Fix bug #12196 with incorrect memory allocations for region-cache.
[emacs.git] / src / gtkutil.c
blob194a1044952b11d4987bf700195c0cebf97fd9f8
1 /* Functions for creating and updating GTK widgets.
3 Copyright (C) 2003-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
22 #ifdef USE_GTK
23 #include <float.h>
24 #include <signal.h>
25 #include <stdio.h>
26 #include <setjmp.h>
27 #include <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 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 1 if color was found, 0 if not. */
582 xg_check_special_colors (struct frame *f,
583 const char *color_name,
584 XColor *color)
586 int success_p = 0;
587 int get_bg = strcmp ("gtk_selection_bg_color", color_name) == 0;
588 int 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 #else
610 GtkStyle *gsty = gtk_widget_get_style (FRAME_GTK_WIDGET (f));
611 GdkColor *grgb = get_bg
612 ? &gsty->bg[GTK_STATE_SELECTED]
613 : &gsty->fg[GTK_STATE_SELECTED];
615 color->red = grgb->red;
616 color->green = grgb->green;
617 color->blue = grgb->blue;
618 color->pixel = grgb->pixel;
619 success_p = 1;
620 #endif
623 UNBLOCK_INPUT;
624 return success_p;
629 /***********************************************************************
630 Tooltips
631 ***********************************************************************/
632 /* Gtk+ calls this callback when the parent of our tooltip dummy changes.
633 We use that to pop down the tooltip. This happens if Gtk+ for some
634 reason wants to change or hide the tooltip. */
636 #ifdef USE_GTK_TOOLTIP
638 static void
639 hierarchy_ch_cb (GtkWidget *widget,
640 GtkWidget *previous_toplevel,
641 gpointer user_data)
643 FRAME_PTR f = (FRAME_PTR) user_data;
644 struct x_output *x = f->output_data.x;
645 GtkWidget *top = gtk_widget_get_toplevel (x->ttip_lbl);
647 if (! top || ! GTK_IS_WINDOW (top))
648 gtk_widget_hide (previous_toplevel);
651 /* Callback called when Gtk+ thinks a tooltip should be displayed.
652 We use it to get the tooltip window and the tooltip widget so
653 we can manipulate the ourselves.
655 Return FALSE ensures that the tooltip is not shown. */
657 static gboolean
658 qttip_cb (GtkWidget *widget,
659 gint xpos,
660 gint ypos,
661 gboolean keyboard_mode,
662 GtkTooltip *tooltip,
663 gpointer user_data)
665 FRAME_PTR f = (FRAME_PTR) user_data;
666 struct x_output *x = f->output_data.x;
667 if (x->ttip_widget == NULL)
669 GtkWidget *p;
670 GList *list, *iter;
672 g_object_set (G_OBJECT (widget), "has-tooltip", FALSE, NULL);
673 x->ttip_widget = tooltip;
674 g_object_ref (G_OBJECT (tooltip));
675 x->ttip_lbl = gtk_label_new ("");
676 g_object_ref (G_OBJECT (x->ttip_lbl));
677 gtk_tooltip_set_custom (tooltip, x->ttip_lbl);
678 x->ttip_window = GTK_WINDOW (gtk_widget_get_toplevel (x->ttip_lbl));
680 /* Change stupid Gtk+ default line wrapping. */
681 p = gtk_widget_get_parent (x->ttip_lbl);
682 list = gtk_container_get_children (GTK_CONTAINER (p));
683 for (iter = list; iter; iter = g_list_next (iter))
685 GtkWidget *w = GTK_WIDGET (iter->data);
686 if (GTK_IS_LABEL (w))
687 gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
689 g_list_free (list);
691 /* ATK needs an empty title for some reason. */
692 gtk_window_set_title (x->ttip_window, "");
693 /* Realize so we can safely get screen later on. */
694 gtk_widget_realize (GTK_WIDGET (x->ttip_window));
695 gtk_widget_realize (x->ttip_lbl);
697 g_signal_connect (x->ttip_lbl, "hierarchy-changed",
698 G_CALLBACK (hierarchy_ch_cb), f);
700 return FALSE;
703 #endif /* USE_GTK_TOOLTIP */
705 /* Prepare a tooltip to be shown, i.e. calculate WIDTH and HEIGHT.
706 Return zero if no system tooltip available, non-zero otherwise. */
709 xg_prepare_tooltip (FRAME_PTR f,
710 Lisp_Object string,
711 int *width,
712 int *height)
714 #ifndef USE_GTK_TOOLTIP
715 return 0;
716 #else
717 struct x_output *x = f->output_data.x;
718 GtkWidget *widget;
719 GdkWindow *gwin;
720 GdkScreen *screen;
721 GtkSettings *settings;
722 gboolean tt_enabled = TRUE;
723 GtkRequisition req;
724 Lisp_Object encoded_string;
726 if (!x->ttip_lbl) return 0;
728 BLOCK_INPUT;
729 encoded_string = ENCODE_UTF_8 (string);
730 widget = GTK_WIDGET (x->ttip_lbl);
731 gwin = gtk_widget_get_window (GTK_WIDGET (x->ttip_window));
732 screen = gdk_window_get_screen (gwin);
733 settings = gtk_settings_get_for_screen (screen);
734 g_object_get (settings, "gtk-enable-tooltips", &tt_enabled, NULL);
735 if (tt_enabled)
737 g_object_set (settings, "gtk-enable-tooltips", FALSE, NULL);
738 /* Record that we disabled it so it can be enabled again. */
739 g_object_set_data (G_OBJECT (x->ttip_window), "restore-tt",
740 (gpointer)f);
743 /* Prevent Gtk+ from hiding tooltip on mouse move and such. */
744 g_object_set_data (G_OBJECT
745 (gtk_widget_get_display (GTK_WIDGET (x->ttip_window))),
746 "gdk-display-current-tooltip", NULL);
748 /* Put our dummy widget in so we can get callbacks for unrealize and
749 hierarchy-changed. */
750 gtk_tooltip_set_custom (x->ttip_widget, widget);
751 gtk_tooltip_set_text (x->ttip_widget, SSDATA (encoded_string));
752 gtk_widget_get_preferred_size (GTK_WIDGET (x->ttip_window), NULL, &req);
753 if (width) *width = req.width;
754 if (height) *height = req.height;
756 UNBLOCK_INPUT;
758 return 1;
759 #endif /* USE_GTK_TOOLTIP */
762 /* Show the tooltip at ROOT_X and ROOT_Y.
763 xg_prepare_tooltip must have been called before this function. */
765 void
766 xg_show_tooltip (FRAME_PTR f, int root_x, int root_y)
768 #ifdef USE_GTK_TOOLTIP
769 struct x_output *x = f->output_data.x;
770 if (x->ttip_window)
772 BLOCK_INPUT;
773 gtk_window_move (x->ttip_window, root_x, root_y);
774 gtk_widget_show_all (GTK_WIDGET (x->ttip_window));
775 UNBLOCK_INPUT;
777 #endif
780 /* Hide tooltip if shown. Do nothing if not shown.
781 Return non-zero if tip was hidden, non-zero if not (i.e. not using
782 system tooltips). */
785 xg_hide_tooltip (FRAME_PTR f)
787 int ret = 0;
788 #ifdef USE_GTK_TOOLTIP
789 if (f->output_data.x->ttip_window)
791 GtkWindow *win = f->output_data.x->ttip_window;
792 BLOCK_INPUT;
793 gtk_widget_hide (GTK_WIDGET (win));
795 if (g_object_get_data (G_OBJECT (win), "restore-tt"))
797 GdkWindow *gwin = gtk_widget_get_window (GTK_WIDGET (win));
798 GdkScreen *screen = gdk_window_get_screen (gwin);
799 GtkSettings *settings = gtk_settings_get_for_screen (screen);
800 g_object_set (settings, "gtk-enable-tooltips", TRUE, NULL);
802 UNBLOCK_INPUT;
804 ret = 1;
806 #endif
807 return ret;
811 /***********************************************************************
812 General functions for creating widgets, resizing, events, e.t.c.
813 ***********************************************************************/
815 /* Make a geometry string and pass that to GTK. It seems this is the
816 only way to get geometry position right if the user explicitly
817 asked for a position when starting Emacs.
818 F is the frame we shall set geometry for. */
820 static void
821 xg_set_geometry (FRAME_PTR f)
823 if (f->size_hint_flags & (USPosition | PPosition))
825 int left = f->left_pos;
826 int xneg = f->size_hint_flags & XNegative;
827 int top = f->top_pos;
828 int yneg = f->size_hint_flags & YNegative;
829 char geom_str[sizeof "=x--" + 4 * INT_STRLEN_BOUND (int)];
831 if (xneg)
832 left = -left;
833 if (yneg)
834 top = -top;
836 sprintf (geom_str, "=%dx%d%c%d%c%d",
837 FRAME_PIXEL_WIDTH (f),
838 FRAME_PIXEL_HEIGHT (f),
839 (xneg ? '-' : '+'), left,
840 (yneg ? '-' : '+'), top);
842 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
843 geom_str))
844 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
848 /* Clear under internal border if any. As we use a mix of Gtk+ and X calls
849 and use a GtkFixed widget, this doesn't happen automatically. */
851 static void
852 xg_clear_under_internal_border (FRAME_PTR f)
854 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
856 GtkWidget *wfixed = f->output_data.x->edit_widget;
857 gtk_widget_queue_draw (wfixed);
858 gdk_window_process_all_updates ();
859 x_clear_area (FRAME_X_DISPLAY (f),
860 FRAME_X_WINDOW (f),
861 0, 0,
862 FRAME_PIXEL_WIDTH (f),
863 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
864 x_clear_area (FRAME_X_DISPLAY (f),
865 FRAME_X_WINDOW (f),
866 0, 0,
867 FRAME_INTERNAL_BORDER_WIDTH (f),
868 FRAME_PIXEL_HEIGHT (f), 0);
869 x_clear_area (FRAME_X_DISPLAY (f),
870 FRAME_X_WINDOW (f),
871 0, FRAME_PIXEL_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
872 FRAME_PIXEL_WIDTH (f),
873 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
874 x_clear_area (FRAME_X_DISPLAY (f),
875 FRAME_X_WINDOW (f),
876 FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
878 FRAME_INTERNAL_BORDER_WIDTH (f),
879 FRAME_PIXEL_HEIGHT (f), 0);
883 /* Function to handle resize of our frame. As we have a Gtk+ tool bar
884 and a Gtk+ menu bar, we get resize events for the edit part of the
885 frame only. We let Gtk+ deal with the Gtk+ parts.
886 F is the frame to resize.
887 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
889 void
890 xg_frame_resized (FRAME_PTR f, int pixelwidth, int pixelheight)
892 int rows, columns;
894 if (pixelwidth == -1 && pixelheight == -1)
896 if (FRAME_GTK_WIDGET (f) && gtk_widget_get_mapped (FRAME_GTK_WIDGET (f)))
897 gdk_window_get_geometry (gtk_widget_get_window (FRAME_GTK_WIDGET (f)),
898 0, 0,
899 &pixelwidth, &pixelheight);
900 else return;
904 rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelheight);
905 columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pixelwidth);
907 if (columns != FRAME_COLS (f)
908 || rows != FRAME_LINES (f)
909 || pixelwidth != FRAME_PIXEL_WIDTH (f)
910 || pixelheight != FRAME_PIXEL_HEIGHT (f))
912 FRAME_PIXEL_WIDTH (f) = pixelwidth;
913 FRAME_PIXEL_HEIGHT (f) = pixelheight;
915 xg_clear_under_internal_border (f);
916 change_frame_size (f, rows, columns, 0, 1, 0);
917 SET_FRAME_GARBAGED (f);
918 cancel_mouse_face (f);
922 /* Resize the outer window of frame F after changing the height.
923 COLUMNS/ROWS is the size the edit area shall have after the resize. */
925 void
926 xg_frame_set_char_size (FRAME_PTR f, int cols, int rows)
928 int pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
929 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
930 int pixelwidth;
932 if (FRAME_PIXEL_HEIGHT (f) == 0)
933 return;
935 /* Take into account the size of the scroll bar. Always use the
936 number of columns occupied by the scroll bar here otherwise we
937 might end up with a frame width that is not a multiple of the
938 frame's character width which is bad for vertically split
939 windows. */
940 f->scroll_bar_actual_width
941 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
943 compute_fringe_widths (f, 0);
945 /* FRAME_TEXT_COLS_TO_PIXEL_WIDTH uses scroll_bar_actual_width, so call it
946 after calculating that value. */
947 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
948 + FRAME_TOOLBAR_WIDTH (f);
951 /* Do this before resize, as we don't know yet if we will be resized. */
952 xg_clear_under_internal_border (f);
954 /* Must resize our top level widget. Font size may have changed,
955 but not rows/cols. */
956 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
957 pixelwidth, pixelheight);
958 x_wm_set_size_hint (f, 0, 0);
960 SET_FRAME_GARBAGED (f);
961 cancel_mouse_face (f);
963 /* We can not call change_frame_size for a mapped frame,
964 we can not set pixel width/height either. The window manager may
965 override our resize request, XMonad does this all the time.
966 The best we can do is try to sync, so lisp code sees the updated
967 size as fast as possible.
968 For unmapped windows, we can set rows/cols. When
969 the frame is mapped again we will (hopefully) get the correct size. */
970 if (f->async_visible)
972 /* Must call this to flush out events */
973 (void)gtk_events_pending ();
974 gdk_flush ();
975 x_wait_for_event (f, ConfigureNotify);
977 else
979 change_frame_size (f, rows, cols, 0, 1, 0);
980 FRAME_PIXEL_WIDTH (f) = pixelwidth;
981 FRAME_PIXEL_HEIGHT (f) = pixelheight;
985 /* Handle height/width changes (i.e. add/remove/move menu/toolbar).
986 The policy is to keep the number of editable lines. */
988 static void
989 xg_height_or_width_changed (FRAME_PTR f)
991 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
992 FRAME_TOTAL_PIXEL_WIDTH (f),
993 FRAME_TOTAL_PIXEL_HEIGHT (f));
994 f->output_data.x->hint_flags = 0;
995 x_wm_set_size_hint (f, 0, 0);
998 /* Convert an X Window WSESC on display DPY to its corresponding GtkWidget.
999 Must be done like this, because GtkWidget:s can have "hidden"
1000 X Window that aren't accessible.
1002 Return 0 if no widget match WDESC. */
1004 GtkWidget *
1005 xg_win_to_widget (Display *dpy, Window wdesc)
1007 gpointer gdkwin;
1008 GtkWidget *gwdesc = 0;
1010 BLOCK_INPUT;
1012 gdkwin = gdk_x11_window_lookup_for_display (gdk_x11_lookup_xdisplay (dpy),
1013 wdesc);
1014 if (gdkwin)
1016 GdkEvent event;
1017 event.any.window = gdkwin;
1018 event.any.type = GDK_NOTHING;
1019 gwdesc = gtk_get_event_widget (&event);
1022 UNBLOCK_INPUT;
1023 return gwdesc;
1026 /* Set the background of widget W to PIXEL. */
1028 static void
1029 xg_set_widget_bg (FRAME_PTR f, GtkWidget *w, long unsigned int pixel)
1031 #ifdef HAVE_GTK3
1032 GdkRGBA bg;
1033 XColor xbg;
1034 xbg.pixel = pixel;
1035 if (XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &xbg))
1037 bg.red = (double)xbg.red/65536.0;
1038 bg.green = (double)xbg.green/65536.0;
1039 bg.blue = (double)xbg.blue/65536.0;
1040 bg.alpha = 1.0;
1041 gtk_widget_override_background_color (w, GTK_STATE_FLAG_NORMAL, &bg);
1043 #else
1044 GdkColor bg;
1045 GdkColormap *map = gtk_widget_get_colormap (w);
1046 gdk_colormap_query_color (map, pixel, &bg);
1047 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &bg);
1048 #endif
1051 /* Callback called when the gtk theme changes.
1052 We notify lisp code so it can fix faces used for region for example. */
1054 static void
1055 style_changed_cb (GObject *go,
1056 GParamSpec *spec,
1057 gpointer user_data)
1059 struct input_event event;
1060 GdkDisplay *gdpy = (GdkDisplay *) user_data;
1061 const char *display_name = gdk_display_get_name (gdpy);
1062 Display *dpy = GDK_DISPLAY_XDISPLAY (gdpy);
1064 EVENT_INIT (event);
1065 event.kind = CONFIG_CHANGED_EVENT;
1066 event.frame_or_window = build_string (display_name);
1067 /* Theme doesn't change often, so intern is called seldom. */
1068 event.arg = intern ("theme-name");
1069 kbd_buffer_store_event (&event);
1071 update_theme_scrollbar_width ();
1073 /* If scroll bar width changed, we need set the new size on all frames
1074 on this display. */
1075 if (dpy)
1077 Lisp_Object rest, frame;
1078 FOR_EACH_FRAME (rest, frame)
1080 FRAME_PTR f = XFRAME (frame);
1081 if (FRAME_X_DISPLAY (f) == dpy)
1083 x_set_scroll_bar_default_width (f);
1084 xg_frame_set_char_size (f, FRAME_COLS (f), FRAME_LINES (f));
1090 /* Called when a delete-event occurs on WIDGET. */
1092 static gboolean
1093 delete_cb (GtkWidget *widget,
1094 GdkEvent *event,
1095 gpointer user_data)
1097 #ifdef HAVE_GTK3
1098 /* The event doesn't arrive in the normal event loop. Send event
1099 here. */
1100 FRAME_PTR f = (FRAME_PTR) user_data;
1101 struct input_event ie;
1103 EVENT_INIT (ie);
1104 ie.kind = DELETE_WINDOW_EVENT;
1105 XSETFRAME (ie.frame_or_window, f);
1106 kbd_buffer_store_event (&ie);
1107 #endif
1109 return TRUE;
1112 /* Create and set up the GTK widgets for frame F.
1113 Return 0 if creation failed, non-zero otherwise. */
1116 xg_create_frame_widgets (FRAME_PTR f)
1118 GtkWidget *wtop;
1119 GtkWidget *wvbox, *whbox;
1120 GtkWidget *wfixed;
1121 #ifndef HAVE_GTK3
1122 GtkRcStyle *style;
1123 #endif
1124 char *title = 0;
1126 BLOCK_INPUT;
1128 if (FRAME_X_EMBEDDED_P (f))
1130 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
1131 wtop = gtk_plug_new_for_display (gdpy, f->output_data.x->parent_desc);
1133 else
1134 wtop = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1136 /* gtk_window_set_has_resize_grip is a Gtk+ 3.0 function but Ubuntu
1137 has backported it to Gtk+ 2.0 and they add the resize grip for
1138 Gtk+ 2.0 applications also. But it has a bug that makes Emacs loop
1139 forever, so disable the grip. */
1140 #if GTK_MAJOR_VERSION < 3 && defined (HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP)
1141 gtk_window_set_has_resize_grip (GTK_WINDOW (wtop), FALSE);
1142 #endif
1144 xg_set_screen (wtop, f);
1146 wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1147 whbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1148 gtk_box_set_homogeneous (GTK_BOX (wvbox), FALSE);
1149 gtk_box_set_homogeneous (GTK_BOX (whbox), FALSE);
1151 #ifdef HAVE_GTK3
1152 wfixed = emacs_fixed_new (f);
1153 #else
1154 wfixed = gtk_fixed_new ();
1155 #endif
1157 if (! wtop || ! wvbox || ! whbox || ! wfixed)
1159 if (wtop) gtk_widget_destroy (wtop);
1160 if (wvbox) gtk_widget_destroy (wvbox);
1161 if (whbox) gtk_widget_destroy (whbox);
1162 if (wfixed) gtk_widget_destroy (wfixed);
1164 UNBLOCK_INPUT;
1165 return 0;
1168 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
1169 gtk_widget_set_name (wtop, EMACS_CLASS);
1170 gtk_widget_set_name (wvbox, "pane");
1171 gtk_widget_set_name (wfixed, SSDATA (Vx_resource_name));
1173 /* If this frame has a title or name, set it in the title bar. */
1174 if (! NILP (f->title))
1175 title = SSDATA (ENCODE_UTF_8 (f->title));
1176 else if (! NILP (f->name))
1177 title = SSDATA (ENCODE_UTF_8 (f->name));
1179 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
1181 FRAME_GTK_OUTER_WIDGET (f) = wtop;
1182 FRAME_GTK_WIDGET (f) = wfixed;
1183 f->output_data.x->vbox_widget = wvbox;
1184 f->output_data.x->hbox_widget = whbox;
1186 gtk_widget_set_has_window (wfixed, TRUE);
1188 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
1189 gtk_box_pack_start (GTK_BOX (wvbox), whbox, TRUE, TRUE, 0);
1190 gtk_box_pack_start (GTK_BOX (whbox), wfixed, TRUE, TRUE, 0);
1192 if (FRAME_EXTERNAL_TOOL_BAR (f))
1193 update_frame_tool_bar (f);
1195 /* We don't want this widget double buffered, because we draw on it
1196 with regular X drawing primitives, so from a GTK/GDK point of
1197 view, the widget is totally blank. When an expose comes, this
1198 will make the widget blank, and then Emacs redraws it. This flickers
1199 a lot, so we turn off double buffering. */
1200 gtk_widget_set_double_buffered (wfixed, FALSE);
1202 gtk_window_set_wmclass (GTK_WINDOW (wtop),
1203 SSDATA (Vx_resource_name),
1204 SSDATA (Vx_resource_class));
1206 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
1207 GTK is to destroy the widget. We want Emacs to do that instead. */
1208 g_signal_connect (G_OBJECT (wtop), "delete-event",
1209 G_CALLBACK (delete_cb), f);
1211 /* Convert our geometry parameters into a geometry string
1212 and specify it.
1213 GTK will itself handle calculating the real position this way. */
1214 xg_set_geometry (f);
1215 f->win_gravity
1216 = gtk_window_get_gravity (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1218 gtk_widget_add_events (wfixed,
1219 GDK_POINTER_MOTION_MASK
1220 | GDK_EXPOSURE_MASK
1221 | GDK_BUTTON_PRESS_MASK
1222 | GDK_BUTTON_RELEASE_MASK
1223 | GDK_KEY_PRESS_MASK
1224 | GDK_ENTER_NOTIFY_MASK
1225 | GDK_LEAVE_NOTIFY_MASK
1226 | GDK_FOCUS_CHANGE_MASK
1227 | GDK_STRUCTURE_MASK
1228 | GDK_VISIBILITY_NOTIFY_MASK);
1230 /* Must realize the windows so the X window gets created. It is used
1231 by callers of this function. */
1232 gtk_widget_realize (wfixed);
1233 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
1235 /* Since GTK clears its window by filling with the background color,
1236 we must keep X and GTK background in sync. */
1237 xg_set_widget_bg (f, wfixed, FRAME_BACKGROUND_PIXEL (f));
1239 #ifndef HAVE_GTK3
1240 /* Also, do not let any background pixmap to be set, this looks very
1241 bad as Emacs overwrites the background pixmap with its own idea
1242 of background color. */
1243 style = gtk_widget_get_modifier_style (wfixed);
1245 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
1246 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
1247 gtk_widget_modify_style (wfixed, style);
1248 #else
1249 gtk_widget_set_can_focus (wfixed, TRUE);
1250 gtk_window_set_resizable (GTK_WINDOW (wtop), TRUE);
1251 #endif
1253 #ifdef USE_GTK_TOOLTIP
1254 /* Steal a tool tip window we can move ourselves. */
1255 f->output_data.x->ttip_widget = 0;
1256 f->output_data.x->ttip_lbl = 0;
1257 f->output_data.x->ttip_window = 0;
1258 gtk_widget_set_tooltip_text (wtop, "Dummy text");
1259 g_signal_connect (wtop, "query-tooltip", G_CALLBACK (qttip_cb), f);
1260 #endif
1263 GdkScreen *screen = gtk_widget_get_screen (wtop);
1264 GtkSettings *gs = gtk_settings_get_for_screen (screen);
1265 /* Only connect this signal once per screen. */
1266 if (! g_signal_handler_find (G_OBJECT (gs),
1267 G_SIGNAL_MATCH_FUNC,
1268 0, 0, 0,
1269 G_CALLBACK (style_changed_cb),
1272 g_signal_connect (G_OBJECT (gs), "notify::gtk-theme-name",
1273 G_CALLBACK (style_changed_cb),
1274 gdk_screen_get_display (screen));
1278 UNBLOCK_INPUT;
1280 return 1;
1283 void
1284 xg_free_frame_widgets (FRAME_PTR f)
1286 if (FRAME_GTK_OUTER_WIDGET (f))
1288 #ifdef USE_GTK_TOOLTIP
1289 struct x_output *x = f->output_data.x;
1290 #endif
1291 struct xg_frame_tb_info *tbinfo
1292 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
1293 TB_INFO_KEY);
1294 if (tbinfo)
1295 xfree (tbinfo);
1297 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
1298 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow in xterm.c */
1299 FRAME_GTK_OUTER_WIDGET (f) = 0;
1300 #ifdef USE_GTK_TOOLTIP
1301 if (x->ttip_lbl)
1302 gtk_widget_destroy (x->ttip_lbl);
1303 if (x->ttip_widget)
1304 g_object_unref (G_OBJECT (x->ttip_widget));
1305 #endif
1309 /* Set the normal size hints for the window manager, for frame F.
1310 FLAGS is the flags word to use--or 0 meaning preserve the flags
1311 that the window now has.
1312 If USER_POSITION is nonzero, we set the User Position
1313 flag (this is useful when FLAGS is 0). */
1315 void
1316 x_wm_set_size_hint (FRAME_PTR f, long int flags, int user_position)
1318 /* Must use GTK routines here, otherwise GTK resets the size hints
1319 to its own defaults. */
1320 GdkGeometry size_hints;
1321 gint hint_flags = 0;
1322 int base_width, base_height;
1323 int min_rows = 0, min_cols = 0;
1324 int win_gravity = f->win_gravity;
1326 /* Don't set size hints during initialization; that apparently leads
1327 to a race condition. See the thread at
1328 http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00033.html */
1329 if (NILP (Vafter_init_time) || !FRAME_GTK_OUTER_WIDGET (f))
1330 return;
1332 if (flags)
1334 memset (&size_hints, 0, sizeof (size_hints));
1335 f->output_data.x->size_hints = size_hints;
1336 f->output_data.x->hint_flags = hint_flags;
1338 else
1339 flags = f->size_hint_flags;
1341 size_hints = f->output_data.x->size_hints;
1342 hint_flags = f->output_data.x->hint_flags;
1344 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
1345 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
1346 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
1348 hint_flags |= GDK_HINT_BASE_SIZE;
1349 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0) + FRAME_TOOLBAR_WIDTH (f);
1350 /* Use one row here so base_height does not become zero.
1351 Gtk+ and/or Unity on Ubuntu 12.04 can't handle it. */
1352 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 1)
1353 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
1355 check_frame_size (f, &min_rows, &min_cols);
1356 if (min_rows > 0) --min_rows; /* We used one row in base_height = ... 1); */
1358 size_hints.base_width = base_width;
1359 size_hints.base_height = base_height;
1360 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
1361 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
1363 /* These currently have a one to one mapping with the X values, but I
1364 don't think we should rely on that. */
1365 hint_flags |= GDK_HINT_WIN_GRAVITY;
1366 size_hints.win_gravity = 0;
1367 if (win_gravity == NorthWestGravity)
1368 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
1369 else if (win_gravity == NorthGravity)
1370 size_hints.win_gravity = GDK_GRAVITY_NORTH;
1371 else if (win_gravity == NorthEastGravity)
1372 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
1373 else if (win_gravity == WestGravity)
1374 size_hints.win_gravity = GDK_GRAVITY_WEST;
1375 else if (win_gravity == CenterGravity)
1376 size_hints.win_gravity = GDK_GRAVITY_CENTER;
1377 else if (win_gravity == EastGravity)
1378 size_hints.win_gravity = GDK_GRAVITY_EAST;
1379 else if (win_gravity == SouthWestGravity)
1380 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
1381 else if (win_gravity == SouthGravity)
1382 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
1383 else if (win_gravity == SouthEastGravity)
1384 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
1385 else if (win_gravity == StaticGravity)
1386 size_hints.win_gravity = GDK_GRAVITY_STATIC;
1388 if (user_position)
1390 hint_flags &= ~GDK_HINT_POS;
1391 hint_flags |= GDK_HINT_USER_POS;
1394 if (hint_flags != f->output_data.x->hint_flags
1395 || memcmp (&size_hints,
1396 &f->output_data.x->size_hints,
1397 sizeof (size_hints)) != 0)
1399 BLOCK_INPUT;
1400 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1401 NULL, &size_hints, hint_flags);
1402 f->output_data.x->size_hints = size_hints;
1403 f->output_data.x->hint_flags = hint_flags;
1404 UNBLOCK_INPUT;
1408 /* Change background color of a frame.
1409 Since GTK uses the background color to clear the window, we must
1410 keep the GTK and X colors in sync.
1411 F is the frame to change,
1412 BG is the pixel value to change to. */
1414 void
1415 xg_set_background_color (FRAME_PTR f, long unsigned int bg)
1417 if (FRAME_GTK_WIDGET (f))
1419 BLOCK_INPUT;
1420 xg_set_widget_bg (f, FRAME_GTK_WIDGET (f), FRAME_BACKGROUND_PIXEL (f));
1421 UNBLOCK_INPUT;
1426 /* Set the frame icon to ICON_PIXMAP/MASK. This must be done with GTK
1427 functions so GTK does not overwrite the icon. */
1429 void
1430 xg_set_frame_icon (FRAME_PTR f, Pixmap icon_pixmap, Pixmap icon_mask)
1432 GdkPixbuf *gp = xg_get_pixbuf_from_pix_and_mask (f,
1433 icon_pixmap,
1434 icon_mask);
1435 if (gp)
1436 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), gp);
1441 /***********************************************************************
1442 Dialog functions
1443 ***********************************************************************/
1444 /* Return the dialog title to use for a dialog of type KEY.
1445 This is the encoding used by lwlib. We use the same for GTK. */
1447 static const char *
1448 get_dialog_title (char key)
1450 const char *title = "";
1452 switch (key) {
1453 case 'E': case 'e':
1454 title = "Error";
1455 break;
1457 case 'I': case 'i':
1458 title = "Information";
1459 break;
1461 case 'L': case 'l':
1462 title = "Prompt";
1463 break;
1465 case 'P': case 'p':
1466 title = "Prompt";
1467 break;
1469 case 'Q': case 'q':
1470 title = "Question";
1471 break;
1474 return title;
1477 /* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
1478 the dialog, but return TRUE so the event does not propagate further
1479 in GTK. This prevents GTK from destroying the dialog widget automatically
1480 and we can always destroy the widget manually, regardless of how
1481 it was popped down (button press or WM_DELETE_WINDOW).
1482 W is the dialog widget.
1483 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
1484 user_data is NULL (not used).
1486 Returns TRUE to end propagation of event. */
1488 static gboolean
1489 dialog_delete_callback (GtkWidget *w, GdkEvent *event, gpointer user_data)
1491 gtk_widget_unmap (w);
1492 return TRUE;
1495 /* Create a popup dialog window. See also xg_create_widget below.
1496 WV is a widget_value describing the dialog.
1497 SELECT_CB is the callback to use when a button has been pressed.
1498 DEACTIVATE_CB is the callback to use when the dialog pops down.
1500 Returns the GTK dialog widget. */
1502 static GtkWidget *
1503 create_dialog (widget_value *wv,
1504 GCallback select_cb,
1505 GCallback deactivate_cb)
1507 const char *title = get_dialog_title (wv->name[0]);
1508 int total_buttons = wv->name[1] - '0';
1509 int right_buttons = wv->name[4] - '0';
1510 int left_buttons;
1511 int button_nr = 0;
1512 int button_spacing = 10;
1513 GtkWidget *wdialog = gtk_dialog_new ();
1514 GtkDialog *wd = GTK_DIALOG (wdialog);
1515 GtkBox *cur_box = GTK_BOX (gtk_dialog_get_action_area (wd));
1516 widget_value *item;
1517 GtkWidget *whbox_down;
1519 /* If the number of buttons is greater than 4, make two rows of buttons
1520 instead. This looks better. */
1521 int make_two_rows = total_buttons > 4;
1523 if (right_buttons == 0) right_buttons = total_buttons/2;
1524 left_buttons = total_buttons - right_buttons;
1526 gtk_window_set_title (GTK_WINDOW (wdialog), title);
1527 gtk_widget_set_name (wdialog, "emacs-dialog");
1530 if (make_two_rows)
1532 GtkWidget *wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, button_spacing);
1533 GtkWidget *whbox_up = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1534 gtk_box_set_homogeneous (GTK_BOX (wvbox), TRUE);
1535 gtk_box_set_homogeneous (GTK_BOX (whbox_up), FALSE);
1536 whbox_down = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1537 gtk_box_set_homogeneous (GTK_BOX (whbox_down), FALSE);
1539 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
1540 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
1541 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
1543 cur_box = GTK_BOX (whbox_up);
1546 g_signal_connect (G_OBJECT (wdialog), "delete-event",
1547 G_CALLBACK (dialog_delete_callback), 0);
1549 if (deactivate_cb)
1551 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
1552 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
1555 for (item = wv->contents; item; item = item->next)
1557 char *utf8_label = get_utf8_string (item->value);
1558 GtkWidget *w;
1559 GtkRequisition req;
1561 if (item->name && strcmp (item->name, "message") == 0)
1563 GtkBox *wvbox = GTK_BOX (gtk_dialog_get_content_area (wd));
1564 /* This is the text part of the dialog. */
1565 w = gtk_label_new (utf8_label);
1566 gtk_box_pack_start (wvbox, gtk_label_new (""), FALSE, FALSE, 0);
1567 gtk_box_pack_start (wvbox, w, TRUE, TRUE, 0);
1568 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
1570 /* Try to make dialog look better. Must realize first so
1571 the widget can calculate the size it needs. */
1572 gtk_widget_realize (w);
1573 gtk_widget_get_preferred_size (w, NULL, &req);
1574 gtk_box_set_spacing (wvbox, req.height);
1575 if (item->value && strlen (item->value) > 0)
1576 button_spacing = 2*req.width/strlen (item->value);
1578 else
1580 /* This is one button to add to the dialog. */
1581 w = gtk_button_new_with_label (utf8_label);
1582 if (! item->enabled)
1583 gtk_widget_set_sensitive (w, FALSE);
1584 if (select_cb)
1585 g_signal_connect (G_OBJECT (w), "clicked",
1586 select_cb, item->call_data);
1588 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
1589 if (++button_nr == left_buttons)
1591 if (make_two_rows)
1592 cur_box = GTK_BOX (whbox_down);
1593 else
1594 gtk_box_pack_start (cur_box,
1595 gtk_label_new (""),
1596 TRUE, TRUE,
1597 button_spacing);
1601 if (utf8_label)
1602 g_free (utf8_label);
1605 return wdialog;
1608 struct xg_dialog_data
1610 GMainLoop *loop;
1611 int response;
1612 GtkWidget *w;
1613 guint timerid;
1616 /* Function that is called when the file or font dialogs pop down.
1617 W is the dialog widget, RESPONSE is the response code.
1618 USER_DATA is what we passed in to g_signal_connect. */
1620 static void
1621 xg_dialog_response_cb (GtkDialog *w,
1622 gint response,
1623 gpointer user_data)
1625 struct xg_dialog_data *dd = (struct xg_dialog_data *)user_data;
1626 dd->response = response;
1627 g_main_loop_quit (dd->loop);
1631 /* Destroy the dialog. This makes it pop down. */
1633 static Lisp_Object
1634 pop_down_dialog (Lisp_Object arg)
1636 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1637 struct xg_dialog_data *dd = (struct xg_dialog_data *) p->pointer;
1639 BLOCK_INPUT;
1640 if (dd->w) gtk_widget_destroy (dd->w);
1641 if (dd->timerid != 0) g_source_remove (dd->timerid);
1643 g_main_loop_quit (dd->loop);
1644 g_main_loop_unref (dd->loop);
1646 UNBLOCK_INPUT;
1648 return Qnil;
1651 /* If there are any emacs timers pending, add a timeout to main loop in DATA.
1652 We pass in DATA as gpointer* so we can use this as a callback. */
1654 static gboolean
1655 xg_maybe_add_timer (gpointer data)
1657 struct xg_dialog_data *dd = (struct xg_dialog_data *) data;
1658 EMACS_TIME next_time = timer_check ();
1660 dd->timerid = 0;
1662 if (EMACS_TIME_VALID_P (next_time))
1664 time_t s = EMACS_SECS (next_time);
1665 int per_ms = EMACS_TIME_RESOLUTION / 1000;
1666 int ms = (EMACS_NSECS (next_time) + per_ms - 1) / per_ms;
1667 if (s <= ((guint) -1 - ms) / 1000)
1668 dd->timerid = g_timeout_add (s * 1000 + ms, xg_maybe_add_timer, dd);
1670 return FALSE;
1674 /* Pops up a modal dialog W and waits for response.
1675 We don't use gtk_dialog_run because we want to process emacs timers.
1676 The dialog W is not destroyed when this function returns. */
1678 static int
1679 xg_dialog_run (FRAME_PTR f, GtkWidget *w)
1681 ptrdiff_t count = SPECPDL_INDEX ();
1682 struct xg_dialog_data dd;
1684 xg_set_screen (w, f);
1685 gtk_window_set_transient_for (GTK_WINDOW (w),
1686 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1687 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1688 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
1690 dd.loop = g_main_loop_new (NULL, FALSE);
1691 dd.response = GTK_RESPONSE_CANCEL;
1692 dd.w = w;
1693 dd.timerid = 0;
1695 g_signal_connect (G_OBJECT (w),
1696 "response",
1697 G_CALLBACK (xg_dialog_response_cb),
1698 &dd);
1699 /* Don't destroy the widget if closed by the window manager close button. */
1700 g_signal_connect (G_OBJECT (w), "delete-event", G_CALLBACK (gtk_true), NULL);
1701 gtk_widget_show (w);
1703 record_unwind_protect (pop_down_dialog, make_save_value (&dd, 0));
1705 (void) xg_maybe_add_timer (&dd);
1706 g_main_loop_run (dd.loop);
1708 dd.w = 0;
1709 unbind_to (count, Qnil);
1711 return dd.response;
1715 /***********************************************************************
1716 File dialog functions
1717 ***********************************************************************/
1718 /* Return non-zero if the old file selection dialog is being used.
1719 Return zero if not. */
1722 xg_uses_old_file_dialog (void)
1724 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1725 return x_gtk_use_old_file_dialog;
1726 #else
1727 return 0;
1728 #endif
1732 typedef char * (*xg_get_file_func) (GtkWidget *);
1734 /* Return the selected file for file chooser dialog W.
1735 The returned string must be free:d. */
1737 static char *
1738 xg_get_file_name_from_chooser (GtkWidget *w)
1740 return gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (w));
1743 /* Callback called when the "Show hidden files" toggle is pressed.
1744 WIDGET is the toggle widget, DATA is the file chooser dialog. */
1746 static void
1747 xg_toggle_visibility_cb (GtkWidget *widget, gpointer data)
1749 GtkFileChooser *dialog = GTK_FILE_CHOOSER (data);
1750 gboolean visible;
1751 g_object_get (G_OBJECT (dialog), "show-hidden", &visible, NULL);
1752 g_object_set (G_OBJECT (dialog), "show-hidden", !visible, NULL);
1756 /* Callback called when a property changes in a file chooser.
1757 GOBJECT is the file chooser dialog, ARG1 describes the property.
1758 USER_DATA is the toggle widget in the file chooser dialog.
1759 We use this to update the "Show hidden files" toggle when the user
1760 changes that property by right clicking in the file list. */
1762 static void
1763 xg_toggle_notify_cb (GObject *gobject, GParamSpec *arg1, gpointer user_data)
1765 if (strcmp (arg1->name, "show-hidden") == 0)
1767 GtkWidget *wtoggle = GTK_WIDGET (user_data);
1768 gboolean visible, toggle_on;
1770 g_object_get (G_OBJECT (gobject), "show-hidden", &visible, NULL);
1771 toggle_on = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (wtoggle));
1773 if (!!visible != !!toggle_on)
1775 g_signal_handlers_block_by_func (G_OBJECT (wtoggle),
1776 G_CALLBACK (xg_toggle_visibility_cb),
1777 gobject);
1778 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), visible);
1779 g_signal_handlers_unblock_by_func
1780 (G_OBJECT (wtoggle),
1781 G_CALLBACK (xg_toggle_visibility_cb),
1782 gobject);
1784 x_gtk_show_hidden_files = visible;
1788 /* Read a file name from the user using a file chooser dialog.
1789 F is the current frame.
1790 PROMPT is a prompt to show to the user. May not be NULL.
1791 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1792 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1793 file. (Actually, this only has cosmetic effects, the user can
1794 still enter a non-existing file.) *FUNC is set to a function that
1795 can be used to retrieve the selected file name from the returned widget.
1797 Returns the created widget. */
1799 static GtkWidget *
1800 xg_get_file_with_chooser (FRAME_PTR f,
1801 char *prompt,
1802 char *default_filename,
1803 int mustmatch_p, int only_dir_p,
1804 xg_get_file_func *func)
1806 char msgbuf[1024];
1808 GtkWidget *filewin, *wtoggle, *wbox, *wmessage IF_LINT (= NULL);
1809 GtkWindow *gwin = GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f));
1810 GtkFileChooserAction action = (mustmatch_p ?
1811 GTK_FILE_CHOOSER_ACTION_OPEN :
1812 GTK_FILE_CHOOSER_ACTION_SAVE);
1814 if (only_dir_p)
1815 action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
1817 filewin = gtk_file_chooser_dialog_new (prompt, gwin, action,
1818 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1819 (mustmatch_p || only_dir_p ?
1820 GTK_STOCK_OPEN : GTK_STOCK_OK),
1821 GTK_RESPONSE_OK,
1822 NULL);
1823 gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (filewin), TRUE);
1825 wbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1826 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
1827 gtk_widget_show (wbox);
1828 wtoggle = gtk_check_button_new_with_label ("Show hidden files.");
1830 if (x_gtk_show_hidden_files)
1832 g_object_set (G_OBJECT (filewin), "show-hidden", TRUE, NULL);
1833 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), TRUE);
1835 gtk_widget_show (wtoggle);
1836 g_signal_connect (G_OBJECT (wtoggle), "clicked",
1837 G_CALLBACK (xg_toggle_visibility_cb), filewin);
1838 g_signal_connect (G_OBJECT (filewin), "notify",
1839 G_CALLBACK (xg_toggle_notify_cb), wtoggle);
1841 if (x_gtk_file_dialog_help_text)
1843 msgbuf[0] = '\0';
1844 /* Gtk+ 2.10 has the file name text entry box integrated in the dialog.
1845 Show the C-l help text only for versions < 2.10. */
1846 if (gtk_check_version (2, 10, 0) && action != GTK_FILE_CHOOSER_ACTION_SAVE)
1847 strcat (msgbuf, "\nType C-l to display a file name text entry box.\n");
1848 strcat (msgbuf, "\nIf you don't like this file selector, use the "
1849 "corresponding\nkey binding or customize "
1850 "use-file-dialog to turn it off.");
1852 wmessage = gtk_label_new (msgbuf);
1853 gtk_widget_show (wmessage);
1856 gtk_box_pack_start (GTK_BOX (wbox), wtoggle, FALSE, FALSE, 0);
1857 if (x_gtk_file_dialog_help_text)
1858 gtk_box_pack_start (GTK_BOX (wbox), wmessage, FALSE, FALSE, 0);
1859 gtk_file_chooser_set_extra_widget (GTK_FILE_CHOOSER (filewin), wbox);
1861 if (default_filename)
1863 Lisp_Object file;
1864 struct gcpro gcpro1;
1865 char *utf8_filename;
1866 GCPRO1 (file);
1868 file = build_string (default_filename);
1870 /* File chooser does not understand ~/... in the file name. It must be
1871 an absolute name starting with /. */
1872 if (default_filename[0] != '/')
1873 file = Fexpand_file_name (file, Qnil);
1875 utf8_filename = SSDATA (ENCODE_UTF_8 (file));
1876 if (! NILP (Ffile_directory_p (file)))
1877 gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (filewin),
1878 utf8_filename);
1879 else
1881 gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (filewin),
1882 utf8_filename);
1883 if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
1885 char *cp = strrchr (utf8_filename, '/');
1886 if (cp) ++cp;
1887 else cp = utf8_filename;
1888 gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (filewin), cp);
1892 UNGCPRO;
1895 *func = xg_get_file_name_from_chooser;
1896 return filewin;
1899 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1901 /* Return the selected file for file selector dialog W.
1902 The returned string must be free:d. */
1904 static char *
1905 xg_get_file_name_from_selector (GtkWidget *w)
1907 GtkFileSelection *filesel = GTK_FILE_SELECTION (w);
1908 return xstrdup ((char*) gtk_file_selection_get_filename (filesel));
1911 /* Create a file selection dialog.
1912 F is the current frame.
1913 PROMPT is a prompt to show to the user. May not be NULL.
1914 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1915 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1916 file. *FUNC is set to a function that can be used to retrieve the
1917 selected file name from the returned widget.
1919 Returns the created widget. */
1921 static GtkWidget *
1922 xg_get_file_with_selection (FRAME_PTR f,
1923 char *prompt,
1924 char *default_filename,
1925 int mustmatch_p, int only_dir_p,
1926 xg_get_file_func *func)
1928 GtkWidget *filewin;
1929 GtkFileSelection *filesel;
1931 filewin = gtk_file_selection_new (prompt);
1932 filesel = GTK_FILE_SELECTION (filewin);
1934 if (default_filename)
1935 gtk_file_selection_set_filename (filesel, default_filename);
1937 if (mustmatch_p)
1939 /* The selection_entry part of filesel is not documented. */
1940 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
1941 gtk_file_selection_hide_fileop_buttons (filesel);
1944 *func = xg_get_file_name_from_selector;
1946 return filewin;
1948 #endif /* HAVE_GTK_FILE_SELECTION_NEW */
1950 /* Read a file name from the user using a file dialog, either the old
1951 file selection dialog, or the new file chooser dialog. Which to use
1952 depends on what the GTK version used has, and what the value of
1953 gtk-use-old-file-dialog.
1954 F is the current frame.
1955 PROMPT is a prompt to show to the user. May not be NULL.
1956 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1957 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1958 file.
1960 Returns a file name or NULL if no file was selected.
1961 The returned string must be freed by the caller. */
1963 char *
1964 xg_get_file_name (FRAME_PTR f,
1965 char *prompt,
1966 char *default_filename,
1967 int mustmatch_p,
1968 int only_dir_p)
1970 GtkWidget *w = 0;
1971 char *fn = 0;
1972 int filesel_done = 0;
1973 xg_get_file_func func;
1975 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
1976 /* I really don't know why this is needed, but without this the GLIBC add on
1977 library linuxthreads hangs when the Gnome file chooser backend creates
1978 threads. */
1979 sigblock (sigmask (__SIGRTMIN));
1980 #endif /* HAVE_PTHREAD */
1982 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1984 if (xg_uses_old_file_dialog ())
1985 w = xg_get_file_with_selection (f, prompt, default_filename,
1986 mustmatch_p, only_dir_p, &func);
1987 else
1988 w = xg_get_file_with_chooser (f, prompt, default_filename,
1989 mustmatch_p, only_dir_p, &func);
1991 #else /* not HAVE_GTK_FILE_SELECTION_NEW */
1992 w = xg_get_file_with_chooser (f, prompt, default_filename,
1993 mustmatch_p, only_dir_p, &func);
1994 #endif /* not HAVE_GTK_FILE_SELECTION_NEW */
1996 gtk_widget_set_name (w, "emacs-filedialog");
1998 filesel_done = xg_dialog_run (f, w);
2000 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
2001 sigunblock (sigmask (__SIGRTMIN));
2002 #endif
2004 if (filesel_done == GTK_RESPONSE_OK)
2005 fn = (*func) (w);
2007 gtk_widget_destroy (w);
2008 return fn;
2011 /***********************************************************************
2012 GTK font chooser
2013 ***********************************************************************/
2015 #ifdef HAVE_FREETYPE
2017 #if USE_NEW_GTK_FONT_CHOOSER
2019 extern Lisp_Object Qnormal;
2020 extern Lisp_Object Qextra_light, Qlight, Qsemi_light, Qsemi_bold;
2021 extern Lisp_Object Qbold, Qextra_bold, Qultra_bold;
2022 extern Lisp_Object Qoblique, Qitalic;
2024 #define XG_WEIGHT_TO_SYMBOL(w) \
2025 (w <= PANGO_WEIGHT_THIN ? Qextra_light \
2026 : w <= PANGO_WEIGHT_ULTRALIGHT ? Qlight \
2027 : w <= PANGO_WEIGHT_LIGHT ? Qsemi_light \
2028 : w < PANGO_WEIGHT_MEDIUM ? Qnormal \
2029 : w <= PANGO_WEIGHT_SEMIBOLD ? Qsemi_bold \
2030 : w <= PANGO_WEIGHT_BOLD ? Qbold \
2031 : w <= PANGO_WEIGHT_HEAVY ? Qextra_bold \
2032 : Qultra_bold)
2034 #define XG_STYLE_TO_SYMBOL(s) \
2035 (s == PANGO_STYLE_OBLIQUE ? Qoblique \
2036 : s == PANGO_STYLE_ITALIC ? Qitalic \
2037 : Qnormal)
2039 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2042 static char *x_last_font_name;
2044 /* Pop up a GTK font selector and return the name of the font the user
2045 selects, as a C string. The returned font name follows GTK's own
2046 format:
2048 `FAMILY [VALUE1 VALUE2] SIZE'
2050 This can be parsed using font_parse_fcname in font.c.
2051 DEFAULT_NAME, if non-zero, is the default font name. */
2053 Lisp_Object
2054 xg_get_font (FRAME_PTR f, const char *default_name)
2056 GtkWidget *w;
2057 int done = 0;
2058 Lisp_Object font = Qnil;
2060 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
2061 sigblock (sigmask (__SIGRTMIN));
2062 #endif /* HAVE_PTHREAD */
2064 w = gtk_font_chooser_dialog_new
2065 ("Pick a font", GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2067 if (default_name)
2069 /* Convert fontconfig names to Gtk names, i.e. remove - before
2070 number */
2071 char *p = strrchr (default_name, '-');
2072 if (p)
2074 char *ep = p+1;
2075 while (isdigit (*ep))
2076 ++ep;
2077 if (*ep == '\0') *p = ' ';
2080 else if (x_last_font_name)
2081 default_name = x_last_font_name;
2083 if (default_name)
2084 gtk_font_chooser_set_font (GTK_FONT_CHOOSER (w), default_name);
2086 gtk_widget_set_name (w, "emacs-fontdialog");
2087 done = xg_dialog_run (f, w);
2089 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
2090 sigunblock (sigmask (__SIGRTMIN));
2091 #endif
2093 if (done == GTK_RESPONSE_OK)
2095 #if USE_NEW_GTK_FONT_CHOOSER
2096 /* Use the GTK3 font chooser. */
2097 PangoFontDescription *desc
2098 = gtk_font_chooser_get_font_desc (GTK_FONT_CHOOSER (w));
2100 if (desc)
2102 Lisp_Object args[8];
2103 const char *name = pango_font_description_get_family (desc);
2104 gint size = pango_font_description_get_size (desc);
2105 PangoWeight weight = pango_font_description_get_weight (desc);
2106 PangoStyle style = pango_font_description_get_style (desc);
2108 args[0] = QCname;
2109 args[1] = build_string (name);
2111 args[2] = QCsize;
2112 args[3] = make_float (pango_units_to_double (size));
2114 args[4] = QCweight;
2115 args[5] = XG_WEIGHT_TO_SYMBOL (weight);
2117 args[6] = QCslant;
2118 args[7] = XG_STYLE_TO_SYMBOL (style);
2120 font = Ffont_spec (8, args);
2122 pango_font_description_free (desc);
2123 xfree (x_last_font_name);
2124 x_last_font_name = xstrdup (name);
2127 #else /* Use old font selector, which just returns the font name. */
2129 char *font_name
2130 = gtk_font_selection_dialog_get_font_name (GTK_FONT_CHOOSER (w));
2132 if (font_name)
2134 font = build_string (font_name);
2135 g_free (x_last_font_name);
2136 x_last_font_name = font_name;
2138 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2141 gtk_widget_destroy (w);
2142 return font;
2144 #endif /* HAVE_FREETYPE */
2148 /***********************************************************************
2149 Menu functions.
2150 ***********************************************************************/
2152 /* The name of menu items that can be used for customization. Since GTK
2153 RC files are very crude and primitive, we have to set this on all
2154 menu item names so a user can easily customize menu items. */
2156 #define MENU_ITEM_NAME "emacs-menuitem"
2159 /* Linked list of all allocated struct xg_menu_cb_data. Used for marking
2160 during GC. The next member points to the items. */
2161 static xg_list_node xg_menu_cb_list;
2163 /* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
2164 during GC. The next member points to the items. */
2165 static xg_list_node xg_menu_item_cb_list;
2167 /* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
2168 F is the frame CL_DATA will be initialized for.
2169 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2171 The menu bar and all sub menus under the menu bar in a frame
2172 share the same structure, hence the reference count.
2174 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
2175 allocated xg_menu_cb_data if CL_DATA is NULL. */
2177 static xg_menu_cb_data *
2178 make_cl_data (xg_menu_cb_data *cl_data, FRAME_PTR f, GCallback highlight_cb)
2180 if (! cl_data)
2182 cl_data = xmalloc (sizeof *cl_data);
2183 cl_data->f = f;
2184 cl_data->menu_bar_vector = f->menu_bar_vector;
2185 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2186 cl_data->highlight_cb = highlight_cb;
2187 cl_data->ref_count = 0;
2189 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
2192 cl_data->ref_count++;
2194 return cl_data;
2197 /* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
2198 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2200 When the menu bar is updated, menu items may have been added and/or
2201 removed, so menu_bar_vector and menu_bar_items_used change. We must
2202 then update CL_DATA since it is used to determine which menu
2203 item that is invoked in the menu.
2204 HIGHLIGHT_CB could change, there is no check that the same
2205 function is given when modifying a menu bar as was given when
2206 creating the menu bar. */
2208 static void
2209 update_cl_data (xg_menu_cb_data *cl_data,
2210 FRAME_PTR f,
2211 GCallback highlight_cb)
2213 if (cl_data)
2215 cl_data->f = f;
2216 cl_data->menu_bar_vector = f->menu_bar_vector;
2217 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2218 cl_data->highlight_cb = highlight_cb;
2222 /* Decrease reference count for CL_DATA.
2223 If reference count is zero, free CL_DATA. */
2225 static void
2226 unref_cl_data (xg_menu_cb_data *cl_data)
2228 if (cl_data && cl_data->ref_count > 0)
2230 cl_data->ref_count--;
2231 if (cl_data->ref_count == 0)
2233 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
2234 xfree (cl_data);
2239 /* Function that marks all lisp data during GC. */
2241 void
2242 xg_mark_data (void)
2244 xg_list_node *iter;
2245 Lisp_Object rest, frame;
2247 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
2248 mark_object (((xg_menu_cb_data *) iter)->menu_bar_vector);
2250 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
2252 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
2254 if (! NILP (cb_data->help))
2255 mark_object (cb_data->help);
2258 FOR_EACH_FRAME (rest, frame)
2260 FRAME_PTR f = XFRAME (frame);
2262 if (FRAME_X_OUTPUT (f) && FRAME_GTK_OUTER_WIDGET (f))
2264 struct xg_frame_tb_info *tbinfo
2265 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
2266 TB_INFO_KEY);
2267 if (tbinfo)
2269 mark_object (tbinfo->last_tool_bar);
2270 mark_object (tbinfo->style);
2277 /* Callback called when a menu item is destroyed. Used to free data.
2278 W is the widget that is being destroyed (not used).
2279 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
2281 static void
2282 menuitem_destroy_callback (GtkWidget *w, gpointer client_data)
2284 if (client_data)
2286 xg_menu_item_cb_data *data = (xg_menu_item_cb_data*) client_data;
2287 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
2288 xfree (data);
2292 /* Callback called when the pointer enters/leaves a menu item.
2293 W is the parent of the menu item.
2294 EVENT is either an enter event or leave event.
2295 CLIENT_DATA is not used.
2297 Returns FALSE to tell GTK to keep processing this event. */
2299 static gboolean
2300 menuitem_highlight_callback (GtkWidget *w,
2301 GdkEventCrossing *event,
2302 gpointer client_data)
2304 GdkEvent ev;
2305 GtkWidget *subwidget;
2306 xg_menu_item_cb_data *data;
2308 ev.crossing = *event;
2309 subwidget = gtk_get_event_widget (&ev);
2310 data = (xg_menu_item_cb_data *) g_object_get_data (G_OBJECT (subwidget),
2311 XG_ITEM_DATA);
2312 if (data)
2314 if (! NILP (data->help) && data->cl_data->highlight_cb)
2316 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : data;
2317 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
2318 (*func) (subwidget, call_data);
2322 return FALSE;
2325 /* Callback called when a menu is destroyed. Used to free data.
2326 W is the widget that is being destroyed (not used).
2327 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
2329 static void
2330 menu_destroy_callback (GtkWidget *w, gpointer client_data)
2332 unref_cl_data ((xg_menu_cb_data*) client_data);
2335 /* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
2336 must be non-NULL) and can be inserted into a menu item.
2338 Returns the GtkHBox. */
2340 static GtkWidget *
2341 make_widget_for_menu_item (const char *utf8_label, const char *utf8_key)
2343 GtkWidget *wlbl;
2344 GtkWidget *wkey;
2345 GtkWidget *wbox;
2347 wbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2348 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
2349 wlbl = gtk_label_new (utf8_label);
2350 wkey = gtk_label_new (utf8_key);
2352 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
2353 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
2355 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
2356 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
2358 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
2359 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
2360 gtk_widget_set_name (wbox, MENU_ITEM_NAME);
2362 return wbox;
2365 /* Make and return a menu item widget with the key to the right.
2366 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
2367 UTF8_KEY is the text representing the key binding.
2368 ITEM is the widget_value describing the menu item.
2370 GROUP is an in/out parameter. If the menu item to be created is not
2371 part of any radio menu group, *GROUP contains NULL on entry and exit.
2372 If the menu item to be created is part of a radio menu group, on entry
2373 *GROUP contains the group to use, or NULL if this is the first item
2374 in the group. On exit, *GROUP contains the radio item group.
2376 Unfortunately, keys don't line up as nicely as in Motif,
2377 but the MacOS X version doesn't either, so I guess that is OK. */
2379 static GtkWidget *
2380 make_menu_item (const char *utf8_label,
2381 const char *utf8_key,
2382 widget_value *item,
2383 GSList **group)
2385 GtkWidget *w;
2386 GtkWidget *wtoadd = 0;
2388 /* It has been observed that some menu items have a NULL name field.
2389 This will lead to this function being called with a NULL utf8_label.
2390 GTK crashes on that so we set a blank label. Why there is a NULL
2391 name remains to be investigated. */
2392 if (! utf8_label) utf8_label = " ";
2394 if (utf8_key)
2395 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2397 if (item->button_type == BUTTON_TYPE_TOGGLE)
2399 *group = NULL;
2400 if (utf8_key) w = gtk_check_menu_item_new ();
2401 else w = gtk_check_menu_item_new_with_label (utf8_label);
2402 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
2404 else if (item->button_type == BUTTON_TYPE_RADIO)
2406 if (utf8_key) w = gtk_radio_menu_item_new (*group);
2407 else w = gtk_radio_menu_item_new_with_label (*group, utf8_label);
2408 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
2409 if (item->selected)
2410 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
2412 else
2414 *group = NULL;
2415 if (utf8_key) w = gtk_menu_item_new ();
2416 else w = gtk_menu_item_new_with_label (utf8_label);
2419 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
2420 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
2422 return w;
2425 static int xg_detached_menus;
2427 /* Returns non-zero if there are detached menus. */
2430 xg_have_tear_offs (void)
2432 return xg_detached_menus > 0;
2435 /* Callback invoked when a detached menu window is removed. Here we
2436 decrease the xg_detached_menus count.
2437 WIDGET is the top level window that is removed (the parent of the menu).
2438 CLIENT_DATA is not used. */
2440 static void
2441 tearoff_remove (GtkWidget *widget, gpointer client_data)
2443 if (xg_detached_menus > 0) --xg_detached_menus;
2446 /* Callback invoked when a menu is detached. It increases the
2447 xg_detached_menus count.
2448 WIDGET is the GtkTearoffMenuItem.
2449 CLIENT_DATA is not used. */
2451 static void
2452 tearoff_activate (GtkWidget *widget, gpointer client_data)
2454 GtkWidget *menu = gtk_widget_get_parent (widget);
2455 if (gtk_menu_get_tearoff_state (GTK_MENU (menu)))
2457 ++xg_detached_menus;
2458 g_signal_connect (G_OBJECT (gtk_widget_get_toplevel (widget)),
2459 "destroy",
2460 G_CALLBACK (tearoff_remove), 0);
2465 /* Create a menu item widget, and connect the callbacks.
2466 ITEM describes the menu item.
2467 F is the frame the created menu belongs to.
2468 SELECT_CB is the callback to use when a menu item is selected.
2469 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2470 CL_DATA points to the callback data to be used for this menu.
2471 GROUP is an in/out parameter. If the menu item to be created is not
2472 part of any radio menu group, *GROUP contains NULL on entry and exit.
2473 If the menu item to be created is part of a radio menu group, on entry
2474 *GROUP contains the group to use, or NULL if this is the first item
2475 in the group. On exit, *GROUP contains the radio item group.
2477 Returns the created GtkWidget. */
2479 static GtkWidget *
2480 xg_create_one_menuitem (widget_value *item,
2481 FRAME_PTR f,
2482 GCallback select_cb,
2483 GCallback highlight_cb,
2484 xg_menu_cb_data *cl_data,
2485 GSList **group)
2487 char *utf8_label;
2488 char *utf8_key;
2489 GtkWidget *w;
2490 xg_menu_item_cb_data *cb_data;
2492 utf8_label = get_utf8_string (item->name);
2493 utf8_key = get_utf8_string (item->key);
2495 w = make_menu_item (utf8_label, utf8_key, item, group);
2497 if (utf8_label) g_free (utf8_label);
2498 if (utf8_key) g_free (utf8_key);
2500 cb_data = xmalloc (sizeof *cb_data);
2502 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
2504 cb_data->select_id = 0;
2505 cb_data->help = item->help;
2506 cb_data->cl_data = cl_data;
2507 cb_data->call_data = item->call_data;
2509 g_signal_connect (G_OBJECT (w),
2510 "destroy",
2511 G_CALLBACK (menuitem_destroy_callback),
2512 cb_data);
2514 /* Put cb_data in widget, so we can get at it when modifying menubar */
2515 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
2517 /* final item, not a submenu */
2518 if (item->call_data && ! item->contents)
2520 if (select_cb)
2521 cb_data->select_id
2522 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
2525 return w;
2528 /* Create a full menu tree specified by DATA.
2529 F is the frame the created menu belongs to.
2530 SELECT_CB is the callback to use when a menu item is selected.
2531 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2532 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2533 POP_UP_P is non-zero if we shall create a popup menu.
2534 MENU_BAR_P is non-zero if we shall create a menu bar.
2535 ADD_TEAROFF_P is non-zero if we shall add a tearoff menu item. Ignored
2536 if MENU_BAR_P is non-zero.
2537 TOPMENU is the topmost GtkWidget that others shall be placed under.
2538 It may be NULL, in that case we create the appropriate widget
2539 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
2540 CL_DATA is the callback data we shall use for this menu, or NULL
2541 if we haven't set the first callback yet.
2542 NAME is the name to give to the top level menu if this function
2543 creates it. May be NULL to not set any name.
2545 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
2546 not NULL.
2548 This function calls itself to create submenus. */
2550 static GtkWidget *
2551 create_menus (widget_value *data,
2552 FRAME_PTR f,
2553 GCallback select_cb,
2554 GCallback deactivate_cb,
2555 GCallback highlight_cb,
2556 int pop_up_p,
2557 int menu_bar_p,
2558 int add_tearoff_p,
2559 GtkWidget *topmenu,
2560 xg_menu_cb_data *cl_data,
2561 const char *name)
2563 widget_value *item;
2564 GtkWidget *wmenu = topmenu;
2565 GSList *group = NULL;
2567 if (! topmenu)
2569 if (! menu_bar_p)
2571 wmenu = gtk_menu_new ();
2572 xg_set_screen (wmenu, f);
2573 /* Connect this to the menu instead of items so we get enter/leave for
2574 disabled items also. TODO: Still does not get enter/leave for
2575 disabled items in detached menus. */
2576 g_signal_connect (G_OBJECT (wmenu),
2577 "enter-notify-event",
2578 G_CALLBACK (menuitem_highlight_callback),
2579 NULL);
2580 g_signal_connect (G_OBJECT (wmenu),
2581 "leave-notify-event",
2582 G_CALLBACK (menuitem_highlight_callback),
2583 NULL);
2585 else
2587 wmenu = gtk_menu_bar_new ();
2588 /* Set width of menu bar to a small value so it doesn't enlarge
2589 a small initial frame size. The width will be set to the
2590 width of the frame later on when it is added to a container.
2591 height -1: Natural height. */
2592 gtk_widget_set_size_request (wmenu, 1, -1);
2595 /* Put cl_data on the top menu for easier access. */
2596 cl_data = make_cl_data (cl_data, f, highlight_cb);
2597 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
2598 g_signal_connect (G_OBJECT (wmenu), "destroy",
2599 G_CALLBACK (menu_destroy_callback), cl_data);
2601 if (name)
2602 gtk_widget_set_name (wmenu, name);
2604 if (deactivate_cb)
2605 g_signal_connect (G_OBJECT (wmenu),
2606 "selection-done", deactivate_cb, 0);
2609 if (! menu_bar_p && add_tearoff_p)
2611 GtkWidget *tearoff = gtk_tearoff_menu_item_new ();
2612 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), tearoff);
2614 g_signal_connect (G_OBJECT (tearoff), "activate",
2615 G_CALLBACK (tearoff_activate), 0);
2618 for (item = data; item; item = item->next)
2620 GtkWidget *w;
2622 if (pop_up_p && !item->contents && !item->call_data
2623 && !menu_separator_name_p (item->name))
2625 char *utf8_label;
2626 /* A title for a popup. We do the same as GTK does when
2627 creating titles, but it does not look good. */
2628 group = NULL;
2629 utf8_label = get_utf8_string (item->name);
2631 gtk_menu_set_title (GTK_MENU (wmenu), utf8_label);
2632 w = gtk_menu_item_new_with_label (utf8_label);
2633 gtk_widget_set_sensitive (w, FALSE);
2634 if (utf8_label) g_free (utf8_label);
2636 else if (menu_separator_name_p (item->name))
2638 group = NULL;
2639 /* GTK only have one separator type. */
2640 w = gtk_separator_menu_item_new ();
2642 else
2644 w = xg_create_one_menuitem (item,
2646 item->contents ? 0 : select_cb,
2647 highlight_cb,
2648 cl_data,
2649 &group);
2651 /* Create a possibly empty submenu for menu bar items, since some
2652 themes don't highlight items correctly without it. */
2653 if (item->contents || menu_bar_p)
2655 GtkWidget *submenu = create_menus (item->contents,
2657 select_cb,
2658 deactivate_cb,
2659 highlight_cb,
2662 add_tearoff_p,
2664 cl_data,
2666 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2670 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
2671 gtk_widget_set_name (w, MENU_ITEM_NAME);
2674 return wmenu;
2677 /* Create a menubar, popup menu or dialog, depending on the TYPE argument.
2678 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
2679 with some text and buttons.
2680 F is the frame the created item belongs to.
2681 NAME is the name to use for the top widget.
2682 VAL is a widget_value structure describing items to be created.
2683 SELECT_CB is the callback to use when a menu item is selected or
2684 a dialog button is pressed.
2685 DEACTIVATE_CB is the callback to use when an item is deactivated.
2686 For a menu, when a sub menu is not shown anymore, for a dialog it is
2687 called when the dialog is popped down.
2688 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2690 Returns the widget created. */
2692 GtkWidget *
2693 xg_create_widget (const char *type, const char *name, FRAME_PTR f, widget_value *val,
2694 GCallback select_cb, GCallback deactivate_cb,
2695 GCallback highlight_cb)
2697 GtkWidget *w = 0;
2698 int menu_bar_p = strcmp (type, "menubar") == 0;
2699 int pop_up_p = strcmp (type, "popup") == 0;
2701 if (strcmp (type, "dialog") == 0)
2703 w = create_dialog (val, select_cb, deactivate_cb);
2704 xg_set_screen (w, f);
2705 gtk_window_set_transient_for (GTK_WINDOW (w),
2706 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2707 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
2708 gtk_widget_set_name (w, "emacs-dialog");
2709 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
2711 else if (menu_bar_p || pop_up_p)
2713 w = create_menus (val->contents,
2715 select_cb,
2716 deactivate_cb,
2717 highlight_cb,
2718 pop_up_p,
2719 menu_bar_p,
2720 menu_bar_p,
2723 name);
2725 /* Set the cursor to an arrow for popup menus when they are mapped.
2726 This is done by default for menu bar menus. */
2727 if (pop_up_p)
2729 /* Must realize so the GdkWindow inside the widget is created. */
2730 gtk_widget_realize (w);
2731 xg_set_cursor (w, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
2734 else
2736 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
2737 type);
2740 return w;
2743 /* Return the label for menu item WITEM. */
2745 static const char *
2746 xg_get_menu_item_label (GtkMenuItem *witem)
2748 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2749 return gtk_label_get_label (wlabel);
2752 /* Return non-zero if the menu item WITEM has the text LABEL. */
2754 static int
2755 xg_item_label_same_p (GtkMenuItem *witem, const char *label)
2757 int is_same = 0;
2758 char *utf8_label = get_utf8_string (label);
2759 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
2761 if (! old_label && ! utf8_label)
2762 is_same = 1;
2763 else if (old_label && utf8_label)
2764 is_same = strcmp (utf8_label, old_label) == 0;
2766 if (utf8_label) g_free (utf8_label);
2768 return is_same;
2771 /* Destroy widgets in LIST. */
2773 static void
2774 xg_destroy_widgets (GList *list)
2776 GList *iter;
2778 for (iter = list; iter; iter = g_list_next (iter))
2780 GtkWidget *w = GTK_WIDGET (iter->data);
2782 /* Destroying the widget will remove it from the container it is in. */
2783 gtk_widget_destroy (w);
2787 /* Update the top level names in MENUBAR (i.e. not submenus).
2788 F is the frame the menu bar belongs to.
2789 *LIST is a list with the current menu bar names (menu item widgets).
2790 ITER is the item within *LIST that shall be updated.
2791 POS is the numerical position, starting at 0, of ITER in *LIST.
2792 VAL describes what the menu bar shall look like after the update.
2793 SELECT_CB is the callback to use when a menu item is selected.
2794 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2795 CL_DATA points to the callback data to be used for this menu bar.
2797 This function calls itself to walk through the menu bar names. */
2799 static void
2800 xg_update_menubar (GtkWidget *menubar,
2801 FRAME_PTR f,
2802 GList **list,
2803 GList *iter,
2804 int pos,
2805 widget_value *val,
2806 GCallback select_cb,
2807 GCallback deactivate_cb,
2808 GCallback highlight_cb,
2809 xg_menu_cb_data *cl_data)
2811 if (! iter && ! val)
2812 return;
2813 else if (iter && ! val)
2815 /* Item(s) have been removed. Remove all remaining items. */
2816 xg_destroy_widgets (iter);
2818 /* Add a blank entry so the menubar doesn't collapse to nothing. */
2819 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2820 gtk_menu_item_new_with_label (""),
2822 /* All updated. */
2823 val = 0;
2824 iter = 0;
2826 else if (! iter && val)
2828 /* Item(s) added. Add all new items in one call. */
2829 create_menus (val, f, select_cb, deactivate_cb, highlight_cb,
2830 0, 1, 0, menubar, cl_data, 0);
2832 /* All updated. */
2833 val = 0;
2834 iter = 0;
2836 /* Below this neither iter or val is NULL */
2837 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
2839 /* This item is still the same, check next item. */
2840 val = val->next;
2841 iter = g_list_next (iter);
2842 ++pos;
2844 else /* This item is changed. */
2846 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
2847 GtkMenuItem *witem2 = 0;
2848 int val_in_menubar = 0;
2849 int iter_in_new_menubar = 0;
2850 GList *iter2;
2851 widget_value *cur;
2853 /* See if the changed entry (val) is present later in the menu bar */
2854 for (iter2 = iter;
2855 iter2 && ! val_in_menubar;
2856 iter2 = g_list_next (iter2))
2858 witem2 = GTK_MENU_ITEM (iter2->data);
2859 val_in_menubar = xg_item_label_same_p (witem2, val->name);
2862 /* See if the current entry (iter) is present later in the
2863 specification for the new menu bar. */
2864 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
2865 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
2867 if (val_in_menubar && ! iter_in_new_menubar)
2869 int nr = pos;
2871 /* This corresponds to:
2872 Current: A B C
2873 New: A C
2874 Remove B. */
2876 g_object_ref (G_OBJECT (witem));
2877 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
2878 gtk_widget_destroy (GTK_WIDGET (witem));
2880 /* Must get new list since the old changed. */
2881 g_list_free (*list);
2882 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2883 while (nr-- > 0) iter = g_list_next (iter);
2885 else if (! val_in_menubar && ! iter_in_new_menubar)
2887 /* This corresponds to:
2888 Current: A B C
2889 New: A X C
2890 Rename B to X. This might seem to be a strange thing to do,
2891 since if there is a menu under B it will be totally wrong for X.
2892 But consider editing a C file. Then there is a C-mode menu
2893 (corresponds to B above).
2894 If then doing C-x C-f the minibuf menu (X above) replaces the
2895 C-mode menu. When returning from the minibuffer, we get
2896 back the C-mode menu. Thus we do:
2897 Rename B to X (C-mode to minibuf menu)
2898 Rename X to B (minibuf to C-mode menu).
2899 If the X menu hasn't been invoked, the menu under B
2900 is up to date when leaving the minibuffer. */
2901 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2902 char *utf8_label = get_utf8_string (val->name);
2903 GtkWidget *submenu = gtk_menu_item_get_submenu (witem);
2905 gtk_label_set_text (wlabel, utf8_label);
2907 /* If this item has a submenu that has been detached, change
2908 the title in the WM decorations also. */
2909 if (submenu && gtk_menu_get_tearoff_state (GTK_MENU (submenu)))
2910 /* Set the title of the detached window. */
2911 gtk_menu_set_title (GTK_MENU (submenu), utf8_label);
2913 if (utf8_label) g_free (utf8_label);
2914 iter = g_list_next (iter);
2915 val = val->next;
2916 ++pos;
2918 else if (! val_in_menubar && iter_in_new_menubar)
2920 /* This corresponds to:
2921 Current: A B C
2922 New: A X B C
2923 Insert X. */
2925 int nr = pos;
2926 GSList *group = 0;
2927 GtkWidget *w = xg_create_one_menuitem (val,
2929 select_cb,
2930 highlight_cb,
2931 cl_data,
2932 &group);
2934 /* Create a possibly empty submenu for menu bar items, since some
2935 themes don't highlight items correctly without it. */
2936 GtkWidget *submenu = create_menus (NULL, f,
2937 select_cb, deactivate_cb,
2938 highlight_cb,
2939 0, 0, 0, 0, cl_data, 0);
2940 gtk_widget_set_name (w, MENU_ITEM_NAME);
2941 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
2942 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2944 g_list_free (*list);
2945 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2946 while (nr-- > 0) iter = g_list_next (iter);
2947 iter = g_list_next (iter);
2948 val = val->next;
2949 ++pos;
2951 else /* if (val_in_menubar && iter_in_new_menubar) */
2953 int nr = pos;
2954 /* This corresponds to:
2955 Current: A B C
2956 New: A C B
2957 Move C before B */
2959 g_object_ref (G_OBJECT (witem2));
2960 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
2961 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2962 GTK_WIDGET (witem2), pos);
2963 g_object_unref (G_OBJECT (witem2));
2965 g_list_free (*list);
2966 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2967 while (nr-- > 0) iter = g_list_next (iter);
2968 if (iter) iter = g_list_next (iter);
2969 val = val->next;
2970 ++pos;
2974 /* Update the rest of the menu bar. */
2975 xg_update_menubar (menubar, f, list, iter, pos, val,
2976 select_cb, deactivate_cb, highlight_cb, cl_data);
2979 /* Update the menu item W so it corresponds to VAL.
2980 SELECT_CB is the callback to use when a menu item is selected.
2981 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2982 CL_DATA is the data to set in the widget for menu invocation. */
2984 static void
2985 xg_update_menu_item (widget_value *val,
2986 GtkWidget *w,
2987 GCallback select_cb,
2988 GCallback highlight_cb,
2989 xg_menu_cb_data *cl_data)
2991 GtkWidget *wchild;
2992 GtkLabel *wlbl = 0;
2993 GtkLabel *wkey = 0;
2994 char *utf8_label;
2995 char *utf8_key;
2996 const char *old_label = 0;
2997 const char *old_key = 0;
2998 xg_menu_item_cb_data *cb_data;
3000 wchild = XG_BIN_CHILD (w);
3001 utf8_label = get_utf8_string (val->name);
3002 utf8_key = get_utf8_string (val->key);
3004 /* See if W is a menu item with a key. See make_menu_item above. */
3005 if (GTK_IS_BOX (wchild))
3007 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
3009 wlbl = GTK_LABEL (list->data);
3010 wkey = GTK_LABEL (list->next->data);
3011 g_list_free (list);
3013 if (! utf8_key)
3015 /* Remove the key and keep just the label. */
3016 g_object_ref (G_OBJECT (wlbl));
3017 gtk_container_remove (GTK_CONTAINER (w), wchild);
3018 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
3019 g_object_unref (G_OBJECT (wlbl));
3020 wkey = 0;
3024 else /* Just a label. */
3026 wlbl = GTK_LABEL (wchild);
3028 /* Check if there is now a key. */
3029 if (utf8_key)
3031 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
3032 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
3034 wlbl = GTK_LABEL (list->data);
3035 wkey = GTK_LABEL (list->next->data);
3036 g_list_free (list);
3038 gtk_container_remove (GTK_CONTAINER (w), wchild);
3039 gtk_container_add (GTK_CONTAINER (w), wtoadd);
3044 if (wkey) old_key = gtk_label_get_label (wkey);
3045 if (wlbl) old_label = gtk_label_get_label (wlbl);
3047 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
3048 gtk_label_set_text (wkey, utf8_key);
3050 if (! old_label || strcmp (utf8_label, old_label) != 0)
3051 gtk_label_set_text (wlbl, utf8_label);
3053 if (utf8_key) g_free (utf8_key);
3054 if (utf8_label) g_free (utf8_label);
3056 if (! val->enabled && gtk_widget_get_sensitive (w))
3057 gtk_widget_set_sensitive (w, FALSE);
3058 else if (val->enabled && ! gtk_widget_get_sensitive (w))
3059 gtk_widget_set_sensitive (w, TRUE);
3061 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (w),
3062 XG_ITEM_DATA);
3063 if (cb_data)
3065 cb_data->call_data = val->call_data;
3066 cb_data->help = val->help;
3067 cb_data->cl_data = cl_data;
3069 /* We assume the callback functions don't change. */
3070 if (val->call_data && ! val->contents)
3072 /* This item shall have a select callback. */
3073 if (! cb_data->select_id)
3074 cb_data->select_id
3075 = g_signal_connect (G_OBJECT (w), "activate",
3076 select_cb, cb_data);
3078 else if (cb_data->select_id)
3080 g_signal_handler_disconnect (w, cb_data->select_id);
3081 cb_data->select_id = 0;
3086 /* Update the toggle menu item W so it corresponds to VAL. */
3088 static void
3089 xg_update_toggle_item (widget_value *val, GtkWidget *w)
3091 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3094 /* Update the radio menu item W so it corresponds to VAL. */
3096 static void
3097 xg_update_radio_item (widget_value *val, GtkWidget *w)
3099 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3102 /* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
3103 SUBMENU may be NULL, in that case a new menu is created.
3104 F is the frame the menu bar belongs to.
3105 VAL describes the contents of the menu bar.
3106 SELECT_CB is the callback to use when a menu item is selected.
3107 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3108 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
3109 CL_DATA is the call back data to use for any newly created items.
3111 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
3112 was NULL. */
3114 static GtkWidget *
3115 xg_update_submenu (GtkWidget *submenu,
3116 FRAME_PTR f,
3117 widget_value *val,
3118 GCallback select_cb,
3119 GCallback deactivate_cb,
3120 GCallback highlight_cb,
3121 xg_menu_cb_data *cl_data)
3123 GtkWidget *newsub = submenu;
3124 GList *list = 0;
3125 GList *iter;
3126 widget_value *cur;
3127 int has_tearoff_p = 0;
3128 GList *first_radio = 0;
3130 if (submenu)
3131 list = gtk_container_get_children (GTK_CONTAINER (submenu));
3133 for (cur = val, iter = list;
3134 cur && iter;
3135 iter = g_list_next (iter), cur = cur->next)
3137 GtkWidget *w = GTK_WIDGET (iter->data);
3139 /* Skip tearoff items, they have no counterpart in val. */
3140 if (GTK_IS_TEAROFF_MENU_ITEM (w))
3142 has_tearoff_p = 1;
3143 iter = g_list_next (iter);
3144 if (iter) w = GTK_WIDGET (iter->data);
3145 else break;
3148 /* Remember first radio button in a group. If we get a mismatch in
3149 a radio group we must rebuild the whole group so that the connections
3150 in GTK becomes correct. */
3151 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
3152 first_radio = iter;
3153 else if (cur->button_type != BUTTON_TYPE_RADIO
3154 && ! GTK_IS_RADIO_MENU_ITEM (w))
3155 first_radio = 0;
3157 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
3159 if (! menu_separator_name_p (cur->name))
3160 break;
3162 else if (GTK_IS_CHECK_MENU_ITEM (w))
3164 if (cur->button_type != BUTTON_TYPE_TOGGLE)
3165 break;
3166 xg_update_toggle_item (cur, w);
3167 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3169 else if (GTK_IS_RADIO_MENU_ITEM (w))
3171 if (cur->button_type != BUTTON_TYPE_RADIO)
3172 break;
3173 xg_update_radio_item (cur, w);
3174 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3176 else if (GTK_IS_MENU_ITEM (w))
3178 GtkMenuItem *witem = GTK_MENU_ITEM (w);
3179 GtkWidget *sub;
3181 if (cur->button_type != BUTTON_TYPE_NONE ||
3182 menu_separator_name_p (cur->name))
3183 break;
3185 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3187 sub = gtk_menu_item_get_submenu (witem);
3188 if (sub && ! cur->contents)
3190 /* Not a submenu anymore. */
3191 g_object_ref (G_OBJECT (sub));
3192 remove_submenu (witem);
3193 gtk_widget_destroy (sub);
3195 else if (cur->contents)
3197 GtkWidget *nsub;
3199 nsub = xg_update_submenu (sub, f, cur->contents,
3200 select_cb, deactivate_cb,
3201 highlight_cb, cl_data);
3203 /* If this item just became a submenu, we must set it. */
3204 if (nsub != sub)
3205 gtk_menu_item_set_submenu (witem, nsub);
3208 else
3210 /* Structural difference. Remove everything from here and down
3211 in SUBMENU. */
3212 break;
3216 /* Remove widgets from first structural change. */
3217 if (iter)
3219 /* If we are adding new menu items below, we must remove from
3220 first radio button so that radio groups become correct. */
3221 if (cur && first_radio) xg_destroy_widgets (first_radio);
3222 else xg_destroy_widgets (iter);
3225 if (cur)
3227 /* More items added. Create them. */
3228 newsub = create_menus (cur,
3230 select_cb,
3231 deactivate_cb,
3232 highlight_cb,
3235 ! has_tearoff_p,
3236 submenu,
3237 cl_data,
3241 if (list) g_list_free (list);
3243 return newsub;
3246 /* Update the MENUBAR.
3247 F is the frame the menu bar belongs to.
3248 VAL describes the contents of the menu bar.
3249 If DEEP_P is non-zero, rebuild all but the top level menu names in
3250 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
3251 SELECT_CB is the callback to use when a menu item is selected.
3252 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3253 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
3255 void
3256 xg_modify_menubar_widgets (GtkWidget *menubar, FRAME_PTR f, widget_value *val,
3257 int deep_p,
3258 GCallback select_cb, GCallback deactivate_cb,
3259 GCallback highlight_cb)
3261 xg_menu_cb_data *cl_data;
3262 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
3264 if (! list) return;
3266 cl_data = (xg_menu_cb_data*) g_object_get_data (G_OBJECT (menubar),
3267 XG_FRAME_DATA);
3269 xg_update_menubar (menubar, f, &list, list, 0, val->contents,
3270 select_cb, deactivate_cb, highlight_cb, cl_data);
3272 if (deep_p)
3274 widget_value *cur;
3276 /* Update all sub menus.
3277 We must keep the submenus (GTK menu item widgets) since the
3278 X Window in the XEvent that activates the menu are those widgets. */
3280 /* Update cl_data, menu_item things in F may have changed. */
3281 update_cl_data (cl_data, f, highlight_cb);
3283 for (cur = val->contents; cur; cur = cur->next)
3285 GList *iter;
3286 GtkWidget *sub = 0;
3287 GtkWidget *newsub;
3288 GtkMenuItem *witem = 0;
3290 /* Find sub menu that corresponds to val and update it. */
3291 for (iter = list ; iter; iter = g_list_next (iter))
3293 witem = GTK_MENU_ITEM (iter->data);
3294 if (xg_item_label_same_p (witem, cur->name))
3296 sub = gtk_menu_item_get_submenu (witem);
3297 break;
3301 newsub = xg_update_submenu (sub,
3303 cur->contents,
3304 select_cb,
3305 deactivate_cb,
3306 highlight_cb,
3307 cl_data);
3308 /* sub may still be NULL. If we just updated non deep and added
3309 a new menu bar item, it has no sub menu yet. So we set the
3310 newly created sub menu under witem. */
3311 if (newsub != sub && witem != 0)
3313 xg_set_screen (newsub, f);
3314 gtk_menu_item_set_submenu (witem, newsub);
3319 g_list_free (list);
3320 gtk_widget_show_all (menubar);
3323 /* Callback called when the menu bar W is mapped.
3324 Used to find the height of the menu bar if we didn't get it
3325 after showing the widget. */
3327 static void
3328 menubar_map_cb (GtkWidget *w, gpointer user_data)
3330 GtkRequisition req;
3331 FRAME_PTR f = (FRAME_PTR) user_data;
3332 gtk_widget_get_preferred_size (w, NULL, &req);
3333 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3335 FRAME_MENUBAR_HEIGHT (f) = req.height;
3336 xg_height_or_width_changed (f);
3340 /* Recompute all the widgets of frame F, when the menu bar has been
3341 changed. Value is non-zero if widgets were updated. */
3344 xg_update_frame_menubar (FRAME_PTR f)
3346 struct x_output *x = f->output_data.x;
3347 GtkRequisition req;
3349 if (!x->menubar_widget || gtk_widget_get_mapped (x->menubar_widget))
3350 return 0;
3352 if (x->menubar_widget && gtk_widget_get_parent (x->menubar_widget))
3353 return 0; /* Already done this, happens for frames created invisible. */
3355 BLOCK_INPUT;
3357 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
3358 FALSE, FALSE, 0);
3359 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
3361 g_signal_connect (x->menubar_widget, "map", G_CALLBACK (menubar_map_cb), f);
3362 gtk_widget_show_all (x->menubar_widget);
3363 gtk_widget_get_preferred_size (x->menubar_widget, NULL, &req);
3365 /* If menu bar doesn't know its height yet, cheat a little so the frame
3366 doesn't jump so much when resized later in menubar_map_cb. */
3367 if (req.height == 0)
3368 req.height = 23;
3370 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3372 FRAME_MENUBAR_HEIGHT (f) = req.height;
3373 xg_height_or_width_changed (f);
3375 UNBLOCK_INPUT;
3377 return 1;
3380 /* Get rid of the menu bar of frame F, and free its storage.
3381 This is used when deleting a frame, and when turning off the menu bar. */
3383 void
3384 free_frame_menubar (FRAME_PTR f)
3386 struct x_output *x = f->output_data.x;
3388 if (x->menubar_widget)
3390 BLOCK_INPUT;
3392 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
3393 /* The menubar and its children shall be deleted when removed from
3394 the container. */
3395 x->menubar_widget = 0;
3396 FRAME_MENUBAR_HEIGHT (f) = 0;
3397 xg_height_or_width_changed (f);
3398 UNBLOCK_INPUT;
3403 xg_event_is_for_menubar (FRAME_PTR f, XEvent *event)
3405 struct x_output *x = f->output_data.x;
3406 GList *iter;
3407 GdkRectangle rec;
3408 GList *list;
3409 GdkDisplay *gdpy;
3410 GdkWindow *gw;
3411 GdkEvent gevent;
3412 GtkWidget *gwdesc;
3414 if (! x->menubar_widget) return 0;
3416 if (! (event->xbutton.x >= 0
3417 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
3418 && event->xbutton.y >= 0
3419 && event->xbutton.y < f->output_data.x->menubar_height
3420 && event->xbutton.same_screen))
3421 return 0;
3423 gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3424 gw = gdk_x11_window_lookup_for_display (gdpy, event->xbutton.window);
3425 if (! gw) return 0;
3426 gevent.any.window = gw;
3427 gevent.any.type = GDK_NOTHING;
3428 gwdesc = gtk_get_event_widget (&gevent);
3429 if (! gwdesc) return 0;
3430 if (! GTK_IS_MENU_BAR (gwdesc)
3431 && ! GTK_IS_MENU_ITEM (gwdesc)
3432 && ! gtk_widget_is_ancestor (x->menubar_widget, gwdesc))
3433 return 0;
3435 list = gtk_container_get_children (GTK_CONTAINER (x->menubar_widget));
3436 if (! list) return 0;
3437 rec.x = event->xbutton.x;
3438 rec.y = event->xbutton.y;
3439 rec.width = 1;
3440 rec.height = 1;
3442 for (iter = list ; iter; iter = g_list_next (iter))
3444 GtkWidget *w = GTK_WIDGET (iter->data);
3445 if (gtk_widget_get_mapped (w) && gtk_widget_intersect (w, &rec, NULL))
3446 break;
3448 g_list_free (list);
3449 return iter == 0 ? 0 : 1;
3454 /***********************************************************************
3455 Scroll bar functions
3456 ***********************************************************************/
3459 /* Setting scroll bar values invokes the callback. Use this variable
3460 to indicate that callback should do nothing. */
3462 int xg_ignore_gtk_scrollbar;
3464 /* The width of the scroll bar for the current theme. */
3466 static int scroll_bar_width_for_theme;
3468 /* Xlib's `Window' fits in 32 bits. But we want to store pointers, and they
3469 may be larger than 32 bits. Keep a mapping from integer index to widget
3470 pointers to get around the 32 bit limitation. */
3472 static struct
3474 GtkWidget **widgets;
3475 ptrdiff_t max_size;
3476 ptrdiff_t used;
3477 } id_to_widget;
3479 /* Grow this much every time we need to allocate more */
3481 #define ID_TO_WIDGET_INCR 32
3483 /* Store the widget pointer W in id_to_widget and return the integer index. */
3485 static ptrdiff_t
3486 xg_store_widget_in_map (GtkWidget *w)
3488 ptrdiff_t i;
3490 if (id_to_widget.max_size == id_to_widget.used)
3492 ptrdiff_t new_size;
3493 if (TYPE_MAXIMUM (Window) - ID_TO_WIDGET_INCR < id_to_widget.max_size)
3494 memory_full (SIZE_MAX);
3496 new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
3497 id_to_widget.widgets = xnrealloc (id_to_widget.widgets,
3498 new_size, sizeof (GtkWidget *));
3500 for (i = id_to_widget.max_size; i < new_size; ++i)
3501 id_to_widget.widgets[i] = 0;
3502 id_to_widget.max_size = new_size;
3505 /* Just loop over the array and find a free place. After all,
3506 how many scroll bars are we creating? Should be a small number.
3507 The check above guarantees we will find a free place. */
3508 for (i = 0; i < id_to_widget.max_size; ++i)
3510 if (! id_to_widget.widgets[i])
3512 id_to_widget.widgets[i] = w;
3513 ++id_to_widget.used;
3515 return i;
3519 /* Should never end up here */
3520 abort ();
3523 /* Remove pointer at IDX from id_to_widget.
3524 Called when scroll bar is destroyed. */
3526 static void
3527 xg_remove_widget_from_map (ptrdiff_t idx)
3529 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3531 id_to_widget.widgets[idx] = 0;
3532 --id_to_widget.used;
3536 /* Get the widget pointer at IDX from id_to_widget. */
3538 static GtkWidget *
3539 xg_get_widget_from_map (ptrdiff_t idx)
3541 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3542 return id_to_widget.widgets[idx];
3544 return 0;
3547 static void
3548 update_theme_scrollbar_width (void)
3550 #ifdef HAVE_GTK3
3551 GtkAdjustment *vadj;
3552 #else
3553 GtkObject *vadj;
3554 #endif
3555 GtkWidget *wscroll;
3556 int w = 0, b = 0;
3558 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX, 0.1, 0.1, 0.1);
3559 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3560 g_object_ref_sink (G_OBJECT (wscroll));
3561 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3562 gtk_widget_destroy (wscroll);
3563 g_object_unref (G_OBJECT (wscroll));
3564 w += 2*b;
3565 if (w < 16) w = 16;
3566 scroll_bar_width_for_theme = w;
3570 xg_get_default_scrollbar_width (void)
3572 return scroll_bar_width_for_theme;
3575 /* Return the scrollbar id for X Window WID on display DPY.
3576 Return -1 if WID not in id_to_widget. */
3578 ptrdiff_t
3579 xg_get_scroll_id_for_window (Display *dpy, Window wid)
3581 ptrdiff_t idx;
3582 GtkWidget *w;
3584 w = xg_win_to_widget (dpy, wid);
3586 if (w)
3588 for (idx = 0; idx < id_to_widget.max_size; ++idx)
3589 if (id_to_widget.widgets[idx] == w)
3590 return idx;
3593 return -1;
3596 /* Callback invoked when scroll bar WIDGET is destroyed.
3597 DATA is the index into id_to_widget for WIDGET.
3598 We free pointer to last scroll bar values here and remove the index. */
3600 static void
3601 xg_gtk_scroll_destroy (GtkWidget *widget, gpointer data)
3603 intptr_t id = (intptr_t) data;
3604 xg_remove_widget_from_map (id);
3607 /* Create a scroll bar widget for frame F. Store the scroll bar
3608 in BAR.
3609 SCROLL_CALLBACK is the callback to invoke when the value of the
3610 bar changes.
3611 END_CALLBACK is the callback to invoke when scrolling ends.
3612 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
3613 to set resources for the widget. */
3615 void
3616 xg_create_scroll_bar (FRAME_PTR f,
3617 struct scroll_bar *bar,
3618 GCallback scroll_callback,
3619 GCallback end_callback,
3620 const char *scroll_bar_name)
3622 GtkWidget *wscroll;
3623 GtkWidget *webox;
3624 intptr_t scroll_id;
3625 #ifdef HAVE_GTK3
3626 GtkAdjustment *vadj;
3627 #else
3628 GtkObject *vadj;
3629 #endif
3631 /* Page, step increment values are not so important here, they
3632 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3633 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
3634 0.1, 0.1, 0.1);
3636 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3637 webox = gtk_event_box_new ();
3638 gtk_widget_set_name (wscroll, scroll_bar_name);
3639 #ifndef HAVE_GTK3
3640 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3641 #endif
3642 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3644 scroll_id = xg_store_widget_in_map (wscroll);
3646 g_signal_connect (G_OBJECT (wscroll),
3647 "destroy",
3648 G_CALLBACK (xg_gtk_scroll_destroy),
3649 (gpointer) scroll_id);
3650 g_signal_connect (G_OBJECT (wscroll),
3651 "change-value",
3652 scroll_callback,
3653 (gpointer) bar);
3654 g_signal_connect (G_OBJECT (wscroll),
3655 "button-release-event",
3656 end_callback,
3657 (gpointer) bar);
3659 /* The scroll bar widget does not draw on a window of its own. Instead
3660 it draws on the parent window, in this case the edit widget. So
3661 whenever the edit widget is cleared, the scroll bar needs to redraw
3662 also, which causes flicker. Put an event box between the edit widget
3663 and the scroll bar, so the scroll bar instead draws itself on the
3664 event box window. */
3665 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3666 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3669 /* Set the cursor to an arrow. */
3670 xg_set_cursor (webox, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
3672 bar->x_window = scroll_id;
3675 /* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
3677 void
3678 xg_remove_scroll_bar (FRAME_PTR f, ptrdiff_t scrollbar_id)
3680 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3681 if (w)
3683 GtkWidget *wparent = gtk_widget_get_parent (w);
3684 gtk_widget_destroy (w);
3685 gtk_widget_destroy (wparent);
3686 SET_FRAME_GARBAGED (f);
3690 /* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
3691 in frame F.
3692 TOP/LEFT are the new pixel positions where the bar shall appear.
3693 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3695 void
3696 xg_update_scrollbar_pos (FRAME_PTR f,
3697 ptrdiff_t scrollbar_id,
3698 int top,
3699 int left,
3700 int width,
3701 int height)
3704 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3706 if (wscroll)
3708 GtkWidget *wfixed = f->output_data.x->edit_widget;
3709 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3710 gint msl;
3712 /* Clear out old position. */
3713 int oldx = -1, oldy = -1, oldw, oldh;
3714 if (gtk_widget_get_parent (wparent) == wfixed)
3716 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3717 "x", &oldx, "y", &oldy, NULL);
3718 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3721 /* Move and resize to new values. */
3722 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3723 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3724 if (msl > height)
3726 /* No room. Hide scroll bar as some themes output a warning if
3727 the height is less than the min size. */
3728 gtk_widget_hide (wparent);
3729 gtk_widget_hide (wscroll);
3731 else
3733 gtk_widget_show_all (wparent);
3734 gtk_widget_set_size_request (wscroll, width, height);
3736 gtk_widget_queue_draw (wfixed);
3737 gdk_window_process_all_updates ();
3738 if (oldx != -1 && oldw > 0 && oldh > 0)
3740 /* Clear under old scroll bar position. This must be done after
3741 the gtk_widget_queue_draw and gdk_window_process_all_updates
3742 above. */
3743 x_clear_area (FRAME_X_DISPLAY (f),
3744 FRAME_X_WINDOW (f),
3745 oldx, oldy, oldw, oldh, 0);
3748 /* GTK does not redraw until the main loop is entered again, but
3749 if there are no X events pending we will not enter it. So we sync
3750 here to get some events. */
3752 x_sync (f);
3753 SET_FRAME_GARBAGED (f);
3754 cancel_mouse_face (f);
3758 /* Get the current value of the range, truncated to an integer. */
3760 static int
3761 int_gtk_range_get_value (GtkRange *range)
3763 return gtk_range_get_value (range);
3767 /* Set the thumb size and position of scroll bar BAR. We are currently
3768 displaying PORTION out of a whole WHOLE, and our position POSITION. */
3770 void
3771 xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
3772 int portion,
3773 int position,
3774 int whole)
3776 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3778 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3780 if (wscroll && NILP (bar->dragging))
3782 GtkAdjustment *adj;
3783 gdouble shown;
3784 gdouble top;
3785 int size, value;
3786 int old_size;
3787 int new_step;
3788 int changed = 0;
3790 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3792 /* We do the same as for MOTIF in xterm.c, assume 30 chars per line
3793 rather than the real portion value. This makes the thumb less likely
3794 to resize and that looks better. */
3795 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
3796 /* When the thumb is at the bottom, position == whole.
3797 So we need to increase `whole' to make space for the thumb. */
3798 whole += portion;
3800 if (whole <= 0)
3801 top = 0, shown = 1;
3802 else
3804 top = (gdouble) position / whole;
3805 shown = (gdouble) portion / whole;
3808 size = shown * XG_SB_RANGE;
3809 size = min (size, XG_SB_RANGE);
3810 size = max (size, 1);
3812 value = top * XG_SB_RANGE;
3813 value = min (value, XG_SB_MAX - size);
3814 value = max (value, XG_SB_MIN);
3816 /* Assume all lines are of equal size. */
3817 new_step = size / max (1, FRAME_LINES (f));
3819 old_size = gtk_adjustment_get_page_size (adj);
3820 if (old_size != size)
3822 int old_step = gtk_adjustment_get_step_increment (adj);
3823 if (old_step != new_step)
3825 gtk_adjustment_set_page_size (adj, size);
3826 gtk_adjustment_set_step_increment (adj, new_step);
3827 /* Assume a page increment is about 95% of the page size */
3828 gtk_adjustment_set_page_increment (adj, size - size / 20);
3829 changed = 1;
3833 if (changed || int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3835 BLOCK_INPUT;
3837 /* gtk_range_set_value invokes the callback. Set
3838 ignore_gtk_scrollbar to make the callback do nothing */
3839 xg_ignore_gtk_scrollbar = 1;
3841 if (int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3842 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
3843 else if (changed)
3844 gtk_adjustment_changed (adj);
3846 xg_ignore_gtk_scrollbar = 0;
3848 UNBLOCK_INPUT;
3853 /* Return non-zero if EVENT is for a scroll bar in frame F.
3854 When the same X window is used for several Gtk+ widgets, we cannot
3855 say for sure based on the X window alone if an event is for the
3856 frame. This function does additional checks.
3858 Return non-zero if the event is for a scroll bar, zero otherwise. */
3861 xg_event_is_for_scrollbar (FRAME_PTR f, XEvent *event)
3863 int retval = 0;
3865 if (f && event->type == ButtonPress && event->xbutton.button < 4)
3867 /* Check if press occurred outside the edit widget. */
3868 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3869 GdkWindow *gwin;
3870 #ifdef HAVE_GTK3
3871 GdkDevice *gdev = gdk_device_manager_get_client_pointer
3872 (gdk_display_get_device_manager (gdpy));
3873 gwin = gdk_device_get_window_at_position (gdev, NULL, NULL);
3874 #else
3875 gwin = gdk_display_get_window_at_pointer (gdpy, NULL, NULL);
3876 #endif
3877 retval = gwin != gtk_widget_get_window (f->output_data.x->edit_widget);
3879 else if (f
3880 && ((event->type == ButtonRelease && event->xbutton.button < 4)
3881 || event->type == MotionNotify))
3883 /* If we are releasing or moving the scroll bar, it has the grab. */
3884 GtkWidget *w = gtk_grab_get_current ();
3885 retval = w != 0 && GTK_IS_SCROLLBAR (w);
3888 return retval;
3893 /***********************************************************************
3894 Tool bar functions
3895 ***********************************************************************/
3896 /* The key for the data we put in the GtkImage widgets. The data is
3897 the image used by Emacs. We use this to see if we need to update
3898 the GtkImage with a new image. */
3899 #define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
3901 /* The key for storing the latest modifiers so the activate callback can
3902 get them. */
3903 #define XG_TOOL_BAR_LAST_MODIFIER "emacs-tool-bar-modifier"
3905 /* The key for storing the button widget in its proxy menu item. */
3906 #define XG_TOOL_BAR_PROXY_BUTTON "emacs-tool-bar-proxy-button"
3908 /* The key for the data we put in the GtkImage widgets. The data is
3909 the stock name used by Emacs. We use this to see if we need to update
3910 the GtkImage with a new image. */
3911 #define XG_TOOL_BAR_STOCK_NAME "emacs-tool-bar-stock-name"
3913 /* As above, but this is used for named theme widgets, as opposed to
3914 stock items. */
3915 #define XG_TOOL_BAR_ICON_NAME "emacs-tool-bar-icon-name"
3917 /* Callback function invoked when a tool bar item is pressed.
3918 W is the button widget in the tool bar that got pressed,
3919 CLIENT_DATA is an integer that is the index of the button in the
3920 tool bar. 0 is the first button. */
3922 static gboolean
3923 xg_tool_bar_button_cb (GtkWidget *widget,
3924 GdkEventButton *event,
3925 gpointer user_data)
3927 intptr_t state = event->state;
3928 gpointer ptr = (gpointer) state;
3929 g_object_set_data (G_OBJECT (widget), XG_TOOL_BAR_LAST_MODIFIER, ptr);
3930 return FALSE;
3934 /* Callback function invoked when a tool bar item is pressed.
3935 W is the button widget in the tool bar that got pressed,
3936 CLIENT_DATA is an integer that is the index of the button in the
3937 tool bar. 0 is the first button. */
3939 static void
3940 xg_tool_bar_callback (GtkWidget *w, gpointer client_data)
3942 intptr_t idx = (intptr_t) client_data;
3943 gpointer gmod = g_object_get_data (G_OBJECT (w), XG_TOOL_BAR_LAST_MODIFIER);
3944 intptr_t mod = (intptr_t) gmod;
3946 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
3947 Lisp_Object key, frame;
3948 struct input_event event;
3949 EVENT_INIT (event);
3951 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
3952 return;
3954 idx *= TOOL_BAR_ITEM_NSLOTS;
3956 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
3957 XSETFRAME (frame, f);
3959 /* We generate two events here. The first one is to set the prefix
3960 to `(tool_bar)', see keyboard.c. */
3961 event.kind = TOOL_BAR_EVENT;
3962 event.frame_or_window = frame;
3963 event.arg = frame;
3964 kbd_buffer_store_event (&event);
3966 event.kind = TOOL_BAR_EVENT;
3967 event.frame_or_window = frame;
3968 event.arg = key;
3969 /* Convert between the modifier bits GDK uses and the modifier bits
3970 Emacs uses. This assumes GDK and X masks are the same, which they are when
3971 this is written. */
3972 event.modifiers = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), mod);
3973 kbd_buffer_store_event (&event);
3975 /* Return focus to the frame after we have clicked on a detached
3976 tool bar button. */
3977 Fx_focus_frame (frame);
3980 /* Callback function invoked when a tool bar item is pressed in a detached
3981 tool bar or the overflow drop down menu.
3982 We just call xg_tool_bar_callback.
3983 W is the menu item widget that got pressed,
3984 CLIENT_DATA is an integer that is the index of the button in the
3985 tool bar. 0 is the first button. */
3987 static void
3988 xg_tool_bar_proxy_callback (GtkWidget *w, gpointer client_data)
3990 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
3991 XG_TOOL_BAR_PROXY_BUTTON));
3992 xg_tool_bar_callback (wbutton, client_data);
3996 static gboolean
3997 xg_tool_bar_help_callback (GtkWidget *w,
3998 GdkEventCrossing *event,
3999 gpointer client_data);
4001 /* This callback is called when a help is to be shown for an item in
4002 the detached tool bar when the detached tool bar it is not expanded. */
4004 static gboolean
4005 xg_tool_bar_proxy_help_callback (GtkWidget *w,
4006 GdkEventCrossing *event,
4007 gpointer client_data)
4009 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
4010 XG_TOOL_BAR_PROXY_BUTTON));
4012 return xg_tool_bar_help_callback (wbutton, event, client_data);
4015 static GtkWidget *
4016 xg_get_tool_bar_widgets (GtkWidget *vb, GtkWidget **wimage)
4018 GList *clist = gtk_container_get_children (GTK_CONTAINER (vb));
4019 GtkWidget *c1 = (GtkWidget *) clist->data;
4020 GtkWidget *c2 = clist->next ? (GtkWidget *) clist->next->data : NULL;
4022 *wimage = GTK_IS_IMAGE (c1) ? c1 : c2;
4023 g_list_free (clist);
4024 return GTK_IS_LABEL (c1) ? c1 : c2;
4028 /* This callback is called when a tool item should create a proxy item,
4029 such as for the overflow menu. Also called when the tool bar is detached.
4030 If we don't create a proxy menu item, the detached tool bar will be
4031 blank. */
4033 static gboolean
4034 xg_tool_bar_menu_proxy (GtkToolItem *toolitem, gpointer user_data)
4036 GtkButton *wbutton = GTK_BUTTON (XG_BIN_CHILD (XG_BIN_CHILD (toolitem)));
4037 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4038 GtkWidget *c1;
4039 GtkLabel *wlbl = GTK_LABEL (xg_get_tool_bar_widgets (vb, &c1));
4040 GtkImage *wimage = GTK_IMAGE (c1);
4041 GtkWidget *wmenuitem = gtk_image_menu_item_new_with_label
4042 (wlbl ? gtk_label_get_text (wlbl) : "");
4043 GtkWidget *wmenuimage;
4046 if (gtk_button_get_use_stock (wbutton))
4047 wmenuimage = gtk_image_new_from_stock (gtk_button_get_label (wbutton),
4048 GTK_ICON_SIZE_MENU);
4049 else
4051 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (wbutton));
4052 GtkImageType store_type = gtk_image_get_storage_type (wimage);
4054 g_object_set (G_OBJECT (settings), "gtk-menu-images", TRUE, NULL);
4056 if (store_type == GTK_IMAGE_STOCK)
4058 gchar *stock_id;
4059 gtk_image_get_stock (wimage, &stock_id, NULL);
4060 wmenuimage = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
4062 else if (store_type == GTK_IMAGE_ICON_SET)
4064 GtkIconSet *icon_set;
4065 gtk_image_get_icon_set (wimage, &icon_set, NULL);
4066 wmenuimage = gtk_image_new_from_icon_set (icon_set,
4067 GTK_ICON_SIZE_MENU);
4069 else if (store_type == GTK_IMAGE_PIXBUF)
4071 gint width, height;
4073 if (settings &&
4074 gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
4075 &width, &height))
4077 GdkPixbuf *src_pixbuf, *dest_pixbuf;
4079 src_pixbuf = gtk_image_get_pixbuf (wimage);
4080 dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
4081 GDK_INTERP_BILINEAR);
4083 wmenuimage = gtk_image_new_from_pixbuf (dest_pixbuf);
4085 else
4087 fprintf (stderr, "internal error: GTK_IMAGE_PIXBUF failed\n");
4088 abort ();
4091 else if (store_type == GTK_IMAGE_ICON_NAME)
4093 const gchar *icon_name;
4094 GtkIconSize icon_size;
4096 gtk_image_get_icon_name (wimage, &icon_name, &icon_size);
4097 wmenuimage = gtk_image_new_from_icon_name (icon_name,
4098 GTK_ICON_SIZE_MENU);
4100 else
4102 fprintf (stderr, "internal error: store_type is %d\n", store_type);
4103 abort ();
4106 if (wmenuimage)
4107 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (wmenuitem), wmenuimage);
4109 g_signal_connect (G_OBJECT (wmenuitem),
4110 "activate",
4111 G_CALLBACK (xg_tool_bar_proxy_callback),
4112 user_data);
4115 g_object_set_data (G_OBJECT (wmenuitem), XG_TOOL_BAR_PROXY_BUTTON,
4116 (gpointer) wbutton);
4117 gtk_tool_item_set_proxy_menu_item (toolitem, "Emacs toolbar item", wmenuitem);
4118 gtk_widget_set_sensitive (wmenuitem,
4119 gtk_widget_get_sensitive (GTK_WIDGET (wbutton)));
4121 /* Use enter/leave notify to show help. We use the events
4122 rather than the GtkButton specific signals "enter" and
4123 "leave", so we can have only one callback. The event
4124 will tell us what kind of event it is. */
4125 g_signal_connect (G_OBJECT (wmenuitem),
4126 "enter-notify-event",
4127 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4128 user_data);
4129 g_signal_connect (G_OBJECT (wmenuitem),
4130 "leave-notify-event",
4131 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4132 user_data);
4134 return TRUE;
4137 /* This callback is called when a tool bar is detached. We must set
4138 the height of the tool bar to zero when this happens so frame sizes
4139 are correctly calculated.
4140 WBOX is the handle box widget that enables detach/attach of the tool bar.
4141 W is the tool bar widget.
4142 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4144 static void
4145 xg_tool_bar_detach_callback (GtkHandleBox *wbox,
4146 GtkWidget *w,
4147 gpointer client_data)
4149 FRAME_PTR f = (FRAME_PTR) client_data;
4151 g_object_set (G_OBJECT (w), "show-arrow", !x_gtk_whole_detached_tool_bar,
4152 NULL);
4154 if (f)
4156 GtkRequisition req, req2;
4157 FRAME_X_OUTPUT (f)->toolbar_detached = 1;
4158 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4159 gtk_widget_get_preferred_size (w, NULL, &req2);
4160 req.width -= req2.width;
4161 req.height -= req2.height;
4162 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4163 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4164 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4165 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4166 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4167 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4168 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4169 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4170 xg_height_or_width_changed (f);
4174 /* This callback is called when a tool bar is reattached. We must set
4175 the height of the tool bar when this happens so frame sizes
4176 are correctly calculated.
4177 WBOX is the handle box widget that enables detach/attach of the tool bar.
4178 W is the tool bar widget.
4179 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4181 static void
4182 xg_tool_bar_attach_callback (GtkHandleBox *wbox,
4183 GtkWidget *w,
4184 gpointer client_data)
4186 FRAME_PTR f = (FRAME_PTR) client_data;
4187 g_object_set (G_OBJECT (w), "show-arrow", TRUE, NULL);
4189 if (f)
4191 GtkRequisition req, req2;
4192 FRAME_X_OUTPUT (f)->toolbar_detached = 0;
4193 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4194 gtk_widget_get_preferred_size (w, NULL, &req2);
4195 req.width += req2.width;
4196 req.height += req2.height;
4197 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4198 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4199 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4200 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4201 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4202 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4203 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4204 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4205 xg_height_or_width_changed (f);
4209 /* This callback is called when the mouse enters or leaves a tool bar item.
4210 It is used for displaying and hiding the help text.
4211 W is the tool bar item, a button.
4212 EVENT is either an enter event or leave event.
4213 CLIENT_DATA is an integer that is the index of the button in the
4214 tool bar. 0 is the first button.
4216 Returns FALSE to tell GTK to keep processing this event. */
4218 static gboolean
4219 xg_tool_bar_help_callback (GtkWidget *w,
4220 GdkEventCrossing *event,
4221 gpointer client_data)
4223 intptr_t idx = (intptr_t) client_data;
4224 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4225 Lisp_Object help, frame;
4227 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4228 return FALSE;
4230 if (event->type == GDK_ENTER_NOTIFY)
4232 idx *= TOOL_BAR_ITEM_NSLOTS;
4233 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
4235 if (NILP (help))
4236 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
4238 else
4239 help = Qnil;
4241 XSETFRAME (frame, f);
4242 kbd_buffer_store_help_event (frame, help);
4244 return FALSE;
4248 /* This callback is called when a tool bar item shall be redrawn.
4249 It modifies the expose event so that the GtkImage widget redraws the
4250 whole image. This to overcome a bug that makes GtkImage draw the image
4251 in the wrong place when it tries to redraw just a part of the image.
4252 W is the GtkImage to be redrawn.
4253 EVENT is the expose event for W.
4254 CLIENT_DATA is unused.
4256 Returns FALSE to tell GTK to keep processing this event. */
4258 #ifndef HAVE_GTK3
4259 static gboolean
4260 xg_tool_bar_item_expose_callback (GtkWidget *w,
4261 GdkEventExpose *event,
4262 gpointer client_data)
4264 gint width, height;
4266 gdk_drawable_get_size (event->window, &width, &height);
4267 event->area.x -= width > event->area.width ? width-event->area.width : 0;
4268 event->area.y -= height > event->area.height ? height-event->area.height : 0;
4270 event->area.x = max (0, event->area.x);
4271 event->area.y = max (0, event->area.y);
4273 event->area.width = max (width, event->area.width);
4274 event->area.height = max (height, event->area.height);
4276 return FALSE;
4278 #endif
4280 #ifdef HAVE_GTK_ORIENTABLE_SET_ORIENTATION
4281 #define toolbar_set_orientation(w, o) \
4282 gtk_orientable_set_orientation (GTK_ORIENTABLE (w), o)
4283 #else
4284 #define toolbar_set_orientation(w, o) \
4285 gtk_toolbar_set_orientation (GTK_TOOLBAR (w), o)
4286 #endif
4288 /* Attach a tool bar to frame F. */
4290 static void
4291 xg_pack_tool_bar (FRAME_PTR f, Lisp_Object pos)
4293 struct x_output *x = f->output_data.x;
4294 int into_hbox = EQ (pos, Qleft) || EQ (pos, Qright);
4296 toolbar_set_orientation (x->toolbar_widget,
4297 into_hbox
4298 ? GTK_ORIENTATION_VERTICAL
4299 : GTK_ORIENTATION_HORIZONTAL);
4300 if (!x->handlebox_widget)
4302 x->handlebox_widget = gtk_handle_box_new ();
4303 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-detached",
4304 G_CALLBACK (xg_tool_bar_detach_callback), f);
4305 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-attached",
4306 G_CALLBACK (xg_tool_bar_attach_callback), f);
4307 gtk_container_add (GTK_CONTAINER (x->handlebox_widget),
4308 x->toolbar_widget);
4311 if (into_hbox)
4313 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4314 GTK_POS_TOP);
4315 gtk_box_pack_start (GTK_BOX (x->hbox_widget), x->handlebox_widget,
4316 FALSE, FALSE, 0);
4318 if (EQ (pos, Qleft))
4319 gtk_box_reorder_child (GTK_BOX (x->hbox_widget),
4320 x->handlebox_widget,
4322 x->toolbar_in_hbox = 1;
4324 else
4326 int vbox_pos = x->menubar_widget ? 1 : 0;
4327 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4328 GTK_POS_LEFT);
4329 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->handlebox_widget,
4330 FALSE, FALSE, 0);
4332 if (EQ (pos, Qtop))
4333 gtk_box_reorder_child (GTK_BOX (x->vbox_widget),
4334 x->handlebox_widget,
4335 vbox_pos);
4336 x->toolbar_in_hbox = 0;
4340 /* Create a tool bar for frame F. */
4342 static void
4343 xg_create_tool_bar (FRAME_PTR f)
4345 struct x_output *x = f->output_data.x;
4346 #if GTK_CHECK_VERSION (3, 3, 6)
4347 GtkStyleContext *gsty;
4348 #endif
4349 struct xg_frame_tb_info *tbinfo
4350 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4351 TB_INFO_KEY);
4352 if (! tbinfo)
4354 tbinfo = xmalloc (sizeof (*tbinfo));
4355 tbinfo->last_tool_bar = Qnil;
4356 tbinfo->style = Qnil;
4357 tbinfo->hmargin = tbinfo->vmargin = 0;
4358 tbinfo->dir = GTK_TEXT_DIR_NONE;
4359 tbinfo->n_last_items = 0;
4360 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4361 TB_INFO_KEY,
4362 tbinfo);
4365 x->toolbar_widget = gtk_toolbar_new ();
4366 x->toolbar_detached = 0;
4368 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
4370 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
4371 toolbar_set_orientation (x->toolbar_widget, GTK_ORIENTATION_HORIZONTAL);
4372 #if GTK_CHECK_VERSION (3, 3, 6)
4373 gsty = gtk_widget_get_style_context (x->toolbar_widget);
4374 gtk_style_context_add_class (gsty, "primary-toolbar");
4375 #endif
4379 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
4381 /* Find the right-to-left image named by RTL in the tool bar images for F.
4382 Returns IMAGE if RTL is not found. */
4384 static Lisp_Object
4385 find_rtl_image (FRAME_PTR f, Lisp_Object image, Lisp_Object rtl)
4387 int i;
4388 Lisp_Object file, rtl_name;
4389 struct gcpro gcpro1, gcpro2;
4390 GCPRO2 (file, rtl_name);
4392 rtl_name = Ffile_name_nondirectory (rtl);
4394 for (i = 0; i < f->n_tool_bar_items; ++i)
4396 Lisp_Object rtl_image = PROP (TOOL_BAR_ITEM_IMAGES);
4397 if (!NILP (file = file_for_image (rtl_image)))
4399 file = call1 (intern ("file-name-sans-extension"),
4400 Ffile_name_nondirectory (file));
4401 if (! NILP (Fequal (file, rtl_name)))
4403 image = rtl_image;
4404 break;
4409 return image;
4412 static GtkToolItem *
4413 xg_make_tool_item (FRAME_PTR f,
4414 GtkWidget *wimage,
4415 GtkWidget **wbutton,
4416 const char *label,
4417 int i, int horiz, int text_image)
4419 GtkToolItem *ti = gtk_tool_item_new ();
4420 GtkWidget *vb = gtk_box_new (horiz
4421 ? GTK_ORIENTATION_HORIZONTAL
4422 : GTK_ORIENTATION_VERTICAL,
4424 GtkWidget *wb = gtk_button_new ();
4425 /* The eventbox is here so we can have tooltips on disabled items. */
4426 GtkWidget *weventbox = gtk_event_box_new ();
4427 #if GTK_CHECK_VERSION (3, 3, 6)
4428 GtkCssProvider *css_prov = gtk_css_provider_new ();
4429 GtkStyleContext *gsty;
4431 gtk_css_provider_load_from_data (css_prov,
4432 "GtkEventBox {"
4433 " background-color: transparent;"
4434 "}",
4435 -1, NULL);
4437 gsty = gtk_widget_get_style_context (weventbox);
4438 gtk_style_context_add_provider (gsty,
4439 GTK_STYLE_PROVIDER (css_prov),
4440 GTK_STYLE_PROVIDER_PRIORITY_USER);
4441 g_object_unref (css_prov);
4442 #endif
4444 gtk_box_set_homogeneous (GTK_BOX (vb), FALSE);
4446 if (wimage && !text_image)
4447 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4448 if (label)
4449 gtk_box_pack_start (GTK_BOX (vb), gtk_label_new (label), TRUE, TRUE, 0);
4450 if (wimage && text_image)
4451 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4453 gtk_button_set_focus_on_click (GTK_BUTTON (wb), FALSE);
4454 gtk_button_set_relief (GTK_BUTTON (wb), GTK_RELIEF_NONE);
4455 gtk_container_add (GTK_CONTAINER (wb), vb);
4456 gtk_container_add (GTK_CONTAINER (weventbox), wb);
4457 gtk_container_add (GTK_CONTAINER (ti), weventbox);
4459 if (wimage || label)
4461 intptr_t ii = i;
4462 gpointer gi = (gpointer) ii;
4464 g_signal_connect (G_OBJECT (ti), "create-menu-proxy",
4465 G_CALLBACK (xg_tool_bar_menu_proxy),
4466 gi);
4468 g_signal_connect (G_OBJECT (wb), "clicked",
4469 G_CALLBACK (xg_tool_bar_callback),
4470 gi);
4472 g_object_set_data (G_OBJECT (weventbox), XG_FRAME_DATA, (gpointer)f);
4474 #ifndef HAVE_GTK3
4475 /* Catch expose events to overcome an annoying redraw bug, see
4476 comment for xg_tool_bar_item_expose_callback. */
4477 g_signal_connect (G_OBJECT (ti),
4478 "expose-event",
4479 G_CALLBACK (xg_tool_bar_item_expose_callback),
4481 #endif
4482 gtk_tool_item_set_homogeneous (ti, FALSE);
4484 /* Callback to save modifier mask (Shift/Control, etc). GTK makes
4485 no distinction based on modifiers in the activate callback,
4486 so we have to do it ourselves. */
4487 g_signal_connect (wb, "button-release-event",
4488 G_CALLBACK (xg_tool_bar_button_cb),
4489 NULL);
4491 g_object_set_data (G_OBJECT (wb), XG_FRAME_DATA, (gpointer)f);
4493 /* Use enter/leave notify to show help. We use the events
4494 rather than the GtkButton specific signals "enter" and
4495 "leave", so we can have only one callback. The event
4496 will tell us what kind of event it is. */
4497 g_signal_connect (G_OBJECT (weventbox),
4498 "enter-notify-event",
4499 G_CALLBACK (xg_tool_bar_help_callback),
4500 gi);
4501 g_signal_connect (G_OBJECT (weventbox),
4502 "leave-notify-event",
4503 G_CALLBACK (xg_tool_bar_help_callback),
4504 gi);
4507 if (wbutton) *wbutton = wb;
4509 return ti;
4512 static int
4513 is_box_type (GtkWidget *vb, int is_horizontal)
4515 #ifdef HAVE_GTK3
4516 int ret = 0;
4517 if (GTK_IS_BOX (vb))
4519 GtkOrientation ori = gtk_orientable_get_orientation (GTK_ORIENTABLE (vb));
4520 ret = (ori == GTK_ORIENTATION_HORIZONTAL && is_horizontal)
4521 || (ori == GTK_ORIENTATION_VERTICAL && ! is_horizontal);
4523 return ret;
4524 #else
4525 return is_horizontal ? GTK_IS_VBOX (vb) : GTK_IS_HBOX (vb);
4526 #endif
4530 static int
4531 xg_tool_item_stale_p (GtkWidget *wbutton, const char *stock_name,
4532 const char *icon_name, const struct image *img,
4533 const char *label, int horiz)
4535 gpointer old;
4536 GtkWidget *wimage;
4537 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4538 GtkWidget *wlbl = xg_get_tool_bar_widgets (vb, &wimage);
4540 /* Check if the tool icon matches. */
4541 if (stock_name && wimage)
4543 old = g_object_get_data (G_OBJECT (wimage),
4544 XG_TOOL_BAR_STOCK_NAME);
4545 if (!old || strcmp (old, stock_name))
4546 return 1;
4548 else if (icon_name && wimage)
4550 old = g_object_get_data (G_OBJECT (wimage),
4551 XG_TOOL_BAR_ICON_NAME);
4552 if (!old || strcmp (old, icon_name))
4553 return 1;
4555 else if (wimage)
4557 gpointer gold_img = g_object_get_data (G_OBJECT (wimage),
4558 XG_TOOL_BAR_IMAGE_DATA);
4559 Pixmap old_img = (Pixmap) gold_img;
4560 if (old_img != img->pixmap)
4561 return 1;
4564 /* Check button configuration and label. */
4565 if (is_box_type (vb, horiz)
4566 || (label ? (wlbl == NULL) : (wlbl != NULL)))
4567 return 1;
4569 /* Ensure label is correct. */
4570 if (label && wlbl)
4571 gtk_label_set_text (GTK_LABEL (wlbl), label);
4572 return 0;
4575 static int
4576 xg_update_tool_bar_sizes (FRAME_PTR f)
4578 struct x_output *x = f->output_data.x;
4579 GtkRequisition req;
4580 int nl = 0, nr = 0, nt = 0, nb = 0;
4582 gtk_widget_get_preferred_size (GTK_WIDGET (x->handlebox_widget), NULL, &req);
4583 if (x->toolbar_in_hbox)
4585 int pos;
4586 gtk_container_child_get (GTK_CONTAINER (x->hbox_widget),
4587 x->handlebox_widget,
4588 "position", &pos, NULL);
4589 if (pos == 0) nl = req.width;
4590 else nr = req.width;
4592 else
4594 int pos;
4595 gtk_container_child_get (GTK_CONTAINER (x->vbox_widget),
4596 x->handlebox_widget,
4597 "position", &pos, NULL);
4598 if (pos == 0 || (pos == 1 && x->menubar_widget)) nt = req.height;
4599 else nb = req.height;
4602 if (nl != FRAME_TOOLBAR_LEFT_WIDTH (f)
4603 || nr != FRAME_TOOLBAR_RIGHT_WIDTH (f)
4604 || nt != FRAME_TOOLBAR_TOP_HEIGHT (f)
4605 || nb != FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
4607 FRAME_TOOLBAR_RIGHT_WIDTH (f) = FRAME_TOOLBAR_LEFT_WIDTH (f)
4608 = FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4609 FRAME_TOOLBAR_LEFT_WIDTH (f) = nl;
4610 FRAME_TOOLBAR_RIGHT_WIDTH (f) = nr;
4611 FRAME_TOOLBAR_TOP_HEIGHT (f) = nt;
4612 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = nb;
4613 return 1;
4616 return 0;
4620 /* Update the tool bar for frame F. Add new buttons and remove old. */
4622 void
4623 update_frame_tool_bar (FRAME_PTR f)
4625 int i, j;
4626 struct x_output *x = f->output_data.x;
4627 int hmargin = 0, vmargin = 0;
4628 GtkToolbar *wtoolbar;
4629 GtkToolItem *ti;
4630 GtkTextDirection dir;
4631 int pack_tool_bar = x->handlebox_widget == NULL;
4632 Lisp_Object style;
4633 int text_image, horiz;
4634 struct xg_frame_tb_info *tbinfo;
4636 if (! FRAME_GTK_WIDGET (f))
4637 return;
4639 BLOCK_INPUT;
4641 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
4643 hmargin = XFASTINT (Vtool_bar_button_margin);
4644 vmargin = XFASTINT (Vtool_bar_button_margin);
4646 else if (CONSP (Vtool_bar_button_margin))
4648 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin), INT_MAX))
4649 hmargin = XFASTINT (XCAR (Vtool_bar_button_margin));
4651 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
4652 vmargin = XFASTINT (XCDR (Vtool_bar_button_margin));
4655 /* The natural size (i.e. when GTK uses 0 as margin) looks best,
4656 so take DEFAULT_TOOL_BAR_BUTTON_MARGIN to mean "default for GTK",
4657 i.e. zero. This means that margins less than
4658 DEFAULT_TOOL_BAR_BUTTON_MARGIN has no effect. */
4659 hmargin = max (0, hmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4660 vmargin = max (0, vmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4662 if (! x->toolbar_widget)
4663 xg_create_tool_bar (f);
4665 wtoolbar = GTK_TOOLBAR (x->toolbar_widget);
4666 dir = gtk_widget_get_direction (GTK_WIDGET (wtoolbar));
4668 style = Ftool_bar_get_system_style ();
4670 /* Are we up to date? */
4671 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4672 TB_INFO_KEY);
4674 if (! NILP (tbinfo->last_tool_bar) && ! NILP (f->tool_bar_items)
4675 && tbinfo->n_last_items == f->n_tool_bar_items
4676 && tbinfo->hmargin == hmargin && tbinfo->vmargin == vmargin
4677 && tbinfo->dir == dir
4678 && ! NILP (Fequal (tbinfo->style, style))
4679 && ! NILP (Fequal (tbinfo->last_tool_bar, f->tool_bar_items)))
4681 UNBLOCK_INPUT;
4682 return;
4685 tbinfo->last_tool_bar = f->tool_bar_items;
4686 tbinfo->n_last_items = f->n_tool_bar_items;
4687 tbinfo->style = style;
4688 tbinfo->hmargin = hmargin;
4689 tbinfo->vmargin = vmargin;
4690 tbinfo->dir = dir;
4692 text_image = EQ (style, Qtext_image_horiz);
4693 horiz = EQ (style, Qboth_horiz) || text_image;
4695 for (i = j = 0; i < f->n_tool_bar_items; ++i)
4697 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
4698 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
4699 int idx;
4700 ptrdiff_t img_id;
4701 int icon_size = 0;
4702 struct image *img = NULL;
4703 Lisp_Object image;
4704 Lisp_Object stock = Qnil;
4705 GtkStockItem stock_item;
4706 char *stock_name = NULL;
4707 char *icon_name = NULL;
4708 Lisp_Object rtl;
4709 GtkWidget *wbutton = NULL;
4710 Lisp_Object specified_file;
4711 int vert_only = ! NILP (PROP (TOOL_BAR_ITEM_VERT_ONLY));
4712 const char *label
4713 = (EQ (style, Qimage) || (vert_only && horiz)) ? NULL
4714 : STRINGP (PROP (TOOL_BAR_ITEM_LABEL))
4715 ? SSDATA (PROP (TOOL_BAR_ITEM_LABEL))
4716 : "";
4718 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4720 /* If this is a separator, use a gtk separator item. */
4721 if (EQ (PROP (TOOL_BAR_ITEM_TYPE), Qt))
4723 if (ti == NULL || !GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4725 if (ti)
4726 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4727 GTK_WIDGET (ti));
4728 ti = gtk_separator_tool_item_new ();
4729 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4731 j++;
4732 continue;
4735 /* Otherwise, the tool-bar item is an ordinary button. */
4737 if (ti && GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4739 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4740 ti = NULL;
4743 if (ti) wbutton = XG_BIN_CHILD (XG_BIN_CHILD (ti));
4745 /* Ignore invalid image specifications. */
4746 image = PROP (TOOL_BAR_ITEM_IMAGES);
4747 if (!valid_image_p (image))
4749 if (ti)
4750 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4751 GTK_WIDGET (ti));
4752 continue;
4755 specified_file = file_for_image (image);
4756 if (!NILP (specified_file) && !NILP (Ffboundp (Qx_gtk_map_stock)))
4757 stock = call1 (Qx_gtk_map_stock, specified_file);
4759 if (STRINGP (stock))
4761 stock_name = SSDATA (stock);
4762 if (stock_name[0] == 'n' && stock_name[1] == ':')
4764 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (wtoolbar));
4765 GtkIconTheme *icon_theme = gtk_icon_theme_get_for_screen (screen);
4767 icon_name = stock_name + 2;
4768 stock_name = NULL;
4769 stock = Qnil;
4771 if (! gtk_icon_theme_has_icon (icon_theme, icon_name))
4772 icon_name = NULL;
4773 else
4774 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4776 else if (gtk_stock_lookup (SSDATA (stock), &stock_item))
4777 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4778 else
4780 stock = Qnil;
4781 stock_name = NULL;
4785 if (stock_name == NULL && icon_name == NULL)
4787 /* No stock image, or stock item not known. Try regular
4788 image. If image is a vector, choose it according to the
4789 button state. */
4790 if (dir == GTK_TEXT_DIR_RTL
4791 && !NILP (rtl = PROP (TOOL_BAR_ITEM_RTL_IMAGE))
4792 && STRINGP (rtl))
4793 image = find_rtl_image (f, image, rtl);
4795 if (VECTORP (image))
4797 if (enabled_p)
4798 idx = (selected_p
4799 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
4800 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
4801 else
4802 idx = (selected_p
4803 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
4804 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
4806 eassert (ASIZE (image) >= idx);
4807 image = AREF (image, idx);
4809 else
4810 idx = -1;
4812 img_id = lookup_image (f, image);
4813 img = IMAGE_FROM_ID (f, img_id);
4814 prepare_image_for_display (f, img);
4816 if (img->load_failed_p || img->pixmap == None)
4818 if (ti)
4819 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4820 GTK_WIDGET (ti));
4821 continue;
4825 /* If there is an existing widget, check if it's stale; if so,
4826 remove it and make a new tool item from scratch. */
4827 if (ti && xg_tool_item_stale_p (wbutton, stock_name, icon_name,
4828 img, label, horiz))
4830 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4831 GTK_WIDGET (ti));
4832 ti = NULL;
4835 if (ti == NULL)
4837 GtkWidget *w;
4839 /* Save the image so we can see if an update is needed the
4840 next time we call xg_tool_item_match_p. */
4841 if (EQ (style, Qtext))
4842 w = NULL;
4843 else if (stock_name)
4845 w = gtk_image_new_from_stock (stock_name, icon_size);
4846 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_STOCK_NAME,
4847 (gpointer) xstrdup (stock_name),
4848 (GDestroyNotify) xfree);
4850 else if (icon_name)
4852 w = gtk_image_new_from_icon_name (icon_name, icon_size);
4853 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_ICON_NAME,
4854 (gpointer) xstrdup (icon_name),
4855 (GDestroyNotify) xfree);
4857 else
4859 w = xg_get_image_for_pixmap (f, img, x->widget, NULL);
4860 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
4861 (gpointer)img->pixmap);
4864 if (w) gtk_misc_set_padding (GTK_MISC (w), hmargin, vmargin);
4865 ti = xg_make_tool_item (f, w, &wbutton, label, i, horiz, text_image);
4866 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4869 #undef PROP
4871 gtk_widget_set_sensitive (wbutton, enabled_p);
4872 j++;
4875 /* Remove buttons not longer needed. */
4878 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4879 if (ti)
4880 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4881 } while (ti != NULL);
4883 if (f->n_tool_bar_items != 0)
4885 if (pack_tool_bar)
4886 xg_pack_tool_bar (f, f->tool_bar_position);
4887 gtk_widget_show_all (GTK_WIDGET (x->handlebox_widget));
4888 if (xg_update_tool_bar_sizes (f))
4889 xg_height_or_width_changed (f);
4892 UNBLOCK_INPUT;
4895 /* Deallocate all resources for the tool bar on frame F.
4896 Remove the tool bar. */
4898 void
4899 free_frame_tool_bar (FRAME_PTR f)
4901 struct x_output *x = f->output_data.x;
4903 if (x->toolbar_widget)
4905 struct xg_frame_tb_info *tbinfo;
4906 int is_packed = x->handlebox_widget != 0;
4907 BLOCK_INPUT;
4908 /* We may have created the toolbar_widget in xg_create_tool_bar, but
4909 not the x->handlebox_widget which is created in xg_pack_tool_bar. */
4910 if (is_packed)
4912 if (x->toolbar_in_hbox)
4913 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4914 x->handlebox_widget);
4915 else
4916 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4917 x->handlebox_widget);
4919 else
4920 gtk_widget_destroy (x->toolbar_widget);
4922 x->toolbar_widget = 0;
4923 x->handlebox_widget = 0;
4924 FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4925 FRAME_TOOLBAR_LEFT_WIDTH (f) = FRAME_TOOLBAR_RIGHT_WIDTH (f) = 0;
4927 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4928 TB_INFO_KEY);
4929 if (tbinfo)
4931 xfree (tbinfo);
4932 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4933 TB_INFO_KEY,
4934 NULL);
4937 xg_height_or_width_changed (f);
4939 UNBLOCK_INPUT;
4944 xg_change_toolbar_position (FRAME_PTR f, Lisp_Object pos)
4946 struct x_output *x = f->output_data.x;
4948 if (! x->toolbar_widget || ! x->handlebox_widget)
4949 return 1;
4951 BLOCK_INPUT;
4952 g_object_ref (x->handlebox_widget);
4953 if (x->toolbar_in_hbox)
4954 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4955 x->handlebox_widget);
4956 else
4957 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4958 x->handlebox_widget);
4959 xg_pack_tool_bar (f, pos);
4960 g_object_unref (x->handlebox_widget);
4961 if (xg_update_tool_bar_sizes (f))
4962 xg_height_or_width_changed (f);
4964 UNBLOCK_INPUT;
4965 return 1;
4970 /***********************************************************************
4971 Initializing
4972 ***********************************************************************/
4973 void
4974 xg_initialize (void)
4976 GtkBindingSet *binding_set;
4977 GtkSettings *settings;
4979 #if HAVE_XFT
4980 /* Work around a bug with corrupted data if libXft gets unloaded. This way
4981 we keep it permanently linked in. */
4982 XftInit (0);
4983 #endif
4985 gdpy_def = NULL;
4986 xg_ignore_gtk_scrollbar = 0;
4987 xg_detached_menus = 0;
4988 xg_menu_cb_list.prev = xg_menu_cb_list.next =
4989 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
4991 id_to_widget.max_size = id_to_widget.used = 0;
4992 id_to_widget.widgets = 0;
4994 settings = gtk_settings_get_for_screen (gdk_display_get_default_screen
4995 (gdk_display_get_default ()));
4996 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
4997 bindings. It doesn't seem to be any way to remove properties,
4998 so we set it to VoidSymbol which in X means "no key". */
4999 gtk_settings_set_string_property (settings,
5000 "gtk-menu-bar-accel",
5001 "VoidSymbol",
5002 EMACS_CLASS);
5004 /* Make GTK text input widgets use Emacs style keybindings. This is
5005 Emacs after all. */
5006 gtk_settings_set_string_property (settings,
5007 "gtk-key-theme-name",
5008 "Emacs",
5009 EMACS_CLASS);
5011 /* Make dialogs close on C-g. Since file dialog inherits from
5012 dialog, this works for them also. */
5013 binding_set = gtk_binding_set_by_class (g_type_class_ref (GTK_TYPE_DIALOG));
5014 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5015 "close", 0);
5017 /* Make menus close on C-g. */
5018 binding_set = gtk_binding_set_by_class (g_type_class_ref
5019 (GTK_TYPE_MENU_SHELL));
5020 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5021 "cancel", 0);
5022 update_theme_scrollbar_width ();
5024 x_last_font_name = NULL;
5027 #endif /* USE_GTK */