Comment formatting
[emacs.git] / src / xfns.c
blob4e8442dd3a38fb6028b630e8e871e78e34e27bea
1 /* Functions for the X window system.
3 Copyright (C) 1989, 1992-2013 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 #ifdef HAVE_X_WINDOWS
47 #include <sys/types.h>
48 #include <sys/stat.h>
50 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
51 #include "bitmaps/gray.xbm"
52 #else
53 #include <X11/bitmaps/gray>
54 #endif
56 #include "xsettings.h"
58 #ifdef HAVE_XRANDR
59 #include <X11/extensions/Xrandr.h>
60 #endif
61 #ifdef HAVE_XINERAMA
62 #include <X11/extensions/Xinerama.h>
63 #endif
65 #ifdef USE_GTK
66 #include "gtkutil.h"
67 #endif
69 #ifdef USE_X_TOOLKIT
70 #include <X11/Shell.h>
72 #ifndef USE_MOTIF
73 #ifdef HAVE_XAW3D
74 #include <X11/Xaw3d/Paned.h>
75 #include <X11/Xaw3d/Label.h>
76 #else /* !HAVE_XAW3D */
77 #include <X11/Xaw/Paned.h>
78 #include <X11/Xaw/Label.h>
79 #endif /* HAVE_XAW3D */
80 #endif /* USE_MOTIF */
82 #ifdef USG
83 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
84 #include <X11/Xos.h>
85 #define USG
86 #ifdef USG /* Pacify gcc -Wunused-macros. */
87 #endif
88 #else
89 #include <X11/Xos.h>
90 #endif
92 #include "widget.h"
94 #include "../lwlib/lwlib.h"
96 #ifdef USE_MOTIF
97 #include <Xm/Xm.h>
98 #include <Xm/DialogS.h>
99 #include <Xm/FileSB.h>
100 #include <Xm/List.h>
101 #include <Xm/TextF.h>
102 #endif
104 #ifdef USE_LUCID
105 #include "../lwlib/xlwmenu.h"
106 #endif
108 #if !defined (NO_EDITRES)
109 #define HACK_EDITRES
110 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
111 #endif /* not defined NO_EDITRES */
113 /* Unique id counter for widgets created by the Lucid Widget Library. */
115 extern LWLIB_ID widget_id_tick;
117 #ifdef USE_MOTIF
119 #endif /* USE_MOTIF */
121 #endif /* USE_X_TOOLKIT */
123 #ifdef USE_GTK
125 #endif /* USE_GTK */
127 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
129 static Lisp_Object Qsuppress_icon;
130 static Lisp_Object Qundefined_color;
131 static Lisp_Object Qcompound_text, Qcancel_timer;
132 Lisp_Object Qfont_param;
134 #ifdef GLYPH_DEBUG
135 static ptrdiff_t image_cache_refcount;
136 static int dpyinfo_refcount;
137 #endif
139 static struct x_display_info *x_display_info_for_name (Lisp_Object);
141 /* Let the user specify an X display with a Lisp object.
142 OBJECT may be nil, a frame or a terminal object.
143 nil stands for the selected frame--or, if that is not an X frame,
144 the first X display on the list. */
146 struct x_display_info *
147 check_x_display_info (Lisp_Object object)
149 struct x_display_info *dpyinfo = NULL;
151 if (NILP (object))
153 struct frame *sf = XFRAME (selected_frame);
155 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
156 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
157 else if (x_display_list != 0)
158 dpyinfo = x_display_list;
159 else
160 error ("X windows are not in use or not initialized");
162 else if (TERMINALP (object))
164 struct terminal *t = get_terminal (object, 1);
166 if (t->type != output_x_window)
167 error ("Terminal %d is not an X display", t->id);
169 dpyinfo = t->display_info.x;
171 else if (STRINGP (object))
172 dpyinfo = x_display_info_for_name (object);
173 else
175 struct frame *f = decode_window_system_frame (object);
176 dpyinfo = FRAME_X_DISPLAY_INFO (f);
179 return dpyinfo;
183 /* Return the Emacs frame-object corresponding to an X window.
184 It could be the frame's main window or an icon window. */
186 /* This function can be called during GC, so use GC_xxx type test macros. */
188 struct frame *
189 x_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
191 Lisp_Object tail, frame;
192 struct frame *f;
194 if (wdesc == None)
195 return NULL;
197 FOR_EACH_FRAME (tail, frame)
199 f = XFRAME (frame);
200 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
201 continue;
202 if (f->output_data.x->hourglass_window == wdesc)
203 return f;
204 #ifdef USE_X_TOOLKIT
205 if ((f->output_data.x->edit_widget
206 && XtWindow (f->output_data.x->edit_widget) == wdesc)
207 /* A tooltip frame? */
208 || (!f->output_data.x->edit_widget
209 && FRAME_X_WINDOW (f) == wdesc)
210 || f->output_data.x->icon_desc == wdesc)
211 return f;
212 #else /* not USE_X_TOOLKIT */
213 #ifdef USE_GTK
214 if (f->output_data.x->edit_widget)
216 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
217 struct x_output *x = f->output_data.x;
218 if (gwdesc != 0 && gwdesc == x->edit_widget)
219 return f;
221 #endif /* USE_GTK */
222 if (FRAME_X_WINDOW (f) == wdesc
223 || f->output_data.x->icon_desc == wdesc)
224 return f;
225 #endif /* not USE_X_TOOLKIT */
227 return 0;
230 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
231 /* Like x_window_to_frame but also compares the window with the widget's
232 windows. */
234 struct frame *
235 x_any_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
237 Lisp_Object tail, frame;
238 struct frame *f, *found = NULL;
239 struct x_output *x;
241 if (wdesc == None)
242 return NULL;
244 FOR_EACH_FRAME (tail, frame)
246 if (found)
247 break;
248 f = XFRAME (frame);
249 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
251 /* This frame matches if the window is any of its widgets. */
252 x = f->output_data.x;
253 if (x->hourglass_window == wdesc)
254 found = f;
255 else if (x->widget)
257 #ifdef USE_GTK
258 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
259 if (gwdesc != 0
260 && gtk_widget_get_toplevel (gwdesc) == x->widget)
261 found = f;
262 #else
263 if (wdesc == XtWindow (x->widget)
264 || wdesc == XtWindow (x->column_widget)
265 || wdesc == XtWindow (x->edit_widget))
266 found = f;
267 /* Match if the window is this frame's menubar. */
268 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
269 found = f;
270 #endif
272 else if (FRAME_X_WINDOW (f) == wdesc)
273 /* A tooltip frame. */
274 found = f;
278 return found;
281 /* Likewise, but consider only the menu bar widget. */
283 struct frame *
284 x_menubar_window_to_frame (struct x_display_info *dpyinfo, XEvent *event)
286 Window wdesc = event->xany.window;
287 Lisp_Object tail, frame;
288 struct frame *f;
289 struct x_output *x;
291 if (wdesc == None)
292 return NULL;
294 FOR_EACH_FRAME (tail, frame)
296 f = XFRAME (frame);
297 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
298 continue;
299 x = f->output_data.x;
300 #ifdef USE_GTK
301 if (x->menubar_widget && xg_event_is_for_menubar (f, event))
302 return f;
303 #else
304 /* Match if the window is this frame's menubar. */
305 if (x->menubar_widget
306 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
307 return f;
308 #endif
310 return 0;
313 /* Return the frame whose principal (outermost) window is WDESC.
314 If WDESC is some other (smaller) window, we return 0. */
316 struct frame *
317 x_top_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
319 Lisp_Object tail, frame;
320 struct frame *f;
321 struct x_output *x;
323 if (wdesc == None)
324 return NULL;
326 FOR_EACH_FRAME (tail, frame)
328 f = XFRAME (frame);
329 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
330 continue;
331 x = f->output_data.x;
333 if (x->widget)
335 /* This frame matches if the window is its topmost widget. */
336 #ifdef USE_GTK
337 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
338 if (gwdesc == x->widget)
339 return f;
340 #else
341 if (wdesc == XtWindow (x->widget))
342 return f;
343 #if 0 /* I don't know why it did this,
344 but it seems logically wrong,
345 and it causes trouble for MapNotify events. */
346 /* Match if the window is this frame's menubar. */
347 if (x->menubar_widget
348 && wdesc == XtWindow (x->menubar_widget))
349 return f;
350 #endif
351 #endif
353 else if (FRAME_X_WINDOW (f) == wdesc)
354 /* Tooltip frame. */
355 return f;
357 return 0;
359 #endif /* USE_X_TOOLKIT || USE_GTK */
363 /* Store the screen positions of frame F into XPTR and YPTR.
364 These are the positions of the containing window manager window,
365 not Emacs's own window. */
367 void
368 x_real_positions (struct frame *f, int *xptr, int *yptr)
370 int win_x, win_y, outer_x IF_LINT (= 0), outer_y IF_LINT (= 0);
371 int real_x = 0, real_y = 0;
372 int had_errors = 0;
373 Window win = f->output_data.x->parent_desc;
374 Atom actual_type;
375 unsigned long actual_size, bytes_remaining;
376 int rc, actual_format;
377 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
378 long max_len = 400;
379 Display *dpy = FRAME_X_DISPLAY (f);
380 unsigned char *tmp_data = NULL;
381 Atom target_type = XA_CARDINAL;
383 block_input ();
385 x_catch_errors (dpy);
387 if (win == dpyinfo->root_window)
388 win = FRAME_OUTER_WINDOW (f);
390 /* This loop traverses up the containment tree until we hit the root
391 window. Window managers may intersect many windows between our window
392 and the root window. The window we find just before the root window
393 should be the outer WM window. */
394 for (;;)
396 Window wm_window, rootw;
397 Window *tmp_children;
398 unsigned int tmp_nchildren;
399 int success;
401 success = XQueryTree (FRAME_X_DISPLAY (f), win, &rootw,
402 &wm_window, &tmp_children, &tmp_nchildren);
404 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
406 /* Don't free tmp_children if XQueryTree failed. */
407 if (! success)
408 break;
410 XFree (tmp_children);
412 if (wm_window == rootw || had_errors)
413 break;
415 win = wm_window;
418 if (! had_errors)
420 unsigned int ign;
421 Window child, rootw;
423 /* Get the real coordinates for the WM window upper left corner */
424 XGetGeometry (FRAME_X_DISPLAY (f), win,
425 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
427 /* Translate real coordinates to coordinates relative to our
428 window. For our window, the upper left corner is 0, 0.
429 Since the upper left corner of the WM window is outside
430 our window, win_x and win_y will be negative:
432 ------------------ ---> x
433 | title |
434 | ----------------- v y
435 | | our window
437 XTranslateCoordinates (FRAME_X_DISPLAY (f),
439 /* From-window, to-window. */
440 FRAME_X_DISPLAY_INFO (f)->root_window,
441 FRAME_X_WINDOW (f),
443 /* From-position, to-position. */
444 real_x, real_y, &win_x, &win_y,
446 /* Child of win. */
447 &child);
449 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
451 outer_x = win_x;
452 outer_y = win_y;
454 else
456 XTranslateCoordinates (FRAME_X_DISPLAY (f),
458 /* From-window, to-window. */
459 FRAME_X_DISPLAY_INFO (f)->root_window,
460 FRAME_OUTER_WINDOW (f),
462 /* From-position, to-position. */
463 real_x, real_y, &outer_x, &outer_y,
465 /* Child of win. */
466 &child);
469 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
473 if (dpyinfo->root_window == f->output_data.x->parent_desc)
475 /* Try _NET_FRAME_EXTENTS if our parent is the root window. */
476 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_frame_extents,
477 0, max_len, False, target_type,
478 &actual_type, &actual_format, &actual_size,
479 &bytes_remaining, &tmp_data);
481 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
482 && actual_size == 4 && actual_format == 32)
484 unsigned int ign;
485 Window rootw;
486 long *fe = (long *)tmp_data;
488 XGetGeometry (FRAME_X_DISPLAY (f), win,
489 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
490 outer_x = -fe[0];
491 outer_y = -fe[2];
492 real_x -= fe[0];
493 real_y -= fe[2];
497 if (tmp_data) XFree (tmp_data);
499 x_uncatch_errors ();
501 unblock_input ();
503 if (had_errors) return;
505 f->x_pixels_diff = -win_x;
506 f->y_pixels_diff = -win_y;
508 FRAME_X_OUTPUT (f)->x_pixels_outer_diff = -outer_x;
509 FRAME_X_OUTPUT (f)->y_pixels_outer_diff = -outer_y;
511 *xptr = real_x;
512 *yptr = real_y;
518 /* Gamma-correct COLOR on frame F. */
520 void
521 gamma_correct (struct frame *f, XColor *color)
523 if (f->gamma)
525 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
526 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
527 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
532 /* Decide if color named COLOR_NAME is valid for use on frame F. If
533 so, return the RGB values in COLOR. If ALLOC_P,
534 allocate the color. Value is false if COLOR_NAME is invalid, or
535 no color could be allocated. */
537 bool
538 x_defined_color (struct frame *f, const char *color_name,
539 XColor *color, bool alloc_p)
541 bool success_p = 0;
542 Display *dpy = FRAME_X_DISPLAY (f);
543 Colormap cmap = FRAME_X_COLORMAP (f);
545 block_input ();
546 #ifdef USE_GTK
547 success_p = xg_check_special_colors (f, color_name, color);
548 #endif
549 if (!success_p)
550 success_p = XParseColor (dpy, cmap, color_name, color) != 0;
551 if (success_p && alloc_p)
552 success_p = x_alloc_nearest_color (f, cmap, color);
553 unblock_input ();
555 return success_p;
559 /* Return the pixel color value for color COLOR_NAME on frame F. If F
560 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
561 Signal an error if color can't be allocated. */
563 static int
564 x_decode_color (struct frame *f, Lisp_Object color_name, int mono_color)
566 XColor cdef;
568 CHECK_STRING (color_name);
570 #if 0 /* Don't do this. It's wrong when we're not using the default
571 colormap, it makes freeing difficult, and it's probably not
572 an important optimization. */
573 if (strcmp (SDATA (color_name), "black") == 0)
574 return BLACK_PIX_DEFAULT (f);
575 else if (strcmp (SDATA (color_name), "white") == 0)
576 return WHITE_PIX_DEFAULT (f);
577 #endif
579 /* Return MONO_COLOR for monochrome frames. */
580 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
581 return mono_color;
583 /* x_defined_color is responsible for coping with failures
584 by looking for a near-miss. */
585 if (x_defined_color (f, SSDATA (color_name), &cdef, 1))
586 return cdef.pixel;
588 signal_error ("Undefined color", color_name);
593 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
594 the previous value of that parameter, NEW_VALUE is the new value.
595 See also the comment of wait_for_wm in struct x_output. */
597 static void
598 x_set_wait_for_wm (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
600 f->output_data.x->wait_for_wm = !NILP (new_value);
603 static void
604 x_set_tool_bar_position (struct frame *f,
605 Lisp_Object new_value,
606 Lisp_Object old_value)
608 if (! EQ (new_value, Qleft) && ! EQ (new_value, Qright)
609 && ! EQ (new_value, Qbottom) && ! EQ (new_value, Qtop))
610 return;
611 if (EQ (new_value, old_value)) return;
613 #ifdef USE_GTK
614 xg_change_toolbar_position (f, new_value);
615 fset_tool_bar_position (f, new_value);
616 #endif
619 #ifdef USE_GTK
621 /* Set icon from FILE for frame F. By using GTK functions the icon
622 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
625 xg_set_icon (struct frame *f, Lisp_Object file)
627 int result = 0;
628 Lisp_Object found;
630 found = x_find_image_file (file);
632 if (! NILP (found))
634 GdkPixbuf *pixbuf;
635 GError *err = NULL;
636 char *filename = SSDATA (found);
637 block_input ();
639 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
641 if (pixbuf)
643 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
644 pixbuf);
645 g_object_unref (pixbuf);
647 result = 1;
649 else
650 g_error_free (err);
652 unblock_input ();
655 return result;
659 xg_set_icon_from_xpm_data (struct frame *f, const char **data)
661 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data (data);
663 if (!pixbuf)
664 return 0;
666 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), pixbuf);
667 g_object_unref (pixbuf);
668 return 1;
670 #endif /* USE_GTK */
673 /* Functions called only from `x_set_frame_param'
674 to set individual parameters.
676 If FRAME_X_WINDOW (f) is 0,
677 the frame is being created and its X-window does not exist yet.
678 In that case, just record the parameter's new value
679 in the standard place; do not attempt to change the window. */
681 static void
682 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
684 struct x_output *x = f->output_data.x;
685 unsigned long fg, old_fg;
687 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
688 old_fg = FRAME_FOREGROUND_PIXEL (f);
689 FRAME_FOREGROUND_PIXEL (f) = fg;
691 if (FRAME_X_WINDOW (f) != 0)
693 Display *dpy = FRAME_X_DISPLAY (f);
695 block_input ();
696 XSetForeground (dpy, x->normal_gc, fg);
697 XSetBackground (dpy, x->reverse_gc, fg);
699 if (x->cursor_pixel == old_fg)
701 unload_color (f, x->cursor_pixel);
702 x->cursor_pixel = x_copy_color (f, fg);
703 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
706 unblock_input ();
708 update_face_from_frame_parameter (f, Qforeground_color, arg);
710 if (FRAME_VISIBLE_P (f))
711 redraw_frame (f);
714 unload_color (f, old_fg);
717 static void
718 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
720 struct x_output *x = f->output_data.x;
721 unsigned long bg;
723 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
724 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
725 FRAME_BACKGROUND_PIXEL (f) = bg;
727 if (FRAME_X_WINDOW (f) != 0)
729 Display *dpy = FRAME_X_DISPLAY (f);
731 block_input ();
732 XSetBackground (dpy, x->normal_gc, bg);
733 XSetForeground (dpy, x->reverse_gc, bg);
734 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
735 XSetForeground (dpy, x->cursor_gc, bg);
737 #ifdef USE_GTK
738 xg_set_background_color (f, bg);
739 #endif
741 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
742 toolkit scroll bars. */
744 Lisp_Object bar;
745 for (bar = FRAME_SCROLL_BARS (f);
746 !NILP (bar);
747 bar = XSCROLL_BAR (bar)->next)
749 Window window = XSCROLL_BAR (bar)->x_window;
750 XSetWindowBackground (dpy, window, bg);
753 #endif /* USE_TOOLKIT_SCROLL_BARS */
755 unblock_input ();
756 update_face_from_frame_parameter (f, Qbackground_color, arg);
758 if (FRAME_VISIBLE_P (f))
759 redraw_frame (f);
763 static Cursor
764 make_invisible_cursor (struct frame *f)
766 Display *dpy = FRAME_X_DISPLAY (f);
767 static char const no_data[] = { 0 };
768 Pixmap pix;
769 XColor col;
770 Cursor c = 0;
772 x_catch_errors (dpy);
773 pix = XCreateBitmapFromData (dpy, FRAME_X_DISPLAY_INFO (f)->root_window,
774 no_data, 1, 1);
775 if (! x_had_errors_p (dpy) && pix != None)
777 Cursor pixc;
778 col.pixel = 0;
779 col.red = col.green = col.blue = 0;
780 col.flags = DoRed | DoGreen | DoBlue;
781 pixc = XCreatePixmapCursor (dpy, pix, pix, &col, &col, 0, 0);
782 if (! x_had_errors_p (dpy) && pixc != None)
783 c = pixc;
784 XFreePixmap (dpy, pix);
787 x_uncatch_errors ();
789 return c;
792 static void
793 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
795 struct x_output *x = f->output_data.x;
796 Display *dpy = FRAME_X_DISPLAY (f);
797 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
798 Cursor hourglass_cursor, horizontal_drag_cursor;
799 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
800 unsigned long mask_color = FRAME_BACKGROUND_PIXEL (f);
802 /* Don't let pointers be invisible. */
803 if (mask_color == pixel)
805 x_free_colors (f, &pixel, 1);
806 pixel = x_copy_color (f, FRAME_FOREGROUND_PIXEL (f));
809 unload_color (f, x->mouse_pixel);
810 x->mouse_pixel = pixel;
812 block_input ();
814 /* It's not okay to crash if the user selects a screwy cursor. */
815 x_catch_errors (dpy);
817 if (!NILP (Vx_pointer_shape))
819 CHECK_NUMBER (Vx_pointer_shape);
820 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
822 else
823 cursor = XCreateFontCursor (dpy, XC_xterm);
824 x_check_errors (dpy, "bad text pointer cursor: %s");
826 if (!NILP (Vx_nontext_pointer_shape))
828 CHECK_NUMBER (Vx_nontext_pointer_shape);
829 nontext_cursor
830 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
832 else
833 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
834 x_check_errors (dpy, "bad nontext pointer cursor: %s");
836 if (!NILP (Vx_hourglass_pointer_shape))
838 CHECK_NUMBER (Vx_hourglass_pointer_shape);
839 hourglass_cursor
840 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
842 else
843 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
844 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
846 if (!NILP (Vx_mode_pointer_shape))
848 CHECK_NUMBER (Vx_mode_pointer_shape);
849 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
851 else
852 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
853 x_check_errors (dpy, "bad modeline pointer cursor: %s");
855 if (!NILP (Vx_sensitive_text_pointer_shape))
857 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
858 hand_cursor
859 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
861 else
862 hand_cursor = XCreateFontCursor (dpy, XC_hand2);
864 if (!NILP (Vx_window_horizontal_drag_shape))
866 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
867 horizontal_drag_cursor
868 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
870 else
871 horizontal_drag_cursor
872 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
874 /* Check and report errors with the above calls. */
875 x_check_errors (dpy, "can't set cursor shape: %s");
876 x_uncatch_errors ();
879 XColor fore_color, back_color;
881 fore_color.pixel = x->mouse_pixel;
882 x_query_color (f, &fore_color);
883 back_color.pixel = mask_color;
884 x_query_color (f, &back_color);
886 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
887 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
888 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
889 XRecolorCursor (dpy, hand_cursor, &fore_color, &back_color);
890 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
891 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
894 if (FRAME_X_WINDOW (f) != 0)
895 XDefineCursor (dpy, FRAME_X_WINDOW (f),
896 f->output_data.x->current_cursor = cursor);
898 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor == 0)
899 FRAME_X_DISPLAY_INFO (f)->invisible_cursor = make_invisible_cursor (f);
901 if (cursor != x->text_cursor
902 && x->text_cursor != 0)
903 XFreeCursor (dpy, x->text_cursor);
904 x->text_cursor = cursor;
906 if (nontext_cursor != x->nontext_cursor
907 && x->nontext_cursor != 0)
908 XFreeCursor (dpy, x->nontext_cursor);
909 x->nontext_cursor = nontext_cursor;
911 if (hourglass_cursor != x->hourglass_cursor
912 && x->hourglass_cursor != 0)
913 XFreeCursor (dpy, x->hourglass_cursor);
914 x->hourglass_cursor = hourglass_cursor;
916 if (mode_cursor != x->modeline_cursor
917 && x->modeline_cursor != 0)
918 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
919 x->modeline_cursor = mode_cursor;
921 if (hand_cursor != x->hand_cursor
922 && x->hand_cursor != 0)
923 XFreeCursor (dpy, x->hand_cursor);
924 x->hand_cursor = hand_cursor;
926 if (horizontal_drag_cursor != x->horizontal_drag_cursor
927 && x->horizontal_drag_cursor != 0)
928 XFreeCursor (dpy, x->horizontal_drag_cursor);
929 x->horizontal_drag_cursor = horizontal_drag_cursor;
931 XFlush (dpy);
932 unblock_input ();
934 update_face_from_frame_parameter (f, Qmouse_color, arg);
937 static void
938 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
940 unsigned long fore_pixel, pixel;
941 bool fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
942 struct x_output *x = f->output_data.x;
944 if (!NILP (Vx_cursor_fore_pixel))
946 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
947 WHITE_PIX_DEFAULT (f));
948 fore_pixel_allocated_p = 1;
950 else
951 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
953 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
954 pixel_allocated_p = 1;
956 /* Make sure that the cursor color differs from the background color. */
957 if (pixel == FRAME_BACKGROUND_PIXEL (f))
959 if (pixel_allocated_p)
961 x_free_colors (f, &pixel, 1);
962 pixel_allocated_p = 0;
965 pixel = x->mouse_pixel;
966 if (pixel == fore_pixel)
968 if (fore_pixel_allocated_p)
970 x_free_colors (f, &fore_pixel, 1);
971 fore_pixel_allocated_p = 0;
973 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
977 unload_color (f, x->cursor_foreground_pixel);
978 if (!fore_pixel_allocated_p)
979 fore_pixel = x_copy_color (f, fore_pixel);
980 x->cursor_foreground_pixel = fore_pixel;
982 unload_color (f, x->cursor_pixel);
983 if (!pixel_allocated_p)
984 pixel = x_copy_color (f, pixel);
985 x->cursor_pixel = pixel;
987 if (FRAME_X_WINDOW (f) != 0)
989 block_input ();
990 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
991 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
992 unblock_input ();
994 if (FRAME_VISIBLE_P (f))
996 x_update_cursor (f, 0);
997 x_update_cursor (f, 1);
1001 update_face_from_frame_parameter (f, Qcursor_color, arg);
1004 /* Set the border-color of frame F to pixel value PIX.
1005 Note that this does not fully take effect if done before
1006 F has an x-window. */
1008 static void
1009 x_set_border_pixel (struct frame *f, int pix)
1011 unload_color (f, f->output_data.x->border_pixel);
1012 f->output_data.x->border_pixel = pix;
1014 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
1016 block_input ();
1017 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), pix);
1018 unblock_input ();
1020 if (FRAME_VISIBLE_P (f))
1021 redraw_frame (f);
1025 /* Set the border-color of frame F to value described by ARG.
1026 ARG can be a string naming a color.
1027 The border-color is used for the border that is drawn by the X server.
1028 Note that this does not fully take effect if done before
1029 F has an x-window; it must be redone when the window is created.
1031 Note: this is done in two routines because of the way X10 works.
1033 Note: under X11, this is normally the province of the window manager,
1034 and so emacs' border colors may be overridden. */
1036 static void
1037 x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1039 int pix;
1041 CHECK_STRING (arg);
1042 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1043 x_set_border_pixel (f, pix);
1044 update_face_from_frame_parameter (f, Qborder_color, arg);
1048 static void
1049 x_set_cursor_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1051 set_frame_cursor_types (f, arg);
1054 static void
1055 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1057 int result;
1059 if (STRINGP (arg))
1061 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1062 return;
1064 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1065 return;
1067 block_input ();
1068 if (NILP (arg))
1069 result = x_text_icon (f,
1070 SSDATA ((!NILP (f->icon_name)
1071 ? f->icon_name
1072 : f->name)));
1073 else
1074 result = x_bitmap_icon (f, arg);
1076 if (result)
1078 unblock_input ();
1079 error ("No icon window available");
1082 XFlush (FRAME_X_DISPLAY (f));
1083 unblock_input ();
1086 static void
1087 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1089 int result;
1091 if (STRINGP (arg))
1093 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1094 return;
1096 else if (!NILP (arg) || NILP (oldval))
1097 return;
1099 fset_icon_name (f, arg);
1101 if (f->output_data.x->icon_bitmap != 0)
1102 return;
1104 block_input ();
1106 result = x_text_icon (f,
1107 SSDATA ((!NILP (f->icon_name)
1108 ? f->icon_name
1109 : !NILP (f->title)
1110 ? f->title
1111 : f->name)));
1113 if (result)
1115 unblock_input ();
1116 error ("No icon window available");
1119 XFlush (FRAME_X_DISPLAY (f));
1120 unblock_input ();
1124 void
1125 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1127 int nlines;
1128 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1129 int olines = FRAME_MENU_BAR_LINES (f);
1130 #endif
1132 /* Right now, menu bars don't work properly in minibuf-only frames;
1133 most of the commands try to apply themselves to the minibuffer
1134 frame itself, and get an error because you can't switch buffers
1135 in or split the minibuffer window. */
1136 if (FRAME_MINIBUF_ONLY_P (f))
1137 return;
1139 if (TYPE_RANGED_INTEGERP (int, value))
1140 nlines = XINT (value);
1141 else
1142 nlines = 0;
1144 /* Make sure we redisplay all windows in this frame. */
1145 windows_or_buffers_changed++;
1147 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1148 FRAME_MENU_BAR_LINES (f) = 0;
1149 if (nlines)
1151 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1152 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1153 /* Make sure next redisplay shows the menu bar. */
1154 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = 1;
1156 else
1158 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1159 free_frame_menubar (f);
1160 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1161 if (FRAME_X_P (f))
1162 f->output_data.x->menubar_widget = 0;
1164 #else /* not USE_X_TOOLKIT && not USE_GTK */
1165 FRAME_MENU_BAR_LINES (f) = nlines;
1166 resize_frame_windows (f, FRAME_LINES (f), 0);
1168 /* If the menu bar height gets changed, the internal border below
1169 the top margin has to be cleared. Also, if the menu bar gets
1170 larger, the area for the added lines has to be cleared except for
1171 the first menu bar line that is to be drawn later. */
1172 if (nlines != olines)
1174 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1175 int width = FRAME_PIXEL_WIDTH (f);
1176 int y;
1178 /* height can be zero here. */
1179 if (height > 0 && width > 0)
1181 y = FRAME_TOP_MARGIN_HEIGHT (f);
1183 block_input ();
1184 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1185 0, y, width, height);
1186 unblock_input ();
1189 if (nlines > 1 && nlines > olines)
1191 y = (olines == 0 ? 1 : olines) * FRAME_LINE_HEIGHT (f);
1192 height = nlines * FRAME_LINE_HEIGHT (f) - y;
1194 block_input ();
1195 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1196 0, y, width, height);
1197 unblock_input ();
1200 if (nlines == 0 && WINDOWP (f->menu_bar_window))
1201 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1203 #endif /* not USE_X_TOOLKIT && not USE_GTK */
1204 adjust_frame_glyphs (f);
1205 run_window_configuration_change_hook (f);
1209 /* Set the number of lines used for the tool bar of frame F to VALUE.
1210 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1211 is the old number of tool bar lines. This function changes the
1212 height of all windows on frame F to match the new tool bar height.
1213 The frame's height doesn't change. */
1215 void
1216 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1218 int delta, nlines, root_height;
1219 Lisp_Object root_window;
1221 /* Treat tool bars like menu bars. */
1222 if (FRAME_MINIBUF_ONLY_P (f))
1223 return;
1225 /* Use VALUE only if an int >= 0. */
1226 if (RANGED_INTEGERP (0, value, INT_MAX))
1227 nlines = XFASTINT (value);
1228 else
1229 nlines = 0;
1231 #ifdef USE_GTK
1232 FRAME_TOOL_BAR_LINES (f) = 0;
1233 if (nlines)
1235 FRAME_EXTERNAL_TOOL_BAR (f) = 1;
1236 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1237 /* Make sure next redisplay shows the tool bar. */
1238 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = 1;
1239 update_frame_tool_bar (f);
1241 else
1243 if (FRAME_EXTERNAL_TOOL_BAR (f))
1244 free_frame_tool_bar (f);
1245 FRAME_EXTERNAL_TOOL_BAR (f) = 0;
1248 return;
1249 #endif
1251 /* Make sure we redisplay all windows in this frame. */
1252 ++windows_or_buffers_changed;
1254 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1256 /* Don't resize the tool-bar to more than we have room for. */
1257 root_window = FRAME_ROOT_WINDOW (f);
1258 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1259 if (root_height - delta < 1)
1261 delta = root_height - 1;
1262 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1265 FRAME_TOOL_BAR_LINES (f) = nlines;
1266 resize_frame_windows (f, FRAME_LINES (f), 0);
1267 adjust_frame_glyphs (f);
1269 /* We also have to make sure that the internal border at the top of
1270 the frame, below the menu bar or tool bar, is redrawn when the
1271 tool bar disappears. This is so because the internal border is
1272 below the tool bar if one is displayed, but is below the menu bar
1273 if there isn't a tool bar. The tool bar draws into the area
1274 below the menu bar. */
1275 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1277 clear_frame (f);
1278 clear_current_matrices (f);
1281 /* If the tool bar gets smaller, the internal border below it
1282 has to be cleared. It was formerly part of the display
1283 of the larger tool bar, and updating windows won't clear it. */
1284 if (delta < 0)
1286 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1287 int width = FRAME_PIXEL_WIDTH (f);
1288 int y = (FRAME_MENU_BAR_LINES (f) + nlines) * FRAME_LINE_HEIGHT (f);
1290 /* height can be zero here. */
1291 if (height > 0 && width > 0)
1293 block_input ();
1294 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1295 0, y, width, height);
1296 unblock_input ();
1299 if (WINDOWP (f->tool_bar_window))
1300 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1303 run_window_configuration_change_hook (f);
1308 /* Set the foreground color for scroll bars on frame F to VALUE.
1309 VALUE should be a string, a color name. If it isn't a string or
1310 isn't a valid color name, do nothing. OLDVAL is the old value of
1311 the frame parameter. */
1313 static void
1314 x_set_scroll_bar_foreground (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1316 unsigned long pixel;
1318 if (STRINGP (value))
1319 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1320 else
1321 pixel = -1;
1323 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1324 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1326 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1327 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1329 /* Remove all scroll bars because they have wrong colors. */
1330 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1331 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1332 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1333 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1335 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1336 redraw_frame (f);
1341 /* Set the background color for scroll bars on frame F to VALUE VALUE
1342 should be a string, a color name. If it isn't a string or isn't a
1343 valid color name, do nothing. OLDVAL is the old value of the frame
1344 parameter. */
1346 static void
1347 x_set_scroll_bar_background (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1349 unsigned long pixel;
1351 if (STRINGP (value))
1352 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1353 else
1354 pixel = -1;
1356 if (f->output_data.x->scroll_bar_background_pixel != -1)
1357 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1359 #ifdef USE_TOOLKIT_SCROLL_BARS
1360 /* Scrollbar shadow colors. */
1361 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1363 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1364 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1366 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1368 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1369 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1371 #endif /* USE_TOOLKIT_SCROLL_BARS */
1373 f->output_data.x->scroll_bar_background_pixel = pixel;
1374 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1376 /* Remove all scroll bars because they have wrong colors. */
1377 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1378 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1379 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1380 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1382 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1383 redraw_frame (f);
1388 /* Encode Lisp string STRING as a text in a format appropriate for
1389 XICCC (X Inter Client Communication Conventions).
1391 This can call Lisp code, so callers must GCPRO.
1393 If STRING contains only ASCII characters, do no conversion and
1394 return the string data of STRING. Otherwise, encode the text by
1395 CODING_SYSTEM, and return a newly allocated memory area which
1396 should be freed by `xfree' by a caller.
1398 SELECTIONP non-zero means the string is being encoded for an X
1399 selection, so it is safe to run pre-write conversions (which
1400 may run Lisp code).
1402 Store the byte length of resulting text in *TEXT_BYTES.
1404 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1405 which means that the `encoding' of the result can be `STRING'.
1406 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1407 the result should be `COMPOUND_TEXT'. */
1409 static unsigned char *
1410 x_encode_text (Lisp_Object string, Lisp_Object coding_system, int selectionp,
1411 ptrdiff_t *text_bytes, int *stringp, int *freep)
1413 int result = string_xstring_p (string);
1414 struct coding_system coding;
1416 if (result == 0)
1418 /* No multibyte character in OBJ. We need not encode it. */
1419 *text_bytes = SBYTES (string);
1420 *stringp = 1;
1421 *freep = 0;
1422 return SDATA (string);
1425 setup_coding_system (coding_system, &coding);
1426 coding.mode |= (CODING_MODE_SAFE_ENCODING | CODING_MODE_LAST_BLOCK);
1427 /* We suppress producing escape sequences for composition. */
1428 coding.common_flags &= ~CODING_ANNOTATION_MASK;
1429 coding.destination = xnmalloc (SCHARS (string), 2);
1430 coding.dst_bytes = SCHARS (string) * 2;
1431 encode_coding_object (&coding, string, 0, 0,
1432 SCHARS (string), SBYTES (string), Qnil);
1433 *text_bytes = coding.produced;
1434 *stringp = (result == 1 || !EQ (coding_system, Qcompound_text));
1435 *freep = 1;
1436 return coding.destination;
1440 /* Set the WM name to NAME for frame F. Also set the icon name.
1441 If the frame already has an icon name, use that, otherwise set the
1442 icon name to NAME. */
1444 static void
1445 x_set_name_internal (struct frame *f, Lisp_Object name)
1447 if (FRAME_X_WINDOW (f))
1449 block_input ();
1451 XTextProperty text, icon;
1452 ptrdiff_t bytes;
1453 int stringp;
1454 int do_free_icon_value = 0, do_free_text_value = 0;
1455 Lisp_Object coding_system;
1456 Lisp_Object encoded_name;
1457 Lisp_Object encoded_icon_name;
1458 struct gcpro gcpro1;
1460 /* As ENCODE_UTF_8 may cause GC and relocation of string data,
1461 we use it before x_encode_text that may return string data. */
1462 GCPRO1 (name);
1463 encoded_name = ENCODE_UTF_8 (name);
1464 UNGCPRO;
1466 coding_system = Qcompound_text;
1467 /* Note: Encoding strategy
1469 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1470 text.encoding. But, there are non-internationalized window
1471 managers which don't support that encoding. So, if NAME
1472 contains only ASCII and 8859-1 characters, encode it by
1473 iso-latin-1, and use "STRING" in text.encoding hoping that
1474 such window managers at least analyze this format correctly,
1475 i.e. treat 8-bit bytes as 8859-1 characters.
1477 We may also be able to use "UTF8_STRING" in text.encoding
1478 in the future which can encode all Unicode characters.
1479 But, for the moment, there's no way to know that the
1480 current window manager supports it or not.
1482 Either way, we also set the _NET_WM_NAME and _NET_WM_ICON_NAME
1483 properties. Per the EWMH specification, those two properties
1484 are always UTF8_STRING. This matches what gtk_window_set_title()
1485 does in the USE_GTK case. */
1486 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1487 &do_free_text_value);
1488 text.encoding = (stringp ? XA_STRING
1489 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1490 text.format = 8;
1491 text.nitems = bytes;
1492 if (text.nitems != bytes)
1493 error ("Window name too large");
1495 if (!STRINGP (f->icon_name))
1497 icon = text;
1498 encoded_icon_name = encoded_name;
1500 else
1502 /* See the above comment "Note: Encoding strategy". */
1503 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1504 &bytes, &stringp, &do_free_icon_value);
1505 icon.encoding = (stringp ? XA_STRING
1506 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1507 icon.format = 8;
1508 icon.nitems = bytes;
1509 if (icon.nitems != bytes)
1510 error ("Icon name too large");
1512 encoded_icon_name = ENCODE_UTF_8 (f->icon_name);
1515 #ifdef USE_GTK
1516 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1517 SSDATA (encoded_name));
1518 #else /* not USE_GTK */
1519 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1520 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1521 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_name,
1522 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1523 8, PropModeReplace,
1524 SDATA (encoded_name),
1525 SBYTES (encoded_name));
1526 #endif /* not USE_GTK */
1528 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1529 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1530 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_icon_name,
1531 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1532 8, PropModeReplace,
1533 SDATA (encoded_icon_name),
1534 SBYTES (encoded_icon_name));
1536 if (do_free_icon_value)
1537 xfree (icon.value);
1538 if (do_free_text_value)
1539 xfree (text.value);
1541 unblock_input ();
1545 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1546 x_id_name.
1548 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1549 name; if NAME is a string, set F's name to NAME and set
1550 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1552 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1553 suggesting a new name, which lisp code should override; if
1554 F->explicit_name is set, ignore the new name; otherwise, set it. */
1556 static void
1557 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1559 /* Make sure that requests from lisp code override requests from
1560 Emacs redisplay code. */
1561 if (explicit)
1563 /* If we're switching from explicit to implicit, we had better
1564 update the mode lines and thereby update the title. */
1565 if (f->explicit_name && NILP (name))
1566 update_mode_lines = 1;
1568 f->explicit_name = ! NILP (name);
1570 else if (f->explicit_name)
1571 return;
1573 /* If NAME is nil, set the name to the x_id_name. */
1574 if (NILP (name))
1576 /* Check for no change needed in this very common case
1577 before we do any consing. */
1578 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
1579 SSDATA (f->name)))
1580 return;
1581 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
1583 else
1584 CHECK_STRING (name);
1586 /* Don't change the name if it's already NAME. */
1587 if (! NILP (Fstring_equal (name, f->name)))
1588 return;
1590 fset_name (f, name);
1592 /* For setting the frame title, the title parameter should override
1593 the name parameter. */
1594 if (! NILP (f->title))
1595 name = f->title;
1597 x_set_name_internal (f, name);
1600 /* This function should be called when the user's lisp code has
1601 specified a name for the frame; the name will override any set by the
1602 redisplay code. */
1603 static void
1604 x_explicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1606 x_set_name (f, arg, 1);
1609 /* This function should be called by Emacs redisplay code to set the
1610 name; names set this way will never override names set by the user's
1611 lisp code. */
1612 void
1613 x_implicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1615 x_set_name (f, arg, 0);
1618 /* Change the title of frame F to NAME.
1619 If NAME is nil, use the frame name as the title. */
1621 static void
1622 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1624 /* Don't change the title if it's already NAME. */
1625 if (EQ (name, f->title))
1626 return;
1628 update_mode_lines = 1;
1630 fset_title (f, name);
1632 if (NILP (name))
1633 name = f->name;
1634 else
1635 CHECK_STRING (name);
1637 x_set_name_internal (f, name);
1640 void
1641 x_set_scroll_bar_default_width (struct frame *f)
1643 int wid = FRAME_COLUMN_WIDTH (f);
1644 #ifdef USE_TOOLKIT_SCROLL_BARS
1645 #ifdef USE_GTK
1646 int minw = xg_get_default_scrollbar_width ();
1647 #else
1648 int minw = 16;
1649 #endif
1650 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1651 int width = minw + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
1652 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
1653 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = width;
1654 #else
1655 /* Make the actual width at least 14 pixels and a multiple of a
1656 character width. */
1657 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
1659 /* Use all of that space (aside from required margins) for the
1660 scroll bar. */
1661 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = 0;
1662 #endif
1666 /* Record in frame F the specified or default value according to ALIST
1667 of the parameter named PROP (a Lisp symbol). If no value is
1668 specified for PROP, look for an X default for XPROP on the frame
1669 named NAME. If that is not found either, use the value DEFLT. */
1671 static Lisp_Object
1672 x_default_scroll_bar_color_parameter (struct frame *f,
1673 Lisp_Object alist, Lisp_Object prop,
1674 const char *xprop, const char *xclass,
1675 int foreground_p)
1677 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1678 Lisp_Object tem;
1680 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1681 if (EQ (tem, Qunbound))
1683 #ifdef USE_TOOLKIT_SCROLL_BARS
1685 /* See if an X resource for the scroll bar color has been
1686 specified. */
1687 tem = display_x_get_resource (dpyinfo,
1688 build_string (foreground_p
1689 ? "foreground"
1690 : "background"),
1691 empty_unibyte_string,
1692 build_string ("verticalScrollBar"),
1693 empty_unibyte_string);
1694 if (!STRINGP (tem))
1696 /* If nothing has been specified, scroll bars will use a
1697 toolkit-dependent default. Because these defaults are
1698 difficult to get at without actually creating a scroll
1699 bar, use nil to indicate that no color has been
1700 specified. */
1701 tem = Qnil;
1704 #else /* not USE_TOOLKIT_SCROLL_BARS */
1706 tem = Qnil;
1708 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1711 x_set_frame_parameters (f, list1 (Fcons (prop, tem)));
1712 return tem;
1718 #ifdef USE_X_TOOLKIT
1720 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1721 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1722 already be present because of the toolkit (Motif adds some of them,
1723 for example, but Xt doesn't). */
1725 static void
1726 hack_wm_protocols (struct frame *f, Widget widget)
1728 Display *dpy = XtDisplay (widget);
1729 Window w = XtWindow (widget);
1730 int need_delete = 1;
1731 int need_focus = 1;
1732 int need_save = 1;
1734 block_input ();
1736 Atom type;
1737 unsigned char *catoms;
1738 int format = 0;
1739 unsigned long nitems = 0;
1740 unsigned long bytes_after;
1742 if ((XGetWindowProperty (dpy, w,
1743 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1744 (long)0, (long)100, False, XA_ATOM,
1745 &type, &format, &nitems, &bytes_after,
1746 &catoms)
1747 == Success)
1748 && format == 32 && type == XA_ATOM)
1750 Atom *atoms = (Atom *) catoms;
1751 while (nitems > 0)
1753 nitems--;
1754 if (atoms[nitems]
1755 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1756 need_delete = 0;
1757 else if (atoms[nitems]
1758 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1759 need_focus = 0;
1760 else if (atoms[nitems]
1761 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1762 need_save = 0;
1765 if (catoms)
1766 XFree (catoms);
1769 Atom props [10];
1770 int count = 0;
1771 if (need_delete)
1772 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1773 if (need_focus)
1774 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1775 if (need_save)
1776 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1777 if (count)
1778 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1779 XA_ATOM, 32, PropModeAppend,
1780 (unsigned char *) props, count);
1782 unblock_input ();
1784 #endif
1788 /* Support routines for XIC (X Input Context). */
1790 #ifdef HAVE_X_I18N
1792 static XFontSet xic_create_xfontset (struct frame *);
1793 static XIMStyle best_xim_style (XIMStyles *, XIMStyles *);
1796 /* Supported XIM styles, ordered by preference. */
1798 static XIMStyle supported_xim_styles[] =
1800 XIMPreeditPosition | XIMStatusArea,
1801 XIMPreeditPosition | XIMStatusNothing,
1802 XIMPreeditPosition | XIMStatusNone,
1803 XIMPreeditNothing | XIMStatusArea,
1804 XIMPreeditNothing | XIMStatusNothing,
1805 XIMPreeditNothing | XIMStatusNone,
1806 XIMPreeditNone | XIMStatusArea,
1807 XIMPreeditNone | XIMStatusNothing,
1808 XIMPreeditNone | XIMStatusNone,
1813 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1814 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1816 static const char xic_default_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1818 /* Create an Xt fontset spec from the name of a base font.
1819 If `motif' is True use the Motif syntax. */
1820 char *
1821 xic_create_fontsetname (const char *base_fontname, int motif)
1823 const char *sep = motif ? ";" : ",";
1824 char *fontsetname;
1826 /* Make a fontset name from the base font name. */
1827 if (xic_default_fontset == base_fontname)
1829 /* There is no base font name, use the default. */
1830 fontsetname = xmalloc (strlen (base_fontname) + 2);
1831 strcpy (fontsetname, base_fontname);
1833 else
1835 /* Make a fontset name from the base font name.
1836 The font set will be made of the following elements:
1837 - the base font.
1838 - the base font where the charset spec is replaced by -*-*.
1839 - the same but with the family also replaced with -*-*-. */
1840 const char *p = base_fontname;
1841 ptrdiff_t i;
1843 for (i = 0; *p; p++)
1844 if (*p == '-') i++;
1845 if (i != 14)
1847 /* As the font name doesn't conform to XLFD, we can't
1848 modify it to generalize it to allcs and allfamilies.
1849 Use the specified font plus the default. */
1850 fontsetname = xmalloc (strlen (base_fontname)
1851 + strlen (xic_default_fontset) + 3);
1852 strcpy (fontsetname, base_fontname);
1853 strcat (fontsetname, sep);
1854 strcat (fontsetname, xic_default_fontset);
1856 else
1858 ptrdiff_t len;
1859 const char *p1 = NULL, *p2 = NULL, *p3 = NULL;
1860 char *font_allcs = NULL;
1861 char *font_allfamilies = NULL;
1862 char *font_all = NULL;
1863 const char *allcs = "*-*-*-*-*-*-*";
1864 const char *allfamilies = "-*-*-";
1865 const char *all = "*-*-*-*-";
1866 char *base;
1868 for (i = 0, p = base_fontname; i < 8; p++)
1870 if (*p == '-')
1872 i++;
1873 if (i == 3)
1874 p1 = p + 1;
1875 else if (i == 7)
1876 p2 = p + 1;
1877 else if (i == 6)
1878 p3 = p + 1;
1881 /* If base_fontname specifies ADSTYLE, make it a
1882 wildcard. */
1883 if (*p3 != '*')
1885 ptrdiff_t diff = (p2 - p3) - 2;
1887 base = alloca (strlen (base_fontname) + 1);
1888 memcpy (base, base_fontname, p3 - base_fontname);
1889 base[p3 - base_fontname] = '*';
1890 base[(p3 - base_fontname) + 1] = '-';
1891 strcpy (base + (p3 - base_fontname) + 2, p2);
1892 p = base + (p - base_fontname) - diff;
1893 p1 = base + (p1 - base_fontname);
1894 p2 = base + (p2 - base_fontname) - diff;
1895 base_fontname = base;
1898 /* Build the font spec that matches all charsets. */
1899 len = p - base_fontname + strlen (allcs) + 1;
1900 font_allcs = alloca (len);
1901 memcpy (font_allcs, base_fontname, p - base_fontname);
1902 strcat (font_allcs, allcs);
1904 /* Build the font spec that matches all families and
1905 add-styles. */
1906 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
1907 font_allfamilies = alloca (len);
1908 strcpy (font_allfamilies, allfamilies);
1909 memcpy (font_allfamilies + strlen (allfamilies), p1, p - p1);
1910 strcat (font_allfamilies, allcs);
1912 /* Build the font spec that matches all. */
1913 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
1914 font_all = alloca (len);
1915 strcpy (font_all, allfamilies);
1916 strcat (font_all, all);
1917 memcpy (font_all + strlen (all) + strlen (allfamilies), p2, p - p2);
1918 strcat (font_all, allcs);
1920 /* Build the actual font set name. */
1921 len = strlen (base_fontname) + strlen (font_allcs)
1922 + strlen (font_allfamilies) + strlen (font_all) + 5;
1923 fontsetname = xmalloc (len);
1924 strcpy (fontsetname, base_fontname);
1925 strcat (fontsetname, sep);
1926 strcat (fontsetname, font_allcs);
1927 strcat (fontsetname, sep);
1928 strcat (fontsetname, font_allfamilies);
1929 strcat (fontsetname, sep);
1930 strcat (fontsetname, font_all);
1933 if (motif)
1934 strcat (fontsetname, ":");
1935 return fontsetname;
1937 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
1939 #ifdef DEBUG_XIC_FONTSET
1940 static void
1941 print_fontset_result (XFontSet xfs, char *name, char **missing_list,
1942 int missing_count)
1944 if (xfs)
1945 fprintf (stderr, "XIC Fontset created: %s\n", name);
1946 else
1948 fprintf (stderr, "XIC Fontset failed: %s\n", name);
1949 while (missing_count-- > 0)
1951 fprintf (stderr, " missing: %s\n", *missing_list);
1952 missing_list++;
1957 #endif
1959 static XFontSet
1960 xic_create_xfontset (struct frame *f)
1962 XFontSet xfs = NULL;
1963 struct font *font = FRAME_FONT (f);
1964 int pixel_size = font->pixel_size;
1965 Lisp_Object rest, frame;
1967 /* See if there is another frame already using same fontset. */
1968 FOR_EACH_FRAME (rest, frame)
1970 struct frame *cf = XFRAME (frame);
1972 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
1973 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
1974 && FRAME_FONT (f)
1975 && FRAME_FONT (f)->pixel_size == pixel_size)
1977 xfs = FRAME_XIC_FONTSET (cf);
1978 break;
1982 if (! xfs)
1984 char buf[256];
1985 char **missing_list;
1986 int missing_count;
1987 char *def_string;
1988 const char *xlfd_format = "-*-*-medium-r-normal--%d-*-*-*-*-*";
1990 sprintf (buf, xlfd_format, pixel_size);
1991 missing_list = NULL;
1992 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
1993 &missing_list, &missing_count, &def_string);
1994 #ifdef DEBUG_XIC_FONTSET
1995 print_fontset_result (xfs, buf, missing_list, missing_count);
1996 #endif
1997 if (missing_list)
1998 XFreeStringList (missing_list);
1999 if (! xfs)
2001 /* List of pixel sizes most likely available. Find one that
2002 is closest to pixel_size. */
2003 int sizes[] = {0, 8, 10, 11, 12, 14, 17, 18, 20, 24, 26, 34, 0};
2004 int *smaller, *larger;
2006 for (smaller = sizes; smaller[1]; smaller++)
2007 if (smaller[1] >= pixel_size)
2008 break;
2009 larger = smaller + 1;
2010 if (*larger == pixel_size)
2011 larger++;
2012 while (*smaller || *larger)
2014 int this_size;
2016 if (! *larger)
2017 this_size = *smaller--;
2018 else if (! *smaller)
2019 this_size = *larger++;
2020 else if (pixel_size - *smaller < *larger - pixel_size)
2021 this_size = *smaller--;
2022 else
2023 this_size = *larger++;
2024 sprintf (buf, xlfd_format, this_size);
2025 missing_list = NULL;
2026 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2027 &missing_list, &missing_count, &def_string);
2028 #ifdef DEBUG_XIC_FONTSET
2029 print_fontset_result (xfs, buf, missing_list, missing_count);
2030 #endif
2031 if (missing_list)
2032 XFreeStringList (missing_list);
2033 if (xfs)
2034 break;
2037 if (! xfs)
2039 const char *last_resort = "-*-*-*-r-normal--*-*-*-*-*-*";
2041 missing_list = NULL;
2042 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), last_resort,
2043 &missing_list, &missing_count, &def_string);
2044 #ifdef DEBUG_XIC_FONTSET
2045 print_fontset_result (xfs, last_resort, missing_list, missing_count);
2046 #endif
2047 if (missing_list)
2048 XFreeStringList (missing_list);
2053 return xfs;
2056 /* Free the X fontset of frame F if it is the last frame using it. */
2058 void
2059 xic_free_xfontset (struct frame *f)
2061 Lisp_Object rest, frame;
2062 bool shared_p = 0;
2064 if (!FRAME_XIC_FONTSET (f))
2065 return;
2067 /* See if there is another frame sharing the same fontset. */
2068 FOR_EACH_FRAME (rest, frame)
2070 struct frame *cf = XFRAME (frame);
2071 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2072 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2073 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2075 shared_p = 1;
2076 break;
2080 if (!shared_p)
2081 /* The fontset is not used anymore. It is safe to free it. */
2082 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2084 FRAME_XIC_FONTSET (f) = NULL;
2088 /* Value is the best input style, given user preferences USER (already
2089 checked to be supported by Emacs), and styles supported by the
2090 input method XIM. */
2092 static XIMStyle
2093 best_xim_style (XIMStyles *user, XIMStyles *xim)
2095 int i, j;
2097 for (i = 0; i < user->count_styles; ++i)
2098 for (j = 0; j < xim->count_styles; ++j)
2099 if (user->supported_styles[i] == xim->supported_styles[j])
2100 return user->supported_styles[i];
2102 /* Return the default style. */
2103 return XIMPreeditNothing | XIMStatusNothing;
2106 /* Create XIC for frame F. */
2108 static XIMStyle xic_style;
2110 void
2111 create_frame_xic (struct frame *f)
2113 XIM xim;
2114 XIC xic = NULL;
2115 XFontSet xfs = NULL;
2117 if (FRAME_XIC (f))
2118 return;
2120 /* Create X fontset. */
2121 xfs = xic_create_xfontset (f);
2122 xim = FRAME_X_XIM (f);
2123 if (xim)
2125 XRectangle s_area;
2126 XPoint spot;
2127 XVaNestedList preedit_attr;
2128 XVaNestedList status_attr;
2130 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2131 spot.x = 0; spot.y = 1;
2133 /* Determine XIC style. */
2134 if (xic_style == 0)
2136 XIMStyles supported_list;
2137 supported_list.count_styles = (sizeof supported_xim_styles
2138 / sizeof supported_xim_styles[0]);
2139 supported_list.supported_styles = supported_xim_styles;
2140 xic_style = best_xim_style (&supported_list,
2141 FRAME_X_XIM_STYLES (f));
2144 preedit_attr = XVaCreateNestedList (0,
2145 XNFontSet, xfs,
2146 XNForeground,
2147 FRAME_FOREGROUND_PIXEL (f),
2148 XNBackground,
2149 FRAME_BACKGROUND_PIXEL (f),
2150 (xic_style & XIMPreeditPosition
2151 ? XNSpotLocation
2152 : NULL),
2153 &spot,
2154 NULL);
2155 status_attr = XVaCreateNestedList (0,
2156 XNArea,
2157 &s_area,
2158 XNFontSet,
2159 xfs,
2160 XNForeground,
2161 FRAME_FOREGROUND_PIXEL (f),
2162 XNBackground,
2163 FRAME_BACKGROUND_PIXEL (f),
2164 NULL);
2166 xic = XCreateIC (xim,
2167 XNInputStyle, xic_style,
2168 XNClientWindow, FRAME_X_WINDOW (f),
2169 XNFocusWindow, FRAME_X_WINDOW (f),
2170 XNStatusAttributes, status_attr,
2171 XNPreeditAttributes, preedit_attr,
2172 NULL);
2173 XFree (preedit_attr);
2174 XFree (status_attr);
2177 FRAME_XIC (f) = xic;
2178 FRAME_XIC_STYLE (f) = xic_style;
2179 FRAME_XIC_FONTSET (f) = xfs;
2183 /* Destroy XIC and free XIC fontset of frame F, if any. */
2185 void
2186 free_frame_xic (struct frame *f)
2188 if (FRAME_XIC (f) == NULL)
2189 return;
2191 XDestroyIC (FRAME_XIC (f));
2192 xic_free_xfontset (f);
2194 FRAME_XIC (f) = NULL;
2198 /* Place preedit area for XIC of window W's frame to specified
2199 pixel position X/Y. X and Y are relative to window W. */
2201 void
2202 xic_set_preeditarea (struct window *w, int x, int y)
2204 struct frame *f = XFRAME (w->frame);
2205 XVaNestedList attr;
2206 XPoint spot;
2208 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2209 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2210 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2211 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2212 XFree (attr);
2216 /* Place status area for XIC in bottom right corner of frame F.. */
2218 void
2219 xic_set_statusarea (struct frame *f)
2221 XIC xic = FRAME_XIC (f);
2222 XVaNestedList attr;
2223 XRectangle area;
2224 XRectangle *needed;
2226 /* Negotiate geometry of status area. If input method has existing
2227 status area, use its current size. */
2228 area.x = area.y = area.width = area.height = 0;
2229 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2230 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2231 XFree (attr);
2233 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2234 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2235 XFree (attr);
2237 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2239 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2240 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2241 XFree (attr);
2244 area.width = needed->width;
2245 area.height = needed->height;
2246 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2247 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2248 - FRAME_MENUBAR_HEIGHT (f)
2249 - FRAME_TOOLBAR_TOP_HEIGHT (f)
2250 - FRAME_INTERNAL_BORDER_WIDTH (f));
2251 XFree (needed);
2253 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2254 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2255 XFree (attr);
2259 /* Set X fontset for XIC of frame F, using base font name
2260 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2262 void
2263 xic_set_xfontset (struct frame *f, const char *base_fontname)
2265 XVaNestedList attr;
2266 XFontSet xfs;
2268 xic_free_xfontset (f);
2270 xfs = xic_create_xfontset (f);
2272 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2273 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2274 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2275 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2276 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2277 XFree (attr);
2279 FRAME_XIC_FONTSET (f) = xfs;
2282 #endif /* HAVE_X_I18N */
2286 #ifdef USE_X_TOOLKIT
2288 /* Create and set up the X widget for frame F. */
2290 static void
2291 x_window (struct frame *f, long window_prompting, int minibuffer_only)
2293 XClassHint class_hints;
2294 XSetWindowAttributes attributes;
2295 unsigned long attribute_mask;
2296 Widget shell_widget;
2297 Widget pane_widget;
2298 Widget frame_widget;
2299 Arg al [25];
2300 int ac;
2302 block_input ();
2304 /* Use the resource name as the top-level widget name
2305 for looking up resources. Make a non-Lisp copy
2306 for the window manager, so GC relocation won't bother it.
2308 Elsewhere we specify the window name for the window manager. */
2309 f->namebuf = xstrdup (SSDATA (Vx_resource_name));
2311 ac = 0;
2312 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2313 XtSetArg (al[ac], XtNinput, 1); ac++;
2314 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2315 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2316 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2317 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2318 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2319 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2320 applicationShellWidgetClass,
2321 FRAME_X_DISPLAY (f), al, ac);
2323 f->output_data.x->widget = shell_widget;
2324 /* maybe_set_screen_title_format (shell_widget); */
2326 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2327 NULL, shell_widget, False,
2328 NULL, NULL, NULL, NULL);
2330 ac = 0;
2331 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2332 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2333 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2334 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2335 XtSetValues (pane_widget, al, ac);
2336 f->output_data.x->column_widget = pane_widget;
2338 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2339 the emacs screen when changing menubar. This reduces flickering. */
2341 ac = 0;
2342 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2343 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2344 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2345 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2346 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2347 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2348 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2349 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2350 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2351 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2352 al, ac);
2354 f->output_data.x->edit_widget = frame_widget;
2356 XtManageChild (frame_widget);
2358 /* Do some needed geometry management. */
2360 char *tem, shell_position[sizeof "=x++" + 4 * INT_STRLEN_BOUND (int)];
2361 Arg gal[10];
2362 int gac = 0;
2363 int extra_borders = 0;
2364 int menubar_size
2365 = (f->output_data.x->menubar_widget
2366 ? (f->output_data.x->menubar_widget->core.height
2367 + f->output_data.x->menubar_widget->core.border_width)
2368 : 0);
2370 #if 0 /* Experimentally, we now get the right results
2371 for -geometry -0-0 without this. 24 Aug 96, rms. */
2372 if (FRAME_EXTERNAL_MENU_BAR (f))
2374 Dimension ibw = 0;
2375 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2376 menubar_size += ibw;
2378 #endif
2380 f->output_data.x->menubar_height = menubar_size;
2382 #ifndef USE_LUCID
2383 /* Motif seems to need this amount added to the sizes
2384 specified for the shell widget. The Athena/Lucid widgets don't.
2385 Both conclusions reached experimentally. -- rms. */
2386 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2387 &extra_borders, NULL);
2388 extra_borders *= 2;
2389 #endif
2391 /* Convert our geometry parameters into a geometry string
2392 and specify it.
2393 Note that we do not specify here whether the position
2394 is a user-specified or program-specified one.
2395 We pass that information later, in x_wm_set_size_hints. */
2397 int left = f->left_pos;
2398 int xneg = window_prompting & XNegative;
2399 int top = f->top_pos;
2400 int yneg = window_prompting & YNegative;
2401 if (xneg)
2402 left = -left;
2403 if (yneg)
2404 top = -top;
2406 if (window_prompting & USPosition)
2407 sprintf (shell_position, "=%dx%d%c%d%c%d",
2408 FRAME_PIXEL_WIDTH (f) + extra_borders,
2409 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2410 (xneg ? '-' : '+'), left,
2411 (yneg ? '-' : '+'), top);
2412 else
2414 sprintf (shell_position, "=%dx%d",
2415 FRAME_PIXEL_WIDTH (f) + extra_borders,
2416 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2418 /* Setting x and y when the position is not specified in
2419 the geometry string will set program position in the WM hints.
2420 If Emacs had just one program position, we could set it in
2421 fallback resources, but since each make-frame call can specify
2422 different program positions, this is easier. */
2423 XtSetArg (gal[gac], XtNx, left); gac++;
2424 XtSetArg (gal[gac], XtNy, top); gac++;
2428 /* We don't free this because we don't know whether
2429 it is safe to free it while the frame exists.
2430 It isn't worth the trouble of arranging to free it
2431 when the frame is deleted. */
2432 tem = xstrdup (shell_position);
2433 XtSetArg (gal[gac], XtNgeometry, tem); gac++;
2434 XtSetValues (shell_widget, gal, gac);
2437 XtManageChild (pane_widget);
2438 XtRealizeWidget (shell_widget);
2440 if (FRAME_X_EMBEDDED_P (f))
2441 XReparentWindow (FRAME_X_DISPLAY (f), XtWindow (shell_widget),
2442 f->output_data.x->parent_desc, 0, 0);
2444 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2446 validate_x_resource_name ();
2448 class_hints.res_name = SSDATA (Vx_resource_name);
2449 class_hints.res_class = SSDATA (Vx_resource_class);
2450 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2452 #ifdef HAVE_X_I18N
2453 FRAME_XIC (f) = NULL;
2454 if (use_xim)
2455 create_frame_xic (f);
2456 #endif
2458 f->output_data.x->wm_hints.input = True;
2459 f->output_data.x->wm_hints.flags |= InputHint;
2460 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2461 &f->output_data.x->wm_hints);
2463 hack_wm_protocols (f, shell_widget);
2465 #ifdef HACK_EDITRES
2466 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2467 #endif
2469 /* Do a stupid property change to force the server to generate a
2470 PropertyNotify event so that the event_stream server timestamp will
2471 be initialized to something relevant to the time we created the window.
2473 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2474 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
2475 XA_ATOM, 32, PropModeAppend, NULL, 0);
2477 /* Make all the standard events reach the Emacs frame. */
2478 attributes.event_mask = STANDARD_EVENT_SET;
2480 #ifdef HAVE_X_I18N
2481 if (FRAME_XIC (f))
2483 /* XIM server might require some X events. */
2484 unsigned long fevent = NoEventMask;
2485 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2486 attributes.event_mask |= fevent;
2488 #endif /* HAVE_X_I18N */
2490 attribute_mask = CWEventMask;
2491 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2492 attribute_mask, &attributes);
2494 XtMapWidget (frame_widget);
2496 /* x_set_name normally ignores requests to set the name if the
2497 requested name is the same as the current name. This is the one
2498 place where that assumption isn't correct; f->name is set, but
2499 the X server hasn't been told. */
2501 Lisp_Object name;
2502 int explicit = f->explicit_name;
2504 f->explicit_name = 0;
2505 name = f->name;
2506 fset_name (f, Qnil);
2507 x_set_name (f, name, explicit);
2510 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2511 f->output_data.x->current_cursor
2512 = f->output_data.x->text_cursor);
2514 unblock_input ();
2516 /* This is a no-op, except under Motif. Make sure main areas are
2517 set to something reasonable, in case we get an error later. */
2518 lw_set_main_areas (pane_widget, 0, frame_widget);
2521 #else /* not USE_X_TOOLKIT */
2522 #ifdef USE_GTK
2523 static void
2524 x_window (struct frame *f)
2526 if (! xg_create_frame_widgets (f))
2527 error ("Unable to create window");
2529 #ifdef HAVE_X_I18N
2530 FRAME_XIC (f) = NULL;
2531 if (use_xim)
2533 block_input ();
2534 create_frame_xic (f);
2535 if (FRAME_XIC (f))
2537 /* XIM server might require some X events. */
2538 unsigned long fevent = NoEventMask;
2539 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2541 if (fevent != NoEventMask)
2543 XSetWindowAttributes attributes;
2544 XWindowAttributes wattr;
2545 unsigned long attribute_mask;
2547 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2548 &wattr);
2549 attributes.event_mask = wattr.your_event_mask | fevent;
2550 attribute_mask = CWEventMask;
2551 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2552 attribute_mask, &attributes);
2555 unblock_input ();
2557 #endif
2560 #else /*! USE_GTK */
2561 /* Create and set up the X window for frame F. */
2563 static void
2564 x_window (struct frame *f)
2566 XClassHint class_hints;
2567 XSetWindowAttributes attributes;
2568 unsigned long attribute_mask;
2570 attributes.background_pixel = FRAME_BACKGROUND_PIXEL (f);
2571 attributes.border_pixel = f->output_data.x->border_pixel;
2572 attributes.bit_gravity = StaticGravity;
2573 attributes.backing_store = NotUseful;
2574 attributes.save_under = True;
2575 attributes.event_mask = STANDARD_EVENT_SET;
2576 attributes.colormap = FRAME_X_COLORMAP (f);
2577 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2578 | CWColormap);
2580 block_input ();
2581 FRAME_X_WINDOW (f)
2582 = XCreateWindow (FRAME_X_DISPLAY (f),
2583 f->output_data.x->parent_desc,
2584 f->left_pos,
2585 f->top_pos,
2586 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2587 f->border_width,
2588 CopyFromParent, /* depth */
2589 InputOutput, /* class */
2590 FRAME_X_VISUAL (f),
2591 attribute_mask, &attributes);
2593 #ifdef HAVE_X_I18N
2594 if (use_xim)
2596 create_frame_xic (f);
2597 if (FRAME_XIC (f))
2599 /* XIM server might require some X events. */
2600 unsigned long fevent = NoEventMask;
2601 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2602 attributes.event_mask |= fevent;
2603 attribute_mask = CWEventMask;
2604 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2605 attribute_mask, &attributes);
2608 #endif /* HAVE_X_I18N */
2610 validate_x_resource_name ();
2612 class_hints.res_name = SSDATA (Vx_resource_name);
2613 class_hints.res_class = SSDATA (Vx_resource_class);
2614 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2616 /* The menubar is part of the ordinary display;
2617 it does not count in addition to the height of the window. */
2618 f->output_data.x->menubar_height = 0;
2620 /* This indicates that we use the "Passive Input" input model.
2621 Unless we do this, we don't get the Focus{In,Out} events that we
2622 need to draw the cursor correctly. Accursed bureaucrats.
2623 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2625 f->output_data.x->wm_hints.input = True;
2626 f->output_data.x->wm_hints.flags |= InputHint;
2627 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2628 &f->output_data.x->wm_hints);
2629 f->output_data.x->wm_hints.icon_pixmap = None;
2631 /* Request "save yourself" and "delete window" commands from wm. */
2633 Atom protocols[2];
2634 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2635 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2636 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2639 /* x_set_name normally ignores requests to set the name if the
2640 requested name is the same as the current name. This is the one
2641 place where that assumption isn't correct; f->name is set, but
2642 the X server hasn't been told. */
2644 Lisp_Object name;
2645 int explicit = f->explicit_name;
2647 f->explicit_name = 0;
2648 name = f->name;
2649 fset_name (f, Qnil);
2650 x_set_name (f, name, explicit);
2653 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2654 f->output_data.x->current_cursor
2655 = f->output_data.x->text_cursor);
2657 unblock_input ();
2659 if (FRAME_X_WINDOW (f) == 0)
2660 error ("Unable to create window");
2663 #endif /* not USE_GTK */
2664 #endif /* not USE_X_TOOLKIT */
2666 /* Verify that the icon position args for this window are valid. */
2668 static void
2669 x_icon_verify (struct frame *f, Lisp_Object parms)
2671 Lisp_Object icon_x, icon_y;
2673 /* Set the position of the icon. Note that twm groups all
2674 icons in an icon window. */
2675 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2676 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2677 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2679 CHECK_NUMBER (icon_x);
2680 CHECK_NUMBER (icon_y);
2682 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2683 error ("Both left and top icon corners of icon must be specified");
2686 /* Handle the icon stuff for this window. Perhaps later we might
2687 want an x_set_icon_position which can be called interactively as
2688 well. */
2690 static void
2691 x_icon (struct frame *f, Lisp_Object parms)
2693 Lisp_Object icon_x, icon_y;
2694 #if 0
2695 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2696 #endif
2698 /* Set the position of the icon. Note that twm groups all
2699 icons in an icon window. */
2700 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2701 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2702 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2704 CHECK_TYPE_RANGED_INTEGER (int, icon_x);
2705 CHECK_TYPE_RANGED_INTEGER (int, icon_y);
2707 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2708 error ("Both left and top icon corners of icon must be specified");
2710 block_input ();
2712 if (! EQ (icon_x, Qunbound))
2713 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2715 #if 0 /* x_get_arg removes the visibility parameter as a side effect,
2716 but x_create_frame still needs it. */
2717 /* Start up iconic or window? */
2718 x_wm_set_window_state
2719 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2720 Qicon)
2721 ? IconicState
2722 : NormalState));
2723 #endif
2725 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
2726 ? f->icon_name
2727 : f->name)));
2729 unblock_input ();
2732 /* Make the GCs needed for this window, setting the
2733 background, border and mouse colors; also create the
2734 mouse cursor and the gray border tile. */
2736 static void
2737 x_make_gc (struct frame *f)
2739 XGCValues gc_values;
2741 block_input ();
2743 /* Create the GCs of this frame.
2744 Note that many default values are used. */
2746 gc_values.foreground = FRAME_FOREGROUND_PIXEL (f);
2747 gc_values.background = FRAME_BACKGROUND_PIXEL (f);
2748 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2749 f->output_data.x->normal_gc
2750 = XCreateGC (FRAME_X_DISPLAY (f),
2751 FRAME_X_WINDOW (f),
2752 GCLineWidth | GCForeground | GCBackground,
2753 &gc_values);
2755 /* Reverse video style. */
2756 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2757 gc_values.background = FRAME_FOREGROUND_PIXEL (f);
2758 f->output_data.x->reverse_gc
2759 = XCreateGC (FRAME_X_DISPLAY (f),
2760 FRAME_X_WINDOW (f),
2761 GCForeground | GCBackground | GCLineWidth,
2762 &gc_values);
2764 /* Cursor has cursor-color background, background-color foreground. */
2765 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2766 gc_values.background = f->output_data.x->cursor_pixel;
2767 gc_values.fill_style = FillOpaqueStippled;
2768 f->output_data.x->cursor_gc
2769 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2770 (GCForeground | GCBackground
2771 | GCFillStyle | GCLineWidth),
2772 &gc_values);
2774 /* Create the gray border tile used when the pointer is not in
2775 the frame. Since this depends on the frame's pixel values,
2776 this must be done on a per-frame basis. */
2777 f->output_data.x->border_tile
2778 = (XCreatePixmapFromBitmapData
2779 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
2780 gray_bits, gray_width, gray_height,
2781 FRAME_FOREGROUND_PIXEL (f),
2782 FRAME_BACKGROUND_PIXEL (f),
2783 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2785 unblock_input ();
2789 /* Free what was allocated in x_make_gc. */
2791 void
2792 x_free_gcs (struct frame *f)
2794 Display *dpy = FRAME_X_DISPLAY (f);
2796 block_input ();
2798 if (f->output_data.x->normal_gc)
2800 XFreeGC (dpy, f->output_data.x->normal_gc);
2801 f->output_data.x->normal_gc = 0;
2804 if (f->output_data.x->reverse_gc)
2806 XFreeGC (dpy, f->output_data.x->reverse_gc);
2807 f->output_data.x->reverse_gc = 0;
2810 if (f->output_data.x->cursor_gc)
2812 XFreeGC (dpy, f->output_data.x->cursor_gc);
2813 f->output_data.x->cursor_gc = 0;
2816 if (f->output_data.x->border_tile)
2818 XFreePixmap (dpy, f->output_data.x->border_tile);
2819 f->output_data.x->border_tile = 0;
2822 unblock_input ();
2826 /* Handler for signals raised during x_create_frame and
2827 x_create_tip_frame. FRAME is the frame which is partially
2828 constructed. */
2830 static Lisp_Object
2831 unwind_create_frame (Lisp_Object frame)
2833 struct frame *f = XFRAME (frame);
2835 /* If frame is already dead, nothing to do. This can happen if the
2836 display is disconnected after the frame has become official, but
2837 before x_create_frame removes the unwind protect. */
2838 if (!FRAME_LIVE_P (f))
2839 return Qnil;
2841 /* If frame is ``official'', nothing to do. */
2842 if (NILP (Fmemq (frame, Vframe_list)))
2844 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2845 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2846 #endif
2848 x_free_frame_resources (f);
2849 free_glyphs (f);
2851 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2852 /* Check that reference counts are indeed correct. */
2853 eassert (dpyinfo->reference_count == dpyinfo_refcount);
2854 eassert (dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
2855 #endif
2856 return Qt;
2859 return Qnil;
2862 static void
2863 do_unwind_create_frame (Lisp_Object frame)
2865 unwind_create_frame (frame);
2868 static void
2869 unwind_create_frame_1 (Lisp_Object val)
2871 inhibit_lisp_code = val;
2874 static void
2875 x_default_font_parameter (struct frame *f, Lisp_Object parms)
2877 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2878 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
2879 RES_TYPE_STRING);
2880 Lisp_Object font = Qnil;
2881 if (EQ (font_param, Qunbound))
2882 font_param = Qnil;
2884 if (NILP (font_param))
2886 /* System font should take precedence over X resources. We suggest this
2887 regardless of font-use-system-font because .emacs may not have been
2888 read yet. */
2889 const char *system_font = xsettings_get_system_font ();
2890 if (system_font)
2891 font = font_open_by_name (f, build_unibyte_string (system_font));
2894 if (NILP (font))
2895 font = !NILP (font_param) ? font_param
2896 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
2898 if (! FONTP (font) && ! STRINGP (font))
2900 const char *names[]
2902 #ifdef HAVE_XFT
2903 /* This will find the normal Xft font. */
2904 "monospace-10",
2905 #endif
2906 "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1",
2907 "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2908 "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2909 /* This was formerly the first thing tried, but it finds
2910 too many fonts and takes too long. */
2911 "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1",
2912 /* If those didn't work, look for something which will
2913 at least work. */
2914 "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1",
2915 "fixed",
2916 NULL };
2917 int i;
2919 for (i = 0; names[i]; i++)
2921 font = font_open_by_name (f, build_unibyte_string (names[i]));
2922 if (! NILP (font))
2923 break;
2925 if (NILP (font))
2926 error ("No suitable font was found");
2928 else if (!NILP (font_param))
2930 /* Remember the explicit font parameter, so we can re-apply it after
2931 we've applied the `default' face settings. */
2932 x_set_frame_parameters (f, list1 (Fcons (Qfont_param, font_param)));
2935 /* This call will make X resources override any system font setting. */
2936 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
2940 DEFUN ("x-wm-set-size-hint", Fx_wm_set_size_hint, Sx_wm_set_size_hint,
2941 0, 1, 0,
2942 doc: /* Send the size hints for frame FRAME to the window manager.
2943 If FRAME is omitted or nil, use the selected frame.
2944 Signal error if FRAME is not an X frame. */)
2945 (Lisp_Object frame)
2947 struct frame *f = decode_window_system_frame (frame);
2949 block_input ();
2950 x_wm_set_size_hint (f, 0, 0);
2951 unblock_input ();
2952 return Qnil;
2955 static void
2956 set_machine_and_pid_properties (struct frame *f)
2958 long pid = (long) getpid ();
2960 /* This will set WM_CLIENT_MACHINE and WM_LOCALE_NAME. */
2961 XSetWMProperties (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), NULL, NULL,
2962 NULL, 0, NULL, NULL, NULL);
2963 XChangeProperty (FRAME_X_DISPLAY (f),
2964 FRAME_OUTER_WINDOW (f),
2965 XInternAtom (FRAME_X_DISPLAY (f),
2966 "_NET_WM_PID",
2967 False),
2968 XA_CARDINAL, 32, PropModeReplace,
2969 (unsigned char *) &pid, 1);
2972 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
2973 1, 1, 0,
2974 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
2975 Return an Emacs frame object.
2976 PARMS is an alist of frame parameters.
2977 If the parameters specify that the frame should not have a minibuffer,
2978 and do not specify a specific minibuffer window to use,
2979 then `default-minibuffer-frame' must be a frame whose minibuffer can
2980 be shared by the new frame.
2982 This function is an internal primitive--use `make-frame' instead. */)
2983 (Lisp_Object parms)
2985 struct frame *f;
2986 Lisp_Object frame, tem;
2987 Lisp_Object name;
2988 int minibuffer_only = 0;
2989 long window_prompting = 0;
2990 int width, height;
2991 ptrdiff_t count = SPECPDL_INDEX ();
2992 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2993 Lisp_Object display;
2994 struct x_display_info *dpyinfo = NULL;
2995 Lisp_Object parent;
2996 struct kboard *kb;
2998 parms = Fcopy_alist (parms);
3000 /* Use this general default value to start with
3001 until we know if this frame has a specified name. */
3002 Vx_resource_name = Vinvocation_name;
3004 display = x_get_arg (dpyinfo, parms, Qterminal, 0, 0, RES_TYPE_NUMBER);
3005 if (EQ (display, Qunbound))
3006 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3007 if (EQ (display, Qunbound))
3008 display = Qnil;
3009 dpyinfo = check_x_display_info (display);
3010 kb = dpyinfo->terminal->kboard;
3012 if (!dpyinfo->terminal->name)
3013 error ("Terminal is not live, can't create new frames on it");
3015 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3016 if (!STRINGP (name)
3017 && ! EQ (name, Qunbound)
3018 && ! NILP (name))
3019 error ("Invalid frame name--not a string or nil");
3021 if (STRINGP (name))
3022 Vx_resource_name = name;
3024 /* See if parent window is specified. */
3025 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3026 if (EQ (parent, Qunbound))
3027 parent = Qnil;
3028 if (! NILP (parent))
3029 CHECK_NUMBER (parent);
3031 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3032 /* No need to protect DISPLAY because that's not used after passing
3033 it to make_frame_without_minibuffer. */
3034 frame = Qnil;
3035 GCPRO4 (parms, parent, name, frame);
3036 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3037 RES_TYPE_SYMBOL);
3038 if (EQ (tem, Qnone) || NILP (tem))
3039 f = make_frame_without_minibuffer (Qnil, kb, display);
3040 else if (EQ (tem, Qonly))
3042 f = make_minibuffer_frame ();
3043 minibuffer_only = 1;
3045 else if (WINDOWP (tem))
3046 f = make_frame_without_minibuffer (tem, kb, display);
3047 else
3048 f = make_frame (1);
3050 XSETFRAME (frame, f);
3052 f->terminal = dpyinfo->terminal;
3054 f->output_method = output_x_window;
3055 f->output_data.x = xzalloc (sizeof *f->output_data.x);
3056 f->output_data.x->icon_bitmap = -1;
3057 FRAME_FONTSET (f) = -1;
3058 f->output_data.x->scroll_bar_foreground_pixel = -1;
3059 f->output_data.x->scroll_bar_background_pixel = -1;
3060 #ifdef USE_TOOLKIT_SCROLL_BARS
3061 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3062 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3063 #endif /* USE_TOOLKIT_SCROLL_BARS */
3065 fset_icon_name (f,
3066 x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3067 RES_TYPE_STRING));
3068 if (! STRINGP (f->icon_name))
3069 fset_icon_name (f, Qnil);
3071 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3073 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
3074 record_unwind_protect (do_unwind_create_frame, frame);
3076 /* These colors will be set anyway later, but it's important
3077 to get the color reference counts right, so initialize them! */
3079 Lisp_Object black;
3080 struct gcpro gcpro1;
3082 /* Function x_decode_color can signal an error. Make
3083 sure to initialize color slots so that we won't try
3084 to free colors we haven't allocated. */
3085 FRAME_FOREGROUND_PIXEL (f) = -1;
3086 FRAME_BACKGROUND_PIXEL (f) = -1;
3087 f->output_data.x->cursor_pixel = -1;
3088 f->output_data.x->cursor_foreground_pixel = -1;
3089 f->output_data.x->border_pixel = -1;
3090 f->output_data.x->mouse_pixel = -1;
3092 black = build_string ("black");
3093 GCPRO1 (black);
3094 FRAME_FOREGROUND_PIXEL (f)
3095 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3096 FRAME_BACKGROUND_PIXEL (f)
3097 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3098 f->output_data.x->cursor_pixel
3099 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3100 f->output_data.x->cursor_foreground_pixel
3101 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3102 f->output_data.x->border_pixel
3103 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3104 f->output_data.x->mouse_pixel
3105 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3106 UNGCPRO;
3109 /* Specify the parent under which to make this X window. */
3111 if (!NILP (parent))
3113 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3114 f->output_data.x->explicit_parent = 1;
3116 else
3118 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3119 f->output_data.x->explicit_parent = 0;
3122 /* Set the name; the functions to which we pass f expect the name to
3123 be set. */
3124 if (EQ (name, Qunbound) || NILP (name))
3126 fset_name (f, build_string (dpyinfo->x_id_name));
3127 f->explicit_name = 0;
3129 else
3131 fset_name (f, name);
3132 f->explicit_name = 1;
3133 /* use the frame's title when getting resources for this frame. */
3134 specbind (Qx_resource_name, name);
3137 #ifdef HAVE_FREETYPE
3138 #ifdef HAVE_XFT
3139 register_font_driver (&xftfont_driver, f);
3140 #else /* not HAVE_XFT */
3141 register_font_driver (&ftxfont_driver, f);
3142 #endif /* not HAVE_XFT */
3143 #endif /* HAVE_FREETYPE */
3144 register_font_driver (&xfont_driver, f);
3146 x_default_parameter (f, parms, Qfont_backend, Qnil,
3147 "fontBackend", "FontBackend", RES_TYPE_STRING);
3149 /* Extract the window parameters from the supplied values
3150 that are needed to determine window geometry. */
3151 x_default_font_parameter (f, parms);
3152 if (!FRAME_FONT (f))
3154 delete_frame (frame, Qnoelisp);
3155 error ("Invalid frame font");
3158 /* Frame contents get displaced if an embedded X window has a border. */
3159 if (! FRAME_X_EMBEDDED_P (f))
3160 x_default_parameter (f, parms, Qborder_width, make_number (0),
3161 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3163 /* This defaults to 1 in order to match xterm. We recognize either
3164 internalBorderWidth or internalBorder (which is what xterm calls
3165 it). */
3166 if (NILP (Fassq (Qinternal_border_width, parms)))
3168 Lisp_Object value;
3170 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3171 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3172 if (! EQ (value, Qunbound))
3173 parms = Fcons (Fcons (Qinternal_border_width, value),
3174 parms);
3176 x_default_parameter (f, parms, Qinternal_border_width,
3177 #ifdef USE_GTK /* We used to impose 0 in xg_create_frame_widgets. */
3178 make_number (0),
3179 #else
3180 make_number (1),
3181 #endif
3182 "internalBorderWidth", "internalBorderWidth",
3183 RES_TYPE_NUMBER);
3184 x_default_parameter (f, parms, Qvertical_scroll_bars,
3185 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3186 Qright,
3187 #else
3188 Qleft,
3189 #endif
3190 "verticalScrollBars", "ScrollBars",
3191 RES_TYPE_SYMBOL);
3193 /* Also do the stuff which must be set before the window exists. */
3194 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3195 "foreground", "Foreground", RES_TYPE_STRING);
3196 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3197 "background", "Background", RES_TYPE_STRING);
3198 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3199 "pointerColor", "Foreground", RES_TYPE_STRING);
3200 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3201 "borderColor", "BorderColor", RES_TYPE_STRING);
3202 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3203 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3204 x_default_parameter (f, parms, Qline_spacing, Qnil,
3205 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3206 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3207 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3208 x_default_parameter (f, parms, Qright_fringe, Qnil,
3209 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3211 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3212 "scrollBarForeground",
3213 "ScrollBarForeground", 1);
3214 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3215 "scrollBarBackground",
3216 "ScrollBarBackground", 0);
3218 #ifdef GLYPH_DEBUG
3219 image_cache_refcount =
3220 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
3221 dpyinfo_refcount = dpyinfo->reference_count;
3222 #endif /* GLYPH_DEBUG */
3224 /* Init faces before x_default_parameter is called for scroll-bar
3225 parameters because that function calls x_set_scroll_bar_width,
3226 which calls change_frame_size, which calls Fset_window_buffer,
3227 which runs hooks, which call Fvertical_motion. At the end, we
3228 end up in init_iterator with a null face cache, which should not
3229 happen. */
3230 init_frame_faces (f);
3232 /* Set the menu-bar-lines and tool-bar-lines parameters. We don't
3233 look up the X resources controlling the menu-bar and tool-bar
3234 here; they are processed specially at startup, and reflected in
3235 the values of the mode variables.
3237 Avoid calling window-configuration-change-hook; otherwise we
3238 could get an infloop in next_frame since the frame is not yet in
3239 Vframe_list. */
3241 ptrdiff_t count2 = SPECPDL_INDEX ();
3242 record_unwind_protect (unwind_create_frame_1, inhibit_lisp_code);
3243 inhibit_lisp_code = Qt;
3245 x_default_parameter (f, parms, Qmenu_bar_lines,
3246 NILP (Vmenu_bar_mode)
3247 ? make_number (0) : make_number (1),
3248 NULL, NULL, RES_TYPE_NUMBER);
3249 x_default_parameter (f, parms, Qtool_bar_lines,
3250 NILP (Vtool_bar_mode)
3251 ? make_number (0) : make_number (1),
3252 NULL, NULL, RES_TYPE_NUMBER);
3254 unbind_to (count2, Qnil);
3257 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3258 "bufferPredicate", "BufferPredicate",
3259 RES_TYPE_SYMBOL);
3260 x_default_parameter (f, parms, Qtitle, Qnil,
3261 "title", "Title", RES_TYPE_STRING);
3262 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3263 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3264 x_default_parameter (f, parms, Qfullscreen, Qnil,
3265 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3266 x_default_parameter (f, parms, Qtool_bar_position,
3267 f->tool_bar_position, 0, 0, RES_TYPE_SYMBOL);
3269 /* Compute the size of the X window. */
3270 window_prompting = x_figure_window_size (f, parms, 1);
3272 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3273 f->no_split = minibuffer_only || EQ (tem, Qt);
3275 x_icon_verify (f, parms);
3277 /* Create the X widget or window. */
3278 #ifdef USE_X_TOOLKIT
3279 x_window (f, window_prompting, minibuffer_only);
3280 #else
3281 x_window (f);
3282 #endif
3284 x_icon (f, parms);
3285 x_make_gc (f);
3287 /* Now consider the frame official. */
3288 f->terminal->reference_count++;
3289 FRAME_X_DISPLAY_INFO (f)->reference_count++;
3290 Vframe_list = Fcons (frame, Vframe_list);
3292 /* We need to do this after creating the X window, so that the
3293 icon-creation functions can say whose icon they're describing. */
3294 x_default_parameter (f, parms, Qicon_type, Qt,
3295 "bitmapIcon", "BitmapIcon", RES_TYPE_BOOLEAN);
3297 x_default_parameter (f, parms, Qauto_raise, Qnil,
3298 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3299 x_default_parameter (f, parms, Qauto_lower, Qnil,
3300 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3301 x_default_parameter (f, parms, Qcursor_type, Qbox,
3302 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3303 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3304 "scrollBarWidth", "ScrollBarWidth",
3305 RES_TYPE_NUMBER);
3306 x_default_parameter (f, parms, Qalpha, Qnil,
3307 "alpha", "Alpha", RES_TYPE_NUMBER);
3309 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3310 Change will not be effected unless different from the current
3311 FRAME_LINES (f). */
3312 width = FRAME_COLS (f);
3313 height = FRAME_LINES (f);
3315 SET_FRAME_COLS (f, 0);
3316 FRAME_LINES (f) = 0;
3317 change_frame_size (f, height, width, 1, 0, 0);
3319 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3320 /* Create the menu bar. */
3321 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3323 /* If this signals an error, we haven't set size hints for the
3324 frame and we didn't make it visible. */
3325 initialize_frame_menubar (f);
3327 #ifndef USE_GTK
3328 /* This is a no-op, except under Motif where it arranges the
3329 main window for the widgets on it. */
3330 lw_set_main_areas (f->output_data.x->column_widget,
3331 f->output_data.x->menubar_widget,
3332 f->output_data.x->edit_widget);
3333 #endif /* not USE_GTK */
3335 #endif /* USE_X_TOOLKIT || USE_GTK */
3337 /* Tell the server what size and position, etc, we want, and how
3338 badly we want them. This should be done after we have the menu
3339 bar so that its size can be taken into account. */
3340 block_input ();
3341 x_wm_set_size_hint (f, window_prompting, 0);
3342 unblock_input ();
3344 /* Make the window appear on the frame and enable display, unless
3345 the caller says not to. However, with explicit parent, Emacs
3346 cannot control visibility, so don't try. */
3347 if (! f->output_data.x->explicit_parent)
3349 Lisp_Object visibility;
3351 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3352 RES_TYPE_SYMBOL);
3353 if (EQ (visibility, Qunbound))
3354 visibility = Qt;
3356 if (EQ (visibility, Qicon))
3357 x_iconify_frame (f);
3358 else if (! NILP (visibility))
3359 x_make_frame_visible (f);
3360 else
3362 /* Must have been Qnil. */
3366 block_input ();
3368 /* Set machine name and pid for the purpose of window managers. */
3369 set_machine_and_pid_properties (f);
3371 /* Set the WM leader property. GTK does this itself, so this is not
3372 needed when using GTK. */
3373 if (dpyinfo->client_leader_window != 0)
3375 XChangeProperty (FRAME_X_DISPLAY (f),
3376 FRAME_OUTER_WINDOW (f),
3377 dpyinfo->Xatom_wm_client_leader,
3378 XA_WINDOW, 32, PropModeReplace,
3379 (unsigned char *) &dpyinfo->client_leader_window, 1);
3382 unblock_input ();
3384 /* Initialize `default-minibuffer-frame' in case this is the first
3385 frame on this terminal. */
3386 if (FRAME_HAS_MINIBUF_P (f)
3387 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
3388 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
3389 kset_default_minibuffer_frame (kb, frame);
3391 /* All remaining specified parameters, which have not been "used"
3392 by x_get_arg and friends, now go in the misc. alist of the frame. */
3393 for (tem = parms; CONSP (tem); tem = XCDR (tem))
3394 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3395 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
3397 UNGCPRO;
3399 /* Make sure windows on this frame appear in calls to next-window
3400 and similar functions. */
3401 Vwindow_list = Qnil;
3403 return unbind_to (count, frame);
3407 /* FRAME is used only to get a handle on the X display. We don't pass the
3408 display info directly because we're called from frame.c, which doesn't
3409 know about that structure. */
3411 Lisp_Object
3412 x_get_focus_frame (struct frame *frame)
3414 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
3415 Lisp_Object xfocus;
3416 if (! dpyinfo->x_focus_frame)
3417 return Qnil;
3419 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3420 return xfocus;
3424 /* In certain situations, when the window manager follows a
3425 click-to-focus policy, there seems to be no way around calling
3426 XSetInputFocus to give another frame the input focus .
3428 In an ideal world, XSetInputFocus should generally be avoided so
3429 that applications don't interfere with the window manager's focus
3430 policy. But I think it's okay to use when it's clearly done
3431 following a user-command. */
3433 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
3434 doc: /* Set the input focus to FRAME.
3435 FRAME nil means use the selected frame. */)
3436 (Lisp_Object frame)
3438 struct frame *f = decode_window_system_frame (frame);
3439 Display *dpy = FRAME_X_DISPLAY (f);
3441 block_input ();
3442 x_catch_errors (dpy);
3444 if (FRAME_X_EMBEDDED_P (f))
3446 /* For Xembedded frames, normally the embedder forwards key
3447 events. See XEmbed Protocol Specification at
3448 http://freedesktop.org/wiki/Specifications/xembed-spec */
3449 xembed_request_focus (f);
3451 else
3453 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3454 RevertToParent, CurrentTime);
3455 x_ewmh_activate_frame (f);
3458 x_uncatch_errors ();
3459 unblock_input ();
3461 return Qnil;
3465 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3466 doc: /* Internal function called by `color-defined-p', which see
3467 .\(Note that the Nextstep version of this function ignores FRAME.) */)
3468 (Lisp_Object color, Lisp_Object frame)
3470 XColor foo;
3471 struct frame *f = decode_window_system_frame (frame);
3473 CHECK_STRING (color);
3475 if (x_defined_color (f, SSDATA (color), &foo, 0))
3476 return Qt;
3477 else
3478 return Qnil;
3481 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3482 doc: /* Internal function called by `color-values', which see. */)
3483 (Lisp_Object color, Lisp_Object frame)
3485 XColor foo;
3486 struct frame *f = decode_window_system_frame (frame);
3488 CHECK_STRING (color);
3490 if (x_defined_color (f, SSDATA (color), &foo, 0))
3491 return list3i (foo.red, foo.green, foo.blue);
3492 else
3493 return Qnil;
3496 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3497 doc: /* Internal function called by `display-color-p', which see. */)
3498 (Lisp_Object terminal)
3500 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3502 if (dpyinfo->n_planes <= 2)
3503 return Qnil;
3505 switch (dpyinfo->visual->class)
3507 case StaticColor:
3508 case PseudoColor:
3509 case TrueColor:
3510 case DirectColor:
3511 return Qt;
3513 default:
3514 return Qnil;
3518 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3519 0, 1, 0,
3520 doc: /* Return t if the X display supports shades of gray.
3521 Note that color displays do support shades of gray.
3522 The optional argument TERMINAL specifies which display to ask about.
3523 TERMINAL should be a terminal object, a frame or a display name (a string).
3524 If omitted or nil, that stands for the selected frame's display. */)
3525 (Lisp_Object terminal)
3527 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3529 if (dpyinfo->n_planes <= 1)
3530 return Qnil;
3532 switch (dpyinfo->visual->class)
3534 case StaticColor:
3535 case PseudoColor:
3536 case TrueColor:
3537 case DirectColor:
3538 case StaticGray:
3539 case GrayScale:
3540 return Qt;
3542 default:
3543 return Qnil;
3547 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3548 0, 1, 0,
3549 doc: /* Return the width in pixels of the X display TERMINAL.
3550 The optional argument TERMINAL specifies which display to ask about.
3551 TERMINAL should be a terminal object, a frame or a display name (a string).
3552 If omitted or nil, that stands for the selected frame's display.
3554 On \"multi-monitor\" setups this refers to the pixel width for all
3555 physical monitors associated with TERMINAL. To get information for
3556 each physical monitor, use `display-monitor-attributes-list'. */)
3557 (Lisp_Object terminal)
3559 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3561 return make_number (x_display_pixel_width (dpyinfo));
3564 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3565 Sx_display_pixel_height, 0, 1, 0,
3566 doc: /* Return the height in pixels of the X display TERMINAL.
3567 The optional argument TERMINAL specifies which display to ask about.
3568 TERMINAL should be a terminal object, a frame or a display name (a string).
3569 If omitted or nil, that stands for the selected frame's display.
3571 On \"multi-monitor\" setups this refers to the pixel height for all
3572 physical monitors associated with TERMINAL. To get information for
3573 each physical monitor, use `display-monitor-attributes-list'. */)
3574 (Lisp_Object terminal)
3576 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3578 return make_number (x_display_pixel_height (dpyinfo));
3581 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3582 0, 1, 0,
3583 doc: /* Return the number of bitplanes of the X display TERMINAL.
3584 The optional argument TERMINAL specifies which display to ask about.
3585 TERMINAL should be a terminal object, a frame or a display name (a string).
3586 If omitted or nil, that stands for the selected frame's display. */)
3587 (Lisp_Object terminal)
3589 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3591 return make_number (dpyinfo->n_planes);
3594 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3595 0, 1, 0,
3596 doc: /* Return the number of color cells of the X display TERMINAL.
3597 The optional argument TERMINAL specifies which display to ask about.
3598 TERMINAL should be a terminal object, a frame or a display name (a string).
3599 If omitted or nil, that stands for the selected frame's display. */)
3600 (Lisp_Object terminal)
3602 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3604 int nr_planes = DisplayPlanes (dpyinfo->display,
3605 XScreenNumberOfScreen (dpyinfo->screen));
3607 /* Truncate nr_planes to 24 to avoid integer overflow.
3608 Some displays says 32, but only 24 bits are actually significant.
3609 There are only very few and rare video cards that have more than
3610 24 significant bits. Also 24 bits is more than 16 million colors,
3611 it "should be enough for everyone". */
3612 if (nr_planes > 24) nr_planes = 24;
3614 return make_number (1 << nr_planes);
3617 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3618 Sx_server_max_request_size,
3619 0, 1, 0,
3620 doc: /* Return the maximum request size of the X server of display TERMINAL.
3621 The optional argument TERMINAL specifies which display to ask about.
3622 TERMINAL should be a terminal object, a frame or a display name (a string).
3623 If omitted or nil, that stands for the selected frame's display. */)
3624 (Lisp_Object terminal)
3626 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3628 return make_number (MAXREQUEST (dpyinfo->display));
3631 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3632 doc: /* Return the "vendor ID" string of the X server of display TERMINAL.
3633 \(Labeling every distributor as a "vendor" embodies the false assumption
3634 that operating systems cannot be developed and distributed noncommercially.)
3635 The optional argument TERMINAL specifies which display to ask about.
3636 TERMINAL should be a terminal object, a frame or a display name (a string).
3637 If omitted or nil, that stands for the selected frame's display. */)
3638 (Lisp_Object terminal)
3640 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3641 const char *vendor = ServerVendor (dpyinfo->display);
3643 if (! vendor) vendor = "";
3644 return build_string (vendor);
3647 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3648 doc: /* Return the version numbers of the X server of display TERMINAL.
3649 The value is a list of three integers: the major and minor
3650 version numbers of the X Protocol in use, and the distributor-specific release
3651 number. See also the function `x-server-vendor'.
3653 The optional argument TERMINAL specifies which display to ask about.
3654 TERMINAL should be a terminal object, a frame or a display name (a string).
3655 If omitted or nil, that stands for the selected frame's display. */)
3656 (Lisp_Object terminal)
3658 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3659 Display *dpy = dpyinfo->display;
3661 return list3i (ProtocolVersion (dpy), ProtocolRevision (dpy),
3662 VendorRelease (dpy));
3665 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3666 doc: /* Return the number of screens on the X server of display TERMINAL.
3667 The optional argument TERMINAL specifies which display to ask about.
3668 TERMINAL should be a terminal object, a frame or a display name (a string).
3669 If omitted or nil, that stands for the selected frame's display. */)
3670 (Lisp_Object terminal)
3672 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3674 return make_number (ScreenCount (dpyinfo->display));
3677 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3678 doc: /* Return the height in millimeters of the X display TERMINAL.
3679 The optional argument TERMINAL specifies which display to ask about.
3680 TERMINAL should be a terminal object, a frame or a display name (a string).
3681 If omitted or nil, that stands for the selected frame's display.
3683 On \"multi-monitor\" setups this refers to the height in millimeters for
3684 all physical monitors associated with TERMINAL. To get information
3685 for each physical monitor, use `display-monitor-attributes-list'. */)
3686 (Lisp_Object terminal)
3688 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3690 return make_number (HeightMMOfScreen (dpyinfo->screen));
3693 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3694 doc: /* Return the width in millimeters of the X display TERMINAL.
3695 The optional argument TERMINAL specifies which display to ask about.
3696 TERMINAL should be a terminal object, a frame or a display name (a string).
3697 If omitted or nil, that stands for the selected frame's display.
3699 On \"multi-monitor\" setups this refers to the width in millimeters for
3700 all physical monitors associated with TERMINAL. To get information
3701 for each physical monitor, use `display-monitor-attributes-list'. */)
3702 (Lisp_Object terminal)
3704 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3706 return make_number (WidthMMOfScreen (dpyinfo->screen));
3709 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3710 Sx_display_backing_store, 0, 1, 0,
3711 doc: /* Return an indication of whether X display TERMINAL does backing store.
3712 The value may be `always', `when-mapped', or `not-useful'.
3713 The optional argument TERMINAL specifies which display to ask about.
3714 TERMINAL should be a terminal object, a frame or a display name (a string).
3715 If omitted or nil, that stands for the selected frame's display. */)
3716 (Lisp_Object terminal)
3718 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3719 Lisp_Object result;
3721 switch (DoesBackingStore (dpyinfo->screen))
3723 case Always:
3724 result = intern ("always");
3725 break;
3727 case WhenMapped:
3728 result = intern ("when-mapped");
3729 break;
3731 case NotUseful:
3732 result = intern ("not-useful");
3733 break;
3735 default:
3736 error ("Strange value for BackingStore parameter of screen");
3739 return result;
3742 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3743 Sx_display_visual_class, 0, 1, 0,
3744 doc: /* Return the visual class of the X display TERMINAL.
3745 The value is one of the symbols `static-gray', `gray-scale',
3746 `static-color', `pseudo-color', `true-color', or `direct-color'.
3748 The optional argument TERMINAL specifies which display to ask about.
3749 TERMINAL should a terminal object, a frame or a display name (a string).
3750 If omitted or nil, that stands for the selected frame's display. */)
3751 (Lisp_Object terminal)
3753 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3754 Lisp_Object result;
3756 switch (dpyinfo->visual->class)
3758 case StaticGray:
3759 result = intern ("static-gray");
3760 break;
3761 case GrayScale:
3762 result = intern ("gray-scale");
3763 break;
3764 case StaticColor:
3765 result = intern ("static-color");
3766 break;
3767 case PseudoColor:
3768 result = intern ("pseudo-color");
3769 break;
3770 case TrueColor:
3771 result = intern ("true-color");
3772 break;
3773 case DirectColor:
3774 result = intern ("direct-color");
3775 break;
3776 default:
3777 error ("Display has an unknown visual class");
3780 return result;
3783 DEFUN ("x-display-save-under", Fx_display_save_under,
3784 Sx_display_save_under, 0, 1, 0,
3785 doc: /* Return t if the X display TERMINAL supports the save-under feature.
3786 The optional argument TERMINAL specifies which display to ask about.
3787 TERMINAL should be a terminal object, a frame or a display name (a string).
3788 If omitted or nil, that stands for the selected frame's display. */)
3789 (Lisp_Object terminal)
3791 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3793 if (DoesSaveUnders (dpyinfo->screen) == True)
3794 return Qt;
3795 else
3796 return Qnil;
3799 /* Store the geometry of the workarea on display DPYINFO into *RECT.
3800 Return false if and only if the workarea information cannot be
3801 obtained via the _NET_WORKAREA root window property. */
3803 #if ! GTK_CHECK_VERSION (3, 4, 0)
3804 static bool
3805 x_get_net_workarea (struct x_display_info *dpyinfo, XRectangle *rect)
3807 Display *dpy = dpyinfo->display;
3808 long offset, max_len;
3809 Atom target_type, actual_type;
3810 unsigned long actual_size, bytes_remaining;
3811 int rc, actual_format;
3812 unsigned char *tmp_data = NULL;
3813 bool result = false;
3815 x_catch_errors (dpy);
3816 offset = 0;
3817 max_len = 1;
3818 target_type = XA_CARDINAL;
3819 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
3820 dpyinfo->Xatom_net_current_desktop,
3821 offset, max_len, False, target_type,
3822 &actual_type, &actual_format, &actual_size,
3823 &bytes_remaining, &tmp_data);
3824 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
3825 && actual_format == 32 && actual_size == max_len)
3827 long current_desktop = ((long *) tmp_data)[0];
3829 XFree (tmp_data);
3830 tmp_data = NULL;
3832 offset = 4 * current_desktop;
3833 max_len = 4;
3834 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
3835 dpyinfo->Xatom_net_workarea,
3836 offset, max_len, False, target_type,
3837 &actual_type, &actual_format, &actual_size,
3838 &bytes_remaining, &tmp_data);
3839 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
3840 && actual_format == 32 && actual_size == max_len)
3842 long *values = (long *) tmp_data;
3844 rect->x = values[0];
3845 rect->y = values[1];
3846 rect->width = values[2];
3847 rect->height = values[3];
3849 XFree (tmp_data);
3850 tmp_data = NULL;
3852 result = true;
3855 if (tmp_data)
3856 XFree (tmp_data);
3857 x_uncatch_errors ();
3859 return result;
3861 #endif
3863 #ifndef USE_GTK
3865 /* Return monitor number where F is "most" or closest to. */
3866 static int
3867 x_get_monitor_for_frame (struct frame *f,
3868 struct MonitorInfo *monitors,
3869 int n_monitors)
3871 XRectangle frect;
3872 int area = 0, dist = -1;
3873 int best_area = -1, best_dist = -1;
3874 int i;
3876 if (n_monitors == 1) return 0;
3877 frect.x = f->left_pos;
3878 frect.y = f->top_pos;
3879 frect.width = FRAME_PIXEL_WIDTH (f);
3880 frect.height = FRAME_PIXEL_HEIGHT (f);
3882 for (i = 0; i < n_monitors; ++i)
3884 struct MonitorInfo *mi = &monitors[i];
3885 XRectangle res;
3886 int a = 0;
3888 if (mi->geom.width == 0) continue;
3890 if (x_intersect_rectangles (&mi->geom, &frect, &res))
3892 a = res.width * res.height;
3893 if (a > area)
3895 area = a;
3896 best_area = i;
3900 if (a == 0 && area == 0)
3902 int dx, dy, d;
3903 if (frect.x + frect.width < mi->geom.x)
3904 dx = mi->geom.x - frect.x + frect.width;
3905 else if (frect.x > mi->geom.x + mi->geom.width)
3906 dx = frect.x - mi->geom.x + mi->geom.width;
3907 else
3908 dx = 0;
3909 if (frect.y + frect.height < mi->geom.y)
3910 dy = mi->geom.y - frect.y + frect.height;
3911 else if (frect.y > mi->geom.y + mi->geom.height)
3912 dy = frect.y - mi->geom.y + mi->geom.height;
3913 else
3914 dy = 0;
3916 d = dx*dx + dy*dy;
3917 if (dist == -1 || dist > d)
3919 dist = d;
3920 best_dist = i;
3925 return best_area != -1 ? best_area : (best_dist != -1 ? best_dist : 0);
3928 static Lisp_Object
3929 x_make_monitor_attribute_list (struct MonitorInfo *monitors,
3930 int n_monitors,
3931 int primary_monitor,
3932 struct x_display_info *dpyinfo,
3933 const char *source)
3935 Lisp_Object monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
3936 Lisp_Object frame, rest;
3938 FOR_EACH_FRAME (rest, frame)
3940 struct frame *f = XFRAME (frame);
3942 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo
3943 && !EQ (frame, tip_frame))
3945 int i = x_get_monitor_for_frame (f, monitors, n_monitors);
3946 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
3950 return make_monitor_attribute_list (monitors, n_monitors, primary_monitor,
3951 monitor_frames, source);
3954 static Lisp_Object
3955 x_get_monitor_attributes_fallback (struct x_display_info *dpyinfo)
3957 struct MonitorInfo monitor;
3958 XRectangle workarea_r;
3960 /* Fallback: treat (possibly) multiple physical monitors as if they
3961 formed a single monitor as a whole. This should provide a
3962 consistent result at least on single monitor environments. */
3963 monitor.geom.x = monitor.geom.y = 0;
3964 monitor.geom.width = x_display_pixel_width (dpyinfo);
3965 monitor.geom.height = x_display_pixel_height (dpyinfo);
3966 monitor.mm_width = WidthMMOfScreen (dpyinfo->screen);
3967 monitor.mm_height = HeightMMOfScreen (dpyinfo->screen);
3968 monitor.name = xstrdup ("combined screen");
3970 if (x_get_net_workarea (dpyinfo, &workarea_r))
3971 monitor.work = workarea_r;
3972 else
3973 monitor.work = monitor.geom;
3974 return x_make_monitor_attribute_list (&monitor, 1, 0, dpyinfo, "fallback");
3978 #ifdef HAVE_XINERAMA
3979 static Lisp_Object
3980 x_get_monitor_attributes_xinerama (struct x_display_info *dpyinfo)
3982 int n_monitors, i;
3983 Lisp_Object attributes_list = Qnil;
3984 Display *dpy = dpyinfo->display;
3985 XineramaScreenInfo *info = XineramaQueryScreens (dpy, &n_monitors);
3986 struct MonitorInfo *monitors;
3987 double mm_width_per_pixel, mm_height_per_pixel;
3989 if (! info || n_monitors == 0)
3991 if (info)
3992 XFree (info);
3993 return attributes_list;
3996 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
3997 / x_display_pixel_width (dpyinfo));
3998 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
3999 / x_display_pixel_height (dpyinfo));
4000 monitors = xzalloc (n_monitors * sizeof *monitors);
4001 for (i = 0; i < n_monitors; ++i)
4003 struct MonitorInfo *mi = &monitors[i];
4004 XRectangle workarea_r;
4006 mi->geom.x = info[i].x_org;
4007 mi->geom.y = info[i].y_org;
4008 mi->geom.width = info[i].width;
4009 mi->geom.height = info[i].height;
4010 mi->mm_width = mi->geom.width * mm_width_per_pixel + 0.5;
4011 mi->mm_height = mi->geom.height * mm_height_per_pixel + 0.5;
4012 mi->name = 0;
4014 /* Xinerama usually have primary monitor first, just use that. */
4015 if (i == 0 && x_get_net_workarea (dpyinfo, &workarea_r))
4017 mi->work = workarea_r;
4018 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
4019 mi->work = mi->geom;
4021 else
4022 mi->work = mi->geom;
4024 XFree (info);
4026 attributes_list = x_make_monitor_attribute_list (monitors,
4027 n_monitors,
4029 dpyinfo,
4030 "Xinerama");
4031 free_monitors (monitors, n_monitors);
4032 return attributes_list;
4034 #endif /* HAVE_XINERAMA */
4037 #ifdef HAVE_XRANDR
4038 static Lisp_Object
4039 x_get_monitor_attributes_xrandr (struct x_display_info *dpyinfo)
4041 Lisp_Object attributes_list = Qnil;
4042 XRRScreenResources *resources;
4043 Display *dpy = dpyinfo->display;
4044 int i, n_monitors, primary = -1;
4045 RROutput pxid = None;
4046 struct MonitorInfo *monitors;
4048 #ifdef HAVE_XRRGETSCREENRESOURCESCURRENT
4049 resources = XRRGetScreenResourcesCurrent (dpy, dpyinfo->root_window);
4050 #else
4051 resources = XRRGetScreenResources (dpy, dpyinfo->root_window);
4052 #endif
4053 if (! resources || resources->noutput == 0)
4055 if (resources)
4056 XRRFreeScreenResources (resources);
4057 return Qnil;
4059 n_monitors = resources->noutput;
4060 monitors = xzalloc (n_monitors * sizeof *monitors);
4062 #ifdef HAVE_XRRGETOUTPUTPRIMARY
4063 pxid = XRRGetOutputPrimary (dpy, dpyinfo->root_window);
4064 #endif
4066 for (i = 0; i < n_monitors; ++i)
4068 XRROutputInfo *info = XRRGetOutputInfo (dpy, resources,
4069 resources->outputs[i]);
4070 Connection conn = info ? info->connection : RR_Disconnected;
4071 RRCrtc id = info ? info->crtc : None;
4073 if (strcmp (info->name, "default") == 0)
4075 /* Non XRandr 1.2 driver, does not give useful data. */
4076 XRRFreeOutputInfo (info);
4077 XRRFreeScreenResources (resources);
4078 free_monitors (monitors, n_monitors);
4079 return Qnil;
4082 if (conn != RR_Disconnected && id != None)
4084 XRRCrtcInfo *crtc = XRRGetCrtcInfo (dpy, resources, id);
4085 struct MonitorInfo *mi = &monitors[i];
4086 XRectangle workarea_r;
4088 if (! crtc)
4090 XRRFreeOutputInfo (info);
4091 continue;
4094 mi->geom.x = crtc->x;
4095 mi->geom.y = crtc->y;
4096 mi->geom.width = crtc->width;
4097 mi->geom.height = crtc->height;
4098 mi->mm_width = info->mm_width;
4099 mi->mm_height = info->mm_height;
4100 mi->name = xstrdup (info->name);
4102 if (pxid != None && pxid == resources->outputs[i])
4103 primary = i;
4104 else if (primary == -1 && strcmp (info->name, "LVDS") == 0)
4105 primary = i;
4107 if (i == primary && x_get_net_workarea (dpyinfo, &workarea_r))
4109 mi->work= workarea_r;
4110 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
4111 mi->work = mi->geom;
4113 else
4114 mi->work = mi->geom;
4116 XRRFreeCrtcInfo (crtc);
4118 XRRFreeOutputInfo (info);
4120 XRRFreeScreenResources (resources);
4122 attributes_list = x_make_monitor_attribute_list (monitors,
4123 n_monitors,
4124 primary,
4125 dpyinfo,
4126 "XRandr");
4127 free_monitors (monitors, n_monitors);
4128 return attributes_list;
4130 #endif /* HAVE_XRANDR */
4132 static Lisp_Object
4133 x_get_monitor_attributes (struct x_display_info *dpyinfo)
4135 Lisp_Object attributes_list = Qnil;
4136 Display *dpy = dpyinfo->display;
4138 #ifdef HAVE_XRANDR
4139 int xrr_event_base, xrr_error_base;
4140 bool xrr_ok = false;
4141 xrr_ok = XRRQueryExtension (dpy, &xrr_event_base, &xrr_error_base);
4142 if (xrr_ok)
4144 int xrr_major, xrr_minor;
4145 XRRQueryVersion (dpy, &xrr_major, &xrr_minor);
4146 xrr_ok = (xrr_major == 1 && xrr_minor >= 2) || xrr_major > 1;
4149 if (xrr_ok)
4150 attributes_list = x_get_monitor_attributes_xrandr (dpyinfo);
4151 #endif /* HAVE_XRANDR */
4153 #ifdef HAVE_XINERAMA
4154 if (NILP (attributes_list))
4156 int xin_event_base, xin_error_base;
4157 bool xin_ok = false;
4158 xin_ok = XineramaQueryExtension (dpy, &xin_event_base, &xin_error_base);
4159 if (xin_ok && XineramaIsActive (dpy))
4160 attributes_list = x_get_monitor_attributes_xinerama (dpyinfo);
4162 #endif /* HAVE_XINERAMA */
4164 if (NILP (attributes_list))
4165 attributes_list = x_get_monitor_attributes_fallback (dpyinfo);
4167 return attributes_list;
4170 #endif /* !USE_GTK */
4172 DEFUN ("x-display-monitor-attributes-list", Fx_display_monitor_attributes_list,
4173 Sx_display_monitor_attributes_list,
4174 0, 1, 0,
4175 doc: /* Return a list of physical monitor attributes on the X display TERMINAL.
4177 The optional argument TERMINAL specifies which display to ask about.
4178 TERMINAL should be a terminal object, a frame or a display name (a string).
4179 If omitted or nil, that stands for the selected frame's display.
4181 In addition to the standard attribute keys listed in
4182 `display-monitor-attributes-list', the following keys are contained in
4183 the attributes:
4185 source -- String describing the source from which multi-monitor
4186 information is obtained, one of \"Gdk\", \"XRandr\",
4187 \"Xinerama\", or \"fallback\"
4189 Internal use only, use `display-monitor-attributes-list' instead. */)
4190 (Lisp_Object terminal)
4192 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4193 Lisp_Object attributes_list = Qnil;
4195 #ifdef USE_GTK
4196 double mm_width_per_pixel, mm_height_per_pixel;
4197 GdkDisplay *gdpy;
4198 GdkScreen *gscreen;
4199 gint primary_monitor = 0, n_monitors, i;
4200 Lisp_Object monitor_frames, rest, frame;
4201 static const char *source = "Gdk";
4202 struct MonitorInfo *monitors;
4204 block_input ();
4205 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
4206 / x_display_pixel_width (dpyinfo));
4207 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
4208 / x_display_pixel_height (dpyinfo));
4209 gdpy = gdk_x11_lookup_xdisplay (dpyinfo->display);
4210 gscreen = gdk_display_get_default_screen (gdpy);
4211 #if GTK_CHECK_VERSION (2, 20, 0)
4212 primary_monitor = gdk_screen_get_primary_monitor (gscreen);
4213 #endif
4214 n_monitors = gdk_screen_get_n_monitors (gscreen);
4215 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4216 monitors = xzalloc (n_monitors * sizeof *monitors);
4218 FOR_EACH_FRAME (rest, frame)
4220 struct frame *f = XFRAME (frame);
4222 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo
4223 && !EQ (frame, tip_frame))
4225 GdkWindow *gwin = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
4227 i = gdk_screen_get_monitor_at_window (gscreen, gwin);
4228 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
4232 for (i = 0; i < n_monitors; ++i)
4234 gint width_mm = -1, height_mm = -1;
4235 GdkRectangle rec, work;
4236 struct MonitorInfo *mi = &monitors[i];
4238 gdk_screen_get_monitor_geometry (gscreen, i, &rec);
4240 #if GTK_CHECK_VERSION (2, 14, 0)
4241 width_mm = gdk_screen_get_monitor_width_mm (gscreen, i);
4242 height_mm = gdk_screen_get_monitor_height_mm (gscreen, i);
4243 #endif
4244 if (width_mm < 0)
4245 width_mm = rec.width * mm_width_per_pixel + 0.5;
4246 if (height_mm < 0)
4247 height_mm = rec.height * mm_height_per_pixel + 0.5;
4249 #if GTK_CHECK_VERSION (3, 4, 0)
4250 gdk_screen_get_monitor_workarea (gscreen, i, &work);
4251 #else
4252 /* Emulate the behavior of GTK+ 3.4. */
4254 XRectangle workarea_r;
4256 if (i == primary_monitor && x_get_net_workarea (dpyinfo, &workarea_r))
4258 work.x = workarea_r.x;
4259 work.y = workarea_r.y;
4260 work.width = workarea_r.width;
4261 work.height = workarea_r.height;
4262 if (! gdk_rectangle_intersect (&rec, &work, &work))
4263 work = rec;
4265 else
4266 work = rec;
4268 #endif
4271 mi->geom.x = rec.x;
4272 mi->geom.y = rec.y;
4273 mi->geom.width = rec.width;
4274 mi->geom.height = rec.height;
4275 mi->work.x = work.x;
4276 mi->work.y = work.y;
4277 mi->work.width = work.width;
4278 mi->work.height = work.height;
4279 mi->mm_width = width_mm;
4280 mi->mm_height = height_mm;
4282 #if GTK_CHECK_VERSION (2, 14, 0)
4283 mi->name = gdk_screen_get_monitor_plug_name (gscreen, i);
4284 #endif
4287 attributes_list = make_monitor_attribute_list (monitors,
4288 n_monitors,
4289 primary_monitor,
4290 monitor_frames,
4291 source);
4292 unblock_input ();
4293 #else /* not USE_GTK */
4295 block_input ();
4296 attributes_list = x_get_monitor_attributes (dpyinfo);
4297 unblock_input ();
4299 #endif /* not USE_GTK */
4301 return attributes_list;
4304 /************************************************************************
4305 X Displays
4306 ************************************************************************/
4309 /* Mapping visual names to visuals. */
4311 static struct visual_class
4313 const char *name;
4314 int class;
4316 visual_classes[] =
4318 {"StaticGray", StaticGray},
4319 {"GrayScale", GrayScale},
4320 {"StaticColor", StaticColor},
4321 {"PseudoColor", PseudoColor},
4322 {"TrueColor", TrueColor},
4323 {"DirectColor", DirectColor},
4324 {NULL, 0}
4328 #ifndef HAVE_XSCREENNUMBEROFSCREEN
4330 /* Value is the screen number of screen SCR. This is a substitute for
4331 the X function with the same name when that doesn't exist. */
4334 XScreenNumberOfScreen (scr)
4335 register Screen *scr;
4337 Display *dpy = scr->display;
4338 int i;
4340 for (i = 0; i < dpy->nscreens; ++i)
4341 if (scr == dpy->screens + i)
4342 break;
4344 return i;
4347 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
4350 /* Select the visual that should be used on display DPYINFO. Set
4351 members of DPYINFO appropriately. Called from x_term_init. */
4353 void
4354 select_visual (struct x_display_info *dpyinfo)
4356 Display *dpy = dpyinfo->display;
4357 Screen *screen = dpyinfo->screen;
4358 Lisp_Object value;
4360 /* See if a visual is specified. */
4361 value = display_x_get_resource (dpyinfo,
4362 build_string ("visualClass"),
4363 build_string ("VisualClass"),
4364 Qnil, Qnil);
4365 if (STRINGP (value))
4367 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
4368 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
4369 depth, a decimal number. NAME is compared with case ignored. */
4370 char *s = alloca (SBYTES (value) + 1);
4371 char *dash;
4372 int i, class = -1;
4373 XVisualInfo vinfo;
4375 strcpy (s, SSDATA (value));
4376 dash = strchr (s, '-');
4377 if (dash)
4379 dpyinfo->n_planes = atoi (dash + 1);
4380 *dash = '\0';
4382 else
4383 /* We won't find a matching visual with depth 0, so that
4384 an error will be printed below. */
4385 dpyinfo->n_planes = 0;
4387 /* Determine the visual class. */
4388 for (i = 0; visual_classes[i].name; ++i)
4389 if (xstrcasecmp (s, visual_classes[i].name) == 0)
4391 class = visual_classes[i].class;
4392 break;
4395 /* Look up a matching visual for the specified class. */
4396 if (class == -1
4397 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
4398 dpyinfo->n_planes, class, &vinfo))
4399 fatal ("Invalid visual specification `%s'", SDATA (value));
4401 dpyinfo->visual = vinfo.visual;
4403 else
4405 int n_visuals;
4406 XVisualInfo *vinfo, vinfo_template;
4408 dpyinfo->visual = DefaultVisualOfScreen (screen);
4410 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
4411 vinfo_template.screen = XScreenNumberOfScreen (screen);
4412 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
4413 &vinfo_template, &n_visuals);
4414 if (n_visuals <= 0)
4415 fatal ("Can't get proper X visual info");
4417 dpyinfo->n_planes = vinfo->depth;
4418 XFree (vinfo);
4423 /* Return the X display structure for the display named NAME.
4424 Open a new connection if necessary. */
4426 static struct x_display_info *
4427 x_display_info_for_name (Lisp_Object name)
4429 Lisp_Object names;
4430 struct x_display_info *dpyinfo;
4432 CHECK_STRING (name);
4434 #if 0
4435 if (! EQ (Vinitial_window_system, intern ("x")))
4436 error ("Not using X Windows"); /* That doesn't stop us anymore. */
4437 #endif
4439 for (dpyinfo = x_display_list, names = x_display_name_list;
4440 dpyinfo;
4441 dpyinfo = dpyinfo->next, names = XCDR (names))
4443 Lisp_Object tem;
4444 tem = Fstring_equal (XCAR (XCAR (names)), name);
4445 if (!NILP (tem))
4446 return dpyinfo;
4449 /* Use this general default value to start with. */
4450 Vx_resource_name = Vinvocation_name;
4452 validate_x_resource_name ();
4454 dpyinfo = x_term_init (name, 0, SSDATA (Vx_resource_name));
4456 if (dpyinfo == 0)
4457 error ("Cannot connect to X server %s", SDATA (name));
4459 XSETFASTINT (Vwindow_system_version, 11);
4461 return dpyinfo;
4465 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4466 1, 3, 0,
4467 doc: /* Open a connection to a display server.
4468 DISPLAY is the name of the display to connect to.
4469 Optional second arg XRM-STRING is a string of resources in xrdb format.
4470 If the optional third arg MUST-SUCCEED is non-nil,
4471 terminate Emacs if we can't open the connection.
4472 \(In the Nextstep version, the last two arguments are currently ignored.) */)
4473 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4475 char *xrm_option;
4476 struct x_display_info *dpyinfo;
4478 CHECK_STRING (display);
4479 if (! NILP (xrm_string))
4480 CHECK_STRING (xrm_string);
4482 #if 0
4483 if (! EQ (Vinitial_window_system, intern ("x")))
4484 error ("Not using X Windows"); /* That doesn't stop us anymore. */
4485 #endif
4487 xrm_option = NILP (xrm_string) ? 0 : SSDATA (xrm_string);
4489 validate_x_resource_name ();
4491 /* This is what opens the connection and sets x_current_display.
4492 This also initializes many symbols, such as those used for input. */
4493 dpyinfo = x_term_init (display, xrm_option,
4494 SSDATA (Vx_resource_name));
4496 if (dpyinfo == 0)
4498 if (!NILP (must_succeed))
4499 fatal ("Cannot connect to X server %s.\n\
4500 Check the DISPLAY environment variable or use `-d'.\n\
4501 Also use the `xauth' program to verify that you have the proper\n\
4502 authorization information needed to connect the X server.\n\
4503 An insecure way to solve the problem may be to use `xhost'.\n",
4504 SDATA (display));
4505 else
4506 error ("Cannot connect to X server %s", SDATA (display));
4509 XSETFASTINT (Vwindow_system_version, 11);
4510 return Qnil;
4513 DEFUN ("x-close-connection", Fx_close_connection,
4514 Sx_close_connection, 1, 1, 0,
4515 doc: /* Close the connection to TERMINAL's X server.
4516 For TERMINAL, specify a terminal object, a frame or a display name (a
4517 string). If TERMINAL is nil, that stands for the selected frame's
4518 terminal. */)
4519 (Lisp_Object terminal)
4521 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4523 if (dpyinfo->reference_count > 0)
4524 error ("Display still has frames on it");
4526 x_delete_terminal (dpyinfo->terminal);
4528 return Qnil;
4531 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4532 doc: /* Return the list of display names that Emacs has connections to. */)
4533 (void)
4535 Lisp_Object tail, result;
4537 result = Qnil;
4538 for (tail = x_display_name_list; CONSP (tail); tail = XCDR (tail))
4539 result = Fcons (XCAR (XCAR (tail)), result);
4541 return result;
4544 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4545 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4546 This function only has an effect on X Windows. With MS Windows, it is
4547 defined but does nothing.
4549 If ON is nil, allow buffering of requests.
4550 Turning on synchronization prohibits the Xlib routines from buffering
4551 requests and seriously degrades performance, but makes debugging much
4552 easier.
4553 The optional second argument TERMINAL specifies which display to act on.
4554 TERMINAL should be a terminal object, a frame or a display name (a string).
4555 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
4556 (Lisp_Object on, Lisp_Object terminal)
4558 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4560 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4562 return Qnil;
4565 /* Wait for responses to all X commands issued so far for frame F. */
4567 void
4568 x_sync (struct frame *f)
4570 block_input ();
4571 XSync (FRAME_X_DISPLAY (f), False);
4572 unblock_input ();
4576 /***********************************************************************
4577 Window properties
4578 ***********************************************************************/
4580 DEFUN ("x-change-window-property", Fx_change_window_property,
4581 Sx_change_window_property, 2, 6, 0,
4582 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4583 PROP must be a string. VALUE may be a string or a list of conses,
4584 numbers and/or strings. If an element in the list is a string, it is
4585 converted to an atom and the value of the atom is used. If an element
4586 is a cons, it is converted to a 32 bit number where the car is the 16
4587 top bits and the cdr is the lower 16 bits.
4589 FRAME nil or omitted means use the selected frame.
4590 If TYPE is given and non-nil, it is the name of the type of VALUE.
4591 If TYPE is not given or nil, the type is STRING.
4592 FORMAT gives the size in bits of each element if VALUE is a list.
4593 It must be one of 8, 16 or 32.
4594 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4595 If OUTER-P is non-nil, the property is changed for the outer X window of
4596 FRAME. Default is to change on the edit X window. */)
4597 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
4598 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
4600 struct frame *f = decode_window_system_frame (frame);
4601 Atom prop_atom;
4602 Atom target_type = XA_STRING;
4603 int element_format = 8;
4604 unsigned char *data;
4605 int nelements;
4606 Window w;
4608 CHECK_STRING (prop);
4610 if (! NILP (format))
4612 CHECK_NUMBER (format);
4614 if (XINT (format) != 8 && XINT (format) != 16
4615 && XINT (format) != 32)
4616 error ("FORMAT must be one of 8, 16 or 32");
4617 element_format = XINT (format);
4620 if (CONSP (value))
4622 ptrdiff_t elsize;
4624 nelements = x_check_property_data (value);
4625 if (nelements == -1)
4626 error ("Bad data in VALUE, must be number, string or cons");
4628 /* The man page for XChangeProperty:
4629 "If the specified format is 32, the property data must be a
4630 long array."
4631 This applies even if long is more than 32 bits. The X library
4632 converts to 32 bits before sending to the X server. */
4633 elsize = element_format == 32 ? sizeof (long) : element_format >> 3;
4634 data = xnmalloc (nelements, elsize);
4636 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4638 else
4640 CHECK_STRING (value);
4641 data = SDATA (value);
4642 if (INT_MAX < SBYTES (value))
4643 error ("VALUE too long");
4644 nelements = SBYTES (value);
4647 block_input ();
4648 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4649 if (! NILP (type))
4651 CHECK_STRING (type);
4652 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4655 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4656 else w = FRAME_X_WINDOW (f);
4658 XChangeProperty (FRAME_X_DISPLAY (f), w,
4659 prop_atom, target_type, element_format, PropModeReplace,
4660 data, nelements);
4662 if (CONSP (value)) xfree (data);
4664 /* Make sure the property is set when we return. */
4665 XFlush (FRAME_X_DISPLAY (f));
4666 unblock_input ();
4668 return value;
4672 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4673 Sx_delete_window_property, 1, 2, 0,
4674 doc: /* Remove window property PROP from X window of FRAME.
4675 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4676 (Lisp_Object prop, Lisp_Object frame)
4678 struct frame *f = decode_window_system_frame (frame);
4679 Atom prop_atom;
4681 CHECK_STRING (prop);
4682 block_input ();
4683 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4684 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4686 /* Make sure the property is removed when we return. */
4687 XFlush (FRAME_X_DISPLAY (f));
4688 unblock_input ();
4690 return prop;
4694 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4695 1, 6, 0,
4696 doc: /* Value is the value of window property PROP on FRAME.
4697 If FRAME is nil or omitted, use the selected frame.
4699 On X Windows, the following optional arguments are also accepted:
4700 If TYPE is nil or omitted, get the property as a string.
4701 Otherwise TYPE is the name of the atom that denotes the type expected.
4702 If SOURCE is non-nil, get the property on that window instead of from
4703 FRAME. The number 0 denotes the root window.
4704 If DELETE-P is non-nil, delete the property after retrieving it.
4705 If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
4707 On MS Windows, this function accepts but ignores those optional arguments.
4709 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4710 no value of TYPE (always string in the MS Windows case). */)
4711 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
4712 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
4714 struct frame *f = decode_window_system_frame (frame);
4715 Atom prop_atom;
4716 int rc;
4717 Lisp_Object prop_value = Qnil;
4718 unsigned char *tmp_data = NULL;
4719 Atom actual_type;
4720 Atom target_type = XA_STRING;
4721 int actual_format;
4722 unsigned long actual_size, bytes_remaining;
4723 Window target_window = FRAME_X_WINDOW (f);
4724 struct gcpro gcpro1;
4726 GCPRO1 (prop_value);
4727 CHECK_STRING (prop);
4729 if (! NILP (source))
4731 CONS_TO_INTEGER (source, Window, target_window);
4732 if (! target_window)
4733 target_window = FRAME_X_DISPLAY_INFO (f)->root_window;
4736 block_input ();
4737 if (STRINGP (type))
4739 if (strcmp ("AnyPropertyType", SSDATA (type)) == 0)
4740 target_type = AnyPropertyType;
4741 else
4742 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4745 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4746 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4747 prop_atom, 0, 0, False, target_type,
4748 &actual_type, &actual_format, &actual_size,
4749 &bytes_remaining, &tmp_data);
4750 if (rc == Success)
4752 int size = bytes_remaining;
4754 XFree (tmp_data);
4755 tmp_data = NULL;
4757 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4758 prop_atom, 0, bytes_remaining,
4759 ! NILP (delete_p), target_type,
4760 &actual_type, &actual_format,
4761 &actual_size, &bytes_remaining,
4762 &tmp_data);
4763 if (rc == Success && tmp_data)
4765 /* The man page for XGetWindowProperty says:
4766 "If the returned format is 32, the returned data is represented
4767 as a long array and should be cast to that type to obtain the
4768 elements."
4769 This applies even if long is more than 32 bits, the X library
4770 converts from 32 bit elements received from the X server to long
4771 and passes the long array to us. Thus, for that case memcpy can not
4772 be used. We convert to a 32 bit type here, because so much code
4773 assume on that.
4775 The bytes and offsets passed to XGetWindowProperty refers to the
4776 property and those are indeed in 32 bit quantities if format is
4777 32. */
4779 if (BITS_PER_LONG > 32 && actual_format == 32)
4781 unsigned long i;
4782 int *idata = (int *) tmp_data;
4783 long *ldata = (long *) tmp_data;
4785 for (i = 0; i < actual_size; ++i)
4786 idata[i] = (int) ldata[i];
4789 if (NILP (vector_ret_p))
4790 prop_value = make_string ((char *) tmp_data, size);
4791 else
4792 prop_value = x_property_data_to_lisp (f,
4793 tmp_data,
4794 actual_type,
4795 actual_format,
4796 actual_size);
4799 if (tmp_data) XFree (tmp_data);
4802 unblock_input ();
4803 UNGCPRO;
4804 return prop_value;
4809 /***********************************************************************
4810 Busy cursor
4811 ***********************************************************************/
4813 /* Timer function of hourglass_atimer. TIMER is equal to
4814 hourglass_atimer.
4816 Display an hourglass pointer on all frames by mapping the frames'
4817 hourglass_window. Set the hourglass_p flag in the frames'
4818 output_data.x structure to indicate that an hourglass cursor is
4819 shown on the frames. */
4821 void
4822 show_hourglass (struct atimer *timer)
4824 /* The timer implementation will cancel this timer automatically
4825 after this function has run. Set hourglass_atimer to null
4826 so that we know the timer doesn't have to be canceled. */
4827 hourglass_atimer = NULL;
4829 if (!hourglass_shown_p)
4831 Lisp_Object rest, frame;
4833 block_input ();
4835 FOR_EACH_FRAME (rest, frame)
4837 struct frame *f = XFRAME (frame);
4839 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4841 Display *dpy = FRAME_X_DISPLAY (f);
4843 #ifdef USE_X_TOOLKIT
4844 if (f->output_data.x->widget)
4845 #else
4846 if (FRAME_OUTER_WINDOW (f))
4847 #endif
4849 f->output_data.x->hourglass_p = 1;
4851 if (!f->output_data.x->hourglass_window)
4853 unsigned long mask = CWCursor;
4854 XSetWindowAttributes attrs;
4855 #ifdef USE_GTK
4856 Window parent = FRAME_X_WINDOW (f);
4857 #else
4858 Window parent = FRAME_OUTER_WINDOW (f);
4859 #endif
4860 attrs.cursor = f->output_data.x->hourglass_cursor;
4862 f->output_data.x->hourglass_window
4863 = XCreateWindow (dpy, parent,
4864 0, 0, 32000, 32000, 0, 0,
4865 InputOnly,
4866 CopyFromParent,
4867 mask, &attrs);
4870 XMapRaised (dpy, f->output_data.x->hourglass_window);
4871 XFlush (dpy);
4876 hourglass_shown_p = 1;
4877 unblock_input ();
4882 /* Hide the hourglass pointer on all frames, if it is currently
4883 shown. */
4885 void
4886 hide_hourglass (void)
4888 if (hourglass_shown_p)
4890 Lisp_Object rest, frame;
4892 block_input ();
4893 FOR_EACH_FRAME (rest, frame)
4895 struct frame *f = XFRAME (frame);
4897 if (FRAME_X_P (f)
4898 /* Watch out for newly created frames. */
4899 && f->output_data.x->hourglass_window)
4901 XUnmapWindow (FRAME_X_DISPLAY (f),
4902 f->output_data.x->hourglass_window);
4903 /* Sync here because XTread_socket looks at the
4904 hourglass_p flag that is reset to zero below. */
4905 XSync (FRAME_X_DISPLAY (f), False);
4906 f->output_data.x->hourglass_p = 0;
4910 hourglass_shown_p = 0;
4911 unblock_input ();
4917 /***********************************************************************
4918 Tool tips
4919 ***********************************************************************/
4921 static Lisp_Object x_create_tip_frame (struct x_display_info *,
4922 Lisp_Object, Lisp_Object);
4923 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
4924 Lisp_Object, int, int, int *, int *);
4926 /* The frame of a currently visible tooltip. */
4928 Lisp_Object tip_frame;
4930 /* If non-nil, a timer started that hides the last tooltip when it
4931 fires. */
4933 static Lisp_Object tip_timer;
4934 Window tip_window;
4936 /* If non-nil, a vector of 3 elements containing the last args
4937 with which x-show-tip was called. See there. */
4939 static Lisp_Object last_show_tip_args;
4942 static void
4943 unwind_create_tip_frame (Lisp_Object frame)
4945 Lisp_Object deleted;
4947 deleted = unwind_create_frame (frame);
4948 if (EQ (deleted, Qt))
4950 tip_window = None;
4951 tip_frame = Qnil;
4956 /* Create a frame for a tooltip on the display described by DPYINFO.
4957 PARMS is a list of frame parameters. TEXT is the string to
4958 display in the tip frame. Value is the frame.
4960 Note that functions called here, esp. x_default_parameter can
4961 signal errors, for instance when a specified color name is
4962 undefined. We have to make sure that we're in a consistent state
4963 when this happens. */
4965 static Lisp_Object
4966 x_create_tip_frame (struct x_display_info *dpyinfo,
4967 Lisp_Object parms,
4968 Lisp_Object text)
4970 struct frame *f;
4971 Lisp_Object frame;
4972 Lisp_Object name;
4973 int width, height;
4974 ptrdiff_t count = SPECPDL_INDEX ();
4975 struct gcpro gcpro1, gcpro2, gcpro3;
4976 int face_change_count_before = face_change_count;
4977 Lisp_Object buffer;
4978 struct buffer *old_buffer;
4980 if (!dpyinfo->terminal->name)
4981 error ("Terminal is not live, can't create new frames on it");
4983 parms = Fcopy_alist (parms);
4985 /* Get the name of the frame to use for resource lookup. */
4986 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4987 if (!STRINGP (name)
4988 && !EQ (name, Qunbound)
4989 && !NILP (name))
4990 error ("Invalid frame name--not a string or nil");
4992 frame = Qnil;
4993 GCPRO3 (parms, name, frame);
4994 f = make_frame (1);
4995 XSETFRAME (frame, f);
4997 buffer = Fget_buffer_create (build_string (" *tip*"));
4998 /* Use set_window_buffer instead of Fset_window_buffer (see
4999 discussion of bug#11984, bug#12025, bug#12026). */
5000 set_window_buffer (FRAME_ROOT_WINDOW (f), buffer, 0, 0);
5001 old_buffer = current_buffer;
5002 set_buffer_internal_1 (XBUFFER (buffer));
5003 bset_truncate_lines (current_buffer, Qnil);
5004 specbind (Qinhibit_read_only, Qt);
5005 specbind (Qinhibit_modification_hooks, Qt);
5006 Ferase_buffer ();
5007 Finsert (1, &text);
5008 set_buffer_internal_1 (old_buffer);
5010 record_unwind_protect (unwind_create_tip_frame, frame);
5012 f->terminal = dpyinfo->terminal;
5014 /* By setting the output method, we're essentially saying that
5015 the frame is live, as per FRAME_LIVE_P. If we get a signal
5016 from this point on, x_destroy_window might screw up reference
5017 counts etc. */
5018 f->output_method = output_x_window;
5019 f->output_data.x = xzalloc (sizeof *f->output_data.x);
5020 f->output_data.x->icon_bitmap = -1;
5021 FRAME_FONTSET (f) = -1;
5022 f->output_data.x->scroll_bar_foreground_pixel = -1;
5023 f->output_data.x->scroll_bar_background_pixel = -1;
5024 #ifdef USE_TOOLKIT_SCROLL_BARS
5025 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
5026 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
5027 #endif /* USE_TOOLKIT_SCROLL_BARS */
5028 fset_icon_name (f, Qnil);
5029 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
5030 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
5031 f->output_data.x->explicit_parent = 0;
5033 /* These colors will be set anyway later, but it's important
5034 to get the color reference counts right, so initialize them! */
5036 Lisp_Object black;
5037 struct gcpro gcpro1;
5039 /* Function x_decode_color can signal an error. Make
5040 sure to initialize color slots so that we won't try
5041 to free colors we haven't allocated. */
5042 FRAME_FOREGROUND_PIXEL (f) = -1;
5043 FRAME_BACKGROUND_PIXEL (f) = -1;
5044 f->output_data.x->cursor_pixel = -1;
5045 f->output_data.x->cursor_foreground_pixel = -1;
5046 f->output_data.x->border_pixel = -1;
5047 f->output_data.x->mouse_pixel = -1;
5049 black = build_string ("black");
5050 GCPRO1 (black);
5051 FRAME_FOREGROUND_PIXEL (f)
5052 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5053 FRAME_BACKGROUND_PIXEL (f)
5054 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5055 f->output_data.x->cursor_pixel
5056 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5057 f->output_data.x->cursor_foreground_pixel
5058 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5059 f->output_data.x->border_pixel
5060 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5061 f->output_data.x->mouse_pixel
5062 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5063 UNGCPRO;
5066 /* Set the name; the functions to which we pass f expect the name to
5067 be set. */
5068 if (EQ (name, Qunbound) || NILP (name))
5070 fset_name (f, build_string (dpyinfo->x_id_name));
5071 f->explicit_name = 0;
5073 else
5075 fset_name (f, name);
5076 f->explicit_name = 1;
5077 /* use the frame's title when getting resources for this frame. */
5078 specbind (Qx_resource_name, name);
5081 register_font_driver (&xfont_driver, f);
5082 #ifdef HAVE_FREETYPE
5083 #ifdef HAVE_XFT
5084 register_font_driver (&xftfont_driver, f);
5085 #else /* not HAVE_XFT */
5086 register_font_driver (&ftxfont_driver, f);
5087 #endif /* not HAVE_XFT */
5088 #endif /* HAVE_FREETYPE */
5090 x_default_parameter (f, parms, Qfont_backend, Qnil,
5091 "fontBackend", "FontBackend", RES_TYPE_STRING);
5093 /* Extract the window parameters from the supplied values that are
5094 needed to determine window geometry. */
5095 x_default_font_parameter (f, parms);
5097 x_default_parameter (f, parms, Qborder_width, make_number (0),
5098 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
5100 /* This defaults to 2 in order to match xterm. We recognize either
5101 internalBorderWidth or internalBorder (which is what xterm calls
5102 it). */
5103 if (NILP (Fassq (Qinternal_border_width, parms)))
5105 Lisp_Object value;
5107 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
5108 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
5109 if (! EQ (value, Qunbound))
5110 parms = Fcons (Fcons (Qinternal_border_width, value),
5111 parms);
5114 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
5115 "internalBorderWidth", "internalBorderWidth",
5116 RES_TYPE_NUMBER);
5118 /* Also do the stuff which must be set before the window exists. */
5119 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
5120 "foreground", "Foreground", RES_TYPE_STRING);
5121 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
5122 "background", "Background", RES_TYPE_STRING);
5123 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
5124 "pointerColor", "Foreground", RES_TYPE_STRING);
5125 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
5126 "cursorColor", "Foreground", RES_TYPE_STRING);
5127 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
5128 "borderColor", "BorderColor", RES_TYPE_STRING);
5130 #ifdef GLYPH_DEBUG
5131 image_cache_refcount =
5132 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
5133 dpyinfo_refcount = dpyinfo->reference_count;
5134 #endif /* GLYPH_DEBUG */
5136 /* Init faces before x_default_parameter is called for scroll-bar
5137 parameters because that function calls x_set_scroll_bar_width,
5138 which calls change_frame_size, which calls Fset_window_buffer,
5139 which runs hooks, which call Fvertical_motion. At the end, we
5140 end up in init_iterator with a null face cache, which should not
5141 happen. */
5142 init_frame_faces (f);
5144 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
5146 x_figure_window_size (f, parms, 0);
5149 XSetWindowAttributes attrs;
5150 unsigned long mask;
5151 Atom type = FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type_tooltip;
5153 block_input ();
5154 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
5155 if (DoesSaveUnders (dpyinfo->screen))
5156 mask |= CWSaveUnder;
5158 /* Window managers look at the override-redirect flag to determine
5159 whether or net to give windows a decoration (Xlib spec, chapter
5160 3.2.8). */
5161 attrs.override_redirect = True;
5162 attrs.save_under = True;
5163 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
5164 /* Arrange for getting MapNotify and UnmapNotify events. */
5165 attrs.event_mask = StructureNotifyMask;
5166 tip_window
5167 = FRAME_X_WINDOW (f)
5168 = XCreateWindow (FRAME_X_DISPLAY (f),
5169 FRAME_X_DISPLAY_INFO (f)->root_window,
5170 /* x, y, width, height */
5171 0, 0, 1, 1,
5172 /* Border. */
5173 f->border_width,
5174 CopyFromParent, InputOutput, CopyFromParent,
5175 mask, &attrs);
5176 XChangeProperty (FRAME_X_DISPLAY (f), tip_window,
5177 FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type,
5178 XA_ATOM, 32, PropModeReplace,
5179 (unsigned char *)&type, 1);
5180 unblock_input ();
5183 x_make_gc (f);
5185 x_default_parameter (f, parms, Qauto_raise, Qnil,
5186 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5187 x_default_parameter (f, parms, Qauto_lower, Qnil,
5188 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5189 x_default_parameter (f, parms, Qcursor_type, Qbox,
5190 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5192 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
5193 Change will not be effected unless different from the current
5194 FRAME_LINES (f). */
5195 width = FRAME_COLS (f);
5196 height = FRAME_LINES (f);
5197 SET_FRAME_COLS (f, 0);
5198 FRAME_LINES (f) = 0;
5199 change_frame_size (f, height, width, 1, 0, 0);
5201 /* Add `tooltip' frame parameter's default value. */
5202 if (NILP (Fframe_parameter (frame, Qtooltip)))
5203 Fmodify_frame_parameters (frame, list1 (Fcons (Qtooltip, Qt)));
5205 /* FIXME - can this be done in a similar way to normal frames?
5206 http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00641.html */
5208 /* Set the `display-type' frame parameter before setting up faces. */
5210 Lisp_Object disptype;
5212 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
5213 disptype = intern ("mono");
5214 else if (FRAME_X_DISPLAY_INFO (f)->visual->class == GrayScale
5215 || FRAME_X_DISPLAY_INFO (f)->visual->class == StaticGray)
5216 disptype = intern ("grayscale");
5217 else
5218 disptype = intern ("color");
5220 if (NILP (Fframe_parameter (frame, Qdisplay_type)))
5221 Fmodify_frame_parameters (frame, list1 (Fcons (Qdisplay_type, disptype)));
5224 /* Set up faces after all frame parameters are known. This call
5225 also merges in face attributes specified for new frames.
5227 Frame parameters may be changed if .Xdefaults contains
5228 specifications for the default font. For example, if there is an
5229 `Emacs.default.attributeBackground: pink', the `background-color'
5230 attribute of the frame get's set, which let's the internal border
5231 of the tooltip frame appear in pink. Prevent this. */
5233 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
5235 /* Set tip_frame here, so that */
5236 tip_frame = frame;
5237 call2 (Qface_set_after_frame_default, frame, Qnil);
5239 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
5240 Fmodify_frame_parameters (frame, list1 (Fcons (Qbackground_color, bg)));
5243 f->no_split = 1;
5245 UNGCPRO;
5247 /* Now that the frame will be official, it counts as a reference to
5248 its display and terminal. */
5249 FRAME_X_DISPLAY_INFO (f)->reference_count++;
5250 f->terminal->reference_count++;
5252 /* It is now ok to make the frame official even if we get an error
5253 below. And the frame needs to be on Vframe_list or making it
5254 visible won't work. */
5255 Vframe_list = Fcons (frame, Vframe_list);
5258 /* Setting attributes of faces of the tooltip frame from resources
5259 and similar will increment face_change_count, which leads to the
5260 clearing of all current matrices. Since this isn't necessary
5261 here, avoid it by resetting face_change_count to the value it
5262 had before we created the tip frame. */
5263 face_change_count = face_change_count_before;
5265 /* Discard the unwind_protect. */
5266 return unbind_to (count, frame);
5270 /* Compute where to display tip frame F. PARMS is the list of frame
5271 parameters for F. DX and DY are specified offsets from the current
5272 location of the mouse. WIDTH and HEIGHT are the width and height
5273 of the tooltip. Return coordinates relative to the root window of
5274 the display in *ROOT_X, and *ROOT_Y. */
5276 static void
5277 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)
5279 Lisp_Object left, top;
5280 int win_x, win_y;
5281 Window root, child;
5282 unsigned pmask;
5284 /* User-specified position? */
5285 left = Fcdr (Fassq (Qleft, parms));
5286 top = Fcdr (Fassq (Qtop, parms));
5288 /* Move the tooltip window where the mouse pointer is. Resize and
5289 show it. */
5290 if (!INTEGERP (left) || !INTEGERP (top))
5292 block_input ();
5293 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
5294 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
5295 unblock_input ();
5298 if (INTEGERP (top))
5299 *root_y = XINT (top);
5300 else if (*root_y + XINT (dy) <= 0)
5301 *root_y = 0; /* Can happen for negative dy */
5302 else if (*root_y + XINT (dy) + height
5303 <= x_display_pixel_height (FRAME_X_DISPLAY_INFO (f)))
5304 /* It fits below the pointer */
5305 *root_y += XINT (dy);
5306 else if (height + XINT (dy) <= *root_y)
5307 /* It fits above the pointer. */
5308 *root_y -= height + XINT (dy);
5309 else
5310 /* Put it on the top. */
5311 *root_y = 0;
5313 if (INTEGERP (left))
5314 *root_x = XINT (left);
5315 else if (*root_x + XINT (dx) <= 0)
5316 *root_x = 0; /* Can happen for negative dx */
5317 else if (*root_x + XINT (dx) + width
5318 <= x_display_pixel_width (FRAME_X_DISPLAY_INFO (f)))
5319 /* It fits to the right of the pointer. */
5320 *root_x += XINT (dx);
5321 else if (width + XINT (dx) <= *root_x)
5322 /* It fits to the left of the pointer. */
5323 *root_x -= width + XINT (dx);
5324 else
5325 /* Put it left-justified on the screen--it ought to fit that way. */
5326 *root_x = 0;
5330 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5331 doc: /* Show STRING in a "tooltip" window on frame FRAME.
5332 A tooltip window is a small X window displaying a string.
5334 This is an internal function; Lisp code should call `tooltip-show'.
5336 FRAME nil or omitted means use the selected frame.
5338 PARMS is an optional list of frame parameters which can be used to
5339 change the tooltip's appearance.
5341 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5342 means use the default timeout of 5 seconds.
5344 If the list of frame parameters PARMS contains a `left' parameters,
5345 the tooltip is displayed at that x-position. Otherwise it is
5346 displayed at the mouse position, with offset DX added (default is 5 if
5347 DX isn't specified). Likewise for the y-position; if a `top' frame
5348 parameter is specified, it determines the y-position of the tooltip
5349 window, otherwise it is displayed at the mouse position, with offset
5350 DY added (default is -10).
5352 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5353 Text larger than the specified size is clipped. */)
5354 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
5356 struct frame *f;
5357 struct window *w;
5358 int root_x, root_y;
5359 struct buffer *old_buffer;
5360 struct text_pos pos;
5361 int i, width, height, seen_reversed_p;
5362 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5363 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5364 ptrdiff_t count = SPECPDL_INDEX ();
5366 specbind (Qinhibit_redisplay, Qt);
5368 GCPRO4 (string, parms, frame, timeout);
5370 CHECK_STRING (string);
5371 if (SCHARS (string) == 0)
5372 string = make_unibyte_string (" ", 1);
5374 f = decode_window_system_frame (frame);
5375 if (NILP (timeout))
5376 timeout = make_number (5);
5377 else
5378 CHECK_NATNUM (timeout);
5380 if (NILP (dx))
5381 dx = make_number (5);
5382 else
5383 CHECK_NUMBER (dx);
5385 if (NILP (dy))
5386 dy = make_number (-10);
5387 else
5388 CHECK_NUMBER (dy);
5390 #ifdef USE_GTK
5391 if (x_gtk_use_system_tooltips)
5393 bool ok;
5395 /* Hide a previous tip, if any. */
5396 Fx_hide_tip ();
5398 block_input ();
5399 ok = xg_prepare_tooltip (f, string, &width, &height);
5400 if (ok)
5402 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5403 xg_show_tooltip (f, root_x, root_y);
5404 /* This is used in Fx_hide_tip. */
5405 XSETFRAME (tip_frame, f);
5407 unblock_input ();
5408 if (ok) goto start_timer;
5410 #endif /* USE_GTK */
5412 if (NILP (last_show_tip_args))
5413 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5415 if (!NILP (tip_frame))
5417 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5418 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5419 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5421 if (EQ (frame, last_frame)
5422 && !NILP (Fequal (last_string, string))
5423 && !NILP (Fequal (last_parms, parms)))
5425 struct frame *tip_f = XFRAME (tip_frame);
5427 /* Only DX and DY have changed. */
5428 if (!NILP (tip_timer))
5430 Lisp_Object timer = tip_timer;
5431 tip_timer = Qnil;
5432 call1 (Qcancel_timer, timer);
5435 block_input ();
5436 compute_tip_xy (tip_f, parms, dx, dy, FRAME_PIXEL_WIDTH (tip_f),
5437 FRAME_PIXEL_HEIGHT (tip_f), &root_x, &root_y);
5438 XMoveWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
5439 root_x, root_y);
5440 unblock_input ();
5441 goto start_timer;
5445 /* Hide a previous tip, if any. */
5446 Fx_hide_tip ();
5448 ASET (last_show_tip_args, 0, string);
5449 ASET (last_show_tip_args, 1, frame);
5450 ASET (last_show_tip_args, 2, parms);
5452 /* Add default values to frame parameters. */
5453 if (NILP (Fassq (Qname, parms)))
5454 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5455 if (NILP (Fassq (Qinternal_border_width, parms)))
5456 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5457 if (NILP (Fassq (Qborder_width, parms)))
5458 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5459 if (NILP (Fassq (Qborder_color, parms)))
5460 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5461 if (NILP (Fassq (Qbackground_color, parms)))
5462 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5463 parms);
5465 /* Create a frame for the tooltip, and record it in the global
5466 variable tip_frame. */
5467 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
5468 f = XFRAME (frame);
5470 /* Set up the frame's root window. */
5471 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5472 w->left_col = 0;
5473 w->top_line = 0;
5475 if (CONSP (Vx_max_tooltip_size)
5476 && RANGED_INTEGERP (1, XCAR (Vx_max_tooltip_size), INT_MAX)
5477 && RANGED_INTEGERP (1, XCDR (Vx_max_tooltip_size), INT_MAX))
5479 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
5480 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
5482 else
5484 w->total_cols = 80;
5485 w->total_lines = 40;
5488 FRAME_TOTAL_COLS (f) = w->total_cols;
5489 adjust_frame_glyphs (f);
5490 w->pseudo_window_p = 1;
5492 /* Display the tooltip text in a temporary buffer. */
5493 old_buffer = current_buffer;
5494 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->contents));
5495 bset_truncate_lines (current_buffer, Qnil);
5496 clear_glyph_matrix (w->desired_matrix);
5497 clear_glyph_matrix (w->current_matrix);
5498 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5499 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
5501 /* Compute width and height of the tooltip. */
5502 width = height = seen_reversed_p = 0;
5503 for (i = 0; i < w->desired_matrix->nrows; ++i)
5505 struct glyph_row *row = &w->desired_matrix->rows[i];
5506 struct glyph *last;
5507 int row_width;
5509 /* Stop at the first empty row at the end. */
5510 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
5511 break;
5513 /* Let the row go over the full width of the frame. */
5514 row->full_width_p = 1;
5516 row_width = row->pixel_width;
5517 if (row->used[TEXT_AREA])
5519 /* There's a glyph at the end of rows that is used to place
5520 the cursor there. Don't include the width of this glyph. */
5521 if (!row->reversed_p)
5523 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5524 if (INTEGERP (last->object))
5525 row_width -= last->pixel_width;
5527 else
5529 /* There could be a stretch glyph at the beginning of R2L
5530 rows that is produced by extend_face_to_end_of_line.
5531 Don't count that glyph. */
5532 struct glyph *g = row->glyphs[TEXT_AREA];
5534 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
5536 row_width -= g->pixel_width;
5537 seen_reversed_p = 1;
5542 height += row->height;
5543 width = max (width, row_width);
5546 /* If we've seen partial-length R2L rows, we need to re-adjust the
5547 tool-tip frame width and redisplay it again, to avoid over-wide
5548 tips due to the stretch glyph that extends R2L lines to full
5549 width of the frame. */
5550 if (seen_reversed_p)
5552 /* w->total_cols and FRAME_TOTAL_COLS want the width in columns,
5553 not in pixels. */
5554 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
5555 w->total_cols = width;
5556 FRAME_TOTAL_COLS (f) = width;
5557 adjust_frame_glyphs (f);
5558 clear_glyph_matrix (w->desired_matrix);
5559 clear_glyph_matrix (w->current_matrix);
5560 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5561 width = height = 0;
5562 /* Recompute width and height of the tooltip. */
5563 for (i = 0; i < w->desired_matrix->nrows; ++i)
5565 struct glyph_row *row = &w->desired_matrix->rows[i];
5566 struct glyph *last;
5567 int row_width;
5569 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
5570 break;
5571 row->full_width_p = 1;
5572 row_width = row->pixel_width;
5573 if (row->used[TEXT_AREA] && !row->reversed_p)
5575 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5576 if (INTEGERP (last->object))
5577 row_width -= last->pixel_width;
5580 height += row->height;
5581 width = max (width, row_width);
5585 /* Add the frame's internal border to the width and height the X
5586 window should have. */
5587 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5588 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5590 /* Move the tooltip window where the mouse pointer is. Resize and
5591 show it. */
5592 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5594 block_input ();
5595 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5596 root_x, root_y, width, height);
5597 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5598 unblock_input ();
5600 /* Draw into the window. */
5601 w->must_be_updated_p = 1;
5602 update_single_window (w, 1);
5604 /* Restore original current buffer. */
5605 set_buffer_internal_1 (old_buffer);
5606 windows_or_buffers_changed = old_windows_or_buffers_changed;
5608 start_timer:
5609 /* Let the tip disappear after timeout seconds. */
5610 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5611 intern ("x-hide-tip"));
5613 UNGCPRO;
5614 return unbind_to (count, Qnil);
5618 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5619 doc: /* Hide the current tooltip window, if there is any.
5620 Value is t if tooltip was open, nil otherwise. */)
5621 (void)
5623 ptrdiff_t count;
5624 Lisp_Object deleted, frame, timer;
5625 struct gcpro gcpro1, gcpro2;
5627 /* Return quickly if nothing to do. */
5628 if (NILP (tip_timer) && NILP (tip_frame))
5629 return Qnil;
5631 frame = tip_frame;
5632 timer = tip_timer;
5633 GCPRO2 (frame, timer);
5634 tip_frame = tip_timer = deleted = Qnil;
5636 count = SPECPDL_INDEX ();
5637 specbind (Qinhibit_redisplay, Qt);
5638 specbind (Qinhibit_quit, Qt);
5640 if (!NILP (timer))
5641 call1 (Qcancel_timer, timer);
5643 #ifdef USE_GTK
5645 /* When using system tooltip, tip_frame is the Emacs frame on which
5646 the tip is shown. */
5647 struct frame *f = XFRAME (frame);
5648 if (FRAME_LIVE_P (f) && xg_hide_tooltip (f))
5649 frame = Qnil;
5651 #endif
5653 if (FRAMEP (frame))
5655 delete_frame (frame, Qnil);
5656 deleted = Qt;
5658 #ifdef USE_LUCID
5659 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5660 redisplay procedure is not called when a tip frame over menu
5661 items is unmapped. Redisplay the menu manually... */
5663 Widget w;
5664 struct frame *f = SELECTED_FRAME ();
5665 w = f->output_data.x->menubar_widget;
5667 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
5668 && w != NULL)
5670 block_input ();
5671 xlwmenu_redisplay (w);
5672 unblock_input ();
5675 #endif /* USE_LUCID */
5678 UNGCPRO;
5679 return unbind_to (count, deleted);
5684 /***********************************************************************
5685 File selection dialog
5686 ***********************************************************************/
5688 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5689 Sx_uses_old_gtk_dialog,
5690 0, 0, 0,
5691 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5692 (void)
5694 #ifdef USE_GTK
5695 if (use_dialog_box
5696 && use_file_dialog
5697 && window_system_available (SELECTED_FRAME ())
5698 && xg_uses_old_file_dialog ())
5699 return Qt;
5700 #endif
5701 return Qnil;
5705 #ifdef USE_MOTIF
5706 /* Callback for "OK" and "Cancel" on file selection dialog. */
5708 static void
5709 file_dialog_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5711 int *result = client_data;
5712 XmAnyCallbackStruct *cb = call_data;
5713 *result = cb->reason;
5717 /* Callback for unmapping a file selection dialog. This is used to
5718 capture the case where a dialog is closed via a window manager's
5719 closer button, for example. Using a XmNdestroyCallback didn't work
5720 in this case. */
5722 static void
5723 file_dialog_unmap_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5725 int *result = client_data;
5726 *result = XmCR_CANCEL;
5729 static void
5730 clean_up_file_dialog (void *arg)
5732 Widget dialog = arg;
5734 /* Clean up. */
5735 block_input ();
5736 XtUnmanageChild (dialog);
5737 XtDestroyWidget (dialog);
5738 x_menu_set_in_use (0);
5739 unblock_input ();
5743 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5744 doc: /* Read file name, prompting with PROMPT in directory DIR.
5745 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5746 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5747 or directory must exist.
5749 This function is only defined on NS, MS Windows, and X Windows with the
5750 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5751 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5752 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename,
5753 Lisp_Object mustmatch, Lisp_Object only_dir_p)
5755 int result;
5756 struct frame *f = SELECTED_FRAME ();
5757 Lisp_Object file = Qnil;
5758 Lisp_Object decoded_file;
5759 Widget dialog, text, help;
5760 Arg al[10];
5761 int ac = 0;
5762 XmString dir_xmstring, pattern_xmstring;
5763 ptrdiff_t count = SPECPDL_INDEX ();
5764 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5766 check_window_system (f);
5768 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5770 if (popup_activated ())
5771 error ("Trying to use a menu from within a menu-entry");
5773 CHECK_STRING (prompt);
5774 CHECK_STRING (dir);
5776 /* Prevent redisplay. */
5777 specbind (Qinhibit_redisplay, Qt);
5779 block_input ();
5781 /* Create the dialog with PROMPT as title, using DIR as initial
5782 directory and using "*" as pattern. */
5783 dir = Fexpand_file_name (dir, Qnil);
5784 dir_xmstring = XmStringCreateLocalized (SSDATA (dir));
5785 pattern_xmstring = XmStringCreateLocalized ("*");
5787 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5788 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5789 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5790 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5791 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5792 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5793 "fsb", al, ac);
5794 XmStringFree (dir_xmstring);
5795 XmStringFree (pattern_xmstring);
5797 /* Add callbacks for OK and Cancel. */
5798 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5799 (XtPointer) &result);
5800 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5801 (XtPointer) &result);
5802 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5803 (XtPointer) &result);
5805 /* Remove the help button since we can't display help. */
5806 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5807 XtUnmanageChild (help);
5809 /* Mark OK button as default. */
5810 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5811 XmNshowAsDefault, True, NULL);
5813 /* If MUSTMATCH is non-nil, disable the file entry field of the
5814 dialog, so that the user must select a file from the files list
5815 box. We can't remove it because we wouldn't have a way to get at
5816 the result file name, then. */
5817 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5818 if (!NILP (mustmatch))
5820 Widget label;
5821 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5822 XtSetSensitive (text, False);
5823 XtSetSensitive (label, False);
5826 /* Manage the dialog, so that list boxes get filled. */
5827 XtManageChild (dialog);
5829 if (STRINGP (default_filename))
5831 XmString default_xmstring;
5832 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5833 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5835 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5836 XmTextFieldReplace (wtext, 0, last_pos,
5837 (SSDATA (Ffile_name_nondirectory (default_filename))));
5839 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5840 must include the path for this to work. */
5842 default_xmstring = XmStringCreateLocalized (SSDATA (default_filename));
5844 if (XmListItemExists (list, default_xmstring))
5846 int item_pos = XmListItemPos (list, default_xmstring);
5847 /* Select the item and scroll it into view. */
5848 XmListSelectPos (list, item_pos, True);
5849 XmListSetPos (list, item_pos);
5852 XmStringFree (default_xmstring);
5855 record_unwind_protect_ptr (clean_up_file_dialog, dialog);
5857 /* Process events until the user presses Cancel or OK. */
5858 x_menu_set_in_use (1);
5859 result = 0;
5860 while (result == 0)
5862 XEvent event;
5863 x_menu_wait_for_event (0);
5864 XtAppNextEvent (Xt_app_con, &event);
5865 if (event.type == KeyPress
5866 && FRAME_X_DISPLAY (f) == event.xkey.display)
5868 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5870 /* Pop down on C-g. */
5871 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5872 XtUnmanageChild (dialog);
5875 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5878 /* Get the result. */
5879 if (result == XmCR_OK)
5881 XmString text_string;
5882 String data;
5884 XtVaGetValues (dialog, XmNtextString, &text_string, NULL);
5885 XmStringGetLtoR (text_string, XmFONTLIST_DEFAULT_TAG, &data);
5886 XmStringFree (text_string);
5887 file = build_string (data);
5888 XtFree (data);
5890 else
5891 file = Qnil;
5893 unblock_input ();
5894 UNGCPRO;
5896 /* Make "Cancel" equivalent to C-g. */
5897 if (NILP (file))
5898 Fsignal (Qquit, Qnil);
5900 decoded_file = DECODE_FILE (file);
5902 return unbind_to (count, decoded_file);
5905 #endif /* USE_MOTIF */
5907 #ifdef USE_GTK
5909 static void
5910 clean_up_dialog (void)
5912 x_menu_set_in_use (0);
5915 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5916 doc: /* Read file name, prompting with PROMPT in directory DIR.
5917 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5918 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5919 or directory must exist.
5921 This function is only defined on NS, MS Windows, and X Windows with the
5922 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5923 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5924 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
5926 struct frame *f = SELECTED_FRAME ();
5927 char *fn;
5928 Lisp_Object file = Qnil;
5929 Lisp_Object decoded_file;
5930 ptrdiff_t count = SPECPDL_INDEX ();
5931 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5932 char *cdef_file;
5934 check_window_system (f);
5936 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5938 if (popup_activated ())
5939 error ("Trying to use a menu from within a menu-entry");
5941 CHECK_STRING (prompt);
5942 CHECK_STRING (dir);
5944 /* Prevent redisplay. */
5945 specbind (Qinhibit_redisplay, Qt);
5946 record_unwind_protect_void (clean_up_dialog);
5948 block_input ();
5950 if (STRINGP (default_filename))
5951 cdef_file = SSDATA (default_filename);
5952 else
5953 cdef_file = SSDATA (dir);
5955 fn = xg_get_file_name (f, SSDATA (prompt), cdef_file,
5956 ! NILP (mustmatch),
5957 ! NILP (only_dir_p));
5959 if (fn)
5961 file = build_string (fn);
5962 xfree (fn);
5965 unblock_input ();
5966 UNGCPRO;
5968 /* Make "Cancel" equivalent to C-g. */
5969 if (NILP (file))
5970 Fsignal (Qquit, Qnil);
5972 decoded_file = DECODE_FILE (file);
5974 return unbind_to (count, decoded_file);
5978 #ifdef HAVE_FREETYPE
5980 DEFUN ("x-select-font", Fx_select_font, Sx_select_font, 0, 2, 0,
5981 doc: /* Read a font using a GTK dialog.
5982 Return either a font spec (for GTK versions >= 3.2) or a string
5983 containing a GTK-style font name.
5985 FRAME is the frame on which to pop up the font chooser. If omitted or
5986 nil, it defaults to the selected frame. */)
5987 (Lisp_Object frame, Lisp_Object ignored)
5989 struct frame *f = decode_window_system_frame (frame);
5990 Lisp_Object font;
5991 Lisp_Object font_param;
5992 char *default_name = NULL;
5993 struct gcpro gcpro1, gcpro2;
5994 ptrdiff_t count = SPECPDL_INDEX ();
5996 if (popup_activated ())
5997 error ("Trying to use a menu from within a menu-entry");
5999 /* Prevent redisplay. */
6000 specbind (Qinhibit_redisplay, Qt);
6001 record_unwind_protect_void (clean_up_dialog);
6003 block_input ();
6005 GCPRO2 (font_param, font);
6007 XSETFONT (font, FRAME_FONT (f));
6008 font_param = Ffont_get (font, intern (":name"));
6009 if (STRINGP (font_param))
6010 default_name = xstrdup (SSDATA (font_param));
6011 else
6013 font_param = Fframe_parameter (frame, Qfont_param);
6014 if (STRINGP (font_param))
6015 default_name = xstrdup (SSDATA (font_param));
6018 font = xg_get_font (f, default_name);
6019 xfree (default_name);
6021 unblock_input ();
6023 if (NILP (font))
6024 Fsignal (Qquit, Qnil);
6026 return unbind_to (count, font);
6028 #endif /* HAVE_FREETYPE */
6030 #endif /* USE_GTK */
6033 /***********************************************************************
6034 Keyboard
6035 ***********************************************************************/
6037 #ifdef HAVE_XKB
6038 #include <X11/XKBlib.h>
6039 #include <X11/keysym.h>
6040 #endif
6042 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
6043 Sx_backspace_delete_keys_p, 0, 1, 0,
6044 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
6045 FRAME nil means use the selected frame.
6046 Value is t if we know that both keys are present, and are mapped to the
6047 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
6048 present and mapped to the usual X keysyms. */)
6049 (Lisp_Object frame)
6051 #ifndef HAVE_XKB
6052 return Qlambda;
6053 #else
6054 XkbDescPtr kb;
6055 struct frame *f = decode_window_system_frame (frame);
6056 Display *dpy = FRAME_X_DISPLAY (f);
6057 Lisp_Object have_keys;
6058 int major, minor, op, event, error_code;
6060 block_input ();
6062 /* Check library version in case we're dynamically linked. */
6063 major = XkbMajorVersion;
6064 minor = XkbMinorVersion;
6065 if (!XkbLibraryVersion (&major, &minor))
6067 unblock_input ();
6068 return Qlambda;
6071 /* Check that the server supports XKB. */
6072 major = XkbMajorVersion;
6073 minor = XkbMinorVersion;
6074 if (!XkbQueryExtension (dpy, &op, &event, &error_code, &major, &minor))
6076 unblock_input ();
6077 return Qlambda;
6080 /* In this code we check that the keyboard has physical keys with names
6081 that start with BKSP (Backspace) and DELE (Delete), and that they
6082 generate keysym XK_BackSpace and XK_Delete respectively.
6083 This function is used to test if normal-erase-is-backspace should be
6084 turned on.
6085 An alternative approach would be to just check if XK_BackSpace and
6086 XK_Delete are mapped to any key. But if any of those are mapped to
6087 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
6088 user doesn't know about it, it is better to return false here.
6089 It is more obvious to the user what to do if she/he has two keys
6090 clearly marked with names/symbols and one key does something not
6091 expected (i.e. she/he then tries the other).
6092 The cases where Backspace/Delete is mapped to some other key combination
6093 are rare, and in those cases, normal-erase-is-backspace can be turned on
6094 manually. */
6096 have_keys = Qnil;
6097 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
6098 if (kb)
6100 int delete_keycode = 0, backspace_keycode = 0, i;
6102 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
6104 for (i = kb->min_key_code;
6105 (i < kb->max_key_code
6106 && (delete_keycode == 0 || backspace_keycode == 0));
6107 ++i)
6109 /* The XKB symbolic key names can be seen most easily in
6110 the PS file generated by `xkbprint -label name
6111 $DISPLAY'. */
6112 if (memcmp ("DELE", kb->names->keys[i].name, 4) == 0)
6113 delete_keycode = i;
6114 else if (memcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
6115 backspace_keycode = i;
6118 XkbFreeNames (kb, 0, True);
6121 XkbFreeClientMap (kb, 0, True);
6123 if (delete_keycode
6124 && backspace_keycode
6125 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
6126 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
6127 have_keys = Qt;
6129 unblock_input ();
6130 return have_keys;
6131 #endif
6136 /***********************************************************************
6137 Initialization
6138 ***********************************************************************/
6140 /* Keep this list in the same order as frame_parms in frame.c.
6141 Use 0 for unsupported frame parameters. */
6143 frame_parm_handler x_frame_parm_handlers[] =
6145 x_set_autoraise,
6146 x_set_autolower,
6147 x_set_background_color,
6148 x_set_border_color,
6149 x_set_border_width,
6150 x_set_cursor_color,
6151 x_set_cursor_type,
6152 x_set_font,
6153 x_set_foreground_color,
6154 x_set_icon_name,
6155 x_set_icon_type,
6156 x_set_internal_border_width,
6157 x_set_menu_bar_lines,
6158 x_set_mouse_color,
6159 x_explicitly_set_name,
6160 x_set_scroll_bar_width,
6161 x_set_title,
6162 x_set_unsplittable,
6163 x_set_vertical_scroll_bars,
6164 x_set_visibility,
6165 x_set_tool_bar_lines,
6166 x_set_scroll_bar_foreground,
6167 x_set_scroll_bar_background,
6168 x_set_screen_gamma,
6169 x_set_line_spacing,
6170 x_set_fringe_width,
6171 x_set_fringe_width,
6172 x_set_wait_for_wm,
6173 x_set_fullscreen,
6174 x_set_font_backend,
6175 x_set_alpha,
6176 x_set_sticky,
6177 x_set_tool_bar_position,
6180 void
6181 syms_of_xfns (void)
6183 /* The section below is built by the lisp expression at the top of the file,
6184 just above where these variables are declared. */
6185 /*&&& init symbols here &&&*/
6186 DEFSYM (Qsuppress_icon, "suppress-icon");
6187 DEFSYM (Qundefined_color, "undefined-color");
6188 DEFSYM (Qcompound_text, "compound-text");
6189 DEFSYM (Qcancel_timer, "cancel-timer");
6190 DEFSYM (Qfont_param, "font-parameter");
6191 /* This is the end of symbol initialization. */
6193 Fput (Qundefined_color, Qerror_conditions,
6194 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
6195 Fput (Qundefined_color, Qerror_message,
6196 build_pure_c_string ("Undefined color"));
6198 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
6199 doc: /* The shape of the pointer when over text.
6200 Changing the value does not affect existing frames
6201 unless you set the mouse color. */);
6202 Vx_pointer_shape = Qnil;
6204 #if 0 /* This doesn't really do anything. */
6205 DEFVAR_LISP ("x-nontext-pointer-shape", Vx_nontext_pointer_shape,
6206 doc: /* The shape of the pointer when not over text.
6207 This variable takes effect when you create a new frame
6208 or when you set the mouse color. */);
6209 #endif
6210 Vx_nontext_pointer_shape = Qnil;
6212 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
6213 doc: /* The shape of the pointer when Emacs is busy.
6214 This variable takes effect when you create a new frame
6215 or when you set the mouse color. */);
6216 Vx_hourglass_pointer_shape = Qnil;
6218 #if 0 /* This doesn't really do anything. */
6219 DEFVAR_LISP ("x-mode-pointer-shape", Vx_mode_pointer_shape,
6220 doc: /* The shape of the pointer when over the mode line.
6221 This variable takes effect when you create a new frame
6222 or when you set the mouse color. */);
6223 #endif
6224 Vx_mode_pointer_shape = Qnil;
6226 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
6227 Vx_sensitive_text_pointer_shape,
6228 doc: /* The shape of the pointer when over mouse-sensitive text.
6229 This variable takes effect when you create a new frame
6230 or when you set the mouse color. */);
6231 Vx_sensitive_text_pointer_shape = Qnil;
6233 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
6234 Vx_window_horizontal_drag_shape,
6235 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
6236 This variable takes effect when you create a new frame
6237 or when you set the mouse color. */);
6238 Vx_window_horizontal_drag_shape = Qnil;
6240 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
6241 doc: /* A string indicating the foreground color of the cursor box. */);
6242 Vx_cursor_fore_pixel = Qnil;
6244 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
6245 doc: /* Maximum size for tooltips.
6246 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
6247 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
6249 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
6250 doc: /* Non-nil if no X window manager is in use.
6251 Emacs doesn't try to figure this out; this is always nil
6252 unless you set it to something else. */);
6253 /* We don't have any way to find this out, so set it to nil
6254 and maybe the user would like to set it to t. */
6255 Vx_no_window_manager = Qnil;
6257 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
6258 Vx_pixel_size_width_font_regexp,
6259 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
6261 Since Emacs gets width of a font matching with this regexp from
6262 PIXEL_SIZE field of the name, font finding mechanism gets faster for
6263 such a font. This is especially effective for such large fonts as
6264 Chinese, Japanese, and Korean. */);
6265 Vx_pixel_size_width_font_regexp = Qnil;
6267 /* This is not ifdef:ed, so other builds than GTK can customize it. */
6268 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", x_gtk_use_old_file_dialog,
6269 doc: /* Non-nil means prompt with the old GTK file selection dialog.
6270 If nil or if the file selection dialog is not available, the new GTK file
6271 chooser is used instead. To turn off all file dialogs set the
6272 variable `use-file-dialog'. */);
6273 x_gtk_use_old_file_dialog = 0;
6275 DEFVAR_BOOL ("x-gtk-show-hidden-files", x_gtk_show_hidden_files,
6276 doc: /* If non-nil, the GTK file chooser will by default show hidden files.
6277 Note that this is just the default, there is a toggle button on the file
6278 chooser to show or not show hidden files on a case by case basis. */);
6279 x_gtk_show_hidden_files = 0;
6281 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", x_gtk_file_dialog_help_text,
6282 doc: /* If non-nil, the GTK file chooser will show additional help text.
6283 If more space for files in the file chooser dialog is wanted, set this to nil
6284 to turn the additional text off. */);
6285 x_gtk_file_dialog_help_text = 1;
6287 DEFVAR_BOOL ("x-gtk-whole-detached-tool-bar", x_gtk_whole_detached_tool_bar,
6288 doc: /* If non-nil, a detached tool bar is shown in full.
6289 The default is to just show an arrow and pressing on that arrow shows
6290 the tool bar buttons. */);
6291 x_gtk_whole_detached_tool_bar = 0;
6293 DEFVAR_BOOL ("x-gtk-use-system-tooltips", x_gtk_use_system_tooltips,
6294 doc: /* If non-nil with a Gtk+ built Emacs, the Gtk+ tooltip is used.
6295 Otherwise use Emacs own tooltip implementation.
6296 When using Gtk+ tooltips, the tooltip face is not used. */);
6297 x_gtk_use_system_tooltips = 1;
6299 Fprovide (intern_c_string ("x"), Qnil);
6301 #ifdef USE_X_TOOLKIT
6302 Fprovide (intern_c_string ("x-toolkit"), Qnil);
6303 #ifdef USE_MOTIF
6304 Fprovide (intern_c_string ("motif"), Qnil);
6306 DEFVAR_LISP ("motif-version-string", Vmotif_version_string,
6307 doc: /* Version info for LessTif/Motif. */);
6308 Vmotif_version_string = build_string (XmVERSION_STRING);
6309 #endif /* USE_MOTIF */
6310 #endif /* USE_X_TOOLKIT */
6312 #ifdef USE_GTK
6313 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
6314 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
6315 But for a user it is a toolkit for X, and indeed, configure
6316 accepts --with-x-toolkit=gtk. */
6317 Fprovide (intern_c_string ("x-toolkit"), Qnil);
6318 Fprovide (intern_c_string ("gtk"), Qnil);
6319 Fprovide (intern_c_string ("move-toolbar"), Qnil);
6321 DEFVAR_LISP ("gtk-version-string", Vgtk_version_string,
6322 doc: /* Version info for GTK+. */);
6324 char gtk_version[sizeof ".." + 3 * INT_STRLEN_BOUND (int)];
6325 int len = sprintf (gtk_version, "%d.%d.%d",
6326 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
6327 Vgtk_version_string = make_pure_string (gtk_version, len, len, 0);
6329 #endif /* USE_GTK */
6331 /* X window properties. */
6332 defsubr (&Sx_change_window_property);
6333 defsubr (&Sx_delete_window_property);
6334 defsubr (&Sx_window_property);
6336 defsubr (&Sxw_display_color_p);
6337 defsubr (&Sx_display_grayscale_p);
6338 defsubr (&Sxw_color_defined_p);
6339 defsubr (&Sxw_color_values);
6340 defsubr (&Sx_server_max_request_size);
6341 defsubr (&Sx_server_vendor);
6342 defsubr (&Sx_server_version);
6343 defsubr (&Sx_display_pixel_width);
6344 defsubr (&Sx_display_pixel_height);
6345 defsubr (&Sx_display_mm_width);
6346 defsubr (&Sx_display_mm_height);
6347 defsubr (&Sx_display_screens);
6348 defsubr (&Sx_display_planes);
6349 defsubr (&Sx_display_color_cells);
6350 defsubr (&Sx_display_visual_class);
6351 defsubr (&Sx_display_backing_store);
6352 defsubr (&Sx_display_save_under);
6353 defsubr (&Sx_display_monitor_attributes_list);
6354 defsubr (&Sx_wm_set_size_hint);
6355 defsubr (&Sx_create_frame);
6356 defsubr (&Sx_open_connection);
6357 defsubr (&Sx_close_connection);
6358 defsubr (&Sx_display_list);
6359 defsubr (&Sx_synchronize);
6360 defsubr (&Sx_focus_frame);
6361 defsubr (&Sx_backspace_delete_keys_p);
6363 defsubr (&Sx_show_tip);
6364 defsubr (&Sx_hide_tip);
6365 tip_timer = Qnil;
6366 staticpro (&tip_timer);
6367 tip_frame = Qnil;
6368 staticpro (&tip_frame);
6370 last_show_tip_args = Qnil;
6371 staticpro (&last_show_tip_args);
6373 defsubr (&Sx_uses_old_gtk_dialog);
6374 #if defined (USE_MOTIF) || defined (USE_GTK)
6375 defsubr (&Sx_file_dialog);
6376 #endif
6378 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
6379 defsubr (&Sx_select_font);
6380 #endif
6383 #endif /* HAVE_X_WINDOWS */