Reduce some cal-tex code duplication
[emacs.git] / src / gtkutil.c
blob2941605d4481465f0b79609c5373789bab860d55
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>
28 #include <c-ctype.h>
30 #include "lisp.h"
31 #include "xterm.h"
32 #include "blockinput.h"
33 #include "syssignal.h"
34 #include "window.h"
35 #include "gtkutil.h"
36 #include "termhooks.h"
37 #include "keyboard.h"
38 #include "charset.h"
39 #include "coding.h"
40 #include <gdk/gdkkeysyms.h>
41 #include "xsettings.h"
43 #ifdef HAVE_XFT
44 #include <X11/Xft/Xft.h>
45 #endif
47 #ifdef HAVE_GTK3
48 #include <gtk/gtkx.h>
49 #include "emacsgtkfixed.h"
50 #endif
52 #define FRAME_TOTAL_PIXEL_HEIGHT(f) \
53 (FRAME_PIXEL_HEIGHT (f) + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
55 #define FRAME_TOTAL_PIXEL_WIDTH(f) \
56 (FRAME_PIXEL_WIDTH (f) + FRAME_TOOLBAR_WIDTH (f))
58 #ifndef HAVE_GTK_WIDGET_SET_HAS_WINDOW
59 #define gtk_widget_set_has_window(w, b) \
60 (gtk_fixed_set_has_window (GTK_FIXED (w), b))
61 #endif
62 #ifndef HAVE_GTK_DIALOG_GET_ACTION_AREA
63 #define gtk_dialog_get_action_area(w) ((w)->action_area)
64 #define gtk_dialog_get_content_area(w) ((w)->vbox)
65 #endif
66 #ifndef HAVE_GTK_WIDGET_GET_SENSITIVE
67 #define gtk_widget_get_sensitive(w) (GTK_WIDGET_SENSITIVE (w))
68 #endif
69 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
70 #define gtk_adjustment_set_page_size(w, s) ((w)->page_size = (s))
71 #define gtk_adjustment_set_page_increment(w, s) ((w)->page_increment = (s))
72 #define gtk_adjustment_get_step_increment(w) ((w)->step_increment)
73 #define gtk_adjustment_set_step_increment(w, s) ((w)->step_increment = (s))
74 #endif
75 #if GTK_MAJOR_VERSION > 2 || GTK_MINOR_VERSION > 11
76 #define remove_submenu(w) gtk_menu_item_set_submenu ((w), NULL)
77 #else
78 #define remove_submenu(w) gtk_menu_item_remove_submenu ((w))
79 #endif
81 #if GTK_MAJOR_VERSION > 3 || (GTK_MAJOR_VERSION == 3 && GTK_MINOR_VERSION >= 2)
82 #define USE_NEW_GTK_FONT_CHOOSER 1
83 #else
84 #define USE_NEW_GTK_FONT_CHOOSER 0
85 #define gtk_font_chooser_dialog_new(x, y) \
86 gtk_font_selection_dialog_new (x)
87 #undef GTK_FONT_CHOOSER
88 #define GTK_FONT_CHOOSER(x) GTK_FONT_SELECTION_DIALOG (x)
89 #define gtk_font_chooser_set_font(x, y) \
90 gtk_font_selection_dialog_set_font_name (x, y)
91 #endif
93 #ifndef HAVE_GTK3
94 #ifdef USE_GTK_TOOLTIP
95 #define gdk_window_get_screen(w) gdk_drawable_get_screen (w)
96 #endif
97 #define gdk_window_get_geometry(w, a, b, c, d) \
98 gdk_window_get_geometry (w, a, b, c, d, 0)
99 #define gdk_x11_window_lookup_for_display(d, w) \
100 gdk_xid_table_lookup_for_display (d, w)
101 #define gtk_box_new(ori, spacing) \
102 ((ori) == GTK_ORIENTATION_HORIZONTAL \
103 ? gtk_hbox_new (FALSE, (spacing)) : gtk_vbox_new (FALSE, (spacing)))
104 #define gtk_scrollbar_new(ori, spacing) \
105 ((ori) == GTK_ORIENTATION_HORIZONTAL \
106 ? gtk_hscrollbar_new ((spacing)) : gtk_vscrollbar_new ((spacing)))
107 #ifndef GDK_KEY_g
108 #define GDK_KEY_g GDK_g
109 #endif
110 #endif /* HAVE_GTK3 */
112 #define XG_BIN_CHILD(x) gtk_bin_get_child (GTK_BIN (x))
114 static void update_theme_scrollbar_width (void);
116 #define TB_INFO_KEY "xg_frame_tb_info"
117 struct xg_frame_tb_info
119 Lisp_Object last_tool_bar;
120 Lisp_Object style;
121 int n_last_items;
122 int hmargin, vmargin;
123 GtkTextDirection dir;
127 /***********************************************************************
128 Display handling functions
129 ***********************************************************************/
131 /* Keep track of the default display, or NULL if there is none. Emacs
132 may close all its displays. */
134 static GdkDisplay *gdpy_def;
136 /* When the GTK widget W is to be created on a display for F that
137 is not the default display, set the display for W.
138 W can be a GtkMenu or a GtkWindow widget. */
140 static void
141 xg_set_screen (GtkWidget *w, FRAME_PTR f)
143 if (FRAME_X_DISPLAY (f) != DEFAULT_GDK_DISPLAY ())
145 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
146 GdkScreen *gscreen = gdk_display_get_default_screen (gdpy);
148 if (GTK_IS_MENU (w))
149 gtk_menu_set_screen (GTK_MENU (w), gscreen);
150 else
151 gtk_window_set_screen (GTK_WINDOW (w), gscreen);
156 /* Open a display named by DISPLAY_NAME. The display is returned in *DPY.
157 *DPY is set to NULL if the display can't be opened.
159 Returns non-zero if display could be opened, zero if display could not
160 be opened, and less than zero if the GTK version doesn't support
161 multiple displays. */
163 void
164 xg_display_open (char *display_name, Display **dpy)
166 GdkDisplay *gdpy;
168 gdpy = gdk_display_open (display_name);
169 if (!gdpy_def && gdpy)
171 gdpy_def = gdpy;
172 gdk_display_manager_set_default_display (gdk_display_manager_get (),
173 gdpy);
176 *dpy = gdpy ? GDK_DISPLAY_XDISPLAY (gdpy) : NULL;
180 /* Close display DPY. */
182 void
183 xg_display_close (Display *dpy)
185 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
187 /* If this is the default display, try to change it before closing.
188 If there is no other display to use, gdpy_def is set to NULL, and
189 the next call to xg_display_open resets the default display. */
190 if (gdk_display_get_default () == gdpy)
192 struct x_display_info *dpyinfo;
193 GdkDisplay *gdpy_new = NULL;
195 /* Find another display. */
196 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
197 if (dpyinfo->display != dpy)
199 gdpy_new = gdk_x11_lookup_xdisplay (dpyinfo->display);
200 gdk_display_manager_set_default_display (gdk_display_manager_get (),
201 gdpy_new);
202 break;
204 gdpy_def = gdpy_new;
207 #if GTK_MAJOR_VERSION == 2 && GTK_MINOR_VERSION < 10
208 /* GTK 2.2-2.8 has a bug that makes gdk_display_close crash (bug
209 http://bugzilla.gnome.org/show_bug.cgi?id=85715). This way we
210 can continue running, but there will be memory leaks. */
211 g_object_run_dispose (G_OBJECT (gdpy));
212 #else
213 /* This seems to be fixed in GTK 2.10. */
214 gdk_display_close (gdpy);
215 #endif
219 /***********************************************************************
220 Utility functions
221 ***********************************************************************/
222 /* The next two variables and functions are taken from lwlib. */
223 static widget_value *widget_value_free_list;
224 static int malloc_cpt;
226 /* Allocate a widget_value structure, either by taking one from the
227 widget_value_free_list or by malloc:ing a new one.
229 Return a pointer to the allocated structure. */
231 widget_value *
232 malloc_widget_value (void)
234 widget_value *wv;
235 if (widget_value_free_list)
237 wv = widget_value_free_list;
238 widget_value_free_list = wv->free_list;
239 wv->free_list = 0;
241 else
243 wv = xmalloc (sizeof *wv);
244 malloc_cpt++;
246 memset (wv, 0, sizeof (widget_value));
247 return wv;
250 /* This is analogous to free. It frees only what was allocated
251 by malloc_widget_value, and no substructures. */
253 void
254 free_widget_value (widget_value *wv)
256 if (wv->free_list)
257 abort ();
259 if (malloc_cpt > 25)
261 /* When the number of already allocated cells is too big,
262 We free it. */
263 xfree (wv);
264 malloc_cpt--;
266 else
268 wv->free_list = widget_value_free_list;
269 widget_value_free_list = wv;
274 /* Create and return the cursor to be used for popup menus and
275 scroll bars on display DPY. */
277 GdkCursor *
278 xg_create_default_cursor (Display *dpy)
280 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
281 return gdk_cursor_new_for_display (gdpy, GDK_LEFT_PTR);
284 static GdkPixbuf *
285 xg_get_pixbuf_from_pixmap (FRAME_PTR f, Pixmap pix)
287 int iunused;
288 GdkPixbuf *tmp_buf;
289 Window wunused;
290 unsigned int width, height, uunused;
291 XImage *xim;
293 XGetGeometry (FRAME_X_DISPLAY (f), pix, &wunused, &iunused, &iunused,
294 &width, &height, &uunused, &uunused);
296 xim = XGetImage (FRAME_X_DISPLAY (f), pix, 0, 0, width, height,
297 ~0, XYPixmap);
298 if (!xim) return 0;
300 tmp_buf = gdk_pixbuf_new_from_data ((guchar *) xim->data,
301 GDK_COLORSPACE_RGB,
302 FALSE,
303 xim->bitmap_unit,
304 width,
305 height,
306 xim->bytes_per_line,
307 NULL,
308 NULL);
309 XDestroyImage (xim);
310 return tmp_buf;
313 /* Apply GMASK to GPIX and return a GdkPixbuf with an alpha channel. */
315 static GdkPixbuf *
316 xg_get_pixbuf_from_pix_and_mask (FRAME_PTR f,
317 Pixmap pix,
318 Pixmap mask)
320 int width, height;
321 GdkPixbuf *icon_buf, *tmp_buf;
323 tmp_buf = xg_get_pixbuf_from_pixmap (f, pix);
324 icon_buf = gdk_pixbuf_add_alpha (tmp_buf, FALSE, 0, 0, 0);
325 g_object_unref (G_OBJECT (tmp_buf));
327 width = gdk_pixbuf_get_width (icon_buf);
328 height = gdk_pixbuf_get_height (icon_buf);
330 if (mask)
332 GdkPixbuf *mask_buf = xg_get_pixbuf_from_pixmap (f, mask);
333 guchar *pixels = gdk_pixbuf_get_pixels (icon_buf);
334 guchar *mask_pixels = gdk_pixbuf_get_pixels (mask_buf);
335 int rowstride = gdk_pixbuf_get_rowstride (icon_buf);
336 int mask_rowstride = gdk_pixbuf_get_rowstride (mask_buf);
337 int y;
339 for (y = 0; y < height; ++y)
341 guchar *iconptr, *maskptr;
342 int x;
344 iconptr = pixels + y * rowstride;
345 maskptr = mask_pixels + y * mask_rowstride;
347 for (x = 0; x < width; ++x)
349 /* In a bitmap, RGB is either 255/255/255 or 0/0/0. Checking
350 just R is sufficient. */
351 if (maskptr[0] == 0)
352 iconptr[3] = 0; /* 0, 1, 2 is R, G, B. 3 is alpha. */
354 iconptr += rowstride/width;
355 maskptr += mask_rowstride/width;
359 g_object_unref (G_OBJECT (mask_buf));
362 return icon_buf;
365 static Lisp_Object
366 file_for_image (Lisp_Object image)
368 Lisp_Object specified_file = Qnil;
369 Lisp_Object tail;
371 for (tail = XCDR (image);
372 NILP (specified_file) && CONSP (tail) && CONSP (XCDR (tail));
373 tail = XCDR (XCDR (tail)))
374 if (EQ (XCAR (tail), QCfile))
375 specified_file = XCAR (XCDR (tail));
377 return specified_file;
380 /* For the image defined in IMG, make and return a GtkImage. For displays with
381 8 planes or less we must make a GdkPixbuf and apply the mask manually.
382 Otherwise the highlighting and dimming the tool bar code in GTK does
383 will look bad. For display with more than 8 planes we just use the
384 pixmap and mask directly. For monochrome displays, GTK doesn't seem
385 able to use external pixmaps, it looks bad whatever we do.
386 The image is defined on the display where frame F is.
387 WIDGET is used to find the GdkColormap to use for the GdkPixbuf.
388 If OLD_WIDGET is NULL, a new widget is constructed and returned.
389 If OLD_WIDGET is not NULL, that widget is modified. */
391 static GtkWidget *
392 xg_get_image_for_pixmap (FRAME_PTR f,
393 struct image *img,
394 GtkWidget *widget,
395 GtkImage *old_widget)
397 GdkPixbuf *icon_buf;
399 /* If we have a file, let GTK do all the image handling.
400 This seems to be the only way to make insensitive and activated icons
401 look good in all cases. */
402 Lisp_Object specified_file = file_for_image (img->spec);
403 Lisp_Object file;
405 /* We already loaded the image once before calling this
406 function, so this only fails if the image file has been removed.
407 In that case, use the pixmap already loaded. */
409 if (STRINGP (specified_file)
410 && STRINGP (file = x_find_image_file (specified_file)))
412 if (! old_widget)
413 old_widget = GTK_IMAGE (gtk_image_new_from_file (SSDATA (file)));
414 else
415 gtk_image_set_from_file (old_widget, SSDATA (file));
417 return GTK_WIDGET (old_widget);
420 /* No file, do the image handling ourselves. This will look very bad
421 on a monochrome display, and sometimes bad on all displays with
422 certain themes. */
424 /* This is a workaround to make icons look good on pseudo color
425 displays. Apparently GTK expects the images to have an alpha
426 channel. If they don't, insensitive and activated icons will
427 look bad. This workaround does not work on monochrome displays,
428 and is strictly not needed on true color/static color displays (i.e.
429 16 bits and higher). But we do it anyway so we get a pixbuf that is
430 not associated with the img->pixmap. The img->pixmap may be removed
431 by clearing the image cache and then the tool bar redraw fails, since
432 Gtk+ assumes the pixmap is always there. */
433 icon_buf = xg_get_pixbuf_from_pix_and_mask (f, img->pixmap, img->mask);
435 if (icon_buf)
437 if (! old_widget)
438 old_widget = GTK_IMAGE (gtk_image_new_from_pixbuf (icon_buf));
439 else
440 gtk_image_set_from_pixbuf (old_widget, icon_buf);
442 g_object_unref (G_OBJECT (icon_buf));
445 return GTK_WIDGET (old_widget);
449 /* Set CURSOR on W and all widgets W contain. We must do like this
450 for scroll bars and menu because they create widgets internally,
451 and it is those widgets that are visible. */
453 static void
454 xg_set_cursor (GtkWidget *w, GdkCursor *cursor)
456 GdkWindow *window = gtk_widget_get_window (w);
457 GList *children = gdk_window_peek_children (window);
459 gdk_window_set_cursor (window, cursor);
461 /* The scroll bar widget has more than one GDK window (had to look at
462 the source to figure this out), and there is no way to set cursor
463 on widgets in GTK. So we must set the cursor for all GDK windows.
464 Ditto for menus. */
466 for ( ; children; children = g_list_next (children))
467 gdk_window_set_cursor (GDK_WINDOW (children->data), cursor);
470 /* Insert NODE into linked LIST. */
472 static void
473 xg_list_insert (xg_list_node *list, xg_list_node *node)
475 xg_list_node *list_start = list->next;
477 if (list_start) list_start->prev = node;
478 node->next = list_start;
479 node->prev = 0;
480 list->next = node;
483 /* Remove NODE from linked LIST. */
485 static void
486 xg_list_remove (xg_list_node *list, xg_list_node *node)
488 xg_list_node *list_start = list->next;
489 if (node == list_start)
491 list->next = node->next;
492 if (list->next) list->next->prev = 0;
494 else
496 node->prev->next = node->next;
497 if (node->next) node->next->prev = node->prev;
501 /* Allocate and return a utf8 version of STR. If STR is already
502 utf8 or NULL, just return a copy of STR.
503 A new string is allocated and the caller must free the result
504 with g_free. */
506 static char *
507 get_utf8_string (const char *str)
509 char *utf8_str;
511 if (!str) return NULL;
513 /* If not UTF-8, try current locale. */
514 if (!g_utf8_validate (str, -1, NULL))
515 utf8_str = g_locale_to_utf8 (str, -1, 0, 0, 0);
516 else
517 return g_strdup (str);
519 if (!utf8_str)
521 /* Probably some control characters in str. Escape them. */
522 ptrdiff_t len;
523 ptrdiff_t nr_bad = 0;
524 gsize bytes_read;
525 gsize bytes_written;
526 unsigned char *p = (unsigned char *)str;
527 char *cp, *up;
528 GError *err = NULL;
530 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
531 &bytes_written, &err))
532 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
534 ++nr_bad;
535 p += bytes_written+1;
536 g_error_free (err);
537 err = NULL;
540 if (err)
542 g_error_free (err);
543 err = NULL;
545 if (cp) g_free (cp);
547 len = strlen (str);
548 if ((min (PTRDIFF_MAX, SIZE_MAX) - len - 1) / 4 < nr_bad)
549 memory_full (SIZE_MAX);
550 up = utf8_str = xmalloc (len + nr_bad * 4 + 1);
551 p = (unsigned char *)str;
553 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
554 &bytes_written, &err))
555 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
557 memcpy (up, p, bytes_written);
558 sprintf (up + bytes_written, "\\%03o", p[bytes_written]);
559 up += bytes_written+4;
560 p += bytes_written+1;
561 g_error_free (err);
562 err = NULL;
565 if (cp)
567 strcat (utf8_str, cp);
568 g_free (cp);
570 if (err)
572 g_error_free (err);
573 err = NULL;
576 return utf8_str;
579 /* Check for special colors used in face spec for region face.
580 The colors are fetched from the Gtk+ theme.
581 Return 1 if color was found, 0 if not. */
584 xg_check_special_colors (struct frame *f,
585 const char *color_name,
586 XColor *color)
588 int success_p = 0;
589 int get_bg = strcmp ("gtk_selection_bg_color", color_name) == 0;
590 int get_fg = !get_bg && strcmp ("gtk_selection_fg_color", color_name) == 0;
592 if (! FRAME_GTK_WIDGET (f) || ! (get_bg || get_fg))
593 return success_p;
595 BLOCK_INPUT;
597 #ifdef HAVE_GTK3
598 GtkStyleContext *gsty
599 = gtk_widget_get_style_context (FRAME_GTK_OUTER_WIDGET (f));
600 GdkRGBA col;
601 char buf[sizeof "rgbi://" + 3 * (DBL_MAX_10_EXP + sizeof "-1.000000" - 1)];
602 int state = GTK_STATE_FLAG_SELECTED|GTK_STATE_FLAG_FOCUSED;
603 if (get_fg)
604 gtk_style_context_get_color (gsty, state, &col);
605 else
606 gtk_style_context_get_background_color (gsty, state, &col);
608 sprintf (buf, "rgbi:%lf/%lf/%lf", col.red, col.green, col.blue);
609 success_p = XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
610 buf, color);
611 #else
612 GtkStyle *gsty = gtk_widget_get_style (FRAME_GTK_WIDGET (f));
613 GdkColor *grgb = get_bg
614 ? &gsty->bg[GTK_STATE_SELECTED]
615 : &gsty->fg[GTK_STATE_SELECTED];
617 color->red = grgb->red;
618 color->green = grgb->green;
619 color->blue = grgb->blue;
620 color->pixel = grgb->pixel;
621 success_p = 1;
622 #endif
625 UNBLOCK_INPUT;
626 return success_p;
631 /***********************************************************************
632 Tooltips
633 ***********************************************************************/
634 /* Gtk+ calls this callback when the parent of our tooltip dummy changes.
635 We use that to pop down the tooltip. This happens if Gtk+ for some
636 reason wants to change or hide the tooltip. */
638 #ifdef USE_GTK_TOOLTIP
640 static void
641 hierarchy_ch_cb (GtkWidget *widget,
642 GtkWidget *previous_toplevel,
643 gpointer user_data)
645 FRAME_PTR f = (FRAME_PTR) user_data;
646 struct x_output *x = f->output_data.x;
647 GtkWidget *top = gtk_widget_get_toplevel (x->ttip_lbl);
649 if (! top || ! GTK_IS_WINDOW (top))
650 gtk_widget_hide (previous_toplevel);
653 /* Callback called when Gtk+ thinks a tooltip should be displayed.
654 We use it to get the tooltip window and the tooltip widget so
655 we can manipulate the ourselves.
657 Return FALSE ensures that the tooltip is not shown. */
659 static gboolean
660 qttip_cb (GtkWidget *widget,
661 gint xpos,
662 gint ypos,
663 gboolean keyboard_mode,
664 GtkTooltip *tooltip,
665 gpointer user_data)
667 FRAME_PTR f = (FRAME_PTR) user_data;
668 struct x_output *x = f->output_data.x;
669 if (x->ttip_widget == NULL)
671 GtkWidget *p;
672 GList *list, *iter;
674 g_object_set (G_OBJECT (widget), "has-tooltip", FALSE, NULL);
675 x->ttip_widget = tooltip;
676 g_object_ref (G_OBJECT (tooltip));
677 x->ttip_lbl = gtk_label_new ("");
678 g_object_ref (G_OBJECT (x->ttip_lbl));
679 gtk_tooltip_set_custom (tooltip, x->ttip_lbl);
680 x->ttip_window = GTK_WINDOW (gtk_widget_get_toplevel (x->ttip_lbl));
682 /* Change stupid Gtk+ default line wrapping. */
683 p = gtk_widget_get_parent (x->ttip_lbl);
684 list = gtk_container_get_children (GTK_CONTAINER (p));
685 for (iter = list; iter; iter = g_list_next (iter))
687 GtkWidget *w = GTK_WIDGET (iter->data);
688 if (GTK_IS_LABEL (w))
689 gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
691 g_list_free (list);
693 /* ATK needs an empty title for some reason. */
694 gtk_window_set_title (x->ttip_window, "");
695 /* Realize so we can safely get screen later on. */
696 gtk_widget_realize (GTK_WIDGET (x->ttip_window));
697 gtk_widget_realize (x->ttip_lbl);
699 g_signal_connect (x->ttip_lbl, "hierarchy-changed",
700 G_CALLBACK (hierarchy_ch_cb), f);
702 return FALSE;
705 #endif /* USE_GTK_TOOLTIP */
707 /* Prepare a tooltip to be shown, i.e. calculate WIDTH and HEIGHT.
708 Return zero if no system tooltip available, non-zero otherwise. */
711 xg_prepare_tooltip (FRAME_PTR f,
712 Lisp_Object string,
713 int *width,
714 int *height)
716 #ifndef USE_GTK_TOOLTIP
717 return 0;
718 #else
719 struct x_output *x = f->output_data.x;
720 GtkWidget *widget;
721 GdkWindow *gwin;
722 GdkScreen *screen;
723 GtkSettings *settings;
724 gboolean tt_enabled = TRUE;
725 GtkRequisition req;
726 Lisp_Object encoded_string;
728 if (!x->ttip_lbl) return 0;
730 BLOCK_INPUT;
731 encoded_string = ENCODE_UTF_8 (string);
732 widget = GTK_WIDGET (x->ttip_lbl);
733 gwin = gtk_widget_get_window (GTK_WIDGET (x->ttip_window));
734 screen = gdk_window_get_screen (gwin);
735 settings = gtk_settings_get_for_screen (screen);
736 g_object_get (settings, "gtk-enable-tooltips", &tt_enabled, NULL);
737 if (tt_enabled)
739 g_object_set (settings, "gtk-enable-tooltips", FALSE, NULL);
740 /* Record that we disabled it so it can be enabled again. */
741 g_object_set_data (G_OBJECT (x->ttip_window), "restore-tt",
742 (gpointer)f);
745 /* Prevent Gtk+ from hiding tooltip on mouse move and such. */
746 g_object_set_data (G_OBJECT
747 (gtk_widget_get_display (GTK_WIDGET (x->ttip_window))),
748 "gdk-display-current-tooltip", NULL);
750 /* Put our dummy widget in so we can get callbacks for unrealize and
751 hierarchy-changed. */
752 gtk_tooltip_set_custom (x->ttip_widget, widget);
753 gtk_tooltip_set_text (x->ttip_widget, SSDATA (encoded_string));
754 gtk_widget_get_preferred_size (GTK_WIDGET (x->ttip_window), NULL, &req);
755 if (width) *width = req.width;
756 if (height) *height = req.height;
758 UNBLOCK_INPUT;
760 return 1;
761 #endif /* USE_GTK_TOOLTIP */
764 /* Show the tooltip at ROOT_X and ROOT_Y.
765 xg_prepare_tooltip must have been called before this function. */
767 void
768 xg_show_tooltip (FRAME_PTR f, int root_x, int root_y)
770 #ifdef USE_GTK_TOOLTIP
771 struct x_output *x = f->output_data.x;
772 if (x->ttip_window)
774 BLOCK_INPUT;
775 gtk_window_move (x->ttip_window, root_x, root_y);
776 gtk_widget_show_all (GTK_WIDGET (x->ttip_window));
777 UNBLOCK_INPUT;
779 #endif
782 /* Hide tooltip if shown. Do nothing if not shown.
783 Return non-zero if tip was hidden, non-zero if not (i.e. not using
784 system tooltips). */
787 xg_hide_tooltip (FRAME_PTR f)
789 int ret = 0;
790 #ifdef USE_GTK_TOOLTIP
791 if (f->output_data.x->ttip_window)
793 GtkWindow *win = f->output_data.x->ttip_window;
794 BLOCK_INPUT;
795 gtk_widget_hide (GTK_WIDGET (win));
797 if (g_object_get_data (G_OBJECT (win), "restore-tt"))
799 GdkWindow *gwin = gtk_widget_get_window (GTK_WIDGET (win));
800 GdkScreen *screen = gdk_window_get_screen (gwin);
801 GtkSettings *settings = gtk_settings_get_for_screen (screen);
802 g_object_set (settings, "gtk-enable-tooltips", TRUE, NULL);
804 UNBLOCK_INPUT;
806 ret = 1;
808 #endif
809 return ret;
813 /***********************************************************************
814 General functions for creating widgets, resizing, events, e.t.c.
815 ***********************************************************************/
817 /* Make a geometry string and pass that to GTK. It seems this is the
818 only way to get geometry position right if the user explicitly
819 asked for a position when starting Emacs.
820 F is the frame we shall set geometry for. */
822 static void
823 xg_set_geometry (FRAME_PTR f)
825 if (f->size_hint_flags & (USPosition | PPosition))
827 int left = f->left_pos;
828 int xneg = f->size_hint_flags & XNegative;
829 int top = f->top_pos;
830 int yneg = f->size_hint_flags & YNegative;
831 char geom_str[sizeof "=x--" + 4 * INT_STRLEN_BOUND (int)];
833 if (xneg)
834 left = -left;
835 if (yneg)
836 top = -top;
838 sprintf (geom_str, "=%dx%d%c%d%c%d",
839 FRAME_PIXEL_WIDTH (f),
840 FRAME_PIXEL_HEIGHT (f),
841 (xneg ? '-' : '+'), left,
842 (yneg ? '-' : '+'), top);
844 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
845 geom_str))
846 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
850 /* Clear under internal border if any. As we use a mix of Gtk+ and X calls
851 and use a GtkFixed widget, this doesn't happen automatically. */
853 static void
854 xg_clear_under_internal_border (FRAME_PTR f)
856 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
858 GtkWidget *wfixed = f->output_data.x->edit_widget;
859 gtk_widget_queue_draw (wfixed);
860 gdk_window_process_all_updates ();
861 x_clear_area (FRAME_X_DISPLAY (f),
862 FRAME_X_WINDOW (f),
863 0, 0,
864 FRAME_PIXEL_WIDTH (f),
865 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
866 x_clear_area (FRAME_X_DISPLAY (f),
867 FRAME_X_WINDOW (f),
868 0, 0,
869 FRAME_INTERNAL_BORDER_WIDTH (f),
870 FRAME_PIXEL_HEIGHT (f), 0);
871 x_clear_area (FRAME_X_DISPLAY (f),
872 FRAME_X_WINDOW (f),
873 0, FRAME_PIXEL_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
874 FRAME_PIXEL_WIDTH (f),
875 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
876 x_clear_area (FRAME_X_DISPLAY (f),
877 FRAME_X_WINDOW (f),
878 FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
880 FRAME_INTERNAL_BORDER_WIDTH (f),
881 FRAME_PIXEL_HEIGHT (f), 0);
885 /* Function to handle resize of our frame. As we have a Gtk+ tool bar
886 and a Gtk+ menu bar, we get resize events for the edit part of the
887 frame only. We let Gtk+ deal with the Gtk+ parts.
888 F is the frame to resize.
889 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
891 void
892 xg_frame_resized (FRAME_PTR f, int pixelwidth, int pixelheight)
894 int rows, columns;
896 if (pixelwidth == -1 && pixelheight == -1)
898 if (FRAME_GTK_WIDGET (f) && gtk_widget_get_mapped (FRAME_GTK_WIDGET (f)))
899 gdk_window_get_geometry (gtk_widget_get_window (FRAME_GTK_WIDGET (f)),
900 0, 0,
901 &pixelwidth, &pixelheight);
902 else return;
906 rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelheight);
907 columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pixelwidth);
909 if (columns != FRAME_COLS (f)
910 || rows != FRAME_LINES (f)
911 || pixelwidth != FRAME_PIXEL_WIDTH (f)
912 || pixelheight != FRAME_PIXEL_HEIGHT (f))
914 FRAME_PIXEL_WIDTH (f) = pixelwidth;
915 FRAME_PIXEL_HEIGHT (f) = pixelheight;
917 xg_clear_under_internal_border (f);
918 change_frame_size (f, rows, columns, 0, 1, 0);
919 SET_FRAME_GARBAGED (f);
920 cancel_mouse_face (f);
924 /* Resize the outer window of frame F after changing the height.
925 COLUMNS/ROWS is the size the edit area shall have after the resize. */
927 void
928 xg_frame_set_char_size (FRAME_PTR f, int cols, int rows)
930 int pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
931 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
932 int pixelwidth;
934 if (FRAME_PIXEL_HEIGHT (f) == 0)
935 return;
937 /* Take into account the size of the scroll bar. Always use the
938 number of columns occupied by the scroll bar here otherwise we
939 might end up with a frame width that is not a multiple of the
940 frame's character width which is bad for vertically split
941 windows. */
942 f->scroll_bar_actual_width
943 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
945 compute_fringe_widths (f, 0);
947 /* FRAME_TEXT_COLS_TO_PIXEL_WIDTH uses scroll_bar_actual_width, so call it
948 after calculating that value. */
949 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
950 + FRAME_TOOLBAR_WIDTH (f);
953 /* Do this before resize, as we don't know yet if we will be resized. */
954 xg_clear_under_internal_border (f);
956 /* Must resize our top level widget. Font size may have changed,
957 but not rows/cols. */
958 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
959 pixelwidth, pixelheight);
960 x_wm_set_size_hint (f, 0, 0);
962 SET_FRAME_GARBAGED (f);
963 cancel_mouse_face (f);
965 /* We can not call change_frame_size for a mapped frame,
966 we can not set pixel width/height either. The window manager may
967 override our resize request, XMonad does this all the time.
968 The best we can do is try to sync, so lisp code sees the updated
969 size as fast as possible.
970 For unmapped windows, we can set rows/cols. When
971 the frame is mapped again we will (hopefully) get the correct size. */
972 if (f->async_visible)
974 /* Must call this to flush out events */
975 (void)gtk_events_pending ();
976 gdk_flush ();
977 x_wait_for_event (f, ConfigureNotify);
979 else
981 change_frame_size (f, rows, cols, 0, 1, 0);
982 FRAME_PIXEL_WIDTH (f) = pixelwidth;
983 FRAME_PIXEL_HEIGHT (f) = pixelheight;
987 /* Handle height/width changes (i.e. add/remove/move menu/toolbar).
988 The policy is to keep the number of editable lines. */
990 static void
991 xg_height_or_width_changed (FRAME_PTR f)
993 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
994 FRAME_TOTAL_PIXEL_WIDTH (f),
995 FRAME_TOTAL_PIXEL_HEIGHT (f));
996 f->output_data.x->hint_flags = 0;
997 x_wm_set_size_hint (f, 0, 0);
1000 /* Convert an X Window WSESC on display DPY to its corresponding GtkWidget.
1001 Must be done like this, because GtkWidget:s can have "hidden"
1002 X Window that aren't accessible.
1004 Return 0 if no widget match WDESC. */
1006 GtkWidget *
1007 xg_win_to_widget (Display *dpy, Window wdesc)
1009 gpointer gdkwin;
1010 GtkWidget *gwdesc = 0;
1012 BLOCK_INPUT;
1014 gdkwin = gdk_x11_window_lookup_for_display (gdk_x11_lookup_xdisplay (dpy),
1015 wdesc);
1016 if (gdkwin)
1018 GdkEvent event;
1019 event.any.window = gdkwin;
1020 event.any.type = GDK_NOTHING;
1021 gwdesc = gtk_get_event_widget (&event);
1024 UNBLOCK_INPUT;
1025 return gwdesc;
1028 /* Set the background of widget W to PIXEL. */
1030 static void
1031 xg_set_widget_bg (FRAME_PTR f, GtkWidget *w, long unsigned int pixel)
1033 #ifdef HAVE_GTK3
1034 GdkRGBA bg;
1035 XColor xbg;
1036 xbg.pixel = pixel;
1037 if (XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &xbg))
1039 bg.red = (double)xbg.red/65536.0;
1040 bg.green = (double)xbg.green/65536.0;
1041 bg.blue = (double)xbg.blue/65536.0;
1042 bg.alpha = 1.0;
1043 gtk_widget_override_background_color (w, GTK_STATE_FLAG_NORMAL, &bg);
1045 #else
1046 GdkColor bg;
1047 GdkColormap *map = gtk_widget_get_colormap (w);
1048 gdk_colormap_query_color (map, pixel, &bg);
1049 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &bg);
1050 #endif
1053 /* Callback called when the gtk theme changes.
1054 We notify lisp code so it can fix faces used for region for example. */
1056 static void
1057 style_changed_cb (GObject *go,
1058 GParamSpec *spec,
1059 gpointer user_data)
1061 struct input_event event;
1062 GdkDisplay *gdpy = (GdkDisplay *) user_data;
1063 const char *display_name = gdk_display_get_name (gdpy);
1064 Display *dpy = GDK_DISPLAY_XDISPLAY (gdpy);
1066 EVENT_INIT (event);
1067 event.kind = CONFIG_CHANGED_EVENT;
1068 event.frame_or_window = build_string (display_name);
1069 /* Theme doesn't change often, so intern is called seldom. */
1070 event.arg = intern ("theme-name");
1071 kbd_buffer_store_event (&event);
1073 update_theme_scrollbar_width ();
1075 /* If scroll bar width changed, we need set the new size on all frames
1076 on this display. */
1077 if (dpy)
1079 Lisp_Object rest, frame;
1080 FOR_EACH_FRAME (rest, frame)
1082 FRAME_PTR f = XFRAME (frame);
1083 if (FRAME_X_DISPLAY (f) == dpy)
1085 x_set_scroll_bar_default_width (f);
1086 xg_frame_set_char_size (f, FRAME_COLS (f), FRAME_LINES (f));
1092 /* Called when a delete-event occurs on WIDGET. */
1094 static gboolean
1095 delete_cb (GtkWidget *widget,
1096 GdkEvent *event,
1097 gpointer user_data)
1099 #ifdef HAVE_GTK3
1100 /* The event doesn't arrive in the normal event loop. Send event
1101 here. */
1102 FRAME_PTR f = (FRAME_PTR) user_data;
1103 struct input_event ie;
1105 EVENT_INIT (ie);
1106 ie.kind = DELETE_WINDOW_EVENT;
1107 XSETFRAME (ie.frame_or_window, f);
1108 kbd_buffer_store_event (&ie);
1109 #endif
1111 return TRUE;
1114 /* Create and set up the GTK widgets for frame F.
1115 Return 0 if creation failed, non-zero otherwise. */
1118 xg_create_frame_widgets (FRAME_PTR f)
1120 GtkWidget *wtop;
1121 GtkWidget *wvbox, *whbox;
1122 GtkWidget *wfixed;
1123 #ifndef HAVE_GTK3
1124 GtkRcStyle *style;
1125 #endif
1126 char *title = 0;
1128 BLOCK_INPUT;
1130 if (FRAME_X_EMBEDDED_P (f))
1132 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
1133 wtop = gtk_plug_new_for_display (gdpy, f->output_data.x->parent_desc);
1135 else
1136 wtop = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1138 /* gtk_window_set_has_resize_grip is a Gtk+ 3.0 function but Ubuntu
1139 has backported it to Gtk+ 2.0 and they add the resize grip for
1140 Gtk+ 2.0 applications also. But it has a bug that makes Emacs loop
1141 forever, so disable the grip. */
1142 #if GTK_MAJOR_VERSION < 3 && defined (HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP)
1143 gtk_window_set_has_resize_grip (GTK_WINDOW (wtop), FALSE);
1144 #endif
1146 xg_set_screen (wtop, f);
1148 wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1149 whbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1150 gtk_box_set_homogeneous (GTK_BOX (wvbox), FALSE);
1151 gtk_box_set_homogeneous (GTK_BOX (whbox), FALSE);
1153 #ifdef HAVE_GTK3
1154 wfixed = emacs_fixed_new (f);
1155 #else
1156 wfixed = gtk_fixed_new ();
1157 #endif
1159 if (! wtop || ! wvbox || ! whbox || ! wfixed)
1161 if (wtop) gtk_widget_destroy (wtop);
1162 if (wvbox) gtk_widget_destroy (wvbox);
1163 if (whbox) gtk_widget_destroy (whbox);
1164 if (wfixed) gtk_widget_destroy (wfixed);
1166 UNBLOCK_INPUT;
1167 return 0;
1170 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
1171 gtk_widget_set_name (wtop, EMACS_CLASS);
1172 gtk_widget_set_name (wvbox, "pane");
1173 gtk_widget_set_name (wfixed, SSDATA (Vx_resource_name));
1175 /* If this frame has a title or name, set it in the title bar. */
1176 if (! NILP (f->title))
1177 title = SSDATA (ENCODE_UTF_8 (f->title));
1178 else if (! NILP (f->name))
1179 title = SSDATA (ENCODE_UTF_8 (f->name));
1181 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
1183 FRAME_GTK_OUTER_WIDGET (f) = wtop;
1184 FRAME_GTK_WIDGET (f) = wfixed;
1185 f->output_data.x->vbox_widget = wvbox;
1186 f->output_data.x->hbox_widget = whbox;
1188 gtk_widget_set_has_window (wfixed, TRUE);
1190 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
1191 gtk_box_pack_start (GTK_BOX (wvbox), whbox, TRUE, TRUE, 0);
1192 gtk_box_pack_start (GTK_BOX (whbox), wfixed, TRUE, TRUE, 0);
1194 if (FRAME_EXTERNAL_TOOL_BAR (f))
1195 update_frame_tool_bar (f);
1197 /* We don't want this widget double buffered, because we draw on it
1198 with regular X drawing primitives, so from a GTK/GDK point of
1199 view, the widget is totally blank. When an expose comes, this
1200 will make the widget blank, and then Emacs redraws it. This flickers
1201 a lot, so we turn off double buffering. */
1202 gtk_widget_set_double_buffered (wfixed, FALSE);
1204 gtk_window_set_wmclass (GTK_WINDOW (wtop),
1205 SSDATA (Vx_resource_name),
1206 SSDATA (Vx_resource_class));
1208 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
1209 GTK is to destroy the widget. We want Emacs to do that instead. */
1210 g_signal_connect (G_OBJECT (wtop), "delete-event",
1211 G_CALLBACK (delete_cb), f);
1213 /* Convert our geometry parameters into a geometry string
1214 and specify it.
1215 GTK will itself handle calculating the real position this way. */
1216 xg_set_geometry (f);
1217 f->win_gravity
1218 = gtk_window_get_gravity (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1220 gtk_widget_add_events (wfixed,
1221 GDK_POINTER_MOTION_MASK
1222 | GDK_EXPOSURE_MASK
1223 | GDK_BUTTON_PRESS_MASK
1224 | GDK_BUTTON_RELEASE_MASK
1225 | GDK_KEY_PRESS_MASK
1226 | GDK_ENTER_NOTIFY_MASK
1227 | GDK_LEAVE_NOTIFY_MASK
1228 | GDK_FOCUS_CHANGE_MASK
1229 | GDK_STRUCTURE_MASK
1230 | GDK_VISIBILITY_NOTIFY_MASK);
1232 /* Must realize the windows so the X window gets created. It is used
1233 by callers of this function. */
1234 gtk_widget_realize (wfixed);
1235 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
1237 /* Since GTK clears its window by filling with the background color,
1238 we must keep X and GTK background in sync. */
1239 xg_set_widget_bg (f, wfixed, FRAME_BACKGROUND_PIXEL (f));
1241 #ifndef HAVE_GTK3
1242 /* Also, do not let any background pixmap to be set, this looks very
1243 bad as Emacs overwrites the background pixmap with its own idea
1244 of background color. */
1245 style = gtk_widget_get_modifier_style (wfixed);
1247 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
1248 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
1249 gtk_widget_modify_style (wfixed, style);
1250 #else
1251 gtk_widget_set_can_focus (wfixed, TRUE);
1252 gtk_window_set_resizable (GTK_WINDOW (wtop), TRUE);
1253 #endif
1255 #ifdef USE_GTK_TOOLTIP
1256 /* Steal a tool tip window we can move ourselves. */
1257 f->output_data.x->ttip_widget = 0;
1258 f->output_data.x->ttip_lbl = 0;
1259 f->output_data.x->ttip_window = 0;
1260 gtk_widget_set_tooltip_text (wtop, "Dummy text");
1261 g_signal_connect (wtop, "query-tooltip", G_CALLBACK (qttip_cb), f);
1262 #endif
1265 GdkScreen *screen = gtk_widget_get_screen (wtop);
1266 GtkSettings *gs = gtk_settings_get_for_screen (screen);
1267 /* Only connect this signal once per screen. */
1268 if (! g_signal_handler_find (G_OBJECT (gs),
1269 G_SIGNAL_MATCH_FUNC,
1270 0, 0, 0,
1271 G_CALLBACK (style_changed_cb),
1274 g_signal_connect (G_OBJECT (gs), "notify::gtk-theme-name",
1275 G_CALLBACK (style_changed_cb),
1276 gdk_screen_get_display (screen));
1280 UNBLOCK_INPUT;
1282 return 1;
1285 void
1286 xg_free_frame_widgets (FRAME_PTR f)
1288 if (FRAME_GTK_OUTER_WIDGET (f))
1290 #ifdef USE_GTK_TOOLTIP
1291 struct x_output *x = f->output_data.x;
1292 #endif
1293 struct xg_frame_tb_info *tbinfo
1294 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
1295 TB_INFO_KEY);
1296 if (tbinfo)
1297 xfree (tbinfo);
1299 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
1300 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow in xterm.c */
1301 FRAME_GTK_OUTER_WIDGET (f) = 0;
1302 #ifdef USE_GTK_TOOLTIP
1303 if (x->ttip_lbl)
1304 gtk_widget_destroy (x->ttip_lbl);
1305 if (x->ttip_widget)
1306 g_object_unref (G_OBJECT (x->ttip_widget));
1307 #endif
1311 /* Set the normal size hints for the window manager, for frame F.
1312 FLAGS is the flags word to use--or 0 meaning preserve the flags
1313 that the window now has.
1314 If USER_POSITION is nonzero, we set the User Position
1315 flag (this is useful when FLAGS is 0). */
1317 void
1318 x_wm_set_size_hint (FRAME_PTR f, long int flags, int user_position)
1320 /* Must use GTK routines here, otherwise GTK resets the size hints
1321 to its own defaults. */
1322 GdkGeometry size_hints;
1323 gint hint_flags = 0;
1324 int base_width, base_height;
1325 int min_rows = 0, min_cols = 0;
1326 int win_gravity = f->win_gravity;
1328 /* Don't set size hints during initialization; that apparently leads
1329 to a race condition. See the thread at
1330 http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00033.html */
1331 if (NILP (Vafter_init_time) || !FRAME_GTK_OUTER_WIDGET (f))
1332 return;
1334 if (flags)
1336 memset (&size_hints, 0, sizeof (size_hints));
1337 f->output_data.x->size_hints = size_hints;
1338 f->output_data.x->hint_flags = hint_flags;
1340 else
1341 flags = f->size_hint_flags;
1343 size_hints = f->output_data.x->size_hints;
1344 hint_flags = f->output_data.x->hint_flags;
1346 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
1347 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
1348 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
1350 hint_flags |= GDK_HINT_BASE_SIZE;
1351 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0) + FRAME_TOOLBAR_WIDTH (f);
1352 /* Use one row here so base_height does not become zero.
1353 Gtk+ and/or Unity on Ubuntu 12.04 can't handle it. */
1354 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 1)
1355 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
1357 check_frame_size (f, &min_rows, &min_cols);
1358 if (min_rows > 0) --min_rows; /* We used one row in base_height = ... 1); */
1360 size_hints.base_width = base_width;
1361 size_hints.base_height = base_height;
1362 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
1363 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
1365 /* These currently have a one to one mapping with the X values, but I
1366 don't think we should rely on that. */
1367 hint_flags |= GDK_HINT_WIN_GRAVITY;
1368 size_hints.win_gravity = 0;
1369 if (win_gravity == NorthWestGravity)
1370 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
1371 else if (win_gravity == NorthGravity)
1372 size_hints.win_gravity = GDK_GRAVITY_NORTH;
1373 else if (win_gravity == NorthEastGravity)
1374 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
1375 else if (win_gravity == WestGravity)
1376 size_hints.win_gravity = GDK_GRAVITY_WEST;
1377 else if (win_gravity == CenterGravity)
1378 size_hints.win_gravity = GDK_GRAVITY_CENTER;
1379 else if (win_gravity == EastGravity)
1380 size_hints.win_gravity = GDK_GRAVITY_EAST;
1381 else if (win_gravity == SouthWestGravity)
1382 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
1383 else if (win_gravity == SouthGravity)
1384 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
1385 else if (win_gravity == SouthEastGravity)
1386 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
1387 else if (win_gravity == StaticGravity)
1388 size_hints.win_gravity = GDK_GRAVITY_STATIC;
1390 if (user_position)
1392 hint_flags &= ~GDK_HINT_POS;
1393 hint_flags |= GDK_HINT_USER_POS;
1396 if (hint_flags != f->output_data.x->hint_flags
1397 || memcmp (&size_hints,
1398 &f->output_data.x->size_hints,
1399 sizeof (size_hints)) != 0)
1401 BLOCK_INPUT;
1402 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1403 NULL, &size_hints, hint_flags);
1404 f->output_data.x->size_hints = size_hints;
1405 f->output_data.x->hint_flags = hint_flags;
1406 UNBLOCK_INPUT;
1410 /* Change background color of a frame.
1411 Since GTK uses the background color to clear the window, we must
1412 keep the GTK and X colors in sync.
1413 F is the frame to change,
1414 BG is the pixel value to change to. */
1416 void
1417 xg_set_background_color (FRAME_PTR f, long unsigned int bg)
1419 if (FRAME_GTK_WIDGET (f))
1421 BLOCK_INPUT;
1422 xg_set_widget_bg (f, FRAME_GTK_WIDGET (f), FRAME_BACKGROUND_PIXEL (f));
1423 UNBLOCK_INPUT;
1428 /* Set the frame icon to ICON_PIXMAP/MASK. This must be done with GTK
1429 functions so GTK does not overwrite the icon. */
1431 void
1432 xg_set_frame_icon (FRAME_PTR f, Pixmap icon_pixmap, Pixmap icon_mask)
1434 GdkPixbuf *gp = xg_get_pixbuf_from_pix_and_mask (f,
1435 icon_pixmap,
1436 icon_mask);
1437 if (gp)
1438 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), gp);
1443 /***********************************************************************
1444 Dialog functions
1445 ***********************************************************************/
1446 /* Return the dialog title to use for a dialog of type KEY.
1447 This is the encoding used by lwlib. We use the same for GTK. */
1449 static const char *
1450 get_dialog_title (char key)
1452 const char *title = "";
1454 switch (key) {
1455 case 'E': case 'e':
1456 title = "Error";
1457 break;
1459 case 'I': case 'i':
1460 title = "Information";
1461 break;
1463 case 'L': case 'l':
1464 title = "Prompt";
1465 break;
1467 case 'P': case 'p':
1468 title = "Prompt";
1469 break;
1471 case 'Q': case 'q':
1472 title = "Question";
1473 break;
1476 return title;
1479 /* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
1480 the dialog, but return TRUE so the event does not propagate further
1481 in GTK. This prevents GTK from destroying the dialog widget automatically
1482 and we can always destroy the widget manually, regardless of how
1483 it was popped down (button press or WM_DELETE_WINDOW).
1484 W is the dialog widget.
1485 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
1486 user_data is NULL (not used).
1488 Returns TRUE to end propagation of event. */
1490 static gboolean
1491 dialog_delete_callback (GtkWidget *w, GdkEvent *event, gpointer user_data)
1493 gtk_widget_unmap (w);
1494 return TRUE;
1497 /* Create a popup dialog window. See also xg_create_widget below.
1498 WV is a widget_value describing the dialog.
1499 SELECT_CB is the callback to use when a button has been pressed.
1500 DEACTIVATE_CB is the callback to use when the dialog pops down.
1502 Returns the GTK dialog widget. */
1504 static GtkWidget *
1505 create_dialog (widget_value *wv,
1506 GCallback select_cb,
1507 GCallback deactivate_cb)
1509 const char *title = get_dialog_title (wv->name[0]);
1510 int total_buttons = wv->name[1] - '0';
1511 int right_buttons = wv->name[4] - '0';
1512 int left_buttons;
1513 int button_nr = 0;
1514 int button_spacing = 10;
1515 GtkWidget *wdialog = gtk_dialog_new ();
1516 GtkDialog *wd = GTK_DIALOG (wdialog);
1517 GtkBox *cur_box = GTK_BOX (gtk_dialog_get_action_area (wd));
1518 widget_value *item;
1519 GtkWidget *whbox_down;
1521 /* If the number of buttons is greater than 4, make two rows of buttons
1522 instead. This looks better. */
1523 int make_two_rows = total_buttons > 4;
1525 if (right_buttons == 0) right_buttons = total_buttons/2;
1526 left_buttons = total_buttons - right_buttons;
1528 gtk_window_set_title (GTK_WINDOW (wdialog), title);
1529 gtk_widget_set_name (wdialog, "emacs-dialog");
1532 if (make_two_rows)
1534 GtkWidget *wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, button_spacing);
1535 GtkWidget *whbox_up = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1536 gtk_box_set_homogeneous (GTK_BOX (wvbox), TRUE);
1537 gtk_box_set_homogeneous (GTK_BOX (whbox_up), FALSE);
1538 whbox_down = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1539 gtk_box_set_homogeneous (GTK_BOX (whbox_down), FALSE);
1541 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
1542 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
1543 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
1545 cur_box = GTK_BOX (whbox_up);
1548 g_signal_connect (G_OBJECT (wdialog), "delete-event",
1549 G_CALLBACK (dialog_delete_callback), 0);
1551 if (deactivate_cb)
1553 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
1554 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
1557 for (item = wv->contents; item; item = item->next)
1559 char *utf8_label = get_utf8_string (item->value);
1560 GtkWidget *w;
1561 GtkRequisition req;
1563 if (item->name && strcmp (item->name, "message") == 0)
1565 GtkBox *wvbox = GTK_BOX (gtk_dialog_get_content_area (wd));
1566 /* This is the text part of the dialog. */
1567 w = gtk_label_new (utf8_label);
1568 gtk_box_pack_start (wvbox, gtk_label_new (""), FALSE, FALSE, 0);
1569 gtk_box_pack_start (wvbox, w, TRUE, TRUE, 0);
1570 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
1572 /* Try to make dialog look better. Must realize first so
1573 the widget can calculate the size it needs. */
1574 gtk_widget_realize (w);
1575 gtk_widget_get_preferred_size (w, NULL, &req);
1576 gtk_box_set_spacing (wvbox, req.height);
1577 if (item->value && strlen (item->value) > 0)
1578 button_spacing = 2*req.width/strlen (item->value);
1580 else
1582 /* This is one button to add to the dialog. */
1583 w = gtk_button_new_with_label (utf8_label);
1584 if (! item->enabled)
1585 gtk_widget_set_sensitive (w, FALSE);
1586 if (select_cb)
1587 g_signal_connect (G_OBJECT (w), "clicked",
1588 select_cb, item->call_data);
1590 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
1591 if (++button_nr == left_buttons)
1593 if (make_two_rows)
1594 cur_box = GTK_BOX (whbox_down);
1595 else
1596 gtk_box_pack_start (cur_box,
1597 gtk_label_new (""),
1598 TRUE, TRUE,
1599 button_spacing);
1603 if (utf8_label)
1604 g_free (utf8_label);
1607 return wdialog;
1610 struct xg_dialog_data
1612 GMainLoop *loop;
1613 int response;
1614 GtkWidget *w;
1615 guint timerid;
1618 /* Function that is called when the file or font dialogs pop down.
1619 W is the dialog widget, RESPONSE is the response code.
1620 USER_DATA is what we passed in to g_signal_connect. */
1622 static void
1623 xg_dialog_response_cb (GtkDialog *w,
1624 gint response,
1625 gpointer user_data)
1627 struct xg_dialog_data *dd = (struct xg_dialog_data *)user_data;
1628 dd->response = response;
1629 g_main_loop_quit (dd->loop);
1633 /* Destroy the dialog. This makes it pop down. */
1635 static Lisp_Object
1636 pop_down_dialog (Lisp_Object arg)
1638 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1639 struct xg_dialog_data *dd = (struct xg_dialog_data *) p->pointer;
1641 BLOCK_INPUT;
1642 if (dd->w) gtk_widget_destroy (dd->w);
1643 if (dd->timerid != 0) g_source_remove (dd->timerid);
1645 g_main_loop_quit (dd->loop);
1646 g_main_loop_unref (dd->loop);
1648 UNBLOCK_INPUT;
1650 return Qnil;
1653 /* If there are any emacs timers pending, add a timeout to main loop in DATA.
1654 We pass in DATA as gpointer* so we can use this as a callback. */
1656 static gboolean
1657 xg_maybe_add_timer (gpointer data)
1659 struct xg_dialog_data *dd = (struct xg_dialog_data *) data;
1660 EMACS_TIME next_time = timer_check ();
1662 dd->timerid = 0;
1664 if (EMACS_TIME_VALID_P (next_time))
1666 time_t s = EMACS_SECS (next_time);
1667 int per_ms = EMACS_TIME_RESOLUTION / 1000;
1668 int ms = (EMACS_NSECS (next_time) + per_ms - 1) / per_ms;
1669 if (s <= ((guint) -1 - ms) / 1000)
1670 dd->timerid = g_timeout_add (s * 1000 + ms, xg_maybe_add_timer, dd);
1672 return FALSE;
1676 /* Pops up a modal dialog W and waits for response.
1677 We don't use gtk_dialog_run because we want to process emacs timers.
1678 The dialog W is not destroyed when this function returns. */
1680 static int
1681 xg_dialog_run (FRAME_PTR f, GtkWidget *w)
1683 ptrdiff_t count = SPECPDL_INDEX ();
1684 struct xg_dialog_data dd;
1686 xg_set_screen (w, f);
1687 gtk_window_set_transient_for (GTK_WINDOW (w),
1688 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1689 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1690 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
1692 dd.loop = g_main_loop_new (NULL, FALSE);
1693 dd.response = GTK_RESPONSE_CANCEL;
1694 dd.w = w;
1695 dd.timerid = 0;
1697 g_signal_connect (G_OBJECT (w),
1698 "response",
1699 G_CALLBACK (xg_dialog_response_cb),
1700 &dd);
1701 /* Don't destroy the widget if closed by the window manager close button. */
1702 g_signal_connect (G_OBJECT (w), "delete-event", G_CALLBACK (gtk_true), NULL);
1703 gtk_widget_show (w);
1705 record_unwind_protect (pop_down_dialog, make_save_value (&dd, 0));
1707 (void) xg_maybe_add_timer (&dd);
1708 g_main_loop_run (dd.loop);
1710 dd.w = 0;
1711 unbind_to (count, Qnil);
1713 return dd.response;
1717 /***********************************************************************
1718 File dialog functions
1719 ***********************************************************************/
1720 /* Return non-zero if the old file selection dialog is being used.
1721 Return zero if not. */
1724 xg_uses_old_file_dialog (void)
1726 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1727 return x_gtk_use_old_file_dialog;
1728 #else
1729 return 0;
1730 #endif
1734 typedef char * (*xg_get_file_func) (GtkWidget *);
1736 /* Return the selected file for file chooser dialog W.
1737 The returned string must be free:d. */
1739 static char *
1740 xg_get_file_name_from_chooser (GtkWidget *w)
1742 return gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (w));
1745 /* Callback called when the "Show hidden files" toggle is pressed.
1746 WIDGET is the toggle widget, DATA is the file chooser dialog. */
1748 static void
1749 xg_toggle_visibility_cb (GtkWidget *widget, gpointer data)
1751 GtkFileChooser *dialog = GTK_FILE_CHOOSER (data);
1752 gboolean visible;
1753 g_object_get (G_OBJECT (dialog), "show-hidden", &visible, NULL);
1754 g_object_set (G_OBJECT (dialog), "show-hidden", !visible, NULL);
1758 /* Callback called when a property changes in a file chooser.
1759 GOBJECT is the file chooser dialog, ARG1 describes the property.
1760 USER_DATA is the toggle widget in the file chooser dialog.
1761 We use this to update the "Show hidden files" toggle when the user
1762 changes that property by right clicking in the file list. */
1764 static void
1765 xg_toggle_notify_cb (GObject *gobject, GParamSpec *arg1, gpointer user_data)
1767 if (strcmp (arg1->name, "show-hidden") == 0)
1769 GtkWidget *wtoggle = GTK_WIDGET (user_data);
1770 gboolean visible, toggle_on;
1772 g_object_get (G_OBJECT (gobject), "show-hidden", &visible, NULL);
1773 toggle_on = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (wtoggle));
1775 if (!!visible != !!toggle_on)
1777 g_signal_handlers_block_by_func (G_OBJECT (wtoggle),
1778 G_CALLBACK (xg_toggle_visibility_cb),
1779 gobject);
1780 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), visible);
1781 g_signal_handlers_unblock_by_func
1782 (G_OBJECT (wtoggle),
1783 G_CALLBACK (xg_toggle_visibility_cb),
1784 gobject);
1786 x_gtk_show_hidden_files = visible;
1790 /* Read a file name from the user using a file chooser dialog.
1791 F is the current frame.
1792 PROMPT is a prompt to show to the user. May not be NULL.
1793 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1794 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1795 file. (Actually, this only has cosmetic effects, the user can
1796 still enter a non-existing file.) *FUNC is set to a function that
1797 can be used to retrieve the selected file name from the returned widget.
1799 Returns the created widget. */
1801 static GtkWidget *
1802 xg_get_file_with_chooser (FRAME_PTR f,
1803 char *prompt,
1804 char *default_filename,
1805 int mustmatch_p, int only_dir_p,
1806 xg_get_file_func *func)
1808 char msgbuf[1024];
1810 GtkWidget *filewin, *wtoggle, *wbox, *wmessage IF_LINT (= NULL);
1811 GtkWindow *gwin = GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f));
1812 GtkFileChooserAction action = (mustmatch_p ?
1813 GTK_FILE_CHOOSER_ACTION_OPEN :
1814 GTK_FILE_CHOOSER_ACTION_SAVE);
1816 if (only_dir_p)
1817 action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
1819 filewin = gtk_file_chooser_dialog_new (prompt, gwin, action,
1820 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1821 (mustmatch_p || only_dir_p ?
1822 GTK_STOCK_OPEN : GTK_STOCK_OK),
1823 GTK_RESPONSE_OK,
1824 NULL);
1825 gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (filewin), TRUE);
1827 wbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1828 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
1829 gtk_widget_show (wbox);
1830 wtoggle = gtk_check_button_new_with_label ("Show hidden files.");
1832 if (x_gtk_show_hidden_files)
1834 g_object_set (G_OBJECT (filewin), "show-hidden", TRUE, NULL);
1835 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), TRUE);
1837 gtk_widget_show (wtoggle);
1838 g_signal_connect (G_OBJECT (wtoggle), "clicked",
1839 G_CALLBACK (xg_toggle_visibility_cb), filewin);
1840 g_signal_connect (G_OBJECT (filewin), "notify",
1841 G_CALLBACK (xg_toggle_notify_cb), wtoggle);
1843 if (x_gtk_file_dialog_help_text)
1845 msgbuf[0] = '\0';
1846 /* Gtk+ 2.10 has the file name text entry box integrated in the dialog.
1847 Show the C-l help text only for versions < 2.10. */
1848 if (gtk_check_version (2, 10, 0) && action != GTK_FILE_CHOOSER_ACTION_SAVE)
1849 strcat (msgbuf, "\nType C-l to display a file name text entry box.\n");
1850 strcat (msgbuf, "\nIf you don't like this file selector, use the "
1851 "corresponding\nkey binding or customize "
1852 "use-file-dialog to turn it off.");
1854 wmessage = gtk_label_new (msgbuf);
1855 gtk_widget_show (wmessage);
1858 gtk_box_pack_start (GTK_BOX (wbox), wtoggle, FALSE, FALSE, 0);
1859 if (x_gtk_file_dialog_help_text)
1860 gtk_box_pack_start (GTK_BOX (wbox), wmessage, FALSE, FALSE, 0);
1861 gtk_file_chooser_set_extra_widget (GTK_FILE_CHOOSER (filewin), wbox);
1863 if (default_filename)
1865 Lisp_Object file;
1866 struct gcpro gcpro1;
1867 char *utf8_filename;
1868 GCPRO1 (file);
1870 file = build_string (default_filename);
1872 /* File chooser does not understand ~/... in the file name. It must be
1873 an absolute name starting with /. */
1874 if (default_filename[0] != '/')
1875 file = Fexpand_file_name (file, Qnil);
1877 utf8_filename = SSDATA (ENCODE_UTF_8 (file));
1878 if (! NILP (Ffile_directory_p (file)))
1879 gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (filewin),
1880 utf8_filename);
1881 else
1883 gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (filewin),
1884 utf8_filename);
1885 if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
1887 char *cp = strrchr (utf8_filename, '/');
1888 if (cp) ++cp;
1889 else cp = utf8_filename;
1890 gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (filewin), cp);
1894 UNGCPRO;
1897 *func = xg_get_file_name_from_chooser;
1898 return filewin;
1901 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1903 /* Return the selected file for file selector dialog W.
1904 The returned string must be free:d. */
1906 static char *
1907 xg_get_file_name_from_selector (GtkWidget *w)
1909 GtkFileSelection *filesel = GTK_FILE_SELECTION (w);
1910 return xstrdup ((char*) gtk_file_selection_get_filename (filesel));
1913 /* Create a file selection dialog.
1914 F is the current frame.
1915 PROMPT is a prompt to show to the user. May not be NULL.
1916 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1917 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1918 file. *FUNC is set to a function that can be used to retrieve the
1919 selected file name from the returned widget.
1921 Returns the created widget. */
1923 static GtkWidget *
1924 xg_get_file_with_selection (FRAME_PTR f,
1925 char *prompt,
1926 char *default_filename,
1927 int mustmatch_p, int only_dir_p,
1928 xg_get_file_func *func)
1930 GtkWidget *filewin;
1931 GtkFileSelection *filesel;
1933 filewin = gtk_file_selection_new (prompt);
1934 filesel = GTK_FILE_SELECTION (filewin);
1936 if (default_filename)
1937 gtk_file_selection_set_filename (filesel, default_filename);
1939 if (mustmatch_p)
1941 /* The selection_entry part of filesel is not documented. */
1942 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
1943 gtk_file_selection_hide_fileop_buttons (filesel);
1946 *func = xg_get_file_name_from_selector;
1948 return filewin;
1950 #endif /* HAVE_GTK_FILE_SELECTION_NEW */
1952 /* Read a file name from the user using a file dialog, either the old
1953 file selection dialog, or the new file chooser dialog. Which to use
1954 depends on what the GTK version used has, and what the value of
1955 gtk-use-old-file-dialog.
1956 F is the current frame.
1957 PROMPT is a prompt to show to the user. May not be NULL.
1958 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1959 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1960 file.
1962 Returns a file name or NULL if no file was selected.
1963 The returned string must be freed by the caller. */
1965 char *
1966 xg_get_file_name (FRAME_PTR f,
1967 char *prompt,
1968 char *default_filename,
1969 int mustmatch_p,
1970 int only_dir_p)
1972 GtkWidget *w = 0;
1973 char *fn = 0;
1974 int filesel_done = 0;
1975 xg_get_file_func func;
1977 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
1978 /* I really don't know why this is needed, but without this the GLIBC add on
1979 library linuxthreads hangs when the Gnome file chooser backend creates
1980 threads. */
1981 sigblock (sigmask (__SIGRTMIN));
1982 #endif /* HAVE_PTHREAD */
1984 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1986 if (xg_uses_old_file_dialog ())
1987 w = xg_get_file_with_selection (f, prompt, default_filename,
1988 mustmatch_p, only_dir_p, &func);
1989 else
1990 w = xg_get_file_with_chooser (f, prompt, default_filename,
1991 mustmatch_p, only_dir_p, &func);
1993 #else /* not HAVE_GTK_FILE_SELECTION_NEW */
1994 w = xg_get_file_with_chooser (f, prompt, default_filename,
1995 mustmatch_p, only_dir_p, &func);
1996 #endif /* not HAVE_GTK_FILE_SELECTION_NEW */
1998 gtk_widget_set_name (w, "emacs-filedialog");
2000 filesel_done = xg_dialog_run (f, w);
2002 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
2003 sigunblock (sigmask (__SIGRTMIN));
2004 #endif
2006 if (filesel_done == GTK_RESPONSE_OK)
2007 fn = (*func) (w);
2009 gtk_widget_destroy (w);
2010 return fn;
2013 /***********************************************************************
2014 GTK font chooser
2015 ***********************************************************************/
2017 #ifdef HAVE_FREETYPE
2019 #if USE_NEW_GTK_FONT_CHOOSER
2021 extern Lisp_Object Qxft, Qnormal;
2022 extern Lisp_Object Qextra_light, Qlight, Qsemi_light, Qsemi_bold;
2023 extern Lisp_Object Qbold, Qextra_bold, Qultra_bold;
2024 extern Lisp_Object Qoblique, Qitalic;
2026 #define XG_WEIGHT_TO_SYMBOL(w) \
2027 (w <= PANGO_WEIGHT_THIN ? Qextra_light \
2028 : w <= PANGO_WEIGHT_ULTRALIGHT ? Qlight \
2029 : w <= PANGO_WEIGHT_LIGHT ? Qsemi_light \
2030 : w < PANGO_WEIGHT_MEDIUM ? Qnormal \
2031 : w <= PANGO_WEIGHT_SEMIBOLD ? Qsemi_bold \
2032 : w <= PANGO_WEIGHT_BOLD ? Qbold \
2033 : w <= PANGO_WEIGHT_HEAVY ? Qextra_bold \
2034 : Qultra_bold)
2036 #define XG_STYLE_TO_SYMBOL(s) \
2037 (s == PANGO_STYLE_OBLIQUE ? Qoblique \
2038 : s == PANGO_STYLE_ITALIC ? Qitalic \
2039 : Qnormal)
2041 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2044 static char *x_last_font_name;
2046 /* Pop up a GTK font selector and return the name of the font the user
2047 selects, as a C string. The returned font name follows GTK's own
2048 format:
2050 `FAMILY [VALUE1 VALUE2] SIZE'
2052 This can be parsed using font_parse_fcname in font.c.
2053 DEFAULT_NAME, if non-zero, is the default font name. */
2055 Lisp_Object
2056 xg_get_font (FRAME_PTR f, const char *default_name)
2058 GtkWidget *w;
2059 int done = 0;
2060 Lisp_Object font = Qnil;
2062 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
2063 sigblock (sigmask (__SIGRTMIN));
2064 #endif /* HAVE_PTHREAD */
2066 w = gtk_font_chooser_dialog_new
2067 ("Pick a font", GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2069 if (default_name)
2071 /* Convert fontconfig names to Gtk names, i.e. remove - before
2072 number */
2073 char *p = strrchr (default_name, '-');
2074 if (p)
2076 char *ep = p+1;
2077 while (c_isdigit (*ep))
2078 ++ep;
2079 if (*ep == '\0') *p = ' ';
2082 else if (x_last_font_name)
2083 default_name = x_last_font_name;
2085 if (default_name)
2086 gtk_font_chooser_set_font (GTK_FONT_CHOOSER (w), default_name);
2088 gtk_widget_set_name (w, "emacs-fontdialog");
2089 done = xg_dialog_run (f, w);
2091 #if defined (HAVE_PTHREAD) && defined (__SIGRTMIN)
2092 sigunblock (sigmask (__SIGRTMIN));
2093 #endif
2095 if (done == GTK_RESPONSE_OK)
2097 #if USE_NEW_GTK_FONT_CHOOSER
2098 /* Use the GTK3 font chooser. */
2099 PangoFontDescription *desc
2100 = gtk_font_chooser_get_font_desc (GTK_FONT_CHOOSER (w));
2102 if (desc)
2104 Lisp_Object args[10];
2105 const char *name = pango_font_description_get_family (desc);
2106 gint size = pango_font_description_get_size (desc);
2107 PangoWeight weight = pango_font_description_get_weight (desc);
2108 PangoStyle style = pango_font_description_get_style (desc);
2110 args[0] = QCname;
2111 args[1] = build_string (name);
2113 args[2] = QCsize;
2114 args[3] = make_float (pango_units_to_double (size));
2116 args[4] = QCweight;
2117 args[5] = XG_WEIGHT_TO_SYMBOL (weight);
2119 args[6] = QCslant;
2120 args[7] = XG_STYLE_TO_SYMBOL (style);
2122 args[8] = QCtype;
2123 args[9] = Qxft;
2125 font = Ffont_spec (8, args);
2127 pango_font_description_free (desc);
2128 xfree (x_last_font_name);
2129 x_last_font_name = xstrdup (name);
2132 #else /* Use old font selector, which just returns the font name. */
2134 char *font_name
2135 = gtk_font_selection_dialog_get_font_name (GTK_FONT_CHOOSER (w));
2137 if (font_name)
2139 font = build_string (font_name);
2140 g_free (x_last_font_name);
2141 x_last_font_name = font_name;
2143 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2146 gtk_widget_destroy (w);
2147 return font;
2149 #endif /* HAVE_FREETYPE */
2153 /***********************************************************************
2154 Menu functions.
2155 ***********************************************************************/
2157 /* The name of menu items that can be used for customization. Since GTK
2158 RC files are very crude and primitive, we have to set this on all
2159 menu item names so a user can easily customize menu items. */
2161 #define MENU_ITEM_NAME "emacs-menuitem"
2164 /* Linked list of all allocated struct xg_menu_cb_data. Used for marking
2165 during GC. The next member points to the items. */
2166 static xg_list_node xg_menu_cb_list;
2168 /* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
2169 during GC. The next member points to the items. */
2170 static xg_list_node xg_menu_item_cb_list;
2172 /* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
2173 F is the frame CL_DATA will be initialized for.
2174 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2176 The menu bar and all sub menus under the menu bar in a frame
2177 share the same structure, hence the reference count.
2179 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
2180 allocated xg_menu_cb_data if CL_DATA is NULL. */
2182 static xg_menu_cb_data *
2183 make_cl_data (xg_menu_cb_data *cl_data, FRAME_PTR f, GCallback highlight_cb)
2185 if (! cl_data)
2187 cl_data = xmalloc (sizeof *cl_data);
2188 cl_data->f = f;
2189 cl_data->menu_bar_vector = f->menu_bar_vector;
2190 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2191 cl_data->highlight_cb = highlight_cb;
2192 cl_data->ref_count = 0;
2194 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
2197 cl_data->ref_count++;
2199 return cl_data;
2202 /* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
2203 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2205 When the menu bar is updated, menu items may have been added and/or
2206 removed, so menu_bar_vector and menu_bar_items_used change. We must
2207 then update CL_DATA since it is used to determine which menu
2208 item that is invoked in the menu.
2209 HIGHLIGHT_CB could change, there is no check that the same
2210 function is given when modifying a menu bar as was given when
2211 creating the menu bar. */
2213 static void
2214 update_cl_data (xg_menu_cb_data *cl_data,
2215 FRAME_PTR f,
2216 GCallback highlight_cb)
2218 if (cl_data)
2220 cl_data->f = f;
2221 cl_data->menu_bar_vector = f->menu_bar_vector;
2222 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2223 cl_data->highlight_cb = highlight_cb;
2227 /* Decrease reference count for CL_DATA.
2228 If reference count is zero, free CL_DATA. */
2230 static void
2231 unref_cl_data (xg_menu_cb_data *cl_data)
2233 if (cl_data && cl_data->ref_count > 0)
2235 cl_data->ref_count--;
2236 if (cl_data->ref_count == 0)
2238 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
2239 xfree (cl_data);
2244 /* Function that marks all lisp data during GC. */
2246 void
2247 xg_mark_data (void)
2249 xg_list_node *iter;
2250 Lisp_Object rest, frame;
2252 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
2253 mark_object (((xg_menu_cb_data *) iter)->menu_bar_vector);
2255 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
2257 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
2259 if (! NILP (cb_data->help))
2260 mark_object (cb_data->help);
2263 FOR_EACH_FRAME (rest, frame)
2265 FRAME_PTR f = XFRAME (frame);
2267 if (FRAME_X_P (f) && FRAME_GTK_OUTER_WIDGET (f))
2269 struct xg_frame_tb_info *tbinfo
2270 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
2271 TB_INFO_KEY);
2272 if (tbinfo)
2274 mark_object (tbinfo->last_tool_bar);
2275 mark_object (tbinfo->style);
2282 /* Callback called when a menu item is destroyed. Used to free data.
2283 W is the widget that is being destroyed (not used).
2284 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
2286 static void
2287 menuitem_destroy_callback (GtkWidget *w, gpointer client_data)
2289 if (client_data)
2291 xg_menu_item_cb_data *data = (xg_menu_item_cb_data*) client_data;
2292 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
2293 xfree (data);
2297 /* Callback called when the pointer enters/leaves a menu item.
2298 W is the parent of the menu item.
2299 EVENT is either an enter event or leave event.
2300 CLIENT_DATA is not used.
2302 Returns FALSE to tell GTK to keep processing this event. */
2304 static gboolean
2305 menuitem_highlight_callback (GtkWidget *w,
2306 GdkEventCrossing *event,
2307 gpointer client_data)
2309 GdkEvent ev;
2310 GtkWidget *subwidget;
2311 xg_menu_item_cb_data *data;
2313 ev.crossing = *event;
2314 subwidget = gtk_get_event_widget (&ev);
2315 data = (xg_menu_item_cb_data *) g_object_get_data (G_OBJECT (subwidget),
2316 XG_ITEM_DATA);
2317 if (data)
2319 if (! NILP (data->help) && data->cl_data->highlight_cb)
2321 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : data;
2322 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
2323 (*func) (subwidget, call_data);
2327 return FALSE;
2330 /* Callback called when a menu is destroyed. Used to free data.
2331 W is the widget that is being destroyed (not used).
2332 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
2334 static void
2335 menu_destroy_callback (GtkWidget *w, gpointer client_data)
2337 unref_cl_data ((xg_menu_cb_data*) client_data);
2340 /* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
2341 must be non-NULL) and can be inserted into a menu item.
2343 Returns the GtkHBox. */
2345 static GtkWidget *
2346 make_widget_for_menu_item (const char *utf8_label, const char *utf8_key)
2348 GtkWidget *wlbl;
2349 GtkWidget *wkey;
2350 GtkWidget *wbox;
2352 wbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2353 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
2354 wlbl = gtk_label_new (utf8_label);
2355 wkey = gtk_label_new (utf8_key);
2357 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
2358 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
2360 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
2361 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
2363 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
2364 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
2365 gtk_widget_set_name (wbox, MENU_ITEM_NAME);
2367 return wbox;
2370 /* Make and return a menu item widget with the key to the right.
2371 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
2372 UTF8_KEY is the text representing the key binding.
2373 ITEM is the widget_value describing the menu item.
2375 GROUP is an in/out parameter. If the menu item to be created is not
2376 part of any radio menu group, *GROUP contains NULL on entry and exit.
2377 If the menu item to be created is part of a radio menu group, on entry
2378 *GROUP contains the group to use, or NULL if this is the first item
2379 in the group. On exit, *GROUP contains the radio item group.
2381 Unfortunately, keys don't line up as nicely as in Motif,
2382 but the MacOS X version doesn't either, so I guess that is OK. */
2384 static GtkWidget *
2385 make_menu_item (const char *utf8_label,
2386 const char *utf8_key,
2387 widget_value *item,
2388 GSList **group)
2390 GtkWidget *w;
2391 GtkWidget *wtoadd = 0;
2393 /* It has been observed that some menu items have a NULL name field.
2394 This will lead to this function being called with a NULL utf8_label.
2395 GTK crashes on that so we set a blank label. Why there is a NULL
2396 name remains to be investigated. */
2397 if (! utf8_label) utf8_label = " ";
2399 if (utf8_key)
2400 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2402 if (item->button_type == BUTTON_TYPE_TOGGLE)
2404 *group = NULL;
2405 if (utf8_key) w = gtk_check_menu_item_new ();
2406 else w = gtk_check_menu_item_new_with_label (utf8_label);
2407 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
2409 else if (item->button_type == BUTTON_TYPE_RADIO)
2411 if (utf8_key) w = gtk_radio_menu_item_new (*group);
2412 else w = gtk_radio_menu_item_new_with_label (*group, utf8_label);
2413 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
2414 if (item->selected)
2415 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
2417 else
2419 *group = NULL;
2420 if (utf8_key) w = gtk_menu_item_new ();
2421 else w = gtk_menu_item_new_with_label (utf8_label);
2424 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
2425 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
2427 return w;
2430 static int xg_detached_menus;
2432 /* Returns non-zero if there are detached menus. */
2435 xg_have_tear_offs (void)
2437 return xg_detached_menus > 0;
2440 /* Callback invoked when a detached menu window is removed. Here we
2441 decrease the xg_detached_menus count.
2442 WIDGET is the top level window that is removed (the parent of the menu).
2443 CLIENT_DATA is not used. */
2445 static void
2446 tearoff_remove (GtkWidget *widget, gpointer client_data)
2448 if (xg_detached_menus > 0) --xg_detached_menus;
2451 /* Callback invoked when a menu is detached. It increases the
2452 xg_detached_menus count.
2453 WIDGET is the GtkTearoffMenuItem.
2454 CLIENT_DATA is not used. */
2456 static void
2457 tearoff_activate (GtkWidget *widget, gpointer client_data)
2459 GtkWidget *menu = gtk_widget_get_parent (widget);
2460 if (gtk_menu_get_tearoff_state (GTK_MENU (menu)))
2462 ++xg_detached_menus;
2463 g_signal_connect (G_OBJECT (gtk_widget_get_toplevel (widget)),
2464 "destroy",
2465 G_CALLBACK (tearoff_remove), 0);
2470 /* Create a menu item widget, and connect the callbacks.
2471 ITEM describes the menu item.
2472 F is the frame the created menu belongs to.
2473 SELECT_CB is the callback to use when a menu item is selected.
2474 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2475 CL_DATA points to the callback data to be used for this menu.
2476 GROUP is an in/out parameter. If the menu item to be created is not
2477 part of any radio menu group, *GROUP contains NULL on entry and exit.
2478 If the menu item to be created is part of a radio menu group, on entry
2479 *GROUP contains the group to use, or NULL if this is the first item
2480 in the group. On exit, *GROUP contains the radio item group.
2482 Returns the created GtkWidget. */
2484 static GtkWidget *
2485 xg_create_one_menuitem (widget_value *item,
2486 FRAME_PTR f,
2487 GCallback select_cb,
2488 GCallback highlight_cb,
2489 xg_menu_cb_data *cl_data,
2490 GSList **group)
2492 char *utf8_label;
2493 char *utf8_key;
2494 GtkWidget *w;
2495 xg_menu_item_cb_data *cb_data;
2497 utf8_label = get_utf8_string (item->name);
2498 utf8_key = get_utf8_string (item->key);
2500 w = make_menu_item (utf8_label, utf8_key, item, group);
2502 if (utf8_label) g_free (utf8_label);
2503 if (utf8_key) g_free (utf8_key);
2505 cb_data = xmalloc (sizeof *cb_data);
2507 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
2509 cb_data->select_id = 0;
2510 cb_data->help = item->help;
2511 cb_data->cl_data = cl_data;
2512 cb_data->call_data = item->call_data;
2514 g_signal_connect (G_OBJECT (w),
2515 "destroy",
2516 G_CALLBACK (menuitem_destroy_callback),
2517 cb_data);
2519 /* Put cb_data in widget, so we can get at it when modifying menubar */
2520 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
2522 /* final item, not a submenu */
2523 if (item->call_data && ! item->contents)
2525 if (select_cb)
2526 cb_data->select_id
2527 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
2530 return w;
2533 /* Create a full menu tree specified by DATA.
2534 F is the frame the created menu belongs to.
2535 SELECT_CB is the callback to use when a menu item is selected.
2536 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2537 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2538 POP_UP_P is non-zero if we shall create a popup menu.
2539 MENU_BAR_P is non-zero if we shall create a menu bar.
2540 ADD_TEAROFF_P is non-zero if we shall add a tearoff menu item. Ignored
2541 if MENU_BAR_P is non-zero.
2542 TOPMENU is the topmost GtkWidget that others shall be placed under.
2543 It may be NULL, in that case we create the appropriate widget
2544 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
2545 CL_DATA is the callback data we shall use for this menu, or NULL
2546 if we haven't set the first callback yet.
2547 NAME is the name to give to the top level menu if this function
2548 creates it. May be NULL to not set any name.
2550 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
2551 not NULL.
2553 This function calls itself to create submenus. */
2555 static GtkWidget *
2556 create_menus (widget_value *data,
2557 FRAME_PTR f,
2558 GCallback select_cb,
2559 GCallback deactivate_cb,
2560 GCallback highlight_cb,
2561 int pop_up_p,
2562 int menu_bar_p,
2563 int add_tearoff_p,
2564 GtkWidget *topmenu,
2565 xg_menu_cb_data *cl_data,
2566 const char *name)
2568 widget_value *item;
2569 GtkWidget *wmenu = topmenu;
2570 GSList *group = NULL;
2572 if (! topmenu)
2574 if (! menu_bar_p)
2576 wmenu = gtk_menu_new ();
2577 xg_set_screen (wmenu, f);
2578 /* Connect this to the menu instead of items so we get enter/leave for
2579 disabled items also. TODO: Still does not get enter/leave for
2580 disabled items in detached menus. */
2581 g_signal_connect (G_OBJECT (wmenu),
2582 "enter-notify-event",
2583 G_CALLBACK (menuitem_highlight_callback),
2584 NULL);
2585 g_signal_connect (G_OBJECT (wmenu),
2586 "leave-notify-event",
2587 G_CALLBACK (menuitem_highlight_callback),
2588 NULL);
2590 else
2592 wmenu = gtk_menu_bar_new ();
2593 /* Set width of menu bar to a small value so it doesn't enlarge
2594 a small initial frame size. The width will be set to the
2595 width of the frame later on when it is added to a container.
2596 height -1: Natural height. */
2597 gtk_widget_set_size_request (wmenu, 1, -1);
2600 /* Put cl_data on the top menu for easier access. */
2601 cl_data = make_cl_data (cl_data, f, highlight_cb);
2602 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
2603 g_signal_connect (G_OBJECT (wmenu), "destroy",
2604 G_CALLBACK (menu_destroy_callback), cl_data);
2606 if (name)
2607 gtk_widget_set_name (wmenu, name);
2609 if (deactivate_cb)
2610 g_signal_connect (G_OBJECT (wmenu),
2611 "selection-done", deactivate_cb, 0);
2614 if (! menu_bar_p && add_tearoff_p)
2616 GtkWidget *tearoff = gtk_tearoff_menu_item_new ();
2617 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), tearoff);
2619 g_signal_connect (G_OBJECT (tearoff), "activate",
2620 G_CALLBACK (tearoff_activate), 0);
2623 for (item = data; item; item = item->next)
2625 GtkWidget *w;
2627 if (pop_up_p && !item->contents && !item->call_data
2628 && !menu_separator_name_p (item->name))
2630 char *utf8_label;
2631 /* A title for a popup. We do the same as GTK does when
2632 creating titles, but it does not look good. */
2633 group = NULL;
2634 utf8_label = get_utf8_string (item->name);
2636 gtk_menu_set_title (GTK_MENU (wmenu), utf8_label);
2637 w = gtk_menu_item_new_with_label (utf8_label);
2638 gtk_widget_set_sensitive (w, FALSE);
2639 if (utf8_label) g_free (utf8_label);
2641 else if (menu_separator_name_p (item->name))
2643 group = NULL;
2644 /* GTK only have one separator type. */
2645 w = gtk_separator_menu_item_new ();
2647 else
2649 w = xg_create_one_menuitem (item,
2651 item->contents ? 0 : select_cb,
2652 highlight_cb,
2653 cl_data,
2654 &group);
2656 /* Create a possibly empty submenu for menu bar items, since some
2657 themes don't highlight items correctly without it. */
2658 if (item->contents || menu_bar_p)
2660 GtkWidget *submenu = create_menus (item->contents,
2662 select_cb,
2663 deactivate_cb,
2664 highlight_cb,
2667 add_tearoff_p,
2669 cl_data,
2671 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2675 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
2676 gtk_widget_set_name (w, MENU_ITEM_NAME);
2679 return wmenu;
2682 /* Create a menubar, popup menu or dialog, depending on the TYPE argument.
2683 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
2684 with some text and buttons.
2685 F is the frame the created item belongs to.
2686 NAME is the name to use for the top widget.
2687 VAL is a widget_value structure describing items to be created.
2688 SELECT_CB is the callback to use when a menu item is selected or
2689 a dialog button is pressed.
2690 DEACTIVATE_CB is the callback to use when an item is deactivated.
2691 For a menu, when a sub menu is not shown anymore, for a dialog it is
2692 called when the dialog is popped down.
2693 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2695 Returns the widget created. */
2697 GtkWidget *
2698 xg_create_widget (const char *type, const char *name, FRAME_PTR f, widget_value *val,
2699 GCallback select_cb, GCallback deactivate_cb,
2700 GCallback highlight_cb)
2702 GtkWidget *w = 0;
2703 int menu_bar_p = strcmp (type, "menubar") == 0;
2704 int pop_up_p = strcmp (type, "popup") == 0;
2706 if (strcmp (type, "dialog") == 0)
2708 w = create_dialog (val, select_cb, deactivate_cb);
2709 xg_set_screen (w, f);
2710 gtk_window_set_transient_for (GTK_WINDOW (w),
2711 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2712 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
2713 gtk_widget_set_name (w, "emacs-dialog");
2714 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
2716 else if (menu_bar_p || pop_up_p)
2718 w = create_menus (val->contents,
2720 select_cb,
2721 deactivate_cb,
2722 highlight_cb,
2723 pop_up_p,
2724 menu_bar_p,
2725 menu_bar_p,
2728 name);
2730 /* Set the cursor to an arrow for popup menus when they are mapped.
2731 This is done by default for menu bar menus. */
2732 if (pop_up_p)
2734 /* Must realize so the GdkWindow inside the widget is created. */
2735 gtk_widget_realize (w);
2736 xg_set_cursor (w, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
2739 else
2741 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
2742 type);
2745 return w;
2748 /* Return the label for menu item WITEM. */
2750 static const char *
2751 xg_get_menu_item_label (GtkMenuItem *witem)
2753 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2754 return gtk_label_get_label (wlabel);
2757 /* Return non-zero if the menu item WITEM has the text LABEL. */
2759 static int
2760 xg_item_label_same_p (GtkMenuItem *witem, const char *label)
2762 int is_same = 0;
2763 char *utf8_label = get_utf8_string (label);
2764 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
2766 if (! old_label && ! utf8_label)
2767 is_same = 1;
2768 else if (old_label && utf8_label)
2769 is_same = strcmp (utf8_label, old_label) == 0;
2771 if (utf8_label) g_free (utf8_label);
2773 return is_same;
2776 /* Destroy widgets in LIST. */
2778 static void
2779 xg_destroy_widgets (GList *list)
2781 GList *iter;
2783 for (iter = list; iter; iter = g_list_next (iter))
2785 GtkWidget *w = GTK_WIDGET (iter->data);
2787 /* Destroying the widget will remove it from the container it is in. */
2788 gtk_widget_destroy (w);
2792 /* Update the top level names in MENUBAR (i.e. not submenus).
2793 F is the frame the menu bar belongs to.
2794 *LIST is a list with the current menu bar names (menu item widgets).
2795 ITER is the item within *LIST that shall be updated.
2796 POS is the numerical position, starting at 0, of ITER in *LIST.
2797 VAL describes what the menu bar shall look like after the update.
2798 SELECT_CB is the callback to use when a menu item is selected.
2799 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2800 CL_DATA points to the callback data to be used for this menu bar.
2802 This function calls itself to walk through the menu bar names. */
2804 static void
2805 xg_update_menubar (GtkWidget *menubar,
2806 FRAME_PTR f,
2807 GList **list,
2808 GList *iter,
2809 int pos,
2810 widget_value *val,
2811 GCallback select_cb,
2812 GCallback deactivate_cb,
2813 GCallback highlight_cb,
2814 xg_menu_cb_data *cl_data)
2816 if (! iter && ! val)
2817 return;
2818 else if (iter && ! val)
2820 /* Item(s) have been removed. Remove all remaining items. */
2821 xg_destroy_widgets (iter);
2823 /* Add a blank entry so the menubar doesn't collapse to nothing. */
2824 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2825 gtk_menu_item_new_with_label (""),
2827 /* All updated. */
2828 val = 0;
2829 iter = 0;
2831 else if (! iter && val)
2833 /* Item(s) added. Add all new items in one call. */
2834 create_menus (val, f, select_cb, deactivate_cb, highlight_cb,
2835 0, 1, 0, menubar, cl_data, 0);
2837 /* All updated. */
2838 val = 0;
2839 iter = 0;
2841 /* Below this neither iter or val is NULL */
2842 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
2844 /* This item is still the same, check next item. */
2845 val = val->next;
2846 iter = g_list_next (iter);
2847 ++pos;
2849 else /* This item is changed. */
2851 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
2852 GtkMenuItem *witem2 = 0;
2853 int val_in_menubar = 0;
2854 int iter_in_new_menubar = 0;
2855 GList *iter2;
2856 widget_value *cur;
2858 /* See if the changed entry (val) is present later in the menu bar */
2859 for (iter2 = iter;
2860 iter2 && ! val_in_menubar;
2861 iter2 = g_list_next (iter2))
2863 witem2 = GTK_MENU_ITEM (iter2->data);
2864 val_in_menubar = xg_item_label_same_p (witem2, val->name);
2867 /* See if the current entry (iter) is present later in the
2868 specification for the new menu bar. */
2869 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
2870 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
2872 if (val_in_menubar && ! iter_in_new_menubar)
2874 int nr = pos;
2876 /* This corresponds to:
2877 Current: A B C
2878 New: A C
2879 Remove B. */
2881 g_object_ref (G_OBJECT (witem));
2882 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
2883 gtk_widget_destroy (GTK_WIDGET (witem));
2885 /* Must get new list since the old changed. */
2886 g_list_free (*list);
2887 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2888 while (nr-- > 0) iter = g_list_next (iter);
2890 else if (! val_in_menubar && ! iter_in_new_menubar)
2892 /* This corresponds to:
2893 Current: A B C
2894 New: A X C
2895 Rename B to X. This might seem to be a strange thing to do,
2896 since if there is a menu under B it will be totally wrong for X.
2897 But consider editing a C file. Then there is a C-mode menu
2898 (corresponds to B above).
2899 If then doing C-x C-f the minibuf menu (X above) replaces the
2900 C-mode menu. When returning from the minibuffer, we get
2901 back the C-mode menu. Thus we do:
2902 Rename B to X (C-mode to minibuf menu)
2903 Rename X to B (minibuf to C-mode menu).
2904 If the X menu hasn't been invoked, the menu under B
2905 is up to date when leaving the minibuffer. */
2906 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2907 char *utf8_label = get_utf8_string (val->name);
2908 GtkWidget *submenu = gtk_menu_item_get_submenu (witem);
2910 gtk_label_set_text (wlabel, utf8_label);
2912 /* If this item has a submenu that has been detached, change
2913 the title in the WM decorations also. */
2914 if (submenu && gtk_menu_get_tearoff_state (GTK_MENU (submenu)))
2915 /* Set the title of the detached window. */
2916 gtk_menu_set_title (GTK_MENU (submenu), utf8_label);
2918 if (utf8_label) g_free (utf8_label);
2919 iter = g_list_next (iter);
2920 val = val->next;
2921 ++pos;
2923 else if (! val_in_menubar && iter_in_new_menubar)
2925 /* This corresponds to:
2926 Current: A B C
2927 New: A X B C
2928 Insert X. */
2930 int nr = pos;
2931 GSList *group = 0;
2932 GtkWidget *w = xg_create_one_menuitem (val,
2934 select_cb,
2935 highlight_cb,
2936 cl_data,
2937 &group);
2939 /* Create a possibly empty submenu for menu bar items, since some
2940 themes don't highlight items correctly without it. */
2941 GtkWidget *submenu = create_menus (NULL, f,
2942 select_cb, deactivate_cb,
2943 highlight_cb,
2944 0, 0, 0, 0, cl_data, 0);
2945 gtk_widget_set_name (w, MENU_ITEM_NAME);
2946 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
2947 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2949 g_list_free (*list);
2950 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2951 while (nr-- > 0) iter = g_list_next (iter);
2952 iter = g_list_next (iter);
2953 val = val->next;
2954 ++pos;
2956 else /* if (val_in_menubar && iter_in_new_menubar) */
2958 int nr = pos;
2959 /* This corresponds to:
2960 Current: A B C
2961 New: A C B
2962 Move C before B */
2964 g_object_ref (G_OBJECT (witem2));
2965 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
2966 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2967 GTK_WIDGET (witem2), pos);
2968 g_object_unref (G_OBJECT (witem2));
2970 g_list_free (*list);
2971 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2972 while (nr-- > 0) iter = g_list_next (iter);
2973 if (iter) iter = g_list_next (iter);
2974 val = val->next;
2975 ++pos;
2979 /* Update the rest of the menu bar. */
2980 xg_update_menubar (menubar, f, list, iter, pos, val,
2981 select_cb, deactivate_cb, highlight_cb, cl_data);
2984 /* Update the menu item W so it corresponds to VAL.
2985 SELECT_CB is the callback to use when a menu item is selected.
2986 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2987 CL_DATA is the data to set in the widget for menu invocation. */
2989 static void
2990 xg_update_menu_item (widget_value *val,
2991 GtkWidget *w,
2992 GCallback select_cb,
2993 GCallback highlight_cb,
2994 xg_menu_cb_data *cl_data)
2996 GtkWidget *wchild;
2997 GtkLabel *wlbl = 0;
2998 GtkLabel *wkey = 0;
2999 char *utf8_label;
3000 char *utf8_key;
3001 const char *old_label = 0;
3002 const char *old_key = 0;
3003 xg_menu_item_cb_data *cb_data;
3005 wchild = XG_BIN_CHILD (w);
3006 utf8_label = get_utf8_string (val->name);
3007 utf8_key = get_utf8_string (val->key);
3009 /* See if W is a menu item with a key. See make_menu_item above. */
3010 if (GTK_IS_BOX (wchild))
3012 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
3014 wlbl = GTK_LABEL (list->data);
3015 wkey = GTK_LABEL (list->next->data);
3016 g_list_free (list);
3018 if (! utf8_key)
3020 /* Remove the key and keep just the label. */
3021 g_object_ref (G_OBJECT (wlbl));
3022 gtk_container_remove (GTK_CONTAINER (w), wchild);
3023 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
3024 g_object_unref (G_OBJECT (wlbl));
3025 wkey = 0;
3029 else /* Just a label. */
3031 wlbl = GTK_LABEL (wchild);
3033 /* Check if there is now a key. */
3034 if (utf8_key)
3036 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
3037 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
3039 wlbl = GTK_LABEL (list->data);
3040 wkey = GTK_LABEL (list->next->data);
3041 g_list_free (list);
3043 gtk_container_remove (GTK_CONTAINER (w), wchild);
3044 gtk_container_add (GTK_CONTAINER (w), wtoadd);
3049 if (wkey) old_key = gtk_label_get_label (wkey);
3050 if (wlbl) old_label = gtk_label_get_label (wlbl);
3052 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
3053 gtk_label_set_text (wkey, utf8_key);
3055 if (! old_label || strcmp (utf8_label, old_label) != 0)
3056 gtk_label_set_text (wlbl, utf8_label);
3058 if (utf8_key) g_free (utf8_key);
3059 if (utf8_label) g_free (utf8_label);
3061 if (! val->enabled && gtk_widget_get_sensitive (w))
3062 gtk_widget_set_sensitive (w, FALSE);
3063 else if (val->enabled && ! gtk_widget_get_sensitive (w))
3064 gtk_widget_set_sensitive (w, TRUE);
3066 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (w),
3067 XG_ITEM_DATA);
3068 if (cb_data)
3070 cb_data->call_data = val->call_data;
3071 cb_data->help = val->help;
3072 cb_data->cl_data = cl_data;
3074 /* We assume the callback functions don't change. */
3075 if (val->call_data && ! val->contents)
3077 /* This item shall have a select callback. */
3078 if (! cb_data->select_id)
3079 cb_data->select_id
3080 = g_signal_connect (G_OBJECT (w), "activate",
3081 select_cb, cb_data);
3083 else if (cb_data->select_id)
3085 g_signal_handler_disconnect (w, cb_data->select_id);
3086 cb_data->select_id = 0;
3091 /* Update the toggle menu item W so it corresponds to VAL. */
3093 static void
3094 xg_update_toggle_item (widget_value *val, GtkWidget *w)
3096 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3099 /* Update the radio menu item W so it corresponds to VAL. */
3101 static void
3102 xg_update_radio_item (widget_value *val, GtkWidget *w)
3104 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3107 /* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
3108 SUBMENU may be NULL, in that case a new menu is created.
3109 F is the frame the menu bar belongs to.
3110 VAL describes the contents of the menu bar.
3111 SELECT_CB is the callback to use when a menu item is selected.
3112 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3113 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
3114 CL_DATA is the call back data to use for any newly created items.
3116 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
3117 was NULL. */
3119 static GtkWidget *
3120 xg_update_submenu (GtkWidget *submenu,
3121 FRAME_PTR f,
3122 widget_value *val,
3123 GCallback select_cb,
3124 GCallback deactivate_cb,
3125 GCallback highlight_cb,
3126 xg_menu_cb_data *cl_data)
3128 GtkWidget *newsub = submenu;
3129 GList *list = 0;
3130 GList *iter;
3131 widget_value *cur;
3132 int has_tearoff_p = 0;
3133 GList *first_radio = 0;
3135 if (submenu)
3136 list = gtk_container_get_children (GTK_CONTAINER (submenu));
3138 for (cur = val, iter = list;
3139 cur && iter;
3140 iter = g_list_next (iter), cur = cur->next)
3142 GtkWidget *w = GTK_WIDGET (iter->data);
3144 /* Skip tearoff items, they have no counterpart in val. */
3145 if (GTK_IS_TEAROFF_MENU_ITEM (w))
3147 has_tearoff_p = 1;
3148 iter = g_list_next (iter);
3149 if (iter) w = GTK_WIDGET (iter->data);
3150 else break;
3153 /* Remember first radio button in a group. If we get a mismatch in
3154 a radio group we must rebuild the whole group so that the connections
3155 in GTK becomes correct. */
3156 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
3157 first_radio = iter;
3158 else if (cur->button_type != BUTTON_TYPE_RADIO
3159 && ! GTK_IS_RADIO_MENU_ITEM (w))
3160 first_radio = 0;
3162 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
3164 if (! menu_separator_name_p (cur->name))
3165 break;
3167 else if (GTK_IS_CHECK_MENU_ITEM (w))
3169 if (cur->button_type != BUTTON_TYPE_TOGGLE)
3170 break;
3171 xg_update_toggle_item (cur, w);
3172 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3174 else if (GTK_IS_RADIO_MENU_ITEM (w))
3176 if (cur->button_type != BUTTON_TYPE_RADIO)
3177 break;
3178 xg_update_radio_item (cur, w);
3179 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3181 else if (GTK_IS_MENU_ITEM (w))
3183 GtkMenuItem *witem = GTK_MENU_ITEM (w);
3184 GtkWidget *sub;
3186 if (cur->button_type != BUTTON_TYPE_NONE ||
3187 menu_separator_name_p (cur->name))
3188 break;
3190 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3192 sub = gtk_menu_item_get_submenu (witem);
3193 if (sub && ! cur->contents)
3195 /* Not a submenu anymore. */
3196 g_object_ref (G_OBJECT (sub));
3197 remove_submenu (witem);
3198 gtk_widget_destroy (sub);
3200 else if (cur->contents)
3202 GtkWidget *nsub;
3204 nsub = xg_update_submenu (sub, f, cur->contents,
3205 select_cb, deactivate_cb,
3206 highlight_cb, cl_data);
3208 /* If this item just became a submenu, we must set it. */
3209 if (nsub != sub)
3210 gtk_menu_item_set_submenu (witem, nsub);
3213 else
3215 /* Structural difference. Remove everything from here and down
3216 in SUBMENU. */
3217 break;
3221 /* Remove widgets from first structural change. */
3222 if (iter)
3224 /* If we are adding new menu items below, we must remove from
3225 first radio button so that radio groups become correct. */
3226 if (cur && first_radio) xg_destroy_widgets (first_radio);
3227 else xg_destroy_widgets (iter);
3230 if (cur)
3232 /* More items added. Create them. */
3233 newsub = create_menus (cur,
3235 select_cb,
3236 deactivate_cb,
3237 highlight_cb,
3240 ! has_tearoff_p,
3241 submenu,
3242 cl_data,
3246 if (list) g_list_free (list);
3248 return newsub;
3251 /* Update the MENUBAR.
3252 F is the frame the menu bar belongs to.
3253 VAL describes the contents of the menu bar.
3254 If DEEP_P is non-zero, rebuild all but the top level menu names in
3255 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
3256 SELECT_CB is the callback to use when a menu item is selected.
3257 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3258 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
3260 void
3261 xg_modify_menubar_widgets (GtkWidget *menubar, FRAME_PTR f, widget_value *val,
3262 int deep_p,
3263 GCallback select_cb, GCallback deactivate_cb,
3264 GCallback highlight_cb)
3266 xg_menu_cb_data *cl_data;
3267 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
3269 if (! list) return;
3271 cl_data = (xg_menu_cb_data*) g_object_get_data (G_OBJECT (menubar),
3272 XG_FRAME_DATA);
3274 xg_update_menubar (menubar, f, &list, list, 0, val->contents,
3275 select_cb, deactivate_cb, highlight_cb, cl_data);
3277 if (deep_p)
3279 widget_value *cur;
3281 /* Update all sub menus.
3282 We must keep the submenus (GTK menu item widgets) since the
3283 X Window in the XEvent that activates the menu are those widgets. */
3285 /* Update cl_data, menu_item things in F may have changed. */
3286 update_cl_data (cl_data, f, highlight_cb);
3288 for (cur = val->contents; cur; cur = cur->next)
3290 GList *iter;
3291 GtkWidget *sub = 0;
3292 GtkWidget *newsub;
3293 GtkMenuItem *witem = 0;
3295 /* Find sub menu that corresponds to val and update it. */
3296 for (iter = list ; iter; iter = g_list_next (iter))
3298 witem = GTK_MENU_ITEM (iter->data);
3299 if (xg_item_label_same_p (witem, cur->name))
3301 sub = gtk_menu_item_get_submenu (witem);
3302 break;
3306 newsub = xg_update_submenu (sub,
3308 cur->contents,
3309 select_cb,
3310 deactivate_cb,
3311 highlight_cb,
3312 cl_data);
3313 /* sub may still be NULL. If we just updated non deep and added
3314 a new menu bar item, it has no sub menu yet. So we set the
3315 newly created sub menu under witem. */
3316 if (newsub != sub && witem != 0)
3318 xg_set_screen (newsub, f);
3319 gtk_menu_item_set_submenu (witem, newsub);
3324 g_list_free (list);
3325 gtk_widget_show_all (menubar);
3328 /* Callback called when the menu bar W is mapped.
3329 Used to find the height of the menu bar if we didn't get it
3330 after showing the widget. */
3332 static void
3333 menubar_map_cb (GtkWidget *w, gpointer user_data)
3335 GtkRequisition req;
3336 FRAME_PTR f = (FRAME_PTR) user_data;
3337 gtk_widget_get_preferred_size (w, NULL, &req);
3338 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3340 FRAME_MENUBAR_HEIGHT (f) = req.height;
3341 xg_height_or_width_changed (f);
3345 /* Recompute all the widgets of frame F, when the menu bar has been
3346 changed. Value is non-zero if widgets were updated. */
3349 xg_update_frame_menubar (FRAME_PTR f)
3351 struct x_output *x = f->output_data.x;
3352 GtkRequisition req;
3354 if (!x->menubar_widget || gtk_widget_get_mapped (x->menubar_widget))
3355 return 0;
3357 if (x->menubar_widget && gtk_widget_get_parent (x->menubar_widget))
3358 return 0; /* Already done this, happens for frames created invisible. */
3360 BLOCK_INPUT;
3362 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
3363 FALSE, FALSE, 0);
3364 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
3366 g_signal_connect (x->menubar_widget, "map", G_CALLBACK (menubar_map_cb), f);
3367 gtk_widget_show_all (x->menubar_widget);
3368 gtk_widget_get_preferred_size (x->menubar_widget, NULL, &req);
3370 /* If menu bar doesn't know its height yet, cheat a little so the frame
3371 doesn't jump so much when resized later in menubar_map_cb. */
3372 if (req.height == 0)
3373 req.height = 23;
3375 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3377 FRAME_MENUBAR_HEIGHT (f) = req.height;
3378 xg_height_or_width_changed (f);
3380 UNBLOCK_INPUT;
3382 return 1;
3385 /* Get rid of the menu bar of frame F, and free its storage.
3386 This is used when deleting a frame, and when turning off the menu bar. */
3388 void
3389 free_frame_menubar (FRAME_PTR f)
3391 struct x_output *x = f->output_data.x;
3393 if (x->menubar_widget)
3395 BLOCK_INPUT;
3397 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
3398 /* The menubar and its children shall be deleted when removed from
3399 the container. */
3400 x->menubar_widget = 0;
3401 FRAME_MENUBAR_HEIGHT (f) = 0;
3402 xg_height_or_width_changed (f);
3403 UNBLOCK_INPUT;
3408 xg_event_is_for_menubar (FRAME_PTR f, XEvent *event)
3410 struct x_output *x = f->output_data.x;
3411 GList *iter;
3412 GdkRectangle rec;
3413 GList *list;
3414 GdkDisplay *gdpy;
3415 GdkWindow *gw;
3416 GdkEvent gevent;
3417 GtkWidget *gwdesc;
3419 if (! x->menubar_widget) return 0;
3421 if (! (event->xbutton.x >= 0
3422 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
3423 && event->xbutton.y >= 0
3424 && event->xbutton.y < f->output_data.x->menubar_height
3425 && event->xbutton.same_screen))
3426 return 0;
3428 gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3429 gw = gdk_x11_window_lookup_for_display (gdpy, event->xbutton.window);
3430 if (! gw) return 0;
3431 gevent.any.window = gw;
3432 gevent.any.type = GDK_NOTHING;
3433 gwdesc = gtk_get_event_widget (&gevent);
3434 if (! gwdesc) return 0;
3435 if (! GTK_IS_MENU_BAR (gwdesc)
3436 && ! GTK_IS_MENU_ITEM (gwdesc)
3437 && ! gtk_widget_is_ancestor (x->menubar_widget, gwdesc))
3438 return 0;
3440 list = gtk_container_get_children (GTK_CONTAINER (x->menubar_widget));
3441 if (! list) return 0;
3442 rec.x = event->xbutton.x;
3443 rec.y = event->xbutton.y;
3444 rec.width = 1;
3445 rec.height = 1;
3447 for (iter = list ; iter; iter = g_list_next (iter))
3449 GtkWidget *w = GTK_WIDGET (iter->data);
3450 if (gtk_widget_get_mapped (w) && gtk_widget_intersect (w, &rec, NULL))
3451 break;
3453 g_list_free (list);
3454 return iter == 0 ? 0 : 1;
3459 /***********************************************************************
3460 Scroll bar functions
3461 ***********************************************************************/
3464 /* Setting scroll bar values invokes the callback. Use this variable
3465 to indicate that callback should do nothing. */
3467 int xg_ignore_gtk_scrollbar;
3469 /* The width of the scroll bar for the current theme. */
3471 static int scroll_bar_width_for_theme;
3473 /* Xlib's `Window' fits in 32 bits. But we want to store pointers, and they
3474 may be larger than 32 bits. Keep a mapping from integer index to widget
3475 pointers to get around the 32 bit limitation. */
3477 static struct
3479 GtkWidget **widgets;
3480 ptrdiff_t max_size;
3481 ptrdiff_t used;
3482 } id_to_widget;
3484 /* Grow this much every time we need to allocate more */
3486 #define ID_TO_WIDGET_INCR 32
3488 /* Store the widget pointer W in id_to_widget and return the integer index. */
3490 static ptrdiff_t
3491 xg_store_widget_in_map (GtkWidget *w)
3493 ptrdiff_t i;
3495 if (id_to_widget.max_size == id_to_widget.used)
3497 ptrdiff_t new_size;
3498 if (TYPE_MAXIMUM (Window) - ID_TO_WIDGET_INCR < id_to_widget.max_size)
3499 memory_full (SIZE_MAX);
3501 new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
3502 id_to_widget.widgets = xnrealloc (id_to_widget.widgets,
3503 new_size, sizeof (GtkWidget *));
3505 for (i = id_to_widget.max_size; i < new_size; ++i)
3506 id_to_widget.widgets[i] = 0;
3507 id_to_widget.max_size = new_size;
3510 /* Just loop over the array and find a free place. After all,
3511 how many scroll bars are we creating? Should be a small number.
3512 The check above guarantees we will find a free place. */
3513 for (i = 0; i < id_to_widget.max_size; ++i)
3515 if (! id_to_widget.widgets[i])
3517 id_to_widget.widgets[i] = w;
3518 ++id_to_widget.used;
3520 return i;
3524 /* Should never end up here */
3525 abort ();
3528 /* Remove pointer at IDX from id_to_widget.
3529 Called when scroll bar is destroyed. */
3531 static void
3532 xg_remove_widget_from_map (ptrdiff_t idx)
3534 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3536 id_to_widget.widgets[idx] = 0;
3537 --id_to_widget.used;
3541 /* Get the widget pointer at IDX from id_to_widget. */
3543 static GtkWidget *
3544 xg_get_widget_from_map (ptrdiff_t idx)
3546 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3547 return id_to_widget.widgets[idx];
3549 return 0;
3552 static void
3553 update_theme_scrollbar_width (void)
3555 #ifdef HAVE_GTK3
3556 GtkAdjustment *vadj;
3557 #else
3558 GtkObject *vadj;
3559 #endif
3560 GtkWidget *wscroll;
3561 int w = 0, b = 0;
3563 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX, 0.1, 0.1, 0.1);
3564 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3565 g_object_ref_sink (G_OBJECT (wscroll));
3566 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3567 gtk_widget_destroy (wscroll);
3568 g_object_unref (G_OBJECT (wscroll));
3569 w += 2*b;
3570 if (w < 16) w = 16;
3571 scroll_bar_width_for_theme = w;
3575 xg_get_default_scrollbar_width (void)
3577 return scroll_bar_width_for_theme;
3580 /* Return the scrollbar id for X Window WID on display DPY.
3581 Return -1 if WID not in id_to_widget. */
3583 ptrdiff_t
3584 xg_get_scroll_id_for_window (Display *dpy, Window wid)
3586 ptrdiff_t idx;
3587 GtkWidget *w;
3589 w = xg_win_to_widget (dpy, wid);
3591 if (w)
3593 for (idx = 0; idx < id_to_widget.max_size; ++idx)
3594 if (id_to_widget.widgets[idx] == w)
3595 return idx;
3598 return -1;
3601 /* Callback invoked when scroll bar WIDGET is destroyed.
3602 DATA is the index into id_to_widget for WIDGET.
3603 We free pointer to last scroll bar values here and remove the index. */
3605 static void
3606 xg_gtk_scroll_destroy (GtkWidget *widget, gpointer data)
3608 intptr_t id = (intptr_t) data;
3609 xg_remove_widget_from_map (id);
3612 /* Create a scroll bar widget for frame F. Store the scroll bar
3613 in BAR.
3614 SCROLL_CALLBACK is the callback to invoke when the value of the
3615 bar changes.
3616 END_CALLBACK is the callback to invoke when scrolling ends.
3617 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
3618 to set resources for the widget. */
3620 void
3621 xg_create_scroll_bar (FRAME_PTR f,
3622 struct scroll_bar *bar,
3623 GCallback scroll_callback,
3624 GCallback end_callback,
3625 const char *scroll_bar_name)
3627 GtkWidget *wscroll;
3628 GtkWidget *webox;
3629 intptr_t scroll_id;
3630 #ifdef HAVE_GTK3
3631 GtkAdjustment *vadj;
3632 #else
3633 GtkObject *vadj;
3634 #endif
3636 /* Page, step increment values are not so important here, they
3637 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3638 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
3639 0.1, 0.1, 0.1);
3641 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3642 webox = gtk_event_box_new ();
3643 gtk_widget_set_name (wscroll, scroll_bar_name);
3644 #ifndef HAVE_GTK3
3645 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3646 #endif
3647 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3649 scroll_id = xg_store_widget_in_map (wscroll);
3651 g_signal_connect (G_OBJECT (wscroll),
3652 "destroy",
3653 G_CALLBACK (xg_gtk_scroll_destroy),
3654 (gpointer) scroll_id);
3655 g_signal_connect (G_OBJECT (wscroll),
3656 "change-value",
3657 scroll_callback,
3658 (gpointer) bar);
3659 g_signal_connect (G_OBJECT (wscroll),
3660 "button-release-event",
3661 end_callback,
3662 (gpointer) bar);
3664 /* The scroll bar widget does not draw on a window of its own. Instead
3665 it draws on the parent window, in this case the edit widget. So
3666 whenever the edit widget is cleared, the scroll bar needs to redraw
3667 also, which causes flicker. Put an event box between the edit widget
3668 and the scroll bar, so the scroll bar instead draws itself on the
3669 event box window. */
3670 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3671 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3674 /* Set the cursor to an arrow. */
3675 xg_set_cursor (webox, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
3677 bar->x_window = scroll_id;
3680 /* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
3682 void
3683 xg_remove_scroll_bar (FRAME_PTR f, ptrdiff_t scrollbar_id)
3685 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3686 if (w)
3688 GtkWidget *wparent = gtk_widget_get_parent (w);
3689 gtk_widget_destroy (w);
3690 gtk_widget_destroy (wparent);
3691 SET_FRAME_GARBAGED (f);
3695 /* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
3696 in frame F.
3697 TOP/LEFT are the new pixel positions where the bar shall appear.
3698 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3700 void
3701 xg_update_scrollbar_pos (FRAME_PTR f,
3702 ptrdiff_t scrollbar_id,
3703 int top,
3704 int left,
3705 int width,
3706 int height)
3709 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3711 if (wscroll)
3713 GtkWidget *wfixed = f->output_data.x->edit_widget;
3714 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3715 gint msl;
3717 /* Clear out old position. */
3718 int oldx = -1, oldy = -1, oldw, oldh;
3719 if (gtk_widget_get_parent (wparent) == wfixed)
3721 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3722 "x", &oldx, "y", &oldy, NULL);
3723 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3726 /* Move and resize to new values. */
3727 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3728 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3729 if (msl > height)
3731 /* No room. Hide scroll bar as some themes output a warning if
3732 the height is less than the min size. */
3733 gtk_widget_hide (wparent);
3734 gtk_widget_hide (wscroll);
3736 else
3738 gtk_widget_show_all (wparent);
3739 gtk_widget_set_size_request (wscroll, width, height);
3741 gtk_widget_queue_draw (wfixed);
3742 gdk_window_process_all_updates ();
3743 if (oldx != -1 && oldw > 0 && oldh > 0)
3745 /* Clear under old scroll bar position. This must be done after
3746 the gtk_widget_queue_draw and gdk_window_process_all_updates
3747 above. */
3748 x_clear_area (FRAME_X_DISPLAY (f),
3749 FRAME_X_WINDOW (f),
3750 oldx, oldy, oldw, oldh, 0);
3753 /* GTK does not redraw until the main loop is entered again, but
3754 if there are no X events pending we will not enter it. So we sync
3755 here to get some events. */
3757 x_sync (f);
3758 SET_FRAME_GARBAGED (f);
3759 cancel_mouse_face (f);
3763 /* Get the current value of the range, truncated to an integer. */
3765 static int
3766 int_gtk_range_get_value (GtkRange *range)
3768 return gtk_range_get_value (range);
3772 /* Set the thumb size and position of scroll bar BAR. We are currently
3773 displaying PORTION out of a whole WHOLE, and our position POSITION. */
3775 void
3776 xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
3777 int portion,
3778 int position,
3779 int whole)
3781 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3783 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3785 if (wscroll && NILP (bar->dragging))
3787 GtkAdjustment *adj;
3788 gdouble shown;
3789 gdouble top;
3790 int size, value;
3791 int old_size;
3792 int new_step;
3793 int changed = 0;
3795 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3797 /* We do the same as for MOTIF in xterm.c, assume 30 chars per line
3798 rather than the real portion value. This makes the thumb less likely
3799 to resize and that looks better. */
3800 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
3801 /* When the thumb is at the bottom, position == whole.
3802 So we need to increase `whole' to make space for the thumb. */
3803 whole += portion;
3805 if (whole <= 0)
3806 top = 0, shown = 1;
3807 else
3809 top = (gdouble) position / whole;
3810 shown = (gdouble) portion / whole;
3813 size = shown * XG_SB_RANGE;
3814 size = min (size, XG_SB_RANGE);
3815 size = max (size, 1);
3817 value = top * XG_SB_RANGE;
3818 value = min (value, XG_SB_MAX - size);
3819 value = max (value, XG_SB_MIN);
3821 /* Assume all lines are of equal size. */
3822 new_step = size / max (1, FRAME_LINES (f));
3824 old_size = gtk_adjustment_get_page_size (adj);
3825 if (old_size != size)
3827 int old_step = gtk_adjustment_get_step_increment (adj);
3828 if (old_step != new_step)
3830 gtk_adjustment_set_page_size (adj, size);
3831 gtk_adjustment_set_step_increment (adj, new_step);
3832 /* Assume a page increment is about 95% of the page size */
3833 gtk_adjustment_set_page_increment (adj, size - size / 20);
3834 changed = 1;
3838 if (changed || int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3840 BLOCK_INPUT;
3842 /* gtk_range_set_value invokes the callback. Set
3843 ignore_gtk_scrollbar to make the callback do nothing */
3844 xg_ignore_gtk_scrollbar = 1;
3846 if (int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3847 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
3848 else if (changed)
3849 gtk_adjustment_changed (adj);
3851 xg_ignore_gtk_scrollbar = 0;
3853 UNBLOCK_INPUT;
3858 /* Return non-zero if EVENT is for a scroll bar in frame F.
3859 When the same X window is used for several Gtk+ widgets, we cannot
3860 say for sure based on the X window alone if an event is for the
3861 frame. This function does additional checks.
3863 Return non-zero if the event is for a scroll bar, zero otherwise. */
3866 xg_event_is_for_scrollbar (FRAME_PTR f, XEvent *event)
3868 int retval = 0;
3870 if (f && event->type == ButtonPress && event->xbutton.button < 4)
3872 /* Check if press occurred outside the edit widget. */
3873 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3874 GdkWindow *gwin;
3875 #ifdef HAVE_GTK3
3876 GdkDevice *gdev = gdk_device_manager_get_client_pointer
3877 (gdk_display_get_device_manager (gdpy));
3878 gwin = gdk_device_get_window_at_position (gdev, NULL, NULL);
3879 #else
3880 gwin = gdk_display_get_window_at_pointer (gdpy, NULL, NULL);
3881 #endif
3882 retval = gwin != gtk_widget_get_window (f->output_data.x->edit_widget);
3884 else if (f
3885 && ((event->type == ButtonRelease && event->xbutton.button < 4)
3886 || event->type == MotionNotify))
3888 /* If we are releasing or moving the scroll bar, it has the grab. */
3889 GtkWidget *w = gtk_grab_get_current ();
3890 retval = w != 0 && GTK_IS_SCROLLBAR (w);
3893 return retval;
3898 /***********************************************************************
3899 Tool bar functions
3900 ***********************************************************************/
3901 /* The key for the data we put in the GtkImage widgets. The data is
3902 the image used by Emacs. We use this to see if we need to update
3903 the GtkImage with a new image. */
3904 #define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
3906 /* The key for storing the latest modifiers so the activate callback can
3907 get them. */
3908 #define XG_TOOL_BAR_LAST_MODIFIER "emacs-tool-bar-modifier"
3910 /* The key for storing the button widget in its proxy menu item. */
3911 #define XG_TOOL_BAR_PROXY_BUTTON "emacs-tool-bar-proxy-button"
3913 /* The key for the data we put in the GtkImage widgets. The data is
3914 the stock name used by Emacs. We use this to see if we need to update
3915 the GtkImage with a new image. */
3916 #define XG_TOOL_BAR_STOCK_NAME "emacs-tool-bar-stock-name"
3918 /* As above, but this is used for named theme widgets, as opposed to
3919 stock items. */
3920 #define XG_TOOL_BAR_ICON_NAME "emacs-tool-bar-icon-name"
3922 /* Callback function invoked when a tool bar item is pressed.
3923 W is the button widget in the tool bar that got pressed,
3924 CLIENT_DATA is an integer that is the index of the button in the
3925 tool bar. 0 is the first button. */
3927 static gboolean
3928 xg_tool_bar_button_cb (GtkWidget *widget,
3929 GdkEventButton *event,
3930 gpointer user_data)
3932 intptr_t state = event->state;
3933 gpointer ptr = (gpointer) state;
3934 g_object_set_data (G_OBJECT (widget), XG_TOOL_BAR_LAST_MODIFIER, ptr);
3935 return FALSE;
3939 /* Callback function invoked when a tool bar item is pressed.
3940 W is the button widget in the tool bar that got pressed,
3941 CLIENT_DATA is an integer that is the index of the button in the
3942 tool bar. 0 is the first button. */
3944 static void
3945 xg_tool_bar_callback (GtkWidget *w, gpointer client_data)
3947 intptr_t idx = (intptr_t) client_data;
3948 gpointer gmod = g_object_get_data (G_OBJECT (w), XG_TOOL_BAR_LAST_MODIFIER);
3949 intptr_t mod = (intptr_t) gmod;
3951 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
3952 Lisp_Object key, frame;
3953 struct input_event event;
3954 EVENT_INIT (event);
3956 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
3957 return;
3959 idx *= TOOL_BAR_ITEM_NSLOTS;
3961 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
3962 XSETFRAME (frame, f);
3964 /* We generate two events here. The first one is to set the prefix
3965 to `(tool_bar)', see keyboard.c. */
3966 event.kind = TOOL_BAR_EVENT;
3967 event.frame_or_window = frame;
3968 event.arg = frame;
3969 kbd_buffer_store_event (&event);
3971 event.kind = TOOL_BAR_EVENT;
3972 event.frame_or_window = frame;
3973 event.arg = key;
3974 /* Convert between the modifier bits GDK uses and the modifier bits
3975 Emacs uses. This assumes GDK and X masks are the same, which they are when
3976 this is written. */
3977 event.modifiers = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), mod);
3978 kbd_buffer_store_event (&event);
3980 /* Return focus to the frame after we have clicked on a detached
3981 tool bar button. */
3982 Fx_focus_frame (frame);
3985 /* Callback function invoked when a tool bar item is pressed in a detached
3986 tool bar or the overflow drop down menu.
3987 We just call xg_tool_bar_callback.
3988 W is the menu item widget that got pressed,
3989 CLIENT_DATA is an integer that is the index of the button in the
3990 tool bar. 0 is the first button. */
3992 static void
3993 xg_tool_bar_proxy_callback (GtkWidget *w, gpointer client_data)
3995 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
3996 XG_TOOL_BAR_PROXY_BUTTON));
3997 xg_tool_bar_callback (wbutton, client_data);
4001 static gboolean
4002 xg_tool_bar_help_callback (GtkWidget *w,
4003 GdkEventCrossing *event,
4004 gpointer client_data);
4006 /* This callback is called when a help is to be shown for an item in
4007 the detached tool bar when the detached tool bar it is not expanded. */
4009 static gboolean
4010 xg_tool_bar_proxy_help_callback (GtkWidget *w,
4011 GdkEventCrossing *event,
4012 gpointer client_data)
4014 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
4015 XG_TOOL_BAR_PROXY_BUTTON));
4017 return xg_tool_bar_help_callback (wbutton, event, client_data);
4020 static GtkWidget *
4021 xg_get_tool_bar_widgets (GtkWidget *vb, GtkWidget **wimage)
4023 GList *clist = gtk_container_get_children (GTK_CONTAINER (vb));
4024 GtkWidget *c1 = (GtkWidget *) clist->data;
4025 GtkWidget *c2 = clist->next ? (GtkWidget *) clist->next->data : NULL;
4027 *wimage = GTK_IS_IMAGE (c1) ? c1 : c2;
4028 g_list_free (clist);
4029 return GTK_IS_LABEL (c1) ? c1 : c2;
4033 /* This callback is called when a tool item should create a proxy item,
4034 such as for the overflow menu. Also called when the tool bar is detached.
4035 If we don't create a proxy menu item, the detached tool bar will be
4036 blank. */
4038 static gboolean
4039 xg_tool_bar_menu_proxy (GtkToolItem *toolitem, gpointer user_data)
4041 GtkButton *wbutton = GTK_BUTTON (XG_BIN_CHILD (XG_BIN_CHILD (toolitem)));
4042 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4043 GtkWidget *c1;
4044 GtkLabel *wlbl = GTK_LABEL (xg_get_tool_bar_widgets (vb, &c1));
4045 GtkImage *wimage = GTK_IMAGE (c1);
4046 GtkWidget *wmenuitem = gtk_image_menu_item_new_with_label
4047 (wlbl ? gtk_label_get_text (wlbl) : "");
4048 GtkWidget *wmenuimage;
4051 if (gtk_button_get_use_stock (wbutton))
4052 wmenuimage = gtk_image_new_from_stock (gtk_button_get_label (wbutton),
4053 GTK_ICON_SIZE_MENU);
4054 else
4056 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (wbutton));
4057 GtkImageType store_type = gtk_image_get_storage_type (wimage);
4059 g_object_set (G_OBJECT (settings), "gtk-menu-images", TRUE, NULL);
4061 if (store_type == GTK_IMAGE_STOCK)
4063 gchar *stock_id;
4064 gtk_image_get_stock (wimage, &stock_id, NULL);
4065 wmenuimage = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
4067 else if (store_type == GTK_IMAGE_ICON_SET)
4069 GtkIconSet *icon_set;
4070 gtk_image_get_icon_set (wimage, &icon_set, NULL);
4071 wmenuimage = gtk_image_new_from_icon_set (icon_set,
4072 GTK_ICON_SIZE_MENU);
4074 else if (store_type == GTK_IMAGE_PIXBUF)
4076 gint width, height;
4078 if (settings &&
4079 gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
4080 &width, &height))
4082 GdkPixbuf *src_pixbuf, *dest_pixbuf;
4084 src_pixbuf = gtk_image_get_pixbuf (wimage);
4085 dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
4086 GDK_INTERP_BILINEAR);
4088 wmenuimage = gtk_image_new_from_pixbuf (dest_pixbuf);
4090 else
4092 fprintf (stderr, "internal error: GTK_IMAGE_PIXBUF failed\n");
4093 abort ();
4096 else if (store_type == GTK_IMAGE_ICON_NAME)
4098 const gchar *icon_name;
4099 GtkIconSize icon_size;
4101 gtk_image_get_icon_name (wimage, &icon_name, &icon_size);
4102 wmenuimage = gtk_image_new_from_icon_name (icon_name,
4103 GTK_ICON_SIZE_MENU);
4105 else
4107 fprintf (stderr, "internal error: store_type is %d\n", store_type);
4108 abort ();
4111 if (wmenuimage)
4112 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (wmenuitem), wmenuimage);
4114 g_signal_connect (G_OBJECT (wmenuitem),
4115 "activate",
4116 G_CALLBACK (xg_tool_bar_proxy_callback),
4117 user_data);
4120 g_object_set_data (G_OBJECT (wmenuitem), XG_TOOL_BAR_PROXY_BUTTON,
4121 (gpointer) wbutton);
4122 gtk_tool_item_set_proxy_menu_item (toolitem, "Emacs toolbar item", wmenuitem);
4123 gtk_widget_set_sensitive (wmenuitem,
4124 gtk_widget_get_sensitive (GTK_WIDGET (wbutton)));
4126 /* Use enter/leave notify to show help. We use the events
4127 rather than the GtkButton specific signals "enter" and
4128 "leave", so we can have only one callback. The event
4129 will tell us what kind of event it is. */
4130 g_signal_connect (G_OBJECT (wmenuitem),
4131 "enter-notify-event",
4132 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4133 user_data);
4134 g_signal_connect (G_OBJECT (wmenuitem),
4135 "leave-notify-event",
4136 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4137 user_data);
4139 return TRUE;
4142 /* This callback is called when a tool bar is detached. We must set
4143 the height of the tool bar to zero when this happens so frame sizes
4144 are correctly calculated.
4145 WBOX is the handle box widget that enables detach/attach of the tool bar.
4146 W is the tool bar widget.
4147 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4149 static void
4150 xg_tool_bar_detach_callback (GtkHandleBox *wbox,
4151 GtkWidget *w,
4152 gpointer client_data)
4154 FRAME_PTR f = (FRAME_PTR) client_data;
4156 g_object_set (G_OBJECT (w), "show-arrow", !x_gtk_whole_detached_tool_bar,
4157 NULL);
4159 if (f)
4161 GtkRequisition req, req2;
4162 FRAME_X_OUTPUT (f)->toolbar_detached = 1;
4163 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4164 gtk_widget_get_preferred_size (w, NULL, &req2);
4165 req.width -= req2.width;
4166 req.height -= req2.height;
4167 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4168 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4169 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4170 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4171 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4172 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4173 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4174 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4175 xg_height_or_width_changed (f);
4179 /* This callback is called when a tool bar is reattached. We must set
4180 the height of the tool bar when this happens so frame sizes
4181 are correctly calculated.
4182 WBOX is the handle box widget that enables detach/attach of the tool bar.
4183 W is the tool bar widget.
4184 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4186 static void
4187 xg_tool_bar_attach_callback (GtkHandleBox *wbox,
4188 GtkWidget *w,
4189 gpointer client_data)
4191 FRAME_PTR f = (FRAME_PTR) client_data;
4192 g_object_set (G_OBJECT (w), "show-arrow", TRUE, NULL);
4194 if (f)
4196 GtkRequisition req, req2;
4197 FRAME_X_OUTPUT (f)->toolbar_detached = 0;
4198 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4199 gtk_widget_get_preferred_size (w, NULL, &req2);
4200 req.width += req2.width;
4201 req.height += req2.height;
4202 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4203 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4204 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4205 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4206 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4207 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4208 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4209 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4210 xg_height_or_width_changed (f);
4214 /* This callback is called when the mouse enters or leaves a tool bar item.
4215 It is used for displaying and hiding the help text.
4216 W is the tool bar item, a button.
4217 EVENT is either an enter event or leave event.
4218 CLIENT_DATA is an integer that is the index of the button in the
4219 tool bar. 0 is the first button.
4221 Returns FALSE to tell GTK to keep processing this event. */
4223 static gboolean
4224 xg_tool_bar_help_callback (GtkWidget *w,
4225 GdkEventCrossing *event,
4226 gpointer client_data)
4228 intptr_t idx = (intptr_t) client_data;
4229 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4230 Lisp_Object help, frame;
4232 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4233 return FALSE;
4235 if (event->type == GDK_ENTER_NOTIFY)
4237 idx *= TOOL_BAR_ITEM_NSLOTS;
4238 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
4240 if (NILP (help))
4241 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
4243 else
4244 help = Qnil;
4246 XSETFRAME (frame, f);
4247 kbd_buffer_store_help_event (frame, help);
4249 return FALSE;
4253 /* This callback is called when a tool bar item shall be redrawn.
4254 It modifies the expose event so that the GtkImage widget redraws the
4255 whole image. This to overcome a bug that makes GtkImage draw the image
4256 in the wrong place when it tries to redraw just a part of the image.
4257 W is the GtkImage to be redrawn.
4258 EVENT is the expose event for W.
4259 CLIENT_DATA is unused.
4261 Returns FALSE to tell GTK to keep processing this event. */
4263 #ifndef HAVE_GTK3
4264 static gboolean
4265 xg_tool_bar_item_expose_callback (GtkWidget *w,
4266 GdkEventExpose *event,
4267 gpointer client_data)
4269 gint width, height;
4271 gdk_drawable_get_size (event->window, &width, &height);
4272 event->area.x -= width > event->area.width ? width-event->area.width : 0;
4273 event->area.y -= height > event->area.height ? height-event->area.height : 0;
4275 event->area.x = max (0, event->area.x);
4276 event->area.y = max (0, event->area.y);
4278 event->area.width = max (width, event->area.width);
4279 event->area.height = max (height, event->area.height);
4281 return FALSE;
4283 #endif
4285 #ifdef HAVE_GTK_ORIENTABLE_SET_ORIENTATION
4286 #define toolbar_set_orientation(w, o) \
4287 gtk_orientable_set_orientation (GTK_ORIENTABLE (w), o)
4288 #else
4289 #define toolbar_set_orientation(w, o) \
4290 gtk_toolbar_set_orientation (GTK_TOOLBAR (w), o)
4291 #endif
4293 /* Attach a tool bar to frame F. */
4295 static void
4296 xg_pack_tool_bar (FRAME_PTR f, Lisp_Object pos)
4298 struct x_output *x = f->output_data.x;
4299 int into_hbox = EQ (pos, Qleft) || EQ (pos, Qright);
4301 toolbar_set_orientation (x->toolbar_widget,
4302 into_hbox
4303 ? GTK_ORIENTATION_VERTICAL
4304 : GTK_ORIENTATION_HORIZONTAL);
4305 if (!x->handlebox_widget)
4307 x->handlebox_widget = gtk_handle_box_new ();
4308 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-detached",
4309 G_CALLBACK (xg_tool_bar_detach_callback), f);
4310 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-attached",
4311 G_CALLBACK (xg_tool_bar_attach_callback), f);
4312 gtk_container_add (GTK_CONTAINER (x->handlebox_widget),
4313 x->toolbar_widget);
4316 if (into_hbox)
4318 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4319 GTK_POS_TOP);
4320 gtk_box_pack_start (GTK_BOX (x->hbox_widget), x->handlebox_widget,
4321 FALSE, FALSE, 0);
4323 if (EQ (pos, Qleft))
4324 gtk_box_reorder_child (GTK_BOX (x->hbox_widget),
4325 x->handlebox_widget,
4327 x->toolbar_in_hbox = 1;
4329 else
4331 int vbox_pos = x->menubar_widget ? 1 : 0;
4332 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4333 GTK_POS_LEFT);
4334 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->handlebox_widget,
4335 FALSE, FALSE, 0);
4337 if (EQ (pos, Qtop))
4338 gtk_box_reorder_child (GTK_BOX (x->vbox_widget),
4339 x->handlebox_widget,
4340 vbox_pos);
4341 x->toolbar_in_hbox = 0;
4345 /* Create a tool bar for frame F. */
4347 static void
4348 xg_create_tool_bar (FRAME_PTR f)
4350 struct x_output *x = f->output_data.x;
4351 #if GTK_CHECK_VERSION (3, 3, 6)
4352 GtkStyleContext *gsty;
4353 #endif
4354 struct xg_frame_tb_info *tbinfo
4355 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4356 TB_INFO_KEY);
4357 if (! tbinfo)
4359 tbinfo = xmalloc (sizeof (*tbinfo));
4360 tbinfo->last_tool_bar = Qnil;
4361 tbinfo->style = Qnil;
4362 tbinfo->hmargin = tbinfo->vmargin = 0;
4363 tbinfo->dir = GTK_TEXT_DIR_NONE;
4364 tbinfo->n_last_items = 0;
4365 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4366 TB_INFO_KEY,
4367 tbinfo);
4370 x->toolbar_widget = gtk_toolbar_new ();
4371 x->toolbar_detached = 0;
4373 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
4375 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
4376 toolbar_set_orientation (x->toolbar_widget, GTK_ORIENTATION_HORIZONTAL);
4377 #if GTK_CHECK_VERSION (3, 3, 6)
4378 gsty = gtk_widget_get_style_context (x->toolbar_widget);
4379 gtk_style_context_add_class (gsty, "primary-toolbar");
4380 #endif
4384 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
4386 /* Find the right-to-left image named by RTL in the tool bar images for F.
4387 Returns IMAGE if RTL is not found. */
4389 static Lisp_Object
4390 find_rtl_image (FRAME_PTR f, Lisp_Object image, Lisp_Object rtl)
4392 int i;
4393 Lisp_Object file, rtl_name;
4394 struct gcpro gcpro1, gcpro2;
4395 GCPRO2 (file, rtl_name);
4397 rtl_name = Ffile_name_nondirectory (rtl);
4399 for (i = 0; i < f->n_tool_bar_items; ++i)
4401 Lisp_Object rtl_image = PROP (TOOL_BAR_ITEM_IMAGES);
4402 if (!NILP (file = file_for_image (rtl_image)))
4404 file = call1 (intern ("file-name-sans-extension"),
4405 Ffile_name_nondirectory (file));
4406 if (! NILP (Fequal (file, rtl_name)))
4408 image = rtl_image;
4409 break;
4414 return image;
4417 static GtkToolItem *
4418 xg_make_tool_item (FRAME_PTR f,
4419 GtkWidget *wimage,
4420 GtkWidget **wbutton,
4421 const char *label,
4422 int i, int horiz, int text_image)
4424 GtkToolItem *ti = gtk_tool_item_new ();
4425 GtkWidget *vb = gtk_box_new (horiz
4426 ? GTK_ORIENTATION_HORIZONTAL
4427 : GTK_ORIENTATION_VERTICAL,
4429 GtkWidget *wb = gtk_button_new ();
4430 /* The eventbox is here so we can have tooltips on disabled items. */
4431 GtkWidget *weventbox = gtk_event_box_new ();
4432 #if GTK_CHECK_VERSION (3, 3, 6)
4433 GtkCssProvider *css_prov = gtk_css_provider_new ();
4434 GtkStyleContext *gsty;
4436 gtk_css_provider_load_from_data (css_prov,
4437 "GtkEventBox {"
4438 " background-color: transparent;"
4439 "}",
4440 -1, NULL);
4442 gsty = gtk_widget_get_style_context (weventbox);
4443 gtk_style_context_add_provider (gsty,
4444 GTK_STYLE_PROVIDER (css_prov),
4445 GTK_STYLE_PROVIDER_PRIORITY_USER);
4446 g_object_unref (css_prov);
4447 #endif
4449 gtk_box_set_homogeneous (GTK_BOX (vb), FALSE);
4451 if (wimage && !text_image)
4452 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4453 if (label)
4454 gtk_box_pack_start (GTK_BOX (vb), gtk_label_new (label), TRUE, TRUE, 0);
4455 if (wimage && text_image)
4456 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4458 gtk_button_set_focus_on_click (GTK_BUTTON (wb), FALSE);
4459 gtk_button_set_relief (GTK_BUTTON (wb), GTK_RELIEF_NONE);
4460 gtk_container_add (GTK_CONTAINER (wb), vb);
4461 gtk_container_add (GTK_CONTAINER (weventbox), wb);
4462 gtk_container_add (GTK_CONTAINER (ti), weventbox);
4464 if (wimage || label)
4466 intptr_t ii = i;
4467 gpointer gi = (gpointer) ii;
4469 g_signal_connect (G_OBJECT (ti), "create-menu-proxy",
4470 G_CALLBACK (xg_tool_bar_menu_proxy),
4471 gi);
4473 g_signal_connect (G_OBJECT (wb), "clicked",
4474 G_CALLBACK (xg_tool_bar_callback),
4475 gi);
4477 g_object_set_data (G_OBJECT (weventbox), XG_FRAME_DATA, (gpointer)f);
4479 #ifndef HAVE_GTK3
4480 /* Catch expose events to overcome an annoying redraw bug, see
4481 comment for xg_tool_bar_item_expose_callback. */
4482 g_signal_connect (G_OBJECT (ti),
4483 "expose-event",
4484 G_CALLBACK (xg_tool_bar_item_expose_callback),
4486 #endif
4487 gtk_tool_item_set_homogeneous (ti, FALSE);
4489 /* Callback to save modifier mask (Shift/Control, etc). GTK makes
4490 no distinction based on modifiers in the activate callback,
4491 so we have to do it ourselves. */
4492 g_signal_connect (wb, "button-release-event",
4493 G_CALLBACK (xg_tool_bar_button_cb),
4494 NULL);
4496 g_object_set_data (G_OBJECT (wb), XG_FRAME_DATA, (gpointer)f);
4498 /* Use enter/leave notify to show help. We use the events
4499 rather than the GtkButton specific signals "enter" and
4500 "leave", so we can have only one callback. The event
4501 will tell us what kind of event it is. */
4502 g_signal_connect (G_OBJECT (weventbox),
4503 "enter-notify-event",
4504 G_CALLBACK (xg_tool_bar_help_callback),
4505 gi);
4506 g_signal_connect (G_OBJECT (weventbox),
4507 "leave-notify-event",
4508 G_CALLBACK (xg_tool_bar_help_callback),
4509 gi);
4512 if (wbutton) *wbutton = wb;
4514 return ti;
4517 static int
4518 is_box_type (GtkWidget *vb, int is_horizontal)
4520 #ifdef HAVE_GTK3
4521 int ret = 0;
4522 if (GTK_IS_BOX (vb))
4524 GtkOrientation ori = gtk_orientable_get_orientation (GTK_ORIENTABLE (vb));
4525 ret = (ori == GTK_ORIENTATION_HORIZONTAL && is_horizontal)
4526 || (ori == GTK_ORIENTATION_VERTICAL && ! is_horizontal);
4528 return ret;
4529 #else
4530 return is_horizontal ? GTK_IS_VBOX (vb) : GTK_IS_HBOX (vb);
4531 #endif
4535 static int
4536 xg_tool_item_stale_p (GtkWidget *wbutton, const char *stock_name,
4537 const char *icon_name, const struct image *img,
4538 const char *label, int horiz)
4540 gpointer old;
4541 GtkWidget *wimage;
4542 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4543 GtkWidget *wlbl = xg_get_tool_bar_widgets (vb, &wimage);
4545 /* Check if the tool icon matches. */
4546 if (stock_name && wimage)
4548 old = g_object_get_data (G_OBJECT (wimage),
4549 XG_TOOL_BAR_STOCK_NAME);
4550 if (!old || strcmp (old, stock_name))
4551 return 1;
4553 else if (icon_name && wimage)
4555 old = g_object_get_data (G_OBJECT (wimage),
4556 XG_TOOL_BAR_ICON_NAME);
4557 if (!old || strcmp (old, icon_name))
4558 return 1;
4560 else if (wimage)
4562 gpointer gold_img = g_object_get_data (G_OBJECT (wimage),
4563 XG_TOOL_BAR_IMAGE_DATA);
4564 Pixmap old_img = (Pixmap) gold_img;
4565 if (old_img != img->pixmap)
4566 return 1;
4569 /* Check button configuration and label. */
4570 if (is_box_type (vb, horiz)
4571 || (label ? (wlbl == NULL) : (wlbl != NULL)))
4572 return 1;
4574 /* Ensure label is correct. */
4575 if (label && wlbl)
4576 gtk_label_set_text (GTK_LABEL (wlbl), label);
4577 return 0;
4580 static int
4581 xg_update_tool_bar_sizes (FRAME_PTR f)
4583 struct x_output *x = f->output_data.x;
4584 GtkRequisition req;
4585 int nl = 0, nr = 0, nt = 0, nb = 0;
4587 gtk_widget_get_preferred_size (GTK_WIDGET (x->handlebox_widget), NULL, &req);
4588 if (x->toolbar_in_hbox)
4590 int pos;
4591 gtk_container_child_get (GTK_CONTAINER (x->hbox_widget),
4592 x->handlebox_widget,
4593 "position", &pos, NULL);
4594 if (pos == 0) nl = req.width;
4595 else nr = req.width;
4597 else
4599 int pos;
4600 gtk_container_child_get (GTK_CONTAINER (x->vbox_widget),
4601 x->handlebox_widget,
4602 "position", &pos, NULL);
4603 if (pos == 0 || (pos == 1 && x->menubar_widget)) nt = req.height;
4604 else nb = req.height;
4607 if (nl != FRAME_TOOLBAR_LEFT_WIDTH (f)
4608 || nr != FRAME_TOOLBAR_RIGHT_WIDTH (f)
4609 || nt != FRAME_TOOLBAR_TOP_HEIGHT (f)
4610 || nb != FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
4612 FRAME_TOOLBAR_RIGHT_WIDTH (f) = FRAME_TOOLBAR_LEFT_WIDTH (f)
4613 = FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4614 FRAME_TOOLBAR_LEFT_WIDTH (f) = nl;
4615 FRAME_TOOLBAR_RIGHT_WIDTH (f) = nr;
4616 FRAME_TOOLBAR_TOP_HEIGHT (f) = nt;
4617 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = nb;
4618 return 1;
4621 return 0;
4625 /* Update the tool bar for frame F. Add new buttons and remove old. */
4627 void
4628 update_frame_tool_bar (FRAME_PTR f)
4630 int i, j;
4631 struct x_output *x = f->output_data.x;
4632 int hmargin = 0, vmargin = 0;
4633 GtkToolbar *wtoolbar;
4634 GtkToolItem *ti;
4635 GtkTextDirection dir;
4636 int pack_tool_bar = x->handlebox_widget == NULL;
4637 Lisp_Object style;
4638 int text_image, horiz;
4639 struct xg_frame_tb_info *tbinfo;
4641 if (! FRAME_GTK_WIDGET (f))
4642 return;
4644 BLOCK_INPUT;
4646 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
4648 hmargin = XFASTINT (Vtool_bar_button_margin);
4649 vmargin = XFASTINT (Vtool_bar_button_margin);
4651 else if (CONSP (Vtool_bar_button_margin))
4653 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin), INT_MAX))
4654 hmargin = XFASTINT (XCAR (Vtool_bar_button_margin));
4656 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
4657 vmargin = XFASTINT (XCDR (Vtool_bar_button_margin));
4660 /* The natural size (i.e. when GTK uses 0 as margin) looks best,
4661 so take DEFAULT_TOOL_BAR_BUTTON_MARGIN to mean "default for GTK",
4662 i.e. zero. This means that margins less than
4663 DEFAULT_TOOL_BAR_BUTTON_MARGIN has no effect. */
4664 hmargin = max (0, hmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4665 vmargin = max (0, vmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4667 if (! x->toolbar_widget)
4668 xg_create_tool_bar (f);
4670 wtoolbar = GTK_TOOLBAR (x->toolbar_widget);
4671 dir = gtk_widget_get_direction (GTK_WIDGET (wtoolbar));
4673 style = Ftool_bar_get_system_style ();
4675 /* Are we up to date? */
4676 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4677 TB_INFO_KEY);
4679 if (! NILP (tbinfo->last_tool_bar) && ! NILP (f->tool_bar_items)
4680 && tbinfo->n_last_items == f->n_tool_bar_items
4681 && tbinfo->hmargin == hmargin && tbinfo->vmargin == vmargin
4682 && tbinfo->dir == dir
4683 && ! NILP (Fequal (tbinfo->style, style))
4684 && ! NILP (Fequal (tbinfo->last_tool_bar, f->tool_bar_items)))
4686 UNBLOCK_INPUT;
4687 return;
4690 tbinfo->last_tool_bar = f->tool_bar_items;
4691 tbinfo->n_last_items = f->n_tool_bar_items;
4692 tbinfo->style = style;
4693 tbinfo->hmargin = hmargin;
4694 tbinfo->vmargin = vmargin;
4695 tbinfo->dir = dir;
4697 text_image = EQ (style, Qtext_image_horiz);
4698 horiz = EQ (style, Qboth_horiz) || text_image;
4700 for (i = j = 0; i < f->n_tool_bar_items; ++i)
4702 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
4703 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
4704 int idx;
4705 ptrdiff_t img_id;
4706 int icon_size = 0;
4707 struct image *img = NULL;
4708 Lisp_Object image;
4709 Lisp_Object stock = Qnil;
4710 GtkStockItem stock_item;
4711 char *stock_name = NULL;
4712 char *icon_name = NULL;
4713 Lisp_Object rtl;
4714 GtkWidget *wbutton = NULL;
4715 Lisp_Object specified_file;
4716 int vert_only = ! NILP (PROP (TOOL_BAR_ITEM_VERT_ONLY));
4717 const char *label
4718 = (EQ (style, Qimage) || (vert_only && horiz)) ? NULL
4719 : STRINGP (PROP (TOOL_BAR_ITEM_LABEL))
4720 ? SSDATA (PROP (TOOL_BAR_ITEM_LABEL))
4721 : "";
4723 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4725 /* If this is a separator, use a gtk separator item. */
4726 if (EQ (PROP (TOOL_BAR_ITEM_TYPE), Qt))
4728 if (ti == NULL || !GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4730 if (ti)
4731 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4732 GTK_WIDGET (ti));
4733 ti = gtk_separator_tool_item_new ();
4734 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4736 j++;
4737 continue;
4740 /* Otherwise, the tool-bar item is an ordinary button. */
4742 if (ti && GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4744 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4745 ti = NULL;
4748 if (ti) wbutton = XG_BIN_CHILD (XG_BIN_CHILD (ti));
4750 /* Ignore invalid image specifications. */
4751 image = PROP (TOOL_BAR_ITEM_IMAGES);
4752 if (!valid_image_p (image))
4754 if (ti)
4755 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4756 GTK_WIDGET (ti));
4757 continue;
4760 specified_file = file_for_image (image);
4761 if (!NILP (specified_file) && !NILP (Ffboundp (Qx_gtk_map_stock)))
4762 stock = call1 (Qx_gtk_map_stock, specified_file);
4764 if (STRINGP (stock))
4766 stock_name = SSDATA (stock);
4767 if (stock_name[0] == 'n' && stock_name[1] == ':')
4769 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (wtoolbar));
4770 GtkIconTheme *icon_theme = gtk_icon_theme_get_for_screen (screen);
4772 icon_name = stock_name + 2;
4773 stock_name = NULL;
4774 stock = Qnil;
4776 if (! gtk_icon_theme_has_icon (icon_theme, icon_name))
4777 icon_name = NULL;
4778 else
4779 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4781 else if (gtk_stock_lookup (SSDATA (stock), &stock_item))
4782 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4783 else
4785 stock = Qnil;
4786 stock_name = NULL;
4790 if (stock_name == NULL && icon_name == NULL)
4792 /* No stock image, or stock item not known. Try regular
4793 image. If image is a vector, choose it according to the
4794 button state. */
4795 if (dir == GTK_TEXT_DIR_RTL
4796 && !NILP (rtl = PROP (TOOL_BAR_ITEM_RTL_IMAGE))
4797 && STRINGP (rtl))
4798 image = find_rtl_image (f, image, rtl);
4800 if (VECTORP (image))
4802 if (enabled_p)
4803 idx = (selected_p
4804 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
4805 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
4806 else
4807 idx = (selected_p
4808 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
4809 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
4811 eassert (ASIZE (image) >= idx);
4812 image = AREF (image, idx);
4814 else
4815 idx = -1;
4817 img_id = lookup_image (f, image);
4818 img = IMAGE_FROM_ID (f, img_id);
4819 prepare_image_for_display (f, img);
4821 if (img->load_failed_p || img->pixmap == None)
4823 if (ti)
4824 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4825 GTK_WIDGET (ti));
4826 continue;
4830 /* If there is an existing widget, check if it's stale; if so,
4831 remove it and make a new tool item from scratch. */
4832 if (ti && xg_tool_item_stale_p (wbutton, stock_name, icon_name,
4833 img, label, horiz))
4835 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4836 GTK_WIDGET (ti));
4837 ti = NULL;
4840 if (ti == NULL)
4842 GtkWidget *w;
4844 /* Save the image so we can see if an update is needed the
4845 next time we call xg_tool_item_match_p. */
4846 if (EQ (style, Qtext))
4847 w = NULL;
4848 else if (stock_name)
4850 w = gtk_image_new_from_stock (stock_name, icon_size);
4851 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_STOCK_NAME,
4852 (gpointer) xstrdup (stock_name),
4853 (GDestroyNotify) xfree);
4855 else if (icon_name)
4857 w = gtk_image_new_from_icon_name (icon_name, icon_size);
4858 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_ICON_NAME,
4859 (gpointer) xstrdup (icon_name),
4860 (GDestroyNotify) xfree);
4862 else
4864 w = xg_get_image_for_pixmap (f, img, x->widget, NULL);
4865 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
4866 (gpointer)img->pixmap);
4869 if (w) gtk_misc_set_padding (GTK_MISC (w), hmargin, vmargin);
4870 ti = xg_make_tool_item (f, w, &wbutton, label, i, horiz, text_image);
4871 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4874 #undef PROP
4876 gtk_widget_set_sensitive (wbutton, enabled_p);
4877 j++;
4880 /* Remove buttons not longer needed. */
4883 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4884 if (ti)
4885 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4886 } while (ti != NULL);
4888 if (f->n_tool_bar_items != 0)
4890 if (pack_tool_bar)
4891 xg_pack_tool_bar (f, f->tool_bar_position);
4892 gtk_widget_show_all (GTK_WIDGET (x->handlebox_widget));
4893 if (xg_update_tool_bar_sizes (f))
4894 xg_height_or_width_changed (f);
4897 UNBLOCK_INPUT;
4900 /* Deallocate all resources for the tool bar on frame F.
4901 Remove the tool bar. */
4903 void
4904 free_frame_tool_bar (FRAME_PTR f)
4906 struct x_output *x = f->output_data.x;
4908 if (x->toolbar_widget)
4910 struct xg_frame_tb_info *tbinfo;
4911 int is_packed = x->handlebox_widget != 0;
4912 BLOCK_INPUT;
4913 /* We may have created the toolbar_widget in xg_create_tool_bar, but
4914 not the x->handlebox_widget which is created in xg_pack_tool_bar. */
4915 if (is_packed)
4917 if (x->toolbar_in_hbox)
4918 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4919 x->handlebox_widget);
4920 else
4921 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4922 x->handlebox_widget);
4924 else
4925 gtk_widget_destroy (x->toolbar_widget);
4927 x->toolbar_widget = 0;
4928 x->handlebox_widget = 0;
4929 FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4930 FRAME_TOOLBAR_LEFT_WIDTH (f) = FRAME_TOOLBAR_RIGHT_WIDTH (f) = 0;
4932 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4933 TB_INFO_KEY);
4934 if (tbinfo)
4936 xfree (tbinfo);
4937 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4938 TB_INFO_KEY,
4939 NULL);
4942 xg_height_or_width_changed (f);
4944 UNBLOCK_INPUT;
4949 xg_change_toolbar_position (FRAME_PTR f, Lisp_Object pos)
4951 struct x_output *x = f->output_data.x;
4953 if (! x->toolbar_widget || ! x->handlebox_widget)
4954 return 1;
4956 BLOCK_INPUT;
4957 g_object_ref (x->handlebox_widget);
4958 if (x->toolbar_in_hbox)
4959 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4960 x->handlebox_widget);
4961 else
4962 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4963 x->handlebox_widget);
4964 xg_pack_tool_bar (f, pos);
4965 g_object_unref (x->handlebox_widget);
4966 if (xg_update_tool_bar_sizes (f))
4967 xg_height_or_width_changed (f);
4969 UNBLOCK_INPUT;
4970 return 1;
4975 /***********************************************************************
4976 Initializing
4977 ***********************************************************************/
4978 void
4979 xg_initialize (void)
4981 GtkBindingSet *binding_set;
4982 GtkSettings *settings;
4984 #if HAVE_XFT
4985 /* Work around a bug with corrupted data if libXft gets unloaded. This way
4986 we keep it permanently linked in. */
4987 XftInit (0);
4988 #endif
4990 gdpy_def = NULL;
4991 xg_ignore_gtk_scrollbar = 0;
4992 xg_detached_menus = 0;
4993 xg_menu_cb_list.prev = xg_menu_cb_list.next =
4994 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
4996 id_to_widget.max_size = id_to_widget.used = 0;
4997 id_to_widget.widgets = 0;
4999 settings = gtk_settings_get_for_screen (gdk_display_get_default_screen
5000 (gdk_display_get_default ()));
5001 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
5002 bindings. It doesn't seem to be any way to remove properties,
5003 so we set it to VoidSymbol which in X means "no key". */
5004 gtk_settings_set_string_property (settings,
5005 "gtk-menu-bar-accel",
5006 "VoidSymbol",
5007 EMACS_CLASS);
5009 /* Make GTK text input widgets use Emacs style keybindings. This is
5010 Emacs after all. */
5011 gtk_settings_set_string_property (settings,
5012 "gtk-key-theme-name",
5013 "Emacs",
5014 EMACS_CLASS);
5016 /* Make dialogs close on C-g. Since file dialog inherits from
5017 dialog, this works for them also. */
5018 binding_set = gtk_binding_set_by_class (g_type_class_ref (GTK_TYPE_DIALOG));
5019 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5020 "close", 0);
5022 /* Make menus close on C-g. */
5023 binding_set = gtk_binding_set_by_class (g_type_class_ref
5024 (GTK_TYPE_MENU_SHELL));
5025 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5026 "cancel", 0);
5027 update_theme_scrollbar_width ();
5029 x_last_font_name = NULL;
5032 #endif /* USE_GTK */