(enable-local-variables): Doc fix.
[emacs.git] / src / xfns.c
blob9f221efb5dee69bfdd73119e2e20f4dd4f2c1ddc
1 /* Functions for the X window system.
2 Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005, 2006 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 2, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 #include <config.h>
23 #include <stdio.h>
24 #include <math.h>
26 #ifdef HAVE_UNISTD_H
27 #include <unistd.h>
28 #endif
30 /* This makes the fields of a Display accessible, in Xlib header files. */
32 #define XLIB_ILLEGAL_ACCESS
34 #include "lisp.h"
35 #include "xterm.h"
36 #include "frame.h"
37 #include "window.h"
38 #include "buffer.h"
39 #include "intervals.h"
40 #include "dispextern.h"
41 #include "keyboard.h"
42 #include "blockinput.h"
43 #include <epaths.h>
44 #include "charset.h"
45 #include "coding.h"
46 #include "fontset.h"
47 #include "systime.h"
48 #include "termhooks.h"
49 #include "atimer.h"
51 #ifdef HAVE_X_WINDOWS
53 #include <ctype.h>
54 #include <sys/types.h>
55 #include <sys/stat.h>
57 #ifndef VMS
58 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
59 #include "bitmaps/gray.xbm"
60 #else
61 #include <X11/bitmaps/gray>
62 #endif
63 #else
64 #include "[.bitmaps]gray.xbm"
65 #endif
67 #ifdef USE_GTK
68 #include "gtkutil.h"
69 #endif
71 #ifdef USE_X_TOOLKIT
72 #include <X11/Shell.h>
74 #ifndef USE_MOTIF
75 #include <X11/Xaw/Paned.h>
76 #include <X11/Xaw/Label.h>
77 #endif /* USE_MOTIF */
79 #ifdef USG
80 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
81 #include <X11/Xos.h>
82 #define USG
83 #else
84 #include <X11/Xos.h>
85 #endif
87 #include "widget.h"
89 #include "../lwlib/lwlib.h"
91 #ifdef USE_MOTIF
92 #include <Xm/Xm.h>
93 #include <Xm/DialogS.h>
94 #include <Xm/FileSB.h>
95 #endif
97 /* Do the EDITRES protocol if running X11R5
98 Exception: HP-UX (at least version A.09.05) has X11R5 without EditRes */
100 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
101 #define HACK_EDITRES
102 extern void _XEditResCheckMessages ();
103 #endif /* R5 + Athena */
105 /* Unique id counter for widgets created by the Lucid Widget Library. */
107 extern LWLIB_ID widget_id_tick;
109 #ifdef USE_LUCID
110 /* This is part of a kludge--see lwlib/xlwmenu.c. */
111 extern XFontStruct *xlwmenu_default_font;
112 #endif
114 extern void free_frame_menubar ();
115 extern double atof ();
117 #ifdef USE_MOTIF
119 /* LessTif/Motif version info. */
121 static Lisp_Object Vmotif_version_string;
123 #endif /* USE_MOTIF */
125 #endif /* USE_X_TOOLKIT */
127 #ifdef USE_GTK
129 /* GTK+ version info */
131 static Lisp_Object Vgtk_version_string;
133 #endif /* USE_GTK */
135 #ifdef HAVE_X11R4
136 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
137 #else
138 #define MAXREQUEST(dpy) ((dpy)->max_request_size)
139 #endif
141 /* The gray bitmap `bitmaps/gray'. This is done because xterm.c uses
142 it, and including `bitmaps/gray' more than once is a problem when
143 config.h defines `static' as an empty replacement string. */
145 int gray_bitmap_width = gray_width;
146 int gray_bitmap_height = gray_height;
147 char *gray_bitmap_bits = gray_bits;
149 /* Non-zero means we're allowed to display an hourglass cursor. */
151 int display_hourglass_p;
153 /* Non-zero means prompt with the old GTK file selection dialog. */
155 int x_use_old_gtk_file_dialog;
157 /* If non-zero, by default show hidden files in the GTK file chooser. */
159 int x_gtk_show_hidden_files;
161 /* If non-zero, don't collapse to tool bar when it is detached. */
163 int x_gtk_whole_detached_tool_bar;
165 /* The background and shape of the mouse pointer, and shape when not
166 over text or in the modeline. */
168 Lisp_Object Vx_pointer_shape, Vx_nontext_pointer_shape, Vx_mode_pointer_shape;
169 Lisp_Object Vx_hourglass_pointer_shape;
171 /* The shape when over mouse-sensitive text. */
173 Lisp_Object Vx_sensitive_text_pointer_shape;
175 /* If non-nil, the pointer shape to indicate that windows can be
176 dragged horizontally. */
178 Lisp_Object Vx_window_horizontal_drag_shape;
180 /* Color of chars displayed in cursor box. */
182 Lisp_Object Vx_cursor_fore_pixel;
184 /* Nonzero if using X. */
186 static int x_in_use;
188 /* Non nil if no window manager is in use. */
190 Lisp_Object Vx_no_window_manager;
192 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
194 Lisp_Object Vx_pixel_size_width_font_regexp;
196 Lisp_Object Qnone;
197 Lisp_Object Qsuppress_icon;
198 Lisp_Object Qundefined_color;
199 Lisp_Object Qcompound_text, Qcancel_timer;
201 /* In dispnew.c */
203 extern Lisp_Object Vwindow_system_version;
205 /* The below are defined in frame.c. */
207 #if GLYPH_DEBUG
208 int image_cache_refcount, dpyinfo_refcount;
209 #endif
213 /* Error if we are not connected to X. */
215 void
216 check_x ()
218 if (! x_in_use)
219 error ("X windows are not in use or not initialized");
222 /* Nonzero if we can use mouse menus.
223 You should not call this unless HAVE_MENUS is defined. */
226 have_menus_p ()
228 return x_in_use;
231 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
232 and checking validity for X. */
234 FRAME_PTR
235 check_x_frame (frame)
236 Lisp_Object frame;
238 FRAME_PTR f;
240 if (NILP (frame))
241 frame = selected_frame;
242 CHECK_LIVE_FRAME (frame);
243 f = XFRAME (frame);
244 if (! FRAME_X_P (f))
245 error ("Non-X frame used");
246 return f;
249 /* Let the user specify an X display with a frame.
250 nil stands for the selected frame--or, if that is not an X frame,
251 the first X display on the list. */
253 struct x_display_info *
254 check_x_display_info (frame)
255 Lisp_Object frame;
257 struct x_display_info *dpyinfo = NULL;
259 if (NILP (frame))
261 struct frame *sf = XFRAME (selected_frame);
263 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
264 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
265 else if (x_display_list != 0)
266 dpyinfo = x_display_list;
267 else
268 error ("X windows are not in use or not initialized");
270 else if (STRINGP (frame))
271 dpyinfo = x_display_info_for_name (frame);
272 else
274 FRAME_PTR f = check_x_frame (frame);
275 dpyinfo = FRAME_X_DISPLAY_INFO (f);
278 return dpyinfo;
282 /* Return the Emacs frame-object corresponding to an X window.
283 It could be the frame's main window or an icon window. */
285 /* This function can be called during GC, so use GC_xxx type test macros. */
287 struct frame *
288 x_window_to_frame (dpyinfo, wdesc)
289 struct x_display_info *dpyinfo;
290 int wdesc;
292 Lisp_Object tail, frame;
293 struct frame *f;
295 if (wdesc == None) return 0;
297 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
299 frame = XCAR (tail);
300 if (!GC_FRAMEP (frame))
301 continue;
302 f = XFRAME (frame);
303 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
304 continue;
305 if (f->output_data.x->hourglass_window == wdesc)
306 return f;
307 #ifdef USE_X_TOOLKIT
308 if ((f->output_data.x->edit_widget
309 && XtWindow (f->output_data.x->edit_widget) == wdesc)
310 /* A tooltip frame? */
311 || (!f->output_data.x->edit_widget
312 && FRAME_X_WINDOW (f) == wdesc)
313 || f->output_data.x->icon_desc == wdesc)
314 return f;
315 #else /* not USE_X_TOOLKIT */
316 #ifdef USE_GTK
317 if (f->output_data.x->edit_widget)
319 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
320 struct x_output *x = f->output_data.x;
321 if (gwdesc != 0 && gwdesc == x->edit_widget)
322 return f;
324 #endif /* USE_GTK */
325 if (FRAME_X_WINDOW (f) == wdesc
326 || f->output_data.x->icon_desc == wdesc)
327 return f;
328 #endif /* not USE_X_TOOLKIT */
330 return 0;
333 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
334 /* Like x_window_to_frame but also compares the window with the widget's
335 windows. */
337 struct frame *
338 x_any_window_to_frame (dpyinfo, wdesc)
339 struct x_display_info *dpyinfo;
340 int wdesc;
342 Lisp_Object tail, frame;
343 struct frame *f, *found;
344 struct x_output *x;
346 if (wdesc == None) return NULL;
348 found = NULL;
349 for (tail = Vframe_list; GC_CONSP (tail) && !found; tail = XCDR (tail))
351 frame = XCAR (tail);
352 if (!GC_FRAMEP (frame))
353 continue;
355 f = XFRAME (frame);
356 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
358 /* This frame matches if the window is any of its widgets. */
359 x = f->output_data.x;
360 if (x->hourglass_window == wdesc)
361 found = f;
362 else if (x->widget)
364 #ifdef USE_GTK
365 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
366 if (gwdesc != 0
367 && (gwdesc == x->widget
368 || gwdesc == x->edit_widget
369 || gwdesc == x->vbox_widget
370 || gwdesc == x->menubar_widget))
371 found = f;
372 #else
373 if (wdesc == XtWindow (x->widget)
374 || wdesc == XtWindow (x->column_widget)
375 || wdesc == XtWindow (x->edit_widget))
376 found = f;
377 /* Match if the window is this frame's menubar. */
378 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
379 found = f;
380 #endif
382 else if (FRAME_X_WINDOW (f) == wdesc)
383 /* A tooltip frame. */
384 found = f;
388 return found;
391 /* Likewise, but exclude the menu bar widget. */
393 struct frame *
394 x_non_menubar_window_to_frame (dpyinfo, wdesc)
395 struct x_display_info *dpyinfo;
396 int wdesc;
398 Lisp_Object tail, frame;
399 struct frame *f;
400 struct x_output *x;
402 if (wdesc == None) return 0;
404 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
406 frame = XCAR (tail);
407 if (!GC_FRAMEP (frame))
408 continue;
409 f = XFRAME (frame);
410 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
411 continue;
412 x = f->output_data.x;
413 /* This frame matches if the window is any of its widgets. */
414 if (x->hourglass_window == wdesc)
415 return f;
416 else if (x->widget)
418 #ifdef USE_GTK
419 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
420 if (gwdesc != 0
421 && (gwdesc == x->widget
422 || gwdesc == x->edit_widget
423 || gwdesc == x->vbox_widget))
424 return f;
425 #else
426 if (wdesc == XtWindow (x->widget)
427 || wdesc == XtWindow (x->column_widget)
428 || wdesc == XtWindow (x->edit_widget))
429 return f;
430 #endif
432 else if (FRAME_X_WINDOW (f) == wdesc)
433 /* A tooltip frame. */
434 return f;
436 return 0;
439 /* Likewise, but consider only the menu bar widget. */
441 struct frame *
442 x_menubar_window_to_frame (dpyinfo, wdesc)
443 struct x_display_info *dpyinfo;
444 int wdesc;
446 Lisp_Object tail, frame;
447 struct frame *f;
448 struct x_output *x;
450 if (wdesc == None) return 0;
452 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
454 frame = XCAR (tail);
455 if (!GC_FRAMEP (frame))
456 continue;
457 f = XFRAME (frame);
458 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
459 continue;
460 x = f->output_data.x;
461 /* Match if the window is this frame's menubar. */
462 #ifdef USE_GTK
463 if (x->menubar_widget)
465 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
466 int found = 0;
468 BLOCK_INPUT;
469 if (gwdesc != 0
470 && (gwdesc == x->menubar_widget
471 || gtk_widget_get_parent (gwdesc) == x->menubar_widget))
472 found = 1;
473 UNBLOCK_INPUT;
474 if (found) return f;
476 #else
477 if (x->menubar_widget
478 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
479 return f;
480 #endif
482 return 0;
485 /* Return the frame whose principal (outermost) window is WDESC.
486 If WDESC is some other (smaller) window, we return 0. */
488 struct frame *
489 x_top_window_to_frame (dpyinfo, wdesc)
490 struct x_display_info *dpyinfo;
491 int wdesc;
493 Lisp_Object tail, frame;
494 struct frame *f;
495 struct x_output *x;
497 if (wdesc == None) return 0;
499 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
501 frame = XCAR (tail);
502 if (!GC_FRAMEP (frame))
503 continue;
504 f = XFRAME (frame);
505 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
506 continue;
507 x = f->output_data.x;
509 if (x->widget)
511 /* This frame matches if the window is its topmost widget. */
512 #ifdef USE_GTK
513 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
514 if (gwdesc == x->widget)
515 return f;
516 #else
517 if (wdesc == XtWindow (x->widget))
518 return f;
519 #if 0 /* I don't know why it did this,
520 but it seems logically wrong,
521 and it causes trouble for MapNotify events. */
522 /* Match if the window is this frame's menubar. */
523 if (x->menubar_widget
524 && wdesc == XtWindow (x->menubar_widget))
525 return f;
526 #endif
527 #endif
529 else if (FRAME_X_WINDOW (f) == wdesc)
530 /* Tooltip frame. */
531 return f;
533 return 0;
535 #endif /* USE_X_TOOLKIT || USE_GTK */
539 static Lisp_Object unwind_create_frame P_ ((Lisp_Object));
540 static Lisp_Object unwind_create_tip_frame P_ ((Lisp_Object));
542 void x_set_foreground_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
543 static void x_set_wait_for_wm P_ ((struct frame *, Lisp_Object, Lisp_Object));
544 void x_set_background_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
545 void x_set_mouse_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
546 void x_set_cursor_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
547 void x_set_border_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
548 void x_set_cursor_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
549 void x_set_icon_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
550 void x_set_icon_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
551 void x_explicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
552 void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
553 void x_set_title P_ ((struct frame *, Lisp_Object, Lisp_Object));
554 void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
555 void x_set_scroll_bar_foreground P_ ((struct frame *, Lisp_Object,
556 Lisp_Object));
557 void x_set_scroll_bar_background P_ ((struct frame *, Lisp_Object,
558 Lisp_Object));
559 static Lisp_Object x_default_scroll_bar_color_parameter P_ ((struct frame *,
560 Lisp_Object,
561 Lisp_Object,
562 char *, char *,
563 int));
566 /* Store the screen positions of frame F into XPTR and YPTR.
567 These are the positions of the containing window manager window,
568 not Emacs's own window. */
570 void
571 x_real_positions (f, xptr, yptr)
572 FRAME_PTR f;
573 int *xptr, *yptr;
575 int win_x, win_y, outer_x, outer_y;
576 int real_x = 0, real_y = 0;
577 int had_errors = 0;
578 Window win = f->output_data.x->parent_desc;
580 int count;
582 BLOCK_INPUT;
584 count = x_catch_errors (FRAME_X_DISPLAY (f));
586 if (win == FRAME_X_DISPLAY_INFO (f)->root_window)
587 win = FRAME_OUTER_WINDOW (f);
589 /* This loop traverses up the containment tree until we hit the root
590 window. Window managers may intersect many windows between our window
591 and the root window. The window we find just before the root window
592 should be the outer WM window. */
593 for (;;)
595 Window wm_window, rootw;
596 Window *tmp_children;
597 unsigned int tmp_nchildren;
598 int success;
600 success = XQueryTree (FRAME_X_DISPLAY (f), win, &rootw,
601 &wm_window, &tmp_children, &tmp_nchildren);
603 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
605 /* Don't free tmp_children if XQueryTree failed. */
606 if (! success)
607 break;
609 XFree ((char *) tmp_children);
611 if (wm_window == rootw || had_errors)
612 break;
614 win = wm_window;
617 if (! had_errors)
619 unsigned int ign;
620 Window child, rootw;
622 /* Get the real coordinates for the WM window upper left corner */
623 XGetGeometry (FRAME_X_DISPLAY (f), win,
624 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
626 /* Translate real coordinates to coordinates relative to our
627 window. For our window, the upper left corner is 0, 0.
628 Since the upper left corner of the WM window is outside
629 our window, win_x and win_y will be negative:
631 ------------------ ---> x
632 | title |
633 | ----------------- v y
634 | | our window
636 XTranslateCoordinates (FRAME_X_DISPLAY (f),
638 /* From-window, to-window. */
639 FRAME_X_DISPLAY_INFO (f)->root_window,
640 FRAME_X_WINDOW (f),
642 /* From-position, to-position. */
643 real_x, real_y, &win_x, &win_y,
645 /* Child of win. */
646 &child);
648 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
650 outer_x = win_x;
651 outer_y = win_y;
653 else
655 XTranslateCoordinates (FRAME_X_DISPLAY (f),
657 /* From-window, to-window. */
658 FRAME_X_DISPLAY_INFO (f)->root_window,
659 FRAME_OUTER_WINDOW (f),
661 /* From-position, to-position. */
662 real_x, real_y, &outer_x, &outer_y,
664 /* Child of win. */
665 &child);
668 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
671 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
673 UNBLOCK_INPUT;
675 if (had_errors) return;
677 f->x_pixels_diff = -win_x;
678 f->y_pixels_diff = -win_y;
680 FRAME_X_OUTPUT (f)->x_pixels_outer_diff = -outer_x;
681 FRAME_X_OUTPUT (f)->y_pixels_outer_diff = -outer_y;
683 *xptr = real_x;
684 *yptr = real_y;
690 /* Gamma-correct COLOR on frame F. */
692 void
693 gamma_correct (f, color)
694 struct frame *f;
695 XColor *color;
697 if (f->gamma)
699 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
700 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
701 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
706 /* Decide if color named COLOR_NAME is valid for use on frame F. If
707 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
708 allocate the color. Value is zero if COLOR_NAME is invalid, or
709 no color could be allocated. */
712 x_defined_color (f, color_name, color, alloc_p)
713 struct frame *f;
714 char *color_name;
715 XColor *color;
716 int alloc_p;
718 int success_p;
719 Display *dpy = FRAME_X_DISPLAY (f);
720 Colormap cmap = FRAME_X_COLORMAP (f);
722 BLOCK_INPUT;
723 success_p = XParseColor (dpy, cmap, color_name, color);
724 if (success_p && alloc_p)
725 success_p = x_alloc_nearest_color (f, cmap, color);
726 UNBLOCK_INPUT;
728 return success_p;
732 /* Return the pixel color value for color COLOR_NAME on frame F. If F
733 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
734 Signal an error if color can't be allocated. */
737 x_decode_color (f, color_name, mono_color)
738 FRAME_PTR f;
739 Lisp_Object color_name;
740 int mono_color;
742 XColor cdef;
744 CHECK_STRING (color_name);
746 #if 0 /* Don't do this. It's wrong when we're not using the default
747 colormap, it makes freeing difficult, and it's probably not
748 an important optimization. */
749 if (strcmp (SDATA (color_name), "black") == 0)
750 return BLACK_PIX_DEFAULT (f);
751 else if (strcmp (SDATA (color_name), "white") == 0)
752 return WHITE_PIX_DEFAULT (f);
753 #endif
755 /* Return MONO_COLOR for monochrome frames. */
756 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
757 return mono_color;
759 /* x_defined_color is responsible for coping with failures
760 by looking for a near-miss. */
761 if (x_defined_color (f, SDATA (color_name), &cdef, 1))
762 return cdef.pixel;
764 Fsignal (Qerror, Fcons (build_string ("Undefined color"),
765 Fcons (color_name, Qnil)));
766 return 0;
771 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
772 the previous value of that parameter, NEW_VALUE is the new value.
773 See also the comment of wait_for_wm in struct x_output. */
775 static void
776 x_set_wait_for_wm (f, new_value, old_value)
777 struct frame *f;
778 Lisp_Object new_value, old_value;
780 f->output_data.x->wait_for_wm = !NILP (new_value);
783 #ifdef USE_GTK
785 /* Set icon from FILE for frame F. By using GTK functions the icon
786 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
789 xg_set_icon (f, file)
790 FRAME_PTR f;
791 Lisp_Object file;
793 struct gcpro gcpro1;
794 int result = 0;
795 Lisp_Object found;
797 GCPRO1 (found);
799 found = x_find_image_file (file);
801 if (! NILP (found))
803 GdkPixbuf *pixbuf;
804 GError *err = NULL;
805 char *filename = (char *) SDATA (found);
806 BLOCK_INPUT;
808 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
810 if (pixbuf)
812 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
813 pixbuf);
814 g_object_unref (pixbuf);
816 result = 1;
818 else
819 g_error_free (err);
821 UNBLOCK_INPUT;
824 UNGCPRO;
825 return result;
829 xg_set_icon_from_xpm_data (f, data)
830 FRAME_PTR f;
831 char **data;
833 int result = 0;
834 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data ((const char **) data);
836 if (!pixbuf)
837 return 0;
839 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), pixbuf);
840 g_object_unref (pixbuf);
841 return 1;
843 #endif /* USE_GTK */
846 /* Functions called only from `x_set_frame_param'
847 to set individual parameters.
849 If FRAME_X_WINDOW (f) is 0,
850 the frame is being created and its X-window does not exist yet.
851 In that case, just record the parameter's new value
852 in the standard place; do not attempt to change the window. */
854 void
855 x_set_foreground_color (f, arg, oldval)
856 struct frame *f;
857 Lisp_Object arg, oldval;
859 struct x_output *x = f->output_data.x;
860 unsigned long fg, old_fg;
862 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
863 old_fg = x->foreground_pixel;
864 x->foreground_pixel = fg;
866 if (FRAME_X_WINDOW (f) != 0)
868 Display *dpy = FRAME_X_DISPLAY (f);
870 BLOCK_INPUT;
871 XSetForeground (dpy, x->normal_gc, fg);
872 XSetBackground (dpy, x->reverse_gc, fg);
874 if (x->cursor_pixel == old_fg)
876 unload_color (f, x->cursor_pixel);
877 x->cursor_pixel = x_copy_color (f, fg);
878 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
881 UNBLOCK_INPUT;
883 update_face_from_frame_parameter (f, Qforeground_color, arg);
885 if (FRAME_VISIBLE_P (f))
886 redraw_frame (f);
889 unload_color (f, old_fg);
892 void
893 x_set_background_color (f, arg, oldval)
894 struct frame *f;
895 Lisp_Object arg, oldval;
897 struct x_output *x = f->output_data.x;
898 unsigned long bg;
900 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
901 unload_color (f, x->background_pixel);
902 x->background_pixel = bg;
904 if (FRAME_X_WINDOW (f) != 0)
906 Display *dpy = FRAME_X_DISPLAY (f);
908 BLOCK_INPUT;
909 XSetBackground (dpy, x->normal_gc, bg);
910 XSetForeground (dpy, x->reverse_gc, bg);
911 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
912 XSetForeground (dpy, x->cursor_gc, bg);
914 #ifdef USE_GTK
915 xg_set_background_color (f, bg);
916 #endif
918 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
919 toolkit scroll bars. */
921 Lisp_Object bar;
922 for (bar = FRAME_SCROLL_BARS (f);
923 !NILP (bar);
924 bar = XSCROLL_BAR (bar)->next)
926 Window window = SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar));
927 XSetWindowBackground (dpy, window, bg);
930 #endif /* USE_TOOLKIT_SCROLL_BARS */
932 UNBLOCK_INPUT;
933 update_face_from_frame_parameter (f, Qbackground_color, arg);
935 if (FRAME_VISIBLE_P (f))
936 redraw_frame (f);
940 void
941 x_set_mouse_color (f, arg, oldval)
942 struct frame *f;
943 Lisp_Object arg, oldval;
945 struct x_output *x = f->output_data.x;
946 Display *dpy = FRAME_X_DISPLAY (f);
947 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
948 Cursor hourglass_cursor, horizontal_drag_cursor;
949 int count;
950 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
951 unsigned long mask_color = x->background_pixel;
953 /* Don't let pointers be invisible. */
954 if (mask_color == pixel)
956 x_free_colors (f, &pixel, 1);
957 pixel = x_copy_color (f, x->foreground_pixel);
960 unload_color (f, x->mouse_pixel);
961 x->mouse_pixel = pixel;
963 BLOCK_INPUT;
965 /* It's not okay to crash if the user selects a screwy cursor. */
966 count = x_catch_errors (dpy);
968 if (!NILP (Vx_pointer_shape))
970 CHECK_NUMBER (Vx_pointer_shape);
971 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
973 else
974 cursor = XCreateFontCursor (dpy, XC_xterm);
975 x_check_errors (dpy, "bad text pointer cursor: %s");
977 if (!NILP (Vx_nontext_pointer_shape))
979 CHECK_NUMBER (Vx_nontext_pointer_shape);
980 nontext_cursor
981 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
983 else
984 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
985 x_check_errors (dpy, "bad nontext pointer cursor: %s");
987 if (!NILP (Vx_hourglass_pointer_shape))
989 CHECK_NUMBER (Vx_hourglass_pointer_shape);
990 hourglass_cursor
991 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
993 else
994 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
995 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
997 if (!NILP (Vx_mode_pointer_shape))
999 CHECK_NUMBER (Vx_mode_pointer_shape);
1000 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
1002 else
1003 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
1004 x_check_errors (dpy, "bad modeline pointer cursor: %s");
1006 if (!NILP (Vx_sensitive_text_pointer_shape))
1008 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
1009 hand_cursor
1010 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
1012 else
1013 hand_cursor = XCreateFontCursor (dpy, XC_hand2);
1015 if (!NILP (Vx_window_horizontal_drag_shape))
1017 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
1018 horizontal_drag_cursor
1019 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
1021 else
1022 horizontal_drag_cursor
1023 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
1025 /* Check and report errors with the above calls. */
1026 x_check_errors (dpy, "can't set cursor shape: %s");
1027 x_uncatch_errors (dpy, count);
1030 XColor fore_color, back_color;
1032 fore_color.pixel = x->mouse_pixel;
1033 x_query_color (f, &fore_color);
1034 back_color.pixel = mask_color;
1035 x_query_color (f, &back_color);
1037 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
1038 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
1039 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
1040 XRecolorCursor (dpy, hand_cursor, &fore_color, &back_color);
1041 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
1042 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
1045 if (FRAME_X_WINDOW (f) != 0)
1046 XDefineCursor (dpy, FRAME_X_WINDOW (f), cursor);
1048 if (cursor != x->text_cursor
1049 && x->text_cursor != 0)
1050 XFreeCursor (dpy, x->text_cursor);
1051 x->text_cursor = cursor;
1053 if (nontext_cursor != x->nontext_cursor
1054 && x->nontext_cursor != 0)
1055 XFreeCursor (dpy, x->nontext_cursor);
1056 x->nontext_cursor = nontext_cursor;
1058 if (hourglass_cursor != x->hourglass_cursor
1059 && x->hourglass_cursor != 0)
1060 XFreeCursor (dpy, x->hourglass_cursor);
1061 x->hourglass_cursor = hourglass_cursor;
1063 if (mode_cursor != x->modeline_cursor
1064 && x->modeline_cursor != 0)
1065 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
1066 x->modeline_cursor = mode_cursor;
1068 if (hand_cursor != x->hand_cursor
1069 && x->hand_cursor != 0)
1070 XFreeCursor (dpy, x->hand_cursor);
1071 x->hand_cursor = hand_cursor;
1073 if (horizontal_drag_cursor != x->horizontal_drag_cursor
1074 && x->horizontal_drag_cursor != 0)
1075 XFreeCursor (dpy, x->horizontal_drag_cursor);
1076 x->horizontal_drag_cursor = horizontal_drag_cursor;
1078 XFlush (dpy);
1079 UNBLOCK_INPUT;
1081 update_face_from_frame_parameter (f, Qmouse_color, arg);
1084 void
1085 x_set_cursor_color (f, arg, oldval)
1086 struct frame *f;
1087 Lisp_Object arg, oldval;
1089 unsigned long fore_pixel, pixel;
1090 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1091 struct x_output *x = f->output_data.x;
1093 if (!NILP (Vx_cursor_fore_pixel))
1095 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1096 WHITE_PIX_DEFAULT (f));
1097 fore_pixel_allocated_p = 1;
1099 else
1100 fore_pixel = x->background_pixel;
1102 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1103 pixel_allocated_p = 1;
1105 /* Make sure that the cursor color differs from the background color. */
1106 if (pixel == x->background_pixel)
1108 if (pixel_allocated_p)
1110 x_free_colors (f, &pixel, 1);
1111 pixel_allocated_p = 0;
1114 pixel = x->mouse_pixel;
1115 if (pixel == fore_pixel)
1117 if (fore_pixel_allocated_p)
1119 x_free_colors (f, &fore_pixel, 1);
1120 fore_pixel_allocated_p = 0;
1122 fore_pixel = x->background_pixel;
1126 unload_color (f, x->cursor_foreground_pixel);
1127 if (!fore_pixel_allocated_p)
1128 fore_pixel = x_copy_color (f, fore_pixel);
1129 x->cursor_foreground_pixel = fore_pixel;
1131 unload_color (f, x->cursor_pixel);
1132 if (!pixel_allocated_p)
1133 pixel = x_copy_color (f, pixel);
1134 x->cursor_pixel = pixel;
1136 if (FRAME_X_WINDOW (f) != 0)
1138 BLOCK_INPUT;
1139 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
1140 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
1141 UNBLOCK_INPUT;
1143 if (FRAME_VISIBLE_P (f))
1145 x_update_cursor (f, 0);
1146 x_update_cursor (f, 1);
1150 update_face_from_frame_parameter (f, Qcursor_color, arg);
1153 /* Set the border-color of frame F to pixel value PIX.
1154 Note that this does not fully take effect if done before
1155 F has an x-window. */
1157 void
1158 x_set_border_pixel (f, pix)
1159 struct frame *f;
1160 int pix;
1162 unload_color (f, f->output_data.x->border_pixel);
1163 f->output_data.x->border_pixel = pix;
1165 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
1167 BLOCK_INPUT;
1168 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1169 (unsigned long)pix);
1170 UNBLOCK_INPUT;
1172 if (FRAME_VISIBLE_P (f))
1173 redraw_frame (f);
1177 /* Set the border-color of frame F to value described by ARG.
1178 ARG can be a string naming a color.
1179 The border-color is used for the border that is drawn by the X server.
1180 Note that this does not fully take effect if done before
1181 F has an x-window; it must be redone when the window is created.
1183 Note: this is done in two routines because of the way X10 works.
1185 Note: under X11, this is normally the province of the window manager,
1186 and so emacs' border colors may be overridden. */
1188 void
1189 x_set_border_color (f, arg, oldval)
1190 struct frame *f;
1191 Lisp_Object arg, oldval;
1193 int pix;
1195 CHECK_STRING (arg);
1196 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1197 x_set_border_pixel (f, pix);
1198 update_face_from_frame_parameter (f, Qborder_color, arg);
1202 void
1203 x_set_cursor_type (f, arg, oldval)
1204 FRAME_PTR f;
1205 Lisp_Object arg, oldval;
1207 set_frame_cursor_types (f, arg);
1209 /* Make sure the cursor gets redrawn. */
1210 cursor_type_changed = 1;
1213 void
1214 x_set_icon_type (f, arg, oldval)
1215 struct frame *f;
1216 Lisp_Object arg, oldval;
1218 int result;
1220 if (STRINGP (arg))
1222 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1223 return;
1225 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1226 return;
1228 BLOCK_INPUT;
1229 if (NILP (arg))
1230 result = x_text_icon (f,
1231 (char *) SDATA ((!NILP (f->icon_name)
1232 ? f->icon_name
1233 : f->name)));
1234 else
1235 result = x_bitmap_icon (f, arg);
1237 if (result)
1239 UNBLOCK_INPUT;
1240 error ("No icon window available");
1243 XFlush (FRAME_X_DISPLAY (f));
1244 UNBLOCK_INPUT;
1247 void
1248 x_set_icon_name (f, arg, oldval)
1249 struct frame *f;
1250 Lisp_Object arg, oldval;
1252 int result;
1254 if (STRINGP (arg))
1256 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1257 return;
1259 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1260 return;
1262 f->icon_name = arg;
1264 if (f->output_data.x->icon_bitmap != 0)
1265 return;
1267 BLOCK_INPUT;
1269 result = x_text_icon (f,
1270 (char *) SDATA ((!NILP (f->icon_name)
1271 ? f->icon_name
1272 : !NILP (f->title)
1273 ? f->title
1274 : f->name)));
1276 if (result)
1278 UNBLOCK_INPUT;
1279 error ("No icon window available");
1282 XFlush (FRAME_X_DISPLAY (f));
1283 UNBLOCK_INPUT;
1287 void
1288 x_set_menu_bar_lines (f, value, oldval)
1289 struct frame *f;
1290 Lisp_Object value, oldval;
1292 int nlines;
1293 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1294 int olines = FRAME_MENU_BAR_LINES (f);
1295 #endif
1297 /* Right now, menu bars don't work properly in minibuf-only frames;
1298 most of the commands try to apply themselves to the minibuffer
1299 frame itself, and get an error because you can't switch buffers
1300 in or split the minibuffer window. */
1301 if (FRAME_MINIBUF_ONLY_P (f))
1302 return;
1304 if (INTEGERP (value))
1305 nlines = XINT (value);
1306 else
1307 nlines = 0;
1309 /* Make sure we redisplay all windows in this frame. */
1310 windows_or_buffers_changed++;
1312 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1313 FRAME_MENU_BAR_LINES (f) = 0;
1314 if (nlines)
1316 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1317 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1318 /* Make sure next redisplay shows the menu bar. */
1319 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1321 else
1323 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1324 free_frame_menubar (f);
1325 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1326 if (FRAME_X_P (f))
1327 f->output_data.x->menubar_widget = 0;
1329 #else /* not USE_X_TOOLKIT && not USE_GTK */
1330 FRAME_MENU_BAR_LINES (f) = nlines;
1331 change_window_heights (f->root_window, nlines - olines);
1332 #endif /* not USE_X_TOOLKIT */
1333 adjust_glyphs (f);
1337 /* Set the number of lines used for the tool bar of frame F to VALUE.
1338 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1339 is the old number of tool bar lines. This function changes the
1340 height of all windows on frame F to match the new tool bar height.
1341 The frame's height doesn't change. */
1343 void
1344 x_set_tool_bar_lines (f, value, oldval)
1345 struct frame *f;
1346 Lisp_Object value, oldval;
1348 int delta, nlines, root_height;
1349 Lisp_Object root_window;
1351 /* Treat tool bars like menu bars. */
1352 if (FRAME_MINIBUF_ONLY_P (f))
1353 return;
1355 /* Use VALUE only if an integer >= 0. */
1356 if (INTEGERP (value) && XINT (value) >= 0)
1357 nlines = XFASTINT (value);
1358 else
1359 nlines = 0;
1361 #ifdef USE_GTK
1362 FRAME_TOOL_BAR_LINES (f) = 0;
1363 if (nlines)
1365 FRAME_EXTERNAL_TOOL_BAR (f) = 1;
1366 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1367 /* Make sure next redisplay shows the tool bar. */
1368 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1369 update_frame_tool_bar (f);
1371 else
1373 if (FRAME_EXTERNAL_TOOL_BAR (f))
1374 free_frame_tool_bar (f);
1375 FRAME_EXTERNAL_TOOL_BAR (f) = 0;
1378 return;
1379 #endif
1381 /* Make sure we redisplay all windows in this frame. */
1382 ++windows_or_buffers_changed;
1384 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1386 /* Don't resize the tool-bar to more than we have room for. */
1387 root_window = FRAME_ROOT_WINDOW (f);
1388 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1389 if (root_height - delta < 1)
1391 delta = root_height - 1;
1392 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1395 FRAME_TOOL_BAR_LINES (f) = nlines;
1396 change_window_heights (root_window, delta);
1397 adjust_glyphs (f);
1399 /* We also have to make sure that the internal border at the top of
1400 the frame, below the menu bar or tool bar, is redrawn when the
1401 tool bar disappears. This is so because the internal border is
1402 below the tool bar if one is displayed, but is below the menu bar
1403 if there isn't a tool bar. The tool bar draws into the area
1404 below the menu bar. */
1405 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1407 updating_frame = f;
1408 clear_frame ();
1409 clear_current_matrices (f);
1410 updating_frame = NULL;
1413 /* If the tool bar gets smaller, the internal border below it
1414 has to be cleared. It was formerly part of the display
1415 of the larger tool bar, and updating windows won't clear it. */
1416 if (delta < 0)
1418 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1419 int width = FRAME_PIXEL_WIDTH (f);
1420 int y = nlines * FRAME_LINE_HEIGHT (f);
1422 /* height can be zero here. */
1423 if (height > 0 && width > 0)
1425 BLOCK_INPUT;
1426 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1427 0, y, width, height, False);
1428 UNBLOCK_INPUT;
1431 if (WINDOWP (f->tool_bar_window))
1432 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1437 /* Set the foreground color for scroll bars on frame F to VALUE.
1438 VALUE should be a string, a color name. If it isn't a string or
1439 isn't a valid color name, do nothing. OLDVAL is the old value of
1440 the frame parameter. */
1442 void
1443 x_set_scroll_bar_foreground (f, value, oldval)
1444 struct frame *f;
1445 Lisp_Object value, oldval;
1447 unsigned long pixel;
1449 if (STRINGP (value))
1450 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1451 else
1452 pixel = -1;
1454 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1455 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1457 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1458 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1460 /* Remove all scroll bars because they have wrong colors. */
1461 if (condemn_scroll_bars_hook)
1462 (*condemn_scroll_bars_hook) (f);
1463 if (judge_scroll_bars_hook)
1464 (*judge_scroll_bars_hook) (f);
1466 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1467 redraw_frame (f);
1472 /* Set the background color for scroll bars on frame F to VALUE VALUE
1473 should be a string, a color name. If it isn't a string or isn't a
1474 valid color name, do nothing. OLDVAL is the old value of the frame
1475 parameter. */
1477 void
1478 x_set_scroll_bar_background (f, value, oldval)
1479 struct frame *f;
1480 Lisp_Object value, oldval;
1482 unsigned long pixel;
1484 if (STRINGP (value))
1485 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1486 else
1487 pixel = -1;
1489 if (f->output_data.x->scroll_bar_background_pixel != -1)
1490 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1492 #ifdef USE_TOOLKIT_SCROLL_BARS
1493 /* Scrollbar shadow colors. */
1494 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1496 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1497 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1499 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1501 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1502 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1504 #endif /* USE_TOOLKIT_SCROLL_BARS */
1506 f->output_data.x->scroll_bar_background_pixel = pixel;
1507 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1509 /* Remove all scroll bars because they have wrong colors. */
1510 if (condemn_scroll_bars_hook)
1511 (*condemn_scroll_bars_hook) (f);
1512 if (judge_scroll_bars_hook)
1513 (*judge_scroll_bars_hook) (f);
1515 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1516 redraw_frame (f);
1521 /* Encode Lisp string STRING as a text in a format appropriate for
1522 XICCC (X Inter Client Communication Conventions).
1524 If STRING contains only ASCII characters, do no conversion and
1525 return the string data of STRING. Otherwise, encode the text by
1526 CODING_SYSTEM, and return a newly allocated memory area which
1527 should be freed by `xfree' by a caller.
1529 SELECTIONP non-zero means the string is being encoded for an X
1530 selection, so it is safe to run pre-write conversions (which
1531 may run Lisp code).
1533 Store the byte length of resulting text in *TEXT_BYTES.
1535 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1536 which means that the `encoding' of the result can be `STRING'.
1537 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1538 the result should be `COMPOUND_TEXT'. */
1540 static unsigned char *
1541 x_encode_text (string, coding_system, selectionp, text_bytes, stringp, freep)
1542 Lisp_Object string, coding_system;
1543 int *text_bytes, *stringp;
1544 int selectionp;
1545 int *freep;
1547 unsigned char *str = SDATA (string);
1548 int chars = SCHARS (string);
1549 int bytes = SBYTES (string);
1550 int charset_info;
1551 int bufsize;
1552 unsigned char *buf;
1553 struct coding_system coding;
1554 extern Lisp_Object Qcompound_text_with_extensions;
1556 charset_info = find_charset_in_text (str, chars, bytes, NULL, Qnil);
1557 if (charset_info == 0)
1559 /* No multibyte character in OBJ. We need not encode it. */
1560 *text_bytes = bytes;
1561 *stringp = 1;
1562 *freep = 0;
1563 return str;
1566 setup_coding_system (coding_system, &coding);
1567 if (selectionp
1568 && SYMBOLP (coding.pre_write_conversion)
1569 && !NILP (Ffboundp (coding.pre_write_conversion)))
1571 string = run_pre_post_conversion_on_str (string, &coding, 1);
1572 str = SDATA (string);
1573 chars = SCHARS (string);
1574 bytes = SBYTES (string);
1576 coding.src_multibyte = 1;
1577 coding.dst_multibyte = 0;
1578 coding.mode |= CODING_MODE_LAST_BLOCK;
1579 if (coding.type == coding_type_iso2022)
1580 coding.flags |= CODING_FLAG_ISO_SAFE;
1581 /* We suppress producing escape sequences for composition. */
1582 coding.composing = COMPOSITION_DISABLED;
1583 bufsize = encoding_buffer_size (&coding, bytes);
1584 buf = (unsigned char *) xmalloc (bufsize);
1585 encode_coding (&coding, str, buf, bytes, bufsize);
1586 *text_bytes = coding.produced;
1587 *stringp = (charset_info == 1
1588 || (!EQ (coding_system, Qcompound_text)
1589 && !EQ (coding_system, Qcompound_text_with_extensions)));
1590 *freep = 1;
1591 return buf;
1595 /* Set the WM name to NAME for frame F. Also set the icon name.
1596 If the frame already has an icon name, use that, otherwise set the
1597 icon name to NAME. */
1599 static void
1600 x_set_name_internal (f, name)
1601 FRAME_PTR f;
1602 Lisp_Object name;
1604 if (FRAME_X_WINDOW (f))
1606 BLOCK_INPUT;
1607 #ifdef HAVE_X11R4
1609 XTextProperty text, icon;
1610 int bytes, stringp;
1611 int do_free_icon_value = 0, do_free_text_value = 0;
1612 Lisp_Object coding_system;
1614 coding_system = Qcompound_text;
1615 /* Note: Encoding strategy
1617 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1618 text.encoding. But, there are non-internationalized window
1619 managers which don't support that encoding. So, if NAME
1620 contains only ASCII and 8859-1 characters, encode it by
1621 iso-latin-1, and use "STRING" in text.encoding hoping that
1622 such window managers at least analyze this format correctly,
1623 i.e. treat 8-bit bytes as 8859-1 characters.
1625 We may also be able to use "UTF8_STRING" in text.encoding
1626 in the future which can encode all Unicode characters.
1627 But, for the moment, there's no way to know that the
1628 current window manager supports it or not. */
1629 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1630 &do_free_text_value);
1631 text.encoding = (stringp ? XA_STRING
1632 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1633 text.format = 8;
1634 text.nitems = bytes;
1636 if (NILP (f->icon_name))
1638 icon = text;
1640 else
1642 /* See the above comment "Note: Encoding strategy". */
1643 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1644 &bytes, &stringp, &do_free_icon_value);
1645 icon.encoding = (stringp ? XA_STRING
1646 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1647 icon.format = 8;
1648 icon.nitems = bytes;
1651 #ifdef USE_GTK
1652 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1653 (char *) SDATA (ENCODE_UTF_8 (name)));
1654 #else /* not USE_GTK */
1655 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1656 #endif /* not USE_GTK */
1658 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1660 if (do_free_icon_value)
1661 xfree (icon.value);
1662 if (do_free_text_value)
1663 xfree (text.value);
1665 #else /* not HAVE_X11R4 */
1666 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1667 SDATA (name));
1668 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1669 SDATA (name));
1670 #endif /* not HAVE_X11R4 */
1671 UNBLOCK_INPUT;
1675 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1676 x_id_name.
1678 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1679 name; if NAME is a string, set F's name to NAME and set
1680 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1682 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1683 suggesting a new name, which lisp code should override; if
1684 F->explicit_name is set, ignore the new name; otherwise, set it. */
1686 void
1687 x_set_name (f, name, explicit)
1688 struct frame *f;
1689 Lisp_Object name;
1690 int explicit;
1692 /* Make sure that requests from lisp code override requests from
1693 Emacs redisplay code. */
1694 if (explicit)
1696 /* If we're switching from explicit to implicit, we had better
1697 update the mode lines and thereby update the title. */
1698 if (f->explicit_name && NILP (name))
1699 update_mode_lines = 1;
1701 f->explicit_name = ! NILP (name);
1703 else if (f->explicit_name)
1704 return;
1706 /* If NAME is nil, set the name to the x_id_name. */
1707 if (NILP (name))
1709 /* Check for no change needed in this very common case
1710 before we do any consing. */
1711 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
1712 SDATA (f->name)))
1713 return;
1714 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
1716 else
1717 CHECK_STRING (name);
1719 /* Don't change the name if it's already NAME. */
1720 if (! NILP (Fstring_equal (name, f->name)))
1721 return;
1723 f->name = name;
1725 /* For setting the frame title, the title parameter should override
1726 the name parameter. */
1727 if (! NILP (f->title))
1728 name = f->title;
1730 x_set_name_internal (f, name);
1733 /* This function should be called when the user's lisp code has
1734 specified a name for the frame; the name will override any set by the
1735 redisplay code. */
1736 void
1737 x_explicitly_set_name (f, arg, oldval)
1738 FRAME_PTR f;
1739 Lisp_Object arg, oldval;
1741 x_set_name (f, arg, 1);
1744 /* This function should be called by Emacs redisplay code to set the
1745 name; names set this way will never override names set by the user's
1746 lisp code. */
1747 void
1748 x_implicitly_set_name (f, arg, oldval)
1749 FRAME_PTR f;
1750 Lisp_Object arg, oldval;
1752 x_set_name (f, arg, 0);
1755 /* Change the title of frame F to NAME.
1756 If NAME is nil, use the frame name as the title.
1758 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1759 name; if NAME is a string, set F's name to NAME and set
1760 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1762 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1763 suggesting a new name, which lisp code should override; if
1764 F->explicit_name is set, ignore the new name; otherwise, set it. */
1766 void
1767 x_set_title (f, name, old_name)
1768 struct frame *f;
1769 Lisp_Object name, old_name;
1771 /* Don't change the title if it's already NAME. */
1772 if (EQ (name, f->title))
1773 return;
1775 update_mode_lines = 1;
1777 f->title = name;
1779 if (NILP (name))
1780 name = f->name;
1781 else
1782 CHECK_STRING (name);
1784 x_set_name_internal (f, name);
1787 void
1788 x_set_scroll_bar_default_width (f)
1789 struct frame *f;
1791 int wid = FRAME_COLUMN_WIDTH (f);
1793 #ifdef USE_TOOLKIT_SCROLL_BARS
1794 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1795 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
1796 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
1797 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = width;
1798 #else
1799 /* Make the actual width at least 14 pixels and a multiple of a
1800 character width. */
1801 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
1803 /* Use all of that space (aside from required margins) for the
1804 scroll bar. */
1805 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = 0;
1806 #endif
1810 /* Record in frame F the specified or default value according to ALIST
1811 of the parameter named PROP (a Lisp symbol). If no value is
1812 specified for PROP, look for an X default for XPROP on the frame
1813 named NAME. If that is not found either, use the value DEFLT. */
1815 static Lisp_Object
1816 x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
1817 foreground_p)
1818 struct frame *f;
1819 Lisp_Object alist;
1820 Lisp_Object prop;
1821 char *xprop;
1822 char *xclass;
1823 int foreground_p;
1825 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1826 Lisp_Object tem;
1828 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1829 if (EQ (tem, Qunbound))
1831 #ifdef USE_TOOLKIT_SCROLL_BARS
1833 /* See if an X resource for the scroll bar color has been
1834 specified. */
1835 tem = display_x_get_resource (dpyinfo,
1836 build_string (foreground_p
1837 ? "foreground"
1838 : "background"),
1839 empty_string,
1840 build_string ("verticalScrollBar"),
1841 empty_string);
1842 if (!STRINGP (tem))
1844 /* If nothing has been specified, scroll bars will use a
1845 toolkit-dependent default. Because these defaults are
1846 difficult to get at without actually creating a scroll
1847 bar, use nil to indicate that no color has been
1848 specified. */
1849 tem = Qnil;
1852 #else /* not USE_TOOLKIT_SCROLL_BARS */
1854 tem = Qnil;
1856 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1859 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
1860 return tem;
1865 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
1867 Status
1868 XSetWMProtocols (dpy, w, protocols, count)
1869 Display *dpy;
1870 Window w;
1871 Atom *protocols;
1872 int count;
1874 Atom prop;
1875 prop = XInternAtom (dpy, "WM_PROTOCOLS", False);
1876 if (prop == None) return False;
1877 XChangeProperty (dpy, w, prop, XA_ATOM, 32, PropModeReplace,
1878 (unsigned char *) protocols, count);
1879 return True;
1881 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
1883 #ifdef USE_X_TOOLKIT
1885 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1886 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1887 already be present because of the toolkit (Motif adds some of them,
1888 for example, but Xt doesn't). */
1890 static void
1891 hack_wm_protocols (f, widget)
1892 FRAME_PTR f;
1893 Widget widget;
1895 Display *dpy = XtDisplay (widget);
1896 Window w = XtWindow (widget);
1897 int need_delete = 1;
1898 int need_focus = 1;
1899 int need_save = 1;
1901 BLOCK_INPUT;
1903 Atom type;
1904 unsigned char *catoms;
1905 int format = 0;
1906 unsigned long nitems = 0;
1907 unsigned long bytes_after;
1909 if ((XGetWindowProperty (dpy, w,
1910 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1911 (long)0, (long)100, False, XA_ATOM,
1912 &type, &format, &nitems, &bytes_after,
1913 &catoms)
1914 == Success)
1915 && format == 32 && type == XA_ATOM)
1917 Atom *atoms = (Atom *) catoms;
1918 while (nitems > 0)
1920 nitems--;
1921 if (atoms[nitems]
1922 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1923 need_delete = 0;
1924 else if (atoms[nitems]
1925 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1926 need_focus = 0;
1927 else if (atoms[nitems]
1928 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1929 need_save = 0;
1932 if (catoms)
1933 XFree (catoms);
1936 Atom props [10];
1937 int count = 0;
1938 if (need_delete)
1939 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1940 if (need_focus)
1941 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1942 if (need_save)
1943 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1944 if (count)
1945 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1946 XA_ATOM, 32, PropModeAppend,
1947 (unsigned char *) props, count);
1949 UNBLOCK_INPUT;
1951 #endif
1955 /* Support routines for XIC (X Input Context). */
1957 #ifdef HAVE_X_I18N
1959 static XFontSet xic_create_xfontset P_ ((struct frame *, char *));
1960 static XIMStyle best_xim_style P_ ((XIMStyles *, XIMStyles *));
1963 /* Supported XIM styles, ordered by preference. */
1965 static XIMStyle supported_xim_styles[] =
1967 XIMPreeditPosition | XIMStatusArea,
1968 XIMPreeditPosition | XIMStatusNothing,
1969 XIMPreeditPosition | XIMStatusNone,
1970 XIMPreeditNothing | XIMStatusArea,
1971 XIMPreeditNothing | XIMStatusNothing,
1972 XIMPreeditNothing | XIMStatusNone,
1973 XIMPreeditNone | XIMStatusArea,
1974 XIMPreeditNone | XIMStatusNothing,
1975 XIMPreeditNone | XIMStatusNone,
1980 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1982 char xic_defaut_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1984 /* Create an Xt fontset spec from the name of a base font.
1985 If `motif' is True use the Motif syntax. */
1986 char *
1987 xic_create_fontsetname (base_fontname, motif)
1988 char *base_fontname;
1989 Bool motif;
1991 const char *sep = motif ? ";" : ",";
1992 char *fontsetname;
1994 /* Make a fontset name from the base font name. */
1995 if (xic_defaut_fontset == base_fontname)
1996 { /* There is no base font name, use the default. */
1997 int len = strlen (base_fontname) + 2;
1998 fontsetname = xmalloc (len);
1999 bzero (fontsetname, len);
2000 strcpy (fontsetname, base_fontname);
2002 else
2004 /* Make a fontset name from the base font name.
2005 The font set will be made of the following elements:
2006 - the base font.
2007 - the base font where the charset spec is replaced by -*-*.
2008 - the same but with the family also replaced with -*-*-. */
2009 char *p = base_fontname;
2010 int i;
2012 for (i = 0; *p; p++)
2013 if (*p == '-') i++;
2014 if (i != 14)
2015 { /* As the font name doesn't conform to XLFD, we can't
2016 modify it to generalize it to allcs and allfamilies.
2017 Use the specified font plus the default. */
2018 int len = strlen (base_fontname) + strlen (xic_defaut_fontset) + 3;
2019 fontsetname = xmalloc (len);
2020 bzero (fontsetname, len);
2021 strcpy (fontsetname, base_fontname);
2022 strcat (fontsetname, sep);
2023 strcat (fontsetname, xic_defaut_fontset);
2025 else
2027 int len;
2028 char *p1 = NULL, *p2 = NULL;
2029 char *font_allcs = NULL;
2030 char *font_allfamilies = NULL;
2031 char *font_all = NULL;
2032 char *allcs = "*-*-*-*-*-*-*";
2033 char *allfamilies = "-*-*-";
2034 char *all = "*-*-*-*-";
2036 for (i = 0, p = base_fontname; i < 8; p++)
2038 if (*p == '-')
2040 i++;
2041 if (i == 3)
2042 p1 = p + 1;
2043 else if (i == 7)
2044 p2 = p + 1;
2047 /* Build the font spec that matches all charsets. */
2048 len = p - base_fontname + strlen (allcs) + 1;
2049 font_allcs = (char *) alloca (len);
2050 bzero (font_allcs, len);
2051 bcopy (base_fontname, font_allcs, p - base_fontname);
2052 strcat (font_allcs, allcs);
2054 /* Build the font spec that matches all families. */
2055 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
2056 font_allfamilies = (char *) alloca (len);
2057 bzero (font_allfamilies, len);
2058 strcpy (font_allfamilies, allfamilies);
2059 bcopy (p1, font_allfamilies + strlen (allfamilies), p - p1);
2060 strcat (font_allfamilies, allcs);
2062 /* Build the font spec that matches all. */
2063 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
2064 font_all = (char *) alloca (len);
2065 bzero (font_all, len);
2066 strcpy (font_all, allfamilies);
2067 strcat (font_all, all);
2068 bcopy (p2, font_all + strlen (all) + strlen (allfamilies), p - p2);
2069 strcat (font_all, allcs);
2071 /* Build the actual font set name. */
2072 len = strlen (base_fontname) + strlen (font_allcs)
2073 + strlen (font_allfamilies) + strlen (font_all) + 5;
2074 fontsetname = xmalloc (len);
2075 bzero (fontsetname, len);
2076 strcpy (fontsetname, base_fontname);
2077 strcat (fontsetname, sep);
2078 strcat (fontsetname, font_allcs);
2079 strcat (fontsetname, sep);
2080 strcat (fontsetname, font_allfamilies);
2081 strcat (fontsetname, sep);
2082 strcat (fontsetname, font_all);
2085 if (motif)
2086 strcat (fontsetname, ":");
2087 return fontsetname;
2090 static XFontSet
2091 xic_create_xfontset (f, base_fontname)
2092 struct frame *f;
2093 char *base_fontname;
2095 XFontSet xfs = NULL;
2096 char **missing_list = NULL;
2097 int missing_count;
2098 char *def_string;
2099 Lisp_Object rest, frame;
2101 if (!base_fontname)
2102 base_fontname = xic_defaut_fontset;
2104 /* See if there is another frame already using same fontset. */
2105 FOR_EACH_FRAME (rest, frame)
2107 struct frame *cf = XFRAME (frame);
2108 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2109 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2110 && FRAME_XIC_BASE_FONTNAME (cf)
2111 && !strcmp (FRAME_XIC_BASE_FONTNAME (cf), base_fontname))
2113 xfs = FRAME_XIC_FONTSET (cf);
2114 break;
2118 if (!xfs)
2120 char *fontsetname = xic_create_fontsetname (base_fontname, False);
2122 /* New fontset. */
2123 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
2124 fontsetname, &missing_list,
2125 &missing_count, &def_string);
2126 if (missing_list)
2127 XFreeStringList (missing_list);
2128 xfree (fontsetname);
2131 if (FRAME_XIC_BASE_FONTNAME (f))
2132 xfree (FRAME_XIC_BASE_FONTNAME (f));
2133 FRAME_XIC_BASE_FONTNAME (f) = xstrdup (base_fontname);
2135 /* No need to free def_string. */
2136 return xfs;
2139 /* Free the X fontset of frame F if it is the last frame using it. */
2141 void
2142 xic_free_xfontset (f)
2143 struct frame *f;
2145 Lisp_Object rest, frame;
2146 int shared_p = 0;
2148 if (!FRAME_XIC_FONTSET (f))
2149 return;
2151 /* See if there is another frame sharing the same fontset. */
2152 FOR_EACH_FRAME (rest, frame)
2154 struct frame *cf = XFRAME (frame);
2155 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2156 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2157 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2159 shared_p = 1;
2160 break;
2164 if (!shared_p)
2165 /* The fontset is not used anymore. It is safe to free it. */
2166 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2168 if (FRAME_XIC_BASE_FONTNAME (f))
2169 xfree (FRAME_XIC_BASE_FONTNAME (f));
2170 FRAME_XIC_BASE_FONTNAME (f) = NULL;
2171 FRAME_XIC_FONTSET (f) = NULL;
2175 /* Value is the best input style, given user preferences USER (already
2176 checked to be supported by Emacs), and styles supported by the
2177 input method XIM. */
2179 static XIMStyle
2180 best_xim_style (user, xim)
2181 XIMStyles *user;
2182 XIMStyles *xim;
2184 int i, j;
2186 for (i = 0; i < user->count_styles; ++i)
2187 for (j = 0; j < xim->count_styles; ++j)
2188 if (user->supported_styles[i] == xim->supported_styles[j])
2189 return user->supported_styles[i];
2191 /* Return the default style. */
2192 return XIMPreeditNothing | XIMStatusNothing;
2195 /* Create XIC for frame F. */
2197 static XIMStyle xic_style;
2199 void
2200 create_frame_xic (f)
2201 struct frame *f;
2203 XIM xim;
2204 XIC xic = NULL;
2205 XFontSet xfs = NULL;
2207 if (FRAME_XIC (f))
2208 return;
2210 /* Create X fontset. */
2211 xfs = xic_create_xfontset
2212 (f, (FRAME_FONTSET (f) < 0) ? NULL
2213 : (char *) SDATA (fontset_ascii (FRAME_FONTSET (f))));
2215 xim = FRAME_X_XIM (f);
2216 if (xim)
2218 XRectangle s_area;
2219 XPoint spot;
2220 XVaNestedList preedit_attr;
2221 XVaNestedList status_attr;
2223 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2224 spot.x = 0; spot.y = 1;
2226 /* Determine XIC style. */
2227 if (xic_style == 0)
2229 XIMStyles supported_list;
2230 supported_list.count_styles = (sizeof supported_xim_styles
2231 / sizeof supported_xim_styles[0]);
2232 supported_list.supported_styles = supported_xim_styles;
2233 xic_style = best_xim_style (&supported_list,
2234 FRAME_X_XIM_STYLES (f));
2237 preedit_attr = XVaCreateNestedList (0,
2238 XNFontSet, xfs,
2239 XNForeground,
2240 FRAME_FOREGROUND_PIXEL (f),
2241 XNBackground,
2242 FRAME_BACKGROUND_PIXEL (f),
2243 (xic_style & XIMPreeditPosition
2244 ? XNSpotLocation
2245 : NULL),
2246 &spot,
2247 NULL);
2248 status_attr = XVaCreateNestedList (0,
2249 XNArea,
2250 &s_area,
2251 XNFontSet,
2252 xfs,
2253 XNForeground,
2254 FRAME_FOREGROUND_PIXEL (f),
2255 XNBackground,
2256 FRAME_BACKGROUND_PIXEL (f),
2257 NULL);
2259 xic = XCreateIC (xim,
2260 XNInputStyle, xic_style,
2261 XNClientWindow, FRAME_X_WINDOW (f),
2262 XNFocusWindow, FRAME_X_WINDOW (f),
2263 XNStatusAttributes, status_attr,
2264 XNPreeditAttributes, preedit_attr,
2265 NULL);
2266 XFree (preedit_attr);
2267 XFree (status_attr);
2270 FRAME_XIC (f) = xic;
2271 FRAME_XIC_STYLE (f) = xic_style;
2272 FRAME_XIC_FONTSET (f) = xfs;
2276 /* Destroy XIC and free XIC fontset of frame F, if any. */
2278 void
2279 free_frame_xic (f)
2280 struct frame *f;
2282 if (FRAME_XIC (f) == NULL)
2283 return;
2285 XDestroyIC (FRAME_XIC (f));
2286 xic_free_xfontset (f);
2288 FRAME_XIC (f) = NULL;
2292 /* Place preedit area for XIC of window W's frame to specified
2293 pixel position X/Y. X and Y are relative to window W. */
2295 void
2296 xic_set_preeditarea (w, x, y)
2297 struct window *w;
2298 int x, y;
2300 struct frame *f = XFRAME (w->frame);
2301 XVaNestedList attr;
2302 XPoint spot;
2304 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2305 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2306 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2307 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2308 XFree (attr);
2312 /* Place status area for XIC in bottom right corner of frame F.. */
2314 void
2315 xic_set_statusarea (f)
2316 struct frame *f;
2318 XIC xic = FRAME_XIC (f);
2319 XVaNestedList attr;
2320 XRectangle area;
2321 XRectangle *needed;
2323 /* Negotiate geometry of status area. If input method has existing
2324 status area, use its current size. */
2325 area.x = area.y = area.width = area.height = 0;
2326 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2327 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2328 XFree (attr);
2330 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2331 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2332 XFree (attr);
2334 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2336 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2337 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2338 XFree (attr);
2341 area.width = needed->width;
2342 area.height = needed->height;
2343 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2344 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2345 - FRAME_MENUBAR_HEIGHT (f)
2346 - FRAME_TOOLBAR_HEIGHT (f)
2347 - FRAME_INTERNAL_BORDER_WIDTH (f));
2348 XFree (needed);
2350 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2351 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2352 XFree (attr);
2356 /* Set X fontset for XIC of frame F, using base font name
2357 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2359 void
2360 xic_set_xfontset (f, base_fontname)
2361 struct frame *f;
2362 char *base_fontname;
2364 XVaNestedList attr;
2365 XFontSet xfs;
2367 xic_free_xfontset (f);
2369 xfs = xic_create_xfontset (f, base_fontname);
2371 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2372 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2373 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2374 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2375 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2376 XFree (attr);
2378 FRAME_XIC_FONTSET (f) = xfs;
2381 #endif /* HAVE_X_I18N */
2385 #ifdef USE_X_TOOLKIT
2387 /* Create and set up the X widget for frame F. */
2389 static void
2390 x_window (f, window_prompting, minibuffer_only)
2391 struct frame *f;
2392 long window_prompting;
2393 int minibuffer_only;
2395 XClassHint class_hints;
2396 XSetWindowAttributes attributes;
2397 unsigned long attribute_mask;
2398 Widget shell_widget;
2399 Widget pane_widget;
2400 Widget frame_widget;
2401 Arg al [25];
2402 int ac;
2404 BLOCK_INPUT;
2406 /* Use the resource name as the top-level widget name
2407 for looking up resources. Make a non-Lisp copy
2408 for the window manager, so GC relocation won't bother it.
2410 Elsewhere we specify the window name for the window manager. */
2413 char *str = (char *) SDATA (Vx_resource_name);
2414 f->namebuf = (char *) xmalloc (strlen (str) + 1);
2415 strcpy (f->namebuf, str);
2418 ac = 0;
2419 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2420 XtSetArg (al[ac], XtNinput, 1); ac++;
2421 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2422 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2423 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2424 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2425 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2426 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2427 applicationShellWidgetClass,
2428 FRAME_X_DISPLAY (f), al, ac);
2430 f->output_data.x->widget = shell_widget;
2431 /* maybe_set_screen_title_format (shell_widget); */
2433 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2434 (widget_value *) NULL,
2435 shell_widget, False,
2436 (lw_callback) NULL,
2437 (lw_callback) NULL,
2438 (lw_callback) NULL,
2439 (lw_callback) NULL);
2441 ac = 0;
2442 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2443 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2444 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2445 XtSetValues (pane_widget, al, ac);
2446 f->output_data.x->column_widget = pane_widget;
2448 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2449 the emacs screen when changing menubar. This reduces flickering. */
2451 ac = 0;
2452 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2453 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2454 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2455 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2456 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2457 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2458 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2459 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2460 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2461 al, ac);
2463 f->output_data.x->edit_widget = frame_widget;
2465 XtManageChild (frame_widget);
2467 /* Do some needed geometry management. */
2469 int len;
2470 char *tem, shell_position[32];
2471 Arg al[10];
2472 int ac = 0;
2473 int extra_borders = 0;
2474 int menubar_size
2475 = (f->output_data.x->menubar_widget
2476 ? (f->output_data.x->menubar_widget->core.height
2477 + f->output_data.x->menubar_widget->core.border_width)
2478 : 0);
2480 #if 0 /* Experimentally, we now get the right results
2481 for -geometry -0-0 without this. 24 Aug 96, rms. */
2482 if (FRAME_EXTERNAL_MENU_BAR (f))
2484 Dimension ibw = 0;
2485 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2486 menubar_size += ibw;
2488 #endif
2490 f->output_data.x->menubar_height = menubar_size;
2492 #ifndef USE_LUCID
2493 /* Motif seems to need this amount added to the sizes
2494 specified for the shell widget. The Athena/Lucid widgets don't.
2495 Both conclusions reached experimentally. -- rms. */
2496 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2497 &extra_borders, NULL);
2498 extra_borders *= 2;
2499 #endif
2501 /* Convert our geometry parameters into a geometry string
2502 and specify it.
2503 Note that we do not specify here whether the position
2504 is a user-specified or program-specified one.
2505 We pass that information later, in x_wm_set_size_hints. */
2507 int left = f->left_pos;
2508 int xneg = window_prompting & XNegative;
2509 int top = f->top_pos;
2510 int yneg = window_prompting & YNegative;
2511 if (xneg)
2512 left = -left;
2513 if (yneg)
2514 top = -top;
2516 if (window_prompting & USPosition)
2517 sprintf (shell_position, "=%dx%d%c%d%c%d",
2518 FRAME_PIXEL_WIDTH (f) + extra_borders,
2519 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2520 (xneg ? '-' : '+'), left,
2521 (yneg ? '-' : '+'), top);
2522 else
2524 sprintf (shell_position, "=%dx%d",
2525 FRAME_PIXEL_WIDTH (f) + extra_borders,
2526 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2528 /* Setting x and y when the position is not specified in
2529 the geometry string will set program position in the WM hints.
2530 If Emacs had just one program position, we could set it in
2531 fallback resources, but since each make-frame call can specify
2532 different program positions, this is easier. */
2533 XtSetArg (al[ac], XtNx, left); ac++;
2534 XtSetArg (al[ac], XtNy, top); ac++;
2538 len = strlen (shell_position) + 1;
2539 /* We don't free this because we don't know whether
2540 it is safe to free it while the frame exists.
2541 It isn't worth the trouble of arranging to free it
2542 when the frame is deleted. */
2543 tem = (char *) xmalloc (len);
2544 strncpy (tem, shell_position, len);
2545 XtSetArg (al[ac], XtNgeometry, tem); ac++;
2546 XtSetValues (shell_widget, al, ac);
2549 XtManageChild (pane_widget);
2550 XtRealizeWidget (shell_widget);
2552 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2554 validate_x_resource_name ();
2556 class_hints.res_name = (char *) SDATA (Vx_resource_name);
2557 class_hints.res_class = (char *) SDATA (Vx_resource_class);
2558 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2560 #ifdef HAVE_X_I18N
2561 FRAME_XIC (f) = NULL;
2562 if (use_xim)
2563 create_frame_xic (f);
2564 #endif
2566 f->output_data.x->wm_hints.input = True;
2567 f->output_data.x->wm_hints.flags |= InputHint;
2568 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2569 &f->output_data.x->wm_hints);
2571 hack_wm_protocols (f, shell_widget);
2573 #ifdef HACK_EDITRES
2574 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2575 #endif
2577 /* Do a stupid property change to force the server to generate a
2578 PropertyNotify event so that the event_stream server timestamp will
2579 be initialized to something relevant to the time we created the window.
2581 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2582 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
2583 XA_ATOM, 32, PropModeAppend,
2584 (unsigned char*) NULL, 0);
2586 /* Make all the standard events reach the Emacs frame. */
2587 attributes.event_mask = STANDARD_EVENT_SET;
2589 #ifdef HAVE_X_I18N
2590 if (FRAME_XIC (f))
2592 /* XIM server might require some X events. */
2593 unsigned long fevent = NoEventMask;
2594 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2595 attributes.event_mask |= fevent;
2597 #endif /* HAVE_X_I18N */
2599 attribute_mask = CWEventMask;
2600 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2601 attribute_mask, &attributes);
2603 XtMapWidget (frame_widget);
2605 /* x_set_name normally ignores requests to set the name if the
2606 requested name is the same as the current name. This is the one
2607 place where that assumption isn't correct; f->name is set, but
2608 the X server hasn't been told. */
2610 Lisp_Object name;
2611 int explicit = f->explicit_name;
2613 f->explicit_name = 0;
2614 name = f->name;
2615 f->name = Qnil;
2616 x_set_name (f, name, explicit);
2619 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2620 f->output_data.x->text_cursor);
2622 UNBLOCK_INPUT;
2624 /* This is a no-op, except under Motif. Make sure main areas are
2625 set to something reasonable, in case we get an error later. */
2626 lw_set_main_areas (pane_widget, 0, frame_widget);
2629 #else /* not USE_X_TOOLKIT */
2630 #ifdef USE_GTK
2631 void
2632 x_window (f)
2633 FRAME_PTR f;
2635 if (! xg_create_frame_widgets (f))
2636 error ("Unable to create window");
2638 #ifdef HAVE_X_I18N
2639 FRAME_XIC (f) = NULL;
2640 if (use_xim)
2642 BLOCK_INPUT;
2643 create_frame_xic (f);
2644 if (FRAME_XIC (f))
2646 /* XIM server might require some X events. */
2647 unsigned long fevent = NoEventMask;
2648 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2650 if (fevent != NoEventMask)
2652 XSetWindowAttributes attributes;
2653 XWindowAttributes wattr;
2654 unsigned long attribute_mask;
2656 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2657 &wattr);
2658 attributes.event_mask = wattr.your_event_mask | fevent;
2659 attribute_mask = CWEventMask;
2660 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2661 attribute_mask, &attributes);
2664 UNBLOCK_INPUT;
2666 #endif
2669 #else /*! USE_GTK */
2670 /* Create and set up the X window for frame F. */
2672 void
2673 x_window (f)
2674 struct frame *f;
2677 XClassHint class_hints;
2678 XSetWindowAttributes attributes;
2679 unsigned long attribute_mask;
2681 attributes.background_pixel = f->output_data.x->background_pixel;
2682 attributes.border_pixel = f->output_data.x->border_pixel;
2683 attributes.bit_gravity = StaticGravity;
2684 attributes.backing_store = NotUseful;
2685 attributes.save_under = True;
2686 attributes.event_mask = STANDARD_EVENT_SET;
2687 attributes.colormap = FRAME_X_COLORMAP (f);
2688 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2689 | CWColormap);
2691 BLOCK_INPUT;
2692 FRAME_X_WINDOW (f)
2693 = XCreateWindow (FRAME_X_DISPLAY (f),
2694 f->output_data.x->parent_desc,
2695 f->left_pos,
2696 f->top_pos,
2697 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2698 f->border_width,
2699 CopyFromParent, /* depth */
2700 InputOutput, /* class */
2701 FRAME_X_VISUAL (f),
2702 attribute_mask, &attributes);
2704 #ifdef HAVE_X_I18N
2705 if (use_xim)
2707 create_frame_xic (f);
2708 if (FRAME_XIC (f))
2710 /* XIM server might require some X events. */
2711 unsigned long fevent = NoEventMask;
2712 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2713 attributes.event_mask |= fevent;
2714 attribute_mask = CWEventMask;
2715 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2716 attribute_mask, &attributes);
2719 #endif /* HAVE_X_I18N */
2721 validate_x_resource_name ();
2723 class_hints.res_name = (char *) SDATA (Vx_resource_name);
2724 class_hints.res_class = (char *) SDATA (Vx_resource_class);
2725 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2727 /* The menubar is part of the ordinary display;
2728 it does not count in addition to the height of the window. */
2729 f->output_data.x->menubar_height = 0;
2731 /* This indicates that we use the "Passive Input" input model.
2732 Unless we do this, we don't get the Focus{In,Out} events that we
2733 need to draw the cursor correctly. Accursed bureaucrats.
2734 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2736 f->output_data.x->wm_hints.input = True;
2737 f->output_data.x->wm_hints.flags |= InputHint;
2738 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2739 &f->output_data.x->wm_hints);
2740 f->output_data.x->wm_hints.icon_pixmap = None;
2742 /* Request "save yourself" and "delete window" commands from wm. */
2744 Atom protocols[2];
2745 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2746 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2747 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2750 /* x_set_name normally ignores requests to set the name if the
2751 requested name is the same as the current name. This is the one
2752 place where that assumption isn't correct; f->name is set, but
2753 the X server hasn't been told. */
2755 Lisp_Object name;
2756 int explicit = f->explicit_name;
2758 f->explicit_name = 0;
2759 name = f->name;
2760 f->name = Qnil;
2761 x_set_name (f, name, explicit);
2764 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2765 f->output_data.x->text_cursor);
2767 UNBLOCK_INPUT;
2769 if (FRAME_X_WINDOW (f) == 0)
2770 error ("Unable to create window");
2773 #endif /* not USE_GTK */
2774 #endif /* not USE_X_TOOLKIT */
2776 /* Verify that the icon position args for this window are valid. */
2778 static void
2779 x_icon_verify (f, parms)
2780 struct frame *f;
2781 Lisp_Object parms;
2783 Lisp_Object icon_x, icon_y;
2785 /* Set the position of the icon. Note that twm groups all
2786 icons in an icon window. */
2787 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2788 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2789 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2791 CHECK_NUMBER (icon_x);
2792 CHECK_NUMBER (icon_y);
2794 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2795 error ("Both left and top icon corners of icon must be specified");
2798 /* Handle the icon stuff for this window. Perhaps later we might
2799 want an x_set_icon_position which can be called interactively as
2800 well. */
2802 static void
2803 x_icon (f, parms)
2804 struct frame *f;
2805 Lisp_Object parms;
2807 Lisp_Object icon_x, icon_y;
2808 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2810 /* Set the position of the icon. Note that twm groups all
2811 icons in an icon window. */
2812 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2813 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2814 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2816 CHECK_NUMBER (icon_x);
2817 CHECK_NUMBER (icon_y);
2819 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2820 error ("Both left and top icon corners of icon must be specified");
2822 BLOCK_INPUT;
2824 if (! EQ (icon_x, Qunbound))
2825 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2827 /* Start up iconic or window? */
2828 x_wm_set_window_state
2829 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2830 Qicon)
2831 ? IconicState
2832 : NormalState));
2834 x_text_icon (f, (char *) SDATA ((!NILP (f->icon_name)
2835 ? f->icon_name
2836 : f->name)));
2838 UNBLOCK_INPUT;
2841 /* Make the GCs needed for this window, setting the
2842 background, border and mouse colors; also create the
2843 mouse cursor and the gray border tile. */
2845 static char cursor_bits[] =
2847 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2848 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2849 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2850 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
2853 static void
2854 x_make_gc (f)
2855 struct frame *f;
2857 XGCValues gc_values;
2859 BLOCK_INPUT;
2861 /* Create the GCs of this frame.
2862 Note that many default values are used. */
2864 /* Normal video */
2865 gc_values.font = FRAME_FONT (f)->fid;
2866 gc_values.foreground = f->output_data.x->foreground_pixel;
2867 gc_values.background = f->output_data.x->background_pixel;
2868 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2869 f->output_data.x->normal_gc
2870 = XCreateGC (FRAME_X_DISPLAY (f),
2871 FRAME_X_WINDOW (f),
2872 GCLineWidth | GCFont | GCForeground | GCBackground,
2873 &gc_values);
2875 /* Reverse video style. */
2876 gc_values.foreground = f->output_data.x->background_pixel;
2877 gc_values.background = f->output_data.x->foreground_pixel;
2878 f->output_data.x->reverse_gc
2879 = XCreateGC (FRAME_X_DISPLAY (f),
2880 FRAME_X_WINDOW (f),
2881 GCFont | GCForeground | GCBackground | GCLineWidth,
2882 &gc_values);
2884 /* Cursor has cursor-color background, background-color foreground. */
2885 gc_values.foreground = f->output_data.x->background_pixel;
2886 gc_values.background = f->output_data.x->cursor_pixel;
2887 gc_values.fill_style = FillOpaqueStippled;
2888 gc_values.stipple
2889 = XCreateBitmapFromData (FRAME_X_DISPLAY (f),
2890 FRAME_X_DISPLAY_INFO (f)->root_window,
2891 cursor_bits, 16, 16);
2892 f->output_data.x->cursor_gc
2893 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2894 (GCFont | GCForeground | GCBackground
2895 | GCFillStyle /* | GCStipple */ | GCLineWidth),
2896 &gc_values);
2898 /* Reliefs. */
2899 f->output_data.x->white_relief.gc = 0;
2900 f->output_data.x->black_relief.gc = 0;
2902 /* Create the gray border tile used when the pointer is not in
2903 the frame. Since this depends on the frame's pixel values,
2904 this must be done on a per-frame basis. */
2905 f->output_data.x->border_tile
2906 = (XCreatePixmapFromBitmapData
2907 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
2908 gray_bits, gray_width, gray_height,
2909 f->output_data.x->foreground_pixel,
2910 f->output_data.x->background_pixel,
2911 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2913 UNBLOCK_INPUT;
2917 /* Free what was was allocated in x_make_gc. */
2919 void
2920 x_free_gcs (f)
2921 struct frame *f;
2923 Display *dpy = FRAME_X_DISPLAY (f);
2925 BLOCK_INPUT;
2927 if (f->output_data.x->normal_gc)
2929 XFreeGC (dpy, f->output_data.x->normal_gc);
2930 f->output_data.x->normal_gc = 0;
2933 if (f->output_data.x->reverse_gc)
2935 XFreeGC (dpy, f->output_data.x->reverse_gc);
2936 f->output_data.x->reverse_gc = 0;
2939 if (f->output_data.x->cursor_gc)
2941 XFreeGC (dpy, f->output_data.x->cursor_gc);
2942 f->output_data.x->cursor_gc = 0;
2945 if (f->output_data.x->border_tile)
2947 XFreePixmap (dpy, f->output_data.x->border_tile);
2948 f->output_data.x->border_tile = 0;
2951 UNBLOCK_INPUT;
2955 /* Handler for signals raised during x_create_frame and
2956 x_create_top_frame. FRAME is the frame which is partially
2957 constructed. */
2959 static Lisp_Object
2960 unwind_create_frame (frame)
2961 Lisp_Object frame;
2963 struct frame *f = XFRAME (frame);
2965 /* If frame is ``official'', nothing to do. */
2966 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
2968 #if GLYPH_DEBUG
2969 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2970 #endif
2972 x_free_frame_resources (f);
2974 #if GLYPH_DEBUG
2975 /* Check that reference counts are indeed correct. */
2976 xassert (dpyinfo->reference_count == dpyinfo_refcount);
2977 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
2978 #endif
2979 return Qt;
2982 return Qnil;
2986 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
2987 1, 1, 0,
2988 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
2989 Returns an Emacs frame object.
2990 ALIST is an alist of frame parameters.
2991 If the parameters specify that the frame should not have a minibuffer,
2992 and do not specify a specific minibuffer window to use,
2993 then `default-minibuffer-frame' must be a frame whose minibuffer can
2994 be shared by the new frame.
2996 This function is an internal primitive--use `make-frame' instead. */)
2997 (parms)
2998 Lisp_Object parms;
3000 struct frame *f;
3001 Lisp_Object frame, tem;
3002 Lisp_Object name;
3003 int minibuffer_only = 0;
3004 long window_prompting = 0;
3005 int width, height;
3006 int count = SPECPDL_INDEX ();
3007 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3008 Lisp_Object display;
3009 struct x_display_info *dpyinfo = NULL;
3010 Lisp_Object parent;
3011 struct kboard *kb;
3013 check_x ();
3015 parms = Fcopy_alist (parms);
3017 /* Use this general default value to start with
3018 until we know if this frame has a specified name. */
3019 Vx_resource_name = Vinvocation_name;
3021 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3022 if (EQ (display, Qunbound))
3023 display = Qnil;
3024 dpyinfo = check_x_display_info (display);
3025 #ifdef MULTI_KBOARD
3026 kb = dpyinfo->kboard;
3027 #else
3028 kb = &the_only_kboard;
3029 #endif
3031 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3032 if (!STRINGP (name)
3033 && ! EQ (name, Qunbound)
3034 && ! NILP (name))
3035 error ("Invalid frame name--not a string or nil");
3037 if (STRINGP (name))
3038 Vx_resource_name = name;
3040 /* See if parent window is specified. */
3041 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3042 if (EQ (parent, Qunbound))
3043 parent = Qnil;
3044 if (! NILP (parent))
3045 CHECK_NUMBER (parent);
3047 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3048 /* No need to protect DISPLAY because that's not used after passing
3049 it to make_frame_without_minibuffer. */
3050 frame = Qnil;
3051 GCPRO4 (parms, parent, name, frame);
3052 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3053 RES_TYPE_SYMBOL);
3054 if (EQ (tem, Qnone) || NILP (tem))
3055 f = make_frame_without_minibuffer (Qnil, kb, display);
3056 else if (EQ (tem, Qonly))
3058 f = make_minibuffer_frame ();
3059 minibuffer_only = 1;
3061 else if (WINDOWP (tem))
3062 f = make_frame_without_minibuffer (tem, kb, display);
3063 else
3064 f = make_frame (1);
3066 XSETFRAME (frame, f);
3068 /* Note that X Windows does support scroll bars. */
3069 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
3071 f->output_method = output_x_window;
3072 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
3073 bzero (f->output_data.x, sizeof (struct x_output));
3074 f->output_data.x->icon_bitmap = -1;
3075 FRAME_FONTSET (f) = -1;
3076 f->output_data.x->scroll_bar_foreground_pixel = -1;
3077 f->output_data.x->scroll_bar_background_pixel = -1;
3078 #ifdef USE_TOOLKIT_SCROLL_BARS
3079 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3080 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3081 #endif /* USE_TOOLKIT_SCROLL_BARS */
3082 record_unwind_protect (unwind_create_frame, frame);
3084 f->icon_name
3085 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3086 RES_TYPE_STRING);
3087 if (! STRINGP (f->icon_name))
3088 f->icon_name = Qnil;
3090 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3091 #if GLYPH_DEBUG
3092 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
3093 dpyinfo_refcount = dpyinfo->reference_count;
3094 #endif /* GLYPH_DEBUG */
3095 #ifdef MULTI_KBOARD
3096 FRAME_KBOARD (f) = kb;
3097 #endif
3099 /* These colors will be set anyway later, but it's important
3100 to get the color reference counts right, so initialize them! */
3102 Lisp_Object black;
3103 struct gcpro gcpro1;
3105 /* Function x_decode_color can signal an error. Make
3106 sure to initialize color slots so that we won't try
3107 to free colors we haven't allocated. */
3108 f->output_data.x->foreground_pixel = -1;
3109 f->output_data.x->background_pixel = -1;
3110 f->output_data.x->cursor_pixel = -1;
3111 f->output_data.x->cursor_foreground_pixel = -1;
3112 f->output_data.x->border_pixel = -1;
3113 f->output_data.x->mouse_pixel = -1;
3115 black = build_string ("black");
3116 GCPRO1 (black);
3117 f->output_data.x->foreground_pixel
3118 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3119 f->output_data.x->background_pixel
3120 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3121 f->output_data.x->cursor_pixel
3122 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3123 f->output_data.x->cursor_foreground_pixel
3124 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3125 f->output_data.x->border_pixel
3126 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3127 f->output_data.x->mouse_pixel
3128 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3129 UNGCPRO;
3132 /* Specify the parent under which to make this X window. */
3134 if (!NILP (parent))
3136 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3137 f->output_data.x->explicit_parent = 1;
3139 else
3141 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3142 f->output_data.x->explicit_parent = 0;
3145 /* Set the name; the functions to which we pass f expect the name to
3146 be set. */
3147 if (EQ (name, Qunbound) || NILP (name))
3149 f->name = build_string (dpyinfo->x_id_name);
3150 f->explicit_name = 0;
3152 else
3154 f->name = name;
3155 f->explicit_name = 1;
3156 /* use the frame's title when getting resources for this frame. */
3157 specbind (Qx_resource_name, name);
3160 /* Extract the window parameters from the supplied values
3161 that are needed to determine window geometry. */
3163 Lisp_Object font;
3165 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
3167 BLOCK_INPUT;
3168 /* First, try whatever font the caller has specified. */
3169 if (STRINGP (font))
3171 tem = Fquery_fontset (font, Qnil);
3172 if (STRINGP (tem))
3173 font = x_new_fontset (f, SDATA (tem));
3174 else
3175 font = x_new_font (f, SDATA (font));
3178 /* Try out a font which we hope has bold and italic variations. */
3179 if (!STRINGP (font))
3180 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
3181 if (!STRINGP (font))
3182 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3183 if (! STRINGP (font))
3184 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3185 if (! STRINGP (font))
3186 /* This was formerly the first thing tried, but it finds too many fonts
3187 and takes too long. */
3188 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
3189 /* If those didn't work, look for something which will at least work. */
3190 if (! STRINGP (font))
3191 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
3192 UNBLOCK_INPUT;
3193 if (! STRINGP (font))
3194 font = build_string ("fixed");
3196 x_default_parameter (f, parms, Qfont, font,
3197 "font", "Font", RES_TYPE_STRING);
3200 #ifdef USE_LUCID
3201 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
3202 whereby it fails to get any font. */
3203 xlwmenu_default_font = FRAME_FONT (f);
3204 #endif
3206 x_default_parameter (f, parms, Qborder_width, make_number (2),
3207 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3209 /* This defaults to 1 in order to match xterm. We recognize either
3210 internalBorderWidth or internalBorder (which is what xterm calls
3211 it). */
3212 if (NILP (Fassq (Qinternal_border_width, parms)))
3214 Lisp_Object value;
3216 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3217 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3218 if (! EQ (value, Qunbound))
3219 parms = Fcons (Fcons (Qinternal_border_width, value),
3220 parms);
3222 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
3223 "internalBorderWidth", "internalBorderWidth",
3224 RES_TYPE_NUMBER);
3225 x_default_parameter (f, parms, Qvertical_scroll_bars, Qleft,
3226 "verticalScrollBars", "ScrollBars",
3227 RES_TYPE_SYMBOL);
3229 /* Also do the stuff which must be set before the window exists. */
3230 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3231 "foreground", "Foreground", RES_TYPE_STRING);
3232 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3233 "background", "Background", RES_TYPE_STRING);
3234 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3235 "pointerColor", "Foreground", RES_TYPE_STRING);
3236 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
3237 "cursorColor", "Foreground", RES_TYPE_STRING);
3238 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3239 "borderColor", "BorderColor", RES_TYPE_STRING);
3240 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3241 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3242 x_default_parameter (f, parms, Qline_spacing, Qnil,
3243 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3244 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3245 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3246 x_default_parameter (f, parms, Qright_fringe, Qnil,
3247 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3249 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3250 "scrollBarForeground",
3251 "ScrollBarForeground", 1);
3252 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3253 "scrollBarBackground",
3254 "ScrollBarBackground", 0);
3256 /* Init faces before x_default_parameter is called for scroll-bar
3257 parameters because that function calls x_set_scroll_bar_width,
3258 which calls change_frame_size, which calls Fset_window_buffer,
3259 which runs hooks, which call Fvertical_motion. At the end, we
3260 end up in init_iterator with a null face cache, which should not
3261 happen. */
3262 init_frame_faces (f);
3264 x_default_parameter (f, parms, Qmenu_bar_lines, make_number (1),
3265 "menuBar", "MenuBar", RES_TYPE_NUMBER);
3266 x_default_parameter (f, parms, Qtool_bar_lines, make_number (1),
3267 "toolBar", "ToolBar", RES_TYPE_NUMBER);
3268 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3269 "bufferPredicate", "BufferPredicate",
3270 RES_TYPE_SYMBOL);
3271 x_default_parameter (f, parms, Qtitle, Qnil,
3272 "title", "Title", RES_TYPE_STRING);
3273 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3274 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3275 x_default_parameter (f, parms, Qfullscreen, Qnil,
3276 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3278 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3280 /* Compute the size of the X window. */
3281 window_prompting = x_figure_window_size (f, parms, 1);
3283 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3284 f->no_split = minibuffer_only || EQ (tem, Qt);
3286 x_icon_verify (f, parms);
3288 /* Create the X widget or window. */
3289 #ifdef USE_X_TOOLKIT
3290 x_window (f, window_prompting, minibuffer_only);
3291 #else
3292 x_window (f);
3293 #endif
3295 x_icon (f, parms);
3296 x_make_gc (f);
3298 /* Now consider the frame official. */
3299 FRAME_X_DISPLAY_INFO (f)->reference_count++;
3300 Vframe_list = Fcons (frame, Vframe_list);
3302 /* We need to do this after creating the X window, so that the
3303 icon-creation functions can say whose icon they're describing. */
3304 x_default_parameter (f, parms, Qicon_type, Qt,
3305 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
3307 x_default_parameter (f, parms, Qauto_raise, Qnil,
3308 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3309 x_default_parameter (f, parms, Qauto_lower, Qnil,
3310 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3311 x_default_parameter (f, parms, Qcursor_type, Qbox,
3312 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3313 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3314 "scrollBarWidth", "ScrollBarWidth",
3315 RES_TYPE_NUMBER);
3317 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3318 Change will not be effected unless different from the current
3319 FRAME_LINES (f). */
3320 width = FRAME_COLS (f);
3321 height = FRAME_LINES (f);
3323 SET_FRAME_COLS (f, 0);
3324 FRAME_LINES (f) = 0;
3325 change_frame_size (f, height, width, 1, 0, 0);
3327 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3328 /* Create the menu bar. */
3329 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3331 /* If this signals an error, we haven't set size hints for the
3332 frame and we didn't make it visible. */
3333 initialize_frame_menubar (f);
3335 #ifndef USE_GTK
3336 /* This is a no-op, except under Motif where it arranges the
3337 main window for the widgets on it. */
3338 lw_set_main_areas (f->output_data.x->column_widget,
3339 f->output_data.x->menubar_widget,
3340 f->output_data.x->edit_widget);
3341 #endif /* not USE_GTK */
3343 #endif /* USE_X_TOOLKIT || USE_GTK */
3345 /* Tell the server what size and position, etc, we want, and how
3346 badly we want them. This should be done after we have the menu
3347 bar so that its size can be taken into account. */
3348 BLOCK_INPUT;
3349 x_wm_set_size_hint (f, window_prompting, 0);
3350 UNBLOCK_INPUT;
3352 /* Make the window appear on the frame and enable display, unless
3353 the caller says not to. However, with explicit parent, Emacs
3354 cannot control visibility, so don't try. */
3355 if (! f->output_data.x->explicit_parent)
3357 Lisp_Object visibility;
3359 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3360 RES_TYPE_SYMBOL);
3361 if (EQ (visibility, Qunbound))
3362 visibility = Qt;
3364 if (EQ (visibility, Qicon))
3365 x_iconify_frame (f);
3366 else if (! NILP (visibility))
3367 x_make_frame_visible (f);
3368 else
3369 /* Must have been Qnil. */
3373 /* Set the WM leader property. GTK does this itself, so this is not
3374 needed when using GTK. */
3375 if (dpyinfo->client_leader_window != 0)
3377 BLOCK_INPUT;
3378 XChangeProperty (FRAME_X_DISPLAY (f),
3379 FRAME_OUTER_WINDOW (f),
3380 dpyinfo->Xatom_wm_client_leader,
3381 XA_WINDOW, 32, PropModeReplace,
3382 (unsigned char *) &dpyinfo->client_leader_window, 1);
3383 UNBLOCK_INPUT;
3386 /* Initialize `default-minibuffer-frame' in case this is the first
3387 frame on this display device. */
3388 if (FRAME_HAS_MINIBUF_P (f)
3389 && (!FRAMEP (kb->Vdefault_minibuffer_frame)
3390 || !FRAME_LIVE_P (XFRAME (kb->Vdefault_minibuffer_frame))))
3391 kb->Vdefault_minibuffer_frame = frame;
3393 /* All remaining specified parameters, which have not been "used"
3394 by x_get_arg and friends, now go in the misc. alist of the frame. */
3395 for (tem = parms; !NILP (tem); tem = XCDR (tem))
3396 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3397 f->param_alist = Fcons (XCAR (tem), f->param_alist);
3399 UNGCPRO;
3401 /* Make sure windows on this frame appear in calls to next-window
3402 and similar functions. */
3403 Vwindow_list = Qnil;
3405 return unbind_to (count, frame);
3409 /* FRAME is used only to get a handle on the X display. We don't pass the
3410 display info directly because we're called from frame.c, which doesn't
3411 know about that structure. */
3413 Lisp_Object
3414 x_get_focus_frame (frame)
3415 struct frame *frame;
3417 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
3418 Lisp_Object xfocus;
3419 if (! dpyinfo->x_focus_frame)
3420 return Qnil;
3422 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3423 return xfocus;
3427 /* In certain situations, when the window manager follows a
3428 click-to-focus policy, there seems to be no way around calling
3429 XSetInputFocus to give another frame the input focus .
3431 In an ideal world, XSetInputFocus should generally be avoided so
3432 that applications don't interfere with the window manager's focus
3433 policy. But I think it's okay to use when it's clearly done
3434 following a user-command. */
3436 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
3437 doc: /* Set the input focus to FRAME.
3438 FRAME nil means use the selected frame. */)
3439 (frame)
3440 Lisp_Object frame;
3442 struct frame *f = check_x_frame (frame);
3443 Display *dpy = FRAME_X_DISPLAY (f);
3444 int count;
3446 BLOCK_INPUT;
3447 count = x_catch_errors (dpy);
3448 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3449 RevertToParent, CurrentTime);
3450 x_uncatch_errors (dpy, count);
3451 UNBLOCK_INPUT;
3453 return Qnil;
3457 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3458 doc: /* Internal function called by `color-defined-p', which see. */)
3459 (color, frame)
3460 Lisp_Object color, frame;
3462 XColor foo;
3463 FRAME_PTR f = check_x_frame (frame);
3465 CHECK_STRING (color);
3467 if (x_defined_color (f, SDATA (color), &foo, 0))
3468 return Qt;
3469 else
3470 return Qnil;
3473 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3474 doc: /* Internal function called by `color-values', which see. */)
3475 (color, frame)
3476 Lisp_Object color, frame;
3478 XColor foo;
3479 FRAME_PTR f = check_x_frame (frame);
3481 CHECK_STRING (color);
3483 if (x_defined_color (f, SDATA (color), &foo, 0))
3485 Lisp_Object rgb[3];
3487 rgb[0] = make_number (foo.red);
3488 rgb[1] = make_number (foo.green);
3489 rgb[2] = make_number (foo.blue);
3490 return Flist (3, rgb);
3492 else
3493 return Qnil;
3496 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3497 doc: /* Internal function called by `display-color-p', which see. */)
3498 (display)
3499 Lisp_Object display;
3501 struct x_display_info *dpyinfo = check_x_display_info (display);
3503 if (dpyinfo->n_planes <= 2)
3504 return Qnil;
3506 switch (dpyinfo->visual->class)
3508 case StaticColor:
3509 case PseudoColor:
3510 case TrueColor:
3511 case DirectColor:
3512 return Qt;
3514 default:
3515 return Qnil;
3519 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3520 0, 1, 0,
3521 doc: /* Return t if the X display supports shades of gray.
3522 Note that color displays do support shades of gray.
3523 The optional argument DISPLAY specifies which display to ask about.
3524 DISPLAY should be either a frame or a display name (a string).
3525 If omitted or nil, that stands for the selected frame's display. */)
3526 (display)
3527 Lisp_Object display;
3529 struct x_display_info *dpyinfo = check_x_display_info (display);
3531 if (dpyinfo->n_planes <= 1)
3532 return Qnil;
3534 switch (dpyinfo->visual->class)
3536 case StaticColor:
3537 case PseudoColor:
3538 case TrueColor:
3539 case DirectColor:
3540 case StaticGray:
3541 case GrayScale:
3542 return Qt;
3544 default:
3545 return Qnil;
3549 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3550 0, 1, 0,
3551 doc: /* Returns the width in pixels of the X display DISPLAY.
3552 The optional argument DISPLAY specifies which display to ask about.
3553 DISPLAY should be either a frame or a display name (a string).
3554 If omitted or nil, that stands for the selected frame's display. */)
3555 (display)
3556 Lisp_Object display;
3558 struct x_display_info *dpyinfo = check_x_display_info (display);
3560 return make_number (dpyinfo->width);
3563 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3564 Sx_display_pixel_height, 0, 1, 0,
3565 doc: /* Returns the height in pixels of the X display DISPLAY.
3566 The optional argument DISPLAY specifies which display to ask about.
3567 DISPLAY should be either a frame or a display name (a string).
3568 If omitted or nil, that stands for the selected frame's display. */)
3569 (display)
3570 Lisp_Object display;
3572 struct x_display_info *dpyinfo = check_x_display_info (display);
3574 return make_number (dpyinfo->height);
3577 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3578 0, 1, 0,
3579 doc: /* Returns the number of bitplanes of the X display DISPLAY.
3580 The optional argument DISPLAY specifies which display to ask about.
3581 DISPLAY should be either a frame or a display name (a string).
3582 If omitted or nil, that stands for the selected frame's display. */)
3583 (display)
3584 Lisp_Object display;
3586 struct x_display_info *dpyinfo = check_x_display_info (display);
3588 return make_number (dpyinfo->n_planes);
3591 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3592 0, 1, 0,
3593 doc: /* Returns the number of color cells of the X display DISPLAY.
3594 The optional argument DISPLAY specifies which display to ask about.
3595 DISPLAY should be either a frame or a display name (a string).
3596 If omitted or nil, that stands for the selected frame's display. */)
3597 (display)
3598 Lisp_Object display;
3600 struct x_display_info *dpyinfo = check_x_display_info (display);
3602 int nr_planes = DisplayPlanes (dpyinfo->display,
3603 XScreenNumberOfScreen (dpyinfo->screen));
3605 /* Truncate nr_planes to 24 to avoid integer overflow.
3606 Some displays says 32, but only 24 bits are actually significant.
3607 There are only very few and rare video cards that have more than
3608 24 significant bits. Also 24 bits is more than 16 million colors,
3609 it "should be enough for everyone". */
3610 if (nr_planes > 24) nr_planes = 24;
3612 return make_number (1 << nr_planes);
3615 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3616 Sx_server_max_request_size,
3617 0, 1, 0,
3618 doc: /* Returns the maximum request size of the X server of display DISPLAY.
3619 The optional argument DISPLAY specifies which display to ask about.
3620 DISPLAY should be either a frame or a display name (a string).
3621 If omitted or nil, that stands for the selected frame's display. */)
3622 (display)
3623 Lisp_Object display;
3625 struct x_display_info *dpyinfo = check_x_display_info (display);
3627 return make_number (MAXREQUEST (dpyinfo->display));
3630 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3631 doc: /* Returns the "vendor ID" string of the X server of display DISPLAY.
3632 \(Labelling every distributor as a "vendor" embodies the false assumption
3633 that operating systems cannot be developed and distributed noncommercially.)
3634 The optional argument DISPLAY specifies which display to ask about.
3635 DISPLAY should be either a frame or a display name (a string).
3636 If omitted or nil, that stands for the selected frame's display. */)
3637 (display)
3638 Lisp_Object display;
3640 struct x_display_info *dpyinfo = check_x_display_info (display);
3641 char *vendor = ServerVendor (dpyinfo->display);
3643 if (! vendor) vendor = "";
3644 return build_string (vendor);
3647 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3648 doc: /* Returns the version numbers of the X server of display DISPLAY.
3649 The value is a list of three integers: the major and minor
3650 version numbers of the X Protocol in use, and the distributor-specific release
3651 number. See also the function `x-server-vendor'.
3653 The optional argument DISPLAY specifies which display to ask about.
3654 DISPLAY should be either a frame or a display name (a string).
3655 If omitted or nil, that stands for the selected frame's display. */)
3656 (display)
3657 Lisp_Object display;
3659 struct x_display_info *dpyinfo = check_x_display_info (display);
3660 Display *dpy = dpyinfo->display;
3662 return Fcons (make_number (ProtocolVersion (dpy)),
3663 Fcons (make_number (ProtocolRevision (dpy)),
3664 Fcons (make_number (VendorRelease (dpy)), Qnil)));
3667 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3668 doc: /* Return the number of screens on the X server of display DISPLAY.
3669 The optional argument DISPLAY specifies which display to ask about.
3670 DISPLAY should be either a frame or a display name (a string).
3671 If omitted or nil, that stands for the selected frame's display. */)
3672 (display)
3673 Lisp_Object display;
3675 struct x_display_info *dpyinfo = check_x_display_info (display);
3677 return make_number (ScreenCount (dpyinfo->display));
3680 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3681 doc: /* Return the height in millimeters of the X display DISPLAY.
3682 The optional argument DISPLAY specifies which display to ask about.
3683 DISPLAY should be either a frame or a display name (a string).
3684 If omitted or nil, that stands for the selected frame's display. */)
3685 (display)
3686 Lisp_Object display;
3688 struct x_display_info *dpyinfo = check_x_display_info (display);
3690 return make_number (HeightMMOfScreen (dpyinfo->screen));
3693 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3694 doc: /* Return the width in millimeters of the X display DISPLAY.
3695 The optional argument DISPLAY specifies which display to ask about.
3696 DISPLAY should be either a frame or a display name (a string).
3697 If omitted or nil, that stands for the selected frame's display. */)
3698 (display)
3699 Lisp_Object display;
3701 struct x_display_info *dpyinfo = check_x_display_info (display);
3703 return make_number (WidthMMOfScreen (dpyinfo->screen));
3706 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3707 Sx_display_backing_store, 0, 1, 0,
3708 doc: /* Returns an indication of whether X display DISPLAY does backing store.
3709 The value may be `always', `when-mapped', or `not-useful'.
3710 The optional argument DISPLAY specifies which display to ask about.
3711 DISPLAY should be either a frame or a display name (a string).
3712 If omitted or nil, that stands for the selected frame's display. */)
3713 (display)
3714 Lisp_Object display;
3716 struct x_display_info *dpyinfo = check_x_display_info (display);
3717 Lisp_Object result;
3719 switch (DoesBackingStore (dpyinfo->screen))
3721 case Always:
3722 result = intern ("always");
3723 break;
3725 case WhenMapped:
3726 result = intern ("when-mapped");
3727 break;
3729 case NotUseful:
3730 result = intern ("not-useful");
3731 break;
3733 default:
3734 error ("Strange value for BackingStore parameter of screen");
3735 result = Qnil;
3738 return result;
3741 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3742 Sx_display_visual_class, 0, 1, 0,
3743 doc: /* Return the visual class of the X display DISPLAY.
3744 The value is one of the symbols `static-gray', `gray-scale',
3745 `static-color', `pseudo-color', `true-color', or `direct-color'.
3747 The optional argument DISPLAY specifies which display to ask about.
3748 DISPLAY should be either a frame or a display name (a string).
3749 If omitted or nil, that stands for the selected frame's display. */)
3750 (display)
3751 Lisp_Object display;
3753 struct x_display_info *dpyinfo = check_x_display_info (display);
3754 Lisp_Object result;
3756 switch (dpyinfo->visual->class)
3758 case StaticGray:
3759 result = intern ("static-gray");
3760 break;
3761 case GrayScale:
3762 result = intern ("gray-scale");
3763 break;
3764 case StaticColor:
3765 result = intern ("static-color");
3766 break;
3767 case PseudoColor:
3768 result = intern ("pseudo-color");
3769 break;
3770 case TrueColor:
3771 result = intern ("true-color");
3772 break;
3773 case DirectColor:
3774 result = intern ("direct-color");
3775 break;
3776 default:
3777 error ("Display has an unknown visual class");
3778 result = Qnil;
3781 return result;
3784 DEFUN ("x-display-save-under", Fx_display_save_under,
3785 Sx_display_save_under, 0, 1, 0,
3786 doc: /* Returns t if the X display DISPLAY supports the save-under feature.
3787 The optional argument DISPLAY specifies which display to ask about.
3788 DISPLAY should be either a frame or a display name (a string).
3789 If omitted or nil, that stands for the selected frame's display. */)
3790 (display)
3791 Lisp_Object display;
3793 struct x_display_info *dpyinfo = check_x_display_info (display);
3795 if (DoesSaveUnders (dpyinfo->screen) == True)
3796 return Qt;
3797 else
3798 return Qnil;
3802 x_pixel_width (f)
3803 register struct frame *f;
3805 return FRAME_PIXEL_WIDTH (f);
3809 x_pixel_height (f)
3810 register struct frame *f;
3812 return FRAME_PIXEL_HEIGHT (f);
3816 x_char_width (f)
3817 register struct frame *f;
3819 return FRAME_COLUMN_WIDTH (f);
3823 x_char_height (f)
3824 register struct frame *f;
3826 return FRAME_LINE_HEIGHT (f);
3830 x_screen_planes (f)
3831 register struct frame *f;
3833 return FRAME_X_DISPLAY_INFO (f)->n_planes;
3838 /************************************************************************
3839 X Displays
3840 ************************************************************************/
3843 /* Mapping visual names to visuals. */
3845 static struct visual_class
3847 char *name;
3848 int class;
3850 visual_classes[] =
3852 {"StaticGray", StaticGray},
3853 {"GrayScale", GrayScale},
3854 {"StaticColor", StaticColor},
3855 {"PseudoColor", PseudoColor},
3856 {"TrueColor", TrueColor},
3857 {"DirectColor", DirectColor},
3858 {NULL, 0}
3862 #ifndef HAVE_XSCREENNUMBEROFSCREEN
3864 /* Value is the screen number of screen SCR. This is a substitute for
3865 the X function with the same name when that doesn't exist. */
3868 XScreenNumberOfScreen (scr)
3869 register Screen *scr;
3871 Display *dpy = scr->display;
3872 int i;
3874 for (i = 0; i < dpy->nscreens; ++i)
3875 if (scr == dpy->screens + i)
3876 break;
3878 return i;
3881 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
3884 /* Select the visual that should be used on display DPYINFO. Set
3885 members of DPYINFO appropriately. Called from x_term_init. */
3887 void
3888 select_visual (dpyinfo)
3889 struct x_display_info *dpyinfo;
3891 Display *dpy = dpyinfo->display;
3892 Screen *screen = dpyinfo->screen;
3893 Lisp_Object value;
3895 /* See if a visual is specified. */
3896 value = display_x_get_resource (dpyinfo,
3897 build_string ("visualClass"),
3898 build_string ("VisualClass"),
3899 Qnil, Qnil);
3900 if (STRINGP (value))
3902 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
3903 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
3904 depth, a decimal number. NAME is compared with case ignored. */
3905 char *s = (char *) alloca (SBYTES (value) + 1);
3906 char *dash;
3907 int i, class = -1;
3908 XVisualInfo vinfo;
3910 strcpy (s, SDATA (value));
3911 dash = index (s, '-');
3912 if (dash)
3914 dpyinfo->n_planes = atoi (dash + 1);
3915 *dash = '\0';
3917 else
3918 /* We won't find a matching visual with depth 0, so that
3919 an error will be printed below. */
3920 dpyinfo->n_planes = 0;
3922 /* Determine the visual class. */
3923 for (i = 0; visual_classes[i].name; ++i)
3924 if (xstricmp (s, visual_classes[i].name) == 0)
3926 class = visual_classes[i].class;
3927 break;
3930 /* Look up a matching visual for the specified class. */
3931 if (class == -1
3932 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
3933 dpyinfo->n_planes, class, &vinfo))
3934 fatal ("Invalid visual specification `%s'", SDATA (value));
3936 dpyinfo->visual = vinfo.visual;
3938 else
3940 int n_visuals;
3941 XVisualInfo *vinfo, vinfo_template;
3943 dpyinfo->visual = DefaultVisualOfScreen (screen);
3945 #ifdef HAVE_X11R4
3946 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
3947 #else
3948 vinfo_template.visualid = dpyinfo->visual->visualid;
3949 #endif
3950 vinfo_template.screen = XScreenNumberOfScreen (screen);
3951 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
3952 &vinfo_template, &n_visuals);
3953 if (n_visuals != 1)
3954 fatal ("Can't get proper X visual info");
3956 dpyinfo->n_planes = vinfo->depth;
3957 XFree ((char *) vinfo);
3962 /* Return the X display structure for the display named NAME.
3963 Open a new connection if necessary. */
3965 struct x_display_info *
3966 x_display_info_for_name (name)
3967 Lisp_Object name;
3969 Lisp_Object names;
3970 struct x_display_info *dpyinfo;
3972 CHECK_STRING (name);
3974 if (! EQ (Vwindow_system, intern ("x")))
3975 error ("Not using X Windows");
3977 for (dpyinfo = x_display_list, names = x_display_name_list;
3978 dpyinfo;
3979 dpyinfo = dpyinfo->next, names = XCDR (names))
3981 Lisp_Object tem;
3982 tem = Fstring_equal (XCAR (XCAR (names)), name);
3983 if (!NILP (tem))
3984 return dpyinfo;
3987 /* Use this general default value to start with. */
3988 Vx_resource_name = Vinvocation_name;
3990 validate_x_resource_name ();
3992 dpyinfo = x_term_init (name, (char *)0,
3993 (char *) SDATA (Vx_resource_name));
3995 if (dpyinfo == 0)
3996 error ("Cannot connect to X server %s", SDATA (name));
3998 x_in_use = 1;
3999 XSETFASTINT (Vwindow_system_version, 11);
4001 return dpyinfo;
4005 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4006 1, 3, 0,
4007 doc: /* Open a connection to an X server.
4008 DISPLAY is the name of the display to connect to.
4009 Optional second arg XRM-STRING is a string of resources in xrdb format.
4010 If the optional third arg MUST-SUCCEED is non-nil,
4011 terminate Emacs if we can't open the connection. */)
4012 (display, xrm_string, must_succeed)
4013 Lisp_Object display, xrm_string, must_succeed;
4015 unsigned char *xrm_option;
4016 struct x_display_info *dpyinfo;
4018 CHECK_STRING (display);
4019 if (! NILP (xrm_string))
4020 CHECK_STRING (xrm_string);
4022 if (! EQ (Vwindow_system, intern ("x")))
4023 error ("Not using X Windows");
4025 if (! NILP (xrm_string))
4026 xrm_option = (unsigned char *) SDATA (xrm_string);
4027 else
4028 xrm_option = (unsigned char *) 0;
4030 validate_x_resource_name ();
4032 /* This is what opens the connection and sets x_current_display.
4033 This also initializes many symbols, such as those used for input. */
4034 dpyinfo = x_term_init (display, xrm_option,
4035 (char *) SDATA (Vx_resource_name));
4037 if (dpyinfo == 0)
4039 if (!NILP (must_succeed))
4040 fatal ("Cannot connect to X server %s.\n\
4041 Check the DISPLAY environment variable or use `-d'.\n\
4042 Also use the `xauth' program to verify that you have the proper\n\
4043 authorization information needed to connect the X server.\n\
4044 An insecure way to solve the problem may be to use `xhost'.\n",
4045 SDATA (display));
4046 else
4047 error ("Cannot connect to X server %s", SDATA (display));
4050 x_in_use = 1;
4052 XSETFASTINT (Vwindow_system_version, 11);
4053 return Qnil;
4056 DEFUN ("x-close-connection", Fx_close_connection,
4057 Sx_close_connection, 1, 1, 0,
4058 doc: /* Close the connection to DISPLAY's X server.
4059 For DISPLAY, specify either a frame or a display name (a string).
4060 If DISPLAY is nil, that stands for the selected frame's display. */)
4061 (display)
4062 Lisp_Object display;
4064 struct x_display_info *dpyinfo = check_x_display_info (display);
4065 int i;
4067 if (dpyinfo->reference_count > 0)
4068 error ("Display still has frames on it");
4070 BLOCK_INPUT;
4071 /* Free the fonts in the font table. */
4072 for (i = 0; i < dpyinfo->n_fonts; i++)
4073 if (dpyinfo->font_table[i].name)
4075 XFreeFont (dpyinfo->display, dpyinfo->font_table[i].font);
4078 x_destroy_all_bitmaps (dpyinfo);
4079 XSetCloseDownMode (dpyinfo->display, DestroyAll);
4081 #ifdef USE_X_TOOLKIT
4082 XtCloseDisplay (dpyinfo->display);
4083 #else
4084 XCloseDisplay (dpyinfo->display);
4085 #endif
4087 x_delete_display (dpyinfo);
4088 UNBLOCK_INPUT;
4090 return Qnil;
4093 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4094 doc: /* Return the list of display names that Emacs has connections to. */)
4097 Lisp_Object tail, result;
4099 result = Qnil;
4100 for (tail = x_display_name_list; ! NILP (tail); tail = XCDR (tail))
4101 result = Fcons (XCAR (XCAR (tail)), result);
4103 return result;
4106 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4107 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4108 If ON is nil, allow buffering of requests.
4109 Turning on synchronization prohibits the Xlib routines from buffering
4110 requests and seriously degrades performance, but makes debugging much
4111 easier.
4112 The optional second argument DISPLAY specifies which display to act on.
4113 DISPLAY should be either a frame or a display name (a string).
4114 If DISPLAY is omitted or nil, that stands for the selected frame's display. */)
4115 (on, display)
4116 Lisp_Object display, on;
4118 struct x_display_info *dpyinfo = check_x_display_info (display);
4120 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4122 return Qnil;
4125 /* Wait for responses to all X commands issued so far for frame F. */
4127 void
4128 x_sync (f)
4129 FRAME_PTR f;
4131 BLOCK_INPUT;
4132 XSync (FRAME_X_DISPLAY (f), False);
4133 UNBLOCK_INPUT;
4137 /***********************************************************************
4138 Window properties
4139 ***********************************************************************/
4141 DEFUN ("x-change-window-property", Fx_change_window_property,
4142 Sx_change_window_property, 2, 6, 0,
4143 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4144 PROP must be a string.
4145 VALUE may be a string or a list of conses, numbers and/or strings.
4146 If an element in the list is a string, it is converted to
4147 an Atom and the value of the Atom is used. If an element is a cons,
4148 it is converted to a 32 bit number where the car is the 16 top bits and the
4149 cdr is the lower 16 bits.
4150 FRAME nil or omitted means use the selected frame.
4151 If TYPE is given and non-nil, it is the name of the type of VALUE.
4152 If TYPE is not given or nil, the type is STRING.
4153 FORMAT gives the size in bits of each element if VALUE is a list.
4154 It must be one of 8, 16 or 32.
4155 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4156 If OUTER_P is non-nil, the property is changed for the outer X window of
4157 FRAME. Default is to change on the edit X window.
4159 Value is VALUE. */)
4160 (prop, value, frame, type, format, outer_p)
4161 Lisp_Object prop, value, frame, type, format, outer_p;
4163 struct frame *f = check_x_frame (frame);
4164 Atom prop_atom;
4165 Atom target_type = XA_STRING;
4166 int element_format = 8;
4167 unsigned char *data;
4168 int nelements;
4169 Window w;
4171 CHECK_STRING (prop);
4173 if (! NILP (format))
4175 CHECK_NUMBER (format);
4176 element_format = XFASTINT (format);
4178 if (element_format != 8 && element_format != 16
4179 && element_format != 32)
4180 error ("FORMAT must be one of 8, 16 or 32");
4183 if (CONSP (value))
4185 nelements = x_check_property_data (value);
4186 if (nelements == -1)
4187 error ("Bad data in VALUE, must be number, string or cons");
4189 if (element_format == 8)
4190 data = (unsigned char *) xmalloc (nelements);
4191 else if (element_format == 16)
4192 data = (unsigned char *) xmalloc (nelements*2);
4193 else /* format == 32 */
4194 /* The man page for XChangeProperty:
4195 "If the specified format is 32, the property data must be a
4196 long array."
4197 This applies even if long is more than 64 bits. The X library
4198 converts to 32 bits before sending to the X server. */
4199 data = (unsigned char *) xmalloc (nelements * sizeof(long));
4201 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4203 else
4205 CHECK_STRING (value);
4206 data = SDATA (value);
4207 nelements = SCHARS (value);
4210 BLOCK_INPUT;
4211 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4212 if (! NILP (type))
4214 CHECK_STRING (type);
4215 target_type = XInternAtom (FRAME_X_DISPLAY (f), SDATA (type), False);
4218 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4219 else w = FRAME_X_WINDOW (f);
4221 XChangeProperty (FRAME_X_DISPLAY (f), w,
4222 prop_atom, target_type, element_format, PropModeReplace,
4223 data, nelements);
4225 if (CONSP (value)) xfree (data);
4227 /* Make sure the property is set when we return. */
4228 XFlush (FRAME_X_DISPLAY (f));
4229 UNBLOCK_INPUT;
4231 return value;
4235 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4236 Sx_delete_window_property, 1, 2, 0,
4237 doc: /* Remove window property PROP from X window of FRAME.
4238 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4239 (prop, frame)
4240 Lisp_Object prop, frame;
4242 struct frame *f = check_x_frame (frame);
4243 Atom prop_atom;
4245 CHECK_STRING (prop);
4246 BLOCK_INPUT;
4247 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4248 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4250 /* Make sure the property is removed when we return. */
4251 XFlush (FRAME_X_DISPLAY (f));
4252 UNBLOCK_INPUT;
4254 return prop;
4258 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4259 1, 6, 0,
4260 doc: /* Value is the value of window property PROP on FRAME.
4261 If FRAME is nil or omitted, use the selected frame.
4262 If TYPE is nil or omitted, get the property as a string. Otherwise TYPE
4263 is the name of the Atom that denotes the type expected.
4264 If SOURCE is non-nil, get the property on that window instead of from
4265 FRAME. The number 0 denotes the root window.
4266 If DELETE_P is non-nil, delete the property after retreiving it.
4267 If VECTOR_RET_P is non-nil, don't return a string but a vector of values.
4269 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4270 no value of TYPE. */)
4271 (prop, frame, type, source, delete_p, vector_ret_p)
4272 Lisp_Object prop, frame, type, source, delete_p, vector_ret_p;
4274 struct frame *f = check_x_frame (frame);
4275 Atom prop_atom;
4276 int rc;
4277 Lisp_Object prop_value = Qnil;
4278 unsigned char *tmp_data = NULL;
4279 Atom actual_type;
4280 Atom target_type = XA_STRING;
4281 int actual_format;
4282 unsigned long actual_size, bytes_remaining;
4283 Window target_window = FRAME_X_WINDOW (f);
4284 struct gcpro gcpro1;
4286 GCPRO1 (prop_value);
4287 CHECK_STRING (prop);
4289 if (! NILP (source))
4291 if (NUMBERP (source))
4293 if (FLOATP (source))
4294 target_window = (Window) XFLOAT (source);
4295 else
4296 target_window = XFASTINT (source);
4298 if (target_window == 0)
4299 target_window = FRAME_X_DISPLAY_INFO (f)->root_window;
4301 else if (CONSP (source))
4302 target_window = cons_to_long (source);
4305 BLOCK_INPUT;
4306 if (STRINGP (type))
4308 if (strcmp ("AnyPropertyType", SDATA (type)) == 0)
4309 target_type = AnyPropertyType;
4310 else
4311 target_type = XInternAtom (FRAME_X_DISPLAY (f), SDATA (type), False);
4314 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4315 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4316 prop_atom, 0, 0, False, target_type,
4317 &actual_type, &actual_format, &actual_size,
4318 &bytes_remaining, &tmp_data);
4319 if (rc == Success)
4321 int size = bytes_remaining;
4323 XFree (tmp_data);
4324 tmp_data = NULL;
4326 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4327 prop_atom, 0, bytes_remaining,
4328 ! NILP (delete_p), target_type,
4329 &actual_type, &actual_format,
4330 &actual_size, &bytes_remaining,
4331 &tmp_data);
4332 if (rc == Success && tmp_data)
4334 /* The man page for XGetWindowProperty says:
4335 "If the returned format is 32, the returned data is represented
4336 as a long array and should be cast to that type to obtain the
4337 elements."
4338 This applies even if long is more than 32 bits, the X library
4339 converts from 32 bit elements received from the X server to long
4340 and passes the long array to us. Thus, for that case bcopy can not
4341 be used. We convert to a 32 bit type here, because so much code
4342 assume on that.
4344 The bytes and offsets passed to XGetWindowProperty refers to the
4345 property and those are indeed in 32 bit quantities if format is
4346 32. */
4348 if (actual_format == 32 && actual_format < BITS_PER_LONG)
4350 unsigned long i;
4351 int *idata = (int *) tmp_data;
4352 long *ldata = (long *) tmp_data;
4354 for (i = 0; i < actual_size; ++i)
4355 idata[i] = (int) ldata[i];
4358 if (NILP (vector_ret_p))
4359 prop_value = make_string (tmp_data, size);
4360 else
4361 prop_value = x_property_data_to_lisp (f,
4362 tmp_data,
4363 actual_type,
4364 actual_format,
4365 actual_size);
4368 if (tmp_data) XFree (tmp_data);
4371 UNBLOCK_INPUT;
4372 UNGCPRO;
4373 return prop_value;
4378 /***********************************************************************
4379 Busy cursor
4380 ***********************************************************************/
4382 /* If non-null, an asynchronous timer that, when it expires, displays
4383 an hourglass cursor on all frames. */
4385 static struct atimer *hourglass_atimer;
4387 /* Non-zero means an hourglass cursor is currently shown. */
4389 static int hourglass_shown_p;
4391 /* Number of seconds to wait before displaying an hourglass cursor. */
4393 static Lisp_Object Vhourglass_delay;
4395 /* Default number of seconds to wait before displaying an hourglass
4396 cursor. */
4398 #define DEFAULT_HOURGLASS_DELAY 1
4400 /* Function prototypes. */
4402 static void show_hourglass P_ ((struct atimer *));
4403 static void hide_hourglass P_ ((void));
4405 /* Return non-zero if houglass timer has been started or hourglass is shown. */
4408 hourglass_started ()
4410 return hourglass_shown_p || hourglass_atimer != NULL;
4414 /* Cancel a currently active hourglass timer, and start a new one. */
4416 void
4417 start_hourglass ()
4419 EMACS_TIME delay;
4420 int secs, usecs = 0;
4422 /* Don't bother for ttys. */
4423 if (NILP (Vwindow_system))
4424 return;
4426 cancel_hourglass ();
4428 if (INTEGERP (Vhourglass_delay)
4429 && XINT (Vhourglass_delay) > 0)
4430 secs = XFASTINT (Vhourglass_delay);
4431 else if (FLOATP (Vhourglass_delay)
4432 && XFLOAT_DATA (Vhourglass_delay) > 0)
4434 Lisp_Object tem;
4435 tem = Ftruncate (Vhourglass_delay, Qnil);
4436 secs = XFASTINT (tem);
4437 usecs = (XFLOAT_DATA (Vhourglass_delay) - secs) * 1000000;
4439 else
4440 secs = DEFAULT_HOURGLASS_DELAY;
4442 EMACS_SET_SECS_USECS (delay, secs, usecs);
4443 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
4444 show_hourglass, NULL);
4448 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
4449 shown. */
4451 void
4452 cancel_hourglass ()
4454 if (hourglass_atimer)
4456 cancel_atimer (hourglass_atimer);
4457 hourglass_atimer = NULL;
4460 if (hourglass_shown_p)
4461 hide_hourglass ();
4465 /* Timer function of hourglass_atimer. TIMER is equal to
4466 hourglass_atimer.
4468 Display an hourglass pointer on all frames by mapping the frames'
4469 hourglass_window. Set the hourglass_p flag in the frames'
4470 output_data.x structure to indicate that an hourglass cursor is
4471 shown on the frames. */
4473 static void
4474 show_hourglass (timer)
4475 struct atimer *timer;
4477 /* The timer implementation will cancel this timer automatically
4478 after this function has run. Set hourglass_atimer to null
4479 so that we know the timer doesn't have to be canceled. */
4480 hourglass_atimer = NULL;
4482 if (!hourglass_shown_p)
4484 Lisp_Object rest, frame;
4486 BLOCK_INPUT;
4488 FOR_EACH_FRAME (rest, frame)
4490 struct frame *f = XFRAME (frame);
4492 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4494 Display *dpy = FRAME_X_DISPLAY (f);
4496 #ifdef USE_X_TOOLKIT
4497 if (f->output_data.x->widget)
4498 #else
4499 if (FRAME_OUTER_WINDOW (f))
4500 #endif
4502 f->output_data.x->hourglass_p = 1;
4504 if (!f->output_data.x->hourglass_window)
4506 unsigned long mask = CWCursor;
4507 XSetWindowAttributes attrs;
4508 #ifdef USE_GTK
4509 Window parent = FRAME_X_WINDOW (f);
4510 #else
4511 Window parent = FRAME_OUTER_WINDOW (f);
4512 #endif
4513 attrs.cursor = f->output_data.x->hourglass_cursor;
4515 f->output_data.x->hourglass_window
4516 = XCreateWindow (dpy, parent,
4517 0, 0, 32000, 32000, 0, 0,
4518 InputOnly,
4519 CopyFromParent,
4520 mask, &attrs);
4523 XMapRaised (dpy, f->output_data.x->hourglass_window);
4524 XFlush (dpy);
4529 hourglass_shown_p = 1;
4530 UNBLOCK_INPUT;
4535 /* Hide the hourglass pointer on all frames, if it is currently
4536 shown. */
4538 static void
4539 hide_hourglass ()
4541 if (hourglass_shown_p)
4543 Lisp_Object rest, frame;
4545 BLOCK_INPUT;
4546 FOR_EACH_FRAME (rest, frame)
4548 struct frame *f = XFRAME (frame);
4550 if (FRAME_X_P (f)
4551 /* Watch out for newly created frames. */
4552 && f->output_data.x->hourglass_window)
4554 XUnmapWindow (FRAME_X_DISPLAY (f),
4555 f->output_data.x->hourglass_window);
4556 /* Sync here because XTread_socket looks at the
4557 hourglass_p flag that is reset to zero below. */
4558 XSync (FRAME_X_DISPLAY (f), False);
4559 f->output_data.x->hourglass_p = 0;
4563 hourglass_shown_p = 0;
4564 UNBLOCK_INPUT;
4570 /***********************************************************************
4571 Tool tips
4572 ***********************************************************************/
4574 static Lisp_Object x_create_tip_frame P_ ((struct x_display_info *,
4575 Lisp_Object, Lisp_Object));
4576 static void compute_tip_xy P_ ((struct frame *, Lisp_Object, Lisp_Object,
4577 Lisp_Object, int, int, int *, int *));
4579 /* The frame of a currently visible tooltip. */
4581 Lisp_Object tip_frame;
4583 /* If non-nil, a timer started that hides the last tooltip when it
4584 fires. */
4586 Lisp_Object tip_timer;
4587 Window tip_window;
4589 /* If non-nil, a vector of 3 elements containing the last args
4590 with which x-show-tip was called. See there. */
4592 Lisp_Object last_show_tip_args;
4594 /* Maximum size for tooltips; a cons (COLUMNS . ROWS). */
4596 Lisp_Object Vx_max_tooltip_size;
4599 static Lisp_Object
4600 unwind_create_tip_frame (frame)
4601 Lisp_Object frame;
4603 Lisp_Object deleted;
4605 deleted = unwind_create_frame (frame);
4606 if (EQ (deleted, Qt))
4608 tip_window = None;
4609 tip_frame = Qnil;
4612 return deleted;
4616 /* Create a frame for a tooltip on the display described by DPYINFO.
4617 PARMS is a list of frame parameters. TEXT is the string to
4618 display in the tip frame. Value is the frame.
4620 Note that functions called here, esp. x_default_parameter can
4621 signal errors, for instance when a specified color name is
4622 undefined. We have to make sure that we're in a consistent state
4623 when this happens. */
4625 static Lisp_Object
4626 x_create_tip_frame (dpyinfo, parms, text)
4627 struct x_display_info *dpyinfo;
4628 Lisp_Object parms, text;
4630 struct frame *f;
4631 Lisp_Object frame, tem;
4632 Lisp_Object name;
4633 long window_prompting = 0;
4634 int width, height;
4635 int count = SPECPDL_INDEX ();
4636 struct gcpro gcpro1, gcpro2, gcpro3;
4637 struct kboard *kb;
4638 int face_change_count_before = face_change_count;
4639 Lisp_Object buffer;
4640 struct buffer *old_buffer;
4642 check_x ();
4645 #ifdef MULTI_KBOARD
4646 kb = dpyinfo->kboard;
4647 #else
4648 kb = &the_only_kboard;
4649 #endif
4651 /* Get the name of the frame to use for resource lookup. */
4652 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4653 if (!STRINGP (name)
4654 && !EQ (name, Qunbound)
4655 && !NILP (name))
4656 error ("Invalid frame name--not a string or nil");
4658 frame = Qnil;
4659 GCPRO3 (parms, name, frame);
4660 f = make_frame (1);
4661 XSETFRAME (frame, f);
4663 buffer = Fget_buffer_create (build_string (" *tip*"));
4664 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer, Qnil);
4665 old_buffer = current_buffer;
4666 set_buffer_internal_1 (XBUFFER (buffer));
4667 current_buffer->truncate_lines = Qnil;
4668 specbind (Qinhibit_read_only, Qt);
4669 specbind (Qinhibit_modification_hooks, Qt);
4670 Ferase_buffer ();
4671 Finsert (1, &text);
4672 set_buffer_internal_1 (old_buffer);
4674 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
4675 record_unwind_protect (unwind_create_tip_frame, frame);
4677 /* By setting the output method, we're essentially saying that
4678 the frame is live, as per FRAME_LIVE_P. If we get a signal
4679 from this point on, x_destroy_window might screw up reference
4680 counts etc. */
4681 f->output_method = output_x_window;
4682 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4683 bzero (f->output_data.x, sizeof (struct x_output));
4684 f->output_data.x->icon_bitmap = -1;
4685 FRAME_FONTSET (f) = -1;
4686 f->output_data.x->scroll_bar_foreground_pixel = -1;
4687 f->output_data.x->scroll_bar_background_pixel = -1;
4688 #ifdef USE_TOOLKIT_SCROLL_BARS
4689 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
4690 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
4691 #endif /* USE_TOOLKIT_SCROLL_BARS */
4692 f->icon_name = Qnil;
4693 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4694 #if GLYPH_DEBUG
4695 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
4696 dpyinfo_refcount = dpyinfo->reference_count;
4697 #endif /* GLYPH_DEBUG */
4698 #ifdef MULTI_KBOARD
4699 FRAME_KBOARD (f) = kb;
4700 #endif
4701 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4702 f->output_data.x->explicit_parent = 0;
4704 /* These colors will be set anyway later, but it's important
4705 to get the color reference counts right, so initialize them! */
4707 Lisp_Object black;
4708 struct gcpro gcpro1;
4710 black = build_string ("black");
4711 GCPRO1 (black);
4712 f->output_data.x->foreground_pixel
4713 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4714 f->output_data.x->background_pixel
4715 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4716 f->output_data.x->cursor_pixel
4717 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4718 f->output_data.x->cursor_foreground_pixel
4719 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4720 f->output_data.x->border_pixel
4721 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4722 f->output_data.x->mouse_pixel
4723 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4724 UNGCPRO;
4727 /* Set the name; the functions to which we pass f expect the name to
4728 be set. */
4729 if (EQ (name, Qunbound) || NILP (name))
4731 f->name = build_string (dpyinfo->x_id_name);
4732 f->explicit_name = 0;
4734 else
4736 f->name = name;
4737 f->explicit_name = 1;
4738 /* use the frame's title when getting resources for this frame. */
4739 specbind (Qx_resource_name, name);
4742 /* Extract the window parameters from the supplied values that are
4743 needed to determine window geometry. */
4745 Lisp_Object font;
4747 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4749 BLOCK_INPUT;
4750 /* First, try whatever font the caller has specified. */
4751 if (STRINGP (font))
4753 tem = Fquery_fontset (font, Qnil);
4754 if (STRINGP (tem))
4755 font = x_new_fontset (f, SDATA (tem));
4756 else
4757 font = x_new_font (f, SDATA (font));
4760 /* Try out a font which we hope has bold and italic variations. */
4761 if (!STRINGP (font))
4762 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
4763 if (!STRINGP (font))
4764 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4765 if (! STRINGP (font))
4766 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4767 if (! STRINGP (font))
4768 /* This was formerly the first thing tried, but it finds too many fonts
4769 and takes too long. */
4770 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
4771 /* If those didn't work, look for something which will at least work. */
4772 if (! STRINGP (font))
4773 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
4774 UNBLOCK_INPUT;
4775 if (! STRINGP (font))
4776 font = build_string ("fixed");
4778 x_default_parameter (f, parms, Qfont, font,
4779 "font", "Font", RES_TYPE_STRING);
4782 x_default_parameter (f, parms, Qborder_width, make_number (2),
4783 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4785 /* This defaults to 2 in order to match xterm. We recognize either
4786 internalBorderWidth or internalBorder (which is what xterm calls
4787 it). */
4788 if (NILP (Fassq (Qinternal_border_width, parms)))
4790 Lisp_Object value;
4792 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4793 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4794 if (! EQ (value, Qunbound))
4795 parms = Fcons (Fcons (Qinternal_border_width, value),
4796 parms);
4799 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4800 "internalBorderWidth", "internalBorderWidth",
4801 RES_TYPE_NUMBER);
4803 /* Also do the stuff which must be set before the window exists. */
4804 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4805 "foreground", "Foreground", RES_TYPE_STRING);
4806 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4807 "background", "Background", RES_TYPE_STRING);
4808 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4809 "pointerColor", "Foreground", RES_TYPE_STRING);
4810 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4811 "cursorColor", "Foreground", RES_TYPE_STRING);
4812 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4813 "borderColor", "BorderColor", RES_TYPE_STRING);
4815 /* Init faces before x_default_parameter is called for scroll-bar
4816 parameters because that function calls x_set_scroll_bar_width,
4817 which calls change_frame_size, which calls Fset_window_buffer,
4818 which runs hooks, which call Fvertical_motion. At the end, we
4819 end up in init_iterator with a null face cache, which should not
4820 happen. */
4821 init_frame_faces (f);
4823 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4825 window_prompting = x_figure_window_size (f, parms, 0);
4828 XSetWindowAttributes attrs;
4829 unsigned long mask;
4831 BLOCK_INPUT;
4832 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
4833 if (DoesSaveUnders (dpyinfo->screen))
4834 mask |= CWSaveUnder;
4836 /* Window managers look at the override-redirect flag to determine
4837 whether or net to give windows a decoration (Xlib spec, chapter
4838 3.2.8). */
4839 attrs.override_redirect = True;
4840 attrs.save_under = True;
4841 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4842 /* Arrange for getting MapNotify and UnmapNotify events. */
4843 attrs.event_mask = StructureNotifyMask;
4844 tip_window
4845 = FRAME_X_WINDOW (f)
4846 = XCreateWindow (FRAME_X_DISPLAY (f),
4847 FRAME_X_DISPLAY_INFO (f)->root_window,
4848 /* x, y, width, height */
4849 0, 0, 1, 1,
4850 /* Border. */
4852 CopyFromParent, InputOutput, CopyFromParent,
4853 mask, &attrs);
4854 UNBLOCK_INPUT;
4857 x_make_gc (f);
4859 x_default_parameter (f, parms, Qauto_raise, Qnil,
4860 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4861 x_default_parameter (f, parms, Qauto_lower, Qnil,
4862 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4863 x_default_parameter (f, parms, Qcursor_type, Qbox,
4864 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4866 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4867 Change will not be effected unless different from the current
4868 FRAME_LINES (f). */
4869 width = FRAME_COLS (f);
4870 height = FRAME_LINES (f);
4871 SET_FRAME_COLS (f, 0);
4872 FRAME_LINES (f) = 0;
4873 change_frame_size (f, height, width, 1, 0, 0);
4875 /* Add `tooltip' frame parameter's default value. */
4876 if (NILP (Fframe_parameter (frame, intern ("tooltip"))))
4877 Fmodify_frame_parameters (frame, Fcons (Fcons (intern ("tooltip"), Qt),
4878 Qnil));
4880 /* Set up faces after all frame parameters are known. This call
4881 also merges in face attributes specified for new frames.
4883 Frame parameters may be changed if .Xdefaults contains
4884 specifications for the default font. For example, if there is an
4885 `Emacs.default.attributeBackground: pink', the `background-color'
4886 attribute of the frame get's set, which let's the internal border
4887 of the tooltip frame appear in pink. Prevent this. */
4889 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
4891 /* Set tip_frame here, so that */
4892 tip_frame = frame;
4893 call1 (Qface_set_after_frame_default, frame);
4895 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
4896 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
4897 Qnil));
4900 f->no_split = 1;
4902 UNGCPRO;
4904 /* It is now ok to make the frame official even if we get an error
4905 below. And the frame needs to be on Vframe_list or making it
4906 visible won't work. */
4907 Vframe_list = Fcons (frame, Vframe_list);
4909 /* Now that the frame is official, it counts as a reference to
4910 its display. */
4911 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4913 /* Setting attributes of faces of the tooltip frame from resources
4914 and similar will increment face_change_count, which leads to the
4915 clearing of all current matrices. Since this isn't necessary
4916 here, avoid it by resetting face_change_count to the value it
4917 had before we created the tip frame. */
4918 face_change_count = face_change_count_before;
4920 /* Discard the unwind_protect. */
4921 return unbind_to (count, frame);
4925 /* Compute where to display tip frame F. PARMS is the list of frame
4926 parameters for F. DX and DY are specified offsets from the current
4927 location of the mouse. WIDTH and HEIGHT are the width and height
4928 of the tooltip. Return coordinates relative to the root window of
4929 the display in *ROOT_X, and *ROOT_Y. */
4931 static void
4932 compute_tip_xy (f, parms, dx, dy, width, height, root_x, root_y)
4933 struct frame *f;
4934 Lisp_Object parms, dx, dy;
4935 int width, height;
4936 int *root_x, *root_y;
4938 Lisp_Object left, top;
4939 int win_x, win_y;
4940 Window root, child;
4941 unsigned pmask;
4943 /* User-specified position? */
4944 left = Fcdr (Fassq (Qleft, parms));
4945 top = Fcdr (Fassq (Qtop, parms));
4947 /* Move the tooltip window where the mouse pointer is. Resize and
4948 show it. */
4949 if (!INTEGERP (left) || !INTEGERP (top))
4951 BLOCK_INPUT;
4952 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
4953 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
4954 UNBLOCK_INPUT;
4957 if (INTEGERP (top))
4958 *root_y = XINT (top);
4959 else if (*root_y + XINT (dy) <= 0)
4960 *root_y = 0; /* Can happen for negative dy */
4961 else if (*root_y + XINT (dy) + height <= FRAME_X_DISPLAY_INFO (f)->height)
4962 /* It fits below the pointer */
4963 *root_y += XINT (dy);
4964 else if (height + XINT (dy) <= *root_y)
4965 /* It fits above the pointer. */
4966 *root_y -= height + XINT (dy);
4967 else
4968 /* Put it on the top. */
4969 *root_y = 0;
4971 if (INTEGERP (left))
4972 *root_x = XINT (left);
4973 else if (*root_x + XINT (dx) <= 0)
4974 *root_x = 0; /* Can happen for negative dx */
4975 else if (*root_x + XINT (dx) + width <= FRAME_X_DISPLAY_INFO (f)->width)
4976 /* It fits to the right of the pointer. */
4977 *root_x += XINT (dx);
4978 else if (width + XINT (dx) <= *root_x)
4979 /* It fits to the left of the pointer. */
4980 *root_x -= width + XINT (dx);
4981 else
4982 /* Put it left-justified on the screen--it ought to fit that way. */
4983 *root_x = 0;
4987 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
4988 doc: /* Show STRING in a "tooltip" window on frame FRAME.
4989 A tooltip window is a small X window displaying a string.
4991 FRAME nil or omitted means use the selected frame.
4993 PARMS is an optional list of frame parameters which can be used to
4994 change the tooltip's appearance.
4996 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
4997 means use the default timeout of 5 seconds.
4999 If the list of frame parameters PARAMS contains a `left' parameters,
5000 the tooltip is displayed at that x-position. Otherwise it is
5001 displayed at the mouse position, with offset DX added (default is 5 if
5002 DX isn't specified). Likewise for the y-position; if a `top' frame
5003 parameter is specified, it determines the y-position of the tooltip
5004 window, otherwise it is displayed at the mouse position, with offset
5005 DY added (default is -10).
5007 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5008 Text larger than the specified size is clipped. */)
5009 (string, frame, parms, timeout, dx, dy)
5010 Lisp_Object string, frame, parms, timeout, dx, dy;
5012 struct frame *f;
5013 struct window *w;
5014 int root_x, root_y;
5015 struct buffer *old_buffer;
5016 struct text_pos pos;
5017 int i, width, height;
5018 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5019 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5020 int count = SPECPDL_INDEX ();
5022 specbind (Qinhibit_redisplay, Qt);
5024 GCPRO4 (string, parms, frame, timeout);
5026 CHECK_STRING (string);
5027 f = check_x_frame (frame);
5028 if (NILP (timeout))
5029 timeout = make_number (5);
5030 else
5031 CHECK_NATNUM (timeout);
5033 if (NILP (dx))
5034 dx = make_number (5);
5035 else
5036 CHECK_NUMBER (dx);
5038 if (NILP (dy))
5039 dy = make_number (-10);
5040 else
5041 CHECK_NUMBER (dy);
5043 if (NILP (last_show_tip_args))
5044 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5046 if (!NILP (tip_frame))
5048 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5049 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5050 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5052 if (EQ (frame, last_frame)
5053 && !NILP (Fequal (last_string, string))
5054 && !NILP (Fequal (last_parms, parms)))
5056 struct frame *f = XFRAME (tip_frame);
5058 /* Only DX and DY have changed. */
5059 if (!NILP (tip_timer))
5061 Lisp_Object timer = tip_timer;
5062 tip_timer = Qnil;
5063 call1 (Qcancel_timer, timer);
5066 BLOCK_INPUT;
5067 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
5068 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
5069 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5070 root_x, root_y);
5071 UNBLOCK_INPUT;
5072 goto start_timer;
5076 /* Hide a previous tip, if any. */
5077 Fx_hide_tip ();
5079 ASET (last_show_tip_args, 0, string);
5080 ASET (last_show_tip_args, 1, frame);
5081 ASET (last_show_tip_args, 2, parms);
5083 /* Add default values to frame parameters. */
5084 if (NILP (Fassq (Qname, parms)))
5085 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5086 if (NILP (Fassq (Qinternal_border_width, parms)))
5087 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5088 if (NILP (Fassq (Qborder_width, parms)))
5089 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5090 if (NILP (Fassq (Qborder_color, parms)))
5091 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5092 if (NILP (Fassq (Qbackground_color, parms)))
5093 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5094 parms);
5096 /* Create a frame for the tooltip, and record it in the global
5097 variable tip_frame. */
5098 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
5099 f = XFRAME (frame);
5101 /* Set up the frame's root window. */
5102 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5103 w->left_col = w->top_line = make_number (0);
5105 if (CONSP (Vx_max_tooltip_size)
5106 && INTEGERP (XCAR (Vx_max_tooltip_size))
5107 && XINT (XCAR (Vx_max_tooltip_size)) > 0
5108 && INTEGERP (XCDR (Vx_max_tooltip_size))
5109 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
5111 w->total_cols = XCAR (Vx_max_tooltip_size);
5112 w->total_lines = XCDR (Vx_max_tooltip_size);
5114 else
5116 w->total_cols = make_number (80);
5117 w->total_lines = make_number (40);
5120 FRAME_TOTAL_COLS (f) = XINT (w->total_cols);
5121 adjust_glyphs (f);
5122 w->pseudo_window_p = 1;
5124 /* Display the tooltip text in a temporary buffer. */
5125 old_buffer = current_buffer;
5126 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
5127 current_buffer->truncate_lines = Qnil;
5128 clear_glyph_matrix (w->desired_matrix);
5129 clear_glyph_matrix (w->current_matrix);
5130 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5131 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5133 /* Compute width and height of the tooltip. */
5134 width = height = 0;
5135 for (i = 0; i < w->desired_matrix->nrows; ++i)
5137 struct glyph_row *row = &w->desired_matrix->rows[i];
5138 struct glyph *last;
5139 int row_width;
5141 /* Stop at the first empty row at the end. */
5142 if (!row->enabled_p || !row->displays_text_p)
5143 break;
5145 /* Let the row go over the full width of the frame. */
5146 row->full_width_p = 1;
5148 /* There's a glyph at the end of rows that is used to place
5149 the cursor there. Don't include the width of this glyph. */
5150 if (row->used[TEXT_AREA])
5152 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5153 row_width = row->pixel_width - last->pixel_width;
5155 else
5156 row_width = row->pixel_width;
5158 height += row->height;
5159 width = max (width, row_width);
5162 /* Add the frame's internal border to the width and height the X
5163 window should have. */
5164 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5165 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5167 /* Move the tooltip window where the mouse pointer is. Resize and
5168 show it. */
5169 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5171 BLOCK_INPUT;
5172 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5173 root_x, root_y, width, height);
5174 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5175 UNBLOCK_INPUT;
5177 /* Draw into the window. */
5178 w->must_be_updated_p = 1;
5179 update_single_window (w, 1);
5181 /* Restore original current buffer. */
5182 set_buffer_internal_1 (old_buffer);
5183 windows_or_buffers_changed = old_windows_or_buffers_changed;
5185 start_timer:
5186 /* Let the tip disappear after timeout seconds. */
5187 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5188 intern ("x-hide-tip"));
5190 UNGCPRO;
5191 return unbind_to (count, Qnil);
5195 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5196 doc: /* Hide the current tooltip window, if there is any.
5197 Value is t if tooltip was open, nil otherwise. */)
5200 int count;
5201 Lisp_Object deleted, frame, timer;
5202 struct gcpro gcpro1, gcpro2;
5204 /* Return quickly if nothing to do. */
5205 if (NILP (tip_timer) && NILP (tip_frame))
5206 return Qnil;
5208 frame = tip_frame;
5209 timer = tip_timer;
5210 GCPRO2 (frame, timer);
5211 tip_frame = tip_timer = deleted = Qnil;
5213 count = SPECPDL_INDEX ();
5214 specbind (Qinhibit_redisplay, Qt);
5215 specbind (Qinhibit_quit, Qt);
5217 if (!NILP (timer))
5218 call1 (Qcancel_timer, timer);
5220 if (FRAMEP (frame))
5222 Fdelete_frame (frame, Qnil);
5223 deleted = Qt;
5225 #ifdef USE_LUCID
5226 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5227 redisplay procedure is not called when a tip frame over menu
5228 items is unmapped. Redisplay the menu manually... */
5230 struct frame *f = SELECTED_FRAME ();
5231 Widget w = f->output_data.x->menubar_widget;
5232 extern void xlwmenu_redisplay P_ ((Widget));
5234 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
5235 && w != NULL)
5237 BLOCK_INPUT;
5238 xlwmenu_redisplay (w);
5239 UNBLOCK_INPUT;
5242 #endif /* USE_LUCID */
5245 UNGCPRO;
5246 return unbind_to (count, deleted);
5251 /***********************************************************************
5252 File selection dialog
5253 ***********************************************************************/
5255 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5256 Sx_uses_old_gtk_dialog,
5257 0, 0, 0,
5258 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5261 #ifdef USE_GTK
5262 extern int use_dialog_box;
5263 extern int use_file_dialog;
5265 if (use_dialog_box
5266 && use_file_dialog
5267 && have_menus_p ()
5268 && xg_uses_old_file_dialog ())
5269 return Qt;
5270 #endif
5271 return Qnil;
5275 #ifdef USE_MOTIF
5276 /* Callback for "OK" and "Cancel" on file selection dialog. */
5278 static void
5279 file_dialog_cb (widget, client_data, call_data)
5280 Widget widget;
5281 XtPointer call_data, client_data;
5283 int *result = (int *) client_data;
5284 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
5285 *result = cb->reason;
5289 /* Callback for unmapping a file selection dialog. This is used to
5290 capture the case where a dialog is closed via a window manager's
5291 closer button, for example. Using a XmNdestroyCallback didn't work
5292 in this case. */
5294 static void
5295 file_dialog_unmap_cb (widget, client_data, call_data)
5296 Widget widget;
5297 XtPointer call_data, client_data;
5299 int *result = (int *) client_data;
5300 *result = XmCR_CANCEL;
5303 static Lisp_Object
5304 clean_up_file_dialog (arg)
5305 Lisp_Object arg;
5307 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
5308 Widget dialog = (Widget) p->pointer;
5310 /* Clean up. */
5311 BLOCK_INPUT;
5312 XtUnmanageChild (dialog);
5313 XtDestroyWidget (dialog);
5314 x_menu_set_in_use (0);
5315 UNBLOCK_INPUT;
5317 return Qnil;
5321 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5322 doc: /* Read file name, prompting with PROMPT in directory DIR.
5323 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5324 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5325 or directory must exist. ONLY-DIR-P is ignored." */)
5326 (prompt, dir, default_filename, mustmatch, only_dir_p)
5327 Lisp_Object prompt, dir, default_filename, mustmatch, only_dir_p;
5329 int result;
5330 struct frame *f = SELECTED_FRAME ();
5331 Lisp_Object file = Qnil;
5332 Lisp_Object decoded_file;
5333 Widget dialog, text, help;
5334 Arg al[10];
5335 int ac = 0;
5336 extern XtAppContext Xt_app_con;
5337 XmString dir_xmstring, pattern_xmstring;
5338 int count = SPECPDL_INDEX ();
5339 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5341 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5343 if (popup_activated ())
5344 error ("Trying to use a menu from within a menu-entry");
5346 CHECK_STRING (prompt);
5347 CHECK_STRING (dir);
5349 /* Prevent redisplay. */
5350 specbind (Qinhibit_redisplay, Qt);
5352 BLOCK_INPUT;
5354 /* Create the dialog with PROMPT as title, using DIR as initial
5355 directory and using "*" as pattern. */
5356 dir = Fexpand_file_name (dir, Qnil);
5357 dir_xmstring = XmStringCreateLocalized (SDATA (dir));
5358 pattern_xmstring = XmStringCreateLocalized ("*");
5360 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5361 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5362 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5363 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5364 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5365 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5366 "fsb", al, ac);
5367 XmStringFree (dir_xmstring);
5368 XmStringFree (pattern_xmstring);
5370 /* Add callbacks for OK and Cancel. */
5371 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5372 (XtPointer) &result);
5373 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5374 (XtPointer) &result);
5375 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5376 (XtPointer) &result);
5378 /* Remove the help button since we can't display help. */
5379 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5380 XtUnmanageChild (help);
5382 /* Mark OK button as default. */
5383 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5384 XmNshowAsDefault, True, NULL);
5386 /* If MUSTMATCH is non-nil, disable the file entry field of the
5387 dialog, so that the user must select a file from the files list
5388 box. We can't remove it because we wouldn't have a way to get at
5389 the result file name, then. */
5390 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5391 if (!NILP (mustmatch))
5393 Widget label;
5394 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5395 XtSetSensitive (text, False);
5396 XtSetSensitive (label, False);
5399 /* Manage the dialog, so that list boxes get filled. */
5400 XtManageChild (dialog);
5402 if (STRINGP (default_filename))
5404 XmString default_xmstring;
5405 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5406 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5408 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5409 XmTextFieldReplace (wtext, 0, last_pos,
5410 (SDATA (Ffile_name_nondirectory (default_filename))));
5412 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5413 must include the path for this to work. */
5415 default_xmstring = XmStringCreateLocalized (SDATA (default_filename));
5417 if (XmListItemExists (list, default_xmstring))
5419 int item_pos = XmListItemPos (list, default_xmstring);
5420 /* Select the item and scroll it into view. */
5421 XmListSelectPos (list, item_pos, True);
5422 XmListSetPos (list, item_pos);
5425 XmStringFree (default_xmstring);
5428 record_unwind_protect (clean_up_file_dialog, make_save_value (dialog, 0));
5430 /* Process events until the user presses Cancel or OK. */
5431 x_menu_set_in_use (1);
5432 result = 0;
5433 while (result == 0)
5435 XEvent event;
5436 x_menu_wait_for_event (0);
5437 XtAppNextEvent (Xt_app_con, &event);
5438 if (event.type == KeyPress
5439 && FRAME_X_DISPLAY (f) == event.xkey.display)
5441 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5443 /* Pop down on C-g. */
5444 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5445 XtUnmanageChild (dialog);
5448 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5451 /* Get the result. */
5452 if (result == XmCR_OK)
5454 XmString text;
5455 String data;
5457 XtVaGetValues (dialog, XmNtextString, &text, NULL);
5458 XmStringGetLtoR (text, XmFONTLIST_DEFAULT_TAG, &data);
5459 XmStringFree (text);
5460 file = build_string (data);
5461 XtFree (data);
5463 else
5464 file = Qnil;
5466 UNBLOCK_INPUT;
5467 UNGCPRO;
5469 /* Make "Cancel" equivalent to C-g. */
5470 if (NILP (file))
5471 Fsignal (Qquit, Qnil);
5473 decoded_file = DECODE_FILE (file);
5475 return unbind_to (count, decoded_file);
5478 #endif /* USE_MOTIF */
5480 #ifdef USE_GTK
5482 static Lisp_Object
5483 clean_up_dialog (arg)
5484 Lisp_Object arg;
5486 x_menu_set_in_use (0);
5488 return Qnil;
5491 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5492 doc: /* Read file name, prompting with PROMPT in directory DIR.
5493 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5494 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5495 or directory must exist. If ONLY-DIR-P is non-nil, the user can only select
5496 directories. */)
5497 (prompt, dir, default_filename, mustmatch, only_dir_p)
5498 Lisp_Object prompt, dir, default_filename, mustmatch, only_dir_p;
5500 FRAME_PTR f = SELECTED_FRAME ();
5501 char *fn;
5502 Lisp_Object file = Qnil;
5503 Lisp_Object decoded_file;
5504 int count = SPECPDL_INDEX ();
5505 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5506 char *cdef_file;
5508 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5510 if (popup_activated ())
5511 error ("Trying to use a menu from within a menu-entry");
5513 CHECK_STRING (prompt);
5514 CHECK_STRING (dir);
5516 /* Prevent redisplay. */
5517 specbind (Qinhibit_redisplay, Qt);
5518 record_unwind_protect (clean_up_dialog, Qnil);
5520 BLOCK_INPUT;
5522 if (STRINGP (default_filename))
5523 cdef_file = SDATA (default_filename);
5524 else
5525 cdef_file = SDATA (dir);
5527 fn = xg_get_file_name (f, SDATA (prompt), cdef_file,
5528 ! NILP (mustmatch),
5529 ! NILP (only_dir_p));
5531 if (fn)
5533 file = build_string (fn);
5534 xfree (fn);
5537 UNBLOCK_INPUT;
5538 UNGCPRO;
5540 /* Make "Cancel" equivalent to C-g. */
5541 if (NILP (file))
5542 Fsignal (Qquit, Qnil);
5544 decoded_file = DECODE_FILE (file);
5546 return unbind_to (count, decoded_file);
5549 #endif /* USE_GTK */
5552 /***********************************************************************
5553 Keyboard
5554 ***********************************************************************/
5556 #ifdef HAVE_XKBGETKEYBOARD
5557 #include <X11/XKBlib.h>
5558 #include <X11/keysym.h>
5559 #endif
5561 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
5562 Sx_backspace_delete_keys_p, 0, 1, 0,
5563 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
5564 FRAME nil means use the selected frame.
5565 Value is t if we know that both keys are present, and are mapped to the
5566 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
5567 present and mapped to the usual X keysyms. */)
5568 (frame)
5569 Lisp_Object frame;
5571 #ifdef HAVE_XKBGETKEYBOARD
5572 XkbDescPtr kb;
5573 struct frame *f = check_x_frame (frame);
5574 Display *dpy = FRAME_X_DISPLAY (f);
5575 Lisp_Object have_keys;
5576 int major, minor, op, event, error;
5578 BLOCK_INPUT;
5580 /* Check library version in case we're dynamically linked. */
5581 major = XkbMajorVersion;
5582 minor = XkbMinorVersion;
5583 if (!XkbLibraryVersion (&major, &minor))
5585 UNBLOCK_INPUT;
5586 return Qlambda;
5589 /* Check that the server supports XKB. */
5590 major = XkbMajorVersion;
5591 minor = XkbMinorVersion;
5592 if (!XkbQueryExtension (dpy, &op, &event, &error, &major, &minor))
5594 UNBLOCK_INPUT;
5595 return Qlambda;
5598 /* In this code we check that the keyboard has physical keys with names
5599 that start with BKSP (Backspace) and DELE (Delete), and that they
5600 generate keysym XK_BackSpace and XK_Delete respectively.
5601 This function is used to test if normal-erase-is-backspace should be
5602 turned on.
5603 An alternative approach would be to just check if XK_BackSpace and
5604 XK_Delete are mapped to any key. But if any of those are mapped to
5605 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
5606 user doesn't know about it, it is better to return false here.
5607 It is more obvious to the user what to do if she/he has two keys
5608 clearly marked with names/symbols and one key does something not
5609 expected (i.e. she/he then tries the other).
5610 The cases where Backspace/Delete is mapped to some other key combination
5611 are rare, and in those cases, normal-erase-is-backspace can be turned on
5612 manually. */
5614 have_keys = Qnil;
5615 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
5616 if (kb)
5618 int delete_keycode = 0, backspace_keycode = 0, i;
5620 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
5622 for (i = kb->min_key_code;
5623 (i < kb->max_key_code
5624 && (delete_keycode == 0 || backspace_keycode == 0));
5625 ++i)
5627 /* The XKB symbolic key names can be seen most easily in
5628 the PS file generated by `xkbprint -label name
5629 $DISPLAY'. */
5630 if (bcmp ("DELE", kb->names->keys[i].name, 4) == 0)
5631 delete_keycode = i;
5632 else if (bcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
5633 backspace_keycode = i;
5636 XkbFreeNames (kb, 0, True);
5639 XkbFreeClientMap (kb, 0, True);
5641 if (delete_keycode
5642 && backspace_keycode
5643 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
5644 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
5645 have_keys = Qt;
5647 UNBLOCK_INPUT;
5648 return have_keys;
5649 #else /* not HAVE_XKBGETKEYBOARD */
5650 return Qlambda;
5651 #endif /* not HAVE_XKBGETKEYBOARD */
5656 /***********************************************************************
5657 Initialization
5658 ***********************************************************************/
5660 /* Keep this list in the same order as frame_parms in frame.c.
5661 Use 0 for unsupported frame parameters. */
5663 frame_parm_handler x_frame_parm_handlers[] =
5665 x_set_autoraise,
5666 x_set_autolower,
5667 x_set_background_color,
5668 x_set_border_color,
5669 x_set_border_width,
5670 x_set_cursor_color,
5671 x_set_cursor_type,
5672 x_set_font,
5673 x_set_foreground_color,
5674 x_set_icon_name,
5675 x_set_icon_type,
5676 x_set_internal_border_width,
5677 x_set_menu_bar_lines,
5678 x_set_mouse_color,
5679 x_explicitly_set_name,
5680 x_set_scroll_bar_width,
5681 x_set_title,
5682 x_set_unsplittable,
5683 x_set_vertical_scroll_bars,
5684 x_set_visibility,
5685 x_set_tool_bar_lines,
5686 x_set_scroll_bar_foreground,
5687 x_set_scroll_bar_background,
5688 x_set_screen_gamma,
5689 x_set_line_spacing,
5690 x_set_fringe_width,
5691 x_set_fringe_width,
5692 x_set_wait_for_wm,
5693 x_set_fullscreen,
5696 void
5697 syms_of_xfns ()
5699 /* This is zero if not using X windows. */
5700 x_in_use = 0;
5702 /* The section below is built by the lisp expression at the top of the file,
5703 just above where these variables are declared. */
5704 /*&&& init symbols here &&&*/
5705 Qnone = intern ("none");
5706 staticpro (&Qnone);
5707 Qsuppress_icon = intern ("suppress-icon");
5708 staticpro (&Qsuppress_icon);
5709 Qundefined_color = intern ("undefined-color");
5710 staticpro (&Qundefined_color);
5711 Qcompound_text = intern ("compound-text");
5712 staticpro (&Qcompound_text);
5713 Qcancel_timer = intern ("cancel-timer");
5714 staticpro (&Qcancel_timer);
5715 /* This is the end of symbol initialization. */
5717 /* Text property `display' should be nonsticky by default. */
5718 Vtext_property_default_nonsticky
5719 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
5722 Fput (Qundefined_color, Qerror_conditions,
5723 Fcons (Qundefined_color, Fcons (Qerror, Qnil)));
5724 Fput (Qundefined_color, Qerror_message,
5725 build_string ("Undefined color"));
5727 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
5728 doc: /* The shape of the pointer when over text.
5729 Changing the value does not affect existing frames
5730 unless you set the mouse color. */);
5731 Vx_pointer_shape = Qnil;
5733 #if 0 /* This doesn't really do anything. */
5734 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape,
5735 doc: /* The shape of the pointer when not over text.
5736 This variable takes effect when you create a new frame
5737 or when you set the mouse color. */);
5738 #endif
5739 Vx_nontext_pointer_shape = Qnil;
5741 DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape,
5742 doc: /* The shape of the pointer when Emacs is busy.
5743 This variable takes effect when you create a new frame
5744 or when you set the mouse color. */);
5745 Vx_hourglass_pointer_shape = Qnil;
5747 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p,
5748 doc: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
5749 display_hourglass_p = 1;
5751 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay,
5752 doc: /* *Seconds to wait before displaying an hourglass pointer.
5753 Value must be an integer or float. */);
5754 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
5756 #if 0 /* This doesn't really do anything. */
5757 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape,
5758 doc: /* The shape of the pointer when over the mode line.
5759 This variable takes effect when you create a new frame
5760 or when you set the mouse color. */);
5761 #endif
5762 Vx_mode_pointer_shape = Qnil;
5764 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
5765 &Vx_sensitive_text_pointer_shape,
5766 doc: /* The shape of the pointer when over mouse-sensitive text.
5767 This variable takes effect when you create a new frame
5768 or when you set the mouse color. */);
5769 Vx_sensitive_text_pointer_shape = Qnil;
5771 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
5772 &Vx_window_horizontal_drag_shape,
5773 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
5774 This variable takes effect when you create a new frame
5775 or when you set the mouse color. */);
5776 Vx_window_horizontal_drag_shape = Qnil;
5778 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
5779 doc: /* A string indicating the foreground color of the cursor box. */);
5780 Vx_cursor_fore_pixel = Qnil;
5782 DEFVAR_LISP ("x-max-tooltip-size", &Vx_max_tooltip_size,
5783 doc: /* Maximum size for tooltips. Value is a pair (COLUMNS . ROWS).
5784 Text larger than this is clipped. */);
5785 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
5787 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
5788 doc: /* Non-nil if no X window manager is in use.
5789 Emacs doesn't try to figure this out; this is always nil
5790 unless you set it to something else. */);
5791 /* We don't have any way to find this out, so set it to nil
5792 and maybe the user would like to set it to t. */
5793 Vx_no_window_manager = Qnil;
5795 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
5796 &Vx_pixel_size_width_font_regexp,
5797 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
5799 Since Emacs gets width of a font matching with this regexp from
5800 PIXEL_SIZE field of the name, font finding mechanism gets faster for
5801 such a font. This is especially effective for such large fonts as
5802 Chinese, Japanese, and Korean. */);
5803 Vx_pixel_size_width_font_regexp = Qnil;
5805 /* This is not ifdef:ed, so other builds than GTK can customize it. */
5806 DEFVAR_BOOL ("x-use-old-gtk-file-dialog", &x_use_old_gtk_file_dialog,
5807 doc: /* *Non-nil means prompt with the old GTK file selection dialog.
5808 If nil or if the file selection dialog is not available, the new GTK file
5809 chooser is used instead. To turn off all file dialogs set the
5810 variable `use-file-dialog'. */);
5811 x_use_old_gtk_file_dialog = 0;
5813 DEFVAR_BOOL ("x-gtk-show-hidden-files", &x_gtk_show_hidden_files,
5814 doc: /* *If non-nil, the GTK file chooser will by default show hidden files.
5815 Note that this is just the default, there is a toggle button on the file
5816 chooser to show or not show hidden files on a case by case basis. */);
5817 x_gtk_show_hidden_files = 0;
5819 DEFVAR_BOOL ("x-gtk-whole-detached-tool-bar", &x_gtk_whole_detached_tool_bar,
5820 doc: /* *If non-nil, a detached tool bar is shown in full.
5821 The default is to just show an arrow and pressing on that arrow shows
5822 the tool bar buttons. */);
5823 x_gtk_whole_detached_tool_bar = 0;
5825 Fprovide (intern ("x"), Qnil);
5827 #ifdef USE_X_TOOLKIT
5828 Fprovide (intern ("x-toolkit"), Qnil);
5829 #ifdef USE_MOTIF
5830 Fprovide (intern ("motif"), Qnil);
5832 DEFVAR_LISP ("motif-version-string", &Vmotif_version_string,
5833 doc: /* Version info for LessTif/Motif. */);
5834 Vmotif_version_string = build_string (XmVERSION_STRING);
5835 #endif /* USE_MOTIF */
5836 #endif /* USE_X_TOOLKIT */
5838 #ifdef USE_GTK
5839 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
5840 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
5841 But for a user it is a toolkit for X, and indeed, configure
5842 accepts --with-x-toolkit=gtk. */
5843 Fprovide (intern ("x-toolkit"), Qnil);
5844 Fprovide (intern ("gtk"), Qnil);
5846 DEFVAR_LISP ("gtk-version-string", &Vgtk_version_string,
5847 doc: /* Version info for GTK+. */);
5849 char gtk_version[40];
5850 g_snprintf (gtk_version, sizeof (gtk_version), "%u.%u.%u",
5851 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
5852 Vgtk_version_string = build_string (gtk_version);
5854 #endif /* USE_GTK */
5856 /* X window properties. */
5857 defsubr (&Sx_change_window_property);
5858 defsubr (&Sx_delete_window_property);
5859 defsubr (&Sx_window_property);
5861 defsubr (&Sxw_display_color_p);
5862 defsubr (&Sx_display_grayscale_p);
5863 defsubr (&Sxw_color_defined_p);
5864 defsubr (&Sxw_color_values);
5865 defsubr (&Sx_server_max_request_size);
5866 defsubr (&Sx_server_vendor);
5867 defsubr (&Sx_server_version);
5868 defsubr (&Sx_display_pixel_width);
5869 defsubr (&Sx_display_pixel_height);
5870 defsubr (&Sx_display_mm_width);
5871 defsubr (&Sx_display_mm_height);
5872 defsubr (&Sx_display_screens);
5873 defsubr (&Sx_display_planes);
5874 defsubr (&Sx_display_color_cells);
5875 defsubr (&Sx_display_visual_class);
5876 defsubr (&Sx_display_backing_store);
5877 defsubr (&Sx_display_save_under);
5878 defsubr (&Sx_create_frame);
5879 defsubr (&Sx_open_connection);
5880 defsubr (&Sx_close_connection);
5881 defsubr (&Sx_display_list);
5882 defsubr (&Sx_synchronize);
5883 defsubr (&Sx_focus_frame);
5884 defsubr (&Sx_backspace_delete_keys_p);
5886 /* Setting callback functions for fontset handler. */
5887 get_font_info_func = x_get_font_info;
5889 #if 0 /* This function pointer doesn't seem to be used anywhere.
5890 And the pointer assigned has the wrong type, anyway. */
5891 list_fonts_func = x_list_fonts;
5892 #endif
5894 load_font_func = x_load_font;
5895 find_ccl_program_func = x_find_ccl_program;
5896 query_font_func = x_query_font;
5897 set_frame_fontset_func = x_set_font;
5898 check_window_system_func = check_x;
5900 hourglass_atimer = NULL;
5901 hourglass_shown_p = 0;
5903 defsubr (&Sx_show_tip);
5904 defsubr (&Sx_hide_tip);
5905 tip_timer = Qnil;
5906 staticpro (&tip_timer);
5907 tip_frame = Qnil;
5908 staticpro (&tip_frame);
5910 last_show_tip_args = Qnil;
5911 staticpro (&last_show_tip_args);
5913 defsubr (&Sx_uses_old_gtk_dialog);
5914 #if defined (USE_MOTIF) || defined (USE_GTK)
5915 defsubr (&Sx_file_dialog);
5916 #endif
5919 #endif /* HAVE_X_WINDOWS */
5921 /* arch-tag: 55040d02-5485-4d58-8b22-95a7a05f3288
5922 (do not change this comment) */