Fix bug #10129: add positional information to "C-u C-x =".
[emacs.git] / src / xfns.c
blobf00335b5d03d4f37237ded0aa392d1504337c4d0
1 /* Functions for the X window system.
3 Copyright (C) 1989, 1992-2012 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 <setjmp.h>
24 #include <ctype.h>
25 #include <unistd.h>
27 /* This makes the fields of a Display accessible, in Xlib header files. */
29 #define XLIB_ILLEGAL_ACCESS
31 #include "lisp.h"
32 #include "xterm.h"
33 #include "frame.h"
34 #include "window.h"
35 #include "buffer.h"
36 #include "intervals.h"
37 #include "dispextern.h"
38 #include "keyboard.h"
39 #include "blockinput.h"
40 #include <epaths.h>
41 #include "character.h"
42 #include "charset.h"
43 #include "coding.h"
44 #include "fontset.h"
45 #include "systime.h"
46 #include "termhooks.h"
47 #include "atimer.h"
48 #include "termchar.h"
49 #include "font.h"
51 #ifdef HAVE_X_WINDOWS
53 #include <ctype.h>
54 #include <sys/types.h>
55 #include <sys/stat.h>
57 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
58 #include "bitmaps/gray.xbm"
59 #else
60 #include <X11/bitmaps/gray>
61 #endif
63 #include "xsettings.h"
65 #ifdef USE_GTK
66 #include "gtkutil.h"
67 #endif
69 #ifdef USE_X_TOOLKIT
70 #include <X11/Shell.h>
72 #ifndef USE_MOTIF
73 #ifdef HAVE_XAW3D
74 #include <X11/Xaw3d/Paned.h>
75 #include <X11/Xaw3d/Label.h>
76 #else /* !HAVE_XAW3D */
77 #include <X11/Xaw/Paned.h>
78 #include <X11/Xaw/Label.h>
79 #endif /* HAVE_XAW3D */
80 #endif /* USE_MOTIF */
82 #ifdef USG
83 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
84 #include <X11/Xos.h>
85 #define USG
86 #ifdef USG /* Pacify gcc -Wunused-macros. */
87 #endif
88 #else
89 #include <X11/Xos.h>
90 #endif
92 #include "widget.h"
94 #include "../lwlib/lwlib.h"
96 #ifdef USE_MOTIF
97 #include <Xm/Xm.h>
98 #include <Xm/DialogS.h>
99 #include <Xm/FileSB.h>
100 #include <Xm/List.h>
101 #include <Xm/TextF.h>
102 #endif
104 #ifdef USE_LUCID
105 #include "../lwlib/xlwmenu.h"
106 #endif
108 #if !defined (NO_EDITRES)
109 #define HACK_EDITRES
110 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
111 #endif /* not defined NO_EDITRES */
113 /* Unique id counter for widgets created by the Lucid Widget Library. */
115 extern LWLIB_ID widget_id_tick;
117 #ifdef USE_MOTIF
119 #endif /* USE_MOTIF */
121 #endif /* USE_X_TOOLKIT */
123 #ifdef USE_GTK
125 #endif /* USE_GTK */
127 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
129 /* The gray bitmap `bitmaps/gray'. This is done because xterm.c uses
130 it, and including `bitmaps/gray' more than once is a problem when
131 config.h defines `static' as an empty replacement string. */
133 int gray_bitmap_width = gray_width;
134 int gray_bitmap_height = gray_height;
135 char *gray_bitmap_bits = gray_bits;
137 /* Nonzero if using X. */
139 static int x_in_use;
141 static Lisp_Object Qnone;
142 static Lisp_Object Qsuppress_icon;
143 static Lisp_Object Qundefined_color;
144 static Lisp_Object Qcompound_text, Qcancel_timer;
145 Lisp_Object Qfont_param;
147 #if GLYPH_DEBUG
148 static ptrdiff_t image_cache_refcount;
149 static int dpyinfo_refcount;
150 #endif
152 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
153 static char *x_last_font_name;
154 #endif
156 static struct x_display_info *x_display_info_for_name (Lisp_Object);
159 /* Error if we are not connected to X. */
161 void
162 check_x (void)
164 if (! x_in_use)
165 error ("X windows are not in use or not initialized");
168 /* Nonzero if we can use mouse menus.
169 You should not call this unless HAVE_MENUS is defined. */
172 have_menus_p (void)
174 return x_in_use;
177 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
178 and checking validity for X. */
180 FRAME_PTR
181 check_x_frame (Lisp_Object frame)
183 FRAME_PTR f;
185 if (NILP (frame))
186 frame = selected_frame;
187 CHECK_LIVE_FRAME (frame);
188 f = XFRAME (frame);
189 if (! FRAME_X_P (f))
190 error ("Non-X frame used");
191 return f;
194 /* Let the user specify an X display with a Lisp object.
195 OBJECT may be nil, a frame or a terminal object.
196 nil stands for the selected frame--or, if that is not an X frame,
197 the first X display on the list. */
199 struct x_display_info *
200 check_x_display_info (Lisp_Object object)
202 struct x_display_info *dpyinfo = NULL;
204 if (NILP (object))
206 struct frame *sf = XFRAME (selected_frame);
208 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
209 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
210 else if (x_display_list != 0)
211 dpyinfo = x_display_list;
212 else
213 error ("X windows are not in use or not initialized");
215 else if (TERMINALP (object))
217 struct terminal *t = get_terminal (object, 1);
219 if (t->type != output_x_window)
220 error ("Terminal %"pI"d is not an X display", XINT (object));
222 dpyinfo = t->display_info.x;
224 else if (STRINGP (object))
225 dpyinfo = x_display_info_for_name (object);
226 else
228 FRAME_PTR f = check_x_frame (object);
229 dpyinfo = FRAME_X_DISPLAY_INFO (f);
232 return dpyinfo;
236 /* Return the Emacs frame-object corresponding to an X window.
237 It could be the frame's main window or an icon window. */
239 /* This function can be called during GC, so use GC_xxx type test macros. */
241 struct frame *
242 x_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
244 Lisp_Object tail, frame;
245 struct frame *f;
247 if (wdesc == None) return 0;
249 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
251 frame = XCAR (tail);
252 if (!FRAMEP (frame))
253 continue;
254 f = XFRAME (frame);
255 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
256 continue;
257 if (f->output_data.x->hourglass_window == wdesc)
258 return f;
259 #ifdef USE_X_TOOLKIT
260 if ((f->output_data.x->edit_widget
261 && XtWindow (f->output_data.x->edit_widget) == wdesc)
262 /* A tooltip frame? */
263 || (!f->output_data.x->edit_widget
264 && FRAME_X_WINDOW (f) == wdesc)
265 || f->output_data.x->icon_desc == wdesc)
266 return f;
267 #else /* not USE_X_TOOLKIT */
268 #ifdef USE_GTK
269 if (f->output_data.x->edit_widget)
271 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
272 struct x_output *x = f->output_data.x;
273 if (gwdesc != 0 && gwdesc == x->edit_widget)
274 return f;
276 #endif /* USE_GTK */
277 if (FRAME_X_WINDOW (f) == wdesc
278 || f->output_data.x->icon_desc == wdesc)
279 return f;
280 #endif /* not USE_X_TOOLKIT */
282 return 0;
285 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
286 /* Like x_window_to_frame but also compares the window with the widget's
287 windows. */
289 struct frame *
290 x_any_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
292 Lisp_Object tail, frame;
293 struct frame *f, *found;
294 struct x_output *x;
296 if (wdesc == None) return NULL;
298 found = NULL;
299 for (tail = Vframe_list; CONSP (tail) && !found; tail = XCDR (tail))
301 frame = XCAR (tail);
302 if (!FRAMEP (frame))
303 continue;
305 f = XFRAME (frame);
306 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
308 /* This frame matches if the window is any of its widgets. */
309 x = f->output_data.x;
310 if (x->hourglass_window == wdesc)
311 found = f;
312 else if (x->widget)
314 #ifdef USE_GTK
315 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
316 if (gwdesc != 0
317 && gtk_widget_get_toplevel (gwdesc) == x->widget)
318 found = f;
319 #else
320 if (wdesc == XtWindow (x->widget)
321 || wdesc == XtWindow (x->column_widget)
322 || wdesc == XtWindow (x->edit_widget))
323 found = f;
324 /* Match if the window is this frame's menubar. */
325 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
326 found = f;
327 #endif
329 else if (FRAME_X_WINDOW (f) == wdesc)
330 /* A tooltip frame. */
331 found = f;
335 return found;
338 /* Likewise, but consider only the menu bar widget. */
340 struct frame *
341 x_menubar_window_to_frame (struct x_display_info *dpyinfo, XEvent *event)
343 Window wdesc = event->xany.window;
344 Lisp_Object tail, frame;
345 struct frame *f;
346 struct x_output *x;
348 if (wdesc == None) return 0;
350 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
352 frame = XCAR (tail);
353 if (!FRAMEP (frame))
354 continue;
355 f = XFRAME (frame);
356 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
357 continue;
358 x = f->output_data.x;
359 #ifdef USE_GTK
360 if (x->menubar_widget && xg_event_is_for_menubar (f, event))
361 return f;
362 #else
363 /* Match if the window is this frame's menubar. */
364 if (x->menubar_widget
365 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
366 return f;
367 #endif
369 return 0;
372 /* Return the frame whose principal (outermost) window is WDESC.
373 If WDESC is some other (smaller) window, we return 0. */
375 struct frame *
376 x_top_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
378 Lisp_Object tail, frame;
379 struct frame *f;
380 struct x_output *x;
382 if (wdesc == None) return 0;
384 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
386 frame = XCAR (tail);
387 if (!FRAMEP (frame))
388 continue;
389 f = XFRAME (frame);
390 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
391 continue;
392 x = f->output_data.x;
394 if (x->widget)
396 /* This frame matches if the window is its topmost widget. */
397 #ifdef USE_GTK
398 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
399 if (gwdesc == x->widget)
400 return f;
401 #else
402 if (wdesc == XtWindow (x->widget))
403 return f;
404 #if 0 /* I don't know why it did this,
405 but it seems logically wrong,
406 and it causes trouble for MapNotify events. */
407 /* Match if the window is this frame's menubar. */
408 if (x->menubar_widget
409 && wdesc == XtWindow (x->menubar_widget))
410 return f;
411 #endif
412 #endif
414 else if (FRAME_X_WINDOW (f) == wdesc)
415 /* Tooltip frame. */
416 return f;
418 return 0;
420 #endif /* USE_X_TOOLKIT || USE_GTK */
424 /* Store the screen positions of frame F into XPTR and YPTR.
425 These are the positions of the containing window manager window,
426 not Emacs's own window. */
428 void
429 x_real_positions (FRAME_PTR f, int *xptr, int *yptr)
431 int win_x, win_y, outer_x IF_LINT (= 0), outer_y IF_LINT (= 0);
432 int real_x = 0, real_y = 0;
433 int had_errors = 0;
434 Window win = f->output_data.x->parent_desc;
435 Atom actual_type;
436 unsigned long actual_size, bytes_remaining;
437 int rc, actual_format;
438 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
439 long max_len = 400;
440 Display *dpy = FRAME_X_DISPLAY (f);
441 unsigned char *tmp_data = NULL;
442 Atom target_type = XA_CARDINAL;
444 BLOCK_INPUT;
446 x_catch_errors (dpy);
448 if (win == dpyinfo->root_window)
449 win = FRAME_OUTER_WINDOW (f);
451 /* This loop traverses up the containment tree until we hit the root
452 window. Window managers may intersect many windows between our window
453 and the root window. The window we find just before the root window
454 should be the outer WM window. */
455 for (;;)
457 Window wm_window, rootw;
458 Window *tmp_children;
459 unsigned int tmp_nchildren;
460 int success;
462 success = XQueryTree (FRAME_X_DISPLAY (f), win, &rootw,
463 &wm_window, &tmp_children, &tmp_nchildren);
465 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
467 /* Don't free tmp_children if XQueryTree failed. */
468 if (! success)
469 break;
471 XFree ((char *) tmp_children);
473 if (wm_window == rootw || had_errors)
474 break;
476 win = wm_window;
479 if (! had_errors)
481 unsigned int ign;
482 Window child, rootw;
484 /* Get the real coordinates for the WM window upper left corner */
485 XGetGeometry (FRAME_X_DISPLAY (f), win,
486 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
488 /* Translate real coordinates to coordinates relative to our
489 window. For our window, the upper left corner is 0, 0.
490 Since the upper left corner of the WM window is outside
491 our window, win_x and win_y will be negative:
493 ------------------ ---> x
494 | title |
495 | ----------------- v y
496 | | our window
498 XTranslateCoordinates (FRAME_X_DISPLAY (f),
500 /* From-window, to-window. */
501 FRAME_X_DISPLAY_INFO (f)->root_window,
502 FRAME_X_WINDOW (f),
504 /* From-position, to-position. */
505 real_x, real_y, &win_x, &win_y,
507 /* Child of win. */
508 &child);
510 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
512 outer_x = win_x;
513 outer_y = win_y;
515 else
517 XTranslateCoordinates (FRAME_X_DISPLAY (f),
519 /* From-window, to-window. */
520 FRAME_X_DISPLAY_INFO (f)->root_window,
521 FRAME_OUTER_WINDOW (f),
523 /* From-position, to-position. */
524 real_x, real_y, &outer_x, &outer_y,
526 /* Child of win. */
527 &child);
530 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
534 if (dpyinfo->root_window == f->output_data.x->parent_desc)
536 /* Try _NET_FRAME_EXTENTS if our parent is the root window. */
537 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_frame_extents,
538 0, max_len, False, target_type,
539 &actual_type, &actual_format, &actual_size,
540 &bytes_remaining, &tmp_data);
542 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
543 && actual_size == 4 && actual_format == 32)
545 unsigned int ign;
546 Window rootw;
547 long *fe = (long *)tmp_data;
549 XGetGeometry (FRAME_X_DISPLAY (f), win,
550 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
551 outer_x = -fe[0];
552 outer_y = -fe[2];
553 real_x -= fe[0];
554 real_y -= fe[2];
558 if (tmp_data) XFree (tmp_data);
560 x_uncatch_errors ();
562 UNBLOCK_INPUT;
564 if (had_errors) return;
566 f->x_pixels_diff = -win_x;
567 f->y_pixels_diff = -win_y;
569 FRAME_X_OUTPUT (f)->x_pixels_outer_diff = -outer_x;
570 FRAME_X_OUTPUT (f)->y_pixels_outer_diff = -outer_y;
572 *xptr = real_x;
573 *yptr = real_y;
579 /* Gamma-correct COLOR on frame F. */
581 void
582 gamma_correct (struct frame *f, XColor *color)
584 if (f->gamma)
586 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
587 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
588 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
593 /* Decide if color named COLOR_NAME is valid for use on frame F. If
594 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
595 allocate the color. Value is zero if COLOR_NAME is invalid, or
596 no color could be allocated. */
599 x_defined_color (struct frame *f, const char *color_name,
600 XColor *color, int alloc_p)
602 int success_p = 0;
603 Display *dpy = FRAME_X_DISPLAY (f);
604 Colormap cmap = FRAME_X_COLORMAP (f);
606 BLOCK_INPUT;
607 #ifdef USE_GTK
608 success_p = xg_check_special_colors (f, color_name, color);
609 #endif
610 if (!success_p)
611 success_p = XParseColor (dpy, cmap, color_name, color);
612 if (success_p && alloc_p)
613 success_p = x_alloc_nearest_color (f, cmap, color);
614 UNBLOCK_INPUT;
616 return success_p;
620 /* Return the pixel color value for color COLOR_NAME on frame F. If F
621 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
622 Signal an error if color can't be allocated. */
624 static int
625 x_decode_color (FRAME_PTR f, Lisp_Object color_name, int mono_color)
627 XColor cdef;
629 CHECK_STRING (color_name);
631 #if 0 /* Don't do this. It's wrong when we're not using the default
632 colormap, it makes freeing difficult, and it's probably not
633 an important optimization. */
634 if (strcmp (SDATA (color_name), "black") == 0)
635 return BLACK_PIX_DEFAULT (f);
636 else if (strcmp (SDATA (color_name), "white") == 0)
637 return WHITE_PIX_DEFAULT (f);
638 #endif
640 /* Return MONO_COLOR for monochrome frames. */
641 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
642 return mono_color;
644 /* x_defined_color is responsible for coping with failures
645 by looking for a near-miss. */
646 if (x_defined_color (f, SSDATA (color_name), &cdef, 1))
647 return cdef.pixel;
649 signal_error ("Undefined color", color_name);
654 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
655 the previous value of that parameter, NEW_VALUE is the new value.
656 See also the comment of wait_for_wm in struct x_output. */
658 static void
659 x_set_wait_for_wm (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
661 f->output_data.x->wait_for_wm = !NILP (new_value);
664 static void
665 x_set_tool_bar_position (struct frame *f,
666 Lisp_Object new_value,
667 Lisp_Object old_value)
669 if (! EQ (new_value, Qleft) && ! EQ (new_value, Qright)
670 && ! EQ (new_value, Qbottom) && ! EQ (new_value, Qtop))
671 return;
672 if (EQ (new_value, old_value)) return;
674 #ifdef USE_GTK
675 if (xg_change_toolbar_position (f, new_value))
676 f->tool_bar_position = new_value;
677 #endif
680 #ifdef USE_GTK
682 /* Set icon from FILE for frame F. By using GTK functions the icon
683 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
686 xg_set_icon (FRAME_PTR f, Lisp_Object file)
688 int result = 0;
689 Lisp_Object found;
691 found = x_find_image_file (file);
693 if (! NILP (found))
695 GdkPixbuf *pixbuf;
696 GError *err = NULL;
697 char *filename = SSDATA (found);
698 BLOCK_INPUT;
700 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
702 if (pixbuf)
704 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
705 pixbuf);
706 g_object_unref (pixbuf);
708 result = 1;
710 else
711 g_error_free (err);
713 UNBLOCK_INPUT;
716 return result;
720 xg_set_icon_from_xpm_data (FRAME_PTR f, const char **data)
722 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data (data);
724 if (!pixbuf)
725 return 0;
727 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), pixbuf);
728 g_object_unref (pixbuf);
729 return 1;
731 #endif /* USE_GTK */
734 /* Functions called only from `x_set_frame_param'
735 to set individual parameters.
737 If FRAME_X_WINDOW (f) is 0,
738 the frame is being created and its X-window does not exist yet.
739 In that case, just record the parameter's new value
740 in the standard place; do not attempt to change the window. */
742 static void
743 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
745 struct x_output *x = f->output_data.x;
746 unsigned long fg, old_fg;
748 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
749 old_fg = FRAME_FOREGROUND_PIXEL (f);
750 FRAME_FOREGROUND_PIXEL (f) = fg;
752 if (FRAME_X_WINDOW (f) != 0)
754 Display *dpy = FRAME_X_DISPLAY (f);
756 BLOCK_INPUT;
757 XSetForeground (dpy, x->normal_gc, fg);
758 XSetBackground (dpy, x->reverse_gc, fg);
760 if (x->cursor_pixel == old_fg)
762 unload_color (f, x->cursor_pixel);
763 x->cursor_pixel = x_copy_color (f, fg);
764 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
767 UNBLOCK_INPUT;
769 update_face_from_frame_parameter (f, Qforeground_color, arg);
771 if (FRAME_VISIBLE_P (f))
772 redraw_frame (f);
775 unload_color (f, old_fg);
778 static void
779 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
781 struct x_output *x = f->output_data.x;
782 unsigned long bg;
784 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
785 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
786 FRAME_BACKGROUND_PIXEL (f) = bg;
788 if (FRAME_X_WINDOW (f) != 0)
790 Display *dpy = FRAME_X_DISPLAY (f);
792 BLOCK_INPUT;
793 XSetBackground (dpy, x->normal_gc, bg);
794 XSetForeground (dpy, x->reverse_gc, bg);
795 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
796 XSetForeground (dpy, x->cursor_gc, bg);
798 #ifdef USE_GTK
799 xg_set_background_color (f, bg);
800 #endif
802 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
803 toolkit scroll bars. */
805 Lisp_Object bar;
806 for (bar = FRAME_SCROLL_BARS (f);
807 !NILP (bar);
808 bar = XSCROLL_BAR (bar)->next)
810 Window window = XSCROLL_BAR (bar)->x_window;
811 XSetWindowBackground (dpy, window, bg);
814 #endif /* USE_TOOLKIT_SCROLL_BARS */
816 UNBLOCK_INPUT;
817 update_face_from_frame_parameter (f, Qbackground_color, arg);
819 if (FRAME_VISIBLE_P (f))
820 redraw_frame (f);
824 static Cursor
825 make_invisible_cursor (struct frame *f)
827 Display *dpy = FRAME_X_DISPLAY (f);
828 static char const no_data[] = { 0 };
829 Pixmap pix;
830 XColor col;
831 Cursor c = 0;
833 x_catch_errors (dpy);
834 pix = XCreateBitmapFromData (dpy, FRAME_X_DISPLAY_INFO (f)->root_window,
835 no_data, 1, 1);
836 if (! x_had_errors_p (dpy) && pix != None)
838 Cursor pixc;
839 col.pixel = 0;
840 col.red = col.green = col.blue = 0;
841 col.flags = DoRed | DoGreen | DoBlue;
842 pixc = XCreatePixmapCursor (dpy, pix, pix, &col, &col, 0, 0);
843 if (! x_had_errors_p (dpy) && pixc != None)
844 c = pixc;
845 XFreePixmap (dpy, pix);
848 x_uncatch_errors ();
850 return c;
853 static void
854 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
856 struct x_output *x = f->output_data.x;
857 Display *dpy = FRAME_X_DISPLAY (f);
858 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
859 Cursor hourglass_cursor, horizontal_drag_cursor;
860 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
861 unsigned long mask_color = FRAME_BACKGROUND_PIXEL (f);
863 /* Don't let pointers be invisible. */
864 if (mask_color == pixel)
866 x_free_colors (f, &pixel, 1);
867 pixel = x_copy_color (f, FRAME_FOREGROUND_PIXEL (f));
870 unload_color (f, x->mouse_pixel);
871 x->mouse_pixel = pixel;
873 BLOCK_INPUT;
875 /* It's not okay to crash if the user selects a screwy cursor. */
876 x_catch_errors (dpy);
878 if (!NILP (Vx_pointer_shape))
880 CHECK_NUMBER (Vx_pointer_shape);
881 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
883 else
884 cursor = XCreateFontCursor (dpy, XC_xterm);
885 x_check_errors (dpy, "bad text pointer cursor: %s");
887 if (!NILP (Vx_nontext_pointer_shape))
889 CHECK_NUMBER (Vx_nontext_pointer_shape);
890 nontext_cursor
891 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
893 else
894 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
895 x_check_errors (dpy, "bad nontext pointer cursor: %s");
897 if (!NILP (Vx_hourglass_pointer_shape))
899 CHECK_NUMBER (Vx_hourglass_pointer_shape);
900 hourglass_cursor
901 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
903 else
904 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
905 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
907 if (!NILP (Vx_mode_pointer_shape))
909 CHECK_NUMBER (Vx_mode_pointer_shape);
910 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
912 else
913 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
914 x_check_errors (dpy, "bad modeline pointer cursor: %s");
916 if (!NILP (Vx_sensitive_text_pointer_shape))
918 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
919 hand_cursor
920 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
922 else
923 hand_cursor = XCreateFontCursor (dpy, XC_hand2);
925 if (!NILP (Vx_window_horizontal_drag_shape))
927 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
928 horizontal_drag_cursor
929 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
931 else
932 horizontal_drag_cursor
933 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
935 /* Check and report errors with the above calls. */
936 x_check_errors (dpy, "can't set cursor shape: %s");
937 x_uncatch_errors ();
940 XColor fore_color, back_color;
942 fore_color.pixel = x->mouse_pixel;
943 x_query_color (f, &fore_color);
944 back_color.pixel = mask_color;
945 x_query_color (f, &back_color);
947 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
948 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
949 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
950 XRecolorCursor (dpy, hand_cursor, &fore_color, &back_color);
951 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
952 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
955 if (FRAME_X_WINDOW (f) != 0)
956 XDefineCursor (dpy, FRAME_X_WINDOW (f),
957 f->output_data.x->current_cursor = cursor);
959 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor == 0)
960 FRAME_X_DISPLAY_INFO (f)->invisible_cursor = make_invisible_cursor (f);
962 if (cursor != x->text_cursor
963 && x->text_cursor != 0)
964 XFreeCursor (dpy, x->text_cursor);
965 x->text_cursor = cursor;
967 if (nontext_cursor != x->nontext_cursor
968 && x->nontext_cursor != 0)
969 XFreeCursor (dpy, x->nontext_cursor);
970 x->nontext_cursor = nontext_cursor;
972 if (hourglass_cursor != x->hourglass_cursor
973 && x->hourglass_cursor != 0)
974 XFreeCursor (dpy, x->hourglass_cursor);
975 x->hourglass_cursor = hourglass_cursor;
977 if (mode_cursor != x->modeline_cursor
978 && x->modeline_cursor != 0)
979 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
980 x->modeline_cursor = mode_cursor;
982 if (hand_cursor != x->hand_cursor
983 && x->hand_cursor != 0)
984 XFreeCursor (dpy, x->hand_cursor);
985 x->hand_cursor = hand_cursor;
987 if (horizontal_drag_cursor != x->horizontal_drag_cursor
988 && x->horizontal_drag_cursor != 0)
989 XFreeCursor (dpy, x->horizontal_drag_cursor);
990 x->horizontal_drag_cursor = horizontal_drag_cursor;
992 XFlush (dpy);
993 UNBLOCK_INPUT;
995 update_face_from_frame_parameter (f, Qmouse_color, arg);
998 static void
999 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1001 unsigned long fore_pixel, pixel;
1002 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1003 struct x_output *x = f->output_data.x;
1005 if (!NILP (Vx_cursor_fore_pixel))
1007 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1008 WHITE_PIX_DEFAULT (f));
1009 fore_pixel_allocated_p = 1;
1011 else
1012 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1014 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1015 pixel_allocated_p = 1;
1017 /* Make sure that the cursor color differs from the background color. */
1018 if (pixel == FRAME_BACKGROUND_PIXEL (f))
1020 if (pixel_allocated_p)
1022 x_free_colors (f, &pixel, 1);
1023 pixel_allocated_p = 0;
1026 pixel = x->mouse_pixel;
1027 if (pixel == fore_pixel)
1029 if (fore_pixel_allocated_p)
1031 x_free_colors (f, &fore_pixel, 1);
1032 fore_pixel_allocated_p = 0;
1034 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1038 unload_color (f, x->cursor_foreground_pixel);
1039 if (!fore_pixel_allocated_p)
1040 fore_pixel = x_copy_color (f, fore_pixel);
1041 x->cursor_foreground_pixel = fore_pixel;
1043 unload_color (f, x->cursor_pixel);
1044 if (!pixel_allocated_p)
1045 pixel = x_copy_color (f, pixel);
1046 x->cursor_pixel = pixel;
1048 if (FRAME_X_WINDOW (f) != 0)
1050 BLOCK_INPUT;
1051 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
1052 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
1053 UNBLOCK_INPUT;
1055 if (FRAME_VISIBLE_P (f))
1057 x_update_cursor (f, 0);
1058 x_update_cursor (f, 1);
1062 update_face_from_frame_parameter (f, Qcursor_color, arg);
1065 /* Set the border-color of frame F to pixel value PIX.
1066 Note that this does not fully take effect if done before
1067 F has an x-window. */
1069 static void
1070 x_set_border_pixel (struct frame *f, int pix)
1072 unload_color (f, f->output_data.x->border_pixel);
1073 f->output_data.x->border_pixel = pix;
1075 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
1077 BLOCK_INPUT;
1078 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), pix);
1079 UNBLOCK_INPUT;
1081 if (FRAME_VISIBLE_P (f))
1082 redraw_frame (f);
1086 /* Set the border-color of frame F to value described by ARG.
1087 ARG can be a string naming a color.
1088 The border-color is used for the border that is drawn by the X server.
1089 Note that this does not fully take effect if done before
1090 F has an x-window; it must be redone when the window is created.
1092 Note: this is done in two routines because of the way X10 works.
1094 Note: under X11, this is normally the province of the window manager,
1095 and so emacs' border colors may be overridden. */
1097 static void
1098 x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1100 int pix;
1102 CHECK_STRING (arg);
1103 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1104 x_set_border_pixel (f, pix);
1105 update_face_from_frame_parameter (f, Qborder_color, arg);
1109 static void
1110 x_set_cursor_type (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1112 set_frame_cursor_types (f, arg);
1114 /* Make sure the cursor gets redrawn. */
1115 cursor_type_changed = 1;
1118 static void
1119 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1121 int result;
1123 if (STRINGP (arg))
1125 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1126 return;
1128 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1129 return;
1131 BLOCK_INPUT;
1132 if (NILP (arg))
1133 result = x_text_icon (f,
1134 SSDATA ((!NILP (f->icon_name)
1135 ? f->icon_name
1136 : f->name)));
1137 else
1138 result = x_bitmap_icon (f, arg);
1140 if (result)
1142 UNBLOCK_INPUT;
1143 error ("No icon window available");
1146 XFlush (FRAME_X_DISPLAY (f));
1147 UNBLOCK_INPUT;
1150 static void
1151 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1153 int result;
1155 if (STRINGP (arg))
1157 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1158 return;
1160 else if (!NILP (arg) || NILP (oldval))
1161 return;
1163 f->icon_name = arg;
1165 if (f->output_data.x->icon_bitmap != 0)
1166 return;
1168 BLOCK_INPUT;
1170 result = x_text_icon (f,
1171 SSDATA ((!NILP (f->icon_name)
1172 ? f->icon_name
1173 : !NILP (f->title)
1174 ? f->title
1175 : f->name)));
1177 if (result)
1179 UNBLOCK_INPUT;
1180 error ("No icon window available");
1183 XFlush (FRAME_X_DISPLAY (f));
1184 UNBLOCK_INPUT;
1188 void
1189 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1191 int nlines;
1192 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1193 int olines = FRAME_MENU_BAR_LINES (f);
1194 #endif
1196 /* Right now, menu bars don't work properly in minibuf-only frames;
1197 most of the commands try to apply themselves to the minibuffer
1198 frame itself, and get an error because you can't switch buffers
1199 in or split the minibuffer window. */
1200 if (FRAME_MINIBUF_ONLY_P (f))
1201 return;
1203 if (INTEGERP (value))
1204 nlines = XINT (value);
1205 else
1206 nlines = 0;
1208 /* Make sure we redisplay all windows in this frame. */
1209 windows_or_buffers_changed++;
1211 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1212 FRAME_MENU_BAR_LINES (f) = 0;
1213 if (nlines)
1215 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1216 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1217 /* Make sure next redisplay shows the menu bar. */
1218 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1220 else
1222 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1223 free_frame_menubar (f);
1224 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1225 if (FRAME_X_P (f))
1226 f->output_data.x->menubar_widget = 0;
1228 #else /* not USE_X_TOOLKIT && not USE_GTK */
1229 FRAME_MENU_BAR_LINES (f) = nlines;
1230 resize_frame_windows (f, FRAME_LINES (f), 0);
1232 /* If the menu bar height gets changed, the internal border below
1233 the top margin has to be cleared. Also, if the menu bar gets
1234 larger, the area for the added lines has to be cleared except for
1235 the first menu bar line that is to be drawn later. */
1236 if (nlines != olines)
1238 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1239 int width = FRAME_PIXEL_WIDTH (f);
1240 int y;
1242 /* height can be zero here. */
1243 if (height > 0 && width > 0)
1245 y = FRAME_TOP_MARGIN_HEIGHT (f);
1247 BLOCK_INPUT;
1248 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1249 0, y, width, height, False);
1250 UNBLOCK_INPUT;
1253 if (nlines > 1 && nlines > olines)
1255 y = (olines == 0 ? 1 : olines) * FRAME_LINE_HEIGHT (f);
1256 height = nlines * FRAME_LINE_HEIGHT (f) - y;
1258 BLOCK_INPUT;
1259 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1260 0, y, width, height, False);
1261 UNBLOCK_INPUT;
1264 if (nlines == 0 && WINDOWP (f->menu_bar_window))
1265 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1267 #endif /* not USE_X_TOOLKIT && not USE_GTK */
1268 adjust_glyphs (f);
1269 run_window_configuration_change_hook (f);
1273 /* Set the number of lines used for the tool bar of frame F to VALUE.
1274 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1275 is the old number of tool bar lines. This function changes the
1276 height of all windows on frame F to match the new tool bar height.
1277 The frame's height doesn't change. */
1279 void
1280 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1282 int delta, nlines, root_height;
1283 Lisp_Object root_window;
1285 /* Treat tool bars like menu bars. */
1286 if (FRAME_MINIBUF_ONLY_P (f))
1287 return;
1289 /* Use VALUE only if an integer >= 0. */
1290 if (INTEGERP (value) && XINT (value) >= 0)
1291 nlines = XFASTINT (value);
1292 else
1293 nlines = 0;
1295 #ifdef USE_GTK
1296 FRAME_TOOL_BAR_LINES (f) = 0;
1297 if (nlines)
1299 FRAME_EXTERNAL_TOOL_BAR (f) = 1;
1300 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1301 /* Make sure next redisplay shows the tool bar. */
1302 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1303 update_frame_tool_bar (f);
1305 else
1307 if (FRAME_EXTERNAL_TOOL_BAR (f))
1308 free_frame_tool_bar (f);
1309 FRAME_EXTERNAL_TOOL_BAR (f) = 0;
1312 return;
1313 #endif
1315 /* Make sure we redisplay all windows in this frame. */
1316 ++windows_or_buffers_changed;
1318 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1320 /* Don't resize the tool-bar to more than we have room for. */
1321 root_window = FRAME_ROOT_WINDOW (f);
1322 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1323 if (root_height - delta < 1)
1325 delta = root_height - 1;
1326 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1329 FRAME_TOOL_BAR_LINES (f) = nlines;
1330 resize_frame_windows (f, FRAME_LINES (f), 0);
1331 adjust_glyphs (f);
1333 /* We also have to make sure that the internal border at the top of
1334 the frame, below the menu bar or tool bar, is redrawn when the
1335 tool bar disappears. This is so because the internal border is
1336 below the tool bar if one is displayed, but is below the menu bar
1337 if there isn't a tool bar. The tool bar draws into the area
1338 below the menu bar. */
1339 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1341 clear_frame (f);
1342 clear_current_matrices (f);
1345 /* If the tool bar gets smaller, the internal border below it
1346 has to be cleared. It was formerly part of the display
1347 of the larger tool bar, and updating windows won't clear it. */
1348 if (delta < 0)
1350 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1351 int width = FRAME_PIXEL_WIDTH (f);
1352 int y = (FRAME_MENU_BAR_LINES (f) + nlines) * FRAME_LINE_HEIGHT (f);
1354 /* height can be zero here. */
1355 if (height > 0 && width > 0)
1357 BLOCK_INPUT;
1358 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1359 0, y, width, height, False);
1360 UNBLOCK_INPUT;
1363 if (WINDOWP (f->tool_bar_window))
1364 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1367 run_window_configuration_change_hook (f);
1372 /* Set the foreground color for scroll bars on frame F to VALUE.
1373 VALUE should be a string, a color name. If it isn't a string or
1374 isn't a valid color name, do nothing. OLDVAL is the old value of
1375 the frame parameter. */
1377 static void
1378 x_set_scroll_bar_foreground (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1380 unsigned long pixel;
1382 if (STRINGP (value))
1383 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1384 else
1385 pixel = -1;
1387 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1388 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1390 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1391 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1393 /* Remove all scroll bars because they have wrong colors. */
1394 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1395 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1396 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1397 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1399 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1400 redraw_frame (f);
1405 /* Set the background color for scroll bars on frame F to VALUE VALUE
1406 should be a string, a color name. If it isn't a string or isn't a
1407 valid color name, do nothing. OLDVAL is the old value of the frame
1408 parameter. */
1410 static void
1411 x_set_scroll_bar_background (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1413 unsigned long pixel;
1415 if (STRINGP (value))
1416 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1417 else
1418 pixel = -1;
1420 if (f->output_data.x->scroll_bar_background_pixel != -1)
1421 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1423 #ifdef USE_TOOLKIT_SCROLL_BARS
1424 /* Scrollbar shadow colors. */
1425 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1427 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1428 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1430 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1432 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1433 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1435 #endif /* USE_TOOLKIT_SCROLL_BARS */
1437 f->output_data.x->scroll_bar_background_pixel = pixel;
1438 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1440 /* Remove all scroll bars because they have wrong colors. */
1441 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1442 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1443 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1444 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1446 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1447 redraw_frame (f);
1452 /* Encode Lisp string STRING as a text in a format appropriate for
1453 XICCC (X Inter Client Communication Conventions).
1455 This can call Lisp code, so callers must GCPRO.
1457 If STRING contains only ASCII characters, do no conversion and
1458 return the string data of STRING. Otherwise, encode the text by
1459 CODING_SYSTEM, and return a newly allocated memory area which
1460 should be freed by `xfree' by a caller.
1462 SELECTIONP non-zero means the string is being encoded for an X
1463 selection, so it is safe to run pre-write conversions (which
1464 may run Lisp code).
1466 Store the byte length of resulting text in *TEXT_BYTES.
1468 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1469 which means that the `encoding' of the result can be `STRING'.
1470 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1471 the result should be `COMPOUND_TEXT'. */
1473 static unsigned char *
1474 x_encode_text (Lisp_Object string, Lisp_Object coding_system, int selectionp,
1475 ptrdiff_t *text_bytes, int *stringp, int *freep)
1477 int result = string_xstring_p (string);
1478 struct coding_system coding;
1480 if (result == 0)
1482 /* No multibyte character in OBJ. We need not encode it. */
1483 *text_bytes = SBYTES (string);
1484 *stringp = 1;
1485 *freep = 0;
1486 return SDATA (string);
1489 setup_coding_system (coding_system, &coding);
1490 coding.mode |= (CODING_MODE_SAFE_ENCODING | CODING_MODE_LAST_BLOCK);
1491 /* We suppress producing escape sequences for composition. */
1492 coding.common_flags &= ~CODING_ANNOTATION_MASK;
1493 coding.destination = xnmalloc (SCHARS (string), 2);
1494 coding.dst_bytes = SCHARS (string) * 2;
1495 encode_coding_object (&coding, string, 0, 0,
1496 SCHARS (string), SBYTES (string), Qnil);
1497 *text_bytes = coding.produced;
1498 *stringp = (result == 1 || !EQ (coding_system, Qcompound_text));
1499 *freep = 1;
1500 return coding.destination;
1504 /* Set the WM name to NAME for frame F. Also set the icon name.
1505 If the frame already has an icon name, use that, otherwise set the
1506 icon name to NAME. */
1508 static void
1509 x_set_name_internal (FRAME_PTR f, Lisp_Object name)
1511 if (FRAME_X_WINDOW (f))
1513 BLOCK_INPUT;
1515 XTextProperty text, icon;
1516 ptrdiff_t bytes;
1517 int stringp;
1518 int do_free_icon_value = 0, do_free_text_value = 0;
1519 Lisp_Object coding_system;
1520 Lisp_Object encoded_name;
1521 Lisp_Object encoded_icon_name;
1522 struct gcpro gcpro1;
1524 /* As ENCODE_UTF_8 may cause GC and relocation of string data,
1525 we use it before x_encode_text that may return string data. */
1526 GCPRO1 (name);
1527 encoded_name = ENCODE_UTF_8 (name);
1528 UNGCPRO;
1530 coding_system = Qcompound_text;
1531 /* Note: Encoding strategy
1533 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1534 text.encoding. But, there are non-internationalized window
1535 managers which don't support that encoding. So, if NAME
1536 contains only ASCII and 8859-1 characters, encode it by
1537 iso-latin-1, and use "STRING" in text.encoding hoping that
1538 such window managers at least analyze this format correctly,
1539 i.e. treat 8-bit bytes as 8859-1 characters.
1541 We may also be able to use "UTF8_STRING" in text.encoding
1542 in the future which can encode all Unicode characters.
1543 But, for the moment, there's no way to know that the
1544 current window manager supports it or not.
1546 Either way, we also set the _NET_WM_NAME and _NET_WM_ICON_NAME
1547 properties. Per the EWMH specification, those two properties
1548 are always UTF8_STRING. This matches what gtk_window_set_title()
1549 does in the USE_GTK case. */
1550 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1551 &do_free_text_value);
1552 text.encoding = (stringp ? XA_STRING
1553 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1554 text.format = 8;
1555 text.nitems = bytes;
1556 if (text.nitems != bytes)
1557 error ("Window name too large");
1559 if (!STRINGP (f->icon_name))
1561 icon = text;
1562 encoded_icon_name = encoded_name;
1564 else
1566 /* See the above comment "Note: Encoding strategy". */
1567 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1568 &bytes, &stringp, &do_free_icon_value);
1569 icon.encoding = (stringp ? XA_STRING
1570 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1571 icon.format = 8;
1572 icon.nitems = bytes;
1573 if (icon.nitems != bytes)
1574 error ("Icon name too large");
1576 encoded_icon_name = ENCODE_UTF_8 (f->icon_name);
1579 #ifdef USE_GTK
1580 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1581 SSDATA (encoded_name));
1582 #else /* not USE_GTK */
1583 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1584 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1585 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_name,
1586 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1587 8, PropModeReplace,
1588 SDATA (encoded_name),
1589 SBYTES (encoded_name));
1590 #endif /* not USE_GTK */
1592 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1593 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1594 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_icon_name,
1595 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1596 8, PropModeReplace,
1597 SDATA (encoded_icon_name),
1598 SBYTES (encoded_icon_name));
1600 if (do_free_icon_value)
1601 xfree (icon.value);
1602 if (do_free_text_value)
1603 xfree (text.value);
1605 UNBLOCK_INPUT;
1609 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1610 x_id_name.
1612 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1613 name; if NAME is a string, set F's name to NAME and set
1614 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1616 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1617 suggesting a new name, which lisp code should override; if
1618 F->explicit_name is set, ignore the new name; otherwise, set it. */
1620 static void
1621 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1623 /* Make sure that requests from lisp code override requests from
1624 Emacs redisplay code. */
1625 if (explicit)
1627 /* If we're switching from explicit to implicit, we had better
1628 update the mode lines and thereby update the title. */
1629 if (f->explicit_name && NILP (name))
1630 update_mode_lines = 1;
1632 f->explicit_name = ! NILP (name);
1634 else if (f->explicit_name)
1635 return;
1637 /* If NAME is nil, set the name to the x_id_name. */
1638 if (NILP (name))
1640 /* Check for no change needed in this very common case
1641 before we do any consing. */
1642 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
1643 SSDATA (f->name)))
1644 return;
1645 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
1647 else
1648 CHECK_STRING (name);
1650 /* Don't change the name if it's already NAME. */
1651 if (! NILP (Fstring_equal (name, f->name)))
1652 return;
1654 f->name = name;
1656 /* For setting the frame title, the title parameter should override
1657 the name parameter. */
1658 if (! NILP (f->title))
1659 name = f->title;
1661 x_set_name_internal (f, name);
1664 /* This function should be called when the user's lisp code has
1665 specified a name for the frame; the name will override any set by the
1666 redisplay code. */
1667 static void
1668 x_explicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1670 x_set_name (f, arg, 1);
1673 /* This function should be called by Emacs redisplay code to set the
1674 name; names set this way will never override names set by the user's
1675 lisp code. */
1676 void
1677 x_implicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1679 x_set_name (f, arg, 0);
1682 /* Change the title of frame F to NAME.
1683 If NAME is nil, use the frame name as the title. */
1685 static void
1686 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1688 /* Don't change the title if it's already NAME. */
1689 if (EQ (name, f->title))
1690 return;
1692 update_mode_lines = 1;
1694 f->title = name;
1696 if (NILP (name))
1697 name = f->name;
1698 else
1699 CHECK_STRING (name);
1701 x_set_name_internal (f, name);
1704 void
1705 x_set_scroll_bar_default_width (struct frame *f)
1707 int wid = FRAME_COLUMN_WIDTH (f);
1708 #ifdef USE_TOOLKIT_SCROLL_BARS
1709 #ifdef USE_GTK
1710 int minw = xg_get_default_scrollbar_width ();
1711 #else
1712 int minw = 16;
1713 #endif
1714 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1715 int width = minw + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
1716 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
1717 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = width;
1718 #else
1719 /* Make the actual width at least 14 pixels and a multiple of a
1720 character width. */
1721 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
1723 /* Use all of that space (aside from required margins) for the
1724 scroll bar. */
1725 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = 0;
1726 #endif
1730 /* Record in frame F the specified or default value according to ALIST
1731 of the parameter named PROP (a Lisp symbol). If no value is
1732 specified for PROP, look for an X default for XPROP on the frame
1733 named NAME. If that is not found either, use the value DEFLT. */
1735 static Lisp_Object
1736 x_default_scroll_bar_color_parameter (struct frame *f,
1737 Lisp_Object alist, Lisp_Object prop,
1738 const char *xprop, const char *xclass,
1739 int foreground_p)
1741 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1742 Lisp_Object tem;
1744 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1745 if (EQ (tem, Qunbound))
1747 #ifdef USE_TOOLKIT_SCROLL_BARS
1749 /* See if an X resource for the scroll bar color has been
1750 specified. */
1751 tem = display_x_get_resource (dpyinfo,
1752 build_string (foreground_p
1753 ? "foreground"
1754 : "background"),
1755 empty_unibyte_string,
1756 build_string ("verticalScrollBar"),
1757 empty_unibyte_string);
1758 if (!STRINGP (tem))
1760 /* If nothing has been specified, scroll bars will use a
1761 toolkit-dependent default. Because these defaults are
1762 difficult to get at without actually creating a scroll
1763 bar, use nil to indicate that no color has been
1764 specified. */
1765 tem = Qnil;
1768 #else /* not USE_TOOLKIT_SCROLL_BARS */
1770 tem = Qnil;
1772 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1775 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
1776 return tem;
1782 #ifdef USE_X_TOOLKIT
1784 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1785 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1786 already be present because of the toolkit (Motif adds some of them,
1787 for example, but Xt doesn't). */
1789 static void
1790 hack_wm_protocols (FRAME_PTR f, Widget widget)
1792 Display *dpy = XtDisplay (widget);
1793 Window w = XtWindow (widget);
1794 int need_delete = 1;
1795 int need_focus = 1;
1796 int need_save = 1;
1798 BLOCK_INPUT;
1800 Atom type;
1801 unsigned char *catoms;
1802 int format = 0;
1803 unsigned long nitems = 0;
1804 unsigned long bytes_after;
1806 if ((XGetWindowProperty (dpy, w,
1807 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1808 (long)0, (long)100, False, XA_ATOM,
1809 &type, &format, &nitems, &bytes_after,
1810 &catoms)
1811 == Success)
1812 && format == 32 && type == XA_ATOM)
1814 Atom *atoms = (Atom *) catoms;
1815 while (nitems > 0)
1817 nitems--;
1818 if (atoms[nitems]
1819 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1820 need_delete = 0;
1821 else if (atoms[nitems]
1822 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1823 need_focus = 0;
1824 else if (atoms[nitems]
1825 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1826 need_save = 0;
1829 if (catoms)
1830 XFree (catoms);
1833 Atom props [10];
1834 int count = 0;
1835 if (need_delete)
1836 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1837 if (need_focus)
1838 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1839 if (need_save)
1840 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1841 if (count)
1842 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1843 XA_ATOM, 32, PropModeAppend,
1844 (unsigned char *) props, count);
1846 UNBLOCK_INPUT;
1848 #endif
1852 /* Support routines for XIC (X Input Context). */
1854 #ifdef HAVE_X_I18N
1856 static XFontSet xic_create_xfontset (struct frame *);
1857 static XIMStyle best_xim_style (XIMStyles *, XIMStyles *);
1860 /* Supported XIM styles, ordered by preference. */
1862 static XIMStyle supported_xim_styles[] =
1864 XIMPreeditPosition | XIMStatusArea,
1865 XIMPreeditPosition | XIMStatusNothing,
1866 XIMPreeditPosition | XIMStatusNone,
1867 XIMPreeditNothing | XIMStatusArea,
1868 XIMPreeditNothing | XIMStatusNothing,
1869 XIMPreeditNothing | XIMStatusNone,
1870 XIMPreeditNone | XIMStatusArea,
1871 XIMPreeditNone | XIMStatusNothing,
1872 XIMPreeditNone | XIMStatusNone,
1877 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1878 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1880 static const char xic_default_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1882 /* Create an Xt fontset spec from the name of a base font.
1883 If `motif' is True use the Motif syntax. */
1884 char *
1885 xic_create_fontsetname (const char *base_fontname, int motif)
1887 const char *sep = motif ? ";" : ",";
1888 char *fontsetname;
1890 /* Make a fontset name from the base font name. */
1891 if (xic_default_fontset == base_fontname)
1892 { /* There is no base font name, use the default. */
1893 ptrdiff_t len = strlen (base_fontname) + 2;
1894 fontsetname = xmalloc (len);
1895 memset (fontsetname, 0, len);
1896 strcpy (fontsetname, base_fontname);
1898 else
1900 /* Make a fontset name from the base font name.
1901 The font set will be made of the following elements:
1902 - the base font.
1903 - the base font where the charset spec is replaced by -*-*.
1904 - the same but with the family also replaced with -*-*-. */
1905 const char *p = base_fontname;
1906 ptrdiff_t i;
1908 for (i = 0; *p; p++)
1909 if (*p == '-') i++;
1910 if (i != 14)
1911 { /* As the font name doesn't conform to XLFD, we can't
1912 modify it to generalize it to allcs and allfamilies.
1913 Use the specified font plus the default. */
1914 ptrdiff_t len =
1915 strlen (base_fontname) + strlen (xic_default_fontset) + 3;
1916 fontsetname = xmalloc (len);
1917 memset (fontsetname, 0, len);
1918 strcpy (fontsetname, base_fontname);
1919 strcat (fontsetname, sep);
1920 strcat (fontsetname, xic_default_fontset);
1922 else
1924 ptrdiff_t len;
1925 const char *p1 = NULL, *p2 = NULL, *p3 = NULL;
1926 char *font_allcs = NULL;
1927 char *font_allfamilies = NULL;
1928 char *font_all = NULL;
1929 const char *allcs = "*-*-*-*-*-*-*";
1930 const char *allfamilies = "-*-*-";
1931 const char *all = "*-*-*-*-";
1932 char *base;
1934 for (i = 0, p = base_fontname; i < 8; p++)
1936 if (*p == '-')
1938 i++;
1939 if (i == 3)
1940 p1 = p + 1;
1941 else if (i == 7)
1942 p2 = p + 1;
1943 else if (i == 6)
1944 p3 = p + 1;
1947 /* If base_fontname specifies ADSTYLE, make it a
1948 wildcard. */
1949 if (*p3 != '*')
1951 ptrdiff_t diff = (p2 - p3) - 2;
1953 base = alloca (strlen (base_fontname) + 1);
1954 memcpy (base, base_fontname, p3 - base_fontname);
1955 base[p3 - base_fontname] = '*';
1956 base[(p3 - base_fontname) + 1] = '-';
1957 strcpy (base + (p3 - base_fontname) + 2, p2);
1958 p = base + (p - base_fontname) - diff;
1959 p1 = base + (p1 - base_fontname);
1960 p2 = base + (p2 - base_fontname) - diff;
1961 base_fontname = base;
1964 /* Build the font spec that matches all charsets. */
1965 len = p - base_fontname + strlen (allcs) + 1;
1966 font_allcs = (char *) alloca (len);
1967 memset (font_allcs, 0, len);
1968 memcpy (font_allcs, base_fontname, p - base_fontname);
1969 strcat (font_allcs, allcs);
1971 /* Build the font spec that matches all families and
1972 add-styles. */
1973 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
1974 font_allfamilies = (char *) alloca (len);
1975 memset (font_allfamilies, 0, len);
1976 strcpy (font_allfamilies, allfamilies);
1977 memcpy (font_allfamilies + strlen (allfamilies), p1, p - p1);
1978 strcat (font_allfamilies, allcs);
1980 /* Build the font spec that matches all. */
1981 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
1982 font_all = (char *) alloca (len);
1983 memset (font_all, 0, len);
1984 strcpy (font_all, allfamilies);
1985 strcat (font_all, all);
1986 memcpy (font_all + strlen (all) + strlen (allfamilies), p2, p - p2);
1987 strcat (font_all, allcs);
1989 /* Build the actual font set name. */
1990 len = strlen (base_fontname) + strlen (font_allcs)
1991 + strlen (font_allfamilies) + strlen (font_all) + 5;
1992 fontsetname = xmalloc (len);
1993 memset (fontsetname, 0, len);
1994 strcpy (fontsetname, base_fontname);
1995 strcat (fontsetname, sep);
1996 strcat (fontsetname, font_allcs);
1997 strcat (fontsetname, sep);
1998 strcat (fontsetname, font_allfamilies);
1999 strcat (fontsetname, sep);
2000 strcat (fontsetname, font_all);
2003 if (motif)
2004 strcat (fontsetname, ":");
2005 return fontsetname;
2007 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
2009 #ifdef DEBUG_XIC_FONTSET
2010 static void
2011 print_fontset_result (XFontSet xfs, char *name, char **missing_list,
2012 int missing_count)
2014 if (xfs)
2015 fprintf (stderr, "XIC Fontset created: %s\n", name);
2016 else
2018 fprintf (stderr, "XIC Fontset failed: %s\n", name);
2019 while (missing_count-- > 0)
2021 fprintf (stderr, " missing: %s\n", *missing_list);
2022 missing_list++;
2027 #endif
2029 static XFontSet
2030 xic_create_xfontset (struct frame *f)
2032 XFontSet xfs = NULL;
2033 struct font *font = FRAME_FONT (f);
2034 int pixel_size = font->pixel_size;
2035 Lisp_Object rest, frame;
2037 /* See if there is another frame already using same fontset. */
2038 FOR_EACH_FRAME (rest, frame)
2040 struct frame *cf = XFRAME (frame);
2042 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2043 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2044 && FRAME_FONT (f)
2045 && FRAME_FONT (f)->pixel_size == pixel_size)
2047 xfs = FRAME_XIC_FONTSET (cf);
2048 break;
2052 if (! xfs)
2054 char buf[256];
2055 char **missing_list;
2056 int missing_count;
2057 char *def_string;
2058 const char *xlfd_format = "-*-*-medium-r-normal--%d-*-*-*-*-*";
2060 sprintf (buf, xlfd_format, pixel_size);
2061 missing_list = NULL;
2062 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2063 &missing_list, &missing_count, &def_string);
2064 #ifdef DEBUG_XIC_FONTSET
2065 print_fontset_result (xfs, buf, missing_list, missing_count);
2066 #endif
2067 if (missing_list)
2068 XFreeStringList (missing_list);
2069 if (! xfs)
2071 /* List of pixel sizes most likely available. Find one that
2072 is closest to pixel_size. */
2073 int sizes[] = {0, 8, 10, 11, 12, 14, 17, 18, 20, 24, 26, 34, 0};
2074 int *smaller, *larger;
2076 for (smaller = sizes; smaller[1]; smaller++)
2077 if (smaller[1] >= pixel_size)
2078 break;
2079 larger = smaller + 1;
2080 if (*larger == pixel_size)
2081 larger++;
2082 while (*smaller || *larger)
2084 int this_size;
2086 if (! *larger)
2087 this_size = *smaller--;
2088 else if (! *smaller)
2089 this_size = *larger++;
2090 else if (pixel_size - *smaller < *larger - pixel_size)
2091 this_size = *smaller--;
2092 else
2093 this_size = *larger++;
2094 sprintf (buf, xlfd_format, this_size);
2095 missing_list = NULL;
2096 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2097 &missing_list, &missing_count, &def_string);
2098 #ifdef DEBUG_XIC_FONTSET
2099 print_fontset_result (xfs, buf, missing_list, missing_count);
2100 #endif
2101 if (missing_list)
2102 XFreeStringList (missing_list);
2103 if (xfs)
2104 break;
2107 if (! xfs)
2109 const char *last_resort = "-*-*-*-r-normal--*-*-*-*-*-*";
2111 missing_list = NULL;
2112 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), last_resort,
2113 &missing_list, &missing_count, &def_string);
2114 #ifdef DEBUG_XIC_FONTSET
2115 print_fontset_result (xfs, last_resort, missing_list, missing_count);
2116 #endif
2117 if (missing_list)
2118 XFreeStringList (missing_list);
2123 return xfs;
2126 /* Free the X fontset of frame F if it is the last frame using it. */
2128 void
2129 xic_free_xfontset (struct frame *f)
2131 Lisp_Object rest, frame;
2132 int shared_p = 0;
2134 if (!FRAME_XIC_FONTSET (f))
2135 return;
2137 /* See if there is another frame sharing the same fontset. */
2138 FOR_EACH_FRAME (rest, frame)
2140 struct frame *cf = XFRAME (frame);
2141 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2142 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2143 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2145 shared_p = 1;
2146 break;
2150 if (!shared_p)
2151 /* The fontset is not used anymore. It is safe to free it. */
2152 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2154 if (FRAME_XIC_BASE_FONTNAME (f))
2155 xfree (FRAME_XIC_BASE_FONTNAME (f));
2156 FRAME_XIC_BASE_FONTNAME (f) = NULL;
2157 FRAME_XIC_FONTSET (f) = NULL;
2161 /* Value is the best input style, given user preferences USER (already
2162 checked to be supported by Emacs), and styles supported by the
2163 input method XIM. */
2165 static XIMStyle
2166 best_xim_style (XIMStyles *user, XIMStyles *xim)
2168 int i, j;
2170 for (i = 0; i < user->count_styles; ++i)
2171 for (j = 0; j < xim->count_styles; ++j)
2172 if (user->supported_styles[i] == xim->supported_styles[j])
2173 return user->supported_styles[i];
2175 /* Return the default style. */
2176 return XIMPreeditNothing | XIMStatusNothing;
2179 /* Create XIC for frame F. */
2181 static XIMStyle xic_style;
2183 void
2184 create_frame_xic (struct frame *f)
2186 XIM xim;
2187 XIC xic = NULL;
2188 XFontSet xfs = NULL;
2190 if (FRAME_XIC (f))
2191 return;
2193 /* Create X fontset. */
2194 xfs = xic_create_xfontset (f);
2195 xim = FRAME_X_XIM (f);
2196 if (xim)
2198 XRectangle s_area;
2199 XPoint spot;
2200 XVaNestedList preedit_attr;
2201 XVaNestedList status_attr;
2203 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2204 spot.x = 0; spot.y = 1;
2206 /* Determine XIC style. */
2207 if (xic_style == 0)
2209 XIMStyles supported_list;
2210 supported_list.count_styles = (sizeof supported_xim_styles
2211 / sizeof supported_xim_styles[0]);
2212 supported_list.supported_styles = supported_xim_styles;
2213 xic_style = best_xim_style (&supported_list,
2214 FRAME_X_XIM_STYLES (f));
2217 preedit_attr = XVaCreateNestedList (0,
2218 XNFontSet, xfs,
2219 XNForeground,
2220 FRAME_FOREGROUND_PIXEL (f),
2221 XNBackground,
2222 FRAME_BACKGROUND_PIXEL (f),
2223 (xic_style & XIMPreeditPosition
2224 ? XNSpotLocation
2225 : NULL),
2226 &spot,
2227 NULL);
2228 status_attr = XVaCreateNestedList (0,
2229 XNArea,
2230 &s_area,
2231 XNFontSet,
2232 xfs,
2233 XNForeground,
2234 FRAME_FOREGROUND_PIXEL (f),
2235 XNBackground,
2236 FRAME_BACKGROUND_PIXEL (f),
2237 NULL);
2239 xic = XCreateIC (xim,
2240 XNInputStyle, xic_style,
2241 XNClientWindow, FRAME_X_WINDOW (f),
2242 XNFocusWindow, FRAME_X_WINDOW (f),
2243 XNStatusAttributes, status_attr,
2244 XNPreeditAttributes, preedit_attr,
2245 NULL);
2246 XFree (preedit_attr);
2247 XFree (status_attr);
2250 FRAME_XIC (f) = xic;
2251 FRAME_XIC_STYLE (f) = xic_style;
2252 FRAME_XIC_FONTSET (f) = xfs;
2256 /* Destroy XIC and free XIC fontset of frame F, if any. */
2258 void
2259 free_frame_xic (struct frame *f)
2261 if (FRAME_XIC (f) == NULL)
2262 return;
2264 XDestroyIC (FRAME_XIC (f));
2265 xic_free_xfontset (f);
2267 FRAME_XIC (f) = NULL;
2271 /* Place preedit area for XIC of window W's frame to specified
2272 pixel position X/Y. X and Y are relative to window W. */
2274 void
2275 xic_set_preeditarea (struct window *w, int x, int y)
2277 struct frame *f = XFRAME (w->frame);
2278 XVaNestedList attr;
2279 XPoint spot;
2281 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2282 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2283 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2284 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2285 XFree (attr);
2289 /* Place status area for XIC in bottom right corner of frame F.. */
2291 void
2292 xic_set_statusarea (struct frame *f)
2294 XIC xic = FRAME_XIC (f);
2295 XVaNestedList attr;
2296 XRectangle area;
2297 XRectangle *needed;
2299 /* Negotiate geometry of status area. If input method has existing
2300 status area, use its current size. */
2301 area.x = area.y = area.width = area.height = 0;
2302 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2303 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2304 XFree (attr);
2306 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2307 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2308 XFree (attr);
2310 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2312 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2313 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2314 XFree (attr);
2317 area.width = needed->width;
2318 area.height = needed->height;
2319 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2320 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2321 - FRAME_MENUBAR_HEIGHT (f)
2322 - FRAME_TOOLBAR_TOP_HEIGHT (f)
2323 - FRAME_INTERNAL_BORDER_WIDTH (f));
2324 XFree (needed);
2326 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2327 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2328 XFree (attr);
2332 /* Set X fontset for XIC of frame F, using base font name
2333 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2335 void
2336 xic_set_xfontset (struct frame *f, const char *base_fontname)
2338 XVaNestedList attr;
2339 XFontSet xfs;
2341 xic_free_xfontset (f);
2343 xfs = xic_create_xfontset (f);
2345 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2346 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2347 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2348 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2349 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2350 XFree (attr);
2352 FRAME_XIC_FONTSET (f) = xfs;
2355 #endif /* HAVE_X_I18N */
2359 #ifdef USE_X_TOOLKIT
2361 /* Create and set up the X widget for frame F. */
2363 static void
2364 x_window (struct frame *f, long window_prompting, int minibuffer_only)
2366 XClassHint class_hints;
2367 XSetWindowAttributes attributes;
2368 unsigned long attribute_mask;
2369 Widget shell_widget;
2370 Widget pane_widget;
2371 Widget frame_widget;
2372 Arg al [25];
2373 int ac;
2375 BLOCK_INPUT;
2377 /* Use the resource name as the top-level widget name
2378 for looking up resources. Make a non-Lisp copy
2379 for the window manager, so GC relocation won't bother it.
2381 Elsewhere we specify the window name for the window manager. */
2384 char *str = SSDATA (Vx_resource_name);
2385 f->namebuf = (char *) xmalloc (strlen (str) + 1);
2386 strcpy (f->namebuf, str);
2389 ac = 0;
2390 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2391 XtSetArg (al[ac], XtNinput, 1); ac++;
2392 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2393 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2394 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2395 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2396 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2397 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2398 applicationShellWidgetClass,
2399 FRAME_X_DISPLAY (f), al, ac);
2401 f->output_data.x->widget = shell_widget;
2402 /* maybe_set_screen_title_format (shell_widget); */
2404 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2405 (widget_value *) NULL,
2406 shell_widget, False,
2407 (lw_callback) NULL,
2408 (lw_callback) NULL,
2409 (lw_callback) NULL,
2410 (lw_callback) NULL);
2412 ac = 0;
2413 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2414 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2415 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2416 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2417 XtSetValues (pane_widget, al, ac);
2418 f->output_data.x->column_widget = pane_widget;
2420 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2421 the emacs screen when changing menubar. This reduces flickering. */
2423 ac = 0;
2424 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2425 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2426 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2427 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2428 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2429 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2430 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2431 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2432 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2433 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2434 al, ac);
2436 f->output_data.x->edit_widget = frame_widget;
2438 XtManageChild (frame_widget);
2440 /* Do some needed geometry management. */
2442 ptrdiff_t len;
2443 char *tem, shell_position[sizeof "=x++" + 4 * INT_STRLEN_BOUND (int)];
2444 Arg gal[10];
2445 int gac = 0;
2446 int extra_borders = 0;
2447 int menubar_size
2448 = (f->output_data.x->menubar_widget
2449 ? (f->output_data.x->menubar_widget->core.height
2450 + f->output_data.x->menubar_widget->core.border_width)
2451 : 0);
2453 #if 0 /* Experimentally, we now get the right results
2454 for -geometry -0-0 without this. 24 Aug 96, rms. */
2455 if (FRAME_EXTERNAL_MENU_BAR (f))
2457 Dimension ibw = 0;
2458 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2459 menubar_size += ibw;
2461 #endif
2463 f->output_data.x->menubar_height = menubar_size;
2465 #ifndef USE_LUCID
2466 /* Motif seems to need this amount added to the sizes
2467 specified for the shell widget. The Athena/Lucid widgets don't.
2468 Both conclusions reached experimentally. -- rms. */
2469 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2470 &extra_borders, NULL);
2471 extra_borders *= 2;
2472 #endif
2474 /* Convert our geometry parameters into a geometry string
2475 and specify it.
2476 Note that we do not specify here whether the position
2477 is a user-specified or program-specified one.
2478 We pass that information later, in x_wm_set_size_hints. */
2480 int left = f->left_pos;
2481 int xneg = window_prompting & XNegative;
2482 int top = f->top_pos;
2483 int yneg = window_prompting & YNegative;
2484 if (xneg)
2485 left = -left;
2486 if (yneg)
2487 top = -top;
2489 if (window_prompting & USPosition)
2490 sprintf (shell_position, "=%dx%d%c%d%c%d",
2491 FRAME_PIXEL_WIDTH (f) + extra_borders,
2492 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2493 (xneg ? '-' : '+'), left,
2494 (yneg ? '-' : '+'), top);
2495 else
2497 sprintf (shell_position, "=%dx%d",
2498 FRAME_PIXEL_WIDTH (f) + extra_borders,
2499 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2501 /* Setting x and y when the position is not specified in
2502 the geometry string will set program position in the WM hints.
2503 If Emacs had just one program position, we could set it in
2504 fallback resources, but since each make-frame call can specify
2505 different program positions, this is easier. */
2506 XtSetArg (gal[gac], XtNx, left); gac++;
2507 XtSetArg (gal[gac], XtNy, top); gac++;
2511 len = strlen (shell_position) + 1;
2512 /* We don't free this because we don't know whether
2513 it is safe to free it while the frame exists.
2514 It isn't worth the trouble of arranging to free it
2515 when the frame is deleted. */
2516 tem = (char *) xmalloc (len);
2517 strncpy (tem, shell_position, len);
2518 XtSetArg (gal[gac], XtNgeometry, tem); gac++;
2519 XtSetValues (shell_widget, gal, gac);
2522 XtManageChild (pane_widget);
2523 XtRealizeWidget (shell_widget);
2525 if (FRAME_X_EMBEDDED_P (f))
2526 XReparentWindow (FRAME_X_DISPLAY (f), XtWindow (shell_widget),
2527 f->output_data.x->parent_desc, 0, 0);
2529 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2531 validate_x_resource_name ();
2533 class_hints.res_name = SSDATA (Vx_resource_name);
2534 class_hints.res_class = SSDATA (Vx_resource_class);
2535 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2537 #ifdef HAVE_X_I18N
2538 FRAME_XIC (f) = NULL;
2539 if (use_xim)
2540 create_frame_xic (f);
2541 #endif
2543 f->output_data.x->wm_hints.input = True;
2544 f->output_data.x->wm_hints.flags |= InputHint;
2545 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2546 &f->output_data.x->wm_hints);
2548 hack_wm_protocols (f, shell_widget);
2550 #ifdef HACK_EDITRES
2551 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2552 #endif
2554 /* Do a stupid property change to force the server to generate a
2555 PropertyNotify event so that the event_stream server timestamp will
2556 be initialized to something relevant to the time we created the window.
2558 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2559 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
2560 XA_ATOM, 32, PropModeAppend,
2561 (unsigned char*) NULL, 0);
2563 /* Make all the standard events reach the Emacs frame. */
2564 attributes.event_mask = STANDARD_EVENT_SET;
2566 #ifdef HAVE_X_I18N
2567 if (FRAME_XIC (f))
2569 /* XIM server might require some X events. */
2570 unsigned long fevent = NoEventMask;
2571 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2572 attributes.event_mask |= fevent;
2574 #endif /* HAVE_X_I18N */
2576 attribute_mask = CWEventMask;
2577 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2578 attribute_mask, &attributes);
2580 XtMapWidget (frame_widget);
2582 /* x_set_name normally ignores requests to set the name if the
2583 requested name is the same as the current name. This is the one
2584 place where that assumption isn't correct; f->name is set, but
2585 the X server hasn't been told. */
2587 Lisp_Object name;
2588 int explicit = f->explicit_name;
2590 f->explicit_name = 0;
2591 name = f->name;
2592 f->name = Qnil;
2593 x_set_name (f, name, explicit);
2596 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2597 f->output_data.x->current_cursor
2598 = f->output_data.x->text_cursor);
2600 UNBLOCK_INPUT;
2602 /* This is a no-op, except under Motif. Make sure main areas are
2603 set to something reasonable, in case we get an error later. */
2604 lw_set_main_areas (pane_widget, 0, frame_widget);
2607 #else /* not USE_X_TOOLKIT */
2608 #ifdef USE_GTK
2609 static void
2610 x_window (FRAME_PTR f)
2612 if (! xg_create_frame_widgets (f))
2613 error ("Unable to create window");
2615 #ifdef HAVE_X_I18N
2616 FRAME_XIC (f) = NULL;
2617 if (use_xim)
2619 BLOCK_INPUT;
2620 create_frame_xic (f);
2621 if (FRAME_XIC (f))
2623 /* XIM server might require some X events. */
2624 unsigned long fevent = NoEventMask;
2625 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2627 if (fevent != NoEventMask)
2629 XSetWindowAttributes attributes;
2630 XWindowAttributes wattr;
2631 unsigned long attribute_mask;
2633 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2634 &wattr);
2635 attributes.event_mask = wattr.your_event_mask | fevent;
2636 attribute_mask = CWEventMask;
2637 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2638 attribute_mask, &attributes);
2641 UNBLOCK_INPUT;
2643 #endif
2646 #else /*! USE_GTK */
2647 /* Create and set up the X window for frame F. */
2649 static void
2650 x_window (struct frame *f)
2652 XClassHint class_hints;
2653 XSetWindowAttributes attributes;
2654 unsigned long attribute_mask;
2656 attributes.background_pixel = FRAME_BACKGROUND_PIXEL (f);
2657 attributes.border_pixel = f->output_data.x->border_pixel;
2658 attributes.bit_gravity = StaticGravity;
2659 attributes.backing_store = NotUseful;
2660 attributes.save_under = True;
2661 attributes.event_mask = STANDARD_EVENT_SET;
2662 attributes.colormap = FRAME_X_COLORMAP (f);
2663 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2664 | CWColormap);
2666 BLOCK_INPUT;
2667 FRAME_X_WINDOW (f)
2668 = XCreateWindow (FRAME_X_DISPLAY (f),
2669 f->output_data.x->parent_desc,
2670 f->left_pos,
2671 f->top_pos,
2672 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2673 f->border_width,
2674 CopyFromParent, /* depth */
2675 InputOutput, /* class */
2676 FRAME_X_VISUAL (f),
2677 attribute_mask, &attributes);
2679 #ifdef HAVE_X_I18N
2680 if (use_xim)
2682 create_frame_xic (f);
2683 if (FRAME_XIC (f))
2685 /* XIM server might require some X events. */
2686 unsigned long fevent = NoEventMask;
2687 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2688 attributes.event_mask |= fevent;
2689 attribute_mask = CWEventMask;
2690 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2691 attribute_mask, &attributes);
2694 #endif /* HAVE_X_I18N */
2696 validate_x_resource_name ();
2698 class_hints.res_name = SSDATA (Vx_resource_name);
2699 class_hints.res_class = SSDATA (Vx_resource_class);
2700 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2702 /* The menubar is part of the ordinary display;
2703 it does not count in addition to the height of the window. */
2704 f->output_data.x->menubar_height = 0;
2706 /* This indicates that we use the "Passive Input" input model.
2707 Unless we do this, we don't get the Focus{In,Out} events that we
2708 need to draw the cursor correctly. Accursed bureaucrats.
2709 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2711 f->output_data.x->wm_hints.input = True;
2712 f->output_data.x->wm_hints.flags |= InputHint;
2713 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2714 &f->output_data.x->wm_hints);
2715 f->output_data.x->wm_hints.icon_pixmap = None;
2717 /* Request "save yourself" and "delete window" commands from wm. */
2719 Atom protocols[2];
2720 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2721 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2722 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2725 /* x_set_name normally ignores requests to set the name if the
2726 requested name is the same as the current name. This is the one
2727 place where that assumption isn't correct; f->name is set, but
2728 the X server hasn't been told. */
2730 Lisp_Object name;
2731 int explicit = f->explicit_name;
2733 f->explicit_name = 0;
2734 name = f->name;
2735 f->name = Qnil;
2736 x_set_name (f, name, explicit);
2739 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2740 f->output_data.x->current_cursor
2741 = f->output_data.x->text_cursor);
2743 UNBLOCK_INPUT;
2745 if (FRAME_X_WINDOW (f) == 0)
2746 error ("Unable to create window");
2749 #endif /* not USE_GTK */
2750 #endif /* not USE_X_TOOLKIT */
2752 /* Verify that the icon position args for this window are valid. */
2754 static void
2755 x_icon_verify (struct frame *f, Lisp_Object parms)
2757 Lisp_Object icon_x, icon_y;
2759 /* Set the position of the icon. Note that twm groups all
2760 icons in an icon window. */
2761 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2762 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2763 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2765 CHECK_NUMBER (icon_x);
2766 CHECK_NUMBER (icon_y);
2768 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2769 error ("Both left and top icon corners of icon must be specified");
2772 /* Handle the icon stuff for this window. Perhaps later we might
2773 want an x_set_icon_position which can be called interactively as
2774 well. */
2776 static void
2777 x_icon (struct frame *f, Lisp_Object parms)
2779 Lisp_Object icon_x, icon_y;
2780 #if 0
2781 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2782 #endif
2784 /* Set the position of the icon. Note that twm groups all
2785 icons in an icon window. */
2786 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2787 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2788 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2790 CHECK_NUMBER (icon_x);
2791 CHECK_NUMBER (icon_y);
2793 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2794 error ("Both left and top icon corners of icon must be specified");
2796 BLOCK_INPUT;
2798 if (! EQ (icon_x, Qunbound))
2799 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2801 #if 0 /* x_get_arg removes the visibility parameter as a side effect,
2802 but x_create_frame still needs it. */
2803 /* Start up iconic or window? */
2804 x_wm_set_window_state
2805 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2806 Qicon)
2807 ? IconicState
2808 : NormalState));
2809 #endif
2811 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
2812 ? f->icon_name
2813 : f->name)));
2815 UNBLOCK_INPUT;
2818 /* Make the GCs needed for this window, setting the
2819 background, border and mouse colors; also create the
2820 mouse cursor and the gray border tile. */
2822 static void
2823 x_make_gc (struct frame *f)
2825 XGCValues gc_values;
2827 BLOCK_INPUT;
2829 /* Create the GCs of this frame.
2830 Note that many default values are used. */
2832 gc_values.foreground = FRAME_FOREGROUND_PIXEL (f);
2833 gc_values.background = FRAME_BACKGROUND_PIXEL (f);
2834 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2835 f->output_data.x->normal_gc
2836 = XCreateGC (FRAME_X_DISPLAY (f),
2837 FRAME_X_WINDOW (f),
2838 GCLineWidth | GCForeground | GCBackground,
2839 &gc_values);
2841 /* Reverse video style. */
2842 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2843 gc_values.background = FRAME_FOREGROUND_PIXEL (f);
2844 f->output_data.x->reverse_gc
2845 = XCreateGC (FRAME_X_DISPLAY (f),
2846 FRAME_X_WINDOW (f),
2847 GCForeground | GCBackground | GCLineWidth,
2848 &gc_values);
2850 /* Cursor has cursor-color background, background-color foreground. */
2851 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2852 gc_values.background = f->output_data.x->cursor_pixel;
2853 gc_values.fill_style = FillOpaqueStippled;
2854 f->output_data.x->cursor_gc
2855 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2856 (GCForeground | GCBackground
2857 | GCFillStyle | GCLineWidth),
2858 &gc_values);
2860 /* Reliefs. */
2861 f->output_data.x->white_relief.gc = 0;
2862 f->output_data.x->black_relief.gc = 0;
2864 /* Create the gray border tile used when the pointer is not in
2865 the frame. Since this depends on the frame's pixel values,
2866 this must be done on a per-frame basis. */
2867 f->output_data.x->border_tile
2868 = (XCreatePixmapFromBitmapData
2869 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
2870 gray_bits, gray_width, gray_height,
2871 FRAME_FOREGROUND_PIXEL (f),
2872 FRAME_BACKGROUND_PIXEL (f),
2873 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2875 UNBLOCK_INPUT;
2879 /* Free what was allocated in x_make_gc. */
2881 void
2882 x_free_gcs (struct frame *f)
2884 Display *dpy = FRAME_X_DISPLAY (f);
2886 BLOCK_INPUT;
2888 if (f->output_data.x->normal_gc)
2890 XFreeGC (dpy, f->output_data.x->normal_gc);
2891 f->output_data.x->normal_gc = 0;
2894 if (f->output_data.x->reverse_gc)
2896 XFreeGC (dpy, f->output_data.x->reverse_gc);
2897 f->output_data.x->reverse_gc = 0;
2900 if (f->output_data.x->cursor_gc)
2902 XFreeGC (dpy, f->output_data.x->cursor_gc);
2903 f->output_data.x->cursor_gc = 0;
2906 if (f->output_data.x->border_tile)
2908 XFreePixmap (dpy, f->output_data.x->border_tile);
2909 f->output_data.x->border_tile = 0;
2912 UNBLOCK_INPUT;
2916 /* Handler for signals raised during x_create_frame and
2917 x_create_tip_frame. FRAME is the frame which is partially
2918 constructed. */
2920 static Lisp_Object
2921 unwind_create_frame (Lisp_Object frame)
2923 struct frame *f = XFRAME (frame);
2925 /* If frame is already dead, nothing to do. This can happen if the
2926 display is disconnected after the frame has become official, but
2927 before x_create_frame removes the unwind protect. */
2928 if (!FRAME_LIVE_P (f))
2929 return Qnil;
2931 /* If frame is ``official'', nothing to do. */
2932 if (NILP (Fmemq (frame, Vframe_list)))
2934 #if GLYPH_DEBUG && XASSERTS
2935 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2936 #endif
2938 x_free_frame_resources (f);
2939 free_glyphs (f);
2941 #if GLYPH_DEBUG
2942 /* Check that reference counts are indeed correct. */
2943 xassert (dpyinfo->reference_count == dpyinfo_refcount);
2944 xassert (dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
2945 #endif
2946 return Qt;
2949 return Qnil;
2953 static void
2954 x_default_font_parameter (struct frame *f, Lisp_Object parms)
2956 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2957 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
2958 RES_TYPE_STRING);
2959 Lisp_Object font = Qnil;
2960 if (EQ (font_param, Qunbound))
2961 font_param = Qnil;
2963 if (NILP (font_param))
2965 /* System font should take precedence over X resources. We suggest this
2966 regardless of font-use-system-font because .emacs may not have been
2967 read yet. */
2968 const char *system_font = xsettings_get_system_font ();
2969 if (system_font)
2971 char *name = xstrdup (system_font);
2972 font = font_open_by_name (f, name);
2973 xfree (name);
2977 if (NILP (font))
2978 font = !NILP (font_param) ? font_param
2979 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
2981 if (! FONTP (font) && ! STRINGP (font))
2983 const char *names[]
2985 #ifdef HAVE_XFT
2986 /* This will find the normal Xft font. */
2987 "monospace-10",
2988 #endif
2989 "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1",
2990 "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2991 "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2992 /* This was formerly the first thing tried, but it finds
2993 too many fonts and takes too long. */
2994 "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1",
2995 /* If those didn't work, look for something which will
2996 at least work. */
2997 "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1",
2998 "fixed",
2999 NULL };
3000 int i;
3002 for (i = 0; names[i]; i++)
3004 font = font_open_by_name (f, names[i]);
3005 if (! NILP (font))
3006 break;
3008 if (NILP (font))
3009 error ("No suitable font was found");
3011 else if (!NILP (font_param))
3013 /* Remember the explicit font parameter, so we can re-apply it after
3014 we've applied the `default' face settings. */
3015 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
3018 /* This call will make X resources override any system font setting. */
3019 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
3023 DEFUN ("x-wm-set-size-hint", Fx_wm_set_size_hint, Sx_wm_set_size_hint,
3024 0, 1, 0,
3025 doc: /* Send the size hints for frame FRAME to the window manager.
3026 If FRAME is nil, use the selected frame. */)
3027 (Lisp_Object frame)
3029 struct frame *f;
3030 if (NILP (frame))
3031 frame = selected_frame;
3032 f = XFRAME (frame);
3033 BLOCK_INPUT;
3034 if (FRAME_X_P (f))
3035 x_wm_set_size_hint (f, 0, 0);
3036 UNBLOCK_INPUT;
3037 return Qnil;
3040 static void
3041 set_machine_and_pid_properties (struct frame *f)
3043 long pid = (long) getpid ();
3045 /* This will set WM_CLIENT_MACHINE and WM_LOCALE_NAME. */
3046 XSetWMProperties (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), NULL, NULL,
3047 NULL, 0, NULL, NULL, NULL);
3048 XChangeProperty (FRAME_X_DISPLAY (f),
3049 FRAME_OUTER_WINDOW (f),
3050 XInternAtom (FRAME_X_DISPLAY (f),
3051 "_NET_WM_PID",
3052 False),
3053 XA_CARDINAL, 32, PropModeReplace,
3054 (unsigned char *) &pid, 1);
3057 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
3058 1, 1, 0,
3059 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
3060 Return an Emacs frame object.
3061 PARMS is an alist of frame parameters.
3062 If the parameters specify that the frame should not have a minibuffer,
3063 and do not specify a specific minibuffer window to use,
3064 then `default-minibuffer-frame' must be a frame whose minibuffer can
3065 be shared by the new frame.
3067 This function is an internal primitive--use `make-frame' instead. */)
3068 (Lisp_Object parms)
3070 struct frame *f;
3071 Lisp_Object frame, tem;
3072 Lisp_Object name;
3073 int minibuffer_only = 0;
3074 long window_prompting = 0;
3075 int width, height;
3076 int count = SPECPDL_INDEX ();
3077 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3078 Lisp_Object display;
3079 struct x_display_info *dpyinfo = NULL;
3080 Lisp_Object parent;
3081 struct kboard *kb;
3083 parms = Fcopy_alist (parms);
3085 /* Use this general default value to start with
3086 until we know if this frame has a specified name. */
3087 Vx_resource_name = Vinvocation_name;
3089 display = x_get_arg (dpyinfo, parms, Qterminal, 0, 0, RES_TYPE_NUMBER);
3090 if (EQ (display, Qunbound))
3091 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3092 if (EQ (display, Qunbound))
3093 display = Qnil;
3094 dpyinfo = check_x_display_info (display);
3095 kb = dpyinfo->terminal->kboard;
3097 if (!dpyinfo->terminal->name)
3098 error ("Terminal is not live, can't create new frames on it");
3100 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3101 if (!STRINGP (name)
3102 && ! EQ (name, Qunbound)
3103 && ! NILP (name))
3104 error ("Invalid frame name--not a string or nil");
3106 if (STRINGP (name))
3107 Vx_resource_name = name;
3109 /* See if parent window is specified. */
3110 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3111 if (EQ (parent, Qunbound))
3112 parent = Qnil;
3113 if (! NILP (parent))
3114 CHECK_NUMBER (parent);
3116 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3117 /* No need to protect DISPLAY because that's not used after passing
3118 it to make_frame_without_minibuffer. */
3119 frame = Qnil;
3120 GCPRO4 (parms, parent, name, frame);
3121 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3122 RES_TYPE_SYMBOL);
3123 if (EQ (tem, Qnone) || NILP (tem))
3124 f = make_frame_without_minibuffer (Qnil, kb, display);
3125 else if (EQ (tem, Qonly))
3127 f = make_minibuffer_frame ();
3128 minibuffer_only = 1;
3130 else if (WINDOWP (tem))
3131 f = make_frame_without_minibuffer (tem, kb, display);
3132 else
3133 f = make_frame (1);
3135 XSETFRAME (frame, f);
3137 /* Note that X Windows does support scroll bars. */
3138 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
3140 f->terminal = dpyinfo->terminal;
3142 f->output_method = output_x_window;
3143 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
3144 memset (f->output_data.x, 0, sizeof (struct x_output));
3145 f->output_data.x->icon_bitmap = -1;
3146 FRAME_FONTSET (f) = -1;
3147 f->output_data.x->scroll_bar_foreground_pixel = -1;
3148 f->output_data.x->scroll_bar_background_pixel = -1;
3149 #ifdef USE_TOOLKIT_SCROLL_BARS
3150 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3151 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3152 #endif /* USE_TOOLKIT_SCROLL_BARS */
3154 f->icon_name
3155 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3156 RES_TYPE_STRING);
3157 if (! STRINGP (f->icon_name))
3158 f->icon_name = Qnil;
3160 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3162 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
3163 record_unwind_protect (unwind_create_frame, frame);
3165 /* These colors will be set anyway later, but it's important
3166 to get the color reference counts right, so initialize them! */
3168 Lisp_Object black;
3169 struct gcpro gcpro1;
3171 /* Function x_decode_color can signal an error. Make
3172 sure to initialize color slots so that we won't try
3173 to free colors we haven't allocated. */
3174 FRAME_FOREGROUND_PIXEL (f) = -1;
3175 FRAME_BACKGROUND_PIXEL (f) = -1;
3176 f->output_data.x->cursor_pixel = -1;
3177 f->output_data.x->cursor_foreground_pixel = -1;
3178 f->output_data.x->border_pixel = -1;
3179 f->output_data.x->mouse_pixel = -1;
3181 black = build_string ("black");
3182 GCPRO1 (black);
3183 FRAME_FOREGROUND_PIXEL (f)
3184 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3185 FRAME_BACKGROUND_PIXEL (f)
3186 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3187 f->output_data.x->cursor_pixel
3188 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3189 f->output_data.x->cursor_foreground_pixel
3190 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3191 f->output_data.x->border_pixel
3192 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3193 f->output_data.x->mouse_pixel
3194 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3195 UNGCPRO;
3198 /* Specify the parent under which to make this X window. */
3200 if (!NILP (parent))
3202 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3203 f->output_data.x->explicit_parent = 1;
3205 else
3207 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3208 f->output_data.x->explicit_parent = 0;
3211 /* Set the name; the functions to which we pass f expect the name to
3212 be set. */
3213 if (EQ (name, Qunbound) || NILP (name))
3215 f->name = build_string (dpyinfo->x_id_name);
3216 f->explicit_name = 0;
3218 else
3220 f->name = name;
3221 f->explicit_name = 1;
3222 /* use the frame's title when getting resources for this frame. */
3223 specbind (Qx_resource_name, name);
3226 f->resx = dpyinfo->resx;
3227 f->resy = dpyinfo->resy;
3229 #ifdef HAVE_FREETYPE
3230 #ifdef HAVE_XFT
3231 register_font_driver (&xftfont_driver, f);
3232 #else /* not HAVE_XFT */
3233 register_font_driver (&ftxfont_driver, f);
3234 #endif /* not HAVE_XFT */
3235 #endif /* HAVE_FREETYPE */
3236 register_font_driver (&xfont_driver, f);
3238 x_default_parameter (f, parms, Qfont_backend, Qnil,
3239 "fontBackend", "FontBackend", RES_TYPE_STRING);
3241 /* Extract the window parameters from the supplied values
3242 that are needed to determine window geometry. */
3243 x_default_font_parameter (f, parms);
3244 if (!FRAME_FONT (f))
3246 delete_frame (frame, Qnoelisp);
3247 error ("Invalid frame font");
3250 /* Frame contents get displaced if an embedded X window has a border. */
3251 if (! FRAME_X_EMBEDDED_P (f))
3252 x_default_parameter (f, parms, Qborder_width, make_number (0),
3253 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3255 /* This defaults to 1 in order to match xterm. We recognize either
3256 internalBorderWidth or internalBorder (which is what xterm calls
3257 it). */
3258 if (NILP (Fassq (Qinternal_border_width, parms)))
3260 Lisp_Object value;
3262 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3263 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3264 if (! EQ (value, Qunbound))
3265 parms = Fcons (Fcons (Qinternal_border_width, value),
3266 parms);
3268 x_default_parameter (f, parms, Qinternal_border_width,
3269 #ifdef USE_GTK /* We used to impose 0 in xg_create_frame_widgets. */
3270 make_number (0),
3271 #else
3272 make_number (1),
3273 #endif
3274 "internalBorderWidth", "internalBorderWidth",
3275 RES_TYPE_NUMBER);
3276 x_default_parameter (f, parms, Qvertical_scroll_bars,
3277 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3278 Qright,
3279 #else
3280 Qleft,
3281 #endif
3282 "verticalScrollBars", "ScrollBars",
3283 RES_TYPE_SYMBOL);
3285 /* Also do the stuff which must be set before the window exists. */
3286 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3287 "foreground", "Foreground", RES_TYPE_STRING);
3288 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3289 "background", "Background", RES_TYPE_STRING);
3290 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3291 "pointerColor", "Foreground", RES_TYPE_STRING);
3292 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3293 "borderColor", "BorderColor", RES_TYPE_STRING);
3294 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3295 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3296 x_default_parameter (f, parms, Qline_spacing, Qnil,
3297 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3298 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3299 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3300 x_default_parameter (f, parms, Qright_fringe, Qnil,
3301 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3303 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3304 "scrollBarForeground",
3305 "ScrollBarForeground", 1);
3306 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3307 "scrollBarBackground",
3308 "ScrollBarBackground", 0);
3310 #if GLYPH_DEBUG
3311 image_cache_refcount =
3312 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
3313 dpyinfo_refcount = dpyinfo->reference_count;
3314 #endif /* GLYPH_DEBUG */
3316 /* Init faces before x_default_parameter is called for scroll-bar
3317 parameters because that function calls x_set_scroll_bar_width,
3318 which calls change_frame_size, which calls Fset_window_buffer,
3319 which runs hooks, which call Fvertical_motion. At the end, we
3320 end up in init_iterator with a null face cache, which should not
3321 happen. */
3322 init_frame_faces (f);
3324 /* The X resources controlling the menu-bar and tool-bar are
3325 processed specially at startup, and reflected in the mode
3326 variables; ignore them here. */
3327 x_default_parameter (f, parms, Qmenu_bar_lines,
3328 NILP (Vmenu_bar_mode)
3329 ? make_number (0) : make_number (1),
3330 NULL, NULL, RES_TYPE_NUMBER);
3331 x_default_parameter (f, parms, Qtool_bar_lines,
3332 NILP (Vtool_bar_mode)
3333 ? make_number (0) : make_number (1),
3334 NULL, NULL, RES_TYPE_NUMBER);
3336 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3337 "bufferPredicate", "BufferPredicate",
3338 RES_TYPE_SYMBOL);
3339 x_default_parameter (f, parms, Qtitle, Qnil,
3340 "title", "Title", RES_TYPE_STRING);
3341 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3342 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3343 x_default_parameter (f, parms, Qfullscreen, Qnil,
3344 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3345 x_default_parameter (f, parms, Qtool_bar_position,
3346 f->tool_bar_position, 0, 0, RES_TYPE_SYMBOL);
3348 /* Compute the size of the X window. */
3349 window_prompting = x_figure_window_size (f, parms, 1);
3351 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3352 f->no_split = minibuffer_only || EQ (tem, Qt);
3354 x_icon_verify (f, parms);
3356 /* Create the X widget or window. */
3357 #ifdef USE_X_TOOLKIT
3358 x_window (f, window_prompting, minibuffer_only);
3359 #else
3360 x_window (f);
3361 #endif
3363 x_icon (f, parms);
3364 x_make_gc (f);
3366 /* Now consider the frame official. */
3367 f->terminal->reference_count++;
3368 FRAME_X_DISPLAY_INFO (f)->reference_count++;
3369 Vframe_list = Fcons (frame, Vframe_list);
3371 /* We need to do this after creating the X window, so that the
3372 icon-creation functions can say whose icon they're describing. */
3373 x_default_parameter (f, parms, Qicon_type, Qt,
3374 "bitmapIcon", "BitmapIcon", RES_TYPE_BOOLEAN);
3376 x_default_parameter (f, parms, Qauto_raise, Qnil,
3377 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3378 x_default_parameter (f, parms, Qauto_lower, Qnil,
3379 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3380 x_default_parameter (f, parms, Qcursor_type, Qbox,
3381 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3382 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3383 "scrollBarWidth", "ScrollBarWidth",
3384 RES_TYPE_NUMBER);
3385 x_default_parameter (f, parms, Qalpha, Qnil,
3386 "alpha", "Alpha", RES_TYPE_NUMBER);
3388 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3389 Change will not be effected unless different from the current
3390 FRAME_LINES (f). */
3391 width = FRAME_COLS (f);
3392 height = FRAME_LINES (f);
3394 SET_FRAME_COLS (f, 0);
3395 FRAME_LINES (f) = 0;
3396 change_frame_size (f, height, width, 1, 0, 0);
3398 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3399 /* Create the menu bar. */
3400 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3402 /* If this signals an error, we haven't set size hints for the
3403 frame and we didn't make it visible. */
3404 initialize_frame_menubar (f);
3406 #ifndef USE_GTK
3407 /* This is a no-op, except under Motif where it arranges the
3408 main window for the widgets on it. */
3409 lw_set_main_areas (f->output_data.x->column_widget,
3410 f->output_data.x->menubar_widget,
3411 f->output_data.x->edit_widget);
3412 #endif /* not USE_GTK */
3414 #endif /* USE_X_TOOLKIT || USE_GTK */
3416 /* Tell the server what size and position, etc, we want, and how
3417 badly we want them. This should be done after we have the menu
3418 bar so that its size can be taken into account. */
3419 BLOCK_INPUT;
3420 x_wm_set_size_hint (f, window_prompting, 0);
3421 UNBLOCK_INPUT;
3423 /* Make the window appear on the frame and enable display, unless
3424 the caller says not to. However, with explicit parent, Emacs
3425 cannot control visibility, so don't try. */
3426 if (! f->output_data.x->explicit_parent)
3428 Lisp_Object visibility;
3430 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3431 RES_TYPE_SYMBOL);
3432 if (EQ (visibility, Qunbound))
3433 visibility = Qt;
3435 if (EQ (visibility, Qicon))
3436 x_iconify_frame (f);
3437 else if (! NILP (visibility))
3438 x_make_frame_visible (f);
3439 else
3441 /* Must have been Qnil. */
3445 BLOCK_INPUT;
3447 /* Set machine name and pid for the purpose of window managers. */
3448 set_machine_and_pid_properties (f);
3450 /* Set the WM leader property. GTK does this itself, so this is not
3451 needed when using GTK. */
3452 if (dpyinfo->client_leader_window != 0)
3454 XChangeProperty (FRAME_X_DISPLAY (f),
3455 FRAME_OUTER_WINDOW (f),
3456 dpyinfo->Xatom_wm_client_leader,
3457 XA_WINDOW, 32, PropModeReplace,
3458 (unsigned char *) &dpyinfo->client_leader_window, 1);
3461 UNBLOCK_INPUT;
3463 /* Initialize `default-minibuffer-frame' in case this is the first
3464 frame on this terminal. */
3465 if (FRAME_HAS_MINIBUF_P (f)
3466 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
3467 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
3468 KVAR (kb, Vdefault_minibuffer_frame) = frame;
3470 /* All remaining specified parameters, which have not been "used"
3471 by x_get_arg and friends, now go in the misc. alist of the frame. */
3472 for (tem = parms; CONSP (tem); tem = XCDR (tem))
3473 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3474 f->param_alist = Fcons (XCAR (tem), f->param_alist);
3476 UNGCPRO;
3478 /* Make sure windows on this frame appear in calls to next-window
3479 and similar functions. */
3480 Vwindow_list = Qnil;
3482 return unbind_to (count, frame);
3486 /* FRAME is used only to get a handle on the X display. We don't pass the
3487 display info directly because we're called from frame.c, which doesn't
3488 know about that structure. */
3490 Lisp_Object
3491 x_get_focus_frame (struct frame *frame)
3493 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
3494 Lisp_Object xfocus;
3495 if (! dpyinfo->x_focus_frame)
3496 return Qnil;
3498 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3499 return xfocus;
3503 /* In certain situations, when the window manager follows a
3504 click-to-focus policy, there seems to be no way around calling
3505 XSetInputFocus to give another frame the input focus .
3507 In an ideal world, XSetInputFocus should generally be avoided so
3508 that applications don't interfere with the window manager's focus
3509 policy. But I think it's okay to use when it's clearly done
3510 following a user-command. */
3512 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
3513 doc: /* Set the input focus to FRAME.
3514 FRAME nil means use the selected frame. */)
3515 (Lisp_Object frame)
3517 struct frame *f = check_x_frame (frame);
3518 Display *dpy = FRAME_X_DISPLAY (f);
3520 BLOCK_INPUT;
3521 x_catch_errors (dpy);
3523 if (FRAME_X_EMBEDDED_P (f))
3525 /* For Xembedded frames, normally the embedder forwards key
3526 events. See XEmbed Protocol Specification at
3527 http://freedesktop.org/wiki/Specifications/xembed-spec */
3528 xembed_request_focus (f);
3530 else
3532 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3533 RevertToParent, CurrentTime);
3534 x_ewmh_activate_frame (f);
3537 x_uncatch_errors ();
3538 UNBLOCK_INPUT;
3540 return Qnil;
3544 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3545 doc: /* Internal function called by `color-defined-p', which see
3546 .\(Note that the Nextstep version of this function ignores FRAME.) */)
3547 (Lisp_Object color, Lisp_Object frame)
3549 XColor foo;
3550 FRAME_PTR f = check_x_frame (frame);
3552 CHECK_STRING (color);
3554 if (x_defined_color (f, SSDATA (color), &foo, 0))
3555 return Qt;
3556 else
3557 return Qnil;
3560 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3561 doc: /* Internal function called by `color-values', which see. */)
3562 (Lisp_Object color, Lisp_Object frame)
3564 XColor foo;
3565 FRAME_PTR f = check_x_frame (frame);
3567 CHECK_STRING (color);
3569 if (x_defined_color (f, SSDATA (color), &foo, 0))
3570 return list3 (make_number (foo.red),
3571 make_number (foo.green),
3572 make_number (foo.blue));
3573 else
3574 return Qnil;
3577 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3578 doc: /* Internal function called by `display-color-p', which see. */)
3579 (Lisp_Object terminal)
3581 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3583 if (dpyinfo->n_planes <= 2)
3584 return Qnil;
3586 switch (dpyinfo->visual->class)
3588 case StaticColor:
3589 case PseudoColor:
3590 case TrueColor:
3591 case DirectColor:
3592 return Qt;
3594 default:
3595 return Qnil;
3599 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3600 0, 1, 0,
3601 doc: /* Return t if the X display supports shades of gray.
3602 Note that color displays do support shades of gray.
3603 The optional argument TERMINAL specifies which display to ask about.
3604 TERMINAL should be a terminal object, a frame or a display name (a string).
3605 If omitted or nil, that stands for the selected frame's display. */)
3606 (Lisp_Object terminal)
3608 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3610 if (dpyinfo->n_planes <= 1)
3611 return Qnil;
3613 switch (dpyinfo->visual->class)
3615 case StaticColor:
3616 case PseudoColor:
3617 case TrueColor:
3618 case DirectColor:
3619 case StaticGray:
3620 case GrayScale:
3621 return Qt;
3623 default:
3624 return Qnil;
3628 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3629 0, 1, 0,
3630 doc: /* Return the width in pixels of the X display TERMINAL.
3631 The optional argument TERMINAL specifies which display to ask about.
3632 TERMINAL should be a terminal object, a frame or a display name (a string).
3633 If omitted or nil, that stands for the selected frame's display. */)
3634 (Lisp_Object terminal)
3636 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3638 return make_number (x_display_pixel_width (dpyinfo));
3641 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3642 Sx_display_pixel_height, 0, 1, 0,
3643 doc: /* Return the height in pixels of the X display TERMINAL.
3644 The optional argument TERMINAL specifies which display to ask about.
3645 TERMINAL should be a terminal object, a frame or a display name (a string).
3646 If omitted or nil, that stands for the selected frame's display. */)
3647 (Lisp_Object terminal)
3649 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3651 return make_number (x_display_pixel_height (dpyinfo));
3654 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3655 0, 1, 0,
3656 doc: /* Return the number of bitplanes of the X display TERMINAL.
3657 The optional argument TERMINAL specifies which display to ask about.
3658 TERMINAL should be a terminal object, a frame or a display name (a string).
3659 If omitted or nil, that stands for the selected frame's display. */)
3660 (Lisp_Object terminal)
3662 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3664 return make_number (dpyinfo->n_planes);
3667 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3668 0, 1, 0,
3669 doc: /* Return the number of color cells of the X display TERMINAL.
3670 The optional argument TERMINAL specifies which display to ask about.
3671 TERMINAL should be a terminal object, a frame or a display name (a string).
3672 If omitted or nil, that stands for the selected frame's display. */)
3673 (Lisp_Object terminal)
3675 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3677 int nr_planes = DisplayPlanes (dpyinfo->display,
3678 XScreenNumberOfScreen (dpyinfo->screen));
3680 /* Truncate nr_planes to 24 to avoid integer overflow.
3681 Some displays says 32, but only 24 bits are actually significant.
3682 There are only very few and rare video cards that have more than
3683 24 significant bits. Also 24 bits is more than 16 million colors,
3684 it "should be enough for everyone". */
3685 if (nr_planes > 24) nr_planes = 24;
3687 return make_number (1 << nr_planes);
3690 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3691 Sx_server_max_request_size,
3692 0, 1, 0,
3693 doc: /* Return the maximum request size of the X server of display TERMINAL.
3694 The optional argument TERMINAL specifies which display to ask about.
3695 TERMINAL should be a terminal object, a frame or a display name (a string).
3696 If omitted or nil, that stands for the selected frame's display. */)
3697 (Lisp_Object terminal)
3699 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3701 return make_number (MAXREQUEST (dpyinfo->display));
3704 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3705 doc: /* Return the "vendor ID" string of the X server of display TERMINAL.
3706 \(Labeling every distributor as a "vendor" embodies the false assumption
3707 that operating systems cannot be developed and distributed noncommercially.)
3708 The optional argument TERMINAL specifies which display to ask about.
3709 TERMINAL should be a terminal object, a frame or a display name (a string).
3710 If omitted or nil, that stands for the selected frame's display. */)
3711 (Lisp_Object terminal)
3713 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3714 const char *vendor = ServerVendor (dpyinfo->display);
3716 if (! vendor) vendor = "";
3717 return build_string (vendor);
3720 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3721 doc: /* Return the version numbers of the X server of display TERMINAL.
3722 The value is a list of three integers: the major and minor
3723 version numbers of the X Protocol in use, and the distributor-specific release
3724 number. See also the function `x-server-vendor'.
3726 The optional argument TERMINAL specifies which display to ask about.
3727 TERMINAL should be a terminal object, a frame or a display name (a string).
3728 If omitted or nil, that stands for the selected frame's display. */)
3729 (Lisp_Object terminal)
3731 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3732 Display *dpy = dpyinfo->display;
3734 return Fcons (make_number (ProtocolVersion (dpy)),
3735 Fcons (make_number (ProtocolRevision (dpy)),
3736 Fcons (make_number (VendorRelease (dpy)), Qnil)));
3739 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3740 doc: /* Return the number of screens on the X server of display TERMINAL.
3741 The optional argument TERMINAL specifies which display to ask about.
3742 TERMINAL should be a terminal object, a frame or a display name (a string).
3743 If omitted or nil, that stands for the selected frame's display. */)
3744 (Lisp_Object terminal)
3746 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3748 return make_number (ScreenCount (dpyinfo->display));
3751 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3752 doc: /* Return the height in millimeters of the X display TERMINAL.
3753 The optional argument TERMINAL specifies which display to ask about.
3754 TERMINAL should be a terminal object, a frame or a display name (a string).
3755 If omitted or nil, that stands for the selected frame's display. */)
3756 (Lisp_Object terminal)
3758 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3760 return make_number (HeightMMOfScreen (dpyinfo->screen));
3763 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3764 doc: /* Return the width in millimeters of the X display TERMINAL.
3765 The optional argument TERMINAL specifies which display to ask about.
3766 TERMINAL should be a terminal object, a frame or a display name (a string).
3767 If omitted or nil, that stands for the selected frame's display. */)
3768 (Lisp_Object terminal)
3770 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3772 return make_number (WidthMMOfScreen (dpyinfo->screen));
3775 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3776 Sx_display_backing_store, 0, 1, 0,
3777 doc: /* Return an indication of whether X display TERMINAL does backing store.
3778 The value may be `always', `when-mapped', or `not-useful'.
3779 The optional argument TERMINAL specifies which display to ask about.
3780 TERMINAL should be a terminal object, a frame or a display name (a string).
3781 If omitted or nil, that stands for the selected frame's display. */)
3782 (Lisp_Object terminal)
3784 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3785 Lisp_Object result;
3787 switch (DoesBackingStore (dpyinfo->screen))
3789 case Always:
3790 result = intern ("always");
3791 break;
3793 case WhenMapped:
3794 result = intern ("when-mapped");
3795 break;
3797 case NotUseful:
3798 result = intern ("not-useful");
3799 break;
3801 default:
3802 error ("Strange value for BackingStore parameter of screen");
3803 result = Qnil;
3806 return result;
3809 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3810 Sx_display_visual_class, 0, 1, 0,
3811 doc: /* Return the visual class of the X display TERMINAL.
3812 The value is one of the symbols `static-gray', `gray-scale',
3813 `static-color', `pseudo-color', `true-color', or `direct-color'.
3815 The optional argument TERMINAL specifies which display to ask about.
3816 TERMINAL should a terminal object, a frame or a display name (a string).
3817 If omitted or nil, that stands for the selected frame's display. */)
3818 (Lisp_Object terminal)
3820 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3821 Lisp_Object result;
3823 switch (dpyinfo->visual->class)
3825 case StaticGray:
3826 result = intern ("static-gray");
3827 break;
3828 case GrayScale:
3829 result = intern ("gray-scale");
3830 break;
3831 case StaticColor:
3832 result = intern ("static-color");
3833 break;
3834 case PseudoColor:
3835 result = intern ("pseudo-color");
3836 break;
3837 case TrueColor:
3838 result = intern ("true-color");
3839 break;
3840 case DirectColor:
3841 result = intern ("direct-color");
3842 break;
3843 default:
3844 error ("Display has an unknown visual class");
3845 result = Qnil;
3848 return result;
3851 DEFUN ("x-display-save-under", Fx_display_save_under,
3852 Sx_display_save_under, 0, 1, 0,
3853 doc: /* Return t if the X display TERMINAL supports the save-under feature.
3854 The optional argument TERMINAL specifies which display to ask about.
3855 TERMINAL should be a terminal object, a frame or a display name (a string).
3856 If omitted or nil, that stands for the selected frame's display. */)
3857 (Lisp_Object terminal)
3859 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3861 if (DoesSaveUnders (dpyinfo->screen) == True)
3862 return Qt;
3863 else
3864 return Qnil;
3868 x_pixel_width (register struct frame *f)
3870 return FRAME_PIXEL_WIDTH (f);
3874 x_pixel_height (register struct frame *f)
3876 return FRAME_PIXEL_HEIGHT (f);
3880 x_char_width (register struct frame *f)
3882 return FRAME_COLUMN_WIDTH (f);
3886 x_char_height (register struct frame *f)
3888 return FRAME_LINE_HEIGHT (f);
3893 /************************************************************************
3894 X Displays
3895 ************************************************************************/
3898 /* Mapping visual names to visuals. */
3900 static struct visual_class
3902 const char *name;
3903 int class;
3905 visual_classes[] =
3907 {"StaticGray", StaticGray},
3908 {"GrayScale", GrayScale},
3909 {"StaticColor", StaticColor},
3910 {"PseudoColor", PseudoColor},
3911 {"TrueColor", TrueColor},
3912 {"DirectColor", DirectColor},
3913 {NULL, 0}
3917 #ifndef HAVE_XSCREENNUMBEROFSCREEN
3919 /* Value is the screen number of screen SCR. This is a substitute for
3920 the X function with the same name when that doesn't exist. */
3923 XScreenNumberOfScreen (scr)
3924 register Screen *scr;
3926 Display *dpy = scr->display;
3927 int i;
3929 for (i = 0; i < dpy->nscreens; ++i)
3930 if (scr == dpy->screens + i)
3931 break;
3933 return i;
3936 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
3939 /* Select the visual that should be used on display DPYINFO. Set
3940 members of DPYINFO appropriately. Called from x_term_init. */
3942 void
3943 select_visual (struct x_display_info *dpyinfo)
3945 Display *dpy = dpyinfo->display;
3946 Screen *screen = dpyinfo->screen;
3947 Lisp_Object value;
3949 /* See if a visual is specified. */
3950 value = display_x_get_resource (dpyinfo,
3951 build_string ("visualClass"),
3952 build_string ("VisualClass"),
3953 Qnil, Qnil);
3954 if (STRINGP (value))
3956 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
3957 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
3958 depth, a decimal number. NAME is compared with case ignored. */
3959 char *s = (char *) alloca (SBYTES (value) + 1);
3960 char *dash;
3961 int i, class = -1;
3962 XVisualInfo vinfo;
3964 strcpy (s, SSDATA (value));
3965 dash = strchr (s, '-');
3966 if (dash)
3968 dpyinfo->n_planes = atoi (dash + 1);
3969 *dash = '\0';
3971 else
3972 /* We won't find a matching visual with depth 0, so that
3973 an error will be printed below. */
3974 dpyinfo->n_planes = 0;
3976 /* Determine the visual class. */
3977 for (i = 0; visual_classes[i].name; ++i)
3978 if (xstrcasecmp (s, visual_classes[i].name) == 0)
3980 class = visual_classes[i].class;
3981 break;
3984 /* Look up a matching visual for the specified class. */
3985 if (class == -1
3986 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
3987 dpyinfo->n_planes, class, &vinfo))
3988 fatal ("Invalid visual specification `%s'", SDATA (value));
3990 dpyinfo->visual = vinfo.visual;
3992 else
3994 int n_visuals;
3995 XVisualInfo *vinfo, vinfo_template;
3997 dpyinfo->visual = DefaultVisualOfScreen (screen);
3999 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
4000 vinfo_template.screen = XScreenNumberOfScreen (screen);
4001 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
4002 &vinfo_template, &n_visuals);
4003 if (n_visuals <= 0)
4004 fatal ("Can't get proper X visual info");
4006 dpyinfo->n_planes = vinfo->depth;
4007 XFree ((char *) vinfo);
4012 /* Return the X display structure for the display named NAME.
4013 Open a new connection if necessary. */
4015 static struct x_display_info *
4016 x_display_info_for_name (Lisp_Object name)
4018 Lisp_Object names;
4019 struct x_display_info *dpyinfo;
4021 CHECK_STRING (name);
4023 #if 0
4024 if (! EQ (Vinitial_window_system, intern ("x")))
4025 error ("Not using X Windows"); /* That doesn't stop us anymore. */
4026 #endif
4028 for (dpyinfo = x_display_list, names = x_display_name_list;
4029 dpyinfo;
4030 dpyinfo = dpyinfo->next, names = XCDR (names))
4032 Lisp_Object tem;
4033 tem = Fstring_equal (XCAR (XCAR (names)), name);
4034 if (!NILP (tem))
4035 return dpyinfo;
4038 /* Use this general default value to start with. */
4039 Vx_resource_name = Vinvocation_name;
4041 validate_x_resource_name ();
4043 dpyinfo = x_term_init (name, (char *)0,
4044 SSDATA (Vx_resource_name));
4046 if (dpyinfo == 0)
4047 error ("Cannot connect to X server %s", SDATA (name));
4049 x_in_use = 1;
4050 XSETFASTINT (Vwindow_system_version, 11);
4052 return dpyinfo;
4056 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4057 1, 3, 0,
4058 doc: /* Open a connection to a display server.
4059 DISPLAY is the name of the display to connect to.
4060 Optional second arg XRM-STRING is a string of resources in xrdb format.
4061 If the optional third arg MUST-SUCCEED is non-nil,
4062 terminate Emacs if we can't open the connection.
4063 \(In the Nextstep version, the last two arguments are currently ignored.) */)
4064 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4066 char *xrm_option;
4067 struct x_display_info *dpyinfo;
4069 CHECK_STRING (display);
4070 if (! NILP (xrm_string))
4071 CHECK_STRING (xrm_string);
4073 #if 0
4074 if (! EQ (Vinitial_window_system, intern ("x")))
4075 error ("Not using X Windows"); /* That doesn't stop us anymore. */
4076 #endif
4078 if (! NILP (xrm_string))
4079 xrm_option = SSDATA (xrm_string);
4080 else
4081 xrm_option = (char *) 0;
4083 validate_x_resource_name ();
4085 /* This is what opens the connection and sets x_current_display.
4086 This also initializes many symbols, such as those used for input. */
4087 dpyinfo = x_term_init (display, xrm_option,
4088 SSDATA (Vx_resource_name));
4090 if (dpyinfo == 0)
4092 if (!NILP (must_succeed))
4093 fatal ("Cannot connect to X server %s.\n\
4094 Check the DISPLAY environment variable or use `-d'.\n\
4095 Also use the `xauth' program to verify that you have the proper\n\
4096 authorization information needed to connect the X server.\n\
4097 An insecure way to solve the problem may be to use `xhost'.\n",
4098 SDATA (display));
4099 else
4100 error ("Cannot connect to X server %s", SDATA (display));
4103 x_in_use = 1;
4105 XSETFASTINT (Vwindow_system_version, 11);
4106 return Qnil;
4109 DEFUN ("x-close-connection", Fx_close_connection,
4110 Sx_close_connection, 1, 1, 0,
4111 doc: /* Close the connection to TERMINAL's X server.
4112 For TERMINAL, specify a terminal object, a frame or a display name (a
4113 string). If TERMINAL is nil, that stands for the selected frame's
4114 terminal. */)
4115 (Lisp_Object terminal)
4117 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4119 if (dpyinfo->reference_count > 0)
4120 error ("Display still has frames on it");
4122 x_delete_terminal (dpyinfo->terminal);
4124 return Qnil;
4127 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4128 doc: /* Return the list of display names that Emacs has connections to. */)
4129 (void)
4131 Lisp_Object tail, result;
4133 result = Qnil;
4134 for (tail = x_display_name_list; CONSP (tail); tail = XCDR (tail))
4135 result = Fcons (XCAR (XCAR (tail)), result);
4137 return result;
4140 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4141 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4142 This function only has an effect on X Windows. With MS Windows, it is
4143 defined but does nothing.
4145 If ON is nil, allow buffering of requests.
4146 Turning on synchronization prohibits the Xlib routines from buffering
4147 requests and seriously degrades performance, but makes debugging much
4148 easier.
4149 The optional second argument TERMINAL specifies which display to act on.
4150 TERMINAL should be a terminal object, a frame or a display name (a string).
4151 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
4152 (Lisp_Object on, Lisp_Object terminal)
4154 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4156 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4158 return Qnil;
4161 /* Wait for responses to all X commands issued so far for frame F. */
4163 void
4164 x_sync (FRAME_PTR f)
4166 BLOCK_INPUT;
4167 XSync (FRAME_X_DISPLAY (f), False);
4168 UNBLOCK_INPUT;
4172 /***********************************************************************
4173 Window properties
4174 ***********************************************************************/
4176 DEFUN ("x-change-window-property", Fx_change_window_property,
4177 Sx_change_window_property, 2, 6, 0,
4178 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4179 PROP must be a string. VALUE may be a string or a list of conses,
4180 numbers and/or strings. If an element in the list is a string, it is
4181 converted to an atom and the value of the atom is used. If an element
4182 is a cons, it is converted to a 32 bit number where the car is the 16
4183 top bits and the cdr is the lower 16 bits.
4185 FRAME nil or omitted means use the selected frame.
4186 If TYPE is given and non-nil, it is the name of the type of VALUE.
4187 If TYPE is not given or nil, the type is STRING.
4188 FORMAT gives the size in bits of each element if VALUE is a list.
4189 It must be one of 8, 16 or 32.
4190 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4191 If OUTER_P is non-nil, the property is changed for the outer X window of
4192 FRAME. Default is to change on the edit X window. */)
4193 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame, Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
4195 struct frame *f = check_x_frame (frame);
4196 Atom prop_atom;
4197 Atom target_type = XA_STRING;
4198 int element_format = 8;
4199 unsigned char *data;
4200 int nelements;
4201 Window w;
4203 CHECK_STRING (prop);
4205 if (! NILP (format))
4207 CHECK_NUMBER (format);
4208 element_format = XFASTINT (format);
4210 if (element_format != 8 && element_format != 16
4211 && element_format != 32)
4212 error ("FORMAT must be one of 8, 16 or 32");
4215 if (CONSP (value))
4217 ptrdiff_t elsize;
4219 nelements = x_check_property_data (value);
4220 if (nelements == -1)
4221 error ("Bad data in VALUE, must be number, string or cons");
4223 /* The man page for XChangeProperty:
4224 "If the specified format is 32, the property data must be a
4225 long array."
4226 This applies even if long is more than 32 bits. The X library
4227 converts to 32 bits before sending to the X server. */
4228 elsize = element_format == 32 ? sizeof (long) : element_format >> 3;
4229 data = xnmalloc (nelements, elsize);
4231 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4233 else
4235 CHECK_STRING (value);
4236 data = SDATA (value);
4237 if (INT_MAX < SBYTES (value))
4238 error ("VALUE too long");
4239 nelements = SBYTES (value);
4242 BLOCK_INPUT;
4243 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4244 if (! NILP (type))
4246 CHECK_STRING (type);
4247 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4250 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4251 else w = FRAME_X_WINDOW (f);
4253 XChangeProperty (FRAME_X_DISPLAY (f), w,
4254 prop_atom, target_type, element_format, PropModeReplace,
4255 data, nelements);
4257 if (CONSP (value)) xfree (data);
4259 /* Make sure the property is set when we return. */
4260 XFlush (FRAME_X_DISPLAY (f));
4261 UNBLOCK_INPUT;
4263 return value;
4267 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4268 Sx_delete_window_property, 1, 2, 0,
4269 doc: /* Remove window property PROP from X window of FRAME.
4270 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4271 (Lisp_Object prop, Lisp_Object frame)
4273 struct frame *f = check_x_frame (frame);
4274 Atom prop_atom;
4276 CHECK_STRING (prop);
4277 BLOCK_INPUT;
4278 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4279 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4281 /* Make sure the property is removed when we return. */
4282 XFlush (FRAME_X_DISPLAY (f));
4283 UNBLOCK_INPUT;
4285 return prop;
4289 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4290 1, 6, 0,
4291 doc: /* Value is the value of window property PROP on FRAME.
4292 If FRAME is nil or omitted, use the selected frame.
4294 On MS Windows, this function only accepts the PROP and FRAME arguments.
4296 On X Windows, the following optional arguments are also accepted:
4297 If TYPE is nil or omitted, get the property as a string.
4298 Otherwise TYPE is the name of the atom that denotes the type expected.
4299 If SOURCE is non-nil, get the property on that window instead of from
4300 FRAME. The number 0 denotes the root window.
4301 If DELETE_P is non-nil, delete the property after retrieving it.
4302 If VECTOR_RET_P is non-nil, don't return a string but a vector of values.
4304 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4305 no value of TYPE (always string in the MS Windows case). */)
4306 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type, Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
4308 struct frame *f = check_x_frame (frame);
4309 Atom prop_atom;
4310 int rc;
4311 Lisp_Object prop_value = Qnil;
4312 unsigned char *tmp_data = NULL;
4313 Atom actual_type;
4314 Atom target_type = XA_STRING;
4315 int actual_format;
4316 unsigned long actual_size, bytes_remaining;
4317 Window target_window = FRAME_X_WINDOW (f);
4318 struct gcpro gcpro1;
4320 GCPRO1 (prop_value);
4321 CHECK_STRING (prop);
4323 if (! NILP (source))
4325 CONS_TO_INTEGER (source, Window, target_window);
4326 if (! target_window)
4327 target_window = FRAME_X_DISPLAY_INFO (f)->root_window;
4330 BLOCK_INPUT;
4331 if (STRINGP (type))
4333 if (strcmp ("AnyPropertyType", SSDATA (type)) == 0)
4334 target_type = AnyPropertyType;
4335 else
4336 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4339 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4340 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4341 prop_atom, 0, 0, False, target_type,
4342 &actual_type, &actual_format, &actual_size,
4343 &bytes_remaining, &tmp_data);
4344 if (rc == Success)
4346 int size = bytes_remaining;
4348 XFree (tmp_data);
4349 tmp_data = NULL;
4351 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4352 prop_atom, 0, bytes_remaining,
4353 ! NILP (delete_p), target_type,
4354 &actual_type, &actual_format,
4355 &actual_size, &bytes_remaining,
4356 &tmp_data);
4357 if (rc == Success && tmp_data)
4359 /* The man page for XGetWindowProperty says:
4360 "If the returned format is 32, the returned data is represented
4361 as a long array and should be cast to that type to obtain the
4362 elements."
4363 This applies even if long is more than 32 bits, the X library
4364 converts from 32 bit elements received from the X server to long
4365 and passes the long array to us. Thus, for that case memcpy can not
4366 be used. We convert to a 32 bit type here, because so much code
4367 assume on that.
4369 The bytes and offsets passed to XGetWindowProperty refers to the
4370 property and those are indeed in 32 bit quantities if format is
4371 32. */
4373 if (32 < BITS_PER_LONG && actual_format == 32)
4375 unsigned long i;
4376 int *idata = (int *) tmp_data;
4377 long *ldata = (long *) tmp_data;
4379 for (i = 0; i < actual_size; ++i)
4380 idata[i] = (int) ldata[i];
4383 if (NILP (vector_ret_p))
4384 prop_value = make_string ((char *) tmp_data, size);
4385 else
4386 prop_value = x_property_data_to_lisp (f,
4387 tmp_data,
4388 actual_type,
4389 actual_format,
4390 actual_size);
4393 if (tmp_data) XFree (tmp_data);
4396 UNBLOCK_INPUT;
4397 UNGCPRO;
4398 return prop_value;
4403 /***********************************************************************
4404 Busy cursor
4405 ***********************************************************************/
4407 /* Timer function of hourglass_atimer. TIMER is equal to
4408 hourglass_atimer.
4410 Display an hourglass pointer on all frames by mapping the frames'
4411 hourglass_window. Set the hourglass_p flag in the frames'
4412 output_data.x structure to indicate that an hourglass cursor is
4413 shown on the frames. */
4415 void
4416 show_hourglass (struct atimer *timer)
4418 /* The timer implementation will cancel this timer automatically
4419 after this function has run. Set hourglass_atimer to null
4420 so that we know the timer doesn't have to be canceled. */
4421 hourglass_atimer = NULL;
4423 if (!hourglass_shown_p)
4425 Lisp_Object rest, frame;
4427 BLOCK_INPUT;
4429 FOR_EACH_FRAME (rest, frame)
4431 struct frame *f = XFRAME (frame);
4433 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4435 Display *dpy = FRAME_X_DISPLAY (f);
4437 #ifdef USE_X_TOOLKIT
4438 if (f->output_data.x->widget)
4439 #else
4440 if (FRAME_OUTER_WINDOW (f))
4441 #endif
4443 f->output_data.x->hourglass_p = 1;
4445 if (!f->output_data.x->hourglass_window)
4447 unsigned long mask = CWCursor;
4448 XSetWindowAttributes attrs;
4449 #ifdef USE_GTK
4450 Window parent = FRAME_X_WINDOW (f);
4451 #else
4452 Window parent = FRAME_OUTER_WINDOW (f);
4453 #endif
4454 attrs.cursor = f->output_data.x->hourglass_cursor;
4456 f->output_data.x->hourglass_window
4457 = XCreateWindow (dpy, parent,
4458 0, 0, 32000, 32000, 0, 0,
4459 InputOnly,
4460 CopyFromParent,
4461 mask, &attrs);
4464 XMapRaised (dpy, f->output_data.x->hourglass_window);
4465 XFlush (dpy);
4470 hourglass_shown_p = 1;
4471 UNBLOCK_INPUT;
4476 /* Hide the hourglass pointer on all frames, if it is currently
4477 shown. */
4479 void
4480 hide_hourglass (void)
4482 if (hourglass_shown_p)
4484 Lisp_Object rest, frame;
4486 BLOCK_INPUT;
4487 FOR_EACH_FRAME (rest, frame)
4489 struct frame *f = XFRAME (frame);
4491 if (FRAME_X_P (f)
4492 /* Watch out for newly created frames. */
4493 && f->output_data.x->hourglass_window)
4495 XUnmapWindow (FRAME_X_DISPLAY (f),
4496 f->output_data.x->hourglass_window);
4497 /* Sync here because XTread_socket looks at the
4498 hourglass_p flag that is reset to zero below. */
4499 XSync (FRAME_X_DISPLAY (f), False);
4500 f->output_data.x->hourglass_p = 0;
4504 hourglass_shown_p = 0;
4505 UNBLOCK_INPUT;
4511 /***********************************************************************
4512 Tool tips
4513 ***********************************************************************/
4515 static Lisp_Object x_create_tip_frame (struct x_display_info *,
4516 Lisp_Object, Lisp_Object);
4517 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
4518 Lisp_Object, int, int, int *, int *);
4520 /* The frame of a currently visible tooltip. */
4522 Lisp_Object tip_frame;
4524 /* If non-nil, a timer started that hides the last tooltip when it
4525 fires. */
4527 static Lisp_Object tip_timer;
4528 Window tip_window;
4530 /* If non-nil, a vector of 3 elements containing the last args
4531 with which x-show-tip was called. See there. */
4533 static Lisp_Object last_show_tip_args;
4536 static Lisp_Object
4537 unwind_create_tip_frame (Lisp_Object frame)
4539 Lisp_Object deleted;
4541 deleted = unwind_create_frame (frame);
4542 if (EQ (deleted, Qt))
4544 tip_window = None;
4545 tip_frame = Qnil;
4548 return deleted;
4552 /* Create a frame for a tooltip on the display described by DPYINFO.
4553 PARMS is a list of frame parameters. TEXT is the string to
4554 display in the tip frame. Value is the frame.
4556 Note that functions called here, esp. x_default_parameter can
4557 signal errors, for instance when a specified color name is
4558 undefined. We have to make sure that we're in a consistent state
4559 when this happens. */
4561 static Lisp_Object
4562 x_create_tip_frame (struct x_display_info *dpyinfo,
4563 Lisp_Object parms,
4564 Lisp_Object text)
4566 struct frame *f;
4567 Lisp_Object frame;
4568 Lisp_Object name;
4569 int width, height;
4570 int count = SPECPDL_INDEX ();
4571 struct gcpro gcpro1, gcpro2, gcpro3;
4572 int face_change_count_before = face_change_count;
4573 Lisp_Object buffer;
4574 struct buffer *old_buffer;
4576 check_x ();
4578 if (!dpyinfo->terminal->name)
4579 error ("Terminal is not live, can't create new frames on it");
4581 parms = Fcopy_alist (parms);
4583 /* Get the name of the frame to use for resource lookup. */
4584 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4585 if (!STRINGP (name)
4586 && !EQ (name, Qunbound)
4587 && !NILP (name))
4588 error ("Invalid frame name--not a string or nil");
4590 frame = Qnil;
4591 GCPRO3 (parms, name, frame);
4592 f = make_frame (1);
4593 XSETFRAME (frame, f);
4595 buffer = Fget_buffer_create (build_string (" *tip*"));
4596 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer, Qnil);
4597 old_buffer = current_buffer;
4598 set_buffer_internal_1 (XBUFFER (buffer));
4599 BVAR (current_buffer, truncate_lines) = Qnil;
4600 specbind (Qinhibit_read_only, Qt);
4601 specbind (Qinhibit_modification_hooks, Qt);
4602 Ferase_buffer ();
4603 Finsert (1, &text);
4604 set_buffer_internal_1 (old_buffer);
4606 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
4607 record_unwind_protect (unwind_create_tip_frame, frame);
4609 f->terminal = dpyinfo->terminal;
4611 /* By setting the output method, we're essentially saying that
4612 the frame is live, as per FRAME_LIVE_P. If we get a signal
4613 from this point on, x_destroy_window might screw up reference
4614 counts etc. */
4615 f->output_method = output_x_window;
4616 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4617 memset (f->output_data.x, 0, sizeof (struct x_output));
4618 f->output_data.x->icon_bitmap = -1;
4619 FRAME_FONTSET (f) = -1;
4620 f->output_data.x->scroll_bar_foreground_pixel = -1;
4621 f->output_data.x->scroll_bar_background_pixel = -1;
4622 #ifdef USE_TOOLKIT_SCROLL_BARS
4623 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
4624 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
4625 #endif /* USE_TOOLKIT_SCROLL_BARS */
4626 f->icon_name = Qnil;
4627 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4628 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4629 f->output_data.x->explicit_parent = 0;
4631 /* These colors will be set anyway later, but it's important
4632 to get the color reference counts right, so initialize them! */
4634 Lisp_Object black;
4635 struct gcpro gcpro1;
4637 /* Function x_decode_color can signal an error. Make
4638 sure to initialize color slots so that we won't try
4639 to free colors we haven't allocated. */
4640 FRAME_FOREGROUND_PIXEL (f) = -1;
4641 FRAME_BACKGROUND_PIXEL (f) = -1;
4642 f->output_data.x->cursor_pixel = -1;
4643 f->output_data.x->cursor_foreground_pixel = -1;
4644 f->output_data.x->border_pixel = -1;
4645 f->output_data.x->mouse_pixel = -1;
4647 black = build_string ("black");
4648 GCPRO1 (black);
4649 FRAME_FOREGROUND_PIXEL (f)
4650 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4651 FRAME_BACKGROUND_PIXEL (f)
4652 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4653 f->output_data.x->cursor_pixel
4654 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4655 f->output_data.x->cursor_foreground_pixel
4656 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4657 f->output_data.x->border_pixel
4658 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4659 f->output_data.x->mouse_pixel
4660 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4661 UNGCPRO;
4664 /* Set the name; the functions to which we pass f expect the name to
4665 be set. */
4666 if (EQ (name, Qunbound) || NILP (name))
4668 f->name = build_string (dpyinfo->x_id_name);
4669 f->explicit_name = 0;
4671 else
4673 f->name = name;
4674 f->explicit_name = 1;
4675 /* use the frame's title when getting resources for this frame. */
4676 specbind (Qx_resource_name, name);
4679 f->resx = dpyinfo->resx;
4680 f->resy = dpyinfo->resy;
4682 register_font_driver (&xfont_driver, f);
4683 #ifdef HAVE_FREETYPE
4684 #ifdef HAVE_XFT
4685 register_font_driver (&xftfont_driver, f);
4686 #else /* not HAVE_XFT */
4687 register_font_driver (&ftxfont_driver, f);
4688 #endif /* not HAVE_XFT */
4689 #endif /* HAVE_FREETYPE */
4691 x_default_parameter (f, parms, Qfont_backend, Qnil,
4692 "fontBackend", "FontBackend", RES_TYPE_STRING);
4694 /* Extract the window parameters from the supplied values that are
4695 needed to determine window geometry. */
4696 x_default_font_parameter (f, parms);
4698 x_default_parameter (f, parms, Qborder_width, make_number (0),
4699 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4701 /* This defaults to 2 in order to match xterm. We recognize either
4702 internalBorderWidth or internalBorder (which is what xterm calls
4703 it). */
4704 if (NILP (Fassq (Qinternal_border_width, parms)))
4706 Lisp_Object value;
4708 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4709 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4710 if (! EQ (value, Qunbound))
4711 parms = Fcons (Fcons (Qinternal_border_width, value),
4712 parms);
4715 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4716 "internalBorderWidth", "internalBorderWidth",
4717 RES_TYPE_NUMBER);
4719 /* Also do the stuff which must be set before the window exists. */
4720 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4721 "foreground", "Foreground", RES_TYPE_STRING);
4722 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4723 "background", "Background", RES_TYPE_STRING);
4724 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4725 "pointerColor", "Foreground", RES_TYPE_STRING);
4726 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4727 "cursorColor", "Foreground", RES_TYPE_STRING);
4728 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4729 "borderColor", "BorderColor", RES_TYPE_STRING);
4731 #if GLYPH_DEBUG
4732 image_cache_refcount =
4733 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
4734 dpyinfo_refcount = dpyinfo->reference_count;
4735 #endif /* GLYPH_DEBUG */
4737 /* Init faces before x_default_parameter is called for scroll-bar
4738 parameters because that function calls x_set_scroll_bar_width,
4739 which calls change_frame_size, which calls Fset_window_buffer,
4740 which runs hooks, which call Fvertical_motion. At the end, we
4741 end up in init_iterator with a null face cache, which should not
4742 happen. */
4743 init_frame_faces (f);
4745 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4747 x_figure_window_size (f, parms, 0);
4750 XSetWindowAttributes attrs;
4751 unsigned long mask;
4752 Atom type = FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type_tooltip;
4754 BLOCK_INPUT;
4755 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
4756 if (DoesSaveUnders (dpyinfo->screen))
4757 mask |= CWSaveUnder;
4759 /* Window managers look at the override-redirect flag to determine
4760 whether or net to give windows a decoration (Xlib spec, chapter
4761 3.2.8). */
4762 attrs.override_redirect = True;
4763 attrs.save_under = True;
4764 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4765 /* Arrange for getting MapNotify and UnmapNotify events. */
4766 attrs.event_mask = StructureNotifyMask;
4767 tip_window
4768 = FRAME_X_WINDOW (f)
4769 = XCreateWindow (FRAME_X_DISPLAY (f),
4770 FRAME_X_DISPLAY_INFO (f)->root_window,
4771 /* x, y, width, height */
4772 0, 0, 1, 1,
4773 /* Border. */
4774 f->border_width,
4775 CopyFromParent, InputOutput, CopyFromParent,
4776 mask, &attrs);
4777 XChangeProperty (FRAME_X_DISPLAY (f), tip_window,
4778 FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type,
4779 XA_ATOM, 32, PropModeReplace,
4780 (unsigned char *)&type, 1);
4781 UNBLOCK_INPUT;
4784 x_make_gc (f);
4786 x_default_parameter (f, parms, Qauto_raise, Qnil,
4787 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4788 x_default_parameter (f, parms, Qauto_lower, Qnil,
4789 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4790 x_default_parameter (f, parms, Qcursor_type, Qbox,
4791 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4793 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4794 Change will not be effected unless different from the current
4795 FRAME_LINES (f). */
4796 width = FRAME_COLS (f);
4797 height = FRAME_LINES (f);
4798 SET_FRAME_COLS (f, 0);
4799 FRAME_LINES (f) = 0;
4800 change_frame_size (f, height, width, 1, 0, 0);
4802 /* Add `tooltip' frame parameter's default value. */
4803 if (NILP (Fframe_parameter (frame, Qtooltip)))
4804 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
4806 /* FIXME - can this be done in a similar way to normal frames?
4807 http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00641.html */
4809 /* Set the `display-type' frame parameter before setting up faces. */
4811 Lisp_Object disptype;
4813 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
4814 disptype = intern ("mono");
4815 else if (FRAME_X_DISPLAY_INFO (f)->visual->class == GrayScale
4816 || FRAME_X_DISPLAY_INFO (f)->visual->class == StaticGray)
4817 disptype = intern ("grayscale");
4818 else
4819 disptype = intern ("color");
4821 if (NILP (Fframe_parameter (frame, Qdisplay_type)))
4822 Fmodify_frame_parameters (frame, Fcons (Fcons (Qdisplay_type, disptype),
4823 Qnil));
4826 /* Set up faces after all frame parameters are known. This call
4827 also merges in face attributes specified for new frames.
4829 Frame parameters may be changed if .Xdefaults contains
4830 specifications for the default font. For example, if there is an
4831 `Emacs.default.attributeBackground: pink', the `background-color'
4832 attribute of the frame get's set, which let's the internal border
4833 of the tooltip frame appear in pink. Prevent this. */
4835 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
4837 /* Set tip_frame here, so that */
4838 tip_frame = frame;
4839 call2 (Qface_set_after_frame_default, frame, Qnil);
4841 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
4842 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
4843 Qnil));
4846 f->no_split = 1;
4848 UNGCPRO;
4850 /* Now that the frame will be official, it counts as a reference to
4851 its display and terminal. */
4852 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4853 f->terminal->reference_count++;
4855 /* It is now ok to make the frame official even if we get an error
4856 below. And the frame needs to be on Vframe_list or making it
4857 visible won't work. */
4858 Vframe_list = Fcons (frame, Vframe_list);
4861 /* Setting attributes of faces of the tooltip frame from resources
4862 and similar will increment face_change_count, which leads to the
4863 clearing of all current matrices. Since this isn't necessary
4864 here, avoid it by resetting face_change_count to the value it
4865 had before we created the tip frame. */
4866 face_change_count = face_change_count_before;
4868 /* Discard the unwind_protect. */
4869 return unbind_to (count, frame);
4873 /* Compute where to display tip frame F. PARMS is the list of frame
4874 parameters for F. DX and DY are specified offsets from the current
4875 location of the mouse. WIDTH and HEIGHT are the width and height
4876 of the tooltip. Return coordinates relative to the root window of
4877 the display in *ROOT_X, and *ROOT_Y. */
4879 static void
4880 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)
4882 Lisp_Object left, top;
4883 int win_x, win_y;
4884 Window root, child;
4885 unsigned pmask;
4887 /* User-specified position? */
4888 left = Fcdr (Fassq (Qleft, parms));
4889 top = Fcdr (Fassq (Qtop, parms));
4891 /* Move the tooltip window where the mouse pointer is. Resize and
4892 show it. */
4893 if (!INTEGERP (left) || !INTEGERP (top))
4895 BLOCK_INPUT;
4896 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
4897 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
4898 UNBLOCK_INPUT;
4901 if (INTEGERP (top))
4902 *root_y = XINT (top);
4903 else if (*root_y + XINT (dy) <= 0)
4904 *root_y = 0; /* Can happen for negative dy */
4905 else if (*root_y + XINT (dy) + height
4906 <= x_display_pixel_height (FRAME_X_DISPLAY_INFO (f)))
4907 /* It fits below the pointer */
4908 *root_y += XINT (dy);
4909 else if (height + XINT (dy) <= *root_y)
4910 /* It fits above the pointer. */
4911 *root_y -= height + XINT (dy);
4912 else
4913 /* Put it on the top. */
4914 *root_y = 0;
4916 if (INTEGERP (left))
4917 *root_x = XINT (left);
4918 else if (*root_x + XINT (dx) <= 0)
4919 *root_x = 0; /* Can happen for negative dx */
4920 else if (*root_x + XINT (dx) + width
4921 <= x_display_pixel_width (FRAME_X_DISPLAY_INFO (f)))
4922 /* It fits to the right of the pointer. */
4923 *root_x += XINT (dx);
4924 else if (width + XINT (dx) <= *root_x)
4925 /* It fits to the left of the pointer. */
4926 *root_x -= width + XINT (dx);
4927 else
4928 /* Put it left-justified on the screen--it ought to fit that way. */
4929 *root_x = 0;
4933 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
4934 doc: /* Show STRING in a "tooltip" window on frame FRAME.
4935 A tooltip window is a small X window displaying a string.
4937 This is an internal function; Lisp code should call `tooltip-show'.
4939 FRAME nil or omitted means use the selected frame.
4941 PARMS is an optional list of frame parameters which can be used to
4942 change the tooltip's appearance.
4944 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
4945 means use the default timeout of 5 seconds.
4947 If the list of frame parameters PARMS contains a `left' parameters,
4948 the tooltip is displayed at that x-position. Otherwise it is
4949 displayed at the mouse position, with offset DX added (default is 5 if
4950 DX isn't specified). Likewise for the y-position; if a `top' frame
4951 parameter is specified, it determines the y-position of the tooltip
4952 window, otherwise it is displayed at the mouse position, with offset
4953 DY added (default is -10).
4955 A tooltip's maximum size is specified by `x-max-tooltip-size'.
4956 Text larger than the specified size is clipped. */)
4957 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
4959 struct frame *f;
4960 struct window *w;
4961 int root_x, root_y;
4962 struct buffer *old_buffer;
4963 struct text_pos pos;
4964 int i, width, height, seen_reversed_p;
4965 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4966 int old_windows_or_buffers_changed = windows_or_buffers_changed;
4967 int count = SPECPDL_INDEX ();
4969 specbind (Qinhibit_redisplay, Qt);
4971 GCPRO4 (string, parms, frame, timeout);
4973 CHECK_STRING (string);
4974 if (SCHARS (string) == 0)
4975 string = make_unibyte_string (" ", 1);
4977 f = check_x_frame (frame);
4978 if (NILP (timeout))
4979 timeout = make_number (5);
4980 else
4981 CHECK_NATNUM (timeout);
4983 if (NILP (dx))
4984 dx = make_number (5);
4985 else
4986 CHECK_NUMBER (dx);
4988 if (NILP (dy))
4989 dy = make_number (-10);
4990 else
4991 CHECK_NUMBER (dy);
4993 #ifdef USE_GTK
4994 if (x_gtk_use_system_tooltips)
4996 int ok;
4998 /* Hide a previous tip, if any. */
4999 Fx_hide_tip ();
5001 BLOCK_INPUT;
5002 if ((ok = xg_prepare_tooltip (f, string, &width, &height)) != 0)
5004 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5005 xg_show_tooltip (f, root_x, root_y);
5006 /* This is used in Fx_hide_tip. */
5007 XSETFRAME (tip_frame, f);
5009 UNBLOCK_INPUT;
5010 if (ok) goto start_timer;
5012 #endif /* USE_GTK */
5014 if (NILP (last_show_tip_args))
5015 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5017 if (!NILP (tip_frame))
5019 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5020 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5021 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5023 if (EQ (frame, last_frame)
5024 && !NILP (Fequal (last_string, string))
5025 && !NILP (Fequal (last_parms, parms)))
5027 struct frame *tip_f = XFRAME (tip_frame);
5029 /* Only DX and DY have changed. */
5030 if (!NILP (tip_timer))
5032 Lisp_Object timer = tip_timer;
5033 tip_timer = Qnil;
5034 call1 (Qcancel_timer, timer);
5037 BLOCK_INPUT;
5038 compute_tip_xy (tip_f, parms, dx, dy, FRAME_PIXEL_WIDTH (tip_f),
5039 FRAME_PIXEL_HEIGHT (tip_f), &root_x, &root_y);
5040 XMoveWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
5041 root_x, root_y);
5042 UNBLOCK_INPUT;
5043 goto start_timer;
5047 /* Hide a previous tip, if any. */
5048 Fx_hide_tip ();
5050 ASET (last_show_tip_args, 0, string);
5051 ASET (last_show_tip_args, 1, frame);
5052 ASET (last_show_tip_args, 2, parms);
5054 /* Add default values to frame parameters. */
5055 if (NILP (Fassq (Qname, parms)))
5056 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5057 if (NILP (Fassq (Qinternal_border_width, parms)))
5058 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5059 if (NILP (Fassq (Qborder_width, parms)))
5060 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5061 if (NILP (Fassq (Qborder_color, parms)))
5062 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5063 if (NILP (Fassq (Qbackground_color, parms)))
5064 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5065 parms);
5067 /* Create a frame for the tooltip, and record it in the global
5068 variable tip_frame. */
5069 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
5070 f = XFRAME (frame);
5072 /* Set up the frame's root window. */
5073 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5074 w->left_col = w->top_line = make_number (0);
5076 if (CONSP (Vx_max_tooltip_size)
5077 && INTEGERP (XCAR (Vx_max_tooltip_size))
5078 && XINT (XCAR (Vx_max_tooltip_size)) > 0
5079 && INTEGERP (XCDR (Vx_max_tooltip_size))
5080 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
5082 w->total_cols = XCAR (Vx_max_tooltip_size);
5083 w->total_lines = XCDR (Vx_max_tooltip_size);
5085 else
5087 w->total_cols = make_number (80);
5088 w->total_lines = make_number (40);
5091 FRAME_TOTAL_COLS (f) = XINT (w->total_cols);
5092 adjust_glyphs (f);
5093 w->pseudo_window_p = 1;
5095 /* Display the tooltip text in a temporary buffer. */
5096 old_buffer = current_buffer;
5097 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
5098 BVAR (current_buffer, truncate_lines) = Qnil;
5099 clear_glyph_matrix (w->desired_matrix);
5100 clear_glyph_matrix (w->current_matrix);
5101 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5102 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
5104 /* Compute width and height of the tooltip. */
5105 width = height = seen_reversed_p = 0;
5106 for (i = 0; i < w->desired_matrix->nrows; ++i)
5108 struct glyph_row *row = &w->desired_matrix->rows[i];
5109 struct glyph *last;
5110 int row_width;
5112 /* Stop at the first empty row at the end. */
5113 if (!row->enabled_p || !row->displays_text_p)
5114 break;
5116 /* Let the row go over the full width of the frame. */
5117 row->full_width_p = 1;
5119 row_width = row->pixel_width;
5120 if (row->used[TEXT_AREA])
5122 /* There's a glyph at the end of rows that is used to place
5123 the cursor there. Don't include the width of this glyph. */
5124 if (!row->reversed_p)
5126 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5127 if (INTEGERP (last->object))
5128 row_width -= last->pixel_width;
5130 else
5132 /* There could be a stretch glyph at the beginning of R2L
5133 rows that is produced by extend_face_to_end_of_line.
5134 Don't count that glyph. */
5135 struct glyph *g = row->glyphs[TEXT_AREA];
5137 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
5139 row_width -= g->pixel_width;
5140 seen_reversed_p = 1;
5145 height += row->height;
5146 width = max (width, row_width);
5149 /* If we've seen partial-length R2L rows, we need to re-adjust the
5150 tool-tip frame width and redisplay it again, to avoid over-wide
5151 tips due to the stretch glyph that extends R2L lines to full
5152 width of the frame. */
5153 if (seen_reversed_p)
5155 /* w->total_cols and FRAME_TOTAL_COLS want the width in columns,
5156 not in pixels. */
5157 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
5158 w->total_cols = make_number (width);
5159 FRAME_TOTAL_COLS (f) = width;
5160 adjust_glyphs (f);
5161 clear_glyph_matrix (w->desired_matrix);
5162 clear_glyph_matrix (w->current_matrix);
5163 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5164 width = height = 0;
5165 /* Recompute width and height of the tooltip. */
5166 for (i = 0; i < w->desired_matrix->nrows; ++i)
5168 struct glyph_row *row = &w->desired_matrix->rows[i];
5169 struct glyph *last;
5170 int row_width;
5172 if (!row->enabled_p || !row->displays_text_p)
5173 break;
5174 row->full_width_p = 1;
5175 row_width = row->pixel_width;
5176 if (row->used[TEXT_AREA] && !row->reversed_p)
5178 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5179 if (INTEGERP (last->object))
5180 row_width -= last->pixel_width;
5183 height += row->height;
5184 width = max (width, row_width);
5188 /* Add the frame's internal border to the width and height the X
5189 window should have. */
5190 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5191 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5193 /* Move the tooltip window where the mouse pointer is. Resize and
5194 show it. */
5195 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5197 BLOCK_INPUT;
5198 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5199 root_x, root_y, width, height);
5200 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5201 UNBLOCK_INPUT;
5203 /* Draw into the window. */
5204 w->must_be_updated_p = 1;
5205 update_single_window (w, 1);
5207 /* Restore original current buffer. */
5208 set_buffer_internal_1 (old_buffer);
5209 windows_or_buffers_changed = old_windows_or_buffers_changed;
5211 start_timer:
5212 /* Let the tip disappear after timeout seconds. */
5213 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5214 intern ("x-hide-tip"));
5216 UNGCPRO;
5217 return unbind_to (count, Qnil);
5221 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5222 doc: /* Hide the current tooltip window, if there is any.
5223 Value is t if tooltip was open, nil otherwise. */)
5224 (void)
5226 int count;
5227 Lisp_Object deleted, frame, timer;
5228 struct gcpro gcpro1, gcpro2;
5230 /* Return quickly if nothing to do. */
5231 if (NILP (tip_timer) && NILP (tip_frame))
5232 return Qnil;
5234 frame = tip_frame;
5235 timer = tip_timer;
5236 GCPRO2 (frame, timer);
5237 tip_frame = tip_timer = deleted = Qnil;
5239 count = SPECPDL_INDEX ();
5240 specbind (Qinhibit_redisplay, Qt);
5241 specbind (Qinhibit_quit, Qt);
5243 if (!NILP (timer))
5244 call1 (Qcancel_timer, timer);
5246 #ifdef USE_GTK
5248 /* When using system tooltip, tip_frame is the Emacs frame on which
5249 the tip is shown. */
5250 struct frame *f = XFRAME (frame);
5251 if (FRAME_LIVE_P (f) && xg_hide_tooltip (f))
5252 frame = Qnil;
5254 #endif
5256 if (FRAMEP (frame))
5258 delete_frame (frame, Qnil);
5259 deleted = Qt;
5261 #ifdef USE_LUCID
5262 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5263 redisplay procedure is not called when a tip frame over menu
5264 items is unmapped. Redisplay the menu manually... */
5266 Widget w;
5267 struct frame *f = SELECTED_FRAME ();
5268 w = f->output_data.x->menubar_widget;
5270 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
5271 && w != NULL)
5273 BLOCK_INPUT;
5274 xlwmenu_redisplay (w);
5275 UNBLOCK_INPUT;
5278 #endif /* USE_LUCID */
5281 UNGCPRO;
5282 return unbind_to (count, deleted);
5287 /***********************************************************************
5288 File selection dialog
5289 ***********************************************************************/
5291 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5292 Sx_uses_old_gtk_dialog,
5293 0, 0, 0,
5294 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5295 (void)
5297 #ifdef USE_GTK
5298 if (use_dialog_box
5299 && use_file_dialog
5300 && have_menus_p ()
5301 && xg_uses_old_file_dialog ())
5302 return Qt;
5303 #endif
5304 return Qnil;
5308 #ifdef USE_MOTIF
5309 /* Callback for "OK" and "Cancel" on file selection dialog. */
5311 static void
5312 file_dialog_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5314 int *result = (int *) client_data;
5315 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
5316 *result = cb->reason;
5320 /* Callback for unmapping a file selection dialog. This is used to
5321 capture the case where a dialog is closed via a window manager's
5322 closer button, for example. Using a XmNdestroyCallback didn't work
5323 in this case. */
5325 static void
5326 file_dialog_unmap_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5328 int *result = (int *) client_data;
5329 *result = XmCR_CANCEL;
5332 static Lisp_Object
5333 clean_up_file_dialog (Lisp_Object arg)
5335 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
5336 Widget dialog = (Widget) p->pointer;
5338 /* Clean up. */
5339 BLOCK_INPUT;
5340 XtUnmanageChild (dialog);
5341 XtDestroyWidget (dialog);
5342 x_menu_set_in_use (0);
5343 UNBLOCK_INPUT;
5345 return Qnil;
5349 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5350 doc: /* Read file name, prompting with PROMPT in directory DIR.
5351 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5352 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5353 or directory must exist.
5355 This function is only defined on MS Windows, and X Windows with the
5356 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5357 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5358 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
5360 int result;
5361 struct frame *f = SELECTED_FRAME ();
5362 Lisp_Object file = Qnil;
5363 Lisp_Object decoded_file;
5364 Widget dialog, text, help;
5365 Arg al[10];
5366 int ac = 0;
5367 XmString dir_xmstring, pattern_xmstring;
5368 int count = SPECPDL_INDEX ();
5369 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5371 check_x ();
5373 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5375 if (popup_activated ())
5376 error ("Trying to use a menu from within a menu-entry");
5378 CHECK_STRING (prompt);
5379 CHECK_STRING (dir);
5381 /* Prevent redisplay. */
5382 specbind (Qinhibit_redisplay, Qt);
5384 BLOCK_INPUT;
5386 /* Create the dialog with PROMPT as title, using DIR as initial
5387 directory and using "*" as pattern. */
5388 dir = Fexpand_file_name (dir, Qnil);
5389 dir_xmstring = XmStringCreateLocalized (SDATA (dir));
5390 pattern_xmstring = XmStringCreateLocalized ("*");
5392 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5393 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5394 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5395 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5396 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5397 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5398 "fsb", al, ac);
5399 XmStringFree (dir_xmstring);
5400 XmStringFree (pattern_xmstring);
5402 /* Add callbacks for OK and Cancel. */
5403 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5404 (XtPointer) &result);
5405 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5406 (XtPointer) &result);
5407 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5408 (XtPointer) &result);
5410 /* Remove the help button since we can't display help. */
5411 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5412 XtUnmanageChild (help);
5414 /* Mark OK button as default. */
5415 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5416 XmNshowAsDefault, True, NULL);
5418 /* If MUSTMATCH is non-nil, disable the file entry field of the
5419 dialog, so that the user must select a file from the files list
5420 box. We can't remove it because we wouldn't have a way to get at
5421 the result file name, then. */
5422 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5423 if (!NILP (mustmatch))
5425 Widget label;
5426 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5427 XtSetSensitive (text, False);
5428 XtSetSensitive (label, False);
5431 /* Manage the dialog, so that list boxes get filled. */
5432 XtManageChild (dialog);
5434 if (STRINGP (default_filename))
5436 XmString default_xmstring;
5437 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5438 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5440 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5441 XmTextFieldReplace (wtext, 0, last_pos,
5442 (SDATA (Ffile_name_nondirectory (default_filename))));
5444 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5445 must include the path for this to work. */
5447 default_xmstring = XmStringCreateLocalized (SDATA (default_filename));
5449 if (XmListItemExists (list, default_xmstring))
5451 int item_pos = XmListItemPos (list, default_xmstring);
5452 /* Select the item and scroll it into view. */
5453 XmListSelectPos (list, item_pos, True);
5454 XmListSetPos (list, item_pos);
5457 XmStringFree (default_xmstring);
5460 record_unwind_protect (clean_up_file_dialog, make_save_value (dialog, 0));
5462 /* Process events until the user presses Cancel or OK. */
5463 x_menu_set_in_use (1);
5464 result = 0;
5465 while (result == 0)
5467 XEvent event;
5468 x_menu_wait_for_event (0);
5469 XtAppNextEvent (Xt_app_con, &event);
5470 if (event.type == KeyPress
5471 && FRAME_X_DISPLAY (f) == event.xkey.display)
5473 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5475 /* Pop down on C-g. */
5476 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5477 XtUnmanageChild (dialog);
5480 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5483 /* Get the result. */
5484 if (result == XmCR_OK)
5486 XmString text_string;
5487 String data;
5489 XtVaGetValues (dialog, XmNtextString, &text_string, NULL);
5490 XmStringGetLtoR (text_string, XmFONTLIST_DEFAULT_TAG, &data);
5491 XmStringFree (text_string);
5492 file = build_string (data);
5493 XtFree (data);
5495 else
5496 file = Qnil;
5498 UNBLOCK_INPUT;
5499 UNGCPRO;
5501 /* Make "Cancel" equivalent to C-g. */
5502 if (NILP (file))
5503 Fsignal (Qquit, Qnil);
5505 decoded_file = DECODE_FILE (file);
5507 return unbind_to (count, decoded_file);
5510 #endif /* USE_MOTIF */
5512 #ifdef USE_GTK
5514 static Lisp_Object
5515 clean_up_dialog (Lisp_Object arg)
5517 x_menu_set_in_use (0);
5519 return Qnil;
5522 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5523 doc: /* Read file name, prompting with PROMPT in directory DIR.
5524 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5525 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5526 or directory must exist.
5528 This function is only defined on MS Windows, and X Windows with the
5529 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5530 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5531 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
5533 FRAME_PTR f = SELECTED_FRAME ();
5534 char *fn;
5535 Lisp_Object file = Qnil;
5536 Lisp_Object decoded_file;
5537 int count = SPECPDL_INDEX ();
5538 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5539 char *cdef_file;
5541 check_x ();
5543 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5545 if (popup_activated ())
5546 error ("Trying to use a menu from within a menu-entry");
5548 CHECK_STRING (prompt);
5549 CHECK_STRING (dir);
5551 /* Prevent redisplay. */
5552 specbind (Qinhibit_redisplay, Qt);
5553 record_unwind_protect (clean_up_dialog, Qnil);
5555 BLOCK_INPUT;
5557 if (STRINGP (default_filename))
5558 cdef_file = SSDATA (default_filename);
5559 else
5560 cdef_file = SSDATA (dir);
5562 fn = xg_get_file_name (f, SSDATA (prompt), cdef_file,
5563 ! NILP (mustmatch),
5564 ! NILP (only_dir_p));
5566 if (fn)
5568 file = build_string (fn);
5569 xfree (fn);
5572 UNBLOCK_INPUT;
5573 UNGCPRO;
5575 /* Make "Cancel" equivalent to C-g. */
5576 if (NILP (file))
5577 Fsignal (Qquit, Qnil);
5579 decoded_file = DECODE_FILE (file);
5581 return unbind_to (count, decoded_file);
5585 #ifdef HAVE_FREETYPE
5587 DEFUN ("x-select-font", Fx_select_font, Sx_select_font, 0, 2, 0,
5588 doc: /* Read a font name using a GTK font selection dialog.
5589 Return a GTK-style font string corresponding to the selection.
5591 If FRAME is omitted or nil, it defaults to the selected frame. */)
5592 (Lisp_Object frame, Lisp_Object ignored)
5594 FRAME_PTR f = check_x_frame (frame);
5595 char *name;
5596 Lisp_Object font;
5597 Lisp_Object font_param;
5598 char *default_name = NULL;
5599 struct gcpro gcpro1, gcpro2;
5600 int count = SPECPDL_INDEX ();
5602 check_x ();
5604 if (popup_activated ())
5605 error ("Trying to use a menu from within a menu-entry");
5607 /* Prevent redisplay. */
5608 specbind (Qinhibit_redisplay, Qt);
5609 record_unwind_protect (clean_up_dialog, Qnil);
5611 BLOCK_INPUT;
5613 GCPRO2 (font_param, font);
5615 XSETFONT (font, FRAME_FONT (f));
5616 font_param = Ffont_get (font, intern (":name"));
5617 if (STRINGP (font_param))
5618 default_name = xstrdup (SSDATA (font_param));
5619 else
5621 font_param = Fframe_parameter (frame, Qfont_param);
5622 if (STRINGP (font_param))
5623 default_name = xstrdup (SSDATA (font_param));
5626 if (default_name == NULL && x_last_font_name != NULL)
5627 default_name = xstrdup (x_last_font_name);
5629 /* Convert fontconfig names to Gtk names, i.e. remove - before number */
5630 if (default_name)
5632 char *p = strrchr (default_name, '-');
5633 if (p)
5635 char *ep = p+1;
5636 while (isdigit (*ep))
5637 ++ep;
5638 if (*ep == '\0') *p = ' ';
5642 name = xg_get_font_name (f, default_name);
5643 xfree (default_name);
5645 if (name)
5647 font = build_string (name);
5648 g_free (x_last_font_name);
5649 x_last_font_name = name;
5652 UNBLOCK_INPUT;
5654 if (NILP (font))
5655 Fsignal (Qquit, Qnil);
5657 return unbind_to (count, font);
5659 #endif /* HAVE_FREETYPE */
5661 #endif /* USE_GTK */
5664 /***********************************************************************
5665 Keyboard
5666 ***********************************************************************/
5668 #ifdef HAVE_XKBGETKEYBOARD
5669 #include <X11/XKBlib.h>
5670 #include <X11/keysym.h>
5671 #endif
5673 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
5674 Sx_backspace_delete_keys_p, 0, 1, 0,
5675 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
5676 FRAME nil means use the selected frame.
5677 Value is t if we know that both keys are present, and are mapped to the
5678 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
5679 present and mapped to the usual X keysyms. */)
5680 (Lisp_Object frame)
5682 #ifdef HAVE_XKBGETKEYBOARD
5683 XkbDescPtr kb;
5684 struct frame *f = check_x_frame (frame);
5685 Display *dpy = FRAME_X_DISPLAY (f);
5686 Lisp_Object have_keys;
5687 int major, minor, op, event, error_code;
5689 BLOCK_INPUT;
5691 /* Check library version in case we're dynamically linked. */
5692 major = XkbMajorVersion;
5693 minor = XkbMinorVersion;
5694 if (!XkbLibraryVersion (&major, &minor))
5696 UNBLOCK_INPUT;
5697 return Qlambda;
5700 /* Check that the server supports XKB. */
5701 major = XkbMajorVersion;
5702 minor = XkbMinorVersion;
5703 if (!XkbQueryExtension (dpy, &op, &event, &error_code, &major, &minor))
5705 UNBLOCK_INPUT;
5706 return Qlambda;
5709 /* In this code we check that the keyboard has physical keys with names
5710 that start with BKSP (Backspace) and DELE (Delete), and that they
5711 generate keysym XK_BackSpace and XK_Delete respectively.
5712 This function is used to test if normal-erase-is-backspace should be
5713 turned on.
5714 An alternative approach would be to just check if XK_BackSpace and
5715 XK_Delete are mapped to any key. But if any of those are mapped to
5716 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
5717 user doesn't know about it, it is better to return false here.
5718 It is more obvious to the user what to do if she/he has two keys
5719 clearly marked with names/symbols and one key does something not
5720 expected (i.e. she/he then tries the other).
5721 The cases where Backspace/Delete is mapped to some other key combination
5722 are rare, and in those cases, normal-erase-is-backspace can be turned on
5723 manually. */
5725 have_keys = Qnil;
5726 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
5727 if (kb)
5729 int delete_keycode = 0, backspace_keycode = 0, i;
5731 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
5733 for (i = kb->min_key_code;
5734 (i < kb->max_key_code
5735 && (delete_keycode == 0 || backspace_keycode == 0));
5736 ++i)
5738 /* The XKB symbolic key names can be seen most easily in
5739 the PS file generated by `xkbprint -label name
5740 $DISPLAY'. */
5741 if (memcmp ("DELE", kb->names->keys[i].name, 4) == 0)
5742 delete_keycode = i;
5743 else if (memcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
5744 backspace_keycode = i;
5747 XkbFreeNames (kb, 0, True);
5750 XkbFreeClientMap (kb, 0, True);
5752 if (delete_keycode
5753 && backspace_keycode
5754 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
5755 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
5756 have_keys = Qt;
5758 UNBLOCK_INPUT;
5759 return have_keys;
5760 #else /* not HAVE_XKBGETKEYBOARD */
5761 return Qlambda;
5762 #endif /* not HAVE_XKBGETKEYBOARD */
5767 /***********************************************************************
5768 Initialization
5769 ***********************************************************************/
5771 /* Keep this list in the same order as frame_parms in frame.c.
5772 Use 0 for unsupported frame parameters. */
5774 frame_parm_handler x_frame_parm_handlers[] =
5776 x_set_autoraise,
5777 x_set_autolower,
5778 x_set_background_color,
5779 x_set_border_color,
5780 x_set_border_width,
5781 x_set_cursor_color,
5782 x_set_cursor_type,
5783 x_set_font,
5784 x_set_foreground_color,
5785 x_set_icon_name,
5786 x_set_icon_type,
5787 x_set_internal_border_width,
5788 x_set_menu_bar_lines,
5789 x_set_mouse_color,
5790 x_explicitly_set_name,
5791 x_set_scroll_bar_width,
5792 x_set_title,
5793 x_set_unsplittable,
5794 x_set_vertical_scroll_bars,
5795 x_set_visibility,
5796 x_set_tool_bar_lines,
5797 x_set_scroll_bar_foreground,
5798 x_set_scroll_bar_background,
5799 x_set_screen_gamma,
5800 x_set_line_spacing,
5801 x_set_fringe_width,
5802 x_set_fringe_width,
5803 x_set_wait_for_wm,
5804 x_set_fullscreen,
5805 x_set_font_backend,
5806 x_set_alpha,
5807 x_set_sticky,
5808 x_set_tool_bar_position,
5811 void
5812 syms_of_xfns (void)
5814 /* This is zero if not using X windows. */
5815 x_in_use = 0;
5817 /* The section below is built by the lisp expression at the top of the file,
5818 just above where these variables are declared. */
5819 /*&&& init symbols here &&&*/
5820 DEFSYM (Qnone, "none");
5821 DEFSYM (Qsuppress_icon, "suppress-icon");
5822 DEFSYM (Qundefined_color, "undefined-color");
5823 DEFSYM (Qcompound_text, "compound-text");
5824 DEFSYM (Qcancel_timer, "cancel-timer");
5825 DEFSYM (Qfont_param, "font-parameter");
5826 /* This is the end of symbol initialization. */
5828 Fput (Qundefined_color, Qerror_conditions,
5829 pure_cons (Qundefined_color, pure_cons (Qerror, Qnil)));
5830 Fput (Qundefined_color, Qerror_message,
5831 make_pure_c_string ("Undefined color"));
5833 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
5834 doc: /* The shape of the pointer when over text.
5835 Changing the value does not affect existing frames
5836 unless you set the mouse color. */);
5837 Vx_pointer_shape = Qnil;
5839 #if 0 /* This doesn't really do anything. */
5840 DEFVAR_LISP ("x-nontext-pointer-shape", Vx_nontext_pointer_shape,
5841 doc: /* The shape of the pointer when not over text.
5842 This variable takes effect when you create a new frame
5843 or when you set the mouse color. */);
5844 #endif
5845 Vx_nontext_pointer_shape = Qnil;
5847 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
5848 doc: /* The shape of the pointer when Emacs is busy.
5849 This variable takes effect when you create a new frame
5850 or when you set the mouse color. */);
5851 Vx_hourglass_pointer_shape = Qnil;
5853 #if 0 /* This doesn't really do anything. */
5854 DEFVAR_LISP ("x-mode-pointer-shape", Vx_mode_pointer_shape,
5855 doc: /* The shape of the pointer when over the mode line.
5856 This variable takes effect when you create a new frame
5857 or when you set the mouse color. */);
5858 #endif
5859 Vx_mode_pointer_shape = Qnil;
5861 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
5862 Vx_sensitive_text_pointer_shape,
5863 doc: /* The shape of the pointer when over mouse-sensitive text.
5864 This variable takes effect when you create a new frame
5865 or when you set the mouse color. */);
5866 Vx_sensitive_text_pointer_shape = Qnil;
5868 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
5869 Vx_window_horizontal_drag_shape,
5870 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
5871 This variable takes effect when you create a new frame
5872 or when you set the mouse color. */);
5873 Vx_window_horizontal_drag_shape = Qnil;
5875 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
5876 doc: /* A string indicating the foreground color of the cursor box. */);
5877 Vx_cursor_fore_pixel = Qnil;
5879 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
5880 doc: /* Maximum size for tooltips.
5881 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
5882 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
5884 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
5885 doc: /* Non-nil if no X window manager is in use.
5886 Emacs doesn't try to figure this out; this is always nil
5887 unless you set it to something else. */);
5888 /* We don't have any way to find this out, so set it to nil
5889 and maybe the user would like to set it to t. */
5890 Vx_no_window_manager = Qnil;
5892 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
5893 Vx_pixel_size_width_font_regexp,
5894 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
5896 Since Emacs gets width of a font matching with this regexp from
5897 PIXEL_SIZE field of the name, font finding mechanism gets faster for
5898 such a font. This is especially effective for such large fonts as
5899 Chinese, Japanese, and Korean. */);
5900 Vx_pixel_size_width_font_regexp = Qnil;
5902 /* This is not ifdef:ed, so other builds than GTK can customize it. */
5903 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", x_gtk_use_old_file_dialog,
5904 doc: /* *Non-nil means prompt with the old GTK file selection dialog.
5905 If nil or if the file selection dialog is not available, the new GTK file
5906 chooser is used instead. To turn off all file dialogs set the
5907 variable `use-file-dialog'. */);
5908 x_gtk_use_old_file_dialog = 0;
5910 DEFVAR_BOOL ("x-gtk-show-hidden-files", x_gtk_show_hidden_files,
5911 doc: /* *If non-nil, the GTK file chooser will by default show hidden files.
5912 Note that this is just the default, there is a toggle button on the file
5913 chooser to show or not show hidden files on a case by case basis. */);
5914 x_gtk_show_hidden_files = 0;
5916 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", x_gtk_file_dialog_help_text,
5917 doc: /* *If non-nil, the GTK file chooser will show additional help text.
5918 If more space for files in the file chooser dialog is wanted, set this to nil
5919 to turn the additional text off. */);
5920 x_gtk_file_dialog_help_text = 1;
5922 DEFVAR_BOOL ("x-gtk-whole-detached-tool-bar", x_gtk_whole_detached_tool_bar,
5923 doc: /* *If non-nil, a detached tool bar is shown in full.
5924 The default is to just show an arrow and pressing on that arrow shows
5925 the tool bar buttons. */);
5926 x_gtk_whole_detached_tool_bar = 0;
5928 DEFVAR_BOOL ("x-gtk-use-system-tooltips", x_gtk_use_system_tooltips,
5929 doc: /* *If non-nil with a Gtk+ built Emacs, the Gtk+ tooltip is used.
5930 Otherwise use Emacs own tooltip implementation.
5931 When using Gtk+ tooltips, the tooltip face is not used. */);
5932 x_gtk_use_system_tooltips = 1;
5934 Fprovide (intern_c_string ("x"), Qnil);
5936 #ifdef USE_X_TOOLKIT
5937 Fprovide (intern_c_string ("x-toolkit"), Qnil);
5938 #ifdef USE_MOTIF
5939 Fprovide (intern_c_string ("motif"), Qnil);
5941 DEFVAR_LISP ("motif-version-string", Vmotif_version_string,
5942 doc: /* Version info for LessTif/Motif. */);
5943 Vmotif_version_string = build_string (XmVERSION_STRING);
5944 #endif /* USE_MOTIF */
5945 #endif /* USE_X_TOOLKIT */
5947 #ifdef USE_GTK
5948 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
5949 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
5950 But for a user it is a toolkit for X, and indeed, configure
5951 accepts --with-x-toolkit=gtk. */
5952 Fprovide (intern_c_string ("x-toolkit"), Qnil);
5953 Fprovide (intern_c_string ("gtk"), Qnil);
5954 Fprovide (intern_c_string ("move-toolbar"), Qnil);
5956 DEFVAR_LISP ("gtk-version-string", Vgtk_version_string,
5957 doc: /* Version info for GTK+. */);
5959 char gtk_version[40];
5960 g_snprintf (gtk_version, sizeof (gtk_version), "%u.%u.%u",
5961 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
5962 Vgtk_version_string = make_pure_string (gtk_version, strlen (gtk_version), strlen (gtk_version), 0);
5964 #endif /* USE_GTK */
5966 /* X window properties. */
5967 defsubr (&Sx_change_window_property);
5968 defsubr (&Sx_delete_window_property);
5969 defsubr (&Sx_window_property);
5971 defsubr (&Sxw_display_color_p);
5972 defsubr (&Sx_display_grayscale_p);
5973 defsubr (&Sxw_color_defined_p);
5974 defsubr (&Sxw_color_values);
5975 defsubr (&Sx_server_max_request_size);
5976 defsubr (&Sx_server_vendor);
5977 defsubr (&Sx_server_version);
5978 defsubr (&Sx_display_pixel_width);
5979 defsubr (&Sx_display_pixel_height);
5980 defsubr (&Sx_display_mm_width);
5981 defsubr (&Sx_display_mm_height);
5982 defsubr (&Sx_display_screens);
5983 defsubr (&Sx_display_planes);
5984 defsubr (&Sx_display_color_cells);
5985 defsubr (&Sx_display_visual_class);
5986 defsubr (&Sx_display_backing_store);
5987 defsubr (&Sx_display_save_under);
5988 defsubr (&Sx_wm_set_size_hint);
5989 defsubr (&Sx_create_frame);
5990 defsubr (&Sx_open_connection);
5991 defsubr (&Sx_close_connection);
5992 defsubr (&Sx_display_list);
5993 defsubr (&Sx_synchronize);
5994 defsubr (&Sx_focus_frame);
5995 defsubr (&Sx_backspace_delete_keys_p);
5997 /* Setting callback functions for fontset handler. */
5998 check_window_system_func = check_x;
6000 defsubr (&Sx_show_tip);
6001 defsubr (&Sx_hide_tip);
6002 tip_timer = Qnil;
6003 staticpro (&tip_timer);
6004 tip_frame = Qnil;
6005 staticpro (&tip_frame);
6007 last_show_tip_args = Qnil;
6008 staticpro (&last_show_tip_args);
6010 defsubr (&Sx_uses_old_gtk_dialog);
6011 #if defined (USE_MOTIF) || defined (USE_GTK)
6012 defsubr (&Sx_file_dialog);
6013 #endif
6015 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
6016 defsubr (&Sx_select_font);
6017 x_last_font_name = NULL;
6018 #endif
6021 #endif /* HAVE_X_WINDOWS */