Minor ABLOCKS_BUSY cleanups in alloc.c
[emacs.git] / src / xfns.c
blob35e2a236f89cc4ae851b36381e1afbc79a8267d9
1 /* Functions for the X window system.
3 Copyright (C) 1989, 1992-2016 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 <http://www.gnu.org/licenses/>. */
20 #include <config.h>
21 #include <stdio.h>
22 #include <math.h>
23 #include <unistd.h>
25 #include "lisp.h"
26 #include "xterm.h"
27 #include "frame.h"
28 #include "window.h"
29 #include "buffer.h"
30 #include "dispextern.h"
31 #include "keyboard.h"
32 #include "blockinput.h"
33 #include "charset.h"
34 #include "coding.h"
35 #include "termhooks.h"
36 #include "font.h"
38 #include <sys/types.h>
39 #include <sys/stat.h>
41 #include "bitmaps/gray.xbm"
42 #include "xsettings.h"
44 #ifdef HAVE_XRANDR
45 #include <X11/extensions/Xrandr.h>
46 #endif
47 #ifdef HAVE_XINERAMA
48 #include <X11/extensions/Xinerama.h>
49 #endif
51 #ifdef USE_GTK
52 #include "gtkutil.h"
53 #endif
55 #ifdef USE_X_TOOLKIT
56 #include <X11/Shell.h>
58 #ifndef USE_MOTIF
59 #ifdef HAVE_XAW3D
60 #include <X11/Xaw3d/Paned.h>
61 #include <X11/Xaw3d/Label.h>
62 #else /* !HAVE_XAW3D */
63 #include <X11/Xaw/Paned.h>
64 #include <X11/Xaw/Label.h>
65 #endif /* HAVE_XAW3D */
66 #endif /* USE_MOTIF */
68 #ifdef USG
69 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
70 #include <X11/Xos.h>
71 #define USG
72 #ifdef USG /* Pacify gcc -Wunused-macros. */
73 #endif
74 #else
75 #include <X11/Xos.h>
76 #endif
78 #include "widget.h"
80 #include "../lwlib/lwlib.h"
82 #ifdef USE_MOTIF
83 #include <Xm/Xm.h>
84 #include <Xm/DialogS.h>
85 #include <Xm/FileSB.h>
86 #include <Xm/List.h>
87 #include <Xm/TextF.h>
88 #endif
90 #ifdef USE_LUCID
91 #include "../lwlib/xlwmenu.h"
92 #endif
94 #if !defined (NO_EDITRES)
95 #define HACK_EDITRES
96 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
97 #endif /* not defined NO_EDITRES */
99 /* Unique id counter for widgets created by the Lucid Widget Library. */
101 extern LWLIB_ID widget_id_tick;
103 #ifdef USE_MOTIF
105 #endif /* USE_MOTIF */
107 #endif /* USE_X_TOOLKIT */
109 #ifdef USE_GTK
111 #endif /* USE_GTK */
113 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
115 static ptrdiff_t image_cache_refcount;
116 #ifdef GLYPH_DEBUG
117 static int dpyinfo_refcount;
118 #endif
120 static struct x_display_info *x_display_info_for_name (Lisp_Object);
122 /* Let the user specify an X display with a Lisp object.
123 OBJECT may be nil, a frame or a terminal object.
124 nil stands for the selected frame--or, if that is not an X frame,
125 the first X display on the list. */
127 struct x_display_info *
128 check_x_display_info (Lisp_Object object)
130 struct x_display_info *dpyinfo = NULL;
132 if (NILP (object))
134 struct frame *sf = XFRAME (selected_frame);
136 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
137 dpyinfo = FRAME_DISPLAY_INFO (sf);
138 else if (x_display_list != 0)
139 dpyinfo = x_display_list;
140 else
141 error ("X windows are not in use or not initialized");
143 else if (TERMINALP (object))
145 struct terminal *t = decode_live_terminal (object);
147 if (t->type != output_x_window)
148 error ("Terminal %d is not an X display", t->id);
150 dpyinfo = t->display_info.x;
152 else if (STRINGP (object))
153 dpyinfo = x_display_info_for_name (object);
154 else
156 struct frame *f = decode_window_system_frame (object);
157 dpyinfo = FRAME_DISPLAY_INFO (f);
160 return dpyinfo;
163 /* Return the screen positions and offsets of frame F.
164 Store the offsets between FRAME_OUTER_WINDOW and the containing
165 window manager window into LEFT_OFFSET_X, RIGHT_OFFSET_X,
166 TOP_OFFSET_Y and BOTTOM_OFFSET_Y.
167 Store the offsets between FRAME_X_WINDOW and the containing
168 window manager window into X_PIXELS_DIFF and Y_PIXELS_DIFF.
169 Store the screen positions of frame F into XPTR and YPTR.
170 These are the positions of the containing window manager window,
171 not Emacs's own window. */
172 void
173 x_real_pos_and_offsets (struct frame *f,
174 int *left_offset_x,
175 int *right_offset_x,
176 int *top_offset_y,
177 int *bottom_offset_y,
178 int *x_pixels_diff,
179 int *y_pixels_diff,
180 int *xptr,
181 int *yptr,
182 int *outer_border)
184 int win_x = 0, win_y = 0, outer_x = 0, outer_y = 0;
185 int real_x = 0, real_y = 0;
186 bool had_errors = false;
187 Window win = f->output_data.x->parent_desc;
188 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
189 long max_len = 400;
190 Atom target_type = XA_CARDINAL;
191 unsigned int ow = 0, oh = 0;
192 unsigned int fw = 0, fh = 0;
193 unsigned int bw = 0;
194 /* We resort to XCB if possible because there are several X calls
195 here which require responses from the server but do not have data
196 dependencies between them. Using XCB lets us pipeline requests,
197 whereas with Xlib we must wait for each answer before sending the
198 next request.
200 For a non-local display, the round-trip time could be a few tens
201 of milliseconds, depending on the network distance. It doesn't
202 take a lot of those to add up to a noticeable hesitation in
203 responding to user actions. */
204 #ifdef USE_XCB
205 xcb_connection_t *xcb_conn = dpyinfo->xcb_connection;
206 xcb_get_property_cookie_t prop_cookie;
207 xcb_get_geometry_cookie_t outer_geom_cookie;
208 bool sent_requests = false;
209 #else
210 Atom actual_type;
211 unsigned long actual_size, bytes_remaining;
212 int rc, actual_format;
213 Display *dpy = FRAME_X_DISPLAY (f);
214 unsigned char *tmp_data = NULL;
215 #endif
217 if (x_pixels_diff) *x_pixels_diff = 0;
218 if (y_pixels_diff) *y_pixels_diff = 0;
219 if (left_offset_x) *left_offset_x = 0;
220 if (top_offset_y) *top_offset_y = 0;
221 if (right_offset_x) *right_offset_x = 0;
222 if (bottom_offset_y) *bottom_offset_y = 0;
223 if (xptr) *xptr = 0;
224 if (yptr) *yptr = 0;
225 if (outer_border) *outer_border = 0;
227 if (win == dpyinfo->root_window)
228 win = FRAME_OUTER_WINDOW (f);
230 block_input ();
232 #ifndef USE_XCB
233 /* If we're using XCB, all errors are checked for on each call. */
234 x_catch_errors (dpy);
235 #endif
237 /* This loop traverses up the containment tree until we hit the root
238 window. Window managers may intersect many windows between our window
239 and the root window. The window we find just before the root window
240 should be the outer WM window. */
241 for (;;)
243 Window wm_window, rootw;
245 #ifdef USE_XCB
246 xcb_query_tree_cookie_t query_tree_cookie;
247 xcb_query_tree_reply_t *query_tree;
249 query_tree_cookie = xcb_query_tree (xcb_conn, win);
250 query_tree = xcb_query_tree_reply (xcb_conn, query_tree_cookie, NULL);
251 if (query_tree == NULL)
252 had_errors = true;
253 else
255 wm_window = query_tree->parent;
256 rootw = query_tree->root;
257 free (query_tree);
259 #else
260 Window *tmp_children;
261 unsigned int tmp_nchildren;
262 int success;
264 success = XQueryTree (dpy, win, &rootw,
265 &wm_window, &tmp_children, &tmp_nchildren);
267 had_errors = x_had_errors_p (dpy);
269 /* Don't free tmp_children if XQueryTree failed. */
270 if (! success)
271 break;
273 XFree (tmp_children);
274 #endif
276 if (had_errors || wm_window == rootw)
277 break;
279 win = wm_window;
282 if (! had_errors)
284 #ifdef USE_XCB
285 xcb_get_geometry_cookie_t geom_cookie;
286 xcb_translate_coordinates_cookie_t trans_cookie;
287 xcb_translate_coordinates_cookie_t outer_trans_cookie;
289 xcb_translate_coordinates_reply_t *trans;
290 xcb_get_geometry_reply_t *geom;
291 #else
292 Window child, rootw;
293 unsigned int ign;
294 #endif
296 #ifdef USE_XCB
297 /* Fire off the requests that don't have data dependencies.
299 Once we've done this, we must collect the results for each
300 one before returning, even if other errors are detected,
301 making the other responses moot. */
302 geom_cookie = xcb_get_geometry (xcb_conn, win);
304 trans_cookie =
305 xcb_translate_coordinates (xcb_conn,
306 /* From-window, to-window. */
307 FRAME_DISPLAY_INFO (f)->root_window,
308 FRAME_X_WINDOW (f),
310 /* From-position. */
311 0, 0);
312 if (FRAME_X_WINDOW (f) != FRAME_OUTER_WINDOW (f))
313 outer_trans_cookie =
314 xcb_translate_coordinates (xcb_conn,
315 /* From-window, to-window. */
316 FRAME_DISPLAY_INFO (f)->root_window,
317 FRAME_OUTER_WINDOW (f),
319 /* From-position. */
320 0, 0);
321 if (right_offset_x || bottom_offset_y)
322 outer_geom_cookie = xcb_get_geometry (xcb_conn,
323 FRAME_OUTER_WINDOW (f));
325 if (dpyinfo->root_window == f->output_data.x->parent_desc)
326 /* Try _NET_FRAME_EXTENTS if our parent is the root window. */
327 prop_cookie = xcb_get_property (xcb_conn, 0, win,
328 dpyinfo->Xatom_net_frame_extents,
329 target_type, 0, max_len);
331 sent_requests = true;
332 #endif
334 /* Get the real coordinates for the WM window upper left corner */
335 #ifdef USE_XCB
336 geom = xcb_get_geometry_reply (xcb_conn, geom_cookie, NULL);
337 if (geom)
339 real_x = geom->x;
340 real_y = geom->y;
341 ow = geom->width;
342 oh = geom->height;
343 bw = geom->border_width;
344 free (geom);
346 else
347 had_errors = true;
348 #else
349 XGetGeometry (dpy, win,
350 &rootw, &real_x, &real_y, &ow, &oh, &bw, &ign);
351 #endif
353 /* Translate real coordinates to coordinates relative to our
354 window. For our window, the upper left corner is 0, 0.
355 Since the upper left corner of the WM window is outside
356 our window, win_x and win_y will be negative:
358 ------------------ ---> x
359 | title |
360 | ----------------- v y
361 | | our window
363 Since we don't care about the child window corresponding to
364 the actual coordinates, we can send zero to get the offsets
365 and compute the resulting coordinates below. This reduces
366 the data dependencies between calls and lets us pipeline the
367 requests better in the XCB case. */
368 #ifdef USE_XCB
369 trans = xcb_translate_coordinates_reply (xcb_conn, trans_cookie, NULL);
370 if (trans)
372 win_x = trans->dst_x;
373 win_y = trans->dst_y;
374 free (trans);
376 else
377 had_errors = true;
378 #else
379 XTranslateCoordinates (dpy,
381 /* From-window, to-window. */
382 FRAME_DISPLAY_INFO (f)->root_window,
383 FRAME_X_WINDOW (f),
385 /* From-position, to-position. */
386 0, 0, &win_x, &win_y,
388 /* Child of win. */
389 &child);
390 #endif
392 win_x += real_x;
393 win_y += real_y;
395 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
397 outer_x = win_x;
398 outer_y = win_y;
400 else
402 #ifdef USE_XCB
403 xcb_translate_coordinates_reply_t *outer_trans;
405 outer_trans = xcb_translate_coordinates_reply (xcb_conn,
406 outer_trans_cookie,
407 NULL);
408 if (outer_trans)
410 outer_x = outer_trans->dst_x;
411 outer_y = outer_trans->dst_y;
412 free (outer_trans);
414 else
415 had_errors = true;
416 #else
417 XTranslateCoordinates (dpy,
419 /* From-window, to-window. */
420 FRAME_DISPLAY_INFO (f)->root_window,
421 FRAME_OUTER_WINDOW (f),
423 /* From-position, to-position. */
424 0, 0, &outer_x, &outer_y,
426 /* Child of win. */
427 &child);
428 #endif
430 outer_x += real_x;
431 outer_y += real_y;
434 #ifndef USE_XCB
435 had_errors = x_had_errors_p (dpy);
436 #endif
439 if (dpyinfo->root_window == f->output_data.x->parent_desc)
441 /* Try _NET_FRAME_EXTENTS if our parent is the root window. */
442 #ifdef USE_XCB
443 /* Make sure we didn't get an X error early and skip sending the
444 request. */
445 if (sent_requests)
447 xcb_get_property_reply_t *prop;
449 prop = xcb_get_property_reply (xcb_conn, prop_cookie, NULL);
450 if (prop)
452 if (prop->type == target_type
453 && prop->format == 32
454 && (xcb_get_property_value_length (prop)
455 == 4 * sizeof (int32_t)))
457 int32_t *fe = xcb_get_property_value (prop);
459 outer_x = -fe[0];
460 outer_y = -fe[2];
461 real_x -= fe[0];
462 real_y -= fe[2];
464 free (prop);
466 /* Xlib version doesn't set had_errors here. Intentional or bug? */
468 #else
469 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_frame_extents,
470 0, max_len, False, target_type,
471 &actual_type, &actual_format, &actual_size,
472 &bytes_remaining, &tmp_data);
474 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
475 && actual_size == 4 && actual_format == 32)
477 long *fe = (long *)tmp_data;
479 outer_x = -fe[0];
480 outer_y = -fe[2];
481 real_x -= fe[0];
482 real_y -= fe[2];
485 if (tmp_data) XFree (tmp_data);
486 #endif
489 if (right_offset_x || bottom_offset_y)
491 #ifdef USE_XCB
492 /* Make sure we didn't get an X error early and skip sending the
493 request. */
494 if (sent_requests)
496 xcb_get_geometry_reply_t *outer_geom;
498 outer_geom = xcb_get_geometry_reply (xcb_conn, outer_geom_cookie,
499 NULL);
500 if (outer_geom)
502 fw = outer_geom->width;
503 fh = outer_geom->height;
504 free (outer_geom);
506 else
507 had_errors = true;
509 #else
510 int xy_ign;
511 unsigned int ign;
512 Window rootw;
514 XGetGeometry (dpy, FRAME_OUTER_WINDOW (f),
515 &rootw, &xy_ign, &xy_ign, &fw, &fh, &ign, &ign);
516 #endif
519 #ifndef USE_XCB
520 x_uncatch_errors ();
521 #endif
523 unblock_input ();
525 if (had_errors) return;
527 if (x_pixels_diff) *x_pixels_diff = -win_x;
528 if (y_pixels_diff) *y_pixels_diff = -win_y;
530 if (left_offset_x) *left_offset_x = -outer_x;
531 if (top_offset_y) *top_offset_y = -outer_y;
533 if (xptr) *xptr = real_x;
534 if (yptr) *yptr = real_y;
536 if (outer_border) *outer_border = bw;
538 if (right_offset_x) *right_offset_x = ow - fw + outer_x;
539 if (bottom_offset_y) *bottom_offset_y = oh - fh + outer_y;
542 /* Store the screen positions of frame F into XPTR and YPTR.
543 These are the positions of the containing window manager window,
544 not Emacs's own window. */
546 void
547 x_real_positions (struct frame *f, int *xptr, int *yptr)
549 x_real_pos_and_offsets (f, NULL, NULL, NULL, NULL, NULL, NULL, xptr, yptr,
550 NULL);
554 /* Get the mouse position in frame relative coordinates. */
556 void
557 x_relative_mouse_position (struct frame *f, int *x, int *y)
559 Window root, dummy_window;
560 int dummy;
562 eassert (FRAME_X_P (f));
564 block_input ();
566 XQueryPointer (FRAME_X_DISPLAY (f),
567 DefaultRootWindow (FRAME_X_DISPLAY (f)),
569 /* The root window which contains the pointer. */
570 &root,
572 /* Window pointer is on, not used */
573 &dummy_window,
575 /* The position on that root window. */
576 x, y,
578 /* x/y in dummy_window coordinates, not used. */
579 &dummy, &dummy,
581 /* Modifier keys and pointer buttons, about which
582 we don't care. */
583 (unsigned int *) &dummy);
585 XTranslateCoordinates (FRAME_X_DISPLAY (f),
587 /* From-window, to-window. */
588 FRAME_DISPLAY_INFO (f)->root_window,
589 FRAME_X_WINDOW (f),
591 /* From-position, to-position. */
592 *x, *y, x, y,
594 /* Child of win. */
595 &dummy_window);
597 unblock_input ();
600 /* Gamma-correct COLOR on frame F. */
602 void
603 gamma_correct (struct frame *f, XColor *color)
605 if (f->gamma)
607 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
608 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
609 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
614 /* Decide if color named COLOR_NAME is valid for use on frame F. If
615 so, return the RGB values in COLOR. If ALLOC_P,
616 allocate the color. Value is false if COLOR_NAME is invalid, or
617 no color could be allocated. */
619 bool
620 x_defined_color (struct frame *f, const char *color_name,
621 XColor *color, bool alloc_p)
623 bool success_p = false;
624 Colormap cmap = FRAME_X_COLORMAP (f);
626 block_input ();
627 #ifdef USE_GTK
628 success_p = xg_check_special_colors (f, color_name, color);
629 #endif
630 if (!success_p)
631 success_p = x_parse_color (f, color_name, color) != 0;
632 if (success_p && alloc_p)
633 success_p = x_alloc_nearest_color (f, cmap, color);
634 unblock_input ();
636 return success_p;
640 /* Return the pixel color value for color COLOR_NAME on frame F. If F
641 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
642 Signal an error if color can't be allocated. */
644 static int
645 x_decode_color (struct frame *f, Lisp_Object color_name, int mono_color)
647 XColor cdef;
649 CHECK_STRING (color_name);
651 #if false /* Don't do this. It's wrong when we're not using the default
652 colormap, it makes freeing difficult, and it's probably not
653 an important optimization. */
654 if (strcmp (SDATA (color_name), "black") == 0)
655 return BLACK_PIX_DEFAULT (f);
656 else if (strcmp (SDATA (color_name), "white") == 0)
657 return WHITE_PIX_DEFAULT (f);
658 #endif
660 /* Return MONO_COLOR for monochrome frames. */
661 if (FRAME_DISPLAY_INFO (f)->n_planes == 1)
662 return mono_color;
664 /* x_defined_color is responsible for coping with failures
665 by looking for a near-miss. */
666 if (x_defined_color (f, SSDATA (color_name), &cdef, true))
667 return cdef.pixel;
669 signal_error ("Undefined color", color_name);
674 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
675 the previous value of that parameter, NEW_VALUE is the new value.
676 See also the comment of wait_for_wm in struct x_output. */
678 static void
679 x_set_wait_for_wm (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
681 f->output_data.x->wait_for_wm = !NILP (new_value);
684 static void
685 x_set_tool_bar_position (struct frame *f,
686 Lisp_Object new_value,
687 Lisp_Object old_value)
689 Lisp_Object choice = list4 (Qleft, Qright, Qtop, Qbottom);
691 if (!NILP (Fmemq (new_value, choice)))
693 #ifdef USE_GTK
694 if (!EQ (new_value, old_value))
696 xg_change_toolbar_position (f, new_value);
697 fset_tool_bar_position (f, new_value);
699 #else
700 if (!EQ (new_value, Qtop))
701 error ("The only supported tool bar position is top");
702 #endif
704 else
705 wrong_choice (choice, new_value);
708 #ifdef USE_GTK
710 /* Set icon from FILE for frame F. By using GTK functions the icon
711 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
713 bool
714 xg_set_icon (struct frame *f, Lisp_Object file)
716 bool result = false;
717 Lisp_Object found;
719 found = x_find_image_file (file);
721 if (! NILP (found))
723 GdkPixbuf *pixbuf;
724 GError *err = NULL;
725 char *filename = SSDATA (ENCODE_FILE (found));
726 block_input ();
728 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
730 if (pixbuf)
732 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
733 pixbuf);
734 g_object_unref (pixbuf);
736 result = true;
738 else
739 g_error_free (err);
741 unblock_input ();
744 return result;
747 bool
748 xg_set_icon_from_xpm_data (struct frame *f, const char **data)
750 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data (data);
752 if (!pixbuf)
753 return false;
755 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), pixbuf);
756 g_object_unref (pixbuf);
757 return true;
759 #endif /* USE_GTK */
762 /* Functions called only from `x_set_frame_param'
763 to set individual parameters.
765 If FRAME_X_WINDOW (f) is 0,
766 the frame is being created and its X-window does not exist yet.
767 In that case, just record the parameter's new value
768 in the standard place; do not attempt to change the window. */
770 static void
771 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
773 struct x_output *x = f->output_data.x;
774 unsigned long fg, old_fg;
776 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
777 old_fg = FRAME_FOREGROUND_PIXEL (f);
778 FRAME_FOREGROUND_PIXEL (f) = fg;
780 if (FRAME_X_WINDOW (f) != 0)
782 Display *dpy = FRAME_X_DISPLAY (f);
784 block_input ();
785 XSetForeground (dpy, x->normal_gc, fg);
786 XSetBackground (dpy, x->reverse_gc, fg);
788 if (x->cursor_pixel == old_fg)
790 unload_color (f, x->cursor_pixel);
791 x->cursor_pixel = x_copy_color (f, fg);
792 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
795 unblock_input ();
797 update_face_from_frame_parameter (f, Qforeground_color, arg);
799 if (FRAME_VISIBLE_P (f))
800 redraw_frame (f);
803 unload_color (f, old_fg);
806 static void
807 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
809 struct x_output *x = f->output_data.x;
810 unsigned long bg;
812 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
813 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
814 FRAME_BACKGROUND_PIXEL (f) = bg;
816 if (FRAME_X_WINDOW (f) != 0)
818 Display *dpy = FRAME_X_DISPLAY (f);
820 block_input ();
821 XSetBackground (dpy, x->normal_gc, bg);
822 XSetForeground (dpy, x->reverse_gc, bg);
823 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
824 XSetForeground (dpy, x->cursor_gc, bg);
826 #ifdef USE_GTK
827 xg_set_background_color (f, bg);
828 #endif
830 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
831 toolkit scroll bars. */
833 Lisp_Object bar;
834 for (bar = FRAME_SCROLL_BARS (f);
835 !NILP (bar);
836 bar = XSCROLL_BAR (bar)->next)
838 Window window = XSCROLL_BAR (bar)->x_window;
839 XSetWindowBackground (dpy, window, bg);
842 #endif /* USE_TOOLKIT_SCROLL_BARS */
844 unblock_input ();
845 update_face_from_frame_parameter (f, Qbackground_color, arg);
847 if (FRAME_VISIBLE_P (f))
848 redraw_frame (f);
852 /* This array must stay in sync with the mouse_cursor_types array below! */
853 enum mouse_cursor {
854 mouse_cursor_text,
855 mouse_cursor_nontext,
856 mouse_cursor_hourglass,
857 mouse_cursor_mode,
858 mouse_cursor_hand,
859 mouse_cursor_horizontal_drag,
860 mouse_cursor_vertical_drag,
861 mouse_cursor_max
864 struct mouse_cursor_types {
865 /* Printable name for error messages (optional). */
866 const char *name;
868 /* Lisp variable controlling the cursor shape. */
869 /* FIXME: A couple of these variables are defined in the C code but
870 are not actually accessible from Lisp. They should probably be
871 made accessible or removed. */
872 Lisp_Object *shape_var_ptr;
874 /* The default shape. */
875 int default_shape;
878 /* This array must stay in sync with enum mouse_cursor above! */
879 static const struct mouse_cursor_types mouse_cursor_types[] = {
880 { "text", &Vx_pointer_shape, XC_xterm },
881 { "nontext", &Vx_nontext_pointer_shape, XC_left_ptr },
882 { "hourglass", &Vx_hourglass_pointer_shape, XC_watch },
883 { "modeline", &Vx_mode_pointer_shape, XC_xterm },
884 { NULL, &Vx_sensitive_text_pointer_shape, XC_hand2 },
885 { NULL, &Vx_window_horizontal_drag_shape, XC_sb_h_double_arrow },
886 { NULL, &Vx_window_vertical_drag_shape, XC_sb_v_double_arrow },
889 struct mouse_cursor_data {
890 /* Last index for which XCreateFontCursor has been called, and thus
891 the last index for which x_request_serial[] is valid. */
892 int last_cursor_create_request;
894 /* Last index for which an X error event was received in response to
895 attempting to create the cursor. */
896 int error_cursor;
898 /* Cursor numbers chosen. */
899 unsigned int cursor_num[mouse_cursor_max];
901 /* Allocated Cursor values, or zero for failed attempts. */
902 Cursor cursor[mouse_cursor_max];
904 /* X serial numbers for the first request sent by XCreateFontCursor.
905 Note that there may be more than one request sent. */
906 unsigned long x_request_serial[mouse_cursor_max];
908 /* If an error has been received, a pointer to where the current
909 error-message text is stored. */
910 char *error_string;
913 static void
914 x_set_mouse_color_handler (Display *dpy, XErrorEvent *event,
915 char *error_string, void *data)
917 struct mouse_cursor_data *cursor_data = data;
918 int i;
920 cursor_data->error_cursor = -1;
921 cursor_data->error_string = error_string;
922 for (i = 0; i < cursor_data->last_cursor_create_request; i++)
924 if (event->serial >= cursor_data->x_request_serial[i])
925 cursor_data->error_cursor = i;
927 if (cursor_data->error_cursor >= 0)
928 /* If we failed to allocate it, don't try to free it. */
929 cursor_data->cursor[cursor_data->error_cursor] = 0;
932 static void
933 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
935 struct x_output *x = f->output_data.x;
936 Display *dpy = FRAME_X_DISPLAY (f);
937 struct mouse_cursor_data cursor_data = { -1, -1 };
938 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
939 unsigned long mask_color = FRAME_BACKGROUND_PIXEL (f);
940 int i;
942 /* Don't let pointers be invisible. */
943 if (mask_color == pixel)
945 x_free_colors (f, &pixel, 1);
946 pixel = x_copy_color (f, FRAME_FOREGROUND_PIXEL (f));
949 unload_color (f, x->mouse_pixel);
950 x->mouse_pixel = pixel;
952 for (i = 0; i < mouse_cursor_max; i++)
954 Lisp_Object shape_var = *mouse_cursor_types[i].shape_var_ptr;
955 if (!NILP (shape_var))
957 CHECK_TYPE_RANGED_INTEGER (unsigned, shape_var);
958 cursor_data.cursor_num[i] = XINT (shape_var);
960 else
961 cursor_data.cursor_num[i] = mouse_cursor_types[i].default_shape;
964 block_input ();
966 /* It's not okay to crash if the user selects a screwy cursor. */
967 x_catch_errors_with_handler (dpy, x_set_mouse_color_handler, &cursor_data);
969 for (i = 0; i < mouse_cursor_max; i++)
971 cursor_data.x_request_serial[i] = XNextRequest (dpy);
972 cursor_data.last_cursor_create_request = i;
973 cursor_data.cursor[i] = XCreateFontCursor (dpy,
974 cursor_data.cursor_num[i]);
977 /* Now sync up and process all received errors from cursor
978 creation. */
979 if (x_had_errors_p (dpy))
981 const char *bad_cursor_name = NULL;
982 /* Bounded by X_ERROR_MESSAGE_SIZE in xterm.c. */
983 size_t message_length = strlen (cursor_data.error_string);
984 char *xmessage = alloca (1 + message_length);
985 memcpy (xmessage, cursor_data.error_string, message_length);
987 x_uncatch_errors ();
989 /* Free any successfully created cursors. */
990 for (i = 0; i < mouse_cursor_max; i++)
991 if (cursor_data.cursor[i] != 0)
992 XFreeCursor (dpy, cursor_data.cursor[i]);
994 /* This should only be able to fail if the server's serial
995 number tracking is broken. */
996 if (cursor_data.error_cursor >= 0)
997 bad_cursor_name = mouse_cursor_types[cursor_data.error_cursor].name;
998 if (bad_cursor_name)
999 error ("bad %s pointer cursor: %s", bad_cursor_name, xmessage);
1000 else
1001 error ("can't set cursor shape: %s", xmessage);
1004 x_uncatch_errors_after_check ();
1007 XColor colors[2]; /* 0=foreground, 1=background */
1009 colors[0].pixel = x->mouse_pixel;
1010 colors[1].pixel = mask_color;
1011 x_query_colors (f, colors, 2);
1013 for (i = 0; i < mouse_cursor_max; i++)
1014 XRecolorCursor (dpy, cursor_data.cursor[i], &colors[0], &colors[1]);
1017 if (FRAME_X_WINDOW (f) != 0)
1019 f->output_data.x->current_cursor = cursor_data.cursor[mouse_cursor_text];
1020 XDefineCursor (dpy, FRAME_X_WINDOW (f),
1021 f->output_data.x->current_cursor);
1024 #define INSTALL_CURSOR(FIELD, SHORT_INDEX) \
1025 eassert (x->FIELD != cursor_data.cursor[mouse_cursor_ ## SHORT_INDEX]); \
1026 if (x->FIELD != 0) \
1027 XFreeCursor (dpy, x->FIELD); \
1028 x->FIELD = cursor_data.cursor[mouse_cursor_ ## SHORT_INDEX];
1030 INSTALL_CURSOR (text_cursor, text);
1031 INSTALL_CURSOR (nontext_cursor, nontext);
1032 INSTALL_CURSOR (hourglass_cursor, hourglass);
1033 INSTALL_CURSOR (modeline_cursor, mode);
1034 INSTALL_CURSOR (hand_cursor, hand);
1035 INSTALL_CURSOR (horizontal_drag_cursor, horizontal_drag);
1036 INSTALL_CURSOR (vertical_drag_cursor, vertical_drag);
1038 #undef INSTALL_CURSOR
1040 XFlush (dpy);
1041 unblock_input ();
1043 update_face_from_frame_parameter (f, Qmouse_color, arg);
1046 static void
1047 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1049 unsigned long fore_pixel, pixel;
1050 bool fore_pixel_allocated_p = false, pixel_allocated_p = false;
1051 struct x_output *x = f->output_data.x;
1053 if (!NILP (Vx_cursor_fore_pixel))
1055 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1056 WHITE_PIX_DEFAULT (f));
1057 fore_pixel_allocated_p = true;
1059 else
1060 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1062 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1063 pixel_allocated_p = true;
1065 /* Make sure that the cursor color differs from the background color. */
1066 if (pixel == FRAME_BACKGROUND_PIXEL (f))
1068 if (pixel_allocated_p)
1070 x_free_colors (f, &pixel, 1);
1071 pixel_allocated_p = false;
1074 pixel = x->mouse_pixel;
1075 if (pixel == fore_pixel)
1077 if (fore_pixel_allocated_p)
1079 x_free_colors (f, &fore_pixel, 1);
1080 fore_pixel_allocated_p = false;
1082 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1086 unload_color (f, x->cursor_foreground_pixel);
1087 if (!fore_pixel_allocated_p)
1088 fore_pixel = x_copy_color (f, fore_pixel);
1089 x->cursor_foreground_pixel = fore_pixel;
1091 unload_color (f, x->cursor_pixel);
1092 if (!pixel_allocated_p)
1093 pixel = x_copy_color (f, pixel);
1094 x->cursor_pixel = pixel;
1096 if (FRAME_X_WINDOW (f) != 0)
1098 block_input ();
1099 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
1100 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
1101 unblock_input ();
1103 if (FRAME_VISIBLE_P (f))
1105 x_update_cursor (f, false);
1106 x_update_cursor (f, true);
1110 update_face_from_frame_parameter (f, Qcursor_color, arg);
1113 /* Set the border-color of frame F to pixel value PIX.
1114 Note that this does not fully take effect if done before
1115 F has an x-window. */
1117 static void
1118 x_set_border_pixel (struct frame *f, int pix)
1120 unload_color (f, f->output_data.x->border_pixel);
1121 f->output_data.x->border_pixel = pix;
1123 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
1125 block_input ();
1126 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), pix);
1127 unblock_input ();
1129 if (FRAME_VISIBLE_P (f))
1130 redraw_frame (f);
1134 /* Set the border-color of frame F to value described by ARG.
1135 ARG can be a string naming a color.
1136 The border-color is used for the border that is drawn by the X server.
1137 Note that this does not fully take effect if done before
1138 F has an x-window; it must be redone when the window is created.
1140 Note: this is done in two routines because of the way X10 works.
1142 Note: under X11, this is normally the province of the window manager,
1143 and so emacs's border colors may be overridden. */
1145 static void
1146 x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1148 int pix;
1150 CHECK_STRING (arg);
1151 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1152 x_set_border_pixel (f, pix);
1153 update_face_from_frame_parameter (f, Qborder_color, arg);
1157 static void
1158 x_set_cursor_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1160 set_frame_cursor_types (f, arg);
1163 static void
1164 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1166 bool result;
1168 if (STRINGP (arg))
1170 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1171 return;
1173 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1174 return;
1176 block_input ();
1177 if (NILP (arg))
1178 result = x_text_icon (f,
1179 SSDATA ((!NILP (f->icon_name)
1180 ? f->icon_name
1181 : f->name)));
1182 else
1183 result = x_bitmap_icon (f, arg);
1185 if (result)
1187 unblock_input ();
1188 error ("No icon window available");
1191 XFlush (FRAME_X_DISPLAY (f));
1192 unblock_input ();
1195 static void
1196 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1198 bool result;
1200 if (STRINGP (arg))
1202 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1203 return;
1205 else if (!NILP (arg) || NILP (oldval))
1206 return;
1208 fset_icon_name (f, arg);
1210 if (f->output_data.x->icon_bitmap != 0)
1211 return;
1213 block_input ();
1215 result = x_text_icon (f,
1216 SSDATA ((!NILP (f->icon_name)
1217 ? f->icon_name
1218 : !NILP (f->title)
1219 ? f->title
1220 : f->name)));
1222 if (result)
1224 unblock_input ();
1225 error ("No icon window available");
1228 XFlush (FRAME_X_DISPLAY (f));
1229 unblock_input ();
1233 static void
1234 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1236 int nlines;
1237 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1238 int olines = FRAME_MENU_BAR_LINES (f);
1239 #endif
1241 /* Right now, menu bars don't work properly in minibuf-only frames;
1242 most of the commands try to apply themselves to the minibuffer
1243 frame itself, and get an error because you can't switch buffers
1244 in or split the minibuffer window. */
1245 if (FRAME_MINIBUF_ONLY_P (f))
1246 return;
1248 if (TYPE_RANGED_INTEGERP (int, value))
1249 nlines = XINT (value);
1250 else
1251 nlines = 0;
1253 /* Make sure we redisplay all windows in this frame. */
1254 fset_redisplay (f);
1256 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1257 FRAME_MENU_BAR_LINES (f) = 0;
1258 FRAME_MENU_BAR_HEIGHT (f) = 0;
1259 if (nlines)
1261 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1262 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1263 /* Make sure next redisplay shows the menu bar. */
1264 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = true;
1266 else
1268 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1269 free_frame_menubar (f);
1270 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1271 if (FRAME_X_P (f))
1272 f->output_data.x->menubar_widget = 0;
1274 #else /* not USE_X_TOOLKIT && not USE_GTK */
1275 FRAME_MENU_BAR_LINES (f) = nlines;
1276 FRAME_MENU_BAR_HEIGHT (f) = nlines * FRAME_LINE_HEIGHT (f);
1277 adjust_frame_size (f, -1, -1, 2, true, Qx_set_menu_bar_lines);
1278 if (FRAME_X_WINDOW (f))
1279 x_clear_under_internal_border (f);
1281 /* If the menu bar height gets changed, the internal border below
1282 the top margin has to be cleared. Also, if the menu bar gets
1283 larger, the area for the added lines has to be cleared except for
1284 the first menu bar line that is to be drawn later. */
1285 if (nlines != olines)
1287 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1288 int width = FRAME_PIXEL_WIDTH (f);
1289 int y;
1291 /* height can be zero here. */
1292 if (FRAME_X_WINDOW (f) && height > 0 && width > 0)
1294 y = FRAME_TOP_MARGIN_HEIGHT (f);
1296 block_input ();
1297 x_clear_area (f, 0, y, width, height);
1298 unblock_input ();
1301 if (nlines > 1 && nlines > olines)
1303 y = (olines == 0 ? 1 : olines) * FRAME_LINE_HEIGHT (f);
1304 height = nlines * FRAME_LINE_HEIGHT (f) - y;
1306 block_input ();
1307 x_clear_area (f, 0, y, width, height);
1308 unblock_input ();
1311 if (nlines == 0 && WINDOWP (f->menu_bar_window))
1312 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1314 #endif /* not USE_X_TOOLKIT && not USE_GTK */
1315 adjust_frame_glyphs (f);
1319 /* Set the number of lines used for the tool bar of frame F to VALUE.
1320 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1321 is the old number of tool bar lines. This function changes the
1322 height of all windows on frame F to match the new tool bar height.
1323 The frame's height doesn't change. */
1325 static void
1326 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1328 int nlines;
1330 /* Treat tool bars like menu bars. */
1331 if (FRAME_MINIBUF_ONLY_P (f))
1332 return;
1334 /* Use VALUE only if an int >= 0. */
1335 if (RANGED_INTEGERP (0, value, INT_MAX))
1336 nlines = XFASTINT (value);
1337 else
1338 nlines = 0;
1340 x_change_tool_bar_height (f, nlines * FRAME_LINE_HEIGHT (f));
1344 /* Set the pixel height of the tool bar of frame F to HEIGHT. */
1345 void
1346 x_change_tool_bar_height (struct frame *f, int height)
1348 #ifdef USE_GTK
1349 FRAME_TOOL_BAR_LINES (f) = 0;
1350 FRAME_TOOL_BAR_HEIGHT (f) = 0;
1351 if (height)
1353 FRAME_EXTERNAL_TOOL_BAR (f) = true;
1354 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1355 /* Make sure next redisplay shows the tool bar. */
1356 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = true;
1357 update_frame_tool_bar (f);
1359 else
1361 if (FRAME_EXTERNAL_TOOL_BAR (f))
1362 free_frame_tool_bar (f);
1363 FRAME_EXTERNAL_TOOL_BAR (f) = false;
1365 #else /* !USE_GTK */
1366 int unit = FRAME_LINE_HEIGHT (f);
1367 int old_height = FRAME_TOOL_BAR_HEIGHT (f);
1368 int lines = (height + unit - 1) / unit;
1369 Lisp_Object fullscreen;
1371 /* Make sure we redisplay all windows in this frame. */
1372 fset_redisplay (f);
1374 /* Recalculate tool bar and frame text sizes. */
1375 FRAME_TOOL_BAR_HEIGHT (f) = height;
1376 FRAME_TOOL_BAR_LINES (f) = lines;
1377 /* Store the `tool-bar-lines' and `height' frame parameters. */
1378 store_frame_param (f, Qtool_bar_lines, make_number (lines));
1379 store_frame_param (f, Qheight, make_number (FRAME_LINES (f)));
1381 /* We also have to make sure that the internal border at the top of
1382 the frame, below the menu bar or tool bar, is redrawn when the
1383 tool bar disappears. This is so because the internal border is
1384 below the tool bar if one is displayed, but is below the menu bar
1385 if there isn't a tool bar. The tool bar draws into the area
1386 below the menu bar. */
1387 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_HEIGHT (f) == 0)
1389 clear_frame (f);
1390 clear_current_matrices (f);
1393 if ((height < old_height) && WINDOWP (f->tool_bar_window))
1394 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1396 /* Recalculate toolbar height. */
1397 f->n_tool_bar_rows = 0;
1398 if (old_height == 0
1399 && (!f->after_make_frame
1400 || NILP (frame_inhibit_implied_resize)
1401 || (CONSP (frame_inhibit_implied_resize)
1402 && NILP (Fmemq (Qtool_bar_lines, frame_inhibit_implied_resize)))))
1403 f->tool_bar_redisplayed = f->tool_bar_resized = false;
1405 adjust_frame_size (f, -1, -1,
1406 ((!f->tool_bar_resized
1407 && (NILP (fullscreen =
1408 get_frame_param (f, Qfullscreen))
1409 || EQ (fullscreen, Qfullwidth))) ? 1
1410 : (old_height == 0 || height == 0) ? 2
1411 : 4),
1412 false, Qtool_bar_lines);
1414 f->tool_bar_resized = f->tool_bar_redisplayed;
1416 /* adjust_frame_size might not have done anything, garbage frame
1417 here. */
1418 adjust_frame_glyphs (f);
1419 SET_FRAME_GARBAGED (f);
1420 if (FRAME_X_WINDOW (f))
1421 x_clear_under_internal_border (f);
1423 #endif /* USE_GTK */
1427 static void
1428 x_set_internal_border_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1430 int border;
1432 CHECK_TYPE_RANGED_INTEGER (int, arg);
1433 border = max (XINT (arg), 0);
1435 if (border != FRAME_INTERNAL_BORDER_WIDTH (f))
1437 FRAME_INTERNAL_BORDER_WIDTH (f) = border;
1439 #ifdef USE_X_TOOLKIT
1440 if (FRAME_X_OUTPUT (f)->edit_widget)
1441 widget_store_internal_border (FRAME_X_OUTPUT (f)->edit_widget);
1442 #endif
1444 if (FRAME_X_WINDOW (f) != 0)
1446 adjust_frame_size (f, -1, -1, 3, false, Qinternal_border_width);
1448 #ifdef USE_GTK
1449 xg_clear_under_internal_border (f);
1450 #else
1451 x_clear_under_internal_border (f);
1452 #endif
1459 /* Set the foreground color for scroll bars on frame F to VALUE.
1460 VALUE should be a string, a color name. If it isn't a string or
1461 isn't a valid color name, do nothing. OLDVAL is the old value of
1462 the frame parameter. */
1464 static void
1465 x_set_scroll_bar_foreground (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1467 unsigned long pixel;
1469 if (STRINGP (value))
1470 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1471 else
1472 pixel = -1;
1474 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1475 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1477 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1478 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1480 /* Remove all scroll bars because they have wrong colors. */
1481 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1482 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1483 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1484 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1486 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1487 redraw_frame (f);
1492 /* Set the background color for scroll bars on frame F to VALUE VALUE
1493 should be a string, a color name. If it isn't a string or isn't a
1494 valid color name, do nothing. OLDVAL is the old value of the frame
1495 parameter. */
1497 static void
1498 x_set_scroll_bar_background (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1500 unsigned long pixel;
1502 if (STRINGP (value))
1503 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1504 else
1505 pixel = -1;
1507 if (f->output_data.x->scroll_bar_background_pixel != -1)
1508 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1510 #if defined (USE_LUCID) && defined (USE_TOOLKIT_SCROLL_BARS)
1511 /* Scrollbar shadow colors. */
1512 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1514 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1515 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1517 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1519 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1520 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1522 #endif /* USE_LUCID && USE_TOOLKIT_SCROLL_BARS */
1524 f->output_data.x->scroll_bar_background_pixel = pixel;
1525 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1527 /* Remove all scroll bars because they have wrong colors. */
1528 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1529 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1530 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1531 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1533 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1534 redraw_frame (f);
1539 /* Encode Lisp string STRING as a text in a format appropriate for
1540 XICCC (X Inter Client Communication Conventions).
1542 If STRING contains only ASCII characters, do no conversion and
1543 return the string data of STRING. Otherwise, encode the text by
1544 CODING_SYSTEM, and return a newly allocated memory area which
1545 should be freed by `xfree' by a caller.
1547 Store the byte length of resulting text in *TEXT_BYTES.
1549 If the text contains only ASCII and Latin-1, store true in *STRING_P,
1550 which means that the `encoding' of the result can be `STRING'.
1551 Otherwise store false in *STRINGP, which means that the `encoding' of
1552 the result should be `COMPOUND_TEXT'. */
1554 static unsigned char *
1555 x_encode_text (Lisp_Object string, Lisp_Object coding_system,
1556 ptrdiff_t *text_bytes, bool *stringp, bool *freep)
1558 int result = string_xstring_p (string);
1559 struct coding_system coding;
1561 if (result == 0)
1563 /* No multibyte character in OBJ. We need not encode it. */
1564 *text_bytes = SBYTES (string);
1565 *stringp = true;
1566 *freep = false;
1567 return SDATA (string);
1570 setup_coding_system (coding_system, &coding);
1571 coding.mode |= (CODING_MODE_SAFE_ENCODING | CODING_MODE_LAST_BLOCK);
1572 /* We suppress producing escape sequences for composition. */
1573 coding.common_flags &= ~CODING_ANNOTATION_MASK;
1574 coding.destination = xnmalloc (SCHARS (string), 2);
1575 coding.dst_bytes = SCHARS (string) * 2;
1576 encode_coding_object (&coding, string, 0, 0,
1577 SCHARS (string), SBYTES (string), Qnil);
1578 *text_bytes = coding.produced;
1579 *stringp = (result == 1 || !EQ (coding_system, Qcompound_text));
1580 *freep = true;
1581 return coding.destination;
1585 /* Set the WM name to NAME for frame F. Also set the icon name.
1586 If the frame already has an icon name, use that, otherwise set the
1587 icon name to NAME. */
1589 static void
1590 x_set_name_internal (struct frame *f, Lisp_Object name)
1592 if (FRAME_X_WINDOW (f))
1594 block_input ();
1596 XTextProperty text, icon;
1597 ptrdiff_t bytes;
1598 bool stringp;
1599 bool do_free_icon_value = false, do_free_text_value = false;
1600 Lisp_Object coding_system;
1601 Lisp_Object encoded_name;
1602 Lisp_Object encoded_icon_name;
1604 /* As ENCODE_UTF_8 may cause GC and relocation of string data,
1605 we use it before x_encode_text that may return string data. */
1606 encoded_name = ENCODE_UTF_8 (name);
1608 coding_system = Qcompound_text;
1609 /* Note: Encoding strategy
1611 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1612 text.encoding. But, there are non-internationalized window
1613 managers which don't support that encoding. So, if NAME
1614 contains only ASCII and 8859-1 characters, encode it by
1615 iso-latin-1, and use "STRING" in text.encoding hoping that
1616 such window managers at least analyze this format correctly,
1617 i.e. treat 8-bit bytes as 8859-1 characters.
1619 We may also be able to use "UTF8_STRING" in text.encoding
1620 in the future which can encode all Unicode characters.
1621 But, for the moment, there's no way to know that the
1622 current window manager supports it or not.
1624 Either way, we also set the _NET_WM_NAME and _NET_WM_ICON_NAME
1625 properties. Per the EWMH specification, those two properties
1626 are always UTF8_STRING. This matches what gtk_window_set_title()
1627 does in the USE_GTK case. */
1628 text.value = x_encode_text (name, coding_system, &bytes,
1629 &stringp, &do_free_text_value);
1630 text.encoding = (stringp ? XA_STRING
1631 : FRAME_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1632 text.format = 8;
1633 text.nitems = bytes;
1635 if (!STRINGP (f->icon_name))
1637 icon = text;
1638 encoded_icon_name = encoded_name;
1640 else
1642 /* See the above comment "Note: Encoding strategy". */
1643 icon.value = x_encode_text (f->icon_name, coding_system, &bytes,
1644 &stringp, &do_free_icon_value);
1645 icon.encoding = (stringp ? XA_STRING
1646 : FRAME_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1647 icon.format = 8;
1648 icon.nitems = bytes;
1650 encoded_icon_name = ENCODE_UTF_8 (f->icon_name);
1653 #ifdef USE_GTK
1654 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1655 SSDATA (encoded_name));
1656 #else /* not USE_GTK */
1657 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1658 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1659 FRAME_DISPLAY_INFO (f)->Xatom_net_wm_name,
1660 FRAME_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1661 8, PropModeReplace,
1662 SDATA (encoded_name),
1663 SBYTES (encoded_name));
1664 #endif /* not USE_GTK */
1666 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1667 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1668 FRAME_DISPLAY_INFO (f)->Xatom_net_wm_icon_name,
1669 FRAME_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1670 8, PropModeReplace,
1671 SDATA (encoded_icon_name),
1672 SBYTES (encoded_icon_name));
1674 if (do_free_icon_value)
1675 xfree (icon.value);
1676 if (do_free_text_value)
1677 xfree (text.value);
1679 unblock_input ();
1683 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1684 x_id_name.
1686 If EXPLICIT is true, that indicates that lisp code is setting the
1687 name; if NAME is a string, set F's name to NAME and set
1688 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1690 If EXPLICIT is false, that indicates that Emacs redisplay code is
1691 suggesting a new name, which lisp code should override; if
1692 F->explicit_name is set, ignore the new name; otherwise, set it. */
1694 static void
1695 x_set_name (struct frame *f, Lisp_Object name, bool explicit)
1697 /* Make sure that requests from lisp code override requests from
1698 Emacs redisplay code. */
1699 if (explicit)
1701 /* If we're switching from explicit to implicit, we had better
1702 update the mode lines and thereby update the title. */
1703 if (f->explicit_name && NILP (name))
1704 update_mode_lines = 37;
1706 f->explicit_name = ! NILP (name);
1708 else if (f->explicit_name)
1709 return;
1711 /* If NAME is nil, set the name to the x_id_name. */
1712 if (NILP (name))
1714 /* Check for no change needed in this very common case
1715 before we do any consing. */
1716 if (!strcmp (FRAME_DISPLAY_INFO (f)->x_id_name,
1717 SSDATA (f->name)))
1718 return;
1719 name = build_string (FRAME_DISPLAY_INFO (f)->x_id_name);
1721 else
1722 CHECK_STRING (name);
1724 /* Don't change the name if it's already NAME. */
1725 if (! NILP (Fstring_equal (name, f->name)))
1726 return;
1728 fset_name (f, name);
1730 /* For setting the frame title, the title parameter should override
1731 the name parameter. */
1732 if (! NILP (f->title))
1733 name = f->title;
1735 x_set_name_internal (f, name);
1738 /* This function should be called when the user's lisp code has
1739 specified a name for the frame; the name will override any set by the
1740 redisplay code. */
1741 static void
1742 x_explicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1744 x_set_name (f, arg, true);
1747 /* This function should be called by Emacs redisplay code to set the
1748 name; names set this way will never override names set by the user's
1749 lisp code. */
1750 void
1751 x_implicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1753 x_set_name (f, arg, false);
1756 /* Change the title of frame F to NAME.
1757 If NAME is nil, use the frame name as the title. */
1759 static void
1760 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1762 /* Don't change the title if it's already NAME. */
1763 if (EQ (name, f->title))
1764 return;
1766 update_mode_lines = 38;
1768 fset_title (f, name);
1770 if (NILP (name))
1771 name = f->name;
1772 else
1773 CHECK_STRING (name);
1775 x_set_name_internal (f, name);
1778 void
1779 x_set_scroll_bar_default_width (struct frame *f)
1781 int unit = FRAME_COLUMN_WIDTH (f);
1782 #ifdef USE_TOOLKIT_SCROLL_BARS
1783 #ifdef USE_GTK
1784 int minw = xg_get_default_scrollbar_width ();
1785 #else
1786 int minw = 16;
1787 #endif
1788 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1789 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (minw + unit - 1) / unit;
1790 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = minw;
1791 #else
1792 /* The width of a non-toolkit scrollbar is 14 pixels. */
1793 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + unit - 1) / unit;
1794 FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
1795 = FRAME_CONFIG_SCROLL_BAR_COLS (f) * unit;
1796 #endif
1799 void
1800 x_set_scroll_bar_default_height (struct frame *f)
1802 int height = FRAME_LINE_HEIGHT (f);
1803 #ifdef USE_TOOLKIT_SCROLL_BARS
1804 #ifdef USE_GTK
1805 int min_height = xg_get_default_scrollbar_height ();
1806 #else
1807 int min_height = 16;
1808 #endif
1809 /* A minimum height of 14 doesn't look good for toolkit scroll bars. */
1810 FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) = min_height;
1811 FRAME_CONFIG_SCROLL_BAR_LINES (f) = (min_height + height - 1) / height;
1812 #else
1813 /* The height of a non-toolkit scrollbar is 14 pixels. */
1814 FRAME_CONFIG_SCROLL_BAR_LINES (f) = (14 + height - 1) / height;
1816 /* Use all of that space (aside from required margins) for the
1817 scroll bar. */
1818 FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) = 14;
1819 #endif
1823 /* Record in frame F the specified or default value according to ALIST
1824 of the parameter named PROP (a Lisp symbol). If no value is
1825 specified for PROP, look for an X default for XPROP on the frame
1826 named NAME. If that is not found either, use the value DEFLT. */
1828 static Lisp_Object
1829 x_default_scroll_bar_color_parameter (struct frame *f,
1830 Lisp_Object alist, Lisp_Object prop,
1831 const char *xprop, const char *xclass,
1832 bool foreground_p)
1834 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
1835 Lisp_Object tem;
1837 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1838 if (EQ (tem, Qunbound))
1840 #ifdef USE_TOOLKIT_SCROLL_BARS
1842 /* See if an X resource for the scroll bar color has been
1843 specified. */
1844 AUTO_STRING (foreground, "foreground");
1845 AUTO_STRING (background, "foreground");
1846 AUTO_STRING (verticalScrollBar, "verticalScrollBar");
1847 tem = (display_x_get_resource
1848 (dpyinfo, foreground_p ? foreground : background,
1849 empty_unibyte_string,
1850 verticalScrollBar,
1851 empty_unibyte_string));
1852 if (!STRINGP (tem))
1854 /* If nothing has been specified, scroll bars will use a
1855 toolkit-dependent default. Because these defaults are
1856 difficult to get at without actually creating a scroll
1857 bar, use nil to indicate that no color has been
1858 specified. */
1859 tem = Qnil;
1862 #else /* not USE_TOOLKIT_SCROLL_BARS */
1864 tem = Qnil;
1866 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1869 AUTO_FRAME_ARG (arg, prop, tem);
1870 x_set_frame_parameters (f, arg);
1871 return tem;
1877 #ifdef USE_X_TOOLKIT
1879 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1880 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1881 already be present because of the toolkit (Motif adds some of them,
1882 for example, but Xt doesn't). */
1884 static void
1885 hack_wm_protocols (struct frame *f, Widget widget)
1887 Display *dpy = XtDisplay (widget);
1888 Window w = XtWindow (widget);
1889 bool need_delete = true;
1890 bool need_focus = true;
1891 bool need_save = true;
1893 block_input ();
1895 Atom type;
1896 unsigned char *catoms;
1897 int format = 0;
1898 unsigned long nitems = 0;
1899 unsigned long bytes_after;
1901 if ((XGetWindowProperty (dpy, w,
1902 FRAME_DISPLAY_INFO (f)->Xatom_wm_protocols,
1903 0, 100, False, XA_ATOM,
1904 &type, &format, &nitems, &bytes_after,
1905 &catoms)
1906 == Success)
1907 && format == 32 && type == XA_ATOM)
1909 Atom *atoms = (Atom *) catoms;
1910 while (nitems > 0)
1912 nitems--;
1913 if (atoms[nitems]
1914 == FRAME_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1915 need_delete = false;
1916 else if (atoms[nitems]
1917 == FRAME_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1918 need_focus = false;
1919 else if (atoms[nitems]
1920 == FRAME_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1921 need_save = false;
1924 if (catoms)
1925 XFree (catoms);
1928 Atom props[10];
1929 int count = 0;
1930 if (need_delete)
1931 props[count++] = FRAME_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1932 if (need_focus)
1933 props[count++] = FRAME_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1934 if (need_save)
1935 props[count++] = FRAME_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1936 if (count)
1937 XChangeProperty (dpy, w, FRAME_DISPLAY_INFO (f)->Xatom_wm_protocols,
1938 XA_ATOM, 32, PropModeAppend,
1939 (unsigned char *) props, count);
1941 unblock_input ();
1943 #endif
1947 /* Support routines for XIC (X Input Context). */
1949 #ifdef HAVE_X_I18N
1951 static XFontSet xic_create_xfontset (struct frame *);
1952 static XIMStyle best_xim_style (XIMStyles *);
1955 /* Supported XIM styles, ordered by preference. */
1957 static const XIMStyle supported_xim_styles[] =
1959 XIMPreeditPosition | XIMStatusArea,
1960 XIMPreeditPosition | XIMStatusNothing,
1961 XIMPreeditPosition | XIMStatusNone,
1962 XIMPreeditNothing | XIMStatusArea,
1963 XIMPreeditNothing | XIMStatusNothing,
1964 XIMPreeditNothing | XIMStatusNone,
1965 XIMPreeditNone | XIMStatusArea,
1966 XIMPreeditNone | XIMStatusNothing,
1967 XIMPreeditNone | XIMStatusNone,
1972 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1973 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1975 static const char xic_default_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1977 /* Create an Xt fontset spec from the name of a base font.
1978 If `motif' is True use the Motif syntax. */
1979 char *
1980 xic_create_fontsetname (const char *base_fontname, bool motif)
1982 const char *sep = motif ? ";" : ",";
1983 char *fontsetname;
1984 char *z;
1986 /* Make a fontset name from the base font name. */
1987 if (xic_default_fontset == base_fontname)
1989 /* There is no base font name, use the default. */
1990 fontsetname = xmalloc (strlen (base_fontname) + 2);
1991 z = stpcpy (fontsetname, base_fontname);
1993 else
1995 /* Make a fontset name from the base font name.
1996 The font set will be made of the following elements:
1997 - the base font.
1998 - the base font where the charset spec is replaced by -*-*.
1999 - the same but with the family also replaced with -*-*-. */
2000 const char *p = base_fontname;
2001 ptrdiff_t i;
2003 for (i = 0; *p; p++)
2004 if (*p == '-') i++;
2005 if (i != 14)
2007 /* As the font name doesn't conform to XLFD, we can't
2008 modify it to generalize it to allcs and allfamilies.
2009 Use the specified font plus the default. */
2010 fontsetname = xmalloc (strlen (base_fontname)
2011 + strlen (xic_default_fontset) + 3);
2012 z = stpcpy (fontsetname, base_fontname);
2013 z = stpcpy (z, sep);
2014 z = stpcpy (z, xic_default_fontset);
2016 else
2018 ptrdiff_t len;
2019 const char *p1 = NULL, *p2 = NULL, *p3 = NULL;
2020 char *font_allcs = NULL;
2021 char *font_allfamilies = NULL;
2022 char *font_all = NULL;
2023 const char *allcs = "*-*-*-*-*-*-*";
2024 const char *allfamilies = "-*-*-";
2025 const char *all = "*-*-*-*-";
2026 char *base;
2028 for (i = 0, p = base_fontname; i < 8; p++)
2030 if (*p == '-')
2032 i++;
2033 if (i == 3)
2034 p1 = p + 1;
2035 else if (i == 7)
2036 p2 = p + 1;
2037 else if (i == 6)
2038 p3 = p + 1;
2041 /* If base_fontname specifies ADSTYLE, make it a
2042 wildcard. */
2043 if (*p3 != '*')
2045 ptrdiff_t diff = (p2 - p3) - 2;
2047 base = alloca (strlen (base_fontname) + 1);
2048 memcpy (base, base_fontname, p3 - base_fontname);
2049 base[p3 - base_fontname] = '*';
2050 base[(p3 - base_fontname) + 1] = '-';
2051 strcpy (base + (p3 - base_fontname) + 2, p2);
2052 p = base + (p - base_fontname) - diff;
2053 p1 = base + (p1 - base_fontname);
2054 p2 = base + (p2 - base_fontname) - diff;
2055 base_fontname = base;
2058 /* Build the font spec that matches all charsets. */
2059 len = p - base_fontname + strlen (allcs) + 1;
2060 font_allcs = alloca (len);
2061 memcpy (font_allcs, base_fontname, p - base_fontname);
2062 strcpy (font_allcs + (p - base_fontname), allcs);
2064 /* Build the font spec that matches all families and
2065 add-styles. */
2066 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
2067 font_allfamilies = alloca (len);
2068 strcpy (font_allfamilies, allfamilies);
2069 memcpy (font_allfamilies + strlen (allfamilies), p1, p - p1);
2070 strcpy (font_allfamilies + strlen (allfamilies) + (p - p1), allcs);
2072 /* Build the font spec that matches all. */
2073 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
2074 font_all = alloca (len);
2075 z = stpcpy (font_all, allfamilies);
2076 z = stpcpy (z, all);
2077 memcpy (z, p2, p - p2);
2078 strcpy (z + (p - p2), allcs);
2080 /* Build the actual font set name. */
2081 len = strlen (base_fontname) + strlen (font_allcs)
2082 + strlen (font_allfamilies) + strlen (font_all) + 5;
2083 fontsetname = xmalloc (len);
2084 z = stpcpy (fontsetname, base_fontname);
2085 z = stpcpy (z, sep);
2086 z = stpcpy (z, font_allcs);
2087 z = stpcpy (z, sep);
2088 z = stpcpy (z, font_allfamilies);
2089 z = stpcpy (z, sep);
2090 z = stpcpy (z, font_all);
2093 if (motif)
2094 strcpy (z, ":");
2095 return fontsetname;
2097 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
2099 #ifdef DEBUG_XIC_FONTSET
2100 static void
2101 print_fontset_result (XFontSet xfs, char *name, char **missing_list,
2102 int missing_count)
2104 if (xfs)
2105 fprintf (stderr, "XIC Fontset created: %s\n", name);
2106 else
2108 fprintf (stderr, "XIC Fontset failed: %s\n", name);
2109 while (missing_count-- > 0)
2111 fprintf (stderr, " missing: %s\n", *missing_list);
2112 missing_list++;
2117 #endif
2119 static XFontSet
2120 xic_create_xfontset (struct frame *f)
2122 XFontSet xfs = NULL;
2123 struct font *font = FRAME_FONT (f);
2124 int pixel_size = font->pixel_size;
2125 Lisp_Object rest, frame;
2127 /* See if there is another frame already using same fontset. */
2128 FOR_EACH_FRAME (rest, frame)
2130 struct frame *cf = XFRAME (frame);
2132 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2133 && FRAME_DISPLAY_INFO (cf) == FRAME_DISPLAY_INFO (f)
2134 && FRAME_FONT (f)
2135 && FRAME_FONT (f)->pixel_size == pixel_size)
2137 xfs = FRAME_XIC_FONTSET (cf);
2138 break;
2142 if (! xfs)
2144 char buf[256];
2145 char **missing_list;
2146 int missing_count;
2147 char *def_string;
2148 const char *xlfd_format = "-*-*-medium-r-normal--%d-*-*-*-*-*";
2150 sprintf (buf, xlfd_format, pixel_size);
2151 missing_list = NULL;
2152 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2153 &missing_list, &missing_count, &def_string);
2154 #ifdef DEBUG_XIC_FONTSET
2155 print_fontset_result (xfs, buf, missing_list, missing_count);
2156 #endif
2157 if (missing_list)
2158 XFreeStringList (missing_list);
2159 if (! xfs)
2161 /* List of pixel sizes most likely available. Find one that
2162 is closest to pixel_size. */
2163 int sizes[] = {0, 8, 10, 11, 12, 14, 17, 18, 20, 24, 26, 34, 0};
2164 int *smaller, *larger;
2166 for (smaller = sizes; smaller[1]; smaller++)
2167 if (smaller[1] >= pixel_size)
2168 break;
2169 larger = smaller + 1;
2170 if (*larger == pixel_size)
2171 larger++;
2172 while (*smaller || *larger)
2174 int this_size;
2176 if (! *larger)
2177 this_size = *smaller--;
2178 else if (! *smaller)
2179 this_size = *larger++;
2180 else if (pixel_size - *smaller < *larger - pixel_size)
2181 this_size = *smaller--;
2182 else
2183 this_size = *larger++;
2184 sprintf (buf, xlfd_format, this_size);
2185 missing_list = NULL;
2186 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2187 &missing_list, &missing_count, &def_string);
2188 #ifdef DEBUG_XIC_FONTSET
2189 print_fontset_result (xfs, buf, missing_list, missing_count);
2190 #endif
2191 if (missing_list)
2192 XFreeStringList (missing_list);
2193 if (xfs)
2194 break;
2197 if (! xfs)
2199 const char *last_resort = "-*-*-*-r-normal--*-*-*-*-*-*";
2201 missing_list = NULL;
2202 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), last_resort,
2203 &missing_list, &missing_count, &def_string);
2204 #ifdef DEBUG_XIC_FONTSET
2205 print_fontset_result (xfs, last_resort, missing_list, missing_count);
2206 #endif
2207 if (missing_list)
2208 XFreeStringList (missing_list);
2213 return xfs;
2216 /* Free the X fontset of frame F if it is the last frame using it. */
2218 void
2219 xic_free_xfontset (struct frame *f)
2221 Lisp_Object rest, frame;
2222 bool shared_p = false;
2224 if (!FRAME_XIC_FONTSET (f))
2225 return;
2227 /* See if there is another frame sharing the same fontset. */
2228 FOR_EACH_FRAME (rest, frame)
2230 struct frame *cf = XFRAME (frame);
2231 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2232 && FRAME_DISPLAY_INFO (cf) == FRAME_DISPLAY_INFO (f)
2233 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2235 shared_p = true;
2236 break;
2240 if (!shared_p)
2241 /* The fontset is not used anymore. It is safe to free it. */
2242 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2244 FRAME_XIC_FONTSET (f) = NULL;
2248 /* Value is the best input style, given user preferences USER (already
2249 checked to be supported by Emacs), and styles supported by the
2250 input method XIM. */
2252 static XIMStyle
2253 best_xim_style (XIMStyles *xim)
2255 int i, j;
2256 int nr_supported = ARRAYELTS (supported_xim_styles);
2258 for (i = 0; i < nr_supported; ++i)
2259 for (j = 0; j < xim->count_styles; ++j)
2260 if (supported_xim_styles[i] == xim->supported_styles[j])
2261 return supported_xim_styles[i];
2263 /* Return the default style. */
2264 return XIMPreeditNothing | XIMStatusNothing;
2267 /* Create XIC for frame F. */
2269 void
2270 create_frame_xic (struct frame *f)
2272 XIM xim;
2273 XIC xic = NULL;
2274 XFontSet xfs = NULL;
2275 XVaNestedList status_attr = NULL;
2276 XVaNestedList preedit_attr = NULL;
2277 XRectangle s_area;
2278 XPoint spot;
2279 XIMStyle xic_style;
2281 if (FRAME_XIC (f))
2282 goto out;
2284 xim = FRAME_X_XIM (f);
2285 if (!xim)
2286 goto out;
2288 /* Determine XIC style. */
2289 xic_style = best_xim_style (FRAME_X_XIM_STYLES (f));
2291 /* Create X fontset. */
2292 if (xic_style & (XIMPreeditPosition | XIMStatusArea))
2294 xfs = xic_create_xfontset (f);
2295 if (!xfs)
2296 goto out;
2298 FRAME_XIC_FONTSET (f) = xfs;
2301 if (xic_style & XIMPreeditPosition)
2303 spot.x = 0; spot.y = 1;
2304 preedit_attr = XVaCreateNestedList (0,
2305 XNFontSet, xfs,
2306 XNForeground,
2307 FRAME_FOREGROUND_PIXEL (f),
2308 XNBackground,
2309 FRAME_BACKGROUND_PIXEL (f),
2310 (xic_style & XIMPreeditPosition
2311 ? XNSpotLocation
2312 : NULL),
2313 &spot,
2314 NULL);
2316 if (!preedit_attr)
2317 goto out;
2320 if (xic_style & XIMStatusArea)
2322 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2323 status_attr = XVaCreateNestedList (0,
2324 XNArea,
2325 &s_area,
2326 XNFontSet,
2327 xfs,
2328 XNForeground,
2329 FRAME_FOREGROUND_PIXEL (f),
2330 XNBackground,
2331 FRAME_BACKGROUND_PIXEL (f),
2332 NULL);
2334 if (!status_attr)
2335 goto out;
2338 if (preedit_attr && status_attr)
2339 xic = XCreateIC (xim,
2340 XNInputStyle, xic_style,
2341 XNClientWindow, FRAME_X_WINDOW (f),
2342 XNFocusWindow, FRAME_X_WINDOW (f),
2343 XNStatusAttributes, status_attr,
2344 XNPreeditAttributes, preedit_attr,
2345 NULL);
2346 else if (preedit_attr)
2347 xic = XCreateIC (xim,
2348 XNInputStyle, xic_style,
2349 XNClientWindow, FRAME_X_WINDOW (f),
2350 XNFocusWindow, FRAME_X_WINDOW (f),
2351 XNPreeditAttributes, preedit_attr,
2352 NULL);
2353 else if (status_attr)
2354 xic = XCreateIC (xim,
2355 XNInputStyle, xic_style,
2356 XNClientWindow, FRAME_X_WINDOW (f),
2357 XNFocusWindow, FRAME_X_WINDOW (f),
2358 XNStatusAttributes, status_attr,
2359 NULL);
2360 else
2361 xic = XCreateIC (xim,
2362 XNInputStyle, xic_style,
2363 XNClientWindow, FRAME_X_WINDOW (f),
2364 XNFocusWindow, FRAME_X_WINDOW (f),
2365 NULL);
2367 if (!xic)
2368 goto out;
2370 FRAME_XIC (f) = xic;
2371 FRAME_XIC_STYLE (f) = xic_style;
2372 xfs = NULL; /* Don't free below. */
2374 out:
2376 if (xfs)
2377 free_frame_xic (f);
2379 if (preedit_attr)
2380 XFree (preedit_attr);
2382 if (status_attr)
2383 XFree (status_attr);
2387 /* Destroy XIC and free XIC fontset of frame F, if any. */
2389 void
2390 free_frame_xic (struct frame *f)
2392 if (FRAME_XIC (f) == NULL)
2393 return;
2395 XDestroyIC (FRAME_XIC (f));
2396 xic_free_xfontset (f);
2398 FRAME_XIC (f) = NULL;
2402 /* Place preedit area for XIC of window W's frame to specified
2403 pixel position X/Y. X and Y are relative to window W. */
2405 void
2406 xic_set_preeditarea (struct window *w, int x, int y)
2408 struct frame *f = XFRAME (w->frame);
2409 XVaNestedList attr;
2410 XPoint spot;
2412 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2413 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2414 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2415 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2416 XFree (attr);
2420 /* Place status area for XIC in bottom right corner of frame F.. */
2422 void
2423 xic_set_statusarea (struct frame *f)
2425 XIC xic = FRAME_XIC (f);
2426 XVaNestedList attr;
2427 XRectangle area;
2428 XRectangle *needed;
2430 /* Negotiate geometry of status area. If input method has existing
2431 status area, use its current size. */
2432 area.x = area.y = area.width = area.height = 0;
2433 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2434 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2435 XFree (attr);
2437 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2438 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2439 XFree (attr);
2441 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2443 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2444 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2445 XFree (attr);
2448 area.width = needed->width;
2449 area.height = needed->height;
2450 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2451 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2452 - FRAME_MENUBAR_HEIGHT (f)
2453 - FRAME_TOOLBAR_TOP_HEIGHT (f)
2454 - FRAME_INTERNAL_BORDER_WIDTH (f));
2455 XFree (needed);
2457 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2458 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2459 XFree (attr);
2463 /* Set X fontset for XIC of frame F, using base font name
2464 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2466 void
2467 xic_set_xfontset (struct frame *f, const char *base_fontname)
2469 XVaNestedList attr;
2470 XFontSet xfs;
2472 xic_free_xfontset (f);
2474 xfs = xic_create_xfontset (f);
2476 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2477 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2478 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2479 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2480 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2481 XFree (attr);
2483 FRAME_XIC_FONTSET (f) = xfs;
2486 #endif /* HAVE_X_I18N */
2490 #ifdef USE_X_TOOLKIT
2492 /* Create and set up the X widget for frame F. */
2494 static void
2495 x_window (struct frame *f, long window_prompting)
2497 XClassHint class_hints;
2498 XSetWindowAttributes attributes;
2499 unsigned long attribute_mask;
2500 Widget shell_widget;
2501 Widget pane_widget;
2502 Widget frame_widget;
2503 Arg al[25];
2504 int ac;
2506 block_input ();
2508 /* Use the resource name as the top-level widget name
2509 for looking up resources. Make a non-Lisp copy
2510 for the window manager, so GC relocation won't bother it.
2512 Elsewhere we specify the window name for the window manager. */
2513 f->namebuf = xlispstrdup (Vx_resource_name);
2515 ac = 0;
2516 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2517 XtSetArg (al[ac], XtNinput, 1); ac++;
2518 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2519 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2520 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2521 XtSetArg (al[ac], XtNdepth, FRAME_DISPLAY_INFO (f)->n_planes); ac++;
2522 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2523 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2524 applicationShellWidgetClass,
2525 FRAME_X_DISPLAY (f), al, ac);
2527 f->output_data.x->widget = shell_widget;
2528 /* maybe_set_screen_title_format (shell_widget); */
2530 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2531 NULL, shell_widget, False,
2532 NULL, NULL, NULL, NULL);
2534 ac = 0;
2535 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2536 XtSetArg (al[ac], XtNdepth, FRAME_DISPLAY_INFO (f)->n_planes); ac++;
2537 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2538 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2539 XtSetValues (pane_widget, al, ac);
2540 f->output_data.x->column_widget = pane_widget;
2542 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2543 the emacs screen when changing menubar. This reduces flickering. */
2545 ac = 0;
2546 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2547 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2548 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2549 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2550 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2551 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2552 XtSetArg (al[ac], XtNdepth, FRAME_DISPLAY_INFO (f)->n_planes); ac++;
2553 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2554 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2555 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2556 al, ac);
2558 f->output_data.x->edit_widget = frame_widget;
2560 XtManageChild (frame_widget);
2562 /* Do some needed geometry management. */
2564 Arg gal[3];
2565 int gac = 0;
2566 int extra_borders = 0;
2567 int menubar_size
2568 = (f->output_data.x->menubar_widget
2569 ? (f->output_data.x->menubar_widget->core.height
2570 + f->output_data.x->menubar_widget->core.border_width)
2571 : 0);
2573 #if false /* Experimentally, we now get the right results
2574 for -geometry -0-0 without this. 24 Aug 96, rms. */
2575 if (FRAME_EXTERNAL_MENU_BAR (f))
2577 Dimension ibw = 0;
2578 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2579 menubar_size += ibw;
2581 #endif
2583 FRAME_MENUBAR_HEIGHT (f) = menubar_size;
2585 #ifndef USE_LUCID
2586 /* Motif seems to need this amount added to the sizes
2587 specified for the shell widget. The Athena/Lucid widgets don't.
2588 Both conclusions reached experimentally. -- rms. */
2589 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2590 &extra_borders, NULL);
2591 extra_borders *= 2;
2592 #endif
2594 f->shell_position = xmalloc (sizeof "=x++" + 4 * INT_STRLEN_BOUND (int));
2596 /* Convert our geometry parameters into a geometry string
2597 and specify it.
2598 Note that we do not specify here whether the position
2599 is a user-specified or program-specified one.
2600 We pass that information later, in x_wm_set_size_hints. */
2602 int left = f->left_pos;
2603 bool xneg = (window_prompting & XNegative) != 0;
2604 int top = f->top_pos;
2605 bool yneg = (window_prompting & YNegative) != 0;
2606 if (xneg)
2607 left = -left;
2608 if (yneg)
2609 top = -top;
2611 if (window_prompting & USPosition)
2612 sprintf (f->shell_position, "=%dx%d%c%d%c%d",
2613 FRAME_PIXEL_WIDTH (f) + extra_borders,
2614 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2615 (xneg ? '-' : '+'), left,
2616 (yneg ? '-' : '+'), top);
2617 else
2619 sprintf (f->shell_position, "=%dx%d",
2620 FRAME_PIXEL_WIDTH (f) + extra_borders,
2621 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2623 /* Setting x and y when the position is not specified in
2624 the geometry string will set program position in the WM hints.
2625 If Emacs had just one program position, we could set it in
2626 fallback resources, but since each make-frame call can specify
2627 different program positions, this is easier. */
2628 XtSetArg (gal[gac], XtNx, left); gac++;
2629 XtSetArg (gal[gac], XtNy, top); gac++;
2633 XtSetArg (gal[gac], XtNgeometry, f->shell_position); gac++;
2634 XtSetValues (shell_widget, gal, gac);
2637 XtManageChild (pane_widget);
2638 XtRealizeWidget (shell_widget);
2640 if (FRAME_X_EMBEDDED_P (f))
2641 XReparentWindow (FRAME_X_DISPLAY (f), XtWindow (shell_widget),
2642 f->output_data.x->parent_desc, 0, 0);
2644 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2646 validate_x_resource_name ();
2648 class_hints.res_name = SSDATA (Vx_resource_name);
2649 class_hints.res_class = SSDATA (Vx_resource_class);
2650 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2652 #ifdef HAVE_X_I18N
2653 FRAME_XIC (f) = NULL;
2654 if (use_xim)
2655 create_frame_xic (f);
2656 #endif
2658 f->output_data.x->wm_hints.input = True;
2659 f->output_data.x->wm_hints.flags |= InputHint;
2660 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2661 &f->output_data.x->wm_hints);
2663 hack_wm_protocols (f, shell_widget);
2665 #ifdef HACK_EDITRES
2666 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2667 #endif
2669 /* Do a stupid property change to force the server to generate a
2670 PropertyNotify event so that the event_stream server timestamp will
2671 be initialized to something relevant to the time we created the window.
2673 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2674 FRAME_DISPLAY_INFO (f)->Xatom_wm_protocols,
2675 XA_ATOM, 32, PropModeAppend, NULL, 0);
2677 /* Make all the standard events reach the Emacs frame. */
2678 attributes.event_mask = STANDARD_EVENT_SET;
2680 #ifdef HAVE_X_I18N
2681 if (FRAME_XIC (f))
2683 /* XIM server might require some X events. */
2684 unsigned long fevent = NoEventMask;
2685 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2686 attributes.event_mask |= fevent;
2688 #endif /* HAVE_X_I18N */
2690 attribute_mask = CWEventMask;
2691 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2692 attribute_mask, &attributes);
2694 XtMapWidget (frame_widget);
2696 /* x_set_name normally ignores requests to set the name if the
2697 requested name is the same as the current name. This is the one
2698 place where that assumption isn't correct; f->name is set, but
2699 the X server hasn't been told. */
2701 Lisp_Object name;
2702 bool explicit = f->explicit_name;
2704 f->explicit_name = false;
2705 name = f->name;
2706 fset_name (f, Qnil);
2707 x_set_name (f, name, explicit);
2710 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2711 f->output_data.x->current_cursor
2712 = f->output_data.x->text_cursor);
2714 unblock_input ();
2716 /* This is a no-op, except under Motif. Make sure main areas are
2717 set to something reasonable, in case we get an error later. */
2718 lw_set_main_areas (pane_widget, 0, frame_widget);
2721 #else /* not USE_X_TOOLKIT */
2722 #ifdef USE_GTK
2723 static void
2724 x_window (struct frame *f)
2726 if (! xg_create_frame_widgets (f))
2727 error ("Unable to create window");
2729 #ifdef HAVE_X_I18N
2730 FRAME_XIC (f) = NULL;
2731 if (use_xim)
2733 block_input ();
2734 create_frame_xic (f);
2735 if (FRAME_XIC (f))
2737 /* XIM server might require some X events. */
2738 unsigned long fevent = NoEventMask;
2739 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2741 if (fevent != NoEventMask)
2743 XSetWindowAttributes attributes;
2744 XWindowAttributes wattr;
2745 unsigned long attribute_mask;
2747 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2748 &wattr);
2749 attributes.event_mask = wattr.your_event_mask | fevent;
2750 attribute_mask = CWEventMask;
2751 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2752 attribute_mask, &attributes);
2755 unblock_input ();
2757 #endif
2760 #else /*! USE_GTK */
2761 /* Create and set up the X window for frame F. */
2763 static void
2764 x_window (struct frame *f)
2766 XClassHint class_hints;
2767 XSetWindowAttributes attributes;
2768 unsigned long attribute_mask;
2770 attributes.background_pixel = FRAME_BACKGROUND_PIXEL (f);
2771 attributes.border_pixel = f->output_data.x->border_pixel;
2772 attributes.bit_gravity = StaticGravity;
2773 attributes.backing_store = NotUseful;
2774 attributes.save_under = True;
2775 attributes.event_mask = STANDARD_EVENT_SET;
2776 attributes.colormap = FRAME_X_COLORMAP (f);
2777 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2778 | CWColormap);
2780 block_input ();
2781 FRAME_X_WINDOW (f)
2782 = XCreateWindow (FRAME_X_DISPLAY (f),
2783 f->output_data.x->parent_desc,
2784 f->left_pos,
2785 f->top_pos,
2786 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2787 f->border_width,
2788 CopyFromParent, /* depth */
2789 InputOutput, /* class */
2790 FRAME_X_VISUAL (f),
2791 attribute_mask, &attributes);
2793 #ifdef HAVE_X_I18N
2794 if (use_xim)
2796 create_frame_xic (f);
2797 if (FRAME_XIC (f))
2799 /* XIM server might require some X events. */
2800 unsigned long fevent = NoEventMask;
2801 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2802 attributes.event_mask |= fevent;
2803 attribute_mask = CWEventMask;
2804 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2805 attribute_mask, &attributes);
2808 #endif /* HAVE_X_I18N */
2810 validate_x_resource_name ();
2812 class_hints.res_name = SSDATA (Vx_resource_name);
2813 class_hints.res_class = SSDATA (Vx_resource_class);
2814 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2816 /* This indicates that we use the "Passive Input" input model.
2817 Unless we do this, we don't get the Focus{In,Out} events that we
2818 need to draw the cursor correctly. Accursed bureaucrats.
2819 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2821 f->output_data.x->wm_hints.input = True;
2822 f->output_data.x->wm_hints.flags |= InputHint;
2823 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2824 &f->output_data.x->wm_hints);
2825 f->output_data.x->wm_hints.icon_pixmap = None;
2827 /* Request "save yourself" and "delete window" commands from wm. */
2829 Atom protocols[2];
2830 protocols[0] = FRAME_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2831 protocols[1] = FRAME_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2832 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2835 /* x_set_name normally ignores requests to set the name if the
2836 requested name is the same as the current name. This is the one
2837 place where that assumption isn't correct; f->name is set, but
2838 the X server hasn't been told. */
2840 Lisp_Object name;
2841 bool explicit = f->explicit_name;
2843 f->explicit_name = false;
2844 name = f->name;
2845 fset_name (f, Qnil);
2846 x_set_name (f, name, explicit);
2849 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2850 f->output_data.x->current_cursor
2851 = f->output_data.x->text_cursor);
2853 unblock_input ();
2855 if (FRAME_X_WINDOW (f) == 0)
2856 error ("Unable to create window");
2859 #endif /* not USE_GTK */
2860 #endif /* not USE_X_TOOLKIT */
2862 /* Verify that the icon position args for this window are valid. */
2864 static void
2865 x_icon_verify (struct frame *f, Lisp_Object parms)
2867 Lisp_Object icon_x, icon_y;
2869 /* Set the position of the icon. Note that twm groups all
2870 icons in an icon window. */
2871 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2872 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2873 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2875 CHECK_NUMBER (icon_x);
2876 CHECK_NUMBER (icon_y);
2878 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2879 error ("Both left and top icon corners of icon must be specified");
2882 /* Handle the icon stuff for this window. Perhaps later we might
2883 want an x_set_icon_position which can be called interactively as
2884 well. */
2886 static void
2887 x_icon (struct frame *f, Lisp_Object parms)
2889 /* Set the position of the icon. Note that twm groups all
2890 icons in an icon window. */
2891 Lisp_Object icon_x
2892 = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2893 Lisp_Object icon_y
2894 = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2895 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2897 CHECK_TYPE_RANGED_INTEGER (int, icon_x);
2898 CHECK_TYPE_RANGED_INTEGER (int, icon_y);
2900 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2901 error ("Both left and top icon corners of icon must be specified");
2903 block_input ();
2905 if (! EQ (icon_x, Qunbound))
2906 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2908 #if false /* x_get_arg removes the visibility parameter as a side effect,
2909 but x_create_frame still needs it. */
2910 /* Start up iconic or window? */
2911 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
2912 x_wm_set_window_state
2913 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2914 Qicon)
2915 ? IconicState
2916 : NormalState));
2917 #endif
2919 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
2920 ? f->icon_name
2921 : f->name)));
2923 unblock_input ();
2926 /* Make the GCs needed for this window, setting the
2927 background, border and mouse colors; also create the
2928 mouse cursor and the gray border tile. */
2930 static void
2931 x_make_gc (struct frame *f)
2933 XGCValues gc_values;
2935 block_input ();
2937 /* Create the GCs of this frame.
2938 Note that many default values are used. */
2940 gc_values.foreground = FRAME_FOREGROUND_PIXEL (f);
2941 gc_values.background = FRAME_BACKGROUND_PIXEL (f);
2942 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2943 f->output_data.x->normal_gc
2944 = XCreateGC (FRAME_X_DISPLAY (f),
2945 FRAME_X_WINDOW (f),
2946 GCLineWidth | GCForeground | GCBackground,
2947 &gc_values);
2949 /* Reverse video style. */
2950 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2951 gc_values.background = FRAME_FOREGROUND_PIXEL (f);
2952 f->output_data.x->reverse_gc
2953 = XCreateGC (FRAME_X_DISPLAY (f),
2954 FRAME_X_WINDOW (f),
2955 GCForeground | GCBackground | GCLineWidth,
2956 &gc_values);
2958 /* Cursor has cursor-color background, background-color foreground. */
2959 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2960 gc_values.background = f->output_data.x->cursor_pixel;
2961 gc_values.fill_style = FillOpaqueStippled;
2962 f->output_data.x->cursor_gc
2963 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2964 (GCForeground | GCBackground
2965 | GCFillStyle | GCLineWidth),
2966 &gc_values);
2968 /* Create the gray border tile used when the pointer is not in
2969 the frame. Since this depends on the frame's pixel values,
2970 this must be done on a per-frame basis. */
2971 f->output_data.x->border_tile
2972 = (XCreatePixmapFromBitmapData
2973 (FRAME_X_DISPLAY (f), FRAME_DISPLAY_INFO (f)->root_window,
2974 gray_bits, gray_width, gray_height,
2975 FRAME_FOREGROUND_PIXEL (f),
2976 FRAME_BACKGROUND_PIXEL (f),
2977 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2979 unblock_input ();
2983 /* Free what was allocated in x_make_gc. */
2985 void
2986 x_free_gcs (struct frame *f)
2988 Display *dpy = FRAME_X_DISPLAY (f);
2990 block_input ();
2992 if (f->output_data.x->normal_gc)
2994 XFreeGC (dpy, f->output_data.x->normal_gc);
2995 f->output_data.x->normal_gc = 0;
2998 if (f->output_data.x->reverse_gc)
3000 XFreeGC (dpy, f->output_data.x->reverse_gc);
3001 f->output_data.x->reverse_gc = 0;
3004 if (f->output_data.x->cursor_gc)
3006 XFreeGC (dpy, f->output_data.x->cursor_gc);
3007 f->output_data.x->cursor_gc = 0;
3010 if (f->output_data.x->border_tile)
3012 XFreePixmap (dpy, f->output_data.x->border_tile);
3013 f->output_data.x->border_tile = 0;
3016 unblock_input ();
3020 /* Handler for signals raised during x_create_frame and
3021 x_create_tip_frame. FRAME is the frame which is partially
3022 constructed. */
3024 static Lisp_Object
3025 unwind_create_frame (Lisp_Object frame)
3027 struct frame *f = XFRAME (frame);
3029 /* If frame is already dead, nothing to do. This can happen if the
3030 display is disconnected after the frame has become official, but
3031 before x_create_frame removes the unwind protect. */
3032 if (!FRAME_LIVE_P (f))
3033 return Qnil;
3035 /* If frame is ``official'', nothing to do. */
3036 if (NILP (Fmemq (frame, Vframe_list)))
3038 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
3039 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
3040 #endif
3042 /* If the frame's image cache refcount is still the same as our
3043 private shadow variable, it means we are unwinding a frame
3044 for which we didn't yet call init_frame_faces, where the
3045 refcount is incremented. Therefore, we increment it here, so
3046 that free_frame_faces, called in x_free_frame_resources
3047 below, will not mistakenly decrement the counter that was not
3048 incremented yet to account for this new frame. */
3049 if (FRAME_IMAGE_CACHE (f) != NULL
3050 && FRAME_IMAGE_CACHE (f)->refcount == image_cache_refcount)
3051 FRAME_IMAGE_CACHE (f)->refcount++;
3053 x_free_frame_resources (f);
3054 free_glyphs (f);
3056 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
3057 /* Check that reference counts are indeed correct. */
3058 eassert (dpyinfo->reference_count == dpyinfo_refcount);
3059 eassert (dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
3060 #endif
3061 return Qt;
3064 return Qnil;
3067 static void
3068 do_unwind_create_frame (Lisp_Object frame)
3070 unwind_create_frame (frame);
3073 static void
3074 x_default_font_parameter (struct frame *f, Lisp_Object parms)
3076 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
3077 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
3078 RES_TYPE_STRING);
3079 Lisp_Object font = Qnil;
3080 if (EQ (font_param, Qunbound))
3081 font_param = Qnil;
3083 if (NILP (font_param))
3085 /* System font should take precedence over X resources. We suggest this
3086 regardless of font-use-system-font because .emacs may not have been
3087 read yet. */
3088 const char *system_font = xsettings_get_system_font ();
3089 if (system_font)
3090 font = font_open_by_name (f, build_unibyte_string (system_font));
3093 if (NILP (font))
3094 font = !NILP (font_param) ? font_param
3095 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
3097 if (! FONTP (font) && ! STRINGP (font))
3099 const char *names[]
3101 #ifdef HAVE_XFT
3102 /* This will find the normal Xft font. */
3103 "monospace-10",
3104 #endif
3105 "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1",
3106 "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
3107 "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
3108 /* This was formerly the first thing tried, but it finds
3109 too many fonts and takes too long. */
3110 "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1",
3111 /* If those didn't work, look for something which will
3112 at least work. */
3113 "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1",
3114 "fixed",
3115 NULL };
3116 int i;
3118 for (i = 0; names[i]; i++)
3120 font = font_open_by_name (f, build_unibyte_string (names[i]));
3121 if (! NILP (font))
3122 break;
3124 if (NILP (font))
3125 error ("No suitable font was found");
3127 else if (!NILP (font_param))
3129 /* Remember the explicit font parameter, so we can re-apply it after
3130 we've applied the `default' face settings. */
3131 AUTO_FRAME_ARG (arg, Qfont_parameter, font_param);
3132 x_set_frame_parameters (f, arg);
3135 /* This call will make X resources override any system font setting. */
3136 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
3140 DEFUN ("x-wm-set-size-hint", Fx_wm_set_size_hint, Sx_wm_set_size_hint,
3141 0, 1, 0,
3142 doc: /* Send the size hints for frame FRAME to the window manager.
3143 If FRAME is omitted or nil, use the selected frame.
3144 Signal error if FRAME is not an X frame. */)
3145 (Lisp_Object frame)
3147 struct frame *f = decode_window_system_frame (frame);
3149 block_input ();
3150 x_wm_set_size_hint (f, 0, false);
3151 unblock_input ();
3152 return Qnil;
3155 static void
3156 set_machine_and_pid_properties (struct frame *f)
3158 /* This will set WM_CLIENT_MACHINE and WM_LOCALE_NAME. */
3159 XSetWMProperties (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), NULL, NULL,
3160 NULL, 0, NULL, NULL, NULL);
3161 pid_t pid = getpid ();
3162 if (pid <= 0xffffffffu)
3164 unsigned long xpid = pid;
3165 XChangeProperty (FRAME_X_DISPLAY (f),
3166 FRAME_OUTER_WINDOW (f),
3167 XInternAtom (FRAME_X_DISPLAY (f),
3168 "_NET_WM_PID",
3169 False),
3170 XA_CARDINAL, 32, PropModeReplace,
3171 (unsigned char *) &xpid, 1);
3175 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
3176 1, 1, 0,
3177 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
3178 Return an Emacs frame object. PARMS is an alist of frame parameters.
3179 If the parameters specify that the frame should not have a minibuffer,
3180 and do not specify a specific minibuffer window to use, then
3181 `default-minibuffer-frame' must be a frame whose minibuffer can be
3182 shared by the new frame.
3184 This function is an internal primitive--use `make-frame' instead. */)
3185 (Lisp_Object parms)
3187 struct frame *f;
3188 Lisp_Object frame, tem;
3189 Lisp_Object name;
3190 bool minibuffer_only = false;
3191 long window_prompting = 0;
3192 ptrdiff_t count = SPECPDL_INDEX ();
3193 Lisp_Object display;
3194 struct x_display_info *dpyinfo = NULL;
3195 Lisp_Object parent;
3196 struct kboard *kb;
3197 int x_width = 0, x_height = 0;
3199 parms = Fcopy_alist (parms);
3201 /* Use this general default value to start with
3202 until we know if this frame has a specified name. */
3203 Vx_resource_name = Vinvocation_name;
3205 display = x_get_arg (dpyinfo, parms, Qterminal, 0, 0, RES_TYPE_NUMBER);
3206 if (EQ (display, Qunbound))
3207 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3208 if (EQ (display, Qunbound))
3209 display = Qnil;
3210 dpyinfo = check_x_display_info (display);
3211 kb = dpyinfo->terminal->kboard;
3213 if (!dpyinfo->terminal->name)
3214 error ("Terminal is not live, can't create new frames on it");
3216 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3217 if (!STRINGP (name)
3218 && ! EQ (name, Qunbound)
3219 && ! NILP (name))
3220 error ("Invalid frame name--not a string or nil");
3222 if (STRINGP (name))
3223 Vx_resource_name = name;
3225 /* See if parent window is specified. */
3226 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3227 if (EQ (parent, Qunbound))
3228 parent = Qnil;
3229 if (! NILP (parent))
3230 CHECK_NUMBER (parent);
3232 frame = Qnil;
3233 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3234 RES_TYPE_SYMBOL);
3235 if (EQ (tem, Qnone) || NILP (tem))
3236 f = make_frame_without_minibuffer (Qnil, kb, display);
3237 else if (EQ (tem, Qonly))
3239 f = make_minibuffer_frame ();
3240 minibuffer_only = true;
3242 else if (WINDOWP (tem))
3243 f = make_frame_without_minibuffer (tem, kb, display);
3244 else
3245 f = make_frame (true);
3247 XSETFRAME (frame, f);
3249 f->terminal = dpyinfo->terminal;
3251 f->output_method = output_x_window;
3252 f->output_data.x = xzalloc (sizeof *f->output_data.x);
3253 f->output_data.x->icon_bitmap = -1;
3254 FRAME_FONTSET (f) = -1;
3255 f->output_data.x->scroll_bar_foreground_pixel = -1;
3256 f->output_data.x->scroll_bar_background_pixel = -1;
3257 #if defined (USE_LUCID) && defined (USE_TOOLKIT_SCROLL_BARS)
3258 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3259 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3260 #endif /* USE_LUCID && USE_TOOLKIT_SCROLL_BARS */
3261 f->output_data.x->white_relief.pixel = -1;
3262 f->output_data.x->black_relief.pixel = -1;
3264 fset_icon_name (f,
3265 x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3266 RES_TYPE_STRING));
3267 if (! STRINGP (f->icon_name))
3268 fset_icon_name (f, Qnil);
3270 FRAME_DISPLAY_INFO (f) = dpyinfo;
3272 /* With FRAME_DISPLAY_INFO set up, this unwind-protect is safe. */
3273 record_unwind_protect (do_unwind_create_frame, frame);
3275 /* These colors will be set anyway later, but it's important
3276 to get the color reference counts right, so initialize them! */
3278 Lisp_Object black;
3280 /* Function x_decode_color can signal an error. Make
3281 sure to initialize color slots so that we won't try
3282 to free colors we haven't allocated. */
3283 FRAME_FOREGROUND_PIXEL (f) = -1;
3284 FRAME_BACKGROUND_PIXEL (f) = -1;
3285 f->output_data.x->cursor_pixel = -1;
3286 f->output_data.x->cursor_foreground_pixel = -1;
3287 f->output_data.x->border_pixel = -1;
3288 f->output_data.x->mouse_pixel = -1;
3290 black = build_string ("black");
3291 FRAME_FOREGROUND_PIXEL (f)
3292 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3293 FRAME_BACKGROUND_PIXEL (f)
3294 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3295 f->output_data.x->cursor_pixel
3296 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3297 f->output_data.x->cursor_foreground_pixel
3298 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3299 f->output_data.x->border_pixel
3300 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3301 f->output_data.x->mouse_pixel
3302 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3305 /* Specify the parent under which to make this X window. */
3306 if (!NILP (parent))
3308 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3309 f->output_data.x->explicit_parent = true;
3311 else
3313 f->output_data.x->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
3314 f->output_data.x->explicit_parent = false;
3317 /* Set the name; the functions to which we pass f expect the name to
3318 be set. */
3319 if (EQ (name, Qunbound) || NILP (name))
3321 fset_name (f, build_string (dpyinfo->x_id_name));
3322 f->explicit_name = false;
3324 else
3326 fset_name (f, name);
3327 f->explicit_name = true;
3328 /* Use the frame's title when getting resources for this frame. */
3329 specbind (Qx_resource_name, name);
3332 #ifdef USE_CAIRO
3333 register_font_driver (&ftcrfont_driver, f);
3334 #else
3335 #ifdef HAVE_FREETYPE
3336 #ifdef HAVE_XFT
3337 register_font_driver (&xftfont_driver, f);
3338 #else /* not HAVE_XFT */
3339 register_font_driver (&ftxfont_driver, f);
3340 #endif /* not HAVE_XFT */
3341 #endif /* HAVE_FREETYPE */
3342 register_font_driver (&xfont_driver, f);
3343 #endif /* not USE_CAIRO */
3345 image_cache_refcount =
3346 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
3347 #ifdef GLYPH_DEBUG
3348 dpyinfo_refcount = dpyinfo->reference_count;
3349 #endif /* GLYPH_DEBUG */
3351 x_default_parameter (f, parms, Qfont_backend, Qnil,
3352 "fontBackend", "FontBackend", RES_TYPE_STRING);
3354 /* Extract the window parameters from the supplied values
3355 that are needed to determine window geometry. */
3356 x_default_font_parameter (f, parms);
3357 if (!FRAME_FONT (f))
3359 delete_frame (frame, Qnoelisp);
3360 error ("Invalid frame font");
3363 /* Frame contents get displaced if an embedded X window has a border. */
3364 if (! FRAME_X_EMBEDDED_P (f))
3365 x_default_parameter (f, parms, Qborder_width, make_number (0),
3366 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3368 /* This defaults to 1 in order to match xterm. We recognize either
3369 internalBorderWidth or internalBorder (which is what xterm calls
3370 it). */
3371 if (NILP (Fassq (Qinternal_border_width, parms)))
3373 Lisp_Object value;
3375 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3376 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3377 if (! EQ (value, Qunbound))
3378 parms = Fcons (Fcons (Qinternal_border_width, value),
3379 parms);
3381 x_default_parameter (f, parms, Qinternal_border_width,
3382 #ifdef USE_GTK /* We used to impose 0 in xg_create_frame_widgets. */
3383 make_number (0),
3384 #else
3385 make_number (1),
3386 #endif
3387 "internalBorderWidth", "internalBorderWidth",
3388 RES_TYPE_NUMBER);
3389 x_default_parameter (f, parms, Qright_divider_width, make_number (0),
3390 NULL, NULL, RES_TYPE_NUMBER);
3391 x_default_parameter (f, parms, Qbottom_divider_width, make_number (0),
3392 NULL, NULL, RES_TYPE_NUMBER);
3393 x_default_parameter (f, parms, Qvertical_scroll_bars,
3394 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3395 Qright,
3396 #else
3397 Qleft,
3398 #endif
3399 "verticalScrollBars", "ScrollBars",
3400 RES_TYPE_SYMBOL);
3401 x_default_parameter (f, parms, Qhorizontal_scroll_bars, Qnil,
3402 "horizontalScrollBars", "ScrollBars",
3403 RES_TYPE_SYMBOL);
3404 /* Also do the stuff which must be set before the window exists. */
3405 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3406 "foreground", "Foreground", RES_TYPE_STRING);
3407 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3408 "background", "Background", RES_TYPE_STRING);
3409 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3410 "pointerColor", "Foreground", RES_TYPE_STRING);
3411 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3412 "borderColor", "BorderColor", RES_TYPE_STRING);
3413 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3414 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3415 x_default_parameter (f, parms, Qline_spacing, Qnil,
3416 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3417 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3418 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3419 x_default_parameter (f, parms, Qright_fringe, Qnil,
3420 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3422 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3423 "scrollBarForeground",
3424 "ScrollBarForeground", true);
3425 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3426 "scrollBarBackground",
3427 "ScrollBarBackground", false);
3429 /* Init faces before x_default_parameter is called for the
3430 scroll-bar-width parameter because otherwise we end up in
3431 init_iterator with a null face cache, which should not happen. */
3432 init_frame_faces (f);
3434 /* The following call of change_frame_size is needed since otherwise
3435 x_set_tool_bar_lines will already work with the character sizes
3436 installed by init_frame_faces while the frame's pixel size is
3437 still calculated from a character size of 1 and we subsequently
3438 hit the (height >= 0) assertion in window_box_height.
3440 The non-pixelwise code apparently worked around this because it
3441 had one frame line vs one toolbar line which left us with a zero
3442 root window height which was obviously wrong as well ... */
3443 adjust_frame_size (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
3444 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 5, true,
3445 Qx_create_frame_1);
3447 /* Set the menu-bar-lines and tool-bar-lines parameters. We don't
3448 look up the X resources controlling the menu-bar and tool-bar
3449 here; they are processed specially at startup, and reflected in
3450 the values of the mode variables. */
3452 x_default_parameter (f, parms, Qmenu_bar_lines,
3453 NILP (Vmenu_bar_mode)
3454 ? make_number (0) : make_number (1),
3455 NULL, NULL, RES_TYPE_NUMBER);
3456 x_default_parameter (f, parms, Qtool_bar_lines,
3457 NILP (Vtool_bar_mode)
3458 ? make_number (0) : make_number (1),
3459 NULL, NULL, RES_TYPE_NUMBER);
3461 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3462 "bufferPredicate", "BufferPredicate",
3463 RES_TYPE_SYMBOL);
3464 x_default_parameter (f, parms, Qtitle, Qnil,
3465 "title", "Title", RES_TYPE_STRING);
3466 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3467 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3468 x_default_parameter (f, parms, Qtool_bar_position,
3469 FRAME_TOOL_BAR_POSITION (f), 0, 0, RES_TYPE_SYMBOL);
3471 /* Compute the size of the X window. */
3472 window_prompting = x_figure_window_size (f, parms, true, &x_width, &x_height);
3474 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3475 f->no_split = minibuffer_only || EQ (tem, Qt);
3477 x_icon_verify (f, parms);
3479 /* Create the X widget or window. */
3480 #ifdef USE_X_TOOLKIT
3481 x_window (f, window_prompting);
3482 #else
3483 x_window (f);
3484 #endif
3486 x_icon (f, parms);
3487 x_make_gc (f);
3489 /* Now consider the frame official. */
3490 f->terminal->reference_count++;
3491 FRAME_DISPLAY_INFO (f)->reference_count++;
3492 Vframe_list = Fcons (frame, Vframe_list);
3494 /* We need to do this after creating the X window, so that the
3495 icon-creation functions can say whose icon they're describing. */
3496 x_default_parameter (f, parms, Qicon_type, Qt,
3497 "bitmapIcon", "BitmapIcon", RES_TYPE_BOOLEAN);
3499 x_default_parameter (f, parms, Qauto_raise, Qnil,
3500 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3501 x_default_parameter (f, parms, Qauto_lower, Qnil,
3502 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3503 x_default_parameter (f, parms, Qcursor_type, Qbox,
3504 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3505 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3506 "scrollBarWidth", "ScrollBarWidth",
3507 RES_TYPE_NUMBER);
3508 x_default_parameter (f, parms, Qscroll_bar_height, Qnil,
3509 "scrollBarHeight", "ScrollBarHeight",
3510 RES_TYPE_NUMBER);
3511 x_default_parameter (f, parms, Qalpha, Qnil,
3512 "alpha", "Alpha", RES_TYPE_NUMBER);
3514 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3515 /* Create the menu bar. */
3516 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3518 /* If this signals an error, we haven't set size hints for the
3519 frame and we didn't make it visible. */
3520 initialize_frame_menubar (f);
3522 #ifndef USE_GTK
3523 /* This is a no-op, except under Motif where it arranges the
3524 main window for the widgets on it. */
3525 lw_set_main_areas (f->output_data.x->column_widget,
3526 f->output_data.x->menubar_widget,
3527 f->output_data.x->edit_widget);
3528 #endif /* not USE_GTK */
3530 #endif /* USE_X_TOOLKIT || USE_GTK */
3532 /* Consider frame official, now. */
3533 f->can_x_set_window_size = true;
3535 if (x_width > 0)
3536 SET_FRAME_WIDTH (f, x_width);
3537 if (x_height > 0)
3538 SET_FRAME_HEIGHT (f, x_height);
3540 /* Tell the server what size and position, etc, we want, and how
3541 badly we want them. This should be done after we have the menu
3542 bar so that its size can be taken into account. */
3543 block_input ();
3544 x_wm_set_size_hint (f, window_prompting, false);
3545 unblock_input ();
3547 adjust_frame_size (f, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (f),
3548 0, true, Qx_create_frame_2);
3550 /* Process fullscreen parameter here in the hope that normalizing a
3551 fullheight/fullwidth frame will produce the size set by the last
3552 adjust_frame_size call. */
3553 x_default_parameter (f, parms, Qfullscreen, Qnil,
3554 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3556 /* Make the window appear on the frame and enable display, unless
3557 the caller says not to. However, with explicit parent, Emacs
3558 cannot control visibility, so don't try. */
3559 if (! f->output_data.x->explicit_parent)
3561 Lisp_Object visibility;
3563 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3564 RES_TYPE_SYMBOL);
3565 if (EQ (visibility, Qunbound))
3566 visibility = Qt;
3568 if (EQ (visibility, Qicon))
3569 x_iconify_frame (f);
3570 else if (! NILP (visibility))
3571 x_make_frame_visible (f);
3572 else
3574 /* Must have been Qnil. */
3578 block_input ();
3580 /* Set machine name and pid for the purpose of window managers. */
3581 set_machine_and_pid_properties (f);
3583 /* Set the WM leader property. GTK does this itself, so this is not
3584 needed when using GTK. */
3585 if (dpyinfo->client_leader_window != 0)
3587 XChangeProperty (FRAME_X_DISPLAY (f),
3588 FRAME_OUTER_WINDOW (f),
3589 dpyinfo->Xatom_wm_client_leader,
3590 XA_WINDOW, 32, PropModeReplace,
3591 (unsigned char *) &dpyinfo->client_leader_window, 1);
3594 unblock_input ();
3596 /* Initialize `default-minibuffer-frame' in case this is the first
3597 frame on this terminal. */
3598 if (FRAME_HAS_MINIBUF_P (f)
3599 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
3600 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
3601 kset_default_minibuffer_frame (kb, frame);
3603 /* All remaining specified parameters, which have not been "used"
3604 by x_get_arg and friends, now go in the misc. alist of the frame. */
3605 for (tem = parms; CONSP (tem); tem = XCDR (tem))
3606 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3607 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
3609 /* Make sure windows on this frame appear in calls to next-window
3610 and similar functions. */
3611 Vwindow_list = Qnil;
3613 return unbind_to (count, frame);
3617 /* FRAME is used only to get a handle on the X display. We don't pass the
3618 display info directly because we're called from frame.c, which doesn't
3619 know about that structure. */
3621 Lisp_Object
3622 x_get_focus_frame (struct frame *frame)
3624 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
3625 Lisp_Object xfocus;
3626 if (! dpyinfo->x_focus_frame)
3627 return Qnil;
3629 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3630 return xfocus;
3634 /* In certain situations, when the window manager follows a
3635 click-to-focus policy, there seems to be no way around calling
3636 XSetInputFocus to give another frame the input focus .
3638 In an ideal world, XSetInputFocus should generally be avoided so
3639 that applications don't interfere with the window manager's focus
3640 policy. But I think it's okay to use when it's clearly done
3641 following a user-command. */
3643 void
3644 x_focus_frame (struct frame *f)
3646 Display *dpy = FRAME_X_DISPLAY (f);
3648 block_input ();
3649 x_catch_errors (dpy);
3651 if (FRAME_X_EMBEDDED_P (f))
3653 /* For Xembedded frames, normally the embedder forwards key
3654 events. See XEmbed Protocol Specification at
3655 http://freedesktop.org/wiki/Specifications/xembed-spec */
3656 xembed_request_focus (f);
3658 else
3660 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3661 RevertToParent, CurrentTime);
3662 x_ewmh_activate_frame (f);
3665 x_uncatch_errors ();
3666 unblock_input ();
3670 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3671 doc: /* Internal function called by `color-defined-p', which see.
3672 \(Note that the Nextstep version of this function ignores FRAME.) */)
3673 (Lisp_Object color, Lisp_Object frame)
3675 XColor foo;
3676 struct frame *f = decode_window_system_frame (frame);
3678 CHECK_STRING (color);
3680 if (x_defined_color (f, SSDATA (color), &foo, false))
3681 return Qt;
3682 else
3683 return Qnil;
3686 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3687 doc: /* Internal function called by `color-values', which see. */)
3688 (Lisp_Object color, Lisp_Object frame)
3690 XColor foo;
3691 struct frame *f = decode_window_system_frame (frame);
3693 CHECK_STRING (color);
3695 if (x_defined_color (f, SSDATA (color), &foo, false))
3696 return list3i (foo.red, foo.green, foo.blue);
3697 else
3698 return Qnil;
3701 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3702 doc: /* Internal function called by `display-color-p', which see. */)
3703 (Lisp_Object terminal)
3705 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3707 if (dpyinfo->n_planes <= 2)
3708 return Qnil;
3710 switch (dpyinfo->visual->class)
3712 case StaticColor:
3713 case PseudoColor:
3714 case TrueColor:
3715 case DirectColor:
3716 return Qt;
3718 default:
3719 return Qnil;
3723 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3724 0, 1, 0,
3725 doc: /* Return t if the X display supports shades of gray.
3726 Note that color displays do support shades of gray.
3727 The optional argument TERMINAL specifies which display to ask about.
3728 TERMINAL should be a terminal object, a frame or a display name (a string).
3729 If omitted or nil, that stands for the selected frame's display. */)
3730 (Lisp_Object terminal)
3732 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3734 if (dpyinfo->n_planes <= 1)
3735 return Qnil;
3737 switch (dpyinfo->visual->class)
3739 case StaticColor:
3740 case PseudoColor:
3741 case TrueColor:
3742 case DirectColor:
3743 case StaticGray:
3744 case GrayScale:
3745 return Qt;
3747 default:
3748 return Qnil;
3752 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3753 0, 1, 0,
3754 doc: /* Return the width in pixels of the X display TERMINAL.
3755 The optional argument TERMINAL specifies which display to ask about.
3756 TERMINAL should be a terminal object, a frame or a display name (a string).
3757 If omitted or nil, that stands for the selected frame's display.
3759 On \"multi-monitor\" setups this refers to the pixel width for all
3760 physical monitors associated with TERMINAL. To get information for
3761 each physical monitor, use `display-monitor-attributes-list'. */)
3762 (Lisp_Object terminal)
3764 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3766 return make_number (x_display_pixel_width (dpyinfo));
3769 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3770 Sx_display_pixel_height, 0, 1, 0,
3771 doc: /* Return the height in pixels of the X display TERMINAL.
3772 The optional argument TERMINAL specifies which display to ask about.
3773 TERMINAL should be a terminal object, a frame or a display name (a string).
3774 If omitted or nil, that stands for the selected frame's display.
3776 On \"multi-monitor\" setups this refers to the pixel height for all
3777 physical monitors associated with TERMINAL. To get information for
3778 each physical monitor, use `display-monitor-attributes-list'. */)
3779 (Lisp_Object terminal)
3781 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3783 return make_number (x_display_pixel_height (dpyinfo));
3786 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3787 0, 1, 0,
3788 doc: /* Return the number of bitplanes of the X display TERMINAL.
3789 The optional argument TERMINAL specifies which display to ask about.
3790 TERMINAL should be a terminal object, a frame or a display name (a string).
3791 If omitted or nil, that stands for the selected frame's display. */)
3792 (Lisp_Object terminal)
3794 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3796 return make_number (dpyinfo->n_planes);
3799 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3800 0, 1, 0,
3801 doc: /* Return the number of color cells of the X display TERMINAL.
3802 The optional argument TERMINAL specifies which display to ask about.
3803 TERMINAL should be a terminal object, a frame or a display name (a string).
3804 If omitted or nil, that stands for the selected frame's display. */)
3805 (Lisp_Object terminal)
3807 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3809 int nr_planes = DisplayPlanes (dpyinfo->display,
3810 XScreenNumberOfScreen (dpyinfo->screen));
3812 /* Truncate nr_planes to 24 to avoid integer overflow.
3813 Some displays says 32, but only 24 bits are actually significant.
3814 There are only very few and rare video cards that have more than
3815 24 significant bits. Also 24 bits is more than 16 million colors,
3816 it "should be enough for everyone". */
3817 if (nr_planes > 24) nr_planes = 24;
3819 return make_number (1 << nr_planes);
3822 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3823 Sx_server_max_request_size,
3824 0, 1, 0,
3825 doc: /* Return the maximum request size of the X server of display TERMINAL.
3826 The optional argument TERMINAL specifies which display to ask about.
3827 TERMINAL should be a terminal object, a frame or a display name (a string).
3828 If omitted or nil, that stands for the selected frame's display. */)
3829 (Lisp_Object terminal)
3831 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3833 return make_number (MAXREQUEST (dpyinfo->display));
3836 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3837 doc: /* Return the "vendor ID" string of the GUI software on TERMINAL.
3839 \(Labeling every distributor as a "vendor" embodies the false assumption
3840 that operating systems cannot be developed and distributed noncommercially.)
3841 The optional argument TERMINAL specifies which display to ask about.
3843 For GNU and Unix systems, this queries the X server software; for
3844 MS-Windows, this queries the OS.
3846 TERMINAL should be a terminal object, a frame or a display name (a string).
3847 If omitted or nil, that stands for the selected frame's display. */)
3848 (Lisp_Object terminal)
3850 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3851 const char *vendor = ServerVendor (dpyinfo->display);
3853 if (! vendor) vendor = "";
3854 return build_string (vendor);
3857 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3858 doc: /* Return the version numbers of the GUI software on TERMINAL.
3859 The value is a list of three integers specifying the version of the GUI
3860 software in use.
3862 For GNU and Unix system, the first 2 numbers are the version of the X
3863 Protocol used on TERMINAL and the 3rd number is the distributor-specific
3864 release number. For MS-Windows, the 3 numbers report the version and
3865 the build number of the OS.
3867 See also the function `x-server-vendor'.
3869 The optional argument TERMINAL specifies which display to ask about.
3870 TERMINAL should be a terminal object, a frame or a display name (a string).
3871 If omitted or nil, that stands for the selected frame's display. */)
3872 (Lisp_Object terminal)
3874 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3875 Display *dpy = dpyinfo->display;
3877 return list3i (ProtocolVersion (dpy), ProtocolRevision (dpy),
3878 VendorRelease (dpy));
3881 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3882 doc: /* Return the number of screens on the X server of display TERMINAL.
3883 The optional argument TERMINAL specifies which display to ask about.
3884 TERMINAL should be a terminal object, a frame or a display name (a string).
3885 If omitted or nil, that stands for the selected frame's display. */)
3886 (Lisp_Object terminal)
3888 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3890 return make_number (ScreenCount (dpyinfo->display));
3893 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3894 doc: /* Return the height in millimeters of the X display TERMINAL.
3895 The optional argument TERMINAL specifies which display to ask about.
3896 TERMINAL should be a terminal object, a frame or a display name (a string).
3897 If omitted or nil, that stands for the selected frame's display.
3899 On \"multi-monitor\" setups this refers to the height in millimeters for
3900 all physical monitors associated with TERMINAL. To get information
3901 for each physical monitor, use `display-monitor-attributes-list'. */)
3902 (Lisp_Object terminal)
3904 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3906 return make_number (HeightMMOfScreen (dpyinfo->screen));
3909 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3910 doc: /* Return the width in millimeters of the X display TERMINAL.
3911 The optional argument TERMINAL specifies which display to ask about.
3912 TERMINAL should be a terminal object, a frame or a display name (a string).
3913 If omitted or nil, that stands for the selected frame's display.
3915 On \"multi-monitor\" setups this refers to the width in millimeters for
3916 all physical monitors associated with TERMINAL. To get information
3917 for each physical monitor, use `display-monitor-attributes-list'. */)
3918 (Lisp_Object terminal)
3920 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3922 return make_number (WidthMMOfScreen (dpyinfo->screen));
3925 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3926 Sx_display_backing_store, 0, 1, 0,
3927 doc: /* Return an indication of whether X display TERMINAL does backing store.
3928 The value may be `always', `when-mapped', or `not-useful'.
3929 The optional argument TERMINAL specifies which display to ask about.
3930 TERMINAL should be a terminal object, a frame or a display name (a string).
3931 If omitted or nil, that stands for the selected frame's display. */)
3932 (Lisp_Object terminal)
3934 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3935 Lisp_Object result;
3937 switch (DoesBackingStore (dpyinfo->screen))
3939 case Always:
3940 result = intern ("always");
3941 break;
3943 case WhenMapped:
3944 result = intern ("when-mapped");
3945 break;
3947 case NotUseful:
3948 result = intern ("not-useful");
3949 break;
3951 default:
3952 error ("Strange value for BackingStore parameter of screen");
3955 return result;
3958 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3959 Sx_display_visual_class, 0, 1, 0,
3960 doc: /* Return the visual class of the X display TERMINAL.
3961 The value is one of the symbols `static-gray', `gray-scale',
3962 `static-color', `pseudo-color', `true-color', or `direct-color'.
3964 The optional argument TERMINAL specifies which display to ask about.
3965 TERMINAL should a terminal object, a frame or a display name (a string).
3966 If omitted or nil, that stands for the selected frame's display. */)
3967 (Lisp_Object terminal)
3969 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3970 Lisp_Object result;
3972 switch (dpyinfo->visual->class)
3974 case StaticGray:
3975 result = intern ("static-gray");
3976 break;
3977 case GrayScale:
3978 result = intern ("gray-scale");
3979 break;
3980 case StaticColor:
3981 result = intern ("static-color");
3982 break;
3983 case PseudoColor:
3984 result = intern ("pseudo-color");
3985 break;
3986 case TrueColor:
3987 result = intern ("true-color");
3988 break;
3989 case DirectColor:
3990 result = intern ("direct-color");
3991 break;
3992 default:
3993 error ("Display has an unknown visual class");
3996 return result;
3999 DEFUN ("x-display-save-under", Fx_display_save_under,
4000 Sx_display_save_under, 0, 1, 0,
4001 doc: /* Return t if the X display TERMINAL supports the save-under feature.
4002 The optional argument TERMINAL specifies which display to ask about.
4003 TERMINAL should be a terminal object, a frame or a display name (a string).
4004 If omitted or nil, that stands for the selected frame's display. */)
4005 (Lisp_Object terminal)
4007 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4009 if (DoesSaveUnders (dpyinfo->screen) == True)
4010 return Qt;
4011 else
4012 return Qnil;
4015 /* Store the geometry of the workarea on display DPYINFO into *RECT.
4016 Return false if and only if the workarea information cannot be
4017 obtained via the _NET_WORKAREA root window property. */
4019 #if ! GTK_CHECK_VERSION (3, 4, 0)
4020 static bool
4021 x_get_net_workarea (struct x_display_info *dpyinfo, XRectangle *rect)
4023 Display *dpy = dpyinfo->display;
4024 long offset, max_len;
4025 Atom target_type, actual_type;
4026 unsigned long actual_size, bytes_remaining;
4027 int rc, actual_format;
4028 unsigned char *tmp_data = NULL;
4029 bool result = false;
4031 x_catch_errors (dpy);
4032 offset = 0;
4033 max_len = 1;
4034 target_type = XA_CARDINAL;
4035 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
4036 dpyinfo->Xatom_net_current_desktop,
4037 offset, max_len, False, target_type,
4038 &actual_type, &actual_format, &actual_size,
4039 &bytes_remaining, &tmp_data);
4040 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
4041 && actual_format == 32 && actual_size == max_len)
4043 long current_desktop = ((long *) tmp_data)[0];
4045 XFree (tmp_data);
4046 tmp_data = NULL;
4048 offset = 4 * current_desktop;
4049 max_len = 4;
4050 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
4051 dpyinfo->Xatom_net_workarea,
4052 offset, max_len, False, target_type,
4053 &actual_type, &actual_format, &actual_size,
4054 &bytes_remaining, &tmp_data);
4055 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
4056 && actual_format == 32 && actual_size == max_len)
4058 long *values = (long *) tmp_data;
4060 rect->x = values[0];
4061 rect->y = values[1];
4062 rect->width = values[2];
4063 rect->height = values[3];
4065 XFree (tmp_data);
4066 tmp_data = NULL;
4068 result = true;
4071 if (tmp_data)
4072 XFree (tmp_data);
4073 x_uncatch_errors ();
4075 return result;
4077 #endif
4079 #ifndef USE_GTK
4081 /* Return monitor number where F is "most" or closest to. */
4082 static int
4083 x_get_monitor_for_frame (struct frame *f,
4084 struct MonitorInfo *monitors,
4085 int n_monitors)
4087 XRectangle frect;
4088 int area = 0, dist = -1;
4089 int best_area = -1, best_dist = -1;
4090 int i;
4092 if (n_monitors == 1) return 0;
4093 frect.x = f->left_pos;
4094 frect.y = f->top_pos;
4095 frect.width = FRAME_PIXEL_WIDTH (f);
4096 frect.height = FRAME_PIXEL_HEIGHT (f);
4098 for (i = 0; i < n_monitors; ++i)
4100 struct MonitorInfo *mi = &monitors[i];
4101 XRectangle res;
4102 int a = 0;
4104 if (mi->geom.width == 0) continue;
4106 if (x_intersect_rectangles (&mi->geom, &frect, &res))
4108 a = res.width * res.height;
4109 if (a > area)
4111 area = a;
4112 best_area = i;
4116 if (a == 0 && area == 0)
4118 int dx, dy, d;
4119 if (frect.x + frect.width < mi->geom.x)
4120 dx = mi->geom.x - frect.x + frect.width;
4121 else if (frect.x > mi->geom.x + mi->geom.width)
4122 dx = frect.x - mi->geom.x + mi->geom.width;
4123 else
4124 dx = 0;
4125 if (frect.y + frect.height < mi->geom.y)
4126 dy = mi->geom.y - frect.y + frect.height;
4127 else if (frect.y > mi->geom.y + mi->geom.height)
4128 dy = frect.y - mi->geom.y + mi->geom.height;
4129 else
4130 dy = 0;
4132 d = dx*dx + dy*dy;
4133 if (dist == -1 || dist > d)
4135 dist = d;
4136 best_dist = i;
4141 return best_area != -1 ? best_area : (best_dist != -1 ? best_dist : 0);
4144 static Lisp_Object
4145 x_make_monitor_attribute_list (struct MonitorInfo *monitors,
4146 int n_monitors,
4147 int primary_monitor,
4148 struct x_display_info *dpyinfo,
4149 const char *source)
4151 Lisp_Object monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4152 Lisp_Object frame, rest;
4154 FOR_EACH_FRAME (rest, frame)
4156 struct frame *f = XFRAME (frame);
4158 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo
4159 && !EQ (frame, tip_frame))
4161 int i = x_get_monitor_for_frame (f, monitors, n_monitors);
4162 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
4166 return make_monitor_attribute_list (monitors, n_monitors, primary_monitor,
4167 monitor_frames, source);
4170 static Lisp_Object
4171 x_get_monitor_attributes_fallback (struct x_display_info *dpyinfo)
4173 struct MonitorInfo monitor;
4174 XRectangle workarea_r;
4176 /* Fallback: treat (possibly) multiple physical monitors as if they
4177 formed a single monitor as a whole. This should provide a
4178 consistent result at least on single monitor environments. */
4179 monitor.geom.x = monitor.geom.y = 0;
4180 monitor.geom.width = x_display_pixel_width (dpyinfo);
4181 monitor.geom.height = x_display_pixel_height (dpyinfo);
4182 monitor.mm_width = WidthMMOfScreen (dpyinfo->screen);
4183 monitor.mm_height = HeightMMOfScreen (dpyinfo->screen);
4184 monitor.name = xstrdup ("combined screen");
4186 if (x_get_net_workarea (dpyinfo, &workarea_r))
4187 monitor.work = workarea_r;
4188 else
4189 monitor.work = monitor.geom;
4190 return x_make_monitor_attribute_list (&monitor, 1, 0, dpyinfo, "fallback");
4194 #ifdef HAVE_XINERAMA
4195 static Lisp_Object
4196 x_get_monitor_attributes_xinerama (struct x_display_info *dpyinfo)
4198 int n_monitors, i;
4199 Lisp_Object attributes_list = Qnil;
4200 Display *dpy = dpyinfo->display;
4201 XineramaScreenInfo *info = XineramaQueryScreens (dpy, &n_monitors);
4202 struct MonitorInfo *monitors;
4203 double mm_width_per_pixel, mm_height_per_pixel;
4205 if (! info || n_monitors == 0)
4207 if (info)
4208 XFree (info);
4209 return attributes_list;
4212 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
4213 / x_display_pixel_width (dpyinfo));
4214 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
4215 / x_display_pixel_height (dpyinfo));
4216 monitors = xzalloc (n_monitors * sizeof *monitors);
4217 for (i = 0; i < n_monitors; ++i)
4219 struct MonitorInfo *mi = &monitors[i];
4220 XRectangle workarea_r;
4222 mi->geom.x = info[i].x_org;
4223 mi->geom.y = info[i].y_org;
4224 mi->geom.width = info[i].width;
4225 mi->geom.height = info[i].height;
4226 mi->mm_width = mi->geom.width * mm_width_per_pixel + 0.5;
4227 mi->mm_height = mi->geom.height * mm_height_per_pixel + 0.5;
4228 mi->name = 0;
4230 /* Xinerama usually have primary monitor first, just use that. */
4231 if (i == 0 && x_get_net_workarea (dpyinfo, &workarea_r))
4233 mi->work = workarea_r;
4234 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
4235 mi->work = mi->geom;
4237 else
4238 mi->work = mi->geom;
4240 XFree (info);
4242 attributes_list = x_make_monitor_attribute_list (monitors,
4243 n_monitors,
4245 dpyinfo,
4246 "Xinerama");
4247 free_monitors (monitors, n_monitors);
4248 return attributes_list;
4250 #endif /* HAVE_XINERAMA */
4253 #ifdef HAVE_XRANDR
4254 static Lisp_Object
4255 x_get_monitor_attributes_xrandr (struct x_display_info *dpyinfo)
4257 Lisp_Object attributes_list = Qnil;
4258 XRRScreenResources *resources;
4259 Display *dpy = dpyinfo->display;
4260 int i, n_monitors, primary = -1;
4261 RROutput pxid = None;
4262 struct MonitorInfo *monitors;
4264 #define RANDR13_LIBRARY \
4265 (RANDR_MAJOR > 1 || (RANDR_MAJOR == 1 && RANDR_MINOR >= 3))
4267 #if RANDR13_LIBRARY
4268 /* Check if the display supports 1.3 too. */
4269 bool randr13_avail = (dpyinfo->xrandr_major_version > 1
4270 || (dpyinfo->xrandr_major_version == 1
4271 && dpyinfo->xrandr_minor_version >= 3));
4273 if (randr13_avail)
4274 resources = XRRGetScreenResourcesCurrent (dpy, dpyinfo->root_window);
4275 else
4276 resources = XRRGetScreenResources (dpy, dpyinfo->root_window);
4277 #else
4278 resources = XRRGetScreenResources (dpy, dpyinfo->root_window);
4279 #endif
4280 if (! resources || resources->noutput == 0)
4282 if (resources)
4283 XRRFreeScreenResources (resources);
4284 return Qnil;
4286 n_monitors = resources->noutput;
4287 monitors = xzalloc (n_monitors * sizeof *monitors);
4289 #if RANDR13_LIBRARY
4290 if (randr13_avail)
4291 pxid = XRRGetOutputPrimary (dpy, dpyinfo->root_window);
4292 #endif
4294 for (i = 0; i < n_monitors; ++i)
4296 XRROutputInfo *info = XRRGetOutputInfo (dpy, resources,
4297 resources->outputs[i]);
4298 Connection conn = info ? info->connection : RR_Disconnected;
4299 RRCrtc id = info ? info->crtc : None;
4301 if (strcmp (info->name, "default") == 0)
4303 /* Non XRandr 1.2 driver, does not give useful data. */
4304 XRRFreeOutputInfo (info);
4305 XRRFreeScreenResources (resources);
4306 free_monitors (monitors, n_monitors);
4307 return Qnil;
4310 if (conn != RR_Disconnected && id != None)
4312 XRRCrtcInfo *crtc = XRRGetCrtcInfo (dpy, resources, id);
4313 struct MonitorInfo *mi = &monitors[i];
4314 XRectangle workarea_r;
4316 if (! crtc)
4318 XRRFreeOutputInfo (info);
4319 continue;
4322 mi->geom.x = crtc->x;
4323 mi->geom.y = crtc->y;
4324 mi->geom.width = crtc->width;
4325 mi->geom.height = crtc->height;
4326 mi->mm_width = info->mm_width;
4327 mi->mm_height = info->mm_height;
4328 mi->name = xstrdup (info->name);
4330 if (pxid != None && pxid == resources->outputs[i])
4331 primary = i;
4332 else if (primary == -1 && strcmp (info->name, "LVDS") == 0)
4333 primary = i;
4335 if (i == primary && x_get_net_workarea (dpyinfo, &workarea_r))
4337 mi->work= workarea_r;
4338 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
4339 mi->work = mi->geom;
4341 else
4342 mi->work = mi->geom;
4344 XRRFreeCrtcInfo (crtc);
4346 XRRFreeOutputInfo (info);
4348 XRRFreeScreenResources (resources);
4350 attributes_list = x_make_monitor_attribute_list (monitors,
4351 n_monitors,
4352 primary,
4353 dpyinfo,
4354 "XRandr");
4355 free_monitors (monitors, n_monitors);
4356 return attributes_list;
4358 #endif /* HAVE_XRANDR */
4360 static Lisp_Object
4361 x_get_monitor_attributes (struct x_display_info *dpyinfo)
4363 Lisp_Object attributes_list = Qnil;
4364 Display *dpy = dpyinfo->display;
4366 (void) dpy; /* Suppress unused variable warning. */
4368 #ifdef HAVE_XRANDR
4369 int xrr_event_base, xrr_error_base;
4370 bool xrr_ok = false;
4371 xrr_ok = XRRQueryExtension (dpy, &xrr_event_base, &xrr_error_base);
4372 if (xrr_ok)
4374 XRRQueryVersion (dpy, &dpyinfo->xrandr_major_version,
4375 &dpyinfo->xrandr_minor_version);
4376 xrr_ok = ((dpyinfo->xrandr_major_version == 1
4377 && dpyinfo->xrandr_minor_version >= 2)
4378 || dpyinfo->xrandr_major_version > 1);
4381 if (xrr_ok)
4382 attributes_list = x_get_monitor_attributes_xrandr (dpyinfo);
4383 #endif /* HAVE_XRANDR */
4385 #ifdef HAVE_XINERAMA
4386 if (NILP (attributes_list))
4388 int xin_event_base, xin_error_base;
4389 bool xin_ok = false;
4390 xin_ok = XineramaQueryExtension (dpy, &xin_event_base, &xin_error_base);
4391 if (xin_ok && XineramaIsActive (dpy))
4392 attributes_list = x_get_monitor_attributes_xinerama (dpyinfo);
4394 #endif /* HAVE_XINERAMA */
4396 if (NILP (attributes_list))
4397 attributes_list = x_get_monitor_attributes_fallback (dpyinfo);
4399 return attributes_list;
4402 #endif /* !USE_GTK */
4404 DEFUN ("x-display-monitor-attributes-list", Fx_display_monitor_attributes_list,
4405 Sx_display_monitor_attributes_list,
4406 0, 1, 0,
4407 doc: /* Return a list of physical monitor attributes on the X display TERMINAL.
4409 The optional argument TERMINAL specifies which display to ask about.
4410 TERMINAL should be a terminal object, a frame or a display name (a string).
4411 If omitted or nil, that stands for the selected frame's display.
4413 In addition to the standard attribute keys listed in
4414 `display-monitor-attributes-list', the following keys are contained in
4415 the attributes:
4417 source -- String describing the source from which multi-monitor
4418 information is obtained, one of \"Gdk\", \"XRandr\",
4419 \"Xinerama\", or \"fallback\"
4421 Internal use only, use `display-monitor-attributes-list' instead. */)
4422 (Lisp_Object terminal)
4424 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4425 Lisp_Object attributes_list = Qnil;
4427 #ifdef USE_GTK
4428 double mm_width_per_pixel, mm_height_per_pixel;
4429 GdkDisplay *gdpy;
4430 GdkScreen *gscreen;
4431 gint primary_monitor = 0, n_monitors, i;
4432 Lisp_Object monitor_frames, rest, frame;
4433 static const char *source = "Gdk";
4434 struct MonitorInfo *monitors;
4436 block_input ();
4437 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
4438 / x_display_pixel_width (dpyinfo));
4439 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
4440 / x_display_pixel_height (dpyinfo));
4441 gdpy = gdk_x11_lookup_xdisplay (dpyinfo->display);
4442 gscreen = gdk_display_get_default_screen (gdpy);
4443 #if GTK_CHECK_VERSION (2, 20, 0)
4444 primary_monitor = gdk_screen_get_primary_monitor (gscreen);
4445 #endif
4446 n_monitors = gdk_screen_get_n_monitors (gscreen);
4447 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4448 monitors = xzalloc (n_monitors * sizeof *monitors);
4450 FOR_EACH_FRAME (rest, frame)
4452 struct frame *f = XFRAME (frame);
4454 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo
4455 && !EQ (frame, tip_frame))
4457 GdkWindow *gwin = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
4459 i = gdk_screen_get_monitor_at_window (gscreen, gwin);
4460 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
4464 for (i = 0; i < n_monitors; ++i)
4466 gint width_mm = -1, height_mm = -1;
4467 GdkRectangle rec, work;
4468 struct MonitorInfo *mi = &monitors[i];
4470 gdk_screen_get_monitor_geometry (gscreen, i, &rec);
4472 #if GTK_CHECK_VERSION (2, 14, 0)
4473 width_mm = gdk_screen_get_monitor_width_mm (gscreen, i);
4474 height_mm = gdk_screen_get_monitor_height_mm (gscreen, i);
4475 #endif
4476 if (width_mm < 0)
4477 width_mm = rec.width * mm_width_per_pixel + 0.5;
4478 if (height_mm < 0)
4479 height_mm = rec.height * mm_height_per_pixel + 0.5;
4481 #if GTK_CHECK_VERSION (3, 4, 0)
4482 gdk_screen_get_monitor_workarea (gscreen, i, &work);
4483 #else
4484 /* Emulate the behavior of GTK+ 3.4. */
4486 XRectangle workarea_r;
4488 if (i == primary_monitor && x_get_net_workarea (dpyinfo, &workarea_r))
4490 work.x = workarea_r.x;
4491 work.y = workarea_r.y;
4492 work.width = workarea_r.width;
4493 work.height = workarea_r.height;
4494 if (! gdk_rectangle_intersect (&rec, &work, &work))
4495 work = rec;
4497 else
4498 work = rec;
4500 #endif
4503 mi->geom.x = rec.x;
4504 mi->geom.y = rec.y;
4505 mi->geom.width = rec.width;
4506 mi->geom.height = rec.height;
4507 mi->work.x = work.x;
4508 mi->work.y = work.y;
4509 mi->work.width = work.width;
4510 mi->work.height = work.height;
4511 mi->mm_width = width_mm;
4512 mi->mm_height = height_mm;
4514 #if GTK_CHECK_VERSION (2, 14, 0)
4515 mi->name = gdk_screen_get_monitor_plug_name (gscreen, i);
4516 #endif
4519 attributes_list = make_monitor_attribute_list (monitors,
4520 n_monitors,
4521 primary_monitor,
4522 monitor_frames,
4523 source);
4524 unblock_input ();
4525 #else /* not USE_GTK */
4527 block_input ();
4528 attributes_list = x_get_monitor_attributes (dpyinfo);
4529 unblock_input ();
4531 #endif /* not USE_GTK */
4533 return attributes_list;
4536 /* Return geometric attributes of FRAME. According to the value of
4537 ATTRIBUTES return the outer edges of FRAME (Qouter_edges), the native
4538 edges of FRAME (Qnative_edges), or the inner edges of frame
4539 (Qinner_edges). Any other value means to return the geometry as
4540 returned by Fx_frame_geometry. */
4541 static Lisp_Object
4542 frame_geometry (Lisp_Object frame, Lisp_Object attribute)
4544 struct frame *f = decode_live_frame (frame);
4545 /** XWindowAttributes atts; **/
4546 Window rootw;
4547 unsigned int ign, native_width, native_height;
4548 int xy_ign, xptr, yptr;
4549 int left_off, right_off, top_off, bottom_off;
4550 int outer_left, outer_top, outer_right, outer_bottom;
4551 int native_left, native_top, native_right, native_bottom;
4552 int inner_left, inner_top, inner_right, inner_bottom;
4553 int internal_border_width;
4554 bool menu_bar_external = false, tool_bar_external = false;
4555 int menu_bar_height = 0, menu_bar_width = 0;
4556 int tool_bar_height = 0, tool_bar_width = 0;
4558 if (FRAME_INITIAL_P (f) || !FRAME_X_P (f))
4559 return Qnil;
4561 block_input ();
4562 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
4563 &rootw, &xy_ign, &xy_ign, &native_width, &native_height,
4564 &ign, &ign);
4565 /** XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &atts); **/
4566 x_real_pos_and_offsets (f, &left_off, &right_off, &top_off, &bottom_off,
4567 NULL, NULL, &xptr, &yptr, NULL);
4568 unblock_input ();
4570 /** native_width = atts.width; **/
4571 /** native_height = atts.height; **/
4573 outer_left = xptr;
4574 outer_top = yptr;
4575 outer_right = outer_left + left_off + native_width + right_off;
4576 outer_bottom = outer_top + top_off + native_height + bottom_off;
4578 native_left = outer_left + left_off;
4579 native_top = outer_top + top_off;
4580 native_right = native_left + native_width;
4581 native_bottom = native_top + native_height;
4583 internal_border_width = FRAME_INTERNAL_BORDER_WIDTH (f);
4584 inner_left = native_left + internal_border_width;
4585 inner_top = native_top + internal_border_width;
4586 inner_right = native_right - internal_border_width;
4587 inner_bottom = native_bottom - internal_border_width;
4589 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
4590 menu_bar_external = true;
4591 menu_bar_height = FRAME_MENUBAR_HEIGHT (f);
4592 native_top += menu_bar_height;
4593 inner_top += menu_bar_height;
4594 #else
4595 menu_bar_height = FRAME_MENU_BAR_HEIGHT (f);
4596 inner_top += menu_bar_height;
4597 #endif
4598 menu_bar_width = menu_bar_height ? native_width : 0;
4600 #if defined (USE_GTK)
4601 tool_bar_external = true;
4602 if (EQ (FRAME_TOOL_BAR_POSITION (f), Qleft))
4604 tool_bar_width = FRAME_TOOLBAR_WIDTH (f);
4605 native_left += tool_bar_width;
4606 inner_left += tool_bar_width;
4607 tool_bar_height
4608 = tool_bar_width ? native_height - menu_bar_height : 0;
4610 else if (EQ (FRAME_TOOL_BAR_POSITION (f), Qtop))
4612 tool_bar_height = FRAME_TOOLBAR_HEIGHT (f);
4613 native_top += tool_bar_height;
4614 inner_top += tool_bar_height;
4615 tool_bar_width = tool_bar_height ? native_width : 0;
4617 else if (EQ (FRAME_TOOL_BAR_POSITION (f), Qright))
4619 tool_bar_width = FRAME_TOOLBAR_WIDTH (f);
4620 native_right -= tool_bar_width;
4621 inner_right -= tool_bar_width;
4622 tool_bar_height
4623 = tool_bar_width ? native_height - menu_bar_height : 0;
4625 else
4627 tool_bar_height = FRAME_TOOLBAR_HEIGHT (f);
4628 native_bottom -= tool_bar_height;
4629 inner_bottom -= tool_bar_height;
4630 tool_bar_width = tool_bar_height ? native_width : 0;
4632 #else
4633 tool_bar_height = FRAME_TOOL_BAR_HEIGHT (f);
4634 tool_bar_width = tool_bar_height ? native_width : 0;
4635 inner_top += tool_bar_height;
4636 #endif
4638 /* Construct list. */
4639 if (EQ (attribute, Qouter_edges))
4640 return list4 (make_number (outer_left), make_number (outer_top),
4641 make_number (outer_right), make_number (outer_bottom));
4642 else if (EQ (attribute, Qnative_edges))
4643 return list4 (make_number (native_left), make_number (native_top),
4644 make_number (native_right), make_number (native_bottom));
4645 else if (EQ (attribute, Qinner_edges))
4646 return list4 (make_number (inner_left), make_number (inner_top),
4647 make_number (inner_right), make_number (inner_bottom));
4648 else
4649 return
4650 listn (CONSTYPE_HEAP, 10,
4651 Fcons (Qouter_position,
4652 Fcons (make_number (outer_left),
4653 make_number (outer_top))),
4654 Fcons (Qouter_size,
4655 Fcons (make_number (outer_right - outer_left),
4656 make_number (outer_bottom - outer_top))),
4657 /* Approximate. */
4658 Fcons (Qexternal_border_size,
4659 Fcons (make_number (right_off),
4660 make_number (bottom_off))),
4661 /* Approximate. */
4662 Fcons (Qtitle_bar_size,
4663 Fcons (make_number (0),
4664 make_number (top_off - bottom_off))),
4665 Fcons (Qmenu_bar_external, menu_bar_external ? Qt : Qnil),
4666 Fcons (Qmenu_bar_size,
4667 Fcons (make_number (menu_bar_width),
4668 make_number (menu_bar_height))),
4669 Fcons (Qtool_bar_external, tool_bar_external ? Qt : Qnil),
4670 Fcons (Qtool_bar_position, FRAME_TOOL_BAR_POSITION (f)),
4671 Fcons (Qtool_bar_size,
4672 Fcons (make_number (tool_bar_width),
4673 make_number (tool_bar_height))),
4674 Fcons (Qinternal_border_width,
4675 make_number (internal_border_width)));
4678 DEFUN ("x-frame-geometry", Fx_frame_geometry, Sx_frame_geometry, 0, 1, 0,
4679 doc: /* Return geometric attributes of FRAME.
4680 FRAME must be a live frame and defaults to the selected one. The return
4681 value is an association list of the attributes listed below. All height
4682 and width values are in pixels.
4684 `outer-position' is a cons of the outer left and top edges of FRAME
4685 relative to the origin - the position (0, 0) - of FRAME's display.
4687 `outer-size' is a cons of the outer width and height of FRAME. The
4688 outer size includes the title bar and the external borders as well as
4689 any menu and/or tool bar of frame.
4691 `external-border-size' is a cons of the horizontal and vertical width of
4692 FRAME's external borders as supplied by the window manager.
4694 `title-bar-size' is a cons of the width and height of the title bar of
4695 FRAME as supplied by the window manager. If both of them are zero,
4696 FRAME has no title bar. If only the width is zero, Emacs was not
4697 able to retrieve the width information.
4699 `menu-bar-external', if non-nil, means the menu bar is external (never
4700 included in the inner edges of FRAME).
4702 `menu-bar-size' is a cons of the width and height of the menu bar of
4703 FRAME.
4705 `tool-bar-external', if non-nil, means the tool bar is external (never
4706 included in the inner edges of FRAME).
4708 `tool-bar-position' tells on which side the tool bar on FRAME is and can
4709 be one of `left', `top', `right' or `bottom'. If this is nil, FRAME
4710 has no tool bar.
4712 `tool-bar-size' is a cons of the width and height of the tool bar of
4713 FRAME.
4715 `internal-border-width' is the width of the internal border of
4716 FRAME. */)
4717 (Lisp_Object frame)
4719 return frame_geometry (frame, Qnil);
4722 DEFUN ("x-frame-edges", Fx_frame_edges, Sx_frame_edges, 0, 2, 0,
4723 doc: /* Return edge coordinates of FRAME.
4724 FRAME must be a live frame and defaults to the selected one. The return
4725 value is a list of the form (LEFT, TOP, RIGHT, BOTTOM). All values are
4726 in pixels relative to the origin - the position (0, 0) - of FRAME's
4727 display.
4729 If optional argument TYPE is the symbol `outer-edges', return the outer
4730 edges of FRAME. The outer edges comprise the decorations of the window
4731 manager (like the title bar or external borders) as well as any external
4732 menu or tool bar of FRAME. If optional argument TYPE is the symbol
4733 `native-edges' or nil, return the native edges of FRAME. The native
4734 edges exclude the decorations of the window manager and any external
4735 menu or tool bar of FRAME. If TYPE is the symbol `inner-edges', return
4736 the inner edges of FRAME. These edges exclude title bar, any borders,
4737 menu bar or tool bar of FRAME. */)
4738 (Lisp_Object frame, Lisp_Object type)
4740 return frame_geometry (frame, ((EQ (type, Qouter_edges)
4741 || EQ (type, Qinner_edges))
4742 ? type
4743 : Qnative_edges));
4746 DEFUN ("x-mouse-absolute-pixel-position", Fx_mouse_absolute_pixel_position,
4747 Sx_mouse_absolute_pixel_position, 0, 0, 0,
4748 doc: /* Return absolute position of mouse cursor in pixels.
4749 The position is returned as a cons cell (X . Y) of the coordinates of
4750 the mouse cursor position in pixels relative to a position (0, 0) of the
4751 selected frame's display. */)
4752 (void)
4754 struct frame *f = SELECTED_FRAME ();
4755 Window root, dummy_window;
4756 int x, y, dummy;
4758 if (FRAME_INITIAL_P (f) || !FRAME_X_P (f))
4759 return Qnil;
4761 block_input ();
4762 XQueryPointer (FRAME_X_DISPLAY (f),
4763 DefaultRootWindow (FRAME_X_DISPLAY (f)),
4764 &root, &dummy_window, &x, &y, &dummy, &dummy,
4765 (unsigned int *) &dummy);
4766 unblock_input ();
4768 return Fcons (make_number (x), make_number (y));
4771 DEFUN ("x-set-mouse-absolute-pixel-position", Fx_set_mouse_absolute_pixel_position,
4772 Sx_set_mouse_absolute_pixel_position, 2, 2, 0,
4773 doc: /* Move mouse pointer to absolute pixel position (X, Y).
4774 The coordinates X and Y are interpreted in pixels relative to a position
4775 \(0, 0) of the selected frame's display. */)
4776 (Lisp_Object x, Lisp_Object y)
4778 struct frame *f = SELECTED_FRAME ();
4780 if (FRAME_INITIAL_P (f) || !FRAME_X_P (f))
4781 return Qnil;
4783 CHECK_TYPE_RANGED_INTEGER (int, x);
4784 CHECK_TYPE_RANGED_INTEGER (int, y);
4786 block_input ();
4787 XWarpPointer (FRAME_X_DISPLAY (f), None, DefaultRootWindow (FRAME_X_DISPLAY (f)),
4788 0, 0, 0, 0, XINT (x), XINT (y));
4789 unblock_input ();
4791 return Qnil;
4794 /************************************************************************
4795 X Displays
4796 ************************************************************************/
4799 /* Mapping visual names to visuals. */
4801 static struct visual_class
4803 const char *name;
4804 int class;
4806 visual_classes[] =
4808 {"StaticGray", StaticGray},
4809 {"GrayScale", GrayScale},
4810 {"StaticColor", StaticColor},
4811 {"PseudoColor", PseudoColor},
4812 {"TrueColor", TrueColor},
4813 {"DirectColor", DirectColor},
4814 {NULL, 0}
4818 #ifndef HAVE_XSCREENNUMBEROFSCREEN
4820 /* Value is the screen number of screen SCR. This is a substitute for
4821 the X function with the same name when that doesn't exist. */
4824 XScreenNumberOfScreen (scr)
4825 register Screen *scr;
4827 Display *dpy = scr->display;
4828 int i;
4830 for (i = 0; i < dpy->nscreens; ++i)
4831 if (scr == dpy->screens + i)
4832 break;
4834 return i;
4837 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
4840 /* Select the visual that should be used on display DPYINFO. Set
4841 members of DPYINFO appropriately. Called from x_term_init. */
4843 void
4844 select_visual (struct x_display_info *dpyinfo)
4846 Display *dpy = dpyinfo->display;
4847 Screen *screen = dpyinfo->screen;
4849 /* See if a visual is specified. */
4850 AUTO_STRING (visualClass, "visualClass");
4851 AUTO_STRING (VisualClass, "VisualClass");
4852 Lisp_Object value = display_x_get_resource (dpyinfo, visualClass,
4853 VisualClass, Qnil, Qnil);
4855 if (STRINGP (value))
4857 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
4858 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
4859 depth, a decimal number. NAME is compared with case ignored. */
4860 char *s = alloca (SBYTES (value) + 1);
4861 char *dash;
4862 int i, class = -1;
4863 XVisualInfo vinfo;
4865 lispstpcpy (s, value);
4866 dash = strchr (s, '-');
4867 if (dash)
4869 dpyinfo->n_planes = atoi (dash + 1);
4870 *dash = '\0';
4872 else
4873 /* We won't find a matching visual with depth 0, so that
4874 an error will be printed below. */
4875 dpyinfo->n_planes = 0;
4877 /* Determine the visual class. */
4878 for (i = 0; visual_classes[i].name; ++i)
4879 if (xstrcasecmp (s, visual_classes[i].name) == 0)
4881 class = visual_classes[i].class;
4882 break;
4885 /* Look up a matching visual for the specified class. */
4886 if (class == -1
4887 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
4888 dpyinfo->n_planes, class, &vinfo))
4889 fatal ("Invalid visual specification '%s'",
4890 SSDATA (ENCODE_SYSTEM (value)));
4892 dpyinfo->visual = vinfo.visual;
4894 else
4896 int n_visuals;
4897 XVisualInfo *vinfo, vinfo_template;
4899 dpyinfo->visual = DefaultVisualOfScreen (screen);
4901 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
4902 vinfo_template.screen = XScreenNumberOfScreen (screen);
4903 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
4904 &vinfo_template, &n_visuals);
4905 if (n_visuals <= 0)
4906 fatal ("Can't get proper X visual info");
4908 dpyinfo->n_planes = vinfo->depth;
4909 XFree (vinfo);
4914 /* Return the X display structure for the display named NAME.
4915 Open a new connection if necessary. */
4917 static struct x_display_info *
4918 x_display_info_for_name (Lisp_Object name)
4920 struct x_display_info *dpyinfo;
4922 CHECK_STRING (name);
4924 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
4925 if (!NILP (Fstring_equal (XCAR (dpyinfo->name_list_element), name)))
4926 return dpyinfo;
4928 /* Use this general default value to start with. */
4929 Vx_resource_name = Vinvocation_name;
4931 validate_x_resource_name ();
4933 dpyinfo = x_term_init (name, 0, SSDATA (Vx_resource_name));
4935 if (dpyinfo == 0)
4936 error ("Cannot connect to X server %s", SDATA (name));
4938 XSETFASTINT (Vwindow_system_version, 11);
4940 return dpyinfo;
4944 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4945 1, 3, 0,
4946 doc: /* Open a connection to a display server.
4947 DISPLAY is the name of the display to connect to.
4948 Optional second arg XRM-STRING is a string of resources in xrdb format.
4949 If the optional third arg MUST-SUCCEED is non-nil,
4950 terminate Emacs if we can't open the connection.
4951 \(In the Nextstep version, the last two arguments are currently ignored.) */)
4952 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4954 char *xrm_option;
4955 struct x_display_info *dpyinfo;
4957 CHECK_STRING (display);
4958 if (! NILP (xrm_string))
4959 CHECK_STRING (xrm_string);
4961 xrm_option = NILP (xrm_string) ? 0 : SSDATA (xrm_string);
4963 validate_x_resource_name ();
4965 /* This is what opens the connection and sets x_current_display.
4966 This also initializes many symbols, such as those used for input. */
4967 dpyinfo = x_term_init (display, xrm_option,
4968 SSDATA (Vx_resource_name));
4970 if (dpyinfo == 0)
4972 if (!NILP (must_succeed))
4973 fatal ("Cannot connect to X server %s.\n\
4974 Check the DISPLAY environment variable or use `-d'.\n\
4975 Also use the `xauth' program to verify that you have the proper\n\
4976 authorization information needed to connect the X server.\n\
4977 An insecure way to solve the problem may be to use `xhost'.\n",
4978 SDATA (display));
4979 else
4980 error ("Cannot connect to X server %s", SDATA (display));
4983 XSETFASTINT (Vwindow_system_version, 11);
4984 return Qnil;
4987 DEFUN ("x-close-connection", Fx_close_connection,
4988 Sx_close_connection, 1, 1, 0,
4989 doc: /* Close the connection to TERMINAL's X server.
4990 For TERMINAL, specify a terminal object, a frame or a display name (a
4991 string). If TERMINAL is nil, that stands for the selected frame's
4992 terminal. */)
4993 (Lisp_Object terminal)
4995 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4997 if (dpyinfo->reference_count > 0)
4998 error ("Display still has frames on it");
5000 x_delete_terminal (dpyinfo->terminal);
5002 return Qnil;
5005 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
5006 doc: /* Return the list of display names that Emacs has connections to. */)
5007 (void)
5009 Lisp_Object result = Qnil;
5010 struct x_display_info *xdi;
5012 for (xdi = x_display_list; xdi; xdi = xdi->next)
5013 result = Fcons (XCAR (xdi->name_list_element), result);
5015 return result;
5018 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
5019 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
5020 This function only has an effect on X Windows. With MS Windows, it is
5021 defined but does nothing.
5023 If ON is nil, allow buffering of requests.
5024 Turning on synchronization prohibits the Xlib routines from buffering
5025 requests and seriously degrades performance, but makes debugging much
5026 easier.
5027 The optional second argument TERMINAL specifies which display to act on.
5028 TERMINAL should be a terminal object, a frame or a display name (a string).
5029 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
5030 (Lisp_Object on, Lisp_Object terminal)
5032 struct x_display_info *dpyinfo = check_x_display_info (terminal);
5034 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
5036 return Qnil;
5039 /* Wait for responses to all X commands issued so far for frame F. */
5041 void
5042 x_sync (struct frame *f)
5044 block_input ();
5045 XSync (FRAME_X_DISPLAY (f), False);
5046 unblock_input ();
5050 /***********************************************************************
5051 Window properties
5052 ***********************************************************************/
5054 DEFUN ("x-change-window-property", Fx_change_window_property,
5055 Sx_change_window_property, 2, 6, 0,
5056 doc: /* Change window property PROP to VALUE on the X window of FRAME.
5057 PROP must be a string. VALUE may be a string or a list of conses,
5058 numbers and/or strings. If an element in the list is a string, it is
5059 converted to an atom and the value of the atom is used. If an element
5060 is a cons, it is converted to a 32 bit number where the car is the 16
5061 top bits and the cdr is the lower 16 bits.
5063 FRAME nil or omitted means use the selected frame.
5064 If TYPE is given and non-nil, it is the name of the type of VALUE.
5065 If TYPE is not given or nil, the type is STRING.
5066 FORMAT gives the size in bits of each element if VALUE is a list.
5067 It must be one of 8, 16 or 32.
5068 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
5069 If OUTER-P is non-nil, the property is changed for the outer X window of
5070 FRAME. Default is to change on the edit X window. */)
5071 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
5072 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
5074 struct frame *f = decode_window_system_frame (frame);
5075 Atom prop_atom;
5076 Atom target_type = XA_STRING;
5077 int element_format = 8;
5078 unsigned char *data;
5079 int nelements;
5080 Window w;
5082 CHECK_STRING (prop);
5084 if (! NILP (format))
5086 CHECK_NUMBER (format);
5088 if (XINT (format) != 8 && XINT (format) != 16
5089 && XINT (format) != 32)
5090 error ("FORMAT must be one of 8, 16 or 32");
5091 element_format = XINT (format);
5094 if (CONSP (value))
5096 ptrdiff_t elsize;
5098 nelements = x_check_property_data (value);
5099 if (nelements == -1)
5100 error ("Bad data in VALUE, must be number, string or cons");
5102 /* The man page for XChangeProperty:
5103 "If the specified format is 32, the property data must be a
5104 long array."
5105 This applies even if long is more than 32 bits. The X library
5106 converts to 32 bits before sending to the X server. */
5107 elsize = element_format == 32 ? sizeof (long) : element_format >> 3;
5108 data = xnmalloc (nelements, elsize);
5110 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
5112 else
5114 CHECK_STRING (value);
5115 data = SDATA (value);
5116 if (INT_MAX < SBYTES (value))
5117 error ("VALUE too long");
5118 nelements = SBYTES (value);
5121 block_input ();
5122 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
5123 if (! NILP (type))
5125 CHECK_STRING (type);
5126 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
5129 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
5130 else w = FRAME_X_WINDOW (f);
5132 XChangeProperty (FRAME_X_DISPLAY (f), w,
5133 prop_atom, target_type, element_format, PropModeReplace,
5134 data, nelements);
5136 if (CONSP (value)) xfree (data);
5138 /* Make sure the property is set when we return. */
5139 XFlush (FRAME_X_DISPLAY (f));
5140 unblock_input ();
5142 return value;
5146 DEFUN ("x-delete-window-property", Fx_delete_window_property,
5147 Sx_delete_window_property, 1, 2, 0,
5148 doc: /* Remove window property PROP from X window of FRAME.
5149 FRAME nil or omitted means use the selected frame. Value is PROP. */)
5150 (Lisp_Object prop, Lisp_Object frame)
5152 struct frame *f = decode_window_system_frame (frame);
5153 Atom prop_atom;
5155 CHECK_STRING (prop);
5156 block_input ();
5157 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
5158 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
5160 /* Make sure the property is removed when we return. */
5161 XFlush (FRAME_X_DISPLAY (f));
5162 unblock_input ();
5164 return prop;
5168 static Lisp_Object
5169 x_window_property_intern (struct frame *f,
5170 Window target_window,
5171 Atom prop_atom,
5172 Atom target_type,
5173 Lisp_Object delete_p,
5174 Lisp_Object vector_ret_p,
5175 bool *found)
5177 unsigned char *tmp_data = NULL;
5178 Lisp_Object prop_value = Qnil;
5179 Atom actual_type;
5180 int actual_format;
5181 unsigned long actual_size, bytes_remaining;
5182 int rc;
5184 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
5185 prop_atom, 0, 0, False, target_type,
5186 &actual_type, &actual_format, &actual_size,
5187 &bytes_remaining, &tmp_data);
5189 *found = actual_format != 0;
5191 if (rc == Success && *found)
5193 XFree (tmp_data);
5194 tmp_data = NULL;
5196 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
5197 prop_atom, 0, bytes_remaining,
5198 ! NILP (delete_p), target_type,
5199 &actual_type, &actual_format,
5200 &actual_size, &bytes_remaining,
5201 &tmp_data);
5202 if (rc == Success && tmp_data)
5204 /* The man page for XGetWindowProperty says:
5205 "If the returned format is 32, the returned data is represented
5206 as a long array and should be cast to that type to obtain the
5207 elements."
5208 This applies even if long is more than 32 bits, the X library
5209 converts from 32 bit elements received from the X server to long
5210 and passes the long array to us. Thus, for that case memcpy can not
5211 be used. We convert to a 32 bit type here, because so much code
5212 assume on that.
5214 The bytes and offsets passed to XGetWindowProperty refers to the
5215 property and those are indeed in 32 bit quantities if format is
5216 32. */
5218 if (BITS_PER_LONG > 32 && actual_format == 32)
5220 unsigned long i;
5221 int *idata = (int *) tmp_data;
5222 long *ldata = (long *) tmp_data;
5224 for (i = 0; i < actual_size; ++i)
5225 idata[i] = (int) ldata[i];
5228 if (NILP (vector_ret_p))
5229 prop_value = make_string ((char *) tmp_data, actual_size);
5230 else
5231 prop_value = x_property_data_to_lisp (f,
5232 tmp_data,
5233 actual_type,
5234 actual_format,
5235 actual_size);
5238 if (tmp_data) XFree (tmp_data);
5241 return prop_value;
5244 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
5245 1, 6, 0,
5246 doc: /* Value is the value of window property PROP on FRAME.
5247 If FRAME is nil or omitted, use the selected frame.
5249 On X Windows, the following optional arguments are also accepted:
5250 If TYPE is nil or omitted, get the property as a string.
5251 Otherwise TYPE is the name of the atom that denotes the type expected.
5252 If SOURCE is non-nil, get the property on that window instead of from
5253 FRAME. The number 0 denotes the root window.
5254 If DELETE-P is non-nil, delete the property after retrieving it.
5255 If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
5257 On MS Windows, this function accepts but ignores those optional arguments.
5259 Value is nil if FRAME hasn't a property with name PROP or if PROP has
5260 no value of TYPE (always string in the MS Windows case). */)
5261 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
5262 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
5264 struct frame *f = decode_window_system_frame (frame);
5265 Atom prop_atom;
5266 Lisp_Object prop_value = Qnil;
5267 Atom target_type = XA_STRING;
5268 Window target_window = FRAME_X_WINDOW (f);
5269 bool found;
5271 CHECK_STRING (prop);
5273 if (! NILP (source))
5275 CONS_TO_INTEGER (source, Window, target_window);
5276 if (! target_window)
5277 target_window = FRAME_DISPLAY_INFO (f)->root_window;
5280 block_input ();
5281 if (STRINGP (type))
5283 if (strcmp ("AnyPropertyType", SSDATA (type)) == 0)
5284 target_type = AnyPropertyType;
5285 else
5286 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
5289 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
5290 prop_value = x_window_property_intern (f,
5291 target_window,
5292 prop_atom,
5293 target_type,
5294 delete_p,
5295 vector_ret_p,
5296 &found);
5297 if (NILP (prop_value)
5298 && ! found
5299 && NILP (source)
5300 && target_window != FRAME_OUTER_WINDOW (f))
5302 prop_value = x_window_property_intern (f,
5303 FRAME_OUTER_WINDOW (f),
5304 prop_atom,
5305 target_type,
5306 delete_p,
5307 vector_ret_p,
5308 &found);
5312 unblock_input ();
5313 return prop_value;
5316 /***********************************************************************
5317 Tool tips
5318 ***********************************************************************/
5320 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
5321 Lisp_Object, int, int, int *, int *);
5323 /* The frame of a currently visible tooltip. */
5325 Lisp_Object tip_frame;
5327 /* If non-nil, a timer started that hides the last tooltip when it
5328 fires. */
5330 static Lisp_Object tip_timer;
5331 Window tip_window;
5333 /* If non-nil, a vector of 3 elements containing the last args
5334 with which x-show-tip was called. See there. */
5336 static Lisp_Object last_show_tip_args;
5339 static void
5340 unwind_create_tip_frame (Lisp_Object frame)
5342 Lisp_Object deleted;
5344 deleted = unwind_create_frame (frame);
5345 if (EQ (deleted, Qt))
5347 tip_window = None;
5348 tip_frame = Qnil;
5353 /* Create a frame for a tooltip on the display described by DPYINFO.
5354 PARMS is a list of frame parameters. TEXT is the string to
5355 display in the tip frame. Value is the frame.
5357 Note that functions called here, esp. x_default_parameter can
5358 signal errors, for instance when a specified color name is
5359 undefined. We have to make sure that we're in a consistent state
5360 when this happens. */
5362 static Lisp_Object
5363 x_create_tip_frame (struct x_display_info *dpyinfo, Lisp_Object parms)
5365 struct frame *f;
5366 Lisp_Object frame;
5367 Lisp_Object name;
5368 int width, height;
5369 ptrdiff_t count = SPECPDL_INDEX ();
5370 bool face_change_before = face_change;
5371 int x_width = 0, x_height = 0;
5373 if (!dpyinfo->terminal->name)
5374 error ("Terminal is not live, can't create new frames on it");
5376 parms = Fcopy_alist (parms);
5378 /* Get the name of the frame to use for resource lookup. */
5379 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
5380 if (!STRINGP (name)
5381 && !EQ (name, Qunbound)
5382 && !NILP (name))
5383 error ("Invalid frame name--not a string or nil");
5385 frame = Qnil;
5386 f = make_frame (false);
5387 f->wants_modeline = false;
5388 XSETFRAME (frame, f);
5389 record_unwind_protect (unwind_create_tip_frame, frame);
5391 f->terminal = dpyinfo->terminal;
5393 /* By setting the output method, we're essentially saying that
5394 the frame is live, as per FRAME_LIVE_P. If we get a signal
5395 from this point on, x_destroy_window might screw up reference
5396 counts etc. */
5397 f->output_method = output_x_window;
5398 f->output_data.x = xzalloc (sizeof *f->output_data.x);
5399 f->output_data.x->icon_bitmap = -1;
5400 FRAME_FONTSET (f) = -1;
5401 f->output_data.x->scroll_bar_foreground_pixel = -1;
5402 f->output_data.x->scroll_bar_background_pixel = -1;
5403 #if defined (USE_LUCID) && defined (USE_TOOLKIT_SCROLL_BARS)
5404 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
5405 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
5406 #endif /* USE_LUCID && USE_TOOLKIT_SCROLL_BARS */
5407 f->output_data.x->white_relief.pixel = -1;
5408 f->output_data.x->black_relief.pixel = -1;
5410 fset_icon_name (f, Qnil);
5411 FRAME_DISPLAY_INFO (f) = dpyinfo;
5412 f->output_data.x->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
5413 f->output_data.x->explicit_parent = false;
5415 /* These colors will be set anyway later, but it's important
5416 to get the color reference counts right, so initialize them! */
5418 Lisp_Object black;
5420 /* Function x_decode_color can signal an error. Make
5421 sure to initialize color slots so that we won't try
5422 to free colors we haven't allocated. */
5423 FRAME_FOREGROUND_PIXEL (f) = -1;
5424 FRAME_BACKGROUND_PIXEL (f) = -1;
5425 f->output_data.x->cursor_pixel = -1;
5426 f->output_data.x->cursor_foreground_pixel = -1;
5427 f->output_data.x->border_pixel = -1;
5428 f->output_data.x->mouse_pixel = -1;
5430 black = build_string ("black");
5431 FRAME_FOREGROUND_PIXEL (f)
5432 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5433 FRAME_BACKGROUND_PIXEL (f)
5434 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5435 f->output_data.x->cursor_pixel
5436 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5437 f->output_data.x->cursor_foreground_pixel
5438 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5439 f->output_data.x->border_pixel
5440 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5441 f->output_data.x->mouse_pixel
5442 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5445 /* Set the name; the functions to which we pass f expect the name to
5446 be set. */
5447 if (EQ (name, Qunbound) || NILP (name))
5449 fset_name (f, build_string (dpyinfo->x_id_name));
5450 f->explicit_name = false;
5452 else
5454 fset_name (f, name);
5455 f->explicit_name = true;
5456 /* use the frame's title when getting resources for this frame. */
5457 specbind (Qx_resource_name, name);
5460 #ifdef USE_CAIRO
5461 register_font_driver (&ftcrfont_driver, f);
5462 #else
5463 register_font_driver (&xfont_driver, f);
5464 #ifdef HAVE_FREETYPE
5465 #ifdef HAVE_XFT
5466 register_font_driver (&xftfont_driver, f);
5467 #else /* not HAVE_XFT */
5468 register_font_driver (&ftxfont_driver, f);
5469 #endif /* not HAVE_XFT */
5470 #endif /* HAVE_FREETYPE */
5471 #endif /* not USE_CAIRO */
5473 image_cache_refcount =
5474 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
5475 #ifdef GLYPH_DEBUG
5476 dpyinfo_refcount = dpyinfo->reference_count;
5477 #endif /* GLYPH_DEBUG */
5479 x_default_parameter (f, parms, Qfont_backend, Qnil,
5480 "fontBackend", "FontBackend", RES_TYPE_STRING);
5482 /* Extract the window parameters from the supplied values that are
5483 needed to determine window geometry. */
5484 x_default_font_parameter (f, parms);
5486 x_default_parameter (f, parms, Qborder_width, make_number (0),
5487 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
5489 /* This defaults to 2 in order to match xterm. We recognize either
5490 internalBorderWidth or internalBorder (which is what xterm calls
5491 it). */
5492 if (NILP (Fassq (Qinternal_border_width, parms)))
5494 Lisp_Object value;
5496 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
5497 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
5498 if (! EQ (value, Qunbound))
5499 parms = Fcons (Fcons (Qinternal_border_width, value),
5500 parms);
5503 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
5504 "internalBorderWidth", "internalBorderWidth",
5505 RES_TYPE_NUMBER);
5506 x_default_parameter (f, parms, Qright_divider_width, make_number (0),
5507 NULL, NULL, RES_TYPE_NUMBER);
5508 x_default_parameter (f, parms, Qbottom_divider_width, make_number (0),
5509 NULL, NULL, RES_TYPE_NUMBER);
5511 /* Also do the stuff which must be set before the window exists. */
5512 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
5513 "foreground", "Foreground", RES_TYPE_STRING);
5514 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
5515 "background", "Background", RES_TYPE_STRING);
5516 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
5517 "pointerColor", "Foreground", RES_TYPE_STRING);
5518 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
5519 "cursorColor", "Foreground", RES_TYPE_STRING);
5520 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
5521 "borderColor", "BorderColor", RES_TYPE_STRING);
5523 /* Init faces before x_default_parameter is called for the
5524 scroll-bar-width parameter because otherwise we end up in
5525 init_iterator with a null face cache, which should not happen. */
5526 init_frame_faces (f);
5528 f->output_data.x->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
5530 x_figure_window_size (f, parms, false, &x_width, &x_height);
5533 XSetWindowAttributes attrs;
5534 unsigned long mask;
5535 Atom type = FRAME_DISPLAY_INFO (f)->Xatom_net_window_type_tooltip;
5537 block_input ();
5538 mask = CWBackPixel | CWOverrideRedirect | CWEventMask | CWCursor;
5539 if (DoesSaveUnders (dpyinfo->screen))
5540 mask |= CWSaveUnder;
5542 /* Window managers look at the override-redirect flag to determine
5543 whether or net to give windows a decoration (Xlib spec, chapter
5544 3.2.8). */
5545 attrs.override_redirect = True;
5546 attrs.save_under = True;
5547 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
5548 attrs.cursor =
5549 f->output_data.x->current_cursor
5550 = f->output_data.x->text_cursor;
5551 /* Arrange for getting MapNotify and UnmapNotify events. */
5552 attrs.event_mask = StructureNotifyMask;
5553 tip_window
5554 = FRAME_X_WINDOW (f)
5555 = XCreateWindow (FRAME_X_DISPLAY (f),
5556 FRAME_DISPLAY_INFO (f)->root_window,
5557 /* x, y, width, height */
5558 0, 0, 1, 1,
5559 /* Border. */
5560 f->border_width,
5561 CopyFromParent, InputOutput, CopyFromParent,
5562 mask, &attrs);
5563 XChangeProperty (FRAME_X_DISPLAY (f), tip_window,
5564 FRAME_DISPLAY_INFO (f)->Xatom_net_window_type,
5565 XA_ATOM, 32, PropModeReplace,
5566 (unsigned char *)&type, 1);
5567 unblock_input ();
5570 x_make_gc (f);
5572 x_default_parameter (f, parms, Qauto_raise, Qnil,
5573 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5574 x_default_parameter (f, parms, Qauto_lower, Qnil,
5575 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5576 x_default_parameter (f, parms, Qcursor_type, Qbox,
5577 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5578 x_default_parameter (f, parms, Qalpha, Qnil,
5579 "alpha", "Alpha", RES_TYPE_NUMBER);
5581 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
5582 Change will not be effected unless different from the current
5583 FRAME_LINES (f). */
5584 width = FRAME_COLS (f);
5585 height = FRAME_LINES (f);
5586 SET_FRAME_COLS (f, 0);
5587 SET_FRAME_LINES (f, 0);
5588 change_frame_size (f, width, height, true, false, false, false);
5590 /* Add `tooltip' frame parameter's default value. */
5591 if (NILP (Fframe_parameter (frame, Qtooltip)))
5593 AUTO_FRAME_ARG (arg, Qtooltip, Qt);
5594 Fmodify_frame_parameters (frame, arg);
5597 /* FIXME - can this be done in a similar way to normal frames?
5598 http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00641.html */
5600 /* Set the `display-type' frame parameter before setting up faces. */
5602 Lisp_Object disptype;
5604 if (FRAME_DISPLAY_INFO (f)->n_planes == 1)
5605 disptype = Qmono;
5606 else if (FRAME_DISPLAY_INFO (f)->visual->class == GrayScale
5607 || FRAME_DISPLAY_INFO (f)->visual->class == StaticGray)
5608 disptype = intern ("grayscale");
5609 else
5610 disptype = intern ("color");
5612 if (NILP (Fframe_parameter (frame, Qdisplay_type)))
5614 AUTO_FRAME_ARG (arg, Qdisplay_type, disptype);
5615 Fmodify_frame_parameters (frame, arg);
5619 /* Set up faces after all frame parameters are known. This call
5620 also merges in face attributes specified for new frames.
5622 Frame parameters may be changed if .Xdefaults contains
5623 specifications for the default font. For example, if there is an
5624 `Emacs.default.attributeBackground: pink', the `background-color'
5625 attribute of the frame get's set, which let's the internal border
5626 of the tooltip frame appear in pink. Prevent this. */
5628 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
5630 call2 (Qface_set_after_frame_default, frame, Qnil);
5632 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
5634 AUTO_FRAME_ARG (arg, Qbackground_color, bg);
5635 Fmodify_frame_parameters (frame, arg);
5639 f->no_split = true;
5641 /* Now that the frame will be official, it counts as a reference to
5642 its display and terminal. */
5643 FRAME_DISPLAY_INFO (f)->reference_count++;
5644 f->terminal->reference_count++;
5646 /* It is now ok to make the frame official even if we get an error
5647 below. And the frame needs to be on Vframe_list or making it
5648 visible won't work. */
5649 Vframe_list = Fcons (frame, Vframe_list);
5650 f->can_x_set_window_size = true;
5652 /* Setting attributes of faces of the tooltip frame from resources
5653 and similar will set face_change, which leads to the clearing of
5654 all current matrices. Since this isn't necessary here, avoid it
5655 by resetting face_change to the value it had before we created
5656 the tip frame. */
5657 face_change = face_change_before;
5659 /* Discard the unwind_protect. */
5660 return unbind_to (count, frame);
5664 /* Compute where to display tip frame F. PARMS is the list of frame
5665 parameters for F. DX and DY are specified offsets from the current
5666 location of the mouse. WIDTH and HEIGHT are the width and height
5667 of the tooltip. Return coordinates relative to the root window of
5668 the display in *ROOT_X, and *ROOT_Y. */
5670 static void
5671 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)
5673 Lisp_Object left, top, right, bottom;
5674 int win_x, win_y;
5675 Window root, child;
5676 unsigned pmask;
5677 int min_x, min_y, max_x, max_y = -1;
5679 /* User-specified position? */
5680 left = Fcdr (Fassq (Qleft, parms));
5681 top = Fcdr (Fassq (Qtop, parms));
5682 right = Fcdr (Fassq (Qright, parms));
5683 bottom = Fcdr (Fassq (Qbottom, parms));
5685 /* Move the tooltip window where the mouse pointer is. Resize and
5686 show it. */
5687 if ((!INTEGERP (left) && !INTEGERP (right))
5688 || (!INTEGERP (top) && !INTEGERP (bottom)))
5690 Lisp_Object frame, attributes, monitor, geometry;
5692 block_input ();
5693 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_DISPLAY_INFO (f)->root_window,
5694 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
5695 unblock_input ();
5697 XSETFRAME(frame, f);
5698 attributes = Fx_display_monitor_attributes_list (frame);
5700 /* Try to determine the monitor where the mouse pointer is and
5701 its geometry. See bug#22549. */
5702 while (CONSP (attributes))
5704 monitor = XCAR (attributes);
5705 geometry = Fassq (Qgeometry, monitor);
5706 if (CONSP (geometry))
5708 min_x = XINT (Fnth (make_number (1), geometry));
5709 min_y = XINT (Fnth (make_number (2), geometry));
5710 max_x = min_x + XINT (Fnth (make_number (3), geometry));
5711 max_y = min_y + XINT (Fnth (make_number (4), geometry));
5712 if (min_x <= *root_x && *root_x < max_x
5713 && min_y <= *root_y && *root_y < max_y)
5715 break;
5717 max_y = -1;
5720 attributes = XCDR (attributes);
5724 /* It was not possible to determine the monitor's geometry, so we
5725 assign some sane defaults here: */
5726 if ( max_y < 0 )
5728 min_x = 0;
5729 min_y = 0;
5730 max_x = x_display_pixel_width (FRAME_DISPLAY_INFO (f));
5731 max_y = x_display_pixel_height (FRAME_DISPLAY_INFO (f));
5734 if (INTEGERP (top))
5735 *root_y = XINT (top);
5736 else if (INTEGERP (bottom))
5737 *root_y = XINT (bottom) - height;
5738 else if (*root_y + XINT (dy) <= min_y)
5739 *root_y = min_y; /* Can happen for negative dy */
5740 else if (*root_y + XINT (dy) + height <= max_y)
5741 /* It fits below the pointer */
5742 *root_y += XINT (dy);
5743 else if (height + XINT (dy) + min_y <= *root_y)
5744 /* It fits above the pointer. */
5745 *root_y -= height + XINT (dy);
5746 else
5747 /* Put it on the top. */
5748 *root_y = min_y;
5750 if (INTEGERP (left))
5751 *root_x = XINT (left);
5752 else if (INTEGERP (right))
5753 *root_x = XINT (right) - width;
5754 else if (*root_x + XINT (dx) <= min_x)
5755 *root_x = 0; /* Can happen for negative dx */
5756 else if (*root_x + XINT (dx) + width <= max_x)
5757 /* It fits to the right of the pointer. */
5758 *root_x += XINT (dx);
5759 else if (width + XINT (dx) + min_x <= *root_x)
5760 /* It fits to the left of the pointer. */
5761 *root_x -= width + XINT (dx);
5762 else
5763 /* Put it left justified on the screen -- it ought to fit that way. */
5764 *root_x = min_x;
5768 /* Hide tooltip. Delete its frame if DELETE is true. */
5769 static Lisp_Object
5770 x_hide_tip (bool delete)
5772 if (!NILP (tip_timer))
5774 call1 (Qcancel_timer, tip_timer);
5775 tip_timer = Qnil;
5779 if (NILP (tip_frame)
5780 || (!delete && FRAMEP (tip_frame)
5781 && !FRAME_VISIBLE_P (XFRAME (tip_frame))))
5782 return Qnil;
5783 else
5785 ptrdiff_t count;
5786 Lisp_Object was_open = Qnil;
5788 count = SPECPDL_INDEX ();
5789 specbind (Qinhibit_redisplay, Qt);
5790 specbind (Qinhibit_quit, Qt);
5792 #ifdef USE_GTK
5794 /* When using system tooltip, tip_frame is the Emacs frame on
5795 which the tip is shown. */
5796 struct frame *f = XFRAME (tip_frame);
5798 if (FRAME_LIVE_P (f) && xg_hide_tooltip (f))
5800 tip_frame = Qnil;
5801 was_open = Qt;
5804 #endif
5806 if (FRAMEP (tip_frame))
5808 if (delete)
5810 delete_frame (tip_frame, Qnil);
5811 tip_frame = Qnil;
5813 else
5814 x_make_frame_invisible (XFRAME (tip_frame));
5816 was_open = Qt;
5818 #ifdef USE_LUCID
5819 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5820 redisplay procedure is not called when a tip frame over
5821 menu items is unmapped. Redisplay the menu manually... */
5823 Widget w;
5824 struct frame *f = SELECTED_FRAME ();
5825 if (FRAME_X_P (f) && FRAME_LIVE_P (f))
5827 w = f->output_data.x->menubar_widget;
5829 if (!DoesSaveUnders (FRAME_DISPLAY_INFO (f)->screen)
5830 && w != NULL)
5832 block_input ();
5833 xlwmenu_redisplay (w);
5834 unblock_input ();
5838 #endif /* USE_LUCID */
5840 else
5841 tip_frame = Qnil;
5843 return unbind_to (count, was_open);
5847 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5848 doc: /* Show STRING in a "tooltip" window on frame FRAME.
5849 A tooltip window is a small X window displaying a string.
5851 This is an internal function; Lisp code should call `tooltip-show'.
5853 FRAME nil or omitted means use the selected frame.
5855 PARMS is an optional list of frame parameters which can be used to
5856 change the tooltip's appearance.
5858 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5859 means use the default timeout of 5 seconds.
5861 If the list of frame parameters PARMS contains a `left' parameter,
5862 display the tooltip at that x-position. If the list of frame parameters
5863 PARMS contains no `left' but a `right' parameter, display the tooltip
5864 right-adjusted at that x-position. Otherwise display it at the
5865 x-position of the mouse, with offset DX added (default is 5 if DX isn't
5866 specified).
5868 Likewise for the y-position: If a `top' frame parameter is specified, it
5869 determines the position of the upper edge of the tooltip window. If a
5870 `bottom' parameter but no `top' frame parameter is specified, it
5871 determines the position of the lower edge of the tooltip window.
5872 Otherwise display the tooltip window at the y-position of the mouse,
5873 with offset DY added (default is -10).
5875 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5876 Text larger than the specified size is clipped. */)
5877 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
5879 struct frame *f, *tip_f;
5880 struct window *w;
5881 int root_x, root_y;
5882 struct buffer *old_buffer;
5883 struct text_pos pos;
5884 int width, height;
5885 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5886 ptrdiff_t count = SPECPDL_INDEX ();
5887 ptrdiff_t count_1;
5888 Lisp_Object window, size;
5889 AUTO_STRING (tip, " *tip*");
5891 specbind (Qinhibit_redisplay, Qt);
5893 CHECK_STRING (string);
5894 if (SCHARS (string) == 0)
5895 string = make_unibyte_string (" ", 1);
5897 f = decode_window_system_frame (frame);
5898 if (NILP (timeout))
5899 timeout = make_number (5);
5900 else
5901 CHECK_NATNUM (timeout);
5903 if (NILP (dx))
5904 dx = make_number (5);
5905 else
5906 CHECK_NUMBER (dx);
5908 if (NILP (dy))
5909 dy = make_number (-10);
5910 else
5911 CHECK_NUMBER (dy);
5913 #ifdef USE_GTK
5914 if (x_gtk_use_system_tooltips)
5916 bool ok;
5918 /* Hide a previous tip, if any. */
5919 Fx_hide_tip ();
5921 block_input ();
5922 ok = xg_prepare_tooltip (f, string, &width, &height);
5923 if (ok)
5925 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5926 xg_show_tooltip (f, root_x, root_y);
5927 /* This is used in Fx_hide_tip. */
5928 XSETFRAME (tip_frame, f);
5930 unblock_input ();
5931 if (ok) goto start_timer;
5933 #endif /* USE_GTK */
5935 if (NILP (last_show_tip_args))
5936 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5938 if (FRAMEP (tip_frame) && FRAME_LIVE_P (XFRAME (tip_frame)))
5940 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5941 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5942 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5944 if (FRAME_VISIBLE_P (XFRAME (tip_frame))
5945 && EQ (frame, last_frame)
5946 && !NILP (Fequal_including_properties (last_string, string))
5947 && !NILP (Fequal (last_parms, parms)))
5949 /* Only DX and DY have changed. */
5950 tip_f = XFRAME (tip_frame);
5951 if (!NILP (tip_timer))
5953 Lisp_Object timer = tip_timer;
5955 tip_timer = Qnil;
5956 call1 (Qcancel_timer, timer);
5959 block_input ();
5960 compute_tip_xy (tip_f, parms, dx, dy, FRAME_PIXEL_WIDTH (tip_f),
5961 FRAME_PIXEL_HEIGHT (tip_f), &root_x, &root_y);
5962 XMoveWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
5963 root_x, root_y);
5964 unblock_input ();
5966 goto start_timer;
5968 else if (tooltip_reuse_hidden_frame && EQ (frame, last_frame))
5970 bool delete = false;
5971 Lisp_Object tail, elt, parm, last;
5973 /* Check if every parameter in PARMS has the same value in
5974 last_parms unless it should be ignored by means of
5975 Vtooltip_reuse_hidden_frame_parameters. This may destruct
5976 last_parms which, however, will be recreated below. */
5977 for (tail = parms; CONSP (tail); tail = XCDR (tail))
5979 elt = XCAR (tail);
5980 parm = Fcar (elt);
5981 /* The left, top, right and bottom parameters are handled
5982 by compute_tip_xy so they can be ignored here. */
5983 if (!EQ (parm, Qleft) && !EQ (parm, Qtop)
5984 && !EQ (parm, Qright) && !EQ (parm, Qbottom))
5986 last = Fassq (parm, last_parms);
5987 if (NILP (Fequal (Fcdr (elt), Fcdr (last))))
5989 /* We lost, delete the old tooltip. */
5990 delete = true;
5991 break;
5993 else
5994 last_parms = call2 (Qassq_delete_all, parm, last_parms);
5996 else
5997 last_parms = call2 (Qassq_delete_all, parm, last_parms);
6000 /* Now check if every parameter in what is left of last_parms
6001 with a non-nil value has an association in PARMS unless it
6002 should be ignored by means of
6003 Vtooltip_reuse_hidden_frame_parameters. */
6004 for (tail = last_parms; CONSP (tail); tail = XCDR (tail))
6006 elt = XCAR (tail);
6007 parm = Fcar (elt);
6008 if (!EQ (parm, Qleft) && !EQ (parm, Qtop) && !EQ (parm, Qright)
6009 && !EQ (parm, Qbottom) && !NILP (Fcdr (elt)))
6011 /* We lost, delete the old tooltip. */
6012 delete = true;
6013 break;
6017 x_hide_tip (delete);
6019 else
6020 x_hide_tip (true);
6022 else
6023 x_hide_tip (true);
6025 ASET (last_show_tip_args, 0, string);
6026 ASET (last_show_tip_args, 1, frame);
6027 ASET (last_show_tip_args, 2, parms);
6029 if (!FRAMEP (tip_frame) || !FRAME_LIVE_P (XFRAME (tip_frame)))
6031 /* Add default values to frame parameters. */
6032 if (NILP (Fassq (Qname, parms)))
6033 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
6034 if (NILP (Fassq (Qinternal_border_width, parms)))
6035 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
6036 if (NILP (Fassq (Qborder_width, parms)))
6037 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
6038 if (NILP (Fassq (Qborder_color, parms)))
6039 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
6040 if (NILP (Fassq (Qbackground_color, parms)))
6041 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
6042 parms);
6044 /* Create a frame for the tooltip, and record it in the global
6045 variable tip_frame. */
6046 if (NILP (tip_frame = x_create_tip_frame (FRAME_DISPLAY_INFO (f), parms)))
6047 /* Creating the tip frame failed. */
6048 return unbind_to (count, Qnil);
6051 tip_f = XFRAME (tip_frame);
6052 window = FRAME_ROOT_WINDOW (tip_f);
6053 set_window_buffer (window, Fget_buffer_create (tip), false, false);
6054 w = XWINDOW (window);
6055 w->pseudo_window_p = true;
6057 /* Set up the frame's root window. Note: The following code does not
6058 try to size the window or its frame correctly. Its only purpose is
6059 to make the subsequent text size calculations work. The right
6060 sizes should get installed when the toolkit gets back to us. */
6061 w->left_col = 0;
6062 w->top_line = 0;
6063 w->pixel_left = 0;
6064 w->pixel_top = 0;
6066 if (CONSP (Vx_max_tooltip_size)
6067 && RANGED_INTEGERP (1, XCAR (Vx_max_tooltip_size), INT_MAX)
6068 && RANGED_INTEGERP (1, XCDR (Vx_max_tooltip_size), INT_MAX))
6070 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
6071 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
6073 else
6075 w->total_cols = 80;
6076 w->total_lines = 40;
6079 w->pixel_width = w->total_cols * FRAME_COLUMN_WIDTH (tip_f);
6080 w->pixel_height = w->total_lines * FRAME_LINE_HEIGHT (tip_f);
6081 FRAME_TOTAL_COLS (tip_f) = w->total_cols;
6082 adjust_frame_glyphs (tip_f);
6084 /* Insert STRING into root window's buffer and fit the frame to the
6085 buffer. */
6086 count_1 = SPECPDL_INDEX ();
6087 old_buffer = current_buffer;
6088 set_buffer_internal_1 (XBUFFER (w->contents));
6089 bset_truncate_lines (current_buffer, Qnil);
6090 specbind (Qinhibit_read_only, Qt);
6091 specbind (Qinhibit_modification_hooks, Qt);
6092 specbind (Qinhibit_point_motion_hooks, Qt);
6093 Ferase_buffer ();
6094 Finsert (1, &string);
6095 clear_glyph_matrix (w->desired_matrix);
6096 clear_glyph_matrix (w->current_matrix);
6097 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
6098 try_window (window, pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6099 /* Calculate size of tooltip window. */
6100 size = Fwindow_text_pixel_size (window, Qnil, Qnil, Qnil,
6101 make_number (w->pixel_height), Qnil);
6102 /* Add the frame's internal border to calculated size. */
6103 width = XINT (Fcar (size)) + 2 * FRAME_INTERNAL_BORDER_WIDTH (tip_f);
6104 height = XINT (Fcdr (size)) + 2 * FRAME_INTERNAL_BORDER_WIDTH (tip_f);
6106 /* Calculate position of tooltip frame. */
6107 compute_tip_xy (tip_f, parms, dx, dy, width, height, &root_x, &root_y);
6109 /* Show tooltip frame. */
6110 block_input ();
6111 XMoveResizeWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
6112 root_x, root_y, width, height);
6113 XMapRaised (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f));
6114 unblock_input ();
6116 w->must_be_updated_p = true;
6117 update_single_window (w);
6118 set_buffer_internal_1 (old_buffer);
6119 unbind_to (count_1, Qnil);
6120 windows_or_buffers_changed = old_windows_or_buffers_changed;
6122 start_timer:
6123 /* Let the tip disappear after timeout seconds. */
6124 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
6125 intern ("x-hide-tip"));
6127 return unbind_to (count, Qnil);
6131 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
6132 doc: /* Hide the current tooltip window, if there is any.
6133 Value is t if tooltip was open, nil otherwise. */)
6134 (void)
6136 return x_hide_tip (!tooltip_reuse_hidden_frame);
6140 /***********************************************************************
6141 File selection dialog
6142 ***********************************************************************/
6144 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
6145 Sx_uses_old_gtk_dialog,
6146 0, 0, 0,
6147 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
6148 (void)
6150 #ifdef USE_GTK
6151 if (use_dialog_box
6152 && use_file_dialog
6153 && window_system_available (SELECTED_FRAME ())
6154 && xg_uses_old_file_dialog ())
6155 return Qt;
6156 #endif
6157 return Qnil;
6161 #ifdef USE_MOTIF
6162 /* Callback for "OK" and "Cancel" on file selection dialog. */
6164 static void
6165 file_dialog_cb (Widget widget, XtPointer client_data, XtPointer call_data)
6167 int *result = client_data;
6168 XmAnyCallbackStruct *cb = call_data;
6169 *result = cb->reason;
6173 /* Callback for unmapping a file selection dialog. This is used to
6174 capture the case where a dialog is closed via a window manager's
6175 closer button, for example. Using a XmNdestroyCallback didn't work
6176 in this case. */
6178 static void
6179 file_dialog_unmap_cb (Widget widget, XtPointer client_data, XtPointer call_data)
6181 int *result = client_data;
6182 *result = XmCR_CANCEL;
6185 static void
6186 clean_up_file_dialog (void *arg)
6188 Widget dialog = arg;
6190 /* Clean up. */
6191 block_input ();
6192 XtUnmanageChild (dialog);
6193 XtDestroyWidget (dialog);
6194 x_menu_set_in_use (false);
6195 unblock_input ();
6199 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
6200 doc: /* Read file name, prompting with PROMPT in directory DIR.
6201 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6202 selection box, if specified. If MUSTMATCH is non-nil, the returned file
6203 or directory must exist.
6205 This function is only defined on NS, MS Windows, and X Windows with the
6206 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6207 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories.
6208 On Windows 7 and later, the file selection dialog "remembers" the last
6209 directory where the user selected a file, and will open that directory
6210 instead of DIR on subsequent invocations of this function with the same
6211 value of DIR as in previous invocations; this is standard Windows behavior. */)
6212 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename,
6213 Lisp_Object mustmatch, Lisp_Object only_dir_p)
6215 int result;
6216 struct frame *f = SELECTED_FRAME ();
6217 Lisp_Object file = Qnil;
6218 Lisp_Object decoded_file;
6219 Widget dialog, text, help;
6220 Arg al[10];
6221 int ac = 0;
6222 XmString dir_xmstring, pattern_xmstring;
6223 ptrdiff_t count = SPECPDL_INDEX ();
6225 check_window_system (f);
6227 if (popup_activated ())
6228 error ("Trying to use a menu from within a menu-entry");
6230 CHECK_STRING (prompt);
6231 CHECK_STRING (dir);
6233 /* Prevent redisplay. */
6234 specbind (Qinhibit_redisplay, Qt);
6236 block_input ();
6238 /* Create the dialog with PROMPT as title, using DIR as initial
6239 directory and using "*" as pattern. */
6240 dir = Fexpand_file_name (dir, Qnil);
6241 dir_xmstring = XmStringCreateLocalized (SSDATA (dir));
6242 pattern_xmstring = XmStringCreateLocalized ("*");
6244 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
6245 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
6246 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
6247 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
6248 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
6249 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
6250 "fsb", al, ac);
6251 XmStringFree (dir_xmstring);
6252 XmStringFree (pattern_xmstring);
6254 /* Add callbacks for OK and Cancel. */
6255 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
6256 (XtPointer) &result);
6257 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
6258 (XtPointer) &result);
6259 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
6260 (XtPointer) &result);
6262 /* Remove the help button since we can't display help. */
6263 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
6264 XtUnmanageChild (help);
6266 /* Mark OK button as default. */
6267 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
6268 XmNshowAsDefault, True, NULL);
6270 /* If MUSTMATCH is non-nil, disable the file entry field of the
6271 dialog, so that the user must select a file from the files list
6272 box. We can't remove it because we wouldn't have a way to get at
6273 the result file name, then. */
6274 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
6275 if (!NILP (mustmatch))
6277 Widget label;
6278 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
6279 XtSetSensitive (text, False);
6280 XtSetSensitive (label, False);
6283 /* Manage the dialog, so that list boxes get filled. */
6284 XtManageChild (dialog);
6286 if (STRINGP (default_filename))
6288 XmString default_xmstring;
6289 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
6290 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
6292 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
6293 XmTextFieldReplace (wtext, 0, last_pos,
6294 (SSDATA (Ffile_name_nondirectory (default_filename))));
6296 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
6297 must include the path for this to work. */
6299 default_xmstring = XmStringCreateLocalized (SSDATA (default_filename));
6301 if (XmListItemExists (list, default_xmstring))
6303 int item_pos = XmListItemPos (list, default_xmstring);
6304 /* Select the item and scroll it into view. */
6305 XmListSelectPos (list, item_pos, True);
6306 XmListSetPos (list, item_pos);
6309 XmStringFree (default_xmstring);
6312 record_unwind_protect_ptr (clean_up_file_dialog, dialog);
6314 /* Process events until the user presses Cancel or OK. */
6315 x_menu_set_in_use (true);
6316 result = 0;
6317 while (result == 0)
6319 XEvent event;
6320 x_menu_wait_for_event (0);
6321 XtAppNextEvent (Xt_app_con, &event);
6322 if (event.type == KeyPress
6323 && FRAME_X_DISPLAY (f) == event.xkey.display)
6325 KeySym keysym = XLookupKeysym (&event.xkey, 0);
6327 /* Pop down on C-g. */
6328 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
6329 XtUnmanageChild (dialog);
6332 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
6335 /* Get the result. */
6336 if (result == XmCR_OK)
6338 XmString text_string;
6339 String data;
6341 XtVaGetValues (dialog, XmNtextString, &text_string, NULL);
6342 XmStringGetLtoR (text_string, XmFONTLIST_DEFAULT_TAG, &data);
6343 XmStringFree (text_string);
6344 file = build_string (data);
6345 XtFree (data);
6347 else
6348 file = Qnil;
6350 unblock_input ();
6352 /* Make "Cancel" equivalent to C-g. */
6353 if (NILP (file))
6354 Fsignal (Qquit, Qnil);
6356 decoded_file = DECODE_FILE (file);
6358 return unbind_to (count, decoded_file);
6361 #endif /* USE_MOTIF */
6363 #ifdef USE_GTK
6365 static void
6366 clean_up_dialog (void)
6368 x_menu_set_in_use (false);
6371 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
6372 doc: /* Read file name, prompting with PROMPT in directory DIR.
6373 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6374 selection box, if specified. If MUSTMATCH is non-nil, the returned file
6375 or directory must exist.
6377 This function is only defined on NS, MS Windows, and X Windows with the
6378 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6379 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories.
6380 On Windows 7 and later, the file selection dialog "remembers" the last
6381 directory where the user selected a file, and will open that directory
6382 instead of DIR on subsequent invocations of this function with the same
6383 value of DIR as in previous invocations; this is standard Windows behavior. */)
6384 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
6386 struct frame *f = SELECTED_FRAME ();
6387 char *fn;
6388 Lisp_Object file = Qnil;
6389 Lisp_Object decoded_file;
6390 ptrdiff_t count = SPECPDL_INDEX ();
6391 char *cdef_file;
6393 check_window_system (f);
6395 if (popup_activated ())
6396 error ("Trying to use a menu from within a menu-entry");
6398 CHECK_STRING (prompt);
6399 CHECK_STRING (dir);
6401 /* Prevent redisplay. */
6402 specbind (Qinhibit_redisplay, Qt);
6403 record_unwind_protect_void (clean_up_dialog);
6405 block_input ();
6407 if (STRINGP (default_filename))
6408 cdef_file = SSDATA (default_filename);
6409 else
6410 cdef_file = SSDATA (dir);
6412 fn = xg_get_file_name (f, SSDATA (prompt), cdef_file,
6413 ! NILP (mustmatch),
6414 ! NILP (only_dir_p));
6416 if (fn)
6418 file = build_string (fn);
6419 xfree (fn);
6422 unblock_input ();
6424 /* Make "Cancel" equivalent to C-g. */
6425 if (NILP (file))
6426 Fsignal (Qquit, Qnil);
6428 decoded_file = DECODE_FILE (file);
6430 return unbind_to (count, decoded_file);
6434 #ifdef HAVE_FREETYPE
6436 DEFUN ("x-select-font", Fx_select_font, Sx_select_font, 0, 2, 0,
6437 doc: /* Read a font using a GTK dialog.
6438 Return either a font spec (for GTK versions >= 3.2) or a string
6439 containing a GTK-style font name.
6441 FRAME is the frame on which to pop up the font chooser. If omitted or
6442 nil, it defaults to the selected frame. */)
6443 (Lisp_Object frame, Lisp_Object ignored)
6445 struct frame *f = decode_window_system_frame (frame);
6446 Lisp_Object font;
6447 Lisp_Object font_param;
6448 char *default_name = NULL;
6449 ptrdiff_t count = SPECPDL_INDEX ();
6451 if (popup_activated ())
6452 error ("Trying to use a menu from within a menu-entry");
6454 /* Prevent redisplay. */
6455 specbind (Qinhibit_redisplay, Qt);
6456 record_unwind_protect_void (clean_up_dialog);
6458 block_input ();
6460 XSETFONT (font, FRAME_FONT (f));
6461 font_param = Ffont_get (font, QCname);
6462 if (STRINGP (font_param))
6463 default_name = xlispstrdup (font_param);
6464 else
6466 font_param = Fframe_parameter (frame, Qfont_parameter);
6467 if (STRINGP (font_param))
6468 default_name = xlispstrdup (font_param);
6471 font = xg_get_font (f, default_name);
6472 xfree (default_name);
6474 unblock_input ();
6476 if (NILP (font))
6477 Fsignal (Qquit, Qnil);
6479 return unbind_to (count, font);
6481 #endif /* HAVE_FREETYPE */
6483 #endif /* USE_GTK */
6486 /***********************************************************************
6487 Keyboard
6488 ***********************************************************************/
6490 #ifdef HAVE_XKB
6491 #include <X11/XKBlib.h>
6492 #include <X11/keysym.h>
6493 #endif
6495 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
6496 Sx_backspace_delete_keys_p, 0, 1, 0,
6497 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
6498 FRAME nil means use the selected frame.
6499 Value is t if we know that both keys are present, and are mapped to the
6500 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
6501 present and mapped to the usual X keysyms. */)
6502 (Lisp_Object frame)
6504 #ifndef HAVE_XKB
6505 return Qlambda;
6506 #else
6507 XkbDescPtr kb;
6508 struct frame *f = decode_window_system_frame (frame);
6509 Display *dpy = FRAME_X_DISPLAY (f);
6510 Lisp_Object have_keys;
6511 int major, minor, op, event, error_code;
6513 block_input ();
6515 /* Check library version in case we're dynamically linked. */
6516 major = XkbMajorVersion;
6517 minor = XkbMinorVersion;
6518 if (!XkbLibraryVersion (&major, &minor))
6520 unblock_input ();
6521 return Qlambda;
6524 /* Check that the server supports XKB. */
6525 major = XkbMajorVersion;
6526 minor = XkbMinorVersion;
6527 if (!XkbQueryExtension (dpy, &op, &event, &error_code, &major, &minor))
6529 unblock_input ();
6530 return Qlambda;
6533 /* In this code we check that the keyboard has physical keys with names
6534 that start with BKSP (Backspace) and DELE (Delete), and that they
6535 generate keysym XK_BackSpace and XK_Delete respectively.
6536 This function is used to test if normal-erase-is-backspace should be
6537 turned on.
6538 An alternative approach would be to just check if XK_BackSpace and
6539 XK_Delete are mapped to any key. But if any of those are mapped to
6540 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
6541 user doesn't know about it, it is better to return false here.
6542 It is more obvious to the user what to do if she/he has two keys
6543 clearly marked with names/symbols and one key does something not
6544 expected (i.e. she/he then tries the other).
6545 The cases where Backspace/Delete is mapped to some other key combination
6546 are rare, and in those cases, normal-erase-is-backspace can be turned on
6547 manually. */
6549 have_keys = Qnil;
6550 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
6551 if (kb)
6553 int delete_keycode = 0, backspace_keycode = 0, i;
6555 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
6557 for (i = kb->min_key_code;
6558 (i < kb->max_key_code
6559 && (delete_keycode == 0 || backspace_keycode == 0));
6560 ++i)
6562 /* The XKB symbolic key names can be seen most easily in
6563 the PS file generated by `xkbprint -label name
6564 $DISPLAY'. */
6565 if (memcmp ("DELE", kb->names->keys[i].name, 4) == 0)
6566 delete_keycode = i;
6567 else if (memcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
6568 backspace_keycode = i;
6571 XkbFreeNames (kb, 0, True);
6574 /* As of libX11-1.6.2, XkbGetMap manual says that you should use
6575 XkbFreeClientMap to free the data returned by XkbGetMap. But
6576 this function just frees the data referenced from KB and not
6577 KB itself. To free KB as well, call XkbFreeKeyboard. */
6578 XkbFreeKeyboard (kb, XkbAllMapComponentsMask, True);
6580 if (delete_keycode
6581 && backspace_keycode
6582 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
6583 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
6584 have_keys = Qt;
6586 unblock_input ();
6587 return have_keys;
6588 #endif
6593 /***********************************************************************
6594 Printing
6595 ***********************************************************************/
6597 #ifdef USE_CAIRO
6598 DEFUN ("x-export-frames", Fx_export_frames, Sx_export_frames, 0, 2, 0,
6599 doc: /* Return image data of FRAMES in TYPE format.
6600 FRAMES should be nil (the selected frame), a frame, or a list of
6601 frames (each of which corresponds to one page). Each frame should be
6602 visible. Optional arg TYPE should be either `pdf' (default), `png',
6603 `postscript', or `svg'. Supported types are determined by the
6604 compile-time configuration of cairo. */)
6605 (Lisp_Object frames, Lisp_Object type)
6607 Lisp_Object rest, tmp;
6608 cairo_surface_type_t surface_type;
6610 if (!CONSP (frames))
6611 frames = list1 (frames);
6613 tmp = Qnil;
6614 for (rest = frames; CONSP (rest); rest = XCDR (rest))
6616 struct frame *f = decode_window_system_frame (XCAR (rest));
6617 Lisp_Object frame;
6619 XSETFRAME (frame, f);
6620 if (!FRAME_VISIBLE_P (f))
6621 error ("Frames to be exported must be visible.");
6622 tmp = Fcons (frame, tmp);
6624 frames = Fnreverse (tmp);
6626 #ifdef CAIRO_HAS_PDF_SURFACE
6627 if (NILP (type) || EQ (type, Qpdf))
6628 surface_type = CAIRO_SURFACE_TYPE_PDF;
6629 else
6630 #endif
6631 #ifdef CAIRO_HAS_PNG_FUNCTIONS
6632 if (EQ (type, Qpng))
6634 if (!NILP (XCDR (frames)))
6635 error ("PNG export cannot handle multiple frames.");
6636 surface_type = CAIRO_SURFACE_TYPE_IMAGE;
6638 else
6639 #endif
6640 #ifdef CAIRO_HAS_PS_SURFACE
6641 if (EQ (type, Qpostscript))
6642 surface_type = CAIRO_SURFACE_TYPE_PS;
6643 else
6644 #endif
6645 #ifdef CAIRO_HAS_SVG_SURFACE
6646 if (EQ (type, Qsvg))
6648 /* For now, we stick to SVG 1.1. */
6649 if (!NILP (XCDR (frames)))
6650 error ("SVG export cannot handle multiple frames.");
6651 surface_type = CAIRO_SURFACE_TYPE_SVG;
6653 else
6654 #endif
6655 error ("Unsupported export type");
6657 return x_cr_export_frames (frames, surface_type);
6660 #ifdef USE_GTK
6661 DEFUN ("x-page-setup-dialog", Fx_page_setup_dialog, Sx_page_setup_dialog, 0, 0, 0,
6662 doc: /* Pop up a page setup dialog.
6663 The current page setup can be obtained using `x-get-page-setup'. */)
6664 (void)
6666 block_input ();
6667 xg_page_setup_dialog ();
6668 unblock_input ();
6670 return Qnil;
6673 DEFUN ("x-get-page-setup", Fx_get_page_setup, Sx_get_page_setup, 0, 0, 0,
6674 doc: /* Return the value of the current page setup.
6675 The return value is an alist containing the following keys:
6677 orientation: page orientation (symbol `portrait', `landscape',
6678 `reverse-portrait', or `reverse-landscape').
6679 width, height: page width/height in points not including margins.
6680 left-margin, right-margin, top-margin, bottom-margin: print margins,
6681 which is the parts of the page that the printer cannot print
6682 on, in points.
6684 The paper width can be obtained as the sum of width, left-margin, and
6685 right-margin values if the page orientation is `portrait' or
6686 `reverse-portrait'. Otherwise, it is the sum of width, top-margin,
6687 and bottom-margin values. Likewise, the paper height is the sum of
6688 height, top-margin, and bottom-margin values if the page orientation
6689 is `portrait' or `reverse-portrait'. Otherwise, it is the sum of
6690 height, left-margin, and right-margin values. */)
6691 (void)
6693 Lisp_Object result;
6695 block_input ();
6696 result = xg_get_page_setup ();
6697 unblock_input ();
6699 return result;
6702 DEFUN ("x-print-frames-dialog", Fx_print_frames_dialog, Sx_print_frames_dialog, 0, 1, "",
6703 doc: /* Pop up a print dialog to print the current contents of FRAMES.
6704 FRAMES should be nil (the selected frame), a frame, or a list of
6705 frames (each of which corresponds to one page). Each frame should be
6706 visible. */)
6707 (Lisp_Object frames)
6709 Lisp_Object rest, tmp;
6710 int count;
6712 if (!CONSP (frames))
6713 frames = list1 (frames);
6715 tmp = Qnil;
6716 for (rest = frames; CONSP (rest); rest = XCDR (rest))
6718 struct frame *f = decode_window_system_frame (XCAR (rest));
6719 Lisp_Object frame;
6721 XSETFRAME (frame, f);
6722 if (!FRAME_VISIBLE_P (f))
6723 error ("Frames to be printed must be visible.");
6724 tmp = Fcons (frame, tmp);
6726 frames = Fnreverse (tmp);
6728 /* Make sure the current matrices are up-to-date. */
6729 count = SPECPDL_INDEX ();
6730 specbind (Qredisplay_dont_pause, Qt);
6731 redisplay_preserve_echo_area (32);
6732 unbind_to (count, Qnil);
6734 block_input ();
6735 xg_print_frames_dialog (frames);
6736 unblock_input ();
6738 return Qnil;
6740 #endif /* USE_GTK */
6741 #endif /* USE_CAIRO */
6744 /***********************************************************************
6745 Initialization
6746 ***********************************************************************/
6748 /* Keep this list in the same order as frame_parms in frame.c.
6749 Use 0 for unsupported frame parameters. */
6751 frame_parm_handler x_frame_parm_handlers[] =
6753 x_set_autoraise,
6754 x_set_autolower,
6755 x_set_background_color,
6756 x_set_border_color,
6757 x_set_border_width,
6758 x_set_cursor_color,
6759 x_set_cursor_type,
6760 x_set_font,
6761 x_set_foreground_color,
6762 x_set_icon_name,
6763 x_set_icon_type,
6764 x_set_internal_border_width,
6765 x_set_right_divider_width,
6766 x_set_bottom_divider_width,
6767 x_set_menu_bar_lines,
6768 x_set_mouse_color,
6769 x_explicitly_set_name,
6770 x_set_scroll_bar_width,
6771 x_set_scroll_bar_height,
6772 x_set_title,
6773 x_set_unsplittable,
6774 x_set_vertical_scroll_bars,
6775 x_set_horizontal_scroll_bars,
6776 x_set_visibility,
6777 x_set_tool_bar_lines,
6778 x_set_scroll_bar_foreground,
6779 x_set_scroll_bar_background,
6780 x_set_screen_gamma,
6781 x_set_line_spacing,
6782 x_set_left_fringe,
6783 x_set_right_fringe,
6784 x_set_wait_for_wm,
6785 x_set_fullscreen,
6786 x_set_font_backend,
6787 x_set_alpha,
6788 x_set_sticky,
6789 x_set_tool_bar_position,
6792 void
6793 syms_of_xfns (void)
6795 DEFSYM (Qundefined_color, "undefined-color");
6796 DEFSYM (Qcompound_text, "compound-text");
6797 DEFSYM (Qcancel_timer, "cancel-timer");
6798 DEFSYM (Qfont_parameter, "font-parameter");
6799 DEFSYM (Qmono, "mono");
6800 DEFSYM (Qassq_delete_all, "assq-delete-all");
6802 #ifdef USE_CAIRO
6803 DEFSYM (Qpdf, "pdf");
6805 DEFSYM (Qorientation, "orientation");
6806 DEFSYM (Qtop_margin, "top-margin");
6807 DEFSYM (Qbottom_margin, "bottom-margin");
6808 DEFSYM (Qportrait, "portrait");
6809 DEFSYM (Qlandscape, "landscape");
6810 DEFSYM (Qreverse_portrait, "reverse-portrait");
6811 DEFSYM (Qreverse_landscape, "reverse-landscape");
6812 #endif
6814 Fput (Qundefined_color, Qerror_conditions,
6815 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
6816 Fput (Qundefined_color, Qerror_message,
6817 build_pure_c_string ("Undefined color"));
6819 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
6820 doc: /* The shape of the pointer when over text.
6821 Changing the value does not affect existing frames
6822 unless you set the mouse color. */);
6823 Vx_pointer_shape = Qnil;
6825 #if false /* This doesn't really do anything. */
6826 DEFVAR_LISP ("x-nontext-pointer-shape", Vx_nontext_pointer_shape,
6827 doc: /* The shape of the pointer when not over text.
6828 This variable takes effect when you create a new frame
6829 or when you set the mouse color. */);
6830 #endif
6831 Vx_nontext_pointer_shape = Qnil;
6833 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
6834 doc: /* The shape of the pointer when Emacs is busy.
6835 This variable takes effect when you create a new frame
6836 or when you set the mouse color. */);
6837 Vx_hourglass_pointer_shape = Qnil;
6839 #if false /* This doesn't really do anything. */
6840 DEFVAR_LISP ("x-mode-pointer-shape", Vx_mode_pointer_shape,
6841 doc: /* The shape of the pointer when over the mode line.
6842 This variable takes effect when you create a new frame
6843 or when you set the mouse color. */);
6844 #endif
6845 Vx_mode_pointer_shape = Qnil;
6847 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
6848 Vx_sensitive_text_pointer_shape,
6849 doc: /* The shape of the pointer when over mouse-sensitive text.
6850 This variable takes effect when you create a new frame
6851 or when you set the mouse color. */);
6852 Vx_sensitive_text_pointer_shape = Qnil;
6854 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
6855 Vx_window_horizontal_drag_shape,
6856 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
6857 This variable takes effect when you create a new frame
6858 or when you set the mouse color. */);
6859 Vx_window_horizontal_drag_shape = Qnil;
6861 DEFVAR_LISP ("x-window-vertical-drag-cursor",
6862 Vx_window_vertical_drag_shape,
6863 doc: /* Pointer shape to use for indicating a window can be dragged vertically.
6864 This variable takes effect when you create a new frame
6865 or when you set the mouse color. */);
6866 Vx_window_vertical_drag_shape = Qnil;
6868 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
6869 doc: /* A string indicating the foreground color of the cursor box. */);
6870 Vx_cursor_fore_pixel = Qnil;
6872 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
6873 doc: /* Maximum size for tooltips.
6874 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
6875 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
6877 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
6878 doc: /* Non-nil if no X window manager is in use.
6879 Emacs doesn't try to figure this out; this is always nil
6880 unless you set it to something else. */);
6881 /* We don't have any way to find this out, so set it to nil
6882 and maybe the user would like to set it to t. */
6883 Vx_no_window_manager = Qnil;
6885 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
6886 Vx_pixel_size_width_font_regexp,
6887 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
6889 Since Emacs gets width of a font matching with this regexp from
6890 PIXEL_SIZE field of the name, font finding mechanism gets faster for
6891 such a font. This is especially effective for such large fonts as
6892 Chinese, Japanese, and Korean. */);
6893 Vx_pixel_size_width_font_regexp = Qnil;
6895 /* This is not ifdef:ed, so other builds than GTK can customize it. */
6896 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", x_gtk_use_old_file_dialog,
6897 doc: /* Non-nil means prompt with the old GTK file selection dialog.
6898 If nil or if the file selection dialog is not available, the new GTK file
6899 chooser is used instead. To turn off all file dialogs set the
6900 variable `use-file-dialog'. */);
6901 x_gtk_use_old_file_dialog = false;
6903 DEFVAR_BOOL ("x-gtk-show-hidden-files", x_gtk_show_hidden_files,
6904 doc: /* If non-nil, the GTK file chooser will by default show hidden files.
6905 Note that this is just the default, there is a toggle button on the file
6906 chooser to show or not show hidden files on a case by case basis. */);
6907 x_gtk_show_hidden_files = false;
6909 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", x_gtk_file_dialog_help_text,
6910 doc: /* If non-nil, the GTK file chooser will show additional help text.
6911 If more space for files in the file chooser dialog is wanted, set this to nil
6912 to turn the additional text off. */);
6913 x_gtk_file_dialog_help_text = true;
6915 DEFVAR_BOOL ("x-gtk-use-system-tooltips", x_gtk_use_system_tooltips,
6916 doc: /* If non-nil with a Gtk+ built Emacs, the Gtk+ tooltip is used.
6917 Otherwise use Emacs own tooltip implementation.
6918 When using Gtk+ tooltips, the tooltip face is not used. */);
6919 x_gtk_use_system_tooltips = true;
6921 /* Tell Emacs about this window system. */
6922 Fprovide (Qx, Qnil);
6924 #ifdef USE_X_TOOLKIT
6925 Fprovide (intern_c_string ("x-toolkit"), Qnil);
6926 #ifdef USE_MOTIF
6927 Fprovide (intern_c_string ("motif"), Qnil);
6929 DEFVAR_LISP ("motif-version-string", Vmotif_version_string,
6930 doc: /* Version info for LessTif/Motif. */);
6931 Vmotif_version_string = build_string (XmVERSION_STRING);
6932 #endif /* USE_MOTIF */
6933 #endif /* USE_X_TOOLKIT */
6935 #ifdef USE_GTK
6936 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
6937 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
6938 But for a user it is a toolkit for X, and indeed, configure
6939 accepts --with-x-toolkit=gtk. */
6940 Fprovide (intern_c_string ("x-toolkit"), Qnil);
6941 Fprovide (intern_c_string ("gtk"), Qnil);
6942 Fprovide (intern_c_string ("move-toolbar"), Qnil);
6944 DEFVAR_LISP ("gtk-version-string", Vgtk_version_string,
6945 doc: /* Version info for GTK+. */);
6947 char gtk_version[sizeof ".." + 3 * INT_STRLEN_BOUND (int)];
6948 int len = sprintf (gtk_version, "%d.%d.%d",
6949 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
6950 Vgtk_version_string = make_pure_string (gtk_version, len, len, false);
6952 #endif /* USE_GTK */
6954 #ifdef USE_CAIRO
6955 Fprovide (intern_c_string ("cairo"), Qnil);
6957 DEFVAR_LISP ("cairo-version-string", Vcairo_version_string,
6958 doc: /* Version info for cairo. */);
6960 char cairo_version[sizeof ".." + 3 * INT_STRLEN_BOUND (int)];
6961 int len = sprintf (cairo_version, "%d.%d.%d",
6962 CAIRO_VERSION_MAJOR, CAIRO_VERSION_MINOR,
6963 CAIRO_VERSION_MICRO);
6964 Vcairo_version_string = make_pure_string (cairo_version, len, len, false);
6966 #endif
6968 /* X window properties. */
6969 defsubr (&Sx_change_window_property);
6970 defsubr (&Sx_delete_window_property);
6971 defsubr (&Sx_window_property);
6973 defsubr (&Sxw_display_color_p);
6974 defsubr (&Sx_display_grayscale_p);
6975 defsubr (&Sxw_color_defined_p);
6976 defsubr (&Sxw_color_values);
6977 defsubr (&Sx_server_max_request_size);
6978 defsubr (&Sx_server_vendor);
6979 defsubr (&Sx_server_version);
6980 defsubr (&Sx_display_pixel_width);
6981 defsubr (&Sx_display_pixel_height);
6982 defsubr (&Sx_display_mm_width);
6983 defsubr (&Sx_display_mm_height);
6984 defsubr (&Sx_display_screens);
6985 defsubr (&Sx_display_planes);
6986 defsubr (&Sx_display_color_cells);
6987 defsubr (&Sx_display_visual_class);
6988 defsubr (&Sx_display_backing_store);
6989 defsubr (&Sx_display_save_under);
6990 defsubr (&Sx_display_monitor_attributes_list);
6991 defsubr (&Sx_frame_geometry);
6992 defsubr (&Sx_frame_edges);
6993 defsubr (&Sx_mouse_absolute_pixel_position);
6994 defsubr (&Sx_set_mouse_absolute_pixel_position);
6995 defsubr (&Sx_wm_set_size_hint);
6996 defsubr (&Sx_create_frame);
6997 defsubr (&Sx_open_connection);
6998 defsubr (&Sx_close_connection);
6999 defsubr (&Sx_display_list);
7000 defsubr (&Sx_synchronize);
7001 defsubr (&Sx_backspace_delete_keys_p);
7003 defsubr (&Sx_show_tip);
7004 defsubr (&Sx_hide_tip);
7005 tip_timer = Qnil;
7006 staticpro (&tip_timer);
7007 tip_frame = Qnil;
7008 staticpro (&tip_frame);
7010 last_show_tip_args = Qnil;
7011 staticpro (&last_show_tip_args);
7013 defsubr (&Sx_uses_old_gtk_dialog);
7014 #if defined (USE_MOTIF) || defined (USE_GTK)
7015 defsubr (&Sx_file_dialog);
7016 #endif
7018 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
7019 defsubr (&Sx_select_font);
7020 #endif
7022 #ifdef USE_CAIRO
7023 defsubr (&Sx_export_frames);
7024 #ifdef USE_GTK
7025 defsubr (&Sx_page_setup_dialog);
7026 defsubr (&Sx_get_page_setup);
7027 defsubr (&Sx_print_frames_dialog);
7028 #endif
7029 #endif