(Single Shell, Interactive Shell): Fix xrefs.
[emacs.git] / src / xfns.c
blob02d525ecd91cfe87de5701421eeb6949e88ac7fa
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 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 /* The background and shape of the mouse pointer, and shape when not
162 over text or in the modeline. */
164 Lisp_Object Vx_pointer_shape, Vx_nontext_pointer_shape, Vx_mode_pointer_shape;
165 Lisp_Object Vx_hourglass_pointer_shape;
167 /* The shape when over mouse-sensitive text. */
169 Lisp_Object Vx_sensitive_text_pointer_shape;
171 /* If non-nil, the pointer shape to indicate that windows can be
172 dragged horizontally. */
174 Lisp_Object Vx_window_horizontal_drag_shape;
176 /* Color of chars displayed in cursor box. */
178 Lisp_Object Vx_cursor_fore_pixel;
180 /* Nonzero if using X. */
182 static int x_in_use;
184 /* Non nil if no window manager is in use. */
186 Lisp_Object Vx_no_window_manager;
188 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
190 Lisp_Object Vx_pixel_size_width_font_regexp;
192 Lisp_Object Qnone;
193 Lisp_Object Qsuppress_icon;
194 Lisp_Object Qundefined_color;
195 Lisp_Object Qcompound_text, Qcancel_timer;
197 /* In dispnew.c */
199 extern Lisp_Object Vwindow_system_version;
201 /* The below are defined in frame.c. */
203 #if GLYPH_DEBUG
204 int image_cache_refcount, dpyinfo_refcount;
205 #endif
209 /* Error if we are not connected to X. */
211 void
212 check_x ()
214 if (! x_in_use)
215 error ("X windows are not in use or not initialized");
218 /* Nonzero if we can use mouse menus.
219 You should not call this unless HAVE_MENUS is defined. */
222 have_menus_p ()
224 return x_in_use;
227 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
228 and checking validity for X. */
230 FRAME_PTR
231 check_x_frame (frame)
232 Lisp_Object frame;
234 FRAME_PTR f;
236 if (NILP (frame))
237 frame = selected_frame;
238 CHECK_LIVE_FRAME (frame);
239 f = XFRAME (frame);
240 if (! FRAME_X_P (f))
241 error ("Non-X frame used");
242 return f;
245 /* Let the user specify an X display with a frame.
246 nil stands for the selected frame--or, if that is not an X frame,
247 the first X display on the list. */
249 struct x_display_info *
250 check_x_display_info (frame)
251 Lisp_Object frame;
253 struct x_display_info *dpyinfo = NULL;
255 if (NILP (frame))
257 struct frame *sf = XFRAME (selected_frame);
259 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
260 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
261 else if (x_display_list != 0)
262 dpyinfo = x_display_list;
263 else
264 error ("X windows are not in use or not initialized");
266 else if (STRINGP (frame))
267 dpyinfo = x_display_info_for_name (frame);
268 else
270 FRAME_PTR f = check_x_frame (frame);
271 dpyinfo = FRAME_X_DISPLAY_INFO (f);
274 return dpyinfo;
278 /* Return the Emacs frame-object corresponding to an X window.
279 It could be the frame's main window or an icon window. */
281 /* This function can be called during GC, so use GC_xxx type test macros. */
283 struct frame *
284 x_window_to_frame (dpyinfo, wdesc)
285 struct x_display_info *dpyinfo;
286 int wdesc;
288 Lisp_Object tail, frame;
289 struct frame *f;
291 if (wdesc == None) return 0;
293 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
295 frame = XCAR (tail);
296 if (!GC_FRAMEP (frame))
297 continue;
298 f = XFRAME (frame);
299 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
300 continue;
301 if (f->output_data.x->hourglass_window == wdesc)
302 return f;
303 #ifdef USE_X_TOOLKIT
304 if ((f->output_data.x->edit_widget
305 && XtWindow (f->output_data.x->edit_widget) == wdesc)
306 /* A tooltip frame? */
307 || (!f->output_data.x->edit_widget
308 && FRAME_X_WINDOW (f) == wdesc)
309 || f->output_data.x->icon_desc == wdesc)
310 return f;
311 #else /* not USE_X_TOOLKIT */
312 #ifdef USE_GTK
313 if (f->output_data.x->edit_widget)
315 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
316 struct x_output *x = f->output_data.x;
317 if (gwdesc != 0 && gwdesc == x->edit_widget)
318 return f;
320 #endif /* USE_GTK */
321 if (FRAME_X_WINDOW (f) == wdesc
322 || f->output_data.x->icon_desc == wdesc)
323 return f;
324 #endif /* not USE_X_TOOLKIT */
326 return 0;
329 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
330 /* Like x_window_to_frame but also compares the window with the widget's
331 windows. */
333 struct frame *
334 x_any_window_to_frame (dpyinfo, wdesc)
335 struct x_display_info *dpyinfo;
336 int wdesc;
338 Lisp_Object tail, frame;
339 struct frame *f, *found;
340 struct x_output *x;
342 if (wdesc == None) return NULL;
344 found = NULL;
345 for (tail = Vframe_list; GC_CONSP (tail) && !found; tail = XCDR (tail))
347 frame = XCAR (tail);
348 if (!GC_FRAMEP (frame))
349 continue;
351 f = XFRAME (frame);
352 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
354 /* This frame matches if the window is any of its widgets. */
355 x = f->output_data.x;
356 if (x->hourglass_window == wdesc)
357 found = f;
358 else if (x->widget)
360 #ifdef USE_GTK
361 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
362 if (gwdesc != 0
363 && (gwdesc == x->widget
364 || gwdesc == x->edit_widget
365 || gwdesc == x->vbox_widget
366 || gwdesc == x->menubar_widget))
367 found = f;
368 #else
369 if (wdesc == XtWindow (x->widget)
370 || wdesc == XtWindow (x->column_widget)
371 || wdesc == XtWindow (x->edit_widget))
372 found = f;
373 /* Match if the window is this frame's menubar. */
374 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
375 found = f;
376 #endif
378 else if (FRAME_X_WINDOW (f) == wdesc)
379 /* A tooltip frame. */
380 found = f;
384 return found;
387 /* Likewise, but exclude the menu bar widget. */
389 struct frame *
390 x_non_menubar_window_to_frame (dpyinfo, wdesc)
391 struct x_display_info *dpyinfo;
392 int wdesc;
394 Lisp_Object tail, frame;
395 struct frame *f;
396 struct x_output *x;
398 if (wdesc == None) return 0;
400 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
402 frame = XCAR (tail);
403 if (!GC_FRAMEP (frame))
404 continue;
405 f = XFRAME (frame);
406 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
407 continue;
408 x = f->output_data.x;
409 /* This frame matches if the window is any of its widgets. */
410 if (x->hourglass_window == wdesc)
411 return f;
412 else if (x->widget)
414 #ifdef USE_GTK
415 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
416 if (gwdesc != 0
417 && (gwdesc == x->widget
418 || gwdesc == x->edit_widget
419 || gwdesc == x->vbox_widget))
420 return f;
421 #else
422 if (wdesc == XtWindow (x->widget)
423 || wdesc == XtWindow (x->column_widget)
424 || wdesc == XtWindow (x->edit_widget))
425 return f;
426 #endif
428 else if (FRAME_X_WINDOW (f) == wdesc)
429 /* A tooltip frame. */
430 return f;
432 return 0;
435 /* Likewise, but consider only the menu bar widget. */
437 struct frame *
438 x_menubar_window_to_frame (dpyinfo, wdesc)
439 struct x_display_info *dpyinfo;
440 int wdesc;
442 Lisp_Object tail, frame;
443 struct frame *f;
444 struct x_output *x;
446 if (wdesc == None) return 0;
448 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
450 frame = XCAR (tail);
451 if (!GC_FRAMEP (frame))
452 continue;
453 f = XFRAME (frame);
454 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
455 continue;
456 x = f->output_data.x;
457 /* Match if the window is this frame's menubar. */
458 #ifdef USE_GTK
459 if (x->menubar_widget)
461 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
462 int found = 0;
464 BLOCK_INPUT;
465 if (gwdesc != 0
466 && (gwdesc == x->menubar_widget
467 || gtk_widget_get_parent (gwdesc) == x->menubar_widget))
468 found = 1;
469 UNBLOCK_INPUT;
470 if (found) return f;
472 #else
473 if (x->menubar_widget
474 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
475 return f;
476 #endif
478 return 0;
481 /* Return the frame whose principal (outermost) window is WDESC.
482 If WDESC is some other (smaller) window, we return 0. */
484 struct frame *
485 x_top_window_to_frame (dpyinfo, wdesc)
486 struct x_display_info *dpyinfo;
487 int wdesc;
489 Lisp_Object tail, frame;
490 struct frame *f;
491 struct x_output *x;
493 if (wdesc == None) return 0;
495 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
497 frame = XCAR (tail);
498 if (!GC_FRAMEP (frame))
499 continue;
500 f = XFRAME (frame);
501 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
502 continue;
503 x = f->output_data.x;
505 if (x->widget)
507 /* This frame matches if the window is its topmost widget. */
508 #ifdef USE_GTK
509 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
510 if (gwdesc == x->widget)
511 return f;
512 #else
513 if (wdesc == XtWindow (x->widget))
514 return f;
515 #if 0 /* I don't know why it did this,
516 but it seems logically wrong,
517 and it causes trouble for MapNotify events. */
518 /* Match if the window is this frame's menubar. */
519 if (x->menubar_widget
520 && wdesc == XtWindow (x->menubar_widget))
521 return f;
522 #endif
523 #endif
525 else if (FRAME_X_WINDOW (f) == wdesc)
526 /* Tooltip frame. */
527 return f;
529 return 0;
531 #endif /* USE_X_TOOLKIT || USE_GTK */
535 static Lisp_Object unwind_create_frame P_ ((Lisp_Object));
536 static Lisp_Object unwind_create_tip_frame P_ ((Lisp_Object));
538 void x_set_foreground_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
539 static void x_set_wait_for_wm P_ ((struct frame *, Lisp_Object, Lisp_Object));
540 void x_set_background_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
541 void x_set_mouse_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
542 void x_set_cursor_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
543 void x_set_border_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
544 void x_set_cursor_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
545 void x_set_icon_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
546 void x_set_icon_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
547 void x_explicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
548 void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
549 void x_set_title P_ ((struct frame *, Lisp_Object, Lisp_Object));
550 void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
551 void x_set_scroll_bar_foreground P_ ((struct frame *, Lisp_Object,
552 Lisp_Object));
553 void x_set_scroll_bar_background P_ ((struct frame *, Lisp_Object,
554 Lisp_Object));
555 static Lisp_Object x_default_scroll_bar_color_parameter P_ ((struct frame *,
556 Lisp_Object,
557 Lisp_Object,
558 char *, char *,
559 int));
562 /* Store the screen positions of frame F into XPTR and YPTR.
563 These are the positions of the containing window manager window,
564 not Emacs's own window. */
566 void
567 x_real_positions (f, xptr, yptr)
568 FRAME_PTR f;
569 int *xptr, *yptr;
571 int win_x, win_y, outer_x, outer_y;
572 int real_x = 0, real_y = 0;
573 int had_errors = 0;
574 Window win = f->output_data.x->parent_desc;
576 int count;
578 BLOCK_INPUT;
580 count = x_catch_errors (FRAME_X_DISPLAY (f));
582 if (win == FRAME_X_DISPLAY_INFO (f)->root_window)
583 win = FRAME_OUTER_WINDOW (f);
585 /* This loop traverses up the containment tree until we hit the root
586 window. Window managers may intersect many windows between our window
587 and the root window. The window we find just before the root window
588 should be the outer WM window. */
589 for (;;)
591 Window wm_window, rootw;
592 Window *tmp_children;
593 unsigned int tmp_nchildren;
594 int success;
596 success = XQueryTree (FRAME_X_DISPLAY (f), win, &rootw,
597 &wm_window, &tmp_children, &tmp_nchildren);
599 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
601 /* Don't free tmp_children if XQueryTree failed. */
602 if (! success)
603 break;
605 XFree ((char *) tmp_children);
607 if (wm_window == rootw || had_errors)
608 break;
610 win = wm_window;
613 if (! had_errors)
615 unsigned int ign;
616 Window child, rootw;
618 /* Get the real coordinates for the WM window upper left corner */
619 XGetGeometry (FRAME_X_DISPLAY (f), win,
620 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
622 /* Translate real coordinates to coordinates relative to our
623 window. For our window, the upper left corner is 0, 0.
624 Since the upper left corner of the WM window is outside
625 our window, win_x and win_y will be negative:
627 ------------------ ---> x
628 | title |
629 | ----------------- v y
630 | | our window
632 XTranslateCoordinates (FRAME_X_DISPLAY (f),
634 /* From-window, to-window. */
635 FRAME_X_DISPLAY_INFO (f)->root_window,
636 FRAME_X_WINDOW (f),
638 /* From-position, to-position. */
639 real_x, real_y, &win_x, &win_y,
641 /* Child of win. */
642 &child);
644 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
646 outer_x = win_x;
647 outer_y = win_y;
649 else
651 XTranslateCoordinates (FRAME_X_DISPLAY (f),
653 /* From-window, to-window. */
654 FRAME_X_DISPLAY_INFO (f)->root_window,
655 FRAME_OUTER_WINDOW (f),
657 /* From-position, to-position. */
658 real_x, real_y, &outer_x, &outer_y,
660 /* Child of win. */
661 &child);
664 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
667 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
669 UNBLOCK_INPUT;
671 if (had_errors) return;
673 f->x_pixels_diff = -win_x;
674 f->y_pixels_diff = -win_y;
676 FRAME_X_OUTPUT (f)->x_pixels_outer_diff = -outer_x;
677 FRAME_X_OUTPUT (f)->y_pixels_outer_diff = -outer_y;
679 *xptr = real_x;
680 *yptr = real_y;
686 /* Gamma-correct COLOR on frame F. */
688 void
689 gamma_correct (f, color)
690 struct frame *f;
691 XColor *color;
693 if (f->gamma)
695 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
696 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
697 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
702 /* Decide if color named COLOR_NAME is valid for use on frame F. If
703 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
704 allocate the color. Value is zero if COLOR_NAME is invalid, or
705 no color could be allocated. */
708 x_defined_color (f, color_name, color, alloc_p)
709 struct frame *f;
710 char *color_name;
711 XColor *color;
712 int alloc_p;
714 int success_p;
715 Display *dpy = FRAME_X_DISPLAY (f);
716 Colormap cmap = FRAME_X_COLORMAP (f);
718 BLOCK_INPUT;
719 success_p = XParseColor (dpy, cmap, color_name, color);
720 if (success_p && alloc_p)
721 success_p = x_alloc_nearest_color (f, cmap, color);
722 UNBLOCK_INPUT;
724 return success_p;
728 /* Return the pixel color value for color COLOR_NAME on frame F. If F
729 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
730 Signal an error if color can't be allocated. */
733 x_decode_color (f, color_name, mono_color)
734 FRAME_PTR f;
735 Lisp_Object color_name;
736 int mono_color;
738 XColor cdef;
740 CHECK_STRING (color_name);
742 #if 0 /* Don't do this. It's wrong when we're not using the default
743 colormap, it makes freeing difficult, and it's probably not
744 an important optimization. */
745 if (strcmp (SDATA (color_name), "black") == 0)
746 return BLACK_PIX_DEFAULT (f);
747 else if (strcmp (SDATA (color_name), "white") == 0)
748 return WHITE_PIX_DEFAULT (f);
749 #endif
751 /* Return MONO_COLOR for monochrome frames. */
752 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
753 return mono_color;
755 /* x_defined_color is responsible for coping with failures
756 by looking for a near-miss. */
757 if (x_defined_color (f, SDATA (color_name), &cdef, 1))
758 return cdef.pixel;
760 Fsignal (Qerror, Fcons (build_string ("Undefined color"),
761 Fcons (color_name, Qnil)));
762 return 0;
767 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
768 the previous value of that parameter, NEW_VALUE is the new value.
769 See also the comment of wait_for_wm in struct x_output. */
771 static void
772 x_set_wait_for_wm (f, new_value, old_value)
773 struct frame *f;
774 Lisp_Object new_value, old_value;
776 f->output_data.x->wait_for_wm = !NILP (new_value);
779 #ifdef USE_GTK
781 /* Set icon from FILE for frame F. By using GTK functions the icon
782 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
785 xg_set_icon (f, file)
786 FRAME_PTR f;
787 Lisp_Object file;
789 struct gcpro gcpro1;
790 int result = 0;
791 Lisp_Object found;
793 GCPRO1 (found);
795 found = x_find_image_file (file);
797 if (! NILP (found))
799 GdkPixbuf *pixbuf;
800 GError *err = NULL;
801 char *filename = (char *) SDATA (found);
802 BLOCK_INPUT;
804 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
806 if (pixbuf)
808 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
809 pixbuf);
810 g_object_unref (pixbuf);
812 result = 1;
814 else
815 g_error_free (err);
817 UNBLOCK_INPUT;
820 UNGCPRO;
821 return result;
825 xg_set_icon_from_xpm_data (f, data)
826 FRAME_PTR f;
827 char **data;
829 int result = 0;
830 GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data ((const char **) data);
832 if (!pixbuf)
833 return 0;
835 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), pixbuf);
836 g_object_unref (pixbuf);
837 return 1;
839 #endif /* USE_GTK */
842 /* Functions called only from `x_set_frame_param'
843 to set individual parameters.
845 If FRAME_X_WINDOW (f) is 0,
846 the frame is being created and its X-window does not exist yet.
847 In that case, just record the parameter's new value
848 in the standard place; do not attempt to change the window. */
850 void
851 x_set_foreground_color (f, arg, oldval)
852 struct frame *f;
853 Lisp_Object arg, oldval;
855 struct x_output *x = f->output_data.x;
856 unsigned long fg, old_fg;
858 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
859 old_fg = x->foreground_pixel;
860 x->foreground_pixel = fg;
862 if (FRAME_X_WINDOW (f) != 0)
864 Display *dpy = FRAME_X_DISPLAY (f);
866 BLOCK_INPUT;
867 XSetForeground (dpy, x->normal_gc, fg);
868 XSetBackground (dpy, x->reverse_gc, fg);
870 if (x->cursor_pixel == old_fg)
872 unload_color (f, x->cursor_pixel);
873 x->cursor_pixel = x_copy_color (f, fg);
874 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
877 UNBLOCK_INPUT;
879 update_face_from_frame_parameter (f, Qforeground_color, arg);
881 if (FRAME_VISIBLE_P (f))
882 redraw_frame (f);
885 unload_color (f, old_fg);
888 void
889 x_set_background_color (f, arg, oldval)
890 struct frame *f;
891 Lisp_Object arg, oldval;
893 struct x_output *x = f->output_data.x;
894 unsigned long bg;
896 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
897 unload_color (f, x->background_pixel);
898 x->background_pixel = bg;
900 if (FRAME_X_WINDOW (f) != 0)
902 Display *dpy = FRAME_X_DISPLAY (f);
904 BLOCK_INPUT;
905 XSetBackground (dpy, x->normal_gc, bg);
906 XSetForeground (dpy, x->reverse_gc, bg);
907 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
908 XSetForeground (dpy, x->cursor_gc, bg);
910 #ifdef USE_GTK
911 xg_set_background_color (f, bg);
912 #endif
914 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
915 toolkit scroll bars. */
917 Lisp_Object bar;
918 for (bar = FRAME_SCROLL_BARS (f);
919 !NILP (bar);
920 bar = XSCROLL_BAR (bar)->next)
922 Window window = SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar));
923 XSetWindowBackground (dpy, window, bg);
926 #endif /* USE_TOOLKIT_SCROLL_BARS */
928 UNBLOCK_INPUT;
929 update_face_from_frame_parameter (f, Qbackground_color, arg);
931 if (FRAME_VISIBLE_P (f))
932 redraw_frame (f);
936 void
937 x_set_mouse_color (f, arg, oldval)
938 struct frame *f;
939 Lisp_Object arg, oldval;
941 struct x_output *x = f->output_data.x;
942 Display *dpy = FRAME_X_DISPLAY (f);
943 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
944 Cursor hourglass_cursor, horizontal_drag_cursor;
945 int count;
946 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
947 unsigned long mask_color = x->background_pixel;
949 /* Don't let pointers be invisible. */
950 if (mask_color == pixel)
952 x_free_colors (f, &pixel, 1);
953 pixel = x_copy_color (f, x->foreground_pixel);
956 unload_color (f, x->mouse_pixel);
957 x->mouse_pixel = pixel;
959 BLOCK_INPUT;
961 /* It's not okay to crash if the user selects a screwy cursor. */
962 count = x_catch_errors (dpy);
964 if (!NILP (Vx_pointer_shape))
966 CHECK_NUMBER (Vx_pointer_shape);
967 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
969 else
970 cursor = XCreateFontCursor (dpy, XC_xterm);
971 x_check_errors (dpy, "bad text pointer cursor: %s");
973 if (!NILP (Vx_nontext_pointer_shape))
975 CHECK_NUMBER (Vx_nontext_pointer_shape);
976 nontext_cursor
977 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
979 else
980 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
981 x_check_errors (dpy, "bad nontext pointer cursor: %s");
983 if (!NILP (Vx_hourglass_pointer_shape))
985 CHECK_NUMBER (Vx_hourglass_pointer_shape);
986 hourglass_cursor
987 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
989 else
990 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
991 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
993 if (!NILP (Vx_mode_pointer_shape))
995 CHECK_NUMBER (Vx_mode_pointer_shape);
996 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
998 else
999 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
1000 x_check_errors (dpy, "bad modeline pointer cursor: %s");
1002 if (!NILP (Vx_sensitive_text_pointer_shape))
1004 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
1005 hand_cursor
1006 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
1008 else
1009 hand_cursor = XCreateFontCursor (dpy, XC_hand2);
1011 if (!NILP (Vx_window_horizontal_drag_shape))
1013 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
1014 horizontal_drag_cursor
1015 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
1017 else
1018 horizontal_drag_cursor
1019 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
1021 /* Check and report errors with the above calls. */
1022 x_check_errors (dpy, "can't set cursor shape: %s");
1023 x_uncatch_errors (dpy, count);
1026 XColor fore_color, back_color;
1028 fore_color.pixel = x->mouse_pixel;
1029 x_query_color (f, &fore_color);
1030 back_color.pixel = mask_color;
1031 x_query_color (f, &back_color);
1033 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
1034 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
1035 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
1036 XRecolorCursor (dpy, hand_cursor, &fore_color, &back_color);
1037 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
1038 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
1041 if (FRAME_X_WINDOW (f) != 0)
1042 XDefineCursor (dpy, FRAME_X_WINDOW (f), cursor);
1044 if (cursor != x->text_cursor
1045 && x->text_cursor != 0)
1046 XFreeCursor (dpy, x->text_cursor);
1047 x->text_cursor = cursor;
1049 if (nontext_cursor != x->nontext_cursor
1050 && x->nontext_cursor != 0)
1051 XFreeCursor (dpy, x->nontext_cursor);
1052 x->nontext_cursor = nontext_cursor;
1054 if (hourglass_cursor != x->hourglass_cursor
1055 && x->hourglass_cursor != 0)
1056 XFreeCursor (dpy, x->hourglass_cursor);
1057 x->hourglass_cursor = hourglass_cursor;
1059 if (mode_cursor != x->modeline_cursor
1060 && x->modeline_cursor != 0)
1061 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
1062 x->modeline_cursor = mode_cursor;
1064 if (hand_cursor != x->hand_cursor
1065 && x->hand_cursor != 0)
1066 XFreeCursor (dpy, x->hand_cursor);
1067 x->hand_cursor = hand_cursor;
1069 if (horizontal_drag_cursor != x->horizontal_drag_cursor
1070 && x->horizontal_drag_cursor != 0)
1071 XFreeCursor (dpy, x->horizontal_drag_cursor);
1072 x->horizontal_drag_cursor = horizontal_drag_cursor;
1074 XFlush (dpy);
1075 UNBLOCK_INPUT;
1077 update_face_from_frame_parameter (f, Qmouse_color, arg);
1080 void
1081 x_set_cursor_color (f, arg, oldval)
1082 struct frame *f;
1083 Lisp_Object arg, oldval;
1085 unsigned long fore_pixel, pixel;
1086 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1087 struct x_output *x = f->output_data.x;
1089 if (!NILP (Vx_cursor_fore_pixel))
1091 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1092 WHITE_PIX_DEFAULT (f));
1093 fore_pixel_allocated_p = 1;
1095 else
1096 fore_pixel = x->background_pixel;
1098 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1099 pixel_allocated_p = 1;
1101 /* Make sure that the cursor color differs from the background color. */
1102 if (pixel == x->background_pixel)
1104 if (pixel_allocated_p)
1106 x_free_colors (f, &pixel, 1);
1107 pixel_allocated_p = 0;
1110 pixel = x->mouse_pixel;
1111 if (pixel == fore_pixel)
1113 if (fore_pixel_allocated_p)
1115 x_free_colors (f, &fore_pixel, 1);
1116 fore_pixel_allocated_p = 0;
1118 fore_pixel = x->background_pixel;
1122 unload_color (f, x->cursor_foreground_pixel);
1123 if (!fore_pixel_allocated_p)
1124 fore_pixel = x_copy_color (f, fore_pixel);
1125 x->cursor_foreground_pixel = fore_pixel;
1127 unload_color (f, x->cursor_pixel);
1128 if (!pixel_allocated_p)
1129 pixel = x_copy_color (f, pixel);
1130 x->cursor_pixel = pixel;
1132 if (FRAME_X_WINDOW (f) != 0)
1134 BLOCK_INPUT;
1135 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
1136 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
1137 UNBLOCK_INPUT;
1139 if (FRAME_VISIBLE_P (f))
1141 x_update_cursor (f, 0);
1142 x_update_cursor (f, 1);
1146 update_face_from_frame_parameter (f, Qcursor_color, arg);
1149 /* Set the border-color of frame F to pixel value PIX.
1150 Note that this does not fully take effect if done before
1151 F has an x-window. */
1153 void
1154 x_set_border_pixel (f, pix)
1155 struct frame *f;
1156 int pix;
1158 unload_color (f, f->output_data.x->border_pixel);
1159 f->output_data.x->border_pixel = pix;
1161 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
1163 BLOCK_INPUT;
1164 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1165 (unsigned long)pix);
1166 UNBLOCK_INPUT;
1168 if (FRAME_VISIBLE_P (f))
1169 redraw_frame (f);
1173 /* Set the border-color of frame F to value described by ARG.
1174 ARG can be a string naming a color.
1175 The border-color is used for the border that is drawn by the X server.
1176 Note that this does not fully take effect if done before
1177 F has an x-window; it must be redone when the window is created.
1179 Note: this is done in two routines because of the way X10 works.
1181 Note: under X11, this is normally the province of the window manager,
1182 and so emacs' border colors may be overridden. */
1184 void
1185 x_set_border_color (f, arg, oldval)
1186 struct frame *f;
1187 Lisp_Object arg, oldval;
1189 int pix;
1191 CHECK_STRING (arg);
1192 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1193 x_set_border_pixel (f, pix);
1194 update_face_from_frame_parameter (f, Qborder_color, arg);
1198 void
1199 x_set_cursor_type (f, arg, oldval)
1200 FRAME_PTR f;
1201 Lisp_Object arg, oldval;
1203 set_frame_cursor_types (f, arg);
1205 /* Make sure the cursor gets redrawn. */
1206 cursor_type_changed = 1;
1209 void
1210 x_set_icon_type (f, arg, oldval)
1211 struct frame *f;
1212 Lisp_Object arg, oldval;
1214 int result;
1216 if (STRINGP (arg))
1218 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1219 return;
1221 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1222 return;
1224 BLOCK_INPUT;
1225 if (NILP (arg))
1226 result = x_text_icon (f,
1227 (char *) SDATA ((!NILP (f->icon_name)
1228 ? f->icon_name
1229 : f->name)));
1230 else
1231 result = x_bitmap_icon (f, arg);
1233 if (result)
1235 UNBLOCK_INPUT;
1236 error ("No icon window available");
1239 XFlush (FRAME_X_DISPLAY (f));
1240 UNBLOCK_INPUT;
1243 void
1244 x_set_icon_name (f, arg, oldval)
1245 struct frame *f;
1246 Lisp_Object arg, oldval;
1248 int result;
1250 if (STRINGP (arg))
1252 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1253 return;
1255 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1256 return;
1258 f->icon_name = arg;
1260 if (f->output_data.x->icon_bitmap != 0)
1261 return;
1263 BLOCK_INPUT;
1265 result = x_text_icon (f,
1266 (char *) SDATA ((!NILP (f->icon_name)
1267 ? f->icon_name
1268 : !NILP (f->title)
1269 ? f->title
1270 : f->name)));
1272 if (result)
1274 UNBLOCK_INPUT;
1275 error ("No icon window available");
1278 XFlush (FRAME_X_DISPLAY (f));
1279 UNBLOCK_INPUT;
1283 void
1284 x_set_menu_bar_lines (f, value, oldval)
1285 struct frame *f;
1286 Lisp_Object value, oldval;
1288 int nlines;
1289 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1290 int olines = FRAME_MENU_BAR_LINES (f);
1291 #endif
1293 /* Right now, menu bars don't work properly in minibuf-only frames;
1294 most of the commands try to apply themselves to the minibuffer
1295 frame itself, and get an error because you can't switch buffers
1296 in or split the minibuffer window. */
1297 if (FRAME_MINIBUF_ONLY_P (f))
1298 return;
1300 if (INTEGERP (value))
1301 nlines = XINT (value);
1302 else
1303 nlines = 0;
1305 /* Make sure we redisplay all windows in this frame. */
1306 windows_or_buffers_changed++;
1308 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1309 FRAME_MENU_BAR_LINES (f) = 0;
1310 if (nlines)
1312 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1313 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1314 /* Make sure next redisplay shows the menu bar. */
1315 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1317 else
1319 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1320 free_frame_menubar (f);
1321 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1322 if (FRAME_X_P (f))
1323 f->output_data.x->menubar_widget = 0;
1325 #else /* not USE_X_TOOLKIT && not USE_GTK */
1326 FRAME_MENU_BAR_LINES (f) = nlines;
1327 change_window_heights (f->root_window, nlines - olines);
1328 #endif /* not USE_X_TOOLKIT */
1329 adjust_glyphs (f);
1333 /* Set the number of lines used for the tool bar of frame F to VALUE.
1334 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1335 is the old number of tool bar lines. This function changes the
1336 height of all windows on frame F to match the new tool bar height.
1337 The frame's height doesn't change. */
1339 void
1340 x_set_tool_bar_lines (f, value, oldval)
1341 struct frame *f;
1342 Lisp_Object value, oldval;
1344 int delta, nlines, root_height;
1345 Lisp_Object root_window;
1347 /* Treat tool bars like menu bars. */
1348 if (FRAME_MINIBUF_ONLY_P (f))
1349 return;
1351 /* Use VALUE only if an integer >= 0. */
1352 if (INTEGERP (value) && XINT (value) >= 0)
1353 nlines = XFASTINT (value);
1354 else
1355 nlines = 0;
1357 #ifdef USE_GTK
1358 FRAME_TOOL_BAR_LINES (f) = 0;
1359 if (nlines)
1361 FRAME_EXTERNAL_TOOL_BAR (f) = 1;
1362 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1363 /* Make sure next redisplay shows the tool bar. */
1364 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1365 update_frame_tool_bar (f);
1367 else
1369 if (FRAME_EXTERNAL_TOOL_BAR (f))
1370 free_frame_tool_bar (f);
1371 FRAME_EXTERNAL_TOOL_BAR (f) = 0;
1374 return;
1375 #endif
1377 /* Make sure we redisplay all windows in this frame. */
1378 ++windows_or_buffers_changed;
1380 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1382 /* Don't resize the tool-bar to more than we have room for. */
1383 root_window = FRAME_ROOT_WINDOW (f);
1384 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1385 if (root_height - delta < 1)
1387 delta = root_height - 1;
1388 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1391 FRAME_TOOL_BAR_LINES (f) = nlines;
1392 change_window_heights (root_window, delta);
1393 adjust_glyphs (f);
1395 /* We also have to make sure that the internal border at the top of
1396 the frame, below the menu bar or tool bar, is redrawn when the
1397 tool bar disappears. This is so because the internal border is
1398 below the tool bar if one is displayed, but is below the menu bar
1399 if there isn't a tool bar. The tool bar draws into the area
1400 below the menu bar. */
1401 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1403 updating_frame = f;
1404 clear_frame ();
1405 clear_current_matrices (f);
1406 updating_frame = NULL;
1409 /* If the tool bar gets smaller, the internal border below it
1410 has to be cleared. It was formerly part of the display
1411 of the larger tool bar, and updating windows won't clear it. */
1412 if (delta < 0)
1414 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1415 int width = FRAME_PIXEL_WIDTH (f);
1416 int y = nlines * FRAME_LINE_HEIGHT (f);
1418 /* height can be zero here. */
1419 if (height > 0 && width > 0)
1421 BLOCK_INPUT;
1422 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1423 0, y, width, height, False);
1424 UNBLOCK_INPUT;
1427 if (WINDOWP (f->tool_bar_window))
1428 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1433 /* Set the foreground color for scroll bars on frame F to VALUE.
1434 VALUE should be a string, a color name. If it isn't a string or
1435 isn't a valid color name, do nothing. OLDVAL is the old value of
1436 the frame parameter. */
1438 void
1439 x_set_scroll_bar_foreground (f, value, oldval)
1440 struct frame *f;
1441 Lisp_Object value, oldval;
1443 unsigned long pixel;
1445 if (STRINGP (value))
1446 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1447 else
1448 pixel = -1;
1450 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1451 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1453 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1454 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1456 /* Remove all scroll bars because they have wrong colors. */
1457 if (condemn_scroll_bars_hook)
1458 (*condemn_scroll_bars_hook) (f);
1459 if (judge_scroll_bars_hook)
1460 (*judge_scroll_bars_hook) (f);
1462 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1463 redraw_frame (f);
1468 /* Set the background color for scroll bars on frame F to VALUE VALUE
1469 should be a string, a color name. If it isn't a string or isn't a
1470 valid color name, do nothing. OLDVAL is the old value of the frame
1471 parameter. */
1473 void
1474 x_set_scroll_bar_background (f, value, oldval)
1475 struct frame *f;
1476 Lisp_Object value, oldval;
1478 unsigned long pixel;
1480 if (STRINGP (value))
1481 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1482 else
1483 pixel = -1;
1485 if (f->output_data.x->scroll_bar_background_pixel != -1)
1486 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1488 #ifdef USE_TOOLKIT_SCROLL_BARS
1489 /* Scrollbar shadow colors. */
1490 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1492 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1493 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1495 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1497 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1498 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1500 #endif /* USE_TOOLKIT_SCROLL_BARS */
1502 f->output_data.x->scroll_bar_background_pixel = pixel;
1503 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1505 /* Remove all scroll bars because they have wrong colors. */
1506 if (condemn_scroll_bars_hook)
1507 (*condemn_scroll_bars_hook) (f);
1508 if (judge_scroll_bars_hook)
1509 (*judge_scroll_bars_hook) (f);
1511 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1512 redraw_frame (f);
1517 /* Encode Lisp string STRING as a text in a format appropriate for
1518 XICCC (X Inter Client Communication Conventions).
1520 If STRING contains only ASCII characters, do no conversion and
1521 return the string data of STRING. Otherwise, encode the text by
1522 CODING_SYSTEM, and return a newly allocated memory area which
1523 should be freed by `xfree' by a caller.
1525 SELECTIONP non-zero means the string is being encoded for an X
1526 selection, so it is safe to run pre-write conversions (which
1527 may run Lisp code).
1529 Store the byte length of resulting text in *TEXT_BYTES.
1531 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1532 which means that the `encoding' of the result can be `STRING'.
1533 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1534 the result should be `COMPOUND_TEXT'. */
1536 static unsigned char *
1537 x_encode_text (string, coding_system, selectionp, text_bytes, stringp, freep)
1538 Lisp_Object string, coding_system;
1539 int *text_bytes, *stringp;
1540 int selectionp;
1541 int *freep;
1543 unsigned char *str = SDATA (string);
1544 int chars = SCHARS (string);
1545 int bytes = SBYTES (string);
1546 int charset_info;
1547 int bufsize;
1548 unsigned char *buf;
1549 struct coding_system coding;
1550 extern Lisp_Object Qcompound_text_with_extensions;
1552 charset_info = find_charset_in_text (str, chars, bytes, NULL, Qnil);
1553 if (charset_info == 0)
1555 /* No multibyte character in OBJ. We need not encode it. */
1556 *text_bytes = bytes;
1557 *stringp = 1;
1558 *freep = 0;
1559 return str;
1562 setup_coding_system (coding_system, &coding);
1563 if (selectionp
1564 && SYMBOLP (coding.pre_write_conversion)
1565 && !NILP (Ffboundp (coding.pre_write_conversion)))
1567 string = run_pre_post_conversion_on_str (string, &coding, 1);
1568 str = SDATA (string);
1569 chars = SCHARS (string);
1570 bytes = SBYTES (string);
1572 coding.src_multibyte = 1;
1573 coding.dst_multibyte = 0;
1574 coding.mode |= CODING_MODE_LAST_BLOCK;
1575 if (coding.type == coding_type_iso2022)
1576 coding.flags |= CODING_FLAG_ISO_SAFE;
1577 /* We suppress producing escape sequences for composition. */
1578 coding.composing = COMPOSITION_DISABLED;
1579 bufsize = encoding_buffer_size (&coding, bytes);
1580 buf = (unsigned char *) xmalloc (bufsize);
1581 encode_coding (&coding, str, buf, bytes, bufsize);
1582 *text_bytes = coding.produced;
1583 *stringp = (charset_info == 1
1584 || (!EQ (coding_system, Qcompound_text)
1585 && !EQ (coding_system, Qcompound_text_with_extensions)));
1586 *freep = 1;
1587 return buf;
1591 /* Set the WM name to NAME for frame F. Also set the icon name.
1592 If the frame already has an icon name, use that, otherwise set the
1593 icon name to NAME. */
1595 static void
1596 x_set_name_internal (f, name)
1597 FRAME_PTR f;
1598 Lisp_Object name;
1600 if (FRAME_X_WINDOW (f))
1602 BLOCK_INPUT;
1603 #ifdef HAVE_X11R4
1605 XTextProperty text, icon;
1606 int bytes, stringp;
1607 int do_free_icon_value = 0, do_free_text_value = 0;
1608 Lisp_Object coding_system;
1610 coding_system = Qcompound_text;
1611 /* Note: Encoding strategy
1613 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1614 text.encoding. But, there are non-internationalized window
1615 managers which don't support that encoding. So, if NAME
1616 contains only ASCII and 8859-1 characters, encode it by
1617 iso-latin-1, and use "STRING" in text.encoding hoping that
1618 such window managers at least analyze this format correctly,
1619 i.e. treat 8-bit bytes as 8859-1 characters.
1621 We may also be able to use "UTF8_STRING" in text.encoding
1622 in the future which can encode all Unicode characters.
1623 But, for the moment, there's no way to know that the
1624 current window manager supports it or not. */
1625 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1626 &do_free_text_value);
1627 text.encoding = (stringp ? XA_STRING
1628 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1629 text.format = 8;
1630 text.nitems = bytes;
1632 if (NILP (f->icon_name))
1634 icon = text;
1636 else
1638 /* See the above comment "Note: Encoding strategy". */
1639 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1640 &bytes, &stringp, &do_free_icon_value);
1641 icon.encoding = (stringp ? XA_STRING
1642 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1643 icon.format = 8;
1644 icon.nitems = bytes;
1647 #ifdef USE_GTK
1648 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1649 (char *) SDATA (ENCODE_UTF_8 (name)));
1650 #else /* not USE_GTK */
1651 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1652 #endif /* not USE_GTK */
1654 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1656 if (do_free_icon_value)
1657 xfree (icon.value);
1658 if (do_free_text_value)
1659 xfree (text.value);
1661 #else /* not HAVE_X11R4 */
1662 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1663 SDATA (name));
1664 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1665 SDATA (name));
1666 #endif /* not HAVE_X11R4 */
1667 UNBLOCK_INPUT;
1671 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1672 x_id_name.
1674 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1675 name; if NAME is a string, set F's name to NAME and set
1676 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1678 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1679 suggesting a new name, which lisp code should override; if
1680 F->explicit_name is set, ignore the new name; otherwise, set it. */
1682 void
1683 x_set_name (f, name, explicit)
1684 struct frame *f;
1685 Lisp_Object name;
1686 int explicit;
1688 /* Make sure that requests from lisp code override requests from
1689 Emacs redisplay code. */
1690 if (explicit)
1692 /* If we're switching from explicit to implicit, we had better
1693 update the mode lines and thereby update the title. */
1694 if (f->explicit_name && NILP (name))
1695 update_mode_lines = 1;
1697 f->explicit_name = ! NILP (name);
1699 else if (f->explicit_name)
1700 return;
1702 /* If NAME is nil, set the name to the x_id_name. */
1703 if (NILP (name))
1705 /* Check for no change needed in this very common case
1706 before we do any consing. */
1707 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
1708 SDATA (f->name)))
1709 return;
1710 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
1712 else
1713 CHECK_STRING (name);
1715 /* Don't change the name if it's already NAME. */
1716 if (! NILP (Fstring_equal (name, f->name)))
1717 return;
1719 f->name = name;
1721 /* For setting the frame title, the title parameter should override
1722 the name parameter. */
1723 if (! NILP (f->title))
1724 name = f->title;
1726 x_set_name_internal (f, name);
1729 /* This function should be called when the user's lisp code has
1730 specified a name for the frame; the name will override any set by the
1731 redisplay code. */
1732 void
1733 x_explicitly_set_name (f, arg, oldval)
1734 FRAME_PTR f;
1735 Lisp_Object arg, oldval;
1737 x_set_name (f, arg, 1);
1740 /* This function should be called by Emacs redisplay code to set the
1741 name; names set this way will never override names set by the user's
1742 lisp code. */
1743 void
1744 x_implicitly_set_name (f, arg, oldval)
1745 FRAME_PTR f;
1746 Lisp_Object arg, oldval;
1748 x_set_name (f, arg, 0);
1751 /* Change the title of frame F to NAME.
1752 If NAME is nil, use the frame name as the title.
1754 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1755 name; if NAME is a string, set F's name to NAME and set
1756 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1758 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1759 suggesting a new name, which lisp code should override; if
1760 F->explicit_name is set, ignore the new name; otherwise, set it. */
1762 void
1763 x_set_title (f, name, old_name)
1764 struct frame *f;
1765 Lisp_Object name, old_name;
1767 /* Don't change the title if it's already NAME. */
1768 if (EQ (name, f->title))
1769 return;
1771 update_mode_lines = 1;
1773 f->title = name;
1775 if (NILP (name))
1776 name = f->name;
1777 else
1778 CHECK_STRING (name);
1780 x_set_name_internal (f, name);
1783 void
1784 x_set_scroll_bar_default_width (f)
1785 struct frame *f;
1787 int wid = FRAME_COLUMN_WIDTH (f);
1789 #ifdef USE_TOOLKIT_SCROLL_BARS
1790 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1791 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
1792 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
1793 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = width;
1794 #else
1795 /* Make the actual width at least 14 pixels and a multiple of a
1796 character width. */
1797 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
1799 /* Use all of that space (aside from required margins) for the
1800 scroll bar. */
1801 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = 0;
1802 #endif
1806 /* Record in frame F the specified or default value according to ALIST
1807 of the parameter named PROP (a Lisp symbol). If no value is
1808 specified for PROP, look for an X default for XPROP on the frame
1809 named NAME. If that is not found either, use the value DEFLT. */
1811 static Lisp_Object
1812 x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
1813 foreground_p)
1814 struct frame *f;
1815 Lisp_Object alist;
1816 Lisp_Object prop;
1817 char *xprop;
1818 char *xclass;
1819 int foreground_p;
1821 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1822 Lisp_Object tem;
1824 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1825 if (EQ (tem, Qunbound))
1827 #ifdef USE_TOOLKIT_SCROLL_BARS
1829 /* See if an X resource for the scroll bar color has been
1830 specified. */
1831 tem = display_x_get_resource (dpyinfo,
1832 build_string (foreground_p
1833 ? "foreground"
1834 : "background"),
1835 empty_string,
1836 build_string ("verticalScrollBar"),
1837 empty_string);
1838 if (!STRINGP (tem))
1840 /* If nothing has been specified, scroll bars will use a
1841 toolkit-dependent default. Because these defaults are
1842 difficult to get at without actually creating a scroll
1843 bar, use nil to indicate that no color has been
1844 specified. */
1845 tem = Qnil;
1848 #else /* not USE_TOOLKIT_SCROLL_BARS */
1850 tem = Qnil;
1852 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1855 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
1856 return tem;
1861 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
1863 Status
1864 XSetWMProtocols (dpy, w, protocols, count)
1865 Display *dpy;
1866 Window w;
1867 Atom *protocols;
1868 int count;
1870 Atom prop;
1871 prop = XInternAtom (dpy, "WM_PROTOCOLS", False);
1872 if (prop == None) return False;
1873 XChangeProperty (dpy, w, prop, XA_ATOM, 32, PropModeReplace,
1874 (unsigned char *) protocols, count);
1875 return True;
1877 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
1879 #ifdef USE_X_TOOLKIT
1881 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1882 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1883 already be present because of the toolkit (Motif adds some of them,
1884 for example, but Xt doesn't). */
1886 static void
1887 hack_wm_protocols (f, widget)
1888 FRAME_PTR f;
1889 Widget widget;
1891 Display *dpy = XtDisplay (widget);
1892 Window w = XtWindow (widget);
1893 int need_delete = 1;
1894 int need_focus = 1;
1895 int need_save = 1;
1897 BLOCK_INPUT;
1899 Atom type;
1900 unsigned char *catoms;
1901 int format = 0;
1902 unsigned long nitems = 0;
1903 unsigned long bytes_after;
1905 if ((XGetWindowProperty (dpy, w,
1906 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1907 (long)0, (long)100, False, XA_ATOM,
1908 &type, &format, &nitems, &bytes_after,
1909 &catoms)
1910 == Success)
1911 && format == 32 && type == XA_ATOM)
1913 Atom *atoms = (Atom *) catoms;
1914 while (nitems > 0)
1916 nitems--;
1917 if (atoms[nitems]
1918 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1919 need_delete = 0;
1920 else if (atoms[nitems]
1921 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1922 need_focus = 0;
1923 else if (atoms[nitems]
1924 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1925 need_save = 0;
1928 if (catoms)
1929 XFree (catoms);
1932 Atom props [10];
1933 int count = 0;
1934 if (need_delete)
1935 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1936 if (need_focus)
1937 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1938 if (need_save)
1939 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1940 if (count)
1941 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1942 XA_ATOM, 32, PropModeAppend,
1943 (unsigned char *) props, count);
1945 UNBLOCK_INPUT;
1947 #endif
1951 /* Support routines for XIC (X Input Context). */
1953 #ifdef HAVE_X_I18N
1955 static XFontSet xic_create_xfontset P_ ((struct frame *, char *));
1956 static XIMStyle best_xim_style P_ ((XIMStyles *, XIMStyles *));
1959 /* Supported XIM styles, ordered by preference. */
1961 static XIMStyle supported_xim_styles[] =
1963 XIMPreeditPosition | XIMStatusArea,
1964 XIMPreeditPosition | XIMStatusNothing,
1965 XIMPreeditPosition | XIMStatusNone,
1966 XIMPreeditNothing | XIMStatusArea,
1967 XIMPreeditNothing | XIMStatusNothing,
1968 XIMPreeditNothing | XIMStatusNone,
1969 XIMPreeditNone | XIMStatusArea,
1970 XIMPreeditNone | XIMStatusNothing,
1971 XIMPreeditNone | XIMStatusNone,
1976 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1978 char xic_defaut_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1980 /* Create an Xt fontset spec from the name of a base font.
1981 If `motif' is True use the Motif syntax. */
1982 char *
1983 xic_create_fontsetname (base_fontname, motif)
1984 char *base_fontname;
1985 Bool motif;
1987 const char *sep = motif ? ";" : ",";
1988 char *fontsetname;
1990 /* Make a fontset name from the base font name. */
1991 if (xic_defaut_fontset == base_fontname)
1992 { /* There is no base font name, use the default. */
1993 int len = strlen (base_fontname) + 2;
1994 fontsetname = xmalloc (len);
1995 bzero (fontsetname, len);
1996 strcpy (fontsetname, base_fontname);
1998 else
2000 /* Make a fontset name from the base font name.
2001 The font set will be made of the following elements:
2002 - the base font.
2003 - the base font where the charset spec is replaced by -*-*.
2004 - the same but with the family also replaced with -*-*-. */
2005 char *p = base_fontname;
2006 int i;
2008 for (i = 0; *p; p++)
2009 if (*p == '-') i++;
2010 if (i != 14)
2011 { /* As the font name doesn't conform to XLFD, we can't
2012 modify it to generalize it to allcs and allfamilies.
2013 Use the specified font plus the default. */
2014 int len = strlen (base_fontname) + strlen (xic_defaut_fontset) + 3;
2015 fontsetname = xmalloc (len);
2016 bzero (fontsetname, len);
2017 strcpy (fontsetname, base_fontname);
2018 strcat (fontsetname, sep);
2019 strcat (fontsetname, xic_defaut_fontset);
2021 else
2023 int len;
2024 char *p1 = NULL, *p2 = NULL;
2025 char *font_allcs = NULL;
2026 char *font_allfamilies = NULL;
2027 char *font_all = NULL;
2028 char *allcs = "*-*-*-*-*-*-*";
2029 char *allfamilies = "-*-*-";
2030 char *all = "*-*-*-*-";
2032 for (i = 0, p = base_fontname; i < 8; p++)
2034 if (*p == '-')
2036 i++;
2037 if (i == 3)
2038 p1 = p + 1;
2039 else if (i == 7)
2040 p2 = p + 1;
2043 /* Build the font spec that matches all charsets. */
2044 len = p - base_fontname + strlen (allcs) + 1;
2045 font_allcs = (char *) alloca (len);
2046 bzero (font_allcs, len);
2047 bcopy (base_fontname, font_allcs, p - base_fontname);
2048 strcat (font_allcs, allcs);
2050 /* Build the font spec that matches all families. */
2051 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
2052 font_allfamilies = (char *) alloca (len);
2053 bzero (font_allfamilies, len);
2054 strcpy (font_allfamilies, allfamilies);
2055 bcopy (p1, font_allfamilies + strlen (allfamilies), p - p1);
2056 strcat (font_allfamilies, allcs);
2058 /* Build the font spec that matches all. */
2059 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
2060 font_all = (char *) alloca (len);
2061 bzero (font_all, len);
2062 strcpy (font_all, allfamilies);
2063 strcat (font_all, all);
2064 bcopy (p2, font_all + strlen (all) + strlen (allfamilies), p - p2);
2065 strcat (font_all, allcs);
2067 /* Build the actual font set name. */
2068 len = strlen (base_fontname) + strlen (font_allcs)
2069 + strlen (font_allfamilies) + strlen (font_all) + 5;
2070 fontsetname = xmalloc (len);
2071 bzero (fontsetname, len);
2072 strcpy (fontsetname, base_fontname);
2073 strcat (fontsetname, sep);
2074 strcat (fontsetname, font_allcs);
2075 strcat (fontsetname, sep);
2076 strcat (fontsetname, font_allfamilies);
2077 strcat (fontsetname, sep);
2078 strcat (fontsetname, font_all);
2081 if (motif)
2082 strcat (fontsetname, ":");
2083 return fontsetname;
2086 static XFontSet
2087 xic_create_xfontset (f, base_fontname)
2088 struct frame *f;
2089 char *base_fontname;
2091 XFontSet xfs = NULL;
2092 char **missing_list = NULL;
2093 int missing_count;
2094 char *def_string;
2095 Lisp_Object rest, frame;
2097 if (!base_fontname)
2098 base_fontname = xic_defaut_fontset;
2100 /* See if there is another frame already using same fontset. */
2101 FOR_EACH_FRAME (rest, frame)
2103 struct frame *cf = XFRAME (frame);
2104 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2105 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2106 && FRAME_XIC_BASE_FONTNAME (cf)
2107 && !strcmp (FRAME_XIC_BASE_FONTNAME (cf), base_fontname))
2109 xfs = FRAME_XIC_FONTSET (cf);
2110 break;
2114 if (!xfs)
2116 char *fontsetname = xic_create_fontsetname (base_fontname, False);
2118 /* New fontset. */
2119 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
2120 fontsetname, &missing_list,
2121 &missing_count, &def_string);
2122 if (missing_list)
2123 XFreeStringList (missing_list);
2124 xfree (fontsetname);
2127 if (FRAME_XIC_BASE_FONTNAME (f))
2128 xfree (FRAME_XIC_BASE_FONTNAME (f));
2129 FRAME_XIC_BASE_FONTNAME (f) = xstrdup (base_fontname);
2131 /* No need to free def_string. */
2132 return xfs;
2135 /* Free the X fontset of frame F if it is the last frame using it. */
2137 void
2138 xic_free_xfontset (f)
2139 struct frame *f;
2141 Lisp_Object rest, frame;
2142 int shared_p = 0;
2144 if (!FRAME_XIC_FONTSET (f))
2145 return;
2147 /* See if there is another frame sharing the same fontset. */
2148 FOR_EACH_FRAME (rest, frame)
2150 struct frame *cf = XFRAME (frame);
2151 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2152 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2153 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2155 shared_p = 1;
2156 break;
2160 if (!shared_p)
2161 /* The fontset is not used anymore. It is safe to free it. */
2162 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2164 if (FRAME_XIC_BASE_FONTNAME (f))
2165 xfree (FRAME_XIC_BASE_FONTNAME (f));
2166 FRAME_XIC_BASE_FONTNAME (f) = NULL;
2167 FRAME_XIC_FONTSET (f) = NULL;
2171 /* Value is the best input style, given user preferences USER (already
2172 checked to be supported by Emacs), and styles supported by the
2173 input method XIM. */
2175 static XIMStyle
2176 best_xim_style (user, xim)
2177 XIMStyles *user;
2178 XIMStyles *xim;
2180 int i, j;
2182 for (i = 0; i < user->count_styles; ++i)
2183 for (j = 0; j < xim->count_styles; ++j)
2184 if (user->supported_styles[i] == xim->supported_styles[j])
2185 return user->supported_styles[i];
2187 /* Return the default style. */
2188 return XIMPreeditNothing | XIMStatusNothing;
2191 /* Create XIC for frame F. */
2193 static XIMStyle xic_style;
2195 void
2196 create_frame_xic (f)
2197 struct frame *f;
2199 XIM xim;
2200 XIC xic = NULL;
2201 XFontSet xfs = NULL;
2203 if (FRAME_XIC (f))
2204 return;
2206 /* Create X fontset. */
2207 xfs = xic_create_xfontset
2208 (f, (FRAME_FONTSET (f) < 0) ? NULL
2209 : (char *) SDATA (fontset_ascii (FRAME_FONTSET (f))));
2211 xim = FRAME_X_XIM (f);
2212 if (xim)
2214 XRectangle s_area;
2215 XPoint spot;
2216 XVaNestedList preedit_attr;
2217 XVaNestedList status_attr;
2219 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2220 spot.x = 0; spot.y = 1;
2222 /* Determine XIC style. */
2223 if (xic_style == 0)
2225 XIMStyles supported_list;
2226 supported_list.count_styles = (sizeof supported_xim_styles
2227 / sizeof supported_xim_styles[0]);
2228 supported_list.supported_styles = supported_xim_styles;
2229 xic_style = best_xim_style (&supported_list,
2230 FRAME_X_XIM_STYLES (f));
2233 preedit_attr = XVaCreateNestedList (0,
2234 XNFontSet, xfs,
2235 XNForeground,
2236 FRAME_FOREGROUND_PIXEL (f),
2237 XNBackground,
2238 FRAME_BACKGROUND_PIXEL (f),
2239 (xic_style & XIMPreeditPosition
2240 ? XNSpotLocation
2241 : NULL),
2242 &spot,
2243 NULL);
2244 status_attr = XVaCreateNestedList (0,
2245 XNArea,
2246 &s_area,
2247 XNFontSet,
2248 xfs,
2249 XNForeground,
2250 FRAME_FOREGROUND_PIXEL (f),
2251 XNBackground,
2252 FRAME_BACKGROUND_PIXEL (f),
2253 NULL);
2255 xic = XCreateIC (xim,
2256 XNInputStyle, xic_style,
2257 XNClientWindow, FRAME_X_WINDOW (f),
2258 XNFocusWindow, FRAME_X_WINDOW (f),
2259 XNStatusAttributes, status_attr,
2260 XNPreeditAttributes, preedit_attr,
2261 NULL);
2262 XFree (preedit_attr);
2263 XFree (status_attr);
2266 FRAME_XIC (f) = xic;
2267 FRAME_XIC_STYLE (f) = xic_style;
2268 FRAME_XIC_FONTSET (f) = xfs;
2272 /* Destroy XIC and free XIC fontset of frame F, if any. */
2274 void
2275 free_frame_xic (f)
2276 struct frame *f;
2278 if (FRAME_XIC (f) == NULL)
2279 return;
2281 XDestroyIC (FRAME_XIC (f));
2282 xic_free_xfontset (f);
2284 FRAME_XIC (f) = NULL;
2288 /* Place preedit area for XIC of window W's frame to specified
2289 pixel position X/Y. X and Y are relative to window W. */
2291 void
2292 xic_set_preeditarea (w, x, y)
2293 struct window *w;
2294 int x, y;
2296 struct frame *f = XFRAME (w->frame);
2297 XVaNestedList attr;
2298 XPoint spot;
2300 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2301 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2302 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2303 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2304 XFree (attr);
2308 /* Place status area for XIC in bottom right corner of frame F.. */
2310 void
2311 xic_set_statusarea (f)
2312 struct frame *f;
2314 XIC xic = FRAME_XIC (f);
2315 XVaNestedList attr;
2316 XRectangle area;
2317 XRectangle *needed;
2319 /* Negotiate geometry of status area. If input method has existing
2320 status area, use its current size. */
2321 area.x = area.y = area.width = area.height = 0;
2322 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2323 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2324 XFree (attr);
2326 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2327 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2328 XFree (attr);
2330 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2332 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2333 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2334 XFree (attr);
2337 area.width = needed->width;
2338 area.height = needed->height;
2339 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2340 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2341 - FRAME_MENUBAR_HEIGHT (f)
2342 - FRAME_TOOLBAR_HEIGHT (f)
2343 - FRAME_INTERNAL_BORDER_WIDTH (f));
2344 XFree (needed);
2346 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2347 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2348 XFree (attr);
2352 /* Set X fontset for XIC of frame F, using base font name
2353 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2355 void
2356 xic_set_xfontset (f, base_fontname)
2357 struct frame *f;
2358 char *base_fontname;
2360 XVaNestedList attr;
2361 XFontSet xfs;
2363 xic_free_xfontset (f);
2365 xfs = xic_create_xfontset (f, base_fontname);
2367 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2368 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2369 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2370 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2371 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2372 XFree (attr);
2374 FRAME_XIC_FONTSET (f) = xfs;
2377 #endif /* HAVE_X_I18N */
2381 #ifdef USE_X_TOOLKIT
2383 /* Create and set up the X widget for frame F. */
2385 static void
2386 x_window (f, window_prompting, minibuffer_only)
2387 struct frame *f;
2388 long window_prompting;
2389 int minibuffer_only;
2391 XClassHint class_hints;
2392 XSetWindowAttributes attributes;
2393 unsigned long attribute_mask;
2394 Widget shell_widget;
2395 Widget pane_widget;
2396 Widget frame_widget;
2397 Arg al [25];
2398 int ac;
2400 BLOCK_INPUT;
2402 /* Use the resource name as the top-level widget name
2403 for looking up resources. Make a non-Lisp copy
2404 for the window manager, so GC relocation won't bother it.
2406 Elsewhere we specify the window name for the window manager. */
2409 char *str = (char *) SDATA (Vx_resource_name);
2410 f->namebuf = (char *) xmalloc (strlen (str) + 1);
2411 strcpy (f->namebuf, str);
2414 ac = 0;
2415 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2416 XtSetArg (al[ac], XtNinput, 1); ac++;
2417 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2418 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2419 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2420 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2421 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2422 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2423 applicationShellWidgetClass,
2424 FRAME_X_DISPLAY (f), al, ac);
2426 f->output_data.x->widget = shell_widget;
2427 /* maybe_set_screen_title_format (shell_widget); */
2429 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2430 (widget_value *) NULL,
2431 shell_widget, False,
2432 (lw_callback) NULL,
2433 (lw_callback) NULL,
2434 (lw_callback) NULL,
2435 (lw_callback) NULL);
2437 ac = 0;
2438 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2439 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2440 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2441 XtSetValues (pane_widget, al, ac);
2442 f->output_data.x->column_widget = pane_widget;
2444 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2445 the emacs screen when changing menubar. This reduces flickering. */
2447 ac = 0;
2448 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2449 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2450 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2451 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2452 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2453 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2454 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2455 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2456 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2457 al, ac);
2459 f->output_data.x->edit_widget = frame_widget;
2461 XtManageChild (frame_widget);
2463 /* Do some needed geometry management. */
2465 int len;
2466 char *tem, shell_position[32];
2467 Arg al[10];
2468 int ac = 0;
2469 int extra_borders = 0;
2470 int menubar_size
2471 = (f->output_data.x->menubar_widget
2472 ? (f->output_data.x->menubar_widget->core.height
2473 + f->output_data.x->menubar_widget->core.border_width)
2474 : 0);
2476 #if 0 /* Experimentally, we now get the right results
2477 for -geometry -0-0 without this. 24 Aug 96, rms. */
2478 if (FRAME_EXTERNAL_MENU_BAR (f))
2480 Dimension ibw = 0;
2481 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2482 menubar_size += ibw;
2484 #endif
2486 f->output_data.x->menubar_height = menubar_size;
2488 #ifndef USE_LUCID
2489 /* Motif seems to need this amount added to the sizes
2490 specified for the shell widget. The Athena/Lucid widgets don't.
2491 Both conclusions reached experimentally. -- rms. */
2492 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2493 &extra_borders, NULL);
2494 extra_borders *= 2;
2495 #endif
2497 /* Convert our geometry parameters into a geometry string
2498 and specify it.
2499 Note that we do not specify here whether the position
2500 is a user-specified or program-specified one.
2501 We pass that information later, in x_wm_set_size_hints. */
2503 int left = f->left_pos;
2504 int xneg = window_prompting & XNegative;
2505 int top = f->top_pos;
2506 int yneg = window_prompting & YNegative;
2507 if (xneg)
2508 left = -left;
2509 if (yneg)
2510 top = -top;
2512 if (window_prompting & USPosition)
2513 sprintf (shell_position, "=%dx%d%c%d%c%d",
2514 FRAME_PIXEL_WIDTH (f) + extra_borders,
2515 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2516 (xneg ? '-' : '+'), left,
2517 (yneg ? '-' : '+'), top);
2518 else
2520 sprintf (shell_position, "=%dx%d",
2521 FRAME_PIXEL_WIDTH (f) + extra_borders,
2522 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2524 /* Setting x and y when the position is not specified in
2525 the geometry string will set program position in the WM hints.
2526 If Emacs had just one program position, we could set it in
2527 fallback resources, but since each make-frame call can specify
2528 different program positions, this is easier. */
2529 XtSetArg (al[ac], XtNx, left); ac++;
2530 XtSetArg (al[ac], XtNy, top); ac++;
2534 len = strlen (shell_position) + 1;
2535 /* We don't free this because we don't know whether
2536 it is safe to free it while the frame exists.
2537 It isn't worth the trouble of arranging to free it
2538 when the frame is deleted. */
2539 tem = (char *) xmalloc (len);
2540 strncpy (tem, shell_position, len);
2541 XtSetArg (al[ac], XtNgeometry, tem); ac++;
2542 XtSetValues (shell_widget, al, ac);
2545 XtManageChild (pane_widget);
2546 XtRealizeWidget (shell_widget);
2548 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2550 validate_x_resource_name ();
2552 class_hints.res_name = (char *) SDATA (Vx_resource_name);
2553 class_hints.res_class = (char *) SDATA (Vx_resource_class);
2554 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2556 #ifdef HAVE_X_I18N
2557 FRAME_XIC (f) = NULL;
2558 if (use_xim)
2559 create_frame_xic (f);
2560 #endif
2562 f->output_data.x->wm_hints.input = True;
2563 f->output_data.x->wm_hints.flags |= InputHint;
2564 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2565 &f->output_data.x->wm_hints);
2567 hack_wm_protocols (f, shell_widget);
2569 #ifdef HACK_EDITRES
2570 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2571 #endif
2573 /* Do a stupid property change to force the server to generate a
2574 PropertyNotify event so that the event_stream server timestamp will
2575 be initialized to something relevant to the time we created the window.
2577 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2578 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
2579 XA_ATOM, 32, PropModeAppend,
2580 (unsigned char*) NULL, 0);
2582 /* Make all the standard events reach the Emacs frame. */
2583 attributes.event_mask = STANDARD_EVENT_SET;
2585 #ifdef HAVE_X_I18N
2586 if (FRAME_XIC (f))
2588 /* XIM server might require some X events. */
2589 unsigned long fevent = NoEventMask;
2590 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2591 attributes.event_mask |= fevent;
2593 #endif /* HAVE_X_I18N */
2595 attribute_mask = CWEventMask;
2596 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2597 attribute_mask, &attributes);
2599 XtMapWidget (frame_widget);
2601 /* x_set_name normally ignores requests to set the name if the
2602 requested name is the same as the current name. This is the one
2603 place where that assumption isn't correct; f->name is set, but
2604 the X server hasn't been told. */
2606 Lisp_Object name;
2607 int explicit = f->explicit_name;
2609 f->explicit_name = 0;
2610 name = f->name;
2611 f->name = Qnil;
2612 x_set_name (f, name, explicit);
2615 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2616 f->output_data.x->text_cursor);
2618 UNBLOCK_INPUT;
2620 /* This is a no-op, except under Motif. Make sure main areas are
2621 set to something reasonable, in case we get an error later. */
2622 lw_set_main_areas (pane_widget, 0, frame_widget);
2625 #else /* not USE_X_TOOLKIT */
2626 #ifdef USE_GTK
2627 void
2628 x_window (f)
2629 FRAME_PTR f;
2631 if (! xg_create_frame_widgets (f))
2632 error ("Unable to create window");
2634 #ifdef HAVE_X_I18N
2635 FRAME_XIC (f) = NULL;
2636 if (use_xim)
2638 BLOCK_INPUT;
2639 create_frame_xic (f);
2640 if (FRAME_XIC (f))
2642 /* XIM server might require some X events. */
2643 unsigned long fevent = NoEventMask;
2644 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2646 if (fevent != NoEventMask)
2648 XSetWindowAttributes attributes;
2649 XWindowAttributes wattr;
2650 unsigned long attribute_mask;
2652 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2653 &wattr);
2654 attributes.event_mask = wattr.your_event_mask | fevent;
2655 attribute_mask = CWEventMask;
2656 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2657 attribute_mask, &attributes);
2660 UNBLOCK_INPUT;
2662 #endif
2665 #else /*! USE_GTK */
2666 /* Create and set up the X window for frame F. */
2668 void
2669 x_window (f)
2670 struct frame *f;
2673 XClassHint class_hints;
2674 XSetWindowAttributes attributes;
2675 unsigned long attribute_mask;
2677 attributes.background_pixel = f->output_data.x->background_pixel;
2678 attributes.border_pixel = f->output_data.x->border_pixel;
2679 attributes.bit_gravity = StaticGravity;
2680 attributes.backing_store = NotUseful;
2681 attributes.save_under = True;
2682 attributes.event_mask = STANDARD_EVENT_SET;
2683 attributes.colormap = FRAME_X_COLORMAP (f);
2684 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2685 | CWColormap);
2687 BLOCK_INPUT;
2688 FRAME_X_WINDOW (f)
2689 = XCreateWindow (FRAME_X_DISPLAY (f),
2690 f->output_data.x->parent_desc,
2691 f->left_pos,
2692 f->top_pos,
2693 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2694 f->border_width,
2695 CopyFromParent, /* depth */
2696 InputOutput, /* class */
2697 FRAME_X_VISUAL (f),
2698 attribute_mask, &attributes);
2700 #ifdef HAVE_X_I18N
2701 if (use_xim)
2703 create_frame_xic (f);
2704 if (FRAME_XIC (f))
2706 /* XIM server might require some X events. */
2707 unsigned long fevent = NoEventMask;
2708 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2709 attributes.event_mask |= fevent;
2710 attribute_mask = CWEventMask;
2711 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2712 attribute_mask, &attributes);
2715 #endif /* HAVE_X_I18N */
2717 validate_x_resource_name ();
2719 class_hints.res_name = (char *) SDATA (Vx_resource_name);
2720 class_hints.res_class = (char *) SDATA (Vx_resource_class);
2721 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2723 /* The menubar is part of the ordinary display;
2724 it does not count in addition to the height of the window. */
2725 f->output_data.x->menubar_height = 0;
2727 /* This indicates that we use the "Passive Input" input model.
2728 Unless we do this, we don't get the Focus{In,Out} events that we
2729 need to draw the cursor correctly. Accursed bureaucrats.
2730 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2732 f->output_data.x->wm_hints.input = True;
2733 f->output_data.x->wm_hints.flags |= InputHint;
2734 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2735 &f->output_data.x->wm_hints);
2736 f->output_data.x->wm_hints.icon_pixmap = None;
2738 /* Request "save yourself" and "delete window" commands from wm. */
2740 Atom protocols[2];
2741 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2742 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2743 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2746 /* x_set_name normally ignores requests to set the name if the
2747 requested name is the same as the current name. This is the one
2748 place where that assumption isn't correct; f->name is set, but
2749 the X server hasn't been told. */
2751 Lisp_Object name;
2752 int explicit = f->explicit_name;
2754 f->explicit_name = 0;
2755 name = f->name;
2756 f->name = Qnil;
2757 x_set_name (f, name, explicit);
2760 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2761 f->output_data.x->text_cursor);
2763 UNBLOCK_INPUT;
2765 if (FRAME_X_WINDOW (f) == 0)
2766 error ("Unable to create window");
2769 #endif /* not USE_GTK */
2770 #endif /* not USE_X_TOOLKIT */
2772 /* Verify that the icon position args for this window are valid. */
2774 static void
2775 x_icon_verify (f, parms)
2776 struct frame *f;
2777 Lisp_Object parms;
2779 Lisp_Object icon_x, icon_y;
2781 /* Set the position of the icon. Note that twm groups all
2782 icons in an icon window. */
2783 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2784 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2785 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2787 CHECK_NUMBER (icon_x);
2788 CHECK_NUMBER (icon_y);
2790 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2791 error ("Both left and top icon corners of icon must be specified");
2794 /* Handle the icon stuff for this window. Perhaps later we might
2795 want an x_set_icon_position which can be called interactively as
2796 well. */
2798 static void
2799 x_icon (f, parms)
2800 struct frame *f;
2801 Lisp_Object parms;
2803 Lisp_Object icon_x, icon_y;
2804 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2806 /* Set the position of the icon. Note that twm groups all
2807 icons in an icon window. */
2808 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2809 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2810 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2812 CHECK_NUMBER (icon_x);
2813 CHECK_NUMBER (icon_y);
2815 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2816 error ("Both left and top icon corners of icon must be specified");
2818 BLOCK_INPUT;
2820 if (! EQ (icon_x, Qunbound))
2821 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2823 /* Start up iconic or window? */
2824 x_wm_set_window_state
2825 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2826 Qicon)
2827 ? IconicState
2828 : NormalState));
2830 x_text_icon (f, (char *) SDATA ((!NILP (f->icon_name)
2831 ? f->icon_name
2832 : f->name)));
2834 UNBLOCK_INPUT;
2837 /* Make the GCs needed for this window, setting the
2838 background, border and mouse colors; also create the
2839 mouse cursor and the gray border tile. */
2841 static char cursor_bits[] =
2843 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2844 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2845 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2846 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
2849 static void
2850 x_make_gc (f)
2851 struct frame *f;
2853 XGCValues gc_values;
2855 BLOCK_INPUT;
2857 /* Create the GCs of this frame.
2858 Note that many default values are used. */
2860 /* Normal video */
2861 gc_values.font = FRAME_FONT (f)->fid;
2862 gc_values.foreground = f->output_data.x->foreground_pixel;
2863 gc_values.background = f->output_data.x->background_pixel;
2864 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2865 f->output_data.x->normal_gc
2866 = XCreateGC (FRAME_X_DISPLAY (f),
2867 FRAME_X_WINDOW (f),
2868 GCLineWidth | GCFont | GCForeground | GCBackground,
2869 &gc_values);
2871 /* Reverse video style. */
2872 gc_values.foreground = f->output_data.x->background_pixel;
2873 gc_values.background = f->output_data.x->foreground_pixel;
2874 f->output_data.x->reverse_gc
2875 = XCreateGC (FRAME_X_DISPLAY (f),
2876 FRAME_X_WINDOW (f),
2877 GCFont | GCForeground | GCBackground | GCLineWidth,
2878 &gc_values);
2880 /* Cursor has cursor-color background, background-color foreground. */
2881 gc_values.foreground = f->output_data.x->background_pixel;
2882 gc_values.background = f->output_data.x->cursor_pixel;
2883 gc_values.fill_style = FillOpaqueStippled;
2884 gc_values.stipple
2885 = XCreateBitmapFromData (FRAME_X_DISPLAY (f),
2886 FRAME_X_DISPLAY_INFO (f)->root_window,
2887 cursor_bits, 16, 16);
2888 f->output_data.x->cursor_gc
2889 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2890 (GCFont | GCForeground | GCBackground
2891 | GCFillStyle /* | GCStipple */ | GCLineWidth),
2892 &gc_values);
2894 /* Reliefs. */
2895 f->output_data.x->white_relief.gc = 0;
2896 f->output_data.x->black_relief.gc = 0;
2898 /* Create the gray border tile used when the pointer is not in
2899 the frame. Since this depends on the frame's pixel values,
2900 this must be done on a per-frame basis. */
2901 f->output_data.x->border_tile
2902 = (XCreatePixmapFromBitmapData
2903 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
2904 gray_bits, gray_width, gray_height,
2905 f->output_data.x->foreground_pixel,
2906 f->output_data.x->background_pixel,
2907 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2909 UNBLOCK_INPUT;
2913 /* Free what was was allocated in x_make_gc. */
2915 void
2916 x_free_gcs (f)
2917 struct frame *f;
2919 Display *dpy = FRAME_X_DISPLAY (f);
2921 BLOCK_INPUT;
2923 if (f->output_data.x->normal_gc)
2925 XFreeGC (dpy, f->output_data.x->normal_gc);
2926 f->output_data.x->normal_gc = 0;
2929 if (f->output_data.x->reverse_gc)
2931 XFreeGC (dpy, f->output_data.x->reverse_gc);
2932 f->output_data.x->reverse_gc = 0;
2935 if (f->output_data.x->cursor_gc)
2937 XFreeGC (dpy, f->output_data.x->cursor_gc);
2938 f->output_data.x->cursor_gc = 0;
2941 if (f->output_data.x->border_tile)
2943 XFreePixmap (dpy, f->output_data.x->border_tile);
2944 f->output_data.x->border_tile = 0;
2947 UNBLOCK_INPUT;
2951 /* Handler for signals raised during x_create_frame and
2952 x_create_top_frame. FRAME is the frame which is partially
2953 constructed. */
2955 static Lisp_Object
2956 unwind_create_frame (frame)
2957 Lisp_Object frame;
2959 struct frame *f = XFRAME (frame);
2961 /* If frame is ``official'', nothing to do. */
2962 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
2964 #if GLYPH_DEBUG
2965 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2966 #endif
2968 x_free_frame_resources (f);
2970 #if GLYPH_DEBUG
2971 /* Check that reference counts are indeed correct. */
2972 xassert (dpyinfo->reference_count == dpyinfo_refcount);
2973 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
2974 #endif
2975 return Qt;
2978 return Qnil;
2982 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
2983 1, 1, 0,
2984 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
2985 Returns an Emacs frame object.
2986 ALIST is an alist of frame parameters.
2987 If the parameters specify that the frame should not have a minibuffer,
2988 and do not specify a specific minibuffer window to use,
2989 then `default-minibuffer-frame' must be a frame whose minibuffer can
2990 be shared by the new frame.
2992 This function is an internal primitive--use `make-frame' instead. */)
2993 (parms)
2994 Lisp_Object parms;
2996 struct frame *f;
2997 Lisp_Object frame, tem;
2998 Lisp_Object name;
2999 int minibuffer_only = 0;
3000 long window_prompting = 0;
3001 int width, height;
3002 int count = SPECPDL_INDEX ();
3003 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3004 Lisp_Object display;
3005 struct x_display_info *dpyinfo = NULL;
3006 Lisp_Object parent;
3007 struct kboard *kb;
3009 check_x ();
3011 parms = Fcopy_alist (parms);
3013 /* Use this general default value to start with
3014 until we know if this frame has a specified name. */
3015 Vx_resource_name = Vinvocation_name;
3017 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3018 if (EQ (display, Qunbound))
3019 display = Qnil;
3020 dpyinfo = check_x_display_info (display);
3021 #ifdef MULTI_KBOARD
3022 kb = dpyinfo->kboard;
3023 #else
3024 kb = &the_only_kboard;
3025 #endif
3027 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3028 if (!STRINGP (name)
3029 && ! EQ (name, Qunbound)
3030 && ! NILP (name))
3031 error ("Invalid frame name--not a string or nil");
3033 if (STRINGP (name))
3034 Vx_resource_name = name;
3036 /* See if parent window is specified. */
3037 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3038 if (EQ (parent, Qunbound))
3039 parent = Qnil;
3040 if (! NILP (parent))
3041 CHECK_NUMBER (parent);
3043 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3044 /* No need to protect DISPLAY because that's not used after passing
3045 it to make_frame_without_minibuffer. */
3046 frame = Qnil;
3047 GCPRO4 (parms, parent, name, frame);
3048 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3049 RES_TYPE_SYMBOL);
3050 if (EQ (tem, Qnone) || NILP (tem))
3051 f = make_frame_without_minibuffer (Qnil, kb, display);
3052 else if (EQ (tem, Qonly))
3054 f = make_minibuffer_frame ();
3055 minibuffer_only = 1;
3057 else if (WINDOWP (tem))
3058 f = make_frame_without_minibuffer (tem, kb, display);
3059 else
3060 f = make_frame (1);
3062 XSETFRAME (frame, f);
3064 /* Note that X Windows does support scroll bars. */
3065 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
3067 f->output_method = output_x_window;
3068 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
3069 bzero (f->output_data.x, sizeof (struct x_output));
3070 f->output_data.x->icon_bitmap = -1;
3071 FRAME_FONTSET (f) = -1;
3072 f->output_data.x->scroll_bar_foreground_pixel = -1;
3073 f->output_data.x->scroll_bar_background_pixel = -1;
3074 #ifdef USE_TOOLKIT_SCROLL_BARS
3075 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3076 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3077 #endif /* USE_TOOLKIT_SCROLL_BARS */
3078 record_unwind_protect (unwind_create_frame, frame);
3080 f->icon_name
3081 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3082 RES_TYPE_STRING);
3083 if (! STRINGP (f->icon_name))
3084 f->icon_name = Qnil;
3086 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3087 #if GLYPH_DEBUG
3088 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
3089 dpyinfo_refcount = dpyinfo->reference_count;
3090 #endif /* GLYPH_DEBUG */
3091 #ifdef MULTI_KBOARD
3092 FRAME_KBOARD (f) = kb;
3093 #endif
3095 /* These colors will be set anyway later, but it's important
3096 to get the color reference counts right, so initialize them! */
3098 Lisp_Object black;
3099 struct gcpro gcpro1;
3101 /* Function x_decode_color can signal an error. Make
3102 sure to initialize color slots so that we won't try
3103 to free colors we haven't allocated. */
3104 f->output_data.x->foreground_pixel = -1;
3105 f->output_data.x->background_pixel = -1;
3106 f->output_data.x->cursor_pixel = -1;
3107 f->output_data.x->cursor_foreground_pixel = -1;
3108 f->output_data.x->border_pixel = -1;
3109 f->output_data.x->mouse_pixel = -1;
3111 black = build_string ("black");
3112 GCPRO1 (black);
3113 f->output_data.x->foreground_pixel
3114 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3115 f->output_data.x->background_pixel
3116 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3117 f->output_data.x->cursor_pixel
3118 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3119 f->output_data.x->cursor_foreground_pixel
3120 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3121 f->output_data.x->border_pixel
3122 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3123 f->output_data.x->mouse_pixel
3124 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3125 UNGCPRO;
3128 /* Specify the parent under which to make this X window. */
3130 if (!NILP (parent))
3132 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3133 f->output_data.x->explicit_parent = 1;
3135 else
3137 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3138 f->output_data.x->explicit_parent = 0;
3141 /* Set the name; the functions to which we pass f expect the name to
3142 be set. */
3143 if (EQ (name, Qunbound) || NILP (name))
3145 f->name = build_string (dpyinfo->x_id_name);
3146 f->explicit_name = 0;
3148 else
3150 f->name = name;
3151 f->explicit_name = 1;
3152 /* use the frame's title when getting resources for this frame. */
3153 specbind (Qx_resource_name, name);
3156 /* Extract the window parameters from the supplied values
3157 that are needed to determine window geometry. */
3159 Lisp_Object font;
3161 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
3163 BLOCK_INPUT;
3164 /* First, try whatever font the caller has specified. */
3165 if (STRINGP (font))
3167 tem = Fquery_fontset (font, Qnil);
3168 if (STRINGP (tem))
3169 font = x_new_fontset (f, SDATA (tem));
3170 else
3171 font = x_new_font (f, SDATA (font));
3174 /* Try out a font which we hope has bold and italic variations. */
3175 if (!STRINGP (font))
3176 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
3177 if (!STRINGP (font))
3178 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3179 if (! STRINGP (font))
3180 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3181 if (! STRINGP (font))
3182 /* This was formerly the first thing tried, but it finds too many fonts
3183 and takes too long. */
3184 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
3185 /* If those didn't work, look for something which will at least work. */
3186 if (! STRINGP (font))
3187 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
3188 UNBLOCK_INPUT;
3189 if (! STRINGP (font))
3190 font = build_string ("fixed");
3192 x_default_parameter (f, parms, Qfont, font,
3193 "font", "Font", RES_TYPE_STRING);
3196 #ifdef USE_LUCID
3197 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
3198 whereby it fails to get any font. */
3199 xlwmenu_default_font = FRAME_FONT (f);
3200 #endif
3202 x_default_parameter (f, parms, Qborder_width, make_number (2),
3203 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3205 /* This defaults to 1 in order to match xterm. We recognize either
3206 internalBorderWidth or internalBorder (which is what xterm calls
3207 it). */
3208 if (NILP (Fassq (Qinternal_border_width, parms)))
3210 Lisp_Object value;
3212 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3213 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3214 if (! EQ (value, Qunbound))
3215 parms = Fcons (Fcons (Qinternal_border_width, value),
3216 parms);
3218 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
3219 "internalBorderWidth", "internalBorderWidth",
3220 RES_TYPE_NUMBER);
3221 x_default_parameter (f, parms, Qvertical_scroll_bars, Qleft,
3222 "verticalScrollBars", "ScrollBars",
3223 RES_TYPE_SYMBOL);
3225 /* Also do the stuff which must be set before the window exists. */
3226 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3227 "foreground", "Foreground", RES_TYPE_STRING);
3228 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3229 "background", "Background", RES_TYPE_STRING);
3230 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3231 "pointerColor", "Foreground", RES_TYPE_STRING);
3232 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
3233 "cursorColor", "Foreground", RES_TYPE_STRING);
3234 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3235 "borderColor", "BorderColor", RES_TYPE_STRING);
3236 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3237 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3238 x_default_parameter (f, parms, Qline_spacing, Qnil,
3239 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3240 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3241 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3242 x_default_parameter (f, parms, Qright_fringe, Qnil,
3243 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3245 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3246 "scrollBarForeground",
3247 "ScrollBarForeground", 1);
3248 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3249 "scrollBarBackground",
3250 "ScrollBarBackground", 0);
3252 /* Init faces before x_default_parameter is called for scroll-bar
3253 parameters because that function calls x_set_scroll_bar_width,
3254 which calls change_frame_size, which calls Fset_window_buffer,
3255 which runs hooks, which call Fvertical_motion. At the end, we
3256 end up in init_iterator with a null face cache, which should not
3257 happen. */
3258 init_frame_faces (f);
3260 x_default_parameter (f, parms, Qmenu_bar_lines, make_number (1),
3261 "menuBar", "MenuBar", RES_TYPE_NUMBER);
3262 x_default_parameter (f, parms, Qtool_bar_lines, make_number (1),
3263 "toolBar", "ToolBar", RES_TYPE_NUMBER);
3264 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3265 "bufferPredicate", "BufferPredicate",
3266 RES_TYPE_SYMBOL);
3267 x_default_parameter (f, parms, Qtitle, Qnil,
3268 "title", "Title", RES_TYPE_STRING);
3269 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3270 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3271 x_default_parameter (f, parms, Qfullscreen, Qnil,
3272 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3274 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3276 /* Compute the size of the X window. */
3277 window_prompting = x_figure_window_size (f, parms, 1);
3279 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3280 f->no_split = minibuffer_only || EQ (tem, Qt);
3282 x_icon_verify (f, parms);
3284 /* Create the X widget or window. */
3285 #ifdef USE_X_TOOLKIT
3286 x_window (f, window_prompting, minibuffer_only);
3287 #else
3288 x_window (f);
3289 #endif
3291 x_icon (f, parms);
3292 x_make_gc (f);
3294 /* Now consider the frame official. */
3295 FRAME_X_DISPLAY_INFO (f)->reference_count++;
3296 Vframe_list = Fcons (frame, Vframe_list);
3298 /* We need to do this after creating the X window, so that the
3299 icon-creation functions can say whose icon they're describing. */
3300 x_default_parameter (f, parms, Qicon_type, Qt,
3301 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
3303 x_default_parameter (f, parms, Qauto_raise, Qnil,
3304 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3305 x_default_parameter (f, parms, Qauto_lower, Qnil,
3306 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3307 x_default_parameter (f, parms, Qcursor_type, Qbox,
3308 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3309 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3310 "scrollBarWidth", "ScrollBarWidth",
3311 RES_TYPE_NUMBER);
3313 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3314 Change will not be effected unless different from the current
3315 FRAME_LINES (f). */
3316 width = FRAME_COLS (f);
3317 height = FRAME_LINES (f);
3319 SET_FRAME_COLS (f, 0);
3320 FRAME_LINES (f) = 0;
3321 change_frame_size (f, height, width, 1, 0, 0);
3323 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3324 /* Create the menu bar. */
3325 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3327 /* If this signals an error, we haven't set size hints for the
3328 frame and we didn't make it visible. */
3329 initialize_frame_menubar (f);
3331 #ifndef USE_GTK
3332 /* This is a no-op, except under Motif where it arranges the
3333 main window for the widgets on it. */
3334 lw_set_main_areas (f->output_data.x->column_widget,
3335 f->output_data.x->menubar_widget,
3336 f->output_data.x->edit_widget);
3337 #endif /* not USE_GTK */
3339 #endif /* USE_X_TOOLKIT || USE_GTK */
3341 /* Tell the server what size and position, etc, we want, and how
3342 badly we want them. This should be done after we have the menu
3343 bar so that its size can be taken into account. */
3344 BLOCK_INPUT;
3345 x_wm_set_size_hint (f, window_prompting, 0);
3346 UNBLOCK_INPUT;
3348 /* Make the window appear on the frame and enable display, unless
3349 the caller says not to. However, with explicit parent, Emacs
3350 cannot control visibility, so don't try. */
3351 if (! f->output_data.x->explicit_parent)
3353 Lisp_Object visibility;
3355 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3356 RES_TYPE_SYMBOL);
3357 if (EQ (visibility, Qunbound))
3358 visibility = Qt;
3360 if (EQ (visibility, Qicon))
3361 x_iconify_frame (f);
3362 else if (! NILP (visibility))
3363 x_make_frame_visible (f);
3364 else
3365 /* Must have been Qnil. */
3369 /* Set the WM leader property. GTK does this itself, so this is not
3370 needed when using GTK. */
3371 if (dpyinfo->client_leader_window != 0)
3373 BLOCK_INPUT;
3374 XChangeProperty (FRAME_X_DISPLAY (f),
3375 FRAME_OUTER_WINDOW (f),
3376 dpyinfo->Xatom_wm_client_leader,
3377 XA_WINDOW, 32, PropModeReplace,
3378 (unsigned char *) &dpyinfo->client_leader_window, 1);
3379 UNBLOCK_INPUT;
3382 /* Initialize `default-minibuffer-frame' in case this is the first
3383 frame on this display device. */
3384 if (FRAME_HAS_MINIBUF_P (f)
3385 && (!FRAMEP (kb->Vdefault_minibuffer_frame)
3386 || !FRAME_LIVE_P (XFRAME (kb->Vdefault_minibuffer_frame))))
3387 kb->Vdefault_minibuffer_frame = frame;
3389 /* All remaining specified parameters, which have not been "used"
3390 by x_get_arg and friends, now go in the misc. alist of the frame. */
3391 for (tem = parms; !NILP (tem); tem = XCDR (tem))
3392 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3393 f->param_alist = Fcons (XCAR (tem), f->param_alist);
3395 UNGCPRO;
3397 /* Make sure windows on this frame appear in calls to next-window
3398 and similar functions. */
3399 Vwindow_list = Qnil;
3401 return unbind_to (count, frame);
3405 /* FRAME is used only to get a handle on the X display. We don't pass the
3406 display info directly because we're called from frame.c, which doesn't
3407 know about that structure. */
3409 Lisp_Object
3410 x_get_focus_frame (frame)
3411 struct frame *frame;
3413 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
3414 Lisp_Object xfocus;
3415 if (! dpyinfo->x_focus_frame)
3416 return Qnil;
3418 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3419 return xfocus;
3423 /* In certain situations, when the window manager follows a
3424 click-to-focus policy, there seems to be no way around calling
3425 XSetInputFocus to give another frame the input focus .
3427 In an ideal world, XSetInputFocus should generally be avoided so
3428 that applications don't interfere with the window manager's focus
3429 policy. But I think it's okay to use when it's clearly done
3430 following a user-command. */
3432 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
3433 doc: /* Set the input focus to FRAME.
3434 FRAME nil means use the selected frame. */)
3435 (frame)
3436 Lisp_Object frame;
3438 struct frame *f = check_x_frame (frame);
3439 Display *dpy = FRAME_X_DISPLAY (f);
3440 int count;
3442 BLOCK_INPUT;
3443 count = x_catch_errors (dpy);
3444 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3445 RevertToParent, CurrentTime);
3446 x_uncatch_errors (dpy, count);
3447 UNBLOCK_INPUT;
3449 return Qnil;
3453 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3454 doc: /* Internal function called by `color-defined-p', which see. */)
3455 (color, frame)
3456 Lisp_Object color, frame;
3458 XColor foo;
3459 FRAME_PTR f = check_x_frame (frame);
3461 CHECK_STRING (color);
3463 if (x_defined_color (f, SDATA (color), &foo, 0))
3464 return Qt;
3465 else
3466 return Qnil;
3469 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3470 doc: /* Internal function called by `color-values', which see. */)
3471 (color, frame)
3472 Lisp_Object color, frame;
3474 XColor foo;
3475 FRAME_PTR f = check_x_frame (frame);
3477 CHECK_STRING (color);
3479 if (x_defined_color (f, SDATA (color), &foo, 0))
3481 Lisp_Object rgb[3];
3483 rgb[0] = make_number (foo.red);
3484 rgb[1] = make_number (foo.green);
3485 rgb[2] = make_number (foo.blue);
3486 return Flist (3, rgb);
3488 else
3489 return Qnil;
3492 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3493 doc: /* Internal function called by `display-color-p', which see. */)
3494 (display)
3495 Lisp_Object display;
3497 struct x_display_info *dpyinfo = check_x_display_info (display);
3499 if (dpyinfo->n_planes <= 2)
3500 return Qnil;
3502 switch (dpyinfo->visual->class)
3504 case StaticColor:
3505 case PseudoColor:
3506 case TrueColor:
3507 case DirectColor:
3508 return Qt;
3510 default:
3511 return Qnil;
3515 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3516 0, 1, 0,
3517 doc: /* Return t if the X display supports shades of gray.
3518 Note that color displays do support shades of gray.
3519 The optional argument DISPLAY specifies which display to ask about.
3520 DISPLAY should be either a frame or a display name (a string).
3521 If omitted or nil, that stands for the selected frame's display. */)
3522 (display)
3523 Lisp_Object display;
3525 struct x_display_info *dpyinfo = check_x_display_info (display);
3527 if (dpyinfo->n_planes <= 1)
3528 return Qnil;
3530 switch (dpyinfo->visual->class)
3532 case StaticColor:
3533 case PseudoColor:
3534 case TrueColor:
3535 case DirectColor:
3536 case StaticGray:
3537 case GrayScale:
3538 return Qt;
3540 default:
3541 return Qnil;
3545 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3546 0, 1, 0,
3547 doc: /* Returns the width in pixels of the X display DISPLAY.
3548 The optional argument DISPLAY specifies which display to ask about.
3549 DISPLAY should be either a frame or a display name (a string).
3550 If omitted or nil, that stands for the selected frame's display. */)
3551 (display)
3552 Lisp_Object display;
3554 struct x_display_info *dpyinfo = check_x_display_info (display);
3556 return make_number (dpyinfo->width);
3559 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3560 Sx_display_pixel_height, 0, 1, 0,
3561 doc: /* Returns the height in pixels of the X display DISPLAY.
3562 The optional argument DISPLAY specifies which display to ask about.
3563 DISPLAY should be either a frame or a display name (a string).
3564 If omitted or nil, that stands for the selected frame's display. */)
3565 (display)
3566 Lisp_Object display;
3568 struct x_display_info *dpyinfo = check_x_display_info (display);
3570 return make_number (dpyinfo->height);
3573 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3574 0, 1, 0,
3575 doc: /* Returns the number of bitplanes of the X display DISPLAY.
3576 The optional argument DISPLAY specifies which display to ask about.
3577 DISPLAY should be either a frame or a display name (a string).
3578 If omitted or nil, that stands for the selected frame's display. */)
3579 (display)
3580 Lisp_Object display;
3582 struct x_display_info *dpyinfo = check_x_display_info (display);
3584 return make_number (dpyinfo->n_planes);
3587 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3588 0, 1, 0,
3589 doc: /* Returns the number of color cells of the X display DISPLAY.
3590 The optional argument DISPLAY specifies which display to ask about.
3591 DISPLAY should be either a frame or a display name (a string).
3592 If omitted or nil, that stands for the selected frame's display. */)
3593 (display)
3594 Lisp_Object display;
3596 struct x_display_info *dpyinfo = check_x_display_info (display);
3598 int nr_planes = DisplayPlanes (dpyinfo->display,
3599 XScreenNumberOfScreen (dpyinfo->screen));
3601 /* Truncate nr_planes to 24 to avoid integer overflow.
3602 Some displays says 32, but only 24 bits are actually significant.
3603 There are only very few and rare video cards that have more than
3604 24 significant bits. Also 24 bits is more than 16 million colors,
3605 it "should be enough for everyone". */
3606 if (nr_planes > 24) nr_planes = 24;
3608 return make_number (1 << nr_planes);
3611 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3612 Sx_server_max_request_size,
3613 0, 1, 0,
3614 doc: /* Returns the maximum request size of the X server of display DISPLAY.
3615 The optional argument DISPLAY specifies which display to ask about.
3616 DISPLAY should be either a frame or a display name (a string).
3617 If omitted or nil, that stands for the selected frame's display. */)
3618 (display)
3619 Lisp_Object display;
3621 struct x_display_info *dpyinfo = check_x_display_info (display);
3623 return make_number (MAXREQUEST (dpyinfo->display));
3626 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3627 doc: /* Returns the "vendor ID" string of the X server of display DISPLAY.
3628 \(Labelling every distributor as a "vendor" embodies the false assumption
3629 that operating systems cannot be developed and distributed noncommercially.)
3630 The optional argument DISPLAY specifies which display to ask about.
3631 DISPLAY should be either a frame or a display name (a string).
3632 If omitted or nil, that stands for the selected frame's display. */)
3633 (display)
3634 Lisp_Object display;
3636 struct x_display_info *dpyinfo = check_x_display_info (display);
3637 char *vendor = ServerVendor (dpyinfo->display);
3639 if (! vendor) vendor = "";
3640 return build_string (vendor);
3643 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3644 doc: /* Returns the version numbers of the X server of display DISPLAY.
3645 The value is a list of three integers: the major and minor
3646 version numbers of the X Protocol in use, and the distributor-specific release
3647 number. See also the function `x-server-vendor'.
3649 The optional argument DISPLAY specifies which display to ask about.
3650 DISPLAY should be either a frame or a display name (a string).
3651 If omitted or nil, that stands for the selected frame's display. */)
3652 (display)
3653 Lisp_Object display;
3655 struct x_display_info *dpyinfo = check_x_display_info (display);
3656 Display *dpy = dpyinfo->display;
3658 return Fcons (make_number (ProtocolVersion (dpy)),
3659 Fcons (make_number (ProtocolRevision (dpy)),
3660 Fcons (make_number (VendorRelease (dpy)), Qnil)));
3663 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3664 doc: /* Return the number of screens on the X server of display DISPLAY.
3665 The optional argument DISPLAY specifies which display to ask about.
3666 DISPLAY should be either a frame or a display name (a string).
3667 If omitted or nil, that stands for the selected frame's display. */)
3668 (display)
3669 Lisp_Object display;
3671 struct x_display_info *dpyinfo = check_x_display_info (display);
3673 return make_number (ScreenCount (dpyinfo->display));
3676 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3677 doc: /* Return the height in millimeters of the X display DISPLAY.
3678 The optional argument DISPLAY specifies which display to ask about.
3679 DISPLAY should be either a frame or a display name (a string).
3680 If omitted or nil, that stands for the selected frame's display. */)
3681 (display)
3682 Lisp_Object display;
3684 struct x_display_info *dpyinfo = check_x_display_info (display);
3686 return make_number (HeightMMOfScreen (dpyinfo->screen));
3689 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3690 doc: /* Return the width in millimeters of the X display DISPLAY.
3691 The optional argument DISPLAY specifies which display to ask about.
3692 DISPLAY should be either a frame or a display name (a string).
3693 If omitted or nil, that stands for the selected frame's display. */)
3694 (display)
3695 Lisp_Object display;
3697 struct x_display_info *dpyinfo = check_x_display_info (display);
3699 return make_number (WidthMMOfScreen (dpyinfo->screen));
3702 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3703 Sx_display_backing_store, 0, 1, 0,
3704 doc: /* Returns an indication of whether X display DISPLAY does backing store.
3705 The value may be `always', `when-mapped', or `not-useful'.
3706 The optional argument DISPLAY specifies which display to ask about.
3707 DISPLAY should be either a frame or a display name (a string).
3708 If omitted or nil, that stands for the selected frame's display. */)
3709 (display)
3710 Lisp_Object display;
3712 struct x_display_info *dpyinfo = check_x_display_info (display);
3713 Lisp_Object result;
3715 switch (DoesBackingStore (dpyinfo->screen))
3717 case Always:
3718 result = intern ("always");
3719 break;
3721 case WhenMapped:
3722 result = intern ("when-mapped");
3723 break;
3725 case NotUseful:
3726 result = intern ("not-useful");
3727 break;
3729 default:
3730 error ("Strange value for BackingStore parameter of screen");
3731 result = Qnil;
3734 return result;
3737 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3738 Sx_display_visual_class, 0, 1, 0,
3739 doc: /* Return the visual class of the X display DISPLAY.
3740 The value is one of the symbols `static-gray', `gray-scale',
3741 `static-color', `pseudo-color', `true-color', or `direct-color'.
3743 The optional argument DISPLAY specifies which display to ask about.
3744 DISPLAY should be either a frame or a display name (a string).
3745 If omitted or nil, that stands for the selected frame's display. */)
3746 (display)
3747 Lisp_Object display;
3749 struct x_display_info *dpyinfo = check_x_display_info (display);
3750 Lisp_Object result;
3752 switch (dpyinfo->visual->class)
3754 case StaticGray:
3755 result = intern ("static-gray");
3756 break;
3757 case GrayScale:
3758 result = intern ("gray-scale");
3759 break;
3760 case StaticColor:
3761 result = intern ("static-color");
3762 break;
3763 case PseudoColor:
3764 result = intern ("pseudo-color");
3765 break;
3766 case TrueColor:
3767 result = intern ("true-color");
3768 break;
3769 case DirectColor:
3770 result = intern ("direct-color");
3771 break;
3772 default:
3773 error ("Display has an unknown visual class");
3774 result = Qnil;
3777 return result;
3780 DEFUN ("x-display-save-under", Fx_display_save_under,
3781 Sx_display_save_under, 0, 1, 0,
3782 doc: /* Returns t if the X display DISPLAY supports the save-under feature.
3783 The optional argument DISPLAY specifies which display to ask about.
3784 DISPLAY should be either a frame or a display name (a string).
3785 If omitted or nil, that stands for the selected frame's display. */)
3786 (display)
3787 Lisp_Object display;
3789 struct x_display_info *dpyinfo = check_x_display_info (display);
3791 if (DoesSaveUnders (dpyinfo->screen) == True)
3792 return Qt;
3793 else
3794 return Qnil;
3798 x_pixel_width (f)
3799 register struct frame *f;
3801 return FRAME_PIXEL_WIDTH (f);
3805 x_pixel_height (f)
3806 register struct frame *f;
3808 return FRAME_PIXEL_HEIGHT (f);
3812 x_char_width (f)
3813 register struct frame *f;
3815 return FRAME_COLUMN_WIDTH (f);
3819 x_char_height (f)
3820 register struct frame *f;
3822 return FRAME_LINE_HEIGHT (f);
3826 x_screen_planes (f)
3827 register struct frame *f;
3829 return FRAME_X_DISPLAY_INFO (f)->n_planes;
3834 /************************************************************************
3835 X Displays
3836 ************************************************************************/
3839 /* Mapping visual names to visuals. */
3841 static struct visual_class
3843 char *name;
3844 int class;
3846 visual_classes[] =
3848 {"StaticGray", StaticGray},
3849 {"GrayScale", GrayScale},
3850 {"StaticColor", StaticColor},
3851 {"PseudoColor", PseudoColor},
3852 {"TrueColor", TrueColor},
3853 {"DirectColor", DirectColor},
3854 {NULL, 0}
3858 #ifndef HAVE_XSCREENNUMBEROFSCREEN
3860 /* Value is the screen number of screen SCR. This is a substitute for
3861 the X function with the same name when that doesn't exist. */
3864 XScreenNumberOfScreen (scr)
3865 register Screen *scr;
3867 Display *dpy = scr->display;
3868 int i;
3870 for (i = 0; i < dpy->nscreens; ++i)
3871 if (scr == dpy->screens + i)
3872 break;
3874 return i;
3877 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
3880 /* Select the visual that should be used on display DPYINFO. Set
3881 members of DPYINFO appropriately. Called from x_term_init. */
3883 void
3884 select_visual (dpyinfo)
3885 struct x_display_info *dpyinfo;
3887 Display *dpy = dpyinfo->display;
3888 Screen *screen = dpyinfo->screen;
3889 Lisp_Object value;
3891 /* See if a visual is specified. */
3892 value = display_x_get_resource (dpyinfo,
3893 build_string ("visualClass"),
3894 build_string ("VisualClass"),
3895 Qnil, Qnil);
3896 if (STRINGP (value))
3898 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
3899 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
3900 depth, a decimal number. NAME is compared with case ignored. */
3901 char *s = (char *) alloca (SBYTES (value) + 1);
3902 char *dash;
3903 int i, class = -1;
3904 XVisualInfo vinfo;
3906 strcpy (s, SDATA (value));
3907 dash = index (s, '-');
3908 if (dash)
3910 dpyinfo->n_planes = atoi (dash + 1);
3911 *dash = '\0';
3913 else
3914 /* We won't find a matching visual with depth 0, so that
3915 an error will be printed below. */
3916 dpyinfo->n_planes = 0;
3918 /* Determine the visual class. */
3919 for (i = 0; visual_classes[i].name; ++i)
3920 if (xstricmp (s, visual_classes[i].name) == 0)
3922 class = visual_classes[i].class;
3923 break;
3926 /* Look up a matching visual for the specified class. */
3927 if (class == -1
3928 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
3929 dpyinfo->n_planes, class, &vinfo))
3930 fatal ("Invalid visual specification `%s'", SDATA (value));
3932 dpyinfo->visual = vinfo.visual;
3934 else
3936 int n_visuals;
3937 XVisualInfo *vinfo, vinfo_template;
3939 dpyinfo->visual = DefaultVisualOfScreen (screen);
3941 #ifdef HAVE_X11R4
3942 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
3943 #else
3944 vinfo_template.visualid = dpyinfo->visual->visualid;
3945 #endif
3946 vinfo_template.screen = XScreenNumberOfScreen (screen);
3947 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
3948 &vinfo_template, &n_visuals);
3949 if (n_visuals != 1)
3950 fatal ("Can't get proper X visual info");
3952 dpyinfo->n_planes = vinfo->depth;
3953 XFree ((char *) vinfo);
3958 /* Return the X display structure for the display named NAME.
3959 Open a new connection if necessary. */
3961 struct x_display_info *
3962 x_display_info_for_name (name)
3963 Lisp_Object name;
3965 Lisp_Object names;
3966 struct x_display_info *dpyinfo;
3968 CHECK_STRING (name);
3970 if (! EQ (Vwindow_system, intern ("x")))
3971 error ("Not using X Windows");
3973 for (dpyinfo = x_display_list, names = x_display_name_list;
3974 dpyinfo;
3975 dpyinfo = dpyinfo->next, names = XCDR (names))
3977 Lisp_Object tem;
3978 tem = Fstring_equal (XCAR (XCAR (names)), name);
3979 if (!NILP (tem))
3980 return dpyinfo;
3983 /* Use this general default value to start with. */
3984 Vx_resource_name = Vinvocation_name;
3986 validate_x_resource_name ();
3988 dpyinfo = x_term_init (name, (char *)0,
3989 (char *) SDATA (Vx_resource_name));
3991 if (dpyinfo == 0)
3992 error ("Cannot connect to X server %s", SDATA (name));
3994 x_in_use = 1;
3995 XSETFASTINT (Vwindow_system_version, 11);
3997 return dpyinfo;
4001 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4002 1, 3, 0,
4003 doc: /* Open a connection to an X server.
4004 DISPLAY is the name of the display to connect to.
4005 Optional second arg XRM-STRING is a string of resources in xrdb format.
4006 If the optional third arg MUST-SUCCEED is non-nil,
4007 terminate Emacs if we can't open the connection. */)
4008 (display, xrm_string, must_succeed)
4009 Lisp_Object display, xrm_string, must_succeed;
4011 unsigned char *xrm_option;
4012 struct x_display_info *dpyinfo;
4014 CHECK_STRING (display);
4015 if (! NILP (xrm_string))
4016 CHECK_STRING (xrm_string);
4018 if (! EQ (Vwindow_system, intern ("x")))
4019 error ("Not using X Windows");
4021 if (! NILP (xrm_string))
4022 xrm_option = (unsigned char *) SDATA (xrm_string);
4023 else
4024 xrm_option = (unsigned char *) 0;
4026 validate_x_resource_name ();
4028 /* This is what opens the connection and sets x_current_display.
4029 This also initializes many symbols, such as those used for input. */
4030 dpyinfo = x_term_init (display, xrm_option,
4031 (char *) SDATA (Vx_resource_name));
4033 if (dpyinfo == 0)
4035 if (!NILP (must_succeed))
4036 fatal ("Cannot connect to X server %s.\n\
4037 Check the DISPLAY environment variable or use `-d'.\n\
4038 Also use the `xauth' program to verify that you have the proper\n\
4039 authorization information needed to connect the X server.\n\
4040 An insecure way to solve the problem may be to use `xhost'.\n",
4041 SDATA (display));
4042 else
4043 error ("Cannot connect to X server %s", SDATA (display));
4046 x_in_use = 1;
4048 XSETFASTINT (Vwindow_system_version, 11);
4049 return Qnil;
4052 DEFUN ("x-close-connection", Fx_close_connection,
4053 Sx_close_connection, 1, 1, 0,
4054 doc: /* Close the connection to DISPLAY's X server.
4055 For DISPLAY, specify either a frame or a display name (a string).
4056 If DISPLAY is nil, that stands for the selected frame's display. */)
4057 (display)
4058 Lisp_Object display;
4060 struct x_display_info *dpyinfo = check_x_display_info (display);
4061 int i;
4063 if (dpyinfo->reference_count > 0)
4064 error ("Display still has frames on it");
4066 BLOCK_INPUT;
4067 /* Free the fonts in the font table. */
4068 for (i = 0; i < dpyinfo->n_fonts; i++)
4069 if (dpyinfo->font_table[i].name)
4071 XFreeFont (dpyinfo->display, dpyinfo->font_table[i].font);
4074 x_destroy_all_bitmaps (dpyinfo);
4075 XSetCloseDownMode (dpyinfo->display, DestroyAll);
4077 #ifdef USE_X_TOOLKIT
4078 XtCloseDisplay (dpyinfo->display);
4079 #else
4080 XCloseDisplay (dpyinfo->display);
4081 #endif
4083 x_delete_display (dpyinfo);
4084 UNBLOCK_INPUT;
4086 return Qnil;
4089 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4090 doc: /* Return the list of display names that Emacs has connections to. */)
4093 Lisp_Object tail, result;
4095 result = Qnil;
4096 for (tail = x_display_name_list; ! NILP (tail); tail = XCDR (tail))
4097 result = Fcons (XCAR (XCAR (tail)), result);
4099 return result;
4102 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4103 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4104 If ON is nil, allow buffering of requests.
4105 Turning on synchronization prohibits the Xlib routines from buffering
4106 requests and seriously degrades performance, but makes debugging much
4107 easier.
4108 The optional second argument DISPLAY specifies which display to act on.
4109 DISPLAY should be either a frame or a display name (a string).
4110 If DISPLAY is omitted or nil, that stands for the selected frame's display. */)
4111 (on, display)
4112 Lisp_Object display, on;
4114 struct x_display_info *dpyinfo = check_x_display_info (display);
4116 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4118 return Qnil;
4121 /* Wait for responses to all X commands issued so far for frame F. */
4123 void
4124 x_sync (f)
4125 FRAME_PTR f;
4127 BLOCK_INPUT;
4128 XSync (FRAME_X_DISPLAY (f), False);
4129 UNBLOCK_INPUT;
4133 /***********************************************************************
4134 Window properties
4135 ***********************************************************************/
4137 DEFUN ("x-change-window-property", Fx_change_window_property,
4138 Sx_change_window_property, 2, 6, 0,
4139 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4140 PROP must be a string.
4141 VALUE may be a string or a list of conses, numbers and/or strings.
4142 If an element in the list is a string, it is converted to
4143 an Atom and the value of the Atom is used. If an element is a cons,
4144 it is converted to a 32 bit number where the car is the 16 top bits and the
4145 cdr is the lower 16 bits.
4146 FRAME nil or omitted means use the selected frame.
4147 If TYPE is given and non-nil, it is the name of the type of VALUE.
4148 If TYPE is not given or nil, the type is STRING.
4149 FORMAT gives the size in bits of each element if VALUE is a list.
4150 It must be one of 8, 16 or 32.
4151 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4152 If OUTER_P is non-nil, the property is changed for the outer X window of
4153 FRAME. Default is to change on the edit X window.
4155 Value is VALUE. */)
4156 (prop, value, frame, type, format, outer_p)
4157 Lisp_Object prop, value, frame, type, format, outer_p;
4159 struct frame *f = check_x_frame (frame);
4160 Atom prop_atom;
4161 Atom target_type = XA_STRING;
4162 int element_format = 8;
4163 unsigned char *data;
4164 int nelements;
4165 Window w;
4167 CHECK_STRING (prop);
4169 if (! NILP (format))
4171 CHECK_NUMBER (format);
4172 element_format = XFASTINT (format);
4174 if (element_format != 8 && element_format != 16
4175 && element_format != 32)
4176 error ("FORMAT must be one of 8, 16 or 32");
4179 if (CONSP (value))
4181 nelements = x_check_property_data (value);
4182 if (nelements == -1)
4183 error ("Bad data in VALUE, must be number, string or cons");
4185 if (element_format == 8)
4186 data = (unsigned char *) xmalloc (nelements);
4187 else if (element_format == 16)
4188 data = (unsigned char *) xmalloc (nelements*2);
4189 else /* format == 32 */
4190 /* The man page for XChangeProperty:
4191 "If the specified format is 32, the property data must be a
4192 long array."
4193 This applies even if long is more than 64 bits. The X library
4194 converts to 32 bits before sending to the X server. */
4195 data = (unsigned char *) xmalloc (nelements * sizeof(long));
4197 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4199 else
4201 CHECK_STRING (value);
4202 data = SDATA (value);
4203 nelements = SCHARS (value);
4206 BLOCK_INPUT;
4207 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4208 if (! NILP (type))
4210 CHECK_STRING (type);
4211 target_type = XInternAtom (FRAME_X_DISPLAY (f), SDATA (type), False);
4214 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4215 else w = FRAME_X_WINDOW (f);
4217 XChangeProperty (FRAME_X_DISPLAY (f), w,
4218 prop_atom, target_type, element_format, PropModeReplace,
4219 data, nelements);
4221 if (CONSP (value)) xfree (data);
4223 /* Make sure the property is set when we return. */
4224 XFlush (FRAME_X_DISPLAY (f));
4225 UNBLOCK_INPUT;
4227 return value;
4231 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4232 Sx_delete_window_property, 1, 2, 0,
4233 doc: /* Remove window property PROP from X window of FRAME.
4234 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4235 (prop, frame)
4236 Lisp_Object prop, frame;
4238 struct frame *f = check_x_frame (frame);
4239 Atom prop_atom;
4241 CHECK_STRING (prop);
4242 BLOCK_INPUT;
4243 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4244 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4246 /* Make sure the property is removed when we return. */
4247 XFlush (FRAME_X_DISPLAY (f));
4248 UNBLOCK_INPUT;
4250 return prop;
4254 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4255 1, 6, 0,
4256 doc: /* Value is the value of window property PROP on FRAME.
4257 If FRAME is nil or omitted, use the selected frame.
4258 If TYPE is nil or omitted, get the property as a string. Otherwise TYPE
4259 is the name of the Atom that denotes the type expected.
4260 If SOURCE is non-nil, get the property on that window instead of from
4261 FRAME. The number 0 denotes the root window.
4262 If DELETE_P is non-nil, delete the property after retreiving it.
4263 If VECTOR_RET_P is non-nil, don't return a string but a vector of values.
4265 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4266 no value of TYPE. */)
4267 (prop, frame, type, source, delete_p, vector_ret_p)
4268 Lisp_Object prop, frame, type, source, delete_p, vector_ret_p;
4270 struct frame *f = check_x_frame (frame);
4271 Atom prop_atom;
4272 int rc;
4273 Lisp_Object prop_value = Qnil;
4274 unsigned char *tmp_data = NULL;
4275 Atom actual_type;
4276 Atom target_type = XA_STRING;
4277 int actual_format;
4278 unsigned long actual_size, bytes_remaining;
4279 Window target_window = FRAME_X_WINDOW (f);
4280 struct gcpro gcpro1;
4282 GCPRO1 (prop_value);
4283 CHECK_STRING (prop);
4285 if (! NILP (source))
4287 if (NUMBERP (source))
4289 if (FLOATP (source))
4290 target_window = (Window) XFLOAT (source);
4291 else
4292 target_window = XFASTINT (source);
4294 if (target_window == 0)
4295 target_window = FRAME_X_DISPLAY_INFO (f)->root_window;
4297 else if (CONSP (source))
4298 target_window = cons_to_long (source);
4301 BLOCK_INPUT;
4302 if (STRINGP (type))
4304 if (strcmp ("AnyPropertyType", SDATA (type)) == 0)
4305 target_type = AnyPropertyType;
4306 else
4307 target_type = XInternAtom (FRAME_X_DISPLAY (f), SDATA (type), False);
4310 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4311 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4312 prop_atom, 0, 0, False, target_type,
4313 &actual_type, &actual_format, &actual_size,
4314 &bytes_remaining, &tmp_data);
4315 if (rc == Success)
4317 int size = bytes_remaining;
4319 XFree (tmp_data);
4320 tmp_data = NULL;
4322 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4323 prop_atom, 0, bytes_remaining,
4324 ! NILP (delete_p), target_type,
4325 &actual_type, &actual_format,
4326 &actual_size, &bytes_remaining,
4327 &tmp_data);
4328 if (rc == Success && tmp_data)
4330 /* The man page for XGetWindowProperty says:
4331 "If the returned format is 32, the returned data is represented
4332 as a long array and should be cast to that type to obtain the
4333 elements."
4334 This applies even if long is more than 32 bits, the X library
4335 converts from 32 bit elements received from the X server to long
4336 and passes the long array to us. Thus, for that case bcopy can not
4337 be used. We convert to a 32 bit type here, because so much code
4338 assume on that.
4340 The bytes and offsets passed to XGetWindowProperty refers to the
4341 property and those are indeed in 32 bit quantities if format is
4342 32. */
4344 if (actual_format == 32 && actual_format < BITS_PER_LONG)
4346 unsigned long i;
4347 int *idata = (int *) tmp_data;
4348 long *ldata = (long *) tmp_data;
4350 for (i = 0; i < actual_size; ++i)
4351 idata[i] = (int) ldata[i];
4354 if (NILP (vector_ret_p))
4355 prop_value = make_string (tmp_data, size);
4356 else
4357 prop_value = x_property_data_to_lisp (f,
4358 tmp_data,
4359 actual_type,
4360 actual_format,
4361 actual_size);
4364 if (tmp_data) XFree (tmp_data);
4367 UNBLOCK_INPUT;
4368 UNGCPRO;
4369 return prop_value;
4374 /***********************************************************************
4375 Busy cursor
4376 ***********************************************************************/
4378 /* If non-null, an asynchronous timer that, when it expires, displays
4379 an hourglass cursor on all frames. */
4381 static struct atimer *hourglass_atimer;
4383 /* Non-zero means an hourglass cursor is currently shown. */
4385 static int hourglass_shown_p;
4387 /* Number of seconds to wait before displaying an hourglass cursor. */
4389 static Lisp_Object Vhourglass_delay;
4391 /* Default number of seconds to wait before displaying an hourglass
4392 cursor. */
4394 #define DEFAULT_HOURGLASS_DELAY 1
4396 /* Function prototypes. */
4398 static void show_hourglass P_ ((struct atimer *));
4399 static void hide_hourglass P_ ((void));
4401 /* Return non-zero if houglass timer has been started or hourglass is shown. */
4404 hourglass_started ()
4406 return hourglass_shown_p || hourglass_atimer != NULL;
4410 /* Cancel a currently active hourglass timer, and start a new one. */
4412 void
4413 start_hourglass ()
4415 EMACS_TIME delay;
4416 int secs, usecs = 0;
4418 /* Don't bother for ttys. */
4419 if (NILP (Vwindow_system))
4420 return;
4422 cancel_hourglass ();
4424 if (INTEGERP (Vhourglass_delay)
4425 && XINT (Vhourglass_delay) > 0)
4426 secs = XFASTINT (Vhourglass_delay);
4427 else if (FLOATP (Vhourglass_delay)
4428 && XFLOAT_DATA (Vhourglass_delay) > 0)
4430 Lisp_Object tem;
4431 tem = Ftruncate (Vhourglass_delay, Qnil);
4432 secs = XFASTINT (tem);
4433 usecs = (XFLOAT_DATA (Vhourglass_delay) - secs) * 1000000;
4435 else
4436 secs = DEFAULT_HOURGLASS_DELAY;
4438 EMACS_SET_SECS_USECS (delay, secs, usecs);
4439 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
4440 show_hourglass, NULL);
4444 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
4445 shown. */
4447 void
4448 cancel_hourglass ()
4450 if (hourglass_atimer)
4452 cancel_atimer (hourglass_atimer);
4453 hourglass_atimer = NULL;
4456 if (hourglass_shown_p)
4457 hide_hourglass ();
4461 /* Timer function of hourglass_atimer. TIMER is equal to
4462 hourglass_atimer.
4464 Display an hourglass pointer on all frames by mapping the frames'
4465 hourglass_window. Set the hourglass_p flag in the frames'
4466 output_data.x structure to indicate that an hourglass cursor is
4467 shown on the frames. */
4469 static void
4470 show_hourglass (timer)
4471 struct atimer *timer;
4473 /* The timer implementation will cancel this timer automatically
4474 after this function has run. Set hourglass_atimer to null
4475 so that we know the timer doesn't have to be canceled. */
4476 hourglass_atimer = NULL;
4478 if (!hourglass_shown_p)
4480 Lisp_Object rest, frame;
4482 BLOCK_INPUT;
4484 FOR_EACH_FRAME (rest, frame)
4486 struct frame *f = XFRAME (frame);
4488 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4490 Display *dpy = FRAME_X_DISPLAY (f);
4492 #ifdef USE_X_TOOLKIT
4493 if (f->output_data.x->widget)
4494 #else
4495 if (FRAME_OUTER_WINDOW (f))
4496 #endif
4498 f->output_data.x->hourglass_p = 1;
4500 if (!f->output_data.x->hourglass_window)
4502 unsigned long mask = CWCursor;
4503 XSetWindowAttributes attrs;
4504 #ifdef USE_GTK
4505 Window parent = FRAME_X_WINDOW (f);
4506 #else
4507 Window parent = FRAME_OUTER_WINDOW (f);
4508 #endif
4509 attrs.cursor = f->output_data.x->hourglass_cursor;
4511 f->output_data.x->hourglass_window
4512 = XCreateWindow (dpy, parent,
4513 0, 0, 32000, 32000, 0, 0,
4514 InputOnly,
4515 CopyFromParent,
4516 mask, &attrs);
4519 XMapRaised (dpy, f->output_data.x->hourglass_window);
4520 XFlush (dpy);
4525 hourglass_shown_p = 1;
4526 UNBLOCK_INPUT;
4531 /* Hide the hourglass pointer on all frames, if it is currently
4532 shown. */
4534 static void
4535 hide_hourglass ()
4537 if (hourglass_shown_p)
4539 Lisp_Object rest, frame;
4541 BLOCK_INPUT;
4542 FOR_EACH_FRAME (rest, frame)
4544 struct frame *f = XFRAME (frame);
4546 if (FRAME_X_P (f)
4547 /* Watch out for newly created frames. */
4548 && f->output_data.x->hourglass_window)
4550 XUnmapWindow (FRAME_X_DISPLAY (f),
4551 f->output_data.x->hourglass_window);
4552 /* Sync here because XTread_socket looks at the
4553 hourglass_p flag that is reset to zero below. */
4554 XSync (FRAME_X_DISPLAY (f), False);
4555 f->output_data.x->hourglass_p = 0;
4559 hourglass_shown_p = 0;
4560 UNBLOCK_INPUT;
4566 /***********************************************************************
4567 Tool tips
4568 ***********************************************************************/
4570 static Lisp_Object x_create_tip_frame P_ ((struct x_display_info *,
4571 Lisp_Object, Lisp_Object));
4572 static void compute_tip_xy P_ ((struct frame *, Lisp_Object, Lisp_Object,
4573 Lisp_Object, int, int, int *, int *));
4575 /* The frame of a currently visible tooltip. */
4577 Lisp_Object tip_frame;
4579 /* If non-nil, a timer started that hides the last tooltip when it
4580 fires. */
4582 Lisp_Object tip_timer;
4583 Window tip_window;
4585 /* If non-nil, a vector of 3 elements containing the last args
4586 with which x-show-tip was called. See there. */
4588 Lisp_Object last_show_tip_args;
4590 /* Maximum size for tooltips; a cons (COLUMNS . ROWS). */
4592 Lisp_Object Vx_max_tooltip_size;
4595 static Lisp_Object
4596 unwind_create_tip_frame (frame)
4597 Lisp_Object frame;
4599 Lisp_Object deleted;
4601 deleted = unwind_create_frame (frame);
4602 if (EQ (deleted, Qt))
4604 tip_window = None;
4605 tip_frame = Qnil;
4608 return deleted;
4612 /* Create a frame for a tooltip on the display described by DPYINFO.
4613 PARMS is a list of frame parameters. TEXT is the string to
4614 display in the tip frame. Value is the frame.
4616 Note that functions called here, esp. x_default_parameter can
4617 signal errors, for instance when a specified color name is
4618 undefined. We have to make sure that we're in a consistent state
4619 when this happens. */
4621 static Lisp_Object
4622 x_create_tip_frame (dpyinfo, parms, text)
4623 struct x_display_info *dpyinfo;
4624 Lisp_Object parms, text;
4626 struct frame *f;
4627 Lisp_Object frame, tem;
4628 Lisp_Object name;
4629 long window_prompting = 0;
4630 int width, height;
4631 int count = SPECPDL_INDEX ();
4632 struct gcpro gcpro1, gcpro2, gcpro3;
4633 struct kboard *kb;
4634 int face_change_count_before = face_change_count;
4635 Lisp_Object buffer;
4636 struct buffer *old_buffer;
4638 check_x ();
4641 #ifdef MULTI_KBOARD
4642 kb = dpyinfo->kboard;
4643 #else
4644 kb = &the_only_kboard;
4645 #endif
4647 /* Get the name of the frame to use for resource lookup. */
4648 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4649 if (!STRINGP (name)
4650 && !EQ (name, Qunbound)
4651 && !NILP (name))
4652 error ("Invalid frame name--not a string or nil");
4654 frame = Qnil;
4655 GCPRO3 (parms, name, frame);
4656 f = make_frame (1);
4657 XSETFRAME (frame, f);
4659 buffer = Fget_buffer_create (build_string (" *tip*"));
4660 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer, Qnil);
4661 old_buffer = current_buffer;
4662 set_buffer_internal_1 (XBUFFER (buffer));
4663 current_buffer->truncate_lines = Qnil;
4664 specbind (Qinhibit_read_only, Qt);
4665 specbind (Qinhibit_modification_hooks, Qt);
4666 Ferase_buffer ();
4667 Finsert (1, &text);
4668 set_buffer_internal_1 (old_buffer);
4670 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
4671 record_unwind_protect (unwind_create_tip_frame, frame);
4673 /* By setting the output method, we're essentially saying that
4674 the frame is live, as per FRAME_LIVE_P. If we get a signal
4675 from this point on, x_destroy_window might screw up reference
4676 counts etc. */
4677 f->output_method = output_x_window;
4678 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4679 bzero (f->output_data.x, sizeof (struct x_output));
4680 f->output_data.x->icon_bitmap = -1;
4681 FRAME_FONTSET (f) = -1;
4682 f->output_data.x->scroll_bar_foreground_pixel = -1;
4683 f->output_data.x->scroll_bar_background_pixel = -1;
4684 #ifdef USE_TOOLKIT_SCROLL_BARS
4685 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
4686 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
4687 #endif /* USE_TOOLKIT_SCROLL_BARS */
4688 f->icon_name = Qnil;
4689 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4690 #if GLYPH_DEBUG
4691 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
4692 dpyinfo_refcount = dpyinfo->reference_count;
4693 #endif /* GLYPH_DEBUG */
4694 #ifdef MULTI_KBOARD
4695 FRAME_KBOARD (f) = kb;
4696 #endif
4697 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4698 f->output_data.x->explicit_parent = 0;
4700 /* These colors will be set anyway later, but it's important
4701 to get the color reference counts right, so initialize them! */
4703 Lisp_Object black;
4704 struct gcpro gcpro1;
4706 black = build_string ("black");
4707 GCPRO1 (black);
4708 f->output_data.x->foreground_pixel
4709 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4710 f->output_data.x->background_pixel
4711 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4712 f->output_data.x->cursor_pixel
4713 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4714 f->output_data.x->cursor_foreground_pixel
4715 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4716 f->output_data.x->border_pixel
4717 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4718 f->output_data.x->mouse_pixel
4719 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4720 UNGCPRO;
4723 /* Set the name; the functions to which we pass f expect the name to
4724 be set. */
4725 if (EQ (name, Qunbound) || NILP (name))
4727 f->name = build_string (dpyinfo->x_id_name);
4728 f->explicit_name = 0;
4730 else
4732 f->name = name;
4733 f->explicit_name = 1;
4734 /* use the frame's title when getting resources for this frame. */
4735 specbind (Qx_resource_name, name);
4738 /* Extract the window parameters from the supplied values that are
4739 needed to determine window geometry. */
4741 Lisp_Object font;
4743 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4745 BLOCK_INPUT;
4746 /* First, try whatever font the caller has specified. */
4747 if (STRINGP (font))
4749 tem = Fquery_fontset (font, Qnil);
4750 if (STRINGP (tem))
4751 font = x_new_fontset (f, SDATA (tem));
4752 else
4753 font = x_new_font (f, SDATA (font));
4756 /* Try out a font which we hope has bold and italic variations. */
4757 if (!STRINGP (font))
4758 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
4759 if (!STRINGP (font))
4760 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4761 if (! STRINGP (font))
4762 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4763 if (! STRINGP (font))
4764 /* This was formerly the first thing tried, but it finds too many fonts
4765 and takes too long. */
4766 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
4767 /* If those didn't work, look for something which will at least work. */
4768 if (! STRINGP (font))
4769 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
4770 UNBLOCK_INPUT;
4771 if (! STRINGP (font))
4772 font = build_string ("fixed");
4774 x_default_parameter (f, parms, Qfont, font,
4775 "font", "Font", RES_TYPE_STRING);
4778 x_default_parameter (f, parms, Qborder_width, make_number (2),
4779 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4781 /* This defaults to 2 in order to match xterm. We recognize either
4782 internalBorderWidth or internalBorder (which is what xterm calls
4783 it). */
4784 if (NILP (Fassq (Qinternal_border_width, parms)))
4786 Lisp_Object value;
4788 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4789 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4790 if (! EQ (value, Qunbound))
4791 parms = Fcons (Fcons (Qinternal_border_width, value),
4792 parms);
4795 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4796 "internalBorderWidth", "internalBorderWidth",
4797 RES_TYPE_NUMBER);
4799 /* Also do the stuff which must be set before the window exists. */
4800 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4801 "foreground", "Foreground", RES_TYPE_STRING);
4802 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4803 "background", "Background", RES_TYPE_STRING);
4804 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4805 "pointerColor", "Foreground", RES_TYPE_STRING);
4806 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4807 "cursorColor", "Foreground", RES_TYPE_STRING);
4808 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4809 "borderColor", "BorderColor", RES_TYPE_STRING);
4811 /* Init faces before x_default_parameter is called for scroll-bar
4812 parameters because that function calls x_set_scroll_bar_width,
4813 which calls change_frame_size, which calls Fset_window_buffer,
4814 which runs hooks, which call Fvertical_motion. At the end, we
4815 end up in init_iterator with a null face cache, which should not
4816 happen. */
4817 init_frame_faces (f);
4819 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4821 window_prompting = x_figure_window_size (f, parms, 0);
4824 XSetWindowAttributes attrs;
4825 unsigned long mask;
4827 BLOCK_INPUT;
4828 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
4829 if (DoesSaveUnders (dpyinfo->screen))
4830 mask |= CWSaveUnder;
4832 /* Window managers look at the override-redirect flag to determine
4833 whether or net to give windows a decoration (Xlib spec, chapter
4834 3.2.8). */
4835 attrs.override_redirect = True;
4836 attrs.save_under = True;
4837 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4838 /* Arrange for getting MapNotify and UnmapNotify events. */
4839 attrs.event_mask = StructureNotifyMask;
4840 tip_window
4841 = FRAME_X_WINDOW (f)
4842 = XCreateWindow (FRAME_X_DISPLAY (f),
4843 FRAME_X_DISPLAY_INFO (f)->root_window,
4844 /* x, y, width, height */
4845 0, 0, 1, 1,
4846 /* Border. */
4848 CopyFromParent, InputOutput, CopyFromParent,
4849 mask, &attrs);
4850 UNBLOCK_INPUT;
4853 x_make_gc (f);
4855 x_default_parameter (f, parms, Qauto_raise, Qnil,
4856 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4857 x_default_parameter (f, parms, Qauto_lower, Qnil,
4858 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4859 x_default_parameter (f, parms, Qcursor_type, Qbox,
4860 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4862 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4863 Change will not be effected unless different from the current
4864 FRAME_LINES (f). */
4865 width = FRAME_COLS (f);
4866 height = FRAME_LINES (f);
4867 SET_FRAME_COLS (f, 0);
4868 FRAME_LINES (f) = 0;
4869 change_frame_size (f, height, width, 1, 0, 0);
4871 /* Add `tooltip' frame parameter's default value. */
4872 if (NILP (Fframe_parameter (frame, intern ("tooltip"))))
4873 Fmodify_frame_parameters (frame, Fcons (Fcons (intern ("tooltip"), Qt),
4874 Qnil));
4876 /* Set up faces after all frame parameters are known. This call
4877 also merges in face attributes specified for new frames.
4879 Frame parameters may be changed if .Xdefaults contains
4880 specifications for the default font. For example, if there is an
4881 `Emacs.default.attributeBackground: pink', the `background-color'
4882 attribute of the frame get's set, which let's the internal border
4883 of the tooltip frame appear in pink. Prevent this. */
4885 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
4887 /* Set tip_frame here, so that */
4888 tip_frame = frame;
4889 call1 (Qface_set_after_frame_default, frame);
4891 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
4892 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
4893 Qnil));
4896 f->no_split = 1;
4898 UNGCPRO;
4900 /* It is now ok to make the frame official even if we get an error
4901 below. And the frame needs to be on Vframe_list or making it
4902 visible won't work. */
4903 Vframe_list = Fcons (frame, Vframe_list);
4905 /* Now that the frame is official, it counts as a reference to
4906 its display. */
4907 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4909 /* Setting attributes of faces of the tooltip frame from resources
4910 and similar will increment face_change_count, which leads to the
4911 clearing of all current matrices. Since this isn't necessary
4912 here, avoid it by resetting face_change_count to the value it
4913 had before we created the tip frame. */
4914 face_change_count = face_change_count_before;
4916 /* Discard the unwind_protect. */
4917 return unbind_to (count, frame);
4921 /* Compute where to display tip frame F. PARMS is the list of frame
4922 parameters for F. DX and DY are specified offsets from the current
4923 location of the mouse. WIDTH and HEIGHT are the width and height
4924 of the tooltip. Return coordinates relative to the root window of
4925 the display in *ROOT_X, and *ROOT_Y. */
4927 static void
4928 compute_tip_xy (f, parms, dx, dy, width, height, root_x, root_y)
4929 struct frame *f;
4930 Lisp_Object parms, dx, dy;
4931 int width, height;
4932 int *root_x, *root_y;
4934 Lisp_Object left, top;
4935 int win_x, win_y;
4936 Window root, child;
4937 unsigned pmask;
4939 /* User-specified position? */
4940 left = Fcdr (Fassq (Qleft, parms));
4941 top = Fcdr (Fassq (Qtop, parms));
4943 /* Move the tooltip window where the mouse pointer is. Resize and
4944 show it. */
4945 if (!INTEGERP (left) || !INTEGERP (top))
4947 BLOCK_INPUT;
4948 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
4949 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
4950 UNBLOCK_INPUT;
4953 if (INTEGERP (top))
4954 *root_y = XINT (top);
4955 else if (*root_y + XINT (dy) <= 0)
4956 *root_y = 0; /* Can happen for negative dy */
4957 else if (*root_y + XINT (dy) + height <= FRAME_X_DISPLAY_INFO (f)->height)
4958 /* It fits below the pointer */
4959 *root_y += XINT (dy);
4960 else if (height + XINT (dy) <= *root_y)
4961 /* It fits above the pointer. */
4962 *root_y -= height + XINT (dy);
4963 else
4964 /* Put it on the top. */
4965 *root_y = 0;
4967 if (INTEGERP (left))
4968 *root_x = XINT (left);
4969 else if (*root_x + XINT (dx) <= 0)
4970 *root_x = 0; /* Can happen for negative dx */
4971 else if (*root_x + XINT (dx) + width <= FRAME_X_DISPLAY_INFO (f)->width)
4972 /* It fits to the right of the pointer. */
4973 *root_x += XINT (dx);
4974 else if (width + XINT (dx) <= *root_x)
4975 /* It fits to the left of the pointer. */
4976 *root_x -= width + XINT (dx);
4977 else
4978 /* Put it left-justified on the screen--it ought to fit that way. */
4979 *root_x = 0;
4983 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
4984 doc: /* Show STRING in a "tooltip" window on frame FRAME.
4985 A tooltip window is a small X window displaying a string.
4987 FRAME nil or omitted means use the selected frame.
4989 PARMS is an optional list of frame parameters which can be used to
4990 change the tooltip's appearance.
4992 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
4993 means use the default timeout of 5 seconds.
4995 If the list of frame parameters PARAMS contains a `left' parameters,
4996 the tooltip is displayed at that x-position. Otherwise it is
4997 displayed at the mouse position, with offset DX added (default is 5 if
4998 DX isn't specified). Likewise for the y-position; if a `top' frame
4999 parameter is specified, it determines the y-position of the tooltip
5000 window, otherwise it is displayed at the mouse position, with offset
5001 DY added (default is -10).
5003 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5004 Text larger than the specified size is clipped. */)
5005 (string, frame, parms, timeout, dx, dy)
5006 Lisp_Object string, frame, parms, timeout, dx, dy;
5008 struct frame *f;
5009 struct window *w;
5010 int root_x, root_y;
5011 struct buffer *old_buffer;
5012 struct text_pos pos;
5013 int i, width, height;
5014 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5015 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5016 int count = SPECPDL_INDEX ();
5018 specbind (Qinhibit_redisplay, Qt);
5020 GCPRO4 (string, parms, frame, timeout);
5022 CHECK_STRING (string);
5023 f = check_x_frame (frame);
5024 if (NILP (timeout))
5025 timeout = make_number (5);
5026 else
5027 CHECK_NATNUM (timeout);
5029 if (NILP (dx))
5030 dx = make_number (5);
5031 else
5032 CHECK_NUMBER (dx);
5034 if (NILP (dy))
5035 dy = make_number (-10);
5036 else
5037 CHECK_NUMBER (dy);
5039 if (NILP (last_show_tip_args))
5040 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5042 if (!NILP (tip_frame))
5044 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5045 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5046 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5048 if (EQ (frame, last_frame)
5049 && !NILP (Fequal (last_string, string))
5050 && !NILP (Fequal (last_parms, parms)))
5052 struct frame *f = XFRAME (tip_frame);
5054 /* Only DX and DY have changed. */
5055 if (!NILP (tip_timer))
5057 Lisp_Object timer = tip_timer;
5058 tip_timer = Qnil;
5059 call1 (Qcancel_timer, timer);
5062 BLOCK_INPUT;
5063 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
5064 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
5065 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5066 root_x, root_y);
5067 UNBLOCK_INPUT;
5068 goto start_timer;
5072 /* Hide a previous tip, if any. */
5073 Fx_hide_tip ();
5075 ASET (last_show_tip_args, 0, string);
5076 ASET (last_show_tip_args, 1, frame);
5077 ASET (last_show_tip_args, 2, parms);
5079 /* Add default values to frame parameters. */
5080 if (NILP (Fassq (Qname, parms)))
5081 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5082 if (NILP (Fassq (Qinternal_border_width, parms)))
5083 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5084 if (NILP (Fassq (Qborder_width, parms)))
5085 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5086 if (NILP (Fassq (Qborder_color, parms)))
5087 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5088 if (NILP (Fassq (Qbackground_color, parms)))
5089 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5090 parms);
5092 /* Create a frame for the tooltip, and record it in the global
5093 variable tip_frame. */
5094 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
5095 f = XFRAME (frame);
5097 /* Set up the frame's root window. */
5098 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5099 w->left_col = w->top_line = make_number (0);
5101 if (CONSP (Vx_max_tooltip_size)
5102 && INTEGERP (XCAR (Vx_max_tooltip_size))
5103 && XINT (XCAR (Vx_max_tooltip_size)) > 0
5104 && INTEGERP (XCDR (Vx_max_tooltip_size))
5105 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
5107 w->total_cols = XCAR (Vx_max_tooltip_size);
5108 w->total_lines = XCDR (Vx_max_tooltip_size);
5110 else
5112 w->total_cols = make_number (80);
5113 w->total_lines = make_number (40);
5116 FRAME_TOTAL_COLS (f) = XINT (w->total_cols);
5117 adjust_glyphs (f);
5118 w->pseudo_window_p = 1;
5120 /* Display the tooltip text in a temporary buffer. */
5121 old_buffer = current_buffer;
5122 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
5123 current_buffer->truncate_lines = Qnil;
5124 clear_glyph_matrix (w->desired_matrix);
5125 clear_glyph_matrix (w->current_matrix);
5126 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5127 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5129 /* Compute width and height of the tooltip. */
5130 width = height = 0;
5131 for (i = 0; i < w->desired_matrix->nrows; ++i)
5133 struct glyph_row *row = &w->desired_matrix->rows[i];
5134 struct glyph *last;
5135 int row_width;
5137 /* Stop at the first empty row at the end. */
5138 if (!row->enabled_p || !row->displays_text_p)
5139 break;
5141 /* Let the row go over the full width of the frame. */
5142 row->full_width_p = 1;
5144 /* There's a glyph at the end of rows that is used to place
5145 the cursor there. Don't include the width of this glyph. */
5146 if (row->used[TEXT_AREA])
5148 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5149 row_width = row->pixel_width - last->pixel_width;
5151 else
5152 row_width = row->pixel_width;
5154 height += row->height;
5155 width = max (width, row_width);
5158 /* Add the frame's internal border to the width and height the X
5159 window should have. */
5160 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5161 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5163 /* Move the tooltip window where the mouse pointer is. Resize and
5164 show it. */
5165 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5167 BLOCK_INPUT;
5168 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5169 root_x, root_y, width, height);
5170 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5171 UNBLOCK_INPUT;
5173 /* Draw into the window. */
5174 w->must_be_updated_p = 1;
5175 update_single_window (w, 1);
5177 /* Restore original current buffer. */
5178 set_buffer_internal_1 (old_buffer);
5179 windows_or_buffers_changed = old_windows_or_buffers_changed;
5181 start_timer:
5182 /* Let the tip disappear after timeout seconds. */
5183 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5184 intern ("x-hide-tip"));
5186 UNGCPRO;
5187 return unbind_to (count, Qnil);
5191 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5192 doc: /* Hide the current tooltip window, if there is any.
5193 Value is t if tooltip was open, nil otherwise. */)
5196 int count;
5197 Lisp_Object deleted, frame, timer;
5198 struct gcpro gcpro1, gcpro2;
5200 /* Return quickly if nothing to do. */
5201 if (NILP (tip_timer) && NILP (tip_frame))
5202 return Qnil;
5204 frame = tip_frame;
5205 timer = tip_timer;
5206 GCPRO2 (frame, timer);
5207 tip_frame = tip_timer = deleted = Qnil;
5209 count = SPECPDL_INDEX ();
5210 specbind (Qinhibit_redisplay, Qt);
5211 specbind (Qinhibit_quit, Qt);
5213 if (!NILP (timer))
5214 call1 (Qcancel_timer, timer);
5216 if (FRAMEP (frame))
5218 Fdelete_frame (frame, Qnil);
5219 deleted = Qt;
5221 #ifdef USE_LUCID
5222 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5223 redisplay procedure is not called when a tip frame over menu
5224 items is unmapped. Redisplay the menu manually... */
5226 struct frame *f = SELECTED_FRAME ();
5227 Widget w = f->output_data.x->menubar_widget;
5228 extern void xlwmenu_redisplay P_ ((Widget));
5230 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
5231 && w != NULL)
5233 BLOCK_INPUT;
5234 xlwmenu_redisplay (w);
5235 UNBLOCK_INPUT;
5238 #endif /* USE_LUCID */
5241 UNGCPRO;
5242 return unbind_to (count, deleted);
5247 /***********************************************************************
5248 File selection dialog
5249 ***********************************************************************/
5251 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5252 Sx_uses_old_gtk_dialog,
5253 0, 0, 0,
5254 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5257 #ifdef USE_GTK
5258 extern int use_dialog_box;
5259 extern int use_file_dialog;
5261 if (use_dialog_box
5262 && use_file_dialog
5263 && have_menus_p ()
5264 && xg_uses_old_file_dialog ())
5265 return Qt;
5266 #endif
5267 return Qnil;
5271 #ifdef USE_MOTIF
5272 /* Callback for "OK" and "Cancel" on file selection dialog. */
5274 static void
5275 file_dialog_cb (widget, client_data, call_data)
5276 Widget widget;
5277 XtPointer call_data, client_data;
5279 int *result = (int *) client_data;
5280 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
5281 *result = cb->reason;
5285 /* Callback for unmapping a file selection dialog. This is used to
5286 capture the case where a dialog is closed via a window manager's
5287 closer button, for example. Using a XmNdestroyCallback didn't work
5288 in this case. */
5290 static void
5291 file_dialog_unmap_cb (widget, client_data, call_data)
5292 Widget widget;
5293 XtPointer call_data, client_data;
5295 int *result = (int *) client_data;
5296 *result = XmCR_CANCEL;
5299 static Lisp_Object
5300 clean_up_file_dialog (arg)
5301 Lisp_Object arg;
5303 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
5304 Widget dialog = (Widget) p->pointer;
5306 /* Clean up. */
5307 BLOCK_INPUT;
5308 XtUnmanageChild (dialog);
5309 XtDestroyWidget (dialog);
5310 x_menu_set_in_use (0);
5311 UNBLOCK_INPUT;
5313 return Qnil;
5317 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5318 doc: /* Read file name, prompting with PROMPT in directory DIR.
5319 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5320 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5321 or directory must exist. ONLY-DIR-P is ignored." */)
5322 (prompt, dir, default_filename, mustmatch, only_dir_p)
5323 Lisp_Object prompt, dir, default_filename, mustmatch, only_dir_p;
5325 int result;
5326 struct frame *f = SELECTED_FRAME ();
5327 Lisp_Object file = Qnil;
5328 Widget dialog, text, help;
5329 Arg al[10];
5330 int ac = 0;
5331 extern XtAppContext Xt_app_con;
5332 XmString dir_xmstring, pattern_xmstring;
5333 int count = SPECPDL_INDEX ();
5334 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5336 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5338 if (popup_activated ())
5339 error ("Trying to use a menu from within a menu-entry");
5341 CHECK_STRING (prompt);
5342 CHECK_STRING (dir);
5344 /* Prevent redisplay. */
5345 specbind (Qinhibit_redisplay, Qt);
5347 BLOCK_INPUT;
5349 /* Create the dialog with PROMPT as title, using DIR as initial
5350 directory and using "*" as pattern. */
5351 dir = Fexpand_file_name (dir, Qnil);
5352 dir_xmstring = XmStringCreateLocalized (SDATA (dir));
5353 pattern_xmstring = XmStringCreateLocalized ("*");
5355 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5356 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5357 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5358 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5359 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5360 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5361 "fsb", al, ac);
5362 XmStringFree (dir_xmstring);
5363 XmStringFree (pattern_xmstring);
5365 /* Add callbacks for OK and Cancel. */
5366 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5367 (XtPointer) &result);
5368 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5369 (XtPointer) &result);
5370 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5371 (XtPointer) &result);
5373 /* Remove the help button since we can't display help. */
5374 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5375 XtUnmanageChild (help);
5377 /* Mark OK button as default. */
5378 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5379 XmNshowAsDefault, True, NULL);
5381 /* If MUSTMATCH is non-nil, disable the file entry field of the
5382 dialog, so that the user must select a file from the files list
5383 box. We can't remove it because we wouldn't have a way to get at
5384 the result file name, then. */
5385 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5386 if (!NILP (mustmatch))
5388 Widget label;
5389 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5390 XtSetSensitive (text, False);
5391 XtSetSensitive (label, False);
5394 /* Manage the dialog, so that list boxes get filled. */
5395 XtManageChild (dialog);
5397 if (STRINGP (default_filename))
5399 XmString default_xmstring;
5400 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5401 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5403 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5404 XmTextFieldReplace (wtext, 0, last_pos,
5405 (SDATA (Ffile_name_nondirectory (default_filename))));
5407 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5408 must include the path for this to work. */
5410 default_xmstring = XmStringCreateLocalized (SDATA (default_filename));
5412 if (XmListItemExists (list, default_xmstring))
5414 int item_pos = XmListItemPos (list, default_xmstring);
5415 /* Select the item and scroll it into view. */
5416 XmListSelectPos (list, item_pos, True);
5417 XmListSetPos (list, item_pos);
5420 XmStringFree (default_xmstring);
5423 record_unwind_protect (clean_up_file_dialog, make_save_value (dialog, 0));
5425 /* Process events until the user presses Cancel or OK. */
5426 x_menu_set_in_use (1);
5427 result = 0;
5428 while (result == 0)
5430 XEvent event;
5431 x_menu_wait_for_event (0);
5432 XtAppNextEvent (Xt_app_con, &event);
5433 if (event.type == KeyPress
5434 && FRAME_X_DISPLAY (f) == event.xkey.display)
5436 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5438 /* Pop down on C-g. */
5439 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5440 XtUnmanageChild (dialog);
5443 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5446 /* Get the result. */
5447 if (result == XmCR_OK)
5449 XmString text;
5450 String data;
5452 XtVaGetValues (dialog, XmNtextString, &text, NULL);
5453 XmStringGetLtoR (text, XmFONTLIST_DEFAULT_TAG, &data);
5454 XmStringFree (text);
5455 file = build_string (data);
5456 XtFree (data);
5458 else
5459 file = Qnil;
5461 UNBLOCK_INPUT;
5462 UNGCPRO;
5464 /* Make "Cancel" equivalent to C-g. */
5465 if (NILP (file))
5466 Fsignal (Qquit, Qnil);
5468 return unbind_to (count, file);
5471 #endif /* USE_MOTIF */
5473 #ifdef USE_GTK
5475 static Lisp_Object
5476 clean_up_dialog (arg)
5477 Lisp_Object arg;
5479 x_menu_set_in_use (0);
5481 return Qnil;
5484 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5485 doc: /* Read file name, prompting with PROMPT in directory DIR.
5486 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5487 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5488 or directory must exist. If ONLY-DIR-P is non-nil, the user can only select
5489 directories. */)
5490 (prompt, dir, default_filename, mustmatch, only_dir_p)
5491 Lisp_Object prompt, dir, default_filename, mustmatch, only_dir_p;
5493 FRAME_PTR f = SELECTED_FRAME ();
5494 char *fn;
5495 Lisp_Object file = Qnil;
5496 int count = SPECPDL_INDEX ();
5497 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5498 char *cdef_file;
5500 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5502 if (popup_activated ())
5503 error ("Trying to use a menu from within a menu-entry");
5505 CHECK_STRING (prompt);
5506 CHECK_STRING (dir);
5508 /* Prevent redisplay. */
5509 specbind (Qinhibit_redisplay, Qt);
5510 record_unwind_protect (clean_up_dialog, Qnil);
5512 BLOCK_INPUT;
5514 if (STRINGP (default_filename))
5515 cdef_file = SDATA (default_filename);
5516 else
5517 cdef_file = SDATA (dir);
5519 fn = xg_get_file_name (f, SDATA (prompt), cdef_file,
5520 ! NILP (mustmatch),
5521 ! NILP (only_dir_p));
5523 if (fn)
5525 file = build_string (fn);
5526 xfree (fn);
5529 UNBLOCK_INPUT;
5530 UNGCPRO;
5532 /* Make "Cancel" equivalent to C-g. */
5533 if (NILP (file))
5534 Fsignal (Qquit, Qnil);
5536 return unbind_to (count, file);
5539 #endif /* USE_GTK */
5542 /***********************************************************************
5543 Keyboard
5544 ***********************************************************************/
5546 #ifdef HAVE_XKBGETKEYBOARD
5547 #include <X11/XKBlib.h>
5548 #include <X11/keysym.h>
5549 #endif
5551 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
5552 Sx_backspace_delete_keys_p, 0, 1, 0,
5553 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
5554 FRAME nil means use the selected frame.
5555 Value is t if we know that both keys are present, and are mapped to the
5556 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
5557 present and mapped to the usual X keysyms. */)
5558 (frame)
5559 Lisp_Object frame;
5561 #ifdef HAVE_XKBGETKEYBOARD
5562 XkbDescPtr kb;
5563 struct frame *f = check_x_frame (frame);
5564 Display *dpy = FRAME_X_DISPLAY (f);
5565 Lisp_Object have_keys;
5566 int major, minor, op, event, error;
5568 BLOCK_INPUT;
5570 /* Check library version in case we're dynamically linked. */
5571 major = XkbMajorVersion;
5572 minor = XkbMinorVersion;
5573 if (!XkbLibraryVersion (&major, &minor))
5575 UNBLOCK_INPUT;
5576 return Qlambda;
5579 /* Check that the server supports XKB. */
5580 major = XkbMajorVersion;
5581 minor = XkbMinorVersion;
5582 if (!XkbQueryExtension (dpy, &op, &event, &error, &major, &minor))
5584 UNBLOCK_INPUT;
5585 return Qlambda;
5588 /* In this code we check that the keyboard has physical keys with names
5589 that start with BKSP (Backspace) and DELE (Delete), and that they
5590 generate keysym XK_BackSpace and XK_Delete respectively.
5591 This function is used to test if normal-erase-is-backspace should be
5592 turned on.
5593 An alternative approach would be to just check if XK_BackSpace and
5594 XK_Delete are mapped to any key. But if any of those are mapped to
5595 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
5596 user doesn't know about it, it is better to return false here.
5597 It is more obvious to the user what to do if she/he has two keys
5598 clearly marked with names/symbols and one key does something not
5599 expected (i.e. she/he then tries the other).
5600 The cases where Backspace/Delete is mapped to some other key combination
5601 are rare, and in those cases, normal-erase-is-backspace can be turned on
5602 manually. */
5604 have_keys = Qnil;
5605 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
5606 if (kb)
5608 int delete_keycode = 0, backspace_keycode = 0, i;
5610 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
5612 for (i = kb->min_key_code;
5613 (i < kb->max_key_code
5614 && (delete_keycode == 0 || backspace_keycode == 0));
5615 ++i)
5617 /* The XKB symbolic key names can be seen most easily in
5618 the PS file generated by `xkbprint -label name
5619 $DISPLAY'. */
5620 if (bcmp ("DELE", kb->names->keys[i].name, 4) == 0)
5621 delete_keycode = i;
5622 else if (bcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
5623 backspace_keycode = i;
5626 XkbFreeNames (kb, 0, True);
5629 XkbFreeClientMap (kb, 0, True);
5631 if (delete_keycode
5632 && backspace_keycode
5633 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
5634 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
5635 have_keys = Qt;
5637 UNBLOCK_INPUT;
5638 return have_keys;
5639 #else /* not HAVE_XKBGETKEYBOARD */
5640 return Qlambda;
5641 #endif /* not HAVE_XKBGETKEYBOARD */
5646 /***********************************************************************
5647 Initialization
5648 ***********************************************************************/
5650 /* Keep this list in the same order as frame_parms in frame.c.
5651 Use 0 for unsupported frame parameters. */
5653 frame_parm_handler x_frame_parm_handlers[] =
5655 x_set_autoraise,
5656 x_set_autolower,
5657 x_set_background_color,
5658 x_set_border_color,
5659 x_set_border_width,
5660 x_set_cursor_color,
5661 x_set_cursor_type,
5662 x_set_font,
5663 x_set_foreground_color,
5664 x_set_icon_name,
5665 x_set_icon_type,
5666 x_set_internal_border_width,
5667 x_set_menu_bar_lines,
5668 x_set_mouse_color,
5669 x_explicitly_set_name,
5670 x_set_scroll_bar_width,
5671 x_set_title,
5672 x_set_unsplittable,
5673 x_set_vertical_scroll_bars,
5674 x_set_visibility,
5675 x_set_tool_bar_lines,
5676 x_set_scroll_bar_foreground,
5677 x_set_scroll_bar_background,
5678 x_set_screen_gamma,
5679 x_set_line_spacing,
5680 x_set_fringe_width,
5681 x_set_fringe_width,
5682 x_set_wait_for_wm,
5683 x_set_fullscreen,
5686 void
5687 syms_of_xfns ()
5689 /* This is zero if not using X windows. */
5690 x_in_use = 0;
5692 /* The section below is built by the lisp expression at the top of the file,
5693 just above where these variables are declared. */
5694 /*&&& init symbols here &&&*/
5695 Qnone = intern ("none");
5696 staticpro (&Qnone);
5697 Qsuppress_icon = intern ("suppress-icon");
5698 staticpro (&Qsuppress_icon);
5699 Qundefined_color = intern ("undefined-color");
5700 staticpro (&Qundefined_color);
5701 Qcompound_text = intern ("compound-text");
5702 staticpro (&Qcompound_text);
5703 Qcancel_timer = intern ("cancel-timer");
5704 staticpro (&Qcancel_timer);
5705 /* This is the end of symbol initialization. */
5707 /* Text property `display' should be nonsticky by default. */
5708 Vtext_property_default_nonsticky
5709 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
5712 Fput (Qundefined_color, Qerror_conditions,
5713 Fcons (Qundefined_color, Fcons (Qerror, Qnil)));
5714 Fput (Qundefined_color, Qerror_message,
5715 build_string ("Undefined color"));
5717 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
5718 doc: /* The shape of the pointer when over text.
5719 Changing the value does not affect existing frames
5720 unless you set the mouse color. */);
5721 Vx_pointer_shape = Qnil;
5723 #if 0 /* This doesn't really do anything. */
5724 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape,
5725 doc: /* The shape of the pointer when not over text.
5726 This variable takes effect when you create a new frame
5727 or when you set the mouse color. */);
5728 #endif
5729 Vx_nontext_pointer_shape = Qnil;
5731 DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape,
5732 doc: /* The shape of the pointer when Emacs is busy.
5733 This variable takes effect when you create a new frame
5734 or when you set the mouse color. */);
5735 Vx_hourglass_pointer_shape = Qnil;
5737 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p,
5738 doc: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
5739 display_hourglass_p = 1;
5741 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay,
5742 doc: /* *Seconds to wait before displaying an hourglass pointer.
5743 Value must be an integer or float. */);
5744 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
5746 #if 0 /* This doesn't really do anything. */
5747 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape,
5748 doc: /* The shape of the pointer when over the mode line.
5749 This variable takes effect when you create a new frame
5750 or when you set the mouse color. */);
5751 #endif
5752 Vx_mode_pointer_shape = Qnil;
5754 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
5755 &Vx_sensitive_text_pointer_shape,
5756 doc: /* The shape of the pointer when over mouse-sensitive text.
5757 This variable takes effect when you create a new frame
5758 or when you set the mouse color. */);
5759 Vx_sensitive_text_pointer_shape = Qnil;
5761 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
5762 &Vx_window_horizontal_drag_shape,
5763 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
5764 This variable takes effect when you create a new frame
5765 or when you set the mouse color. */);
5766 Vx_window_horizontal_drag_shape = Qnil;
5768 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
5769 doc: /* A string indicating the foreground color of the cursor box. */);
5770 Vx_cursor_fore_pixel = Qnil;
5772 DEFVAR_LISP ("x-max-tooltip-size", &Vx_max_tooltip_size,
5773 doc: /* Maximum size for tooltips. Value is a pair (COLUMNS . ROWS).
5774 Text larger than this is clipped. */);
5775 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
5777 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
5778 doc: /* Non-nil if no X window manager is in use.
5779 Emacs doesn't try to figure this out; this is always nil
5780 unless you set it to something else. */);
5781 /* We don't have any way to find this out, so set it to nil
5782 and maybe the user would like to set it to t. */
5783 Vx_no_window_manager = Qnil;
5785 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
5786 &Vx_pixel_size_width_font_regexp,
5787 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
5789 Since Emacs gets width of a font matching with this regexp from
5790 PIXEL_SIZE field of the name, font finding mechanism gets faster for
5791 such a font. This is especially effective for such large fonts as
5792 Chinese, Japanese, and Korean. */);
5793 Vx_pixel_size_width_font_regexp = Qnil;
5795 /* This is not ifdef:ed, so other builds than GTK can customize it. */
5796 DEFVAR_BOOL ("x-use-old-gtk-file-dialog", &x_use_old_gtk_file_dialog,
5797 doc: /* *Non-nil means prompt with the old GTK file selection dialog.
5798 If nil or if the file selection dialog is not available, the new GTK file
5799 chooser is used instead. To turn off all file dialogs set the
5800 variable `use-file-dialog'. */);
5801 x_use_old_gtk_file_dialog = 0;
5803 DEFVAR_BOOL ("x-gtk-show-hidden-files", &x_gtk_show_hidden_files,
5804 doc: /* *If non-nil, the GTK file chooser will by default show hidden files.
5805 Note that this is just the default, there is a toggle button on the file
5806 chooser to show or not show hidden files on a case by case basis. */);
5807 x_gtk_show_hidden_files = 0;
5809 Fprovide (intern ("x"), Qnil);
5811 #ifdef USE_X_TOOLKIT
5812 Fprovide (intern ("x-toolkit"), Qnil);
5813 #ifdef USE_MOTIF
5814 Fprovide (intern ("motif"), Qnil);
5816 DEFVAR_LISP ("motif-version-string", &Vmotif_version_string,
5817 doc: /* Version info for LessTif/Motif. */);
5818 Vmotif_version_string = build_string (XmVERSION_STRING);
5819 #endif /* USE_MOTIF */
5820 #endif /* USE_X_TOOLKIT */
5822 #ifdef USE_GTK
5823 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
5824 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
5825 But for a user it is a toolkit for X, and indeed, configure
5826 accepts --with-x-toolkit=gtk. */
5827 Fprovide (intern ("x-toolkit"), Qnil);
5828 Fprovide (intern ("gtk"), Qnil);
5830 DEFVAR_LISP ("gtk-version-string", &Vgtk_version_string,
5831 doc: /* Version info for GTK+. */);
5833 char gtk_version[40];
5834 g_snprintf (gtk_version, sizeof (gtk_version), "%u.%u.%u",
5835 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
5836 Vgtk_version_string = build_string (gtk_version);
5838 #endif /* USE_GTK */
5840 /* X window properties. */
5841 defsubr (&Sx_change_window_property);
5842 defsubr (&Sx_delete_window_property);
5843 defsubr (&Sx_window_property);
5845 defsubr (&Sxw_display_color_p);
5846 defsubr (&Sx_display_grayscale_p);
5847 defsubr (&Sxw_color_defined_p);
5848 defsubr (&Sxw_color_values);
5849 defsubr (&Sx_server_max_request_size);
5850 defsubr (&Sx_server_vendor);
5851 defsubr (&Sx_server_version);
5852 defsubr (&Sx_display_pixel_width);
5853 defsubr (&Sx_display_pixel_height);
5854 defsubr (&Sx_display_mm_width);
5855 defsubr (&Sx_display_mm_height);
5856 defsubr (&Sx_display_screens);
5857 defsubr (&Sx_display_planes);
5858 defsubr (&Sx_display_color_cells);
5859 defsubr (&Sx_display_visual_class);
5860 defsubr (&Sx_display_backing_store);
5861 defsubr (&Sx_display_save_under);
5862 defsubr (&Sx_create_frame);
5863 defsubr (&Sx_open_connection);
5864 defsubr (&Sx_close_connection);
5865 defsubr (&Sx_display_list);
5866 defsubr (&Sx_synchronize);
5867 defsubr (&Sx_focus_frame);
5868 defsubr (&Sx_backspace_delete_keys_p);
5870 /* Setting callback functions for fontset handler. */
5871 get_font_info_func = x_get_font_info;
5873 #if 0 /* This function pointer doesn't seem to be used anywhere.
5874 And the pointer assigned has the wrong type, anyway. */
5875 list_fonts_func = x_list_fonts;
5876 #endif
5878 load_font_func = x_load_font;
5879 find_ccl_program_func = x_find_ccl_program;
5880 query_font_func = x_query_font;
5881 set_frame_fontset_func = x_set_font;
5882 check_window_system_func = check_x;
5884 hourglass_atimer = NULL;
5885 hourglass_shown_p = 0;
5887 defsubr (&Sx_show_tip);
5888 defsubr (&Sx_hide_tip);
5889 tip_timer = Qnil;
5890 staticpro (&tip_timer);
5891 tip_frame = Qnil;
5892 staticpro (&tip_frame);
5894 last_show_tip_args = Qnil;
5895 staticpro (&last_show_tip_args);
5897 defsubr (&Sx_uses_old_gtk_dialog);
5898 #if defined (USE_MOTIF) || defined (USE_GTK)
5899 defsubr (&Sx_file_dialog);
5900 #endif
5903 #endif /* HAVE_X_WINDOWS */
5905 /* arch-tag: 55040d02-5485-4d58-8b22-95a7a05f3288
5906 (do not change this comment) */