Document EWW.
[emacs.git] / src / xfns.c
bloba78c2bf6b769148db9be9ff6da0626d1ff634c5d
1 /* Functions for the X window system.
3 Copyright (C) 1989, 1992-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #include <config.h>
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 "character.h"
30 #include "buffer.h"
31 #include "intervals.h"
32 #include "dispextern.h"
33 #include "keyboard.h"
34 #include "blockinput.h"
35 #include <epaths.h>
36 #include "charset.h"
37 #include "coding.h"
38 #include "fontset.h"
39 #include "systime.h"
40 #include "termhooks.h"
41 #include "atimer.h"
42 #include "termchar.h"
43 #include "font.h"
45 #include <sys/types.h>
46 #include <sys/stat.h>
48 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
49 #include "bitmaps/gray.xbm"
50 #else
51 #include <X11/bitmaps/gray>
52 #endif
54 #include "xsettings.h"
56 #ifdef HAVE_XRANDR
57 #include <X11/extensions/Xrandr.h>
58 #endif
59 #ifdef HAVE_XINERAMA
60 #include <X11/extensions/Xinerama.h>
61 #endif
63 #ifdef USE_GTK
64 #include "gtkutil.h"
65 #endif
67 #ifdef USE_X_TOOLKIT
68 #include <X11/Shell.h>
70 #ifndef USE_MOTIF
71 #ifdef HAVE_XAW3D
72 #include <X11/Xaw3d/Paned.h>
73 #include <X11/Xaw3d/Label.h>
74 #else /* !HAVE_XAW3D */
75 #include <X11/Xaw/Paned.h>
76 #include <X11/Xaw/Label.h>
77 #endif /* HAVE_XAW3D */
78 #endif /* USE_MOTIF */
80 #ifdef USG
81 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
82 #include <X11/Xos.h>
83 #define USG
84 #ifdef USG /* Pacify gcc -Wunused-macros. */
85 #endif
86 #else
87 #include <X11/Xos.h>
88 #endif
90 #include "widget.h"
92 #include "../lwlib/lwlib.h"
94 #ifdef USE_MOTIF
95 #include <Xm/Xm.h>
96 #include <Xm/DialogS.h>
97 #include <Xm/FileSB.h>
98 #include <Xm/List.h>
99 #include <Xm/TextF.h>
100 #endif
102 #ifdef USE_LUCID
103 #include "../lwlib/xlwmenu.h"
104 #endif
106 #if !defined (NO_EDITRES)
107 #define HACK_EDITRES
108 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
109 #endif /* not defined NO_EDITRES */
111 /* Unique id counter for widgets created by the Lucid Widget Library. */
113 extern LWLIB_ID widget_id_tick;
115 #ifdef USE_MOTIF
117 #endif /* USE_MOTIF */
119 #endif /* USE_X_TOOLKIT */
121 #ifdef USE_GTK
123 #endif /* USE_GTK */
125 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
127 static Lisp_Object Qsuppress_icon;
128 static Lisp_Object Qundefined_color;
129 static Lisp_Object Qcompound_text, Qcancel_timer;
130 Lisp_Object Qfont_param;
132 #ifdef GLYPH_DEBUG
133 static ptrdiff_t image_cache_refcount;
134 static int dpyinfo_refcount;
135 #endif
137 static struct x_display_info *x_display_info_for_name (Lisp_Object);
139 /* Let the user specify an X display with a Lisp object.
140 OBJECT may be nil, a frame or a terminal object.
141 nil stands for the selected frame--or, if that is not an X frame,
142 the first X display on the list. */
144 struct x_display_info *
145 check_x_display_info (Lisp_Object object)
147 struct x_display_info *dpyinfo = NULL;
149 if (NILP (object))
151 struct frame *sf = XFRAME (selected_frame);
153 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
154 dpyinfo = FRAME_DISPLAY_INFO (sf);
155 else if (x_display_list != 0)
156 dpyinfo = x_display_list;
157 else
158 error ("X windows are not in use or not initialized");
160 else if (TERMINALP (object))
162 struct terminal *t = get_terminal (object, 1);
164 if (t->type != output_x_window)
165 error ("Terminal %d is not an X display", t->id);
167 dpyinfo = t->display_info.x;
169 else if (STRINGP (object))
170 dpyinfo = x_display_info_for_name (object);
171 else
173 struct frame *f = decode_window_system_frame (object);
174 dpyinfo = FRAME_DISPLAY_INFO (f);
177 return dpyinfo;
180 /* Store the screen positions of frame F into XPTR and YPTR.
181 These are the positions of the containing window manager window,
182 not Emacs's own window. */
184 void
185 x_real_positions (struct frame *f, int *xptr, int *yptr)
187 int win_x, win_y, outer_x IF_LINT (= 0), outer_y IF_LINT (= 0);
188 int real_x = 0, real_y = 0;
189 int had_errors = 0;
190 Window win = f->output_data.x->parent_desc;
191 Atom actual_type;
192 unsigned long actual_size, bytes_remaining;
193 int rc, actual_format;
194 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
195 long max_len = 400;
196 Display *dpy = FRAME_X_DISPLAY (f);
197 unsigned char *tmp_data = NULL;
198 Atom target_type = XA_CARDINAL;
200 block_input ();
202 x_catch_errors (dpy);
204 if (win == dpyinfo->root_window)
205 win = FRAME_OUTER_WINDOW (f);
207 /* This loop traverses up the containment tree until we hit the root
208 window. Window managers may intersect many windows between our window
209 and the root window. The window we find just before the root window
210 should be the outer WM window. */
211 for (;;)
213 Window wm_window, rootw;
214 Window *tmp_children;
215 unsigned int tmp_nchildren;
216 int success;
218 success = XQueryTree (FRAME_X_DISPLAY (f), win, &rootw,
219 &wm_window, &tmp_children, &tmp_nchildren);
221 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
223 /* Don't free tmp_children if XQueryTree failed. */
224 if (! success)
225 break;
227 XFree (tmp_children);
229 if (wm_window == rootw || had_errors)
230 break;
232 win = wm_window;
235 if (! had_errors)
237 unsigned int ign;
238 Window child, rootw;
240 /* Get the real coordinates for the WM window upper left corner */
241 XGetGeometry (FRAME_X_DISPLAY (f), win,
242 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
244 /* Translate real coordinates to coordinates relative to our
245 window. For our window, the upper left corner is 0, 0.
246 Since the upper left corner of the WM window is outside
247 our window, win_x and win_y will be negative:
249 ------------------ ---> x
250 | title |
251 | ----------------- v y
252 | | our window
254 XTranslateCoordinates (FRAME_X_DISPLAY (f),
256 /* From-window, to-window. */
257 FRAME_DISPLAY_INFO (f)->root_window,
258 FRAME_X_WINDOW (f),
260 /* From-position, to-position. */
261 real_x, real_y, &win_x, &win_y,
263 /* Child of win. */
264 &child);
266 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
268 outer_x = win_x;
269 outer_y = win_y;
271 else
273 XTranslateCoordinates (FRAME_X_DISPLAY (f),
275 /* From-window, to-window. */
276 FRAME_DISPLAY_INFO (f)->root_window,
277 FRAME_OUTER_WINDOW (f),
279 /* From-position, to-position. */
280 real_x, real_y, &outer_x, &outer_y,
282 /* Child of win. */
283 &child);
286 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
290 if (dpyinfo->root_window == f->output_data.x->parent_desc)
292 /* Try _NET_FRAME_EXTENTS if our parent is the root window. */
293 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_frame_extents,
294 0, max_len, False, target_type,
295 &actual_type, &actual_format, &actual_size,
296 &bytes_remaining, &tmp_data);
298 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
299 && actual_size == 4 && actual_format == 32)
301 unsigned int ign;
302 Window rootw;
303 long *fe = (long *)tmp_data;
305 XGetGeometry (FRAME_X_DISPLAY (f), win,
306 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
307 outer_x = -fe[0];
308 outer_y = -fe[2];
309 real_x -= fe[0];
310 real_y -= fe[2];
314 if (tmp_data) XFree (tmp_data);
316 x_uncatch_errors ();
318 unblock_input ();
320 if (had_errors) return;
322 f->x_pixels_diff = -win_x;
323 f->y_pixels_diff = -win_y;
325 FRAME_X_OUTPUT (f)->x_pixels_outer_diff = -outer_x;
326 FRAME_X_OUTPUT (f)->y_pixels_outer_diff = -outer_y;
328 *xptr = real_x;
329 *yptr = real_y;
335 /* Gamma-correct COLOR on frame F. */
337 void
338 gamma_correct (struct frame *f, XColor *color)
340 if (f->gamma)
342 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
343 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
344 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
349 /* Decide if color named COLOR_NAME is valid for use on frame F. If
350 so, return the RGB values in COLOR. If ALLOC_P,
351 allocate the color. Value is false if COLOR_NAME is invalid, or
352 no color could be allocated. */
354 bool
355 x_defined_color (struct frame *f, const char *color_name,
356 XColor *color, bool alloc_p)
358 bool success_p = 0;
359 Display *dpy = FRAME_X_DISPLAY (f);
360 Colormap cmap = FRAME_X_COLORMAP (f);
362 block_input ();
363 #ifdef USE_GTK
364 success_p = xg_check_special_colors (f, color_name, color);
365 #endif
366 if (!success_p)
367 success_p = XParseColor (dpy, cmap, color_name, color) != 0;
368 if (success_p && alloc_p)
369 success_p = x_alloc_nearest_color (f, cmap, color);
370 unblock_input ();
372 return success_p;
376 /* Return the pixel color value for color COLOR_NAME on frame F. If F
377 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
378 Signal an error if color can't be allocated. */
380 static int
381 x_decode_color (struct frame *f, Lisp_Object color_name, int mono_color)
383 XColor cdef;
385 CHECK_STRING (color_name);
387 #if 0 /* Don't do this. It's wrong when we're not using the default
388 colormap, it makes freeing difficult, and it's probably not
389 an important optimization. */
390 if (strcmp (SDATA (color_name), "black") == 0)
391 return BLACK_PIX_DEFAULT (f);
392 else if (strcmp (SDATA (color_name), "white") == 0)
393 return WHITE_PIX_DEFAULT (f);
394 #endif
396 /* Return MONO_COLOR for monochrome frames. */
397 if (FRAME_DISPLAY_INFO (f)->n_planes == 1)
398 return mono_color;
400 /* x_defined_color is responsible for coping with failures
401 by looking for a near-miss. */
402 if (x_defined_color (f, SSDATA (color_name), &cdef, 1))
403 return cdef.pixel;
405 signal_error ("Undefined color", color_name);
410 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
411 the previous value of that parameter, NEW_VALUE is the new value.
412 See also the comment of wait_for_wm in struct x_output. */
414 static void
415 x_set_wait_for_wm (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
417 f->output_data.x->wait_for_wm = !NILP (new_value);
420 static void
421 x_set_tool_bar_position (struct frame *f,
422 Lisp_Object new_value,
423 Lisp_Object old_value)
425 if (! EQ (new_value, Qleft) && ! EQ (new_value, Qright)
426 && ! EQ (new_value, Qbottom) && ! EQ (new_value, Qtop))
427 return;
428 if (EQ (new_value, old_value)) return;
430 #ifdef USE_GTK
431 xg_change_toolbar_position (f, new_value);
432 fset_tool_bar_position (f, new_value);
433 #endif
436 #ifdef USE_GTK
438 /* Set icon from FILE for frame F. By using GTK functions the icon
439 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
442 xg_set_icon (struct frame *f, Lisp_Object file)
444 int result = 0;
445 Lisp_Object found;
447 found = x_find_image_file (file);
449 if (! NILP (found))
451 GdkPixbuf *pixbuf;
452 GError *err = NULL;
453 char *filename = SSDATA (found);
454 block_input ();
456 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
458 if (pixbuf)
460 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
461 pixbuf);
462 g_object_unref (pixbuf);
464 result = 1;
466 else
467 g_error_free (err);
469 unblock_input ();
472 return result;
476 xg_set_icon_from_xpm_data (struct frame *f, const char **data)
478 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data (data);
480 if (!pixbuf)
481 return 0;
483 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), pixbuf);
484 g_object_unref (pixbuf);
485 return 1;
487 #endif /* USE_GTK */
490 /* Functions called only from `x_set_frame_param'
491 to set individual parameters.
493 If FRAME_X_WINDOW (f) is 0,
494 the frame is being created and its X-window does not exist yet.
495 In that case, just record the parameter's new value
496 in the standard place; do not attempt to change the window. */
498 static void
499 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
501 struct x_output *x = f->output_data.x;
502 unsigned long fg, old_fg;
504 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
505 old_fg = FRAME_FOREGROUND_PIXEL (f);
506 FRAME_FOREGROUND_PIXEL (f) = fg;
508 if (FRAME_X_WINDOW (f) != 0)
510 Display *dpy = FRAME_X_DISPLAY (f);
512 block_input ();
513 XSetForeground (dpy, x->normal_gc, fg);
514 XSetBackground (dpy, x->reverse_gc, fg);
516 if (x->cursor_pixel == old_fg)
518 unload_color (f, x->cursor_pixel);
519 x->cursor_pixel = x_copy_color (f, fg);
520 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
523 unblock_input ();
525 update_face_from_frame_parameter (f, Qforeground_color, arg);
527 if (FRAME_VISIBLE_P (f))
528 redraw_frame (f);
531 unload_color (f, old_fg);
534 static void
535 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
537 struct x_output *x = f->output_data.x;
538 unsigned long bg;
540 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
541 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
542 FRAME_BACKGROUND_PIXEL (f) = bg;
544 if (FRAME_X_WINDOW (f) != 0)
546 Display *dpy = FRAME_X_DISPLAY (f);
548 block_input ();
549 XSetBackground (dpy, x->normal_gc, bg);
550 XSetForeground (dpy, x->reverse_gc, bg);
551 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
552 XSetForeground (dpy, x->cursor_gc, bg);
554 #ifdef USE_GTK
555 xg_set_background_color (f, bg);
556 #endif
558 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
559 toolkit scroll bars. */
561 Lisp_Object bar;
562 for (bar = FRAME_SCROLL_BARS (f);
563 !NILP (bar);
564 bar = XSCROLL_BAR (bar)->next)
566 Window window = XSCROLL_BAR (bar)->x_window;
567 XSetWindowBackground (dpy, window, bg);
570 #endif /* USE_TOOLKIT_SCROLL_BARS */
572 unblock_input ();
573 update_face_from_frame_parameter (f, Qbackground_color, arg);
575 if (FRAME_VISIBLE_P (f))
576 redraw_frame (f);
580 static Cursor
581 make_invisible_cursor (struct frame *f)
583 Display *dpy = FRAME_X_DISPLAY (f);
584 static char const no_data[] = { 0 };
585 Pixmap pix;
586 XColor col;
587 Cursor c = 0;
589 x_catch_errors (dpy);
590 pix = XCreateBitmapFromData (dpy, FRAME_DISPLAY_INFO (f)->root_window,
591 no_data, 1, 1);
592 if (! x_had_errors_p (dpy) && pix != None)
594 Cursor pixc;
595 col.pixel = 0;
596 col.red = col.green = col.blue = 0;
597 col.flags = DoRed | DoGreen | DoBlue;
598 pixc = XCreatePixmapCursor (dpy, pix, pix, &col, &col, 0, 0);
599 if (! x_had_errors_p (dpy) && pixc != None)
600 c = pixc;
601 XFreePixmap (dpy, pix);
604 x_uncatch_errors ();
606 return c;
609 static void
610 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
612 struct x_output *x = f->output_data.x;
613 Display *dpy = FRAME_X_DISPLAY (f);
614 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
615 Cursor hourglass_cursor, horizontal_drag_cursor, vertical_drag_cursor;
616 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
617 unsigned long mask_color = FRAME_BACKGROUND_PIXEL (f);
619 /* Don't let pointers be invisible. */
620 if (mask_color == pixel)
622 x_free_colors (f, &pixel, 1);
623 pixel = x_copy_color (f, FRAME_FOREGROUND_PIXEL (f));
626 unload_color (f, x->mouse_pixel);
627 x->mouse_pixel = pixel;
629 block_input ();
631 /* It's not okay to crash if the user selects a screwy cursor. */
632 x_catch_errors (dpy);
634 if (!NILP (Vx_pointer_shape))
636 CHECK_NUMBER (Vx_pointer_shape);
637 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
639 else
640 cursor = XCreateFontCursor (dpy, XC_xterm);
641 x_check_errors (dpy, "bad text pointer cursor: %s");
643 if (!NILP (Vx_nontext_pointer_shape))
645 CHECK_NUMBER (Vx_nontext_pointer_shape);
646 nontext_cursor
647 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
649 else
650 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
651 x_check_errors (dpy, "bad nontext pointer cursor: %s");
653 if (!NILP (Vx_hourglass_pointer_shape))
655 CHECK_NUMBER (Vx_hourglass_pointer_shape);
656 hourglass_cursor
657 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
659 else
660 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
661 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
663 if (!NILP (Vx_mode_pointer_shape))
665 CHECK_NUMBER (Vx_mode_pointer_shape);
666 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
668 else
669 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
670 x_check_errors (dpy, "bad modeline pointer cursor: %s");
672 if (!NILP (Vx_sensitive_text_pointer_shape))
674 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
675 hand_cursor
676 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
678 else
679 hand_cursor = XCreateFontCursor (dpy, XC_hand2);
681 if (!NILP (Vx_window_horizontal_drag_shape))
683 CHECK_TYPE_RANGED_INTEGER (unsigned, Vx_window_horizontal_drag_shape);
684 horizontal_drag_cursor
685 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
687 else
688 horizontal_drag_cursor
689 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
691 if (!NILP (Vx_window_vertical_drag_shape))
693 CHECK_NUMBER (Vx_window_vertical_drag_shape);
694 vertical_drag_cursor
695 = XCreateFontCursor (dpy, XINT (Vx_window_vertical_drag_shape));
697 else
698 vertical_drag_cursor
699 = XCreateFontCursor (dpy, XC_sb_v_double_arrow);
701 /* Check and report errors with the above calls. */
702 x_check_errors (dpy, "can't set cursor shape: %s");
703 x_uncatch_errors ();
706 XColor fore_color, back_color;
708 fore_color.pixel = x->mouse_pixel;
709 x_query_color (f, &fore_color);
710 back_color.pixel = mask_color;
711 x_query_color (f, &back_color);
713 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
714 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
715 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
716 XRecolorCursor (dpy, hand_cursor, &fore_color, &back_color);
717 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
718 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
721 if (FRAME_X_WINDOW (f) != 0)
722 XDefineCursor (dpy, FRAME_X_WINDOW (f),
723 f->output_data.x->current_cursor = cursor);
725 if (FRAME_DISPLAY_INFO (f)->invisible_cursor == 0)
726 FRAME_DISPLAY_INFO (f)->invisible_cursor = make_invisible_cursor (f);
728 if (cursor != x->text_cursor
729 && x->text_cursor != 0)
730 XFreeCursor (dpy, x->text_cursor);
731 x->text_cursor = cursor;
733 if (nontext_cursor != x->nontext_cursor
734 && x->nontext_cursor != 0)
735 XFreeCursor (dpy, x->nontext_cursor);
736 x->nontext_cursor = nontext_cursor;
738 if (hourglass_cursor != x->hourglass_cursor
739 && x->hourglass_cursor != 0)
740 XFreeCursor (dpy, x->hourglass_cursor);
741 x->hourglass_cursor = hourglass_cursor;
743 if (mode_cursor != x->modeline_cursor
744 && x->modeline_cursor != 0)
745 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
746 x->modeline_cursor = mode_cursor;
748 if (hand_cursor != x->hand_cursor
749 && x->hand_cursor != 0)
750 XFreeCursor (dpy, x->hand_cursor);
751 x->hand_cursor = hand_cursor;
753 if (horizontal_drag_cursor != x->horizontal_drag_cursor
754 && x->horizontal_drag_cursor != 0)
755 XFreeCursor (dpy, x->horizontal_drag_cursor);
756 x->horizontal_drag_cursor = horizontal_drag_cursor;
758 if (vertical_drag_cursor != x->vertical_drag_cursor
759 && x->vertical_drag_cursor != 0)
760 XFreeCursor (dpy, x->vertical_drag_cursor);
761 x->vertical_drag_cursor = vertical_drag_cursor;
763 XFlush (dpy);
764 unblock_input ();
766 update_face_from_frame_parameter (f, Qmouse_color, arg);
769 static void
770 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
772 unsigned long fore_pixel, pixel;
773 bool fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
774 struct x_output *x = f->output_data.x;
776 if (!NILP (Vx_cursor_fore_pixel))
778 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
779 WHITE_PIX_DEFAULT (f));
780 fore_pixel_allocated_p = 1;
782 else
783 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
785 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
786 pixel_allocated_p = 1;
788 /* Make sure that the cursor color differs from the background color. */
789 if (pixel == FRAME_BACKGROUND_PIXEL (f))
791 if (pixel_allocated_p)
793 x_free_colors (f, &pixel, 1);
794 pixel_allocated_p = 0;
797 pixel = x->mouse_pixel;
798 if (pixel == fore_pixel)
800 if (fore_pixel_allocated_p)
802 x_free_colors (f, &fore_pixel, 1);
803 fore_pixel_allocated_p = 0;
805 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
809 unload_color (f, x->cursor_foreground_pixel);
810 if (!fore_pixel_allocated_p)
811 fore_pixel = x_copy_color (f, fore_pixel);
812 x->cursor_foreground_pixel = fore_pixel;
814 unload_color (f, x->cursor_pixel);
815 if (!pixel_allocated_p)
816 pixel = x_copy_color (f, pixel);
817 x->cursor_pixel = pixel;
819 if (FRAME_X_WINDOW (f) != 0)
821 block_input ();
822 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
823 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
824 unblock_input ();
826 if (FRAME_VISIBLE_P (f))
828 x_update_cursor (f, 0);
829 x_update_cursor (f, 1);
833 update_face_from_frame_parameter (f, Qcursor_color, arg);
836 /* Set the border-color of frame F to pixel value PIX.
837 Note that this does not fully take effect if done before
838 F has an x-window. */
840 static void
841 x_set_border_pixel (struct frame *f, int pix)
843 unload_color (f, f->output_data.x->border_pixel);
844 f->output_data.x->border_pixel = pix;
846 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
848 block_input ();
849 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), pix);
850 unblock_input ();
852 if (FRAME_VISIBLE_P (f))
853 redraw_frame (f);
857 /* Set the border-color of frame F to value described by ARG.
858 ARG can be a string naming a color.
859 The border-color is used for the border that is drawn by the X server.
860 Note that this does not fully take effect if done before
861 F has an x-window; it must be redone when the window is created.
863 Note: this is done in two routines because of the way X10 works.
865 Note: under X11, this is normally the province of the window manager,
866 and so emacs's border colors may be overridden. */
868 static void
869 x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
871 int pix;
873 CHECK_STRING (arg);
874 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
875 x_set_border_pixel (f, pix);
876 update_face_from_frame_parameter (f, Qborder_color, arg);
880 static void
881 x_set_cursor_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
883 set_frame_cursor_types (f, arg);
886 static void
887 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
889 int result;
891 if (STRINGP (arg))
893 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
894 return;
896 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
897 return;
899 block_input ();
900 if (NILP (arg))
901 result = x_text_icon (f,
902 SSDATA ((!NILP (f->icon_name)
903 ? f->icon_name
904 : f->name)));
905 else
906 result = x_bitmap_icon (f, arg);
908 if (result)
910 unblock_input ();
911 error ("No icon window available");
914 XFlush (FRAME_X_DISPLAY (f));
915 unblock_input ();
918 static void
919 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
921 int result;
923 if (STRINGP (arg))
925 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
926 return;
928 else if (!NILP (arg) || NILP (oldval))
929 return;
931 fset_icon_name (f, arg);
933 if (f->output_data.x->icon_bitmap != 0)
934 return;
936 block_input ();
938 result = x_text_icon (f,
939 SSDATA ((!NILP (f->icon_name)
940 ? f->icon_name
941 : !NILP (f->title)
942 ? f->title
943 : f->name)));
945 if (result)
947 unblock_input ();
948 error ("No icon window available");
951 XFlush (FRAME_X_DISPLAY (f));
952 unblock_input ();
956 void
957 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
959 int nlines;
960 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
961 int olines = FRAME_MENU_BAR_LINES (f);
962 #endif
964 /* Right now, menu bars don't work properly in minibuf-only frames;
965 most of the commands try to apply themselves to the minibuffer
966 frame itself, and get an error because you can't switch buffers
967 in or split the minibuffer window. */
968 if (FRAME_MINIBUF_ONLY_P (f))
969 return;
971 if (TYPE_RANGED_INTEGERP (int, value))
972 nlines = XINT (value);
973 else
974 nlines = 0;
976 /* Make sure we redisplay all windows in this frame. */
977 windows_or_buffers_changed = 59;
979 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
980 FRAME_MENU_BAR_LINES (f) = 0;
981 FRAME_MENU_BAR_HEIGHT (f) = 0;
982 if (nlines)
984 FRAME_EXTERNAL_MENU_BAR (f) = 1;
985 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
986 /* Make sure next redisplay shows the menu bar. */
987 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = 1;
989 else
991 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
992 free_frame_menubar (f);
993 FRAME_EXTERNAL_MENU_BAR (f) = 0;
994 if (FRAME_X_P (f))
995 f->output_data.x->menubar_widget = 0;
997 #else /* not USE_X_TOOLKIT && not USE_GTK */
998 FRAME_MENU_BAR_LINES (f) = nlines;
999 FRAME_MENU_BAR_HEIGHT (f) = nlines * FRAME_LINE_HEIGHT (f);
1000 resize_frame_windows (f, FRAME_TEXT_HEIGHT (f), 0, 1);
1002 /* If the menu bar height gets changed, the internal border below
1003 the top margin has to be cleared. Also, if the menu bar gets
1004 larger, the area for the added lines has to be cleared except for
1005 the first menu bar line that is to be drawn later. */
1006 if (nlines != olines)
1008 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1009 int width = FRAME_PIXEL_WIDTH (f);
1010 int y;
1012 /* height can be zero here. */
1013 if (FRAME_X_WINDOW (f) && height > 0 && width > 0)
1015 y = FRAME_TOP_MARGIN_HEIGHT (f);
1017 block_input ();
1018 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1019 0, y, width, height);
1020 unblock_input ();
1023 if (nlines > 1 && nlines > olines)
1025 y = (olines == 0 ? 1 : olines) * FRAME_LINE_HEIGHT (f);
1026 height = nlines * FRAME_LINE_HEIGHT (f) - y;
1028 block_input ();
1029 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1030 0, y, width, height);
1031 unblock_input ();
1034 if (nlines == 0 && WINDOWP (f->menu_bar_window))
1035 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1037 #endif /* not USE_X_TOOLKIT && not USE_GTK */
1038 adjust_frame_glyphs (f);
1039 run_window_configuration_change_hook (f);
1043 /* Set the number of lines used for the tool bar of frame F to VALUE.
1044 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1045 is the old number of tool bar lines. This function changes the
1046 height of all windows on frame F to match the new tool bar height.
1047 The frame's height doesn't change. */
1049 void
1050 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1052 int nlines;
1053 #if ! defined (USE_GTK)
1054 int delta, root_height;
1055 int unit = FRAME_LINE_HEIGHT (f);
1056 #endif
1058 /* Treat tool bars like menu bars. */
1059 if (FRAME_MINIBUF_ONLY_P (f))
1060 return;
1062 /* Use VALUE only if an int >= 0. */
1063 if (RANGED_INTEGERP (0, value, INT_MAX))
1064 nlines = XFASTINT (value);
1065 else
1066 nlines = 0;
1068 #ifdef USE_GTK
1070 FRAME_TOOL_BAR_LINES (f) = 0;
1071 FRAME_TOOL_BAR_HEIGHT (f) = 0;
1072 if (nlines)
1074 FRAME_EXTERNAL_TOOL_BAR (f) = 1;
1075 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1076 /* Make sure next redisplay shows the tool bar. */
1077 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = 1;
1078 update_frame_tool_bar (f);
1080 else
1082 if (FRAME_EXTERNAL_TOOL_BAR (f))
1083 free_frame_tool_bar (f);
1084 FRAME_EXTERNAL_TOOL_BAR (f) = 0;
1087 #else /* !USE_GTK */
1089 /* Make sure we redisplay all windows in this frame. */
1090 windows_or_buffers_changed = 60;
1092 /* DELTA is in pixels now. */
1093 delta = (nlines - FRAME_TOOL_BAR_LINES (f)) * unit;
1095 /* Don't resize the tool-bar to more than we have room for. Note: The
1096 calculations below and the subsequent call to resize_frame_windows
1097 are inherently flawed because they can make the toolbar higher than
1098 the containing frame. */
1099 if (delta > 0)
1101 root_height = WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f)));
1102 if (root_height - delta < unit)
1104 delta = root_height - unit;
1105 /* When creating a new frame and toolbar mode is enabled, we
1106 need at least one toolbar line. */
1107 nlines = max (FRAME_TOOL_BAR_LINES (f) + delta / unit, 1);
1111 FRAME_TOOL_BAR_LINES (f) = nlines;
1112 FRAME_TOOL_BAR_HEIGHT (f) = nlines * FRAME_LINE_HEIGHT (f);
1113 ++windows_or_buffers_changed;
1114 resize_frame_windows (f, FRAME_TEXT_HEIGHT (f), 0, 1);
1115 adjust_frame_glyphs (f);
1117 /* We also have to make sure that the internal border at the top of
1118 the frame, below the menu bar or tool bar, is redrawn when the
1119 tool bar disappears. This is so because the internal border is
1120 below the tool bar if one is displayed, but is below the menu bar
1121 if there isn't a tool bar. The tool bar draws into the area
1122 below the menu bar. */
1123 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_HEIGHT (f) == 0)
1125 clear_frame (f);
1126 clear_current_matrices (f);
1129 /* If the tool bar gets smaller, the internal border below it
1130 has to be cleared. It was formerly part of the display
1131 of the larger tool bar, and updating windows won't clear it. */
1132 if (delta < 0)
1134 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1135 int width = FRAME_PIXEL_WIDTH (f);
1136 int y = nlines * unit;
1138 /* height can be zero here. */
1139 if (height > 0 && width > 0)
1141 block_input ();
1142 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1143 0, y, width, height);
1144 unblock_input ();
1147 if (WINDOWP (f->tool_bar_window))
1148 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1151 run_window_configuration_change_hook (f);
1152 #endif /* USE_GTK */
1156 /* Set the foreground color for scroll bars on frame F to VALUE.
1157 VALUE should be a string, a color name. If it isn't a string or
1158 isn't a valid color name, do nothing. OLDVAL is the old value of
1159 the frame parameter. */
1161 static void
1162 x_set_scroll_bar_foreground (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1164 unsigned long pixel;
1166 if (STRINGP (value))
1167 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1168 else
1169 pixel = -1;
1171 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1172 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1174 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1175 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1177 /* Remove all scroll bars because they have wrong colors. */
1178 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1179 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1180 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1181 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1183 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1184 redraw_frame (f);
1189 /* Set the background color for scroll bars on frame F to VALUE VALUE
1190 should be a string, a color name. If it isn't a string or isn't a
1191 valid color name, do nothing. OLDVAL is the old value of the frame
1192 parameter. */
1194 static void
1195 x_set_scroll_bar_background (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1197 unsigned long pixel;
1199 if (STRINGP (value))
1200 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1201 else
1202 pixel = -1;
1204 if (f->output_data.x->scroll_bar_background_pixel != -1)
1205 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1207 #ifdef USE_TOOLKIT_SCROLL_BARS
1208 /* Scrollbar shadow colors. */
1209 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1211 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1212 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1214 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1216 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1217 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1219 #endif /* USE_TOOLKIT_SCROLL_BARS */
1221 f->output_data.x->scroll_bar_background_pixel = pixel;
1222 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1224 /* Remove all scroll bars because they have wrong colors. */
1225 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1226 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1227 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1228 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1230 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1231 redraw_frame (f);
1236 /* Encode Lisp string STRING as a text in a format appropriate for
1237 XICCC (X Inter Client Communication Conventions).
1239 This can call Lisp code, so callers must GCPRO.
1241 If STRING contains only ASCII characters, do no conversion and
1242 return the string data of STRING. Otherwise, encode the text by
1243 CODING_SYSTEM, and return a newly allocated memory area which
1244 should be freed by `xfree' by a caller.
1246 SELECTIONP non-zero means the string is being encoded for an X
1247 selection, so it is safe to run pre-write conversions (which
1248 may run Lisp code).
1250 Store the byte length of resulting text in *TEXT_BYTES.
1252 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1253 which means that the `encoding' of the result can be `STRING'.
1254 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1255 the result should be `COMPOUND_TEXT'. */
1257 static unsigned char *
1258 x_encode_text (Lisp_Object string, Lisp_Object coding_system, int selectionp,
1259 ptrdiff_t *text_bytes, int *stringp, int *freep)
1261 int result = string_xstring_p (string);
1262 struct coding_system coding;
1264 if (result == 0)
1266 /* No multibyte character in OBJ. We need not encode it. */
1267 *text_bytes = SBYTES (string);
1268 *stringp = 1;
1269 *freep = 0;
1270 return SDATA (string);
1273 setup_coding_system (coding_system, &coding);
1274 coding.mode |= (CODING_MODE_SAFE_ENCODING | CODING_MODE_LAST_BLOCK);
1275 /* We suppress producing escape sequences for composition. */
1276 coding.common_flags &= ~CODING_ANNOTATION_MASK;
1277 coding.destination = xnmalloc (SCHARS (string), 2);
1278 coding.dst_bytes = SCHARS (string) * 2;
1279 encode_coding_object (&coding, string, 0, 0,
1280 SCHARS (string), SBYTES (string), Qnil);
1281 *text_bytes = coding.produced;
1282 *stringp = (result == 1 || !EQ (coding_system, Qcompound_text));
1283 *freep = 1;
1284 return coding.destination;
1288 /* Set the WM name to NAME for frame F. Also set the icon name.
1289 If the frame already has an icon name, use that, otherwise set the
1290 icon name to NAME. */
1292 static void
1293 x_set_name_internal (struct frame *f, Lisp_Object name)
1295 if (FRAME_X_WINDOW (f))
1297 block_input ();
1299 XTextProperty text, icon;
1300 ptrdiff_t bytes;
1301 int stringp;
1302 int do_free_icon_value = 0, do_free_text_value = 0;
1303 Lisp_Object coding_system;
1304 Lisp_Object encoded_name;
1305 Lisp_Object encoded_icon_name;
1306 struct gcpro gcpro1;
1308 /* As ENCODE_UTF_8 may cause GC and relocation of string data,
1309 we use it before x_encode_text that may return string data. */
1310 GCPRO1 (name);
1311 encoded_name = ENCODE_UTF_8 (name);
1312 UNGCPRO;
1314 coding_system = Qcompound_text;
1315 /* Note: Encoding strategy
1317 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1318 text.encoding. But, there are non-internationalized window
1319 managers which don't support that encoding. So, if NAME
1320 contains only ASCII and 8859-1 characters, encode it by
1321 iso-latin-1, and use "STRING" in text.encoding hoping that
1322 such window managers at least analyze this format correctly,
1323 i.e. treat 8-bit bytes as 8859-1 characters.
1325 We may also be able to use "UTF8_STRING" in text.encoding
1326 in the future which can encode all Unicode characters.
1327 But, for the moment, there's no way to know that the
1328 current window manager supports it or not.
1330 Either way, we also set the _NET_WM_NAME and _NET_WM_ICON_NAME
1331 properties. Per the EWMH specification, those two properties
1332 are always UTF8_STRING. This matches what gtk_window_set_title()
1333 does in the USE_GTK case. */
1334 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1335 &do_free_text_value);
1336 text.encoding = (stringp ? XA_STRING
1337 : FRAME_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1338 text.format = 8;
1339 text.nitems = bytes;
1340 if (text.nitems != bytes)
1341 error ("Window name too large");
1343 if (!STRINGP (f->icon_name))
1345 icon = text;
1346 encoded_icon_name = encoded_name;
1348 else
1350 /* See the above comment "Note: Encoding strategy". */
1351 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1352 &bytes, &stringp, &do_free_icon_value);
1353 icon.encoding = (stringp ? XA_STRING
1354 : FRAME_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1355 icon.format = 8;
1356 icon.nitems = bytes;
1357 if (icon.nitems != bytes)
1358 error ("Icon name too large");
1360 encoded_icon_name = ENCODE_UTF_8 (f->icon_name);
1363 #ifdef USE_GTK
1364 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1365 SSDATA (encoded_name));
1366 #else /* not USE_GTK */
1367 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1368 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1369 FRAME_DISPLAY_INFO (f)->Xatom_net_wm_name,
1370 FRAME_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1371 8, PropModeReplace,
1372 SDATA (encoded_name),
1373 SBYTES (encoded_name));
1374 #endif /* not USE_GTK */
1376 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1377 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1378 FRAME_DISPLAY_INFO (f)->Xatom_net_wm_icon_name,
1379 FRAME_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1380 8, PropModeReplace,
1381 SDATA (encoded_icon_name),
1382 SBYTES (encoded_icon_name));
1384 if (do_free_icon_value)
1385 xfree (icon.value);
1386 if (do_free_text_value)
1387 xfree (text.value);
1389 unblock_input ();
1393 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1394 x_id_name.
1396 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1397 name; if NAME is a string, set F's name to NAME and set
1398 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1400 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1401 suggesting a new name, which lisp code should override; if
1402 F->explicit_name is set, ignore the new name; otherwise, set it. */
1404 static void
1405 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1407 /* Make sure that requests from lisp code override requests from
1408 Emacs redisplay code. */
1409 if (explicit)
1411 /* If we're switching from explicit to implicit, we had better
1412 update the mode lines and thereby update the title. */
1413 if (f->explicit_name && NILP (name))
1414 update_mode_lines = 37;
1416 f->explicit_name = ! NILP (name);
1418 else if (f->explicit_name)
1419 return;
1421 /* If NAME is nil, set the name to the x_id_name. */
1422 if (NILP (name))
1424 /* Check for no change needed in this very common case
1425 before we do any consing. */
1426 if (!strcmp (FRAME_DISPLAY_INFO (f)->x_id_name,
1427 SSDATA (f->name)))
1428 return;
1429 name = build_string (FRAME_DISPLAY_INFO (f)->x_id_name);
1431 else
1432 CHECK_STRING (name);
1434 /* Don't change the name if it's already NAME. */
1435 if (! NILP (Fstring_equal (name, f->name)))
1436 return;
1438 fset_name (f, name);
1440 /* For setting the frame title, the title parameter should override
1441 the name parameter. */
1442 if (! NILP (f->title))
1443 name = f->title;
1445 x_set_name_internal (f, name);
1448 /* This function should be called when the user's lisp code has
1449 specified a name for the frame; the name will override any set by the
1450 redisplay code. */
1451 static void
1452 x_explicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1454 x_set_name (f, arg, 1);
1457 /* This function should be called by Emacs redisplay code to set the
1458 name; names set this way will never override names set by the user's
1459 lisp code. */
1460 void
1461 x_implicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1463 x_set_name (f, arg, 0);
1466 /* Change the title of frame F to NAME.
1467 If NAME is nil, use the frame name as the title. */
1469 static void
1470 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1472 /* Don't change the title if it's already NAME. */
1473 if (EQ (name, f->title))
1474 return;
1476 update_mode_lines = 38;
1478 fset_title (f, name);
1480 if (NILP (name))
1481 name = f->name;
1482 else
1483 CHECK_STRING (name);
1485 x_set_name_internal (f, name);
1488 void
1489 x_set_scroll_bar_default_width (struct frame *f)
1491 int unit = FRAME_COLUMN_WIDTH (f);
1492 #ifdef USE_TOOLKIT_SCROLL_BARS
1493 #ifdef USE_GTK
1494 int minw = xg_get_default_scrollbar_width ();
1495 #else
1496 int minw = 16;
1497 #endif
1498 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1499 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (minw + unit - 1) / unit;
1500 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = minw;
1501 #else
1502 /* The width of a non-toolkit scrollbar is at least 14 pixels and a
1503 multiple of the frame's character width. */
1504 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + unit - 1) / unit;
1505 FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
1506 = FRAME_CONFIG_SCROLL_BAR_COLS (f) * unit;
1507 #endif
1511 /* Record in frame F the specified or default value according to ALIST
1512 of the parameter named PROP (a Lisp symbol). If no value is
1513 specified for PROP, look for an X default for XPROP on the frame
1514 named NAME. If that is not found either, use the value DEFLT. */
1516 static Lisp_Object
1517 x_default_scroll_bar_color_parameter (struct frame *f,
1518 Lisp_Object alist, Lisp_Object prop,
1519 const char *xprop, const char *xclass,
1520 int foreground_p)
1522 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
1523 Lisp_Object tem;
1525 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1526 if (EQ (tem, Qunbound))
1528 #ifdef USE_TOOLKIT_SCROLL_BARS
1530 /* See if an X resource for the scroll bar color has been
1531 specified. */
1532 tem = display_x_get_resource (dpyinfo,
1533 build_string (foreground_p
1534 ? "foreground"
1535 : "background"),
1536 empty_unibyte_string,
1537 build_string ("verticalScrollBar"),
1538 empty_unibyte_string);
1539 if (!STRINGP (tem))
1541 /* If nothing has been specified, scroll bars will use a
1542 toolkit-dependent default. Because these defaults are
1543 difficult to get at without actually creating a scroll
1544 bar, use nil to indicate that no color has been
1545 specified. */
1546 tem = Qnil;
1549 #else /* not USE_TOOLKIT_SCROLL_BARS */
1551 tem = Qnil;
1553 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1556 x_set_frame_parameters (f, list1 (Fcons (prop, tem)));
1557 return tem;
1563 #ifdef USE_X_TOOLKIT
1565 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1566 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1567 already be present because of the toolkit (Motif adds some of them,
1568 for example, but Xt doesn't). */
1570 static void
1571 hack_wm_protocols (struct frame *f, Widget widget)
1573 Display *dpy = XtDisplay (widget);
1574 Window w = XtWindow (widget);
1575 int need_delete = 1;
1576 int need_focus = 1;
1577 int need_save = 1;
1579 block_input ();
1581 Atom type;
1582 unsigned char *catoms;
1583 int format = 0;
1584 unsigned long nitems = 0;
1585 unsigned long bytes_after;
1587 if ((XGetWindowProperty (dpy, w,
1588 FRAME_DISPLAY_INFO (f)->Xatom_wm_protocols,
1589 (long)0, (long)100, False, XA_ATOM,
1590 &type, &format, &nitems, &bytes_after,
1591 &catoms)
1592 == Success)
1593 && format == 32 && type == XA_ATOM)
1595 Atom *atoms = (Atom *) catoms;
1596 while (nitems > 0)
1598 nitems--;
1599 if (atoms[nitems]
1600 == FRAME_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1601 need_delete = 0;
1602 else if (atoms[nitems]
1603 == FRAME_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1604 need_focus = 0;
1605 else if (atoms[nitems]
1606 == FRAME_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1607 need_save = 0;
1610 if (catoms)
1611 XFree (catoms);
1614 Atom props [10];
1615 int count = 0;
1616 if (need_delete)
1617 props[count++] = FRAME_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1618 if (need_focus)
1619 props[count++] = FRAME_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1620 if (need_save)
1621 props[count++] = FRAME_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1622 if (count)
1623 XChangeProperty (dpy, w, FRAME_DISPLAY_INFO (f)->Xatom_wm_protocols,
1624 XA_ATOM, 32, PropModeAppend,
1625 (unsigned char *) props, count);
1627 unblock_input ();
1629 #endif
1633 /* Support routines for XIC (X Input Context). */
1635 #ifdef HAVE_X_I18N
1637 static XFontSet xic_create_xfontset (struct frame *);
1638 static XIMStyle best_xim_style (XIMStyles *, XIMStyles *);
1641 /* Supported XIM styles, ordered by preference. */
1643 static XIMStyle supported_xim_styles[] =
1645 XIMPreeditPosition | XIMStatusArea,
1646 XIMPreeditPosition | XIMStatusNothing,
1647 XIMPreeditPosition | XIMStatusNone,
1648 XIMPreeditNothing | XIMStatusArea,
1649 XIMPreeditNothing | XIMStatusNothing,
1650 XIMPreeditNothing | XIMStatusNone,
1651 XIMPreeditNone | XIMStatusArea,
1652 XIMPreeditNone | XIMStatusNothing,
1653 XIMPreeditNone | XIMStatusNone,
1658 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1659 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1661 static const char xic_default_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1663 /* Create an Xt fontset spec from the name of a base font.
1664 If `motif' is True use the Motif syntax. */
1665 char *
1666 xic_create_fontsetname (const char *base_fontname, int motif)
1668 const char *sep = motif ? ";" : ",";
1669 char *fontsetname;
1671 /* Make a fontset name from the base font name. */
1672 if (xic_default_fontset == base_fontname)
1674 /* There is no base font name, use the default. */
1675 fontsetname = xmalloc (strlen (base_fontname) + 2);
1676 strcpy (fontsetname, base_fontname);
1678 else
1680 /* Make a fontset name from the base font name.
1681 The font set will be made of the following elements:
1682 - the base font.
1683 - the base font where the charset spec is replaced by -*-*.
1684 - the same but with the family also replaced with -*-*-. */
1685 const char *p = base_fontname;
1686 ptrdiff_t i;
1688 for (i = 0; *p; p++)
1689 if (*p == '-') i++;
1690 if (i != 14)
1692 /* As the font name doesn't conform to XLFD, we can't
1693 modify it to generalize it to allcs and allfamilies.
1694 Use the specified font plus the default. */
1695 fontsetname = xmalloc (strlen (base_fontname)
1696 + strlen (xic_default_fontset) + 3);
1697 strcpy (fontsetname, base_fontname);
1698 strcat (fontsetname, sep);
1699 strcat (fontsetname, xic_default_fontset);
1701 else
1703 ptrdiff_t len;
1704 const char *p1 = NULL, *p2 = NULL, *p3 = NULL;
1705 char *font_allcs = NULL;
1706 char *font_allfamilies = NULL;
1707 char *font_all = NULL;
1708 const char *allcs = "*-*-*-*-*-*-*";
1709 const char *allfamilies = "-*-*-";
1710 const char *all = "*-*-*-*-";
1711 char *base;
1713 for (i = 0, p = base_fontname; i < 8; p++)
1715 if (*p == '-')
1717 i++;
1718 if (i == 3)
1719 p1 = p + 1;
1720 else if (i == 7)
1721 p2 = p + 1;
1722 else if (i == 6)
1723 p3 = p + 1;
1726 /* If base_fontname specifies ADSTYLE, make it a
1727 wildcard. */
1728 if (*p3 != '*')
1730 ptrdiff_t diff = (p2 - p3) - 2;
1732 base = alloca (strlen (base_fontname) + 1);
1733 memcpy (base, base_fontname, p3 - base_fontname);
1734 base[p3 - base_fontname] = '*';
1735 base[(p3 - base_fontname) + 1] = '-';
1736 strcpy (base + (p3 - base_fontname) + 2, p2);
1737 p = base + (p - base_fontname) - diff;
1738 p1 = base + (p1 - base_fontname);
1739 p2 = base + (p2 - base_fontname) - diff;
1740 base_fontname = base;
1743 /* Build the font spec that matches all charsets. */
1744 len = p - base_fontname + strlen (allcs) + 1;
1745 font_allcs = alloca (len);
1746 memcpy (font_allcs, base_fontname, p - base_fontname);
1747 strcat (font_allcs, allcs);
1749 /* Build the font spec that matches all families and
1750 add-styles. */
1751 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
1752 font_allfamilies = alloca (len);
1753 strcpy (font_allfamilies, allfamilies);
1754 memcpy (font_allfamilies + strlen (allfamilies), p1, p - p1);
1755 strcat (font_allfamilies, allcs);
1757 /* Build the font spec that matches all. */
1758 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
1759 font_all = alloca (len);
1760 strcpy (font_all, allfamilies);
1761 strcat (font_all, all);
1762 memcpy (font_all + strlen (all) + strlen (allfamilies), p2, p - p2);
1763 strcat (font_all, allcs);
1765 /* Build the actual font set name. */
1766 len = strlen (base_fontname) + strlen (font_allcs)
1767 + strlen (font_allfamilies) + strlen (font_all) + 5;
1768 fontsetname = xmalloc (len);
1769 strcpy (fontsetname, base_fontname);
1770 strcat (fontsetname, sep);
1771 strcat (fontsetname, font_allcs);
1772 strcat (fontsetname, sep);
1773 strcat (fontsetname, font_allfamilies);
1774 strcat (fontsetname, sep);
1775 strcat (fontsetname, font_all);
1778 if (motif)
1779 return strcat (fontsetname, ":");
1780 return fontsetname;
1782 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
1784 #ifdef DEBUG_XIC_FONTSET
1785 static void
1786 print_fontset_result (XFontSet xfs, char *name, char **missing_list,
1787 int missing_count)
1789 if (xfs)
1790 fprintf (stderr, "XIC Fontset created: %s\n", name);
1791 else
1793 fprintf (stderr, "XIC Fontset failed: %s\n", name);
1794 while (missing_count-- > 0)
1796 fprintf (stderr, " missing: %s\n", *missing_list);
1797 missing_list++;
1802 #endif
1804 static XFontSet
1805 xic_create_xfontset (struct frame *f)
1807 XFontSet xfs = NULL;
1808 struct font *font = FRAME_FONT (f);
1809 int pixel_size = font->pixel_size;
1810 Lisp_Object rest, frame;
1812 /* See if there is another frame already using same fontset. */
1813 FOR_EACH_FRAME (rest, frame)
1815 struct frame *cf = XFRAME (frame);
1817 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
1818 && FRAME_DISPLAY_INFO (cf) == FRAME_DISPLAY_INFO (f)
1819 && FRAME_FONT (f)
1820 && FRAME_FONT (f)->pixel_size == pixel_size)
1822 xfs = FRAME_XIC_FONTSET (cf);
1823 break;
1827 if (! xfs)
1829 char buf[256];
1830 char **missing_list;
1831 int missing_count;
1832 char *def_string;
1833 const char *xlfd_format = "-*-*-medium-r-normal--%d-*-*-*-*-*";
1835 sprintf (buf, xlfd_format, pixel_size);
1836 missing_list = NULL;
1837 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
1838 &missing_list, &missing_count, &def_string);
1839 #ifdef DEBUG_XIC_FONTSET
1840 print_fontset_result (xfs, buf, missing_list, missing_count);
1841 #endif
1842 if (missing_list)
1843 XFreeStringList (missing_list);
1844 if (! xfs)
1846 /* List of pixel sizes most likely available. Find one that
1847 is closest to pixel_size. */
1848 int sizes[] = {0, 8, 10, 11, 12, 14, 17, 18, 20, 24, 26, 34, 0};
1849 int *smaller, *larger;
1851 for (smaller = sizes; smaller[1]; smaller++)
1852 if (smaller[1] >= pixel_size)
1853 break;
1854 larger = smaller + 1;
1855 if (*larger == pixel_size)
1856 larger++;
1857 while (*smaller || *larger)
1859 int this_size;
1861 if (! *larger)
1862 this_size = *smaller--;
1863 else if (! *smaller)
1864 this_size = *larger++;
1865 else if (pixel_size - *smaller < *larger - pixel_size)
1866 this_size = *smaller--;
1867 else
1868 this_size = *larger++;
1869 sprintf (buf, xlfd_format, this_size);
1870 missing_list = NULL;
1871 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
1872 &missing_list, &missing_count, &def_string);
1873 #ifdef DEBUG_XIC_FONTSET
1874 print_fontset_result (xfs, buf, missing_list, missing_count);
1875 #endif
1876 if (missing_list)
1877 XFreeStringList (missing_list);
1878 if (xfs)
1879 break;
1882 if (! xfs)
1884 const char *last_resort = "-*-*-*-r-normal--*-*-*-*-*-*";
1886 missing_list = NULL;
1887 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), last_resort,
1888 &missing_list, &missing_count, &def_string);
1889 #ifdef DEBUG_XIC_FONTSET
1890 print_fontset_result (xfs, last_resort, missing_list, missing_count);
1891 #endif
1892 if (missing_list)
1893 XFreeStringList (missing_list);
1898 return xfs;
1901 /* Free the X fontset of frame F if it is the last frame using it. */
1903 void
1904 xic_free_xfontset (struct frame *f)
1906 Lisp_Object rest, frame;
1907 bool shared_p = 0;
1909 if (!FRAME_XIC_FONTSET (f))
1910 return;
1912 /* See if there is another frame sharing the same fontset. */
1913 FOR_EACH_FRAME (rest, frame)
1915 struct frame *cf = XFRAME (frame);
1916 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
1917 && FRAME_DISPLAY_INFO (cf) == FRAME_DISPLAY_INFO (f)
1918 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
1920 shared_p = 1;
1921 break;
1925 if (!shared_p)
1926 /* The fontset is not used anymore. It is safe to free it. */
1927 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
1929 FRAME_XIC_FONTSET (f) = NULL;
1933 /* Value is the best input style, given user preferences USER (already
1934 checked to be supported by Emacs), and styles supported by the
1935 input method XIM. */
1937 static XIMStyle
1938 best_xim_style (XIMStyles *user, XIMStyles *xim)
1940 int i, j;
1942 for (i = 0; i < user->count_styles; ++i)
1943 for (j = 0; j < xim->count_styles; ++j)
1944 if (user->supported_styles[i] == xim->supported_styles[j])
1945 return user->supported_styles[i];
1947 /* Return the default style. */
1948 return XIMPreeditNothing | XIMStatusNothing;
1951 /* Create XIC for frame F. */
1953 static XIMStyle xic_style;
1955 void
1956 create_frame_xic (struct frame *f)
1958 XIM xim;
1959 XIC xic = NULL;
1960 XFontSet xfs = NULL;
1962 if (FRAME_XIC (f))
1963 return;
1965 /* Create X fontset. */
1966 xfs = xic_create_xfontset (f);
1967 xim = FRAME_X_XIM (f);
1968 if (xim)
1970 XRectangle s_area;
1971 XPoint spot;
1972 XVaNestedList preedit_attr;
1973 XVaNestedList status_attr;
1975 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
1976 spot.x = 0; spot.y = 1;
1978 /* Determine XIC style. */
1979 if (xic_style == 0)
1981 XIMStyles supported_list;
1982 supported_list.count_styles = (sizeof supported_xim_styles
1983 / sizeof supported_xim_styles[0]);
1984 supported_list.supported_styles = supported_xim_styles;
1985 xic_style = best_xim_style (&supported_list,
1986 FRAME_X_XIM_STYLES (f));
1989 preedit_attr = XVaCreateNestedList (0,
1990 XNFontSet, xfs,
1991 XNForeground,
1992 FRAME_FOREGROUND_PIXEL (f),
1993 XNBackground,
1994 FRAME_BACKGROUND_PIXEL (f),
1995 (xic_style & XIMPreeditPosition
1996 ? XNSpotLocation
1997 : NULL),
1998 &spot,
1999 NULL);
2000 status_attr = XVaCreateNestedList (0,
2001 XNArea,
2002 &s_area,
2003 XNFontSet,
2004 xfs,
2005 XNForeground,
2006 FRAME_FOREGROUND_PIXEL (f),
2007 XNBackground,
2008 FRAME_BACKGROUND_PIXEL (f),
2009 NULL);
2011 xic = XCreateIC (xim,
2012 XNInputStyle, xic_style,
2013 XNClientWindow, FRAME_X_WINDOW (f),
2014 XNFocusWindow, FRAME_X_WINDOW (f),
2015 XNStatusAttributes, status_attr,
2016 XNPreeditAttributes, preedit_attr,
2017 NULL);
2018 XFree (preedit_attr);
2019 XFree (status_attr);
2022 FRAME_XIC (f) = xic;
2023 FRAME_XIC_STYLE (f) = xic_style;
2024 FRAME_XIC_FONTSET (f) = xfs;
2028 /* Destroy XIC and free XIC fontset of frame F, if any. */
2030 void
2031 free_frame_xic (struct frame *f)
2033 if (FRAME_XIC (f) == NULL)
2034 return;
2036 XDestroyIC (FRAME_XIC (f));
2037 xic_free_xfontset (f);
2039 FRAME_XIC (f) = NULL;
2043 /* Place preedit area for XIC of window W's frame to specified
2044 pixel position X/Y. X and Y are relative to window W. */
2046 void
2047 xic_set_preeditarea (struct window *w, int x, int y)
2049 struct frame *f = XFRAME (w->frame);
2050 XVaNestedList attr;
2051 XPoint spot;
2053 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2054 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2055 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2056 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2057 XFree (attr);
2061 /* Place status area for XIC in bottom right corner of frame F.. */
2063 void
2064 xic_set_statusarea (struct frame *f)
2066 XIC xic = FRAME_XIC (f);
2067 XVaNestedList attr;
2068 XRectangle area;
2069 XRectangle *needed;
2071 /* Negotiate geometry of status area. If input method has existing
2072 status area, use its current size. */
2073 area.x = area.y = area.width = area.height = 0;
2074 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2075 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2076 XFree (attr);
2078 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2079 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2080 XFree (attr);
2082 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2084 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2085 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2086 XFree (attr);
2089 area.width = needed->width;
2090 area.height = needed->height;
2091 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2092 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2093 - FRAME_MENUBAR_HEIGHT (f)
2094 - FRAME_TOOLBAR_TOP_HEIGHT (f)
2095 - FRAME_INTERNAL_BORDER_WIDTH (f));
2096 XFree (needed);
2098 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2099 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2100 XFree (attr);
2104 /* Set X fontset for XIC of frame F, using base font name
2105 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2107 void
2108 xic_set_xfontset (struct frame *f, const char *base_fontname)
2110 XVaNestedList attr;
2111 XFontSet xfs;
2113 xic_free_xfontset (f);
2115 xfs = xic_create_xfontset (f);
2117 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2118 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2119 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2120 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2121 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2122 XFree (attr);
2124 FRAME_XIC_FONTSET (f) = xfs;
2127 #endif /* HAVE_X_I18N */
2131 #ifdef USE_X_TOOLKIT
2133 /* Create and set up the X widget for frame F. */
2135 static void
2136 x_window (struct frame *f, long window_prompting, int minibuffer_only)
2138 XClassHint class_hints;
2139 XSetWindowAttributes attributes;
2140 unsigned long attribute_mask;
2141 Widget shell_widget;
2142 Widget pane_widget;
2143 Widget frame_widget;
2144 Arg al [25];
2145 int ac;
2147 block_input ();
2149 /* Use the resource name as the top-level widget name
2150 for looking up resources. Make a non-Lisp copy
2151 for the window manager, so GC relocation won't bother it.
2153 Elsewhere we specify the window name for the window manager. */
2154 f->namebuf = xstrdup (SSDATA (Vx_resource_name));
2156 ac = 0;
2157 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2158 XtSetArg (al[ac], XtNinput, 1); ac++;
2159 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2160 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2161 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2162 XtSetArg (al[ac], XtNdepth, FRAME_DISPLAY_INFO (f)->n_planes); ac++;
2163 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2164 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2165 applicationShellWidgetClass,
2166 FRAME_X_DISPLAY (f), al, ac);
2168 f->output_data.x->widget = shell_widget;
2169 /* maybe_set_screen_title_format (shell_widget); */
2171 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2172 NULL, shell_widget, False,
2173 NULL, NULL, NULL, NULL);
2175 ac = 0;
2176 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2177 XtSetArg (al[ac], XtNdepth, FRAME_DISPLAY_INFO (f)->n_planes); ac++;
2178 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2179 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2180 XtSetValues (pane_widget, al, ac);
2181 f->output_data.x->column_widget = pane_widget;
2183 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2184 the emacs screen when changing menubar. This reduces flickering. */
2186 ac = 0;
2187 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2188 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2189 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2190 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2191 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2192 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2193 XtSetArg (al[ac], XtNdepth, FRAME_DISPLAY_INFO (f)->n_planes); ac++;
2194 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2195 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2196 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2197 al, ac);
2199 f->output_data.x->edit_widget = frame_widget;
2201 XtManageChild (frame_widget);
2203 /* Do some needed geometry management. */
2205 char *tem, shell_position[sizeof "=x++" + 4 * INT_STRLEN_BOUND (int)];
2206 Arg gal[10];
2207 int gac = 0;
2208 int extra_borders = 0;
2209 int menubar_size
2210 = (f->output_data.x->menubar_widget
2211 ? (f->output_data.x->menubar_widget->core.height
2212 + f->output_data.x->menubar_widget->core.border_width)
2213 : 0);
2215 #if 0 /* Experimentally, we now get the right results
2216 for -geometry -0-0 without this. 24 Aug 96, rms. */
2217 if (FRAME_EXTERNAL_MENU_BAR (f))
2219 Dimension ibw = 0;
2220 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2221 menubar_size += ibw;
2223 #endif
2225 f->output_data.x->menubar_height = menubar_size;
2227 #ifndef USE_LUCID
2228 /* Motif seems to need this amount added to the sizes
2229 specified for the shell widget. The Athena/Lucid widgets don't.
2230 Both conclusions reached experimentally. -- rms. */
2231 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2232 &extra_borders, NULL);
2233 extra_borders *= 2;
2234 #endif
2236 /* Convert our geometry parameters into a geometry string
2237 and specify it.
2238 Note that we do not specify here whether the position
2239 is a user-specified or program-specified one.
2240 We pass that information later, in x_wm_set_size_hints. */
2242 int left = f->left_pos;
2243 int xneg = window_prompting & XNegative;
2244 int top = f->top_pos;
2245 int yneg = window_prompting & YNegative;
2246 if (xneg)
2247 left = -left;
2248 if (yneg)
2249 top = -top;
2251 if (window_prompting & USPosition)
2252 sprintf (shell_position, "=%dx%d%c%d%c%d",
2253 FRAME_PIXEL_WIDTH (f) + extra_borders,
2254 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2255 (xneg ? '-' : '+'), left,
2256 (yneg ? '-' : '+'), top);
2257 else
2259 sprintf (shell_position, "=%dx%d",
2260 FRAME_PIXEL_WIDTH (f) + extra_borders,
2261 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2263 /* Setting x and y when the position is not specified in
2264 the geometry string will set program position in the WM hints.
2265 If Emacs had just one program position, we could set it in
2266 fallback resources, but since each make-frame call can specify
2267 different program positions, this is easier. */
2268 XtSetArg (gal[gac], XtNx, left); gac++;
2269 XtSetArg (gal[gac], XtNy, top); gac++;
2273 /* We don't free this because we don't know whether
2274 it is safe to free it while the frame exists.
2275 It isn't worth the trouble of arranging to free it
2276 when the frame is deleted. */
2277 tem = xstrdup (shell_position);
2278 XtSetArg (gal[gac], XtNgeometry, tem); gac++;
2279 XtSetValues (shell_widget, gal, gac);
2282 XtManageChild (pane_widget);
2283 XtRealizeWidget (shell_widget);
2285 if (FRAME_X_EMBEDDED_P (f))
2286 XReparentWindow (FRAME_X_DISPLAY (f), XtWindow (shell_widget),
2287 f->output_data.x->parent_desc, 0, 0);
2289 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2291 validate_x_resource_name ();
2293 class_hints.res_name = SSDATA (Vx_resource_name);
2294 class_hints.res_class = SSDATA (Vx_resource_class);
2295 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2297 #ifdef HAVE_X_I18N
2298 FRAME_XIC (f) = NULL;
2299 if (use_xim)
2300 create_frame_xic (f);
2301 #endif
2303 f->output_data.x->wm_hints.input = True;
2304 f->output_data.x->wm_hints.flags |= InputHint;
2305 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2306 &f->output_data.x->wm_hints);
2308 hack_wm_protocols (f, shell_widget);
2310 #ifdef HACK_EDITRES
2311 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2312 #endif
2314 /* Do a stupid property change to force the server to generate a
2315 PropertyNotify event so that the event_stream server timestamp will
2316 be initialized to something relevant to the time we created the window.
2318 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2319 FRAME_DISPLAY_INFO (f)->Xatom_wm_protocols,
2320 XA_ATOM, 32, PropModeAppend, NULL, 0);
2322 /* Make all the standard events reach the Emacs frame. */
2323 attributes.event_mask = STANDARD_EVENT_SET;
2325 #ifdef HAVE_X_I18N
2326 if (FRAME_XIC (f))
2328 /* XIM server might require some X events. */
2329 unsigned long fevent = NoEventMask;
2330 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2331 attributes.event_mask |= fevent;
2333 #endif /* HAVE_X_I18N */
2335 attribute_mask = CWEventMask;
2336 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2337 attribute_mask, &attributes);
2339 XtMapWidget (frame_widget);
2341 /* x_set_name normally ignores requests to set the name if the
2342 requested name is the same as the current name. This is the one
2343 place where that assumption isn't correct; f->name is set, but
2344 the X server hasn't been told. */
2346 Lisp_Object name;
2347 int explicit = f->explicit_name;
2349 f->explicit_name = 0;
2350 name = f->name;
2351 fset_name (f, Qnil);
2352 x_set_name (f, name, explicit);
2355 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2356 f->output_data.x->current_cursor
2357 = f->output_data.x->text_cursor);
2359 unblock_input ();
2361 /* This is a no-op, except under Motif. Make sure main areas are
2362 set to something reasonable, in case we get an error later. */
2363 lw_set_main_areas (pane_widget, 0, frame_widget);
2366 #else /* not USE_X_TOOLKIT */
2367 #ifdef USE_GTK
2368 static void
2369 x_window (struct frame *f)
2371 if (! xg_create_frame_widgets (f))
2372 error ("Unable to create window");
2374 #ifdef HAVE_X_I18N
2375 FRAME_XIC (f) = NULL;
2376 if (use_xim)
2378 block_input ();
2379 create_frame_xic (f);
2380 if (FRAME_XIC (f))
2382 /* XIM server might require some X events. */
2383 unsigned long fevent = NoEventMask;
2384 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2386 if (fevent != NoEventMask)
2388 XSetWindowAttributes attributes;
2389 XWindowAttributes wattr;
2390 unsigned long attribute_mask;
2392 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2393 &wattr);
2394 attributes.event_mask = wattr.your_event_mask | fevent;
2395 attribute_mask = CWEventMask;
2396 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2397 attribute_mask, &attributes);
2400 unblock_input ();
2402 #endif
2405 #else /*! USE_GTK */
2406 /* Create and set up the X window for frame F. */
2408 static void
2409 x_window (struct frame *f)
2411 XClassHint class_hints;
2412 XSetWindowAttributes attributes;
2413 unsigned long attribute_mask;
2415 attributes.background_pixel = FRAME_BACKGROUND_PIXEL (f);
2416 attributes.border_pixel = f->output_data.x->border_pixel;
2417 attributes.bit_gravity = StaticGravity;
2418 attributes.backing_store = NotUseful;
2419 attributes.save_under = True;
2420 attributes.event_mask = STANDARD_EVENT_SET;
2421 attributes.colormap = FRAME_X_COLORMAP (f);
2422 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2423 | CWColormap);
2425 block_input ();
2426 FRAME_X_WINDOW (f)
2427 = XCreateWindow (FRAME_X_DISPLAY (f),
2428 f->output_data.x->parent_desc,
2429 f->left_pos,
2430 f->top_pos,
2431 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2432 f->border_width,
2433 CopyFromParent, /* depth */
2434 InputOutput, /* class */
2435 FRAME_X_VISUAL (f),
2436 attribute_mask, &attributes);
2438 #ifdef HAVE_X_I18N
2439 if (use_xim)
2441 create_frame_xic (f);
2442 if (FRAME_XIC (f))
2444 /* XIM server might require some X events. */
2445 unsigned long fevent = NoEventMask;
2446 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2447 attributes.event_mask |= fevent;
2448 attribute_mask = CWEventMask;
2449 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2450 attribute_mask, &attributes);
2453 #endif /* HAVE_X_I18N */
2455 validate_x_resource_name ();
2457 class_hints.res_name = SSDATA (Vx_resource_name);
2458 class_hints.res_class = SSDATA (Vx_resource_class);
2459 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2461 /* The menubar is part of the ordinary display;
2462 it does not count in addition to the height of the window. */
2463 f->output_data.x->menubar_height = 0;
2465 /* This indicates that we use the "Passive Input" input model.
2466 Unless we do this, we don't get the Focus{In,Out} events that we
2467 need to draw the cursor correctly. Accursed bureaucrats.
2468 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2470 f->output_data.x->wm_hints.input = True;
2471 f->output_data.x->wm_hints.flags |= InputHint;
2472 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2473 &f->output_data.x->wm_hints);
2474 f->output_data.x->wm_hints.icon_pixmap = None;
2476 /* Request "save yourself" and "delete window" commands from wm. */
2478 Atom protocols[2];
2479 protocols[0] = FRAME_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2480 protocols[1] = FRAME_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2481 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2484 /* x_set_name normally ignores requests to set the name if the
2485 requested name is the same as the current name. This is the one
2486 place where that assumption isn't correct; f->name is set, but
2487 the X server hasn't been told. */
2489 Lisp_Object name;
2490 int explicit = f->explicit_name;
2492 f->explicit_name = 0;
2493 name = f->name;
2494 fset_name (f, Qnil);
2495 x_set_name (f, name, explicit);
2498 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2499 f->output_data.x->current_cursor
2500 = f->output_data.x->text_cursor);
2502 unblock_input ();
2504 if (FRAME_X_WINDOW (f) == 0)
2505 error ("Unable to create window");
2508 #endif /* not USE_GTK */
2509 #endif /* not USE_X_TOOLKIT */
2511 /* Verify that the icon position args for this window are valid. */
2513 static void
2514 x_icon_verify (struct frame *f, Lisp_Object parms)
2516 Lisp_Object icon_x, icon_y;
2518 /* Set the position of the icon. Note that twm groups all
2519 icons in an icon window. */
2520 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2521 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2522 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2524 CHECK_NUMBER (icon_x);
2525 CHECK_NUMBER (icon_y);
2527 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2528 error ("Both left and top icon corners of icon must be specified");
2531 /* Handle the icon stuff for this window. Perhaps later we might
2532 want an x_set_icon_position which can be called interactively as
2533 well. */
2535 static void
2536 x_icon (struct frame *f, Lisp_Object parms)
2538 Lisp_Object icon_x, icon_y;
2539 #if 0
2540 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
2541 #endif
2543 /* Set the position of the icon. Note that twm groups all
2544 icons in an icon window. */
2545 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2546 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2547 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2549 CHECK_TYPE_RANGED_INTEGER (int, icon_x);
2550 CHECK_TYPE_RANGED_INTEGER (int, icon_y);
2552 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2553 error ("Both left and top icon corners of icon must be specified");
2555 block_input ();
2557 if (! EQ (icon_x, Qunbound))
2558 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2560 #if 0 /* x_get_arg removes the visibility parameter as a side effect,
2561 but x_create_frame still needs it. */
2562 /* Start up iconic or window? */
2563 x_wm_set_window_state
2564 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2565 Qicon)
2566 ? IconicState
2567 : NormalState));
2568 #endif
2570 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
2571 ? f->icon_name
2572 : f->name)));
2574 unblock_input ();
2577 /* Make the GCs needed for this window, setting the
2578 background, border and mouse colors; also create the
2579 mouse cursor and the gray border tile. */
2581 static void
2582 x_make_gc (struct frame *f)
2584 XGCValues gc_values;
2586 block_input ();
2588 /* Create the GCs of this frame.
2589 Note that many default values are used. */
2591 gc_values.foreground = FRAME_FOREGROUND_PIXEL (f);
2592 gc_values.background = FRAME_BACKGROUND_PIXEL (f);
2593 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2594 f->output_data.x->normal_gc
2595 = XCreateGC (FRAME_X_DISPLAY (f),
2596 FRAME_X_WINDOW (f),
2597 GCLineWidth | GCForeground | GCBackground,
2598 &gc_values);
2600 /* Reverse video style. */
2601 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2602 gc_values.background = FRAME_FOREGROUND_PIXEL (f);
2603 f->output_data.x->reverse_gc
2604 = XCreateGC (FRAME_X_DISPLAY (f),
2605 FRAME_X_WINDOW (f),
2606 GCForeground | GCBackground | GCLineWidth,
2607 &gc_values);
2609 /* Cursor has cursor-color background, background-color foreground. */
2610 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2611 gc_values.background = f->output_data.x->cursor_pixel;
2612 gc_values.fill_style = FillOpaqueStippled;
2613 f->output_data.x->cursor_gc
2614 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2615 (GCForeground | GCBackground
2616 | GCFillStyle | GCLineWidth),
2617 &gc_values);
2619 /* Create the gray border tile used when the pointer is not in
2620 the frame. Since this depends on the frame's pixel values,
2621 this must be done on a per-frame basis. */
2622 f->output_data.x->border_tile
2623 = (XCreatePixmapFromBitmapData
2624 (FRAME_X_DISPLAY (f), FRAME_DISPLAY_INFO (f)->root_window,
2625 gray_bits, gray_width, gray_height,
2626 FRAME_FOREGROUND_PIXEL (f),
2627 FRAME_BACKGROUND_PIXEL (f),
2628 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2630 unblock_input ();
2634 /* Free what was allocated in x_make_gc. */
2636 void
2637 x_free_gcs (struct frame *f)
2639 Display *dpy = FRAME_X_DISPLAY (f);
2641 block_input ();
2643 if (f->output_data.x->normal_gc)
2645 XFreeGC (dpy, f->output_data.x->normal_gc);
2646 f->output_data.x->normal_gc = 0;
2649 if (f->output_data.x->reverse_gc)
2651 XFreeGC (dpy, f->output_data.x->reverse_gc);
2652 f->output_data.x->reverse_gc = 0;
2655 if (f->output_data.x->cursor_gc)
2657 XFreeGC (dpy, f->output_data.x->cursor_gc);
2658 f->output_data.x->cursor_gc = 0;
2661 if (f->output_data.x->border_tile)
2663 XFreePixmap (dpy, f->output_data.x->border_tile);
2664 f->output_data.x->border_tile = 0;
2667 unblock_input ();
2671 /* Handler for signals raised during x_create_frame and
2672 x_create_tip_frame. FRAME is the frame which is partially
2673 constructed. */
2675 static Lisp_Object
2676 unwind_create_frame (Lisp_Object frame)
2678 struct frame *f = XFRAME (frame);
2680 /* If frame is already dead, nothing to do. This can happen if the
2681 display is disconnected after the frame has become official, but
2682 before x_create_frame removes the unwind protect. */
2683 if (!FRAME_LIVE_P (f))
2684 return Qnil;
2686 /* If frame is ``official'', nothing to do. */
2687 if (NILP (Fmemq (frame, Vframe_list)))
2689 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2690 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
2691 #endif
2693 x_free_frame_resources (f);
2694 free_glyphs (f);
2696 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2697 /* Check that reference counts are indeed correct. */
2698 eassert (dpyinfo->reference_count == dpyinfo_refcount);
2699 eassert (dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
2700 #endif
2701 return Qt;
2704 return Qnil;
2707 static void
2708 do_unwind_create_frame (Lisp_Object frame)
2710 unwind_create_frame (frame);
2713 static void
2714 unwind_create_frame_1 (Lisp_Object val)
2716 inhibit_lisp_code = val;
2719 static void
2720 x_default_font_parameter (struct frame *f, Lisp_Object parms)
2722 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
2723 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
2724 RES_TYPE_STRING);
2725 Lisp_Object font = Qnil;
2726 if (EQ (font_param, Qunbound))
2727 font_param = Qnil;
2729 if (NILP (font_param))
2731 /* System font should take precedence over X resources. We suggest this
2732 regardless of font-use-system-font because .emacs may not have been
2733 read yet. */
2734 const char *system_font = xsettings_get_system_font ();
2735 if (system_font)
2736 font = font_open_by_name (f, build_unibyte_string (system_font));
2739 if (NILP (font))
2740 font = !NILP (font_param) ? font_param
2741 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
2743 if (! FONTP (font) && ! STRINGP (font))
2745 const char *names[]
2747 #ifdef HAVE_XFT
2748 /* This will find the normal Xft font. */
2749 "monospace-10",
2750 #endif
2751 "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1",
2752 "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2753 "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2754 /* This was formerly the first thing tried, but it finds
2755 too many fonts and takes too long. */
2756 "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1",
2757 /* If those didn't work, look for something which will
2758 at least work. */
2759 "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1",
2760 "fixed",
2761 NULL };
2762 int i;
2764 for (i = 0; names[i]; i++)
2766 font = font_open_by_name (f, build_unibyte_string (names[i]));
2767 if (! NILP (font))
2768 break;
2770 if (NILP (font))
2771 error ("No suitable font was found");
2773 else if (!NILP (font_param))
2775 /* Remember the explicit font parameter, so we can re-apply it after
2776 we've applied the `default' face settings. */
2777 x_set_frame_parameters (f, list1 (Fcons (Qfont_param, font_param)));
2780 /* This call will make X resources override any system font setting. */
2781 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
2785 DEFUN ("x-wm-set-size-hint", Fx_wm_set_size_hint, Sx_wm_set_size_hint,
2786 0, 1, 0,
2787 doc: /* Send the size hints for frame FRAME to the window manager.
2788 If FRAME is omitted or nil, use the selected frame.
2789 Signal error if FRAME is not an X frame. */)
2790 (Lisp_Object frame)
2792 struct frame *f = decode_window_system_frame (frame);
2794 block_input ();
2795 x_wm_set_size_hint (f, 0, 0);
2796 unblock_input ();
2797 return Qnil;
2800 static void
2801 set_machine_and_pid_properties (struct frame *f)
2803 long pid = (long) getpid ();
2805 /* This will set WM_CLIENT_MACHINE and WM_LOCALE_NAME. */
2806 XSetWMProperties (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), NULL, NULL,
2807 NULL, 0, NULL, NULL, NULL);
2808 XChangeProperty (FRAME_X_DISPLAY (f),
2809 FRAME_OUTER_WINDOW (f),
2810 XInternAtom (FRAME_X_DISPLAY (f),
2811 "_NET_WM_PID",
2812 False),
2813 XA_CARDINAL, 32, PropModeReplace,
2814 (unsigned char *) &pid, 1);
2817 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
2818 1, 1, 0,
2819 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
2820 Return an Emacs frame object.
2821 PARMS is an alist of frame parameters.
2822 If the parameters specify that the frame should not have a minibuffer,
2823 and do not specify a specific minibuffer window to use,
2824 then `default-minibuffer-frame' must be a frame whose minibuffer can
2825 be shared by the new frame.
2827 This function is an internal primitive--use `make-frame' instead. */)
2828 (Lisp_Object parms)
2830 struct frame *f;
2831 Lisp_Object frame, tem;
2832 Lisp_Object name;
2833 int minibuffer_only = 0;
2834 long window_prompting = 0;
2835 int width, height;
2836 ptrdiff_t count = SPECPDL_INDEX ();
2837 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2838 Lisp_Object display;
2839 struct x_display_info *dpyinfo = NULL;
2840 Lisp_Object parent;
2841 struct kboard *kb;
2843 parms = Fcopy_alist (parms);
2845 /* Use this general default value to start with
2846 until we know if this frame has a specified name. */
2847 Vx_resource_name = Vinvocation_name;
2849 display = x_get_arg (dpyinfo, parms, Qterminal, 0, 0, RES_TYPE_NUMBER);
2850 if (EQ (display, Qunbound))
2851 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
2852 if (EQ (display, Qunbound))
2853 display = Qnil;
2854 dpyinfo = check_x_display_info (display);
2855 kb = dpyinfo->terminal->kboard;
2857 if (!dpyinfo->terminal->name)
2858 error ("Terminal is not live, can't create new frames on it");
2860 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
2861 if (!STRINGP (name)
2862 && ! EQ (name, Qunbound)
2863 && ! NILP (name))
2864 error ("Invalid frame name--not a string or nil");
2866 if (STRINGP (name))
2867 Vx_resource_name = name;
2869 /* See if parent window is specified. */
2870 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
2871 if (EQ (parent, Qunbound))
2872 parent = Qnil;
2873 if (! NILP (parent))
2874 CHECK_NUMBER (parent);
2876 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
2877 /* No need to protect DISPLAY because that's not used after passing
2878 it to make_frame_without_minibuffer. */
2879 frame = Qnil;
2880 GCPRO4 (parms, parent, name, frame);
2881 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
2882 RES_TYPE_SYMBOL);
2883 if (EQ (tem, Qnone) || NILP (tem))
2884 f = make_frame_without_minibuffer (Qnil, kb, display);
2885 else if (EQ (tem, Qonly))
2887 f = make_minibuffer_frame ();
2888 minibuffer_only = 1;
2890 else if (WINDOWP (tem))
2891 f = make_frame_without_minibuffer (tem, kb, display);
2892 else
2893 f = make_frame (1);
2895 XSETFRAME (frame, f);
2897 f->terminal = dpyinfo->terminal;
2899 f->output_method = output_x_window;
2900 f->output_data.x = xzalloc (sizeof *f->output_data.x);
2901 f->output_data.x->icon_bitmap = -1;
2902 FRAME_FONTSET (f) = -1;
2903 f->output_data.x->scroll_bar_foreground_pixel = -1;
2904 f->output_data.x->scroll_bar_background_pixel = -1;
2905 #ifdef USE_TOOLKIT_SCROLL_BARS
2906 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
2907 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
2908 #endif /* USE_TOOLKIT_SCROLL_BARS */
2909 f->output_data.x->white_relief.pixel = -1;
2910 f->output_data.x->black_relief.pixel = -1;
2912 fset_icon_name (f,
2913 x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
2914 RES_TYPE_STRING));
2915 if (! STRINGP (f->icon_name))
2916 fset_icon_name (f, Qnil);
2918 FRAME_DISPLAY_INFO (f) = dpyinfo;
2920 /* With FRAME_DISPLAY_INFO set up, this unwind-protect is safe. */
2921 record_unwind_protect (do_unwind_create_frame, frame);
2923 /* These colors will be set anyway later, but it's important
2924 to get the color reference counts right, so initialize them! */
2926 Lisp_Object black;
2927 struct gcpro gcpro1;
2929 /* Function x_decode_color can signal an error. Make
2930 sure to initialize color slots so that we won't try
2931 to free colors we haven't allocated. */
2932 FRAME_FOREGROUND_PIXEL (f) = -1;
2933 FRAME_BACKGROUND_PIXEL (f) = -1;
2934 f->output_data.x->cursor_pixel = -1;
2935 f->output_data.x->cursor_foreground_pixel = -1;
2936 f->output_data.x->border_pixel = -1;
2937 f->output_data.x->mouse_pixel = -1;
2939 black = build_string ("black");
2940 GCPRO1 (black);
2941 FRAME_FOREGROUND_PIXEL (f)
2942 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
2943 FRAME_BACKGROUND_PIXEL (f)
2944 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
2945 f->output_data.x->cursor_pixel
2946 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
2947 f->output_data.x->cursor_foreground_pixel
2948 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
2949 f->output_data.x->border_pixel
2950 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
2951 f->output_data.x->mouse_pixel
2952 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
2953 UNGCPRO;
2956 /* Specify the parent under which to make this X window. */
2958 if (!NILP (parent))
2960 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
2961 f->output_data.x->explicit_parent = 1;
2963 else
2965 f->output_data.x->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
2966 f->output_data.x->explicit_parent = 0;
2969 /* Set the name; the functions to which we pass f expect the name to
2970 be set. */
2971 if (EQ (name, Qunbound) || NILP (name))
2973 fset_name (f, build_string (dpyinfo->x_id_name));
2974 f->explicit_name = 0;
2976 else
2978 fset_name (f, name);
2979 f->explicit_name = 1;
2980 /* use the frame's title when getting resources for this frame. */
2981 specbind (Qx_resource_name, name);
2984 #ifdef HAVE_FREETYPE
2985 #ifdef HAVE_XFT
2986 register_font_driver (&xftfont_driver, f);
2987 #else /* not HAVE_XFT */
2988 register_font_driver (&ftxfont_driver, f);
2989 #endif /* not HAVE_XFT */
2990 #endif /* HAVE_FREETYPE */
2991 register_font_driver (&xfont_driver, f);
2993 x_default_parameter (f, parms, Qfont_backend, Qnil,
2994 "fontBackend", "FontBackend", RES_TYPE_STRING);
2996 /* Extract the window parameters from the supplied values
2997 that are needed to determine window geometry. */
2998 x_default_font_parameter (f, parms);
2999 if (!FRAME_FONT (f))
3001 delete_frame (frame, Qnoelisp);
3002 error ("Invalid frame font");
3005 /* Frame contents get displaced if an embedded X window has a border. */
3006 if (! FRAME_X_EMBEDDED_P (f))
3007 x_default_parameter (f, parms, Qborder_width, make_number (0),
3008 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3010 /* This defaults to 1 in order to match xterm. We recognize either
3011 internalBorderWidth or internalBorder (which is what xterm calls
3012 it). */
3013 if (NILP (Fassq (Qinternal_border_width, parms)))
3015 Lisp_Object value;
3017 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3018 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3019 if (! EQ (value, Qunbound))
3020 parms = Fcons (Fcons (Qinternal_border_width, value),
3021 parms);
3023 x_default_parameter (f, parms, Qinternal_border_width,
3024 #ifdef USE_GTK /* We used to impose 0 in xg_create_frame_widgets. */
3025 make_number (0),
3026 #else
3027 make_number (1),
3028 #endif
3029 "internalBorderWidth", "internalBorderWidth",
3030 RES_TYPE_NUMBER);
3031 x_default_parameter (f, parms, Qvertical_scroll_bars,
3032 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3033 Qright,
3034 #else
3035 Qleft,
3036 #endif
3037 "verticalScrollBars", "ScrollBars",
3038 RES_TYPE_SYMBOL);
3040 /* Also do the stuff which must be set before the window exists. */
3041 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3042 "foreground", "Foreground", RES_TYPE_STRING);
3043 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3044 "background", "Background", RES_TYPE_STRING);
3045 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3046 "pointerColor", "Foreground", RES_TYPE_STRING);
3047 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3048 "borderColor", "BorderColor", RES_TYPE_STRING);
3049 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3050 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3051 x_default_parameter (f, parms, Qline_spacing, Qnil,
3052 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3053 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3054 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3055 x_default_parameter (f, parms, Qright_fringe, Qnil,
3056 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3058 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3059 "scrollBarForeground",
3060 "ScrollBarForeground", 1);
3061 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3062 "scrollBarBackground",
3063 "ScrollBarBackground", 0);
3065 #ifdef GLYPH_DEBUG
3066 image_cache_refcount =
3067 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
3068 dpyinfo_refcount = dpyinfo->reference_count;
3069 #endif /* GLYPH_DEBUG */
3071 /* Init faces before x_default_parameter is called for scroll-bar
3072 parameters because that function calls x_set_scroll_bar_width,
3073 which calls change_frame_size, which calls Fset_window_buffer,
3074 which runs hooks, which call Fvertical_motion. At the end, we
3075 end up in init_iterator with a null face cache, which should not
3076 happen. */
3077 init_frame_faces (f);
3079 /* PXW: This is a duplicate from below. We have to do it here since
3080 otherwise x_set_tool_bar_lines will work with the character sizes
3081 installed by init_frame_faces while the frame's pixel size is still
3082 calculated from a character size of 1 and we subsequently hit the
3083 eassert (height >= 0) assertion in window_box_height. The
3084 non-pixelwise code apparently worked around this because it had one
3085 frame line vs one toolbar line which left us with a zero root
3086 window height which was obviously wrong as well ... */
3087 change_frame_size (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
3088 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 1, 0, 0, 1);
3090 /* Set the menu-bar-lines and tool-bar-lines parameters. We don't
3091 look up the X resources controlling the menu-bar and tool-bar
3092 here; they are processed specially at startup, and reflected in
3093 the values of the mode variables.
3095 Avoid calling window-configuration-change-hook; otherwise we
3096 could get an infloop in next_frame since the frame is not yet in
3097 Vframe_list. */
3099 ptrdiff_t count2 = SPECPDL_INDEX ();
3100 record_unwind_protect (unwind_create_frame_1, inhibit_lisp_code);
3101 inhibit_lisp_code = Qt;
3103 x_default_parameter (f, parms, Qmenu_bar_lines,
3104 NILP (Vmenu_bar_mode)
3105 ? make_number (0) : make_number (1),
3106 NULL, NULL, RES_TYPE_NUMBER);
3107 x_default_parameter (f, parms, Qtool_bar_lines,
3108 NILP (Vtool_bar_mode)
3109 ? make_number (0) : make_number (1),
3110 NULL, NULL, RES_TYPE_NUMBER);
3112 unbind_to (count2, Qnil);
3115 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3116 "bufferPredicate", "BufferPredicate",
3117 RES_TYPE_SYMBOL);
3118 x_default_parameter (f, parms, Qtitle, Qnil,
3119 "title", "Title", RES_TYPE_STRING);
3120 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3121 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3122 x_default_parameter (f, parms, Qfullscreen, Qnil,
3123 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3124 x_default_parameter (f, parms, Qtool_bar_position,
3125 f->tool_bar_position, 0, 0, RES_TYPE_SYMBOL);
3127 /* Compute the size of the X window. */
3128 window_prompting = x_figure_window_size (f, parms, 1);
3130 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3131 f->no_split = minibuffer_only || EQ (tem, Qt);
3133 x_icon_verify (f, parms);
3135 /* Create the X widget or window. */
3136 #ifdef USE_X_TOOLKIT
3137 x_window (f, window_prompting, minibuffer_only);
3138 #else
3139 x_window (f);
3140 #endif
3142 x_icon (f, parms);
3143 x_make_gc (f);
3145 /* Now consider the frame official. */
3146 f->terminal->reference_count++;
3147 FRAME_DISPLAY_INFO (f)->reference_count++;
3148 Vframe_list = Fcons (frame, Vframe_list);
3150 /* We need to do this after creating the X window, so that the
3151 icon-creation functions can say whose icon they're describing. */
3152 x_default_parameter (f, parms, Qicon_type, Qt,
3153 "bitmapIcon", "BitmapIcon", RES_TYPE_BOOLEAN);
3155 x_default_parameter (f, parms, Qauto_raise, Qnil,
3156 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3157 x_default_parameter (f, parms, Qauto_lower, Qnil,
3158 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3159 x_default_parameter (f, parms, Qcursor_type, Qbox,
3160 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3161 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3162 "scrollBarWidth", "ScrollBarWidth",
3163 RES_TYPE_NUMBER);
3164 x_default_parameter (f, parms, Qalpha, Qnil,
3165 "alpha", "Alpha", RES_TYPE_NUMBER);
3167 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3168 Change will not be effected unless different from the current
3169 FRAME_LINES (f). */
3170 width = FRAME_TEXT_WIDTH (f);
3171 height = FRAME_TEXT_HEIGHT (f);
3172 FRAME_TEXT_HEIGHT (f) = 0;
3173 SET_FRAME_WIDTH (f, 0);
3174 change_frame_size (f, width, height, 1, 0, 0, 1);
3176 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3177 /* Create the menu bar. */
3178 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3180 /* If this signals an error, we haven't set size hints for the
3181 frame and we didn't make it visible. */
3182 initialize_frame_menubar (f);
3184 #ifndef USE_GTK
3185 /* This is a no-op, except under Motif where it arranges the
3186 main window for the widgets on it. */
3187 lw_set_main_areas (f->output_data.x->column_widget,
3188 f->output_data.x->menubar_widget,
3189 f->output_data.x->edit_widget);
3190 #endif /* not USE_GTK */
3192 #endif /* USE_X_TOOLKIT || USE_GTK */
3194 /* Tell the server what size and position, etc, we want, and how
3195 badly we want them. This should be done after we have the menu
3196 bar so that its size can be taken into account. */
3197 block_input ();
3198 x_wm_set_size_hint (f, window_prompting, 0);
3199 unblock_input ();
3201 /* Make the window appear on the frame and enable display, unless
3202 the caller says not to. However, with explicit parent, Emacs
3203 cannot control visibility, so don't try. */
3204 if (! f->output_data.x->explicit_parent)
3206 Lisp_Object visibility;
3208 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3209 RES_TYPE_SYMBOL);
3210 if (EQ (visibility, Qunbound))
3211 visibility = Qt;
3213 if (EQ (visibility, Qicon))
3214 x_iconify_frame (f);
3215 else if (! NILP (visibility))
3216 x_make_frame_visible (f);
3217 else
3219 /* Must have been Qnil. */
3223 block_input ();
3225 /* Set machine name and pid for the purpose of window managers. */
3226 set_machine_and_pid_properties (f);
3228 /* Set the WM leader property. GTK does this itself, so this is not
3229 needed when using GTK. */
3230 if (dpyinfo->client_leader_window != 0)
3232 XChangeProperty (FRAME_X_DISPLAY (f),
3233 FRAME_OUTER_WINDOW (f),
3234 dpyinfo->Xatom_wm_client_leader,
3235 XA_WINDOW, 32, PropModeReplace,
3236 (unsigned char *) &dpyinfo->client_leader_window, 1);
3239 unblock_input ();
3241 /* Initialize `default-minibuffer-frame' in case this is the first
3242 frame on this terminal. */
3243 if (FRAME_HAS_MINIBUF_P (f)
3244 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
3245 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
3246 kset_default_minibuffer_frame (kb, frame);
3248 /* All remaining specified parameters, which have not been "used"
3249 by x_get_arg and friends, now go in the misc. alist of the frame. */
3250 for (tem = parms; CONSP (tem); tem = XCDR (tem))
3251 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3252 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
3254 UNGCPRO;
3256 /* Make sure windows on this frame appear in calls to next-window
3257 and similar functions. */
3258 Vwindow_list = Qnil;
3260 return unbind_to (count, frame);
3264 /* FRAME is used only to get a handle on the X display. We don't pass the
3265 display info directly because we're called from frame.c, which doesn't
3266 know about that structure. */
3268 Lisp_Object
3269 x_get_focus_frame (struct frame *frame)
3271 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
3272 Lisp_Object xfocus;
3273 if (! dpyinfo->x_focus_frame)
3274 return Qnil;
3276 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3277 return xfocus;
3281 /* In certain situations, when the window manager follows a
3282 click-to-focus policy, there seems to be no way around calling
3283 XSetInputFocus to give another frame the input focus .
3285 In an ideal world, XSetInputFocus should generally be avoided so
3286 that applications don't interfere with the window manager's focus
3287 policy. But I think it's okay to use when it's clearly done
3288 following a user-command. */
3290 void
3291 x_focus_frame (struct frame *f)
3293 Display *dpy = FRAME_X_DISPLAY (f);
3295 block_input ();
3296 x_catch_errors (dpy);
3298 if (FRAME_X_EMBEDDED_P (f))
3300 /* For Xembedded frames, normally the embedder forwards key
3301 events. See XEmbed Protocol Specification at
3302 http://freedesktop.org/wiki/Specifications/xembed-spec */
3303 xembed_request_focus (f);
3305 else
3307 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3308 RevertToParent, CurrentTime);
3309 x_ewmh_activate_frame (f);
3312 x_uncatch_errors ();
3313 unblock_input ();
3317 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3318 doc: /* Internal function called by `color-defined-p', which see
3319 .\(Note that the Nextstep version of this function ignores FRAME.) */)
3320 (Lisp_Object color, Lisp_Object frame)
3322 XColor foo;
3323 struct frame *f = decode_window_system_frame (frame);
3325 CHECK_STRING (color);
3327 if (x_defined_color (f, SSDATA (color), &foo, 0))
3328 return Qt;
3329 else
3330 return Qnil;
3333 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3334 doc: /* Internal function called by `color-values', which see. */)
3335 (Lisp_Object color, Lisp_Object frame)
3337 XColor foo;
3338 struct frame *f = decode_window_system_frame (frame);
3340 CHECK_STRING (color);
3342 if (x_defined_color (f, SSDATA (color), &foo, 0))
3343 return list3i (foo.red, foo.green, foo.blue);
3344 else
3345 return Qnil;
3348 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3349 doc: /* Internal function called by `display-color-p', which see. */)
3350 (Lisp_Object terminal)
3352 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3354 if (dpyinfo->n_planes <= 2)
3355 return Qnil;
3357 switch (dpyinfo->visual->class)
3359 case StaticColor:
3360 case PseudoColor:
3361 case TrueColor:
3362 case DirectColor:
3363 return Qt;
3365 default:
3366 return Qnil;
3370 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3371 0, 1, 0,
3372 doc: /* Return t if the X display supports shades of gray.
3373 Note that color displays do support shades of gray.
3374 The optional argument TERMINAL specifies which display to ask about.
3375 TERMINAL should be a terminal object, a frame or a display name (a string).
3376 If omitted or nil, that stands for the selected frame's display. */)
3377 (Lisp_Object terminal)
3379 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3381 if (dpyinfo->n_planes <= 1)
3382 return Qnil;
3384 switch (dpyinfo->visual->class)
3386 case StaticColor:
3387 case PseudoColor:
3388 case TrueColor:
3389 case DirectColor:
3390 case StaticGray:
3391 case GrayScale:
3392 return Qt;
3394 default:
3395 return Qnil;
3399 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3400 0, 1, 0,
3401 doc: /* Return the width in pixels of the X display TERMINAL.
3402 The optional argument TERMINAL specifies which display to ask about.
3403 TERMINAL should be a terminal object, a frame or a display name (a string).
3404 If omitted or nil, that stands for the selected frame's display.
3406 On \"multi-monitor\" setups this refers to the pixel width for all
3407 physical monitors associated with TERMINAL. To get information for
3408 each physical monitor, use `display-monitor-attributes-list'. */)
3409 (Lisp_Object terminal)
3411 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3413 return make_number (x_display_pixel_width (dpyinfo));
3416 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3417 Sx_display_pixel_height, 0, 1, 0,
3418 doc: /* Return the height in pixels of the X display TERMINAL.
3419 The optional argument TERMINAL specifies which display to ask about.
3420 TERMINAL should be a terminal object, a frame or a display name (a string).
3421 If omitted or nil, that stands for the selected frame's display.
3423 On \"multi-monitor\" setups this refers to the pixel height for all
3424 physical monitors associated with TERMINAL. To get information for
3425 each physical monitor, use `display-monitor-attributes-list'. */)
3426 (Lisp_Object terminal)
3428 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3430 return make_number (x_display_pixel_height (dpyinfo));
3433 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3434 0, 1, 0,
3435 doc: /* Return the number of bitplanes of the X display TERMINAL.
3436 The optional argument TERMINAL specifies which display to ask about.
3437 TERMINAL should be a terminal object, a frame or a display name (a string).
3438 If omitted or nil, that stands for the selected frame's display. */)
3439 (Lisp_Object terminal)
3441 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3443 return make_number (dpyinfo->n_planes);
3446 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3447 0, 1, 0,
3448 doc: /* Return the number of color cells of the X display TERMINAL.
3449 The optional argument TERMINAL specifies which display to ask about.
3450 TERMINAL should be a terminal object, a frame or a display name (a string).
3451 If omitted or nil, that stands for the selected frame's display. */)
3452 (Lisp_Object terminal)
3454 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3456 int nr_planes = DisplayPlanes (dpyinfo->display,
3457 XScreenNumberOfScreen (dpyinfo->screen));
3459 /* Truncate nr_planes to 24 to avoid integer overflow.
3460 Some displays says 32, but only 24 bits are actually significant.
3461 There are only very few and rare video cards that have more than
3462 24 significant bits. Also 24 bits is more than 16 million colors,
3463 it "should be enough for everyone". */
3464 if (nr_planes > 24) nr_planes = 24;
3466 return make_number (1 << nr_planes);
3469 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3470 Sx_server_max_request_size,
3471 0, 1, 0,
3472 doc: /* Return the maximum request size of the X server of display TERMINAL.
3473 The optional argument TERMINAL specifies which display to ask about.
3474 TERMINAL should be a terminal object, a frame or a display name (a string).
3475 If omitted or nil, that stands for the selected frame's display. */)
3476 (Lisp_Object terminal)
3478 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3480 return make_number (MAXREQUEST (dpyinfo->display));
3483 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3484 doc: /* Return the "vendor ID" string of the X server of display TERMINAL.
3485 \(Labeling every distributor as a "vendor" embodies the false assumption
3486 that operating systems cannot be developed and distributed noncommercially.)
3487 The optional argument TERMINAL specifies which display to ask about.
3488 TERMINAL should be a terminal object, a frame or a display name (a string).
3489 If omitted or nil, that stands for the selected frame's display. */)
3490 (Lisp_Object terminal)
3492 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3493 const char *vendor = ServerVendor (dpyinfo->display);
3495 if (! vendor) vendor = "";
3496 return build_string (vendor);
3499 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3500 doc: /* Return the version numbers of the X server of display TERMINAL.
3501 The value is a list of three integers: the major and minor
3502 version numbers of the X Protocol in use, and the distributor-specific release
3503 number. See also the function `x-server-vendor'.
3505 The optional argument TERMINAL specifies which display to ask about.
3506 TERMINAL should be a terminal object, a frame or a display name (a string).
3507 If omitted or nil, that stands for the selected frame's display. */)
3508 (Lisp_Object terminal)
3510 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3511 Display *dpy = dpyinfo->display;
3513 return list3i (ProtocolVersion (dpy), ProtocolRevision (dpy),
3514 VendorRelease (dpy));
3517 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3518 doc: /* Return the number of screens on the X server of display TERMINAL.
3519 The optional argument TERMINAL specifies which display to ask about.
3520 TERMINAL should be a terminal object, a frame or a display name (a string).
3521 If omitted or nil, that stands for the selected frame's display. */)
3522 (Lisp_Object terminal)
3524 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3526 return make_number (ScreenCount (dpyinfo->display));
3529 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3530 doc: /* Return the height in millimeters of the X display TERMINAL.
3531 The optional argument TERMINAL specifies which display to ask about.
3532 TERMINAL should be a terminal object, a frame or a display name (a string).
3533 If omitted or nil, that stands for the selected frame's display.
3535 On \"multi-monitor\" setups this refers to the height in millimeters for
3536 all physical monitors associated with TERMINAL. To get information
3537 for each physical monitor, use `display-monitor-attributes-list'. */)
3538 (Lisp_Object terminal)
3540 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3542 return make_number (HeightMMOfScreen (dpyinfo->screen));
3545 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3546 doc: /* Return the width in millimeters of the X display TERMINAL.
3547 The optional argument TERMINAL specifies which display to ask about.
3548 TERMINAL should be a terminal object, a frame or a display name (a string).
3549 If omitted or nil, that stands for the selected frame's display.
3551 On \"multi-monitor\" setups this refers to the width in millimeters for
3552 all physical monitors associated with TERMINAL. To get information
3553 for each physical monitor, use `display-monitor-attributes-list'. */)
3554 (Lisp_Object terminal)
3556 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3558 return make_number (WidthMMOfScreen (dpyinfo->screen));
3561 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3562 Sx_display_backing_store, 0, 1, 0,
3563 doc: /* Return an indication of whether X display TERMINAL does backing store.
3564 The value may be `always', `when-mapped', or `not-useful'.
3565 The optional argument TERMINAL specifies which display to ask about.
3566 TERMINAL should be a terminal object, a frame or a display name (a string).
3567 If omitted or nil, that stands for the selected frame's display. */)
3568 (Lisp_Object terminal)
3570 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3571 Lisp_Object result;
3573 switch (DoesBackingStore (dpyinfo->screen))
3575 case Always:
3576 result = intern ("always");
3577 break;
3579 case WhenMapped:
3580 result = intern ("when-mapped");
3581 break;
3583 case NotUseful:
3584 result = intern ("not-useful");
3585 break;
3587 default:
3588 error ("Strange value for BackingStore parameter of screen");
3591 return result;
3594 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3595 Sx_display_visual_class, 0, 1, 0,
3596 doc: /* Return the visual class of the X display TERMINAL.
3597 The value is one of the symbols `static-gray', `gray-scale',
3598 `static-color', `pseudo-color', `true-color', or `direct-color'.
3600 The optional argument TERMINAL specifies which display to ask about.
3601 TERMINAL should a terminal object, a frame or a display name (a string).
3602 If omitted or nil, that stands for the selected frame's display. */)
3603 (Lisp_Object terminal)
3605 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3606 Lisp_Object result;
3608 switch (dpyinfo->visual->class)
3610 case StaticGray:
3611 result = intern ("static-gray");
3612 break;
3613 case GrayScale:
3614 result = intern ("gray-scale");
3615 break;
3616 case StaticColor:
3617 result = intern ("static-color");
3618 break;
3619 case PseudoColor:
3620 result = intern ("pseudo-color");
3621 break;
3622 case TrueColor:
3623 result = intern ("true-color");
3624 break;
3625 case DirectColor:
3626 result = intern ("direct-color");
3627 break;
3628 default:
3629 error ("Display has an unknown visual class");
3632 return result;
3635 DEFUN ("x-display-save-under", Fx_display_save_under,
3636 Sx_display_save_under, 0, 1, 0,
3637 doc: /* Return t if the X display TERMINAL supports the save-under feature.
3638 The optional argument TERMINAL specifies which display to ask about.
3639 TERMINAL should be a terminal object, a frame or a display name (a string).
3640 If omitted or nil, that stands for the selected frame's display. */)
3641 (Lisp_Object terminal)
3643 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3645 if (DoesSaveUnders (dpyinfo->screen) == True)
3646 return Qt;
3647 else
3648 return Qnil;
3651 /* Store the geometry of the workarea on display DPYINFO into *RECT.
3652 Return false if and only if the workarea information cannot be
3653 obtained via the _NET_WORKAREA root window property. */
3655 #if ! GTK_CHECK_VERSION (3, 4, 0)
3656 static bool
3657 x_get_net_workarea (struct x_display_info *dpyinfo, XRectangle *rect)
3659 Display *dpy = dpyinfo->display;
3660 long offset, max_len;
3661 Atom target_type, actual_type;
3662 unsigned long actual_size, bytes_remaining;
3663 int rc, actual_format;
3664 unsigned char *tmp_data = NULL;
3665 bool result = false;
3667 x_catch_errors (dpy);
3668 offset = 0;
3669 max_len = 1;
3670 target_type = XA_CARDINAL;
3671 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
3672 dpyinfo->Xatom_net_current_desktop,
3673 offset, max_len, False, target_type,
3674 &actual_type, &actual_format, &actual_size,
3675 &bytes_remaining, &tmp_data);
3676 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
3677 && actual_format == 32 && actual_size == max_len)
3679 long current_desktop = ((long *) tmp_data)[0];
3681 XFree (tmp_data);
3682 tmp_data = NULL;
3684 offset = 4 * current_desktop;
3685 max_len = 4;
3686 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
3687 dpyinfo->Xatom_net_workarea,
3688 offset, max_len, False, target_type,
3689 &actual_type, &actual_format, &actual_size,
3690 &bytes_remaining, &tmp_data);
3691 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
3692 && actual_format == 32 && actual_size == max_len)
3694 long *values = (long *) tmp_data;
3696 rect->x = values[0];
3697 rect->y = values[1];
3698 rect->width = values[2];
3699 rect->height = values[3];
3701 XFree (tmp_data);
3702 tmp_data = NULL;
3704 result = true;
3707 if (tmp_data)
3708 XFree (tmp_data);
3709 x_uncatch_errors ();
3711 return result;
3713 #endif
3715 #ifndef USE_GTK
3717 /* Return monitor number where F is "most" or closest to. */
3718 static int
3719 x_get_monitor_for_frame (struct frame *f,
3720 struct MonitorInfo *monitors,
3721 int n_monitors)
3723 XRectangle frect;
3724 int area = 0, dist = -1;
3725 int best_area = -1, best_dist = -1;
3726 int i;
3728 if (n_monitors == 1) return 0;
3729 frect.x = f->left_pos;
3730 frect.y = f->top_pos;
3731 frect.width = FRAME_PIXEL_WIDTH (f);
3732 frect.height = FRAME_PIXEL_HEIGHT (f);
3734 for (i = 0; i < n_monitors; ++i)
3736 struct MonitorInfo *mi = &monitors[i];
3737 XRectangle res;
3738 int a = 0;
3740 if (mi->geom.width == 0) continue;
3742 if (x_intersect_rectangles (&mi->geom, &frect, &res))
3744 a = res.width * res.height;
3745 if (a > area)
3747 area = a;
3748 best_area = i;
3752 if (a == 0 && area == 0)
3754 int dx, dy, d;
3755 if (frect.x + frect.width < mi->geom.x)
3756 dx = mi->geom.x - frect.x + frect.width;
3757 else if (frect.x > mi->geom.x + mi->geom.width)
3758 dx = frect.x - mi->geom.x + mi->geom.width;
3759 else
3760 dx = 0;
3761 if (frect.y + frect.height < mi->geom.y)
3762 dy = mi->geom.y - frect.y + frect.height;
3763 else if (frect.y > mi->geom.y + mi->geom.height)
3764 dy = frect.y - mi->geom.y + mi->geom.height;
3765 else
3766 dy = 0;
3768 d = dx*dx + dy*dy;
3769 if (dist == -1 || dist > d)
3771 dist = d;
3772 best_dist = i;
3777 return best_area != -1 ? best_area : (best_dist != -1 ? best_dist : 0);
3780 static Lisp_Object
3781 x_make_monitor_attribute_list (struct MonitorInfo *monitors,
3782 int n_monitors,
3783 int primary_monitor,
3784 struct x_display_info *dpyinfo,
3785 const char *source)
3787 Lisp_Object monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
3788 Lisp_Object frame, rest;
3790 FOR_EACH_FRAME (rest, frame)
3792 struct frame *f = XFRAME (frame);
3794 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo
3795 && !EQ (frame, tip_frame))
3797 int i = x_get_monitor_for_frame (f, monitors, n_monitors);
3798 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
3802 return make_monitor_attribute_list (monitors, n_monitors, primary_monitor,
3803 monitor_frames, source);
3806 static Lisp_Object
3807 x_get_monitor_attributes_fallback (struct x_display_info *dpyinfo)
3809 struct MonitorInfo monitor;
3810 XRectangle workarea_r;
3812 /* Fallback: treat (possibly) multiple physical monitors as if they
3813 formed a single monitor as a whole. This should provide a
3814 consistent result at least on single monitor environments. */
3815 monitor.geom.x = monitor.geom.y = 0;
3816 monitor.geom.width = x_display_pixel_width (dpyinfo);
3817 monitor.geom.height = x_display_pixel_height (dpyinfo);
3818 monitor.mm_width = WidthMMOfScreen (dpyinfo->screen);
3819 monitor.mm_height = HeightMMOfScreen (dpyinfo->screen);
3820 monitor.name = xstrdup ("combined screen");
3822 if (x_get_net_workarea (dpyinfo, &workarea_r))
3823 monitor.work = workarea_r;
3824 else
3825 monitor.work = monitor.geom;
3826 return x_make_monitor_attribute_list (&monitor, 1, 0, dpyinfo, "fallback");
3830 #ifdef HAVE_XINERAMA
3831 static Lisp_Object
3832 x_get_monitor_attributes_xinerama (struct x_display_info *dpyinfo)
3834 int n_monitors, i;
3835 Lisp_Object attributes_list = Qnil;
3836 Display *dpy = dpyinfo->display;
3837 XineramaScreenInfo *info = XineramaQueryScreens (dpy, &n_monitors);
3838 struct MonitorInfo *monitors;
3839 double mm_width_per_pixel, mm_height_per_pixel;
3841 if (! info || n_monitors == 0)
3843 if (info)
3844 XFree (info);
3845 return attributes_list;
3848 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
3849 / x_display_pixel_width (dpyinfo));
3850 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
3851 / x_display_pixel_height (dpyinfo));
3852 monitors = xzalloc (n_monitors * sizeof *monitors);
3853 for (i = 0; i < n_monitors; ++i)
3855 struct MonitorInfo *mi = &monitors[i];
3856 XRectangle workarea_r;
3858 mi->geom.x = info[i].x_org;
3859 mi->geom.y = info[i].y_org;
3860 mi->geom.width = info[i].width;
3861 mi->geom.height = info[i].height;
3862 mi->mm_width = mi->geom.width * mm_width_per_pixel + 0.5;
3863 mi->mm_height = mi->geom.height * mm_height_per_pixel + 0.5;
3864 mi->name = 0;
3866 /* Xinerama usually have primary monitor first, just use that. */
3867 if (i == 0 && x_get_net_workarea (dpyinfo, &workarea_r))
3869 mi->work = workarea_r;
3870 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
3871 mi->work = mi->geom;
3873 else
3874 mi->work = mi->geom;
3876 XFree (info);
3878 attributes_list = x_make_monitor_attribute_list (monitors,
3879 n_monitors,
3881 dpyinfo,
3882 "Xinerama");
3883 free_monitors (monitors, n_monitors);
3884 return attributes_list;
3886 #endif /* HAVE_XINERAMA */
3889 #ifdef HAVE_XRANDR
3890 static Lisp_Object
3891 x_get_monitor_attributes_xrandr (struct x_display_info *dpyinfo)
3893 Lisp_Object attributes_list = Qnil;
3894 XRRScreenResources *resources;
3895 Display *dpy = dpyinfo->display;
3896 int i, n_monitors, primary = -1;
3897 RROutput pxid = None;
3898 struct MonitorInfo *monitors;
3900 #ifdef HAVE_XRRGETSCREENRESOURCESCURRENT
3901 resources = XRRGetScreenResourcesCurrent (dpy, dpyinfo->root_window);
3902 #else
3903 resources = XRRGetScreenResources (dpy, dpyinfo->root_window);
3904 #endif
3905 if (! resources || resources->noutput == 0)
3907 if (resources)
3908 XRRFreeScreenResources (resources);
3909 return Qnil;
3911 n_monitors = resources->noutput;
3912 monitors = xzalloc (n_monitors * sizeof *monitors);
3914 #ifdef HAVE_XRRGETOUTPUTPRIMARY
3915 pxid = XRRGetOutputPrimary (dpy, dpyinfo->root_window);
3916 #endif
3918 for (i = 0; i < n_monitors; ++i)
3920 XRROutputInfo *info = XRRGetOutputInfo (dpy, resources,
3921 resources->outputs[i]);
3922 Connection conn = info ? info->connection : RR_Disconnected;
3923 RRCrtc id = info ? info->crtc : None;
3925 if (strcmp (info->name, "default") == 0)
3927 /* Non XRandr 1.2 driver, does not give useful data. */
3928 XRRFreeOutputInfo (info);
3929 XRRFreeScreenResources (resources);
3930 free_monitors (monitors, n_monitors);
3931 return Qnil;
3934 if (conn != RR_Disconnected && id != None)
3936 XRRCrtcInfo *crtc = XRRGetCrtcInfo (dpy, resources, id);
3937 struct MonitorInfo *mi = &monitors[i];
3938 XRectangle workarea_r;
3940 if (! crtc)
3942 XRRFreeOutputInfo (info);
3943 continue;
3946 mi->geom.x = crtc->x;
3947 mi->geom.y = crtc->y;
3948 mi->geom.width = crtc->width;
3949 mi->geom.height = crtc->height;
3950 mi->mm_width = info->mm_width;
3951 mi->mm_height = info->mm_height;
3952 mi->name = xstrdup (info->name);
3954 if (pxid != None && pxid == resources->outputs[i])
3955 primary = i;
3956 else if (primary == -1 && strcmp (info->name, "LVDS") == 0)
3957 primary = i;
3959 if (i == primary && x_get_net_workarea (dpyinfo, &workarea_r))
3961 mi->work= workarea_r;
3962 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
3963 mi->work = mi->geom;
3965 else
3966 mi->work = mi->geom;
3968 XRRFreeCrtcInfo (crtc);
3970 XRRFreeOutputInfo (info);
3972 XRRFreeScreenResources (resources);
3974 attributes_list = x_make_monitor_attribute_list (monitors,
3975 n_monitors,
3976 primary,
3977 dpyinfo,
3978 "XRandr");
3979 free_monitors (monitors, n_monitors);
3980 return attributes_list;
3982 #endif /* HAVE_XRANDR */
3984 static Lisp_Object
3985 x_get_monitor_attributes (struct x_display_info *dpyinfo)
3987 Lisp_Object attributes_list = Qnil;
3988 Display *dpy = dpyinfo->display;
3990 (void) dpy; /* Suppress unused variable warning. */
3992 #ifdef HAVE_XRANDR
3993 int xrr_event_base, xrr_error_base;
3994 bool xrr_ok = false;
3995 xrr_ok = XRRQueryExtension (dpy, &xrr_event_base, &xrr_error_base);
3996 if (xrr_ok)
3998 int xrr_major, xrr_minor;
3999 XRRQueryVersion (dpy, &xrr_major, &xrr_minor);
4000 xrr_ok = (xrr_major == 1 && xrr_minor >= 2) || xrr_major > 1;
4003 if (xrr_ok)
4004 attributes_list = x_get_monitor_attributes_xrandr (dpyinfo);
4005 #endif /* HAVE_XRANDR */
4007 #ifdef HAVE_XINERAMA
4008 if (NILP (attributes_list))
4010 int xin_event_base, xin_error_base;
4011 bool xin_ok = false;
4012 xin_ok = XineramaQueryExtension (dpy, &xin_event_base, &xin_error_base);
4013 if (xin_ok && XineramaIsActive (dpy))
4014 attributes_list = x_get_monitor_attributes_xinerama (dpyinfo);
4016 #endif /* HAVE_XINERAMA */
4018 if (NILP (attributes_list))
4019 attributes_list = x_get_monitor_attributes_fallback (dpyinfo);
4021 return attributes_list;
4024 #endif /* !USE_GTK */
4026 DEFUN ("x-display-monitor-attributes-list", Fx_display_monitor_attributes_list,
4027 Sx_display_monitor_attributes_list,
4028 0, 1, 0,
4029 doc: /* Return a list of physical monitor attributes on the X display TERMINAL.
4031 The optional argument TERMINAL specifies which display to ask about.
4032 TERMINAL should be a terminal object, a frame or a display name (a string).
4033 If omitted or nil, that stands for the selected frame's display.
4035 In addition to the standard attribute keys listed in
4036 `display-monitor-attributes-list', the following keys are contained in
4037 the attributes:
4039 source -- String describing the source from which multi-monitor
4040 information is obtained, one of \"Gdk\", \"XRandr\",
4041 \"Xinerama\", or \"fallback\"
4043 Internal use only, use `display-monitor-attributes-list' instead. */)
4044 (Lisp_Object terminal)
4046 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4047 Lisp_Object attributes_list = Qnil;
4049 #ifdef USE_GTK
4050 double mm_width_per_pixel, mm_height_per_pixel;
4051 GdkDisplay *gdpy;
4052 GdkScreen *gscreen;
4053 gint primary_monitor = 0, n_monitors, i;
4054 Lisp_Object monitor_frames, rest, frame;
4055 static const char *source = "Gdk";
4056 struct MonitorInfo *monitors;
4058 block_input ();
4059 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
4060 / x_display_pixel_width (dpyinfo));
4061 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
4062 / x_display_pixel_height (dpyinfo));
4063 gdpy = gdk_x11_lookup_xdisplay (dpyinfo->display);
4064 gscreen = gdk_display_get_default_screen (gdpy);
4065 #if GTK_CHECK_VERSION (2, 20, 0)
4066 primary_monitor = gdk_screen_get_primary_monitor (gscreen);
4067 #endif
4068 n_monitors = gdk_screen_get_n_monitors (gscreen);
4069 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4070 monitors = xzalloc (n_monitors * sizeof *monitors);
4072 FOR_EACH_FRAME (rest, frame)
4074 struct frame *f = XFRAME (frame);
4076 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo
4077 && !EQ (frame, tip_frame))
4079 GdkWindow *gwin = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
4081 i = gdk_screen_get_monitor_at_window (gscreen, gwin);
4082 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
4086 for (i = 0; i < n_monitors; ++i)
4088 gint width_mm = -1, height_mm = -1;
4089 GdkRectangle rec, work;
4090 struct MonitorInfo *mi = &monitors[i];
4092 gdk_screen_get_monitor_geometry (gscreen, i, &rec);
4094 #if GTK_CHECK_VERSION (2, 14, 0)
4095 width_mm = gdk_screen_get_monitor_width_mm (gscreen, i);
4096 height_mm = gdk_screen_get_monitor_height_mm (gscreen, i);
4097 #endif
4098 if (width_mm < 0)
4099 width_mm = rec.width * mm_width_per_pixel + 0.5;
4100 if (height_mm < 0)
4101 height_mm = rec.height * mm_height_per_pixel + 0.5;
4103 #if GTK_CHECK_VERSION (3, 4, 0)
4104 gdk_screen_get_monitor_workarea (gscreen, i, &work);
4105 #else
4106 /* Emulate the behavior of GTK+ 3.4. */
4108 XRectangle workarea_r;
4110 if (i == primary_monitor && x_get_net_workarea (dpyinfo, &workarea_r))
4112 work.x = workarea_r.x;
4113 work.y = workarea_r.y;
4114 work.width = workarea_r.width;
4115 work.height = workarea_r.height;
4116 if (! gdk_rectangle_intersect (&rec, &work, &work))
4117 work = rec;
4119 else
4120 work = rec;
4122 #endif
4125 mi->geom.x = rec.x;
4126 mi->geom.y = rec.y;
4127 mi->geom.width = rec.width;
4128 mi->geom.height = rec.height;
4129 mi->work.x = work.x;
4130 mi->work.y = work.y;
4131 mi->work.width = work.width;
4132 mi->work.height = work.height;
4133 mi->mm_width = width_mm;
4134 mi->mm_height = height_mm;
4136 #if GTK_CHECK_VERSION (2, 14, 0)
4137 mi->name = gdk_screen_get_monitor_plug_name (gscreen, i);
4138 #endif
4141 attributes_list = make_monitor_attribute_list (monitors,
4142 n_monitors,
4143 primary_monitor,
4144 monitor_frames,
4145 source);
4146 unblock_input ();
4147 #else /* not USE_GTK */
4149 block_input ();
4150 attributes_list = x_get_monitor_attributes (dpyinfo);
4151 unblock_input ();
4153 #endif /* not USE_GTK */
4155 return attributes_list;
4158 /************************************************************************
4159 X Displays
4160 ************************************************************************/
4163 /* Mapping visual names to visuals. */
4165 static struct visual_class
4167 const char *name;
4168 int class;
4170 visual_classes[] =
4172 {"StaticGray", StaticGray},
4173 {"GrayScale", GrayScale},
4174 {"StaticColor", StaticColor},
4175 {"PseudoColor", PseudoColor},
4176 {"TrueColor", TrueColor},
4177 {"DirectColor", DirectColor},
4178 {NULL, 0}
4182 #ifndef HAVE_XSCREENNUMBEROFSCREEN
4184 /* Value is the screen number of screen SCR. This is a substitute for
4185 the X function with the same name when that doesn't exist. */
4188 XScreenNumberOfScreen (scr)
4189 register Screen *scr;
4191 Display *dpy = scr->display;
4192 int i;
4194 for (i = 0; i < dpy->nscreens; ++i)
4195 if (scr == dpy->screens + i)
4196 break;
4198 return i;
4201 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
4204 /* Select the visual that should be used on display DPYINFO. Set
4205 members of DPYINFO appropriately. Called from x_term_init. */
4207 void
4208 select_visual (struct x_display_info *dpyinfo)
4210 Display *dpy = dpyinfo->display;
4211 Screen *screen = dpyinfo->screen;
4212 Lisp_Object value;
4214 /* See if a visual is specified. */
4215 value = display_x_get_resource (dpyinfo,
4216 build_string ("visualClass"),
4217 build_string ("VisualClass"),
4218 Qnil, Qnil);
4219 if (STRINGP (value))
4221 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
4222 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
4223 depth, a decimal number. NAME is compared with case ignored. */
4224 char *s = alloca (SBYTES (value) + 1);
4225 char *dash;
4226 int i, class = -1;
4227 XVisualInfo vinfo;
4229 strcpy (s, SSDATA (value));
4230 dash = strchr (s, '-');
4231 if (dash)
4233 dpyinfo->n_planes = atoi (dash + 1);
4234 *dash = '\0';
4236 else
4237 /* We won't find a matching visual with depth 0, so that
4238 an error will be printed below. */
4239 dpyinfo->n_planes = 0;
4241 /* Determine the visual class. */
4242 for (i = 0; visual_classes[i].name; ++i)
4243 if (xstrcasecmp (s, visual_classes[i].name) == 0)
4245 class = visual_classes[i].class;
4246 break;
4249 /* Look up a matching visual for the specified class. */
4250 if (class == -1
4251 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
4252 dpyinfo->n_planes, class, &vinfo))
4253 fatal ("Invalid visual specification `%s'", SDATA (value));
4255 dpyinfo->visual = vinfo.visual;
4257 else
4259 int n_visuals;
4260 XVisualInfo *vinfo, vinfo_template;
4262 dpyinfo->visual = DefaultVisualOfScreen (screen);
4264 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
4265 vinfo_template.screen = XScreenNumberOfScreen (screen);
4266 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
4267 &vinfo_template, &n_visuals);
4268 if (n_visuals <= 0)
4269 fatal ("Can't get proper X visual info");
4271 dpyinfo->n_planes = vinfo->depth;
4272 XFree (vinfo);
4277 /* Return the X display structure for the display named NAME.
4278 Open a new connection if necessary. */
4280 static struct x_display_info *
4281 x_display_info_for_name (Lisp_Object name)
4283 struct x_display_info *dpyinfo;
4285 CHECK_STRING (name);
4287 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
4288 if (!NILP (Fstring_equal (XCAR (dpyinfo->name_list_element), name)))
4289 return dpyinfo;
4291 /* Use this general default value to start with. */
4292 Vx_resource_name = Vinvocation_name;
4294 validate_x_resource_name ();
4296 dpyinfo = x_term_init (name, 0, SSDATA (Vx_resource_name));
4298 if (dpyinfo == 0)
4299 error ("Cannot connect to X server %s", SDATA (name));
4301 XSETFASTINT (Vwindow_system_version, 11);
4303 return dpyinfo;
4307 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4308 1, 3, 0,
4309 doc: /* Open a connection to a display server.
4310 DISPLAY is the name of the display to connect to.
4311 Optional second arg XRM-STRING is a string of resources in xrdb format.
4312 If the optional third arg MUST-SUCCEED is non-nil,
4313 terminate Emacs if we can't open the connection.
4314 \(In the Nextstep version, the last two arguments are currently ignored.) */)
4315 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4317 char *xrm_option;
4318 struct x_display_info *dpyinfo;
4320 CHECK_STRING (display);
4321 if (! NILP (xrm_string))
4322 CHECK_STRING (xrm_string);
4324 xrm_option = NILP (xrm_string) ? 0 : SSDATA (xrm_string);
4326 validate_x_resource_name ();
4328 /* This is what opens the connection and sets x_current_display.
4329 This also initializes many symbols, such as those used for input. */
4330 dpyinfo = x_term_init (display, xrm_option,
4331 SSDATA (Vx_resource_name));
4333 if (dpyinfo == 0)
4335 if (!NILP (must_succeed))
4336 fatal ("Cannot connect to X server %s.\n\
4337 Check the DISPLAY environment variable or use `-d'.\n\
4338 Also use the `xauth' program to verify that you have the proper\n\
4339 authorization information needed to connect the X server.\n\
4340 An insecure way to solve the problem may be to use `xhost'.\n",
4341 SDATA (display));
4342 else
4343 error ("Cannot connect to X server %s", SDATA (display));
4346 XSETFASTINT (Vwindow_system_version, 11);
4347 return Qnil;
4350 DEFUN ("x-close-connection", Fx_close_connection,
4351 Sx_close_connection, 1, 1, 0,
4352 doc: /* Close the connection to TERMINAL's X server.
4353 For TERMINAL, specify a terminal object, a frame or a display name (a
4354 string). If TERMINAL is nil, that stands for the selected frame's
4355 terminal. */)
4356 (Lisp_Object terminal)
4358 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4360 if (dpyinfo->reference_count > 0)
4361 error ("Display still has frames on it");
4363 x_delete_terminal (dpyinfo->terminal);
4365 return Qnil;
4368 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4369 doc: /* Return the list of display names that Emacs has connections to. */)
4370 (void)
4372 Lisp_Object result = Qnil;
4373 struct x_display_info *xdi;
4375 for (xdi = x_display_list; xdi; xdi = xdi->next)
4376 result = Fcons (XCAR (xdi->name_list_element), result);
4378 return result;
4381 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4382 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4383 This function only has an effect on X Windows. With MS Windows, it is
4384 defined but does nothing.
4386 If ON is nil, allow buffering of requests.
4387 Turning on synchronization prohibits the Xlib routines from buffering
4388 requests and seriously degrades performance, but makes debugging much
4389 easier.
4390 The optional second argument TERMINAL specifies which display to act on.
4391 TERMINAL should be a terminal object, a frame or a display name (a string).
4392 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
4393 (Lisp_Object on, Lisp_Object terminal)
4395 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4397 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4399 return Qnil;
4402 /* Wait for responses to all X commands issued so far for frame F. */
4404 void
4405 x_sync (struct frame *f)
4407 block_input ();
4408 XSync (FRAME_X_DISPLAY (f), False);
4409 unblock_input ();
4413 /***********************************************************************
4414 Window properties
4415 ***********************************************************************/
4417 DEFUN ("x-change-window-property", Fx_change_window_property,
4418 Sx_change_window_property, 2, 6, 0,
4419 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4420 PROP must be a string. VALUE may be a string or a list of conses,
4421 numbers and/or strings. If an element in the list is a string, it is
4422 converted to an atom and the value of the atom is used. If an element
4423 is a cons, it is converted to a 32 bit number where the car is the 16
4424 top bits and the cdr is the lower 16 bits.
4426 FRAME nil or omitted means use the selected frame.
4427 If TYPE is given and non-nil, it is the name of the type of VALUE.
4428 If TYPE is not given or nil, the type is STRING.
4429 FORMAT gives the size in bits of each element if VALUE is a list.
4430 It must be one of 8, 16 or 32.
4431 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4432 If OUTER-P is non-nil, the property is changed for the outer X window of
4433 FRAME. Default is to change on the edit X window. */)
4434 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
4435 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
4437 struct frame *f = decode_window_system_frame (frame);
4438 Atom prop_atom;
4439 Atom target_type = XA_STRING;
4440 int element_format = 8;
4441 unsigned char *data;
4442 int nelements;
4443 Window w;
4445 CHECK_STRING (prop);
4447 if (! NILP (format))
4449 CHECK_NUMBER (format);
4451 if (XINT (format) != 8 && XINT (format) != 16
4452 && XINT (format) != 32)
4453 error ("FORMAT must be one of 8, 16 or 32");
4454 element_format = XINT (format);
4457 if (CONSP (value))
4459 ptrdiff_t elsize;
4461 nelements = x_check_property_data (value);
4462 if (nelements == -1)
4463 error ("Bad data in VALUE, must be number, string or cons");
4465 /* The man page for XChangeProperty:
4466 "If the specified format is 32, the property data must be a
4467 long array."
4468 This applies even if long is more than 32 bits. The X library
4469 converts to 32 bits before sending to the X server. */
4470 elsize = element_format == 32 ? sizeof (long) : element_format >> 3;
4471 data = xnmalloc (nelements, elsize);
4473 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4475 else
4477 CHECK_STRING (value);
4478 data = SDATA (value);
4479 if (INT_MAX < SBYTES (value))
4480 error ("VALUE too long");
4481 nelements = SBYTES (value);
4484 block_input ();
4485 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4486 if (! NILP (type))
4488 CHECK_STRING (type);
4489 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4492 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4493 else w = FRAME_X_WINDOW (f);
4495 XChangeProperty (FRAME_X_DISPLAY (f), w,
4496 prop_atom, target_type, element_format, PropModeReplace,
4497 data, nelements);
4499 if (CONSP (value)) xfree (data);
4501 /* Make sure the property is set when we return. */
4502 XFlush (FRAME_X_DISPLAY (f));
4503 unblock_input ();
4505 return value;
4509 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4510 Sx_delete_window_property, 1, 2, 0,
4511 doc: /* Remove window property PROP from X window of FRAME.
4512 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4513 (Lisp_Object prop, Lisp_Object frame)
4515 struct frame *f = decode_window_system_frame (frame);
4516 Atom prop_atom;
4518 CHECK_STRING (prop);
4519 block_input ();
4520 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4521 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4523 /* Make sure the property is removed when we return. */
4524 XFlush (FRAME_X_DISPLAY (f));
4525 unblock_input ();
4527 return prop;
4531 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4532 1, 6, 0,
4533 doc: /* Value is the value of window property PROP on FRAME.
4534 If FRAME is nil or omitted, use the selected frame.
4536 On X Windows, the following optional arguments are also accepted:
4537 If TYPE is nil or omitted, get the property as a string.
4538 Otherwise TYPE is the name of the atom that denotes the type expected.
4539 If SOURCE is non-nil, get the property on that window instead of from
4540 FRAME. The number 0 denotes the root window.
4541 If DELETE-P is non-nil, delete the property after retrieving it.
4542 If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
4544 On MS Windows, this function accepts but ignores those optional arguments.
4546 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4547 no value of TYPE (always string in the MS Windows case). */)
4548 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
4549 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
4551 struct frame *f = decode_window_system_frame (frame);
4552 Atom prop_atom;
4553 int rc;
4554 Lisp_Object prop_value = Qnil;
4555 unsigned char *tmp_data = NULL;
4556 Atom actual_type;
4557 Atom target_type = XA_STRING;
4558 int actual_format;
4559 unsigned long actual_size, bytes_remaining;
4560 Window target_window = FRAME_X_WINDOW (f);
4561 struct gcpro gcpro1;
4563 GCPRO1 (prop_value);
4564 CHECK_STRING (prop);
4566 if (! NILP (source))
4568 CONS_TO_INTEGER (source, Window, target_window);
4569 if (! target_window)
4570 target_window = FRAME_DISPLAY_INFO (f)->root_window;
4573 block_input ();
4574 if (STRINGP (type))
4576 if (strcmp ("AnyPropertyType", SSDATA (type)) == 0)
4577 target_type = AnyPropertyType;
4578 else
4579 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4582 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4583 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4584 prop_atom, 0, 0, False, target_type,
4585 &actual_type, &actual_format, &actual_size,
4586 &bytes_remaining, &tmp_data);
4587 if (rc == Success)
4589 int size = bytes_remaining;
4591 XFree (tmp_data);
4592 tmp_data = NULL;
4594 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4595 prop_atom, 0, bytes_remaining,
4596 ! NILP (delete_p), target_type,
4597 &actual_type, &actual_format,
4598 &actual_size, &bytes_remaining,
4599 &tmp_data);
4600 if (rc == Success && tmp_data)
4602 /* The man page for XGetWindowProperty says:
4603 "If the returned format is 32, the returned data is represented
4604 as a long array and should be cast to that type to obtain the
4605 elements."
4606 This applies even if long is more than 32 bits, the X library
4607 converts from 32 bit elements received from the X server to long
4608 and passes the long array to us. Thus, for that case memcpy can not
4609 be used. We convert to a 32 bit type here, because so much code
4610 assume on that.
4612 The bytes and offsets passed to XGetWindowProperty refers to the
4613 property and those are indeed in 32 bit quantities if format is
4614 32. */
4616 if (BITS_PER_LONG > 32 && actual_format == 32)
4618 unsigned long i;
4619 int *idata = (int *) tmp_data;
4620 long *ldata = (long *) tmp_data;
4622 for (i = 0; i < actual_size; ++i)
4623 idata[i] = (int) ldata[i];
4626 if (NILP (vector_ret_p))
4627 prop_value = make_string ((char *) tmp_data, size);
4628 else
4629 prop_value = x_property_data_to_lisp (f,
4630 tmp_data,
4631 actual_type,
4632 actual_format,
4633 actual_size);
4636 if (tmp_data) XFree (tmp_data);
4639 unblock_input ();
4640 UNGCPRO;
4641 return prop_value;
4646 /***********************************************************************
4647 Busy cursor
4648 ***********************************************************************/
4650 /* Timer function of hourglass_atimer. TIMER is equal to
4651 hourglass_atimer.
4653 Display an hourglass pointer on all frames by mapping the frames'
4654 hourglass_window. Set the hourglass_p flag in the frames'
4655 output_data.x structure to indicate that an hourglass cursor is
4656 shown on the frames. */
4658 void
4659 show_hourglass (struct atimer *timer)
4661 /* The timer implementation will cancel this timer automatically
4662 after this function has run. Set hourglass_atimer to null
4663 so that we know the timer doesn't have to be canceled. */
4664 hourglass_atimer = NULL;
4666 if (!hourglass_shown_p)
4668 Lisp_Object rest, frame;
4670 block_input ();
4672 FOR_EACH_FRAME (rest, frame)
4674 struct frame *f = XFRAME (frame);
4676 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4678 Display *dpy = FRAME_X_DISPLAY (f);
4680 #ifdef USE_X_TOOLKIT
4681 if (f->output_data.x->widget)
4682 #else
4683 if (FRAME_OUTER_WINDOW (f))
4684 #endif
4686 f->output_data.x->hourglass_p = 1;
4688 if (!f->output_data.x->hourglass_window)
4690 unsigned long mask = CWCursor;
4691 XSetWindowAttributes attrs;
4692 #ifdef USE_GTK
4693 Window parent = FRAME_X_WINDOW (f);
4694 #else
4695 Window parent = FRAME_OUTER_WINDOW (f);
4696 #endif
4697 attrs.cursor = f->output_data.x->hourglass_cursor;
4699 f->output_data.x->hourglass_window
4700 = XCreateWindow (dpy, parent,
4701 0, 0, 32000, 32000, 0, 0,
4702 InputOnly,
4703 CopyFromParent,
4704 mask, &attrs);
4707 XMapRaised (dpy, f->output_data.x->hourglass_window);
4708 XFlush (dpy);
4713 hourglass_shown_p = 1;
4714 unblock_input ();
4719 /* Hide the hourglass pointer on all frames, if it is currently
4720 shown. */
4722 void
4723 hide_hourglass (void)
4725 if (hourglass_shown_p)
4727 Lisp_Object rest, frame;
4729 block_input ();
4730 FOR_EACH_FRAME (rest, frame)
4732 struct frame *f = XFRAME (frame);
4734 if (FRAME_X_P (f)
4735 /* Watch out for newly created frames. */
4736 && f->output_data.x->hourglass_window)
4738 XUnmapWindow (FRAME_X_DISPLAY (f),
4739 f->output_data.x->hourglass_window);
4740 /* Sync here because XTread_socket looks at the
4741 hourglass_p flag that is reset to zero below. */
4742 XSync (FRAME_X_DISPLAY (f), False);
4743 f->output_data.x->hourglass_p = 0;
4747 hourglass_shown_p = 0;
4748 unblock_input ();
4754 /***********************************************************************
4755 Tool tips
4756 ***********************************************************************/
4758 static Lisp_Object x_create_tip_frame (struct x_display_info *,
4759 Lisp_Object, Lisp_Object);
4760 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
4761 Lisp_Object, int, int, int *, int *);
4763 /* The frame of a currently visible tooltip. */
4765 Lisp_Object tip_frame;
4767 /* If non-nil, a timer started that hides the last tooltip when it
4768 fires. */
4770 static Lisp_Object tip_timer;
4771 Window tip_window;
4773 /* If non-nil, a vector of 3 elements containing the last args
4774 with which x-show-tip was called. See there. */
4776 static Lisp_Object last_show_tip_args;
4779 static void
4780 unwind_create_tip_frame (Lisp_Object frame)
4782 Lisp_Object deleted;
4784 deleted = unwind_create_frame (frame);
4785 if (EQ (deleted, Qt))
4787 tip_window = None;
4788 tip_frame = Qnil;
4793 /* Create a frame for a tooltip on the display described by DPYINFO.
4794 PARMS is a list of frame parameters. TEXT is the string to
4795 display in the tip frame. Value is the frame.
4797 Note that functions called here, esp. x_default_parameter can
4798 signal errors, for instance when a specified color name is
4799 undefined. We have to make sure that we're in a consistent state
4800 when this happens. */
4802 static Lisp_Object
4803 x_create_tip_frame (struct x_display_info *dpyinfo,
4804 Lisp_Object parms,
4805 Lisp_Object text)
4807 struct frame *f;
4808 Lisp_Object frame;
4809 Lisp_Object name;
4810 int width, height;
4811 ptrdiff_t count = SPECPDL_INDEX ();
4812 struct gcpro gcpro1, gcpro2, gcpro3;
4813 int face_change_count_before = face_change_count;
4814 Lisp_Object buffer;
4815 struct buffer *old_buffer;
4817 if (!dpyinfo->terminal->name)
4818 error ("Terminal is not live, can't create new frames on it");
4820 parms = Fcopy_alist (parms);
4822 /* Get the name of the frame to use for resource lookup. */
4823 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4824 if (!STRINGP (name)
4825 && !EQ (name, Qunbound)
4826 && !NILP (name))
4827 error ("Invalid frame name--not a string or nil");
4829 frame = Qnil;
4830 GCPRO3 (parms, name, frame);
4831 f = make_frame (1);
4832 XSETFRAME (frame, f);
4834 buffer = Fget_buffer_create (build_string (" *tip*"));
4835 /* Use set_window_buffer instead of Fset_window_buffer (see
4836 discussion of bug#11984, bug#12025, bug#12026). */
4837 set_window_buffer (FRAME_ROOT_WINDOW (f), buffer, 0, 0);
4838 old_buffer = current_buffer;
4839 set_buffer_internal_1 (XBUFFER (buffer));
4840 bset_truncate_lines (current_buffer, Qnil);
4841 specbind (Qinhibit_read_only, Qt);
4842 specbind (Qinhibit_modification_hooks, Qt);
4843 Ferase_buffer ();
4844 Finsert (1, &text);
4845 set_buffer_internal_1 (old_buffer);
4847 record_unwind_protect (unwind_create_tip_frame, frame);
4849 f->terminal = dpyinfo->terminal;
4851 /* By setting the output method, we're essentially saying that
4852 the frame is live, as per FRAME_LIVE_P. If we get a signal
4853 from this point on, x_destroy_window might screw up reference
4854 counts etc. */
4855 f->output_method = output_x_window;
4856 f->output_data.x = xzalloc (sizeof *f->output_data.x);
4857 f->output_data.x->icon_bitmap = -1;
4858 FRAME_FONTSET (f) = -1;
4859 f->output_data.x->scroll_bar_foreground_pixel = -1;
4860 f->output_data.x->scroll_bar_background_pixel = -1;
4861 #ifdef USE_TOOLKIT_SCROLL_BARS
4862 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
4863 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
4864 #endif /* USE_TOOLKIT_SCROLL_BARS */
4865 f->output_data.x->white_relief.pixel = -1;
4866 f->output_data.x->black_relief.pixel = -1;
4868 fset_icon_name (f, Qnil);
4869 FRAME_DISPLAY_INFO (f) = dpyinfo;
4870 f->output_data.x->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
4871 f->output_data.x->explicit_parent = 0;
4873 /* These colors will be set anyway later, but it's important
4874 to get the color reference counts right, so initialize them! */
4876 Lisp_Object black;
4877 struct gcpro gcpro1;
4879 /* Function x_decode_color can signal an error. Make
4880 sure to initialize color slots so that we won't try
4881 to free colors we haven't allocated. */
4882 FRAME_FOREGROUND_PIXEL (f) = -1;
4883 FRAME_BACKGROUND_PIXEL (f) = -1;
4884 f->output_data.x->cursor_pixel = -1;
4885 f->output_data.x->cursor_foreground_pixel = -1;
4886 f->output_data.x->border_pixel = -1;
4887 f->output_data.x->mouse_pixel = -1;
4889 black = build_string ("black");
4890 GCPRO1 (black);
4891 FRAME_FOREGROUND_PIXEL (f)
4892 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4893 FRAME_BACKGROUND_PIXEL (f)
4894 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4895 f->output_data.x->cursor_pixel
4896 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4897 f->output_data.x->cursor_foreground_pixel
4898 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4899 f->output_data.x->border_pixel
4900 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4901 f->output_data.x->mouse_pixel
4902 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4903 UNGCPRO;
4906 /* Set the name; the functions to which we pass f expect the name to
4907 be set. */
4908 if (EQ (name, Qunbound) || NILP (name))
4910 fset_name (f, build_string (dpyinfo->x_id_name));
4911 f->explicit_name = 0;
4913 else
4915 fset_name (f, name);
4916 f->explicit_name = 1;
4917 /* use the frame's title when getting resources for this frame. */
4918 specbind (Qx_resource_name, name);
4921 register_font_driver (&xfont_driver, f);
4922 #ifdef HAVE_FREETYPE
4923 #ifdef HAVE_XFT
4924 register_font_driver (&xftfont_driver, f);
4925 #else /* not HAVE_XFT */
4926 register_font_driver (&ftxfont_driver, f);
4927 #endif /* not HAVE_XFT */
4928 #endif /* HAVE_FREETYPE */
4930 x_default_parameter (f, parms, Qfont_backend, Qnil,
4931 "fontBackend", "FontBackend", RES_TYPE_STRING);
4933 /* Extract the window parameters from the supplied values that are
4934 needed to determine window geometry. */
4935 x_default_font_parameter (f, parms);
4937 x_default_parameter (f, parms, Qborder_width, make_number (0),
4938 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4940 /* This defaults to 2 in order to match xterm. We recognize either
4941 internalBorderWidth or internalBorder (which is what xterm calls
4942 it). */
4943 if (NILP (Fassq (Qinternal_border_width, parms)))
4945 Lisp_Object value;
4947 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4948 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4949 if (! EQ (value, Qunbound))
4950 parms = Fcons (Fcons (Qinternal_border_width, value),
4951 parms);
4954 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4955 "internalBorderWidth", "internalBorderWidth",
4956 RES_TYPE_NUMBER);
4957 x_default_parameter (f, parms, Qright_divider_width, make_number (0),
4958 NULL, NULL, RES_TYPE_NUMBER);
4959 x_default_parameter (f, parms, Qbottom_divider_width, make_number (0),
4960 NULL, NULL, RES_TYPE_NUMBER);
4962 /* Also do the stuff which must be set before the window exists. */
4963 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4964 "foreground", "Foreground", RES_TYPE_STRING);
4965 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4966 "background", "Background", RES_TYPE_STRING);
4967 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4968 "pointerColor", "Foreground", RES_TYPE_STRING);
4969 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4970 "cursorColor", "Foreground", RES_TYPE_STRING);
4971 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4972 "borderColor", "BorderColor", RES_TYPE_STRING);
4974 #ifdef GLYPH_DEBUG
4975 image_cache_refcount =
4976 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
4977 dpyinfo_refcount = dpyinfo->reference_count;
4978 #endif /* GLYPH_DEBUG */
4980 /* Init faces before x_default_parameter is called for scroll-bar
4981 parameters because that function calls x_set_scroll_bar_width,
4982 which calls change_frame_size, which calls Fset_window_buffer,
4983 which runs hooks, which call Fvertical_motion. At the end, we
4984 end up in init_iterator with a null face cache, which should not
4985 happen. */
4986 init_frame_faces (f);
4988 f->output_data.x->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
4990 x_figure_window_size (f, parms, 0);
4993 XSetWindowAttributes attrs;
4994 unsigned long mask;
4995 Atom type = FRAME_DISPLAY_INFO (f)->Xatom_net_window_type_tooltip;
4997 block_input ();
4998 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
4999 if (DoesSaveUnders (dpyinfo->screen))
5000 mask |= CWSaveUnder;
5002 /* Window managers look at the override-redirect flag to determine
5003 whether or net to give windows a decoration (Xlib spec, chapter
5004 3.2.8). */
5005 attrs.override_redirect = True;
5006 attrs.save_under = True;
5007 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
5008 /* Arrange for getting MapNotify and UnmapNotify events. */
5009 attrs.event_mask = StructureNotifyMask;
5010 tip_window
5011 = FRAME_X_WINDOW (f)
5012 = XCreateWindow (FRAME_X_DISPLAY (f),
5013 FRAME_DISPLAY_INFO (f)->root_window,
5014 /* x, y, width, height */
5015 0, 0, 1, 1,
5016 /* Border. */
5017 f->border_width,
5018 CopyFromParent, InputOutput, CopyFromParent,
5019 mask, &attrs);
5020 XChangeProperty (FRAME_X_DISPLAY (f), tip_window,
5021 FRAME_DISPLAY_INFO (f)->Xatom_net_window_type,
5022 XA_ATOM, 32, PropModeReplace,
5023 (unsigned char *)&type, 1);
5024 unblock_input ();
5027 x_make_gc (f);
5029 x_default_parameter (f, parms, Qauto_raise, Qnil,
5030 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5031 x_default_parameter (f, parms, Qauto_lower, Qnil,
5032 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5033 x_default_parameter (f, parms, Qcursor_type, Qbox,
5034 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5036 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
5037 Change will not be effected unless different from the current
5038 FRAME_LINES (f). */
5039 width = FRAME_COLS (f);
5040 height = FRAME_LINES (f);
5041 SET_FRAME_COLS (f, 0);
5042 FRAME_LINES (f) = 0;
5043 change_frame_size (f, width, height, 1, 0, 0, 0);
5045 /* Add `tooltip' frame parameter's default value. */
5046 if (NILP (Fframe_parameter (frame, Qtooltip)))
5047 Fmodify_frame_parameters (frame, list1 (Fcons (Qtooltip, Qt)));
5049 /* FIXME - can this be done in a similar way to normal frames?
5050 http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00641.html */
5052 /* Set the `display-type' frame parameter before setting up faces. */
5054 Lisp_Object disptype;
5056 if (FRAME_DISPLAY_INFO (f)->n_planes == 1)
5057 disptype = intern ("mono");
5058 else if (FRAME_DISPLAY_INFO (f)->visual->class == GrayScale
5059 || FRAME_DISPLAY_INFO (f)->visual->class == StaticGray)
5060 disptype = intern ("grayscale");
5061 else
5062 disptype = intern ("color");
5064 if (NILP (Fframe_parameter (frame, Qdisplay_type)))
5065 Fmodify_frame_parameters (frame, list1 (Fcons (Qdisplay_type, disptype)));
5068 /* Set up faces after all frame parameters are known. This call
5069 also merges in face attributes specified for new frames.
5071 Frame parameters may be changed if .Xdefaults contains
5072 specifications for the default font. For example, if there is an
5073 `Emacs.default.attributeBackground: pink', the `background-color'
5074 attribute of the frame get's set, which let's the internal border
5075 of the tooltip frame appear in pink. Prevent this. */
5077 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
5079 /* Set tip_frame here, so that */
5080 tip_frame = frame;
5081 call2 (Qface_set_after_frame_default, frame, Qnil);
5083 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
5084 Fmodify_frame_parameters (frame, list1 (Fcons (Qbackground_color, bg)));
5087 f->no_split = 1;
5089 UNGCPRO;
5091 /* Now that the frame will be official, it counts as a reference to
5092 its display and terminal. */
5093 FRAME_DISPLAY_INFO (f)->reference_count++;
5094 f->terminal->reference_count++;
5096 /* It is now ok to make the frame official even if we get an error
5097 below. And the frame needs to be on Vframe_list or making it
5098 visible won't work. */
5099 Vframe_list = Fcons (frame, Vframe_list);
5102 /* Setting attributes of faces of the tooltip frame from resources
5103 and similar will increment face_change_count, which leads to the
5104 clearing of all current matrices. Since this isn't necessary
5105 here, avoid it by resetting face_change_count to the value it
5106 had before we created the tip frame. */
5107 face_change_count = face_change_count_before;
5109 /* Discard the unwind_protect. */
5110 return unbind_to (count, frame);
5114 /* Compute where to display tip frame F. PARMS is the list of frame
5115 parameters for F. DX and DY are specified offsets from the current
5116 location of the mouse. WIDTH and HEIGHT are the width and height
5117 of the tooltip. Return coordinates relative to the root window of
5118 the display in *ROOT_X, and *ROOT_Y. */
5120 static void
5121 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)
5123 Lisp_Object left, top;
5124 int win_x, win_y;
5125 Window root, child;
5126 unsigned pmask;
5128 /* User-specified position? */
5129 left = Fcdr (Fassq (Qleft, parms));
5130 top = Fcdr (Fassq (Qtop, parms));
5132 /* Move the tooltip window where the mouse pointer is. Resize and
5133 show it. */
5134 if (!INTEGERP (left) || !INTEGERP (top))
5136 block_input ();
5137 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_DISPLAY_INFO (f)->root_window,
5138 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
5139 unblock_input ();
5142 if (INTEGERP (top))
5143 *root_y = XINT (top);
5144 else if (*root_y + XINT (dy) <= 0)
5145 *root_y = 0; /* Can happen for negative dy */
5146 else if (*root_y + XINT (dy) + height
5147 <= x_display_pixel_height (FRAME_DISPLAY_INFO (f)))
5148 /* It fits below the pointer */
5149 *root_y += XINT (dy);
5150 else if (height + XINT (dy) <= *root_y)
5151 /* It fits above the pointer. */
5152 *root_y -= height + XINT (dy);
5153 else
5154 /* Put it on the top. */
5155 *root_y = 0;
5157 if (INTEGERP (left))
5158 *root_x = XINT (left);
5159 else if (*root_x + XINT (dx) <= 0)
5160 *root_x = 0; /* Can happen for negative dx */
5161 else if (*root_x + XINT (dx) + width
5162 <= x_display_pixel_width (FRAME_DISPLAY_INFO (f)))
5163 /* It fits to the right of the pointer. */
5164 *root_x += XINT (dx);
5165 else if (width + XINT (dx) <= *root_x)
5166 /* It fits to the left of the pointer. */
5167 *root_x -= width + XINT (dx);
5168 else
5169 /* Put it left-justified on the screen--it ought to fit that way. */
5170 *root_x = 0;
5174 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5175 doc: /* Show STRING in a "tooltip" window on frame FRAME.
5176 A tooltip window is a small X window displaying a string.
5178 This is an internal function; Lisp code should call `tooltip-show'.
5180 FRAME nil or omitted means use the selected frame.
5182 PARMS is an optional list of frame parameters which can be used to
5183 change the tooltip's appearance.
5185 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5186 means use the default timeout of 5 seconds.
5188 If the list of frame parameters PARMS contains a `left' parameters,
5189 the tooltip is displayed at that x-position. Otherwise it is
5190 displayed at the mouse position, with offset DX added (default is 5 if
5191 DX isn't specified). Likewise for the y-position; if a `top' frame
5192 parameter is specified, it determines the y-position of the tooltip
5193 window, otherwise it is displayed at the mouse position, with offset
5194 DY added (default is -10).
5196 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5197 Text larger than the specified size is clipped. */)
5198 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
5200 struct frame *f;
5201 struct window *w;
5202 int root_x, root_y;
5203 struct buffer *old_buffer;
5204 struct text_pos pos;
5205 int i, width, height, seen_reversed_p;
5206 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5207 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5208 ptrdiff_t count = SPECPDL_INDEX ();
5210 specbind (Qinhibit_redisplay, Qt);
5212 GCPRO4 (string, parms, frame, timeout);
5214 CHECK_STRING (string);
5215 if (SCHARS (string) == 0)
5216 string = make_unibyte_string (" ", 1);
5218 f = decode_window_system_frame (frame);
5219 if (NILP (timeout))
5220 timeout = make_number (5);
5221 else
5222 CHECK_NATNUM (timeout);
5224 if (NILP (dx))
5225 dx = make_number (5);
5226 else
5227 CHECK_NUMBER (dx);
5229 if (NILP (dy))
5230 dy = make_number (-10);
5231 else
5232 CHECK_NUMBER (dy);
5234 #ifdef USE_GTK
5235 if (x_gtk_use_system_tooltips)
5237 bool ok;
5239 /* Hide a previous tip, if any. */
5240 Fx_hide_tip ();
5242 block_input ();
5243 ok = xg_prepare_tooltip (f, string, &width, &height);
5244 if (ok)
5246 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5247 xg_show_tooltip (f, root_x, root_y);
5248 /* This is used in Fx_hide_tip. */
5249 XSETFRAME (tip_frame, f);
5251 unblock_input ();
5252 if (ok) goto start_timer;
5254 #endif /* USE_GTK */
5256 if (NILP (last_show_tip_args))
5257 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5259 if (!NILP (tip_frame))
5261 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5262 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5263 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5265 if (EQ (frame, last_frame)
5266 && !NILP (Fequal (last_string, string))
5267 && !NILP (Fequal (last_parms, parms)))
5269 struct frame *tip_f = XFRAME (tip_frame);
5271 /* Only DX and DY have changed. */
5272 if (!NILP (tip_timer))
5274 Lisp_Object timer = tip_timer;
5275 tip_timer = Qnil;
5276 call1 (Qcancel_timer, timer);
5279 block_input ();
5280 compute_tip_xy (tip_f, parms, dx, dy, FRAME_PIXEL_WIDTH (tip_f),
5281 FRAME_PIXEL_HEIGHT (tip_f), &root_x, &root_y);
5282 XMoveWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
5283 root_x, root_y);
5284 unblock_input ();
5285 goto start_timer;
5289 /* Hide a previous tip, if any. */
5290 Fx_hide_tip ();
5292 ASET (last_show_tip_args, 0, string);
5293 ASET (last_show_tip_args, 1, frame);
5294 ASET (last_show_tip_args, 2, parms);
5296 /* Add default values to frame parameters. */
5297 if (NILP (Fassq (Qname, parms)))
5298 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5299 if (NILP (Fassq (Qinternal_border_width, parms)))
5300 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5301 if (NILP (Fassq (Qborder_width, parms)))
5302 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5303 if (NILP (Fassq (Qbottom_divider_width, parms)))
5304 parms = Fcons (Fcons (Qbottom_divider_width, make_number (0)), parms);
5305 if (NILP (Fassq (Qright_divider_width, parms)))
5306 parms = Fcons (Fcons (Qright_divider_width, make_number (0)), parms);
5307 if (NILP (Fassq (Qborder_color, parms)))
5308 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5309 if (NILP (Fassq (Qbackground_color, parms)))
5310 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5311 parms);
5313 /* Create a frame for the tooltip, and record it in the global
5314 variable tip_frame. */
5315 frame = x_create_tip_frame (FRAME_DISPLAY_INFO (f), parms, string);
5316 f = XFRAME (frame);
5318 /* Set up the frame's root window. */
5319 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5320 w->left_col = 0;
5321 w->top_line = 0;
5322 w->pixel_left = 0;
5323 w->pixel_top = 0;
5325 if (CONSP (Vx_max_tooltip_size)
5326 && RANGED_INTEGERP (1, XCAR (Vx_max_tooltip_size), INT_MAX)
5327 && RANGED_INTEGERP (1, XCDR (Vx_max_tooltip_size), INT_MAX))
5329 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
5330 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
5332 else
5334 w->total_cols = 80;
5335 w->total_lines = 40;
5338 w->pixel_width = w->total_cols * FRAME_COLUMN_WIDTH (f);
5339 w->pixel_height = w->total_lines * FRAME_LINE_HEIGHT (f);
5341 FRAME_TOTAL_COLS (f) = w->total_cols;
5342 adjust_frame_glyphs (f);
5343 w->pseudo_window_p = 1;
5345 /* Display the tooltip text in a temporary buffer. */
5346 old_buffer = current_buffer;
5347 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->contents));
5348 bset_truncate_lines (current_buffer, Qnil);
5349 clear_glyph_matrix (w->desired_matrix);
5350 clear_glyph_matrix (w->current_matrix);
5351 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5352 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
5354 /* Compute width and height of the tooltip. */
5355 width = height = seen_reversed_p = 0;
5356 for (i = 0; i < w->desired_matrix->nrows; ++i)
5358 struct glyph_row *row = &w->desired_matrix->rows[i];
5359 struct glyph *last;
5360 int row_width;
5362 /* Stop at the first empty row at the end. */
5363 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
5364 break;
5366 /* Let the row go over the full width of the frame. */
5367 row->full_width_p = 1;
5369 row_width = row->pixel_width;
5370 if (row->used[TEXT_AREA])
5372 /* There's a glyph at the end of rows that is used to place
5373 the cursor there. Don't include the width of this glyph. */
5374 if (!row->reversed_p)
5376 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5377 if (INTEGERP (last->object))
5378 row_width -= last->pixel_width;
5380 else
5382 /* There could be a stretch glyph at the beginning of R2L
5383 rows that is produced by extend_face_to_end_of_line.
5384 Don't count that glyph. */
5385 struct glyph *g = row->glyphs[TEXT_AREA];
5387 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
5389 row_width -= g->pixel_width;
5390 seen_reversed_p = 1;
5395 height += row->height;
5396 width = max (width, row_width);
5399 /* If we've seen partial-length R2L rows, we need to re-adjust the
5400 tool-tip frame width and redisplay it again, to avoid over-wide
5401 tips due to the stretch glyph that extends R2L lines to full
5402 width of the frame. */
5403 if (seen_reversed_p)
5405 /* w->total_cols and FRAME_TOTAL_COLS want the width in columns,
5406 not in pixels. */
5407 w->pixel_width = width;
5408 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
5409 w->total_cols = width;
5410 FRAME_TOTAL_COLS (f) = width;
5411 SET_FRAME_WIDTH (f, width);
5412 adjust_frame_glyphs (f);
5413 clear_glyph_matrix (w->desired_matrix);
5414 clear_glyph_matrix (w->current_matrix);
5415 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5416 width = height = 0;
5417 /* Recompute width and height of the tooltip. */
5418 for (i = 0; i < w->desired_matrix->nrows; ++i)
5420 struct glyph_row *row = &w->desired_matrix->rows[i];
5421 struct glyph *last;
5422 int row_width;
5424 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
5425 break;
5426 row->full_width_p = 1;
5427 row_width = row->pixel_width;
5428 if (row->used[TEXT_AREA] && !row->reversed_p)
5430 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5431 if (INTEGERP (last->object))
5432 row_width -= last->pixel_width;
5435 height += row->height;
5436 width = max (width, row_width);
5440 /* Add the frame's internal border to the width and height the X
5441 window should have. */
5442 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5443 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5445 /* Move the tooltip window where the mouse pointer is. Resize and
5446 show it. */
5447 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5449 block_input ();
5450 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5451 root_x, root_y, width, height);
5452 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5453 unblock_input ();
5455 /* Draw into the window. */
5456 w->must_be_updated_p = 1;
5457 update_single_window (w, 1);
5459 /* Restore original current buffer. */
5460 set_buffer_internal_1 (old_buffer);
5461 windows_or_buffers_changed = old_windows_or_buffers_changed;
5463 start_timer:
5464 /* Let the tip disappear after timeout seconds. */
5465 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5466 intern ("x-hide-tip"));
5468 UNGCPRO;
5469 return unbind_to (count, Qnil);
5473 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5474 doc: /* Hide the current tooltip window, if there is any.
5475 Value is t if tooltip was open, nil otherwise. */)
5476 (void)
5478 ptrdiff_t count;
5479 Lisp_Object deleted, frame, timer;
5480 struct gcpro gcpro1, gcpro2;
5482 /* Return quickly if nothing to do. */
5483 if (NILP (tip_timer) && NILP (tip_frame))
5484 return Qnil;
5486 frame = tip_frame;
5487 timer = tip_timer;
5488 GCPRO2 (frame, timer);
5489 tip_frame = tip_timer = deleted = Qnil;
5491 count = SPECPDL_INDEX ();
5492 specbind (Qinhibit_redisplay, Qt);
5493 specbind (Qinhibit_quit, Qt);
5495 if (!NILP (timer))
5496 call1 (Qcancel_timer, timer);
5498 #ifdef USE_GTK
5500 /* When using system tooltip, tip_frame is the Emacs frame on which
5501 the tip is shown. */
5502 struct frame *f = XFRAME (frame);
5503 if (FRAME_LIVE_P (f) && xg_hide_tooltip (f))
5504 frame = Qnil;
5506 #endif
5508 if (FRAMEP (frame))
5510 delete_frame (frame, Qnil);
5511 deleted = Qt;
5513 #ifdef USE_LUCID
5514 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5515 redisplay procedure is not called when a tip frame over menu
5516 items is unmapped. Redisplay the menu manually... */
5518 Widget w;
5519 struct frame *f = SELECTED_FRAME ();
5520 w = f->output_data.x->menubar_widget;
5522 if (!DoesSaveUnders (FRAME_DISPLAY_INFO (f)->screen)
5523 && w != NULL)
5525 block_input ();
5526 xlwmenu_redisplay (w);
5527 unblock_input ();
5530 #endif /* USE_LUCID */
5533 UNGCPRO;
5534 return unbind_to (count, deleted);
5539 /***********************************************************************
5540 File selection dialog
5541 ***********************************************************************/
5543 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5544 Sx_uses_old_gtk_dialog,
5545 0, 0, 0,
5546 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5547 (void)
5549 #ifdef USE_GTK
5550 if (use_dialog_box
5551 && use_file_dialog
5552 && window_system_available (SELECTED_FRAME ())
5553 && xg_uses_old_file_dialog ())
5554 return Qt;
5555 #endif
5556 return Qnil;
5560 #ifdef USE_MOTIF
5561 /* Callback for "OK" and "Cancel" on file selection dialog. */
5563 static void
5564 file_dialog_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5566 int *result = client_data;
5567 XmAnyCallbackStruct *cb = call_data;
5568 *result = cb->reason;
5572 /* Callback for unmapping a file selection dialog. This is used to
5573 capture the case where a dialog is closed via a window manager's
5574 closer button, for example. Using a XmNdestroyCallback didn't work
5575 in this case. */
5577 static void
5578 file_dialog_unmap_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5580 int *result = client_data;
5581 *result = XmCR_CANCEL;
5584 static void
5585 clean_up_file_dialog (void *arg)
5587 Widget dialog = arg;
5589 /* Clean up. */
5590 block_input ();
5591 XtUnmanageChild (dialog);
5592 XtDestroyWidget (dialog);
5593 x_menu_set_in_use (0);
5594 unblock_input ();
5598 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5599 doc: /* Read file name, prompting with PROMPT in directory DIR.
5600 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5601 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5602 or directory must exist.
5604 This function is only defined on NS, MS Windows, and X Windows with the
5605 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5606 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5607 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename,
5608 Lisp_Object mustmatch, Lisp_Object only_dir_p)
5610 int result;
5611 struct frame *f = SELECTED_FRAME ();
5612 Lisp_Object file = Qnil;
5613 Lisp_Object decoded_file;
5614 Widget dialog, text, help;
5615 Arg al[10];
5616 int ac = 0;
5617 XmString dir_xmstring, pattern_xmstring;
5618 ptrdiff_t count = SPECPDL_INDEX ();
5619 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5621 check_window_system (f);
5623 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5625 if (popup_activated ())
5626 error ("Trying to use a menu from within a menu-entry");
5628 CHECK_STRING (prompt);
5629 CHECK_STRING (dir);
5631 /* Prevent redisplay. */
5632 specbind (Qinhibit_redisplay, Qt);
5634 block_input ();
5636 /* Create the dialog with PROMPT as title, using DIR as initial
5637 directory and using "*" as pattern. */
5638 dir = Fexpand_file_name (dir, Qnil);
5639 dir_xmstring = XmStringCreateLocalized (SSDATA (dir));
5640 pattern_xmstring = XmStringCreateLocalized ("*");
5642 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5643 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5644 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5645 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5646 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5647 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5648 "fsb", al, ac);
5649 XmStringFree (dir_xmstring);
5650 XmStringFree (pattern_xmstring);
5652 /* Add callbacks for OK and Cancel. */
5653 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5654 (XtPointer) &result);
5655 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5656 (XtPointer) &result);
5657 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5658 (XtPointer) &result);
5660 /* Remove the help button since we can't display help. */
5661 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5662 XtUnmanageChild (help);
5664 /* Mark OK button as default. */
5665 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5666 XmNshowAsDefault, True, NULL);
5668 /* If MUSTMATCH is non-nil, disable the file entry field of the
5669 dialog, so that the user must select a file from the files list
5670 box. We can't remove it because we wouldn't have a way to get at
5671 the result file name, then. */
5672 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5673 if (!NILP (mustmatch))
5675 Widget label;
5676 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5677 XtSetSensitive (text, False);
5678 XtSetSensitive (label, False);
5681 /* Manage the dialog, so that list boxes get filled. */
5682 XtManageChild (dialog);
5684 if (STRINGP (default_filename))
5686 XmString default_xmstring;
5687 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5688 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5690 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5691 XmTextFieldReplace (wtext, 0, last_pos,
5692 (SSDATA (Ffile_name_nondirectory (default_filename))));
5694 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5695 must include the path for this to work. */
5697 default_xmstring = XmStringCreateLocalized (SSDATA (default_filename));
5699 if (XmListItemExists (list, default_xmstring))
5701 int item_pos = XmListItemPos (list, default_xmstring);
5702 /* Select the item and scroll it into view. */
5703 XmListSelectPos (list, item_pos, True);
5704 XmListSetPos (list, item_pos);
5707 XmStringFree (default_xmstring);
5710 record_unwind_protect_ptr (clean_up_file_dialog, dialog);
5712 /* Process events until the user presses Cancel or OK. */
5713 x_menu_set_in_use (1);
5714 result = 0;
5715 while (result == 0)
5717 XEvent event;
5718 x_menu_wait_for_event (0);
5719 XtAppNextEvent (Xt_app_con, &event);
5720 if (event.type == KeyPress
5721 && FRAME_X_DISPLAY (f) == event.xkey.display)
5723 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5725 /* Pop down on C-g. */
5726 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5727 XtUnmanageChild (dialog);
5730 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5733 /* Get the result. */
5734 if (result == XmCR_OK)
5736 XmString text_string;
5737 String data;
5739 XtVaGetValues (dialog, XmNtextString, &text_string, NULL);
5740 XmStringGetLtoR (text_string, XmFONTLIST_DEFAULT_TAG, &data);
5741 XmStringFree (text_string);
5742 file = build_string (data);
5743 XtFree (data);
5745 else
5746 file = Qnil;
5748 unblock_input ();
5749 UNGCPRO;
5751 /* Make "Cancel" equivalent to C-g. */
5752 if (NILP (file))
5753 Fsignal (Qquit, Qnil);
5755 decoded_file = DECODE_FILE (file);
5757 return unbind_to (count, decoded_file);
5760 #endif /* USE_MOTIF */
5762 #ifdef USE_GTK
5764 static void
5765 clean_up_dialog (void)
5767 x_menu_set_in_use (0);
5770 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5771 doc: /* Read file name, prompting with PROMPT in directory DIR.
5772 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5773 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5774 or directory must exist.
5776 This function is only defined on NS, MS Windows, and X Windows with the
5777 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5778 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5779 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
5781 struct frame *f = SELECTED_FRAME ();
5782 char *fn;
5783 Lisp_Object file = Qnil;
5784 Lisp_Object decoded_file;
5785 ptrdiff_t count = SPECPDL_INDEX ();
5786 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5787 char *cdef_file;
5789 check_window_system (f);
5791 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5793 if (popup_activated ())
5794 error ("Trying to use a menu from within a menu-entry");
5796 CHECK_STRING (prompt);
5797 CHECK_STRING (dir);
5799 /* Prevent redisplay. */
5800 specbind (Qinhibit_redisplay, Qt);
5801 record_unwind_protect_void (clean_up_dialog);
5803 block_input ();
5805 if (STRINGP (default_filename))
5806 cdef_file = SSDATA (default_filename);
5807 else
5808 cdef_file = SSDATA (dir);
5810 fn = xg_get_file_name (f, SSDATA (prompt), cdef_file,
5811 ! NILP (mustmatch),
5812 ! NILP (only_dir_p));
5814 if (fn)
5816 file = build_string (fn);
5817 xfree (fn);
5820 unblock_input ();
5821 UNGCPRO;
5823 /* Make "Cancel" equivalent to C-g. */
5824 if (NILP (file))
5825 Fsignal (Qquit, Qnil);
5827 decoded_file = DECODE_FILE (file);
5829 return unbind_to (count, decoded_file);
5833 #ifdef HAVE_FREETYPE
5835 DEFUN ("x-select-font", Fx_select_font, Sx_select_font, 0, 2, 0,
5836 doc: /* Read a font using a GTK dialog.
5837 Return either a font spec (for GTK versions >= 3.2) or a string
5838 containing a GTK-style font name.
5840 FRAME is the frame on which to pop up the font chooser. If omitted or
5841 nil, it defaults to the selected frame. */)
5842 (Lisp_Object frame, Lisp_Object ignored)
5844 struct frame *f = decode_window_system_frame (frame);
5845 Lisp_Object font;
5846 Lisp_Object font_param;
5847 char *default_name = NULL;
5848 struct gcpro gcpro1, gcpro2;
5849 ptrdiff_t count = SPECPDL_INDEX ();
5851 if (popup_activated ())
5852 error ("Trying to use a menu from within a menu-entry");
5854 /* Prevent redisplay. */
5855 specbind (Qinhibit_redisplay, Qt);
5856 record_unwind_protect_void (clean_up_dialog);
5858 block_input ();
5860 GCPRO2 (font_param, font);
5862 XSETFONT (font, FRAME_FONT (f));
5863 font_param = Ffont_get (font, intern (":name"));
5864 if (STRINGP (font_param))
5865 default_name = xstrdup (SSDATA (font_param));
5866 else
5868 font_param = Fframe_parameter (frame, Qfont_param);
5869 if (STRINGP (font_param))
5870 default_name = xstrdup (SSDATA (font_param));
5873 font = xg_get_font (f, default_name);
5874 xfree (default_name);
5876 unblock_input ();
5878 if (NILP (font))
5879 Fsignal (Qquit, Qnil);
5881 return unbind_to (count, font);
5883 #endif /* HAVE_FREETYPE */
5885 #endif /* USE_GTK */
5888 /***********************************************************************
5889 Keyboard
5890 ***********************************************************************/
5892 #ifdef HAVE_XKB
5893 #include <X11/XKBlib.h>
5894 #include <X11/keysym.h>
5895 #endif
5897 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
5898 Sx_backspace_delete_keys_p, 0, 1, 0,
5899 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
5900 FRAME nil means use the selected frame.
5901 Value is t if we know that both keys are present, and are mapped to the
5902 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
5903 present and mapped to the usual X keysyms. */)
5904 (Lisp_Object frame)
5906 #ifndef HAVE_XKB
5907 return Qlambda;
5908 #else
5909 XkbDescPtr kb;
5910 struct frame *f = decode_window_system_frame (frame);
5911 Display *dpy = FRAME_X_DISPLAY (f);
5912 Lisp_Object have_keys;
5913 int major, minor, op, event, error_code;
5915 block_input ();
5917 /* Check library version in case we're dynamically linked. */
5918 major = XkbMajorVersion;
5919 minor = XkbMinorVersion;
5920 if (!XkbLibraryVersion (&major, &minor))
5922 unblock_input ();
5923 return Qlambda;
5926 /* Check that the server supports XKB. */
5927 major = XkbMajorVersion;
5928 minor = XkbMinorVersion;
5929 if (!XkbQueryExtension (dpy, &op, &event, &error_code, &major, &minor))
5931 unblock_input ();
5932 return Qlambda;
5935 /* In this code we check that the keyboard has physical keys with names
5936 that start with BKSP (Backspace) and DELE (Delete), and that they
5937 generate keysym XK_BackSpace and XK_Delete respectively.
5938 This function is used to test if normal-erase-is-backspace should be
5939 turned on.
5940 An alternative approach would be to just check if XK_BackSpace and
5941 XK_Delete are mapped to any key. But if any of those are mapped to
5942 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
5943 user doesn't know about it, it is better to return false here.
5944 It is more obvious to the user what to do if she/he has two keys
5945 clearly marked with names/symbols and one key does something not
5946 expected (i.e. she/he then tries the other).
5947 The cases where Backspace/Delete is mapped to some other key combination
5948 are rare, and in those cases, normal-erase-is-backspace can be turned on
5949 manually. */
5951 have_keys = Qnil;
5952 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
5953 if (kb)
5955 int delete_keycode = 0, backspace_keycode = 0, i;
5957 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
5959 for (i = kb->min_key_code;
5960 (i < kb->max_key_code
5961 && (delete_keycode == 0 || backspace_keycode == 0));
5962 ++i)
5964 /* The XKB symbolic key names can be seen most easily in
5965 the PS file generated by `xkbprint -label name
5966 $DISPLAY'. */
5967 if (memcmp ("DELE", kb->names->keys[i].name, 4) == 0)
5968 delete_keycode = i;
5969 else if (memcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
5970 backspace_keycode = i;
5973 XkbFreeNames (kb, 0, True);
5976 XkbFreeClientMap (kb, 0, True);
5978 if (delete_keycode
5979 && backspace_keycode
5980 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
5981 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
5982 have_keys = Qt;
5984 unblock_input ();
5985 return have_keys;
5986 #endif
5991 /***********************************************************************
5992 Initialization
5993 ***********************************************************************/
5995 /* Keep this list in the same order as frame_parms in frame.c.
5996 Use 0 for unsupported frame parameters. */
5998 frame_parm_handler x_frame_parm_handlers[] =
6000 x_set_autoraise,
6001 x_set_autolower,
6002 x_set_background_color,
6003 x_set_border_color,
6004 x_set_border_width,
6005 x_set_cursor_color,
6006 x_set_cursor_type,
6007 x_set_font,
6008 x_set_foreground_color,
6009 x_set_icon_name,
6010 x_set_icon_type,
6011 x_set_internal_border_width,
6012 x_set_right_divider_width,
6013 x_set_bottom_divider_width,
6014 x_set_menu_bar_lines,
6015 x_set_mouse_color,
6016 x_explicitly_set_name,
6017 x_set_scroll_bar_width,
6018 x_set_title,
6019 x_set_unsplittable,
6020 x_set_vertical_scroll_bars,
6021 x_set_visibility,
6022 x_set_tool_bar_lines,
6023 x_set_scroll_bar_foreground,
6024 x_set_scroll_bar_background,
6025 x_set_screen_gamma,
6026 x_set_line_spacing,
6027 x_set_fringe_width,
6028 x_set_fringe_width,
6029 x_set_wait_for_wm,
6030 x_set_fullscreen,
6031 x_set_font_backend,
6032 x_set_alpha,
6033 x_set_sticky,
6034 x_set_tool_bar_position,
6037 void
6038 syms_of_xfns (void)
6040 /* The section below is built by the lisp expression at the top of the file,
6041 just above where these variables are declared. */
6042 /*&&& init symbols here &&&*/
6043 DEFSYM (Qsuppress_icon, "suppress-icon");
6044 DEFSYM (Qundefined_color, "undefined-color");
6045 DEFSYM (Qcompound_text, "compound-text");
6046 DEFSYM (Qcancel_timer, "cancel-timer");
6047 DEFSYM (Qfont_param, "font-parameter");
6048 /* This is the end of symbol initialization. */
6050 Fput (Qundefined_color, Qerror_conditions,
6051 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
6052 Fput (Qundefined_color, Qerror_message,
6053 build_pure_c_string ("Undefined color"));
6055 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
6056 doc: /* The shape of the pointer when over text.
6057 Changing the value does not affect existing frames
6058 unless you set the mouse color. */);
6059 Vx_pointer_shape = Qnil;
6061 #if 0 /* This doesn't really do anything. */
6062 DEFVAR_LISP ("x-nontext-pointer-shape", Vx_nontext_pointer_shape,
6063 doc: /* The shape of the pointer when not over text.
6064 This variable takes effect when you create a new frame
6065 or when you set the mouse color. */);
6066 #endif
6067 Vx_nontext_pointer_shape = Qnil;
6069 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
6070 doc: /* The shape of the pointer when Emacs is busy.
6071 This variable takes effect when you create a new frame
6072 or when you set the mouse color. */);
6073 Vx_hourglass_pointer_shape = Qnil;
6075 #if 0 /* This doesn't really do anything. */
6076 DEFVAR_LISP ("x-mode-pointer-shape", Vx_mode_pointer_shape,
6077 doc: /* The shape of the pointer when over the mode line.
6078 This variable takes effect when you create a new frame
6079 or when you set the mouse color. */);
6080 #endif
6081 Vx_mode_pointer_shape = Qnil;
6083 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
6084 Vx_sensitive_text_pointer_shape,
6085 doc: /* The shape of the pointer when over mouse-sensitive text.
6086 This variable takes effect when you create a new frame
6087 or when you set the mouse color. */);
6088 Vx_sensitive_text_pointer_shape = Qnil;
6090 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
6091 Vx_window_horizontal_drag_shape,
6092 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
6093 This variable takes effect when you create a new frame
6094 or when you set the mouse color. */);
6095 Vx_window_horizontal_drag_shape = Qnil;
6097 DEFVAR_LISP ("x-window-vertical-drag-cursor",
6098 Vx_window_vertical_drag_shape,
6099 doc: /* Pointer shape to use for indicating a window can be dragged vertically.
6100 This variable takes effect when you create a new frame
6101 or when you set the mouse color. */);
6102 Vx_window_vertical_drag_shape = Qnil;
6104 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
6105 doc: /* A string indicating the foreground color of the cursor box. */);
6106 Vx_cursor_fore_pixel = Qnil;
6108 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
6109 doc: /* Maximum size for tooltips.
6110 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
6111 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
6113 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
6114 doc: /* Non-nil if no X window manager is in use.
6115 Emacs doesn't try to figure this out; this is always nil
6116 unless you set it to something else. */);
6117 /* We don't have any way to find this out, so set it to nil
6118 and maybe the user would like to set it to t. */
6119 Vx_no_window_manager = Qnil;
6121 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
6122 Vx_pixel_size_width_font_regexp,
6123 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
6125 Since Emacs gets width of a font matching with this regexp from
6126 PIXEL_SIZE field of the name, font finding mechanism gets faster for
6127 such a font. This is especially effective for such large fonts as
6128 Chinese, Japanese, and Korean. */);
6129 Vx_pixel_size_width_font_regexp = Qnil;
6131 /* This is not ifdef:ed, so other builds than GTK can customize it. */
6132 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", x_gtk_use_old_file_dialog,
6133 doc: /* Non-nil means prompt with the old GTK file selection dialog.
6134 If nil or if the file selection dialog is not available, the new GTK file
6135 chooser is used instead. To turn off all file dialogs set the
6136 variable `use-file-dialog'. */);
6137 x_gtk_use_old_file_dialog = 0;
6139 DEFVAR_BOOL ("x-gtk-show-hidden-files", x_gtk_show_hidden_files,
6140 doc: /* If non-nil, the GTK file chooser will by default show hidden files.
6141 Note that this is just the default, there is a toggle button on the file
6142 chooser to show or not show hidden files on a case by case basis. */);
6143 x_gtk_show_hidden_files = 0;
6145 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", x_gtk_file_dialog_help_text,
6146 doc: /* If non-nil, the GTK file chooser will show additional help text.
6147 If more space for files in the file chooser dialog is wanted, set this to nil
6148 to turn the additional text off. */);
6149 x_gtk_file_dialog_help_text = 1;
6151 DEFVAR_BOOL ("x-gtk-whole-detached-tool-bar", x_gtk_whole_detached_tool_bar,
6152 doc: /* If non-nil, a detached tool bar is shown in full.
6153 The default is to just show an arrow and pressing on that arrow shows
6154 the tool bar buttons. */);
6155 x_gtk_whole_detached_tool_bar = 0;
6157 DEFVAR_BOOL ("x-gtk-use-system-tooltips", x_gtk_use_system_tooltips,
6158 doc: /* If non-nil with a Gtk+ built Emacs, the Gtk+ tooltip is used.
6159 Otherwise use Emacs own tooltip implementation.
6160 When using Gtk+ tooltips, the tooltip face is not used. */);
6161 x_gtk_use_system_tooltips = 1;
6163 /* Tell Emacs about this window system. */
6164 Fprovide (Qx, Qnil);
6166 #ifdef USE_X_TOOLKIT
6167 Fprovide (intern_c_string ("x-toolkit"), Qnil);
6168 #ifdef USE_MOTIF
6169 Fprovide (intern_c_string ("motif"), Qnil);
6171 DEFVAR_LISP ("motif-version-string", Vmotif_version_string,
6172 doc: /* Version info for LessTif/Motif. */);
6173 Vmotif_version_string = build_string (XmVERSION_STRING);
6174 #endif /* USE_MOTIF */
6175 #endif /* USE_X_TOOLKIT */
6177 #ifdef USE_GTK
6178 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
6179 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
6180 But for a user it is a toolkit for X, and indeed, configure
6181 accepts --with-x-toolkit=gtk. */
6182 Fprovide (intern_c_string ("x-toolkit"), Qnil);
6183 Fprovide (intern_c_string ("gtk"), Qnil);
6184 Fprovide (intern_c_string ("move-toolbar"), Qnil);
6186 DEFVAR_LISP ("gtk-version-string", Vgtk_version_string,
6187 doc: /* Version info for GTK+. */);
6189 char gtk_version[sizeof ".." + 3 * INT_STRLEN_BOUND (int)];
6190 int len = sprintf (gtk_version, "%d.%d.%d",
6191 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
6192 Vgtk_version_string = make_pure_string (gtk_version, len, len, 0);
6194 #endif /* USE_GTK */
6196 /* X window properties. */
6197 defsubr (&Sx_change_window_property);
6198 defsubr (&Sx_delete_window_property);
6199 defsubr (&Sx_window_property);
6201 defsubr (&Sxw_display_color_p);
6202 defsubr (&Sx_display_grayscale_p);
6203 defsubr (&Sxw_color_defined_p);
6204 defsubr (&Sxw_color_values);
6205 defsubr (&Sx_server_max_request_size);
6206 defsubr (&Sx_server_vendor);
6207 defsubr (&Sx_server_version);
6208 defsubr (&Sx_display_pixel_width);
6209 defsubr (&Sx_display_pixel_height);
6210 defsubr (&Sx_display_mm_width);
6211 defsubr (&Sx_display_mm_height);
6212 defsubr (&Sx_display_screens);
6213 defsubr (&Sx_display_planes);
6214 defsubr (&Sx_display_color_cells);
6215 defsubr (&Sx_display_visual_class);
6216 defsubr (&Sx_display_backing_store);
6217 defsubr (&Sx_display_save_under);
6218 defsubr (&Sx_display_monitor_attributes_list);
6219 defsubr (&Sx_wm_set_size_hint);
6220 defsubr (&Sx_create_frame);
6221 defsubr (&Sx_open_connection);
6222 defsubr (&Sx_close_connection);
6223 defsubr (&Sx_display_list);
6224 defsubr (&Sx_synchronize);
6225 defsubr (&Sx_backspace_delete_keys_p);
6227 defsubr (&Sx_show_tip);
6228 defsubr (&Sx_hide_tip);
6229 tip_timer = Qnil;
6230 staticpro (&tip_timer);
6231 tip_frame = Qnil;
6232 staticpro (&tip_frame);
6234 last_show_tip_args = Qnil;
6235 staticpro (&last_show_tip_args);
6237 defsubr (&Sx_uses_old_gtk_dialog);
6238 #if defined (USE_MOTIF) || defined (USE_GTK)
6239 defsubr (&Sx_file_dialog);
6240 #endif
6242 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
6243 defsubr (&Sx_select_font);
6244 #endif