(Documentation): Add xref to Documentation Tips.
[emacs.git] / src / xfns.c
blob47e78222cbf2e1c383e431efefb51329cafc1c9e
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 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 #include <config.h>
23 #include <stdio.h>
24 #include <math.h>
26 #ifdef HAVE_UNISTD_H
27 #include <unistd.h>
28 #endif
30 /* This makes the fields of a Display accessible, in Xlib header files. */
32 #define XLIB_ILLEGAL_ACCESS
34 #include "lisp.h"
35 #include "xterm.h"
36 #include "frame.h"
37 #include "window.h"
38 #include "buffer.h"
39 #include "intervals.h"
40 #include "dispextern.h"
41 #include "keyboard.h"
42 #include "blockinput.h"
43 #include <epaths.h>
44 #include "charset.h"
45 #include "coding.h"
46 #include "fontset.h"
47 #include "systime.h"
48 #include "termhooks.h"
49 #include "atimer.h"
51 #ifdef HAVE_X_WINDOWS
53 #include <ctype.h>
54 #include <sys/types.h>
55 #include <sys/stat.h>
57 #ifndef VMS
58 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
59 #include "bitmaps/gray.xbm"
60 #else
61 #include <X11/bitmaps/gray>
62 #endif
63 #else
64 #include "[.bitmaps]gray.xbm"
65 #endif
67 #ifdef USE_GTK
68 #include "gtkutil.h"
69 #endif
71 #ifdef USE_X_TOOLKIT
72 #include <X11/Shell.h>
74 #ifndef USE_MOTIF
75 #include <X11/Xaw/Paned.h>
76 #include <X11/Xaw/Label.h>
77 #endif /* USE_MOTIF */
79 #ifdef USG
80 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
81 #include <X11/Xos.h>
82 #define USG
83 #else
84 #include <X11/Xos.h>
85 #endif
87 #include "widget.h"
89 #include "../lwlib/lwlib.h"
91 #ifdef USE_MOTIF
92 #include <Xm/Xm.h>
93 #include <Xm/DialogS.h>
94 #include <Xm/FileSB.h>
95 #endif
97 /* Do the EDITRES protocol if running X11R5
98 Exception: HP-UX (at least version A.09.05) has X11R5 without EditRes */
100 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
101 #define HACK_EDITRES
102 extern void _XEditResCheckMessages ();
103 #endif /* R5 + Athena */
105 /* Unique id counter for widgets created by the Lucid Widget Library. */
107 extern LWLIB_ID widget_id_tick;
109 #ifdef USE_LUCID
110 /* This is part of a kludge--see lwlib/xlwmenu.c. */
111 extern XFontStruct *xlwmenu_default_font;
112 #endif
114 extern void free_frame_menubar ();
115 extern double atof ();
117 #ifdef USE_MOTIF
119 /* LessTif/Motif version info. */
121 static Lisp_Object Vmotif_version_string;
123 #endif /* USE_MOTIF */
125 #endif /* USE_X_TOOLKIT */
127 #ifdef USE_GTK
129 /* GTK+ version info */
131 static Lisp_Object Vgtk_version_string;
133 #endif /* USE_GTK */
135 #ifdef HAVE_X11R4
136 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
137 #else
138 #define MAXREQUEST(dpy) ((dpy)->max_request_size)
139 #endif
141 /* The gray bitmap `bitmaps/gray'. This is done because xterm.c uses
142 it, and including `bitmaps/gray' more than once is a problem when
143 config.h defines `static' as an empty replacement string. */
145 int gray_bitmap_width = gray_width;
146 int gray_bitmap_height = gray_height;
147 char *gray_bitmap_bits = gray_bits;
149 /* Non-zero means we're allowed to display an hourglass cursor. */
151 int display_hourglass_p;
153 /* Non-zero means prompt with the old GTK file selection dialog. */
155 int x_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 If STRING contains only ASCII characters, do no conversion and
1520 return the string data of STRING. Otherwise, encode the text by
1521 CODING_SYSTEM, and return a newly allocated memory area which
1522 should be freed by `xfree' by a caller.
1524 SELECTIONP non-zero means the string is being encoded for an X
1525 selection, so it is safe to run pre-write conversions (which
1526 may run Lisp code).
1528 Store the byte length of resulting text in *TEXT_BYTES.
1530 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1531 which means that the `encoding' of the result can be `STRING'.
1532 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1533 the result should be `COMPOUND_TEXT'. */
1535 static unsigned char *
1536 x_encode_text (string, coding_system, selectionp, text_bytes, stringp, freep)
1537 Lisp_Object string, coding_system;
1538 int *text_bytes, *stringp;
1539 int selectionp;
1540 int *freep;
1542 unsigned char *str = SDATA (string);
1543 int chars = SCHARS (string);
1544 int bytes = SBYTES (string);
1545 int charset_info;
1546 int bufsize;
1547 unsigned char *buf;
1548 struct coding_system coding;
1549 extern Lisp_Object Qcompound_text_with_extensions;
1551 charset_info = find_charset_in_text (str, chars, bytes, NULL, Qnil);
1552 if (charset_info == 0)
1554 /* No multibyte character in OBJ. We need not encode it. */
1555 *text_bytes = bytes;
1556 *stringp = 1;
1557 *freep = 0;
1558 return str;
1561 setup_coding_system (coding_system, &coding);
1562 if (selectionp
1563 && SYMBOLP (coding.pre_write_conversion)
1564 && !NILP (Ffboundp (coding.pre_write_conversion)))
1566 string = run_pre_post_conversion_on_str (string, &coding, 1);
1567 str = SDATA (string);
1568 chars = SCHARS (string);
1569 bytes = SBYTES (string);
1571 coding.src_multibyte = 1;
1572 coding.dst_multibyte = 0;
1573 coding.mode |= CODING_MODE_LAST_BLOCK;
1574 if (coding.type == coding_type_iso2022)
1575 coding.flags |= CODING_FLAG_ISO_SAFE;
1576 /* We suppress producing escape sequences for composition. */
1577 coding.composing = COMPOSITION_DISABLED;
1578 bufsize = encoding_buffer_size (&coding, bytes);
1579 buf = (unsigned char *) xmalloc (bufsize);
1580 encode_coding (&coding, str, buf, bytes, bufsize);
1581 *text_bytes = coding.produced;
1582 *stringp = (charset_info == 1
1583 || (!EQ (coding_system, Qcompound_text)
1584 && !EQ (coding_system, Qcompound_text_with_extensions)));
1585 *freep = 1;
1586 return buf;
1590 /* Set the WM name to NAME for frame F. Also set the icon name.
1591 If the frame already has an icon name, use that, otherwise set the
1592 icon name to NAME. */
1594 static void
1595 x_set_name_internal (f, name)
1596 FRAME_PTR f;
1597 Lisp_Object name;
1599 if (FRAME_X_WINDOW (f))
1601 BLOCK_INPUT;
1602 #ifdef HAVE_X11R4
1604 XTextProperty text, icon;
1605 int bytes, stringp;
1606 int do_free_icon_value = 0, do_free_text_value = 0;
1607 Lisp_Object coding_system;
1609 coding_system = Qcompound_text;
1610 /* Note: Encoding strategy
1612 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1613 text.encoding. But, there are non-internationalized window
1614 managers which don't support that encoding. So, if NAME
1615 contains only ASCII and 8859-1 characters, encode it by
1616 iso-latin-1, and use "STRING" in text.encoding hoping that
1617 such window managers at least analyze this format correctly,
1618 i.e. treat 8-bit bytes as 8859-1 characters.
1620 We may also be able to use "UTF8_STRING" in text.encoding
1621 in the future which can encode all Unicode characters.
1622 But, for the moment, there's no way to know that the
1623 current window manager supports it or not. */
1624 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp,
1625 &do_free_text_value);
1626 text.encoding = (stringp ? XA_STRING
1627 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1628 text.format = 8;
1629 text.nitems = bytes;
1631 if (!STRINGP (f->icon_name))
1633 icon = text;
1635 else
1637 /* See the above comment "Note: Encoding strategy". */
1638 icon.value = x_encode_text (f->icon_name, coding_system, 0,
1639 &bytes, &stringp, &do_free_icon_value);
1640 icon.encoding = (stringp ? XA_STRING
1641 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
1642 icon.format = 8;
1643 icon.nitems = bytes;
1646 #ifdef USE_GTK
1647 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
1648 (char *) SDATA (ENCODE_UTF_8 (name)));
1649 #else /* not USE_GTK */
1650 XSetWMName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
1651 #endif /* not USE_GTK */
1653 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &icon);
1655 if (do_free_icon_value)
1656 xfree (icon.value);
1657 if (do_free_text_value)
1658 xfree (text.value);
1660 #else /* not HAVE_X11R4 */
1661 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1662 SDATA (name));
1663 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1664 SDATA (name));
1665 #endif /* not HAVE_X11R4 */
1666 UNBLOCK_INPUT;
1670 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1671 x_id_name.
1673 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1674 name; if NAME is a string, set F's name to NAME and set
1675 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1677 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1678 suggesting a new name, which lisp code should override; if
1679 F->explicit_name is set, ignore the new name; otherwise, set it. */
1681 void
1682 x_set_name (f, name, explicit)
1683 struct frame *f;
1684 Lisp_Object name;
1685 int explicit;
1687 /* Make sure that requests from lisp code override requests from
1688 Emacs redisplay code. */
1689 if (explicit)
1691 /* If we're switching from explicit to implicit, we had better
1692 update the mode lines and thereby update the title. */
1693 if (f->explicit_name && NILP (name))
1694 update_mode_lines = 1;
1696 f->explicit_name = ! NILP (name);
1698 else if (f->explicit_name)
1699 return;
1701 /* If NAME is nil, set the name to the x_id_name. */
1702 if (NILP (name))
1704 /* Check for no change needed in this very common case
1705 before we do any consing. */
1706 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
1707 SDATA (f->name)))
1708 return;
1709 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
1711 else
1712 CHECK_STRING (name);
1714 /* Don't change the name if it's already NAME. */
1715 if (! NILP (Fstring_equal (name, f->name)))
1716 return;
1718 f->name = name;
1720 /* For setting the frame title, the title parameter should override
1721 the name parameter. */
1722 if (! NILP (f->title))
1723 name = f->title;
1725 x_set_name_internal (f, name);
1728 /* This function should be called when the user's lisp code has
1729 specified a name for the frame; the name will override any set by the
1730 redisplay code. */
1731 void
1732 x_explicitly_set_name (f, arg, oldval)
1733 FRAME_PTR f;
1734 Lisp_Object arg, oldval;
1736 x_set_name (f, arg, 1);
1739 /* This function should be called by Emacs redisplay code to set the
1740 name; names set this way will never override names set by the user's
1741 lisp code. */
1742 void
1743 x_implicitly_set_name (f, arg, oldval)
1744 FRAME_PTR f;
1745 Lisp_Object arg, oldval;
1747 x_set_name (f, arg, 0);
1750 /* Change the title of frame F to NAME.
1751 If NAME is nil, use the frame name as the title.
1753 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1754 name; if NAME is a string, set F's name to NAME and set
1755 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1757 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1758 suggesting a new name, which lisp code should override; if
1759 F->explicit_name is set, ignore the new name; otherwise, set it. */
1761 void
1762 x_set_title (f, name, old_name)
1763 struct frame *f;
1764 Lisp_Object name, old_name;
1766 /* Don't change the title if it's already NAME. */
1767 if (EQ (name, f->title))
1768 return;
1770 update_mode_lines = 1;
1772 f->title = name;
1774 if (NILP (name))
1775 name = f->name;
1776 else
1777 CHECK_STRING (name);
1779 x_set_name_internal (f, name);
1782 void
1783 x_set_scroll_bar_default_width (f)
1784 struct frame *f;
1786 int wid = FRAME_COLUMN_WIDTH (f);
1788 #ifdef USE_TOOLKIT_SCROLL_BARS
1789 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
1790 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
1791 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
1792 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = width;
1793 #else
1794 /* Make the actual width at least 14 pixels and a multiple of a
1795 character width. */
1796 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
1798 /* Use all of that space (aside from required margins) for the
1799 scroll bar. */
1800 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = 0;
1801 #endif
1805 /* Record in frame F the specified or default value according to ALIST
1806 of the parameter named PROP (a Lisp symbol). If no value is
1807 specified for PROP, look for an X default for XPROP on the frame
1808 named NAME. If that is not found either, use the value DEFLT. */
1810 static Lisp_Object
1811 x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
1812 foreground_p)
1813 struct frame *f;
1814 Lisp_Object alist;
1815 Lisp_Object prop;
1816 char *xprop;
1817 char *xclass;
1818 int foreground_p;
1820 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1821 Lisp_Object tem;
1823 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
1824 if (EQ (tem, Qunbound))
1826 #ifdef USE_TOOLKIT_SCROLL_BARS
1828 /* See if an X resource for the scroll bar color has been
1829 specified. */
1830 tem = display_x_get_resource (dpyinfo,
1831 build_string (foreground_p
1832 ? "foreground"
1833 : "background"),
1834 empty_string,
1835 build_string ("verticalScrollBar"),
1836 empty_string);
1837 if (!STRINGP (tem))
1839 /* If nothing has been specified, scroll bars will use a
1840 toolkit-dependent default. Because these defaults are
1841 difficult to get at without actually creating a scroll
1842 bar, use nil to indicate that no color has been
1843 specified. */
1844 tem = Qnil;
1847 #else /* not USE_TOOLKIT_SCROLL_BARS */
1849 tem = Qnil;
1851 #endif /* not USE_TOOLKIT_SCROLL_BARS */
1854 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
1855 return tem;
1860 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
1862 Status
1863 XSetWMProtocols (dpy, w, protocols, count)
1864 Display *dpy;
1865 Window w;
1866 Atom *protocols;
1867 int count;
1869 Atom prop;
1870 prop = XInternAtom (dpy, "WM_PROTOCOLS", False);
1871 if (prop == None) return False;
1872 XChangeProperty (dpy, w, prop, XA_ATOM, 32, PropModeReplace,
1873 (unsigned char *) protocols, count);
1874 return True;
1876 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
1878 #ifdef USE_X_TOOLKIT
1880 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
1881 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
1882 already be present because of the toolkit (Motif adds some of them,
1883 for example, but Xt doesn't). */
1885 static void
1886 hack_wm_protocols (f, widget)
1887 FRAME_PTR f;
1888 Widget widget;
1890 Display *dpy = XtDisplay (widget);
1891 Window w = XtWindow (widget);
1892 int need_delete = 1;
1893 int need_focus = 1;
1894 int need_save = 1;
1896 BLOCK_INPUT;
1898 Atom type;
1899 unsigned char *catoms;
1900 int format = 0;
1901 unsigned long nitems = 0;
1902 unsigned long bytes_after;
1904 if ((XGetWindowProperty (dpy, w,
1905 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1906 (long)0, (long)100, False, XA_ATOM,
1907 &type, &format, &nitems, &bytes_after,
1908 &catoms)
1909 == Success)
1910 && format == 32 && type == XA_ATOM)
1912 Atom *atoms = (Atom *) catoms;
1913 while (nitems > 0)
1915 nitems--;
1916 if (atoms[nitems]
1917 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
1918 need_delete = 0;
1919 else if (atoms[nitems]
1920 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
1921 need_focus = 0;
1922 else if (atoms[nitems]
1923 == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
1924 need_save = 0;
1927 if (catoms)
1928 XFree (catoms);
1931 Atom props [10];
1932 int count = 0;
1933 if (need_delete)
1934 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
1935 if (need_focus)
1936 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
1937 if (need_save)
1938 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
1939 if (count)
1940 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
1941 XA_ATOM, 32, PropModeAppend,
1942 (unsigned char *) props, count);
1944 UNBLOCK_INPUT;
1946 #endif
1950 /* Support routines for XIC (X Input Context). */
1952 #ifdef HAVE_X_I18N
1954 static XFontSet xic_create_xfontset P_ ((struct frame *, char *));
1955 static XIMStyle best_xim_style P_ ((XIMStyles *, XIMStyles *));
1958 /* Supported XIM styles, ordered by preference. */
1960 static XIMStyle supported_xim_styles[] =
1962 XIMPreeditPosition | XIMStatusArea,
1963 XIMPreeditPosition | XIMStatusNothing,
1964 XIMPreeditPosition | XIMStatusNone,
1965 XIMPreeditNothing | XIMStatusArea,
1966 XIMPreeditNothing | XIMStatusNothing,
1967 XIMPreeditNothing | XIMStatusNone,
1968 XIMPreeditNone | XIMStatusArea,
1969 XIMPreeditNone | XIMStatusNothing,
1970 XIMPreeditNone | XIMStatusNone,
1975 /* Create an X fontset on frame F with base font name BASE_FONTNAME. */
1977 char xic_defaut_fontset[] = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
1979 /* Create an Xt fontset spec from the name of a base font.
1980 If `motif' is True use the Motif syntax. */
1981 char *
1982 xic_create_fontsetname (base_fontname, motif)
1983 char *base_fontname;
1984 Bool motif;
1986 const char *sep = motif ? ";" : ",";
1987 char *fontsetname;
1989 /* Make a fontset name from the base font name. */
1990 if (xic_defaut_fontset == base_fontname)
1991 { /* There is no base font name, use the default. */
1992 int len = strlen (base_fontname) + 2;
1993 fontsetname = xmalloc (len);
1994 bzero (fontsetname, len);
1995 strcpy (fontsetname, base_fontname);
1997 else
1999 /* Make a fontset name from the base font name.
2000 The font set will be made of the following elements:
2001 - the base font.
2002 - the base font where the charset spec is replaced by -*-*.
2003 - the same but with the family also replaced with -*-*-. */
2004 char *p = base_fontname;
2005 int i;
2007 for (i = 0; *p; p++)
2008 if (*p == '-') i++;
2009 if (i != 14)
2010 { /* As the font name doesn't conform to XLFD, we can't
2011 modify it to generalize it to allcs and allfamilies.
2012 Use the specified font plus the default. */
2013 int len = strlen (base_fontname) + strlen (xic_defaut_fontset) + 3;
2014 fontsetname = xmalloc (len);
2015 bzero (fontsetname, len);
2016 strcpy (fontsetname, base_fontname);
2017 strcat (fontsetname, sep);
2018 strcat (fontsetname, xic_defaut_fontset);
2020 else
2022 int len;
2023 char *p1 = NULL, *p2 = NULL, *p3 = NULL;
2024 char *font_allcs = NULL;
2025 char *font_allfamilies = NULL;
2026 char *font_all = NULL;
2027 char *allcs = "*-*-*-*-*-*-*";
2028 char *allfamilies = "-*-*-";
2029 char *all = "*-*-*-*-";
2030 char *base;
2032 for (i = 0, p = base_fontname; i < 8; p++)
2034 if (*p == '-')
2036 i++;
2037 if (i == 3)
2038 p1 = p + 1;
2039 else if (i == 7)
2040 p2 = p + 1;
2041 else if (i == 6)
2042 p3 = p + 1;
2045 /* If base_fontname specifies ADSTYLE, make it a
2046 wildcard. */
2047 if (*p3 != '*')
2049 int diff = (p2 - p3) - 2;
2051 base = alloca (strlen (base_fontname) + 1);
2052 bcopy (base_fontname, base, p3 - base_fontname);
2053 base[p3 - base_fontname] = '*';
2054 base[(p3 - base_fontname) + 1] = '-';
2055 strcpy (base + (p3 - base_fontname) + 2, p2);
2056 p = base + (p - base_fontname) - diff;
2057 p1 = base + (p1 - base_fontname);
2058 p2 = base + (p2 - base_fontname) - diff;
2059 base_fontname = base;
2062 /* Build the font spec that matches all charsets. */
2063 len = p - base_fontname + strlen (allcs) + 1;
2064 font_allcs = (char *) alloca (len);
2065 bzero (font_allcs, len);
2066 bcopy (base_fontname, font_allcs, p - base_fontname);
2067 strcat (font_allcs, allcs);
2069 /* Build the font spec that matches all families and
2070 add-styles. */
2071 len = p - p1 + strlen (allcs) + strlen (allfamilies) + 1;
2072 font_allfamilies = (char *) alloca (len);
2073 bzero (font_allfamilies, len);
2074 strcpy (font_allfamilies, allfamilies);
2075 bcopy (p1, font_allfamilies + strlen (allfamilies), p - p1);
2076 strcat (font_allfamilies, allcs);
2078 /* Build the font spec that matches all. */
2079 len = p - p2 + strlen (allcs) + strlen (all) + strlen (allfamilies) + 1;
2080 font_all = (char *) alloca (len);
2081 bzero (font_all, len);
2082 strcpy (font_all, allfamilies);
2083 strcat (font_all, all);
2084 bcopy (p2, font_all + strlen (all) + strlen (allfamilies), p - p2);
2085 strcat (font_all, allcs);
2087 /* Build the actual font set name. */
2088 len = strlen (base_fontname) + strlen (font_allcs)
2089 + strlen (font_allfamilies) + strlen (font_all) + 5;
2090 fontsetname = xmalloc (len);
2091 bzero (fontsetname, len);
2092 strcpy (fontsetname, base_fontname);
2093 strcat (fontsetname, sep);
2094 strcat (fontsetname, font_allcs);
2095 strcat (fontsetname, sep);
2096 strcat (fontsetname, font_allfamilies);
2097 strcat (fontsetname, sep);
2098 strcat (fontsetname, font_all);
2101 if (motif)
2102 strcat (fontsetname, ":");
2103 return fontsetname;
2106 static XFontSet
2107 xic_create_xfontset (f, base_fontname)
2108 struct frame *f;
2109 char *base_fontname;
2111 XFontSet xfs = NULL;
2112 char **missing_list = NULL;
2113 int missing_count;
2114 char *def_string;
2115 Lisp_Object rest, frame;
2117 if (!base_fontname)
2118 base_fontname = xic_defaut_fontset;
2120 /* See if there is another frame already using same fontset. */
2121 FOR_EACH_FRAME (rest, frame)
2123 struct frame *cf = XFRAME (frame);
2124 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2125 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2126 && FRAME_XIC_BASE_FONTNAME (cf)
2127 && !strcmp (FRAME_XIC_BASE_FONTNAME (cf), base_fontname))
2129 xfs = FRAME_XIC_FONTSET (cf);
2130 break;
2134 if (!xfs)
2136 char *fontsetname = xic_create_fontsetname (base_fontname, False);
2138 /* New fontset. */
2139 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
2140 fontsetname, &missing_list,
2141 &missing_count, &def_string);
2142 if (missing_list)
2143 XFreeStringList (missing_list);
2144 if (! xfs)
2146 /* FONTSETNAME contains a list of font names (specific fonts
2147 first, general fonts last), but giving that to
2148 XCreateFontSet at once occasionally fails (bug of X?).
2149 So, we try to call XCreateFontSet for each fontname. */
2150 char *p0 = fontsetname, *p1;
2152 while (p0)
2154 p1 = strchr (p0, ',');
2155 if (p1)
2156 *p1 = '\0';
2157 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
2158 p0, &missing_list,
2159 &missing_count, &def_string);
2160 if (missing_list)
2161 XFreeStringList (missing_list);
2162 if (xfs)
2163 break;
2164 p0 = p1 ? p1 + 1 : NULL;
2167 xfree (fontsetname);
2170 if (FRAME_XIC_BASE_FONTNAME (f))
2171 xfree (FRAME_XIC_BASE_FONTNAME (f));
2172 FRAME_XIC_BASE_FONTNAME (f) = xstrdup (base_fontname);
2174 /* No need to free def_string. */
2175 return xfs;
2178 /* Free the X fontset of frame F if it is the last frame using it. */
2180 void
2181 xic_free_xfontset (f)
2182 struct frame *f;
2184 Lisp_Object rest, frame;
2185 int shared_p = 0;
2187 if (!FRAME_XIC_FONTSET (f))
2188 return;
2190 /* See if there is another frame sharing the same fontset. */
2191 FOR_EACH_FRAME (rest, frame)
2193 struct frame *cf = XFRAME (frame);
2194 if (cf != f && FRAME_LIVE_P (f) && FRAME_X_P (cf)
2195 && FRAME_X_DISPLAY_INFO (cf) == FRAME_X_DISPLAY_INFO (f)
2196 && FRAME_XIC_FONTSET (cf) == FRAME_XIC_FONTSET (f))
2198 shared_p = 1;
2199 break;
2203 if (!shared_p)
2204 /* The fontset is not used anymore. It is safe to free it. */
2205 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
2207 if (FRAME_XIC_BASE_FONTNAME (f))
2208 xfree (FRAME_XIC_BASE_FONTNAME (f));
2209 FRAME_XIC_BASE_FONTNAME (f) = NULL;
2210 FRAME_XIC_FONTSET (f) = NULL;
2214 /* Value is the best input style, given user preferences USER (already
2215 checked to be supported by Emacs), and styles supported by the
2216 input method XIM. */
2218 static XIMStyle
2219 best_xim_style (user, xim)
2220 XIMStyles *user;
2221 XIMStyles *xim;
2223 int i, j;
2225 for (i = 0; i < user->count_styles; ++i)
2226 for (j = 0; j < xim->count_styles; ++j)
2227 if (user->supported_styles[i] == xim->supported_styles[j])
2228 return user->supported_styles[i];
2230 /* Return the default style. */
2231 return XIMPreeditNothing | XIMStatusNothing;
2234 /* Create XIC for frame F. */
2236 static XIMStyle xic_style;
2238 void
2239 create_frame_xic (f)
2240 struct frame *f;
2242 XIM xim;
2243 XIC xic = NULL;
2244 XFontSet xfs = NULL;
2246 if (FRAME_XIC (f))
2247 return;
2249 /* Create X fontset. */
2250 xfs = xic_create_xfontset
2251 (f, (FRAME_FONTSET (f) < 0) ? NULL
2252 : (char *) SDATA (fontset_ascii (FRAME_FONTSET (f))));
2254 xim = FRAME_X_XIM (f);
2255 if (xim)
2257 XRectangle s_area;
2258 XPoint spot;
2259 XVaNestedList preedit_attr;
2260 XVaNestedList status_attr;
2262 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
2263 spot.x = 0; spot.y = 1;
2265 /* Determine XIC style. */
2266 if (xic_style == 0)
2268 XIMStyles supported_list;
2269 supported_list.count_styles = (sizeof supported_xim_styles
2270 / sizeof supported_xim_styles[0]);
2271 supported_list.supported_styles = supported_xim_styles;
2272 xic_style = best_xim_style (&supported_list,
2273 FRAME_X_XIM_STYLES (f));
2276 preedit_attr = XVaCreateNestedList (0,
2277 XNFontSet, xfs,
2278 XNForeground,
2279 FRAME_FOREGROUND_PIXEL (f),
2280 XNBackground,
2281 FRAME_BACKGROUND_PIXEL (f),
2282 (xic_style & XIMPreeditPosition
2283 ? XNSpotLocation
2284 : NULL),
2285 &spot,
2286 NULL);
2287 status_attr = XVaCreateNestedList (0,
2288 XNArea,
2289 &s_area,
2290 XNFontSet,
2291 xfs,
2292 XNForeground,
2293 FRAME_FOREGROUND_PIXEL (f),
2294 XNBackground,
2295 FRAME_BACKGROUND_PIXEL (f),
2296 NULL);
2298 xic = XCreateIC (xim,
2299 XNInputStyle, xic_style,
2300 XNClientWindow, FRAME_X_WINDOW (f),
2301 XNFocusWindow, FRAME_X_WINDOW (f),
2302 XNStatusAttributes, status_attr,
2303 XNPreeditAttributes, preedit_attr,
2304 NULL);
2305 XFree (preedit_attr);
2306 XFree (status_attr);
2309 FRAME_XIC (f) = xic;
2310 FRAME_XIC_STYLE (f) = xic_style;
2311 FRAME_XIC_FONTSET (f) = xfs;
2315 /* Destroy XIC and free XIC fontset of frame F, if any. */
2317 void
2318 free_frame_xic (f)
2319 struct frame *f;
2321 if (FRAME_XIC (f) == NULL)
2322 return;
2324 XDestroyIC (FRAME_XIC (f));
2325 xic_free_xfontset (f);
2327 FRAME_XIC (f) = NULL;
2331 /* Place preedit area for XIC of window W's frame to specified
2332 pixel position X/Y. X and Y are relative to window W. */
2334 void
2335 xic_set_preeditarea (w, x, y)
2336 struct window *w;
2337 int x, y;
2339 struct frame *f = XFRAME (w->frame);
2340 XVaNestedList attr;
2341 XPoint spot;
2343 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x) + WINDOW_LEFT_FRINGE_WIDTH (w);
2344 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
2345 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
2346 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2347 XFree (attr);
2351 /* Place status area for XIC in bottom right corner of frame F.. */
2353 void
2354 xic_set_statusarea (f)
2355 struct frame *f;
2357 XIC xic = FRAME_XIC (f);
2358 XVaNestedList attr;
2359 XRectangle area;
2360 XRectangle *needed;
2362 /* Negotiate geometry of status area. If input method has existing
2363 status area, use its current size. */
2364 area.x = area.y = area.width = area.height = 0;
2365 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
2366 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2367 XFree (attr);
2369 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
2370 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2371 XFree (attr);
2373 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
2375 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
2376 XGetICValues (xic, XNStatusAttributes, attr, NULL);
2377 XFree (attr);
2380 area.width = needed->width;
2381 area.height = needed->height;
2382 area.x = FRAME_PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
2383 area.y = (FRAME_PIXEL_HEIGHT (f) - area.height
2384 - FRAME_MENUBAR_HEIGHT (f)
2385 - FRAME_TOOLBAR_HEIGHT (f)
2386 - FRAME_INTERNAL_BORDER_WIDTH (f));
2387 XFree (needed);
2389 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
2390 XSetICValues (xic, XNStatusAttributes, attr, NULL);
2391 XFree (attr);
2395 /* Set X fontset for XIC of frame F, using base font name
2396 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2398 void
2399 xic_set_xfontset (f, base_fontname)
2400 struct frame *f;
2401 char *base_fontname;
2403 XVaNestedList attr;
2404 XFontSet xfs;
2406 xic_free_xfontset (f);
2408 xfs = xic_create_xfontset (f, base_fontname);
2410 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
2411 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
2412 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
2413 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
2414 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
2415 XFree (attr);
2417 FRAME_XIC_FONTSET (f) = xfs;
2420 #endif /* HAVE_X_I18N */
2424 #ifdef USE_X_TOOLKIT
2426 /* Create and set up the X widget for frame F. */
2428 static void
2429 x_window (f, window_prompting, minibuffer_only)
2430 struct frame *f;
2431 long window_prompting;
2432 int minibuffer_only;
2434 XClassHint class_hints;
2435 XSetWindowAttributes attributes;
2436 unsigned long attribute_mask;
2437 Widget shell_widget;
2438 Widget pane_widget;
2439 Widget frame_widget;
2440 Arg al [25];
2441 int ac;
2443 BLOCK_INPUT;
2445 /* Use the resource name as the top-level widget name
2446 for looking up resources. Make a non-Lisp copy
2447 for the window manager, so GC relocation won't bother it.
2449 Elsewhere we specify the window name for the window manager. */
2452 char *str = (char *) SDATA (Vx_resource_name);
2453 f->namebuf = (char *) xmalloc (strlen (str) + 1);
2454 strcpy (f->namebuf, str);
2457 ac = 0;
2458 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
2459 XtSetArg (al[ac], XtNinput, 1); ac++;
2460 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2461 XtSetArg (al[ac], XtNborderWidth, f->border_width); ac++;
2462 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2463 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2464 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2465 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
2466 applicationShellWidgetClass,
2467 FRAME_X_DISPLAY (f), al, ac);
2469 f->output_data.x->widget = shell_widget;
2470 /* maybe_set_screen_title_format (shell_widget); */
2472 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
2473 (widget_value *) NULL,
2474 shell_widget, False,
2475 (lw_callback) NULL,
2476 (lw_callback) NULL,
2477 (lw_callback) NULL,
2478 (lw_callback) NULL);
2480 ac = 0;
2481 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2482 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2483 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2484 XtSetValues (pane_widget, al, ac);
2485 f->output_data.x->column_widget = pane_widget;
2487 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2488 the emacs screen when changing menubar. This reduces flickering. */
2490 ac = 0;
2491 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
2492 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
2493 XtSetArg (al[ac], XtNallowResize, 1); ac++;
2494 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
2495 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
2496 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
2497 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
2498 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
2499 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
2500 al, ac);
2502 f->output_data.x->edit_widget = frame_widget;
2504 XtManageChild (frame_widget);
2506 /* Do some needed geometry management. */
2508 int len;
2509 char *tem, shell_position[32];
2510 Arg al[10];
2511 int ac = 0;
2512 int extra_borders = 0;
2513 int menubar_size
2514 = (f->output_data.x->menubar_widget
2515 ? (f->output_data.x->menubar_widget->core.height
2516 + f->output_data.x->menubar_widget->core.border_width)
2517 : 0);
2519 #if 0 /* Experimentally, we now get the right results
2520 for -geometry -0-0 without this. 24 Aug 96, rms. */
2521 if (FRAME_EXTERNAL_MENU_BAR (f))
2523 Dimension ibw = 0;
2524 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
2525 menubar_size += ibw;
2527 #endif
2529 f->output_data.x->menubar_height = menubar_size;
2531 #ifndef USE_LUCID
2532 /* Motif seems to need this amount added to the sizes
2533 specified for the shell widget. The Athena/Lucid widgets don't.
2534 Both conclusions reached experimentally. -- rms. */
2535 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
2536 &extra_borders, NULL);
2537 extra_borders *= 2;
2538 #endif
2540 /* Convert our geometry parameters into a geometry string
2541 and specify it.
2542 Note that we do not specify here whether the position
2543 is a user-specified or program-specified one.
2544 We pass that information later, in x_wm_set_size_hints. */
2546 int left = f->left_pos;
2547 int xneg = window_prompting & XNegative;
2548 int top = f->top_pos;
2549 int yneg = window_prompting & YNegative;
2550 if (xneg)
2551 left = -left;
2552 if (yneg)
2553 top = -top;
2555 if (window_prompting & USPosition)
2556 sprintf (shell_position, "=%dx%d%c%d%c%d",
2557 FRAME_PIXEL_WIDTH (f) + extra_borders,
2558 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders,
2559 (xneg ? '-' : '+'), left,
2560 (yneg ? '-' : '+'), top);
2561 else
2563 sprintf (shell_position, "=%dx%d",
2564 FRAME_PIXEL_WIDTH (f) + extra_borders,
2565 FRAME_PIXEL_HEIGHT (f) + menubar_size + extra_borders);
2567 /* Setting x and y when the position is not specified in
2568 the geometry string will set program position in the WM hints.
2569 If Emacs had just one program position, we could set it in
2570 fallback resources, but since each make-frame call can specify
2571 different program positions, this is easier. */
2572 XtSetArg (al[ac], XtNx, left); ac++;
2573 XtSetArg (al[ac], XtNy, top); ac++;
2577 len = strlen (shell_position) + 1;
2578 /* We don't free this because we don't know whether
2579 it is safe to free it while the frame exists.
2580 It isn't worth the trouble of arranging to free it
2581 when the frame is deleted. */
2582 tem = (char *) xmalloc (len);
2583 strncpy (tem, shell_position, len);
2584 XtSetArg (al[ac], XtNgeometry, tem); ac++;
2585 XtSetValues (shell_widget, al, ac);
2588 XtManageChild (pane_widget);
2589 XtRealizeWidget (shell_widget);
2591 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
2593 validate_x_resource_name ();
2595 class_hints.res_name = (char *) SDATA (Vx_resource_name);
2596 class_hints.res_class = (char *) SDATA (Vx_resource_class);
2597 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
2599 #ifdef HAVE_X_I18N
2600 FRAME_XIC (f) = NULL;
2601 if (use_xim)
2602 create_frame_xic (f);
2603 #endif
2605 f->output_data.x->wm_hints.input = True;
2606 f->output_data.x->wm_hints.flags |= InputHint;
2607 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2608 &f->output_data.x->wm_hints);
2610 hack_wm_protocols (f, shell_widget);
2612 #ifdef HACK_EDITRES
2613 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
2614 #endif
2616 /* Do a stupid property change to force the server to generate a
2617 PropertyNotify event so that the event_stream server timestamp will
2618 be initialized to something relevant to the time we created the window.
2620 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
2621 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
2622 XA_ATOM, 32, PropModeAppend,
2623 (unsigned char*) NULL, 0);
2625 /* Make all the standard events reach the Emacs frame. */
2626 attributes.event_mask = STANDARD_EVENT_SET;
2628 #ifdef HAVE_X_I18N
2629 if (FRAME_XIC (f))
2631 /* XIM server might require some X events. */
2632 unsigned long fevent = NoEventMask;
2633 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2634 attributes.event_mask |= fevent;
2636 #endif /* HAVE_X_I18N */
2638 attribute_mask = CWEventMask;
2639 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
2640 attribute_mask, &attributes);
2642 XtMapWidget (frame_widget);
2644 /* x_set_name normally ignores requests to set the name if the
2645 requested name is the same as the current name. This is the one
2646 place where that assumption isn't correct; f->name is set, but
2647 the X server hasn't been told. */
2649 Lisp_Object name;
2650 int explicit = f->explicit_name;
2652 f->explicit_name = 0;
2653 name = f->name;
2654 f->name = Qnil;
2655 x_set_name (f, name, explicit);
2658 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2659 f->output_data.x->text_cursor);
2661 UNBLOCK_INPUT;
2663 /* This is a no-op, except under Motif. Make sure main areas are
2664 set to something reasonable, in case we get an error later. */
2665 lw_set_main_areas (pane_widget, 0, frame_widget);
2668 #else /* not USE_X_TOOLKIT */
2669 #ifdef USE_GTK
2670 void
2671 x_window (f)
2672 FRAME_PTR f;
2674 if (! xg_create_frame_widgets (f))
2675 error ("Unable to create window");
2677 #ifdef HAVE_X_I18N
2678 FRAME_XIC (f) = NULL;
2679 if (use_xim)
2681 BLOCK_INPUT;
2682 create_frame_xic (f);
2683 if (FRAME_XIC (f))
2685 /* XIM server might require some X events. */
2686 unsigned long fevent = NoEventMask;
2687 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2689 if (fevent != NoEventMask)
2691 XSetWindowAttributes attributes;
2692 XWindowAttributes wattr;
2693 unsigned long attribute_mask;
2695 XGetWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2696 &wattr);
2697 attributes.event_mask = wattr.your_event_mask | fevent;
2698 attribute_mask = CWEventMask;
2699 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2700 attribute_mask, &attributes);
2703 UNBLOCK_INPUT;
2705 #endif
2708 #else /*! USE_GTK */
2709 /* Create and set up the X window for frame F. */
2711 void
2712 x_window (f)
2713 struct frame *f;
2716 XClassHint class_hints;
2717 XSetWindowAttributes attributes;
2718 unsigned long attribute_mask;
2720 attributes.background_pixel = f->output_data.x->background_pixel;
2721 attributes.border_pixel = f->output_data.x->border_pixel;
2722 attributes.bit_gravity = StaticGravity;
2723 attributes.backing_store = NotUseful;
2724 attributes.save_under = True;
2725 attributes.event_mask = STANDARD_EVENT_SET;
2726 attributes.colormap = FRAME_X_COLORMAP (f);
2727 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
2728 | CWColormap);
2730 BLOCK_INPUT;
2731 FRAME_X_WINDOW (f)
2732 = XCreateWindow (FRAME_X_DISPLAY (f),
2733 f->output_data.x->parent_desc,
2734 f->left_pos,
2735 f->top_pos,
2736 FRAME_PIXEL_WIDTH (f), FRAME_PIXEL_HEIGHT (f),
2737 f->border_width,
2738 CopyFromParent, /* depth */
2739 InputOutput, /* class */
2740 FRAME_X_VISUAL (f),
2741 attribute_mask, &attributes);
2743 #ifdef HAVE_X_I18N
2744 if (use_xim)
2746 create_frame_xic (f);
2747 if (FRAME_XIC (f))
2749 /* XIM server might require some X events. */
2750 unsigned long fevent = NoEventMask;
2751 XGetICValues (FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
2752 attributes.event_mask |= fevent;
2753 attribute_mask = CWEventMask;
2754 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2755 attribute_mask, &attributes);
2758 #endif /* HAVE_X_I18N */
2760 validate_x_resource_name ();
2762 class_hints.res_name = (char *) SDATA (Vx_resource_name);
2763 class_hints.res_class = (char *) SDATA (Vx_resource_class);
2764 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
2766 /* The menubar is part of the ordinary display;
2767 it does not count in addition to the height of the window. */
2768 f->output_data.x->menubar_height = 0;
2770 /* This indicates that we use the "Passive Input" input model.
2771 Unless we do this, we don't get the Focus{In,Out} events that we
2772 need to draw the cursor correctly. Accursed bureaucrats.
2773 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2775 f->output_data.x->wm_hints.input = True;
2776 f->output_data.x->wm_hints.flags |= InputHint;
2777 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2778 &f->output_data.x->wm_hints);
2779 f->output_data.x->wm_hints.icon_pixmap = None;
2781 /* Request "save yourself" and "delete window" commands from wm. */
2783 Atom protocols[2];
2784 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
2785 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
2786 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
2789 /* x_set_name normally ignores requests to set the name if the
2790 requested name is the same as the current name. This is the one
2791 place where that assumption isn't correct; f->name is set, but
2792 the X server hasn't been told. */
2794 Lisp_Object name;
2795 int explicit = f->explicit_name;
2797 f->explicit_name = 0;
2798 name = f->name;
2799 f->name = Qnil;
2800 x_set_name (f, name, explicit);
2803 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2804 f->output_data.x->text_cursor);
2806 UNBLOCK_INPUT;
2808 if (FRAME_X_WINDOW (f) == 0)
2809 error ("Unable to create window");
2812 #endif /* not USE_GTK */
2813 #endif /* not USE_X_TOOLKIT */
2815 /* Verify that the icon position args for this window are valid. */
2817 static void
2818 x_icon_verify (f, parms)
2819 struct frame *f;
2820 Lisp_Object parms;
2822 Lisp_Object icon_x, icon_y;
2824 /* Set the position of the icon. Note that twm groups all
2825 icons in an icon window. */
2826 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2827 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2828 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2830 CHECK_NUMBER (icon_x);
2831 CHECK_NUMBER (icon_y);
2833 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2834 error ("Both left and top icon corners of icon must be specified");
2837 /* Handle the icon stuff for this window. Perhaps later we might
2838 want an x_set_icon_position which can be called interactively as
2839 well. */
2841 static void
2842 x_icon (f, parms)
2843 struct frame *f;
2844 Lisp_Object parms;
2846 Lisp_Object icon_x, icon_y;
2847 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2849 /* Set the position of the icon. Note that twm groups all
2850 icons in an icon window. */
2851 icon_x = x_frame_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
2852 icon_y = x_frame_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
2853 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
2855 CHECK_NUMBER (icon_x);
2856 CHECK_NUMBER (icon_y);
2858 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
2859 error ("Both left and top icon corners of icon must be specified");
2861 BLOCK_INPUT;
2863 if (! EQ (icon_x, Qunbound))
2864 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
2866 #if 0 /* x_get_arg removes the visibility parameter as a side effect,
2867 but x_create_frame still needs it. */
2868 /* Start up iconic or window? */
2869 x_wm_set_window_state
2870 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
2871 Qicon)
2872 ? IconicState
2873 : NormalState));
2874 #endif
2876 x_text_icon (f, (char *) SDATA ((!NILP (f->icon_name)
2877 ? f->icon_name
2878 : f->name)));
2880 UNBLOCK_INPUT;
2883 /* Make the GCs needed for this window, setting the
2884 background, border and mouse colors; also create the
2885 mouse cursor and the gray border tile. */
2887 static char cursor_bits[] =
2889 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2890 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2891 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
2892 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
2895 static void
2896 x_make_gc (f)
2897 struct frame *f;
2899 XGCValues gc_values;
2901 BLOCK_INPUT;
2903 /* Create the GCs of this frame.
2904 Note that many default values are used. */
2906 /* Normal video */
2907 gc_values.font = FRAME_FONT (f)->fid;
2908 gc_values.foreground = f->output_data.x->foreground_pixel;
2909 gc_values.background = f->output_data.x->background_pixel;
2910 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
2911 f->output_data.x->normal_gc
2912 = XCreateGC (FRAME_X_DISPLAY (f),
2913 FRAME_X_WINDOW (f),
2914 GCLineWidth | GCFont | GCForeground | GCBackground,
2915 &gc_values);
2917 /* Reverse video style. */
2918 gc_values.foreground = f->output_data.x->background_pixel;
2919 gc_values.background = f->output_data.x->foreground_pixel;
2920 f->output_data.x->reverse_gc
2921 = XCreateGC (FRAME_X_DISPLAY (f),
2922 FRAME_X_WINDOW (f),
2923 GCFont | GCForeground | GCBackground | GCLineWidth,
2924 &gc_values);
2926 /* Cursor has cursor-color background, background-color foreground. */
2927 gc_values.foreground = f->output_data.x->background_pixel;
2928 gc_values.background = f->output_data.x->cursor_pixel;
2929 gc_values.fill_style = FillOpaqueStippled;
2930 gc_values.stipple
2931 = XCreateBitmapFromData (FRAME_X_DISPLAY (f),
2932 FRAME_X_DISPLAY_INFO (f)->root_window,
2933 cursor_bits, 16, 16);
2934 f->output_data.x->cursor_gc
2935 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2936 (GCFont | GCForeground | GCBackground
2937 | GCFillStyle /* | GCStipple */ | GCLineWidth),
2938 &gc_values);
2940 /* Reliefs. */
2941 f->output_data.x->white_relief.gc = 0;
2942 f->output_data.x->black_relief.gc = 0;
2944 /* Create the gray border tile used when the pointer is not in
2945 the frame. Since this depends on the frame's pixel values,
2946 this must be done on a per-frame basis. */
2947 f->output_data.x->border_tile
2948 = (XCreatePixmapFromBitmapData
2949 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
2950 gray_bits, gray_width, gray_height,
2951 f->output_data.x->foreground_pixel,
2952 f->output_data.x->background_pixel,
2953 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
2955 UNBLOCK_INPUT;
2959 /* Free what was was allocated in x_make_gc. */
2961 void
2962 x_free_gcs (f)
2963 struct frame *f;
2965 Display *dpy = FRAME_X_DISPLAY (f);
2967 BLOCK_INPUT;
2969 if (f->output_data.x->normal_gc)
2971 XFreeGC (dpy, f->output_data.x->normal_gc);
2972 f->output_data.x->normal_gc = 0;
2975 if (f->output_data.x->reverse_gc)
2977 XFreeGC (dpy, f->output_data.x->reverse_gc);
2978 f->output_data.x->reverse_gc = 0;
2981 if (f->output_data.x->cursor_gc)
2983 XFreeGC (dpy, f->output_data.x->cursor_gc);
2984 f->output_data.x->cursor_gc = 0;
2987 if (f->output_data.x->border_tile)
2989 XFreePixmap (dpy, f->output_data.x->border_tile);
2990 f->output_data.x->border_tile = 0;
2993 UNBLOCK_INPUT;
2997 /* Handler for signals raised during x_create_frame and
2998 x_create_top_frame. FRAME is the frame which is partially
2999 constructed. */
3001 static Lisp_Object
3002 unwind_create_frame (frame)
3003 Lisp_Object frame;
3005 struct frame *f = XFRAME (frame);
3007 /* If frame is ``official'', nothing to do. */
3008 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
3010 #if GLYPH_DEBUG
3011 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3012 #endif
3014 x_free_frame_resources (f);
3016 #if GLYPH_DEBUG
3017 /* Check that reference counts are indeed correct. */
3018 xassert (dpyinfo->reference_count == dpyinfo_refcount);
3019 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
3020 #endif
3021 return Qt;
3024 return Qnil;
3028 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
3029 1, 1, 0,
3030 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
3031 Returns an Emacs frame object.
3032 ALIST is an alist of frame parameters.
3033 If the parameters specify that the frame should not have a minibuffer,
3034 and do not specify a specific minibuffer window to use,
3035 then `default-minibuffer-frame' must be a frame whose minibuffer can
3036 be shared by the new frame.
3038 This function is an internal primitive--use `make-frame' instead. */)
3039 (parms)
3040 Lisp_Object parms;
3042 struct frame *f;
3043 Lisp_Object frame, tem;
3044 Lisp_Object name;
3045 int minibuffer_only = 0;
3046 long window_prompting = 0;
3047 int width, height;
3048 int count = SPECPDL_INDEX ();
3049 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3050 Lisp_Object display;
3051 struct x_display_info *dpyinfo = NULL;
3052 Lisp_Object parent;
3053 struct kboard *kb;
3055 check_x ();
3057 parms = Fcopy_alist (parms);
3059 /* Use this general default value to start with
3060 until we know if this frame has a specified name. */
3061 Vx_resource_name = Vinvocation_name;
3063 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3064 if (EQ (display, Qunbound))
3065 display = Qnil;
3066 dpyinfo = check_x_display_info (display);
3067 #ifdef MULTI_KBOARD
3068 kb = dpyinfo->kboard;
3069 #else
3070 kb = &the_only_kboard;
3071 #endif
3073 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3074 if (!STRINGP (name)
3075 && ! EQ (name, Qunbound)
3076 && ! NILP (name))
3077 error ("Invalid frame name--not a string or nil");
3079 if (STRINGP (name))
3080 Vx_resource_name = name;
3082 /* See if parent window is specified. */
3083 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3084 if (EQ (parent, Qunbound))
3085 parent = Qnil;
3086 if (! NILP (parent))
3087 CHECK_NUMBER (parent);
3089 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3090 /* No need to protect DISPLAY because that's not used after passing
3091 it to make_frame_without_minibuffer. */
3092 frame = Qnil;
3093 GCPRO4 (parms, parent, name, frame);
3094 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3095 RES_TYPE_SYMBOL);
3096 if (EQ (tem, Qnone) || NILP (tem))
3097 f = make_frame_without_minibuffer (Qnil, kb, display);
3098 else if (EQ (tem, Qonly))
3100 f = make_minibuffer_frame ();
3101 minibuffer_only = 1;
3103 else if (WINDOWP (tem))
3104 f = make_frame_without_minibuffer (tem, kb, display);
3105 else
3106 f = make_frame (1);
3108 XSETFRAME (frame, f);
3110 /* Note that X Windows does support scroll bars. */
3111 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
3113 f->output_method = output_x_window;
3114 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
3115 bzero (f->output_data.x, sizeof (struct x_output));
3116 f->output_data.x->icon_bitmap = -1;
3117 FRAME_FONTSET (f) = -1;
3118 f->output_data.x->scroll_bar_foreground_pixel = -1;
3119 f->output_data.x->scroll_bar_background_pixel = -1;
3120 #ifdef USE_TOOLKIT_SCROLL_BARS
3121 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
3122 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
3123 #endif /* USE_TOOLKIT_SCROLL_BARS */
3125 f->icon_name
3126 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3127 RES_TYPE_STRING);
3128 if (! STRINGP (f->icon_name))
3129 f->icon_name = Qnil;
3131 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3133 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
3134 record_unwind_protect (unwind_create_frame, frame);
3135 #if GLYPH_DEBUG
3136 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
3137 dpyinfo_refcount = dpyinfo->reference_count;
3138 #endif /* GLYPH_DEBUG */
3139 #ifdef MULTI_KBOARD
3140 FRAME_KBOARD (f) = kb;
3141 #endif
3143 /* These colors will be set anyway later, but it's important
3144 to get the color reference counts right, so initialize them! */
3146 Lisp_Object black;
3147 struct gcpro gcpro1;
3149 /* Function x_decode_color can signal an error. Make
3150 sure to initialize color slots so that we won't try
3151 to free colors we haven't allocated. */
3152 f->output_data.x->foreground_pixel = -1;
3153 f->output_data.x->background_pixel = -1;
3154 f->output_data.x->cursor_pixel = -1;
3155 f->output_data.x->cursor_foreground_pixel = -1;
3156 f->output_data.x->border_pixel = -1;
3157 f->output_data.x->mouse_pixel = -1;
3159 black = build_string ("black");
3160 GCPRO1 (black);
3161 f->output_data.x->foreground_pixel
3162 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3163 f->output_data.x->background_pixel
3164 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3165 f->output_data.x->cursor_pixel
3166 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3167 f->output_data.x->cursor_foreground_pixel
3168 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3169 f->output_data.x->border_pixel
3170 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3171 f->output_data.x->mouse_pixel
3172 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3173 UNGCPRO;
3176 /* Specify the parent under which to make this X window. */
3178 if (!NILP (parent))
3180 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3181 f->output_data.x->explicit_parent = 1;
3183 else
3185 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3186 f->output_data.x->explicit_parent = 0;
3189 /* Set the name; the functions to which we pass f expect the name to
3190 be set. */
3191 if (EQ (name, Qunbound) || NILP (name))
3193 f->name = build_string (dpyinfo->x_id_name);
3194 f->explicit_name = 0;
3196 else
3198 f->name = name;
3199 f->explicit_name = 1;
3200 /* use the frame's title when getting resources for this frame. */
3201 specbind (Qx_resource_name, name);
3204 /* Extract the window parameters from the supplied values
3205 that are needed to determine window geometry. */
3207 Lisp_Object font;
3209 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
3211 BLOCK_INPUT;
3212 /* First, try whatever font the caller has specified. */
3213 if (STRINGP (font))
3215 tem = Fquery_fontset (font, Qnil);
3216 if (STRINGP (tem))
3217 font = x_new_fontset (f, SDATA (tem));
3218 else
3219 font = x_new_font (f, SDATA (font));
3222 /* Try out a font which we hope has bold and italic variations. */
3223 if (!STRINGP (font))
3224 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
3225 if (!STRINGP (font))
3226 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3227 if (! STRINGP (font))
3228 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3229 if (! STRINGP (font))
3230 /* This was formerly the first thing tried, but it finds too many fonts
3231 and takes too long. */
3232 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
3233 /* If those didn't work, look for something which will at least work. */
3234 if (! STRINGP (font))
3235 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
3236 UNBLOCK_INPUT;
3237 if (! STRINGP (font))
3238 font = build_string ("fixed");
3240 x_set_frame_parameters (f, Fcons (Fcons (Qfont, font), Qnil));
3243 #ifdef USE_LUCID
3244 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
3245 whereby it fails to get any font. */
3246 xlwmenu_default_font = FRAME_FONT (f);
3247 #endif
3249 x_default_parameter (f, parms, Qborder_width, make_number (2),
3250 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3252 /* This defaults to 1 in order to match xterm. We recognize either
3253 internalBorderWidth or internalBorder (which is what xterm calls
3254 it). */
3255 if (NILP (Fassq (Qinternal_border_width, parms)))
3257 Lisp_Object value;
3259 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
3260 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
3261 if (! EQ (value, Qunbound))
3262 parms = Fcons (Fcons (Qinternal_border_width, value),
3263 parms);
3265 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
3266 "internalBorderWidth", "internalBorderWidth",
3267 RES_TYPE_NUMBER);
3268 x_default_parameter (f, parms, Qvertical_scroll_bars, Qleft,
3269 "verticalScrollBars", "ScrollBars",
3270 RES_TYPE_SYMBOL);
3272 /* Also do the stuff which must be set before the window exists. */
3273 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
3274 "foreground", "Foreground", RES_TYPE_STRING);
3275 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
3276 "background", "Background", RES_TYPE_STRING);
3277 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
3278 "pointerColor", "Foreground", RES_TYPE_STRING);
3279 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
3280 "cursorColor", "Foreground", RES_TYPE_STRING);
3281 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
3282 "borderColor", "BorderColor", RES_TYPE_STRING);
3283 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
3284 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
3285 x_default_parameter (f, parms, Qline_spacing, Qnil,
3286 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
3287 x_default_parameter (f, parms, Qleft_fringe, Qnil,
3288 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
3289 x_default_parameter (f, parms, Qright_fringe, Qnil,
3290 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
3292 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
3293 "scrollBarForeground",
3294 "ScrollBarForeground", 1);
3295 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
3296 "scrollBarBackground",
3297 "ScrollBarBackground", 0);
3299 /* Init faces before x_default_parameter is called for scroll-bar
3300 parameters because that function calls x_set_scroll_bar_width,
3301 which calls change_frame_size, which calls Fset_window_buffer,
3302 which runs hooks, which call Fvertical_motion. At the end, we
3303 end up in init_iterator with a null face cache, which should not
3304 happen. */
3305 init_frame_faces (f);
3307 x_default_parameter (f, parms, Qmenu_bar_lines, make_number (1),
3308 "menuBar", "MenuBar", RES_TYPE_NUMBER);
3309 x_default_parameter (f, parms, Qtool_bar_lines, make_number (1),
3310 "toolBar", "ToolBar", RES_TYPE_NUMBER);
3311 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
3312 "bufferPredicate", "BufferPredicate",
3313 RES_TYPE_SYMBOL);
3314 x_default_parameter (f, parms, Qtitle, Qnil,
3315 "title", "Title", RES_TYPE_STRING);
3316 x_default_parameter (f, parms, Qwait_for_wm, Qt,
3317 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
3318 x_default_parameter (f, parms, Qfullscreen, Qnil,
3319 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
3321 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3323 /* Compute the size of the X window. */
3324 window_prompting = x_figure_window_size (f, parms, 1);
3326 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
3327 f->no_split = minibuffer_only || EQ (tem, Qt);
3329 x_icon_verify (f, parms);
3331 /* Create the X widget or window. */
3332 #ifdef USE_X_TOOLKIT
3333 x_window (f, window_prompting, minibuffer_only);
3334 #else
3335 x_window (f);
3336 #endif
3338 x_icon (f, parms);
3339 x_make_gc (f);
3341 /* Now consider the frame official. */
3342 FRAME_X_DISPLAY_INFO (f)->reference_count++;
3343 Vframe_list = Fcons (frame, Vframe_list);
3345 /* We need to do this after creating the X window, so that the
3346 icon-creation functions can say whose icon they're describing. */
3347 x_default_parameter (f, parms, Qicon_type, Qt,
3348 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
3350 x_default_parameter (f, parms, Qauto_raise, Qnil,
3351 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3352 x_default_parameter (f, parms, Qauto_lower, Qnil,
3353 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
3354 x_default_parameter (f, parms, Qcursor_type, Qbox,
3355 "cursorType", "CursorType", RES_TYPE_SYMBOL);
3356 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
3357 "scrollBarWidth", "ScrollBarWidth",
3358 RES_TYPE_NUMBER);
3360 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3361 Change will not be effected unless different from the current
3362 FRAME_LINES (f). */
3363 width = FRAME_COLS (f);
3364 height = FRAME_LINES (f);
3366 SET_FRAME_COLS (f, 0);
3367 FRAME_LINES (f) = 0;
3368 change_frame_size (f, height, width, 1, 0, 0);
3370 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3371 /* Create the menu bar. */
3372 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
3374 /* If this signals an error, we haven't set size hints for the
3375 frame and we didn't make it visible. */
3376 initialize_frame_menubar (f);
3378 #ifndef USE_GTK
3379 /* This is a no-op, except under Motif where it arranges the
3380 main window for the widgets on it. */
3381 lw_set_main_areas (f->output_data.x->column_widget,
3382 f->output_data.x->menubar_widget,
3383 f->output_data.x->edit_widget);
3384 #endif /* not USE_GTK */
3386 #endif /* USE_X_TOOLKIT || USE_GTK */
3388 /* Tell the server what size and position, etc, we want, and how
3389 badly we want them. This should be done after we have the menu
3390 bar so that its size can be taken into account. */
3391 BLOCK_INPUT;
3392 x_wm_set_size_hint (f, window_prompting, 0);
3393 UNBLOCK_INPUT;
3395 /* Make the window appear on the frame and enable display, unless
3396 the caller says not to. However, with explicit parent, Emacs
3397 cannot control visibility, so don't try. */
3398 if (! f->output_data.x->explicit_parent)
3400 Lisp_Object visibility;
3402 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
3403 RES_TYPE_SYMBOL);
3404 if (EQ (visibility, Qunbound))
3405 visibility = Qt;
3407 if (EQ (visibility, Qicon))
3408 x_iconify_frame (f);
3409 else if (! NILP (visibility))
3410 x_make_frame_visible (f);
3411 else
3412 /* Must have been Qnil. */
3416 /* Set the WM leader property. GTK does this itself, so this is not
3417 needed when using GTK. */
3418 if (dpyinfo->client_leader_window != 0)
3420 BLOCK_INPUT;
3421 XChangeProperty (FRAME_X_DISPLAY (f),
3422 FRAME_OUTER_WINDOW (f),
3423 dpyinfo->Xatom_wm_client_leader,
3424 XA_WINDOW, 32, PropModeReplace,
3425 (unsigned char *) &dpyinfo->client_leader_window, 1);
3426 UNBLOCK_INPUT;
3429 /* Initialize `default-minibuffer-frame' in case this is the first
3430 frame on this display device. */
3431 if (FRAME_HAS_MINIBUF_P (f)
3432 && (!FRAMEP (kb->Vdefault_minibuffer_frame)
3433 || !FRAME_LIVE_P (XFRAME (kb->Vdefault_minibuffer_frame))))
3434 kb->Vdefault_minibuffer_frame = frame;
3436 /* All remaining specified parameters, which have not been "used"
3437 by x_get_arg and friends, now go in the misc. alist of the frame. */
3438 for (tem = parms; !NILP (tem); tem = XCDR (tem))
3439 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
3440 f->param_alist = Fcons (XCAR (tem), f->param_alist);
3442 UNGCPRO;
3444 /* Make sure windows on this frame appear in calls to next-window
3445 and similar functions. */
3446 Vwindow_list = Qnil;
3448 return unbind_to (count, frame);
3452 /* FRAME is used only to get a handle on the X display. We don't pass the
3453 display info directly because we're called from frame.c, which doesn't
3454 know about that structure. */
3456 Lisp_Object
3457 x_get_focus_frame (frame)
3458 struct frame *frame;
3460 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
3461 Lisp_Object xfocus;
3462 if (! dpyinfo->x_focus_frame)
3463 return Qnil;
3465 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
3466 return xfocus;
3470 /* In certain situations, when the window manager follows a
3471 click-to-focus policy, there seems to be no way around calling
3472 XSetInputFocus to give another frame the input focus .
3474 In an ideal world, XSetInputFocus should generally be avoided so
3475 that applications don't interfere with the window manager's focus
3476 policy. But I think it's okay to use when it's clearly done
3477 following a user-command. */
3479 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
3480 doc: /* Set the input focus to FRAME.
3481 FRAME nil means use the selected frame. */)
3482 (frame)
3483 Lisp_Object frame;
3485 struct frame *f = check_x_frame (frame);
3486 Display *dpy = FRAME_X_DISPLAY (f);
3488 BLOCK_INPUT;
3489 x_catch_errors (dpy);
3490 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3491 RevertToParent, CurrentTime);
3492 x_uncatch_errors ();
3493 UNBLOCK_INPUT;
3495 return Qnil;
3499 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
3500 doc: /* Internal function called by `color-defined-p', which see. */)
3501 (color, frame)
3502 Lisp_Object color, frame;
3504 XColor foo;
3505 FRAME_PTR f = check_x_frame (frame);
3507 CHECK_STRING (color);
3509 if (x_defined_color (f, SDATA (color), &foo, 0))
3510 return Qt;
3511 else
3512 return Qnil;
3515 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
3516 doc: /* Internal function called by `color-values', which see. */)
3517 (color, frame)
3518 Lisp_Object color, frame;
3520 XColor foo;
3521 FRAME_PTR f = check_x_frame (frame);
3523 CHECK_STRING (color);
3525 if (x_defined_color (f, SDATA (color), &foo, 0))
3526 return list3 (make_number (foo.red),
3527 make_number (foo.green),
3528 make_number (foo.blue));
3529 else
3530 return Qnil;
3533 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
3534 doc: /* Internal function called by `display-color-p', which see. */)
3535 (display)
3536 Lisp_Object display;
3538 struct x_display_info *dpyinfo = check_x_display_info (display);
3540 if (dpyinfo->n_planes <= 2)
3541 return Qnil;
3543 switch (dpyinfo->visual->class)
3545 case StaticColor:
3546 case PseudoColor:
3547 case TrueColor:
3548 case DirectColor:
3549 return Qt;
3551 default:
3552 return Qnil;
3556 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
3557 0, 1, 0,
3558 doc: /* Return t if the X display supports shades of gray.
3559 Note that color displays do support shades of gray.
3560 The optional argument DISPLAY specifies which display to ask about.
3561 DISPLAY should be either a frame or a display name (a string).
3562 If omitted or nil, that stands for the selected frame's display. */)
3563 (display)
3564 Lisp_Object display;
3566 struct x_display_info *dpyinfo = check_x_display_info (display);
3568 if (dpyinfo->n_planes <= 1)
3569 return Qnil;
3571 switch (dpyinfo->visual->class)
3573 case StaticColor:
3574 case PseudoColor:
3575 case TrueColor:
3576 case DirectColor:
3577 case StaticGray:
3578 case GrayScale:
3579 return Qt;
3581 default:
3582 return Qnil;
3586 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
3587 0, 1, 0,
3588 doc: /* Returns the width in pixels of the X display DISPLAY.
3589 The optional argument DISPLAY specifies which display to ask about.
3590 DISPLAY should be either a frame or a display name (a string).
3591 If omitted or nil, that stands for the selected frame's display. */)
3592 (display)
3593 Lisp_Object display;
3595 struct x_display_info *dpyinfo = check_x_display_info (display);
3597 return make_number (dpyinfo->width);
3600 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
3601 Sx_display_pixel_height, 0, 1, 0,
3602 doc: /* Returns the height in pixels of the X display DISPLAY.
3603 The optional argument DISPLAY specifies which display to ask about.
3604 DISPLAY should be either a frame or a display name (a string).
3605 If omitted or nil, that stands for the selected frame's display. */)
3606 (display)
3607 Lisp_Object display;
3609 struct x_display_info *dpyinfo = check_x_display_info (display);
3611 return make_number (dpyinfo->height);
3614 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
3615 0, 1, 0,
3616 doc: /* Returns the number of bitplanes of the X display DISPLAY.
3617 The optional argument DISPLAY specifies which display to ask about.
3618 DISPLAY should be either a frame or a display name (a string).
3619 If omitted or nil, that stands for the selected frame's display. */)
3620 (display)
3621 Lisp_Object display;
3623 struct x_display_info *dpyinfo = check_x_display_info (display);
3625 return make_number (dpyinfo->n_planes);
3628 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
3629 0, 1, 0,
3630 doc: /* Returns the number of color cells of the X display DISPLAY.
3631 The optional argument DISPLAY specifies which display to ask about.
3632 DISPLAY should be either a frame or a display name (a string).
3633 If omitted or nil, that stands for the selected frame's display. */)
3634 (display)
3635 Lisp_Object display;
3637 struct x_display_info *dpyinfo = check_x_display_info (display);
3639 int nr_planes = DisplayPlanes (dpyinfo->display,
3640 XScreenNumberOfScreen (dpyinfo->screen));
3642 /* Truncate nr_planes to 24 to avoid integer overflow.
3643 Some displays says 32, but only 24 bits are actually significant.
3644 There are only very few and rare video cards that have more than
3645 24 significant bits. Also 24 bits is more than 16 million colors,
3646 it "should be enough for everyone". */
3647 if (nr_planes > 24) nr_planes = 24;
3649 return make_number (1 << nr_planes);
3652 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
3653 Sx_server_max_request_size,
3654 0, 1, 0,
3655 doc: /* Returns the maximum request size of the X server of display DISPLAY.
3656 The optional argument DISPLAY specifies which display to ask about.
3657 DISPLAY should be either a frame or a display name (a string).
3658 If omitted or nil, that stands for the selected frame's display. */)
3659 (display)
3660 Lisp_Object display;
3662 struct x_display_info *dpyinfo = check_x_display_info (display);
3664 return make_number (MAXREQUEST (dpyinfo->display));
3667 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
3668 doc: /* Returns the "vendor ID" string of the X server of display DISPLAY.
3669 \(Labelling every distributor as a "vendor" embodies the false assumption
3670 that operating systems cannot be developed and distributed noncommercially.)
3671 The optional argument DISPLAY specifies which display to ask about.
3672 DISPLAY should be either a frame or a display name (a string).
3673 If omitted or nil, that stands for the selected frame's display. */)
3674 (display)
3675 Lisp_Object display;
3677 struct x_display_info *dpyinfo = check_x_display_info (display);
3678 char *vendor = ServerVendor (dpyinfo->display);
3680 if (! vendor) vendor = "";
3681 return build_string (vendor);
3684 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
3685 doc: /* Returns the version numbers of the X server of display DISPLAY.
3686 The value is a list of three integers: the major and minor
3687 version numbers of the X Protocol in use, and the distributor-specific release
3688 number. See also the function `x-server-vendor'.
3690 The optional argument DISPLAY specifies which display to ask about.
3691 DISPLAY should be either a frame or a display name (a string).
3692 If omitted or nil, that stands for the selected frame's display. */)
3693 (display)
3694 Lisp_Object display;
3696 struct x_display_info *dpyinfo = check_x_display_info (display);
3697 Display *dpy = dpyinfo->display;
3699 return Fcons (make_number (ProtocolVersion (dpy)),
3700 Fcons (make_number (ProtocolRevision (dpy)),
3701 Fcons (make_number (VendorRelease (dpy)), Qnil)));
3704 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
3705 doc: /* Return the number of screens on the X server of display DISPLAY.
3706 The optional argument DISPLAY specifies which display to ask about.
3707 DISPLAY should be either a frame or a display name (a string).
3708 If omitted or nil, that stands for the selected frame's display. */)
3709 (display)
3710 Lisp_Object display;
3712 struct x_display_info *dpyinfo = check_x_display_info (display);
3714 return make_number (ScreenCount (dpyinfo->display));
3717 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
3718 doc: /* Return the height in millimeters of the X display DISPLAY.
3719 The optional argument DISPLAY specifies which display to ask about.
3720 DISPLAY should be either a frame or a display name (a string).
3721 If omitted or nil, that stands for the selected frame's display. */)
3722 (display)
3723 Lisp_Object display;
3725 struct x_display_info *dpyinfo = check_x_display_info (display);
3727 return make_number (HeightMMOfScreen (dpyinfo->screen));
3730 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
3731 doc: /* Return the width in millimeters of the X display DISPLAY.
3732 The optional argument DISPLAY specifies which display to ask about.
3733 DISPLAY should be either a frame or a display name (a string).
3734 If omitted or nil, that stands for the selected frame's display. */)
3735 (display)
3736 Lisp_Object display;
3738 struct x_display_info *dpyinfo = check_x_display_info (display);
3740 return make_number (WidthMMOfScreen (dpyinfo->screen));
3743 DEFUN ("x-display-backing-store", Fx_display_backing_store,
3744 Sx_display_backing_store, 0, 1, 0,
3745 doc: /* Returns an indication of whether X display DISPLAY does backing store.
3746 The value may be `always', `when-mapped', or `not-useful'.
3747 The optional argument DISPLAY specifies which display to ask about.
3748 DISPLAY should be either a frame or a display name (a string).
3749 If omitted or nil, that stands for the selected frame's display. */)
3750 (display)
3751 Lisp_Object display;
3753 struct x_display_info *dpyinfo = check_x_display_info (display);
3754 Lisp_Object result;
3756 switch (DoesBackingStore (dpyinfo->screen))
3758 case Always:
3759 result = intern ("always");
3760 break;
3762 case WhenMapped:
3763 result = intern ("when-mapped");
3764 break;
3766 case NotUseful:
3767 result = intern ("not-useful");
3768 break;
3770 default:
3771 error ("Strange value for BackingStore parameter of screen");
3772 result = Qnil;
3775 return result;
3778 DEFUN ("x-display-visual-class", Fx_display_visual_class,
3779 Sx_display_visual_class, 0, 1, 0,
3780 doc: /* Return the visual class of the X display DISPLAY.
3781 The value is one of the symbols `static-gray', `gray-scale',
3782 `static-color', `pseudo-color', `true-color', or `direct-color'.
3784 The optional argument DISPLAY specifies which display to ask about.
3785 DISPLAY should be either a frame or a display name (a string).
3786 If omitted or nil, that stands for the selected frame's display. */)
3787 (display)
3788 Lisp_Object display;
3790 struct x_display_info *dpyinfo = check_x_display_info (display);
3791 Lisp_Object result;
3793 switch (dpyinfo->visual->class)
3795 case StaticGray:
3796 result = intern ("static-gray");
3797 break;
3798 case GrayScale:
3799 result = intern ("gray-scale");
3800 break;
3801 case StaticColor:
3802 result = intern ("static-color");
3803 break;
3804 case PseudoColor:
3805 result = intern ("pseudo-color");
3806 break;
3807 case TrueColor:
3808 result = intern ("true-color");
3809 break;
3810 case DirectColor:
3811 result = intern ("direct-color");
3812 break;
3813 default:
3814 error ("Display has an unknown visual class");
3815 result = Qnil;
3818 return result;
3821 DEFUN ("x-display-save-under", Fx_display_save_under,
3822 Sx_display_save_under, 0, 1, 0,
3823 doc: /* Returns t if the X display DISPLAY supports the save-under feature.
3824 The optional argument DISPLAY specifies which display to ask about.
3825 DISPLAY should be either a frame or a display name (a string).
3826 If omitted or nil, that stands for the selected frame's display. */)
3827 (display)
3828 Lisp_Object display;
3830 struct x_display_info *dpyinfo = check_x_display_info (display);
3832 if (DoesSaveUnders (dpyinfo->screen) == True)
3833 return Qt;
3834 else
3835 return Qnil;
3839 x_pixel_width (f)
3840 register struct frame *f;
3842 return FRAME_PIXEL_WIDTH (f);
3846 x_pixel_height (f)
3847 register struct frame *f;
3849 return FRAME_PIXEL_HEIGHT (f);
3853 x_char_width (f)
3854 register struct frame *f;
3856 return FRAME_COLUMN_WIDTH (f);
3860 x_char_height (f)
3861 register struct frame *f;
3863 return FRAME_LINE_HEIGHT (f);
3867 x_screen_planes (f)
3868 register struct frame *f;
3870 return FRAME_X_DISPLAY_INFO (f)->n_planes;
3875 /************************************************************************
3876 X Displays
3877 ************************************************************************/
3880 /* Mapping visual names to visuals. */
3882 static struct visual_class
3884 char *name;
3885 int class;
3887 visual_classes[] =
3889 {"StaticGray", StaticGray},
3890 {"GrayScale", GrayScale},
3891 {"StaticColor", StaticColor},
3892 {"PseudoColor", PseudoColor},
3893 {"TrueColor", TrueColor},
3894 {"DirectColor", DirectColor},
3895 {NULL, 0}
3899 #ifndef HAVE_XSCREENNUMBEROFSCREEN
3901 /* Value is the screen number of screen SCR. This is a substitute for
3902 the X function with the same name when that doesn't exist. */
3905 XScreenNumberOfScreen (scr)
3906 register Screen *scr;
3908 Display *dpy = scr->display;
3909 int i;
3911 for (i = 0; i < dpy->nscreens; ++i)
3912 if (scr == dpy->screens + i)
3913 break;
3915 return i;
3918 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
3921 /* Select the visual that should be used on display DPYINFO. Set
3922 members of DPYINFO appropriately. Called from x_term_init. */
3924 void
3925 select_visual (dpyinfo)
3926 struct x_display_info *dpyinfo;
3928 Display *dpy = dpyinfo->display;
3929 Screen *screen = dpyinfo->screen;
3930 Lisp_Object value;
3932 /* See if a visual is specified. */
3933 value = display_x_get_resource (dpyinfo,
3934 build_string ("visualClass"),
3935 build_string ("VisualClass"),
3936 Qnil, Qnil);
3937 if (STRINGP (value))
3939 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
3940 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
3941 depth, a decimal number. NAME is compared with case ignored. */
3942 char *s = (char *) alloca (SBYTES (value) + 1);
3943 char *dash;
3944 int i, class = -1;
3945 XVisualInfo vinfo;
3947 strcpy (s, SDATA (value));
3948 dash = index (s, '-');
3949 if (dash)
3951 dpyinfo->n_planes = atoi (dash + 1);
3952 *dash = '\0';
3954 else
3955 /* We won't find a matching visual with depth 0, so that
3956 an error will be printed below. */
3957 dpyinfo->n_planes = 0;
3959 /* Determine the visual class. */
3960 for (i = 0; visual_classes[i].name; ++i)
3961 if (xstricmp (s, visual_classes[i].name) == 0)
3963 class = visual_classes[i].class;
3964 break;
3967 /* Look up a matching visual for the specified class. */
3968 if (class == -1
3969 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
3970 dpyinfo->n_planes, class, &vinfo))
3971 fatal ("Invalid visual specification `%s'", SDATA (value));
3973 dpyinfo->visual = vinfo.visual;
3975 else
3977 int n_visuals;
3978 XVisualInfo *vinfo, vinfo_template;
3980 dpyinfo->visual = DefaultVisualOfScreen (screen);
3982 #ifdef HAVE_X11R4
3983 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
3984 #else
3985 vinfo_template.visualid = dpyinfo->visual->visualid;
3986 #endif
3987 vinfo_template.screen = XScreenNumberOfScreen (screen);
3988 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
3989 &vinfo_template, &n_visuals);
3990 if (n_visuals != 1)
3991 fatal ("Can't get proper X visual info");
3993 dpyinfo->n_planes = vinfo->depth;
3994 XFree ((char *) vinfo);
3999 /* Return the X display structure for the display named NAME.
4000 Open a new connection if necessary. */
4002 struct x_display_info *
4003 x_display_info_for_name (name)
4004 Lisp_Object name;
4006 Lisp_Object names;
4007 struct x_display_info *dpyinfo;
4009 CHECK_STRING (name);
4011 if (! EQ (Vwindow_system, intern ("x")))
4012 error ("Not using X Windows");
4014 for (dpyinfo = x_display_list, names = x_display_name_list;
4015 dpyinfo;
4016 dpyinfo = dpyinfo->next, names = XCDR (names))
4018 Lisp_Object tem;
4019 tem = Fstring_equal (XCAR (XCAR (names)), name);
4020 if (!NILP (tem))
4021 return dpyinfo;
4024 /* Use this general default value to start with. */
4025 Vx_resource_name = Vinvocation_name;
4027 validate_x_resource_name ();
4029 dpyinfo = x_term_init (name, (char *)0,
4030 (char *) SDATA (Vx_resource_name));
4032 if (dpyinfo == 0)
4033 error ("Cannot connect to X server %s", SDATA (name));
4035 x_in_use = 1;
4036 XSETFASTINT (Vwindow_system_version, 11);
4038 return dpyinfo;
4042 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4043 1, 3, 0,
4044 doc: /* Open a connection to an X server.
4045 DISPLAY is the name of the display to connect to.
4046 Optional second arg XRM-STRING is a string of resources in xrdb format.
4047 If the optional third arg MUST-SUCCEED is non-nil,
4048 terminate Emacs if we can't open the connection. */)
4049 (display, xrm_string, must_succeed)
4050 Lisp_Object display, xrm_string, must_succeed;
4052 unsigned char *xrm_option;
4053 struct x_display_info *dpyinfo;
4055 CHECK_STRING (display);
4056 if (! NILP (xrm_string))
4057 CHECK_STRING (xrm_string);
4059 if (! EQ (Vwindow_system, intern ("x")))
4060 error ("Not using X Windows");
4062 if (! NILP (xrm_string))
4063 xrm_option = (unsigned char *) SDATA (xrm_string);
4064 else
4065 xrm_option = (unsigned char *) 0;
4067 validate_x_resource_name ();
4069 /* This is what opens the connection and sets x_current_display.
4070 This also initializes many symbols, such as those used for input. */
4071 dpyinfo = x_term_init (display, xrm_option,
4072 (char *) SDATA (Vx_resource_name));
4074 if (dpyinfo == 0)
4076 if (!NILP (must_succeed))
4077 fatal ("Cannot connect to X server %s.\n\
4078 Check the DISPLAY environment variable or use `-d'.\n\
4079 Also use the `xauth' program to verify that you have the proper\n\
4080 authorization information needed to connect the X server.\n\
4081 An insecure way to solve the problem may be to use `xhost'.\n",
4082 SDATA (display));
4083 else
4084 error ("Cannot connect to X server %s", SDATA (display));
4087 x_in_use = 1;
4089 XSETFASTINT (Vwindow_system_version, 11);
4090 return Qnil;
4093 DEFUN ("x-close-connection", Fx_close_connection,
4094 Sx_close_connection, 1, 1, 0,
4095 doc: /* Close the connection to DISPLAY's X server.
4096 For DISPLAY, specify either a frame or a display name (a string).
4097 If DISPLAY is nil, that stands for the selected frame's display. */)
4098 (display)
4099 Lisp_Object display;
4101 struct x_display_info *dpyinfo = check_x_display_info (display);
4102 int i;
4104 if (dpyinfo->reference_count > 0)
4105 error ("Display still has frames on it");
4107 BLOCK_INPUT;
4108 /* Free the fonts in the font table. */
4109 for (i = 0; i < dpyinfo->n_fonts; i++)
4110 if (dpyinfo->font_table[i].name)
4112 XFreeFont (dpyinfo->display, dpyinfo->font_table[i].font);
4115 x_destroy_all_bitmaps (dpyinfo);
4116 XSetCloseDownMode (dpyinfo->display, DestroyAll);
4118 #ifdef USE_GTK
4119 xg_display_close (dpyinfo->display);
4120 #else
4121 #ifdef USE_X_TOOLKIT
4122 XtCloseDisplay (dpyinfo->display);
4123 #else
4124 XCloseDisplay (dpyinfo->display);
4125 #endif
4126 #endif /* ! USE_GTK */
4128 x_delete_display (dpyinfo);
4129 UNBLOCK_INPUT;
4131 return Qnil;
4134 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4135 doc: /* Return the list of display names that Emacs has connections to. */)
4138 Lisp_Object tail, result;
4140 result = Qnil;
4141 for (tail = x_display_name_list; ! NILP (tail); tail = XCDR (tail))
4142 result = Fcons (XCAR (XCAR (tail)), result);
4144 return result;
4147 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4148 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4149 If ON is nil, allow buffering of requests.
4150 Turning on synchronization prohibits the Xlib routines from buffering
4151 requests and seriously degrades performance, but makes debugging much
4152 easier.
4153 The optional second argument DISPLAY specifies which display to act on.
4154 DISPLAY should be either a frame or a display name (a string).
4155 If DISPLAY is omitted or nil, that stands for the selected frame's display. */)
4156 (on, display)
4157 Lisp_Object display, on;
4159 struct x_display_info *dpyinfo = check_x_display_info (display);
4161 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4163 return Qnil;
4166 /* Wait for responses to all X commands issued so far for frame F. */
4168 void
4169 x_sync (f)
4170 FRAME_PTR f;
4172 BLOCK_INPUT;
4173 XSync (FRAME_X_DISPLAY (f), False);
4174 UNBLOCK_INPUT;
4178 /***********************************************************************
4179 Window properties
4180 ***********************************************************************/
4182 DEFUN ("x-change-window-property", Fx_change_window_property,
4183 Sx_change_window_property, 2, 6, 0,
4184 doc: /* Change window property PROP to VALUE on the X window of FRAME.
4185 PROP must be a string.
4186 VALUE may be a string or a list of conses, numbers and/or strings.
4187 If an element in the list is a string, it is converted to
4188 an Atom and the value of the Atom is used. If an element is a cons,
4189 it is converted to a 32 bit number where the car is the 16 top bits and the
4190 cdr is the lower 16 bits.
4191 FRAME nil or omitted means use the selected frame.
4192 If TYPE is given and non-nil, it is the name of the type of VALUE.
4193 If TYPE is not given or nil, the type is STRING.
4194 FORMAT gives the size in bits of each element if VALUE is a list.
4195 It must be one of 8, 16 or 32.
4196 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
4197 If OUTER_P is non-nil, the property is changed for the outer X window of
4198 FRAME. Default is to change on the edit X window.
4200 Value is VALUE. */)
4201 (prop, value, frame, type, format, outer_p)
4202 Lisp_Object prop, value, frame, type, format, outer_p;
4204 struct frame *f = check_x_frame (frame);
4205 Atom prop_atom;
4206 Atom target_type = XA_STRING;
4207 int element_format = 8;
4208 unsigned char *data;
4209 int nelements;
4210 Window w;
4212 CHECK_STRING (prop);
4214 if (! NILP (format))
4216 CHECK_NUMBER (format);
4217 element_format = XFASTINT (format);
4219 if (element_format != 8 && element_format != 16
4220 && element_format != 32)
4221 error ("FORMAT must be one of 8, 16 or 32");
4224 if (CONSP (value))
4226 nelements = x_check_property_data (value);
4227 if (nelements == -1)
4228 error ("Bad data in VALUE, must be number, string or cons");
4230 if (element_format == 8)
4231 data = (unsigned char *) xmalloc (nelements);
4232 else if (element_format == 16)
4233 data = (unsigned char *) xmalloc (nelements*2);
4234 else /* format == 32 */
4235 /* The man page for XChangeProperty:
4236 "If the specified format is 32, the property data must be a
4237 long array."
4238 This applies even if long is more than 64 bits. The X library
4239 converts to 32 bits before sending to the X server. */
4240 data = (unsigned char *) xmalloc (nelements * sizeof(long));
4242 x_fill_property_data (FRAME_X_DISPLAY (f), value, data, element_format);
4244 else
4246 CHECK_STRING (value);
4247 data = SDATA (value);
4248 nelements = SCHARS (value);
4251 BLOCK_INPUT;
4252 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4253 if (! NILP (type))
4255 CHECK_STRING (type);
4256 target_type = XInternAtom (FRAME_X_DISPLAY (f), SDATA (type), False);
4259 if (! NILP (outer_p)) w = FRAME_OUTER_WINDOW (f);
4260 else w = FRAME_X_WINDOW (f);
4262 XChangeProperty (FRAME_X_DISPLAY (f), w,
4263 prop_atom, target_type, element_format, PropModeReplace,
4264 data, nelements);
4266 if (CONSP (value)) xfree (data);
4268 /* Make sure the property is set when we return. */
4269 XFlush (FRAME_X_DISPLAY (f));
4270 UNBLOCK_INPUT;
4272 return value;
4276 DEFUN ("x-delete-window-property", Fx_delete_window_property,
4277 Sx_delete_window_property, 1, 2, 0,
4278 doc: /* Remove window property PROP from X window of FRAME.
4279 FRAME nil or omitted means use the selected frame. Value is PROP. */)
4280 (prop, frame)
4281 Lisp_Object prop, frame;
4283 struct frame *f = check_x_frame (frame);
4284 Atom prop_atom;
4286 CHECK_STRING (prop);
4287 BLOCK_INPUT;
4288 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4289 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
4291 /* Make sure the property is removed when we return. */
4292 XFlush (FRAME_X_DISPLAY (f));
4293 UNBLOCK_INPUT;
4295 return prop;
4299 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
4300 1, 6, 0,
4301 doc: /* Value is the value of window property PROP on FRAME.
4302 If FRAME is nil or omitted, use the selected frame.
4303 If TYPE is nil or omitted, get the property as a string. Otherwise TYPE
4304 is the name of the Atom that denotes the type expected.
4305 If SOURCE is non-nil, get the property on that window instead of from
4306 FRAME. The number 0 denotes the root window.
4307 If DELETE_P is non-nil, delete the property after retreiving it.
4308 If VECTOR_RET_P is non-nil, don't return a string but a vector of values.
4310 Value is nil if FRAME hasn't a property with name PROP or if PROP has
4311 no value of TYPE. */)
4312 (prop, frame, type, source, delete_p, vector_ret_p)
4313 Lisp_Object prop, frame, type, source, delete_p, vector_ret_p;
4315 struct frame *f = check_x_frame (frame);
4316 Atom prop_atom;
4317 int rc;
4318 Lisp_Object prop_value = Qnil;
4319 unsigned char *tmp_data = NULL;
4320 Atom actual_type;
4321 Atom target_type = XA_STRING;
4322 int actual_format;
4323 unsigned long actual_size, bytes_remaining;
4324 Window target_window = FRAME_X_WINDOW (f);
4325 struct gcpro gcpro1;
4327 GCPRO1 (prop_value);
4328 CHECK_STRING (prop);
4330 if (! NILP (source))
4332 if (NUMBERP (source))
4334 if (FLOATP (source))
4335 target_window = (Window) XFLOAT (source);
4336 else
4337 target_window = XFASTINT (source);
4339 if (target_window == 0)
4340 target_window = FRAME_X_DISPLAY_INFO (f)->root_window;
4342 else if (CONSP (source))
4343 target_window = cons_to_long (source);
4346 BLOCK_INPUT;
4347 if (STRINGP (type))
4349 if (strcmp ("AnyPropertyType", SDATA (type)) == 0)
4350 target_type = AnyPropertyType;
4351 else
4352 target_type = XInternAtom (FRAME_X_DISPLAY (f), SDATA (type), False);
4355 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
4356 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4357 prop_atom, 0, 0, False, target_type,
4358 &actual_type, &actual_format, &actual_size,
4359 &bytes_remaining, &tmp_data);
4360 if (rc == Success)
4362 int size = bytes_remaining;
4364 XFree (tmp_data);
4365 tmp_data = NULL;
4367 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), target_window,
4368 prop_atom, 0, bytes_remaining,
4369 ! NILP (delete_p), target_type,
4370 &actual_type, &actual_format,
4371 &actual_size, &bytes_remaining,
4372 &tmp_data);
4373 if (rc == Success && tmp_data)
4375 /* The man page for XGetWindowProperty says:
4376 "If the returned format is 32, the returned data is represented
4377 as a long array and should be cast to that type to obtain the
4378 elements."
4379 This applies even if long is more than 32 bits, the X library
4380 converts from 32 bit elements received from the X server to long
4381 and passes the long array to us. Thus, for that case bcopy can not
4382 be used. We convert to a 32 bit type here, because so much code
4383 assume on that.
4385 The bytes and offsets passed to XGetWindowProperty refers to the
4386 property and those are indeed in 32 bit quantities if format is
4387 32. */
4389 if (actual_format == 32 && actual_format < BITS_PER_LONG)
4391 unsigned long i;
4392 int *idata = (int *) tmp_data;
4393 long *ldata = (long *) tmp_data;
4395 for (i = 0; i < actual_size; ++i)
4396 idata[i] = (int) ldata[i];
4399 if (NILP (vector_ret_p))
4400 prop_value = make_string (tmp_data, size);
4401 else
4402 prop_value = x_property_data_to_lisp (f,
4403 tmp_data,
4404 actual_type,
4405 actual_format,
4406 actual_size);
4409 if (tmp_data) XFree (tmp_data);
4412 UNBLOCK_INPUT;
4413 UNGCPRO;
4414 return prop_value;
4419 /***********************************************************************
4420 Busy cursor
4421 ***********************************************************************/
4423 /* If non-null, an asynchronous timer that, when it expires, displays
4424 an hourglass cursor on all frames. */
4426 static struct atimer *hourglass_atimer;
4428 /* Non-zero means an hourglass cursor is currently shown. */
4430 static int hourglass_shown_p;
4432 /* Number of seconds to wait before displaying an hourglass cursor. */
4434 static Lisp_Object Vhourglass_delay;
4436 /* Default number of seconds to wait before displaying an hourglass
4437 cursor. */
4439 #define DEFAULT_HOURGLASS_DELAY 1
4441 /* Function prototypes. */
4443 static void show_hourglass P_ ((struct atimer *));
4444 static void hide_hourglass P_ ((void));
4446 /* Return non-zero if houglass timer has been started or hourglass is shown. */
4449 hourglass_started ()
4451 return hourglass_shown_p || hourglass_atimer != NULL;
4455 /* Cancel a currently active hourglass timer, and start a new one. */
4457 void
4458 start_hourglass ()
4460 EMACS_TIME delay;
4461 int secs, usecs = 0;
4463 /* Don't bother for ttys. */
4464 if (NILP (Vwindow_system))
4465 return;
4467 cancel_hourglass ();
4469 if (INTEGERP (Vhourglass_delay)
4470 && XINT (Vhourglass_delay) > 0)
4471 secs = XFASTINT (Vhourglass_delay);
4472 else if (FLOATP (Vhourglass_delay)
4473 && XFLOAT_DATA (Vhourglass_delay) > 0)
4475 Lisp_Object tem;
4476 tem = Ftruncate (Vhourglass_delay, Qnil);
4477 secs = XFASTINT (tem);
4478 usecs = (XFLOAT_DATA (Vhourglass_delay) - secs) * 1000000;
4480 else
4481 secs = DEFAULT_HOURGLASS_DELAY;
4483 EMACS_SET_SECS_USECS (delay, secs, usecs);
4484 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
4485 show_hourglass, NULL);
4489 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
4490 shown. */
4492 void
4493 cancel_hourglass ()
4495 if (hourglass_atimer)
4497 cancel_atimer (hourglass_atimer);
4498 hourglass_atimer = NULL;
4501 if (hourglass_shown_p)
4502 hide_hourglass ();
4506 /* Timer function of hourglass_atimer. TIMER is equal to
4507 hourglass_atimer.
4509 Display an hourglass pointer on all frames by mapping the frames'
4510 hourglass_window. Set the hourglass_p flag in the frames'
4511 output_data.x structure to indicate that an hourglass cursor is
4512 shown on the frames. */
4514 static void
4515 show_hourglass (timer)
4516 struct atimer *timer;
4518 /* The timer implementation will cancel this timer automatically
4519 after this function has run. Set hourglass_atimer to null
4520 so that we know the timer doesn't have to be canceled. */
4521 hourglass_atimer = NULL;
4523 if (!hourglass_shown_p)
4525 Lisp_Object rest, frame;
4527 BLOCK_INPUT;
4529 FOR_EACH_FRAME (rest, frame)
4531 struct frame *f = XFRAME (frame);
4533 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
4535 Display *dpy = FRAME_X_DISPLAY (f);
4537 #ifdef USE_X_TOOLKIT
4538 if (f->output_data.x->widget)
4539 #else
4540 if (FRAME_OUTER_WINDOW (f))
4541 #endif
4543 f->output_data.x->hourglass_p = 1;
4545 if (!f->output_data.x->hourglass_window)
4547 unsigned long mask = CWCursor;
4548 XSetWindowAttributes attrs;
4549 #ifdef USE_GTK
4550 Window parent = FRAME_X_WINDOW (f);
4551 #else
4552 Window parent = FRAME_OUTER_WINDOW (f);
4553 #endif
4554 attrs.cursor = f->output_data.x->hourglass_cursor;
4556 f->output_data.x->hourglass_window
4557 = XCreateWindow (dpy, parent,
4558 0, 0, 32000, 32000, 0, 0,
4559 InputOnly,
4560 CopyFromParent,
4561 mask, &attrs);
4564 XMapRaised (dpy, f->output_data.x->hourglass_window);
4565 XFlush (dpy);
4570 hourglass_shown_p = 1;
4571 UNBLOCK_INPUT;
4576 /* Hide the hourglass pointer on all frames, if it is currently
4577 shown. */
4579 static void
4580 hide_hourglass ()
4582 if (hourglass_shown_p)
4584 Lisp_Object rest, frame;
4586 BLOCK_INPUT;
4587 FOR_EACH_FRAME (rest, frame)
4589 struct frame *f = XFRAME (frame);
4591 if (FRAME_X_P (f)
4592 /* Watch out for newly created frames. */
4593 && f->output_data.x->hourglass_window)
4595 XUnmapWindow (FRAME_X_DISPLAY (f),
4596 f->output_data.x->hourglass_window);
4597 /* Sync here because XTread_socket looks at the
4598 hourglass_p flag that is reset to zero below. */
4599 XSync (FRAME_X_DISPLAY (f), False);
4600 f->output_data.x->hourglass_p = 0;
4604 hourglass_shown_p = 0;
4605 UNBLOCK_INPUT;
4611 /***********************************************************************
4612 Tool tips
4613 ***********************************************************************/
4615 static Lisp_Object x_create_tip_frame P_ ((struct x_display_info *,
4616 Lisp_Object, Lisp_Object));
4617 static void compute_tip_xy P_ ((struct frame *, Lisp_Object, Lisp_Object,
4618 Lisp_Object, int, int, int *, int *));
4620 /* The frame of a currently visible tooltip. */
4622 Lisp_Object tip_frame;
4624 /* If non-nil, a timer started that hides the last tooltip when it
4625 fires. */
4627 Lisp_Object tip_timer;
4628 Window tip_window;
4630 /* If non-nil, a vector of 3 elements containing the last args
4631 with which x-show-tip was called. See there. */
4633 Lisp_Object last_show_tip_args;
4635 /* Maximum size for tooltips; a cons (COLUMNS . ROWS). */
4637 Lisp_Object Vx_max_tooltip_size;
4640 static Lisp_Object
4641 unwind_create_tip_frame (frame)
4642 Lisp_Object frame;
4644 Lisp_Object deleted;
4646 deleted = unwind_create_frame (frame);
4647 if (EQ (deleted, Qt))
4649 tip_window = None;
4650 tip_frame = Qnil;
4653 return deleted;
4657 /* Create a frame for a tooltip on the display described by DPYINFO.
4658 PARMS is a list of frame parameters. TEXT is the string to
4659 display in the tip frame. Value is the frame.
4661 Note that functions called here, esp. x_default_parameter can
4662 signal errors, for instance when a specified color name is
4663 undefined. We have to make sure that we're in a consistent state
4664 when this happens. */
4666 static Lisp_Object
4667 x_create_tip_frame (dpyinfo, parms, text)
4668 struct x_display_info *dpyinfo;
4669 Lisp_Object parms, text;
4671 struct frame *f;
4672 Lisp_Object frame, tem;
4673 Lisp_Object name;
4674 long window_prompting = 0;
4675 int width, height;
4676 int count = SPECPDL_INDEX ();
4677 struct gcpro gcpro1, gcpro2, gcpro3;
4678 struct kboard *kb;
4679 int face_change_count_before = face_change_count;
4680 Lisp_Object buffer;
4681 struct buffer *old_buffer;
4683 check_x ();
4685 parms = Fcopy_alist (parms);
4687 #ifdef MULTI_KBOARD
4688 kb = dpyinfo->kboard;
4689 #else
4690 kb = &the_only_kboard;
4691 #endif
4693 /* Get the name of the frame to use for resource lookup. */
4694 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4695 if (!STRINGP (name)
4696 && !EQ (name, Qunbound)
4697 && !NILP (name))
4698 error ("Invalid frame name--not a string or nil");
4700 frame = Qnil;
4701 GCPRO3 (parms, name, frame);
4702 f = make_frame (1);
4703 XSETFRAME (frame, f);
4705 buffer = Fget_buffer_create (build_string (" *tip*"));
4706 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer, Qnil);
4707 old_buffer = current_buffer;
4708 set_buffer_internal_1 (XBUFFER (buffer));
4709 current_buffer->truncate_lines = Qnil;
4710 specbind (Qinhibit_read_only, Qt);
4711 specbind (Qinhibit_modification_hooks, Qt);
4712 Ferase_buffer ();
4713 Finsert (1, &text);
4714 set_buffer_internal_1 (old_buffer);
4716 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
4717 record_unwind_protect (unwind_create_tip_frame, frame);
4719 /* By setting the output method, we're essentially saying that
4720 the frame is live, as per FRAME_LIVE_P. If we get a signal
4721 from this point on, x_destroy_window might screw up reference
4722 counts etc. */
4723 f->output_method = output_x_window;
4724 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4725 bzero (f->output_data.x, sizeof (struct x_output));
4726 f->output_data.x->icon_bitmap = -1;
4727 FRAME_FONTSET (f) = -1;
4728 f->output_data.x->scroll_bar_foreground_pixel = -1;
4729 f->output_data.x->scroll_bar_background_pixel = -1;
4730 #ifdef USE_TOOLKIT_SCROLL_BARS
4731 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
4732 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
4733 #endif /* USE_TOOLKIT_SCROLL_BARS */
4734 f->icon_name = Qnil;
4735 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4736 #if GLYPH_DEBUG
4737 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
4738 dpyinfo_refcount = dpyinfo->reference_count;
4739 #endif /* GLYPH_DEBUG */
4740 #ifdef MULTI_KBOARD
4741 FRAME_KBOARD (f) = kb;
4742 #endif
4743 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4744 f->output_data.x->explicit_parent = 0;
4746 /* These colors will be set anyway later, but it's important
4747 to get the color reference counts right, so initialize them! */
4749 Lisp_Object black;
4750 struct gcpro gcpro1;
4752 black = build_string ("black");
4753 GCPRO1 (black);
4754 f->output_data.x->foreground_pixel
4755 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4756 f->output_data.x->background_pixel
4757 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4758 f->output_data.x->cursor_pixel
4759 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4760 f->output_data.x->cursor_foreground_pixel
4761 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4762 f->output_data.x->border_pixel
4763 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4764 f->output_data.x->mouse_pixel
4765 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4766 UNGCPRO;
4769 /* Set the name; the functions to which we pass f expect the name to
4770 be set. */
4771 if (EQ (name, Qunbound) || NILP (name))
4773 f->name = build_string (dpyinfo->x_id_name);
4774 f->explicit_name = 0;
4776 else
4778 f->name = name;
4779 f->explicit_name = 1;
4780 /* use the frame's title when getting resources for this frame. */
4781 specbind (Qx_resource_name, name);
4784 /* Extract the window parameters from the supplied values that are
4785 needed to determine window geometry. */
4787 Lisp_Object font;
4789 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4791 BLOCK_INPUT;
4792 /* First, try whatever font the caller has specified. */
4793 if (STRINGP (font))
4795 tem = Fquery_fontset (font, Qnil);
4796 if (STRINGP (tem))
4797 font = x_new_fontset (f, SDATA (tem));
4798 else
4799 font = x_new_font (f, SDATA (font));
4802 /* Try out a font which we hope has bold and italic variations. */
4803 if (!STRINGP (font))
4804 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
4805 if (!STRINGP (font))
4806 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4807 if (! STRINGP (font))
4808 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4809 if (! STRINGP (font))
4810 /* This was formerly the first thing tried, but it finds too many fonts
4811 and takes too long. */
4812 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
4813 /* If those didn't work, look for something which will at least work. */
4814 if (! STRINGP (font))
4815 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
4816 UNBLOCK_INPUT;
4817 if (! STRINGP (font))
4818 font = build_string ("fixed");
4820 x_default_parameter (f, parms, Qfont, font,
4821 "font", "Font", RES_TYPE_STRING);
4824 x_default_parameter (f, parms, Qborder_width, make_number (2),
4825 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4827 /* This defaults to 2 in order to match xterm. We recognize either
4828 internalBorderWidth or internalBorder (which is what xterm calls
4829 it). */
4830 if (NILP (Fassq (Qinternal_border_width, parms)))
4832 Lisp_Object value;
4834 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4835 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4836 if (! EQ (value, Qunbound))
4837 parms = Fcons (Fcons (Qinternal_border_width, value),
4838 parms);
4841 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4842 "internalBorderWidth", "internalBorderWidth",
4843 RES_TYPE_NUMBER);
4845 /* Also do the stuff which must be set before the window exists. */
4846 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4847 "foreground", "Foreground", RES_TYPE_STRING);
4848 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4849 "background", "Background", RES_TYPE_STRING);
4850 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4851 "pointerColor", "Foreground", RES_TYPE_STRING);
4852 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4853 "cursorColor", "Foreground", RES_TYPE_STRING);
4854 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4855 "borderColor", "BorderColor", RES_TYPE_STRING);
4857 /* Init faces before x_default_parameter is called for scroll-bar
4858 parameters because that function calls x_set_scroll_bar_width,
4859 which calls change_frame_size, which calls Fset_window_buffer,
4860 which runs hooks, which call Fvertical_motion. At the end, we
4861 end up in init_iterator with a null face cache, which should not
4862 happen. */
4863 init_frame_faces (f);
4865 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4867 window_prompting = x_figure_window_size (f, parms, 0);
4870 XSetWindowAttributes attrs;
4871 unsigned long mask;
4873 BLOCK_INPUT;
4874 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
4875 if (DoesSaveUnders (dpyinfo->screen))
4876 mask |= CWSaveUnder;
4878 /* Window managers look at the override-redirect flag to determine
4879 whether or net to give windows a decoration (Xlib spec, chapter
4880 3.2.8). */
4881 attrs.override_redirect = True;
4882 attrs.save_under = True;
4883 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4884 /* Arrange for getting MapNotify and UnmapNotify events. */
4885 attrs.event_mask = StructureNotifyMask;
4886 tip_window
4887 = FRAME_X_WINDOW (f)
4888 = XCreateWindow (FRAME_X_DISPLAY (f),
4889 FRAME_X_DISPLAY_INFO (f)->root_window,
4890 /* x, y, width, height */
4891 0, 0, 1, 1,
4892 /* Border. */
4894 CopyFromParent, InputOutput, CopyFromParent,
4895 mask, &attrs);
4896 UNBLOCK_INPUT;
4899 x_make_gc (f);
4901 x_default_parameter (f, parms, Qauto_raise, Qnil,
4902 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4903 x_default_parameter (f, parms, Qauto_lower, Qnil,
4904 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4905 x_default_parameter (f, parms, Qcursor_type, Qbox,
4906 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4908 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4909 Change will not be effected unless different from the current
4910 FRAME_LINES (f). */
4911 width = FRAME_COLS (f);
4912 height = FRAME_LINES (f);
4913 SET_FRAME_COLS (f, 0);
4914 FRAME_LINES (f) = 0;
4915 change_frame_size (f, height, width, 1, 0, 0);
4917 /* Add `tooltip' frame parameter's default value. */
4918 if (NILP (Fframe_parameter (frame, intern ("tooltip"))))
4919 Fmodify_frame_parameters (frame, Fcons (Fcons (intern ("tooltip"), Qt),
4920 Qnil));
4922 /* Set up faces after all frame parameters are known. This call
4923 also merges in face attributes specified for new frames.
4925 Frame parameters may be changed if .Xdefaults contains
4926 specifications for the default font. For example, if there is an
4927 `Emacs.default.attributeBackground: pink', the `background-color'
4928 attribute of the frame get's set, which let's the internal border
4929 of the tooltip frame appear in pink. Prevent this. */
4931 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
4933 /* Set tip_frame here, so that */
4934 tip_frame = frame;
4935 call1 (Qface_set_after_frame_default, frame);
4937 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
4938 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
4939 Qnil));
4942 f->no_split = 1;
4944 UNGCPRO;
4946 /* It is now ok to make the frame official even if we get an error
4947 below. And the frame needs to be on Vframe_list or making it
4948 visible won't work. */
4949 Vframe_list = Fcons (frame, Vframe_list);
4951 /* Now that the frame is official, it counts as a reference to
4952 its display. */
4953 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4955 /* Setting attributes of faces of the tooltip frame from resources
4956 and similar will increment face_change_count, which leads to the
4957 clearing of all current matrices. Since this isn't necessary
4958 here, avoid it by resetting face_change_count to the value it
4959 had before we created the tip frame. */
4960 face_change_count = face_change_count_before;
4962 /* Discard the unwind_protect. */
4963 return unbind_to (count, frame);
4967 /* Compute where to display tip frame F. PARMS is the list of frame
4968 parameters for F. DX and DY are specified offsets from the current
4969 location of the mouse. WIDTH and HEIGHT are the width and height
4970 of the tooltip. Return coordinates relative to the root window of
4971 the display in *ROOT_X, and *ROOT_Y. */
4973 static void
4974 compute_tip_xy (f, parms, dx, dy, width, height, root_x, root_y)
4975 struct frame *f;
4976 Lisp_Object parms, dx, dy;
4977 int width, height;
4978 int *root_x, *root_y;
4980 Lisp_Object left, top;
4981 int win_x, win_y;
4982 Window root, child;
4983 unsigned pmask;
4985 /* User-specified position? */
4986 left = Fcdr (Fassq (Qleft, parms));
4987 top = Fcdr (Fassq (Qtop, parms));
4989 /* Move the tooltip window where the mouse pointer is. Resize and
4990 show it. */
4991 if (!INTEGERP (left) || !INTEGERP (top))
4993 BLOCK_INPUT;
4994 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
4995 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
4996 UNBLOCK_INPUT;
4999 if (INTEGERP (top))
5000 *root_y = XINT (top);
5001 else if (*root_y + XINT (dy) <= 0)
5002 *root_y = 0; /* Can happen for negative dy */
5003 else if (*root_y + XINT (dy) + height <= FRAME_X_DISPLAY_INFO (f)->height)
5004 /* It fits below the pointer */
5005 *root_y += XINT (dy);
5006 else if (height + XINT (dy) <= *root_y)
5007 /* It fits above the pointer. */
5008 *root_y -= height + XINT (dy);
5009 else
5010 /* Put it on the top. */
5011 *root_y = 0;
5013 if (INTEGERP (left))
5014 *root_x = XINT (left);
5015 else if (*root_x + XINT (dx) <= 0)
5016 *root_x = 0; /* Can happen for negative dx */
5017 else if (*root_x + XINT (dx) + width <= FRAME_X_DISPLAY_INFO (f)->width)
5018 /* It fits to the right of the pointer. */
5019 *root_x += XINT (dx);
5020 else if (width + XINT (dx) <= *root_x)
5021 /* It fits to the left of the pointer. */
5022 *root_x -= width + XINT (dx);
5023 else
5024 /* Put it left-justified on the screen--it ought to fit that way. */
5025 *root_x = 0;
5029 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5030 doc: /* Show STRING in a "tooltip" window on frame FRAME.
5031 A tooltip window is a small X window displaying a string.
5033 FRAME nil or omitted means use the selected frame.
5035 PARMS is an optional list of frame parameters which can be used to
5036 change the tooltip's appearance.
5038 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5039 means use the default timeout of 5 seconds.
5041 If the list of frame parameters PARAMS contains a `left' parameters,
5042 the tooltip is displayed at that x-position. Otherwise it is
5043 displayed at the mouse position, with offset DX added (default is 5 if
5044 DX isn't specified). Likewise for the y-position; if a `top' frame
5045 parameter is specified, it determines the y-position of the tooltip
5046 window, otherwise it is displayed at the mouse position, with offset
5047 DY added (default is -10).
5049 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5050 Text larger than the specified size is clipped. */)
5051 (string, frame, parms, timeout, dx, dy)
5052 Lisp_Object string, frame, parms, timeout, dx, dy;
5054 struct frame *f;
5055 struct window *w;
5056 int root_x, root_y;
5057 struct buffer *old_buffer;
5058 struct text_pos pos;
5059 int i, width, height;
5060 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5061 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5062 int count = SPECPDL_INDEX ();
5064 specbind (Qinhibit_redisplay, Qt);
5066 GCPRO4 (string, parms, frame, timeout);
5068 CHECK_STRING (string);
5069 f = check_x_frame (frame);
5070 if (NILP (timeout))
5071 timeout = make_number (5);
5072 else
5073 CHECK_NATNUM (timeout);
5075 if (NILP (dx))
5076 dx = make_number (5);
5077 else
5078 CHECK_NUMBER (dx);
5080 if (NILP (dy))
5081 dy = make_number (-10);
5082 else
5083 CHECK_NUMBER (dy);
5085 if (NILP (last_show_tip_args))
5086 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5088 if (!NILP (tip_frame))
5090 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5091 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5092 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5094 if (EQ (frame, last_frame)
5095 && !NILP (Fequal (last_string, string))
5096 && !NILP (Fequal (last_parms, parms)))
5098 struct frame *f = XFRAME (tip_frame);
5100 /* Only DX and DY have changed. */
5101 if (!NILP (tip_timer))
5103 Lisp_Object timer = tip_timer;
5104 tip_timer = Qnil;
5105 call1 (Qcancel_timer, timer);
5108 BLOCK_INPUT;
5109 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
5110 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
5111 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5112 root_x, root_y);
5113 UNBLOCK_INPUT;
5114 goto start_timer;
5118 /* Hide a previous tip, if any. */
5119 Fx_hide_tip ();
5121 ASET (last_show_tip_args, 0, string);
5122 ASET (last_show_tip_args, 1, frame);
5123 ASET (last_show_tip_args, 2, parms);
5125 /* Add default values to frame parameters. */
5126 if (NILP (Fassq (Qname, parms)))
5127 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5128 if (NILP (Fassq (Qinternal_border_width, parms)))
5129 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5130 if (NILP (Fassq (Qborder_width, parms)))
5131 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5132 if (NILP (Fassq (Qborder_color, parms)))
5133 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5134 if (NILP (Fassq (Qbackground_color, parms)))
5135 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5136 parms);
5138 /* Create a frame for the tooltip, and record it in the global
5139 variable tip_frame. */
5140 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
5141 f = XFRAME (frame);
5143 /* Set up the frame's root window. */
5144 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5145 w->left_col = w->top_line = make_number (0);
5147 if (CONSP (Vx_max_tooltip_size)
5148 && INTEGERP (XCAR (Vx_max_tooltip_size))
5149 && XINT (XCAR (Vx_max_tooltip_size)) > 0
5150 && INTEGERP (XCDR (Vx_max_tooltip_size))
5151 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
5153 w->total_cols = XCAR (Vx_max_tooltip_size);
5154 w->total_lines = XCDR (Vx_max_tooltip_size);
5156 else
5158 w->total_cols = make_number (80);
5159 w->total_lines = make_number (40);
5162 FRAME_TOTAL_COLS (f) = XINT (w->total_cols);
5163 adjust_glyphs (f);
5164 w->pseudo_window_p = 1;
5166 /* Display the tooltip text in a temporary buffer. */
5167 old_buffer = current_buffer;
5168 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
5169 current_buffer->truncate_lines = Qnil;
5170 clear_glyph_matrix (w->desired_matrix);
5171 clear_glyph_matrix (w->current_matrix);
5172 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5173 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5175 /* Compute width and height of the tooltip. */
5176 width = height = 0;
5177 for (i = 0; i < w->desired_matrix->nrows; ++i)
5179 struct glyph_row *row = &w->desired_matrix->rows[i];
5180 struct glyph *last;
5181 int row_width;
5183 /* Stop at the first empty row at the end. */
5184 if (!row->enabled_p || !row->displays_text_p)
5185 break;
5187 /* Let the row go over the full width of the frame. */
5188 row->full_width_p = 1;
5190 /* There's a glyph at the end of rows that is used to place
5191 the cursor there. Don't include the width of this glyph. */
5192 if (row->used[TEXT_AREA])
5194 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5195 row_width = row->pixel_width - last->pixel_width;
5197 else
5198 row_width = row->pixel_width;
5200 height += row->height;
5201 width = max (width, row_width);
5204 /* Add the frame's internal border to the width and height the X
5205 window should have. */
5206 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5207 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5209 /* Move the tooltip window where the mouse pointer is. Resize and
5210 show it. */
5211 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5213 BLOCK_INPUT;
5214 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5215 root_x, root_y, width, height);
5216 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
5217 UNBLOCK_INPUT;
5219 /* Draw into the window. */
5220 w->must_be_updated_p = 1;
5221 update_single_window (w, 1);
5223 /* Restore original current buffer. */
5224 set_buffer_internal_1 (old_buffer);
5225 windows_or_buffers_changed = old_windows_or_buffers_changed;
5227 start_timer:
5228 /* Let the tip disappear after timeout seconds. */
5229 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5230 intern ("x-hide-tip"));
5232 UNGCPRO;
5233 return unbind_to (count, Qnil);
5237 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5238 doc: /* Hide the current tooltip window, if there is any.
5239 Value is t if tooltip was open, nil otherwise. */)
5242 int count;
5243 Lisp_Object deleted, frame, timer;
5244 struct gcpro gcpro1, gcpro2;
5246 /* Return quickly if nothing to do. */
5247 if (NILP (tip_timer) && NILP (tip_frame))
5248 return Qnil;
5250 frame = tip_frame;
5251 timer = tip_timer;
5252 GCPRO2 (frame, timer);
5253 tip_frame = tip_timer = deleted = Qnil;
5255 count = SPECPDL_INDEX ();
5256 specbind (Qinhibit_redisplay, Qt);
5257 specbind (Qinhibit_quit, Qt);
5259 if (!NILP (timer))
5260 call1 (Qcancel_timer, timer);
5262 if (FRAMEP (frame))
5264 Fdelete_frame (frame, Qnil);
5265 deleted = Qt;
5267 #ifdef USE_LUCID
5268 /* Bloodcurdling hack alert: The Lucid menu bar widget's
5269 redisplay procedure is not called when a tip frame over menu
5270 items is unmapped. Redisplay the menu manually... */
5272 struct frame *f = SELECTED_FRAME ();
5273 Widget w = f->output_data.x->menubar_widget;
5274 extern void xlwmenu_redisplay P_ ((Widget));
5276 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
5277 && w != NULL)
5279 BLOCK_INPUT;
5280 xlwmenu_redisplay (w);
5281 UNBLOCK_INPUT;
5284 #endif /* USE_LUCID */
5287 UNGCPRO;
5288 return unbind_to (count, deleted);
5293 /***********************************************************************
5294 File selection dialog
5295 ***********************************************************************/
5297 DEFUN ("x-uses-old-gtk-dialog", Fx_uses_old_gtk_dialog,
5298 Sx_uses_old_gtk_dialog,
5299 0, 0, 0,
5300 doc: /* Return t if the old Gtk+ file selection dialog is used. */)
5303 #ifdef USE_GTK
5304 extern int use_dialog_box;
5305 extern int use_file_dialog;
5307 if (use_dialog_box
5308 && use_file_dialog
5309 && have_menus_p ()
5310 && xg_uses_old_file_dialog ())
5311 return Qt;
5312 #endif
5313 return Qnil;
5317 #ifdef USE_MOTIF
5318 /* Callback for "OK" and "Cancel" on file selection dialog. */
5320 static void
5321 file_dialog_cb (widget, client_data, call_data)
5322 Widget widget;
5323 XtPointer call_data, client_data;
5325 int *result = (int *) client_data;
5326 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
5327 *result = cb->reason;
5331 /* Callback for unmapping a file selection dialog. This is used to
5332 capture the case where a dialog is closed via a window manager's
5333 closer button, for example. Using a XmNdestroyCallback didn't work
5334 in this case. */
5336 static void
5337 file_dialog_unmap_cb (widget, client_data, call_data)
5338 Widget widget;
5339 XtPointer call_data, client_data;
5341 int *result = (int *) client_data;
5342 *result = XmCR_CANCEL;
5345 static Lisp_Object
5346 clean_up_file_dialog (arg)
5347 Lisp_Object arg;
5349 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
5350 Widget dialog = (Widget) p->pointer;
5352 /* Clean up. */
5353 BLOCK_INPUT;
5354 XtUnmanageChild (dialog);
5355 XtDestroyWidget (dialog);
5356 x_menu_set_in_use (0);
5357 UNBLOCK_INPUT;
5359 return Qnil;
5363 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5364 doc: /* Read file name, prompting with PROMPT in directory DIR.
5365 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5366 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5367 or directory must exist. ONLY-DIR-P is ignored." */)
5368 (prompt, dir, default_filename, mustmatch, only_dir_p)
5369 Lisp_Object prompt, dir, default_filename, mustmatch, only_dir_p;
5371 int result;
5372 struct frame *f = SELECTED_FRAME ();
5373 Lisp_Object file = Qnil;
5374 Lisp_Object decoded_file;
5375 Widget dialog, text, help;
5376 Arg al[10];
5377 int ac = 0;
5378 extern XtAppContext Xt_app_con;
5379 XmString dir_xmstring, pattern_xmstring;
5380 int count = SPECPDL_INDEX ();
5381 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5383 check_x ();
5385 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5387 if (popup_activated ())
5388 error ("Trying to use a menu from within a menu-entry");
5390 CHECK_STRING (prompt);
5391 CHECK_STRING (dir);
5393 /* Prevent redisplay. */
5394 specbind (Qinhibit_redisplay, Qt);
5396 BLOCK_INPUT;
5398 /* Create the dialog with PROMPT as title, using DIR as initial
5399 directory and using "*" as pattern. */
5400 dir = Fexpand_file_name (dir, Qnil);
5401 dir_xmstring = XmStringCreateLocalized (SDATA (dir));
5402 pattern_xmstring = XmStringCreateLocalized ("*");
5404 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
5405 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
5406 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
5407 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
5408 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
5409 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
5410 "fsb", al, ac);
5411 XmStringFree (dir_xmstring);
5412 XmStringFree (pattern_xmstring);
5414 /* Add callbacks for OK and Cancel. */
5415 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
5416 (XtPointer) &result);
5417 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
5418 (XtPointer) &result);
5419 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
5420 (XtPointer) &result);
5422 /* Remove the help button since we can't display help. */
5423 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
5424 XtUnmanageChild (help);
5426 /* Mark OK button as default. */
5427 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
5428 XmNshowAsDefault, True, NULL);
5430 /* If MUSTMATCH is non-nil, disable the file entry field of the
5431 dialog, so that the user must select a file from the files list
5432 box. We can't remove it because we wouldn't have a way to get at
5433 the result file name, then. */
5434 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5435 if (!NILP (mustmatch))
5437 Widget label;
5438 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
5439 XtSetSensitive (text, False);
5440 XtSetSensitive (label, False);
5443 /* Manage the dialog, so that list boxes get filled. */
5444 XtManageChild (dialog);
5446 if (STRINGP (default_filename))
5448 XmString default_xmstring;
5449 Widget wtext = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
5450 Widget list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
5452 XmTextPosition last_pos = XmTextFieldGetLastPosition (wtext);
5453 XmTextFieldReplace (wtext, 0, last_pos,
5454 (SDATA (Ffile_name_nondirectory (default_filename))));
5456 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
5457 must include the path for this to work. */
5459 default_xmstring = XmStringCreateLocalized (SDATA (default_filename));
5461 if (XmListItemExists (list, default_xmstring))
5463 int item_pos = XmListItemPos (list, default_xmstring);
5464 /* Select the item and scroll it into view. */
5465 XmListSelectPos (list, item_pos, True);
5466 XmListSetPos (list, item_pos);
5469 XmStringFree (default_xmstring);
5472 record_unwind_protect (clean_up_file_dialog, make_save_value (dialog, 0));
5474 /* Process events until the user presses Cancel or OK. */
5475 x_menu_set_in_use (1);
5476 result = 0;
5477 while (result == 0)
5479 XEvent event;
5480 x_menu_wait_for_event (0);
5481 XtAppNextEvent (Xt_app_con, &event);
5482 if (event.type == KeyPress
5483 && FRAME_X_DISPLAY (f) == event.xkey.display)
5485 KeySym keysym = XLookupKeysym (&event.xkey, 0);
5487 /* Pop down on C-g. */
5488 if (keysym == XK_g && (event.xkey.state & ControlMask) != 0)
5489 XtUnmanageChild (dialog);
5492 (void) x_dispatch_event (&event, FRAME_X_DISPLAY (f));
5495 /* Get the result. */
5496 if (result == XmCR_OK)
5498 XmString text;
5499 String data;
5501 XtVaGetValues (dialog, XmNtextString, &text, NULL);
5502 XmStringGetLtoR (text, XmFONTLIST_DEFAULT_TAG, &data);
5503 XmStringFree (text);
5504 file = build_string (data);
5505 XtFree (data);
5507 else
5508 file = Qnil;
5510 UNBLOCK_INPUT;
5511 UNGCPRO;
5513 /* Make "Cancel" equivalent to C-g. */
5514 if (NILP (file))
5515 Fsignal (Qquit, Qnil);
5517 decoded_file = DECODE_FILE (file);
5519 return unbind_to (count, decoded_file);
5522 #endif /* USE_MOTIF */
5524 #ifdef USE_GTK
5526 static Lisp_Object
5527 clean_up_dialog (arg)
5528 Lisp_Object arg;
5530 x_menu_set_in_use (0);
5532 return Qnil;
5535 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
5536 doc: /* Read file name, prompting with PROMPT in directory DIR.
5537 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
5538 selection box, if specified. If MUSTMATCH is non-nil, the returned file
5539 or directory must exist. If ONLY-DIR-P is non-nil, the user can only select
5540 directories. */)
5541 (prompt, dir, default_filename, mustmatch, only_dir_p)
5542 Lisp_Object prompt, dir, default_filename, mustmatch, only_dir_p;
5544 FRAME_PTR f = SELECTED_FRAME ();
5545 char *fn;
5546 Lisp_Object file = Qnil;
5547 Lisp_Object decoded_file;
5548 int count = SPECPDL_INDEX ();
5549 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
5550 char *cdef_file;
5552 check_x ();
5554 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
5556 if (popup_activated ())
5557 error ("Trying to use a menu from within a menu-entry");
5559 CHECK_STRING (prompt);
5560 CHECK_STRING (dir);
5562 /* Prevent redisplay. */
5563 specbind (Qinhibit_redisplay, Qt);
5564 record_unwind_protect (clean_up_dialog, Qnil);
5566 BLOCK_INPUT;
5568 if (STRINGP (default_filename))
5569 cdef_file = SDATA (default_filename);
5570 else
5571 cdef_file = SDATA (dir);
5573 fn = xg_get_file_name (f, SDATA (prompt), cdef_file,
5574 ! NILP (mustmatch),
5575 ! NILP (only_dir_p));
5577 if (fn)
5579 file = build_string (fn);
5580 xfree (fn);
5583 UNBLOCK_INPUT;
5584 UNGCPRO;
5586 /* Make "Cancel" equivalent to C-g. */
5587 if (NILP (file))
5588 Fsignal (Qquit, Qnil);
5590 decoded_file = DECODE_FILE (file);
5592 return unbind_to (count, decoded_file);
5595 #endif /* USE_GTK */
5598 /***********************************************************************
5599 Keyboard
5600 ***********************************************************************/
5602 #ifdef HAVE_XKBGETKEYBOARD
5603 #include <X11/XKBlib.h>
5604 #include <X11/keysym.h>
5605 #endif
5607 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
5608 Sx_backspace_delete_keys_p, 0, 1, 0,
5609 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
5610 FRAME nil means use the selected frame.
5611 Value is t if we know that both keys are present, and are mapped to the
5612 usual X keysyms. Value is `lambda' if we cannot determine if both keys are
5613 present and mapped to the usual X keysyms. */)
5614 (frame)
5615 Lisp_Object frame;
5617 #ifdef HAVE_XKBGETKEYBOARD
5618 XkbDescPtr kb;
5619 struct frame *f = check_x_frame (frame);
5620 Display *dpy = FRAME_X_DISPLAY (f);
5621 Lisp_Object have_keys;
5622 int major, minor, op, event, error;
5624 BLOCK_INPUT;
5626 /* Check library version in case we're dynamically linked. */
5627 major = XkbMajorVersion;
5628 minor = XkbMinorVersion;
5629 if (!XkbLibraryVersion (&major, &minor))
5631 UNBLOCK_INPUT;
5632 return Qlambda;
5635 /* Check that the server supports XKB. */
5636 major = XkbMajorVersion;
5637 minor = XkbMinorVersion;
5638 if (!XkbQueryExtension (dpy, &op, &event, &error, &major, &minor))
5640 UNBLOCK_INPUT;
5641 return Qlambda;
5644 /* In this code we check that the keyboard has physical keys with names
5645 that start with BKSP (Backspace) and DELE (Delete), and that they
5646 generate keysym XK_BackSpace and XK_Delete respectively.
5647 This function is used to test if normal-erase-is-backspace should be
5648 turned on.
5649 An alternative approach would be to just check if XK_BackSpace and
5650 XK_Delete are mapped to any key. But if any of those are mapped to
5651 some non-intuitive key combination (Meta-Shift-Ctrl-whatever) and the
5652 user doesn't know about it, it is better to return false here.
5653 It is more obvious to the user what to do if she/he has two keys
5654 clearly marked with names/symbols and one key does something not
5655 expected (i.e. she/he then tries the other).
5656 The cases where Backspace/Delete is mapped to some other key combination
5657 are rare, and in those cases, normal-erase-is-backspace can be turned on
5658 manually. */
5660 have_keys = Qnil;
5661 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
5662 if (kb)
5664 int delete_keycode = 0, backspace_keycode = 0, i;
5666 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
5668 for (i = kb->min_key_code;
5669 (i < kb->max_key_code
5670 && (delete_keycode == 0 || backspace_keycode == 0));
5671 ++i)
5673 /* The XKB symbolic key names can be seen most easily in
5674 the PS file generated by `xkbprint -label name
5675 $DISPLAY'. */
5676 if (bcmp ("DELE", kb->names->keys[i].name, 4) == 0)
5677 delete_keycode = i;
5678 else if (bcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
5679 backspace_keycode = i;
5682 XkbFreeNames (kb, 0, True);
5685 XkbFreeClientMap (kb, 0, True);
5687 if (delete_keycode
5688 && backspace_keycode
5689 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
5690 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
5691 have_keys = Qt;
5693 UNBLOCK_INPUT;
5694 return have_keys;
5695 #else /* not HAVE_XKBGETKEYBOARD */
5696 return Qlambda;
5697 #endif /* not HAVE_XKBGETKEYBOARD */
5702 /***********************************************************************
5703 Initialization
5704 ***********************************************************************/
5706 /* Keep this list in the same order as frame_parms in frame.c.
5707 Use 0 for unsupported frame parameters. */
5709 frame_parm_handler x_frame_parm_handlers[] =
5711 x_set_autoraise,
5712 x_set_autolower,
5713 x_set_background_color,
5714 x_set_border_color,
5715 x_set_border_width,
5716 x_set_cursor_color,
5717 x_set_cursor_type,
5718 x_set_font,
5719 x_set_foreground_color,
5720 x_set_icon_name,
5721 x_set_icon_type,
5722 x_set_internal_border_width,
5723 x_set_menu_bar_lines,
5724 x_set_mouse_color,
5725 x_explicitly_set_name,
5726 x_set_scroll_bar_width,
5727 x_set_title,
5728 x_set_unsplittable,
5729 x_set_vertical_scroll_bars,
5730 x_set_visibility,
5731 x_set_tool_bar_lines,
5732 x_set_scroll_bar_foreground,
5733 x_set_scroll_bar_background,
5734 x_set_screen_gamma,
5735 x_set_line_spacing,
5736 x_set_fringe_width,
5737 x_set_fringe_width,
5738 x_set_wait_for_wm,
5739 x_set_fullscreen,
5742 void
5743 syms_of_xfns ()
5745 /* This is zero if not using X windows. */
5746 x_in_use = 0;
5748 /* The section below is built by the lisp expression at the top of the file,
5749 just above where these variables are declared. */
5750 /*&&& init symbols here &&&*/
5751 Qnone = intern ("none");
5752 staticpro (&Qnone);
5753 Qsuppress_icon = intern ("suppress-icon");
5754 staticpro (&Qsuppress_icon);
5755 Qundefined_color = intern ("undefined-color");
5756 staticpro (&Qundefined_color);
5757 Qcompound_text = intern ("compound-text");
5758 staticpro (&Qcompound_text);
5759 Qcancel_timer = intern ("cancel-timer");
5760 staticpro (&Qcancel_timer);
5761 /* This is the end of symbol initialization. */
5763 /* Text property `display' should be nonsticky by default. */
5764 Vtext_property_default_nonsticky
5765 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
5768 Fput (Qundefined_color, Qerror_conditions,
5769 Fcons (Qundefined_color, Fcons (Qerror, Qnil)));
5770 Fput (Qundefined_color, Qerror_message,
5771 build_string ("Undefined color"));
5773 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
5774 doc: /* The shape of the pointer when over text.
5775 Changing the value does not affect existing frames
5776 unless you set the mouse color. */);
5777 Vx_pointer_shape = Qnil;
5779 #if 0 /* This doesn't really do anything. */
5780 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape,
5781 doc: /* The shape of the pointer when not over text.
5782 This variable takes effect when you create a new frame
5783 or when you set the mouse color. */);
5784 #endif
5785 Vx_nontext_pointer_shape = Qnil;
5787 DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape,
5788 doc: /* The shape of the pointer when Emacs is busy.
5789 This variable takes effect when you create a new frame
5790 or when you set the mouse color. */);
5791 Vx_hourglass_pointer_shape = Qnil;
5793 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p,
5794 doc: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
5795 display_hourglass_p = 1;
5797 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay,
5798 doc: /* *Seconds to wait before displaying an hourglass pointer.
5799 Value must be an integer or float. */);
5800 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
5802 #if 0 /* This doesn't really do anything. */
5803 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape,
5804 doc: /* The shape of the pointer when over the mode line.
5805 This variable takes effect when you create a new frame
5806 or when you set the mouse color. */);
5807 #endif
5808 Vx_mode_pointer_shape = Qnil;
5810 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
5811 &Vx_sensitive_text_pointer_shape,
5812 doc: /* The shape of the pointer when over mouse-sensitive text.
5813 This variable takes effect when you create a new frame
5814 or when you set the mouse color. */);
5815 Vx_sensitive_text_pointer_shape = Qnil;
5817 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
5818 &Vx_window_horizontal_drag_shape,
5819 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
5820 This variable takes effect when you create a new frame
5821 or when you set the mouse color. */);
5822 Vx_window_horizontal_drag_shape = Qnil;
5824 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
5825 doc: /* A string indicating the foreground color of the cursor box. */);
5826 Vx_cursor_fore_pixel = Qnil;
5828 DEFVAR_LISP ("x-max-tooltip-size", &Vx_max_tooltip_size,
5829 doc: /* Maximum size for tooltips. Value is a pair (COLUMNS . ROWS).
5830 Text larger than this is clipped. */);
5831 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
5833 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
5834 doc: /* Non-nil if no X window manager is in use.
5835 Emacs doesn't try to figure this out; this is always nil
5836 unless you set it to something else. */);
5837 /* We don't have any way to find this out, so set it to nil
5838 and maybe the user would like to set it to t. */
5839 Vx_no_window_manager = Qnil;
5841 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
5842 &Vx_pixel_size_width_font_regexp,
5843 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
5845 Since Emacs gets width of a font matching with this regexp from
5846 PIXEL_SIZE field of the name, font finding mechanism gets faster for
5847 such a font. This is especially effective for such large fonts as
5848 Chinese, Japanese, and Korean. */);
5849 Vx_pixel_size_width_font_regexp = Qnil;
5851 /* This is not ifdef:ed, so other builds than GTK can customize it. */
5852 DEFVAR_BOOL ("x-gtk-use-old-file-dialog", &x_gtk_use_old_file_dialog,
5853 doc: /* *Non-nil means prompt with the old GTK file selection dialog.
5854 If nil or if the file selection dialog is not available, the new GTK file
5855 chooser is used instead. To turn off all file dialogs set the
5856 variable `use-file-dialog'. */);
5857 x_gtk_use_old_file_dialog = 0;
5859 DEFVAR_BOOL ("x-gtk-show-hidden-files", &x_gtk_show_hidden_files,
5860 doc: /* *If non-nil, the GTK file chooser will by default show hidden files.
5861 Note that this is just the default, there is a toggle button on the file
5862 chooser to show or not show hidden files on a case by case basis. */);
5863 x_gtk_show_hidden_files = 0;
5865 DEFVAR_BOOL ("x-gtk-file-dialog-help-text", &x_gtk_file_dialog_help_text,
5866 doc: /* *If non-nil, the GTK file chooser will show additional help text.
5867 If more space for files in the file chooser dialog is wanted, set this to nil
5868 to turn the additional text off. */);
5869 x_gtk_file_dialog_help_text = 1;
5871 DEFVAR_BOOL ("x-gtk-whole-detached-tool-bar", &x_gtk_whole_detached_tool_bar,
5872 doc: /* *If non-nil, a detached tool bar is shown in full.
5873 The default is to just show an arrow and pressing on that arrow shows
5874 the tool bar buttons. */);
5875 x_gtk_whole_detached_tool_bar = 0;
5877 Fprovide (intern ("x"), Qnil);
5879 #ifdef USE_X_TOOLKIT
5880 Fprovide (intern ("x-toolkit"), Qnil);
5881 #ifdef USE_MOTIF
5882 Fprovide (intern ("motif"), Qnil);
5884 DEFVAR_LISP ("motif-version-string", &Vmotif_version_string,
5885 doc: /* Version info for LessTif/Motif. */);
5886 Vmotif_version_string = build_string (XmVERSION_STRING);
5887 #endif /* USE_MOTIF */
5888 #endif /* USE_X_TOOLKIT */
5890 #ifdef USE_GTK
5891 /* Provide x-toolkit also for GTK. Internally GTK does not use Xt so it
5892 is not an X toolkit in that sense (USE_X_TOOLKIT is not defined).
5893 But for a user it is a toolkit for X, and indeed, configure
5894 accepts --with-x-toolkit=gtk. */
5895 Fprovide (intern ("x-toolkit"), Qnil);
5896 Fprovide (intern ("gtk"), Qnil);
5898 DEFVAR_LISP ("gtk-version-string", &Vgtk_version_string,
5899 doc: /* Version info for GTK+. */);
5901 char gtk_version[40];
5902 g_snprintf (gtk_version, sizeof (gtk_version), "%u.%u.%u",
5903 GTK_MAJOR_VERSION, GTK_MINOR_VERSION, GTK_MICRO_VERSION);
5904 Vgtk_version_string = build_string (gtk_version);
5906 #endif /* USE_GTK */
5908 /* X window properties. */
5909 defsubr (&Sx_change_window_property);
5910 defsubr (&Sx_delete_window_property);
5911 defsubr (&Sx_window_property);
5913 defsubr (&Sxw_display_color_p);
5914 defsubr (&Sx_display_grayscale_p);
5915 defsubr (&Sxw_color_defined_p);
5916 defsubr (&Sxw_color_values);
5917 defsubr (&Sx_server_max_request_size);
5918 defsubr (&Sx_server_vendor);
5919 defsubr (&Sx_server_version);
5920 defsubr (&Sx_display_pixel_width);
5921 defsubr (&Sx_display_pixel_height);
5922 defsubr (&Sx_display_mm_width);
5923 defsubr (&Sx_display_mm_height);
5924 defsubr (&Sx_display_screens);
5925 defsubr (&Sx_display_planes);
5926 defsubr (&Sx_display_color_cells);
5927 defsubr (&Sx_display_visual_class);
5928 defsubr (&Sx_display_backing_store);
5929 defsubr (&Sx_display_save_under);
5930 defsubr (&Sx_create_frame);
5931 defsubr (&Sx_open_connection);
5932 defsubr (&Sx_close_connection);
5933 defsubr (&Sx_display_list);
5934 defsubr (&Sx_synchronize);
5935 defsubr (&Sx_focus_frame);
5936 defsubr (&Sx_backspace_delete_keys_p);
5938 /* Setting callback functions for fontset handler. */
5939 get_font_info_func = x_get_font_info;
5941 #if 0 /* This function pointer doesn't seem to be used anywhere.
5942 And the pointer assigned has the wrong type, anyway. */
5943 list_fonts_func = x_list_fonts;
5944 #endif
5946 load_font_func = x_load_font;
5947 find_ccl_program_func = x_find_ccl_program;
5948 query_font_func = x_query_font;
5949 set_frame_fontset_func = x_set_font;
5950 check_window_system_func = check_x;
5952 hourglass_atimer = NULL;
5953 hourglass_shown_p = 0;
5955 defsubr (&Sx_show_tip);
5956 defsubr (&Sx_hide_tip);
5957 tip_timer = Qnil;
5958 staticpro (&tip_timer);
5959 tip_frame = Qnil;
5960 staticpro (&tip_frame);
5962 last_show_tip_args = Qnil;
5963 staticpro (&last_show_tip_args);
5965 defsubr (&Sx_uses_old_gtk_dialog);
5966 #if defined (USE_MOTIF) || defined (USE_GTK)
5967 defsubr (&Sx_file_dialog);
5968 #endif
5971 #endif /* HAVE_X_WINDOWS */
5973 /* arch-tag: 55040d02-5485-4d58-8b22-95a7a05f3288
5974 (do not change this comment) */