Document arguments of insert_1_both.
[emacs.git] / src / xfns.c
blob46cd10e5f2f901455b02f2ba87e7a3907f04f03c
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 /* This makes the fields of a Display accessible, in Xlib header files. */
27 #define XLIB_ILLEGAL_ACCESS
29 #include "lisp.h"
30 #include "xterm.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "character.h"
34 #include "buffer.h"
35 #include "intervals.h"
36 #include "dispextern.h"
37 #include "keyboard.h"
38 #include "blockinput.h"
39 #include <epaths.h>
40 #include "charset.h"
41 #include "coding.h"
42 #include "fontset.h"
43 #include "systime.h"
44 #include "termhooks.h"
45 #include "atimer.h"
46 #include "termchar.h"
47 #include "font.h"
49 #ifdef HAVE_X_WINDOWS
51 #include <sys/types.h>
52 #include <sys/stat.h>
54 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
55 #include "bitmaps/gray.xbm"
56 #else
57 #include <X11/bitmaps/gray>
58 #endif
60 #include "xsettings.h"
62 #ifdef HAVE_XRANDR
63 #include <X11/extensions/Xrandr.h>
64 #endif
65 #ifdef HAVE_XINERAMA
66 #include <X11/extensions/Xinerama.h>
67 #endif
69 #ifdef USE_GTK
70 #include "gtkutil.h"
71 #endif
73 #ifdef USE_X_TOOLKIT
74 #include <X11/Shell.h>
76 #ifndef USE_MOTIF
77 #ifdef HAVE_XAW3D
78 #include <X11/Xaw3d/Paned.h>
79 #include <X11/Xaw3d/Label.h>
80 #else /* !HAVE_XAW3D */
81 #include <X11/Xaw/Paned.h>
82 #include <X11/Xaw/Label.h>
83 #endif /* HAVE_XAW3D */
84 #endif /* USE_MOTIF */
86 #ifdef USG
87 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
88 #include <X11/Xos.h>
89 #define USG
90 #ifdef USG /* Pacify gcc -Wunused-macros. */
91 #endif
92 #else
93 #include <X11/Xos.h>
94 #endif
96 #include "widget.h"
98 #include "../lwlib/lwlib.h"
100 #ifdef USE_MOTIF
101 #include <Xm/Xm.h>
102 #include <Xm/DialogS.h>
103 #include <Xm/FileSB.h>
104 #include <Xm/List.h>
105 #include <Xm/TextF.h>
106 #endif
108 #ifdef USE_LUCID
109 #include "../lwlib/xlwmenu.h"
110 #endif
112 #if !defined (NO_EDITRES)
113 #define HACK_EDITRES
114 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
115 #endif /* not defined NO_EDITRES */
117 /* Unique id counter for widgets created by the Lucid Widget Library. */
119 extern LWLIB_ID widget_id_tick;
121 #ifdef USE_MOTIF
123 #endif /* USE_MOTIF */
125 #endif /* USE_X_TOOLKIT */
127 #ifdef USE_GTK
129 #endif /* USE_GTK */
131 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
133 static Lisp_Object Qsuppress_icon;
134 static Lisp_Object Qundefined_color;
135 static Lisp_Object Qcompound_text, Qcancel_timer;
136 static Lisp_Object Qgeometry, Qworkarea, Qmm_size, Qframes, Qsource;
137 Lisp_Object Qfont_param;
139 #ifdef GLYPH_DEBUG
140 static ptrdiff_t image_cache_refcount;
141 static int dpyinfo_refcount;
142 #endif
144 static struct x_display_info *x_display_info_for_name (Lisp_Object);
146 /* Let the user specify an X display with a Lisp object.
147 OBJECT may be nil, a frame or a terminal object.
148 nil stands for the selected frame--or, if that is not an X frame,
149 the first X display on the list. */
151 struct x_display_info *
152 check_x_display_info (Lisp_Object object)
154 struct x_display_info *dpyinfo = NULL;
156 if (NILP (object))
158 struct frame *sf = XFRAME (selected_frame);
160 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
161 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
162 else if (x_display_list != 0)
163 dpyinfo = x_display_list;
164 else
165 error ("X windows are not in use or not initialized");
167 else if (TERMINALP (object))
169 struct terminal *t = get_terminal (object, 1);
171 if (t->type != output_x_window)
172 error ("Terminal %"pI"d is not an X display", XINT (object));
174 dpyinfo = t->display_info.x;
176 else if (STRINGP (object))
177 dpyinfo = x_display_info_for_name (object);
178 else
180 FRAME_PTR f = decode_window_system_frame (object);
181 dpyinfo = FRAME_X_DISPLAY_INFO (f);
184 return dpyinfo;
188 /* Return the Emacs frame-object corresponding to an X window.
189 It could be the frame's main window or an icon window. */
191 /* This function can be called during GC, so use GC_xxx type test macros. */
193 struct frame *
194 x_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
196 Lisp_Object tail, frame;
197 struct frame *f;
199 if (wdesc == None)
200 return NULL;
202 FOR_EACH_FRAME (tail, frame)
204 f = XFRAME (frame);
205 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
206 continue;
207 if (f->output_data.x->hourglass_window == wdesc)
208 return f;
209 #ifdef USE_X_TOOLKIT
210 if ((f->output_data.x->edit_widget
211 && XtWindow (f->output_data.x->edit_widget) == wdesc)
212 /* A tooltip frame? */
213 || (!f->output_data.x->edit_widget
214 && FRAME_X_WINDOW (f) == wdesc)
215 || f->output_data.x->icon_desc == wdesc)
216 return f;
217 #else /* not USE_X_TOOLKIT */
218 #ifdef USE_GTK
219 if (f->output_data.x->edit_widget)
221 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
222 struct x_output *x = f->output_data.x;
223 if (gwdesc != 0 && gwdesc == x->edit_widget)
224 return f;
226 #endif /* USE_GTK */
227 if (FRAME_X_WINDOW (f) == wdesc
228 || f->output_data.x->icon_desc == wdesc)
229 return f;
230 #endif /* not USE_X_TOOLKIT */
232 return 0;
235 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
236 /* Like x_window_to_frame but also compares the window with the widget's
237 windows. */
239 struct frame *
240 x_any_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
242 Lisp_Object tail, frame;
243 struct frame *f, *found = NULL;
244 struct x_output *x;
246 if (wdesc == None)
247 return NULL;
249 FOR_EACH_FRAME (tail, frame)
251 if (found)
252 break;
253 f = XFRAME (frame);
254 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
256 /* This frame matches if the window is any of its widgets. */
257 x = f->output_data.x;
258 if (x->hourglass_window == wdesc)
259 found = f;
260 else if (x->widget)
262 #ifdef USE_GTK
263 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
264 if (gwdesc != 0
265 && gtk_widget_get_toplevel (gwdesc) == x->widget)
266 found = f;
267 #else
268 if (wdesc == XtWindow (x->widget)
269 || wdesc == XtWindow (x->column_widget)
270 || wdesc == XtWindow (x->edit_widget))
271 found = f;
272 /* Match if the window is this frame's menubar. */
273 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
274 found = f;
275 #endif
277 else if (FRAME_X_WINDOW (f) == wdesc)
278 /* A tooltip frame. */
279 found = f;
283 return found;
286 /* Likewise, but consider only the menu bar widget. */
288 struct frame *
289 x_menubar_window_to_frame (struct x_display_info *dpyinfo, XEvent *event)
291 Window wdesc = event->xany.window;
292 Lisp_Object tail, frame;
293 struct frame *f;
294 struct x_output *x;
296 if (wdesc == None)
297 return NULL;
299 FOR_EACH_FRAME (tail, frame)
301 f = XFRAME (frame);
302 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
303 continue;
304 x = f->output_data.x;
305 #ifdef USE_GTK
306 if (x->menubar_widget && xg_event_is_for_menubar (f, event))
307 return f;
308 #else
309 /* Match if the window is this frame's menubar. */
310 if (x->menubar_widget
311 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
312 return f;
313 #endif
315 return 0;
318 /* Return the frame whose principal (outermost) window is WDESC.
319 If WDESC is some other (smaller) window, we return 0. */
321 struct frame *
322 x_top_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
324 Lisp_Object tail, frame;
325 struct frame *f;
326 struct x_output *x;
328 if (wdesc == None)
329 return NULL;
331 FOR_EACH_FRAME (tail, frame)
333 f = XFRAME (frame);
334 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
335 continue;
336 x = f->output_data.x;
338 if (x->widget)
340 /* This frame matches if the window is its topmost widget. */
341 #ifdef USE_GTK
342 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
343 if (gwdesc == x->widget)
344 return f;
345 #else
346 if (wdesc == XtWindow (x->widget))
347 return f;
348 #if 0 /* I don't know why it did this,
349 but it seems logically wrong,
350 and it causes trouble for MapNotify events. */
351 /* Match if the window is this frame's menubar. */
352 if (x->menubar_widget
353 && wdesc == XtWindow (x->menubar_widget))
354 return f;
355 #endif
356 #endif
358 else if (FRAME_X_WINDOW (f) == wdesc)
359 /* Tooltip frame. */
360 return f;
362 return 0;
364 #endif /* USE_X_TOOLKIT || USE_GTK */
368 /* Store the screen positions of frame F into XPTR and YPTR.
369 These are the positions of the containing window manager window,
370 not Emacs's own window. */
372 void
373 x_real_positions (FRAME_PTR f, int *xptr, int *yptr)
375 int win_x, win_y, outer_x IF_LINT (= 0), outer_y IF_LINT (= 0);
376 int real_x = 0, real_y = 0;
377 int had_errors = 0;
378 Window win = f->output_data.x->parent_desc;
379 Atom actual_type;
380 unsigned long actual_size, bytes_remaining;
381 int rc, actual_format;
382 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
383 long max_len = 400;
384 Display *dpy = FRAME_X_DISPLAY (f);
385 unsigned char *tmp_data = NULL;
386 Atom target_type = XA_CARDINAL;
388 block_input ();
390 x_catch_errors (dpy);
392 if (win == dpyinfo->root_window)
393 win = FRAME_OUTER_WINDOW (f);
395 /* This loop traverses up the containment tree until we hit the root
396 window. Window managers may intersect many windows between our window
397 and the root window. The window we find just before the root window
398 should be the outer WM window. */
399 for (;;)
401 Window wm_window, rootw;
402 Window *tmp_children;
403 unsigned int tmp_nchildren;
404 int success;
406 success = XQueryTree (FRAME_X_DISPLAY (f), win, &rootw,
407 &wm_window, &tmp_children, &tmp_nchildren);
409 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
411 /* Don't free tmp_children if XQueryTree failed. */
412 if (! success)
413 break;
415 XFree (tmp_children);
417 if (wm_window == rootw || had_errors)
418 break;
420 win = wm_window;
423 if (! had_errors)
425 unsigned int ign;
426 Window child, rootw;
428 /* Get the real coordinates for the WM window upper left corner */
429 XGetGeometry (FRAME_X_DISPLAY (f), win,
430 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
432 /* Translate real coordinates to coordinates relative to our
433 window. For our window, the upper left corner is 0, 0.
434 Since the upper left corner of the WM window is outside
435 our window, win_x and win_y will be negative:
437 ------------------ ---> x
438 | title |
439 | ----------------- v y
440 | | our window
442 XTranslateCoordinates (FRAME_X_DISPLAY (f),
444 /* From-window, to-window. */
445 FRAME_X_DISPLAY_INFO (f)->root_window,
446 FRAME_X_WINDOW (f),
448 /* From-position, to-position. */
449 real_x, real_y, &win_x, &win_y,
451 /* Child of win. */
452 &child);
454 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
456 outer_x = win_x;
457 outer_y = win_y;
459 else
461 XTranslateCoordinates (FRAME_X_DISPLAY (f),
463 /* From-window, to-window. */
464 FRAME_X_DISPLAY_INFO (f)->root_window,
465 FRAME_OUTER_WINDOW (f),
467 /* From-position, to-position. */
468 real_x, real_y, &outer_x, &outer_y,
470 /* Child of win. */
471 &child);
474 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
478 if (dpyinfo->root_window == f->output_data.x->parent_desc)
480 /* Try _NET_FRAME_EXTENTS if our parent is the root window. */
481 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_frame_extents,
482 0, max_len, False, target_type,
483 &actual_type, &actual_format, &actual_size,
484 &bytes_remaining, &tmp_data);
486 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
487 && actual_size == 4 && actual_format == 32)
489 unsigned int ign;
490 Window rootw;
491 long *fe = (long *)tmp_data;
493 XGetGeometry (FRAME_X_DISPLAY (f), win,
494 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
495 outer_x = -fe[0];
496 outer_y = -fe[2];
497 real_x -= fe[0];
498 real_y -= fe[2];
502 if (tmp_data) XFree (tmp_data);
504 x_uncatch_errors ();
506 unblock_input ();
508 if (had_errors) return;
510 f->x_pixels_diff = -win_x;
511 f->y_pixels_diff = -win_y;
513 FRAME_X_OUTPUT (f)->x_pixels_outer_diff = -outer_x;
514 FRAME_X_OUTPUT (f)->y_pixels_outer_diff = -outer_y;
516 *xptr = real_x;
517 *yptr = real_y;
523 /* Gamma-correct COLOR on frame F. */
525 void
526 gamma_correct (struct frame *f, XColor *color)
528 if (f->gamma)
530 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
531 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
532 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
537 /* Decide if color named COLOR_NAME is valid for use on frame F. If
538 so, return the RGB values in COLOR. If ALLOC_P,
539 allocate the color. Value is false if COLOR_NAME is invalid, or
540 no color could be allocated. */
542 bool
543 x_defined_color (struct frame *f, const char *color_name,
544 XColor *color, bool alloc_p)
546 bool success_p = 0;
547 Display *dpy = FRAME_X_DISPLAY (f);
548 Colormap cmap = FRAME_X_COLORMAP (f);
550 block_input ();
551 #ifdef USE_GTK
552 success_p = xg_check_special_colors (f, color_name, color);
553 #endif
554 if (!success_p)
555 success_p = XParseColor (dpy, cmap, color_name, color) != 0;
556 if (success_p && alloc_p)
557 success_p = x_alloc_nearest_color (f, cmap, color);
558 unblock_input ();
560 return success_p;
564 /* Return the pixel color value for color COLOR_NAME on frame F. If F
565 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
566 Signal an error if color can't be allocated. */
568 static int
569 x_decode_color (FRAME_PTR f, Lisp_Object color_name, int mono_color)
571 XColor cdef;
573 CHECK_STRING (color_name);
575 #if 0 /* Don't do this. It's wrong when we're not using the default
576 colormap, it makes freeing difficult, and it's probably not
577 an important optimization. */
578 if (strcmp (SDATA (color_name), "black") == 0)
579 return BLACK_PIX_DEFAULT (f);
580 else if (strcmp (SDATA (color_name), "white") == 0)
581 return WHITE_PIX_DEFAULT (f);
582 #endif
584 /* Return MONO_COLOR for monochrome frames. */
585 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
586 return mono_color;
588 /* x_defined_color is responsible for coping with failures
589 by looking for a near-miss. */
590 if (x_defined_color (f, SSDATA (color_name), &cdef, 1))
591 return cdef.pixel;
593 signal_error ("Undefined color", color_name);
598 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
599 the previous value of that parameter, NEW_VALUE is the new value.
600 See also the comment of wait_for_wm in struct x_output. */
602 static void
603 x_set_wait_for_wm (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
605 f->output_data.x->wait_for_wm = !NILP (new_value);
608 static void
609 x_set_tool_bar_position (struct frame *f,
610 Lisp_Object new_value,
611 Lisp_Object old_value)
613 if (! EQ (new_value, Qleft) && ! EQ (new_value, Qright)
614 && ! EQ (new_value, Qbottom) && ! EQ (new_value, Qtop))
615 return;
616 if (EQ (new_value, old_value)) return;
618 #ifdef USE_GTK
619 xg_change_toolbar_position (f, new_value);
620 fset_tool_bar_position (f, new_value);
621 #endif
624 #ifdef USE_GTK
626 /* Set icon from FILE for frame F. By using GTK functions the icon
627 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
630 xg_set_icon (FRAME_PTR f, Lisp_Object file)
632 int result = 0;
633 Lisp_Object found;
635 found = x_find_image_file (file);
637 if (! NILP (found))
639 GdkPixbuf *pixbuf;
640 GError *err = NULL;
641 char *filename = SSDATA (found);
642 block_input ();
644 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
646 if (pixbuf)
648 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
649 pixbuf);
650 g_object_unref (pixbuf);
652 result = 1;
654 else
655 g_error_free (err);
657 unblock_input ();
660 return result;
664 xg_set_icon_from_xpm_data (FRAME_PTR f, const char **data)
666 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data (data);
668 if (!pixbuf)
669 return 0;
671 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), pixbuf);
672 g_object_unref (pixbuf);
673 return 1;
675 #endif /* USE_GTK */
678 /* Functions called only from `x_set_frame_param'
679 to set individual parameters.
681 If FRAME_X_WINDOW (f) is 0,
682 the frame is being created and its X-window does not exist yet.
683 In that case, just record the parameter's new value
684 in the standard place; do not attempt to change the window. */
686 static void
687 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
689 struct x_output *x = f->output_data.x;
690 unsigned long fg, old_fg;
692 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
693 old_fg = FRAME_FOREGROUND_PIXEL (f);
694 FRAME_FOREGROUND_PIXEL (f) = fg;
696 if (FRAME_X_WINDOW (f) != 0)
698 Display *dpy = FRAME_X_DISPLAY (f);
700 block_input ();
701 XSetForeground (dpy, x->normal_gc, fg);
702 XSetBackground (dpy, x->reverse_gc, fg);
704 if (x->cursor_pixel == old_fg)
706 unload_color (f, x->cursor_pixel);
707 x->cursor_pixel = x_copy_color (f, fg);
708 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
711 unblock_input ();
713 update_face_from_frame_parameter (f, Qforeground_color, arg);
715 if (FRAME_VISIBLE_P (f))
716 redraw_frame (f);
719 unload_color (f, old_fg);
722 static void
723 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
725 struct x_output *x = f->output_data.x;
726 unsigned long bg;
728 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
729 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
730 FRAME_BACKGROUND_PIXEL (f) = bg;
732 if (FRAME_X_WINDOW (f) != 0)
734 Display *dpy = FRAME_X_DISPLAY (f);
736 block_input ();
737 XSetBackground (dpy, x->normal_gc, bg);
738 XSetForeground (dpy, x->reverse_gc, bg);
739 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
740 XSetForeground (dpy, x->cursor_gc, bg);
742 #ifdef USE_GTK
743 xg_set_background_color (f, bg);
744 #endif
746 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
747 toolkit scroll bars. */
749 Lisp_Object bar;
750 for (bar = FRAME_SCROLL_BARS (f);
751 !NILP (bar);
752 bar = XSCROLL_BAR (bar)->next)
754 Window window = XSCROLL_BAR (bar)->x_window;
755 XSetWindowBackground (dpy, window, bg);
758 #endif /* USE_TOOLKIT_SCROLL_BARS */
760 unblock_input ();
761 update_face_from_frame_parameter (f, Qbackground_color, arg);
763 if (FRAME_VISIBLE_P (f))
764 redraw_frame (f);
768 static Cursor
769 make_invisible_cursor (struct frame *f)
771 Display *dpy = FRAME_X_DISPLAY (f);
772 static char const no_data[] = { 0 };
773 Pixmap pix;
774 XColor col;
775 Cursor c = 0;
777 x_catch_errors (dpy);
778 pix = XCreateBitmapFromData (dpy, FRAME_X_DISPLAY_INFO (f)->root_window,
779 no_data, 1, 1);
780 if (! x_had_errors_p (dpy) && pix != None)
782 Cursor pixc;
783 col.pixel = 0;
784 col.red = col.green = col.blue = 0;
785 col.flags = DoRed | DoGreen | DoBlue;
786 pixc = XCreatePixmapCursor (dpy, pix, pix, &col, &col, 0, 0);
787 if (! x_had_errors_p (dpy) && pixc != None)
788 c = pixc;
789 XFreePixmap (dpy, pix);
792 x_uncatch_errors ();
794 return c;
797 static void
798 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
800 struct x_output *x = f->output_data.x;
801 Display *dpy = FRAME_X_DISPLAY (f);
802 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
803 Cursor hourglass_cursor, horizontal_drag_cursor;
804 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
805 unsigned long mask_color = FRAME_BACKGROUND_PIXEL (f);
807 /* Don't let pointers be invisible. */
808 if (mask_color == pixel)
810 x_free_colors (f, &pixel, 1);
811 pixel = x_copy_color (f, FRAME_FOREGROUND_PIXEL (f));
814 unload_color (f, x->mouse_pixel);
815 x->mouse_pixel = pixel;
817 block_input ();
819 /* It's not okay to crash if the user selects a screwy cursor. */
820 x_catch_errors (dpy);
822 if (!NILP (Vx_pointer_shape))
824 CHECK_NUMBER (Vx_pointer_shape);
825 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
827 else
828 cursor = XCreateFontCursor (dpy, XC_xterm);
829 x_check_errors (dpy, "bad text pointer cursor: %s");
831 if (!NILP (Vx_nontext_pointer_shape))
833 CHECK_NUMBER (Vx_nontext_pointer_shape);
834 nontext_cursor
835 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
837 else
838 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
839 x_check_errors (dpy, "bad nontext pointer cursor: %s");
841 if (!NILP (Vx_hourglass_pointer_shape))
843 CHECK_NUMBER (Vx_hourglass_pointer_shape);
844 hourglass_cursor
845 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
847 else
848 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
849 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
851 if (!NILP (Vx_mode_pointer_shape))
853 CHECK_NUMBER (Vx_mode_pointer_shape);
854 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
856 else
857 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
858 x_check_errors (dpy, "bad modeline pointer cursor: %s");
860 if (!NILP (Vx_sensitive_text_pointer_shape))
862 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
863 hand_cursor
864 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
866 else
867 hand_cursor = XCreateFontCursor (dpy, XC_hand2);
869 if (!NILP (Vx_window_horizontal_drag_shape))
871 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
872 horizontal_drag_cursor
873 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
875 else
876 horizontal_drag_cursor
877 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
879 /* Check and report errors with the above calls. */
880 x_check_errors (dpy, "can't set cursor shape: %s");
881 x_uncatch_errors ();
884 XColor fore_color, back_color;
886 fore_color.pixel = x->mouse_pixel;
887 x_query_color (f, &fore_color);
888 back_color.pixel = mask_color;
889 x_query_color (f, &back_color);
891 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
892 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
893 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
894 XRecolorCursor (dpy, hand_cursor, &fore_color, &back_color);
895 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
896 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
899 if (FRAME_X_WINDOW (f) != 0)
900 XDefineCursor (dpy, FRAME_X_WINDOW (f),
901 f->output_data.x->current_cursor = cursor);
903 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor == 0)
904 FRAME_X_DISPLAY_INFO (f)->invisible_cursor = make_invisible_cursor (f);
906 if (cursor != x->text_cursor
907 && x->text_cursor != 0)
908 XFreeCursor (dpy, x->text_cursor);
909 x->text_cursor = cursor;
911 if (nontext_cursor != x->nontext_cursor
912 && x->nontext_cursor != 0)
913 XFreeCursor (dpy, x->nontext_cursor);
914 x->nontext_cursor = nontext_cursor;
916 if (hourglass_cursor != x->hourglass_cursor
917 && x->hourglass_cursor != 0)
918 XFreeCursor (dpy, x->hourglass_cursor);
919 x->hourglass_cursor = hourglass_cursor;
921 if (mode_cursor != x->modeline_cursor
922 && x->modeline_cursor != 0)
923 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
924 x->modeline_cursor = mode_cursor;
926 if (hand_cursor != x->hand_cursor
927 && x->hand_cursor != 0)
928 XFreeCursor (dpy, x->hand_cursor);
929 x->hand_cursor = hand_cursor;
931 if (horizontal_drag_cursor != x->horizontal_drag_cursor
932 && x->horizontal_drag_cursor != 0)
933 XFreeCursor (dpy, x->horizontal_drag_cursor);
934 x->horizontal_drag_cursor = horizontal_drag_cursor;
936 XFlush (dpy);
937 unblock_input ();
939 update_face_from_frame_parameter (f, Qmouse_color, arg);
942 static void
943 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
945 unsigned long fore_pixel, pixel;
946 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
947 struct x_output *x = f->output_data.x;
949 if (!NILP (Vx_cursor_fore_pixel))
951 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
952 WHITE_PIX_DEFAULT (f));
953 fore_pixel_allocated_p = 1;
955 else
956 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
958 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
959 pixel_allocated_p = 1;
961 /* Make sure that the cursor color differs from the background color. */
962 if (pixel == FRAME_BACKGROUND_PIXEL (f))
964 if (pixel_allocated_p)
966 x_free_colors (f, &pixel, 1);
967 pixel_allocated_p = 0;
970 pixel = x->mouse_pixel;
971 if (pixel == fore_pixel)
973 if (fore_pixel_allocated_p)
975 x_free_colors (f, &fore_pixel, 1);
976 fore_pixel_allocated_p = 0;
978 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
982 unload_color (f, x->cursor_foreground_pixel);
983 if (!fore_pixel_allocated_p)
984 fore_pixel = x_copy_color (f, fore_pixel);
985 x->cursor_foreground_pixel = fore_pixel;
987 unload_color (f, x->cursor_pixel);
988 if (!pixel_allocated_p)
989 pixel = x_copy_color (f, pixel);
990 x->cursor_pixel = pixel;
992 if (FRAME_X_WINDOW (f) != 0)
994 block_input ();
995 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
996 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
997 unblock_input ();
999 if (FRAME_VISIBLE_P (f))
1001 x_update_cursor (f, 0);
1002 x_update_cursor (f, 1);
1006 update_face_from_frame_parameter (f, Qcursor_color, arg);
1009 /* Set the border-color of frame F to pixel value PIX.
1010 Note that this does not fully take effect if done before
1011 F has an x-window. */
1013 static void
1014 x_set_border_pixel (struct frame *f, int pix)
1016 unload_color (f, f->output_data.x->border_pixel);
1017 f->output_data.x->border_pixel = pix;
1019 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
1021 block_input ();
1022 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), pix);
1023 unblock_input ();
1025 if (FRAME_VISIBLE_P (f))
1026 redraw_frame (f);
1030 /* Set the border-color of frame F to value described by ARG.
1031 ARG can be a string naming a color.
1032 The border-color is used for the border that is drawn by the X server.
1033 Note that this does not fully take effect if done before
1034 F has an x-window; it must be redone when the window is created.
1036 Note: this is done in two routines because of the way X10 works.
1038 Note: under X11, this is normally the province of the window manager,
1039 and so emacs' border colors may be overridden. */
1041 static void
1042 x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1044 int pix;
1046 CHECK_STRING (arg);
1047 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1048 x_set_border_pixel (f, pix);
1049 update_face_from_frame_parameter (f, Qborder_color, arg);
1053 static void
1054 x_set_cursor_type (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1056 set_frame_cursor_types (f, arg);
1058 /* Make sure the cursor gets redrawn. */
1059 cursor_type_changed = 1;
1062 static void
1063 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1065 int result;
1067 if (STRINGP (arg))
1069 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1070 return;
1072 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1073 return;
1075 block_input ();
1076 if (NILP (arg))
1077 result = x_text_icon (f,
1078 SSDATA ((!NILP (f->icon_name)
1079 ? f->icon_name
1080 : f->name)));
1081 else
1082 result = x_bitmap_icon (f, arg);
1084 if (result)
1086 unblock_input ();
1087 error ("No icon window available");
1090 XFlush (FRAME_X_DISPLAY (f));
1091 unblock_input ();
1094 static void
1095 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1097 int result;
1099 if (STRINGP (arg))
1101 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1102 return;
1104 else if (!NILP (arg) || NILP (oldval))
1105 return;
1107 fset_icon_name (f, arg);
1109 if (f->output_data.x->icon_bitmap != 0)
1110 return;
1112 block_input ();
1114 result = x_text_icon (f,
1115 SSDATA ((!NILP (f->icon_name)
1116 ? f->icon_name
1117 : !NILP (f->title)
1118 ? f->title
1119 : f->name)));
1121 if (result)
1123 unblock_input ();
1124 error ("No icon window available");
1127 XFlush (FRAME_X_DISPLAY (f));
1128 unblock_input ();
1132 void
1133 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1135 int nlines;
1136 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1137 int olines = FRAME_MENU_BAR_LINES (f);
1138 #endif
1140 /* Right now, menu bars don't work properly in minibuf-only frames;
1141 most of the commands try to apply themselves to the minibuffer
1142 frame itself, and get an error because you can't switch buffers
1143 in or split the minibuffer window. */
1144 if (FRAME_MINIBUF_ONLY_P (f))
1145 return;
1147 if (TYPE_RANGED_INTEGERP (int, value))
1148 nlines = XINT (value);
1149 else
1150 nlines = 0;
1152 /* Make sure we redisplay all windows in this frame. */
1153 windows_or_buffers_changed++;
1155 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1156 FRAME_MENU_BAR_LINES (f) = 0;
1157 if (nlines)
1159 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1160 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1161 /* Make sure next redisplay shows the menu bar. */
1162 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = 1;
1164 else
1166 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1167 free_frame_menubar (f);
1168 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1169 if (FRAME_X_P (f))
1170 f->output_data.x->menubar_widget = 0;
1172 #else /* not USE_X_TOOLKIT && not USE_GTK */
1173 FRAME_MENU_BAR_LINES (f) = nlines;
1174 resize_frame_windows (f, FRAME_LINES (f), 0);
1176 /* If the menu bar height gets changed, the internal border below
1177 the top margin has to be cleared. Also, if the menu bar gets
1178 larger, the area for the added lines has to be cleared except for
1179 the first menu bar line that is to be drawn later. */
1180 if (nlines != olines)
1182 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1183 int width = FRAME_PIXEL_WIDTH (f);
1184 int y;
1186 /* height can be zero here. */
1187 if (height > 0 && width > 0)
1189 y = FRAME_TOP_MARGIN_HEIGHT (f);
1191 block_input ();
1192 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1193 0, y, width, height, False);
1194 unblock_input ();
1197 if (nlines > 1 && nlines > olines)
1199 y = (olines == 0 ? 1 : olines) * FRAME_LINE_HEIGHT (f);
1200 height = nlines * FRAME_LINE_HEIGHT (f) - y;
1202 block_input ();
1203 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1204 0, y, width, height, False);
1205 unblock_input ();
1208 if (nlines == 0 && WINDOWP (f->menu_bar_window))
1209 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1211 #endif /* not USE_X_TOOLKIT && not USE_GTK */
1212 adjust_glyphs (f);
1213 run_window_configuration_change_hook (f);
1217 /* Set the number of lines used for the tool bar of frame F to VALUE.
1218 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1219 is the old number of tool bar lines. This function changes the
1220 height of all windows on frame F to match the new tool bar height.
1221 The frame's height doesn't change. */
1223 void
1224 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1226 int delta, nlines, root_height;
1227 Lisp_Object root_window;
1229 /* Treat tool bars like menu bars. */
1230 if (FRAME_MINIBUF_ONLY_P (f))
1231 return;
1233 /* Use VALUE only if an int >= 0. */
1234 if (RANGED_INTEGERP (0, value, INT_MAX))
1235 nlines = XFASTINT (value);
1236 else
1237 nlines = 0;
1239 #ifdef USE_GTK
1240 FRAME_TOOL_BAR_LINES (f) = 0;
1241 if (nlines)
1243 FRAME_EXTERNAL_TOOL_BAR (f) = 1;
1244 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1245 /* Make sure next redisplay shows the tool bar. */
1246 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = 1;
1247 update_frame_tool_bar (f);
1249 else
1251 if (FRAME_EXTERNAL_TOOL_BAR (f))
1252 free_frame_tool_bar (f);
1253 FRAME_EXTERNAL_TOOL_BAR (f) = 0;
1256 return;
1257 #endif
1259 /* Make sure we redisplay all windows in this frame. */
1260 ++windows_or_buffers_changed;
1262 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1264 /* Don't resize the tool-bar to more than we have room for. */
1265 root_window = FRAME_ROOT_WINDOW (f);
1266 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1267 if (root_height - delta < 1)
1269 delta = root_height - 1;
1270 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1273 FRAME_TOOL_BAR_LINES (f) = nlines;
1274 resize_frame_windows (f, FRAME_LINES (f), 0);
1275 adjust_glyphs (f);
1277 /* We also have to make sure that the internal border at the top of
1278 the frame, below the menu bar or tool bar, is redrawn when the
1279 tool bar disappears. This is so because the internal border is
1280 below the tool bar if one is displayed, but is below the menu bar
1281 if there isn't a tool bar. The tool bar draws into the area
1282 below the menu bar. */
1283 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1285 clear_frame (f);
1286 clear_current_matrices (f);
1289 /* If the tool bar gets smaller, the internal border below it
1290 has to be cleared. It was formerly part of the display
1291 of the larger tool bar, and updating windows won't clear it. */
1292 if (delta < 0)
1294 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1295 int width = FRAME_PIXEL_WIDTH (f);
1296 int y = (FRAME_MENU_BAR_LINES (f) + nlines) * FRAME_LINE_HEIGHT (f);
1298 /* height can be zero here. */
1299 if (height > 0 && width > 0)
1301 block_input ();
1302 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1303 0, y, width, height, False);
1304 unblock_input ();
1307 if (WINDOWP (f->tool_bar_window))
1308 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1311 run_window_configuration_change_hook (f);
1316 /* Set the foreground color for scroll bars on frame F to VALUE.
1317 VALUE should be a string, a color name. If it isn't a string or
1318 isn't a valid color name, do nothing. OLDVAL is the old value of
1319 the frame parameter. */
1321 static void
1322 x_set_scroll_bar_foreground (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1324 unsigned long pixel;
1326 if (STRINGP (value))
1327 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1328 else
1329 pixel = -1;
1331 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1332 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1334 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1335 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1337 /* Remove all scroll bars because they have wrong colors. */
1338 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1339 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1340 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1341 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1343 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1344 redraw_frame (f);
1349 /* Set the background color for scroll bars on frame F to VALUE VALUE
1350 should be a string, a color name. If it isn't a string or isn't a
1351 valid color name, do nothing. OLDVAL is the old value of the frame
1352 parameter. */
1354 static void
1355 x_set_scroll_bar_background (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1357 unsigned long pixel;
1359 if (STRINGP (value))
1360 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1361 else
1362 pixel = -1;
1364 if (f->output_data.x->scroll_bar_background_pixel != -1)
1365 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1367 #ifdef USE_TOOLKIT_SCROLL_BARS
1368 /* Scrollbar shadow colors. */
1369 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1371 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1372 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1374 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1376 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1377 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1379 #endif /* USE_TOOLKIT_SCROLL_BARS */
1381 f->output_data.x->scroll_bar_background_pixel = pixel;
1382 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1384 /* Remove all scroll bars because they have wrong colors. */
1385 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1386 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1387 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1388 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1390 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1391 redraw_frame (f);
1396 /* Encode Lisp string STRING as a text in a format appropriate for
1397 XICCC (X Inter Client Communication Conventions).
1399 This can call Lisp code, so callers must GCPRO.
1401 If STRING contains only ASCII characters, do no conversion and
1402 return the string data of STRING. Otherwise, encode the text by
1403 CODING_SYSTEM, and return a newly allocated memory area which
1404 should be freed by `xfree' by a caller.
1406 SELECTIONP non-zero means the string is being encoded for an X
1407 selection, so it is safe to run pre-write conversions (which
1408 may run Lisp code).
1410 Store the byte length of resulting text in *TEXT_BYTES.
1412 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1413 which means that the `encoding' of the result can be `STRING'.
1414 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1415 the result should be `COMPOUND_TEXT'. */
1417 static unsigned char *
1418 x_encode_text (Lisp_Object string, Lisp_Object coding_system, int selectionp,
1419 ptrdiff_t *text_bytes, int *stringp, int *freep)
1421 int result = string_xstring_p (string);
1422 struct coding_system coding;
1424 if (result == 0)
1426 /* No multibyte character in OBJ. We need not encode it. */
1427 *text_bytes = SBYTES (string);
1428 *stringp = 1;
1429 *freep = 0;
1430 return SDATA (string);
1433 setup_coding_system (coding_system, &coding);
1434 coding.mode |= (CODING_MODE_SAFE_ENCODING | CODING_MODE_LAST_BLOCK);
1435 /* We suppress producing escape sequences for composition. */
1436 coding.common_flags &= ~CODING_ANNOTATION_MASK;
1437 coding.destination = xnmalloc (SCHARS (string), 2);
1438 coding.dst_bytes = SCHARS (string) * 2;
1439 encode_coding_object (&coding, string, 0, 0,
1440 SCHARS (string), SBYTES (string), Qnil);
1441 *text_bytes = coding.produced;
1442 *stringp = (result == 1 || !EQ (coding_system, Qcompound_text));
1443 *freep = 1;
1444 return coding.destination;
1448 /* Set the WM name to NAME for frame F. Also set the icon name.
1449 If the frame already has an icon name, use that, otherwise set the
1450 icon name to NAME. */
1452 static void
1453 x_set_name_internal (FRAME_PTR f, Lisp_Object name)
1455 if (FRAME_X_WINDOW (f))
1457 block_input ();
1459 XTextProperty text, icon;
1460 ptrdiff_t bytes;
1461 int stringp;
1462 int do_free_icon_value = 0, do_free_text_value = 0;
1463 Lisp_Object coding_system;
1464 Lisp_Object encoded_name;
1465 Lisp_Object encoded_icon_name;
1466 struct gcpro gcpro1;
1468 /* As ENCODE_UTF_8 may cause GC and relocation of string data,
1469 we use it before x_encode_text that may return string data. */
1470 GCPRO1 (name);
1471 encoded_name = ENCODE_UTF_8 (name);
1472 UNGCPRO;
1474 coding_system = Qcompound_text;
1475 /* Note: Encoding strategy
1477 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1478 text.encoding. But, there are non-internationalized window
1479 managers which don't support that encoding. So, if NAME
1480 contains only ASCII and 8859-1 characters, encode it by
1481 iso-latin-1, and use "STRING" in text.encoding hoping that
1482 such window managers at least analyze this format correctly,
1483 i.e. treat 8-bit bytes as 8859-1 characters.
1485 We may also be able to use "UTF8_STRING" in text.encoding
1486 in the future which can encode all Unicode characters.
1487 But, for the moment, there's no way to know that the
1488 current window manager supports it or not.
1490 Either way, we also set the _NET_WM_NAME and _NET_WM_ICON_NAME
1491 properties. Per the EWMH specification, those two properties
1492 are always UTF8_STRING. This matches what gtk_window_set_title()
1493 does in the USE_GTK case. */
1494 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1495 &do_free_text_value);
1496 text.encoding = (stringp ? XA_STRING
1497 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1498 text.format = 8;
1499 text.nitems = bytes;
1500 if (text.nitems != bytes)
1501 error ("Window name too large");
1503 if (!STRINGP (f->icon_name))
1505 icon = text;
1506 encoded_icon_name = encoded_name;
1508 else
1510 /* See the above comment "Note: Encoding strategy". */
1511 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1512 &bytes, &stringp, &do_free_icon_value);
1513 icon.encoding = (stringp ? XA_STRING
1514 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1515 icon.format = 8;
1516 icon.nitems = bytes;
1517 if (icon.nitems != bytes)
1518 error ("Icon name too large");
1520 encoded_icon_name = ENCODE_UTF_8 (f->icon_name);
1523 #ifdef USE_GTK
1524 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1525 SSDATA (encoded_name));
1526 #else /* not USE_GTK */
1527 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1528 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1529 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_name,
1530 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1531 8, PropModeReplace,
1532 SDATA (encoded_name),
1533 SBYTES (encoded_name));
1534 #endif /* not USE_GTK */
1536 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1537 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1538 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_icon_name,
1539 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1540 8, PropModeReplace,
1541 SDATA (encoded_icon_name),
1542 SBYTES (encoded_icon_name));
1544 if (do_free_icon_value)
1545 xfree (icon.value);
1546 if (do_free_text_value)
1547 xfree (text.value);
1549 unblock_input ();
1553 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1554 x_id_name.
1556 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1557 name; if NAME is a string, set F's name to NAME and set
1558 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1560 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1561 suggesting a new name, which lisp code should override; if
1562 F->explicit_name is set, ignore the new name; otherwise, set it. */
1564 static void
1565 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1567 /* Make sure that requests from lisp code override requests from
1568 Emacs redisplay code. */
1569 if (explicit)
1571 /* If we're switching from explicit to implicit, we had better
1572 update the mode lines and thereby update the title. */
1573 if (f->explicit_name && NILP (name))
1574 update_mode_lines = 1;
1576 f->explicit_name = ! NILP (name);
1578 else if (f->explicit_name)
1579 return;
1581 /* If NAME is nil, set the name to the x_id_name. */
1582 if (NILP (name))
1584 /* Check for no change needed in this very common case
1585 before we do any consing. */
1586 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
1587 SSDATA (f->name)))
1588 return;
1589 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
1591 else
1592 CHECK_STRING (name);
1594 /* Don't change the name if it's already NAME. */
1595 if (! NILP (Fstring_equal (name, f->name)))
1596 return;
1598 fset_name (f, name);
1600 /* For setting the frame title, the title parameter should override
1601 the name parameter. */
1602 if (! NILP (f->title))
1603 name = f->title;
1605 x_set_name_internal (f, name);
1608 /* This function should be called when the user's lisp code has
1609 specified a name for the frame; the name will override any set by the
1610 redisplay code. */
1611 static void
1612 x_explicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1614 x_set_name (f, arg, 1);
1617 /* This function should be called by Emacs redisplay code to set the
1618 name; names set this way will never override names set by the user's
1619 lisp code. */
1620 void
1621 x_implicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1623 x_set_name (f, arg, 0);
1626 /* Change the title of frame F to NAME.
1627 If NAME is nil, use the frame name as the title. */
1629 static void
1630 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1632 /* Don't change the title if it's already NAME. */
1633 if (EQ (name, f->title))
1634 return;
1636 update_mode_lines = 1;
1638 fset_title (f, name);
1640 if (NILP (name))
1641 name = f->name;
1642 else
1643 CHECK_STRING (name);
1645 x_set_name_internal (f, name);
1648 void
1649 x_set_scroll_bar_default_width (struct frame *f)
1651 int wid = FRAME_COLUMN_WIDTH (f);
1652 #ifdef USE_TOOLKIT_SCROLL_BARS
1653 #ifdef USE_GTK
1654 int minw = xg_get_default_scrollbar_width ();
1655 #else
1656 int minw = 16;
1657 #endif
1658 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1659 int width = minw + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
1660 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
1661 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = width;
1662 #else
1663 /* Make the actual width at least 14 pixels and a multiple of a
1664 character width. */
1665 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
1667 /* Use all of that space (aside from required margins) for the
1668 scroll bar. */
1669 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = 0;
1670 #endif
1674 /* Record in frame F the specified or default value according to ALIST
1675 of the parameter named PROP (a Lisp symbol). If no value is
1676 specified for PROP, look for an X default for XPROP on the frame
1677 named NAME. If that is not found either, use the value DEFLT. */
1679 static Lisp_Object
1680 x_default_scroll_bar_color_parameter (struct frame *f,
1681 Lisp_Object alist, Lisp_Object prop,
1682 const char *xprop, const char *xclass,
1683 int foreground_p)
1685 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1686 Lisp_Object tem;
1688 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1689 if (EQ (tem, Qunbound))
1691 #ifdef USE_TOOLKIT_SCROLL_BARS
1693 /* See if an X resource for the scroll bar color has been
1694 specified. */
1695 tem = display_x_get_resource (dpyinfo,
1696 build_string (foreground_p
1697 ? "foreground"
1698 : "background"),
1699 empty_unibyte_string,
1700 build_string ("verticalScrollBar"),
1701 empty_unibyte_string);
1702 if (!STRINGP (tem))
1704 /* If nothing has been specified, scroll bars will use a
1705 toolkit-dependent default. Because these defaults are
1706 difficult to get at without actually creating a scroll
1707 bar, use nil to indicate that no color has been
1708 specified. */
1709 tem = Qnil;
1712 #else /* not USE_TOOLKIT_SCROLL_BARS */
1714 tem = Qnil;
1716 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1719 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
1720 return tem;
1726 #ifdef USE_X_TOOLKIT
1728 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1729 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1730 already be present because of the toolkit (Motif adds some of them,
1731 for example, but Xt doesn't). */
1733 static void
1734 hack_wm_protocols (FRAME_PTR f, Widget widget)
1736 Display *dpy = XtDisplay (widget);
1737 Window w = XtWindow (widget);
1738 int need_delete = 1;
1739 int need_focus = 1;
1740 int need_save = 1;
1742 block_input ();
1744 Atom type;
1745 unsigned char *catoms;
1746 int format = 0;
1747 unsigned long nitems = 0;
1748 unsigned long bytes_after;
1750 if ((XGetWindowProperty (dpy, w,
1751 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1752 (long)0, (long)100, False, XA_ATOM,
1753 &type, &format, &nitems, &bytes_after,
1754 &catoms)
1755 == Success)
1756 && format == 32 && type == XA_ATOM)
1758 Atom *atoms = (Atom *) catoms;
1759 while (nitems > 0)
1761 nitems--;
1762 if (atoms[nitems]
1763 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1764 need_delete = 0;
1765 else if (atoms[nitems]
1766 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1767 need_focus = 0;
1768 else if (atoms[nitems]
1769 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1770 need_save = 0;
1773 if (catoms)
1774 XFree (catoms);
1777 Atom props [10];
1778 int count = 0;
1779 if (need_delete)
1780 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1781 if (need_focus)
1782 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1783 if (need_save)
1784 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1785 if (count)
1786 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1787 XA_ATOM, 32, PropModeAppend,
1788 (unsigned char *) props, count);
1790 unblock_input ();
1792 #endif
1796 /* Support routines for XIC (X Input Context). */
1798 #ifdef HAVE_X_I18N
1800 static XFontSet xic_create_xfontset (struct frame *);
1801 static XIMStyle best_xim_style (XIMStyles *, XIMStyles *);
1804 /* Supported XIM styles, ordered by preference. */
1806 static XIMStyle supported_xim_styles[] =
1808 XIMPreeditPosition | XIMStatusArea,
1809 XIMPreeditPosition | XIMStatusNothing,
1810 XIMPreeditPosition | XIMStatusNone,
1811 XIMPreeditNothing | XIMStatusArea,
1812 XIMPreeditNothing | XIMStatusNothing,
1813 XIMPreeditNothing | XIMStatusNone,
1814 XIMPreeditNone | XIMStatusArea,
1815 XIMPreeditNone | XIMStatusNothing,
1816 XIMPreeditNone | XIMStatusNone,
1821 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1822 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1824 static const char xic_default_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1826 /* Create an Xt fontset spec from the name of a base font.
1827 If `motif' is True use the Motif syntax. */
1828 char *
1829 xic_create_fontsetname (const char *base_fontname, int motif)
1831 const char *sep = motif ? ";" : ",";
1832 char *fontsetname;
1834 /* Make a fontset name from the base font name. */
1835 if (xic_default_fontset == base_fontname)
1837 /* There is no base font name, use the default. */
1838 fontsetname = xmalloc (strlen (base_fontname) + 2);
1839 strcpy (fontsetname, base_fontname);
1841 else
1843 /* Make a fontset name from the base font name.
1844 The font set will be made of the following elements:
1845 - the base font.
1846 - the base font where the charset spec is replaced by -*-*.
1847 - the same but with the family also replaced with -*-*-. */
1848 const char *p = base_fontname;
1849 ptrdiff_t i;
1851 for (i = 0; *p; p++)
1852 if (*p == '-') i++;
1853 if (i != 14)
1855 /* As the font name doesn't conform to XLFD, we can't
1856 modify it to generalize it to allcs and allfamilies.
1857 Use the specified font plus the default. */
1858 fontsetname = xmalloc (strlen (base_fontname)
1859 + strlen (xic_default_fontset) + 3);
1860 strcpy (fontsetname, base_fontname);
1861 strcat (fontsetname, sep);
1862 strcat (fontsetname, xic_default_fontset);
1864 else
1866 ptrdiff_t len;
1867 const char *p1 = NULL, *p2 = NULL, *p3 = NULL;
1868 char *font_allcs = NULL;
1869 char *font_allfamilies = NULL;
1870 char *font_all = NULL;
1871 const char *allcs = "*-*-*-*-*-*-*";
1872 const char *allfamilies = "-*-*-";
1873 const char *all = "*-*-*-*-";
1874 char *base;
1876 for (i = 0, p = base_fontname; i < 8; p++)
1878 if (*p == '-')
1880 i++;
1881 if (i == 3)
1882 p1 = p + 1;
1883 else if (i == 7)
1884 p2 = p + 1;
1885 else if (i == 6)
1886 p3 = p + 1;
1889 /* If base_fontname specifies ADSTYLE, make it a
1890 wildcard. */
1891 if (*p3 != '*')
1893 ptrdiff_t diff = (p2 - p3) - 2;
1895 base = alloca (strlen (base_fontname) + 1);
1896 memcpy (base, base_fontname, p3 - base_fontname);
1897 base[p3 - base_fontname] = '*';
1898 base[(p3 - base_fontname) + 1] = '-';
1899 strcpy (base + (p3 - base_fontname) + 2, p2);
1900 p = base + (p - base_fontname) - diff;
1901 p1 = base + (p1 - base_fontname);
1902 p2 = base + (p2 - base_fontname) - diff;
1903 base_fontname = base;
1906 /* Build the font spec that matches all charsets. */
1907 len = p - base_fontname + strlen (allcs) + 1;
1908 font_allcs = alloca (len);
1909 memcpy (font_allcs, base_fontname, p - base_fontname);
1910 strcat (font_allcs, allcs);
1912 /* Build the font spec that matches all families and
1913 add-styles. */
1914 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
1915 font_allfamilies = alloca (len);
1916 strcpy (font_allfamilies, allfamilies);
1917 memcpy (font_allfamilies + strlen (allfamilies), p1, p - p1);
1918 strcat (font_allfamilies, allcs);
1920 /* Build the font spec that matches all. */
1921 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
1922 font_all = alloca (len);
1923 strcpy (font_all, allfamilies);
1924 strcat (font_all, all);
1925 memcpy (font_all + strlen (all) + strlen (allfamilies), p2, p - p2);
1926 strcat (font_all, allcs);
1928 /* Build the actual font set name. */
1929 len = strlen (base_fontname) + strlen (font_allcs)
1930 + strlen (font_allfamilies) + strlen (font_all) + 5;
1931 fontsetname = xmalloc (len);
1932 strcpy (fontsetname, base_fontname);
1933 strcat (fontsetname, sep);
1934 strcat (fontsetname, font_allcs);
1935 strcat (fontsetname, sep);
1936 strcat (fontsetname, font_allfamilies);
1937 strcat (fontsetname, sep);
1938 strcat (fontsetname, font_all);
1941 if (motif)
1942 strcat (fontsetname, ":");
1943 return fontsetname;
1945 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
1947 #ifdef DEBUG_XIC_FONTSET
1948 static void
1949 print_fontset_result (XFontSet xfs, char *name, char **missing_list,
1950 int missing_count)
1952 if (xfs)
1953 fprintf (stderr, "XIC Fontset created: %s\n", name);
1954 else
1956 fprintf (stderr, "XIC Fontset failed: %s\n", name);
1957 while (missing_count-- > 0)
1959 fprintf (stderr, " missing: %s\n", *missing_list);
1960 missing_list++;
1965 #endif
1967 static XFontSet
1968 xic_create_xfontset (struct frame *f)
1970 XFontSet xfs = NULL;
1971 struct font *font = FRAME_FONT (f);
1972 int pixel_size = font->pixel_size;
1973 Lisp_Object rest, frame;
1975 /* See if there is another frame already using same fontset. */
1976 FOR_EACH_FRAME (rest, frame)
1978 struct frame *cf = XFRAME (frame);
1980 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
1981 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
1982 && FRAME_FONT (f)
1983 && FRAME_FONT (f)->pixel_size == pixel_size)
1985 xfs = FRAME_XIC_FONTSET (cf);
1986 break;
1990 if (! xfs)
1992 char buf[256];
1993 char **missing_list;
1994 int missing_count;
1995 char *def_string;
1996 const char *xlfd_format = "-*-*-medium-r-normal--%d-*-*-*-*-*";
1998 sprintf (buf, xlfd_format, pixel_size);
1999 missing_list = NULL;
2000 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2001 &missing_list, &missing_count, &def_string);
2002 #ifdef DEBUG_XIC_FONTSET
2003 print_fontset_result (xfs, buf, missing_list, missing_count);
2004 #endif
2005 if (missing_list)
2006 XFreeStringList (missing_list);
2007 if (! xfs)
2009 /* List of pixel sizes most likely available. Find one that
2010 is closest to pixel_size. */
2011 int sizes[] = {0, 8, 10, 11, 12, 14, 17, 18, 20, 24, 26, 34, 0};
2012 int *smaller, *larger;
2014 for (smaller = sizes; smaller[1]; smaller++)
2015 if (smaller[1] >= pixel_size)
2016 break;
2017 larger = smaller + 1;
2018 if (*larger == pixel_size)
2019 larger++;
2020 while (*smaller || *larger)
2022 int this_size;
2024 if (! *larger)
2025 this_size = *smaller--;
2026 else if (! *smaller)
2027 this_size = *larger++;
2028 else if (pixel_size - *smaller < *larger - pixel_size)
2029 this_size = *smaller--;
2030 else
2031 this_size = *larger++;
2032 sprintf (buf, xlfd_format, this_size);
2033 missing_list = NULL;
2034 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2035 &missing_list, &missing_count, &def_string);
2036 #ifdef DEBUG_XIC_FONTSET
2037 print_fontset_result (xfs, buf, missing_list, missing_count);
2038 #endif
2039 if (missing_list)
2040 XFreeStringList (missing_list);
2041 if (xfs)
2042 break;
2045 if (! xfs)
2047 const char *last_resort = "-*-*-*-r-normal--*-*-*-*-*-*";
2049 missing_list = NULL;
2050 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), last_resort,
2051 &missing_list, &missing_count, &def_string);
2052 #ifdef DEBUG_XIC_FONTSET
2053 print_fontset_result (xfs, last_resort, missing_list, missing_count);
2054 #endif
2055 if (missing_list)
2056 XFreeStringList (missing_list);
2061 return xfs;
2064 /* Free the X fontset of frame F if it is the last frame using it. */
2066 void
2067 xic_free_xfontset (struct frame *f)
2069 Lisp_Object rest, frame;
2070 int shared_p = 0;
2072 if (!FRAME_XIC_FONTSET (f))
2073 return;
2075 /* See if there is another frame sharing the same fontset. */
2076 FOR_EACH_FRAME (rest, frame)
2078 struct frame *cf = XFRAME (frame);
2079 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2080 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2081 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2083 shared_p = 1;
2084 break;
2088 if (!shared_p)
2089 /* The fontset is not used anymore. It is safe to free it. */
2090 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2092 if (FRAME_XIC_BASE_FONTNAME (f))
2093 xfree (FRAME_XIC_BASE_FONTNAME (f));
2094 FRAME_XIC_BASE_FONTNAME (f) = NULL;
2095 FRAME_XIC_FONTSET (f) = NULL;
2099 /* Value is the best input style, given user preferences USER (already
2100 checked to be supported by Emacs), and styles supported by the
2101 input method XIM. */
2103 static XIMStyle
2104 best_xim_style (XIMStyles *user, XIMStyles *xim)
2106 int i, j;
2108 for (i = 0; i < user->count_styles; ++i)
2109 for (j = 0; j < xim->count_styles; ++j)
2110 if (user->supported_styles[i] == xim->supported_styles[j])
2111 return user->supported_styles[i];
2113 /* Return the default style. */
2114 return XIMPreeditNothing | XIMStatusNothing;
2117 /* Create XIC for frame F. */
2119 static XIMStyle xic_style;
2121 void
2122 create_frame_xic (struct frame *f)
2124 XIM xim;
2125 XIC xic = NULL;
2126 XFontSet xfs = NULL;
2128 if (FRAME_XIC (f))
2129 return;
2131 /* Create X fontset. */
2132 xfs = xic_create_xfontset (f);
2133 xim = FRAME_X_XIM (f);
2134 if (xim)
2136 XRectangle s_area;
2137 XPoint spot;
2138 XVaNestedList preedit_attr;
2139 XVaNestedList status_attr;
2141 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2142 spot.x = 0; spot.y = 1;
2144 /* Determine XIC style. */
2145 if (xic_style == 0)
2147 XIMStyles supported_list;
2148 supported_list.count_styles = (sizeof supported_xim_styles
2149 / sizeof supported_xim_styles[0]);
2150 supported_list.supported_styles = supported_xim_styles;
2151 xic_style = best_xim_style (&supported_list,
2152 FRAME_X_XIM_STYLES (f));
2155 preedit_attr = XVaCreateNestedList (0,
2156 XNFontSet, xfs,
2157 XNForeground,
2158 FRAME_FOREGROUND_PIXEL (f),
2159 XNBackground,
2160 FRAME_BACKGROUND_PIXEL (f),
2161 (xic_style & XIMPreeditPosition
2162 ? XNSpotLocation
2163 : NULL),
2164 &spot,
2165 NULL);
2166 status_attr = XVaCreateNestedList (0,
2167 XNArea,
2168 &s_area,
2169 XNFontSet,
2170 xfs,
2171 XNForeground,
2172 FRAME_FOREGROUND_PIXEL (f),
2173 XNBackground,
2174 FRAME_BACKGROUND_PIXEL (f),
2175 NULL);
2177 xic = XCreateIC (xim,
2178 XNInputStyle, xic_style,
2179 XNClientWindow, FRAME_X_WINDOW (f),
2180 XNFocusWindow, FRAME_X_WINDOW (f),
2181 XNStatusAttributes, status_attr,
2182 XNPreeditAttributes, preedit_attr,
2183 NULL);
2184 XFree (preedit_attr);
2185 XFree (status_attr);
2188 FRAME_XIC (f) = xic;
2189 FRAME_XIC_STYLE (f) = xic_style;
2190 FRAME_XIC_FONTSET (f) = xfs;
2194 /* Destroy XIC and free XIC fontset of frame F, if any. */
2196 void
2197 free_frame_xic (struct frame *f)
2199 if (FRAME_XIC (f) == NULL)
2200 return;
2202 XDestroyIC (FRAME_XIC (f));
2203 xic_free_xfontset (f);
2205 FRAME_XIC (f) = NULL;
2209 /* Place preedit area for XIC of window W's frame to specified
2210 pixel position X/Y. X and Y are relative to window W. */
2212 void
2213 xic_set_preeditarea (struct window *w, int x, int y)
2215 struct frame *f = XFRAME (w->frame);
2216 XVaNestedList attr;
2217 XPoint spot;
2219 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2220 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2221 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2222 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2223 XFree (attr);
2227 /* Place status area for XIC in bottom right corner of frame F.. */
2229 void
2230 xic_set_statusarea (struct frame *f)
2232 XIC xic = FRAME_XIC (f);
2233 XVaNestedList attr;
2234 XRectangle area;
2235 XRectangle *needed;
2237 /* Negotiate geometry of status area. If input method has existing
2238 status area, use its current size. */
2239 area.x = area.y = area.width = area.height = 0;
2240 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2241 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2242 XFree (attr);
2244 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2245 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2246 XFree (attr);
2248 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2250 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2251 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2252 XFree (attr);
2255 area.width = needed->width;
2256 area.height = needed->height;
2257 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2258 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2259 - FRAME_MENUBAR_HEIGHT (f)
2260 - FRAME_TOOLBAR_TOP_HEIGHT (f)
2261 - FRAME_INTERNAL_BORDER_WIDTH (f));
2262 XFree (needed);
2264 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2265 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2266 XFree (attr);
2270 /* Set X fontset for XIC of frame F, using base font name
2271 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2273 void
2274 xic_set_xfontset (struct frame *f, const char *base_fontname)
2276 XVaNestedList attr;
2277 XFontSet xfs;
2279 xic_free_xfontset (f);
2281 xfs = xic_create_xfontset (f);
2283 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2284 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2285 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2286 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2287 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2288 XFree (attr);
2290 FRAME_XIC_FONTSET (f) = xfs;
2293 #endif /* HAVE_X_I18N */
2297 #ifdef USE_X_TOOLKIT
2299 /* Create and set up the X widget for frame F. */
2301 static void
2302 x_window (struct frame *f, long window_prompting, int minibuffer_only)
2304 XClassHint class_hints;
2305 XSetWindowAttributes attributes;
2306 unsigned long attribute_mask;
2307 Widget shell_widget;
2308 Widget pane_widget;
2309 Widget frame_widget;
2310 Arg al [25];
2311 int ac;
2313 block_input ();
2315 /* Use the resource name as the top-level widget name
2316 for looking up resources. Make a non-Lisp copy
2317 for the window manager, so GC relocation won't bother it.
2319 Elsewhere we specify the window name for the window manager. */
2322 char *str = SSDATA (Vx_resource_name);
2323 f->namebuf = xmalloc (strlen (str) + 1);
2324 strcpy (f->namebuf, str);
2327 ac = 0;
2328 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2329 XtSetArg (al[ac], XtNinput, 1); ac++;
2330 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2331 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2332 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2333 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2334 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2335 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2336 applicationShellWidgetClass,
2337 FRAME_X_DISPLAY (f), al, ac);
2339 f->output_data.x->widget = shell_widget;
2340 /* maybe_set_screen_title_format (shell_widget); */
2342 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2343 (widget_value *) NULL,
2344 shell_widget, False,
2345 (lw_callback) NULL,
2346 (lw_callback) NULL,
2347 (lw_callback) NULL,
2348 (lw_callback) NULL);
2350 ac = 0;
2351 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2352 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2353 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2354 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2355 XtSetValues (pane_widget, al, ac);
2356 f->output_data.x->column_widget = pane_widget;
2358 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2359 the emacs screen when changing menubar. This reduces flickering. */
2361 ac = 0;
2362 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2363 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2364 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2365 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2366 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2367 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2368 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2369 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2370 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2371 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2372 al, ac);
2374 f->output_data.x->edit_widget = frame_widget;
2376 XtManageChild (frame_widget);
2378 /* Do some needed geometry management. */
2380 char *tem, shell_position[sizeof "=x++" + 4 * INT_STRLEN_BOUND (int)];
2381 Arg gal[10];
2382 int gac = 0;
2383 int extra_borders = 0;
2384 int menubar_size
2385 = (f->output_data.x->menubar_widget
2386 ? (f->output_data.x->menubar_widget->core.height
2387 + f->output_data.x->menubar_widget->core.border_width)
2388 : 0);
2390 #if 0 /* Experimentally, we now get the right results
2391 for -geometry -0-0 without this. 24 Aug 96, rms. */
2392 if (FRAME_EXTERNAL_MENU_BAR (f))
2394 Dimension ibw = 0;
2395 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2396 menubar_size += ibw;
2398 #endif
2400 f->output_data.x->menubar_height = menubar_size;
2402 #ifndef USE_LUCID
2403 /* Motif seems to need this amount added to the sizes
2404 specified for the shell widget. The Athena/Lucid widgets don't.
2405 Both conclusions reached experimentally. -- rms. */
2406 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2407 &extra_borders, NULL);
2408 extra_borders *= 2;
2409 #endif
2411 /* Convert our geometry parameters into a geometry string
2412 and specify it.
2413 Note that we do not specify here whether the position
2414 is a user-specified or program-specified one.
2415 We pass that information later, in x_wm_set_size_hints. */
2417 int left = f->left_pos;
2418 int xneg = window_prompting & XNegative;
2419 int top = f->top_pos;
2420 int yneg = window_prompting & YNegative;
2421 if (xneg)
2422 left = -left;
2423 if (yneg)
2424 top = -top;
2426 if (window_prompting & USPosition)
2427 sprintf (shell_position, "=%dx%d%c%d%c%d",
2428 FRAME_PIXEL_WIDTH (f) + extra_borders,
2429 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2430 (xneg ? '-' : '+'), left,
2431 (yneg ? '-' : '+'), top);
2432 else
2434 sprintf (shell_position, "=%dx%d",
2435 FRAME_PIXEL_WIDTH (f) + extra_borders,
2436 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2438 /* Setting x and y when the position is not specified in
2439 the geometry string will set program position in the WM hints.
2440 If Emacs had just one program position, we could set it in
2441 fallback resources, but since each make-frame call can specify
2442 different program positions, this is easier. */
2443 XtSetArg (gal[gac], XtNx, left); gac++;
2444 XtSetArg (gal[gac], XtNy, top); gac++;
2448 /* We don't free this because we don't know whether
2449 it is safe to free it while the frame exists.
2450 It isn't worth the trouble of arranging to free it
2451 when the frame is deleted. */
2452 tem = xstrdup (shell_position);
2453 XtSetArg (gal[gac], XtNgeometry, tem); gac++;
2454 XtSetValues (shell_widget, gal, gac);
2457 XtManageChild (pane_widget);
2458 XtRealizeWidget (shell_widget);
2460 if (FRAME_X_EMBEDDED_P (f))
2461 XReparentWindow (FRAME_X_DISPLAY (f), XtWindow (shell_widget),
2462 f->output_data.x->parent_desc, 0, 0);
2464 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2466 validate_x_resource_name ();
2468 class_hints.res_name = SSDATA (Vx_resource_name);
2469 class_hints.res_class = SSDATA (Vx_resource_class);
2470 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2472 #ifdef HAVE_X_I18N
2473 FRAME_XIC (f) = NULL;
2474 if (use_xim)
2475 create_frame_xic (f);
2476 #endif
2478 f->output_data.x->wm_hints.input = True;
2479 f->output_data.x->wm_hints.flags |= InputHint;
2480 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2481 &f->output_data.x->wm_hints);
2483 hack_wm_protocols (f, shell_widget);
2485 #ifdef HACK_EDITRES
2486 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2487 #endif
2489 /* Do a stupid property change to force the server to generate a
2490 PropertyNotify event so that the event_stream server timestamp will
2491 be initialized to something relevant to the time we created the window.
2493 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2494 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
2495 XA_ATOM, 32, PropModeAppend,
2496 (unsigned char*) NULL, 0);
2498 /* Make all the standard events reach the Emacs frame. */
2499 attributes.event_mask = STANDARD_EVENT_SET;
2501 #ifdef HAVE_X_I18N
2502 if (FRAME_XIC (f))
2504 /* XIM server might require some X events. */
2505 unsigned long fevent = NoEventMask;
2506 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2507 attributes.event_mask |= fevent;
2509 #endif /* HAVE_X_I18N */
2511 attribute_mask = CWEventMask;
2512 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2513 attribute_mask, &attributes);
2515 XtMapWidget (frame_widget);
2517 /* x_set_name normally ignores requests to set the name if the
2518 requested name is the same as the current name. This is the one
2519 place where that assumption isn't correct; f->name is set, but
2520 the X server hasn't been told. */
2522 Lisp_Object name;
2523 int explicit = f->explicit_name;
2525 f->explicit_name = 0;
2526 name = f->name;
2527 fset_name (f, Qnil);
2528 x_set_name (f, name, explicit);
2531 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2532 f->output_data.x->current_cursor
2533 = f->output_data.x->text_cursor);
2535 unblock_input ();
2537 /* This is a no-op, except under Motif. Make sure main areas are
2538 set to something reasonable, in case we get an error later. */
2539 lw_set_main_areas (pane_widget, 0, frame_widget);
2542 #else /* not USE_X_TOOLKIT */
2543 #ifdef USE_GTK
2544 static void
2545 x_window (FRAME_PTR f)
2547 if (! xg_create_frame_widgets (f))
2548 error ("Unable to create window");
2550 #ifdef HAVE_X_I18N
2551 FRAME_XIC (f) = NULL;
2552 if (use_xim)
2554 block_input ();
2555 create_frame_xic (f);
2556 if (FRAME_XIC (f))
2558 /* XIM server might require some X events. */
2559 unsigned long fevent = NoEventMask;
2560 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2562 if (fevent != NoEventMask)
2564 XSetWindowAttributes attributes;
2565 XWindowAttributes wattr;
2566 unsigned long attribute_mask;
2568 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2569 &wattr);
2570 attributes.event_mask = wattr.your_event_mask | fevent;
2571 attribute_mask = CWEventMask;
2572 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2573 attribute_mask, &attributes);
2576 unblock_input ();
2578 #endif
2581 #else /*! USE_GTK */
2582 /* Create and set up the X window for frame F. */
2584 static void
2585 x_window (struct frame *f)
2587 XClassHint class_hints;
2588 XSetWindowAttributes attributes;
2589 unsigned long attribute_mask;
2591 attributes.background_pixel = FRAME_BACKGROUND_PIXEL (f);
2592 attributes.border_pixel = f->output_data.x->border_pixel;
2593 attributes.bit_gravity = StaticGravity;
2594 attributes.backing_store = NotUseful;
2595 attributes.save_under = True;
2596 attributes.event_mask = STANDARD_EVENT_SET;
2597 attributes.colormap = FRAME_X_COLORMAP (f);
2598 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2599 | CWColormap);
2601 block_input ();
2602 FRAME_X_WINDOW (f)
2603 = XCreateWindow (FRAME_X_DISPLAY (f),
2604 f->output_data.x->parent_desc,
2605 f->left_pos,
2606 f->top_pos,
2607 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2608 f->border_width,
2609 CopyFromParent, /* depth */
2610 InputOutput, /* class */
2611 FRAME_X_VISUAL (f),
2612 attribute_mask, &attributes);
2614 #ifdef HAVE_X_I18N
2615 if (use_xim)
2617 create_frame_xic (f);
2618 if (FRAME_XIC (f))
2620 /* XIM server might require some X events. */
2621 unsigned long fevent = NoEventMask;
2622 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2623 attributes.event_mask |= fevent;
2624 attribute_mask = CWEventMask;
2625 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2626 attribute_mask, &attributes);
2629 #endif /* HAVE_X_I18N */
2631 validate_x_resource_name ();
2633 class_hints.res_name = SSDATA (Vx_resource_name);
2634 class_hints.res_class = SSDATA (Vx_resource_class);
2635 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2637 /* The menubar is part of the ordinary display;
2638 it does not count in addition to the height of the window. */
2639 f->output_data.x->menubar_height = 0;
2641 /* This indicates that we use the "Passive Input" input model.
2642 Unless we do this, we don't get the Focus{In,Out} events that we
2643 need to draw the cursor correctly. Accursed bureaucrats.
2644 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2646 f->output_data.x->wm_hints.input = True;
2647 f->output_data.x->wm_hints.flags |= InputHint;
2648 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2649 &f->output_data.x->wm_hints);
2650 f->output_data.x->wm_hints.icon_pixmap = None;
2652 /* Request "save yourself" and "delete window" commands from wm. */
2654 Atom protocols[2];
2655 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2656 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2657 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2660 /* x_set_name normally ignores requests to set the name if the
2661 requested name is the same as the current name. This is the one
2662 place where that assumption isn't correct; f->name is set, but
2663 the X server hasn't been told. */
2665 Lisp_Object name;
2666 int explicit = f->explicit_name;
2668 f->explicit_name = 0;
2669 name = f->name;
2670 fset_name (f, Qnil);
2671 x_set_name (f, name, explicit);
2674 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2675 f->output_data.x->current_cursor
2676 = f->output_data.x->text_cursor);
2678 unblock_input ();
2680 if (FRAME_X_WINDOW (f) == 0)
2681 error ("Unable to create window");
2684 #endif /* not USE_GTK */
2685 #endif /* not USE_X_TOOLKIT */
2687 /* Verify that the icon position args for this window are valid. */
2689 static void
2690 x_icon_verify (struct frame *f, Lisp_Object parms)
2692 Lisp_Object icon_x, icon_y;
2694 /* Set the position of the icon. Note that twm groups all
2695 icons in an icon window. */
2696 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2697 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2698 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2700 CHECK_NUMBER (icon_x);
2701 CHECK_NUMBER (icon_y);
2703 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2704 error ("Both left and top icon corners of icon must be specified");
2707 /* Handle the icon stuff for this window. Perhaps later we might
2708 want an x_set_icon_position which can be called interactively as
2709 well. */
2711 static void
2712 x_icon (struct frame *f, Lisp_Object parms)
2714 Lisp_Object icon_x, icon_y;
2715 #if 0
2716 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2717 #endif
2719 /* Set the position of the icon. Note that twm groups all
2720 icons in an icon window. */
2721 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2722 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2723 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2725 CHECK_TYPE_RANGED_INTEGER (int, icon_x);
2726 CHECK_TYPE_RANGED_INTEGER (int, icon_y);
2728 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2729 error ("Both left and top icon corners of icon must be specified");
2731 block_input ();
2733 if (! EQ (icon_x, Qunbound))
2734 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2736 #if 0 /* x_get_arg removes the visibility parameter as a side effect,
2737 but x_create_frame still needs it. */
2738 /* Start up iconic or window? */
2739 x_wm_set_window_state
2740 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2741 Qicon)
2742 ? IconicState
2743 : NormalState));
2744 #endif
2746 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
2747 ? f->icon_name
2748 : f->name)));
2750 unblock_input ();
2753 /* Make the GCs needed for this window, setting the
2754 background, border and mouse colors; also create the
2755 mouse cursor and the gray border tile. */
2757 static void
2758 x_make_gc (struct frame *f)
2760 XGCValues gc_values;
2762 block_input ();
2764 /* Create the GCs of this frame.
2765 Note that many default values are used. */
2767 gc_values.foreground = FRAME_FOREGROUND_PIXEL (f);
2768 gc_values.background = FRAME_BACKGROUND_PIXEL (f);
2769 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2770 f->output_data.x->normal_gc
2771 = XCreateGC (FRAME_X_DISPLAY (f),
2772 FRAME_X_WINDOW (f),
2773 GCLineWidth | GCForeground | GCBackground,
2774 &gc_values);
2776 /* Reverse video style. */
2777 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2778 gc_values.background = FRAME_FOREGROUND_PIXEL (f);
2779 f->output_data.x->reverse_gc
2780 = XCreateGC (FRAME_X_DISPLAY (f),
2781 FRAME_X_WINDOW (f),
2782 GCForeground | GCBackground | GCLineWidth,
2783 &gc_values);
2785 /* Cursor has cursor-color background, background-color foreground. */
2786 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2787 gc_values.background = f->output_data.x->cursor_pixel;
2788 gc_values.fill_style = FillOpaqueStippled;
2789 f->output_data.x->cursor_gc
2790 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2791 (GCForeground | GCBackground
2792 | GCFillStyle | GCLineWidth),
2793 &gc_values);
2795 /* Reliefs. */
2796 f->output_data.x->white_relief.gc = 0;
2797 f->output_data.x->black_relief.gc = 0;
2799 /* Create the gray border tile used when the pointer is not in
2800 the frame. Since this depends on the frame's pixel values,
2801 this must be done on a per-frame basis. */
2802 f->output_data.x->border_tile
2803 = (XCreatePixmapFromBitmapData
2804 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
2805 gray_bits, gray_width, gray_height,
2806 FRAME_FOREGROUND_PIXEL (f),
2807 FRAME_BACKGROUND_PIXEL (f),
2808 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2810 unblock_input ();
2814 /* Free what was allocated in x_make_gc. */
2816 void
2817 x_free_gcs (struct frame *f)
2819 Display *dpy = FRAME_X_DISPLAY (f);
2821 block_input ();
2823 if (f->output_data.x->normal_gc)
2825 XFreeGC (dpy, f->output_data.x->normal_gc);
2826 f->output_data.x->normal_gc = 0;
2829 if (f->output_data.x->reverse_gc)
2831 XFreeGC (dpy, f->output_data.x->reverse_gc);
2832 f->output_data.x->reverse_gc = 0;
2835 if (f->output_data.x->cursor_gc)
2837 XFreeGC (dpy, f->output_data.x->cursor_gc);
2838 f->output_data.x->cursor_gc = 0;
2841 if (f->output_data.x->border_tile)
2843 XFreePixmap (dpy, f->output_data.x->border_tile);
2844 f->output_data.x->border_tile = 0;
2847 unblock_input ();
2851 /* Handler for signals raised during x_create_frame and
2852 x_create_tip_frame. FRAME is the frame which is partially
2853 constructed. */
2855 static Lisp_Object
2856 unwind_create_frame (Lisp_Object frame)
2858 struct frame *f = XFRAME (frame);
2860 /* If frame is already dead, nothing to do. This can happen if the
2861 display is disconnected after the frame has become official, but
2862 before x_create_frame removes the unwind protect. */
2863 if (!FRAME_LIVE_P (f))
2864 return Qnil;
2866 /* If frame is ``official'', nothing to do. */
2867 if (NILP (Fmemq (frame, Vframe_list)))
2869 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2870 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2871 #endif
2873 x_free_frame_resources (f);
2874 free_glyphs (f);
2876 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2877 /* Check that reference counts are indeed correct. */
2878 eassert (dpyinfo->reference_count == dpyinfo_refcount);
2879 eassert (dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
2880 #endif
2881 return Qt;
2884 return Qnil;
2887 static Lisp_Object
2888 unwind_create_frame_1 (Lisp_Object val)
2890 inhibit_lisp_code = val;
2891 return Qnil;
2894 static void
2895 x_default_font_parameter (struct frame *f, Lisp_Object parms)
2897 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2898 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
2899 RES_TYPE_STRING);
2900 Lisp_Object font = Qnil;
2901 if (EQ (font_param, Qunbound))
2902 font_param = Qnil;
2904 if (NILP (font_param))
2906 /* System font should take precedence over X resources. We suggest this
2907 regardless of font-use-system-font because .emacs may not have been
2908 read yet. */
2909 const char *system_font = xsettings_get_system_font ();
2910 if (system_font)
2911 font = font_open_by_name (f, build_unibyte_string (system_font));
2914 if (NILP (font))
2915 font = !NILP (font_param) ? font_param
2916 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
2918 if (! FONTP (font) && ! STRINGP (font))
2920 const char *names[]
2922 #ifdef HAVE_XFT
2923 /* This will find the normal Xft font. */
2924 "monospace-10",
2925 #endif
2926 "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1",
2927 "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2928 "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2929 /* This was formerly the first thing tried, but it finds
2930 too many fonts and takes too long. */
2931 "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1",
2932 /* If those didn't work, look for something which will
2933 at least work. */
2934 "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1",
2935 "fixed",
2936 NULL };
2937 int i;
2939 for (i = 0; names[i]; i++)
2941 font = font_open_by_name (f, build_unibyte_string (names[i]));
2942 if (! NILP (font))
2943 break;
2945 if (NILP (font))
2946 error ("No suitable font was found");
2948 else if (!NILP (font_param))
2950 /* Remember the explicit font parameter, so we can re-apply it after
2951 we've applied the `default' face settings. */
2952 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
2955 /* This call will make X resources override any system font setting. */
2956 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
2960 DEFUN ("x-wm-set-size-hint", Fx_wm_set_size_hint, Sx_wm_set_size_hint,
2961 0, 1, 0,
2962 doc: /* Send the size hints for frame FRAME to the window manager.
2963 If FRAME is omitted or nil, use the selected frame.
2964 Signal error if FRAME is not an X frame. */)
2965 (Lisp_Object frame)
2967 struct frame *f = decode_window_system_frame (frame);
2969 block_input ();
2970 x_wm_set_size_hint (f, 0, 0);
2971 unblock_input ();
2972 return Qnil;
2975 static void
2976 set_machine_and_pid_properties (struct frame *f)
2978 long pid = (long) getpid ();
2980 /* This will set WM_CLIENT_MACHINE and WM_LOCALE_NAME. */
2981 XSetWMProperties (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), NULL, NULL,
2982 NULL, 0, NULL, NULL, NULL);
2983 XChangeProperty (FRAME_X_DISPLAY (f),
2984 FRAME_OUTER_WINDOW (f),
2985 XInternAtom (FRAME_X_DISPLAY (f),
2986 "_NET_WM_PID",
2987 False),
2988 XA_CARDINAL, 32, PropModeReplace,
2989 (unsigned char *) &pid, 1);
2992 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
2993 1, 1, 0,
2994 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
2995 Return an Emacs frame object.
2996 PARMS is an alist of frame parameters.
2997 If the parameters specify that the frame should not have a minibuffer,
2998 and do not specify a specific minibuffer window to use,
2999 then `default-minibuffer-frame' must be a frame whose minibuffer can
3000 be shared by the new frame.
3002 This function is an internal primitive--use `make-frame' instead. */)
3003 (Lisp_Object parms)
3005 struct frame *f;
3006 Lisp_Object frame, tem;
3007 Lisp_Object name;
3008 int minibuffer_only = 0;
3009 long window_prompting = 0;
3010 int width, height;
3011 ptrdiff_t count = SPECPDL_INDEX ();
3012 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3013 Lisp_Object display;
3014 struct x_display_info *dpyinfo = NULL;
3015 Lisp_Object parent;
3016 struct kboard *kb;
3018 parms = Fcopy_alist (parms);
3020 /* Use this general default value to start with
3021 until we know if this frame has a specified name. */
3022 Vx_resource_name = Vinvocation_name;
3024 display = x_get_arg (dpyinfo, parms, Qterminal, 0, 0, RES_TYPE_NUMBER);
3025 if (EQ (display, Qunbound))
3026 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3027 if (EQ (display, Qunbound))
3028 display = Qnil;
3029 dpyinfo = check_x_display_info (display);
3030 kb = dpyinfo->terminal->kboard;
3032 if (!dpyinfo->terminal->name)
3033 error ("Terminal is not live, can't create new frames on it");
3035 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3036 if (!STRINGP (name)
3037 && ! EQ (name, Qunbound)
3038 && ! NILP (name))
3039 error ("Invalid frame name--not a string or nil");
3041 if (STRINGP (name))
3042 Vx_resource_name = name;
3044 /* See if parent window is specified. */
3045 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3046 if (EQ (parent, Qunbound))
3047 parent = Qnil;
3048 if (! NILP (parent))
3049 CHECK_NUMBER (parent);
3051 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3052 /* No need to protect DISPLAY because that's not used after passing
3053 it to make_frame_without_minibuffer. */
3054 frame = Qnil;
3055 GCPRO4 (parms, parent, name, frame);
3056 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3057 RES_TYPE_SYMBOL);
3058 if (EQ (tem, Qnone) || NILP (tem))
3059 f = make_frame_without_minibuffer (Qnil, kb, display);
3060 else if (EQ (tem, Qonly))
3062 f = make_minibuffer_frame ();
3063 minibuffer_only = 1;
3065 else if (WINDOWP (tem))
3066 f = make_frame_without_minibuffer (tem, kb, display);
3067 else
3068 f = make_frame (1);
3070 XSETFRAME (frame, f);
3072 f->terminal = dpyinfo->terminal;
3074 f->output_method = output_x_window;
3075 f->output_data.x = xzalloc (sizeof *f->output_data.x);
3076 f->output_data.x->icon_bitmap = -1;
3077 FRAME_FONTSET (f) = -1;
3078 f->output_data.x->scroll_bar_foreground_pixel = -1;
3079 f->output_data.x->scroll_bar_background_pixel = -1;
3080 #ifdef USE_TOOLKIT_SCROLL_BARS
3081 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3082 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3083 #endif /* USE_TOOLKIT_SCROLL_BARS */
3085 fset_icon_name (f,
3086 x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3087 RES_TYPE_STRING));
3088 if (! STRINGP (f->icon_name))
3089 fset_icon_name (f, Qnil);
3091 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3093 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
3094 record_unwind_protect (unwind_create_frame, frame);
3096 /* These colors will be set anyway later, but it's important
3097 to get the color reference counts right, so initialize them! */
3099 Lisp_Object black;
3100 struct gcpro gcpro1;
3102 /* Function x_decode_color can signal an error. Make
3103 sure to initialize color slots so that we won't try
3104 to free colors we haven't allocated. */
3105 FRAME_FOREGROUND_PIXEL (f) = -1;
3106 FRAME_BACKGROUND_PIXEL (f) = -1;
3107 f->output_data.x->cursor_pixel = -1;
3108 f->output_data.x->cursor_foreground_pixel = -1;
3109 f->output_data.x->border_pixel = -1;
3110 f->output_data.x->mouse_pixel = -1;
3112 black = build_string ("black");
3113 GCPRO1 (black);
3114 FRAME_FOREGROUND_PIXEL (f)
3115 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3116 FRAME_BACKGROUND_PIXEL (f)
3117 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3118 f->output_data.x->cursor_pixel
3119 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3120 f->output_data.x->cursor_foreground_pixel
3121 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3122 f->output_data.x->border_pixel
3123 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3124 f->output_data.x->mouse_pixel
3125 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3126 UNGCPRO;
3129 /* Specify the parent under which to make this X window. */
3131 if (!NILP (parent))
3133 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3134 f->output_data.x->explicit_parent = 1;
3136 else
3138 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3139 f->output_data.x->explicit_parent = 0;
3142 /* Set the name; the functions to which we pass f expect the name to
3143 be set. */
3144 if (EQ (name, Qunbound) || NILP (name))
3146 fset_name (f, build_string (dpyinfo->x_id_name));
3147 f->explicit_name = 0;
3149 else
3151 fset_name (f, name);
3152 f->explicit_name = 1;
3153 /* use the frame's title when getting resources for this frame. */
3154 specbind (Qx_resource_name, name);
3157 #ifdef HAVE_FREETYPE
3158 #ifdef HAVE_XFT
3159 register_font_driver (&xftfont_driver, f);
3160 #else /* not HAVE_XFT */
3161 register_font_driver (&ftxfont_driver, f);
3162 #endif /* not HAVE_XFT */
3163 #endif /* HAVE_FREETYPE */
3164 register_font_driver (&xfont_driver, f);
3166 x_default_parameter (f, parms, Qfont_backend, Qnil,
3167 "fontBackend", "FontBackend", RES_TYPE_STRING);
3169 /* Extract the window parameters from the supplied values
3170 that are needed to determine window geometry. */
3171 x_default_font_parameter (f, parms);
3172 if (!FRAME_FONT (f))
3174 delete_frame (frame, Qnoelisp);
3175 error ("Invalid frame font");
3178 /* Frame contents get displaced if an embedded X window has a border. */
3179 if (! FRAME_X_EMBEDDED_P (f))
3180 x_default_parameter (f, parms, Qborder_width, make_number (0),
3181 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3183 /* This defaults to 1 in order to match xterm. We recognize either
3184 internalBorderWidth or internalBorder (which is what xterm calls
3185 it). */
3186 if (NILP (Fassq (Qinternal_border_width, parms)))
3188 Lisp_Object value;
3190 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3191 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3192 if (! EQ (value, Qunbound))
3193 parms = Fcons (Fcons (Qinternal_border_width, value),
3194 parms);
3196 x_default_parameter (f, parms, Qinternal_border_width,
3197 #ifdef USE_GTK /* We used to impose 0 in xg_create_frame_widgets. */
3198 make_number (0),
3199 #else
3200 make_number (1),
3201 #endif
3202 "internalBorderWidth", "internalBorderWidth",
3203 RES_TYPE_NUMBER);
3204 x_default_parameter (f, parms, Qvertical_scroll_bars,
3205 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3206 Qright,
3207 #else
3208 Qleft,
3209 #endif
3210 "verticalScrollBars", "ScrollBars",
3211 RES_TYPE_SYMBOL);
3213 /* Also do the stuff which must be set before the window exists. */
3214 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3215 "foreground", "Foreground", RES_TYPE_STRING);
3216 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3217 "background", "Background", RES_TYPE_STRING);
3218 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3219 "pointerColor", "Foreground", RES_TYPE_STRING);
3220 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3221 "borderColor", "BorderColor", RES_TYPE_STRING);
3222 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3223 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3224 x_default_parameter (f, parms, Qline_spacing, Qnil,
3225 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3226 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3227 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3228 x_default_parameter (f, parms, Qright_fringe, Qnil,
3229 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3231 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3232 "scrollBarForeground",
3233 "ScrollBarForeground", 1);
3234 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3235 "scrollBarBackground",
3236 "ScrollBarBackground", 0);
3238 #ifdef GLYPH_DEBUG
3239 image_cache_refcount =
3240 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
3241 dpyinfo_refcount = dpyinfo->reference_count;
3242 #endif /* GLYPH_DEBUG */
3244 /* Init faces before x_default_parameter is called for scroll-bar
3245 parameters because that function calls x_set_scroll_bar_width,
3246 which calls change_frame_size, which calls Fset_window_buffer,
3247 which runs hooks, which call Fvertical_motion. At the end, we
3248 end up in init_iterator with a null face cache, which should not
3249 happen. */
3250 init_frame_faces (f);
3252 /* Set the menu-bar-lines and tool-bar-lines parameters. We don't
3253 look up the X resources controlling the menu-bar and tool-bar
3254 here; they are processed specially at startup, and reflected in
3255 the values of the mode variables.
3257 Avoid calling window-configuration-change-hook; otherwise we
3258 could get an infloop in next_frame since the frame is not yet in
3259 Vframe_list. */
3261 ptrdiff_t count2 = SPECPDL_INDEX ();
3262 record_unwind_protect (unwind_create_frame_1, inhibit_lisp_code);
3263 inhibit_lisp_code = Qt;
3265 x_default_parameter (f, parms, Qmenu_bar_lines,
3266 NILP (Vmenu_bar_mode)
3267 ? make_number (0) : make_number (1),
3268 NULL, NULL, RES_TYPE_NUMBER);
3269 x_default_parameter (f, parms, Qtool_bar_lines,
3270 NILP (Vtool_bar_mode)
3271 ? make_number (0) : make_number (1),
3272 NULL, NULL, RES_TYPE_NUMBER);
3274 unbind_to (count2, Qnil);
3277 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3278 "bufferPredicate", "BufferPredicate",
3279 RES_TYPE_SYMBOL);
3280 x_default_parameter (f, parms, Qtitle, Qnil,
3281 "title", "Title", RES_TYPE_STRING);
3282 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3283 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3284 x_default_parameter (f, parms, Qfullscreen, Qnil,
3285 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3286 x_default_parameter (f, parms, Qtool_bar_position,
3287 f->tool_bar_position, 0, 0, RES_TYPE_SYMBOL);
3289 /* Compute the size of the X window. */
3290 window_prompting = x_figure_window_size (f, parms, 1);
3292 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3293 f->no_split = minibuffer_only || EQ (tem, Qt);
3295 x_icon_verify (f, parms);
3297 /* Create the X widget or window. */
3298 #ifdef USE_X_TOOLKIT
3299 x_window (f, window_prompting, minibuffer_only);
3300 #else
3301 x_window (f);
3302 #endif
3304 x_icon (f, parms);
3305 x_make_gc (f);
3307 /* Now consider the frame official. */
3308 f->terminal->reference_count++;
3309 FRAME_X_DISPLAY_INFO (f)->reference_count++;
3310 Vframe_list = Fcons (frame, Vframe_list);
3312 /* We need to do this after creating the X window, so that the
3313 icon-creation functions can say whose icon they're describing. */
3314 x_default_parameter (f, parms, Qicon_type, Qt,
3315 "bitmapIcon", "BitmapIcon", RES_TYPE_BOOLEAN);
3317 x_default_parameter (f, parms, Qauto_raise, Qnil,
3318 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3319 x_default_parameter (f, parms, Qauto_lower, Qnil,
3320 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3321 x_default_parameter (f, parms, Qcursor_type, Qbox,
3322 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3323 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3324 "scrollBarWidth", "ScrollBarWidth",
3325 RES_TYPE_NUMBER);
3326 x_default_parameter (f, parms, Qalpha, Qnil,
3327 "alpha", "Alpha", RES_TYPE_NUMBER);
3329 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3330 Change will not be effected unless different from the current
3331 FRAME_LINES (f). */
3332 width = FRAME_COLS (f);
3333 height = FRAME_LINES (f);
3335 SET_FRAME_COLS (f, 0);
3336 FRAME_LINES (f) = 0;
3337 change_frame_size (f, height, width, 1, 0, 0);
3339 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3340 /* Create the menu bar. */
3341 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3343 /* If this signals an error, we haven't set size hints for the
3344 frame and we didn't make it visible. */
3345 initialize_frame_menubar (f);
3347 #ifndef USE_GTK
3348 /* This is a no-op, except under Motif where it arranges the
3349 main window for the widgets on it. */
3350 lw_set_main_areas (f->output_data.x->column_widget,
3351 f->output_data.x->menubar_widget,
3352 f->output_data.x->edit_widget);
3353 #endif /* not USE_GTK */
3355 #endif /* USE_X_TOOLKIT || USE_GTK */
3357 /* Tell the server what size and position, etc, we want, and how
3358 badly we want them. This should be done after we have the menu
3359 bar so that its size can be taken into account. */
3360 block_input ();
3361 x_wm_set_size_hint (f, window_prompting, 0);
3362 unblock_input ();
3364 /* Make the window appear on the frame and enable display, unless
3365 the caller says not to. However, with explicit parent, Emacs
3366 cannot control visibility, so don't try. */
3367 if (! f->output_data.x->explicit_parent)
3369 Lisp_Object visibility;
3371 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3372 RES_TYPE_SYMBOL);
3373 if (EQ (visibility, Qunbound))
3374 visibility = Qt;
3376 if (EQ (visibility, Qicon))
3377 x_iconify_frame (f);
3378 else if (! NILP (visibility))
3379 x_make_frame_visible (f);
3380 else
3382 /* Must have been Qnil. */
3386 block_input ();
3388 /* Set machine name and pid for the purpose of window managers. */
3389 set_machine_and_pid_properties (f);
3391 /* Set the WM leader property. GTK does this itself, so this is not
3392 needed when using GTK. */
3393 if (dpyinfo->client_leader_window != 0)
3395 XChangeProperty (FRAME_X_DISPLAY (f),
3396 FRAME_OUTER_WINDOW (f),
3397 dpyinfo->Xatom_wm_client_leader,
3398 XA_WINDOW, 32, PropModeReplace,
3399 (unsigned char *) &dpyinfo->client_leader_window, 1);
3402 unblock_input ();
3404 /* Initialize `default-minibuffer-frame' in case this is the first
3405 frame on this terminal. */
3406 if (FRAME_HAS_MINIBUF_P (f)
3407 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
3408 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
3409 kset_default_minibuffer_frame (kb, frame);
3411 /* All remaining specified parameters, which have not been "used"
3412 by x_get_arg and friends, now go in the misc. alist of the frame. */
3413 for (tem = parms; CONSP (tem); tem = XCDR (tem))
3414 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3415 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
3417 UNGCPRO;
3419 /* Make sure windows on this frame appear in calls to next-window
3420 and similar functions. */
3421 Vwindow_list = Qnil;
3423 return unbind_to (count, frame);
3427 /* FRAME is used only to get a handle on the X display. We don't pass the
3428 display info directly because we're called from frame.c, which doesn't
3429 know about that structure. */
3431 Lisp_Object
3432 x_get_focus_frame (struct frame *frame)
3434 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
3435 Lisp_Object xfocus;
3436 if (! dpyinfo->x_focus_frame)
3437 return Qnil;
3439 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3440 return xfocus;
3444 /* In certain situations, when the window manager follows a
3445 click-to-focus policy, there seems to be no way around calling
3446 XSetInputFocus to give another frame the input focus .
3448 In an ideal world, XSetInputFocus should generally be avoided so
3449 that applications don't interfere with the window manager's focus
3450 policy. But I think it's okay to use when it's clearly done
3451 following a user-command. */
3453 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
3454 doc: /* Set the input focus to FRAME.
3455 FRAME nil means use the selected frame. */)
3456 (Lisp_Object frame)
3458 struct frame *f = decode_window_system_frame (frame);
3459 Display *dpy = FRAME_X_DISPLAY (f);
3461 block_input ();
3462 x_catch_errors (dpy);
3464 if (FRAME_X_EMBEDDED_P (f))
3466 /* For Xembedded frames, normally the embedder forwards key
3467 events. See XEmbed Protocol Specification at
3468 http://freedesktop.org/wiki/Specifications/xembed-spec */
3469 xembed_request_focus (f);
3471 else
3473 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3474 RevertToParent, CurrentTime);
3475 x_ewmh_activate_frame (f);
3478 x_uncatch_errors ();
3479 unblock_input ();
3481 return Qnil;
3485 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3486 doc: /* Internal function called by `color-defined-p', which see
3487 .\(Note that the Nextstep version of this function ignores FRAME.) */)
3488 (Lisp_Object color, Lisp_Object frame)
3490 XColor foo;
3491 FRAME_PTR f = decode_window_system_frame (frame);
3493 CHECK_STRING (color);
3495 if (x_defined_color (f, SSDATA (color), &foo, 0))
3496 return Qt;
3497 else
3498 return Qnil;
3501 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3502 doc: /* Internal function called by `color-values', which see. */)
3503 (Lisp_Object color, Lisp_Object frame)
3505 XColor foo;
3506 FRAME_PTR f = decode_window_system_frame (frame);
3508 CHECK_STRING (color);
3510 if (x_defined_color (f, SSDATA (color), &foo, 0))
3511 return list3i (foo.red, foo.green, foo.blue);
3512 else
3513 return Qnil;
3516 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3517 doc: /* Internal function called by `display-color-p', which see. */)
3518 (Lisp_Object terminal)
3520 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3522 if (dpyinfo->n_planes <= 2)
3523 return Qnil;
3525 switch (dpyinfo->visual->class)
3527 case StaticColor:
3528 case PseudoColor:
3529 case TrueColor:
3530 case DirectColor:
3531 return Qt;
3533 default:
3534 return Qnil;
3538 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3539 0, 1, 0,
3540 doc: /* Return t if the X display supports shades of gray.
3541 Note that color displays do support shades of gray.
3542 The optional argument TERMINAL specifies which display to ask about.
3543 TERMINAL should be a terminal object, a frame or a display name (a string).
3544 If omitted or nil, that stands for the selected frame's display. */)
3545 (Lisp_Object terminal)
3547 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3549 if (dpyinfo->n_planes <= 1)
3550 return Qnil;
3552 switch (dpyinfo->visual->class)
3554 case StaticColor:
3555 case PseudoColor:
3556 case TrueColor:
3557 case DirectColor:
3558 case StaticGray:
3559 case GrayScale:
3560 return Qt;
3562 default:
3563 return Qnil;
3567 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3568 0, 1, 0,
3569 doc: /* Return the width in pixels of the X display TERMINAL.
3570 The optional argument TERMINAL specifies which display to ask about.
3571 TERMINAL should be a terminal object, a frame or a display name (a string).
3572 If omitted or nil, that stands for the selected frame's display. */)
3573 (Lisp_Object terminal)
3575 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3577 return make_number (x_display_pixel_width (dpyinfo));
3580 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3581 Sx_display_pixel_height, 0, 1, 0,
3582 doc: /* Return the height in pixels of the X display TERMINAL.
3583 The optional argument TERMINAL specifies which display to ask about.
3584 TERMINAL should be a terminal object, a frame or a display name (a string).
3585 If omitted or nil, that stands for the selected frame's display. */)
3586 (Lisp_Object terminal)
3588 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3590 return make_number (x_display_pixel_height (dpyinfo));
3593 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3594 0, 1, 0,
3595 doc: /* Return the number of bitplanes of the X display TERMINAL.
3596 The optional argument TERMINAL specifies which display to ask about.
3597 TERMINAL should be a terminal object, a frame or a display name (a string).
3598 If omitted or nil, that stands for the selected frame's display. */)
3599 (Lisp_Object terminal)
3601 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3603 return make_number (dpyinfo->n_planes);
3606 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3607 0, 1, 0,
3608 doc: /* Return the number of color cells of the X display TERMINAL.
3609 The optional argument TERMINAL specifies which display to ask about.
3610 TERMINAL should be a terminal object, a frame or a display name (a string).
3611 If omitted or nil, that stands for the selected frame's display. */)
3612 (Lisp_Object terminal)
3614 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3616 int nr_planes = DisplayPlanes (dpyinfo->display,
3617 XScreenNumberOfScreen (dpyinfo->screen));
3619 /* Truncate nr_planes to 24 to avoid integer overflow.
3620 Some displays says 32, but only 24 bits are actually significant.
3621 There are only very few and rare video cards that have more than
3622 24 significant bits. Also 24 bits is more than 16 million colors,
3623 it "should be enough for everyone". */
3624 if (nr_planes > 24) nr_planes = 24;
3626 return make_number (1 << nr_planes);
3629 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3630 Sx_server_max_request_size,
3631 0, 1, 0,
3632 doc: /* Return the maximum request size of the X server of display TERMINAL.
3633 The optional argument TERMINAL specifies which display to ask about.
3634 TERMINAL should be a terminal object, a frame or a display name (a string).
3635 If omitted or nil, that stands for the selected frame's display. */)
3636 (Lisp_Object terminal)
3638 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3640 return make_number (MAXREQUEST (dpyinfo->display));
3643 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3644 doc: /* Return the "vendor ID" string of the X server of display TERMINAL.
3645 \(Labeling every distributor as a "vendor" embodies the false assumption
3646 that operating systems cannot be developed and distributed noncommercially.)
3647 The optional argument TERMINAL specifies which display to ask about.
3648 TERMINAL should be a terminal object, a frame or a display name (a string).
3649 If omitted or nil, that stands for the selected frame's display. */)
3650 (Lisp_Object terminal)
3652 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3653 const char *vendor = ServerVendor (dpyinfo->display);
3655 if (! vendor) vendor = "";
3656 return build_string (vendor);
3659 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3660 doc: /* Return the version numbers of the X server of display TERMINAL.
3661 The value is a list of three integers: the major and minor
3662 version numbers of the X Protocol in use, and the distributor-specific release
3663 number. See also the function `x-server-vendor'.
3665 The optional argument TERMINAL specifies which display to ask about.
3666 TERMINAL should be a terminal object, a frame or a display name (a string).
3667 If omitted or nil, that stands for the selected frame's display. */)
3668 (Lisp_Object terminal)
3670 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3671 Display *dpy = dpyinfo->display;
3673 return list3i (ProtocolVersion (dpy), ProtocolRevision (dpy),
3674 VendorRelease (dpy));
3677 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3678 doc: /* Return the number of screens on the X server of 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. */)
3682 (Lisp_Object terminal)
3684 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3686 return make_number (ScreenCount (dpyinfo->display));
3689 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3690 doc: /* Return the height in millimeters of the X display TERMINAL.
3691 The optional argument TERMINAL specifies which display to ask about.
3692 TERMINAL should be a terminal object, a frame or a display name (a string).
3693 If omitted or nil, that stands for the selected frame's display. */)
3694 (Lisp_Object terminal)
3696 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3698 return make_number (HeightMMOfScreen (dpyinfo->screen));
3701 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3702 doc: /* Return the width in millimeters of the X display TERMINAL.
3703 The optional argument TERMINAL specifies which display to ask about.
3704 TERMINAL should be a terminal object, a frame or a display name (a string).
3705 If omitted or nil, that stands for the selected frame's display. */)
3706 (Lisp_Object terminal)
3708 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3710 return make_number (WidthMMOfScreen (dpyinfo->screen));
3713 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3714 Sx_display_backing_store, 0, 1, 0,
3715 doc: /* Return an indication of whether X display TERMINAL does backing store.
3716 The value may be `always', `when-mapped', or `not-useful'.
3717 The optional argument TERMINAL specifies which display to ask about.
3718 TERMINAL should be a terminal object, a frame or a display name (a string).
3719 If omitted or nil, that stands for the selected frame's display. */)
3720 (Lisp_Object terminal)
3722 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3723 Lisp_Object result;
3725 switch (DoesBackingStore (dpyinfo->screen))
3727 case Always:
3728 result = intern ("always");
3729 break;
3731 case WhenMapped:
3732 result = intern ("when-mapped");
3733 break;
3735 case NotUseful:
3736 result = intern ("not-useful");
3737 break;
3739 default:
3740 error ("Strange value for BackingStore parameter of screen");
3743 return result;
3746 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3747 Sx_display_visual_class, 0, 1, 0,
3748 doc: /* Return the visual class of the X display TERMINAL.
3749 The value is one of the symbols `static-gray', `gray-scale',
3750 `static-color', `pseudo-color', `true-color', or `direct-color'.
3752 The optional argument TERMINAL specifies which display to ask about.
3753 TERMINAL should a terminal object, a frame or a display name (a string).
3754 If omitted or nil, that stands for the selected frame's display. */)
3755 (Lisp_Object terminal)
3757 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3758 Lisp_Object result;
3760 switch (dpyinfo->visual->class)
3762 case StaticGray:
3763 result = intern ("static-gray");
3764 break;
3765 case GrayScale:
3766 result = intern ("gray-scale");
3767 break;
3768 case StaticColor:
3769 result = intern ("static-color");
3770 break;
3771 case PseudoColor:
3772 result = intern ("pseudo-color");
3773 break;
3774 case TrueColor:
3775 result = intern ("true-color");
3776 break;
3777 case DirectColor:
3778 result = intern ("direct-color");
3779 break;
3780 default:
3781 error ("Display has an unknown visual class");
3784 return result;
3787 DEFUN ("x-display-save-under", Fx_display_save_under,
3788 Sx_display_save_under, 0, 1, 0,
3789 doc: /* Return t if the X display TERMINAL supports the save-under feature.
3790 The optional argument TERMINAL specifies which display to ask about.
3791 TERMINAL should be a terminal object, a frame or a display name (a string).
3792 If omitted or nil, that stands for the selected frame's display. */)
3793 (Lisp_Object terminal)
3795 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3797 if (DoesSaveUnders (dpyinfo->screen) == True)
3798 return Qt;
3799 else
3800 return Qnil;
3803 /* Store the geometry of the workarea on display DPYINFO into *RECT.
3804 Return false if and only if the workarea information cannot be
3805 obtained via the _NET_WORKAREA root window property. */
3807 #if ! GTK_CHECK_VERSION (3, 4, 0)
3808 static bool
3809 x_get_net_workarea (struct x_display_info *dpyinfo, XRectangle *rect)
3811 Display *dpy = dpyinfo->display;
3812 long offset, max_len;
3813 Atom target_type, actual_type;
3814 unsigned long actual_size, bytes_remaining;
3815 int rc, actual_format;
3816 unsigned char *tmp_data = NULL;
3817 bool result = false;
3819 x_catch_errors (dpy);
3820 offset = 0;
3821 max_len = 1;
3822 target_type = XA_CARDINAL;
3823 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
3824 dpyinfo->Xatom_net_current_desktop,
3825 offset, max_len, False, target_type,
3826 &actual_type, &actual_format, &actual_size,
3827 &bytes_remaining, &tmp_data);
3828 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
3829 && actual_format == 32 && actual_size == max_len)
3831 long current_desktop = ((long *) tmp_data)[0];
3833 XFree (tmp_data);
3834 tmp_data = NULL;
3836 offset = 4 * current_desktop;
3837 max_len = 4;
3838 rc = XGetWindowProperty (dpy, dpyinfo->root_window,
3839 dpyinfo->Xatom_net_workarea,
3840 offset, max_len, False, target_type,
3841 &actual_type, &actual_format, &actual_size,
3842 &bytes_remaining, &tmp_data);
3843 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
3844 && actual_format == 32 && actual_size == max_len)
3846 long *values = (long *) tmp_data;
3848 rect->x = values[0];
3849 rect->y = values[1];
3850 rect->width = values[2];
3851 rect->height = values[3];
3853 XFree (tmp_data);
3854 tmp_data = NULL;
3856 result = true;
3859 if (tmp_data)
3860 XFree (tmp_data);
3861 x_uncatch_errors ();
3863 return result;
3865 #endif
3867 #ifndef USE_GTK
3869 struct MonitorInfo {
3870 XRectangle geom, work;
3871 int mm_width, mm_height;
3872 char *name;
3875 #if defined HAVE_XINERAMA || defined HAVE_XRANDR
3876 static void
3877 free_monitors (struct MonitorInfo *monitors, int n_monitors)
3879 int i;
3880 for (i = 0; i < n_monitors; ++i)
3881 xfree (monitors[i].name);
3882 xfree (monitors);
3884 #endif /* HAVE_XINERAMA || HAVE_XRANDR */
3887 /* Return monitor number where F is "most" or closest to. */
3888 static int
3889 x_get_monitor_for_frame (struct frame *f,
3890 struct MonitorInfo *monitors,
3891 int n_monitors)
3893 XRectangle frect;
3894 int area = 0, dist = -1;
3895 int best_area = -1, best_dist = -1;
3896 int i;
3898 if (n_monitors == 1) return 0;
3899 frect.x = f->left_pos;
3900 frect.y = f->top_pos;
3901 frect.width = FRAME_PIXEL_WIDTH (f);
3902 frect.height = FRAME_PIXEL_HEIGHT (f);
3904 for (i = 0; i < n_monitors; ++i)
3906 struct MonitorInfo *mi = &monitors[i];
3907 XRectangle res;
3908 int a = 0;
3910 if (mi->geom.width == 0) continue;
3912 if (x_intersect_rectangles (&mi->geom, &frect, &res))
3914 a = res.width * res.height;
3915 if (a > area)
3917 area = a;
3918 best_area = i;
3922 if (a == 0 && area == 0)
3924 int dx, dy, d;
3925 if (frect.x + frect.width < mi->geom.x)
3926 dx = mi->geom.x - frect.x + frect.width;
3927 else if (frect.x > mi->geom.x + mi->geom.width)
3928 dx = frect.x - mi->geom.x + mi->geom.width;
3929 else
3930 dx = 0;
3931 if (frect.y + frect.height < mi->geom.y)
3932 dy = mi->geom.y - frect.y + frect.height;
3933 else if (frect.y > mi->geom.y + mi->geom.height)
3934 dy = frect.y - mi->geom.y + mi->geom.height;
3935 else
3936 dy = 0;
3938 d = dx*dx + dy*dy;
3939 if (dist == -1 || dist > d)
3941 dist = d;
3942 best_dist = i;
3947 return best_area != -1 ? best_area : (best_dist != -1 ? best_dist : 0);
3950 static Lisp_Object
3951 x_make_monitor_attribute_list (struct MonitorInfo *monitors,
3952 int n_monitors,
3953 int primary_monitor,
3954 struct x_display_info *dpyinfo,
3955 const char *source)
3957 Lisp_Object monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
3958 Lisp_Object frame, rest, attributes_list = Qnil;
3959 Lisp_Object primary_monitor_attributes = Qnil;
3960 int i;
3962 FOR_EACH_FRAME (rest, frame)
3964 struct frame *f = XFRAME (frame);
3966 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo
3967 && !EQ (frame, tip_frame))
3969 i = x_get_monitor_for_frame (f, monitors, n_monitors);
3970 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
3974 for (i = 0; i < n_monitors; ++i)
3976 Lisp_Object geometry, workarea, attributes = Qnil;
3977 struct MonitorInfo *mi = &monitors[i];
3979 if (mi->geom.width == 0) continue;
3981 workarea = list4i (mi->work.x, mi->work.y,
3982 mi->work.width, mi->work.height);
3983 geometry = list4i (mi->geom.x, mi->geom.y,
3984 mi->geom.width, mi->geom.height);
3985 attributes = Fcons (Fcons (Qsource,
3986 make_string (source, strlen (source))),
3987 attributes);
3988 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
3989 attributes);
3990 attributes = Fcons (Fcons (Qmm_size,
3991 list2i (mi->mm_width, mi->mm_height)),
3992 attributes);
3993 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
3994 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
3995 if (mi->name)
3996 attributes = Fcons (Fcons (Qname, make_string (mi->name,
3997 strlen (mi->name))),
3998 attributes);
4000 if (i == primary_monitor)
4001 primary_monitor_attributes = attributes;
4002 else
4003 attributes_list = Fcons (attributes, attributes_list);
4006 if (!NILP (primary_monitor_attributes))
4007 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
4008 return attributes_list;
4011 static Lisp_Object
4012 x_get_monitor_attributes_fallback (struct x_display_info *dpyinfo)
4014 struct MonitorInfo monitor;
4015 XRectangle workarea_r;
4017 /* Fallback: treat (possibly) multiple physical monitors as if they
4018 formed a single monitor as a whole. This should provide a
4019 consistent result at least on single monitor environments. */
4020 monitor.geom.x = monitor.geom.y = 0;
4021 monitor.geom.width = x_display_pixel_width (dpyinfo);
4022 monitor.geom.height = x_display_pixel_height (dpyinfo);
4023 monitor.mm_width = WidthMMOfScreen (dpyinfo->screen);
4024 monitor.mm_height = HeightMMOfScreen (dpyinfo->screen);
4025 monitor.name = xstrdup ("combined screen");
4027 if (x_get_net_workarea (dpyinfo, &workarea_r))
4028 monitor.work = workarea_r;
4029 else
4030 monitor.work = monitor.geom;
4031 return x_make_monitor_attribute_list (&monitor, 1, 0, dpyinfo, "fallback");
4035 #ifdef HAVE_XINERAMA
4036 static Lisp_Object
4037 x_get_monitor_attributes_xinerama (struct x_display_info *dpyinfo)
4039 int n_monitors, i;
4040 Lisp_Object attributes_list = Qnil;
4041 Display *dpy = dpyinfo->display;
4042 XineramaScreenInfo *info = XineramaQueryScreens (dpy, &n_monitors);
4043 struct MonitorInfo *monitors;
4044 double mm_width_per_pixel, mm_height_per_pixel;
4046 if (! info || n_monitors == 0)
4048 if (info)
4049 XFree (info);
4050 return attributes_list;
4053 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
4054 / x_display_pixel_width (dpyinfo));
4055 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
4056 / x_display_pixel_height (dpyinfo));
4057 monitors = (struct MonitorInfo *) xzalloc (n_monitors * sizeof (*monitors));
4058 for (i = 0; i < n_monitors; ++i)
4060 struct MonitorInfo *mi = &monitors[i];
4061 XRectangle workarea_r;
4063 mi->geom.x = info[i].x_org;
4064 mi->geom.y = info[i].y_org;
4065 mi->geom.width = info[i].width;
4066 mi->geom.height = info[i].height;
4067 mi->mm_width = mi->geom.width * mm_width_per_pixel + 0.5;
4068 mi->mm_height = mi->geom.height * mm_height_per_pixel + 0.5;
4069 mi->name = 0;
4071 /* Xinerama usually have primary monitor first, just use that. */
4072 if (i == 0 && x_get_net_workarea (dpyinfo, &workarea_r))
4074 mi->work = workarea_r;
4075 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
4076 mi->work = mi->geom;
4078 else
4079 mi->work = mi->geom;
4081 XFree (info);
4083 attributes_list = x_make_monitor_attribute_list (monitors,
4084 n_monitors,
4086 dpyinfo,
4087 "Xinerama");
4088 free_monitors (monitors, n_monitors);
4089 return attributes_list;
4091 #endif /* HAVE_XINERAMA */
4094 #ifdef HAVE_XRANDR
4095 static Lisp_Object
4096 x_get_monitor_attributes_xrandr (struct x_display_info *dpyinfo)
4098 Lisp_Object attributes_list = Qnil;
4099 XRRScreenResources *resources;
4100 Display *dpy = dpyinfo->display;
4101 int i, n_monitors, primary = -1;
4102 RROutput pxid = None;
4103 struct MonitorInfo *monitors;
4105 #ifdef HAVE_XRRGETSCREENRESOURCESCURRENT
4106 resources = XRRGetScreenResourcesCurrent (dpy, dpyinfo->root_window);
4107 #else
4108 resources = XRRGetScreenResources (dpy, dpyinfo->root_window);
4109 #endif
4110 if (! resources || resources->noutput == 0)
4112 if (resources)
4113 XRRFreeScreenResources (resources);
4114 return Qnil;
4116 n_monitors = resources->noutput;
4117 monitors = (struct MonitorInfo *) xzalloc (n_monitors * sizeof (*monitors));
4119 #ifdef HAVE_XRRGETOUTPUTPRIMARY
4120 pxid = XRRGetOutputPrimary (dpy, dpyinfo->root_window);
4121 #endif
4123 for (i = 0; i < n_monitors; ++i)
4125 XRROutputInfo *info = XRRGetOutputInfo (dpy, resources,
4126 resources->outputs[i]);
4127 Connection conn = info ? info->connection : RR_Disconnected;
4128 RRCrtc id = info ? info->crtc : None;
4130 if (strcmp (info->name, "default") == 0)
4132 /* Non XRandr 1.2 driver, does not give useful data. */
4133 XRRFreeOutputInfo (info);
4134 XRRFreeScreenResources (resources);
4135 free_monitors (monitors, n_monitors);
4136 return Qnil;
4139 if (conn != RR_Disconnected && id != None)
4141 XRRCrtcInfo *crtc = XRRGetCrtcInfo (dpy, resources, id);
4142 struct MonitorInfo *mi = &monitors[i];
4143 XRectangle workarea_r;
4145 if (! crtc)
4147 XRRFreeOutputInfo (info);
4148 continue;
4151 mi->geom.x = crtc->x;
4152 mi->geom.y = crtc->y;
4153 mi->geom.width = crtc->width;
4154 mi->geom.height = crtc->height;
4155 mi->mm_width = info->mm_width;
4156 mi->mm_height = info->mm_height;
4157 mi->name = xstrdup (info->name);
4159 if (pxid != None && pxid == resources->outputs[i])
4160 primary = i;
4161 else if (primary == -1 && strcmp (info->name, "LVDS") == 0)
4162 primary = i;
4164 if (i == primary && x_get_net_workarea (dpyinfo, &workarea_r))
4166 mi->work= workarea_r;
4167 if (! x_intersect_rectangles (&mi->geom, &mi->work, &mi->work))
4168 mi->work = mi->geom;
4170 else
4171 mi->work = mi->geom;
4173 XRRFreeCrtcInfo (crtc);
4175 XRRFreeOutputInfo (info);
4177 XRRFreeScreenResources (resources);
4179 attributes_list = x_make_monitor_attribute_list (monitors,
4180 n_monitors,
4181 primary,
4182 dpyinfo,
4183 "XRandr");
4184 free_monitors (monitors, n_monitors);
4185 return attributes_list;
4187 #endif /* HAVE_XRANDR */
4189 static Lisp_Object
4190 x_get_monitor_attributes (struct x_display_info *dpyinfo)
4192 Lisp_Object attributes_list = Qnil;
4193 Display *dpy = dpyinfo->display;
4195 #ifdef HAVE_XRANDR
4196 int xrr_event_base, xrr_error_base;
4197 bool xrr_ok = false;
4198 xrr_ok = XRRQueryExtension (dpy, &xrr_event_base, &xrr_error_base);
4199 if (xrr_ok)
4201 int xrr_major, xrr_minor;
4202 XRRQueryVersion (dpy, &xrr_major, &xrr_minor);
4203 xrr_ok = (xrr_major == 1 && xrr_minor >= 2) || xrr_major > 1;
4206 if (xrr_ok)
4207 attributes_list = x_get_monitor_attributes_xrandr (dpyinfo);
4208 #endif /* HAVE_XRANDR */
4210 #ifdef HAVE_XINERAMA
4211 if (NILP (attributes_list))
4213 int xin_event_base, xin_error_base;
4214 bool xin_ok = false;
4215 xin_ok = XineramaQueryExtension (dpy, &xin_event_base, &xin_error_base);
4216 if (xin_ok && XineramaIsActive (dpy))
4217 attributes_list = x_get_monitor_attributes_xinerama (dpyinfo);
4219 #endif /* HAVE_XINERAMA */
4221 if (NILP (attributes_list))
4222 attributes_list = x_get_monitor_attributes_fallback (dpyinfo);
4224 return attributes_list;
4227 #endif /* !USE_GTK */
4229 DEFUN ("x-display-monitor-attributes-list", Fx_display_monitor_attributes_list,
4230 Sx_display_monitor_attributes_list,
4231 0, 1, 0,
4232 doc: /* Return a list of physical monitor attributes on the X display TERMINAL.
4234 The optional argument TERMINAL specifies which display to ask about.
4235 TERMINAL should be a terminal object, a frame or a display name (a string).
4236 If omitted or nil, that stands for the selected frame's display.
4238 In addition to the standard attribute keys listed in
4239 `display-monitor-attributes-list', the following keys are contained in
4240 the attributes:
4242 source -- String describing the source from which multi-monitor
4243 information is obtained, one of \"Gdk\", \"XRandr\",
4244 \"Xinerama\", or \"fallback\"
4246 Internal use only, use `display-monitor-attributes-list' instead. */)
4247 (Lisp_Object terminal)
4249 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4250 Lisp_Object attributes_list = Qnil;
4252 #ifdef USE_GTK
4253 double mm_width_per_pixel, mm_height_per_pixel;
4254 GdkDisplay *gdpy;
4255 GdkScreen *gscreen;
4256 gint primary_monitor = 0, n_monitors, i;
4257 Lisp_Object primary_monitor_attributes = Qnil;
4258 Lisp_Object monitor_frames, rest, frame;
4259 static const char *source = "Gdk";
4261 block_input ();
4262 mm_width_per_pixel = ((double) WidthMMOfScreen (dpyinfo->screen)
4263 / x_display_pixel_width (dpyinfo));
4264 mm_height_per_pixel = ((double) HeightMMOfScreen (dpyinfo->screen)
4265 / x_display_pixel_height (dpyinfo));
4266 gdpy = gdk_x11_lookup_xdisplay (dpyinfo->display);
4267 gscreen = gdk_display_get_default_screen (gdpy);
4268 #if GTK_CHECK_VERSION (2, 20, 0)
4269 primary_monitor = gdk_screen_get_primary_monitor (gscreen);
4270 #endif
4271 n_monitors = gdk_screen_get_n_monitors (gscreen);
4272 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4273 FOR_EACH_FRAME (rest, frame)
4275 struct frame *f = XFRAME (frame);
4277 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo
4278 && !EQ (frame, tip_frame))
4280 GdkWindow *gwin = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
4282 i = gdk_screen_get_monitor_at_window (gscreen, gwin);
4283 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
4287 i = n_monitors;
4288 while (i-- > 0)
4290 Lisp_Object geometry, workarea, attributes = Qnil;
4291 gint width_mm = -1, height_mm = -1;
4292 GdkRectangle rec;
4294 attributes = Fcons (Fcons (Qsource,
4295 make_string (source, strlen (source))),
4296 attributes);
4297 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
4298 attributes);
4300 gdk_screen_get_monitor_geometry (gscreen, i, &rec);
4301 geometry = list4i (rec.x, rec.y, rec.width, rec.height);
4303 #if GTK_CHECK_VERSION (2, 14, 0)
4304 width_mm = gdk_screen_get_monitor_width_mm (gscreen, i);
4305 height_mm = gdk_screen_get_monitor_height_mm (gscreen, i);
4306 #endif
4307 if (width_mm < 0)
4308 width_mm = rec.width * mm_width_per_pixel + 0.5;
4309 if (height_mm < 0)
4310 height_mm = rec.height * mm_height_per_pixel + 0.5;
4311 attributes = Fcons (Fcons (Qmm_size,
4312 list2i (width_mm, height_mm)),
4313 attributes);
4315 #if GTK_CHECK_VERSION (3, 4, 0)
4316 gdk_screen_get_monitor_workarea (gscreen, i, &rec);
4317 workarea = list4i (rec.x, rec.y, rec.width, rec.height);
4318 #else
4319 /* Emulate the behavior of GTK+ 3.4. */
4321 XRectangle workarea_r;
4323 workarea = Qnil;
4324 if (i == primary_monitor && x_get_net_workarea (dpyinfo, &workarea_r))
4326 GdkRectangle work;
4328 work.x = workarea_r.x;
4329 work.y = workarea_r.y;
4330 work.width = workarea_r.width;
4331 work.height = workarea_r.height;
4332 if (gdk_rectangle_intersect (&rec, &work, &work))
4333 workarea = list4i (work.x, work.y, work.width, work.height);
4335 if (NILP (workarea))
4336 workarea = geometry;
4338 #endif
4339 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
4341 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
4342 #if GTK_CHECK_VERSION (2, 14, 0)
4344 char *name = gdk_screen_get_monitor_plug_name (gscreen, i);
4345 if (name)
4346 attributes = Fcons (Fcons (Qname, make_string (name, strlen (name))),
4347 attributes);
4349 #endif
4351 if (i == primary_monitor)
4352 primary_monitor_attributes = attributes;
4353 else
4354 attributes_list = Fcons (attributes, attributes_list);
4357 if (!NILP (primary_monitor_attributes))
4358 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
4359 unblock_input ();
4360 #else /* not USE_GTK */
4362 block_input ();
4363 attributes_list = x_get_monitor_attributes (dpyinfo);
4364 unblock_input ();
4366 #endif /* not USE_GTK */
4368 return attributes_list;
4373 x_pixel_width (register struct frame *f)
4375 return FRAME_PIXEL_WIDTH (f);
4379 x_pixel_height (register struct frame *f)
4381 return FRAME_PIXEL_HEIGHT (f);
4384 /************************************************************************
4385 X Displays
4386 ************************************************************************/
4389 /* Mapping visual names to visuals. */
4391 static struct visual_class
4393 const char *name;
4394 int class;
4396 visual_classes[] =
4398 {"StaticGray", StaticGray},
4399 {"GrayScale", GrayScale},
4400 {"StaticColor", StaticColor},
4401 {"PseudoColor", PseudoColor},
4402 {"TrueColor", TrueColor},
4403 {"DirectColor", DirectColor},
4404 {NULL, 0}
4408 #ifndef HAVE_XSCREENNUMBEROFSCREEN
4410 /* Value is the screen number of screen SCR. This is a substitute for
4411 the X function with the same name when that doesn't exist. */
4414 XScreenNumberOfScreen (scr)
4415 register Screen *scr;
4417 Display *dpy = scr->display;
4418 int i;
4420 for (i = 0; i < dpy->nscreens; ++i)
4421 if (scr == dpy->screens + i)
4422 break;
4424 return i;
4427 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
4430 /* Select the visual that should be used on display DPYINFO. Set
4431 members of DPYINFO appropriately. Called from x_term_init. */
4433 void
4434 select_visual (struct x_display_info *dpyinfo)
4436 Display *dpy = dpyinfo->display;
4437 Screen *screen = dpyinfo->screen;
4438 Lisp_Object value;
4440 /* See if a visual is specified. */
4441 value = display_x_get_resource (dpyinfo,
4442 build_string ("visualClass"),
4443 build_string ("VisualClass"),
4444 Qnil, Qnil);
4445 if (STRINGP (value))
4447 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
4448 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
4449 depth, a decimal number. NAME is compared with case ignored. */
4450 char *s = alloca (SBYTES (value) + 1);
4451 char *dash;
4452 int i, class = -1;
4453 XVisualInfo vinfo;
4455 strcpy (s, SSDATA (value));
4456 dash = strchr (s, '-');
4457 if (dash)
4459 dpyinfo->n_planes = atoi (dash + 1);
4460 *dash = '\0';
4462 else
4463 /* We won't find a matching visual with depth 0, so that
4464 an error will be printed below. */
4465 dpyinfo->n_planes = 0;
4467 /* Determine the visual class. */
4468 for (i = 0; visual_classes[i].name; ++i)
4469 if (xstrcasecmp (s, visual_classes[i].name) == 0)
4471 class = visual_classes[i].class;
4472 break;
4475 /* Look up a matching visual for the specified class. */
4476 if (class == -1
4477 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
4478 dpyinfo->n_planes, class, &vinfo))
4479 fatal ("Invalid visual specification `%s'", SDATA (value));
4481 dpyinfo->visual = vinfo.visual;
4483 else
4485 int n_visuals;
4486 XVisualInfo *vinfo, vinfo_template;
4488 dpyinfo->visual = DefaultVisualOfScreen (screen);
4490 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
4491 vinfo_template.screen = XScreenNumberOfScreen (screen);
4492 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
4493 &vinfo_template, &n_visuals);
4494 if (n_visuals <= 0)
4495 fatal ("Can't get proper X visual info");
4497 dpyinfo->n_planes = vinfo->depth;
4498 XFree (vinfo);
4503 /* Return the X display structure for the display named NAME.
4504 Open a new connection if necessary. */
4506 static struct x_display_info *
4507 x_display_info_for_name (Lisp_Object name)
4509 Lisp_Object names;
4510 struct x_display_info *dpyinfo;
4512 CHECK_STRING (name);
4514 #if 0
4515 if (! EQ (Vinitial_window_system, intern ("x")))
4516 error ("Not using X Windows"); /* That doesn't stop us anymore. */
4517 #endif
4519 for (dpyinfo = x_display_list, names = x_display_name_list;
4520 dpyinfo;
4521 dpyinfo = dpyinfo->next, names = XCDR (names))
4523 Lisp_Object tem;
4524 tem = Fstring_equal (XCAR (XCAR (names)), name);
4525 if (!NILP (tem))
4526 return dpyinfo;
4529 /* Use this general default value to start with. */
4530 Vx_resource_name = Vinvocation_name;
4532 validate_x_resource_name ();
4534 dpyinfo = x_term_init (name, (char *)0,
4535 SSDATA (Vx_resource_name));
4537 if (dpyinfo == 0)
4538 error ("Cannot connect to X server %s", SDATA (name));
4540 XSETFASTINT (Vwindow_system_version, 11);
4542 return dpyinfo;
4546 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4547 1, 3, 0,
4548 doc: /* Open a connection to a display server.
4549 DISPLAY is the name of the display to connect to.
4550 Optional second arg XRM-STRING is a string of resources in xrdb format.
4551 If the optional third arg MUST-SUCCEED is non-nil,
4552 terminate Emacs if we can't open the connection.
4553 \(In the Nextstep version, the last two arguments are currently ignored.) */)
4554 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4556 char *xrm_option;
4557 struct x_display_info *dpyinfo;
4559 CHECK_STRING (display);
4560 if (! NILP (xrm_string))
4561 CHECK_STRING (xrm_string);
4563 #if 0
4564 if (! EQ (Vinitial_window_system, intern ("x")))
4565 error ("Not using X Windows"); /* That doesn't stop us anymore. */
4566 #endif
4568 if (! NILP (xrm_string))
4569 xrm_option = SSDATA (xrm_string);
4570 else
4571 xrm_option = (char *) 0;
4573 validate_x_resource_name ();
4575 /* This is what opens the connection and sets x_current_display.
4576 This also initializes many symbols, such as those used for input. */
4577 dpyinfo = x_term_init (display, xrm_option,
4578 SSDATA (Vx_resource_name));
4580 if (dpyinfo == 0)
4582 if (!NILP (must_succeed))
4583 fatal ("Cannot connect to X server %s.\n\
4584 Check the DISPLAY environment variable or use `-d'.\n\
4585 Also use the `xauth' program to verify that you have the proper\n\
4586 authorization information needed to connect the X server.\n\
4587 An insecure way to solve the problem may be to use `xhost'.\n",
4588 SDATA (display));
4589 else
4590 error ("Cannot connect to X server %s", SDATA (display));
4593 XSETFASTINT (Vwindow_system_version, 11);
4594 return Qnil;
4597 DEFUN ("x-close-connection", Fx_close_connection,
4598 Sx_close_connection, 1, 1, 0,
4599 doc: /* Close the connection to TERMINAL's X server.
4600 For TERMINAL, specify a terminal object, a frame or a display name (a
4601 string). If TERMINAL is nil, that stands for the selected frame's
4602 terminal. */)
4603 (Lisp_Object terminal)
4605 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4607 if (dpyinfo->reference_count > 0)
4608 error ("Display still has frames on it");
4610 x_delete_terminal (dpyinfo->terminal);
4612 return Qnil;
4615 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4616 doc: /* Return the list of display names that Emacs has connections to. */)
4617 (void)
4619 Lisp_Object tail, result;
4621 result = Qnil;
4622 for (tail = x_display_name_list; CONSP (tail); tail = XCDR (tail))
4623 result = Fcons (XCAR (XCAR (tail)), result);
4625 return result;
4628 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4629 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4630 This function only has an effect on X Windows. With MS Windows, it is
4631 defined but does nothing.
4633 If ON is nil, allow buffering of requests.
4634 Turning on synchronization prohibits the Xlib routines from buffering
4635 requests and seriously degrades performance, but makes debugging much
4636 easier.
4637 The optional second argument TERMINAL specifies which display to act on.
4638 TERMINAL should be a terminal object, a frame or a display name (a string).
4639 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
4640 (Lisp_Object on, Lisp_Object terminal)
4642 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4644 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4646 return Qnil;
4649 /* Wait for responses to all X commands issued so far for frame F. */
4651 void
4652 x_sync (FRAME_PTR f)
4654 block_input ();
4655 XSync (FRAME_X_DISPLAY (f), False);
4656 unblock_input ();
4660 /***********************************************************************
4661 Window properties
4662 ***********************************************************************/
4664 DEFUN ("x-change-window-property", Fx_change_window_property,
4665 Sx_change_window_property, 2, 6, 0,
4666 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4667 PROP must be a string. VALUE may be a string or a list of conses,
4668 numbers and/or strings. If an element in the list is a string, it is
4669 converted to an atom and the value of the atom is used. If an element
4670 is a cons, it is converted to a 32 bit number where the car is the 16
4671 top bits and the cdr is the lower 16 bits.
4673 FRAME nil or omitted means use the selected frame.
4674 If TYPE is given and non-nil, it is the name of the type of VALUE.
4675 If TYPE is not given or nil, the type is STRING.
4676 FORMAT gives the size in bits of each element if VALUE is a list.
4677 It must be one of 8, 16 or 32.
4678 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4679 If OUTER-P is non-nil, the property is changed for the outer X window of
4680 FRAME. Default is to change on the edit X window. */)
4681 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
4682 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
4684 struct frame *f = decode_window_system_frame (frame);
4685 Atom prop_atom;
4686 Atom target_type = XA_STRING;
4687 int element_format = 8;
4688 unsigned char *data;
4689 int nelements;
4690 Window w;
4692 CHECK_STRING (prop);
4694 if (! NILP (format))
4696 CHECK_NUMBER (format);
4698 if (XINT (format) != 8 && XINT (format) != 16
4699 && XINT (format) != 32)
4700 error ("FORMAT must be one of 8, 16 or 32");
4701 element_format = XINT (format);
4704 if (CONSP (value))
4706 ptrdiff_t elsize;
4708 nelements = x_check_property_data (value);
4709 if (nelements == -1)
4710 error ("Bad data in VALUE, must be number, string or cons");
4712 /* The man page for XChangeProperty:
4713 "If the specified format is 32, the property data must be a
4714 long array."
4715 This applies even if long is more than 32 bits. The X library
4716 converts to 32 bits before sending to the X server. */
4717 elsize = element_format == 32 ? sizeof (long) : element_format >> 3;
4718 data = xnmalloc (nelements, elsize);
4720 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4722 else
4724 CHECK_STRING (value);
4725 data = SDATA (value);
4726 if (INT_MAX < SBYTES (value))
4727 error ("VALUE too long");
4728 nelements = SBYTES (value);
4731 block_input ();
4732 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4733 if (! NILP (type))
4735 CHECK_STRING (type);
4736 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4739 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4740 else w = FRAME_X_WINDOW (f);
4742 XChangeProperty (FRAME_X_DISPLAY (f), w,
4743 prop_atom, target_type, element_format, PropModeReplace,
4744 data, nelements);
4746 if (CONSP (value)) xfree (data);
4748 /* Make sure the property is set when we return. */
4749 XFlush (FRAME_X_DISPLAY (f));
4750 unblock_input ();
4752 return value;
4756 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4757 Sx_delete_window_property, 1, 2, 0,
4758 doc: /* Remove window property PROP from X window of FRAME.
4759 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4760 (Lisp_Object prop, Lisp_Object frame)
4762 struct frame *f = decode_window_system_frame (frame);
4763 Atom prop_atom;
4765 CHECK_STRING (prop);
4766 block_input ();
4767 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4768 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4770 /* Make sure the property is removed when we return. */
4771 XFlush (FRAME_X_DISPLAY (f));
4772 unblock_input ();
4774 return prop;
4778 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4779 1, 6, 0,
4780 doc: /* Value is the value of window property PROP on FRAME.
4781 If FRAME is nil or omitted, use the selected frame.
4783 On X Windows, the following optional arguments are also accepted:
4784 If TYPE is nil or omitted, get the property as a string.
4785 Otherwise TYPE is the name of the atom that denotes the type expected.
4786 If SOURCE is non-nil, get the property on that window instead of from
4787 FRAME. The number 0 denotes the root window.
4788 If DELETE-P is non-nil, delete the property after retrieving it.
4789 If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
4791 On MS Windows, this function accepts but ignores those optional arguments.
4793 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4794 no value of TYPE (always string in the MS Windows case). */)
4795 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
4796 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
4798 struct frame *f = decode_window_system_frame (frame);
4799 Atom prop_atom;
4800 int rc;
4801 Lisp_Object prop_value = Qnil;
4802 unsigned char *tmp_data = NULL;
4803 Atom actual_type;
4804 Atom target_type = XA_STRING;
4805 int actual_format;
4806 unsigned long actual_size, bytes_remaining;
4807 Window target_window = FRAME_X_WINDOW (f);
4808 struct gcpro gcpro1;
4810 GCPRO1 (prop_value);
4811 CHECK_STRING (prop);
4813 if (! NILP (source))
4815 CONS_TO_INTEGER (source, Window, target_window);
4816 if (! target_window)
4817 target_window = FRAME_X_DISPLAY_INFO (f)->root_window;
4820 block_input ();
4821 if (STRINGP (type))
4823 if (strcmp ("AnyPropertyType", SSDATA (type)) == 0)
4824 target_type = AnyPropertyType;
4825 else
4826 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4829 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4830 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4831 prop_atom, 0, 0, False, target_type,
4832 &actual_type, &actual_format, &actual_size,
4833 &bytes_remaining, &tmp_data);
4834 if (rc == Success)
4836 int size = bytes_remaining;
4838 XFree (tmp_data);
4839 tmp_data = NULL;
4841 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4842 prop_atom, 0, bytes_remaining,
4843 ! NILP (delete_p), target_type,
4844 &actual_type, &actual_format,
4845 &actual_size, &bytes_remaining,
4846 &tmp_data);
4847 if (rc == Success && tmp_data)
4849 /* The man page for XGetWindowProperty says:
4850 "If the returned format is 32, the returned data is represented
4851 as a long array and should be cast to that type to obtain the
4852 elements."
4853 This applies even if long is more than 32 bits, the X library
4854 converts from 32 bit elements received from the X server to long
4855 and passes the long array to us. Thus, for that case memcpy can not
4856 be used. We convert to a 32 bit type here, because so much code
4857 assume on that.
4859 The bytes and offsets passed to XGetWindowProperty refers to the
4860 property and those are indeed in 32 bit quantities if format is
4861 32. */
4863 if (BITS_PER_LONG > 32 && actual_format == 32)
4865 unsigned long i;
4866 int *idata = (int *) tmp_data;
4867 long *ldata = (long *) tmp_data;
4869 for (i = 0; i < actual_size; ++i)
4870 idata[i] = (int) ldata[i];
4873 if (NILP (vector_ret_p))
4874 prop_value = make_string ((char *) tmp_data, size);
4875 else
4876 prop_value = x_property_data_to_lisp (f,
4877 tmp_data,
4878 actual_type,
4879 actual_format,
4880 actual_size);
4883 if (tmp_data) XFree (tmp_data);
4886 unblock_input ();
4887 UNGCPRO;
4888 return prop_value;
4893 /***********************************************************************
4894 Busy cursor
4895 ***********************************************************************/
4897 /* Timer function of hourglass_atimer. TIMER is equal to
4898 hourglass_atimer.
4900 Display an hourglass pointer on all frames by mapping the frames'
4901 hourglass_window. Set the hourglass_p flag in the frames'
4902 output_data.x structure to indicate that an hourglass cursor is
4903 shown on the frames. */
4905 void
4906 show_hourglass (struct atimer *timer)
4908 /* The timer implementation will cancel this timer automatically
4909 after this function has run. Set hourglass_atimer to null
4910 so that we know the timer doesn't have to be canceled. */
4911 hourglass_atimer = NULL;
4913 if (!hourglass_shown_p)
4915 Lisp_Object rest, frame;
4917 block_input ();
4919 FOR_EACH_FRAME (rest, frame)
4921 struct frame *f = XFRAME (frame);
4923 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4925 Display *dpy = FRAME_X_DISPLAY (f);
4927 #ifdef USE_X_TOOLKIT
4928 if (f->output_data.x->widget)
4929 #else
4930 if (FRAME_OUTER_WINDOW (f))
4931 #endif
4933 f->output_data.x->hourglass_p = 1;
4935 if (!f->output_data.x->hourglass_window)
4937 unsigned long mask = CWCursor;
4938 XSetWindowAttributes attrs;
4939 #ifdef USE_GTK
4940 Window parent = FRAME_X_WINDOW (f);
4941 #else
4942 Window parent = FRAME_OUTER_WINDOW (f);
4943 #endif
4944 attrs.cursor = f->output_data.x->hourglass_cursor;
4946 f->output_data.x->hourglass_window
4947 = XCreateWindow (dpy, parent,
4948 0, 0, 32000, 32000, 0, 0,
4949 InputOnly,
4950 CopyFromParent,
4951 mask, &attrs);
4954 XMapRaised (dpy, f->output_data.x->hourglass_window);
4955 XFlush (dpy);
4960 hourglass_shown_p = 1;
4961 unblock_input ();
4966 /* Hide the hourglass pointer on all frames, if it is currently
4967 shown. */
4969 void
4970 hide_hourglass (void)
4972 if (hourglass_shown_p)
4974 Lisp_Object rest, frame;
4976 block_input ();
4977 FOR_EACH_FRAME (rest, frame)
4979 struct frame *f = XFRAME (frame);
4981 if (FRAME_X_P (f)
4982 /* Watch out for newly created frames. */
4983 && f->output_data.x->hourglass_window)
4985 XUnmapWindow (FRAME_X_DISPLAY (f),
4986 f->output_data.x->hourglass_window);
4987 /* Sync here because XTread_socket looks at the
4988 hourglass_p flag that is reset to zero below. */
4989 XSync (FRAME_X_DISPLAY (f), False);
4990 f->output_data.x->hourglass_p = 0;
4994 hourglass_shown_p = 0;
4995 unblock_input ();
5001 /***********************************************************************
5002 Tool tips
5003 ***********************************************************************/
5005 static Lisp_Object x_create_tip_frame (struct x_display_info *,
5006 Lisp_Object, Lisp_Object);
5007 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
5008 Lisp_Object, int, int, int *, int *);
5010 /* The frame of a currently visible tooltip. */
5012 Lisp_Object tip_frame;
5014 /* If non-nil, a timer started that hides the last tooltip when it
5015 fires. */
5017 static Lisp_Object tip_timer;
5018 Window tip_window;
5020 /* If non-nil, a vector of 3 elements containing the last args
5021 with which x-show-tip was called. See there. */
5023 static Lisp_Object last_show_tip_args;
5026 static Lisp_Object
5027 unwind_create_tip_frame (Lisp_Object frame)
5029 Lisp_Object deleted;
5031 deleted = unwind_create_frame (frame);
5032 if (EQ (deleted, Qt))
5034 tip_window = None;
5035 tip_frame = Qnil;
5038 return deleted;
5042 /* Create a frame for a tooltip on the display described by DPYINFO.
5043 PARMS is a list of frame parameters. TEXT is the string to
5044 display in the tip frame. Value is the frame.
5046 Note that functions called here, esp. x_default_parameter can
5047 signal errors, for instance when a specified color name is
5048 undefined. We have to make sure that we're in a consistent state
5049 when this happens. */
5051 static Lisp_Object
5052 x_create_tip_frame (struct x_display_info *dpyinfo,
5053 Lisp_Object parms,
5054 Lisp_Object text)
5056 struct frame *f;
5057 Lisp_Object frame;
5058 Lisp_Object name;
5059 int width, height;
5060 ptrdiff_t count = SPECPDL_INDEX ();
5061 struct gcpro gcpro1, gcpro2, gcpro3;
5062 int face_change_count_before = face_change_count;
5063 Lisp_Object buffer;
5064 struct buffer *old_buffer;
5066 if (!dpyinfo->terminal->name)
5067 error ("Terminal is not live, can't create new frames on it");
5069 parms = Fcopy_alist (parms);
5071 /* Get the name of the frame to use for resource lookup. */
5072 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
5073 if (!STRINGP (name)
5074 && !EQ (name, Qunbound)
5075 && !NILP (name))
5076 error ("Invalid frame name--not a string or nil");
5078 frame = Qnil;
5079 GCPRO3 (parms, name, frame);
5080 f = make_frame (1);
5081 XSETFRAME (frame, f);
5083 buffer = Fget_buffer_create (build_string (" *tip*"));
5084 /* Use set_window_buffer instead of Fset_window_buffer (see
5085 discussion of bug#11984, bug#12025, bug#12026). */
5086 set_window_buffer (FRAME_ROOT_WINDOW (f), buffer, 0, 0);
5087 old_buffer = current_buffer;
5088 set_buffer_internal_1 (XBUFFER (buffer));
5089 bset_truncate_lines (current_buffer, Qnil);
5090 specbind (Qinhibit_read_only, Qt);
5091 specbind (Qinhibit_modification_hooks, Qt);
5092 Ferase_buffer ();
5093 Finsert (1, &text);
5094 set_buffer_internal_1 (old_buffer);
5096 record_unwind_protect (unwind_create_tip_frame, frame);
5098 f->terminal = dpyinfo->terminal;
5100 /* By setting the output method, we're essentially saying that
5101 the frame is live, as per FRAME_LIVE_P. If we get a signal
5102 from this point on, x_destroy_window might screw up reference
5103 counts etc. */
5104 f->output_method = output_x_window;
5105 f->output_data.x = xzalloc (sizeof *f->output_data.x);
5106 f->output_data.x->icon_bitmap = -1;
5107 FRAME_FONTSET (f) = -1;
5108 f->output_data.x->scroll_bar_foreground_pixel = -1;
5109 f->output_data.x->scroll_bar_background_pixel = -1;
5110 #ifdef USE_TOOLKIT_SCROLL_BARS
5111 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
5112 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
5113 #endif /* USE_TOOLKIT_SCROLL_BARS */
5114 fset_icon_name (f, Qnil);
5115 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
5116 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
5117 f->output_data.x->explicit_parent = 0;
5119 /* These colors will be set anyway later, but it's important
5120 to get the color reference counts right, so initialize them! */
5122 Lisp_Object black;
5123 struct gcpro gcpro1;
5125 /* Function x_decode_color can signal an error. Make
5126 sure to initialize color slots so that we won't try
5127 to free colors we haven't allocated. */
5128 FRAME_FOREGROUND_PIXEL (f) = -1;
5129 FRAME_BACKGROUND_PIXEL (f) = -1;
5130 f->output_data.x->cursor_pixel = -1;
5131 f->output_data.x->cursor_foreground_pixel = -1;
5132 f->output_data.x->border_pixel = -1;
5133 f->output_data.x->mouse_pixel = -1;
5135 black = build_string ("black");
5136 GCPRO1 (black);
5137 FRAME_FOREGROUND_PIXEL (f)
5138 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5139 FRAME_BACKGROUND_PIXEL (f)
5140 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5141 f->output_data.x->cursor_pixel
5142 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5143 f->output_data.x->cursor_foreground_pixel
5144 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5145 f->output_data.x->border_pixel
5146 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5147 f->output_data.x->mouse_pixel
5148 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
5149 UNGCPRO;
5152 /* Set the name; the functions to which we pass f expect the name to
5153 be set. */
5154 if (EQ (name, Qunbound) || NILP (name))
5156 fset_name (f, build_string (dpyinfo->x_id_name));
5157 f->explicit_name = 0;
5159 else
5161 fset_name (f, name);
5162 f->explicit_name = 1;
5163 /* use the frame's title when getting resources for this frame. */
5164 specbind (Qx_resource_name, name);
5167 register_font_driver (&xfont_driver, f);
5168 #ifdef HAVE_FREETYPE
5169 #ifdef HAVE_XFT
5170 register_font_driver (&xftfont_driver, f);
5171 #else /* not HAVE_XFT */
5172 register_font_driver (&ftxfont_driver, f);
5173 #endif /* not HAVE_XFT */
5174 #endif /* HAVE_FREETYPE */
5176 x_default_parameter (f, parms, Qfont_backend, Qnil,
5177 "fontBackend", "FontBackend", RES_TYPE_STRING);
5179 /* Extract the window parameters from the supplied values that are
5180 needed to determine window geometry. */
5181 x_default_font_parameter (f, parms);
5183 x_default_parameter (f, parms, Qborder_width, make_number (0),
5184 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
5186 /* This defaults to 2 in order to match xterm. We recognize either
5187 internalBorderWidth or internalBorder (which is what xterm calls
5188 it). */
5189 if (NILP (Fassq (Qinternal_border_width, parms)))
5191 Lisp_Object value;
5193 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
5194 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
5195 if (! EQ (value, Qunbound))
5196 parms = Fcons (Fcons (Qinternal_border_width, value),
5197 parms);
5200 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
5201 "internalBorderWidth", "internalBorderWidth",
5202 RES_TYPE_NUMBER);
5204 /* Also do the stuff which must be set before the window exists. */
5205 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
5206 "foreground", "Foreground", RES_TYPE_STRING);
5207 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
5208 "background", "Background", RES_TYPE_STRING);
5209 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
5210 "pointerColor", "Foreground", RES_TYPE_STRING);
5211 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
5212 "cursorColor", "Foreground", RES_TYPE_STRING);
5213 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
5214 "borderColor", "BorderColor", RES_TYPE_STRING);
5216 #ifdef GLYPH_DEBUG
5217 image_cache_refcount =
5218 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
5219 dpyinfo_refcount = dpyinfo->reference_count;
5220 #endif /* GLYPH_DEBUG */
5222 /* Init faces before x_default_parameter is called for scroll-bar
5223 parameters because that function calls x_set_scroll_bar_width,
5224 which calls change_frame_size, which calls Fset_window_buffer,
5225 which runs hooks, which call Fvertical_motion. At the end, we
5226 end up in init_iterator with a null face cache, which should not
5227 happen. */
5228 init_frame_faces (f);
5230 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
5232 x_figure_window_size (f, parms, 0);
5235 XSetWindowAttributes attrs;
5236 unsigned long mask;
5237 Atom type = FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type_tooltip;
5239 block_input ();
5240 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
5241 if (DoesSaveUnders (dpyinfo->screen))
5242 mask |= CWSaveUnder;
5244 /* Window managers look at the override-redirect flag to determine
5245 whether or net to give windows a decoration (Xlib spec, chapter
5246 3.2.8). */
5247 attrs.override_redirect = True;
5248 attrs.save_under = True;
5249 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
5250 /* Arrange for getting MapNotify and UnmapNotify events. */
5251 attrs.event_mask = StructureNotifyMask;
5252 tip_window
5253 = FRAME_X_WINDOW (f)
5254 = XCreateWindow (FRAME_X_DISPLAY (f),
5255 FRAME_X_DISPLAY_INFO (f)->root_window,
5256 /* x, y, width, height */
5257 0, 0, 1, 1,
5258 /* Border. */
5259 f->border_width,
5260 CopyFromParent, InputOutput, CopyFromParent,
5261 mask, &attrs);
5262 XChangeProperty (FRAME_X_DISPLAY (f), tip_window,
5263 FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type,
5264 XA_ATOM, 32, PropModeReplace,
5265 (unsigned char *)&type, 1);
5266 unblock_input ();
5269 x_make_gc (f);
5271 x_default_parameter (f, parms, Qauto_raise, Qnil,
5272 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5273 x_default_parameter (f, parms, Qauto_lower, Qnil,
5274 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5275 x_default_parameter (f, parms, Qcursor_type, Qbox,
5276 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5278 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
5279 Change will not be effected unless different from the current
5280 FRAME_LINES (f). */
5281 width = FRAME_COLS (f);
5282 height = FRAME_LINES (f);
5283 SET_FRAME_COLS (f, 0);
5284 FRAME_LINES (f) = 0;
5285 change_frame_size (f, height, width, 1, 0, 0);
5287 /* Add `tooltip' frame parameter's default value. */
5288 if (NILP (Fframe_parameter (frame, Qtooltip)))
5289 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
5291 /* FIXME - can this be done in a similar way to normal frames?
5292 http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00641.html */
5294 /* Set the `display-type' frame parameter before setting up faces. */
5296 Lisp_Object disptype;
5298 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
5299 disptype = intern ("mono");
5300 else if (FRAME_X_DISPLAY_INFO (f)->visual->class == GrayScale
5301 || FRAME_X_DISPLAY_INFO (f)->visual->class == StaticGray)
5302 disptype = intern ("grayscale");
5303 else
5304 disptype = intern ("color");
5306 if (NILP (Fframe_parameter (frame, Qdisplay_type)))
5307 Fmodify_frame_parameters (frame, Fcons (Fcons (Qdisplay_type, disptype),
5308 Qnil));
5311 /* Set up faces after all frame parameters are known. This call
5312 also merges in face attributes specified for new frames.
5314 Frame parameters may be changed if .Xdefaults contains
5315 specifications for the default font. For example, if there is an
5316 `Emacs.default.attributeBackground: pink', the `background-color'
5317 attribute of the frame get's set, which let's the internal border
5318 of the tooltip frame appear in pink. Prevent this. */
5320 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
5322 /* Set tip_frame here, so that */
5323 tip_frame = frame;
5324 call2 (Qface_set_after_frame_default, frame, Qnil);
5326 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
5327 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
5328 Qnil));
5331 f->no_split = 1;
5333 UNGCPRO;
5335 /* Now that the frame will be official, it counts as a reference to
5336 its display and terminal. */
5337 FRAME_X_DISPLAY_INFO (f)->reference_count++;
5338 f->terminal->reference_count++;
5340 /* It is now ok to make the frame official even if we get an error
5341 below. And the frame needs to be on Vframe_list or making it
5342 visible won't work. */
5343 Vframe_list = Fcons (frame, Vframe_list);
5346 /* Setting attributes of faces of the tooltip frame from resources
5347 and similar will increment face_change_count, which leads to the
5348 clearing of all current matrices. Since this isn't necessary
5349 here, avoid it by resetting face_change_count to the value it
5350 had before we created the tip frame. */
5351 face_change_count = face_change_count_before;
5353 /* Discard the unwind_protect. */
5354 return unbind_to (count, frame);
5358 /* Compute where to display tip frame F. PARMS is the list of frame
5359 parameters for F. DX and DY are specified offsets from the current
5360 location of the mouse. WIDTH and HEIGHT are the width and height
5361 of the tooltip. Return coordinates relative to the root window of
5362 the display in *ROOT_X, and *ROOT_Y. */
5364 static void
5365 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)
5367 Lisp_Object left, top;
5368 int win_x, win_y;
5369 Window root, child;
5370 unsigned pmask;
5372 /* User-specified position? */
5373 left = Fcdr (Fassq (Qleft, parms));
5374 top = Fcdr (Fassq (Qtop, parms));
5376 /* Move the tooltip window where the mouse pointer is. Resize and
5377 show it. */
5378 if (!INTEGERP (left) || !INTEGERP (top))
5380 block_input ();
5381 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
5382 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
5383 unblock_input ();
5386 if (INTEGERP (top))
5387 *root_y = XINT (top);
5388 else if (*root_y + XINT (dy) <= 0)
5389 *root_y = 0; /* Can happen for negative dy */
5390 else if (*root_y + XINT (dy) + height
5391 <= x_display_pixel_height (FRAME_X_DISPLAY_INFO (f)))
5392 /* It fits below the pointer */
5393 *root_y += XINT (dy);
5394 else if (height + XINT (dy) <= *root_y)
5395 /* It fits above the pointer. */
5396 *root_y -= height + XINT (dy);
5397 else
5398 /* Put it on the top. */
5399 *root_y = 0;
5401 if (INTEGERP (left))
5402 *root_x = XINT (left);
5403 else if (*root_x + XINT (dx) <= 0)
5404 *root_x = 0; /* Can happen for negative dx */
5405 else if (*root_x + XINT (dx) + width
5406 <= x_display_pixel_width (FRAME_X_DISPLAY_INFO (f)))
5407 /* It fits to the right of the pointer. */
5408 *root_x += XINT (dx);
5409 else if (width + XINT (dx) <= *root_x)
5410 /* It fits to the left of the pointer. */
5411 *root_x -= width + XINT (dx);
5412 else
5413 /* Put it left-justified on the screen--it ought to fit that way. */
5414 *root_x = 0;
5418 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5419 doc: /* Show STRING in a "tooltip" window on frame FRAME.
5420 A tooltip window is a small X window displaying a string.
5422 This is an internal function; Lisp code should call `tooltip-show'.
5424 FRAME nil or omitted means use the selected frame.
5426 PARMS is an optional list of frame parameters which can be used to
5427 change the tooltip's appearance.
5429 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5430 means use the default timeout of 5 seconds.
5432 If the list of frame parameters PARMS contains a `left' parameters,
5433 the tooltip is displayed at that x-position. Otherwise it is
5434 displayed at the mouse position, with offset DX added (default is 5 if
5435 DX isn't specified). Likewise for the y-position; if a `top' frame
5436 parameter is specified, it determines the y-position of the tooltip
5437 window, otherwise it is displayed at the mouse position, with offset
5438 DY added (default is -10).
5440 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5441 Text larger than the specified size is clipped. */)
5442 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
5444 struct frame *f;
5445 struct window *w;
5446 int root_x, root_y;
5447 struct buffer *old_buffer;
5448 struct text_pos pos;
5449 int i, width, height, seen_reversed_p;
5450 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5451 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5452 ptrdiff_t count = SPECPDL_INDEX ();
5454 specbind (Qinhibit_redisplay, Qt);
5456 GCPRO4 (string, parms, frame, timeout);
5458 CHECK_STRING (string);
5459 if (SCHARS (string) == 0)
5460 string = make_unibyte_string (" ", 1);
5462 f = decode_window_system_frame (frame);
5463 if (NILP (timeout))
5464 timeout = make_number (5);
5465 else
5466 CHECK_NATNUM (timeout);
5468 if (NILP (dx))
5469 dx = make_number (5);
5470 else
5471 CHECK_NUMBER (dx);
5473 if (NILP (dy))
5474 dy = make_number (-10);
5475 else
5476 CHECK_NUMBER (dy);
5478 #ifdef USE_GTK
5479 if (x_gtk_use_system_tooltips)
5481 bool ok;
5483 /* Hide a previous tip, if any. */
5484 Fx_hide_tip ();
5486 block_input ();
5487 ok = xg_prepare_tooltip (f, string, &width, &height);
5488 if (ok)
5490 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5491 xg_show_tooltip (f, root_x, root_y);
5492 /* This is used in Fx_hide_tip. */
5493 XSETFRAME (tip_frame, f);
5495 unblock_input ();
5496 if (ok) goto start_timer;
5498 #endif /* USE_GTK */
5500 if (NILP (last_show_tip_args))
5501 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5503 if (!NILP (tip_frame))
5505 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5506 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5507 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5509 if (EQ (frame, last_frame)
5510 && !NILP (Fequal (last_string, string))
5511 && !NILP (Fequal (last_parms, parms)))
5513 struct frame *tip_f = XFRAME (tip_frame);
5515 /* Only DX and DY have changed. */
5516 if (!NILP (tip_timer))
5518 Lisp_Object timer = tip_timer;
5519 tip_timer = Qnil;
5520 call1 (Qcancel_timer, timer);
5523 block_input ();
5524 compute_tip_xy (tip_f, parms, dx, dy, FRAME_PIXEL_WIDTH (tip_f),
5525 FRAME_PIXEL_HEIGHT (tip_f), &root_x, &root_y);
5526 XMoveWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
5527 root_x, root_y);
5528 unblock_input ();
5529 goto start_timer;
5533 /* Hide a previous tip, if any. */
5534 Fx_hide_tip ();
5536 ASET (last_show_tip_args, 0, string);
5537 ASET (last_show_tip_args, 1, frame);
5538 ASET (last_show_tip_args, 2, parms);
5540 /* Add default values to frame parameters. */
5541 if (NILP (Fassq (Qname, parms)))
5542 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5543 if (NILP (Fassq (Qinternal_border_width, parms)))
5544 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5545 if (NILP (Fassq (Qborder_width, parms)))
5546 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5547 if (NILP (Fassq (Qborder_color, parms)))
5548 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5549 if (NILP (Fassq (Qbackground_color, parms)))
5550 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5551 parms);
5553 /* Create a frame for the tooltip, and record it in the global
5554 variable tip_frame. */
5555 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
5556 f = XFRAME (frame);
5558 /* Set up the frame's root window. */
5559 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5560 w->left_col = 0;
5561 w->top_line = 0;
5563 if (CONSP (Vx_max_tooltip_size)
5564 && RANGED_INTEGERP (1, XCAR (Vx_max_tooltip_size), INT_MAX)
5565 && RANGED_INTEGERP (1, XCDR (Vx_max_tooltip_size), INT_MAX))
5567 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
5568 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
5570 else
5572 w->total_cols = 80;
5573 w->total_lines = 40;
5576 FRAME_TOTAL_COLS (f) = w->total_cols;
5577 adjust_glyphs (f);
5578 w->pseudo_window_p = 1;
5580 /* Display the tooltip text in a temporary buffer. */
5581 old_buffer = current_buffer;
5582 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->contents));
5583 bset_truncate_lines (current_buffer, Qnil);
5584 clear_glyph_matrix (w->desired_matrix);
5585 clear_glyph_matrix (w->current_matrix);
5586 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5587 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
5589 /* Compute width and height of the tooltip. */
5590 width = height = seen_reversed_p = 0;
5591 for (i = 0; i < w->desired_matrix->nrows; ++i)
5593 struct glyph_row *row = &w->desired_matrix->rows[i];
5594 struct glyph *last;
5595 int row_width;
5597 /* Stop at the first empty row at the end. */
5598 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
5599 break;
5601 /* Let the row go over the full width of the frame. */
5602 row->full_width_p = 1;
5604 row_width = row->pixel_width;
5605 if (row->used[TEXT_AREA])
5607 /* There's a glyph at the end of rows that is used to place
5608 the cursor there. Don't include the width of this glyph. */
5609 if (!row->reversed_p)
5611 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5612 if (INTEGERP (last->object))
5613 row_width -= last->pixel_width;
5615 else
5617 /* There could be a stretch glyph at the beginning of R2L
5618 rows that is produced by extend_face_to_end_of_line.
5619 Don't count that glyph. */
5620 struct glyph *g = row->glyphs[TEXT_AREA];
5622 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
5624 row_width -= g->pixel_width;
5625 seen_reversed_p = 1;
5630 height += row->height;
5631 width = max (width, row_width);
5634 /* If we've seen partial-length R2L rows, we need to re-adjust the
5635 tool-tip frame width and redisplay it again, to avoid over-wide
5636 tips due to the stretch glyph that extends R2L lines to full
5637 width of the frame. */
5638 if (seen_reversed_p)
5640 /* w->total_cols and FRAME_TOTAL_COLS want the width in columns,
5641 not in pixels. */
5642 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
5643 w->total_cols = width;
5644 FRAME_TOTAL_COLS (f) = width;
5645 adjust_glyphs (f);
5646 clear_glyph_matrix (w->desired_matrix);
5647 clear_glyph_matrix (w->current_matrix);
5648 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5649 width = height = 0;
5650 /* Recompute width and height of the tooltip. */
5651 for (i = 0; i < w->desired_matrix->nrows; ++i)
5653 struct glyph_row *row = &w->desired_matrix->rows[i];
5654 struct glyph *last;
5655 int row_width;
5657 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
5658 break;
5659 row->full_width_p = 1;
5660 row_width = row->pixel_width;
5661 if (row->used[TEXT_AREA] && !row->reversed_p)
5663 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5664 if (INTEGERP (last->object))
5665 row_width -= last->pixel_width;
5668 height += row->height;
5669 width = max (width, row_width);
5673 /* Add the frame's internal border to the width and height the X
5674 window should have. */
5675 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5676 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5678 /* Move the tooltip window where the mouse pointer is. Resize and
5679 show it. */
5680 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5682 block_input ();
5683 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5684 root_x, root_y, width, height);
5685 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5686 unblock_input ();
5688 /* Draw into the window. */
5689 w->must_be_updated_p = 1;
5690 update_single_window (w, 1);
5692 /* Restore original current buffer. */
5693 set_buffer_internal_1 (old_buffer);
5694 windows_or_buffers_changed = old_windows_or_buffers_changed;
5696 start_timer:
5697 /* Let the tip disappear after timeout seconds. */
5698 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5699 intern ("x-hide-tip"));
5701 UNGCPRO;
5702 return unbind_to (count, Qnil);
5706 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5707 doc: /* Hide the current tooltip window, if there is any.
5708 Value is t if tooltip was open, nil otherwise. */)
5709 (void)
5711 ptrdiff_t count;
5712 Lisp_Object deleted, frame, timer;
5713 struct gcpro gcpro1, gcpro2;
5715 /* Return quickly if nothing to do. */
5716 if (NILP (tip_timer) && NILP (tip_frame))
5717 return Qnil;
5719 frame = tip_frame;
5720 timer = tip_timer;
5721 GCPRO2 (frame, timer);
5722 tip_frame = tip_timer = deleted = Qnil;
5724 count = SPECPDL_INDEX ();
5725 specbind (Qinhibit_redisplay, Qt);
5726 specbind (Qinhibit_quit, Qt);
5728 if (!NILP (timer))
5729 call1 (Qcancel_timer, timer);
5731 #ifdef USE_GTK
5733 /* When using system tooltip, tip_frame is the Emacs frame on which
5734 the tip is shown. */
5735 struct frame *f = XFRAME (frame);
5736 if (FRAME_LIVE_P (f) && xg_hide_tooltip (f))
5737 frame = Qnil;
5739 #endif
5741 if (FRAMEP (frame))
5743 delete_frame (frame, Qnil);
5744 deleted = Qt;
5746 #ifdef USE_LUCID
5747 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5748 redisplay procedure is not called when a tip frame over menu
5749 items is unmapped. Redisplay the menu manually... */
5751 Widget w;
5752 struct frame *f = SELECTED_FRAME ();
5753 w = f->output_data.x->menubar_widget;
5755 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
5756 && w != NULL)
5758 block_input ();
5759 xlwmenu_redisplay (w);
5760 unblock_input ();
5763 #endif /* USE_LUCID */
5766 UNGCPRO;
5767 return unbind_to (count, deleted);
5772 /***********************************************************************
5773 File selection dialog
5774 ***********************************************************************/
5776 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5777 Sx_uses_old_gtk_dialog,
5778 0, 0, 0,
5779 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5780 (void)
5782 #ifdef USE_GTK
5783 if (use_dialog_box
5784 && use_file_dialog
5785 && window_system_available (SELECTED_FRAME ())
5786 && xg_uses_old_file_dialog ())
5787 return Qt;
5788 #endif
5789 return Qnil;
5793 #ifdef USE_MOTIF
5794 /* Callback for "OK" and "Cancel" on file selection dialog. */
5796 static void
5797 file_dialog_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5799 int *result = (int *) client_data;
5800 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
5801 *result = cb->reason;
5805 /* Callback for unmapping a file selection dialog. This is used to
5806 capture the case where a dialog is closed via a window manager's
5807 closer button, for example. Using a XmNdestroyCallback didn't work
5808 in this case. */
5810 static void
5811 file_dialog_unmap_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5813 int *result = (int *) client_data;
5814 *result = XmCR_CANCEL;
5817 static Lisp_Object
5818 clean_up_file_dialog (Lisp_Object arg)
5820 Widget dialog = XSAVE_POINTER (arg, 0);
5822 /* Clean up. */
5823 block_input ();
5824 XtUnmanageChild (dialog);
5825 XtDestroyWidget (dialog);
5826 x_menu_set_in_use (0);
5827 unblock_input ();
5829 return Qnil;
5833 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5834 doc: /* Read file name, prompting with PROMPT in directory DIR.
5835 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5836 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5837 or directory must exist.
5839 This function is only defined on NS, MS Windows, and X Windows with the
5840 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5841 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5842 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
5844 int result;
5845 struct frame *f = SELECTED_FRAME ();
5846 Lisp_Object file = Qnil;
5847 Lisp_Object decoded_file;
5848 Widget dialog, text, help;
5849 Arg al[10];
5850 int ac = 0;
5851 XmString dir_xmstring, pattern_xmstring;
5852 ptrdiff_t count = SPECPDL_INDEX ();
5853 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5855 check_window_system (f);
5857 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5859 if (popup_activated ())
5860 error ("Trying to use a menu from within a menu-entry");
5862 CHECK_STRING (prompt);
5863 CHECK_STRING (dir);
5865 /* Prevent redisplay. */
5866 specbind (Qinhibit_redisplay, Qt);
5868 block_input ();
5870 /* Create the dialog with PROMPT as title, using DIR as initial
5871 directory and using "*" as pattern. */
5872 dir = Fexpand_file_name (dir, Qnil);
5873 dir_xmstring = XmStringCreateLocalized (SSDATA (dir));
5874 pattern_xmstring = XmStringCreateLocalized ("*");
5876 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5877 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5878 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5879 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5880 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5881 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5882 "fsb", al, ac);
5883 XmStringFree (dir_xmstring);
5884 XmStringFree (pattern_xmstring);
5886 /* Add callbacks for OK and Cancel. */
5887 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5888 (XtPointer) &result);
5889 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5890 (XtPointer) &result);
5891 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5892 (XtPointer) &result);
5894 /* Remove the help button since we can't display help. */
5895 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5896 XtUnmanageChild (help);
5898 /* Mark OK button as default. */
5899 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5900 XmNshowAsDefault, True, NULL);
5902 /* If MUSTMATCH is non-nil, disable the file entry field of the
5903 dialog, so that the user must select a file from the files list
5904 box. We can't remove it because we wouldn't have a way to get at
5905 the result file name, then. */
5906 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5907 if (!NILP (mustmatch))
5909 Widget label;
5910 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5911 XtSetSensitive (text, False);
5912 XtSetSensitive (label, False);
5915 /* Manage the dialog, so that list boxes get filled. */
5916 XtManageChild (dialog);
5918 if (STRINGP (default_filename))
5920 XmString default_xmstring;
5921 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5922 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5924 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5925 XmTextFieldReplace (wtext, 0, last_pos,
5926 (SSDATA (Ffile_name_nondirectory (default_filename))));
5928 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5929 must include the path for this to work. */
5931 default_xmstring = XmStringCreateLocalized (SSDATA (default_filename));
5933 if (XmListItemExists (list, default_xmstring))
5935 int item_pos = XmListItemPos (list, default_xmstring);
5936 /* Select the item and scroll it into view. */
5937 XmListSelectPos (list, item_pos, True);
5938 XmListSetPos (list, item_pos);
5941 XmStringFree (default_xmstring);
5944 record_unwind_protect (clean_up_file_dialog, make_save_pointer (dialog));
5946 /* Process events until the user presses Cancel or OK. */
5947 x_menu_set_in_use (1);
5948 result = 0;
5949 while (result == 0)
5951 XEvent event;
5952 x_menu_wait_for_event (0);
5953 XtAppNextEvent (Xt_app_con, &event);
5954 if (event.type == KeyPress
5955 && FRAME_X_DISPLAY (f) == event.xkey.display)
5957 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5959 /* Pop down on C-g. */
5960 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5961 XtUnmanageChild (dialog);
5964 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5967 /* Get the result. */
5968 if (result == XmCR_OK)
5970 XmString text_string;
5971 String data;
5973 XtVaGetValues (dialog, XmNtextString, &text_string, NULL);
5974 XmStringGetLtoR (text_string, XmFONTLIST_DEFAULT_TAG, &data);
5975 XmStringFree (text_string);
5976 file = build_string (data);
5977 XtFree (data);
5979 else
5980 file = Qnil;
5982 unblock_input ();
5983 UNGCPRO;
5985 /* Make "Cancel" equivalent to C-g. */
5986 if (NILP (file))
5987 Fsignal (Qquit, Qnil);
5989 decoded_file = DECODE_FILE (file);
5991 return unbind_to (count, decoded_file);
5994 #endif /* USE_MOTIF */
5996 #ifdef USE_GTK
5998 static Lisp_Object
5999 clean_up_dialog (Lisp_Object arg)
6001 x_menu_set_in_use (0);
6003 return Qnil;
6006 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
6007 doc: /* Read file name, prompting with PROMPT in directory DIR.
6008 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6009 selection box, if specified. If MUSTMATCH is non-nil, the returned file
6010 or directory must exist.
6012 This function is only defined on NS, MS Windows, and X Windows with the
6013 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6014 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
6015 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
6017 FRAME_PTR f = SELECTED_FRAME ();
6018 char *fn;
6019 Lisp_Object file = Qnil;
6020 Lisp_Object decoded_file;
6021 ptrdiff_t count = SPECPDL_INDEX ();
6022 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
6023 char *cdef_file;
6025 check_window_system (f);
6027 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
6029 if (popup_activated ())
6030 error ("Trying to use a menu from within a menu-entry");
6032 CHECK_STRING (prompt);
6033 CHECK_STRING (dir);
6035 /* Prevent redisplay. */
6036 specbind (Qinhibit_redisplay, Qt);
6037 record_unwind_protect (clean_up_dialog, Qnil);
6039 block_input ();
6041 if (STRINGP (default_filename))
6042 cdef_file = SSDATA (default_filename);
6043 else
6044 cdef_file = SSDATA (dir);
6046 fn = xg_get_file_name (f, SSDATA (prompt), cdef_file,
6047 ! NILP (mustmatch),
6048 ! NILP (only_dir_p));
6050 if (fn)
6052 file = build_string (fn);
6053 xfree (fn);
6056 unblock_input ();
6057 UNGCPRO;
6059 /* Make "Cancel" equivalent to C-g. */
6060 if (NILP (file))
6061 Fsignal (Qquit, Qnil);
6063 decoded_file = DECODE_FILE (file);
6065 return unbind_to (count, decoded_file);
6069 #ifdef HAVE_FREETYPE
6071 DEFUN ("x-select-font", Fx_select_font, Sx_select_font, 0, 2, 0,
6072 doc: /* Read a font using a GTK dialog.
6073 Return either a font spec (for GTK versions >= 3.2) or a string
6074 containing a GTK-style font name.
6076 FRAME is the frame on which to pop up the font chooser. If omitted or
6077 nil, it defaults to the selected frame. */)
6078 (Lisp_Object frame, Lisp_Object ignored)
6080 FRAME_PTR f = decode_window_system_frame (frame);
6081 Lisp_Object font;
6082 Lisp_Object font_param;
6083 char *default_name = NULL;
6084 struct gcpro gcpro1, gcpro2;
6085 ptrdiff_t count = SPECPDL_INDEX ();
6087 if (popup_activated ())
6088 error ("Trying to use a menu from within a menu-entry");
6090 /* Prevent redisplay. */
6091 specbind (Qinhibit_redisplay, Qt);
6092 record_unwind_protect (clean_up_dialog, Qnil);
6094 block_input ();
6096 GCPRO2 (font_param, font);
6098 XSETFONT (font, FRAME_FONT (f));
6099 font_param = Ffont_get (font, intern (":name"));
6100 if (STRINGP (font_param))
6101 default_name = xstrdup (SSDATA (font_param));
6102 else
6104 font_param = Fframe_parameter (frame, Qfont_param);
6105 if (STRINGP (font_param))
6106 default_name = xstrdup (SSDATA (font_param));
6109 font = xg_get_font (f, default_name);
6110 xfree (default_name);
6112 unblock_input ();
6114 if (NILP (font))
6115 Fsignal (Qquit, Qnil);
6117 return unbind_to (count, font);
6119 #endif /* HAVE_FREETYPE */
6121 #endif /* USE_GTK */
6124 /***********************************************************************
6125 Keyboard
6126 ***********************************************************************/
6128 #ifdef HAVE_XKB
6129 #include <X11/XKBlib.h>
6130 #include <X11/keysym.h>
6131 #endif
6133 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
6134 Sx_backspace_delete_keys_p, 0, 1, 0,
6135 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
6136 FRAME nil means use the selected frame.
6137 Value is t if we know that both keys are present, and are mapped to the
6138 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
6139 present and mapped to the usual X keysyms. */)
6140 (Lisp_Object frame)
6142 #ifndef HAVE_XKB
6143 return Qlambda;
6144 #else
6145 XkbDescPtr kb;
6146 struct frame *f = decode_window_system_frame (frame);
6147 Display *dpy = FRAME_X_DISPLAY (f);
6148 Lisp_Object have_keys;
6149 int major, minor, op, event, error_code;
6151 block_input ();
6153 /* Check library version in case we're dynamically linked. */
6154 major = XkbMajorVersion;
6155 minor = XkbMinorVersion;
6156 if (!XkbLibraryVersion (&major, &minor))
6158 unblock_input ();
6159 return Qlambda;
6162 /* Check that the server supports XKB. */
6163 major = XkbMajorVersion;
6164 minor = XkbMinorVersion;
6165 if (!XkbQueryExtension (dpy, &op, &event, &error_code, &major, &minor))
6167 unblock_input ();
6168 return Qlambda;
6171 /* In this code we check that the keyboard has physical keys with names
6172 that start with BKSP (Backspace) and DELE (Delete), and that they
6173 generate keysym XK_BackSpace and XK_Delete respectively.
6174 This function is used to test if normal-erase-is-backspace should be
6175 turned on.
6176 An alternative approach would be to just check if XK_BackSpace and
6177 XK_Delete are mapped to any key. But if any of those are mapped to
6178 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
6179 user doesn't know about it, it is better to return false here.
6180 It is more obvious to the user what to do if she/he has two keys
6181 clearly marked with names/symbols and one key does something not
6182 expected (i.e. she/he then tries the other).
6183 The cases where Backspace/Delete is mapped to some other key combination
6184 are rare, and in those cases, normal-erase-is-backspace can be turned on
6185 manually. */
6187 have_keys = Qnil;
6188 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
6189 if (kb)
6191 int delete_keycode = 0, backspace_keycode = 0, i;
6193 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
6195 for (i = kb->min_key_code;
6196 (i < kb->max_key_code
6197 && (delete_keycode == 0 || backspace_keycode == 0));
6198 ++i)
6200 /* The XKB symbolic key names can be seen most easily in
6201 the PS file generated by `xkbprint -label name
6202 $DISPLAY'. */
6203 if (memcmp ("DELE", kb->names->keys[i].name, 4) == 0)
6204 delete_keycode = i;
6205 else if (memcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
6206 backspace_keycode = i;
6209 XkbFreeNames (kb, 0, True);
6212 XkbFreeClientMap (kb, 0, True);
6214 if (delete_keycode
6215 && backspace_keycode
6216 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
6217 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
6218 have_keys = Qt;
6220 unblock_input ();
6221 return have_keys;
6222 #endif
6227 /***********************************************************************
6228 Initialization
6229 ***********************************************************************/
6231 /* Keep this list in the same order as frame_parms in frame.c.
6232 Use 0 for unsupported frame parameters. */
6234 frame_parm_handler x_frame_parm_handlers[] =
6236 x_set_autoraise,
6237 x_set_autolower,
6238 x_set_background_color,
6239 x_set_border_color,
6240 x_set_border_width,
6241 x_set_cursor_color,
6242 x_set_cursor_type,
6243 x_set_font,
6244 x_set_foreground_color,
6245 x_set_icon_name,
6246 x_set_icon_type,
6247 x_set_internal_border_width,
6248 x_set_menu_bar_lines,
6249 x_set_mouse_color,
6250 x_explicitly_set_name,
6251 x_set_scroll_bar_width,
6252 x_set_title,
6253 x_set_unsplittable,
6254 x_set_vertical_scroll_bars,
6255 x_set_visibility,
6256 x_set_tool_bar_lines,
6257 x_set_scroll_bar_foreground,
6258 x_set_scroll_bar_background,
6259 x_set_screen_gamma,
6260 x_set_line_spacing,
6261 x_set_fringe_width,
6262 x_set_fringe_width,
6263 x_set_wait_for_wm,
6264 x_set_fullscreen,
6265 x_set_font_backend,
6266 x_set_alpha,
6267 x_set_sticky,
6268 x_set_tool_bar_position,
6271 void
6272 syms_of_xfns (void)
6274 /* The section below is built by the lisp expression at the top of the file,
6275 just above where these variables are declared. */
6276 /*&&& init symbols here &&&*/
6277 DEFSYM (Qsuppress_icon, "suppress-icon");
6278 DEFSYM (Qundefined_color, "undefined-color");
6279 DEFSYM (Qcompound_text, "compound-text");
6280 DEFSYM (Qcancel_timer, "cancel-timer");
6281 DEFSYM (Qgeometry, "geometry");
6282 DEFSYM (Qworkarea, "workarea");
6283 DEFSYM (Qmm_size, "mm-size");
6284 DEFSYM (Qframes, "frames");
6285 DEFSYM (Qsource, "source");
6286 DEFSYM (Qfont_param, "font-parameter");
6287 /* This is the end of symbol initialization. */
6289 Fput (Qundefined_color, Qerror_conditions,
6290 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
6291 Fput (Qundefined_color, Qerror_message,
6292 build_pure_c_string ("Undefined color"));
6294 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
6295 doc: /* The shape of the pointer when over text.
6296 Changing the value does not affect existing frames
6297 unless you set the mouse color. */);
6298 Vx_pointer_shape = Qnil;
6300 #if 0 /* This doesn't really do anything. */
6301 DEFVAR_LISP ("x-nontext-pointer-shape", Vx_nontext_pointer_shape,
6302 doc: /* The shape of the pointer when not over text.
6303 This variable takes effect when you create a new frame
6304 or when you set the mouse color. */);
6305 #endif
6306 Vx_nontext_pointer_shape = Qnil;
6308 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
6309 doc: /* The shape of the pointer when Emacs is busy.
6310 This variable takes effect when you create a new frame
6311 or when you set the mouse color. */);
6312 Vx_hourglass_pointer_shape = Qnil;
6314 #if 0 /* This doesn't really do anything. */
6315 DEFVAR_LISP ("x-mode-pointer-shape", Vx_mode_pointer_shape,
6316 doc: /* The shape of the pointer when over the mode line.
6317 This variable takes effect when you create a new frame
6318 or when you set the mouse color. */);
6319 #endif
6320 Vx_mode_pointer_shape = Qnil;
6322 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
6323 Vx_sensitive_text_pointer_shape,
6324 doc: /* The shape of the pointer when over mouse-sensitive text.
6325 This variable takes effect when you create a new frame
6326 or when you set the mouse color. */);
6327 Vx_sensitive_text_pointer_shape = Qnil;
6329 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
6330 Vx_window_horizontal_drag_shape,
6331 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
6332 This variable takes effect when you create a new frame
6333 or when you set the mouse color. */);
6334 Vx_window_horizontal_drag_shape = Qnil;
6336 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
6337 doc: /* A string indicating the foreground color of the cursor box. */);
6338 Vx_cursor_fore_pixel = Qnil;
6340 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
6341 doc: /* Maximum size for tooltips.
6342 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
6343 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
6345 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
6346 doc: /* Non-nil if no X window manager is in use.
6347 Emacs doesn't try to figure this out; this is always nil
6348 unless you set it to something else. */);
6349 /* We don't have any way to find this out, so set it to nil
6350 and maybe the user would like to set it to t. */
6351 Vx_no_window_manager = Qnil;
6353 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
6354 Vx_pixel_size_width_font_regexp,
6355 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
6357 Since Emacs gets width of a font matching with this regexp from
6358 PIXEL_SIZE field of the name, font finding mechanism gets faster for
6359 such a font. This is especially effective for such large fonts as
6360 Chinese, Japanese, and Korean. */);
6361 Vx_pixel_size_width_font_regexp = Qnil;
6363 /* This is not ifdef:ed, so other builds than GTK can customize it. */
6364 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", x_gtk_use_old_file_dialog,
6365 doc: /* Non-nil means prompt with the old GTK file selection dialog.
6366 If nil or if the file selection dialog is not available, the new GTK file
6367 chooser is used instead. To turn off all file dialogs set the
6368 variable `use-file-dialog'. */);
6369 x_gtk_use_old_file_dialog = 0;
6371 DEFVAR_BOOL ("x-gtk-show-hidden-files", x_gtk_show_hidden_files,
6372 doc: /* If non-nil, the GTK file chooser will by default show hidden files.
6373 Note that this is just the default, there is a toggle button on the file
6374 chooser to show or not show hidden files on a case by case basis. */);
6375 x_gtk_show_hidden_files = 0;
6377 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", x_gtk_file_dialog_help_text,
6378 doc: /* If non-nil, the GTK file chooser will show additional help text.
6379 If more space for files in the file chooser dialog is wanted, set this to nil
6380 to turn the additional text off. */);
6381 x_gtk_file_dialog_help_text = 1;
6383 DEFVAR_BOOL ("x-gtk-whole-detached-tool-bar", x_gtk_whole_detached_tool_bar,
6384 doc: /* If non-nil, a detached tool bar is shown in full.
6385 The default is to just show an arrow and pressing on that arrow shows
6386 the tool bar buttons. */);
6387 x_gtk_whole_detached_tool_bar = 0;
6389 DEFVAR_BOOL ("x-gtk-use-system-tooltips", x_gtk_use_system_tooltips,
6390 doc: /* If non-nil with a Gtk+ built Emacs, the Gtk+ tooltip is used.
6391 Otherwise use Emacs own tooltip implementation.
6392 When using Gtk+ tooltips, the tooltip face is not used. */);
6393 x_gtk_use_system_tooltips = 1;
6395 Fprovide (intern_c_string ("x"), Qnil);
6397 #ifdef USE_X_TOOLKIT
6398 Fprovide (intern_c_string ("x-toolkit"), Qnil);
6399 #ifdef USE_MOTIF
6400 Fprovide (intern_c_string ("motif"), Qnil);
6402 DEFVAR_LISP ("motif-version-string", Vmotif_version_string,
6403 doc: /* Version info for LessTif/Motif. */);
6404 Vmotif_version_string = build_string (XmVERSION_STRING);
6405 #endif /* USE_MOTIF */
6406 #endif /* USE_X_TOOLKIT */
6408 #ifdef USE_GTK
6409 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
6410 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
6411 But for a user it is a toolkit for X, and indeed, configure
6412 accepts --with-x-toolkit=gtk. */
6413 Fprovide (intern_c_string ("x-toolkit"), Qnil);
6414 Fprovide (intern_c_string ("gtk"), Qnil);
6415 Fprovide (intern_c_string ("move-toolbar"), Qnil);
6417 DEFVAR_LISP ("gtk-version-string", Vgtk_version_string,
6418 doc: /* Version info for GTK+. */);
6420 char gtk_version[sizeof ".." + 3 * INT_STRLEN_BOUND (int)];
6421 int len = sprintf (gtk_version, "%d.%d.%d",
6422 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
6423 Vgtk_version_string = make_pure_string (gtk_version, len, len, 0);
6425 #endif /* USE_GTK */
6427 /* X window properties. */
6428 defsubr (&Sx_change_window_property);
6429 defsubr (&Sx_delete_window_property);
6430 defsubr (&Sx_window_property);
6432 defsubr (&Sxw_display_color_p);
6433 defsubr (&Sx_display_grayscale_p);
6434 defsubr (&Sxw_color_defined_p);
6435 defsubr (&Sxw_color_values);
6436 defsubr (&Sx_server_max_request_size);
6437 defsubr (&Sx_server_vendor);
6438 defsubr (&Sx_server_version);
6439 defsubr (&Sx_display_pixel_width);
6440 defsubr (&Sx_display_pixel_height);
6441 defsubr (&Sx_display_mm_width);
6442 defsubr (&Sx_display_mm_height);
6443 defsubr (&Sx_display_screens);
6444 defsubr (&Sx_display_planes);
6445 defsubr (&Sx_display_color_cells);
6446 defsubr (&Sx_display_visual_class);
6447 defsubr (&Sx_display_backing_store);
6448 defsubr (&Sx_display_save_under);
6449 defsubr (&Sx_display_monitor_attributes_list);
6450 defsubr (&Sx_wm_set_size_hint);
6451 defsubr (&Sx_create_frame);
6452 defsubr (&Sx_open_connection);
6453 defsubr (&Sx_close_connection);
6454 defsubr (&Sx_display_list);
6455 defsubr (&Sx_synchronize);
6456 defsubr (&Sx_focus_frame);
6457 defsubr (&Sx_backspace_delete_keys_p);
6459 defsubr (&Sx_show_tip);
6460 defsubr (&Sx_hide_tip);
6461 tip_timer = Qnil;
6462 staticpro (&tip_timer);
6463 tip_frame = Qnil;
6464 staticpro (&tip_frame);
6466 last_show_tip_args = Qnil;
6467 staticpro (&last_show_tip_args);
6469 defsubr (&Sx_uses_old_gtk_dialog);
6470 #if defined (USE_MOTIF) || defined (USE_GTK)
6471 defsubr (&Sx_file_dialog);
6472 #endif
6474 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
6475 defsubr (&Sx_select_font);
6476 #endif
6479 #endif /* HAVE_X_WINDOWS */