Improve backward compatibility of tramp-tests.el
[emacs.git] / src / xfns.c
blob9022e4a96746084e8dc3a1cd3b8f7c532740015d
1 /* Functions for the X window system.
3 Copyright (C) 1989, 1992-2017 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 (at
10 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 <https://www.gnu.org/licenses/>. */
20 #include <config.h>
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <math.h>
24 #include <unistd.h>
26 #include "lisp.h"
27 #include "xterm.h"
28 #include "frame.h"
29 #include "window.h"
30 #include "buffer.h"
31 #include "dispextern.h"
32 #include "keyboard.h"
33 #include "blockinput.h"
34 #include "charset.h"
35 #include "coding.h"
36 #include "termhooks.h"
37 #include "font.h"
39 #include <sys/types.h>
40 #include <sys/stat.h>
42 #include "bitmaps/gray.xbm"
43 #include "xsettings.h"
45 #ifdef HAVE_XRANDR
46 #include <X11/extensions/Xrandr.h>
47 #endif
48 #ifdef HAVE_XINERAMA
49 #include <X11/extensions/Xinerama.h>
50 #endif
52 #ifdef USE_GTK
53 #include "gtkutil.h"
54 #endif
56 #ifdef HAVE_XDBE
57 #include <X11/extensions/Xdbe.h>
58 #endif
60 #ifdef USE_X_TOOLKIT
61 #include <X11/Shell.h>
63 #ifndef USE_MOTIF
64 #ifdef HAVE_XAW3D
65 #include <X11/Xaw3d/Paned.h>
66 #include <X11/Xaw3d/Label.h>
67 #else /* !HAVE_XAW3D */
68 #include <X11/Xaw/Paned.h>
69 #include <X11/Xaw/Label.h>
70 #endif /* HAVE_XAW3D */
71 #endif /* USE_MOTIF */
73 #ifdef USG
74 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
75 #include <X11/Xos.h>
76 #define USG
77 #ifdef USG /* Pacify gcc -Wunused-macros. */
78 #endif
79 #else
80 #include <X11/Xos.h>
81 #endif
83 #include "widget.h"
85 #include "../lwlib/lwlib.h"
87 #ifdef USE_MOTIF
88 #include <Xm/Xm.h>
89 #include <Xm/DialogS.h>
90 #include <Xm/FileSB.h>
91 #include <Xm/List.h>
92 #include <Xm/TextF.h>
93 #include <Xm/MwmUtil.h>
94 #endif
96 #ifdef USE_LUCID
97 #include "../lwlib/xlwmenu.h"
98 #endif
100 /* Unique id counter for widgets created by the Lucid Widget Library. */
102 extern LWLIB_ID widget_id_tick;
104 #ifdef USE_MOTIF
106 #endif /* USE_MOTIF */
108 #endif /* USE_X_TOOLKIT */
110 #ifdef USE_GTK
112 #endif /* USE_GTK */
114 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
116 static ptrdiff_t image_cache_refcount;
117 #ifdef GLYPH_DEBUG
118 static int dpyinfo_refcount;
119 #endif
121 #ifndef USE_MOTIF
122 #ifndef USE_GTK
123 /** #define MWM_HINTS_FUNCTIONS (1L << 0) **/
124 #define MWM_HINTS_DECORATIONS (1L << 1)
125 /** #define MWM_HINTS_INPUT_MODE (1L << 2) **/
126 /** #define MWM_HINTS_STATUS (1L << 3) **/
128 #define MWM_DECOR_ALL (1L << 0)
129 /** #define MWM_DECOR_BORDER (1L << 1) **/
130 /** #define MWM_DECOR_RESIZEH (1L << 2) **/
131 /** #define MWM_DECOR_TITLE (1L << 3) **/
132 /** #define MWM_DECOR_MENU (1L << 4) **/
133 /** #define MWM_DECOR_MINIMIZE (1L << 5) **/
134 /** #define MWM_DECOR_MAXIMIZE (1L << 6) **/
136 /** #define _XA_MOTIF_WM_HINTS "_MOTIF_WM_HINTS" **/
138 typedef struct {
139 unsigned long flags;
140 unsigned long functions;
141 unsigned long decorations;
142 long input_mode;
143 unsigned long status;
144 } PropMotifWmHints;
146 #define PROP_MOTIF_WM_HINTS_ELEMENTS 5
147 #endif /* NOT USE_GTK */
148 #endif /* NOT USE_MOTIF */
150 static struct x_display_info *x_display_info_for_name (Lisp_Object);
151 static void set_up_x_back_buffer (struct frame *f);
153 /* Let the user specify an X display with a Lisp object.
154 OBJECT may be nil, a frame or a terminal object.
155 nil stands for the selected frame--or, if that is not an X frame,
156 the first X display on the list. */
158 struct x_display_info *
159 check_x_display_info (Lisp_Object object)
161 struct x_display_info *dpyinfo = NULL;
163 if (NILP (object))
165 struct frame *sf = XFRAME (selected_frame);
167 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
168 dpyinfo = FRAME_DISPLAY_INFO (sf);
169 else if (x_display_list != 0)
170 dpyinfo = x_display_list;
171 else
172 error ("X windows are not in use or not initialized");
174 else if (TERMINALP (object))
176 struct terminal *t = decode_live_terminal (object);
178 if (t->type != output_x_window)
179 error ("Terminal %d is not an X display", t->id);
181 dpyinfo = t->display_info.x;
183 else if (STRINGP (object))
184 dpyinfo = x_display_info_for_name (object);
185 else
187 struct frame *f = decode_window_system_frame (object);
188 dpyinfo = FRAME_DISPLAY_INFO (f);
191 return dpyinfo;
194 /* Return the screen positions and offsets of frame F.
195 Store the offsets between FRAME_OUTER_WINDOW and the containing
196 window manager window into LEFT_OFFSET_X, RIGHT_OFFSET_X,
197 TOP_OFFSET_Y and BOTTOM_OFFSET_Y.
198 Store the offsets between FRAME_X_WINDOW and the containing
199 window manager window into X_PIXELS_DIFF and Y_PIXELS_DIFF.
200 Store the screen positions of frame F into XPTR and YPTR.
201 These are the positions of the containing window manager window,
202 not Emacs's own window. */
203 void
204 x_real_pos_and_offsets (struct frame *f,
205 int *left_offset_x,
206 int *right_offset_x,
207 int *top_offset_y,
208 int *bottom_offset_y,
209 int *x_pixels_diff,
210 int *y_pixels_diff,
211 int *xptr,
212 int *yptr,
213 int *outer_border)
215 int win_x = 0, win_y = 0, outer_x = 0, outer_y = 0;
216 int real_x = 0, real_y = 0;
217 bool had_errors = false;
218 Window win = (FRAME_PARENT_FRAME (f)
219 ? FRAME_X_WINDOW (FRAME_PARENT_FRAME (f))
220 : f->output_data.x->parent_desc);
221 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
222 long max_len = 400;
223 Atom target_type = XA_CARDINAL;
224 unsigned int ow = 0, oh = 0;
225 unsigned int fw = 0, fh = 0;
226 unsigned int bw = 0;
227 /* We resort to XCB if possible because there are several X calls
228 here which require responses from the server but do not have data
229 dependencies between them. Using XCB lets us pipeline requests,
230 whereas with Xlib we must wait for each answer before sending the
231 next request.
233 For a non-local display, the round-trip time could be a few tens
234 of milliseconds, depending on the network distance. It doesn't
235 take a lot of those to add up to a noticeable hesitation in
236 responding to user actions. */
237 #ifdef USE_XCB
238 xcb_connection_t *xcb_conn = dpyinfo->xcb_connection;
239 xcb_get_property_cookie_t prop_cookie;
240 xcb_get_geometry_cookie_t outer_geom_cookie;
241 bool sent_requests = false;
242 #else
243 Atom actual_type;
244 unsigned long actual_size, bytes_remaining;
245 int rc, actual_format;
246 Display *dpy = FRAME_X_DISPLAY (f);
247 unsigned char *tmp_data = NULL;
248 #endif
250 if (x_pixels_diff) *x_pixels_diff = 0;
251 if (y_pixels_diff) *y_pixels_diff = 0;
252 if (left_offset_x) *left_offset_x = 0;
253 if (top_offset_y) *top_offset_y = 0;
254 if (right_offset_x) *right_offset_x = 0;
255 if (bottom_offset_y) *bottom_offset_y = 0;
256 if (xptr) *xptr = 0;
257 if (yptr) *yptr = 0;
258 if (outer_border) *outer_border = 0;
260 if (win == dpyinfo->root_window)
261 win = FRAME_OUTER_WINDOW (f);
263 block_input ();
265 #ifndef USE_XCB
266 /* If we're using XCB, all errors are checked for on each call. */
267 x_catch_errors (dpy);
268 #endif
270 /* This loop traverses up the containment tree until we hit the root
271 window. Window managers may intersect many windows between our window
272 and the root window. The window we find just before the root window
273 should be the outer WM window. */
274 for (;;)
276 Window wm_window, rootw;
278 #ifdef USE_XCB
279 xcb_query_tree_cookie_t query_tree_cookie;
280 xcb_query_tree_reply_t *query_tree;
282 query_tree_cookie = xcb_query_tree (xcb_conn, win);
283 query_tree = xcb_query_tree_reply (xcb_conn, query_tree_cookie, NULL);
284 if (query_tree == NULL)
285 had_errors = true;
286 else
288 wm_window = query_tree->parent;
289 rootw = query_tree->root;
290 free (query_tree);
292 #else
293 Window *tmp_children;
294 unsigned int tmp_nchildren;
295 int success;
297 success = XQueryTree (dpy, win, &rootw,
298 &wm_window, &tmp_children, &tmp_nchildren);
300 had_errors = x_had_errors_p (dpy);
302 /* Don't free tmp_children if XQueryTree failed. */
303 if (! success)
304 break;
306 XFree (tmp_children);
307 #endif
309 if (had_errors || wm_window == rootw)
310 break;
312 win = wm_window;
315 if (! had_errors)
317 #ifdef USE_XCB
318 xcb_get_geometry_cookie_t geom_cookie;
319 xcb_translate_coordinates_cookie_t trans_cookie;
320 xcb_translate_coordinates_cookie_t outer_trans_cookie;
322 xcb_translate_coordinates_reply_t *trans;
323 xcb_get_geometry_reply_t *geom;
324 #else
325 Window child, rootw;
326 unsigned int ign;
327 #endif
329 #ifdef USE_XCB
330 /* Fire off the requests that don't have data dependencies.
332 Once we've done this, we must collect the results for each
333 one before returning, even if other errors are detected,
334 making the other responses moot. */
335 geom_cookie = xcb_get_geometry (xcb_conn, win);
337 trans_cookie =
338 xcb_translate_coordinates (xcb_conn,
339 /* From-window, to-window. */
340 FRAME_DISPLAY_INFO (f)->root_window,
341 FRAME_X_WINDOW (f),
343 /* From-position. */
344 0, 0);
345 if (FRAME_X_WINDOW (f) != FRAME_OUTER_WINDOW (f))
346 outer_trans_cookie =
347 xcb_translate_coordinates (xcb_conn,
348 /* From-window, to-window. */
349 FRAME_DISPLAY_INFO (f)->root_window,
350 FRAME_OUTER_WINDOW (f),
352 /* From-position. */
353 0, 0);
354 if (right_offset_x || bottom_offset_y)
355 outer_geom_cookie = xcb_get_geometry (xcb_conn,
356 FRAME_OUTER_WINDOW (f));
358 if ((dpyinfo->root_window == f->output_data.x->parent_desc)
359 && !FRAME_PARENT_FRAME (f))
360 /* Try _NET_FRAME_EXTENTS if our parent is the root window. */
361 prop_cookie = xcb_get_property (xcb_conn, 0, win,
362 dpyinfo->Xatom_net_frame_extents,
363 target_type, 0, max_len);
365 sent_requests = true;
366 #endif
368 /* Get the real coordinates for the WM window upper left corner */
369 #ifdef USE_XCB
370 geom = xcb_get_geometry_reply (xcb_conn, geom_cookie, NULL);
371 if (geom)
373 real_x = geom->x;
374 real_y = geom->y;
375 ow = geom->width;
376 oh = geom->height;
377 bw = geom->border_width;
378 free (geom);
380 else
381 had_errors = true;
382 #else
383 XGetGeometry (dpy, win,
384 &rootw, &real_x, &real_y, &ow, &oh, &bw, &ign);
385 #endif
387 /* Translate real coordinates to coordinates relative to our
388 window. For our window, the upper left corner is 0, 0.
389 Since the upper left corner of the WM window is outside
390 our window, win_x and win_y will be negative:
392 ------------------ ---> x
393 | title |
394 | ----------------- v y
395 | | our window
397 Since we don't care about the child window corresponding to
398 the actual coordinates, we can send zero to get the offsets
399 and compute the resulting coordinates below. This reduces
400 the data dependencies between calls and lets us pipeline the
401 requests better in the XCB case. */
402 #ifdef USE_XCB
403 trans = xcb_translate_coordinates_reply (xcb_conn, trans_cookie, NULL);
404 if (trans)
406 win_x = trans->dst_x;
407 win_y = trans->dst_y;
408 free (trans);
410 else
411 had_errors = true;
412 #else
413 XTranslateCoordinates (dpy,
415 /* From-window, to-window. */
416 FRAME_DISPLAY_INFO (f)->root_window,
417 FRAME_X_WINDOW (f),
419 /* From-position, to-position. */
420 0, 0, &win_x, &win_y,
422 /* Child of win. */
423 &child);
424 #endif
426 win_x += real_x;
427 win_y += real_y;
429 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
431 outer_x = win_x;
432 outer_y = win_y;
434 else
436 #ifdef USE_XCB
437 xcb_translate_coordinates_reply_t *outer_trans;
439 outer_trans = xcb_translate_coordinates_reply (xcb_conn,
440 outer_trans_cookie,
441 NULL);
442 if (outer_trans)
444 outer_x = outer_trans->dst_x;
445 outer_y = outer_trans->dst_y;
446 free (outer_trans);
448 else
449 had_errors = true;
450 #else
451 XTranslateCoordinates (dpy,
453 /* From-window, to-window. */
454 FRAME_DISPLAY_INFO (f)->root_window,
455 FRAME_OUTER_WINDOW (f),
457 /* From-position, to-position. */
458 0, 0, &outer_x, &outer_y,
460 /* Child of win. */
461 &child);
462 #endif
464 outer_x += real_x;
465 outer_y += real_y;
468 #ifndef USE_XCB
469 had_errors = x_had_errors_p (dpy);
470 #endif
473 if ((dpyinfo->root_window == f->output_data.x->parent_desc)
474 && !FRAME_PARENT_FRAME (f))
476 /* Try _NET_FRAME_EXTENTS if our parent is the root window. */
477 #ifdef USE_XCB
478 /* Make sure we didn't get an X error early and skip sending the
479 request. */
480 if (sent_requests)
482 xcb_get_property_reply_t *prop;
484 prop = xcb_get_property_reply (xcb_conn, prop_cookie, NULL);
485 if (prop)
487 if (prop->type == target_type
488 && prop->format == 32
489 && (xcb_get_property_value_length (prop)
490 == 4 * sizeof (int32_t)))
492 int32_t *fe = xcb_get_property_value (prop);
494 outer_x = -fe[0];
495 outer_y = -fe[2];
496 real_x -= fe[0];
497 real_y -= fe[2];
499 free (prop);
501 /* Xlib version doesn't set had_errors here. Intentional or bug? */
503 #else
504 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_frame_extents,
505 0, max_len, False, target_type,
506 &actual_type, &actual_format, &actual_size,
507 &bytes_remaining, &tmp_data);
509 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
510 && actual_size == 4 && actual_format == 32)
512 long *fe = (long *)tmp_data;
514 outer_x = -fe[0];
515 outer_y = -fe[2];
516 real_x -= fe[0];
517 real_y -= fe[2];
520 if (tmp_data) XFree (tmp_data);
521 #endif
524 if (right_offset_x || bottom_offset_y)
526 #ifdef USE_XCB
527 /* Make sure we didn't get an X error early and skip sending the
528 request. */
529 if (sent_requests)
531 xcb_get_geometry_reply_t *outer_geom;
533 outer_geom = xcb_get_geometry_reply (xcb_conn, outer_geom_cookie,
534 NULL);
535 if (outer_geom)
537 fw = outer_geom->width;
538 fh = outer_geom->height;
539 free (outer_geom);
541 else
542 had_errors = true;
544 #else
545 int xy_ign;
546 unsigned int ign;
547 Window rootw;
549 XGetGeometry (dpy, FRAME_OUTER_WINDOW (f),
550 &rootw, &xy_ign, &xy_ign, &fw, &fh, &ign, &ign);
551 #endif
554 #ifndef USE_XCB
555 x_uncatch_errors ();
556 #endif
558 unblock_input ();
560 if (had_errors) return;
562 if (x_pixels_diff) *x_pixels_diff = -win_x;
563 if (y_pixels_diff) *y_pixels_diff = -win_y;
565 if (left_offset_x) *left_offset_x = -outer_x;
566 if (top_offset_y) *top_offset_y = -outer_y;
568 if (xptr) *xptr = real_x;
569 if (yptr) *yptr = real_y;
571 if (outer_border) *outer_border = bw;
573 if (right_offset_x) *right_offset_x = ow - fw + outer_x;
574 if (bottom_offset_y) *bottom_offset_y = oh - fh + outer_y;
577 /* Store the screen positions of frame F into XPTR and YPTR.
578 These are the positions of the containing window manager window,
579 not Emacs's own window. */
581 void
582 x_real_positions (struct frame *f, int *xptr, int *yptr)
584 x_real_pos_and_offsets (f, NULL, NULL, NULL, NULL, NULL, NULL, xptr, yptr,
585 NULL);
589 /* Get the mouse position in frame relative coordinates. */
591 void
592 x_relative_mouse_position (struct frame *f, int *x, int *y)
594 Window root, dummy_window;
595 int dummy;
597 eassert (FRAME_X_P (f));
599 block_input ();
601 XQueryPointer (FRAME_X_DISPLAY (f),
602 DefaultRootWindow (FRAME_X_DISPLAY (f)),
604 /* The root window which contains the pointer. */
605 &root,
607 /* Window pointer is on, not used */
608 &dummy_window,
610 /* The position on that root window. */
611 x, y,
613 /* x/y in dummy_window coordinates, not used. */
614 &dummy, &dummy,
616 /* Modifier keys and pointer buttons, about which
617 we don't care. */
618 (unsigned int *) &dummy);
620 XTranslateCoordinates (FRAME_X_DISPLAY (f),
622 /* From-window, to-window. */
623 FRAME_DISPLAY_INFO (f)->root_window,
624 FRAME_X_WINDOW (f),
626 /* From-position, to-position. */
627 *x, *y, x, y,
629 /* Child of win. */
630 &dummy_window);
632 unblock_input ();
635 /* Gamma-correct COLOR on frame F. */
637 void
638 gamma_correct (struct frame *f, XColor *color)
640 if (f->gamma)
642 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
643 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
644 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
649 /* Decide if color named COLOR_NAME is valid for use on frame F. If
650 so, return the RGB values in COLOR. If ALLOC_P,
651 allocate the color. Value is false if COLOR_NAME is invalid, or
652 no color could be allocated. */
654 bool
655 x_defined_color (struct frame *f, const char *color_name,
656 XColor *color, bool alloc_p)
658 bool success_p = false;
659 Colormap cmap = FRAME_X_COLORMAP (f);
661 block_input ();
662 #ifdef USE_GTK
663 success_p = xg_check_special_colors (f, color_name, color);
664 #endif
665 if (!success_p)
666 success_p = x_parse_color (f, color_name, color) != 0;
667 if (success_p && alloc_p)
668 success_p = x_alloc_nearest_color (f, cmap, color);
669 unblock_input ();
671 return success_p;
675 /* Return the pixel color value for color COLOR_NAME on frame F. If F
676 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
677 Signal an error if color can't be allocated. */
679 static int
680 x_decode_color (struct frame *f, Lisp_Object color_name, int mono_color)
682 XColor cdef;
684 CHECK_STRING (color_name);
686 #if false /* Don't do this. It's wrong when we're not using the default
687 colormap, it makes freeing difficult, and it's probably not
688 an important optimization. */
689 if (strcmp (SDATA (color_name), "black") == 0)
690 return BLACK_PIX_DEFAULT (f);
691 else if (strcmp (SDATA (color_name), "white") == 0)
692 return WHITE_PIX_DEFAULT (f);
693 #endif
695 /* Return MONO_COLOR for monochrome frames. */
696 if (FRAME_DISPLAY_INFO (f)->n_planes == 1)
697 return mono_color;
699 /* x_defined_color is responsible for coping with failures
700 by looking for a near-miss. */
701 if (x_defined_color (f, SSDATA (color_name), &cdef, true))
702 return cdef.pixel;
704 signal_error ("Undefined color", color_name);
709 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
710 the previous value of that parameter, NEW_VALUE is the new value.
711 See also the comment of wait_for_wm in struct x_output. */
713 static void
714 x_set_wait_for_wm (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
716 f->output_data.x->wait_for_wm = !NILP (new_value);
719 static void
720 x_set_tool_bar_position (struct frame *f,
721 Lisp_Object new_value,
722 Lisp_Object old_value)
724 Lisp_Object choice = list4 (Qleft, Qright, Qtop, Qbottom);
726 if (!NILP (Fmemq (new_value, choice)))
728 #ifdef USE_GTK
729 if (!EQ (new_value, old_value))
731 xg_change_toolbar_position (f, new_value);
732 fset_tool_bar_position (f, new_value);
734 #else
735 if (!EQ (new_value, Qtop))
736 error ("The only supported tool bar position is top");
737 #endif
739 else
740 wrong_choice (choice, new_value);
743 static void
744 x_set_inhibit_double_buffering (struct frame *f,
745 Lisp_Object new_value,
746 Lisp_Object old_value)
748 block_input ();
749 if (FRAME_X_WINDOW (f) && !EQ (new_value, old_value))
751 bool want_double_buffering = NILP (new_value);
752 bool was_double_buffered = FRAME_X_DOUBLE_BUFFERED_P (f);
753 /* font_drop_xrender_surfaces in xftfont does something only if
754 we're double-buffered, so call font_drop_xrender_surfaces before
755 and after any potential change. One of the calls will end up
756 being a no-op. */
757 if (want_double_buffering != was_double_buffered)
758 font_drop_xrender_surfaces (f);
759 if (FRAME_X_DOUBLE_BUFFERED_P (f) && !want_double_buffering)
760 tear_down_x_back_buffer (f);
761 else if (!FRAME_X_DOUBLE_BUFFERED_P (f) && want_double_buffering)
762 set_up_x_back_buffer (f);
763 if (FRAME_X_DOUBLE_BUFFERED_P (f) != was_double_buffered)
765 SET_FRAME_GARBAGED (f);
766 font_drop_xrender_surfaces (f);
769 unblock_input ();
773 * x_set_undecorated:
775 * Set frame F's `undecorated' parameter. If non-nil, F's window-system
776 * window is drawn without decorations, title, minimize/maximize boxes
777 * and external borders. This usually means that the window cannot be
778 * dragged, resized, iconified, maximized or deleted with the mouse. If
779 * nil, draw the frame with all the elements listed above unless these
780 * have been suspended via window manager settings.
782 * Some window managers may not honor this parameter.
784 static void
785 x_set_undecorated (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
787 if (!EQ (new_value, old_value))
789 FRAME_UNDECORATED (f) = NILP (new_value) ? false : true;
790 #ifdef USE_GTK
791 xg_set_undecorated (f, new_value);
792 #else
793 Display *dpy = FRAME_X_DISPLAY (f);
794 PropMotifWmHints hints;
795 Atom prop = XInternAtom (dpy, "_MOTIF_WM_HINTS", False);
797 memset (&hints, 0, sizeof(hints));
798 hints.flags = MWM_HINTS_DECORATIONS;
799 hints.decorations = NILP (new_value) ? MWM_DECOR_ALL : 0;
801 block_input ();
802 /* For some reason the third and fourth arguments in the following
803 call must be identical: In the corresponding XGetWindowProperty
804 call in getMotifHints, xfwm has the third and seventh args both
805 display_info->atoms[MOTIF_WM_HINTS]. Obviously, YMMV. */
806 XChangeProperty (dpy, FRAME_OUTER_WINDOW (f), prop, prop, 32,
807 PropModeReplace, (unsigned char *) &hints,
808 PROP_MOTIF_WM_HINTS_ELEMENTS);
809 unblock_input ();
811 #endif /* USE_GTK */
816 * x_set_parent_frame:
818 * Set frame F's `parent-frame' parameter. If non-nil, make F a child
819 * frame of the frame specified by that parameter. Technically, this
820 * makes F's window-system window a child window of the parent frame's
821 * window-system window. If nil, make F's window-system window a
822 * top-level window--a child of its display's root window.
824 * A child frame is clipped at the native edges of its parent frame.
825 * Its `left' and `top' parameters specify positions relative to the
826 * top-left corner of its parent frame's native rectangle. Usually,
827 * moving a parent frame moves all its child frames too, keeping their
828 * position relative to the parent unaltered. When a parent frame is
829 * iconified or made invisible, its child frames are made invisible.
830 * When a parent frame is deleted, its child frames are deleted too.
832 * A visible child frame always appears on top of its parent frame thus
833 * obscuring parts of it. When a frame has more than one child frame,
834 * their stacking order is specified just as that of non-child frames
835 * relative to their display.
837 * Whether a child frame has a menu or tool bar may be window-system or
838 * window manager dependent. It's advisable to disable both via the
839 * frame parameter settings.
841 * Some window managers may not honor this parameter.
843 static void
844 x_set_parent_frame (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
846 struct frame *p = NULL;
848 if (!NILP (new_value)
849 && (!FRAMEP (new_value)
850 || !FRAME_LIVE_P (p = XFRAME (new_value))
851 || !FRAME_X_P (p)))
853 store_frame_param (f, Qparent_frame, old_value);
854 error ("Invalid specification of `parent-frame'");
857 if (p != FRAME_PARENT_FRAME (f))
859 block_input ();
860 XReparentWindow
861 (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
862 p ? FRAME_X_WINDOW (p) : DefaultRootWindow (FRAME_X_DISPLAY (f)),
863 f->left_pos, f->top_pos);
864 unblock_input ();
866 fset_parent_frame (f, new_value);
871 * x_set_no_focus_on_map:
873 * Set frame F's `no-focus-on-map' parameter which, if non-nil, means
874 * that F's window-system window does not want to receive input focus
875 * when it is mapped. (A frame's window is mapped when the frame is
876 * displayed for the first time and when the frame changes its state
877 * from `iconified' or `invisible' to `visible'.)
879 * Some window managers may not honor this parameter.
881 static void
882 x_set_no_focus_on_map (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
884 if (!EQ (new_value, old_value))
886 #ifdef USE_GTK
887 xg_set_no_focus_on_map (f, new_value);
888 #else /* not USE_GTK */
889 Display *dpy = FRAME_X_DISPLAY (f);
890 Atom prop = XInternAtom (dpy, "_NET_WM_USER_TIME", False);
891 Time timestamp = NILP (new_value) ? CurrentTime : 0;
893 XChangeProperty (dpy, FRAME_OUTER_WINDOW (f), prop,
894 XA_CARDINAL, 32, PropModeReplace,
895 (unsigned char *) &timestamp, 1);
896 #endif /* USE_GTK */
897 FRAME_NO_FOCUS_ON_MAP (f) = !NILP (new_value);
902 * x_set_no_accept_focus:
904 * Set frame F's `no-accept-focus' parameter which, if non-nil, hints
905 * that F's window-system window does not want to receive input focus
906 * via mouse clicks or by moving the mouse into it.
908 * If non-nil, this may have the unwanted side-effect that a user cannot
909 * scroll a non-selected frame with the mouse.
911 * Some window managers may not honor this parameter.
913 static void
914 x_set_no_accept_focus (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
916 if (!EQ (new_value, old_value))
918 #ifdef USE_GTK
919 xg_set_no_accept_focus (f, new_value);
920 #else /* not USE_GTK */
921 #ifdef USE_X_TOOLKIT
922 Arg al[1];
924 XtSetArg (al[0], XtNinput, NILP (new_value) ? True : False);
925 XtSetValues (f->output_data.x->widget, al, 1);
926 #else /* not USE_X_TOOLKIT */
927 Window window = FRAME_X_WINDOW (f);
929 f->output_data.x->wm_hints.input = NILP (new_value) ? True : False;
930 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
931 #endif /* USE_X_TOOLKIT */
932 #endif /* USE_GTK */
933 FRAME_NO_ACCEPT_FOCUS (f) = !NILP (new_value);
938 * x_set_override_redirect:
940 * Set frame F's `override_redirect' parameter which, if non-nil, hints
941 * that the window manager doesn't want to deal with F. Usually, such
942 * frames have no decorations and always appear on top of all frames.
944 * Some window managers may not honor this parameter.
946 static void
947 x_set_override_redirect (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
949 if (!EQ (new_value, old_value))
951 /* Here (xfwm) override_redirect can be changed for invisible
952 frames only. */
953 x_make_frame_invisible (f);
955 #ifdef USE_GTK
956 xg_set_override_redirect (f, new_value);
957 #else /* not USE_GTK */
958 XSetWindowAttributes attributes;
960 attributes.override_redirect = NILP (new_value) ? False : True;
961 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
962 CWOverrideRedirect, &attributes);
963 #endif
964 x_make_frame_visible (f);
965 FRAME_OVERRIDE_REDIRECT (f) = !NILP (new_value);
970 #ifdef USE_GTK
972 /* Set icon from FILE for frame F. By using GTK functions the icon
973 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
975 bool
976 xg_set_icon (struct frame *f, Lisp_Object file)
978 bool result = false;
979 Lisp_Object found;
981 found = x_find_image_file (file);
983 if (! NILP (found))
985 GdkPixbuf *pixbuf;
986 GError *err = NULL;
987 char *filename = SSDATA (ENCODE_FILE (found));
988 block_input ();
990 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
992 if (pixbuf)
994 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
995 pixbuf);
996 g_object_unref (pixbuf);
998 result = true;
1000 else
1001 g_error_free (err);
1003 unblock_input ();
1006 return result;
1009 bool
1010 xg_set_icon_from_xpm_data (struct frame *f, const char **data)
1012 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data (data);
1014 if (!pixbuf)
1015 return false;
1017 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), pixbuf);
1018 g_object_unref (pixbuf);
1019 return true;
1021 #endif /* USE_GTK */
1024 /* Functions called only from `x_set_frame_param'
1025 to set individual parameters.
1027 If FRAME_X_WINDOW (f) is 0,
1028 the frame is being created and its X-window does not exist yet.
1029 In that case, just record the parameter's new value
1030 in the standard place; do not attempt to change the window. */
1032 static void
1033 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1035 struct x_output *x = f->output_data.x;
1036 unsigned long fg, old_fg;
1038 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1039 old_fg = FRAME_FOREGROUND_PIXEL (f);
1040 FRAME_FOREGROUND_PIXEL (f) = fg;
1042 if (FRAME_X_WINDOW (f) != 0)
1044 Display *dpy = FRAME_X_DISPLAY (f);
1046 block_input ();
1047 XSetForeground (dpy, x->normal_gc, fg);
1048 XSetBackground (dpy, x->reverse_gc, fg);
1050 if (x->cursor_pixel == old_fg)
1052 unload_color (f, x->cursor_pixel);
1053 x->cursor_pixel = x_copy_color (f, fg);
1054 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
1057 unblock_input ();
1059 update_face_from_frame_parameter (f, Qforeground_color, arg);
1061 if (FRAME_VISIBLE_P (f))
1062 redraw_frame (f);
1065 unload_color (f, old_fg);
1068 static void
1069 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1071 struct x_output *x = f->output_data.x;
1072 unsigned long bg;
1074 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1075 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
1076 FRAME_BACKGROUND_PIXEL (f) = bg;
1078 if (FRAME_X_WINDOW (f) != 0)
1080 Display *dpy = FRAME_X_DISPLAY (f);
1082 block_input ();
1083 XSetBackground (dpy, x->normal_gc, bg);
1084 XSetForeground (dpy, x->reverse_gc, bg);
1085 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
1086 XSetForeground (dpy, x->cursor_gc, bg);
1088 #ifdef USE_GTK
1089 xg_set_background_color (f, bg);
1090 #endif
1092 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
1093 toolkit scroll bars. */
1095 Lisp_Object bar;
1096 for (bar = FRAME_SCROLL_BARS (f);
1097 !NILP (bar);
1098 bar = XSCROLL_BAR (bar)->next)
1100 Window window = XSCROLL_BAR (bar)->x_window;
1101 XSetWindowBackground (dpy, window, bg);
1104 #endif /* USE_TOOLKIT_SCROLL_BARS */
1106 unblock_input ();
1107 update_face_from_frame_parameter (f, Qbackground_color, arg);
1109 if (FRAME_VISIBLE_P (f))
1110 redraw_frame (f);
1114 /* This array must stay in sync with the mouse_cursor_types array below! */
1115 enum mouse_cursor {
1116 mouse_cursor_text,
1117 mouse_cursor_nontext,
1118 mouse_cursor_hourglass,
1119 mouse_cursor_mode,
1120 mouse_cursor_hand,
1121 mouse_cursor_horizontal_drag,
1122 mouse_cursor_vertical_drag,
1123 mouse_cursor_left_edge,
1124 mouse_cursor_top_left_corner,
1125 mouse_cursor_top_edge,
1126 mouse_cursor_top_right_corner,
1127 mouse_cursor_right_edge,
1128 mouse_cursor_bottom_right_corner,
1129 mouse_cursor_bottom_edge,
1130 mouse_cursor_bottom_left_corner,
1131 mouse_cursor_max
1134 struct mouse_cursor_types {
1135 /* Printable name for error messages (optional). */
1136 const char *name;
1138 /* Lisp variable controlling the cursor shape. */
1139 /* FIXME: A couple of these variables are defined in the C code but
1140 are not actually accessible from Lisp. They should probably be
1141 made accessible or removed. */
1142 Lisp_Object *shape_var_ptr;
1144 /* The default shape. */
1145 int default_shape;
1148 /* This array must stay in sync with enum mouse_cursor above! */
1149 static const struct mouse_cursor_types mouse_cursor_types[] = {
1150 { "text", &Vx_pointer_shape, XC_xterm },
1151 { "nontext", &Vx_nontext_pointer_shape, XC_left_ptr },
1152 { "hourglass", &Vx_hourglass_pointer_shape, XC_watch },
1153 { "modeline", &Vx_mode_pointer_shape, XC_xterm },
1154 { NULL, &Vx_sensitive_text_pointer_shape, XC_hand2 },
1155 { NULL, &Vx_window_horizontal_drag_shape, XC_sb_h_double_arrow },
1156 { NULL, &Vx_window_vertical_drag_shape, XC_sb_v_double_arrow },
1157 { NULL, &Vx_window_left_edge_shape, XC_left_side },
1158 { NULL, &Vx_window_top_left_corner_shape, XC_top_left_corner },
1159 { NULL, &Vx_window_top_edge_shape, XC_top_side },
1160 { NULL, &Vx_window_top_right_corner_shape, XC_top_right_corner },
1161 { NULL, &Vx_window_right_edge_shape, XC_right_side },
1162 { NULL, &Vx_window_bottom_right_corner_shape, XC_bottom_right_corner },
1163 { NULL, &Vx_window_bottom_edge_shape, XC_bottom_side },
1164 { NULL, &Vx_window_bottom_left_corner_shape, XC_bottom_left_corner },
1167 struct mouse_cursor_data {
1168 /* Last index for which XCreateFontCursor has been called, and thus
1169 the last index for which x_request_serial[] is valid. */
1170 int last_cursor_create_request;
1172 /* Last index for which an X error event was received in response to
1173 attempting to create the cursor. */
1174 int error_cursor;
1176 /* Cursor numbers chosen. */
1177 unsigned int cursor_num[mouse_cursor_max];
1179 /* Allocated Cursor values, or zero for failed attempts. */
1180 Cursor cursor[mouse_cursor_max];
1182 /* X serial numbers for the first request sent by XCreateFontCursor.
1183 Note that there may be more than one request sent. */
1184 unsigned long x_request_serial[mouse_cursor_max];
1186 /* If an error has been received, a pointer to where the current
1187 error-message text is stored. */
1188 char *error_string;
1191 static void
1192 x_set_mouse_color_handler (Display *dpy, XErrorEvent *event,
1193 char *error_string, void *data)
1195 struct mouse_cursor_data *cursor_data = data;
1196 int i;
1198 cursor_data->error_cursor = -1;
1199 cursor_data->error_string = error_string;
1200 for (i = 0; i < cursor_data->last_cursor_create_request; i++)
1202 if (event->serial >= cursor_data->x_request_serial[i])
1203 cursor_data->error_cursor = i;
1205 if (cursor_data->error_cursor >= 0)
1206 /* If we failed to allocate it, don't try to free it. */
1207 cursor_data->cursor[cursor_data->error_cursor] = 0;
1210 static void
1211 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1213 struct x_output *x = f->output_data.x;
1214 Display *dpy = FRAME_X_DISPLAY (f);
1215 struct mouse_cursor_data cursor_data = { -1, -1 };
1216 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1217 unsigned long mask_color = FRAME_BACKGROUND_PIXEL (f);
1218 int i;
1220 /* Don't let pointers be invisible. */
1221 if (mask_color == pixel)
1223 x_free_colors (f, &pixel, 1);
1224 pixel = x_copy_color (f, FRAME_FOREGROUND_PIXEL (f));
1227 unload_color (f, x->mouse_pixel);
1228 x->mouse_pixel = pixel;
1230 for (i = 0; i < mouse_cursor_max; i++)
1232 Lisp_Object shape_var = *mouse_cursor_types[i].shape_var_ptr;
1233 if (!NILP (shape_var))
1235 CHECK_TYPE_RANGED_INTEGER (unsigned, shape_var);
1236 cursor_data.cursor_num[i] = XINT (shape_var);
1238 else
1239 cursor_data.cursor_num[i] = mouse_cursor_types[i].default_shape;
1242 block_input ();
1244 /* It's not okay to crash if the user selects a screwy cursor. */
1245 x_catch_errors_with_handler (dpy, x_set_mouse_color_handler, &cursor_data);
1247 for (i = 0; i < mouse_cursor_max; i++)
1249 cursor_data.x_request_serial[i] = XNextRequest (dpy);
1250 cursor_data.last_cursor_create_request = i;
1251 cursor_data.cursor[i] = XCreateFontCursor (dpy,
1252 cursor_data.cursor_num[i]);
1255 /* Now sync up and process all received errors from cursor
1256 creation. */
1257 if (x_had_errors_p (dpy))
1259 const char *bad_cursor_name = NULL;
1260 /* Bounded by X_ERROR_MESSAGE_SIZE in xterm.c. */
1261 size_t message_length = strlen (cursor_data.error_string);
1262 char *xmessage = alloca (1 + message_length);
1263 memcpy (xmessage, cursor_data.error_string, message_length);
1265 x_uncatch_errors ();
1267 /* Free any successfully created cursors. */
1268 for (i = 0; i < mouse_cursor_max; i++)
1269 if (cursor_data.cursor[i] != 0)
1270 XFreeCursor (dpy, cursor_data.cursor[i]);
1272 /* This should only be able to fail if the server's serial
1273 number tracking is broken. */
1274 if (cursor_data.error_cursor >= 0)
1275 bad_cursor_name = mouse_cursor_types[cursor_data.error_cursor].name;
1276 if (bad_cursor_name)
1277 error ("bad %s pointer cursor: %s", bad_cursor_name, xmessage);
1278 else
1279 error ("can't set cursor shape: %s", xmessage);
1282 x_uncatch_errors_after_check ();
1285 XColor colors[2]; /* 0=foreground, 1=background */
1287 colors[0].pixel = x->mouse_pixel;
1288 colors[1].pixel = mask_color;
1289 x_query_colors (f, colors, 2);
1291 for (i = 0; i < mouse_cursor_max; i++)
1292 XRecolorCursor (dpy, cursor_data.cursor[i], &colors[0], &colors[1]);
1295 if (FRAME_X_WINDOW (f) != 0)
1297 f->output_data.x->current_cursor = cursor_data.cursor[mouse_cursor_text];
1298 XDefineCursor (dpy, FRAME_X_WINDOW (f),
1299 f->output_data.x->current_cursor);
1302 #define INSTALL_CURSOR(FIELD, SHORT_INDEX) \
1303 eassert (x->FIELD != cursor_data.cursor[mouse_cursor_ ## SHORT_INDEX]); \
1304 if (x->FIELD != 0) \
1305 XFreeCursor (dpy, x->FIELD); \
1306 x->FIELD = cursor_data.cursor[mouse_cursor_ ## SHORT_INDEX];
1308 INSTALL_CURSOR (text_cursor, text);
1309 INSTALL_CURSOR (nontext_cursor, nontext);
1310 INSTALL_CURSOR (hourglass_cursor, hourglass);
1311 INSTALL_CURSOR (modeline_cursor, mode);
1312 INSTALL_CURSOR (hand_cursor, hand);
1313 INSTALL_CURSOR (horizontal_drag_cursor, horizontal_drag);
1314 INSTALL_CURSOR (vertical_drag_cursor, vertical_drag);
1315 INSTALL_CURSOR (left_edge_cursor, left_edge);
1316 INSTALL_CURSOR (top_left_corner_cursor, top_left_corner);
1317 INSTALL_CURSOR (top_edge_cursor, top_edge);
1318 INSTALL_CURSOR (top_right_corner_cursor, top_right_corner);
1319 INSTALL_CURSOR (right_edge_cursor, right_edge);
1320 INSTALL_CURSOR (bottom_right_corner_cursor, bottom_right_corner);
1321 INSTALL_CURSOR (bottom_edge_cursor, bottom_edge);
1322 INSTALL_CURSOR (bottom_left_corner_cursor, bottom_left_corner);
1324 #undef INSTALL_CURSOR
1326 XFlush (dpy);
1327 unblock_input ();
1329 update_face_from_frame_parameter (f, Qmouse_color, arg);
1332 static void
1333 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1335 unsigned long fore_pixel, pixel;
1336 bool fore_pixel_allocated_p = false, pixel_allocated_p = false;
1337 struct x_output *x = f->output_data.x;
1339 if (!NILP (Vx_cursor_fore_pixel))
1341 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1342 WHITE_PIX_DEFAULT (f));
1343 fore_pixel_allocated_p = true;
1345 else
1346 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1348 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1349 pixel_allocated_p = true;
1351 /* Make sure that the cursor color differs from the background color. */
1352 if (pixel == FRAME_BACKGROUND_PIXEL (f))
1354 if (pixel_allocated_p)
1356 x_free_colors (f, &pixel, 1);
1357 pixel_allocated_p = false;
1360 pixel = x->mouse_pixel;
1361 if (pixel == fore_pixel)
1363 if (fore_pixel_allocated_p)
1365 x_free_colors (f, &fore_pixel, 1);
1366 fore_pixel_allocated_p = false;
1368 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1372 unload_color (f, x->cursor_foreground_pixel);
1373 if (!fore_pixel_allocated_p)
1374 fore_pixel = x_copy_color (f, fore_pixel);
1375 x->cursor_foreground_pixel = fore_pixel;
1377 unload_color (f, x->cursor_pixel);
1378 if (!pixel_allocated_p)
1379 pixel = x_copy_color (f, pixel);
1380 x->cursor_pixel = pixel;
1382 if (FRAME_X_WINDOW (f) != 0)
1384 block_input ();
1385 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
1386 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
1387 unblock_input ();
1389 if (FRAME_VISIBLE_P (f))
1391 x_update_cursor (f, false);
1392 x_update_cursor (f, true);
1396 update_face_from_frame_parameter (f, Qcursor_color, arg);
1399 /* Set the border-color of frame F to pixel value PIX.
1400 Note that this does not fully take effect if done before
1401 F has an x-window. */
1403 static void
1404 x_set_border_pixel (struct frame *f, int pix)
1406 unload_color (f, f->output_data.x->border_pixel);
1407 f->output_data.x->border_pixel = pix;
1409 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
1411 block_input ();
1412 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), pix);
1413 unblock_input ();
1415 if (FRAME_VISIBLE_P (f))
1416 redraw_frame (f);
1420 /* Set the border-color of frame F to value described by ARG.
1421 ARG can be a string naming a color.
1422 The border-color is used for the border that is drawn by the X server.
1423 Note that this does not fully take effect if done before
1424 F has an x-window; it must be redone when the window is created.
1426 Note: this is done in two routines because of the way X10 works.
1428 Note: under X11, this is normally the province of the window manager,
1429 and so emacs's border colors may be overridden. */
1431 static void
1432 x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1434 int pix;
1436 CHECK_STRING (arg);
1437 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1438 x_set_border_pixel (f, pix);
1439 update_face_from_frame_parameter (f, Qborder_color, arg);
1443 static void
1444 x_set_cursor_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1446 set_frame_cursor_types (f, arg);
1449 static void
1450 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1452 bool result;
1454 if (STRINGP (arg))
1456 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1457 return;
1459 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1460 return;
1462 block_input ();
1463 if (NILP (arg))
1464 result = x_text_icon (f,
1465 SSDATA ((!NILP (f->icon_name)
1466 ? f->icon_name
1467 : f->name)));
1468 else
1469 result = x_bitmap_icon (f, arg);
1471 if (result)
1473 unblock_input ();
1474 error ("No icon window available");
1477 XFlush (FRAME_X_DISPLAY (f));
1478 unblock_input ();
1481 static void
1482 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1484 bool result;
1486 if (STRINGP (arg))
1488 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1489 return;
1491 else if (!NILP (arg) || NILP (oldval))
1492 return;
1494 fset_icon_name (f, arg);
1496 if (f->output_data.x->icon_bitmap != 0)
1497 return;
1499 block_input ();
1501 result = x_text_icon (f,
1502 SSDATA ((!NILP (f->icon_name)
1503 ? f->icon_name
1504 : !NILP (f->title)
1505 ? f->title
1506 : f->name)));
1508 if (result)
1510 unblock_input ();
1511 error ("No icon window available");
1514 XFlush (FRAME_X_DISPLAY (f));
1515 unblock_input ();
1519 static void
1520 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1522 int nlines;
1523 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1524 int olines = FRAME_MENU_BAR_LINES (f);
1525 #endif
1527 /* Right now, menu bars don't work properly in minibuf-only frames;
1528 most of the commands try to apply themselves to the minibuffer
1529 frame itself, and get an error because you can't switch buffers
1530 in or split the minibuffer window. */
1531 if (FRAME_MINIBUF_ONLY_P (f) || FRAME_PARENT_FRAME (f))
1532 return;
1534 if (TYPE_RANGED_INTEGERP (int, value))
1535 nlines = XINT (value);
1536 else
1537 nlines = 0;
1539 /* Make sure we redisplay all windows in this frame. */
1540 fset_redisplay (f);
1542 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1543 FRAME_MENU_BAR_LINES (f) = 0;
1544 FRAME_MENU_BAR_HEIGHT (f) = 0;
1545 if (nlines)
1547 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1548 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1549 /* Make sure next redisplay shows the menu bar. */
1550 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = true;
1552 else
1554 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1555 free_frame_menubar (f);
1556 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1557 if (FRAME_X_P (f))
1558 f->output_data.x->menubar_widget = 0;
1560 #else /* not USE_X_TOOLKIT && not USE_GTK */
1561 FRAME_MENU_BAR_LINES (f) = nlines;
1562 FRAME_MENU_BAR_HEIGHT (f) = nlines * FRAME_LINE_HEIGHT (f);
1563 adjust_frame_size (f, -1, -1, 2, true, Qx_set_menu_bar_lines);
1564 if (FRAME_X_WINDOW (f))
1565 x_clear_under_internal_border (f);
1567 /* If the menu bar height gets changed, the internal border below
1568 the top margin has to be cleared. Also, if the menu bar gets
1569 larger, the area for the added lines has to be cleared except for
1570 the first menu bar line that is to be drawn later. */
1571 if (nlines != olines)
1573 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1574 int width = FRAME_PIXEL_WIDTH (f);
1575 int y;
1577 /* height can be zero here. */
1578 if (FRAME_X_WINDOW (f) && height > 0 && width > 0)
1580 y = FRAME_TOP_MARGIN_HEIGHT (f);
1582 block_input ();
1583 x_clear_area (f, 0, y, width, height);
1584 unblock_input ();
1587 if (nlines > 1 && nlines > olines)
1589 y = (olines == 0 ? 1 : olines) * FRAME_LINE_HEIGHT (f);
1590 height = nlines * FRAME_LINE_HEIGHT (f) - y;
1592 block_input ();
1593 x_clear_area (f, 0, y, width, height);
1594 unblock_input ();
1597 if (nlines == 0 && WINDOWP (f->menu_bar_window))
1598 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1600 #endif /* not USE_X_TOOLKIT && not USE_GTK */
1601 adjust_frame_glyphs (f);
1605 /* Set the number of lines used for the tool bar of frame F to VALUE.
1606 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1607 is the old number of tool bar lines. This function changes the
1608 height of all windows on frame F to match the new tool bar height.
1609 The frame's height doesn't change. */
1611 static void
1612 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1614 int nlines;
1616 /* Treat tool bars like menu bars. */
1617 if (FRAME_MINIBUF_ONLY_P (f))
1618 return;
1620 /* Use VALUE only if an int >= 0. */
1621 if (RANGED_INTEGERP (0, value, INT_MAX))
1622 nlines = XFASTINT (value);
1623 else
1624 nlines = 0;
1626 x_change_tool_bar_height (f, nlines * FRAME_LINE_HEIGHT (f));
1630 /* Set the pixel height of the tool bar of frame F to HEIGHT. */
1631 void
1632 x_change_tool_bar_height (struct frame *f, int height)
1634 #ifdef USE_GTK
1635 FRAME_TOOL_BAR_LINES (f) = 0;
1636 FRAME_TOOL_BAR_HEIGHT (f) = 0;
1637 if (height)
1639 FRAME_EXTERNAL_TOOL_BAR (f) = true;
1640 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1641 /* Make sure next redisplay shows the tool bar. */
1642 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = true;
1643 update_frame_tool_bar (f);
1645 else
1647 if (FRAME_EXTERNAL_TOOL_BAR (f))
1648 free_frame_tool_bar (f);
1649 FRAME_EXTERNAL_TOOL_BAR (f) = false;
1651 #else /* !USE_GTK */
1652 int unit = FRAME_LINE_HEIGHT (f);
1653 int old_height = FRAME_TOOL_BAR_HEIGHT (f);
1654 int lines = (height + unit - 1) / unit;
1655 Lisp_Object fullscreen;
1657 /* Make sure we redisplay all windows in this frame. */
1658 fset_redisplay (f);
1660 /* Recalculate tool bar and frame text sizes. */
1661 FRAME_TOOL_BAR_HEIGHT (f) = height;
1662 FRAME_TOOL_BAR_LINES (f) = lines;
1663 /* Store the `tool-bar-lines' and `height' frame parameters. */
1664 store_frame_param (f, Qtool_bar_lines, make_number (lines));
1665 store_frame_param (f, Qheight, make_number (FRAME_LINES (f)));
1667 /* We also have to make sure that the internal border at the top of
1668 the frame, below the menu bar or tool bar, is redrawn when the
1669 tool bar disappears. This is so because the internal border is
1670 below the tool bar if one is displayed, but is below the menu bar
1671 if there isn't a tool bar. The tool bar draws into the area
1672 below the menu bar. */
1673 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_HEIGHT (f) == 0)
1675 clear_frame (f);
1676 clear_current_matrices (f);
1679 if ((height < old_height) && WINDOWP (f->tool_bar_window))
1680 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1682 /* Recalculate toolbar height. */
1683 f->n_tool_bar_rows = 0;
1684 if (old_height == 0
1685 && (!f->after_make_frame
1686 || NILP (frame_inhibit_implied_resize)
1687 || (CONSP (frame_inhibit_implied_resize)
1688 && NILP (Fmemq (Qtool_bar_lines, frame_inhibit_implied_resize)))))
1689 f->tool_bar_redisplayed = f->tool_bar_resized = false;
1691 adjust_frame_size (f, -1, -1,
1692 ((!f->tool_bar_resized
1693 && (NILP (fullscreen =
1694 get_frame_param (f, Qfullscreen))
1695 || EQ (fullscreen, Qfullwidth))) ? 1
1696 : (old_height == 0 || height == 0) ? 2
1697 : 4),
1698 false, Qtool_bar_lines);
1700 f->tool_bar_resized = f->tool_bar_redisplayed;
1702 /* adjust_frame_size might not have done anything, garbage frame
1703 here. */
1704 adjust_frame_glyphs (f);
1705 SET_FRAME_GARBAGED (f);
1706 if (FRAME_X_WINDOW (f))
1707 x_clear_under_internal_border (f);
1709 #endif /* USE_GTK */
1713 static void
1714 x_set_internal_border_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1716 int border;
1718 CHECK_TYPE_RANGED_INTEGER (int, arg);
1719 border = max (XINT (arg), 0);
1721 if (border != FRAME_INTERNAL_BORDER_WIDTH (f))
1723 f->internal_border_width = border;
1725 #ifdef USE_X_TOOLKIT
1726 if (FRAME_X_OUTPUT (f)->edit_widget)
1727 widget_store_internal_border (FRAME_X_OUTPUT (f)->edit_widget);
1728 #endif
1730 if (FRAME_X_WINDOW (f))
1732 adjust_frame_size (f, -1, -1, 3, false, Qinternal_border_width);
1733 x_clear_under_internal_border (f);
1740 /* Set the foreground color for scroll bars on frame F to VALUE.
1741 VALUE should be a string, a color name. If it isn't a string or
1742 isn't a valid color name, do nothing. OLDVAL is the old value of
1743 the frame parameter. */
1745 static void
1746 x_set_scroll_bar_foreground (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1748 unsigned long pixel;
1750 if (STRINGP (value))
1751 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1752 else
1753 pixel = -1;
1755 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1756 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1758 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1759 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1761 /* Remove all scroll bars because they have wrong colors. */
1762 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1763 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1764 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1765 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1767 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1768 redraw_frame (f);
1773 /* Set the background color for scroll bars on frame F to VALUE VALUE
1774 should be a string, a color name. If it isn't a string or isn't a
1775 valid color name, do nothing. OLDVAL is the old value of the frame
1776 parameter. */
1778 static void
1779 x_set_scroll_bar_background (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1781 unsigned long pixel;
1783 if (STRINGP (value))
1784 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1785 else
1786 pixel = -1;
1788 if (f->output_data.x->scroll_bar_background_pixel != -1)
1789 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1791 #if defined (USE_LUCID) && defined (USE_TOOLKIT_SCROLL_BARS)
1792 /* Scrollbar shadow colors. */
1793 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1795 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1796 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1798 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1800 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1801 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1803 #endif /* USE_LUCID && USE_TOOLKIT_SCROLL_BARS */
1805 f->output_data.x->scroll_bar_background_pixel = pixel;
1806 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1808 /* Remove all scroll bars because they have wrong colors. */
1809 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1810 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1811 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1812 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1814 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1815 redraw_frame (f);
1820 /* Encode Lisp string STRING as a text in a format appropriate for
1821 XICCC (X Inter Client Communication Conventions).
1823 If STRING contains only ASCII characters, do no conversion and
1824 return the string data of STRING. Otherwise, encode the text by
1825 CODING_SYSTEM, and return a newly allocated memory area which
1826 should be freed by `xfree' by a caller.
1828 Store the byte length of resulting text in *TEXT_BYTES.
1830 If the text contains only ASCII and Latin-1, store true in *STRING_P,
1831 which means that the `encoding' of the result can be `STRING'.
1832 Otherwise store false in *STRINGP, which means that the `encoding' of
1833 the result should be `COMPOUND_TEXT'. */
1835 static unsigned char *
1836 x_encode_text (Lisp_Object string, Lisp_Object coding_system,
1837 ptrdiff_t *text_bytes, bool *stringp, bool *freep)
1839 int result = string_xstring_p (string);
1840 struct coding_system coding;
1842 if (result == 0)
1844 /* No multibyte character in OBJ. We need not encode it. */
1845 *text_bytes = SBYTES (string);
1846 *stringp = true;
1847 *freep = false;
1848 return SDATA (string);
1851 setup_coding_system (coding_system, &coding);
1852 coding.mode |= (CODING_MODE_SAFE_ENCODING | CODING_MODE_LAST_BLOCK);
1853 /* We suppress producing escape sequences for composition. */
1854 coding.common_flags &= ~CODING_ANNOTATION_MASK;
1855 coding.destination = xnmalloc (SCHARS (string), 2);
1856 coding.dst_bytes = SCHARS (string) * 2;
1857 encode_coding_object (&coding, string, 0, 0,
1858 SCHARS (string), SBYTES (string), Qnil);
1859 *text_bytes = coding.produced;
1860 *stringp = (result == 1 || !EQ (coding_system, Qcompound_text));
1861 *freep = true;
1862 return coding.destination;
1866 /* Set the WM name to NAME for frame F. Also set the icon name.
1867 If the frame already has an icon name, use that, otherwise set the
1868 icon name to NAME. */
1870 static void
1871 x_set_name_internal (struct frame *f, Lisp_Object name)
1873 if (FRAME_X_WINDOW (f))
1875 block_input ();
1877 XTextProperty text, icon;
1878 ptrdiff_t bytes;
1879 bool stringp;
1880 bool do_free_icon_value = false, do_free_text_value = false;
1881 Lisp_Object coding_system;
1882 Lisp_Object encoded_name;
1883 Lisp_Object encoded_icon_name;
1885 /* As ENCODE_UTF_8 may cause GC and relocation of string data,
1886 we use it before x_encode_text that may return string data. */
1887 encoded_name = ENCODE_UTF_8 (name);
1889 coding_system = Qcompound_text;
1890 /* Note: Encoding strategy
1892 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1893 text.encoding. But, there are non-internationalized window
1894 managers which don't support that encoding. So, if NAME
1895 contains only ASCII and 8859-1 characters, encode it by
1896 iso-latin-1, and use "STRING" in text.encoding hoping that
1897 such window managers at least analyze this format correctly,
1898 i.e. treat 8-bit bytes as 8859-1 characters.
1900 We may also be able to use "UTF8_STRING" in text.encoding
1901 in the future which can encode all Unicode characters.
1902 But, for the moment, there's no way to know that the
1903 current window manager supports it or not.
1905 Either way, we also set the _NET_WM_NAME and _NET_WM_ICON_NAME
1906 properties. Per the EWMH specification, those two properties
1907 are always UTF8_STRING. This matches what gtk_window_set_title()
1908 does in the USE_GTK case. */
1909 text.value = x_encode_text (name, coding_system, &bytes,
1910 &stringp, &do_free_text_value);
1911 text.encoding = (stringp ? XA_STRING
1912 : FRAME_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1913 text.format = 8;
1914 text.nitems = bytes;
1916 if (!STRINGP (f->icon_name))
1918 icon = text;
1919 encoded_icon_name = encoded_name;
1921 else
1923 /* See the above comment "Note: Encoding strategy". */
1924 icon.value = x_encode_text (f->icon_name, coding_system, &bytes,
1925 &stringp, &do_free_icon_value);
1926 icon.encoding = (stringp ? XA_STRING
1927 : FRAME_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1928 icon.format = 8;
1929 icon.nitems = bytes;
1931 encoded_icon_name = ENCODE_UTF_8 (f->icon_name);
1934 #ifdef USE_GTK
1935 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1936 SSDATA (encoded_name));
1937 #else /* not USE_GTK */
1938 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1939 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1940 FRAME_DISPLAY_INFO (f)->Xatom_net_wm_name,
1941 FRAME_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1942 8, PropModeReplace,
1943 SDATA (encoded_name),
1944 SBYTES (encoded_name));
1945 #endif /* not USE_GTK */
1947 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1948 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1949 FRAME_DISPLAY_INFO (f)->Xatom_net_wm_icon_name,
1950 FRAME_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1951 8, PropModeReplace,
1952 SDATA (encoded_icon_name),
1953 SBYTES (encoded_icon_name));
1955 if (do_free_icon_value)
1956 xfree (icon.value);
1957 if (do_free_text_value)
1958 xfree (text.value);
1960 unblock_input ();
1964 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1965 x_id_name.
1967 If EXPLICIT is true, that indicates that lisp code is setting the
1968 name; if NAME is a string, set F's name to NAME and set
1969 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1971 If EXPLICIT is false, that indicates that Emacs redisplay code is
1972 suggesting a new name, which lisp code should override; if
1973 F->explicit_name is set, ignore the new name; otherwise, set it. */
1975 static void
1976 x_set_name (struct frame *f, Lisp_Object name, bool explicit)
1978 /* Make sure that requests from lisp code override requests from
1979 Emacs redisplay code. */
1980 if (explicit)
1982 /* If we're switching from explicit to implicit, we had better
1983 update the mode lines and thereby update the title. */
1984 if (f->explicit_name && NILP (name))
1985 update_mode_lines = 37;
1987 f->explicit_name = ! NILP (name);
1989 else if (f->explicit_name)
1990 return;
1992 /* If NAME is nil, set the name to the x_id_name. */
1993 if (NILP (name))
1995 /* Check for no change needed in this very common case
1996 before we do any consing. */
1997 if (!strcmp (FRAME_DISPLAY_INFO (f)->x_id_name,
1998 SSDATA (f->name)))
1999 return;
2000 name = build_string (FRAME_DISPLAY_INFO (f)->x_id_name);
2002 else
2003 CHECK_STRING (name);
2005 /* Don't change the name if it's already NAME. */
2006 if (! NILP (Fstring_equal (name, f->name)))
2007 return;
2009 fset_name (f, name);
2011 /* For setting the frame title, the title parameter should override
2012 the name parameter. */
2013 if (! NILP (f->title))
2014 name = f->title;
2016 x_set_name_internal (f, name);
2019 /* This function should be called when the user's lisp code has
2020 specified a name for the frame; the name will override any set by the
2021 redisplay code. */
2022 static void
2023 x_explicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
2025 x_set_name (f, arg, true);
2028 /* This function should be called by Emacs redisplay code to set the
2029 name; names set this way will never override names set by the user's
2030 lisp code. */
2031 void
2032 x_implicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
2034 x_set_name (f, arg, false);
2037 /* Change the title of frame F to NAME.
2038 If NAME is nil, use the frame name as the title. */
2040 static void
2041 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
2043 /* Don't change the title if it's already NAME. */
2044 if (EQ (name, f->title))
2045 return;
2047 update_mode_lines = 38;
2049 fset_title (f, name);
2051 if (NILP (name))
2052 name = f->name;
2053 else
2054 CHECK_STRING (name);
2056 x_set_name_internal (f, name);
2059 void
2060 x_set_scroll_bar_default_width (struct frame *f)
2062 int unit = FRAME_COLUMN_WIDTH (f);
2063 #ifdef USE_TOOLKIT_SCROLL_BARS
2064 #ifdef USE_GTK
2065 int minw = xg_get_default_scrollbar_width (f);
2066 #else
2067 int minw = 16;
2068 #endif
2069 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
2070 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (minw + unit - 1) / unit;
2071 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = minw;
2072 #else
2073 /* The width of a non-toolkit scrollbar is 14 pixels. */
2074 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + unit - 1) / unit;
2075 FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
2076 = FRAME_CONFIG_SCROLL_BAR_COLS (f) * unit;
2077 #endif
2080 void
2081 x_set_scroll_bar_default_height (struct frame *f)
2083 int height = FRAME_LINE_HEIGHT (f);
2084 #ifdef USE_TOOLKIT_SCROLL_BARS
2085 #ifdef USE_GTK
2086 int min_height = xg_get_default_scrollbar_height (f);
2087 #else
2088 int min_height = 16;
2089 #endif
2090 /* A minimum height of 14 doesn't look good for toolkit scroll bars. */
2091 FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) = min_height;
2092 FRAME_CONFIG_SCROLL_BAR_LINES (f) = (min_height + height - 1) / height;
2093 #else
2094 /* The height of a non-toolkit scrollbar is 14 pixels. */
2095 FRAME_CONFIG_SCROLL_BAR_LINES (f) = (14 + height - 1) / height;
2097 /* Use all of that space (aside from required margins) for the
2098 scroll bar. */
2099 FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) = 14;
2100 #endif
2104 /* Record in frame F the specified or default value according to ALIST
2105 of the parameter named PROP (a Lisp symbol). If no value is
2106 specified for PROP, look for an X default for XPROP on the frame
2107 named NAME. If that is not found either, use the value DEFLT. */
2109 static Lisp_Object
2110 x_default_scroll_bar_color_parameter (struct frame *f,
2111 Lisp_Object alist, Lisp_Object prop,
2112 const char *xprop, const char *xclass,
2113 bool foreground_p)
2115 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
2116 Lisp_Object tem;
2118 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
2119 if (EQ (tem, Qunbound))
2121 #ifdef USE_TOOLKIT_SCROLL_BARS
2123 /* See if an X resource for the scroll bar color has been
2124 specified. */
2125 AUTO_STRING (foreground, "foreground");
2126 AUTO_STRING (background, "foreground");
2127 AUTO_STRING (verticalScrollBar, "verticalScrollBar");
2128 tem = (display_x_get_resource
2129 (dpyinfo, foreground_p ? foreground : background,
2130 empty_unibyte_string,
2131 verticalScrollBar,
2132 empty_unibyte_string));
2133 if (!STRINGP (tem))
2135 /* If nothing has been specified, scroll bars will use a
2136 toolkit-dependent default. Because these defaults are
2137 difficult to get at without actually creating a scroll
2138 bar, use nil to indicate that no color has been
2139 specified. */
2140 tem = Qnil;
2143 #else /* not USE_TOOLKIT_SCROLL_BARS */
2145 tem = Qnil;
2147 #endif /* not USE_TOOLKIT_SCROLL_BARS */
2150 AUTO_FRAME_ARG (arg, prop, tem);
2151 x_set_frame_parameters (f, arg);
2152 return tem;
2158 #ifdef USE_X_TOOLKIT
2160 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
2161 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
2162 already be present because of the toolkit (Motif adds some of them,
2163 for example, but Xt doesn't). */
2165 static void
2166 hack_wm_protocols (struct frame *f, Widget widget)
2168 Display *dpy = XtDisplay (widget);
2169 Window w = XtWindow (widget);
2170 bool need_delete = true;
2171 bool need_focus = true;
2172 bool need_save = true;
2174 block_input ();
2176 Atom type;
2177 unsigned char *catoms;
2178 int format = 0;
2179 unsigned long nitems = 0;
2180 unsigned long bytes_after;
2182 if ((XGetWindowProperty (dpy, w,
2183 FRAME_DISPLAY_INFO (f)->Xatom_wm_protocols,
2184 0, 100, False, XA_ATOM,
2185 &type, &format, &nitems, &bytes_after,
2186 &catoms)
2187 == Success)
2188 && format == 32 && type == XA_ATOM)
2190 Atom *atoms = (Atom *) catoms;
2191 while (nitems > 0)
2193 nitems--;
2194 if (atoms[nitems]
2195 == FRAME_DISPLAY_INFO (f)->Xatom_wm_delete_window)
2196 need_delete = false;
2197 else if (atoms[nitems]
2198 == FRAME_DISPLAY_INFO (f)->Xatom_wm_take_focus)
2199 need_focus = false;
2200 else if (atoms[nitems]
2201 == FRAME_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
2202 need_save = false;
2205 if (catoms)
2206 XFree (catoms);
2209 Atom props[10];
2210 int count = 0;
2211 if (need_delete)
2212 props[count++] = FRAME_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2213 if (need_focus)
2214 props[count++] = FRAME_DISPLAY_INFO (f)->Xatom_wm_take_focus;
2215 if (need_save)
2216 props[count++] = FRAME_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2217 if (count)
2218 XChangeProperty (dpy, w, FRAME_DISPLAY_INFO (f)->Xatom_wm_protocols,
2219 XA_ATOM, 32, PropModeAppend,
2220 (unsigned char *) props, count);
2222 unblock_input ();
2224 #endif
2228 /* Support routines for XIC (X Input Context). */
2230 #ifdef HAVE_X_I18N
2232 static XFontSet xic_create_xfontset (struct frame *);
2233 static XIMStyle best_xim_style (XIMStyles *);
2236 /* Supported XIM styles, ordered by preference. */
2238 static const XIMStyle supported_xim_styles[] =
2240 XIMPreeditPosition | XIMStatusArea,
2241 XIMPreeditPosition | XIMStatusNothing,
2242 XIMPreeditPosition | XIMStatusNone,
2243 XIMPreeditNothing | XIMStatusArea,
2244 XIMPreeditNothing | XIMStatusNothing,
2245 XIMPreeditNothing | XIMStatusNone,
2246 XIMPreeditNone | XIMStatusArea,
2247 XIMPreeditNone | XIMStatusNothing,
2248 XIMPreeditNone | XIMStatusNone,
2253 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
2254 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
2256 static const char xic_default_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
2258 /* Create an Xt fontset spec from the name of a base font.
2259 If `motif' is True use the Motif syntax. */
2260 char *
2261 xic_create_fontsetname (const char *base_fontname, bool motif)
2263 const char *sep = motif ? ";" : ",";
2264 char *fontsetname;
2265 char *z;
2267 /* Make a fontset name from the base font name. */
2268 if (xic_default_fontset == base_fontname)
2270 /* There is no base font name, use the default. */
2271 fontsetname = xmalloc (strlen (base_fontname) + 2);
2272 z = stpcpy (fontsetname, base_fontname);
2274 else
2276 /* Make a fontset name from the base font name.
2277 The font set will be made of the following elements:
2278 - the base font.
2279 - the base font where the charset spec is replaced by -*-*.
2280 - the same but with the family also replaced with -*-*-. */
2281 const char *p = base_fontname;
2282 ptrdiff_t i;
2284 for (i = 0; *p; p++)
2285 if (*p == '-') i++;
2286 if (i != 14)
2288 /* As the font name doesn't conform to XLFD, we can't
2289 modify it to generalize it to allcs and allfamilies.
2290 Use the specified font plus the default. */
2291 fontsetname = xmalloc (strlen (base_fontname)
2292 + strlen (xic_default_fontset) + 3);
2293 z = stpcpy (fontsetname, base_fontname);
2294 z = stpcpy (z, sep);
2295 z = stpcpy (z, xic_default_fontset);
2297 else
2299 ptrdiff_t len;
2300 const char *p1 = NULL, *p2 = NULL, *p3 = NULL;
2301 char *font_allcs = NULL;
2302 char *font_allfamilies = NULL;
2303 char *font_all = NULL;
2304 const char *allcs = "*-*-*-*-*-*-*";
2305 const char *allfamilies = "-*-*-";
2306 const char *all = "*-*-*-*-";
2307 char *base;
2309 for (i = 0, p = base_fontname; i < 8; p++)
2311 if (*p == '-')
2313 i++;
2314 if (i == 3)
2315 p1 = p + 1;
2316 else if (i == 7)
2317 p2 = p + 1;
2318 else if (i == 6)
2319 p3 = p + 1;
2322 /* If base_fontname specifies ADSTYLE, make it a
2323 wildcard. */
2324 if (*p3 != '*')
2326 ptrdiff_t diff = (p2 - p3) - 2;
2328 base = alloca (strlen (base_fontname) + 1);
2329 memcpy (base, base_fontname, p3 - base_fontname);
2330 base[p3 - base_fontname] = '*';
2331 base[(p3 - base_fontname) + 1] = '-';
2332 strcpy (base + (p3 - base_fontname) + 2, p2);
2333 p = base + (p - base_fontname) - diff;
2334 p1 = base + (p1 - base_fontname);
2335 p2 = base + (p2 - base_fontname) - diff;
2336 base_fontname = base;
2339 /* Build the font spec that matches all charsets. */
2340 len = p - base_fontname + strlen (allcs) + 1;
2341 font_allcs = alloca (len);
2342 memcpy (font_allcs, base_fontname, p - base_fontname);
2343 strcpy (font_allcs + (p - base_fontname), allcs);
2345 /* Build the font spec that matches all families and
2346 add-styles. */
2347 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
2348 font_allfamilies = alloca (len);
2349 strcpy (font_allfamilies, allfamilies);
2350 memcpy (font_allfamilies + strlen (allfamilies), p1, p - p1);
2351 strcpy (font_allfamilies + strlen (allfamilies) + (p - p1), allcs);
2353 /* Build the font spec that matches all. */
2354 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
2355 font_all = alloca (len);
2356 z = stpcpy (font_all, allfamilies);
2357 z = stpcpy (z, all);
2358 memcpy (z, p2, p - p2);
2359 strcpy (z + (p - p2), allcs);
2361 /* Build the actual font set name. */
2362 len = strlen (base_fontname) + strlen (font_allcs)
2363 + strlen (font_allfamilies) + strlen (font_all) + 5;
2364 fontsetname = xmalloc (len);
2365 z = stpcpy (fontsetname, base_fontname);
2366 z = stpcpy (z, sep);
2367 z = stpcpy (z, font_allcs);
2368 z = stpcpy (z, sep);
2369 z = stpcpy (z, font_allfamilies);
2370 z = stpcpy (z, sep);
2371 z = stpcpy (z, font_all);
2374 if (motif)
2375 strcpy (z, ":");
2376 return fontsetname;
2378 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
2380 #ifdef DEBUG_XIC_FONTSET
2381 static void
2382 print_fontset_result (XFontSet xfs, char *name, char **missing_list,
2383 int missing_count)
2385 if (xfs)
2386 fprintf (stderr, "XIC Fontset created: %s\n", name);
2387 else
2389 fprintf (stderr, "XIC Fontset failed: %s\n", name);
2390 while (missing_count-- > 0)
2392 fprintf (stderr, " missing: %s\n", *missing_list);
2393 missing_list++;
2398 #endif
2400 static XFontSet
2401 xic_create_xfontset (struct frame *f)
2403 XFontSet xfs = NULL;
2404 struct font *font = FRAME_FONT (f);
2405 int pixel_size = font->pixel_size;
2406 Lisp_Object rest, frame;
2408 /* See if there is another frame already using same fontset. */
2409 FOR_EACH_FRAME (rest, frame)
2411 struct frame *cf = XFRAME (frame);
2413 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2414 && FRAME_DISPLAY_INFO (cf) == FRAME_DISPLAY_INFO (f)
2415 && FRAME_FONT (f)
2416 && FRAME_FONT (f)->pixel_size == pixel_size)
2418 xfs = FRAME_XIC_FONTSET (cf);
2419 break;
2423 if (! xfs)
2425 char buf[256];
2426 char **missing_list;
2427 int missing_count;
2428 char *def_string;
2429 const char *xlfd_format = "-*-*-medium-r-normal--%d-*-*-*-*-*";
2431 sprintf (buf, xlfd_format, pixel_size);
2432 missing_list = NULL;
2433 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2434 &missing_list, &missing_count, &def_string);
2435 #ifdef DEBUG_XIC_FONTSET
2436 print_fontset_result (xfs, buf, missing_list, missing_count);
2437 #endif
2438 if (missing_list)
2439 XFreeStringList (missing_list);
2440 if (! xfs)
2442 /* List of pixel sizes most likely available. Find one that
2443 is closest to pixel_size. */
2444 int sizes[] = {0, 8, 10, 11, 12, 14, 17, 18, 20, 24, 26, 34, 0};
2445 int *smaller, *larger;
2447 for (smaller = sizes; smaller[1]; smaller++)
2448 if (smaller[1] >= pixel_size)
2449 break;
2450 larger = smaller + 1;
2451 if (*larger == pixel_size)
2452 larger++;
2453 while (*smaller || *larger)
2455 int this_size;
2457 if (! *larger)
2458 this_size = *smaller--;
2459 else if (! *smaller)
2460 this_size = *larger++;
2461 else if (pixel_size - *smaller < *larger - pixel_size)
2462 this_size = *smaller--;
2463 else
2464 this_size = *larger++;
2465 sprintf (buf, xlfd_format, this_size);
2466 missing_list = NULL;
2467 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2468 &missing_list, &missing_count, &def_string);
2469 #ifdef DEBUG_XIC_FONTSET
2470 print_fontset_result (xfs, buf, missing_list, missing_count);
2471 #endif
2472 if (missing_list)
2473 XFreeStringList (missing_list);
2474 if (xfs)
2475 break;
2478 if (! xfs)
2480 const char *last_resort = "-*-*-*-r-normal--*-*-*-*-*-*";
2482 missing_list = NULL;
2483 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), last_resort,
2484 &missing_list, &missing_count, &def_string);
2485 #ifdef DEBUG_XIC_FONTSET
2486 print_fontset_result (xfs, last_resort, missing_list, missing_count);
2487 #endif
2488 if (missing_list)
2489 XFreeStringList (missing_list);
2494 return xfs;
2497 /* Free the X fontset of frame F if it is the last frame using it. */
2499 void
2500 xic_free_xfontset (struct frame *f)
2502 Lisp_Object rest, frame;
2503 bool shared_p = false;
2505 if (!FRAME_XIC_FONTSET (f))
2506 return;
2508 /* See if there is another frame sharing the same fontset. */
2509 FOR_EACH_FRAME (rest, frame)
2511 struct frame *cf = XFRAME (frame);
2512 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2513 && FRAME_DISPLAY_INFO (cf) == FRAME_DISPLAY_INFO (f)
2514 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2516 shared_p = true;
2517 break;
2521 if (!shared_p)
2522 /* The fontset is not used anymore. It is safe to free it. */
2523 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2525 FRAME_XIC_FONTSET (f) = NULL;
2529 /* Value is the best input style, given user preferences USER (already
2530 checked to be supported by Emacs), and styles supported by the
2531 input method XIM. */
2533 static XIMStyle
2534 best_xim_style (XIMStyles *xim)
2536 int i, j;
2537 int nr_supported = ARRAYELTS (supported_xim_styles);
2539 for (i = 0; i < nr_supported; ++i)
2540 for (j = 0; j < xim->count_styles; ++j)
2541 if (supported_xim_styles[i] == xim->supported_styles[j])
2542 return supported_xim_styles[i];
2544 /* Return the default style. */
2545 return XIMPreeditNothing | XIMStatusNothing;
2548 /* Create XIC for frame F. */
2550 void
2551 create_frame_xic (struct frame *f)
2553 XIM xim;
2554 XIC xic = NULL;
2555 XFontSet xfs = NULL;
2556 XVaNestedList status_attr = NULL;
2557 XVaNestedList preedit_attr = NULL;
2558 XRectangle s_area;
2559 XPoint spot;
2560 XIMStyle xic_style;
2562 if (FRAME_XIC (f))
2563 goto out;
2565 xim = FRAME_X_XIM (f);
2566 if (!xim)
2567 goto out;
2569 /* Determine XIC style. */
2570 xic_style = best_xim_style (FRAME_X_XIM_STYLES (f));
2572 /* Create X fontset. */
2573 if (xic_style & (XIMPreeditPosition | XIMStatusArea))
2575 xfs = xic_create_xfontset (f);
2576 if (!xfs)
2577 goto out;
2579 FRAME_XIC_FONTSET (f) = xfs;
2582 if (xic_style & XIMPreeditPosition)
2584 spot.x = 0; spot.y = 1;
2585 preedit_attr = XVaCreateNestedList (0,
2586 XNFontSet, xfs,
2587 XNForeground,
2588 FRAME_FOREGROUND_PIXEL (f),
2589 XNBackground,
2590 FRAME_BACKGROUND_PIXEL (f),
2591 (xic_style & XIMPreeditPosition
2592 ? XNSpotLocation
2593 : NULL),
2594 &spot,
2595 NULL);
2597 if (!preedit_attr)
2598 goto out;
2601 if (xic_style & XIMStatusArea)
2603 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2604 status_attr = XVaCreateNestedList (0,
2605 XNArea,
2606 &s_area,
2607 XNFontSet,
2608 xfs,
2609 XNForeground,
2610 FRAME_FOREGROUND_PIXEL (f),
2611 XNBackground,
2612 FRAME_BACKGROUND_PIXEL (f),
2613 NULL);
2615 if (!status_attr)
2616 goto out;
2619 if (preedit_attr && status_attr)
2620 xic = XCreateIC (xim,
2621 XNInputStyle, xic_style,
2622 XNClientWindow, FRAME_X_WINDOW (f),
2623 XNFocusWindow, FRAME_X_WINDOW (f),
2624 XNStatusAttributes, status_attr,
2625 XNPreeditAttributes, preedit_attr,
2626 NULL);
2627 else if (preedit_attr)
2628 xic = XCreateIC (xim,
2629 XNInputStyle, xic_style,
2630 XNClientWindow, FRAME_X_WINDOW (f),
2631 XNFocusWindow, FRAME_X_WINDOW (f),
2632 XNPreeditAttributes, preedit_attr,
2633 NULL);
2634 else if (status_attr)
2635 xic = XCreateIC (xim,
2636 XNInputStyle, xic_style,
2637 XNClientWindow, FRAME_X_WINDOW (f),
2638 XNFocusWindow, FRAME_X_WINDOW (f),
2639 XNStatusAttributes, status_attr,
2640 NULL);
2641 else
2642 xic = XCreateIC (xim,
2643 XNInputStyle, xic_style,
2644 XNClientWindow, FRAME_X_WINDOW (f),
2645 XNFocusWindow, FRAME_X_WINDOW (f),
2646 NULL);
2648 if (!xic)
2649 goto out;
2651 FRAME_XIC (f) = xic;
2652 FRAME_XIC_STYLE (f) = xic_style;
2653 xfs = NULL; /* Don't free below. */
2655 out:
2657 if (xfs)
2658 free_frame_xic (f);
2660 if (preedit_attr)
2661 XFree (preedit_attr);
2663 if (status_attr)
2664 XFree (status_attr);
2668 /* Destroy XIC and free XIC fontset of frame F, if any. */
2670 void
2671 free_frame_xic (struct frame *f)
2673 if (FRAME_XIC (f) == NULL)
2674 return;
2676 XDestroyIC (FRAME_XIC (f));
2677 xic_free_xfontset (f);
2679 FRAME_XIC (f) = NULL;
2683 /* Place preedit area for XIC of window W's frame to specified
2684 pixel position X/Y. X and Y are relative to window W. */
2686 void
2687 xic_set_preeditarea (struct window *w, int x, int y)
2689 struct frame *f = XFRAME (w->frame);
2690 XVaNestedList attr;
2691 XPoint spot;
2693 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2694 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2695 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2696 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2697 XFree (attr);
2701 /* Place status area for XIC in bottom right corner of frame F.. */
2703 void
2704 xic_set_statusarea (struct frame *f)
2706 XIC xic = FRAME_XIC (f);
2707 XVaNestedList attr;
2708 XRectangle area;
2709 XRectangle *needed;
2711 /* Negotiate geometry of status area. If input method has existing
2712 status area, use its current size. */
2713 area.x = area.y = area.width = area.height = 0;
2714 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2715 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2716 XFree (attr);
2718 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2719 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2720 XFree (attr);
2722 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2724 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2725 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2726 XFree (attr);
2729 area.width = needed->width;
2730 area.height = needed->height;
2731 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2732 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2733 - FRAME_MENUBAR_HEIGHT (f)
2734 - FRAME_TOOLBAR_TOP_HEIGHT (f)
2735 - FRAME_INTERNAL_BORDER_WIDTH (f));
2736 XFree (needed);
2738 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2739 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2740 XFree (attr);
2744 /* Set X fontset for XIC of frame F, using base font name
2745 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2747 void
2748 xic_set_xfontset (struct frame *f, const char *base_fontname)
2750 XVaNestedList attr;
2751 XFontSet xfs;
2753 xic_free_xfontset (f);
2755 xfs = xic_create_xfontset (f);
2757 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2758 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2759 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2760 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2761 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2762 XFree (attr);
2764 FRAME_XIC_FONTSET (f) = xfs;
2767 #endif /* HAVE_X_I18N */
2772 void
2773 x_mark_frame_dirty (struct frame *f)
2775 if (FRAME_X_DOUBLE_BUFFERED_P (f) && !FRAME_X_NEED_BUFFER_FLIP (f))
2776 FRAME_X_NEED_BUFFER_FLIP (f) = true;
2779 static void
2780 set_up_x_back_buffer (struct frame *f)
2782 #ifdef HAVE_XDBE
2783 block_input ();
2784 if (FRAME_X_WINDOW (f) && !FRAME_X_DOUBLE_BUFFERED_P (f))
2786 FRAME_X_RAW_DRAWABLE (f) = FRAME_X_WINDOW (f);
2787 if (FRAME_DISPLAY_INFO (f)->supports_xdbe)
2789 /* If allocating a back buffer fails, either because the
2790 server ran out of memory or we don't have the right kind
2791 of visual, just use single-buffered rendering. */
2792 x_catch_errors (FRAME_X_DISPLAY (f));
2793 FRAME_X_RAW_DRAWABLE (f) = XdbeAllocateBackBufferName (
2794 FRAME_X_DISPLAY (f),
2795 FRAME_X_WINDOW (f),
2796 XdbeCopied);
2797 if (x_had_errors_p (FRAME_X_DISPLAY (f)))
2798 FRAME_X_RAW_DRAWABLE (f) = FRAME_X_WINDOW (f);
2799 x_uncatch_errors_after_check ();
2802 unblock_input ();
2803 #endif
2806 void
2807 tear_down_x_back_buffer (struct frame *f)
2809 #ifdef HAVE_XDBE
2810 block_input ();
2811 if (FRAME_X_WINDOW (f) && FRAME_X_DOUBLE_BUFFERED_P (f))
2813 if (FRAME_X_DOUBLE_BUFFERED_P (f))
2815 XdbeDeallocateBackBufferName (FRAME_X_DISPLAY (f),
2816 FRAME_X_DRAWABLE (f));
2817 FRAME_X_RAW_DRAWABLE (f) = FRAME_X_WINDOW (f);
2820 unblock_input ();
2821 #endif
2824 /* Set up double buffering if the frame parameters don't prohibit
2825 it. */
2826 void
2827 initial_set_up_x_back_buffer (struct frame *f)
2829 block_input ();
2830 eassert (FRAME_X_WINDOW (f));
2831 FRAME_X_RAW_DRAWABLE (f) = FRAME_X_WINDOW (f);
2832 if (NILP (CDR (Fassq (Qinhibit_double_buffering, f->param_alist))))
2833 set_up_x_back_buffer (f);
2834 unblock_input ();
2837 #ifdef USE_X_TOOLKIT
2839 /* Create and set up the X widget for frame F. */
2841 static void
2842 x_window (struct frame *f, long window_prompting)
2844 XClassHint class_hints;
2845 XSetWindowAttributes attributes;
2846 unsigned long attribute_mask;
2847 Widget shell_widget;
2848 Widget pane_widget;
2849 Widget frame_widget;
2850 Arg al[25];
2851 int ac;
2853 block_input ();
2855 /* Use the resource name as the top-level widget name
2856 for looking up resources. Make a non-Lisp copy
2857 for the window manager, so GC relocation won't bother it.
2859 Elsewhere we specify the window name for the window manager. */
2860 f->namebuf = xlispstrdup (Vx_resource_name);
2862 ac = 0;
2863 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2864 XtSetArg (al[ac], XtNinput, 1); ac++;
2865 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2866 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2867 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2868 XtSetArg (al[ac], XtNdepth, FRAME_DISPLAY_INFO (f)->n_planes); ac++;
2869 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2870 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2871 applicationShellWidgetClass,
2872 FRAME_X_DISPLAY (f), al, ac);
2874 f->output_data.x->widget = shell_widget;
2875 /* maybe_set_screen_title_format (shell_widget); */
2877 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2878 NULL, shell_widget, False,
2879 NULL, NULL, NULL, NULL);
2881 ac = 0;
2882 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2883 XtSetArg (al[ac], XtNdepth, FRAME_DISPLAY_INFO (f)->n_planes); ac++;
2884 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2885 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2886 XtSetValues (pane_widget, al, ac);
2887 f->output_data.x->column_widget = pane_widget;
2889 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2890 the emacs screen when changing menubar. This reduces flickering. */
2892 ac = 0;
2893 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2894 XtSetArg (al[ac], (char *) XtNshowGrip, 0); ac++;
2895 XtSetArg (al[ac], (char *) XtNallowResize, 1); ac++;
2896 XtSetArg (al[ac], (char *) XtNresizeToPreferred, 1); ac++;
2897 XtSetArg (al[ac], (char *) XtNemacsFrame, f); ac++;
2898 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2899 XtSetArg (al[ac], XtNdepth, FRAME_DISPLAY_INFO (f)->n_planes); ac++;
2900 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2901 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2902 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass (), pane_widget,
2903 al, ac);
2905 f->output_data.x->edit_widget = frame_widget;
2907 XtManageChild (frame_widget);
2909 /* Do some needed geometry management. */
2911 Arg gal[3];
2912 int gac = 0;
2913 int extra_borders = 0;
2914 int menubar_size
2915 = (f->output_data.x->menubar_widget
2916 ? (f->output_data.x->menubar_widget->core.height
2917 + f->output_data.x->menubar_widget->core.border_width)
2918 : 0);
2920 #if false /* Experimentally, we now get the right results
2921 for -geometry -0-0 without this. 24 Aug 96, rms. */
2922 if (FRAME_EXTERNAL_MENU_BAR (f))
2924 Dimension ibw = 0;
2925 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2926 menubar_size += ibw;
2928 #endif
2930 FRAME_MENUBAR_HEIGHT (f) = menubar_size;
2932 #ifndef USE_LUCID
2933 /* Motif seems to need this amount added to the sizes
2934 specified for the shell widget. The Athena/Lucid widgets don't.
2935 Both conclusions reached experimentally. -- rms. */
2936 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2937 &extra_borders, NULL);
2938 extra_borders *= 2;
2939 #endif
2941 f->shell_position = xmalloc (sizeof "=x++" + 4 * INT_STRLEN_BOUND (int));
2943 /* Convert our geometry parameters into a geometry string
2944 and specify it.
2945 Note that we do not specify here whether the position
2946 is a user-specified or program-specified one.
2947 We pass that information later, in x_wm_set_size_hint. */
2949 int left = f->left_pos;
2950 bool xneg = (window_prompting & XNegative) != 0;
2951 int top = f->top_pos;
2952 bool yneg = (window_prompting & YNegative) != 0;
2953 if (xneg)
2954 left = -left;
2955 if (yneg)
2956 top = -top;
2958 if (window_prompting & USPosition)
2959 sprintf (f->shell_position, "=%dx%d%c%d%c%d",
2960 FRAME_PIXEL_WIDTH (f) + extra_borders,
2961 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2962 (xneg ? '-' : '+'), left,
2963 (yneg ? '-' : '+'), top);
2964 else
2966 sprintf (f->shell_position, "=%dx%d",
2967 FRAME_PIXEL_WIDTH (f) + extra_borders,
2968 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2970 /* Setting x and y when the position is not specified in
2971 the geometry string will set program position in the WM hints.
2972 If Emacs had just one program position, we could set it in
2973 fallback resources, but since each make-frame call can specify
2974 different program positions, this is easier. */
2975 XtSetArg (gal[gac], XtNx, left); gac++;
2976 XtSetArg (gal[gac], XtNy, top); gac++;
2980 XtSetArg (gal[gac], XtNgeometry, f->shell_position); gac++;
2981 XtSetValues (shell_widget, gal, gac);
2984 XtManageChild (pane_widget);
2985 XtRealizeWidget (shell_widget);
2987 if (FRAME_X_EMBEDDED_P (f))
2988 XReparentWindow (FRAME_X_DISPLAY (f), XtWindow (shell_widget),
2989 f->output_data.x->parent_desc, 0, 0);
2991 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2992 initial_set_up_x_back_buffer (f);
2993 validate_x_resource_name ();
2995 class_hints.res_name = SSDATA (Vx_resource_name);
2996 class_hints.res_class = SSDATA (Vx_resource_class);
2997 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2999 #ifdef HAVE_X_I18N
3000 FRAME_XIC (f) = NULL;
3001 if (use_xim)
3002 create_frame_xic (f);
3003 #endif
3005 f->output_data.x->wm_hints.input = True;
3006 f->output_data.x->wm_hints.flags |= InputHint;
3007 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3008 &f->output_data.x->wm_hints);
3010 hack_wm_protocols (f, shell_widget);
3012 #ifdef X_TOOLKIT_EDITRES
3013 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
3014 #endif
3016 /* Do a stupid property change to force the server to generate a
3017 PropertyNotify event so that the event_stream server timestamp will
3018 be initialized to something relevant to the time we created the window.
3020 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
3021 FRAME_DISPLAY_INFO (f)->Xatom_wm_protocols,
3022 XA_ATOM, 32, PropModeAppend, NULL, 0);
3024 /* Make all the standard events reach the Emacs frame. */
3025 attributes.event_mask = STANDARD_EVENT_SET;
3027 #ifdef HAVE_X_I18N
3028 if (FRAME_XIC (f))
3030 /* XIM server might require some X events. */
3031 unsigned long fevent = NoEventMask;
3032 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3033 attributes.event_mask |= fevent;
3035 #endif /* HAVE_X_I18N */
3037 attributes.override_redirect = FRAME_OVERRIDE_REDIRECT (f);
3038 attribute_mask = CWEventMask | CWOverrideRedirect;
3039 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
3040 attribute_mask, &attributes);
3042 XtMapWidget (frame_widget);
3044 /* x_set_name normally ignores requests to set the name if the
3045 requested name is the same as the current name. This is the one
3046 place where that assumption isn't correct; f->name is set, but
3047 the X server hasn't been told. */
3049 Lisp_Object name;
3050 bool explicit = f->explicit_name;
3052 f->explicit_name = false;
3053 name = f->name;
3054 fset_name (f, Qnil);
3055 x_set_name (f, name, explicit);
3058 if (FRAME_UNDECORATED (f))
3060 Display *dpy = FRAME_X_DISPLAY (f);
3061 PropMotifWmHints hints;
3062 Atom prop = XInternAtom (dpy, "_MOTIF_WM_HINTS", False);
3064 memset (&hints, 0, sizeof(hints));
3065 hints.flags = MWM_HINTS_DECORATIONS;
3066 hints.decorations = 0;
3068 /* For some reason the third and fourth arguments in the following
3069 call must be identical: In the corresponding XGetWindowProperty
3070 call in getMotifHints, xfwm has the third and seventh args both
3071 display_info->atoms[MOTIF_WM_HINTS]. Obviously, YMMV. */
3072 XChangeProperty (dpy, FRAME_OUTER_WINDOW (f), prop, prop, 32,
3073 PropModeReplace, (unsigned char *) &hints,
3074 PROP_MOTIF_WM_HINTS_ELEMENTS);
3077 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3078 f->output_data.x->current_cursor
3079 = f->output_data.x->text_cursor);
3081 unblock_input ();
3083 /* This is a no-op, except under Motif. Make sure main areas are
3084 set to something reasonable, in case we get an error later. */
3085 lw_set_main_areas (pane_widget, 0, frame_widget);
3088 #else /* not USE_X_TOOLKIT */
3089 #ifdef USE_GTK
3090 static void
3091 x_window (struct frame *f)
3093 if (! xg_create_frame_widgets (f))
3094 error ("Unable to create window");
3096 #ifdef HAVE_X_I18N
3097 FRAME_XIC (f) = NULL;
3098 if (use_xim)
3100 block_input ();
3101 create_frame_xic (f);
3102 if (FRAME_XIC (f))
3104 /* XIM server might require some X events. */
3105 unsigned long fevent = NoEventMask;
3106 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3108 if (fevent != NoEventMask)
3110 XSetWindowAttributes attributes;
3111 XWindowAttributes wattr;
3112 unsigned long attribute_mask;
3114 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3115 &wattr);
3116 attributes.event_mask = wattr.your_event_mask | fevent;
3117 attribute_mask = CWEventMask;
3118 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3119 attribute_mask, &attributes);
3122 unblock_input ();
3124 #endif
3127 #else /*! USE_GTK */
3128 /* Create and set up the X window for frame F. */
3130 static void
3131 x_window (struct frame *f)
3133 XClassHint class_hints;
3134 XSetWindowAttributes attributes;
3135 unsigned long attribute_mask;
3137 attributes.background_pixel = FRAME_BACKGROUND_PIXEL (f);
3138 attributes.border_pixel = f->output_data.x->border_pixel;
3139 attributes.bit_gravity = StaticGravity;
3140 attributes.backing_store = NotUseful;
3141 attributes.save_under = True;
3142 attributes.event_mask = STANDARD_EVENT_SET;
3143 attributes.colormap = FRAME_X_COLORMAP (f);
3144 attributes.override_redirect = FRAME_OVERRIDE_REDIRECT (f);
3145 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
3146 | CWOverrideRedirect | CWColormap);
3148 block_input ();
3149 FRAME_X_WINDOW (f)
3150 = XCreateWindow (FRAME_X_DISPLAY (f),
3151 f->output_data.x->parent_desc,
3152 f->left_pos,
3153 f->top_pos,
3154 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
3155 f->border_width,
3156 CopyFromParent, /* depth */
3157 InputOutput, /* class */
3158 FRAME_X_VISUAL (f),
3159 attribute_mask, &attributes);
3160 initial_set_up_x_back_buffer (f);
3162 #ifdef HAVE_X_I18N
3163 if (use_xim)
3165 create_frame_xic (f);
3166 if (FRAME_XIC (f))
3168 /* XIM server might require some X events. */
3169 unsigned long fevent = NoEventMask;
3170 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3171 attributes.event_mask |= fevent;
3172 attribute_mask = CWEventMask;
3173 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3174 attribute_mask, &attributes);
3177 #endif /* HAVE_X_I18N */
3179 validate_x_resource_name ();
3181 class_hints.res_name = SSDATA (Vx_resource_name);
3182 class_hints.res_class = SSDATA (Vx_resource_class);
3183 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
3185 /* This indicates that we use the "Passive Input" input model.
3186 Unless we do this, we don't get the Focus{In,Out} events that we
3187 need to draw the cursor correctly. Accursed bureaucrats.
3188 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
3190 f->output_data.x->wm_hints.input = True;
3191 f->output_data.x->wm_hints.flags |= InputHint;
3192 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3193 &f->output_data.x->wm_hints);
3194 f->output_data.x->wm_hints.icon_pixmap = None;
3196 /* Request "save yourself" and "delete window" commands from wm. */
3198 Atom protocols[2];
3199 protocols[0] = FRAME_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3200 protocols[1] = FRAME_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3201 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
3204 /* x_set_name normally ignores requests to set the name if the
3205 requested name is the same as the current name. This is the one
3206 place where that assumption isn't correct; f->name is set, but
3207 the X server hasn't been told. */
3209 Lisp_Object name;
3210 bool explicit = f->explicit_name;
3212 f->explicit_name = false;
3213 name = f->name;
3214 fset_name (f, Qnil);
3215 x_set_name (f, name, explicit);
3218 if (FRAME_UNDECORATED (f))
3220 Display *dpy = FRAME_X_DISPLAY (f);
3221 PropMotifWmHints hints;
3222 Atom prop = XInternAtom (dpy, "_MOTIF_WM_HINTS", False);
3224 memset (&hints, 0, sizeof(hints));
3225 hints.flags = MWM_HINTS_DECORATIONS;
3226 hints.decorations = 0;
3228 /* For some reason the third and fourth arguments in the following
3229 call must be identical: In the corresponding XGetWindowProperty
3230 call in getMotifHints, xfwm has the third and seventh args both
3231 display_info->atoms[MOTIF_WM_HINTS]. Obviously, YMMV. */
3232 XChangeProperty (dpy, FRAME_OUTER_WINDOW (f), prop, prop, 32,
3233 PropModeReplace, (unsigned char *) &hints,
3234 PROP_MOTIF_WM_HINTS_ELEMENTS);
3238 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3239 f->output_data.x->current_cursor
3240 = f->output_data.x->text_cursor);
3242 unblock_input ();
3244 if (FRAME_X_WINDOW (f) == 0)
3245 error ("Unable to create window");
3248 #endif /* not USE_GTK */
3249 #endif /* not USE_X_TOOLKIT */
3251 /* Verify that the icon position args for this window are valid. */
3253 static void
3254 x_icon_verify (struct frame *f, Lisp_Object parms)
3256 Lisp_Object icon_x, icon_y;
3258 /* Set the position of the icon. Note that twm groups all
3259 icons in an icon window. */
3260 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
3261 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
3262 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
3264 CHECK_NUMBER (icon_x);
3265 CHECK_NUMBER (icon_y);
3267 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
3268 error ("Both left and top icon corners of icon must be specified");
3271 /* Handle the icon stuff for this window. Perhaps later we might
3272 want an x_set_icon_position which can be called interactively as
3273 well. */
3275 static void
3276 x_icon (struct frame *f, Lisp_Object parms)
3278 /* Set the position of the icon. Note that twm groups all
3279 icons in an icon window. */
3280 Lisp_Object icon_x
3281 = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
3282 Lisp_Object icon_y
3283 = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
3284 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
3286 CHECK_TYPE_RANGED_INTEGER (int, icon_x);
3287 CHECK_TYPE_RANGED_INTEGER (int, icon_y);
3289 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
3290 error ("Both left and top icon corners of icon must be specified");
3292 block_input ();
3294 if (! EQ (icon_x, Qunbound))
3295 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
3297 #if false /* x_get_arg removes the visibility parameter as a side effect,
3298 but x_create_frame still needs it. */
3299 /* Start up iconic or window? */
3300 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
3301 x_wm_set_window_state
3302 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
3303 Qicon)
3304 ? IconicState
3305 : NormalState));
3306 #endif
3308 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
3309 ? f->icon_name
3310 : f->name)));
3312 unblock_input ();
3315 /* Make the GCs needed for this window, setting the
3316 background, border and mouse colors; also create the
3317 mouse cursor and the gray border tile. */
3319 static void
3320 x_make_gc (struct frame *f)
3322 XGCValues gc_values;
3324 block_input ();
3326 /* Create the GCs of this frame.
3327 Note that many default values are used. */
3329 gc_values.foreground = FRAME_FOREGROUND_PIXEL (f);
3330 gc_values.background = FRAME_BACKGROUND_PIXEL (f);
3331 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
3332 f->output_data.x->normal_gc
3333 = XCreateGC (FRAME_X_DISPLAY (f),
3334 FRAME_X_DRAWABLE (f),
3335 GCLineWidth | GCForeground | GCBackground,
3336 &gc_values);
3338 /* Reverse video style. */
3339 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
3340 gc_values.background = FRAME_FOREGROUND_PIXEL (f);
3341 f->output_data.x->reverse_gc
3342 = XCreateGC (FRAME_X_DISPLAY (f),
3343 FRAME_X_DRAWABLE (f),
3344 GCForeground | GCBackground | GCLineWidth,
3345 &gc_values);
3347 /* Cursor has cursor-color background, background-color foreground. */
3348 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
3349 gc_values.background = f->output_data.x->cursor_pixel;
3350 gc_values.fill_style = FillOpaqueStippled;
3351 f->output_data.x->cursor_gc
3352 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_DRAWABLE (f),
3353 (GCForeground | GCBackground
3354 | GCFillStyle | GCLineWidth),
3355 &gc_values);
3357 /* Create the gray border tile used when the pointer is not in
3358 the frame. Since this depends on the frame's pixel values,
3359 this must be done on a per-frame basis. */
3360 f->output_data.x->border_tile
3361 = (XCreatePixmapFromBitmapData
3362 (FRAME_X_DISPLAY (f), FRAME_DISPLAY_INFO (f)->root_window,
3363 gray_bits, gray_width, gray_height,
3364 FRAME_FOREGROUND_PIXEL (f),
3365 FRAME_BACKGROUND_PIXEL (f),
3366 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
3368 unblock_input ();
3372 /* Free what was allocated in x_make_gc. */
3374 void
3375 x_free_gcs (struct frame *f)
3377 Display *dpy = FRAME_X_DISPLAY (f);
3379 block_input ();
3381 if (f->output_data.x->normal_gc)
3383 XFreeGC (dpy, f->output_data.x->normal_gc);
3384 f->output_data.x->normal_gc = 0;
3387 if (f->output_data.x->reverse_gc)
3389 XFreeGC (dpy, f->output_data.x->reverse_gc);
3390 f->output_data.x->reverse_gc = 0;
3393 if (f->output_data.x->cursor_gc)
3395 XFreeGC (dpy, f->output_data.x->cursor_gc);
3396 f->output_data.x->cursor_gc = 0;
3399 if (f->output_data.x->border_tile)
3401 XFreePixmap (dpy, f->output_data.x->border_tile);
3402 f->output_data.x->border_tile = 0;
3405 unblock_input ();
3409 /* Handler for signals raised during x_create_frame and
3410 x_create_tip_frame. FRAME is the frame which is partially
3411 constructed. */
3413 static Lisp_Object
3414 unwind_create_frame (Lisp_Object frame)
3416 struct frame *f = XFRAME (frame);
3418 /* If frame is already dead, nothing to do. This can happen if the
3419 display is disconnected after the frame has become official, but
3420 before x_create_frame removes the unwind protect. */
3421 if (!FRAME_LIVE_P (f))
3422 return Qnil;
3424 /* If frame is ``official'', nothing to do. */
3425 if (NILP (Fmemq (frame, Vframe_list)))
3427 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
3428 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
3429 #endif
3431 /* If the frame's image cache refcount is still the same as our
3432 private shadow variable, it means we are unwinding a frame
3433 for which we didn't yet call init_frame_faces, where the
3434 refcount is incremented. Therefore, we increment it here, so
3435 that free_frame_faces, called in x_free_frame_resources
3436 below, will not mistakenly decrement the counter that was not
3437 incremented yet to account for this new frame. */
3438 if (FRAME_IMAGE_CACHE (f) != NULL
3439 && FRAME_IMAGE_CACHE (f)->refcount == image_cache_refcount)
3440 FRAME_IMAGE_CACHE (f)->refcount++;
3442 x_free_frame_resources (f);
3443 free_glyphs (f);
3445 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
3446 /* Check that reference counts are indeed correct. */
3447 eassert (dpyinfo->reference_count == dpyinfo_refcount);
3448 eassert (dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
3449 #endif
3450 return Qt;
3453 return Qnil;
3456 static void
3457 do_unwind_create_frame (Lisp_Object frame)
3459 unwind_create_frame (frame);
3462 static void
3463 x_default_font_parameter (struct frame *f, Lisp_Object parms)
3465 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
3466 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
3467 RES_TYPE_STRING);
3468 Lisp_Object font = Qnil;
3469 if (EQ (font_param, Qunbound))
3470 font_param = Qnil;
3472 if (NILP (font_param))
3474 /* System font should take precedence over X resources. We suggest this
3475 regardless of font-use-system-font because .emacs may not have been
3476 read yet. */
3477 const char *system_font = xsettings_get_system_font ();
3478 if (system_font)
3479 font = font_open_by_name (f, build_unibyte_string (system_font));
3482 if (NILP (font))
3483 font = !NILP (font_param) ? font_param
3484 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
3486 if (! FONTP (font) && ! STRINGP (font))
3488 const char *names[]
3490 #ifdef HAVE_XFT
3491 /* This will find the normal Xft font. */
3492 "monospace-10",
3493 #endif
3494 "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1",
3495 "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
3496 "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
3497 /* This was formerly the first thing tried, but it finds
3498 too many fonts and takes too long. */
3499 "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1",
3500 /* If those didn't work, look for something which will
3501 at least work. */
3502 "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1",
3503 "fixed",
3504 NULL };
3505 int i;
3507 for (i = 0; names[i]; i++)
3509 font = font_open_by_name (f, build_unibyte_string (names[i]));
3510 if (! NILP (font))
3511 break;
3513 if (NILP (font))
3514 error ("No suitable font was found");
3516 else if (!NILP (font_param))
3518 /* Remember the explicit font parameter, so we can re-apply it after
3519 we've applied the `default' face settings. */
3520 AUTO_FRAME_ARG (arg, Qfont_parameter, font_param);
3521 x_set_frame_parameters (f, arg);
3524 /* This call will make X resources override any system font setting. */
3525 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
3529 DEFUN ("x-wm-set-size-hint", Fx_wm_set_size_hint, Sx_wm_set_size_hint,
3530 0, 1, 0,
3531 doc: /* Send the size hints for frame FRAME to the window manager.
3532 If FRAME is omitted or nil, use the selected frame.
3533 Signal error if FRAME is not an X frame. */)
3534 (Lisp_Object frame)
3536 struct frame *f = decode_window_system_frame (frame);
3538 block_input ();
3539 x_wm_set_size_hint (f, 0, false);
3540 unblock_input ();
3541 return Qnil;
3544 static void
3545 set_machine_and_pid_properties (struct frame *f)
3547 /* This will set WM_CLIENT_MACHINE and WM_LOCALE_NAME. */
3548 XSetWMProperties (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), NULL, NULL,
3549 NULL, 0, NULL, NULL, NULL);
3550 pid_t pid = getpid ();
3551 if (pid <= 0xffffffffu)
3553 unsigned long xpid = pid;
3554 XChangeProperty (FRAME_X_DISPLAY (f),
3555 FRAME_OUTER_WINDOW (f),
3556 XInternAtom (FRAME_X_DISPLAY (f),
3557 "_NET_WM_PID",
3558 False),
3559 XA_CARDINAL, 32, PropModeReplace,
3560 (unsigned char *) &xpid, 1);
3564 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
3565 1, 1, 0,
3566 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
3567 Return an Emacs frame object. PARMS is an alist of frame parameters.
3568 If the parameters specify that the frame should not have a minibuffer,
3569 and do not specify a specific minibuffer window to use, then
3570 `default-minibuffer-frame' must be a frame whose minibuffer can be
3571 shared by the new frame.
3573 This function is an internal primitive--use `make-frame' instead. */)
3574 (Lisp_Object parms)
3576 struct frame *f;
3577 Lisp_Object frame, tem;
3578 Lisp_Object name;
3579 bool minibuffer_only = false;
3580 bool undecorated = false, override_redirect = false;
3581 long window_prompting = 0;
3582 ptrdiff_t count = SPECPDL_INDEX ();
3583 Lisp_Object display;
3584 struct x_display_info *dpyinfo = NULL;
3585 Lisp_Object parent, parent_frame;
3586 struct kboard *kb;
3587 int x_width = 0, x_height = 0;
3589 parms = Fcopy_alist (parms);
3591 /* Use this general default value to start with
3592 until we know if this frame has a specified name. */
3593 Vx_resource_name = Vinvocation_name;
3595 display = x_get_arg (dpyinfo, parms, Qterminal, 0, 0, RES_TYPE_NUMBER);
3596 if (EQ (display, Qunbound))
3597 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3598 if (EQ (display, Qunbound))
3599 display = Qnil;
3600 dpyinfo = check_x_display_info (display);
3601 kb = dpyinfo->terminal->kboard;
3603 if (!dpyinfo->terminal->name)
3604 error ("Terminal is not live, can't create new frames on it");
3606 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3607 if (!STRINGP (name)
3608 && ! EQ (name, Qunbound)
3609 && ! NILP (name))
3610 error ("Invalid frame name--not a string or nil");
3612 if (STRINGP (name))
3613 Vx_resource_name = name;
3615 /* See if parent window is specified. */
3616 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3617 if (EQ (parent, Qunbound))
3618 parent = Qnil;
3619 if (! NILP (parent))
3620 CHECK_NUMBER (parent);
3622 frame = Qnil;
3623 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3624 RES_TYPE_SYMBOL);
3625 if (EQ (tem, Qnone) || NILP (tem))
3626 f = make_frame_without_minibuffer (Qnil, kb, display);
3627 else if (EQ (tem, Qonly))
3629 f = make_minibuffer_frame ();
3630 minibuffer_only = true;
3632 else if (WINDOWP (tem))
3633 f = make_frame_without_minibuffer (tem, kb, display);
3634 else
3635 f = make_frame (true);
3637 parent_frame = x_get_arg (dpyinfo, parms, Qparent_frame, NULL, NULL,
3638 RES_TYPE_SYMBOL);
3639 /* Accept parent-frame iff parent-id was not specified. */
3640 if (!NILP (parent)
3641 || EQ (parent_frame, Qunbound)
3642 || NILP (parent_frame)
3643 || !FRAMEP (parent_frame)
3644 || !FRAME_LIVE_P (XFRAME (parent_frame))
3645 || !FRAME_X_P (XFRAME (parent_frame)))
3646 parent_frame = Qnil;
3648 fset_parent_frame (f, parent_frame);
3649 store_frame_param (f, Qparent_frame, parent_frame);
3651 if (!NILP (tem = (x_get_arg (dpyinfo, parms, Qundecorated, NULL, NULL,
3652 RES_TYPE_BOOLEAN)))
3653 && !(EQ (tem, Qunbound)))
3654 undecorated = true;
3656 FRAME_UNDECORATED (f) = undecorated;
3657 store_frame_param (f, Qundecorated, undecorated ? Qt : Qnil);
3659 if (!NILP (tem = (x_get_arg (dpyinfo, parms, Qoverride_redirect, NULL, NULL,
3660 RES_TYPE_BOOLEAN)))
3661 && !(EQ (tem, Qunbound)))
3662 override_redirect = true;
3664 FRAME_OVERRIDE_REDIRECT (f) = override_redirect;
3665 store_frame_param (f, Qoverride_redirect, override_redirect ? Qt : Qnil);
3667 XSETFRAME (frame, f);
3669 f->terminal = dpyinfo->terminal;
3671 f->output_method = output_x_window;
3672 f->output_data.x = xzalloc (sizeof *f->output_data.x);
3673 f->output_data.x->icon_bitmap = -1;
3674 FRAME_FONTSET (f) = -1;
3675 f->output_data.x->scroll_bar_foreground_pixel = -1;
3676 f->output_data.x->scroll_bar_background_pixel = -1;
3677 #if defined (USE_LUCID) && defined (USE_TOOLKIT_SCROLL_BARS)
3678 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3679 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3680 #endif /* USE_LUCID && USE_TOOLKIT_SCROLL_BARS */
3681 f->output_data.x->white_relief.pixel = -1;
3682 f->output_data.x->black_relief.pixel = -1;
3684 fset_icon_name (f,
3685 x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3686 RES_TYPE_STRING));
3687 if (! STRINGP (f->icon_name))
3688 fset_icon_name (f, Qnil);
3690 FRAME_DISPLAY_INFO (f) = dpyinfo;
3692 /* With FRAME_DISPLAY_INFO set up, this unwind-protect is safe. */
3693 record_unwind_protect (do_unwind_create_frame, frame);
3695 /* These colors will be set anyway later, but it's important
3696 to get the color reference counts right, so initialize them! */
3698 Lisp_Object black;
3700 /* Function x_decode_color can signal an error. Make
3701 sure to initialize color slots so that we won't try
3702 to free colors we haven't allocated. */
3703 FRAME_FOREGROUND_PIXEL (f) = -1;
3704 FRAME_BACKGROUND_PIXEL (f) = -1;
3705 f->output_data.x->cursor_pixel = -1;
3706 f->output_data.x->cursor_foreground_pixel = -1;
3707 f->output_data.x->border_pixel = -1;
3708 f->output_data.x->mouse_pixel = -1;
3710 black = build_string ("black");
3711 FRAME_FOREGROUND_PIXEL (f)
3712 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3713 FRAME_BACKGROUND_PIXEL (f)
3714 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3715 f->output_data.x->cursor_pixel
3716 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3717 f->output_data.x->cursor_foreground_pixel
3718 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3719 f->output_data.x->border_pixel
3720 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3721 f->output_data.x->mouse_pixel
3722 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3725 /* Specify the parent under which to make this X window. */
3726 if (!NILP (parent))
3728 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3729 f->output_data.x->explicit_parent = true;
3731 else
3733 f->output_data.x->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
3734 f->output_data.x->explicit_parent = false;
3737 /* Set the name; the functions to which we pass f expect the name to
3738 be set. */
3739 if (EQ (name, Qunbound) || NILP (name))
3741 fset_name (f, build_string (dpyinfo->x_id_name));
3742 f->explicit_name = false;
3744 else
3746 fset_name (f, name);
3747 f->explicit_name = true;
3748 /* Use the frame's title when getting resources for this frame. */
3749 specbind (Qx_resource_name, name);
3752 #ifdef USE_CAIRO
3753 register_font_driver (&ftcrfont_driver, f);
3754 #else
3755 #ifdef HAVE_FREETYPE
3756 #ifdef HAVE_XFT
3757 register_font_driver (&xftfont_driver, f);
3758 #else /* not HAVE_XFT */
3759 register_font_driver (&ftxfont_driver, f);
3760 #endif /* not HAVE_XFT */
3761 #endif /* HAVE_FREETYPE */
3762 register_font_driver (&xfont_driver, f);
3763 #endif /* not USE_CAIRO */
3765 image_cache_refcount =
3766 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
3767 #ifdef GLYPH_DEBUG
3768 dpyinfo_refcount = dpyinfo->reference_count;
3769 #endif /* GLYPH_DEBUG */
3771 x_default_parameter (f, parms, Qfont_backend, Qnil,
3772 "fontBackend", "FontBackend", RES_TYPE_STRING);
3774 /* Extract the window parameters from the supplied values
3775 that are needed to determine window geometry. */
3776 x_default_font_parameter (f, parms);
3777 if (!FRAME_FONT (f))
3779 delete_frame (frame, Qnoelisp);
3780 error ("Invalid frame font");
3783 /* Frame contents get displaced if an embedded X window has a border. */
3784 if (! FRAME_X_EMBEDDED_P (f))
3785 x_default_parameter (f, parms, Qborder_width, make_number (0),
3786 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3788 /* This defaults to 1 in order to match xterm. We recognize either
3789 internalBorderWidth or internalBorder (which is what xterm calls
3790 it). */
3791 if (NILP (Fassq (Qinternal_border_width, parms)))
3793 Lisp_Object value;
3795 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3796 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3797 if (! EQ (value, Qunbound))
3798 parms = Fcons (Fcons (Qinternal_border_width, value),
3799 parms);
3801 x_default_parameter (f, parms, Qinternal_border_width,
3802 #ifdef USE_GTK /* We used to impose 0 in xg_create_frame_widgets. */
3803 make_number (0),
3804 #else
3805 make_number (1),
3806 #endif
3807 "internalBorderWidth", "internalBorderWidth",
3808 RES_TYPE_NUMBER);
3809 x_default_parameter (f, parms, Qright_divider_width, make_number (0),
3810 NULL, NULL, RES_TYPE_NUMBER);
3811 x_default_parameter (f, parms, Qbottom_divider_width, make_number (0),
3812 NULL, NULL, RES_TYPE_NUMBER);
3813 x_default_parameter (f, parms, Qvertical_scroll_bars,
3814 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3815 Qright,
3816 #else
3817 Qleft,
3818 #endif
3819 "verticalScrollBars", "ScrollBars",
3820 RES_TYPE_SYMBOL);
3821 x_default_parameter (f, parms, Qhorizontal_scroll_bars, Qnil,
3822 "horizontalScrollBars", "ScrollBars",
3823 RES_TYPE_SYMBOL);
3824 /* Also do the stuff which must be set before the window exists. */
3825 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3826 "foreground", "Foreground", RES_TYPE_STRING);
3827 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3828 "background", "Background", RES_TYPE_STRING);
3829 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3830 "pointerColor", "Foreground", RES_TYPE_STRING);
3831 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3832 "borderColor", "BorderColor", RES_TYPE_STRING);
3833 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3834 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3835 x_default_parameter (f, parms, Qline_spacing, Qnil,
3836 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3837 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3838 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3839 x_default_parameter (f, parms, Qright_fringe, Qnil,
3840 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3841 x_default_parameter (f, parms, Qno_special_glyphs, Qnil,
3842 NULL, NULL, RES_TYPE_BOOLEAN);
3844 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3845 "scrollBarForeground",
3846 "ScrollBarForeground", true);
3847 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3848 "scrollBarBackground",
3849 "ScrollBarBackground", false);
3851 /* Init faces before x_default_parameter is called for the
3852 scroll-bar-width parameter because otherwise we end up in
3853 init_iterator with a null face cache, which should not happen. */
3854 init_frame_faces (f);
3856 /* We have to call adjust_frame_size here since otherwise
3857 x_set_tool_bar_lines will already work with the character sizes
3858 installed by init_frame_faces while the frame's pixel size is still
3859 calculated from a character size of 1 and we subsequently hit the
3860 (height >= 0) assertion in window_box_height.
3862 The non-pixelwise code apparently worked around this because it
3863 had one frame line vs one toolbar line which left us with a zero
3864 root window height which was obviously wrong as well ...
3866 Also process `min-width' and `min-height' parameters right here
3867 because `frame-windows-min-size' needs them. */
3868 tem = x_get_arg (dpyinfo, parms, Qmin_width, NULL, NULL, RES_TYPE_NUMBER);
3869 if (NUMBERP (tem))
3870 store_frame_param (f, Qmin_width, tem);
3871 tem = x_get_arg (dpyinfo, parms, Qmin_height, NULL, NULL, RES_TYPE_NUMBER);
3872 if (NUMBERP (tem))
3873 store_frame_param (f, Qmin_height, tem);
3874 adjust_frame_size (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
3875 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 5, true,
3876 Qx_create_frame_1);
3878 /* Set the menu-bar-lines and tool-bar-lines parameters. We don't
3879 look up the X resources controlling the menu-bar and tool-bar
3880 here; they are processed specially at startup, and reflected in
3881 the values of the mode variables. */
3883 x_default_parameter (f, parms, Qmenu_bar_lines,
3884 NILP (Vmenu_bar_mode)
3885 ? make_number (0) : make_number (1),
3886 NULL, NULL, RES_TYPE_NUMBER);
3887 x_default_parameter (f, parms, Qtool_bar_lines,
3888 NILP (Vtool_bar_mode)
3889 ? make_number (0) : make_number (1),
3890 NULL, NULL, RES_TYPE_NUMBER);
3892 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3893 "bufferPredicate", "BufferPredicate",
3894 RES_TYPE_SYMBOL);
3895 x_default_parameter (f, parms, Qtitle, Qnil,
3896 "title", "Title", RES_TYPE_STRING);
3897 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3898 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3899 x_default_parameter (f, parms, Qtool_bar_position,
3900 FRAME_TOOL_BAR_POSITION (f), 0, 0, RES_TYPE_SYMBOL);
3901 x_default_parameter (f, parms, Qinhibit_double_buffering, Qnil,
3902 "inhibitDoubleBuffering", "InhibitDoubleBuffering",
3903 RES_TYPE_BOOLEAN);
3905 /* Compute the size of the X window. */
3906 window_prompting = x_figure_window_size (f, parms, true, &x_width, &x_height);
3908 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3909 f->no_split = minibuffer_only || EQ (tem, Qt);
3911 x_icon_verify (f, parms);
3913 /* Create the X widget or window. */
3914 #ifdef USE_X_TOOLKIT
3915 x_window (f, window_prompting);
3916 #else
3917 x_window (f);
3918 #endif
3920 x_icon (f, parms);
3921 x_make_gc (f);
3923 /* Now consider the frame official. */
3924 f->terminal->reference_count++;
3925 FRAME_DISPLAY_INFO (f)->reference_count++;
3926 Vframe_list = Fcons (frame, Vframe_list);
3928 /* We need to do this after creating the X window, so that the
3929 icon-creation functions can say whose icon they're describing. */
3930 x_default_parameter (f, parms, Qicon_type, Qt,
3931 "bitmapIcon", "BitmapIcon", RES_TYPE_BOOLEAN);
3933 x_default_parameter (f, parms, Qauto_raise, Qnil,
3934 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3935 x_default_parameter (f, parms, Qauto_lower, Qnil,
3936 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3937 x_default_parameter (f, parms, Qcursor_type, Qbox,
3938 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3939 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3940 "scrollBarWidth", "ScrollBarWidth",
3941 RES_TYPE_NUMBER);
3942 x_default_parameter (f, parms, Qscroll_bar_height, Qnil,
3943 "scrollBarHeight", "ScrollBarHeight",
3944 RES_TYPE_NUMBER);
3945 x_default_parameter (f, parms, Qalpha, Qnil,
3946 "alpha", "Alpha", RES_TYPE_NUMBER);
3948 if (!NILP (parent_frame))
3950 struct frame *p = XFRAME (parent_frame);
3952 block_input ();
3953 XReparentWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
3954 FRAME_X_WINDOW (p), f->left_pos, f->top_pos);
3955 unblock_input ();
3958 x_default_parameter (f, parms, Qno_focus_on_map, Qnil,
3959 NULL, NULL, RES_TYPE_BOOLEAN);
3960 x_default_parameter (f, parms, Qno_accept_focus, Qnil,
3961 NULL, NULL, RES_TYPE_BOOLEAN);
3963 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3964 /* Create the menu bar. */
3965 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3967 /* If this signals an error, we haven't set size hints for the
3968 frame and we didn't make it visible. */
3969 initialize_frame_menubar (f);
3971 #ifndef USE_GTK
3972 /* This is a no-op, except under Motif where it arranges the
3973 main window for the widgets on it. */
3974 lw_set_main_areas (f->output_data.x->column_widget,
3975 f->output_data.x->menubar_widget,
3976 f->output_data.x->edit_widget);
3977 #endif /* not USE_GTK */
3979 #endif /* USE_X_TOOLKIT || USE_GTK */
3981 /* Consider frame official, now. */
3982 f->can_x_set_window_size = true;
3984 if (x_width > 0)
3985 SET_FRAME_WIDTH (f, x_width);
3986 if (x_height > 0)
3987 SET_FRAME_HEIGHT (f, x_height);
3989 /* Tell the server what size and position, etc, we want, and how
3990 badly we want them. This should be done after we have the menu
3991 bar so that its size can be taken into account. */
3992 block_input ();
3993 x_wm_set_size_hint (f, window_prompting, false);
3994 unblock_input ();
3996 adjust_frame_size (f, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (f),
3997 0, true, Qx_create_frame_2);
3999 /* Process fullscreen parameter here in the hope that normalizing a
4000 fullheight/fullwidth frame will produce the size set by the last
4001 adjust_frame_size call. */
4002 x_default_parameter (f, parms, Qfullscreen, Qnil,
4003 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
4005 /* Make the window appear on the frame and enable display, unless
4006 the caller says not to. However, with explicit parent, Emacs
4007 cannot control visibility, so don't try. */
4008 if (!f->output_data.x->explicit_parent)
4010 Lisp_Object visibility
4011 = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL);
4013 if (EQ (visibility, Qicon))
4014 x_iconify_frame (f);
4015 else
4017 if (EQ (visibility, Qunbound))
4018 visibility = Qt;
4020 if (!NILP (visibility))
4021 x_make_frame_visible (f);
4024 store_frame_param (f, Qvisibility, visibility);
4027 block_input ();
4029 /* Set machine name and pid for the purpose of window managers. */
4030 set_machine_and_pid_properties (f);
4032 /* Set the WM leader property. GTK does this itself, so this is not
4033 needed when using GTK. */
4034 if (dpyinfo->client_leader_window != 0)
4036 XChangeProperty (FRAME_X_DISPLAY (f),
4037 FRAME_OUTER_WINDOW (f),
4038 dpyinfo->Xatom_wm_client_leader,
4039 XA_WINDOW, 32, PropModeReplace,
4040 (unsigned char *) &dpyinfo->client_leader_window, 1);
4043 unblock_input ();
4045 /* Works iff frame has been already mapped. */
4046 x_default_parameter (f, parms, Qskip_taskbar, Qnil,
4047 NULL, NULL, RES_TYPE_BOOLEAN);
4048 /* The `z-group' parameter works only for visible frames. */
4049 x_default_parameter (f, parms, Qz_group, Qnil,
4050 NULL, NULL, RES_TYPE_SYMBOL);
4052 /* Initialize `default-minibuffer-frame' in case this is the first
4053 frame on this terminal. */
4054 if (FRAME_HAS_MINIBUF_P (f)
4055 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
4056 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
4057 kset_default_minibuffer_frame (kb, frame);
4059 /* All remaining specified parameters, which have not been "used"
4060 by x_get_arg and friends, now go in the misc. alist of the frame. */
4061 for (tem = parms; CONSP (tem); tem = XCDR (tem))
4062 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
4063 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
4065 /* Make sure windows on this frame appear in calls to next-window
4066 and similar functions. */
4067 Vwindow_list = Qnil;
4069 return unbind_to (count, frame);
4073 /* FRAME is used only to get a handle on the X display. We don't pass the
4074 display info directly because we're called from frame.c, which doesn't
4075 know about that structure. */
4077 Lisp_Object
4078 x_get_focus_frame (struct frame *frame)
4080 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
4081 Lisp_Object xfocus;
4082 if (! dpyinfo->x_focus_frame)
4083 return Qnil;
4085 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
4086 return xfocus;
4090 /* In certain situations, when the window manager follows a
4091 click-to-focus policy, there seems to be no way around calling
4092 XSetInputFocus to give another frame the input focus .
4094 In an ideal world, XSetInputFocus should generally be avoided so
4095 that applications don't interfere with the window manager's focus
4096 policy. But I think it's okay to use when it's clearly done
4097 following a user-command. */
4099 void
4100 x_focus_frame (struct frame *f, bool noactivate)
4102 Display *dpy = FRAME_X_DISPLAY (f);
4104 block_input ();
4105 x_catch_errors (dpy);
4107 if (FRAME_X_EMBEDDED_P (f))
4109 /* For Xembedded frames, normally the embedder forwards key
4110 events. See XEmbed Protocol Specification at
4111 http://freedesktop.org/wiki/Specifications/xembed-spec */
4112 xembed_request_focus (f);
4114 else
4116 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4117 RevertToParent, CurrentTime);
4118 if (!noactivate)
4119 x_ewmh_activate_frame (f);
4122 x_uncatch_errors ();
4123 unblock_input ();
4127 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4128 doc: /* Internal function called by `color-defined-p', which see.
4129 \(Note that the Nextstep version of this function ignores FRAME.) */)
4130 (Lisp_Object color, Lisp_Object frame)
4132 XColor foo;
4133 struct frame *f = decode_window_system_frame (frame);
4135 CHECK_STRING (color);
4137 if (x_defined_color (f, SSDATA (color), &foo, false))
4138 return Qt;
4139 else
4140 return Qnil;
4143 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4144 doc: /* Internal function called by `color-values', which see. */)
4145 (Lisp_Object color, Lisp_Object frame)
4147 XColor foo;
4148 struct frame *f = decode_window_system_frame (frame);
4150 CHECK_STRING (color);
4152 if (x_defined_color (f, SSDATA (color), &foo, false))
4153 return list3i (foo.red, foo.green, foo.blue);
4154 else
4155 return Qnil;
4158 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4159 doc: /* Internal function called by `display-color-p', which see. */)
4160 (Lisp_Object terminal)
4162 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4164 if (dpyinfo->n_planes <= 2)
4165 return Qnil;
4167 switch (dpyinfo->visual->class)
4169 case StaticColor:
4170 case PseudoColor:
4171 case TrueColor:
4172 case DirectColor:
4173 return Qt;
4175 default:
4176 return Qnil;
4180 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
4181 0, 1, 0,
4182 doc: /* Return t if the X display supports shades of gray.
4183 Note that color displays do support shades of gray.
4184 The optional argument TERMINAL specifies which display to ask about.
4185 TERMINAL should be a terminal object, a frame or a display name (a string).
4186 If omitted or nil, that stands for the selected frame's display. */)
4187 (Lisp_Object terminal)
4189 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4191 if (dpyinfo->n_planes <= 1)
4192 return Qnil;
4194 switch (dpyinfo->visual->class)
4196 case StaticColor:
4197 case PseudoColor:
4198 case TrueColor:
4199 case DirectColor:
4200 case StaticGray:
4201 case GrayScale:
4202 return Qt;
4204 default:
4205 return Qnil;
4209 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
4210 0, 1, 0,
4211 doc: /* Return the width in pixels of the X display TERMINAL.
4212 The optional argument TERMINAL specifies which display to ask about.
4213 TERMINAL should be a terminal object, a frame or a display name (a string).
4214 If omitted or nil, that stands for the selected frame's display.
4216 On \"multi-monitor\" setups this refers to the pixel width for all
4217 physical monitors associated with TERMINAL. To get information for
4218 each physical monitor, use `display-monitor-attributes-list'. */)
4219 (Lisp_Object terminal)
4221 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4223 return make_number (x_display_pixel_width (dpyinfo));
4226 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4227 Sx_display_pixel_height, 0, 1, 0,
4228 doc: /* Return the height in pixels of the X display TERMINAL.
4229 The optional argument TERMINAL specifies which display to ask about.
4230 TERMINAL should be a terminal object, a frame or a display name (a string).
4231 If omitted or nil, that stands for the selected frame's display.
4233 On \"multi-monitor\" setups this refers to the pixel height for all
4234 physical monitors associated with TERMINAL. To get information for
4235 each physical monitor, use `display-monitor-attributes-list'. */)
4236 (Lisp_Object terminal)
4238 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4240 return make_number (x_display_pixel_height (dpyinfo));
4243 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4244 0, 1, 0,
4245 doc: /* Return the number of bitplanes of the X display TERMINAL.
4246 The optional argument TERMINAL specifies which display to ask about.
4247 TERMINAL should be a terminal object, a frame or a display name (a string).
4248 If omitted or nil, that stands for the selected frame's display. */)
4249 (Lisp_Object terminal)
4251 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4253 return make_number (dpyinfo->n_planes);
4256 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4257 0, 1, 0,
4258 doc: /* Return the number of color cells of the X display TERMINAL.
4259 The optional argument TERMINAL specifies which display to ask about.
4260 TERMINAL should be a terminal object, a frame or a display name (a string).
4261 If omitted or nil, that stands for the selected frame's display. */)
4262 (Lisp_Object terminal)
4264 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4266 int nr_planes = DisplayPlanes (dpyinfo->display,
4267 XScreenNumberOfScreen (dpyinfo->screen));
4269 /* Truncate nr_planes to 24 to avoid integer overflow.
4270 Some displays says 32, but only 24 bits are actually significant.
4271 There are only very few and rare video cards that have more than
4272 24 significant bits. Also 24 bits is more than 16 million colors,
4273 it "should be enough for everyone". */
4274 if (nr_planes > 24) nr_planes = 24;
4276 return make_number (1 << nr_planes);
4279 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4280 Sx_server_max_request_size,
4281 0, 1, 0,
4282 doc: /* Return the maximum request size of the X server of display TERMINAL.
4283 The optional argument TERMINAL specifies which display to ask about.
4284 TERMINAL should be a terminal object, a frame or a display name (a string).
4285 If omitted or nil, that stands for the selected frame's display. */)
4286 (Lisp_Object terminal)
4288 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4290 return make_number (MAXREQUEST (dpyinfo->display));
4293 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4294 doc: /* Return the "vendor ID" string of the GUI software on TERMINAL.
4296 \(Labeling every distributor as a "vendor" embodies the false assumption
4297 that operating systems cannot be developed and distributed noncommercially.)
4298 The optional argument TERMINAL specifies which display to ask about.
4300 For GNU and Unix systems, this queries the X server software; for
4301 MS-Windows, this queries the OS.
4303 TERMINAL should be a terminal object, a frame or a display name (a string).
4304 If omitted or nil, that stands for the selected frame's display. */)
4305 (Lisp_Object terminal)
4307 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4308 const char *vendor = ServerVendor (dpyinfo->display);
4310 if (! vendor) vendor = "";
4311 return build_string (vendor);
4314 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4315 doc: /* Return the version numbers of the GUI software on TERMINAL.
4316 The value is a list of three integers specifying the version of the GUI
4317 software in use.
4319 For GNU and Unix system, the first 2 numbers are the version of the X
4320 Protocol used on TERMINAL and the 3rd number is the distributor-specific
4321 release number. For MS-Windows, the 3 numbers report the version and
4322 the build number of the OS.
4324 See also the function `x-server-vendor'.
4326 The optional argument TERMINAL specifies which display to ask about.
4327 TERMINAL should be a terminal object, a frame or a display name (a string).
4328 If omitted or nil, that stands for the selected frame's display. */)
4329 (Lisp_Object terminal)
4331 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4332 Display *dpy = dpyinfo->display;
4334 return list3i (ProtocolVersion (dpy), ProtocolRevision (dpy),
4335 VendorRelease (dpy));
4338 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4339 doc: /* Return the number of screens on the X server of display TERMINAL.
4340 The optional argument TERMINAL specifies which display to ask about.
4341 TERMINAL should be a terminal object, a frame or a display name (a string).
4342 If omitted or nil, that stands for the selected frame's display. */)
4343 (Lisp_Object terminal)
4345 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4347 return make_number (ScreenCount (dpyinfo->display));
4350 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
4351 doc: /* Return the height in millimeters of the X display TERMINAL.
4352 The optional argument TERMINAL specifies which display to ask about.
4353 TERMINAL should be a terminal object, a frame or a display name (a string).
4354 If omitted or nil, that stands for the selected frame's display.
4356 On \"multi-monitor\" setups this refers to the height in millimeters for
4357 all physical monitors associated with TERMINAL. To get information
4358 for each physical monitor, use `display-monitor-attributes-list'. */)
4359 (Lisp_Object terminal)
4361 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4363 return make_number (HeightMMOfScreen (dpyinfo->screen));
4366 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4367 doc: /* Return the width in millimeters of the X display TERMINAL.
4368 The optional argument TERMINAL specifies which display to ask about.
4369 TERMINAL should be a terminal object, a frame or a display name (a string).
4370 If omitted or nil, that stands for the selected frame's display.
4372 On \"multi-monitor\" setups this refers to the width in millimeters for
4373 all physical monitors associated with TERMINAL. To get information
4374 for each physical monitor, use `display-monitor-attributes-list'. */)
4375 (Lisp_Object terminal)
4377 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4379 return make_number (WidthMMOfScreen (dpyinfo->screen));
4382 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4383 Sx_display_backing_store, 0, 1, 0,
4384 doc: /* Return an indication of whether X display TERMINAL does backing store.
4385 The value may be `always', `when-mapped', or `not-useful'.
4386 The optional argument TERMINAL specifies which display to ask about.
4387 TERMINAL should be a terminal object, a frame or a display name (a string).
4388 If omitted or nil, that stands for the selected frame's display. */)
4389 (Lisp_Object terminal)
4391 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4392 Lisp_Object result;
4394 switch (DoesBackingStore (dpyinfo->screen))
4396 case Always:
4397 result = intern ("always");
4398 break;
4400 case WhenMapped:
4401 result = intern ("when-mapped");
4402 break;
4404 case NotUseful:
4405 result = intern ("not-useful");
4406 break;
4408 default:
4409 error ("Strange value for BackingStore parameter of screen");
4412 return result;
4415 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4416 Sx_display_visual_class, 0, 1, 0,
4417 doc: /* Return the visual class of the X display TERMINAL.
4418 The value is one of the symbols `static-gray', `gray-scale',
4419 `static-color', `pseudo-color', `true-color', or `direct-color'.
4421 The optional argument TERMINAL specifies which display to ask about.
4422 TERMINAL should a terminal object, a frame or a display name (a string).
4423 If omitted or nil, that stands for the selected frame's display. */)
4424 (Lisp_Object terminal)
4426 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4427 Lisp_Object result;
4429 switch (dpyinfo->visual->class)
4431 case StaticGray:
4432 result = intern ("static-gray");
4433 break;
4434 case GrayScale:
4435 result = intern ("gray-scale");
4436 break;
4437 case StaticColor:
4438 result = intern ("static-color");
4439 break;
4440 case PseudoColor:
4441 result = intern ("pseudo-color");
4442 break;
4443 case TrueColor:
4444 result = intern ("true-color");
4445 break;
4446 case DirectColor:
4447 result = intern ("direct-color");
4448 break;
4449 default:
4450 error ("Display has an unknown visual class");
4453 return result;
4456 DEFUN ("x-display-save-under", Fx_display_save_under,
4457 Sx_display_save_under, 0, 1, 0,
4458 doc: /* Return t if the X display TERMINAL supports the save-under feature.
4459 The optional argument TERMINAL specifies which display to ask about.
4460 TERMINAL should be a terminal object, a frame or a display name (a string).
4461 If omitted or nil, that stands for the selected frame's display. */)
4462 (Lisp_Object terminal)
4464 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4466 if (DoesSaveUnders (dpyinfo->screen) == True)
4467 return Qt;
4468 else
4469 return Qnil;
4472 /* Store the geometry of the workarea on display DPYINFO into *RECT.
4473 Return false if and only if the workarea information cannot be
4474 obtained via the _NET_WORKAREA root window property. */
4476 #if ! GTK_CHECK_VERSION (3, 4, 0)
4477 static bool
4478 x_get_net_workarea (struct x_display_info *dpyinfo, XRectangle *rect)
4480 Display *dpy = dpyinfo->display;
4481 long offset, max_len;
4482 Atom target_type, actual_type;
4483 unsigned long actual_size, bytes_remaining;
4484 int rc, actual_format;
4485 unsigned char *tmp_data = NULL;
4486 bool result = false;
4488 x_catch_errors (dpy);
4489 offset = 0;
4490 max_len = 1;
4491 target_type = XA_CARDINAL;
4492 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
4493 dpyinfo->Xatom_net_current_desktop,
4494 offset, max_len, False, target_type,
4495 &actual_type, &actual_format, &actual_size,
4496 &bytes_remaining, &tmp_data);
4497 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
4498 && actual_format == 32 && actual_size == max_len)
4500 long current_desktop = ((long *) tmp_data)[0];
4502 XFree (tmp_data);
4503 tmp_data = NULL;
4505 offset = 4 * current_desktop;
4506 max_len = 4;
4507 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
4508 dpyinfo->Xatom_net_workarea,
4509 offset, max_len, False, target_type,
4510 &actual_type, &actual_format, &actual_size,
4511 &bytes_remaining, &tmp_data);
4512 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
4513 && actual_format == 32 && actual_size == max_len)
4515 long *values = (long *) tmp_data;
4517 rect->x = values[0];
4518 rect->y = values[1];
4519 rect->width = values[2];
4520 rect->height = values[3];
4522 XFree (tmp_data);
4523 tmp_data = NULL;
4525 result = true;
4528 if (tmp_data)
4529 XFree (tmp_data);
4530 x_uncatch_errors ();
4532 return result;
4534 #endif
4536 #ifndef USE_GTK
4538 /* Return monitor number where F is "most" or closest to. */
4539 static int
4540 x_get_monitor_for_frame (struct frame *f,
4541 struct MonitorInfo *monitors,
4542 int n_monitors)
4544 XRectangle frect;
4545 int area = 0, dist = -1;
4546 int best_area = -1, best_dist = -1;
4547 int i;
4549 if (n_monitors == 1) return 0;
4550 frect.x = f->left_pos;
4551 frect.y = f->top_pos;
4552 frect.width = FRAME_PIXEL_WIDTH (f);
4553 frect.height = FRAME_PIXEL_HEIGHT (f);
4555 for (i = 0; i < n_monitors; ++i)
4557 struct MonitorInfo *mi = &monitors[i];
4558 XRectangle res;
4559 int a = 0;
4561 if (mi->geom.width == 0) continue;
4563 if (x_intersect_rectangles (&mi->geom, &frect, &res))
4565 a = res.width * res.height;
4566 if (a > area)
4568 area = a;
4569 best_area = i;
4573 if (a == 0 && area == 0)
4575 int dx, dy, d;
4576 if (frect.x + frect.width < mi->geom.x)
4577 dx = mi->geom.x - frect.x + frect.width;
4578 else if (frect.x > mi->geom.x + mi->geom.width)
4579 dx = frect.x - mi->geom.x + mi->geom.width;
4580 else
4581 dx = 0;
4582 if (frect.y + frect.height < mi->geom.y)
4583 dy = mi->geom.y - frect.y + frect.height;
4584 else if (frect.y > mi->geom.y + mi->geom.height)
4585 dy = frect.y - mi->geom.y + mi->geom.height;
4586 else
4587 dy = 0;
4589 d = dx*dx + dy*dy;
4590 if (dist == -1 || dist > d)
4592 dist = d;
4593 best_dist = i;
4598 return best_area != -1 ? best_area : (best_dist != -1 ? best_dist : 0);
4601 static Lisp_Object
4602 x_make_monitor_attribute_list (struct MonitorInfo *monitors,
4603 int n_monitors,
4604 int primary_monitor,
4605 struct x_display_info *dpyinfo,
4606 const char *source)
4608 Lisp_Object monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4609 Lisp_Object frame, rest;
4611 FOR_EACH_FRAME (rest, frame)
4613 struct frame *f = XFRAME (frame);
4615 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo
4616 && !EQ (frame, tip_frame))
4618 int i = x_get_monitor_for_frame (f, monitors, n_monitors);
4619 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
4623 return make_monitor_attribute_list (monitors, n_monitors, primary_monitor,
4624 monitor_frames, source);
4627 static Lisp_Object
4628 x_get_monitor_attributes_fallback (struct x_display_info *dpyinfo)
4630 struct MonitorInfo monitor;
4631 XRectangle workarea_r;
4633 /* Fallback: treat (possibly) multiple physical monitors as if they
4634 formed a single monitor as a whole. This should provide a
4635 consistent result at least on single monitor environments. */
4636 monitor.geom.x = monitor.geom.y = 0;
4637 monitor.geom.width = x_display_pixel_width (dpyinfo);
4638 monitor.geom.height = x_display_pixel_height (dpyinfo);
4639 monitor.mm_width = WidthMMOfScreen (dpyinfo->screen);
4640 monitor.mm_height = HeightMMOfScreen (dpyinfo->screen);
4641 monitor.name = xstrdup ("combined screen");
4643 if (x_get_net_workarea (dpyinfo, &workarea_r))
4644 monitor.work = workarea_r;
4645 else
4646 monitor.work = monitor.geom;
4647 return x_make_monitor_attribute_list (&monitor, 1, 0, dpyinfo, "fallback");
4651 #ifdef HAVE_XINERAMA
4652 static Lisp_Object
4653 x_get_monitor_attributes_xinerama (struct x_display_info *dpyinfo)
4655 int n_monitors, i;
4656 Lisp_Object attributes_list = Qnil;
4657 Display *dpy = dpyinfo->display;
4658 XineramaScreenInfo *info = XineramaQueryScreens (dpy, &n_monitors);
4659 struct MonitorInfo *monitors;
4660 double mm_width_per_pixel, mm_height_per_pixel;
4662 if (! info || n_monitors == 0)
4664 if (info)
4665 XFree (info);
4666 return attributes_list;
4669 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
4670 / x_display_pixel_width (dpyinfo));
4671 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
4672 / x_display_pixel_height (dpyinfo));
4673 monitors = xzalloc (n_monitors * sizeof *monitors);
4674 for (i = 0; i < n_monitors; ++i)
4676 struct MonitorInfo *mi = &monitors[i];
4677 XRectangle workarea_r;
4679 mi->geom.x = info[i].x_org;
4680 mi->geom.y = info[i].y_org;
4681 mi->geom.width = info[i].width;
4682 mi->geom.height = info[i].height;
4683 mi->mm_width = mi->geom.width * mm_width_per_pixel + 0.5;
4684 mi->mm_height = mi->geom.height * mm_height_per_pixel + 0.5;
4685 mi->name = 0;
4687 /* Xinerama usually have primary monitor first, just use that. */
4688 if (i == 0 && x_get_net_workarea (dpyinfo, &workarea_r))
4690 mi->work = workarea_r;
4691 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
4692 mi->work = mi->geom;
4694 else
4695 mi->work = mi->geom;
4697 XFree (info);
4699 attributes_list = x_make_monitor_attribute_list (monitors,
4700 n_monitors,
4702 dpyinfo,
4703 "Xinerama");
4704 free_monitors (monitors, n_monitors);
4705 return attributes_list;
4707 #endif /* HAVE_XINERAMA */
4710 #ifdef HAVE_XRANDR
4711 static Lisp_Object
4712 x_get_monitor_attributes_xrandr (struct x_display_info *dpyinfo)
4714 Lisp_Object attributes_list = Qnil;
4715 XRRScreenResources *resources;
4716 Display *dpy = dpyinfo->display;
4717 int i, n_monitors, primary = -1;
4718 RROutput pxid = None;
4719 struct MonitorInfo *monitors;
4721 #define RANDR13_LIBRARY \
4722 (RANDR_MAJOR > 1 || (RANDR_MAJOR == 1 && RANDR_MINOR >= 3))
4724 #if RANDR13_LIBRARY
4725 /* Check if the display supports 1.3 too. */
4726 bool randr13_avail = (dpyinfo->xrandr_major_version > 1
4727 || (dpyinfo->xrandr_major_version == 1
4728 && dpyinfo->xrandr_minor_version >= 3));
4730 if (randr13_avail)
4731 resources = XRRGetScreenResourcesCurrent (dpy, dpyinfo->root_window);
4732 else
4733 resources = XRRGetScreenResources (dpy, dpyinfo->root_window);
4734 #else
4735 resources = XRRGetScreenResources (dpy, dpyinfo->root_window);
4736 #endif
4737 if (! resources || resources->noutput == 0)
4739 if (resources)
4740 XRRFreeScreenResources (resources);
4741 return Qnil;
4743 n_monitors = resources->noutput;
4744 monitors = xzalloc (n_monitors * sizeof *monitors);
4746 #if RANDR13_LIBRARY
4747 if (randr13_avail)
4748 pxid = XRRGetOutputPrimary (dpy, dpyinfo->root_window);
4749 #endif
4751 for (i = 0; i < n_monitors; ++i)
4753 XRROutputInfo *info = XRRGetOutputInfo (dpy, resources,
4754 resources->outputs[i]);
4755 if (!info)
4756 continue;
4758 if (strcmp (info->name, "default") == 0)
4760 /* Non XRandr 1.2 driver, does not give useful data. */
4761 XRRFreeOutputInfo (info);
4762 XRRFreeScreenResources (resources);
4763 free_monitors (monitors, n_monitors);
4764 return Qnil;
4767 if (info->connection != RR_Disconnected && info->crtc != None)
4769 XRRCrtcInfo *crtc = XRRGetCrtcInfo (dpy, resources, info->crtc);
4770 struct MonitorInfo *mi = &monitors[i];
4771 XRectangle workarea_r;
4773 if (! crtc)
4775 XRRFreeOutputInfo (info);
4776 continue;
4779 mi->geom.x = crtc->x;
4780 mi->geom.y = crtc->y;
4781 mi->geom.width = crtc->width;
4782 mi->geom.height = crtc->height;
4783 mi->mm_width = info->mm_width;
4784 mi->mm_height = info->mm_height;
4785 mi->name = xstrdup (info->name);
4787 if (pxid != None && pxid == resources->outputs[i])
4788 primary = i;
4789 else if (primary == -1 && strcmp (info->name, "LVDS") == 0)
4790 primary = i;
4792 if (i == primary && x_get_net_workarea (dpyinfo, &workarea_r))
4794 mi->work= workarea_r;
4795 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
4796 mi->work = mi->geom;
4798 else
4799 mi->work = mi->geom;
4801 XRRFreeCrtcInfo (crtc);
4803 XRRFreeOutputInfo (info);
4805 XRRFreeScreenResources (resources);
4807 attributes_list = x_make_monitor_attribute_list (monitors,
4808 n_monitors,
4809 primary,
4810 dpyinfo,
4811 "XRandr");
4812 free_monitors (monitors, n_monitors);
4813 return attributes_list;
4815 #endif /* HAVE_XRANDR */
4817 static Lisp_Object
4818 x_get_monitor_attributes (struct x_display_info *dpyinfo)
4820 Lisp_Object attributes_list = Qnil;
4821 Display *dpy = dpyinfo->display;
4823 (void) dpy; /* Suppress unused variable warning. */
4825 #ifdef HAVE_XRANDR
4826 int xrr_event_base, xrr_error_base;
4827 bool xrr_ok = false;
4828 xrr_ok = XRRQueryExtension (dpy, &xrr_event_base, &xrr_error_base);
4829 if (xrr_ok)
4831 XRRQueryVersion (dpy, &dpyinfo->xrandr_major_version,
4832 &dpyinfo->xrandr_minor_version);
4833 xrr_ok = ((dpyinfo->xrandr_major_version == 1
4834 && dpyinfo->xrandr_minor_version >= 2)
4835 || dpyinfo->xrandr_major_version > 1);
4838 if (xrr_ok)
4839 attributes_list = x_get_monitor_attributes_xrandr (dpyinfo);
4840 #endif /* HAVE_XRANDR */
4842 #ifdef HAVE_XINERAMA
4843 if (NILP (attributes_list))
4845 int xin_event_base, xin_error_base;
4846 bool xin_ok = false;
4847 xin_ok = XineramaQueryExtension (dpy, &xin_event_base, &xin_error_base);
4848 if (xin_ok && XineramaIsActive (dpy))
4849 attributes_list = x_get_monitor_attributes_xinerama (dpyinfo);
4851 #endif /* HAVE_XINERAMA */
4853 if (NILP (attributes_list))
4854 attributes_list = x_get_monitor_attributes_fallback (dpyinfo);
4856 return attributes_list;
4859 #endif /* !USE_GTK */
4861 DEFUN ("x-display-monitor-attributes-list", Fx_display_monitor_attributes_list,
4862 Sx_display_monitor_attributes_list,
4863 0, 1, 0,
4864 doc: /* Return a list of physical monitor attributes on the X display TERMINAL.
4866 The optional argument TERMINAL specifies which display to ask about.
4867 TERMINAL should be a terminal object, a frame or a display name (a string).
4868 If omitted or nil, that stands for the selected frame's display.
4870 In addition to the standard attribute keys listed in
4871 `display-monitor-attributes-list', the following keys are contained in
4872 the attributes:
4874 source -- String describing the source from which multi-monitor
4875 information is obtained, one of \"Gdk\", \"XRandr\",
4876 \"Xinerama\", or \"fallback\"
4878 Internal use only, use `display-monitor-attributes-list' instead. */)
4879 (Lisp_Object terminal)
4881 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4882 Lisp_Object attributes_list = Qnil;
4884 #ifdef USE_GTK
4885 double mm_width_per_pixel, mm_height_per_pixel;
4886 GdkDisplay *gdpy;
4887 #if ! GTK_CHECK_VERSION (3, 22, 0)
4888 GdkScreen *gscreen;
4889 #endif
4890 gint primary_monitor = 0, n_monitors, i;
4891 Lisp_Object monitor_frames, rest, frame;
4892 static const char *source = "Gdk";
4893 struct MonitorInfo *monitors;
4895 block_input ();
4896 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
4897 / x_display_pixel_width (dpyinfo));
4898 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
4899 / x_display_pixel_height (dpyinfo));
4900 gdpy = gdk_x11_lookup_xdisplay (dpyinfo->display);
4901 #if GTK_CHECK_VERSION (3, 22, 0)
4902 n_monitors = gdk_display_get_n_monitors (gdpy);
4903 #else
4904 gscreen = gdk_display_get_default_screen (gdpy);
4905 #if GTK_CHECK_VERSION (2, 20, 0)
4906 primary_monitor = gdk_screen_get_primary_monitor (gscreen);
4907 #endif
4908 n_monitors = gdk_screen_get_n_monitors (gscreen);
4909 #endif
4910 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4911 monitors = xzalloc (n_monitors * sizeof *monitors);
4913 FOR_EACH_FRAME (rest, frame)
4915 struct frame *f = XFRAME (frame);
4917 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo
4918 && !EQ (frame, tip_frame))
4920 GdkWindow *gwin = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
4922 #if GTK_CHECK_VERSION (3, 22, 0)
4923 for (i = 0; i < n_monitors; i++)
4924 if (gdk_display_get_monitor_at_window (gdpy, gwin)
4925 == gdk_display_get_monitor (gdpy, i))
4926 break;
4927 #else
4928 i = gdk_screen_get_monitor_at_window (gscreen, gwin);
4929 #endif
4930 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
4934 for (i = 0; i < n_monitors; ++i)
4936 gint width_mm = -1, height_mm = -1;
4937 GdkRectangle rec, work;
4938 struct MonitorInfo *mi = &monitors[i];
4940 #if GTK_CHECK_VERSION (3, 22, 0)
4941 GdkMonitor *monitor = gdk_display_get_monitor (gdpy, i);
4942 if (gdk_monitor_is_primary (monitor))
4943 primary_monitor = i;
4944 gdk_monitor_get_geometry (monitor, &rec);
4945 #else
4946 gdk_screen_get_monitor_geometry (gscreen, i, &rec);
4947 #endif
4949 #if GTK_CHECK_VERSION (3, 22, 0)
4950 width_mm = gdk_monitor_get_width_mm (monitor);
4951 height_mm = gdk_monitor_get_height_mm (monitor);
4952 #elif GTK_CHECK_VERSION (2, 14, 0)
4953 width_mm = gdk_screen_get_monitor_width_mm (gscreen, i);
4954 height_mm = gdk_screen_get_monitor_height_mm (gscreen, i);
4955 #endif
4956 if (width_mm < 0)
4957 width_mm = rec.width * mm_width_per_pixel + 0.5;
4958 if (height_mm < 0)
4959 height_mm = rec.height * mm_height_per_pixel + 0.5;
4961 #if GTK_CHECK_VERSION (3, 22, 0)
4962 gdk_monitor_get_workarea (monitor, &work);
4963 #elif GTK_CHECK_VERSION (3, 4, 0)
4964 gdk_screen_get_monitor_workarea (gscreen, i, &work);
4965 #else
4966 /* Emulate the behavior of GTK+ 3.4. */
4968 XRectangle workarea_r;
4970 if (i == primary_monitor && x_get_net_workarea (dpyinfo, &workarea_r))
4972 work.x = workarea_r.x;
4973 work.y = workarea_r.y;
4974 work.width = workarea_r.width;
4975 work.height = workarea_r.height;
4976 if (! gdk_rectangle_intersect (&rec, &work, &work))
4977 work = rec;
4979 else
4980 work = rec;
4982 #endif
4985 mi->geom.x = rec.x;
4986 mi->geom.y = rec.y;
4987 mi->geom.width = rec.width;
4988 mi->geom.height = rec.height;
4989 mi->work.x = work.x;
4990 mi->work.y = work.y;
4991 mi->work.width = work.width;
4992 mi->work.height = work.height;
4993 mi->mm_width = width_mm;
4994 mi->mm_height = height_mm;
4996 #if GTK_CHECK_VERSION (3, 22, 0)
4997 mi->name = g_strdup (gdk_monitor_get_model (monitor));
4998 #elif GTK_CHECK_VERSION (2, 14, 0)
4999 mi->name = gdk_screen_get_monitor_plug_name (gscreen, i);
5000 #endif
5003 attributes_list = make_monitor_attribute_list (monitors,
5004 n_monitors,
5005 primary_monitor,
5006 monitor_frames,
5007 source);
5008 unblock_input ();
5009 #else /* not USE_GTK */
5011 block_input ();
5012 attributes_list = x_get_monitor_attributes (dpyinfo);
5013 unblock_input ();
5015 #endif /* not USE_GTK */
5017 return attributes_list;
5020 /* Return geometric attributes of FRAME. According to the value of
5021 ATTRIBUTES return the outer edges of FRAME (Qouter_edges), the native
5022 edges of FRAME (Qnative_edges), or the inner edges of frame
5023 (Qinner_edges). Any other value means to return the geometry as
5024 returned by Fx_frame_geometry. */
5025 static Lisp_Object
5026 frame_geometry (Lisp_Object frame, Lisp_Object attribute)
5028 struct frame *f = decode_live_frame (frame);
5029 /** XWindowAttributes atts; **/
5030 Window rootw;
5031 unsigned int ign, native_width, native_height, x_border_width = 0;
5032 int x_native = 0, y_native = 0, xptr = 0, yptr = 0;
5033 int left_off = 0, right_off = 0, top_off = 0, bottom_off = 0;
5034 int outer_left, outer_top, outer_right, outer_bottom;
5035 int native_left, native_top, native_right, native_bottom;
5036 int inner_left, inner_top, inner_right, inner_bottom;
5037 int internal_border_width;
5038 bool menu_bar_external = false, tool_bar_external = false;
5039 int menu_bar_height = 0, menu_bar_width = 0;
5040 int tool_bar_height = 0, tool_bar_width = 0;
5042 if (FRAME_INITIAL_P (f) || !FRAME_X_P (f))
5043 return Qnil;
5045 block_input ();
5046 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
5047 &rootw, &x_native, &y_native, &native_width, &native_height,
5048 &x_border_width, &ign);
5049 /** XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &atts); **/
5050 if (!FRAME_PARENT_FRAME (f))
5051 x_real_pos_and_offsets (f, &left_off, &right_off, &top_off, &bottom_off,
5052 NULL, NULL, &xptr, &yptr, NULL);
5053 unblock_input ();
5055 /** native_width = atts.width; **/
5056 /** native_height = atts.height; **/
5058 if (FRAME_PARENT_FRAME (f))
5060 Lisp_Object parent, edges;
5062 XSETFRAME (parent, FRAME_PARENT_FRAME (f));
5063 edges = Fx_frame_edges (parent, Qnative_edges);
5064 if (!NILP (edges))
5066 x_native += XINT (Fnth (make_number (0), edges));
5067 y_native += XINT (Fnth (make_number (1), edges));
5070 outer_left = x_native;
5071 outer_top = y_native;
5072 outer_right = outer_left + native_width + 2 * x_border_width;
5073 outer_bottom = outer_top + native_height + 2 * x_border_width;
5075 native_left = x_native + x_border_width;
5076 native_top = y_native + x_border_width;
5077 native_right = native_left + native_width;
5078 native_bottom = native_top + native_height;
5080 else
5082 outer_left = xptr;
5083 outer_top = yptr;
5084 outer_right = outer_left + left_off + native_width + right_off;
5085 outer_bottom = outer_top + top_off + native_height + bottom_off;
5087 native_left = outer_left + left_off;
5088 native_top = outer_top + top_off;
5089 native_right = native_left + native_width;
5090 native_bottom = native_top + native_height;
5093 internal_border_width = FRAME_INTERNAL_BORDER_WIDTH (f);
5094 inner_left = native_left + internal_border_width;
5095 inner_top = native_top + internal_border_width;
5096 inner_right = native_right - internal_border_width;
5097 inner_bottom = native_bottom - internal_border_width;
5099 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
5100 menu_bar_external = true;
5101 menu_bar_height = FRAME_MENUBAR_HEIGHT (f);
5102 native_top += menu_bar_height;
5103 inner_top += menu_bar_height;
5104 #else
5105 menu_bar_height = FRAME_MENU_BAR_HEIGHT (f);
5106 inner_top += menu_bar_height;
5107 #endif
5108 menu_bar_width = menu_bar_height ? native_width : 0;
5110 #if defined (USE_GTK)
5111 tool_bar_external = true;
5112 if (EQ (FRAME_TOOL_BAR_POSITION (f), Qleft))
5114 tool_bar_width = FRAME_TOOLBAR_WIDTH (f);
5115 native_left += tool_bar_width;
5116 inner_left += tool_bar_width;
5117 tool_bar_height
5118 = tool_bar_width ? native_height - menu_bar_height : 0;
5120 else if (EQ (FRAME_TOOL_BAR_POSITION (f), Qtop))
5122 tool_bar_height = FRAME_TOOLBAR_HEIGHT (f);
5123 native_top += tool_bar_height;
5124 inner_top += tool_bar_height;
5125 tool_bar_width = tool_bar_height ? native_width : 0;
5127 else if (EQ (FRAME_TOOL_BAR_POSITION (f), Qright))
5129 tool_bar_width = FRAME_TOOLBAR_WIDTH (f);
5130 native_right -= tool_bar_width;
5131 inner_right -= tool_bar_width;
5132 tool_bar_height
5133 = tool_bar_width ? native_height - menu_bar_height : 0;
5135 else
5137 tool_bar_height = FRAME_TOOLBAR_HEIGHT (f);
5138 native_bottom -= tool_bar_height;
5139 inner_bottom -= tool_bar_height;
5140 tool_bar_width = tool_bar_height ? native_width : 0;
5142 #else
5143 tool_bar_height = FRAME_TOOL_BAR_HEIGHT (f);
5144 tool_bar_width = (tool_bar_height
5145 ? native_width - 2 * internal_border_width
5146 : 0);
5147 inner_top += tool_bar_height;
5148 #endif
5150 /* Construct list. */
5151 if (EQ (attribute, Qouter_edges))
5152 return list4 (make_number (outer_left), make_number (outer_top),
5153 make_number (outer_right), make_number (outer_bottom));
5154 else if (EQ (attribute, Qnative_edges))
5155 return list4 (make_number (native_left), make_number (native_top),
5156 make_number (native_right), make_number (native_bottom));
5157 else if (EQ (attribute, Qinner_edges))
5158 return list4 (make_number (inner_left), make_number (inner_top),
5159 make_number (inner_right), make_number (inner_bottom));
5160 else
5161 return
5162 listn (CONSTYPE_HEAP, 11,
5163 Fcons (Qouter_position,
5164 Fcons (make_number (outer_left),
5165 make_number (outer_top))),
5166 Fcons (Qouter_size,
5167 Fcons (make_number (outer_right - outer_left),
5168 make_number (outer_bottom - outer_top))),
5169 /* Approximate. */
5170 Fcons (Qexternal_border_size,
5171 Fcons (make_number (right_off),
5172 make_number (bottom_off))),
5173 Fcons (Qouter_border_width, make_number (x_border_width)),
5174 /* Approximate. */
5175 Fcons (Qtitle_bar_size,
5176 Fcons (make_number (0),
5177 make_number (top_off - bottom_off))),
5178 Fcons (Qmenu_bar_external, menu_bar_external ? Qt : Qnil),
5179 Fcons (Qmenu_bar_size,
5180 Fcons (make_number (menu_bar_width),
5181 make_number (menu_bar_height))),
5182 Fcons (Qtool_bar_external, tool_bar_external ? Qt : Qnil),
5183 Fcons (Qtool_bar_position, FRAME_TOOL_BAR_POSITION (f)),
5184 Fcons (Qtool_bar_size,
5185 Fcons (make_number (tool_bar_width),
5186 make_number (tool_bar_height))),
5187 Fcons (Qinternal_border_width,
5188 make_number (internal_border_width)));
5191 DEFUN ("x-frame-geometry", Fx_frame_geometry, Sx_frame_geometry, 0, 1, 0,
5192 doc: /* Return geometric attributes of FRAME.
5193 FRAME must be a live frame and defaults to the selected one. The return
5194 value is an association list of the attributes listed below. All height
5195 and width values are in pixels.
5197 `outer-position' is a cons of the outer left and top edges of FRAME
5198 relative to the origin - the position (0, 0) - of FRAME's display.
5200 `outer-size' is a cons of the outer width and height of FRAME. The
5201 outer size includes the title bar and the external borders as well as
5202 any menu and/or tool bar of frame. For a child frame the value
5203 includes FRAME's X borders, if any.
5205 `external-border-size' is a cons of the horizontal and vertical width of
5206 FRAME's external borders as supplied by the window manager.
5208 `title-bar-size' is a cons of the width and height of the title bar of
5209 FRAME as supplied by the window manager. If both of them are zero,
5210 FRAME has no title bar. If only the width is zero, Emacs was not
5211 able to retrieve the width information.
5213 `menu-bar-external', if non-nil, means the menu bar is external (never
5214 included in the inner edges of FRAME).
5216 `menu-bar-size' is a cons of the width and height of the menu bar of
5217 FRAME.
5219 `tool-bar-external', if non-nil, means the tool bar is external (never
5220 included in the inner edges of FRAME).
5222 `tool-bar-position' tells on which side the tool bar on FRAME is and can
5223 be one of `left', `top', `right' or `bottom'. If this is nil, FRAME
5224 has no tool bar.
5226 `tool-bar-size' is a cons of the width and height of the tool bar of
5227 FRAME.
5229 `internal-border-width' is the width of the internal border of
5230 FRAME.
5232 `outer-border-width' is the width of the X border of FRAME. The X
5233 border is usually only shown for frames without window manager
5234 decorations like child and tooltip frames. */)
5235 (Lisp_Object frame)
5237 return frame_geometry (frame, Qnil);
5240 DEFUN ("x-frame-edges", Fx_frame_edges, Sx_frame_edges, 0, 2, 0,
5241 doc: /* Return edge coordinates of FRAME.
5242 FRAME must be a live frame and defaults to the selected one. The return
5243 value is a list of the form (LEFT, TOP, RIGHT, BOTTOM). All values are
5244 in pixels relative to the origin - the position (0, 0) - of FRAME's
5245 display.
5247 If optional argument TYPE is the symbol `outer-edges', return the outer
5248 edges of FRAME. The outer edges comprise the decorations of the window
5249 manager (like the title bar or external borders) as well as any external
5250 menu or tool bar of FRAME. If optional argument TYPE is the symbol
5251 `native-edges' or nil, return the native edges of FRAME. The native
5252 edges exclude the decorations of the window manager and any external
5253 menu or tool bar of FRAME. If TYPE is the symbol `inner-edges', return
5254 the inner edges of FRAME. These edges exclude title bar, any borders,
5255 menu bar or tool bar of FRAME. */)
5256 (Lisp_Object frame, Lisp_Object type)
5258 return frame_geometry (frame, ((EQ (type, Qouter_edges)
5259 || EQ (type, Qinner_edges))
5260 ? type
5261 : Qnative_edges));
5265 * x_frame_list_z_order:
5267 * Recursively add list of all frames on the display specified via
5268 * DPYINFO and whose window-system window's parent is specified by
5269 * WINDOW to FRAMES and return FRAMES.
5271 static Lisp_Object
5272 x_frame_list_z_order (Display* dpy, Window window)
5274 Window root, parent, *children;
5275 unsigned int nchildren;
5276 int i;
5277 Lisp_Object frames = Qnil;
5279 block_input ();
5280 if (XQueryTree (dpy, window, &root, &parent, &children, &nchildren))
5282 unblock_input ();
5283 for (i = 0; i < nchildren; i++)
5285 Lisp_Object frame, tail;
5287 FOR_EACH_FRAME (tail, frame)
5288 /* With a reparenting window manager the parent_desc field
5289 usually specifies the topmost windows of our frames.
5290 Otherwise FRAME_OUTER_WINDOW should do. */
5291 if (XFRAME (frame)->output_data.x->parent_desc == children[i]
5292 || FRAME_OUTER_WINDOW (XFRAME (frame)) == children[i])
5293 frames = Fcons (frame, frames);
5296 if (children) XFree ((char *)children);
5298 else
5299 unblock_input ();
5301 return frames;
5305 DEFUN ("x-frame-list-z-order", Fx_frame_list_z_order,
5306 Sx_frame_list_z_order, 0, 1, 0,
5307 doc: /* Return list of Emacs' frames, in Z (stacking) order.
5308 The optional argument TERMINAL specifies which display to ask about.
5309 TERMINAL should be either a frame or a display name (a string). If
5310 omitted or nil, that stands for the selected frame's display. Return
5311 nil if TERMINAL contains no Emacs frame.
5313 As a special case, if TERMINAL is non-nil and specifies a live frame,
5314 return the child frames of that frame in Z (stacking) order.
5316 Frames are listed from topmost (first) to bottommost (last). */)
5317 (Lisp_Object terminal)
5319 struct x_display_info *dpyinfo = check_x_display_info (terminal);
5320 Display *dpy = dpyinfo->display;
5321 Window window;
5323 if (FRAMEP (terminal) && FRAME_LIVE_P (XFRAME (terminal)))
5324 window = FRAME_X_WINDOW (XFRAME (terminal));
5325 else
5326 window = dpyinfo->root_window;
5328 return x_frame_list_z_order (dpy, window);
5332 * x_frame_restack:
5334 * Restack frame F1 below frame F2, above if ABOVE_FLAG is non-nil. In
5335 * practice this is a two-step action: The first step removes F1's
5336 * window-system window from the display. The second step reinserts
5337 * F1's window below (above if ABOVE_FLAG is true) that of F2.
5339 static void
5340 x_frame_restack (struct frame *f1, struct frame *f2, bool above_flag)
5342 #if defined (USE_GTK) && GTK_CHECK_VERSION (2, 18, 0)
5343 block_input ();
5344 xg_frame_restack (f1, f2, above_flag);
5345 unblock_input ();
5346 #else
5347 Display *dpy = FRAME_X_DISPLAY (f1);
5348 Window window1 = FRAME_OUTER_WINDOW (f1);
5349 XWindowChanges wc;
5350 unsigned long mask = (CWSibling | CWStackMode);
5352 wc.sibling = FRAME_OUTER_WINDOW (f2);
5353 wc.stack_mode = above_flag ? Above : Below;
5354 block_input ();
5355 /* Configure the window manager window (a normal XConfigureWindow
5356 won't cut it). This should also work for child frames. */
5357 XReconfigureWMWindow (dpy, window1, FRAME_X_SCREEN_NUMBER (f1), mask, &wc);
5358 unblock_input ();
5359 #endif /* USE_GTK */
5363 DEFUN ("x-frame-restack", Fx_frame_restack, Sx_frame_restack, 2, 3, 0,
5364 doc: /* Restack FRAME1 below FRAME2.
5365 This means that if both frames are visible and the display areas of
5366 these frames overlap, FRAME2 (partially) obscures FRAME1. If optional
5367 third argument ABOVE is non-nil, restack FRAME1 above FRAME2. This
5368 means that if both frames are visible and the display areas of these
5369 frames overlap, FRAME1 (partially) obscures FRAME2.
5371 This may be thought of as an atomic action performed in two steps: The
5372 first step removes FRAME1's window-step window from the display. The
5373 second step reinserts FRAME1's window below (above if ABOVE is true)
5374 that of FRAME2. Hence the position of FRAME2 in its display's Z
5375 \(stacking) order relative to all other frames excluding FRAME1 remains
5376 unaltered.
5378 Some window managers may refuse to restack windows. */)
5379 (Lisp_Object frame1, Lisp_Object frame2, Lisp_Object above)
5381 struct frame *f1 = decode_live_frame (frame1);
5382 struct frame *f2 = decode_live_frame (frame2);
5384 if (FRAME_OUTER_WINDOW (f1) && FRAME_OUTER_WINDOW (f2))
5386 x_frame_restack (f1, f2, !NILP (above));
5387 return Qt;
5389 else
5391 error ("Cannot restack frames");
5392 return Qnil;
5397 DEFUN ("x-mouse-absolute-pixel-position", Fx_mouse_absolute_pixel_position,
5398 Sx_mouse_absolute_pixel_position, 0, 0, 0,
5399 doc: /* Return absolute position of mouse cursor in pixels.
5400 The position is returned as a cons cell (X . Y) of the coordinates of
5401 the mouse cursor position in pixels relative to a position (0, 0) of the
5402 selected frame's display. */)
5403 (void)
5405 struct frame *f = SELECTED_FRAME ();
5406 Window root, dummy_window;
5407 int x, y, dummy;
5409 if (FRAME_INITIAL_P (f) || !FRAME_X_P (f))
5410 return Qnil;
5412 block_input ();
5413 XQueryPointer (FRAME_X_DISPLAY (f),
5414 DefaultRootWindow (FRAME_X_DISPLAY (f)),
5415 &root, &dummy_window, &x, &y, &dummy, &dummy,
5416 (unsigned int *) &dummy);
5417 unblock_input ();
5419 return Fcons (make_number (x), make_number (y));
5422 DEFUN ("x-set-mouse-absolute-pixel-position", Fx_set_mouse_absolute_pixel_position,
5423 Sx_set_mouse_absolute_pixel_position, 2, 2, 0,
5424 doc: /* Move mouse pointer to absolute pixel position (X, Y).
5425 The coordinates X and Y are interpreted in pixels relative to a position
5426 \(0, 0) of the selected frame's display. */)
5427 (Lisp_Object x, Lisp_Object y)
5429 struct frame *f = SELECTED_FRAME ();
5431 if (FRAME_INITIAL_P (f) || !FRAME_X_P (f))
5432 return Qnil;
5434 CHECK_TYPE_RANGED_INTEGER (int, x);
5435 CHECK_TYPE_RANGED_INTEGER (int, y);
5437 block_input ();
5438 XWarpPointer (FRAME_X_DISPLAY (f), None, DefaultRootWindow (FRAME_X_DISPLAY (f)),
5439 0, 0, 0, 0, XINT (x), XINT (y));
5440 unblock_input ();
5442 return Qnil;
5445 /************************************************************************
5446 X Displays
5447 ************************************************************************/
5450 /* Mapping visual names to visuals. */
5452 static struct visual_class
5454 const char *name;
5455 int class;
5457 visual_classes[] =
5459 {"StaticGray", StaticGray},
5460 {"GrayScale", GrayScale},
5461 {"StaticColor", StaticColor},
5462 {"PseudoColor", PseudoColor},
5463 {"TrueColor", TrueColor},
5464 {"DirectColor", DirectColor},
5465 {NULL, 0}
5469 #ifndef HAVE_XSCREENNUMBEROFSCREEN
5471 /* Value is the screen number of screen SCR. This is a substitute for
5472 the X function with the same name when that doesn't exist. */
5475 XScreenNumberOfScreen (scr)
5476 register Screen *scr;
5478 Display *dpy = scr->display;
5479 int i;
5481 for (i = 0; i < dpy->nscreens; ++i)
5482 if (scr == dpy->screens + i)
5483 break;
5485 return i;
5488 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
5491 /* Select the visual that should be used on display DPYINFO. Set
5492 members of DPYINFO appropriately. Called from x_term_init. */
5494 void
5495 select_visual (struct x_display_info *dpyinfo)
5497 Display *dpy = dpyinfo->display;
5498 Screen *screen = dpyinfo->screen;
5500 /* See if a visual is specified. */
5501 AUTO_STRING (visualClass, "visualClass");
5502 AUTO_STRING (VisualClass, "VisualClass");
5503 Lisp_Object value = display_x_get_resource (dpyinfo, visualClass,
5504 VisualClass, Qnil, Qnil);
5506 if (STRINGP (value))
5508 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
5509 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
5510 depth, a decimal number. NAME is compared with case ignored. */
5511 char *s = alloca (SBYTES (value) + 1);
5512 char *dash;
5513 int i, class = -1;
5514 XVisualInfo vinfo;
5516 lispstpcpy (s, value);
5517 dash = strchr (s, '-');
5518 if (dash)
5520 dpyinfo->n_planes = atoi (dash + 1);
5521 *dash = '\0';
5523 else
5524 /* We won't find a matching visual with depth 0, so that
5525 an error will be printed below. */
5526 dpyinfo->n_planes = 0;
5528 /* Determine the visual class. */
5529 for (i = 0; visual_classes[i].name; ++i)
5530 if (xstrcasecmp (s, visual_classes[i].name) == 0)
5532 class = visual_classes[i].class;
5533 break;
5536 /* Look up a matching visual for the specified class. */
5537 if (class == -1
5538 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
5539 dpyinfo->n_planes, class, &vinfo))
5540 fatal ("Invalid visual specification '%s'",
5541 SSDATA (ENCODE_SYSTEM (value)));
5543 dpyinfo->visual = vinfo.visual;
5545 else
5547 int n_visuals;
5548 XVisualInfo *vinfo, vinfo_template;
5550 dpyinfo->visual = DefaultVisualOfScreen (screen);
5552 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
5553 vinfo_template.screen = XScreenNumberOfScreen (screen);
5554 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
5555 &vinfo_template, &n_visuals);
5556 if (n_visuals <= 0)
5557 fatal ("Can't get proper X visual info");
5559 dpyinfo->n_planes = vinfo->depth;
5560 XFree (vinfo);
5565 /* Return the X display structure for the display named NAME.
5566 Open a new connection if necessary. */
5568 static struct x_display_info *
5569 x_display_info_for_name (Lisp_Object name)
5571 struct x_display_info *dpyinfo;
5573 CHECK_STRING (name);
5575 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
5576 if (!NILP (Fstring_equal (XCAR (dpyinfo->name_list_element), name)))
5577 return dpyinfo;
5579 /* Use this general default value to start with. */
5580 Vx_resource_name = Vinvocation_name;
5582 validate_x_resource_name ();
5584 dpyinfo = x_term_init (name, 0, SSDATA (Vx_resource_name));
5586 if (dpyinfo == 0)
5587 error ("Cannot connect to X server %s", SDATA (name));
5589 XSETFASTINT (Vwindow_system_version, 11);
5591 return dpyinfo;
5595 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
5596 1, 3, 0,
5597 doc: /* Open a connection to a display server.
5598 DISPLAY is the name of the display to connect to.
5599 Optional second arg XRM-STRING is a string of resources in xrdb format.
5600 If the optional third arg MUST-SUCCEED is non-nil,
5601 terminate Emacs if we can't open the connection.
5602 \(In the Nextstep version, the last two arguments are currently ignored.) */)
5603 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
5605 char *xrm_option;
5606 struct x_display_info *dpyinfo;
5608 CHECK_STRING (display);
5609 if (! NILP (xrm_string))
5610 CHECK_STRING (xrm_string);
5612 xrm_option = NILP (xrm_string) ? 0 : SSDATA (xrm_string);
5614 validate_x_resource_name ();
5616 /* This is what opens the connection and sets x_current_display.
5617 This also initializes many symbols, such as those used for input. */
5618 dpyinfo = x_term_init (display, xrm_option,
5619 SSDATA (Vx_resource_name));
5621 if (dpyinfo == 0)
5623 if (!NILP (must_succeed))
5624 fatal ("Cannot connect to X server %s.\n\
5625 Check the DISPLAY environment variable or use `-d'.\n\
5626 Also use the `xauth' program to verify that you have the proper\n\
5627 authorization information needed to connect the X server.\n\
5628 An insecure way to solve the problem may be to use `xhost'.\n",
5629 SDATA (display));
5630 else
5631 error ("Cannot connect to X server %s", SDATA (display));
5634 XSETFASTINT (Vwindow_system_version, 11);
5635 return Qnil;
5638 DEFUN ("x-close-connection", Fx_close_connection,
5639 Sx_close_connection, 1, 1, 0,
5640 doc: /* Close the connection to TERMINAL's X server.
5641 For TERMINAL, specify a terminal object, a frame or a display name (a
5642 string). If TERMINAL is nil, that stands for the selected frame's
5643 terminal. */)
5644 (Lisp_Object terminal)
5646 struct x_display_info *dpyinfo = check_x_display_info (terminal);
5648 if (dpyinfo->reference_count > 0)
5649 error ("Display still has frames on it");
5651 x_delete_terminal (dpyinfo->terminal);
5653 return Qnil;
5656 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
5657 doc: /* Return the list of display names that Emacs has connections to. */)
5658 (void)
5660 Lisp_Object result = Qnil;
5661 struct x_display_info *xdi;
5663 for (xdi = x_display_list; xdi; xdi = xdi->next)
5664 result = Fcons (XCAR (xdi->name_list_element), result);
5666 return result;
5669 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
5670 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
5671 This function only has an effect on X Windows. With MS Windows, it is
5672 defined but does nothing.
5674 If ON is nil, allow buffering of requests.
5675 Turning on synchronization prohibits the Xlib routines from buffering
5676 requests and seriously degrades performance, but makes debugging much
5677 easier.
5678 The optional second argument TERMINAL specifies which display to act on.
5679 TERMINAL should be a terminal object, a frame or a display name (a string).
5680 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
5681 (Lisp_Object on, Lisp_Object terminal)
5683 struct x_display_info *dpyinfo = check_x_display_info (terminal);
5685 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
5687 return Qnil;
5690 /* Wait for responses to all X commands issued so far for frame F. */
5692 void
5693 x_sync (struct frame *f)
5695 block_input ();
5696 XSync (FRAME_X_DISPLAY (f), False);
5697 unblock_input ();
5701 /***********************************************************************
5702 Window properties
5703 ***********************************************************************/
5705 DEFUN ("x-change-window-property", Fx_change_window_property,
5706 Sx_change_window_property, 2, 6, 0,
5707 doc: /* Change window property PROP to VALUE on the X window of FRAME.
5708 PROP must be a string. VALUE may be a string or a list of conses,
5709 numbers and/or strings. If an element in the list is a string, it is
5710 converted to an atom and the value of the atom is used. If an element
5711 is a cons, it is converted to a 32 bit number where the car is the 16
5712 top bits and the cdr is the lower 16 bits.
5714 FRAME nil or omitted means use the selected frame.
5715 If TYPE is given and non-nil, it is the name of the type of VALUE.
5716 If TYPE is not given or nil, the type is STRING.
5717 FORMAT gives the size in bits of each element if VALUE is a list.
5718 It must be one of 8, 16 or 32.
5719 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
5720 If OUTER-P is non-nil, the property is changed for the outer X window of
5721 FRAME. Default is to change on the edit X window. */)
5722 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
5723 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
5725 struct frame *f = decode_window_system_frame (frame);
5726 Atom prop_atom;
5727 Atom target_type = XA_STRING;
5728 int element_format = 8;
5729 unsigned char *data;
5730 int nelements;
5731 Window w;
5733 CHECK_STRING (prop);
5735 if (! NILP (format))
5737 CHECK_NUMBER (format);
5739 if (XINT (format) != 8 && XINT (format) != 16
5740 && XINT (format) != 32)
5741 error ("FORMAT must be one of 8, 16 or 32");
5742 element_format = XINT (format);
5745 if (CONSP (value))
5747 ptrdiff_t elsize;
5749 nelements = x_check_property_data (value);
5750 if (nelements == -1)
5751 error ("Bad data in VALUE, must be number, string or cons");
5753 /* The man page for XChangeProperty:
5754 "If the specified format is 32, the property data must be a
5755 long array."
5756 This applies even if long is more than 32 bits. The X library
5757 converts to 32 bits before sending to the X server. */
5758 elsize = element_format == 32 ? sizeof (long) : element_format >> 3;
5759 data = xnmalloc (nelements, elsize);
5761 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
5763 else
5765 ptrdiff_t elsize;
5767 CHECK_STRING (value);
5768 data = SDATA (value);
5769 if (INT_MAX < SBYTES (value))
5770 error ("VALUE too long");
5772 /* See comment above about longs and format=32 */
5773 elsize = element_format == 32 ? sizeof (long) : element_format >> 3;
5774 if (SBYTES (value) % elsize != 0)
5775 error ("VALUE must contain an integral number of octets for FORMAT");
5776 nelements = SBYTES (value) / elsize;
5779 block_input ();
5780 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
5781 if (! NILP (type))
5783 CHECK_STRING (type);
5784 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
5787 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
5788 else w = FRAME_X_WINDOW (f);
5790 XChangeProperty (FRAME_X_DISPLAY (f), w,
5791 prop_atom, target_type, element_format, PropModeReplace,
5792 data, nelements);
5794 if (CONSP (value)) xfree (data);
5796 /* Make sure the property is set when we return. */
5797 XFlush (FRAME_X_DISPLAY (f));
5798 unblock_input ();
5800 return value;
5804 DEFUN ("x-delete-window-property", Fx_delete_window_property,
5805 Sx_delete_window_property, 1, 2, 0,
5806 doc: /* Remove window property PROP from X window of FRAME.
5807 FRAME nil or omitted means use the selected frame. Value is PROP. */)
5808 (Lisp_Object prop, Lisp_Object frame)
5810 struct frame *f = decode_window_system_frame (frame);
5811 Atom prop_atom;
5813 CHECK_STRING (prop);
5814 block_input ();
5815 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
5816 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
5818 /* Make sure the property is removed when we return. */
5819 XFlush (FRAME_X_DISPLAY (f));
5820 unblock_input ();
5822 return prop;
5826 static Lisp_Object
5827 x_window_property_intern (struct frame *f,
5828 Window target_window,
5829 Atom prop_atom,
5830 Atom target_type,
5831 Lisp_Object delete_p,
5832 Lisp_Object vector_ret_p,
5833 bool *found)
5835 unsigned char *tmp_data = NULL;
5836 Lisp_Object prop_value = Qnil;
5837 Atom actual_type;
5838 int actual_format;
5839 unsigned long actual_size, bytes_remaining;
5840 int rc;
5842 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
5843 prop_atom, 0, 0, False, target_type,
5844 &actual_type, &actual_format, &actual_size,
5845 &bytes_remaining, &tmp_data);
5847 *found = actual_format != 0;
5849 if (rc == Success && *found)
5851 XFree (tmp_data);
5852 tmp_data = NULL;
5854 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
5855 prop_atom, 0, bytes_remaining,
5856 ! NILP (delete_p), target_type,
5857 &actual_type, &actual_format,
5858 &actual_size, &bytes_remaining,
5859 &tmp_data);
5860 if (rc == Success && tmp_data)
5862 /* The man page for XGetWindowProperty says:
5863 "If the returned format is 32, the returned data is represented
5864 as a long array and should be cast to that type to obtain the
5865 elements."
5866 This applies even if long is more than 32 bits, the X library
5867 converts from 32 bit elements received from the X server to long
5868 and passes the long array to us. Thus, for that case memcpy can not
5869 be used. We convert to a 32 bit type here, because so much code
5870 assume on that.
5872 The bytes and offsets passed to XGetWindowProperty refers to the
5873 property and those are indeed in 32 bit quantities if format is
5874 32. */
5876 if (LONG_WIDTH > 32 && actual_format == 32)
5878 unsigned long i;
5879 int *idata = (int *) tmp_data;
5880 long *ldata = (long *) tmp_data;
5882 for (i = 0; i < actual_size; ++i)
5883 idata[i] = (int) ldata[i];
5886 if (NILP (vector_ret_p))
5887 prop_value = make_string ((char *) tmp_data,
5888 (actual_format >> 3) * actual_size);
5889 else
5890 prop_value = x_property_data_to_lisp (f,
5891 tmp_data,
5892 actual_type,
5893 actual_format,
5894 actual_size);
5897 if (tmp_data) XFree (tmp_data);
5900 return prop_value;
5903 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
5904 1, 6, 0,
5905 doc: /* Value is the value of window property PROP on FRAME.
5906 If FRAME is nil or omitted, use the selected frame.
5908 On X Windows, the following optional arguments are also accepted:
5909 If TYPE is nil or omitted, get the property as a string.
5910 Otherwise TYPE is the name of the atom that denotes the type expected.
5911 If SOURCE is non-nil, get the property on that window instead of from
5912 FRAME. The number 0 denotes the root window.
5913 If DELETE-P is non-nil, delete the property after retrieving it.
5914 If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
5916 On MS Windows, this function accepts but ignores those optional arguments.
5918 Value is nil if FRAME hasn't a property with name PROP or if PROP has
5919 no value of TYPE (always string in the MS Windows case). */)
5920 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
5921 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
5923 struct frame *f = decode_window_system_frame (frame);
5924 Atom prop_atom;
5925 Lisp_Object prop_value = Qnil;
5926 Atom target_type = XA_STRING;
5927 Window target_window = FRAME_X_WINDOW (f);
5928 bool found;
5930 CHECK_STRING (prop);
5932 if (! NILP (source))
5934 CONS_TO_INTEGER (source, Window, target_window);
5935 if (! target_window)
5936 target_window = FRAME_DISPLAY_INFO (f)->root_window;
5939 block_input ();
5940 if (STRINGP (type))
5942 if (strcmp ("AnyPropertyType", SSDATA (type)) == 0)
5943 target_type = AnyPropertyType;
5944 else
5945 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
5948 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
5949 prop_value = x_window_property_intern (f,
5950 target_window,
5951 prop_atom,
5952 target_type,
5953 delete_p,
5954 vector_ret_p,
5955 &found);
5956 if (NILP (prop_value)
5957 && ! found
5958 && NILP (source)
5959 && target_window != FRAME_OUTER_WINDOW (f))
5961 prop_value = x_window_property_intern (f,
5962 FRAME_OUTER_WINDOW (f),
5963 prop_atom,
5964 target_type,
5965 delete_p,
5966 vector_ret_p,
5967 &found);
5971 unblock_input ();
5972 return prop_value;
5975 DEFUN ("x-window-property-attributes", Fx_window_property_attributes, Sx_window_property_attributes,
5976 1, 3, 0,
5977 doc: /* Retrieve metadata about window property PROP on FRAME.
5978 If FRAME is nil or omitted, use the selected frame.
5979 If SOURCE is non-nil, get the property on that window instead of from
5980 FRAME. The number 0 denotes the root window.
5982 Return value is nil if FRAME hasn't a property with name PROP.
5983 Otherwise, the return value is a vector with the following fields:
5985 0. The property type, as an integer. The symbolic name of
5986 the type can be obtained with `x-get-atom-name'.
5987 1. The format of each element; one of 8, 16, or 32.
5988 2. The length of the property, in number of elements. */)
5989 (Lisp_Object prop, Lisp_Object frame, Lisp_Object source)
5991 struct frame *f = decode_window_system_frame (frame);
5992 Window target_window = FRAME_X_WINDOW (f);
5993 Atom prop_atom;
5994 Lisp_Object prop_attr = Qnil;
5995 Atom actual_type;
5996 int actual_format;
5997 unsigned long actual_size, bytes_remaining;
5998 unsigned char *tmp_data = NULL;
5999 int rc;
6001 CHECK_STRING (prop);
6003 if (! NILP (source))
6005 CONS_TO_INTEGER (source, Window, target_window);
6006 if (! target_window)
6007 target_window = FRAME_DISPLAY_INFO (f)->root_window;
6010 block_input ();
6012 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
6013 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
6014 prop_atom, 0, 0, False, AnyPropertyType,
6015 &actual_type, &actual_format, &actual_size,
6016 &bytes_remaining, &tmp_data);
6017 if (rc == Success /* no invalid params */
6018 && actual_format == 0 /* but prop not found */
6019 && NILP (source)
6020 && target_window != FRAME_OUTER_WINDOW (f))
6022 /* analogous behavior to x-window-property: if property isn't found
6023 on the frame's inner window and no alternate window id was
6024 provided, try the frame's outer window. */
6025 target_window = FRAME_OUTER_WINDOW (f);
6026 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
6027 prop_atom, 0, 0, False, AnyPropertyType,
6028 &actual_type, &actual_format, &actual_size,
6029 &bytes_remaining, &tmp_data);
6032 if (rc == Success && actual_format != 0)
6034 XFree (tmp_data);
6036 prop_attr = make_uninit_vector (3);
6037 ASET (prop_attr, 0, make_number (actual_type));
6038 ASET (prop_attr, 1, make_number (actual_format));
6039 ASET (prop_attr, 2, make_number (bytes_remaining / (actual_format >> 3)));
6042 unblock_input ();
6043 return prop_attr;
6046 /***********************************************************************
6047 Tool tips
6048 ***********************************************************************/
6050 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
6051 Lisp_Object, int, int, int *, int *);
6053 /* The frame of a currently visible tooltip. */
6055 Lisp_Object tip_frame;
6057 /* If non-nil, a timer started that hides the last tooltip when it
6058 fires. */
6060 static Lisp_Object tip_timer;
6061 Window tip_window;
6063 /* If non-nil, a vector of 3 elements containing the last args
6064 with which x-show-tip was called. See there. */
6066 static Lisp_Object last_show_tip_args;
6069 static void
6070 unwind_create_tip_frame (Lisp_Object frame)
6072 Lisp_Object deleted;
6074 deleted = unwind_create_frame (frame);
6075 if (EQ (deleted, Qt))
6077 tip_window = None;
6078 tip_frame = Qnil;
6083 /* Create a frame for a tooltip on the display described by DPYINFO.
6084 PARMS is a list of frame parameters. TEXT is the string to
6085 display in the tip frame. Value is the frame.
6087 Note that functions called here, esp. x_default_parameter can
6088 signal errors, for instance when a specified color name is
6089 undefined. We have to make sure that we're in a consistent state
6090 when this happens. */
6092 static Lisp_Object
6093 x_create_tip_frame (struct x_display_info *dpyinfo, Lisp_Object parms)
6095 struct frame *f;
6096 Lisp_Object frame;
6097 Lisp_Object name;
6098 int width, height;
6099 ptrdiff_t count = SPECPDL_INDEX ();
6100 bool face_change_before = face_change;
6101 int x_width = 0, x_height = 0;
6103 if (!dpyinfo->terminal->name)
6104 error ("Terminal is not live, can't create new frames on it");
6106 parms = Fcopy_alist (parms);
6108 /* Get the name of the frame to use for resource lookup. */
6109 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
6110 if (!STRINGP (name)
6111 && !EQ (name, Qunbound)
6112 && !NILP (name))
6113 error ("Invalid frame name--not a string or nil");
6115 frame = Qnil;
6116 f = make_frame (false);
6117 f->wants_modeline = false;
6118 XSETFRAME (frame, f);
6119 record_unwind_protect (unwind_create_tip_frame, frame);
6121 f->terminal = dpyinfo->terminal;
6123 /* By setting the output method, we're essentially saying that
6124 the frame is live, as per FRAME_LIVE_P. If we get a signal
6125 from this point on, x_destroy_window might screw up reference
6126 counts etc. */
6127 f->output_method = output_x_window;
6128 f->output_data.x = xzalloc (sizeof *f->output_data.x);
6129 f->output_data.x->icon_bitmap = -1;
6130 FRAME_FONTSET (f) = -1;
6131 f->output_data.x->scroll_bar_foreground_pixel = -1;
6132 f->output_data.x->scroll_bar_background_pixel = -1;
6133 #if defined (USE_LUCID) && defined (USE_TOOLKIT_SCROLL_BARS)
6134 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
6135 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
6136 #endif /* USE_LUCID && USE_TOOLKIT_SCROLL_BARS */
6137 f->output_data.x->white_relief.pixel = -1;
6138 f->output_data.x->black_relief.pixel = -1;
6140 fset_icon_name (f, Qnil);
6141 FRAME_DISPLAY_INFO (f) = dpyinfo;
6142 f->output_data.x->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
6143 f->output_data.x->explicit_parent = false;
6145 /* These colors will be set anyway later, but it's important
6146 to get the color reference counts right, so initialize them! */
6148 Lisp_Object black;
6150 /* Function x_decode_color can signal an error. Make
6151 sure to initialize color slots so that we won't try
6152 to free colors we haven't allocated. */
6153 FRAME_FOREGROUND_PIXEL (f) = -1;
6154 FRAME_BACKGROUND_PIXEL (f) = -1;
6155 f->output_data.x->cursor_pixel = -1;
6156 f->output_data.x->cursor_foreground_pixel = -1;
6157 f->output_data.x->border_pixel = -1;
6158 f->output_data.x->mouse_pixel = -1;
6160 black = build_string ("black");
6161 FRAME_FOREGROUND_PIXEL (f)
6162 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
6163 FRAME_BACKGROUND_PIXEL (f)
6164 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
6165 f->output_data.x->cursor_pixel
6166 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
6167 f->output_data.x->cursor_foreground_pixel
6168 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
6169 f->output_data.x->border_pixel
6170 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
6171 f->output_data.x->mouse_pixel
6172 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
6175 /* Set the name; the functions to which we pass f expect the name to
6176 be set. */
6177 if (EQ (name, Qunbound) || NILP (name))
6179 fset_name (f, build_string (dpyinfo->x_id_name));
6180 f->explicit_name = false;
6182 else
6184 fset_name (f, name);
6185 f->explicit_name = true;
6186 /* use the frame's title when getting resources for this frame. */
6187 specbind (Qx_resource_name, name);
6190 #ifdef USE_CAIRO
6191 register_font_driver (&ftcrfont_driver, f);
6192 #else
6193 register_font_driver (&xfont_driver, f);
6194 #ifdef HAVE_FREETYPE
6195 #ifdef HAVE_XFT
6196 register_font_driver (&xftfont_driver, f);
6197 #else /* not HAVE_XFT */
6198 register_font_driver (&ftxfont_driver, f);
6199 #endif /* not HAVE_XFT */
6200 #endif /* HAVE_FREETYPE */
6201 #endif /* not USE_CAIRO */
6203 image_cache_refcount =
6204 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
6205 #ifdef GLYPH_DEBUG
6206 dpyinfo_refcount = dpyinfo->reference_count;
6207 #endif /* GLYPH_DEBUG */
6209 x_default_parameter (f, parms, Qfont_backend, Qnil,
6210 "fontBackend", "FontBackend", RES_TYPE_STRING);
6212 /* Extract the window parameters from the supplied values that are
6213 needed to determine window geometry. */
6214 x_default_font_parameter (f, parms);
6216 x_default_parameter (f, parms, Qborder_width, make_number (0),
6217 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
6219 /* This defaults to 2 in order to match xterm. We recognize either
6220 internalBorderWidth or internalBorder (which is what xterm calls
6221 it). */
6222 if (NILP (Fassq (Qinternal_border_width, parms)))
6224 Lisp_Object value;
6226 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
6227 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
6228 if (! EQ (value, Qunbound))
6229 parms = Fcons (Fcons (Qinternal_border_width, value),
6230 parms);
6233 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
6234 "internalBorderWidth", "internalBorderWidth",
6235 RES_TYPE_NUMBER);
6236 x_default_parameter (f, parms, Qright_divider_width, make_number (0),
6237 NULL, NULL, RES_TYPE_NUMBER);
6238 x_default_parameter (f, parms, Qbottom_divider_width, make_number (0),
6239 NULL, NULL, RES_TYPE_NUMBER);
6241 /* Also do the stuff which must be set before the window exists. */
6242 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
6243 "foreground", "Foreground", RES_TYPE_STRING);
6244 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
6245 "background", "Background", RES_TYPE_STRING);
6246 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
6247 "pointerColor", "Foreground", RES_TYPE_STRING);
6248 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
6249 "cursorColor", "Foreground", RES_TYPE_STRING);
6250 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
6251 "borderColor", "BorderColor", RES_TYPE_STRING);
6252 x_default_parameter (f, parms, Qno_special_glyphs, Qnil,
6253 NULL, NULL, RES_TYPE_BOOLEAN);
6255 /* Init faces before x_default_parameter is called for the
6256 scroll-bar-width parameter because otherwise we end up in
6257 init_iterator with a null face cache, which should not happen. */
6258 init_frame_faces (f);
6260 f->output_data.x->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
6262 x_figure_window_size (f, parms, false, &x_width, &x_height);
6265 XSetWindowAttributes attrs;
6266 unsigned long mask;
6267 Atom type = FRAME_DISPLAY_INFO (f)->Xatom_net_window_type_tooltip;
6269 block_input ();
6270 mask = CWBackPixel | CWOverrideRedirect | CWEventMask | CWCursor;
6271 if (DoesSaveUnders (dpyinfo->screen))
6272 mask |= CWSaveUnder;
6274 /* Window managers look at the override-redirect flag to determine
6275 whether or net to give windows a decoration (Xlib spec, chapter
6276 3.2.8). */
6277 attrs.override_redirect = True;
6278 attrs.save_under = True;
6279 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
6280 attrs.cursor =
6281 f->output_data.x->current_cursor
6282 = f->output_data.x->text_cursor;
6283 /* Arrange for getting MapNotify and UnmapNotify events. */
6284 attrs.event_mask = StructureNotifyMask;
6285 tip_window
6286 = FRAME_X_WINDOW (f)
6287 = XCreateWindow (FRAME_X_DISPLAY (f),
6288 FRAME_DISPLAY_INFO (f)->root_window,
6289 /* x, y, width, height */
6290 0, 0, 1, 1,
6291 /* Border. */
6292 f->border_width,
6293 CopyFromParent, InputOutput, CopyFromParent,
6294 mask, &attrs);
6295 initial_set_up_x_back_buffer (f);
6296 XChangeProperty (FRAME_X_DISPLAY (f), tip_window,
6297 FRAME_DISPLAY_INFO (f)->Xatom_net_window_type,
6298 XA_ATOM, 32, PropModeReplace,
6299 (unsigned char *)&type, 1);
6300 unblock_input ();
6303 x_make_gc (f);
6305 x_default_parameter (f, parms, Qauto_raise, Qnil,
6306 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
6307 x_default_parameter (f, parms, Qauto_lower, Qnil,
6308 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
6309 x_default_parameter (f, parms, Qcursor_type, Qbox,
6310 "cursorType", "CursorType", RES_TYPE_SYMBOL);
6311 x_default_parameter (f, parms, Qalpha, Qnil,
6312 "alpha", "Alpha", RES_TYPE_NUMBER);
6314 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
6315 Change will not be effected unless different from the current
6316 FRAME_LINES (f). */
6317 width = FRAME_COLS (f);
6318 height = FRAME_LINES (f);
6319 SET_FRAME_COLS (f, 0);
6320 SET_FRAME_LINES (f, 0);
6321 change_frame_size (f, width, height, true, false, false, false);
6323 /* Add `tooltip' frame parameter's default value. */
6324 if (NILP (Fframe_parameter (frame, Qtooltip)))
6326 AUTO_FRAME_ARG (arg, Qtooltip, Qt);
6327 Fmodify_frame_parameters (frame, arg);
6330 /* FIXME - can this be done in a similar way to normal frames?
6331 https://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00641.html */
6333 /* Set the `display-type' frame parameter before setting up faces. */
6335 Lisp_Object disptype;
6337 if (FRAME_DISPLAY_INFO (f)->n_planes == 1)
6338 disptype = Qmono;
6339 else if (FRAME_DISPLAY_INFO (f)->visual->class == GrayScale
6340 || FRAME_DISPLAY_INFO (f)->visual->class == StaticGray)
6341 disptype = intern ("grayscale");
6342 else
6343 disptype = intern ("color");
6345 if (NILP (Fframe_parameter (frame, Qdisplay_type)))
6347 AUTO_FRAME_ARG (arg, Qdisplay_type, disptype);
6348 Fmodify_frame_parameters (frame, arg);
6352 /* Set up faces after all frame parameters are known. This call
6353 also merges in face attributes specified for new frames.
6355 Frame parameters may be changed if .Xdefaults contains
6356 specifications for the default font. For example, if there is an
6357 `Emacs.default.attributeBackground: pink', the `background-color'
6358 attribute of the frame get's set, which let's the internal border
6359 of the tooltip frame appear in pink. Prevent this. */
6361 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
6363 call2 (Qface_set_after_frame_default, frame, Qnil);
6365 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
6367 AUTO_FRAME_ARG (arg, Qbackground_color, bg);
6368 Fmodify_frame_parameters (frame, arg);
6372 f->no_split = true;
6374 /* Now that the frame will be official, it counts as a reference to
6375 its display and terminal. */
6376 FRAME_DISPLAY_INFO (f)->reference_count++;
6377 f->terminal->reference_count++;
6379 /* It is now ok to make the frame official even if we get an error
6380 below. And the frame needs to be on Vframe_list or making it
6381 visible won't work. */
6382 Vframe_list = Fcons (frame, Vframe_list);
6383 f->can_x_set_window_size = true;
6385 /* Setting attributes of faces of the tooltip frame from resources
6386 and similar will set face_change, which leads to the clearing of
6387 all current matrices. Since this isn't necessary here, avoid it
6388 by resetting face_change to the value it had before we created
6389 the tip frame. */
6390 face_change = face_change_before;
6392 /* Discard the unwind_protect. */
6393 return unbind_to (count, frame);
6397 /* Compute where to display tip frame F. PARMS is the list of frame
6398 parameters for F. DX and DY are specified offsets from the current
6399 location of the mouse. WIDTH and HEIGHT are the width and height
6400 of the tooltip. Return coordinates relative to the root window of
6401 the display in *ROOT_X, and *ROOT_Y. */
6403 static void
6404 compute_tip_xy (struct frame *f, Lisp_Object parms, Lisp_Object dx, Lisp_Object dy, int width, int height, int *root_x, int *root_y)
6406 Lisp_Object left, top, right, bottom;
6407 int win_x, win_y;
6408 Window root, child;
6409 unsigned pmask;
6410 int min_x, min_y, max_x, max_y = -1;
6412 /* User-specified position? */
6413 left = Fcdr (Fassq (Qleft, parms));
6414 top = Fcdr (Fassq (Qtop, parms));
6415 right = Fcdr (Fassq (Qright, parms));
6416 bottom = Fcdr (Fassq (Qbottom, parms));
6418 /* Move the tooltip window where the mouse pointer is. Resize and
6419 show it. */
6420 if ((!INTEGERP (left) && !INTEGERP (right))
6421 || (!INTEGERP (top) && !INTEGERP (bottom)))
6423 Lisp_Object frame, attributes, monitor, geometry;
6425 block_input ();
6426 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_DISPLAY_INFO (f)->root_window,
6427 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
6428 unblock_input ();
6430 XSETFRAME(frame, f);
6431 attributes = Fx_display_monitor_attributes_list (frame);
6433 /* Try to determine the monitor where the mouse pointer is and
6434 its geometry. See bug#22549. */
6435 while (CONSP (attributes))
6437 monitor = XCAR (attributes);
6438 geometry = Fassq (Qgeometry, monitor);
6439 if (CONSP (geometry))
6441 min_x = XINT (Fnth (make_number (1), geometry));
6442 min_y = XINT (Fnth (make_number (2), geometry));
6443 max_x = min_x + XINT (Fnth (make_number (3), geometry));
6444 max_y = min_y + XINT (Fnth (make_number (4), geometry));
6445 if (min_x <= *root_x && *root_x < max_x
6446 && min_y <= *root_y && *root_y < max_y)
6448 break;
6450 max_y = -1;
6453 attributes = XCDR (attributes);
6457 /* It was not possible to determine the monitor's geometry, so we
6458 assign some sane defaults here: */
6459 if ( max_y < 0 )
6461 min_x = 0;
6462 min_y = 0;
6463 max_x = x_display_pixel_width (FRAME_DISPLAY_INFO (f));
6464 max_y = x_display_pixel_height (FRAME_DISPLAY_INFO (f));
6467 if (INTEGERP (top))
6468 *root_y = XINT (top);
6469 else if (INTEGERP (bottom))
6470 *root_y = XINT (bottom) - height;
6471 else if (*root_y + XINT (dy) <= min_y)
6472 *root_y = min_y; /* Can happen for negative dy */
6473 else if (*root_y + XINT (dy) + height <= max_y)
6474 /* It fits below the pointer */
6475 *root_y += XINT (dy);
6476 else if (height + XINT (dy) + min_y <= *root_y)
6477 /* It fits above the pointer. */
6478 *root_y -= height + XINT (dy);
6479 else
6480 /* Put it on the top. */
6481 *root_y = min_y;
6483 if (INTEGERP (left))
6484 *root_x = XINT (left);
6485 else if (INTEGERP (right))
6486 *root_x = XINT (right) - width;
6487 else if (*root_x + XINT (dx) <= min_x)
6488 *root_x = 0; /* Can happen for negative dx */
6489 else if (*root_x + XINT (dx) + width <= max_x)
6490 /* It fits to the right of the pointer. */
6491 *root_x += XINT (dx);
6492 else if (width + XINT (dx) + min_x <= *root_x)
6493 /* It fits to the left of the pointer. */
6494 *root_x -= width + XINT (dx);
6495 else
6496 /* Put it left justified on the screen -- it ought to fit that way. */
6497 *root_x = min_x;
6501 /* Hide tooltip. Delete its frame if DELETE is true. */
6502 static Lisp_Object
6503 x_hide_tip (bool delete)
6505 if (!NILP (tip_timer))
6507 call1 (Qcancel_timer, tip_timer);
6508 tip_timer = Qnil;
6512 if (NILP (tip_frame)
6513 || (!delete && FRAMEP (tip_frame)
6514 && !FRAME_VISIBLE_P (XFRAME (tip_frame))))
6515 return Qnil;
6516 else
6518 ptrdiff_t count;
6519 Lisp_Object was_open = Qnil;
6521 count = SPECPDL_INDEX ();
6522 specbind (Qinhibit_redisplay, Qt);
6523 specbind (Qinhibit_quit, Qt);
6525 #ifdef USE_GTK
6527 /* When using system tooltip, tip_frame is the Emacs frame on
6528 which the tip is shown. */
6529 struct frame *f = XFRAME (tip_frame);
6531 if (FRAME_LIVE_P (f) && xg_hide_tooltip (f))
6533 tip_frame = Qnil;
6534 was_open = Qt;
6537 #endif
6539 if (FRAMEP (tip_frame))
6541 if (delete)
6543 delete_frame (tip_frame, Qnil);
6544 tip_frame = Qnil;
6546 else
6547 x_make_frame_invisible (XFRAME (tip_frame));
6549 was_open = Qt;
6551 #ifdef USE_LUCID
6552 /* Bloodcurdling hack alert: The Lucid menu bar widget's
6553 redisplay procedure is not called when a tip frame over
6554 menu items is unmapped. Redisplay the menu manually... */
6556 Widget w;
6557 struct frame *f = SELECTED_FRAME ();
6558 if (FRAME_X_P (f) && FRAME_LIVE_P (f))
6560 w = f->output_data.x->menubar_widget;
6562 if (!DoesSaveUnders (FRAME_DISPLAY_INFO (f)->screen)
6563 && w != NULL)
6565 block_input ();
6566 xlwmenu_redisplay (w);
6567 unblock_input ();
6571 #endif /* USE_LUCID */
6573 else
6574 tip_frame = Qnil;
6576 return unbind_to (count, was_open);
6580 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
6581 doc: /* Show STRING in a "tooltip" window on frame FRAME.
6582 A tooltip window is a small X window displaying a string.
6584 This is an internal function; Lisp code should call `tooltip-show'.
6586 FRAME nil or omitted means use the selected frame.
6588 PARMS is an optional list of frame parameters which can be used to
6589 change the tooltip's appearance.
6591 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
6592 means use the default timeout of 5 seconds.
6594 If the list of frame parameters PARMS contains a `left' parameter,
6595 display the tooltip at that x-position. If the list of frame parameters
6596 PARMS contains no `left' but a `right' parameter, display the tooltip
6597 right-adjusted at that x-position. Otherwise display it at the
6598 x-position of the mouse, with offset DX added (default is 5 if DX isn't
6599 specified).
6601 Likewise for the y-position: If a `top' frame parameter is specified, it
6602 determines the position of the upper edge of the tooltip window. If a
6603 `bottom' parameter but no `top' frame parameter is specified, it
6604 determines the position of the lower edge of the tooltip window.
6605 Otherwise display the tooltip window at the y-position of the mouse,
6606 with offset DY added (default is -10).
6608 A tooltip's maximum size is specified by `x-max-tooltip-size'.
6609 Text larger than the specified size is clipped. */)
6610 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
6612 struct frame *f, *tip_f;
6613 struct window *w;
6614 int root_x, root_y;
6615 struct buffer *old_buffer;
6616 struct text_pos pos;
6617 int width, height;
6618 int old_windows_or_buffers_changed = windows_or_buffers_changed;
6619 ptrdiff_t count = SPECPDL_INDEX ();
6620 ptrdiff_t count_1;
6621 Lisp_Object window, size;
6622 AUTO_STRING (tip, " *tip*");
6624 specbind (Qinhibit_redisplay, Qt);
6626 CHECK_STRING (string);
6627 if (SCHARS (string) == 0)
6628 string = make_unibyte_string (" ", 1);
6630 f = decode_window_system_frame (frame);
6631 if (NILP (timeout))
6632 timeout = make_number (5);
6633 else
6634 CHECK_NATNUM (timeout);
6636 if (NILP (dx))
6637 dx = make_number (5);
6638 else
6639 CHECK_NUMBER (dx);
6641 if (NILP (dy))
6642 dy = make_number (-10);
6643 else
6644 CHECK_NUMBER (dy);
6646 #ifdef USE_GTK
6647 if (x_gtk_use_system_tooltips)
6649 bool ok;
6651 /* Hide a previous tip, if any. */
6652 Fx_hide_tip ();
6654 block_input ();
6655 ok = xg_prepare_tooltip (f, string, &width, &height);
6656 if (ok)
6658 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
6659 xg_show_tooltip (f, root_x, root_y);
6660 /* This is used in Fx_hide_tip. */
6661 XSETFRAME (tip_frame, f);
6663 unblock_input ();
6664 if (ok) goto start_timer;
6666 #endif /* USE_GTK */
6668 if (NILP (last_show_tip_args))
6669 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
6671 if (FRAMEP (tip_frame) && FRAME_LIVE_P (XFRAME (tip_frame)))
6673 Lisp_Object last_string = AREF (last_show_tip_args, 0);
6674 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
6675 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
6677 if (FRAME_VISIBLE_P (XFRAME (tip_frame))
6678 && EQ (frame, last_frame)
6679 && !NILP (Fequal_including_properties (last_string, string))
6680 && !NILP (Fequal (last_parms, parms)))
6682 /* Only DX and DY have changed. */
6683 tip_f = XFRAME (tip_frame);
6684 if (!NILP (tip_timer))
6686 Lisp_Object timer = tip_timer;
6688 tip_timer = Qnil;
6689 call1 (Qcancel_timer, timer);
6692 block_input ();
6693 compute_tip_xy (tip_f, parms, dx, dy, FRAME_PIXEL_WIDTH (tip_f),
6694 FRAME_PIXEL_HEIGHT (tip_f), &root_x, &root_y);
6695 XMoveWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
6696 root_x, root_y);
6697 unblock_input ();
6699 goto start_timer;
6701 else if (tooltip_reuse_hidden_frame && EQ (frame, last_frame))
6703 bool delete = false;
6704 Lisp_Object tail, elt, parm, last;
6706 /* Check if every parameter in PARMS has the same value in
6707 last_parms unless it should be ignored by means of
6708 Vtooltip_reuse_hidden_frame_parameters. This may destruct
6709 last_parms which, however, will be recreated below. */
6710 for (tail = parms; CONSP (tail); tail = XCDR (tail))
6712 elt = XCAR (tail);
6713 parm = Fcar (elt);
6714 /* The left, top, right and bottom parameters are handled
6715 by compute_tip_xy so they can be ignored here. */
6716 if (!EQ (parm, Qleft) && !EQ (parm, Qtop)
6717 && !EQ (parm, Qright) && !EQ (parm, Qbottom))
6719 last = Fassq (parm, last_parms);
6720 if (NILP (Fequal (Fcdr (elt), Fcdr (last))))
6722 /* We lost, delete the old tooltip. */
6723 delete = true;
6724 break;
6726 else
6727 last_parms = call2 (Qassq_delete_all, parm, last_parms);
6729 else
6730 last_parms = call2 (Qassq_delete_all, parm, last_parms);
6733 /* Now check if every parameter in what is left of last_parms
6734 with a non-nil value has an association in PARMS unless it
6735 should be ignored by means of
6736 Vtooltip_reuse_hidden_frame_parameters. */
6737 for (tail = last_parms; CONSP (tail); tail = XCDR (tail))
6739 elt = XCAR (tail);
6740 parm = Fcar (elt);
6741 if (!EQ (parm, Qleft) && !EQ (parm, Qtop) && !EQ (parm, Qright)
6742 && !EQ (parm, Qbottom) && !NILP (Fcdr (elt)))
6744 /* We lost, delete the old tooltip. */
6745 delete = true;
6746 break;
6750 x_hide_tip (delete);
6752 else
6753 x_hide_tip (true);
6755 else
6756 x_hide_tip (true);
6758 ASET (last_show_tip_args, 0, string);
6759 ASET (last_show_tip_args, 1, frame);
6760 ASET (last_show_tip_args, 2, parms);
6762 if (!FRAMEP (tip_frame) || !FRAME_LIVE_P (XFRAME (tip_frame)))
6764 /* Add default values to frame parameters. */
6765 if (NILP (Fassq (Qname, parms)))
6766 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
6767 if (NILP (Fassq (Qinternal_border_width, parms)))
6768 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
6769 if (NILP (Fassq (Qborder_width, parms)))
6770 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
6771 if (NILP (Fassq (Qborder_color, parms)))
6772 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
6773 if (NILP (Fassq (Qbackground_color, parms)))
6774 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
6775 parms);
6777 /* Create a frame for the tooltip, and record it in the global
6778 variable tip_frame. */
6779 if (NILP (tip_frame = x_create_tip_frame (FRAME_DISPLAY_INFO (f), parms)))
6780 /* Creating the tip frame failed. */
6781 return unbind_to (count, Qnil);
6784 tip_f = XFRAME (tip_frame);
6785 window = FRAME_ROOT_WINDOW (tip_f);
6786 set_window_buffer (window, Fget_buffer_create (tip), false, false);
6787 w = XWINDOW (window);
6788 w->pseudo_window_p = true;
6790 /* Set up the frame's root window. Note: The following code does not
6791 try to size the window or its frame correctly. Its only purpose is
6792 to make the subsequent text size calculations work. The right
6793 sizes should get installed when the toolkit gets back to us. */
6794 w->left_col = 0;
6795 w->top_line = 0;
6796 w->pixel_left = 0;
6797 w->pixel_top = 0;
6799 if (CONSP (Vx_max_tooltip_size)
6800 && RANGED_INTEGERP (1, XCAR (Vx_max_tooltip_size), INT_MAX)
6801 && RANGED_INTEGERP (1, XCDR (Vx_max_tooltip_size), INT_MAX))
6803 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
6804 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
6806 else
6808 w->total_cols = 80;
6809 w->total_lines = 40;
6812 w->pixel_width = w->total_cols * FRAME_COLUMN_WIDTH (tip_f);
6813 w->pixel_height = w->total_lines * FRAME_LINE_HEIGHT (tip_f);
6814 FRAME_TOTAL_COLS (tip_f) = w->total_cols;
6815 adjust_frame_glyphs (tip_f);
6817 /* Insert STRING into root window's buffer and fit the frame to the
6818 buffer. */
6819 count_1 = SPECPDL_INDEX ();
6820 old_buffer = current_buffer;
6821 set_buffer_internal_1 (XBUFFER (w->contents));
6822 bset_truncate_lines (current_buffer, Qnil);
6823 specbind (Qinhibit_read_only, Qt);
6824 specbind (Qinhibit_modification_hooks, Qt);
6825 specbind (Qinhibit_point_motion_hooks, Qt);
6826 Ferase_buffer ();
6827 Finsert (1, &string);
6828 clear_glyph_matrix (w->desired_matrix);
6829 clear_glyph_matrix (w->current_matrix);
6830 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
6831 try_window (window, pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6832 /* Calculate size of tooltip window. */
6833 size = Fwindow_text_pixel_size (window, Qnil, Qnil, Qnil,
6834 make_number (w->pixel_height), Qnil);
6835 /* Add the frame's internal border to calculated size. */
6836 width = XINT (Fcar (size)) + 2 * FRAME_INTERNAL_BORDER_WIDTH (tip_f);
6837 height = XINT (Fcdr (size)) + 2 * FRAME_INTERNAL_BORDER_WIDTH (tip_f);
6839 /* Calculate position of tooltip frame. */
6840 compute_tip_xy (tip_f, parms, dx, dy, width, height, &root_x, &root_y);
6842 /* Show tooltip frame. */
6843 block_input ();
6844 XMoveResizeWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
6845 root_x, root_y, width, height);
6846 XMapRaised (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f));
6847 unblock_input ();
6849 w->must_be_updated_p = true;
6850 update_single_window (w);
6851 set_buffer_internal_1 (old_buffer);
6852 unbind_to (count_1, Qnil);
6853 windows_or_buffers_changed = old_windows_or_buffers_changed;
6855 start_timer:
6856 /* Let the tip disappear after timeout seconds. */
6857 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
6858 intern ("x-hide-tip"));
6860 return unbind_to (count, Qnil);
6864 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
6865 doc: /* Hide the current tooltip window, if there is any.
6866 Value is t if tooltip was open, nil otherwise. */)
6867 (void)
6869 return x_hide_tip (!tooltip_reuse_hidden_frame);
6872 DEFUN ("x-double-buffered-p", Fx_double_buffered_p, Sx_double_buffered_p,
6873 0, 1, 0,
6874 doc: /* Return t if FRAME is being double buffered. */)
6875 (Lisp_Object frame)
6877 struct frame *f = decode_live_frame (frame);
6878 return FRAME_X_DOUBLE_BUFFERED_P (f) ? Qt : Qnil;
6882 /***********************************************************************
6883 File selection dialog
6884 ***********************************************************************/
6886 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
6887 Sx_uses_old_gtk_dialog,
6888 0, 0, 0,
6889 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
6890 (void)
6892 #ifdef USE_GTK
6893 if (use_dialog_box
6894 && use_file_dialog
6895 && window_system_available (SELECTED_FRAME ())
6896 && xg_uses_old_file_dialog ())
6897 return Qt;
6898 #endif
6899 return Qnil;
6903 #ifdef USE_MOTIF
6904 /* Callback for "OK" and "Cancel" on file selection dialog. */
6906 static void
6907 file_dialog_cb (Widget widget, XtPointer client_data, XtPointer call_data)
6909 int *result = client_data;
6910 XmAnyCallbackStruct *cb = call_data;
6911 *result = cb->reason;
6915 /* Callback for unmapping a file selection dialog. This is used to
6916 capture the case where a dialog is closed via a window manager's
6917 closer button, for example. Using a XmNdestroyCallback didn't work
6918 in this case. */
6920 static void
6921 file_dialog_unmap_cb (Widget widget, XtPointer client_data, XtPointer call_data)
6923 int *result = client_data;
6924 *result = XmCR_CANCEL;
6927 static void
6928 clean_up_file_dialog (void *arg)
6930 Widget dialog = arg;
6932 /* Clean up. */
6933 block_input ();
6934 XtUnmanageChild (dialog);
6935 XtDestroyWidget (dialog);
6936 x_menu_set_in_use (false);
6937 unblock_input ();
6941 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
6942 doc: /* Read file name, prompting with PROMPT in directory DIR.
6943 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6944 selection box, if specified. If MUSTMATCH is non-nil, the returned file
6945 or directory must exist.
6947 This function is only defined on NS, MS Windows, and X Windows with the
6948 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6949 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories.
6950 On Windows 7 and later, the file selection dialog "remembers" the last
6951 directory where the user selected a file, and will open that directory
6952 instead of DIR on subsequent invocations of this function with the same
6953 value of DIR as in previous invocations; this is standard Windows behavior. */)
6954 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename,
6955 Lisp_Object mustmatch, Lisp_Object only_dir_p)
6957 int result;
6958 struct frame *f = SELECTED_FRAME ();
6959 Lisp_Object file = Qnil;
6960 Lisp_Object decoded_file;
6961 Widget dialog, text, help;
6962 Arg al[10];
6963 int ac = 0;
6964 XmString dir_xmstring, pattern_xmstring;
6965 ptrdiff_t count = SPECPDL_INDEX ();
6967 check_window_system (f);
6969 if (popup_activated ())
6970 error ("Trying to use a menu from within a menu-entry");
6972 CHECK_STRING (prompt);
6973 CHECK_STRING (dir);
6975 /* Prevent redisplay. */
6976 specbind (Qinhibit_redisplay, Qt);
6978 block_input ();
6980 /* Create the dialog with PROMPT as title, using DIR as initial
6981 directory and using "*" as pattern. */
6982 dir = Fexpand_file_name (dir, Qnil);
6983 dir_xmstring = XmStringCreateLocalized (SSDATA (dir));
6984 pattern_xmstring = XmStringCreateLocalized ("*");
6986 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
6987 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
6988 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
6989 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
6990 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
6991 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
6992 "fsb", al, ac);
6993 XmStringFree (dir_xmstring);
6994 XmStringFree (pattern_xmstring);
6996 /* Add callbacks for OK and Cancel. */
6997 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
6998 (XtPointer) &result);
6999 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
7000 (XtPointer) &result);
7001 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
7002 (XtPointer) &result);
7004 /* Remove the help button since we can't display help. */
7005 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
7006 XtUnmanageChild (help);
7008 /* Mark OK button as default. */
7009 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
7010 XmNshowAsDefault, True, NULL);
7012 /* If MUSTMATCH is non-nil, disable the file entry field of the
7013 dialog, so that the user must select a file from the files list
7014 box. We can't remove it because we wouldn't have a way to get at
7015 the result file name, then. */
7016 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
7017 if (!NILP (mustmatch))
7019 Widget label;
7020 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
7021 XtSetSensitive (text, False);
7022 XtSetSensitive (label, False);
7025 /* Manage the dialog, so that list boxes get filled. */
7026 XtManageChild (dialog);
7028 if (STRINGP (default_filename))
7030 XmString default_xmstring;
7031 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
7032 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
7034 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
7035 XmTextFieldReplace (wtext, 0, last_pos,
7036 (SSDATA (Ffile_name_nondirectory (default_filename))));
7038 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
7039 must include the path for this to work. */
7041 default_xmstring = XmStringCreateLocalized (SSDATA (default_filename));
7043 if (XmListItemExists (list, default_xmstring))
7045 int item_pos = XmListItemPos (list, default_xmstring);
7046 /* Select the item and scroll it into view. */
7047 XmListSelectPos (list, item_pos, True);
7048 XmListSetPos (list, item_pos);
7051 XmStringFree (default_xmstring);
7054 record_unwind_protect_ptr (clean_up_file_dialog, dialog);
7056 /* Process events until the user presses Cancel or OK. */
7057 x_menu_set_in_use (true);
7058 result = 0;
7059 while (result == 0)
7061 XEvent event;
7062 x_menu_wait_for_event (0);
7063 XtAppNextEvent (Xt_app_con, &event);
7064 if (event.type == KeyPress
7065 && FRAME_X_DISPLAY (f) == event.xkey.display)
7067 KeySym keysym = XLookupKeysym (&event.xkey, 0);
7069 /* Pop down on C-g. */
7070 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
7071 XtUnmanageChild (dialog);
7074 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
7077 /* Get the result. */
7078 if (result == XmCR_OK)
7080 XmString text_string;
7081 String data;
7083 XtVaGetValues (dialog, XmNtextString, &text_string, NULL);
7084 XmStringGetLtoR (text_string, XmFONTLIST_DEFAULT_TAG, &data);
7085 XmStringFree (text_string);
7086 file = build_string (data);
7087 XtFree (data);
7089 else
7090 file = Qnil;
7092 unblock_input ();
7094 /* Make "Cancel" equivalent to C-g. */
7095 if (NILP (file))
7096 quit ();
7098 decoded_file = DECODE_FILE (file);
7100 return unbind_to (count, decoded_file);
7103 #endif /* USE_MOTIF */
7105 #ifdef USE_GTK
7107 static void
7108 clean_up_dialog (void)
7110 x_menu_set_in_use (false);
7113 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
7114 doc: /* Read file name, prompting with PROMPT in directory DIR.
7115 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
7116 selection box, if specified. If MUSTMATCH is non-nil, the returned file
7117 or directory must exist.
7119 This function is only defined on NS, MS Windows, and X Windows with the
7120 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
7121 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories.
7122 On Windows 7 and later, the file selection dialog "remembers" the last
7123 directory where the user selected a file, and will open that directory
7124 instead of DIR on subsequent invocations of this function with the same
7125 value of DIR as in previous invocations; this is standard Windows behavior. */)
7126 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
7128 struct frame *f = SELECTED_FRAME ();
7129 char *fn;
7130 Lisp_Object file = Qnil;
7131 Lisp_Object decoded_file;
7132 ptrdiff_t count = SPECPDL_INDEX ();
7133 char *cdef_file;
7135 check_window_system (f);
7137 if (popup_activated ())
7138 error ("Trying to use a menu from within a menu-entry");
7139 else
7140 x_menu_set_in_use (true);
7142 CHECK_STRING (prompt);
7143 CHECK_STRING (dir);
7145 /* Prevent redisplay. */
7146 specbind (Qinhibit_redisplay, Qt);
7147 record_unwind_protect_void (clean_up_dialog);
7149 block_input ();
7151 if (STRINGP (default_filename))
7152 cdef_file = SSDATA (default_filename);
7153 else
7154 cdef_file = SSDATA (dir);
7156 fn = xg_get_file_name (f, SSDATA (prompt), cdef_file,
7157 ! NILP (mustmatch),
7158 ! NILP (only_dir_p));
7160 if (fn)
7162 file = build_string (fn);
7163 xfree (fn);
7166 unblock_input ();
7168 /* Make "Cancel" equivalent to C-g. */
7169 if (NILP (file))
7170 quit ();
7172 decoded_file = DECODE_FILE (file);
7174 return unbind_to (count, decoded_file);
7178 #ifdef HAVE_FREETYPE
7180 DEFUN ("x-select-font", Fx_select_font, Sx_select_font, 0, 2, 0,
7181 doc: /* Read a font using a GTK dialog.
7182 Return either a font spec (for GTK versions >= 3.2) or a string
7183 containing a GTK-style font name.
7185 FRAME is the frame on which to pop up the font chooser. If omitted or
7186 nil, it defaults to the selected frame. */)
7187 (Lisp_Object frame, Lisp_Object ignored)
7189 struct frame *f = decode_window_system_frame (frame);
7190 Lisp_Object font;
7191 Lisp_Object font_param;
7192 char *default_name = NULL;
7193 ptrdiff_t count = SPECPDL_INDEX ();
7195 if (popup_activated ())
7196 error ("Trying to use a menu from within a menu-entry");
7197 else
7198 x_menu_set_in_use (true);
7200 /* Prevent redisplay. */
7201 specbind (Qinhibit_redisplay, Qt);
7202 record_unwind_protect_void (clean_up_dialog);
7204 block_input ();
7206 XSETFONT (font, FRAME_FONT (f));
7207 font_param = Ffont_get (font, QCname);
7208 if (STRINGP (font_param))
7209 default_name = xlispstrdup (font_param);
7210 else
7212 font_param = Fframe_parameter (frame, Qfont_parameter);
7213 if (STRINGP (font_param))
7214 default_name = xlispstrdup (font_param);
7217 font = xg_get_font (f, default_name);
7218 xfree (default_name);
7220 unblock_input ();
7222 if (NILP (font))
7223 quit ();
7225 return unbind_to (count, font);
7227 #endif /* HAVE_FREETYPE */
7229 #endif /* USE_GTK */
7232 /***********************************************************************
7233 Keyboard
7234 ***********************************************************************/
7236 #ifdef HAVE_XKB
7237 #include <X11/XKBlib.h>
7238 #include <X11/keysym.h>
7239 #endif
7241 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
7242 Sx_backspace_delete_keys_p, 0, 1, 0,
7243 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
7244 FRAME nil means use the selected frame.
7245 Value is t if we know that both keys are present, and are mapped to the
7246 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
7247 present and mapped to the usual X keysyms. */)
7248 (Lisp_Object frame)
7250 #ifndef HAVE_XKB
7251 return Qlambda;
7252 #else
7253 XkbDescPtr kb;
7254 struct frame *f = decode_window_system_frame (frame);
7255 Display *dpy = FRAME_X_DISPLAY (f);
7256 Lisp_Object have_keys;
7257 int major, minor, op, event, error_code;
7259 block_input ();
7261 /* Check library version in case we're dynamically linked. */
7262 major = XkbMajorVersion;
7263 minor = XkbMinorVersion;
7264 if (!XkbLibraryVersion (&major, &minor))
7266 unblock_input ();
7267 return Qlambda;
7270 /* Check that the server supports XKB. */
7271 major = XkbMajorVersion;
7272 minor = XkbMinorVersion;
7273 if (!XkbQueryExtension (dpy, &op, &event, &error_code, &major, &minor))
7275 unblock_input ();
7276 return Qlambda;
7279 /* In this code we check that the keyboard has physical keys with names
7280 that start with BKSP (Backspace) and DELE (Delete), and that they
7281 generate keysym XK_BackSpace and XK_Delete respectively.
7282 This function is used to test if normal-erase-is-backspace should be
7283 turned on.
7284 An alternative approach would be to just check if XK_BackSpace and
7285 XK_Delete are mapped to any key. But if any of those are mapped to
7286 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
7287 user doesn't know about it, it is better to return false here.
7288 It is more obvious to the user what to do if she/he has two keys
7289 clearly marked with names/symbols and one key does something not
7290 expected (i.e. she/he then tries the other).
7291 The cases where Backspace/Delete is mapped to some other key combination
7292 are rare, and in those cases, normal-erase-is-backspace can be turned on
7293 manually. */
7295 have_keys = Qnil;
7296 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
7297 if (kb)
7299 int delete_keycode = 0, backspace_keycode = 0, i;
7301 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
7303 for (i = kb->min_key_code;
7304 (i < kb->max_key_code
7305 && (delete_keycode == 0 || backspace_keycode == 0));
7306 ++i)
7308 /* The XKB symbolic key names can be seen most easily in
7309 the PS file generated by `xkbprint -label name
7310 $DISPLAY'. */
7311 if (memcmp ("DELE", kb->names->keys[i].name, 4) == 0)
7312 delete_keycode = i;
7313 else if (memcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
7314 backspace_keycode = i;
7317 XkbFreeNames (kb, 0, True);
7320 /* As of libX11-1.6.2, XkbGetMap manual says that you should use
7321 XkbFreeClientMap to free the data returned by XkbGetMap. But
7322 this function just frees the data referenced from KB and not
7323 KB itself. To free KB as well, call XkbFreeKeyboard. */
7324 XkbFreeKeyboard (kb, XkbAllMapComponentsMask, True);
7326 if (delete_keycode
7327 && backspace_keycode
7328 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
7329 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
7330 have_keys = Qt;
7332 unblock_input ();
7333 return have_keys;
7334 #endif
7339 /***********************************************************************
7340 Printing
7341 ***********************************************************************/
7343 #ifdef USE_CAIRO
7344 DEFUN ("x-export-frames", Fx_export_frames, Sx_export_frames, 0, 2, 0,
7345 doc: /* Return image data of FRAMES in TYPE format.
7346 FRAMES should be nil (the selected frame), a frame, or a list of
7347 frames (each of which corresponds to one page). Each frame should be
7348 visible. Optional arg TYPE should be either `pdf' (default), `png',
7349 `postscript', or `svg'. Supported types are determined by the
7350 compile-time configuration of cairo. */)
7351 (Lisp_Object frames, Lisp_Object type)
7353 Lisp_Object rest, tmp;
7354 cairo_surface_type_t surface_type;
7356 if (!CONSP (frames))
7357 frames = list1 (frames);
7359 tmp = Qnil;
7360 for (rest = frames; CONSP (rest); rest = XCDR (rest))
7362 struct frame *f = decode_window_system_frame (XCAR (rest));
7363 Lisp_Object frame;
7365 XSETFRAME (frame, f);
7366 if (!FRAME_VISIBLE_P (f))
7367 error ("Frames to be exported must be visible.");
7368 tmp = Fcons (frame, tmp);
7370 frames = Fnreverse (tmp);
7372 #ifdef CAIRO_HAS_PDF_SURFACE
7373 if (NILP (type) || EQ (type, Qpdf))
7374 surface_type = CAIRO_SURFACE_TYPE_PDF;
7375 else
7376 #endif
7377 #ifdef CAIRO_HAS_PNG_FUNCTIONS
7378 if (EQ (type, Qpng))
7380 if (!NILP (XCDR (frames)))
7381 error ("PNG export cannot handle multiple frames.");
7382 surface_type = CAIRO_SURFACE_TYPE_IMAGE;
7384 else
7385 #endif
7386 #ifdef CAIRO_HAS_PS_SURFACE
7387 if (EQ (type, Qpostscript))
7388 surface_type = CAIRO_SURFACE_TYPE_PS;
7389 else
7390 #endif
7391 #ifdef CAIRO_HAS_SVG_SURFACE
7392 if (EQ (type, Qsvg))
7394 /* For now, we stick to SVG 1.1. */
7395 if (!NILP (XCDR (frames)))
7396 error ("SVG export cannot handle multiple frames.");
7397 surface_type = CAIRO_SURFACE_TYPE_SVG;
7399 else
7400 #endif
7401 error ("Unsupported export type");
7403 return x_cr_export_frames (frames, surface_type);
7406 #ifdef USE_GTK
7407 DEFUN ("x-page-setup-dialog", Fx_page_setup_dialog, Sx_page_setup_dialog, 0, 0, 0,
7408 doc: /* Pop up a page setup dialog.
7409 The current page setup can be obtained using `x-get-page-setup'. */)
7410 (void)
7412 block_input ();
7413 xg_page_setup_dialog ();
7414 unblock_input ();
7416 return Qnil;
7419 DEFUN ("x-get-page-setup", Fx_get_page_setup, Sx_get_page_setup, 0, 0, 0,
7420 doc: /* Return the value of the current page setup.
7421 The return value is an alist containing the following keys:
7423 orientation: page orientation (symbol `portrait', `landscape',
7424 `reverse-portrait', or `reverse-landscape').
7425 width, height: page width/height in points not including margins.
7426 left-margin, right-margin, top-margin, bottom-margin: print margins,
7427 which is the parts of the page that the printer cannot print
7428 on, in points.
7430 The paper width can be obtained as the sum of width, left-margin, and
7431 right-margin values if the page orientation is `portrait' or
7432 `reverse-portrait'. Otherwise, it is the sum of width, top-margin,
7433 and bottom-margin values. Likewise, the paper height is the sum of
7434 height, top-margin, and bottom-margin values if the page orientation
7435 is `portrait' or `reverse-portrait'. Otherwise, it is the sum of
7436 height, left-margin, and right-margin values. */)
7437 (void)
7439 Lisp_Object result;
7441 block_input ();
7442 result = xg_get_page_setup ();
7443 unblock_input ();
7445 return result;
7448 DEFUN ("x-print-frames-dialog", Fx_print_frames_dialog, Sx_print_frames_dialog, 0, 1, "",
7449 doc: /* Pop up a print dialog to print the current contents of FRAMES.
7450 FRAMES should be nil (the selected frame), a frame, or a list of
7451 frames (each of which corresponds to one page). Each frame should be
7452 visible. */)
7453 (Lisp_Object frames)
7455 Lisp_Object rest, tmp;
7456 int count;
7458 if (!CONSP (frames))
7459 frames = list1 (frames);
7461 tmp = Qnil;
7462 for (rest = frames; CONSP (rest); rest = XCDR (rest))
7464 struct frame *f = decode_window_system_frame (XCAR (rest));
7465 Lisp_Object frame;
7467 XSETFRAME (frame, f);
7468 if (!FRAME_VISIBLE_P (f))
7469 error ("Frames to be printed must be visible.");
7470 tmp = Fcons (frame, tmp);
7472 frames = Fnreverse (tmp);
7474 /* Make sure the current matrices are up-to-date. */
7475 count = SPECPDL_INDEX ();
7476 specbind (Qredisplay_dont_pause, Qt);
7477 redisplay_preserve_echo_area (32);
7478 unbind_to (count, Qnil);
7480 block_input ();
7481 xg_print_frames_dialog (frames);
7482 unblock_input ();
7484 return Qnil;
7486 #endif /* USE_GTK */
7487 #endif /* USE_CAIRO */
7490 /***********************************************************************
7491 Initialization
7492 ***********************************************************************/
7494 /* Keep this list in the same order as frame_parms in frame.c.
7495 Use 0 for unsupported frame parameters. */
7497 frame_parm_handler x_frame_parm_handlers[] =
7499 x_set_autoraise,
7500 x_set_autolower,
7501 x_set_background_color,
7502 x_set_border_color,
7503 x_set_border_width,
7504 x_set_cursor_color,
7505 x_set_cursor_type,
7506 x_set_font,
7507 x_set_foreground_color,
7508 x_set_icon_name,
7509 x_set_icon_type,
7510 x_set_internal_border_width,
7511 x_set_right_divider_width,
7512 x_set_bottom_divider_width,
7513 x_set_menu_bar_lines,
7514 x_set_mouse_color,
7515 x_explicitly_set_name,
7516 x_set_scroll_bar_width,
7517 x_set_scroll_bar_height,
7518 x_set_title,
7519 x_set_unsplittable,
7520 x_set_vertical_scroll_bars,
7521 x_set_horizontal_scroll_bars,
7522 x_set_visibility,
7523 x_set_tool_bar_lines,
7524 x_set_scroll_bar_foreground,
7525 x_set_scroll_bar_background,
7526 x_set_screen_gamma,
7527 x_set_line_spacing,
7528 x_set_left_fringe,
7529 x_set_right_fringe,
7530 x_set_wait_for_wm,
7531 x_set_fullscreen,
7532 x_set_font_backend,
7533 x_set_alpha,
7534 x_set_sticky,
7535 x_set_tool_bar_position,
7536 x_set_inhibit_double_buffering,
7537 x_set_undecorated,
7538 x_set_parent_frame,
7539 x_set_skip_taskbar,
7540 x_set_no_focus_on_map,
7541 x_set_no_accept_focus,
7542 x_set_z_group,
7543 x_set_override_redirect,
7544 x_set_no_special_glyphs,
7547 void
7548 syms_of_xfns (void)
7550 DEFSYM (Qundefined_color, "undefined-color");
7551 DEFSYM (Qcompound_text, "compound-text");
7552 DEFSYM (Qcancel_timer, "cancel-timer");
7553 DEFSYM (Qfont_parameter, "font-parameter");
7554 DEFSYM (Qmono, "mono");
7555 DEFSYM (Qassq_delete_all, "assq-delete-all");
7557 #ifdef USE_CAIRO
7558 DEFSYM (Qpdf, "pdf");
7560 DEFSYM (Qorientation, "orientation");
7561 DEFSYM (Qtop_margin, "top-margin");
7562 DEFSYM (Qbottom_margin, "bottom-margin");
7563 DEFSYM (Qportrait, "portrait");
7564 DEFSYM (Qlandscape, "landscape");
7565 DEFSYM (Qreverse_portrait, "reverse-portrait");
7566 DEFSYM (Qreverse_landscape, "reverse-landscape");
7567 #endif
7569 Fput (Qundefined_color, Qerror_conditions,
7570 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
7571 Fput (Qundefined_color, Qerror_message,
7572 build_pure_c_string ("Undefined color"));
7574 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
7575 doc: /* The shape of the pointer when over text.
7576 Changing the value does not affect existing frames
7577 unless you set the mouse color. */);
7578 Vx_pointer_shape = Qnil;
7580 #if false /* This doesn't really do anything. */
7581 DEFVAR_LISP ("x-nontext-pointer-shape", Vx_nontext_pointer_shape,
7582 doc: /* The shape of the pointer when not over text.
7583 This variable takes effect when you create a new frame
7584 or when you set the mouse color. */);
7585 #endif
7586 Vx_nontext_pointer_shape = Qnil;
7588 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
7589 doc: /* The shape of the pointer when Emacs is busy.
7590 This variable takes effect when you create a new frame
7591 or when you set the mouse color. */);
7592 Vx_hourglass_pointer_shape = Qnil;
7594 #if false /* This doesn't really do anything. */
7595 DEFVAR_LISP ("x-mode-pointer-shape", Vx_mode_pointer_shape,
7596 doc: /* The shape of the pointer when over the mode line.
7597 This variable takes effect when you create a new frame
7598 or when you set the mouse color. */);
7599 #endif
7600 Vx_mode_pointer_shape = Qnil;
7602 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
7603 Vx_sensitive_text_pointer_shape,
7604 doc: /* The shape of the pointer when over mouse-sensitive text.
7605 This variable takes effect when you create a new frame
7606 or when you set the mouse color. */);
7607 Vx_sensitive_text_pointer_shape = Qnil;
7609 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
7610 Vx_window_horizontal_drag_shape,
7611 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
7612 This variable takes effect when you create a new frame
7613 or when you set the mouse color. */);
7614 Vx_window_horizontal_drag_shape = Qnil;
7616 DEFVAR_LISP ("x-window-vertical-drag-cursor",
7617 Vx_window_vertical_drag_shape,
7618 doc: /* Pointer shape to use for indicating a window can be dragged vertically.
7619 This variable takes effect when you create a new frame
7620 or when you set the mouse color. */);
7621 Vx_window_vertical_drag_shape = Qnil;
7623 DEFVAR_LISP ("x-window-left-edge-cursor",
7624 Vx_window_left_edge_shape,
7625 doc: /* Pointer shape indicating a left x-window edge can be dragged.
7626 This variable takes effect when you create a new frame
7627 or when you set the mouse color. */);
7628 Vx_window_left_edge_shape = Qnil;
7630 DEFVAR_LISP ("x-window-top-left-corner-cursor",
7631 Vx_window_top_left_corner_shape,
7632 doc: /* Pointer shape indicating a top left x-window corner can be dragged.
7633 This variable takes effect when you create a new frame
7634 or when you set the mouse color. */);
7635 Vx_window_top_left_corner_shape = Qnil;
7637 DEFVAR_LISP ("x-window-top-edge-cursor",
7638 Vx_window_top_edge_shape,
7639 doc: /* Pointer shape indicating a top x-window edge can be dragged.
7640 This variable takes effect when you create a new frame
7641 or when you set the mouse color. */);
7642 Vx_window_top_edge_shape = Qnil;
7644 DEFVAR_LISP ("x-window-top-right-corner-cursor",
7645 Vx_window_top_right_corner_shape,
7646 doc: /* Pointer shape indicating a top right x-window corner can be dragged.
7647 This variable takes effect when you create a new frame
7648 or when you set the mouse color. */);
7649 Vx_window_top_right_corner_shape = Qnil;
7651 DEFVAR_LISP ("x-window-right-edge-cursor",
7652 Vx_window_right_edge_shape,
7653 doc: /* Pointer shape indicating a right x-window edge can be dragged.
7654 This variable takes effect when you create a new frame
7655 or when you set the mouse color. */);
7656 Vx_window_right_edge_shape = Qnil;
7658 DEFVAR_LISP ("x-window-bottom-right-corner-cursor",
7659 Vx_window_bottom_right_corner_shape,
7660 doc: /* Pointer shape indicating a bottom right x-window corner can be dragged.
7661 This variable takes effect when you create a new frame
7662 or when you set the mouse color. */);
7663 Vx_window_bottom_right_corner_shape = Qnil;
7665 DEFVAR_LISP ("x-window-bottom-edge-cursor",
7666 Vx_window_bottom_edge_shape,
7667 doc: /* Pointer shape indicating a bottom x-window edge can be dragged.
7668 This variable takes effect when you create a new frame
7669 or when you set the mouse color. */);
7670 Vx_window_bottom_edge_shape = Qnil;
7672 DEFVAR_LISP ("x-window-bottom-left-corner-cursor",
7673 Vx_window_bottom_left_corner_shape,
7674 doc: /* Pointer shape indicating a bottom left x-window corner can be dragged.
7675 This variable takes effect when you create a new frame
7676 or when you set the mouse color. */);
7677 Vx_window_bottom_left_corner_shape = Qnil;
7679 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
7680 doc: /* A string indicating the foreground color of the cursor box. */);
7681 Vx_cursor_fore_pixel = Qnil;
7683 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
7684 doc: /* Maximum size for tooltips.
7685 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
7686 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
7688 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
7689 doc: /* Non-nil if no X window manager is in use.
7690 Emacs doesn't try to figure this out; this is always nil
7691 unless you set it to something else. */);
7692 /* We don't have any way to find this out, so set it to nil
7693 and maybe the user would like to set it to t. */
7694 Vx_no_window_manager = Qnil;
7696 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
7697 Vx_pixel_size_width_font_regexp,
7698 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
7700 Since Emacs gets width of a font matching with this regexp from
7701 PIXEL_SIZE field of the name, font finding mechanism gets faster for
7702 such a font. This is especially effective for such large fonts as
7703 Chinese, Japanese, and Korean. */);
7704 Vx_pixel_size_width_font_regexp = Qnil;
7706 /* This is not ifdef:ed, so other builds than GTK can customize it. */
7707 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", x_gtk_use_old_file_dialog,
7708 doc: /* Non-nil means prompt with the old GTK file selection dialog.
7709 If nil or if the file selection dialog is not available, the new GTK file
7710 chooser is used instead. To turn off all file dialogs set the
7711 variable `use-file-dialog'. */);
7712 x_gtk_use_old_file_dialog = false;
7714 DEFVAR_BOOL ("x-gtk-show-hidden-files", x_gtk_show_hidden_files,
7715 doc: /* If non-nil, the GTK file chooser will by default show hidden files.
7716 Note that this is just the default, there is a toggle button on the file
7717 chooser to show or not show hidden files on a case by case basis. */);
7718 x_gtk_show_hidden_files = false;
7720 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", x_gtk_file_dialog_help_text,
7721 doc: /* If non-nil, the GTK file chooser will show additional help text.
7722 If more space for files in the file chooser dialog is wanted, set this to nil
7723 to turn the additional text off. */);
7724 x_gtk_file_dialog_help_text = true;
7726 DEFVAR_BOOL ("x-gtk-use-system-tooltips", x_gtk_use_system_tooltips,
7727 doc: /* If non-nil with a Gtk+ built Emacs, the Gtk+ tooltip is used.
7728 Otherwise use Emacs own tooltip implementation.
7729 When using Gtk+ tooltips, the tooltip face is not used. */);
7730 x_gtk_use_system_tooltips = true;
7732 /* Tell Emacs about this window system. */
7733 Fprovide (Qx, Qnil);
7735 #ifdef USE_X_TOOLKIT
7736 Fprovide (intern_c_string ("x-toolkit"), Qnil);
7737 #ifdef USE_MOTIF
7738 Fprovide (intern_c_string ("motif"), Qnil);
7740 DEFVAR_LISP ("motif-version-string", Vmotif_version_string,
7741 doc: /* Version info for LessTif/Motif. */);
7742 Vmotif_version_string = build_string (XmVERSION_STRING);
7743 #endif /* USE_MOTIF */
7744 #endif /* USE_X_TOOLKIT */
7746 #ifdef USE_GTK
7747 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
7748 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
7749 But for a user it is a toolkit for X, and indeed, configure
7750 accepts --with-x-toolkit=gtk. */
7751 Fprovide (intern_c_string ("x-toolkit"), Qnil);
7752 Fprovide (intern_c_string ("gtk"), Qnil);
7753 Fprovide (intern_c_string ("move-toolbar"), Qnil);
7755 DEFVAR_LISP ("gtk-version-string", Vgtk_version_string,
7756 doc: /* Version info for GTK+. */);
7758 char gtk_version[sizeof ".." + 3 * INT_STRLEN_BOUND (int)];
7759 int len = sprintf (gtk_version, "%d.%d.%d",
7760 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
7761 Vgtk_version_string = make_pure_string (gtk_version, len, len, false);
7763 #endif /* USE_GTK */
7765 #ifdef USE_CAIRO
7766 Fprovide (intern_c_string ("cairo"), Qnil);
7768 DEFVAR_LISP ("cairo-version-string", Vcairo_version_string,
7769 doc: /* Version info for cairo. */);
7771 char cairo_version[sizeof ".." + 3 * INT_STRLEN_BOUND (int)];
7772 int len = sprintf (cairo_version, "%d.%d.%d",
7773 CAIRO_VERSION_MAJOR, CAIRO_VERSION_MINOR,
7774 CAIRO_VERSION_MICRO);
7775 Vcairo_version_string = make_pure_string (cairo_version, len, len, false);
7777 #endif
7779 /* X window properties. */
7780 defsubr (&Sx_change_window_property);
7781 defsubr (&Sx_delete_window_property);
7782 defsubr (&Sx_window_property);
7783 defsubr (&Sx_window_property_attributes);
7785 defsubr (&Sxw_display_color_p);
7786 defsubr (&Sx_display_grayscale_p);
7787 defsubr (&Sxw_color_defined_p);
7788 defsubr (&Sxw_color_values);
7789 defsubr (&Sx_server_max_request_size);
7790 defsubr (&Sx_server_vendor);
7791 defsubr (&Sx_server_version);
7792 defsubr (&Sx_display_pixel_width);
7793 defsubr (&Sx_display_pixel_height);
7794 defsubr (&Sx_display_mm_width);
7795 defsubr (&Sx_display_mm_height);
7796 defsubr (&Sx_display_screens);
7797 defsubr (&Sx_display_planes);
7798 defsubr (&Sx_display_color_cells);
7799 defsubr (&Sx_display_visual_class);
7800 defsubr (&Sx_display_backing_store);
7801 defsubr (&Sx_display_save_under);
7802 defsubr (&Sx_display_monitor_attributes_list);
7803 defsubr (&Sx_frame_geometry);
7804 defsubr (&Sx_frame_edges);
7805 defsubr (&Sx_frame_list_z_order);
7806 defsubr (&Sx_frame_restack);
7807 defsubr (&Sx_mouse_absolute_pixel_position);
7808 defsubr (&Sx_set_mouse_absolute_pixel_position);
7809 defsubr (&Sx_wm_set_size_hint);
7810 defsubr (&Sx_create_frame);
7811 defsubr (&Sx_open_connection);
7812 defsubr (&Sx_close_connection);
7813 defsubr (&Sx_display_list);
7814 defsubr (&Sx_synchronize);
7815 defsubr (&Sx_backspace_delete_keys_p);
7817 defsubr (&Sx_show_tip);
7818 defsubr (&Sx_hide_tip);
7819 defsubr (&Sx_double_buffered_p);
7820 tip_timer = Qnil;
7821 staticpro (&tip_timer);
7822 tip_frame = Qnil;
7823 staticpro (&tip_frame);
7825 last_show_tip_args = Qnil;
7826 staticpro (&last_show_tip_args);
7828 defsubr (&Sx_uses_old_gtk_dialog);
7829 #if defined (USE_MOTIF) || defined (USE_GTK)
7830 defsubr (&Sx_file_dialog);
7831 #endif
7833 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
7834 defsubr (&Sx_select_font);
7835 #endif
7837 #ifdef USE_CAIRO
7838 defsubr (&Sx_export_frames);
7839 #ifdef USE_GTK
7840 defsubr (&Sx_page_setup_dialog);
7841 defsubr (&Sx_get_page_setup);
7842 defsubr (&Sx_print_frames_dialog);
7843 #endif
7844 #endif