Fix make_frame, introduce Vtemp_buffer_show_specifiers, cleanup doc-strings.
[emacs.git] / src / xfns.c
blob8417db7d6e5375b94633333afcb8968d8427a523
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 resize_frame_windows (f, FRAME_LINES (f), 0);
1232 /* If the menu bar height gets changed, the internal border below
1233 the top margin has to be cleared. Also, if the menu bar gets
1234 larger, the area for the added lines has to be cleared except for
1235 the first menu bar line that is to be drawn later. */
1236 if (nlines != olines)
1238 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1239 int width = FRAME_PIXEL_WIDTH (f);
1240 int y;
1242 /* height can be zero here. */
1243 if (height > 0 && width > 0)
1245 y = FRAME_TOP_MARGIN_HEIGHT (f);
1247 BLOCK_INPUT;
1248 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1249 0, y, width, height, False);
1250 UNBLOCK_INPUT;
1253 if (nlines > 1 && nlines > olines)
1255 y = (olines == 0 ? 1 : olines) * FRAME_LINE_HEIGHT (f);
1256 height = nlines * FRAME_LINE_HEIGHT (f) - y;
1258 BLOCK_INPUT;
1259 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1260 0, y, width, height, False);
1261 UNBLOCK_INPUT;
1264 if (nlines == 0 && WINDOWP (f->menu_bar_window))
1265 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1267 #endif /* not USE_X_TOOLKIT && not USE_GTK */
1268 adjust_glyphs (f);
1269 run_window_configuration_change_hook (f);
1273 /* Set the number of lines used for the tool bar of frame F to VALUE.
1274 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1275 is the old number of tool bar lines. This function changes the
1276 height of all windows on frame F to match the new tool bar height.
1277 The frame's height doesn't change. */
1279 void
1280 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1282 int delta, nlines, root_height;
1283 Lisp_Object root_window;
1285 /* Treat tool bars like menu bars. */
1286 if (FRAME_MINIBUF_ONLY_P (f))
1287 return;
1289 /* Use VALUE only if an integer >= 0. */
1290 if (INTEGERP (value) && XINT (value) >= 0)
1291 nlines = XFASTINT (value);
1292 else
1293 nlines = 0;
1295 #ifdef USE_GTK
1296 FRAME_TOOL_BAR_LINES (f) = 0;
1297 if (nlines)
1299 FRAME_EXTERNAL_TOOL_BAR (f) = 1;
1300 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1301 /* Make sure next redisplay shows the tool bar. */
1302 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1303 update_frame_tool_bar (f);
1305 else
1307 if (FRAME_EXTERNAL_TOOL_BAR (f))
1308 free_frame_tool_bar (f);
1309 FRAME_EXTERNAL_TOOL_BAR (f) = 0;
1312 return;
1313 #endif
1315 /* Make sure we redisplay all windows in this frame. */
1316 ++windows_or_buffers_changed;
1318 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1320 /* Don't resize the tool-bar to more than we have room for. */
1321 root_window = FRAME_ROOT_WINDOW (f);
1322 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1323 if (root_height - delta < 1)
1325 delta = root_height - 1;
1326 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1329 FRAME_TOOL_BAR_LINES (f) = nlines;
1330 resize_frame_windows (f, FRAME_LINES (f), 0);
1331 adjust_glyphs (f);
1333 /* We also have to make sure that the internal border at the top of
1334 the frame, below the menu bar or tool bar, is redrawn when the
1335 tool bar disappears. This is so because the internal border is
1336 below the tool bar if one is displayed, but is below the menu bar
1337 if there isn't a tool bar. The tool bar draws into the area
1338 below the menu bar. */
1339 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1341 clear_frame (f);
1342 clear_current_matrices (f);
1345 /* If the tool bar gets smaller, the internal border below it
1346 has to be cleared. It was formerly part of the display
1347 of the larger tool bar, and updating windows won't clear it. */
1348 if (delta < 0)
1350 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1351 int width = FRAME_PIXEL_WIDTH (f);
1352 int y = (FRAME_MENU_BAR_LINES (f) + nlines) * FRAME_LINE_HEIGHT (f);
1354 /* height can be zero here. */
1355 if (height > 0 && width > 0)
1357 BLOCK_INPUT;
1358 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1359 0, y, width, height, False);
1360 UNBLOCK_INPUT;
1363 if (WINDOWP (f->tool_bar_window))
1364 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1367 run_window_configuration_change_hook (f);
1372 /* Set the foreground color for scroll bars on frame F to VALUE.
1373 VALUE should be a string, a color name. If it isn't a string or
1374 isn't a valid color name, do nothing. OLDVAL is the old value of
1375 the frame parameter. */
1377 static void
1378 x_set_scroll_bar_foreground (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1380 unsigned long pixel;
1382 if (STRINGP (value))
1383 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1384 else
1385 pixel = -1;
1387 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1388 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1390 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1391 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1393 /* Remove all scroll bars because they have wrong colors. */
1394 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1395 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1396 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1397 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1399 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1400 redraw_frame (f);
1405 /* Set the background color for scroll bars on frame F to VALUE VALUE
1406 should be a string, a color name. If it isn't a string or isn't a
1407 valid color name, do nothing. OLDVAL is the old value of the frame
1408 parameter. */
1410 static void
1411 x_set_scroll_bar_background (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1413 unsigned long pixel;
1415 if (STRINGP (value))
1416 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1417 else
1418 pixel = -1;
1420 if (f->output_data.x->scroll_bar_background_pixel != -1)
1421 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1423 #ifdef USE_TOOLKIT_SCROLL_BARS
1424 /* Scrollbar shadow colors. */
1425 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1427 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1428 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1430 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1432 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1433 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1435 #endif /* USE_TOOLKIT_SCROLL_BARS */
1437 f->output_data.x->scroll_bar_background_pixel = pixel;
1438 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1440 /* Remove all scroll bars because they have wrong colors. */
1441 if (FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
1442 (*FRAME_TERMINAL (f)->condemn_scroll_bars_hook) (f);
1443 if (FRAME_TERMINAL (f)->judge_scroll_bars_hook)
1444 (*FRAME_TERMINAL (f)->judge_scroll_bars_hook) (f);
1446 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1447 redraw_frame (f);
1452 /* Encode Lisp string STRING as a text in a format appropriate for
1453 XICCC (X Inter Client Communication Conventions).
1455 This can call Lisp code, so callers must GCPRO.
1457 If STRING contains only ASCII characters, do no conversion and
1458 return the string data of STRING. Otherwise, encode the text by
1459 CODING_SYSTEM, and return a newly allocated memory area which
1460 should be freed by `xfree' by a caller.
1462 SELECTIONP non-zero means the string is being encoded for an X
1463 selection, so it is safe to run pre-write conversions (which
1464 may run Lisp code).
1466 Store the byte length of resulting text in *TEXT_BYTES.
1468 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1469 which means that the `encoding' of the result can be `STRING'.
1470 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1471 the result should be `COMPOUND_TEXT'. */
1473 static unsigned char *
1474 x_encode_text (Lisp_Object string, Lisp_Object coding_system, int selectionp, int *text_bytes, int *stringp, int *freep)
1476 int result = string_xstring_p (string);
1477 struct coding_system coding;
1479 if (result == 0)
1481 /* No multibyte character in OBJ. We need not encode it. */
1482 *text_bytes = SBYTES (string);
1483 *stringp = 1;
1484 *freep = 0;
1485 return SDATA (string);
1488 setup_coding_system (coding_system, &coding);
1489 coding.mode |= (CODING_MODE_SAFE_ENCODING | CODING_MODE_LAST_BLOCK);
1490 /* We suppress producing escape sequences for composition. */
1491 coding.common_flags &= ~CODING_ANNOTATION_MASK;
1492 coding.dst_bytes = SCHARS (string) * 2;
1493 coding.destination = (unsigned char *) xmalloc (coding.dst_bytes);
1494 encode_coding_object (&coding, string, 0, 0,
1495 SCHARS (string), SBYTES (string), Qnil);
1496 *text_bytes = coding.produced;
1497 *stringp = (result == 1 || !EQ (coding_system, Qcompound_text));
1498 *freep = 1;
1499 return coding.destination;
1503 /* Set the WM name to NAME for frame F. Also set the icon name.
1504 If the frame already has an icon name, use that, otherwise set the
1505 icon name to NAME. */
1507 static void
1508 x_set_name_internal (FRAME_PTR f, Lisp_Object name)
1510 if (FRAME_X_WINDOW (f))
1512 BLOCK_INPUT;
1514 XTextProperty text, icon;
1515 int bytes, stringp;
1516 int do_free_icon_value = 0, do_free_text_value = 0;
1517 Lisp_Object coding_system;
1518 Lisp_Object encoded_name;
1519 Lisp_Object encoded_icon_name;
1520 struct gcpro gcpro1;
1522 /* As ENCODE_UTF_8 may cause GC and relocation of string data,
1523 we use it before x_encode_text that may return string data. */
1524 GCPRO1 (name);
1525 encoded_name = ENCODE_UTF_8 (name);
1526 UNGCPRO;
1528 coding_system = Qcompound_text;
1529 /* Note: Encoding strategy
1531 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1532 text.encoding. But, there are non-internationalized window
1533 managers which don't support that encoding. So, if NAME
1534 contains only ASCII and 8859-1 characters, encode it by
1535 iso-latin-1, and use "STRING" in text.encoding hoping that
1536 such window managers at least analyze this format correctly,
1537 i.e. treat 8-bit bytes as 8859-1 characters.
1539 We may also be able to use "UTF8_STRING" in text.encoding
1540 in the future which can encode all Unicode characters.
1541 But, for the moment, there's no way to know that the
1542 current window manager supports it or not.
1544 Either way, we also set the _NET_WM_NAME and _NET_WM_ICON_NAME
1545 properties. Per the EWMH specification, those two properties
1546 are always UTF8_STRING. This matches what gtk_window_set_title()
1547 does in the USE_GTK case. */
1548 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1549 &do_free_text_value);
1550 text.encoding = (stringp ? XA_STRING
1551 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1552 text.format = 8;
1553 text.nitems = bytes;
1555 if (!STRINGP (f->icon_name))
1557 icon = text;
1558 encoded_icon_name = encoded_name;
1560 else
1562 /* See the above comment "Note: Encoding strategy". */
1563 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1564 &bytes, &stringp, &do_free_icon_value);
1565 icon.encoding = (stringp ? XA_STRING
1566 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1567 icon.format = 8;
1568 icon.nitems = bytes;
1570 encoded_icon_name = ENCODE_UTF_8 (f->icon_name);
1573 #ifdef USE_GTK
1574 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1575 SSDATA (encoded_name));
1576 #else /* not USE_GTK */
1577 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1578 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1579 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_name,
1580 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1581 8, PropModeReplace,
1582 SDATA (encoded_name),
1583 SBYTES (encoded_name));
1584 #endif /* not USE_GTK */
1586 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1587 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
1588 FRAME_X_DISPLAY_INFO (f)->Xatom_net_wm_icon_name,
1589 FRAME_X_DISPLAY_INFO (f)->Xatom_UTF8_STRING,
1590 8, PropModeReplace,
1591 SDATA (encoded_icon_name),
1592 SBYTES (encoded_icon_name));
1594 if (do_free_icon_value)
1595 xfree (icon.value);
1596 if (do_free_text_value)
1597 xfree (text.value);
1599 UNBLOCK_INPUT;
1603 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1604 x_id_name.
1606 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1607 name; if NAME is a string, set F's name to NAME and set
1608 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1610 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1611 suggesting a new name, which lisp code should override; if
1612 F->explicit_name is set, ignore the new name; otherwise, set it. */
1614 static void
1615 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1617 /* Make sure that requests from lisp code override requests from
1618 Emacs redisplay code. */
1619 if (explicit)
1621 /* If we're switching from explicit to implicit, we had better
1622 update the mode lines and thereby update the title. */
1623 if (f->explicit_name && NILP (name))
1624 update_mode_lines = 1;
1626 f->explicit_name = ! NILP (name);
1628 else if (f->explicit_name)
1629 return;
1631 /* If NAME is nil, set the name to the x_id_name. */
1632 if (NILP (name))
1634 /* Check for no change needed in this very common case
1635 before we do any consing. */
1636 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
1637 SSDATA (f->name)))
1638 return;
1639 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
1641 else
1642 CHECK_STRING (name);
1644 /* Don't change the name if it's already NAME. */
1645 if (! NILP (Fstring_equal (name, f->name)))
1646 return;
1648 f->name = name;
1650 /* For setting the frame title, the title parameter should override
1651 the name parameter. */
1652 if (! NILP (f->title))
1653 name = f->title;
1655 x_set_name_internal (f, name);
1658 /* This function should be called when the user's lisp code has
1659 specified a name for the frame; the name will override any set by the
1660 redisplay code. */
1661 static void
1662 x_explicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1664 x_set_name (f, arg, 1);
1667 /* This function should be called by Emacs redisplay code to set the
1668 name; names set this way will never override names set by the user's
1669 lisp code. */
1670 void
1671 x_implicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1673 x_set_name (f, arg, 0);
1676 /* Change the title of frame F to NAME.
1677 If NAME is nil, use the frame name as the title. */
1679 static void
1680 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1682 /* Don't change the title if it's already NAME. */
1683 if (EQ (name, f->title))
1684 return;
1686 update_mode_lines = 1;
1688 f->title = name;
1690 if (NILP (name))
1691 name = f->name;
1692 else
1693 CHECK_STRING (name);
1695 x_set_name_internal (f, name);
1698 void
1699 x_set_scroll_bar_default_width (struct frame *f)
1701 int wid = FRAME_COLUMN_WIDTH (f);
1702 #ifdef USE_TOOLKIT_SCROLL_BARS
1703 #ifdef USE_GTK
1704 int minw = xg_get_default_scrollbar_width (f);
1705 #else
1706 int minw = 16;
1707 #endif
1708 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1709 int width = minw + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
1710 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
1711 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = width;
1712 #else
1713 /* Make the actual width at least 14 pixels and a multiple of a
1714 character width. */
1715 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
1717 /* Use all of that space (aside from required margins) for the
1718 scroll bar. */
1719 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = 0;
1720 #endif
1724 /* Record in frame F the specified or default value according to ALIST
1725 of the parameter named PROP (a Lisp symbol). If no value is
1726 specified for PROP, look for an X default for XPROP on the frame
1727 named NAME. If that is not found either, use the value DEFLT. */
1729 static Lisp_Object
1730 x_default_scroll_bar_color_parameter (struct frame *f,
1731 Lisp_Object alist, Lisp_Object prop,
1732 const char *xprop, const char *xclass,
1733 int foreground_p)
1735 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1736 Lisp_Object tem;
1738 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1739 if (EQ (tem, Qunbound))
1741 #ifdef USE_TOOLKIT_SCROLL_BARS
1743 /* See if an X resource for the scroll bar color has been
1744 specified. */
1745 tem = display_x_get_resource (dpyinfo,
1746 build_string (foreground_p
1747 ? "foreground"
1748 : "background"),
1749 empty_unibyte_string,
1750 build_string ("verticalScrollBar"),
1751 empty_unibyte_string);
1752 if (!STRINGP (tem))
1754 /* If nothing has been specified, scroll bars will use a
1755 toolkit-dependent default. Because these defaults are
1756 difficult to get at without actually creating a scroll
1757 bar, use nil to indicate that no color has been
1758 specified. */
1759 tem = Qnil;
1762 #else /* not USE_TOOLKIT_SCROLL_BARS */
1764 tem = Qnil;
1766 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1769 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
1770 return tem;
1776 #ifdef USE_X_TOOLKIT
1778 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1779 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1780 already be present because of the toolkit (Motif adds some of them,
1781 for example, but Xt doesn't). */
1783 static void
1784 hack_wm_protocols (FRAME_PTR f, Widget widget)
1786 Display *dpy = XtDisplay (widget);
1787 Window w = XtWindow (widget);
1788 int need_delete = 1;
1789 int need_focus = 1;
1790 int need_save = 1;
1792 BLOCK_INPUT;
1794 Atom type;
1795 unsigned char *catoms;
1796 int format = 0;
1797 unsigned long nitems = 0;
1798 unsigned long bytes_after;
1800 if ((XGetWindowProperty (dpy, w,
1801 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1802 (long)0, (long)100, False, XA_ATOM,
1803 &type, &format, &nitems, &bytes_after,
1804 &catoms)
1805 == Success)
1806 && format == 32 && type == XA_ATOM)
1808 Atom *atoms = (Atom *) catoms;
1809 while (nitems > 0)
1811 nitems--;
1812 if (atoms[nitems]
1813 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1814 need_delete = 0;
1815 else if (atoms[nitems]
1816 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1817 need_focus = 0;
1818 else if (atoms[nitems]
1819 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1820 need_save = 0;
1823 if (catoms)
1824 XFree (catoms);
1827 Atom props [10];
1828 int count = 0;
1829 if (need_delete)
1830 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1831 if (need_focus)
1832 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1833 if (need_save)
1834 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1835 if (count)
1836 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1837 XA_ATOM, 32, PropModeAppend,
1838 (unsigned char *) props, count);
1840 UNBLOCK_INPUT;
1842 #endif
1846 /* Support routines for XIC (X Input Context). */
1848 #ifdef HAVE_X_I18N
1850 static XFontSet xic_create_xfontset (struct frame *);
1851 static XIMStyle best_xim_style (XIMStyles *, XIMStyles *);
1854 /* Supported XIM styles, ordered by preference. */
1856 static XIMStyle supported_xim_styles[] =
1858 XIMPreeditPosition | XIMStatusArea,
1859 XIMPreeditPosition | XIMStatusNothing,
1860 XIMPreeditPosition | XIMStatusNone,
1861 XIMPreeditNothing | XIMStatusArea,
1862 XIMPreeditNothing | XIMStatusNothing,
1863 XIMPreeditNothing | XIMStatusNone,
1864 XIMPreeditNone | XIMStatusArea,
1865 XIMPreeditNone | XIMStatusNothing,
1866 XIMPreeditNone | XIMStatusNone,
1871 #if defined HAVE_X_WINDOWS && defined USE_X_TOOLKIT
1872 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1874 static const char xic_defaut_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1876 /* Create an Xt fontset spec from the name of a base font.
1877 If `motif' is True use the Motif syntax. */
1878 char *
1879 xic_create_fontsetname (const char *base_fontname, int motif)
1881 const char *sep = motif ? ";" : ",";
1882 char *fontsetname;
1884 /* Make a fontset name from the base font name. */
1885 if (xic_defaut_fontset == base_fontname)
1886 { /* There is no base font name, use the default. */
1887 int len = strlen (base_fontname) + 2;
1888 fontsetname = xmalloc (len);
1889 memset (fontsetname, 0, len);
1890 strcpy (fontsetname, base_fontname);
1892 else
1894 /* Make a fontset name from the base font name.
1895 The font set will be made of the following elements:
1896 - the base font.
1897 - the base font where the charset spec is replaced by -*-*.
1898 - the same but with the family also replaced with -*-*-. */
1899 const char *p = base_fontname;
1900 int i;
1902 for (i = 0; *p; p++)
1903 if (*p == '-') i++;
1904 if (i != 14)
1905 { /* As the font name doesn't conform to XLFD, we can't
1906 modify it to generalize it to allcs and allfamilies.
1907 Use the specified font plus the default. */
1908 int len = strlen (base_fontname) + strlen (xic_defaut_fontset) + 3;
1909 fontsetname = xmalloc (len);
1910 memset (fontsetname, 0, len);
1911 strcpy (fontsetname, base_fontname);
1912 strcat (fontsetname, sep);
1913 strcat (fontsetname, xic_defaut_fontset);
1915 else
1917 int len;
1918 const char *p1 = NULL, *p2 = NULL, *p3 = NULL;
1919 char *font_allcs = NULL;
1920 char *font_allfamilies = NULL;
1921 char *font_all = NULL;
1922 const char *allcs = "*-*-*-*-*-*-*";
1923 const char *allfamilies = "-*-*-";
1924 const char *all = "*-*-*-*-";
1925 char *base;
1927 for (i = 0, p = base_fontname; i < 8; p++)
1929 if (*p == '-')
1931 i++;
1932 if (i == 3)
1933 p1 = p + 1;
1934 else if (i == 7)
1935 p2 = p + 1;
1936 else if (i == 6)
1937 p3 = p + 1;
1940 /* If base_fontname specifies ADSTYLE, make it a
1941 wildcard. */
1942 if (*p3 != '*')
1944 int diff = (p2 - p3) - 2;
1946 base = alloca (strlen (base_fontname) + 1);
1947 memcpy (base, base_fontname, p3 - base_fontname);
1948 base[p3 - base_fontname] = '*';
1949 base[(p3 - base_fontname) + 1] = '-';
1950 strcpy (base + (p3 - base_fontname) + 2, p2);
1951 p = base + (p - base_fontname) - diff;
1952 p1 = base + (p1 - base_fontname);
1953 p2 = base + (p2 - base_fontname) - diff;
1954 base_fontname = base;
1957 /* Build the font spec that matches all charsets. */
1958 len = p - base_fontname + strlen (allcs) + 1;
1959 font_allcs = (char *) alloca (len);
1960 memset (font_allcs, 0, len);
1961 memcpy (font_allcs, base_fontname, p - base_fontname);
1962 strcat (font_allcs, allcs);
1964 /* Build the font spec that matches all families and
1965 add-styles. */
1966 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
1967 font_allfamilies = (char *) alloca (len);
1968 memset (font_allfamilies, 0, len);
1969 strcpy (font_allfamilies, allfamilies);
1970 memcpy (font_allfamilies + strlen (allfamilies), p1, p - p1);
1971 strcat (font_allfamilies, allcs);
1973 /* Build the font spec that matches all. */
1974 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
1975 font_all = (char *) alloca (len);
1976 memset (font_all, 0, len);
1977 strcpy (font_all, allfamilies);
1978 strcat (font_all, all);
1979 memcpy (font_all + strlen (all) + strlen (allfamilies), p2, p - p2);
1980 strcat (font_all, allcs);
1982 /* Build the actual font set name. */
1983 len = strlen (base_fontname) + strlen (font_allcs)
1984 + strlen (font_allfamilies) + strlen (font_all) + 5;
1985 fontsetname = xmalloc (len);
1986 memset (fontsetname, 0, len);
1987 strcpy (fontsetname, base_fontname);
1988 strcat (fontsetname, sep);
1989 strcat (fontsetname, font_allcs);
1990 strcat (fontsetname, sep);
1991 strcat (fontsetname, font_allfamilies);
1992 strcat (fontsetname, sep);
1993 strcat (fontsetname, font_all);
1996 if (motif)
1997 strcat (fontsetname, ":");
1998 return fontsetname;
2000 #endif /* HAVE_X_WINDOWS && USE_X_TOOLKIT */
2002 #ifdef DEBUG_XIC_FONTSET
2003 static void
2004 print_fontset_result (xfs, name, missing_list, missing_count)
2005 XFontSet xfs;
2006 char *name;
2007 char **missing_list;
2008 int missing_count;
2010 if (xfs)
2011 fprintf (stderr, "XIC Fontset created: %s\n", name);
2012 else
2014 fprintf (stderr, "XIC Fontset failed: %s\n", name);
2015 while (missing_count-- > 0)
2017 fprintf (stderr, " missing: %s\n", *missing_list);
2018 missing_list++;
2023 #endif
2025 static XFontSet
2026 xic_create_xfontset (struct frame *f)
2028 XFontSet xfs = NULL;
2029 struct font *font = FRAME_FONT (f);
2030 int pixel_size = font->pixel_size;
2031 Lisp_Object rest, frame;
2033 /* See if there is another frame already using same fontset. */
2034 FOR_EACH_FRAME (rest, frame)
2036 struct frame *cf = XFRAME (frame);
2038 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2039 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2040 && FRAME_FONT (f)
2041 && FRAME_FONT (f)->pixel_size == pixel_size)
2043 xfs = FRAME_XIC_FONTSET (cf);
2044 break;
2048 if (! xfs)
2050 char buf[256];
2051 char **missing_list;
2052 int missing_count;
2053 char *def_string;
2054 const char *xlfd_format = "-*-*-medium-r-normal--%d-*-*-*-*-*";
2056 sprintf (buf, xlfd_format, pixel_size);
2057 missing_list = NULL;
2058 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2059 &missing_list, &missing_count, &def_string);
2060 #ifdef DEBUG_XIC_FONTSET
2061 print_fontset_result (xfs, buf, missing_list, missing_count);
2062 #endif
2063 if (missing_list)
2064 XFreeStringList (missing_list);
2065 if (! xfs)
2067 /* List of pixel sizes most likely available. Find one that
2068 is closest to pixel_size. */
2069 int sizes[] = {0, 8, 10, 11, 12, 14, 17, 18, 20, 24, 26, 34, 0};
2070 int *smaller, *larger;
2072 for (smaller = sizes; smaller[1]; smaller++)
2073 if (smaller[1] >= pixel_size)
2074 break;
2075 larger = smaller + 1;
2076 if (*larger == pixel_size)
2077 larger++;
2078 while (*smaller || *larger)
2080 int this_size;
2082 if (! *larger)
2083 this_size = *smaller--;
2084 else if (! *smaller)
2085 this_size = *larger++;
2086 else if (pixel_size - *smaller < *larger - pixel_size)
2087 this_size = *smaller--;
2088 else
2089 this_size = *larger++;
2090 sprintf (buf, xlfd_format, this_size);
2091 missing_list = NULL;
2092 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), buf,
2093 &missing_list, &missing_count, &def_string);
2094 #ifdef DEBUG_XIC_FONTSET
2095 print_fontset_result (xfs, buf, missing_list, missing_count);
2096 #endif
2097 if (missing_list)
2098 XFreeStringList (missing_list);
2099 if (xfs)
2100 break;
2103 if (! xfs)
2105 const char *last_resort = "-*-*-*-r-normal--*-*-*-*-*-*";
2107 missing_list = NULL;
2108 xfs = XCreateFontSet (FRAME_X_DISPLAY (f), last_resort,
2109 &missing_list, &missing_count, &def_string);
2110 #ifdef DEBUG_XIC_FONTSET
2111 print_fontset_result (xfs, last_resort, missing_list, missing_count);
2112 #endif
2113 if (missing_list)
2114 XFreeStringList (missing_list);
2119 return xfs;
2122 /* Free the X fontset of frame F if it is the last frame using it. */
2124 void
2125 xic_free_xfontset (struct frame *f)
2127 Lisp_Object rest, frame;
2128 int shared_p = 0;
2130 if (!FRAME_XIC_FONTSET (f))
2131 return;
2133 /* See if there is another frame sharing the same fontset. */
2134 FOR_EACH_FRAME (rest, frame)
2136 struct frame *cf = XFRAME (frame);
2137 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2138 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2139 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2141 shared_p = 1;
2142 break;
2146 if (!shared_p)
2147 /* The fontset is not used anymore. It is safe to free it. */
2148 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2150 if (FRAME_XIC_BASE_FONTNAME (f))
2151 xfree (FRAME_XIC_BASE_FONTNAME (f));
2152 FRAME_XIC_BASE_FONTNAME (f) = NULL;
2153 FRAME_XIC_FONTSET (f) = NULL;
2157 /* Value is the best input style, given user preferences USER (already
2158 checked to be supported by Emacs), and styles supported by the
2159 input method XIM. */
2161 static XIMStyle
2162 best_xim_style (XIMStyles *user, XIMStyles *xim)
2164 int i, j;
2166 for (i = 0; i < user->count_styles; ++i)
2167 for (j = 0; j < xim->count_styles; ++j)
2168 if (user->supported_styles[i] == xim->supported_styles[j])
2169 return user->supported_styles[i];
2171 /* Return the default style. */
2172 return XIMPreeditNothing | XIMStatusNothing;
2175 /* Create XIC for frame F. */
2177 static XIMStyle xic_style;
2179 void
2180 create_frame_xic (struct frame *f)
2182 XIM xim;
2183 XIC xic = NULL;
2184 XFontSet xfs = NULL;
2186 if (FRAME_XIC (f))
2187 return;
2189 /* Create X fontset. */
2190 xfs = xic_create_xfontset (f);
2191 xim = FRAME_X_XIM (f);
2192 if (xim)
2194 XRectangle s_area;
2195 XPoint spot;
2196 XVaNestedList preedit_attr;
2197 XVaNestedList status_attr;
2199 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2200 spot.x = 0; spot.y = 1;
2202 /* Determine XIC style. */
2203 if (xic_style == 0)
2205 XIMStyles supported_list;
2206 supported_list.count_styles = (sizeof supported_xim_styles
2207 / sizeof supported_xim_styles[0]);
2208 supported_list.supported_styles = supported_xim_styles;
2209 xic_style = best_xim_style (&supported_list,
2210 FRAME_X_XIM_STYLES (f));
2213 preedit_attr = XVaCreateNestedList (0,
2214 XNFontSet, xfs,
2215 XNForeground,
2216 FRAME_FOREGROUND_PIXEL (f),
2217 XNBackground,
2218 FRAME_BACKGROUND_PIXEL (f),
2219 (xic_style & XIMPreeditPosition
2220 ? XNSpotLocation
2221 : NULL),
2222 &spot,
2223 NULL);
2224 status_attr = XVaCreateNestedList (0,
2225 XNArea,
2226 &s_area,
2227 XNFontSet,
2228 xfs,
2229 XNForeground,
2230 FRAME_FOREGROUND_PIXEL (f),
2231 XNBackground,
2232 FRAME_BACKGROUND_PIXEL (f),
2233 NULL);
2235 xic = XCreateIC (xim,
2236 XNInputStyle, xic_style,
2237 XNClientWindow, FRAME_X_WINDOW (f),
2238 XNFocusWindow, FRAME_X_WINDOW (f),
2239 XNStatusAttributes, status_attr,
2240 XNPreeditAttributes, preedit_attr,
2241 NULL);
2242 XFree (preedit_attr);
2243 XFree (status_attr);
2246 FRAME_XIC (f) = xic;
2247 FRAME_XIC_STYLE (f) = xic_style;
2248 FRAME_XIC_FONTSET (f) = xfs;
2252 /* Destroy XIC and free XIC fontset of frame F, if any. */
2254 void
2255 free_frame_xic (struct frame *f)
2257 if (FRAME_XIC (f) == NULL)
2258 return;
2260 XDestroyIC (FRAME_XIC (f));
2261 xic_free_xfontset (f);
2263 FRAME_XIC (f) = NULL;
2267 /* Place preedit area for XIC of window W's frame to specified
2268 pixel position X/Y. X and Y are relative to window W. */
2270 void
2271 xic_set_preeditarea (struct window *w, int x, int y)
2273 struct frame *f = XFRAME (w->frame);
2274 XVaNestedList attr;
2275 XPoint spot;
2277 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2278 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2279 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2280 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2281 XFree (attr);
2285 /* Place status area for XIC in bottom right corner of frame F.. */
2287 void
2288 xic_set_statusarea (struct frame *f)
2290 XIC xic = FRAME_XIC (f);
2291 XVaNestedList attr;
2292 XRectangle area;
2293 XRectangle *needed;
2295 /* Negotiate geometry of status area. If input method has existing
2296 status area, use its current size. */
2297 area.x = area.y = area.width = area.height = 0;
2298 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2299 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2300 XFree (attr);
2302 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2303 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2304 XFree (attr);
2306 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2308 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2309 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2310 XFree (attr);
2313 area.width = needed->width;
2314 area.height = needed->height;
2315 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2316 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2317 - FRAME_MENUBAR_HEIGHT (f)
2318 - FRAME_TOOLBAR_TOP_HEIGHT (f)
2319 - FRAME_INTERNAL_BORDER_WIDTH (f));
2320 XFree (needed);
2322 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2323 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2324 XFree (attr);
2328 /* Set X fontset for XIC of frame F, using base font name
2329 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2331 void
2332 xic_set_xfontset (struct frame *f, const char *base_fontname)
2334 XVaNestedList attr;
2335 XFontSet xfs;
2337 xic_free_xfontset (f);
2339 xfs = xic_create_xfontset (f);
2341 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2342 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2343 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2344 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2345 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2346 XFree (attr);
2348 FRAME_XIC_FONTSET (f) = xfs;
2351 #endif /* HAVE_X_I18N */
2355 #ifdef USE_X_TOOLKIT
2357 /* Create and set up the X widget for frame F. */
2359 static void
2360 x_window (struct frame *f, long window_prompting, int minibuffer_only)
2362 XClassHint class_hints;
2363 XSetWindowAttributes attributes;
2364 unsigned long attribute_mask;
2365 Widget shell_widget;
2366 Widget pane_widget;
2367 Widget frame_widget;
2368 Arg al [25];
2369 int ac;
2371 BLOCK_INPUT;
2373 /* Use the resource name as the top-level widget name
2374 for looking up resources. Make a non-Lisp copy
2375 for the window manager, so GC relocation won't bother it.
2377 Elsewhere we specify the window name for the window manager. */
2380 char *str = SSDATA (Vx_resource_name);
2381 f->namebuf = (char *) xmalloc (strlen (str) + 1);
2382 strcpy (f->namebuf, str);
2385 ac = 0;
2386 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2387 XtSetArg (al[ac], XtNinput, 1); ac++;
2388 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2389 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2390 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2391 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2392 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2393 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2394 applicationShellWidgetClass,
2395 FRAME_X_DISPLAY (f), al, ac);
2397 f->output_data.x->widget = shell_widget;
2398 /* maybe_set_screen_title_format (shell_widget); */
2400 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2401 (widget_value *) NULL,
2402 shell_widget, False,
2403 (lw_callback) NULL,
2404 (lw_callback) NULL,
2405 (lw_callback) NULL,
2406 (lw_callback) NULL);
2408 ac = 0;
2409 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2410 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2411 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2412 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2413 XtSetValues (pane_widget, al, ac);
2414 f->output_data.x->column_widget = pane_widget;
2416 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2417 the emacs screen when changing menubar. This reduces flickering. */
2419 ac = 0;
2420 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2421 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2422 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2423 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2424 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2425 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2426 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2427 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2428 XtSetArg (al[ac], XtNborderWidth, 0); ac++;
2429 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2430 al, ac);
2432 f->output_data.x->edit_widget = frame_widget;
2434 XtManageChild (frame_widget);
2436 /* Do some needed geometry management. */
2438 int len;
2439 char *tem, shell_position[32];
2440 Arg gal[10];
2441 int gac = 0;
2442 int extra_borders = 0;
2443 int menubar_size
2444 = (f->output_data.x->menubar_widget
2445 ? (f->output_data.x->menubar_widget->core.height
2446 + f->output_data.x->menubar_widget->core.border_width)
2447 : 0);
2449 #if 0 /* Experimentally, we now get the right results
2450 for -geometry -0-0 without this. 24 Aug 96, rms. */
2451 if (FRAME_EXTERNAL_MENU_BAR (f))
2453 Dimension ibw = 0;
2454 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2455 menubar_size += ibw;
2457 #endif
2459 f->output_data.x->menubar_height = menubar_size;
2461 #ifndef USE_LUCID
2462 /* Motif seems to need this amount added to the sizes
2463 specified for the shell widget. The Athena/Lucid widgets don't.
2464 Both conclusions reached experimentally. -- rms. */
2465 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2466 &extra_borders, NULL);
2467 extra_borders *= 2;
2468 #endif
2470 /* Convert our geometry parameters into a geometry string
2471 and specify it.
2472 Note that we do not specify here whether the position
2473 is a user-specified or program-specified one.
2474 We pass that information later, in x_wm_set_size_hints. */
2476 int left = f->left_pos;
2477 int xneg = window_prompting & XNegative;
2478 int top = f->top_pos;
2479 int yneg = window_prompting & YNegative;
2480 if (xneg)
2481 left = -left;
2482 if (yneg)
2483 top = -top;
2485 if (window_prompting & USPosition)
2486 sprintf (shell_position, "=%dx%d%c%d%c%d",
2487 FRAME_PIXEL_WIDTH (f) + extra_borders,
2488 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2489 (xneg ? '-' : '+'), left,
2490 (yneg ? '-' : '+'), top);
2491 else
2493 sprintf (shell_position, "=%dx%d",
2494 FRAME_PIXEL_WIDTH (f) + extra_borders,
2495 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2497 /* Setting x and y when the position is not specified in
2498 the geometry string will set program position in the WM hints.
2499 If Emacs had just one program position, we could set it in
2500 fallback resources, but since each make-frame call can specify
2501 different program positions, this is easier. */
2502 XtSetArg (gal[gac], XtNx, left); gac++;
2503 XtSetArg (gal[gac], XtNy, top); gac++;
2507 len = strlen (shell_position) + 1;
2508 /* We don't free this because we don't know whether
2509 it is safe to free it while the frame exists.
2510 It isn't worth the trouble of arranging to free it
2511 when the frame is deleted. */
2512 tem = (char *) xmalloc (len);
2513 strncpy (tem, shell_position, len);
2514 XtSetArg (gal[gac], XtNgeometry, tem); gac++;
2515 XtSetValues (shell_widget, gal, gac);
2518 XtManageChild (pane_widget);
2519 XtRealizeWidget (shell_widget);
2521 if (FRAME_X_EMBEDDED_P (f))
2522 XReparentWindow (FRAME_X_DISPLAY (f), XtWindow (shell_widget),
2523 f->output_data.x->parent_desc, 0, 0);
2525 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2527 validate_x_resource_name ();
2529 class_hints.res_name = SSDATA (Vx_resource_name);
2530 class_hints.res_class = SSDATA (Vx_resource_class);
2531 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2533 #ifdef HAVE_X_I18N
2534 FRAME_XIC (f) = NULL;
2535 if (use_xim)
2536 create_frame_xic (f);
2537 #endif
2539 f->output_data.x->wm_hints.input = True;
2540 f->output_data.x->wm_hints.flags |= InputHint;
2541 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2542 &f->output_data.x->wm_hints);
2544 hack_wm_protocols (f, shell_widget);
2546 #ifdef HACK_EDITRES
2547 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2548 #endif
2550 /* Do a stupid property change to force the server to generate a
2551 PropertyNotify event so that the event_stream server timestamp will
2552 be initialized to something relevant to the time we created the window.
2554 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2555 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
2556 XA_ATOM, 32, PropModeAppend,
2557 (unsigned char*) NULL, 0);
2559 /* Make all the standard events reach the Emacs frame. */
2560 attributes.event_mask = STANDARD_EVENT_SET;
2562 #ifdef HAVE_X_I18N
2563 if (FRAME_XIC (f))
2565 /* XIM server might require some X events. */
2566 unsigned long fevent = NoEventMask;
2567 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2568 attributes.event_mask |= fevent;
2570 #endif /* HAVE_X_I18N */
2572 attribute_mask = CWEventMask;
2573 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2574 attribute_mask, &attributes);
2576 XtMapWidget (frame_widget);
2578 /* x_set_name normally ignores requests to set the name if the
2579 requested name is the same as the current name. This is the one
2580 place where that assumption isn't correct; f->name is set, but
2581 the X server hasn't been told. */
2583 Lisp_Object name;
2584 int explicit = f->explicit_name;
2586 f->explicit_name = 0;
2587 name = f->name;
2588 f->name = Qnil;
2589 x_set_name (f, name, explicit);
2592 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2593 f->output_data.x->current_cursor
2594 = f->output_data.x->text_cursor);
2596 UNBLOCK_INPUT;
2598 /* This is a no-op, except under Motif. Make sure main areas are
2599 set to something reasonable, in case we get an error later. */
2600 lw_set_main_areas (pane_widget, 0, frame_widget);
2603 #else /* not USE_X_TOOLKIT */
2604 #ifdef USE_GTK
2605 static void
2606 x_window (FRAME_PTR f)
2608 if (! xg_create_frame_widgets (f))
2609 error ("Unable to create window");
2611 #ifdef HAVE_X_I18N
2612 FRAME_XIC (f) = NULL;
2613 if (use_xim)
2615 BLOCK_INPUT;
2616 create_frame_xic (f);
2617 if (FRAME_XIC (f))
2619 /* XIM server might require some X events. */
2620 unsigned long fevent = NoEventMask;
2621 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2623 if (fevent != NoEventMask)
2625 XSetWindowAttributes attributes;
2626 XWindowAttributes wattr;
2627 unsigned long attribute_mask;
2629 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2630 &wattr);
2631 attributes.event_mask = wattr.your_event_mask | fevent;
2632 attribute_mask = CWEventMask;
2633 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2634 attribute_mask, &attributes);
2637 UNBLOCK_INPUT;
2639 #endif
2642 #else /*! USE_GTK */
2643 /* Create and set up the X window for frame F. */
2645 static void
2646 x_window (struct frame *f)
2648 XClassHint class_hints;
2649 XSetWindowAttributes attributes;
2650 unsigned long attribute_mask;
2652 attributes.background_pixel = FRAME_BACKGROUND_PIXEL (f);
2653 attributes.border_pixel = f->output_data.x->border_pixel;
2654 attributes.bit_gravity = StaticGravity;
2655 attributes.backing_store = NotUseful;
2656 attributes.save_under = True;
2657 attributes.event_mask = STANDARD_EVENT_SET;
2658 attributes.colormap = FRAME_X_COLORMAP (f);
2659 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2660 | CWColormap);
2662 BLOCK_INPUT;
2663 FRAME_X_WINDOW (f)
2664 = XCreateWindow (FRAME_X_DISPLAY (f),
2665 f->output_data.x->parent_desc,
2666 f->left_pos,
2667 f->top_pos,
2668 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2669 f->border_width,
2670 CopyFromParent, /* depth */
2671 InputOutput, /* class */
2672 FRAME_X_VISUAL (f),
2673 attribute_mask, &attributes);
2675 #ifdef HAVE_X_I18N
2676 if (use_xim)
2678 create_frame_xic (f);
2679 if (FRAME_XIC (f))
2681 /* XIM server might require some X events. */
2682 unsigned long fevent = NoEventMask;
2683 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2684 attributes.event_mask |= fevent;
2685 attribute_mask = CWEventMask;
2686 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2687 attribute_mask, &attributes);
2690 #endif /* HAVE_X_I18N */
2692 validate_x_resource_name ();
2694 class_hints.res_name = SSDATA (Vx_resource_name);
2695 class_hints.res_class = SSDATA (Vx_resource_class);
2696 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2698 /* The menubar is part of the ordinary display;
2699 it does not count in addition to the height of the window. */
2700 f->output_data.x->menubar_height = 0;
2702 /* This indicates that we use the "Passive Input" input model.
2703 Unless we do this, we don't get the Focus{In,Out} events that we
2704 need to draw the cursor correctly. Accursed bureaucrats.
2705 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2707 f->output_data.x->wm_hints.input = True;
2708 f->output_data.x->wm_hints.flags |= InputHint;
2709 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2710 &f->output_data.x->wm_hints);
2711 f->output_data.x->wm_hints.icon_pixmap = None;
2713 /* Request "save yourself" and "delete window" commands from wm. */
2715 Atom protocols[2];
2716 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2717 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2718 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2721 /* x_set_name normally ignores requests to set the name if the
2722 requested name is the same as the current name. This is the one
2723 place where that assumption isn't correct; f->name is set, but
2724 the X server hasn't been told. */
2726 Lisp_Object name;
2727 int explicit = f->explicit_name;
2729 f->explicit_name = 0;
2730 name = f->name;
2731 f->name = Qnil;
2732 x_set_name (f, name, explicit);
2735 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2736 f->output_data.x->current_cursor
2737 = f->output_data.x->text_cursor);
2739 UNBLOCK_INPUT;
2741 if (FRAME_X_WINDOW (f) == 0)
2742 error ("Unable to create window");
2745 #endif /* not USE_GTK */
2746 #endif /* not USE_X_TOOLKIT */
2748 /* Verify that the icon position args for this window are valid. */
2750 static void
2751 x_icon_verify (struct frame *f, Lisp_Object parms)
2753 Lisp_Object icon_x, icon_y;
2755 /* Set the position of the icon. Note that twm groups all
2756 icons in an icon window. */
2757 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2758 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2759 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2761 CHECK_NUMBER (icon_x);
2762 CHECK_NUMBER (icon_y);
2764 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2765 error ("Both left and top icon corners of icon must be specified");
2768 /* Handle the icon stuff for this window. Perhaps later we might
2769 want an x_set_icon_position which can be called interactively as
2770 well. */
2772 static void
2773 x_icon (struct frame *f, Lisp_Object parms)
2775 Lisp_Object icon_x, icon_y;
2776 #if 0
2777 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2778 #endif
2780 /* Set the position of the icon. Note that twm groups all
2781 icons in an icon window. */
2782 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2783 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2784 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2786 CHECK_NUMBER (icon_x);
2787 CHECK_NUMBER (icon_y);
2789 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2790 error ("Both left and top icon corners of icon must be specified");
2792 BLOCK_INPUT;
2794 if (! EQ (icon_x, Qunbound))
2795 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2797 #if 0 /* x_get_arg removes the visibility parameter as a side effect,
2798 but x_create_frame still needs it. */
2799 /* Start up iconic or window? */
2800 x_wm_set_window_state
2801 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2802 Qicon)
2803 ? IconicState
2804 : NormalState));
2805 #endif
2807 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
2808 ? f->icon_name
2809 : f->name)));
2811 UNBLOCK_INPUT;
2814 /* Make the GCs needed for this window, setting the
2815 background, border and mouse colors; also create the
2816 mouse cursor and the gray border tile. */
2818 static void
2819 x_make_gc (struct frame *f)
2821 XGCValues gc_values;
2823 BLOCK_INPUT;
2825 /* Create the GCs of this frame.
2826 Note that many default values are used. */
2828 gc_values.foreground = FRAME_FOREGROUND_PIXEL (f);
2829 gc_values.background = FRAME_BACKGROUND_PIXEL (f);
2830 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2831 f->output_data.x->normal_gc
2832 = XCreateGC (FRAME_X_DISPLAY (f),
2833 FRAME_X_WINDOW (f),
2834 GCLineWidth | GCForeground | GCBackground,
2835 &gc_values);
2837 /* Reverse video style. */
2838 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2839 gc_values.background = FRAME_FOREGROUND_PIXEL (f);
2840 f->output_data.x->reverse_gc
2841 = XCreateGC (FRAME_X_DISPLAY (f),
2842 FRAME_X_WINDOW (f),
2843 GCForeground | GCBackground | GCLineWidth,
2844 &gc_values);
2846 /* Cursor has cursor-color background, background-color foreground. */
2847 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
2848 gc_values.background = f->output_data.x->cursor_pixel;
2849 gc_values.fill_style = FillOpaqueStippled;
2850 f->output_data.x->cursor_gc
2851 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2852 (GCForeground | GCBackground
2853 | GCFillStyle | GCLineWidth),
2854 &gc_values);
2856 /* Reliefs. */
2857 f->output_data.x->white_relief.gc = 0;
2858 f->output_data.x->black_relief.gc = 0;
2860 /* Create the gray border tile used when the pointer is not in
2861 the frame. Since this depends on the frame's pixel values,
2862 this must be done on a per-frame basis. */
2863 f->output_data.x->border_tile
2864 = (XCreatePixmapFromBitmapData
2865 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
2866 gray_bits, gray_width, gray_height,
2867 FRAME_FOREGROUND_PIXEL (f),
2868 FRAME_BACKGROUND_PIXEL (f),
2869 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2871 UNBLOCK_INPUT;
2875 /* Free what was allocated in x_make_gc. */
2877 void
2878 x_free_gcs (struct frame *f)
2880 Display *dpy = FRAME_X_DISPLAY (f);
2882 BLOCK_INPUT;
2884 if (f->output_data.x->normal_gc)
2886 XFreeGC (dpy, f->output_data.x->normal_gc);
2887 f->output_data.x->normal_gc = 0;
2890 if (f->output_data.x->reverse_gc)
2892 XFreeGC (dpy, f->output_data.x->reverse_gc);
2893 f->output_data.x->reverse_gc = 0;
2896 if (f->output_data.x->cursor_gc)
2898 XFreeGC (dpy, f->output_data.x->cursor_gc);
2899 f->output_data.x->cursor_gc = 0;
2902 if (f->output_data.x->border_tile)
2904 XFreePixmap (dpy, f->output_data.x->border_tile);
2905 f->output_data.x->border_tile = 0;
2908 UNBLOCK_INPUT;
2912 /* Handler for signals raised during x_create_frame and
2913 x_create_top_frame. FRAME is the frame which is partially
2914 constructed. */
2916 static Lisp_Object
2917 unwind_create_frame (Lisp_Object frame)
2919 struct frame *f = XFRAME (frame);
2921 /* If frame is already dead, nothing to do. This can happen if the
2922 display is disconnected after the frame has become official, but
2923 before x_create_frame removes the unwind protect. */
2924 if (!FRAME_LIVE_P (f))
2925 return Qnil;
2927 /* If frame is ``official'', nothing to do. */
2928 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
2930 #if GLYPH_DEBUG
2931 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2932 #endif
2934 x_free_frame_resources (f);
2936 #if GLYPH_DEBUG
2937 /* Check that reference counts are indeed correct. */
2938 xassert (dpyinfo->reference_count == dpyinfo_refcount);
2939 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
2940 #endif
2941 return Qt;
2944 return Qnil;
2948 static void
2949 x_default_font_parameter (struct frame *f, Lisp_Object parms)
2951 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2952 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
2953 RES_TYPE_STRING);
2954 Lisp_Object font = Qnil;
2955 if (EQ (font_param, Qunbound))
2956 font_param = Qnil;
2958 if (NILP (font_param))
2960 /* System font should take precedendce over X resources. We suggest this
2961 regardless of font-use-system-font because .emacs may not have been
2962 read yet. */
2963 const char *system_font = xsettings_get_system_font ();
2964 if (system_font)
2966 char *name = xstrdup (system_font);
2967 font = font_open_by_name (f, name);
2968 xfree (name);
2972 if (NILP (font))
2973 font = !NILP (font_param) ? font_param
2974 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
2976 if (! FONTP (font) && ! STRINGP (font))
2978 const char *names[]
2980 #ifdef HAVE_XFT
2981 /* This will find the normal Xft font. */
2982 "monospace-10",
2983 #endif
2984 "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1",
2985 "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2986 "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1",
2987 /* This was formerly the first thing tried, but it finds
2988 too many fonts and takes too long. */
2989 "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1",
2990 /* If those didn't work, look for something which will
2991 at least work. */
2992 "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1",
2993 "fixed",
2994 NULL };
2995 int i;
2997 for (i = 0; names[i]; i++)
2999 font = font_open_by_name (f, names[i]);
3000 if (! NILP (font))
3001 break;
3003 if (NILP (font))
3004 error ("No suitable font was found");
3006 else if (!NILP (font_param))
3008 /* Remember the explicit font parameter, so we can re-apply it after
3009 we've applied the `default' face settings. */
3010 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
3013 /* This call will make X resources override any system font setting. */
3014 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
3018 DEFUN ("x-wm-set-size-hint", Fx_wm_set_size_hint, Sx_wm_set_size_hint,
3019 0, 1, 0,
3020 doc: /* Send the size hints for frame FRAME to the window manager.
3021 If FRAME is nil, use the selected frame. */)
3022 (Lisp_Object frame)
3024 struct frame *f;
3025 if (NILP (frame))
3026 frame = selected_frame;
3027 f = XFRAME (frame);
3028 BLOCK_INPUT;
3029 if (FRAME_X_P (f))
3030 x_wm_set_size_hint (f, 0, 0);
3031 UNBLOCK_INPUT;
3032 return Qnil;
3035 static void
3036 set_machine_and_pid_properties (struct frame *f)
3038 long pid = (long) getpid ();
3040 /* This will set WM_CLIENT_MACHINE and WM_LOCALE_NAME. */
3041 XSetWMProperties (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), NULL, NULL,
3042 NULL, 0, NULL, NULL, NULL);
3043 XChangeProperty (FRAME_X_DISPLAY (f),
3044 FRAME_OUTER_WINDOW (f),
3045 XInternAtom (FRAME_X_DISPLAY (f),
3046 "_NET_WM_PID",
3047 False),
3048 XA_CARDINAL, 32, PropModeReplace,
3049 (unsigned char *) &pid, 1);
3052 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
3053 1, 1, 0,
3054 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
3055 Return an Emacs frame object.
3056 PARMS is an alist of frame parameters.
3057 If the parameters specify that the frame should not have a minibuffer,
3058 and do not specify a specific minibuffer window to use,
3059 then `default-minibuffer-frame' must be a frame whose minibuffer can
3060 be shared by the new frame.
3062 This function is an internal primitive--use `make-frame' instead. */)
3063 (Lisp_Object parms)
3065 struct frame *f;
3066 Lisp_Object frame, tem;
3067 Lisp_Object name;
3068 int minibuffer_only = 0;
3069 long window_prompting = 0;
3070 int width, height;
3071 int count = SPECPDL_INDEX ();
3072 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3073 Lisp_Object display;
3074 struct x_display_info *dpyinfo = NULL;
3075 Lisp_Object parent;
3076 struct kboard *kb;
3078 parms = Fcopy_alist (parms);
3080 /* Use this general default value to start with
3081 until we know if this frame has a specified name. */
3082 Vx_resource_name = Vinvocation_name;
3084 display = x_get_arg (dpyinfo, parms, Qterminal, 0, 0, RES_TYPE_NUMBER);
3085 if (EQ (display, Qunbound))
3086 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3087 if (EQ (display, Qunbound))
3088 display = Qnil;
3089 dpyinfo = check_x_display_info (display);
3090 kb = dpyinfo->terminal->kboard;
3092 if (!dpyinfo->terminal->name)
3093 error ("Terminal is not live, can't create new frames on it");
3095 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3096 if (!STRINGP (name)
3097 && ! EQ (name, Qunbound)
3098 && ! NILP (name))
3099 error ("Invalid frame name--not a string or nil");
3101 if (STRINGP (name))
3102 Vx_resource_name = name;
3104 /* See if parent window is specified. */
3105 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3106 if (EQ (parent, Qunbound))
3107 parent = Qnil;
3108 if (! NILP (parent))
3109 CHECK_NUMBER (parent);
3111 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3112 /* No need to protect DISPLAY because that's not used after passing
3113 it to make_frame_without_minibuffer. */
3114 frame = Qnil;
3115 GCPRO4 (parms, parent, name, frame);
3116 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3117 RES_TYPE_SYMBOL);
3118 if (EQ (tem, Qnone) || NILP (tem))
3119 f = make_frame_without_minibuffer (Qnil, kb, display);
3120 else if (EQ (tem, Qonly))
3122 f = make_minibuffer_frame ();
3123 minibuffer_only = 1;
3125 else if (WINDOWP (tem))
3126 f = make_frame_without_minibuffer (tem, kb, display);
3127 else
3128 f = make_frame (1);
3130 XSETFRAME (frame, f);
3132 /* Note that X Windows does support scroll bars. */
3133 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
3135 f->terminal = dpyinfo->terminal;
3136 f->terminal->reference_count++;
3138 f->output_method = output_x_window;
3139 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
3140 memset (f->output_data.x, 0, sizeof (struct x_output));
3141 f->output_data.x->icon_bitmap = -1;
3142 FRAME_FONTSET (f) = -1;
3143 f->output_data.x->scroll_bar_foreground_pixel = -1;
3144 f->output_data.x->scroll_bar_background_pixel = -1;
3145 #ifdef USE_TOOLKIT_SCROLL_BARS
3146 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3147 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3148 #endif /* USE_TOOLKIT_SCROLL_BARS */
3150 f->icon_name
3151 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3152 RES_TYPE_STRING);
3153 if (! STRINGP (f->icon_name))
3154 f->icon_name = Qnil;
3156 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3158 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
3159 record_unwind_protect (unwind_create_frame, frame);
3160 #if GLYPH_DEBUG
3161 image_cache_refcount = FRAME_IMAGE_CACHE (f)->refcount;
3162 dpyinfo_refcount = dpyinfo->reference_count;
3163 #endif /* GLYPH_DEBUG */
3165 /* These colors will be set anyway later, but it's important
3166 to get the color reference counts right, so initialize them! */
3168 Lisp_Object black;
3169 struct gcpro inner_gcpro1;
3171 /* Function x_decode_color can signal an error. Make
3172 sure to initialize color slots so that we won't try
3173 to free colors we haven't allocated. */
3174 FRAME_FOREGROUND_PIXEL (f) = -1;
3175 FRAME_BACKGROUND_PIXEL (f) = -1;
3176 f->output_data.x->cursor_pixel = -1;
3177 f->output_data.x->cursor_foreground_pixel = -1;
3178 f->output_data.x->border_pixel = -1;
3179 f->output_data.x->mouse_pixel = -1;
3181 black = build_string ("black");
3182 GCPRO1_VAR (black, inner_gcpro);
3183 FRAME_FOREGROUND_PIXEL (f)
3184 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3185 FRAME_BACKGROUND_PIXEL (f)
3186 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3187 f->output_data.x->cursor_pixel
3188 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3189 f->output_data.x->cursor_foreground_pixel
3190 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3191 f->output_data.x->border_pixel
3192 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3193 f->output_data.x->mouse_pixel
3194 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3195 UNGCPRO_VAR (inner_gcpro);
3198 /* Specify the parent under which to make this X window. */
3200 if (!NILP (parent))
3202 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3203 f->output_data.x->explicit_parent = 1;
3205 else
3207 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3208 f->output_data.x->explicit_parent = 0;
3211 /* Set the name; the functions to which we pass f expect the name to
3212 be set. */
3213 if (EQ (name, Qunbound) || NILP (name))
3215 f->name = build_string (dpyinfo->x_id_name);
3216 f->explicit_name = 0;
3218 else
3220 f->name = name;
3221 f->explicit_name = 1;
3222 /* use the frame's title when getting resources for this frame. */
3223 specbind (Qx_resource_name, name);
3226 f->resx = dpyinfo->resx;
3227 f->resy = dpyinfo->resy;
3229 #ifdef HAVE_FREETYPE
3230 #ifdef HAVE_XFT
3231 register_font_driver (&xftfont_driver, f);
3232 #else /* not HAVE_XFT */
3233 register_font_driver (&ftxfont_driver, f);
3234 #endif /* not HAVE_XFT */
3235 #endif /* HAVE_FREETYPE */
3236 register_font_driver (&xfont_driver, f);
3238 x_default_parameter (f, parms, Qfont_backend, Qnil,
3239 "fontBackend", "FontBackend", RES_TYPE_STRING);
3241 /* Extract the window parameters from the supplied values
3242 that are needed to determine window geometry. */
3243 x_default_font_parameter (f, parms);
3244 if (!FRAME_FONT (f))
3246 delete_frame (frame, Qnoelisp);
3247 error ("Invalid frame font");
3250 /* Frame contents get displaced if an embedded X window has a border. */
3251 if (! FRAME_X_EMBEDDED_P (f))
3252 x_default_parameter (f, parms, Qborder_width, make_number (0),
3253 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3255 /* This defaults to 1 in order to match xterm. We recognize either
3256 internalBorderWidth or internalBorder (which is what xterm calls
3257 it). */
3258 if (NILP (Fassq (Qinternal_border_width, parms)))
3260 Lisp_Object value;
3262 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3263 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3264 if (! EQ (value, Qunbound))
3265 parms = Fcons (Fcons (Qinternal_border_width, value),
3266 parms);
3268 x_default_parameter (f, parms, Qinternal_border_width,
3269 #ifdef USE_GTK /* We used to impose 0 in xg_create_frame_widgets. */
3270 make_number (0),
3271 #else
3272 make_number (1),
3273 #endif
3274 "internalBorderWidth", "internalBorderWidth",
3275 RES_TYPE_NUMBER);
3276 x_default_parameter (f, parms, Qvertical_scroll_bars,
3277 #if defined(USE_GTK) && defined(USE_TOOLKIT_SCROLL_BARS)
3278 Qright,
3279 #else
3280 Qleft,
3281 #endif
3282 "verticalScrollBars", "ScrollBars",
3283 RES_TYPE_SYMBOL);
3285 /* Also do the stuff which must be set before the window exists. */
3286 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3287 "foreground", "Foreground", RES_TYPE_STRING);
3288 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3289 "background", "Background", RES_TYPE_STRING);
3290 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3291 "pointerColor", "Foreground", RES_TYPE_STRING);
3292 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3293 "borderColor", "BorderColor", RES_TYPE_STRING);
3294 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3295 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3296 x_default_parameter (f, parms, Qline_spacing, Qnil,
3297 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3298 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3299 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3300 x_default_parameter (f, parms, Qright_fringe, Qnil,
3301 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3303 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3304 "scrollBarForeground",
3305 "ScrollBarForeground", 1);
3306 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3307 "scrollBarBackground",
3308 "ScrollBarBackground", 0);
3310 /* Init faces before x_default_parameter is called for scroll-bar
3311 parameters because that function calls x_set_scroll_bar_width,
3312 which calls change_frame_size, which calls Fset_window_buffer,
3313 which runs hooks, which call Fvertical_motion. At the end, we
3314 end up in init_iterator with a null face cache, which should not
3315 happen. */
3316 init_frame_faces (f);
3318 /* The X resources controlling the menu-bar and tool-bar are
3319 processed specially at startup, and reflected in the mode
3320 variables; ignore them here. */
3321 x_default_parameter (f, parms, Qmenu_bar_lines,
3322 NILP (Vmenu_bar_mode)
3323 ? make_number (0) : make_number (1),
3324 NULL, NULL, RES_TYPE_NUMBER);
3325 x_default_parameter (f, parms, Qtool_bar_lines,
3326 NILP (Vtool_bar_mode)
3327 ? make_number (0) : make_number (1),
3328 NULL, NULL, RES_TYPE_NUMBER);
3330 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3331 "bufferPredicate", "BufferPredicate",
3332 RES_TYPE_SYMBOL);
3333 x_default_parameter (f, parms, Qtitle, Qnil,
3334 "title", "Title", RES_TYPE_STRING);
3335 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3336 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3337 x_default_parameter (f, parms, Qfullscreen, Qnil,
3338 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3339 x_default_parameter (f, parms, Qtool_bar_position,
3340 f->tool_bar_position, 0, 0, RES_TYPE_SYMBOL);
3342 /* Compute the size of the X window. */
3343 window_prompting = x_figure_window_size (f, parms, 1);
3345 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3346 f->no_split = minibuffer_only || EQ (tem, Qt);
3348 x_icon_verify (f, parms);
3350 /* Create the X widget or window. */
3351 #ifdef USE_X_TOOLKIT
3352 x_window (f, window_prompting, minibuffer_only);
3353 #else
3354 x_window (f);
3355 #endif
3357 x_icon (f, parms);
3358 x_make_gc (f);
3360 /* Now consider the frame official. */
3361 FRAME_X_DISPLAY_INFO (f)->reference_count++;
3362 Vframe_list = Fcons (frame, Vframe_list);
3364 /* We need to do this after creating the X window, so that the
3365 icon-creation functions can say whose icon they're describing. */
3366 x_default_parameter (f, parms, Qicon_type, Qt,
3367 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
3369 x_default_parameter (f, parms, Qauto_raise, Qnil,
3370 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3371 x_default_parameter (f, parms, Qauto_lower, Qnil,
3372 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3373 x_default_parameter (f, parms, Qcursor_type, Qbox,
3374 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3375 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3376 "scrollBarWidth", "ScrollBarWidth",
3377 RES_TYPE_NUMBER);
3378 x_default_parameter (f, parms, Qalpha, Qnil,
3379 "alpha", "Alpha", RES_TYPE_NUMBER);
3381 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3382 Change will not be effected unless different from the current
3383 FRAME_LINES (f). */
3384 width = FRAME_COLS (f);
3385 height = FRAME_LINES (f);
3387 SET_FRAME_COLS (f, 0);
3388 FRAME_LINES (f) = 0;
3389 change_frame_size (f, height, width, 1, 0, 0);
3391 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3392 /* Create the menu bar. */
3393 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3395 /* If this signals an error, we haven't set size hints for the
3396 frame and we didn't make it visible. */
3397 initialize_frame_menubar (f);
3399 #ifndef USE_GTK
3400 /* This is a no-op, except under Motif where it arranges the
3401 main window for the widgets on it. */
3402 lw_set_main_areas (f->output_data.x->column_widget,
3403 f->output_data.x->menubar_widget,
3404 f->output_data.x->edit_widget);
3405 #endif /* not USE_GTK */
3407 #endif /* USE_X_TOOLKIT || USE_GTK */
3409 /* Tell the server what size and position, etc, we want, and how
3410 badly we want them. This should be done after we have the menu
3411 bar so that its size can be taken into account. */
3412 BLOCK_INPUT;
3413 x_wm_set_size_hint (f, window_prompting, 0);
3414 UNBLOCK_INPUT;
3416 /* Make the window appear on the frame and enable display, unless
3417 the caller says not to. However, with explicit parent, Emacs
3418 cannot control visibility, so don't try. */
3419 if (! f->output_data.x->explicit_parent)
3421 Lisp_Object visibility;
3423 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3424 RES_TYPE_SYMBOL);
3425 if (EQ (visibility, Qunbound))
3426 visibility = Qt;
3428 if (EQ (visibility, Qicon))
3429 x_iconify_frame (f);
3430 else if (! NILP (visibility))
3431 x_make_frame_visible (f);
3432 else
3434 /* Must have been Qnil. */
3438 BLOCK_INPUT;
3440 /* Set machine name and pid for the purpose of window managers. */
3441 set_machine_and_pid_properties(f);
3443 /* Set the WM leader property. GTK does this itself, so this is not
3444 needed when using GTK. */
3445 if (dpyinfo->client_leader_window != 0)
3447 XChangeProperty (FRAME_X_DISPLAY (f),
3448 FRAME_OUTER_WINDOW (f),
3449 dpyinfo->Xatom_wm_client_leader,
3450 XA_WINDOW, 32, PropModeReplace,
3451 (unsigned char *) &dpyinfo->client_leader_window, 1);
3454 UNBLOCK_INPUT;
3456 /* Initialize `default-minibuffer-frame' in case this is the first
3457 frame on this terminal. */
3458 if (FRAME_HAS_MINIBUF_P (f)
3459 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
3460 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
3461 KVAR (kb, Vdefault_minibuffer_frame) = frame;
3463 /* All remaining specified parameters, which have not been "used"
3464 by x_get_arg and friends, now go in the misc. alist of the frame. */
3465 for (tem = parms; CONSP (tem); tem = XCDR (tem))
3466 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3467 f->param_alist = Fcons (XCAR (tem), f->param_alist);
3469 UNGCPRO;
3471 /* Make sure windows on this frame appear in calls to next-window
3472 and similar functions. */
3473 Vwindow_list = Qnil;
3475 return unbind_to (count, frame);
3479 /* FRAME is used only to get a handle on the X display. We don't pass the
3480 display info directly because we're called from frame.c, which doesn't
3481 know about that structure. */
3483 Lisp_Object
3484 x_get_focus_frame (struct frame *frame)
3486 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
3487 Lisp_Object xfocus;
3488 if (! dpyinfo->x_focus_frame)
3489 return Qnil;
3491 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3492 return xfocus;
3496 /* In certain situations, when the window manager follows a
3497 click-to-focus policy, there seems to be no way around calling
3498 XSetInputFocus to give another frame the input focus .
3500 In an ideal world, XSetInputFocus should generally be avoided so
3501 that applications don't interfere with the window manager's focus
3502 policy. But I think it's okay to use when it's clearly done
3503 following a user-command. */
3505 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
3506 doc: /* Set the input focus to FRAME.
3507 FRAME nil means use the selected frame. */)
3508 (Lisp_Object frame)
3510 struct frame *f = check_x_frame (frame);
3511 Display *dpy = FRAME_X_DISPLAY (f);
3513 BLOCK_INPUT;
3514 x_catch_errors (dpy);
3515 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3516 RevertToParent, CurrentTime);
3517 x_ewmh_activate_frame (f);
3518 x_uncatch_errors ();
3519 UNBLOCK_INPUT;
3521 return Qnil;
3525 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3526 doc: /* Internal function called by `color-defined-p', which see
3527 .\(Note that the Nextstep version of this function ignores FRAME.) */)
3528 (Lisp_Object color, Lisp_Object frame)
3530 XColor foo;
3531 FRAME_PTR f = check_x_frame (frame);
3533 CHECK_STRING (color);
3535 if (x_defined_color (f, SSDATA (color), &foo, 0))
3536 return Qt;
3537 else
3538 return Qnil;
3541 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3542 doc: /* Internal function called by `color-values', which see. */)
3543 (Lisp_Object color, Lisp_Object frame)
3545 XColor foo;
3546 FRAME_PTR f = check_x_frame (frame);
3548 CHECK_STRING (color);
3550 if (x_defined_color (f, SSDATA (color), &foo, 0))
3551 return list3 (make_number (foo.red),
3552 make_number (foo.green),
3553 make_number (foo.blue));
3554 else
3555 return Qnil;
3558 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3559 doc: /* Internal function called by `display-color-p', which see. */)
3560 (Lisp_Object terminal)
3562 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3564 if (dpyinfo->n_planes <= 2)
3565 return Qnil;
3567 switch (dpyinfo->visual->class)
3569 case StaticColor:
3570 case PseudoColor:
3571 case TrueColor:
3572 case DirectColor:
3573 return Qt;
3575 default:
3576 return Qnil;
3580 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3581 0, 1, 0,
3582 doc: /* Return t if the X display supports shades of gray.
3583 Note that color displays do support shades of gray.
3584 The optional argument TERMINAL specifies which display to ask about.
3585 TERMINAL should be a terminal object, a frame or a display name (a string).
3586 If omitted or nil, that stands for the selected frame's display. */)
3587 (Lisp_Object terminal)
3589 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3591 if (dpyinfo->n_planes <= 1)
3592 return Qnil;
3594 switch (dpyinfo->visual->class)
3596 case StaticColor:
3597 case PseudoColor:
3598 case TrueColor:
3599 case DirectColor:
3600 case StaticGray:
3601 case GrayScale:
3602 return Qt;
3604 default:
3605 return Qnil;
3609 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3610 0, 1, 0,
3611 doc: /* Return the width in pixels of the X display TERMINAL.
3612 The optional argument TERMINAL specifies which display to ask about.
3613 TERMINAL should be a terminal object, a frame or a display name (a string).
3614 If omitted or nil, that stands for the selected frame's display. */)
3615 (Lisp_Object terminal)
3617 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3619 return make_number (x_display_pixel_width (dpyinfo));
3622 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3623 Sx_display_pixel_height, 0, 1, 0,
3624 doc: /* Return the height in pixels of the X display TERMINAL.
3625 The optional argument TERMINAL specifies which display to ask about.
3626 TERMINAL should be a terminal object, a frame or a display name (a string).
3627 If omitted or nil, that stands for the selected frame's display. */)
3628 (Lisp_Object terminal)
3630 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3632 return make_number (x_display_pixel_height (dpyinfo));
3635 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3636 0, 1, 0,
3637 doc: /* Return the number of bitplanes of the X display TERMINAL.
3638 The optional argument TERMINAL specifies which display to ask about.
3639 TERMINAL should be a terminal object, a frame or a display name (a string).
3640 If omitted or nil, that stands for the selected frame's display. */)
3641 (Lisp_Object terminal)
3643 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3645 return make_number (dpyinfo->n_planes);
3648 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3649 0, 1, 0,
3650 doc: /* Return the number of color cells of the X display TERMINAL.
3651 The optional argument TERMINAL specifies which display to ask about.
3652 TERMINAL should be a terminal object, a frame or a display name (a string).
3653 If omitted or nil, that stands for the selected frame's display. */)
3654 (Lisp_Object terminal)
3656 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3658 int nr_planes = DisplayPlanes (dpyinfo->display,
3659 XScreenNumberOfScreen (dpyinfo->screen));
3661 /* Truncate nr_planes to 24 to avoid integer overflow.
3662 Some displays says 32, but only 24 bits are actually significant.
3663 There are only very few and rare video cards that have more than
3664 24 significant bits. Also 24 bits is more than 16 million colors,
3665 it "should be enough for everyone". */
3666 if (nr_planes > 24) nr_planes = 24;
3668 return make_number (1 << nr_planes);
3671 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3672 Sx_server_max_request_size,
3673 0, 1, 0,
3674 doc: /* Return the maximum request size of the X server of display TERMINAL.
3675 The optional argument TERMINAL specifies which display to ask about.
3676 TERMINAL should be a terminal object, a frame or a display name (a string).
3677 If omitted or nil, that stands for the selected frame's display. */)
3678 (Lisp_Object terminal)
3680 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3682 return make_number (MAXREQUEST (dpyinfo->display));
3685 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3686 doc: /* Return the "vendor ID" string of the X server of display TERMINAL.
3687 \(Labelling every distributor as a "vendor" embodies the false assumption
3688 that operating systems cannot be developed and distributed noncommercially.)
3689 The optional argument TERMINAL specifies which display to ask about.
3690 TERMINAL should be a terminal object, a frame or a display name (a string).
3691 If omitted or nil, that stands for the selected frame's display. */)
3692 (Lisp_Object terminal)
3694 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3695 const char *vendor = ServerVendor (dpyinfo->display);
3697 if (! vendor) vendor = "";
3698 return build_string (vendor);
3701 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3702 doc: /* Return the version numbers of the X server of display TERMINAL.
3703 The value is a list of three integers: the major and minor
3704 version numbers of the X Protocol in use, and the distributor-specific release
3705 number. See also the function `x-server-vendor'.
3707 The optional argument TERMINAL specifies which display to ask about.
3708 TERMINAL should be a terminal object, a frame or a display name (a string).
3709 If omitted or nil, that stands for the selected frame's display. */)
3710 (Lisp_Object terminal)
3712 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3713 Display *dpy = dpyinfo->display;
3715 return Fcons (make_number (ProtocolVersion (dpy)),
3716 Fcons (make_number (ProtocolRevision (dpy)),
3717 Fcons (make_number (VendorRelease (dpy)), Qnil)));
3720 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3721 doc: /* Return the number of screens on the X server of display TERMINAL.
3722 The optional argument TERMINAL specifies which display to ask about.
3723 TERMINAL should be a terminal object, a frame or a display name (a string).
3724 If omitted or nil, that stands for the selected frame's display. */)
3725 (Lisp_Object terminal)
3727 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3729 return make_number (ScreenCount (dpyinfo->display));
3732 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3733 doc: /* Return the height in millimeters of the X display TERMINAL.
3734 The optional argument TERMINAL specifies which display to ask about.
3735 TERMINAL should be a terminal object, a frame or a display name (a string).
3736 If omitted or nil, that stands for the selected frame's display. */)
3737 (Lisp_Object terminal)
3739 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3741 return make_number (HeightMMOfScreen (dpyinfo->screen));
3744 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3745 doc: /* Return the width in millimeters of the X display TERMINAL.
3746 The optional argument TERMINAL specifies which display to ask about.
3747 TERMINAL should be a terminal object, a frame or a display name (a string).
3748 If omitted or nil, that stands for the selected frame's display. */)
3749 (Lisp_Object terminal)
3751 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3753 return make_number (WidthMMOfScreen (dpyinfo->screen));
3756 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3757 Sx_display_backing_store, 0, 1, 0,
3758 doc: /* Return an indication of whether X display TERMINAL does backing store.
3759 The value may be `always', `when-mapped', or `not-useful'.
3760 The optional argument TERMINAL specifies which display to ask about.
3761 TERMINAL should be a terminal object, a frame or a display name (a string).
3762 If omitted or nil, that stands for the selected frame's display. */)
3763 (Lisp_Object terminal)
3765 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3766 Lisp_Object result;
3768 switch (DoesBackingStore (dpyinfo->screen))
3770 case Always:
3771 result = intern ("always");
3772 break;
3774 case WhenMapped:
3775 result = intern ("when-mapped");
3776 break;
3778 case NotUseful:
3779 result = intern ("not-useful");
3780 break;
3782 default:
3783 error ("Strange value for BackingStore parameter of screen");
3784 result = Qnil;
3787 return result;
3790 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3791 Sx_display_visual_class, 0, 1, 0,
3792 doc: /* Return the visual class of the X display TERMINAL.
3793 The value is one of the symbols `static-gray', `gray-scale',
3794 `static-color', `pseudo-color', `true-color', or `direct-color'.
3796 The optional argument TERMINAL specifies which display to ask about.
3797 TERMINAL should a terminal object, a frame or a display name (a string).
3798 If omitted or nil, that stands for the selected frame's display. */)
3799 (Lisp_Object terminal)
3801 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3802 Lisp_Object result;
3804 switch (dpyinfo->visual->class)
3806 case StaticGray:
3807 result = intern ("static-gray");
3808 break;
3809 case GrayScale:
3810 result = intern ("gray-scale");
3811 break;
3812 case StaticColor:
3813 result = intern ("static-color");
3814 break;
3815 case PseudoColor:
3816 result = intern ("pseudo-color");
3817 break;
3818 case TrueColor:
3819 result = intern ("true-color");
3820 break;
3821 case DirectColor:
3822 result = intern ("direct-color");
3823 break;
3824 default:
3825 error ("Display has an unknown visual class");
3826 result = Qnil;
3829 return result;
3832 DEFUN ("x-display-save-under", Fx_display_save_under,
3833 Sx_display_save_under, 0, 1, 0,
3834 doc: /* Return t if the X display TERMINAL supports the save-under feature.
3835 The optional argument TERMINAL specifies which display to ask about.
3836 TERMINAL should be a terminal object, a frame or a display name (a string).
3837 If omitted or nil, that stands for the selected frame's display. */)
3838 (Lisp_Object terminal)
3840 struct x_display_info *dpyinfo = check_x_display_info (terminal);
3842 if (DoesSaveUnders (dpyinfo->screen) == True)
3843 return Qt;
3844 else
3845 return Qnil;
3849 x_pixel_width (register struct frame *f)
3851 return FRAME_PIXEL_WIDTH (f);
3855 x_pixel_height (register struct frame *f)
3857 return FRAME_PIXEL_HEIGHT (f);
3861 x_char_width (register struct frame *f)
3863 return FRAME_COLUMN_WIDTH (f);
3867 x_char_height (register struct frame *f)
3869 return FRAME_LINE_HEIGHT (f);
3874 /************************************************************************
3875 X Displays
3876 ************************************************************************/
3879 /* Mapping visual names to visuals. */
3881 static struct visual_class
3883 const char *name;
3884 int class;
3886 visual_classes[] =
3888 {"StaticGray", StaticGray},
3889 {"GrayScale", GrayScale},
3890 {"StaticColor", StaticColor},
3891 {"PseudoColor", PseudoColor},
3892 {"TrueColor", TrueColor},
3893 {"DirectColor", DirectColor},
3894 {NULL, 0}
3898 #ifndef HAVE_XSCREENNUMBEROFSCREEN
3900 /* Value is the screen number of screen SCR. This is a substitute for
3901 the X function with the same name when that doesn't exist. */
3904 XScreenNumberOfScreen (scr)
3905 register Screen *scr;
3907 Display *dpy = scr->display;
3908 int i;
3910 for (i = 0; i < dpy->nscreens; ++i)
3911 if (scr == dpy->screens + i)
3912 break;
3914 return i;
3917 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
3920 /* Select the visual that should be used on display DPYINFO. Set
3921 members of DPYINFO appropriately. Called from x_term_init. */
3923 void
3924 select_visual (struct x_display_info *dpyinfo)
3926 Display *dpy = dpyinfo->display;
3927 Screen *screen = dpyinfo->screen;
3928 Lisp_Object value;
3930 /* See if a visual is specified. */
3931 value = display_x_get_resource (dpyinfo,
3932 build_string ("visualClass"),
3933 build_string ("VisualClass"),
3934 Qnil, Qnil);
3935 if (STRINGP (value))
3937 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
3938 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
3939 depth, a decimal number. NAME is compared with case ignored. */
3940 char *s = (char *) alloca (SBYTES (value) + 1);
3941 char *dash;
3942 int i, class = -1;
3943 XVisualInfo vinfo;
3945 strcpy (s, SSDATA (value));
3946 dash = strchr (s, '-');
3947 if (dash)
3949 dpyinfo->n_planes = atoi (dash + 1);
3950 *dash = '\0';
3952 else
3953 /* We won't find a matching visual with depth 0, so that
3954 an error will be printed below. */
3955 dpyinfo->n_planes = 0;
3957 /* Determine the visual class. */
3958 for (i = 0; visual_classes[i].name; ++i)
3959 if (xstrcasecmp (s, visual_classes[i].name) == 0)
3961 class = visual_classes[i].class;
3962 break;
3965 /* Look up a matching visual for the specified class. */
3966 if (class == -1
3967 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
3968 dpyinfo->n_planes, class, &vinfo))
3969 fatal ("Invalid visual specification `%s'", SDATA (value));
3971 dpyinfo->visual = vinfo.visual;
3973 else
3975 int n_visuals;
3976 XVisualInfo *vinfo, vinfo_template;
3978 dpyinfo->visual = DefaultVisualOfScreen (screen);
3980 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
3981 vinfo_template.screen = XScreenNumberOfScreen (screen);
3982 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
3983 &vinfo_template, &n_visuals);
3984 if (n_visuals <= 0)
3985 fatal ("Can't get proper X visual info");
3987 dpyinfo->n_planes = vinfo->depth;
3988 XFree ((char *) vinfo);
3993 /* Return the X display structure for the display named NAME.
3994 Open a new connection if necessary. */
3996 static struct x_display_info *
3997 x_display_info_for_name (Lisp_Object name)
3999 Lisp_Object names;
4000 struct x_display_info *dpyinfo;
4002 CHECK_STRING (name);
4004 #if 0
4005 if (! EQ (Vinitial_window_system, intern ("x")))
4006 error ("Not using X Windows"); /* That doesn't stop us anymore. */
4007 #endif
4009 for (dpyinfo = x_display_list, names = x_display_name_list;
4010 dpyinfo;
4011 dpyinfo = dpyinfo->next, names = XCDR (names))
4013 Lisp_Object tem;
4014 tem = Fstring_equal (XCAR (XCAR (names)), name);
4015 if (!NILP (tem))
4016 return dpyinfo;
4019 /* Use this general default value to start with. */
4020 Vx_resource_name = Vinvocation_name;
4022 validate_x_resource_name ();
4024 dpyinfo = x_term_init (name, (char *)0,
4025 SSDATA (Vx_resource_name));
4027 if (dpyinfo == 0)
4028 error ("Cannot connect to X server %s", SDATA (name));
4030 x_in_use = 1;
4031 XSETFASTINT (Vwindow_system_version, 11);
4033 return dpyinfo;
4037 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4038 1, 3, 0,
4039 doc: /* Open a connection to a display server.
4040 DISPLAY is the name of the display to connect to.
4041 Optional second arg XRM-STRING is a string of resources in xrdb format.
4042 If the optional third arg MUST-SUCCEED is non-nil,
4043 terminate Emacs if we can't open the connection.
4044 \(In the Nextstep version, the last two arguments are currently ignored.) */)
4045 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4047 char *xrm_option;
4048 struct x_display_info *dpyinfo;
4050 CHECK_STRING (display);
4051 if (! NILP (xrm_string))
4052 CHECK_STRING (xrm_string);
4054 #if 0
4055 if (! EQ (Vinitial_window_system, intern ("x")))
4056 error ("Not using X Windows"); /* That doesn't stop us anymore. */
4057 #endif
4059 if (! NILP (xrm_string))
4060 xrm_option = SSDATA (xrm_string);
4061 else
4062 xrm_option = (char *) 0;
4064 validate_x_resource_name ();
4066 /* This is what opens the connection and sets x_current_display.
4067 This also initializes many symbols, such as those used for input. */
4068 dpyinfo = x_term_init (display, xrm_option,
4069 SSDATA (Vx_resource_name));
4071 if (dpyinfo == 0)
4073 if (!NILP (must_succeed))
4074 fatal ("Cannot connect to X server %s.\n\
4075 Check the DISPLAY environment variable or use `-d'.\n\
4076 Also use the `xauth' program to verify that you have the proper\n\
4077 authorization information needed to connect the X server.\n\
4078 An insecure way to solve the problem may be to use `xhost'.\n",
4079 SDATA (display));
4080 else
4081 error ("Cannot connect to X server %s", SDATA (display));
4084 x_in_use = 1;
4086 XSETFASTINT (Vwindow_system_version, 11);
4087 return Qnil;
4090 DEFUN ("x-close-connection", Fx_close_connection,
4091 Sx_close_connection, 1, 1, 0,
4092 doc: /* Close the connection to TERMINAL's X server.
4093 For TERMINAL, specify a terminal object, a frame or a display name (a
4094 string). If TERMINAL is nil, that stands for the selected frame's
4095 terminal. */)
4096 (Lisp_Object terminal)
4098 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4100 if (dpyinfo->reference_count > 0)
4101 error ("Display still has frames on it");
4103 x_delete_terminal (dpyinfo->terminal);
4105 return Qnil;
4108 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4109 doc: /* Return the list of display names that Emacs has connections to. */)
4110 (void)
4112 Lisp_Object tail, result;
4114 result = Qnil;
4115 for (tail = x_display_name_list; CONSP (tail); tail = XCDR (tail))
4116 result = Fcons (XCAR (XCAR (tail)), result);
4118 return result;
4121 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4122 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4123 This function only has an effect on X Windows. With MS Windows, it is
4124 defined but does nothing.
4126 If ON is nil, allow buffering of requests.
4127 Turning on synchronization prohibits the Xlib routines from buffering
4128 requests and seriously degrades performance, but makes debugging much
4129 easier.
4130 The optional second argument TERMINAL specifies which display to act on.
4131 TERMINAL should be a terminal object, a frame or a display name (a string).
4132 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
4133 (Lisp_Object on, Lisp_Object terminal)
4135 struct x_display_info *dpyinfo = check_x_display_info (terminal);
4137 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4139 return Qnil;
4142 /* Wait for responses to all X commands issued so far for frame F. */
4144 void
4145 x_sync (FRAME_PTR f)
4147 BLOCK_INPUT;
4148 XSync (FRAME_X_DISPLAY (f), False);
4149 UNBLOCK_INPUT;
4153 /***********************************************************************
4154 Window properties
4155 ***********************************************************************/
4157 DEFUN ("x-change-window-property", Fx_change_window_property,
4158 Sx_change_window_property, 2, 6, 0,
4159 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4160 PROP must be a string. VALUE may be a string or a list of conses,
4161 numbers and/or strings. If an element in the list is a string, it is
4162 converted to an atom and the value of the atom is used. If an element
4163 is a cons, it is converted to a 32 bit number where the car is the 16
4164 top bits and the cdr is the lower 16 bits.
4166 FRAME nil or omitted means use the selected frame.
4167 If TYPE is given and non-nil, it is the name of the type of VALUE.
4168 If TYPE is not given or nil, the type is STRING.
4169 FORMAT gives the size in bits of each element if VALUE is a list.
4170 It must be one of 8, 16 or 32.
4171 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4172 If OUTER_P is non-nil, the property is changed for the outer X window of
4173 FRAME. Default is to change on the edit X window. */)
4174 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame, Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
4176 struct frame *f = check_x_frame (frame);
4177 Atom prop_atom;
4178 Atom target_type = XA_STRING;
4179 int element_format = 8;
4180 unsigned char *data;
4181 int nelements;
4182 Window w;
4184 CHECK_STRING (prop);
4186 if (! NILP (format))
4188 CHECK_NUMBER (format);
4189 element_format = XFASTINT (format);
4191 if (element_format != 8 && element_format != 16
4192 && element_format != 32)
4193 error ("FORMAT must be one of 8, 16 or 32");
4196 if (CONSP (value))
4198 nelements = x_check_property_data (value);
4199 if (nelements == -1)
4200 error ("Bad data in VALUE, must be number, string or cons");
4202 if (element_format == 8)
4203 data = (unsigned char *) xmalloc (nelements);
4204 else if (element_format == 16)
4205 data = (unsigned char *) xmalloc (nelements*2);
4206 else /* format == 32 */
4207 /* The man page for XChangeProperty:
4208 "If the specified format is 32, the property data must be a
4209 long array."
4210 This applies even if long is more than 64 bits. The X library
4211 converts to 32 bits before sending to the X server. */
4212 data = (unsigned char *) xmalloc (nelements * sizeof(long));
4214 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4216 else
4218 CHECK_STRING (value);
4219 data = SDATA (value);
4220 nelements = SCHARS (value);
4223 BLOCK_INPUT;
4224 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4225 if (! NILP (type))
4227 CHECK_STRING (type);
4228 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4231 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4232 else w = FRAME_X_WINDOW (f);
4234 XChangeProperty (FRAME_X_DISPLAY (f), w,
4235 prop_atom, target_type, element_format, PropModeReplace,
4236 data, nelements);
4238 if (CONSP (value)) xfree (data);
4240 /* Make sure the property is set when we return. */
4241 XFlush (FRAME_X_DISPLAY (f));
4242 UNBLOCK_INPUT;
4244 return value;
4248 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4249 Sx_delete_window_property, 1, 2, 0,
4250 doc: /* Remove window property PROP from X window of FRAME.
4251 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4252 (Lisp_Object prop, Lisp_Object frame)
4254 struct frame *f = check_x_frame (frame);
4255 Atom prop_atom;
4257 CHECK_STRING (prop);
4258 BLOCK_INPUT;
4259 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4260 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4262 /* Make sure the property is removed when we return. */
4263 XFlush (FRAME_X_DISPLAY (f));
4264 UNBLOCK_INPUT;
4266 return prop;
4270 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4271 1, 6, 0,
4272 doc: /* Value is the value of window property PROP on FRAME.
4273 If FRAME is nil or omitted, use the selected frame.
4275 On MS Windows, this function only accepts the PROP and FRAME arguments.
4277 On X Windows, the following optional arguments are also accepted:
4278 If TYPE is nil or omitted, get the property as a string.
4279 Otherwise TYPE is the name of the atom that denotes the type expected.
4280 If SOURCE is non-nil, get the property on that window instead of from
4281 FRAME. The number 0 denotes the root window.
4282 If DELETE_P is non-nil, delete the property after retreiving it.
4283 If VECTOR_RET_P is non-nil, don't return a string but a vector of values.
4285 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4286 no value of TYPE (always string in the MS Windows case). */)
4287 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type, Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
4289 struct frame *f = check_x_frame (frame);
4290 Atom prop_atom;
4291 int rc;
4292 Lisp_Object prop_value = Qnil;
4293 unsigned char *tmp_data = NULL;
4294 Atom actual_type;
4295 Atom target_type = XA_STRING;
4296 int actual_format;
4297 unsigned long actual_size, bytes_remaining;
4298 Window target_window = FRAME_X_WINDOW (f);
4299 struct gcpro gcpro1;
4301 GCPRO1 (prop_value);
4302 CHECK_STRING (prop);
4304 if (! NILP (source))
4306 CONS_TO_INTEGER (source, Window, target_window);
4307 if (! target_window)
4308 target_window = FRAME_X_DISPLAY_INFO (f)->root_window;
4311 BLOCK_INPUT;
4312 if (STRINGP (type))
4314 if (strcmp ("AnyPropertyType", SSDATA (type)) == 0)
4315 target_type = AnyPropertyType;
4316 else
4317 target_type = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (type), False);
4320 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (prop), False);
4321 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4322 prop_atom, 0, 0, False, target_type,
4323 &actual_type, &actual_format, &actual_size,
4324 &bytes_remaining, &tmp_data);
4325 if (rc == Success)
4327 int size = bytes_remaining;
4329 XFree (tmp_data);
4330 tmp_data = NULL;
4332 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4333 prop_atom, 0, bytes_remaining,
4334 ! NILP (delete_p), target_type,
4335 &actual_type, &actual_format,
4336 &actual_size, &bytes_remaining,
4337 &tmp_data);
4338 if (rc == Success && tmp_data)
4340 /* The man page for XGetWindowProperty says:
4341 "If the returned format is 32, the returned data is represented
4342 as a long array and should be cast to that type to obtain the
4343 elements."
4344 This applies even if long is more than 32 bits, the X library
4345 converts from 32 bit elements received from the X server to long
4346 and passes the long array to us. Thus, for that case memcpy can not
4347 be used. We convert to a 32 bit type here, because so much code
4348 assume on that.
4350 The bytes and offsets passed to XGetWindowProperty refers to the
4351 property and those are indeed in 32 bit quantities if format is
4352 32. */
4354 if (32 < BITS_PER_LONG && actual_format == 32)
4356 unsigned long i;
4357 int *idata = (int *) tmp_data;
4358 long *ldata = (long *) tmp_data;
4360 for (i = 0; i < actual_size; ++i)
4361 idata[i] = (int) ldata[i];
4364 if (NILP (vector_ret_p))
4365 prop_value = make_string ((char *) tmp_data, size);
4366 else
4367 prop_value = x_property_data_to_lisp (f,
4368 tmp_data,
4369 actual_type,
4370 actual_format,
4371 actual_size);
4374 if (tmp_data) XFree (tmp_data);
4377 UNBLOCK_INPUT;
4378 UNGCPRO;
4379 return prop_value;
4384 /***********************************************************************
4385 Busy cursor
4386 ***********************************************************************/
4388 /* Timer function of hourglass_atimer. TIMER is equal to
4389 hourglass_atimer.
4391 Display an hourglass pointer on all frames by mapping the frames'
4392 hourglass_window. Set the hourglass_p flag in the frames'
4393 output_data.x structure to indicate that an hourglass cursor is
4394 shown on the frames. */
4396 void
4397 show_hourglass (struct atimer *timer)
4399 /* The timer implementation will cancel this timer automatically
4400 after this function has run. Set hourglass_atimer to null
4401 so that we know the timer doesn't have to be canceled. */
4402 hourglass_atimer = NULL;
4404 if (!hourglass_shown_p)
4406 Lisp_Object rest, frame;
4408 BLOCK_INPUT;
4410 FOR_EACH_FRAME (rest, frame)
4412 struct frame *f = XFRAME (frame);
4414 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4416 Display *dpy = FRAME_X_DISPLAY (f);
4418 #ifdef USE_X_TOOLKIT
4419 if (f->output_data.x->widget)
4420 #else
4421 if (FRAME_OUTER_WINDOW (f))
4422 #endif
4424 f->output_data.x->hourglass_p = 1;
4426 if (!f->output_data.x->hourglass_window)
4428 unsigned long mask = CWCursor;
4429 XSetWindowAttributes attrs;
4430 #ifdef USE_GTK
4431 Window parent = FRAME_X_WINDOW (f);
4432 #else
4433 Window parent = FRAME_OUTER_WINDOW (f);
4434 #endif
4435 attrs.cursor = f->output_data.x->hourglass_cursor;
4437 f->output_data.x->hourglass_window
4438 = XCreateWindow (dpy, parent,
4439 0, 0, 32000, 32000, 0, 0,
4440 InputOnly,
4441 CopyFromParent,
4442 mask, &attrs);
4445 XMapRaised (dpy, f->output_data.x->hourglass_window);
4446 XFlush (dpy);
4451 hourglass_shown_p = 1;
4452 UNBLOCK_INPUT;
4457 /* Hide the hourglass pointer on all frames, if it is currently
4458 shown. */
4460 void
4461 hide_hourglass (void)
4463 if (hourglass_shown_p)
4465 Lisp_Object rest, frame;
4467 BLOCK_INPUT;
4468 FOR_EACH_FRAME (rest, frame)
4470 struct frame *f = XFRAME (frame);
4472 if (FRAME_X_P (f)
4473 /* Watch out for newly created frames. */
4474 && f->output_data.x->hourglass_window)
4476 XUnmapWindow (FRAME_X_DISPLAY (f),
4477 f->output_data.x->hourglass_window);
4478 /* Sync here because XTread_socket looks at the
4479 hourglass_p flag that is reset to zero below. */
4480 XSync (FRAME_X_DISPLAY (f), False);
4481 f->output_data.x->hourglass_p = 0;
4485 hourglass_shown_p = 0;
4486 UNBLOCK_INPUT;
4492 /***********************************************************************
4493 Tool tips
4494 ***********************************************************************/
4496 static Lisp_Object x_create_tip_frame (struct x_display_info *,
4497 Lisp_Object, Lisp_Object);
4498 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
4499 Lisp_Object, int, int, int *, int *);
4501 /* The frame of a currently visible tooltip. */
4503 Lisp_Object tip_frame;
4505 /* If non-nil, a timer started that hides the last tooltip when it
4506 fires. */
4508 static Lisp_Object tip_timer;
4509 Window tip_window;
4511 /* If non-nil, a vector of 3 elements containing the last args
4512 with which x-show-tip was called. See there. */
4514 static Lisp_Object last_show_tip_args;
4517 static Lisp_Object
4518 unwind_create_tip_frame (Lisp_Object frame)
4520 Lisp_Object deleted;
4522 deleted = unwind_create_frame (frame);
4523 if (EQ (deleted, Qt))
4525 tip_window = None;
4526 tip_frame = Qnil;
4529 return deleted;
4533 /* Create a frame for a tooltip on the display described by DPYINFO.
4534 PARMS is a list of frame parameters. TEXT is the string to
4535 display in the tip frame. Value is the frame.
4537 Note that functions called here, esp. x_default_parameter can
4538 signal errors, for instance when a specified color name is
4539 undefined. We have to make sure that we're in a consistent state
4540 when this happens. */
4542 static Lisp_Object
4543 x_create_tip_frame (struct x_display_info *dpyinfo,
4544 Lisp_Object parms,
4545 Lisp_Object text)
4547 struct frame *f;
4548 Lisp_Object frame;
4549 Lisp_Object name;
4550 int width, height;
4551 int count = SPECPDL_INDEX ();
4552 struct gcpro gcpro1, gcpro2, gcpro3;
4553 int face_change_count_before = face_change_count;
4554 Lisp_Object buffer;
4555 struct buffer *old_buffer;
4557 check_x ();
4559 if (!dpyinfo->terminal->name)
4560 error ("Terminal is not live, can't create new frames on it");
4562 parms = Fcopy_alist (parms);
4564 /* Get the name of the frame to use for resource lookup. */
4565 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4566 if (!STRINGP (name)
4567 && !EQ (name, Qunbound)
4568 && !NILP (name))
4569 error ("Invalid frame name--not a string or nil");
4571 frame = Qnil;
4572 GCPRO3 (parms, name, frame);
4573 f = make_frame (1);
4574 XSETFRAME (frame, f);
4576 buffer = Fget_buffer_create (build_string (" *tip*"));
4577 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer, Qnil);
4578 old_buffer = current_buffer;
4579 set_buffer_internal_1 (XBUFFER (buffer));
4580 BVAR (current_buffer, truncate_lines) = Qnil;
4581 specbind (Qinhibit_read_only, Qt);
4582 specbind (Qinhibit_modification_hooks, Qt);
4583 Ferase_buffer ();
4584 Finsert (1, &text);
4585 set_buffer_internal_1 (old_buffer);
4587 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
4588 record_unwind_protect (unwind_create_tip_frame, frame);
4590 f->terminal = dpyinfo->terminal;
4591 f->terminal->reference_count++;
4593 /* By setting the output method, we're essentially saying that
4594 the frame is live, as per FRAME_LIVE_P. If we get a signal
4595 from this point on, x_destroy_window might screw up reference
4596 counts etc. */
4597 f->output_method = output_x_window;
4598 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4599 memset (f->output_data.x, 0, sizeof (struct x_output));
4600 f->output_data.x->icon_bitmap = -1;
4601 FRAME_FONTSET (f) = -1;
4602 f->output_data.x->scroll_bar_foreground_pixel = -1;
4603 f->output_data.x->scroll_bar_background_pixel = -1;
4604 #ifdef USE_TOOLKIT_SCROLL_BARS
4605 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
4606 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
4607 #endif /* USE_TOOLKIT_SCROLL_BARS */
4608 f->icon_name = Qnil;
4609 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4610 #if GLYPH_DEBUG
4611 image_cache_refcount = FRAME_IMAGE_CACHE (f)->refcount;
4612 dpyinfo_refcount = dpyinfo->reference_count;
4613 #endif /* GLYPH_DEBUG */
4614 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4615 f->output_data.x->explicit_parent = 0;
4617 /* These colors will be set anyway later, but it's important
4618 to get the color reference counts right, so initialize them! */
4620 Lisp_Object black;
4621 struct gcpro inner_gcpro1;
4623 /* Function x_decode_color can signal an error. Make
4624 sure to initialize color slots so that we won't try
4625 to free colors we haven't allocated. */
4626 FRAME_FOREGROUND_PIXEL (f) = -1;
4627 FRAME_BACKGROUND_PIXEL (f) = -1;
4628 f->output_data.x->cursor_pixel = -1;
4629 f->output_data.x->cursor_foreground_pixel = -1;
4630 f->output_data.x->border_pixel = -1;
4631 f->output_data.x->mouse_pixel = -1;
4633 black = build_string ("black");
4634 GCPRO1_VAR (black, inner_gcpro);
4635 FRAME_FOREGROUND_PIXEL (f)
4636 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4637 FRAME_BACKGROUND_PIXEL (f)
4638 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4639 f->output_data.x->cursor_pixel
4640 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4641 f->output_data.x->cursor_foreground_pixel
4642 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4643 f->output_data.x->border_pixel
4644 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4645 f->output_data.x->mouse_pixel
4646 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4647 UNGCPRO_VAR (inner_gcpro);
4650 /* Set the name; the functions to which we pass f expect the name to
4651 be set. */
4652 if (EQ (name, Qunbound) || NILP (name))
4654 f->name = build_string (dpyinfo->x_id_name);
4655 f->explicit_name = 0;
4657 else
4659 f->name = name;
4660 f->explicit_name = 1;
4661 /* use the frame's title when getting resources for this frame. */
4662 specbind (Qx_resource_name, name);
4665 f->resx = dpyinfo->resx;
4666 f->resy = dpyinfo->resy;
4668 register_font_driver (&xfont_driver, f);
4669 #ifdef HAVE_FREETYPE
4670 #ifdef HAVE_XFT
4671 register_font_driver (&xftfont_driver, f);
4672 #else /* not HAVE_XFT */
4673 register_font_driver (&ftxfont_driver, f);
4674 #endif /* not HAVE_XFT */
4675 #endif /* HAVE_FREETYPE */
4677 x_default_parameter (f, parms, Qfont_backend, Qnil,
4678 "fontBackend", "FontBackend", RES_TYPE_STRING);
4680 /* Extract the window parameters from the supplied values that are
4681 needed to determine window geometry. */
4682 x_default_font_parameter (f, parms);
4684 x_default_parameter (f, parms, Qborder_width, make_number (0),
4685 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4687 /* This defaults to 2 in order to match xterm. We recognize either
4688 internalBorderWidth or internalBorder (which is what xterm calls
4689 it). */
4690 if (NILP (Fassq (Qinternal_border_width, parms)))
4692 Lisp_Object value;
4694 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4695 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4696 if (! EQ (value, Qunbound))
4697 parms = Fcons (Fcons (Qinternal_border_width, value),
4698 parms);
4701 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4702 "internalBorderWidth", "internalBorderWidth",
4703 RES_TYPE_NUMBER);
4705 /* Also do the stuff which must be set before the window exists. */
4706 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4707 "foreground", "Foreground", RES_TYPE_STRING);
4708 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4709 "background", "Background", RES_TYPE_STRING);
4710 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4711 "pointerColor", "Foreground", RES_TYPE_STRING);
4712 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4713 "cursorColor", "Foreground", RES_TYPE_STRING);
4714 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4715 "borderColor", "BorderColor", RES_TYPE_STRING);
4717 /* Init faces before x_default_parameter is called for scroll-bar
4718 parameters because that function calls x_set_scroll_bar_width,
4719 which calls change_frame_size, which calls Fset_window_buffer,
4720 which runs hooks, which call Fvertical_motion. At the end, we
4721 end up in init_iterator with a null face cache, which should not
4722 happen. */
4723 init_frame_faces (f);
4725 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4727 x_figure_window_size (f, parms, 0);
4730 XSetWindowAttributes attrs;
4731 unsigned long mask;
4732 Atom type = FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type_tooltip;
4734 BLOCK_INPUT;
4735 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
4736 if (DoesSaveUnders (dpyinfo->screen))
4737 mask |= CWSaveUnder;
4739 /* Window managers look at the override-redirect flag to determine
4740 whether or net to give windows a decoration (Xlib spec, chapter
4741 3.2.8). */
4742 attrs.override_redirect = True;
4743 attrs.save_under = True;
4744 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4745 /* Arrange for getting MapNotify and UnmapNotify events. */
4746 attrs.event_mask = StructureNotifyMask;
4747 tip_window
4748 = FRAME_X_WINDOW (f)
4749 = XCreateWindow (FRAME_X_DISPLAY (f),
4750 FRAME_X_DISPLAY_INFO (f)->root_window,
4751 /* x, y, width, height */
4752 0, 0, 1, 1,
4753 /* Border. */
4754 f->border_width,
4755 CopyFromParent, InputOutput, CopyFromParent,
4756 mask, &attrs);
4757 XChangeProperty (FRAME_X_DISPLAY (f), tip_window,
4758 FRAME_X_DISPLAY_INFO (f)->Xatom_net_window_type,
4759 XA_ATOM, 32, PropModeReplace,
4760 (unsigned char *)&type, 1);
4761 UNBLOCK_INPUT;
4764 x_make_gc (f);
4766 x_default_parameter (f, parms, Qauto_raise, Qnil,
4767 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4768 x_default_parameter (f, parms, Qauto_lower, Qnil,
4769 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4770 x_default_parameter (f, parms, Qcursor_type, Qbox,
4771 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4773 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4774 Change will not be effected unless different from the current
4775 FRAME_LINES (f). */
4776 width = FRAME_COLS (f);
4777 height = FRAME_LINES (f);
4778 SET_FRAME_COLS (f, 0);
4779 FRAME_LINES (f) = 0;
4780 change_frame_size (f, height, width, 1, 0, 0);
4782 /* Add `tooltip' frame parameter's default value. */
4783 if (NILP (Fframe_parameter (frame, Qtooltip)))
4784 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
4786 /* FIXME - can this be done in a similar way to normal frames?
4787 http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00641.html */
4789 /* Set the `display-type' frame parameter before setting up faces. */
4791 Lisp_Object disptype;
4793 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
4794 disptype = intern ("mono");
4795 else if (FRAME_X_DISPLAY_INFO (f)->visual->class == GrayScale
4796 || FRAME_X_DISPLAY_INFO (f)->visual->class == StaticGray)
4797 disptype = intern ("grayscale");
4798 else
4799 disptype = intern ("color");
4801 if (NILP (Fframe_parameter (frame, Qdisplay_type)))
4802 Fmodify_frame_parameters (frame, Fcons (Fcons (Qdisplay_type, disptype),
4803 Qnil));
4806 /* Set up faces after all frame parameters are known. This call
4807 also merges in face attributes specified for new frames.
4809 Frame parameters may be changed if .Xdefaults contains
4810 specifications for the default font. For example, if there is an
4811 `Emacs.default.attributeBackground: pink', the `background-color'
4812 attribute of the frame get's set, which let's the internal border
4813 of the tooltip frame appear in pink. Prevent this. */
4815 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
4817 /* Set tip_frame here, so that */
4818 tip_frame = frame;
4819 call2 (Qface_set_after_frame_default, frame, Qnil);
4821 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
4822 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
4823 Qnil));
4826 f->no_split = 1;
4828 UNGCPRO;
4830 /* It is now ok to make the frame official even if we get an error
4831 below. And the frame needs to be on Vframe_list or making it
4832 visible won't work. */
4833 Vframe_list = Fcons (frame, Vframe_list);
4835 /* Now that the frame is official, it counts as a reference to
4836 its display. */
4837 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4839 /* Setting attributes of faces of the tooltip frame from resources
4840 and similar will increment face_change_count, which leads to the
4841 clearing of all current matrices. Since this isn't necessary
4842 here, avoid it by resetting face_change_count to the value it
4843 had before we created the tip frame. */
4844 face_change_count = face_change_count_before;
4846 /* Discard the unwind_protect. */
4847 return unbind_to (count, frame);
4851 /* Compute where to display tip frame F. PARMS is the list of frame
4852 parameters for F. DX and DY are specified offsets from the current
4853 location of the mouse. WIDTH and HEIGHT are the width and height
4854 of the tooltip. Return coordinates relative to the root window of
4855 the display in *ROOT_X, and *ROOT_Y. */
4857 static void
4858 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)
4860 Lisp_Object left, top;
4861 int win_x, win_y;
4862 Window root, child;
4863 unsigned pmask;
4865 /* User-specified position? */
4866 left = Fcdr (Fassq (Qleft, parms));
4867 top = Fcdr (Fassq (Qtop, parms));
4869 /* Move the tooltip window where the mouse pointer is. Resize and
4870 show it. */
4871 if (!INTEGERP (left) || !INTEGERP (top))
4873 BLOCK_INPUT;
4874 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
4875 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
4876 UNBLOCK_INPUT;
4879 if (INTEGERP (top))
4880 *root_y = XINT (top);
4881 else if (*root_y + XINT (dy) <= 0)
4882 *root_y = 0; /* Can happen for negative dy */
4883 else if (*root_y + XINT (dy) + height
4884 <= x_display_pixel_height (FRAME_X_DISPLAY_INFO (f)))
4885 /* It fits below the pointer */
4886 *root_y += XINT (dy);
4887 else if (height + XINT (dy) <= *root_y)
4888 /* It fits above the pointer. */
4889 *root_y -= height + XINT (dy);
4890 else
4891 /* Put it on the top. */
4892 *root_y = 0;
4894 if (INTEGERP (left))
4895 *root_x = XINT (left);
4896 else if (*root_x + XINT (dx) <= 0)
4897 *root_x = 0; /* Can happen for negative dx */
4898 else if (*root_x + XINT (dx) + width
4899 <= x_display_pixel_width (FRAME_X_DISPLAY_INFO (f)))
4900 /* It fits to the right of the pointer. */
4901 *root_x += XINT (dx);
4902 else if (width + XINT (dx) <= *root_x)
4903 /* It fits to the left of the pointer. */
4904 *root_x -= width + XINT (dx);
4905 else
4906 /* Put it left-justified on the screen--it ought to fit that way. */
4907 *root_x = 0;
4911 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
4912 doc: /* Show STRING in a "tooltip" window on frame FRAME.
4913 A tooltip window is a small X window displaying a string.
4915 This is an internal function; Lisp code should call `tooltip-show'.
4917 FRAME nil or omitted means use the selected frame.
4919 PARMS is an optional list of frame parameters which can be used to
4920 change the tooltip's appearance.
4922 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
4923 means use the default timeout of 5 seconds.
4925 If the list of frame parameters PARMS contains a `left' parameters,
4926 the tooltip is displayed at that x-position. Otherwise it is
4927 displayed at the mouse position, with offset DX added (default is 5 if
4928 DX isn't specified). Likewise for the y-position; if a `top' frame
4929 parameter is specified, it determines the y-position of the tooltip
4930 window, otherwise it is displayed at the mouse position, with offset
4931 DY added (default is -10).
4933 A tooltip's maximum size is specified by `x-max-tooltip-size'.
4934 Text larger than the specified size is clipped. */)
4935 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
4937 struct frame *f;
4938 struct window *w;
4939 int root_x, root_y;
4940 struct buffer *old_buffer;
4941 struct text_pos pos;
4942 int i, width, height, seen_reversed_p;
4943 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4944 int old_windows_or_buffers_changed = windows_or_buffers_changed;
4945 int count = SPECPDL_INDEX ();
4947 specbind (Qinhibit_redisplay, Qt);
4949 GCPRO4 (string, parms, frame, timeout);
4951 CHECK_STRING (string);
4952 if (SCHARS (string) == 0)
4953 string = make_unibyte_string (" ", 1);
4955 f = check_x_frame (frame);
4956 if (NILP (timeout))
4957 timeout = make_number (5);
4958 else
4959 CHECK_NATNUM (timeout);
4961 if (NILP (dx))
4962 dx = make_number (5);
4963 else
4964 CHECK_NUMBER (dx);
4966 if (NILP (dy))
4967 dy = make_number (-10);
4968 else
4969 CHECK_NUMBER (dy);
4971 #ifdef USE_GTK
4972 if (x_gtk_use_system_tooltips)
4974 int ok;
4976 /* Hide a previous tip, if any. */
4977 Fx_hide_tip ();
4979 BLOCK_INPUT;
4980 if ((ok = xg_prepare_tooltip (f, string, &width, &height)) != 0)
4982 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
4983 xg_show_tooltip (f, root_x, root_y);
4984 /* This is used in Fx_hide_tip. */
4985 XSETFRAME (tip_frame, f);
4987 UNBLOCK_INPUT;
4988 if (ok) goto start_timer;
4990 #endif /* USE_GTK */
4992 if (NILP (last_show_tip_args))
4993 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
4995 if (!NILP (tip_frame))
4997 Lisp_Object last_string = AREF (last_show_tip_args, 0);
4998 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
4999 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5001 if (EQ (frame, last_frame)
5002 && !NILP (Fequal (last_string, string))
5003 && !NILP (Fequal (last_parms, parms)))
5005 struct frame *tip_f = XFRAME (tip_frame);
5007 /* Only DX and DY have changed. */
5008 if (!NILP (tip_timer))
5010 Lisp_Object timer = tip_timer;
5011 tip_timer = Qnil;
5012 call1 (Qcancel_timer, timer);
5015 BLOCK_INPUT;
5016 compute_tip_xy (tip_f, parms, dx, dy, FRAME_PIXEL_WIDTH (tip_f),
5017 FRAME_PIXEL_HEIGHT (tip_f), &root_x, &root_y);
5018 XMoveWindow (FRAME_X_DISPLAY (tip_f), FRAME_X_WINDOW (tip_f),
5019 root_x, root_y);
5020 UNBLOCK_INPUT;
5021 goto start_timer;
5025 /* Hide a previous tip, if any. */
5026 Fx_hide_tip ();
5028 ASET (last_show_tip_args, 0, string);
5029 ASET (last_show_tip_args, 1, frame);
5030 ASET (last_show_tip_args, 2, parms);
5032 /* Add default values to frame parameters. */
5033 if (NILP (Fassq (Qname, parms)))
5034 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5035 if (NILP (Fassq (Qinternal_border_width, parms)))
5036 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5037 if (NILP (Fassq (Qborder_width, parms)))
5038 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5039 if (NILP (Fassq (Qborder_color, parms)))
5040 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5041 if (NILP (Fassq (Qbackground_color, parms)))
5042 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5043 parms);
5045 /* Create a frame for the tooltip, and record it in the global
5046 variable tip_frame. */
5047 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
5048 f = XFRAME (frame);
5050 /* Set up the frame's root window. */
5051 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5052 w->left_col = w->top_line = make_number (0);
5054 if (CONSP (Vx_max_tooltip_size)
5055 && INTEGERP (XCAR (Vx_max_tooltip_size))
5056 && XINT (XCAR (Vx_max_tooltip_size)) > 0
5057 && INTEGERP (XCDR (Vx_max_tooltip_size))
5058 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
5060 w->total_cols = XCAR (Vx_max_tooltip_size);
5061 w->total_lines = XCDR (Vx_max_tooltip_size);
5063 else
5065 w->total_cols = make_number (80);
5066 w->total_lines = make_number (40);
5069 FRAME_TOTAL_COLS (f) = XINT (w->total_cols);
5070 adjust_glyphs (f);
5071 w->pseudo_window_p = 1;
5073 /* Display the tooltip text in a temporary buffer. */
5074 old_buffer = current_buffer;
5075 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
5076 BVAR (current_buffer, truncate_lines) = Qnil;
5077 clear_glyph_matrix (w->desired_matrix);
5078 clear_glyph_matrix (w->current_matrix);
5079 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5080 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
5082 /* Compute width and height of the tooltip. */
5083 width = height = seen_reversed_p = 0;
5084 for (i = 0; i < w->desired_matrix->nrows; ++i)
5086 struct glyph_row *row = &w->desired_matrix->rows[i];
5087 struct glyph *last;
5088 int row_width;
5090 /* Stop at the first empty row at the end. */
5091 if (!row->enabled_p || !row->displays_text_p)
5092 break;
5094 /* Let the row go over the full width of the frame. */
5095 row->full_width_p = 1;
5097 row_width = row->pixel_width;
5098 if (row->used[TEXT_AREA])
5100 /* There's a glyph at the end of rows that is used to place
5101 the cursor there. Don't include the width of this glyph. */
5102 if (!row->reversed_p)
5104 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5105 if (INTEGERP (last->object))
5106 row_width -= last->pixel_width;
5108 else
5110 /* There could be a stretch glyph at the beginning of R2L
5111 rows that is produced by extend_face_to_end_of_line.
5112 Don't count that glyph. */
5113 struct glyph *g = row->glyphs[TEXT_AREA];
5115 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
5117 row_width -= g->pixel_width;
5118 seen_reversed_p = 1;
5123 height += row->height;
5124 width = max (width, row_width);
5127 /* If we've seen partial-length R2L rows, we need to re-adjust the
5128 tool-tip frame width and redisplay it again, to avoid over-wide
5129 tips due to the stretch glyph that extends R2L lines to full
5130 width of the frame. */
5131 if (seen_reversed_p)
5133 /* w->total_cols and FRAME_TOTAL_COLS want the width in columns,
5134 not in pixels. */
5135 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
5136 w->total_cols = make_number (width);
5137 FRAME_TOTAL_COLS (f) = width;
5138 adjust_glyphs (f);
5139 clear_glyph_matrix (w->desired_matrix);
5140 clear_glyph_matrix (w->current_matrix);
5141 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5142 width = height = 0;
5143 /* Recompute width and height of the tooltip. */
5144 for (i = 0; i < w->desired_matrix->nrows; ++i)
5146 struct glyph_row *row = &w->desired_matrix->rows[i];
5147 struct glyph *last;
5148 int row_width;
5150 if (!row->enabled_p || !row->displays_text_p)
5151 break;
5152 row->full_width_p = 1;
5153 row_width = row->pixel_width;
5154 if (row->used[TEXT_AREA] && !row->reversed_p)
5156 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5157 if (INTEGERP (last->object))
5158 row_width -= last->pixel_width;
5161 height += row->height;
5162 width = max (width, row_width);
5166 /* Add the frame's internal border to the width and height the X
5167 window should have. */
5168 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5169 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5171 /* Move the tooltip window where the mouse pointer is. Resize and
5172 show it. */
5173 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5175 BLOCK_INPUT;
5176 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5177 root_x, root_y, width, height);
5178 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5179 UNBLOCK_INPUT;
5181 /* Draw into the window. */
5182 w->must_be_updated_p = 1;
5183 update_single_window (w, 1);
5185 /* Restore original current buffer. */
5186 set_buffer_internal_1 (old_buffer);
5187 windows_or_buffers_changed = old_windows_or_buffers_changed;
5189 start_timer:
5190 /* Let the tip disappear after timeout seconds. */
5191 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5192 intern ("x-hide-tip"));
5194 UNGCPRO;
5195 return unbind_to (count, Qnil);
5199 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5200 doc: /* Hide the current tooltip window, if there is any.
5201 Value is t if tooltip was open, nil otherwise. */)
5202 (void)
5204 int count;
5205 Lisp_Object deleted, frame, timer;
5206 struct gcpro gcpro1, gcpro2;
5208 /* Return quickly if nothing to do. */
5209 if (NILP (tip_timer) && NILP (tip_frame))
5210 return Qnil;
5212 frame = tip_frame;
5213 timer = tip_timer;
5214 GCPRO2 (frame, timer);
5215 tip_frame = tip_timer = deleted = Qnil;
5217 count = SPECPDL_INDEX ();
5218 specbind (Qinhibit_redisplay, Qt);
5219 specbind (Qinhibit_quit, Qt);
5221 if (!NILP (timer))
5222 call1 (Qcancel_timer, timer);
5224 #ifdef USE_GTK
5226 /* When using system tooltip, tip_frame is the Emacs frame on which
5227 the tip is shown. */
5228 struct frame *f = XFRAME (frame);
5229 if (FRAME_LIVE_P (f) && xg_hide_tooltip (f))
5230 frame = Qnil;
5232 #endif
5234 if (FRAMEP (frame))
5236 delete_frame (frame, Qnil);
5237 deleted = Qt;
5239 #ifdef USE_LUCID
5240 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5241 redisplay procedure is not called when a tip frame over menu
5242 items is unmapped. Redisplay the menu manually... */
5244 Widget w;
5245 struct frame *f = SELECTED_FRAME ();
5246 w = f->output_data.x->menubar_widget;
5248 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
5249 && w != NULL)
5251 BLOCK_INPUT;
5252 xlwmenu_redisplay (w);
5253 UNBLOCK_INPUT;
5256 #endif /* USE_LUCID */
5259 UNGCPRO;
5260 return unbind_to (count, deleted);
5265 /***********************************************************************
5266 File selection dialog
5267 ***********************************************************************/
5269 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5270 Sx_uses_old_gtk_dialog,
5271 0, 0, 0,
5272 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5273 (void)
5275 #ifdef USE_GTK
5276 if (use_dialog_box
5277 && use_file_dialog
5278 && have_menus_p ()
5279 && xg_uses_old_file_dialog ())
5280 return Qt;
5281 #endif
5282 return Qnil;
5286 #ifdef USE_MOTIF
5287 /* Callback for "OK" and "Cancel" on file selection dialog. */
5289 static void
5290 file_dialog_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5292 int *result = (int *) client_data;
5293 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
5294 *result = cb->reason;
5298 /* Callback for unmapping a file selection dialog. This is used to
5299 capture the case where a dialog is closed via a window manager's
5300 closer button, for example. Using a XmNdestroyCallback didn't work
5301 in this case. */
5303 static void
5304 file_dialog_unmap_cb (Widget widget, XtPointer client_data, XtPointer call_data)
5306 int *result = (int *) client_data;
5307 *result = XmCR_CANCEL;
5310 static Lisp_Object
5311 clean_up_file_dialog (Lisp_Object arg)
5313 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
5314 Widget dialog = (Widget) p->pointer;
5316 /* Clean up. */
5317 BLOCK_INPUT;
5318 XtUnmanageChild (dialog);
5319 XtDestroyWidget (dialog);
5320 x_menu_set_in_use (0);
5321 UNBLOCK_INPUT;
5323 return Qnil;
5327 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5328 doc: /* Read file name, prompting with PROMPT in directory DIR.
5329 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5330 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5331 or directory must exist.
5333 This function is only defined on MS Windows, and X Windows with the
5334 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5335 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5336 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
5338 int result;
5339 struct frame *f = SELECTED_FRAME ();
5340 Lisp_Object file = Qnil;
5341 Lisp_Object decoded_file;
5342 Widget dialog, text, help;
5343 Arg al[10];
5344 int ac = 0;
5345 XmString dir_xmstring, pattern_xmstring;
5346 int count = SPECPDL_INDEX ();
5347 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5349 check_x ();
5351 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5353 if (popup_activated ())
5354 error ("Trying to use a menu from within a menu-entry");
5356 CHECK_STRING (prompt);
5357 CHECK_STRING (dir);
5359 /* Prevent redisplay. */
5360 specbind (Qinhibit_redisplay, Qt);
5362 BLOCK_INPUT;
5364 /* Create the dialog with PROMPT as title, using DIR as initial
5365 directory and using "*" as pattern. */
5366 dir = Fexpand_file_name (dir, Qnil);
5367 dir_xmstring = XmStringCreateLocalized (SDATA (dir));
5368 pattern_xmstring = XmStringCreateLocalized ("*");
5370 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5371 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5372 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5373 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5374 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5375 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5376 "fsb", al, ac);
5377 XmStringFree (dir_xmstring);
5378 XmStringFree (pattern_xmstring);
5380 /* Add callbacks for OK and Cancel. */
5381 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5382 (XtPointer) &result);
5383 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5384 (XtPointer) &result);
5385 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5386 (XtPointer) &result);
5388 /* Remove the help button since we can't display help. */
5389 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5390 XtUnmanageChild (help);
5392 /* Mark OK button as default. */
5393 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5394 XmNshowAsDefault, True, NULL);
5396 /* If MUSTMATCH is non-nil, disable the file entry field of the
5397 dialog, so that the user must select a file from the files list
5398 box. We can't remove it because we wouldn't have a way to get at
5399 the result file name, then. */
5400 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5401 if (!NILP (mustmatch))
5403 Widget label;
5404 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5405 XtSetSensitive (text, False);
5406 XtSetSensitive (label, False);
5409 /* Manage the dialog, so that list boxes get filled. */
5410 XtManageChild (dialog);
5412 if (STRINGP (default_filename))
5414 XmString default_xmstring;
5415 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5416 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5418 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5419 XmTextFieldReplace (wtext, 0, last_pos,
5420 (SDATA (Ffile_name_nondirectory (default_filename))));
5422 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5423 must include the path for this to work. */
5425 default_xmstring = XmStringCreateLocalized (SDATA (default_filename));
5427 if (XmListItemExists (list, default_xmstring))
5429 int item_pos = XmListItemPos (list, default_xmstring);
5430 /* Select the item and scroll it into view. */
5431 XmListSelectPos (list, item_pos, True);
5432 XmListSetPos (list, item_pos);
5435 XmStringFree (default_xmstring);
5438 record_unwind_protect (clean_up_file_dialog, make_save_value (dialog, 0));
5440 /* Process events until the user presses Cancel or OK. */
5441 x_menu_set_in_use (1);
5442 result = 0;
5443 while (result == 0)
5445 XEvent event;
5446 x_menu_wait_for_event (0);
5447 XtAppNextEvent (Xt_app_con, &event);
5448 if (event.type == KeyPress
5449 && FRAME_X_DISPLAY (f) == event.xkey.display)
5451 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5453 /* Pop down on C-g. */
5454 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5455 XtUnmanageChild (dialog);
5458 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5461 /* Get the result. */
5462 if (result == XmCR_OK)
5464 XmString text_string;
5465 String data;
5467 XtVaGetValues (dialog, XmNtextString, &text_string, NULL);
5468 XmStringGetLtoR (text_string, XmFONTLIST_DEFAULT_TAG, &data);
5469 XmStringFree (text_string);
5470 file = build_string (data);
5471 XtFree (data);
5473 else
5474 file = Qnil;
5476 UNBLOCK_INPUT;
5477 UNGCPRO;
5479 /* Make "Cancel" equivalent to C-g. */
5480 if (NILP (file))
5481 Fsignal (Qquit, Qnil);
5483 decoded_file = DECODE_FILE (file);
5485 return unbind_to (count, decoded_file);
5488 #endif /* USE_MOTIF */
5490 #ifdef USE_GTK
5492 static Lisp_Object
5493 clean_up_dialog (Lisp_Object arg)
5495 x_menu_set_in_use (0);
5497 return Qnil;
5500 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5501 doc: /* Read file name, prompting with PROMPT in directory DIR.
5502 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5503 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5504 or directory must exist.
5506 This function is only defined on MS Windows, and X Windows with the
5507 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
5508 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5509 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
5511 FRAME_PTR f = SELECTED_FRAME ();
5512 char *fn;
5513 Lisp_Object file = Qnil;
5514 Lisp_Object decoded_file;
5515 int count = SPECPDL_INDEX ();
5516 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5517 char *cdef_file;
5519 check_x ();
5521 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5523 if (popup_activated ())
5524 error ("Trying to use a menu from within a menu-entry");
5526 CHECK_STRING (prompt);
5527 CHECK_STRING (dir);
5529 /* Prevent redisplay. */
5530 specbind (Qinhibit_redisplay, Qt);
5531 record_unwind_protect (clean_up_dialog, Qnil);
5533 BLOCK_INPUT;
5535 if (STRINGP (default_filename))
5536 cdef_file = SSDATA (default_filename);
5537 else
5538 cdef_file = SSDATA (dir);
5540 fn = xg_get_file_name (f, SSDATA (prompt), cdef_file,
5541 ! NILP (mustmatch),
5542 ! NILP (only_dir_p));
5544 if (fn)
5546 file = build_string (fn);
5547 xfree (fn);
5550 UNBLOCK_INPUT;
5551 UNGCPRO;
5553 /* Make "Cancel" equivalent to C-g. */
5554 if (NILP (file))
5555 Fsignal (Qquit, Qnil);
5557 decoded_file = DECODE_FILE (file);
5559 return unbind_to (count, decoded_file);
5563 #ifdef HAVE_FREETYPE
5565 DEFUN ("x-select-font", Fx_select_font, Sx_select_font, 0, 2, 0,
5566 doc: /* Read a font name using a GTK font selection dialog.
5567 Return a GTK-style font string corresponding to the selection.
5569 If FRAME is omitted or nil, it defaults to the selected frame. */)
5570 (Lisp_Object frame, Lisp_Object ignored)
5572 FRAME_PTR f = check_x_frame (frame);
5573 char *name;
5574 Lisp_Object font;
5575 Lisp_Object font_param;
5576 char *default_name = NULL;
5577 struct gcpro gcpro1, gcpro2;
5578 int count = SPECPDL_INDEX ();
5580 check_x ();
5582 if (popup_activated ())
5583 error ("Trying to use a menu from within a menu-entry");
5585 /* Prevent redisplay. */
5586 specbind (Qinhibit_redisplay, Qt);
5587 record_unwind_protect (clean_up_dialog, Qnil);
5589 BLOCK_INPUT;
5591 GCPRO2(font_param, font);
5593 XSETFONT (font, FRAME_FONT (f));
5594 font_param = Ffont_get (font, intern (":name"));
5595 if (STRINGP (font_param))
5596 default_name = xstrdup (SSDATA (font_param));
5597 else
5599 font_param = Fframe_parameter (frame, Qfont_param);
5600 if (STRINGP (font_param))
5601 default_name = xstrdup (SSDATA (font_param));
5604 if (default_name == NULL && x_last_font_name != NULL)
5605 default_name = xstrdup (x_last_font_name);
5607 /* Convert fontconfig names to Gtk names, i.e. remove - before number */
5608 if (default_name)
5610 char *p = strrchr (default_name, '-');
5611 if (p)
5613 char *ep = p+1;
5614 while (isdigit (*ep))
5615 ++ep;
5616 if (*ep == '\0') *p = ' ';
5620 name = xg_get_font_name (f, default_name);
5621 xfree (default_name);
5623 if (name)
5625 font = build_string (name);
5626 g_free (x_last_font_name);
5627 x_last_font_name = name;
5630 UNBLOCK_INPUT;
5632 if (NILP (font))
5633 Fsignal (Qquit, Qnil);
5635 return unbind_to (count, font);
5637 #endif /* HAVE_FREETYPE */
5639 #endif /* USE_GTK */
5642 /***********************************************************************
5643 Keyboard
5644 ***********************************************************************/
5646 #ifdef HAVE_XKBGETKEYBOARD
5647 #include <X11/XKBlib.h>
5648 #include <X11/keysym.h>
5649 #endif
5651 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
5652 Sx_backspace_delete_keys_p, 0, 1, 0,
5653 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
5654 FRAME nil means use the selected frame.
5655 Value is t if we know that both keys are present, and are mapped to the
5656 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
5657 present and mapped to the usual X keysyms. */)
5658 (Lisp_Object frame)
5660 #ifdef HAVE_XKBGETKEYBOARD
5661 XkbDescPtr kb;
5662 struct frame *f = check_x_frame (frame);
5663 Display *dpy = FRAME_X_DISPLAY (f);
5664 Lisp_Object have_keys;
5665 int major, minor, op, event, error_code;
5667 BLOCK_INPUT;
5669 /* Check library version in case we're dynamically linked. */
5670 major = XkbMajorVersion;
5671 minor = XkbMinorVersion;
5672 if (!XkbLibraryVersion (&major, &minor))
5674 UNBLOCK_INPUT;
5675 return Qlambda;
5678 /* Check that the server supports XKB. */
5679 major = XkbMajorVersion;
5680 minor = XkbMinorVersion;
5681 if (!XkbQueryExtension (dpy, &op, &event, &error_code, &major, &minor))
5683 UNBLOCK_INPUT;
5684 return Qlambda;
5687 /* In this code we check that the keyboard has physical keys with names
5688 that start with BKSP (Backspace) and DELE (Delete), and that they
5689 generate keysym XK_BackSpace and XK_Delete respectively.
5690 This function is used to test if normal-erase-is-backspace should be
5691 turned on.
5692 An alternative approach would be to just check if XK_BackSpace and
5693 XK_Delete are mapped to any key. But if any of those are mapped to
5694 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
5695 user doesn't know about it, it is better to return false here.
5696 It is more obvious to the user what to do if she/he has two keys
5697 clearly marked with names/symbols and one key does something not
5698 expected (i.e. she/he then tries the other).
5699 The cases where Backspace/Delete is mapped to some other key combination
5700 are rare, and in those cases, normal-erase-is-backspace can be turned on
5701 manually. */
5703 have_keys = Qnil;
5704 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
5705 if (kb)
5707 int delete_keycode = 0, backspace_keycode = 0, i;
5709 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
5711 for (i = kb->min_key_code;
5712 (i < kb->max_key_code
5713 && (delete_keycode == 0 || backspace_keycode == 0));
5714 ++i)
5716 /* The XKB symbolic key names can be seen most easily in
5717 the PS file generated by `xkbprint -label name
5718 $DISPLAY'. */
5719 if (memcmp ("DELE", kb->names->keys[i].name, 4) == 0)
5720 delete_keycode = i;
5721 else if (memcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
5722 backspace_keycode = i;
5725 XkbFreeNames (kb, 0, True);
5728 XkbFreeClientMap (kb, 0, True);
5730 if (delete_keycode
5731 && backspace_keycode
5732 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
5733 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
5734 have_keys = Qt;
5736 UNBLOCK_INPUT;
5737 return have_keys;
5738 #else /* not HAVE_XKBGETKEYBOARD */
5739 return Qlambda;
5740 #endif /* not HAVE_XKBGETKEYBOARD */
5745 /***********************************************************************
5746 Initialization
5747 ***********************************************************************/
5749 /* Keep this list in the same order as frame_parms in frame.c.
5750 Use 0 for unsupported frame parameters. */
5752 frame_parm_handler x_frame_parm_handlers[] =
5754 x_set_autoraise,
5755 x_set_autolower,
5756 x_set_background_color,
5757 x_set_border_color,
5758 x_set_border_width,
5759 x_set_cursor_color,
5760 x_set_cursor_type,
5761 x_set_font,
5762 x_set_foreground_color,
5763 x_set_icon_name,
5764 x_set_icon_type,
5765 x_set_internal_border_width,
5766 x_set_menu_bar_lines,
5767 x_set_mouse_color,
5768 x_explicitly_set_name,
5769 x_set_scroll_bar_width,
5770 x_set_title,
5771 x_set_unsplittable,
5772 x_set_vertical_scroll_bars,
5773 x_set_visibility,
5774 x_set_tool_bar_lines,
5775 x_set_scroll_bar_foreground,
5776 x_set_scroll_bar_background,
5777 x_set_screen_gamma,
5778 x_set_line_spacing,
5779 x_set_fringe_width,
5780 x_set_fringe_width,
5781 x_set_wait_for_wm,
5782 x_set_fullscreen,
5783 x_set_font_backend,
5784 x_set_alpha,
5785 x_set_sticky,
5786 x_set_tool_bar_position,
5789 void
5790 syms_of_xfns (void)
5792 /* This is zero if not using X windows. */
5793 x_in_use = 0;
5795 /* The section below is built by the lisp expression at the top of the file,
5796 just above where these variables are declared. */
5797 /*&&& init symbols here &&&*/
5798 Qnone = intern_c_string ("none");
5799 staticpro (&Qnone);
5800 Qsuppress_icon = intern_c_string ("suppress-icon");
5801 staticpro (&Qsuppress_icon);
5802 Qundefined_color = intern_c_string ("undefined-color");
5803 staticpro (&Qundefined_color);
5804 Qcompound_text = intern_c_string ("compound-text");
5805 staticpro (&Qcompound_text);
5806 Qcancel_timer = intern_c_string ("cancel-timer");
5807 staticpro (&Qcancel_timer);
5808 Qfont_param = intern_c_string ("font-parameter");
5809 staticpro (&Qfont_param);
5810 /* This is the end of symbol initialization. */
5812 /* Text property `display' should be nonsticky by default. */
5813 Vtext_property_default_nonsticky
5814 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
5817 Fput (Qundefined_color, Qerror_conditions,
5818 pure_cons (Qundefined_color, pure_cons (Qerror, Qnil)));
5819 Fput (Qundefined_color, Qerror_message,
5820 make_pure_c_string ("Undefined color"));
5822 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
5823 doc: /* The shape of the pointer when over text.
5824 Changing the value does not affect existing frames
5825 unless you set the mouse color. */);
5826 Vx_pointer_shape = Qnil;
5828 #if 0 /* This doesn't really do anything. */
5829 DEFVAR_LISP ("x-nontext-pointer-shape", Vx_nontext_pointer_shape,
5830 doc: /* The shape of the pointer when not over text.
5831 This variable takes effect when you create a new frame
5832 or when you set the mouse color. */);
5833 #endif
5834 Vx_nontext_pointer_shape = Qnil;
5836 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
5837 doc: /* The shape of the pointer when Emacs is busy.
5838 This variable takes effect when you create a new frame
5839 or when you set the mouse color. */);
5840 Vx_hourglass_pointer_shape = Qnil;
5842 #if 0 /* This doesn't really do anything. */
5843 DEFVAR_LISP ("x-mode-pointer-shape", Vx_mode_pointer_shape,
5844 doc: /* The shape of the pointer when over the mode line.
5845 This variable takes effect when you create a new frame
5846 or when you set the mouse color. */);
5847 #endif
5848 Vx_mode_pointer_shape = Qnil;
5850 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
5851 Vx_sensitive_text_pointer_shape,
5852 doc: /* The shape of the pointer when over mouse-sensitive text.
5853 This variable takes effect when you create a new frame
5854 or when you set the mouse color. */);
5855 Vx_sensitive_text_pointer_shape = Qnil;
5857 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
5858 Vx_window_horizontal_drag_shape,
5859 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
5860 This variable takes effect when you create a new frame
5861 or when you set the mouse color. */);
5862 Vx_window_horizontal_drag_shape = Qnil;
5864 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
5865 doc: /* A string indicating the foreground color of the cursor box. */);
5866 Vx_cursor_fore_pixel = Qnil;
5868 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
5869 doc: /* Maximum size for tooltips.
5870 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
5871 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
5873 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
5874 doc: /* Non-nil if no X window manager is in use.
5875 Emacs doesn't try to figure this out; this is always nil
5876 unless you set it to something else. */);
5877 /* We don't have any way to find this out, so set it to nil
5878 and maybe the user would like to set it to t. */
5879 Vx_no_window_manager = Qnil;
5881 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
5882 Vx_pixel_size_width_font_regexp,
5883 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
5885 Since Emacs gets width of a font matching with this regexp from
5886 PIXEL_SIZE field of the name, font finding mechanism gets faster for
5887 such a font. This is especially effective for such large fonts as
5888 Chinese, Japanese, and Korean. */);
5889 Vx_pixel_size_width_font_regexp = Qnil;
5891 /* This is not ifdef:ed, so other builds than GTK can customize it. */
5892 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", x_gtk_use_old_file_dialog,
5893 doc: /* *Non-nil means prompt with the old GTK file selection dialog.
5894 If nil or if the file selection dialog is not available, the new GTK file
5895 chooser is used instead. To turn off all file dialogs set the
5896 variable `use-file-dialog'. */);
5897 x_gtk_use_old_file_dialog = 0;
5899 DEFVAR_BOOL ("x-gtk-show-hidden-files", x_gtk_show_hidden_files,
5900 doc: /* *If non-nil, the GTK file chooser will by default show hidden files.
5901 Note that this is just the default, there is a toggle button on the file
5902 chooser to show or not show hidden files on a case by case basis. */);
5903 x_gtk_show_hidden_files = 0;
5905 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", x_gtk_file_dialog_help_text,
5906 doc: /* *If non-nil, the GTK file chooser will show additional help text.
5907 If more space for files in the file chooser dialog is wanted, set this to nil
5908 to turn the additional text off. */);
5909 x_gtk_file_dialog_help_text = 1;
5911 DEFVAR_BOOL ("x-gtk-whole-detached-tool-bar", x_gtk_whole_detached_tool_bar,
5912 doc: /* *If non-nil, a detached tool bar is shown in full.
5913 The default is to just show an arrow and pressing on that arrow shows
5914 the tool bar buttons. */);
5915 x_gtk_whole_detached_tool_bar = 0;
5917 DEFVAR_BOOL ("x-gtk-use-system-tooltips", x_gtk_use_system_tooltips,
5918 doc: /* *If non-nil with a Gtk+ built Emacs, the Gtk+ toolip is used.
5919 Otherwise use Emacs own tooltip implementation.
5920 When using Gtk+ tooltips, the tooltip face is not used. */);
5921 x_gtk_use_system_tooltips = 1;
5923 Fprovide (intern_c_string ("x"), Qnil);
5925 #ifdef USE_X_TOOLKIT
5926 Fprovide (intern_c_string ("x-toolkit"), Qnil);
5927 #ifdef USE_MOTIF
5928 Fprovide (intern_c_string ("motif"), Qnil);
5930 DEFVAR_LISP ("motif-version-string", Vmotif_version_string,
5931 doc: /* Version info for LessTif/Motif. */);
5932 Vmotif_version_string = build_string (XmVERSION_STRING);
5933 #endif /* USE_MOTIF */
5934 #endif /* USE_X_TOOLKIT */
5936 #ifdef USE_GTK
5937 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
5938 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
5939 But for a user it is a toolkit for X, and indeed, configure
5940 accepts --with-x-toolkit=gtk. */
5941 Fprovide (intern_c_string ("x-toolkit"), Qnil);
5942 Fprovide (intern_c_string ("gtk"), Qnil);
5943 Fprovide (intern_c_string ("move-toolbar"), Qnil);
5945 DEFVAR_LISP ("gtk-version-string", Vgtk_version_string,
5946 doc: /* Version info for GTK+. */);
5948 char gtk_version[40];
5949 g_snprintf (gtk_version, sizeof (gtk_version), "%u.%u.%u",
5950 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
5951 Vgtk_version_string = make_pure_string (gtk_version, strlen (gtk_version), strlen (gtk_version), 0);
5953 #endif /* USE_GTK */
5955 /* X window properties. */
5956 defsubr (&Sx_change_window_property);
5957 defsubr (&Sx_delete_window_property);
5958 defsubr (&Sx_window_property);
5960 defsubr (&Sxw_display_color_p);
5961 defsubr (&Sx_display_grayscale_p);
5962 defsubr (&Sxw_color_defined_p);
5963 defsubr (&Sxw_color_values);
5964 defsubr (&Sx_server_max_request_size);
5965 defsubr (&Sx_server_vendor);
5966 defsubr (&Sx_server_version);
5967 defsubr (&Sx_display_pixel_width);
5968 defsubr (&Sx_display_pixel_height);
5969 defsubr (&Sx_display_mm_width);
5970 defsubr (&Sx_display_mm_height);
5971 defsubr (&Sx_display_screens);
5972 defsubr (&Sx_display_planes);
5973 defsubr (&Sx_display_color_cells);
5974 defsubr (&Sx_display_visual_class);
5975 defsubr (&Sx_display_backing_store);
5976 defsubr (&Sx_display_save_under);
5977 defsubr (&Sx_wm_set_size_hint);
5978 defsubr (&Sx_create_frame);
5979 defsubr (&Sx_open_connection);
5980 defsubr (&Sx_close_connection);
5981 defsubr (&Sx_display_list);
5982 defsubr (&Sx_synchronize);
5983 defsubr (&Sx_focus_frame);
5984 defsubr (&Sx_backspace_delete_keys_p);
5986 /* Setting callback functions for fontset handler. */
5987 check_window_system_func = check_x;
5989 defsubr (&Sx_show_tip);
5990 defsubr (&Sx_hide_tip);
5991 tip_timer = Qnil;
5992 staticpro (&tip_timer);
5993 tip_frame = Qnil;
5994 staticpro (&tip_frame);
5996 last_show_tip_args = Qnil;
5997 staticpro (&last_show_tip_args);
5999 defsubr (&Sx_uses_old_gtk_dialog);
6000 #if defined (USE_MOTIF) || defined (USE_GTK)
6001 defsubr (&Sx_file_dialog);
6002 #endif
6004 #if defined (USE_GTK) && defined (HAVE_FREETYPE)
6005 defsubr (&Sx_select_font);
6006 x_last_font_name = NULL;
6007 #endif
6010 #endif /* HAVE_X_WINDOWS */