Amend to fontify /regexp/s in actions correctly.
[emacs.git] / src / gtkutil.c
blob4771d34b4a032840389bc078787c4c37615db354
1 /* Functions for creating and updating GTK widgets.
3 Copyright (C) 2003-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
22 #ifdef USE_GTK
23 #include <float.h>
24 #include <stdio.h>
26 #include <c-ctype.h>
28 #include "lisp.h"
29 #include "xterm.h"
30 #include "blockinput.h"
31 #include "syssignal.h"
32 #include "window.h"
33 #include "gtkutil.h"
34 #include "termhooks.h"
35 #include "keyboard.h"
36 #include "charset.h"
37 #include "coding.h"
38 #include <gdk/gdkkeysyms.h>
39 #include "xsettings.h"
41 #ifdef HAVE_XFT
42 #include <X11/Xft/Xft.h>
43 #endif
45 #ifdef HAVE_GTK3
46 #include <gtk/gtkx.h>
47 #include "emacsgtkfixed.h"
48 #endif
50 #define FRAME_TOTAL_PIXEL_HEIGHT(f) \
51 (FRAME_PIXEL_HEIGHT (f) + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
53 #define FRAME_TOTAL_PIXEL_WIDTH(f) \
54 (FRAME_PIXEL_WIDTH (f) + FRAME_TOOLBAR_WIDTH (f))
56 #ifndef HAVE_GTK_WIDGET_SET_HAS_WINDOW
57 #define gtk_widget_set_has_window(w, b) \
58 (gtk_fixed_set_has_window (GTK_FIXED (w), b))
59 #endif
60 #ifndef HAVE_GTK_DIALOG_GET_ACTION_AREA
61 #define gtk_dialog_get_action_area(w) ((w)->action_area)
62 #define gtk_dialog_get_content_area(w) ((w)->vbox)
63 #endif
64 #ifndef HAVE_GTK_WIDGET_GET_SENSITIVE
65 #define gtk_widget_get_sensitive(w) (GTK_WIDGET_SENSITIVE (w))
66 #endif
67 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
68 #define gtk_adjustment_set_page_size(w, s) ((w)->page_size = (s))
69 #define gtk_adjustment_set_page_increment(w, s) ((w)->page_increment = (s))
70 #define gtk_adjustment_get_step_increment(w) ((w)->step_increment)
71 #define gtk_adjustment_set_step_increment(w, s) ((w)->step_increment = (s))
72 #endif
73 #if GTK_MAJOR_VERSION > 2 || GTK_MINOR_VERSION > 11
74 #define remove_submenu(w) gtk_menu_item_set_submenu ((w), NULL)
75 #else
76 #define remove_submenu(w) gtk_menu_item_remove_submenu ((w))
77 #endif
79 #if GTK_MAJOR_VERSION > 3 || (GTK_MAJOR_VERSION == 3 && GTK_MINOR_VERSION >= 2)
80 #define USE_NEW_GTK_FONT_CHOOSER 1
81 #else
82 #define USE_NEW_GTK_FONT_CHOOSER 0
83 #define gtk_font_chooser_dialog_new(x, y) \
84 gtk_font_selection_dialog_new (x)
85 #undef GTK_FONT_CHOOSER
86 #define GTK_FONT_CHOOSER(x) GTK_FONT_SELECTION_DIALOG (x)
87 #define gtk_font_chooser_set_font(x, y) \
88 gtk_font_selection_dialog_set_font_name (x, y)
89 #endif
91 #ifndef HAVE_GTK3
92 #ifdef USE_GTK_TOOLTIP
93 #define gdk_window_get_screen(w) gdk_drawable_get_screen (w)
94 #endif
95 #define gdk_window_get_geometry(w, a, b, c, d) \
96 gdk_window_get_geometry (w, a, b, c, d, 0)
97 #define gdk_x11_window_lookup_for_display(d, w) \
98 gdk_xid_table_lookup_for_display (d, w)
99 #define gtk_box_new(ori, spacing) \
100 ((ori) == GTK_ORIENTATION_HORIZONTAL \
101 ? gtk_hbox_new (FALSE, (spacing)) : gtk_vbox_new (FALSE, (spacing)))
102 #define gtk_scrollbar_new(ori, spacing) \
103 ((ori) == GTK_ORIENTATION_HORIZONTAL \
104 ? gtk_hscrollbar_new ((spacing)) : gtk_vscrollbar_new ((spacing)))
105 #ifndef GDK_KEY_g
106 #define GDK_KEY_g GDK_g
107 #endif
108 #endif /* HAVE_GTK3 */
110 #define XG_BIN_CHILD(x) gtk_bin_get_child (GTK_BIN (x))
112 static void update_theme_scrollbar_width (void);
114 #define TB_INFO_KEY "xg_frame_tb_info"
115 struct xg_frame_tb_info
117 Lisp_Object last_tool_bar;
118 Lisp_Object style;
119 int n_last_items;
120 int hmargin, vmargin;
121 GtkTextDirection dir;
125 /***********************************************************************
126 Display handling functions
127 ***********************************************************************/
129 /* Keep track of the default display, or NULL if there is none. Emacs
130 may close all its displays. */
132 static GdkDisplay *gdpy_def;
134 /* When the GTK widget W is to be created on a display for F that
135 is not the default display, set the display for W.
136 W can be a GtkMenu or a GtkWindow widget. */
138 static void
139 xg_set_screen (GtkWidget *w, FRAME_PTR f)
141 if (FRAME_X_DISPLAY (f) != DEFAULT_GDK_DISPLAY ())
143 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
144 GdkScreen *gscreen = gdk_display_get_default_screen (gdpy);
146 if (GTK_IS_MENU (w))
147 gtk_menu_set_screen (GTK_MENU (w), gscreen);
148 else
149 gtk_window_set_screen (GTK_WINDOW (w), gscreen);
154 /* Open a display named by DISPLAY_NAME. The display is returned in *DPY.
155 *DPY is set to NULL if the display can't be opened.
157 Returns non-zero if display could be opened, zero if display could not
158 be opened, and less than zero if the GTK version doesn't support
159 multiple displays. */
161 void
162 xg_display_open (char *display_name, Display **dpy)
164 GdkDisplay *gdpy;
166 gdpy = gdk_display_open (display_name);
167 if (!gdpy_def && gdpy)
169 gdpy_def = gdpy;
170 gdk_display_manager_set_default_display (gdk_display_manager_get (),
171 gdpy);
174 *dpy = gdpy ? GDK_DISPLAY_XDISPLAY (gdpy) : NULL;
178 /* Close display DPY. */
180 void
181 xg_display_close (Display *dpy)
183 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
185 /* If this is the default display, try to change it before closing.
186 If there is no other display to use, gdpy_def is set to NULL, and
187 the next call to xg_display_open resets the default display. */
188 if (gdk_display_get_default () == gdpy)
190 struct x_display_info *dpyinfo;
191 GdkDisplay *gdpy_new = NULL;
193 /* Find another display. */
194 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
195 if (dpyinfo->display != dpy)
197 gdpy_new = gdk_x11_lookup_xdisplay (dpyinfo->display);
198 gdk_display_manager_set_default_display (gdk_display_manager_get (),
199 gdpy_new);
200 break;
202 gdpy_def = gdpy_new;
205 #if GTK_MAJOR_VERSION == 2 && GTK_MINOR_VERSION < 10
206 /* GTK 2.2-2.8 has a bug that makes gdk_display_close crash (bug
207 http://bugzilla.gnome.org/show_bug.cgi?id=85715). This way we
208 can continue running, but there will be memory leaks. */
209 g_object_run_dispose (G_OBJECT (gdpy));
210 #else
211 /* This seems to be fixed in GTK 2.10. */
212 gdk_display_close (gdpy);
213 #endif
217 /***********************************************************************
218 Utility functions
219 ***********************************************************************/
220 /* The next two variables and functions are taken from lwlib. */
221 static widget_value *widget_value_free_list;
222 static int malloc_cpt;
224 /* Allocate a widget_value structure, either by taking one from the
225 widget_value_free_list or by malloc:ing a new one.
227 Return a pointer to the allocated structure. */
229 widget_value *
230 malloc_widget_value (void)
232 widget_value *wv;
233 if (widget_value_free_list)
235 wv = widget_value_free_list;
236 widget_value_free_list = wv->free_list;
237 wv->free_list = 0;
239 else
241 wv = xmalloc (sizeof *wv);
242 malloc_cpt++;
244 memset (wv, 0, sizeof (widget_value));
245 return wv;
248 /* This is analogous to free. It frees only what was allocated
249 by malloc_widget_value, and no substructures. */
251 void
252 free_widget_value (widget_value *wv)
254 if (wv->free_list)
255 emacs_abort ();
257 if (malloc_cpt > 25)
259 /* When the number of already allocated cells is too big,
260 We free it. */
261 xfree (wv);
262 malloc_cpt--;
264 else
266 wv->free_list = widget_value_free_list;
267 widget_value_free_list = wv;
272 /* Create and return the cursor to be used for popup menus and
273 scroll bars on display DPY. */
275 GdkCursor *
276 xg_create_default_cursor (Display *dpy)
278 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
279 return gdk_cursor_new_for_display (gdpy, GDK_LEFT_PTR);
282 static GdkPixbuf *
283 xg_get_pixbuf_from_pixmap (FRAME_PTR f, Pixmap pix)
285 int iunused;
286 GdkPixbuf *tmp_buf;
287 Window wunused;
288 unsigned int width, height, uunused;
289 XImage *xim;
291 XGetGeometry (FRAME_X_DISPLAY (f), pix, &wunused, &iunused, &iunused,
292 &width, &height, &uunused, &uunused);
294 xim = XGetImage (FRAME_X_DISPLAY (f), pix, 0, 0, width, height,
295 ~0, XYPixmap);
296 if (!xim) return 0;
298 tmp_buf = gdk_pixbuf_new_from_data ((guchar *) xim->data,
299 GDK_COLORSPACE_RGB,
300 FALSE,
301 xim->bitmap_unit,
302 width,
303 height,
304 xim->bytes_per_line,
305 NULL,
306 NULL);
307 XDestroyImage (xim);
308 return tmp_buf;
311 /* Apply GMASK to GPIX and return a GdkPixbuf with an alpha channel. */
313 static GdkPixbuf *
314 xg_get_pixbuf_from_pix_and_mask (FRAME_PTR f,
315 Pixmap pix,
316 Pixmap mask)
318 int width, height;
319 GdkPixbuf *icon_buf, *tmp_buf;
321 tmp_buf = xg_get_pixbuf_from_pixmap (f, pix);
322 icon_buf = gdk_pixbuf_add_alpha (tmp_buf, FALSE, 0, 0, 0);
323 g_object_unref (G_OBJECT (tmp_buf));
325 width = gdk_pixbuf_get_width (icon_buf);
326 height = gdk_pixbuf_get_height (icon_buf);
328 if (mask)
330 GdkPixbuf *mask_buf = xg_get_pixbuf_from_pixmap (f, mask);
331 guchar *pixels = gdk_pixbuf_get_pixels (icon_buf);
332 guchar *mask_pixels = gdk_pixbuf_get_pixels (mask_buf);
333 int rowstride = gdk_pixbuf_get_rowstride (icon_buf);
334 int mask_rowstride = gdk_pixbuf_get_rowstride (mask_buf);
335 int y;
337 for (y = 0; y < height; ++y)
339 guchar *iconptr, *maskptr;
340 int x;
342 iconptr = pixels + y * rowstride;
343 maskptr = mask_pixels + y * mask_rowstride;
345 for (x = 0; x < width; ++x)
347 /* In a bitmap, RGB is either 255/255/255 or 0/0/0. Checking
348 just R is sufficient. */
349 if (maskptr[0] == 0)
350 iconptr[3] = 0; /* 0, 1, 2 is R, G, B. 3 is alpha. */
352 iconptr += rowstride/width;
353 maskptr += mask_rowstride/width;
357 g_object_unref (G_OBJECT (mask_buf));
360 return icon_buf;
363 static Lisp_Object
364 file_for_image (Lisp_Object image)
366 Lisp_Object specified_file = Qnil;
367 Lisp_Object tail;
369 for (tail = XCDR (image);
370 NILP (specified_file) && CONSP (tail) && CONSP (XCDR (tail));
371 tail = XCDR (XCDR (tail)))
372 if (EQ (XCAR (tail), QCfile))
373 specified_file = XCAR (XCDR (tail));
375 return specified_file;
378 /* For the image defined in IMG, make and return a GtkImage. For displays with
379 8 planes or less we must make a GdkPixbuf and apply the mask manually.
380 Otherwise the highlighting and dimming the tool bar code in GTK does
381 will look bad. For display with more than 8 planes we just use the
382 pixmap and mask directly. For monochrome displays, GTK doesn't seem
383 able to use external pixmaps, it looks bad whatever we do.
384 The image is defined on the display where frame F is.
385 WIDGET is used to find the GdkColormap to use for the GdkPixbuf.
386 If OLD_WIDGET is NULL, a new widget is constructed and returned.
387 If OLD_WIDGET is not NULL, that widget is modified. */
389 static GtkWidget *
390 xg_get_image_for_pixmap (FRAME_PTR f,
391 struct image *img,
392 GtkWidget *widget,
393 GtkImage *old_widget)
395 GdkPixbuf *icon_buf;
397 /* If we have a file, let GTK do all the image handling.
398 This seems to be the only way to make insensitive and activated icons
399 look good in all cases. */
400 Lisp_Object specified_file = file_for_image (img->spec);
401 Lisp_Object file;
403 /* We already loaded the image once before calling this
404 function, so this only fails if the image file has been removed.
405 In that case, use the pixmap already loaded. */
407 if (STRINGP (specified_file)
408 && STRINGP (file = x_find_image_file (specified_file)))
410 if (! old_widget)
411 old_widget = GTK_IMAGE (gtk_image_new_from_file (SSDATA (file)));
412 else
413 gtk_image_set_from_file (old_widget, SSDATA (file));
415 return GTK_WIDGET (old_widget);
418 /* No file, do the image handling ourselves. This will look very bad
419 on a monochrome display, and sometimes bad on all displays with
420 certain themes. */
422 /* This is a workaround to make icons look good on pseudo color
423 displays. Apparently GTK expects the images to have an alpha
424 channel. If they don't, insensitive and activated icons will
425 look bad. This workaround does not work on monochrome displays,
426 and is strictly not needed on true color/static color displays (i.e.
427 16 bits and higher). But we do it anyway so we get a pixbuf that is
428 not associated with the img->pixmap. The img->pixmap may be removed
429 by clearing the image cache and then the tool bar redraw fails, since
430 Gtk+ assumes the pixmap is always there. */
431 icon_buf = xg_get_pixbuf_from_pix_and_mask (f, img->pixmap, img->mask);
433 if (icon_buf)
435 if (! old_widget)
436 old_widget = GTK_IMAGE (gtk_image_new_from_pixbuf (icon_buf));
437 else
438 gtk_image_set_from_pixbuf (old_widget, icon_buf);
440 g_object_unref (G_OBJECT (icon_buf));
443 return GTK_WIDGET (old_widget);
447 /* Set CURSOR on W and all widgets W contain. We must do like this
448 for scroll bars and menu because they create widgets internally,
449 and it is those widgets that are visible. */
451 static void
452 xg_set_cursor (GtkWidget *w, GdkCursor *cursor)
454 GdkWindow *window = gtk_widget_get_window (w);
455 GList *children = gdk_window_peek_children (window);
457 gdk_window_set_cursor (window, cursor);
459 /* The scroll bar widget has more than one GDK window (had to look at
460 the source to figure this out), and there is no way to set cursor
461 on widgets in GTK. So we must set the cursor for all GDK windows.
462 Ditto for menus. */
464 for ( ; children; children = g_list_next (children))
465 gdk_window_set_cursor (GDK_WINDOW (children->data), cursor);
468 /* Insert NODE into linked LIST. */
470 static void
471 xg_list_insert (xg_list_node *list, xg_list_node *node)
473 xg_list_node *list_start = list->next;
475 if (list_start) list_start->prev = node;
476 node->next = list_start;
477 node->prev = 0;
478 list->next = node;
481 /* Remove NODE from linked LIST. */
483 static void
484 xg_list_remove (xg_list_node *list, xg_list_node *node)
486 xg_list_node *list_start = list->next;
487 if (node == list_start)
489 list->next = node->next;
490 if (list->next) list->next->prev = 0;
492 else
494 node->prev->next = node->next;
495 if (node->next) node->next->prev = node->prev;
499 /* Allocate and return a utf8 version of STR. If STR is already
500 utf8 or NULL, just return a copy of STR.
501 A new string is allocated and the caller must free the result
502 with g_free. */
504 static char *
505 get_utf8_string (const char *str)
507 char *utf8_str;
509 if (!str) return NULL;
511 /* If not UTF-8, try current locale. */
512 if (!g_utf8_validate (str, -1, NULL))
513 utf8_str = g_locale_to_utf8 (str, -1, 0, 0, 0);
514 else
515 return g_strdup (str);
517 if (!utf8_str)
519 /* Probably some control characters in str. Escape them. */
520 ptrdiff_t len;
521 ptrdiff_t nr_bad = 0;
522 gsize bytes_read;
523 gsize bytes_written;
524 unsigned char *p = (unsigned char *)str;
525 char *cp, *up;
526 GError *err = NULL;
528 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
529 &bytes_written, &err))
530 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
532 ++nr_bad;
533 p += bytes_written+1;
534 g_error_free (err);
535 err = NULL;
538 if (err)
540 g_error_free (err);
541 err = NULL;
543 if (cp) g_free (cp);
545 len = strlen (str);
546 if ((min (PTRDIFF_MAX, SIZE_MAX) - len - 1) / 4 < nr_bad)
547 memory_full (SIZE_MAX);
548 up = utf8_str = xmalloc (len + nr_bad * 4 + 1);
549 p = (unsigned char *)str;
551 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
552 &bytes_written, &err))
553 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
555 memcpy (up, p, bytes_written);
556 sprintf (up + bytes_written, "\\%03o", p[bytes_written]);
557 up += bytes_written+4;
558 p += bytes_written+1;
559 g_error_free (err);
560 err = NULL;
563 if (cp)
565 strcat (utf8_str, cp);
566 g_free (cp);
568 if (err)
570 g_error_free (err);
571 err = NULL;
574 return utf8_str;
577 /* Check for special colors used in face spec for region face.
578 The colors are fetched from the Gtk+ theme.
579 Return true if color was found, false if not. */
581 bool
582 xg_check_special_colors (struct frame *f,
583 const char *color_name,
584 XColor *color)
586 bool success_p = 0;
587 bool get_bg = strcmp ("gtk_selection_bg_color", color_name) == 0;
588 bool get_fg = !get_bg && strcmp ("gtk_selection_fg_color", color_name) == 0;
590 if (! FRAME_GTK_WIDGET (f) || ! (get_bg || get_fg))
591 return success_p;
593 block_input ();
595 #ifdef HAVE_GTK3
596 GtkStyleContext *gsty
597 = gtk_widget_get_style_context (FRAME_GTK_OUTER_WIDGET (f));
598 GdkRGBA col;
599 char buf[sizeof "rgbi://" + 3 * (DBL_MAX_10_EXP + sizeof "-1.000000" - 1)];
600 int state = GTK_STATE_FLAG_SELECTED|GTK_STATE_FLAG_FOCUSED;
601 if (get_fg)
602 gtk_style_context_get_color (gsty, state, &col);
603 else
604 gtk_style_context_get_background_color (gsty, state, &col);
606 sprintf (buf, "rgbi:%lf/%lf/%lf", col.red, col.green, col.blue);
607 success_p = (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
608 buf, color)
609 != 0);
610 #else
611 GtkStyle *gsty = gtk_widget_get_style (FRAME_GTK_WIDGET (f));
612 GdkColor *grgb = get_bg
613 ? &gsty->bg[GTK_STATE_SELECTED]
614 : &gsty->fg[GTK_STATE_SELECTED];
616 color->red = grgb->red;
617 color->green = grgb->green;
618 color->blue = grgb->blue;
619 color->pixel = grgb->pixel;
620 success_p = 1;
621 #endif
624 unblock_input ();
625 return success_p;
630 /***********************************************************************
631 Tooltips
632 ***********************************************************************/
633 /* Gtk+ calls this callback when the parent of our tooltip dummy changes.
634 We use that to pop down the tooltip. This happens if Gtk+ for some
635 reason wants to change or hide the tooltip. */
637 #ifdef USE_GTK_TOOLTIP
639 static void
640 hierarchy_ch_cb (GtkWidget *widget,
641 GtkWidget *previous_toplevel,
642 gpointer user_data)
644 FRAME_PTR f = (FRAME_PTR) user_data;
645 struct x_output *x = f->output_data.x;
646 GtkWidget *top = gtk_widget_get_toplevel (x->ttip_lbl);
648 if (! top || ! GTK_IS_WINDOW (top))
649 gtk_widget_hide (previous_toplevel);
652 /* Callback called when Gtk+ thinks a tooltip should be displayed.
653 We use it to get the tooltip window and the tooltip widget so
654 we can manipulate the ourselves.
656 Return FALSE ensures that the tooltip is not shown. */
658 static gboolean
659 qttip_cb (GtkWidget *widget,
660 gint xpos,
661 gint ypos,
662 gboolean keyboard_mode,
663 GtkTooltip *tooltip,
664 gpointer user_data)
666 FRAME_PTR f = (FRAME_PTR) user_data;
667 struct x_output *x = f->output_data.x;
668 if (x->ttip_widget == NULL)
670 GtkWidget *p;
671 GList *list, *iter;
673 g_object_set (G_OBJECT (widget), "has-tooltip", FALSE, NULL);
674 x->ttip_widget = tooltip;
675 g_object_ref (G_OBJECT (tooltip));
676 x->ttip_lbl = gtk_label_new ("");
677 g_object_ref (G_OBJECT (x->ttip_lbl));
678 gtk_tooltip_set_custom (tooltip, x->ttip_lbl);
679 x->ttip_window = GTK_WINDOW (gtk_widget_get_toplevel (x->ttip_lbl));
681 /* Change stupid Gtk+ default line wrapping. */
682 p = gtk_widget_get_parent (x->ttip_lbl);
683 list = gtk_container_get_children (GTK_CONTAINER (p));
684 for (iter = list; iter; iter = g_list_next (iter))
686 GtkWidget *w = GTK_WIDGET (iter->data);
687 if (GTK_IS_LABEL (w))
688 gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
690 g_list_free (list);
692 /* ATK needs an empty title for some reason. */
693 gtk_window_set_title (x->ttip_window, "");
694 /* Realize so we can safely get screen later on. */
695 gtk_widget_realize (GTK_WIDGET (x->ttip_window));
696 gtk_widget_realize (x->ttip_lbl);
698 g_signal_connect (x->ttip_lbl, "hierarchy-changed",
699 G_CALLBACK (hierarchy_ch_cb), f);
701 return FALSE;
704 #endif /* USE_GTK_TOOLTIP */
706 /* Prepare a tooltip to be shown, i.e. calculate WIDTH and HEIGHT.
707 Return true if a system tooltip is available. */
709 bool
710 xg_prepare_tooltip (FRAME_PTR f,
711 Lisp_Object string,
712 int *width,
713 int *height)
715 #ifndef USE_GTK_TOOLTIP
716 return 0;
717 #else
718 struct x_output *x = f->output_data.x;
719 GtkWidget *widget;
720 GdkWindow *gwin;
721 GdkScreen *screen;
722 GtkSettings *settings;
723 gboolean tt_enabled = TRUE;
724 GtkRequisition req;
725 Lisp_Object encoded_string;
727 if (!x->ttip_lbl) return 0;
729 block_input ();
730 encoded_string = ENCODE_UTF_8 (string);
731 widget = GTK_WIDGET (x->ttip_lbl);
732 gwin = gtk_widget_get_window (GTK_WIDGET (x->ttip_window));
733 screen = gdk_window_get_screen (gwin);
734 settings = gtk_settings_get_for_screen (screen);
735 g_object_get (settings, "gtk-enable-tooltips", &tt_enabled, NULL);
736 if (tt_enabled)
738 g_object_set (settings, "gtk-enable-tooltips", FALSE, NULL);
739 /* Record that we disabled it so it can be enabled again. */
740 g_object_set_data (G_OBJECT (x->ttip_window), "restore-tt",
741 (gpointer)f);
744 /* Prevent Gtk+ from hiding tooltip on mouse move and such. */
745 g_object_set_data (G_OBJECT
746 (gtk_widget_get_display (GTK_WIDGET (x->ttip_window))),
747 "gdk-display-current-tooltip", NULL);
749 /* Put our dummy widget in so we can get callbacks for unrealize and
750 hierarchy-changed. */
751 gtk_tooltip_set_custom (x->ttip_widget, widget);
752 gtk_tooltip_set_text (x->ttip_widget, SSDATA (encoded_string));
753 gtk_widget_get_preferred_size (GTK_WIDGET (x->ttip_window), NULL, &req);
754 if (width) *width = req.width;
755 if (height) *height = req.height;
757 unblock_input ();
759 return 1;
760 #endif /* USE_GTK_TOOLTIP */
763 /* Show the tooltip at ROOT_X and ROOT_Y.
764 xg_prepare_tooltip must have been called before this function. */
766 void
767 xg_show_tooltip (FRAME_PTR f, int root_x, int root_y)
769 #ifdef USE_GTK_TOOLTIP
770 struct x_output *x = f->output_data.x;
771 if (x->ttip_window)
773 block_input ();
774 gtk_window_move (x->ttip_window, root_x, root_y);
775 gtk_widget_show_all (GTK_WIDGET (x->ttip_window));
776 unblock_input ();
778 #endif
781 /* Hide tooltip if shown. Do nothing if not shown.
782 Return true if tip was hidden, false if not (i.e. not using
783 system tooltips). */
785 bool
786 xg_hide_tooltip (FRAME_PTR f)
788 bool ret = 0;
789 #ifdef USE_GTK_TOOLTIP
790 if (f->output_data.x->ttip_window)
792 GtkWindow *win = f->output_data.x->ttip_window;
793 block_input ();
794 gtk_widget_hide (GTK_WIDGET (win));
796 if (g_object_get_data (G_OBJECT (win), "restore-tt"))
798 GdkWindow *gwin = gtk_widget_get_window (GTK_WIDGET (win));
799 GdkScreen *screen = gdk_window_get_screen (gwin);
800 GtkSettings *settings = gtk_settings_get_for_screen (screen);
801 g_object_set (settings, "gtk-enable-tooltips", TRUE, NULL);
803 unblock_input ();
805 ret = 1;
807 #endif
808 return ret;
812 /***********************************************************************
813 General functions for creating widgets, resizing, events, e.t.c.
814 ***********************************************************************/
816 static void
817 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
818 const gchar *msg, gpointer user_data)
820 if (!strstr (msg, "visible children"))
821 fprintf (stderr, "XX %s-WARNING **: %s\n", log_domain, msg);
824 /* Make a geometry string and pass that to GTK. It seems this is the
825 only way to get geometry position right if the user explicitly
826 asked for a position when starting Emacs.
827 F is the frame we shall set geometry for. */
829 static void
830 xg_set_geometry (FRAME_PTR f)
832 if (f->size_hint_flags & (USPosition | PPosition))
834 int left = f->left_pos;
835 int xneg = f->size_hint_flags & XNegative;
836 int top = f->top_pos;
837 int yneg = f->size_hint_flags & YNegative;
838 char geom_str[sizeof "=x--" + 4 * INT_STRLEN_BOUND (int)];
839 guint id;
841 if (xneg)
842 left = -left;
843 if (yneg)
844 top = -top;
846 sprintf (geom_str, "=%dx%d%c%d%c%d",
847 FRAME_PIXEL_WIDTH (f),
848 FRAME_PIXEL_HEIGHT (f),
849 (xneg ? '-' : '+'), left,
850 (yneg ? '-' : '+'), top);
852 /* Silence warning about visible children. */
853 id = g_log_set_handler ("Gtk", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
854 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
856 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
857 geom_str))
858 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
860 g_log_remove_handler ("Gtk", id);
864 /* Clear under internal border if any. As we use a mix of Gtk+ and X calls
865 and use a GtkFixed widget, this doesn't happen automatically. */
867 static void
868 xg_clear_under_internal_border (FRAME_PTR f)
870 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
872 GtkWidget *wfixed = f->output_data.x->edit_widget;
873 gtk_widget_queue_draw (wfixed);
874 gdk_window_process_all_updates ();
875 x_clear_area (FRAME_X_DISPLAY (f),
876 FRAME_X_WINDOW (f),
877 0, 0,
878 FRAME_PIXEL_WIDTH (f),
879 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
880 x_clear_area (FRAME_X_DISPLAY (f),
881 FRAME_X_WINDOW (f),
882 0, 0,
883 FRAME_INTERNAL_BORDER_WIDTH (f),
884 FRAME_PIXEL_HEIGHT (f), 0);
885 x_clear_area (FRAME_X_DISPLAY (f),
886 FRAME_X_WINDOW (f),
887 0, FRAME_PIXEL_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
888 FRAME_PIXEL_WIDTH (f),
889 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
890 x_clear_area (FRAME_X_DISPLAY (f),
891 FRAME_X_WINDOW (f),
892 FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
894 FRAME_INTERNAL_BORDER_WIDTH (f),
895 FRAME_PIXEL_HEIGHT (f), 0);
899 /* Function to handle resize of our frame. As we have a Gtk+ tool bar
900 and a Gtk+ menu bar, we get resize events for the edit part of the
901 frame only. We let Gtk+ deal with the Gtk+ parts.
902 F is the frame to resize.
903 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
905 void
906 xg_frame_resized (FRAME_PTR f, int pixelwidth, int pixelheight)
908 int rows, columns;
910 if (pixelwidth == -1 && pixelheight == -1)
912 if (FRAME_GTK_WIDGET (f) && gtk_widget_get_mapped (FRAME_GTK_WIDGET (f)))
913 gdk_window_get_geometry (gtk_widget_get_window (FRAME_GTK_WIDGET (f)),
914 0, 0,
915 &pixelwidth, &pixelheight);
916 else return;
920 rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelheight);
921 columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pixelwidth);
923 if (columns != FRAME_COLS (f)
924 || rows != FRAME_LINES (f)
925 || pixelwidth != FRAME_PIXEL_WIDTH (f)
926 || pixelheight != FRAME_PIXEL_HEIGHT (f))
928 FRAME_PIXEL_WIDTH (f) = pixelwidth;
929 FRAME_PIXEL_HEIGHT (f) = pixelheight;
931 xg_clear_under_internal_border (f);
932 change_frame_size (f, rows, columns, 0, 1, 0);
933 SET_FRAME_GARBAGED (f);
934 cancel_mouse_face (f);
938 /* Resize the outer window of frame F after changing the height.
939 COLUMNS/ROWS is the size the edit area shall have after the resize. */
941 void
942 xg_frame_set_char_size (FRAME_PTR f, int cols, int rows)
944 int pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
945 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
946 int pixelwidth;
948 if (FRAME_PIXEL_HEIGHT (f) == 0)
949 return;
951 /* Take into account the size of the scroll bar. Always use the
952 number of columns occupied by the scroll bar here otherwise we
953 might end up with a frame width that is not a multiple of the
954 frame's character width which is bad for vertically split
955 windows. */
956 f->scroll_bar_actual_width
957 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
959 compute_fringe_widths (f, 0);
961 /* FRAME_TEXT_COLS_TO_PIXEL_WIDTH uses scroll_bar_actual_width, so call it
962 after calculating that value. */
963 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
964 + FRAME_TOOLBAR_WIDTH (f);
967 /* Do this before resize, as we don't know yet if we will be resized. */
968 xg_clear_under_internal_border (f);
970 /* Must resize our top level widget. Font size may have changed,
971 but not rows/cols. */
972 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
973 pixelwidth, pixelheight);
974 x_wm_set_size_hint (f, 0, 0);
976 SET_FRAME_GARBAGED (f);
977 cancel_mouse_face (f);
979 /* We can not call change_frame_size for a mapped frame,
980 we can not set pixel width/height either. The window manager may
981 override our resize request, XMonad does this all the time.
982 The best we can do is try to sync, so lisp code sees the updated
983 size as fast as possible.
984 For unmapped windows, we can set rows/cols. When
985 the frame is mapped again we will (hopefully) get the correct size. */
986 if (FRAME_VISIBLE_P (f))
988 /* Must call this to flush out events */
989 (void)gtk_events_pending ();
990 gdk_flush ();
991 x_wait_for_event (f, ConfigureNotify);
993 else
995 change_frame_size (f, rows, cols, 0, 1, 0);
996 FRAME_PIXEL_WIDTH (f) = pixelwidth;
997 FRAME_PIXEL_HEIGHT (f) = pixelheight;
1001 /* Handle height/width changes (i.e. add/remove/move menu/toolbar).
1002 The policy is to keep the number of editable lines. */
1004 static void
1005 xg_height_or_width_changed (FRAME_PTR f)
1007 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1008 FRAME_TOTAL_PIXEL_WIDTH (f),
1009 FRAME_TOTAL_PIXEL_HEIGHT (f));
1010 f->output_data.x->hint_flags = 0;
1011 x_wm_set_size_hint (f, 0, 0);
1014 /* Convert an X Window WSESC on display DPY to its corresponding GtkWidget.
1015 Must be done like this, because GtkWidget:s can have "hidden"
1016 X Window that aren't accessible.
1018 Return 0 if no widget match WDESC. */
1020 GtkWidget *
1021 xg_win_to_widget (Display *dpy, Window wdesc)
1023 gpointer gdkwin;
1024 GtkWidget *gwdesc = 0;
1026 block_input ();
1028 gdkwin = gdk_x11_window_lookup_for_display (gdk_x11_lookup_xdisplay (dpy),
1029 wdesc);
1030 if (gdkwin)
1032 GdkEvent event;
1033 event.any.window = gdkwin;
1034 event.any.type = GDK_NOTHING;
1035 gwdesc = gtk_get_event_widget (&event);
1038 unblock_input ();
1039 return gwdesc;
1042 /* Set the background of widget W to PIXEL. */
1044 static void
1045 xg_set_widget_bg (FRAME_PTR f, GtkWidget *w, long unsigned int pixel)
1047 #ifdef HAVE_GTK3
1048 GdkRGBA bg;
1049 XColor xbg;
1050 xbg.pixel = pixel;
1051 if (XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &xbg))
1053 bg.red = (double)xbg.red/65535.0;
1054 bg.green = (double)xbg.green/65535.0;
1055 bg.blue = (double)xbg.blue/65535.0;
1056 bg.alpha = 1.0;
1057 gtk_widget_override_background_color (w, GTK_STATE_FLAG_NORMAL, &bg);
1059 #else
1060 GdkColor bg;
1061 GdkColormap *map = gtk_widget_get_colormap (w);
1062 gdk_colormap_query_color (map, pixel, &bg);
1063 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &bg);
1064 #endif
1067 /* Callback called when the gtk theme changes.
1068 We notify lisp code so it can fix faces used for region for example. */
1070 static void
1071 style_changed_cb (GObject *go,
1072 GParamSpec *spec,
1073 gpointer user_data)
1075 struct input_event event;
1076 GdkDisplay *gdpy = (GdkDisplay *) user_data;
1077 const char *display_name = gdk_display_get_name (gdpy);
1078 Display *dpy = GDK_DISPLAY_XDISPLAY (gdpy);
1080 EVENT_INIT (event);
1081 event.kind = CONFIG_CHANGED_EVENT;
1082 event.frame_or_window = build_string (display_name);
1083 /* Theme doesn't change often, so intern is called seldom. */
1084 event.arg = intern ("theme-name");
1085 kbd_buffer_store_event (&event);
1087 update_theme_scrollbar_width ();
1089 /* If scroll bar width changed, we need set the new size on all frames
1090 on this display. */
1091 if (dpy)
1093 Lisp_Object rest, frame;
1094 FOR_EACH_FRAME (rest, frame)
1096 FRAME_PTR f = XFRAME (frame);
1097 if (FRAME_X_DISPLAY (f) == dpy)
1099 x_set_scroll_bar_default_width (f);
1100 xg_frame_set_char_size (f, FRAME_COLS (f), FRAME_LINES (f));
1106 /* Called when a delete-event occurs on WIDGET. */
1108 static gboolean
1109 delete_cb (GtkWidget *widget,
1110 GdkEvent *event,
1111 gpointer user_data)
1113 #ifdef HAVE_GTK3
1114 /* The event doesn't arrive in the normal event loop. Send event
1115 here. */
1116 FRAME_PTR f = (FRAME_PTR) user_data;
1117 struct input_event ie;
1119 EVENT_INIT (ie);
1120 ie.kind = DELETE_WINDOW_EVENT;
1121 XSETFRAME (ie.frame_or_window, f);
1122 kbd_buffer_store_event (&ie);
1123 #endif
1125 return TRUE;
1128 /* Create and set up the GTK widgets for frame F.
1129 Return true if creation succeeded. */
1131 bool
1132 xg_create_frame_widgets (FRAME_PTR f)
1134 GtkWidget *wtop;
1135 GtkWidget *wvbox, *whbox;
1136 GtkWidget *wfixed;
1137 #ifndef HAVE_GTK3
1138 GtkRcStyle *style;
1139 #endif
1140 char *title = 0;
1142 block_input ();
1144 if (FRAME_X_EMBEDDED_P (f))
1146 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
1147 wtop = gtk_plug_new_for_display (gdpy, f->output_data.x->parent_desc);
1149 else
1150 wtop = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1152 /* gtk_window_set_has_resize_grip is a Gtk+ 3.0 function but Ubuntu
1153 has backported it to Gtk+ 2.0 and they add the resize grip for
1154 Gtk+ 2.0 applications also. But it has a bug that makes Emacs loop
1155 forever, so disable the grip. */
1156 #if GTK_MAJOR_VERSION < 3 && defined (HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP)
1157 gtk_window_set_has_resize_grip (GTK_WINDOW (wtop), FALSE);
1158 #endif
1160 xg_set_screen (wtop, f);
1162 wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1163 whbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1164 gtk_box_set_homogeneous (GTK_BOX (wvbox), FALSE);
1165 gtk_box_set_homogeneous (GTK_BOX (whbox), FALSE);
1167 #ifdef HAVE_GTK3
1168 wfixed = emacs_fixed_new (f);
1169 #else
1170 wfixed = gtk_fixed_new ();
1171 #endif
1173 if (! wtop || ! wvbox || ! whbox || ! wfixed)
1175 if (wtop) gtk_widget_destroy (wtop);
1176 if (wvbox) gtk_widget_destroy (wvbox);
1177 if (whbox) gtk_widget_destroy (whbox);
1178 if (wfixed) gtk_widget_destroy (wfixed);
1180 unblock_input ();
1181 return 0;
1184 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
1185 gtk_widget_set_name (wtop, EMACS_CLASS);
1186 gtk_widget_set_name (wvbox, "pane");
1187 gtk_widget_set_name (wfixed, SSDATA (Vx_resource_name));
1189 /* If this frame has a title or name, set it in the title bar. */
1190 if (! NILP (f->title))
1191 title = SSDATA (ENCODE_UTF_8 (f->title));
1192 else if (! NILP (f->name))
1193 title = SSDATA (ENCODE_UTF_8 (f->name));
1195 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
1197 FRAME_GTK_OUTER_WIDGET (f) = wtop;
1198 FRAME_GTK_WIDGET (f) = wfixed;
1199 f->output_data.x->vbox_widget = wvbox;
1200 f->output_data.x->hbox_widget = whbox;
1202 gtk_widget_set_has_window (wfixed, TRUE);
1204 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
1205 gtk_box_pack_start (GTK_BOX (wvbox), whbox, TRUE, TRUE, 0);
1206 gtk_box_pack_start (GTK_BOX (whbox), wfixed, TRUE, TRUE, 0);
1208 if (FRAME_EXTERNAL_TOOL_BAR (f))
1209 update_frame_tool_bar (f);
1211 /* We don't want this widget double buffered, because we draw on it
1212 with regular X drawing primitives, so from a GTK/GDK point of
1213 view, the widget is totally blank. When an expose comes, this
1214 will make the widget blank, and then Emacs redraws it. This flickers
1215 a lot, so we turn off double buffering. */
1216 gtk_widget_set_double_buffered (wfixed, FALSE);
1218 gtk_window_set_wmclass (GTK_WINDOW (wtop),
1219 SSDATA (Vx_resource_name),
1220 SSDATA (Vx_resource_class));
1222 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
1223 GTK is to destroy the widget. We want Emacs to do that instead. */
1224 g_signal_connect (G_OBJECT (wtop), "delete-event",
1225 G_CALLBACK (delete_cb), f);
1227 /* Convert our geometry parameters into a geometry string
1228 and specify it.
1229 GTK will itself handle calculating the real position this way. */
1230 xg_set_geometry (f);
1231 f->win_gravity
1232 = gtk_window_get_gravity (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1234 gtk_widget_add_events (wfixed,
1235 GDK_POINTER_MOTION_MASK
1236 | GDK_EXPOSURE_MASK
1237 | GDK_BUTTON_PRESS_MASK
1238 | GDK_BUTTON_RELEASE_MASK
1239 | GDK_KEY_PRESS_MASK
1240 | GDK_ENTER_NOTIFY_MASK
1241 | GDK_LEAVE_NOTIFY_MASK
1242 | GDK_FOCUS_CHANGE_MASK
1243 | GDK_STRUCTURE_MASK
1244 | GDK_VISIBILITY_NOTIFY_MASK);
1246 /* Must realize the windows so the X window gets created. It is used
1247 by callers of this function. */
1248 gtk_widget_realize (wfixed);
1249 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
1251 /* Since GTK clears its window by filling with the background color,
1252 we must keep X and GTK background in sync. */
1253 xg_set_widget_bg (f, wfixed, FRAME_BACKGROUND_PIXEL (f));
1255 #ifndef HAVE_GTK3
1256 /* Also, do not let any background pixmap to be set, this looks very
1257 bad as Emacs overwrites the background pixmap with its own idea
1258 of background color. */
1259 style = gtk_widget_get_modifier_style (wfixed);
1261 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
1262 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
1263 gtk_widget_modify_style (wfixed, style);
1264 #else
1265 gtk_widget_set_can_focus (wfixed, TRUE);
1266 gtk_window_set_resizable (GTK_WINDOW (wtop), TRUE);
1267 #endif
1269 #ifdef USE_GTK_TOOLTIP
1270 /* Steal a tool tip window we can move ourselves. */
1271 f->output_data.x->ttip_widget = 0;
1272 f->output_data.x->ttip_lbl = 0;
1273 f->output_data.x->ttip_window = 0;
1274 gtk_widget_set_tooltip_text (wtop, "Dummy text");
1275 g_signal_connect (wtop, "query-tooltip", G_CALLBACK (qttip_cb), f);
1276 #endif
1279 GdkScreen *screen = gtk_widget_get_screen (wtop);
1280 GtkSettings *gs = gtk_settings_get_for_screen (screen);
1281 /* Only connect this signal once per screen. */
1282 if (! g_signal_handler_find (G_OBJECT (gs),
1283 G_SIGNAL_MATCH_FUNC,
1284 0, 0, 0,
1285 G_CALLBACK (style_changed_cb),
1288 g_signal_connect (G_OBJECT (gs), "notify::gtk-theme-name",
1289 G_CALLBACK (style_changed_cb),
1290 gdk_screen_get_display (screen));
1294 unblock_input ();
1296 return 1;
1299 void
1300 xg_free_frame_widgets (FRAME_PTR f)
1302 if (FRAME_GTK_OUTER_WIDGET (f))
1304 #ifdef USE_GTK_TOOLTIP
1305 struct x_output *x = f->output_data.x;
1306 #endif
1307 struct xg_frame_tb_info *tbinfo
1308 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
1309 TB_INFO_KEY);
1310 if (tbinfo)
1311 xfree (tbinfo);
1313 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
1314 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow in xterm.c */
1315 FRAME_GTK_OUTER_WIDGET (f) = 0;
1316 #ifdef USE_GTK_TOOLTIP
1317 if (x->ttip_lbl)
1318 gtk_widget_destroy (x->ttip_lbl);
1319 if (x->ttip_widget)
1320 g_object_unref (G_OBJECT (x->ttip_widget));
1321 #endif
1325 /* Set the normal size hints for the window manager, for frame F.
1326 FLAGS is the flags word to use--or 0 meaning preserve the flags
1327 that the window now has.
1328 If USER_POSITION, set the User Position
1329 flag (this is useful when FLAGS is 0). */
1331 void
1332 x_wm_set_size_hint (FRAME_PTR f, long int flags, bool user_position)
1334 /* Must use GTK routines here, otherwise GTK resets the size hints
1335 to its own defaults. */
1336 GdkGeometry size_hints;
1337 gint hint_flags = 0;
1338 int base_width, base_height;
1339 int min_rows = 0, min_cols = 0;
1340 int win_gravity = f->win_gravity;
1342 /* Don't set size hints during initialization; that apparently leads
1343 to a race condition. See the thread at
1344 http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00033.html */
1345 if (NILP (Vafter_init_time) || !FRAME_GTK_OUTER_WIDGET (f))
1346 return;
1348 if (flags)
1350 memset (&size_hints, 0, sizeof (size_hints));
1351 f->output_data.x->size_hints = size_hints;
1352 f->output_data.x->hint_flags = hint_flags;
1354 else
1355 flags = f->size_hint_flags;
1357 size_hints = f->output_data.x->size_hints;
1358 hint_flags = f->output_data.x->hint_flags;
1360 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
1361 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
1362 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
1364 hint_flags |= GDK_HINT_BASE_SIZE;
1365 /* Use one row/col here so base_height/width does not become zero.
1366 Gtk+ and/or Unity on Ubuntu 12.04 can't handle it. */
1367 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 1) + FRAME_TOOLBAR_WIDTH (f);
1368 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 1)
1369 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
1371 check_frame_size (f, &min_rows, &min_cols);
1372 if (min_cols > 0) --min_cols; /* We used one col in base_width = ... 1); */
1373 if (min_rows > 0) --min_rows; /* We used one row in base_height = ... 1); */
1375 size_hints.base_width = base_width;
1376 size_hints.base_height = base_height;
1377 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
1378 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
1380 /* These currently have a one to one mapping with the X values, but I
1381 don't think we should rely on that. */
1382 hint_flags |= GDK_HINT_WIN_GRAVITY;
1383 size_hints.win_gravity = 0;
1384 if (win_gravity == NorthWestGravity)
1385 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
1386 else if (win_gravity == NorthGravity)
1387 size_hints.win_gravity = GDK_GRAVITY_NORTH;
1388 else if (win_gravity == NorthEastGravity)
1389 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
1390 else if (win_gravity == WestGravity)
1391 size_hints.win_gravity = GDK_GRAVITY_WEST;
1392 else if (win_gravity == CenterGravity)
1393 size_hints.win_gravity = GDK_GRAVITY_CENTER;
1394 else if (win_gravity == EastGravity)
1395 size_hints.win_gravity = GDK_GRAVITY_EAST;
1396 else if (win_gravity == SouthWestGravity)
1397 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
1398 else if (win_gravity == SouthGravity)
1399 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
1400 else if (win_gravity == SouthEastGravity)
1401 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
1402 else if (win_gravity == StaticGravity)
1403 size_hints.win_gravity = GDK_GRAVITY_STATIC;
1405 if (user_position)
1407 hint_flags &= ~GDK_HINT_POS;
1408 hint_flags |= GDK_HINT_USER_POS;
1411 if (hint_flags != f->output_data.x->hint_flags
1412 || memcmp (&size_hints,
1413 &f->output_data.x->size_hints,
1414 sizeof (size_hints)) != 0)
1416 block_input ();
1417 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1418 NULL, &size_hints, hint_flags);
1419 f->output_data.x->size_hints = size_hints;
1420 f->output_data.x->hint_flags = hint_flags;
1421 unblock_input ();
1425 /* Change background color of a frame.
1426 Since GTK uses the background color to clear the window, we must
1427 keep the GTK and X colors in sync.
1428 F is the frame to change,
1429 BG is the pixel value to change to. */
1431 void
1432 xg_set_background_color (FRAME_PTR f, long unsigned int bg)
1434 if (FRAME_GTK_WIDGET (f))
1436 block_input ();
1437 xg_set_widget_bg (f, FRAME_GTK_WIDGET (f), FRAME_BACKGROUND_PIXEL (f));
1438 unblock_input ();
1443 /* Set the frame icon to ICON_PIXMAP/MASK. This must be done with GTK
1444 functions so GTK does not overwrite the icon. */
1446 void
1447 xg_set_frame_icon (FRAME_PTR f, Pixmap icon_pixmap, Pixmap icon_mask)
1449 GdkPixbuf *gp = xg_get_pixbuf_from_pix_and_mask (f,
1450 icon_pixmap,
1451 icon_mask);
1452 if (gp)
1453 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), gp);
1458 /***********************************************************************
1459 Dialog functions
1460 ***********************************************************************/
1461 /* Return the dialog title to use for a dialog of type KEY.
1462 This is the encoding used by lwlib. We use the same for GTK. */
1464 static const char *
1465 get_dialog_title (char key)
1467 const char *title = "";
1469 switch (key) {
1470 case 'E': case 'e':
1471 title = "Error";
1472 break;
1474 case 'I': case 'i':
1475 title = "Information";
1476 break;
1478 case 'L': case 'l':
1479 title = "Prompt";
1480 break;
1482 case 'P': case 'p':
1483 title = "Prompt";
1484 break;
1486 case 'Q': case 'q':
1487 title = "Question";
1488 break;
1491 return title;
1494 /* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
1495 the dialog, but return TRUE so the event does not propagate further
1496 in GTK. This prevents GTK from destroying the dialog widget automatically
1497 and we can always destroy the widget manually, regardless of how
1498 it was popped down (button press or WM_DELETE_WINDOW).
1499 W is the dialog widget.
1500 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
1501 user_data is NULL (not used).
1503 Returns TRUE to end propagation of event. */
1505 static gboolean
1506 dialog_delete_callback (GtkWidget *w, GdkEvent *event, gpointer user_data)
1508 gtk_widget_unmap (w);
1509 return TRUE;
1512 /* Create a popup dialog window. See also xg_create_widget below.
1513 WV is a widget_value describing the dialog.
1514 SELECT_CB is the callback to use when a button has been pressed.
1515 DEACTIVATE_CB is the callback to use when the dialog pops down.
1517 Returns the GTK dialog widget. */
1519 static GtkWidget *
1520 create_dialog (widget_value *wv,
1521 GCallback select_cb,
1522 GCallback deactivate_cb)
1524 const char *title = get_dialog_title (wv->name[0]);
1525 int total_buttons = wv->name[1] - '0';
1526 int right_buttons = wv->name[4] - '0';
1527 int left_buttons;
1528 int button_nr = 0;
1529 int button_spacing = 10;
1530 GtkWidget *wdialog = gtk_dialog_new ();
1531 GtkDialog *wd = GTK_DIALOG (wdialog);
1532 GtkBox *cur_box = GTK_BOX (gtk_dialog_get_action_area (wd));
1533 widget_value *item;
1534 GtkWidget *whbox_down;
1536 /* If the number of buttons is greater than 4, make two rows of buttons
1537 instead. This looks better. */
1538 bool make_two_rows = total_buttons > 4;
1540 if (right_buttons == 0) right_buttons = total_buttons/2;
1541 left_buttons = total_buttons - right_buttons;
1543 gtk_window_set_title (GTK_WINDOW (wdialog), title);
1544 gtk_widget_set_name (wdialog, "emacs-dialog");
1547 if (make_two_rows)
1549 GtkWidget *wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, button_spacing);
1550 GtkWidget *whbox_up = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1551 gtk_box_set_homogeneous (GTK_BOX (wvbox), TRUE);
1552 gtk_box_set_homogeneous (GTK_BOX (whbox_up), FALSE);
1553 whbox_down = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1554 gtk_box_set_homogeneous (GTK_BOX (whbox_down), FALSE);
1556 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
1557 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
1558 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
1560 cur_box = GTK_BOX (whbox_up);
1563 g_signal_connect (G_OBJECT (wdialog), "delete-event",
1564 G_CALLBACK (dialog_delete_callback), 0);
1566 if (deactivate_cb)
1568 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
1569 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
1572 for (item = wv->contents; item; item = item->next)
1574 char *utf8_label = get_utf8_string (item->value);
1575 GtkWidget *w;
1576 GtkRequisition req;
1578 if (item->name && strcmp (item->name, "message") == 0)
1580 GtkBox *wvbox = GTK_BOX (gtk_dialog_get_content_area (wd));
1581 /* This is the text part of the dialog. */
1582 w = gtk_label_new (utf8_label);
1583 gtk_box_pack_start (wvbox, gtk_label_new (""), FALSE, FALSE, 0);
1584 gtk_box_pack_start (wvbox, w, TRUE, TRUE, 0);
1585 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
1587 /* Try to make dialog look better. Must realize first so
1588 the widget can calculate the size it needs. */
1589 gtk_widget_realize (w);
1590 gtk_widget_get_preferred_size (w, NULL, &req);
1591 gtk_box_set_spacing (wvbox, req.height);
1592 if (item->value && strlen (item->value) > 0)
1593 button_spacing = 2*req.width/strlen (item->value);
1595 else
1597 /* This is one button to add to the dialog. */
1598 w = gtk_button_new_with_label (utf8_label);
1599 if (! item->enabled)
1600 gtk_widget_set_sensitive (w, FALSE);
1601 if (select_cb)
1602 g_signal_connect (G_OBJECT (w), "clicked",
1603 select_cb, item->call_data);
1605 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
1606 if (++button_nr == left_buttons)
1608 if (make_two_rows)
1609 cur_box = GTK_BOX (whbox_down);
1610 else
1611 gtk_box_pack_start (cur_box,
1612 gtk_label_new (""),
1613 TRUE, TRUE,
1614 button_spacing);
1618 if (utf8_label)
1619 g_free (utf8_label);
1622 return wdialog;
1625 struct xg_dialog_data
1627 GMainLoop *loop;
1628 int response;
1629 GtkWidget *w;
1630 guint timerid;
1633 /* Function that is called when the file or font dialogs pop down.
1634 W is the dialog widget, RESPONSE is the response code.
1635 USER_DATA is what we passed in to g_signal_connect. */
1637 static void
1638 xg_dialog_response_cb (GtkDialog *w,
1639 gint response,
1640 gpointer user_data)
1642 struct xg_dialog_data *dd = (struct xg_dialog_data *)user_data;
1643 dd->response = response;
1644 g_main_loop_quit (dd->loop);
1648 /* Destroy the dialog. This makes it pop down. */
1650 static Lisp_Object
1651 pop_down_dialog (Lisp_Object arg)
1653 struct xg_dialog_data *dd = XSAVE_POINTER (arg, 0);
1655 block_input ();
1656 if (dd->w) gtk_widget_destroy (dd->w);
1657 if (dd->timerid != 0) g_source_remove (dd->timerid);
1659 g_main_loop_quit (dd->loop);
1660 g_main_loop_unref (dd->loop);
1662 unblock_input ();
1664 return Qnil;
1667 /* If there are any emacs timers pending, add a timeout to main loop in DATA.
1668 We pass in DATA as gpointer* so we can use this as a callback. */
1670 static gboolean
1671 xg_maybe_add_timer (gpointer data)
1673 struct xg_dialog_data *dd = (struct xg_dialog_data *) data;
1674 EMACS_TIME next_time = timer_check ();
1676 dd->timerid = 0;
1678 if (EMACS_TIME_VALID_P (next_time))
1680 time_t s = EMACS_SECS (next_time);
1681 int per_ms = EMACS_TIME_RESOLUTION / 1000;
1682 int ms = (EMACS_NSECS (next_time) + per_ms - 1) / per_ms;
1683 if (s <= ((guint) -1 - ms) / 1000)
1684 dd->timerid = g_timeout_add (s * 1000 + ms, xg_maybe_add_timer, dd);
1686 return FALSE;
1690 /* Pops up a modal dialog W and waits for response.
1691 We don't use gtk_dialog_run because we want to process emacs timers.
1692 The dialog W is not destroyed when this function returns. */
1694 static int
1695 xg_dialog_run (FRAME_PTR f, GtkWidget *w)
1697 ptrdiff_t count = SPECPDL_INDEX ();
1698 struct xg_dialog_data dd;
1700 xg_set_screen (w, f);
1701 gtk_window_set_transient_for (GTK_WINDOW (w),
1702 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1703 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1704 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
1706 dd.loop = g_main_loop_new (NULL, FALSE);
1707 dd.response = GTK_RESPONSE_CANCEL;
1708 dd.w = w;
1709 dd.timerid = 0;
1711 g_signal_connect (G_OBJECT (w),
1712 "response",
1713 G_CALLBACK (xg_dialog_response_cb),
1714 &dd);
1715 /* Don't destroy the widget if closed by the window manager close button. */
1716 g_signal_connect (G_OBJECT (w), "delete-event", G_CALLBACK (gtk_true), NULL);
1717 gtk_widget_show (w);
1719 record_unwind_protect (pop_down_dialog, make_save_pointer (&dd));
1721 (void) xg_maybe_add_timer (&dd);
1722 g_main_loop_run (dd.loop);
1724 dd.w = 0;
1725 unbind_to (count, Qnil);
1727 return dd.response;
1731 /***********************************************************************
1732 File dialog functions
1733 ***********************************************************************/
1734 /* Return true if the old file selection dialog is being used. */
1736 bool
1737 xg_uses_old_file_dialog (void)
1739 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1740 return x_gtk_use_old_file_dialog;
1741 #else
1742 return 0;
1743 #endif
1747 typedef char * (*xg_get_file_func) (GtkWidget *);
1749 /* Return the selected file for file chooser dialog W.
1750 The returned string must be free:d. */
1752 static char *
1753 xg_get_file_name_from_chooser (GtkWidget *w)
1755 return gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (w));
1758 /* Callback called when the "Show hidden files" toggle is pressed.
1759 WIDGET is the toggle widget, DATA is the file chooser dialog. */
1761 static void
1762 xg_toggle_visibility_cb (GtkWidget *widget, gpointer data)
1764 GtkFileChooser *dialog = GTK_FILE_CHOOSER (data);
1765 gboolean visible;
1766 g_object_get (G_OBJECT (dialog), "show-hidden", &visible, NULL);
1767 g_object_set (G_OBJECT (dialog), "show-hidden", !visible, NULL);
1771 /* Callback called when a property changes in a file chooser.
1772 GOBJECT is the file chooser dialog, ARG1 describes the property.
1773 USER_DATA is the toggle widget in the file chooser dialog.
1774 We use this to update the "Show hidden files" toggle when the user
1775 changes that property by right clicking in the file list. */
1777 static void
1778 xg_toggle_notify_cb (GObject *gobject, GParamSpec *arg1, gpointer user_data)
1780 if (strcmp (arg1->name, "show-hidden") == 0)
1782 GtkWidget *wtoggle = GTK_WIDGET (user_data);
1783 gboolean visible, toggle_on;
1785 g_object_get (G_OBJECT (gobject), "show-hidden", &visible, NULL);
1786 toggle_on = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (wtoggle));
1788 if (!!visible != !!toggle_on)
1790 g_signal_handlers_block_by_func (G_OBJECT (wtoggle),
1791 G_CALLBACK (xg_toggle_visibility_cb),
1792 gobject);
1793 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), visible);
1794 g_signal_handlers_unblock_by_func
1795 (G_OBJECT (wtoggle),
1796 G_CALLBACK (xg_toggle_visibility_cb),
1797 gobject);
1799 x_gtk_show_hidden_files = visible;
1803 /* Read a file name from the user using a file chooser dialog.
1804 F is the current frame.
1805 PROMPT is a prompt to show to the user. May not be NULL.
1806 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1807 If MUSTMATCH_P, the returned file name must be an existing
1808 file. (Actually, this only has cosmetic effects, the user can
1809 still enter a non-existing file.) *FUNC is set to a function that
1810 can be used to retrieve the selected file name from the returned widget.
1812 Returns the created widget. */
1814 static GtkWidget *
1815 xg_get_file_with_chooser (FRAME_PTR f,
1816 char *prompt,
1817 char *default_filename,
1818 bool mustmatch_p, bool only_dir_p,
1819 xg_get_file_func *func)
1821 char msgbuf[1024];
1823 GtkWidget *filewin, *wtoggle, *wbox, *wmessage IF_LINT (= NULL);
1824 GtkWindow *gwin = GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f));
1825 GtkFileChooserAction action = (mustmatch_p ?
1826 GTK_FILE_CHOOSER_ACTION_OPEN :
1827 GTK_FILE_CHOOSER_ACTION_SAVE);
1829 if (only_dir_p)
1830 action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
1832 filewin = gtk_file_chooser_dialog_new (prompt, gwin, action,
1833 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1834 (mustmatch_p || only_dir_p ?
1835 GTK_STOCK_OPEN : GTK_STOCK_OK),
1836 GTK_RESPONSE_OK,
1837 NULL);
1838 gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (filewin), TRUE);
1840 wbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1841 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
1842 gtk_widget_show (wbox);
1843 wtoggle = gtk_check_button_new_with_label ("Show hidden files.");
1845 if (x_gtk_show_hidden_files)
1847 g_object_set (G_OBJECT (filewin), "show-hidden", TRUE, NULL);
1848 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), TRUE);
1850 gtk_widget_show (wtoggle);
1851 g_signal_connect (G_OBJECT (wtoggle), "clicked",
1852 G_CALLBACK (xg_toggle_visibility_cb), filewin);
1853 g_signal_connect (G_OBJECT (filewin), "notify",
1854 G_CALLBACK (xg_toggle_notify_cb), wtoggle);
1856 if (x_gtk_file_dialog_help_text)
1858 msgbuf[0] = '\0';
1859 /* Gtk+ 2.10 has the file name text entry box integrated in the dialog.
1860 Show the C-l help text only for versions < 2.10. */
1861 if (gtk_check_version (2, 10, 0) && action != GTK_FILE_CHOOSER_ACTION_SAVE)
1862 strcat (msgbuf, "\nType C-l to display a file name text entry box.\n");
1863 strcat (msgbuf, "\nIf you don't like this file selector, use the "
1864 "corresponding\nkey binding or customize "
1865 "use-file-dialog to turn it off.");
1867 wmessage = gtk_label_new (msgbuf);
1868 gtk_widget_show (wmessage);
1871 gtk_box_pack_start (GTK_BOX (wbox), wtoggle, FALSE, FALSE, 0);
1872 if (x_gtk_file_dialog_help_text)
1873 gtk_box_pack_start (GTK_BOX (wbox), wmessage, FALSE, FALSE, 0);
1874 gtk_file_chooser_set_extra_widget (GTK_FILE_CHOOSER (filewin), wbox);
1876 if (default_filename)
1878 Lisp_Object file;
1879 struct gcpro gcpro1;
1880 char *utf8_filename;
1881 GCPRO1 (file);
1883 file = build_string (default_filename);
1885 /* File chooser does not understand ~/... in the file name. It must be
1886 an absolute name starting with /. */
1887 if (default_filename[0] != '/')
1888 file = Fexpand_file_name (file, Qnil);
1890 utf8_filename = SSDATA (ENCODE_UTF_8 (file));
1891 if (! NILP (Ffile_directory_p (file)))
1892 gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (filewin),
1893 utf8_filename);
1894 else
1896 gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (filewin),
1897 utf8_filename);
1898 if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
1900 char *cp = strrchr (utf8_filename, '/');
1901 if (cp) ++cp;
1902 else cp = utf8_filename;
1903 gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (filewin), cp);
1907 UNGCPRO;
1910 *func = xg_get_file_name_from_chooser;
1911 return filewin;
1914 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1916 /* Return the selected file for file selector dialog W.
1917 The returned string must be free:d. */
1919 static char *
1920 xg_get_file_name_from_selector (GtkWidget *w)
1922 GtkFileSelection *filesel = GTK_FILE_SELECTION (w);
1923 return xstrdup ((char*) gtk_file_selection_get_filename (filesel));
1926 /* Create a file selection dialog.
1927 F is the current frame.
1928 PROMPT is a prompt to show to the user. May not be NULL.
1929 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1930 If MUSTMATCH_P, the returned file name must be an existing
1931 file. *FUNC is set to a function that can be used to retrieve the
1932 selected file name from the returned widget.
1934 Returns the created widget. */
1936 static GtkWidget *
1937 xg_get_file_with_selection (FRAME_PTR f,
1938 char *prompt,
1939 char *default_filename,
1940 bool mustmatch_p, bool only_dir_p,
1941 xg_get_file_func *func)
1943 GtkWidget *filewin;
1944 GtkFileSelection *filesel;
1946 filewin = gtk_file_selection_new (prompt);
1947 filesel = GTK_FILE_SELECTION (filewin);
1949 if (default_filename)
1950 gtk_file_selection_set_filename (filesel, default_filename);
1952 if (mustmatch_p)
1954 /* The selection_entry part of filesel is not documented. */
1955 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
1956 gtk_file_selection_hide_fileop_buttons (filesel);
1959 *func = xg_get_file_name_from_selector;
1961 return filewin;
1963 #endif /* HAVE_GTK_FILE_SELECTION_NEW */
1965 /* Read a file name from the user using a file dialog, either the old
1966 file selection dialog, or the new file chooser dialog. Which to use
1967 depends on what the GTK version used has, and what the value of
1968 gtk-use-old-file-dialog.
1969 F is the current frame.
1970 PROMPT is a prompt to show to the user. May not be NULL.
1971 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1972 If MUSTMATCH_P, the returned file name must be an existing
1973 file.
1975 Returns a file name or NULL if no file was selected.
1976 The returned string must be freed by the caller. */
1978 char *
1979 xg_get_file_name (FRAME_PTR f,
1980 char *prompt,
1981 char *default_filename,
1982 bool mustmatch_p,
1983 bool only_dir_p)
1985 GtkWidget *w = 0;
1986 char *fn = 0;
1987 int filesel_done = 0;
1988 xg_get_file_func func;
1990 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1992 if (xg_uses_old_file_dialog ())
1993 w = xg_get_file_with_selection (f, prompt, default_filename,
1994 mustmatch_p, only_dir_p, &func);
1995 else
1996 w = xg_get_file_with_chooser (f, prompt, default_filename,
1997 mustmatch_p, only_dir_p, &func);
1999 #else /* not HAVE_GTK_FILE_SELECTION_NEW */
2000 w = xg_get_file_with_chooser (f, prompt, default_filename,
2001 mustmatch_p, only_dir_p, &func);
2002 #endif /* not HAVE_GTK_FILE_SELECTION_NEW */
2004 gtk_widget_set_name (w, "emacs-filedialog");
2006 filesel_done = xg_dialog_run (f, w);
2007 if (filesel_done == GTK_RESPONSE_OK)
2008 fn = (*func) (w);
2010 gtk_widget_destroy (w);
2011 return fn;
2014 /***********************************************************************
2015 GTK font chooser
2016 ***********************************************************************/
2018 #ifdef HAVE_FREETYPE
2020 #if USE_NEW_GTK_FONT_CHOOSER
2022 #define XG_WEIGHT_TO_SYMBOL(w) \
2023 (w <= PANGO_WEIGHT_THIN ? Qextra_light \
2024 : w <= PANGO_WEIGHT_ULTRALIGHT ? Qlight \
2025 : w <= PANGO_WEIGHT_LIGHT ? Qsemi_light \
2026 : w < PANGO_WEIGHT_MEDIUM ? Qnormal \
2027 : w <= PANGO_WEIGHT_SEMIBOLD ? Qsemi_bold \
2028 : w <= PANGO_WEIGHT_BOLD ? Qbold \
2029 : w <= PANGO_WEIGHT_HEAVY ? Qextra_bold \
2030 : Qultra_bold)
2032 #define XG_STYLE_TO_SYMBOL(s) \
2033 (s == PANGO_STYLE_OBLIQUE ? Qoblique \
2034 : s == PANGO_STYLE_ITALIC ? Qitalic \
2035 : Qnormal)
2037 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2040 static char *x_last_font_name;
2041 extern Lisp_Object Qxft;
2043 /* Pop up a GTK font selector and return the name of the font the user
2044 selects, as a C string. The returned font name follows GTK's own
2045 format:
2047 `FAMILY [VALUE1 VALUE2] SIZE'
2049 This can be parsed using font_parse_fcname in font.c.
2050 DEFAULT_NAME, if non-zero, is the default font name. */
2052 Lisp_Object
2053 xg_get_font (FRAME_PTR f, const char *default_name)
2055 GtkWidget *w;
2056 int done = 0;
2057 Lisp_Object font = Qnil;
2059 w = gtk_font_chooser_dialog_new
2060 ("Pick a font", GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2062 if (default_name)
2064 /* Convert fontconfig names to Gtk names, i.e. remove - before
2065 number */
2066 char *p = strrchr (default_name, '-');
2067 if (p)
2069 char *ep = p+1;
2070 while (c_isdigit (*ep))
2071 ++ep;
2072 if (*ep == '\0') *p = ' ';
2075 else if (x_last_font_name)
2076 default_name = x_last_font_name;
2078 if (default_name)
2079 gtk_font_chooser_set_font (GTK_FONT_CHOOSER (w), default_name);
2081 gtk_widget_set_name (w, "emacs-fontdialog");
2082 done = xg_dialog_run (f, w);
2083 if (done == GTK_RESPONSE_OK)
2085 #if USE_NEW_GTK_FONT_CHOOSER
2086 /* Use the GTK3 font chooser. */
2087 PangoFontDescription *desc
2088 = gtk_font_chooser_get_font_desc (GTK_FONT_CHOOSER (w));
2090 if (desc)
2092 Lisp_Object args[10];
2093 const char *name = pango_font_description_get_family (desc);
2094 gint size = pango_font_description_get_size (desc);
2095 PangoWeight weight = pango_font_description_get_weight (desc);
2096 PangoStyle style = pango_font_description_get_style (desc);
2098 args[0] = QCname;
2099 args[1] = build_string (name);
2101 args[2] = QCsize;
2102 args[3] = make_float (pango_units_to_double (size));
2104 args[4] = QCweight;
2105 args[5] = XG_WEIGHT_TO_SYMBOL (weight);
2107 args[6] = QCslant;
2108 args[7] = XG_STYLE_TO_SYMBOL (style);
2110 args[8] = QCtype;
2111 args[9] = Qxft;
2113 font = Ffont_spec (8, args);
2115 pango_font_description_free (desc);
2116 xfree (x_last_font_name);
2117 x_last_font_name = xstrdup (name);
2120 #else /* Use old font selector, which just returns the font name. */
2122 char *font_name
2123 = gtk_font_selection_dialog_get_font_name (GTK_FONT_CHOOSER (w));
2125 if (font_name)
2127 font = build_string (font_name);
2128 g_free (x_last_font_name);
2129 x_last_font_name = font_name;
2131 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2134 gtk_widget_destroy (w);
2135 return font;
2137 #endif /* HAVE_FREETYPE */
2141 /***********************************************************************
2142 Menu functions.
2143 ***********************************************************************/
2145 /* The name of menu items that can be used for customization. Since GTK
2146 RC files are very crude and primitive, we have to set this on all
2147 menu item names so a user can easily customize menu items. */
2149 #define MENU_ITEM_NAME "emacs-menuitem"
2152 /* Linked list of all allocated struct xg_menu_cb_data. Used for marking
2153 during GC. The next member points to the items. */
2154 static xg_list_node xg_menu_cb_list;
2156 /* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
2157 during GC. The next member points to the items. */
2158 static xg_list_node xg_menu_item_cb_list;
2160 /* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
2161 F is the frame CL_DATA will be initialized for.
2162 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2164 The menu bar and all sub menus under the menu bar in a frame
2165 share the same structure, hence the reference count.
2167 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
2168 allocated xg_menu_cb_data if CL_DATA is NULL. */
2170 static xg_menu_cb_data *
2171 make_cl_data (xg_menu_cb_data *cl_data, FRAME_PTR f, GCallback highlight_cb)
2173 if (! cl_data)
2175 cl_data = xmalloc (sizeof *cl_data);
2176 cl_data->f = f;
2177 cl_data->menu_bar_vector = f->menu_bar_vector;
2178 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2179 cl_data->highlight_cb = highlight_cb;
2180 cl_data->ref_count = 0;
2182 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
2185 cl_data->ref_count++;
2187 return cl_data;
2190 /* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
2191 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2193 When the menu bar is updated, menu items may have been added and/or
2194 removed, so menu_bar_vector and menu_bar_items_used change. We must
2195 then update CL_DATA since it is used to determine which menu
2196 item that is invoked in the menu.
2197 HIGHLIGHT_CB could change, there is no check that the same
2198 function is given when modifying a menu bar as was given when
2199 creating the menu bar. */
2201 static void
2202 update_cl_data (xg_menu_cb_data *cl_data,
2203 FRAME_PTR f,
2204 GCallback highlight_cb)
2206 if (cl_data)
2208 cl_data->f = f;
2209 cl_data->menu_bar_vector = f->menu_bar_vector;
2210 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2211 cl_data->highlight_cb = highlight_cb;
2215 /* Decrease reference count for CL_DATA.
2216 If reference count is zero, free CL_DATA. */
2218 static void
2219 unref_cl_data (xg_menu_cb_data *cl_data)
2221 if (cl_data && cl_data->ref_count > 0)
2223 cl_data->ref_count--;
2224 if (cl_data->ref_count == 0)
2226 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
2227 xfree (cl_data);
2232 /* Function that marks all lisp data during GC. */
2234 void
2235 xg_mark_data (void)
2237 xg_list_node *iter;
2238 Lisp_Object rest, frame;
2240 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
2241 mark_object (((xg_menu_cb_data *) iter)->menu_bar_vector);
2243 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
2245 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
2247 if (! NILP (cb_data->help))
2248 mark_object (cb_data->help);
2251 FOR_EACH_FRAME (rest, frame)
2253 FRAME_PTR f = XFRAME (frame);
2255 if (FRAME_X_P (f) && FRAME_GTK_OUTER_WIDGET (f))
2257 struct xg_frame_tb_info *tbinfo
2258 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
2259 TB_INFO_KEY);
2260 if (tbinfo)
2262 mark_object (tbinfo->last_tool_bar);
2263 mark_object (tbinfo->style);
2270 /* Callback called when a menu item is destroyed. Used to free data.
2271 W is the widget that is being destroyed (not used).
2272 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
2274 static void
2275 menuitem_destroy_callback (GtkWidget *w, gpointer client_data)
2277 if (client_data)
2279 xg_menu_item_cb_data *data = (xg_menu_item_cb_data*) client_data;
2280 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
2281 xfree (data);
2285 /* Callback called when the pointer enters/leaves a menu item.
2286 W is the parent of the menu item.
2287 EVENT is either an enter event or leave event.
2288 CLIENT_DATA is not used.
2290 Returns FALSE to tell GTK to keep processing this event. */
2292 static gboolean
2293 menuitem_highlight_callback (GtkWidget *w,
2294 GdkEventCrossing *event,
2295 gpointer client_data)
2297 GdkEvent ev;
2298 GtkWidget *subwidget;
2299 xg_menu_item_cb_data *data;
2301 ev.crossing = *event;
2302 subwidget = gtk_get_event_widget (&ev);
2303 data = (xg_menu_item_cb_data *) g_object_get_data (G_OBJECT (subwidget),
2304 XG_ITEM_DATA);
2305 if (data)
2307 if (! NILP (data->help) && data->cl_data->highlight_cb)
2309 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : data;
2310 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
2311 (*func) (subwidget, call_data);
2315 return FALSE;
2318 /* Callback called when a menu is destroyed. Used to free data.
2319 W is the widget that is being destroyed (not used).
2320 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
2322 static void
2323 menu_destroy_callback (GtkWidget *w, gpointer client_data)
2325 unref_cl_data ((xg_menu_cb_data*) client_data);
2328 /* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
2329 must be non-NULL) and can be inserted into a menu item.
2331 Returns the GtkHBox. */
2333 static GtkWidget *
2334 make_widget_for_menu_item (const char *utf8_label, const char *utf8_key)
2336 GtkWidget *wlbl;
2337 GtkWidget *wkey;
2338 GtkWidget *wbox;
2340 wbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2341 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
2342 wlbl = gtk_label_new (utf8_label);
2343 wkey = gtk_label_new (utf8_key);
2345 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
2346 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
2348 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
2349 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
2351 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
2352 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
2353 gtk_widget_set_name (wbox, MENU_ITEM_NAME);
2355 return wbox;
2358 /* Make and return a menu item widget with the key to the right.
2359 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
2360 UTF8_KEY is the text representing the key binding.
2361 ITEM is the widget_value describing the menu item.
2363 GROUP is an in/out parameter. If the menu item to be created is not
2364 part of any radio menu group, *GROUP contains NULL on entry and exit.
2365 If the menu item to be created is part of a radio menu group, on entry
2366 *GROUP contains the group to use, or NULL if this is the first item
2367 in the group. On exit, *GROUP contains the radio item group.
2369 Unfortunately, keys don't line up as nicely as in Motif,
2370 but the MacOS X version doesn't either, so I guess that is OK. */
2372 static GtkWidget *
2373 make_menu_item (const char *utf8_label,
2374 const char *utf8_key,
2375 widget_value *item,
2376 GSList **group)
2378 GtkWidget *w;
2379 GtkWidget *wtoadd = 0;
2381 /* It has been observed that some menu items have a NULL name field.
2382 This will lead to this function being called with a NULL utf8_label.
2383 GTK crashes on that so we set a blank label. Why there is a NULL
2384 name remains to be investigated. */
2385 if (! utf8_label) utf8_label = " ";
2387 if (utf8_key)
2388 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2390 if (item->button_type == BUTTON_TYPE_TOGGLE)
2392 *group = NULL;
2393 if (utf8_key) w = gtk_check_menu_item_new ();
2394 else w = gtk_check_menu_item_new_with_label (utf8_label);
2395 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
2397 else if (item->button_type == BUTTON_TYPE_RADIO)
2399 if (utf8_key) w = gtk_radio_menu_item_new (*group);
2400 else w = gtk_radio_menu_item_new_with_label (*group, utf8_label);
2401 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
2402 if (item->selected)
2403 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
2405 else
2407 *group = NULL;
2408 if (utf8_key) w = gtk_menu_item_new ();
2409 else w = gtk_menu_item_new_with_label (utf8_label);
2412 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
2413 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
2415 return w;
2418 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
2420 static int xg_detached_menus;
2422 /* Return true if there are detached menus. */
2424 bool
2425 xg_have_tear_offs (void)
2427 return xg_detached_menus > 0;
2430 /* Callback invoked when a detached menu window is removed. Here we
2431 decrease the xg_detached_menus count.
2432 WIDGET is the top level window that is removed (the parent of the menu).
2433 CLIENT_DATA is not used. */
2435 static void
2436 tearoff_remove (GtkWidget *widget, gpointer client_data)
2438 if (xg_detached_menus > 0) --xg_detached_menus;
2441 /* Callback invoked when a menu is detached. It increases the
2442 xg_detached_menus count.
2443 WIDGET is the GtkTearoffMenuItem.
2444 CLIENT_DATA is not used. */
2446 static void
2447 tearoff_activate (GtkWidget *widget, gpointer client_data)
2449 GtkWidget *menu = gtk_widget_get_parent (widget);
2450 if (gtk_menu_get_tearoff_state (GTK_MENU (menu)))
2452 ++xg_detached_menus;
2453 g_signal_connect (G_OBJECT (gtk_widget_get_toplevel (widget)),
2454 "destroy",
2455 G_CALLBACK (tearoff_remove), 0);
2458 #else /* ! HAVE_GTK_TEAROFF_MENU_ITEM_NEW */
2459 bool
2460 xg_have_tear_offs (void)
2462 return false;
2464 #endif /* ! HAVE_GTK_TEAROFF_MENU_ITEM_NEW */
2466 /* Create a menu item widget, and connect the callbacks.
2467 ITEM describes the menu item.
2468 F is the frame the created menu belongs to.
2469 SELECT_CB is the callback to use when a menu item is selected.
2470 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2471 CL_DATA points to the callback data to be used for this menu.
2472 GROUP is an in/out parameter. If the menu item to be created is not
2473 part of any radio menu group, *GROUP contains NULL on entry and exit.
2474 If the menu item to be created is part of a radio menu group, on entry
2475 *GROUP contains the group to use, or NULL if this is the first item
2476 in the group. On exit, *GROUP contains the radio item group.
2478 Returns the created GtkWidget. */
2480 static GtkWidget *
2481 xg_create_one_menuitem (widget_value *item,
2482 FRAME_PTR f,
2483 GCallback select_cb,
2484 GCallback highlight_cb,
2485 xg_menu_cb_data *cl_data,
2486 GSList **group)
2488 char *utf8_label;
2489 char *utf8_key;
2490 GtkWidget *w;
2491 xg_menu_item_cb_data *cb_data;
2493 utf8_label = get_utf8_string (item->name);
2494 utf8_key = get_utf8_string (item->key);
2496 w = make_menu_item (utf8_label, utf8_key, item, group);
2498 if (utf8_label) g_free (utf8_label);
2499 if (utf8_key) g_free (utf8_key);
2501 cb_data = xmalloc (sizeof *cb_data);
2503 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
2505 cb_data->select_id = 0;
2506 cb_data->help = item->help;
2507 cb_data->cl_data = cl_data;
2508 cb_data->call_data = item->call_data;
2510 g_signal_connect (G_OBJECT (w),
2511 "destroy",
2512 G_CALLBACK (menuitem_destroy_callback),
2513 cb_data);
2515 /* Put cb_data in widget, so we can get at it when modifying menubar */
2516 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
2518 /* final item, not a submenu */
2519 if (item->call_data && ! item->contents)
2521 if (select_cb)
2522 cb_data->select_id
2523 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
2526 return w;
2529 /* Create a full menu tree specified by DATA.
2530 F is the frame the created menu belongs to.
2531 SELECT_CB is the callback to use when a menu item is selected.
2532 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2533 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2534 If POP_UP_P, create a popup menu.
2535 If MENU_BAR_P, create a menu bar.
2536 If ADD_TEAROFF_P, add a tearoff menu item. Ignored if MENU_BAR_P or
2537 the Gtk+ version used does not have tearoffs.
2538 TOPMENU is the topmost GtkWidget that others shall be placed under.
2539 It may be NULL, in that case we create the appropriate widget
2540 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
2541 CL_DATA is the callback data we shall use for this menu, or NULL
2542 if we haven't set the first callback yet.
2543 NAME is the name to give to the top level menu if this function
2544 creates it. May be NULL to not set any name.
2546 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
2547 not NULL.
2549 This function calls itself to create submenus. */
2551 static GtkWidget *
2552 create_menus (widget_value *data,
2553 FRAME_PTR f,
2554 GCallback select_cb,
2555 GCallback deactivate_cb,
2556 GCallback highlight_cb,
2557 bool pop_up_p,
2558 bool menu_bar_p,
2559 bool add_tearoff_p,
2560 GtkWidget *topmenu,
2561 xg_menu_cb_data *cl_data,
2562 const char *name)
2564 widget_value *item;
2565 GtkWidget *wmenu = topmenu;
2566 GSList *group = NULL;
2568 if (! topmenu)
2570 if (! menu_bar_p)
2572 wmenu = gtk_menu_new ();
2573 xg_set_screen (wmenu, f);
2574 /* Connect this to the menu instead of items so we get enter/leave for
2575 disabled items also. TODO: Still does not get enter/leave for
2576 disabled items in detached menus. */
2577 g_signal_connect (G_OBJECT (wmenu),
2578 "enter-notify-event",
2579 G_CALLBACK (menuitem_highlight_callback),
2580 NULL);
2581 g_signal_connect (G_OBJECT (wmenu),
2582 "leave-notify-event",
2583 G_CALLBACK (menuitem_highlight_callback),
2584 NULL);
2586 else
2588 wmenu = gtk_menu_bar_new ();
2589 /* Set width of menu bar to a small value so it doesn't enlarge
2590 a small initial frame size. The width will be set to the
2591 width of the frame later on when it is added to a container.
2592 height -1: Natural height. */
2593 gtk_widget_set_size_request (wmenu, 1, -1);
2596 /* Put cl_data on the top menu for easier access. */
2597 cl_data = make_cl_data (cl_data, f, highlight_cb);
2598 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
2599 g_signal_connect (G_OBJECT (wmenu), "destroy",
2600 G_CALLBACK (menu_destroy_callback), cl_data);
2602 if (name)
2603 gtk_widget_set_name (wmenu, name);
2605 if (deactivate_cb)
2606 g_signal_connect (G_OBJECT (wmenu),
2607 "selection-done", deactivate_cb, 0);
2610 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
2611 if (! menu_bar_p && add_tearoff_p)
2613 GtkWidget *tearoff = gtk_tearoff_menu_item_new ();
2614 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), tearoff);
2616 g_signal_connect (G_OBJECT (tearoff), "activate",
2617 G_CALLBACK (tearoff_activate), 0);
2619 #endif
2621 for (item = data; item; item = item->next)
2623 GtkWidget *w;
2625 if (pop_up_p && !item->contents && !item->call_data
2626 && !menu_separator_name_p (item->name))
2628 char *utf8_label;
2629 /* A title for a popup. We do the same as GTK does when
2630 creating titles, but it does not look good. */
2631 group = NULL;
2632 utf8_label = get_utf8_string (item->name);
2634 gtk_menu_set_title (GTK_MENU (wmenu), utf8_label);
2635 w = gtk_menu_item_new_with_label (utf8_label);
2636 gtk_widget_set_sensitive (w, FALSE);
2637 if (utf8_label) g_free (utf8_label);
2639 else if (menu_separator_name_p (item->name))
2641 group = NULL;
2642 /* GTK only have one separator type. */
2643 w = gtk_separator_menu_item_new ();
2645 else
2647 w = xg_create_one_menuitem (item,
2649 item->contents ? 0 : select_cb,
2650 highlight_cb,
2651 cl_data,
2652 &group);
2654 /* Create a possibly empty submenu for menu bar items, since some
2655 themes don't highlight items correctly without it. */
2656 if (item->contents || menu_bar_p)
2658 GtkWidget *submenu = create_menus (item->contents,
2660 select_cb,
2661 deactivate_cb,
2662 highlight_cb,
2665 add_tearoff_p,
2667 cl_data,
2669 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2673 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
2674 gtk_widget_set_name (w, MENU_ITEM_NAME);
2677 return wmenu;
2680 /* Create a menubar, popup menu or dialog, depending on the TYPE argument.
2681 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
2682 with some text and buttons.
2683 F is the frame the created item belongs to.
2684 NAME is the name to use for the top widget.
2685 VAL is a widget_value structure describing items to be created.
2686 SELECT_CB is the callback to use when a menu item is selected or
2687 a dialog button is pressed.
2688 DEACTIVATE_CB is the callback to use when an item is deactivated.
2689 For a menu, when a sub menu is not shown anymore, for a dialog it is
2690 called when the dialog is popped down.
2691 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2693 Returns the widget created. */
2695 GtkWidget *
2696 xg_create_widget (const char *type, const char *name, FRAME_PTR f, widget_value *val,
2697 GCallback select_cb, GCallback deactivate_cb,
2698 GCallback highlight_cb)
2700 GtkWidget *w = 0;
2701 bool menu_bar_p = strcmp (type, "menubar") == 0;
2702 bool pop_up_p = strcmp (type, "popup") == 0;
2704 if (strcmp (type, "dialog") == 0)
2706 w = create_dialog (val, select_cb, deactivate_cb);
2707 xg_set_screen (w, f);
2708 gtk_window_set_transient_for (GTK_WINDOW (w),
2709 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2710 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
2711 gtk_widget_set_name (w, "emacs-dialog");
2712 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
2714 else if (menu_bar_p || pop_up_p)
2716 w = create_menus (val->contents,
2718 select_cb,
2719 deactivate_cb,
2720 highlight_cb,
2721 pop_up_p,
2722 menu_bar_p,
2723 menu_bar_p,
2726 name);
2728 /* Set the cursor to an arrow for popup menus when they are mapped.
2729 This is done by default for menu bar menus. */
2730 if (pop_up_p)
2732 /* Must realize so the GdkWindow inside the widget is created. */
2733 gtk_widget_realize (w);
2734 xg_set_cursor (w, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
2737 else
2739 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
2740 type);
2743 return w;
2746 /* Return the label for menu item WITEM. */
2748 static const char *
2749 xg_get_menu_item_label (GtkMenuItem *witem)
2751 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2752 return gtk_label_get_label (wlabel);
2755 /* Return true if the menu item WITEM has the text LABEL. */
2757 static bool
2758 xg_item_label_same_p (GtkMenuItem *witem, const char *label)
2760 bool is_same = 0;
2761 char *utf8_label = get_utf8_string (label);
2762 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
2764 if (! old_label && ! utf8_label)
2765 is_same = 1;
2766 else if (old_label && utf8_label)
2767 is_same = strcmp (utf8_label, old_label) == 0;
2769 if (utf8_label) g_free (utf8_label);
2771 return is_same;
2774 /* Destroy widgets in LIST. */
2776 static void
2777 xg_destroy_widgets (GList *list)
2779 GList *iter;
2781 for (iter = list; iter; iter = g_list_next (iter))
2783 GtkWidget *w = GTK_WIDGET (iter->data);
2785 /* Destroying the widget will remove it from the container it is in. */
2786 gtk_widget_destroy (w);
2790 /* Update the top level names in MENUBAR (i.e. not submenus).
2791 F is the frame the menu bar belongs to.
2792 *LIST is a list with the current menu bar names (menu item widgets).
2793 ITER is the item within *LIST that shall be updated.
2794 POS is the numerical position, starting at 0, of ITER in *LIST.
2795 VAL describes what the menu bar shall look like after the update.
2796 SELECT_CB is the callback to use when a menu item is selected.
2797 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2798 CL_DATA points to the callback data to be used for this menu bar.
2800 This function calls itself to walk through the menu bar names. */
2802 static void
2803 xg_update_menubar (GtkWidget *menubar,
2804 FRAME_PTR f,
2805 GList **list,
2806 GList *iter,
2807 int pos,
2808 widget_value *val,
2809 GCallback select_cb,
2810 GCallback deactivate_cb,
2811 GCallback highlight_cb,
2812 xg_menu_cb_data *cl_data)
2814 if (! iter && ! val)
2815 return;
2816 else if (iter && ! val)
2818 /* Item(s) have been removed. Remove all remaining items. */
2819 xg_destroy_widgets (iter);
2821 /* Add a blank entry so the menubar doesn't collapse to nothing. */
2822 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2823 gtk_menu_item_new_with_label (""),
2825 /* All updated. */
2826 val = 0;
2827 iter = 0;
2829 else if (! iter && val)
2831 /* Item(s) added. Add all new items in one call. */
2832 create_menus (val, f, select_cb, deactivate_cb, highlight_cb,
2833 0, 1, 0, menubar, cl_data, 0);
2835 /* All updated. */
2836 val = 0;
2837 iter = 0;
2839 /* Below this neither iter or val is NULL */
2840 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
2842 /* This item is still the same, check next item. */
2843 val = val->next;
2844 iter = g_list_next (iter);
2845 ++pos;
2847 else /* This item is changed. */
2849 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
2850 GtkMenuItem *witem2 = 0;
2851 bool val_in_menubar = 0;
2852 bool iter_in_new_menubar = 0;
2853 GList *iter2;
2854 widget_value *cur;
2856 /* See if the changed entry (val) is present later in the menu bar */
2857 for (iter2 = iter;
2858 iter2 && ! val_in_menubar;
2859 iter2 = g_list_next (iter2))
2861 witem2 = GTK_MENU_ITEM (iter2->data);
2862 val_in_menubar = xg_item_label_same_p (witem2, val->name);
2865 /* See if the current entry (iter) is present later in the
2866 specification for the new menu bar. */
2867 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
2868 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
2870 if (val_in_menubar && ! iter_in_new_menubar)
2872 int nr = pos;
2874 /* This corresponds to:
2875 Current: A B C
2876 New: A C
2877 Remove B. */
2879 g_object_ref (G_OBJECT (witem));
2880 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
2881 gtk_widget_destroy (GTK_WIDGET (witem));
2883 /* Must get new list since the old changed. */
2884 g_list_free (*list);
2885 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2886 while (nr-- > 0) iter = g_list_next (iter);
2888 else if (! val_in_menubar && ! iter_in_new_menubar)
2890 /* This corresponds to:
2891 Current: A B C
2892 New: A X C
2893 Rename B to X. This might seem to be a strange thing to do,
2894 since if there is a menu under B it will be totally wrong for X.
2895 But consider editing a C file. Then there is a C-mode menu
2896 (corresponds to B above).
2897 If then doing C-x C-f the minibuf menu (X above) replaces the
2898 C-mode menu. When returning from the minibuffer, we get
2899 back the C-mode menu. Thus we do:
2900 Rename B to X (C-mode to minibuf menu)
2901 Rename X to B (minibuf to C-mode menu).
2902 If the X menu hasn't been invoked, the menu under B
2903 is up to date when leaving the minibuffer. */
2904 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2905 char *utf8_label = get_utf8_string (val->name);
2906 GtkWidget *submenu = gtk_menu_item_get_submenu (witem);
2908 gtk_label_set_text (wlabel, utf8_label);
2910 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
2911 /* If this item has a submenu that has been detached, change
2912 the title in the WM decorations also. */
2913 if (submenu && gtk_menu_get_tearoff_state (GTK_MENU (submenu)))
2914 /* Set the title of the detached window. */
2915 gtk_menu_set_title (GTK_MENU (submenu), utf8_label);
2916 #endif
2918 if (utf8_label) g_free (utf8_label);
2919 iter = g_list_next (iter);
2920 val = val->next;
2921 ++pos;
2923 else if (! val_in_menubar && iter_in_new_menubar)
2925 /* This corresponds to:
2926 Current: A B C
2927 New: A X B C
2928 Insert X. */
2930 int nr = pos;
2931 GSList *group = 0;
2932 GtkWidget *w = xg_create_one_menuitem (val,
2934 select_cb,
2935 highlight_cb,
2936 cl_data,
2937 &group);
2939 /* Create a possibly empty submenu for menu bar items, since some
2940 themes don't highlight items correctly without it. */
2941 GtkWidget *submenu = create_menus (NULL, f,
2942 select_cb, deactivate_cb,
2943 highlight_cb,
2944 0, 0, 0, 0, cl_data, 0);
2945 gtk_widget_set_name (w, MENU_ITEM_NAME);
2946 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
2947 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2949 g_list_free (*list);
2950 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2951 while (nr-- > 0) iter = g_list_next (iter);
2952 iter = g_list_next (iter);
2953 val = val->next;
2954 ++pos;
2956 else /* if (val_in_menubar && iter_in_new_menubar) */
2958 int nr = pos;
2959 /* This corresponds to:
2960 Current: A B C
2961 New: A C B
2962 Move C before B */
2964 g_object_ref (G_OBJECT (witem2));
2965 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
2966 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2967 GTK_WIDGET (witem2), pos);
2968 g_object_unref (G_OBJECT (witem2));
2970 g_list_free (*list);
2971 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2972 while (nr-- > 0) iter = g_list_next (iter);
2973 if (iter) iter = g_list_next (iter);
2974 val = val->next;
2975 ++pos;
2979 /* Update the rest of the menu bar. */
2980 xg_update_menubar (menubar, f, list, iter, pos, val,
2981 select_cb, deactivate_cb, highlight_cb, cl_data);
2984 /* Update the menu item W so it corresponds to VAL.
2985 SELECT_CB is the callback to use when a menu item is selected.
2986 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2987 CL_DATA is the data to set in the widget for menu invocation. */
2989 static void
2990 xg_update_menu_item (widget_value *val,
2991 GtkWidget *w,
2992 GCallback select_cb,
2993 GCallback highlight_cb,
2994 xg_menu_cb_data *cl_data)
2996 GtkWidget *wchild;
2997 GtkLabel *wlbl = 0;
2998 GtkLabel *wkey = 0;
2999 char *utf8_label;
3000 char *utf8_key;
3001 const char *old_label = 0;
3002 const char *old_key = 0;
3003 xg_menu_item_cb_data *cb_data;
3005 wchild = XG_BIN_CHILD (w);
3006 utf8_label = get_utf8_string (val->name);
3007 utf8_key = get_utf8_string (val->key);
3009 /* See if W is a menu item with a key. See make_menu_item above. */
3010 if (GTK_IS_BOX (wchild))
3012 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
3014 wlbl = GTK_LABEL (list->data);
3015 wkey = GTK_LABEL (list->next->data);
3016 g_list_free (list);
3018 if (! utf8_key)
3020 /* Remove the key and keep just the label. */
3021 g_object_ref (G_OBJECT (wlbl));
3022 gtk_container_remove (GTK_CONTAINER (w), wchild);
3023 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
3024 g_object_unref (G_OBJECT (wlbl));
3025 wkey = 0;
3029 else /* Just a label. */
3031 wlbl = GTK_LABEL (wchild);
3033 /* Check if there is now a key. */
3034 if (utf8_key)
3036 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
3037 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
3039 wlbl = GTK_LABEL (list->data);
3040 wkey = GTK_LABEL (list->next->data);
3041 g_list_free (list);
3043 gtk_container_remove (GTK_CONTAINER (w), wchild);
3044 gtk_container_add (GTK_CONTAINER (w), wtoadd);
3049 if (wkey) old_key = gtk_label_get_label (wkey);
3050 if (wlbl) old_label = gtk_label_get_label (wlbl);
3052 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
3053 gtk_label_set_text (wkey, utf8_key);
3055 if (! old_label || strcmp (utf8_label, old_label) != 0)
3056 gtk_label_set_text (wlbl, utf8_label);
3058 if (utf8_key) g_free (utf8_key);
3059 if (utf8_label) g_free (utf8_label);
3061 if (! val->enabled && gtk_widget_get_sensitive (w))
3062 gtk_widget_set_sensitive (w, FALSE);
3063 else if (val->enabled && ! gtk_widget_get_sensitive (w))
3064 gtk_widget_set_sensitive (w, TRUE);
3066 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (w),
3067 XG_ITEM_DATA);
3068 if (cb_data)
3070 cb_data->call_data = val->call_data;
3071 cb_data->help = val->help;
3072 cb_data->cl_data = cl_data;
3074 /* We assume the callback functions don't change. */
3075 if (val->call_data && ! val->contents)
3077 /* This item shall have a select callback. */
3078 if (! cb_data->select_id)
3079 cb_data->select_id
3080 = g_signal_connect (G_OBJECT (w), "activate",
3081 select_cb, cb_data);
3083 else if (cb_data->select_id)
3085 g_signal_handler_disconnect (w, cb_data->select_id);
3086 cb_data->select_id = 0;
3091 /* Update the toggle menu item W so it corresponds to VAL. */
3093 static void
3094 xg_update_toggle_item (widget_value *val, GtkWidget *w)
3096 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3099 /* Update the radio menu item W so it corresponds to VAL. */
3101 static void
3102 xg_update_radio_item (widget_value *val, GtkWidget *w)
3104 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3107 /* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
3108 SUBMENU may be NULL, in that case a new menu is created.
3109 F is the frame the menu bar belongs to.
3110 VAL describes the contents of the menu bar.
3111 SELECT_CB is the callback to use when a menu item is selected.
3112 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3113 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
3114 CL_DATA is the call back data to use for any newly created items.
3116 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
3117 was NULL. */
3119 static GtkWidget *
3120 xg_update_submenu (GtkWidget *submenu,
3121 FRAME_PTR f,
3122 widget_value *val,
3123 GCallback select_cb,
3124 GCallback deactivate_cb,
3125 GCallback highlight_cb,
3126 xg_menu_cb_data *cl_data)
3128 GtkWidget *newsub = submenu;
3129 GList *list = 0;
3130 GList *iter;
3131 widget_value *cur;
3132 bool has_tearoff_p = 0;
3133 GList *first_radio = 0;
3135 if (submenu)
3136 list = gtk_container_get_children (GTK_CONTAINER (submenu));
3138 for (cur = val, iter = list;
3139 cur && iter;
3140 iter = g_list_next (iter), cur = cur->next)
3142 GtkWidget *w = GTK_WIDGET (iter->data);
3144 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
3145 /* Skip tearoff items, they have no counterpart in val. */
3146 if (GTK_IS_TEAROFF_MENU_ITEM (w))
3148 has_tearoff_p = 1;
3149 iter = g_list_next (iter);
3150 if (iter) w = GTK_WIDGET (iter->data);
3151 else break;
3153 #endif
3155 /* Remember first radio button in a group. If we get a mismatch in
3156 a radio group we must rebuild the whole group so that the connections
3157 in GTK becomes correct. */
3158 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
3159 first_radio = iter;
3160 else if (cur->button_type != BUTTON_TYPE_RADIO
3161 && ! GTK_IS_RADIO_MENU_ITEM (w))
3162 first_radio = 0;
3164 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
3166 if (! menu_separator_name_p (cur->name))
3167 break;
3169 else if (GTK_IS_CHECK_MENU_ITEM (w))
3171 if (cur->button_type != BUTTON_TYPE_TOGGLE)
3172 break;
3173 xg_update_toggle_item (cur, w);
3174 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3176 else if (GTK_IS_RADIO_MENU_ITEM (w))
3178 if (cur->button_type != BUTTON_TYPE_RADIO)
3179 break;
3180 xg_update_radio_item (cur, w);
3181 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3183 else if (GTK_IS_MENU_ITEM (w))
3185 GtkMenuItem *witem = GTK_MENU_ITEM (w);
3186 GtkWidget *sub;
3188 if (cur->button_type != BUTTON_TYPE_NONE ||
3189 menu_separator_name_p (cur->name))
3190 break;
3192 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3194 sub = gtk_menu_item_get_submenu (witem);
3195 if (sub && ! cur->contents)
3197 /* Not a submenu anymore. */
3198 g_object_ref (G_OBJECT (sub));
3199 remove_submenu (witem);
3200 gtk_widget_destroy (sub);
3202 else if (cur->contents)
3204 GtkWidget *nsub;
3206 nsub = xg_update_submenu (sub, f, cur->contents,
3207 select_cb, deactivate_cb,
3208 highlight_cb, cl_data);
3210 /* If this item just became a submenu, we must set it. */
3211 if (nsub != sub)
3212 gtk_menu_item_set_submenu (witem, nsub);
3215 else
3217 /* Structural difference. Remove everything from here and down
3218 in SUBMENU. */
3219 break;
3223 /* Remove widgets from first structural change. */
3224 if (iter)
3226 /* If we are adding new menu items below, we must remove from
3227 first radio button so that radio groups become correct. */
3228 if (cur && first_radio) xg_destroy_widgets (first_radio);
3229 else xg_destroy_widgets (iter);
3232 if (cur)
3234 /* More items added. Create them. */
3235 newsub = create_menus (cur,
3237 select_cb,
3238 deactivate_cb,
3239 highlight_cb,
3242 ! has_tearoff_p,
3243 submenu,
3244 cl_data,
3248 if (list) g_list_free (list);
3250 return newsub;
3253 /* Update the MENUBAR.
3254 F is the frame the menu bar belongs to.
3255 VAL describes the contents of the menu bar.
3256 If DEEP_P, rebuild all but the top level menu names in
3257 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
3258 SELECT_CB is the callback to use when a menu item is selected.
3259 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3260 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
3262 void
3263 xg_modify_menubar_widgets (GtkWidget *menubar, FRAME_PTR f, widget_value *val,
3264 bool deep_p,
3265 GCallback select_cb, GCallback deactivate_cb,
3266 GCallback highlight_cb)
3268 xg_menu_cb_data *cl_data;
3269 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
3271 if (! list) return;
3273 cl_data = (xg_menu_cb_data*) g_object_get_data (G_OBJECT (menubar),
3274 XG_FRAME_DATA);
3276 xg_update_menubar (menubar, f, &list, list, 0, val->contents,
3277 select_cb, deactivate_cb, highlight_cb, cl_data);
3279 if (deep_p)
3281 widget_value *cur;
3283 /* Update all sub menus.
3284 We must keep the submenus (GTK menu item widgets) since the
3285 X Window in the XEvent that activates the menu are those widgets. */
3287 /* Update cl_data, menu_item things in F may have changed. */
3288 update_cl_data (cl_data, f, highlight_cb);
3290 for (cur = val->contents; cur; cur = cur->next)
3292 GList *iter;
3293 GtkWidget *sub = 0;
3294 GtkWidget *newsub;
3295 GtkMenuItem *witem = 0;
3297 /* Find sub menu that corresponds to val and update it. */
3298 for (iter = list ; iter; iter = g_list_next (iter))
3300 witem = GTK_MENU_ITEM (iter->data);
3301 if (xg_item_label_same_p (witem, cur->name))
3303 sub = gtk_menu_item_get_submenu (witem);
3304 break;
3308 newsub = xg_update_submenu (sub,
3310 cur->contents,
3311 select_cb,
3312 deactivate_cb,
3313 highlight_cb,
3314 cl_data);
3315 /* sub may still be NULL. If we just updated non deep and added
3316 a new menu bar item, it has no sub menu yet. So we set the
3317 newly created sub menu under witem. */
3318 if (newsub != sub && witem != 0)
3320 xg_set_screen (newsub, f);
3321 gtk_menu_item_set_submenu (witem, newsub);
3326 g_list_free (list);
3327 gtk_widget_show_all (menubar);
3330 /* Callback called when the menu bar W is mapped.
3331 Used to find the height of the menu bar if we didn't get it
3332 after showing the widget. */
3334 static void
3335 menubar_map_cb (GtkWidget *w, gpointer user_data)
3337 GtkRequisition req;
3338 FRAME_PTR f = (FRAME_PTR) user_data;
3339 gtk_widget_get_preferred_size (w, NULL, &req);
3340 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3342 FRAME_MENUBAR_HEIGHT (f) = req.height;
3343 xg_height_or_width_changed (f);
3347 /* Recompute all the widgets of frame F, when the menu bar has been
3348 changed. */
3350 void
3351 xg_update_frame_menubar (FRAME_PTR f)
3353 struct x_output *x = f->output_data.x;
3354 GtkRequisition req;
3356 if (!x->menubar_widget || gtk_widget_get_mapped (x->menubar_widget))
3357 return;
3359 if (x->menubar_widget && gtk_widget_get_parent (x->menubar_widget))
3360 return; /* Already done this, happens for frames created invisible. */
3362 block_input ();
3364 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
3365 FALSE, FALSE, 0);
3366 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
3368 g_signal_connect (x->menubar_widget, "map", G_CALLBACK (menubar_map_cb), f);
3369 gtk_widget_show_all (x->menubar_widget);
3370 gtk_widget_get_preferred_size (x->menubar_widget, NULL, &req);
3372 /* If menu bar doesn't know its height yet, cheat a little so the frame
3373 doesn't jump so much when resized later in menubar_map_cb. */
3374 if (req.height == 0)
3375 req.height = 23;
3377 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3379 FRAME_MENUBAR_HEIGHT (f) = req.height;
3380 xg_height_or_width_changed (f);
3382 unblock_input ();
3385 /* Get rid of the menu bar of frame F, and free its storage.
3386 This is used when deleting a frame, and when turning off the menu bar. */
3388 void
3389 free_frame_menubar (FRAME_PTR f)
3391 struct x_output *x = f->output_data.x;
3393 if (x->menubar_widget)
3395 block_input ();
3397 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
3398 /* The menubar and its children shall be deleted when removed from
3399 the container. */
3400 x->menubar_widget = 0;
3401 FRAME_MENUBAR_HEIGHT (f) = 0;
3402 xg_height_or_width_changed (f);
3403 unblock_input ();
3407 bool
3408 xg_event_is_for_menubar (FRAME_PTR f, XEvent *event)
3410 struct x_output *x = f->output_data.x;
3411 GList *iter;
3412 GdkRectangle rec;
3413 GList *list;
3414 GdkDisplay *gdpy;
3415 GdkWindow *gw;
3416 GdkEvent gevent;
3417 GtkWidget *gwdesc;
3419 if (! x->menubar_widget) return 0;
3421 if (! (event->xbutton.x >= 0
3422 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
3423 && event->xbutton.y >= 0
3424 && event->xbutton.y < f->output_data.x->menubar_height
3425 && event->xbutton.same_screen))
3426 return 0;
3428 gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3429 gw = gdk_x11_window_lookup_for_display (gdpy, event->xbutton.window);
3430 if (! gw) return 0;
3431 gevent.any.window = gw;
3432 gevent.any.type = GDK_NOTHING;
3433 gwdesc = gtk_get_event_widget (&gevent);
3434 if (! gwdesc) return 0;
3435 if (! GTK_IS_MENU_BAR (gwdesc)
3436 && ! GTK_IS_MENU_ITEM (gwdesc)
3437 && ! gtk_widget_is_ancestor (x->menubar_widget, gwdesc))
3438 return 0;
3440 list = gtk_container_get_children (GTK_CONTAINER (x->menubar_widget));
3441 if (! list) return 0;
3442 rec.x = event->xbutton.x;
3443 rec.y = event->xbutton.y;
3444 rec.width = 1;
3445 rec.height = 1;
3447 for (iter = list ; iter; iter = g_list_next (iter))
3449 GtkWidget *w = GTK_WIDGET (iter->data);
3450 if (gtk_widget_get_mapped (w) && gtk_widget_intersect (w, &rec, NULL))
3451 break;
3453 g_list_free (list);
3454 return iter != 0;
3459 /***********************************************************************
3460 Scroll bar functions
3461 ***********************************************************************/
3464 /* Setting scroll bar values invokes the callback. Use this variable
3465 to indicate that callback should do nothing. */
3467 bool xg_ignore_gtk_scrollbar;
3469 /* The width of the scroll bar for the current theme. */
3471 static int scroll_bar_width_for_theme;
3473 /* Xlib's `Window' fits in 32 bits. But we want to store pointers, and they
3474 may be larger than 32 bits. Keep a mapping from integer index to widget
3475 pointers to get around the 32 bit limitation. */
3477 static struct
3479 GtkWidget **widgets;
3480 ptrdiff_t max_size;
3481 ptrdiff_t used;
3482 } id_to_widget;
3484 /* Grow this much every time we need to allocate more */
3486 #define ID_TO_WIDGET_INCR 32
3488 /* Store the widget pointer W in id_to_widget and return the integer index. */
3490 static ptrdiff_t
3491 xg_store_widget_in_map (GtkWidget *w)
3493 ptrdiff_t i;
3495 if (id_to_widget.max_size == id_to_widget.used)
3497 ptrdiff_t new_size;
3498 if (TYPE_MAXIMUM (Window) - ID_TO_WIDGET_INCR < id_to_widget.max_size)
3499 memory_full (SIZE_MAX);
3501 new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
3502 id_to_widget.widgets = xnrealloc (id_to_widget.widgets,
3503 new_size, sizeof (GtkWidget *));
3505 for (i = id_to_widget.max_size; i < new_size; ++i)
3506 id_to_widget.widgets[i] = 0;
3507 id_to_widget.max_size = new_size;
3510 /* Just loop over the array and find a free place. After all,
3511 how many scroll bars are we creating? Should be a small number.
3512 The check above guarantees we will find a free place. */
3513 for (i = 0; i < id_to_widget.max_size; ++i)
3515 if (! id_to_widget.widgets[i])
3517 id_to_widget.widgets[i] = w;
3518 ++id_to_widget.used;
3520 return i;
3524 /* Should never end up here */
3525 emacs_abort ();
3528 /* Remove pointer at IDX from id_to_widget.
3529 Called when scroll bar is destroyed. */
3531 static void
3532 xg_remove_widget_from_map (ptrdiff_t idx)
3534 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3536 id_to_widget.widgets[idx] = 0;
3537 --id_to_widget.used;
3541 /* Get the widget pointer at IDX from id_to_widget. */
3543 static GtkWidget *
3544 xg_get_widget_from_map (ptrdiff_t idx)
3546 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3547 return id_to_widget.widgets[idx];
3549 return 0;
3552 static void
3553 update_theme_scrollbar_width (void)
3555 #ifdef HAVE_GTK3
3556 GtkAdjustment *vadj;
3557 #else
3558 GtkObject *vadj;
3559 #endif
3560 GtkWidget *wscroll;
3561 int w = 0, b = 0;
3563 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX, 0.1, 0.1, 0.1);
3564 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3565 g_object_ref_sink (G_OBJECT (wscroll));
3566 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3567 gtk_widget_destroy (wscroll);
3568 g_object_unref (G_OBJECT (wscroll));
3569 w += 2*b;
3570 if (w < 16) w = 16;
3571 scroll_bar_width_for_theme = w;
3575 xg_get_default_scrollbar_width (void)
3577 return scroll_bar_width_for_theme;
3580 /* Return the scrollbar id for X Window WID on display DPY.
3581 Return -1 if WID not in id_to_widget. */
3583 ptrdiff_t
3584 xg_get_scroll_id_for_window (Display *dpy, Window wid)
3586 ptrdiff_t idx;
3587 GtkWidget *w;
3589 w = xg_win_to_widget (dpy, wid);
3591 if (w)
3593 for (idx = 0; idx < id_to_widget.max_size; ++idx)
3594 if (id_to_widget.widgets[idx] == w)
3595 return idx;
3598 return -1;
3601 /* Callback invoked when scroll bar WIDGET is destroyed.
3602 DATA is the index into id_to_widget for WIDGET.
3603 We free pointer to last scroll bar values here and remove the index. */
3605 static void
3606 xg_gtk_scroll_destroy (GtkWidget *widget, gpointer data)
3608 intptr_t id = (intptr_t) data;
3609 xg_remove_widget_from_map (id);
3612 /* Create a scroll bar widget for frame F. Store the scroll bar
3613 in BAR.
3614 SCROLL_CALLBACK is the callback to invoke when the value of the
3615 bar changes.
3616 END_CALLBACK is the callback to invoke when scrolling ends.
3617 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
3618 to set resources for the widget. */
3620 void
3621 xg_create_scroll_bar (FRAME_PTR f,
3622 struct scroll_bar *bar,
3623 GCallback scroll_callback,
3624 GCallback end_callback,
3625 const char *scroll_bar_name)
3627 GtkWidget *wscroll;
3628 GtkWidget *webox;
3629 intptr_t scroll_id;
3630 #ifdef HAVE_GTK3
3631 GtkAdjustment *vadj;
3632 #else
3633 GtkObject *vadj;
3634 #endif
3636 /* Page, step increment values are not so important here, they
3637 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3638 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
3639 0.1, 0.1, 0.1);
3641 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3642 webox = gtk_event_box_new ();
3643 gtk_widget_set_name (wscroll, scroll_bar_name);
3644 #ifndef HAVE_GTK3
3645 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3646 #endif
3647 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3649 scroll_id = xg_store_widget_in_map (wscroll);
3651 g_signal_connect (G_OBJECT (wscroll),
3652 "destroy",
3653 G_CALLBACK (xg_gtk_scroll_destroy),
3654 (gpointer) scroll_id);
3655 g_signal_connect (G_OBJECT (wscroll),
3656 "change-value",
3657 scroll_callback,
3658 (gpointer) bar);
3659 g_signal_connect (G_OBJECT (wscroll),
3660 "button-release-event",
3661 end_callback,
3662 (gpointer) bar);
3664 /* The scroll bar widget does not draw on a window of its own. Instead
3665 it draws on the parent window, in this case the edit widget. So
3666 whenever the edit widget is cleared, the scroll bar needs to redraw
3667 also, which causes flicker. Put an event box between the edit widget
3668 and the scroll bar, so the scroll bar instead draws itself on the
3669 event box window. */
3670 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3671 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3674 /* Set the cursor to an arrow. */
3675 xg_set_cursor (webox, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
3677 bar->x_window = scroll_id;
3680 /* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
3682 void
3683 xg_remove_scroll_bar (FRAME_PTR f, ptrdiff_t scrollbar_id)
3685 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3686 if (w)
3688 GtkWidget *wparent = gtk_widget_get_parent (w);
3689 gtk_widget_destroy (w);
3690 gtk_widget_destroy (wparent);
3691 SET_FRAME_GARBAGED (f);
3695 /* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
3696 in frame F.
3697 TOP/LEFT are the new pixel positions where the bar shall appear.
3698 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3700 void
3701 xg_update_scrollbar_pos (FRAME_PTR f,
3702 ptrdiff_t scrollbar_id,
3703 int top,
3704 int left,
3705 int width,
3706 int height)
3709 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3711 if (wscroll)
3713 GtkWidget *wfixed = f->output_data.x->edit_widget;
3714 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3715 gint msl;
3717 /* Clear out old position. */
3718 int oldx = -1, oldy = -1, oldw, oldh;
3719 if (gtk_widget_get_parent (wparent) == wfixed)
3721 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3722 "x", &oldx, "y", &oldy, NULL);
3723 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3726 /* Move and resize to new values. */
3727 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3728 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3729 if (msl > height)
3731 /* No room. Hide scroll bar as some themes output a warning if
3732 the height is less than the min size. */
3733 gtk_widget_hide (wparent);
3734 gtk_widget_hide (wscroll);
3736 else
3738 gtk_widget_show_all (wparent);
3739 gtk_widget_set_size_request (wscroll, width, height);
3741 gtk_widget_queue_draw (wfixed);
3742 gdk_window_process_all_updates ();
3743 if (oldx != -1 && oldw > 0 && oldh > 0)
3745 /* Clear under old scroll bar position. This must be done after
3746 the gtk_widget_queue_draw and gdk_window_process_all_updates
3747 above. */
3748 x_clear_area (FRAME_X_DISPLAY (f),
3749 FRAME_X_WINDOW (f),
3750 oldx, oldy, oldw, oldh, 0);
3753 /* GTK does not redraw until the main loop is entered again, but
3754 if there are no X events pending we will not enter it. So we sync
3755 here to get some events. */
3757 x_sync (f);
3758 SET_FRAME_GARBAGED (f);
3759 cancel_mouse_face (f);
3763 /* Get the current value of the range, truncated to an integer. */
3765 static int
3766 int_gtk_range_get_value (GtkRange *range)
3768 return gtk_range_get_value (range);
3772 /* Set the thumb size and position of scroll bar BAR. We are currently
3773 displaying PORTION out of a whole WHOLE, and our position POSITION. */
3775 void
3776 xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
3777 int portion,
3778 int position,
3779 int whole)
3781 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3783 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3785 if (wscroll && NILP (bar->dragging))
3787 GtkAdjustment *adj;
3788 gdouble shown;
3789 gdouble top;
3790 int size, value;
3791 int old_size;
3792 int new_step;
3793 bool changed = 0;
3795 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3797 if (scroll_bar_adjust_thumb_portion_p)
3799 /* We do the same as for MOTIF in xterm.c, use 30 chars per
3800 line rather than the real portion value. This makes the
3801 thumb less likely to resize and that looks better. */
3802 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
3804 /* When the thumb is at the bottom, position == whole.
3805 So we need to increase `whole' to make space for the thumb. */
3806 whole += portion;
3809 if (whole <= 0)
3810 top = 0, shown = 1;
3811 else
3813 top = (gdouble) position / whole;
3814 shown = (gdouble) portion / whole;
3817 size = clip_to_bounds (1, shown * XG_SB_RANGE, XG_SB_RANGE);
3818 value = clip_to_bounds (XG_SB_MIN, top * XG_SB_RANGE, XG_SB_MAX - size);
3820 /* Assume all lines are of equal size. */
3821 new_step = size / max (1, FRAME_LINES (f));
3823 old_size = gtk_adjustment_get_page_size (adj);
3824 if (old_size != size)
3826 int old_step = gtk_adjustment_get_step_increment (adj);
3827 if (old_step != new_step)
3829 gtk_adjustment_set_page_size (adj, size);
3830 gtk_adjustment_set_step_increment (adj, new_step);
3831 /* Assume a page increment is about 95% of the page size */
3832 gtk_adjustment_set_page_increment (adj, size - size / 20);
3833 changed = 1;
3837 if (changed || int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3839 block_input ();
3841 /* gtk_range_set_value invokes the callback. Set
3842 ignore_gtk_scrollbar to make the callback do nothing */
3843 xg_ignore_gtk_scrollbar = 1;
3845 if (int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3846 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
3847 else if (changed)
3848 gtk_adjustment_changed (adj);
3850 xg_ignore_gtk_scrollbar = 0;
3852 unblock_input ();
3857 /* Return true if EVENT is for a scroll bar in frame F.
3858 When the same X window is used for several Gtk+ widgets, we cannot
3859 say for sure based on the X window alone if an event is for the
3860 frame. This function does additional checks. */
3862 bool
3863 xg_event_is_for_scrollbar (FRAME_PTR f, XEvent *event)
3865 bool retval = 0;
3867 if (f && event->type == ButtonPress && event->xbutton.button < 4)
3869 /* Check if press occurred outside the edit widget. */
3870 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3871 GdkWindow *gwin;
3872 #ifdef HAVE_GTK3
3873 GdkDevice *gdev = gdk_device_manager_get_client_pointer
3874 (gdk_display_get_device_manager (gdpy));
3875 gwin = gdk_device_get_window_at_position (gdev, NULL, NULL);
3876 #else
3877 gwin = gdk_display_get_window_at_pointer (gdpy, NULL, NULL);
3878 #endif
3879 retval = gwin != gtk_widget_get_window (f->output_data.x->edit_widget);
3881 else if (f
3882 && ((event->type == ButtonRelease && event->xbutton.button < 4)
3883 || event->type == MotionNotify))
3885 /* If we are releasing or moving the scroll bar, it has the grab. */
3886 GtkWidget *w = gtk_grab_get_current ();
3887 retval = w != 0 && GTK_IS_SCROLLBAR (w);
3890 return retval;
3895 /***********************************************************************
3896 Tool bar functions
3897 ***********************************************************************/
3898 /* The key for the data we put in the GtkImage widgets. The data is
3899 the image used by Emacs. We use this to see if we need to update
3900 the GtkImage with a new image. */
3901 #define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
3903 /* The key for storing the latest modifiers so the activate callback can
3904 get them. */
3905 #define XG_TOOL_BAR_LAST_MODIFIER "emacs-tool-bar-modifier"
3907 /* The key for storing the button widget in its proxy menu item. */
3908 #define XG_TOOL_BAR_PROXY_BUTTON "emacs-tool-bar-proxy-button"
3910 /* The key for the data we put in the GtkImage widgets. The data is
3911 the stock name used by Emacs. We use this to see if we need to update
3912 the GtkImage with a new image. */
3913 #define XG_TOOL_BAR_STOCK_NAME "emacs-tool-bar-stock-name"
3915 /* As above, but this is used for named theme widgets, as opposed to
3916 stock items. */
3917 #define XG_TOOL_BAR_ICON_NAME "emacs-tool-bar-icon-name"
3919 /* Callback function invoked when a tool bar item is pressed.
3920 W is the button widget in the tool bar that got pressed,
3921 CLIENT_DATA is an integer that is the index of the button in the
3922 tool bar. 0 is the first button. */
3924 static gboolean
3925 xg_tool_bar_button_cb (GtkWidget *widget,
3926 GdkEventButton *event,
3927 gpointer user_data)
3929 intptr_t state = event->state;
3930 gpointer ptr = (gpointer) state;
3931 g_object_set_data (G_OBJECT (widget), XG_TOOL_BAR_LAST_MODIFIER, ptr);
3932 return FALSE;
3936 /* Callback function invoked when a tool bar item is pressed.
3937 W is the button widget in the tool bar that got pressed,
3938 CLIENT_DATA is an integer that is the index of the button in the
3939 tool bar. 0 is the first button. */
3941 static void
3942 xg_tool_bar_callback (GtkWidget *w, gpointer client_data)
3944 intptr_t idx = (intptr_t) client_data;
3945 gpointer gmod = g_object_get_data (G_OBJECT (w), XG_TOOL_BAR_LAST_MODIFIER);
3946 intptr_t mod = (intptr_t) gmod;
3948 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
3949 Lisp_Object key, frame;
3950 struct input_event event;
3951 EVENT_INIT (event);
3953 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
3954 return;
3956 idx *= TOOL_BAR_ITEM_NSLOTS;
3958 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
3959 XSETFRAME (frame, f);
3961 /* We generate two events here. The first one is to set the prefix
3962 to `(tool_bar)', see keyboard.c. */
3963 event.kind = TOOL_BAR_EVENT;
3964 event.frame_or_window = frame;
3965 event.arg = frame;
3966 kbd_buffer_store_event (&event);
3968 event.kind = TOOL_BAR_EVENT;
3969 event.frame_or_window = frame;
3970 event.arg = key;
3971 /* Convert between the modifier bits GDK uses and the modifier bits
3972 Emacs uses. This assumes GDK and X masks are the same, which they are when
3973 this is written. */
3974 event.modifiers = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), mod);
3975 kbd_buffer_store_event (&event);
3977 /* Return focus to the frame after we have clicked on a detached
3978 tool bar button. */
3979 Fx_focus_frame (frame);
3982 /* Callback function invoked when a tool bar item is pressed in a detached
3983 tool bar or the overflow drop down menu.
3984 We just call xg_tool_bar_callback.
3985 W is the menu item widget that got pressed,
3986 CLIENT_DATA is an integer that is the index of the button in the
3987 tool bar. 0 is the first button. */
3989 static void
3990 xg_tool_bar_proxy_callback (GtkWidget *w, gpointer client_data)
3992 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
3993 XG_TOOL_BAR_PROXY_BUTTON));
3994 xg_tool_bar_callback (wbutton, client_data);
3998 static gboolean
3999 xg_tool_bar_help_callback (GtkWidget *w,
4000 GdkEventCrossing *event,
4001 gpointer client_data);
4003 /* This callback is called when a help is to be shown for an item in
4004 the detached tool bar when the detached tool bar it is not expanded. */
4006 static gboolean
4007 xg_tool_bar_proxy_help_callback (GtkWidget *w,
4008 GdkEventCrossing *event,
4009 gpointer client_data)
4011 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
4012 XG_TOOL_BAR_PROXY_BUTTON));
4014 return xg_tool_bar_help_callback (wbutton, event, client_data);
4017 static GtkWidget *
4018 xg_get_tool_bar_widgets (GtkWidget *vb, GtkWidget **wimage)
4020 GList *clist = gtk_container_get_children (GTK_CONTAINER (vb));
4021 GtkWidget *c1 = (GtkWidget *) clist->data;
4022 GtkWidget *c2 = clist->next ? (GtkWidget *) clist->next->data : NULL;
4024 *wimage = GTK_IS_IMAGE (c1) ? c1 : c2;
4025 g_list_free (clist);
4026 return GTK_IS_LABEL (c1) ? c1 : c2;
4030 /* This callback is called when a tool item should create a proxy item,
4031 such as for the overflow menu. Also called when the tool bar is detached.
4032 If we don't create a proxy menu item, the detached tool bar will be
4033 blank. */
4035 static gboolean
4036 xg_tool_bar_menu_proxy (GtkToolItem *toolitem, gpointer user_data)
4038 GtkButton *wbutton = GTK_BUTTON (XG_BIN_CHILD (XG_BIN_CHILD (toolitem)));
4039 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4040 GtkWidget *c1;
4041 GtkLabel *wlbl = GTK_LABEL (xg_get_tool_bar_widgets (vb, &c1));
4042 GtkImage *wimage = GTK_IMAGE (c1);
4043 GtkWidget *wmenuitem = gtk_image_menu_item_new_with_label
4044 (wlbl ? gtk_label_get_text (wlbl) : "");
4045 GtkWidget *wmenuimage;
4048 if (gtk_button_get_use_stock (wbutton))
4049 wmenuimage = gtk_image_new_from_stock (gtk_button_get_label (wbutton),
4050 GTK_ICON_SIZE_MENU);
4051 else
4053 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (wbutton));
4054 GtkImageType store_type = gtk_image_get_storage_type (wimage);
4056 g_object_set (G_OBJECT (settings), "gtk-menu-images", TRUE, NULL);
4058 if (store_type == GTK_IMAGE_STOCK)
4060 gchar *stock_id;
4061 gtk_image_get_stock (wimage, &stock_id, NULL);
4062 wmenuimage = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
4064 else if (store_type == GTK_IMAGE_ICON_SET)
4066 GtkIconSet *icon_set;
4067 gtk_image_get_icon_set (wimage, &icon_set, NULL);
4068 wmenuimage = gtk_image_new_from_icon_set (icon_set,
4069 GTK_ICON_SIZE_MENU);
4071 else if (store_type == GTK_IMAGE_PIXBUF)
4073 gint width, height;
4075 if (settings &&
4076 gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
4077 &width, &height))
4079 GdkPixbuf *src_pixbuf, *dest_pixbuf;
4081 src_pixbuf = gtk_image_get_pixbuf (wimage);
4082 dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
4083 GDK_INTERP_BILINEAR);
4085 wmenuimage = gtk_image_new_from_pixbuf (dest_pixbuf);
4087 else
4089 fprintf (stderr, "internal error: GTK_IMAGE_PIXBUF failed\n");
4090 emacs_abort ();
4093 else if (store_type == GTK_IMAGE_ICON_NAME)
4095 const gchar *icon_name;
4096 GtkIconSize icon_size;
4098 gtk_image_get_icon_name (wimage, &icon_name, &icon_size);
4099 wmenuimage = gtk_image_new_from_icon_name (icon_name,
4100 GTK_ICON_SIZE_MENU);
4102 else
4104 fprintf (stderr, "internal error: store_type is %d\n", store_type);
4105 emacs_abort ();
4108 if (wmenuimage)
4109 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (wmenuitem), wmenuimage);
4111 g_signal_connect (G_OBJECT (wmenuitem),
4112 "activate",
4113 G_CALLBACK (xg_tool_bar_proxy_callback),
4114 user_data);
4117 g_object_set_data (G_OBJECT (wmenuitem), XG_TOOL_BAR_PROXY_BUTTON,
4118 (gpointer) wbutton);
4119 gtk_tool_item_set_proxy_menu_item (toolitem, "Emacs toolbar item", wmenuitem);
4120 gtk_widget_set_sensitive (wmenuitem,
4121 gtk_widget_get_sensitive (GTK_WIDGET (wbutton)));
4123 /* Use enter/leave notify to show help. We use the events
4124 rather than the GtkButton specific signals "enter" and
4125 "leave", so we can have only one callback. The event
4126 will tell us what kind of event it is. */
4127 g_signal_connect (G_OBJECT (wmenuitem),
4128 "enter-notify-event",
4129 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4130 user_data);
4131 g_signal_connect (G_OBJECT (wmenuitem),
4132 "leave-notify-event",
4133 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4134 user_data);
4136 return TRUE;
4139 /* This callback is called when a tool bar is detached. We must set
4140 the height of the tool bar to zero when this happens so frame sizes
4141 are correctly calculated.
4142 WBOX is the handle box widget that enables detach/attach of the tool bar.
4143 W is the tool bar widget.
4144 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4146 static void
4147 xg_tool_bar_detach_callback (GtkHandleBox *wbox,
4148 GtkWidget *w,
4149 gpointer client_data)
4151 FRAME_PTR f = (FRAME_PTR) client_data;
4153 g_object_set (G_OBJECT (w), "show-arrow", !x_gtk_whole_detached_tool_bar,
4154 NULL);
4156 if (f)
4158 GtkRequisition req, req2;
4160 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4161 gtk_widget_get_preferred_size (w, NULL, &req2);
4162 req.width -= req2.width;
4163 req.height -= req2.height;
4164 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4165 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4166 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4167 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4168 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4169 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4170 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4171 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4172 xg_height_or_width_changed (f);
4176 /* This callback is called when a tool bar is reattached. We must set
4177 the height of the tool bar when this happens so frame sizes
4178 are correctly calculated.
4179 WBOX is the handle box widget that enables detach/attach of the tool bar.
4180 W is the tool bar widget.
4181 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4183 static void
4184 xg_tool_bar_attach_callback (GtkHandleBox *wbox,
4185 GtkWidget *w,
4186 gpointer client_data)
4188 FRAME_PTR f = (FRAME_PTR) client_data;
4189 g_object_set (G_OBJECT (w), "show-arrow", TRUE, NULL);
4191 if (f)
4193 GtkRequisition req, req2;
4195 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4196 gtk_widget_get_preferred_size (w, NULL, &req2);
4197 req.width += req2.width;
4198 req.height += req2.height;
4199 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4200 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4201 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4202 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4203 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4204 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4205 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4206 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4207 xg_height_or_width_changed (f);
4211 /* This callback is called when the mouse enters or leaves a tool bar item.
4212 It is used for displaying and hiding the help text.
4213 W is the tool bar item, a button.
4214 EVENT is either an enter event or leave event.
4215 CLIENT_DATA is an integer that is the index of the button in the
4216 tool bar. 0 is the first button.
4218 Returns FALSE to tell GTK to keep processing this event. */
4220 static gboolean
4221 xg_tool_bar_help_callback (GtkWidget *w,
4222 GdkEventCrossing *event,
4223 gpointer client_data)
4225 intptr_t idx = (intptr_t) client_data;
4226 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4227 Lisp_Object help, frame;
4229 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4230 return FALSE;
4232 if (event->type == GDK_ENTER_NOTIFY)
4234 idx *= TOOL_BAR_ITEM_NSLOTS;
4235 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
4237 if (NILP (help))
4238 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
4240 else
4241 help = Qnil;
4243 XSETFRAME (frame, f);
4244 kbd_buffer_store_help_event (frame, help);
4246 return FALSE;
4250 /* This callback is called when a tool bar item shall be redrawn.
4251 It modifies the expose event so that the GtkImage widget redraws the
4252 whole image. This to overcome a bug that makes GtkImage draw the image
4253 in the wrong place when it tries to redraw just a part of the image.
4254 W is the GtkImage to be redrawn.
4255 EVENT is the expose event for W.
4256 CLIENT_DATA is unused.
4258 Returns FALSE to tell GTK to keep processing this event. */
4260 #ifndef HAVE_GTK3
4261 static gboolean
4262 xg_tool_bar_item_expose_callback (GtkWidget *w,
4263 GdkEventExpose *event,
4264 gpointer client_data)
4266 gint width, height;
4268 gdk_drawable_get_size (event->window, &width, &height);
4269 event->area.x -= width > event->area.width ? width-event->area.width : 0;
4270 event->area.y -= height > event->area.height ? height-event->area.height : 0;
4272 event->area.x = max (0, event->area.x);
4273 event->area.y = max (0, event->area.y);
4275 event->area.width = max (width, event->area.width);
4276 event->area.height = max (height, event->area.height);
4278 return FALSE;
4280 #endif
4282 #ifdef HAVE_GTK_ORIENTABLE_SET_ORIENTATION
4283 #define toolbar_set_orientation(w, o) \
4284 gtk_orientable_set_orientation (GTK_ORIENTABLE (w), o)
4285 #else
4286 #define toolbar_set_orientation(w, o) \
4287 gtk_toolbar_set_orientation (GTK_TOOLBAR (w), o)
4288 #endif
4290 #ifdef HAVE_GTK_HANDLE_BOX_NEW
4291 #define TOOLBAR_TOP_WIDGET(x) ((x)->handlebox_widget)
4292 #else
4293 #define TOOLBAR_TOP_WIDGET(x) ((x)->toolbar_widget)
4294 #endif
4296 /* Attach a tool bar to frame F. */
4298 static void
4299 xg_pack_tool_bar (FRAME_PTR f, Lisp_Object pos)
4301 struct x_output *x = f->output_data.x;
4302 bool into_hbox = EQ (pos, Qleft) || EQ (pos, Qright);
4303 GtkWidget *top_widget = TOOLBAR_TOP_WIDGET (x);
4305 toolbar_set_orientation (x->toolbar_widget,
4306 into_hbox
4307 ? GTK_ORIENTATION_VERTICAL
4308 : GTK_ORIENTATION_HORIZONTAL);
4309 #ifdef HAVE_GTK_HANDLE_BOX_NEW
4310 if (!x->handlebox_widget)
4312 top_widget = x->handlebox_widget = gtk_handle_box_new ();
4313 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-detached",
4314 G_CALLBACK (xg_tool_bar_detach_callback), f);
4315 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-attached",
4316 G_CALLBACK (xg_tool_bar_attach_callback), f);
4317 gtk_container_add (GTK_CONTAINER (x->handlebox_widget),
4318 x->toolbar_widget);
4320 #endif
4322 if (into_hbox)
4324 #ifdef HAVE_GTK_HANDLE_BOX_NEW
4325 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4326 GTK_POS_TOP);
4327 #endif
4328 gtk_box_pack_start (GTK_BOX (x->hbox_widget), top_widget,
4329 FALSE, FALSE, 0);
4331 if (EQ (pos, Qleft))
4332 gtk_box_reorder_child (GTK_BOX (x->hbox_widget),
4333 top_widget,
4335 x->toolbar_in_hbox = true;
4337 else
4339 bool vbox_pos = x->menubar_widget != 0;
4340 #ifdef HAVE_GTK_HANDLE_BOX_NEW
4341 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4342 GTK_POS_LEFT);
4343 #endif
4344 gtk_box_pack_start (GTK_BOX (x->vbox_widget), top_widget,
4345 FALSE, FALSE, 0);
4347 if (EQ (pos, Qtop))
4348 gtk_box_reorder_child (GTK_BOX (x->vbox_widget),
4349 top_widget,
4350 vbox_pos);
4351 x->toolbar_in_hbox = false;
4353 x->toolbar_is_packed = true;
4356 /* Create a tool bar for frame F. */
4358 static void
4359 xg_create_tool_bar (FRAME_PTR f)
4361 struct x_output *x = f->output_data.x;
4362 #if GTK_CHECK_VERSION (3, 3, 6)
4363 GtkStyleContext *gsty;
4364 #endif
4365 struct xg_frame_tb_info *tbinfo
4366 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4367 TB_INFO_KEY);
4368 if (! tbinfo)
4370 tbinfo = xmalloc (sizeof (*tbinfo));
4371 tbinfo->last_tool_bar = Qnil;
4372 tbinfo->style = Qnil;
4373 tbinfo->hmargin = tbinfo->vmargin = 0;
4374 tbinfo->dir = GTK_TEXT_DIR_NONE;
4375 tbinfo->n_last_items = 0;
4376 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4377 TB_INFO_KEY,
4378 tbinfo);
4381 x->toolbar_widget = gtk_toolbar_new ();
4383 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
4385 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
4386 toolbar_set_orientation (x->toolbar_widget, GTK_ORIENTATION_HORIZONTAL);
4387 #if GTK_CHECK_VERSION (3, 3, 6)
4388 gsty = gtk_widget_get_style_context (x->toolbar_widget);
4389 gtk_style_context_add_class (gsty, "primary-toolbar");
4390 #endif
4394 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
4396 /* Find the right-to-left image named by RTL in the tool bar images for F.
4397 Returns IMAGE if RTL is not found. */
4399 static Lisp_Object
4400 find_rtl_image (FRAME_PTR f, Lisp_Object image, Lisp_Object rtl)
4402 int i;
4403 Lisp_Object file, rtl_name;
4404 struct gcpro gcpro1, gcpro2;
4405 GCPRO2 (file, rtl_name);
4407 rtl_name = Ffile_name_nondirectory (rtl);
4409 for (i = 0; i < f->n_tool_bar_items; ++i)
4411 Lisp_Object rtl_image = PROP (TOOL_BAR_ITEM_IMAGES);
4412 if (!NILP (file = file_for_image (rtl_image)))
4414 file = call1 (intern ("file-name-sans-extension"),
4415 Ffile_name_nondirectory (file));
4416 if (! NILP (Fequal (file, rtl_name)))
4418 image = rtl_image;
4419 break;
4424 return image;
4427 static GtkToolItem *
4428 xg_make_tool_item (FRAME_PTR f,
4429 GtkWidget *wimage,
4430 GtkWidget **wbutton,
4431 const char *label,
4432 int i, bool horiz, bool text_image)
4434 GtkToolItem *ti = gtk_tool_item_new ();
4435 GtkWidget *vb = gtk_box_new (horiz
4436 ? GTK_ORIENTATION_HORIZONTAL
4437 : GTK_ORIENTATION_VERTICAL,
4439 GtkWidget *wb = gtk_button_new ();
4440 /* The eventbox is here so we can have tooltips on disabled items. */
4441 GtkWidget *weventbox = gtk_event_box_new ();
4442 #if GTK_CHECK_VERSION (3, 3, 6)
4443 GtkCssProvider *css_prov = gtk_css_provider_new ();
4444 GtkStyleContext *gsty;
4446 gtk_css_provider_load_from_data (css_prov,
4447 "GtkEventBox {"
4448 " background-color: transparent;"
4449 "}",
4450 -1, NULL);
4452 gsty = gtk_widget_get_style_context (weventbox);
4453 gtk_style_context_add_provider (gsty,
4454 GTK_STYLE_PROVIDER (css_prov),
4455 GTK_STYLE_PROVIDER_PRIORITY_USER);
4456 g_object_unref (css_prov);
4457 #endif
4459 gtk_box_set_homogeneous (GTK_BOX (vb), FALSE);
4461 if (wimage && !text_image)
4462 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4463 if (label)
4464 gtk_box_pack_start (GTK_BOX (vb), gtk_label_new (label), TRUE, TRUE, 0);
4465 if (wimage && text_image)
4466 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4468 gtk_button_set_focus_on_click (GTK_BUTTON (wb), FALSE);
4469 gtk_button_set_relief (GTK_BUTTON (wb), GTK_RELIEF_NONE);
4470 gtk_container_add (GTK_CONTAINER (wb), vb);
4471 gtk_container_add (GTK_CONTAINER (weventbox), wb);
4472 gtk_container_add (GTK_CONTAINER (ti), weventbox);
4474 if (wimage || label)
4476 intptr_t ii = i;
4477 gpointer gi = (gpointer) ii;
4479 g_signal_connect (G_OBJECT (ti), "create-menu-proxy",
4480 G_CALLBACK (xg_tool_bar_menu_proxy),
4481 gi);
4483 g_signal_connect (G_OBJECT (wb), "clicked",
4484 G_CALLBACK (xg_tool_bar_callback),
4485 gi);
4487 g_object_set_data (G_OBJECT (weventbox), XG_FRAME_DATA, (gpointer)f);
4489 #ifndef HAVE_GTK3
4490 /* Catch expose events to overcome an annoying redraw bug, see
4491 comment for xg_tool_bar_item_expose_callback. */
4492 g_signal_connect (G_OBJECT (ti),
4493 "expose-event",
4494 G_CALLBACK (xg_tool_bar_item_expose_callback),
4496 #endif
4497 gtk_tool_item_set_homogeneous (ti, FALSE);
4499 /* Callback to save modifier mask (Shift/Control, etc). GTK makes
4500 no distinction based on modifiers in the activate callback,
4501 so we have to do it ourselves. */
4502 g_signal_connect (wb, "button-release-event",
4503 G_CALLBACK (xg_tool_bar_button_cb),
4504 NULL);
4506 g_object_set_data (G_OBJECT (wb), XG_FRAME_DATA, (gpointer)f);
4508 /* Use enter/leave notify to show help. We use the events
4509 rather than the GtkButton specific signals "enter" and
4510 "leave", so we can have only one callback. The event
4511 will tell us what kind of event it is. */
4512 g_signal_connect (G_OBJECT (weventbox),
4513 "enter-notify-event",
4514 G_CALLBACK (xg_tool_bar_help_callback),
4515 gi);
4516 g_signal_connect (G_OBJECT (weventbox),
4517 "leave-notify-event",
4518 G_CALLBACK (xg_tool_bar_help_callback),
4519 gi);
4522 if (wbutton) *wbutton = wb;
4524 return ti;
4527 static bool
4528 is_box_type (GtkWidget *vb, bool is_horizontal)
4530 #ifdef HAVE_GTK3
4531 bool ret = 0;
4532 if (GTK_IS_BOX (vb))
4534 GtkOrientation ori = gtk_orientable_get_orientation (GTK_ORIENTABLE (vb));
4535 ret = (ori == GTK_ORIENTATION_HORIZONTAL && is_horizontal)
4536 || (ori == GTK_ORIENTATION_VERTICAL && ! is_horizontal);
4538 return ret;
4539 #else
4540 return is_horizontal ? GTK_IS_VBOX (vb) : GTK_IS_HBOX (vb);
4541 #endif
4545 static bool
4546 xg_tool_item_stale_p (GtkWidget *wbutton, const char *stock_name,
4547 const char *icon_name, const struct image *img,
4548 const char *label, bool horiz)
4550 gpointer old;
4551 GtkWidget *wimage;
4552 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4553 GtkWidget *wlbl = xg_get_tool_bar_widgets (vb, &wimage);
4555 /* Check if the tool icon matches. */
4556 if (stock_name && wimage)
4558 old = g_object_get_data (G_OBJECT (wimage),
4559 XG_TOOL_BAR_STOCK_NAME);
4560 if (!old || strcmp (old, stock_name))
4561 return 1;
4563 else if (icon_name && wimage)
4565 old = g_object_get_data (G_OBJECT (wimage),
4566 XG_TOOL_BAR_ICON_NAME);
4567 if (!old || strcmp (old, icon_name))
4568 return 1;
4570 else if (wimage)
4572 gpointer gold_img = g_object_get_data (G_OBJECT (wimage),
4573 XG_TOOL_BAR_IMAGE_DATA);
4574 Pixmap old_img = (Pixmap) gold_img;
4575 if (old_img != img->pixmap)
4576 return 1;
4579 /* Check button configuration and label. */
4580 if (is_box_type (vb, horiz)
4581 || (label ? (wlbl == NULL) : (wlbl != NULL)))
4582 return 1;
4584 /* Ensure label is correct. */
4585 if (label && wlbl)
4586 gtk_label_set_text (GTK_LABEL (wlbl), label);
4587 return 0;
4590 static bool
4591 xg_update_tool_bar_sizes (FRAME_PTR f)
4593 struct x_output *x = f->output_data.x;
4594 GtkRequisition req;
4595 int nl = 0, nr = 0, nt = 0, nb = 0;
4596 GtkWidget *top_widget = TOOLBAR_TOP_WIDGET (x);
4598 gtk_widget_get_preferred_size (GTK_WIDGET (top_widget), NULL, &req);
4599 if (x->toolbar_in_hbox)
4601 int pos;
4602 gtk_container_child_get (GTK_CONTAINER (x->hbox_widget),
4603 top_widget,
4604 "position", &pos, NULL);
4605 if (pos == 0) nl = req.width;
4606 else nr = req.width;
4608 else
4610 int pos;
4611 gtk_container_child_get (GTK_CONTAINER (x->vbox_widget),
4612 top_widget,
4613 "position", &pos, NULL);
4614 if (pos == 0 || (pos == 1 && x->menubar_widget)) nt = req.height;
4615 else nb = req.height;
4618 if (nl != FRAME_TOOLBAR_LEFT_WIDTH (f)
4619 || nr != FRAME_TOOLBAR_RIGHT_WIDTH (f)
4620 || nt != FRAME_TOOLBAR_TOP_HEIGHT (f)
4621 || nb != FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
4623 FRAME_TOOLBAR_RIGHT_WIDTH (f) = FRAME_TOOLBAR_LEFT_WIDTH (f)
4624 = FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4625 FRAME_TOOLBAR_LEFT_WIDTH (f) = nl;
4626 FRAME_TOOLBAR_RIGHT_WIDTH (f) = nr;
4627 FRAME_TOOLBAR_TOP_HEIGHT (f) = nt;
4628 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = nb;
4629 return 1;
4632 return 0;
4636 /* Update the tool bar for frame F. Add new buttons and remove old. */
4638 void
4639 update_frame_tool_bar (FRAME_PTR f)
4641 int i, j;
4642 struct x_output *x = f->output_data.x;
4643 int hmargin = 0, vmargin = 0;
4644 GtkToolbar *wtoolbar;
4645 GtkToolItem *ti;
4646 GtkTextDirection dir;
4647 Lisp_Object style;
4648 bool text_image, horiz;
4649 struct xg_frame_tb_info *tbinfo;
4651 if (! FRAME_GTK_WIDGET (f))
4652 return;
4654 block_input ();
4656 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
4658 hmargin = XFASTINT (Vtool_bar_button_margin);
4659 vmargin = XFASTINT (Vtool_bar_button_margin);
4661 else if (CONSP (Vtool_bar_button_margin))
4663 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin), INT_MAX))
4664 hmargin = XFASTINT (XCAR (Vtool_bar_button_margin));
4666 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
4667 vmargin = XFASTINT (XCDR (Vtool_bar_button_margin));
4670 /* The natural size (i.e. when GTK uses 0 as margin) looks best,
4671 so take DEFAULT_TOOL_BAR_BUTTON_MARGIN to mean "default for GTK",
4672 i.e. zero. This means that margins less than
4673 DEFAULT_TOOL_BAR_BUTTON_MARGIN has no effect. */
4674 hmargin = max (0, hmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4675 vmargin = max (0, vmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4677 if (! x->toolbar_widget)
4678 xg_create_tool_bar (f);
4680 wtoolbar = GTK_TOOLBAR (x->toolbar_widget);
4681 dir = gtk_widget_get_direction (GTK_WIDGET (wtoolbar));
4683 style = Ftool_bar_get_system_style ();
4685 /* Are we up to date? */
4686 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4687 TB_INFO_KEY);
4689 if (! NILP (tbinfo->last_tool_bar) && ! NILP (f->tool_bar_items)
4690 && tbinfo->n_last_items == f->n_tool_bar_items
4691 && tbinfo->hmargin == hmargin && tbinfo->vmargin == vmargin
4692 && tbinfo->dir == dir
4693 && ! NILP (Fequal (tbinfo->style, style))
4694 && ! NILP (Fequal (tbinfo->last_tool_bar, f->tool_bar_items)))
4696 unblock_input ();
4697 return;
4700 tbinfo->last_tool_bar = f->tool_bar_items;
4701 tbinfo->n_last_items = f->n_tool_bar_items;
4702 tbinfo->style = style;
4703 tbinfo->hmargin = hmargin;
4704 tbinfo->vmargin = vmargin;
4705 tbinfo->dir = dir;
4707 text_image = EQ (style, Qtext_image_horiz);
4708 horiz = EQ (style, Qboth_horiz) || text_image;
4710 for (i = j = 0; i < f->n_tool_bar_items; ++i)
4712 bool enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
4713 bool selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
4714 int idx;
4715 ptrdiff_t img_id;
4716 int icon_size = 0;
4717 struct image *img = NULL;
4718 Lisp_Object image;
4719 Lisp_Object stock = Qnil;
4720 GtkStockItem stock_item;
4721 char *stock_name = NULL;
4722 char *icon_name = NULL;
4723 Lisp_Object rtl;
4724 GtkWidget *wbutton = NULL;
4725 Lisp_Object specified_file;
4726 bool vert_only = ! NILP (PROP (TOOL_BAR_ITEM_VERT_ONLY));
4727 const char *label
4728 = (EQ (style, Qimage) || (vert_only && horiz)) ? NULL
4729 : STRINGP (PROP (TOOL_BAR_ITEM_LABEL))
4730 ? SSDATA (PROP (TOOL_BAR_ITEM_LABEL))
4731 : "";
4733 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4735 /* If this is a separator, use a gtk separator item. */
4736 if (EQ (PROP (TOOL_BAR_ITEM_TYPE), Qt))
4738 if (ti == NULL || !GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4740 if (ti)
4741 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4742 GTK_WIDGET (ti));
4743 ti = gtk_separator_tool_item_new ();
4744 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4746 j++;
4747 continue;
4750 /* Otherwise, the tool-bar item is an ordinary button. */
4752 if (ti && GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4754 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4755 ti = NULL;
4758 if (ti) wbutton = XG_BIN_CHILD (XG_BIN_CHILD (ti));
4760 /* Ignore invalid image specifications. */
4761 image = PROP (TOOL_BAR_ITEM_IMAGES);
4762 if (!valid_image_p (image))
4764 if (ti)
4765 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4766 GTK_WIDGET (ti));
4767 continue;
4770 specified_file = file_for_image (image);
4771 if (!NILP (specified_file) && !NILP (Ffboundp (Qx_gtk_map_stock)))
4772 stock = call1 (Qx_gtk_map_stock, specified_file);
4774 if (STRINGP (stock))
4776 stock_name = SSDATA (stock);
4777 if (stock_name[0] == 'n' && stock_name[1] == ':')
4779 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (wtoolbar));
4780 GtkIconTheme *icon_theme = gtk_icon_theme_get_for_screen (screen);
4782 icon_name = stock_name + 2;
4783 stock_name = NULL;
4784 stock = Qnil;
4786 if (! gtk_icon_theme_has_icon (icon_theme, icon_name))
4787 icon_name = NULL;
4788 else
4789 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4791 else if (gtk_stock_lookup (SSDATA (stock), &stock_item))
4792 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4793 else
4795 stock = Qnil;
4796 stock_name = NULL;
4800 if (stock_name == NULL && icon_name == NULL)
4802 /* No stock image, or stock item not known. Try regular
4803 image. If image is a vector, choose it according to the
4804 button state. */
4805 if (dir == GTK_TEXT_DIR_RTL
4806 && !NILP (rtl = PROP (TOOL_BAR_ITEM_RTL_IMAGE))
4807 && STRINGP (rtl))
4808 image = find_rtl_image (f, image, rtl);
4810 if (VECTORP (image))
4812 if (enabled_p)
4813 idx = (selected_p
4814 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
4815 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
4816 else
4817 idx = (selected_p
4818 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
4819 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
4821 eassert (ASIZE (image) >= idx);
4822 image = AREF (image, idx);
4824 else
4825 idx = -1;
4827 img_id = lookup_image (f, image);
4828 img = IMAGE_FROM_ID (f, img_id);
4829 prepare_image_for_display (f, img);
4831 if (img->load_failed_p || img->pixmap == None)
4833 if (ti)
4834 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4835 GTK_WIDGET (ti));
4836 continue;
4840 /* If there is an existing widget, check if it's stale; if so,
4841 remove it and make a new tool item from scratch. */
4842 if (ti && xg_tool_item_stale_p (wbutton, stock_name, icon_name,
4843 img, label, horiz))
4845 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4846 GTK_WIDGET (ti));
4847 ti = NULL;
4850 if (ti == NULL)
4852 GtkWidget *w;
4854 /* Save the image so we can see if an update is needed the
4855 next time we call xg_tool_item_match_p. */
4856 if (EQ (style, Qtext))
4857 w = NULL;
4858 else if (stock_name)
4860 w = gtk_image_new_from_stock (stock_name, icon_size);
4861 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_STOCK_NAME,
4862 (gpointer) xstrdup (stock_name),
4863 (GDestroyNotify) xfree);
4865 else if (icon_name)
4867 w = gtk_image_new_from_icon_name (icon_name, icon_size);
4868 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_ICON_NAME,
4869 (gpointer) xstrdup (icon_name),
4870 (GDestroyNotify) xfree);
4872 else
4874 w = xg_get_image_for_pixmap (f, img, x->widget, NULL);
4875 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
4876 (gpointer)img->pixmap);
4879 if (w) gtk_misc_set_padding (GTK_MISC (w), hmargin, vmargin);
4880 ti = xg_make_tool_item (f, w, &wbutton, label, i, horiz, text_image);
4881 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4884 #undef PROP
4886 gtk_widget_set_sensitive (wbutton, enabled_p);
4887 j++;
4890 /* Remove buttons not longer needed. */
4893 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4894 if (ti)
4895 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4896 } while (ti != NULL);
4898 if (f->n_tool_bar_items != 0)
4900 if (! x->toolbar_is_packed)
4901 xg_pack_tool_bar (f, f->tool_bar_position);
4902 gtk_widget_show_all (TOOLBAR_TOP_WIDGET (x));
4903 if (xg_update_tool_bar_sizes (f))
4904 xg_height_or_width_changed (f);
4907 unblock_input ();
4910 /* Deallocate all resources for the tool bar on frame F.
4911 Remove the tool bar. */
4913 void
4914 free_frame_tool_bar (FRAME_PTR f)
4916 struct x_output *x = f->output_data.x;
4918 if (x->toolbar_widget)
4920 struct xg_frame_tb_info *tbinfo;
4921 GtkWidget *top_widget = TOOLBAR_TOP_WIDGET (x);
4923 block_input ();
4924 /* We may have created the toolbar_widget in xg_create_tool_bar, but
4925 not the x->handlebox_widget which is created in xg_pack_tool_bar. */
4926 if (x->toolbar_is_packed)
4928 if (x->toolbar_in_hbox)
4929 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4930 top_widget);
4931 else
4932 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4933 top_widget);
4935 else
4936 gtk_widget_destroy (x->toolbar_widget);
4938 x->toolbar_widget = 0;
4939 TOOLBAR_TOP_WIDGET (x) = 0;
4940 x->toolbar_is_packed = false;
4941 FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4942 FRAME_TOOLBAR_LEFT_WIDTH (f) = FRAME_TOOLBAR_RIGHT_WIDTH (f) = 0;
4944 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4945 TB_INFO_KEY);
4946 if (tbinfo)
4948 xfree (tbinfo);
4949 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4950 TB_INFO_KEY,
4951 NULL);
4954 xg_height_or_width_changed (f);
4956 unblock_input ();
4960 void
4961 xg_change_toolbar_position (FRAME_PTR f, Lisp_Object pos)
4963 struct x_output *x = f->output_data.x;
4964 GtkWidget *top_widget = TOOLBAR_TOP_WIDGET (x);
4966 if (! x->toolbar_widget || ! top_widget)
4967 return;
4969 block_input ();
4970 g_object_ref (top_widget);
4971 if (x->toolbar_is_packed)
4973 if (x->toolbar_in_hbox)
4974 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4975 top_widget);
4976 else
4977 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4978 top_widget);
4981 xg_pack_tool_bar (f, pos);
4982 g_object_unref (top_widget);
4983 if (xg_update_tool_bar_sizes (f))
4984 xg_height_or_width_changed (f);
4986 unblock_input ();
4991 /***********************************************************************
4992 Initializing
4993 ***********************************************************************/
4994 void
4995 xg_initialize (void)
4997 GtkBindingSet *binding_set;
4998 GtkSettings *settings;
5000 #if HAVE_XFT
5001 /* Work around a bug with corrupted data if libXft gets unloaded. This way
5002 we keep it permanently linked in. */
5003 XftInit (0);
5004 #endif
5006 gdpy_def = NULL;
5007 xg_ignore_gtk_scrollbar = 0;
5008 #ifdef HAVE_GTK_TEAROFF_MENU_ITEM_NEW
5009 xg_detached_menus = 0;
5010 #endif
5011 xg_menu_cb_list.prev = xg_menu_cb_list.next =
5012 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
5014 id_to_widget.max_size = id_to_widget.used = 0;
5015 id_to_widget.widgets = 0;
5017 settings = gtk_settings_get_for_screen (gdk_display_get_default_screen
5018 (gdk_display_get_default ()));
5019 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
5020 bindings. It doesn't seem to be any way to remove properties,
5021 so we set it to VoidSymbol which in X means "no key". */
5022 gtk_settings_set_string_property (settings,
5023 "gtk-menu-bar-accel",
5024 "VoidSymbol",
5025 EMACS_CLASS);
5027 /* Make GTK text input widgets use Emacs style keybindings. This is
5028 Emacs after all. */
5029 gtk_settings_set_string_property (settings,
5030 "gtk-key-theme-name",
5031 "Emacs",
5032 EMACS_CLASS);
5034 /* Make dialogs close on C-g. Since file dialog inherits from
5035 dialog, this works for them also. */
5036 binding_set = gtk_binding_set_by_class (g_type_class_ref (GTK_TYPE_DIALOG));
5037 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5038 "close", 0);
5040 /* Make menus close on C-g. */
5041 binding_set = gtk_binding_set_by_class (g_type_class_ref
5042 (GTK_TYPE_MENU_SHELL));
5043 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5044 "cancel", 0);
5045 update_theme_scrollbar_width ();
5047 #ifdef HAVE_FREETYPE
5048 x_last_font_name = NULL;
5049 #endif
5052 #endif /* USE_GTK */