lisp/textmodes/bibtex.el: new command bibtex-search-entries
[emacs.git] / src / xfns.c
blobf3dc493ff8514d90dfd7afd39f876753e684e6f6
1 /* Functions for the X window system.
3 Copyright (C) 1989, 1992-2011 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 int image_cache_refcount, dpyinfo_refcount;
149 #endif
151 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
152 static char *x_last_font_name;
153 #endif
155 static struct x_display_info *x_display_info_for_name (Lisp_Object);
158 /* Error if we are not connected to X. */
160 void
161 check_x (void)
163 if (! x_in_use)
164 error ("X windows are not in use or not initialized");
167 /* Nonzero if we can use mouse menus.
168 You should not call this unless HAVE_MENUS is defined. */
171 have_menus_p (void)
173 return x_in_use;
176 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
177 and checking validity for X. */
179 FRAME_PTR
180 check_x_frame (Lisp_Object frame)
182 FRAME_PTR f;
184 if (NILP (frame))
185 frame = selected_frame;
186 CHECK_LIVE_FRAME (frame);
187 f = XFRAME (frame);
188 if (! FRAME_X_P (f))
189 error ("Non-X frame used");
190 return f;
193 /* Let the user specify an X display with a Lisp object.
194 OBJECT may be nil, a frame or a terminal object.
195 nil stands for the selected frame--or, if that is not an X frame,
196 the first X display on the list. */
198 struct x_display_info *
199 check_x_display_info (Lisp_Object object)
201 struct x_display_info *dpyinfo = NULL;
203 if (NILP (object))
205 struct frame *sf = XFRAME (selected_frame);
207 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
208 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
209 else if (x_display_list != 0)
210 dpyinfo = x_display_list;
211 else
212 error ("X windows are not in use or not initialized");
214 else if (TERMINALP (object))
216 struct terminal *t = get_terminal (object, 1);
218 if (t->type != output_x_window)
219 error ("Terminal %"pI"d is not an X display", XINT (object));
221 dpyinfo = t->display_info.x;
223 else if (STRINGP (object))
224 dpyinfo = x_display_info_for_name (object);
225 else
227 FRAME_PTR f = check_x_frame (object);
228 dpyinfo = FRAME_X_DISPLAY_INFO (f);
231 return dpyinfo;
235 /* Return the Emacs frame-object corresponding to an X window.
236 It could be the frame's main window or an icon window. */
238 /* This function can be called during GC, so use GC_xxx type test macros. */
240 struct frame *
241 x_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
243 Lisp_Object tail, frame;
244 struct frame *f;
246 if (wdesc == None) return 0;
248 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
250 frame = XCAR (tail);
251 if (!FRAMEP (frame))
252 continue;
253 f = XFRAME (frame);
254 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
255 continue;
256 if (f->output_data.x->hourglass_window == wdesc)
257 return f;
258 #ifdef USE_X_TOOLKIT
259 if ((f->output_data.x->edit_widget
260 && XtWindow (f->output_data.x->edit_widget) == wdesc)
261 /* A tooltip frame? */
262 || (!f->output_data.x->edit_widget
263 && FRAME_X_WINDOW (f) == wdesc)
264 || f->output_data.x->icon_desc == wdesc)
265 return f;
266 #else /* not USE_X_TOOLKIT */
267 #ifdef USE_GTK
268 if (f->output_data.x->edit_widget)
270 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
271 struct x_output *x = f->output_data.x;
272 if (gwdesc != 0 && gwdesc == x->edit_widget)
273 return f;
275 #endif /* USE_GTK */
276 if (FRAME_X_WINDOW (f) == wdesc
277 || f->output_data.x->icon_desc == wdesc)
278 return f;
279 #endif /* not USE_X_TOOLKIT */
281 return 0;
284 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
285 /* Like x_window_to_frame but also compares the window with the widget's
286 windows. */
288 struct frame *
289 x_any_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
291 Lisp_Object tail, frame;
292 struct frame *f, *found;
293 struct x_output *x;
295 if (wdesc == None) return NULL;
297 found = NULL;
298 for (tail = Vframe_list; CONSP (tail) && !found; tail = XCDR (tail))
300 frame = XCAR (tail);
301 if (!FRAMEP (frame))
302 continue;
304 f = XFRAME (frame);
305 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
307 /* This frame matches if the window is any of its widgets. */
308 x = f->output_data.x;
309 if (x->hourglass_window == wdesc)
310 found = f;
311 else if (x->widget)
313 #ifdef USE_GTK
314 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
315 if (gwdesc != 0
316 && gtk_widget_get_toplevel (gwdesc) == x->widget)
317 found = f;
318 #else
319 if (wdesc == XtWindow (x->widget)
320 || wdesc == XtWindow (x->column_widget)
321 || wdesc == XtWindow (x->edit_widget))
322 found = f;
323 /* Match if the window is this frame's menubar. */
324 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
325 found = f;
326 #endif
328 else if (FRAME_X_WINDOW (f) == wdesc)
329 /* A tooltip frame. */
330 found = f;
334 return found;
337 /* Likewise, but consider only the menu bar widget. */
339 struct frame *
340 x_menubar_window_to_frame (struct x_display_info *dpyinfo, XEvent *event)
342 Window wdesc = event->xany.window;
343 Lisp_Object tail, frame;
344 struct frame *f;
345 struct x_output *x;
347 if (wdesc == None) return 0;
349 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
351 frame = XCAR (tail);
352 if (!FRAMEP (frame))
353 continue;
354 f = XFRAME (frame);
355 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
356 continue;
357 x = f->output_data.x;
358 #ifdef USE_GTK
359 if (x->menubar_widget && xg_event_is_for_menubar (f, event))
360 return f;
361 #else
362 /* Match if the window is this frame's menubar. */
363 if (x->menubar_widget
364 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
365 return f;
366 #endif
368 return 0;
371 /* Return the frame whose principal (outermost) window is WDESC.
372 If WDESC is some other (smaller) window, we return 0. */
374 struct frame *
375 x_top_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
377 Lisp_Object tail, frame;
378 struct frame *f;
379 struct x_output *x;
381 if (wdesc == None) return 0;
383 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
385 frame = XCAR (tail);
386 if (!FRAMEP (frame))
387 continue;
388 f = XFRAME (frame);
389 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
390 continue;
391 x = f->output_data.x;
393 if (x->widget)
395 /* This frame matches if the window is its topmost widget. */
396 #ifdef USE_GTK
397 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
398 if (gwdesc == x->widget)
399 return f;
400 #else
401 if (wdesc == XtWindow (x->widget))
402 return f;
403 #if 0 /* I don't know why it did this,
404 but it seems logically wrong,
405 and it causes trouble for MapNotify events. */
406 /* Match if the window is this frame's menubar. */
407 if (x->menubar_widget
408 && wdesc == XtWindow (x->menubar_widget))
409 return f;
410 #endif
411 #endif
413 else if (FRAME_X_WINDOW (f) == wdesc)
414 /* Tooltip frame. */
415 return f;
417 return 0;
419 #endif /* USE_X_TOOLKIT || USE_GTK */
423 /* Store the screen positions of frame F into XPTR and YPTR.
424 These are the positions of the containing window manager window,
425 not Emacs's own window. */
427 void
428 x_real_positions (FRAME_PTR f, int *xptr, int *yptr)
430 int win_x, win_y, outer_x IF_LINT (= 0), outer_y IF_LINT (= 0);
431 int real_x = 0, real_y = 0;
432 int had_errors = 0;
433 Window win = f->output_data.x->parent_desc;
434 Atom actual_type;
435 unsigned long actual_size, bytes_remaining;
436 int rc, actual_format;
437 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
438 long max_len = 400;
439 Display *dpy = FRAME_X_DISPLAY (f);
440 unsigned char *tmp_data = NULL;
441 Atom target_type = XA_CARDINAL;
443 BLOCK_INPUT;
445 x_catch_errors (dpy);
447 if (win == dpyinfo->root_window)
448 win = FRAME_OUTER_WINDOW (f);
450 /* This loop traverses up the containment tree until we hit the root
451 window. Window managers may intersect many windows between our window
452 and the root window. The window we find just before the root window
453 should be the outer WM window. */
454 for (;;)
456 Window wm_window, rootw;
457 Window *tmp_children;
458 unsigned int tmp_nchildren;
459 int success;
461 success = XQueryTree (FRAME_X_DISPLAY (f), win, &rootw,
462 &wm_window, &tmp_children, &tmp_nchildren);
464 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
466 /* Don't free tmp_children if XQueryTree failed. */
467 if (! success)
468 break;
470 XFree ((char *) tmp_children);
472 if (wm_window == rootw || had_errors)
473 break;
475 win = wm_window;
478 if (! had_errors)
480 unsigned int ign;
481 Window child, rootw;
483 /* Get the real coordinates for the WM window upper left corner */
484 XGetGeometry (FRAME_X_DISPLAY (f), win,
485 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
487 /* Translate real coordinates to coordinates relative to our
488 window. For our window, the upper left corner is 0, 0.
489 Since the upper left corner of the WM window is outside
490 our window, win_x and win_y will be negative:
492 ------------------ ---> x
493 | title |
494 | ----------------- v y
495 | | our window
497 XTranslateCoordinates (FRAME_X_DISPLAY (f),
499 /* From-window, to-window. */
500 FRAME_X_DISPLAY_INFO (f)->root_window,
501 FRAME_X_WINDOW (f),
503 /* From-position, to-position. */
504 real_x, real_y, &win_x, &win_y,
506 /* Child of win. */
507 &child);
509 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
511 outer_x = win_x;
512 outer_y = win_y;
514 else
516 XTranslateCoordinates (FRAME_X_DISPLAY (f),
518 /* From-window, to-window. */
519 FRAME_X_DISPLAY_INFO (f)->root_window,
520 FRAME_OUTER_WINDOW (f),
522 /* From-position, to-position. */
523 real_x, real_y, &outer_x, &outer_y,
525 /* Child of win. */
526 &child);
529 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
533 if (dpyinfo->root_window == f->output_data.x->parent_desc)
535 /* Try _NET_FRAME_EXTENTS if our parent is the root window. */
536 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_frame_extents,
537 0, max_len, False, target_type,
538 &actual_type, &actual_format, &actual_size,
539 &bytes_remaining, &tmp_data);
541 if (rc == Success && actual_type == target_type && !x_had_errors_p (dpy)
542 && actual_size == 4 && actual_format == 32)
544 unsigned int ign;
545 Window rootw;
546 long *fe = (long *)tmp_data;
548 XGetGeometry (FRAME_X_DISPLAY (f), win,
549 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
550 outer_x = -fe[0];
551 outer_y = -fe[2];
552 real_x -= fe[0];
553 real_y -= fe[2];
557 if (tmp_data) XFree (tmp_data);
559 x_uncatch_errors ();
561 UNBLOCK_INPUT;
563 if (had_errors) return;
565 f->x_pixels_diff = -win_x;
566 f->y_pixels_diff = -win_y;
568 FRAME_X_OUTPUT (f)->x_pixels_outer_diff = -outer_x;
569 FRAME_X_OUTPUT (f)->y_pixels_outer_diff = -outer_y;
571 *xptr = real_x;
572 *yptr = real_y;
578 /* Gamma-correct COLOR on frame F. */
580 void
581 gamma_correct (struct frame *f, XColor *color)
583 if (f->gamma)
585 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
586 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
587 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
592 /* Decide if color named COLOR_NAME is valid for use on frame F. If
593 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
594 allocate the color. Value is zero if COLOR_NAME is invalid, or
595 no color could be allocated. */
598 x_defined_color (struct frame *f, const char *color_name,
599 XColor *color, int alloc_p)
601 int success_p = 0;
602 Display *dpy = FRAME_X_DISPLAY (f);
603 Colormap cmap = FRAME_X_COLORMAP (f);
605 BLOCK_INPUT;
606 #ifdef USE_GTK
607 success_p = xg_check_special_colors (f, color_name, color);
608 #endif
609 if (!success_p)
610 success_p = XParseColor (dpy, cmap, color_name, color);
611 if (success_p && alloc_p)
612 success_p = x_alloc_nearest_color (f, cmap, color);
613 UNBLOCK_INPUT;
615 return success_p;
619 /* Return the pixel color value for color COLOR_NAME on frame F. If F
620 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
621 Signal an error if color can't be allocated. */
623 static int
624 x_decode_color (FRAME_PTR f, Lisp_Object color_name, int mono_color)
626 XColor cdef;
628 CHECK_STRING (color_name);
630 #if 0 /* Don't do this. It's wrong when we're not using the default
631 colormap, it makes freeing difficult, and it's probably not
632 an important optimization. */
633 if (strcmp (SDATA (color_name), "black") == 0)
634 return BLACK_PIX_DEFAULT (f);
635 else if (strcmp (SDATA (color_name), "white") == 0)
636 return WHITE_PIX_DEFAULT (f);
637 #endif
639 /* Return MONO_COLOR for monochrome frames. */
640 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
641 return mono_color;
643 /* x_defined_color is responsible for coping with failures
644 by looking for a near-miss. */
645 if (x_defined_color (f, SSDATA (color_name), &cdef, 1))
646 return cdef.pixel;
648 signal_error ("Undefined color", color_name);
653 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
654 the previous value of that parameter, NEW_VALUE is the new value.
655 See also the comment of wait_for_wm in struct x_output. */
657 static void
658 x_set_wait_for_wm (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
660 f->output_data.x->wait_for_wm = !NILP (new_value);
663 static void
664 x_set_tool_bar_position (struct frame *f,
665 Lisp_Object new_value,
666 Lisp_Object old_value)
668 if (! EQ (new_value, Qleft) && ! EQ (new_value, Qright)
669 && ! EQ (new_value, Qbottom) && ! EQ (new_value, Qtop))
670 return;
671 if (EQ (new_value, old_value)) return;
673 #ifdef USE_GTK
674 if (xg_change_toolbar_position (f, new_value))
675 f->tool_bar_position = new_value;
676 #endif
679 #ifdef USE_GTK
681 /* Set icon from FILE for frame F. By using GTK functions the icon
682 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
685 xg_set_icon (FRAME_PTR f, Lisp_Object file)
687 int result = 0;
688 Lisp_Object found;
690 found = x_find_image_file (file);
692 if (! NILP (found))
694 GdkPixbuf *pixbuf;
695 GError *err = NULL;
696 char *filename = SSDATA (found);
697 BLOCK_INPUT;
699 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
701 if (pixbuf)
703 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
704 pixbuf);
705 g_object_unref (pixbuf);
707 result = 1;
709 else
710 g_error_free (err);
712 UNBLOCK_INPUT;
715 return result;
719 xg_set_icon_from_xpm_data (FRAME_PTR f, const char **data)
721 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data (data);
723 if (!pixbuf)
724 return 0;
726 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), pixbuf);
727 g_object_unref (pixbuf);
728 return 1;
730 #endif /* USE_GTK */
733 /* Functions called only from `x_set_frame_param'
734 to set individual parameters.
736 If FRAME_X_WINDOW (f) is 0,
737 the frame is being created and its X-window does not exist yet.
738 In that case, just record the parameter's new value
739 in the standard place; do not attempt to change the window. */
741 static void
742 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
744 struct x_output *x = f->output_data.x;
745 unsigned long fg, old_fg;
747 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
748 old_fg = FRAME_FOREGROUND_PIXEL (f);
749 FRAME_FOREGROUND_PIXEL (f) = fg;
751 if (FRAME_X_WINDOW (f) != 0)
753 Display *dpy = FRAME_X_DISPLAY (f);
755 BLOCK_INPUT;
756 XSetForeground (dpy, x->normal_gc, fg);
757 XSetBackground (dpy, x->reverse_gc, fg);
759 if (x->cursor_pixel == old_fg)
761 unload_color (f, x->cursor_pixel);
762 x->cursor_pixel = x_copy_color (f, fg);
763 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
766 UNBLOCK_INPUT;
768 update_face_from_frame_parameter (f, Qforeground_color, arg);
770 if (FRAME_VISIBLE_P (f))
771 redraw_frame (f);
774 unload_color (f, old_fg);
777 static void
778 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
780 struct x_output *x = f->output_data.x;
781 unsigned long bg;
783 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
784 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
785 FRAME_BACKGROUND_PIXEL (f) = bg;
787 if (FRAME_X_WINDOW (f) != 0)
789 Display *dpy = FRAME_X_DISPLAY (f);
791 BLOCK_INPUT;
792 XSetBackground (dpy, x->normal_gc, bg);
793 XSetForeground (dpy, x->reverse_gc, bg);
794 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
795 XSetForeground (dpy, x->cursor_gc, bg);
797 #ifdef USE_GTK
798 xg_set_background_color (f, bg);
799 #endif
801 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
802 toolkit scroll bars. */
804 Lisp_Object bar;
805 for (bar = FRAME_SCROLL_BARS (f);
806 !NILP (bar);
807 bar = XSCROLL_BAR (bar)->next)
809 Window window = XSCROLL_BAR (bar)->x_window;
810 XSetWindowBackground (dpy, window, bg);
813 #endif /* USE_TOOLKIT_SCROLL_BARS */
815 UNBLOCK_INPUT;
816 update_face_from_frame_parameter (f, Qbackground_color, arg);
818 if (FRAME_VISIBLE_P (f))
819 redraw_frame (f);
823 static Cursor
824 make_invisible_cursor (struct frame *f)
826 Display *dpy = FRAME_X_DISPLAY (f);
827 static char const no_data[] = { 0 };
828 Pixmap pix;
829 XColor col;
830 Cursor c = 0;
832 x_catch_errors (dpy);
833 pix = XCreateBitmapFromData (dpy, FRAME_X_DISPLAY_INFO (f)->root_window,
834 no_data, 1, 1);
835 if (! x_had_errors_p (dpy) && pix != None)
837 Cursor pixc;
838 col.pixel = 0;
839 col.red = col.green = col.blue = 0;
840 col.flags = DoRed | DoGreen | DoBlue;
841 pixc = XCreatePixmapCursor (dpy, pix, pix, &col, &col, 0, 0);
842 if (! x_had_errors_p (dpy) && pixc != None)
843 c = pixc;
844 XFreePixmap (dpy, pix);
847 x_uncatch_errors ();
849 return c;
852 static void
853 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
855 struct x_output *x = f->output_data.x;
856 Display *dpy = FRAME_X_DISPLAY (f);
857 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
858 Cursor hourglass_cursor, horizontal_drag_cursor;
859 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
860 unsigned long mask_color = FRAME_BACKGROUND_PIXEL (f);
862 /* Don't let pointers be invisible. */
863 if (mask_color == pixel)
865 x_free_colors (f, &pixel, 1);
866 pixel = x_copy_color (f, FRAME_FOREGROUND_PIXEL (f));
869 unload_color (f, x->mouse_pixel);
870 x->mouse_pixel = pixel;
872 BLOCK_INPUT;
874 /* It's not okay to crash if the user selects a screwy cursor. */
875 x_catch_errors (dpy);
877 if (!NILP (Vx_pointer_shape))
879 CHECK_NUMBER (Vx_pointer_shape);
880 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
882 else
883 cursor = XCreateFontCursor (dpy, XC_xterm);
884 x_check_errors (dpy, "bad text pointer cursor: %s");
886 if (!NILP (Vx_nontext_pointer_shape))
888 CHECK_NUMBER (Vx_nontext_pointer_shape);
889 nontext_cursor
890 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
892 else
893 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
894 x_check_errors (dpy, "bad nontext pointer cursor: %s");
896 if (!NILP (Vx_hourglass_pointer_shape))
898 CHECK_NUMBER (Vx_hourglass_pointer_shape);
899 hourglass_cursor
900 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
902 else
903 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
904 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
906 if (!NILP (Vx_mode_pointer_shape))
908 CHECK_NUMBER (Vx_mode_pointer_shape);
909 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
911 else
912 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
913 x_check_errors (dpy, "bad modeline pointer cursor: %s");
915 if (!NILP (Vx_sensitive_text_pointer_shape))
917 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
918 hand_cursor
919 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
921 else
922 hand_cursor = XCreateFontCursor (dpy, XC_hand2);
924 if (!NILP (Vx_window_horizontal_drag_shape))
926 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
927 horizontal_drag_cursor
928 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
930 else
931 horizontal_drag_cursor
932 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
934 /* Check and report errors with the above calls. */
935 x_check_errors (dpy, "can't set cursor shape: %s");
936 x_uncatch_errors ();
939 XColor fore_color, back_color;
941 fore_color.pixel = x->mouse_pixel;
942 x_query_color (f, &fore_color);
943 back_color.pixel = mask_color;
944 x_query_color (f, &back_color);
946 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
947 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
948 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
949 XRecolorCursor (dpy, hand_cursor, &fore_color, &back_color);
950 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
951 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
954 if (FRAME_X_WINDOW (f) != 0)
955 XDefineCursor (dpy, FRAME_X_WINDOW (f),
956 f->output_data.x->current_cursor = cursor);
958 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor == 0)
959 FRAME_X_DISPLAY_INFO (f)->invisible_cursor = make_invisible_cursor (f);
961 if (cursor != x->text_cursor
962 && x->text_cursor != 0)
963 XFreeCursor (dpy, x->text_cursor);
964 x->text_cursor = cursor;
966 if (nontext_cursor != x->nontext_cursor
967 && x->nontext_cursor != 0)
968 XFreeCursor (dpy, x->nontext_cursor);
969 x->nontext_cursor = nontext_cursor;
971 if (hourglass_cursor != x->hourglass_cursor
972 && x->hourglass_cursor != 0)
973 XFreeCursor (dpy, x->hourglass_cursor);
974 x->hourglass_cursor = hourglass_cursor;
976 if (mode_cursor != x->modeline_cursor
977 && x->modeline_cursor != 0)
978 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
979 x->modeline_cursor = mode_cursor;
981 if (hand_cursor != x->hand_cursor
982 && x->hand_cursor != 0)
983 XFreeCursor (dpy, x->hand_cursor);
984 x->hand_cursor = hand_cursor;
986 if (horizontal_drag_cursor != x->horizontal_drag_cursor
987 && x->horizontal_drag_cursor != 0)
988 XFreeCursor (dpy, x->horizontal_drag_cursor);
989 x->horizontal_drag_cursor = horizontal_drag_cursor;
991 XFlush (dpy);
992 UNBLOCK_INPUT;
994 update_face_from_frame_parameter (f, Qmouse_color, arg);
997 static void
998 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1000 unsigned long fore_pixel, pixel;
1001 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1002 struct x_output *x = f->output_data.x;
1004 if (!NILP (Vx_cursor_fore_pixel))
1006 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1007 WHITE_PIX_DEFAULT (f));
1008 fore_pixel_allocated_p = 1;
1010 else
1011 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1013 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1014 pixel_allocated_p = 1;
1016 /* Make sure that the cursor color differs from the background color. */
1017 if (pixel == FRAME_BACKGROUND_PIXEL (f))
1019 if (pixel_allocated_p)
1021 x_free_colors (f, &pixel, 1);
1022 pixel_allocated_p = 0;
1025 pixel = x->mouse_pixel;
1026 if (pixel == fore_pixel)
1028 if (fore_pixel_allocated_p)
1030 x_free_colors (f, &fore_pixel, 1);
1031 fore_pixel_allocated_p = 0;
1033 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1037 unload_color (f, x->cursor_foreground_pixel);
1038 if (!fore_pixel_allocated_p)
1039 fore_pixel = x_copy_color (f, fore_pixel);
1040 x->cursor_foreground_pixel = fore_pixel;
1042 unload_color (f, x->cursor_pixel);
1043 if (!pixel_allocated_p)
1044 pixel = x_copy_color (f, pixel);
1045 x->cursor_pixel = pixel;
1047 if (FRAME_X_WINDOW (f) != 0)
1049 BLOCK_INPUT;
1050 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
1051 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
1052 UNBLOCK_INPUT;
1054 if (FRAME_VISIBLE_P (f))
1056 x_update_cursor (f, 0);
1057 x_update_cursor (f, 1);
1061 update_face_from_frame_parameter (f, Qcursor_color, arg);
1064 /* Set the border-color of frame F to pixel value PIX.
1065 Note that this does not fully take effect if done before
1066 F has an x-window. */
1068 static void
1069 x_set_border_pixel (struct frame *f, int pix)
1071 unload_color (f, f->output_data.x->border_pixel);
1072 f->output_data.x->border_pixel = pix;
1074 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
1076 BLOCK_INPUT;
1077 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1078 (unsigned long)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 change_window_heights (f->root_window, nlines - olines);
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);
1272 /* Set the number of lines used for the tool bar of frame F to VALUE.
1273 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1274 is the old number of tool bar lines. This function changes the
1275 height of all windows on frame F to match the new tool bar height.
1276 The frame's height doesn't change. */
1278 void
1279 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1281 int delta, nlines, root_height;
1282 Lisp_Object root_window;
1284 /* Treat tool bars like menu bars. */
1285 if (FRAME_MINIBUF_ONLY_P (f))
1286 return;
1288 /* Use VALUE only if an integer >= 0. */
1289 if (INTEGERP (value) && XINT (value) >= 0)
1290 nlines = XFASTINT (value);
1291 else
1292 nlines = 0;
1294 #ifdef USE_GTK
1295 FRAME_TOOL_BAR_LINES (f) = 0;
1296 if (nlines)
1298 FRAME_EXTERNAL_TOOL_BAR (f) = 1;
1299 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1300 /* Make sure next redisplay shows the tool bar. */
1301 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1302 update_frame_tool_bar (f);
1304 else
1306 if (FRAME_EXTERNAL_TOOL_BAR (f))
1307 free_frame_tool_bar (f);
1308 FRAME_EXTERNAL_TOOL_BAR (f) = 0;
1311 return;
1312 #endif
1314 /* Make sure we redisplay all windows in this frame. */
1315 ++windows_or_buffers_changed;
1317 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1319 /* Don't resize the tool-bar to more than we have room for. */
1320 root_window = FRAME_ROOT_WINDOW (f);
1321 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1322 if (root_height - delta < 1)
1324 delta = root_height - 1;
1325 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1328 FRAME_TOOL_BAR_LINES (f) = nlines;
1329 change_window_heights (root_window, delta);
1330 adjust_glyphs (f);
1332 /* We also have to make sure that the internal border at the top of
1333 the frame, below the menu bar or tool bar, is redrawn when the
1334 tool bar disappears. This is so because the internal border is
1335 below the tool bar if one is displayed, but is below the menu bar
1336 if there isn't a tool bar. The tool bar draws into the area
1337 below the menu bar. */
1338 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1340 clear_frame (f);
1341 clear_current_matrices (f);
1344 /* If the tool bar gets smaller, the internal border below it
1345 has to be cleared. It was formerly part of the display
1346 of the larger tool bar, and updating windows won't clear it. */
1347 if (delta < 0)
1349 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1350 int width = FRAME_PIXEL_WIDTH (f);
1351 int y = (FRAME_MENU_BAR_LINES (f) + nlines) * FRAME_LINE_HEIGHT (f);
1353 /* height can be zero here. */
1354 if (height > 0 && width > 0)
1356 BLOCK_INPUT;
1357 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1358 0, y, width, height, False);
1359 UNBLOCK_INPUT;
1362 if (WINDOWP (f->tool_bar_window))
1363 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1368 /* Set the foreground color for scroll bars on frame F to VALUE.
1369 VALUE should be a string, a color name. If it isn't a string or
1370 isn't a valid color name, do nothing. OLDVAL is the old value of
1371 the frame parameter. */
1373 static void
1374 x_set_scroll_bar_foreground (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1376 unsigned long pixel;
1378 if (STRINGP (value))
1379 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1380 else
1381 pixel = -1;
1383 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1384 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1386 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1387 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1389 /* Remove all scroll bars because they have wrong colors. */
1390 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1391 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1392 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1393 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1395 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1396 redraw_frame (f);
1401 /* Set the background color for scroll bars on frame F to VALUE VALUE
1402 should be a string, a color name. If it isn't a string or isn't a
1403 valid color name, do nothing. OLDVAL is the old value of the frame
1404 parameter. */
1406 static void
1407 x_set_scroll_bar_background (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1409 unsigned long pixel;
1411 if (STRINGP (value))
1412 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1413 else
1414 pixel = -1;
1416 if (f->output_data.x->scroll_bar_background_pixel != -1)
1417 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1419 #ifdef USE_TOOLKIT_SCROLL_BARS
1420 /* Scrollbar shadow colors. */
1421 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1423 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1424 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1426 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1428 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1429 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1431 #endif /* USE_TOOLKIT_SCROLL_BARS */
1433 f->output_data.x->scroll_bar_background_pixel = pixel;
1434 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1436 /* Remove all scroll bars because they have wrong colors. */
1437 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1438 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1439 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1440 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1442 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1443 redraw_frame (f);
1448 /* Encode Lisp string STRING as a text in a format appropriate for
1449 XICCC (X Inter Client Communication Conventions).
1451 This can call Lisp code, so callers must GCPRO.
1453 If STRING contains only ASCII characters, do no conversion and
1454 return the string data of STRING. Otherwise, encode the text by
1455 CODING_SYSTEM, and return a newly allocated memory area which
1456 should be freed by `xfree' by a caller.
1458 SELECTIONP non-zero means the string is being encoded for an X
1459 selection, so it is safe to run pre-write conversions (which
1460 may run Lisp code).
1462 Store the byte length of resulting text in *TEXT_BYTES.
1464 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1465 which means that the `encoding' of the result can be `STRING'.
1466 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1467 the result should be `COMPOUND_TEXT'. */
1469 static unsigned char *
1470 x_encode_text (Lisp_Object string, Lisp_Object coding_system, int selectionp, int *text_bytes, int *stringp, int *freep)
1472 int result = string_xstring_p (string);
1473 struct coding_system coding;
1475 if (result == 0)
1477 /* No multibyte character in OBJ. We need not encode it. */
1478 *text_bytes = SBYTES (string);
1479 *stringp = 1;
1480 *freep = 0;
1481 return SDATA (string);
1484 setup_coding_system (coding_system, &coding);
1485 coding.mode |= (CODING_MODE_SAFE_ENCODING | CODING_MODE_LAST_BLOCK);
1486 /* We suppress producing escape sequences for composition. */
1487 coding.common_flags &= ~CODING_ANNOTATION_MASK;
1488 coding.dst_bytes = SCHARS (string) * 2;
1489 coding.destination = (unsigned char *) xmalloc (coding.dst_bytes);
1490 encode_coding_object (&coding, string, 0, 0,
1491 SCHARS (string), SBYTES (string), Qnil);
1492 *text_bytes = coding.produced;
1493 *stringp = (result == 1 || !EQ (coding_system, Qcompound_text));
1494 *freep = 1;
1495 return coding.destination;
1499 /* Set the WM name to NAME for frame F. Also set the icon name.
1500 If the frame already has an icon name, use that, otherwise set the
1501 icon name to NAME. */
1503 static void
1504 x_set_name_internal (FRAME_PTR f, Lisp_Object name)
1506 if (FRAME_X_WINDOW (f))
1508 BLOCK_INPUT;
1510 XTextProperty text, icon;
1511 int bytes, stringp;
1512 int do_free_icon_value = 0, do_free_text_value = 0;
1513 Lisp_Object coding_system;
1514 Lisp_Object encoded_name;
1515 Lisp_Object encoded_icon_name;
1516 struct gcpro gcpro1;
1518 /* As ENCODE_UTF_8 may cause GC and relocation of string data,
1519 we use it before x_encode_text that may return string data. */
1520 GCPRO1 (name);
1521 encoded_name = ENCODE_UTF_8 (name);
1522 UNGCPRO;
1524 coding_system = Qcompound_text;
1525 /* Note: Encoding strategy
1527 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1528 text.encoding. But, there are non-internationalized window
1529 managers which don't support that encoding. So, if NAME
1530 contains only ASCII and 8859-1 characters, encode it by
1531 iso-latin-1, and use "STRING" in text.encoding hoping that
1532 such window managers at least analyze this format correctly,
1533 i.e. treat 8-bit bytes as 8859-1 characters.
1535 We may also be able to use "UTF8_STRING" in text.encoding
1536 in the future which can encode all Unicode characters.
1537 But, for the moment, there's no way to know that the
1538 current window manager supports it or not.
1540 Either way, we also set the _NET_WM_NAME and _NET_WM_ICON_NAME
1541 properties. Per the EWMH specification, those two properties
1542 are always UTF8_STRING. This matches what gtk_window_set_title()
1543 does in the USE_GTK case. */
1544 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1545 &do_free_text_value);
1546 text.encoding = (stringp ? XA_STRING
1547 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1548 text.format = 8;
1549 text.nitems = bytes;
1551 if (!STRINGP (f->icon_name))
1553 icon = text;
1554 encoded_icon_name = encoded_name;
1556 else
1558 /* See the above comment "Note: Encoding strategy". */
1559 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1560 &bytes, &stringp, &do_free_icon_value);
1561 icon.encoding = (stringp ? XA_STRING
1562 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1563 icon.format = 8;
1564 icon.nitems = bytes;
1566 encoded_icon_name = ENCODE_UTF_8 (f->icon_name);
1569 #ifdef USE_GTK
1570 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1571 SSDATA (encoded_name));
1572 #else /* not USE_GTK */
1573 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1574 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1575 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_name,
1576 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1577 8, PropModeReplace,
1578 SDATA (encoded_name),
1579 SBYTES (encoded_name));
1580 #endif /* not USE_GTK */
1582 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1583 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1584 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_icon_name,
1585 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1586 8, PropModeReplace,
1587 SDATA (encoded_icon_name),
1588 SBYTES (encoded_icon_name));
1590 if (do_free_icon_value)
1591 xfree (icon.value);
1592 if (do_free_text_value)
1593 xfree (text.value);
1595 UNBLOCK_INPUT;
1599 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1600 x_id_name.
1602 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1603 name; if NAME is a string, set F's name to NAME and set
1604 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1606 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1607 suggesting a new name, which lisp code should override; if
1608 F->explicit_name is set, ignore the new name; otherwise, set it. */
1610 static void
1611 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1613 /* Make sure that requests from lisp code override requests from
1614 Emacs redisplay code. */
1615 if (explicit)
1617 /* If we're switching from explicit to implicit, we had better
1618 update the mode lines and thereby update the title. */
1619 if (f->explicit_name && NILP (name))
1620 update_mode_lines = 1;
1622 f->explicit_name = ! NILP (name);
1624 else if (f->explicit_name)
1625 return;
1627 /* If NAME is nil, set the name to the x_id_name. */
1628 if (NILP (name))
1630 /* Check for no change needed in this very common case
1631 before we do any consing. */
1632 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
1633 SSDATA (f->name)))
1634 return;
1635 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
1637 else
1638 CHECK_STRING (name);
1640 /* Don't change the name if it's already NAME. */
1641 if (! NILP (Fstring_equal (name, f->name)))
1642 return;
1644 f->name = name;
1646 /* For setting the frame title, the title parameter should override
1647 the name parameter. */
1648 if (! NILP (f->title))
1649 name = f->title;
1651 x_set_name_internal (f, name);
1654 /* This function should be called when the user's lisp code has
1655 specified a name for the frame; the name will override any set by the
1656 redisplay code. */
1657 static void
1658 x_explicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1660 x_set_name (f, arg, 1);
1663 /* This function should be called by Emacs redisplay code to set the
1664 name; names set this way will never override names set by the user's
1665 lisp code. */
1666 void
1667 x_implicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1669 x_set_name (f, arg, 0);
1672 /* Change the title of frame F to NAME.
1673 If NAME is nil, use the frame name as the title. */
1675 static void
1676 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1678 /* Don't change the title if it's already NAME. */
1679 if (EQ (name, f->title))
1680 return;
1682 update_mode_lines = 1;
1684 f->title = name;
1686 if (NILP (name))
1687 name = f->name;
1688 else
1689 CHECK_STRING (name);
1691 x_set_name_internal (f, name);
1694 void
1695 x_set_scroll_bar_default_width (struct frame *f)
1697 int wid = FRAME_COLUMN_WIDTH (f);
1699 #ifdef USE_TOOLKIT_SCROLL_BARS
1700 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1701 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
1702 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
1703 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = width;
1704 #else
1705 /* Make the actual width at least 14 pixels and a multiple of a
1706 character width. */
1707 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
1709 /* Use all of that space (aside from required margins) for the
1710 scroll bar. */
1711 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = 0;
1712 #endif
1716 /* Record in frame F the specified or default value according to ALIST
1717 of the parameter named PROP (a Lisp symbol). If no value is
1718 specified for PROP, look for an X default for XPROP on the frame
1719 named NAME. If that is not found either, use the value DEFLT. */
1721 static Lisp_Object
1722 x_default_scroll_bar_color_parameter (struct frame *f,
1723 Lisp_Object alist, Lisp_Object prop,
1724 const char *xprop, const char *xclass,
1725 int foreground_p)
1727 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1728 Lisp_Object tem;
1730 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1731 if (EQ (tem, Qunbound))
1733 #ifdef USE_TOOLKIT_SCROLL_BARS
1735 /* See if an X resource for the scroll bar color has been
1736 specified. */
1737 tem = display_x_get_resource (dpyinfo,
1738 build_string (foreground_p
1739 ? "foreground"
1740 : "background"),
1741 empty_unibyte_string,
1742 build_string ("verticalScrollBar"),
1743 empty_unibyte_string);
1744 if (!STRINGP (tem))
1746 /* If nothing has been specified, scroll bars will use a
1747 toolkit-dependent default. Because these defaults are
1748 difficult to get at without actually creating a scroll
1749 bar, use nil to indicate that no color has been
1750 specified. */
1751 tem = Qnil;
1754 #else /* not USE_TOOLKIT_SCROLL_BARS */
1756 tem = Qnil;
1758 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1761 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
1762 return tem;
1768 #ifdef USE_X_TOOLKIT
1770 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1771 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1772 already be present because of the toolkit (Motif adds some of them,
1773 for example, but Xt doesn't). */
1775 static void
1776 hack_wm_protocols (FRAME_PTR f, Widget widget)
1778 Display *dpy = XtDisplay (widget);
1779 Window w = XtWindow (widget);
1780 int need_delete = 1;
1781 int need_focus = 1;
1782 int need_save = 1;
1784 BLOCK_INPUT;
1786 Atom type;
1787 unsigned char *catoms;
1788 int format = 0;
1789 unsigned long nitems = 0;
1790 unsigned long bytes_after;
1792 if ((XGetWindowProperty (dpy, w,
1793 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1794 (long)0, (long)100, False, XA_ATOM,
1795 &type, &format, &nitems, &bytes_after,
1796 &catoms)
1797 == Success)
1798 && format == 32 && type == XA_ATOM)
1800 Atom *atoms = (Atom *) catoms;
1801 while (nitems > 0)
1803 nitems--;
1804 if (atoms[nitems]
1805 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1806 need_delete = 0;
1807 else if (atoms[nitems]
1808 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1809 need_focus = 0;
1810 else if (atoms[nitems]
1811 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1812 need_save = 0;
1815 if (catoms)
1816 XFree (catoms);
1819 Atom props [10];
1820 int count = 0;
1821 if (need_delete)
1822 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1823 if (need_focus)
1824 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1825 if (need_save)
1826 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1827 if (count)
1828 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1829 XA_ATOM, 32, PropModeAppend,
1830 (unsigned char *) props, count);
1832 UNBLOCK_INPUT;
1834 #endif
1838 /* Support routines for XIC (X Input Context). */
1840 #ifdef HAVE_X_I18N
1842 static XFontSet xic_create_xfontset (struct frame *);
1843 static XIMStyle best_xim_style (XIMStyles *, XIMStyles *);
1846 /* Supported XIM styles, ordered by preference. */
1848 static XIMStyle supported_xim_styles[] =
1850 XIMPreeditPosition | XIMStatusArea,
1851 XIMPreeditPosition | XIMStatusNothing,
1852 XIMPreeditPosition | XIMStatusNone,
1853 XIMPreeditNothing | XIMStatusArea,
1854 XIMPreeditNothing | XIMStatusNothing,
1855 XIMPreeditNothing | XIMStatusNone,
1856 XIMPreeditNone | XIMStatusArea,
1857 XIMPreeditNone | XIMStatusNothing,
1858 XIMPreeditNone | XIMStatusNone,
1863 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1864 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1866 static const char xic_defaut_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1868 /* Create an Xt fontset spec from the name of a base font.
1869 If `motif' is True use the Motif syntax. */
1870 char *
1871 xic_create_fontsetname (const char *base_fontname, int motif)
1873 const char *sep = motif ? ";" : ",";
1874 char *fontsetname;
1876 /* Make a fontset name from the base font name. */
1877 if (xic_defaut_fontset == base_fontname)
1878 { /* There is no base font name, use the default. */
1879 int len = strlen (base_fontname) + 2;
1880 fontsetname = xmalloc (len);
1881 memset (fontsetname, 0, len);
1882 strcpy (fontsetname, base_fontname);
1884 else
1886 /* Make a fontset name from the base font name.
1887 The font set will be made of the following elements:
1888 - the base font.
1889 - the base font where the charset spec is replaced by -*-*.
1890 - the same but with the family also replaced with -*-*-. */
1891 const char *p = base_fontname;
1892 int i;
1894 for (i = 0; *p; p++)
1895 if (*p == '-') i++;
1896 if (i != 14)
1897 { /* As the font name doesn't conform to XLFD, we can't
1898 modify it to generalize it to allcs and allfamilies.
1899 Use the specified font plus the default. */
1900 int len = strlen (base_fontname) + strlen (xic_defaut_fontset) + 3;
1901 fontsetname = xmalloc (len);
1902 memset (fontsetname, 0, len);
1903 strcpy (fontsetname, base_fontname);
1904 strcat (fontsetname, sep);
1905 strcat (fontsetname, xic_defaut_fontset);
1907 else
1909 int len;
1910 const char *p1 = NULL, *p2 = NULL, *p3 = NULL;
1911 char *font_allcs = NULL;
1912 char *font_allfamilies = NULL;
1913 char *font_all = NULL;
1914 const char *allcs = "*-*-*-*-*-*-*";
1915 const char *allfamilies = "-*-*-";
1916 const char *all = "*-*-*-*-";
1917 char *base;
1919 for (i = 0, p = base_fontname; i < 8; p++)
1921 if (*p == '-')
1923 i++;
1924 if (i == 3)
1925 p1 = p + 1;
1926 else if (i == 7)
1927 p2 = p + 1;
1928 else if (i == 6)
1929 p3 = p + 1;
1932 /* If base_fontname specifies ADSTYLE, make it a
1933 wildcard. */
1934 if (*p3 != '*')
1936 int diff = (p2 - p3) - 2;
1938 base = alloca (strlen (base_fontname) + 1);
1939 memcpy (base, base_fontname, p3 - base_fontname);
1940 base[p3 - base_fontname] = '*';
1941 base[(p3 - base_fontname) + 1] = '-';
1942 strcpy (base + (p3 - base_fontname) + 2, p2);
1943 p = base + (p - base_fontname) - diff;
1944 p1 = base + (p1 - base_fontname);
1945 p2 = base + (p2 - base_fontname) - diff;
1946 base_fontname = base;
1949 /* Build the font spec that matches all charsets. */
1950 len = p - base_fontname + strlen (allcs) + 1;
1951 font_allcs = (char *) alloca (len);
1952 memset (font_allcs, 0, len);
1953 memcpy (font_allcs, base_fontname, p - base_fontname);
1954 strcat (font_allcs, allcs);
1956 /* Build the font spec that matches all families and
1957 add-styles. */
1958 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
1959 font_allfamilies = (char *) alloca (len);
1960 memset (font_allfamilies, 0, len);
1961 strcpy (font_allfamilies, allfamilies);
1962 memcpy (font_allfamilies + strlen (allfamilies), p1, p - p1);
1963 strcat (font_allfamilies, allcs);
1965 /* Build the font spec that matches all. */
1966 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
1967 font_all = (char *) alloca (len);
1968 memset (font_all, 0, len);
1969 strcpy (font_all, allfamilies);
1970 strcat (font_all, all);
1971 memcpy (font_all + strlen (all) + strlen (allfamilies), p2, p - p2);
1972 strcat (font_all, allcs);
1974 /* Build the actual font set name. */
1975 len = strlen (base_fontname) + strlen (font_allcs)
1976 + strlen (font_allfamilies) + strlen (font_all) + 5;
1977 fontsetname = xmalloc (len);
1978 memset (fontsetname, 0, len);
1979 strcpy (fontsetname, base_fontname);
1980 strcat (fontsetname, sep);
1981 strcat (fontsetname, font_allcs);
1982 strcat (fontsetname, sep);
1983 strcat (fontsetname, font_allfamilies);
1984 strcat (fontsetname, sep);
1985 strcat (fontsetname, font_all);
1988 if (motif)
1989 strcat (fontsetname, ":");
1990 return fontsetname;
1992 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
1994 #ifdef DEBUG_XIC_FONTSET
1995 static void
1996 print_fontset_result (xfs, name, missing_list, missing_count)
1997 XFontSet xfs;
1998 char *name;
1999 char **missing_list;
2000 int missing_count;
2002 if (xfs)
2003 fprintf (stderr, "XIC Fontset created: %s\n", name);
2004 else
2006 fprintf (stderr, "XIC Fontset failed: %s\n", name);
2007 while (missing_count-- > 0)
2009 fprintf (stderr, " missing: %s\n", *missing_list);
2010 missing_list++;
2015 #endif
2017 static XFontSet
2018 xic_create_xfontset (struct frame *f)
2020 XFontSet xfs = NULL;
2021 struct font *font = FRAME_FONT (f);
2022 int pixel_size = font->pixel_size;
2023 Lisp_Object rest, frame;
2025 /* See if there is another frame already using same fontset. */
2026 FOR_EACH_FRAME (rest, frame)
2028 struct frame *cf = XFRAME (frame);
2030 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2031 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2032 && FRAME_FONT (f)
2033 && FRAME_FONT (f)->pixel_size == pixel_size)
2035 xfs = FRAME_XIC_FONTSET (cf);
2036 break;
2040 if (! xfs)
2042 char buf[256];
2043 char **missing_list;
2044 int missing_count;
2045 char *def_string;
2046 const char *xlfd_format = "-*-*-medium-r-normal--%d-*-*-*-*-*";
2048 sprintf (buf, xlfd_format, pixel_size);
2049 missing_list = NULL;
2050 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2051 &missing_list, &missing_count, &def_string);
2052 #ifdef DEBUG_XIC_FONTSET
2053 print_fontset_result (xfs, buf, missing_list, missing_count);
2054 #endif
2055 if (missing_list)
2056 XFreeStringList (missing_list);
2057 if (! xfs)
2059 /* List of pixel sizes most likely available. Find one that
2060 is closest to pixel_size. */
2061 int sizes[] = {0, 8, 10, 11, 12, 14, 17, 18, 20, 24, 26, 34, 0};
2062 int *smaller, *larger;
2064 for (smaller = sizes; smaller[1]; smaller++)
2065 if (smaller[1] >= pixel_size)
2066 break;
2067 larger = smaller + 1;
2068 if (*larger == pixel_size)
2069 larger++;
2070 while (*smaller || *larger)
2072 int this_size;
2074 if (! *larger)
2075 this_size = *smaller--;
2076 else if (! *smaller)
2077 this_size = *larger++;
2078 else if (pixel_size - *smaller < *larger - pixel_size)
2079 this_size = *smaller--;
2080 else
2081 this_size = *larger++;
2082 sprintf (buf, xlfd_format, this_size);
2083 missing_list = NULL;
2084 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2085 &missing_list, &missing_count, &def_string);
2086 #ifdef DEBUG_XIC_FONTSET
2087 print_fontset_result (xfs, buf, missing_list, missing_count);
2088 #endif
2089 if (missing_list)
2090 XFreeStringList (missing_list);
2091 if (xfs)
2092 break;
2095 if (! xfs)
2097 const char *last_resort = "-*-*-*-r-normal--*-*-*-*-*-*";
2099 missing_list = NULL;
2100 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), last_resort,
2101 &missing_list, &missing_count, &def_string);
2102 #ifdef DEBUG_XIC_FONTSET
2103 print_fontset_result (xfs, last_resort, missing_list, missing_count);
2104 #endif
2105 if (missing_list)
2106 XFreeStringList (missing_list);
2111 return xfs;
2114 /* Free the X fontset of frame F if it is the last frame using it. */
2116 void
2117 xic_free_xfontset (struct frame *f)
2119 Lisp_Object rest, frame;
2120 int shared_p = 0;
2122 if (!FRAME_XIC_FONTSET (f))
2123 return;
2125 /* See if there is another frame sharing the same fontset. */
2126 FOR_EACH_FRAME (rest, frame)
2128 struct frame *cf = XFRAME (frame);
2129 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2130 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2131 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2133 shared_p = 1;
2134 break;
2138 if (!shared_p)
2139 /* The fontset is not used anymore. It is safe to free it. */
2140 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2142 if (FRAME_XIC_BASE_FONTNAME (f))
2143 xfree (FRAME_XIC_BASE_FONTNAME (f));
2144 FRAME_XIC_BASE_FONTNAME (f) = NULL;
2145 FRAME_XIC_FONTSET (f) = NULL;
2149 /* Value is the best input style, given user preferences USER (already
2150 checked to be supported by Emacs), and styles supported by the
2151 input method XIM. */
2153 static XIMStyle
2154 best_xim_style (XIMStyles *user, XIMStyles *xim)
2156 int i, j;
2158 for (i = 0; i < user->count_styles; ++i)
2159 for (j = 0; j < xim->count_styles; ++j)
2160 if (user->supported_styles[i] == xim->supported_styles[j])
2161 return user->supported_styles[i];
2163 /* Return the default style. */
2164 return XIMPreeditNothing | XIMStatusNothing;
2167 /* Create XIC for frame F. */
2169 static XIMStyle xic_style;
2171 void
2172 create_frame_xic (struct frame *f)
2174 XIM xim;
2175 XIC xic = NULL;
2176 XFontSet xfs = NULL;
2178 if (FRAME_XIC (f))
2179 return;
2181 /* Create X fontset. */
2182 xfs = xic_create_xfontset (f);
2183 xim = FRAME_X_XIM (f);
2184 if (xim)
2186 XRectangle s_area;
2187 XPoint spot;
2188 XVaNestedList preedit_attr;
2189 XVaNestedList status_attr;
2191 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2192 spot.x = 0; spot.y = 1;
2194 /* Determine XIC style. */
2195 if (xic_style == 0)
2197 XIMStyles supported_list;
2198 supported_list.count_styles = (sizeof supported_xim_styles
2199 / sizeof supported_xim_styles[0]);
2200 supported_list.supported_styles = supported_xim_styles;
2201 xic_style = best_xim_style (&supported_list,
2202 FRAME_X_XIM_STYLES (f));
2205 preedit_attr = XVaCreateNestedList (0,
2206 XNFontSet, xfs,
2207 XNForeground,
2208 FRAME_FOREGROUND_PIXEL (f),
2209 XNBackground,
2210 FRAME_BACKGROUND_PIXEL (f),
2211 (xic_style & XIMPreeditPosition
2212 ? XNSpotLocation
2213 : NULL),
2214 &spot,
2215 NULL);
2216 status_attr = XVaCreateNestedList (0,
2217 XNArea,
2218 &s_area,
2219 XNFontSet,
2220 xfs,
2221 XNForeground,
2222 FRAME_FOREGROUND_PIXEL (f),
2223 XNBackground,
2224 FRAME_BACKGROUND_PIXEL (f),
2225 NULL);
2227 xic = XCreateIC (xim,
2228 XNInputStyle, xic_style,
2229 XNClientWindow, FRAME_X_WINDOW (f),
2230 XNFocusWindow, FRAME_X_WINDOW (f),
2231 XNStatusAttributes, status_attr,
2232 XNPreeditAttributes, preedit_attr,
2233 NULL);
2234 XFree (preedit_attr);
2235 XFree (status_attr);
2238 FRAME_XIC (f) = xic;
2239 FRAME_XIC_STYLE (f) = xic_style;
2240 FRAME_XIC_FONTSET (f) = xfs;
2244 /* Destroy XIC and free XIC fontset of frame F, if any. */
2246 void
2247 free_frame_xic (struct frame *f)
2249 if (FRAME_XIC (f) == NULL)
2250 return;
2252 XDestroyIC (FRAME_XIC (f));
2253 xic_free_xfontset (f);
2255 FRAME_XIC (f) = NULL;
2259 /* Place preedit area for XIC of window W's frame to specified
2260 pixel position X/Y. X and Y are relative to window W. */
2262 void
2263 xic_set_preeditarea (struct window *w, int x, int y)
2265 struct frame *f = XFRAME (w->frame);
2266 XVaNestedList attr;
2267 XPoint spot;
2269 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2270 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2271 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2272 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2273 XFree (attr);
2277 /* Place status area for XIC in bottom right corner of frame F.. */
2279 void
2280 xic_set_statusarea (struct frame *f)
2282 XIC xic = FRAME_XIC (f);
2283 XVaNestedList attr;
2284 XRectangle area;
2285 XRectangle *needed;
2287 /* Negotiate geometry of status area. If input method has existing
2288 status area, use its current size. */
2289 area.x = area.y = area.width = area.height = 0;
2290 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2291 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2292 XFree (attr);
2294 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2295 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2296 XFree (attr);
2298 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2300 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2301 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2302 XFree (attr);
2305 area.width = needed->width;
2306 area.height = needed->height;
2307 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2308 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2309 - FRAME_MENUBAR_HEIGHT (f)
2310 - FRAME_TOOLBAR_TOP_HEIGHT (f)
2311 - FRAME_INTERNAL_BORDER_WIDTH (f));
2312 XFree (needed);
2314 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2315 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2316 XFree (attr);
2320 /* Set X fontset for XIC of frame F, using base font name
2321 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2323 void
2324 xic_set_xfontset (struct frame *f, const char *base_fontname)
2326 XVaNestedList attr;
2327 XFontSet xfs;
2329 xic_free_xfontset (f);
2331 xfs = xic_create_xfontset (f);
2333 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2334 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2335 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2336 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2337 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2338 XFree (attr);
2340 FRAME_XIC_FONTSET (f) = xfs;
2343 #endif /* HAVE_X_I18N */
2347 #ifdef USE_X_TOOLKIT
2349 /* Create and set up the X widget for frame F. */
2351 static void
2352 x_window (struct frame *f, long window_prompting, int minibuffer_only)
2354 XClassHint class_hints;
2355 XSetWindowAttributes attributes;
2356 unsigned long attribute_mask;
2357 Widget shell_widget;
2358 Widget pane_widget;
2359 Widget frame_widget;
2360 Arg al [25];
2361 int ac;
2363 BLOCK_INPUT;
2365 /* Use the resource name as the top-level widget name
2366 for looking up resources. Make a non-Lisp copy
2367 for the window manager, so GC relocation won't bother it.
2369 Elsewhere we specify the window name for the window manager. */
2372 char *str = SSDATA (Vx_resource_name);
2373 f->namebuf = (char *) xmalloc (strlen (str) + 1);
2374 strcpy (f->namebuf, str);
2377 ac = 0;
2378 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2379 XtSetArg (al[ac], XtNinput, 1); ac++;
2380 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2381 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2382 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2383 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2384 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2385 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2386 applicationShellWidgetClass,
2387 FRAME_X_DISPLAY (f), al, ac);
2389 f->output_data.x->widget = shell_widget;
2390 /* maybe_set_screen_title_format (shell_widget); */
2392 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2393 (widget_value *) NULL,
2394 shell_widget, False,
2395 (lw_callback) NULL,
2396 (lw_callback) NULL,
2397 (lw_callback) NULL,
2398 (lw_callback) NULL);
2400 ac = 0;
2401 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2402 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2403 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2404 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2405 XtSetValues (pane_widget, al, ac);
2406 f->output_data.x->column_widget = pane_widget;
2408 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2409 the emacs screen when changing menubar. This reduces flickering. */
2411 ac = 0;
2412 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2413 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2414 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2415 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2416 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2417 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2418 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2419 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2420 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2421 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2422 al, ac);
2424 f->output_data.x->edit_widget = frame_widget;
2426 XtManageChild (frame_widget);
2428 /* Do some needed geometry management. */
2430 int len;
2431 char *tem, shell_position[32];
2432 Arg gal[10];
2433 int gac = 0;
2434 int extra_borders = 0;
2435 int menubar_size
2436 = (f->output_data.x->menubar_widget
2437 ? (f->output_data.x->menubar_widget->core.height
2438 + f->output_data.x->menubar_widget->core.border_width)
2439 : 0);
2441 #if 0 /* Experimentally, we now get the right results
2442 for -geometry -0-0 without this. 24 Aug 96, rms. */
2443 if (FRAME_EXTERNAL_MENU_BAR (f))
2445 Dimension ibw = 0;
2446 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2447 menubar_size += ibw;
2449 #endif
2451 f->output_data.x->menubar_height = menubar_size;
2453 #ifndef USE_LUCID
2454 /* Motif seems to need this amount added to the sizes
2455 specified for the shell widget. The Athena/Lucid widgets don't.
2456 Both conclusions reached experimentally. -- rms. */
2457 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2458 &extra_borders, NULL);
2459 extra_borders *= 2;
2460 #endif
2462 /* Convert our geometry parameters into a geometry string
2463 and specify it.
2464 Note that we do not specify here whether the position
2465 is a user-specified or program-specified one.
2466 We pass that information later, in x_wm_set_size_hints. */
2468 int left = f->left_pos;
2469 int xneg = window_prompting & XNegative;
2470 int top = f->top_pos;
2471 int yneg = window_prompting & YNegative;
2472 if (xneg)
2473 left = -left;
2474 if (yneg)
2475 top = -top;
2477 if (window_prompting & USPosition)
2478 sprintf (shell_position, "=%dx%d%c%d%c%d",
2479 FRAME_PIXEL_WIDTH (f) + extra_borders,
2480 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2481 (xneg ? '-' : '+'), left,
2482 (yneg ? '-' : '+'), top);
2483 else
2485 sprintf (shell_position, "=%dx%d",
2486 FRAME_PIXEL_WIDTH (f) + extra_borders,
2487 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2489 /* Setting x and y when the position is not specified in
2490 the geometry string will set program position in the WM hints.
2491 If Emacs had just one program position, we could set it in
2492 fallback resources, but since each make-frame call can specify
2493 different program positions, this is easier. */
2494 XtSetArg (gal[gac], XtNx, left); gac++;
2495 XtSetArg (gal[gac], XtNy, top); gac++;
2499 len = strlen (shell_position) + 1;
2500 /* We don't free this because we don't know whether
2501 it is safe to free it while the frame exists.
2502 It isn't worth the trouble of arranging to free it
2503 when the frame is deleted. */
2504 tem = (char *) xmalloc (len);
2505 strncpy (tem, shell_position, len);
2506 XtSetArg (gal[gac], XtNgeometry, tem); gac++;
2507 XtSetValues (shell_widget, gal, gac);
2510 XtManageChild (pane_widget);
2511 XtRealizeWidget (shell_widget);
2513 if (FRAME_X_EMBEDDED_P (f))
2514 XReparentWindow (FRAME_X_DISPLAY (f), XtWindow (shell_widget),
2515 f->output_data.x->parent_desc, 0, 0);
2517 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2519 validate_x_resource_name ();
2521 class_hints.res_name = SSDATA (Vx_resource_name);
2522 class_hints.res_class = SSDATA (Vx_resource_class);
2523 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2525 #ifdef HAVE_X_I18N
2526 FRAME_XIC (f) = NULL;
2527 if (use_xim)
2528 create_frame_xic (f);
2529 #endif
2531 f->output_data.x->wm_hints.input = True;
2532 f->output_data.x->wm_hints.flags |= InputHint;
2533 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2534 &f->output_data.x->wm_hints);
2536 hack_wm_protocols (f, shell_widget);
2538 #ifdef HACK_EDITRES
2539 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2540 #endif
2542 /* Do a stupid property change to force the server to generate a
2543 PropertyNotify event so that the event_stream server timestamp will
2544 be initialized to something relevant to the time we created the window.
2546 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2547 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
2548 XA_ATOM, 32, PropModeAppend,
2549 (unsigned char*) NULL, 0);
2551 /* Make all the standard events reach the Emacs frame. */
2552 attributes.event_mask = STANDARD_EVENT_SET;
2554 #ifdef HAVE_X_I18N
2555 if (FRAME_XIC (f))
2557 /* XIM server might require some X events. */
2558 unsigned long fevent = NoEventMask;
2559 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2560 attributes.event_mask |= fevent;
2562 #endif /* HAVE_X_I18N */
2564 attribute_mask = CWEventMask;
2565 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2566 attribute_mask, &attributes);
2568 XtMapWidget (frame_widget);
2570 /* x_set_name normally ignores requests to set the name if the
2571 requested name is the same as the current name. This is the one
2572 place where that assumption isn't correct; f->name is set, but
2573 the X server hasn't been told. */
2575 Lisp_Object name;
2576 int explicit = f->explicit_name;
2578 f->explicit_name = 0;
2579 name = f->name;
2580 f->name = Qnil;
2581 x_set_name (f, name, explicit);
2584 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2585 f->output_data.x->current_cursor
2586 = f->output_data.x->text_cursor);
2588 UNBLOCK_INPUT;
2590 /* This is a no-op, except under Motif. Make sure main areas are
2591 set to something reasonable, in case we get an error later. */
2592 lw_set_main_areas (pane_widget, 0, frame_widget);
2595 #else /* not USE_X_TOOLKIT */
2596 #ifdef USE_GTK
2597 static void
2598 x_window (FRAME_PTR f)
2600 if (! xg_create_frame_widgets (f))
2601 error ("Unable to create window");
2603 #ifdef HAVE_X_I18N
2604 FRAME_XIC (f) = NULL;
2605 if (use_xim)
2607 BLOCK_INPUT;
2608 create_frame_xic (f);
2609 if (FRAME_XIC (f))
2611 /* XIM server might require some X events. */
2612 unsigned long fevent = NoEventMask;
2613 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2615 if (fevent != NoEventMask)
2617 XSetWindowAttributes attributes;
2618 XWindowAttributes wattr;
2619 unsigned long attribute_mask;
2621 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2622 &wattr);
2623 attributes.event_mask = wattr.your_event_mask | fevent;
2624 attribute_mask = CWEventMask;
2625 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2626 attribute_mask, &attributes);
2629 UNBLOCK_INPUT;
2631 #endif
2634 #else /*! USE_GTK */
2635 /* Create and set up the X window for frame F. */
2637 static void
2638 x_window (struct frame *f)
2640 XClassHint class_hints;
2641 XSetWindowAttributes attributes;
2642 unsigned long attribute_mask;
2644 attributes.background_pixel = FRAME_BACKGROUND_PIXEL (f);
2645 attributes.border_pixel = f->output_data.x->border_pixel;
2646 attributes.bit_gravity = StaticGravity;
2647 attributes.backing_store = NotUseful;
2648 attributes.save_under = True;
2649 attributes.event_mask = STANDARD_EVENT_SET;
2650 attributes.colormap = FRAME_X_COLORMAP (f);
2651 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2652 | CWColormap);
2654 BLOCK_INPUT;
2655 FRAME_X_WINDOW (f)
2656 = XCreateWindow (FRAME_X_DISPLAY (f),
2657 f->output_data.x->parent_desc,
2658 f->left_pos,
2659 f->top_pos,
2660 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2661 f->border_width,
2662 CopyFromParent, /* depth */
2663 InputOutput, /* class */
2664 FRAME_X_VISUAL (f),
2665 attribute_mask, &attributes);
2667 #ifdef HAVE_X_I18N
2668 if (use_xim)
2670 create_frame_xic (f);
2671 if (FRAME_XIC (f))
2673 /* XIM server might require some X events. */
2674 unsigned long fevent = NoEventMask;
2675 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2676 attributes.event_mask |= fevent;
2677 attribute_mask = CWEventMask;
2678 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2679 attribute_mask, &attributes);
2682 #endif /* HAVE_X_I18N */
2684 validate_x_resource_name ();
2686 class_hints.res_name = SSDATA (Vx_resource_name);
2687 class_hints.res_class = SSDATA (Vx_resource_class);
2688 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2690 /* The menubar is part of the ordinary display;
2691 it does not count in addition to the height of the window. */
2692 f->output_data.x->menubar_height = 0;
2694 /* This indicates that we use the "Passive Input" input model.
2695 Unless we do this, we don't get the Focus{In,Out} events that we
2696 need to draw the cursor correctly. Accursed bureaucrats.
2697 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2699 f->output_data.x->wm_hints.input = True;
2700 f->output_data.x->wm_hints.flags |= InputHint;
2701 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2702 &f->output_data.x->wm_hints);
2703 f->output_data.x->wm_hints.icon_pixmap = None;
2705 /* Request "save yourself" and "delete window" commands from wm. */
2707 Atom protocols[2];
2708 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2709 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2710 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2713 /* x_set_name normally ignores requests to set the name if the
2714 requested name is the same as the current name. This is the one
2715 place where that assumption isn't correct; f->name is set, but
2716 the X server hasn't been told. */
2718 Lisp_Object name;
2719 int explicit = f->explicit_name;
2721 f->explicit_name = 0;
2722 name = f->name;
2723 f->name = Qnil;
2724 x_set_name (f, name, explicit);
2727 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2728 f->output_data.x->current_cursor
2729 = f->output_data.x->text_cursor);
2731 UNBLOCK_INPUT;
2733 if (FRAME_X_WINDOW (f) == 0)
2734 error ("Unable to create window");
2737 #endif /* not USE_GTK */
2738 #endif /* not USE_X_TOOLKIT */
2740 /* Verify that the icon position args for this window are valid. */
2742 static void
2743 x_icon_verify (struct frame *f, Lisp_Object parms)
2745 Lisp_Object icon_x, icon_y;
2747 /* Set the position of the icon. Note that twm groups all
2748 icons in an icon window. */
2749 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2750 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2751 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2753 CHECK_NUMBER (icon_x);
2754 CHECK_NUMBER (icon_y);
2756 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2757 error ("Both left and top icon corners of icon must be specified");
2760 /* Handle the icon stuff for this window. Perhaps later we might
2761 want an x_set_icon_position which can be called interactively as
2762 well. */
2764 static void
2765 x_icon (struct frame *f, Lisp_Object parms)
2767 Lisp_Object icon_x, icon_y;
2768 #if 0
2769 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2770 #endif
2772 /* Set the position of the icon. Note that twm groups all
2773 icons in an icon window. */
2774 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2775 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2776 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2778 CHECK_NUMBER (icon_x);
2779 CHECK_NUMBER (icon_y);
2781 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2782 error ("Both left and top icon corners of icon must be specified");
2784 BLOCK_INPUT;
2786 if (! EQ (icon_x, Qunbound))
2787 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2789 #if 0 /* x_get_arg removes the visibility parameter as a side effect,
2790 but x_create_frame still needs it. */
2791 /* Start up iconic or window? */
2792 x_wm_set_window_state
2793 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2794 Qicon)
2795 ? IconicState
2796 : NormalState));
2797 #endif
2799 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
2800 ? f->icon_name
2801 : f->name)));
2803 UNBLOCK_INPUT;
2806 /* Make the GCs needed for this window, setting the
2807 background, border and mouse colors; also create the
2808 mouse cursor and the gray border tile. */
2810 static void
2811 x_make_gc (struct frame *f)
2813 XGCValues gc_values;
2815 BLOCK_INPUT;
2817 /* Create the GCs of this frame.
2818 Note that many default values are used. */
2820 gc_values.foreground = FRAME_FOREGROUND_PIXEL (f);
2821 gc_values.background = FRAME_BACKGROUND_PIXEL (f);
2822 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2823 f->output_data.x->normal_gc
2824 = XCreateGC (FRAME_X_DISPLAY (f),
2825 FRAME_X_WINDOW (f),
2826 GCLineWidth | GCForeground | GCBackground,
2827 &gc_values);
2829 /* Reverse video style. */
2830 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2831 gc_values.background = FRAME_FOREGROUND_PIXEL (f);
2832 f->output_data.x->reverse_gc
2833 = XCreateGC (FRAME_X_DISPLAY (f),
2834 FRAME_X_WINDOW (f),
2835 GCForeground | GCBackground | GCLineWidth,
2836 &gc_values);
2838 /* Cursor has cursor-color background, background-color foreground. */
2839 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2840 gc_values.background = f->output_data.x->cursor_pixel;
2841 gc_values.fill_style = FillOpaqueStippled;
2842 f->output_data.x->cursor_gc
2843 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2844 (GCForeground | GCBackground
2845 | GCFillStyle | GCLineWidth),
2846 &gc_values);
2848 /* Reliefs. */
2849 f->output_data.x->white_relief.gc = 0;
2850 f->output_data.x->black_relief.gc = 0;
2852 /* Create the gray border tile used when the pointer is not in
2853 the frame. Since this depends on the frame's pixel values,
2854 this must be done on a per-frame basis. */
2855 f->output_data.x->border_tile
2856 = (XCreatePixmapFromBitmapData
2857 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
2858 gray_bits, gray_width, gray_height,
2859 FRAME_FOREGROUND_PIXEL (f),
2860 FRAME_BACKGROUND_PIXEL (f),
2861 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2863 UNBLOCK_INPUT;
2867 /* Free what was allocated in x_make_gc. */
2869 void
2870 x_free_gcs (struct frame *f)
2872 Display *dpy = FRAME_X_DISPLAY (f);
2874 BLOCK_INPUT;
2876 if (f->output_data.x->normal_gc)
2878 XFreeGC (dpy, f->output_data.x->normal_gc);
2879 f->output_data.x->normal_gc = 0;
2882 if (f->output_data.x->reverse_gc)
2884 XFreeGC (dpy, f->output_data.x->reverse_gc);
2885 f->output_data.x->reverse_gc = 0;
2888 if (f->output_data.x->cursor_gc)
2890 XFreeGC (dpy, f->output_data.x->cursor_gc);
2891 f->output_data.x->cursor_gc = 0;
2894 if (f->output_data.x->border_tile)
2896 XFreePixmap (dpy, f->output_data.x->border_tile);
2897 f->output_data.x->border_tile = 0;
2900 UNBLOCK_INPUT;
2904 /* Handler for signals raised during x_create_frame and
2905 x_create_top_frame. FRAME is the frame which is partially
2906 constructed. */
2908 static Lisp_Object
2909 unwind_create_frame (Lisp_Object frame)
2911 struct frame *f = XFRAME (frame);
2913 /* If frame is already dead, nothing to do. This can happen if the
2914 display is disconnected after the frame has become official, but
2915 before x_create_frame removes the unwind protect. */
2916 if (!FRAME_LIVE_P (f))
2917 return Qnil;
2919 /* If frame is ``official'', nothing to do. */
2920 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
2922 #if GLYPH_DEBUG
2923 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2924 #endif
2926 x_free_frame_resources (f);
2928 #if GLYPH_DEBUG
2929 /* Check that reference counts are indeed correct. */
2930 xassert (dpyinfo->reference_count == dpyinfo_refcount);
2931 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
2932 #endif
2933 return Qt;
2936 return Qnil;
2940 static void
2941 x_default_font_parameter (struct frame *f, Lisp_Object parms)
2943 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2944 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
2945 RES_TYPE_STRING);
2946 Lisp_Object font = Qnil;
2947 if (EQ (font_param, Qunbound))
2948 font_param = Qnil;
2950 if (NILP (font_param))
2952 /* System font should take precedendce over X resources. We suggest this
2953 regardless of font-use-system-font because .emacs may not have been
2954 read yet. */
2955 const char *system_font = xsettings_get_system_font ();
2956 if (system_font)
2958 char *name = xstrdup (system_font);
2959 font = font_open_by_name (f, name);
2960 xfree (name);
2964 if (NILP (font))
2965 font = !NILP (font_param) ? font_param
2966 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
2968 if (! FONTP (font) && ! STRINGP (font))
2970 const char *names[]
2972 #ifdef HAVE_XFT
2973 /* This will find the normal Xft font. */
2974 "monospace-10",
2975 #endif
2976 "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1",
2977 "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2978 "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2979 /* This was formerly the first thing tried, but it finds
2980 too many fonts and takes too long. */
2981 "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1",
2982 /* If those didn't work, look for something which will
2983 at least work. */
2984 "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1",
2985 "fixed",
2986 NULL };
2987 int i;
2989 for (i = 0; names[i]; i++)
2991 font = font_open_by_name (f, names[i]);
2992 if (! NILP (font))
2993 break;
2995 if (NILP (font))
2996 error ("No suitable font was found");
2998 else if (!NILP (font_param))
3000 /* Remember the explicit font parameter, so we can re-apply it after
3001 we've applied the `default' face settings. */
3002 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
3005 /* This call will make X resources override any system font setting. */
3006 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
3010 DEFUN ("x-wm-set-size-hint", Fx_wm_set_size_hint, Sx_wm_set_size_hint,
3011 0, 1, 0,
3012 doc: /* Send the size hints for frame FRAME to the window manager.
3013 If FRAME is nil, use the selected frame. */)
3014 (Lisp_Object frame)
3016 struct frame *f;
3017 if (NILP (frame))
3018 frame = selected_frame;
3019 f = XFRAME (frame);
3020 BLOCK_INPUT;
3021 if (FRAME_X_P (f))
3022 x_wm_set_size_hint (f, 0, 0);
3023 UNBLOCK_INPUT;
3024 return Qnil;
3027 static void
3028 set_machine_and_pid_properties (struct frame *f)
3030 long pid = (long) getpid ();
3032 /* This will set WM_CLIENT_MACHINE and WM_LOCALE_NAME. */
3033 XSetWMProperties (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), NULL, NULL,
3034 NULL, 0, NULL, NULL, NULL);
3035 XChangeProperty (FRAME_X_DISPLAY (f),
3036 FRAME_OUTER_WINDOW (f),
3037 XInternAtom (FRAME_X_DISPLAY (f),
3038 "_NET_WM_PID",
3039 False),
3040 XA_CARDINAL, 32, PropModeReplace,
3041 (unsigned char *) &pid, 1);
3044 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
3045 1, 1, 0,
3046 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
3047 Return an Emacs frame object.
3048 PARMS is an alist of frame parameters.
3049 If the parameters specify that the frame should not have a minibuffer,
3050 and do not specify a specific minibuffer window to use,
3051 then `default-minibuffer-frame' must be a frame whose minibuffer can
3052 be shared by the new frame.
3054 This function is an internal primitive--use `make-frame' instead. */)
3055 (Lisp_Object parms)
3057 struct frame *f;
3058 Lisp_Object frame, tem;
3059 Lisp_Object name;
3060 int minibuffer_only = 0;
3061 long window_prompting = 0;
3062 int width, height;
3063 int count = SPECPDL_INDEX ();
3064 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3065 Lisp_Object display;
3066 struct x_display_info *dpyinfo = NULL;
3067 Lisp_Object parent;
3068 struct kboard *kb;
3070 parms = Fcopy_alist (parms);
3072 /* Use this general default value to start with
3073 until we know if this frame has a specified name. */
3074 Vx_resource_name = Vinvocation_name;
3076 display = x_get_arg (dpyinfo, parms, Qterminal, 0, 0, RES_TYPE_NUMBER);
3077 if (EQ (display, Qunbound))
3078 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3079 if (EQ (display, Qunbound))
3080 display = Qnil;
3081 dpyinfo = check_x_display_info (display);
3082 kb = dpyinfo->terminal->kboard;
3084 if (!dpyinfo->terminal->name)
3085 error ("Terminal is not live, can't create new frames on it");
3087 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3088 if (!STRINGP (name)
3089 && ! EQ (name, Qunbound)
3090 && ! NILP (name))
3091 error ("Invalid frame name--not a string or nil");
3093 if (STRINGP (name))
3094 Vx_resource_name = name;
3096 /* See if parent window is specified. */
3097 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3098 if (EQ (parent, Qunbound))
3099 parent = Qnil;
3100 if (! NILP (parent))
3101 CHECK_NUMBER (parent);
3103 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3104 /* No need to protect DISPLAY because that's not used after passing
3105 it to make_frame_without_minibuffer. */
3106 frame = Qnil;
3107 GCPRO4 (parms, parent, name, frame);
3108 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3109 RES_TYPE_SYMBOL);
3110 if (EQ (tem, Qnone) || NILP (tem))
3111 f = make_frame_without_minibuffer (Qnil, kb, display);
3112 else if (EQ (tem, Qonly))
3114 f = make_minibuffer_frame ();
3115 minibuffer_only = 1;
3117 else if (WINDOWP (tem))
3118 f = make_frame_without_minibuffer (tem, kb, display);
3119 else
3120 f = make_frame (1);
3122 XSETFRAME (frame, f);
3124 /* Note that X Windows does support scroll bars. */
3125 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
3127 f->terminal = dpyinfo->terminal;
3128 f->terminal->reference_count++;
3130 f->output_method = output_x_window;
3131 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
3132 memset (f->output_data.x, 0, sizeof (struct x_output));
3133 f->output_data.x->icon_bitmap = -1;
3134 FRAME_FONTSET (f) = -1;
3135 f->output_data.x->scroll_bar_foreground_pixel = -1;
3136 f->output_data.x->scroll_bar_background_pixel = -1;
3137 #ifdef USE_TOOLKIT_SCROLL_BARS
3138 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3139 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3140 #endif /* USE_TOOLKIT_SCROLL_BARS */
3142 f->icon_name
3143 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3144 RES_TYPE_STRING);
3145 if (! STRINGP (f->icon_name))
3146 f->icon_name = Qnil;
3148 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3150 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
3151 record_unwind_protect (unwind_create_frame, frame);
3152 #if GLYPH_DEBUG
3153 image_cache_refcount = FRAME_IMAGE_CACHE (f)->refcount;
3154 dpyinfo_refcount = dpyinfo->reference_count;
3155 #endif /* GLYPH_DEBUG */
3157 /* These colors will be set anyway later, but it's important
3158 to get the color reference counts right, so initialize them! */
3160 Lisp_Object black;
3161 struct gcpro inner_gcpro1;
3163 /* Function x_decode_color can signal an error. Make
3164 sure to initialize color slots so that we won't try
3165 to free colors we haven't allocated. */
3166 FRAME_FOREGROUND_PIXEL (f) = -1;
3167 FRAME_BACKGROUND_PIXEL (f) = -1;
3168 f->output_data.x->cursor_pixel = -1;
3169 f->output_data.x->cursor_foreground_pixel = -1;
3170 f->output_data.x->border_pixel = -1;
3171 f->output_data.x->mouse_pixel = -1;
3173 black = build_string ("black");
3174 GCPRO1_VAR (black, inner_gcpro);
3175 FRAME_FOREGROUND_PIXEL (f)
3176 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3177 FRAME_BACKGROUND_PIXEL (f)
3178 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3179 f->output_data.x->cursor_pixel
3180 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3181 f->output_data.x->cursor_foreground_pixel
3182 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3183 f->output_data.x->border_pixel
3184 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3185 f->output_data.x->mouse_pixel
3186 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3187 UNGCPRO_VAR (inner_gcpro);
3190 /* Specify the parent under which to make this X window. */
3192 if (!NILP (parent))
3194 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3195 f->output_data.x->explicit_parent = 1;
3197 else
3199 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3200 f->output_data.x->explicit_parent = 0;
3203 /* Set the name; the functions to which we pass f expect the name to
3204 be set. */
3205 if (EQ (name, Qunbound) || NILP (name))
3207 f->name = build_string (dpyinfo->x_id_name);
3208 f->explicit_name = 0;
3210 else
3212 f->name = name;
3213 f->explicit_name = 1;
3214 /* use the frame's title when getting resources for this frame. */
3215 specbind (Qx_resource_name, name);
3218 f->resx = dpyinfo->resx;
3219 f->resy = dpyinfo->resy;
3221 #ifdef HAVE_FREETYPE
3222 #ifdef HAVE_XFT
3223 register_font_driver (&xftfont_driver, f);
3224 #else /* not HAVE_XFT */
3225 register_font_driver (&ftxfont_driver, f);
3226 #endif /* not HAVE_XFT */
3227 #endif /* HAVE_FREETYPE */
3228 register_font_driver (&xfont_driver, f);
3230 x_default_parameter (f, parms, Qfont_backend, Qnil,
3231 "fontBackend", "FontBackend", RES_TYPE_STRING);
3233 /* Extract the window parameters from the supplied values
3234 that are needed to determine window geometry. */
3235 x_default_font_parameter (f, parms);
3236 if (!FRAME_FONT (f))
3238 delete_frame (frame, Qnoelisp);
3239 error ("Invalid frame font");
3242 /* Frame contents get displaced if an embedded X window has a border. */
3243 if (! FRAME_X_EMBEDDED_P (f))
3244 x_default_parameter (f, parms, Qborder_width, make_number (0),
3245 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3247 /* This defaults to 1 in order to match xterm. We recognize either
3248 internalBorderWidth or internalBorder (which is what xterm calls
3249 it). */
3250 if (NILP (Fassq (Qinternal_border_width, parms)))
3252 Lisp_Object value;
3254 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3255 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3256 if (! EQ (value, Qunbound))
3257 parms = Fcons (Fcons (Qinternal_border_width, value),
3258 parms);
3260 x_default_parameter (f, parms, Qinternal_border_width,
3261 #ifdef USE_GTK /* We used to impose 0 in xg_create_frame_widgets. */
3262 make_number (0),
3263 #else
3264 make_number (1),
3265 #endif
3266 "internalBorderWidth", "internalBorderWidth",
3267 RES_TYPE_NUMBER);
3268 x_default_parameter (f, parms, Qvertical_scroll_bars,
3269 #if defined(USE_GTK) && defined(USE_TOOLKIT_SCROLL_BARS)
3270 Qright,
3271 #else
3272 Qleft,
3273 #endif
3274 "verticalScrollBars", "ScrollBars",
3275 RES_TYPE_SYMBOL);
3277 /* Also do the stuff which must be set before the window exists. */
3278 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3279 "foreground", "Foreground", RES_TYPE_STRING);
3280 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3281 "background", "Background", RES_TYPE_STRING);
3282 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3283 "pointerColor", "Foreground", RES_TYPE_STRING);
3284 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3285 "borderColor", "BorderColor", RES_TYPE_STRING);
3286 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3287 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3288 x_default_parameter (f, parms, Qline_spacing, Qnil,
3289 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3290 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3291 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3292 x_default_parameter (f, parms, Qright_fringe, Qnil,
3293 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3295 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3296 "scrollBarForeground",
3297 "ScrollBarForeground", 1);
3298 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3299 "scrollBarBackground",
3300 "ScrollBarBackground", 0);
3302 /* Init faces before x_default_parameter is called for scroll-bar
3303 parameters because that function calls x_set_scroll_bar_width,
3304 which calls change_frame_size, which calls Fset_window_buffer,
3305 which runs hooks, which call Fvertical_motion. At the end, we
3306 end up in init_iterator with a null face cache, which should not
3307 happen. */
3308 init_frame_faces (f);
3310 /* The X resources controlling the menu-bar and tool-bar are
3311 processed specially at startup, and reflected in the mode
3312 variables; ignore them here. */
3313 x_default_parameter (f, parms, Qmenu_bar_lines,
3314 NILP (Vmenu_bar_mode)
3315 ? make_number (0) : make_number (1),
3316 NULL, NULL, RES_TYPE_NUMBER);
3317 x_default_parameter (f, parms, Qtool_bar_lines,
3318 NILP (Vtool_bar_mode)
3319 ? make_number (0) : make_number (1),
3320 NULL, NULL, RES_TYPE_NUMBER);
3322 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3323 "bufferPredicate", "BufferPredicate",
3324 RES_TYPE_SYMBOL);
3325 x_default_parameter (f, parms, Qtitle, Qnil,
3326 "title", "Title", RES_TYPE_STRING);
3327 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3328 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3329 x_default_parameter (f, parms, Qfullscreen, Qnil,
3330 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3331 x_default_parameter (f, parms, Qtool_bar_position,
3332 f->tool_bar_position, 0, 0, RES_TYPE_SYMBOL);
3334 /* Compute the size of the X window. */
3335 window_prompting = x_figure_window_size (f, parms, 1);
3337 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3338 f->no_split = minibuffer_only || EQ (tem, Qt);
3340 x_icon_verify (f, parms);
3342 /* Create the X widget or window. */
3343 #ifdef USE_X_TOOLKIT
3344 x_window (f, window_prompting, minibuffer_only);
3345 #else
3346 x_window (f);
3347 #endif
3349 x_icon (f, parms);
3350 x_make_gc (f);
3352 /* Now consider the frame official. */
3353 FRAME_X_DISPLAY_INFO (f)->reference_count++;
3354 Vframe_list = Fcons (frame, Vframe_list);
3356 /* We need to do this after creating the X window, so that the
3357 icon-creation functions can say whose icon they're describing. */
3358 x_default_parameter (f, parms, Qicon_type, Qt,
3359 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
3361 x_default_parameter (f, parms, Qauto_raise, Qnil,
3362 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3363 x_default_parameter (f, parms, Qauto_lower, Qnil,
3364 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3365 x_default_parameter (f, parms, Qcursor_type, Qbox,
3366 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3367 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3368 "scrollBarWidth", "ScrollBarWidth",
3369 RES_TYPE_NUMBER);
3370 x_default_parameter (f, parms, Qalpha, Qnil,
3371 "alpha", "Alpha", RES_TYPE_NUMBER);
3373 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3374 Change will not be effected unless different from the current
3375 FRAME_LINES (f). */
3376 width = FRAME_COLS (f);
3377 height = FRAME_LINES (f);
3379 SET_FRAME_COLS (f, 0);
3380 FRAME_LINES (f) = 0;
3381 change_frame_size (f, height, width, 1, 0, 0);
3383 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3384 /* Create the menu bar. */
3385 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3387 /* If this signals an error, we haven't set size hints for the
3388 frame and we didn't make it visible. */
3389 initialize_frame_menubar (f);
3391 #ifndef USE_GTK
3392 /* This is a no-op, except under Motif where it arranges the
3393 main window for the widgets on it. */
3394 lw_set_main_areas (f->output_data.x->column_widget,
3395 f->output_data.x->menubar_widget,
3396 f->output_data.x->edit_widget);
3397 #endif /* not USE_GTK */
3399 #endif /* USE_X_TOOLKIT || USE_GTK */
3401 /* Tell the server what size and position, etc, we want, and how
3402 badly we want them. This should be done after we have the menu
3403 bar so that its size can be taken into account. */
3404 BLOCK_INPUT;
3405 x_wm_set_size_hint (f, window_prompting, 0);
3406 UNBLOCK_INPUT;
3408 /* Make the window appear on the frame and enable display, unless
3409 the caller says not to. However, with explicit parent, Emacs
3410 cannot control visibility, so don't try. */
3411 if (! f->output_data.x->explicit_parent)
3413 Lisp_Object visibility;
3415 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3416 RES_TYPE_SYMBOL);
3417 if (EQ (visibility, Qunbound))
3418 visibility = Qt;
3420 if (EQ (visibility, Qicon))
3421 x_iconify_frame (f);
3422 else if (! NILP (visibility))
3423 x_make_frame_visible (f);
3424 else
3426 /* Must have been Qnil. */
3430 BLOCK_INPUT;
3432 /* Set machine name and pid for the purpose of window managers. */
3433 set_machine_and_pid_properties(f);
3435 /* Set the WM leader property. GTK does this itself, so this is not
3436 needed when using GTK. */
3437 if (dpyinfo->client_leader_window != 0)
3439 XChangeProperty (FRAME_X_DISPLAY (f),
3440 FRAME_OUTER_WINDOW (f),
3441 dpyinfo->Xatom_wm_client_leader,
3442 XA_WINDOW, 32, PropModeReplace,
3443 (unsigned char *) &dpyinfo->client_leader_window, 1);
3446 UNBLOCK_INPUT;
3448 /* Initialize `default-minibuffer-frame' in case this is the first
3449 frame on this terminal. */
3450 if (FRAME_HAS_MINIBUF_P (f)
3451 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
3452 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
3453 KVAR (kb, Vdefault_minibuffer_frame) = frame;
3455 /* All remaining specified parameters, which have not been "used"
3456 by x_get_arg and friends, now go in the misc. alist of the frame. */
3457 for (tem = parms; CONSP (tem); tem = XCDR (tem))
3458 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3459 f->param_alist = Fcons (XCAR (tem), f->param_alist);
3461 UNGCPRO;
3463 /* Make sure windows on this frame appear in calls to next-window
3464 and similar functions. */
3465 Vwindow_list = Qnil;
3467 return unbind_to (count, frame);
3471 /* FRAME is used only to get a handle on the X display. We don't pass the
3472 display info directly because we're called from frame.c, which doesn't
3473 know about that structure. */
3475 Lisp_Object
3476 x_get_focus_frame (struct frame *frame)
3478 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
3479 Lisp_Object xfocus;
3480 if (! dpyinfo->x_focus_frame)
3481 return Qnil;
3483 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3484 return xfocus;
3488 /* In certain situations, when the window manager follows a
3489 click-to-focus policy, there seems to be no way around calling
3490 XSetInputFocus to give another frame the input focus .
3492 In an ideal world, XSetInputFocus should generally be avoided so
3493 that applications don't interfere with the window manager's focus
3494 policy. But I think it's okay to use when it's clearly done
3495 following a user-command. */
3497 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
3498 doc: /* Set the input focus to FRAME.
3499 FRAME nil means use the selected frame. */)
3500 (Lisp_Object frame)
3502 struct frame *f = check_x_frame (frame);
3503 Display *dpy = FRAME_X_DISPLAY (f);
3505 BLOCK_INPUT;
3506 x_catch_errors (dpy);
3507 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3508 RevertToParent, CurrentTime);
3509 x_ewmh_activate_frame (f);
3510 x_uncatch_errors ();
3511 UNBLOCK_INPUT;
3513 return Qnil;
3517 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3518 doc: /* Internal function called by `color-defined-p', which see
3519 .\(Note that the Nextstep version of this function ignores FRAME.) */)
3520 (Lisp_Object color, Lisp_Object frame)
3522 XColor foo;
3523 FRAME_PTR f = check_x_frame (frame);
3525 CHECK_STRING (color);
3527 if (x_defined_color (f, SSDATA (color), &foo, 0))
3528 return Qt;
3529 else
3530 return Qnil;
3533 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3534 doc: /* Internal function called by `color-values', which see. */)
3535 (Lisp_Object color, Lisp_Object frame)
3537 XColor foo;
3538 FRAME_PTR f = check_x_frame (frame);
3540 CHECK_STRING (color);
3542 if (x_defined_color (f, SSDATA (color), &foo, 0))
3543 return list3 (make_number (foo.red),
3544 make_number (foo.green),
3545 make_number (foo.blue));
3546 else
3547 return Qnil;
3550 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3551 doc: /* Internal function called by `display-color-p', which see. */)
3552 (Lisp_Object terminal)
3554 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3556 if (dpyinfo->n_planes <= 2)
3557 return Qnil;
3559 switch (dpyinfo->visual->class)
3561 case StaticColor:
3562 case PseudoColor:
3563 case TrueColor:
3564 case DirectColor:
3565 return Qt;
3567 default:
3568 return Qnil;
3572 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3573 0, 1, 0,
3574 doc: /* Return t if the X display supports shades of gray.
3575 Note that color displays do support shades of gray.
3576 The optional argument TERMINAL specifies which display to ask about.
3577 TERMINAL should be a terminal object, a frame or a display name (a string).
3578 If omitted or nil, that stands for the selected frame's display. */)
3579 (Lisp_Object terminal)
3581 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3583 if (dpyinfo->n_planes <= 1)
3584 return Qnil;
3586 switch (dpyinfo->visual->class)
3588 case StaticColor:
3589 case PseudoColor:
3590 case TrueColor:
3591 case DirectColor:
3592 case StaticGray:
3593 case GrayScale:
3594 return Qt;
3596 default:
3597 return Qnil;
3601 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3602 0, 1, 0,
3603 doc: /* Return the width in pixels of the X display TERMINAL.
3604 The optional argument TERMINAL specifies which display to ask about.
3605 TERMINAL should be a terminal object, a frame or a display name (a string).
3606 If omitted or nil, that stands for the selected frame's display. */)
3607 (Lisp_Object terminal)
3609 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3611 return make_number (x_display_pixel_width (dpyinfo));
3614 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3615 Sx_display_pixel_height, 0, 1, 0,
3616 doc: /* Return the height in pixels of the X display TERMINAL.
3617 The optional argument TERMINAL specifies which display to ask about.
3618 TERMINAL should be a terminal object, a frame or a display name (a string).
3619 If omitted or nil, that stands for the selected frame's display. */)
3620 (Lisp_Object terminal)
3622 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3624 return make_number (x_display_pixel_height (dpyinfo));
3627 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3628 0, 1, 0,
3629 doc: /* Return the number of bitplanes of the X display TERMINAL.
3630 The optional argument TERMINAL specifies which display to ask about.
3631 TERMINAL should be a terminal object, a frame or a display name (a string).
3632 If omitted or nil, that stands for the selected frame's display. */)
3633 (Lisp_Object terminal)
3635 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3637 return make_number (dpyinfo->n_planes);
3640 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3641 0, 1, 0,
3642 doc: /* Return the number of color cells of the X display TERMINAL.
3643 The optional argument TERMINAL specifies which display to ask about.
3644 TERMINAL should be a terminal object, a frame or a display name (a string).
3645 If omitted or nil, that stands for the selected frame's display. */)
3646 (Lisp_Object terminal)
3648 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3650 int nr_planes = DisplayPlanes (dpyinfo->display,
3651 XScreenNumberOfScreen (dpyinfo->screen));
3653 /* Truncate nr_planes to 24 to avoid integer overflow.
3654 Some displays says 32, but only 24 bits are actually significant.
3655 There are only very few and rare video cards that have more than
3656 24 significant bits. Also 24 bits is more than 16 million colors,
3657 it "should be enough for everyone". */
3658 if (nr_planes > 24) nr_planes = 24;
3660 return make_number (1 << nr_planes);
3663 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3664 Sx_server_max_request_size,
3665 0, 1, 0,
3666 doc: /* Return the maximum request size of the X server of display TERMINAL.
3667 The optional argument TERMINAL specifies which display to ask about.
3668 TERMINAL should be a terminal object, a frame or a display name (a string).
3669 If omitted or nil, that stands for the selected frame's display. */)
3670 (Lisp_Object terminal)
3672 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3674 return make_number (MAXREQUEST (dpyinfo->display));
3677 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3678 doc: /* Return the "vendor ID" string of the X server of display TERMINAL.
3679 \(Labelling every distributor as a "vendor" embodies the false assumption
3680 that operating systems cannot be developed and distributed noncommercially.)
3681 The optional argument TERMINAL specifies which display to ask about.
3682 TERMINAL should be a terminal object, a frame or a display name (a string).
3683 If omitted or nil, that stands for the selected frame's display. */)
3684 (Lisp_Object terminal)
3686 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3687 const char *vendor = ServerVendor (dpyinfo->display);
3689 if (! vendor) vendor = "";
3690 return build_string (vendor);
3693 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3694 doc: /* Return the version numbers of the X server of display TERMINAL.
3695 The value is a list of three integers: the major and minor
3696 version numbers of the X Protocol in use, and the distributor-specific release
3697 number. See also the function `x-server-vendor'.
3699 The optional argument TERMINAL specifies which display to ask about.
3700 TERMINAL should be a terminal object, a frame or a display name (a string).
3701 If omitted or nil, that stands for the selected frame's display. */)
3702 (Lisp_Object terminal)
3704 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3705 Display *dpy = dpyinfo->display;
3707 return Fcons (make_number (ProtocolVersion (dpy)),
3708 Fcons (make_number (ProtocolRevision (dpy)),
3709 Fcons (make_number (VendorRelease (dpy)), Qnil)));
3712 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3713 doc: /* Return the number of screens on the X server of display TERMINAL.
3714 The optional argument TERMINAL specifies which display to ask about.
3715 TERMINAL should be a terminal object, a frame or a display name (a string).
3716 If omitted or nil, that stands for the selected frame's display. */)
3717 (Lisp_Object terminal)
3719 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3721 return make_number (ScreenCount (dpyinfo->display));
3724 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3725 doc: /* Return the height in millimeters of the X display TERMINAL.
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);
3733 return make_number (HeightMMOfScreen (dpyinfo->screen));
3736 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3737 doc: /* Return the width in millimeters of the X display TERMINAL.
3738 The optional argument TERMINAL specifies which display to ask about.
3739 TERMINAL should be a terminal object, a frame or a display name (a string).
3740 If omitted or nil, that stands for the selected frame's display. */)
3741 (Lisp_Object terminal)
3743 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3745 return make_number (WidthMMOfScreen (dpyinfo->screen));
3748 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3749 Sx_display_backing_store, 0, 1, 0,
3750 doc: /* Return an indication of whether X display TERMINAL does backing store.
3751 The value may be `always', `when-mapped', or `not-useful'.
3752 The optional argument TERMINAL specifies which display to ask about.
3753 TERMINAL should be a terminal object, a frame or a display name (a string).
3754 If omitted or nil, that stands for the selected frame's display. */)
3755 (Lisp_Object terminal)
3757 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3758 Lisp_Object result;
3760 switch (DoesBackingStore (dpyinfo->screen))
3762 case Always:
3763 result = intern ("always");
3764 break;
3766 case WhenMapped:
3767 result = intern ("when-mapped");
3768 break;
3770 case NotUseful:
3771 result = intern ("not-useful");
3772 break;
3774 default:
3775 error ("Strange value for BackingStore parameter of screen");
3776 result = Qnil;
3779 return result;
3782 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3783 Sx_display_visual_class, 0, 1, 0,
3784 doc: /* Return the visual class of the X display TERMINAL.
3785 The value is one of the symbols `static-gray', `gray-scale',
3786 `static-color', `pseudo-color', `true-color', or `direct-color'.
3788 The optional argument TERMINAL specifies which display to ask about.
3789 TERMINAL should a terminal object, a frame or a display name (a string).
3790 If omitted or nil, that stands for the selected frame's display. */)
3791 (Lisp_Object terminal)
3793 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3794 Lisp_Object result;
3796 switch (dpyinfo->visual->class)
3798 case StaticGray:
3799 result = intern ("static-gray");
3800 break;
3801 case GrayScale:
3802 result = intern ("gray-scale");
3803 break;
3804 case StaticColor:
3805 result = intern ("static-color");
3806 break;
3807 case PseudoColor:
3808 result = intern ("pseudo-color");
3809 break;
3810 case TrueColor:
3811 result = intern ("true-color");
3812 break;
3813 case DirectColor:
3814 result = intern ("direct-color");
3815 break;
3816 default:
3817 error ("Display has an unknown visual class");
3818 result = Qnil;
3821 return result;
3824 DEFUN ("x-display-save-under", Fx_display_save_under,
3825 Sx_display_save_under, 0, 1, 0,
3826 doc: /* Return t if the X display TERMINAL supports the save-under feature.
3827 The optional argument TERMINAL specifies which display to ask about.
3828 TERMINAL should be a terminal object, a frame or a display name (a string).
3829 If omitted or nil, that stands for the selected frame's display. */)
3830 (Lisp_Object terminal)
3832 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3834 if (DoesSaveUnders (dpyinfo->screen) == True)
3835 return Qt;
3836 else
3837 return Qnil;
3841 x_pixel_width (register struct frame *f)
3843 return FRAME_PIXEL_WIDTH (f);
3847 x_pixel_height (register struct frame *f)
3849 return FRAME_PIXEL_HEIGHT (f);
3853 x_char_width (register struct frame *f)
3855 return FRAME_COLUMN_WIDTH (f);
3859 x_char_height (register struct frame *f)
3861 return FRAME_LINE_HEIGHT (f);
3866 /************************************************************************
3867 X Displays
3868 ************************************************************************/
3871 /* Mapping visual names to visuals. */
3873 static struct visual_class
3875 const char *name;
3876 int class;
3878 visual_classes[] =
3880 {"StaticGray", StaticGray},
3881 {"GrayScale", GrayScale},
3882 {"StaticColor", StaticColor},
3883 {"PseudoColor", PseudoColor},
3884 {"TrueColor", TrueColor},
3885 {"DirectColor", DirectColor},
3886 {NULL, 0}
3890 #ifndef HAVE_XSCREENNUMBEROFSCREEN
3892 /* Value is the screen number of screen SCR. This is a substitute for
3893 the X function with the same name when that doesn't exist. */
3896 XScreenNumberOfScreen (scr)
3897 register Screen *scr;
3899 Display *dpy = scr->display;
3900 int i;
3902 for (i = 0; i < dpy->nscreens; ++i)
3903 if (scr == dpy->screens + i)
3904 break;
3906 return i;
3909 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
3912 /* Select the visual that should be used on display DPYINFO. Set
3913 members of DPYINFO appropriately. Called from x_term_init. */
3915 void
3916 select_visual (struct x_display_info *dpyinfo)
3918 Display *dpy = dpyinfo->display;
3919 Screen *screen = dpyinfo->screen;
3920 Lisp_Object value;
3922 /* See if a visual is specified. */
3923 value = display_x_get_resource (dpyinfo,
3924 build_string ("visualClass"),
3925 build_string ("VisualClass"),
3926 Qnil, Qnil);
3927 if (STRINGP (value))
3929 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
3930 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
3931 depth, a decimal number. NAME is compared with case ignored. */
3932 char *s = (char *) alloca (SBYTES (value) + 1);
3933 char *dash;
3934 int i, class = -1;
3935 XVisualInfo vinfo;
3937 strcpy (s, SSDATA (value));
3938 dash = strchr (s, '-');
3939 if (dash)
3941 dpyinfo->n_planes = atoi (dash + 1);
3942 *dash = '\0';
3944 else
3945 /* We won't find a matching visual with depth 0, so that
3946 an error will be printed below. */
3947 dpyinfo->n_planes = 0;
3949 /* Determine the visual class. */
3950 for (i = 0; visual_classes[i].name; ++i)
3951 if (xstrcasecmp (s, visual_classes[i].name) == 0)
3953 class = visual_classes[i].class;
3954 break;
3957 /* Look up a matching visual for the specified class. */
3958 if (class == -1
3959 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
3960 dpyinfo->n_planes, class, &vinfo))
3961 fatal ("Invalid visual specification `%s'", SDATA (value));
3963 dpyinfo->visual = vinfo.visual;
3965 else
3967 int n_visuals;
3968 XVisualInfo *vinfo, vinfo_template;
3970 dpyinfo->visual = DefaultVisualOfScreen (screen);
3972 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
3973 vinfo_template.screen = XScreenNumberOfScreen (screen);
3974 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
3975 &vinfo_template, &n_visuals);
3976 if (n_visuals <= 0)
3977 fatal ("Can't get proper X visual info");
3979 dpyinfo->n_planes = vinfo->depth;
3980 XFree ((char *) vinfo);
3985 /* Return the X display structure for the display named NAME.
3986 Open a new connection if necessary. */
3988 static struct x_display_info *
3989 x_display_info_for_name (Lisp_Object name)
3991 Lisp_Object names;
3992 struct x_display_info *dpyinfo;
3994 CHECK_STRING (name);
3996 #if 0
3997 if (! EQ (Vinitial_window_system, intern ("x")))
3998 error ("Not using X Windows"); /* That doesn't stop us anymore. */
3999 #endif
4001 for (dpyinfo = x_display_list, names = x_display_name_list;
4002 dpyinfo;
4003 dpyinfo = dpyinfo->next, names = XCDR (names))
4005 Lisp_Object tem;
4006 tem = Fstring_equal (XCAR (XCAR (names)), name);
4007 if (!NILP (tem))
4008 return dpyinfo;
4011 /* Use this general default value to start with. */
4012 Vx_resource_name = Vinvocation_name;
4014 validate_x_resource_name ();
4016 dpyinfo = x_term_init (name, (char *)0,
4017 SSDATA (Vx_resource_name));
4019 if (dpyinfo == 0)
4020 error ("Cannot connect to X server %s", SDATA (name));
4022 x_in_use = 1;
4023 XSETFASTINT (Vwindow_system_version, 11);
4025 return dpyinfo;
4029 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4030 1, 3, 0,
4031 doc: /* Open a connection to a display server.
4032 DISPLAY is the name of the display to connect to.
4033 Optional second arg XRM-STRING is a string of resources in xrdb format.
4034 If the optional third arg MUST-SUCCEED is non-nil,
4035 terminate Emacs if we can't open the connection.
4036 \(In the Nextstep version, the last two arguments are currently ignored.) */)
4037 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4039 char *xrm_option;
4040 struct x_display_info *dpyinfo;
4042 CHECK_STRING (display);
4043 if (! NILP (xrm_string))
4044 CHECK_STRING (xrm_string);
4046 #if 0
4047 if (! EQ (Vinitial_window_system, intern ("x")))
4048 error ("Not using X Windows"); /* That doesn't stop us anymore. */
4049 #endif
4051 if (! NILP (xrm_string))
4052 xrm_option = SSDATA (xrm_string);
4053 else
4054 xrm_option = (char *) 0;
4056 validate_x_resource_name ();
4058 /* This is what opens the connection and sets x_current_display.
4059 This also initializes many symbols, such as those used for input. */
4060 dpyinfo = x_term_init (display, xrm_option,
4061 SSDATA (Vx_resource_name));
4063 if (dpyinfo == 0)
4065 if (!NILP (must_succeed))
4066 fatal ("Cannot connect to X server %s.\n\
4067 Check the DISPLAY environment variable or use `-d'.\n\
4068 Also use the `xauth' program to verify that you have the proper\n\
4069 authorization information needed to connect the X server.\n\
4070 An insecure way to solve the problem may be to use `xhost'.\n",
4071 SDATA (display));
4072 else
4073 error ("Cannot connect to X server %s", SDATA (display));
4076 x_in_use = 1;
4078 XSETFASTINT (Vwindow_system_version, 11);
4079 return Qnil;
4082 DEFUN ("x-close-connection", Fx_close_connection,
4083 Sx_close_connection, 1, 1, 0,
4084 doc: /* Close the connection to TERMINAL's X server.
4085 For TERMINAL, specify a terminal object, a frame or a display name (a
4086 string). If TERMINAL is nil, that stands for the selected frame's
4087 terminal. */)
4088 (Lisp_Object terminal)
4090 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4092 if (dpyinfo->reference_count > 0)
4093 error ("Display still has frames on it");
4095 x_delete_terminal (dpyinfo->terminal);
4097 return Qnil;
4100 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4101 doc: /* Return the list of display names that Emacs has connections to. */)
4102 (void)
4104 Lisp_Object tail, result;
4106 result = Qnil;
4107 for (tail = x_display_name_list; CONSP (tail); tail = XCDR (tail))
4108 result = Fcons (XCAR (XCAR (tail)), result);
4110 return result;
4113 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4114 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4115 This function only has an effect on X Windows. With MS Windows, it is
4116 defined but does nothing.
4118 If ON is nil, allow buffering of requests.
4119 Turning on synchronization prohibits the Xlib routines from buffering
4120 requests and seriously degrades performance, but makes debugging much
4121 easier.
4122 The optional second argument TERMINAL specifies which display to act on.
4123 TERMINAL should be a terminal object, a frame or a display name (a string).
4124 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
4125 (Lisp_Object on, Lisp_Object terminal)
4127 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4129 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4131 return Qnil;
4134 /* Wait for responses to all X commands issued so far for frame F. */
4136 void
4137 x_sync (FRAME_PTR f)
4139 BLOCK_INPUT;
4140 XSync (FRAME_X_DISPLAY (f), False);
4141 UNBLOCK_INPUT;
4145 /***********************************************************************
4146 Window properties
4147 ***********************************************************************/
4149 DEFUN ("x-change-window-property", Fx_change_window_property,
4150 Sx_change_window_property, 2, 6, 0,
4151 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4152 PROP must be a string. VALUE may be a string or a list of conses,
4153 numbers and/or strings. If an element in the list is a string, it is
4154 converted to an atom and the value of the atom is used. If an element
4155 is a cons, it is converted to a 32 bit number where the car is the 16
4156 top bits and the cdr is the lower 16 bits.
4158 FRAME nil or omitted means use the selected frame.
4159 If TYPE is given and non-nil, it is the name of the type of VALUE.
4160 If TYPE is not given or nil, the type is STRING.
4161 FORMAT gives the size in bits of each element if VALUE is a list.
4162 It must be one of 8, 16 or 32.
4163 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4164 If OUTER_P is non-nil, the property is changed for the outer X window of
4165 FRAME. Default is to change on the edit X window. */)
4166 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame, Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
4168 struct frame *f = check_x_frame (frame);
4169 Atom prop_atom;
4170 Atom target_type = XA_STRING;
4171 int element_format = 8;
4172 unsigned char *data;
4173 int nelements;
4174 Window w;
4176 CHECK_STRING (prop);
4178 if (! NILP (format))
4180 CHECK_NUMBER (format);
4181 element_format = XFASTINT (format);
4183 if (element_format != 8 && element_format != 16
4184 && element_format != 32)
4185 error ("FORMAT must be one of 8, 16 or 32");
4188 if (CONSP (value))
4190 nelements = x_check_property_data (value);
4191 if (nelements == -1)
4192 error ("Bad data in VALUE, must be number, string or cons");
4194 if (element_format == 8)
4195 data = (unsigned char *) xmalloc (nelements);
4196 else if (element_format == 16)
4197 data = (unsigned char *) xmalloc (nelements*2);
4198 else /* format == 32 */
4199 /* The man page for XChangeProperty:
4200 "If the specified format is 32, the property data must be a
4201 long array."
4202 This applies even if long is more than 64 bits. The X library
4203 converts to 32 bits before sending to the X server. */
4204 data = (unsigned char *) xmalloc (nelements * sizeof(long));
4206 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4208 else
4210 CHECK_STRING (value);
4211 data = SDATA (value);
4212 nelements = SCHARS (value);
4215 BLOCK_INPUT;
4216 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4217 if (! NILP (type))
4219 CHECK_STRING (type);
4220 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4223 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4224 else w = FRAME_X_WINDOW (f);
4226 XChangeProperty (FRAME_X_DISPLAY (f), w,
4227 prop_atom, target_type, element_format, PropModeReplace,
4228 data, nelements);
4230 if (CONSP (value)) xfree (data);
4232 /* Make sure the property is set when we return. */
4233 XFlush (FRAME_X_DISPLAY (f));
4234 UNBLOCK_INPUT;
4236 return value;
4240 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4241 Sx_delete_window_property, 1, 2, 0,
4242 doc: /* Remove window property PROP from X window of FRAME.
4243 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4244 (Lisp_Object prop, Lisp_Object frame)
4246 struct frame *f = check_x_frame (frame);
4247 Atom prop_atom;
4249 CHECK_STRING (prop);
4250 BLOCK_INPUT;
4251 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4252 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4254 /* Make sure the property is removed when we return. */
4255 XFlush (FRAME_X_DISPLAY (f));
4256 UNBLOCK_INPUT;
4258 return prop;
4262 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4263 1, 6, 0,
4264 doc: /* Value is the value of window property PROP on FRAME.
4265 If FRAME is nil or omitted, use the selected frame.
4267 On MS Windows, this function only accepts the PROP and FRAME arguments.
4269 On X Windows, the following optional arguments are also accepted:
4270 If TYPE is nil or omitted, get the property as a string.
4271 Otherwise TYPE is the name of the atom that denotes the type expected.
4272 If SOURCE is non-nil, get the property on that window instead of from
4273 FRAME. The number 0 denotes the root window.
4274 If DELETE_P is non-nil, delete the property after retreiving it.
4275 If VECTOR_RET_P is non-nil, don't return a string but a vector of values.
4277 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4278 no value of TYPE (always string in the MS Windows case). */)
4279 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type, Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
4281 struct frame *f = check_x_frame (frame);
4282 Atom prop_atom;
4283 int rc;
4284 Lisp_Object prop_value = Qnil;
4285 unsigned char *tmp_data = NULL;
4286 Atom actual_type;
4287 Atom target_type = XA_STRING;
4288 int actual_format;
4289 unsigned long actual_size, bytes_remaining;
4290 Window target_window = FRAME_X_WINDOW (f);
4291 struct gcpro gcpro1;
4293 GCPRO1 (prop_value);
4294 CHECK_STRING (prop);
4296 if (! NILP (source))
4298 if (NUMBERP (source))
4300 if (FLOATP (source))
4301 target_window = (Window) XFLOAT (source);
4302 else
4303 target_window = XFASTINT (source);
4305 if (target_window == 0)
4306 target_window = FRAME_X_DISPLAY_INFO (f)->root_window;
4308 else if (CONSP (source))
4309 target_window = cons_to_long (source);
4312 BLOCK_INPUT;
4313 if (STRINGP (type))
4315 if (strcmp ("AnyPropertyType", SSDATA (type)) == 0)
4316 target_type = AnyPropertyType;
4317 else
4318 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4321 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4322 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4323 prop_atom, 0, 0, False, target_type,
4324 &actual_type, &actual_format, &actual_size,
4325 &bytes_remaining, &tmp_data);
4326 if (rc == Success)
4328 int size = bytes_remaining;
4330 XFree (tmp_data);
4331 tmp_data = NULL;
4333 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4334 prop_atom, 0, bytes_remaining,
4335 ! NILP (delete_p), target_type,
4336 &actual_type, &actual_format,
4337 &actual_size, &bytes_remaining,
4338 &tmp_data);
4339 if (rc == Success && tmp_data)
4341 /* The man page for XGetWindowProperty says:
4342 "If the returned format is 32, the returned data is represented
4343 as a long array and should be cast to that type to obtain the
4344 elements."
4345 This applies even if long is more than 32 bits, the X library
4346 converts from 32 bit elements received from the X server to long
4347 and passes the long array to us. Thus, for that case memcpy can not
4348 be used. We convert to a 32 bit type here, because so much code
4349 assume on that.
4351 The bytes and offsets passed to XGetWindowProperty refers to the
4352 property and those are indeed in 32 bit quantities if format is
4353 32. */
4355 if (32 < BITS_PER_LONG && actual_format == 32)
4357 unsigned long i;
4358 int *idata = (int *) tmp_data;
4359 long *ldata = (long *) tmp_data;
4361 for (i = 0; i < actual_size; ++i)
4362 idata[i] = (int) ldata[i];
4365 if (NILP (vector_ret_p))
4366 prop_value = make_string ((char *) tmp_data, size);
4367 else
4368 prop_value = x_property_data_to_lisp (f,
4369 tmp_data,
4370 actual_type,
4371 actual_format,
4372 actual_size);
4375 if (tmp_data) XFree (tmp_data);
4378 UNBLOCK_INPUT;
4379 UNGCPRO;
4380 return prop_value;
4385 /***********************************************************************
4386 Busy cursor
4387 ***********************************************************************/
4389 /* Timer function of hourglass_atimer. TIMER is equal to
4390 hourglass_atimer.
4392 Display an hourglass pointer on all frames by mapping the frames'
4393 hourglass_window. Set the hourglass_p flag in the frames'
4394 output_data.x structure to indicate that an hourglass cursor is
4395 shown on the frames. */
4397 void
4398 show_hourglass (struct atimer *timer)
4400 /* The timer implementation will cancel this timer automatically
4401 after this function has run. Set hourglass_atimer to null
4402 so that we know the timer doesn't have to be canceled. */
4403 hourglass_atimer = NULL;
4405 if (!hourglass_shown_p)
4407 Lisp_Object rest, frame;
4409 BLOCK_INPUT;
4411 FOR_EACH_FRAME (rest, frame)
4413 struct frame *f = XFRAME (frame);
4415 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4417 Display *dpy = FRAME_X_DISPLAY (f);
4419 #ifdef USE_X_TOOLKIT
4420 if (f->output_data.x->widget)
4421 #else
4422 if (FRAME_OUTER_WINDOW (f))
4423 #endif
4425 f->output_data.x->hourglass_p = 1;
4427 if (!f->output_data.x->hourglass_window)
4429 unsigned long mask = CWCursor;
4430 XSetWindowAttributes attrs;
4431 #ifdef USE_GTK
4432 Window parent = FRAME_X_WINDOW (f);
4433 #else
4434 Window parent = FRAME_OUTER_WINDOW (f);
4435 #endif
4436 attrs.cursor = f->output_data.x->hourglass_cursor;
4438 f->output_data.x->hourglass_window
4439 = XCreateWindow (dpy, parent,
4440 0, 0, 32000, 32000, 0, 0,
4441 InputOnly,
4442 CopyFromParent,
4443 mask, &attrs);
4446 XMapRaised (dpy, f->output_data.x->hourglass_window);
4447 XFlush (dpy);
4452 hourglass_shown_p = 1;
4453 UNBLOCK_INPUT;
4458 /* Hide the hourglass pointer on all frames, if it is currently
4459 shown. */
4461 void
4462 hide_hourglass (void)
4464 if (hourglass_shown_p)
4466 Lisp_Object rest, frame;
4468 BLOCK_INPUT;
4469 FOR_EACH_FRAME (rest, frame)
4471 struct frame *f = XFRAME (frame);
4473 if (FRAME_X_P (f)
4474 /* Watch out for newly created frames. */
4475 && f->output_data.x->hourglass_window)
4477 XUnmapWindow (FRAME_X_DISPLAY (f),
4478 f->output_data.x->hourglass_window);
4479 /* Sync here because XTread_socket looks at the
4480 hourglass_p flag that is reset to zero below. */
4481 XSync (FRAME_X_DISPLAY (f), False);
4482 f->output_data.x->hourglass_p = 0;
4486 hourglass_shown_p = 0;
4487 UNBLOCK_INPUT;
4493 /***********************************************************************
4494 Tool tips
4495 ***********************************************************************/
4497 static Lisp_Object x_create_tip_frame (struct x_display_info *,
4498 Lisp_Object, Lisp_Object);
4499 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
4500 Lisp_Object, int, int, int *, int *);
4502 /* The frame of a currently visible tooltip. */
4504 Lisp_Object tip_frame;
4506 /* If non-nil, a timer started that hides the last tooltip when it
4507 fires. */
4509 static Lisp_Object tip_timer;
4510 Window tip_window;
4512 /* If non-nil, a vector of 3 elements containing the last args
4513 with which x-show-tip was called. See there. */
4515 static Lisp_Object last_show_tip_args;
4518 static Lisp_Object
4519 unwind_create_tip_frame (Lisp_Object frame)
4521 Lisp_Object deleted;
4523 deleted = unwind_create_frame (frame);
4524 if (EQ (deleted, Qt))
4526 tip_window = None;
4527 tip_frame = Qnil;
4530 return deleted;
4534 /* Create a frame for a tooltip on the display described by DPYINFO.
4535 PARMS is a list of frame parameters. TEXT is the string to
4536 display in the tip frame. Value is the frame.
4538 Note that functions called here, esp. x_default_parameter can
4539 signal errors, for instance when a specified color name is
4540 undefined. We have to make sure that we're in a consistent state
4541 when this happens. */
4543 static Lisp_Object
4544 x_create_tip_frame (struct x_display_info *dpyinfo,
4545 Lisp_Object parms,
4546 Lisp_Object text)
4548 struct frame *f;
4549 Lisp_Object frame;
4550 Lisp_Object name;
4551 int width, height;
4552 int count = SPECPDL_INDEX ();
4553 struct gcpro gcpro1, gcpro2, gcpro3;
4554 int face_change_count_before = face_change_count;
4555 Lisp_Object buffer;
4556 struct buffer *old_buffer;
4558 check_x ();
4560 if (!dpyinfo->terminal->name)
4561 error ("Terminal is not live, can't create new frames on it");
4563 parms = Fcopy_alist (parms);
4565 /* Get the name of the frame to use for resource lookup. */
4566 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4567 if (!STRINGP (name)
4568 && !EQ (name, Qunbound)
4569 && !NILP (name))
4570 error ("Invalid frame name--not a string or nil");
4572 frame = Qnil;
4573 GCPRO3 (parms, name, frame);
4574 f = make_frame (1);
4575 XSETFRAME (frame, f);
4577 buffer = Fget_buffer_create (build_string (" *tip*"));
4578 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer, Qnil);
4579 old_buffer = current_buffer;
4580 set_buffer_internal_1 (XBUFFER (buffer));
4581 BVAR (current_buffer, truncate_lines) = Qnil;
4582 specbind (Qinhibit_read_only, Qt);
4583 specbind (Qinhibit_modification_hooks, Qt);
4584 Ferase_buffer ();
4585 Finsert (1, &text);
4586 set_buffer_internal_1 (old_buffer);
4588 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
4589 record_unwind_protect (unwind_create_tip_frame, frame);
4591 f->terminal = dpyinfo->terminal;
4592 f->terminal->reference_count++;
4594 /* By setting the output method, we're essentially saying that
4595 the frame is live, as per FRAME_LIVE_P. If we get a signal
4596 from this point on, x_destroy_window might screw up reference
4597 counts etc. */
4598 f->output_method = output_x_window;
4599 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4600 memset (f->output_data.x, 0, sizeof (struct x_output));
4601 f->output_data.x->icon_bitmap = -1;
4602 FRAME_FONTSET (f) = -1;
4603 f->output_data.x->scroll_bar_foreground_pixel = -1;
4604 f->output_data.x->scroll_bar_background_pixel = -1;
4605 #ifdef USE_TOOLKIT_SCROLL_BARS
4606 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
4607 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
4608 #endif /* USE_TOOLKIT_SCROLL_BARS */
4609 f->icon_name = Qnil;
4610 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4611 #if GLYPH_DEBUG
4612 image_cache_refcount = FRAME_IMAGE_CACHE (f)->refcount;
4613 dpyinfo_refcount = dpyinfo->reference_count;
4614 #endif /* GLYPH_DEBUG */
4615 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4616 f->output_data.x->explicit_parent = 0;
4618 /* These colors will be set anyway later, but it's important
4619 to get the color reference counts right, so initialize them! */
4621 Lisp_Object black;
4622 struct gcpro inner_gcpro1;
4624 /* Function x_decode_color can signal an error. Make
4625 sure to initialize color slots so that we won't try
4626 to free colors we haven't allocated. */
4627 FRAME_FOREGROUND_PIXEL (f) = -1;
4628 FRAME_BACKGROUND_PIXEL (f) = -1;
4629 f->output_data.x->cursor_pixel = -1;
4630 f->output_data.x->cursor_foreground_pixel = -1;
4631 f->output_data.x->border_pixel = -1;
4632 f->output_data.x->mouse_pixel = -1;
4634 black = build_string ("black");
4635 GCPRO1_VAR (black, inner_gcpro);
4636 FRAME_FOREGROUND_PIXEL (f)
4637 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4638 FRAME_BACKGROUND_PIXEL (f)
4639 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4640 f->output_data.x->cursor_pixel
4641 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4642 f->output_data.x->cursor_foreground_pixel
4643 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4644 f->output_data.x->border_pixel
4645 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4646 f->output_data.x->mouse_pixel
4647 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4648 UNGCPRO_VAR (inner_gcpro);
4651 /* Set the name; the functions to which we pass f expect the name to
4652 be set. */
4653 if (EQ (name, Qunbound) || NILP (name))
4655 f->name = build_string (dpyinfo->x_id_name);
4656 f->explicit_name = 0;
4658 else
4660 f->name = name;
4661 f->explicit_name = 1;
4662 /* use the frame's title when getting resources for this frame. */
4663 specbind (Qx_resource_name, name);
4666 f->resx = dpyinfo->resx;
4667 f->resy = dpyinfo->resy;
4669 register_font_driver (&xfont_driver, f);
4670 #ifdef HAVE_FREETYPE
4671 #ifdef HAVE_XFT
4672 register_font_driver (&xftfont_driver, f);
4673 #else /* not HAVE_XFT */
4674 register_font_driver (&ftxfont_driver, f);
4675 #endif /* not HAVE_XFT */
4676 #endif /* HAVE_FREETYPE */
4678 x_default_parameter (f, parms, Qfont_backend, Qnil,
4679 "fontBackend", "FontBackend", RES_TYPE_STRING);
4681 /* Extract the window parameters from the supplied values that are
4682 needed to determine window geometry. */
4683 x_default_font_parameter (f, parms);
4685 x_default_parameter (f, parms, Qborder_width, make_number (0),
4686 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4688 /* This defaults to 2 in order to match xterm. We recognize either
4689 internalBorderWidth or internalBorder (which is what xterm calls
4690 it). */
4691 if (NILP (Fassq (Qinternal_border_width, parms)))
4693 Lisp_Object value;
4695 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4696 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4697 if (! EQ (value, Qunbound))
4698 parms = Fcons (Fcons (Qinternal_border_width, value),
4699 parms);
4702 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4703 "internalBorderWidth", "internalBorderWidth",
4704 RES_TYPE_NUMBER);
4706 /* Also do the stuff which must be set before the window exists. */
4707 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4708 "foreground", "Foreground", RES_TYPE_STRING);
4709 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4710 "background", "Background", RES_TYPE_STRING);
4711 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4712 "pointerColor", "Foreground", RES_TYPE_STRING);
4713 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4714 "cursorColor", "Foreground", RES_TYPE_STRING);
4715 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4716 "borderColor", "BorderColor", RES_TYPE_STRING);
4718 /* Init faces before x_default_parameter is called for scroll-bar
4719 parameters because that function calls x_set_scroll_bar_width,
4720 which calls change_frame_size, which calls Fset_window_buffer,
4721 which runs hooks, which call Fvertical_motion. At the end, we
4722 end up in init_iterator with a null face cache, which should not
4723 happen. */
4724 init_frame_faces (f);
4726 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4728 x_figure_window_size (f, parms, 0);
4731 XSetWindowAttributes attrs;
4732 unsigned long mask;
4733 Atom type = FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type_tooltip;
4735 BLOCK_INPUT;
4736 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
4737 if (DoesSaveUnders (dpyinfo->screen))
4738 mask |= CWSaveUnder;
4740 /* Window managers look at the override-redirect flag to determine
4741 whether or net to give windows a decoration (Xlib spec, chapter
4742 3.2.8). */
4743 attrs.override_redirect = True;
4744 attrs.save_under = True;
4745 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4746 /* Arrange for getting MapNotify and UnmapNotify events. */
4747 attrs.event_mask = StructureNotifyMask;
4748 tip_window
4749 = FRAME_X_WINDOW (f)
4750 = XCreateWindow (FRAME_X_DISPLAY (f),
4751 FRAME_X_DISPLAY_INFO (f)->root_window,
4752 /* x, y, width, height */
4753 0, 0, 1, 1,
4754 /* Border. */
4755 f->border_width,
4756 CopyFromParent, InputOutput, CopyFromParent,
4757 mask, &attrs);
4758 XChangeProperty (FRAME_X_DISPLAY (f), tip_window,
4759 FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type,
4760 XA_ATOM, 32, PropModeReplace,
4761 (unsigned char *)&type, 1);
4762 UNBLOCK_INPUT;
4765 x_make_gc (f);
4767 x_default_parameter (f, parms, Qauto_raise, Qnil,
4768 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4769 x_default_parameter (f, parms, Qauto_lower, Qnil,
4770 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4771 x_default_parameter (f, parms, Qcursor_type, Qbox,
4772 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4774 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4775 Change will not be effected unless different from the current
4776 FRAME_LINES (f). */
4777 width = FRAME_COLS (f);
4778 height = FRAME_LINES (f);
4779 SET_FRAME_COLS (f, 0);
4780 FRAME_LINES (f) = 0;
4781 change_frame_size (f, height, width, 1, 0, 0);
4783 /* Add `tooltip' frame parameter's default value. */
4784 if (NILP (Fframe_parameter (frame, Qtooltip)))
4785 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
4787 /* FIXME - can this be done in a similar way to normal frames?
4788 http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00641.html */
4790 /* Set the `display-type' frame parameter before setting up faces. */
4792 Lisp_Object disptype;
4794 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
4795 disptype = intern ("mono");
4796 else if (FRAME_X_DISPLAY_INFO (f)->visual->class == GrayScale
4797 || FRAME_X_DISPLAY_INFO (f)->visual->class == StaticGray)
4798 disptype = intern ("grayscale");
4799 else
4800 disptype = intern ("color");
4802 if (NILP (Fframe_parameter (frame, Qdisplay_type)))
4803 Fmodify_frame_parameters (frame, Fcons (Fcons (Qdisplay_type, disptype),
4804 Qnil));
4807 /* Set up faces after all frame parameters are known. This call
4808 also merges in face attributes specified for new frames.
4810 Frame parameters may be changed if .Xdefaults contains
4811 specifications for the default font. For example, if there is an
4812 `Emacs.default.attributeBackground: pink', the `background-color'
4813 attribute of the frame get's set, which let's the internal border
4814 of the tooltip frame appear in pink. Prevent this. */
4816 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
4818 /* Set tip_frame here, so that */
4819 tip_frame = frame;
4820 call2 (Qface_set_after_frame_default, frame, Qnil);
4822 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
4823 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
4824 Qnil));
4827 f->no_split = 1;
4829 UNGCPRO;
4831 /* It is now ok to make the frame official even if we get an error
4832 below. And the frame needs to be on Vframe_list or making it
4833 visible won't work. */
4834 Vframe_list = Fcons (frame, Vframe_list);
4836 /* Now that the frame is official, it counts as a reference to
4837 its display. */
4838 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4840 /* Setting attributes of faces of the tooltip frame from resources
4841 and similar will increment face_change_count, which leads to the
4842 clearing of all current matrices. Since this isn't necessary
4843 here, avoid it by resetting face_change_count to the value it
4844 had before we created the tip frame. */
4845 face_change_count = face_change_count_before;
4847 /* Discard the unwind_protect. */
4848 return unbind_to (count, frame);
4852 /* Compute where to display tip frame F. PARMS is the list of frame
4853 parameters for F. DX and DY are specified offsets from the current
4854 location of the mouse. WIDTH and HEIGHT are the width and height
4855 of the tooltip. Return coordinates relative to the root window of
4856 the display in *ROOT_X, and *ROOT_Y. */
4858 static void
4859 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)
4861 Lisp_Object left, top;
4862 int win_x, win_y;
4863 Window root, child;
4864 unsigned pmask;
4866 /* User-specified position? */
4867 left = Fcdr (Fassq (Qleft, parms));
4868 top = Fcdr (Fassq (Qtop, parms));
4870 /* Move the tooltip window where the mouse pointer is. Resize and
4871 show it. */
4872 if (!INTEGERP (left) || !INTEGERP (top))
4874 BLOCK_INPUT;
4875 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
4876 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
4877 UNBLOCK_INPUT;
4880 if (INTEGERP (top))
4881 *root_y = XINT (top);
4882 else if (*root_y + XINT (dy) <= 0)
4883 *root_y = 0; /* Can happen for negative dy */
4884 else if (*root_y + XINT (dy) + height
4885 <= x_display_pixel_height (FRAME_X_DISPLAY_INFO (f)))
4886 /* It fits below the pointer */
4887 *root_y += XINT (dy);
4888 else if (height + XINT (dy) <= *root_y)
4889 /* It fits above the pointer. */
4890 *root_y -= height + XINT (dy);
4891 else
4892 /* Put it on the top. */
4893 *root_y = 0;
4895 if (INTEGERP (left))
4896 *root_x = XINT (left);
4897 else if (*root_x + XINT (dx) <= 0)
4898 *root_x = 0; /* Can happen for negative dx */
4899 else if (*root_x + XINT (dx) + width
4900 <= x_display_pixel_width (FRAME_X_DISPLAY_INFO (f)))
4901 /* It fits to the right of the pointer. */
4902 *root_x += XINT (dx);
4903 else if (width + XINT (dx) <= *root_x)
4904 /* It fits to the left of the pointer. */
4905 *root_x -= width + XINT (dx);
4906 else
4907 /* Put it left-justified on the screen--it ought to fit that way. */
4908 *root_x = 0;
4912 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
4913 doc: /* Show STRING in a "tooltip" window on frame FRAME.
4914 A tooltip window is a small X window displaying a string.
4916 This is an internal function; Lisp code should call `tooltip-show'.
4918 FRAME nil or omitted means use the selected frame.
4920 PARMS is an optional list of frame parameters which can be used to
4921 change the tooltip's appearance.
4923 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
4924 means use the default timeout of 5 seconds.
4926 If the list of frame parameters PARMS contains a `left' parameters,
4927 the tooltip is displayed at that x-position. Otherwise it is
4928 displayed at the mouse position, with offset DX added (default is 5 if
4929 DX isn't specified). Likewise for the y-position; if a `top' frame
4930 parameter is specified, it determines the y-position of the tooltip
4931 window, otherwise it is displayed at the mouse position, with offset
4932 DY added (default is -10).
4934 A tooltip's maximum size is specified by `x-max-tooltip-size'.
4935 Text larger than the specified size is clipped. */)
4936 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
4938 struct frame *f;
4939 struct window *w;
4940 int root_x, root_y;
4941 struct buffer *old_buffer;
4942 struct text_pos pos;
4943 int i, width, height, seen_reversed_p;
4944 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4945 int old_windows_or_buffers_changed = windows_or_buffers_changed;
4946 int count = SPECPDL_INDEX ();
4948 specbind (Qinhibit_redisplay, Qt);
4950 GCPRO4 (string, parms, frame, timeout);
4952 CHECK_STRING (string);
4953 if (SCHARS (string) == 0)
4954 string = make_unibyte_string (" ", 1);
4956 f = check_x_frame (frame);
4957 if (NILP (timeout))
4958 timeout = make_number (5);
4959 else
4960 CHECK_NATNUM (timeout);
4962 if (NILP (dx))
4963 dx = make_number (5);
4964 else
4965 CHECK_NUMBER (dx);
4967 if (NILP (dy))
4968 dy = make_number (-10);
4969 else
4970 CHECK_NUMBER (dy);
4972 #ifdef USE_GTK
4973 if (x_gtk_use_system_tooltips)
4975 int ok;
4977 /* Hide a previous tip, if any. */
4978 Fx_hide_tip ();
4980 BLOCK_INPUT;
4981 if ((ok = xg_prepare_tooltip (f, string, &width, &height)) != 0)
4983 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
4984 xg_show_tooltip (f, root_x, root_y);
4985 /* This is used in Fx_hide_tip. */
4986 XSETFRAME (tip_frame, f);
4988 UNBLOCK_INPUT;
4989 if (ok) goto start_timer;
4991 #endif /* USE_GTK */
4993 if (NILP (last_show_tip_args))
4994 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
4996 if (!NILP (tip_frame))
4998 Lisp_Object last_string = AREF (last_show_tip_args, 0);
4999 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5000 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5002 if (EQ (frame, last_frame)
5003 && !NILP (Fequal (last_string, string))
5004 && !NILP (Fequal (last_parms, parms)))
5006 struct frame *tip_f = XFRAME (tip_frame);
5008 /* Only DX and DY have changed. */
5009 if (!NILP (tip_timer))
5011 Lisp_Object timer = tip_timer;
5012 tip_timer = Qnil;
5013 call1 (Qcancel_timer, timer);
5016 BLOCK_INPUT;
5017 compute_tip_xy (tip_f, parms, dx, dy, FRAME_PIXEL_WIDTH (tip_f),
5018 FRAME_PIXEL_HEIGHT (tip_f), &root_x, &root_y);
5019 XMoveWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
5020 root_x, root_y);
5021 UNBLOCK_INPUT;
5022 goto start_timer;
5026 /* Hide a previous tip, if any. */
5027 Fx_hide_tip ();
5029 ASET (last_show_tip_args, 0, string);
5030 ASET (last_show_tip_args, 1, frame);
5031 ASET (last_show_tip_args, 2, parms);
5033 /* Add default values to frame parameters. */
5034 if (NILP (Fassq (Qname, parms)))
5035 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5036 if (NILP (Fassq (Qinternal_border_width, parms)))
5037 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5038 if (NILP (Fassq (Qborder_width, parms)))
5039 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5040 if (NILP (Fassq (Qborder_color, parms)))
5041 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5042 if (NILP (Fassq (Qbackground_color, parms)))
5043 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5044 parms);
5046 /* Create a frame for the tooltip, and record it in the global
5047 variable tip_frame. */
5048 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
5049 f = XFRAME (frame);
5051 /* Set up the frame's root window. */
5052 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5053 w->left_col = w->top_line = make_number (0);
5055 if (CONSP (Vx_max_tooltip_size)
5056 && INTEGERP (XCAR (Vx_max_tooltip_size))
5057 && XINT (XCAR (Vx_max_tooltip_size)) > 0
5058 && INTEGERP (XCDR (Vx_max_tooltip_size))
5059 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
5061 w->total_cols = XCAR (Vx_max_tooltip_size);
5062 w->total_lines = XCDR (Vx_max_tooltip_size);
5064 else
5066 w->total_cols = make_number (80);
5067 w->total_lines = make_number (40);
5070 FRAME_TOTAL_COLS (f) = XINT (w->total_cols);
5071 adjust_glyphs (f);
5072 w->pseudo_window_p = 1;
5074 /* Display the tooltip text in a temporary buffer. */
5075 old_buffer = current_buffer;
5076 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
5077 BVAR (current_buffer, truncate_lines) = Qnil;
5078 clear_glyph_matrix (w->desired_matrix);
5079 clear_glyph_matrix (w->current_matrix);
5080 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5081 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
5083 /* Compute width and height of the tooltip. */
5084 width = height = seen_reversed_p = 0;
5085 for (i = 0; i < w->desired_matrix->nrows; ++i)
5087 struct glyph_row *row = &w->desired_matrix->rows[i];
5088 struct glyph *last;
5089 int row_width;
5091 /* Stop at the first empty row at the end. */
5092 if (!row->enabled_p || !row->displays_text_p)
5093 break;
5095 /* Let the row go over the full width of the frame. */
5096 row->full_width_p = 1;
5098 row_width = row->pixel_width;
5099 if (row->used[TEXT_AREA])
5101 /* There's a glyph at the end of rows that is used to place
5102 the cursor there. Don't include the width of this glyph. */
5103 if (!row->reversed_p)
5105 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5106 if (INTEGERP (last->object))
5107 row_width -= last->pixel_width;
5109 else
5111 /* There could be a stretch glyph at the beginning of R2L
5112 rows that is produced by extend_face_to_end_of_line.
5113 Don't count that glyph. */
5114 struct glyph *g = row->glyphs[TEXT_AREA];
5116 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
5118 row_width -= g->pixel_width;
5119 seen_reversed_p = 1;
5124 height += row->height;
5125 width = max (width, row_width);
5128 /* If we've seen partial-length R2L rows, we need to re-adjust the
5129 tool-tip frame width and redisplay it again, to avoid over-wide
5130 tips due to the stretch glyph that extends R2L lines to full
5131 width of the frame. */
5132 if (seen_reversed_p)
5134 /* w->total_cols and FRAME_TOTAL_COLS want the width in columns,
5135 not in pixels. */
5136 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
5137 w->total_cols = make_number (width);
5138 FRAME_TOTAL_COLS (f) = width;
5139 adjust_glyphs (f);
5140 clear_glyph_matrix (w->desired_matrix);
5141 clear_glyph_matrix (w->current_matrix);
5142 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5143 width = height = 0;
5144 /* Recompute width and height of the tooltip. */
5145 for (i = 0; i < w->desired_matrix->nrows; ++i)
5147 struct glyph_row *row = &w->desired_matrix->rows[i];
5148 struct glyph *last;
5149 int row_width;
5151 if (!row->enabled_p || !row->displays_text_p)
5152 break;
5153 row->full_width_p = 1;
5154 row_width = row->pixel_width;
5155 if (row->used[TEXT_AREA] && !row->reversed_p)
5157 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5158 if (INTEGERP (last->object))
5159 row_width -= last->pixel_width;
5162 height += row->height;
5163 width = max (width, row_width);
5167 /* Add the frame's internal border to the width and height the X
5168 window should have. */
5169 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5170 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5172 /* Move the tooltip window where the mouse pointer is. Resize and
5173 show it. */
5174 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5176 BLOCK_INPUT;
5177 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5178 root_x, root_y, width, height);
5179 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5180 UNBLOCK_INPUT;
5182 /* Draw into the window. */
5183 w->must_be_updated_p = 1;
5184 update_single_window (w, 1);
5186 /* Restore original current buffer. */
5187 set_buffer_internal_1 (old_buffer);
5188 windows_or_buffers_changed = old_windows_or_buffers_changed;
5190 start_timer:
5191 /* Let the tip disappear after timeout seconds. */
5192 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5193 intern ("x-hide-tip"));
5195 UNGCPRO;
5196 return unbind_to (count, Qnil);
5200 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5201 doc: /* Hide the current tooltip window, if there is any.
5202 Value is t if tooltip was open, nil otherwise. */)
5203 (void)
5205 int count;
5206 Lisp_Object deleted, frame, timer;
5207 struct gcpro gcpro1, gcpro2;
5209 /* Return quickly if nothing to do. */
5210 if (NILP (tip_timer) && NILP (tip_frame))
5211 return Qnil;
5213 frame = tip_frame;
5214 timer = tip_timer;
5215 GCPRO2 (frame, timer);
5216 tip_frame = tip_timer = deleted = Qnil;
5218 count = SPECPDL_INDEX ();
5219 specbind (Qinhibit_redisplay, Qt);
5220 specbind (Qinhibit_quit, Qt);
5222 if (!NILP (timer))
5223 call1 (Qcancel_timer, timer);
5225 #ifdef USE_GTK
5227 /* When using system tooltip, tip_frame is the Emacs frame on which
5228 the tip is shown. */
5229 struct frame *f = XFRAME (frame);
5230 if (FRAME_LIVE_P (f) && xg_hide_tooltip (f))
5231 frame = Qnil;
5233 #endif
5235 if (FRAMEP (frame))
5237 delete_frame (frame, Qnil);
5238 deleted = Qt;
5240 #ifdef USE_LUCID
5241 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5242 redisplay procedure is not called when a tip frame over menu
5243 items is unmapped. Redisplay the menu manually... */
5245 Widget w;
5246 struct frame *f = SELECTED_FRAME ();
5247 w = f->output_data.x->menubar_widget;
5249 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
5250 && w != NULL)
5252 BLOCK_INPUT;
5253 xlwmenu_redisplay (w);
5254 UNBLOCK_INPUT;
5257 #endif /* USE_LUCID */
5260 UNGCPRO;
5261 return unbind_to (count, deleted);
5266 /***********************************************************************
5267 File selection dialog
5268 ***********************************************************************/
5270 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5271 Sx_uses_old_gtk_dialog,
5272 0, 0, 0,
5273 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5274 (void)
5276 #ifdef USE_GTK
5277 if (use_dialog_box
5278 && use_file_dialog
5279 && have_menus_p ()
5280 && xg_uses_old_file_dialog ())
5281 return Qt;
5282 #endif
5283 return Qnil;
5287 #ifdef USE_MOTIF
5288 /* Callback for "OK" and "Cancel" on file selection dialog. */
5290 static void
5291 file_dialog_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5293 int *result = (int *) client_data;
5294 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
5295 *result = cb->reason;
5299 /* Callback for unmapping a file selection dialog. This is used to
5300 capture the case where a dialog is closed via a window manager's
5301 closer button, for example. Using a XmNdestroyCallback didn't work
5302 in this case. */
5304 static void
5305 file_dialog_unmap_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5307 int *result = (int *) client_data;
5308 *result = XmCR_CANCEL;
5311 static Lisp_Object
5312 clean_up_file_dialog (Lisp_Object arg)
5314 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
5315 Widget dialog = (Widget) p->pointer;
5317 /* Clean up. */
5318 BLOCK_INPUT;
5319 XtUnmanageChild (dialog);
5320 XtDestroyWidget (dialog);
5321 x_menu_set_in_use (0);
5322 UNBLOCK_INPUT;
5324 return Qnil;
5328 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5329 doc: /* Read file name, prompting with PROMPT in directory DIR.
5330 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5331 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5332 or directory must exist.
5334 This function is only defined on MS Windows, and X Windows with the
5335 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5336 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5337 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
5339 int result;
5340 struct frame *f = SELECTED_FRAME ();
5341 Lisp_Object file = Qnil;
5342 Lisp_Object decoded_file;
5343 Widget dialog, text, help;
5344 Arg al[10];
5345 int ac = 0;
5346 XmString dir_xmstring, pattern_xmstring;
5347 int count = SPECPDL_INDEX ();
5348 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5350 check_x ();
5352 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5354 if (popup_activated ())
5355 error ("Trying to use a menu from within a menu-entry");
5357 CHECK_STRING (prompt);
5358 CHECK_STRING (dir);
5360 /* Prevent redisplay. */
5361 specbind (Qinhibit_redisplay, Qt);
5363 BLOCK_INPUT;
5365 /* Create the dialog with PROMPT as title, using DIR as initial
5366 directory and using "*" as pattern. */
5367 dir = Fexpand_file_name (dir, Qnil);
5368 dir_xmstring = XmStringCreateLocalized (SDATA (dir));
5369 pattern_xmstring = XmStringCreateLocalized ("*");
5371 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5372 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5373 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5374 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5375 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5376 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5377 "fsb", al, ac);
5378 XmStringFree (dir_xmstring);
5379 XmStringFree (pattern_xmstring);
5381 /* Add callbacks for OK and Cancel. */
5382 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5383 (XtPointer) &result);
5384 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5385 (XtPointer) &result);
5386 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5387 (XtPointer) &result);
5389 /* Remove the help button since we can't display help. */
5390 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5391 XtUnmanageChild (help);
5393 /* Mark OK button as default. */
5394 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5395 XmNshowAsDefault, True, NULL);
5397 /* If MUSTMATCH is non-nil, disable the file entry field of the
5398 dialog, so that the user must select a file from the files list
5399 box. We can't remove it because we wouldn't have a way to get at
5400 the result file name, then. */
5401 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5402 if (!NILP (mustmatch))
5404 Widget label;
5405 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5406 XtSetSensitive (text, False);
5407 XtSetSensitive (label, False);
5410 /* Manage the dialog, so that list boxes get filled. */
5411 XtManageChild (dialog);
5413 if (STRINGP (default_filename))
5415 XmString default_xmstring;
5416 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5417 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5419 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5420 XmTextFieldReplace (wtext, 0, last_pos,
5421 (SDATA (Ffile_name_nondirectory (default_filename))));
5423 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5424 must include the path for this to work. */
5426 default_xmstring = XmStringCreateLocalized (SDATA (default_filename));
5428 if (XmListItemExists (list, default_xmstring))
5430 int item_pos = XmListItemPos (list, default_xmstring);
5431 /* Select the item and scroll it into view. */
5432 XmListSelectPos (list, item_pos, True);
5433 XmListSetPos (list, item_pos);
5436 XmStringFree (default_xmstring);
5439 record_unwind_protect (clean_up_file_dialog, make_save_value (dialog, 0));
5441 /* Process events until the user presses Cancel or OK. */
5442 x_menu_set_in_use (1);
5443 result = 0;
5444 while (result == 0)
5446 XEvent event;
5447 x_menu_wait_for_event (0);
5448 XtAppNextEvent (Xt_app_con, &event);
5449 if (event.type == KeyPress
5450 && FRAME_X_DISPLAY (f) == event.xkey.display)
5452 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5454 /* Pop down on C-g. */
5455 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5456 XtUnmanageChild (dialog);
5459 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5462 /* Get the result. */
5463 if (result == XmCR_OK)
5465 XmString text_string;
5466 String data;
5468 XtVaGetValues (dialog, XmNtextString, &text_string, NULL);
5469 XmStringGetLtoR (text_string, XmFONTLIST_DEFAULT_TAG, &data);
5470 XmStringFree (text_string);
5471 file = build_string (data);
5472 XtFree (data);
5474 else
5475 file = Qnil;
5477 UNBLOCK_INPUT;
5478 UNGCPRO;
5480 /* Make "Cancel" equivalent to C-g. */
5481 if (NILP (file))
5482 Fsignal (Qquit, Qnil);
5484 decoded_file = DECODE_FILE (file);
5486 return unbind_to (count, decoded_file);
5489 #endif /* USE_MOTIF */
5491 #ifdef USE_GTK
5493 static Lisp_Object
5494 clean_up_dialog (Lisp_Object arg)
5496 x_menu_set_in_use (0);
5498 return Qnil;
5501 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5502 doc: /* Read file name, prompting with PROMPT in directory DIR.
5503 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5504 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5505 or directory must exist.
5507 This function is only defined on MS Windows, and X Windows with the
5508 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5509 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5510 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
5512 FRAME_PTR f = SELECTED_FRAME ();
5513 char *fn;
5514 Lisp_Object file = Qnil;
5515 Lisp_Object decoded_file;
5516 int count = SPECPDL_INDEX ();
5517 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5518 char *cdef_file;
5520 check_x ();
5522 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5524 if (popup_activated ())
5525 error ("Trying to use a menu from within a menu-entry");
5527 CHECK_STRING (prompt);
5528 CHECK_STRING (dir);
5530 /* Prevent redisplay. */
5531 specbind (Qinhibit_redisplay, Qt);
5532 record_unwind_protect (clean_up_dialog, Qnil);
5534 BLOCK_INPUT;
5536 if (STRINGP (default_filename))
5537 cdef_file = SSDATA (default_filename);
5538 else
5539 cdef_file = SSDATA (dir);
5541 fn = xg_get_file_name (f, SSDATA (prompt), cdef_file,
5542 ! NILP (mustmatch),
5543 ! NILP (only_dir_p));
5545 if (fn)
5547 file = build_string (fn);
5548 xfree (fn);
5551 UNBLOCK_INPUT;
5552 UNGCPRO;
5554 /* Make "Cancel" equivalent to C-g. */
5555 if (NILP (file))
5556 Fsignal (Qquit, Qnil);
5558 decoded_file = DECODE_FILE (file);
5560 return unbind_to (count, decoded_file);
5564 #ifdef HAVE_FREETYPE
5566 DEFUN ("x-select-font", Fx_select_font, Sx_select_font, 0, 2, 0,
5567 doc: /* Read a font name using a GTK font selection dialog.
5568 Return a GTK-style font string corresponding to the selection.
5570 If FRAME is omitted or nil, it defaults to the selected frame. */)
5571 (Lisp_Object frame, Lisp_Object ignored)
5573 FRAME_PTR f = check_x_frame (frame);
5574 char *name;
5575 Lisp_Object font;
5576 Lisp_Object font_param;
5577 char *default_name = NULL;
5578 struct gcpro gcpro1, gcpro2;
5579 int count = SPECPDL_INDEX ();
5581 check_x ();
5583 if (popup_activated ())
5584 error ("Trying to use a menu from within a menu-entry");
5586 /* Prevent redisplay. */
5587 specbind (Qinhibit_redisplay, Qt);
5588 record_unwind_protect (clean_up_dialog, Qnil);
5590 BLOCK_INPUT;
5592 GCPRO2(font_param, font);
5594 XSETFONT (font, FRAME_FONT (f));
5595 font_param = Ffont_get (font, intern (":name"));
5596 if (STRINGP (font_param))
5597 default_name = xstrdup (SSDATA (font_param));
5598 else
5600 font_param = Fframe_parameter (frame, Qfont_param);
5601 if (STRINGP (font_param))
5602 default_name = xstrdup (SSDATA (font_param));
5605 if (default_name == NULL && x_last_font_name != NULL)
5606 default_name = xstrdup (x_last_font_name);
5608 /* Convert fontconfig names to Gtk names, i.e. remove - before number */
5609 if (default_name)
5611 char *p = strrchr (default_name, '-');
5612 if (p)
5614 char *ep = p+1;
5615 while (isdigit (*ep))
5616 ++ep;
5617 if (*ep == '\0') *p = ' ';
5621 name = xg_get_font_name (f, default_name);
5622 xfree (default_name);
5624 if (name)
5626 font = build_string (name);
5627 g_free (x_last_font_name);
5628 x_last_font_name = name;
5631 UNBLOCK_INPUT;
5633 if (NILP (font))
5634 Fsignal (Qquit, Qnil);
5636 return unbind_to (count, font);
5638 #endif /* HAVE_FREETYPE */
5640 #endif /* USE_GTK */
5643 /***********************************************************************
5644 Keyboard
5645 ***********************************************************************/
5647 #ifdef HAVE_XKBGETKEYBOARD
5648 #include <X11/XKBlib.h>
5649 #include <X11/keysym.h>
5650 #endif
5652 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
5653 Sx_backspace_delete_keys_p, 0, 1, 0,
5654 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
5655 FRAME nil means use the selected frame.
5656 Value is t if we know that both keys are present, and are mapped to the
5657 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
5658 present and mapped to the usual X keysyms. */)
5659 (Lisp_Object frame)
5661 #ifdef HAVE_XKBGETKEYBOARD
5662 XkbDescPtr kb;
5663 struct frame *f = check_x_frame (frame);
5664 Display *dpy = FRAME_X_DISPLAY (f);
5665 Lisp_Object have_keys;
5666 int major, minor, op, event, error_code;
5668 BLOCK_INPUT;
5670 /* Check library version in case we're dynamically linked. */
5671 major = XkbMajorVersion;
5672 minor = XkbMinorVersion;
5673 if (!XkbLibraryVersion (&major, &minor))
5675 UNBLOCK_INPUT;
5676 return Qlambda;
5679 /* Check that the server supports XKB. */
5680 major = XkbMajorVersion;
5681 minor = XkbMinorVersion;
5682 if (!XkbQueryExtension (dpy, &op, &event, &error_code, &major, &minor))
5684 UNBLOCK_INPUT;
5685 return Qlambda;
5688 /* In this code we check that the keyboard has physical keys with names
5689 that start with BKSP (Backspace) and DELE (Delete), and that they
5690 generate keysym XK_BackSpace and XK_Delete respectively.
5691 This function is used to test if normal-erase-is-backspace should be
5692 turned on.
5693 An alternative approach would be to just check if XK_BackSpace and
5694 XK_Delete are mapped to any key. But if any of those are mapped to
5695 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
5696 user doesn't know about it, it is better to return false here.
5697 It is more obvious to the user what to do if she/he has two keys
5698 clearly marked with names/symbols and one key does something not
5699 expected (i.e. she/he then tries the other).
5700 The cases where Backspace/Delete is mapped to some other key combination
5701 are rare, and in those cases, normal-erase-is-backspace can be turned on
5702 manually. */
5704 have_keys = Qnil;
5705 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
5706 if (kb)
5708 int delete_keycode = 0, backspace_keycode = 0, i;
5710 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
5712 for (i = kb->min_key_code;
5713 (i < kb->max_key_code
5714 && (delete_keycode == 0 || backspace_keycode == 0));
5715 ++i)
5717 /* The XKB symbolic key names can be seen most easily in
5718 the PS file generated by `xkbprint -label name
5719 $DISPLAY'. */
5720 if (memcmp ("DELE", kb->names->keys[i].name, 4) == 0)
5721 delete_keycode = i;
5722 else if (memcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
5723 backspace_keycode = i;
5726 XkbFreeNames (kb, 0, True);
5729 XkbFreeClientMap (kb, 0, True);
5731 if (delete_keycode
5732 && backspace_keycode
5733 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
5734 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
5735 have_keys = Qt;
5737 UNBLOCK_INPUT;
5738 return have_keys;
5739 #else /* not HAVE_XKBGETKEYBOARD */
5740 return Qlambda;
5741 #endif /* not HAVE_XKBGETKEYBOARD */
5746 /***********************************************************************
5747 Initialization
5748 ***********************************************************************/
5750 /* Keep this list in the same order as frame_parms in frame.c.
5751 Use 0 for unsupported frame parameters. */
5753 frame_parm_handler x_frame_parm_handlers[] =
5755 x_set_autoraise,
5756 x_set_autolower,
5757 x_set_background_color,
5758 x_set_border_color,
5759 x_set_border_width,
5760 x_set_cursor_color,
5761 x_set_cursor_type,
5762 x_set_font,
5763 x_set_foreground_color,
5764 x_set_icon_name,
5765 x_set_icon_type,
5766 x_set_internal_border_width,
5767 x_set_menu_bar_lines,
5768 x_set_mouse_color,
5769 x_explicitly_set_name,
5770 x_set_scroll_bar_width,
5771 x_set_title,
5772 x_set_unsplittable,
5773 x_set_vertical_scroll_bars,
5774 x_set_visibility,
5775 x_set_tool_bar_lines,
5776 x_set_scroll_bar_foreground,
5777 x_set_scroll_bar_background,
5778 x_set_screen_gamma,
5779 x_set_line_spacing,
5780 x_set_fringe_width,
5781 x_set_fringe_width,
5782 x_set_wait_for_wm,
5783 x_set_fullscreen,
5784 x_set_font_backend,
5785 x_set_alpha,
5786 x_set_sticky,
5787 x_set_tool_bar_position,
5790 void
5791 syms_of_xfns (void)
5793 /* This is zero if not using X windows. */
5794 x_in_use = 0;
5796 /* The section below is built by the lisp expression at the top of the file,
5797 just above where these variables are declared. */
5798 /*&&& init symbols here &&&*/
5799 Qnone = intern_c_string ("none");
5800 staticpro (&Qnone);
5801 Qsuppress_icon = intern_c_string ("suppress-icon");
5802 staticpro (&Qsuppress_icon);
5803 Qundefined_color = intern_c_string ("undefined-color");
5804 staticpro (&Qundefined_color);
5805 Qcompound_text = intern_c_string ("compound-text");
5806 staticpro (&Qcompound_text);
5807 Qcancel_timer = intern_c_string ("cancel-timer");
5808 staticpro (&Qcancel_timer);
5809 Qfont_param = intern_c_string ("font-parameter");
5810 staticpro (&Qfont_param);
5811 /* This is the end of symbol initialization. */
5813 /* Text property `display' should be nonsticky by default. */
5814 Vtext_property_default_nonsticky
5815 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
5818 Fput (Qundefined_color, Qerror_conditions,
5819 pure_cons (Qundefined_color, pure_cons (Qerror, Qnil)));
5820 Fput (Qundefined_color, Qerror_message,
5821 make_pure_c_string ("Undefined color"));
5823 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
5824 doc: /* The shape of the pointer when over text.
5825 Changing the value does not affect existing frames
5826 unless you set the mouse color. */);
5827 Vx_pointer_shape = Qnil;
5829 #if 0 /* This doesn't really do anything. */
5830 DEFVAR_LISP ("x-nontext-pointer-shape", Vx_nontext_pointer_shape,
5831 doc: /* The shape of the pointer when not over text.
5832 This variable takes effect when you create a new frame
5833 or when you set the mouse color. */);
5834 #endif
5835 Vx_nontext_pointer_shape = Qnil;
5837 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
5838 doc: /* The shape of the pointer when Emacs is busy.
5839 This variable takes effect when you create a new frame
5840 or when you set the mouse color. */);
5841 Vx_hourglass_pointer_shape = Qnil;
5843 #if 0 /* This doesn't really do anything. */
5844 DEFVAR_LISP ("x-mode-pointer-shape", Vx_mode_pointer_shape,
5845 doc: /* The shape of the pointer when over the mode line.
5846 This variable takes effect when you create a new frame
5847 or when you set the mouse color. */);
5848 #endif
5849 Vx_mode_pointer_shape = Qnil;
5851 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
5852 Vx_sensitive_text_pointer_shape,
5853 doc: /* The shape of the pointer when over mouse-sensitive text.
5854 This variable takes effect when you create a new frame
5855 or when you set the mouse color. */);
5856 Vx_sensitive_text_pointer_shape = Qnil;
5858 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
5859 Vx_window_horizontal_drag_shape,
5860 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
5861 This variable takes effect when you create a new frame
5862 or when you set the mouse color. */);
5863 Vx_window_horizontal_drag_shape = Qnil;
5865 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
5866 doc: /* A string indicating the foreground color of the cursor box. */);
5867 Vx_cursor_fore_pixel = Qnil;
5869 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
5870 doc: /* Maximum size for tooltips.
5871 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
5872 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
5874 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
5875 doc: /* Non-nil if no X window manager is in use.
5876 Emacs doesn't try to figure this out; this is always nil
5877 unless you set it to something else. */);
5878 /* We don't have any way to find this out, so set it to nil
5879 and maybe the user would like to set it to t. */
5880 Vx_no_window_manager = Qnil;
5882 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
5883 Vx_pixel_size_width_font_regexp,
5884 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
5886 Since Emacs gets width of a font matching with this regexp from
5887 PIXEL_SIZE field of the name, font finding mechanism gets faster for
5888 such a font. This is especially effective for such large fonts as
5889 Chinese, Japanese, and Korean. */);
5890 Vx_pixel_size_width_font_regexp = Qnil;
5892 /* This is not ifdef:ed, so other builds than GTK can customize it. */
5893 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", x_gtk_use_old_file_dialog,
5894 doc: /* *Non-nil means prompt with the old GTK file selection dialog.
5895 If nil or if the file selection dialog is not available, the new GTK file
5896 chooser is used instead. To turn off all file dialogs set the
5897 variable `use-file-dialog'. */);
5898 x_gtk_use_old_file_dialog = 0;
5900 DEFVAR_BOOL ("x-gtk-show-hidden-files", x_gtk_show_hidden_files,
5901 doc: /* *If non-nil, the GTK file chooser will by default show hidden files.
5902 Note that this is just the default, there is a toggle button on the file
5903 chooser to show or not show hidden files on a case by case basis. */);
5904 x_gtk_show_hidden_files = 0;
5906 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", x_gtk_file_dialog_help_text,
5907 doc: /* *If non-nil, the GTK file chooser will show additional help text.
5908 If more space for files in the file chooser dialog is wanted, set this to nil
5909 to turn the additional text off. */);
5910 x_gtk_file_dialog_help_text = 1;
5912 DEFVAR_BOOL ("x-gtk-whole-detached-tool-bar", x_gtk_whole_detached_tool_bar,
5913 doc: /* *If non-nil, a detached tool bar is shown in full.
5914 The default is to just show an arrow and pressing on that arrow shows
5915 the tool bar buttons. */);
5916 x_gtk_whole_detached_tool_bar = 0;
5918 DEFVAR_BOOL ("x-gtk-use-system-tooltips", x_gtk_use_system_tooltips,
5919 doc: /* *If non-nil with a Gtk+ built Emacs, the Gtk+ toolip is used.
5920 Otherwise use Emacs own tooltip implementation.
5921 When using Gtk+ tooltips, the tooltip face is not used. */);
5922 x_gtk_use_system_tooltips = 1;
5924 Fprovide (intern_c_string ("x"), Qnil);
5926 #ifdef USE_X_TOOLKIT
5927 Fprovide (intern_c_string ("x-toolkit"), Qnil);
5928 #ifdef USE_MOTIF
5929 Fprovide (intern_c_string ("motif"), Qnil);
5931 DEFVAR_LISP ("motif-version-string", Vmotif_version_string,
5932 doc: /* Version info for LessTif/Motif. */);
5933 Vmotif_version_string = build_string (XmVERSION_STRING);
5934 #endif /* USE_MOTIF */
5935 #endif /* USE_X_TOOLKIT */
5937 #ifdef USE_GTK
5938 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
5939 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
5940 But for a user it is a toolkit for X, and indeed, configure
5941 accepts --with-x-toolkit=gtk. */
5942 Fprovide (intern_c_string ("x-toolkit"), Qnil);
5943 Fprovide (intern_c_string ("gtk"), Qnil);
5944 Fprovide (intern_c_string ("move-toolbar"), Qnil);
5946 DEFVAR_LISP ("gtk-version-string", Vgtk_version_string,
5947 doc: /* Version info for GTK+. */);
5949 char gtk_version[40];
5950 g_snprintf (gtk_version, sizeof (gtk_version), "%u.%u.%u",
5951 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
5952 Vgtk_version_string = make_pure_string (gtk_version, strlen (gtk_version), strlen (gtk_version), 0);
5954 #endif /* USE_GTK */
5956 /* X window properties. */
5957 defsubr (&Sx_change_window_property);
5958 defsubr (&Sx_delete_window_property);
5959 defsubr (&Sx_window_property);
5961 defsubr (&Sxw_display_color_p);
5962 defsubr (&Sx_display_grayscale_p);
5963 defsubr (&Sxw_color_defined_p);
5964 defsubr (&Sxw_color_values);
5965 defsubr (&Sx_server_max_request_size);
5966 defsubr (&Sx_server_vendor);
5967 defsubr (&Sx_server_version);
5968 defsubr (&Sx_display_pixel_width);
5969 defsubr (&Sx_display_pixel_height);
5970 defsubr (&Sx_display_mm_width);
5971 defsubr (&Sx_display_mm_height);
5972 defsubr (&Sx_display_screens);
5973 defsubr (&Sx_display_planes);
5974 defsubr (&Sx_display_color_cells);
5975 defsubr (&Sx_display_visual_class);
5976 defsubr (&Sx_display_backing_store);
5977 defsubr (&Sx_display_save_under);
5978 defsubr (&Sx_wm_set_size_hint);
5979 defsubr (&Sx_create_frame);
5980 defsubr (&Sx_open_connection);
5981 defsubr (&Sx_close_connection);
5982 defsubr (&Sx_display_list);
5983 defsubr (&Sx_synchronize);
5984 defsubr (&Sx_focus_frame);
5985 defsubr (&Sx_backspace_delete_keys_p);
5987 /* Setting callback functions for fontset handler. */
5988 check_window_system_func = check_x;
5990 defsubr (&Sx_show_tip);
5991 defsubr (&Sx_hide_tip);
5992 tip_timer = Qnil;
5993 staticpro (&tip_timer);
5994 tip_frame = Qnil;
5995 staticpro (&tip_frame);
5997 last_show_tip_args = Qnil;
5998 staticpro (&last_show_tip_args);
6000 defsubr (&Sx_uses_old_gtk_dialog);
6001 #if defined (USE_MOTIF) || defined (USE_GTK)
6002 defsubr (&Sx_file_dialog);
6003 #endif
6005 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
6006 defsubr (&Sx_select_font);
6007 x_last_font_name = NULL;
6008 #endif
6011 #endif /* HAVE_X_WINDOWS */