(vc-cvs-parse-root): Handle roots without colon between hostname and path.
[emacs.git] / src / xterm.c
blobeef22a51443dd09986a797b8037e82ce1ca0a8f6
1 /* X Communication module for terminals which understand the X protocol.
2 Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
22 /* Xt features made by Fred Pierresteguy. */
24 #include <config.h>
26 /* On 4.3 these lose if they come after xterm.h. */
27 /* Putting these at the beginning seems to be standard for other .c files. */
28 #include <signal.h>
30 #include <stdio.h>
32 #ifdef HAVE_X_WINDOWS
34 #include "lisp.h"
35 #include "blockinput.h"
37 /* Need syssignal.h for various externs and definitions that may be required
38 by some configurations for calls to signal later in this source file. */
39 #include "syssignal.h"
41 /* This may include sys/types.h, and that somehow loses
42 if this is not done before the other system files. */
43 #include "xterm.h"
44 #include <X11/cursorfont.h>
46 /* Load sys/types.h if not already loaded.
47 In some systems loading it twice is suicidal. */
48 #ifndef makedev
49 #include <sys/types.h>
50 #endif /* makedev */
52 #ifdef BSD_SYSTEM
53 #include <sys/ioctl.h>
54 #endif /* ! defined (BSD_SYSTEM) */
56 #include "systime.h"
58 #ifndef INCLUDED_FCNTL
59 #include <fcntl.h>
60 #endif
61 #include <ctype.h>
62 #include <errno.h>
63 #include <setjmp.h>
64 #include <sys/stat.h>
65 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
66 /* #include <sys/param.h> */
68 #include "charset.h"
69 #include "character.h"
70 #include "coding.h"
71 #include "frame.h"
72 #include "dispextern.h"
73 #include "fontset.h"
74 #include "termhooks.h"
75 #include "termopts.h"
76 #include "termchar.h"
77 #include "emacs-icon.h"
78 #include "disptab.h"
79 #include "buffer.h"
80 #include "window.h"
81 #include "keyboard.h"
82 #include "intervals.h"
83 #include "process.h"
84 #include "atimer.h"
85 #include "keymap.h"
86 #include "font.h"
87 #include "fontset.h"
89 #ifdef USE_X_TOOLKIT
90 #include <X11/Shell.h>
91 #endif
93 #ifdef HAVE_SYS_TIME_H
94 #include <sys/time.h>
95 #endif
96 #ifdef HAVE_UNISTD_H
97 #include <unistd.h>
98 #endif
100 #ifdef USE_GTK
101 #include "gtkutil.h"
102 #endif
104 #ifdef USE_LUCID
105 extern int xlwmenu_window_p P_ ((Widget w, Window window));
106 extern void xlwmenu_redisplay P_ ((Widget));
107 #endif
109 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
111 extern void free_frame_menubar P_ ((struct frame *));
112 extern struct frame *x_menubar_window_to_frame P_ ((struct x_display_info *,
113 int));
114 #endif
116 #ifdef USE_X_TOOLKIT
117 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
118 #define HACK_EDITRES
119 extern void _XEditResCheckMessages ();
120 #endif /* not NO_EDITRES */
122 /* Include toolkit specific headers for the scroll bar widget. */
124 #ifdef USE_TOOLKIT_SCROLL_BARS
125 #if defined USE_MOTIF
126 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
127 #include <Xm/ScrollBar.h>
128 #else /* !USE_MOTIF i.e. use Xaw */
130 #ifdef HAVE_XAW3D
131 #include <X11/Xaw3d/Simple.h>
132 #include <X11/Xaw3d/Scrollbar.h>
133 #include <X11/Xaw3d/ThreeD.h>
134 #else /* !HAVE_XAW3D */
135 #include <X11/Xaw/Simple.h>
136 #include <X11/Xaw/Scrollbar.h>
137 #endif /* !HAVE_XAW3D */
138 #ifndef XtNpickTop
139 #define XtNpickTop "pickTop"
140 #endif /* !XtNpickTop */
141 #endif /* !USE_MOTIF */
142 #endif /* USE_TOOLKIT_SCROLL_BARS */
144 #endif /* USE_X_TOOLKIT */
146 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
147 #define x_any_window_to_frame x_window_to_frame
148 #define x_top_window_to_frame x_window_to_frame
149 #endif
151 #ifdef USE_X_TOOLKIT
152 #include "widget.h"
153 #ifndef XtNinitialState
154 #define XtNinitialState "initialState"
155 #endif
156 #endif
158 /* Default to using XIM if available. */
159 #ifdef USE_XIM
160 int use_xim = 1;
161 #else
162 int use_xim = 0; /* configure --without-xim */
163 #endif
167 /* Non-nil means Emacs uses toolkit scroll bars. */
169 Lisp_Object Vx_toolkit_scroll_bars;
171 /* Non-zero means that a HELP_EVENT has been generated since Emacs
172 start. */
174 static int any_help_event_p;
176 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
177 static Lisp_Object last_window;
179 /* Non-zero means make use of UNDERLINE_POSITION font properties. */
181 int x_use_underline_position_properties;
183 /* Non-zero means to draw the underline at the same place as the descent line. */
185 int x_underline_at_descent_line;
187 /* This is a chain of structures for all the X displays currently in
188 use. */
190 struct x_display_info *x_display_list;
192 /* This is a list of cons cells, each of the form (NAME
193 . FONT-LIST-CACHE), one for each element of x_display_list and in
194 the same order. NAME is the name of the frame. FONT-LIST-CACHE
195 records previous values returned by x-list-fonts. */
197 Lisp_Object x_display_name_list;
199 /* Frame being updated by update_frame. This is declared in term.c.
200 This is set by update_begin and looked at by all the XT functions.
201 It is zero while not inside an update. In that case, the XT
202 functions assume that `selected_frame' is the frame to apply to. */
204 extern struct frame *updating_frame;
206 /* This is a frame waiting to be auto-raised, within XTread_socket. */
208 struct frame *pending_autoraise_frame;
210 #ifdef USE_X_TOOLKIT
211 /* The application context for Xt use. */
212 XtAppContext Xt_app_con;
213 static String Xt_default_resources[] = {0};
214 #endif /* USE_X_TOOLKIT */
216 /* Non-zero means user is interacting with a toolkit scroll bar. */
218 static int toolkit_scroll_bar_interaction;
220 /* Non-zero means to not move point as a result of clicking on a
221 frame to focus it (when focus-follows-mouse is nil). */
223 int x_mouse_click_focus_ignore_position;
225 /* Non-zero timeout value means ignore next mouse click if it arrives
226 before that timeout elapses (i.e. as part of the same sequence of
227 events resulting from clicking on a frame to select it). */
229 static unsigned long ignore_next_mouse_click_timeout;
231 /* Mouse movement.
233 Formerly, we used PointerMotionHintMask (in standard_event_mask)
234 so that we would have to call XQueryPointer after each MotionNotify
235 event to ask for another such event. However, this made mouse tracking
236 slow, and there was a bug that made it eventually stop.
238 Simply asking for MotionNotify all the time seems to work better.
240 In order to avoid asking for motion events and then throwing most
241 of them away or busy-polling the server for mouse positions, we ask
242 the server for pointer motion hints. This means that we get only
243 one event per group of mouse movements. "Groups" are delimited by
244 other kinds of events (focus changes and button clicks, for
245 example), or by XQueryPointer calls; when one of these happens, we
246 get another MotionNotify event the next time the mouse moves. This
247 is at least as efficient as getting motion events when mouse
248 tracking is on, and I suspect only negligibly worse when tracking
249 is off. */
251 /* Where the mouse was last time we reported a mouse event. */
253 static XRectangle last_mouse_glyph;
254 static FRAME_PTR last_mouse_glyph_frame;
255 static Lisp_Object last_mouse_press_frame;
257 /* The scroll bar in which the last X motion event occurred.
259 If the last X motion event occurred in a scroll bar, we set this so
260 XTmouse_position can know whether to report a scroll bar motion or
261 an ordinary motion.
263 If the last X motion event didn't occur in a scroll bar, we set
264 this to Qnil, to tell XTmouse_position to return an ordinary motion
265 event. */
267 static Lisp_Object last_mouse_scroll_bar;
269 /* This is a hack. We would really prefer that XTmouse_position would
270 return the time associated with the position it returns, but there
271 doesn't seem to be any way to wrest the time-stamp from the server
272 along with the position query. So, we just keep track of the time
273 of the last movement we received, and return that in hopes that
274 it's somewhat accurate. */
276 static Time last_mouse_movement_time;
278 /* Time for last user interaction as returned in X events. */
280 static Time last_user_time;
282 /* Incremented by XTread_socket whenever it really tries to read
283 events. */
285 #ifdef __STDC__
286 static int volatile input_signal_count;
287 #else
288 static int input_signal_count;
289 #endif
291 /* Used locally within XTread_socket. */
293 static int x_noop_count;
295 /* Initial values of argv and argc. */
297 extern char **initial_argv;
298 extern int initial_argc;
300 extern Lisp_Object Vcommand_line_args, Vsystem_name;
302 /* Tells if a window manager is present or not. */
304 extern Lisp_Object Vx_no_window_manager;
306 extern Lisp_Object Qeql;
308 extern int errno;
310 /* A mask of extra modifier bits to put into every keyboard char. */
312 extern EMACS_INT extra_keyboard_modifiers;
314 /* The keysyms to use for the various modifiers. */
316 Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
317 Lisp_Object Vx_keysym_table;
318 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
320 static Lisp_Object Qvendor_specific_keysyms;
321 static Lisp_Object Qlatin_1;
323 /* Used in x_flush. */
325 extern Lisp_Object Vinhibit_redisplay;
327 extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
328 extern int x_bitmap_mask P_ ((FRAME_PTR, int));
330 static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
331 static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
332 static const XColor *x_color_cells P_ ((Display *, int *));
333 static void x_update_window_end P_ ((struct window *, int, int));
335 static int x_io_error_quitter P_ ((Display *));
336 static struct terminal *x_create_terminal P_ ((struct x_display_info *));
337 void x_delete_terminal P_ ((struct terminal *));
338 static void x_update_end P_ ((struct frame *));
339 static void XTframe_up_to_date P_ ((struct frame *));
340 static void XTset_terminal_modes P_ ((struct terminal *));
341 static void XTreset_terminal_modes P_ ((struct terminal *));
342 static void x_clear_frame P_ ((struct frame *));
343 static void frame_highlight P_ ((struct frame *));
344 static void frame_unhighlight P_ ((struct frame *));
345 static void x_new_focus_frame P_ ((struct x_display_info *, struct frame *));
346 static void x_focus_changed P_ ((int, int, struct x_display_info *,
347 struct frame *, struct input_event *));
348 static void x_detect_focus_change P_ ((struct x_display_info *,
349 XEvent *, struct input_event *));
350 static void XTframe_rehighlight P_ ((struct frame *));
351 static void x_frame_rehighlight P_ ((struct x_display_info *));
352 static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
353 static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
354 enum text_cursor_kinds));
356 static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
357 static void x_flush P_ ((struct frame *f));
358 static void x_update_begin P_ ((struct frame *));
359 static void x_update_window_begin P_ ((struct window *));
360 static void x_after_update_window_line P_ ((struct glyph_row *));
361 static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
362 static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
363 enum scroll_bar_part *,
364 Lisp_Object *, Lisp_Object *,
365 unsigned long *));
366 static void x_check_fullscreen P_ ((struct frame *));
367 static void x_check_expected_move P_ ((struct frame *, int, int));
368 static void x_sync_with_move P_ ((struct frame *, int, int, int));
369 static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
370 int *, struct input_event *));
371 /* Don't declare this NO_RETURN because we want no
372 interference with debugging failing X calls. */
373 static SIGTYPE x_connection_closed P_ ((Display *, char *));
376 /* Flush display of frame F, or of all frames if F is null. */
378 static void
379 x_flush (f)
380 struct frame *f;
382 /* Don't call XFlush when it is not safe to redisplay; the X
383 connection may be broken. */
384 if (!NILP (Vinhibit_redisplay))
385 return;
387 BLOCK_INPUT;
388 if (f == NULL)
390 Lisp_Object rest, frame;
391 FOR_EACH_FRAME (rest, frame)
392 if (FRAME_X_P (XFRAME (frame)))
393 x_flush (XFRAME (frame));
395 else if (FRAME_X_P (f))
396 XFlush (FRAME_X_DISPLAY (f));
397 UNBLOCK_INPUT;
401 /* Remove calls to XFlush by defining XFlush to an empty replacement.
402 Calls to XFlush should be unnecessary because the X output buffer
403 is flushed automatically as needed by calls to XPending,
404 XNextEvent, or XWindowEvent according to the XFlush man page.
405 XTread_socket calls XPending. Removing XFlush improves
406 performance. */
408 #define XFlush(DISPLAY) (void) 0
411 /***********************************************************************
412 Debugging
413 ***********************************************************************/
415 #if 0
417 /* This is a function useful for recording debugging information about
418 the sequence of occurrences in this file. */
420 struct record
422 char *locus;
423 int type;
426 struct record event_record[100];
428 int event_record_index;
430 record_event (locus, type)
431 char *locus;
432 int type;
434 if (event_record_index == sizeof (event_record) / sizeof (struct record))
435 event_record_index = 0;
437 event_record[event_record_index].locus = locus;
438 event_record[event_record_index].type = type;
439 event_record_index++;
442 #endif /* 0 */
446 /* Return the struct x_display_info corresponding to DPY. */
448 struct x_display_info *
449 x_display_info_for_display (dpy)
450 Display *dpy;
452 struct x_display_info *dpyinfo;
454 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
455 if (dpyinfo->display == dpy)
456 return dpyinfo;
458 return 0;
461 #define OPAQUE 0xffffffff
462 #define OPACITY "_NET_WM_WINDOW_OPACITY"
464 void
465 x_set_frame_alpha (f)
466 struct frame *f;
468 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
469 Display *dpy = FRAME_X_DISPLAY (f);
470 Window win = FRAME_OUTER_WINDOW (f);
471 double alpha = 1.0;
472 double alpha_min = 1.0;
473 unsigned long opac;
475 if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
476 /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
477 we must treat the former instead of the latter. */
478 win = FRAME_X_OUTPUT(f)->parent_desc;
480 if (dpyinfo->x_highlight_frame == f)
481 alpha = f->alpha[0];
482 else
483 alpha = f->alpha[1];
485 if (FLOATP (Vframe_alpha_lower_limit))
486 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
487 else if (INTEGERP (Vframe_alpha_lower_limit))
488 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
490 if (alpha < 0.0 || 1.0 < alpha)
491 alpha = 1.0;
492 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
493 alpha = alpha_min;
495 opac = alpha * OPAQUE;
497 /* return unless necessary */
499 unsigned char *data;
500 Atom actual;
501 int rc, format;
502 unsigned long n, left;
504 x_catch_errors (dpy);
505 rc = XGetWindowProperty(dpy, win, XInternAtom(dpy, OPACITY, False),
506 0L, 1L, False, XA_CARDINAL,
507 &actual, &format, &n, &left,
508 &data);
510 if (rc == Success && actual != None)
511 if (*(unsigned long *)data == opac)
513 XFree ((void *) data);
514 x_uncatch_errors ();
515 return;
517 else
518 XFree ((void *) data);
519 x_uncatch_errors ();
522 x_catch_errors (dpy);
523 XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
524 XA_CARDINAL, 32, PropModeReplace,
525 (unsigned char *) &opac, 1L);
526 x_uncatch_errors ();
530 x_display_pixel_height (dpyinfo)
531 struct x_display_info *dpyinfo;
533 return HeightOfScreen (dpyinfo->screen);
537 x_display_pixel_width (dpyinfo)
538 struct x_display_info *dpyinfo;
540 return WidthOfScreen (dpyinfo->screen);
544 /***********************************************************************
545 Starting and ending an update
546 ***********************************************************************/
548 /* Start an update of frame F. This function is installed as a hook
549 for update_begin, i.e. it is called when update_begin is called.
550 This function is called prior to calls to x_update_window_begin for
551 each window being updated. Currently, there is nothing to do here
552 because all interesting stuff is done on a window basis. */
554 static void
555 x_update_begin (f)
556 struct frame *f;
558 /* Nothing to do. */
562 /* Start update of window W. Set the global variable updated_window
563 to the window being updated and set output_cursor to the cursor
564 position of W. */
566 static void
567 x_update_window_begin (w)
568 struct window *w;
570 struct frame *f = XFRAME (WINDOW_FRAME (w));
571 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
573 updated_window = w;
574 set_output_cursor (&w->cursor);
576 BLOCK_INPUT;
578 if (f == display_info->mouse_face_mouse_frame)
580 /* Don't do highlighting for mouse motion during the update. */
581 display_info->mouse_face_defer = 1;
583 /* If F needs to be redrawn, simply forget about any prior mouse
584 highlighting. */
585 if (FRAME_GARBAGED_P (f))
586 display_info->mouse_face_window = Qnil;
588 #if 0 /* Rows in a current matrix containing glyphs in mouse-face have
589 their mouse_face_p flag set, which means that they are always
590 unequal to rows in a desired matrix which never have that
591 flag set. So, rows containing mouse-face glyphs are never
592 scrolled, and we don't have to switch the mouse highlight off
593 here to prevent it from being scrolled. */
595 /* Can we tell that this update does not affect the window
596 where the mouse highlight is? If so, no need to turn off.
597 Likewise, don't do anything if the frame is garbaged;
598 in that case, the frame's current matrix that we would use
599 is all wrong, and we will redisplay that line anyway. */
600 if (!NILP (display_info->mouse_face_window)
601 && w == XWINDOW (display_info->mouse_face_window))
603 int i;
605 for (i = 0; i < w->desired_matrix->nrows; ++i)
606 if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
607 break;
609 if (i < w->desired_matrix->nrows)
610 clear_mouse_face (display_info);
612 #endif /* 0 */
615 UNBLOCK_INPUT;
619 /* Draw a vertical window border from (x,y0) to (x,y1) */
621 static void
622 x_draw_vertical_window_border (w, x, y0, y1)
623 struct window *w;
624 int x, y0, y1;
626 struct frame *f = XFRAME (WINDOW_FRAME (w));
627 struct face *face;
629 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
630 if (face)
631 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
632 face->foreground);
634 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
635 f->output_data.x->normal_gc, x, y0, x, y1);
638 /* End update of window W (which is equal to updated_window).
640 Draw vertical borders between horizontally adjacent windows, and
641 display W's cursor if CURSOR_ON_P is non-zero.
643 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
644 glyphs in mouse-face were overwritten. In that case we have to
645 make sure that the mouse-highlight is properly redrawn.
647 W may be a menu bar pseudo-window in case we don't have X toolkit
648 support. Such windows don't have a cursor, so don't display it
649 here. */
651 static void
652 x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
653 struct window *w;
654 int cursor_on_p, mouse_face_overwritten_p;
656 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
658 if (!w->pseudo_window_p)
660 BLOCK_INPUT;
662 if (cursor_on_p)
663 display_and_set_cursor (w, 1, output_cursor.hpos,
664 output_cursor.vpos,
665 output_cursor.x, output_cursor.y);
667 if (draw_window_fringes (w, 1))
668 x_draw_vertical_border (w);
670 UNBLOCK_INPUT;
673 /* If a row with mouse-face was overwritten, arrange for
674 XTframe_up_to_date to redisplay the mouse highlight. */
675 if (mouse_face_overwritten_p)
677 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
678 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
679 dpyinfo->mouse_face_window = Qnil;
682 updated_window = NULL;
686 /* End update of frame F. This function is installed as a hook in
687 update_end. */
689 static void
690 x_update_end (f)
691 struct frame *f;
693 /* Mouse highlight may be displayed again. */
694 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
696 #ifndef XFlush
697 BLOCK_INPUT;
698 XFlush (FRAME_X_DISPLAY (f));
699 UNBLOCK_INPUT;
700 #endif
704 /* This function is called from various places in xdisp.c whenever a
705 complete update has been performed. The global variable
706 updated_window is not available here. */
708 static void
709 XTframe_up_to_date (f)
710 struct frame *f;
712 if (FRAME_X_P (f))
714 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
716 if (dpyinfo->mouse_face_deferred_gc
717 || f == dpyinfo->mouse_face_mouse_frame)
719 BLOCK_INPUT;
720 if (dpyinfo->mouse_face_mouse_frame)
721 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
722 dpyinfo->mouse_face_mouse_x,
723 dpyinfo->mouse_face_mouse_y);
724 dpyinfo->mouse_face_deferred_gc = 0;
725 UNBLOCK_INPUT;
731 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
732 arrow bitmaps, or clear the fringes if no bitmaps are required
733 before DESIRED_ROW is made current. The window being updated is
734 found in updated_window. This function It is called from
735 update_window_line only if it is known that there are differences
736 between bitmaps to be drawn between current row and DESIRED_ROW. */
738 static void
739 x_after_update_window_line (desired_row)
740 struct glyph_row *desired_row;
742 struct window *w = updated_window;
743 struct frame *f;
744 int width, height;
746 xassert (w);
748 if (!desired_row->mode_line_p && !w->pseudo_window_p)
749 desired_row->redraw_fringe_bitmaps_p = 1;
751 /* When a window has disappeared, make sure that no rest of
752 full-width rows stays visible in the internal border. Could
753 check here if updated_window is the leftmost/rightmost window,
754 but I guess it's not worth doing since vertically split windows
755 are almost never used, internal border is rarely set, and the
756 overhead is very small. */
757 if (windows_or_buffers_changed
758 && desired_row->full_width_p
759 && (f = XFRAME (w->frame),
760 width = FRAME_INTERNAL_BORDER_WIDTH (f),
761 width != 0)
762 && (height = desired_row->visible_height,
763 height > 0))
765 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
767 /* Internal border is drawn below the tool bar. */
768 if (WINDOWP (f->tool_bar_window)
769 && w == XWINDOW (f->tool_bar_window))
770 y -= width;
772 BLOCK_INPUT;
773 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
774 0, y, width, height, False);
775 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
776 FRAME_PIXEL_WIDTH (f) - width,
777 y, width, height, False);
778 UNBLOCK_INPUT;
782 static void
783 x_draw_fringe_bitmap (w, row, p)
784 struct window *w;
785 struct glyph_row *row;
786 struct draw_fringe_bitmap_params *p;
788 struct frame *f = XFRAME (WINDOW_FRAME (w));
789 Display *display = FRAME_X_DISPLAY (f);
790 Window window = FRAME_X_WINDOW (f);
791 GC gc = f->output_data.x->normal_gc;
792 struct face *face = p->face;
793 int rowY;
795 /* Must clip because of partially visible lines. */
796 rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
797 if (p->y < rowY)
799 /* Adjust position of "bottom aligned" bitmap on partially
800 visible last row. */
801 int oldY = row->y;
802 int oldVH = row->visible_height;
803 row->visible_height = p->h;
804 row->y -= rowY - p->y;
805 x_clip_to_row (w, row, -1, gc);
806 row->y = oldY;
807 row->visible_height = oldVH;
809 else
810 x_clip_to_row (w, row, -1, gc);
812 if (!p->overlay_p)
814 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
816 /* In case the same realized face is used for fringes and
817 for something displayed in the text (e.g. face `region' on
818 mono-displays, the fill style may have been changed to
819 FillSolid in x_draw_glyph_string_background. */
820 if (face->stipple)
821 XSetFillStyle (display, face->gc, FillOpaqueStippled);
822 else
823 XSetForeground (display, face->gc, face->background);
825 #ifdef USE_TOOLKIT_SCROLL_BARS
826 /* If the fringe is adjacent to the left (right) scroll bar of a
827 leftmost (rightmost, respectively) window, then extend its
828 background to the gap between the fringe and the bar. */
829 if ((WINDOW_LEFTMOST_P (w)
830 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
831 || (WINDOW_RIGHTMOST_P (w)
832 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
834 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
836 if (sb_width > 0)
838 int left = WINDOW_SCROLL_BAR_AREA_X (w);
839 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
840 * FRAME_COLUMN_WIDTH (f));
842 if (bx < 0)
844 /* Bitmap fills the fringe. */
845 if (left + width == p->x)
846 bx = left + sb_width;
847 else if (p->x + p->wd == left)
848 bx = left;
849 if (bx >= 0)
851 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
853 nx = width - sb_width;
854 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
855 row->y));
856 ny = row->visible_height;
859 else
861 if (left + width == bx)
863 bx = left + sb_width;
864 nx += width - sb_width;
866 else if (bx + nx == left)
867 nx += width - sb_width;
871 #endif
872 if (bx >= 0 && nx > 0)
873 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
875 if (!face->stipple)
876 XSetForeground (display, face->gc, face->foreground);
879 if (p->which)
881 unsigned char *bits;
882 Pixmap pixmap, clipmask = (Pixmap) 0;
883 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
884 XGCValues gcv;
886 if (p->wd > 8)
887 bits = (unsigned char *)(p->bits + p->dh);
888 else
889 bits = (unsigned char *)p->bits + p->dh;
891 /* Draw the bitmap. I believe these small pixmaps can be cached
892 by the server. */
893 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
894 (p->cursor_p
895 ? (p->overlay_p ? face->background
896 : f->output_data.x->cursor_pixel)
897 : face->foreground),
898 face->background, depth);
900 if (p->overlay_p)
902 clipmask = XCreatePixmapFromBitmapData (display,
903 FRAME_X_DISPLAY_INFO (f)->root_window,
904 bits, p->wd, p->h,
905 1, 0, 1);
906 gcv.clip_mask = clipmask;
907 gcv.clip_x_origin = p->x;
908 gcv.clip_y_origin = p->y;
909 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
912 XCopyArea (display, pixmap, window, gc, 0, 0,
913 p->wd, p->h, p->x, p->y);
914 XFreePixmap (display, pixmap);
916 if (p->overlay_p)
918 gcv.clip_mask = (Pixmap) 0;
919 XChangeGC (display, gc, GCClipMask, &gcv);
920 XFreePixmap (display, clipmask);
924 XSetClipMask (display, gc, None);
929 /* This is called when starting Emacs and when restarting after
930 suspend. When starting Emacs, no X window is mapped. And nothing
931 must be done to Emacs's own window if it is suspended (though that
932 rarely happens). */
934 static void
935 XTset_terminal_modes (struct terminal *terminal)
939 /* This is called when exiting or suspending Emacs. Exiting will make
940 the X-windows go away, and suspending requires no action. */
942 static void
943 XTreset_terminal_modes (struct terminal *terminal)
948 /***********************************************************************
949 Glyph display
950 ***********************************************************************/
954 static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
955 static void x_set_glyph_string_gc P_ ((struct glyph_string *));
956 static void x_draw_glyph_string_background P_ ((struct glyph_string *,
957 int));
958 static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
959 static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
960 static void x_draw_glyph_string_box P_ ((struct glyph_string *));
961 static void x_draw_glyph_string P_ ((struct glyph_string *));
962 static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
963 static void x_set_cursor_gc P_ ((struct glyph_string *));
964 static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
965 static void x_set_mouse_face_gc P_ ((struct glyph_string *));
966 static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
967 unsigned long *, double, int));
968 static void x_setup_relief_color P_ ((struct frame *, struct relief *,
969 double, int, unsigned long));
970 static void x_setup_relief_colors P_ ((struct glyph_string *));
971 static void x_draw_image_glyph_string P_ ((struct glyph_string *));
972 static void x_draw_image_relief P_ ((struct glyph_string *));
973 static void x_draw_image_foreground P_ ((struct glyph_string *));
974 static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
975 static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
976 int, int, int));
977 static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
978 int, int, int, int, int, int,
979 XRectangle *));
980 static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
981 int, int, int, XRectangle *));
983 #if GLYPH_DEBUG
984 static void x_check_font P_ ((struct frame *, struct font *));
985 #endif
988 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
989 face. */
991 static void
992 x_set_cursor_gc (s)
993 struct glyph_string *s;
995 if (s->font == FRAME_FONT (s->f)
996 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
997 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
998 && !s->cmp)
999 s->gc = s->f->output_data.x->cursor_gc;
1000 else
1002 /* Cursor on non-default face: must merge. */
1003 XGCValues xgcv;
1004 unsigned long mask;
1006 xgcv.background = s->f->output_data.x->cursor_pixel;
1007 xgcv.foreground = s->face->background;
1009 /* If the glyph would be invisible, try a different foreground. */
1010 if (xgcv.foreground == xgcv.background)
1011 xgcv.foreground = s->face->foreground;
1012 if (xgcv.foreground == xgcv.background)
1013 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
1014 if (xgcv.foreground == xgcv.background)
1015 xgcv.foreground = s->face->foreground;
1017 /* Make sure the cursor is distinct from text in this face. */
1018 if (xgcv.background == s->face->background
1019 && xgcv.foreground == s->face->foreground)
1021 xgcv.background = s->face->foreground;
1022 xgcv.foreground = s->face->background;
1025 IF_DEBUG (x_check_font (s->f, s->font));
1026 xgcv.graphics_exposures = False;
1027 mask = GCForeground | GCBackground | GCGraphicsExposures;
1029 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1030 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1031 mask, &xgcv);
1032 else
1033 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1034 = XCreateGC (s->display, s->window, mask, &xgcv);
1036 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1041 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1043 static void
1044 x_set_mouse_face_gc (s)
1045 struct glyph_string *s;
1047 int face_id;
1048 struct face *face;
1050 /* What face has to be used last for the mouse face? */
1051 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1052 face = FACE_FROM_ID (s->f, face_id);
1053 if (face == NULL)
1054 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1056 if (s->first_glyph->type == CHAR_GLYPH)
1057 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1058 else
1059 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1060 s->face = FACE_FROM_ID (s->f, face_id);
1061 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1063 if (s->font == s->face->font)
1064 s->gc = s->face->gc;
1065 else
1067 /* Otherwise construct scratch_cursor_gc with values from FACE
1068 except for FONT. */
1069 XGCValues xgcv;
1070 unsigned long mask;
1072 xgcv.background = s->face->background;
1073 xgcv.foreground = s->face->foreground;
1074 xgcv.graphics_exposures = False;
1075 mask = GCForeground | GCBackground | GCGraphicsExposures;
1077 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1078 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1079 mask, &xgcv);
1080 else
1081 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1082 = XCreateGC (s->display, s->window, mask, &xgcv);
1084 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1087 xassert (s->gc != 0);
1091 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1092 Faces to use in the mode line have already been computed when the
1093 matrix was built, so there isn't much to do, here. */
1095 static INLINE void
1096 x_set_mode_line_face_gc (s)
1097 struct glyph_string *s;
1099 s->gc = s->face->gc;
1103 /* Set S->gc of glyph string S for drawing that glyph string. Set
1104 S->stippled_p to a non-zero value if the face of S has a stipple
1105 pattern. */
1107 static INLINE void
1108 x_set_glyph_string_gc (s)
1109 struct glyph_string *s;
1111 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1113 if (s->hl == DRAW_NORMAL_TEXT)
1115 s->gc = s->face->gc;
1116 s->stippled_p = s->face->stipple != 0;
1118 else if (s->hl == DRAW_INVERSE_VIDEO)
1120 x_set_mode_line_face_gc (s);
1121 s->stippled_p = s->face->stipple != 0;
1123 else if (s->hl == DRAW_CURSOR)
1125 x_set_cursor_gc (s);
1126 s->stippled_p = 0;
1128 else if (s->hl == DRAW_MOUSE_FACE)
1130 x_set_mouse_face_gc (s);
1131 s->stippled_p = s->face->stipple != 0;
1133 else if (s->hl == DRAW_IMAGE_RAISED
1134 || s->hl == DRAW_IMAGE_SUNKEN)
1136 s->gc = s->face->gc;
1137 s->stippled_p = s->face->stipple != 0;
1139 else
1141 s->gc = s->face->gc;
1142 s->stippled_p = s->face->stipple != 0;
1145 /* GC must have been set. */
1146 xassert (s->gc != 0);
1150 /* Set clipping for output of glyph string S. S may be part of a mode
1151 line or menu if we don't have X toolkit support. */
1153 static INLINE void
1154 x_set_glyph_string_clipping (s)
1155 struct glyph_string *s;
1157 XRectangle *r = s->clip;
1158 int n = get_glyph_string_clip_rects (s, r, 2);
1160 if (n > 0)
1161 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1162 s->num_clips = n;
1166 /* Set SRC's clipping for output of glyph string DST. This is called
1167 when we are drawing DST's left_overhang or right_overhang only in
1168 the area of SRC. */
1170 static void
1171 x_set_glyph_string_clipping_exactly (src, dst)
1172 struct glyph_string *src, *dst;
1174 XRectangle r;
1176 r.x = src->x;
1177 r.width = src->width;
1178 r.y = src->y;
1179 r.height = src->height;
1180 dst->clip[0] = r;
1181 dst->num_clips = 1;
1182 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1186 /* RIF:
1187 Compute left and right overhang of glyph string S. */
1189 static void
1190 x_compute_glyph_string_overhangs (s)
1191 struct glyph_string *s;
1193 if (s->cmp == NULL
1194 && s->first_glyph->type == CHAR_GLYPH)
1196 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1197 struct font *font = s->font;
1198 struct font_metrics metrics;
1199 int i;
1201 for (i = 0; i < s->nchars; i++)
1202 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1203 font->driver->text_extents (font, code, s->nchars, &metrics);
1204 s->right_overhang = (metrics.rbearing > metrics.width
1205 ? metrics.rbearing - metrics.width : 0);
1206 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1208 else if (s->cmp)
1210 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1211 s->left_overhang = - s->cmp->lbearing;
1216 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1218 static INLINE void
1219 x_clear_glyph_string_rect (s, x, y, w, h)
1220 struct glyph_string *s;
1221 int x, y, w, h;
1223 XGCValues xgcv;
1224 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1225 XSetForeground (s->display, s->gc, xgcv.background);
1226 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1227 XSetForeground (s->display, s->gc, xgcv.foreground);
1231 /* Draw the background of glyph_string S. If S->background_filled_p
1232 is non-zero don't draw it. FORCE_P non-zero means draw the
1233 background even if it wouldn't be drawn normally. This is used
1234 when a string preceding S draws into the background of S, or S
1235 contains the first component of a composition. */
1237 static void
1238 x_draw_glyph_string_background (s, force_p)
1239 struct glyph_string *s;
1240 int force_p;
1242 /* Nothing to do if background has already been drawn or if it
1243 shouldn't be drawn in the first place. */
1244 if (!s->background_filled_p)
1246 int box_line_width = max (s->face->box_line_width, 0);
1248 if (s->stippled_p)
1250 /* Fill background with a stipple pattern. */
1251 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1252 XFillRectangle (s->display, s->window, s->gc, s->x,
1253 s->y + box_line_width,
1254 s->background_width,
1255 s->height - 2 * box_line_width);
1256 XSetFillStyle (s->display, s->gc, FillSolid);
1257 s->background_filled_p = 1;
1259 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1260 || s->font_not_found_p
1261 || s->extends_to_end_of_line_p
1262 || force_p)
1264 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1265 s->background_width,
1266 s->height - 2 * box_line_width);
1267 s->background_filled_p = 1;
1273 /* Draw the foreground of glyph string S. */
1275 static void
1276 x_draw_glyph_string_foreground (s)
1277 struct glyph_string *s;
1279 int i, x;
1281 /* If first glyph of S has a left box line, start drawing the text
1282 of S to the right of that box line. */
1283 if (s->face->box != FACE_NO_BOX
1284 && s->first_glyph->left_box_line_p)
1285 x = s->x + eabs (s->face->box_line_width);
1286 else
1287 x = s->x;
1289 /* Draw characters of S as rectangles if S's font could not be
1290 loaded. */
1291 if (s->font_not_found_p)
1293 for (i = 0; i < s->nchars; ++i)
1295 struct glyph *g = s->first_glyph + i;
1296 XDrawRectangle (s->display, s->window,
1297 s->gc, x, s->y, g->pixel_width - 1,
1298 s->height - 1);
1299 x += g->pixel_width;
1302 else
1304 struct font *font = s->font;
1305 int boff = font->baseline_offset;
1306 int y;
1308 if (font->vertical_centering)
1309 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1311 y = s->ybase - boff;
1312 if (s->for_overlaps
1313 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1314 font->driver->draw (s, 0, s->nchars, x, y, 0);
1315 else
1316 font->driver->draw (s, 0, s->nchars, x, y, 1);
1317 if (s->face->overstrike)
1318 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1322 /* Draw the foreground of composite glyph string S. */
1324 static void
1325 x_draw_composite_glyph_string_foreground (s)
1326 struct glyph_string *s;
1328 int i, j, x;
1329 struct font *font = s->font;
1331 /* If first glyph of S has a left box line, start drawing the text
1332 of S to the right of that box line. */
1333 if (s->face && s->face->box != FACE_NO_BOX
1334 && s->first_glyph->left_box_line_p)
1335 x = s->x + eabs (s->face->box_line_width);
1336 else
1337 x = s->x;
1339 /* S is a glyph string for a composition. S->cmp_from is the index
1340 of the first character drawn for glyphs of this composition.
1341 S->cmp_from == 0 means we are drawing the very first character of
1342 this composition. */
1344 /* Draw a rectangle for the composition if the font for the very
1345 first character of the composition could not be loaded. */
1346 if (s->font_not_found_p)
1348 if (s->cmp_from == 0)
1349 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1350 s->width - 1, s->height - 1);
1352 else if (! s->first_glyph->u.cmp.automatic)
1354 int y = s->ybase;
1356 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1357 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1359 int xx = x + s->cmp->offsets[j * 2];
1360 int yy = y - s->cmp->offsets[j * 2 + 1];
1362 font->driver->draw (s, j, j + 1, xx, yy, 0);
1363 if (s->face->overstrike)
1364 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1367 else
1369 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1370 Lisp_Object glyph;
1371 int y = s->ybase;
1372 int width = 0;
1374 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1376 glyph = LGSTRING_GLYPH (gstring, i);
1377 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1378 width += LGLYPH_WIDTH (glyph);
1379 else
1381 int xoff, yoff, wadjust;
1383 if (j < i)
1385 font->driver->draw (s, j, i, x, y, 0);
1386 x += width;
1388 xoff = LGLYPH_XOFF (glyph);
1389 yoff = LGLYPH_YOFF (glyph);
1390 wadjust = LGLYPH_WADJUST (glyph);
1391 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1392 x += wadjust;
1393 j = i + 1;
1394 width = 0;
1397 if (j < i)
1398 font->driver->draw (s, j, i, x, y, 0);
1403 #ifdef USE_X_TOOLKIT
1405 static struct frame *x_frame_of_widget P_ ((Widget));
1406 static Boolean cvt_string_to_pixel P_ ((Display *, XrmValue *, Cardinal *,
1407 XrmValue *, XrmValue *, XtPointer *));
1408 static void cvt_pixel_dtor P_ ((XtAppContext, XrmValue *, XtPointer,
1409 XrmValue *, Cardinal *));
1412 /* Return the frame on which widget WIDGET is used.. Abort if frame
1413 cannot be determined. */
1415 static struct frame *
1416 x_frame_of_widget (widget)
1417 Widget widget;
1419 struct x_display_info *dpyinfo;
1420 Lisp_Object tail;
1421 struct frame *f;
1423 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1425 /* Find the top-level shell of the widget. Note that this function
1426 can be called when the widget is not yet realized, so XtWindow
1427 (widget) == 0. That's the reason we can't simply use
1428 x_any_window_to_frame. */
1429 while (!XtIsTopLevelShell (widget))
1430 widget = XtParent (widget);
1432 /* Look for a frame with that top-level widget. Allocate the color
1433 on that frame to get the right gamma correction value. */
1434 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1435 if (FRAMEP (XCAR (tail))
1436 && (f = XFRAME (XCAR (tail)),
1437 (FRAME_X_P (f)
1438 && f->output_data.nothing != 1
1439 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1440 && f->output_data.x->widget == widget)
1441 return f;
1443 abort ();
1447 /* Allocate the color COLOR->pixel on the screen and display of
1448 widget WIDGET in colormap CMAP. If an exact match cannot be
1449 allocated, try the nearest color available. Value is non-zero
1450 if successful. This is called from lwlib. */
1453 x_alloc_nearest_color_for_widget (widget, cmap, color)
1454 Widget widget;
1455 Colormap cmap;
1456 XColor *color;
1458 struct frame *f = x_frame_of_widget (widget);
1459 return x_alloc_nearest_color (f, cmap, color);
1463 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1464 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1465 If this produces the same color as PIXEL, try a color where all RGB
1466 values have DELTA added. Return the allocated color in *PIXEL.
1467 DISPLAY is the X display, CMAP is the colormap to operate on.
1468 Value is non-zero if successful. */
1471 x_alloc_lighter_color_for_widget (widget, display, cmap, pixel, factor, delta)
1472 Widget widget;
1473 Display *display;
1474 Colormap cmap;
1475 unsigned long *pixel;
1476 double factor;
1477 int delta;
1479 struct frame *f = x_frame_of_widget (widget);
1480 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1484 /* Structure specifying which arguments should be passed by Xt to
1485 cvt_string_to_pixel. We want the widget's screen and colormap. */
1487 static XtConvertArgRec cvt_string_to_pixel_args[] =
1489 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1490 sizeof (Screen *)},
1491 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1492 sizeof (Colormap)}
1496 /* The address of this variable is returned by
1497 cvt_string_to_pixel. */
1499 static Pixel cvt_string_to_pixel_value;
1502 /* Convert a color name to a pixel color.
1504 DPY is the display we are working on.
1506 ARGS is an array of *NARGS XrmValue structures holding additional
1507 information about the widget for which the conversion takes place.
1508 The contents of this array are determined by the specification
1509 in cvt_string_to_pixel_args.
1511 FROM is a pointer to an XrmValue which points to the color name to
1512 convert. TO is an XrmValue in which to return the pixel color.
1514 CLOSURE_RET is a pointer to user-data, in which we record if
1515 we allocated the color or not.
1517 Value is True if successful, False otherwise. */
1519 static Boolean
1520 cvt_string_to_pixel (dpy, args, nargs, from, to, closure_ret)
1521 Display *dpy;
1522 XrmValue *args;
1523 Cardinal *nargs;
1524 XrmValue *from, *to;
1525 XtPointer *closure_ret;
1527 Screen *screen;
1528 Colormap cmap;
1529 Pixel pixel;
1530 String color_name;
1531 XColor color;
1533 if (*nargs != 2)
1535 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1536 "wrongParameters", "cvt_string_to_pixel",
1537 "XtToolkitError",
1538 "Screen and colormap args required", NULL, NULL);
1539 return False;
1542 screen = *(Screen **) args[0].addr;
1543 cmap = *(Colormap *) args[1].addr;
1544 color_name = (String) from->addr;
1546 if (strcmp (color_name, XtDefaultBackground) == 0)
1548 *closure_ret = (XtPointer) False;
1549 pixel = WhitePixelOfScreen (screen);
1551 else if (strcmp (color_name, XtDefaultForeground) == 0)
1553 *closure_ret = (XtPointer) False;
1554 pixel = BlackPixelOfScreen (screen);
1556 else if (XParseColor (dpy, cmap, color_name, &color)
1557 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1559 pixel = color.pixel;
1560 *closure_ret = (XtPointer) True;
1562 else
1564 String params[1];
1565 Cardinal nparams = 1;
1567 params[0] = color_name;
1568 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1569 "badValue", "cvt_string_to_pixel",
1570 "XtToolkitError", "Invalid color `%s'",
1571 params, &nparams);
1572 return False;
1575 if (to->addr != NULL)
1577 if (to->size < sizeof (Pixel))
1579 to->size = sizeof (Pixel);
1580 return False;
1583 *(Pixel *) to->addr = pixel;
1585 else
1587 cvt_string_to_pixel_value = pixel;
1588 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1591 to->size = sizeof (Pixel);
1592 return True;
1596 /* Free a pixel color which was previously allocated via
1597 cvt_string_to_pixel. This is registered as the destructor
1598 for this type of resource via XtSetTypeConverter.
1600 APP is the application context in which we work.
1602 TO is a pointer to an XrmValue holding the color to free.
1603 CLOSURE is the value we stored in CLOSURE_RET for this color
1604 in cvt_string_to_pixel.
1606 ARGS and NARGS are like for cvt_string_to_pixel. */
1608 static void
1609 cvt_pixel_dtor (app, to, closure, args, nargs)
1610 XtAppContext app;
1611 XrmValuePtr to;
1612 XtPointer closure;
1613 XrmValuePtr args;
1614 Cardinal *nargs;
1616 if (*nargs != 2)
1618 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1619 "XtToolkitError",
1620 "Screen and colormap arguments required",
1621 NULL, NULL);
1623 else if (closure != NULL)
1625 /* We did allocate the pixel, so free it. */
1626 Screen *screen = *(Screen **) args[0].addr;
1627 Colormap cmap = *(Colormap *) args[1].addr;
1628 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1629 (Pixel *) to->addr, 1);
1634 #endif /* USE_X_TOOLKIT */
1637 /* Value is an array of XColor structures for the contents of the
1638 color map of display DPY. Set *NCELLS to the size of the array.
1639 Note that this probably shouldn't be called for large color maps,
1640 say a 24-bit TrueColor map. */
1642 static const XColor *
1643 x_color_cells (dpy, ncells)
1644 Display *dpy;
1645 int *ncells;
1647 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1649 if (dpyinfo->color_cells == NULL)
1651 Screen *screen = dpyinfo->screen;
1652 int i;
1654 dpyinfo->ncolor_cells
1655 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1656 dpyinfo->color_cells
1657 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1658 * sizeof *dpyinfo->color_cells);
1660 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1661 dpyinfo->color_cells[i].pixel = i;
1663 XQueryColors (dpy, dpyinfo->cmap,
1664 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1667 *ncells = dpyinfo->ncolor_cells;
1668 return dpyinfo->color_cells;
1672 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1673 colors in COLORS. Use cached information, if available. */
1675 void
1676 x_query_colors (f, colors, ncolors)
1677 struct frame *f;
1678 XColor *colors;
1679 int ncolors;
1681 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1683 if (dpyinfo->color_cells)
1685 int i;
1686 for (i = 0; i < ncolors; ++i)
1688 unsigned long pixel = colors[i].pixel;
1689 xassert (pixel < dpyinfo->ncolor_cells);
1690 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1691 colors[i] = dpyinfo->color_cells[pixel];
1694 else
1695 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1699 /* On frame F, translate pixel color to RGB values for the color in
1700 COLOR. Use cached information, if available. */
1702 void
1703 x_query_color (f, color)
1704 struct frame *f;
1705 XColor *color;
1707 x_query_colors (f, color, 1);
1711 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1712 exact match can't be allocated, try the nearest color available.
1713 Value is non-zero if successful. Set *COLOR to the color
1714 allocated. */
1716 static int
1717 x_alloc_nearest_color_1 (dpy, cmap, color)
1718 Display *dpy;
1719 Colormap cmap;
1720 XColor *color;
1722 int rc;
1724 rc = XAllocColor (dpy, cmap, color);
1725 if (rc == 0)
1727 /* If we got to this point, the colormap is full, so we're going
1728 to try to get the next closest color. The algorithm used is
1729 a least-squares matching, which is what X uses for closest
1730 color matching with StaticColor visuals. */
1731 int nearest, i;
1732 unsigned long nearest_delta = ~0;
1733 int ncells;
1734 const XColor *cells = x_color_cells (dpy, &ncells);
1736 for (nearest = i = 0; i < ncells; ++i)
1738 long dred = (color->red >> 8) - (cells[i].red >> 8);
1739 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1740 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1741 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1743 if (delta < nearest_delta)
1745 nearest = i;
1746 nearest_delta = delta;
1750 color->red = cells[nearest].red;
1751 color->green = cells[nearest].green;
1752 color->blue = cells[nearest].blue;
1753 rc = XAllocColor (dpy, cmap, color);
1755 else
1757 /* If allocation succeeded, and the allocated pixel color is not
1758 equal to a cached pixel color recorded earlier, there was a
1759 change in the colormap, so clear the color cache. */
1760 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1761 XColor *cached_color;
1763 if (dpyinfo->color_cells
1764 && (cached_color = &dpyinfo->color_cells[color->pixel],
1765 (cached_color->red != color->red
1766 || cached_color->blue != color->blue
1767 || cached_color->green != color->green)))
1769 xfree (dpyinfo->color_cells);
1770 dpyinfo->color_cells = NULL;
1771 dpyinfo->ncolor_cells = 0;
1775 #ifdef DEBUG_X_COLORS
1776 if (rc)
1777 register_color (color->pixel);
1778 #endif /* DEBUG_X_COLORS */
1780 return rc;
1784 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1785 exact match can't be allocated, try the nearest color available.
1786 Value is non-zero if successful. Set *COLOR to the color
1787 allocated. */
1790 x_alloc_nearest_color (f, cmap, color)
1791 struct frame *f;
1792 Colormap cmap;
1793 XColor *color;
1795 gamma_correct (f, color);
1796 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1800 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1801 It's necessary to do this instead of just using PIXEL directly to
1802 get color reference counts right. */
1804 unsigned long
1805 x_copy_color (f, pixel)
1806 struct frame *f;
1807 unsigned long pixel;
1809 XColor color;
1811 color.pixel = pixel;
1812 BLOCK_INPUT;
1813 x_query_color (f, &color);
1814 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1815 UNBLOCK_INPUT;
1816 #ifdef DEBUG_X_COLORS
1817 register_color (pixel);
1818 #endif
1819 return color.pixel;
1823 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1824 It's necessary to do this instead of just using PIXEL directly to
1825 get color reference counts right. */
1827 unsigned long
1828 x_copy_dpy_color (dpy, cmap, pixel)
1829 Display *dpy;
1830 Colormap cmap;
1831 unsigned long pixel;
1833 XColor color;
1835 color.pixel = pixel;
1836 BLOCK_INPUT;
1837 XQueryColor (dpy, cmap, &color);
1838 XAllocColor (dpy, cmap, &color);
1839 UNBLOCK_INPUT;
1840 #ifdef DEBUG_X_COLORS
1841 register_color (pixel);
1842 #endif
1843 return color.pixel;
1847 /* Brightness beyond which a color won't have its highlight brightness
1848 boosted.
1850 Nominally, highlight colors for `3d' faces are calculated by
1851 brightening an object's color by a constant scale factor, but this
1852 doesn't yield good results for dark colors, so for colors who's
1853 brightness is less than this value (on a scale of 0-65535) have an
1854 use an additional additive factor.
1856 The value here is set so that the default menu-bar/mode-line color
1857 (grey75) will not have its highlights changed at all. */
1858 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1861 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1862 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1863 If this produces the same color as PIXEL, try a color where all RGB
1864 values have DELTA added. Return the allocated color in *PIXEL.
1865 DISPLAY is the X display, CMAP is the colormap to operate on.
1866 Value is non-zero if successful. */
1868 static int
1869 x_alloc_lighter_color (f, display, cmap, pixel, factor, delta)
1870 struct frame *f;
1871 Display *display;
1872 Colormap cmap;
1873 unsigned long *pixel;
1874 double factor;
1875 int delta;
1877 XColor color, new;
1878 long bright;
1879 int success_p;
1881 /* Get RGB color values. */
1882 color.pixel = *pixel;
1883 x_query_color (f, &color);
1885 /* Change RGB values by specified FACTOR. Avoid overflow! */
1886 xassert (factor >= 0);
1887 new.red = min (0xffff, factor * color.red);
1888 new.green = min (0xffff, factor * color.green);
1889 new.blue = min (0xffff, factor * color.blue);
1891 /* Calculate brightness of COLOR. */
1892 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1894 /* We only boost colors that are darker than
1895 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1896 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1897 /* Make an additive adjustment to NEW, because it's dark enough so
1898 that scaling by FACTOR alone isn't enough. */
1900 /* How far below the limit this color is (0 - 1, 1 being darker). */
1901 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1902 /* The additive adjustment. */
1903 int min_delta = delta * dimness * factor / 2;
1905 if (factor < 1)
1907 new.red = max (0, new.red - min_delta);
1908 new.green = max (0, new.green - min_delta);
1909 new.blue = max (0, new.blue - min_delta);
1911 else
1913 new.red = min (0xffff, min_delta + new.red);
1914 new.green = min (0xffff, min_delta + new.green);
1915 new.blue = min (0xffff, min_delta + new.blue);
1919 /* Try to allocate the color. */
1920 success_p = x_alloc_nearest_color (f, cmap, &new);
1921 if (success_p)
1923 if (new.pixel == *pixel)
1925 /* If we end up with the same color as before, try adding
1926 delta to the RGB values. */
1927 x_free_colors (f, &new.pixel, 1);
1929 new.red = min (0xffff, delta + color.red);
1930 new.green = min (0xffff, delta + color.green);
1931 new.blue = min (0xffff, delta + color.blue);
1932 success_p = x_alloc_nearest_color (f, cmap, &new);
1934 else
1935 success_p = 1;
1936 *pixel = new.pixel;
1939 return success_p;
1943 /* Set up the foreground color for drawing relief lines of glyph
1944 string S. RELIEF is a pointer to a struct relief containing the GC
1945 with which lines will be drawn. Use a color that is FACTOR or
1946 DELTA lighter or darker than the relief's background which is found
1947 in S->f->output_data.x->relief_background. If such a color cannot
1948 be allocated, use DEFAULT_PIXEL, instead. */
1950 static void
1951 x_setup_relief_color (f, relief, factor, delta, default_pixel)
1952 struct frame *f;
1953 struct relief *relief;
1954 double factor;
1955 int delta;
1956 unsigned long default_pixel;
1958 XGCValues xgcv;
1959 struct x_output *di = f->output_data.x;
1960 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1961 unsigned long pixel;
1962 unsigned long background = di->relief_background;
1963 Colormap cmap = FRAME_X_COLORMAP (f);
1964 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1965 Display *dpy = FRAME_X_DISPLAY (f);
1967 xgcv.graphics_exposures = False;
1968 xgcv.line_width = 1;
1970 /* Free previously allocated color. The color cell will be reused
1971 when it has been freed as many times as it was allocated, so this
1972 doesn't affect faces using the same colors. */
1973 if (relief->gc
1974 && relief->allocated_p)
1976 x_free_colors (f, &relief->pixel, 1);
1977 relief->allocated_p = 0;
1980 /* Allocate new color. */
1981 xgcv.foreground = default_pixel;
1982 pixel = background;
1983 if (dpyinfo->n_planes != 1
1984 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1986 relief->allocated_p = 1;
1987 xgcv.foreground = relief->pixel = pixel;
1990 if (relief->gc == 0)
1992 xgcv.stipple = dpyinfo->gray;
1993 mask |= GCStipple;
1994 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1996 else
1997 XChangeGC (dpy, relief->gc, mask, &xgcv);
2001 /* Set up colors for the relief lines around glyph string S. */
2003 static void
2004 x_setup_relief_colors (s)
2005 struct glyph_string *s;
2007 struct x_output *di = s->f->output_data.x;
2008 unsigned long color;
2010 if (s->face->use_box_color_for_shadows_p)
2011 color = s->face->box_color;
2012 else if (s->first_glyph->type == IMAGE_GLYPH
2013 && s->img->pixmap
2014 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2015 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2016 else
2018 XGCValues xgcv;
2020 /* Get the background color of the face. */
2021 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2022 color = xgcv.background;
2025 if (di->white_relief.gc == 0
2026 || color != di->relief_background)
2028 di->relief_background = color;
2029 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2030 WHITE_PIX_DEFAULT (s->f));
2031 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2032 BLACK_PIX_DEFAULT (s->f));
2037 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2038 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2039 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2040 relief. LEFT_P non-zero means draw a relief on the left side of
2041 the rectangle. RIGHT_P non-zero means draw a relief on the right
2042 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2043 when drawing. */
2045 static void
2046 x_draw_relief_rect (f, left_x, top_y, right_x, bottom_y, width,
2047 raised_p, top_p, bot_p, left_p, right_p, clip_rect)
2048 struct frame *f;
2049 int left_x, top_y, right_x, bottom_y, width;
2050 int top_p, bot_p, left_p, right_p, raised_p;
2051 XRectangle *clip_rect;
2053 Display *dpy = FRAME_X_DISPLAY (f);
2054 Window window = FRAME_X_WINDOW (f);
2055 int i;
2056 GC gc;
2058 if (raised_p)
2059 gc = f->output_data.x->white_relief.gc;
2060 else
2061 gc = f->output_data.x->black_relief.gc;
2062 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2064 /* Top. */
2065 if (top_p)
2066 for (i = 0; i < width; ++i)
2067 XDrawLine (dpy, window, gc,
2068 left_x + i * left_p, top_y + i,
2069 right_x + 1 - i * right_p, top_y + i);
2071 /* Left. */
2072 if (left_p)
2073 for (i = 0; i < width; ++i)
2074 XDrawLine (dpy, window, gc,
2075 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2077 XSetClipMask (dpy, gc, None);
2078 if (raised_p)
2079 gc = f->output_data.x->black_relief.gc;
2080 else
2081 gc = f->output_data.x->white_relief.gc;
2082 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2084 /* Bottom. */
2085 if (bot_p)
2086 for (i = 0; i < width; ++i)
2087 XDrawLine (dpy, window, gc,
2088 left_x + i * left_p, bottom_y - i,
2089 right_x + 1 - i * right_p, bottom_y - i);
2091 /* Right. */
2092 if (right_p)
2093 for (i = 0; i < width; ++i)
2094 XDrawLine (dpy, window, gc,
2095 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2097 XSetClipMask (dpy, gc, None);
2101 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2102 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2103 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2104 left side of the rectangle. RIGHT_P non-zero means draw a line
2105 on the right side of the rectangle. CLIP_RECT is the clipping
2106 rectangle to use when drawing. */
2108 static void
2109 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2110 left_p, right_p, clip_rect)
2111 struct glyph_string *s;
2112 int left_x, top_y, right_x, bottom_y, width, left_p, right_p;
2113 XRectangle *clip_rect;
2115 XGCValues xgcv;
2117 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2118 XSetForeground (s->display, s->gc, s->face->box_color);
2119 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2121 /* Top. */
2122 XFillRectangle (s->display, s->window, s->gc,
2123 left_x, top_y, right_x - left_x + 1, width);
2125 /* Left. */
2126 if (left_p)
2127 XFillRectangle (s->display, s->window, s->gc,
2128 left_x, top_y, width, bottom_y - top_y + 1);
2130 /* Bottom. */
2131 XFillRectangle (s->display, s->window, s->gc,
2132 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2134 /* Right. */
2135 if (right_p)
2136 XFillRectangle (s->display, s->window, s->gc,
2137 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2139 XSetForeground (s->display, s->gc, xgcv.foreground);
2140 XSetClipMask (s->display, s->gc, None);
2144 /* Draw a box around glyph string S. */
2146 static void
2147 x_draw_glyph_string_box (s)
2148 struct glyph_string *s;
2150 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2151 int left_p, right_p;
2152 struct glyph *last_glyph;
2153 XRectangle clip_rect;
2155 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2156 ? WINDOW_RIGHT_EDGE_X (s->w)
2157 : window_box_right (s->w, s->area));
2159 /* The glyph that may have a right box line. */
2160 last_glyph = (s->cmp || s->img
2161 ? s->first_glyph
2162 : s->first_glyph + s->nchars - 1);
2164 width = eabs (s->face->box_line_width);
2165 raised_p = s->face->box == FACE_RAISED_BOX;
2166 left_x = s->x;
2167 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2168 ? last_x - 1
2169 : min (last_x, s->x + s->background_width) - 1);
2170 top_y = s->y;
2171 bottom_y = top_y + s->height - 1;
2173 left_p = (s->first_glyph->left_box_line_p
2174 || (s->hl == DRAW_MOUSE_FACE
2175 && (s->prev == NULL
2176 || s->prev->hl != s->hl)));
2177 right_p = (last_glyph->right_box_line_p
2178 || (s->hl == DRAW_MOUSE_FACE
2179 && (s->next == NULL
2180 || s->next->hl != s->hl)));
2182 get_glyph_string_clip_rect (s, &clip_rect);
2184 if (s->face->box == FACE_SIMPLE_BOX)
2185 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2186 left_p, right_p, &clip_rect);
2187 else
2189 x_setup_relief_colors (s);
2190 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2191 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2196 /* Draw foreground of image glyph string S. */
2198 static void
2199 x_draw_image_foreground (s)
2200 struct glyph_string *s;
2202 int x = s->x;
2203 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2205 /* If first glyph of S has a left box line, start drawing it to the
2206 right of that line. */
2207 if (s->face->box != FACE_NO_BOX
2208 && s->first_glyph->left_box_line_p
2209 && s->slice.x == 0)
2210 x += eabs (s->face->box_line_width);
2212 /* If there is a margin around the image, adjust x- and y-position
2213 by that margin. */
2214 if (s->slice.x == 0)
2215 x += s->img->hmargin;
2216 if (s->slice.y == 0)
2217 y += s->img->vmargin;
2219 if (s->img->pixmap)
2221 if (s->img->mask)
2223 /* We can't set both a clip mask and use XSetClipRectangles
2224 because the latter also sets a clip mask. We also can't
2225 trust on the shape extension to be available
2226 (XShapeCombineRegion). So, compute the rectangle to draw
2227 manually. */
2228 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2229 | GCFunction);
2230 XGCValues xgcv;
2231 XRectangle clip_rect, image_rect, r;
2233 xgcv.clip_mask = s->img->mask;
2234 xgcv.clip_x_origin = x;
2235 xgcv.clip_y_origin = y;
2236 xgcv.function = GXcopy;
2237 XChangeGC (s->display, s->gc, mask, &xgcv);
2239 get_glyph_string_clip_rect (s, &clip_rect);
2240 image_rect.x = x;
2241 image_rect.y = y;
2242 image_rect.width = s->slice.width;
2243 image_rect.height = s->slice.height;
2244 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2245 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2246 s->slice.x + r.x - x, s->slice.y + r.y - y,
2247 r.width, r.height, r.x, r.y);
2249 else
2251 XRectangle clip_rect, image_rect, r;
2253 get_glyph_string_clip_rect (s, &clip_rect);
2254 image_rect.x = x;
2255 image_rect.y = y;
2256 image_rect.width = s->slice.width;
2257 image_rect.height = s->slice.height;
2258 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2259 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2260 s->slice.x + r.x - x, s->slice.y + r.y - y,
2261 r.width, r.height, r.x, r.y);
2263 /* When the image has a mask, we can expect that at
2264 least part of a mouse highlight or a block cursor will
2265 be visible. If the image doesn't have a mask, make
2266 a block cursor visible by drawing a rectangle around
2267 the image. I believe it's looking better if we do
2268 nothing here for mouse-face. */
2269 if (s->hl == DRAW_CURSOR)
2271 int r = s->img->relief;
2272 if (r < 0) r = -r;
2273 XDrawRectangle (s->display, s->window, s->gc,
2274 x - r, y - r,
2275 s->slice.width + r*2 - 1,
2276 s->slice.height + r*2 - 1);
2280 else
2281 /* Draw a rectangle if image could not be loaded. */
2282 XDrawRectangle (s->display, s->window, s->gc, x, y,
2283 s->slice.width - 1, s->slice.height - 1);
2287 /* Draw a relief around the image glyph string S. */
2289 static void
2290 x_draw_image_relief (s)
2291 struct glyph_string *s;
2293 int x0, y0, x1, y1, thick, raised_p;
2294 XRectangle r;
2295 int x = s->x;
2296 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2298 /* If first glyph of S has a left box line, start drawing it to the
2299 right of that line. */
2300 if (s->face->box != FACE_NO_BOX
2301 && s->first_glyph->left_box_line_p
2302 && s->slice.x == 0)
2303 x += eabs (s->face->box_line_width);
2305 /* If there is a margin around the image, adjust x- and y-position
2306 by that margin. */
2307 if (s->slice.x == 0)
2308 x += s->img->hmargin;
2309 if (s->slice.y == 0)
2310 y += s->img->vmargin;
2312 if (s->hl == DRAW_IMAGE_SUNKEN
2313 || s->hl == DRAW_IMAGE_RAISED)
2315 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2316 raised_p = s->hl == DRAW_IMAGE_RAISED;
2318 else
2320 thick = eabs (s->img->relief);
2321 raised_p = s->img->relief > 0;
2324 x0 = x - thick;
2325 y0 = y - thick;
2326 x1 = x + s->slice.width + thick - 1;
2327 y1 = y + s->slice.height + thick - 1;
2329 x_setup_relief_colors (s);
2330 get_glyph_string_clip_rect (s, &r);
2331 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2332 s->slice.y == 0,
2333 s->slice.y + s->slice.height == s->img->height,
2334 s->slice.x == 0,
2335 s->slice.x + s->slice.width == s->img->width,
2336 &r);
2340 /* Draw the foreground of image glyph string S to PIXMAP. */
2342 static void
2343 x_draw_image_foreground_1 (s, pixmap)
2344 struct glyph_string *s;
2345 Pixmap pixmap;
2347 int x = 0;
2348 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2350 /* If first glyph of S has a left box line, start drawing it to the
2351 right of that line. */
2352 if (s->face->box != FACE_NO_BOX
2353 && s->first_glyph->left_box_line_p
2354 && s->slice.x == 0)
2355 x += eabs (s->face->box_line_width);
2357 /* If there is a margin around the image, adjust x- and y-position
2358 by that margin. */
2359 if (s->slice.x == 0)
2360 x += s->img->hmargin;
2361 if (s->slice.y == 0)
2362 y += s->img->vmargin;
2364 if (s->img->pixmap)
2366 if (s->img->mask)
2368 /* We can't set both a clip mask and use XSetClipRectangles
2369 because the latter also sets a clip mask. We also can't
2370 trust on the shape extension to be available
2371 (XShapeCombineRegion). So, compute the rectangle to draw
2372 manually. */
2373 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2374 | GCFunction);
2375 XGCValues xgcv;
2377 xgcv.clip_mask = s->img->mask;
2378 xgcv.clip_x_origin = x - s->slice.x;
2379 xgcv.clip_y_origin = y - s->slice.y;
2380 xgcv.function = GXcopy;
2381 XChangeGC (s->display, s->gc, mask, &xgcv);
2383 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2384 s->slice.x, s->slice.y,
2385 s->slice.width, s->slice.height, x, y);
2386 XSetClipMask (s->display, s->gc, None);
2388 else
2390 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2391 s->slice.x, s->slice.y,
2392 s->slice.width, s->slice.height, x, y);
2394 /* When the image has a mask, we can expect that at
2395 least part of a mouse highlight or a block cursor will
2396 be visible. If the image doesn't have a mask, make
2397 a block cursor visible by drawing a rectangle around
2398 the image. I believe it's looking better if we do
2399 nothing here for mouse-face. */
2400 if (s->hl == DRAW_CURSOR)
2402 int r = s->img->relief;
2403 if (r < 0) r = -r;
2404 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2405 s->slice.width + r*2 - 1,
2406 s->slice.height + r*2 - 1);
2410 else
2411 /* Draw a rectangle if image could not be loaded. */
2412 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2413 s->slice.width - 1, s->slice.height - 1);
2417 /* Draw part of the background of glyph string S. X, Y, W, and H
2418 give the rectangle to draw. */
2420 static void
2421 x_draw_glyph_string_bg_rect (s, x, y, w, h)
2422 struct glyph_string *s;
2423 int x, y, w, h;
2425 if (s->stippled_p)
2427 /* Fill background with a stipple pattern. */
2428 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2429 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2430 XSetFillStyle (s->display, s->gc, FillSolid);
2432 else
2433 x_clear_glyph_string_rect (s, x, y, w, h);
2437 /* Draw image glyph string S.
2439 s->y
2440 s->x +-------------------------
2441 | s->face->box
2443 | +-------------------------
2444 | | s->img->margin
2446 | | +-------------------
2447 | | | the image
2451 static void
2452 x_draw_image_glyph_string (s)
2453 struct glyph_string *s;
2455 int box_line_hwidth = eabs (s->face->box_line_width);
2456 int box_line_vwidth = max (s->face->box_line_width, 0);
2457 int height;
2458 Pixmap pixmap = None;
2460 height = s->height;
2461 if (s->slice.y == 0)
2462 height -= box_line_vwidth;
2463 if (s->slice.y + s->slice.height >= s->img->height)
2464 height -= box_line_vwidth;
2466 /* Fill background with face under the image. Do it only if row is
2467 taller than image or if image has a clip mask to reduce
2468 flickering. */
2469 s->stippled_p = s->face->stipple != 0;
2470 if (height > s->slice.height
2471 || s->img->hmargin
2472 || s->img->vmargin
2473 || s->img->mask
2474 || s->img->pixmap == 0
2475 || s->width != s->background_width)
2477 if (s->img->mask)
2479 /* Create a pixmap as large as the glyph string. Fill it
2480 with the background color. Copy the image to it, using
2481 its mask. Copy the temporary pixmap to the display. */
2482 Screen *screen = FRAME_X_SCREEN (s->f);
2483 int depth = DefaultDepthOfScreen (screen);
2485 /* Create a pixmap as large as the glyph string. */
2486 pixmap = XCreatePixmap (s->display, s->window,
2487 s->background_width,
2488 s->height, depth);
2490 /* Don't clip in the following because we're working on the
2491 pixmap. */
2492 XSetClipMask (s->display, s->gc, None);
2494 /* Fill the pixmap with the background color/stipple. */
2495 if (s->stippled_p)
2497 /* Fill background with a stipple pattern. */
2498 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2499 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2500 XFillRectangle (s->display, pixmap, s->gc,
2501 0, 0, s->background_width, s->height);
2502 XSetFillStyle (s->display, s->gc, FillSolid);
2503 XSetTSOrigin (s->display, s->gc, 0, 0);
2505 else
2507 XGCValues xgcv;
2508 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2509 &xgcv);
2510 XSetForeground (s->display, s->gc, xgcv.background);
2511 XFillRectangle (s->display, pixmap, s->gc,
2512 0, 0, s->background_width, s->height);
2513 XSetForeground (s->display, s->gc, xgcv.foreground);
2516 else
2518 int x = s->x;
2519 int y = s->y;
2521 if (s->first_glyph->left_box_line_p
2522 && s->slice.x == 0)
2523 x += box_line_hwidth;
2525 if (s->slice.y == 0)
2526 y += box_line_vwidth;
2528 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2531 s->background_filled_p = 1;
2534 /* Draw the foreground. */
2535 if (pixmap != None)
2537 x_draw_image_foreground_1 (s, pixmap);
2538 x_set_glyph_string_clipping (s);
2539 XCopyArea (s->display, pixmap, s->window, s->gc,
2540 0, 0, s->background_width, s->height, s->x, s->y);
2541 XFreePixmap (s->display, pixmap);
2543 else
2544 x_draw_image_foreground (s);
2546 /* If we must draw a relief around the image, do it. */
2547 if (s->img->relief
2548 || s->hl == DRAW_IMAGE_RAISED
2549 || s->hl == DRAW_IMAGE_SUNKEN)
2550 x_draw_image_relief (s);
2554 /* Draw stretch glyph string S. */
2556 static void
2557 x_draw_stretch_glyph_string (s)
2558 struct glyph_string *s;
2560 xassert (s->first_glyph->type == STRETCH_GLYPH);
2562 if (s->hl == DRAW_CURSOR
2563 && !x_stretch_cursor_p)
2565 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2566 as wide as the stretch glyph. */
2567 int width, background_width = s->background_width;
2568 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2570 if (x < left_x)
2572 background_width -= left_x - x;
2573 x = left_x;
2575 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2577 /* Draw cursor. */
2578 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2580 /* Clear rest using the GC of the original non-cursor face. */
2581 if (width < background_width)
2583 int y = s->y;
2584 int w = background_width - width, h = s->height;
2585 XRectangle r;
2586 GC gc;
2588 x += width;
2589 if (s->row->mouse_face_p
2590 && cursor_in_mouse_face_p (s->w))
2592 x_set_mouse_face_gc (s);
2593 gc = s->gc;
2595 else
2596 gc = s->face->gc;
2598 get_glyph_string_clip_rect (s, &r);
2599 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2601 if (s->face->stipple)
2603 /* Fill background with a stipple pattern. */
2604 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2605 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2606 XSetFillStyle (s->display, gc, FillSolid);
2608 else
2610 XGCValues xgcv;
2611 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2612 XSetForeground (s->display, gc, xgcv.background);
2613 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2614 XSetForeground (s->display, gc, xgcv.foreground);
2618 else if (!s->background_filled_p)
2620 int background_width = s->background_width;
2621 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2623 /* Don't draw into left margin, fringe or scrollbar area
2624 except for header line and mode line. */
2625 if (x < left_x && !s->row->mode_line_p)
2627 background_width -= left_x - x;
2628 x = left_x;
2630 if (background_width > 0)
2631 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2634 s->background_filled_p = 1;
2638 /* Draw glyph string S. */
2640 static void
2641 x_draw_glyph_string (s)
2642 struct glyph_string *s;
2644 int relief_drawn_p = 0;
2646 /* If S draws into the background of its successors, draw the
2647 background of the successors first so that S can draw into it.
2648 This makes S->next use XDrawString instead of XDrawImageString. */
2649 if (s->next && s->right_overhang && !s->for_overlaps)
2651 int width;
2652 struct glyph_string *next;
2654 for (width = 0, next = s->next; next;
2655 width += next->width, next = next->next)
2656 if (next->first_glyph->type != IMAGE_GLYPH)
2658 x_set_glyph_string_gc (next);
2659 x_set_glyph_string_clipping (next);
2660 x_draw_glyph_string_background (next, 1);
2661 next->num_clips = 0;
2665 /* Set up S->gc, set clipping and draw S. */
2666 x_set_glyph_string_gc (s);
2668 /* Draw relief (if any) in advance for char/composition so that the
2669 glyph string can be drawn over it. */
2670 if (!s->for_overlaps
2671 && s->face->box != FACE_NO_BOX
2672 && (s->first_glyph->type == CHAR_GLYPH
2673 || s->first_glyph->type == COMPOSITE_GLYPH))
2676 x_set_glyph_string_clipping (s);
2677 x_draw_glyph_string_background (s, 1);
2678 x_draw_glyph_string_box (s);
2679 x_set_glyph_string_clipping (s);
2680 relief_drawn_p = 1;
2682 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2683 && !s->clip_tail
2684 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2685 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2686 /* We must clip just this glyph. left_overhang part has already
2687 drawn when s->prev was drawn, and right_overhang part will be
2688 drawn later when s->next is drawn. */
2689 x_set_glyph_string_clipping_exactly (s, s);
2690 else
2691 x_set_glyph_string_clipping (s);
2693 switch (s->first_glyph->type)
2695 case IMAGE_GLYPH:
2696 x_draw_image_glyph_string (s);
2697 break;
2699 case STRETCH_GLYPH:
2700 x_draw_stretch_glyph_string (s);
2701 break;
2703 case CHAR_GLYPH:
2704 if (s->for_overlaps)
2705 s->background_filled_p = 1;
2706 else
2707 x_draw_glyph_string_background (s, 0);
2708 x_draw_glyph_string_foreground (s);
2709 break;
2711 case COMPOSITE_GLYPH:
2712 if (s->for_overlaps || (s->cmp_from > 0
2713 && ! s->first_glyph->u.cmp.automatic))
2714 s->background_filled_p = 1;
2715 else
2716 x_draw_glyph_string_background (s, 1);
2717 x_draw_composite_glyph_string_foreground (s);
2718 break;
2720 default:
2721 abort ();
2724 if (!s->for_overlaps)
2726 /* Draw underline. */
2727 if (s->face->underline_p)
2729 unsigned long thickness, position;
2730 int y;
2732 if (s->prev && s->prev->face->underline_p)
2734 /* We use the same underline style as the previous one. */
2735 thickness = s->prev->underline_thickness;
2736 position = s->prev->underline_position;
2738 else
2740 /* Get the underline thickness. Default is 1 pixel. */
2741 if (s->font && s->font->underline_thickness > 0)
2742 thickness = s->font->underline_thickness;
2743 else
2744 thickness = 1;
2745 if (x_underline_at_descent_line)
2746 position = (s->height - thickness) - (s->ybase - s->y);
2747 else
2749 /* Get the underline position. This is the recommended
2750 vertical offset in pixels from the baseline to the top of
2751 the underline. This is a signed value according to the
2752 specs, and its default is
2754 ROUND ((maximum descent) / 2), with
2755 ROUND(x) = floor (x + 0.5) */
2757 if (x_use_underline_position_properties
2758 && s->font && s->font->underline_position >= 0)
2759 position = s->font->underline_position;
2760 else if (s->font)
2761 position = (s->font->descent + 1) / 2;
2763 position = max (position, underline_minimum_offset);
2765 /* Check the sanity of thickness and position. We should
2766 avoid drawing underline out of the current line area. */
2767 if (s->y + s->height <= s->ybase + position)
2768 position = (s->height - 1) - (s->ybase - s->y);
2769 if (s->y + s->height < s->ybase + position + thickness)
2770 thickness = (s->y + s->height) - (s->ybase + position);
2771 s->underline_thickness = thickness;
2772 s->underline_position = position;
2773 y = s->ybase + position;
2774 if (s->face->underline_defaulted_p)
2775 XFillRectangle (s->display, s->window, s->gc,
2776 s->x, y, s->background_width, thickness);
2777 else
2779 XGCValues xgcv;
2780 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2781 XSetForeground (s->display, s->gc, s->face->underline_color);
2782 XFillRectangle (s->display, s->window, s->gc,
2783 s->x, y, s->background_width, thickness);
2784 XSetForeground (s->display, s->gc, xgcv.foreground);
2788 /* Draw overline. */
2789 if (s->face->overline_p)
2791 unsigned long dy = 0, h = 1;
2793 if (s->face->overline_color_defaulted_p)
2794 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2795 s->background_width, h);
2796 else
2798 XGCValues xgcv;
2799 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2800 XSetForeground (s->display, s->gc, s->face->overline_color);
2801 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2802 s->background_width, h);
2803 XSetForeground (s->display, s->gc, xgcv.foreground);
2807 /* Draw strike-through. */
2808 if (s->face->strike_through_p)
2810 unsigned long h = 1;
2811 unsigned long dy = (s->height - h) / 2;
2813 if (s->face->strike_through_color_defaulted_p)
2814 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2815 s->width, h);
2816 else
2818 XGCValues xgcv;
2819 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2820 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2821 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2822 s->width, h);
2823 XSetForeground (s->display, s->gc, xgcv.foreground);
2827 /* Draw relief if not yet drawn. */
2828 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2829 x_draw_glyph_string_box (s);
2831 if (s->prev)
2833 struct glyph_string *prev;
2835 for (prev = s->prev; prev; prev = prev->prev)
2836 if (prev->hl != s->hl
2837 && prev->x + prev->width + prev->right_overhang > s->x)
2839 /* As prev was drawn while clipped to its own area, we
2840 must draw the right_overhang part using s->hl now. */
2841 enum draw_glyphs_face save = prev->hl;
2843 prev->hl = s->hl;
2844 x_set_glyph_string_gc (prev);
2845 x_set_glyph_string_clipping_exactly (s, prev);
2846 if (prev->first_glyph->type == CHAR_GLYPH)
2847 x_draw_glyph_string_foreground (prev);
2848 else
2849 x_draw_composite_glyph_string_foreground (prev);
2850 XSetClipMask (prev->display, prev->gc, None);
2851 prev->hl = save;
2852 prev->num_clips = 0;
2856 if (s->next)
2858 struct glyph_string *next;
2860 for (next = s->next; next; next = next->next)
2861 if (next->hl != s->hl
2862 && next->x - next->left_overhang < s->x + s->width)
2864 /* As next will be drawn while clipped to its own area,
2865 we must draw the left_overhang part using s->hl now. */
2866 enum draw_glyphs_face save = next->hl;
2868 next->hl = s->hl;
2869 x_set_glyph_string_gc (next);
2870 x_set_glyph_string_clipping_exactly (s, next);
2871 if (next->first_glyph->type == CHAR_GLYPH)
2872 x_draw_glyph_string_foreground (next);
2873 else
2874 x_draw_composite_glyph_string_foreground (next);
2875 XSetClipMask (next->display, next->gc, None);
2876 next->hl = save;
2877 next->num_clips = 0;
2882 /* Reset clipping. */
2883 XSetClipMask (s->display, s->gc, None);
2884 s->num_clips = 0;
2887 /* Shift display to make room for inserted glyphs. */
2889 void
2890 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2891 struct frame *f;
2892 int x, y, width, height, shift_by;
2894 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2895 f->output_data.x->normal_gc,
2896 x, y, width, height,
2897 x + shift_by, y);
2900 /* Delete N glyphs at the nominal cursor position. Not implemented
2901 for X frames. */
2903 static void
2904 x_delete_glyphs (f, n)
2905 struct frame *f;
2906 register int n;
2908 abort ();
2912 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2913 If they are <= 0, this is probably an error. */
2915 void
2916 x_clear_area (dpy, window, x, y, width, height, exposures)
2917 Display *dpy;
2918 Window window;
2919 int x, y;
2920 int width, height;
2921 int exposures;
2923 xassert (width > 0 && height > 0);
2924 XClearArea (dpy, window, x, y, width, height, exposures);
2928 /* Clear an entire frame. */
2930 static void
2931 x_clear_frame (struct frame *f)
2933 /* Clearing the frame will erase any cursor, so mark them all as no
2934 longer visible. */
2935 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2936 output_cursor.hpos = output_cursor.vpos = 0;
2937 output_cursor.x = -1;
2939 /* We don't set the output cursor here because there will always
2940 follow an explicit cursor_to. */
2941 BLOCK_INPUT;
2942 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2944 /* We have to clear the scroll bars, too. If we have changed
2945 colors or something like that, then they should be notified. */
2946 x_scroll_bar_clear (f);
2948 XFlush (FRAME_X_DISPLAY (f));
2950 UNBLOCK_INPUT;
2955 /* Invert the middle quarter of the frame for .15 sec. */
2957 /* We use the select system call to do the waiting, so we have to make
2958 sure it's available. If it isn't, we just won't do visual bells. */
2960 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2963 /* Subtract the `struct timeval' values X and Y, storing the result in
2964 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2966 static int
2967 timeval_subtract (result, x, y)
2968 struct timeval *result, x, y;
2970 /* Perform the carry for the later subtraction by updating y. This
2971 is safer because on some systems the tv_sec member is unsigned. */
2972 if (x.tv_usec < y.tv_usec)
2974 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2975 y.tv_usec -= 1000000 * nsec;
2976 y.tv_sec += nsec;
2979 if (x.tv_usec - y.tv_usec > 1000000)
2981 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2982 y.tv_usec += 1000000 * nsec;
2983 y.tv_sec -= nsec;
2986 /* Compute the time remaining to wait. tv_usec is certainly
2987 positive. */
2988 result->tv_sec = x.tv_sec - y.tv_sec;
2989 result->tv_usec = x.tv_usec - y.tv_usec;
2991 /* Return indication of whether the result should be considered
2992 negative. */
2993 return x.tv_sec < y.tv_sec;
2996 void
2997 XTflash (f)
2998 struct frame *f;
3000 BLOCK_INPUT;
3003 GC gc;
3005 /* Create a GC that will use the GXxor function to flip foreground
3006 pixels into background pixels. */
3008 XGCValues values;
3010 values.function = GXxor;
3011 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3012 ^ FRAME_BACKGROUND_PIXEL (f));
3014 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3015 GCFunction | GCForeground, &values);
3019 /* Get the height not including a menu bar widget. */
3020 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3021 /* Height of each line to flash. */
3022 int flash_height = FRAME_LINE_HEIGHT (f);
3023 /* These will be the left and right margins of the rectangles. */
3024 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3025 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3027 int width;
3029 /* Don't flash the area between a scroll bar and the frame
3030 edge it is next to. */
3031 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3033 case vertical_scroll_bar_left:
3034 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3035 break;
3037 case vertical_scroll_bar_right:
3038 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3039 break;
3041 default:
3042 break;
3045 width = flash_right - flash_left;
3047 /* If window is tall, flash top and bottom line. */
3048 if (height > 3 * FRAME_LINE_HEIGHT (f))
3050 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3051 flash_left,
3052 (FRAME_INTERNAL_BORDER_WIDTH (f)
3053 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3054 width, flash_height);
3055 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3056 flash_left,
3057 (height - flash_height
3058 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3059 width, flash_height);
3061 else
3062 /* If it is short, flash it all. */
3063 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3064 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3065 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3067 x_flush (f);
3070 struct timeval wakeup;
3072 EMACS_GET_TIME (wakeup);
3074 /* Compute time to wait until, propagating carry from usecs. */
3075 wakeup.tv_usec += 150000;
3076 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3077 wakeup.tv_usec %= 1000000;
3079 /* Keep waiting until past the time wakeup or any input gets
3080 available. */
3081 while (! detect_input_pending ())
3083 struct timeval current;
3084 struct timeval timeout;
3086 EMACS_GET_TIME (current);
3088 /* Break if result would be negative. */
3089 if (timeval_subtract (&current, wakeup, current))
3090 break;
3092 /* How long `select' should wait. */
3093 timeout.tv_sec = 0;
3094 timeout.tv_usec = 10000;
3096 /* Try to wait that long--but we might wake up sooner. */
3097 select (0, NULL, NULL, NULL, &timeout);
3101 /* If window is tall, flash top and bottom line. */
3102 if (height > 3 * FRAME_LINE_HEIGHT (f))
3104 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3105 flash_left,
3106 (FRAME_INTERNAL_BORDER_WIDTH (f)
3107 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3108 width, flash_height);
3109 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3110 flash_left,
3111 (height - flash_height
3112 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3113 width, flash_height);
3115 else
3116 /* If it is short, flash it all. */
3117 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3118 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3119 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3121 XFreeGC (FRAME_X_DISPLAY (f), gc);
3122 x_flush (f);
3126 UNBLOCK_INPUT;
3129 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3132 /* Make audible bell. */
3134 void
3135 XTring_bell ()
3137 struct frame *f = SELECTED_FRAME ();
3139 if (FRAME_X_DISPLAY (f))
3141 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3142 if (visible_bell)
3143 XTflash (f);
3144 else
3145 #endif
3147 BLOCK_INPUT;
3148 XBell (FRAME_X_DISPLAY (f), 0);
3149 XFlush (FRAME_X_DISPLAY (f));
3150 UNBLOCK_INPUT;
3156 /* Specify how many text lines, from the top of the window,
3157 should be affected by insert-lines and delete-lines operations.
3158 This, and those operations, are used only within an update
3159 that is bounded by calls to x_update_begin and x_update_end. */
3161 static void
3162 XTset_terminal_window (n)
3163 register int n;
3165 /* This function intentionally left blank. */
3170 /***********************************************************************
3171 Line Dance
3172 ***********************************************************************/
3174 /* Perform an insert-lines or delete-lines operation, inserting N
3175 lines or deleting -N lines at vertical position VPOS. */
3177 static void
3178 x_ins_del_lines (f, vpos, n)
3179 struct frame *f;
3180 int vpos, n;
3182 abort ();
3186 /* Scroll part of the display as described by RUN. */
3188 static void
3189 x_scroll_run (w, run)
3190 struct window *w;
3191 struct run *run;
3193 struct frame *f = XFRAME (w->frame);
3194 int x, y, width, height, from_y, to_y, bottom_y;
3196 /* Get frame-relative bounding box of the text display area of W,
3197 without mode lines. Include in this box the left and right
3198 fringe of W. */
3199 window_box (w, -1, &x, &y, &width, &height);
3201 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3202 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3203 bottom_y = y + height;
3205 if (to_y < from_y)
3207 /* Scrolling up. Make sure we don't copy part of the mode
3208 line at the bottom. */
3209 if (from_y + run->height > bottom_y)
3210 height = bottom_y - from_y;
3211 else
3212 height = run->height;
3214 else
3216 /* Scolling down. Make sure we don't copy over the mode line.
3217 at the bottom. */
3218 if (to_y + run->height > bottom_y)
3219 height = bottom_y - to_y;
3220 else
3221 height = run->height;
3224 BLOCK_INPUT;
3226 /* Cursor off. Will be switched on again in x_update_window_end. */
3227 updated_window = w;
3228 x_clear_cursor (w);
3230 XCopyArea (FRAME_X_DISPLAY (f),
3231 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3232 f->output_data.x->normal_gc,
3233 x, from_y,
3234 width, height,
3235 x, to_y);
3237 UNBLOCK_INPUT;
3242 /***********************************************************************
3243 Exposure Events
3244 ***********************************************************************/
3247 static void
3248 frame_highlight (f)
3249 struct frame *f;
3251 /* We used to only do this if Vx_no_window_manager was non-nil, but
3252 the ICCCM (section 4.1.6) says that the window's border pixmap
3253 and border pixel are window attributes which are "private to the
3254 client", so we can always change it to whatever we want. */
3255 BLOCK_INPUT;
3256 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3257 f->output_data.x->border_pixel);
3258 UNBLOCK_INPUT;
3259 x_update_cursor (f, 1);
3260 x_set_frame_alpha (f);
3263 static void
3264 frame_unhighlight (f)
3265 struct frame *f;
3267 /* We used to only do this if Vx_no_window_manager was non-nil, but
3268 the ICCCM (section 4.1.6) says that the window's border pixmap
3269 and border pixel are window attributes which are "private to the
3270 client", so we can always change it to whatever we want. */
3271 BLOCK_INPUT;
3272 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3273 f->output_data.x->border_tile);
3274 UNBLOCK_INPUT;
3275 x_update_cursor (f, 1);
3276 x_set_frame_alpha (f);
3279 /* The focus has changed. Update the frames as necessary to reflect
3280 the new situation. Note that we can't change the selected frame
3281 here, because the Lisp code we are interrupting might become confused.
3282 Each event gets marked with the frame in which it occurred, so the
3283 Lisp code can tell when the switch took place by examining the events. */
3285 static void
3286 x_new_focus_frame (dpyinfo, frame)
3287 struct x_display_info *dpyinfo;
3288 struct frame *frame;
3290 struct frame *old_focus = dpyinfo->x_focus_frame;
3292 if (frame != dpyinfo->x_focus_frame)
3294 /* Set this before calling other routines, so that they see
3295 the correct value of x_focus_frame. */
3296 dpyinfo->x_focus_frame = frame;
3298 if (old_focus && old_focus->auto_lower)
3299 x_lower_frame (old_focus);
3301 #if 0
3302 selected_frame = frame;
3303 XSETFRAME (XWINDOW (selected_frame->selected_window)->frame,
3304 selected_frame);
3305 Fselect_window (selected_frame->selected_window, Qnil);
3306 choose_minibuf_frame ();
3307 #endif /* ! 0 */
3309 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3310 pending_autoraise_frame = dpyinfo->x_focus_frame;
3311 else
3312 pending_autoraise_frame = 0;
3315 x_frame_rehighlight (dpyinfo);
3318 /* Handle FocusIn and FocusOut state changes for FRAME.
3319 If FRAME has focus and there exists more than one frame, puts
3320 a FOCUS_IN_EVENT into *BUFP. */
3322 static void
3323 x_focus_changed (type, state, dpyinfo, frame, bufp)
3324 int type;
3325 int state;
3326 struct x_display_info *dpyinfo;
3327 struct frame *frame;
3328 struct input_event *bufp;
3330 if (type == FocusIn)
3332 if (dpyinfo->x_focus_event_frame != frame)
3334 x_new_focus_frame (dpyinfo, frame);
3335 dpyinfo->x_focus_event_frame = frame;
3337 /* Don't stop displaying the initial startup message
3338 for a switch-frame event we don't need. */
3339 if (NILP (Vterminal_frame)
3340 && CONSP (Vframe_list)
3341 && !NILP (XCDR (Vframe_list)))
3343 bufp->kind = FOCUS_IN_EVENT;
3344 XSETFRAME (bufp->frame_or_window, frame);
3348 frame->output_data.x->focus_state |= state;
3350 #ifdef HAVE_X_I18N
3351 if (FRAME_XIC (frame))
3352 XSetICFocus (FRAME_XIC (frame));
3353 #endif
3355 else if (type == FocusOut)
3357 frame->output_data.x->focus_state &= ~state;
3359 if (dpyinfo->x_focus_event_frame == frame)
3361 dpyinfo->x_focus_event_frame = 0;
3362 x_new_focus_frame (dpyinfo, 0);
3365 #ifdef HAVE_X_I18N
3366 if (FRAME_XIC (frame))
3367 XUnsetICFocus (FRAME_XIC (frame));
3368 #endif
3372 /* The focus may have changed. Figure out if it is a real focus change,
3373 by checking both FocusIn/Out and Enter/LeaveNotify events.
3375 Returns FOCUS_IN_EVENT event in *BUFP. */
3377 static void
3378 x_detect_focus_change (dpyinfo, event, bufp)
3379 struct x_display_info *dpyinfo;
3380 XEvent *event;
3381 struct input_event *bufp;
3383 struct frame *frame;
3385 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3386 if (! frame)
3387 return;
3389 switch (event->type)
3391 case EnterNotify:
3392 case LeaveNotify:
3394 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3395 int focus_state
3396 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3398 if (event->xcrossing.detail != NotifyInferior
3399 && event->xcrossing.focus
3400 && ! (focus_state & FOCUS_EXPLICIT))
3401 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3402 FOCUS_IMPLICIT,
3403 dpyinfo, frame, bufp);
3405 break;
3407 case FocusIn:
3408 case FocusOut:
3409 x_focus_changed (event->type,
3410 (event->xfocus.detail == NotifyPointer ?
3411 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3412 dpyinfo, frame, bufp);
3413 break;
3415 case ClientMessage:
3416 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3418 enum xembed_message msg = event->xclient.data.l[1];
3419 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3420 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3422 break;
3427 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3429 void
3430 x_mouse_leave (dpyinfo)
3431 struct x_display_info *dpyinfo;
3433 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3436 /* The focus has changed, or we have redirected a frame's focus to
3437 another frame (this happens when a frame uses a surrogate
3438 mini-buffer frame). Shift the highlight as appropriate.
3440 The FRAME argument doesn't necessarily have anything to do with which
3441 frame is being highlighted or un-highlighted; we only use it to find
3442 the appropriate X display info. */
3444 static void
3445 XTframe_rehighlight (frame)
3446 struct frame *frame;
3448 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3451 static void
3452 x_frame_rehighlight (dpyinfo)
3453 struct x_display_info *dpyinfo;
3455 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3457 if (dpyinfo->x_focus_frame)
3459 dpyinfo->x_highlight_frame
3460 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3461 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3462 : dpyinfo->x_focus_frame);
3463 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3465 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3466 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3469 else
3470 dpyinfo->x_highlight_frame = 0;
3472 if (dpyinfo->x_highlight_frame != old_highlight)
3474 if (old_highlight)
3475 frame_unhighlight (old_highlight);
3476 if (dpyinfo->x_highlight_frame)
3477 frame_highlight (dpyinfo->x_highlight_frame);
3483 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3485 /* Initialize mode_switch_bit and modifier_meaning. */
3486 static void
3487 x_find_modifier_meanings (dpyinfo)
3488 struct x_display_info *dpyinfo;
3490 int min_code, max_code;
3491 KeySym *syms;
3492 int syms_per_code;
3493 XModifierKeymap *mods;
3495 dpyinfo->meta_mod_mask = 0;
3496 dpyinfo->shift_lock_mask = 0;
3497 dpyinfo->alt_mod_mask = 0;
3498 dpyinfo->super_mod_mask = 0;
3499 dpyinfo->hyper_mod_mask = 0;
3501 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3503 syms = XGetKeyboardMapping (dpyinfo->display,
3504 min_code, max_code - min_code + 1,
3505 &syms_per_code);
3506 mods = XGetModifierMapping (dpyinfo->display);
3508 /* Scan the modifier table to see which modifier bits the Meta and
3509 Alt keysyms are on. */
3511 int row, col; /* The row and column in the modifier table. */
3512 int found_alt_or_meta;
3514 for (row = 3; row < 8; row++)
3516 found_alt_or_meta = 0;
3517 for (col = 0; col < mods->max_keypermod; col++)
3519 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3521 /* Zeroes are used for filler. Skip them. */
3522 if (code == 0)
3523 continue;
3525 /* Are any of this keycode's keysyms a meta key? */
3527 int code_col;
3529 for (code_col = 0; code_col < syms_per_code; code_col++)
3531 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3533 switch (sym)
3535 case XK_Meta_L:
3536 case XK_Meta_R:
3537 found_alt_or_meta = 1;
3538 dpyinfo->meta_mod_mask |= (1 << row);
3539 break;
3541 case XK_Alt_L:
3542 case XK_Alt_R:
3543 found_alt_or_meta = 1;
3544 dpyinfo->alt_mod_mask |= (1 << row);
3545 break;
3547 case XK_Hyper_L:
3548 case XK_Hyper_R:
3549 if (!found_alt_or_meta)
3550 dpyinfo->hyper_mod_mask |= (1 << row);
3551 code_col = syms_per_code;
3552 col = mods->max_keypermod;
3553 break;
3555 case XK_Super_L:
3556 case XK_Super_R:
3557 if (!found_alt_or_meta)
3558 dpyinfo->super_mod_mask |= (1 << row);
3559 code_col = syms_per_code;
3560 col = mods->max_keypermod;
3561 break;
3563 case XK_Shift_Lock:
3564 /* Ignore this if it's not on the lock modifier. */
3565 if (!found_alt_or_meta && ((1 << row) == LockMask))
3566 dpyinfo->shift_lock_mask = LockMask;
3567 code_col = syms_per_code;
3568 col = mods->max_keypermod;
3569 break;
3577 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3578 if (! dpyinfo->meta_mod_mask)
3580 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3581 dpyinfo->alt_mod_mask = 0;
3584 /* If some keys are both alt and meta,
3585 make them just meta, not alt. */
3586 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3588 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3591 XFree ((char *) syms);
3592 XFreeModifiermap (mods);
3595 /* Convert between the modifier bits X uses and the modifier bits
3596 Emacs uses. */
3598 unsigned int
3599 x_x_to_emacs_modifiers (dpyinfo, state)
3600 struct x_display_info *dpyinfo;
3601 unsigned int state;
3603 EMACS_UINT mod_meta = meta_modifier;
3604 EMACS_UINT mod_alt = alt_modifier;
3605 EMACS_UINT mod_hyper = hyper_modifier;
3606 EMACS_UINT mod_super = super_modifier;
3607 Lisp_Object tem;
3609 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3610 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3611 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3612 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3613 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3614 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3615 tem = Fget (Vx_super_keysym, Qmodifier_value);
3616 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3619 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3620 | ((state & ControlMask) ? ctrl_modifier : 0)
3621 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3622 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3623 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3624 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3627 static unsigned int
3628 x_emacs_to_x_modifiers (dpyinfo, state)
3629 struct x_display_info *dpyinfo;
3630 unsigned int state;
3632 EMACS_UINT mod_meta = meta_modifier;
3633 EMACS_UINT mod_alt = alt_modifier;
3634 EMACS_UINT mod_hyper = hyper_modifier;
3635 EMACS_UINT mod_super = super_modifier;
3637 Lisp_Object tem;
3639 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3640 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3641 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3642 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3643 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3644 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3645 tem = Fget (Vx_super_keysym, Qmodifier_value);
3646 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3649 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3650 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3651 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3652 | ((state & shift_modifier) ? ShiftMask : 0)
3653 | ((state & ctrl_modifier) ? ControlMask : 0)
3654 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3657 /* Convert a keysym to its name. */
3659 char *
3660 x_get_keysym_name (keysym)
3661 KeySym keysym;
3663 char *value;
3665 BLOCK_INPUT;
3666 value = XKeysymToString (keysym);
3667 UNBLOCK_INPUT;
3669 return value;
3674 /* Mouse clicks and mouse movement. Rah. */
3676 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3678 If the event is a button press, then note that we have grabbed
3679 the mouse. */
3681 static Lisp_Object
3682 construct_mouse_click (result, event, f)
3683 struct input_event *result;
3684 XButtonEvent *event;
3685 struct frame *f;
3687 /* Make the event type NO_EVENT; we'll change that when we decide
3688 otherwise. */
3689 result->kind = MOUSE_CLICK_EVENT;
3690 result->code = event->button - Button1;
3691 result->timestamp = event->time;
3692 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3693 event->state)
3694 | (event->type == ButtonRelease
3695 ? up_modifier
3696 : down_modifier));
3698 XSETINT (result->x, event->x);
3699 XSETINT (result->y, event->y);
3700 XSETFRAME (result->frame_or_window, f);
3701 result->arg = Qnil;
3702 return Qnil;
3706 /* Function to report a mouse movement to the mainstream Emacs code.
3707 The input handler calls this.
3709 We have received a mouse movement event, which is given in *event.
3710 If the mouse is over a different glyph than it was last time, tell
3711 the mainstream emacs code by setting mouse_moved. If not, ask for
3712 another motion event, so we can check again the next time it moves. */
3714 static XMotionEvent last_mouse_motion_event;
3715 static Lisp_Object last_mouse_motion_frame;
3717 static int
3718 note_mouse_movement (frame, event)
3719 FRAME_PTR frame;
3720 XMotionEvent *event;
3722 last_mouse_movement_time = event->time;
3723 last_mouse_motion_event = *event;
3724 XSETFRAME (last_mouse_motion_frame, frame);
3726 if (!FRAME_X_OUTPUT (frame))
3727 return 0;
3729 if (event->window != FRAME_X_WINDOW (frame))
3731 frame->mouse_moved = 1;
3732 last_mouse_scroll_bar = Qnil;
3733 note_mouse_highlight (frame, -1, -1);
3734 last_mouse_glyph_frame = 0;
3735 return 1;
3739 /* Has the mouse moved off the glyph it was on at the last sighting? */
3740 if (frame != last_mouse_glyph_frame
3741 || event->x < last_mouse_glyph.x
3742 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3743 || event->y < last_mouse_glyph.y
3744 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3746 frame->mouse_moved = 1;
3747 last_mouse_scroll_bar = Qnil;
3748 note_mouse_highlight (frame, event->x, event->y);
3749 /* Remember which glyph we're now on. */
3750 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3751 last_mouse_glyph_frame = frame;
3752 return 1;
3755 return 0;
3759 /************************************************************************
3760 Mouse Face
3761 ************************************************************************/
3763 static void
3764 redo_mouse_highlight ()
3766 if (!NILP (last_mouse_motion_frame)
3767 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3768 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3769 last_mouse_motion_event.x,
3770 last_mouse_motion_event.y);
3775 /* Return the current position of the mouse.
3776 *FP should be a frame which indicates which display to ask about.
3778 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3779 and *PART to the frame, window, and scroll bar part that the mouse
3780 is over. Set *X and *Y to the portion and whole of the mouse's
3781 position on the scroll bar.
3783 If the mouse movement started elsewhere, set *FP to the frame the
3784 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3785 the mouse is over.
3787 Set *TIME to the server time-stamp for the time at which the mouse
3788 was at this position.
3790 Don't store anything if we don't have a valid set of values to report.
3792 This clears the mouse_moved flag, so we can wait for the next mouse
3793 movement. */
3795 static void
3796 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3797 FRAME_PTR *fp;
3798 int insist;
3799 Lisp_Object *bar_window;
3800 enum scroll_bar_part *part;
3801 Lisp_Object *x, *y;
3802 unsigned long *time;
3804 FRAME_PTR f1;
3806 BLOCK_INPUT;
3808 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3809 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3810 else
3812 Window root;
3813 int root_x, root_y;
3815 Window dummy_window;
3816 int dummy;
3818 Lisp_Object frame, tail;
3820 /* Clear the mouse-moved flag for every frame on this display. */
3821 FOR_EACH_FRAME (tail, frame)
3822 if (FRAME_X_P (XFRAME (frame))
3823 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3824 XFRAME (frame)->mouse_moved = 0;
3826 last_mouse_scroll_bar = Qnil;
3828 /* Figure out which root window we're on. */
3829 XQueryPointer (FRAME_X_DISPLAY (*fp),
3830 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3832 /* The root window which contains the pointer. */
3833 &root,
3835 /* Trash which we can't trust if the pointer is on
3836 a different screen. */
3837 &dummy_window,
3839 /* The position on that root window. */
3840 &root_x, &root_y,
3842 /* More trash we can't trust. */
3843 &dummy, &dummy,
3845 /* Modifier keys and pointer buttons, about which
3846 we don't care. */
3847 (unsigned int *) &dummy);
3849 /* Now we have a position on the root; find the innermost window
3850 containing the pointer. */
3852 Window win, child;
3853 int win_x, win_y;
3854 int parent_x = 0, parent_y = 0;
3856 win = root;
3858 /* XTranslateCoordinates can get errors if the window
3859 structure is changing at the same time this function
3860 is running. So at least we must not crash from them. */
3862 x_catch_errors (FRAME_X_DISPLAY (*fp));
3864 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3865 && FRAME_LIVE_P (last_mouse_frame))
3867 /* If mouse was grabbed on a frame, give coords for that frame
3868 even if the mouse is now outside it. */
3869 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3871 /* From-window, to-window. */
3872 root, FRAME_X_WINDOW (last_mouse_frame),
3874 /* From-position, to-position. */
3875 root_x, root_y, &win_x, &win_y,
3877 /* Child of win. */
3878 &child);
3879 f1 = last_mouse_frame;
3881 else
3883 while (1)
3885 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3887 /* From-window, to-window. */
3888 root, win,
3890 /* From-position, to-position. */
3891 root_x, root_y, &win_x, &win_y,
3893 /* Child of win. */
3894 &child);
3896 if (child == None || child == win)
3897 break;
3899 win = child;
3900 parent_x = win_x;
3901 parent_y = win_y;
3904 /* Now we know that:
3905 win is the innermost window containing the pointer
3906 (XTC says it has no child containing the pointer),
3907 win_x and win_y are the pointer's position in it
3908 (XTC did this the last time through), and
3909 parent_x and parent_y are the pointer's position in win's parent.
3910 (They are what win_x and win_y were when win was child.
3911 If win is the root window, it has no parent, and
3912 parent_{x,y} are invalid, but that's okay, because we'll
3913 never use them in that case.) */
3915 /* Is win one of our frames? */
3916 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3918 #ifdef USE_X_TOOLKIT
3919 /* If we end up with the menu bar window, say it's not
3920 on the frame. */
3921 if (f1 != NULL
3922 && f1->output_data.x->menubar_widget
3923 && win == XtWindow (f1->output_data.x->menubar_widget))
3924 f1 = NULL;
3925 #endif /* USE_X_TOOLKIT */
3928 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3929 f1 = 0;
3931 x_uncatch_errors ();
3933 /* If not, is it one of our scroll bars? */
3934 if (! f1)
3936 struct scroll_bar *bar;
3938 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3940 if (bar)
3942 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3943 win_x = parent_x;
3944 win_y = parent_y;
3948 if (f1 == 0 && insist > 0)
3949 f1 = SELECTED_FRAME ();
3951 if (f1)
3953 /* Ok, we found a frame. Store all the values.
3954 last_mouse_glyph is a rectangle used to reduce the
3955 generation of mouse events. To not miss any motion
3956 events, we must divide the frame into rectangles of the
3957 size of the smallest character that could be displayed
3958 on it, i.e. into the same rectangles that matrices on
3959 the frame are divided into. */
3961 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3962 last_mouse_glyph_frame = f1;
3964 *bar_window = Qnil;
3965 *part = 0;
3966 *fp = f1;
3967 XSETINT (*x, win_x);
3968 XSETINT (*y, win_y);
3969 *time = last_mouse_movement_time;
3974 UNBLOCK_INPUT;
3979 /***********************************************************************
3980 Scroll bars
3981 ***********************************************************************/
3983 /* Scroll bar support. */
3985 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
3986 manages it.
3987 This can be called in GC, so we have to make sure to strip off mark
3988 bits. */
3990 static struct scroll_bar *
3991 x_window_to_scroll_bar (display, window_id)
3992 Display *display;
3993 Window window_id;
3995 Lisp_Object tail;
3997 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3998 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
3999 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4001 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4003 Lisp_Object frame, bar, condemned;
4005 frame = XCAR (tail);
4006 /* All elements of Vframe_list should be frames. */
4007 if (! FRAMEP (frame))
4008 abort ();
4010 if (! FRAME_X_P (XFRAME (frame)))
4011 continue;
4013 /* Scan this frame's scroll bar list for a scroll bar with the
4014 right window ID. */
4015 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4016 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4017 /* This trick allows us to search both the ordinary and
4018 condemned scroll bar lists with one loop. */
4019 ! NILP (bar) || (bar = condemned,
4020 condemned = Qnil,
4021 ! NILP (bar));
4022 bar = XSCROLL_BAR (bar)->next)
4023 if (XSCROLL_BAR (bar)->x_window == window_id &&
4024 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4025 return XSCROLL_BAR (bar);
4028 return 0;
4032 #if defined USE_LUCID
4034 /* Return the Lucid menu bar WINDOW is part of. Return null
4035 if WINDOW is not part of a menu bar. */
4037 static Widget
4038 x_window_to_menu_bar (window)
4039 Window window;
4041 Lisp_Object tail;
4043 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4045 if (FRAME_X_P (XFRAME (XCAR (tail))))
4047 Lisp_Object frame = XCAR (tail);
4048 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4050 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4051 return menu_bar;
4055 return NULL;
4058 #endif /* USE_LUCID */
4061 /************************************************************************
4062 Toolkit scroll bars
4063 ************************************************************************/
4065 #ifdef USE_TOOLKIT_SCROLL_BARS
4067 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
4068 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
4069 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
4070 struct scroll_bar *));
4071 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
4072 int, int, int));
4075 /* Lisp window being scrolled. Set when starting to interact with
4076 a toolkit scroll bar, reset to nil when ending the interaction. */
4078 static Lisp_Object window_being_scrolled;
4080 /* Last scroll bar part sent in xm_scroll_callback. */
4082 static int last_scroll_bar_part;
4084 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4085 that movements of 1/20 of the screen size are mapped to up/down. */
4087 #ifndef USE_GTK
4088 /* Id of action hook installed for scroll bars. */
4090 static XtActionHookId action_hook_id;
4092 static Boolean xaw3d_arrow_scroll;
4094 /* Whether the drag scrolling maintains the mouse at the top of the
4095 thumb. If not, resizing the thumb needs to be done more carefully
4096 to avoid jerkyness. */
4098 static Boolean xaw3d_pick_top;
4100 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4101 bars are used.. The hook is responsible for detecting when
4102 the user ends an interaction with the scroll bar, and generates
4103 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4105 static void
4106 xt_action_hook (widget, client_data, action_name, event, params,
4107 num_params)
4108 Widget widget;
4109 XtPointer client_data;
4110 String action_name;
4111 XEvent *event;
4112 String *params;
4113 Cardinal *num_params;
4115 int scroll_bar_p;
4116 char *end_action;
4118 #ifdef USE_MOTIF
4119 scroll_bar_p = XmIsScrollBar (widget);
4120 end_action = "Release";
4121 #else /* !USE_MOTIF i.e. use Xaw */
4122 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4123 end_action = "EndScroll";
4124 #endif /* USE_MOTIF */
4126 if (scroll_bar_p
4127 && strcmp (action_name, end_action) == 0
4128 && WINDOWP (window_being_scrolled))
4130 struct window *w;
4132 x_send_scroll_bar_event (window_being_scrolled,
4133 scroll_bar_end_scroll, 0, 0);
4134 w = XWINDOW (window_being_scrolled);
4136 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4138 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4139 /* The thumb size is incorrect while dragging: fix it. */
4140 set_vertical_scroll_bar (w);
4142 window_being_scrolled = Qnil;
4143 last_scroll_bar_part = -1;
4145 /* Xt timeouts no longer needed. */
4146 toolkit_scroll_bar_interaction = 0;
4149 #endif /* not USE_GTK */
4151 /* A vector of windows used for communication between
4152 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4154 static struct window **scroll_bar_windows;
4155 static int scroll_bar_windows_size;
4158 /* Send a client message with message type Xatom_Scrollbar for a
4159 scroll action to the frame of WINDOW. PART is a value identifying
4160 the part of the scroll bar that was clicked on. PORTION is the
4161 amount to scroll of a whole of WHOLE. */
4163 static void
4164 x_send_scroll_bar_event (window, part, portion, whole)
4165 Lisp_Object window;
4166 int part, portion, whole;
4168 XEvent event;
4169 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4170 struct window *w = XWINDOW (window);
4171 struct frame *f = XFRAME (w->frame);
4172 int i;
4174 BLOCK_INPUT;
4176 /* Construct a ClientMessage event to send to the frame. */
4177 ev->type = ClientMessage;
4178 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4179 ev->display = FRAME_X_DISPLAY (f);
4180 ev->window = FRAME_X_WINDOW (f);
4181 ev->format = 32;
4183 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4184 not enough to store a pointer or Lisp_Object on a 64 bit system.
4185 So, store the window in scroll_bar_windows and pass the index
4186 into that array in the event. */
4187 for (i = 0; i < scroll_bar_windows_size; ++i)
4188 if (scroll_bar_windows[i] == NULL)
4189 break;
4191 if (i == scroll_bar_windows_size)
4193 int new_size = max (10, 2 * scroll_bar_windows_size);
4194 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4195 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4197 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4198 nbytes);
4199 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4200 scroll_bar_windows_size = new_size;
4203 scroll_bar_windows[i] = w;
4204 ev->data.l[0] = (long) i;
4205 ev->data.l[1] = (long) part;
4206 ev->data.l[2] = (long) 0;
4207 ev->data.l[3] = (long) portion;
4208 ev->data.l[4] = (long) whole;
4210 /* Make Xt timeouts work while the scroll bar is active. */
4211 toolkit_scroll_bar_interaction = 1;
4212 #ifdef USE_X_TOOLKIT
4213 x_activate_timeout_atimer ();
4214 #endif
4216 /* Setting the event mask to zero means that the message will
4217 be sent to the client that created the window, and if that
4218 window no longer exists, no event will be sent. */
4219 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4220 UNBLOCK_INPUT;
4224 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4225 in *IEVENT. */
4227 static void
4228 x_scroll_bar_to_input_event (event, ievent)
4229 XEvent *event;
4230 struct input_event *ievent;
4232 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4233 Lisp_Object window;
4234 struct frame *f;
4235 struct window *w;
4237 w = scroll_bar_windows[ev->data.l[0]];
4238 scroll_bar_windows[ev->data.l[0]] = NULL;
4240 XSETWINDOW (window, w);
4241 f = XFRAME (w->frame);
4243 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4244 ievent->frame_or_window = window;
4245 ievent->arg = Qnil;
4246 #ifdef USE_GTK
4247 ievent->timestamp = CurrentTime;
4248 #else
4249 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4250 #endif
4251 ievent->part = ev->data.l[1];
4252 ievent->code = ev->data.l[2];
4253 ievent->x = make_number ((int) ev->data.l[3]);
4254 ievent->y = make_number ((int) ev->data.l[4]);
4255 ievent->modifiers = 0;
4259 #ifdef USE_MOTIF
4261 /* Minimum and maximum values used for Motif scroll bars. */
4263 #define XM_SB_MAX 10000000
4266 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4267 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4268 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4270 static void
4271 xm_scroll_callback (widget, client_data, call_data)
4272 Widget widget;
4273 XtPointer client_data, call_data;
4275 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4276 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4277 int part = -1, whole = 0, portion = 0;
4279 switch (cs->reason)
4281 case XmCR_DECREMENT:
4282 bar->dragging = Qnil;
4283 part = scroll_bar_up_arrow;
4284 break;
4286 case XmCR_INCREMENT:
4287 bar->dragging = Qnil;
4288 part = scroll_bar_down_arrow;
4289 break;
4291 case XmCR_PAGE_DECREMENT:
4292 bar->dragging = Qnil;
4293 part = scroll_bar_above_handle;
4294 break;
4296 case XmCR_PAGE_INCREMENT:
4297 bar->dragging = Qnil;
4298 part = scroll_bar_below_handle;
4299 break;
4301 case XmCR_TO_TOP:
4302 bar->dragging = Qnil;
4303 part = scroll_bar_to_top;
4304 break;
4306 case XmCR_TO_BOTTOM:
4307 bar->dragging = Qnil;
4308 part = scroll_bar_to_bottom;
4309 break;
4311 case XmCR_DRAG:
4313 int slider_size;
4315 /* Get the slider size. */
4316 BLOCK_INPUT;
4317 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4318 UNBLOCK_INPUT;
4320 whole = XM_SB_MAX - slider_size;
4321 portion = min (cs->value, whole);
4322 part = scroll_bar_handle;
4323 bar->dragging = make_number (cs->value);
4325 break;
4327 case XmCR_VALUE_CHANGED:
4328 break;
4331 if (part >= 0)
4333 window_being_scrolled = bar->window;
4334 last_scroll_bar_part = part;
4335 x_send_scroll_bar_event (bar->window, part, portion, whole);
4339 #elif defined USE_GTK
4341 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4342 bar widget. DATA is a pointer to the scroll_bar structure. */
4344 static void
4345 xg_scroll_callback (widget, data)
4346 GtkRange *widget;
4347 gpointer data;
4349 struct scroll_bar *bar = (struct scroll_bar *) data;
4350 gdouble previous;
4351 gdouble position;
4352 gdouble *p;
4353 int diff;
4355 int part = -1, whole = 0, portion = 0;
4356 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (widget));
4358 position = gtk_adjustment_get_value (adj);
4360 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
4361 if (! p)
4363 p = (gdouble*) xmalloc (sizeof (gdouble));
4364 *p = XG_SB_MIN;
4365 g_object_set_data (G_OBJECT (widget), XG_LAST_SB_DATA, p);
4368 previous = *p;
4369 *p = position;
4371 if (xg_ignore_gtk_scrollbar) return;
4373 diff = (int) (position - previous);
4375 if (diff == (int) adj->step_increment)
4377 part = scroll_bar_down_arrow;
4378 bar->dragging = Qnil;
4380 else if (-diff == (int) adj->step_increment)
4382 part = scroll_bar_up_arrow;
4383 bar->dragging = Qnil;
4385 else if (diff == (int) adj->page_increment)
4387 part = scroll_bar_below_handle;
4388 bar->dragging = Qnil;
4390 else if (-diff == (int) adj->page_increment)
4392 part = scroll_bar_above_handle;
4393 bar->dragging = Qnil;
4395 else
4397 part = scroll_bar_handle;
4398 whole = adj->upper - adj->page_size;
4399 portion = min ((int)position, whole);
4400 bar->dragging = make_number ((int)portion);
4403 if (part >= 0)
4405 window_being_scrolled = bar->window;
4406 last_scroll_bar_part = part;
4407 x_send_scroll_bar_event (bar->window, part, portion, whole);
4411 #else /* not USE_GTK and not USE_MOTIF */
4413 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4414 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4415 scroll bar struct. CALL_DATA is a pointer to a float saying where
4416 the thumb is. */
4418 static void
4419 xaw_jump_callback (widget, client_data, call_data)
4420 Widget widget;
4421 XtPointer client_data, call_data;
4423 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4424 float top = *(float *) call_data;
4425 float shown;
4426 int whole, portion, height;
4427 int part;
4429 /* Get the size of the thumb, a value between 0 and 1. */
4430 BLOCK_INPUT;
4431 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4432 UNBLOCK_INPUT;
4434 whole = 10000000;
4435 portion = shown < 1 ? top * whole : 0;
4437 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4438 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4439 the bottom, so we force the scrolling whenever we see that we're
4440 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4441 we try to ensure that we always stay two pixels away from the
4442 bottom). */
4443 part = scroll_bar_down_arrow;
4444 else
4445 part = scroll_bar_handle;
4447 window_being_scrolled = bar->window;
4448 bar->dragging = make_number (portion);
4449 last_scroll_bar_part = part;
4450 x_send_scroll_bar_event (bar->window, part, portion, whole);
4454 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4455 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4456 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4457 the scroll bar. CALL_DATA is an integer specifying the action that
4458 has taken place. Its magnitude is in the range 0..height of the
4459 scroll bar. Negative values mean scroll towards buffer start.
4460 Values < height of scroll bar mean line-wise movement. */
4462 static void
4463 xaw_scroll_callback (widget, client_data, call_data)
4464 Widget widget;
4465 XtPointer client_data, call_data;
4467 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4468 /* The position really is stored cast to a pointer. */
4469 int position = (long) call_data;
4470 Dimension height;
4471 int part;
4473 /* Get the height of the scroll bar. */
4474 BLOCK_INPUT;
4475 XtVaGetValues (widget, XtNheight, &height, NULL);
4476 UNBLOCK_INPUT;
4478 if (eabs (position) >= height)
4479 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4481 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4482 it maps line-movement to call_data = max(5, height/20). */
4483 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4484 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4485 else
4486 part = scroll_bar_move_ratio;
4488 window_being_scrolled = bar->window;
4489 bar->dragging = Qnil;
4490 last_scroll_bar_part = part;
4491 x_send_scroll_bar_event (bar->window, part, position, height);
4494 #endif /* not USE_GTK and not USE_MOTIF */
4496 #define SCROLL_BAR_NAME "verticalScrollBar"
4498 /* Create the widget for scroll bar BAR on frame F. Record the widget
4499 and X window of the scroll bar in BAR. */
4501 #ifdef USE_GTK
4502 static void
4503 x_create_toolkit_scroll_bar (f, bar)
4504 struct frame *f;
4505 struct scroll_bar *bar;
4507 char *scroll_bar_name = SCROLL_BAR_NAME;
4509 BLOCK_INPUT;
4510 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4511 scroll_bar_name);
4512 UNBLOCK_INPUT;
4515 #else /* not USE_GTK */
4517 static void
4518 x_create_toolkit_scroll_bar (f, bar)
4519 struct frame *f;
4520 struct scroll_bar *bar;
4522 Window xwindow;
4523 Widget widget;
4524 Arg av[20];
4525 int ac = 0;
4526 char *scroll_bar_name = SCROLL_BAR_NAME;
4527 unsigned long pixel;
4529 BLOCK_INPUT;
4531 #ifdef USE_MOTIF
4532 /* Set resources. Create the widget. */
4533 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4534 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4535 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4536 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4537 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4538 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4539 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4541 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4542 if (pixel != -1)
4544 XtSetArg (av[ac], XmNforeground, pixel);
4545 ++ac;
4548 pixel = f->output_data.x->scroll_bar_background_pixel;
4549 if (pixel != -1)
4551 XtSetArg (av[ac], XmNbackground, pixel);
4552 ++ac;
4555 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4556 scroll_bar_name, av, ac);
4558 /* Add one callback for everything that can happen. */
4559 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4560 (XtPointer) bar);
4561 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4562 (XtPointer) bar);
4563 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4564 (XtPointer) bar);
4565 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4566 (XtPointer) bar);
4567 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4568 (XtPointer) bar);
4569 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4570 (XtPointer) bar);
4571 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4572 (XtPointer) bar);
4574 /* Realize the widget. Only after that is the X window created. */
4575 XtRealizeWidget (widget);
4577 /* Set the cursor to an arrow. I didn't find a resource to do that.
4578 And I'm wondering why it hasn't an arrow cursor by default. */
4579 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4580 f->output_data.x->nontext_cursor);
4582 #else /* !USE_MOTIF i.e. use Xaw */
4584 /* Set resources. Create the widget. The background of the
4585 Xaw3d scroll bar widget is a little bit light for my taste.
4586 We don't alter it here to let users change it according
4587 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4588 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4589 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4590 /* For smoother scrolling with Xaw3d -sm */
4591 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4593 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4594 if (pixel != -1)
4596 XtSetArg (av[ac], XtNforeground, pixel);
4597 ++ac;
4600 pixel = f->output_data.x->scroll_bar_background_pixel;
4601 if (pixel != -1)
4603 XtSetArg (av[ac], XtNbackground, pixel);
4604 ++ac;
4607 /* Top/bottom shadow colors. */
4609 /* Allocate them, if necessary. */
4610 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4612 pixel = f->output_data.x->scroll_bar_background_pixel;
4613 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4614 &pixel, 1.2, 0x8000))
4615 pixel = -1;
4616 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4618 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4620 pixel = f->output_data.x->scroll_bar_background_pixel;
4621 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4622 &pixel, 0.6, 0x4000))
4623 pixel = -1;
4624 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4627 #ifdef XtNbeNiceToColormap
4628 /* Tell the toolkit about them. */
4629 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4630 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4631 /* We tried to allocate a color for the top/bottom shadow, and
4632 failed, so tell Xaw3d to use dithering instead. */
4634 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4635 ++ac;
4637 else
4638 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4639 be more consistent with other emacs 3d colors, and since Xaw3d is
4640 not good at dealing with allocation failure. */
4642 /* This tells Xaw3d to use real colors instead of dithering for
4643 the shadows. */
4644 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4645 ++ac;
4647 /* Specify the colors. */
4648 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4649 if (pixel != -1)
4651 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4652 ++ac;
4654 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4655 if (pixel != -1)
4657 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4658 ++ac;
4661 #endif
4663 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4664 f->output_data.x->edit_widget, av, ac);
4667 char *initial = "";
4668 char *val = initial;
4669 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4670 #ifdef XtNarrowScrollbars
4671 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4672 #endif
4673 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4674 if (xaw3d_arrow_scroll || val == initial)
4675 { /* ARROW_SCROLL */
4676 xaw3d_arrow_scroll = True;
4677 /* Isn't that just a personal preference ? --Stef */
4678 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4682 /* Define callbacks. */
4683 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4684 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4685 (XtPointer) bar);
4687 /* Realize the widget. Only after that is the X window created. */
4688 XtRealizeWidget (widget);
4690 #endif /* !USE_MOTIF */
4692 /* Install an action hook that lets us detect when the user
4693 finishes interacting with a scroll bar. */
4694 if (action_hook_id == 0)
4695 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4697 /* Remember X window and widget in the scroll bar vector. */
4698 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4699 xwindow = XtWindow (widget);
4700 bar->x_window = xwindow;
4702 UNBLOCK_INPUT;
4704 #endif /* not USE_GTK */
4707 /* Set the thumb size and position of scroll bar BAR. We are currently
4708 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4710 #ifdef USE_GTK
4711 static void
4712 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4713 struct scroll_bar *bar;
4714 int portion, position, whole;
4716 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4719 #else /* not USE_GTK */
4720 static void
4721 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4722 struct scroll_bar *bar;
4723 int portion, position, whole;
4725 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4726 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4727 float top, shown;
4729 BLOCK_INPUT;
4731 #ifdef USE_MOTIF
4733 /* We use an estimate of 30 chars per line rather than the real
4734 `portion' value. This has the disadvantage that the thumb size
4735 is not very representative, but it makes our life a lot easier.
4736 Otherwise, we have to constantly adjust the thumb size, which
4737 we can't always do quickly enough: while dragging, the size of
4738 the thumb might prevent the user from dragging the thumb all the
4739 way to the end. but Motif and some versions of Xaw3d don't allow
4740 updating the thumb size while dragging. Also, even if we can update
4741 its size, the update will often happen too late.
4742 If you don't believe it, check out revision 1.650 of xterm.c to see
4743 what hoops we were going through and the still poor behavior we got. */
4744 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4745 /* When the thumb is at the bottom, position == whole.
4746 So we need to increase `whole' to make space for the thumb. */
4747 whole += portion;
4749 if (whole <= 0)
4750 top = 0, shown = 1;
4751 else
4753 top = (float) position / whole;
4754 shown = (float) portion / whole;
4757 if (NILP (bar->dragging))
4759 int size, value;
4761 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4762 is the scroll bar's maximum and MIN is the scroll bar's minimum
4763 value. */
4764 size = shown * XM_SB_MAX;
4765 size = min (size, XM_SB_MAX);
4766 size = max (size, 1);
4768 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4769 value = top * XM_SB_MAX;
4770 value = min (value, XM_SB_MAX - size);
4772 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4774 #else /* !USE_MOTIF i.e. use Xaw */
4776 if (whole == 0)
4777 top = 0, shown = 1;
4778 else
4780 top = (float) position / whole;
4781 shown = (float) portion / whole;
4785 float old_top, old_shown;
4786 Dimension height;
4787 XtVaGetValues (widget,
4788 XtNtopOfThumb, &old_top,
4789 XtNshown, &old_shown,
4790 XtNheight, &height,
4791 NULL);
4793 /* Massage the top+shown values. */
4794 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4795 top = max (0, min (1, top));
4796 else
4797 top = old_top;
4798 /* Keep two pixels available for moving the thumb down. */
4799 shown = max (0, min (1 - top - (2.0 / height), shown));
4801 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4802 check that your system's configuration file contains a define
4803 for `NARROWPROTO'. See s/freebsd.h for an example. */
4804 if (top != old_top || shown != old_shown)
4806 if (NILP (bar->dragging))
4807 XawScrollbarSetThumb (widget, top, shown);
4808 else
4810 /* Try to make the scrolling a tad smoother. */
4811 if (!xaw3d_pick_top)
4812 shown = min (shown, old_shown);
4814 XawScrollbarSetThumb (widget, top, shown);
4818 #endif /* !USE_MOTIF */
4820 UNBLOCK_INPUT;
4822 #endif /* not USE_GTK */
4824 #endif /* USE_TOOLKIT_SCROLL_BARS */
4828 /************************************************************************
4829 Scroll bars, general
4830 ************************************************************************/
4832 /* Create a scroll bar and return the scroll bar vector for it. W is
4833 the Emacs window on which to create the scroll bar. TOP, LEFT,
4834 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4835 scroll bar. */
4837 static struct scroll_bar *
4838 x_scroll_bar_create (w, top, left, width, height)
4839 struct window *w;
4840 int top, left, width, height;
4842 struct frame *f = XFRAME (w->frame);
4843 struct scroll_bar *bar
4844 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4846 BLOCK_INPUT;
4848 #ifdef USE_TOOLKIT_SCROLL_BARS
4849 x_create_toolkit_scroll_bar (f, bar);
4850 #else /* not USE_TOOLKIT_SCROLL_BARS */
4852 XSetWindowAttributes a;
4853 unsigned long mask;
4854 Window window;
4856 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4857 if (a.background_pixel == -1)
4858 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4860 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4861 | ButtonMotionMask | PointerMotionHintMask
4862 | ExposureMask);
4863 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4865 mask = (CWBackPixel | CWEventMask | CWCursor);
4867 /* Clear the area of W that will serve as a scroll bar. This is
4868 for the case that a window has been split horizontally. In
4869 this case, no clear_frame is generated to reduce flickering. */
4870 if (width > 0 && height > 0)
4871 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4872 left, top, width,
4873 window_box_height (w), False);
4875 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4876 /* Position and size of scroll bar. */
4877 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4878 top,
4879 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4880 height,
4881 /* Border width, depth, class, and visual. */
4883 CopyFromParent,
4884 CopyFromParent,
4885 CopyFromParent,
4886 /* Attributes. */
4887 mask, &a);
4888 bar->x_window = window;
4890 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4892 XSETWINDOW (bar->window, w);
4893 bar->top = top;
4894 bar->left = left;
4895 bar->width = width;
4896 bar->height = height;
4897 bar->start = 0;
4898 bar->end = 0;
4899 bar->dragging = Qnil;
4900 bar->fringe_extended_p = 0;
4902 /* Add bar to its frame's list of scroll bars. */
4903 bar->next = FRAME_SCROLL_BARS (f);
4904 bar->prev = Qnil;
4905 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4906 if (!NILP (bar->next))
4907 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4909 /* Map the window/widget. */
4910 #ifdef USE_TOOLKIT_SCROLL_BARS
4912 #ifdef USE_GTK
4913 xg_update_scrollbar_pos (f,
4914 bar->x_window,
4915 top,
4916 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4917 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4918 max (height, 1));
4919 xg_show_scroll_bar (bar->x_window);
4920 #else /* not USE_GTK */
4921 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4922 XtConfigureWidget (scroll_bar,
4923 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4924 top,
4925 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4926 max (height, 1), 0);
4927 XtMapWidget (scroll_bar);
4928 #endif /* not USE_GTK */
4930 #else /* not USE_TOOLKIT_SCROLL_BARS */
4931 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4932 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4934 UNBLOCK_INPUT;
4935 return bar;
4939 #ifndef USE_TOOLKIT_SCROLL_BARS
4941 /* Draw BAR's handle in the proper position.
4943 If the handle is already drawn from START to END, don't bother
4944 redrawing it, unless REBUILD is non-zero; in that case, always
4945 redraw it. (REBUILD is handy for drawing the handle after expose
4946 events.)
4948 Normally, we want to constrain the start and end of the handle to
4949 fit inside its rectangle, but if the user is dragging the scroll
4950 bar handle, we want to let them drag it down all the way, so that
4951 the bar's top is as far down as it goes; otherwise, there's no way
4952 to move to the very end of the buffer. */
4954 static void
4955 x_scroll_bar_set_handle (bar, start, end, rebuild)
4956 struct scroll_bar *bar;
4957 int start, end;
4958 int rebuild;
4960 int dragging = ! NILP (bar->dragging);
4961 Window w = bar->x_window;
4962 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4963 GC gc = f->output_data.x->normal_gc;
4965 /* If the display is already accurate, do nothing. */
4966 if (! rebuild
4967 && start == bar->start
4968 && end == bar->end)
4969 return;
4971 BLOCK_INPUT;
4974 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4975 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4976 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4978 /* Make sure the values are reasonable, and try to preserve
4979 the distance between start and end. */
4981 int length = end - start;
4983 if (start < 0)
4984 start = 0;
4985 else if (start > top_range)
4986 start = top_range;
4987 end = start + length;
4989 if (end < start)
4990 end = start;
4991 else if (end > top_range && ! dragging)
4992 end = top_range;
4995 /* Store the adjusted setting in the scroll bar. */
4996 bar->start = start;
4997 bar->end = end;
4999 /* Clip the end position, just for display. */
5000 if (end > top_range)
5001 end = top_range;
5003 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5004 below top positions, to make sure the handle is always at least
5005 that many pixels tall. */
5006 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5008 /* Draw the empty space above the handle. Note that we can't clear
5009 zero-height areas; that means "clear to end of window." */
5010 if (0 < start)
5011 x_clear_area (FRAME_X_DISPLAY (f), w,
5012 /* x, y, width, height, and exposures. */
5013 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5014 VERTICAL_SCROLL_BAR_TOP_BORDER,
5015 inside_width, start,
5016 False);
5018 /* Change to proper foreground color if one is specified. */
5019 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5020 XSetForeground (FRAME_X_DISPLAY (f), gc,
5021 f->output_data.x->scroll_bar_foreground_pixel);
5023 /* Draw the handle itself. */
5024 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5025 /* x, y, width, height */
5026 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5027 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5028 inside_width, end - start);
5030 /* Restore the foreground color of the GC if we changed it above. */
5031 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5032 XSetForeground (FRAME_X_DISPLAY (f), gc,
5033 FRAME_FOREGROUND_PIXEL (f));
5035 /* Draw the empty space below the handle. Note that we can't
5036 clear zero-height areas; that means "clear to end of window." */
5037 if (end < inside_height)
5038 x_clear_area (FRAME_X_DISPLAY (f), w,
5039 /* x, y, width, height, and exposures. */
5040 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5041 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5042 inside_width, inside_height - end,
5043 False);
5047 UNBLOCK_INPUT;
5050 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5052 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5053 nil. */
5055 static void
5056 x_scroll_bar_remove (bar)
5057 struct scroll_bar *bar;
5059 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5060 BLOCK_INPUT;
5062 #ifdef USE_TOOLKIT_SCROLL_BARS
5063 #ifdef USE_GTK
5064 xg_remove_scroll_bar (f, bar->x_window);
5065 #else /* not USE_GTK */
5066 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5067 #endif /* not USE_GTK */
5068 #else
5069 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5070 #endif
5072 /* Disassociate this scroll bar from its window. */
5073 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5075 UNBLOCK_INPUT;
5079 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5080 that we are displaying PORTION characters out of a total of WHOLE
5081 characters, starting at POSITION. If WINDOW has no scroll bar,
5082 create one. */
5084 static void
5085 XTset_vertical_scroll_bar (w, portion, whole, position)
5086 struct window *w;
5087 int portion, whole, position;
5089 struct frame *f = XFRAME (w->frame);
5090 struct scroll_bar *bar;
5091 int top, height, left, sb_left, width, sb_width;
5092 int window_y, window_height;
5093 #ifdef USE_TOOLKIT_SCROLL_BARS
5094 int fringe_extended_p;
5095 #endif
5097 /* Get window dimensions. */
5098 window_box (w, -1, 0, &window_y, 0, &window_height);
5099 top = window_y;
5100 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5101 height = window_height;
5103 /* Compute the left edge of the scroll bar area. */
5104 left = WINDOW_SCROLL_BAR_AREA_X (w);
5106 /* Compute the width of the scroll bar which might be less than
5107 the width of the area reserved for the scroll bar. */
5108 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5109 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5110 else
5111 sb_width = width;
5113 /* Compute the left edge of the scroll bar. */
5114 #ifdef USE_TOOLKIT_SCROLL_BARS
5115 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5116 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5117 else
5118 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5119 #else
5120 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5121 sb_left = left + width - sb_width;
5122 else
5123 sb_left = left;
5124 #endif
5126 #ifdef USE_TOOLKIT_SCROLL_BARS
5127 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5128 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5129 && WINDOW_LEFT_FRINGE_WIDTH (w)
5130 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5131 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5132 else
5133 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5134 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5135 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5136 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5137 #endif
5139 /* Does the scroll bar exist yet? */
5140 if (NILP (w->vertical_scroll_bar))
5142 if (width > 0 && height > 0)
5144 BLOCK_INPUT;
5145 #ifdef USE_TOOLKIT_SCROLL_BARS
5146 if (fringe_extended_p)
5147 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5148 sb_left, top, sb_width, height, False);
5149 else
5150 #endif
5151 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5152 left, top, width, height, False);
5153 UNBLOCK_INPUT;
5156 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5158 else
5160 /* It may just need to be moved and resized. */
5161 unsigned int mask = 0;
5163 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5165 BLOCK_INPUT;
5167 if (sb_left != bar->left)
5168 mask |= CWX;
5169 if (top != bar->top)
5170 mask |= CWY;
5171 if (sb_width != bar->width)
5172 mask |= CWWidth;
5173 if (height != bar->height)
5174 mask |= CWHeight;
5176 #ifdef USE_TOOLKIT_SCROLL_BARS
5178 /* Move/size the scroll bar widget. */
5179 if (mask || bar->fringe_extended_p != fringe_extended_p)
5181 /* Since toolkit scroll bars are smaller than the space reserved
5182 for them on the frame, we have to clear "under" them. */
5183 if (width > 0 && height > 0)
5185 if (fringe_extended_p)
5186 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5187 sb_left, top, sb_width, height, False);
5188 else
5189 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5190 left, top, width, height, False);
5192 #ifdef USE_GTK
5193 xg_update_scrollbar_pos (f,
5194 bar->x_window,
5195 top,
5196 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5197 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5198 max (height, 1));
5199 #else /* not USE_GTK */
5200 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5201 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5202 top,
5203 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5204 max (height, 1), 0);
5205 #endif /* not USE_GTK */
5207 #else /* not USE_TOOLKIT_SCROLL_BARS */
5209 /* Clear areas not covered by the scroll bar because of
5210 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5211 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5213 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5214 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5215 height, False);
5216 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5217 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5218 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5219 height, False);
5222 /* Clear areas not covered by the scroll bar because it's not as
5223 wide as the area reserved for it. This makes sure a
5224 previous mode line display is cleared after C-x 2 C-x 1, for
5225 example. */
5227 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5228 int rest = area_width - sb_width;
5229 if (rest > 0 && height > 0)
5231 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5232 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5233 left + area_width - rest, top,
5234 rest, height, False);
5235 else
5236 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5237 left, top, rest, height, False);
5241 /* Move/size the scroll bar window. */
5242 if (mask)
5244 XWindowChanges wc;
5246 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5247 wc.y = top;
5248 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5249 wc.height = height;
5250 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5251 mask, &wc);
5254 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5256 /* Remember new settings. */
5257 bar->left = sb_left;
5258 bar->top = top;
5259 bar->width = sb_width;
5260 bar->height = height;
5262 UNBLOCK_INPUT;
5265 #ifdef USE_TOOLKIT_SCROLL_BARS
5266 bar->fringe_extended_p = fringe_extended_p;
5268 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5269 #else /* not USE_TOOLKIT_SCROLL_BARS */
5270 /* Set the scroll bar's current state, unless we're currently being
5271 dragged. */
5272 if (NILP (bar->dragging))
5274 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5276 if (whole == 0)
5277 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5278 else
5280 int start = ((double) position * top_range) / whole;
5281 int end = ((double) (position + portion) * top_range) / whole;
5282 x_scroll_bar_set_handle (bar, start, end, 0);
5285 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5287 XSETVECTOR (w->vertical_scroll_bar, bar);
5291 /* The following three hooks are used when we're doing a thorough
5292 redisplay of the frame. We don't explicitly know which scroll bars
5293 are going to be deleted, because keeping track of when windows go
5294 away is a real pain - "Can you say set-window-configuration, boys
5295 and girls?" Instead, we just assert at the beginning of redisplay
5296 that *all* scroll bars are to be removed, and then save a scroll bar
5297 from the fiery pit when we actually redisplay its window. */
5299 /* Arrange for all scroll bars on FRAME to be removed at the next call
5300 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5301 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5303 static void
5304 XTcondemn_scroll_bars (frame)
5305 FRAME_PTR frame;
5307 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5308 while (! NILP (FRAME_SCROLL_BARS (frame)))
5310 Lisp_Object bar;
5311 bar = FRAME_SCROLL_BARS (frame);
5312 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5313 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5314 XSCROLL_BAR (bar)->prev = Qnil;
5315 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5316 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5317 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5322 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5323 Note that WINDOW isn't necessarily condemned at all. */
5325 static void
5326 XTredeem_scroll_bar (window)
5327 struct window *window;
5329 struct scroll_bar *bar;
5330 struct frame *f;
5332 /* We can't redeem this window's scroll bar if it doesn't have one. */
5333 if (NILP (window->vertical_scroll_bar))
5334 abort ();
5336 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5338 /* Unlink it from the condemned list. */
5339 f = XFRAME (WINDOW_FRAME (window));
5340 if (NILP (bar->prev))
5342 /* If the prev pointer is nil, it must be the first in one of
5343 the lists. */
5344 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5345 /* It's not condemned. Everything's fine. */
5346 return;
5347 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5348 window->vertical_scroll_bar))
5349 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5350 else
5351 /* If its prev pointer is nil, it must be at the front of
5352 one or the other! */
5353 abort ();
5355 else
5356 XSCROLL_BAR (bar->prev)->next = bar->next;
5358 if (! NILP (bar->next))
5359 XSCROLL_BAR (bar->next)->prev = bar->prev;
5361 bar->next = FRAME_SCROLL_BARS (f);
5362 bar->prev = Qnil;
5363 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5364 if (! NILP (bar->next))
5365 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5368 /* Remove all scroll bars on FRAME that haven't been saved since the
5369 last call to `*condemn_scroll_bars_hook'. */
5371 static void
5372 XTjudge_scroll_bars (f)
5373 FRAME_PTR f;
5375 Lisp_Object bar, next;
5377 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5379 /* Clear out the condemned list now so we won't try to process any
5380 more events on the hapless scroll bars. */
5381 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5383 for (; ! NILP (bar); bar = next)
5385 struct scroll_bar *b = XSCROLL_BAR (bar);
5387 x_scroll_bar_remove (b);
5389 next = b->next;
5390 b->next = b->prev = Qnil;
5393 /* Now there should be no references to the condemned scroll bars,
5394 and they should get garbage-collected. */
5398 #ifndef USE_TOOLKIT_SCROLL_BARS
5399 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5400 is a no-op when using toolkit scroll bars.
5402 This may be called from a signal handler, so we have to ignore GC
5403 mark bits. */
5405 static void
5406 x_scroll_bar_expose (bar, event)
5407 struct scroll_bar *bar;
5408 XEvent *event;
5410 Window w = bar->x_window;
5411 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5412 GC gc = f->output_data.x->normal_gc;
5413 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5415 BLOCK_INPUT;
5417 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5419 /* Switch to scroll bar foreground color. */
5420 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5421 XSetForeground (FRAME_X_DISPLAY (f), gc,
5422 f->output_data.x->scroll_bar_foreground_pixel);
5424 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5425 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5427 /* x, y, width, height */
5428 0, 0,
5429 bar->width - 1 - width_trim - width_trim,
5430 bar->height - 1);
5432 /* Restore the foreground color of the GC if we changed it above. */
5433 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5434 XSetForeground (FRAME_X_DISPLAY (f), gc,
5435 FRAME_FOREGROUND_PIXEL (f));
5437 UNBLOCK_INPUT;
5440 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5442 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5443 is set to something other than NO_EVENT, it is enqueued.
5445 This may be called from a signal handler, so we have to ignore GC
5446 mark bits. */
5449 static void
5450 x_scroll_bar_handle_click (bar, event, emacs_event)
5451 struct scroll_bar *bar;
5452 XEvent *event;
5453 struct input_event *emacs_event;
5455 if (! WINDOWP (bar->window))
5456 abort ();
5458 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5459 emacs_event->code = event->xbutton.button - Button1;
5460 emacs_event->modifiers
5461 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5462 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5463 event->xbutton.state)
5464 | (event->type == ButtonRelease
5465 ? up_modifier
5466 : down_modifier));
5467 emacs_event->frame_or_window = bar->window;
5468 emacs_event->arg = Qnil;
5469 emacs_event->timestamp = event->xbutton.time;
5471 #if 0
5472 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5473 int internal_height
5474 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5475 #endif
5476 int top_range
5477 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5478 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5480 if (y < 0) y = 0;
5481 if (y > top_range) y = top_range;
5483 if (y < bar->start)
5484 emacs_event->part = scroll_bar_above_handle;
5485 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5486 emacs_event->part = scroll_bar_handle;
5487 else
5488 emacs_event->part = scroll_bar_below_handle;
5490 /* Just because the user has clicked on the handle doesn't mean
5491 they want to drag it. Lisp code needs to be able to decide
5492 whether or not we're dragging. */
5493 #if 0
5494 /* If the user has just clicked on the handle, record where they're
5495 holding it. */
5496 if (event->type == ButtonPress
5497 && emacs_event->part == scroll_bar_handle)
5498 XSETINT (bar->dragging, y - bar->start);
5499 #endif
5501 #ifndef USE_TOOLKIT_SCROLL_BARS
5502 /* If the user has released the handle, set it to its final position. */
5503 if (event->type == ButtonRelease
5504 && ! NILP (bar->dragging))
5506 int new_start = y - XINT (bar->dragging);
5507 int new_end = new_start + bar->end - bar->start;
5509 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5510 bar->dragging = Qnil;
5512 #endif
5514 /* Same deal here as the other #if 0. */
5515 #if 0
5516 /* Clicks on the handle are always reported as occurring at the top of
5517 the handle. */
5518 if (emacs_event->part == scroll_bar_handle)
5519 emacs_event->x = bar->start;
5520 else
5521 XSETINT (emacs_event->x, y);
5522 #else
5523 XSETINT (emacs_event->x, y);
5524 #endif
5526 XSETINT (emacs_event->y, top_range);
5530 #ifndef USE_TOOLKIT_SCROLL_BARS
5532 /* Handle some mouse motion while someone is dragging the scroll bar.
5534 This may be called from a signal handler, so we have to ignore GC
5535 mark bits. */
5537 static void
5538 x_scroll_bar_note_movement (bar, event)
5539 struct scroll_bar *bar;
5540 XEvent *event;
5542 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5544 last_mouse_movement_time = event->xmotion.time;
5546 f->mouse_moved = 1;
5547 XSETVECTOR (last_mouse_scroll_bar, bar);
5549 /* If we're dragging the bar, display it. */
5550 if (! NILP (bar->dragging))
5552 /* Where should the handle be now? */
5553 int new_start = event->xmotion.y - XINT (bar->dragging);
5555 if (new_start != bar->start)
5557 int new_end = new_start + bar->end - bar->start;
5559 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5564 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5566 /* Return information to the user about the current position of the mouse
5567 on the scroll bar. */
5569 static void
5570 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5571 FRAME_PTR *fp;
5572 Lisp_Object *bar_window;
5573 enum scroll_bar_part *part;
5574 Lisp_Object *x, *y;
5575 unsigned long *time;
5577 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5578 Window w = bar->x_window;
5579 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5580 int win_x, win_y;
5581 Window dummy_window;
5582 int dummy_coord;
5583 unsigned int dummy_mask;
5585 BLOCK_INPUT;
5587 /* Get the mouse's position relative to the scroll bar window, and
5588 report that. */
5589 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5591 /* Root, child, root x and root y. */
5592 &dummy_window, &dummy_window,
5593 &dummy_coord, &dummy_coord,
5595 /* Position relative to scroll bar. */
5596 &win_x, &win_y,
5598 /* Mouse buttons and modifier keys. */
5599 &dummy_mask))
5601 else
5603 #if 0
5604 int inside_height
5605 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5606 #endif
5607 int top_range
5608 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5610 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5612 if (! NILP (bar->dragging))
5613 win_y -= XINT (bar->dragging);
5615 if (win_y < 0)
5616 win_y = 0;
5617 if (win_y > top_range)
5618 win_y = top_range;
5620 *fp = f;
5621 *bar_window = bar->window;
5623 if (! NILP (bar->dragging))
5624 *part = scroll_bar_handle;
5625 else if (win_y < bar->start)
5626 *part = scroll_bar_above_handle;
5627 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5628 *part = scroll_bar_handle;
5629 else
5630 *part = scroll_bar_below_handle;
5632 XSETINT (*x, win_y);
5633 XSETINT (*y, top_range);
5635 f->mouse_moved = 0;
5636 last_mouse_scroll_bar = Qnil;
5639 *time = last_mouse_movement_time;
5641 UNBLOCK_INPUT;
5645 /* The screen has been cleared so we may have changed foreground or
5646 background colors, and the scroll bars may need to be redrawn.
5647 Clear out the scroll bars, and ask for expose events, so we can
5648 redraw them. */
5650 void
5651 x_scroll_bar_clear (f)
5652 FRAME_PTR f;
5654 #ifndef USE_TOOLKIT_SCROLL_BARS
5655 Lisp_Object bar;
5657 /* We can have scroll bars even if this is 0,
5658 if we just turned off scroll bar mode.
5659 But in that case we should not clear them. */
5660 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5661 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5662 bar = XSCROLL_BAR (bar)->next)
5663 XClearArea (FRAME_X_DISPLAY (f),
5664 XSCROLL_BAR (bar)->x_window,
5665 0, 0, 0, 0, True);
5666 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5670 /* The main X event-reading loop - XTread_socket. */
5672 #if 0
5673 /* Time stamp of enter window event. This is only used by XTread_socket,
5674 but we have to put it out here, since static variables within functions
5675 sometimes don't work. */
5677 static Time enter_timestamp;
5678 #endif
5680 /* This holds the state XLookupString needs to implement dead keys
5681 and other tricks known as "compose processing". _X Window System_
5682 says that a portable program can't use this, but Stephen Gildea assures
5683 me that letting the compiler initialize it to zeros will work okay.
5685 This must be defined outside of XTread_socket, for the same reasons
5686 given for enter_timestamp, above. */
5688 static XComposeStatus compose_status;
5690 /* Record the last 100 characters stored
5691 to help debug the loss-of-chars-during-GC problem. */
5693 static int temp_index;
5694 static short temp_buffer[100];
5696 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5697 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5698 temp_index = 0; \
5699 temp_buffer[temp_index++] = (keysym)
5701 /* Set this to nonzero to fake an "X I/O error"
5702 on a particular display. */
5704 struct x_display_info *XTread_socket_fake_io_error;
5706 /* When we find no input here, we occasionally do a no-op command
5707 to verify that the X server is still running and we can still talk with it.
5708 We try all the open displays, one by one.
5709 This variable is used for cycling thru the displays. */
5711 static struct x_display_info *next_noop_dpyinfo;
5713 #define SET_SAVED_MENU_EVENT(size) \
5714 do \
5716 if (f->output_data.x->saved_menu_event == 0) \
5717 f->output_data.x->saved_menu_event \
5718 = (XEvent *) xmalloc (sizeof (XEvent)); \
5719 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5720 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5721 XSETFRAME (inev.ie.frame_or_window, f); \
5723 while (0)
5725 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5726 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5729 enum
5731 X_EVENT_NORMAL,
5732 X_EVENT_GOTO_OUT,
5733 X_EVENT_DROP
5736 /* Filter events for the current X input method.
5737 DPYINFO is the display this event is for.
5738 EVENT is the X event to filter.
5740 Returns non-zero if the event was filtered, caller shall not process
5741 this event further.
5742 Returns zero if event is wasn't filtered. */
5744 #ifdef HAVE_X_I18N
5745 static int
5746 x_filter_event (dpyinfo, event)
5747 struct x_display_info *dpyinfo;
5748 XEvent *event;
5750 /* XFilterEvent returns non-zero if the input method has
5751 consumed the event. We pass the frame's X window to
5752 XFilterEvent because that's the one for which the IC
5753 was created. */
5755 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5756 event->xclient.window);
5758 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5760 #endif
5762 #ifdef USE_GTK
5763 static int current_count;
5764 static int current_finish;
5765 static struct input_event *current_hold_quit;
5767 /* This is the filter function invoked by the GTK event loop.
5768 It is invoked before the XEvent is translated to a GdkEvent,
5769 so we have a chance to act on the event before GTK. */
5770 static GdkFilterReturn
5771 event_handler_gdk (gxev, ev, data)
5772 GdkXEvent *gxev;
5773 GdkEvent *ev;
5774 gpointer data;
5776 XEvent *xev = (XEvent *) gxev;
5778 if (current_count >= 0)
5780 struct x_display_info *dpyinfo;
5782 dpyinfo = x_display_info_for_display (xev->xany.display);
5784 #ifdef HAVE_X_I18N
5785 /* Filter events for the current X input method.
5786 GTK calls XFilterEvent but not for key press and release,
5787 so we do it here. */
5788 if (xev->type == KeyPress || xev->type == KeyRelease)
5789 if (dpyinfo && x_filter_event (dpyinfo, xev))
5790 return GDK_FILTER_REMOVE;
5791 #endif
5793 if (! dpyinfo)
5794 current_finish = X_EVENT_NORMAL;
5795 else
5797 current_count +=
5798 handle_one_xevent (dpyinfo, xev, &current_finish,
5799 current_hold_quit);
5802 else
5803 current_finish = x_dispatch_event (xev, xev->xany.display);
5805 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5806 return GDK_FILTER_REMOVE;
5808 return GDK_FILTER_CONTINUE;
5810 #endif /* USE_GTK */
5813 /* Handles the XEvent EVENT on display DPYINFO.
5815 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5816 *FINISH is zero if caller should continue reading events.
5817 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5819 We return the number of characters stored into the buffer. */
5821 static int
5822 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5823 struct x_display_info *dpyinfo;
5824 XEvent *eventp;
5825 int *finish;
5826 struct input_event *hold_quit;
5828 union {
5829 struct input_event ie;
5830 struct selection_input_event sie;
5831 } inev;
5832 int count = 0;
5833 int do_help = 0;
5834 int nbytes = 0;
5835 struct frame *f = NULL;
5836 struct coding_system coding;
5837 XEvent event = *eventp;
5839 *finish = X_EVENT_NORMAL;
5841 EVENT_INIT (inev.ie);
5842 inev.ie.kind = NO_EVENT;
5843 inev.ie.arg = Qnil;
5845 switch (event.type)
5847 case ClientMessage:
5849 if (event.xclient.message_type
5850 == dpyinfo->Xatom_wm_protocols
5851 && event.xclient.format == 32)
5853 if (event.xclient.data.l[0]
5854 == dpyinfo->Xatom_wm_take_focus)
5856 /* Use x_any_window_to_frame because this
5857 could be the shell widget window
5858 if the frame has no title bar. */
5859 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5860 #ifdef HAVE_X_I18N
5861 /* Not quite sure this is needed -pd */
5862 if (f && FRAME_XIC (f))
5863 XSetICFocus (FRAME_XIC (f));
5864 #endif
5865 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5866 instructs the WM to set the input focus automatically for
5867 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5868 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5869 it has set the focus. So, XSetInputFocus below is not
5870 needed.
5872 The call to XSetInputFocus below has also caused trouble. In
5873 cases where the XSetInputFocus done by the WM and the one
5874 below are temporally close (on a fast machine), the call
5875 below can generate additional FocusIn events which confuse
5876 Emacs. */
5878 /* Since we set WM_TAKE_FOCUS, we must call
5879 XSetInputFocus explicitly. But not if f is null,
5880 since that might be an event for a deleted frame. */
5881 if (f)
5883 Display *d = event.xclient.display;
5884 /* Catch and ignore errors, in case window has been
5885 iconified by a window manager such as GWM. */
5886 x_catch_errors (d);
5887 XSetInputFocus (d, event.xclient.window,
5888 /* The ICCCM says this is
5889 the only valid choice. */
5890 RevertToParent,
5891 event.xclient.data.l[1]);
5892 /* This is needed to detect the error
5893 if there is an error. */
5894 XSync (d, False);
5895 x_uncatch_errors ();
5897 /* Not certain about handling scroll bars here */
5898 #endif /* 0 */
5899 goto done;
5902 if (event.xclient.data.l[0]
5903 == dpyinfo->Xatom_wm_save_yourself)
5905 /* Save state modify the WM_COMMAND property to
5906 something which can reinstate us. This notifies
5907 the session manager, who's looking for such a
5908 PropertyNotify. Can restart processing when
5909 a keyboard or mouse event arrives. */
5910 /* If we have a session manager, don't set this.
5911 KDE will then start two Emacsen, one for the
5912 session manager and one for this. */
5913 #ifdef HAVE_X_SM
5914 if (! x_session_have_connection ())
5915 #endif
5917 f = x_top_window_to_frame (dpyinfo,
5918 event.xclient.window);
5919 /* This is just so we only give real data once
5920 for a single Emacs process. */
5921 if (f == SELECTED_FRAME ())
5922 XSetCommand (FRAME_X_DISPLAY (f),
5923 event.xclient.window,
5924 initial_argv, initial_argc);
5925 else if (f)
5926 XSetCommand (FRAME_X_DISPLAY (f),
5927 event.xclient.window,
5928 0, 0);
5930 goto done;
5933 if (event.xclient.data.l[0]
5934 == dpyinfo->Xatom_wm_delete_window)
5936 f = x_any_window_to_frame (dpyinfo,
5937 event.xclient.window);
5938 if (!f)
5939 goto OTHER; /* May be a dialog that is to be removed */
5941 inev.ie.kind = DELETE_WINDOW_EVENT;
5942 XSETFRAME (inev.ie.frame_or_window, f);
5943 goto done;
5946 goto done;
5949 if (event.xclient.message_type
5950 == dpyinfo->Xatom_wm_configure_denied)
5952 goto done;
5955 if (event.xclient.message_type
5956 == dpyinfo->Xatom_wm_window_moved)
5958 int new_x, new_y;
5959 f = x_window_to_frame (dpyinfo, event.xclient.window);
5961 new_x = event.xclient.data.s[0];
5962 new_y = event.xclient.data.s[1];
5964 if (f)
5966 f->left_pos = new_x;
5967 f->top_pos = new_y;
5969 goto done;
5972 #ifdef HACK_EDITRES
5973 if (event.xclient.message_type
5974 == dpyinfo->Xatom_editres)
5976 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5977 if (f)
5978 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5979 &event, NULL);
5980 goto done;
5982 #endif /* HACK_EDITRES */
5984 if ((event.xclient.message_type
5985 == dpyinfo->Xatom_DONE)
5986 || (event.xclient.message_type
5987 == dpyinfo->Xatom_PAGE))
5989 /* Ghostview job completed. Kill it. We could
5990 reply with "Next" if we received "Page", but we
5991 currently never do because we are interested in
5992 images, only, which should have 1 page. */
5993 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5994 f = x_window_to_frame (dpyinfo, event.xclient.window);
5995 if (!f)
5996 goto OTHER;
5997 x_kill_gs_process (pixmap, f);
5998 expose_frame (f, 0, 0, 0, 0);
5999 goto done;
6002 #ifdef USE_TOOLKIT_SCROLL_BARS
6003 /* Scroll bar callbacks send a ClientMessage from which
6004 we construct an input_event. */
6005 if (event.xclient.message_type
6006 == dpyinfo->Xatom_Scrollbar)
6008 x_scroll_bar_to_input_event (&event, &inev.ie);
6009 *finish = X_EVENT_GOTO_OUT;
6010 goto done;
6012 #endif /* USE_TOOLKIT_SCROLL_BARS */
6014 /* XEmbed messages from the embedder (if any). */
6015 if (event.xclient.message_type
6016 == dpyinfo->Xatom_XEMBED)
6018 enum xembed_message msg = event.xclient.data.l[1];
6019 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6020 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6022 *finish = X_EVENT_GOTO_OUT;
6023 goto done;
6026 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6027 if (!f)
6028 goto OTHER;
6029 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6030 *finish = X_EVENT_DROP;
6032 break;
6034 case SelectionNotify:
6035 last_user_time = event.xselection.time;
6036 #ifdef USE_X_TOOLKIT
6037 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6038 goto OTHER;
6039 #endif /* not USE_X_TOOLKIT */
6040 x_handle_selection_notify (&event.xselection);
6041 break;
6043 case SelectionClear: /* Someone has grabbed ownership. */
6044 last_user_time = event.xselectionclear.time;
6045 #ifdef USE_X_TOOLKIT
6046 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6047 goto OTHER;
6048 #endif /* USE_X_TOOLKIT */
6050 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6052 inev.ie.kind = SELECTION_CLEAR_EVENT;
6053 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6054 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6055 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6056 inev.ie.frame_or_window = Qnil;
6058 break;
6060 case SelectionRequest: /* Someone wants our selection. */
6061 last_user_time = event.xselectionrequest.time;
6062 #ifdef USE_X_TOOLKIT
6063 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6064 goto OTHER;
6065 #endif /* USE_X_TOOLKIT */
6067 XSelectionRequestEvent *eventp
6068 = (XSelectionRequestEvent *) &event;
6070 inev.ie.kind = SELECTION_REQUEST_EVENT;
6071 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6072 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6073 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6074 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6075 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6076 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6077 inev.ie.frame_or_window = Qnil;
6079 break;
6081 case PropertyNotify:
6082 last_user_time = event.xproperty.time;
6083 #if 0 /* This is plain wrong. In the case that we are waiting for a
6084 PropertyNotify used as an ACK in incremental selection
6085 transfer, the property will be on the receiver's window. */
6086 #if defined USE_X_TOOLKIT
6087 if (!x_any_window_to_frame (dpyinfo, event.xproperty.window))
6088 goto OTHER;
6089 #endif
6090 #endif
6091 x_handle_property_notify (&event.xproperty);
6092 goto OTHER;
6094 case ReparentNotify:
6095 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6096 if (f)
6098 int x, y;
6099 f->output_data.x->parent_desc = event.xreparent.parent;
6100 x_real_positions (f, &x, &y);
6101 f->left_pos = x;
6102 f->top_pos = y;
6104 /* Perhaps reparented due to a WM restart. Reset this. */
6105 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6106 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6108 goto OTHER;
6110 case Expose:
6111 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6112 if (f)
6114 x_check_fullscreen (f);
6116 #ifdef USE_GTK
6117 /* This seems to be needed for GTK 2.6. */
6118 x_clear_area (event.xexpose.display,
6119 event.xexpose.window,
6120 event.xexpose.x, event.xexpose.y,
6121 event.xexpose.width, event.xexpose.height,
6122 FALSE);
6123 #endif
6124 if (f->async_visible == 0)
6126 f->async_visible = 1;
6127 f->async_iconified = 0;
6128 f->output_data.x->has_been_visible = 1;
6129 SET_FRAME_GARBAGED (f);
6131 else
6132 expose_frame (f,
6133 event.xexpose.x, event.xexpose.y,
6134 event.xexpose.width, event.xexpose.height);
6136 else
6138 #ifndef USE_TOOLKIT_SCROLL_BARS
6139 struct scroll_bar *bar;
6140 #endif
6141 #if defined USE_LUCID
6142 /* Submenus of the Lucid menu bar aren't widgets
6143 themselves, so there's no way to dispatch events
6144 to them. Recognize this case separately. */
6146 Widget widget
6147 = x_window_to_menu_bar (event.xexpose.window);
6148 if (widget)
6149 xlwmenu_redisplay (widget);
6151 #endif /* USE_LUCID */
6153 #ifdef USE_TOOLKIT_SCROLL_BARS
6154 /* Dispatch event to the widget. */
6155 goto OTHER;
6156 #else /* not USE_TOOLKIT_SCROLL_BARS */
6157 bar = x_window_to_scroll_bar (event.xexpose.display,
6158 event.xexpose.window);
6160 if (bar)
6161 x_scroll_bar_expose (bar, &event);
6162 #ifdef USE_X_TOOLKIT
6163 else
6164 goto OTHER;
6165 #endif /* USE_X_TOOLKIT */
6166 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6168 break;
6170 case GraphicsExpose: /* This occurs when an XCopyArea's
6171 source area was obscured or not
6172 available. */
6173 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6174 if (f)
6176 expose_frame (f,
6177 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6178 event.xgraphicsexpose.width,
6179 event.xgraphicsexpose.height);
6181 #ifdef USE_X_TOOLKIT
6182 else
6183 goto OTHER;
6184 #endif /* USE_X_TOOLKIT */
6185 break;
6187 case NoExpose: /* This occurs when an XCopyArea's
6188 source area was completely
6189 available. */
6190 break;
6192 case UnmapNotify:
6193 /* Redo the mouse-highlight after the tooltip has gone. */
6194 if (event.xmap.window == tip_window)
6196 tip_window = 0;
6197 redo_mouse_highlight ();
6200 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6201 if (f) /* F may no longer exist if
6202 the frame was deleted. */
6204 /* While a frame is unmapped, display generation is
6205 disabled; you don't want to spend time updating a
6206 display that won't ever be seen. */
6207 f->async_visible = 0;
6208 /* We can't distinguish, from the event, whether the window
6209 has become iconified or invisible. So assume, if it
6210 was previously visible, than now it is iconified.
6211 But x_make_frame_invisible clears both
6212 the visible flag and the iconified flag;
6213 and that way, we know the window is not iconified now. */
6214 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6216 f->async_iconified = 1;
6218 inev.ie.kind = ICONIFY_EVENT;
6219 XSETFRAME (inev.ie.frame_or_window, f);
6222 goto OTHER;
6224 case MapNotify:
6225 if (event.xmap.window == tip_window)
6226 /* The tooltip has been drawn already. Avoid
6227 the SET_FRAME_GARBAGED below. */
6228 goto OTHER;
6230 /* We use x_top_window_to_frame because map events can
6231 come for sub-windows and they don't mean that the
6232 frame is visible. */
6233 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6234 if (f)
6236 /* wait_reading_process_output will notice this and update
6237 the frame's display structures.
6238 If we where iconified, we should not set garbaged,
6239 because that stops redrawing on Expose events. This looks
6240 bad if we are called from a recursive event loop
6241 (x_dispatch_event), for example when a dialog is up. */
6242 if (! f->async_iconified)
6243 SET_FRAME_GARBAGED (f);
6245 f->async_visible = 1;
6246 f->async_iconified = 0;
6247 f->output_data.x->has_been_visible = 1;
6249 if (f->iconified)
6251 inev.ie.kind = DEICONIFY_EVENT;
6252 XSETFRAME (inev.ie.frame_or_window, f);
6254 else if (! NILP (Vframe_list)
6255 && ! NILP (XCDR (Vframe_list)))
6256 /* Force a redisplay sooner or later
6257 to update the frame titles
6258 in case this is the second frame. */
6259 record_asynch_buffer_change ();
6261 goto OTHER;
6263 case KeyPress:
6265 last_user_time = event.xkey.time;
6266 ignore_next_mouse_click_timeout = 0;
6268 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6269 /* Dispatch KeyPress events when in menu. */
6270 if (popup_activated ())
6271 goto OTHER;
6272 #endif
6274 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6276 /* If mouse-highlight is an integer, input clears out
6277 mouse highlighting. */
6278 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6279 && (f == 0
6280 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6282 clear_mouse_face (dpyinfo);
6283 dpyinfo->mouse_face_hidden = 1;
6286 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6287 if (f == 0)
6289 /* Scroll bars consume key events, but we want
6290 the keys to go to the scroll bar's frame. */
6291 Widget widget = XtWindowToWidget (dpyinfo->display,
6292 event.xkey.window);
6293 if (widget && XmIsScrollBar (widget))
6295 widget = XtParent (widget);
6296 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6299 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6301 if (f != 0)
6303 KeySym keysym, orig_keysym;
6304 /* al%imercury@uunet.uu.net says that making this 81
6305 instead of 80 fixed a bug whereby meta chars made
6306 his Emacs hang.
6308 It seems that some version of XmbLookupString has
6309 a bug of not returning XBufferOverflow in
6310 status_return even if the input is too long to
6311 fit in 81 bytes. So, we must prepare sufficient
6312 bytes for copy_buffer. 513 bytes (256 chars for
6313 two-byte character set) seems to be a fairly good
6314 approximation. -- 2000.8.10 handa@etl.go.jp */
6315 unsigned char copy_buffer[513];
6316 unsigned char *copy_bufptr = copy_buffer;
6317 int copy_bufsiz = sizeof (copy_buffer);
6318 int modifiers;
6319 Lisp_Object coding_system = Qlatin_1;
6320 Lisp_Object c;
6322 #ifdef USE_GTK
6323 /* Don't pass keys to GTK. A Tab will shift focus to the
6324 tool bar in GTK 2.4. Keys will still go to menus and
6325 dialogs because in that case popup_activated is TRUE
6326 (see above). */
6327 *finish = X_EVENT_DROP;
6328 #endif
6330 event.xkey.state
6331 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6332 extra_keyboard_modifiers);
6333 modifiers = event.xkey.state;
6335 /* This will have to go some day... */
6337 /* make_lispy_event turns chars into control chars.
6338 Don't do it here because XLookupString is too eager. */
6339 event.xkey.state &= ~ControlMask;
6340 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6341 | dpyinfo->super_mod_mask
6342 | dpyinfo->hyper_mod_mask
6343 | dpyinfo->alt_mod_mask);
6345 /* In case Meta is ComposeCharacter,
6346 clear its status. According to Markus Ehrnsperger
6347 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6348 this enables ComposeCharacter to work whether or
6349 not it is combined with Meta. */
6350 if (modifiers & dpyinfo->meta_mod_mask)
6351 bzero (&compose_status, sizeof (compose_status));
6353 #ifdef HAVE_X_I18N
6354 if (FRAME_XIC (f))
6356 Status status_return;
6358 coding_system = Vlocale_coding_system;
6359 nbytes = XmbLookupString (FRAME_XIC (f),
6360 &event.xkey, copy_bufptr,
6361 copy_bufsiz, &keysym,
6362 &status_return);
6363 if (status_return == XBufferOverflow)
6365 copy_bufsiz = nbytes + 1;
6366 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6367 nbytes = XmbLookupString (FRAME_XIC (f),
6368 &event.xkey, copy_bufptr,
6369 copy_bufsiz, &keysym,
6370 &status_return);
6372 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6373 #if 0 && defined X_HAVE_UTF8_STRING
6374 else if (status_return == XLookupKeySym)
6375 { /* Try again but with utf-8. */
6376 coding_system = Qutf_8;
6377 nbytes = Xutf8LookupString (FRAME_XIC (f),
6378 &event.xkey, copy_bufptr,
6379 copy_bufsiz, &keysym,
6380 &status_return);
6381 if (status_return == XBufferOverflow)
6383 copy_bufsiz = nbytes + 1;
6384 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6385 nbytes = Xutf8LookupString (FRAME_XIC (f),
6386 &event.xkey,
6387 copy_bufptr,
6388 copy_bufsiz, &keysym,
6389 &status_return);
6392 #endif
6394 if (status_return == XLookupNone)
6395 break;
6396 else if (status_return == XLookupChars)
6398 keysym = NoSymbol;
6399 modifiers = 0;
6401 else if (status_return != XLookupKeySym
6402 && status_return != XLookupBoth)
6403 abort ();
6405 else
6406 nbytes = XLookupString (&event.xkey, copy_bufptr,
6407 copy_bufsiz, &keysym,
6408 &compose_status);
6409 #else
6410 nbytes = XLookupString (&event.xkey, copy_bufptr,
6411 copy_bufsiz, &keysym,
6412 &compose_status);
6413 #endif
6415 /* If not using XIM/XIC, and a compose sequence is in progress,
6416 we break here. Otherwise, chars_matched is always 0. */
6417 if (compose_status.chars_matched > 0 && nbytes == 0)
6418 break;
6420 bzero (&compose_status, sizeof (compose_status));
6421 orig_keysym = keysym;
6423 /* Common for all keysym input events. */
6424 XSETFRAME (inev.ie.frame_or_window, f);
6425 inev.ie.modifiers
6426 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6427 inev.ie.timestamp = event.xkey.time;
6429 /* First deal with keysyms which have defined
6430 translations to characters. */
6431 if (keysym >= 32 && keysym < 128)
6432 /* Avoid explicitly decoding each ASCII character. */
6434 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6435 inev.ie.code = keysym;
6436 goto done_keysym;
6439 /* Keysyms directly mapped to Unicode characters. */
6440 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6442 if (keysym < 0x01000080)
6443 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6444 else
6445 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6446 inev.ie.code = keysym & 0xFFFFFF;
6447 goto done_keysym;
6450 /* Now non-ASCII. */
6451 if (HASH_TABLE_P (Vx_keysym_table)
6452 && (NATNUMP (c = Fgethash (make_number (keysym),
6453 Vx_keysym_table,
6454 Qnil))))
6456 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6457 ? ASCII_KEYSTROKE_EVENT
6458 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6459 inev.ie.code = XFASTINT (c);
6460 goto done_keysym;
6463 /* Random non-modifier sorts of keysyms. */
6464 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6465 || keysym == XK_Delete
6466 #ifdef XK_ISO_Left_Tab
6467 || (keysym >= XK_ISO_Left_Tab
6468 && keysym <= XK_ISO_Enter)
6469 #endif
6470 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6471 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6472 #ifdef HPUX
6473 /* This recognizes the "extended function
6474 keys". It seems there's no cleaner way.
6475 Test IsModifierKey to avoid handling
6476 mode_switch incorrectly. */
6477 || ((unsigned) (keysym) >= XK_Select
6478 && (unsigned)(keysym) < XK_KP_Space)
6479 #endif
6480 #ifdef XK_dead_circumflex
6481 || orig_keysym == XK_dead_circumflex
6482 #endif
6483 #ifdef XK_dead_grave
6484 || orig_keysym == XK_dead_grave
6485 #endif
6486 #ifdef XK_dead_tilde
6487 || orig_keysym == XK_dead_tilde
6488 #endif
6489 #ifdef XK_dead_diaeresis
6490 || orig_keysym == XK_dead_diaeresis
6491 #endif
6492 #ifdef XK_dead_macron
6493 || orig_keysym == XK_dead_macron
6494 #endif
6495 #ifdef XK_dead_degree
6496 || orig_keysym == XK_dead_degree
6497 #endif
6498 #ifdef XK_dead_acute
6499 || orig_keysym == XK_dead_acute
6500 #endif
6501 #ifdef XK_dead_cedilla
6502 || orig_keysym == XK_dead_cedilla
6503 #endif
6504 #ifdef XK_dead_breve
6505 || orig_keysym == XK_dead_breve
6506 #endif
6507 #ifdef XK_dead_ogonek
6508 || orig_keysym == XK_dead_ogonek
6509 #endif
6510 #ifdef XK_dead_caron
6511 || orig_keysym == XK_dead_caron
6512 #endif
6513 #ifdef XK_dead_doubleacute
6514 || orig_keysym == XK_dead_doubleacute
6515 #endif
6516 #ifdef XK_dead_abovedot
6517 || orig_keysym == XK_dead_abovedot
6518 #endif
6519 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6520 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6521 /* Any "vendor-specific" key is ok. */
6522 || (orig_keysym & (1 << 28))
6523 || (keysym != NoSymbol && nbytes == 0))
6524 && ! (IsModifierKey (orig_keysym)
6525 /* The symbols from XK_ISO_Lock
6526 to XK_ISO_Last_Group_Lock
6527 don't have real modifiers but
6528 should be treated similarly to
6529 Mode_switch by Emacs. */
6530 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6531 || ((unsigned)(orig_keysym)
6532 >= XK_ISO_Lock
6533 && (unsigned)(orig_keysym)
6534 <= XK_ISO_Last_Group_Lock)
6535 #endif
6538 STORE_KEYSYM_FOR_DEBUG (keysym);
6539 /* make_lispy_event will convert this to a symbolic
6540 key. */
6541 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6542 inev.ie.code = keysym;
6543 goto done_keysym;
6546 { /* Raw bytes, not keysym. */
6547 register int i;
6548 register int c;
6549 int nchars, len;
6551 for (i = 0, nchars = 0; i < nbytes; i++)
6553 if (ASCII_BYTE_P (copy_bufptr[i]))
6554 nchars++;
6555 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6558 if (nchars < nbytes)
6560 /* Decode the input data. */
6561 int require;
6562 unsigned char *p;
6564 /* The input should be decoded with `coding_system'
6565 which depends on which X*LookupString function
6566 we used just above and the locale. */
6567 setup_coding_system (coding_system, &coding);
6568 coding.src_multibyte = 0;
6569 coding.dst_multibyte = 1;
6570 /* The input is converted to events, thus we can't
6571 handle composition. Anyway, there's no XIM that
6572 gives us composition information. */
6573 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6575 require = MAX_MULTIBYTE_LENGTH * nbytes;
6576 coding.destination = alloca (require);
6577 coding.dst_bytes = require;
6578 coding.mode |= CODING_MODE_LAST_BLOCK;
6579 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6580 nbytes = coding.produced;
6581 nchars = coding.produced_char;
6582 copy_bufptr = coding.destination;
6585 /* Convert the input data to a sequence of
6586 character events. */
6587 for (i = 0; i < nbytes; i += len)
6589 if (nchars == nbytes)
6590 c = copy_bufptr[i], len = 1;
6591 else
6592 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i,
6593 nbytes - i, len);
6594 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6595 ? ASCII_KEYSTROKE_EVENT
6596 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6597 inev.ie.code = c;
6598 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6601 count += nchars;
6603 inev.ie.kind = NO_EVENT; /* Already stored above. */
6605 if (keysym == NoSymbol)
6606 break;
6609 done_keysym:
6610 #ifdef HAVE_X_I18N
6611 /* Don't dispatch this event since XtDispatchEvent calls
6612 XFilterEvent, and two calls in a row may freeze the
6613 client. */
6614 break;
6615 #else
6616 goto OTHER;
6617 #endif
6619 case KeyRelease:
6620 last_user_time = event.xkey.time;
6621 #ifdef HAVE_X_I18N
6622 /* Don't dispatch this event since XtDispatchEvent calls
6623 XFilterEvent, and two calls in a row may freeze the
6624 client. */
6625 break;
6626 #else
6627 goto OTHER;
6628 #endif
6630 case EnterNotify:
6631 last_user_time = event.xcrossing.time;
6632 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6634 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6636 if (f && x_mouse_click_focus_ignore_position)
6637 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6639 #if 0
6640 if (event.xcrossing.focus)
6642 /* Avoid nasty pop/raise loops. */
6643 if (f && (!(f->auto_raise)
6644 || !(f->auto_lower)
6645 || (event.xcrossing.time - enter_timestamp) > 500))
6647 x_new_focus_frame (dpyinfo, f);
6648 enter_timestamp = event.xcrossing.time;
6651 else if (f == dpyinfo->x_focus_frame)
6652 x_new_focus_frame (dpyinfo, 0);
6653 #endif
6655 /* EnterNotify counts as mouse movement,
6656 so update things that depend on mouse position. */
6657 if (f && !f->output_data.x->hourglass_p)
6658 note_mouse_movement (f, &event.xmotion);
6659 #ifdef USE_GTK
6660 /* We may get an EnterNotify on the buttons in the toolbar. In that
6661 case we moved out of any highlighted area and need to note this. */
6662 if (!f && last_mouse_glyph_frame)
6663 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6664 #endif
6665 goto OTHER;
6667 case FocusIn:
6668 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6669 goto OTHER;
6671 case LeaveNotify:
6672 last_user_time = event.xcrossing.time;
6673 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6675 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6676 if (f)
6678 if (f == dpyinfo->mouse_face_mouse_frame)
6680 /* If we move outside the frame, then we're
6681 certainly no longer on any text in the frame. */
6682 clear_mouse_face (dpyinfo);
6683 dpyinfo->mouse_face_mouse_frame = 0;
6686 /* Generate a nil HELP_EVENT to cancel a help-echo.
6687 Do it only if there's something to cancel.
6688 Otherwise, the startup message is cleared when
6689 the mouse leaves the frame. */
6690 if (any_help_event_p)
6691 do_help = -1;
6693 #ifdef USE_GTK
6694 /* See comment in EnterNotify above */
6695 else if (last_mouse_glyph_frame)
6696 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6697 #endif
6698 goto OTHER;
6700 case FocusOut:
6701 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6702 goto OTHER;
6704 case MotionNotify:
6706 last_user_time = event.xmotion.time;
6707 previous_help_echo_string = help_echo_string;
6708 help_echo_string = Qnil;
6710 if (dpyinfo->grabbed && last_mouse_frame
6711 && FRAME_LIVE_P (last_mouse_frame))
6712 f = last_mouse_frame;
6713 else
6714 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6716 if (dpyinfo->mouse_face_hidden)
6718 dpyinfo->mouse_face_hidden = 0;
6719 clear_mouse_face (dpyinfo);
6722 if (f)
6725 /* Generate SELECT_WINDOW_EVENTs when needed.
6726 Don't let popup menus influence things (bug#1261). */
6727 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6729 Lisp_Object window;
6731 window = window_from_coordinates (f,
6732 event.xmotion.x, event.xmotion.y,
6733 0, 0, 0, 0);
6735 /* Window will be selected only when it is not selected now and
6736 last mouse movement event was not in it. Minibuffer window
6737 will be selected only when it is active. */
6738 if (WINDOWP (window)
6739 && !EQ (window, last_window)
6740 && !EQ (window, selected_window)
6741 /* For click-to-focus window managers
6742 create event iff we don't leave the
6743 selected frame. */
6744 && (focus_follows_mouse
6745 || (EQ (XWINDOW (window)->frame,
6746 XWINDOW (selected_window)->frame))))
6748 inev.ie.kind = SELECT_WINDOW_EVENT;
6749 inev.ie.frame_or_window = window;
6752 last_window=window;
6754 if (!note_mouse_movement (f, &event.xmotion))
6755 help_echo_string = previous_help_echo_string;
6757 else
6759 #ifndef USE_TOOLKIT_SCROLL_BARS
6760 struct scroll_bar *bar
6761 = x_window_to_scroll_bar (event.xmotion.display,
6762 event.xmotion.window);
6764 if (bar)
6765 x_scroll_bar_note_movement (bar, &event);
6766 #endif /* USE_TOOLKIT_SCROLL_BARS */
6768 /* If we move outside the frame, then we're
6769 certainly no longer on any text in the frame. */
6770 clear_mouse_face (dpyinfo);
6773 /* If the contents of the global variable help_echo_string
6774 has changed, generate a HELP_EVENT. */
6775 if (!NILP (help_echo_string)
6776 || !NILP (previous_help_echo_string))
6777 do_help = 1;
6778 goto OTHER;
6781 case ConfigureNotify:
6782 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6783 #ifdef USE_GTK
6784 if (!f
6785 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6786 && event.xconfigure.window == FRAME_X_WINDOW (f))
6788 xg_frame_resized (f, event.xconfigure.width,
6789 event.xconfigure.height);
6790 f = 0;
6792 #endif
6793 if (f)
6795 #ifndef USE_X_TOOLKIT
6796 #ifndef USE_GTK
6797 /* If there is a pending resize for fullscreen, don't
6798 do this one, the right one will come later.
6799 The toolkit version doesn't seem to need this, but we
6800 need to reset it below. */
6801 int dont_resize
6802 = ((f->want_fullscreen & FULLSCREEN_WAIT)
6803 && f->new_text_cols != 0);
6804 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6805 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6807 if (dont_resize)
6808 goto OTHER;
6810 /* In the toolkit version, change_frame_size
6811 is called by the code that handles resizing
6812 of the EmacsFrame widget. */
6814 /* Even if the number of character rows and columns has
6815 not changed, the font size may have changed, so we need
6816 to check the pixel dimensions as well. */
6817 if (columns != FRAME_COLS (f)
6818 || rows != FRAME_LINES (f)
6819 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6820 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6822 change_frame_size (f, rows, columns, 0, 1, 0);
6823 SET_FRAME_GARBAGED (f);
6824 cancel_mouse_face (f);
6827 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6828 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6829 #endif /* not USE_GTK */
6830 #endif
6832 #ifdef USE_GTK
6833 /* GTK creates windows but doesn't map them.
6834 Only get real positions and check fullscreen when mapped. */
6835 if (FRAME_GTK_OUTER_WIDGET (f)
6836 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6837 #endif
6839 x_real_positions (f, &f->left_pos, &f->top_pos);
6841 if (f->want_fullscreen & FULLSCREEN_WAIT)
6842 f->want_fullscreen &= ~(FULLSCREEN_WAIT|FULLSCREEN_BOTH);
6845 #ifdef HAVE_X_I18N
6846 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6847 xic_set_statusarea (f);
6848 #endif
6850 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
6852 /* Since the WM decorations come below top_pos now,
6853 we must put them below top_pos in the future. */
6854 f->win_gravity = NorthWestGravity;
6855 x_wm_set_size_hint (f, (long) 0, 0);
6858 goto OTHER;
6860 case ButtonRelease:
6861 case ButtonPress:
6863 /* If we decide we want to generate an event to be seen
6864 by the rest of Emacs, we put it here. */
6865 int tool_bar_p = 0;
6867 bzero (&compose_status, sizeof (compose_status));
6868 last_mouse_glyph_frame = 0;
6869 last_user_time = event.xbutton.time;
6871 if (dpyinfo->grabbed
6872 && last_mouse_frame
6873 && FRAME_LIVE_P (last_mouse_frame))
6874 f = last_mouse_frame;
6875 else
6876 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6878 if (f)
6880 /* Is this in the tool-bar? */
6881 if (WINDOWP (f->tool_bar_window)
6882 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6884 Lisp_Object window;
6885 int x = event.xbutton.x;
6886 int y = event.xbutton.y;
6888 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6889 tool_bar_p = EQ (window, f->tool_bar_window);
6891 if (tool_bar_p && event.xbutton.button < 4)
6893 handle_tool_bar_click (f, x, y,
6894 event.xbutton.type == ButtonPress,
6895 x_x_to_emacs_modifiers (dpyinfo,
6896 event.xbutton.state));
6900 if (!tool_bar_p)
6901 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6902 if (! popup_activated ())
6903 #endif
6905 if (ignore_next_mouse_click_timeout)
6907 if (event.type == ButtonPress
6908 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6910 ignore_next_mouse_click_timeout = 0;
6911 construct_mouse_click (&inev.ie, &event.xbutton, f);
6913 if (event.type == ButtonRelease)
6914 ignore_next_mouse_click_timeout = 0;
6916 else
6917 construct_mouse_click (&inev.ie, &event.xbutton, f);
6919 if (FRAME_X_EMBEDDED_P (f))
6920 xembed_send_message (f, event.xbutton.time,
6921 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6923 else
6925 struct scroll_bar *bar
6926 = x_window_to_scroll_bar (event.xbutton.display,
6927 event.xbutton.window);
6929 #ifdef USE_TOOLKIT_SCROLL_BARS
6930 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6931 scroll bars. */
6932 if (bar && event.xbutton.state & ControlMask)
6934 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6935 *finish = X_EVENT_DROP;
6937 #else /* not USE_TOOLKIT_SCROLL_BARS */
6938 if (bar)
6939 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6940 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6943 if (event.type == ButtonPress)
6945 dpyinfo->grabbed |= (1 << event.xbutton.button);
6946 last_mouse_frame = f;
6948 if (!tool_bar_p)
6949 last_tool_bar_item = -1;
6951 else
6952 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6954 /* Ignore any mouse motion that happened before this event;
6955 any subsequent mouse-movement Emacs events should reflect
6956 only motion after the ButtonPress/Release. */
6957 if (f != 0)
6958 f->mouse_moved = 0;
6960 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6961 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6962 /* For a down-event in the menu bar,
6963 don't pass it to Xt right now.
6964 Instead, save it away
6965 and we will pass it to Xt from kbd_buffer_get_event.
6966 That way, we can run some Lisp code first. */
6967 if (
6968 #ifdef USE_GTK
6969 ! popup_activated ()
6970 /* Gtk+ menus only react to the first three buttons. */
6971 && event.xbutton.button < 3
6973 #endif
6974 f && event.type == ButtonPress
6975 /* Verify the event is really within the menu bar
6976 and not just sent to it due to grabbing. */
6977 && event.xbutton.x >= 0
6978 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6979 && event.xbutton.y >= 0
6980 && event.xbutton.y < f->output_data.x->menubar_height
6981 && event.xbutton.same_screen)
6983 SET_SAVED_BUTTON_EVENT;
6984 XSETFRAME (last_mouse_press_frame, f);
6985 #ifdef USE_GTK
6986 *finish = X_EVENT_DROP;
6987 #endif
6989 else if (event.type == ButtonPress)
6991 last_mouse_press_frame = Qnil;
6992 goto OTHER;
6995 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6996 but I am trying to be cautious. */
6997 else if (event.type == ButtonRelease)
6999 if (!NILP (last_mouse_press_frame))
7001 f = XFRAME (last_mouse_press_frame);
7002 if (f->output_data.x)
7003 SET_SAVED_BUTTON_EVENT;
7005 else
7006 goto OTHER;
7008 #endif /* USE_MOTIF */
7009 else
7010 goto OTHER;
7011 #endif /* USE_X_TOOLKIT || USE_GTK */
7013 break;
7015 case CirculateNotify:
7016 goto OTHER;
7018 case CirculateRequest:
7019 goto OTHER;
7021 case VisibilityNotify:
7022 goto OTHER;
7024 case MappingNotify:
7025 /* Someone has changed the keyboard mapping - update the
7026 local cache. */
7027 switch (event.xmapping.request)
7029 case MappingModifier:
7030 x_find_modifier_meanings (dpyinfo);
7031 /* This is meant to fall through. */
7032 case MappingKeyboard:
7033 XRefreshKeyboardMapping (&event.xmapping);
7035 goto OTHER;
7037 default:
7038 OTHER:
7039 #ifdef USE_X_TOOLKIT
7040 BLOCK_INPUT;
7041 if (*finish != X_EVENT_DROP)
7042 XtDispatchEvent (&event);
7043 UNBLOCK_INPUT;
7044 #endif /* USE_X_TOOLKIT */
7045 break;
7048 done:
7049 if (inev.ie.kind != NO_EVENT)
7051 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7052 count++;
7055 if (do_help
7056 && !(hold_quit && hold_quit->kind != NO_EVENT))
7058 Lisp_Object frame;
7060 if (f)
7061 XSETFRAME (frame, f);
7062 else
7063 frame = Qnil;
7065 if (do_help > 0)
7067 any_help_event_p = 1;
7068 gen_help_event (help_echo_string, frame, help_echo_window,
7069 help_echo_object, help_echo_pos);
7071 else
7073 help_echo_string = Qnil;
7074 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7076 count++;
7079 *eventp = event;
7080 return count;
7084 /* Handles the XEvent EVENT on display DISPLAY.
7085 This is used for event loops outside the normal event handling,
7086 i.e. looping while a popup menu or a dialog is posted.
7088 Returns the value handle_one_xevent sets in the finish argument. */
7090 x_dispatch_event (event, display)
7091 XEvent *event;
7092 Display *display;
7094 struct x_display_info *dpyinfo;
7095 int finish = X_EVENT_NORMAL;
7097 dpyinfo = x_display_info_for_display (display);
7099 if (dpyinfo)
7100 handle_one_xevent (dpyinfo, event, &finish, 0);
7102 return finish;
7106 /* Read events coming from the X server.
7107 This routine is called by the SIGIO handler.
7108 We return as soon as there are no more events to be read.
7110 We return the number of characters stored into the buffer,
7111 thus pretending to be `read' (except the characters we store
7112 in the keyboard buffer can be multibyte, so are not necessarily
7113 C chars).
7115 EXPECTED is nonzero if the caller knows input is available. */
7117 static int
7118 XTread_socket (terminal, expected, hold_quit)
7119 struct terminal *terminal;
7120 int expected;
7121 struct input_event *hold_quit;
7123 int count = 0;
7124 XEvent event;
7125 int event_found = 0;
7126 #if 0
7127 struct x_display_info *dpyinfo;
7128 #endif
7130 if (interrupt_input_blocked)
7132 interrupt_input_pending = 1;
7133 return -1;
7136 interrupt_input_pending = 0;
7137 BLOCK_INPUT;
7139 /* So people can tell when we have read the available input. */
7140 input_signal_count++;
7142 ++handling_signal;
7144 #ifdef HAVE_X_SM
7145 /* Only check session manager input for the primary display. */
7146 if (terminal->id == 1 && x_session_have_connection ())
7148 struct input_event inev;
7149 BLOCK_INPUT;
7150 /* We don't need to EVENT_INIT (inev) here, as
7151 x_session_check_input copies an entire input_event. */
7152 if (x_session_check_input (&inev))
7154 kbd_buffer_store_event_hold (&inev, hold_quit);
7155 count++;
7157 UNBLOCK_INPUT;
7159 #endif
7161 /* For debugging, this gives a way to fake an I/O error. */
7162 if (terminal->display_info.x == XTread_socket_fake_io_error)
7164 XTread_socket_fake_io_error = 0;
7165 x_io_error_quitter (terminal->display_info.x->display);
7168 #if 0 /* This loop is a noop now. */
7169 /* Find the display we are supposed to read input for.
7170 It's the one communicating on descriptor SD. */
7171 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
7173 #if 0 /* This ought to be unnecessary; let's verify it. */
7174 #ifdef FIOSNBIO
7175 /* If available, Xlib uses FIOSNBIO to make the socket
7176 non-blocking, and then looks for EWOULDBLOCK. If O_NDELAY is set,
7177 FIOSNBIO is ignored, and instead of signaling EWOULDBLOCK,
7178 a read returns 0, which Xlib interprets as equivalent to EPIPE. */
7179 fcntl (dpyinfo->connection, F_SETFL, 0);
7180 #endif /* ! defined (FIOSNBIO) */
7181 #endif
7183 #if 0 /* This code can't be made to work, with multiple displays,
7184 and appears not to be used on any system any more.
7185 Also keyboard.c doesn't turn O_NDELAY on and off
7186 for X connections. */
7187 #ifndef SIGIO
7188 #ifndef HAVE_SELECT
7189 if (! (fcntl (dpyinfo->connection, F_GETFL, 0) & O_NDELAY))
7191 extern int read_alarm_should_throw;
7192 read_alarm_should_throw = 1;
7193 XPeekEvent (dpyinfo->display, &event);
7194 read_alarm_should_throw = 0;
7196 #endif /* HAVE_SELECT */
7197 #endif /* SIGIO */
7198 #endif
7200 #endif
7202 #ifndef USE_GTK
7203 while (XPending (terminal->display_info.x->display))
7205 int finish;
7207 XNextEvent (terminal->display_info.x->display, &event);
7209 #ifdef HAVE_X_I18N
7210 /* Filter events for the current X input method. */
7211 if (x_filter_event (terminal->display_info.x, &event))
7212 break;
7213 #endif
7214 event_found = 1;
7216 count += handle_one_xevent (terminal->display_info.x,
7217 &event, &finish, hold_quit);
7219 if (finish == X_EVENT_GOTO_OUT)
7220 goto out;
7223 #else /* USE_GTK */
7225 /* For GTK we must use the GTK event loop. But XEvents gets passed
7226 to our filter function above, and then to the big event switch.
7227 We use a bunch of globals to communicate with our filter function,
7228 that is kind of ugly, but it works.
7230 There is no way to do one display at the time, GTK just does events
7231 from all displays. */
7233 while (gtk_events_pending ())
7235 current_count = count;
7236 current_hold_quit = hold_quit;
7238 gtk_main_iteration ();
7240 count = current_count;
7241 current_count = -1;
7242 current_hold_quit = 0;
7244 if (current_finish == X_EVENT_GOTO_OUT)
7245 break;
7247 #endif /* USE_GTK */
7249 out:;
7251 /* On some systems, an X bug causes Emacs to get no more events
7252 when the window is destroyed. Detect that. (1994.) */
7253 if (! event_found)
7255 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7256 One XNOOP in 100 loops will make Emacs terminate.
7257 B. Bretthauer, 1994 */
7258 x_noop_count++;
7259 if (x_noop_count >= 100)
7261 x_noop_count=0;
7263 if (next_noop_dpyinfo == 0)
7264 next_noop_dpyinfo = x_display_list;
7266 XNoOp (next_noop_dpyinfo->display);
7268 /* Each time we get here, cycle through the displays now open. */
7269 next_noop_dpyinfo = next_noop_dpyinfo->next;
7273 /* If the focus was just given to an auto-raising frame,
7274 raise it now. */
7275 /* ??? This ought to be able to handle more than one such frame. */
7276 if (pending_autoraise_frame)
7278 x_raise_frame (pending_autoraise_frame);
7279 pending_autoraise_frame = 0;
7282 --handling_signal;
7283 UNBLOCK_INPUT;
7285 return count;
7291 /***********************************************************************
7292 Text Cursor
7293 ***********************************************************************/
7295 /* Set clipping for output in glyph row ROW. W is the window in which
7296 we operate. GC is the graphics context to set clipping in.
7298 ROW may be a text row or, e.g., a mode line. Text rows must be
7299 clipped to the interior of the window dedicated to text display,
7300 mode lines must be clipped to the whole window. */
7302 static void
7303 x_clip_to_row (w, row, area, gc)
7304 struct window *w;
7305 struct glyph_row *row;
7306 int area;
7307 GC gc;
7309 struct frame *f = XFRAME (WINDOW_FRAME (w));
7310 XRectangle clip_rect;
7311 int window_x, window_y, window_width;
7313 window_box (w, area, &window_x, &window_y, &window_width, 0);
7315 clip_rect.x = window_x;
7316 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7317 clip_rect.y = max (clip_rect.y, window_y);
7318 clip_rect.width = window_width;
7319 clip_rect.height = row->visible_height;
7321 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7325 /* Draw a hollow box cursor on window W in glyph row ROW. */
7327 static void
7328 x_draw_hollow_cursor (w, row)
7329 struct window *w;
7330 struct glyph_row *row;
7332 struct frame *f = XFRAME (WINDOW_FRAME (w));
7333 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7334 Display *dpy = FRAME_X_DISPLAY (f);
7335 int x, y, wd, h;
7336 XGCValues xgcv;
7337 struct glyph *cursor_glyph;
7338 GC gc;
7340 /* Get the glyph the cursor is on. If we can't tell because
7341 the current matrix is invalid or such, give up. */
7342 cursor_glyph = get_phys_cursor_glyph (w);
7343 if (cursor_glyph == NULL)
7344 return;
7346 /* Compute frame-relative coordinates for phys cursor. */
7347 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7348 wd = w->phys_cursor_width;
7350 /* The foreground of cursor_gc is typically the same as the normal
7351 background color, which can cause the cursor box to be invisible. */
7352 xgcv.foreground = f->output_data.x->cursor_pixel;
7353 if (dpyinfo->scratch_cursor_gc)
7354 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7355 else
7356 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7357 GCForeground, &xgcv);
7358 gc = dpyinfo->scratch_cursor_gc;
7360 /* Set clipping, draw the rectangle, and reset clipping again. */
7361 x_clip_to_row (w, row, TEXT_AREA, gc);
7362 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7363 XSetClipMask (dpy, gc, None);
7367 /* Draw a bar cursor on window W in glyph row ROW.
7369 Implementation note: One would like to draw a bar cursor with an
7370 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7371 Unfortunately, I didn't find a font yet that has this property set.
7372 --gerd. */
7374 static void
7375 x_draw_bar_cursor (w, row, width, kind)
7376 struct window *w;
7377 struct glyph_row *row;
7378 int width;
7379 enum text_cursor_kinds kind;
7381 struct frame *f = XFRAME (w->frame);
7382 struct glyph *cursor_glyph;
7384 /* If cursor is out of bounds, don't draw garbage. This can happen
7385 in mini-buffer windows when switching between echo area glyphs
7386 and mini-buffer. */
7387 cursor_glyph = get_phys_cursor_glyph (w);
7388 if (cursor_glyph == NULL)
7389 return;
7391 /* If on an image, draw like a normal cursor. That's usually better
7392 visible than drawing a bar, esp. if the image is large so that
7393 the bar might not be in the window. */
7394 if (cursor_glyph->type == IMAGE_GLYPH)
7396 struct glyph_row *row;
7397 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7398 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7400 else
7402 Display *dpy = FRAME_X_DISPLAY (f);
7403 Window window = FRAME_X_WINDOW (f);
7404 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7405 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7406 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7407 XGCValues xgcv;
7409 /* If the glyph's background equals the color we normally draw
7410 the bar cursor in, the bar cursor in its normal color is
7411 invisible. Use the glyph's foreground color instead in this
7412 case, on the assumption that the glyph's colors are chosen so
7413 that the glyph is legible. */
7414 if (face->background == f->output_data.x->cursor_pixel)
7415 xgcv.background = xgcv.foreground = face->foreground;
7416 else
7417 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7418 xgcv.graphics_exposures = 0;
7420 if (gc)
7421 XChangeGC (dpy, gc, mask, &xgcv);
7422 else
7424 gc = XCreateGC (dpy, window, mask, &xgcv);
7425 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7428 if (width < 0)
7429 width = FRAME_CURSOR_WIDTH (f);
7430 width = min (cursor_glyph->pixel_width, width);
7432 w->phys_cursor_width = width;
7433 x_clip_to_row (w, row, TEXT_AREA, gc);
7435 if (kind == BAR_CURSOR)
7436 XFillRectangle (dpy, window, gc,
7437 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7438 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7439 width, row->height);
7440 else
7441 XFillRectangle (dpy, window, gc,
7442 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7443 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7444 row->height - width),
7445 min (FRAME_COLUMN_WIDTH (f), cursor_glyph->pixel_width),
7446 width);
7448 XSetClipMask (dpy, gc, None);
7453 /* RIF: Define cursor CURSOR on frame F. */
7455 static void
7456 x_define_frame_cursor (f, cursor)
7457 struct frame *f;
7458 Cursor cursor;
7460 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7464 /* RIF: Clear area on frame F. */
7466 static void
7467 x_clear_frame_area (f, x, y, width, height)
7468 struct frame *f;
7469 int x, y, width, height;
7471 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7472 x, y, width, height, False);
7476 /* RIF: Draw cursor on window W. */
7478 static void
7479 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7480 struct window *w;
7481 struct glyph_row *glyph_row;
7482 int x, y;
7483 int cursor_type, cursor_width;
7484 int on_p, active_p;
7486 struct frame *f = XFRAME (WINDOW_FRAME (w));
7488 if (on_p)
7490 w->phys_cursor_type = cursor_type;
7491 w->phys_cursor_on_p = 1;
7493 if (glyph_row->exact_window_width_line_p
7494 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7496 glyph_row->cursor_in_fringe_p = 1;
7497 draw_fringe_bitmap (w, glyph_row, 0);
7499 else
7500 switch (cursor_type)
7502 case HOLLOW_BOX_CURSOR:
7503 x_draw_hollow_cursor (w, glyph_row);
7504 break;
7506 case FILLED_BOX_CURSOR:
7507 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7508 break;
7510 case BAR_CURSOR:
7511 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7512 break;
7514 case HBAR_CURSOR:
7515 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7516 break;
7518 case NO_CURSOR:
7519 w->phys_cursor_width = 0;
7520 break;
7522 default:
7523 abort ();
7526 #ifdef HAVE_X_I18N
7527 if (w == XWINDOW (f->selected_window))
7528 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7529 xic_set_preeditarea (w, x, y);
7530 #endif
7533 #ifndef XFlush
7534 XFlush (FRAME_X_DISPLAY (f));
7535 #endif
7539 /* Icons. */
7541 /* Make the x-window of frame F use the gnu icon bitmap. */
7544 x_bitmap_icon (f, file)
7545 struct frame *f;
7546 Lisp_Object file;
7548 int bitmap_id;
7550 if (FRAME_X_WINDOW (f) == 0)
7551 return 1;
7553 /* Free up our existing icon bitmap and mask if any. */
7554 if (f->output_data.x->icon_bitmap > 0)
7555 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7556 f->output_data.x->icon_bitmap = 0;
7558 if (STRINGP (file))
7560 #ifdef USE_GTK
7561 /* Use gtk_window_set_icon_from_file () if available,
7562 It's not restricted to bitmaps */
7563 if (xg_set_icon (f, file))
7564 return 0;
7565 #endif /* USE_GTK */
7566 bitmap_id = x_create_bitmap_from_file (f, file);
7567 x_create_bitmap_mask (f, bitmap_id);
7569 else
7571 /* Create the GNU bitmap and mask if necessary. */
7572 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7574 int rc = -1;
7576 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7577 #ifdef USE_GTK
7578 if (xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7579 return 0;
7580 #else
7581 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7582 if (rc != -1)
7583 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7584 #endif /* USE_GTK */
7585 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
7587 /* If all else fails, use the (black and white) xbm image. */
7588 if (rc == -1)
7590 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7591 gnu_xbm_width, gnu_xbm_height);
7592 if (rc == -1)
7593 return 1;
7595 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7596 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7600 /* The first time we create the GNU bitmap and mask,
7601 this increments the ref-count one extra time.
7602 As a result, the GNU bitmap and mask are never freed.
7603 That way, we don't have to worry about allocating it again. */
7604 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7606 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7609 x_wm_set_icon_pixmap (f, bitmap_id);
7610 f->output_data.x->icon_bitmap = bitmap_id;
7612 return 0;
7616 /* Make the x-window of frame F use a rectangle with text.
7617 Use ICON_NAME as the text. */
7620 x_text_icon (f, icon_name)
7621 struct frame *f;
7622 char *icon_name;
7624 if (FRAME_X_WINDOW (f) == 0)
7625 return 1;
7628 XTextProperty text;
7629 text.value = (unsigned char *) icon_name;
7630 text.encoding = XA_STRING;
7631 text.format = 8;
7632 text.nitems = strlen (icon_name);
7633 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7636 if (f->output_data.x->icon_bitmap > 0)
7637 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7638 f->output_data.x->icon_bitmap = 0;
7639 x_wm_set_icon_pixmap (f, 0);
7641 return 0;
7644 #define X_ERROR_MESSAGE_SIZE 200
7646 /* If non-nil, this should be a string.
7647 It means catch X errors and store the error message in this string.
7649 The reason we use a stack is that x_catch_error/x_uncatch_error can
7650 be called from a signal handler.
7653 struct x_error_message_stack {
7654 char string[X_ERROR_MESSAGE_SIZE];
7655 Display *dpy;
7656 struct x_error_message_stack *prev;
7658 static struct x_error_message_stack *x_error_message;
7660 /* An X error handler which stores the error message in
7661 *x_error_message. This is called from x_error_handler if
7662 x_catch_errors is in effect. */
7664 static void
7665 x_error_catcher (display, error)
7666 Display *display;
7667 XErrorEvent *error;
7669 XGetErrorText (display, error->error_code,
7670 x_error_message->string,
7671 X_ERROR_MESSAGE_SIZE);
7674 /* Begin trapping X errors for display DPY. Actually we trap X errors
7675 for all displays, but DPY should be the display you are actually
7676 operating on.
7678 After calling this function, X protocol errors no longer cause
7679 Emacs to exit; instead, they are recorded in the string
7680 stored in *x_error_message.
7682 Calling x_check_errors signals an Emacs error if an X error has
7683 occurred since the last call to x_catch_errors or x_check_errors.
7685 Calling x_uncatch_errors resumes the normal error handling. */
7687 void x_check_errors ();
7689 void
7690 x_catch_errors (dpy)
7691 Display *dpy;
7693 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7695 /* Make sure any errors from previous requests have been dealt with. */
7696 XSync (dpy, False);
7698 data->dpy = dpy;
7699 data->string[0] = 0;
7700 data->prev = x_error_message;
7701 x_error_message = data;
7704 /* Undo the last x_catch_errors call.
7705 DPY should be the display that was passed to x_catch_errors. */
7707 void
7708 x_uncatch_errors ()
7710 struct x_error_message_stack *tmp;
7712 BLOCK_INPUT;
7714 /* The display may have been closed before this function is called.
7715 Check if it is still open before calling XSync. */
7716 if (x_display_info_for_display (x_error_message->dpy) != 0)
7717 XSync (x_error_message->dpy, False);
7719 tmp = x_error_message;
7720 x_error_message = x_error_message->prev;
7721 xfree (tmp);
7722 UNBLOCK_INPUT;
7725 /* If any X protocol errors have arrived since the last call to
7726 x_catch_errors or x_check_errors, signal an Emacs error using
7727 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7729 void
7730 x_check_errors (dpy, format)
7731 Display *dpy;
7732 char *format;
7734 /* Make sure to catch any errors incurred so far. */
7735 XSync (dpy, False);
7737 if (x_error_message->string[0])
7739 char string[X_ERROR_MESSAGE_SIZE];
7740 bcopy (x_error_message->string, string, X_ERROR_MESSAGE_SIZE);
7741 x_uncatch_errors ();
7742 error (format, string);
7746 /* Nonzero if we had any X protocol errors
7747 since we did x_catch_errors on DPY. */
7750 x_had_errors_p (dpy)
7751 Display *dpy;
7753 /* Make sure to catch any errors incurred so far. */
7754 XSync (dpy, False);
7756 return x_error_message->string[0] != 0;
7759 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7761 void
7762 x_clear_errors (dpy)
7763 Display *dpy;
7765 x_error_message->string[0] = 0;
7768 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7769 * idea. --lorentey */
7770 /* Close off all unclosed x_catch_errors calls. */
7772 void
7773 x_fully_uncatch_errors ()
7775 while (x_error_message)
7776 x_uncatch_errors ();
7778 #endif
7780 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7783 x_catching_errors ()
7785 return x_error_message != 0;
7788 #if 0
7789 static unsigned int x_wire_count;
7790 x_trace_wire ()
7792 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7794 #endif /* ! 0 */
7797 /* Handle SIGPIPE, which can happen when the connection to a server
7798 simply goes away. SIGPIPE is handled by x_connection_signal.
7799 Don't need to do anything, because the write which caused the
7800 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7801 which will do the appropriate cleanup for us. */
7803 static SIGTYPE
7804 x_connection_signal (signalnum) /* If we don't have an argument, */
7805 int signalnum; /* some compilers complain in signal calls. */
7807 #ifdef USG
7808 /* USG systems forget handlers when they are used;
7809 must reestablish each time */
7810 signal (signalnum, x_connection_signal);
7811 #endif /* USG */
7815 /************************************************************************
7816 Handling X errors
7817 ************************************************************************/
7819 /* Error message passed to x_connection_closed. */
7821 static char *error_msg;
7823 /* Function installed as fatal_error_signal_hook in
7824 x_connection_closed. Print the X error message, and exit normally,
7825 instead of dumping core when XtCloseDisplay fails. */
7827 static void
7828 x_fatal_error_signal ()
7830 fprintf (stderr, "%s\n", error_msg);
7831 exit (70);
7834 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7835 the text of an error message that lead to the connection loss. */
7837 static SIGTYPE
7838 x_connection_closed (dpy, error_message)
7839 Display *dpy;
7840 char *error_message;
7842 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7843 Lisp_Object frame, tail;
7844 int index = SPECPDL_INDEX ();
7846 error_msg = (char *) alloca (strlen (error_message) + 1);
7847 strcpy (error_msg, error_message);
7848 handling_signal = 0;
7850 /* Prevent being called recursively because of an error condition
7851 below. Otherwise, we might end up with printing ``can't find per
7852 display information'' in the recursive call instead of printing
7853 the original message here. */
7854 x_catch_errors (dpy);
7856 /* Inhibit redisplay while frames are being deleted. */
7857 specbind (Qinhibit_redisplay, Qt);
7859 if (dpyinfo)
7861 /* Protect display from being closed when we delete the last
7862 frame on it. */
7863 dpyinfo->reference_count++;
7864 dpyinfo->terminal->reference_count++;
7867 /* First delete frames whose mini-buffers are on frames
7868 that are on the dead display. */
7869 FOR_EACH_FRAME (tail, frame)
7871 Lisp_Object minibuf_frame;
7872 minibuf_frame
7873 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7874 if (FRAME_X_P (XFRAME (frame))
7875 && FRAME_X_P (XFRAME (minibuf_frame))
7876 && ! EQ (frame, minibuf_frame)
7877 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7878 Fdelete_frame (frame, Qnoelisp);
7881 /* Now delete all remaining frames on the dead display.
7882 We are now sure none of these is used as the mini-buffer
7883 for another frame that we need to delete. */
7884 FOR_EACH_FRAME (tail, frame)
7885 if (FRAME_X_P (XFRAME (frame))
7886 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7888 /* Set this to t so that Fdelete_frame won't get confused
7889 trying to find a replacement. */
7890 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7891 Fdelete_frame (frame, Qnoelisp);
7894 /* We have to close the display to inform Xt that it doesn't
7895 exist anymore. If we don't, Xt will continue to wait for
7896 events from the display. As a consequence, a sequence of
7898 M-x make-frame-on-display RET :1 RET
7899 ...kill the new frame, so that we get an IO error...
7900 M-x make-frame-on-display RET :1 RET
7902 will indefinitely wait in Xt for events for display `:1', opened
7903 in the first call to make-frame-on-display.
7905 Closing the display is reported to lead to a bus error on
7906 OpenWindows in certain situations. I suspect that is a bug
7907 in OpenWindows. I don't know how to circumvent it here. */
7909 if (dpyinfo)
7911 #ifdef USE_X_TOOLKIT
7912 /* If DPYINFO is null, this means we didn't open the display
7913 in the first place, so don't try to close it. */
7915 extern void (*fatal_error_signal_hook) P_ ((void));
7916 fatal_error_signal_hook = x_fatal_error_signal;
7917 XtCloseDisplay (dpy);
7918 fatal_error_signal_hook = NULL;
7920 #endif
7922 #ifdef USE_GTK
7923 /* Due to bugs in some Gtk+ versions, just exit here if this
7924 is the last display/terminal. */
7925 if (terminal_list->next_terminal == NULL)
7927 fprintf (stderr, "%s\n", error_msg);
7928 shut_down_emacs (0, 0, Qnil);
7929 exit (70);
7931 xg_display_close (dpyinfo->display);
7932 #endif
7934 /* Indicate that this display is dead. */
7935 dpyinfo->display = 0;
7937 dpyinfo->reference_count--;
7938 dpyinfo->terminal->reference_count--;
7939 if (dpyinfo->reference_count != 0)
7940 /* We have just closed all frames on this display. */
7941 abort ();
7944 Lisp_Object tmp;
7945 XSETTERMINAL (tmp, dpyinfo->terminal);
7946 Fdelete_terminal (tmp, Qnoelisp);
7950 x_uncatch_errors ();
7952 if (terminal_list == 0)
7954 fprintf (stderr, "%s\n", error_msg);
7955 shut_down_emacs (0, 0, Qnil);
7956 exit (70);
7959 /* Ordinary stack unwind doesn't deal with these. */
7960 #ifdef SIGIO
7961 sigunblock (sigmask (SIGIO));
7962 #endif
7963 sigunblock (sigmask (SIGALRM));
7964 TOTALLY_UNBLOCK_INPUT;
7966 unbind_to (index, Qnil);
7967 clear_waiting_for_input ();
7968 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7969 longjmp), because returning from this function would get us back into
7970 Xlib's code which will directly call `exit'. */
7971 error ("%s", error_msg);
7974 /* We specifically use it before defining it, so that gcc doesn't inline it,
7975 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7976 static void x_error_quitter P_ ((Display *, XErrorEvent *));
7978 /* This is the first-level handler for X protocol errors.
7979 It calls x_error_quitter or x_error_catcher. */
7981 static int
7982 x_error_handler (display, error)
7983 Display *display;
7984 XErrorEvent *error;
7986 if (x_error_message)
7987 x_error_catcher (display, error);
7988 else
7989 x_error_quitter (display, error);
7990 return 0;
7993 /* This is the usual handler for X protocol errors.
7994 It kills all frames on the display that we got the error for.
7995 If that was the only one, it prints an error message and kills Emacs. */
7997 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7999 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
8000 #define NO_INLINE __attribute__((noinline))
8001 #else
8002 #define NO_INLINE
8003 #endif
8005 /* Some versions of GNU/Linux define noinline in their headers. */
8007 #ifdef noinline
8008 #undef noinline
8009 #endif
8011 /* On older GCC versions, just putting x_error_quitter
8012 after x_error_handler prevents inlining into the former. */
8014 static void NO_INLINE
8015 x_error_quitter (display, error)
8016 Display *display;
8017 XErrorEvent *error;
8019 char buf[256], buf1[356];
8021 /* Ignore BadName errors. They can happen because of fonts
8022 or colors that are not defined. */
8024 if (error->error_code == BadName)
8025 return;
8027 /* Note that there is no real way portable across R3/R4 to get the
8028 original error handler. */
8030 XGetErrorText (display, error->error_code, buf, sizeof (buf));
8031 sprintf (buf1, "X protocol error: %s on protocol request %d",
8032 buf, error->request_code);
8033 x_connection_closed (display, buf1);
8037 /* This is the handler for X IO errors, always.
8038 It kills all frames on the display that we lost touch with.
8039 If that was the only one, it prints an error message and kills Emacs. */
8041 static int
8042 x_io_error_quitter (display)
8043 Display *display;
8045 char buf[256];
8047 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
8048 x_connection_closed (display, buf);
8049 return 0;
8052 /* Changing the font of the frame. */
8054 /* Give frame F the font FONT-OBJECT as its default font. The return
8055 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
8056 frame. If it is negative, generate a new fontset from
8057 FONT-OBJECT. */
8059 Lisp_Object
8060 x_new_font (f, font_object, fontset)
8061 struct frame *f;
8062 Lisp_Object font_object;
8063 int fontset;
8065 struct font *font = XFONT_OBJECT (font_object);
8067 if (fontset < 0)
8068 fontset = fontset_from_font (font_object);
8069 FRAME_FONTSET (f) = fontset;
8070 if (FRAME_FONT (f) == font)
8071 /* This font is already set in frame F. There's nothing more to
8072 do. */
8073 return font_object;
8075 FRAME_FONT (f) = font;
8076 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
8077 FRAME_COLUMN_WIDTH (f) = font->average_width;
8078 FRAME_SPACE_WIDTH (f) = font->space_width;
8079 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
8081 compute_fringe_widths (f, 1);
8083 /* Compute the scroll bar width in character columns. */
8084 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
8086 int wid = FRAME_COLUMN_WIDTH (f);
8087 FRAME_CONFIG_SCROLL_BAR_COLS (f)
8088 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
8090 else
8092 int wid = FRAME_COLUMN_WIDTH (f);
8093 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
8096 if (FRAME_X_WINDOW (f) != 0)
8098 /* Don't change the size of a tip frame; there's no point in
8099 doing it because it's done in Fx_show_tip, and it leads to
8100 problems because the tip frame has no widget. */
8101 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8102 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
8105 #ifdef HAVE_X_I18N
8106 if (FRAME_XIC (f)
8107 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
8109 BLOCK_INPUT;
8110 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
8111 UNBLOCK_INPUT;
8113 #endif
8115 return font_object;
8119 /***********************************************************************
8120 X Input Methods
8121 ***********************************************************************/
8123 #ifdef HAVE_X_I18N
8125 #ifdef HAVE_X11R6
8127 /* XIM destroy callback function, which is called whenever the
8128 connection to input method XIM dies. CLIENT_DATA contains a
8129 pointer to the x_display_info structure corresponding to XIM. */
8131 static void
8132 xim_destroy_callback (xim, client_data, call_data)
8133 XIM xim;
8134 XPointer client_data;
8135 XPointer call_data;
8137 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8138 Lisp_Object frame, tail;
8140 BLOCK_INPUT;
8142 /* No need to call XDestroyIC.. */
8143 FOR_EACH_FRAME (tail, frame)
8145 struct frame *f = XFRAME (frame);
8146 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8148 FRAME_XIC (f) = NULL;
8149 xic_free_xfontset (f);
8153 /* No need to call XCloseIM. */
8154 dpyinfo->xim = NULL;
8155 XFree (dpyinfo->xim_styles);
8156 UNBLOCK_INPUT;
8159 #endif /* HAVE_X11R6 */
8161 #ifdef HAVE_X11R6
8162 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8163 extern char *XSetIMValues P_ ((XIM, ...));
8164 #endif
8166 /* Open the connection to the XIM server on display DPYINFO.
8167 RESOURCE_NAME is the resource name Emacs uses. */
8169 static void
8170 xim_open_dpy (dpyinfo, resource_name)
8171 struct x_display_info *dpyinfo;
8172 char *resource_name;
8174 XIM xim;
8176 #ifdef HAVE_XIM
8177 if (use_xim)
8179 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8180 EMACS_CLASS);
8181 dpyinfo->xim = xim;
8183 if (xim)
8185 #ifdef HAVE_X11R6
8186 XIMCallback destroy;
8187 #endif
8189 /* Get supported styles and XIM values. */
8190 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8192 #ifdef HAVE_X11R6
8193 destroy.callback = xim_destroy_callback;
8194 destroy.client_data = (XPointer)dpyinfo;
8195 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8196 #endif
8200 else
8201 #endif /* HAVE_XIM */
8202 dpyinfo->xim = NULL;
8206 #ifdef HAVE_X11R6_XIM
8208 struct xim_inst_t
8210 struct x_display_info *dpyinfo;
8211 char *resource_name;
8214 /* XIM instantiate callback function, which is called whenever an XIM
8215 server is available. DISPLAY is the display of the XIM.
8216 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8217 when the callback was registered. */
8219 static void
8220 xim_instantiate_callback (display, client_data, call_data)
8221 Display *display;
8222 XPointer client_data;
8223 XPointer call_data;
8225 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8226 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8228 /* We don't support multiple XIM connections. */
8229 if (dpyinfo->xim)
8230 return;
8232 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8234 /* Create XIC for the existing frames on the same display, as long
8235 as they have no XIC. */
8236 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8238 Lisp_Object tail, frame;
8240 BLOCK_INPUT;
8241 FOR_EACH_FRAME (tail, frame)
8243 struct frame *f = XFRAME (frame);
8245 if (FRAME_X_P (f)
8246 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8247 if (FRAME_XIC (f) == NULL)
8249 create_frame_xic (f);
8250 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8251 xic_set_statusarea (f);
8252 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8254 struct window *w = XWINDOW (f->selected_window);
8255 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8260 UNBLOCK_INPUT;
8264 #endif /* HAVE_X11R6_XIM */
8267 /* Open a connection to the XIM server on display DPYINFO.
8268 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8269 connection only at the first time. On X11R6, open the connection
8270 in the XIM instantiate callback function. */
8272 static void
8273 xim_initialize (dpyinfo, resource_name)
8274 struct x_display_info *dpyinfo;
8275 char *resource_name;
8277 #ifdef HAVE_XIM
8278 if (use_xim)
8280 #ifdef HAVE_X11R6_XIM
8281 struct xim_inst_t *xim_inst;
8282 int len;
8284 dpyinfo->xim = NULL;
8285 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8286 xim_inst->dpyinfo = dpyinfo;
8287 len = strlen (resource_name);
8288 xim_inst->resource_name = (char *) xmalloc (len + 1);
8289 bcopy (resource_name, xim_inst->resource_name, len + 1);
8290 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8291 resource_name, EMACS_CLASS,
8292 xim_instantiate_callback,
8293 /* This is XPointer in XFree86
8294 but (XPointer *) on Tru64, at
8295 least, hence the configure test. */
8296 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8297 #else /* not HAVE_X11R6_XIM */
8298 dpyinfo->xim = NULL;
8299 xim_open_dpy (dpyinfo, resource_name);
8300 #endif /* not HAVE_X11R6_XIM */
8303 else
8304 #endif /* HAVE_XIM */
8305 dpyinfo->xim = NULL;
8309 /* Close the connection to the XIM server on display DPYINFO. */
8311 static void
8312 xim_close_dpy (dpyinfo)
8313 struct x_display_info *dpyinfo;
8315 #ifdef HAVE_XIM
8316 if (use_xim)
8318 #ifdef HAVE_X11R6_XIM
8319 if (dpyinfo->display)
8320 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8321 NULL, EMACS_CLASS,
8322 xim_instantiate_callback, NULL);
8323 #else /* not HAVE_X11R6_XIM */
8324 /* If we have X11R6 xim, this causes a double-free. */
8325 if (dpyinfo->display)
8326 XCloseIM (dpyinfo->xim);
8327 #endif /* HAVE_X11R6_XIM */
8328 dpyinfo->xim = NULL;
8329 XFree (dpyinfo->xim_styles);
8331 #endif /* HAVE_XIM */
8334 #endif /* not HAVE_X11R6_XIM */
8338 /* Calculate the absolute position in frame F
8339 from its current recorded position values and gravity. */
8341 void
8342 x_calc_absolute_position (f)
8343 struct frame *f;
8345 int flags = f->size_hint_flags;
8347 /* We have nothing to do if the current position
8348 is already for the top-left corner. */
8349 if (! ((flags & XNegative) || (flags & YNegative)))
8350 return;
8352 /* Treat negative positions as relative to the leftmost bottommost
8353 position that fits on the screen. */
8354 if (flags & XNegative)
8355 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8356 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8359 int height = FRAME_PIXEL_HEIGHT (f);
8361 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8362 /* Something is fishy here. When using Motif, starting Emacs with
8363 `-g -0-0', the frame appears too low by a few pixels.
8365 This seems to be so because initially, while Emacs is starting,
8366 the column widget's height and the frame's pixel height are
8367 different. The column widget's height is the right one. In
8368 later invocations, when Emacs is up, the frame's pixel height
8369 is right, though.
8371 It's not obvious where the initial small difference comes from.
8372 2000-12-01, gerd. */
8374 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8375 #endif
8377 if (flags & YNegative)
8378 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8379 - height + f->top_pos;
8382 /* The left_pos and top_pos
8383 are now relative to the top and left screen edges,
8384 so the flags should correspond. */
8385 f->size_hint_flags &= ~ (XNegative | YNegative);
8388 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8389 to really change the position, and 0 when calling from
8390 x_make_frame_visible (in that case, XOFF and YOFF are the current
8391 position values). It is -1 when calling from x_set_frame_parameters,
8392 which means, do adjust for borders but don't change the gravity. */
8394 void
8395 x_set_offset (f, xoff, yoff, change_gravity)
8396 struct frame *f;
8397 register int xoff, yoff;
8398 int change_gravity;
8400 int modified_top, modified_left;
8402 if (change_gravity > 0)
8404 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8405 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8407 f->top_pos = yoff;
8408 f->left_pos = xoff;
8409 f->size_hint_flags &= ~ (XNegative | YNegative);
8410 if (xoff < 0)
8411 f->size_hint_flags |= XNegative;
8412 if (yoff < 0)
8413 f->size_hint_flags |= YNegative;
8414 f->win_gravity = NorthWestGravity;
8416 x_calc_absolute_position (f);
8418 BLOCK_INPUT;
8419 x_wm_set_size_hint (f, (long) 0, 0);
8421 modified_left = f->left_pos;
8422 modified_top = f->top_pos;
8424 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8426 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8427 than the WM decorations. So we use the calculated offset instead
8428 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8429 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8430 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8433 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8434 modified_left, modified_top);
8436 x_sync_with_move (f, f->left_pos, f->top_pos,
8437 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8438 ? 1 : 0);
8440 /* change_gravity is non-zero when this function is called from Lisp to
8441 programmatically move a frame. In that case, we call
8442 x_check_expected_move to discover if we have a "Type A" or "Type B"
8443 window manager, and, for a "Type A" window manager, adjust the position
8444 of the frame.
8446 We call x_check_expected_move if a programmatic move occurred, and
8447 either the window manager type (A/B) is unknown or it is Type A but we
8448 need to compute the top/left offset adjustment for this frame. */
8450 if (change_gravity != 0 &&
8451 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8452 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8453 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8454 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8455 x_check_expected_move (f, modified_left, modified_top);
8457 UNBLOCK_INPUT;
8460 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8461 on the root window for frame F contains ATOMNAME.
8462 This is how a WM check shall be done according to the Window Manager
8463 Specification/Extended Window Manager Hints at
8464 http://freedesktop.org/wiki/Specifications/wm-spec. */
8466 static int
8467 wm_supports (f, atomname)
8468 struct frame *f;
8469 const char *atomname;
8471 Atom actual_type;
8472 unsigned long actual_size, bytes_remaining;
8473 int i, rc, actual_format;
8474 Atom prop_atom;
8475 Window wmcheck_window;
8476 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8477 Window target_window = dpyinfo->root_window;
8478 long max_len = 65536;
8479 Display *dpy = FRAME_X_DISPLAY (f);
8480 unsigned char *tmp_data = NULL;
8481 Atom target_type = XA_WINDOW;
8482 Atom want_atom;
8484 BLOCK_INPUT;
8486 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8488 x_catch_errors (dpy);
8489 rc = XGetWindowProperty (dpy, target_window,
8490 prop_atom, 0, max_len, False, target_type,
8491 &actual_type, &actual_format, &actual_size,
8492 &bytes_remaining, &tmp_data);
8494 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8496 if (tmp_data) XFree (tmp_data);
8497 x_uncatch_errors ();
8498 UNBLOCK_INPUT;
8499 return 0;
8502 wmcheck_window = *(Window *) tmp_data;
8503 XFree (tmp_data);
8505 /* Check if window exists. */
8506 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8507 x_sync (f);
8508 if (x_had_errors_p (dpy))
8510 x_uncatch_errors ();
8511 UNBLOCK_INPUT;
8512 return 0;
8515 if (dpyinfo->net_supported_window != wmcheck_window)
8517 /* Window changed, reload atoms */
8518 if (dpyinfo->net_supported_atoms != NULL)
8519 XFree (dpyinfo->net_supported_atoms);
8520 dpyinfo->net_supported_atoms = NULL;
8521 dpyinfo->nr_net_supported_atoms = 0;
8522 dpyinfo->net_supported_window = 0;
8524 target_type = XA_ATOM;
8525 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8526 tmp_data = NULL;
8527 rc = XGetWindowProperty (dpy, target_window,
8528 prop_atom, 0, max_len, False, target_type,
8529 &actual_type, &actual_format, &actual_size,
8530 &bytes_remaining, &tmp_data);
8532 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8534 if (tmp_data) XFree (tmp_data);
8535 x_uncatch_errors ();
8536 UNBLOCK_INPUT;
8537 return 0;
8540 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8541 dpyinfo->nr_net_supported_atoms = actual_size;
8542 dpyinfo->net_supported_window = wmcheck_window;
8545 rc = 0;
8546 want_atom = XInternAtom (dpy, atomname, False);
8548 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8549 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8551 x_uncatch_errors ();
8552 UNBLOCK_INPUT;
8554 return rc;
8557 /* Do fullscreen as specified in extended window manager hints */
8559 static int
8560 do_ewmh_fullscreen (f)
8561 struct frame *f;
8563 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8565 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8566 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8567 if (!have_net_atom)
8568 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8570 if (have_net_atom)
8572 Lisp_Object frame;
8573 const char *atom = "_NET_WM_STATE";
8574 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8575 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8576 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8577 const char *what = NULL;
8579 XSETFRAME (frame, f);
8581 /* If there are _NET_ atoms we assume we have extended window manager
8582 hints. */
8583 switch (f->want_fullscreen)
8585 case FULLSCREEN_BOTH:
8586 what = fs;
8587 break;
8588 case FULLSCREEN_WIDTH:
8589 what = fw;
8590 break;
8591 case FULLSCREEN_HEIGHT:
8592 what = fh;
8593 break;
8596 if (what != NULL && !wm_supports (f, what)) return 0;
8599 Fx_send_client_event (frame, make_number (0), frame,
8600 make_unibyte_string (atom, strlen (atom)),
8601 make_number (32),
8602 Fcons (make_number (0), /* Remove */
8603 Fcons
8604 (make_unibyte_string (fs,
8605 strlen (fs)),
8606 Qnil)));
8607 Fx_send_client_event (frame, make_number (0), frame,
8608 make_unibyte_string (atom, strlen (atom)),
8609 make_number (32),
8610 Fcons (make_number (0), /* Remove */
8611 Fcons
8612 (make_unibyte_string (fh,
8613 strlen (fh)),
8614 Qnil)));
8615 Fx_send_client_event (frame, make_number (0), frame,
8616 make_unibyte_string (atom, strlen (atom)),
8617 make_number (32),
8618 Fcons (make_number (0), /* Remove */
8619 Fcons
8620 (make_unibyte_string (fw,
8621 strlen (fw)),
8622 Qnil)));
8623 f->want_fullscreen = FULLSCREEN_NONE;
8624 if (what != NULL)
8625 Fx_send_client_event (frame, make_number (0), frame,
8626 make_unibyte_string (atom, strlen (atom)),
8627 make_number (32),
8628 Fcons (make_number (1), /* Add */
8629 Fcons
8630 (make_unibyte_string (what,
8631 strlen (what)),
8632 Qnil)));
8635 return have_net_atom;
8638 static void
8639 XTfullscreen_hook (f)
8640 FRAME_PTR f;
8642 if (f->async_visible)
8644 BLOCK_INPUT;
8645 do_ewmh_fullscreen (f);
8646 x_sync (f);
8647 UNBLOCK_INPUT;
8652 /* Check if we need to resize the frame due to a fullscreen request.
8653 If so needed, resize the frame. */
8654 static void
8655 x_check_fullscreen (f)
8656 struct frame *f;
8658 if (f->want_fullscreen & FULLSCREEN_BOTH)
8660 int width, height, ign;
8662 if (do_ewmh_fullscreen (f))
8663 return;
8665 x_real_positions (f, &f->left_pos, &f->top_pos);
8667 x_fullscreen_adjust (f, &width, &height, &ign, &ign);
8669 /* We do not need to move the window, it shall be taken care of
8670 when setting WM manager hints.
8671 If the frame is visible already, the position is checked by
8672 x_check_expected_move. */
8673 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8675 change_frame_size (f, height, width, 0, 1, 0);
8676 SET_FRAME_GARBAGED (f);
8677 cancel_mouse_face (f);
8679 /* Wait for the change of frame size to occur */
8680 f->want_fullscreen |= FULLSCREEN_WAIT;
8685 /* This function is called by x_set_offset to determine whether the window
8686 manager interfered with the positioning of the frame. Type A window
8687 managers position the surrounding window manager decorations a small
8688 amount above and left of the user-supplied position. Type B window
8689 managers position the surrounding window manager decorations at the
8690 user-specified position. If we detect a Type A window manager, we
8691 compensate by moving the window right and down by the proper amount. */
8693 static void
8694 x_check_expected_move (f, expected_left, expected_top)
8695 struct frame *f;
8696 int expected_left;
8697 int expected_top;
8699 int current_left = 0, current_top = 0;
8701 /* x_real_positions returns the left and top offsets of the outermost
8702 window manager window around the frame. */
8704 x_real_positions (f, &current_left, &current_top);
8706 if (current_left != expected_left || current_top != expected_top)
8708 /* It's a "Type A" window manager. */
8710 int adjusted_left;
8711 int adjusted_top;
8713 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8714 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8715 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8717 /* Now fix the mispositioned frame's location. */
8719 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8720 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8722 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8723 adjusted_left, adjusted_top);
8725 x_sync_with_move (f, expected_left, expected_top, 0);
8727 else
8728 /* It's a "Type B" window manager. We don't have to adjust the
8729 frame's position. */
8731 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8735 /* Wait for XGetGeometry to return up-to-date position information for a
8736 recently-moved frame. Call this immediately after calling XMoveWindow.
8737 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8738 frame has been moved to, so we use a fuzzy position comparison instead
8739 of an exact comparison. */
8741 static void
8742 x_sync_with_move (f, left, top, fuzzy)
8743 struct frame *f;
8744 int left, top, fuzzy;
8746 int count = 0;
8748 while (count++ < 50)
8750 int current_left = 0, current_top = 0;
8752 /* In theory, this call to XSync only needs to happen once, but in
8753 practice, it doesn't seem to work, hence the need for the surrounding
8754 loop. */
8756 XSync (FRAME_X_DISPLAY (f), False);
8757 x_real_positions (f, &current_left, &current_top);
8759 if (fuzzy)
8761 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8762 pixels. */
8764 if (eabs (current_left - left) <= 10
8765 && eabs (current_top - top) <= 40)
8766 return;
8768 else if (current_left == left && current_top == top)
8769 return;
8772 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8773 will then return up-to-date position info. */
8775 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8779 /* Change the size of frame F's X window to COLS/ROWS in the case F
8780 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8781 top-left-corner window gravity for this size change and subsequent
8782 size changes. Otherwise we leave the window gravity unchanged. */
8784 static void
8785 x_set_window_size_1 (f, change_gravity, cols, rows)
8786 struct frame *f;
8787 int change_gravity;
8788 int cols, rows;
8790 int pixelwidth, pixelheight;
8792 check_frame_size (f, &rows, &cols);
8793 f->scroll_bar_actual_width
8794 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8796 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8797 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8798 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8800 compute_fringe_widths (f, 0);
8802 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8803 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
8805 f->win_gravity = NorthWestGravity;
8806 x_wm_set_size_hint (f, (long) 0, 0);
8808 XSync (FRAME_X_DISPLAY (f), False);
8809 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8810 pixelwidth, pixelheight);
8812 /* Now, strictly speaking, we can't be sure that this is accurate,
8813 but the window manager will get around to dealing with the size
8814 change request eventually, and we'll hear how it went when the
8815 ConfigureNotify event gets here.
8817 We could just not bother storing any of this information here,
8818 and let the ConfigureNotify event set everything up, but that
8819 might be kind of confusing to the Lisp code, since size changes
8820 wouldn't be reported in the frame parameters until some random
8821 point in the future when the ConfigureNotify event arrives.
8823 We pass 1 for DELAY since we can't run Lisp code inside of
8824 a BLOCK_INPUT. */
8825 change_frame_size (f, rows, cols, 0, 1, 0);
8826 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8827 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8829 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8830 receive in the ConfigureNotify event; if we get what we asked
8831 for, then the event won't cause the screen to become garbaged, so
8832 we have to make sure to do it here. */
8833 SET_FRAME_GARBAGED (f);
8835 XFlush (FRAME_X_DISPLAY (f));
8839 /* Call this to change the size of frame F's x-window.
8840 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8841 for this size change and subsequent size changes.
8842 Otherwise we leave the window gravity unchanged. */
8844 void
8845 x_set_window_size (f, change_gravity, cols, rows)
8846 struct frame *f;
8847 int change_gravity;
8848 int cols, rows;
8850 BLOCK_INPUT;
8852 #ifdef USE_GTK
8853 if (FRAME_GTK_WIDGET (f))
8854 xg_frame_set_char_size (f, cols, rows);
8855 else
8856 x_set_window_size_1 (f, change_gravity, cols, rows);
8857 #elif USE_X_TOOLKIT
8859 if (f->output_data.x->widget != NULL)
8861 /* The x and y position of the widget is clobbered by the
8862 call to XtSetValues within EmacsFrameSetCharSize.
8863 This is a real kludge, but I don't understand Xt so I can't
8864 figure out a correct fix. Can anyone else tell me? -- rms. */
8865 int xpos = f->output_data.x->widget->core.x;
8866 int ypos = f->output_data.x->widget->core.y;
8867 EmacsFrameSetCharSize (f->output_data.x->edit_widget, cols, rows);
8868 f->output_data.x->widget->core.x = xpos;
8869 f->output_data.x->widget->core.y = ypos;
8871 else
8872 x_set_window_size_1 (f, change_gravity, cols, rows);
8874 #else /* not USE_X_TOOLKIT */
8876 x_set_window_size_1 (f, change_gravity, cols, rows);
8878 #endif /* not USE_X_TOOLKIT */
8880 /* If cursor was outside the new size, mark it as off. */
8881 mark_window_cursors_off (XWINDOW (f->root_window));
8883 /* Clear out any recollection of where the mouse highlighting was,
8884 since it might be in a place that's outside the new frame size.
8885 Actually checking whether it is outside is a pain in the neck,
8886 so don't try--just let the highlighting be done afresh with new size. */
8887 cancel_mouse_face (f);
8889 UNBLOCK_INPUT;
8892 /* Mouse warping. */
8894 void
8895 x_set_mouse_position (f, x, y)
8896 struct frame *f;
8897 int x, y;
8899 int pix_x, pix_y;
8901 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8902 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8904 if (pix_x < 0) pix_x = 0;
8905 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8907 if (pix_y < 0) pix_y = 0;
8908 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8910 BLOCK_INPUT;
8912 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8913 0, 0, 0, 0, pix_x, pix_y);
8914 UNBLOCK_INPUT;
8917 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8919 void
8920 x_set_mouse_pixel_position (f, pix_x, pix_y)
8921 struct frame *f;
8922 int pix_x, pix_y;
8924 BLOCK_INPUT;
8926 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8927 0, 0, 0, 0, pix_x, pix_y);
8928 UNBLOCK_INPUT;
8931 /* focus shifting, raising and lowering. */
8933 void
8934 x_focus_on_frame (f)
8935 struct frame *f;
8937 #if 0 /* This proves to be unpleasant. */
8938 x_raise_frame (f);
8939 #endif
8940 #if 0
8941 /* I don't think that the ICCCM allows programs to do things like this
8942 without the interaction of the window manager. Whatever you end up
8943 doing with this code, do it to x_unfocus_frame too. */
8944 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8945 RevertToPointerRoot, CurrentTime);
8946 #endif /* ! 0 */
8949 void
8950 x_unfocus_frame (f)
8951 struct frame *f;
8953 #if 0
8954 /* Look at the remarks in x_focus_on_frame. */
8955 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8956 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8957 RevertToPointerRoot, CurrentTime);
8958 #endif /* ! 0 */
8961 /* Raise frame F. */
8963 void
8964 x_raise_frame (f)
8965 struct frame *f;
8967 BLOCK_INPUT;
8968 if (f->async_visible)
8969 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8971 XFlush (FRAME_X_DISPLAY (f));
8972 UNBLOCK_INPUT;
8975 /* Lower frame F. */
8977 void
8978 x_lower_frame (f)
8979 struct frame *f;
8981 if (f->async_visible)
8983 BLOCK_INPUT;
8984 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8985 XFlush (FRAME_X_DISPLAY (f));
8986 UNBLOCK_INPUT;
8990 /* Activate frame with Extended Window Manager Hints */
8992 void
8993 x_ewmh_activate_frame (f)
8994 FRAME_PTR f;
8996 /* See Window Manager Specification/Extended Window Manager Hints at
8997 http://freedesktop.org/wiki/Specifications/wm-spec */
8999 const char *atom = "_NET_ACTIVE_WINDOW";
9000 if (f->async_visible && wm_supports (f, atom))
9002 Lisp_Object frame;
9003 XSETFRAME (frame, f);
9004 Fx_send_client_event (frame, make_number (0), frame,
9005 make_unibyte_string (atom, strlen (atom)),
9006 make_number (32),
9007 Fcons (make_number (1),
9008 Fcons (make_number (last_user_time),
9009 Qnil)));
9013 static void
9014 XTframe_raise_lower (f, raise_flag)
9015 FRAME_PTR f;
9016 int raise_flag;
9018 if (raise_flag)
9019 x_raise_frame (f);
9020 else
9021 x_lower_frame (f);
9024 /* XEmbed implementation. */
9026 void
9027 xembed_set_info (f, flags)
9028 struct frame *f;
9029 enum xembed_info flags;
9031 Atom atom;
9032 unsigned long data[2];
9034 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
9036 data[0] = XEMBED_VERSION;
9037 data[1] = flags;
9039 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
9040 32, PropModeReplace, (unsigned char *) data, 2);
9043 void
9044 xembed_send_message (f, time, message, detail, data1, data2)
9045 struct frame *f;
9046 Time time;
9047 enum xembed_message message;
9048 long detail;
9049 long data1;
9050 long data2;
9052 XEvent event;
9054 event.xclient.type = ClientMessage;
9055 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9056 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9057 event.xclient.format = 32;
9058 event.xclient.data.l[0] = time;
9059 event.xclient.data.l[1] = message;
9060 event.xclient.data.l[2] = detail;
9061 event.xclient.data.l[3] = data1;
9062 event.xclient.data.l[4] = data2;
9064 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9065 False, NoEventMask, &event);
9066 XSync (FRAME_X_DISPLAY (f), False);
9069 /* Change of visibility. */
9071 /* This tries to wait until the frame is really visible.
9072 However, if the window manager asks the user where to position
9073 the frame, this will return before the user finishes doing that.
9074 The frame will not actually be visible at that time,
9075 but it will become visible later when the window manager
9076 finishes with it. */
9078 void
9079 x_make_frame_visible (f)
9080 struct frame *f;
9082 Lisp_Object type;
9083 int original_top, original_left;
9084 int retry_count = 2;
9086 retry:
9088 BLOCK_INPUT;
9090 type = x_icon_type (f);
9091 if (!NILP (type))
9092 x_bitmap_icon (f, type);
9094 if (! FRAME_VISIBLE_P (f))
9096 /* We test FRAME_GARBAGED_P here to make sure we don't
9097 call x_set_offset a second time
9098 if we get to x_make_frame_visible a second time
9099 before the window gets really visible. */
9100 if (! FRAME_ICONIFIED_P (f)
9101 && ! FRAME_X_EMBEDDED_P (f)
9102 && ! f->output_data.x->asked_for_visible)
9103 x_set_offset (f, f->left_pos, f->top_pos, 0);
9105 f->output_data.x->asked_for_visible = 1;
9107 if (! EQ (Vx_no_window_manager, Qt))
9108 x_wm_set_window_state (f, NormalState);
9109 #ifdef USE_X_TOOLKIT
9110 if (FRAME_X_EMBEDDED_P (f))
9111 xembed_set_info (f, XEMBED_MAPPED);
9112 else
9114 /* This was XtPopup, but that did nothing for an iconified frame. */
9115 XtMapWidget (f->output_data.x->widget);
9117 #else /* not USE_X_TOOLKIT */
9118 #ifdef USE_GTK
9119 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9120 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9121 #else
9122 if (FRAME_X_EMBEDDED_P (f))
9123 xembed_set_info (f, XEMBED_MAPPED);
9124 else
9125 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9126 #endif /* not USE_GTK */
9127 #endif /* not USE_X_TOOLKIT */
9128 #if 0 /* This seems to bring back scroll bars in the wrong places
9129 if the window configuration has changed. They seem
9130 to come back ok without this. */
9131 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
9132 XMapSubwindows (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9133 #endif
9136 XFlush (FRAME_X_DISPLAY (f));
9138 /* Synchronize to ensure Emacs knows the frame is visible
9139 before we do anything else. We do this loop with input not blocked
9140 so that incoming events are handled. */
9142 Lisp_Object frame;
9143 int count;
9144 /* This must be before UNBLOCK_INPUT
9145 since events that arrive in response to the actions above
9146 will set it when they are handled. */
9147 int previously_visible = f->output_data.x->has_been_visible;
9149 original_left = f->left_pos;
9150 original_top = f->top_pos;
9152 /* This must come after we set COUNT. */
9153 UNBLOCK_INPUT;
9155 /* We unblock here so that arriving X events are processed. */
9157 /* Now move the window back to where it was "supposed to be".
9158 But don't do it if the gravity is negative.
9159 When the gravity is negative, this uses a position
9160 that is 3 pixels too low. Perhaps that's really the border width.
9162 Don't do this if the window has never been visible before,
9163 because the window manager may choose the position
9164 and we don't want to override it. */
9166 if (! FRAME_VISIBLE_P (f)
9167 && ! FRAME_ICONIFIED_P (f)
9168 && ! FRAME_X_EMBEDDED_P (f)
9169 && f->win_gravity == NorthWestGravity
9170 && previously_visible)
9172 Drawable rootw;
9173 int x, y;
9174 unsigned int width, height, border, depth;
9176 BLOCK_INPUT;
9178 /* On some window managers (such as FVWM) moving an existing
9179 window, even to the same place, causes the window manager
9180 to introduce an offset. This can cause the window to move
9181 to an unexpected location. Check the geometry (a little
9182 slow here) and then verify that the window is in the right
9183 place. If the window is not in the right place, move it
9184 there, and take the potential window manager hit. */
9185 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9186 &rootw, &x, &y, &width, &height, &border, &depth);
9188 if (original_left != x || original_top != y)
9189 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9190 original_left, original_top);
9192 UNBLOCK_INPUT;
9195 XSETFRAME (frame, f);
9197 /* Wait until the frame is visible. Process X events until a
9198 MapNotify event has been seen, or until we think we won't get a
9199 MapNotify at all.. */
9200 for (count = input_signal_count + 10;
9201 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9203 /* Force processing of queued events. */
9204 x_sync (f);
9206 /* Machines that do polling rather than SIGIO have been
9207 observed to go into a busy-wait here. So we'll fake an
9208 alarm signal to let the handler know that there's something
9209 to be read. We used to raise a real alarm, but it seems
9210 that the handler isn't always enabled here. This is
9211 probably a bug. */
9212 if (input_polling_used ())
9214 /* It could be confusing if a real alarm arrives while
9215 processing the fake one. Turn it off and let the
9216 handler reset it. */
9217 extern void poll_for_input_1 P_ ((void));
9218 int old_poll_suppress_count = poll_suppress_count;
9219 poll_suppress_count = 1;
9220 poll_for_input_1 ();
9221 poll_suppress_count = old_poll_suppress_count;
9224 /* See if a MapNotify event has been processed. */
9225 FRAME_SAMPLE_VISIBILITY (f);
9228 /* 2000-09-28: In
9230 (let ((f (selected-frame)))
9231 (iconify-frame f)
9232 (raise-frame f))
9234 the frame is not raised with various window managers on
9235 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9236 unknown reason, the call to XtMapWidget is completely ignored.
9237 Mapping the widget a second time works. */
9239 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9240 goto retry;
9244 /* Change from mapped state to withdrawn state. */
9246 /* Make the frame visible (mapped and not iconified). */
9248 void
9249 x_make_frame_invisible (f)
9250 struct frame *f;
9252 Window window;
9254 /* Use the frame's outermost window, not the one we normally draw on. */
9255 window = FRAME_OUTER_WINDOW (f);
9257 /* Don't keep the highlight on an invisible frame. */
9258 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9259 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9261 #if 0/* This might add unreliability; I don't trust it -- rms. */
9262 if (! f->async_visible && ! f->async_iconified)
9263 return;
9264 #endif
9266 BLOCK_INPUT;
9268 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9269 that the current position of the window is user-specified, rather than
9270 program-specified, so that when the window is mapped again, it will be
9271 placed at the same location, without forcing the user to position it
9272 by hand again (they have already done that once for this window.) */
9273 x_wm_set_size_hint (f, (long) 0, 1);
9275 #ifdef USE_GTK
9276 if (FRAME_GTK_OUTER_WIDGET (f))
9277 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9278 else
9279 #else
9280 if (FRAME_X_EMBEDDED_P (f))
9281 xembed_set_info (f, 0);
9282 else
9283 #endif
9286 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9287 DefaultScreen (FRAME_X_DISPLAY (f))))
9289 UNBLOCK_INPUT_RESIGNAL;
9290 error ("Can't notify window manager of window withdrawal");
9294 /* We can't distinguish this from iconification
9295 just by the event that we get from the server.
9296 So we can't win using the usual strategy of letting
9297 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9298 and synchronize with the server to make sure we agree. */
9299 f->visible = 0;
9300 FRAME_ICONIFIED_P (f) = 0;
9301 f->async_visible = 0;
9302 f->async_iconified = 0;
9304 x_sync (f);
9306 UNBLOCK_INPUT;
9309 /* Change window state from mapped to iconified. */
9311 void
9312 x_iconify_frame (f)
9313 struct frame *f;
9315 int result;
9316 Lisp_Object type;
9318 /* Don't keep the highlight on an invisible frame. */
9319 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9320 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9322 if (f->async_iconified)
9323 return;
9325 BLOCK_INPUT;
9327 FRAME_SAMPLE_VISIBILITY (f);
9329 type = x_icon_type (f);
9330 if (!NILP (type))
9331 x_bitmap_icon (f, type);
9333 #ifdef USE_GTK
9334 if (FRAME_GTK_OUTER_WIDGET (f))
9336 if (! FRAME_VISIBLE_P (f))
9337 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9339 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9340 f->iconified = 1;
9341 f->visible = 1;
9342 f->async_iconified = 1;
9343 f->async_visible = 0;
9344 UNBLOCK_INPUT;
9345 return;
9347 #endif
9349 #ifdef USE_X_TOOLKIT
9351 if (! FRAME_VISIBLE_P (f))
9353 if (! EQ (Vx_no_window_manager, Qt))
9354 x_wm_set_window_state (f, IconicState);
9355 /* This was XtPopup, but that did nothing for an iconified frame. */
9356 XtMapWidget (f->output_data.x->widget);
9357 /* The server won't give us any event to indicate
9358 that an invisible frame was changed to an icon,
9359 so we have to record it here. */
9360 f->iconified = 1;
9361 f->visible = 1;
9362 f->async_iconified = 1;
9363 f->async_visible = 0;
9364 UNBLOCK_INPUT;
9365 return;
9368 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9369 XtWindow (f->output_data.x->widget),
9370 DefaultScreen (FRAME_X_DISPLAY (f)));
9371 UNBLOCK_INPUT;
9373 if (!result)
9374 error ("Can't notify window manager of iconification");
9376 f->async_iconified = 1;
9377 f->async_visible = 0;
9380 BLOCK_INPUT;
9381 XFlush (FRAME_X_DISPLAY (f));
9382 UNBLOCK_INPUT;
9383 #else /* not USE_X_TOOLKIT */
9385 /* Make sure the X server knows where the window should be positioned,
9386 in case the user deiconifies with the window manager. */
9387 if (! FRAME_VISIBLE_P (f)
9388 && ! FRAME_ICONIFIED_P (f)
9389 && ! FRAME_X_EMBEDDED_P (f))
9390 x_set_offset (f, f->left_pos, f->top_pos, 0);
9392 /* Since we don't know which revision of X we're running, we'll use both
9393 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9395 /* X11R4: send a ClientMessage to the window manager using the
9396 WM_CHANGE_STATE type. */
9398 XEvent message;
9400 message.xclient.window = FRAME_X_WINDOW (f);
9401 message.xclient.type = ClientMessage;
9402 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9403 message.xclient.format = 32;
9404 message.xclient.data.l[0] = IconicState;
9406 if (! XSendEvent (FRAME_X_DISPLAY (f),
9407 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9408 False,
9409 SubstructureRedirectMask | SubstructureNotifyMask,
9410 &message))
9412 UNBLOCK_INPUT_RESIGNAL;
9413 error ("Can't notify window manager of iconification");
9417 /* X11R3: set the initial_state field of the window manager hints to
9418 IconicState. */
9419 x_wm_set_window_state (f, IconicState);
9421 if (!FRAME_VISIBLE_P (f))
9423 /* If the frame was withdrawn, before, we must map it. */
9424 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9427 f->async_iconified = 1;
9428 f->async_visible = 0;
9430 XFlush (FRAME_X_DISPLAY (f));
9431 UNBLOCK_INPUT;
9432 #endif /* not USE_X_TOOLKIT */
9436 /* Free X resources of frame F. */
9438 void
9439 x_free_frame_resources (f)
9440 struct frame *f;
9442 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9443 Lisp_Object bar;
9444 struct scroll_bar *b;
9446 BLOCK_INPUT;
9448 /* If a display connection is dead, don't try sending more
9449 commands to the X server. */
9450 if (dpyinfo->display)
9452 /* We must free faces before destroying windows because some
9453 font-driver (e.g. xft) access a window while finishing a
9454 face. */
9455 if (FRAME_FACE_CACHE (f))
9456 free_frame_faces (f);
9458 if (f->output_data.x->icon_desc)
9459 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9461 #ifdef USE_X_TOOLKIT
9462 /* Explicitly destroy the scroll bars of the frame. Without
9463 this, we get "BadDrawable" errors from the toolkit later on,
9464 presumably from expose events generated for the disappearing
9465 toolkit scroll bars. */
9466 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9468 b = XSCROLL_BAR (bar);
9469 x_scroll_bar_remove (b);
9471 #endif
9473 #ifdef HAVE_X_I18N
9474 if (FRAME_XIC (f))
9475 free_frame_xic (f);
9476 #endif
9478 #ifdef USE_X_TOOLKIT
9479 if (f->output_data.x->widget)
9481 XtDestroyWidget (f->output_data.x->widget);
9482 f->output_data.x->widget = NULL;
9484 /* Tooltips don't have widgets, only a simple X window, even if
9485 we are using a toolkit. */
9486 else if (FRAME_X_WINDOW (f))
9487 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9489 free_frame_menubar (f);
9490 #else /* !USE_X_TOOLKIT */
9492 #ifdef USE_GTK
9493 /* In the GTK version, tooltips are normal X
9494 frames. We must check and free both types. */
9495 if (FRAME_GTK_OUTER_WIDGET (f))
9497 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
9498 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
9499 FRAME_GTK_OUTER_WIDGET (f) = 0;
9501 #endif /* USE_GTK */
9503 if (FRAME_X_WINDOW (f))
9504 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9505 #endif /* !USE_X_TOOLKIT */
9507 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9508 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9509 unload_color (f, f->output_data.x->cursor_pixel);
9510 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9511 unload_color (f, f->output_data.x->border_pixel);
9512 unload_color (f, f->output_data.x->mouse_pixel);
9514 if (f->output_data.x->scroll_bar_background_pixel != -1)
9515 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9516 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9517 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9518 #ifdef USE_TOOLKIT_SCROLL_BARS
9519 /* Scrollbar shadow colors. */
9520 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9521 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9522 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9523 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9524 #endif /* USE_TOOLKIT_SCROLL_BARS */
9525 if (f->output_data.x->white_relief.allocated_p)
9526 unload_color (f, f->output_data.x->white_relief.pixel);
9527 if (f->output_data.x->black_relief.allocated_p)
9528 unload_color (f, f->output_data.x->black_relief.pixel);
9530 if (FRAME_FACE_CACHE (f))
9531 free_frame_faces (f);
9533 x_free_gcs (f);
9534 XFlush (FRAME_X_DISPLAY (f));
9537 xfree (f->output_data.x->saved_menu_event);
9538 xfree (f->output_data.x);
9539 f->output_data.x = NULL;
9541 if (f == dpyinfo->x_focus_frame)
9542 dpyinfo->x_focus_frame = 0;
9543 if (f == dpyinfo->x_focus_event_frame)
9544 dpyinfo->x_focus_event_frame = 0;
9545 if (f == dpyinfo->x_highlight_frame)
9546 dpyinfo->x_highlight_frame = 0;
9548 if (f == dpyinfo->mouse_face_mouse_frame)
9550 dpyinfo->mouse_face_beg_row
9551 = dpyinfo->mouse_face_beg_col = -1;
9552 dpyinfo->mouse_face_end_row
9553 = dpyinfo->mouse_face_end_col = -1;
9554 dpyinfo->mouse_face_window = Qnil;
9555 dpyinfo->mouse_face_deferred_gc = 0;
9556 dpyinfo->mouse_face_mouse_frame = 0;
9559 UNBLOCK_INPUT;
9563 /* Destroy the X window of frame F. */
9565 void
9566 x_destroy_window (f)
9567 struct frame *f;
9569 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9571 /* If a display connection is dead, don't try sending more
9572 commands to the X server. */
9573 if (dpyinfo->display != 0)
9574 x_free_frame_resources (f);
9576 dpyinfo->reference_count--;
9580 /* Setting window manager hints. */
9582 /* Set the normal size hints for the window manager, for frame F.
9583 FLAGS is the flags word to use--or 0 meaning preserve the flags
9584 that the window now has.
9585 If USER_POSITION is nonzero, we set the USPosition
9586 flag (this is useful when FLAGS is 0).
9587 The GTK version is in gtkutils.c */
9589 #ifndef USE_GTK
9590 void
9591 x_wm_set_size_hint (f, flags, user_position)
9592 struct frame *f;
9593 long flags;
9594 int user_position;
9596 XSizeHints size_hints;
9598 #ifdef USE_X_TOOLKIT
9599 Arg al[2];
9600 int ac = 0;
9601 Dimension widget_width, widget_height;
9602 #endif
9604 Window window = FRAME_OUTER_WINDOW (f);
9606 /* Setting PMaxSize caused various problems. */
9607 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9609 size_hints.x = f->left_pos;
9610 size_hints.y = f->top_pos;
9612 #ifdef USE_X_TOOLKIT
9613 XtSetArg (al[ac], XtNwidth, &widget_width); ac++;
9614 XtSetArg (al[ac], XtNheight, &widget_height); ac++;
9615 XtGetValues (f->output_data.x->widget, al, ac);
9616 size_hints.height = widget_height;
9617 size_hints.width = widget_width;
9618 #else /* not USE_X_TOOLKIT */
9619 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9620 size_hints.width = FRAME_PIXEL_WIDTH (f);
9621 #endif /* not USE_X_TOOLKIT */
9623 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9624 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9625 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9626 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9627 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9628 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9630 /* Calculate the base and minimum sizes.
9632 (When we use the X toolkit, we don't do it here.
9633 Instead we copy the values that the widgets are using, below.) */
9634 #ifndef USE_X_TOOLKIT
9636 int base_width, base_height;
9637 int min_rows = 0, min_cols = 0;
9639 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9640 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9642 check_frame_size (f, &min_rows, &min_cols);
9644 /* The window manager uses the base width hints to calculate the
9645 current number of rows and columns in the frame while
9646 resizing; min_width and min_height aren't useful for this
9647 purpose, since they might not give the dimensions for a
9648 zero-row, zero-column frame.
9650 We use the base_width and base_height members if we have
9651 them; otherwise, we set the min_width and min_height members
9652 to the size for a zero x zero frame. */
9654 size_hints.flags |= PBaseSize;
9655 size_hints.base_width = base_width;
9656 size_hints.base_height = base_height;
9657 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9658 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9661 /* If we don't need the old flags, we don't need the old hint at all. */
9662 if (flags)
9664 size_hints.flags |= flags;
9665 goto no_read;
9667 #endif /* not USE_X_TOOLKIT */
9670 XSizeHints hints; /* Sometimes I hate X Windows... */
9671 long supplied_return;
9672 int value;
9674 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9675 &supplied_return);
9677 #ifdef USE_X_TOOLKIT
9678 size_hints.base_height = hints.base_height;
9679 size_hints.base_width = hints.base_width;
9680 size_hints.min_height = hints.min_height;
9681 size_hints.min_width = hints.min_width;
9682 #endif
9684 if (flags)
9685 size_hints.flags |= flags;
9686 else
9688 if (value == 0)
9689 hints.flags = 0;
9690 if (hints.flags & PSize)
9691 size_hints.flags |= PSize;
9692 if (hints.flags & PPosition)
9693 size_hints.flags |= PPosition;
9694 if (hints.flags & USPosition)
9695 size_hints.flags |= USPosition;
9696 if (hints.flags & USSize)
9697 size_hints.flags |= USSize;
9701 #ifndef USE_X_TOOLKIT
9702 no_read:
9703 #endif
9705 #ifdef PWinGravity
9706 size_hints.win_gravity = f->win_gravity;
9707 size_hints.flags |= PWinGravity;
9709 if (user_position)
9711 size_hints.flags &= ~ PPosition;
9712 size_hints.flags |= USPosition;
9714 #endif /* PWinGravity */
9716 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9718 #endif /* not USE_GTK */
9720 /* Used for IconicState or NormalState */
9722 void
9723 x_wm_set_window_state (f, state)
9724 struct frame *f;
9725 int state;
9727 #ifdef USE_X_TOOLKIT
9728 Arg al[1];
9730 XtSetArg (al[0], XtNinitialState, state);
9731 XtSetValues (f->output_data.x->widget, al, 1);
9732 #else /* not USE_X_TOOLKIT */
9733 Window window = FRAME_X_WINDOW (f);
9735 f->output_data.x->wm_hints.flags |= StateHint;
9736 f->output_data.x->wm_hints.initial_state = state;
9738 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9739 #endif /* not USE_X_TOOLKIT */
9742 void
9743 x_wm_set_icon_pixmap (f, pixmap_id)
9744 struct frame *f;
9745 int pixmap_id;
9747 Pixmap icon_pixmap, icon_mask;
9749 #ifndef USE_X_TOOLKIT
9750 Window window = FRAME_OUTER_WINDOW (f);
9751 #endif
9753 if (pixmap_id > 0)
9755 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9756 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9757 icon_mask = x_bitmap_mask (f, pixmap_id);
9758 f->output_data.x->wm_hints.icon_mask = icon_mask;
9760 else
9762 /* It seems there is no way to turn off use of an icon pixmap.
9763 The following line does it, only if no icon has yet been created,
9764 for some window managers. But with mwm it crashes.
9765 Some people say it should clear the IconPixmapHint bit in this case,
9766 but that doesn't work, and the X consortium said it isn't the
9767 right thing at all. Since there is no way to win,
9768 best to explicitly give up. */
9769 #if 0
9770 f->output_data.x->wm_hints.icon_pixmap = None;
9771 f->output_data.x->wm_hints.icon_mask = None;
9772 #else
9773 return;
9774 #endif
9778 #ifdef USE_GTK
9780 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9781 return;
9784 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9787 Arg al[1];
9788 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9789 XtSetValues (f->output_data.x->widget, al, 1);
9790 XtSetArg (al[0], XtNiconMask, icon_mask);
9791 XtSetValues (f->output_data.x->widget, al, 1);
9794 #else /* not USE_X_TOOLKIT && not USE_GTK */
9796 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9797 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9799 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9802 void
9803 x_wm_set_icon_position (f, icon_x, icon_y)
9804 struct frame *f;
9805 int icon_x, icon_y;
9807 Window window = FRAME_OUTER_WINDOW (f);
9809 f->output_data.x->wm_hints.flags |= IconPositionHint;
9810 f->output_data.x->wm_hints.icon_x = icon_x;
9811 f->output_data.x->wm_hints.icon_y = icon_y;
9813 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9817 /***********************************************************************
9818 Fonts
9819 ***********************************************************************/
9821 #if GLYPH_DEBUG
9823 /* Check that FONT is valid on frame F. It is if it can be found in F's
9824 font table. */
9826 static void
9827 x_check_font (f, font)
9828 struct frame *f;
9829 struct font *font;
9831 Lisp_Object frame;
9833 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9834 if (font->driver->check)
9835 xassert (font->driver->check (f, font) == 0);
9838 #endif /* GLYPH_DEBUG != 0 */
9841 /***********************************************************************
9842 Initialization
9843 ***********************************************************************/
9845 #ifdef USE_X_TOOLKIT
9846 static XrmOptionDescRec emacs_options[] = {
9847 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9848 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9850 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9851 XrmoptionSepArg, NULL},
9852 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9854 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9855 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9856 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9857 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9858 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9859 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9860 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9863 /* Whether atimer for Xt timeouts is activated or not. */
9865 static int x_timeout_atimer_activated_flag;
9867 #endif /* USE_X_TOOLKIT */
9869 static int x_initialized;
9871 #ifdef HAVE_X_SM
9872 static int x_session_initialized;
9873 #endif
9875 /* Test whether two display-name strings agree up to the dot that separates
9876 the screen number from the server number. */
9877 static int
9878 same_x_server (name1, name2)
9879 const char *name1, *name2;
9881 int seen_colon = 0;
9882 const unsigned char *system_name = SDATA (Vsystem_name);
9883 int system_name_length = strlen (system_name);
9884 int length_until_period = 0;
9886 while (system_name[length_until_period] != 0
9887 && system_name[length_until_period] != '.')
9888 length_until_period++;
9890 /* Treat `unix' like an empty host name. */
9891 if (! strncmp (name1, "unix:", 5))
9892 name1 += 4;
9893 if (! strncmp (name2, "unix:", 5))
9894 name2 += 4;
9895 /* Treat this host's name like an empty host name. */
9896 if (! strncmp (name1, system_name, system_name_length)
9897 && name1[system_name_length] == ':')
9898 name1 += system_name_length;
9899 if (! strncmp (name2, system_name, system_name_length)
9900 && name2[system_name_length] == ':')
9901 name2 += system_name_length;
9902 /* Treat this host's domainless name like an empty host name. */
9903 if (! strncmp (name1, system_name, length_until_period)
9904 && name1[length_until_period] == ':')
9905 name1 += length_until_period;
9906 if (! strncmp (name2, system_name, length_until_period)
9907 && name2[length_until_period] == ':')
9908 name2 += length_until_period;
9910 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9912 if (*name1 == ':')
9913 seen_colon++;
9914 if (seen_colon && *name1 == '.')
9915 return 1;
9917 return (seen_colon
9918 && (*name1 == '.' || *name1 == '\0')
9919 && (*name2 == '.' || *name2 == '\0'));
9922 /* Count number of set bits in mask and number of bits to shift to
9923 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9924 to 5. */
9925 static void
9926 get_bits_and_offset (mask, bits, offset)
9927 unsigned long mask;
9928 int *bits;
9929 int *offset;
9931 int nr = 0;
9932 int off = 0;
9934 while (!(mask & 1))
9936 off++;
9937 mask >>= 1;
9940 while (mask & 1)
9942 nr++;
9943 mask >>= 1;
9946 *offset = off;
9947 *bits = nr;
9950 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9951 But don't permanently open it, just test its availability. */
9954 x_display_ok (display)
9955 const char *display;
9957 int dpy_ok = 1;
9958 Display *dpy;
9960 dpy = XOpenDisplay (display);
9961 if (dpy)
9962 XCloseDisplay (dpy);
9963 else
9964 dpy_ok = 0;
9965 return dpy_ok;
9968 /* Open a connection to X display DISPLAY_NAME, and return
9969 the structure that describes the open display.
9970 If we cannot contact the display, return null. */
9972 struct x_display_info *
9973 x_term_init (display_name, xrm_option, resource_name)
9974 Lisp_Object display_name;
9975 char *xrm_option;
9976 char *resource_name;
9978 int connection;
9979 Display *dpy;
9980 struct terminal *terminal;
9981 struct x_display_info *dpyinfo;
9982 XrmDatabase xrdb;
9984 BLOCK_INPUT;
9986 if (!x_initialized)
9988 x_initialize ();
9989 ++x_initialized;
9992 if (! x_display_ok (SDATA (display_name)))
9993 error ("Display %s can't be opened", SDATA (display_name));
9995 #ifdef USE_GTK
9997 #define NUM_ARGV 10
9998 int argc;
9999 char *argv[NUM_ARGV];
10000 char **argv2 = argv;
10001 GdkAtom atom;
10003 #ifndef HAVE_GTK_MULTIDISPLAY
10004 if (!EQ (Vinitial_window_system, intern ("x")))
10005 error ("Sorry, you cannot connect to X servers with the GTK toolkit");
10006 #endif
10008 if (x_initialized++ > 1)
10010 #ifdef HAVE_GTK_MULTIDISPLAY
10011 /* Opening another display. If xg_display_open returns less
10012 than zero, we are probably on GTK 2.0, which can only handle
10013 one display. GTK 2.2 or later can handle more than one. */
10014 if (xg_display_open (SDATA (display_name), &dpy) < 0)
10015 #endif
10016 error ("Sorry, this version of GTK can only handle one display");
10018 else
10020 for (argc = 0; argc < NUM_ARGV; ++argc)
10021 argv[argc] = 0;
10023 argc = 0;
10024 argv[argc++] = initial_argv[0];
10026 if (! NILP (display_name))
10028 argv[argc++] = "--display";
10029 argv[argc++] = SDATA (display_name);
10032 argv[argc++] = "--name";
10033 argv[argc++] = resource_name;
10035 XSetLocaleModifiers ("");
10037 gtk_init (&argc, &argv2);
10039 /* gtk_init does set_locale. We must fix locale after calling it. */
10040 fixup_locale ();
10041 xg_initialize ();
10043 dpy = GDK_DISPLAY ();
10045 /* NULL window -> events for all windows go to our function */
10046 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10048 /* Load our own gtkrc if it exists. */
10050 char *file = "~/.emacs.d/gtkrc";
10051 Lisp_Object s, abs_file;
10053 s = make_string (file, strlen (file));
10054 abs_file = Fexpand_file_name (s, Qnil);
10056 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10057 gtk_rc_parse (SDATA (abs_file));
10060 XSetErrorHandler (x_error_handler);
10061 XSetIOErrorHandler (x_io_error_quitter);
10064 #else /* not USE_GTK */
10065 #ifdef USE_X_TOOLKIT
10066 /* weiner@footloose.sps.mot.com reports that this causes
10067 errors with X11R5:
10068 X protocol error: BadAtom (invalid Atom parameter)
10069 on protocol request 18skiloaf.
10070 So let's not use it until R6. */
10071 #ifdef HAVE_X11XTR6
10072 XtSetLanguageProc (NULL, NULL, NULL);
10073 #endif
10076 int argc = 0;
10077 char *argv[3];
10079 argv[0] = "";
10080 argc = 1;
10081 if (xrm_option)
10083 argv[argc++] = "-xrm";
10084 argv[argc++] = xrm_option;
10086 turn_on_atimers (0);
10087 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10088 resource_name, EMACS_CLASS,
10089 emacs_options, XtNumber (emacs_options),
10090 &argc, argv);
10091 turn_on_atimers (1);
10093 #ifdef HAVE_X11XTR6
10094 /* I think this is to compensate for XtSetLanguageProc. */
10095 fixup_locale ();
10096 #endif
10099 #else /* not USE_X_TOOLKIT */
10100 XSetLocaleModifiers ("");
10101 dpy = XOpenDisplay (SDATA (display_name));
10102 #endif /* not USE_X_TOOLKIT */
10103 #endif /* not USE_GTK*/
10105 /* Detect failure. */
10106 if (dpy == 0)
10108 UNBLOCK_INPUT;
10109 return 0;
10112 /* We have definitely succeeded. Record the new connection. */
10114 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10115 bzero (dpyinfo, sizeof *dpyinfo);
10117 terminal = x_create_terminal (dpyinfo);
10120 struct x_display_info *share;
10121 Lisp_Object tail;
10123 for (share = x_display_list, tail = x_display_name_list; share;
10124 share = share->next, tail = XCDR (tail))
10125 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10126 SDATA (display_name)))
10127 break;
10128 if (share)
10129 terminal->kboard = share->terminal->kboard;
10130 else
10132 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10133 init_kboard (terminal->kboard);
10134 terminal->kboard->Vwindow_system = intern ("x");
10135 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10137 char *vendor = ServerVendor (dpy);
10138 /* Temporarily hide the partially initialized terminal */
10139 terminal_list = terminal->next_terminal;
10140 UNBLOCK_INPUT;
10141 terminal->kboard->Vsystem_key_alist
10142 = call1 (Qvendor_specific_keysyms,
10143 vendor ? build_string (vendor) : empty_unibyte_string);
10144 BLOCK_INPUT;
10145 terminal->next_terminal = terminal_list;
10146 terminal_list = terminal;
10149 terminal->kboard->next_kboard = all_kboards;
10150 all_kboards = terminal->kboard;
10151 /* Don't let the initial kboard remain current longer than necessary.
10152 That would cause problems if a file loaded on startup tries to
10153 prompt in the mini-buffer. */
10154 if (current_kboard == initial_kboard)
10155 current_kboard = terminal->kboard;
10157 terminal->kboard->reference_count++;
10160 /* Put this display on the chain. */
10161 dpyinfo->next = x_display_list;
10162 x_display_list = dpyinfo;
10164 /* Put it on x_display_name_list as well, to keep them parallel. */
10165 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10166 x_display_name_list);
10167 dpyinfo->name_list_element = XCAR (x_display_name_list);
10169 dpyinfo->display = dpy;
10171 /* Set the name of the terminal. */
10172 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10173 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10174 terminal->name[SBYTES (display_name)] = 0;
10176 #if 0
10177 XSetAfterFunction (x_current_display, x_trace_wire);
10178 #endif /* ! 0 */
10180 dpyinfo->x_id_name
10181 = (char *) xmalloc (SBYTES (Vinvocation_name)
10182 + SBYTES (Vsystem_name)
10183 + 2);
10184 sprintf (dpyinfo->x_id_name, "%s@%s",
10185 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10187 /* Figure out which modifier bits mean what. */
10188 x_find_modifier_meanings (dpyinfo);
10190 /* Get the scroll bar cursor. */
10191 #ifdef USE_GTK
10192 /* We must create a GTK cursor, it is required for GTK widgets. */
10193 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10194 #endif /* USE_GTK */
10196 dpyinfo->vertical_scroll_bar_cursor
10197 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10199 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10200 resource_name, EMACS_CLASS);
10201 #ifdef HAVE_XRMSETDATABASE
10202 XrmSetDatabase (dpyinfo->display, xrdb);
10203 #else
10204 dpyinfo->display->db = xrdb;
10205 #endif
10206 /* Put the rdb where we can find it in a way that works on
10207 all versions. */
10208 dpyinfo->xrdb = xrdb;
10210 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10211 DefaultScreen (dpyinfo->display));
10212 select_visual (dpyinfo);
10213 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10214 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10215 dpyinfo->client_leader_window = 0;
10216 dpyinfo->grabbed = 0;
10217 dpyinfo->reference_count = 0;
10218 dpyinfo->icon_bitmap_id = -1;
10219 dpyinfo->n_fonts = 0;
10220 dpyinfo->bitmaps = 0;
10221 dpyinfo->bitmaps_size = 0;
10222 dpyinfo->bitmaps_last = 0;
10223 dpyinfo->scratch_cursor_gc = 0;
10224 dpyinfo->mouse_face_mouse_frame = 0;
10225 dpyinfo->mouse_face_deferred_gc = 0;
10226 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10227 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10228 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10229 dpyinfo->mouse_face_window = Qnil;
10230 dpyinfo->mouse_face_overlay = Qnil;
10231 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10232 dpyinfo->mouse_face_defer = 0;
10233 dpyinfo->mouse_face_hidden = 0;
10234 dpyinfo->x_focus_frame = 0;
10235 dpyinfo->x_focus_event_frame = 0;
10236 dpyinfo->x_highlight_frame = 0;
10237 dpyinfo->terminal->image_cache = make_image_cache ();
10238 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10240 /* See if we can construct pixel values from RGB values. */
10241 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10242 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10244 if (dpyinfo->visual->class == TrueColor)
10246 get_bits_and_offset (dpyinfo->visual->red_mask,
10247 &dpyinfo->red_bits, &dpyinfo->red_offset);
10248 get_bits_and_offset (dpyinfo->visual->blue_mask,
10249 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10250 get_bits_and_offset (dpyinfo->visual->green_mask,
10251 &dpyinfo->green_bits, &dpyinfo->green_offset);
10254 /* See if a private colormap is requested. */
10255 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10257 if (dpyinfo->visual->class == PseudoColor)
10259 Lisp_Object value;
10260 value = display_x_get_resource (dpyinfo,
10261 build_string ("privateColormap"),
10262 build_string ("PrivateColormap"),
10263 Qnil, Qnil);
10264 if (STRINGP (value)
10265 && (!strcmp (SDATA (value), "true")
10266 || !strcmp (SDATA (value), "on")))
10267 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10270 else
10271 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10272 dpyinfo->visual, AllocNone);
10275 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10276 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10277 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10278 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10279 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10280 pixels = DisplayWidth (dpyinfo->display, screen_number);
10281 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10282 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10283 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10286 dpyinfo->Xatom_wm_protocols
10287 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10288 dpyinfo->Xatom_wm_take_focus
10289 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10290 dpyinfo->Xatom_wm_save_yourself
10291 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10292 dpyinfo->Xatom_wm_delete_window
10293 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10294 dpyinfo->Xatom_wm_change_state
10295 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10296 dpyinfo->Xatom_wm_configure_denied
10297 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10298 dpyinfo->Xatom_wm_window_moved
10299 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10300 dpyinfo->Xatom_wm_client_leader
10301 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10302 dpyinfo->Xatom_editres
10303 = XInternAtom (dpyinfo->display, "Editres", False);
10304 dpyinfo->Xatom_CLIPBOARD
10305 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10306 dpyinfo->Xatom_TIMESTAMP
10307 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10308 dpyinfo->Xatom_TEXT
10309 = XInternAtom (dpyinfo->display, "TEXT", False);
10310 dpyinfo->Xatom_COMPOUND_TEXT
10311 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10312 dpyinfo->Xatom_UTF8_STRING
10313 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10314 dpyinfo->Xatom_DELETE
10315 = XInternAtom (dpyinfo->display, "DELETE", False);
10316 dpyinfo->Xatom_MULTIPLE
10317 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10318 dpyinfo->Xatom_INCR
10319 = XInternAtom (dpyinfo->display, "INCR", False);
10320 dpyinfo->Xatom_EMACS_TMP
10321 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10322 dpyinfo->Xatom_TARGETS
10323 = XInternAtom (dpyinfo->display, "TARGETS", False);
10324 dpyinfo->Xatom_NULL
10325 = XInternAtom (dpyinfo->display, "NULL", False);
10326 dpyinfo->Xatom_ATOM_PAIR
10327 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10328 /* For properties of font. */
10329 dpyinfo->Xatom_PIXEL_SIZE
10330 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10331 dpyinfo->Xatom_AVERAGE_WIDTH
10332 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10333 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10334 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10335 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10336 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10337 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10338 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10340 /* Ghostscript support. */
10341 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10342 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10344 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10345 False);
10347 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10348 False);
10350 dpyinfo->cut_buffers_initialized = 0;
10352 dpyinfo->x_dnd_atoms_size = 8;
10353 dpyinfo->x_dnd_atoms_length = 0;
10354 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10355 * dpyinfo->x_dnd_atoms_size);
10357 dpyinfo->net_supported_atoms = NULL;
10358 dpyinfo->nr_net_supported_atoms = 0;
10359 dpyinfo->net_supported_window = 0;
10361 connection = ConnectionNumber (dpyinfo->display);
10362 dpyinfo->connection = connection;
10365 char null_bits[1];
10367 null_bits[0] = 0x00;
10369 dpyinfo->null_pixel
10370 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10371 null_bits, 1, 1, (long) 0, (long) 0,
10376 extern int gray_bitmap_width, gray_bitmap_height;
10377 extern char *gray_bitmap_bits;
10378 dpyinfo->gray
10379 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10380 gray_bitmap_bits,
10381 gray_bitmap_width, gray_bitmap_height,
10382 (unsigned long) 1, (unsigned long) 0, 1);
10385 #ifdef HAVE_X_I18N
10386 xim_initialize (dpyinfo, resource_name);
10387 #endif
10389 #ifdef subprocesses
10390 /* This is only needed for distinguishing keyboard and process input. */
10391 if (connection != 0)
10392 add_keyboard_wait_descriptor (connection);
10393 #endif
10395 #ifdef F_SETOWN
10396 fcntl (connection, F_SETOWN, getpid ());
10397 #endif /* ! defined (F_SETOWN) */
10399 #ifdef SIGIO
10400 if (interrupt_input)
10401 init_sigio (connection);
10402 #endif /* ! defined (SIGIO) */
10404 #ifdef USE_LUCID
10406 Display *dpy = dpyinfo->display;
10407 XrmValue d, fr, to;
10408 Font font;
10410 d.addr = (XPointer)&dpy;
10411 d.size = sizeof (Display *);
10412 fr.addr = XtDefaultFont;
10413 fr.size = sizeof (XtDefaultFont);
10414 to.size = sizeof (Font *);
10415 to.addr = (XPointer)&font;
10416 x_catch_errors (dpy);
10417 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10418 abort ();
10419 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10420 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10421 x_uncatch_errors ();
10423 #endif
10425 /* See if we should run in synchronous mode. This is useful
10426 for debugging X code. */
10428 Lisp_Object value;
10429 value = display_x_get_resource (dpyinfo,
10430 build_string ("synchronous"),
10431 build_string ("Synchronous"),
10432 Qnil, Qnil);
10433 if (STRINGP (value)
10434 && (!strcmp (SDATA (value), "true")
10435 || !strcmp (SDATA (value), "on")))
10436 XSynchronize (dpyinfo->display, True);
10440 Lisp_Object value;
10441 value = display_x_get_resource (dpyinfo,
10442 build_string ("useXIM"),
10443 build_string ("UseXIM"),
10444 Qnil, Qnil);
10445 #ifdef USE_XIM
10446 if (STRINGP (value)
10447 && (!strcmp (SDATA (value), "false")
10448 || !strcmp (SDATA (value), "off")))
10449 use_xim = 0;
10450 #else
10451 if (STRINGP (value)
10452 && (!strcmp (SDATA (value), "true")
10453 || !strcmp (SDATA (value), "on")))
10454 use_xim = 1;
10455 #endif
10458 #ifdef HAVE_X_SM
10459 /* Only do this for the very first display in the Emacs session.
10460 Ignore X session management when Emacs was first started on a
10461 tty. */
10462 if (terminal->id == 1)
10463 x_session_initialize (dpyinfo);
10464 #endif
10466 UNBLOCK_INPUT;
10468 return dpyinfo;
10471 /* Get rid of display DPYINFO, deleting all frames on it,
10472 and without sending any more commands to the X server. */
10474 void
10475 x_delete_display (dpyinfo)
10476 struct x_display_info *dpyinfo;
10478 int i;
10479 struct terminal *t;
10481 /* Close all frames and delete the generic struct terminal for this
10482 X display. */
10483 for (t = terminal_list; t; t = t->next_terminal)
10484 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10486 #ifdef HAVE_X_SM
10487 /* Close X session management when we close its display. */
10488 if (t->id == 1 && x_session_have_connection ())
10489 x_session_close();
10490 #endif
10491 delete_terminal (t);
10492 break;
10495 delete_keyboard_wait_descriptor (dpyinfo->connection);
10497 /* Discard this display from x_display_name_list and x_display_list.
10498 We can't use Fdelq because that can quit. */
10499 if (! NILP (x_display_name_list)
10500 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10501 x_display_name_list = XCDR (x_display_name_list);
10502 else
10504 Lisp_Object tail;
10506 tail = x_display_name_list;
10507 while (CONSP (tail) && CONSP (XCDR (tail)))
10509 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10511 XSETCDR (tail, XCDR (XCDR (tail)));
10512 break;
10514 tail = XCDR (tail);
10518 if (next_noop_dpyinfo == dpyinfo)
10519 next_noop_dpyinfo = dpyinfo->next;
10521 if (x_display_list == dpyinfo)
10522 x_display_list = dpyinfo->next;
10523 else
10525 struct x_display_info *tail;
10527 for (tail = x_display_list; tail; tail = tail->next)
10528 if (tail->next == dpyinfo)
10529 tail->next = tail->next->next;
10532 /* Xt and GTK do this themselves. */
10533 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
10534 #ifndef AIX /* On AIX, XCloseDisplay calls this. */
10535 XrmDestroyDatabase (dpyinfo->xrdb);
10536 #endif
10537 #endif
10538 #ifdef HAVE_X_I18N
10539 if (dpyinfo->xim)
10540 xim_close_dpy (dpyinfo);
10541 #endif
10543 xfree (dpyinfo->x_id_name);
10544 xfree (dpyinfo->color_cells);
10545 xfree (dpyinfo);
10548 #ifdef USE_X_TOOLKIT
10550 /* Atimer callback function for TIMER. Called every 0.1s to process
10551 Xt timeouts, if needed. We must avoid calling XtAppPending as
10552 much as possible because that function does an implicit XFlush
10553 that slows us down. */
10555 static void
10556 x_process_timeouts (timer)
10557 struct atimer *timer;
10559 BLOCK_INPUT;
10560 x_timeout_atimer_activated_flag = 0;
10561 if (toolkit_scroll_bar_interaction || popup_activated ())
10563 while (XtAppPending (Xt_app_con) & XtIMTimer)
10564 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10565 /* Reactivate the atimer for next time. */
10566 x_activate_timeout_atimer ();
10568 UNBLOCK_INPUT;
10571 /* Install an asynchronous timer that processes Xt timeout events
10572 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10573 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10574 function whenever these variables are set. This is necessary
10575 because some widget sets use timeouts internally, for example the
10576 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10577 processed, these widgets don't behave normally. */
10579 void
10580 x_activate_timeout_atimer ()
10582 BLOCK_INPUT;
10583 if (!x_timeout_atimer_activated_flag)
10585 EMACS_TIME interval;
10587 EMACS_SET_SECS_USECS (interval, 0, 100000);
10588 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10589 x_timeout_atimer_activated_flag = 1;
10591 UNBLOCK_INPUT;
10594 #endif /* USE_X_TOOLKIT */
10597 /* Set up use of X before we make the first connection. */
10599 extern frame_parm_handler x_frame_parm_handlers[];
10601 static struct redisplay_interface x_redisplay_interface =
10603 x_frame_parm_handlers,
10604 x_produce_glyphs,
10605 x_write_glyphs,
10606 x_insert_glyphs,
10607 x_clear_end_of_line,
10608 x_scroll_run,
10609 x_after_update_window_line,
10610 x_update_window_begin,
10611 x_update_window_end,
10612 x_cursor_to,
10613 x_flush,
10614 #ifdef XFlush
10615 x_flush,
10616 #else
10617 0, /* flush_display_optional */
10618 #endif
10619 x_clear_window_mouse_face,
10620 x_get_glyph_overhangs,
10621 x_fix_overlapping_area,
10622 x_draw_fringe_bitmap,
10623 0, /* define_fringe_bitmap */
10624 0, /* destroy_fringe_bitmap */
10625 x_compute_glyph_string_overhangs,
10626 x_draw_glyph_string,
10627 x_define_frame_cursor,
10628 x_clear_frame_area,
10629 x_draw_window_cursor,
10630 x_draw_vertical_window_border,
10631 x_shift_glyphs_for_insert
10635 /* This function is called when the last frame on a display is deleted. */
10636 void
10637 x_delete_terminal (struct terminal *terminal)
10639 struct x_display_info *dpyinfo = terminal->display_info.x;
10640 int i;
10642 /* Protect against recursive calls. Fdelete_frame in
10643 delete_terminal calls us back when it deletes our last frame. */
10644 if (!terminal->name)
10645 return;
10647 BLOCK_INPUT;
10648 /* If called from x_connection_closed, the display may already be closed
10649 and dpyinfo->display was set to 0 to indicate that. */
10650 if (dpyinfo->display)
10652 x_destroy_all_bitmaps (dpyinfo);
10653 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10655 #ifdef USE_GTK
10656 xg_display_close (dpyinfo->display);
10657 #else
10658 #ifdef USE_X_TOOLKIT
10659 XtCloseDisplay (dpyinfo->display);
10660 #else
10661 XCloseDisplay (dpyinfo->display);
10662 #endif
10663 #endif /* ! USE_GTK */
10666 x_delete_display (dpyinfo);
10667 UNBLOCK_INPUT;
10670 /* Create a struct terminal, initialize it with the X11 specific
10671 functions and make DISPLAY->TERMINAL point to it. */
10673 static struct terminal *
10674 x_create_terminal (struct x_display_info *dpyinfo)
10676 struct terminal *terminal;
10678 terminal = create_terminal ();
10680 terminal->type = output_x_window;
10681 terminal->display_info.x = dpyinfo;
10682 dpyinfo->terminal = terminal;
10684 /* kboard is initialized in x_term_init. */
10686 terminal->clear_frame_hook = x_clear_frame;
10687 terminal->ins_del_lines_hook = x_ins_del_lines;
10688 terminal->delete_glyphs_hook = x_delete_glyphs;
10689 terminal->ring_bell_hook = XTring_bell;
10690 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10691 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10692 terminal->update_begin_hook = x_update_begin;
10693 terminal->update_end_hook = x_update_end;
10694 terminal->set_terminal_window_hook = XTset_terminal_window;
10695 terminal->read_socket_hook = XTread_socket;
10696 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10697 terminal->mouse_position_hook = XTmouse_position;
10698 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10699 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10700 terminal->fullscreen_hook = XTfullscreen_hook;
10701 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10702 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10703 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10704 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10706 terminal->delete_frame_hook = x_destroy_window;
10707 terminal->delete_terminal_hook = x_delete_terminal;
10709 terminal->rif = &x_redisplay_interface;
10710 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10711 terminal->char_ins_del_ok = 1;
10712 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10713 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10714 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10715 off the bottom. */
10717 return terminal;
10720 void
10721 x_initialize ()
10723 baud_rate = 19200;
10725 x_noop_count = 0;
10726 last_tool_bar_item = -1;
10727 any_help_event_p = 0;
10728 ignore_next_mouse_click_timeout = 0;
10729 #ifdef HAVE_X_SM
10730 x_session_initialized = 0;
10731 #endif
10733 #ifdef USE_GTK
10734 current_count = -1;
10735 #endif
10737 /* Try to use interrupt input; if we can't, then start polling. */
10738 Fset_input_interrupt_mode (Qt);
10740 #ifdef USE_X_TOOLKIT
10741 XtToolkitInitialize ();
10743 Xt_app_con = XtCreateApplicationContext ();
10745 /* Register a converter from strings to pixels, which uses
10746 Emacs' color allocation infrastructure. */
10747 XtAppSetTypeConverter (Xt_app_con,
10748 XtRString, XtRPixel, cvt_string_to_pixel,
10749 cvt_string_to_pixel_args,
10750 XtNumber (cvt_string_to_pixel_args),
10751 XtCacheByDisplay, cvt_pixel_dtor);
10753 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10754 #endif
10756 #ifdef USE_TOOLKIT_SCROLL_BARS
10757 #ifndef USE_GTK
10758 xaw3d_arrow_scroll = False;
10759 xaw3d_pick_top = True;
10760 #endif
10761 #endif
10763 /* Note that there is no real way portable across R3/R4 to get the
10764 original error handler. */
10765 XSetErrorHandler (x_error_handler);
10766 XSetIOErrorHandler (x_io_error_quitter);
10768 /* Disable Window Change signals; they are handled by X events. */
10769 #if 0 /* Don't. We may want to open tty frames later. */
10770 #ifdef SIGWINCH
10771 signal (SIGWINCH, SIG_DFL);
10772 #endif /* SIGWINCH */
10773 #endif
10775 signal (SIGPIPE, x_connection_signal);
10779 void
10780 syms_of_xterm ()
10782 x_error_message = NULL;
10784 staticpro (&x_display_name_list);
10785 x_display_name_list = Qnil;
10787 staticpro (&last_mouse_scroll_bar);
10788 last_mouse_scroll_bar = Qnil;
10790 staticpro (&Qvendor_specific_keysyms);
10791 Qvendor_specific_keysyms = intern ("vendor-specific-keysyms");
10793 staticpro (&Qlatin_1);
10794 Qlatin_1 = intern ("latin-1");
10796 staticpro (&last_mouse_press_frame);
10797 last_mouse_press_frame = Qnil;
10799 DEFVAR_BOOL ("x-use-underline-position-properties",
10800 &x_use_underline_position_properties,
10801 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10802 A value of nil means ignore them. If you encounter fonts with bogus
10803 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10804 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10805 to override the font's UNDERLINE_POSITION for small font display
10806 sizes. */);
10807 x_use_underline_position_properties = 1;
10809 DEFVAR_BOOL ("x-underline-at-descent-line",
10810 &x_underline_at_descent_line,
10811 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10812 A value of nil means to draw the underline according to the value of the
10813 variable `x-use-underline-position-properties', which is usually at the
10814 baseline level. The default value is nil. */);
10815 x_underline_at_descent_line = 0;
10817 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10818 &x_mouse_click_focus_ignore_position,
10819 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10820 This variable is only used when the window manager requires that you
10821 click on a frame to select it (give it focus). In that case, a value
10822 of nil, means that the selected window and cursor position changes to
10823 reflect the mouse click position, while a non-nil value means that the
10824 selected window or cursor position is preserved. */);
10825 x_mouse_click_focus_ignore_position = 0;
10827 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10828 doc: /* What X toolkit scroll bars Emacs uses.
10829 A value of nil means Emacs doesn't use X toolkit scroll bars.
10830 Otherwise, value is a symbol describing the X toolkit. */);
10831 #ifdef USE_TOOLKIT_SCROLL_BARS
10832 #ifdef USE_MOTIF
10833 Vx_toolkit_scroll_bars = intern ("motif");
10834 #elif defined HAVE_XAW3D
10835 Vx_toolkit_scroll_bars = intern ("xaw3d");
10836 #elif USE_GTK
10837 Vx_toolkit_scroll_bars = intern ("gtk");
10838 #else
10839 Vx_toolkit_scroll_bars = intern ("xaw");
10840 #endif
10841 #else
10842 Vx_toolkit_scroll_bars = Qnil;
10843 #endif
10845 staticpro (&last_mouse_motion_frame);
10846 last_mouse_motion_frame = Qnil;
10848 Qmodifier_value = intern ("modifier-value");
10849 Qalt = intern ("alt");
10850 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10851 Qhyper = intern ("hyper");
10852 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10853 Qmeta = intern ("meta");
10854 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10855 Qsuper = intern ("super");
10856 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10858 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10859 doc: /* Which keys Emacs uses for the alt modifier.
10860 This should be one of the symbols `alt', `hyper', `meta', `super'.
10861 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10862 is nil, which is the same as `alt'. */);
10863 Vx_alt_keysym = Qnil;
10865 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10866 doc: /* Which keys Emacs uses for the hyper modifier.
10867 This should be one of the symbols `alt', `hyper', `meta', `super'.
10868 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10869 default is nil, which is the same as `hyper'. */);
10870 Vx_hyper_keysym = Qnil;
10872 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10873 doc: /* Which keys Emacs uses for the meta modifier.
10874 This should be one of the symbols `alt', `hyper', `meta', `super'.
10875 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10876 default is nil, which is the same as `meta'. */);
10877 Vx_meta_keysym = Qnil;
10879 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10880 doc: /* Which keys Emacs uses for the super modifier.
10881 This should be one of the symbols `alt', `hyper', `meta', `super'.
10882 For example, `super' means use the Super_L and Super_R keysyms. The
10883 default is nil, which is the same as `super'. */);
10884 Vx_super_keysym = Qnil;
10886 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10887 doc: /* Hash table of character codes indexed by X keysym codes. */);
10888 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10889 make_float (DEFAULT_REHASH_SIZE),
10890 make_float (DEFAULT_REHASH_THRESHOLD),
10891 Qnil, Qnil, Qnil);
10894 #endif /* HAVE_X_WINDOWS */
10896 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10897 (do not change this comment) */