* doc/misc/calc.texi (ISO-8601): New section.
[emacs.git] / src / gtkutil.c
blob9f2b652525ffa4b0cc79b0d54de3fd8e880dad1f
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 <stdio.h>
26 #include <c-ctype.h>
28 #include "lisp.h"
29 #include "xterm.h"
30 #include "blockinput.h"
31 #include "syssignal.h"
32 #include "window.h"
33 #include "gtkutil.h"
34 #include "termhooks.h"
35 #include "keyboard.h"
36 #include "charset.h"
37 #include "coding.h"
38 #include <gdk/gdkkeysyms.h>
39 #include "xsettings.h"
41 #ifdef HAVE_XFT
42 #include <X11/Xft/Xft.h>
43 #endif
45 #ifdef HAVE_GTK3
46 #include <gtk/gtkx.h>
47 #include "emacsgtkfixed.h"
48 #endif
50 #define FRAME_TOTAL_PIXEL_HEIGHT(f) \
51 (FRAME_PIXEL_HEIGHT (f) + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
53 #define FRAME_TOTAL_PIXEL_WIDTH(f) \
54 (FRAME_PIXEL_WIDTH (f) + FRAME_TOOLBAR_WIDTH (f))
56 #ifndef HAVE_GTK_WIDGET_SET_HAS_WINDOW
57 #define gtk_widget_set_has_window(w, b) \
58 (gtk_fixed_set_has_window (GTK_FIXED (w), b))
59 #endif
60 #ifndef HAVE_GTK_DIALOG_GET_ACTION_AREA
61 #define gtk_dialog_get_action_area(w) ((w)->action_area)
62 #define gtk_dialog_get_content_area(w) ((w)->vbox)
63 #endif
64 #ifndef HAVE_GTK_WIDGET_GET_SENSITIVE
65 #define gtk_widget_get_sensitive(w) (GTK_WIDGET_SENSITIVE (w))
66 #endif
67 #ifndef HAVE_GTK_ADJUSTMENT_GET_PAGE_SIZE
68 #define gtk_adjustment_set_page_size(w, s) ((w)->page_size = (s))
69 #define gtk_adjustment_set_page_increment(w, s) ((w)->page_increment = (s))
70 #define gtk_adjustment_get_step_increment(w) ((w)->step_increment)
71 #define gtk_adjustment_set_step_increment(w, s) ((w)->step_increment = (s))
72 #endif
73 #if GTK_MAJOR_VERSION > 2 || GTK_MINOR_VERSION > 11
74 #define remove_submenu(w) gtk_menu_item_set_submenu ((w), NULL)
75 #else
76 #define remove_submenu(w) gtk_menu_item_remove_submenu ((w))
77 #endif
79 #if GTK_MAJOR_VERSION > 3 || (GTK_MAJOR_VERSION == 3 && GTK_MINOR_VERSION >= 2)
80 #define USE_NEW_GTK_FONT_CHOOSER 1
81 #else
82 #define USE_NEW_GTK_FONT_CHOOSER 0
83 #define gtk_font_chooser_dialog_new(x, y) \
84 gtk_font_selection_dialog_new (x)
85 #undef GTK_FONT_CHOOSER
86 #define GTK_FONT_CHOOSER(x) GTK_FONT_SELECTION_DIALOG (x)
87 #define gtk_font_chooser_set_font(x, y) \
88 gtk_font_selection_dialog_set_font_name (x, y)
89 #endif
91 #ifndef HAVE_GTK3
92 #ifdef USE_GTK_TOOLTIP
93 #define gdk_window_get_screen(w) gdk_drawable_get_screen (w)
94 #endif
95 #define gdk_window_get_geometry(w, a, b, c, d) \
96 gdk_window_get_geometry (w, a, b, c, d, 0)
97 #define gdk_x11_window_lookup_for_display(d, w) \
98 gdk_xid_table_lookup_for_display (d, w)
99 #define gtk_box_new(ori, spacing) \
100 ((ori) == GTK_ORIENTATION_HORIZONTAL \
101 ? gtk_hbox_new (FALSE, (spacing)) : gtk_vbox_new (FALSE, (spacing)))
102 #define gtk_scrollbar_new(ori, spacing) \
103 ((ori) == GTK_ORIENTATION_HORIZONTAL \
104 ? gtk_hscrollbar_new ((spacing)) : gtk_vscrollbar_new ((spacing)))
105 #ifndef GDK_KEY_g
106 #define GDK_KEY_g GDK_g
107 #endif
108 #endif /* HAVE_GTK3 */
110 #define XG_BIN_CHILD(x) gtk_bin_get_child (GTK_BIN (x))
112 static void update_theme_scrollbar_width (void);
114 #define TB_INFO_KEY "xg_frame_tb_info"
115 struct xg_frame_tb_info
117 Lisp_Object last_tool_bar;
118 Lisp_Object style;
119 int n_last_items;
120 int hmargin, vmargin;
121 GtkTextDirection dir;
125 /***********************************************************************
126 Display handling functions
127 ***********************************************************************/
129 /* Keep track of the default display, or NULL if there is none. Emacs
130 may close all its displays. */
132 static GdkDisplay *gdpy_def;
134 /* When the GTK widget W is to be created on a display for F that
135 is not the default display, set the display for W.
136 W can be a GtkMenu or a GtkWindow widget. */
138 static void
139 xg_set_screen (GtkWidget *w, FRAME_PTR f)
141 if (FRAME_X_DISPLAY (f) != DEFAULT_GDK_DISPLAY ())
143 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
144 GdkScreen *gscreen = gdk_display_get_default_screen (gdpy);
146 if (GTK_IS_MENU (w))
147 gtk_menu_set_screen (GTK_MENU (w), gscreen);
148 else
149 gtk_window_set_screen (GTK_WINDOW (w), gscreen);
154 /* Open a display named by DISPLAY_NAME. The display is returned in *DPY.
155 *DPY is set to NULL if the display can't be opened.
157 Returns non-zero if display could be opened, zero if display could not
158 be opened, and less than zero if the GTK version doesn't support
159 multiple displays. */
161 void
162 xg_display_open (char *display_name, Display **dpy)
164 GdkDisplay *gdpy;
166 gdpy = gdk_display_open (display_name);
167 if (!gdpy_def && gdpy)
169 gdpy_def = gdpy;
170 gdk_display_manager_set_default_display (gdk_display_manager_get (),
171 gdpy);
174 *dpy = gdpy ? GDK_DISPLAY_XDISPLAY (gdpy) : NULL;
178 /* Close display DPY. */
180 void
181 xg_display_close (Display *dpy)
183 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
185 /* If this is the default display, try to change it before closing.
186 If there is no other display to use, gdpy_def is set to NULL, and
187 the next call to xg_display_open resets the default display. */
188 if (gdk_display_get_default () == gdpy)
190 struct x_display_info *dpyinfo;
191 GdkDisplay *gdpy_new = NULL;
193 /* Find another display. */
194 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
195 if (dpyinfo->display != dpy)
197 gdpy_new = gdk_x11_lookup_xdisplay (dpyinfo->display);
198 gdk_display_manager_set_default_display (gdk_display_manager_get (),
199 gdpy_new);
200 break;
202 gdpy_def = gdpy_new;
205 #if GTK_MAJOR_VERSION == 2 && GTK_MINOR_VERSION < 10
206 /* GTK 2.2-2.8 has a bug that makes gdk_display_close crash (bug
207 http://bugzilla.gnome.org/show_bug.cgi?id=85715). This way we
208 can continue running, but there will be memory leaks. */
209 g_object_run_dispose (G_OBJECT (gdpy));
210 #else
211 /* This seems to be fixed in GTK 2.10. */
212 gdk_display_close (gdpy);
213 #endif
217 /***********************************************************************
218 Utility functions
219 ***********************************************************************/
220 /* The next two variables and functions are taken from lwlib. */
221 static widget_value *widget_value_free_list;
222 static int malloc_cpt;
224 /* Allocate a widget_value structure, either by taking one from the
225 widget_value_free_list or by malloc:ing a new one.
227 Return a pointer to the allocated structure. */
229 widget_value *
230 malloc_widget_value (void)
232 widget_value *wv;
233 if (widget_value_free_list)
235 wv = widget_value_free_list;
236 widget_value_free_list = wv->free_list;
237 wv->free_list = 0;
239 else
241 wv = xmalloc (sizeof *wv);
242 malloc_cpt++;
244 memset (wv, 0, sizeof (widget_value));
245 return wv;
248 /* This is analogous to free. It frees only what was allocated
249 by malloc_widget_value, and no substructures. */
251 void
252 free_widget_value (widget_value *wv)
254 if (wv->free_list)
255 emacs_abort ();
257 if (malloc_cpt > 25)
259 /* When the number of already allocated cells is too big,
260 We free it. */
261 xfree (wv);
262 malloc_cpt--;
264 else
266 wv->free_list = widget_value_free_list;
267 widget_value_free_list = wv;
272 /* Create and return the cursor to be used for popup menus and
273 scroll bars on display DPY. */
275 GdkCursor *
276 xg_create_default_cursor (Display *dpy)
278 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
279 return gdk_cursor_new_for_display (gdpy, GDK_LEFT_PTR);
282 static GdkPixbuf *
283 xg_get_pixbuf_from_pixmap (FRAME_PTR f, Pixmap pix)
285 int iunused;
286 GdkPixbuf *tmp_buf;
287 Window wunused;
288 unsigned int width, height, uunused;
289 XImage *xim;
291 XGetGeometry (FRAME_X_DISPLAY (f), pix, &wunused, &iunused, &iunused,
292 &width, &height, &uunused, &uunused);
294 xim = XGetImage (FRAME_X_DISPLAY (f), pix, 0, 0, width, height,
295 ~0, XYPixmap);
296 if (!xim) return 0;
298 tmp_buf = gdk_pixbuf_new_from_data ((guchar *) xim->data,
299 GDK_COLORSPACE_RGB,
300 FALSE,
301 xim->bitmap_unit,
302 width,
303 height,
304 xim->bytes_per_line,
305 NULL,
306 NULL);
307 XDestroyImage (xim);
308 return tmp_buf;
311 /* Apply GMASK to GPIX and return a GdkPixbuf with an alpha channel. */
313 static GdkPixbuf *
314 xg_get_pixbuf_from_pix_and_mask (FRAME_PTR f,
315 Pixmap pix,
316 Pixmap mask)
318 int width, height;
319 GdkPixbuf *icon_buf, *tmp_buf;
321 tmp_buf = xg_get_pixbuf_from_pixmap (f, pix);
322 icon_buf = gdk_pixbuf_add_alpha (tmp_buf, FALSE, 0, 0, 0);
323 g_object_unref (G_OBJECT (tmp_buf));
325 width = gdk_pixbuf_get_width (icon_buf);
326 height = gdk_pixbuf_get_height (icon_buf);
328 if (mask)
330 GdkPixbuf *mask_buf = xg_get_pixbuf_from_pixmap (f, mask);
331 guchar *pixels = gdk_pixbuf_get_pixels (icon_buf);
332 guchar *mask_pixels = gdk_pixbuf_get_pixels (mask_buf);
333 int rowstride = gdk_pixbuf_get_rowstride (icon_buf);
334 int mask_rowstride = gdk_pixbuf_get_rowstride (mask_buf);
335 int y;
337 for (y = 0; y < height; ++y)
339 guchar *iconptr, *maskptr;
340 int x;
342 iconptr = pixels + y * rowstride;
343 maskptr = mask_pixels + y * mask_rowstride;
345 for (x = 0; x < width; ++x)
347 /* In a bitmap, RGB is either 255/255/255 or 0/0/0. Checking
348 just R is sufficient. */
349 if (maskptr[0] == 0)
350 iconptr[3] = 0; /* 0, 1, 2 is R, G, B. 3 is alpha. */
352 iconptr += rowstride/width;
353 maskptr += mask_rowstride/width;
357 g_object_unref (G_OBJECT (mask_buf));
360 return icon_buf;
363 static Lisp_Object
364 file_for_image (Lisp_Object image)
366 Lisp_Object specified_file = Qnil;
367 Lisp_Object tail;
369 for (tail = XCDR (image);
370 NILP (specified_file) && CONSP (tail) && CONSP (XCDR (tail));
371 tail = XCDR (XCDR (tail)))
372 if (EQ (XCAR (tail), QCfile))
373 specified_file = XCAR (XCDR (tail));
375 return specified_file;
378 /* For the image defined in IMG, make and return a GtkImage. For displays with
379 8 planes or less we must make a GdkPixbuf and apply the mask manually.
380 Otherwise the highlighting and dimming the tool bar code in GTK does
381 will look bad. For display with more than 8 planes we just use the
382 pixmap and mask directly. For monochrome displays, GTK doesn't seem
383 able to use external pixmaps, it looks bad whatever we do.
384 The image is defined on the display where frame F is.
385 WIDGET is used to find the GdkColormap to use for the GdkPixbuf.
386 If OLD_WIDGET is NULL, a new widget is constructed and returned.
387 If OLD_WIDGET is not NULL, that widget is modified. */
389 static GtkWidget *
390 xg_get_image_for_pixmap (FRAME_PTR f,
391 struct image *img,
392 GtkWidget *widget,
393 GtkImage *old_widget)
395 GdkPixbuf *icon_buf;
397 /* If we have a file, let GTK do all the image handling.
398 This seems to be the only way to make insensitive and activated icons
399 look good in all cases. */
400 Lisp_Object specified_file = file_for_image (img->spec);
401 Lisp_Object file;
403 /* We already loaded the image once before calling this
404 function, so this only fails if the image file has been removed.
405 In that case, use the pixmap already loaded. */
407 if (STRINGP (specified_file)
408 && STRINGP (file = x_find_image_file (specified_file)))
410 if (! old_widget)
411 old_widget = GTK_IMAGE (gtk_image_new_from_file (SSDATA (file)));
412 else
413 gtk_image_set_from_file (old_widget, SSDATA (file));
415 return GTK_WIDGET (old_widget);
418 /* No file, do the image handling ourselves. This will look very bad
419 on a monochrome display, and sometimes bad on all displays with
420 certain themes. */
422 /* This is a workaround to make icons look good on pseudo color
423 displays. Apparently GTK expects the images to have an alpha
424 channel. If they don't, insensitive and activated icons will
425 look bad. This workaround does not work on monochrome displays,
426 and is strictly not needed on true color/static color displays (i.e.
427 16 bits and higher). But we do it anyway so we get a pixbuf that is
428 not associated with the img->pixmap. The img->pixmap may be removed
429 by clearing the image cache and then the tool bar redraw fails, since
430 Gtk+ assumes the pixmap is always there. */
431 icon_buf = xg_get_pixbuf_from_pix_and_mask (f, img->pixmap, img->mask);
433 if (icon_buf)
435 if (! old_widget)
436 old_widget = GTK_IMAGE (gtk_image_new_from_pixbuf (icon_buf));
437 else
438 gtk_image_set_from_pixbuf (old_widget, icon_buf);
440 g_object_unref (G_OBJECT (icon_buf));
443 return GTK_WIDGET (old_widget);
447 /* Set CURSOR on W and all widgets W contain. We must do like this
448 for scroll bars and menu because they create widgets internally,
449 and it is those widgets that are visible. */
451 static void
452 xg_set_cursor (GtkWidget *w, GdkCursor *cursor)
454 GdkWindow *window = gtk_widget_get_window (w);
455 GList *children = gdk_window_peek_children (window);
457 gdk_window_set_cursor (window, cursor);
459 /* The scroll bar widget has more than one GDK window (had to look at
460 the source to figure this out), and there is no way to set cursor
461 on widgets in GTK. So we must set the cursor for all GDK windows.
462 Ditto for menus. */
464 for ( ; children; children = g_list_next (children))
465 gdk_window_set_cursor (GDK_WINDOW (children->data), cursor);
468 /* Insert NODE into linked LIST. */
470 static void
471 xg_list_insert (xg_list_node *list, xg_list_node *node)
473 xg_list_node *list_start = list->next;
475 if (list_start) list_start->prev = node;
476 node->next = list_start;
477 node->prev = 0;
478 list->next = node;
481 /* Remove NODE from linked LIST. */
483 static void
484 xg_list_remove (xg_list_node *list, xg_list_node *node)
486 xg_list_node *list_start = list->next;
487 if (node == list_start)
489 list->next = node->next;
490 if (list->next) list->next->prev = 0;
492 else
494 node->prev->next = node->next;
495 if (node->next) node->next->prev = node->prev;
499 /* Allocate and return a utf8 version of STR. If STR is already
500 utf8 or NULL, just return a copy of STR.
501 A new string is allocated and the caller must free the result
502 with g_free. */
504 static char *
505 get_utf8_string (const char *str)
507 char *utf8_str;
509 if (!str) return NULL;
511 /* If not UTF-8, try current locale. */
512 if (!g_utf8_validate (str, -1, NULL))
513 utf8_str = g_locale_to_utf8 (str, -1, 0, 0, 0);
514 else
515 return g_strdup (str);
517 if (!utf8_str)
519 /* Probably some control characters in str. Escape them. */
520 ptrdiff_t len;
521 ptrdiff_t nr_bad = 0;
522 gsize bytes_read;
523 gsize bytes_written;
524 unsigned char *p = (unsigned char *)str;
525 char *cp, *up;
526 GError *err = NULL;
528 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
529 &bytes_written, &err))
530 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
532 ++nr_bad;
533 p += bytes_written+1;
534 g_error_free (err);
535 err = NULL;
538 if (err)
540 g_error_free (err);
541 err = NULL;
543 if (cp) g_free (cp);
545 len = strlen (str);
546 if ((min (PTRDIFF_MAX, SIZE_MAX) - len - 1) / 4 < nr_bad)
547 memory_full (SIZE_MAX);
548 up = utf8_str = xmalloc (len + nr_bad * 4 + 1);
549 p = (unsigned char *)str;
551 while (! (cp = g_locale_to_utf8 ((char *)p, -1, &bytes_read,
552 &bytes_written, &err))
553 && err->code == G_CONVERT_ERROR_ILLEGAL_SEQUENCE)
555 memcpy (up, p, bytes_written);
556 sprintf (up + bytes_written, "\\%03o", p[bytes_written]);
557 up += bytes_written+4;
558 p += bytes_written+1;
559 g_error_free (err);
560 err = NULL;
563 if (cp)
565 strcat (utf8_str, cp);
566 g_free (cp);
568 if (err)
570 g_error_free (err);
571 err = NULL;
574 return utf8_str;
577 /* Check for special colors used in face spec for region face.
578 The colors are fetched from the Gtk+ theme.
579 Return true if color was found, false if not. */
581 bool
582 xg_check_special_colors (struct frame *f,
583 const char *color_name,
584 XColor *color)
586 bool success_p = 0;
587 bool get_bg = strcmp ("gtk_selection_bg_color", color_name) == 0;
588 bool get_fg = !get_bg && strcmp ("gtk_selection_fg_color", color_name) == 0;
590 if (! FRAME_GTK_WIDGET (f) || ! (get_bg || get_fg))
591 return success_p;
593 block_input ();
595 #ifdef HAVE_GTK3
596 GtkStyleContext *gsty
597 = gtk_widget_get_style_context (FRAME_GTK_OUTER_WIDGET (f));
598 GdkRGBA col;
599 char buf[sizeof "rgbi://" + 3 * (DBL_MAX_10_EXP + sizeof "-1.000000" - 1)];
600 int state = GTK_STATE_FLAG_SELECTED|GTK_STATE_FLAG_FOCUSED;
601 if (get_fg)
602 gtk_style_context_get_color (gsty, state, &col);
603 else
604 gtk_style_context_get_background_color (gsty, state, &col);
606 sprintf (buf, "rgbi:%lf/%lf/%lf", col.red, col.green, col.blue);
607 success_p = (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
608 buf, color)
609 != 0);
610 #else
611 GtkStyle *gsty = gtk_widget_get_style (FRAME_GTK_WIDGET (f));
612 GdkColor *grgb = get_bg
613 ? &gsty->bg[GTK_STATE_SELECTED]
614 : &gsty->fg[GTK_STATE_SELECTED];
616 color->red = grgb->red;
617 color->green = grgb->green;
618 color->blue = grgb->blue;
619 color->pixel = grgb->pixel;
620 success_p = 1;
621 #endif
624 unblock_input ();
625 return success_p;
630 /***********************************************************************
631 Tooltips
632 ***********************************************************************/
633 /* Gtk+ calls this callback when the parent of our tooltip dummy changes.
634 We use that to pop down the tooltip. This happens if Gtk+ for some
635 reason wants to change or hide the tooltip. */
637 #ifdef USE_GTK_TOOLTIP
639 static void
640 hierarchy_ch_cb (GtkWidget *widget,
641 GtkWidget *previous_toplevel,
642 gpointer user_data)
644 FRAME_PTR f = (FRAME_PTR) user_data;
645 struct x_output *x = f->output_data.x;
646 GtkWidget *top = gtk_widget_get_toplevel (x->ttip_lbl);
648 if (! top || ! GTK_IS_WINDOW (top))
649 gtk_widget_hide (previous_toplevel);
652 /* Callback called when Gtk+ thinks a tooltip should be displayed.
653 We use it to get the tooltip window and the tooltip widget so
654 we can manipulate the ourselves.
656 Return FALSE ensures that the tooltip is not shown. */
658 static gboolean
659 qttip_cb (GtkWidget *widget,
660 gint xpos,
661 gint ypos,
662 gboolean keyboard_mode,
663 GtkTooltip *tooltip,
664 gpointer user_data)
666 FRAME_PTR f = (FRAME_PTR) user_data;
667 struct x_output *x = f->output_data.x;
668 if (x->ttip_widget == NULL)
670 GtkWidget *p;
671 GList *list, *iter;
673 g_object_set (G_OBJECT (widget), "has-tooltip", FALSE, NULL);
674 x->ttip_widget = tooltip;
675 g_object_ref (G_OBJECT (tooltip));
676 x->ttip_lbl = gtk_label_new ("");
677 g_object_ref (G_OBJECT (x->ttip_lbl));
678 gtk_tooltip_set_custom (tooltip, x->ttip_lbl);
679 x->ttip_window = GTK_WINDOW (gtk_widget_get_toplevel (x->ttip_lbl));
681 /* Change stupid Gtk+ default line wrapping. */
682 p = gtk_widget_get_parent (x->ttip_lbl);
683 list = gtk_container_get_children (GTK_CONTAINER (p));
684 for (iter = list; iter; iter = g_list_next (iter))
686 GtkWidget *w = GTK_WIDGET (iter->data);
687 if (GTK_IS_LABEL (w))
688 gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
690 g_list_free (list);
692 /* ATK needs an empty title for some reason. */
693 gtk_window_set_title (x->ttip_window, "");
694 /* Realize so we can safely get screen later on. */
695 gtk_widget_realize (GTK_WIDGET (x->ttip_window));
696 gtk_widget_realize (x->ttip_lbl);
698 g_signal_connect (x->ttip_lbl, "hierarchy-changed",
699 G_CALLBACK (hierarchy_ch_cb), f);
701 return FALSE;
704 #endif /* USE_GTK_TOOLTIP */
706 /* Prepare a tooltip to be shown, i.e. calculate WIDTH and HEIGHT.
707 Return true if a system tooltip is available. */
709 bool
710 xg_prepare_tooltip (FRAME_PTR f,
711 Lisp_Object string,
712 int *width,
713 int *height)
715 #ifndef USE_GTK_TOOLTIP
716 return 0;
717 #else
718 struct x_output *x = f->output_data.x;
719 GtkWidget *widget;
720 GdkWindow *gwin;
721 GdkScreen *screen;
722 GtkSettings *settings;
723 gboolean tt_enabled = TRUE;
724 GtkRequisition req;
725 Lisp_Object encoded_string;
727 if (!x->ttip_lbl) return 0;
729 block_input ();
730 encoded_string = ENCODE_UTF_8 (string);
731 widget = GTK_WIDGET (x->ttip_lbl);
732 gwin = gtk_widget_get_window (GTK_WIDGET (x->ttip_window));
733 screen = gdk_window_get_screen (gwin);
734 settings = gtk_settings_get_for_screen (screen);
735 g_object_get (settings, "gtk-enable-tooltips", &tt_enabled, NULL);
736 if (tt_enabled)
738 g_object_set (settings, "gtk-enable-tooltips", FALSE, NULL);
739 /* Record that we disabled it so it can be enabled again. */
740 g_object_set_data (G_OBJECT (x->ttip_window), "restore-tt",
741 (gpointer)f);
744 /* Prevent Gtk+ from hiding tooltip on mouse move and such. */
745 g_object_set_data (G_OBJECT
746 (gtk_widget_get_display (GTK_WIDGET (x->ttip_window))),
747 "gdk-display-current-tooltip", NULL);
749 /* Put our dummy widget in so we can get callbacks for unrealize and
750 hierarchy-changed. */
751 gtk_tooltip_set_custom (x->ttip_widget, widget);
752 gtk_tooltip_set_text (x->ttip_widget, SSDATA (encoded_string));
753 gtk_widget_get_preferred_size (GTK_WIDGET (x->ttip_window), NULL, &req);
754 if (width) *width = req.width;
755 if (height) *height = req.height;
757 unblock_input ();
759 return 1;
760 #endif /* USE_GTK_TOOLTIP */
763 /* Show the tooltip at ROOT_X and ROOT_Y.
764 xg_prepare_tooltip must have been called before this function. */
766 void
767 xg_show_tooltip (FRAME_PTR f, int root_x, int root_y)
769 #ifdef USE_GTK_TOOLTIP
770 struct x_output *x = f->output_data.x;
771 if (x->ttip_window)
773 block_input ();
774 gtk_window_move (x->ttip_window, root_x, root_y);
775 gtk_widget_show_all (GTK_WIDGET (x->ttip_window));
776 unblock_input ();
778 #endif
781 /* Hide tooltip if shown. Do nothing if not shown.
782 Return true if tip was hidden, false if not (i.e. not using
783 system tooltips). */
785 bool
786 xg_hide_tooltip (FRAME_PTR f)
788 bool ret = 0;
789 #ifdef USE_GTK_TOOLTIP
790 if (f->output_data.x->ttip_window)
792 GtkWindow *win = f->output_data.x->ttip_window;
793 block_input ();
794 gtk_widget_hide (GTK_WIDGET (win));
796 if (g_object_get_data (G_OBJECT (win), "restore-tt"))
798 GdkWindow *gwin = gtk_widget_get_window (GTK_WIDGET (win));
799 GdkScreen *screen = gdk_window_get_screen (gwin);
800 GtkSettings *settings = gtk_settings_get_for_screen (screen);
801 g_object_set (settings, "gtk-enable-tooltips", TRUE, NULL);
803 unblock_input ();
805 ret = 1;
807 #endif
808 return ret;
812 /***********************************************************************
813 General functions for creating widgets, resizing, events, e.t.c.
814 ***********************************************************************/
816 static void
817 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
818 const gchar *msg, gpointer user_data)
820 if (!strstr (msg, "visible children"))
821 fprintf (stderr, "XX %s-WARNING **: %s\n", log_domain, msg);
824 /* Make a geometry string and pass that to GTK. It seems this is the
825 only way to get geometry position right if the user explicitly
826 asked for a position when starting Emacs.
827 F is the frame we shall set geometry for. */
829 static void
830 xg_set_geometry (FRAME_PTR f)
832 if (f->size_hint_flags & (USPosition | PPosition))
834 int left = f->left_pos;
835 int xneg = f->size_hint_flags & XNegative;
836 int top = f->top_pos;
837 int yneg = f->size_hint_flags & YNegative;
838 char geom_str[sizeof "=x--" + 4 * INT_STRLEN_BOUND (int)];
839 guint id;
841 if (xneg)
842 left = -left;
843 if (yneg)
844 top = -top;
846 sprintf (geom_str, "=%dx%d%c%d%c%d",
847 FRAME_PIXEL_WIDTH (f),
848 FRAME_PIXEL_HEIGHT (f),
849 (xneg ? '-' : '+'), left,
850 (yneg ? '-' : '+'), top);
852 /* Silence warning about visible children. */
853 id = g_log_set_handler ("Gtk", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
854 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
856 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
857 geom_str))
858 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
860 g_log_remove_handler ("Gtk", id);
864 /* Clear under internal border if any. As we use a mix of Gtk+ and X calls
865 and use a GtkFixed widget, this doesn't happen automatically. */
867 static void
868 xg_clear_under_internal_border (FRAME_PTR f)
870 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
872 GtkWidget *wfixed = f->output_data.x->edit_widget;
873 gtk_widget_queue_draw (wfixed);
874 gdk_window_process_all_updates ();
875 x_clear_area (FRAME_X_DISPLAY (f),
876 FRAME_X_WINDOW (f),
877 0, 0,
878 FRAME_PIXEL_WIDTH (f),
879 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
880 x_clear_area (FRAME_X_DISPLAY (f),
881 FRAME_X_WINDOW (f),
882 0, 0,
883 FRAME_INTERNAL_BORDER_WIDTH (f),
884 FRAME_PIXEL_HEIGHT (f), 0);
885 x_clear_area (FRAME_X_DISPLAY (f),
886 FRAME_X_WINDOW (f),
887 0, FRAME_PIXEL_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
888 FRAME_PIXEL_WIDTH (f),
889 FRAME_INTERNAL_BORDER_WIDTH (f), 0);
890 x_clear_area (FRAME_X_DISPLAY (f),
891 FRAME_X_WINDOW (f),
892 FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f),
894 FRAME_INTERNAL_BORDER_WIDTH (f),
895 FRAME_PIXEL_HEIGHT (f), 0);
899 /* Function to handle resize of our frame. As we have a Gtk+ tool bar
900 and a Gtk+ menu bar, we get resize events for the edit part of the
901 frame only. We let Gtk+ deal with the Gtk+ parts.
902 F is the frame to resize.
903 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
905 void
906 xg_frame_resized (FRAME_PTR f, int pixelwidth, int pixelheight)
908 int rows, columns;
910 if (pixelwidth == -1 && pixelheight == -1)
912 if (FRAME_GTK_WIDGET (f) && gtk_widget_get_mapped (FRAME_GTK_WIDGET (f)))
913 gdk_window_get_geometry (gtk_widget_get_window (FRAME_GTK_WIDGET (f)),
914 0, 0,
915 &pixelwidth, &pixelheight);
916 else return;
920 rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelheight);
921 columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pixelwidth);
923 if (columns != FRAME_COLS (f)
924 || rows != FRAME_LINES (f)
925 || pixelwidth != FRAME_PIXEL_WIDTH (f)
926 || pixelheight != FRAME_PIXEL_HEIGHT (f))
928 FRAME_PIXEL_WIDTH (f) = pixelwidth;
929 FRAME_PIXEL_HEIGHT (f) = pixelheight;
931 xg_clear_under_internal_border (f);
932 change_frame_size (f, rows, columns, 0, 1, 0);
933 SET_FRAME_GARBAGED (f);
934 cancel_mouse_face (f);
938 /* Resize the outer window of frame F after changing the height.
939 COLUMNS/ROWS is the size the edit area shall have after the resize. */
941 void
942 xg_frame_set_char_size (FRAME_PTR f, int cols, int rows)
944 int pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
945 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
946 int pixelwidth;
948 if (FRAME_PIXEL_HEIGHT (f) == 0)
949 return;
951 /* Take into account the size of the scroll bar. Always use the
952 number of columns occupied by the scroll bar here otherwise we
953 might end up with a frame width that is not a multiple of the
954 frame's character width which is bad for vertically split
955 windows. */
956 f->scroll_bar_actual_width
957 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
959 compute_fringe_widths (f, 0);
961 /* FRAME_TEXT_COLS_TO_PIXEL_WIDTH uses scroll_bar_actual_width, so call it
962 after calculating that value. */
963 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
964 + FRAME_TOOLBAR_WIDTH (f);
967 /* Do this before resize, as we don't know yet if we will be resized. */
968 xg_clear_under_internal_border (f);
970 /* Must resize our top level widget. Font size may have changed,
971 but not rows/cols. */
972 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
973 pixelwidth, pixelheight);
974 x_wm_set_size_hint (f, 0, 0);
976 SET_FRAME_GARBAGED (f);
977 cancel_mouse_face (f);
979 /* We can not call change_frame_size for a mapped frame,
980 we can not set pixel width/height either. The window manager may
981 override our resize request, XMonad does this all the time.
982 The best we can do is try to sync, so lisp code sees the updated
983 size as fast as possible.
984 For unmapped windows, we can set rows/cols. When
985 the frame is mapped again we will (hopefully) get the correct size. */
986 if (f->async_visible)
988 /* Must call this to flush out events */
989 (void)gtk_events_pending ();
990 gdk_flush ();
991 x_wait_for_event (f, ConfigureNotify);
993 else
995 change_frame_size (f, rows, cols, 0, 1, 0);
996 FRAME_PIXEL_WIDTH (f) = pixelwidth;
997 FRAME_PIXEL_HEIGHT (f) = pixelheight;
1001 /* Handle height/width changes (i.e. add/remove/move menu/toolbar).
1002 The policy is to keep the number of editable lines. */
1004 static void
1005 xg_height_or_width_changed (FRAME_PTR f)
1007 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1008 FRAME_TOTAL_PIXEL_WIDTH (f),
1009 FRAME_TOTAL_PIXEL_HEIGHT (f));
1010 f->output_data.x->hint_flags = 0;
1011 x_wm_set_size_hint (f, 0, 0);
1014 /* Convert an X Window WSESC on display DPY to its corresponding GtkWidget.
1015 Must be done like this, because GtkWidget:s can have "hidden"
1016 X Window that aren't accessible.
1018 Return 0 if no widget match WDESC. */
1020 GtkWidget *
1021 xg_win_to_widget (Display *dpy, Window wdesc)
1023 gpointer gdkwin;
1024 GtkWidget *gwdesc = 0;
1026 block_input ();
1028 gdkwin = gdk_x11_window_lookup_for_display (gdk_x11_lookup_xdisplay (dpy),
1029 wdesc);
1030 if (gdkwin)
1032 GdkEvent event;
1033 event.any.window = gdkwin;
1034 event.any.type = GDK_NOTHING;
1035 gwdesc = gtk_get_event_widget (&event);
1038 unblock_input ();
1039 return gwdesc;
1042 /* Set the background of widget W to PIXEL. */
1044 static void
1045 xg_set_widget_bg (FRAME_PTR f, GtkWidget *w, long unsigned int pixel)
1047 #ifdef HAVE_GTK3
1048 GdkRGBA bg;
1049 XColor xbg;
1050 xbg.pixel = pixel;
1051 if (XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &xbg))
1053 bg.red = (double)xbg.red/65535.0;
1054 bg.green = (double)xbg.green/65535.0;
1055 bg.blue = (double)xbg.blue/65535.0;
1056 bg.alpha = 1.0;
1057 gtk_widget_override_background_color (w, GTK_STATE_FLAG_NORMAL, &bg);
1059 #else
1060 GdkColor bg;
1061 GdkColormap *map = gtk_widget_get_colormap (w);
1062 gdk_colormap_query_color (map, pixel, &bg);
1063 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &bg);
1064 #endif
1067 /* Callback called when the gtk theme changes.
1068 We notify lisp code so it can fix faces used for region for example. */
1070 static void
1071 style_changed_cb (GObject *go,
1072 GParamSpec *spec,
1073 gpointer user_data)
1075 struct input_event event;
1076 GdkDisplay *gdpy = (GdkDisplay *) user_data;
1077 const char *display_name = gdk_display_get_name (gdpy);
1078 Display *dpy = GDK_DISPLAY_XDISPLAY (gdpy);
1080 EVENT_INIT (event);
1081 event.kind = CONFIG_CHANGED_EVENT;
1082 event.frame_or_window = build_string (display_name);
1083 /* Theme doesn't change often, so intern is called seldom. */
1084 event.arg = intern ("theme-name");
1085 kbd_buffer_store_event (&event);
1087 update_theme_scrollbar_width ();
1089 /* If scroll bar width changed, we need set the new size on all frames
1090 on this display. */
1091 if (dpy)
1093 Lisp_Object rest, frame;
1094 FOR_EACH_FRAME (rest, frame)
1096 FRAME_PTR f = XFRAME (frame);
1097 if (FRAME_X_DISPLAY (f) == dpy)
1099 x_set_scroll_bar_default_width (f);
1100 xg_frame_set_char_size (f, FRAME_COLS (f), FRAME_LINES (f));
1106 /* Called when a delete-event occurs on WIDGET. */
1108 static gboolean
1109 delete_cb (GtkWidget *widget,
1110 GdkEvent *event,
1111 gpointer user_data)
1113 #ifdef HAVE_GTK3
1114 /* The event doesn't arrive in the normal event loop. Send event
1115 here. */
1116 FRAME_PTR f = (FRAME_PTR) user_data;
1117 struct input_event ie;
1119 EVENT_INIT (ie);
1120 ie.kind = DELETE_WINDOW_EVENT;
1121 XSETFRAME (ie.frame_or_window, f);
1122 kbd_buffer_store_event (&ie);
1123 #endif
1125 return TRUE;
1128 /* Create and set up the GTK widgets for frame F.
1129 Return true if creation succeeded. */
1131 bool
1132 xg_create_frame_widgets (FRAME_PTR f)
1134 GtkWidget *wtop;
1135 GtkWidget *wvbox, *whbox;
1136 GtkWidget *wfixed;
1137 #ifndef HAVE_GTK3
1138 GtkRcStyle *style;
1139 #endif
1140 char *title = 0;
1142 block_input ();
1144 if (FRAME_X_EMBEDDED_P (f))
1146 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
1147 wtop = gtk_plug_new_for_display (gdpy, f->output_data.x->parent_desc);
1149 else
1150 wtop = gtk_window_new (GTK_WINDOW_TOPLEVEL);
1152 /* gtk_window_set_has_resize_grip is a Gtk+ 3.0 function but Ubuntu
1153 has backported it to Gtk+ 2.0 and they add the resize grip for
1154 Gtk+ 2.0 applications also. But it has a bug that makes Emacs loop
1155 forever, so disable the grip. */
1156 #if GTK_MAJOR_VERSION < 3 && defined (HAVE_GTK_WINDOW_SET_HAS_RESIZE_GRIP)
1157 gtk_window_set_has_resize_grip (GTK_WINDOW (wtop), FALSE);
1158 #endif
1160 xg_set_screen (wtop, f);
1162 wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1163 whbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1164 gtk_box_set_homogeneous (GTK_BOX (wvbox), FALSE);
1165 gtk_box_set_homogeneous (GTK_BOX (whbox), FALSE);
1167 #ifdef HAVE_GTK3
1168 wfixed = emacs_fixed_new (f);
1169 #else
1170 wfixed = gtk_fixed_new ();
1171 #endif
1173 if (! wtop || ! wvbox || ! whbox || ! wfixed)
1175 if (wtop) gtk_widget_destroy (wtop);
1176 if (wvbox) gtk_widget_destroy (wvbox);
1177 if (whbox) gtk_widget_destroy (whbox);
1178 if (wfixed) gtk_widget_destroy (wfixed);
1180 unblock_input ();
1181 return 0;
1184 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
1185 gtk_widget_set_name (wtop, EMACS_CLASS);
1186 gtk_widget_set_name (wvbox, "pane");
1187 gtk_widget_set_name (wfixed, SSDATA (Vx_resource_name));
1189 /* If this frame has a title or name, set it in the title bar. */
1190 if (! NILP (f->title))
1191 title = SSDATA (ENCODE_UTF_8 (f->title));
1192 else if (! NILP (f->name))
1193 title = SSDATA (ENCODE_UTF_8 (f->name));
1195 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
1197 FRAME_GTK_OUTER_WIDGET (f) = wtop;
1198 FRAME_GTK_WIDGET (f) = wfixed;
1199 f->output_data.x->vbox_widget = wvbox;
1200 f->output_data.x->hbox_widget = whbox;
1202 gtk_widget_set_has_window (wfixed, TRUE);
1204 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
1205 gtk_box_pack_start (GTK_BOX (wvbox), whbox, TRUE, TRUE, 0);
1206 gtk_box_pack_start (GTK_BOX (whbox), wfixed, TRUE, TRUE, 0);
1208 if (FRAME_EXTERNAL_TOOL_BAR (f))
1209 update_frame_tool_bar (f);
1211 /* We don't want this widget double buffered, because we draw on it
1212 with regular X drawing primitives, so from a GTK/GDK point of
1213 view, the widget is totally blank. When an expose comes, this
1214 will make the widget blank, and then Emacs redraws it. This flickers
1215 a lot, so we turn off double buffering. */
1216 gtk_widget_set_double_buffered (wfixed, FALSE);
1218 gtk_window_set_wmclass (GTK_WINDOW (wtop),
1219 SSDATA (Vx_resource_name),
1220 SSDATA (Vx_resource_class));
1222 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
1223 GTK is to destroy the widget. We want Emacs to do that instead. */
1224 g_signal_connect (G_OBJECT (wtop), "delete-event",
1225 G_CALLBACK (delete_cb), f);
1227 /* Convert our geometry parameters into a geometry string
1228 and specify it.
1229 GTK will itself handle calculating the real position this way. */
1230 xg_set_geometry (f);
1231 f->win_gravity
1232 = gtk_window_get_gravity (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1234 gtk_widget_add_events (wfixed,
1235 GDK_POINTER_MOTION_MASK
1236 | GDK_EXPOSURE_MASK
1237 | GDK_BUTTON_PRESS_MASK
1238 | GDK_BUTTON_RELEASE_MASK
1239 | GDK_KEY_PRESS_MASK
1240 | GDK_ENTER_NOTIFY_MASK
1241 | GDK_LEAVE_NOTIFY_MASK
1242 | GDK_FOCUS_CHANGE_MASK
1243 | GDK_STRUCTURE_MASK
1244 | GDK_VISIBILITY_NOTIFY_MASK);
1246 /* Must realize the windows so the X window gets created. It is used
1247 by callers of this function. */
1248 gtk_widget_realize (wfixed);
1249 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
1251 /* Since GTK clears its window by filling with the background color,
1252 we must keep X and GTK background in sync. */
1253 xg_set_widget_bg (f, wfixed, FRAME_BACKGROUND_PIXEL (f));
1255 #ifndef HAVE_GTK3
1256 /* Also, do not let any background pixmap to be set, this looks very
1257 bad as Emacs overwrites the background pixmap with its own idea
1258 of background color. */
1259 style = gtk_widget_get_modifier_style (wfixed);
1261 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
1262 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
1263 gtk_widget_modify_style (wfixed, style);
1264 #else
1265 gtk_widget_set_can_focus (wfixed, TRUE);
1266 gtk_window_set_resizable (GTK_WINDOW (wtop), TRUE);
1267 #endif
1269 #ifdef USE_GTK_TOOLTIP
1270 /* Steal a tool tip window we can move ourselves. */
1271 f->output_data.x->ttip_widget = 0;
1272 f->output_data.x->ttip_lbl = 0;
1273 f->output_data.x->ttip_window = 0;
1274 gtk_widget_set_tooltip_text (wtop, "Dummy text");
1275 g_signal_connect (wtop, "query-tooltip", G_CALLBACK (qttip_cb), f);
1276 #endif
1279 GdkScreen *screen = gtk_widget_get_screen (wtop);
1280 GtkSettings *gs = gtk_settings_get_for_screen (screen);
1281 /* Only connect this signal once per screen. */
1282 if (! g_signal_handler_find (G_OBJECT (gs),
1283 G_SIGNAL_MATCH_FUNC,
1284 0, 0, 0,
1285 G_CALLBACK (style_changed_cb),
1288 g_signal_connect (G_OBJECT (gs), "notify::gtk-theme-name",
1289 G_CALLBACK (style_changed_cb),
1290 gdk_screen_get_display (screen));
1294 unblock_input ();
1296 return 1;
1299 void
1300 xg_free_frame_widgets (FRAME_PTR f)
1302 if (FRAME_GTK_OUTER_WIDGET (f))
1304 #ifdef USE_GTK_TOOLTIP
1305 struct x_output *x = f->output_data.x;
1306 #endif
1307 struct xg_frame_tb_info *tbinfo
1308 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
1309 TB_INFO_KEY);
1310 if (tbinfo)
1311 xfree (tbinfo);
1313 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
1314 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow in xterm.c */
1315 FRAME_GTK_OUTER_WIDGET (f) = 0;
1316 #ifdef USE_GTK_TOOLTIP
1317 if (x->ttip_lbl)
1318 gtk_widget_destroy (x->ttip_lbl);
1319 if (x->ttip_widget)
1320 g_object_unref (G_OBJECT (x->ttip_widget));
1321 #endif
1325 /* Set the normal size hints for the window manager, for frame F.
1326 FLAGS is the flags word to use--or 0 meaning preserve the flags
1327 that the window now has.
1328 If USER_POSITION, set the User Position
1329 flag (this is useful when FLAGS is 0). */
1331 void
1332 x_wm_set_size_hint (FRAME_PTR f, long int flags, bool user_position)
1334 /* Must use GTK routines here, otherwise GTK resets the size hints
1335 to its own defaults. */
1336 GdkGeometry size_hints;
1337 gint hint_flags = 0;
1338 int base_width, base_height;
1339 int min_rows = 0, min_cols = 0;
1340 int win_gravity = f->win_gravity;
1342 /* Don't set size hints during initialization; that apparently leads
1343 to a race condition. See the thread at
1344 http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00033.html */
1345 if (NILP (Vafter_init_time) || !FRAME_GTK_OUTER_WIDGET (f))
1346 return;
1348 if (flags)
1350 memset (&size_hints, 0, sizeof (size_hints));
1351 f->output_data.x->size_hints = size_hints;
1352 f->output_data.x->hint_flags = hint_flags;
1354 else
1355 flags = f->size_hint_flags;
1357 size_hints = f->output_data.x->size_hints;
1358 hint_flags = f->output_data.x->hint_flags;
1360 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
1361 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
1362 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
1364 hint_flags |= GDK_HINT_BASE_SIZE;
1365 /* Use one row/col here so base_height/width does not become zero.
1366 Gtk+ and/or Unity on Ubuntu 12.04 can't handle it. */
1367 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 1) + FRAME_TOOLBAR_WIDTH (f);
1368 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 1)
1369 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
1371 check_frame_size (f, &min_rows, &min_cols);
1372 if (min_cols > 0) --min_cols; /* We used one col in base_width = ... 1); */
1373 if (min_rows > 0) --min_rows; /* We used one row in base_height = ... 1); */
1375 size_hints.base_width = base_width;
1376 size_hints.base_height = base_height;
1377 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
1378 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
1380 /* These currently have a one to one mapping with the X values, but I
1381 don't think we should rely on that. */
1382 hint_flags |= GDK_HINT_WIN_GRAVITY;
1383 size_hints.win_gravity = 0;
1384 if (win_gravity == NorthWestGravity)
1385 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
1386 else if (win_gravity == NorthGravity)
1387 size_hints.win_gravity = GDK_GRAVITY_NORTH;
1388 else if (win_gravity == NorthEastGravity)
1389 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
1390 else if (win_gravity == WestGravity)
1391 size_hints.win_gravity = GDK_GRAVITY_WEST;
1392 else if (win_gravity == CenterGravity)
1393 size_hints.win_gravity = GDK_GRAVITY_CENTER;
1394 else if (win_gravity == EastGravity)
1395 size_hints.win_gravity = GDK_GRAVITY_EAST;
1396 else if (win_gravity == SouthWestGravity)
1397 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
1398 else if (win_gravity == SouthGravity)
1399 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
1400 else if (win_gravity == SouthEastGravity)
1401 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
1402 else if (win_gravity == StaticGravity)
1403 size_hints.win_gravity = GDK_GRAVITY_STATIC;
1405 if (user_position)
1407 hint_flags &= ~GDK_HINT_POS;
1408 hint_flags |= GDK_HINT_USER_POS;
1411 if (hint_flags != f->output_data.x->hint_flags
1412 || memcmp (&size_hints,
1413 &f->output_data.x->size_hints,
1414 sizeof (size_hints)) != 0)
1416 block_input ();
1417 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1418 NULL, &size_hints, hint_flags);
1419 f->output_data.x->size_hints = size_hints;
1420 f->output_data.x->hint_flags = hint_flags;
1421 unblock_input ();
1425 /* Change background color of a frame.
1426 Since GTK uses the background color to clear the window, we must
1427 keep the GTK and X colors in sync.
1428 F is the frame to change,
1429 BG is the pixel value to change to. */
1431 void
1432 xg_set_background_color (FRAME_PTR f, long unsigned int bg)
1434 if (FRAME_GTK_WIDGET (f))
1436 block_input ();
1437 xg_set_widget_bg (f, FRAME_GTK_WIDGET (f), FRAME_BACKGROUND_PIXEL (f));
1438 unblock_input ();
1443 /* Set the frame icon to ICON_PIXMAP/MASK. This must be done with GTK
1444 functions so GTK does not overwrite the icon. */
1446 void
1447 xg_set_frame_icon (FRAME_PTR f, Pixmap icon_pixmap, Pixmap icon_mask)
1449 GdkPixbuf *gp = xg_get_pixbuf_from_pix_and_mask (f,
1450 icon_pixmap,
1451 icon_mask);
1452 if (gp)
1453 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), gp);
1458 /***********************************************************************
1459 Dialog functions
1460 ***********************************************************************/
1461 /* Return the dialog title to use for a dialog of type KEY.
1462 This is the encoding used by lwlib. We use the same for GTK. */
1464 static const char *
1465 get_dialog_title (char key)
1467 const char *title = "";
1469 switch (key) {
1470 case 'E': case 'e':
1471 title = "Error";
1472 break;
1474 case 'I': case 'i':
1475 title = "Information";
1476 break;
1478 case 'L': case 'l':
1479 title = "Prompt";
1480 break;
1482 case 'P': case 'p':
1483 title = "Prompt";
1484 break;
1486 case 'Q': case 'q':
1487 title = "Question";
1488 break;
1491 return title;
1494 /* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
1495 the dialog, but return TRUE so the event does not propagate further
1496 in GTK. This prevents GTK from destroying the dialog widget automatically
1497 and we can always destroy the widget manually, regardless of how
1498 it was popped down (button press or WM_DELETE_WINDOW).
1499 W is the dialog widget.
1500 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
1501 user_data is NULL (not used).
1503 Returns TRUE to end propagation of event. */
1505 static gboolean
1506 dialog_delete_callback (GtkWidget *w, GdkEvent *event, gpointer user_data)
1508 gtk_widget_unmap (w);
1509 return TRUE;
1512 /* Create a popup dialog window. See also xg_create_widget below.
1513 WV is a widget_value describing the dialog.
1514 SELECT_CB is the callback to use when a button has been pressed.
1515 DEACTIVATE_CB is the callback to use when the dialog pops down.
1517 Returns the GTK dialog widget. */
1519 static GtkWidget *
1520 create_dialog (widget_value *wv,
1521 GCallback select_cb,
1522 GCallback deactivate_cb)
1524 const char *title = get_dialog_title (wv->name[0]);
1525 int total_buttons = wv->name[1] - '0';
1526 int right_buttons = wv->name[4] - '0';
1527 int left_buttons;
1528 int button_nr = 0;
1529 int button_spacing = 10;
1530 GtkWidget *wdialog = gtk_dialog_new ();
1531 GtkDialog *wd = GTK_DIALOG (wdialog);
1532 GtkBox *cur_box = GTK_BOX (gtk_dialog_get_action_area (wd));
1533 widget_value *item;
1534 GtkWidget *whbox_down;
1536 /* If the number of buttons is greater than 4, make two rows of buttons
1537 instead. This looks better. */
1538 bool make_two_rows = total_buttons > 4;
1540 if (right_buttons == 0) right_buttons = total_buttons/2;
1541 left_buttons = total_buttons - right_buttons;
1543 gtk_window_set_title (GTK_WINDOW (wdialog), title);
1544 gtk_widget_set_name (wdialog, "emacs-dialog");
1547 if (make_two_rows)
1549 GtkWidget *wvbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, button_spacing);
1550 GtkWidget *whbox_up = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1551 gtk_box_set_homogeneous (GTK_BOX (wvbox), TRUE);
1552 gtk_box_set_homogeneous (GTK_BOX (whbox_up), FALSE);
1553 whbox_down = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
1554 gtk_box_set_homogeneous (GTK_BOX (whbox_down), FALSE);
1556 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
1557 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
1558 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
1560 cur_box = GTK_BOX (whbox_up);
1563 g_signal_connect (G_OBJECT (wdialog), "delete-event",
1564 G_CALLBACK (dialog_delete_callback), 0);
1566 if (deactivate_cb)
1568 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
1569 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
1572 for (item = wv->contents; item; item = item->next)
1574 char *utf8_label = get_utf8_string (item->value);
1575 GtkWidget *w;
1576 GtkRequisition req;
1578 if (item->name && strcmp (item->name, "message") == 0)
1580 GtkBox *wvbox = GTK_BOX (gtk_dialog_get_content_area (wd));
1581 /* This is the text part of the dialog. */
1582 w = gtk_label_new (utf8_label);
1583 gtk_box_pack_start (wvbox, gtk_label_new (""), FALSE, FALSE, 0);
1584 gtk_box_pack_start (wvbox, w, TRUE, TRUE, 0);
1585 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
1587 /* Try to make dialog look better. Must realize first so
1588 the widget can calculate the size it needs. */
1589 gtk_widget_realize (w);
1590 gtk_widget_get_preferred_size (w, NULL, &req);
1591 gtk_box_set_spacing (wvbox, req.height);
1592 if (item->value && strlen (item->value) > 0)
1593 button_spacing = 2*req.width/strlen (item->value);
1595 else
1597 /* This is one button to add to the dialog. */
1598 w = gtk_button_new_with_label (utf8_label);
1599 if (! item->enabled)
1600 gtk_widget_set_sensitive (w, FALSE);
1601 if (select_cb)
1602 g_signal_connect (G_OBJECT (w), "clicked",
1603 select_cb, item->call_data);
1605 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
1606 if (++button_nr == left_buttons)
1608 if (make_two_rows)
1609 cur_box = GTK_BOX (whbox_down);
1610 else
1611 gtk_box_pack_start (cur_box,
1612 gtk_label_new (""),
1613 TRUE, TRUE,
1614 button_spacing);
1618 if (utf8_label)
1619 g_free (utf8_label);
1622 return wdialog;
1625 struct xg_dialog_data
1627 GMainLoop *loop;
1628 int response;
1629 GtkWidget *w;
1630 guint timerid;
1633 /* Function that is called when the file or font dialogs pop down.
1634 W is the dialog widget, RESPONSE is the response code.
1635 USER_DATA is what we passed in to g_signal_connect. */
1637 static void
1638 xg_dialog_response_cb (GtkDialog *w,
1639 gint response,
1640 gpointer user_data)
1642 struct xg_dialog_data *dd = (struct xg_dialog_data *)user_data;
1643 dd->response = response;
1644 g_main_loop_quit (dd->loop);
1648 /* Destroy the dialog. This makes it pop down. */
1650 static Lisp_Object
1651 pop_down_dialog (Lisp_Object arg)
1653 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1654 struct xg_dialog_data *dd = (struct xg_dialog_data *) p->pointer;
1656 block_input ();
1657 if (dd->w) gtk_widget_destroy (dd->w);
1658 if (dd->timerid != 0) g_source_remove (dd->timerid);
1660 g_main_loop_quit (dd->loop);
1661 g_main_loop_unref (dd->loop);
1663 unblock_input ();
1665 return Qnil;
1668 /* If there are any emacs timers pending, add a timeout to main loop in DATA.
1669 We pass in DATA as gpointer* so we can use this as a callback. */
1671 static gboolean
1672 xg_maybe_add_timer (gpointer data)
1674 struct xg_dialog_data *dd = (struct xg_dialog_data *) data;
1675 EMACS_TIME next_time = timer_check ();
1677 dd->timerid = 0;
1679 if (EMACS_TIME_VALID_P (next_time))
1681 time_t s = EMACS_SECS (next_time);
1682 int per_ms = EMACS_TIME_RESOLUTION / 1000;
1683 int ms = (EMACS_NSECS (next_time) + per_ms - 1) / per_ms;
1684 if (s <= ((guint) -1 - ms) / 1000)
1685 dd->timerid = g_timeout_add (s * 1000 + ms, xg_maybe_add_timer, dd);
1687 return FALSE;
1691 /* Pops up a modal dialog W and waits for response.
1692 We don't use gtk_dialog_run because we want to process emacs timers.
1693 The dialog W is not destroyed when this function returns. */
1695 static int
1696 xg_dialog_run (FRAME_PTR f, GtkWidget *w)
1698 ptrdiff_t count = SPECPDL_INDEX ();
1699 struct xg_dialog_data dd;
1701 xg_set_screen (w, f);
1702 gtk_window_set_transient_for (GTK_WINDOW (w),
1703 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1704 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1705 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
1707 dd.loop = g_main_loop_new (NULL, FALSE);
1708 dd.response = GTK_RESPONSE_CANCEL;
1709 dd.w = w;
1710 dd.timerid = 0;
1712 g_signal_connect (G_OBJECT (w),
1713 "response",
1714 G_CALLBACK (xg_dialog_response_cb),
1715 &dd);
1716 /* Don't destroy the widget if closed by the window manager close button. */
1717 g_signal_connect (G_OBJECT (w), "delete-event", G_CALLBACK (gtk_true), NULL);
1718 gtk_widget_show (w);
1720 record_unwind_protect (pop_down_dialog, make_save_value (&dd, 0));
1722 (void) xg_maybe_add_timer (&dd);
1723 g_main_loop_run (dd.loop);
1725 dd.w = 0;
1726 unbind_to (count, Qnil);
1728 return dd.response;
1732 /***********************************************************************
1733 File dialog functions
1734 ***********************************************************************/
1735 /* Return true if the old file selection dialog is being used. */
1737 bool
1738 xg_uses_old_file_dialog (void)
1740 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1741 return x_gtk_use_old_file_dialog;
1742 #else
1743 return 0;
1744 #endif
1748 typedef char * (*xg_get_file_func) (GtkWidget *);
1750 /* Return the selected file for file chooser dialog W.
1751 The returned string must be free:d. */
1753 static char *
1754 xg_get_file_name_from_chooser (GtkWidget *w)
1756 return gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (w));
1759 /* Callback called when the "Show hidden files" toggle is pressed.
1760 WIDGET is the toggle widget, DATA is the file chooser dialog. */
1762 static void
1763 xg_toggle_visibility_cb (GtkWidget *widget, gpointer data)
1765 GtkFileChooser *dialog = GTK_FILE_CHOOSER (data);
1766 gboolean visible;
1767 g_object_get (G_OBJECT (dialog), "show-hidden", &visible, NULL);
1768 g_object_set (G_OBJECT (dialog), "show-hidden", !visible, NULL);
1772 /* Callback called when a property changes in a file chooser.
1773 GOBJECT is the file chooser dialog, ARG1 describes the property.
1774 USER_DATA is the toggle widget in the file chooser dialog.
1775 We use this to update the "Show hidden files" toggle when the user
1776 changes that property by right clicking in the file list. */
1778 static void
1779 xg_toggle_notify_cb (GObject *gobject, GParamSpec *arg1, gpointer user_data)
1781 if (strcmp (arg1->name, "show-hidden") == 0)
1783 GtkWidget *wtoggle = GTK_WIDGET (user_data);
1784 gboolean visible, toggle_on;
1786 g_object_get (G_OBJECT (gobject), "show-hidden", &visible, NULL);
1787 toggle_on = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (wtoggle));
1789 if (!!visible != !!toggle_on)
1791 g_signal_handlers_block_by_func (G_OBJECT (wtoggle),
1792 G_CALLBACK (xg_toggle_visibility_cb),
1793 gobject);
1794 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), visible);
1795 g_signal_handlers_unblock_by_func
1796 (G_OBJECT (wtoggle),
1797 G_CALLBACK (xg_toggle_visibility_cb),
1798 gobject);
1800 x_gtk_show_hidden_files = visible;
1804 /* Read a file name from the user using a file chooser dialog.
1805 F is the current frame.
1806 PROMPT is a prompt to show to the user. May not be NULL.
1807 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1808 If MUSTMATCH_P, the returned file name must be an existing
1809 file. (Actually, this only has cosmetic effects, the user can
1810 still enter a non-existing file.) *FUNC is set to a function that
1811 can be used to retrieve the selected file name from the returned widget.
1813 Returns the created widget. */
1815 static GtkWidget *
1816 xg_get_file_with_chooser (FRAME_PTR f,
1817 char *prompt,
1818 char *default_filename,
1819 bool mustmatch_p, bool only_dir_p,
1820 xg_get_file_func *func)
1822 char msgbuf[1024];
1824 GtkWidget *filewin, *wtoggle, *wbox, *wmessage IF_LINT (= NULL);
1825 GtkWindow *gwin = GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f));
1826 GtkFileChooserAction action = (mustmatch_p ?
1827 GTK_FILE_CHOOSER_ACTION_OPEN :
1828 GTK_FILE_CHOOSER_ACTION_SAVE);
1830 if (only_dir_p)
1831 action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
1833 filewin = gtk_file_chooser_dialog_new (prompt, gwin, action,
1834 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1835 (mustmatch_p || only_dir_p ?
1836 GTK_STOCK_OPEN : GTK_STOCK_OK),
1837 GTK_RESPONSE_OK,
1838 NULL);
1839 gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (filewin), TRUE);
1841 wbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
1842 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
1843 gtk_widget_show (wbox);
1844 wtoggle = gtk_check_button_new_with_label ("Show hidden files.");
1846 if (x_gtk_show_hidden_files)
1848 g_object_set (G_OBJECT (filewin), "show-hidden", TRUE, NULL);
1849 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), TRUE);
1851 gtk_widget_show (wtoggle);
1852 g_signal_connect (G_OBJECT (wtoggle), "clicked",
1853 G_CALLBACK (xg_toggle_visibility_cb), filewin);
1854 g_signal_connect (G_OBJECT (filewin), "notify",
1855 G_CALLBACK (xg_toggle_notify_cb), wtoggle);
1857 if (x_gtk_file_dialog_help_text)
1859 msgbuf[0] = '\0';
1860 /* Gtk+ 2.10 has the file name text entry box integrated in the dialog.
1861 Show the C-l help text only for versions < 2.10. */
1862 if (gtk_check_version (2, 10, 0) && action != GTK_FILE_CHOOSER_ACTION_SAVE)
1863 strcat (msgbuf, "\nType C-l to display a file name text entry box.\n");
1864 strcat (msgbuf, "\nIf you don't like this file selector, use the "
1865 "corresponding\nkey binding or customize "
1866 "use-file-dialog to turn it off.");
1868 wmessage = gtk_label_new (msgbuf);
1869 gtk_widget_show (wmessage);
1872 gtk_box_pack_start (GTK_BOX (wbox), wtoggle, FALSE, FALSE, 0);
1873 if (x_gtk_file_dialog_help_text)
1874 gtk_box_pack_start (GTK_BOX (wbox), wmessage, FALSE, FALSE, 0);
1875 gtk_file_chooser_set_extra_widget (GTK_FILE_CHOOSER (filewin), wbox);
1877 if (default_filename)
1879 Lisp_Object file;
1880 struct gcpro gcpro1;
1881 char *utf8_filename;
1882 GCPRO1 (file);
1884 file = build_string (default_filename);
1886 /* File chooser does not understand ~/... in the file name. It must be
1887 an absolute name starting with /. */
1888 if (default_filename[0] != '/')
1889 file = Fexpand_file_name (file, Qnil);
1891 utf8_filename = SSDATA (ENCODE_UTF_8 (file));
1892 if (! NILP (Ffile_directory_p (file)))
1893 gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (filewin),
1894 utf8_filename);
1895 else
1897 gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (filewin),
1898 utf8_filename);
1899 if (action == GTK_FILE_CHOOSER_ACTION_SAVE)
1901 char *cp = strrchr (utf8_filename, '/');
1902 if (cp) ++cp;
1903 else cp = utf8_filename;
1904 gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (filewin), cp);
1908 UNGCPRO;
1911 *func = xg_get_file_name_from_chooser;
1912 return filewin;
1915 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1917 /* Return the selected file for file selector dialog W.
1918 The returned string must be free:d. */
1920 static char *
1921 xg_get_file_name_from_selector (GtkWidget *w)
1923 GtkFileSelection *filesel = GTK_FILE_SELECTION (w);
1924 return xstrdup ((char*) gtk_file_selection_get_filename (filesel));
1927 /* Create a file selection dialog.
1928 F is the current frame.
1929 PROMPT is a prompt to show to the user. May not be NULL.
1930 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1931 If MUSTMATCH_P, the returned file name must be an existing
1932 file. *FUNC is set to a function that can be used to retrieve the
1933 selected file name from the returned widget.
1935 Returns the created widget. */
1937 static GtkWidget *
1938 xg_get_file_with_selection (FRAME_PTR f,
1939 char *prompt,
1940 char *default_filename,
1941 bool mustmatch_p, bool only_dir_p,
1942 xg_get_file_func *func)
1944 GtkWidget *filewin;
1945 GtkFileSelection *filesel;
1947 filewin = gtk_file_selection_new (prompt);
1948 filesel = GTK_FILE_SELECTION (filewin);
1950 if (default_filename)
1951 gtk_file_selection_set_filename (filesel, default_filename);
1953 if (mustmatch_p)
1955 /* The selection_entry part of filesel is not documented. */
1956 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
1957 gtk_file_selection_hide_fileop_buttons (filesel);
1960 *func = xg_get_file_name_from_selector;
1962 return filewin;
1964 #endif /* HAVE_GTK_FILE_SELECTION_NEW */
1966 /* Read a file name from the user using a file dialog, either the old
1967 file selection dialog, or the new file chooser dialog. Which to use
1968 depends on what the GTK version used has, and what the value of
1969 gtk-use-old-file-dialog.
1970 F is the current frame.
1971 PROMPT is a prompt to show to the user. May not be NULL.
1972 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1973 If MUSTMATCH_P, the returned file name must be an existing
1974 file.
1976 Returns a file name or NULL if no file was selected.
1977 The returned string must be freed by the caller. */
1979 char *
1980 xg_get_file_name (FRAME_PTR f,
1981 char *prompt,
1982 char *default_filename,
1983 bool mustmatch_p,
1984 bool only_dir_p)
1986 GtkWidget *w = 0;
1987 char *fn = 0;
1988 int filesel_done = 0;
1989 xg_get_file_func func;
1991 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1993 if (xg_uses_old_file_dialog ())
1994 w = xg_get_file_with_selection (f, prompt, default_filename,
1995 mustmatch_p, only_dir_p, &func);
1996 else
1997 w = xg_get_file_with_chooser (f, prompt, default_filename,
1998 mustmatch_p, only_dir_p, &func);
2000 #else /* not HAVE_GTK_FILE_SELECTION_NEW */
2001 w = xg_get_file_with_chooser (f, prompt, default_filename,
2002 mustmatch_p, only_dir_p, &func);
2003 #endif /* not HAVE_GTK_FILE_SELECTION_NEW */
2005 gtk_widget_set_name (w, "emacs-filedialog");
2007 filesel_done = xg_dialog_run (f, w);
2008 if (filesel_done == GTK_RESPONSE_OK)
2009 fn = (*func) (w);
2011 gtk_widget_destroy (w);
2012 return fn;
2015 /***********************************************************************
2016 GTK font chooser
2017 ***********************************************************************/
2019 #ifdef HAVE_FREETYPE
2021 #if USE_NEW_GTK_FONT_CHOOSER
2023 #define XG_WEIGHT_TO_SYMBOL(w) \
2024 (w <= PANGO_WEIGHT_THIN ? Qextra_light \
2025 : w <= PANGO_WEIGHT_ULTRALIGHT ? Qlight \
2026 : w <= PANGO_WEIGHT_LIGHT ? Qsemi_light \
2027 : w < PANGO_WEIGHT_MEDIUM ? Qnormal \
2028 : w <= PANGO_WEIGHT_SEMIBOLD ? Qsemi_bold \
2029 : w <= PANGO_WEIGHT_BOLD ? Qbold \
2030 : w <= PANGO_WEIGHT_HEAVY ? Qextra_bold \
2031 : Qultra_bold)
2033 #define XG_STYLE_TO_SYMBOL(s) \
2034 (s == PANGO_STYLE_OBLIQUE ? Qoblique \
2035 : s == PANGO_STYLE_ITALIC ? Qitalic \
2036 : Qnormal)
2038 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2041 static char *x_last_font_name;
2042 extern Lisp_Object Qxft;
2044 /* Pop up a GTK font selector and return the name of the font the user
2045 selects, as a C string. The returned font name follows GTK's own
2046 format:
2048 `FAMILY [VALUE1 VALUE2] SIZE'
2050 This can be parsed using font_parse_fcname in font.c.
2051 DEFAULT_NAME, if non-zero, is the default font name. */
2053 Lisp_Object
2054 xg_get_font (FRAME_PTR f, const char *default_name)
2056 GtkWidget *w;
2057 int done = 0;
2058 Lisp_Object font = Qnil;
2060 w = gtk_font_chooser_dialog_new
2061 ("Pick a font", GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2063 if (default_name)
2065 /* Convert fontconfig names to Gtk names, i.e. remove - before
2066 number */
2067 char *p = strrchr (default_name, '-');
2068 if (p)
2070 char *ep = p+1;
2071 while (c_isdigit (*ep))
2072 ++ep;
2073 if (*ep == '\0') *p = ' ';
2076 else if (x_last_font_name)
2077 default_name = x_last_font_name;
2079 if (default_name)
2080 gtk_font_chooser_set_font (GTK_FONT_CHOOSER (w), default_name);
2082 gtk_widget_set_name (w, "emacs-fontdialog");
2083 done = xg_dialog_run (f, w);
2084 if (done == GTK_RESPONSE_OK)
2086 #if USE_NEW_GTK_FONT_CHOOSER
2087 /* Use the GTK3 font chooser. */
2088 PangoFontDescription *desc
2089 = gtk_font_chooser_get_font_desc (GTK_FONT_CHOOSER (w));
2091 if (desc)
2093 Lisp_Object args[10];
2094 const char *name = pango_font_description_get_family (desc);
2095 gint size = pango_font_description_get_size (desc);
2096 PangoWeight weight = pango_font_description_get_weight (desc);
2097 PangoStyle style = pango_font_description_get_style (desc);
2099 args[0] = QCname;
2100 args[1] = build_string (name);
2102 args[2] = QCsize;
2103 args[3] = make_float (pango_units_to_double (size));
2105 args[4] = QCweight;
2106 args[5] = XG_WEIGHT_TO_SYMBOL (weight);
2108 args[6] = QCslant;
2109 args[7] = XG_STYLE_TO_SYMBOL (style);
2111 args[8] = QCtype;
2112 args[9] = Qxft;
2114 font = Ffont_spec (8, args);
2116 pango_font_description_free (desc);
2117 xfree (x_last_font_name);
2118 x_last_font_name = xstrdup (name);
2121 #else /* Use old font selector, which just returns the font name. */
2123 char *font_name
2124 = gtk_font_selection_dialog_get_font_name (GTK_FONT_CHOOSER (w));
2126 if (font_name)
2128 font = build_string (font_name);
2129 g_free (x_last_font_name);
2130 x_last_font_name = font_name;
2132 #endif /* USE_NEW_GTK_FONT_CHOOSER */
2135 gtk_widget_destroy (w);
2136 return font;
2138 #endif /* HAVE_FREETYPE */
2142 /***********************************************************************
2143 Menu functions.
2144 ***********************************************************************/
2146 /* The name of menu items that can be used for customization. Since GTK
2147 RC files are very crude and primitive, we have to set this on all
2148 menu item names so a user can easily customize menu items. */
2150 #define MENU_ITEM_NAME "emacs-menuitem"
2153 /* Linked list of all allocated struct xg_menu_cb_data. Used for marking
2154 during GC. The next member points to the items. */
2155 static xg_list_node xg_menu_cb_list;
2157 /* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
2158 during GC. The next member points to the items. */
2159 static xg_list_node xg_menu_item_cb_list;
2161 /* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
2162 F is the frame CL_DATA will be initialized for.
2163 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2165 The menu bar and all sub menus under the menu bar in a frame
2166 share the same structure, hence the reference count.
2168 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
2169 allocated xg_menu_cb_data if CL_DATA is NULL. */
2171 static xg_menu_cb_data *
2172 make_cl_data (xg_menu_cb_data *cl_data, FRAME_PTR f, GCallback highlight_cb)
2174 if (! cl_data)
2176 cl_data = xmalloc (sizeof *cl_data);
2177 cl_data->f = f;
2178 cl_data->menu_bar_vector = f->menu_bar_vector;
2179 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2180 cl_data->highlight_cb = highlight_cb;
2181 cl_data->ref_count = 0;
2183 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
2186 cl_data->ref_count++;
2188 return cl_data;
2191 /* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
2192 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2194 When the menu bar is updated, menu items may have been added and/or
2195 removed, so menu_bar_vector and menu_bar_items_used change. We must
2196 then update CL_DATA since it is used to determine which menu
2197 item that is invoked in the menu.
2198 HIGHLIGHT_CB could change, there is no check that the same
2199 function is given when modifying a menu bar as was given when
2200 creating the menu bar. */
2202 static void
2203 update_cl_data (xg_menu_cb_data *cl_data,
2204 FRAME_PTR f,
2205 GCallback highlight_cb)
2207 if (cl_data)
2209 cl_data->f = f;
2210 cl_data->menu_bar_vector = f->menu_bar_vector;
2211 cl_data->menu_bar_items_used = f->menu_bar_items_used;
2212 cl_data->highlight_cb = highlight_cb;
2216 /* Decrease reference count for CL_DATA.
2217 If reference count is zero, free CL_DATA. */
2219 static void
2220 unref_cl_data (xg_menu_cb_data *cl_data)
2222 if (cl_data && cl_data->ref_count > 0)
2224 cl_data->ref_count--;
2225 if (cl_data->ref_count == 0)
2227 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
2228 xfree (cl_data);
2233 /* Function that marks all lisp data during GC. */
2235 void
2236 xg_mark_data (void)
2238 xg_list_node *iter;
2239 Lisp_Object rest, frame;
2241 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
2242 mark_object (((xg_menu_cb_data *) iter)->menu_bar_vector);
2244 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
2246 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
2248 if (! NILP (cb_data->help))
2249 mark_object (cb_data->help);
2252 FOR_EACH_FRAME (rest, frame)
2254 FRAME_PTR f = XFRAME (frame);
2256 if (FRAME_X_P (f) && FRAME_GTK_OUTER_WIDGET (f))
2258 struct xg_frame_tb_info *tbinfo
2259 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
2260 TB_INFO_KEY);
2261 if (tbinfo)
2263 mark_object (tbinfo->last_tool_bar);
2264 mark_object (tbinfo->style);
2271 /* Callback called when a menu item is destroyed. Used to free data.
2272 W is the widget that is being destroyed (not used).
2273 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
2275 static void
2276 menuitem_destroy_callback (GtkWidget *w, gpointer client_data)
2278 if (client_data)
2280 xg_menu_item_cb_data *data = (xg_menu_item_cb_data*) client_data;
2281 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
2282 xfree (data);
2286 /* Callback called when the pointer enters/leaves a menu item.
2287 W is the parent of the menu item.
2288 EVENT is either an enter event or leave event.
2289 CLIENT_DATA is not used.
2291 Returns FALSE to tell GTK to keep processing this event. */
2293 static gboolean
2294 menuitem_highlight_callback (GtkWidget *w,
2295 GdkEventCrossing *event,
2296 gpointer client_data)
2298 GdkEvent ev;
2299 GtkWidget *subwidget;
2300 xg_menu_item_cb_data *data;
2302 ev.crossing = *event;
2303 subwidget = gtk_get_event_widget (&ev);
2304 data = (xg_menu_item_cb_data *) g_object_get_data (G_OBJECT (subwidget),
2305 XG_ITEM_DATA);
2306 if (data)
2308 if (! NILP (data->help) && data->cl_data->highlight_cb)
2310 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : data;
2311 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
2312 (*func) (subwidget, call_data);
2316 return FALSE;
2319 /* Callback called when a menu is destroyed. Used to free data.
2320 W is the widget that is being destroyed (not used).
2321 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
2323 static void
2324 menu_destroy_callback (GtkWidget *w, gpointer client_data)
2326 unref_cl_data ((xg_menu_cb_data*) client_data);
2329 /* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
2330 must be non-NULL) and can be inserted into a menu item.
2332 Returns the GtkHBox. */
2334 static GtkWidget *
2335 make_widget_for_menu_item (const char *utf8_label, const char *utf8_key)
2337 GtkWidget *wlbl;
2338 GtkWidget *wkey;
2339 GtkWidget *wbox;
2341 wbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
2342 gtk_box_set_homogeneous (GTK_BOX (wbox), FALSE);
2343 wlbl = gtk_label_new (utf8_label);
2344 wkey = gtk_label_new (utf8_key);
2346 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
2347 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
2349 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
2350 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
2352 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
2353 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
2354 gtk_widget_set_name (wbox, MENU_ITEM_NAME);
2356 return wbox;
2359 /* Make and return a menu item widget with the key to the right.
2360 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
2361 UTF8_KEY is the text representing the key binding.
2362 ITEM is the widget_value describing the menu item.
2364 GROUP is an in/out parameter. If the menu item to be created is not
2365 part of any radio menu group, *GROUP contains NULL on entry and exit.
2366 If the menu item to be created is part of a radio menu group, on entry
2367 *GROUP contains the group to use, or NULL if this is the first item
2368 in the group. On exit, *GROUP contains the radio item group.
2370 Unfortunately, keys don't line up as nicely as in Motif,
2371 but the MacOS X version doesn't either, so I guess that is OK. */
2373 static GtkWidget *
2374 make_menu_item (const char *utf8_label,
2375 const char *utf8_key,
2376 widget_value *item,
2377 GSList **group)
2379 GtkWidget *w;
2380 GtkWidget *wtoadd = 0;
2382 /* It has been observed that some menu items have a NULL name field.
2383 This will lead to this function being called with a NULL utf8_label.
2384 GTK crashes on that so we set a blank label. Why there is a NULL
2385 name remains to be investigated. */
2386 if (! utf8_label) utf8_label = " ";
2388 if (utf8_key)
2389 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2391 if (item->button_type == BUTTON_TYPE_TOGGLE)
2393 *group = NULL;
2394 if (utf8_key) w = gtk_check_menu_item_new ();
2395 else w = gtk_check_menu_item_new_with_label (utf8_label);
2396 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
2398 else if (item->button_type == BUTTON_TYPE_RADIO)
2400 if (utf8_key) w = gtk_radio_menu_item_new (*group);
2401 else w = gtk_radio_menu_item_new_with_label (*group, utf8_label);
2402 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
2403 if (item->selected)
2404 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
2406 else
2408 *group = NULL;
2409 if (utf8_key) w = gtk_menu_item_new ();
2410 else w = gtk_menu_item_new_with_label (utf8_label);
2413 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
2414 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
2416 return w;
2419 static int xg_detached_menus;
2421 /* Return true if there are detached menus. */
2423 bool
2424 xg_have_tear_offs (void)
2426 return xg_detached_menus > 0;
2429 /* Callback invoked when a detached menu window is removed. Here we
2430 decrease the xg_detached_menus count.
2431 WIDGET is the top level window that is removed (the parent of the menu).
2432 CLIENT_DATA is not used. */
2434 static void
2435 tearoff_remove (GtkWidget *widget, gpointer client_data)
2437 if (xg_detached_menus > 0) --xg_detached_menus;
2440 /* Callback invoked when a menu is detached. It increases the
2441 xg_detached_menus count.
2442 WIDGET is the GtkTearoffMenuItem.
2443 CLIENT_DATA is not used. */
2445 static void
2446 tearoff_activate (GtkWidget *widget, gpointer client_data)
2448 GtkWidget *menu = gtk_widget_get_parent (widget);
2449 if (gtk_menu_get_tearoff_state (GTK_MENU (menu)))
2451 ++xg_detached_menus;
2452 g_signal_connect (G_OBJECT (gtk_widget_get_toplevel (widget)),
2453 "destroy",
2454 G_CALLBACK (tearoff_remove), 0);
2459 /* Create a menu item widget, and connect the callbacks.
2460 ITEM describes the menu item.
2461 F is the frame the created menu belongs to.
2462 SELECT_CB is the callback to use when a menu item is selected.
2463 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2464 CL_DATA points to the callback data to be used for this menu.
2465 GROUP is an in/out parameter. If the menu item to be created is not
2466 part of any radio menu group, *GROUP contains NULL on entry and exit.
2467 If the menu item to be created is part of a radio menu group, on entry
2468 *GROUP contains the group to use, or NULL if this is the first item
2469 in the group. On exit, *GROUP contains the radio item group.
2471 Returns the created GtkWidget. */
2473 static GtkWidget *
2474 xg_create_one_menuitem (widget_value *item,
2475 FRAME_PTR f,
2476 GCallback select_cb,
2477 GCallback highlight_cb,
2478 xg_menu_cb_data *cl_data,
2479 GSList **group)
2481 char *utf8_label;
2482 char *utf8_key;
2483 GtkWidget *w;
2484 xg_menu_item_cb_data *cb_data;
2486 utf8_label = get_utf8_string (item->name);
2487 utf8_key = get_utf8_string (item->key);
2489 w = make_menu_item (utf8_label, utf8_key, item, group);
2491 if (utf8_label) g_free (utf8_label);
2492 if (utf8_key) g_free (utf8_key);
2494 cb_data = xmalloc (sizeof *cb_data);
2496 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
2498 cb_data->select_id = 0;
2499 cb_data->help = item->help;
2500 cb_data->cl_data = cl_data;
2501 cb_data->call_data = item->call_data;
2503 g_signal_connect (G_OBJECT (w),
2504 "destroy",
2505 G_CALLBACK (menuitem_destroy_callback),
2506 cb_data);
2508 /* Put cb_data in widget, so we can get at it when modifying menubar */
2509 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
2511 /* final item, not a submenu */
2512 if (item->call_data && ! item->contents)
2514 if (select_cb)
2515 cb_data->select_id
2516 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
2519 return w;
2522 /* Create a full menu tree specified by DATA.
2523 F is the frame the created menu belongs to.
2524 SELECT_CB is the callback to use when a menu item is selected.
2525 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2526 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2527 If POP_UP_P, create a popup menu.
2528 If MENU_BAR_P, create a menu bar.
2529 If ADD_TEAROFF_P, add a tearoff menu item. Ignored if MENU_BAR_P.
2530 TOPMENU is the topmost GtkWidget that others shall be placed under.
2531 It may be NULL, in that case we create the appropriate widget
2532 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
2533 CL_DATA is the callback data we shall use for this menu, or NULL
2534 if we haven't set the first callback yet.
2535 NAME is the name to give to the top level menu if this function
2536 creates it. May be NULL to not set any name.
2538 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
2539 not NULL.
2541 This function calls itself to create submenus. */
2543 static GtkWidget *
2544 create_menus (widget_value *data,
2545 FRAME_PTR f,
2546 GCallback select_cb,
2547 GCallback deactivate_cb,
2548 GCallback highlight_cb,
2549 bool pop_up_p,
2550 bool menu_bar_p,
2551 bool add_tearoff_p,
2552 GtkWidget *topmenu,
2553 xg_menu_cb_data *cl_data,
2554 const char *name)
2556 widget_value *item;
2557 GtkWidget *wmenu = topmenu;
2558 GSList *group = NULL;
2560 if (! topmenu)
2562 if (! menu_bar_p)
2564 wmenu = gtk_menu_new ();
2565 xg_set_screen (wmenu, f);
2566 /* Connect this to the menu instead of items so we get enter/leave for
2567 disabled items also. TODO: Still does not get enter/leave for
2568 disabled items in detached menus. */
2569 g_signal_connect (G_OBJECT (wmenu),
2570 "enter-notify-event",
2571 G_CALLBACK (menuitem_highlight_callback),
2572 NULL);
2573 g_signal_connect (G_OBJECT (wmenu),
2574 "leave-notify-event",
2575 G_CALLBACK (menuitem_highlight_callback),
2576 NULL);
2578 else
2580 wmenu = gtk_menu_bar_new ();
2581 /* Set width of menu bar to a small value so it doesn't enlarge
2582 a small initial frame size. The width will be set to the
2583 width of the frame later on when it is added to a container.
2584 height -1: Natural height. */
2585 gtk_widget_set_size_request (wmenu, 1, -1);
2588 /* Put cl_data on the top menu for easier access. */
2589 cl_data = make_cl_data (cl_data, f, highlight_cb);
2590 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
2591 g_signal_connect (G_OBJECT (wmenu), "destroy",
2592 G_CALLBACK (menu_destroy_callback), cl_data);
2594 if (name)
2595 gtk_widget_set_name (wmenu, name);
2597 if (deactivate_cb)
2598 g_signal_connect (G_OBJECT (wmenu),
2599 "selection-done", deactivate_cb, 0);
2602 if (! menu_bar_p && add_tearoff_p)
2604 GtkWidget *tearoff = gtk_tearoff_menu_item_new ();
2605 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), tearoff);
2607 g_signal_connect (G_OBJECT (tearoff), "activate",
2608 G_CALLBACK (tearoff_activate), 0);
2611 for (item = data; item; item = item->next)
2613 GtkWidget *w;
2615 if (pop_up_p && !item->contents && !item->call_data
2616 && !menu_separator_name_p (item->name))
2618 char *utf8_label;
2619 /* A title for a popup. We do the same as GTK does when
2620 creating titles, but it does not look good. */
2621 group = NULL;
2622 utf8_label = get_utf8_string (item->name);
2624 gtk_menu_set_title (GTK_MENU (wmenu), utf8_label);
2625 w = gtk_menu_item_new_with_label (utf8_label);
2626 gtk_widget_set_sensitive (w, FALSE);
2627 if (utf8_label) g_free (utf8_label);
2629 else if (menu_separator_name_p (item->name))
2631 group = NULL;
2632 /* GTK only have one separator type. */
2633 w = gtk_separator_menu_item_new ();
2635 else
2637 w = xg_create_one_menuitem (item,
2639 item->contents ? 0 : select_cb,
2640 highlight_cb,
2641 cl_data,
2642 &group);
2644 /* Create a possibly empty submenu for menu bar items, since some
2645 themes don't highlight items correctly without it. */
2646 if (item->contents || menu_bar_p)
2648 GtkWidget *submenu = create_menus (item->contents,
2650 select_cb,
2651 deactivate_cb,
2652 highlight_cb,
2655 add_tearoff_p,
2657 cl_data,
2659 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2663 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
2664 gtk_widget_set_name (w, MENU_ITEM_NAME);
2667 return wmenu;
2670 /* Create a menubar, popup menu or dialog, depending on the TYPE argument.
2671 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
2672 with some text and buttons.
2673 F is the frame the created item belongs to.
2674 NAME is the name to use for the top widget.
2675 VAL is a widget_value structure describing items to be created.
2676 SELECT_CB is the callback to use when a menu item is selected or
2677 a dialog button is pressed.
2678 DEACTIVATE_CB is the callback to use when an item is deactivated.
2679 For a menu, when a sub menu is not shown anymore, for a dialog it is
2680 called when the dialog is popped down.
2681 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2683 Returns the widget created. */
2685 GtkWidget *
2686 xg_create_widget (const char *type, const char *name, FRAME_PTR f, widget_value *val,
2687 GCallback select_cb, GCallback deactivate_cb,
2688 GCallback highlight_cb)
2690 GtkWidget *w = 0;
2691 bool menu_bar_p = strcmp (type, "menubar") == 0;
2692 bool pop_up_p = strcmp (type, "popup") == 0;
2694 if (strcmp (type, "dialog") == 0)
2696 w = create_dialog (val, select_cb, deactivate_cb);
2697 xg_set_screen (w, f);
2698 gtk_window_set_transient_for (GTK_WINDOW (w),
2699 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2700 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
2701 gtk_widget_set_name (w, "emacs-dialog");
2702 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
2704 else if (menu_bar_p || pop_up_p)
2706 w = create_menus (val->contents,
2708 select_cb,
2709 deactivate_cb,
2710 highlight_cb,
2711 pop_up_p,
2712 menu_bar_p,
2713 menu_bar_p,
2716 name);
2718 /* Set the cursor to an arrow for popup menus when they are mapped.
2719 This is done by default for menu bar menus. */
2720 if (pop_up_p)
2722 /* Must realize so the GdkWindow inside the widget is created. */
2723 gtk_widget_realize (w);
2724 xg_set_cursor (w, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
2727 else
2729 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
2730 type);
2733 return w;
2736 /* Return the label for menu item WITEM. */
2738 static const char *
2739 xg_get_menu_item_label (GtkMenuItem *witem)
2741 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2742 return gtk_label_get_label (wlabel);
2745 /* Return true if the menu item WITEM has the text LABEL. */
2747 static bool
2748 xg_item_label_same_p (GtkMenuItem *witem, const char *label)
2750 bool is_same = 0;
2751 char *utf8_label = get_utf8_string (label);
2752 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
2754 if (! old_label && ! utf8_label)
2755 is_same = 1;
2756 else if (old_label && utf8_label)
2757 is_same = strcmp (utf8_label, old_label) == 0;
2759 if (utf8_label) g_free (utf8_label);
2761 return is_same;
2764 /* Destroy widgets in LIST. */
2766 static void
2767 xg_destroy_widgets (GList *list)
2769 GList *iter;
2771 for (iter = list; iter; iter = g_list_next (iter))
2773 GtkWidget *w = GTK_WIDGET (iter->data);
2775 /* Destroying the widget will remove it from the container it is in. */
2776 gtk_widget_destroy (w);
2780 /* Update the top level names in MENUBAR (i.e. not submenus).
2781 F is the frame the menu bar belongs to.
2782 *LIST is a list with the current menu bar names (menu item widgets).
2783 ITER is the item within *LIST that shall be updated.
2784 POS is the numerical position, starting at 0, of ITER in *LIST.
2785 VAL describes what the menu bar shall look like after the update.
2786 SELECT_CB is the callback to use when a menu item is selected.
2787 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2788 CL_DATA points to the callback data to be used for this menu bar.
2790 This function calls itself to walk through the menu bar names. */
2792 static void
2793 xg_update_menubar (GtkWidget *menubar,
2794 FRAME_PTR f,
2795 GList **list,
2796 GList *iter,
2797 int pos,
2798 widget_value *val,
2799 GCallback select_cb,
2800 GCallback deactivate_cb,
2801 GCallback highlight_cb,
2802 xg_menu_cb_data *cl_data)
2804 if (! iter && ! val)
2805 return;
2806 else if (iter && ! val)
2808 /* Item(s) have been removed. Remove all remaining items. */
2809 xg_destroy_widgets (iter);
2811 /* Add a blank entry so the menubar doesn't collapse to nothing. */
2812 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2813 gtk_menu_item_new_with_label (""),
2815 /* All updated. */
2816 val = 0;
2817 iter = 0;
2819 else if (! iter && val)
2821 /* Item(s) added. Add all new items in one call. */
2822 create_menus (val, f, select_cb, deactivate_cb, highlight_cb,
2823 0, 1, 0, menubar, cl_data, 0);
2825 /* All updated. */
2826 val = 0;
2827 iter = 0;
2829 /* Below this neither iter or val is NULL */
2830 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
2832 /* This item is still the same, check next item. */
2833 val = val->next;
2834 iter = g_list_next (iter);
2835 ++pos;
2837 else /* This item is changed. */
2839 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
2840 GtkMenuItem *witem2 = 0;
2841 bool val_in_menubar = 0;
2842 bool iter_in_new_menubar = 0;
2843 GList *iter2;
2844 widget_value *cur;
2846 /* See if the changed entry (val) is present later in the menu bar */
2847 for (iter2 = iter;
2848 iter2 && ! val_in_menubar;
2849 iter2 = g_list_next (iter2))
2851 witem2 = GTK_MENU_ITEM (iter2->data);
2852 val_in_menubar = xg_item_label_same_p (witem2, val->name);
2855 /* See if the current entry (iter) is present later in the
2856 specification for the new menu bar. */
2857 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
2858 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
2860 if (val_in_menubar && ! iter_in_new_menubar)
2862 int nr = pos;
2864 /* This corresponds to:
2865 Current: A B C
2866 New: A C
2867 Remove B. */
2869 g_object_ref (G_OBJECT (witem));
2870 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
2871 gtk_widget_destroy (GTK_WIDGET (witem));
2873 /* Must get new list since the old changed. */
2874 g_list_free (*list);
2875 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2876 while (nr-- > 0) iter = g_list_next (iter);
2878 else if (! val_in_menubar && ! iter_in_new_menubar)
2880 /* This corresponds to:
2881 Current: A B C
2882 New: A X C
2883 Rename B to X. This might seem to be a strange thing to do,
2884 since if there is a menu under B it will be totally wrong for X.
2885 But consider editing a C file. Then there is a C-mode menu
2886 (corresponds to B above).
2887 If then doing C-x C-f the minibuf menu (X above) replaces the
2888 C-mode menu. When returning from the minibuffer, we get
2889 back the C-mode menu. Thus we do:
2890 Rename B to X (C-mode to minibuf menu)
2891 Rename X to B (minibuf to C-mode menu).
2892 If the X menu hasn't been invoked, the menu under B
2893 is up to date when leaving the minibuffer. */
2894 GtkLabel *wlabel = GTK_LABEL (XG_BIN_CHILD (witem));
2895 char *utf8_label = get_utf8_string (val->name);
2896 GtkWidget *submenu = gtk_menu_item_get_submenu (witem);
2898 gtk_label_set_text (wlabel, utf8_label);
2900 /* If this item has a submenu that has been detached, change
2901 the title in the WM decorations also. */
2902 if (submenu && gtk_menu_get_tearoff_state (GTK_MENU (submenu)))
2903 /* Set the title of the detached window. */
2904 gtk_menu_set_title (GTK_MENU (submenu), utf8_label);
2906 if (utf8_label) g_free (utf8_label);
2907 iter = g_list_next (iter);
2908 val = val->next;
2909 ++pos;
2911 else if (! val_in_menubar && iter_in_new_menubar)
2913 /* This corresponds to:
2914 Current: A B C
2915 New: A X B C
2916 Insert X. */
2918 int nr = pos;
2919 GSList *group = 0;
2920 GtkWidget *w = xg_create_one_menuitem (val,
2922 select_cb,
2923 highlight_cb,
2924 cl_data,
2925 &group);
2927 /* Create a possibly empty submenu for menu bar items, since some
2928 themes don't highlight items correctly without it. */
2929 GtkWidget *submenu = create_menus (NULL, f,
2930 select_cb, deactivate_cb,
2931 highlight_cb,
2932 0, 0, 0, 0, cl_data, 0);
2933 gtk_widget_set_name (w, MENU_ITEM_NAME);
2934 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
2935 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2937 g_list_free (*list);
2938 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2939 while (nr-- > 0) iter = g_list_next (iter);
2940 iter = g_list_next (iter);
2941 val = val->next;
2942 ++pos;
2944 else /* if (val_in_menubar && iter_in_new_menubar) */
2946 int nr = pos;
2947 /* This corresponds to:
2948 Current: A B C
2949 New: A C B
2950 Move C before B */
2952 g_object_ref (G_OBJECT (witem2));
2953 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
2954 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2955 GTK_WIDGET (witem2), pos);
2956 g_object_unref (G_OBJECT (witem2));
2958 g_list_free (*list);
2959 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2960 while (nr-- > 0) iter = g_list_next (iter);
2961 if (iter) iter = g_list_next (iter);
2962 val = val->next;
2963 ++pos;
2967 /* Update the rest of the menu bar. */
2968 xg_update_menubar (menubar, f, list, iter, pos, val,
2969 select_cb, deactivate_cb, highlight_cb, cl_data);
2972 /* Update the menu item W so it corresponds to VAL.
2973 SELECT_CB is the callback to use when a menu item is selected.
2974 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2975 CL_DATA is the data to set in the widget for menu invocation. */
2977 static void
2978 xg_update_menu_item (widget_value *val,
2979 GtkWidget *w,
2980 GCallback select_cb,
2981 GCallback highlight_cb,
2982 xg_menu_cb_data *cl_data)
2984 GtkWidget *wchild;
2985 GtkLabel *wlbl = 0;
2986 GtkLabel *wkey = 0;
2987 char *utf8_label;
2988 char *utf8_key;
2989 const char *old_label = 0;
2990 const char *old_key = 0;
2991 xg_menu_item_cb_data *cb_data;
2993 wchild = XG_BIN_CHILD (w);
2994 utf8_label = get_utf8_string (val->name);
2995 utf8_key = get_utf8_string (val->key);
2997 /* See if W is a menu item with a key. See make_menu_item above. */
2998 if (GTK_IS_BOX (wchild))
3000 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
3002 wlbl = GTK_LABEL (list->data);
3003 wkey = GTK_LABEL (list->next->data);
3004 g_list_free (list);
3006 if (! utf8_key)
3008 /* Remove the key and keep just the label. */
3009 g_object_ref (G_OBJECT (wlbl));
3010 gtk_container_remove (GTK_CONTAINER (w), wchild);
3011 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
3012 g_object_unref (G_OBJECT (wlbl));
3013 wkey = 0;
3017 else /* Just a label. */
3019 wlbl = GTK_LABEL (wchild);
3021 /* Check if there is now a key. */
3022 if (utf8_key)
3024 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
3025 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
3027 wlbl = GTK_LABEL (list->data);
3028 wkey = GTK_LABEL (list->next->data);
3029 g_list_free (list);
3031 gtk_container_remove (GTK_CONTAINER (w), wchild);
3032 gtk_container_add (GTK_CONTAINER (w), wtoadd);
3037 if (wkey) old_key = gtk_label_get_label (wkey);
3038 if (wlbl) old_label = gtk_label_get_label (wlbl);
3040 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
3041 gtk_label_set_text (wkey, utf8_key);
3043 if (! old_label || strcmp (utf8_label, old_label) != 0)
3044 gtk_label_set_text (wlbl, utf8_label);
3046 if (utf8_key) g_free (utf8_key);
3047 if (utf8_label) g_free (utf8_label);
3049 if (! val->enabled && gtk_widget_get_sensitive (w))
3050 gtk_widget_set_sensitive (w, FALSE);
3051 else if (val->enabled && ! gtk_widget_get_sensitive (w))
3052 gtk_widget_set_sensitive (w, TRUE);
3054 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (w),
3055 XG_ITEM_DATA);
3056 if (cb_data)
3058 cb_data->call_data = val->call_data;
3059 cb_data->help = val->help;
3060 cb_data->cl_data = cl_data;
3062 /* We assume the callback functions don't change. */
3063 if (val->call_data && ! val->contents)
3065 /* This item shall have a select callback. */
3066 if (! cb_data->select_id)
3067 cb_data->select_id
3068 = g_signal_connect (G_OBJECT (w), "activate",
3069 select_cb, cb_data);
3071 else if (cb_data->select_id)
3073 g_signal_handler_disconnect (w, cb_data->select_id);
3074 cb_data->select_id = 0;
3079 /* Update the toggle menu item W so it corresponds to VAL. */
3081 static void
3082 xg_update_toggle_item (widget_value *val, GtkWidget *w)
3084 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3087 /* Update the radio menu item W so it corresponds to VAL. */
3089 static void
3090 xg_update_radio_item (widget_value *val, GtkWidget *w)
3092 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
3095 /* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
3096 SUBMENU may be NULL, in that case a new menu is created.
3097 F is the frame the menu bar belongs to.
3098 VAL describes the contents of the menu bar.
3099 SELECT_CB is the callback to use when a menu item is selected.
3100 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3101 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
3102 CL_DATA is the call back data to use for any newly created items.
3104 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
3105 was NULL. */
3107 static GtkWidget *
3108 xg_update_submenu (GtkWidget *submenu,
3109 FRAME_PTR f,
3110 widget_value *val,
3111 GCallback select_cb,
3112 GCallback deactivate_cb,
3113 GCallback highlight_cb,
3114 xg_menu_cb_data *cl_data)
3116 GtkWidget *newsub = submenu;
3117 GList *list = 0;
3118 GList *iter;
3119 widget_value *cur;
3120 bool has_tearoff_p = 0;
3121 GList *first_radio = 0;
3123 if (submenu)
3124 list = gtk_container_get_children (GTK_CONTAINER (submenu));
3126 for (cur = val, iter = list;
3127 cur && iter;
3128 iter = g_list_next (iter), cur = cur->next)
3130 GtkWidget *w = GTK_WIDGET (iter->data);
3132 /* Skip tearoff items, they have no counterpart in val. */
3133 if (GTK_IS_TEAROFF_MENU_ITEM (w))
3135 has_tearoff_p = 1;
3136 iter = g_list_next (iter);
3137 if (iter) w = GTK_WIDGET (iter->data);
3138 else break;
3141 /* Remember first radio button in a group. If we get a mismatch in
3142 a radio group we must rebuild the whole group so that the connections
3143 in GTK becomes correct. */
3144 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
3145 first_radio = iter;
3146 else if (cur->button_type != BUTTON_TYPE_RADIO
3147 && ! GTK_IS_RADIO_MENU_ITEM (w))
3148 first_radio = 0;
3150 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
3152 if (! menu_separator_name_p (cur->name))
3153 break;
3155 else if (GTK_IS_CHECK_MENU_ITEM (w))
3157 if (cur->button_type != BUTTON_TYPE_TOGGLE)
3158 break;
3159 xg_update_toggle_item (cur, w);
3160 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3162 else if (GTK_IS_RADIO_MENU_ITEM (w))
3164 if (cur->button_type != BUTTON_TYPE_RADIO)
3165 break;
3166 xg_update_radio_item (cur, w);
3167 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3169 else if (GTK_IS_MENU_ITEM (w))
3171 GtkMenuItem *witem = GTK_MENU_ITEM (w);
3172 GtkWidget *sub;
3174 if (cur->button_type != BUTTON_TYPE_NONE ||
3175 menu_separator_name_p (cur->name))
3176 break;
3178 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
3180 sub = gtk_menu_item_get_submenu (witem);
3181 if (sub && ! cur->contents)
3183 /* Not a submenu anymore. */
3184 g_object_ref (G_OBJECT (sub));
3185 remove_submenu (witem);
3186 gtk_widget_destroy (sub);
3188 else if (cur->contents)
3190 GtkWidget *nsub;
3192 nsub = xg_update_submenu (sub, f, cur->contents,
3193 select_cb, deactivate_cb,
3194 highlight_cb, cl_data);
3196 /* If this item just became a submenu, we must set it. */
3197 if (nsub != sub)
3198 gtk_menu_item_set_submenu (witem, nsub);
3201 else
3203 /* Structural difference. Remove everything from here and down
3204 in SUBMENU. */
3205 break;
3209 /* Remove widgets from first structural change. */
3210 if (iter)
3212 /* If we are adding new menu items below, we must remove from
3213 first radio button so that radio groups become correct. */
3214 if (cur && first_radio) xg_destroy_widgets (first_radio);
3215 else xg_destroy_widgets (iter);
3218 if (cur)
3220 /* More items added. Create them. */
3221 newsub = create_menus (cur,
3223 select_cb,
3224 deactivate_cb,
3225 highlight_cb,
3228 ! has_tearoff_p,
3229 submenu,
3230 cl_data,
3234 if (list) g_list_free (list);
3236 return newsub;
3239 /* Update the MENUBAR.
3240 F is the frame the menu bar belongs to.
3241 VAL describes the contents of the menu bar.
3242 If DEEP_P, rebuild all but the top level menu names in
3243 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
3244 SELECT_CB is the callback to use when a menu item is selected.
3245 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
3246 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
3248 void
3249 xg_modify_menubar_widgets (GtkWidget *menubar, FRAME_PTR f, widget_value *val,
3250 bool deep_p,
3251 GCallback select_cb, GCallback deactivate_cb,
3252 GCallback highlight_cb)
3254 xg_menu_cb_data *cl_data;
3255 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
3257 if (! list) return;
3259 cl_data = (xg_menu_cb_data*) g_object_get_data (G_OBJECT (menubar),
3260 XG_FRAME_DATA);
3262 xg_update_menubar (menubar, f, &list, list, 0, val->contents,
3263 select_cb, deactivate_cb, highlight_cb, cl_data);
3265 if (deep_p)
3267 widget_value *cur;
3269 /* Update all sub menus.
3270 We must keep the submenus (GTK menu item widgets) since the
3271 X Window in the XEvent that activates the menu are those widgets. */
3273 /* Update cl_data, menu_item things in F may have changed. */
3274 update_cl_data (cl_data, f, highlight_cb);
3276 for (cur = val->contents; cur; cur = cur->next)
3278 GList *iter;
3279 GtkWidget *sub = 0;
3280 GtkWidget *newsub;
3281 GtkMenuItem *witem = 0;
3283 /* Find sub menu that corresponds to val and update it. */
3284 for (iter = list ; iter; iter = g_list_next (iter))
3286 witem = GTK_MENU_ITEM (iter->data);
3287 if (xg_item_label_same_p (witem, cur->name))
3289 sub = gtk_menu_item_get_submenu (witem);
3290 break;
3294 newsub = xg_update_submenu (sub,
3296 cur->contents,
3297 select_cb,
3298 deactivate_cb,
3299 highlight_cb,
3300 cl_data);
3301 /* sub may still be NULL. If we just updated non deep and added
3302 a new menu bar item, it has no sub menu yet. So we set the
3303 newly created sub menu under witem. */
3304 if (newsub != sub && witem != 0)
3306 xg_set_screen (newsub, f);
3307 gtk_menu_item_set_submenu (witem, newsub);
3312 g_list_free (list);
3313 gtk_widget_show_all (menubar);
3316 /* Callback called when the menu bar W is mapped.
3317 Used to find the height of the menu bar if we didn't get it
3318 after showing the widget. */
3320 static void
3321 menubar_map_cb (GtkWidget *w, gpointer user_data)
3323 GtkRequisition req;
3324 FRAME_PTR f = (FRAME_PTR) user_data;
3325 gtk_widget_get_preferred_size (w, NULL, &req);
3326 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3328 FRAME_MENUBAR_HEIGHT (f) = req.height;
3329 xg_height_or_width_changed (f);
3333 /* Recompute all the widgets of frame F, when the menu bar has been
3334 changed. */
3336 void
3337 xg_update_frame_menubar (FRAME_PTR f)
3339 struct x_output *x = f->output_data.x;
3340 GtkRequisition req;
3342 if (!x->menubar_widget || gtk_widget_get_mapped (x->menubar_widget))
3343 return;
3345 if (x->menubar_widget && gtk_widget_get_parent (x->menubar_widget))
3346 return; /* Already done this, happens for frames created invisible. */
3348 block_input ();
3350 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
3351 FALSE, FALSE, 0);
3352 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
3354 g_signal_connect (x->menubar_widget, "map", G_CALLBACK (menubar_map_cb), f);
3355 gtk_widget_show_all (x->menubar_widget);
3356 gtk_widget_get_preferred_size (x->menubar_widget, NULL, &req);
3358 /* If menu bar doesn't know its height yet, cheat a little so the frame
3359 doesn't jump so much when resized later in menubar_map_cb. */
3360 if (req.height == 0)
3361 req.height = 23;
3363 if (FRAME_MENUBAR_HEIGHT (f) != req.height)
3365 FRAME_MENUBAR_HEIGHT (f) = req.height;
3366 xg_height_or_width_changed (f);
3368 unblock_input ();
3371 /* Get rid of the menu bar of frame F, and free its storage.
3372 This is used when deleting a frame, and when turning off the menu bar. */
3374 void
3375 free_frame_menubar (FRAME_PTR f)
3377 struct x_output *x = f->output_data.x;
3379 if (x->menubar_widget)
3381 block_input ();
3383 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
3384 /* The menubar and its children shall be deleted when removed from
3385 the container. */
3386 x->menubar_widget = 0;
3387 FRAME_MENUBAR_HEIGHT (f) = 0;
3388 xg_height_or_width_changed (f);
3389 unblock_input ();
3393 bool
3394 xg_event_is_for_menubar (FRAME_PTR f, XEvent *event)
3396 struct x_output *x = f->output_data.x;
3397 GList *iter;
3398 GdkRectangle rec;
3399 GList *list;
3400 GdkDisplay *gdpy;
3401 GdkWindow *gw;
3402 GdkEvent gevent;
3403 GtkWidget *gwdesc;
3405 if (! x->menubar_widget) return 0;
3407 if (! (event->xbutton.x >= 0
3408 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
3409 && event->xbutton.y >= 0
3410 && event->xbutton.y < f->output_data.x->menubar_height
3411 && event->xbutton.same_screen))
3412 return 0;
3414 gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3415 gw = gdk_x11_window_lookup_for_display (gdpy, event->xbutton.window);
3416 if (! gw) return 0;
3417 gevent.any.window = gw;
3418 gevent.any.type = GDK_NOTHING;
3419 gwdesc = gtk_get_event_widget (&gevent);
3420 if (! gwdesc) return 0;
3421 if (! GTK_IS_MENU_BAR (gwdesc)
3422 && ! GTK_IS_MENU_ITEM (gwdesc)
3423 && ! gtk_widget_is_ancestor (x->menubar_widget, gwdesc))
3424 return 0;
3426 list = gtk_container_get_children (GTK_CONTAINER (x->menubar_widget));
3427 if (! list) return 0;
3428 rec.x = event->xbutton.x;
3429 rec.y = event->xbutton.y;
3430 rec.width = 1;
3431 rec.height = 1;
3433 for (iter = list ; iter; iter = g_list_next (iter))
3435 GtkWidget *w = GTK_WIDGET (iter->data);
3436 if (gtk_widget_get_mapped (w) && gtk_widget_intersect (w, &rec, NULL))
3437 break;
3439 g_list_free (list);
3440 return iter != 0;
3445 /***********************************************************************
3446 Scroll bar functions
3447 ***********************************************************************/
3450 /* Setting scroll bar values invokes the callback. Use this variable
3451 to indicate that callback should do nothing. */
3453 bool xg_ignore_gtk_scrollbar;
3455 /* The width of the scroll bar for the current theme. */
3457 static int scroll_bar_width_for_theme;
3459 /* Xlib's `Window' fits in 32 bits. But we want to store pointers, and they
3460 may be larger than 32 bits. Keep a mapping from integer index to widget
3461 pointers to get around the 32 bit limitation. */
3463 static struct
3465 GtkWidget **widgets;
3466 ptrdiff_t max_size;
3467 ptrdiff_t used;
3468 } id_to_widget;
3470 /* Grow this much every time we need to allocate more */
3472 #define ID_TO_WIDGET_INCR 32
3474 /* Store the widget pointer W in id_to_widget and return the integer index. */
3476 static ptrdiff_t
3477 xg_store_widget_in_map (GtkWidget *w)
3479 ptrdiff_t i;
3481 if (id_to_widget.max_size == id_to_widget.used)
3483 ptrdiff_t new_size;
3484 if (TYPE_MAXIMUM (Window) - ID_TO_WIDGET_INCR < id_to_widget.max_size)
3485 memory_full (SIZE_MAX);
3487 new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
3488 id_to_widget.widgets = xnrealloc (id_to_widget.widgets,
3489 new_size, sizeof (GtkWidget *));
3491 for (i = id_to_widget.max_size; i < new_size; ++i)
3492 id_to_widget.widgets[i] = 0;
3493 id_to_widget.max_size = new_size;
3496 /* Just loop over the array and find a free place. After all,
3497 how many scroll bars are we creating? Should be a small number.
3498 The check above guarantees we will find a free place. */
3499 for (i = 0; i < id_to_widget.max_size; ++i)
3501 if (! id_to_widget.widgets[i])
3503 id_to_widget.widgets[i] = w;
3504 ++id_to_widget.used;
3506 return i;
3510 /* Should never end up here */
3511 emacs_abort ();
3514 /* Remove pointer at IDX from id_to_widget.
3515 Called when scroll bar is destroyed. */
3517 static void
3518 xg_remove_widget_from_map (ptrdiff_t idx)
3520 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3522 id_to_widget.widgets[idx] = 0;
3523 --id_to_widget.used;
3527 /* Get the widget pointer at IDX from id_to_widget. */
3529 static GtkWidget *
3530 xg_get_widget_from_map (ptrdiff_t idx)
3532 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
3533 return id_to_widget.widgets[idx];
3535 return 0;
3538 static void
3539 update_theme_scrollbar_width (void)
3541 #ifdef HAVE_GTK3
3542 GtkAdjustment *vadj;
3543 #else
3544 GtkObject *vadj;
3545 #endif
3546 GtkWidget *wscroll;
3547 int w = 0, b = 0;
3549 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX, 0.1, 0.1, 0.1);
3550 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3551 g_object_ref_sink (G_OBJECT (wscroll));
3552 gtk_widget_style_get (wscroll, "slider-width", &w, "trough-border", &b, NULL);
3553 gtk_widget_destroy (wscroll);
3554 g_object_unref (G_OBJECT (wscroll));
3555 w += 2*b;
3556 if (w < 16) w = 16;
3557 scroll_bar_width_for_theme = w;
3561 xg_get_default_scrollbar_width (void)
3563 return scroll_bar_width_for_theme;
3566 /* Return the scrollbar id for X Window WID on display DPY.
3567 Return -1 if WID not in id_to_widget. */
3569 ptrdiff_t
3570 xg_get_scroll_id_for_window (Display *dpy, Window wid)
3572 ptrdiff_t idx;
3573 GtkWidget *w;
3575 w = xg_win_to_widget (dpy, wid);
3577 if (w)
3579 for (idx = 0; idx < id_to_widget.max_size; ++idx)
3580 if (id_to_widget.widgets[idx] == w)
3581 return idx;
3584 return -1;
3587 /* Callback invoked when scroll bar WIDGET is destroyed.
3588 DATA is the index into id_to_widget for WIDGET.
3589 We free pointer to last scroll bar values here and remove the index. */
3591 static void
3592 xg_gtk_scroll_destroy (GtkWidget *widget, gpointer data)
3594 intptr_t id = (intptr_t) data;
3595 xg_remove_widget_from_map (id);
3598 /* Create a scroll bar widget for frame F. Store the scroll bar
3599 in BAR.
3600 SCROLL_CALLBACK is the callback to invoke when the value of the
3601 bar changes.
3602 END_CALLBACK is the callback to invoke when scrolling ends.
3603 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
3604 to set resources for the widget. */
3606 void
3607 xg_create_scroll_bar (FRAME_PTR f,
3608 struct scroll_bar *bar,
3609 GCallback scroll_callback,
3610 GCallback end_callback,
3611 const char *scroll_bar_name)
3613 GtkWidget *wscroll;
3614 GtkWidget *webox;
3615 intptr_t scroll_id;
3616 #ifdef HAVE_GTK3
3617 GtkAdjustment *vadj;
3618 #else
3619 GtkObject *vadj;
3620 #endif
3622 /* Page, step increment values are not so important here, they
3623 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3624 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
3625 0.1, 0.1, 0.1);
3627 wscroll = gtk_scrollbar_new (GTK_ORIENTATION_VERTICAL, GTK_ADJUSTMENT (vadj));
3628 webox = gtk_event_box_new ();
3629 gtk_widget_set_name (wscroll, scroll_bar_name);
3630 #ifndef HAVE_GTK3
3631 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3632 #endif
3633 g_object_set_data (G_OBJECT (wscroll), XG_FRAME_DATA, (gpointer)f);
3635 scroll_id = xg_store_widget_in_map (wscroll);
3637 g_signal_connect (G_OBJECT (wscroll),
3638 "destroy",
3639 G_CALLBACK (xg_gtk_scroll_destroy),
3640 (gpointer) scroll_id);
3641 g_signal_connect (G_OBJECT (wscroll),
3642 "change-value",
3643 scroll_callback,
3644 (gpointer) bar);
3645 g_signal_connect (G_OBJECT (wscroll),
3646 "button-release-event",
3647 end_callback,
3648 (gpointer) bar);
3650 /* The scroll bar widget does not draw on a window of its own. Instead
3651 it draws on the parent window, in this case the edit widget. So
3652 whenever the edit widget is cleared, the scroll bar needs to redraw
3653 also, which causes flicker. Put an event box between the edit widget
3654 and the scroll bar, so the scroll bar instead draws itself on the
3655 event box window. */
3656 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3657 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3660 /* Set the cursor to an arrow. */
3661 xg_set_cursor (webox, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
3663 bar->x_window = scroll_id;
3666 /* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
3668 void
3669 xg_remove_scroll_bar (FRAME_PTR f, ptrdiff_t scrollbar_id)
3671 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3672 if (w)
3674 GtkWidget *wparent = gtk_widget_get_parent (w);
3675 gtk_widget_destroy (w);
3676 gtk_widget_destroy (wparent);
3677 SET_FRAME_GARBAGED (f);
3681 /* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
3682 in frame F.
3683 TOP/LEFT are the new pixel positions where the bar shall appear.
3684 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3686 void
3687 xg_update_scrollbar_pos (FRAME_PTR f,
3688 ptrdiff_t scrollbar_id,
3689 int top,
3690 int left,
3691 int width,
3692 int height)
3695 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3697 if (wscroll)
3699 GtkWidget *wfixed = f->output_data.x->edit_widget;
3700 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3701 gint msl;
3703 /* Clear out old position. */
3704 int oldx = -1, oldy = -1, oldw, oldh;
3705 if (gtk_widget_get_parent (wparent) == wfixed)
3707 gtk_container_child_get (GTK_CONTAINER (wfixed), wparent,
3708 "x", &oldx, "y", &oldy, NULL);
3709 gtk_widget_get_size_request (wscroll, &oldw, &oldh);
3712 /* Move and resize to new values. */
3713 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3714 gtk_widget_style_get (wscroll, "min-slider-length", &msl, NULL);
3715 if (msl > height)
3717 /* No room. Hide scroll bar as some themes output a warning if
3718 the height is less than the min size. */
3719 gtk_widget_hide (wparent);
3720 gtk_widget_hide (wscroll);
3722 else
3724 gtk_widget_show_all (wparent);
3725 gtk_widget_set_size_request (wscroll, width, height);
3727 gtk_widget_queue_draw (wfixed);
3728 gdk_window_process_all_updates ();
3729 if (oldx != -1 && oldw > 0 && oldh > 0)
3731 /* Clear under old scroll bar position. This must be done after
3732 the gtk_widget_queue_draw and gdk_window_process_all_updates
3733 above. */
3734 x_clear_area (FRAME_X_DISPLAY (f),
3735 FRAME_X_WINDOW (f),
3736 oldx, oldy, oldw, oldh, 0);
3739 /* GTK does not redraw until the main loop is entered again, but
3740 if there are no X events pending we will not enter it. So we sync
3741 here to get some events. */
3743 x_sync (f);
3744 SET_FRAME_GARBAGED (f);
3745 cancel_mouse_face (f);
3749 /* Get the current value of the range, truncated to an integer. */
3751 static int
3752 int_gtk_range_get_value (GtkRange *range)
3754 return gtk_range_get_value (range);
3758 /* Set the thumb size and position of scroll bar BAR. We are currently
3759 displaying PORTION out of a whole WHOLE, and our position POSITION. */
3761 void
3762 xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
3763 int portion,
3764 int position,
3765 int whole)
3767 GtkWidget *wscroll = xg_get_widget_from_map (bar->x_window);
3769 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3771 if (wscroll && NILP (bar->dragging))
3773 GtkAdjustment *adj;
3774 gdouble shown;
3775 gdouble top;
3776 int size, value;
3777 int old_size;
3778 int new_step;
3779 bool changed = 0;
3781 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3783 /* We do the same as for MOTIF in xterm.c, assume 30 chars per line
3784 rather than the real portion value. This makes the thumb less likely
3785 to resize and that looks better. */
3786 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
3787 /* When the thumb is at the bottom, position == whole.
3788 So we need to increase `whole' to make space for the thumb. */
3789 whole += portion;
3791 if (whole <= 0)
3792 top = 0, shown = 1;
3793 else
3795 top = (gdouble) position / whole;
3796 shown = (gdouble) portion / whole;
3799 size = clip_to_bounds (1, shown * XG_SB_RANGE, XG_SB_RANGE);
3800 value = clip_to_bounds (XG_SB_MIN, top * XG_SB_RANGE, XG_SB_MAX - size);
3802 /* Assume all lines are of equal size. */
3803 new_step = size / max (1, FRAME_LINES (f));
3805 old_size = gtk_adjustment_get_page_size (adj);
3806 if (old_size != size)
3808 int old_step = gtk_adjustment_get_step_increment (adj);
3809 if (old_step != new_step)
3811 gtk_adjustment_set_page_size (adj, size);
3812 gtk_adjustment_set_step_increment (adj, new_step);
3813 /* Assume a page increment is about 95% of the page size */
3814 gtk_adjustment_set_page_increment (adj, size - size / 20);
3815 changed = 1;
3819 if (changed || int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3821 block_input ();
3823 /* gtk_range_set_value invokes the callback. Set
3824 ignore_gtk_scrollbar to make the callback do nothing */
3825 xg_ignore_gtk_scrollbar = 1;
3827 if (int_gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3828 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
3829 else if (changed)
3830 gtk_adjustment_changed (adj);
3832 xg_ignore_gtk_scrollbar = 0;
3834 unblock_input ();
3839 /* Return true if EVENT is for a scroll bar in frame F.
3840 When the same X window is used for several Gtk+ widgets, we cannot
3841 say for sure based on the X window alone if an event is for the
3842 frame. This function does additional checks. */
3844 bool
3845 xg_event_is_for_scrollbar (FRAME_PTR f, XEvent *event)
3847 bool retval = 0;
3849 if (f && event->type == ButtonPress && event->xbutton.button < 4)
3851 /* Check if press occurred outside the edit widget. */
3852 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
3853 GdkWindow *gwin;
3854 #ifdef HAVE_GTK3
3855 GdkDevice *gdev = gdk_device_manager_get_client_pointer
3856 (gdk_display_get_device_manager (gdpy));
3857 gwin = gdk_device_get_window_at_position (gdev, NULL, NULL);
3858 #else
3859 gwin = gdk_display_get_window_at_pointer (gdpy, NULL, NULL);
3860 #endif
3861 retval = gwin != gtk_widget_get_window (f->output_data.x->edit_widget);
3863 else if (f
3864 && ((event->type == ButtonRelease && event->xbutton.button < 4)
3865 || event->type == MotionNotify))
3867 /* If we are releasing or moving the scroll bar, it has the grab. */
3868 GtkWidget *w = gtk_grab_get_current ();
3869 retval = w != 0 && GTK_IS_SCROLLBAR (w);
3872 return retval;
3877 /***********************************************************************
3878 Tool bar functions
3879 ***********************************************************************/
3880 /* The key for the data we put in the GtkImage widgets. The data is
3881 the image used by Emacs. We use this to see if we need to update
3882 the GtkImage with a new image. */
3883 #define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
3885 /* The key for storing the latest modifiers so the activate callback can
3886 get them. */
3887 #define XG_TOOL_BAR_LAST_MODIFIER "emacs-tool-bar-modifier"
3889 /* The key for storing the button widget in its proxy menu item. */
3890 #define XG_TOOL_BAR_PROXY_BUTTON "emacs-tool-bar-proxy-button"
3892 /* The key for the data we put in the GtkImage widgets. The data is
3893 the stock name used by Emacs. We use this to see if we need to update
3894 the GtkImage with a new image. */
3895 #define XG_TOOL_BAR_STOCK_NAME "emacs-tool-bar-stock-name"
3897 /* As above, but this is used for named theme widgets, as opposed to
3898 stock items. */
3899 #define XG_TOOL_BAR_ICON_NAME "emacs-tool-bar-icon-name"
3901 /* Callback function invoked when a tool bar item is pressed.
3902 W is the button widget in the tool bar that got pressed,
3903 CLIENT_DATA is an integer that is the index of the button in the
3904 tool bar. 0 is the first button. */
3906 static gboolean
3907 xg_tool_bar_button_cb (GtkWidget *widget,
3908 GdkEventButton *event,
3909 gpointer user_data)
3911 intptr_t state = event->state;
3912 gpointer ptr = (gpointer) state;
3913 g_object_set_data (G_OBJECT (widget), XG_TOOL_BAR_LAST_MODIFIER, ptr);
3914 return FALSE;
3918 /* Callback function invoked when a tool bar item is pressed.
3919 W is the button widget in the tool bar that got pressed,
3920 CLIENT_DATA is an integer that is the index of the button in the
3921 tool bar. 0 is the first button. */
3923 static void
3924 xg_tool_bar_callback (GtkWidget *w, gpointer client_data)
3926 intptr_t idx = (intptr_t) client_data;
3927 gpointer gmod = g_object_get_data (G_OBJECT (w), XG_TOOL_BAR_LAST_MODIFIER);
3928 intptr_t mod = (intptr_t) gmod;
3930 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
3931 Lisp_Object key, frame;
3932 struct input_event event;
3933 EVENT_INIT (event);
3935 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
3936 return;
3938 idx *= TOOL_BAR_ITEM_NSLOTS;
3940 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
3941 XSETFRAME (frame, f);
3943 /* We generate two events here. The first one is to set the prefix
3944 to `(tool_bar)', see keyboard.c. */
3945 event.kind = TOOL_BAR_EVENT;
3946 event.frame_or_window = frame;
3947 event.arg = frame;
3948 kbd_buffer_store_event (&event);
3950 event.kind = TOOL_BAR_EVENT;
3951 event.frame_or_window = frame;
3952 event.arg = key;
3953 /* Convert between the modifier bits GDK uses and the modifier bits
3954 Emacs uses. This assumes GDK and X masks are the same, which they are when
3955 this is written. */
3956 event.modifiers = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), mod);
3957 kbd_buffer_store_event (&event);
3959 /* Return focus to the frame after we have clicked on a detached
3960 tool bar button. */
3961 Fx_focus_frame (frame);
3964 /* Callback function invoked when a tool bar item is pressed in a detached
3965 tool bar or the overflow drop down menu.
3966 We just call xg_tool_bar_callback.
3967 W is the menu item widget that got pressed,
3968 CLIENT_DATA is an integer that is the index of the button in the
3969 tool bar. 0 is the first button. */
3971 static void
3972 xg_tool_bar_proxy_callback (GtkWidget *w, gpointer client_data)
3974 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
3975 XG_TOOL_BAR_PROXY_BUTTON));
3976 xg_tool_bar_callback (wbutton, client_data);
3980 static gboolean
3981 xg_tool_bar_help_callback (GtkWidget *w,
3982 GdkEventCrossing *event,
3983 gpointer client_data);
3985 /* This callback is called when a help is to be shown for an item in
3986 the detached tool bar when the detached tool bar it is not expanded. */
3988 static gboolean
3989 xg_tool_bar_proxy_help_callback (GtkWidget *w,
3990 GdkEventCrossing *event,
3991 gpointer client_data)
3993 GtkWidget *wbutton = GTK_WIDGET (g_object_get_data (G_OBJECT (w),
3994 XG_TOOL_BAR_PROXY_BUTTON));
3996 return xg_tool_bar_help_callback (wbutton, event, client_data);
3999 static GtkWidget *
4000 xg_get_tool_bar_widgets (GtkWidget *vb, GtkWidget **wimage)
4002 GList *clist = gtk_container_get_children (GTK_CONTAINER (vb));
4003 GtkWidget *c1 = (GtkWidget *) clist->data;
4004 GtkWidget *c2 = clist->next ? (GtkWidget *) clist->next->data : NULL;
4006 *wimage = GTK_IS_IMAGE (c1) ? c1 : c2;
4007 g_list_free (clist);
4008 return GTK_IS_LABEL (c1) ? c1 : c2;
4012 /* This callback is called when a tool item should create a proxy item,
4013 such as for the overflow menu. Also called when the tool bar is detached.
4014 If we don't create a proxy menu item, the detached tool bar will be
4015 blank. */
4017 static gboolean
4018 xg_tool_bar_menu_proxy (GtkToolItem *toolitem, gpointer user_data)
4020 GtkButton *wbutton = GTK_BUTTON (XG_BIN_CHILD (XG_BIN_CHILD (toolitem)));
4021 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4022 GtkWidget *c1;
4023 GtkLabel *wlbl = GTK_LABEL (xg_get_tool_bar_widgets (vb, &c1));
4024 GtkImage *wimage = GTK_IMAGE (c1);
4025 GtkWidget *wmenuitem = gtk_image_menu_item_new_with_label
4026 (wlbl ? gtk_label_get_text (wlbl) : "");
4027 GtkWidget *wmenuimage;
4030 if (gtk_button_get_use_stock (wbutton))
4031 wmenuimage = gtk_image_new_from_stock (gtk_button_get_label (wbutton),
4032 GTK_ICON_SIZE_MENU);
4033 else
4035 GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (wbutton));
4036 GtkImageType store_type = gtk_image_get_storage_type (wimage);
4038 g_object_set (G_OBJECT (settings), "gtk-menu-images", TRUE, NULL);
4040 if (store_type == GTK_IMAGE_STOCK)
4042 gchar *stock_id;
4043 gtk_image_get_stock (wimage, &stock_id, NULL);
4044 wmenuimage = gtk_image_new_from_stock (stock_id, GTK_ICON_SIZE_MENU);
4046 else if (store_type == GTK_IMAGE_ICON_SET)
4048 GtkIconSet *icon_set;
4049 gtk_image_get_icon_set (wimage, &icon_set, NULL);
4050 wmenuimage = gtk_image_new_from_icon_set (icon_set,
4051 GTK_ICON_SIZE_MENU);
4053 else if (store_type == GTK_IMAGE_PIXBUF)
4055 gint width, height;
4057 if (settings &&
4058 gtk_icon_size_lookup_for_settings (settings, GTK_ICON_SIZE_MENU,
4059 &width, &height))
4061 GdkPixbuf *src_pixbuf, *dest_pixbuf;
4063 src_pixbuf = gtk_image_get_pixbuf (wimage);
4064 dest_pixbuf = gdk_pixbuf_scale_simple (src_pixbuf, width, height,
4065 GDK_INTERP_BILINEAR);
4067 wmenuimage = gtk_image_new_from_pixbuf (dest_pixbuf);
4069 else
4071 fprintf (stderr, "internal error: GTK_IMAGE_PIXBUF failed\n");
4072 emacs_abort ();
4075 else if (store_type == GTK_IMAGE_ICON_NAME)
4077 const gchar *icon_name;
4078 GtkIconSize icon_size;
4080 gtk_image_get_icon_name (wimage, &icon_name, &icon_size);
4081 wmenuimage = gtk_image_new_from_icon_name (icon_name,
4082 GTK_ICON_SIZE_MENU);
4084 else
4086 fprintf (stderr, "internal error: store_type is %d\n", store_type);
4087 emacs_abort ();
4090 if (wmenuimage)
4091 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (wmenuitem), wmenuimage);
4093 g_signal_connect (G_OBJECT (wmenuitem),
4094 "activate",
4095 G_CALLBACK (xg_tool_bar_proxy_callback),
4096 user_data);
4099 g_object_set_data (G_OBJECT (wmenuitem), XG_TOOL_BAR_PROXY_BUTTON,
4100 (gpointer) wbutton);
4101 gtk_tool_item_set_proxy_menu_item (toolitem, "Emacs toolbar item", wmenuitem);
4102 gtk_widget_set_sensitive (wmenuitem,
4103 gtk_widget_get_sensitive (GTK_WIDGET (wbutton)));
4105 /* Use enter/leave notify to show help. We use the events
4106 rather than the GtkButton specific signals "enter" and
4107 "leave", so we can have only one callback. The event
4108 will tell us what kind of event it is. */
4109 g_signal_connect (G_OBJECT (wmenuitem),
4110 "enter-notify-event",
4111 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4112 user_data);
4113 g_signal_connect (G_OBJECT (wmenuitem),
4114 "leave-notify-event",
4115 G_CALLBACK (xg_tool_bar_proxy_help_callback),
4116 user_data);
4118 return TRUE;
4121 /* This callback is called when a tool bar is detached. We must set
4122 the height of the tool bar to zero when this happens so frame sizes
4123 are correctly calculated.
4124 WBOX is the handle box widget that enables detach/attach of the tool bar.
4125 W is the tool bar widget.
4126 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4128 static void
4129 xg_tool_bar_detach_callback (GtkHandleBox *wbox,
4130 GtkWidget *w,
4131 gpointer client_data)
4133 FRAME_PTR f = (FRAME_PTR) client_data;
4135 g_object_set (G_OBJECT (w), "show-arrow", !x_gtk_whole_detached_tool_bar,
4136 NULL);
4138 if (f)
4140 GtkRequisition req, req2;
4141 FRAME_X_OUTPUT (f)->toolbar_detached = 1;
4142 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4143 gtk_widget_get_preferred_size (w, NULL, &req2);
4144 req.width -= req2.width;
4145 req.height -= req2.height;
4146 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4147 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4148 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4149 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4150 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4151 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4152 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4153 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4154 xg_height_or_width_changed (f);
4158 /* This callback is called when a tool bar is reattached. We must set
4159 the height of the tool bar when this happens so frame sizes
4160 are correctly calculated.
4161 WBOX is the handle box widget that enables detach/attach of the tool bar.
4162 W is the tool bar widget.
4163 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
4165 static void
4166 xg_tool_bar_attach_callback (GtkHandleBox *wbox,
4167 GtkWidget *w,
4168 gpointer client_data)
4170 FRAME_PTR f = (FRAME_PTR) client_data;
4171 g_object_set (G_OBJECT (w), "show-arrow", TRUE, NULL);
4173 if (f)
4175 GtkRequisition req, req2;
4176 FRAME_X_OUTPUT (f)->toolbar_detached = 0;
4177 gtk_widget_get_preferred_size (GTK_WIDGET (wbox), NULL, &req);
4178 gtk_widget_get_preferred_size (w, NULL, &req2);
4179 req.width += req2.width;
4180 req.height += req2.height;
4181 if (FRAME_TOOLBAR_TOP_HEIGHT (f) != 0)
4182 FRAME_TOOLBAR_TOP_HEIGHT (f) = req.height;
4183 else if (FRAME_TOOLBAR_BOTTOM_HEIGHT (f) != 0)
4184 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = req.height;
4185 else if (FRAME_TOOLBAR_RIGHT_WIDTH (f) != 0)
4186 FRAME_TOOLBAR_RIGHT_WIDTH (f) = req.width;
4187 else if (FRAME_TOOLBAR_LEFT_WIDTH (f) != 0)
4188 FRAME_TOOLBAR_LEFT_WIDTH (f) = req.width;
4189 xg_height_or_width_changed (f);
4193 /* This callback is called when the mouse enters or leaves a tool bar item.
4194 It is used for displaying and hiding the help text.
4195 W is the tool bar item, a button.
4196 EVENT is either an enter event or leave event.
4197 CLIENT_DATA is an integer that is the index of the button in the
4198 tool bar. 0 is the first button.
4200 Returns FALSE to tell GTK to keep processing this event. */
4202 static gboolean
4203 xg_tool_bar_help_callback (GtkWidget *w,
4204 GdkEventCrossing *event,
4205 gpointer client_data)
4207 intptr_t idx = (intptr_t) client_data;
4208 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
4209 Lisp_Object help, frame;
4211 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
4212 return FALSE;
4214 if (event->type == GDK_ENTER_NOTIFY)
4216 idx *= TOOL_BAR_ITEM_NSLOTS;
4217 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
4219 if (NILP (help))
4220 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
4222 else
4223 help = Qnil;
4225 XSETFRAME (frame, f);
4226 kbd_buffer_store_help_event (frame, help);
4228 return FALSE;
4232 /* This callback is called when a tool bar item shall be redrawn.
4233 It modifies the expose event so that the GtkImage widget redraws the
4234 whole image. This to overcome a bug that makes GtkImage draw the image
4235 in the wrong place when it tries to redraw just a part of the image.
4236 W is the GtkImage to be redrawn.
4237 EVENT is the expose event for W.
4238 CLIENT_DATA is unused.
4240 Returns FALSE to tell GTK to keep processing this event. */
4242 #ifndef HAVE_GTK3
4243 static gboolean
4244 xg_tool_bar_item_expose_callback (GtkWidget *w,
4245 GdkEventExpose *event,
4246 gpointer client_data)
4248 gint width, height;
4250 gdk_drawable_get_size (event->window, &width, &height);
4251 event->area.x -= width > event->area.width ? width-event->area.width : 0;
4252 event->area.y -= height > event->area.height ? height-event->area.height : 0;
4254 event->area.x = max (0, event->area.x);
4255 event->area.y = max (0, event->area.y);
4257 event->area.width = max (width, event->area.width);
4258 event->area.height = max (height, event->area.height);
4260 return FALSE;
4262 #endif
4264 #ifdef HAVE_GTK_ORIENTABLE_SET_ORIENTATION
4265 #define toolbar_set_orientation(w, o) \
4266 gtk_orientable_set_orientation (GTK_ORIENTABLE (w), o)
4267 #else
4268 #define toolbar_set_orientation(w, o) \
4269 gtk_toolbar_set_orientation (GTK_TOOLBAR (w), o)
4270 #endif
4272 /* Attach a tool bar to frame F. */
4274 static void
4275 xg_pack_tool_bar (FRAME_PTR f, Lisp_Object pos)
4277 struct x_output *x = f->output_data.x;
4278 bool into_hbox = EQ (pos, Qleft) || EQ (pos, Qright);
4280 toolbar_set_orientation (x->toolbar_widget,
4281 into_hbox
4282 ? GTK_ORIENTATION_VERTICAL
4283 : GTK_ORIENTATION_HORIZONTAL);
4284 if (!x->handlebox_widget)
4286 x->handlebox_widget = gtk_handle_box_new ();
4287 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-detached",
4288 G_CALLBACK (xg_tool_bar_detach_callback), f);
4289 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-attached",
4290 G_CALLBACK (xg_tool_bar_attach_callback), f);
4291 gtk_container_add (GTK_CONTAINER (x->handlebox_widget),
4292 x->toolbar_widget);
4295 if (into_hbox)
4297 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4298 GTK_POS_TOP);
4299 gtk_box_pack_start (GTK_BOX (x->hbox_widget), x->handlebox_widget,
4300 FALSE, FALSE, 0);
4302 if (EQ (pos, Qleft))
4303 gtk_box_reorder_child (GTK_BOX (x->hbox_widget),
4304 x->handlebox_widget,
4306 x->toolbar_in_hbox = 1;
4308 else
4310 bool vbox_pos = x->menubar_widget != 0;
4311 gtk_handle_box_set_handle_position (GTK_HANDLE_BOX (x->handlebox_widget),
4312 GTK_POS_LEFT);
4313 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->handlebox_widget,
4314 FALSE, FALSE, 0);
4316 if (EQ (pos, Qtop))
4317 gtk_box_reorder_child (GTK_BOX (x->vbox_widget),
4318 x->handlebox_widget,
4319 vbox_pos);
4320 x->toolbar_in_hbox = 0;
4324 /* Create a tool bar for frame F. */
4326 static void
4327 xg_create_tool_bar (FRAME_PTR f)
4329 struct x_output *x = f->output_data.x;
4330 #if GTK_CHECK_VERSION (3, 3, 6)
4331 GtkStyleContext *gsty;
4332 #endif
4333 struct xg_frame_tb_info *tbinfo
4334 = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4335 TB_INFO_KEY);
4336 if (! tbinfo)
4338 tbinfo = xmalloc (sizeof (*tbinfo));
4339 tbinfo->last_tool_bar = Qnil;
4340 tbinfo->style = Qnil;
4341 tbinfo->hmargin = tbinfo->vmargin = 0;
4342 tbinfo->dir = GTK_TEXT_DIR_NONE;
4343 tbinfo->n_last_items = 0;
4344 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4345 TB_INFO_KEY,
4346 tbinfo);
4349 x->toolbar_widget = gtk_toolbar_new ();
4350 x->toolbar_detached = 0;
4352 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
4354 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
4355 toolbar_set_orientation (x->toolbar_widget, GTK_ORIENTATION_HORIZONTAL);
4356 #if GTK_CHECK_VERSION (3, 3, 6)
4357 gsty = gtk_widget_get_style_context (x->toolbar_widget);
4358 gtk_style_context_add_class (gsty, "primary-toolbar");
4359 #endif
4363 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
4365 /* Find the right-to-left image named by RTL in the tool bar images for F.
4366 Returns IMAGE if RTL is not found. */
4368 static Lisp_Object
4369 find_rtl_image (FRAME_PTR f, Lisp_Object image, Lisp_Object rtl)
4371 int i;
4372 Lisp_Object file, rtl_name;
4373 struct gcpro gcpro1, gcpro2;
4374 GCPRO2 (file, rtl_name);
4376 rtl_name = Ffile_name_nondirectory (rtl);
4378 for (i = 0; i < f->n_tool_bar_items; ++i)
4380 Lisp_Object rtl_image = PROP (TOOL_BAR_ITEM_IMAGES);
4381 if (!NILP (file = file_for_image (rtl_image)))
4383 file = call1 (intern ("file-name-sans-extension"),
4384 Ffile_name_nondirectory (file));
4385 if (! NILP (Fequal (file, rtl_name)))
4387 image = rtl_image;
4388 break;
4393 return image;
4396 static GtkToolItem *
4397 xg_make_tool_item (FRAME_PTR f,
4398 GtkWidget *wimage,
4399 GtkWidget **wbutton,
4400 const char *label,
4401 int i, bool horiz, bool text_image)
4403 GtkToolItem *ti = gtk_tool_item_new ();
4404 GtkWidget *vb = gtk_box_new (horiz
4405 ? GTK_ORIENTATION_HORIZONTAL
4406 : GTK_ORIENTATION_VERTICAL,
4408 GtkWidget *wb = gtk_button_new ();
4409 /* The eventbox is here so we can have tooltips on disabled items. */
4410 GtkWidget *weventbox = gtk_event_box_new ();
4411 #if GTK_CHECK_VERSION (3, 3, 6)
4412 GtkCssProvider *css_prov = gtk_css_provider_new ();
4413 GtkStyleContext *gsty;
4415 gtk_css_provider_load_from_data (css_prov,
4416 "GtkEventBox {"
4417 " background-color: transparent;"
4418 "}",
4419 -1, NULL);
4421 gsty = gtk_widget_get_style_context (weventbox);
4422 gtk_style_context_add_provider (gsty,
4423 GTK_STYLE_PROVIDER (css_prov),
4424 GTK_STYLE_PROVIDER_PRIORITY_USER);
4425 g_object_unref (css_prov);
4426 #endif
4428 gtk_box_set_homogeneous (GTK_BOX (vb), FALSE);
4430 if (wimage && !text_image)
4431 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4432 if (label)
4433 gtk_box_pack_start (GTK_BOX (vb), gtk_label_new (label), TRUE, TRUE, 0);
4434 if (wimage && text_image)
4435 gtk_box_pack_start (GTK_BOX (vb), wimage, TRUE, TRUE, 0);
4437 gtk_button_set_focus_on_click (GTK_BUTTON (wb), FALSE);
4438 gtk_button_set_relief (GTK_BUTTON (wb), GTK_RELIEF_NONE);
4439 gtk_container_add (GTK_CONTAINER (wb), vb);
4440 gtk_container_add (GTK_CONTAINER (weventbox), wb);
4441 gtk_container_add (GTK_CONTAINER (ti), weventbox);
4443 if (wimage || label)
4445 intptr_t ii = i;
4446 gpointer gi = (gpointer) ii;
4448 g_signal_connect (G_OBJECT (ti), "create-menu-proxy",
4449 G_CALLBACK (xg_tool_bar_menu_proxy),
4450 gi);
4452 g_signal_connect (G_OBJECT (wb), "clicked",
4453 G_CALLBACK (xg_tool_bar_callback),
4454 gi);
4456 g_object_set_data (G_OBJECT (weventbox), XG_FRAME_DATA, (gpointer)f);
4458 #ifndef HAVE_GTK3
4459 /* Catch expose events to overcome an annoying redraw bug, see
4460 comment for xg_tool_bar_item_expose_callback. */
4461 g_signal_connect (G_OBJECT (ti),
4462 "expose-event",
4463 G_CALLBACK (xg_tool_bar_item_expose_callback),
4465 #endif
4466 gtk_tool_item_set_homogeneous (ti, FALSE);
4468 /* Callback to save modifier mask (Shift/Control, etc). GTK makes
4469 no distinction based on modifiers in the activate callback,
4470 so we have to do it ourselves. */
4471 g_signal_connect (wb, "button-release-event",
4472 G_CALLBACK (xg_tool_bar_button_cb),
4473 NULL);
4475 g_object_set_data (G_OBJECT (wb), XG_FRAME_DATA, (gpointer)f);
4477 /* Use enter/leave notify to show help. We use the events
4478 rather than the GtkButton specific signals "enter" and
4479 "leave", so we can have only one callback. The event
4480 will tell us what kind of event it is. */
4481 g_signal_connect (G_OBJECT (weventbox),
4482 "enter-notify-event",
4483 G_CALLBACK (xg_tool_bar_help_callback),
4484 gi);
4485 g_signal_connect (G_OBJECT (weventbox),
4486 "leave-notify-event",
4487 G_CALLBACK (xg_tool_bar_help_callback),
4488 gi);
4491 if (wbutton) *wbutton = wb;
4493 return ti;
4496 static bool
4497 is_box_type (GtkWidget *vb, bool is_horizontal)
4499 #ifdef HAVE_GTK3
4500 bool ret = 0;
4501 if (GTK_IS_BOX (vb))
4503 GtkOrientation ori = gtk_orientable_get_orientation (GTK_ORIENTABLE (vb));
4504 ret = (ori == GTK_ORIENTATION_HORIZONTAL && is_horizontal)
4505 || (ori == GTK_ORIENTATION_VERTICAL && ! is_horizontal);
4507 return ret;
4508 #else
4509 return is_horizontal ? GTK_IS_VBOX (vb) : GTK_IS_HBOX (vb);
4510 #endif
4514 static bool
4515 xg_tool_item_stale_p (GtkWidget *wbutton, const char *stock_name,
4516 const char *icon_name, const struct image *img,
4517 const char *label, bool horiz)
4519 gpointer old;
4520 GtkWidget *wimage;
4521 GtkWidget *vb = XG_BIN_CHILD (wbutton);
4522 GtkWidget *wlbl = xg_get_tool_bar_widgets (vb, &wimage);
4524 /* Check if the tool icon matches. */
4525 if (stock_name && wimage)
4527 old = g_object_get_data (G_OBJECT (wimage),
4528 XG_TOOL_BAR_STOCK_NAME);
4529 if (!old || strcmp (old, stock_name))
4530 return 1;
4532 else if (icon_name && wimage)
4534 old = g_object_get_data (G_OBJECT (wimage),
4535 XG_TOOL_BAR_ICON_NAME);
4536 if (!old || strcmp (old, icon_name))
4537 return 1;
4539 else if (wimage)
4541 gpointer gold_img = g_object_get_data (G_OBJECT (wimage),
4542 XG_TOOL_BAR_IMAGE_DATA);
4543 Pixmap old_img = (Pixmap) gold_img;
4544 if (old_img != img->pixmap)
4545 return 1;
4548 /* Check button configuration and label. */
4549 if (is_box_type (vb, horiz)
4550 || (label ? (wlbl == NULL) : (wlbl != NULL)))
4551 return 1;
4553 /* Ensure label is correct. */
4554 if (label && wlbl)
4555 gtk_label_set_text (GTK_LABEL (wlbl), label);
4556 return 0;
4559 static bool
4560 xg_update_tool_bar_sizes (FRAME_PTR f)
4562 struct x_output *x = f->output_data.x;
4563 GtkRequisition req;
4564 int nl = 0, nr = 0, nt = 0, nb = 0;
4566 gtk_widget_get_preferred_size (GTK_WIDGET (x->handlebox_widget), NULL, &req);
4567 if (x->toolbar_in_hbox)
4569 int pos;
4570 gtk_container_child_get (GTK_CONTAINER (x->hbox_widget),
4571 x->handlebox_widget,
4572 "position", &pos, NULL);
4573 if (pos == 0) nl = req.width;
4574 else nr = req.width;
4576 else
4578 int pos;
4579 gtk_container_child_get (GTK_CONTAINER (x->vbox_widget),
4580 x->handlebox_widget,
4581 "position", &pos, NULL);
4582 if (pos == 0 || (pos == 1 && x->menubar_widget)) nt = req.height;
4583 else nb = req.height;
4586 if (nl != FRAME_TOOLBAR_LEFT_WIDTH (f)
4587 || nr != FRAME_TOOLBAR_RIGHT_WIDTH (f)
4588 || nt != FRAME_TOOLBAR_TOP_HEIGHT (f)
4589 || nb != FRAME_TOOLBAR_BOTTOM_HEIGHT (f))
4591 FRAME_TOOLBAR_RIGHT_WIDTH (f) = FRAME_TOOLBAR_LEFT_WIDTH (f)
4592 = FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4593 FRAME_TOOLBAR_LEFT_WIDTH (f) = nl;
4594 FRAME_TOOLBAR_RIGHT_WIDTH (f) = nr;
4595 FRAME_TOOLBAR_TOP_HEIGHT (f) = nt;
4596 FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = nb;
4597 return 1;
4600 return 0;
4604 /* Update the tool bar for frame F. Add new buttons and remove old. */
4606 void
4607 update_frame_tool_bar (FRAME_PTR f)
4609 int i, j;
4610 struct x_output *x = f->output_data.x;
4611 int hmargin = 0, vmargin = 0;
4612 GtkToolbar *wtoolbar;
4613 GtkToolItem *ti;
4614 GtkTextDirection dir;
4615 bool pack_tool_bar = x->handlebox_widget == NULL;
4616 Lisp_Object style;
4617 bool text_image, horiz;
4618 struct xg_frame_tb_info *tbinfo;
4620 if (! FRAME_GTK_WIDGET (f))
4621 return;
4623 block_input ();
4625 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
4627 hmargin = XFASTINT (Vtool_bar_button_margin);
4628 vmargin = XFASTINT (Vtool_bar_button_margin);
4630 else if (CONSP (Vtool_bar_button_margin))
4632 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin), INT_MAX))
4633 hmargin = XFASTINT (XCAR (Vtool_bar_button_margin));
4635 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
4636 vmargin = XFASTINT (XCDR (Vtool_bar_button_margin));
4639 /* The natural size (i.e. when GTK uses 0 as margin) looks best,
4640 so take DEFAULT_TOOL_BAR_BUTTON_MARGIN to mean "default for GTK",
4641 i.e. zero. This means that margins less than
4642 DEFAULT_TOOL_BAR_BUTTON_MARGIN has no effect. */
4643 hmargin = max (0, hmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4644 vmargin = max (0, vmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
4646 if (! x->toolbar_widget)
4647 xg_create_tool_bar (f);
4649 wtoolbar = GTK_TOOLBAR (x->toolbar_widget);
4650 dir = gtk_widget_get_direction (GTK_WIDGET (wtoolbar));
4652 style = Ftool_bar_get_system_style ();
4654 /* Are we up to date? */
4655 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4656 TB_INFO_KEY);
4658 if (! NILP (tbinfo->last_tool_bar) && ! NILP (f->tool_bar_items)
4659 && tbinfo->n_last_items == f->n_tool_bar_items
4660 && tbinfo->hmargin == hmargin && tbinfo->vmargin == vmargin
4661 && tbinfo->dir == dir
4662 && ! NILP (Fequal (tbinfo->style, style))
4663 && ! NILP (Fequal (tbinfo->last_tool_bar, f->tool_bar_items)))
4665 unblock_input ();
4666 return;
4669 tbinfo->last_tool_bar = f->tool_bar_items;
4670 tbinfo->n_last_items = f->n_tool_bar_items;
4671 tbinfo->style = style;
4672 tbinfo->hmargin = hmargin;
4673 tbinfo->vmargin = vmargin;
4674 tbinfo->dir = dir;
4676 text_image = EQ (style, Qtext_image_horiz);
4677 horiz = EQ (style, Qboth_horiz) || text_image;
4679 for (i = j = 0; i < f->n_tool_bar_items; ++i)
4681 bool enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
4682 bool selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
4683 int idx;
4684 ptrdiff_t img_id;
4685 int icon_size = 0;
4686 struct image *img = NULL;
4687 Lisp_Object image;
4688 Lisp_Object stock = Qnil;
4689 GtkStockItem stock_item;
4690 char *stock_name = NULL;
4691 char *icon_name = NULL;
4692 Lisp_Object rtl;
4693 GtkWidget *wbutton = NULL;
4694 Lisp_Object specified_file;
4695 bool vert_only = ! NILP (PROP (TOOL_BAR_ITEM_VERT_ONLY));
4696 const char *label
4697 = (EQ (style, Qimage) || (vert_only && horiz)) ? NULL
4698 : STRINGP (PROP (TOOL_BAR_ITEM_LABEL))
4699 ? SSDATA (PROP (TOOL_BAR_ITEM_LABEL))
4700 : "";
4702 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4704 /* If this is a separator, use a gtk separator item. */
4705 if (EQ (PROP (TOOL_BAR_ITEM_TYPE), Qt))
4707 if (ti == NULL || !GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4709 if (ti)
4710 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4711 GTK_WIDGET (ti));
4712 ti = gtk_separator_tool_item_new ();
4713 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4715 j++;
4716 continue;
4719 /* Otherwise, the tool-bar item is an ordinary button. */
4721 if (ti && GTK_IS_SEPARATOR_TOOL_ITEM (ti))
4723 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4724 ti = NULL;
4727 if (ti) wbutton = XG_BIN_CHILD (XG_BIN_CHILD (ti));
4729 /* Ignore invalid image specifications. */
4730 image = PROP (TOOL_BAR_ITEM_IMAGES);
4731 if (!valid_image_p (image))
4733 if (ti)
4734 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4735 GTK_WIDGET (ti));
4736 continue;
4739 specified_file = file_for_image (image);
4740 if (!NILP (specified_file) && !NILP (Ffboundp (Qx_gtk_map_stock)))
4741 stock = call1 (Qx_gtk_map_stock, specified_file);
4743 if (STRINGP (stock))
4745 stock_name = SSDATA (stock);
4746 if (stock_name[0] == 'n' && stock_name[1] == ':')
4748 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (wtoolbar));
4749 GtkIconTheme *icon_theme = gtk_icon_theme_get_for_screen (screen);
4751 icon_name = stock_name + 2;
4752 stock_name = NULL;
4753 stock = Qnil;
4755 if (! gtk_icon_theme_has_icon (icon_theme, icon_name))
4756 icon_name = NULL;
4757 else
4758 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4760 else if (gtk_stock_lookup (SSDATA (stock), &stock_item))
4761 icon_size = gtk_toolbar_get_icon_size (wtoolbar);
4762 else
4764 stock = Qnil;
4765 stock_name = NULL;
4769 if (stock_name == NULL && icon_name == NULL)
4771 /* No stock image, or stock item not known. Try regular
4772 image. If image is a vector, choose it according to the
4773 button state. */
4774 if (dir == GTK_TEXT_DIR_RTL
4775 && !NILP (rtl = PROP (TOOL_BAR_ITEM_RTL_IMAGE))
4776 && STRINGP (rtl))
4777 image = find_rtl_image (f, image, rtl);
4779 if (VECTORP (image))
4781 if (enabled_p)
4782 idx = (selected_p
4783 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
4784 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
4785 else
4786 idx = (selected_p
4787 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
4788 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
4790 eassert (ASIZE (image) >= idx);
4791 image = AREF (image, idx);
4793 else
4794 idx = -1;
4796 img_id = lookup_image (f, image);
4797 img = IMAGE_FROM_ID (f, img_id);
4798 prepare_image_for_display (f, img);
4800 if (img->load_failed_p || img->pixmap == None)
4802 if (ti)
4803 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4804 GTK_WIDGET (ti));
4805 continue;
4809 /* If there is an existing widget, check if it's stale; if so,
4810 remove it and make a new tool item from scratch. */
4811 if (ti && xg_tool_item_stale_p (wbutton, stock_name, icon_name,
4812 img, label, horiz))
4814 gtk_container_remove (GTK_CONTAINER (wtoolbar),
4815 GTK_WIDGET (ti));
4816 ti = NULL;
4819 if (ti == NULL)
4821 GtkWidget *w;
4823 /* Save the image so we can see if an update is needed the
4824 next time we call xg_tool_item_match_p. */
4825 if (EQ (style, Qtext))
4826 w = NULL;
4827 else if (stock_name)
4829 w = gtk_image_new_from_stock (stock_name, icon_size);
4830 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_STOCK_NAME,
4831 (gpointer) xstrdup (stock_name),
4832 (GDestroyNotify) xfree);
4834 else if (icon_name)
4836 w = gtk_image_new_from_icon_name (icon_name, icon_size);
4837 g_object_set_data_full (G_OBJECT (w), XG_TOOL_BAR_ICON_NAME,
4838 (gpointer) xstrdup (icon_name),
4839 (GDestroyNotify) xfree);
4841 else
4843 w = xg_get_image_for_pixmap (f, img, x->widget, NULL);
4844 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
4845 (gpointer)img->pixmap);
4848 if (w) gtk_misc_set_padding (GTK_MISC (w), hmargin, vmargin);
4849 ti = xg_make_tool_item (f, w, &wbutton, label, i, horiz, text_image);
4850 gtk_toolbar_insert (GTK_TOOLBAR (wtoolbar), ti, j);
4853 #undef PROP
4855 gtk_widget_set_sensitive (wbutton, enabled_p);
4856 j++;
4859 /* Remove buttons not longer needed. */
4862 ti = gtk_toolbar_get_nth_item (GTK_TOOLBAR (wtoolbar), j);
4863 if (ti)
4864 gtk_container_remove (GTK_CONTAINER (wtoolbar), GTK_WIDGET (ti));
4865 } while (ti != NULL);
4867 if (f->n_tool_bar_items != 0)
4869 if (pack_tool_bar)
4870 xg_pack_tool_bar (f, f->tool_bar_position);
4871 gtk_widget_show_all (GTK_WIDGET (x->handlebox_widget));
4872 if (xg_update_tool_bar_sizes (f))
4873 xg_height_or_width_changed (f);
4876 unblock_input ();
4879 /* Deallocate all resources for the tool bar on frame F.
4880 Remove the tool bar. */
4882 void
4883 free_frame_tool_bar (FRAME_PTR f)
4885 struct x_output *x = f->output_data.x;
4887 if (x->toolbar_widget)
4889 struct xg_frame_tb_info *tbinfo;
4890 bool is_packed = x->handlebox_widget != 0;
4891 block_input ();
4892 /* We may have created the toolbar_widget in xg_create_tool_bar, but
4893 not the x->handlebox_widget which is created in xg_pack_tool_bar. */
4894 if (is_packed)
4896 if (x->toolbar_in_hbox)
4897 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4898 x->handlebox_widget);
4899 else
4900 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4901 x->handlebox_widget);
4903 else
4904 gtk_widget_destroy (x->toolbar_widget);
4906 x->toolbar_widget = 0;
4907 x->handlebox_widget = 0;
4908 FRAME_TOOLBAR_TOP_HEIGHT (f) = FRAME_TOOLBAR_BOTTOM_HEIGHT (f) = 0;
4909 FRAME_TOOLBAR_LEFT_WIDTH (f) = FRAME_TOOLBAR_RIGHT_WIDTH (f) = 0;
4911 tbinfo = g_object_get_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4912 TB_INFO_KEY);
4913 if (tbinfo)
4915 xfree (tbinfo);
4916 g_object_set_data (G_OBJECT (FRAME_GTK_OUTER_WIDGET (f)),
4917 TB_INFO_KEY,
4918 NULL);
4921 xg_height_or_width_changed (f);
4923 unblock_input ();
4927 void
4928 xg_change_toolbar_position (FRAME_PTR f, Lisp_Object pos)
4930 struct x_output *x = f->output_data.x;
4932 if (! x->toolbar_widget || ! x->handlebox_widget)
4933 return;
4935 block_input ();
4936 g_object_ref (x->handlebox_widget);
4937 if (x->toolbar_in_hbox)
4938 gtk_container_remove (GTK_CONTAINER (x->hbox_widget),
4939 x->handlebox_widget);
4940 else
4941 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
4942 x->handlebox_widget);
4943 xg_pack_tool_bar (f, pos);
4944 g_object_unref (x->handlebox_widget);
4945 if (xg_update_tool_bar_sizes (f))
4946 xg_height_or_width_changed (f);
4948 unblock_input ();
4953 /***********************************************************************
4954 Initializing
4955 ***********************************************************************/
4956 void
4957 xg_initialize (void)
4959 GtkBindingSet *binding_set;
4960 GtkSettings *settings;
4962 #if HAVE_XFT
4963 /* Work around a bug with corrupted data if libXft gets unloaded. This way
4964 we keep it permanently linked in. */
4965 XftInit (0);
4966 #endif
4968 gdpy_def = NULL;
4969 xg_ignore_gtk_scrollbar = 0;
4970 xg_detached_menus = 0;
4971 xg_menu_cb_list.prev = xg_menu_cb_list.next =
4972 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
4974 id_to_widget.max_size = id_to_widget.used = 0;
4975 id_to_widget.widgets = 0;
4977 settings = gtk_settings_get_for_screen (gdk_display_get_default_screen
4978 (gdk_display_get_default ()));
4979 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
4980 bindings. It doesn't seem to be any way to remove properties,
4981 so we set it to VoidSymbol which in X means "no key". */
4982 gtk_settings_set_string_property (settings,
4983 "gtk-menu-bar-accel",
4984 "VoidSymbol",
4985 EMACS_CLASS);
4987 /* Make GTK text input widgets use Emacs style keybindings. This is
4988 Emacs after all. */
4989 gtk_settings_set_string_property (settings,
4990 "gtk-key-theme-name",
4991 "Emacs",
4992 EMACS_CLASS);
4994 /* Make dialogs close on C-g. Since file dialog inherits from
4995 dialog, this works for them also. */
4996 binding_set = gtk_binding_set_by_class (g_type_class_ref (GTK_TYPE_DIALOG));
4997 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
4998 "close", 0);
5000 /* Make menus close on C-g. */
5001 binding_set = gtk_binding_set_by_class (g_type_class_ref
5002 (GTK_TYPE_MENU_SHELL));
5003 gtk_binding_entry_add_signal (binding_set, GDK_KEY_g, GDK_CONTROL_MASK,
5004 "cancel", 0);
5005 update_theme_scrollbar_width ();
5007 x_last_font_name = NULL;
5010 #endif /* USE_GTK */