Johan Bockg� <bojohan at gnu.org>
[emacs.git] / src / xfns.c
blobf0cb26b72b4b94efe0823185fe290e11c4ba6520
1 /* Functions for the X window system.
2 Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, 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_gtk_use_old_file_dialog;
157 /* If non-zero, by default show hidden files in the GTK file chooser. */
159 int x_gtk_show_hidden_files;
161 /* If non-zero, don't show additional help text in the GTK file chooser. */
163 int x_gtk_file_dialog_help_text;
165 /* If non-zero, don't collapse to tool bar when it is detached. */
167 int x_gtk_whole_detached_tool_bar;
169 /* The background and shape of the mouse pointer, and shape when not
170 over text or in the modeline. */
172 Lisp_Object Vx_pointer_shape, Vx_nontext_pointer_shape, Vx_mode_pointer_shape;
173 Lisp_Object Vx_hourglass_pointer_shape;
175 /* The shape when over mouse-sensitive text. */
177 Lisp_Object Vx_sensitive_text_pointer_shape;
179 /* If non-nil, the pointer shape to indicate that windows can be
180 dragged horizontally. */
182 Lisp_Object Vx_window_horizontal_drag_shape;
184 /* Color of chars displayed in cursor box. */
186 Lisp_Object Vx_cursor_fore_pixel;
188 /* Nonzero if using X. */
190 static int x_in_use;
192 /* Non nil if no window manager is in use. */
194 Lisp_Object Vx_no_window_manager;
196 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
198 Lisp_Object Vx_pixel_size_width_font_regexp;
200 Lisp_Object Qnone;
201 Lisp_Object Qsuppress_icon;
202 Lisp_Object Qundefined_color;
203 Lisp_Object Qcompound_text, Qcancel_timer;
205 /* In dispnew.c */
207 extern Lisp_Object Vwindow_system_version;
209 /* The below are defined in frame.c. */
211 #if GLYPH_DEBUG
212 int image_cache_refcount, dpyinfo_refcount;
213 #endif
217 /* Error if we are not connected to X. */
219 void
220 check_x ()
222 if (! x_in_use)
223 error ("X windows are not in use or not initialized");
226 /* Nonzero if we can use mouse menus.
227 You should not call this unless HAVE_MENUS is defined. */
230 have_menus_p ()
232 return x_in_use;
235 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
236 and checking validity for X. */
238 FRAME_PTR
239 check_x_frame (frame)
240 Lisp_Object frame;
242 FRAME_PTR f;
244 if (NILP (frame))
245 frame = selected_frame;
246 CHECK_LIVE_FRAME (frame);
247 f = XFRAME (frame);
248 if (! FRAME_X_P (f))
249 error ("Non-X frame used");
250 return f;
253 /* Let the user specify an X display with a frame.
254 nil stands for the selected frame--or, if that is not an X frame,
255 the first X display on the list. */
257 struct x_display_info *
258 check_x_display_info (frame)
259 Lisp_Object frame;
261 struct x_display_info *dpyinfo = NULL;
263 if (NILP (frame))
265 struct frame *sf = XFRAME (selected_frame);
267 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
268 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
269 else if (x_display_list != 0)
270 dpyinfo = x_display_list;
271 else
272 error ("X windows are not in use or not initialized");
274 else if (STRINGP (frame))
275 dpyinfo = x_display_info_for_name (frame);
276 else
278 FRAME_PTR f = check_x_frame (frame);
279 dpyinfo = FRAME_X_DISPLAY_INFO (f);
282 return dpyinfo;
286 /* Return the Emacs frame-object corresponding to an X window.
287 It could be the frame's main window or an icon window. */
289 /* This function can be called during GC, so use GC_xxx type test macros. */
291 struct frame *
292 x_window_to_frame (dpyinfo, wdesc)
293 struct x_display_info *dpyinfo;
294 int wdesc;
296 Lisp_Object tail, frame;
297 struct frame *f;
299 if (wdesc == None) return 0;
301 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
303 frame = XCAR (tail);
304 if (!GC_FRAMEP (frame))
305 continue;
306 f = XFRAME (frame);
307 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
308 continue;
309 if (f->output_data.x->hourglass_window == wdesc)
310 return f;
311 #ifdef USE_X_TOOLKIT
312 if ((f->output_data.x->edit_widget
313 && XtWindow (f->output_data.x->edit_widget) == wdesc)
314 /* A tooltip frame? */
315 || (!f->output_data.x->edit_widget
316 && FRAME_X_WINDOW (f) == wdesc)
317 || f->output_data.x->icon_desc == wdesc)
318 return f;
319 #else /* not USE_X_TOOLKIT */
320 #ifdef USE_GTK
321 if (f->output_data.x->edit_widget)
323 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
324 struct x_output *x = f->output_data.x;
325 if (gwdesc != 0 && gwdesc == x->edit_widget)
326 return f;
328 #endif /* USE_GTK */
329 if (FRAME_X_WINDOW (f) == wdesc
330 || f->output_data.x->icon_desc == wdesc)
331 return f;
332 #endif /* not USE_X_TOOLKIT */
334 return 0;
337 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
338 /* Like x_window_to_frame but also compares the window with the widget's
339 windows. */
341 struct frame *
342 x_any_window_to_frame (dpyinfo, wdesc)
343 struct x_display_info *dpyinfo;
344 int wdesc;
346 Lisp_Object tail, frame;
347 struct frame *f, *found;
348 struct x_output *x;
350 if (wdesc == None) return NULL;
352 found = NULL;
353 for (tail = Vframe_list; GC_CONSP (tail) && !found; tail = XCDR (tail))
355 frame = XCAR (tail);
356 if (!GC_FRAMEP (frame))
357 continue;
359 f = XFRAME (frame);
360 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
362 /* This frame matches if the window is any of its widgets. */
363 x = f->output_data.x;
364 if (x->hourglass_window == wdesc)
365 found = f;
366 else if (x->widget)
368 #ifdef USE_GTK
369 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
370 if (gwdesc != 0
371 && (gwdesc == x->widget
372 || gwdesc == x->edit_widget
373 || gwdesc == x->vbox_widget
374 || gwdesc == x->menubar_widget))
375 found = f;
376 #else
377 if (wdesc == XtWindow (x->widget)
378 || wdesc == XtWindow (x->column_widget)
379 || wdesc == XtWindow (x->edit_widget))
380 found = f;
381 /* Match if the window is this frame's menubar. */
382 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
383 found = f;
384 #endif
386 else if (FRAME_X_WINDOW (f) == wdesc)
387 /* A tooltip frame. */
388 found = f;
392 return found;
395 /* Likewise, but exclude the menu bar widget. */
397 struct frame *
398 x_non_menubar_window_to_frame (dpyinfo, wdesc)
399 struct x_display_info *dpyinfo;
400 int wdesc;
402 Lisp_Object tail, frame;
403 struct frame *f;
404 struct x_output *x;
406 if (wdesc == None) return 0;
408 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
410 frame = XCAR (tail);
411 if (!GC_FRAMEP (frame))
412 continue;
413 f = XFRAME (frame);
414 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
415 continue;
416 x = f->output_data.x;
417 /* This frame matches if the window is any of its widgets. */
418 if (x->hourglass_window == wdesc)
419 return f;
420 else if (x->widget)
422 #ifdef USE_GTK
423 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
424 if (gwdesc != 0
425 && (gwdesc == x->widget
426 || gwdesc == x->edit_widget
427 || gwdesc == x->vbox_widget))
428 return f;
429 #else
430 if (wdesc == XtWindow (x->widget)
431 || wdesc == XtWindow (x->column_widget)
432 || wdesc == XtWindow (x->edit_widget))
433 return f;
434 #endif
436 else if (FRAME_X_WINDOW (f) == wdesc)
437 /* A tooltip frame. */
438 return f;
440 return 0;
443 /* Likewise, but consider only the menu bar widget. */
445 struct frame *
446 x_menubar_window_to_frame (dpyinfo, wdesc)
447 struct x_display_info *dpyinfo;
448 int wdesc;
450 Lisp_Object tail, frame;
451 struct frame *f;
452 struct x_output *x;
454 if (wdesc == None) return 0;
456 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
458 frame = XCAR (tail);
459 if (!GC_FRAMEP (frame))
460 continue;
461 f = XFRAME (frame);
462 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
463 continue;
464 x = f->output_data.x;
465 /* Match if the window is this frame's menubar. */
466 #ifdef USE_GTK
467 if (x->menubar_widget)
469 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
470 int found = 0;
472 BLOCK_INPUT;
473 if (gwdesc != 0
474 && (gwdesc == x->menubar_widget
475 || gtk_widget_get_parent (gwdesc) == x->menubar_widget))
476 found = 1;
477 UNBLOCK_INPUT;
478 if (found) return f;
480 #else
481 if (x->menubar_widget
482 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
483 return f;
484 #endif
486 return 0;
489 /* Return the frame whose principal (outermost) window is WDESC.
490 If WDESC is some other (smaller) window, we return 0. */
492 struct frame *
493 x_top_window_to_frame (dpyinfo, wdesc)
494 struct x_display_info *dpyinfo;
495 int wdesc;
497 Lisp_Object tail, frame;
498 struct frame *f;
499 struct x_output *x;
501 if (wdesc == None) return 0;
503 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
505 frame = XCAR (tail);
506 if (!GC_FRAMEP (frame))
507 continue;
508 f = XFRAME (frame);
509 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
510 continue;
511 x = f->output_data.x;
513 if (x->widget)
515 /* This frame matches if the window is its topmost widget. */
516 #ifdef USE_GTK
517 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
518 if (gwdesc == x->widget)
519 return f;
520 #else
521 if (wdesc == XtWindow (x->widget))
522 return f;
523 #if 0 /* I don't know why it did this,
524 but it seems logically wrong,
525 and it causes trouble for MapNotify events. */
526 /* Match if the window is this frame's menubar. */
527 if (x->menubar_widget
528 && wdesc == XtWindow (x->menubar_widget))
529 return f;
530 #endif
531 #endif
533 else if (FRAME_X_WINDOW (f) == wdesc)
534 /* Tooltip frame. */
535 return f;
537 return 0;
539 #endif /* USE_X_TOOLKIT || USE_GTK */
543 static Lisp_Object unwind_create_frame P_ ((Lisp_Object));
544 static Lisp_Object unwind_create_tip_frame P_ ((Lisp_Object));
546 void x_set_foreground_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
547 static void x_set_wait_for_wm P_ ((struct frame *, Lisp_Object, Lisp_Object));
548 void x_set_background_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
549 void x_set_mouse_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
550 void x_set_cursor_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
551 void x_set_border_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
552 void x_set_cursor_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
553 void x_set_icon_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
554 void x_set_icon_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
555 void x_explicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
556 void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
557 void x_set_title P_ ((struct frame *, Lisp_Object, Lisp_Object));
558 void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
559 void x_set_scroll_bar_foreground P_ ((struct frame *, Lisp_Object,
560 Lisp_Object));
561 void x_set_scroll_bar_background P_ ((struct frame *, Lisp_Object,
562 Lisp_Object));
563 static Lisp_Object x_default_scroll_bar_color_parameter P_ ((struct frame *,
564 Lisp_Object,
565 Lisp_Object,
566 char *, char *,
567 int));
570 /* Store the screen positions of frame F into XPTR and YPTR.
571 These are the positions of the containing window manager window,
572 not Emacs's own window. */
574 void
575 x_real_positions (f, xptr, yptr)
576 FRAME_PTR f;
577 int *xptr, *yptr;
579 int win_x, win_y, outer_x, outer_y;
580 int real_x = 0, real_y = 0;
581 int had_errors = 0;
582 Window win = f->output_data.x->parent_desc;
584 BLOCK_INPUT;
586 x_catch_errors (FRAME_X_DISPLAY (f));
588 if (win == FRAME_X_DISPLAY_INFO (f)->root_window)
589 win = FRAME_OUTER_WINDOW (f);
591 /* This loop traverses up the containment tree until we hit the root
592 window. Window managers may intersect many windows between our window
593 and the root window. The window we find just before the root window
594 should be the outer WM window. */
595 for (;;)
597 Window wm_window, rootw;
598 Window *tmp_children;
599 unsigned int tmp_nchildren;
600 int success;
602 success = XQueryTree (FRAME_X_DISPLAY (f), win, &rootw,
603 &wm_window, &tmp_children, &tmp_nchildren);
605 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
607 /* Don't free tmp_children if XQueryTree failed. */
608 if (! success)
609 break;
611 XFree ((char *) tmp_children);
613 if (wm_window == rootw || had_errors)
614 break;
616 win = wm_window;
619 if (! had_errors)
621 unsigned int ign;
622 Window child, rootw;
624 /* Get the real coordinates for the WM window upper left corner */
625 XGetGeometry (FRAME_X_DISPLAY (f), win,
626 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
628 /* Translate real coordinates to coordinates relative to our
629 window. For our window, the upper left corner is 0, 0.
630 Since the upper left corner of the WM window is outside
631 our window, win_x and win_y will be negative:
633 ------------------ ---> x
634 | title |
635 | ----------------- v y
636 | | our window
638 XTranslateCoordinates (FRAME_X_DISPLAY (f),
640 /* From-window, to-window. */
641 FRAME_X_DISPLAY_INFO (f)->root_window,
642 FRAME_X_WINDOW (f),
644 /* From-position, to-position. */
645 real_x, real_y, &win_x, &win_y,
647 /* Child of win. */
648 &child);
650 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
652 outer_x = win_x;
653 outer_y = win_y;
655 else
657 XTranslateCoordinates (FRAME_X_DISPLAY (f),
659 /* From-window, to-window. */
660 FRAME_X_DISPLAY_INFO (f)->root_window,
661 FRAME_OUTER_WINDOW (f),
663 /* From-position, to-position. */
664 real_x, real_y, &outer_x, &outer_y,
666 /* Child of win. */
667 &child);
670 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
673 x_uncatch_errors ();
675 UNBLOCK_INPUT;
677 if (had_errors) return;
679 f->x_pixels_diff = -win_x;
680 f->y_pixels_diff = -win_y;
682 FRAME_X_OUTPUT (f)->x_pixels_outer_diff = -outer_x;
683 FRAME_X_OUTPUT (f)->y_pixels_outer_diff = -outer_y;
685 *xptr = real_x;
686 *yptr = real_y;
692 /* Gamma-correct COLOR on frame F. */
694 void
695 gamma_correct (f, color)
696 struct frame *f;
697 XColor *color;
699 if (f->gamma)
701 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
702 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
703 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
708 /* Decide if color named COLOR_NAME is valid for use on frame F. If
709 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
710 allocate the color. Value is zero if COLOR_NAME is invalid, or
711 no color could be allocated. */
714 x_defined_color (f, color_name, color, alloc_p)
715 struct frame *f;
716 char *color_name;
717 XColor *color;
718 int alloc_p;
720 int success_p;
721 Display *dpy = FRAME_X_DISPLAY (f);
722 Colormap cmap = FRAME_X_COLORMAP (f);
724 BLOCK_INPUT;
725 success_p = XParseColor (dpy, cmap, color_name, color);
726 if (success_p && alloc_p)
727 success_p = x_alloc_nearest_color (f, cmap, color);
728 UNBLOCK_INPUT;
730 return success_p;
734 /* Return the pixel color value for color COLOR_NAME on frame F. If F
735 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
736 Signal an error if color can't be allocated. */
739 x_decode_color (f, color_name, mono_color)
740 FRAME_PTR f;
741 Lisp_Object color_name;
742 int mono_color;
744 XColor cdef;
746 CHECK_STRING (color_name);
748 #if 0 /* Don't do this. It's wrong when we're not using the default
749 colormap, it makes freeing difficult, and it's probably not
750 an important optimization. */
751 if (strcmp (SDATA (color_name), "black") == 0)
752 return BLACK_PIX_DEFAULT (f);
753 else if (strcmp (SDATA (color_name), "white") == 0)
754 return WHITE_PIX_DEFAULT (f);
755 #endif
757 /* Return MONO_COLOR for monochrome frames. */
758 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
759 return mono_color;
761 /* x_defined_color is responsible for coping with failures
762 by looking for a near-miss. */
763 if (x_defined_color (f, SDATA (color_name), &cdef, 1))
764 return cdef.pixel;
766 signal_error ("Undefined color", color_name);
771 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
772 the previous value of that parameter, NEW_VALUE is the new value.
773 See also the comment of wait_for_wm in struct x_output. */
775 static void
776 x_set_wait_for_wm (f, new_value, old_value)
777 struct frame *f;
778 Lisp_Object new_value, old_value;
780 f->output_data.x->wait_for_wm = !NILP (new_value);
783 #ifdef USE_GTK
785 /* Set icon from FILE for frame F. By using GTK functions the icon
786 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
789 xg_set_icon (f, file)
790 FRAME_PTR f;
791 Lisp_Object file;
793 int result = 0;
794 Lisp_Object found;
796 found = x_find_image_file (file);
798 if (! NILP (found))
800 GdkPixbuf *pixbuf;
801 GError *err = NULL;
802 char *filename = (char *) SDATA (found);
803 BLOCK_INPUT;
805 pixbuf = gdk_pixbuf_new_from_file (filename, &err);
807 if (pixbuf)
809 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
810 pixbuf);
811 g_object_unref (pixbuf);
813 result = 1;
815 else
816 g_error_free (err);
818 UNBLOCK_INPUT;
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 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
946 unsigned long mask_color = x->background_pixel;
948 /* Don't let pointers be invisible. */
949 if (mask_color == pixel)
951 x_free_colors (f, &pixel, 1);
952 pixel = x_copy_color (f, x->foreground_pixel);
955 unload_color (f, x->mouse_pixel);
956 x->mouse_pixel = pixel;
958 BLOCK_INPUT;
960 /* It's not okay to crash if the user selects a screwy cursor. */
961 x_catch_errors (dpy);
963 if (!NILP (Vx_pointer_shape))
965 CHECK_NUMBER (Vx_pointer_shape);
966 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
968 else
969 cursor = XCreateFontCursor (dpy, XC_xterm);
970 x_check_errors (dpy, "bad text pointer cursor: %s");
972 if (!NILP (Vx_nontext_pointer_shape))
974 CHECK_NUMBER (Vx_nontext_pointer_shape);
975 nontext_cursor
976 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
978 else
979 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
980 x_check_errors (dpy, "bad nontext pointer cursor: %s");
982 if (!NILP (Vx_hourglass_pointer_shape))
984 CHECK_NUMBER (Vx_hourglass_pointer_shape);
985 hourglass_cursor
986 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
988 else
989 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
990 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
992 if (!NILP (Vx_mode_pointer_shape))
994 CHECK_NUMBER (Vx_mode_pointer_shape);
995 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
997 else
998 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
999 x_check_errors (dpy, "bad modeline pointer cursor: %s");
1001 if (!NILP (Vx_sensitive_text_pointer_shape))
1003 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
1004 hand_cursor
1005 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
1007 else
1008 hand_cursor = XCreateFontCursor (dpy, XC_hand2);
1010 if (!NILP (Vx_window_horizontal_drag_shape))
1012 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
1013 horizontal_drag_cursor
1014 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
1016 else
1017 horizontal_drag_cursor
1018 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
1020 /* Check and report errors with the above calls. */
1021 x_check_errors (dpy, "can't set cursor shape: %s");
1022 x_uncatch_errors ();
1025 XColor fore_color, back_color;
1027 fore_color.pixel = x->mouse_pixel;
1028 x_query_color (f, &fore_color);
1029 back_color.pixel = mask_color;
1030 x_query_color (f, &back_color);
1032 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
1033 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
1034 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
1035 XRecolorCursor (dpy, hand_cursor, &fore_color, &back_color);
1036 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
1037 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
1040 if (FRAME_X_WINDOW (f) != 0)
1041 XDefineCursor (dpy, FRAME_X_WINDOW (f), cursor);
1043 if (cursor != x->text_cursor
1044 && x->text_cursor != 0)
1045 XFreeCursor (dpy, x->text_cursor);
1046 x->text_cursor = cursor;
1048 if (nontext_cursor != x->nontext_cursor
1049 && x->nontext_cursor != 0)
1050 XFreeCursor (dpy, x->nontext_cursor);
1051 x->nontext_cursor = nontext_cursor;
1053 if (hourglass_cursor != x->hourglass_cursor
1054 && x->hourglass_cursor != 0)
1055 XFreeCursor (dpy, x->hourglass_cursor);
1056 x->hourglass_cursor = hourglass_cursor;
1058 if (mode_cursor != x->modeline_cursor
1059 && x->modeline_cursor != 0)
1060 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
1061 x->modeline_cursor = mode_cursor;
1063 if (hand_cursor != x->hand_cursor
1064 && x->hand_cursor != 0)
1065 XFreeCursor (dpy, x->hand_cursor);
1066 x->hand_cursor = hand_cursor;
1068 if (horizontal_drag_cursor != x->horizontal_drag_cursor
1069 && x->horizontal_drag_cursor != 0)
1070 XFreeCursor (dpy, x->horizontal_drag_cursor);
1071 x->horizontal_drag_cursor = horizontal_drag_cursor;
1073 XFlush (dpy);
1074 UNBLOCK_INPUT;
1076 update_face_from_frame_parameter (f, Qmouse_color, arg);
1079 void
1080 x_set_cursor_color (f, arg, oldval)
1081 struct frame *f;
1082 Lisp_Object arg, oldval;
1084 unsigned long fore_pixel, pixel;
1085 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1086 struct x_output *x = f->output_data.x;
1088 if (!NILP (Vx_cursor_fore_pixel))
1090 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1091 WHITE_PIX_DEFAULT (f));
1092 fore_pixel_allocated_p = 1;
1094 else
1095 fore_pixel = x->background_pixel;
1097 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1098 pixel_allocated_p = 1;
1100 /* Make sure that the cursor color differs from the background color. */
1101 if (pixel == x->background_pixel)
1103 if (pixel_allocated_p)
1105 x_free_colors (f, &pixel, 1);
1106 pixel_allocated_p = 0;
1109 pixel = x->mouse_pixel;
1110 if (pixel == fore_pixel)
1112 if (fore_pixel_allocated_p)
1114 x_free_colors (f, &fore_pixel, 1);
1115 fore_pixel_allocated_p = 0;
1117 fore_pixel = x->background_pixel;
1121 unload_color (f, x->cursor_foreground_pixel);
1122 if (!fore_pixel_allocated_p)
1123 fore_pixel = x_copy_color (f, fore_pixel);
1124 x->cursor_foreground_pixel = fore_pixel;
1126 unload_color (f, x->cursor_pixel);
1127 if (!pixel_allocated_p)
1128 pixel = x_copy_color (f, pixel);
1129 x->cursor_pixel = pixel;
1131 if (FRAME_X_WINDOW (f) != 0)
1133 BLOCK_INPUT;
1134 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
1135 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
1136 UNBLOCK_INPUT;
1138 if (FRAME_VISIBLE_P (f))
1140 x_update_cursor (f, 0);
1141 x_update_cursor (f, 1);
1145 update_face_from_frame_parameter (f, Qcursor_color, arg);
1148 /* Set the border-color of frame F to pixel value PIX.
1149 Note that this does not fully take effect if done before
1150 F has an x-window. */
1152 void
1153 x_set_border_pixel (f, pix)
1154 struct frame *f;
1155 int pix;
1157 unload_color (f, f->output_data.x->border_pixel);
1158 f->output_data.x->border_pixel = pix;
1160 if (FRAME_X_WINDOW (f) != 0 && f->border_width > 0)
1162 BLOCK_INPUT;
1163 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1164 (unsigned long)pix);
1165 UNBLOCK_INPUT;
1167 if (FRAME_VISIBLE_P (f))
1168 redraw_frame (f);
1172 /* Set the border-color of frame F to value described by ARG.
1173 ARG can be a string naming a color.
1174 The border-color is used for the border that is drawn by the X server.
1175 Note that this does not fully take effect if done before
1176 F has an x-window; it must be redone when the window is created.
1178 Note: this is done in two routines because of the way X10 works.
1180 Note: under X11, this is normally the province of the window manager,
1181 and so emacs' border colors may be overridden. */
1183 void
1184 x_set_border_color (f, arg, oldval)
1185 struct frame *f;
1186 Lisp_Object arg, oldval;
1188 int pix;
1190 CHECK_STRING (arg);
1191 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1192 x_set_border_pixel (f, pix);
1193 update_face_from_frame_parameter (f, Qborder_color, arg);
1197 void
1198 x_set_cursor_type (f, arg, oldval)
1199 FRAME_PTR f;
1200 Lisp_Object arg, oldval;
1202 set_frame_cursor_types (f, arg);
1204 /* Make sure the cursor gets redrawn. */
1205 cursor_type_changed = 1;
1208 void
1209 x_set_icon_type (f, arg, oldval)
1210 struct frame *f;
1211 Lisp_Object arg, oldval;
1213 int result;
1215 if (STRINGP (arg))
1217 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1218 return;
1220 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1221 return;
1223 BLOCK_INPUT;
1224 if (NILP (arg))
1225 result = x_text_icon (f,
1226 (char *) SDATA ((!NILP (f->icon_name)
1227 ? f->icon_name
1228 : f->name)));
1229 else
1230 result = x_bitmap_icon (f, arg);
1232 if (result)
1234 UNBLOCK_INPUT;
1235 error ("No icon window available");
1238 XFlush (FRAME_X_DISPLAY (f));
1239 UNBLOCK_INPUT;
1242 void
1243 x_set_icon_name (f, arg, oldval)
1244 struct frame *f;
1245 Lisp_Object arg, oldval;
1247 int result;
1249 if (STRINGP (arg))
1251 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1252 return;
1254 else if (!NILP (arg) || NILP (oldval))
1255 return;
1257 f->icon_name = arg;
1259 if (f->output_data.x->icon_bitmap != 0)
1260 return;
1262 BLOCK_INPUT;
1264 result = x_text_icon (f,
1265 (char *) SDATA ((!NILP (f->icon_name)
1266 ? f->icon_name
1267 : !NILP (f->title)
1268 ? f->title
1269 : f->name)));
1271 if (result)
1273 UNBLOCK_INPUT;
1274 error ("No icon window available");
1277 XFlush (FRAME_X_DISPLAY (f));
1278 UNBLOCK_INPUT;
1282 void
1283 x_set_menu_bar_lines (f, value, oldval)
1284 struct frame *f;
1285 Lisp_Object value, oldval;
1287 int nlines;
1288 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1289 int olines = FRAME_MENU_BAR_LINES (f);
1290 #endif
1292 /* Right now, menu bars don't work properly in minibuf-only frames;
1293 most of the commands try to apply themselves to the minibuffer
1294 frame itself, and get an error because you can't switch buffers
1295 in or split the minibuffer window. */
1296 if (FRAME_MINIBUF_ONLY_P (f))
1297 return;
1299 if (INTEGERP (value))
1300 nlines = XINT (value);
1301 else
1302 nlines = 0;
1304 /* Make sure we redisplay all windows in this frame. */
1305 windows_or_buffers_changed++;
1307 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1308 FRAME_MENU_BAR_LINES (f) = 0;
1309 if (nlines)
1311 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1312 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1313 /* Make sure next redisplay shows the menu bar. */
1314 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1316 else
1318 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1319 free_frame_menubar (f);
1320 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1321 if (FRAME_X_P (f))
1322 f->output_data.x->menubar_widget = 0;
1324 #else /* not USE_X_TOOLKIT && not USE_GTK */
1325 FRAME_MENU_BAR_LINES (f) = nlines;
1326 change_window_heights (f->root_window, nlines - olines);
1327 #endif /* not USE_X_TOOLKIT */
1328 adjust_glyphs (f);
1332 /* Set the number of lines used for the tool bar of frame F to VALUE.
1333 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1334 is the old number of tool bar lines. This function changes the
1335 height of all windows on frame F to match the new tool bar height.
1336 The frame's height doesn't change. */
1338 void
1339 x_set_tool_bar_lines (f, value, oldval)
1340 struct frame *f;
1341 Lisp_Object value, oldval;
1343 int delta, nlines, root_height;
1344 Lisp_Object root_window;
1346 /* Treat tool bars like menu bars. */
1347 if (FRAME_MINIBUF_ONLY_P (f))
1348 return;
1350 /* Use VALUE only if an integer >= 0. */
1351 if (INTEGERP (value) && XINT (value) >= 0)
1352 nlines = XFASTINT (value);
1353 else
1354 nlines = 0;
1356 #ifdef USE_GTK
1357 FRAME_TOOL_BAR_LINES (f) = 0;
1358 if (nlines)
1360 FRAME_EXTERNAL_TOOL_BAR (f) = 1;
1361 if (FRAME_X_P (f) && f->output_data.x->toolbar_widget == 0)
1362 /* Make sure next redisplay shows the tool bar. */
1363 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1364 update_frame_tool_bar (f);
1366 else
1368 if (FRAME_EXTERNAL_TOOL_BAR (f))
1369 free_frame_tool_bar (f);
1370 FRAME_EXTERNAL_TOOL_BAR (f) = 0;
1373 return;
1374 #endif
1376 /* Make sure we redisplay all windows in this frame. */
1377 ++windows_or_buffers_changed;
1379 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1381 /* Don't resize the tool-bar to more than we have room for. */
1382 root_window = FRAME_ROOT_WINDOW (f);
1383 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1384 if (root_height - delta < 1)
1386 delta = root_height - 1;
1387 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1390 FRAME_TOOL_BAR_LINES (f) = nlines;
1391 change_window_heights (root_window, delta);
1392 adjust_glyphs (f);
1394 /* We also have to make sure that the internal border at the top of
1395 the frame, below the menu bar or tool bar, is redrawn when the
1396 tool bar disappears. This is so because the internal border is
1397 below the tool bar if one is displayed, but is below the menu bar
1398 if there isn't a tool bar. The tool bar draws into the area
1399 below the menu bar. */
1400 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1402 updating_frame = f;
1403 clear_frame ();
1404 clear_current_matrices (f);
1405 updating_frame = NULL;
1408 /* If the tool bar gets smaller, the internal border below it
1409 has to be cleared. It was formerly part of the display
1410 of the larger tool bar, and updating windows won't clear it. */
1411 if (delta < 0)
1413 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1414 int width = FRAME_PIXEL_WIDTH (f);
1415 int y = nlines * FRAME_LINE_HEIGHT (f);
1417 /* height can be zero here. */
1418 if (height > 0 && width > 0)
1420 BLOCK_INPUT;
1421 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1422 0, y, width, height, False);
1423 UNBLOCK_INPUT;
1426 if (WINDOWP (f->tool_bar_window))
1427 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1432 /* Set the foreground color for scroll bars on frame F to VALUE.
1433 VALUE should be a string, a color name. If it isn't a string or
1434 isn't a valid color name, do nothing. OLDVAL is the old value of
1435 the frame parameter. */
1437 void
1438 x_set_scroll_bar_foreground (f, value, oldval)
1439 struct frame *f;
1440 Lisp_Object value, oldval;
1442 unsigned long pixel;
1444 if (STRINGP (value))
1445 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
1446 else
1447 pixel = -1;
1449 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
1450 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
1452 f->output_data.x->scroll_bar_foreground_pixel = pixel;
1453 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1455 /* Remove all scroll bars because they have wrong colors. */
1456 if (condemn_scroll_bars_hook)
1457 (*condemn_scroll_bars_hook) (f);
1458 if (judge_scroll_bars_hook)
1459 (*judge_scroll_bars_hook) (f);
1461 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
1462 redraw_frame (f);
1467 /* Set the background color for scroll bars on frame F to VALUE VALUE
1468 should be a string, a color name. If it isn't a string or isn't a
1469 valid color name, do nothing. OLDVAL is the old value of the frame
1470 parameter. */
1472 void
1473 x_set_scroll_bar_background (f, value, oldval)
1474 struct frame *f;
1475 Lisp_Object value, oldval;
1477 unsigned long pixel;
1479 if (STRINGP (value))
1480 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
1481 else
1482 pixel = -1;
1484 if (f->output_data.x->scroll_bar_background_pixel != -1)
1485 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
1487 #ifdef USE_TOOLKIT_SCROLL_BARS
1488 /* Scrollbar shadow colors. */
1489 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
1491 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
1492 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
1494 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
1496 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
1497 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
1499 #endif /* USE_TOOLKIT_SCROLL_BARS */
1501 f->output_data.x->scroll_bar_background_pixel = pixel;
1502 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
1504 /* Remove all scroll bars because they have wrong colors. */
1505 if (condemn_scroll_bars_hook)
1506 (*condemn_scroll_bars_hook) (f);
1507 if (judge_scroll_bars_hook)
1508 (*judge_scroll_bars_hook) (f);
1510 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
1511 redraw_frame (f);
1516 /* Encode Lisp string STRING as a text in a format appropriate for
1517 XICCC (X Inter Client Communication Conventions).
1519 This can call Lisp code, so callers must GCPRO.
1521 If STRING contains only ASCII characters, do no conversion and
1522 return the string data of STRING. Otherwise, encode the text by
1523 CODING_SYSTEM, and return a newly allocated memory area which
1524 should be freed by `xfree' by a caller.
1526 SELECTIONP non-zero means the string is being encoded for an X
1527 selection, so it is safe to run pre-write conversions (which
1528 may run Lisp code).
1530 Store the byte length of resulting text in *TEXT_BYTES.
1532 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1533 which means that the `encoding' of the result can be `STRING'.
1534 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1535 the result should be `COMPOUND_TEXT'. */
1537 static unsigned char *
1538 x_encode_text (string, coding_system, selectionp, text_bytes, stringp, freep)
1539 Lisp_Object string, coding_system;
1540 int *text_bytes, *stringp;
1541 int selectionp;
1542 int *freep;
1544 unsigned char *str = SDATA (string);
1545 int chars = SCHARS (string);
1546 int bytes = SBYTES (string);
1547 int charset_info;
1548 int bufsize;
1549 unsigned char *buf;
1550 struct coding_system coding;
1551 extern Lisp_Object Qcompound_text_with_extensions;
1553 charset_info = find_charset_in_text (str, chars, bytes, NULL, Qnil);
1554 if (charset_info == 0)
1556 /* No multibyte character in OBJ. We need not encode it. */
1557 *text_bytes = bytes;
1558 *stringp = 1;
1559 *freep = 0;
1560 return str;
1563 setup_coding_system (coding_system, &coding);
1564 if (selectionp
1565 && SYMBOLP (coding.pre_write_conversion)
1566 && !NILP (Ffboundp (coding.pre_write_conversion)))
1568 struct gcpro gcpro1;
1569 /* We don't need to GCPRO string. */
1570 GCPRO1 (coding_system);
1571 string = run_pre_post_conversion_on_str (string, &coding, 1);
1572 UNGCPRO;
1573 str = SDATA (string);
1574 chars = SCHARS (string);
1575 bytes = SBYTES (string);
1577 coding.src_multibyte = 1;
1578 coding.dst_multibyte = 0;
1579 coding.mode |= CODING_MODE_LAST_BLOCK;
1580 if (coding.type == coding_type_iso2022)
1581 coding.flags |= CODING_FLAG_ISO_SAFE;
1582 /* We suppress producing escape sequences for composition. */
1583 coding.composing = COMPOSITION_DISABLED;
1584 bufsize = encoding_buffer_size (&coding, bytes);
1585 buf = (unsigned char *) xmalloc (bufsize);
1586 encode_coding (&coding, str, buf, bytes, bufsize);
1587 *text_bytes = coding.produced;
1588 *stringp = (charset_info == 1
1589 || (!EQ (coding_system, Qcompound_text)
1590 && !EQ (coding_system, Qcompound_text_with_extensions)));
1591 *freep = 1;
1592 return buf;
1596 /* Set the WM name to NAME for frame F. Also set the icon name.
1597 If the frame already has an icon name, use that, otherwise set the
1598 icon name to NAME. */
1600 static void
1601 x_set_name_internal (f, name)
1602 FRAME_PTR f;
1603 Lisp_Object name;
1605 if (FRAME_X_WINDOW (f))
1607 BLOCK_INPUT;
1608 #ifdef HAVE_X11R4
1610 XTextProperty text, icon;
1611 int bytes, stringp;
1612 int do_free_icon_value = 0, do_free_text_value = 0;
1613 Lisp_Object coding_system;
1614 #ifdef USE_GTK
1615 Lisp_Object encoded_name;
1616 struct gcpro gcpro1;
1618 /* As ENCODE_UTF_8 may cause GC and relocation of string data,
1619 we use it before x_encode_text that may return string data. */
1620 GCPRO1 (name);
1621 encoded_name = ENCODE_UTF_8 (name);
1622 UNGCPRO;
1623 #endif
1625 coding_system = Qcompound_text;
1626 /* Note: Encoding strategy
1628 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1629 text.encoding. But, there are non-internationalized window
1630 managers which don't support that encoding. So, if NAME
1631 contains only ASCII and 8859-1 characters, encode it by
1632 iso-latin-1, and use "STRING" in text.encoding hoping that
1633 such window managers at least analyze this format correctly,
1634 i.e. treat 8-bit bytes as 8859-1 characters.
1636 We may also be able to use "UTF8_STRING" in text.encoding
1637 in the future which can encode all Unicode characters.
1638 But, for the moment, there's no way to know that the
1639 current window manager supports it or not. */
1640 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1641 &do_free_text_value);
1642 text.encoding = (stringp ? XA_STRING
1643 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1644 text.format = 8;
1645 text.nitems = bytes;
1647 if (!STRINGP (f->icon_name))
1649 icon = text;
1651 else
1653 /* See the above comment "Note: Encoding strategy". */
1654 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1655 &bytes, &stringp, &do_free_icon_value);
1656 icon.encoding = (stringp ? XA_STRING
1657 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1658 icon.format = 8;
1659 icon.nitems = bytes;
1662 #ifdef USE_GTK
1663 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1664 (char *) SDATA (encoded_name));
1665 #else /* not USE_GTK */
1666 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1667 #endif /* not USE_GTK */
1669 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1671 if (do_free_icon_value)
1672 xfree (icon.value);
1673 if (do_free_text_value)
1674 xfree (text.value);
1676 #else /* not HAVE_X11R4 */
1677 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1678 SDATA (name));
1679 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1680 SDATA (name));
1681 #endif /* not HAVE_X11R4 */
1682 UNBLOCK_INPUT;
1686 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1687 x_id_name.
1689 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1690 name; if NAME is a string, set F's name to NAME and set
1691 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1693 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1694 suggesting a new name, which lisp code should override; if
1695 F->explicit_name is set, ignore the new name; otherwise, set it. */
1697 void
1698 x_set_name (f, name, explicit)
1699 struct frame *f;
1700 Lisp_Object name;
1701 int explicit;
1703 /* Make sure that requests from lisp code override requests from
1704 Emacs redisplay code. */
1705 if (explicit)
1707 /* If we're switching from explicit to implicit, we had better
1708 update the mode lines and thereby update the title. */
1709 if (f->explicit_name && NILP (name))
1710 update_mode_lines = 1;
1712 f->explicit_name = ! NILP (name);
1714 else if (f->explicit_name)
1715 return;
1717 /* If NAME is nil, set the name to the x_id_name. */
1718 if (NILP (name))
1720 /* Check for no change needed in this very common case
1721 before we do any consing. */
1722 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
1723 SDATA (f->name)))
1724 return;
1725 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
1727 else
1728 CHECK_STRING (name);
1730 /* Don't change the name if it's already NAME. */
1731 if (! NILP (Fstring_equal (name, f->name)))
1732 return;
1734 f->name = name;
1736 /* For setting the frame title, the title parameter should override
1737 the name parameter. */
1738 if (! NILP (f->title))
1739 name = f->title;
1741 x_set_name_internal (f, name);
1744 /* This function should be called when the user's lisp code has
1745 specified a name for the frame; the name will override any set by the
1746 redisplay code. */
1747 void
1748 x_explicitly_set_name (f, arg, oldval)
1749 FRAME_PTR f;
1750 Lisp_Object arg, oldval;
1752 x_set_name (f, arg, 1);
1755 /* This function should be called by Emacs redisplay code to set the
1756 name; names set this way will never override names set by the user's
1757 lisp code. */
1758 void
1759 x_implicitly_set_name (f, arg, oldval)
1760 FRAME_PTR f;
1761 Lisp_Object arg, oldval;
1763 x_set_name (f, arg, 0);
1766 /* Change the title of frame F to NAME.
1767 If NAME is nil, use the frame name as the title. */
1769 void
1770 x_set_title (f, name, old_name)
1771 struct frame *f;
1772 Lisp_Object name, old_name;
1774 /* Don't change the title if it's already NAME. */
1775 if (EQ (name, f->title))
1776 return;
1778 update_mode_lines = 1;
1780 f->title = name;
1782 if (NILP (name))
1783 name = f->name;
1784 else
1785 CHECK_STRING (name);
1787 x_set_name_internal (f, name);
1790 void
1791 x_set_scroll_bar_default_width (f)
1792 struct frame *f;
1794 int wid = FRAME_COLUMN_WIDTH (f);
1796 #ifdef USE_TOOLKIT_SCROLL_BARS
1797 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1798 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
1799 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
1800 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = width;
1801 #else
1802 /* Make the actual width at least 14 pixels and a multiple of a
1803 character width. */
1804 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
1806 /* Use all of that space (aside from required margins) for the
1807 scroll bar. */
1808 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = 0;
1809 #endif
1813 /* Record in frame F the specified or default value according to ALIST
1814 of the parameter named PROP (a Lisp symbol). If no value is
1815 specified for PROP, look for an X default for XPROP on the frame
1816 named NAME. If that is not found either, use the value DEFLT. */
1818 static Lisp_Object
1819 x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
1820 foreground_p)
1821 struct frame *f;
1822 Lisp_Object alist;
1823 Lisp_Object prop;
1824 char *xprop;
1825 char *xclass;
1826 int foreground_p;
1828 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1829 Lisp_Object tem;
1831 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1832 if (EQ (tem, Qunbound))
1834 #ifdef USE_TOOLKIT_SCROLL_BARS
1836 /* See if an X resource for the scroll bar color has been
1837 specified. */
1838 tem = display_x_get_resource (dpyinfo,
1839 build_string (foreground_p
1840 ? "foreground"
1841 : "background"),
1842 empty_string,
1843 build_string ("verticalScrollBar"),
1844 empty_string);
1845 if (!STRINGP (tem))
1847 /* If nothing has been specified, scroll bars will use a
1848 toolkit-dependent default. Because these defaults are
1849 difficult to get at without actually creating a scroll
1850 bar, use nil to indicate that no color has been
1851 specified. */
1852 tem = Qnil;
1855 #else /* not USE_TOOLKIT_SCROLL_BARS */
1857 tem = Qnil;
1859 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1862 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
1863 return tem;
1868 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
1870 Status
1871 XSetWMProtocols (dpy, w, protocols, count)
1872 Display *dpy;
1873 Window w;
1874 Atom *protocols;
1875 int count;
1877 Atom prop;
1878 prop = XInternAtom (dpy, "WM_PROTOCOLS", False);
1879 if (prop == None) return False;
1880 XChangeProperty (dpy, w, prop, XA_ATOM, 32, PropModeReplace,
1881 (unsigned char *) protocols, count);
1882 return True;
1884 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
1886 #ifdef USE_X_TOOLKIT
1888 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1889 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1890 already be present because of the toolkit (Motif adds some of them,
1891 for example, but Xt doesn't). */
1893 static void
1894 hack_wm_protocols (f, widget)
1895 FRAME_PTR f;
1896 Widget widget;
1898 Display *dpy = XtDisplay (widget);
1899 Window w = XtWindow (widget);
1900 int need_delete = 1;
1901 int need_focus = 1;
1902 int need_save = 1;
1904 BLOCK_INPUT;
1906 Atom type;
1907 unsigned char *catoms;
1908 int format = 0;
1909 unsigned long nitems = 0;
1910 unsigned long bytes_after;
1912 if ((XGetWindowProperty (dpy, w,
1913 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1914 (long)0, (long)100, False, XA_ATOM,
1915 &type, &format, &nitems, &bytes_after,
1916 &catoms)
1917 == Success)
1918 && format == 32 && type == XA_ATOM)
1920 Atom *atoms = (Atom *) catoms;
1921 while (nitems > 0)
1923 nitems--;
1924 if (atoms[nitems]
1925 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1926 need_delete = 0;
1927 else if (atoms[nitems]
1928 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1929 need_focus = 0;
1930 else if (atoms[nitems]
1931 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1932 need_save = 0;
1935 if (catoms)
1936 XFree (catoms);
1939 Atom props [10];
1940 int count = 0;
1941 if (need_delete)
1942 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1943 if (need_focus)
1944 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1945 if (need_save)
1946 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1947 if (count)
1948 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1949 XA_ATOM, 32, PropModeAppend,
1950 (unsigned char *) props, count);
1952 UNBLOCK_INPUT;
1954 #endif
1958 /* Support routines for XIC (X Input Context). */
1960 #ifdef HAVE_X_I18N
1962 static XFontSet xic_create_xfontset P_ ((struct frame *, char *));
1963 static XIMStyle best_xim_style P_ ((XIMStyles *, XIMStyles *));
1966 /* Supported XIM styles, ordered by preference. */
1968 static XIMStyle supported_xim_styles[] =
1970 XIMPreeditPosition | XIMStatusArea,
1971 XIMPreeditPosition | XIMStatusNothing,
1972 XIMPreeditPosition | XIMStatusNone,
1973 XIMPreeditNothing | XIMStatusArea,
1974 XIMPreeditNothing | XIMStatusNothing,
1975 XIMPreeditNothing | XIMStatusNone,
1976 XIMPreeditNone | XIMStatusArea,
1977 XIMPreeditNone | XIMStatusNothing,
1978 XIMPreeditNone | XIMStatusNone,
1983 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1985 char xic_defaut_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1987 /* Create an Xt fontset spec from the name of a base font.
1988 If `motif' is True use the Motif syntax. */
1989 char *
1990 xic_create_fontsetname (base_fontname, motif)
1991 char *base_fontname;
1992 Bool motif;
1994 const char *sep = motif ? ";" : ",";
1995 char *fontsetname;
1997 /* Make a fontset name from the base font name. */
1998 if (xic_defaut_fontset == base_fontname)
1999 { /* There is no base font name, use the default. */
2000 int len = strlen (base_fontname) + 2;
2001 fontsetname = xmalloc (len);
2002 bzero (fontsetname, len);
2003 strcpy (fontsetname, base_fontname);
2005 else
2007 /* Make a fontset name from the base font name.
2008 The font set will be made of the following elements:
2009 - the base font.
2010 - the base font where the charset spec is replaced by -*-*.
2011 - the same but with the family also replaced with -*-*-. */
2012 char *p = base_fontname;
2013 int i;
2015 for (i = 0; *p; p++)
2016 if (*p == '-') i++;
2017 if (i != 14)
2018 { /* As the font name doesn't conform to XLFD, we can't
2019 modify it to generalize it to allcs and allfamilies.
2020 Use the specified font plus the default. */
2021 int len = strlen (base_fontname) + strlen (xic_defaut_fontset) + 3;
2022 fontsetname = xmalloc (len);
2023 bzero (fontsetname, len);
2024 strcpy (fontsetname, base_fontname);
2025 strcat (fontsetname, sep);
2026 strcat (fontsetname, xic_defaut_fontset);
2028 else
2030 int len;
2031 char *p1 = NULL, *p2 = NULL, *p3 = NULL;
2032 char *font_allcs = NULL;
2033 char *font_allfamilies = NULL;
2034 char *font_all = NULL;
2035 char *allcs = "*-*-*-*-*-*-*";
2036 char *allfamilies = "-*-*-";
2037 char *all = "*-*-*-*-";
2038 char *base;
2040 for (i = 0, p = base_fontname; i < 8; p++)
2042 if (*p == '-')
2044 i++;
2045 if (i == 3)
2046 p1 = p + 1;
2047 else if (i == 7)
2048 p2 = p + 1;
2049 else if (i == 6)
2050 p3 = p + 1;
2053 /* If base_fontname specifies ADSTYLE, make it a
2054 wildcard. */
2055 if (*p3 != '*')
2057 int diff = (p2 - p3) - 2;
2059 base = alloca (strlen (base_fontname) + 1);
2060 bcopy (base_fontname, base, p3 - base_fontname);
2061 base[p3 - base_fontname] = '*';
2062 base[(p3 - base_fontname) + 1] = '-';
2063 strcpy (base + (p3 - base_fontname) + 2, p2);
2064 p = base + (p - base_fontname) - diff;
2065 p1 = base + (p1 - base_fontname);
2066 p2 = base + (p2 - base_fontname) - diff;
2067 base_fontname = base;
2070 /* Build the font spec that matches all charsets. */
2071 len = p - base_fontname + strlen (allcs) + 1;
2072 font_allcs = (char *) alloca (len);
2073 bzero (font_allcs, len);
2074 bcopy (base_fontname, font_allcs, p - base_fontname);
2075 strcat (font_allcs, allcs);
2077 /* Build the font spec that matches all families and
2078 add-styles. */
2079 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
2080 font_allfamilies = (char *) alloca (len);
2081 bzero (font_allfamilies, len);
2082 strcpy (font_allfamilies, allfamilies);
2083 bcopy (p1, font_allfamilies + strlen (allfamilies), p - p1);
2084 strcat (font_allfamilies, allcs);
2086 /* Build the font spec that matches all. */
2087 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
2088 font_all = (char *) alloca (len);
2089 bzero (font_all, len);
2090 strcpy (font_all, allfamilies);
2091 strcat (font_all, all);
2092 bcopy (p2, font_all + strlen (all) + strlen (allfamilies), p - p2);
2093 strcat (font_all, allcs);
2095 /* Build the actual font set name. */
2096 len = strlen (base_fontname) + strlen (font_allcs)
2097 + strlen (font_allfamilies) + strlen (font_all) + 5;
2098 fontsetname = xmalloc (len);
2099 bzero (fontsetname, len);
2100 strcpy (fontsetname, base_fontname);
2101 strcat (fontsetname, sep);
2102 strcat (fontsetname, font_allcs);
2103 strcat (fontsetname, sep);
2104 strcat (fontsetname, font_allfamilies);
2105 strcat (fontsetname, sep);
2106 strcat (fontsetname, font_all);
2109 if (motif)
2110 strcat (fontsetname, ":");
2111 return fontsetname;
2114 static XFontSet
2115 xic_create_xfontset (f, base_fontname)
2116 struct frame *f;
2117 char *base_fontname;
2119 XFontSet xfs = NULL;
2120 char **missing_list = NULL;
2121 int missing_count;
2122 char *def_string;
2123 Lisp_Object rest, frame;
2125 if (!base_fontname)
2126 base_fontname = xic_defaut_fontset;
2128 /* See if there is another frame already using same fontset. */
2129 FOR_EACH_FRAME (rest, frame)
2131 struct frame *cf = XFRAME (frame);
2132 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2133 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2134 && FRAME_XIC_BASE_FONTNAME (cf)
2135 && !strcmp (FRAME_XIC_BASE_FONTNAME (cf), base_fontname))
2137 xfs = FRAME_XIC_FONTSET (cf);
2138 break;
2142 if (!xfs)
2144 char *fontsetname = xic_create_fontsetname (base_fontname, False);
2146 /* New fontset. */
2147 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
2148 fontsetname, &missing_list,
2149 &missing_count, &def_string);
2150 if (missing_list)
2151 XFreeStringList (missing_list);
2152 if (! xfs)
2154 /* FONTSETNAME contains a list of font names (specific fonts
2155 first, general fonts last), but giving that to
2156 XCreateFontSet at once occasionally fails (bug of X?).
2157 So, we try to call XCreateFontSet for each fontname. */
2158 char *p0 = fontsetname, *p1;
2160 while (p0)
2162 p1 = strchr (p0, ',');
2163 if (p1)
2164 *p1 = '\0';
2165 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
2166 p0, &missing_list,
2167 &missing_count, &def_string);
2168 if (missing_list)
2169 XFreeStringList (missing_list);
2170 if (xfs)
2171 break;
2172 p0 = p1 ? p1 + 1 : NULL;
2175 xfree (fontsetname);
2178 if (FRAME_XIC_BASE_FONTNAME (f))
2179 xfree (FRAME_XIC_BASE_FONTNAME (f));
2180 FRAME_XIC_BASE_FONTNAME (f) = xstrdup (base_fontname);
2182 /* No need to free def_string. */
2183 return xfs;
2186 /* Free the X fontset of frame F if it is the last frame using it. */
2188 void
2189 xic_free_xfontset (f)
2190 struct frame *f;
2192 Lisp_Object rest, frame;
2193 int shared_p = 0;
2195 if (!FRAME_XIC_FONTSET (f))
2196 return;
2198 /* See if there is another frame sharing the same fontset. */
2199 FOR_EACH_FRAME (rest, frame)
2201 struct frame *cf = XFRAME (frame);
2202 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2203 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2204 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2206 shared_p = 1;
2207 break;
2211 if (!shared_p)
2212 /* The fontset is not used anymore. It is safe to free it. */
2213 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2215 if (FRAME_XIC_BASE_FONTNAME (f))
2216 xfree (FRAME_XIC_BASE_FONTNAME (f));
2217 FRAME_XIC_BASE_FONTNAME (f) = NULL;
2218 FRAME_XIC_FONTSET (f) = NULL;
2222 /* Value is the best input style, given user preferences USER (already
2223 checked to be supported by Emacs), and styles supported by the
2224 input method XIM. */
2226 static XIMStyle
2227 best_xim_style (user, xim)
2228 XIMStyles *user;
2229 XIMStyles *xim;
2231 int i, j;
2233 for (i = 0; i < user->count_styles; ++i)
2234 for (j = 0; j < xim->count_styles; ++j)
2235 if (user->supported_styles[i] == xim->supported_styles[j])
2236 return user->supported_styles[i];
2238 /* Return the default style. */
2239 return XIMPreeditNothing | XIMStatusNothing;
2242 /* Create XIC for frame F. */
2244 static XIMStyle xic_style;
2246 void
2247 create_frame_xic (f)
2248 struct frame *f;
2250 XIM xim;
2251 XIC xic = NULL;
2252 XFontSet xfs = NULL;
2254 if (FRAME_XIC (f))
2255 return;
2257 /* Create X fontset. */
2258 xfs = xic_create_xfontset
2259 (f, (FRAME_FONTSET (f) < 0) ? NULL
2260 : (char *) SDATA (fontset_ascii (FRAME_FONTSET (f))));
2262 xim = FRAME_X_XIM (f);
2263 if (xim)
2265 XRectangle s_area;
2266 XPoint spot;
2267 XVaNestedList preedit_attr;
2268 XVaNestedList status_attr;
2270 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2271 spot.x = 0; spot.y = 1;
2273 /* Determine XIC style. */
2274 if (xic_style == 0)
2276 XIMStyles supported_list;
2277 supported_list.count_styles = (sizeof supported_xim_styles
2278 / sizeof supported_xim_styles[0]);
2279 supported_list.supported_styles = supported_xim_styles;
2280 xic_style = best_xim_style (&supported_list,
2281 FRAME_X_XIM_STYLES (f));
2284 preedit_attr = XVaCreateNestedList (0,
2285 XNFontSet, xfs,
2286 XNForeground,
2287 FRAME_FOREGROUND_PIXEL (f),
2288 XNBackground,
2289 FRAME_BACKGROUND_PIXEL (f),
2290 (xic_style & XIMPreeditPosition
2291 ? XNSpotLocation
2292 : NULL),
2293 &spot,
2294 NULL);
2295 status_attr = XVaCreateNestedList (0,
2296 XNArea,
2297 &s_area,
2298 XNFontSet,
2299 xfs,
2300 XNForeground,
2301 FRAME_FOREGROUND_PIXEL (f),
2302 XNBackground,
2303 FRAME_BACKGROUND_PIXEL (f),
2304 NULL);
2306 xic = XCreateIC (xim,
2307 XNInputStyle, xic_style,
2308 XNClientWindow, FRAME_X_WINDOW (f),
2309 XNFocusWindow, FRAME_X_WINDOW (f),
2310 XNStatusAttributes, status_attr,
2311 XNPreeditAttributes, preedit_attr,
2312 NULL);
2313 XFree (preedit_attr);
2314 XFree (status_attr);
2317 FRAME_XIC (f) = xic;
2318 FRAME_XIC_STYLE (f) = xic_style;
2319 FRAME_XIC_FONTSET (f) = xfs;
2323 /* Destroy XIC and free XIC fontset of frame F, if any. */
2325 void
2326 free_frame_xic (f)
2327 struct frame *f;
2329 if (FRAME_XIC (f) == NULL)
2330 return;
2332 XDestroyIC (FRAME_XIC (f));
2333 xic_free_xfontset (f);
2335 FRAME_XIC (f) = NULL;
2339 /* Place preedit area for XIC of window W's frame to specified
2340 pixel position X/Y. X and Y are relative to window W. */
2342 void
2343 xic_set_preeditarea (w, x, y)
2344 struct window *w;
2345 int x, y;
2347 struct frame *f = XFRAME (w->frame);
2348 XVaNestedList attr;
2349 XPoint spot;
2351 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2352 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2353 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2354 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2355 XFree (attr);
2359 /* Place status area for XIC in bottom right corner of frame F.. */
2361 void
2362 xic_set_statusarea (f)
2363 struct frame *f;
2365 XIC xic = FRAME_XIC (f);
2366 XVaNestedList attr;
2367 XRectangle area;
2368 XRectangle *needed;
2370 /* Negotiate geometry of status area. If input method has existing
2371 status area, use its current size. */
2372 area.x = area.y = area.width = area.height = 0;
2373 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2374 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2375 XFree (attr);
2377 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2378 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2379 XFree (attr);
2381 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2383 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2384 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2385 XFree (attr);
2388 area.width = needed->width;
2389 area.height = needed->height;
2390 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2391 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2392 - FRAME_MENUBAR_HEIGHT (f)
2393 - FRAME_TOOLBAR_HEIGHT (f)
2394 - FRAME_INTERNAL_BORDER_WIDTH (f));
2395 XFree (needed);
2397 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2398 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2399 XFree (attr);
2403 /* Set X fontset for XIC of frame F, using base font name
2404 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2406 void
2407 xic_set_xfontset (f, base_fontname)
2408 struct frame *f;
2409 char *base_fontname;
2411 XVaNestedList attr;
2412 XFontSet xfs;
2414 xic_free_xfontset (f);
2416 xfs = xic_create_xfontset (f, base_fontname);
2418 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2419 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2420 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2421 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2422 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2423 XFree (attr);
2425 FRAME_XIC_FONTSET (f) = xfs;
2428 #endif /* HAVE_X_I18N */
2432 #ifdef USE_X_TOOLKIT
2434 /* Create and set up the X widget for frame F. */
2436 static void
2437 x_window (f, window_prompting, minibuffer_only)
2438 struct frame *f;
2439 long window_prompting;
2440 int minibuffer_only;
2442 XClassHint class_hints;
2443 XSetWindowAttributes attributes;
2444 unsigned long attribute_mask;
2445 Widget shell_widget;
2446 Widget pane_widget;
2447 Widget frame_widget;
2448 Arg al [25];
2449 int ac;
2451 BLOCK_INPUT;
2453 /* Use the resource name as the top-level widget name
2454 for looking up resources. Make a non-Lisp copy
2455 for the window manager, so GC relocation won't bother it.
2457 Elsewhere we specify the window name for the window manager. */
2460 char *str = (char *) SDATA (Vx_resource_name);
2461 f->namebuf = (char *) xmalloc (strlen (str) + 1);
2462 strcpy (f->namebuf, str);
2465 ac = 0;
2466 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2467 XtSetArg (al[ac], XtNinput, 1); ac++;
2468 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2469 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2470 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2471 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2472 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2473 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2474 applicationShellWidgetClass,
2475 FRAME_X_DISPLAY (f), al, ac);
2477 f->output_data.x->widget = shell_widget;
2478 /* maybe_set_screen_title_format (shell_widget); */
2480 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2481 (widget_value *) NULL,
2482 shell_widget, False,
2483 (lw_callback) NULL,
2484 (lw_callback) NULL,
2485 (lw_callback) NULL,
2486 (lw_callback) NULL);
2488 ac = 0;
2489 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2490 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2491 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2492 XtSetValues (pane_widget, al, ac);
2493 f->output_data.x->column_widget = pane_widget;
2495 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2496 the emacs screen when changing menubar. This reduces flickering. */
2498 ac = 0;
2499 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2500 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2501 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2502 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2503 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2504 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2505 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2506 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2507 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2508 al, ac);
2510 f->output_data.x->edit_widget = frame_widget;
2512 XtManageChild (frame_widget);
2514 /* Do some needed geometry management. */
2516 int len;
2517 char *tem, shell_position[32];
2518 Arg al[10];
2519 int ac = 0;
2520 int extra_borders = 0;
2521 int menubar_size
2522 = (f->output_data.x->menubar_widget
2523 ? (f->output_data.x->menubar_widget->core.height
2524 + f->output_data.x->menubar_widget->core.border_width)
2525 : 0);
2527 #if 0 /* Experimentally, we now get the right results
2528 for -geometry -0-0 without this. 24 Aug 96, rms. */
2529 if (FRAME_EXTERNAL_MENU_BAR (f))
2531 Dimension ibw = 0;
2532 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2533 menubar_size += ibw;
2535 #endif
2537 f->output_data.x->menubar_height = menubar_size;
2539 #ifndef USE_LUCID
2540 /* Motif seems to need this amount added to the sizes
2541 specified for the shell widget. The Athena/Lucid widgets don't.
2542 Both conclusions reached experimentally. -- rms. */
2543 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2544 &extra_borders, NULL);
2545 extra_borders *= 2;
2546 #endif
2548 /* Convert our geometry parameters into a geometry string
2549 and specify it.
2550 Note that we do not specify here whether the position
2551 is a user-specified or program-specified one.
2552 We pass that information later, in x_wm_set_size_hints. */
2554 int left = f->left_pos;
2555 int xneg = window_prompting & XNegative;
2556 int top = f->top_pos;
2557 int yneg = window_prompting & YNegative;
2558 if (xneg)
2559 left = -left;
2560 if (yneg)
2561 top = -top;
2563 if (window_prompting & USPosition)
2564 sprintf (shell_position, "=%dx%d%c%d%c%d",
2565 FRAME_PIXEL_WIDTH (f) + extra_borders,
2566 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2567 (xneg ? '-' : '+'), left,
2568 (yneg ? '-' : '+'), top);
2569 else
2571 sprintf (shell_position, "=%dx%d",
2572 FRAME_PIXEL_WIDTH (f) + extra_borders,
2573 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2575 /* Setting x and y when the position is not specified in
2576 the geometry string will set program position in the WM hints.
2577 If Emacs had just one program position, we could set it in
2578 fallback resources, but since each make-frame call can specify
2579 different program positions, this is easier. */
2580 XtSetArg (al[ac], XtNx, left); ac++;
2581 XtSetArg (al[ac], XtNy, top); ac++;
2585 len = strlen (shell_position) + 1;
2586 /* We don't free this because we don't know whether
2587 it is safe to free it while the frame exists.
2588 It isn't worth the trouble of arranging to free it
2589 when the frame is deleted. */
2590 tem = (char *) xmalloc (len);
2591 strncpy (tem, shell_position, len);
2592 XtSetArg (al[ac], XtNgeometry, tem); ac++;
2593 XtSetValues (shell_widget, al, ac);
2596 XtManageChild (pane_widget);
2597 XtRealizeWidget (shell_widget);
2599 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2601 validate_x_resource_name ();
2603 class_hints.res_name = (char *) SDATA (Vx_resource_name);
2604 class_hints.res_class = (char *) SDATA (Vx_resource_class);
2605 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2607 #ifdef HAVE_X_I18N
2608 FRAME_XIC (f) = NULL;
2609 if (use_xim)
2610 create_frame_xic (f);
2611 #endif
2613 f->output_data.x->wm_hints.input = True;
2614 f->output_data.x->wm_hints.flags |= InputHint;
2615 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2616 &f->output_data.x->wm_hints);
2618 hack_wm_protocols (f, shell_widget);
2620 #ifdef HACK_EDITRES
2621 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2622 #endif
2624 /* Do a stupid property change to force the server to generate a
2625 PropertyNotify event so that the event_stream server timestamp will
2626 be initialized to something relevant to the time we created the window.
2628 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2629 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
2630 XA_ATOM, 32, PropModeAppend,
2631 (unsigned char*) NULL, 0);
2633 /* Make all the standard events reach the Emacs frame. */
2634 attributes.event_mask = STANDARD_EVENT_SET;
2636 #ifdef HAVE_X_I18N
2637 if (FRAME_XIC (f))
2639 /* XIM server might require some X events. */
2640 unsigned long fevent = NoEventMask;
2641 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2642 attributes.event_mask |= fevent;
2644 #endif /* HAVE_X_I18N */
2646 attribute_mask = CWEventMask;
2647 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2648 attribute_mask, &attributes);
2650 XtMapWidget (frame_widget);
2652 /* x_set_name normally ignores requests to set the name if the
2653 requested name is the same as the current name. This is the one
2654 place where that assumption isn't correct; f->name is set, but
2655 the X server hasn't been told. */
2657 Lisp_Object name;
2658 int explicit = f->explicit_name;
2660 f->explicit_name = 0;
2661 name = f->name;
2662 f->name = Qnil;
2663 x_set_name (f, name, explicit);
2666 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2667 f->output_data.x->text_cursor);
2669 UNBLOCK_INPUT;
2671 /* This is a no-op, except under Motif. Make sure main areas are
2672 set to something reasonable, in case we get an error later. */
2673 lw_set_main_areas (pane_widget, 0, frame_widget);
2676 #else /* not USE_X_TOOLKIT */
2677 #ifdef USE_GTK
2678 void
2679 x_window (f)
2680 FRAME_PTR f;
2682 if (! xg_create_frame_widgets (f))
2683 error ("Unable to create window");
2685 #ifdef HAVE_X_I18N
2686 FRAME_XIC (f) = NULL;
2687 if (use_xim)
2689 BLOCK_INPUT;
2690 create_frame_xic (f);
2691 if (FRAME_XIC (f))
2693 /* XIM server might require some X events. */
2694 unsigned long fevent = NoEventMask;
2695 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2697 if (fevent != NoEventMask)
2699 XSetWindowAttributes attributes;
2700 XWindowAttributes wattr;
2701 unsigned long attribute_mask;
2703 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2704 &wattr);
2705 attributes.event_mask = wattr.your_event_mask | fevent;
2706 attribute_mask = CWEventMask;
2707 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2708 attribute_mask, &attributes);
2711 UNBLOCK_INPUT;
2713 #endif
2716 #else /*! USE_GTK */
2717 /* Create and set up the X window for frame F. */
2719 void
2720 x_window (f)
2721 struct frame *f;
2724 XClassHint class_hints;
2725 XSetWindowAttributes attributes;
2726 unsigned long attribute_mask;
2728 attributes.background_pixel = f->output_data.x->background_pixel;
2729 attributes.border_pixel = f->output_data.x->border_pixel;
2730 attributes.bit_gravity = StaticGravity;
2731 attributes.backing_store = NotUseful;
2732 attributes.save_under = True;
2733 attributes.event_mask = STANDARD_EVENT_SET;
2734 attributes.colormap = FRAME_X_COLORMAP (f);
2735 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2736 | CWColormap);
2738 BLOCK_INPUT;
2739 FRAME_X_WINDOW (f)
2740 = XCreateWindow (FRAME_X_DISPLAY (f),
2741 f->output_data.x->parent_desc,
2742 f->left_pos,
2743 f->top_pos,
2744 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2745 f->border_width,
2746 CopyFromParent, /* depth */
2747 InputOutput, /* class */
2748 FRAME_X_VISUAL (f),
2749 attribute_mask, &attributes);
2751 #ifdef HAVE_X_I18N
2752 if (use_xim)
2754 create_frame_xic (f);
2755 if (FRAME_XIC (f))
2757 /* XIM server might require some X events. */
2758 unsigned long fevent = NoEventMask;
2759 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2760 attributes.event_mask |= fevent;
2761 attribute_mask = CWEventMask;
2762 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2763 attribute_mask, &attributes);
2766 #endif /* HAVE_X_I18N */
2768 validate_x_resource_name ();
2770 class_hints.res_name = (char *) SDATA (Vx_resource_name);
2771 class_hints.res_class = (char *) SDATA (Vx_resource_class);
2772 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2774 /* The menubar is part of the ordinary display;
2775 it does not count in addition to the height of the window. */
2776 f->output_data.x->menubar_height = 0;
2778 /* This indicates that we use the "Passive Input" input model.
2779 Unless we do this, we don't get the Focus{In,Out} events that we
2780 need to draw the cursor correctly. Accursed bureaucrats.
2781 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2783 f->output_data.x->wm_hints.input = True;
2784 f->output_data.x->wm_hints.flags |= InputHint;
2785 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2786 &f->output_data.x->wm_hints);
2787 f->output_data.x->wm_hints.icon_pixmap = None;
2789 /* Request "save yourself" and "delete window" commands from wm. */
2791 Atom protocols[2];
2792 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2793 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2794 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2797 /* x_set_name normally ignores requests to set the name if the
2798 requested name is the same as the current name. This is the one
2799 place where that assumption isn't correct; f->name is set, but
2800 the X server hasn't been told. */
2802 Lisp_Object name;
2803 int explicit = f->explicit_name;
2805 f->explicit_name = 0;
2806 name = f->name;
2807 f->name = Qnil;
2808 x_set_name (f, name, explicit);
2811 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2812 f->output_data.x->text_cursor);
2814 UNBLOCK_INPUT;
2816 if (FRAME_X_WINDOW (f) == 0)
2817 error ("Unable to create window");
2820 #endif /* not USE_GTK */
2821 #endif /* not USE_X_TOOLKIT */
2823 /* Verify that the icon position args for this window are valid. */
2825 static void
2826 x_icon_verify (f, parms)
2827 struct frame *f;
2828 Lisp_Object parms;
2830 Lisp_Object icon_x, icon_y;
2832 /* Set the position of the icon. Note that twm groups all
2833 icons in an icon window. */
2834 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2835 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2836 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2838 CHECK_NUMBER (icon_x);
2839 CHECK_NUMBER (icon_y);
2841 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2842 error ("Both left and top icon corners of icon must be specified");
2845 /* Handle the icon stuff for this window. Perhaps later we might
2846 want an x_set_icon_position which can be called interactively as
2847 well. */
2849 static void
2850 x_icon (f, parms)
2851 struct frame *f;
2852 Lisp_Object parms;
2854 Lisp_Object icon_x, icon_y;
2855 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2857 /* Set the position of the icon. Note that twm groups all
2858 icons in an icon window. */
2859 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2860 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2861 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2863 CHECK_NUMBER (icon_x);
2864 CHECK_NUMBER (icon_y);
2866 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2867 error ("Both left and top icon corners of icon must be specified");
2869 BLOCK_INPUT;
2871 if (! EQ (icon_x, Qunbound))
2872 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2874 #if 0 /* x_get_arg removes the visibility parameter as a side effect,
2875 but x_create_frame still needs it. */
2876 /* Start up iconic or window? */
2877 x_wm_set_window_state
2878 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2879 Qicon)
2880 ? IconicState
2881 : NormalState));
2882 #endif
2884 x_text_icon (f, (char *) SDATA ((!NILP (f->icon_name)
2885 ? f->icon_name
2886 : f->name)));
2888 UNBLOCK_INPUT;
2891 /* Make the GCs needed for this window, setting the
2892 background, border and mouse colors; also create the
2893 mouse cursor and the gray border tile. */
2895 static char cursor_bits[] =
2897 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2898 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2899 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2900 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
2903 static void
2904 x_make_gc (f)
2905 struct frame *f;
2907 XGCValues gc_values;
2909 BLOCK_INPUT;
2911 /* Create the GCs of this frame.
2912 Note that many default values are used. */
2914 /* Normal video */
2915 gc_values.font = FRAME_FONT (f)->fid;
2916 gc_values.foreground = f->output_data.x->foreground_pixel;
2917 gc_values.background = f->output_data.x->background_pixel;
2918 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2919 f->output_data.x->normal_gc
2920 = XCreateGC (FRAME_X_DISPLAY (f),
2921 FRAME_X_WINDOW (f),
2922 GCLineWidth | GCFont | GCForeground | GCBackground,
2923 &gc_values);
2925 /* Reverse video style. */
2926 gc_values.foreground = f->output_data.x->background_pixel;
2927 gc_values.background = f->output_data.x->foreground_pixel;
2928 f->output_data.x->reverse_gc
2929 = XCreateGC (FRAME_X_DISPLAY (f),
2930 FRAME_X_WINDOW (f),
2931 GCFont | GCForeground | GCBackground | GCLineWidth,
2932 &gc_values);
2934 /* Cursor has cursor-color background, background-color foreground. */
2935 gc_values.foreground = f->output_data.x->background_pixel;
2936 gc_values.background = f->output_data.x->cursor_pixel;
2937 gc_values.fill_style = FillOpaqueStippled;
2938 gc_values.stipple
2939 = XCreateBitmapFromData (FRAME_X_DISPLAY (f),
2940 FRAME_X_DISPLAY_INFO (f)->root_window,
2941 cursor_bits, 16, 16);
2942 f->output_data.x->cursor_gc
2943 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2944 (GCFont | GCForeground | GCBackground
2945 | GCFillStyle /* | GCStipple */ | GCLineWidth),
2946 &gc_values);
2948 /* Reliefs. */
2949 f->output_data.x->white_relief.gc = 0;
2950 f->output_data.x->black_relief.gc = 0;
2952 /* Create the gray border tile used when the pointer is not in
2953 the frame. Since this depends on the frame's pixel values,
2954 this must be done on a per-frame basis. */
2955 f->output_data.x->border_tile
2956 = (XCreatePixmapFromBitmapData
2957 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
2958 gray_bits, gray_width, gray_height,
2959 f->output_data.x->foreground_pixel,
2960 f->output_data.x->background_pixel,
2961 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2963 UNBLOCK_INPUT;
2967 /* Free what was was allocated in x_make_gc. */
2969 void
2970 x_free_gcs (f)
2971 struct frame *f;
2973 Display *dpy = FRAME_X_DISPLAY (f);
2975 BLOCK_INPUT;
2977 if (f->output_data.x->normal_gc)
2979 XFreeGC (dpy, f->output_data.x->normal_gc);
2980 f->output_data.x->normal_gc = 0;
2983 if (f->output_data.x->reverse_gc)
2985 XFreeGC (dpy, f->output_data.x->reverse_gc);
2986 f->output_data.x->reverse_gc = 0;
2989 if (f->output_data.x->cursor_gc)
2991 XFreeGC (dpy, f->output_data.x->cursor_gc);
2992 f->output_data.x->cursor_gc = 0;
2995 if (f->output_data.x->border_tile)
2997 XFreePixmap (dpy, f->output_data.x->border_tile);
2998 f->output_data.x->border_tile = 0;
3001 UNBLOCK_INPUT;
3005 /* Handler for signals raised during x_create_frame and
3006 x_create_top_frame. FRAME is the frame which is partially
3007 constructed. */
3009 static Lisp_Object
3010 unwind_create_frame (frame)
3011 Lisp_Object frame;
3013 struct frame *f = XFRAME (frame);
3015 /* If frame is ``official'', nothing to do. */
3016 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
3018 #if GLYPH_DEBUG
3019 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3020 #endif
3022 x_free_frame_resources (f);
3024 #if GLYPH_DEBUG
3025 /* Check that reference counts are indeed correct. */
3026 xassert (dpyinfo->reference_count == dpyinfo_refcount);
3027 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
3028 #endif
3029 return Qt;
3032 return Qnil;
3036 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
3037 1, 1, 0,
3038 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
3039 Returns an Emacs frame object.
3040 ALIST is an alist of frame parameters.
3041 If the parameters specify that the frame should not have a minibuffer,
3042 and do not specify a specific minibuffer window to use,
3043 then `default-minibuffer-frame' must be a frame whose minibuffer can
3044 be shared by the new frame.
3046 This function is an internal primitive--use `make-frame' instead. */)
3047 (parms)
3048 Lisp_Object parms;
3050 struct frame *f;
3051 Lisp_Object frame, tem;
3052 Lisp_Object name;
3053 int minibuffer_only = 0;
3054 long window_prompting = 0;
3055 int width, height;
3056 int count = SPECPDL_INDEX ();
3057 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3058 Lisp_Object display;
3059 struct x_display_info *dpyinfo = NULL;
3060 Lisp_Object parent;
3061 struct kboard *kb;
3063 check_x ();
3065 parms = Fcopy_alist (parms);
3067 /* Use this general default value to start with
3068 until we know if this frame has a specified name. */
3069 Vx_resource_name = Vinvocation_name;
3071 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3072 if (EQ (display, Qunbound))
3073 display = Qnil;
3074 dpyinfo = check_x_display_info (display);
3075 #ifdef MULTI_KBOARD
3076 kb = dpyinfo->kboard;
3077 #else
3078 kb = &the_only_kboard;
3079 #endif
3081 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3082 if (!STRINGP (name)
3083 && ! EQ (name, Qunbound)
3084 && ! NILP (name))
3085 error ("Invalid frame name--not a string or nil");
3087 if (STRINGP (name))
3088 Vx_resource_name = name;
3090 /* See if parent window is specified. */
3091 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3092 if (EQ (parent, Qunbound))
3093 parent = Qnil;
3094 if (! NILP (parent))
3095 CHECK_NUMBER (parent);
3097 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3098 /* No need to protect DISPLAY because that's not used after passing
3099 it to make_frame_without_minibuffer. */
3100 frame = Qnil;
3101 GCPRO4 (parms, parent, name, frame);
3102 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3103 RES_TYPE_SYMBOL);
3104 if (EQ (tem, Qnone) || NILP (tem))
3105 f = make_frame_without_minibuffer (Qnil, kb, display);
3106 else if (EQ (tem, Qonly))
3108 f = make_minibuffer_frame ();
3109 minibuffer_only = 1;
3111 else if (WINDOWP (tem))
3112 f = make_frame_without_minibuffer (tem, kb, display);
3113 else
3114 f = make_frame (1);
3116 XSETFRAME (frame, f);
3118 /* Note that X Windows does support scroll bars. */
3119 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
3121 f->output_method = output_x_window;
3122 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
3123 bzero (f->output_data.x, sizeof (struct x_output));
3124 f->output_data.x->icon_bitmap = -1;
3125 FRAME_FONTSET (f) = -1;
3126 f->output_data.x->scroll_bar_foreground_pixel = -1;
3127 f->output_data.x->scroll_bar_background_pixel = -1;
3128 #ifdef USE_TOOLKIT_SCROLL_BARS
3129 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3130 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3131 #endif /* USE_TOOLKIT_SCROLL_BARS */
3133 f->icon_name
3134 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3135 RES_TYPE_STRING);
3136 if (! STRINGP (f->icon_name))
3137 f->icon_name = Qnil;
3139 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3141 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
3142 record_unwind_protect (unwind_create_frame, frame);
3143 #if GLYPH_DEBUG
3144 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
3145 dpyinfo_refcount = dpyinfo->reference_count;
3146 #endif /* GLYPH_DEBUG */
3147 #ifdef MULTI_KBOARD
3148 FRAME_KBOARD (f) = kb;
3149 #endif
3151 /* These colors will be set anyway later, but it's important
3152 to get the color reference counts right, so initialize them! */
3154 Lisp_Object black;
3155 struct gcpro gcpro1;
3157 /* Function x_decode_color can signal an error. Make
3158 sure to initialize color slots so that we won't try
3159 to free colors we haven't allocated. */
3160 f->output_data.x->foreground_pixel = -1;
3161 f->output_data.x->background_pixel = -1;
3162 f->output_data.x->cursor_pixel = -1;
3163 f->output_data.x->cursor_foreground_pixel = -1;
3164 f->output_data.x->border_pixel = -1;
3165 f->output_data.x->mouse_pixel = -1;
3167 black = build_string ("black");
3168 GCPRO1 (black);
3169 f->output_data.x->foreground_pixel
3170 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3171 f->output_data.x->background_pixel
3172 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3173 f->output_data.x->cursor_pixel
3174 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3175 f->output_data.x->cursor_foreground_pixel
3176 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3177 f->output_data.x->border_pixel
3178 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3179 f->output_data.x->mouse_pixel
3180 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3181 UNGCPRO;
3184 /* Specify the parent under which to make this X window. */
3186 if (!NILP (parent))
3188 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3189 f->output_data.x->explicit_parent = 1;
3191 else
3193 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3194 f->output_data.x->explicit_parent = 0;
3197 /* Set the name; the functions to which we pass f expect the name to
3198 be set. */
3199 if (EQ (name, Qunbound) || NILP (name))
3201 f->name = build_string (dpyinfo->x_id_name);
3202 f->explicit_name = 0;
3204 else
3206 f->name = name;
3207 f->explicit_name = 1;
3208 /* use the frame's title when getting resources for this frame. */
3209 specbind (Qx_resource_name, name);
3212 /* Extract the window parameters from the supplied values
3213 that are needed to determine window geometry. */
3215 Lisp_Object font;
3217 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
3219 BLOCK_INPUT;
3220 /* First, try whatever font the caller has specified. */
3221 if (STRINGP (font))
3223 tem = Fquery_fontset (font, Qnil);
3224 if (STRINGP (tem))
3225 font = x_new_fontset (f, SDATA (tem));
3226 else
3227 font = x_new_font (f, SDATA (font));
3230 /* Try out a font which we hope has bold and italic variations. */
3231 if (!STRINGP (font))
3232 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
3233 if (!STRINGP (font))
3234 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3235 if (! STRINGP (font))
3236 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3237 if (! STRINGP (font))
3238 /* This was formerly the first thing tried, but it finds too many fonts
3239 and takes too long. */
3240 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
3241 /* If those didn't work, look for something which will at least work. */
3242 if (! STRINGP (font))
3243 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
3244 UNBLOCK_INPUT;
3245 if (! STRINGP (font))
3246 font = build_string ("fixed");
3248 x_set_frame_parameters (f, Fcons (Fcons (Qfont, font), Qnil));
3251 #ifdef USE_LUCID
3252 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
3253 whereby it fails to get any font. */
3254 xlwmenu_default_font = FRAME_FONT (f);
3255 #endif
3257 x_default_parameter (f, parms, Qborder_width, make_number (2),
3258 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3260 /* This defaults to 1 in order to match xterm. We recognize either
3261 internalBorderWidth or internalBorder (which is what xterm calls
3262 it). */
3263 if (NILP (Fassq (Qinternal_border_width, parms)))
3265 Lisp_Object value;
3267 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3268 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3269 if (! EQ (value, Qunbound))
3270 parms = Fcons (Fcons (Qinternal_border_width, value),
3271 parms);
3273 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
3274 "internalBorderWidth", "internalBorderWidth",
3275 RES_TYPE_NUMBER);
3276 x_default_parameter (f, parms, Qvertical_scroll_bars, Qleft,
3277 "verticalScrollBars", "ScrollBars",
3278 RES_TYPE_SYMBOL);
3280 /* Also do the stuff which must be set before the window exists. */
3281 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3282 "foreground", "Foreground", RES_TYPE_STRING);
3283 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3284 "background", "Background", RES_TYPE_STRING);
3285 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3286 "pointerColor", "Foreground", RES_TYPE_STRING);
3287 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
3288 "cursorColor", "Foreground", RES_TYPE_STRING);
3289 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3290 "borderColor", "BorderColor", RES_TYPE_STRING);
3291 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3292 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3293 x_default_parameter (f, parms, Qline_spacing, Qnil,
3294 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3295 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3296 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3297 x_default_parameter (f, parms, Qright_fringe, Qnil,
3298 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3300 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3301 "scrollBarForeground",
3302 "ScrollBarForeground", 1);
3303 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3304 "scrollBarBackground",
3305 "ScrollBarBackground", 0);
3307 /* Init faces before x_default_parameter is called for scroll-bar
3308 parameters because that function calls x_set_scroll_bar_width,
3309 which calls change_frame_size, which calls Fset_window_buffer,
3310 which runs hooks, which call Fvertical_motion. At the end, we
3311 end up in init_iterator with a null face cache, which should not
3312 happen. */
3313 init_frame_faces (f);
3315 x_default_parameter (f, parms, Qmenu_bar_lines, make_number (1),
3316 "menuBar", "MenuBar", RES_TYPE_NUMBER);
3317 x_default_parameter (f, parms, Qtool_bar_lines, make_number (1),
3318 "toolBar", "ToolBar", RES_TYPE_NUMBER);
3319 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3320 "bufferPredicate", "BufferPredicate",
3321 RES_TYPE_SYMBOL);
3322 x_default_parameter (f, parms, Qtitle, Qnil,
3323 "title", "Title", RES_TYPE_STRING);
3324 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3325 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3326 x_default_parameter (f, parms, Qfullscreen, Qnil,
3327 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3329 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3331 /* Compute the size of the X window. */
3332 window_prompting = x_figure_window_size (f, parms, 1);
3334 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3335 f->no_split = minibuffer_only || EQ (tem, Qt);
3337 x_icon_verify (f, parms);
3339 /* Create the X widget or window. */
3340 #ifdef USE_X_TOOLKIT
3341 x_window (f, window_prompting, minibuffer_only);
3342 #else
3343 x_window (f);
3344 #endif
3346 x_icon (f, parms);
3347 x_make_gc (f);
3349 /* Now consider the frame official. */
3350 FRAME_X_DISPLAY_INFO (f)->reference_count++;
3351 Vframe_list = Fcons (frame, Vframe_list);
3353 /* We need to do this after creating the X window, so that the
3354 icon-creation functions can say whose icon they're describing. */
3355 x_default_parameter (f, parms, Qicon_type, Qt,
3356 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
3358 x_default_parameter (f, parms, Qauto_raise, Qnil,
3359 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3360 x_default_parameter (f, parms, Qauto_lower, Qnil,
3361 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3362 x_default_parameter (f, parms, Qcursor_type, Qbox,
3363 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3364 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3365 "scrollBarWidth", "ScrollBarWidth",
3366 RES_TYPE_NUMBER);
3368 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3369 Change will not be effected unless different from the current
3370 FRAME_LINES (f). */
3371 width = FRAME_COLS (f);
3372 height = FRAME_LINES (f);
3374 SET_FRAME_COLS (f, 0);
3375 FRAME_LINES (f) = 0;
3376 change_frame_size (f, height, width, 1, 0, 0);
3378 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3379 /* Create the menu bar. */
3380 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3382 /* If this signals an error, we haven't set size hints for the
3383 frame and we didn't make it visible. */
3384 initialize_frame_menubar (f);
3386 #ifndef USE_GTK
3387 /* This is a no-op, except under Motif where it arranges the
3388 main window for the widgets on it. */
3389 lw_set_main_areas (f->output_data.x->column_widget,
3390 f->output_data.x->menubar_widget,
3391 f->output_data.x->edit_widget);
3392 #endif /* not USE_GTK */
3394 #endif /* USE_X_TOOLKIT || USE_GTK */
3396 /* Tell the server what size and position, etc, we want, and how
3397 badly we want them. This should be done after we have the menu
3398 bar so that its size can be taken into account. */
3399 BLOCK_INPUT;
3400 x_wm_set_size_hint (f, window_prompting, 0);
3401 UNBLOCK_INPUT;
3403 /* Make the window appear on the frame and enable display, unless
3404 the caller says not to. However, with explicit parent, Emacs
3405 cannot control visibility, so don't try. */
3406 if (! f->output_data.x->explicit_parent)
3408 Lisp_Object visibility;
3410 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3411 RES_TYPE_SYMBOL);
3412 if (EQ (visibility, Qunbound))
3413 visibility = Qt;
3415 if (EQ (visibility, Qicon))
3416 x_iconify_frame (f);
3417 else if (! NILP (visibility))
3418 x_make_frame_visible (f);
3419 else
3420 /* Must have been Qnil. */
3424 /* Set the WM leader property. GTK does this itself, so this is not
3425 needed when using GTK. */
3426 if (dpyinfo->client_leader_window != 0)
3428 BLOCK_INPUT;
3429 XChangeProperty (FRAME_X_DISPLAY (f),
3430 FRAME_OUTER_WINDOW (f),
3431 dpyinfo->Xatom_wm_client_leader,
3432 XA_WINDOW, 32, PropModeReplace,
3433 (unsigned char *) &dpyinfo->client_leader_window, 1);
3434 UNBLOCK_INPUT;
3437 /* Initialize `default-minibuffer-frame' in case this is the first
3438 frame on this display device. */
3439 if (FRAME_HAS_MINIBUF_P (f)
3440 && (!FRAMEP (kb->Vdefault_minibuffer_frame)
3441 || !FRAME_LIVE_P (XFRAME (kb->Vdefault_minibuffer_frame))))
3442 kb->Vdefault_minibuffer_frame = frame;
3444 /* All remaining specified parameters, which have not been "used"
3445 by x_get_arg and friends, now go in the misc. alist of the frame. */
3446 for (tem = parms; !NILP (tem); tem = XCDR (tem))
3447 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3448 f->param_alist = Fcons (XCAR (tem), f->param_alist);
3450 UNGCPRO;
3452 /* Make sure windows on this frame appear in calls to next-window
3453 and similar functions. */
3454 Vwindow_list = Qnil;
3456 return unbind_to (count, frame);
3460 /* FRAME is used only to get a handle on the X display. We don't pass the
3461 display info directly because we're called from frame.c, which doesn't
3462 know about that structure. */
3464 Lisp_Object
3465 x_get_focus_frame (frame)
3466 struct frame *frame;
3468 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
3469 Lisp_Object xfocus;
3470 if (! dpyinfo->x_focus_frame)
3471 return Qnil;
3473 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3474 return xfocus;
3478 /* In certain situations, when the window manager follows a
3479 click-to-focus policy, there seems to be no way around calling
3480 XSetInputFocus to give another frame the input focus .
3482 In an ideal world, XSetInputFocus should generally be avoided so
3483 that applications don't interfere with the window manager's focus
3484 policy. But I think it's okay to use when it's clearly done
3485 following a user-command. */
3487 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
3488 doc: /* Set the input focus to FRAME.
3489 FRAME nil means use the selected frame. */)
3490 (frame)
3491 Lisp_Object frame;
3493 struct frame *f = check_x_frame (frame);
3494 Display *dpy = FRAME_X_DISPLAY (f);
3496 BLOCK_INPUT;
3497 x_catch_errors (dpy);
3498 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3499 RevertToParent, CurrentTime);
3500 x_uncatch_errors ();
3501 UNBLOCK_INPUT;
3503 return Qnil;
3507 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3508 doc: /* Internal function called by `color-defined-p', which see. */)
3509 (color, frame)
3510 Lisp_Object color, frame;
3512 XColor foo;
3513 FRAME_PTR f = check_x_frame (frame);
3515 CHECK_STRING (color);
3517 if (x_defined_color (f, SDATA (color), &foo, 0))
3518 return Qt;
3519 else
3520 return Qnil;
3523 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3524 doc: /* Internal function called by `color-values', which see. */)
3525 (color, frame)
3526 Lisp_Object color, frame;
3528 XColor foo;
3529 FRAME_PTR f = check_x_frame (frame);
3531 CHECK_STRING (color);
3533 if (x_defined_color (f, SDATA (color), &foo, 0))
3534 return list3 (make_number (foo.red),
3535 make_number (foo.green),
3536 make_number (foo.blue));
3537 else
3538 return Qnil;
3541 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3542 doc: /* Internal function called by `display-color-p', which see. */)
3543 (display)
3544 Lisp_Object display;
3546 struct x_display_info *dpyinfo = check_x_display_info (display);
3548 if (dpyinfo->n_planes <= 2)
3549 return Qnil;
3551 switch (dpyinfo->visual->class)
3553 case StaticColor:
3554 case PseudoColor:
3555 case TrueColor:
3556 case DirectColor:
3557 return Qt;
3559 default:
3560 return Qnil;
3564 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3565 0, 1, 0,
3566 doc: /* Return t if the X display supports shades of gray.
3567 Note that color displays do support shades of gray.
3568 The optional argument DISPLAY specifies which display to ask about.
3569 DISPLAY should be either a frame or a display name (a string).
3570 If omitted or nil, that stands for the selected frame's display. */)
3571 (display)
3572 Lisp_Object display;
3574 struct x_display_info *dpyinfo = check_x_display_info (display);
3576 if (dpyinfo->n_planes <= 1)
3577 return Qnil;
3579 switch (dpyinfo->visual->class)
3581 case StaticColor:
3582 case PseudoColor:
3583 case TrueColor:
3584 case DirectColor:
3585 case StaticGray:
3586 case GrayScale:
3587 return Qt;
3589 default:
3590 return Qnil;
3594 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3595 0, 1, 0,
3596 doc: /* Returns the width in pixels of the X display DISPLAY.
3597 The optional argument DISPLAY specifies which display to ask about.
3598 DISPLAY should be either a frame or a display name (a string).
3599 If omitted or nil, that stands for the selected frame's display. */)
3600 (display)
3601 Lisp_Object display;
3603 struct x_display_info *dpyinfo = check_x_display_info (display);
3605 return make_number (dpyinfo->width);
3608 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3609 Sx_display_pixel_height, 0, 1, 0,
3610 doc: /* Returns the height in pixels of the X display DISPLAY.
3611 The optional argument DISPLAY specifies which display to ask about.
3612 DISPLAY should be either a frame or a display name (a string).
3613 If omitted or nil, that stands for the selected frame's display. */)
3614 (display)
3615 Lisp_Object display;
3617 struct x_display_info *dpyinfo = check_x_display_info (display);
3619 return make_number (dpyinfo->height);
3622 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3623 0, 1, 0,
3624 doc: /* Returns the number of bitplanes of the X display DISPLAY.
3625 The optional argument DISPLAY specifies which display to ask about.
3626 DISPLAY should be either a frame or a display name (a string).
3627 If omitted or nil, that stands for the selected frame's display. */)
3628 (display)
3629 Lisp_Object display;
3631 struct x_display_info *dpyinfo = check_x_display_info (display);
3633 return make_number (dpyinfo->n_planes);
3636 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3637 0, 1, 0,
3638 doc: /* Returns the number of color cells of the X display DISPLAY.
3639 The optional argument DISPLAY specifies which display to ask about.
3640 DISPLAY should be either a frame or a display name (a string).
3641 If omitted or nil, that stands for the selected frame's display. */)
3642 (display)
3643 Lisp_Object display;
3645 struct x_display_info *dpyinfo = check_x_display_info (display);
3647 int nr_planes = DisplayPlanes (dpyinfo->display,
3648 XScreenNumberOfScreen (dpyinfo->screen));
3650 /* Truncate nr_planes to 24 to avoid integer overflow.
3651 Some displays says 32, but only 24 bits are actually significant.
3652 There are only very few and rare video cards that have more than
3653 24 significant bits. Also 24 bits is more than 16 million colors,
3654 it "should be enough for everyone". */
3655 if (nr_planes > 24) nr_planes = 24;
3657 return make_number (1 << nr_planes);
3660 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3661 Sx_server_max_request_size,
3662 0, 1, 0,
3663 doc: /* Returns the maximum request size of the X server of display DISPLAY.
3664 The optional argument DISPLAY specifies which display to ask about.
3665 DISPLAY should be either a frame or a display name (a string).
3666 If omitted or nil, that stands for the selected frame's display. */)
3667 (display)
3668 Lisp_Object display;
3670 struct x_display_info *dpyinfo = check_x_display_info (display);
3672 return make_number (MAXREQUEST (dpyinfo->display));
3675 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3676 doc: /* Returns the "vendor ID" string of the X server of display DISPLAY.
3677 \(Labelling every distributor as a "vendor" embodies the false assumption
3678 that operating systems cannot be developed and distributed noncommercially.)
3679 The optional argument DISPLAY specifies which display to ask about.
3680 DISPLAY should be either a frame or a display name (a string).
3681 If omitted or nil, that stands for the selected frame's display. */)
3682 (display)
3683 Lisp_Object display;
3685 struct x_display_info *dpyinfo = check_x_display_info (display);
3686 char *vendor = ServerVendor (dpyinfo->display);
3688 if (! vendor) vendor = "";
3689 return build_string (vendor);
3692 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3693 doc: /* Returns the version numbers of the X server of display DISPLAY.
3694 The value is a list of three integers: the major and minor
3695 version numbers of the X Protocol in use, and the distributor-specific release
3696 number. See also the function `x-server-vendor'.
3698 The optional argument DISPLAY specifies which display to ask about.
3699 DISPLAY should be either a frame or a display name (a string).
3700 If omitted or nil, that stands for the selected frame's display. */)
3701 (display)
3702 Lisp_Object display;
3704 struct x_display_info *dpyinfo = check_x_display_info (display);
3705 Display *dpy = dpyinfo->display;
3707 return Fcons (make_number (ProtocolVersion (dpy)),
3708 Fcons (make_number (ProtocolRevision (dpy)),
3709 Fcons (make_number (VendorRelease (dpy)), Qnil)));
3712 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3713 doc: /* Return the number of screens on the X server of display DISPLAY.
3714 The optional argument DISPLAY specifies which display to ask about.
3715 DISPLAY should be either a frame or a display name (a string).
3716 If omitted or nil, that stands for the selected frame's display. */)
3717 (display)
3718 Lisp_Object display;
3720 struct x_display_info *dpyinfo = check_x_display_info (display);
3722 return make_number (ScreenCount (dpyinfo->display));
3725 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3726 doc: /* Return the height in millimeters of the X display DISPLAY.
3727 The optional argument DISPLAY specifies which display to ask about.
3728 DISPLAY should be either a frame or a display name (a string).
3729 If omitted or nil, that stands for the selected frame's display. */)
3730 (display)
3731 Lisp_Object display;
3733 struct x_display_info *dpyinfo = check_x_display_info (display);
3735 return make_number (HeightMMOfScreen (dpyinfo->screen));
3738 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3739 doc: /* Return the width in millimeters of the X display DISPLAY.
3740 The optional argument DISPLAY specifies which display to ask about.
3741 DISPLAY should be either a frame or a display name (a string).
3742 If omitted or nil, that stands for the selected frame's display. */)
3743 (display)
3744 Lisp_Object display;
3746 struct x_display_info *dpyinfo = check_x_display_info (display);
3748 return make_number (WidthMMOfScreen (dpyinfo->screen));
3751 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3752 Sx_display_backing_store, 0, 1, 0,
3753 doc: /* Returns an indication of whether X display DISPLAY does backing store.
3754 The value may be `always', `when-mapped', or `not-useful'.
3755 The optional argument DISPLAY specifies which display to ask about.
3756 DISPLAY should be either a frame or a display name (a string).
3757 If omitted or nil, that stands for the selected frame's display. */)
3758 (display)
3759 Lisp_Object display;
3761 struct x_display_info *dpyinfo = check_x_display_info (display);
3762 Lisp_Object result;
3764 switch (DoesBackingStore (dpyinfo->screen))
3766 case Always:
3767 result = intern ("always");
3768 break;
3770 case WhenMapped:
3771 result = intern ("when-mapped");
3772 break;
3774 case NotUseful:
3775 result = intern ("not-useful");
3776 break;
3778 default:
3779 error ("Strange value for BackingStore parameter of screen");
3780 result = Qnil;
3783 return result;
3786 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3787 Sx_display_visual_class, 0, 1, 0,
3788 doc: /* Return the visual class of the X display DISPLAY.
3789 The value is one of the symbols `static-gray', `gray-scale',
3790 `static-color', `pseudo-color', `true-color', or `direct-color'.
3792 The optional argument DISPLAY specifies which display to ask about.
3793 DISPLAY should be either a frame or a display name (a string).
3794 If omitted or nil, that stands for the selected frame's display. */)
3795 (display)
3796 Lisp_Object display;
3798 struct x_display_info *dpyinfo = check_x_display_info (display);
3799 Lisp_Object result;
3801 switch (dpyinfo->visual->class)
3803 case StaticGray:
3804 result = intern ("static-gray");
3805 break;
3806 case GrayScale:
3807 result = intern ("gray-scale");
3808 break;
3809 case StaticColor:
3810 result = intern ("static-color");
3811 break;
3812 case PseudoColor:
3813 result = intern ("pseudo-color");
3814 break;
3815 case TrueColor:
3816 result = intern ("true-color");
3817 break;
3818 case DirectColor:
3819 result = intern ("direct-color");
3820 break;
3821 default:
3822 error ("Display has an unknown visual class");
3823 result = Qnil;
3826 return result;
3829 DEFUN ("x-display-save-under", Fx_display_save_under,
3830 Sx_display_save_under, 0, 1, 0,
3831 doc: /* Returns t if the X display DISPLAY supports the save-under feature.
3832 The optional argument DISPLAY specifies which display to ask about.
3833 DISPLAY should be either a frame or a display name (a string).
3834 If omitted or nil, that stands for the selected frame's display. */)
3835 (display)
3836 Lisp_Object display;
3838 struct x_display_info *dpyinfo = check_x_display_info (display);
3840 if (DoesSaveUnders (dpyinfo->screen) == True)
3841 return Qt;
3842 else
3843 return Qnil;
3847 x_pixel_width (f)
3848 register struct frame *f;
3850 return FRAME_PIXEL_WIDTH (f);
3854 x_pixel_height (f)
3855 register struct frame *f;
3857 return FRAME_PIXEL_HEIGHT (f);
3861 x_char_width (f)
3862 register struct frame *f;
3864 return FRAME_COLUMN_WIDTH (f);
3868 x_char_height (f)
3869 register struct frame *f;
3871 return FRAME_LINE_HEIGHT (f);
3875 x_screen_planes (f)
3876 register struct frame *f;
3878 return FRAME_X_DISPLAY_INFO (f)->n_planes;
3883 /************************************************************************
3884 X Displays
3885 ************************************************************************/
3888 /* Mapping visual names to visuals. */
3890 static struct visual_class
3892 char *name;
3893 int class;
3895 visual_classes[] =
3897 {"StaticGray", StaticGray},
3898 {"GrayScale", GrayScale},
3899 {"StaticColor", StaticColor},
3900 {"PseudoColor", PseudoColor},
3901 {"TrueColor", TrueColor},
3902 {"DirectColor", DirectColor},
3903 {NULL, 0}
3907 #ifndef HAVE_XSCREENNUMBEROFSCREEN
3909 /* Value is the screen number of screen SCR. This is a substitute for
3910 the X function with the same name when that doesn't exist. */
3913 XScreenNumberOfScreen (scr)
3914 register Screen *scr;
3916 Display *dpy = scr->display;
3917 int i;
3919 for (i = 0; i < dpy->nscreens; ++i)
3920 if (scr == dpy->screens + i)
3921 break;
3923 return i;
3926 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
3929 /* Select the visual that should be used on display DPYINFO. Set
3930 members of DPYINFO appropriately. Called from x_term_init. */
3932 void
3933 select_visual (dpyinfo)
3934 struct x_display_info *dpyinfo;
3936 Display *dpy = dpyinfo->display;
3937 Screen *screen = dpyinfo->screen;
3938 Lisp_Object value;
3940 /* See if a visual is specified. */
3941 value = display_x_get_resource (dpyinfo,
3942 build_string ("visualClass"),
3943 build_string ("VisualClass"),
3944 Qnil, Qnil);
3945 if (STRINGP (value))
3947 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
3948 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
3949 depth, a decimal number. NAME is compared with case ignored. */
3950 char *s = (char *) alloca (SBYTES (value) + 1);
3951 char *dash;
3952 int i, class = -1;
3953 XVisualInfo vinfo;
3955 strcpy (s, SDATA (value));
3956 dash = index (s, '-');
3957 if (dash)
3959 dpyinfo->n_planes = atoi (dash + 1);
3960 *dash = '\0';
3962 else
3963 /* We won't find a matching visual with depth 0, so that
3964 an error will be printed below. */
3965 dpyinfo->n_planes = 0;
3967 /* Determine the visual class. */
3968 for (i = 0; visual_classes[i].name; ++i)
3969 if (xstricmp (s, visual_classes[i].name) == 0)
3971 class = visual_classes[i].class;
3972 break;
3975 /* Look up a matching visual for the specified class. */
3976 if (class == -1
3977 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
3978 dpyinfo->n_planes, class, &vinfo))
3979 fatal ("Invalid visual specification `%s'", SDATA (value));
3981 dpyinfo->visual = vinfo.visual;
3983 else
3985 int n_visuals;
3986 XVisualInfo *vinfo, vinfo_template;
3988 dpyinfo->visual = DefaultVisualOfScreen (screen);
3990 #ifdef HAVE_X11R4
3991 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
3992 #else
3993 vinfo_template.visualid = dpyinfo->visual->visualid;
3994 #endif
3995 vinfo_template.screen = XScreenNumberOfScreen (screen);
3996 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
3997 &vinfo_template, &n_visuals);
3998 if (n_visuals != 1)
3999 fatal ("Can't get proper X visual info");
4001 dpyinfo->n_planes = vinfo->depth;
4002 XFree ((char *) vinfo);
4007 /* Return the X display structure for the display named NAME.
4008 Open a new connection if necessary. */
4010 struct x_display_info *
4011 x_display_info_for_name (name)
4012 Lisp_Object name;
4014 Lisp_Object names;
4015 struct x_display_info *dpyinfo;
4017 CHECK_STRING (name);
4019 if (! EQ (Vwindow_system, intern ("x")))
4020 error ("Not using X Windows");
4022 for (dpyinfo = x_display_list, names = x_display_name_list;
4023 dpyinfo;
4024 dpyinfo = dpyinfo->next, names = XCDR (names))
4026 Lisp_Object tem;
4027 tem = Fstring_equal (XCAR (XCAR (names)), name);
4028 if (!NILP (tem))
4029 return dpyinfo;
4032 /* Use this general default value to start with. */
4033 Vx_resource_name = Vinvocation_name;
4035 validate_x_resource_name ();
4037 dpyinfo = x_term_init (name, (char *)0,
4038 (char *) SDATA (Vx_resource_name));
4040 if (dpyinfo == 0)
4041 error ("Cannot connect to X server %s", SDATA (name));
4043 x_in_use = 1;
4044 XSETFASTINT (Vwindow_system_version, 11);
4046 return dpyinfo;
4050 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4051 1, 3, 0,
4052 doc: /* Open a connection to an X server.
4053 DISPLAY is the name of the display to connect to.
4054 Optional second arg XRM-STRING is a string of resources in xrdb format.
4055 If the optional third arg MUST-SUCCEED is non-nil,
4056 terminate Emacs if we can't open the connection. */)
4057 (display, xrm_string, must_succeed)
4058 Lisp_Object display, xrm_string, must_succeed;
4060 unsigned char *xrm_option;
4061 struct x_display_info *dpyinfo;
4063 CHECK_STRING (display);
4064 if (! NILP (xrm_string))
4065 CHECK_STRING (xrm_string);
4067 if (! EQ (Vwindow_system, intern ("x")))
4068 error ("Not using X Windows");
4070 if (! NILP (xrm_string))
4071 xrm_option = (unsigned char *) SDATA (xrm_string);
4072 else
4073 xrm_option = (unsigned char *) 0;
4075 validate_x_resource_name ();
4077 /* This is what opens the connection and sets x_current_display.
4078 This also initializes many symbols, such as those used for input. */
4079 dpyinfo = x_term_init (display, xrm_option,
4080 (char *) SDATA (Vx_resource_name));
4082 if (dpyinfo == 0)
4084 if (!NILP (must_succeed))
4085 fatal ("Cannot connect to X server %s.\n\
4086 Check the DISPLAY environment variable or use `-d'.\n\
4087 Also use the `xauth' program to verify that you have the proper\n\
4088 authorization information needed to connect the X server.\n\
4089 An insecure way to solve the problem may be to use `xhost'.\n",
4090 SDATA (display));
4091 else
4092 error ("Cannot connect to X server %s", SDATA (display));
4095 x_in_use = 1;
4097 XSETFASTINT (Vwindow_system_version, 11);
4098 return Qnil;
4101 DEFUN ("x-close-connection", Fx_close_connection,
4102 Sx_close_connection, 1, 1, 0,
4103 doc: /* Close the connection to DISPLAY's X server.
4104 For DISPLAY, specify either a frame or a display name (a string).
4105 If DISPLAY is nil, that stands for the selected frame's display. */)
4106 (display)
4107 Lisp_Object display;
4109 struct x_display_info *dpyinfo = check_x_display_info (display);
4110 int i;
4112 if (dpyinfo->reference_count > 0)
4113 error ("Display still has frames on it");
4115 BLOCK_INPUT;
4116 /* Free the fonts in the font table. */
4117 for (i = 0; i < dpyinfo->n_fonts; i++)
4118 if (dpyinfo->font_table[i].name)
4120 XFreeFont (dpyinfo->display, dpyinfo->font_table[i].font);
4123 x_destroy_all_bitmaps (dpyinfo);
4124 XSetCloseDownMode (dpyinfo->display, DestroyAll);
4126 #ifdef USE_GTK
4127 xg_display_close (dpyinfo->display);
4128 #else
4129 #ifdef USE_X_TOOLKIT
4130 XtCloseDisplay (dpyinfo->display);
4131 #else
4132 XCloseDisplay (dpyinfo->display);
4133 #endif
4134 #endif /* ! USE_GTK */
4136 x_delete_display (dpyinfo);
4137 UNBLOCK_INPUT;
4139 return Qnil;
4142 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4143 doc: /* Return the list of display names that Emacs has connections to. */)
4146 Lisp_Object tail, result;
4148 result = Qnil;
4149 for (tail = x_display_name_list; ! NILP (tail); tail = XCDR (tail))
4150 result = Fcons (XCAR (XCAR (tail)), result);
4152 return result;
4155 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4156 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4157 If ON is nil, allow buffering of requests.
4158 Turning on synchronization prohibits the Xlib routines from buffering
4159 requests and seriously degrades performance, but makes debugging much
4160 easier.
4161 The optional second argument DISPLAY specifies which display to act on.
4162 DISPLAY should be either a frame or a display name (a string).
4163 If DISPLAY is omitted or nil, that stands for the selected frame's display. */)
4164 (on, display)
4165 Lisp_Object display, on;
4167 struct x_display_info *dpyinfo = check_x_display_info (display);
4169 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4171 return Qnil;
4174 /* Wait for responses to all X commands issued so far for frame F. */
4176 void
4177 x_sync (f)
4178 FRAME_PTR f;
4180 BLOCK_INPUT;
4181 XSync (FRAME_X_DISPLAY (f), False);
4182 UNBLOCK_INPUT;
4186 /***********************************************************************
4187 Window properties
4188 ***********************************************************************/
4190 DEFUN ("x-change-window-property", Fx_change_window_property,
4191 Sx_change_window_property, 2, 6, 0,
4192 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4193 PROP must be a string.
4194 VALUE may be a string or a list of conses, numbers and/or strings.
4195 If an element in the list is a string, it is converted to
4196 an Atom and the value of the Atom is used. If an element is a cons,
4197 it is converted to a 32 bit number where the car is the 16 top bits and the
4198 cdr is the lower 16 bits.
4199 FRAME nil or omitted means use the selected frame.
4200 If TYPE is given and non-nil, it is the name of the type of VALUE.
4201 If TYPE is not given or nil, the type is STRING.
4202 FORMAT gives the size in bits of each element if VALUE is a list.
4203 It must be one of 8, 16 or 32.
4204 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4205 If OUTER_P is non-nil, the property is changed for the outer X window of
4206 FRAME. Default is to change on the edit X window.
4208 Value is VALUE. */)
4209 (prop, value, frame, type, format, outer_p)
4210 Lisp_Object prop, value, frame, type, format, outer_p;
4212 struct frame *f = check_x_frame (frame);
4213 Atom prop_atom;
4214 Atom target_type = XA_STRING;
4215 int element_format = 8;
4216 unsigned char *data;
4217 int nelements;
4218 Window w;
4220 CHECK_STRING (prop);
4222 if (! NILP (format))
4224 CHECK_NUMBER (format);
4225 element_format = XFASTINT (format);
4227 if (element_format != 8 && element_format != 16
4228 && element_format != 32)
4229 error ("FORMAT must be one of 8, 16 or 32");
4232 if (CONSP (value))
4234 nelements = x_check_property_data (value);
4235 if (nelements == -1)
4236 error ("Bad data in VALUE, must be number, string or cons");
4238 if (element_format == 8)
4239 data = (unsigned char *) xmalloc (nelements);
4240 else if (element_format == 16)
4241 data = (unsigned char *) xmalloc (nelements*2);
4242 else /* format == 32 */
4243 /* The man page for XChangeProperty:
4244 "If the specified format is 32, the property data must be a
4245 long array."
4246 This applies even if long is more than 64 bits. The X library
4247 converts to 32 bits before sending to the X server. */
4248 data = (unsigned char *) xmalloc (nelements * sizeof(long));
4250 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4252 else
4254 CHECK_STRING (value);
4255 data = SDATA (value);
4256 nelements = SCHARS (value);
4259 BLOCK_INPUT;
4260 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4261 if (! NILP (type))
4263 CHECK_STRING (type);
4264 target_type = XInternAtom (FRAME_X_DISPLAY (f), SDATA (type), False);
4267 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4268 else w = FRAME_X_WINDOW (f);
4270 XChangeProperty (FRAME_X_DISPLAY (f), w,
4271 prop_atom, target_type, element_format, PropModeReplace,
4272 data, nelements);
4274 if (CONSP (value)) xfree (data);
4276 /* Make sure the property is set when we return. */
4277 XFlush (FRAME_X_DISPLAY (f));
4278 UNBLOCK_INPUT;
4280 return value;
4284 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4285 Sx_delete_window_property, 1, 2, 0,
4286 doc: /* Remove window property PROP from X window of FRAME.
4287 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4288 (prop, frame)
4289 Lisp_Object prop, frame;
4291 struct frame *f = check_x_frame (frame);
4292 Atom prop_atom;
4294 CHECK_STRING (prop);
4295 BLOCK_INPUT;
4296 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4297 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4299 /* Make sure the property is removed when we return. */
4300 XFlush (FRAME_X_DISPLAY (f));
4301 UNBLOCK_INPUT;
4303 return prop;
4307 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4308 1, 6, 0,
4309 doc: /* Value is the value of window property PROP on FRAME.
4310 If FRAME is nil or omitted, use the selected frame.
4311 If TYPE is nil or omitted, get the property as a string. Otherwise TYPE
4312 is the name of the Atom that denotes the type expected.
4313 If SOURCE is non-nil, get the property on that window instead of from
4314 FRAME. The number 0 denotes the root window.
4315 If DELETE_P is non-nil, delete the property after retreiving it.
4316 If VECTOR_RET_P is non-nil, don't return a string but a vector of values.
4318 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4319 no value of TYPE. */)
4320 (prop, frame, type, source, delete_p, vector_ret_p)
4321 Lisp_Object prop, frame, type, source, delete_p, vector_ret_p;
4323 struct frame *f = check_x_frame (frame);
4324 Atom prop_atom;
4325 int rc;
4326 Lisp_Object prop_value = Qnil;
4327 unsigned char *tmp_data = NULL;
4328 Atom actual_type;
4329 Atom target_type = XA_STRING;
4330 int actual_format;
4331 unsigned long actual_size, bytes_remaining;
4332 Window target_window = FRAME_X_WINDOW (f);
4333 struct gcpro gcpro1;
4335 GCPRO1 (prop_value);
4336 CHECK_STRING (prop);
4338 if (! NILP (source))
4340 if (NUMBERP (source))
4342 if (FLOATP (source))
4343 target_window = (Window) XFLOAT (source);
4344 else
4345 target_window = XFASTINT (source);
4347 if (target_window == 0)
4348 target_window = FRAME_X_DISPLAY_INFO (f)->root_window;
4350 else if (CONSP (source))
4351 target_window = cons_to_long (source);
4354 BLOCK_INPUT;
4355 if (STRINGP (type))
4357 if (strcmp ("AnyPropertyType", SDATA (type)) == 0)
4358 target_type = AnyPropertyType;
4359 else
4360 target_type = XInternAtom (FRAME_X_DISPLAY (f), SDATA (type), False);
4363 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4364 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4365 prop_atom, 0, 0, False, target_type,
4366 &actual_type, &actual_format, &actual_size,
4367 &bytes_remaining, &tmp_data);
4368 if (rc == Success)
4370 int size = bytes_remaining;
4372 XFree (tmp_data);
4373 tmp_data = NULL;
4375 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4376 prop_atom, 0, bytes_remaining,
4377 ! NILP (delete_p), target_type,
4378 &actual_type, &actual_format,
4379 &actual_size, &bytes_remaining,
4380 &tmp_data);
4381 if (rc == Success && tmp_data)
4383 /* The man page for XGetWindowProperty says:
4384 "If the returned format is 32, the returned data is represented
4385 as a long array and should be cast to that type to obtain the
4386 elements."
4387 This applies even if long is more than 32 bits, the X library
4388 converts from 32 bit elements received from the X server to long
4389 and passes the long array to us. Thus, for that case bcopy can not
4390 be used. We convert to a 32 bit type here, because so much code
4391 assume on that.
4393 The bytes and offsets passed to XGetWindowProperty refers to the
4394 property and those are indeed in 32 bit quantities if format is
4395 32. */
4397 if (actual_format == 32 && actual_format < BITS_PER_LONG)
4399 unsigned long i;
4400 int *idata = (int *) tmp_data;
4401 long *ldata = (long *) tmp_data;
4403 for (i = 0; i < actual_size; ++i)
4404 idata[i] = (int) ldata[i];
4407 if (NILP (vector_ret_p))
4408 prop_value = make_string (tmp_data, size);
4409 else
4410 prop_value = x_property_data_to_lisp (f,
4411 tmp_data,
4412 actual_type,
4413 actual_format,
4414 actual_size);
4417 if (tmp_data) XFree (tmp_data);
4420 UNBLOCK_INPUT;
4421 UNGCPRO;
4422 return prop_value;
4427 /***********************************************************************
4428 Busy cursor
4429 ***********************************************************************/
4431 /* If non-null, an asynchronous timer that, when it expires, displays
4432 an hourglass cursor on all frames. */
4434 static struct atimer *hourglass_atimer;
4436 /* Non-zero means an hourglass cursor is currently shown. */
4438 static int hourglass_shown_p;
4440 /* Number of seconds to wait before displaying an hourglass cursor. */
4442 static Lisp_Object Vhourglass_delay;
4444 /* Default number of seconds to wait before displaying an hourglass
4445 cursor. */
4447 #define DEFAULT_HOURGLASS_DELAY 1
4449 /* Function prototypes. */
4451 static void show_hourglass P_ ((struct atimer *));
4452 static void hide_hourglass P_ ((void));
4454 /* Return non-zero if houglass timer has been started or hourglass is shown. */
4457 hourglass_started ()
4459 return hourglass_shown_p || hourglass_atimer != NULL;
4463 /* Cancel a currently active hourglass timer, and start a new one. */
4465 void
4466 start_hourglass ()
4468 EMACS_TIME delay;
4469 int secs, usecs = 0;
4471 /* Don't bother for ttys. */
4472 if (NILP (Vwindow_system))
4473 return;
4475 cancel_hourglass ();
4477 if (INTEGERP (Vhourglass_delay)
4478 && XINT (Vhourglass_delay) > 0)
4479 secs = XFASTINT (Vhourglass_delay);
4480 else if (FLOATP (Vhourglass_delay)
4481 && XFLOAT_DATA (Vhourglass_delay) > 0)
4483 Lisp_Object tem;
4484 tem = Ftruncate (Vhourglass_delay, Qnil);
4485 secs = XFASTINT (tem);
4486 usecs = (XFLOAT_DATA (Vhourglass_delay) - secs) * 1000000;
4488 else
4489 secs = DEFAULT_HOURGLASS_DELAY;
4491 EMACS_SET_SECS_USECS (delay, secs, usecs);
4492 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
4493 show_hourglass, NULL);
4497 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
4498 shown. */
4500 void
4501 cancel_hourglass ()
4503 if (hourglass_atimer)
4505 cancel_atimer (hourglass_atimer);
4506 hourglass_atimer = NULL;
4509 if (hourglass_shown_p)
4510 hide_hourglass ();
4514 /* Timer function of hourglass_atimer. TIMER is equal to
4515 hourglass_atimer.
4517 Display an hourglass pointer on all frames by mapping the frames'
4518 hourglass_window. Set the hourglass_p flag in the frames'
4519 output_data.x structure to indicate that an hourglass cursor is
4520 shown on the frames. */
4522 static void
4523 show_hourglass (timer)
4524 struct atimer *timer;
4526 /* The timer implementation will cancel this timer automatically
4527 after this function has run. Set hourglass_atimer to null
4528 so that we know the timer doesn't have to be canceled. */
4529 hourglass_atimer = NULL;
4531 if (!hourglass_shown_p)
4533 Lisp_Object rest, frame;
4535 BLOCK_INPUT;
4537 FOR_EACH_FRAME (rest, frame)
4539 struct frame *f = XFRAME (frame);
4541 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4543 Display *dpy = FRAME_X_DISPLAY (f);
4545 #ifdef USE_X_TOOLKIT
4546 if (f->output_data.x->widget)
4547 #else
4548 if (FRAME_OUTER_WINDOW (f))
4549 #endif
4551 f->output_data.x->hourglass_p = 1;
4553 if (!f->output_data.x->hourglass_window)
4555 unsigned long mask = CWCursor;
4556 XSetWindowAttributes attrs;
4557 #ifdef USE_GTK
4558 Window parent = FRAME_X_WINDOW (f);
4559 #else
4560 Window parent = FRAME_OUTER_WINDOW (f);
4561 #endif
4562 attrs.cursor = f->output_data.x->hourglass_cursor;
4564 f->output_data.x->hourglass_window
4565 = XCreateWindow (dpy, parent,
4566 0, 0, 32000, 32000, 0, 0,
4567 InputOnly,
4568 CopyFromParent,
4569 mask, &attrs);
4572 XMapRaised (dpy, f->output_data.x->hourglass_window);
4573 XFlush (dpy);
4578 hourglass_shown_p = 1;
4579 UNBLOCK_INPUT;
4584 /* Hide the hourglass pointer on all frames, if it is currently
4585 shown. */
4587 static void
4588 hide_hourglass ()
4590 if (hourglass_shown_p)
4592 Lisp_Object rest, frame;
4594 BLOCK_INPUT;
4595 FOR_EACH_FRAME (rest, frame)
4597 struct frame *f = XFRAME (frame);
4599 if (FRAME_X_P (f)
4600 /* Watch out for newly created frames. */
4601 && f->output_data.x->hourglass_window)
4603 XUnmapWindow (FRAME_X_DISPLAY (f),
4604 f->output_data.x->hourglass_window);
4605 /* Sync here because XTread_socket looks at the
4606 hourglass_p flag that is reset to zero below. */
4607 XSync (FRAME_X_DISPLAY (f), False);
4608 f->output_data.x->hourglass_p = 0;
4612 hourglass_shown_p = 0;
4613 UNBLOCK_INPUT;
4619 /***********************************************************************
4620 Tool tips
4621 ***********************************************************************/
4623 static Lisp_Object x_create_tip_frame P_ ((struct x_display_info *,
4624 Lisp_Object, Lisp_Object));
4625 static void compute_tip_xy P_ ((struct frame *, Lisp_Object, Lisp_Object,
4626 Lisp_Object, int, int, int *, int *));
4628 /* The frame of a currently visible tooltip. */
4630 Lisp_Object tip_frame;
4632 /* If non-nil, a timer started that hides the last tooltip when it
4633 fires. */
4635 Lisp_Object tip_timer;
4636 Window tip_window;
4638 /* If non-nil, a vector of 3 elements containing the last args
4639 with which x-show-tip was called. See there. */
4641 Lisp_Object last_show_tip_args;
4643 /* Maximum size for tooltips; a cons (COLUMNS . ROWS). */
4645 Lisp_Object Vx_max_tooltip_size;
4648 static Lisp_Object
4649 unwind_create_tip_frame (frame)
4650 Lisp_Object frame;
4652 Lisp_Object deleted;
4654 deleted = unwind_create_frame (frame);
4655 if (EQ (deleted, Qt))
4657 tip_window = None;
4658 tip_frame = Qnil;
4661 return deleted;
4665 /* Create a frame for a tooltip on the display described by DPYINFO.
4666 PARMS is a list of frame parameters. TEXT is the string to
4667 display in the tip frame. Value is the frame.
4669 Note that functions called here, esp. x_default_parameter can
4670 signal errors, for instance when a specified color name is
4671 undefined. We have to make sure that we're in a consistent state
4672 when this happens. */
4674 static Lisp_Object
4675 x_create_tip_frame (dpyinfo, parms, text)
4676 struct x_display_info *dpyinfo;
4677 Lisp_Object parms, text;
4679 struct frame *f;
4680 Lisp_Object frame, tem;
4681 Lisp_Object name;
4682 long window_prompting = 0;
4683 int width, height;
4684 int count = SPECPDL_INDEX ();
4685 struct gcpro gcpro1, gcpro2, gcpro3;
4686 struct kboard *kb;
4687 int face_change_count_before = face_change_count;
4688 Lisp_Object buffer;
4689 struct buffer *old_buffer;
4691 check_x ();
4693 parms = Fcopy_alist (parms);
4695 #ifdef MULTI_KBOARD
4696 kb = dpyinfo->kboard;
4697 #else
4698 kb = &the_only_kboard;
4699 #endif
4701 /* Get the name of the frame to use for resource lookup. */
4702 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4703 if (!STRINGP (name)
4704 && !EQ (name, Qunbound)
4705 && !NILP (name))
4706 error ("Invalid frame name--not a string or nil");
4708 frame = Qnil;
4709 GCPRO3 (parms, name, frame);
4710 f = make_frame (1);
4711 XSETFRAME (frame, f);
4713 buffer = Fget_buffer_create (build_string (" *tip*"));
4714 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer, Qnil);
4715 old_buffer = current_buffer;
4716 set_buffer_internal_1 (XBUFFER (buffer));
4717 current_buffer->truncate_lines = Qnil;
4718 specbind (Qinhibit_read_only, Qt);
4719 specbind (Qinhibit_modification_hooks, Qt);
4720 Ferase_buffer ();
4721 Finsert (1, &text);
4722 set_buffer_internal_1 (old_buffer);
4724 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
4725 record_unwind_protect (unwind_create_tip_frame, frame);
4727 /* By setting the output method, we're essentially saying that
4728 the frame is live, as per FRAME_LIVE_P. If we get a signal
4729 from this point on, x_destroy_window might screw up reference
4730 counts etc. */
4731 f->output_method = output_x_window;
4732 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4733 bzero (f->output_data.x, sizeof (struct x_output));
4734 f->output_data.x->icon_bitmap = -1;
4735 FRAME_FONTSET (f) = -1;
4736 f->output_data.x->scroll_bar_foreground_pixel = -1;
4737 f->output_data.x->scroll_bar_background_pixel = -1;
4738 #ifdef USE_TOOLKIT_SCROLL_BARS
4739 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
4740 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
4741 #endif /* USE_TOOLKIT_SCROLL_BARS */
4742 f->icon_name = Qnil;
4743 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4744 #if GLYPH_DEBUG
4745 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
4746 dpyinfo_refcount = dpyinfo->reference_count;
4747 #endif /* GLYPH_DEBUG */
4748 #ifdef MULTI_KBOARD
4749 FRAME_KBOARD (f) = kb;
4750 #endif
4751 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4752 f->output_data.x->explicit_parent = 0;
4754 /* These colors will be set anyway later, but it's important
4755 to get the color reference counts right, so initialize them! */
4757 Lisp_Object black;
4758 struct gcpro gcpro1;
4760 black = build_string ("black");
4761 GCPRO1 (black);
4762 f->output_data.x->foreground_pixel
4763 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4764 f->output_data.x->background_pixel
4765 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4766 f->output_data.x->cursor_pixel
4767 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4768 f->output_data.x->cursor_foreground_pixel
4769 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4770 f->output_data.x->border_pixel
4771 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4772 f->output_data.x->mouse_pixel
4773 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4774 UNGCPRO;
4777 /* Set the name; the functions to which we pass f expect the name to
4778 be set. */
4779 if (EQ (name, Qunbound) || NILP (name))
4781 f->name = build_string (dpyinfo->x_id_name);
4782 f->explicit_name = 0;
4784 else
4786 f->name = name;
4787 f->explicit_name = 1;
4788 /* use the frame's title when getting resources for this frame. */
4789 specbind (Qx_resource_name, name);
4792 /* Extract the window parameters from the supplied values that are
4793 needed to determine window geometry. */
4795 Lisp_Object font;
4797 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4799 BLOCK_INPUT;
4800 /* First, try whatever font the caller has specified. */
4801 if (STRINGP (font))
4803 tem = Fquery_fontset (font, Qnil);
4804 if (STRINGP (tem))
4805 font = x_new_fontset (f, SDATA (tem));
4806 else
4807 font = x_new_font (f, SDATA (font));
4810 /* Try out a font which we hope has bold and italic variations. */
4811 if (!STRINGP (font))
4812 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
4813 if (!STRINGP (font))
4814 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4815 if (! STRINGP (font))
4816 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4817 if (! STRINGP (font))
4818 /* This was formerly the first thing tried, but it finds too many fonts
4819 and takes too long. */
4820 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
4821 /* If those didn't work, look for something which will at least work. */
4822 if (! STRINGP (font))
4823 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
4824 UNBLOCK_INPUT;
4825 if (! STRINGP (font))
4826 font = build_string ("fixed");
4828 x_default_parameter (f, parms, Qfont, font,
4829 "font", "Font", RES_TYPE_STRING);
4832 x_default_parameter (f, parms, Qborder_width, make_number (2),
4833 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4835 /* This defaults to 2 in order to match xterm. We recognize either
4836 internalBorderWidth or internalBorder (which is what xterm calls
4837 it). */
4838 if (NILP (Fassq (Qinternal_border_width, parms)))
4840 Lisp_Object value;
4842 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4843 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4844 if (! EQ (value, Qunbound))
4845 parms = Fcons (Fcons (Qinternal_border_width, value),
4846 parms);
4849 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4850 "internalBorderWidth", "internalBorderWidth",
4851 RES_TYPE_NUMBER);
4853 /* Also do the stuff which must be set before the window exists. */
4854 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4855 "foreground", "Foreground", RES_TYPE_STRING);
4856 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4857 "background", "Background", RES_TYPE_STRING);
4858 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4859 "pointerColor", "Foreground", RES_TYPE_STRING);
4860 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4861 "cursorColor", "Foreground", RES_TYPE_STRING);
4862 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4863 "borderColor", "BorderColor", RES_TYPE_STRING);
4865 /* Init faces before x_default_parameter is called for scroll-bar
4866 parameters because that function calls x_set_scroll_bar_width,
4867 which calls change_frame_size, which calls Fset_window_buffer,
4868 which runs hooks, which call Fvertical_motion. At the end, we
4869 end up in init_iterator with a null face cache, which should not
4870 happen. */
4871 init_frame_faces (f);
4873 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4875 window_prompting = x_figure_window_size (f, parms, 0);
4878 XSetWindowAttributes attrs;
4879 unsigned long mask;
4881 BLOCK_INPUT;
4882 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
4883 if (DoesSaveUnders (dpyinfo->screen))
4884 mask |= CWSaveUnder;
4886 /* Window managers look at the override-redirect flag to determine
4887 whether or net to give windows a decoration (Xlib spec, chapter
4888 3.2.8). */
4889 attrs.override_redirect = True;
4890 attrs.save_under = True;
4891 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4892 /* Arrange for getting MapNotify and UnmapNotify events. */
4893 attrs.event_mask = StructureNotifyMask;
4894 tip_window
4895 = FRAME_X_WINDOW (f)
4896 = XCreateWindow (FRAME_X_DISPLAY (f),
4897 FRAME_X_DISPLAY_INFO (f)->root_window,
4898 /* x, y, width, height */
4899 0, 0, 1, 1,
4900 /* Border. */
4902 CopyFromParent, InputOutput, CopyFromParent,
4903 mask, &attrs);
4904 UNBLOCK_INPUT;
4907 x_make_gc (f);
4909 x_default_parameter (f, parms, Qauto_raise, Qnil,
4910 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4911 x_default_parameter (f, parms, Qauto_lower, Qnil,
4912 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4913 x_default_parameter (f, parms, Qcursor_type, Qbox,
4914 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4916 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4917 Change will not be effected unless different from the current
4918 FRAME_LINES (f). */
4919 width = FRAME_COLS (f);
4920 height = FRAME_LINES (f);
4921 SET_FRAME_COLS (f, 0);
4922 FRAME_LINES (f) = 0;
4923 change_frame_size (f, height, width, 1, 0, 0);
4925 /* Add `tooltip' frame parameter's default value. */
4926 if (NILP (Fframe_parameter (frame, intern ("tooltip"))))
4927 Fmodify_frame_parameters (frame, Fcons (Fcons (intern ("tooltip"), Qt),
4928 Qnil));
4930 /* FIXME - can this be done in a similar way to normal frames?
4931 http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00641.html */
4933 /* Set the `display-type' frame parameter before setting up faces. */
4935 Lisp_Object disptype;
4937 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
4938 disptype = intern ("mono");
4939 else if (FRAME_X_DISPLAY_INFO (f)->visual->class == GrayScale
4940 || FRAME_X_DISPLAY_INFO (f)->visual->class == StaticGray)
4941 disptype = intern ("grayscale");
4942 else
4943 disptype = intern ("color");
4945 if (NILP (Fframe_parameter (frame, Qdisplay_type)))
4946 Fmodify_frame_parameters (frame, Fcons (Fcons (Qdisplay_type, disptype),
4947 Qnil));
4950 /* Set up faces after all frame parameters are known. This call
4951 also merges in face attributes specified for new frames.
4953 Frame parameters may be changed if .Xdefaults contains
4954 specifications for the default font. For example, if there is an
4955 `Emacs.default.attributeBackground: pink', the `background-color'
4956 attribute of the frame get's set, which let's the internal border
4957 of the tooltip frame appear in pink. Prevent this. */
4959 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
4961 /* Set tip_frame here, so that */
4962 tip_frame = frame;
4963 call1 (Qface_set_after_frame_default, frame);
4965 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
4966 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
4967 Qnil));
4970 f->no_split = 1;
4972 UNGCPRO;
4974 /* It is now ok to make the frame official even if we get an error
4975 below. And the frame needs to be on Vframe_list or making it
4976 visible won't work. */
4977 Vframe_list = Fcons (frame, Vframe_list);
4979 /* Now that the frame is official, it counts as a reference to
4980 its display. */
4981 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4983 /* Setting attributes of faces of the tooltip frame from resources
4984 and similar will increment face_change_count, which leads to the
4985 clearing of all current matrices. Since this isn't necessary
4986 here, avoid it by resetting face_change_count to the value it
4987 had before we created the tip frame. */
4988 face_change_count = face_change_count_before;
4990 /* Discard the unwind_protect. */
4991 return unbind_to (count, frame);
4995 /* Compute where to display tip frame F. PARMS is the list of frame
4996 parameters for F. DX and DY are specified offsets from the current
4997 location of the mouse. WIDTH and HEIGHT are the width and height
4998 of the tooltip. Return coordinates relative to the root window of
4999 the display in *ROOT_X, and *ROOT_Y. */
5001 static void
5002 compute_tip_xy (f, parms, dx, dy, width, height, root_x, root_y)
5003 struct frame *f;
5004 Lisp_Object parms, dx, dy;
5005 int width, height;
5006 int *root_x, *root_y;
5008 Lisp_Object left, top;
5009 int win_x, win_y;
5010 Window root, child;
5011 unsigned pmask;
5013 /* User-specified position? */
5014 left = Fcdr (Fassq (Qleft, parms));
5015 top = Fcdr (Fassq (Qtop, parms));
5017 /* Move the tooltip window where the mouse pointer is. Resize and
5018 show it. */
5019 if (!INTEGERP (left) || !INTEGERP (top))
5021 BLOCK_INPUT;
5022 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
5023 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
5024 UNBLOCK_INPUT;
5027 if (INTEGERP (top))
5028 *root_y = XINT (top);
5029 else if (*root_y + XINT (dy) <= 0)
5030 *root_y = 0; /* Can happen for negative dy */
5031 else if (*root_y + XINT (dy) + height <= FRAME_X_DISPLAY_INFO (f)->height)
5032 /* It fits below the pointer */
5033 *root_y += XINT (dy);
5034 else if (height + XINT (dy) <= *root_y)
5035 /* It fits above the pointer. */
5036 *root_y -= height + XINT (dy);
5037 else
5038 /* Put it on the top. */
5039 *root_y = 0;
5041 if (INTEGERP (left))
5042 *root_x = XINT (left);
5043 else if (*root_x + XINT (dx) <= 0)
5044 *root_x = 0; /* Can happen for negative dx */
5045 else if (*root_x + XINT (dx) + width <= FRAME_X_DISPLAY_INFO (f)->width)
5046 /* It fits to the right of the pointer. */
5047 *root_x += XINT (dx);
5048 else if (width + XINT (dx) <= *root_x)
5049 /* It fits to the left of the pointer. */
5050 *root_x -= width + XINT (dx);
5051 else
5052 /* Put it left-justified on the screen--it ought to fit that way. */
5053 *root_x = 0;
5057 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5058 doc: /* Show STRING in a "tooltip" window on frame FRAME.
5059 A tooltip window is a small X window displaying a string.
5061 This is an internal function; Lisp code should call `tooltip-show'.
5063 FRAME nil or omitted means use the selected frame.
5065 PARMS is an optional list of frame parameters which can be used to
5066 change the tooltip's appearance.
5068 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5069 means use the default timeout of 5 seconds.
5071 If the list of frame parameters PARAMS contains a `left' parameters,
5072 the tooltip is displayed at that x-position. Otherwise it is
5073 displayed at the mouse position, with offset DX added (default is 5 if
5074 DX isn't specified). Likewise for the y-position; if a `top' frame
5075 parameter is specified, it determines the y-position of the tooltip
5076 window, otherwise it is displayed at the mouse position, with offset
5077 DY added (default is -10).
5079 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5080 Text larger than the specified size is clipped. */)
5081 (string, frame, parms, timeout, dx, dy)
5082 Lisp_Object string, frame, parms, timeout, dx, dy;
5084 struct frame *f;
5085 struct window *w;
5086 int root_x, root_y;
5087 struct buffer *old_buffer;
5088 struct text_pos pos;
5089 int i, width, height;
5090 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5091 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5092 int count = SPECPDL_INDEX ();
5094 specbind (Qinhibit_redisplay, Qt);
5096 GCPRO4 (string, parms, frame, timeout);
5098 CHECK_STRING (string);
5099 f = check_x_frame (frame);
5100 if (NILP (timeout))
5101 timeout = make_number (5);
5102 else
5103 CHECK_NATNUM (timeout);
5105 if (NILP (dx))
5106 dx = make_number (5);
5107 else
5108 CHECK_NUMBER (dx);
5110 if (NILP (dy))
5111 dy = make_number (-10);
5112 else
5113 CHECK_NUMBER (dy);
5115 if (NILP (last_show_tip_args))
5116 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5118 if (!NILP (tip_frame))
5120 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5121 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5122 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5124 if (EQ (frame, last_frame)
5125 && !NILP (Fequal (last_string, string))
5126 && !NILP (Fequal (last_parms, parms)))
5128 struct frame *f = XFRAME (tip_frame);
5130 /* Only DX and DY have changed. */
5131 if (!NILP (tip_timer))
5133 Lisp_Object timer = tip_timer;
5134 tip_timer = Qnil;
5135 call1 (Qcancel_timer, timer);
5138 BLOCK_INPUT;
5139 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
5140 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
5141 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5142 root_x, root_y);
5143 UNBLOCK_INPUT;
5144 goto start_timer;
5148 /* Hide a previous tip, if any. */
5149 Fx_hide_tip ();
5151 ASET (last_show_tip_args, 0, string);
5152 ASET (last_show_tip_args, 1, frame);
5153 ASET (last_show_tip_args, 2, parms);
5155 /* Add default values to frame parameters. */
5156 if (NILP (Fassq (Qname, parms)))
5157 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5158 if (NILP (Fassq (Qinternal_border_width, parms)))
5159 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5160 if (NILP (Fassq (Qborder_width, parms)))
5161 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5162 if (NILP (Fassq (Qborder_color, parms)))
5163 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5164 if (NILP (Fassq (Qbackground_color, parms)))
5165 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5166 parms);
5168 /* Create a frame for the tooltip, and record it in the global
5169 variable tip_frame. */
5170 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
5171 f = XFRAME (frame);
5173 /* Set up the frame's root window. */
5174 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5175 w->left_col = w->top_line = make_number (0);
5177 if (CONSP (Vx_max_tooltip_size)
5178 && INTEGERP (XCAR (Vx_max_tooltip_size))
5179 && XINT (XCAR (Vx_max_tooltip_size)) > 0
5180 && INTEGERP (XCDR (Vx_max_tooltip_size))
5181 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
5183 w->total_cols = XCAR (Vx_max_tooltip_size);
5184 w->total_lines = XCDR (Vx_max_tooltip_size);
5186 else
5188 w->total_cols = make_number (80);
5189 w->total_lines = make_number (40);
5192 FRAME_TOTAL_COLS (f) = XINT (w->total_cols);
5193 adjust_glyphs (f);
5194 w->pseudo_window_p = 1;
5196 /* Display the tooltip text in a temporary buffer. */
5197 old_buffer = current_buffer;
5198 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
5199 current_buffer->truncate_lines = Qnil;
5200 clear_glyph_matrix (w->desired_matrix);
5201 clear_glyph_matrix (w->current_matrix);
5202 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5203 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5205 /* Compute width and height of the tooltip. */
5206 width = height = 0;
5207 for (i = 0; i < w->desired_matrix->nrows; ++i)
5209 struct glyph_row *row = &w->desired_matrix->rows[i];
5210 struct glyph *last;
5211 int row_width;
5213 /* Stop at the first empty row at the end. */
5214 if (!row->enabled_p || !row->displays_text_p)
5215 break;
5217 /* Let the row go over the full width of the frame. */
5218 row->full_width_p = 1;
5220 /* There's a glyph at the end of rows that is used to place
5221 the cursor there. Don't include the width of this glyph. */
5222 if (row->used[TEXT_AREA])
5224 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5225 row_width = row->pixel_width - last->pixel_width;
5227 else
5228 row_width = row->pixel_width;
5230 height += row->height;
5231 width = max (width, row_width);
5234 /* Add the frame's internal border to the width and height the X
5235 window should have. */
5236 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5237 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5239 /* Move the tooltip window where the mouse pointer is. Resize and
5240 show it. */
5241 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5243 BLOCK_INPUT;
5244 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5245 root_x, root_y, width, height);
5246 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5247 UNBLOCK_INPUT;
5249 /* Draw into the window. */
5250 w->must_be_updated_p = 1;
5251 update_single_window (w, 1);
5253 /* Restore original current buffer. */
5254 set_buffer_internal_1 (old_buffer);
5255 windows_or_buffers_changed = old_windows_or_buffers_changed;
5257 start_timer:
5258 /* Let the tip disappear after timeout seconds. */
5259 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5260 intern ("x-hide-tip"));
5262 UNGCPRO;
5263 return unbind_to (count, Qnil);
5267 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5268 doc: /* Hide the current tooltip window, if there is any.
5269 Value is t if tooltip was open, nil otherwise. */)
5272 int count;
5273 Lisp_Object deleted, frame, timer;
5274 struct gcpro gcpro1, gcpro2;
5276 /* Return quickly if nothing to do. */
5277 if (NILP (tip_timer) && NILP (tip_frame))
5278 return Qnil;
5280 frame = tip_frame;
5281 timer = tip_timer;
5282 GCPRO2 (frame, timer);
5283 tip_frame = tip_timer = deleted = Qnil;
5285 count = SPECPDL_INDEX ();
5286 specbind (Qinhibit_redisplay, Qt);
5287 specbind (Qinhibit_quit, Qt);
5289 if (!NILP (timer))
5290 call1 (Qcancel_timer, timer);
5292 if (FRAMEP (frame))
5294 Fdelete_frame (frame, Qnil);
5295 deleted = Qt;
5297 #ifdef USE_LUCID
5298 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5299 redisplay procedure is not called when a tip frame over menu
5300 items is unmapped. Redisplay the menu manually... */
5302 struct frame *f = SELECTED_FRAME ();
5303 Widget w = f->output_data.x->menubar_widget;
5304 extern void xlwmenu_redisplay P_ ((Widget));
5306 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
5307 && w != NULL)
5309 BLOCK_INPUT;
5310 xlwmenu_redisplay (w);
5311 UNBLOCK_INPUT;
5314 #endif /* USE_LUCID */
5317 UNGCPRO;
5318 return unbind_to (count, deleted);
5323 /***********************************************************************
5324 File selection dialog
5325 ***********************************************************************/
5327 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5328 Sx_uses_old_gtk_dialog,
5329 0, 0, 0,
5330 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5333 #ifdef USE_GTK
5334 extern int use_dialog_box;
5335 extern int use_file_dialog;
5337 if (use_dialog_box
5338 && use_file_dialog
5339 && have_menus_p ()
5340 && xg_uses_old_file_dialog ())
5341 return Qt;
5342 #endif
5343 return Qnil;
5347 #ifdef USE_MOTIF
5348 /* Callback for "OK" and "Cancel" on file selection dialog. */
5350 static void
5351 file_dialog_cb (widget, client_data, call_data)
5352 Widget widget;
5353 XtPointer call_data, client_data;
5355 int *result = (int *) client_data;
5356 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
5357 *result = cb->reason;
5361 /* Callback for unmapping a file selection dialog. This is used to
5362 capture the case where a dialog is closed via a window manager's
5363 closer button, for example. Using a XmNdestroyCallback didn't work
5364 in this case. */
5366 static void
5367 file_dialog_unmap_cb (widget, client_data, call_data)
5368 Widget widget;
5369 XtPointer call_data, client_data;
5371 int *result = (int *) client_data;
5372 *result = XmCR_CANCEL;
5375 static Lisp_Object
5376 clean_up_file_dialog (arg)
5377 Lisp_Object arg;
5379 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
5380 Widget dialog = (Widget) p->pointer;
5382 /* Clean up. */
5383 BLOCK_INPUT;
5384 XtUnmanageChild (dialog);
5385 XtDestroyWidget (dialog);
5386 x_menu_set_in_use (0);
5387 UNBLOCK_INPUT;
5389 return Qnil;
5393 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5394 doc: /* Read file name, prompting with PROMPT in directory DIR.
5395 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5396 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5397 or directory must exist. ONLY-DIR-P is ignored." */)
5398 (prompt, dir, default_filename, mustmatch, only_dir_p)
5399 Lisp_Object prompt, dir, default_filename, mustmatch, only_dir_p;
5401 int result;
5402 struct frame *f = SELECTED_FRAME ();
5403 Lisp_Object file = Qnil;
5404 Lisp_Object decoded_file;
5405 Widget dialog, text, help;
5406 Arg al[10];
5407 int ac = 0;
5408 extern XtAppContext Xt_app_con;
5409 XmString dir_xmstring, pattern_xmstring;
5410 int count = SPECPDL_INDEX ();
5411 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5413 check_x ();
5415 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5417 if (popup_activated ())
5418 error ("Trying to use a menu from within a menu-entry");
5420 CHECK_STRING (prompt);
5421 CHECK_STRING (dir);
5423 /* Prevent redisplay. */
5424 specbind (Qinhibit_redisplay, Qt);
5426 BLOCK_INPUT;
5428 /* Create the dialog with PROMPT as title, using DIR as initial
5429 directory and using "*" as pattern. */
5430 dir = Fexpand_file_name (dir, Qnil);
5431 dir_xmstring = XmStringCreateLocalized (SDATA (dir));
5432 pattern_xmstring = XmStringCreateLocalized ("*");
5434 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5435 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5436 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5437 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5438 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5439 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5440 "fsb", al, ac);
5441 XmStringFree (dir_xmstring);
5442 XmStringFree (pattern_xmstring);
5444 /* Add callbacks for OK and Cancel. */
5445 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5446 (XtPointer) &result);
5447 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5448 (XtPointer) &result);
5449 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5450 (XtPointer) &result);
5452 /* Remove the help button since we can't display help. */
5453 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5454 XtUnmanageChild (help);
5456 /* Mark OK button as default. */
5457 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5458 XmNshowAsDefault, True, NULL);
5460 /* If MUSTMATCH is non-nil, disable the file entry field of the
5461 dialog, so that the user must select a file from the files list
5462 box. We can't remove it because we wouldn't have a way to get at
5463 the result file name, then. */
5464 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5465 if (!NILP (mustmatch))
5467 Widget label;
5468 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5469 XtSetSensitive (text, False);
5470 XtSetSensitive (label, False);
5473 /* Manage the dialog, so that list boxes get filled. */
5474 XtManageChild (dialog);
5476 if (STRINGP (default_filename))
5478 XmString default_xmstring;
5479 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5480 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5482 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5483 XmTextFieldReplace (wtext, 0, last_pos,
5484 (SDATA (Ffile_name_nondirectory (default_filename))));
5486 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5487 must include the path for this to work. */
5489 default_xmstring = XmStringCreateLocalized (SDATA (default_filename));
5491 if (XmListItemExists (list, default_xmstring))
5493 int item_pos = XmListItemPos (list, default_xmstring);
5494 /* Select the item and scroll it into view. */
5495 XmListSelectPos (list, item_pos, True);
5496 XmListSetPos (list, item_pos);
5499 XmStringFree (default_xmstring);
5502 record_unwind_protect (clean_up_file_dialog, make_save_value (dialog, 0));
5504 /* Process events until the user presses Cancel or OK. */
5505 x_menu_set_in_use (1);
5506 result = 0;
5507 while (result == 0)
5509 XEvent event;
5510 x_menu_wait_for_event (0);
5511 XtAppNextEvent (Xt_app_con, &event);
5512 if (event.type == KeyPress
5513 && FRAME_X_DISPLAY (f) == event.xkey.display)
5515 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5517 /* Pop down on C-g. */
5518 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5519 XtUnmanageChild (dialog);
5522 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5525 /* Get the result. */
5526 if (result == XmCR_OK)
5528 XmString text;
5529 String data;
5531 XtVaGetValues (dialog, XmNtextString, &text, NULL);
5532 XmStringGetLtoR (text, XmFONTLIST_DEFAULT_TAG, &data);
5533 XmStringFree (text);
5534 file = build_string (data);
5535 XtFree (data);
5537 else
5538 file = Qnil;
5540 UNBLOCK_INPUT;
5541 UNGCPRO;
5543 /* Make "Cancel" equivalent to C-g. */
5544 if (NILP (file))
5545 Fsignal (Qquit, Qnil);
5547 decoded_file = DECODE_FILE (file);
5549 return unbind_to (count, decoded_file);
5552 #endif /* USE_MOTIF */
5554 #ifdef USE_GTK
5556 static Lisp_Object
5557 clean_up_dialog (arg)
5558 Lisp_Object arg;
5560 x_menu_set_in_use (0);
5562 return Qnil;
5565 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5566 doc: /* Read file name, prompting with PROMPT in directory DIR.
5567 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5568 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5569 or directory must exist. If ONLY-DIR-P is non-nil, the user can only select
5570 directories. */)
5571 (prompt, dir, default_filename, mustmatch, only_dir_p)
5572 Lisp_Object prompt, dir, default_filename, mustmatch, only_dir_p;
5574 FRAME_PTR f = SELECTED_FRAME ();
5575 char *fn;
5576 Lisp_Object file = Qnil;
5577 Lisp_Object decoded_file;
5578 int count = SPECPDL_INDEX ();
5579 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5580 char *cdef_file;
5582 check_x ();
5584 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5586 if (popup_activated ())
5587 error ("Trying to use a menu from within a menu-entry");
5589 CHECK_STRING (prompt);
5590 CHECK_STRING (dir);
5592 /* Prevent redisplay. */
5593 specbind (Qinhibit_redisplay, Qt);
5594 record_unwind_protect (clean_up_dialog, Qnil);
5596 BLOCK_INPUT;
5598 if (STRINGP (default_filename))
5599 cdef_file = SDATA (default_filename);
5600 else
5601 cdef_file = SDATA (dir);
5603 fn = xg_get_file_name (f, SDATA (prompt), cdef_file,
5604 ! NILP (mustmatch),
5605 ! NILP (only_dir_p));
5607 if (fn)
5609 file = build_string (fn);
5610 xfree (fn);
5613 UNBLOCK_INPUT;
5614 UNGCPRO;
5616 /* Make "Cancel" equivalent to C-g. */
5617 if (NILP (file))
5618 Fsignal (Qquit, Qnil);
5620 decoded_file = DECODE_FILE (file);
5622 return unbind_to (count, decoded_file);
5625 #endif /* USE_GTK */
5628 /***********************************************************************
5629 Keyboard
5630 ***********************************************************************/
5632 #ifdef HAVE_XKBGETKEYBOARD
5633 #include <X11/XKBlib.h>
5634 #include <X11/keysym.h>
5635 #endif
5637 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
5638 Sx_backspace_delete_keys_p, 0, 1, 0,
5639 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
5640 FRAME nil means use the selected frame.
5641 Value is t if we know that both keys are present, and are mapped to the
5642 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
5643 present and mapped to the usual X keysyms. */)
5644 (frame)
5645 Lisp_Object frame;
5647 #ifdef HAVE_XKBGETKEYBOARD
5648 XkbDescPtr kb;
5649 struct frame *f = check_x_frame (frame);
5650 Display *dpy = FRAME_X_DISPLAY (f);
5651 Lisp_Object have_keys;
5652 int major, minor, op, event, error;
5654 BLOCK_INPUT;
5656 /* Check library version in case we're dynamically linked. */
5657 major = XkbMajorVersion;
5658 minor = XkbMinorVersion;
5659 if (!XkbLibraryVersion (&major, &minor))
5661 UNBLOCK_INPUT;
5662 return Qlambda;
5665 /* Check that the server supports XKB. */
5666 major = XkbMajorVersion;
5667 minor = XkbMinorVersion;
5668 if (!XkbQueryExtension (dpy, &op, &event, &error, &major, &minor))
5670 UNBLOCK_INPUT;
5671 return Qlambda;
5674 /* In this code we check that the keyboard has physical keys with names
5675 that start with BKSP (Backspace) and DELE (Delete), and that they
5676 generate keysym XK_BackSpace and XK_Delete respectively.
5677 This function is used to test if normal-erase-is-backspace should be
5678 turned on.
5679 An alternative approach would be to just check if XK_BackSpace and
5680 XK_Delete are mapped to any key. But if any of those are mapped to
5681 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
5682 user doesn't know about it, it is better to return false here.
5683 It is more obvious to the user what to do if she/he has two keys
5684 clearly marked with names/symbols and one key does something not
5685 expected (i.e. she/he then tries the other).
5686 The cases where Backspace/Delete is mapped to some other key combination
5687 are rare, and in those cases, normal-erase-is-backspace can be turned on
5688 manually. */
5690 have_keys = Qnil;
5691 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
5692 if (kb)
5694 int delete_keycode = 0, backspace_keycode = 0, i;
5696 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
5698 for (i = kb->min_key_code;
5699 (i < kb->max_key_code
5700 && (delete_keycode == 0 || backspace_keycode == 0));
5701 ++i)
5703 /* The XKB symbolic key names can be seen most easily in
5704 the PS file generated by `xkbprint -label name
5705 $DISPLAY'. */
5706 if (bcmp ("DELE", kb->names->keys[i].name, 4) == 0)
5707 delete_keycode = i;
5708 else if (bcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
5709 backspace_keycode = i;
5712 XkbFreeNames (kb, 0, True);
5715 XkbFreeClientMap (kb, 0, True);
5717 if (delete_keycode
5718 && backspace_keycode
5719 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
5720 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
5721 have_keys = Qt;
5723 UNBLOCK_INPUT;
5724 return have_keys;
5725 #else /* not HAVE_XKBGETKEYBOARD */
5726 return Qlambda;
5727 #endif /* not HAVE_XKBGETKEYBOARD */
5732 /***********************************************************************
5733 Initialization
5734 ***********************************************************************/
5736 /* Keep this list in the same order as frame_parms in frame.c.
5737 Use 0 for unsupported frame parameters. */
5739 frame_parm_handler x_frame_parm_handlers[] =
5741 x_set_autoraise,
5742 x_set_autolower,
5743 x_set_background_color,
5744 x_set_border_color,
5745 x_set_border_width,
5746 x_set_cursor_color,
5747 x_set_cursor_type,
5748 x_set_font,
5749 x_set_foreground_color,
5750 x_set_icon_name,
5751 x_set_icon_type,
5752 x_set_internal_border_width,
5753 x_set_menu_bar_lines,
5754 x_set_mouse_color,
5755 x_explicitly_set_name,
5756 x_set_scroll_bar_width,
5757 x_set_title,
5758 x_set_unsplittable,
5759 x_set_vertical_scroll_bars,
5760 x_set_visibility,
5761 x_set_tool_bar_lines,
5762 x_set_scroll_bar_foreground,
5763 x_set_scroll_bar_background,
5764 x_set_screen_gamma,
5765 x_set_line_spacing,
5766 x_set_fringe_width,
5767 x_set_fringe_width,
5768 x_set_wait_for_wm,
5769 x_set_fullscreen,
5772 void
5773 syms_of_xfns ()
5775 /* This is zero if not using X windows. */
5776 x_in_use = 0;
5778 /* The section below is built by the lisp expression at the top of the file,
5779 just above where these variables are declared. */
5780 /*&&& init symbols here &&&*/
5781 Qnone = intern ("none");
5782 staticpro (&Qnone);
5783 Qsuppress_icon = intern ("suppress-icon");
5784 staticpro (&Qsuppress_icon);
5785 Qundefined_color = intern ("undefined-color");
5786 staticpro (&Qundefined_color);
5787 Qcompound_text = intern ("compound-text");
5788 staticpro (&Qcompound_text);
5789 Qcancel_timer = intern ("cancel-timer");
5790 staticpro (&Qcancel_timer);
5791 /* This is the end of symbol initialization. */
5793 /* Text property `display' should be nonsticky by default. */
5794 Vtext_property_default_nonsticky
5795 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
5798 Fput (Qundefined_color, Qerror_conditions,
5799 Fcons (Qundefined_color, Fcons (Qerror, Qnil)));
5800 Fput (Qundefined_color, Qerror_message,
5801 build_string ("Undefined color"));
5803 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
5804 doc: /* The shape of the pointer when over text.
5805 Changing the value does not affect existing frames
5806 unless you set the mouse color. */);
5807 Vx_pointer_shape = Qnil;
5809 #if 0 /* This doesn't really do anything. */
5810 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape,
5811 doc: /* The shape of the pointer when not over text.
5812 This variable takes effect when you create a new frame
5813 or when you set the mouse color. */);
5814 #endif
5815 Vx_nontext_pointer_shape = Qnil;
5817 DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape,
5818 doc: /* The shape of the pointer when Emacs is busy.
5819 This variable takes effect when you create a new frame
5820 or when you set the mouse color. */);
5821 Vx_hourglass_pointer_shape = Qnil;
5823 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p,
5824 doc: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
5825 display_hourglass_p = 1;
5827 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay,
5828 doc: /* *Seconds to wait before displaying an hourglass pointer.
5829 Value must be an integer or float. */);
5830 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
5832 #if 0 /* This doesn't really do anything. */
5833 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape,
5834 doc: /* The shape of the pointer when over the mode line.
5835 This variable takes effect when you create a new frame
5836 or when you set the mouse color. */);
5837 #endif
5838 Vx_mode_pointer_shape = Qnil;
5840 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
5841 &Vx_sensitive_text_pointer_shape,
5842 doc: /* The shape of the pointer when over mouse-sensitive text.
5843 This variable takes effect when you create a new frame
5844 or when you set the mouse color. */);
5845 Vx_sensitive_text_pointer_shape = Qnil;
5847 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
5848 &Vx_window_horizontal_drag_shape,
5849 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
5850 This variable takes effect when you create a new frame
5851 or when you set the mouse color. */);
5852 Vx_window_horizontal_drag_shape = Qnil;
5854 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
5855 doc: /* A string indicating the foreground color of the cursor box. */);
5856 Vx_cursor_fore_pixel = Qnil;
5858 DEFVAR_LISP ("x-max-tooltip-size", &Vx_max_tooltip_size,
5859 doc: /* Maximum size for tooltips. Value is a pair (COLUMNS . ROWS).
5860 Text larger than this is clipped. */);
5861 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
5863 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
5864 doc: /* Non-nil if no X window manager is in use.
5865 Emacs doesn't try to figure this out; this is always nil
5866 unless you set it to something else. */);
5867 /* We don't have any way to find this out, so set it to nil
5868 and maybe the user would like to set it to t. */
5869 Vx_no_window_manager = Qnil;
5871 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
5872 &Vx_pixel_size_width_font_regexp,
5873 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
5875 Since Emacs gets width of a font matching with this regexp from
5876 PIXEL_SIZE field of the name, font finding mechanism gets faster for
5877 such a font. This is especially effective for such large fonts as
5878 Chinese, Japanese, and Korean. */);
5879 Vx_pixel_size_width_font_regexp = Qnil;
5881 /* This is not ifdef:ed, so other builds than GTK can customize it. */
5882 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", &x_gtk_use_old_file_dialog,
5883 doc: /* *Non-nil means prompt with the old GTK file selection dialog.
5884 If nil or if the file selection dialog is not available, the new GTK file
5885 chooser is used instead. To turn off all file dialogs set the
5886 variable `use-file-dialog'. */);
5887 x_gtk_use_old_file_dialog = 0;
5889 DEFVAR_BOOL ("x-gtk-show-hidden-files", &x_gtk_show_hidden_files,
5890 doc: /* *If non-nil, the GTK file chooser will by default show hidden files.
5891 Note that this is just the default, there is a toggle button on the file
5892 chooser to show or not show hidden files on a case by case basis. */);
5893 x_gtk_show_hidden_files = 0;
5895 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", &x_gtk_file_dialog_help_text,
5896 doc: /* *If non-nil, the GTK file chooser will show additional help text.
5897 If more space for files in the file chooser dialog is wanted, set this to nil
5898 to turn the additional text off. */);
5899 x_gtk_file_dialog_help_text = 1;
5901 DEFVAR_BOOL ("x-gtk-whole-detached-tool-bar", &x_gtk_whole_detached_tool_bar,
5902 doc: /* *If non-nil, a detached tool bar is shown in full.
5903 The default is to just show an arrow and pressing on that arrow shows
5904 the tool bar buttons. */);
5905 x_gtk_whole_detached_tool_bar = 0;
5907 Fprovide (intern ("x"), Qnil);
5909 #ifdef USE_X_TOOLKIT
5910 Fprovide (intern ("x-toolkit"), Qnil);
5911 #ifdef USE_MOTIF
5912 Fprovide (intern ("motif"), Qnil);
5914 DEFVAR_LISP ("motif-version-string", &Vmotif_version_string,
5915 doc: /* Version info for LessTif/Motif. */);
5916 Vmotif_version_string = build_string (XmVERSION_STRING);
5917 #endif /* USE_MOTIF */
5918 #endif /* USE_X_TOOLKIT */
5920 #ifdef USE_GTK
5921 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
5922 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
5923 But for a user it is a toolkit for X, and indeed, configure
5924 accepts --with-x-toolkit=gtk. */
5925 Fprovide (intern ("x-toolkit"), Qnil);
5926 Fprovide (intern ("gtk"), Qnil);
5928 DEFVAR_LISP ("gtk-version-string", &Vgtk_version_string,
5929 doc: /* Version info for GTK+. */);
5931 char gtk_version[40];
5932 g_snprintf (gtk_version, sizeof (gtk_version), "%u.%u.%u",
5933 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
5934 Vgtk_version_string = build_string (gtk_version);
5936 #endif /* USE_GTK */
5938 /* X window properties. */
5939 defsubr (&Sx_change_window_property);
5940 defsubr (&Sx_delete_window_property);
5941 defsubr (&Sx_window_property);
5943 defsubr (&Sxw_display_color_p);
5944 defsubr (&Sx_display_grayscale_p);
5945 defsubr (&Sxw_color_defined_p);
5946 defsubr (&Sxw_color_values);
5947 defsubr (&Sx_server_max_request_size);
5948 defsubr (&Sx_server_vendor);
5949 defsubr (&Sx_server_version);
5950 defsubr (&Sx_display_pixel_width);
5951 defsubr (&Sx_display_pixel_height);
5952 defsubr (&Sx_display_mm_width);
5953 defsubr (&Sx_display_mm_height);
5954 defsubr (&Sx_display_screens);
5955 defsubr (&Sx_display_planes);
5956 defsubr (&Sx_display_color_cells);
5957 defsubr (&Sx_display_visual_class);
5958 defsubr (&Sx_display_backing_store);
5959 defsubr (&Sx_display_save_under);
5960 defsubr (&Sx_create_frame);
5961 defsubr (&Sx_open_connection);
5962 defsubr (&Sx_close_connection);
5963 defsubr (&Sx_display_list);
5964 defsubr (&Sx_synchronize);
5965 defsubr (&Sx_focus_frame);
5966 defsubr (&Sx_backspace_delete_keys_p);
5968 /* Setting callback functions for fontset handler. */
5969 get_font_info_func = x_get_font_info;
5971 #if 0 /* This function pointer doesn't seem to be used anywhere.
5972 And the pointer assigned has the wrong type, anyway. */
5973 list_fonts_func = x_list_fonts;
5974 #endif
5976 load_font_func = x_load_font;
5977 find_ccl_program_func = x_find_ccl_program;
5978 query_font_func = x_query_font;
5979 set_frame_fontset_func = x_set_font;
5980 check_window_system_func = check_x;
5982 hourglass_atimer = NULL;
5983 hourglass_shown_p = 0;
5985 defsubr (&Sx_show_tip);
5986 defsubr (&Sx_hide_tip);
5987 tip_timer = Qnil;
5988 staticpro (&tip_timer);
5989 tip_frame = Qnil;
5990 staticpro (&tip_frame);
5992 last_show_tip_args = Qnil;
5993 staticpro (&last_show_tip_args);
5995 defsubr (&Sx_uses_old_gtk_dialog);
5996 #if defined (USE_MOTIF) || defined (USE_GTK)
5997 defsubr (&Sx_file_dialog);
5998 #endif
6001 #endif /* HAVE_X_WINDOWS */
6003 /* arch-tag: 55040d02-5485-4d58-8b22-95a7a05f3288
6004 (do not change this comment) */