* makefile.w32-in (INFO_TARGETS, DVI_TARGETS, clean): Add ns-emacs.
[emacs.git] / src / xterm.c
blob57092c2585969f3c454ae8efcbd087515dfb8695
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 /***********************************************************************
531 Starting and ending an update
532 ***********************************************************************/
534 /* Start an update of frame F. This function is installed as a hook
535 for update_begin, i.e. it is called when update_begin is called.
536 This function is called prior to calls to x_update_window_begin for
537 each window being updated. Currently, there is nothing to do here
538 because all interesting stuff is done on a window basis. */
540 static void
541 x_update_begin (f)
542 struct frame *f;
544 /* Nothing to do. */
548 /* Start update of window W. Set the global variable updated_window
549 to the window being updated and set output_cursor to the cursor
550 position of W. */
552 static void
553 x_update_window_begin (w)
554 struct window *w;
556 struct frame *f = XFRAME (WINDOW_FRAME (w));
557 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
559 updated_window = w;
560 set_output_cursor (&w->cursor);
562 BLOCK_INPUT;
564 if (f == display_info->mouse_face_mouse_frame)
566 /* Don't do highlighting for mouse motion during the update. */
567 display_info->mouse_face_defer = 1;
569 /* If F needs to be redrawn, simply forget about any prior mouse
570 highlighting. */
571 if (FRAME_GARBAGED_P (f))
572 display_info->mouse_face_window = Qnil;
574 #if 0 /* Rows in a current matrix containing glyphs in mouse-face have
575 their mouse_face_p flag set, which means that they are always
576 unequal to rows in a desired matrix which never have that
577 flag set. So, rows containing mouse-face glyphs are never
578 scrolled, and we don't have to switch the mouse highlight off
579 here to prevent it from being scrolled. */
581 /* Can we tell that this update does not affect the window
582 where the mouse highlight is? If so, no need to turn off.
583 Likewise, don't do anything if the frame is garbaged;
584 in that case, the frame's current matrix that we would use
585 is all wrong, and we will redisplay that line anyway. */
586 if (!NILP (display_info->mouse_face_window)
587 && w == XWINDOW (display_info->mouse_face_window))
589 int i;
591 for (i = 0; i < w->desired_matrix->nrows; ++i)
592 if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
593 break;
595 if (i < w->desired_matrix->nrows)
596 clear_mouse_face (display_info);
598 #endif /* 0 */
601 UNBLOCK_INPUT;
605 /* Draw a vertical window border from (x,y0) to (x,y1) */
607 static void
608 x_draw_vertical_window_border (w, x, y0, y1)
609 struct window *w;
610 int x, y0, y1;
612 struct frame *f = XFRAME (WINDOW_FRAME (w));
613 struct face *face;
615 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
616 if (face)
617 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
618 face->foreground);
620 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
621 f->output_data.x->normal_gc, x, y0, x, y1);
624 /* End update of window W (which is equal to updated_window).
626 Draw vertical borders between horizontally adjacent windows, and
627 display W's cursor if CURSOR_ON_P is non-zero.
629 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
630 glyphs in mouse-face were overwritten. In that case we have to
631 make sure that the mouse-highlight is properly redrawn.
633 W may be a menu bar pseudo-window in case we don't have X toolkit
634 support. Such windows don't have a cursor, so don't display it
635 here. */
637 static void
638 x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
639 struct window *w;
640 int cursor_on_p, mouse_face_overwritten_p;
642 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
644 if (!w->pseudo_window_p)
646 BLOCK_INPUT;
648 if (cursor_on_p)
649 display_and_set_cursor (w, 1, output_cursor.hpos,
650 output_cursor.vpos,
651 output_cursor.x, output_cursor.y);
653 if (draw_window_fringes (w, 1))
654 x_draw_vertical_border (w);
656 UNBLOCK_INPUT;
659 /* If a row with mouse-face was overwritten, arrange for
660 XTframe_up_to_date to redisplay the mouse highlight. */
661 if (mouse_face_overwritten_p)
663 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
664 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
665 dpyinfo->mouse_face_window = Qnil;
668 updated_window = NULL;
672 /* End update of frame F. This function is installed as a hook in
673 update_end. */
675 static void
676 x_update_end (f)
677 struct frame *f;
679 /* Mouse highlight may be displayed again. */
680 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
682 #ifndef XFlush
683 BLOCK_INPUT;
684 XFlush (FRAME_X_DISPLAY (f));
685 UNBLOCK_INPUT;
686 #endif
690 /* This function is called from various places in xdisp.c whenever a
691 complete update has been performed. The global variable
692 updated_window is not available here. */
694 static void
695 XTframe_up_to_date (f)
696 struct frame *f;
698 if (FRAME_X_P (f))
700 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
702 if (dpyinfo->mouse_face_deferred_gc
703 || f == dpyinfo->mouse_face_mouse_frame)
705 BLOCK_INPUT;
706 if (dpyinfo->mouse_face_mouse_frame)
707 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
708 dpyinfo->mouse_face_mouse_x,
709 dpyinfo->mouse_face_mouse_y);
710 dpyinfo->mouse_face_deferred_gc = 0;
711 UNBLOCK_INPUT;
717 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
718 arrow bitmaps, or clear the fringes if no bitmaps are required
719 before DESIRED_ROW is made current. The window being updated is
720 found in updated_window. This function It is called from
721 update_window_line only if it is known that there are differences
722 between bitmaps to be drawn between current row and DESIRED_ROW. */
724 static void
725 x_after_update_window_line (desired_row)
726 struct glyph_row *desired_row;
728 struct window *w = updated_window;
729 struct frame *f;
730 int width, height;
732 xassert (w);
734 if (!desired_row->mode_line_p && !w->pseudo_window_p)
735 desired_row->redraw_fringe_bitmaps_p = 1;
737 /* When a window has disappeared, make sure that no rest of
738 full-width rows stays visible in the internal border. Could
739 check here if updated_window is the leftmost/rightmost window,
740 but I guess it's not worth doing since vertically split windows
741 are almost never used, internal border is rarely set, and the
742 overhead is very small. */
743 if (windows_or_buffers_changed
744 && desired_row->full_width_p
745 && (f = XFRAME (w->frame),
746 width = FRAME_INTERNAL_BORDER_WIDTH (f),
747 width != 0)
748 && (height = desired_row->visible_height,
749 height > 0))
751 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
753 /* Internal border is drawn below the tool bar. */
754 if (WINDOWP (f->tool_bar_window)
755 && w == XWINDOW (f->tool_bar_window))
756 y -= width;
758 BLOCK_INPUT;
759 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
760 0, y, width, height, False);
761 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
762 FRAME_PIXEL_WIDTH (f) - width,
763 y, width, height, False);
764 UNBLOCK_INPUT;
768 static void
769 x_draw_fringe_bitmap (w, row, p)
770 struct window *w;
771 struct glyph_row *row;
772 struct draw_fringe_bitmap_params *p;
774 struct frame *f = XFRAME (WINDOW_FRAME (w));
775 Display *display = FRAME_X_DISPLAY (f);
776 Window window = FRAME_X_WINDOW (f);
777 GC gc = f->output_data.x->normal_gc;
778 struct face *face = p->face;
779 int rowY;
781 /* Must clip because of partially visible lines. */
782 rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
783 if (p->y < rowY)
785 /* Adjust position of "bottom aligned" bitmap on partially
786 visible last row. */
787 int oldY = row->y;
788 int oldVH = row->visible_height;
789 row->visible_height = p->h;
790 row->y -= rowY - p->y;
791 x_clip_to_row (w, row, -1, gc);
792 row->y = oldY;
793 row->visible_height = oldVH;
795 else
796 x_clip_to_row (w, row, -1, gc);
798 if (!p->overlay_p)
800 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
802 /* In case the same realized face is used for fringes and
803 for something displayed in the text (e.g. face `region' on
804 mono-displays, the fill style may have been changed to
805 FillSolid in x_draw_glyph_string_background. */
806 if (face->stipple)
807 XSetFillStyle (display, face->gc, FillOpaqueStippled);
808 else
809 XSetForeground (display, face->gc, face->background);
811 #ifdef USE_TOOLKIT_SCROLL_BARS
812 /* If the fringe is adjacent to the left (right) scroll bar of a
813 leftmost (rightmost, respectively) window, then extend its
814 background to the gap between the fringe and the bar. */
815 if ((WINDOW_LEFTMOST_P (w)
816 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
817 || (WINDOW_RIGHTMOST_P (w)
818 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
820 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
822 if (sb_width > 0)
824 int left = WINDOW_SCROLL_BAR_AREA_X (w);
825 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
826 * FRAME_COLUMN_WIDTH (f));
828 if (bx < 0)
830 /* Bitmap fills the fringe. */
831 if (left + width == p->x)
832 bx = left + sb_width;
833 else if (p->x + p->wd == left)
834 bx = left;
835 if (bx >= 0)
837 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
839 nx = width - sb_width;
840 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
841 row->y));
842 ny = row->visible_height;
845 else
847 if (left + width == bx)
849 bx = left + sb_width;
850 nx += width - sb_width;
852 else if (bx + nx == left)
853 nx += width - sb_width;
857 #endif
858 if (bx >= 0 && nx > 0)
859 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
861 if (!face->stipple)
862 XSetForeground (display, face->gc, face->foreground);
865 if (p->which)
867 unsigned char *bits;
868 Pixmap pixmap, clipmask = (Pixmap) 0;
869 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
870 XGCValues gcv;
872 if (p->wd > 8)
873 bits = (unsigned char *)(p->bits + p->dh);
874 else
875 bits = (unsigned char *)p->bits + p->dh;
877 /* Draw the bitmap. I believe these small pixmaps can be cached
878 by the server. */
879 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
880 (p->cursor_p
881 ? (p->overlay_p ? face->background
882 : f->output_data.x->cursor_pixel)
883 : face->foreground),
884 face->background, depth);
886 if (p->overlay_p)
888 clipmask = XCreatePixmapFromBitmapData (display,
889 FRAME_X_DISPLAY_INFO (f)->root_window,
890 bits, p->wd, p->h,
891 1, 0, 1);
892 gcv.clip_mask = clipmask;
893 gcv.clip_x_origin = p->x;
894 gcv.clip_y_origin = p->y;
895 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
898 XCopyArea (display, pixmap, window, gc, 0, 0,
899 p->wd, p->h, p->x, p->y);
900 XFreePixmap (display, pixmap);
902 if (p->overlay_p)
904 gcv.clip_mask = (Pixmap) 0;
905 XChangeGC (display, gc, GCClipMask, &gcv);
906 XFreePixmap (display, clipmask);
910 XSetClipMask (display, gc, None);
915 /* This is called when starting Emacs and when restarting after
916 suspend. When starting Emacs, no X window is mapped. And nothing
917 must be done to Emacs's own window if it is suspended (though that
918 rarely happens). */
920 static void
921 XTset_terminal_modes (struct terminal *terminal)
925 /* This is called when exiting or suspending Emacs. Exiting will make
926 the X-windows go away, and suspending requires no action. */
928 static void
929 XTreset_terminal_modes (struct terminal *terminal)
934 /***********************************************************************
935 Glyph display
936 ***********************************************************************/
940 static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
941 static void x_set_glyph_string_gc P_ ((struct glyph_string *));
942 static void x_draw_glyph_string_background P_ ((struct glyph_string *,
943 int));
944 static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
945 static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
946 static void x_draw_glyph_string_box P_ ((struct glyph_string *));
947 static void x_draw_glyph_string P_ ((struct glyph_string *));
948 static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
949 static void x_set_cursor_gc P_ ((struct glyph_string *));
950 static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
951 static void x_set_mouse_face_gc P_ ((struct glyph_string *));
952 static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
953 unsigned long *, double, int));
954 static void x_setup_relief_color P_ ((struct frame *, struct relief *,
955 double, int, unsigned long));
956 static void x_setup_relief_colors P_ ((struct glyph_string *));
957 static void x_draw_image_glyph_string P_ ((struct glyph_string *));
958 static void x_draw_image_relief P_ ((struct glyph_string *));
959 static void x_draw_image_foreground P_ ((struct glyph_string *));
960 static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
961 static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
962 int, int, int));
963 static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
964 int, int, int, int, int, int,
965 XRectangle *));
966 static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
967 int, int, int, XRectangle *));
969 #if GLYPH_DEBUG
970 static void x_check_font P_ ((struct frame *, struct font *));
971 #endif
974 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
975 face. */
977 static void
978 x_set_cursor_gc (s)
979 struct glyph_string *s;
981 if (s->font == FRAME_FONT (s->f)
982 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
983 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
984 && !s->cmp)
985 s->gc = s->f->output_data.x->cursor_gc;
986 else
988 /* Cursor on non-default face: must merge. */
989 XGCValues xgcv;
990 unsigned long mask;
992 xgcv.background = s->f->output_data.x->cursor_pixel;
993 xgcv.foreground = s->face->background;
995 /* If the glyph would be invisible, try a different foreground. */
996 if (xgcv.foreground == xgcv.background)
997 xgcv.foreground = s->face->foreground;
998 if (xgcv.foreground == xgcv.background)
999 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
1000 if (xgcv.foreground == xgcv.background)
1001 xgcv.foreground = s->face->foreground;
1003 /* Make sure the cursor is distinct from text in this face. */
1004 if (xgcv.background == s->face->background
1005 && xgcv.foreground == s->face->foreground)
1007 xgcv.background = s->face->foreground;
1008 xgcv.foreground = s->face->background;
1011 IF_DEBUG (x_check_font (s->f, s->font));
1012 xgcv.graphics_exposures = False;
1013 mask = GCForeground | GCBackground | GCGraphicsExposures;
1015 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1016 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1017 mask, &xgcv);
1018 else
1019 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1020 = XCreateGC (s->display, s->window, mask, &xgcv);
1022 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1027 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1029 static void
1030 x_set_mouse_face_gc (s)
1031 struct glyph_string *s;
1033 int face_id;
1034 struct face *face;
1036 /* What face has to be used last for the mouse face? */
1037 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1038 face = FACE_FROM_ID (s->f, face_id);
1039 if (face == NULL)
1040 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1042 if (s->first_glyph->type == CHAR_GLYPH)
1043 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1044 else
1045 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1046 s->face = FACE_FROM_ID (s->f, face_id);
1047 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1049 if (s->font == s->face->font)
1050 s->gc = s->face->gc;
1051 else
1053 /* Otherwise construct scratch_cursor_gc with values from FACE
1054 except for FONT. */
1055 XGCValues xgcv;
1056 unsigned long mask;
1058 xgcv.background = s->face->background;
1059 xgcv.foreground = s->face->foreground;
1060 xgcv.graphics_exposures = False;
1061 mask = GCForeground | GCBackground | GCGraphicsExposures;
1063 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1064 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1065 mask, &xgcv);
1066 else
1067 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1068 = XCreateGC (s->display, s->window, mask, &xgcv);
1070 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1073 xassert (s->gc != 0);
1077 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1078 Faces to use in the mode line have already been computed when the
1079 matrix was built, so there isn't much to do, here. */
1081 static INLINE void
1082 x_set_mode_line_face_gc (s)
1083 struct glyph_string *s;
1085 s->gc = s->face->gc;
1089 /* Set S->gc of glyph string S for drawing that glyph string. Set
1090 S->stippled_p to a non-zero value if the face of S has a stipple
1091 pattern. */
1093 static INLINE void
1094 x_set_glyph_string_gc (s)
1095 struct glyph_string *s;
1097 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1099 if (s->hl == DRAW_NORMAL_TEXT)
1101 s->gc = s->face->gc;
1102 s->stippled_p = s->face->stipple != 0;
1104 else if (s->hl == DRAW_INVERSE_VIDEO)
1106 x_set_mode_line_face_gc (s);
1107 s->stippled_p = s->face->stipple != 0;
1109 else if (s->hl == DRAW_CURSOR)
1111 x_set_cursor_gc (s);
1112 s->stippled_p = 0;
1114 else if (s->hl == DRAW_MOUSE_FACE)
1116 x_set_mouse_face_gc (s);
1117 s->stippled_p = s->face->stipple != 0;
1119 else if (s->hl == DRAW_IMAGE_RAISED
1120 || s->hl == DRAW_IMAGE_SUNKEN)
1122 s->gc = s->face->gc;
1123 s->stippled_p = s->face->stipple != 0;
1125 else
1127 s->gc = s->face->gc;
1128 s->stippled_p = s->face->stipple != 0;
1131 /* GC must have been set. */
1132 xassert (s->gc != 0);
1136 /* Set clipping for output of glyph string S. S may be part of a mode
1137 line or menu if we don't have X toolkit support. */
1139 static INLINE void
1140 x_set_glyph_string_clipping (s)
1141 struct glyph_string *s;
1143 XRectangle *r = s->clip;
1144 int n = get_glyph_string_clip_rects (s, r, 2);
1146 if (n > 0)
1147 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1148 s->num_clips = n;
1152 /* Set SRC's clipping for output of glyph string DST. This is called
1153 when we are drawing DST's left_overhang or right_overhang only in
1154 the area of SRC. */
1156 static void
1157 x_set_glyph_string_clipping_exactly (src, dst)
1158 struct glyph_string *src, *dst;
1160 XRectangle r;
1162 r.x = src->x;
1163 r.width = src->width;
1164 r.y = src->y;
1165 r.height = src->height;
1166 dst->clip[0] = r;
1167 dst->num_clips = 1;
1168 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1172 /* RIF:
1173 Compute left and right overhang of glyph string S. */
1175 static void
1176 x_compute_glyph_string_overhangs (s)
1177 struct glyph_string *s;
1179 if (s->cmp == NULL
1180 && s->first_glyph->type == CHAR_GLYPH)
1182 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1183 struct font *font = s->font;
1184 struct font_metrics metrics;
1185 int i;
1187 for (i = 0; i < s->nchars; i++)
1188 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1189 font->driver->text_extents (font, code, s->nchars, &metrics);
1190 s->right_overhang = (metrics.rbearing > metrics.width
1191 ? metrics.rbearing - metrics.width : 0);
1192 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1194 else if (s->cmp)
1196 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1197 s->left_overhang = - s->cmp->lbearing;
1202 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1204 static INLINE void
1205 x_clear_glyph_string_rect (s, x, y, w, h)
1206 struct glyph_string *s;
1207 int x, y, w, h;
1209 XGCValues xgcv;
1210 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1211 XSetForeground (s->display, s->gc, xgcv.background);
1212 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1213 XSetForeground (s->display, s->gc, xgcv.foreground);
1217 /* Draw the background of glyph_string S. If S->background_filled_p
1218 is non-zero don't draw it. FORCE_P non-zero means draw the
1219 background even if it wouldn't be drawn normally. This is used
1220 when a string preceding S draws into the background of S, or S
1221 contains the first component of a composition. */
1223 static void
1224 x_draw_glyph_string_background (s, force_p)
1225 struct glyph_string *s;
1226 int force_p;
1228 /* Nothing to do if background has already been drawn or if it
1229 shouldn't be drawn in the first place. */
1230 if (!s->background_filled_p)
1232 int box_line_width = max (s->face->box_line_width, 0);
1234 if (s->stippled_p)
1236 /* Fill background with a stipple pattern. */
1237 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1238 XFillRectangle (s->display, s->window, s->gc, s->x,
1239 s->y + box_line_width,
1240 s->background_width,
1241 s->height - 2 * box_line_width);
1242 XSetFillStyle (s->display, s->gc, FillSolid);
1243 s->background_filled_p = 1;
1245 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1246 || s->font_not_found_p
1247 || s->extends_to_end_of_line_p
1248 || force_p)
1250 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1251 s->background_width,
1252 s->height - 2 * box_line_width);
1253 s->background_filled_p = 1;
1259 /* Draw the foreground of glyph string S. */
1261 static void
1262 x_draw_glyph_string_foreground (s)
1263 struct glyph_string *s;
1265 int i, x;
1267 /* If first glyph of S has a left box line, start drawing the text
1268 of S to the right of that box line. */
1269 if (s->face->box != FACE_NO_BOX
1270 && s->first_glyph->left_box_line_p)
1271 x = s->x + eabs (s->face->box_line_width);
1272 else
1273 x = s->x;
1275 /* Draw characters of S as rectangles if S's font could not be
1276 loaded. */
1277 if (s->font_not_found_p)
1279 for (i = 0; i < s->nchars; ++i)
1281 struct glyph *g = s->first_glyph + i;
1282 XDrawRectangle (s->display, s->window,
1283 s->gc, x, s->y, g->pixel_width - 1,
1284 s->height - 1);
1285 x += g->pixel_width;
1288 else
1290 struct font *font = s->font;
1291 int boff = font->baseline_offset;
1292 int y;
1294 if (font->vertical_centering)
1295 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1297 y = s->ybase - boff;
1298 if (s->for_overlaps
1299 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1300 font->driver->draw (s, 0, s->nchars, x, y, 0);
1301 else
1302 font->driver->draw (s, 0, s->nchars, x, y, 1);
1303 if (s->face->overstrike)
1304 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1308 /* Draw the foreground of composite glyph string S. */
1310 static void
1311 x_draw_composite_glyph_string_foreground (s)
1312 struct glyph_string *s;
1314 int i, j, x;
1316 /* If first glyph of S has a left box line, start drawing the text
1317 of S to the right of that box line. */
1318 if (s->face && s->face->box != FACE_NO_BOX
1319 && s->first_glyph->left_box_line_p)
1320 x = s->x + eabs (s->face->box_line_width);
1321 else
1322 x = s->x;
1324 /* S is a glyph string for a composition. S->gidx is the index of
1325 the first character drawn for glyphs of this composition.
1326 S->gidx == 0 means we are drawing the very first character of
1327 this composition. */
1329 /* Draw a rectangle for the composition if the font for the very
1330 first character of the composition could not be loaded. */
1331 if (s->font_not_found_p)
1333 if (s->gidx == 0)
1334 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1335 s->width - 1, s->height - 1);
1337 else
1339 struct font *font = s->font;
1340 int y = s->ybase;
1341 int width = 0;
1343 if (s->cmp->method == COMPOSITION_WITH_GLYPH_STRING)
1345 Lisp_Object gstring = AREF (XHASH_TABLE (composition_hash_table)
1346 ->key_and_value,
1347 s->cmp->hash_index * 2);
1348 int from;
1350 for (i = from = 0; i < s->nchars; i++)
1352 Lisp_Object g = LGSTRING_GLYPH (gstring, i);
1353 Lisp_Object adjustment = LGLYPH_ADJUSTMENT (g);
1354 int xoff, yoff, wadjust;
1356 if (! VECTORP (adjustment))
1358 width += LGLYPH_WIDTH (g);
1359 continue;
1361 if (from < i)
1363 font->driver->draw (s, from, i, x, y, 0);
1364 x += width;
1366 xoff = XINT (AREF (adjustment, 0));
1367 yoff = XINT (AREF (adjustment, 1));
1368 wadjust = XINT (AREF (adjustment, 2));
1370 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1371 x += wadjust;
1372 from = i + 1;
1373 width = 0;
1375 if (from < i)
1376 font->driver->draw (s, from, i, x, y, 0);
1378 else
1380 for (i = 0, j = s->gidx; i < s->nchars; i++, j++)
1381 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1383 int xx = x + s->cmp->offsets[j * 2];
1384 int yy = y - s->cmp->offsets[j * 2 + 1];
1386 font->driver->draw (s, j, j + 1, xx, yy, 0);
1387 if (s->face->overstrike)
1388 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1395 #ifdef USE_X_TOOLKIT
1397 static struct frame *x_frame_of_widget P_ ((Widget));
1398 static Boolean cvt_string_to_pixel P_ ((Display *, XrmValue *, Cardinal *,
1399 XrmValue *, XrmValue *, XtPointer *));
1400 static void cvt_pixel_dtor P_ ((XtAppContext, XrmValue *, XtPointer,
1401 XrmValue *, Cardinal *));
1404 /* Return the frame on which widget WIDGET is used.. Abort if frame
1405 cannot be determined. */
1407 static struct frame *
1408 x_frame_of_widget (widget)
1409 Widget widget;
1411 struct x_display_info *dpyinfo;
1412 Lisp_Object tail;
1413 struct frame *f;
1415 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1417 /* Find the top-level shell of the widget. Note that this function
1418 can be called when the widget is not yet realized, so XtWindow
1419 (widget) == 0. That's the reason we can't simply use
1420 x_any_window_to_frame. */
1421 while (!XtIsTopLevelShell (widget))
1422 widget = XtParent (widget);
1424 /* Look for a frame with that top-level widget. Allocate the color
1425 on that frame to get the right gamma correction value. */
1426 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1427 if (FRAMEP (XCAR (tail))
1428 && (f = XFRAME (XCAR (tail)),
1429 (FRAME_X_P (f)
1430 && f->output_data.nothing != 1
1431 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1432 && f->output_data.x->widget == widget)
1433 return f;
1435 abort ();
1439 /* Allocate the color COLOR->pixel on the screen and display of
1440 widget WIDGET in colormap CMAP. If an exact match cannot be
1441 allocated, try the nearest color available. Value is non-zero
1442 if successful. This is called from lwlib. */
1445 x_alloc_nearest_color_for_widget (widget, cmap, color)
1446 Widget widget;
1447 Colormap cmap;
1448 XColor *color;
1450 struct frame *f = x_frame_of_widget (widget);
1451 return x_alloc_nearest_color (f, cmap, color);
1455 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1456 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1457 If this produces the same color as PIXEL, try a color where all RGB
1458 values have DELTA added. Return the allocated color in *PIXEL.
1459 DISPLAY is the X display, CMAP is the colormap to operate on.
1460 Value is non-zero if successful. */
1463 x_alloc_lighter_color_for_widget (widget, display, cmap, pixel, factor, delta)
1464 Widget widget;
1465 Display *display;
1466 Colormap cmap;
1467 unsigned long *pixel;
1468 double factor;
1469 int delta;
1471 struct frame *f = x_frame_of_widget (widget);
1472 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1476 /* Structure specifying which arguments should be passed by Xt to
1477 cvt_string_to_pixel. We want the widget's screen and colormap. */
1479 static XtConvertArgRec cvt_string_to_pixel_args[] =
1481 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1482 sizeof (Screen *)},
1483 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1484 sizeof (Colormap)}
1488 /* The address of this variable is returned by
1489 cvt_string_to_pixel. */
1491 static Pixel cvt_string_to_pixel_value;
1494 /* Convert a color name to a pixel color.
1496 DPY is the display we are working on.
1498 ARGS is an array of *NARGS XrmValue structures holding additional
1499 information about the widget for which the conversion takes place.
1500 The contents of this array are determined by the specification
1501 in cvt_string_to_pixel_args.
1503 FROM is a pointer to an XrmValue which points to the color name to
1504 convert. TO is an XrmValue in which to return the pixel color.
1506 CLOSURE_RET is a pointer to user-data, in which we record if
1507 we allocated the color or not.
1509 Value is True if successful, False otherwise. */
1511 static Boolean
1512 cvt_string_to_pixel (dpy, args, nargs, from, to, closure_ret)
1513 Display *dpy;
1514 XrmValue *args;
1515 Cardinal *nargs;
1516 XrmValue *from, *to;
1517 XtPointer *closure_ret;
1519 Screen *screen;
1520 Colormap cmap;
1521 Pixel pixel;
1522 String color_name;
1523 XColor color;
1525 if (*nargs != 2)
1527 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1528 "wrongParameters", "cvt_string_to_pixel",
1529 "XtToolkitError",
1530 "Screen and colormap args required", NULL, NULL);
1531 return False;
1534 screen = *(Screen **) args[0].addr;
1535 cmap = *(Colormap *) args[1].addr;
1536 color_name = (String) from->addr;
1538 if (strcmp (color_name, XtDefaultBackground) == 0)
1540 *closure_ret = (XtPointer) False;
1541 pixel = WhitePixelOfScreen (screen);
1543 else if (strcmp (color_name, XtDefaultForeground) == 0)
1545 *closure_ret = (XtPointer) False;
1546 pixel = BlackPixelOfScreen (screen);
1548 else if (XParseColor (dpy, cmap, color_name, &color)
1549 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1551 pixel = color.pixel;
1552 *closure_ret = (XtPointer) True;
1554 else
1556 String params[1];
1557 Cardinal nparams = 1;
1559 params[0] = color_name;
1560 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1561 "badValue", "cvt_string_to_pixel",
1562 "XtToolkitError", "Invalid color `%s'",
1563 params, &nparams);
1564 return False;
1567 if (to->addr != NULL)
1569 if (to->size < sizeof (Pixel))
1571 to->size = sizeof (Pixel);
1572 return False;
1575 *(Pixel *) to->addr = pixel;
1577 else
1579 cvt_string_to_pixel_value = pixel;
1580 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1583 to->size = sizeof (Pixel);
1584 return True;
1588 /* Free a pixel color which was previously allocated via
1589 cvt_string_to_pixel. This is registered as the destructor
1590 for this type of resource via XtSetTypeConverter.
1592 APP is the application context in which we work.
1594 TO is a pointer to an XrmValue holding the color to free.
1595 CLOSURE is the value we stored in CLOSURE_RET for this color
1596 in cvt_string_to_pixel.
1598 ARGS and NARGS are like for cvt_string_to_pixel. */
1600 static void
1601 cvt_pixel_dtor (app, to, closure, args, nargs)
1602 XtAppContext app;
1603 XrmValuePtr to;
1604 XtPointer closure;
1605 XrmValuePtr args;
1606 Cardinal *nargs;
1608 if (*nargs != 2)
1610 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1611 "XtToolkitError",
1612 "Screen and colormap arguments required",
1613 NULL, NULL);
1615 else if (closure != NULL)
1617 /* We did allocate the pixel, so free it. */
1618 Screen *screen = *(Screen **) args[0].addr;
1619 Colormap cmap = *(Colormap *) args[1].addr;
1620 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1621 (Pixel *) to->addr, 1);
1626 #endif /* USE_X_TOOLKIT */
1629 /* Value is an array of XColor structures for the contents of the
1630 color map of display DPY. Set *NCELLS to the size of the array.
1631 Note that this probably shouldn't be called for large color maps,
1632 say a 24-bit TrueColor map. */
1634 static const XColor *
1635 x_color_cells (dpy, ncells)
1636 Display *dpy;
1637 int *ncells;
1639 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1641 if (dpyinfo->color_cells == NULL)
1643 Screen *screen = dpyinfo->screen;
1644 int i;
1646 dpyinfo->ncolor_cells
1647 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1648 dpyinfo->color_cells
1649 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1650 * sizeof *dpyinfo->color_cells);
1652 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1653 dpyinfo->color_cells[i].pixel = i;
1655 XQueryColors (dpy, dpyinfo->cmap,
1656 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1659 *ncells = dpyinfo->ncolor_cells;
1660 return dpyinfo->color_cells;
1664 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1665 colors in COLORS. Use cached information, if available. */
1667 void
1668 x_query_colors (f, colors, ncolors)
1669 struct frame *f;
1670 XColor *colors;
1671 int ncolors;
1673 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1675 if (dpyinfo->color_cells)
1677 int i;
1678 for (i = 0; i < ncolors; ++i)
1680 unsigned long pixel = colors[i].pixel;
1681 xassert (pixel < dpyinfo->ncolor_cells);
1682 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1683 colors[i] = dpyinfo->color_cells[pixel];
1686 else
1687 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1691 /* On frame F, translate pixel color to RGB values for the color in
1692 COLOR. Use cached information, if available. */
1694 void
1695 x_query_color (f, color)
1696 struct frame *f;
1697 XColor *color;
1699 x_query_colors (f, color, 1);
1703 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1704 exact match can't be allocated, try the nearest color available.
1705 Value is non-zero if successful. Set *COLOR to the color
1706 allocated. */
1708 static int
1709 x_alloc_nearest_color_1 (dpy, cmap, color)
1710 Display *dpy;
1711 Colormap cmap;
1712 XColor *color;
1714 int rc;
1716 rc = XAllocColor (dpy, cmap, color);
1717 if (rc == 0)
1719 /* If we got to this point, the colormap is full, so we're going
1720 to try to get the next closest color. The algorithm used is
1721 a least-squares matching, which is what X uses for closest
1722 color matching with StaticColor visuals. */
1723 int nearest, i;
1724 unsigned long nearest_delta = ~0;
1725 int ncells;
1726 const XColor *cells = x_color_cells (dpy, &ncells);
1728 for (nearest = i = 0; i < ncells; ++i)
1730 long dred = (color->red >> 8) - (cells[i].red >> 8);
1731 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1732 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1733 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1735 if (delta < nearest_delta)
1737 nearest = i;
1738 nearest_delta = delta;
1742 color->red = cells[nearest].red;
1743 color->green = cells[nearest].green;
1744 color->blue = cells[nearest].blue;
1745 rc = XAllocColor (dpy, cmap, color);
1747 else
1749 /* If allocation succeeded, and the allocated pixel color is not
1750 equal to a cached pixel color recorded earlier, there was a
1751 change in the colormap, so clear the color cache. */
1752 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1753 XColor *cached_color;
1755 if (dpyinfo->color_cells
1756 && (cached_color = &dpyinfo->color_cells[color->pixel],
1757 (cached_color->red != color->red
1758 || cached_color->blue != color->blue
1759 || cached_color->green != color->green)))
1761 xfree (dpyinfo->color_cells);
1762 dpyinfo->color_cells = NULL;
1763 dpyinfo->ncolor_cells = 0;
1767 #ifdef DEBUG_X_COLORS
1768 if (rc)
1769 register_color (color->pixel);
1770 #endif /* DEBUG_X_COLORS */
1772 return rc;
1776 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1777 exact match can't be allocated, try the nearest color available.
1778 Value is non-zero if successful. Set *COLOR to the color
1779 allocated. */
1782 x_alloc_nearest_color (f, cmap, color)
1783 struct frame *f;
1784 Colormap cmap;
1785 XColor *color;
1787 gamma_correct (f, color);
1788 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1792 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1793 It's necessary to do this instead of just using PIXEL directly to
1794 get color reference counts right. */
1796 unsigned long
1797 x_copy_color (f, pixel)
1798 struct frame *f;
1799 unsigned long pixel;
1801 XColor color;
1803 color.pixel = pixel;
1804 BLOCK_INPUT;
1805 x_query_color (f, &color);
1806 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1807 UNBLOCK_INPUT;
1808 #ifdef DEBUG_X_COLORS
1809 register_color (pixel);
1810 #endif
1811 return color.pixel;
1815 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1816 It's necessary to do this instead of just using PIXEL directly to
1817 get color reference counts right. */
1819 unsigned long
1820 x_copy_dpy_color (dpy, cmap, pixel)
1821 Display *dpy;
1822 Colormap cmap;
1823 unsigned long pixel;
1825 XColor color;
1827 color.pixel = pixel;
1828 BLOCK_INPUT;
1829 XQueryColor (dpy, cmap, &color);
1830 XAllocColor (dpy, cmap, &color);
1831 UNBLOCK_INPUT;
1832 #ifdef DEBUG_X_COLORS
1833 register_color (pixel);
1834 #endif
1835 return color.pixel;
1839 /* Brightness beyond which a color won't have its highlight brightness
1840 boosted.
1842 Nominally, highlight colors for `3d' faces are calculated by
1843 brightening an object's color by a constant scale factor, but this
1844 doesn't yield good results for dark colors, so for colors who's
1845 brightness is less than this value (on a scale of 0-65535) have an
1846 use an additional additive factor.
1848 The value here is set so that the default menu-bar/mode-line color
1849 (grey75) will not have its highlights changed at all. */
1850 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1853 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1854 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1855 If this produces the same color as PIXEL, try a color where all RGB
1856 values have DELTA added. Return the allocated color in *PIXEL.
1857 DISPLAY is the X display, CMAP is the colormap to operate on.
1858 Value is non-zero if successful. */
1860 static int
1861 x_alloc_lighter_color (f, display, cmap, pixel, factor, delta)
1862 struct frame *f;
1863 Display *display;
1864 Colormap cmap;
1865 unsigned long *pixel;
1866 double factor;
1867 int delta;
1869 XColor color, new;
1870 long bright;
1871 int success_p;
1873 /* Get RGB color values. */
1874 color.pixel = *pixel;
1875 x_query_color (f, &color);
1877 /* Change RGB values by specified FACTOR. Avoid overflow! */
1878 xassert (factor >= 0);
1879 new.red = min (0xffff, factor * color.red);
1880 new.green = min (0xffff, factor * color.green);
1881 new.blue = min (0xffff, factor * color.blue);
1883 /* Calculate brightness of COLOR. */
1884 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1886 /* We only boost colors that are darker than
1887 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1888 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1889 /* Make an additive adjustment to NEW, because it's dark enough so
1890 that scaling by FACTOR alone isn't enough. */
1892 /* How far below the limit this color is (0 - 1, 1 being darker). */
1893 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1894 /* The additive adjustment. */
1895 int min_delta = delta * dimness * factor / 2;
1897 if (factor < 1)
1899 new.red = max (0, new.red - min_delta);
1900 new.green = max (0, new.green - min_delta);
1901 new.blue = max (0, new.blue - min_delta);
1903 else
1905 new.red = min (0xffff, min_delta + new.red);
1906 new.green = min (0xffff, min_delta + new.green);
1907 new.blue = min (0xffff, min_delta + new.blue);
1911 /* Try to allocate the color. */
1912 success_p = x_alloc_nearest_color (f, cmap, &new);
1913 if (success_p)
1915 if (new.pixel == *pixel)
1917 /* If we end up with the same color as before, try adding
1918 delta to the RGB values. */
1919 x_free_colors (f, &new.pixel, 1);
1921 new.red = min (0xffff, delta + color.red);
1922 new.green = min (0xffff, delta + color.green);
1923 new.blue = min (0xffff, delta + color.blue);
1924 success_p = x_alloc_nearest_color (f, cmap, &new);
1926 else
1927 success_p = 1;
1928 *pixel = new.pixel;
1931 return success_p;
1935 /* Set up the foreground color for drawing relief lines of glyph
1936 string S. RELIEF is a pointer to a struct relief containing the GC
1937 with which lines will be drawn. Use a color that is FACTOR or
1938 DELTA lighter or darker than the relief's background which is found
1939 in S->f->output_data.x->relief_background. If such a color cannot
1940 be allocated, use DEFAULT_PIXEL, instead. */
1942 static void
1943 x_setup_relief_color (f, relief, factor, delta, default_pixel)
1944 struct frame *f;
1945 struct relief *relief;
1946 double factor;
1947 int delta;
1948 unsigned long default_pixel;
1950 XGCValues xgcv;
1951 struct x_output *di = f->output_data.x;
1952 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1953 unsigned long pixel;
1954 unsigned long background = di->relief_background;
1955 Colormap cmap = FRAME_X_COLORMAP (f);
1956 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1957 Display *dpy = FRAME_X_DISPLAY (f);
1959 xgcv.graphics_exposures = False;
1960 xgcv.line_width = 1;
1962 /* Free previously allocated color. The color cell will be reused
1963 when it has been freed as many times as it was allocated, so this
1964 doesn't affect faces using the same colors. */
1965 if (relief->gc
1966 && relief->allocated_p)
1968 x_free_colors (f, &relief->pixel, 1);
1969 relief->allocated_p = 0;
1972 /* Allocate new color. */
1973 xgcv.foreground = default_pixel;
1974 pixel = background;
1975 if (dpyinfo->n_planes != 1
1976 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1978 relief->allocated_p = 1;
1979 xgcv.foreground = relief->pixel = pixel;
1982 if (relief->gc == 0)
1984 xgcv.stipple = dpyinfo->gray;
1985 mask |= GCStipple;
1986 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1988 else
1989 XChangeGC (dpy, relief->gc, mask, &xgcv);
1993 /* Set up colors for the relief lines around glyph string S. */
1995 static void
1996 x_setup_relief_colors (s)
1997 struct glyph_string *s;
1999 struct x_output *di = s->f->output_data.x;
2000 unsigned long color;
2002 if (s->face->use_box_color_for_shadows_p)
2003 color = s->face->box_color;
2004 else if (s->first_glyph->type == IMAGE_GLYPH
2005 && s->img->pixmap
2006 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2007 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2008 else
2010 XGCValues xgcv;
2012 /* Get the background color of the face. */
2013 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2014 color = xgcv.background;
2017 if (di->white_relief.gc == 0
2018 || color != di->relief_background)
2020 di->relief_background = color;
2021 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2022 WHITE_PIX_DEFAULT (s->f));
2023 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2024 BLACK_PIX_DEFAULT (s->f));
2029 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2030 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2031 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2032 relief. LEFT_P non-zero means draw a relief on the left side of
2033 the rectangle. RIGHT_P non-zero means draw a relief on the right
2034 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2035 when drawing. */
2037 static void
2038 x_draw_relief_rect (f, left_x, top_y, right_x, bottom_y, width,
2039 raised_p, top_p, bot_p, left_p, right_p, clip_rect)
2040 struct frame *f;
2041 int left_x, top_y, right_x, bottom_y, width;
2042 int top_p, bot_p, left_p, right_p, raised_p;
2043 XRectangle *clip_rect;
2045 Display *dpy = FRAME_X_DISPLAY (f);
2046 Window window = FRAME_X_WINDOW (f);
2047 int i;
2048 GC gc;
2050 if (raised_p)
2051 gc = f->output_data.x->white_relief.gc;
2052 else
2053 gc = f->output_data.x->black_relief.gc;
2054 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2056 /* Top. */
2057 if (top_p)
2058 for (i = 0; i < width; ++i)
2059 XDrawLine (dpy, window, gc,
2060 left_x + i * left_p, top_y + i,
2061 right_x + 1 - i * right_p, top_y + i);
2063 /* Left. */
2064 if (left_p)
2065 for (i = 0; i < width; ++i)
2066 XDrawLine (dpy, window, gc,
2067 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2069 XSetClipMask (dpy, gc, None);
2070 if (raised_p)
2071 gc = f->output_data.x->black_relief.gc;
2072 else
2073 gc = f->output_data.x->white_relief.gc;
2074 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2076 /* Bottom. */
2077 if (bot_p)
2078 for (i = 0; i < width; ++i)
2079 XDrawLine (dpy, window, gc,
2080 left_x + i * left_p, bottom_y - i,
2081 right_x + 1 - i * right_p, bottom_y - i);
2083 /* Right. */
2084 if (right_p)
2085 for (i = 0; i < width; ++i)
2086 XDrawLine (dpy, window, gc,
2087 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2089 XSetClipMask (dpy, gc, None);
2093 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2094 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2095 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2096 left side of the rectangle. RIGHT_P non-zero means draw a line
2097 on the right side of the rectangle. CLIP_RECT is the clipping
2098 rectangle to use when drawing. */
2100 static void
2101 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2102 left_p, right_p, clip_rect)
2103 struct glyph_string *s;
2104 int left_x, top_y, right_x, bottom_y, width, left_p, right_p;
2105 XRectangle *clip_rect;
2107 XGCValues xgcv;
2109 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2110 XSetForeground (s->display, s->gc, s->face->box_color);
2111 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2113 /* Top. */
2114 XFillRectangle (s->display, s->window, s->gc,
2115 left_x, top_y, right_x - left_x + 1, width);
2117 /* Left. */
2118 if (left_p)
2119 XFillRectangle (s->display, s->window, s->gc,
2120 left_x, top_y, width, bottom_y - top_y + 1);
2122 /* Bottom. */
2123 XFillRectangle (s->display, s->window, s->gc,
2124 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2126 /* Right. */
2127 if (right_p)
2128 XFillRectangle (s->display, s->window, s->gc,
2129 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2131 XSetForeground (s->display, s->gc, xgcv.foreground);
2132 XSetClipMask (s->display, s->gc, None);
2136 /* Draw a box around glyph string S. */
2138 static void
2139 x_draw_glyph_string_box (s)
2140 struct glyph_string *s;
2142 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2143 int left_p, right_p;
2144 struct glyph *last_glyph;
2145 XRectangle clip_rect;
2147 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2148 ? WINDOW_RIGHT_EDGE_X (s->w)
2149 : window_box_right (s->w, s->area));
2151 /* The glyph that may have a right box line. */
2152 last_glyph = (s->cmp || s->img
2153 ? s->first_glyph
2154 : s->first_glyph + s->nchars - 1);
2156 width = eabs (s->face->box_line_width);
2157 raised_p = s->face->box == FACE_RAISED_BOX;
2158 left_x = s->x;
2159 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2160 ? last_x - 1
2161 : min (last_x, s->x + s->background_width) - 1);
2162 top_y = s->y;
2163 bottom_y = top_y + s->height - 1;
2165 left_p = (s->first_glyph->left_box_line_p
2166 || (s->hl == DRAW_MOUSE_FACE
2167 && (s->prev == NULL
2168 || s->prev->hl != s->hl)));
2169 right_p = (last_glyph->right_box_line_p
2170 || (s->hl == DRAW_MOUSE_FACE
2171 && (s->next == NULL
2172 || s->next->hl != s->hl)));
2174 get_glyph_string_clip_rect (s, &clip_rect);
2176 if (s->face->box == FACE_SIMPLE_BOX)
2177 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2178 left_p, right_p, &clip_rect);
2179 else
2181 x_setup_relief_colors (s);
2182 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2183 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2188 /* Draw foreground of image glyph string S. */
2190 static void
2191 x_draw_image_foreground (s)
2192 struct glyph_string *s;
2194 int x = s->x;
2195 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2197 /* If first glyph of S has a left box line, start drawing it to the
2198 right of that line. */
2199 if (s->face->box != FACE_NO_BOX
2200 && s->first_glyph->left_box_line_p
2201 && s->slice.x == 0)
2202 x += eabs (s->face->box_line_width);
2204 /* If there is a margin around the image, adjust x- and y-position
2205 by that margin. */
2206 if (s->slice.x == 0)
2207 x += s->img->hmargin;
2208 if (s->slice.y == 0)
2209 y += s->img->vmargin;
2211 if (s->img->pixmap)
2213 if (s->img->mask)
2215 /* We can't set both a clip mask and use XSetClipRectangles
2216 because the latter also sets a clip mask. We also can't
2217 trust on the shape extension to be available
2218 (XShapeCombineRegion). So, compute the rectangle to draw
2219 manually. */
2220 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2221 | GCFunction);
2222 XGCValues xgcv;
2223 XRectangle clip_rect, image_rect, r;
2225 xgcv.clip_mask = s->img->mask;
2226 xgcv.clip_x_origin = x;
2227 xgcv.clip_y_origin = y;
2228 xgcv.function = GXcopy;
2229 XChangeGC (s->display, s->gc, mask, &xgcv);
2231 get_glyph_string_clip_rect (s, &clip_rect);
2232 image_rect.x = x;
2233 image_rect.y = y;
2234 image_rect.width = s->slice.width;
2235 image_rect.height = s->slice.height;
2236 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2237 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2238 s->slice.x + r.x - x, s->slice.y + r.y - y,
2239 r.width, r.height, r.x, r.y);
2241 else
2243 XRectangle clip_rect, image_rect, r;
2245 get_glyph_string_clip_rect (s, &clip_rect);
2246 image_rect.x = x;
2247 image_rect.y = y;
2248 image_rect.width = s->slice.width;
2249 image_rect.height = s->slice.height;
2250 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2251 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2252 s->slice.x + r.x - x, s->slice.y + r.y - y,
2253 r.width, r.height, r.x, r.y);
2255 /* When the image has a mask, we can expect that at
2256 least part of a mouse highlight or a block cursor will
2257 be visible. If the image doesn't have a mask, make
2258 a block cursor visible by drawing a rectangle around
2259 the image. I believe it's looking better if we do
2260 nothing here for mouse-face. */
2261 if (s->hl == DRAW_CURSOR)
2263 int r = s->img->relief;
2264 if (r < 0) r = -r;
2265 XDrawRectangle (s->display, s->window, s->gc,
2266 x - r, y - r,
2267 s->slice.width + r*2 - 1,
2268 s->slice.height + r*2 - 1);
2272 else
2273 /* Draw a rectangle if image could not be loaded. */
2274 XDrawRectangle (s->display, s->window, s->gc, x, y,
2275 s->slice.width - 1, s->slice.height - 1);
2279 /* Draw a relief around the image glyph string S. */
2281 static void
2282 x_draw_image_relief (s)
2283 struct glyph_string *s;
2285 int x0, y0, x1, y1, thick, raised_p;
2286 XRectangle r;
2287 int x = s->x;
2288 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2290 /* If first glyph of S has a left box line, start drawing it to the
2291 right of that line. */
2292 if (s->face->box != FACE_NO_BOX
2293 && s->first_glyph->left_box_line_p
2294 && s->slice.x == 0)
2295 x += eabs (s->face->box_line_width);
2297 /* If there is a margin around the image, adjust x- and y-position
2298 by that margin. */
2299 if (s->slice.x == 0)
2300 x += s->img->hmargin;
2301 if (s->slice.y == 0)
2302 y += s->img->vmargin;
2304 if (s->hl == DRAW_IMAGE_SUNKEN
2305 || s->hl == DRAW_IMAGE_RAISED)
2307 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2308 raised_p = s->hl == DRAW_IMAGE_RAISED;
2310 else
2312 thick = eabs (s->img->relief);
2313 raised_p = s->img->relief > 0;
2316 x0 = x - thick;
2317 y0 = y - thick;
2318 x1 = x + s->slice.width + thick - 1;
2319 y1 = y + s->slice.height + thick - 1;
2321 x_setup_relief_colors (s);
2322 get_glyph_string_clip_rect (s, &r);
2323 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2324 s->slice.y == 0,
2325 s->slice.y + s->slice.height == s->img->height,
2326 s->slice.x == 0,
2327 s->slice.x + s->slice.width == s->img->width,
2328 &r);
2332 /* Draw the foreground of image glyph string S to PIXMAP. */
2334 static void
2335 x_draw_image_foreground_1 (s, pixmap)
2336 struct glyph_string *s;
2337 Pixmap pixmap;
2339 int x = 0;
2340 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2342 /* If first glyph of S has a left box line, start drawing it to the
2343 right of that line. */
2344 if (s->face->box != FACE_NO_BOX
2345 && s->first_glyph->left_box_line_p
2346 && s->slice.x == 0)
2347 x += eabs (s->face->box_line_width);
2349 /* If there is a margin around the image, adjust x- and y-position
2350 by that margin. */
2351 if (s->slice.x == 0)
2352 x += s->img->hmargin;
2353 if (s->slice.y == 0)
2354 y += s->img->vmargin;
2356 if (s->img->pixmap)
2358 if (s->img->mask)
2360 /* We can't set both a clip mask and use XSetClipRectangles
2361 because the latter also sets a clip mask. We also can't
2362 trust on the shape extension to be available
2363 (XShapeCombineRegion). So, compute the rectangle to draw
2364 manually. */
2365 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2366 | GCFunction);
2367 XGCValues xgcv;
2369 xgcv.clip_mask = s->img->mask;
2370 xgcv.clip_x_origin = x - s->slice.x;
2371 xgcv.clip_y_origin = y - s->slice.y;
2372 xgcv.function = GXcopy;
2373 XChangeGC (s->display, s->gc, mask, &xgcv);
2375 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2376 s->slice.x, s->slice.y,
2377 s->slice.width, s->slice.height, x, y);
2378 XSetClipMask (s->display, s->gc, None);
2380 else
2382 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2383 s->slice.x, s->slice.y,
2384 s->slice.width, s->slice.height, x, y);
2386 /* When the image has a mask, we can expect that at
2387 least part of a mouse highlight or a block cursor will
2388 be visible. If the image doesn't have a mask, make
2389 a block cursor visible by drawing a rectangle around
2390 the image. I believe it's looking better if we do
2391 nothing here for mouse-face. */
2392 if (s->hl == DRAW_CURSOR)
2394 int r = s->img->relief;
2395 if (r < 0) r = -r;
2396 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2397 s->slice.width + r*2 - 1,
2398 s->slice.height + r*2 - 1);
2402 else
2403 /* Draw a rectangle if image could not be loaded. */
2404 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2405 s->slice.width - 1, s->slice.height - 1);
2409 /* Draw part of the background of glyph string S. X, Y, W, and H
2410 give the rectangle to draw. */
2412 static void
2413 x_draw_glyph_string_bg_rect (s, x, y, w, h)
2414 struct glyph_string *s;
2415 int x, y, w, h;
2417 if (s->stippled_p)
2419 /* Fill background with a stipple pattern. */
2420 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2421 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2422 XSetFillStyle (s->display, s->gc, FillSolid);
2424 else
2425 x_clear_glyph_string_rect (s, x, y, w, h);
2429 /* Draw image glyph string S.
2431 s->y
2432 s->x +-------------------------
2433 | s->face->box
2435 | +-------------------------
2436 | | s->img->margin
2438 | | +-------------------
2439 | | | the image
2443 static void
2444 x_draw_image_glyph_string (s)
2445 struct glyph_string *s;
2447 int box_line_hwidth = eabs (s->face->box_line_width);
2448 int box_line_vwidth = max (s->face->box_line_width, 0);
2449 int height;
2450 Pixmap pixmap = None;
2452 height = s->height;
2453 if (s->slice.y == 0)
2454 height -= box_line_vwidth;
2455 if (s->slice.y + s->slice.height >= s->img->height)
2456 height -= box_line_vwidth;
2458 /* Fill background with face under the image. Do it only if row is
2459 taller than image or if image has a clip mask to reduce
2460 flickering. */
2461 s->stippled_p = s->face->stipple != 0;
2462 if (height > s->slice.height
2463 || s->img->hmargin
2464 || s->img->vmargin
2465 || s->img->mask
2466 || s->img->pixmap == 0
2467 || s->width != s->background_width)
2469 if (s->img->mask)
2471 /* Create a pixmap as large as the glyph string. Fill it
2472 with the background color. Copy the image to it, using
2473 its mask. Copy the temporary pixmap to the display. */
2474 Screen *screen = FRAME_X_SCREEN (s->f);
2475 int depth = DefaultDepthOfScreen (screen);
2477 /* Create a pixmap as large as the glyph string. */
2478 pixmap = XCreatePixmap (s->display, s->window,
2479 s->background_width,
2480 s->height, depth);
2482 /* Don't clip in the following because we're working on the
2483 pixmap. */
2484 XSetClipMask (s->display, s->gc, None);
2486 /* Fill the pixmap with the background color/stipple. */
2487 if (s->stippled_p)
2489 /* Fill background with a stipple pattern. */
2490 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2491 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2492 XFillRectangle (s->display, pixmap, s->gc,
2493 0, 0, s->background_width, s->height);
2494 XSetFillStyle (s->display, s->gc, FillSolid);
2495 XSetTSOrigin (s->display, s->gc, 0, 0);
2497 else
2499 XGCValues xgcv;
2500 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2501 &xgcv);
2502 XSetForeground (s->display, s->gc, xgcv.background);
2503 XFillRectangle (s->display, pixmap, s->gc,
2504 0, 0, s->background_width, s->height);
2505 XSetForeground (s->display, s->gc, xgcv.foreground);
2508 else
2510 int x = s->x;
2511 int y = s->y;
2513 if (s->first_glyph->left_box_line_p
2514 && s->slice.x == 0)
2515 x += box_line_hwidth;
2517 if (s->slice.y == 0)
2518 y += box_line_vwidth;
2520 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2523 s->background_filled_p = 1;
2526 /* Draw the foreground. */
2527 if (pixmap != None)
2529 x_draw_image_foreground_1 (s, pixmap);
2530 x_set_glyph_string_clipping (s);
2531 XCopyArea (s->display, pixmap, s->window, s->gc,
2532 0, 0, s->background_width, s->height, s->x, s->y);
2533 XFreePixmap (s->display, pixmap);
2535 else
2536 x_draw_image_foreground (s);
2538 /* If we must draw a relief around the image, do it. */
2539 if (s->img->relief
2540 || s->hl == DRAW_IMAGE_RAISED
2541 || s->hl == DRAW_IMAGE_SUNKEN)
2542 x_draw_image_relief (s);
2546 /* Draw stretch glyph string S. */
2548 static void
2549 x_draw_stretch_glyph_string (s)
2550 struct glyph_string *s;
2552 xassert (s->first_glyph->type == STRETCH_GLYPH);
2554 if (s->hl == DRAW_CURSOR
2555 && !x_stretch_cursor_p)
2557 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2558 as wide as the stretch glyph. */
2559 int width, background_width = s->background_width;
2560 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2562 if (x < left_x)
2564 background_width -= left_x - x;
2565 x = left_x;
2567 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2569 /* Draw cursor. */
2570 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2572 /* Clear rest using the GC of the original non-cursor face. */
2573 if (width < background_width)
2575 int y = s->y;
2576 int w = background_width - width, h = s->height;
2577 XRectangle r;
2578 GC gc;
2580 x += width;
2581 if (s->row->mouse_face_p
2582 && cursor_in_mouse_face_p (s->w))
2584 x_set_mouse_face_gc (s);
2585 gc = s->gc;
2587 else
2588 gc = s->face->gc;
2590 get_glyph_string_clip_rect (s, &r);
2591 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2593 if (s->face->stipple)
2595 /* Fill background with a stipple pattern. */
2596 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2597 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2598 XSetFillStyle (s->display, gc, FillSolid);
2600 else
2602 XGCValues xgcv;
2603 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2604 XSetForeground (s->display, gc, xgcv.background);
2605 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2606 XSetForeground (s->display, gc, xgcv.foreground);
2610 else if (!s->background_filled_p)
2612 int background_width = s->background_width;
2613 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2615 /* Don't draw into left margin, fringe or scrollbar area
2616 except for header line and mode line. */
2617 if (x < left_x && !s->row->mode_line_p)
2619 background_width -= left_x - x;
2620 x = left_x;
2622 if (background_width > 0)
2623 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2626 s->background_filled_p = 1;
2630 /* Draw glyph string S. */
2632 static void
2633 x_draw_glyph_string (s)
2634 struct glyph_string *s;
2636 int relief_drawn_p = 0;
2638 /* If S draws into the background of its successors, draw the
2639 background of the successors first so that S can draw into it.
2640 This makes S->next use XDrawString instead of XDrawImageString. */
2641 if (s->next && s->right_overhang && !s->for_overlaps)
2643 int width;
2644 struct glyph_string *next;
2646 for (width = 0, next = s->next; next;
2647 width += next->width, next = next->next)
2648 if (next->first_glyph->type != IMAGE_GLYPH)
2650 x_set_glyph_string_gc (next);
2651 x_set_glyph_string_clipping (next);
2652 x_draw_glyph_string_background (next, 1);
2653 next->num_clips = 0;
2657 /* Set up S->gc, set clipping and draw S. */
2658 x_set_glyph_string_gc (s);
2660 /* Draw relief (if any) in advance for char/composition so that the
2661 glyph string can be drawn over it. */
2662 if (!s->for_overlaps
2663 && s->face->box != FACE_NO_BOX
2664 && (s->first_glyph->type == CHAR_GLYPH
2665 || s->first_glyph->type == COMPOSITE_GLYPH))
2668 x_set_glyph_string_clipping (s);
2669 x_draw_glyph_string_background (s, 1);
2670 x_draw_glyph_string_box (s);
2671 x_set_glyph_string_clipping (s);
2672 relief_drawn_p = 1;
2674 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2675 && !s->clip_tail
2676 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2677 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2678 /* We must clip just this glyph. left_overhang part has already
2679 drawn when s->prev was drawn, and right_overhang part will be
2680 drawn later when s->next is drawn. */
2681 x_set_glyph_string_clipping_exactly (s, s);
2682 else
2683 x_set_glyph_string_clipping (s);
2685 switch (s->first_glyph->type)
2687 case IMAGE_GLYPH:
2688 x_draw_image_glyph_string (s);
2689 break;
2691 case STRETCH_GLYPH:
2692 x_draw_stretch_glyph_string (s);
2693 break;
2695 case CHAR_GLYPH:
2696 if (s->for_overlaps)
2697 s->background_filled_p = 1;
2698 else
2699 x_draw_glyph_string_background (s, 0);
2700 x_draw_glyph_string_foreground (s);
2701 break;
2703 case COMPOSITE_GLYPH:
2704 if (s->for_overlaps || s->gidx > 0)
2705 s->background_filled_p = 1;
2706 else
2707 x_draw_glyph_string_background (s, 1);
2708 x_draw_composite_glyph_string_foreground (s);
2709 break;
2711 default:
2712 abort ();
2715 if (!s->for_overlaps)
2717 /* Draw underline. */
2718 if (s->face->underline_p)
2720 unsigned long thickness, position;
2721 int y;
2723 if (s->prev && s->prev->face->underline_p)
2725 /* We use the same underline style as the previous one. */
2726 thickness = s->prev->underline_thickness;
2727 position = s->prev->underline_position;
2729 else
2731 /* Get the underline thickness. Default is 1 pixel. */
2732 if (s->font && s->font->underline_thickness > 0)
2733 thickness = s->font->underline_thickness;
2734 else
2735 thickness = 1;
2736 if (x_underline_at_descent_line)
2737 position = (s->height - thickness) - (s->ybase - s->y);
2738 else
2740 /* Get the underline position. This is the recommended
2741 vertical offset in pixels from the baseline to the top of
2742 the underline. This is a signed value according to the
2743 specs, and its default is
2745 ROUND ((maximum descent) / 2), with
2746 ROUND(x) = floor (x + 0.5) */
2748 if (x_use_underline_position_properties
2749 && s->font && s->font->underline_position >= 0)
2750 position = s->font->underline_position;
2751 else if (s->font)
2752 position = (s->font->descent + 1) / 2;
2754 position = max (position, underline_minimum_offset);
2756 /* Check the sanity of thickness and position. We should
2757 avoid drawing underline out of the current line area. */
2758 if (s->y + s->height <= s->ybase + position)
2759 position = (s->height - 1) - (s->ybase - s->y);
2760 if (s->y + s->height < s->ybase + position + thickness)
2761 thickness = (s->y + s->height) - (s->ybase + position);
2762 s->underline_thickness = thickness;
2763 s->underline_position = position;
2764 y = s->ybase + position;
2765 if (s->face->underline_defaulted_p)
2766 XFillRectangle (s->display, s->window, s->gc,
2767 s->x, y, s->background_width, thickness);
2768 else
2770 XGCValues xgcv;
2771 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2772 XSetForeground (s->display, s->gc, s->face->underline_color);
2773 XFillRectangle (s->display, s->window, s->gc,
2774 s->x, y, s->background_width, thickness);
2775 XSetForeground (s->display, s->gc, xgcv.foreground);
2779 /* Draw overline. */
2780 if (s->face->overline_p)
2782 unsigned long dy = 0, h = 1;
2784 if (s->face->overline_color_defaulted_p)
2785 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2786 s->background_width, h);
2787 else
2789 XGCValues xgcv;
2790 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2791 XSetForeground (s->display, s->gc, s->face->overline_color);
2792 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2793 s->background_width, h);
2794 XSetForeground (s->display, s->gc, xgcv.foreground);
2798 /* Draw strike-through. */
2799 if (s->face->strike_through_p)
2801 unsigned long h = 1;
2802 unsigned long dy = (s->height - h) / 2;
2804 if (s->face->strike_through_color_defaulted_p)
2805 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2806 s->width, h);
2807 else
2809 XGCValues xgcv;
2810 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2811 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2812 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2813 s->width, h);
2814 XSetForeground (s->display, s->gc, xgcv.foreground);
2818 /* Draw relief if not yet drawn. */
2819 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2820 x_draw_glyph_string_box (s);
2822 if (s->prev)
2824 struct glyph_string *prev;
2826 for (prev = s->prev; prev; prev = prev->prev)
2827 if (prev->hl != s->hl
2828 && prev->x + prev->width + prev->right_overhang > s->x)
2830 /* As prev was drawn while clipped to its own area, we
2831 must draw the right_overhang part using s->hl now. */
2832 enum draw_glyphs_face save = prev->hl;
2834 prev->hl = s->hl;
2835 x_set_glyph_string_gc (prev);
2836 x_set_glyph_string_clipping_exactly (s, prev);
2837 if (prev->first_glyph->type == CHAR_GLYPH)
2838 x_draw_glyph_string_foreground (prev);
2839 else
2840 x_draw_composite_glyph_string_foreground (prev);
2841 XSetClipMask (prev->display, prev->gc, None);
2842 prev->hl = save;
2843 prev->num_clips = 0;
2847 if (s->next)
2849 struct glyph_string *next;
2851 for (next = s->next; next; next = next->next)
2852 if (next->hl != s->hl
2853 && next->x - next->left_overhang < s->x + s->width)
2855 /* As next will be drawn while clipped to its own area,
2856 we must draw the left_overhang part using s->hl now. */
2857 enum draw_glyphs_face save = next->hl;
2859 next->hl = s->hl;
2860 x_set_glyph_string_gc (next);
2861 x_set_glyph_string_clipping_exactly (s, next);
2862 if (next->first_glyph->type == CHAR_GLYPH)
2863 x_draw_glyph_string_foreground (next);
2864 else
2865 x_draw_composite_glyph_string_foreground (next);
2866 XSetClipMask (next->display, next->gc, None);
2867 next->hl = save;
2868 next->num_clips = 0;
2873 /* Reset clipping. */
2874 XSetClipMask (s->display, s->gc, None);
2875 s->num_clips = 0;
2878 /* Shift display to make room for inserted glyphs. */
2880 void
2881 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2882 struct frame *f;
2883 int x, y, width, height, shift_by;
2885 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2886 f->output_data.x->normal_gc,
2887 x, y, width, height,
2888 x + shift_by, y);
2891 /* Delete N glyphs at the nominal cursor position. Not implemented
2892 for X frames. */
2894 static void
2895 x_delete_glyphs (f, n)
2896 struct frame *f;
2897 register int n;
2899 abort ();
2903 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2904 If they are <= 0, this is probably an error. */
2906 void
2907 x_clear_area (dpy, window, x, y, width, height, exposures)
2908 Display *dpy;
2909 Window window;
2910 int x, y;
2911 int width, height;
2912 int exposures;
2914 xassert (width > 0 && height > 0);
2915 XClearArea (dpy, window, x, y, width, height, exposures);
2919 /* Clear an entire frame. */
2921 static void
2922 x_clear_frame (struct frame *f)
2924 /* Clearing the frame will erase any cursor, so mark them all as no
2925 longer visible. */
2926 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2927 output_cursor.hpos = output_cursor.vpos = 0;
2928 output_cursor.x = -1;
2930 /* We don't set the output cursor here because there will always
2931 follow an explicit cursor_to. */
2932 BLOCK_INPUT;
2933 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2935 /* We have to clear the scroll bars, too. If we have changed
2936 colors or something like that, then they should be notified. */
2937 x_scroll_bar_clear (f);
2939 XFlush (FRAME_X_DISPLAY (f));
2941 UNBLOCK_INPUT;
2946 /* Invert the middle quarter of the frame for .15 sec. */
2948 /* We use the select system call to do the waiting, so we have to make
2949 sure it's available. If it isn't, we just won't do visual bells. */
2951 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2954 /* Subtract the `struct timeval' values X and Y, storing the result in
2955 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2957 static int
2958 timeval_subtract (result, x, y)
2959 struct timeval *result, x, y;
2961 /* Perform the carry for the later subtraction by updating y. This
2962 is safer because on some systems the tv_sec member is unsigned. */
2963 if (x.tv_usec < y.tv_usec)
2965 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2966 y.tv_usec -= 1000000 * nsec;
2967 y.tv_sec += nsec;
2970 if (x.tv_usec - y.tv_usec > 1000000)
2972 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2973 y.tv_usec += 1000000 * nsec;
2974 y.tv_sec -= nsec;
2977 /* Compute the time remaining to wait. tv_usec is certainly
2978 positive. */
2979 result->tv_sec = x.tv_sec - y.tv_sec;
2980 result->tv_usec = x.tv_usec - y.tv_usec;
2982 /* Return indication of whether the result should be considered
2983 negative. */
2984 return x.tv_sec < y.tv_sec;
2987 void
2988 XTflash (f)
2989 struct frame *f;
2991 BLOCK_INPUT;
2994 GC gc;
2996 /* Create a GC that will use the GXxor function to flip foreground
2997 pixels into background pixels. */
2999 XGCValues values;
3001 values.function = GXxor;
3002 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3003 ^ FRAME_BACKGROUND_PIXEL (f));
3005 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3006 GCFunction | GCForeground, &values);
3010 /* Get the height not including a menu bar widget. */
3011 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3012 /* Height of each line to flash. */
3013 int flash_height = FRAME_LINE_HEIGHT (f);
3014 /* These will be the left and right margins of the rectangles. */
3015 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3016 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3018 int width;
3020 /* Don't flash the area between a scroll bar and the frame
3021 edge it is next to. */
3022 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3024 case vertical_scroll_bar_left:
3025 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3026 break;
3028 case vertical_scroll_bar_right:
3029 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3030 break;
3032 default:
3033 break;
3036 width = flash_right - flash_left;
3038 /* If window is tall, flash top and bottom line. */
3039 if (height > 3 * FRAME_LINE_HEIGHT (f))
3041 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3042 flash_left,
3043 (FRAME_INTERNAL_BORDER_WIDTH (f)
3044 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3045 width, flash_height);
3046 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3047 flash_left,
3048 (height - flash_height
3049 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3050 width, flash_height);
3052 else
3053 /* If it is short, flash it all. */
3054 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3055 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3056 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3058 x_flush (f);
3061 struct timeval wakeup;
3063 EMACS_GET_TIME (wakeup);
3065 /* Compute time to wait until, propagating carry from usecs. */
3066 wakeup.tv_usec += 150000;
3067 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3068 wakeup.tv_usec %= 1000000;
3070 /* Keep waiting until past the time wakeup or any input gets
3071 available. */
3072 while (! detect_input_pending ())
3074 struct timeval current;
3075 struct timeval timeout;
3077 EMACS_GET_TIME (current);
3079 /* Break if result would be negative. */
3080 if (timeval_subtract (&current, wakeup, current))
3081 break;
3083 /* How long `select' should wait. */
3084 timeout.tv_sec = 0;
3085 timeout.tv_usec = 10000;
3087 /* Try to wait that long--but we might wake up sooner. */
3088 select (0, NULL, NULL, NULL, &timeout);
3092 /* If window is tall, flash top and bottom line. */
3093 if (height > 3 * FRAME_LINE_HEIGHT (f))
3095 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3096 flash_left,
3097 (FRAME_INTERNAL_BORDER_WIDTH (f)
3098 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3099 width, flash_height);
3100 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3101 flash_left,
3102 (height - flash_height
3103 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3104 width, flash_height);
3106 else
3107 /* If it is short, flash it all. */
3108 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3109 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3110 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3112 XFreeGC (FRAME_X_DISPLAY (f), gc);
3113 x_flush (f);
3117 UNBLOCK_INPUT;
3120 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3123 /* Make audible bell. */
3125 void
3126 XTring_bell ()
3128 struct frame *f = SELECTED_FRAME ();
3130 if (FRAME_X_DISPLAY (f))
3132 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3133 if (visible_bell)
3134 XTflash (f);
3135 else
3136 #endif
3138 BLOCK_INPUT;
3139 XBell (FRAME_X_DISPLAY (f), 0);
3140 XFlush (FRAME_X_DISPLAY (f));
3141 UNBLOCK_INPUT;
3147 /* Specify how many text lines, from the top of the window,
3148 should be affected by insert-lines and delete-lines operations.
3149 This, and those operations, are used only within an update
3150 that is bounded by calls to x_update_begin and x_update_end. */
3152 static void
3153 XTset_terminal_window (n)
3154 register int n;
3156 /* This function intentionally left blank. */
3161 /***********************************************************************
3162 Line Dance
3163 ***********************************************************************/
3165 /* Perform an insert-lines or delete-lines operation, inserting N
3166 lines or deleting -N lines at vertical position VPOS. */
3168 static void
3169 x_ins_del_lines (f, vpos, n)
3170 struct frame *f;
3171 int vpos, n;
3173 abort ();
3177 /* Scroll part of the display as described by RUN. */
3179 static void
3180 x_scroll_run (w, run)
3181 struct window *w;
3182 struct run *run;
3184 struct frame *f = XFRAME (w->frame);
3185 int x, y, width, height, from_y, to_y, bottom_y;
3187 /* Get frame-relative bounding box of the text display area of W,
3188 without mode lines. Include in this box the left and right
3189 fringe of W. */
3190 window_box (w, -1, &x, &y, &width, &height);
3192 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3193 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3194 bottom_y = y + height;
3196 if (to_y < from_y)
3198 /* Scrolling up. Make sure we don't copy part of the mode
3199 line at the bottom. */
3200 if (from_y + run->height > bottom_y)
3201 height = bottom_y - from_y;
3202 else
3203 height = run->height;
3205 else
3207 /* Scolling down. Make sure we don't copy over the mode line.
3208 at the bottom. */
3209 if (to_y + run->height > bottom_y)
3210 height = bottom_y - to_y;
3211 else
3212 height = run->height;
3215 BLOCK_INPUT;
3217 /* Cursor off. Will be switched on again in x_update_window_end. */
3218 updated_window = w;
3219 x_clear_cursor (w);
3221 XCopyArea (FRAME_X_DISPLAY (f),
3222 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3223 f->output_data.x->normal_gc,
3224 x, from_y,
3225 width, height,
3226 x, to_y);
3228 UNBLOCK_INPUT;
3233 /***********************************************************************
3234 Exposure Events
3235 ***********************************************************************/
3238 static void
3239 frame_highlight (f)
3240 struct frame *f;
3242 /* We used to only do this if Vx_no_window_manager was non-nil, but
3243 the ICCCM (section 4.1.6) says that the window's border pixmap
3244 and border pixel are window attributes which are "private to the
3245 client", so we can always change it to whatever we want. */
3246 BLOCK_INPUT;
3247 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3248 f->output_data.x->border_pixel);
3249 UNBLOCK_INPUT;
3250 x_update_cursor (f, 1);
3251 x_set_frame_alpha (f);
3254 static void
3255 frame_unhighlight (f)
3256 struct frame *f;
3258 /* We used to only do this if Vx_no_window_manager was non-nil, but
3259 the ICCCM (section 4.1.6) says that the window's border pixmap
3260 and border pixel are window attributes which are "private to the
3261 client", so we can always change it to whatever we want. */
3262 BLOCK_INPUT;
3263 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3264 f->output_data.x->border_tile);
3265 UNBLOCK_INPUT;
3266 x_update_cursor (f, 1);
3267 x_set_frame_alpha (f);
3270 /* The focus has changed. Update the frames as necessary to reflect
3271 the new situation. Note that we can't change the selected frame
3272 here, because the Lisp code we are interrupting might become confused.
3273 Each event gets marked with the frame in which it occurred, so the
3274 Lisp code can tell when the switch took place by examining the events. */
3276 static void
3277 x_new_focus_frame (dpyinfo, frame)
3278 struct x_display_info *dpyinfo;
3279 struct frame *frame;
3281 struct frame *old_focus = dpyinfo->x_focus_frame;
3283 if (frame != dpyinfo->x_focus_frame)
3285 /* Set this before calling other routines, so that they see
3286 the correct value of x_focus_frame. */
3287 dpyinfo->x_focus_frame = frame;
3289 if (old_focus && old_focus->auto_lower)
3290 x_lower_frame (old_focus);
3292 #if 0
3293 selected_frame = frame;
3294 XSETFRAME (XWINDOW (selected_frame->selected_window)->frame,
3295 selected_frame);
3296 Fselect_window (selected_frame->selected_window, Qnil);
3297 choose_minibuf_frame ();
3298 #endif /* ! 0 */
3300 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3301 pending_autoraise_frame = dpyinfo->x_focus_frame;
3302 else
3303 pending_autoraise_frame = 0;
3306 x_frame_rehighlight (dpyinfo);
3309 /* Handle FocusIn and FocusOut state changes for FRAME.
3310 If FRAME has focus and there exists more than one frame, puts
3311 a FOCUS_IN_EVENT into *BUFP. */
3313 static void
3314 x_focus_changed (type, state, dpyinfo, frame, bufp)
3315 int type;
3316 int state;
3317 struct x_display_info *dpyinfo;
3318 struct frame *frame;
3319 struct input_event *bufp;
3321 if (type == FocusIn)
3323 if (dpyinfo->x_focus_event_frame != frame)
3325 x_new_focus_frame (dpyinfo, frame);
3326 dpyinfo->x_focus_event_frame = frame;
3328 /* Don't stop displaying the initial startup message
3329 for a switch-frame event we don't need. */
3330 if (NILP (Vterminal_frame)
3331 && CONSP (Vframe_list)
3332 && !NILP (XCDR (Vframe_list)))
3334 bufp->kind = FOCUS_IN_EVENT;
3335 XSETFRAME (bufp->frame_or_window, frame);
3339 frame->output_data.x->focus_state |= state;
3341 #ifdef HAVE_X_I18N
3342 if (FRAME_XIC (frame))
3343 XSetICFocus (FRAME_XIC (frame));
3344 #endif
3346 else if (type == FocusOut)
3348 frame->output_data.x->focus_state &= ~state;
3350 if (dpyinfo->x_focus_event_frame == frame)
3352 dpyinfo->x_focus_event_frame = 0;
3353 x_new_focus_frame (dpyinfo, 0);
3356 #ifdef HAVE_X_I18N
3357 if (FRAME_XIC (frame))
3358 XUnsetICFocus (FRAME_XIC (frame));
3359 #endif
3363 /* The focus may have changed. Figure out if it is a real focus change,
3364 by checking both FocusIn/Out and Enter/LeaveNotify events.
3366 Returns FOCUS_IN_EVENT event in *BUFP. */
3368 static void
3369 x_detect_focus_change (dpyinfo, event, bufp)
3370 struct x_display_info *dpyinfo;
3371 XEvent *event;
3372 struct input_event *bufp;
3374 struct frame *frame;
3376 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3377 if (! frame)
3378 return;
3380 switch (event->type)
3382 case EnterNotify:
3383 case LeaveNotify:
3385 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3386 int focus_state
3387 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3389 if (event->xcrossing.detail != NotifyInferior
3390 && event->xcrossing.focus
3391 && ! (focus_state & FOCUS_EXPLICIT))
3392 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3393 FOCUS_IMPLICIT,
3394 dpyinfo, frame, bufp);
3396 break;
3398 case FocusIn:
3399 case FocusOut:
3400 x_focus_changed (event->type,
3401 (event->xfocus.detail == NotifyPointer ?
3402 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3403 dpyinfo, frame, bufp);
3404 break;
3406 case ClientMessage:
3407 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3409 enum xembed_message msg = event->xclient.data.l[1];
3410 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3411 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3413 break;
3418 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3420 void
3421 x_mouse_leave (dpyinfo)
3422 struct x_display_info *dpyinfo;
3424 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3427 /* The focus has changed, or we have redirected a frame's focus to
3428 another frame (this happens when a frame uses a surrogate
3429 mini-buffer frame). Shift the highlight as appropriate.
3431 The FRAME argument doesn't necessarily have anything to do with which
3432 frame is being highlighted or un-highlighted; we only use it to find
3433 the appropriate X display info. */
3435 static void
3436 XTframe_rehighlight (frame)
3437 struct frame *frame;
3439 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3442 static void
3443 x_frame_rehighlight (dpyinfo)
3444 struct x_display_info *dpyinfo;
3446 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3448 if (dpyinfo->x_focus_frame)
3450 dpyinfo->x_highlight_frame
3451 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3452 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3453 : dpyinfo->x_focus_frame);
3454 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3456 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3457 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3460 else
3461 dpyinfo->x_highlight_frame = 0;
3463 if (dpyinfo->x_highlight_frame != old_highlight)
3465 if (old_highlight)
3466 frame_unhighlight (old_highlight);
3467 if (dpyinfo->x_highlight_frame)
3468 frame_highlight (dpyinfo->x_highlight_frame);
3474 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3476 /* Initialize mode_switch_bit and modifier_meaning. */
3477 static void
3478 x_find_modifier_meanings (dpyinfo)
3479 struct x_display_info *dpyinfo;
3481 int min_code, max_code;
3482 KeySym *syms;
3483 int syms_per_code;
3484 XModifierKeymap *mods;
3486 dpyinfo->meta_mod_mask = 0;
3487 dpyinfo->shift_lock_mask = 0;
3488 dpyinfo->alt_mod_mask = 0;
3489 dpyinfo->super_mod_mask = 0;
3490 dpyinfo->hyper_mod_mask = 0;
3492 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3494 syms = XGetKeyboardMapping (dpyinfo->display,
3495 min_code, max_code - min_code + 1,
3496 &syms_per_code);
3497 mods = XGetModifierMapping (dpyinfo->display);
3499 /* Scan the modifier table to see which modifier bits the Meta and
3500 Alt keysyms are on. */
3502 int row, col; /* The row and column in the modifier table. */
3503 int found_alt_or_meta;
3505 for (row = 3; row < 8; row++)
3507 found_alt_or_meta = 0;
3508 for (col = 0; col < mods->max_keypermod; col++)
3510 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3512 /* Zeroes are used for filler. Skip them. */
3513 if (code == 0)
3514 continue;
3516 /* Are any of this keycode's keysyms a meta key? */
3518 int code_col;
3520 for (code_col = 0; code_col < syms_per_code; code_col++)
3522 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3524 switch (sym)
3526 case XK_Meta_L:
3527 case XK_Meta_R:
3528 found_alt_or_meta = 1;
3529 dpyinfo->meta_mod_mask |= (1 << row);
3530 break;
3532 case XK_Alt_L:
3533 case XK_Alt_R:
3534 found_alt_or_meta = 1;
3535 dpyinfo->alt_mod_mask |= (1 << row);
3536 break;
3538 case XK_Hyper_L:
3539 case XK_Hyper_R:
3540 if (!found_alt_or_meta)
3541 dpyinfo->hyper_mod_mask |= (1 << row);
3542 code_col = syms_per_code;
3543 col = mods->max_keypermod;
3544 break;
3546 case XK_Super_L:
3547 case XK_Super_R:
3548 if (!found_alt_or_meta)
3549 dpyinfo->super_mod_mask |= (1 << row);
3550 code_col = syms_per_code;
3551 col = mods->max_keypermod;
3552 break;
3554 case XK_Shift_Lock:
3555 /* Ignore this if it's not on the lock modifier. */
3556 if (!found_alt_or_meta && ((1 << row) == LockMask))
3557 dpyinfo->shift_lock_mask = LockMask;
3558 code_col = syms_per_code;
3559 col = mods->max_keypermod;
3560 break;
3568 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3569 if (! dpyinfo->meta_mod_mask)
3571 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3572 dpyinfo->alt_mod_mask = 0;
3575 /* If some keys are both alt and meta,
3576 make them just meta, not alt. */
3577 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3579 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3582 XFree ((char *) syms);
3583 XFreeModifiermap (mods);
3586 /* Convert between the modifier bits X uses and the modifier bits
3587 Emacs uses. */
3589 unsigned int
3590 x_x_to_emacs_modifiers (dpyinfo, state)
3591 struct x_display_info *dpyinfo;
3592 unsigned int state;
3594 EMACS_UINT mod_meta = meta_modifier;
3595 EMACS_UINT mod_alt = alt_modifier;
3596 EMACS_UINT mod_hyper = hyper_modifier;
3597 EMACS_UINT mod_super = super_modifier;
3598 Lisp_Object tem;
3600 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3601 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3602 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3603 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3604 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3605 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3606 tem = Fget (Vx_super_keysym, Qmodifier_value);
3607 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3610 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3611 | ((state & ControlMask) ? ctrl_modifier : 0)
3612 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3613 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3614 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3615 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3618 static unsigned int
3619 x_emacs_to_x_modifiers (dpyinfo, state)
3620 struct x_display_info *dpyinfo;
3621 unsigned int state;
3623 EMACS_UINT mod_meta = meta_modifier;
3624 EMACS_UINT mod_alt = alt_modifier;
3625 EMACS_UINT mod_hyper = hyper_modifier;
3626 EMACS_UINT mod_super = super_modifier;
3628 Lisp_Object tem;
3630 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3631 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3632 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3633 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3634 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3635 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3636 tem = Fget (Vx_super_keysym, Qmodifier_value);
3637 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3640 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3641 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3642 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3643 | ((state & shift_modifier) ? ShiftMask : 0)
3644 | ((state & ctrl_modifier) ? ControlMask : 0)
3645 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3648 /* Convert a keysym to its name. */
3650 char *
3651 x_get_keysym_name (keysym)
3652 KeySym keysym;
3654 char *value;
3656 BLOCK_INPUT;
3657 value = XKeysymToString (keysym);
3658 UNBLOCK_INPUT;
3660 return value;
3665 /* Mouse clicks and mouse movement. Rah. */
3667 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3669 If the event is a button press, then note that we have grabbed
3670 the mouse. */
3672 static Lisp_Object
3673 construct_mouse_click (result, event, f)
3674 struct input_event *result;
3675 XButtonEvent *event;
3676 struct frame *f;
3678 /* Make the event type NO_EVENT; we'll change that when we decide
3679 otherwise. */
3680 result->kind = MOUSE_CLICK_EVENT;
3681 result->code = event->button - Button1;
3682 result->timestamp = event->time;
3683 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3684 event->state)
3685 | (event->type == ButtonRelease
3686 ? up_modifier
3687 : down_modifier));
3689 XSETINT (result->x, event->x);
3690 XSETINT (result->y, event->y);
3691 XSETFRAME (result->frame_or_window, f);
3692 result->arg = Qnil;
3693 return Qnil;
3697 /* Function to report a mouse movement to the mainstream Emacs code.
3698 The input handler calls this.
3700 We have received a mouse movement event, which is given in *event.
3701 If the mouse is over a different glyph than it was last time, tell
3702 the mainstream emacs code by setting mouse_moved. If not, ask for
3703 another motion event, so we can check again the next time it moves. */
3705 static XMotionEvent last_mouse_motion_event;
3706 static Lisp_Object last_mouse_motion_frame;
3708 static int
3709 note_mouse_movement (frame, event)
3710 FRAME_PTR frame;
3711 XMotionEvent *event;
3713 last_mouse_movement_time = event->time;
3714 last_mouse_motion_event = *event;
3715 XSETFRAME (last_mouse_motion_frame, frame);
3717 if (!FRAME_X_OUTPUT (frame))
3718 return 0;
3720 if (event->window != FRAME_X_WINDOW (frame))
3722 frame->mouse_moved = 1;
3723 last_mouse_scroll_bar = Qnil;
3724 note_mouse_highlight (frame, -1, -1);
3725 last_mouse_glyph_frame = 0;
3726 return 1;
3730 /* Has the mouse moved off the glyph it was on at the last sighting? */
3731 if (frame != last_mouse_glyph_frame
3732 || event->x < last_mouse_glyph.x
3733 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3734 || event->y < last_mouse_glyph.y
3735 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3737 frame->mouse_moved = 1;
3738 last_mouse_scroll_bar = Qnil;
3739 note_mouse_highlight (frame, event->x, event->y);
3740 /* Remember which glyph we're now on. */
3741 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3742 last_mouse_glyph_frame = frame;
3743 return 1;
3746 return 0;
3750 /************************************************************************
3751 Mouse Face
3752 ************************************************************************/
3754 static void
3755 redo_mouse_highlight ()
3757 if (!NILP (last_mouse_motion_frame)
3758 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3759 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3760 last_mouse_motion_event.x,
3761 last_mouse_motion_event.y);
3766 /* Return the current position of the mouse.
3767 *FP should be a frame which indicates which display to ask about.
3769 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3770 and *PART to the frame, window, and scroll bar part that the mouse
3771 is over. Set *X and *Y to the portion and whole of the mouse's
3772 position on the scroll bar.
3774 If the mouse movement started elsewhere, set *FP to the frame the
3775 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3776 the mouse is over.
3778 Set *TIME to the server time-stamp for the time at which the mouse
3779 was at this position.
3781 Don't store anything if we don't have a valid set of values to report.
3783 This clears the mouse_moved flag, so we can wait for the next mouse
3784 movement. */
3786 static void
3787 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3788 FRAME_PTR *fp;
3789 int insist;
3790 Lisp_Object *bar_window;
3791 enum scroll_bar_part *part;
3792 Lisp_Object *x, *y;
3793 unsigned long *time;
3795 FRAME_PTR f1;
3797 BLOCK_INPUT;
3799 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3800 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3801 else
3803 Window root;
3804 int root_x, root_y;
3806 Window dummy_window;
3807 int dummy;
3809 Lisp_Object frame, tail;
3811 /* Clear the mouse-moved flag for every frame on this display. */
3812 FOR_EACH_FRAME (tail, frame)
3813 if (FRAME_X_P (XFRAME (frame))
3814 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3815 XFRAME (frame)->mouse_moved = 0;
3817 last_mouse_scroll_bar = Qnil;
3819 /* Figure out which root window we're on. */
3820 XQueryPointer (FRAME_X_DISPLAY (*fp),
3821 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3823 /* The root window which contains the pointer. */
3824 &root,
3826 /* Trash which we can't trust if the pointer is on
3827 a different screen. */
3828 &dummy_window,
3830 /* The position on that root window. */
3831 &root_x, &root_y,
3833 /* More trash we can't trust. */
3834 &dummy, &dummy,
3836 /* Modifier keys and pointer buttons, about which
3837 we don't care. */
3838 (unsigned int *) &dummy);
3840 /* Now we have a position on the root; find the innermost window
3841 containing the pointer. */
3843 Window win, child;
3844 int win_x, win_y;
3845 int parent_x = 0, parent_y = 0;
3847 win = root;
3849 /* XTranslateCoordinates can get errors if the window
3850 structure is changing at the same time this function
3851 is running. So at least we must not crash from them. */
3853 x_catch_errors (FRAME_X_DISPLAY (*fp));
3855 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3856 && FRAME_LIVE_P (last_mouse_frame))
3858 /* If mouse was grabbed on a frame, give coords for that frame
3859 even if the mouse is now outside it. */
3860 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3862 /* From-window, to-window. */
3863 root, FRAME_X_WINDOW (last_mouse_frame),
3865 /* From-position, to-position. */
3866 root_x, root_y, &win_x, &win_y,
3868 /* Child of win. */
3869 &child);
3870 f1 = last_mouse_frame;
3872 else
3874 while (1)
3876 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3878 /* From-window, to-window. */
3879 root, win,
3881 /* From-position, to-position. */
3882 root_x, root_y, &win_x, &win_y,
3884 /* Child of win. */
3885 &child);
3887 if (child == None || child == win)
3888 break;
3890 win = child;
3891 parent_x = win_x;
3892 parent_y = win_y;
3895 /* Now we know that:
3896 win is the innermost window containing the pointer
3897 (XTC says it has no child containing the pointer),
3898 win_x and win_y are the pointer's position in it
3899 (XTC did this the last time through), and
3900 parent_x and parent_y are the pointer's position in win's parent.
3901 (They are what win_x and win_y were when win was child.
3902 If win is the root window, it has no parent, and
3903 parent_{x,y} are invalid, but that's okay, because we'll
3904 never use them in that case.) */
3906 /* Is win one of our frames? */
3907 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3909 #ifdef USE_X_TOOLKIT
3910 /* If we end up with the menu bar window, say it's not
3911 on the frame. */
3912 if (f1 != NULL
3913 && f1->output_data.x->menubar_widget
3914 && win == XtWindow (f1->output_data.x->menubar_widget))
3915 f1 = NULL;
3916 #endif /* USE_X_TOOLKIT */
3919 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3920 f1 = 0;
3922 x_uncatch_errors ();
3924 /* If not, is it one of our scroll bars? */
3925 if (! f1)
3927 struct scroll_bar *bar;
3929 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3931 if (bar)
3933 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3934 win_x = parent_x;
3935 win_y = parent_y;
3939 if (f1 == 0 && insist > 0)
3940 f1 = SELECTED_FRAME ();
3942 if (f1)
3944 /* Ok, we found a frame. Store all the values.
3945 last_mouse_glyph is a rectangle used to reduce the
3946 generation of mouse events. To not miss any motion
3947 events, we must divide the frame into rectangles of the
3948 size of the smallest character that could be displayed
3949 on it, i.e. into the same rectangles that matrices on
3950 the frame are divided into. */
3952 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3953 last_mouse_glyph_frame = f1;
3955 *bar_window = Qnil;
3956 *part = 0;
3957 *fp = f1;
3958 XSETINT (*x, win_x);
3959 XSETINT (*y, win_y);
3960 *time = last_mouse_movement_time;
3965 UNBLOCK_INPUT;
3970 /***********************************************************************
3971 Scroll bars
3972 ***********************************************************************/
3974 /* Scroll bar support. */
3976 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
3977 manages it.
3978 This can be called in GC, so we have to make sure to strip off mark
3979 bits. */
3981 static struct scroll_bar *
3982 x_window_to_scroll_bar (display, window_id)
3983 Display *display;
3984 Window window_id;
3986 Lisp_Object tail;
3988 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3989 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
3990 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
3992 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
3994 Lisp_Object frame, bar, condemned;
3996 frame = XCAR (tail);
3997 /* All elements of Vframe_list should be frames. */
3998 if (! FRAMEP (frame))
3999 abort ();
4001 if (! FRAME_X_P (XFRAME (frame)))
4002 continue;
4004 /* Scan this frame's scroll bar list for a scroll bar with the
4005 right window ID. */
4006 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4007 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4008 /* This trick allows us to search both the ordinary and
4009 condemned scroll bar lists with one loop. */
4010 ! NILP (bar) || (bar = condemned,
4011 condemned = Qnil,
4012 ! NILP (bar));
4013 bar = XSCROLL_BAR (bar)->next)
4014 if (XSCROLL_BAR (bar)->x_window == window_id &&
4015 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4016 return XSCROLL_BAR (bar);
4019 return 0;
4023 #if defined USE_LUCID
4025 /* Return the Lucid menu bar WINDOW is part of. Return null
4026 if WINDOW is not part of a menu bar. */
4028 static Widget
4029 x_window_to_menu_bar (window)
4030 Window window;
4032 Lisp_Object tail;
4034 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4036 if (FRAME_X_P (XFRAME (XCAR (tail))))
4038 Lisp_Object frame = XCAR (tail);
4039 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4041 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4042 return menu_bar;
4046 return NULL;
4049 #endif /* USE_LUCID */
4052 /************************************************************************
4053 Toolkit scroll bars
4054 ************************************************************************/
4056 #ifdef USE_TOOLKIT_SCROLL_BARS
4058 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
4059 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
4060 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
4061 struct scroll_bar *));
4062 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
4063 int, int, int));
4066 /* Lisp window being scrolled. Set when starting to interact with
4067 a toolkit scroll bar, reset to nil when ending the interaction. */
4069 static Lisp_Object window_being_scrolled;
4071 /* Last scroll bar part sent in xm_scroll_callback. */
4073 static int last_scroll_bar_part;
4075 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4076 that movements of 1/20 of the screen size are mapped to up/down. */
4078 #ifndef USE_GTK
4079 /* Id of action hook installed for scroll bars. */
4081 static XtActionHookId action_hook_id;
4083 static Boolean xaw3d_arrow_scroll;
4085 /* Whether the drag scrolling maintains the mouse at the top of the
4086 thumb. If not, resizing the thumb needs to be done more carefully
4087 to avoid jerkyness. */
4089 static Boolean xaw3d_pick_top;
4091 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4092 bars are used.. The hook is responsible for detecting when
4093 the user ends an interaction with the scroll bar, and generates
4094 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4096 static void
4097 xt_action_hook (widget, client_data, action_name, event, params,
4098 num_params)
4099 Widget widget;
4100 XtPointer client_data;
4101 String action_name;
4102 XEvent *event;
4103 String *params;
4104 Cardinal *num_params;
4106 int scroll_bar_p;
4107 char *end_action;
4109 #ifdef USE_MOTIF
4110 scroll_bar_p = XmIsScrollBar (widget);
4111 end_action = "Release";
4112 #else /* !USE_MOTIF i.e. use Xaw */
4113 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4114 end_action = "EndScroll";
4115 #endif /* USE_MOTIF */
4117 if (scroll_bar_p
4118 && strcmp (action_name, end_action) == 0
4119 && WINDOWP (window_being_scrolled))
4121 struct window *w;
4123 x_send_scroll_bar_event (window_being_scrolled,
4124 scroll_bar_end_scroll, 0, 0);
4125 w = XWINDOW (window_being_scrolled);
4127 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4129 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4130 /* The thumb size is incorrect while dragging: fix it. */
4131 set_vertical_scroll_bar (w);
4133 window_being_scrolled = Qnil;
4134 last_scroll_bar_part = -1;
4136 /* Xt timeouts no longer needed. */
4137 toolkit_scroll_bar_interaction = 0;
4140 #endif /* not USE_GTK */
4142 /* A vector of windows used for communication between
4143 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4145 static struct window **scroll_bar_windows;
4146 static int scroll_bar_windows_size;
4149 /* Send a client message with message type Xatom_Scrollbar for a
4150 scroll action to the frame of WINDOW. PART is a value identifying
4151 the part of the scroll bar that was clicked on. PORTION is the
4152 amount to scroll of a whole of WHOLE. */
4154 static void
4155 x_send_scroll_bar_event (window, part, portion, whole)
4156 Lisp_Object window;
4157 int part, portion, whole;
4159 XEvent event;
4160 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4161 struct window *w = XWINDOW (window);
4162 struct frame *f = XFRAME (w->frame);
4163 int i;
4165 BLOCK_INPUT;
4167 /* Construct a ClientMessage event to send to the frame. */
4168 ev->type = ClientMessage;
4169 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4170 ev->display = FRAME_X_DISPLAY (f);
4171 ev->window = FRAME_X_WINDOW (f);
4172 ev->format = 32;
4174 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4175 not enough to store a pointer or Lisp_Object on a 64 bit system.
4176 So, store the window in scroll_bar_windows and pass the index
4177 into that array in the event. */
4178 for (i = 0; i < scroll_bar_windows_size; ++i)
4179 if (scroll_bar_windows[i] == NULL)
4180 break;
4182 if (i == scroll_bar_windows_size)
4184 int new_size = max (10, 2 * scroll_bar_windows_size);
4185 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4186 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4188 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4189 nbytes);
4190 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4191 scroll_bar_windows_size = new_size;
4194 scroll_bar_windows[i] = w;
4195 ev->data.l[0] = (long) i;
4196 ev->data.l[1] = (long) part;
4197 ev->data.l[2] = (long) 0;
4198 ev->data.l[3] = (long) portion;
4199 ev->data.l[4] = (long) whole;
4201 /* Make Xt timeouts work while the scroll bar is active. */
4202 toolkit_scroll_bar_interaction = 1;
4203 #ifdef USE_X_TOOLKIT
4204 x_activate_timeout_atimer ();
4205 #endif
4207 /* Setting the event mask to zero means that the message will
4208 be sent to the client that created the window, and if that
4209 window no longer exists, no event will be sent. */
4210 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4211 UNBLOCK_INPUT;
4215 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4216 in *IEVENT. */
4218 static void
4219 x_scroll_bar_to_input_event (event, ievent)
4220 XEvent *event;
4221 struct input_event *ievent;
4223 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4224 Lisp_Object window;
4225 struct frame *f;
4226 struct window *w;
4228 w = scroll_bar_windows[ev->data.l[0]];
4229 scroll_bar_windows[ev->data.l[0]] = NULL;
4231 XSETWINDOW (window, w);
4232 f = XFRAME (w->frame);
4234 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4235 ievent->frame_or_window = window;
4236 ievent->arg = Qnil;
4237 #ifdef USE_GTK
4238 ievent->timestamp = CurrentTime;
4239 #else
4240 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4241 #endif
4242 ievent->part = ev->data.l[1];
4243 ievent->code = ev->data.l[2];
4244 ievent->x = make_number ((int) ev->data.l[3]);
4245 ievent->y = make_number ((int) ev->data.l[4]);
4246 ievent->modifiers = 0;
4250 #ifdef USE_MOTIF
4252 /* Minimum and maximum values used for Motif scroll bars. */
4254 #define XM_SB_MAX 10000000
4257 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4258 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4259 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4261 static void
4262 xm_scroll_callback (widget, client_data, call_data)
4263 Widget widget;
4264 XtPointer client_data, call_data;
4266 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4267 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4268 int part = -1, whole = 0, portion = 0;
4270 switch (cs->reason)
4272 case XmCR_DECREMENT:
4273 bar->dragging = Qnil;
4274 part = scroll_bar_up_arrow;
4275 break;
4277 case XmCR_INCREMENT:
4278 bar->dragging = Qnil;
4279 part = scroll_bar_down_arrow;
4280 break;
4282 case XmCR_PAGE_DECREMENT:
4283 bar->dragging = Qnil;
4284 part = scroll_bar_above_handle;
4285 break;
4287 case XmCR_PAGE_INCREMENT:
4288 bar->dragging = Qnil;
4289 part = scroll_bar_below_handle;
4290 break;
4292 case XmCR_TO_TOP:
4293 bar->dragging = Qnil;
4294 part = scroll_bar_to_top;
4295 break;
4297 case XmCR_TO_BOTTOM:
4298 bar->dragging = Qnil;
4299 part = scroll_bar_to_bottom;
4300 break;
4302 case XmCR_DRAG:
4304 int slider_size;
4306 /* Get the slider size. */
4307 BLOCK_INPUT;
4308 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4309 UNBLOCK_INPUT;
4311 whole = XM_SB_MAX - slider_size;
4312 portion = min (cs->value, whole);
4313 part = scroll_bar_handle;
4314 bar->dragging = make_number (cs->value);
4316 break;
4318 case XmCR_VALUE_CHANGED:
4319 break;
4322 if (part >= 0)
4324 window_being_scrolled = bar->window;
4325 last_scroll_bar_part = part;
4326 x_send_scroll_bar_event (bar->window, part, portion, whole);
4330 #elif defined USE_GTK
4332 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4333 bar widget. DATA is a pointer to the scroll_bar structure. */
4335 static void
4336 xg_scroll_callback (widget, data)
4337 GtkRange *widget;
4338 gpointer data;
4340 struct scroll_bar *bar = (struct scroll_bar *) data;
4341 gdouble previous;
4342 gdouble position;
4343 gdouble *p;
4344 int diff;
4346 int part = -1, whole = 0, portion = 0;
4347 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (widget));
4349 position = gtk_adjustment_get_value (adj);
4351 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
4352 if (! p)
4354 p = (gdouble*) xmalloc (sizeof (gdouble));
4355 *p = XG_SB_MIN;
4356 g_object_set_data (G_OBJECT (widget), XG_LAST_SB_DATA, p);
4359 previous = *p;
4360 *p = position;
4362 if (xg_ignore_gtk_scrollbar) return;
4364 diff = (int) (position - previous);
4366 if (diff == (int) adj->step_increment)
4368 part = scroll_bar_down_arrow;
4369 bar->dragging = Qnil;
4371 else if (-diff == (int) adj->step_increment)
4373 part = scroll_bar_up_arrow;
4374 bar->dragging = Qnil;
4376 else if (diff == (int) adj->page_increment)
4378 part = scroll_bar_below_handle;
4379 bar->dragging = Qnil;
4381 else if (-diff == (int) adj->page_increment)
4383 part = scroll_bar_above_handle;
4384 bar->dragging = Qnil;
4386 else
4388 part = scroll_bar_handle;
4389 whole = adj->upper - adj->page_size;
4390 portion = min ((int)position, whole);
4391 bar->dragging = make_number ((int)portion);
4394 if (part >= 0)
4396 window_being_scrolled = bar->window;
4397 last_scroll_bar_part = part;
4398 x_send_scroll_bar_event (bar->window, part, portion, whole);
4402 #else /* not USE_GTK and not USE_MOTIF */
4404 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4405 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4406 scroll bar struct. CALL_DATA is a pointer to a float saying where
4407 the thumb is. */
4409 static void
4410 xaw_jump_callback (widget, client_data, call_data)
4411 Widget widget;
4412 XtPointer client_data, call_data;
4414 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4415 float top = *(float *) call_data;
4416 float shown;
4417 int whole, portion, height;
4418 int part;
4420 /* Get the size of the thumb, a value between 0 and 1. */
4421 BLOCK_INPUT;
4422 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4423 UNBLOCK_INPUT;
4425 whole = 10000000;
4426 portion = shown < 1 ? top * whole : 0;
4428 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4429 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4430 the bottom, so we force the scrolling whenever we see that we're
4431 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4432 we try to ensure that we always stay two pixels away from the
4433 bottom). */
4434 part = scroll_bar_down_arrow;
4435 else
4436 part = scroll_bar_handle;
4438 window_being_scrolled = bar->window;
4439 bar->dragging = make_number (portion);
4440 last_scroll_bar_part = part;
4441 x_send_scroll_bar_event (bar->window, part, portion, whole);
4445 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4446 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4447 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4448 the scroll bar. CALL_DATA is an integer specifying the action that
4449 has taken place. Its magnitude is in the range 0..height of the
4450 scroll bar. Negative values mean scroll towards buffer start.
4451 Values < height of scroll bar mean line-wise movement. */
4453 static void
4454 xaw_scroll_callback (widget, client_data, call_data)
4455 Widget widget;
4456 XtPointer client_data, call_data;
4458 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4459 /* The position really is stored cast to a pointer. */
4460 int position = (long) call_data;
4461 Dimension height;
4462 int part;
4464 /* Get the height of the scroll bar. */
4465 BLOCK_INPUT;
4466 XtVaGetValues (widget, XtNheight, &height, NULL);
4467 UNBLOCK_INPUT;
4469 if (eabs (position) >= height)
4470 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4472 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4473 it maps line-movement to call_data = max(5, height/20). */
4474 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4475 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4476 else
4477 part = scroll_bar_move_ratio;
4479 window_being_scrolled = bar->window;
4480 bar->dragging = Qnil;
4481 last_scroll_bar_part = part;
4482 x_send_scroll_bar_event (bar->window, part, position, height);
4485 #endif /* not USE_GTK and not USE_MOTIF */
4487 #define SCROLL_BAR_NAME "verticalScrollBar"
4489 /* Create the widget for scroll bar BAR on frame F. Record the widget
4490 and X window of the scroll bar in BAR. */
4492 #ifdef USE_GTK
4493 static void
4494 x_create_toolkit_scroll_bar (f, bar)
4495 struct frame *f;
4496 struct scroll_bar *bar;
4498 char *scroll_bar_name = SCROLL_BAR_NAME;
4500 BLOCK_INPUT;
4501 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4502 scroll_bar_name);
4503 UNBLOCK_INPUT;
4506 #else /* not USE_GTK */
4508 static void
4509 x_create_toolkit_scroll_bar (f, bar)
4510 struct frame *f;
4511 struct scroll_bar *bar;
4513 Window xwindow;
4514 Widget widget;
4515 Arg av[20];
4516 int ac = 0;
4517 char *scroll_bar_name = SCROLL_BAR_NAME;
4518 unsigned long pixel;
4520 BLOCK_INPUT;
4522 #ifdef USE_MOTIF
4523 /* Set resources. Create the widget. */
4524 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4525 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4526 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4527 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4528 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4529 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4530 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4532 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4533 if (pixel != -1)
4535 XtSetArg (av[ac], XmNforeground, pixel);
4536 ++ac;
4539 pixel = f->output_data.x->scroll_bar_background_pixel;
4540 if (pixel != -1)
4542 XtSetArg (av[ac], XmNbackground, pixel);
4543 ++ac;
4546 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4547 scroll_bar_name, av, ac);
4549 /* Add one callback for everything that can happen. */
4550 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4551 (XtPointer) bar);
4552 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4553 (XtPointer) bar);
4554 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4555 (XtPointer) bar);
4556 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4557 (XtPointer) bar);
4558 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4559 (XtPointer) bar);
4560 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4561 (XtPointer) bar);
4562 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4563 (XtPointer) bar);
4565 /* Realize the widget. Only after that is the X window created. */
4566 XtRealizeWidget (widget);
4568 /* Set the cursor to an arrow. I didn't find a resource to do that.
4569 And I'm wondering why it hasn't an arrow cursor by default. */
4570 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4571 f->output_data.x->nontext_cursor);
4573 #else /* !USE_MOTIF i.e. use Xaw */
4575 /* Set resources. Create the widget. The background of the
4576 Xaw3d scroll bar widget is a little bit light for my taste.
4577 We don't alter it here to let users change it according
4578 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4579 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4580 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4581 /* For smoother scrolling with Xaw3d -sm */
4582 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4584 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4585 if (pixel != -1)
4587 XtSetArg (av[ac], XtNforeground, pixel);
4588 ++ac;
4591 pixel = f->output_data.x->scroll_bar_background_pixel;
4592 if (pixel != -1)
4594 XtSetArg (av[ac], XtNbackground, pixel);
4595 ++ac;
4598 /* Top/bottom shadow colors. */
4600 /* Allocate them, if necessary. */
4601 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4603 pixel = f->output_data.x->scroll_bar_background_pixel;
4604 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4605 &pixel, 1.2, 0x8000))
4606 pixel = -1;
4607 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4609 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4611 pixel = f->output_data.x->scroll_bar_background_pixel;
4612 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4613 &pixel, 0.6, 0x4000))
4614 pixel = -1;
4615 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4618 #ifdef XtNbeNiceToColormap
4619 /* Tell the toolkit about them. */
4620 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4621 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4622 /* We tried to allocate a color for the top/bottom shadow, and
4623 failed, so tell Xaw3d to use dithering instead. */
4625 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4626 ++ac;
4628 else
4629 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4630 be more consistent with other emacs 3d colors, and since Xaw3d is
4631 not good at dealing with allocation failure. */
4633 /* This tells Xaw3d to use real colors instead of dithering for
4634 the shadows. */
4635 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4636 ++ac;
4638 /* Specify the colors. */
4639 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4640 if (pixel != -1)
4642 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4643 ++ac;
4645 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4646 if (pixel != -1)
4648 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4649 ++ac;
4652 #endif
4654 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4655 f->output_data.x->edit_widget, av, ac);
4658 char *initial = "";
4659 char *val = initial;
4660 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4661 #ifdef XtNarrowScrollbars
4662 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4663 #endif
4664 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4665 if (xaw3d_arrow_scroll || val == initial)
4666 { /* ARROW_SCROLL */
4667 xaw3d_arrow_scroll = True;
4668 /* Isn't that just a personal preference ? --Stef */
4669 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4673 /* Define callbacks. */
4674 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4675 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4676 (XtPointer) bar);
4678 /* Realize the widget. Only after that is the X window created. */
4679 XtRealizeWidget (widget);
4681 #endif /* !USE_MOTIF */
4683 /* Install an action hook that lets us detect when the user
4684 finishes interacting with a scroll bar. */
4685 if (action_hook_id == 0)
4686 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4688 /* Remember X window and widget in the scroll bar vector. */
4689 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4690 xwindow = XtWindow (widget);
4691 bar->x_window = xwindow;
4693 UNBLOCK_INPUT;
4695 #endif /* not USE_GTK */
4698 /* Set the thumb size and position of scroll bar BAR. We are currently
4699 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4701 #ifdef USE_GTK
4702 static void
4703 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4704 struct scroll_bar *bar;
4705 int portion, position, whole;
4707 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4710 #else /* not 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 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4717 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4718 float top, shown;
4720 BLOCK_INPUT;
4722 #ifdef USE_MOTIF
4724 /* We use an estimate of 30 chars per line rather than the real
4725 `portion' value. This has the disadvantage that the thumb size
4726 is not very representative, but it makes our life a lot easier.
4727 Otherwise, we have to constantly adjust the thumb size, which
4728 we can't always do quickly enough: while dragging, the size of
4729 the thumb might prevent the user from dragging the thumb all the
4730 way to the end. but Motif and some versions of Xaw3d don't allow
4731 updating the thumb size while dragging. Also, even if we can update
4732 its size, the update will often happen too late.
4733 If you don't believe it, check out revision 1.650 of xterm.c to see
4734 what hoops we were going through and the still poor behavior we got. */
4735 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4736 /* When the thumb is at the bottom, position == whole.
4737 So we need to increase `whole' to make space for the thumb. */
4738 whole += portion;
4740 if (whole <= 0)
4741 top = 0, shown = 1;
4742 else
4744 top = (float) position / whole;
4745 shown = (float) portion / whole;
4748 if (NILP (bar->dragging))
4750 int size, value;
4752 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4753 is the scroll bar's maximum and MIN is the scroll bar's minimum
4754 value. */
4755 size = shown * XM_SB_MAX;
4756 size = min (size, XM_SB_MAX);
4757 size = max (size, 1);
4759 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4760 value = top * XM_SB_MAX;
4761 value = min (value, XM_SB_MAX - size);
4763 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4765 #else /* !USE_MOTIF i.e. use Xaw */
4767 if (whole == 0)
4768 top = 0, shown = 1;
4769 else
4771 top = (float) position / whole;
4772 shown = (float) portion / whole;
4776 float old_top, old_shown;
4777 Dimension height;
4778 XtVaGetValues (widget,
4779 XtNtopOfThumb, &old_top,
4780 XtNshown, &old_shown,
4781 XtNheight, &height,
4782 NULL);
4784 /* Massage the top+shown values. */
4785 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4786 top = max (0, min (1, top));
4787 else
4788 top = old_top;
4789 /* Keep two pixels available for moving the thumb down. */
4790 shown = max (0, min (1 - top - (2.0 / height), shown));
4792 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4793 check that your system's configuration file contains a define
4794 for `NARROWPROTO'. See s/freebsd.h for an example. */
4795 if (top != old_top || shown != old_shown)
4797 if (NILP (bar->dragging))
4798 XawScrollbarSetThumb (widget, top, shown);
4799 else
4801 /* Try to make the scrolling a tad smoother. */
4802 if (!xaw3d_pick_top)
4803 shown = min (shown, old_shown);
4805 XawScrollbarSetThumb (widget, top, shown);
4809 #endif /* !USE_MOTIF */
4811 UNBLOCK_INPUT;
4813 #endif /* not USE_GTK */
4815 #endif /* USE_TOOLKIT_SCROLL_BARS */
4819 /************************************************************************
4820 Scroll bars, general
4821 ************************************************************************/
4823 /* Create a scroll bar and return the scroll bar vector for it. W is
4824 the Emacs window on which to create the scroll bar. TOP, LEFT,
4825 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4826 scroll bar. */
4828 static struct scroll_bar *
4829 x_scroll_bar_create (w, top, left, width, height)
4830 struct window *w;
4831 int top, left, width, height;
4833 struct frame *f = XFRAME (w->frame);
4834 struct scroll_bar *bar
4835 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4837 BLOCK_INPUT;
4839 #ifdef USE_TOOLKIT_SCROLL_BARS
4840 x_create_toolkit_scroll_bar (f, bar);
4841 #else /* not USE_TOOLKIT_SCROLL_BARS */
4843 XSetWindowAttributes a;
4844 unsigned long mask;
4845 Window window;
4847 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4848 if (a.background_pixel == -1)
4849 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4851 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4852 | ButtonMotionMask | PointerMotionHintMask
4853 | ExposureMask);
4854 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4856 mask = (CWBackPixel | CWEventMask | CWCursor);
4858 /* Clear the area of W that will serve as a scroll bar. This is
4859 for the case that a window has been split horizontally. In
4860 this case, no clear_frame is generated to reduce flickering. */
4861 if (width > 0 && height > 0)
4862 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4863 left, top, width,
4864 window_box_height (w), False);
4866 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4867 /* Position and size of scroll bar. */
4868 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4869 top,
4870 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4871 height,
4872 /* Border width, depth, class, and visual. */
4874 CopyFromParent,
4875 CopyFromParent,
4876 CopyFromParent,
4877 /* Attributes. */
4878 mask, &a);
4879 bar->x_window = window;
4881 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4883 XSETWINDOW (bar->window, w);
4884 bar->top = top;
4885 bar->left = left;
4886 bar->width = width;
4887 bar->height = height;
4888 bar->start = 0;
4889 bar->end = 0;
4890 bar->dragging = Qnil;
4891 bar->fringe_extended_p = 0;
4893 /* Add bar to its frame's list of scroll bars. */
4894 bar->next = FRAME_SCROLL_BARS (f);
4895 bar->prev = Qnil;
4896 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4897 if (!NILP (bar->next))
4898 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4900 /* Map the window/widget. */
4901 #ifdef USE_TOOLKIT_SCROLL_BARS
4903 #ifdef USE_GTK
4904 xg_update_scrollbar_pos (f,
4905 bar->x_window,
4906 top,
4907 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4908 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4909 max (height, 1));
4910 xg_show_scroll_bar (bar->x_window);
4911 #else /* not USE_GTK */
4912 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4913 XtConfigureWidget (scroll_bar,
4914 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4915 top,
4916 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4917 max (height, 1), 0);
4918 XtMapWidget (scroll_bar);
4919 #endif /* not USE_GTK */
4921 #else /* not USE_TOOLKIT_SCROLL_BARS */
4922 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4923 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4925 UNBLOCK_INPUT;
4926 return bar;
4930 #ifndef USE_TOOLKIT_SCROLL_BARS
4932 /* Draw BAR's handle in the proper position.
4934 If the handle is already drawn from START to END, don't bother
4935 redrawing it, unless REBUILD is non-zero; in that case, always
4936 redraw it. (REBUILD is handy for drawing the handle after expose
4937 events.)
4939 Normally, we want to constrain the start and end of the handle to
4940 fit inside its rectangle, but if the user is dragging the scroll
4941 bar handle, we want to let them drag it down all the way, so that
4942 the bar's top is as far down as it goes; otherwise, there's no way
4943 to move to the very end of the buffer. */
4945 static void
4946 x_scroll_bar_set_handle (bar, start, end, rebuild)
4947 struct scroll_bar *bar;
4948 int start, end;
4949 int rebuild;
4951 int dragging = ! NILP (bar->dragging);
4952 Window w = bar->x_window;
4953 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4954 GC gc = f->output_data.x->normal_gc;
4956 /* If the display is already accurate, do nothing. */
4957 if (! rebuild
4958 && start == bar->start
4959 && end == bar->end)
4960 return;
4962 BLOCK_INPUT;
4965 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4966 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4967 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4969 /* Make sure the values are reasonable, and try to preserve
4970 the distance between start and end. */
4972 int length = end - start;
4974 if (start < 0)
4975 start = 0;
4976 else if (start > top_range)
4977 start = top_range;
4978 end = start + length;
4980 if (end < start)
4981 end = start;
4982 else if (end > top_range && ! dragging)
4983 end = top_range;
4986 /* Store the adjusted setting in the scroll bar. */
4987 bar->start = start;
4988 bar->end = end;
4990 /* Clip the end position, just for display. */
4991 if (end > top_range)
4992 end = top_range;
4994 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
4995 below top positions, to make sure the handle is always at least
4996 that many pixels tall. */
4997 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
4999 /* Draw the empty space above the handle. Note that we can't clear
5000 zero-height areas; that means "clear to end of window." */
5001 if (0 < start)
5002 x_clear_area (FRAME_X_DISPLAY (f), w,
5003 /* x, y, width, height, and exposures. */
5004 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5005 VERTICAL_SCROLL_BAR_TOP_BORDER,
5006 inside_width, start,
5007 False);
5009 /* Change to proper foreground color if one is specified. */
5010 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5011 XSetForeground (FRAME_X_DISPLAY (f), gc,
5012 f->output_data.x->scroll_bar_foreground_pixel);
5014 /* Draw the handle itself. */
5015 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5016 /* x, y, width, height */
5017 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5018 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5019 inside_width, end - start);
5021 /* Restore the foreground color of the GC if we changed it above. */
5022 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5023 XSetForeground (FRAME_X_DISPLAY (f), gc,
5024 FRAME_FOREGROUND_PIXEL (f));
5026 /* Draw the empty space below the handle. Note that we can't
5027 clear zero-height areas; that means "clear to end of window." */
5028 if (end < inside_height)
5029 x_clear_area (FRAME_X_DISPLAY (f), w,
5030 /* x, y, width, height, and exposures. */
5031 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5032 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5033 inside_width, inside_height - end,
5034 False);
5038 UNBLOCK_INPUT;
5041 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5043 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5044 nil. */
5046 static void
5047 x_scroll_bar_remove (bar)
5048 struct scroll_bar *bar;
5050 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5051 BLOCK_INPUT;
5053 #ifdef USE_TOOLKIT_SCROLL_BARS
5054 #ifdef USE_GTK
5055 xg_remove_scroll_bar (f, bar->x_window);
5056 #else /* not USE_GTK */
5057 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5058 #endif /* not USE_GTK */
5059 #else
5060 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5061 #endif
5063 /* Disassociate this scroll bar from its window. */
5064 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5066 UNBLOCK_INPUT;
5070 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5071 that we are displaying PORTION characters out of a total of WHOLE
5072 characters, starting at POSITION. If WINDOW has no scroll bar,
5073 create one. */
5075 static void
5076 XTset_vertical_scroll_bar (w, portion, whole, position)
5077 struct window *w;
5078 int portion, whole, position;
5080 struct frame *f = XFRAME (w->frame);
5081 struct scroll_bar *bar;
5082 int top, height, left, sb_left, width, sb_width;
5083 int window_y, window_height;
5084 #ifdef USE_TOOLKIT_SCROLL_BARS
5085 int fringe_extended_p;
5086 #endif
5088 /* Get window dimensions. */
5089 window_box (w, -1, 0, &window_y, 0, &window_height);
5090 top = window_y;
5091 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5092 height = window_height;
5094 /* Compute the left edge of the scroll bar area. */
5095 left = WINDOW_SCROLL_BAR_AREA_X (w);
5097 /* Compute the width of the scroll bar which might be less than
5098 the width of the area reserved for the scroll bar. */
5099 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5100 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5101 else
5102 sb_width = width;
5104 /* Compute the left edge of the scroll bar. */
5105 #ifdef USE_TOOLKIT_SCROLL_BARS
5106 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5107 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5108 else
5109 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5110 #else
5111 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5112 sb_left = left + width - sb_width;
5113 else
5114 sb_left = left;
5115 #endif
5117 #ifdef USE_TOOLKIT_SCROLL_BARS
5118 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5119 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5120 && WINDOW_LEFT_FRINGE_WIDTH (w)
5121 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5122 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5123 else
5124 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5125 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5126 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5127 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5128 #endif
5130 /* Does the scroll bar exist yet? */
5131 if (NILP (w->vertical_scroll_bar))
5133 if (width > 0 && height > 0)
5135 BLOCK_INPUT;
5136 #ifdef USE_TOOLKIT_SCROLL_BARS
5137 if (fringe_extended_p)
5138 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5139 sb_left, top, sb_width, height, False);
5140 else
5141 #endif
5142 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5143 left, top, width, height, False);
5144 UNBLOCK_INPUT;
5147 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5149 else
5151 /* It may just need to be moved and resized. */
5152 unsigned int mask = 0;
5154 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5156 BLOCK_INPUT;
5158 if (sb_left != bar->left)
5159 mask |= CWX;
5160 if (top != bar->top)
5161 mask |= CWY;
5162 if (sb_width != bar->width)
5163 mask |= CWWidth;
5164 if (height != bar->height)
5165 mask |= CWHeight;
5167 #ifdef USE_TOOLKIT_SCROLL_BARS
5169 /* Move/size the scroll bar widget. */
5170 if (mask || bar->fringe_extended_p != fringe_extended_p)
5172 /* Since toolkit scroll bars are smaller than the space reserved
5173 for them on the frame, we have to clear "under" them. */
5174 if (width > 0 && height > 0)
5176 if (fringe_extended_p)
5177 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5178 sb_left, top, sb_width, height, False);
5179 else
5180 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5181 left, top, width, height, False);
5183 #ifdef USE_GTK
5184 xg_update_scrollbar_pos (f,
5185 bar->x_window,
5186 top,
5187 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5188 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5189 max (height, 1));
5190 #else /* not USE_GTK */
5191 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5192 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5193 top,
5194 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5195 max (height, 1), 0);
5196 #endif /* not USE_GTK */
5198 #else /* not USE_TOOLKIT_SCROLL_BARS */
5200 /* Clear areas not covered by the scroll bar because of
5201 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5202 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5204 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5205 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5206 height, False);
5207 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5208 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5209 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5210 height, False);
5213 /* Clear areas not covered by the scroll bar because it's not as
5214 wide as the area reserved for it. This makes sure a
5215 previous mode line display is cleared after C-x 2 C-x 1, for
5216 example. */
5218 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5219 int rest = area_width - sb_width;
5220 if (rest > 0 && height > 0)
5222 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5223 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5224 left + area_width - rest, top,
5225 rest, height, False);
5226 else
5227 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5228 left, top, rest, height, False);
5232 /* Move/size the scroll bar window. */
5233 if (mask)
5235 XWindowChanges wc;
5237 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5238 wc.y = top;
5239 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5240 wc.height = height;
5241 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5242 mask, &wc);
5245 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5247 /* Remember new settings. */
5248 bar->left = sb_left;
5249 bar->top = top;
5250 bar->width = sb_width;
5251 bar->height = height;
5253 UNBLOCK_INPUT;
5256 #ifdef USE_TOOLKIT_SCROLL_BARS
5257 bar->fringe_extended_p = fringe_extended_p;
5259 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5260 #else /* not USE_TOOLKIT_SCROLL_BARS */
5261 /* Set the scroll bar's current state, unless we're currently being
5262 dragged. */
5263 if (NILP (bar->dragging))
5265 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5267 if (whole == 0)
5268 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5269 else
5271 int start = ((double) position * top_range) / whole;
5272 int end = ((double) (position + portion) * top_range) / whole;
5273 x_scroll_bar_set_handle (bar, start, end, 0);
5276 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5278 XSETVECTOR (w->vertical_scroll_bar, bar);
5282 /* The following three hooks are used when we're doing a thorough
5283 redisplay of the frame. We don't explicitly know which scroll bars
5284 are going to be deleted, because keeping track of when windows go
5285 away is a real pain - "Can you say set-window-configuration, boys
5286 and girls?" Instead, we just assert at the beginning of redisplay
5287 that *all* scroll bars are to be removed, and then save a scroll bar
5288 from the fiery pit when we actually redisplay its window. */
5290 /* Arrange for all scroll bars on FRAME to be removed at the next call
5291 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5292 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5294 static void
5295 XTcondemn_scroll_bars (frame)
5296 FRAME_PTR frame;
5298 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5299 while (! NILP (FRAME_SCROLL_BARS (frame)))
5301 Lisp_Object bar;
5302 bar = FRAME_SCROLL_BARS (frame);
5303 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5304 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5305 XSCROLL_BAR (bar)->prev = Qnil;
5306 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5307 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5308 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5313 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5314 Note that WINDOW isn't necessarily condemned at all. */
5316 static void
5317 XTredeem_scroll_bar (window)
5318 struct window *window;
5320 struct scroll_bar *bar;
5321 struct frame *f;
5323 /* We can't redeem this window's scroll bar if it doesn't have one. */
5324 if (NILP (window->vertical_scroll_bar))
5325 abort ();
5327 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5329 /* Unlink it from the condemned list. */
5330 f = XFRAME (WINDOW_FRAME (window));
5331 if (NILP (bar->prev))
5333 /* If the prev pointer is nil, it must be the first in one of
5334 the lists. */
5335 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5336 /* It's not condemned. Everything's fine. */
5337 return;
5338 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5339 window->vertical_scroll_bar))
5340 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5341 else
5342 /* If its prev pointer is nil, it must be at the front of
5343 one or the other! */
5344 abort ();
5346 else
5347 XSCROLL_BAR (bar->prev)->next = bar->next;
5349 if (! NILP (bar->next))
5350 XSCROLL_BAR (bar->next)->prev = bar->prev;
5352 bar->next = FRAME_SCROLL_BARS (f);
5353 bar->prev = Qnil;
5354 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5355 if (! NILP (bar->next))
5356 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5359 /* Remove all scroll bars on FRAME that haven't been saved since the
5360 last call to `*condemn_scroll_bars_hook'. */
5362 static void
5363 XTjudge_scroll_bars (f)
5364 FRAME_PTR f;
5366 Lisp_Object bar, next;
5368 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5370 /* Clear out the condemned list now so we won't try to process any
5371 more events on the hapless scroll bars. */
5372 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5374 for (; ! NILP (bar); bar = next)
5376 struct scroll_bar *b = XSCROLL_BAR (bar);
5378 x_scroll_bar_remove (b);
5380 next = b->next;
5381 b->next = b->prev = Qnil;
5384 /* Now there should be no references to the condemned scroll bars,
5385 and they should get garbage-collected. */
5389 #ifndef USE_TOOLKIT_SCROLL_BARS
5390 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5391 is a no-op when using toolkit scroll bars.
5393 This may be called from a signal handler, so we have to ignore GC
5394 mark bits. */
5396 static void
5397 x_scroll_bar_expose (bar, event)
5398 struct scroll_bar *bar;
5399 XEvent *event;
5401 Window w = bar->x_window;
5402 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5403 GC gc = f->output_data.x->normal_gc;
5404 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5406 BLOCK_INPUT;
5408 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5410 /* Switch to scroll bar foreground color. */
5411 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5412 XSetForeground (FRAME_X_DISPLAY (f), gc,
5413 f->output_data.x->scroll_bar_foreground_pixel);
5415 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5416 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5418 /* x, y, width, height */
5419 0, 0,
5420 bar->width - 1 - width_trim - width_trim,
5421 bar->height - 1);
5423 /* Restore the foreground color of the GC if we changed it above. */
5424 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5425 XSetForeground (FRAME_X_DISPLAY (f), gc,
5426 FRAME_FOREGROUND_PIXEL (f));
5428 UNBLOCK_INPUT;
5431 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5433 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5434 is set to something other than NO_EVENT, it is enqueued.
5436 This may be called from a signal handler, so we have to ignore GC
5437 mark bits. */
5440 static void
5441 x_scroll_bar_handle_click (bar, event, emacs_event)
5442 struct scroll_bar *bar;
5443 XEvent *event;
5444 struct input_event *emacs_event;
5446 if (! WINDOWP (bar->window))
5447 abort ();
5449 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5450 emacs_event->code = event->xbutton.button - Button1;
5451 emacs_event->modifiers
5452 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5453 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5454 event->xbutton.state)
5455 | (event->type == ButtonRelease
5456 ? up_modifier
5457 : down_modifier));
5458 emacs_event->frame_or_window = bar->window;
5459 emacs_event->arg = Qnil;
5460 emacs_event->timestamp = event->xbutton.time;
5462 #if 0
5463 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5464 int internal_height
5465 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5466 #endif
5467 int top_range
5468 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5469 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5471 if (y < 0) y = 0;
5472 if (y > top_range) y = top_range;
5474 if (y < bar->start)
5475 emacs_event->part = scroll_bar_above_handle;
5476 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5477 emacs_event->part = scroll_bar_handle;
5478 else
5479 emacs_event->part = scroll_bar_below_handle;
5481 /* Just because the user has clicked on the handle doesn't mean
5482 they want to drag it. Lisp code needs to be able to decide
5483 whether or not we're dragging. */
5484 #if 0
5485 /* If the user has just clicked on the handle, record where they're
5486 holding it. */
5487 if (event->type == ButtonPress
5488 && emacs_event->part == scroll_bar_handle)
5489 XSETINT (bar->dragging, y - bar->start);
5490 #endif
5492 #ifndef USE_TOOLKIT_SCROLL_BARS
5493 /* If the user has released the handle, set it to its final position. */
5494 if (event->type == ButtonRelease
5495 && ! NILP (bar->dragging))
5497 int new_start = y - XINT (bar->dragging);
5498 int new_end = new_start + bar->end - bar->start;
5500 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5501 bar->dragging = Qnil;
5503 #endif
5505 /* Same deal here as the other #if 0. */
5506 #if 0
5507 /* Clicks on the handle are always reported as occurring at the top of
5508 the handle. */
5509 if (emacs_event->part == scroll_bar_handle)
5510 emacs_event->x = bar->start;
5511 else
5512 XSETINT (emacs_event->x, y);
5513 #else
5514 XSETINT (emacs_event->x, y);
5515 #endif
5517 XSETINT (emacs_event->y, top_range);
5521 #ifndef USE_TOOLKIT_SCROLL_BARS
5523 /* Handle some mouse motion while someone is dragging the scroll bar.
5525 This may be called from a signal handler, so we have to ignore GC
5526 mark bits. */
5528 static void
5529 x_scroll_bar_note_movement (bar, event)
5530 struct scroll_bar *bar;
5531 XEvent *event;
5533 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5535 last_mouse_movement_time = event->xmotion.time;
5537 f->mouse_moved = 1;
5538 XSETVECTOR (last_mouse_scroll_bar, bar);
5540 /* If we're dragging the bar, display it. */
5541 if (! NILP (bar->dragging))
5543 /* Where should the handle be now? */
5544 int new_start = event->xmotion.y - XINT (bar->dragging);
5546 if (new_start != bar->start)
5548 int new_end = new_start + bar->end - bar->start;
5550 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5555 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5557 /* Return information to the user about the current position of the mouse
5558 on the scroll bar. */
5560 static void
5561 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5562 FRAME_PTR *fp;
5563 Lisp_Object *bar_window;
5564 enum scroll_bar_part *part;
5565 Lisp_Object *x, *y;
5566 unsigned long *time;
5568 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5569 Window w = bar->x_window;
5570 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5571 int win_x, win_y;
5572 Window dummy_window;
5573 int dummy_coord;
5574 unsigned int dummy_mask;
5576 BLOCK_INPUT;
5578 /* Get the mouse's position relative to the scroll bar window, and
5579 report that. */
5580 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5582 /* Root, child, root x and root y. */
5583 &dummy_window, &dummy_window,
5584 &dummy_coord, &dummy_coord,
5586 /* Position relative to scroll bar. */
5587 &win_x, &win_y,
5589 /* Mouse buttons and modifier keys. */
5590 &dummy_mask))
5592 else
5594 #if 0
5595 int inside_height
5596 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5597 #endif
5598 int top_range
5599 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5601 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5603 if (! NILP (bar->dragging))
5604 win_y -= XINT (bar->dragging);
5606 if (win_y < 0)
5607 win_y = 0;
5608 if (win_y > top_range)
5609 win_y = top_range;
5611 *fp = f;
5612 *bar_window = bar->window;
5614 if (! NILP (bar->dragging))
5615 *part = scroll_bar_handle;
5616 else if (win_y < bar->start)
5617 *part = scroll_bar_above_handle;
5618 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5619 *part = scroll_bar_handle;
5620 else
5621 *part = scroll_bar_below_handle;
5623 XSETINT (*x, win_y);
5624 XSETINT (*y, top_range);
5626 f->mouse_moved = 0;
5627 last_mouse_scroll_bar = Qnil;
5630 *time = last_mouse_movement_time;
5632 UNBLOCK_INPUT;
5636 /* The screen has been cleared so we may have changed foreground or
5637 background colors, and the scroll bars may need to be redrawn.
5638 Clear out the scroll bars, and ask for expose events, so we can
5639 redraw them. */
5641 void
5642 x_scroll_bar_clear (f)
5643 FRAME_PTR f;
5645 #ifndef USE_TOOLKIT_SCROLL_BARS
5646 Lisp_Object bar;
5648 /* We can have scroll bars even if this is 0,
5649 if we just turned off scroll bar mode.
5650 But in that case we should not clear them. */
5651 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5652 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5653 bar = XSCROLL_BAR (bar)->next)
5654 XClearArea (FRAME_X_DISPLAY (f),
5655 XSCROLL_BAR (bar)->x_window,
5656 0, 0, 0, 0, True);
5657 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5661 /* The main X event-reading loop - XTread_socket. */
5663 #if 0
5664 /* Time stamp of enter window event. This is only used by XTread_socket,
5665 but we have to put it out here, since static variables within functions
5666 sometimes don't work. */
5668 static Time enter_timestamp;
5669 #endif
5671 /* This holds the state XLookupString needs to implement dead keys
5672 and other tricks known as "compose processing". _X Window System_
5673 says that a portable program can't use this, but Stephen Gildea assures
5674 me that letting the compiler initialize it to zeros will work okay.
5676 This must be defined outside of XTread_socket, for the same reasons
5677 given for enter_timestamp, above. */
5679 static XComposeStatus compose_status;
5681 /* Record the last 100 characters stored
5682 to help debug the loss-of-chars-during-GC problem. */
5684 static int temp_index;
5685 static short temp_buffer[100];
5687 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5688 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5689 temp_index = 0; \
5690 temp_buffer[temp_index++] = (keysym)
5692 /* Set this to nonzero to fake an "X I/O error"
5693 on a particular display. */
5695 struct x_display_info *XTread_socket_fake_io_error;
5697 /* When we find no input here, we occasionally do a no-op command
5698 to verify that the X server is still running and we can still talk with it.
5699 We try all the open displays, one by one.
5700 This variable is used for cycling thru the displays. */
5702 static struct x_display_info *next_noop_dpyinfo;
5704 #define SET_SAVED_MENU_EVENT(size) \
5705 do \
5707 if (f->output_data.x->saved_menu_event == 0) \
5708 f->output_data.x->saved_menu_event \
5709 = (XEvent *) xmalloc (sizeof (XEvent)); \
5710 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5711 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5712 XSETFRAME (inev.ie.frame_or_window, f); \
5714 while (0)
5716 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5717 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5720 enum
5722 X_EVENT_NORMAL,
5723 X_EVENT_GOTO_OUT,
5724 X_EVENT_DROP
5727 /* Filter events for the current X input method.
5728 DPYINFO is the display this event is for.
5729 EVENT is the X event to filter.
5731 Returns non-zero if the event was filtered, caller shall not process
5732 this event further.
5733 Returns zero if event is wasn't filtered. */
5735 #ifdef HAVE_X_I18N
5736 static int
5737 x_filter_event (dpyinfo, event)
5738 struct x_display_info *dpyinfo;
5739 XEvent *event;
5741 /* XFilterEvent returns non-zero if the input method has
5742 consumed the event. We pass the frame's X window to
5743 XFilterEvent because that's the one for which the IC
5744 was created. */
5746 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5747 event->xclient.window);
5749 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5751 #endif
5753 #ifdef USE_GTK
5754 static int current_count;
5755 static int current_finish;
5756 static struct input_event *current_hold_quit;
5758 /* This is the filter function invoked by the GTK event loop.
5759 It is invoked before the XEvent is translated to a GdkEvent,
5760 so we have a chance to act on the event before GTK. */
5761 static GdkFilterReturn
5762 event_handler_gdk (gxev, ev, data)
5763 GdkXEvent *gxev;
5764 GdkEvent *ev;
5765 gpointer data;
5767 XEvent *xev = (XEvent *) gxev;
5769 if (current_count >= 0)
5771 struct x_display_info *dpyinfo;
5773 dpyinfo = x_display_info_for_display (xev->xany.display);
5775 #ifdef HAVE_X_I18N
5776 /* Filter events for the current X input method.
5777 GTK calls XFilterEvent but not for key press and release,
5778 so we do it here. */
5779 if (xev->type == KeyPress || xev->type == KeyRelease)
5780 if (dpyinfo && x_filter_event (dpyinfo, xev))
5781 return GDK_FILTER_REMOVE;
5782 #endif
5784 if (! dpyinfo)
5785 current_finish = X_EVENT_NORMAL;
5786 else
5788 current_count +=
5789 handle_one_xevent (dpyinfo, xev, &current_finish,
5790 current_hold_quit);
5793 else
5794 current_finish = x_dispatch_event (xev, xev->xany.display);
5796 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5797 return GDK_FILTER_REMOVE;
5799 return GDK_FILTER_CONTINUE;
5801 #endif /* USE_GTK */
5804 /* Handles the XEvent EVENT on display DPYINFO.
5806 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5807 *FINISH is zero if caller should continue reading events.
5808 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5810 We return the number of characters stored into the buffer. */
5812 static int
5813 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5814 struct x_display_info *dpyinfo;
5815 XEvent *eventp;
5816 int *finish;
5817 struct input_event *hold_quit;
5819 union {
5820 struct input_event ie;
5821 struct selection_input_event sie;
5822 } inev;
5823 int count = 0;
5824 int do_help = 0;
5825 int nbytes = 0;
5826 struct frame *f = NULL;
5827 struct coding_system coding;
5828 XEvent event = *eventp;
5830 *finish = X_EVENT_NORMAL;
5832 EVENT_INIT (inev.ie);
5833 inev.ie.kind = NO_EVENT;
5834 inev.ie.arg = Qnil;
5836 switch (event.type)
5838 case ClientMessage:
5840 if (event.xclient.message_type
5841 == dpyinfo->Xatom_wm_protocols
5842 && event.xclient.format == 32)
5844 if (event.xclient.data.l[0]
5845 == dpyinfo->Xatom_wm_take_focus)
5847 /* Use x_any_window_to_frame because this
5848 could be the shell widget window
5849 if the frame has no title bar. */
5850 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5851 #ifdef HAVE_X_I18N
5852 /* Not quite sure this is needed -pd */
5853 if (f && FRAME_XIC (f))
5854 XSetICFocus (FRAME_XIC (f));
5855 #endif
5856 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5857 instructs the WM to set the input focus automatically for
5858 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5859 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5860 it has set the focus. So, XSetInputFocus below is not
5861 needed.
5863 The call to XSetInputFocus below has also caused trouble. In
5864 cases where the XSetInputFocus done by the WM and the one
5865 below are temporally close (on a fast machine), the call
5866 below can generate additional FocusIn events which confuse
5867 Emacs. */
5869 /* Since we set WM_TAKE_FOCUS, we must call
5870 XSetInputFocus explicitly. But not if f is null,
5871 since that might be an event for a deleted frame. */
5872 if (f)
5874 Display *d = event.xclient.display;
5875 /* Catch and ignore errors, in case window has been
5876 iconified by a window manager such as GWM. */
5877 x_catch_errors (d);
5878 XSetInputFocus (d, event.xclient.window,
5879 /* The ICCCM says this is
5880 the only valid choice. */
5881 RevertToParent,
5882 event.xclient.data.l[1]);
5883 /* This is needed to detect the error
5884 if there is an error. */
5885 XSync (d, False);
5886 x_uncatch_errors ();
5888 /* Not certain about handling scroll bars here */
5889 #endif /* 0 */
5890 goto done;
5893 if (event.xclient.data.l[0]
5894 == dpyinfo->Xatom_wm_save_yourself)
5896 /* Save state modify the WM_COMMAND property to
5897 something which can reinstate us. This notifies
5898 the session manager, who's looking for such a
5899 PropertyNotify. Can restart processing when
5900 a keyboard or mouse event arrives. */
5901 /* If we have a session manager, don't set this.
5902 KDE will then start two Emacsen, one for the
5903 session manager and one for this. */
5904 #ifdef HAVE_X_SM
5905 if (! x_session_have_connection ())
5906 #endif
5908 f = x_top_window_to_frame (dpyinfo,
5909 event.xclient.window);
5910 /* This is just so we only give real data once
5911 for a single Emacs process. */
5912 if (f == SELECTED_FRAME ())
5913 XSetCommand (FRAME_X_DISPLAY (f),
5914 event.xclient.window,
5915 initial_argv, initial_argc);
5916 else if (f)
5917 XSetCommand (FRAME_X_DISPLAY (f),
5918 event.xclient.window,
5919 0, 0);
5921 goto done;
5924 if (event.xclient.data.l[0]
5925 == dpyinfo->Xatom_wm_delete_window)
5927 f = x_any_window_to_frame (dpyinfo,
5928 event.xclient.window);
5929 if (!f)
5930 goto OTHER; /* May be a dialog that is to be removed */
5932 inev.ie.kind = DELETE_WINDOW_EVENT;
5933 XSETFRAME (inev.ie.frame_or_window, f);
5934 goto done;
5937 goto done;
5940 if (event.xclient.message_type
5941 == dpyinfo->Xatom_wm_configure_denied)
5943 goto done;
5946 if (event.xclient.message_type
5947 == dpyinfo->Xatom_wm_window_moved)
5949 int new_x, new_y;
5950 f = x_window_to_frame (dpyinfo, event.xclient.window);
5952 new_x = event.xclient.data.s[0];
5953 new_y = event.xclient.data.s[1];
5955 if (f)
5957 f->left_pos = new_x;
5958 f->top_pos = new_y;
5960 goto done;
5963 #ifdef HACK_EDITRES
5964 if (event.xclient.message_type
5965 == dpyinfo->Xatom_editres)
5967 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5968 if (f)
5969 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5970 &event, NULL);
5971 goto done;
5973 #endif /* HACK_EDITRES */
5975 if ((event.xclient.message_type
5976 == dpyinfo->Xatom_DONE)
5977 || (event.xclient.message_type
5978 == dpyinfo->Xatom_PAGE))
5980 /* Ghostview job completed. Kill it. We could
5981 reply with "Next" if we received "Page", but we
5982 currently never do because we are interested in
5983 images, only, which should have 1 page. */
5984 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5985 f = x_window_to_frame (dpyinfo, event.xclient.window);
5986 if (!f)
5987 goto OTHER;
5988 x_kill_gs_process (pixmap, f);
5989 expose_frame (f, 0, 0, 0, 0);
5990 goto done;
5993 #ifdef USE_TOOLKIT_SCROLL_BARS
5994 /* Scroll bar callbacks send a ClientMessage from which
5995 we construct an input_event. */
5996 if (event.xclient.message_type
5997 == dpyinfo->Xatom_Scrollbar)
5999 x_scroll_bar_to_input_event (&event, &inev.ie);
6000 *finish = X_EVENT_GOTO_OUT;
6001 goto done;
6003 #endif /* USE_TOOLKIT_SCROLL_BARS */
6005 /* XEmbed messages from the embedder (if any). */
6006 if (event.xclient.message_type
6007 == dpyinfo->Xatom_XEMBED)
6009 enum xembed_message msg = event.xclient.data.l[1];
6010 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6011 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6013 *finish = X_EVENT_GOTO_OUT;
6014 goto done;
6017 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6018 if (!f)
6019 goto OTHER;
6020 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6021 *finish = X_EVENT_DROP;
6023 break;
6025 case SelectionNotify:
6026 last_user_time = event.xselection.time;
6027 #ifdef USE_X_TOOLKIT
6028 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6029 goto OTHER;
6030 #endif /* not USE_X_TOOLKIT */
6031 x_handle_selection_notify (&event.xselection);
6032 break;
6034 case SelectionClear: /* Someone has grabbed ownership. */
6035 last_user_time = event.xselectionclear.time;
6036 #ifdef USE_X_TOOLKIT
6037 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6038 goto OTHER;
6039 #endif /* USE_X_TOOLKIT */
6041 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6043 inev.ie.kind = SELECTION_CLEAR_EVENT;
6044 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6045 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6046 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6047 inev.ie.frame_or_window = Qnil;
6049 break;
6051 case SelectionRequest: /* Someone wants our selection. */
6052 last_user_time = event.xselectionrequest.time;
6053 #ifdef USE_X_TOOLKIT
6054 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6055 goto OTHER;
6056 #endif /* USE_X_TOOLKIT */
6058 XSelectionRequestEvent *eventp
6059 = (XSelectionRequestEvent *) &event;
6061 inev.ie.kind = SELECTION_REQUEST_EVENT;
6062 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6063 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6064 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6065 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6066 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6067 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6068 inev.ie.frame_or_window = Qnil;
6070 break;
6072 case PropertyNotify:
6073 last_user_time = event.xproperty.time;
6074 #if 0 /* This is plain wrong. In the case that we are waiting for a
6075 PropertyNotify used as an ACK in incremental selection
6076 transfer, the property will be on the receiver's window. */
6077 #if defined USE_X_TOOLKIT
6078 if (!x_any_window_to_frame (dpyinfo, event.xproperty.window))
6079 goto OTHER;
6080 #endif
6081 #endif
6082 x_handle_property_notify (&event.xproperty);
6083 goto OTHER;
6085 case ReparentNotify:
6086 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6087 if (f)
6089 int x, y;
6090 f->output_data.x->parent_desc = event.xreparent.parent;
6091 x_real_positions (f, &x, &y);
6092 f->left_pos = x;
6093 f->top_pos = y;
6095 /* Perhaps reparented due to a WM restart. Reset this. */
6096 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6097 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6099 goto OTHER;
6101 case Expose:
6102 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6103 if (f)
6105 x_check_fullscreen (f);
6107 #ifdef USE_GTK
6108 /* This seems to be needed for GTK 2.6. */
6109 x_clear_area (event.xexpose.display,
6110 event.xexpose.window,
6111 event.xexpose.x, event.xexpose.y,
6112 event.xexpose.width, event.xexpose.height,
6113 FALSE);
6114 #endif
6115 if (f->async_visible == 0)
6117 f->async_visible = 1;
6118 f->async_iconified = 0;
6119 f->output_data.x->has_been_visible = 1;
6120 SET_FRAME_GARBAGED (f);
6122 else
6123 expose_frame (f,
6124 event.xexpose.x, event.xexpose.y,
6125 event.xexpose.width, event.xexpose.height);
6127 else
6129 #ifndef USE_TOOLKIT_SCROLL_BARS
6130 struct scroll_bar *bar;
6131 #endif
6132 #if defined USE_LUCID
6133 /* Submenus of the Lucid menu bar aren't widgets
6134 themselves, so there's no way to dispatch events
6135 to them. Recognize this case separately. */
6137 Widget widget
6138 = x_window_to_menu_bar (event.xexpose.window);
6139 if (widget)
6140 xlwmenu_redisplay (widget);
6142 #endif /* USE_LUCID */
6144 #ifdef USE_TOOLKIT_SCROLL_BARS
6145 /* Dispatch event to the widget. */
6146 goto OTHER;
6147 #else /* not USE_TOOLKIT_SCROLL_BARS */
6148 bar = x_window_to_scroll_bar (event.xexpose.display,
6149 event.xexpose.window);
6151 if (bar)
6152 x_scroll_bar_expose (bar, &event);
6153 #ifdef USE_X_TOOLKIT
6154 else
6155 goto OTHER;
6156 #endif /* USE_X_TOOLKIT */
6157 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6159 break;
6161 case GraphicsExpose: /* This occurs when an XCopyArea's
6162 source area was obscured or not
6163 available. */
6164 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6165 if (f)
6167 expose_frame (f,
6168 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6169 event.xgraphicsexpose.width,
6170 event.xgraphicsexpose.height);
6172 #ifdef USE_X_TOOLKIT
6173 else
6174 goto OTHER;
6175 #endif /* USE_X_TOOLKIT */
6176 break;
6178 case NoExpose: /* This occurs when an XCopyArea's
6179 source area was completely
6180 available. */
6181 break;
6183 case UnmapNotify:
6184 /* Redo the mouse-highlight after the tooltip has gone. */
6185 if (event.xmap.window == tip_window)
6187 tip_window = 0;
6188 redo_mouse_highlight ();
6191 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6192 if (f) /* F may no longer exist if
6193 the frame was deleted. */
6195 /* While a frame is unmapped, display generation is
6196 disabled; you don't want to spend time updating a
6197 display that won't ever be seen. */
6198 f->async_visible = 0;
6199 /* We can't distinguish, from the event, whether the window
6200 has become iconified or invisible. So assume, if it
6201 was previously visible, than now it is iconified.
6202 But x_make_frame_invisible clears both
6203 the visible flag and the iconified flag;
6204 and that way, we know the window is not iconified now. */
6205 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6207 f->async_iconified = 1;
6209 inev.ie.kind = ICONIFY_EVENT;
6210 XSETFRAME (inev.ie.frame_or_window, f);
6213 goto OTHER;
6215 case MapNotify:
6216 if (event.xmap.window == tip_window)
6217 /* The tooltip has been drawn already. Avoid
6218 the SET_FRAME_GARBAGED below. */
6219 goto OTHER;
6221 /* We use x_top_window_to_frame because map events can
6222 come for sub-windows and they don't mean that the
6223 frame is visible. */
6224 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6225 if (f)
6227 /* wait_reading_process_output will notice this and update
6228 the frame's display structures.
6229 If we where iconified, we should not set garbaged,
6230 because that stops redrawing on Expose events. This looks
6231 bad if we are called from a recursive event loop
6232 (x_dispatch_event), for example when a dialog is up. */
6233 if (! f->async_iconified)
6234 SET_FRAME_GARBAGED (f);
6236 f->async_visible = 1;
6237 f->async_iconified = 0;
6238 f->output_data.x->has_been_visible = 1;
6240 if (f->iconified)
6242 inev.ie.kind = DEICONIFY_EVENT;
6243 XSETFRAME (inev.ie.frame_or_window, f);
6245 else if (! NILP (Vframe_list)
6246 && ! NILP (XCDR (Vframe_list)))
6247 /* Force a redisplay sooner or later
6248 to update the frame titles
6249 in case this is the second frame. */
6250 record_asynch_buffer_change ();
6252 goto OTHER;
6254 case KeyPress:
6256 last_user_time = event.xkey.time;
6257 ignore_next_mouse_click_timeout = 0;
6259 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6260 /* Dispatch KeyPress events when in menu. */
6261 if (popup_activated ())
6262 goto OTHER;
6263 #endif
6265 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6267 /* If mouse-highlight is an integer, input clears out
6268 mouse highlighting. */
6269 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6270 && (f == 0
6271 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6273 clear_mouse_face (dpyinfo);
6274 dpyinfo->mouse_face_hidden = 1;
6277 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6278 if (f == 0)
6280 /* Scroll bars consume key events, but we want
6281 the keys to go to the scroll bar's frame. */
6282 Widget widget = XtWindowToWidget (dpyinfo->display,
6283 event.xkey.window);
6284 if (widget && XmIsScrollBar (widget))
6286 widget = XtParent (widget);
6287 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6290 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6292 if (f != 0)
6294 KeySym keysym, orig_keysym;
6295 /* al%imercury@uunet.uu.net says that making this 81
6296 instead of 80 fixed a bug whereby meta chars made
6297 his Emacs hang.
6299 It seems that some version of XmbLookupString has
6300 a bug of not returning XBufferOverflow in
6301 status_return even if the input is too long to
6302 fit in 81 bytes. So, we must prepare sufficient
6303 bytes for copy_buffer. 513 bytes (256 chars for
6304 two-byte character set) seems to be a fairly good
6305 approximation. -- 2000.8.10 handa@etl.go.jp */
6306 unsigned char copy_buffer[513];
6307 unsigned char *copy_bufptr = copy_buffer;
6308 int copy_bufsiz = sizeof (copy_buffer);
6309 int modifiers;
6310 Lisp_Object coding_system = Qlatin_1;
6311 Lisp_Object c;
6313 #ifdef USE_GTK
6314 /* Don't pass keys to GTK. A Tab will shift focus to the
6315 tool bar in GTK 2.4. Keys will still go to menus and
6316 dialogs because in that case popup_activated is TRUE
6317 (see above). */
6318 *finish = X_EVENT_DROP;
6319 #endif
6321 event.xkey.state
6322 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6323 extra_keyboard_modifiers);
6324 modifiers = event.xkey.state;
6326 /* This will have to go some day... */
6328 /* make_lispy_event turns chars into control chars.
6329 Don't do it here because XLookupString is too eager. */
6330 event.xkey.state &= ~ControlMask;
6331 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6332 | dpyinfo->super_mod_mask
6333 | dpyinfo->hyper_mod_mask
6334 | dpyinfo->alt_mod_mask);
6336 /* In case Meta is ComposeCharacter,
6337 clear its status. According to Markus Ehrnsperger
6338 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6339 this enables ComposeCharacter to work whether or
6340 not it is combined with Meta. */
6341 if (modifiers & dpyinfo->meta_mod_mask)
6342 bzero (&compose_status, sizeof (compose_status));
6344 #ifdef HAVE_X_I18N
6345 if (FRAME_XIC (f))
6347 Status status_return;
6349 coding_system = Vlocale_coding_system;
6350 nbytes = XmbLookupString (FRAME_XIC (f),
6351 &event.xkey, copy_bufptr,
6352 copy_bufsiz, &keysym,
6353 &status_return);
6354 if (status_return == XBufferOverflow)
6356 copy_bufsiz = nbytes + 1;
6357 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6358 nbytes = XmbLookupString (FRAME_XIC (f),
6359 &event.xkey, copy_bufptr,
6360 copy_bufsiz, &keysym,
6361 &status_return);
6363 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6364 #if 0 && defined X_HAVE_UTF8_STRING
6365 else if (status_return == XLookupKeySym)
6366 { /* Try again but with utf-8. */
6367 coding_system = Qutf_8;
6368 nbytes = Xutf8LookupString (FRAME_XIC (f),
6369 &event.xkey, copy_bufptr,
6370 copy_bufsiz, &keysym,
6371 &status_return);
6372 if (status_return == XBufferOverflow)
6374 copy_bufsiz = nbytes + 1;
6375 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6376 nbytes = Xutf8LookupString (FRAME_XIC (f),
6377 &event.xkey,
6378 copy_bufptr,
6379 copy_bufsiz, &keysym,
6380 &status_return);
6383 #endif
6385 if (status_return == XLookupNone)
6386 break;
6387 else if (status_return == XLookupChars)
6389 keysym = NoSymbol;
6390 modifiers = 0;
6392 else if (status_return != XLookupKeySym
6393 && status_return != XLookupBoth)
6394 abort ();
6396 else
6397 nbytes = XLookupString (&event.xkey, copy_bufptr,
6398 copy_bufsiz, &keysym,
6399 &compose_status);
6400 #else
6401 nbytes = XLookupString (&event.xkey, copy_bufptr,
6402 copy_bufsiz, &keysym,
6403 &compose_status);
6404 #endif
6406 /* If not using XIM/XIC, and a compose sequence is in progress,
6407 we break here. Otherwise, chars_matched is always 0. */
6408 if (compose_status.chars_matched > 0 && nbytes == 0)
6409 break;
6411 bzero (&compose_status, sizeof (compose_status));
6412 orig_keysym = keysym;
6414 /* Common for all keysym input events. */
6415 XSETFRAME (inev.ie.frame_or_window, f);
6416 inev.ie.modifiers
6417 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6418 inev.ie.timestamp = event.xkey.time;
6420 /* First deal with keysyms which have defined
6421 translations to characters. */
6422 if (keysym >= 32 && keysym < 128)
6423 /* Avoid explicitly decoding each ASCII character. */
6425 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6426 inev.ie.code = keysym;
6427 goto done_keysym;
6430 /* Keysyms directly mapped to Unicode characters. */
6431 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6433 if (keysym < 0x01000080)
6434 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6435 else
6436 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6437 inev.ie.code = keysym & 0xFFFFFF;
6438 goto done_keysym;
6441 /* Now non-ASCII. */
6442 if (HASH_TABLE_P (Vx_keysym_table)
6443 && (NATNUMP (c = Fgethash (make_number (keysym),
6444 Vx_keysym_table,
6445 Qnil))))
6447 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6448 ? ASCII_KEYSTROKE_EVENT
6449 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6450 inev.ie.code = XFASTINT (c);
6451 goto done_keysym;
6454 /* Random non-modifier sorts of keysyms. */
6455 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6456 || keysym == XK_Delete
6457 #ifdef XK_ISO_Left_Tab
6458 || (keysym >= XK_ISO_Left_Tab
6459 && keysym <= XK_ISO_Enter)
6460 #endif
6461 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6462 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6463 #ifdef HPUX
6464 /* This recognizes the "extended function
6465 keys". It seems there's no cleaner way.
6466 Test IsModifierKey to avoid handling
6467 mode_switch incorrectly. */
6468 || ((unsigned) (keysym) >= XK_Select
6469 && (unsigned)(keysym) < XK_KP_Space)
6470 #endif
6471 #ifdef XK_dead_circumflex
6472 || orig_keysym == XK_dead_circumflex
6473 #endif
6474 #ifdef XK_dead_grave
6475 || orig_keysym == XK_dead_grave
6476 #endif
6477 #ifdef XK_dead_tilde
6478 || orig_keysym == XK_dead_tilde
6479 #endif
6480 #ifdef XK_dead_diaeresis
6481 || orig_keysym == XK_dead_diaeresis
6482 #endif
6483 #ifdef XK_dead_macron
6484 || orig_keysym == XK_dead_macron
6485 #endif
6486 #ifdef XK_dead_degree
6487 || orig_keysym == XK_dead_degree
6488 #endif
6489 #ifdef XK_dead_acute
6490 || orig_keysym == XK_dead_acute
6491 #endif
6492 #ifdef XK_dead_cedilla
6493 || orig_keysym == XK_dead_cedilla
6494 #endif
6495 #ifdef XK_dead_breve
6496 || orig_keysym == XK_dead_breve
6497 #endif
6498 #ifdef XK_dead_ogonek
6499 || orig_keysym == XK_dead_ogonek
6500 #endif
6501 #ifdef XK_dead_caron
6502 || orig_keysym == XK_dead_caron
6503 #endif
6504 #ifdef XK_dead_doubleacute
6505 || orig_keysym == XK_dead_doubleacute
6506 #endif
6507 #ifdef XK_dead_abovedot
6508 || orig_keysym == XK_dead_abovedot
6509 #endif
6510 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6511 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6512 /* Any "vendor-specific" key is ok. */
6513 || (orig_keysym & (1 << 28))
6514 || (keysym != NoSymbol && nbytes == 0))
6515 && ! (IsModifierKey (orig_keysym)
6516 /* The symbols from XK_ISO_Lock
6517 to XK_ISO_Last_Group_Lock
6518 don't have real modifiers but
6519 should be treated similarly to
6520 Mode_switch by Emacs. */
6521 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6522 || ((unsigned)(orig_keysym)
6523 >= XK_ISO_Lock
6524 && (unsigned)(orig_keysym)
6525 <= XK_ISO_Last_Group_Lock)
6526 #endif
6529 STORE_KEYSYM_FOR_DEBUG (keysym);
6530 /* make_lispy_event will convert this to a symbolic
6531 key. */
6532 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6533 inev.ie.code = keysym;
6534 goto done_keysym;
6537 { /* Raw bytes, not keysym. */
6538 register int i;
6539 register int c;
6540 int nchars, len;
6542 for (i = 0, nchars = 0; i < nbytes; i++)
6544 if (ASCII_BYTE_P (copy_bufptr[i]))
6545 nchars++;
6546 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6549 if (nchars < nbytes)
6551 /* Decode the input data. */
6552 int require;
6553 unsigned char *p;
6555 /* The input should be decoded with `coding_system'
6556 which depends on which X*LookupString function
6557 we used just above and the locale. */
6558 setup_coding_system (coding_system, &coding);
6559 coding.src_multibyte = 0;
6560 coding.dst_multibyte = 1;
6561 /* The input is converted to events, thus we can't
6562 handle composition. Anyway, there's no XIM that
6563 gives us composition information. */
6564 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6566 require = MAX_MULTIBYTE_LENGTH * nbytes;
6567 coding.destination = alloca (require);
6568 coding.dst_bytes = require;
6569 coding.mode |= CODING_MODE_LAST_BLOCK;
6570 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6571 nbytes = coding.produced;
6572 nchars = coding.produced_char;
6573 copy_bufptr = coding.destination;
6576 /* Convert the input data to a sequence of
6577 character events. */
6578 for (i = 0; i < nbytes; i += len)
6580 if (nchars == nbytes)
6581 c = copy_bufptr[i], len = 1;
6582 else
6583 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i,
6584 nbytes - i, len);
6585 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6586 ? ASCII_KEYSTROKE_EVENT
6587 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6588 inev.ie.code = c;
6589 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6592 count += nchars;
6594 inev.ie.kind = NO_EVENT; /* Already stored above. */
6596 if (keysym == NoSymbol)
6597 break;
6600 done_keysym:
6601 #ifdef HAVE_X_I18N
6602 /* Don't dispatch this event since XtDispatchEvent calls
6603 XFilterEvent, and two calls in a row may freeze the
6604 client. */
6605 break;
6606 #else
6607 goto OTHER;
6608 #endif
6610 case KeyRelease:
6611 last_user_time = event.xkey.time;
6612 #ifdef HAVE_X_I18N
6613 /* Don't dispatch this event since XtDispatchEvent calls
6614 XFilterEvent, and two calls in a row may freeze the
6615 client. */
6616 break;
6617 #else
6618 goto OTHER;
6619 #endif
6621 case EnterNotify:
6622 last_user_time = event.xcrossing.time;
6623 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6625 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6627 if (f && x_mouse_click_focus_ignore_position)
6628 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6630 #if 0
6631 if (event.xcrossing.focus)
6633 /* Avoid nasty pop/raise loops. */
6634 if (f && (!(f->auto_raise)
6635 || !(f->auto_lower)
6636 || (event.xcrossing.time - enter_timestamp) > 500))
6638 x_new_focus_frame (dpyinfo, f);
6639 enter_timestamp = event.xcrossing.time;
6642 else if (f == dpyinfo->x_focus_frame)
6643 x_new_focus_frame (dpyinfo, 0);
6644 #endif
6646 /* EnterNotify counts as mouse movement,
6647 so update things that depend on mouse position. */
6648 if (f && !f->output_data.x->hourglass_p)
6649 note_mouse_movement (f, &event.xmotion);
6650 #ifdef USE_GTK
6651 /* We may get an EnterNotify on the buttons in the toolbar. In that
6652 case we moved out of any highlighted area and need to note this. */
6653 if (!f && last_mouse_glyph_frame)
6654 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6655 #endif
6656 goto OTHER;
6658 case FocusIn:
6659 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6660 goto OTHER;
6662 case LeaveNotify:
6663 last_user_time = event.xcrossing.time;
6664 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6666 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6667 if (f)
6669 if (f == dpyinfo->mouse_face_mouse_frame)
6671 /* If we move outside the frame, then we're
6672 certainly no longer on any text in the frame. */
6673 clear_mouse_face (dpyinfo);
6674 dpyinfo->mouse_face_mouse_frame = 0;
6677 /* Generate a nil HELP_EVENT to cancel a help-echo.
6678 Do it only if there's something to cancel.
6679 Otherwise, the startup message is cleared when
6680 the mouse leaves the frame. */
6681 if (any_help_event_p)
6682 do_help = -1;
6684 #ifdef USE_GTK
6685 /* See comment in EnterNotify above */
6686 else if (last_mouse_glyph_frame)
6687 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6688 #endif
6689 goto OTHER;
6691 case FocusOut:
6692 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6693 goto OTHER;
6695 case MotionNotify:
6697 last_user_time = event.xmotion.time;
6698 previous_help_echo_string = help_echo_string;
6699 help_echo_string = Qnil;
6701 if (dpyinfo->grabbed && last_mouse_frame
6702 && FRAME_LIVE_P (last_mouse_frame))
6703 f = last_mouse_frame;
6704 else
6705 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6707 if (dpyinfo->mouse_face_hidden)
6709 dpyinfo->mouse_face_hidden = 0;
6710 clear_mouse_face (dpyinfo);
6713 if (f)
6716 /* Generate SELECT_WINDOW_EVENTs when needed. */
6717 if (!NILP (Vmouse_autoselect_window))
6719 Lisp_Object window;
6721 window = window_from_coordinates (f,
6722 event.xmotion.x, event.xmotion.y,
6723 0, 0, 0, 0);
6725 /* Window will be selected only when it is not selected now and
6726 last mouse movement event was not in it. Minibuffer window
6727 will be selected only when it is active. */
6728 if (WINDOWP (window)
6729 && !EQ (window, last_window)
6730 && !EQ (window, selected_window)
6731 /* For click-to-focus window managers
6732 create event iff we don't leave the
6733 selected frame. */
6734 && (focus_follows_mouse
6735 || (EQ (XWINDOW (window)->frame,
6736 XWINDOW (selected_window)->frame))))
6738 inev.ie.kind = SELECT_WINDOW_EVENT;
6739 inev.ie.frame_or_window = window;
6742 last_window=window;
6744 if (!note_mouse_movement (f, &event.xmotion))
6745 help_echo_string = previous_help_echo_string;
6747 else
6749 #ifndef USE_TOOLKIT_SCROLL_BARS
6750 struct scroll_bar *bar
6751 = x_window_to_scroll_bar (event.xmotion.display,
6752 event.xmotion.window);
6754 if (bar)
6755 x_scroll_bar_note_movement (bar, &event);
6756 #endif /* USE_TOOLKIT_SCROLL_BARS */
6758 /* If we move outside the frame, then we're
6759 certainly no longer on any text in the frame. */
6760 clear_mouse_face (dpyinfo);
6763 /* If the contents of the global variable help_echo_string
6764 has changed, generate a HELP_EVENT. */
6765 if (!NILP (help_echo_string)
6766 || !NILP (previous_help_echo_string))
6767 do_help = 1;
6768 goto OTHER;
6771 case ConfigureNotify:
6772 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6773 #ifdef USE_GTK
6774 if (!f
6775 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6776 && event.xconfigure.window == FRAME_X_WINDOW (f))
6778 xg_frame_resized (f, event.xconfigure.width,
6779 event.xconfigure.height);
6780 f = 0;
6782 #endif
6783 if (f)
6785 #ifndef USE_X_TOOLKIT
6786 #ifndef USE_GTK
6787 /* If there is a pending resize for fullscreen, don't
6788 do this one, the right one will come later.
6789 The toolkit version doesn't seem to need this, but we
6790 need to reset it below. */
6791 int dont_resize
6792 = ((f->want_fullscreen & FULLSCREEN_WAIT)
6793 && f->new_text_cols != 0);
6794 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6795 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6797 if (dont_resize)
6798 goto OTHER;
6800 /* In the toolkit version, change_frame_size
6801 is called by the code that handles resizing
6802 of the EmacsFrame widget. */
6804 /* Even if the number of character rows and columns has
6805 not changed, the font size may have changed, so we need
6806 to check the pixel dimensions as well. */
6807 if (columns != FRAME_COLS (f)
6808 || rows != FRAME_LINES (f)
6809 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6810 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6812 change_frame_size (f, rows, columns, 0, 1, 0);
6813 SET_FRAME_GARBAGED (f);
6814 cancel_mouse_face (f);
6817 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6818 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6819 #endif /* not USE_GTK */
6820 #endif
6822 #ifdef USE_GTK
6823 /* GTK creates windows but doesn't map them.
6824 Only get real positions and check fullscreen when mapped. */
6825 if (FRAME_GTK_OUTER_WIDGET (f)
6826 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6827 #endif
6829 x_real_positions (f, &f->left_pos, &f->top_pos);
6831 if (f->want_fullscreen & FULLSCREEN_WAIT)
6832 f->want_fullscreen &= ~(FULLSCREEN_WAIT|FULLSCREEN_BOTH);
6835 #ifdef HAVE_X_I18N
6836 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6837 xic_set_statusarea (f);
6838 #endif
6840 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
6842 /* Since the WM decorations come below top_pos now,
6843 we must put them below top_pos in the future. */
6844 f->win_gravity = NorthWestGravity;
6845 x_wm_set_size_hint (f, (long) 0, 0);
6848 goto OTHER;
6850 case ButtonRelease:
6851 case ButtonPress:
6853 /* If we decide we want to generate an event to be seen
6854 by the rest of Emacs, we put it here. */
6855 int tool_bar_p = 0;
6857 bzero (&compose_status, sizeof (compose_status));
6858 last_mouse_glyph_frame = 0;
6859 last_user_time = event.xbutton.time;
6861 if (dpyinfo->grabbed
6862 && last_mouse_frame
6863 && FRAME_LIVE_P (last_mouse_frame))
6864 f = last_mouse_frame;
6865 else
6866 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6868 if (f)
6870 /* Is this in the tool-bar? */
6871 if (WINDOWP (f->tool_bar_window)
6872 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6874 Lisp_Object window;
6875 int x = event.xbutton.x;
6876 int y = event.xbutton.y;
6878 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6879 tool_bar_p = EQ (window, f->tool_bar_window);
6881 if (tool_bar_p && event.xbutton.button < 4)
6883 handle_tool_bar_click (f, x, y,
6884 event.xbutton.type == ButtonPress,
6885 x_x_to_emacs_modifiers (dpyinfo,
6886 event.xbutton.state));
6890 if (!tool_bar_p)
6891 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6892 if (! popup_activated ())
6893 #endif
6895 if (ignore_next_mouse_click_timeout)
6897 if (event.type == ButtonPress
6898 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6900 ignore_next_mouse_click_timeout = 0;
6901 construct_mouse_click (&inev.ie, &event.xbutton, f);
6903 if (event.type == ButtonRelease)
6904 ignore_next_mouse_click_timeout = 0;
6906 else
6907 construct_mouse_click (&inev.ie, &event.xbutton, f);
6909 if (FRAME_X_EMBEDDED_P (f))
6910 xembed_send_message (f, event.xbutton.time,
6911 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6913 else
6915 struct scroll_bar *bar
6916 = x_window_to_scroll_bar (event.xbutton.display,
6917 event.xbutton.window);
6919 #ifdef USE_TOOLKIT_SCROLL_BARS
6920 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6921 scroll bars. */
6922 if (bar && event.xbutton.state & ControlMask)
6924 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6925 *finish = X_EVENT_DROP;
6927 #else /* not USE_TOOLKIT_SCROLL_BARS */
6928 if (bar)
6929 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6930 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6933 if (event.type == ButtonPress)
6935 dpyinfo->grabbed |= (1 << event.xbutton.button);
6936 last_mouse_frame = f;
6938 if (!tool_bar_p)
6939 last_tool_bar_item = -1;
6941 else
6942 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6944 /* Ignore any mouse motion that happened before this event;
6945 any subsequent mouse-movement Emacs events should reflect
6946 only motion after the ButtonPress/Release. */
6947 if (f != 0)
6948 f->mouse_moved = 0;
6950 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6951 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6952 /* For a down-event in the menu bar,
6953 don't pass it to Xt right now.
6954 Instead, save it away
6955 and we will pass it to Xt from kbd_buffer_get_event.
6956 That way, we can run some Lisp code first. */
6957 if (
6958 #ifdef USE_GTK
6959 ! popup_activated ()
6960 /* Gtk+ menus only react to the first three buttons. */
6961 && event.xbutton.button < 3
6963 #endif
6964 f && event.type == ButtonPress
6965 /* Verify the event is really within the menu bar
6966 and not just sent to it due to grabbing. */
6967 && event.xbutton.x >= 0
6968 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6969 && event.xbutton.y >= 0
6970 && event.xbutton.y < f->output_data.x->menubar_height
6971 && event.xbutton.same_screen)
6973 SET_SAVED_BUTTON_EVENT;
6974 XSETFRAME (last_mouse_press_frame, f);
6975 #ifdef USE_GTK
6976 *finish = X_EVENT_DROP;
6977 #endif
6979 else if (event.type == ButtonPress)
6981 last_mouse_press_frame = Qnil;
6982 goto OTHER;
6985 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6986 but I am trying to be cautious. */
6987 else if (event.type == ButtonRelease)
6989 if (!NILP (last_mouse_press_frame))
6991 f = XFRAME (last_mouse_press_frame);
6992 if (f->output_data.x)
6993 SET_SAVED_BUTTON_EVENT;
6995 else
6996 goto OTHER;
6998 #endif /* USE_MOTIF */
6999 else
7000 goto OTHER;
7001 #endif /* USE_X_TOOLKIT || USE_GTK */
7003 break;
7005 case CirculateNotify:
7006 goto OTHER;
7008 case CirculateRequest:
7009 goto OTHER;
7011 case VisibilityNotify:
7012 goto OTHER;
7014 case MappingNotify:
7015 /* Someone has changed the keyboard mapping - update the
7016 local cache. */
7017 switch (event.xmapping.request)
7019 case MappingModifier:
7020 x_find_modifier_meanings (dpyinfo);
7021 /* This is meant to fall through. */
7022 case MappingKeyboard:
7023 XRefreshKeyboardMapping (&event.xmapping);
7025 goto OTHER;
7027 default:
7028 OTHER:
7029 #ifdef USE_X_TOOLKIT
7030 BLOCK_INPUT;
7031 if (*finish != X_EVENT_DROP)
7032 XtDispatchEvent (&event);
7033 UNBLOCK_INPUT;
7034 #endif /* USE_X_TOOLKIT */
7035 break;
7038 done:
7039 if (inev.ie.kind != NO_EVENT)
7041 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7042 count++;
7045 if (do_help
7046 && !(hold_quit && hold_quit->kind != NO_EVENT))
7048 Lisp_Object frame;
7050 if (f)
7051 XSETFRAME (frame, f);
7052 else
7053 frame = Qnil;
7055 if (do_help > 0)
7057 any_help_event_p = 1;
7058 gen_help_event (help_echo_string, frame, help_echo_window,
7059 help_echo_object, help_echo_pos);
7061 else
7063 help_echo_string = Qnil;
7064 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7066 count++;
7069 *eventp = event;
7070 return count;
7074 /* Handles the XEvent EVENT on display DISPLAY.
7075 This is used for event loops outside the normal event handling,
7076 i.e. looping while a popup menu or a dialog is posted.
7078 Returns the value handle_one_xevent sets in the finish argument. */
7080 x_dispatch_event (event, display)
7081 XEvent *event;
7082 Display *display;
7084 struct x_display_info *dpyinfo;
7085 int finish = X_EVENT_NORMAL;
7087 dpyinfo = x_display_info_for_display (display);
7089 if (dpyinfo)
7090 handle_one_xevent (dpyinfo, event, &finish, 0);
7092 return finish;
7096 /* Read events coming from the X server.
7097 This routine is called by the SIGIO handler.
7098 We return as soon as there are no more events to be read.
7100 We return the number of characters stored into the buffer,
7101 thus pretending to be `read' (except the characters we store
7102 in the keyboard buffer can be multibyte, so are not necessarily
7103 C chars).
7105 EXPECTED is nonzero if the caller knows input is available. */
7107 static int
7108 XTread_socket (terminal, expected, hold_quit)
7109 struct terminal *terminal;
7110 int expected;
7111 struct input_event *hold_quit;
7113 int count = 0;
7114 XEvent event;
7115 int event_found = 0;
7116 #if 0
7117 struct x_display_info *dpyinfo;
7118 #endif
7120 if (interrupt_input_blocked)
7122 interrupt_input_pending = 1;
7123 return -1;
7126 interrupt_input_pending = 0;
7127 BLOCK_INPUT;
7129 /* So people can tell when we have read the available input. */
7130 input_signal_count++;
7132 ++handling_signal;
7134 #ifdef HAVE_X_SM
7135 /* Only check session manager input for the primary display. */
7136 if (terminal->id == 1 && x_session_have_connection ())
7138 struct input_event inev;
7139 BLOCK_INPUT;
7140 /* We don't need to EVENT_INIT (inev) here, as
7141 x_session_check_input copies an entire input_event. */
7142 if (x_session_check_input (&inev))
7144 kbd_buffer_store_event_hold (&inev, hold_quit);
7145 count++;
7147 UNBLOCK_INPUT;
7149 #endif
7151 /* For debugging, this gives a way to fake an I/O error. */
7152 if (terminal->display_info.x == XTread_socket_fake_io_error)
7154 XTread_socket_fake_io_error = 0;
7155 x_io_error_quitter (terminal->display_info.x->display);
7158 #if 0 /* This loop is a noop now. */
7159 /* Find the display we are supposed to read input for.
7160 It's the one communicating on descriptor SD. */
7161 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
7163 #if 0 /* This ought to be unnecessary; let's verify it. */
7164 #ifdef FIOSNBIO
7165 /* If available, Xlib uses FIOSNBIO to make the socket
7166 non-blocking, and then looks for EWOULDBLOCK. If O_NDELAY is set,
7167 FIOSNBIO is ignored, and instead of signaling EWOULDBLOCK,
7168 a read returns 0, which Xlib interprets as equivalent to EPIPE. */
7169 fcntl (dpyinfo->connection, F_SETFL, 0);
7170 #endif /* ! defined (FIOSNBIO) */
7171 #endif
7173 #if 0 /* This code can't be made to work, with multiple displays,
7174 and appears not to be used on any system any more.
7175 Also keyboard.c doesn't turn O_NDELAY on and off
7176 for X connections. */
7177 #ifndef SIGIO
7178 #ifndef HAVE_SELECT
7179 if (! (fcntl (dpyinfo->connection, F_GETFL, 0) & O_NDELAY))
7181 extern int read_alarm_should_throw;
7182 read_alarm_should_throw = 1;
7183 XPeekEvent (dpyinfo->display, &event);
7184 read_alarm_should_throw = 0;
7186 #endif /* HAVE_SELECT */
7187 #endif /* SIGIO */
7188 #endif
7190 #endif
7192 #ifndef USE_GTK
7193 while (XPending (terminal->display_info.x->display))
7195 int finish;
7197 XNextEvent (terminal->display_info.x->display, &event);
7199 #ifdef HAVE_X_I18N
7200 /* Filter events for the current X input method. */
7201 if (x_filter_event (terminal->display_info.x, &event))
7202 break;
7203 #endif
7204 event_found = 1;
7206 count += handle_one_xevent (terminal->display_info.x,
7207 &event, &finish, hold_quit);
7209 if (finish == X_EVENT_GOTO_OUT)
7210 goto out;
7213 #else /* USE_GTK */
7215 /* For GTK we must use the GTK event loop. But XEvents gets passed
7216 to our filter function above, and then to the big event switch.
7217 We use a bunch of globals to communicate with our filter function,
7218 that is kind of ugly, but it works.
7220 There is no way to do one display at the time, GTK just does events
7221 from all displays. */
7223 while (gtk_events_pending ())
7225 current_count = count;
7226 current_hold_quit = hold_quit;
7228 gtk_main_iteration ();
7230 count = current_count;
7231 current_count = -1;
7232 current_hold_quit = 0;
7234 if (current_finish == X_EVENT_GOTO_OUT)
7235 break;
7237 #endif /* USE_GTK */
7239 out:;
7241 /* On some systems, an X bug causes Emacs to get no more events
7242 when the window is destroyed. Detect that. (1994.) */
7243 if (! event_found)
7245 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7246 One XNOOP in 100 loops will make Emacs terminate.
7247 B. Bretthauer, 1994 */
7248 x_noop_count++;
7249 if (x_noop_count >= 100)
7251 x_noop_count=0;
7253 if (next_noop_dpyinfo == 0)
7254 next_noop_dpyinfo = x_display_list;
7256 XNoOp (next_noop_dpyinfo->display);
7258 /* Each time we get here, cycle through the displays now open. */
7259 next_noop_dpyinfo = next_noop_dpyinfo->next;
7263 /* If the focus was just given to an auto-raising frame,
7264 raise it now. */
7265 /* ??? This ought to be able to handle more than one such frame. */
7266 if (pending_autoraise_frame)
7268 x_raise_frame (pending_autoraise_frame);
7269 pending_autoraise_frame = 0;
7272 --handling_signal;
7273 UNBLOCK_INPUT;
7275 return count;
7281 /***********************************************************************
7282 Text Cursor
7283 ***********************************************************************/
7285 /* Set clipping for output in glyph row ROW. W is the window in which
7286 we operate. GC is the graphics context to set clipping in.
7288 ROW may be a text row or, e.g., a mode line. Text rows must be
7289 clipped to the interior of the window dedicated to text display,
7290 mode lines must be clipped to the whole window. */
7292 static void
7293 x_clip_to_row (w, row, area, gc)
7294 struct window *w;
7295 struct glyph_row *row;
7296 int area;
7297 GC gc;
7299 struct frame *f = XFRAME (WINDOW_FRAME (w));
7300 XRectangle clip_rect;
7301 int window_x, window_y, window_width;
7303 window_box (w, area, &window_x, &window_y, &window_width, 0);
7305 clip_rect.x = window_x;
7306 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7307 clip_rect.y = max (clip_rect.y, window_y);
7308 clip_rect.width = window_width;
7309 clip_rect.height = row->visible_height;
7311 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7315 /* Draw a hollow box cursor on window W in glyph row ROW. */
7317 static void
7318 x_draw_hollow_cursor (w, row)
7319 struct window *w;
7320 struct glyph_row *row;
7322 struct frame *f = XFRAME (WINDOW_FRAME (w));
7323 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7324 Display *dpy = FRAME_X_DISPLAY (f);
7325 int x, y, wd, h;
7326 XGCValues xgcv;
7327 struct glyph *cursor_glyph;
7328 GC gc;
7330 /* Get the glyph the cursor is on. If we can't tell because
7331 the current matrix is invalid or such, give up. */
7332 cursor_glyph = get_phys_cursor_glyph (w);
7333 if (cursor_glyph == NULL)
7334 return;
7336 /* Compute frame-relative coordinates for phys cursor. */
7337 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7338 wd = w->phys_cursor_width;
7340 /* The foreground of cursor_gc is typically the same as the normal
7341 background color, which can cause the cursor box to be invisible. */
7342 xgcv.foreground = f->output_data.x->cursor_pixel;
7343 if (dpyinfo->scratch_cursor_gc)
7344 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7345 else
7346 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7347 GCForeground, &xgcv);
7348 gc = dpyinfo->scratch_cursor_gc;
7350 /* Set clipping, draw the rectangle, and reset clipping again. */
7351 x_clip_to_row (w, row, TEXT_AREA, gc);
7352 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7353 XSetClipMask (dpy, gc, None);
7357 /* Draw a bar cursor on window W in glyph row ROW.
7359 Implementation note: One would like to draw a bar cursor with an
7360 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7361 Unfortunately, I didn't find a font yet that has this property set.
7362 --gerd. */
7364 static void
7365 x_draw_bar_cursor (w, row, width, kind)
7366 struct window *w;
7367 struct glyph_row *row;
7368 int width;
7369 enum text_cursor_kinds kind;
7371 struct frame *f = XFRAME (w->frame);
7372 struct glyph *cursor_glyph;
7374 /* If cursor is out of bounds, don't draw garbage. This can happen
7375 in mini-buffer windows when switching between echo area glyphs
7376 and mini-buffer. */
7377 cursor_glyph = get_phys_cursor_glyph (w);
7378 if (cursor_glyph == NULL)
7379 return;
7381 /* If on an image, draw like a normal cursor. That's usually better
7382 visible than drawing a bar, esp. if the image is large so that
7383 the bar might not be in the window. */
7384 if (cursor_glyph->type == IMAGE_GLYPH)
7386 struct glyph_row *row;
7387 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7388 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7390 else
7392 Display *dpy = FRAME_X_DISPLAY (f);
7393 Window window = FRAME_X_WINDOW (f);
7394 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7395 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7396 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7397 XGCValues xgcv;
7399 /* If the glyph's background equals the color we normally draw
7400 the bar cursor in, the bar cursor in its normal color is
7401 invisible. Use the glyph's foreground color instead in this
7402 case, on the assumption that the glyph's colors are chosen so
7403 that the glyph is legible. */
7404 if (face->background == f->output_data.x->cursor_pixel)
7405 xgcv.background = xgcv.foreground = face->foreground;
7406 else
7407 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7408 xgcv.graphics_exposures = 0;
7410 if (gc)
7411 XChangeGC (dpy, gc, mask, &xgcv);
7412 else
7414 gc = XCreateGC (dpy, window, mask, &xgcv);
7415 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7418 if (width < 0)
7419 width = FRAME_CURSOR_WIDTH (f);
7420 width = min (cursor_glyph->pixel_width, width);
7422 w->phys_cursor_width = width;
7423 x_clip_to_row (w, row, TEXT_AREA, gc);
7425 if (kind == BAR_CURSOR)
7426 XFillRectangle (dpy, window, gc,
7427 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7428 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7429 width, row->height);
7430 else
7431 XFillRectangle (dpy, window, gc,
7432 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7433 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7434 row->height - width),
7435 cursor_glyph->pixel_width,
7436 width);
7438 XSetClipMask (dpy, gc, None);
7443 /* RIF: Define cursor CURSOR on frame F. */
7445 static void
7446 x_define_frame_cursor (f, cursor)
7447 struct frame *f;
7448 Cursor cursor;
7450 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7454 /* RIF: Clear area on frame F. */
7456 static void
7457 x_clear_frame_area (f, x, y, width, height)
7458 struct frame *f;
7459 int x, y, width, height;
7461 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7462 x, y, width, height, False);
7466 /* RIF: Draw cursor on window W. */
7468 static void
7469 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7470 struct window *w;
7471 struct glyph_row *glyph_row;
7472 int x, y;
7473 int cursor_type, cursor_width;
7474 int on_p, active_p;
7476 struct frame *f = XFRAME (WINDOW_FRAME (w));
7478 if (on_p)
7480 w->phys_cursor_type = cursor_type;
7481 w->phys_cursor_on_p = 1;
7483 if (glyph_row->exact_window_width_line_p
7484 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7486 glyph_row->cursor_in_fringe_p = 1;
7487 draw_fringe_bitmap (w, glyph_row, 0);
7489 else
7490 switch (cursor_type)
7492 case HOLLOW_BOX_CURSOR:
7493 x_draw_hollow_cursor (w, glyph_row);
7494 break;
7496 case FILLED_BOX_CURSOR:
7497 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7498 break;
7500 case BAR_CURSOR:
7501 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7502 break;
7504 case HBAR_CURSOR:
7505 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7506 break;
7508 case NO_CURSOR:
7509 w->phys_cursor_width = 0;
7510 break;
7512 default:
7513 abort ();
7516 #ifdef HAVE_X_I18N
7517 if (w == XWINDOW (f->selected_window))
7518 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7519 xic_set_preeditarea (w, x, y);
7520 #endif
7523 #ifndef XFlush
7524 XFlush (FRAME_X_DISPLAY (f));
7525 #endif
7529 /* Icons. */
7531 /* Make the x-window of frame F use the gnu icon bitmap. */
7534 x_bitmap_icon (f, file)
7535 struct frame *f;
7536 Lisp_Object file;
7538 int bitmap_id;
7540 if (FRAME_X_WINDOW (f) == 0)
7541 return 1;
7543 /* Free up our existing icon bitmap and mask if any. */
7544 if (f->output_data.x->icon_bitmap > 0)
7545 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7546 f->output_data.x->icon_bitmap = 0;
7548 if (STRINGP (file))
7550 #ifdef USE_GTK
7551 /* Use gtk_window_set_icon_from_file () if available,
7552 It's not restricted to bitmaps */
7553 if (xg_set_icon (f, file))
7554 return 0;
7555 #endif /* USE_GTK */
7556 bitmap_id = x_create_bitmap_from_file (f, file);
7557 x_create_bitmap_mask (f, bitmap_id);
7559 else
7561 /* Create the GNU bitmap and mask if necessary. */
7562 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7564 int rc = -1;
7566 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7567 #ifdef USE_GTK
7568 if (xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7569 return 0;
7570 #else
7571 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7572 if (rc != -1)
7573 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7574 #endif /* USE_GTK */
7575 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
7577 /* If all else fails, use the (black and white) xbm image. */
7578 if (rc == -1)
7580 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7581 gnu_xbm_width, gnu_xbm_height);
7582 if (rc == -1)
7583 return 1;
7585 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7586 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7590 /* The first time we create the GNU bitmap and mask,
7591 this increments the ref-count one extra time.
7592 As a result, the GNU bitmap and mask are never freed.
7593 That way, we don't have to worry about allocating it again. */
7594 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7596 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7599 x_wm_set_icon_pixmap (f, bitmap_id);
7600 f->output_data.x->icon_bitmap = bitmap_id;
7602 return 0;
7606 /* Make the x-window of frame F use a rectangle with text.
7607 Use ICON_NAME as the text. */
7610 x_text_icon (f, icon_name)
7611 struct frame *f;
7612 char *icon_name;
7614 if (FRAME_X_WINDOW (f) == 0)
7615 return 1;
7618 XTextProperty text;
7619 text.value = (unsigned char *) icon_name;
7620 text.encoding = XA_STRING;
7621 text.format = 8;
7622 text.nitems = strlen (icon_name);
7623 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7626 if (f->output_data.x->icon_bitmap > 0)
7627 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7628 f->output_data.x->icon_bitmap = 0;
7629 x_wm_set_icon_pixmap (f, 0);
7631 return 0;
7634 #define X_ERROR_MESSAGE_SIZE 200
7636 /* If non-nil, this should be a string.
7637 It means catch X errors and store the error message in this string.
7639 The reason we use a stack is that x_catch_error/x_uncatch_error can
7640 be called from a signal handler.
7643 struct x_error_message_stack {
7644 char string[X_ERROR_MESSAGE_SIZE];
7645 Display *dpy;
7646 struct x_error_message_stack *prev;
7648 static struct x_error_message_stack *x_error_message;
7650 /* An X error handler which stores the error message in
7651 *x_error_message. This is called from x_error_handler if
7652 x_catch_errors is in effect. */
7654 static void
7655 x_error_catcher (display, error)
7656 Display *display;
7657 XErrorEvent *error;
7659 XGetErrorText (display, error->error_code,
7660 x_error_message->string,
7661 X_ERROR_MESSAGE_SIZE);
7664 /* Begin trapping X errors for display DPY. Actually we trap X errors
7665 for all displays, but DPY should be the display you are actually
7666 operating on.
7668 After calling this function, X protocol errors no longer cause
7669 Emacs to exit; instead, they are recorded in the string
7670 stored in *x_error_message.
7672 Calling x_check_errors signals an Emacs error if an X error has
7673 occurred since the last call to x_catch_errors or x_check_errors.
7675 Calling x_uncatch_errors resumes the normal error handling. */
7677 void x_check_errors ();
7679 void
7680 x_catch_errors (dpy)
7681 Display *dpy;
7683 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7685 /* Make sure any errors from previous requests have been dealt with. */
7686 XSync (dpy, False);
7688 data->dpy = dpy;
7689 data->string[0] = 0;
7690 data->prev = x_error_message;
7691 x_error_message = data;
7694 /* Undo the last x_catch_errors call.
7695 DPY should be the display that was passed to x_catch_errors. */
7697 void
7698 x_uncatch_errors ()
7700 struct x_error_message_stack *tmp;
7702 BLOCK_INPUT;
7704 /* The display may have been closed before this function is called.
7705 Check if it is still open before calling XSync. */
7706 if (x_display_info_for_display (x_error_message->dpy) != 0)
7707 XSync (x_error_message->dpy, False);
7709 tmp = x_error_message;
7710 x_error_message = x_error_message->prev;
7711 xfree (tmp);
7712 UNBLOCK_INPUT;
7715 /* If any X protocol errors have arrived since the last call to
7716 x_catch_errors or x_check_errors, signal an Emacs error using
7717 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7719 void
7720 x_check_errors (dpy, format)
7721 Display *dpy;
7722 char *format;
7724 /* Make sure to catch any errors incurred so far. */
7725 XSync (dpy, False);
7727 if (x_error_message->string[0])
7729 char string[X_ERROR_MESSAGE_SIZE];
7730 bcopy (x_error_message->string, string, X_ERROR_MESSAGE_SIZE);
7731 x_uncatch_errors ();
7732 error (format, string);
7736 /* Nonzero if we had any X protocol errors
7737 since we did x_catch_errors on DPY. */
7740 x_had_errors_p (dpy)
7741 Display *dpy;
7743 /* Make sure to catch any errors incurred so far. */
7744 XSync (dpy, False);
7746 return x_error_message->string[0] != 0;
7749 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7751 void
7752 x_clear_errors (dpy)
7753 Display *dpy;
7755 x_error_message->string[0] = 0;
7758 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7759 * idea. --lorentey */
7760 /* Close off all unclosed x_catch_errors calls. */
7762 void
7763 x_fully_uncatch_errors ()
7765 while (x_error_message)
7766 x_uncatch_errors ();
7768 #endif
7770 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7773 x_catching_errors ()
7775 return x_error_message != 0;
7778 #if 0
7779 static unsigned int x_wire_count;
7780 x_trace_wire ()
7782 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7784 #endif /* ! 0 */
7787 /* Handle SIGPIPE, which can happen when the connection to a server
7788 simply goes away. SIGPIPE is handled by x_connection_signal.
7789 Don't need to do anything, because the write which caused the
7790 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7791 which will do the appropriate cleanup for us. */
7793 static SIGTYPE
7794 x_connection_signal (signalnum) /* If we don't have an argument, */
7795 int signalnum; /* some compilers complain in signal calls. */
7797 #ifdef USG
7798 /* USG systems forget handlers when they are used;
7799 must reestablish each time */
7800 signal (signalnum, x_connection_signal);
7801 #endif /* USG */
7805 /************************************************************************
7806 Handling X errors
7807 ************************************************************************/
7809 /* Error message passed to x_connection_closed. */
7811 static char *error_msg;
7813 /* Function installed as fatal_error_signal_hook in
7814 x_connection_closed. Print the X error message, and exit normally,
7815 instead of dumping core when XtCloseDisplay fails. */
7817 static void
7818 x_fatal_error_signal ()
7820 fprintf (stderr, "%s\n", error_msg);
7821 exit (70);
7824 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7825 the text of an error message that lead to the connection loss. */
7827 static SIGTYPE
7828 x_connection_closed (dpy, error_message)
7829 Display *dpy;
7830 char *error_message;
7832 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7833 Lisp_Object frame, tail;
7834 int index = SPECPDL_INDEX ();
7836 error_msg = (char *) alloca (strlen (error_message) + 1);
7837 strcpy (error_msg, error_message);
7838 handling_signal = 0;
7840 /* Prevent being called recursively because of an error condition
7841 below. Otherwise, we might end up with printing ``can't find per
7842 display information'' in the recursive call instead of printing
7843 the original message here. */
7844 x_catch_errors (dpy);
7846 /* Inhibit redisplay while frames are being deleted. */
7847 specbind (Qinhibit_redisplay, Qt);
7849 if (dpyinfo)
7851 /* Protect display from being closed when we delete the last
7852 frame on it. */
7853 dpyinfo->reference_count++;
7854 dpyinfo->terminal->reference_count++;
7857 /* First delete frames whose mini-buffers are on frames
7858 that are on the dead display. */
7859 FOR_EACH_FRAME (tail, frame)
7861 Lisp_Object minibuf_frame;
7862 minibuf_frame
7863 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7864 if (FRAME_X_P (XFRAME (frame))
7865 && FRAME_X_P (XFRAME (minibuf_frame))
7866 && ! EQ (frame, minibuf_frame)
7867 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7868 Fdelete_frame (frame, Qnoelisp);
7871 /* Now delete all remaining frames on the dead display.
7872 We are now sure none of these is used as the mini-buffer
7873 for another frame that we need to delete. */
7874 FOR_EACH_FRAME (tail, frame)
7875 if (FRAME_X_P (XFRAME (frame))
7876 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7878 /* Set this to t so that Fdelete_frame won't get confused
7879 trying to find a replacement. */
7880 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7881 Fdelete_frame (frame, Qnoelisp);
7884 /* We have to close the display to inform Xt that it doesn't
7885 exist anymore. If we don't, Xt will continue to wait for
7886 events from the display. As a consequence, a sequence of
7888 M-x make-frame-on-display RET :1 RET
7889 ...kill the new frame, so that we get an IO error...
7890 M-x make-frame-on-display RET :1 RET
7892 will indefinitely wait in Xt for events for display `:1', opened
7893 in the first call to make-frame-on-display.
7895 Closing the display is reported to lead to a bus error on
7896 OpenWindows in certain situations. I suspect that is a bug
7897 in OpenWindows. I don't know how to circumvent it here. */
7899 if (dpyinfo)
7901 #ifdef USE_X_TOOLKIT
7902 /* If DPYINFO is null, this means we didn't open the display
7903 in the first place, so don't try to close it. */
7905 extern void (*fatal_error_signal_hook) P_ ((void));
7906 fatal_error_signal_hook = x_fatal_error_signal;
7907 XtCloseDisplay (dpy);
7908 fatal_error_signal_hook = NULL;
7910 #endif
7912 #ifdef USE_GTK
7913 /* Due to bugs in some Gtk+ versions, just exit here if this
7914 is the last display/terminal. */
7915 if (terminal_list->next_terminal == NULL)
7917 fprintf (stderr, "%s\n", error_msg);
7918 shut_down_emacs (0, 0, Qnil);
7919 exit (70);
7921 xg_display_close (dpyinfo->display);
7922 #endif
7924 /* Indicate that this display is dead. */
7925 dpyinfo->display = 0;
7927 dpyinfo->reference_count--;
7928 dpyinfo->terminal->reference_count--;
7929 if (dpyinfo->reference_count != 0)
7930 /* We have just closed all frames on this display. */
7931 abort ();
7934 Lisp_Object tmp;
7935 XSETTERMINAL (tmp, dpyinfo->terminal);
7936 Fdelete_terminal (tmp, Qnoelisp);
7940 x_uncatch_errors ();
7942 if (terminal_list == 0)
7944 fprintf (stderr, "%s\n", error_msg);
7945 shut_down_emacs (0, 0, Qnil);
7946 exit (70);
7949 /* Ordinary stack unwind doesn't deal with these. */
7950 #ifdef SIGIO
7951 sigunblock (sigmask (SIGIO));
7952 #endif
7953 sigunblock (sigmask (SIGALRM));
7954 TOTALLY_UNBLOCK_INPUT;
7956 unbind_to (index, Qnil);
7957 clear_waiting_for_input ();
7958 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7959 longjmp), because returning from this function would get us back into
7960 Xlib's code which will directly call `exit'. */
7961 error ("%s", error_msg);
7964 /* We specifically use it before defining it, so that gcc doesn't inline it,
7965 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7966 static void x_error_quitter P_ ((Display *, XErrorEvent *));
7968 /* This is the first-level handler for X protocol errors.
7969 It calls x_error_quitter or x_error_catcher. */
7971 static int
7972 x_error_handler (display, error)
7973 Display *display;
7974 XErrorEvent *error;
7976 if (x_error_message)
7977 x_error_catcher (display, error);
7978 else
7979 x_error_quitter (display, error);
7980 return 0;
7983 /* This is the usual handler for X protocol errors.
7984 It kills all frames on the display that we got the error for.
7985 If that was the only one, it prints an error message and kills Emacs. */
7987 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7989 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7990 #define NO_INLINE __attribute__((noinline))
7991 #else
7992 #define NO_INLINE
7993 #endif
7995 /* Some versions of GNU/Linux define noinline in their headers. */
7997 #ifdef noinline
7998 #undef noinline
7999 #endif
8001 /* On older GCC versions, just putting x_error_quitter
8002 after x_error_handler prevents inlining into the former. */
8004 static void NO_INLINE
8005 x_error_quitter (display, error)
8006 Display *display;
8007 XErrorEvent *error;
8009 char buf[256], buf1[356];
8011 /* Ignore BadName errors. They can happen because of fonts
8012 or colors that are not defined. */
8014 if (error->error_code == BadName)
8015 return;
8017 /* Note that there is no real way portable across R3/R4 to get the
8018 original error handler. */
8020 XGetErrorText (display, error->error_code, buf, sizeof (buf));
8021 sprintf (buf1, "X protocol error: %s on protocol request %d",
8022 buf, error->request_code);
8023 x_connection_closed (display, buf1);
8027 /* This is the handler for X IO errors, always.
8028 It kills all frames on the display that we lost touch with.
8029 If that was the only one, it prints an error message and kills Emacs. */
8031 static int
8032 x_io_error_quitter (display)
8033 Display *display;
8035 char buf[256];
8037 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
8038 x_connection_closed (display, buf);
8039 return 0;
8042 /* Changing the font of the frame. */
8044 /* Give frame F the font FONT-OBJECT as its default font. The return
8045 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
8046 frame. If it is negative, generate a new fontset from
8047 FONT-OBJECT. */
8049 Lisp_Object
8050 x_new_font (f, font_object, fontset)
8051 struct frame *f;
8052 Lisp_Object font_object;
8053 int fontset;
8055 struct font *font = XFONT_OBJECT (font_object);
8057 if (fontset < 0)
8058 fontset = fontset_from_font (font_object);
8059 FRAME_FONTSET (f) = fontset;
8060 if (FRAME_FONT (f) == font)
8061 /* This font is already set in frame F. There's nothing more to
8062 do. */
8063 return font_object;
8065 FRAME_FONT (f) = font;
8066 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
8067 FRAME_COLUMN_WIDTH (f) = font->average_width;
8068 FRAME_SPACE_WIDTH (f) = font->space_width;
8069 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
8071 compute_fringe_widths (f, 1);
8073 /* Compute the scroll bar width in character columns. */
8074 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
8076 int wid = FRAME_COLUMN_WIDTH (f);
8077 FRAME_CONFIG_SCROLL_BAR_COLS (f)
8078 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
8080 else
8082 int wid = FRAME_COLUMN_WIDTH (f);
8083 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
8086 if (FRAME_X_WINDOW (f) != 0)
8088 /* Don't change the size of a tip frame; there's no point in
8089 doing it because it's done in Fx_show_tip, and it leads to
8090 problems because the tip frame has no widget. */
8091 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8092 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
8095 #ifdef HAVE_X_I18N
8096 if (FRAME_XIC (f)
8097 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
8099 BLOCK_INPUT;
8100 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
8101 UNBLOCK_INPUT;
8103 #endif
8105 return font_object;
8109 /***********************************************************************
8110 X Input Methods
8111 ***********************************************************************/
8113 #ifdef HAVE_X_I18N
8115 #ifdef HAVE_X11R6
8117 /* XIM destroy callback function, which is called whenever the
8118 connection to input method XIM dies. CLIENT_DATA contains a
8119 pointer to the x_display_info structure corresponding to XIM. */
8121 static void
8122 xim_destroy_callback (xim, client_data, call_data)
8123 XIM xim;
8124 XPointer client_data;
8125 XPointer call_data;
8127 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8128 Lisp_Object frame, tail;
8130 BLOCK_INPUT;
8132 /* No need to call XDestroyIC.. */
8133 FOR_EACH_FRAME (tail, frame)
8135 struct frame *f = XFRAME (frame);
8136 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8138 FRAME_XIC (f) = NULL;
8139 xic_free_xfontset (f);
8143 /* No need to call XCloseIM. */
8144 dpyinfo->xim = NULL;
8145 XFree (dpyinfo->xim_styles);
8146 UNBLOCK_INPUT;
8149 #endif /* HAVE_X11R6 */
8151 #ifdef HAVE_X11R6
8152 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8153 extern char *XSetIMValues P_ ((XIM, ...));
8154 #endif
8156 /* Open the connection to the XIM server on display DPYINFO.
8157 RESOURCE_NAME is the resource name Emacs uses. */
8159 static void
8160 xim_open_dpy (dpyinfo, resource_name)
8161 struct x_display_info *dpyinfo;
8162 char *resource_name;
8164 XIM xim;
8166 #ifdef HAVE_XIM
8167 if (use_xim)
8169 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8170 EMACS_CLASS);
8171 dpyinfo->xim = xim;
8173 if (xim)
8175 #ifdef HAVE_X11R6
8176 XIMCallback destroy;
8177 #endif
8179 /* Get supported styles and XIM values. */
8180 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8182 #ifdef HAVE_X11R6
8183 destroy.callback = xim_destroy_callback;
8184 destroy.client_data = (XPointer)dpyinfo;
8185 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8186 #endif
8190 else
8191 #endif /* HAVE_XIM */
8192 dpyinfo->xim = NULL;
8196 #ifdef HAVE_X11R6_XIM
8198 struct xim_inst_t
8200 struct x_display_info *dpyinfo;
8201 char *resource_name;
8204 /* XIM instantiate callback function, which is called whenever an XIM
8205 server is available. DISPLAY is the display of the XIM.
8206 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8207 when the callback was registered. */
8209 static void
8210 xim_instantiate_callback (display, client_data, call_data)
8211 Display *display;
8212 XPointer client_data;
8213 XPointer call_data;
8215 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8216 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8218 /* We don't support multiple XIM connections. */
8219 if (dpyinfo->xim)
8220 return;
8222 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8224 /* Create XIC for the existing frames on the same display, as long
8225 as they have no XIC. */
8226 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8228 Lisp_Object tail, frame;
8230 BLOCK_INPUT;
8231 FOR_EACH_FRAME (tail, frame)
8233 struct frame *f = XFRAME (frame);
8235 if (FRAME_X_P (f)
8236 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8237 if (FRAME_XIC (f) == NULL)
8239 create_frame_xic (f);
8240 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8241 xic_set_statusarea (f);
8242 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8244 struct window *w = XWINDOW (f->selected_window);
8245 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8250 UNBLOCK_INPUT;
8254 #endif /* HAVE_X11R6_XIM */
8257 /* Open a connection to the XIM server on display DPYINFO.
8258 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8259 connection only at the first time. On X11R6, open the connection
8260 in the XIM instantiate callback function. */
8262 static void
8263 xim_initialize (dpyinfo, resource_name)
8264 struct x_display_info *dpyinfo;
8265 char *resource_name;
8267 #ifdef HAVE_XIM
8268 if (use_xim)
8270 #ifdef HAVE_X11R6_XIM
8271 struct xim_inst_t *xim_inst;
8272 int len;
8274 dpyinfo->xim = NULL;
8275 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8276 xim_inst->dpyinfo = dpyinfo;
8277 len = strlen (resource_name);
8278 xim_inst->resource_name = (char *) xmalloc (len + 1);
8279 bcopy (resource_name, xim_inst->resource_name, len + 1);
8280 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8281 resource_name, EMACS_CLASS,
8282 xim_instantiate_callback,
8283 /* This is XPointer in XFree86
8284 but (XPointer *) on Tru64, at
8285 least, hence the configure test. */
8286 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8287 #else /* not HAVE_X11R6_XIM */
8288 dpyinfo->xim = NULL;
8289 xim_open_dpy (dpyinfo, resource_name);
8290 #endif /* not HAVE_X11R6_XIM */
8293 else
8294 #endif /* HAVE_XIM */
8295 dpyinfo->xim = NULL;
8299 /* Close the connection to the XIM server on display DPYINFO. */
8301 static void
8302 xim_close_dpy (dpyinfo)
8303 struct x_display_info *dpyinfo;
8305 #ifdef HAVE_XIM
8306 if (use_xim)
8308 #ifdef HAVE_X11R6_XIM
8309 if (dpyinfo->display)
8310 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8311 NULL, EMACS_CLASS,
8312 xim_instantiate_callback, NULL);
8313 #endif /* not HAVE_X11R6_XIM */
8314 if (dpyinfo->display)
8315 XCloseIM (dpyinfo->xim);
8316 dpyinfo->xim = NULL;
8317 XFree (dpyinfo->xim_styles);
8319 #endif /* HAVE_XIM */
8322 #endif /* not HAVE_X11R6_XIM */
8326 /* Calculate the absolute position in frame F
8327 from its current recorded position values and gravity. */
8329 void
8330 x_calc_absolute_position (f)
8331 struct frame *f;
8333 int flags = f->size_hint_flags;
8335 /* We have nothing to do if the current position
8336 is already for the top-left corner. */
8337 if (! ((flags & XNegative) || (flags & YNegative)))
8338 return;
8340 /* Treat negative positions as relative to the leftmost bottommost
8341 position that fits on the screen. */
8342 if (flags & XNegative)
8343 f->left_pos = (FRAME_X_DISPLAY_INFO (f)->width
8344 - FRAME_PIXEL_WIDTH (f) + f->left_pos);
8347 int height = FRAME_PIXEL_HEIGHT (f);
8349 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8350 /* Something is fishy here. When using Motif, starting Emacs with
8351 `-g -0-0', the frame appears too low by a few pixels.
8353 This seems to be so because initially, while Emacs is starting,
8354 the column widget's height and the frame's pixel height are
8355 different. The column widget's height is the right one. In
8356 later invocations, when Emacs is up, the frame's pixel height
8357 is right, though.
8359 It's not obvious where the initial small difference comes from.
8360 2000-12-01, gerd. */
8362 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8363 #endif
8365 if (flags & YNegative)
8366 f->top_pos = (FRAME_X_DISPLAY_INFO (f)->height - height + f->top_pos);
8369 /* The left_pos and top_pos
8370 are now relative to the top and left screen edges,
8371 so the flags should correspond. */
8372 f->size_hint_flags &= ~ (XNegative | YNegative);
8375 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8376 to really change the position, and 0 when calling from
8377 x_make_frame_visible (in that case, XOFF and YOFF are the current
8378 position values). It is -1 when calling from x_set_frame_parameters,
8379 which means, do adjust for borders but don't change the gravity. */
8381 void
8382 x_set_offset (f, xoff, yoff, change_gravity)
8383 struct frame *f;
8384 register int xoff, yoff;
8385 int change_gravity;
8387 int modified_top, modified_left;
8389 if (change_gravity > 0)
8391 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8392 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8394 f->top_pos = yoff;
8395 f->left_pos = xoff;
8396 f->size_hint_flags &= ~ (XNegative | YNegative);
8397 if (xoff < 0)
8398 f->size_hint_flags |= XNegative;
8399 if (yoff < 0)
8400 f->size_hint_flags |= YNegative;
8401 f->win_gravity = NorthWestGravity;
8403 x_calc_absolute_position (f);
8405 BLOCK_INPUT;
8406 x_wm_set_size_hint (f, (long) 0, 0);
8408 modified_left = f->left_pos;
8409 modified_top = f->top_pos;
8411 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8413 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8414 than the WM decorations. So we use the calculated offset instead
8415 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8416 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8417 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8420 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8421 modified_left, modified_top);
8423 x_sync_with_move (f, f->left_pos, f->top_pos,
8424 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8425 ? 1 : 0);
8427 /* change_gravity is non-zero when this function is called from Lisp to
8428 programmatically move a frame. In that case, we call
8429 x_check_expected_move to discover if we have a "Type A" or "Type B"
8430 window manager, and, for a "Type A" window manager, adjust the position
8431 of the frame.
8433 We call x_check_expected_move if a programmatic move occurred, and
8434 either the window manager type (A/B) is unknown or it is Type A but we
8435 need to compute the top/left offset adjustment for this frame. */
8437 if (change_gravity != 0 &&
8438 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8439 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8440 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8441 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8442 x_check_expected_move (f, modified_left, modified_top);
8444 UNBLOCK_INPUT;
8447 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8448 on the root window for frame F contains ATOMNAME.
8449 This is how a WM check shall be done according to the Window Manager
8450 Specification/Extended Window Manager Hints at
8451 http://freedesktop.org/wiki/Specifications/wm-spec. */
8453 static int
8454 wm_supports (f, atomname)
8455 struct frame *f;
8456 const char *atomname;
8458 Atom actual_type;
8459 unsigned long actual_size, bytes_remaining;
8460 int i, rc, actual_format;
8461 Atom prop_atom;
8462 Window wmcheck_window;
8463 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8464 Window target_window = dpyinfo->root_window;
8465 long max_len = 65536;
8466 Display *dpy = FRAME_X_DISPLAY (f);
8467 unsigned char *tmp_data = NULL;
8468 Atom target_type = XA_WINDOW;
8469 Atom want_atom;
8471 BLOCK_INPUT;
8473 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8475 x_catch_errors (dpy);
8476 rc = XGetWindowProperty (dpy, target_window,
8477 prop_atom, 0, max_len, False, target_type,
8478 &actual_type, &actual_format, &actual_size,
8479 &bytes_remaining, &tmp_data);
8481 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8483 if (tmp_data) XFree (tmp_data);
8484 x_uncatch_errors ();
8485 UNBLOCK_INPUT;
8486 return 0;
8489 wmcheck_window = *(Window *) tmp_data;
8490 XFree (tmp_data);
8492 /* Check if window exists. */
8493 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8494 x_sync (f);
8495 if (x_had_errors_p (dpy))
8497 x_uncatch_errors ();
8498 UNBLOCK_INPUT;
8499 return 0;
8502 if (dpyinfo->net_supported_window != wmcheck_window)
8504 /* Window changed, reload atoms */
8505 if (dpyinfo->net_supported_atoms != NULL)
8506 XFree (dpyinfo->net_supported_atoms);
8507 dpyinfo->net_supported_atoms = NULL;
8508 dpyinfo->nr_net_supported_atoms = 0;
8509 dpyinfo->net_supported_window = 0;
8511 target_type = XA_ATOM;
8512 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8513 tmp_data = NULL;
8514 rc = XGetWindowProperty (dpy, target_window,
8515 prop_atom, 0, max_len, False, target_type,
8516 &actual_type, &actual_format, &actual_size,
8517 &bytes_remaining, &tmp_data);
8519 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8521 if (tmp_data) XFree (tmp_data);
8522 x_uncatch_errors ();
8523 UNBLOCK_INPUT;
8524 return 0;
8527 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8528 dpyinfo->nr_net_supported_atoms = actual_size;
8529 dpyinfo->net_supported_window = wmcheck_window;
8532 rc = 0;
8533 want_atom = XInternAtom (dpy, atomname, False);
8535 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8536 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8538 x_uncatch_errors ();
8539 UNBLOCK_INPUT;
8541 return rc;
8544 /* Do fullscreen as specified in extended window manager hints */
8546 static int
8547 do_ewmh_fullscreen (f)
8548 struct frame *f;
8550 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8552 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8553 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8554 if (!have_net_atom)
8555 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8557 if (have_net_atom)
8559 Lisp_Object frame;
8560 const char *atom = "_NET_WM_STATE";
8561 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8562 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8563 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8564 const char *what = NULL;
8566 XSETFRAME (frame, f);
8568 /* If there are _NET_ atoms we assume we have extended window manager
8569 hints. */
8570 switch (f->want_fullscreen)
8572 case FULLSCREEN_BOTH:
8573 what = fs;
8574 break;
8575 case FULLSCREEN_WIDTH:
8576 what = fw;
8577 break;
8578 case FULLSCREEN_HEIGHT:
8579 what = fh;
8580 break;
8583 if (what != NULL && !wm_supports (f, what)) return 0;
8586 Fx_send_client_event (frame, make_number (0), frame,
8587 make_unibyte_string (atom, strlen (atom)),
8588 make_number (32),
8589 Fcons (make_number (0), /* Remove */
8590 Fcons
8591 (make_unibyte_string (fs,
8592 strlen (fs)),
8593 Qnil)));
8594 Fx_send_client_event (frame, make_number (0), frame,
8595 make_unibyte_string (atom, strlen (atom)),
8596 make_number (32),
8597 Fcons (make_number (0), /* Remove */
8598 Fcons
8599 (make_unibyte_string (fh,
8600 strlen (fh)),
8601 Qnil)));
8602 Fx_send_client_event (frame, make_number (0), frame,
8603 make_unibyte_string (atom, strlen (atom)),
8604 make_number (32),
8605 Fcons (make_number (0), /* Remove */
8606 Fcons
8607 (make_unibyte_string (fw,
8608 strlen (fw)),
8609 Qnil)));
8610 f->want_fullscreen = FULLSCREEN_NONE;
8611 if (what != NULL)
8612 Fx_send_client_event (frame, make_number (0), frame,
8613 make_unibyte_string (atom, strlen (atom)),
8614 make_number (32),
8615 Fcons (make_number (1), /* Add */
8616 Fcons
8617 (make_unibyte_string (what,
8618 strlen (what)),
8619 Qnil)));
8622 return have_net_atom;
8625 static void
8626 XTfullscreen_hook (f)
8627 FRAME_PTR f;
8629 if (f->async_visible)
8631 BLOCK_INPUT;
8632 do_ewmh_fullscreen (f);
8633 x_sync (f);
8634 UNBLOCK_INPUT;
8639 /* Check if we need to resize the frame due to a fullscreen request.
8640 If so needed, resize the frame. */
8641 static void
8642 x_check_fullscreen (f)
8643 struct frame *f;
8645 if (f->want_fullscreen & FULLSCREEN_BOTH)
8647 int width, height, ign;
8649 if (do_ewmh_fullscreen (f))
8650 return;
8652 x_real_positions (f, &f->left_pos, &f->top_pos);
8654 x_fullscreen_adjust (f, &width, &height, &ign, &ign);
8656 /* We do not need to move the window, it shall be taken care of
8657 when setting WM manager hints.
8658 If the frame is visible already, the position is checked by
8659 x_check_expected_move. */
8660 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8662 change_frame_size (f, height, width, 0, 1, 0);
8663 SET_FRAME_GARBAGED (f);
8664 cancel_mouse_face (f);
8666 /* Wait for the change of frame size to occur */
8667 f->want_fullscreen |= FULLSCREEN_WAIT;
8672 /* This function is called by x_set_offset to determine whether the window
8673 manager interfered with the positioning of the frame. Type A window
8674 managers position the surrounding window manager decorations a small
8675 amount above and left of the user-supplied position. Type B window
8676 managers position the surrounding window manager decorations at the
8677 user-specified position. If we detect a Type A window manager, we
8678 compensate by moving the window right and down by the proper amount. */
8680 static void
8681 x_check_expected_move (f, expected_left, expected_top)
8682 struct frame *f;
8683 int expected_left;
8684 int expected_top;
8686 int current_left = 0, current_top = 0;
8688 /* x_real_positions returns the left and top offsets of the outermost
8689 window manager window around the frame. */
8691 x_real_positions (f, &current_left, &current_top);
8693 if (current_left != expected_left || current_top != expected_top)
8695 /* It's a "Type A" window manager. */
8697 int adjusted_left;
8698 int adjusted_top;
8700 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8701 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8702 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8704 /* Now fix the mispositioned frame's location. */
8706 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8707 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8709 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8710 adjusted_left, adjusted_top);
8712 x_sync_with_move (f, expected_left, expected_top, 0);
8714 else
8715 /* It's a "Type B" window manager. We don't have to adjust the
8716 frame's position. */
8718 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8722 /* Wait for XGetGeometry to return up-to-date position information for a
8723 recently-moved frame. Call this immediately after calling XMoveWindow.
8724 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8725 frame has been moved to, so we use a fuzzy position comparison instead
8726 of an exact comparison. */
8728 static void
8729 x_sync_with_move (f, left, top, fuzzy)
8730 struct frame *f;
8731 int left, top, fuzzy;
8733 int count = 0;
8735 while (count++ < 50)
8737 int current_left = 0, current_top = 0;
8739 /* In theory, this call to XSync only needs to happen once, but in
8740 practice, it doesn't seem to work, hence the need for the surrounding
8741 loop. */
8743 XSync (FRAME_X_DISPLAY (f), False);
8744 x_real_positions (f, &current_left, &current_top);
8746 if (fuzzy)
8748 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8749 pixels. */
8751 if (eabs (current_left - left) <= 10
8752 && eabs (current_top - top) <= 40)
8753 return;
8755 else if (current_left == left && current_top == top)
8756 return;
8759 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8760 will then return up-to-date position info. */
8762 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8766 /* Change the size of frame F's X window to COLS/ROWS in the case F
8767 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8768 top-left-corner window gravity for this size change and subsequent
8769 size changes. Otherwise we leave the window gravity unchanged. */
8771 static void
8772 x_set_window_size_1 (f, change_gravity, cols, rows)
8773 struct frame *f;
8774 int change_gravity;
8775 int cols, rows;
8777 int pixelwidth, pixelheight;
8779 check_frame_size (f, &rows, &cols);
8780 f->scroll_bar_actual_width
8781 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8783 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8784 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8785 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8787 compute_fringe_widths (f, 0);
8789 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8790 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
8792 f->win_gravity = NorthWestGravity;
8793 x_wm_set_size_hint (f, (long) 0, 0);
8795 XSync (FRAME_X_DISPLAY (f), False);
8796 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8797 pixelwidth, pixelheight);
8799 /* Now, strictly speaking, we can't be sure that this is accurate,
8800 but the window manager will get around to dealing with the size
8801 change request eventually, and we'll hear how it went when the
8802 ConfigureNotify event gets here.
8804 We could just not bother storing any of this information here,
8805 and let the ConfigureNotify event set everything up, but that
8806 might be kind of confusing to the Lisp code, since size changes
8807 wouldn't be reported in the frame parameters until some random
8808 point in the future when the ConfigureNotify event arrives.
8810 We pass 1 for DELAY since we can't run Lisp code inside of
8811 a BLOCK_INPUT. */
8812 change_frame_size (f, rows, cols, 0, 1, 0);
8813 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8814 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8816 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8817 receive in the ConfigureNotify event; if we get what we asked
8818 for, then the event won't cause the screen to become garbaged, so
8819 we have to make sure to do it here. */
8820 SET_FRAME_GARBAGED (f);
8822 XFlush (FRAME_X_DISPLAY (f));
8826 /* Call this to change the size of frame F's x-window.
8827 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8828 for this size change and subsequent size changes.
8829 Otherwise we leave the window gravity unchanged. */
8831 void
8832 x_set_window_size (f, change_gravity, cols, rows)
8833 struct frame *f;
8834 int change_gravity;
8835 int cols, rows;
8837 BLOCK_INPUT;
8839 #ifdef USE_GTK
8840 if (FRAME_GTK_WIDGET (f))
8841 xg_frame_set_char_size (f, cols, rows);
8842 else
8843 x_set_window_size_1 (f, change_gravity, cols, rows);
8844 #elif USE_X_TOOLKIT
8846 if (f->output_data.x->widget != NULL)
8848 /* The x and y position of the widget is clobbered by the
8849 call to XtSetValues within EmacsFrameSetCharSize.
8850 This is a real kludge, but I don't understand Xt so I can't
8851 figure out a correct fix. Can anyone else tell me? -- rms. */
8852 int xpos = f->output_data.x->widget->core.x;
8853 int ypos = f->output_data.x->widget->core.y;
8854 EmacsFrameSetCharSize (f->output_data.x->edit_widget, cols, rows);
8855 f->output_data.x->widget->core.x = xpos;
8856 f->output_data.x->widget->core.y = ypos;
8858 else
8859 x_set_window_size_1 (f, change_gravity, cols, rows);
8861 #else /* not USE_X_TOOLKIT */
8863 x_set_window_size_1 (f, change_gravity, cols, rows);
8865 #endif /* not USE_X_TOOLKIT */
8867 /* If cursor was outside the new size, mark it as off. */
8868 mark_window_cursors_off (XWINDOW (f->root_window));
8870 /* Clear out any recollection of where the mouse highlighting was,
8871 since it might be in a place that's outside the new frame size.
8872 Actually checking whether it is outside is a pain in the neck,
8873 so don't try--just let the highlighting be done afresh with new size. */
8874 cancel_mouse_face (f);
8876 UNBLOCK_INPUT;
8879 /* Mouse warping. */
8881 void
8882 x_set_mouse_position (f, x, y)
8883 struct frame *f;
8884 int x, y;
8886 int pix_x, pix_y;
8888 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8889 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8891 if (pix_x < 0) pix_x = 0;
8892 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8894 if (pix_y < 0) pix_y = 0;
8895 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8897 BLOCK_INPUT;
8899 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8900 0, 0, 0, 0, pix_x, pix_y);
8901 UNBLOCK_INPUT;
8904 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8906 void
8907 x_set_mouse_pixel_position (f, pix_x, pix_y)
8908 struct frame *f;
8909 int pix_x, pix_y;
8911 BLOCK_INPUT;
8913 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8914 0, 0, 0, 0, pix_x, pix_y);
8915 UNBLOCK_INPUT;
8918 /* focus shifting, raising and lowering. */
8920 void
8921 x_focus_on_frame (f)
8922 struct frame *f;
8924 #if 0 /* This proves to be unpleasant. */
8925 x_raise_frame (f);
8926 #endif
8927 #if 0
8928 /* I don't think that the ICCCM allows programs to do things like this
8929 without the interaction of the window manager. Whatever you end up
8930 doing with this code, do it to x_unfocus_frame too. */
8931 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8932 RevertToPointerRoot, CurrentTime);
8933 #endif /* ! 0 */
8936 void
8937 x_unfocus_frame (f)
8938 struct frame *f;
8940 #if 0
8941 /* Look at the remarks in x_focus_on_frame. */
8942 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8943 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8944 RevertToPointerRoot, CurrentTime);
8945 #endif /* ! 0 */
8948 /* Raise frame F. */
8950 void
8951 x_raise_frame (f)
8952 struct frame *f;
8954 BLOCK_INPUT;
8955 if (f->async_visible)
8956 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8958 XFlush (FRAME_X_DISPLAY (f));
8959 UNBLOCK_INPUT;
8962 /* Lower frame F. */
8964 void
8965 x_lower_frame (f)
8966 struct frame *f;
8968 if (f->async_visible)
8970 BLOCK_INPUT;
8971 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8972 XFlush (FRAME_X_DISPLAY (f));
8973 UNBLOCK_INPUT;
8977 /* Activate frame with Extended Window Manager Hints */
8979 void
8980 x_ewmh_activate_frame (f)
8981 FRAME_PTR f;
8983 /* See Window Manager Specification/Extended Window Manager Hints at
8984 http://freedesktop.org/wiki/Specifications/wm-spec */
8986 const char *atom = "_NET_ACTIVE_WINDOW";
8987 if (f->async_visible && wm_supports (f, atom))
8989 Lisp_Object frame;
8990 XSETFRAME (frame, f);
8991 Fx_send_client_event (frame, make_number (0), frame,
8992 make_unibyte_string (atom, strlen (atom)),
8993 make_number (32),
8994 Fcons (make_number (1),
8995 Fcons (make_number (last_user_time),
8996 Qnil)));
9000 static void
9001 XTframe_raise_lower (f, raise_flag)
9002 FRAME_PTR f;
9003 int raise_flag;
9005 if (raise_flag)
9006 x_raise_frame (f);
9007 else
9008 x_lower_frame (f);
9011 /* XEmbed implementation. */
9013 void
9014 xembed_set_info (f, flags)
9015 struct frame *f;
9016 enum xembed_info flags;
9018 Atom atom;
9019 unsigned long data[2];
9021 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
9023 data[0] = XEMBED_VERSION;
9024 data[1] = flags;
9026 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
9027 32, PropModeReplace, (unsigned char *) data, 2);
9030 void
9031 xembed_send_message (f, time, message, detail, data1, data2)
9032 struct frame *f;
9033 Time time;
9034 enum xembed_message message;
9035 long detail;
9036 long data1;
9037 long data2;
9039 XEvent event;
9041 event.xclient.type = ClientMessage;
9042 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9043 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9044 event.xclient.format = 32;
9045 event.xclient.data.l[0] = time;
9046 event.xclient.data.l[1] = message;
9047 event.xclient.data.l[2] = detail;
9048 event.xclient.data.l[3] = data1;
9049 event.xclient.data.l[4] = data2;
9051 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9052 False, NoEventMask, &event);
9053 XSync (FRAME_X_DISPLAY (f), False);
9056 /* Change of visibility. */
9058 /* This tries to wait until the frame is really visible.
9059 However, if the window manager asks the user where to position
9060 the frame, this will return before the user finishes doing that.
9061 The frame will not actually be visible at that time,
9062 but it will become visible later when the window manager
9063 finishes with it. */
9065 void
9066 x_make_frame_visible (f)
9067 struct frame *f;
9069 Lisp_Object type;
9070 int original_top, original_left;
9071 int retry_count = 2;
9073 retry:
9075 BLOCK_INPUT;
9077 type = x_icon_type (f);
9078 if (!NILP (type))
9079 x_bitmap_icon (f, type);
9081 if (! FRAME_VISIBLE_P (f))
9083 /* We test FRAME_GARBAGED_P here to make sure we don't
9084 call x_set_offset a second time
9085 if we get to x_make_frame_visible a second time
9086 before the window gets really visible. */
9087 if (! FRAME_ICONIFIED_P (f)
9088 && ! FRAME_X_EMBEDDED_P (f)
9089 && ! f->output_data.x->asked_for_visible)
9090 x_set_offset (f, f->left_pos, f->top_pos, 0);
9092 f->output_data.x->asked_for_visible = 1;
9094 if (! EQ (Vx_no_window_manager, Qt))
9095 x_wm_set_window_state (f, NormalState);
9096 #ifdef USE_X_TOOLKIT
9097 if (FRAME_X_EMBEDDED_P (f))
9098 xembed_set_info (f, XEMBED_MAPPED);
9099 else
9101 /* This was XtPopup, but that did nothing for an iconified frame. */
9102 XtMapWidget (f->output_data.x->widget);
9104 #else /* not USE_X_TOOLKIT */
9105 #ifdef USE_GTK
9106 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9107 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9108 #else
9109 if (FRAME_X_EMBEDDED_P (f))
9110 xembed_set_info (f, XEMBED_MAPPED);
9111 else
9112 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9113 #endif /* not USE_GTK */
9114 #endif /* not USE_X_TOOLKIT */
9115 #if 0 /* This seems to bring back scroll bars in the wrong places
9116 if the window configuration has changed. They seem
9117 to come back ok without this. */
9118 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
9119 XMapSubwindows (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9120 #endif
9123 XFlush (FRAME_X_DISPLAY (f));
9125 /* Synchronize to ensure Emacs knows the frame is visible
9126 before we do anything else. We do this loop with input not blocked
9127 so that incoming events are handled. */
9129 Lisp_Object frame;
9130 int count;
9131 /* This must be before UNBLOCK_INPUT
9132 since events that arrive in response to the actions above
9133 will set it when they are handled. */
9134 int previously_visible = f->output_data.x->has_been_visible;
9136 original_left = f->left_pos;
9137 original_top = f->top_pos;
9139 /* This must come after we set COUNT. */
9140 UNBLOCK_INPUT;
9142 /* We unblock here so that arriving X events are processed. */
9144 /* Now move the window back to where it was "supposed to be".
9145 But don't do it if the gravity is negative.
9146 When the gravity is negative, this uses a position
9147 that is 3 pixels too low. Perhaps that's really the border width.
9149 Don't do this if the window has never been visible before,
9150 because the window manager may choose the position
9151 and we don't want to override it. */
9153 if (! FRAME_VISIBLE_P (f)
9154 && ! FRAME_ICONIFIED_P (f)
9155 && ! FRAME_X_EMBEDDED_P (f)
9156 && f->win_gravity == NorthWestGravity
9157 && previously_visible)
9159 Drawable rootw;
9160 int x, y;
9161 unsigned int width, height, border, depth;
9163 BLOCK_INPUT;
9165 /* On some window managers (such as FVWM) moving an existing
9166 window, even to the same place, causes the window manager
9167 to introduce an offset. This can cause the window to move
9168 to an unexpected location. Check the geometry (a little
9169 slow here) and then verify that the window is in the right
9170 place. If the window is not in the right place, move it
9171 there, and take the potential window manager hit. */
9172 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9173 &rootw, &x, &y, &width, &height, &border, &depth);
9175 if (original_left != x || original_top != y)
9176 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9177 original_left, original_top);
9179 UNBLOCK_INPUT;
9182 XSETFRAME (frame, f);
9184 /* Wait until the frame is visible. Process X events until a
9185 MapNotify event has been seen, or until we think we won't get a
9186 MapNotify at all.. */
9187 for (count = input_signal_count + 10;
9188 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9190 /* Force processing of queued events. */
9191 x_sync (f);
9193 /* Machines that do polling rather than SIGIO have been
9194 observed to go into a busy-wait here. So we'll fake an
9195 alarm signal to let the handler know that there's something
9196 to be read. We used to raise a real alarm, but it seems
9197 that the handler isn't always enabled here. This is
9198 probably a bug. */
9199 if (input_polling_used ())
9201 /* It could be confusing if a real alarm arrives while
9202 processing the fake one. Turn it off and let the
9203 handler reset it. */
9204 extern void poll_for_input_1 P_ ((void));
9205 int old_poll_suppress_count = poll_suppress_count;
9206 poll_suppress_count = 1;
9207 poll_for_input_1 ();
9208 poll_suppress_count = old_poll_suppress_count;
9211 /* See if a MapNotify event has been processed. */
9212 FRAME_SAMPLE_VISIBILITY (f);
9215 /* 2000-09-28: In
9217 (let ((f (selected-frame)))
9218 (iconify-frame f)
9219 (raise-frame f))
9221 the frame is not raised with various window managers on
9222 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9223 unknown reason, the call to XtMapWidget is completely ignored.
9224 Mapping the widget a second time works. */
9226 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9227 goto retry;
9231 /* Change from mapped state to withdrawn state. */
9233 /* Make the frame visible (mapped and not iconified). */
9235 void
9236 x_make_frame_invisible (f)
9237 struct frame *f;
9239 Window window;
9241 /* Use the frame's outermost window, not the one we normally draw on. */
9242 window = FRAME_OUTER_WINDOW (f);
9244 /* Don't keep the highlight on an invisible frame. */
9245 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9246 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9248 #if 0/* This might add unreliability; I don't trust it -- rms. */
9249 if (! f->async_visible && ! f->async_iconified)
9250 return;
9251 #endif
9253 BLOCK_INPUT;
9255 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9256 that the current position of the window is user-specified, rather than
9257 program-specified, so that when the window is mapped again, it will be
9258 placed at the same location, without forcing the user to position it
9259 by hand again (they have already done that once for this window.) */
9260 x_wm_set_size_hint (f, (long) 0, 1);
9262 #ifdef USE_GTK
9263 if (FRAME_GTK_OUTER_WIDGET (f))
9264 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9265 else
9266 #else
9267 if (FRAME_X_EMBEDDED_P (f))
9268 xembed_set_info (f, 0);
9269 else
9270 #endif
9273 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9274 DefaultScreen (FRAME_X_DISPLAY (f))))
9276 UNBLOCK_INPUT_RESIGNAL;
9277 error ("Can't notify window manager of window withdrawal");
9281 /* We can't distinguish this from iconification
9282 just by the event that we get from the server.
9283 So we can't win using the usual strategy of letting
9284 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9285 and synchronize with the server to make sure we agree. */
9286 f->visible = 0;
9287 FRAME_ICONIFIED_P (f) = 0;
9288 f->async_visible = 0;
9289 f->async_iconified = 0;
9291 x_sync (f);
9293 UNBLOCK_INPUT;
9296 /* Change window state from mapped to iconified. */
9298 void
9299 x_iconify_frame (f)
9300 struct frame *f;
9302 int result;
9303 Lisp_Object type;
9305 /* Don't keep the highlight on an invisible frame. */
9306 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9307 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9309 if (f->async_iconified)
9310 return;
9312 BLOCK_INPUT;
9314 FRAME_SAMPLE_VISIBILITY (f);
9316 type = x_icon_type (f);
9317 if (!NILP (type))
9318 x_bitmap_icon (f, type);
9320 #ifdef USE_GTK
9321 if (FRAME_GTK_OUTER_WIDGET (f))
9323 if (! FRAME_VISIBLE_P (f))
9324 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9326 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9327 f->iconified = 1;
9328 f->visible = 1;
9329 f->async_iconified = 1;
9330 f->async_visible = 0;
9331 UNBLOCK_INPUT;
9332 return;
9334 #endif
9336 #ifdef USE_X_TOOLKIT
9338 if (! FRAME_VISIBLE_P (f))
9340 if (! EQ (Vx_no_window_manager, Qt))
9341 x_wm_set_window_state (f, IconicState);
9342 /* This was XtPopup, but that did nothing for an iconified frame. */
9343 XtMapWidget (f->output_data.x->widget);
9344 /* The server won't give us any event to indicate
9345 that an invisible frame was changed to an icon,
9346 so we have to record it here. */
9347 f->iconified = 1;
9348 f->visible = 1;
9349 f->async_iconified = 1;
9350 f->async_visible = 0;
9351 UNBLOCK_INPUT;
9352 return;
9355 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9356 XtWindow (f->output_data.x->widget),
9357 DefaultScreen (FRAME_X_DISPLAY (f)));
9358 UNBLOCK_INPUT;
9360 if (!result)
9361 error ("Can't notify window manager of iconification");
9363 f->async_iconified = 1;
9364 f->async_visible = 0;
9367 BLOCK_INPUT;
9368 XFlush (FRAME_X_DISPLAY (f));
9369 UNBLOCK_INPUT;
9370 #else /* not USE_X_TOOLKIT */
9372 /* Make sure the X server knows where the window should be positioned,
9373 in case the user deiconifies with the window manager. */
9374 if (! FRAME_VISIBLE_P (f)
9375 && ! FRAME_ICONIFIED_P (f)
9376 && ! FRAME_X_EMBEDDED_P (f))
9377 x_set_offset (f, f->left_pos, f->top_pos, 0);
9379 /* Since we don't know which revision of X we're running, we'll use both
9380 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9382 /* X11R4: send a ClientMessage to the window manager using the
9383 WM_CHANGE_STATE type. */
9385 XEvent message;
9387 message.xclient.window = FRAME_X_WINDOW (f);
9388 message.xclient.type = ClientMessage;
9389 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9390 message.xclient.format = 32;
9391 message.xclient.data.l[0] = IconicState;
9393 if (! XSendEvent (FRAME_X_DISPLAY (f),
9394 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9395 False,
9396 SubstructureRedirectMask | SubstructureNotifyMask,
9397 &message))
9399 UNBLOCK_INPUT_RESIGNAL;
9400 error ("Can't notify window manager of iconification");
9404 /* X11R3: set the initial_state field of the window manager hints to
9405 IconicState. */
9406 x_wm_set_window_state (f, IconicState);
9408 if (!FRAME_VISIBLE_P (f))
9410 /* If the frame was withdrawn, before, we must map it. */
9411 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9414 f->async_iconified = 1;
9415 f->async_visible = 0;
9417 XFlush (FRAME_X_DISPLAY (f));
9418 UNBLOCK_INPUT;
9419 #endif /* not USE_X_TOOLKIT */
9423 /* Free X resources of frame F. */
9425 void
9426 x_free_frame_resources (f)
9427 struct frame *f;
9429 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9430 Lisp_Object bar;
9431 struct scroll_bar *b;
9433 BLOCK_INPUT;
9435 /* If a display connection is dead, don't try sending more
9436 commands to the X server. */
9437 if (dpyinfo->display)
9439 /* We must free faces before destroying windows because some
9440 font-driver (e.g. xft) access a window while finishing a
9441 face. */
9442 if (FRAME_FACE_CACHE (f))
9443 free_frame_faces (f);
9445 if (f->output_data.x->icon_desc)
9446 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9448 #ifdef USE_X_TOOLKIT
9449 /* Explicitly destroy the scroll bars of the frame. Without
9450 this, we get "BadDrawable" errors from the toolkit later on,
9451 presumably from expose events generated for the disappearing
9452 toolkit scroll bars. */
9453 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9455 b = XSCROLL_BAR (bar);
9456 x_scroll_bar_remove (b);
9458 #endif
9460 #ifdef HAVE_X_I18N
9461 if (FRAME_XIC (f))
9462 free_frame_xic (f);
9463 #endif
9465 #ifdef USE_X_TOOLKIT
9466 if (f->output_data.x->widget)
9468 XtDestroyWidget (f->output_data.x->widget);
9469 f->output_data.x->widget = NULL;
9471 /* Tooltips don't have widgets, only a simple X window, even if
9472 we are using a toolkit. */
9473 else if (FRAME_X_WINDOW (f))
9474 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9476 free_frame_menubar (f);
9477 #else /* !USE_X_TOOLKIT */
9479 #ifdef USE_GTK
9480 /* In the GTK version, tooltips are normal X
9481 frames. We must check and free both types. */
9482 if (FRAME_GTK_OUTER_WIDGET (f))
9484 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
9485 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
9486 FRAME_GTK_OUTER_WIDGET (f) = 0;
9488 #endif /* USE_GTK */
9490 if (FRAME_X_WINDOW (f))
9491 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9492 #endif /* !USE_X_TOOLKIT */
9494 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9495 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9496 unload_color (f, f->output_data.x->cursor_pixel);
9497 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9498 unload_color (f, f->output_data.x->border_pixel);
9499 unload_color (f, f->output_data.x->mouse_pixel);
9501 if (f->output_data.x->scroll_bar_background_pixel != -1)
9502 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9503 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9504 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9505 #ifdef USE_TOOLKIT_SCROLL_BARS
9506 /* Scrollbar shadow colors. */
9507 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9508 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9509 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9510 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9511 #endif /* USE_TOOLKIT_SCROLL_BARS */
9512 if (f->output_data.x->white_relief.allocated_p)
9513 unload_color (f, f->output_data.x->white_relief.pixel);
9514 if (f->output_data.x->black_relief.allocated_p)
9515 unload_color (f, f->output_data.x->black_relief.pixel);
9517 if (FRAME_FACE_CACHE (f))
9518 free_frame_faces (f);
9520 x_free_gcs (f);
9521 XFlush (FRAME_X_DISPLAY (f));
9524 xfree (f->output_data.x->saved_menu_event);
9525 xfree (f->output_data.x);
9526 f->output_data.x = NULL;
9528 if (f == dpyinfo->x_focus_frame)
9529 dpyinfo->x_focus_frame = 0;
9530 if (f == dpyinfo->x_focus_event_frame)
9531 dpyinfo->x_focus_event_frame = 0;
9532 if (f == dpyinfo->x_highlight_frame)
9533 dpyinfo->x_highlight_frame = 0;
9535 if (f == dpyinfo->mouse_face_mouse_frame)
9537 dpyinfo->mouse_face_beg_row
9538 = dpyinfo->mouse_face_beg_col = -1;
9539 dpyinfo->mouse_face_end_row
9540 = dpyinfo->mouse_face_end_col = -1;
9541 dpyinfo->mouse_face_window = Qnil;
9542 dpyinfo->mouse_face_deferred_gc = 0;
9543 dpyinfo->mouse_face_mouse_frame = 0;
9546 UNBLOCK_INPUT;
9550 /* Destroy the X window of frame F. */
9552 void
9553 x_destroy_window (f)
9554 struct frame *f;
9556 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9558 /* If a display connection is dead, don't try sending more
9559 commands to the X server. */
9560 if (dpyinfo->display != 0)
9561 x_free_frame_resources (f);
9563 dpyinfo->reference_count--;
9567 /* Setting window manager hints. */
9569 /* Set the normal size hints for the window manager, for frame F.
9570 FLAGS is the flags word to use--or 0 meaning preserve the flags
9571 that the window now has.
9572 If USER_POSITION is nonzero, we set the USPosition
9573 flag (this is useful when FLAGS is 0).
9574 The GTK version is in gtkutils.c */
9576 #ifndef USE_GTK
9577 void
9578 x_wm_set_size_hint (f, flags, user_position)
9579 struct frame *f;
9580 long flags;
9581 int user_position;
9583 XSizeHints size_hints;
9585 #ifdef USE_X_TOOLKIT
9586 Arg al[2];
9587 int ac = 0;
9588 Dimension widget_width, widget_height;
9589 #endif
9591 Window window = FRAME_OUTER_WINDOW (f);
9593 /* Setting PMaxSize caused various problems. */
9594 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9596 size_hints.x = f->left_pos;
9597 size_hints.y = f->top_pos;
9599 #ifdef USE_X_TOOLKIT
9600 XtSetArg (al[ac], XtNwidth, &widget_width); ac++;
9601 XtSetArg (al[ac], XtNheight, &widget_height); ac++;
9602 XtGetValues (f->output_data.x->widget, al, ac);
9603 size_hints.height = widget_height;
9604 size_hints.width = widget_width;
9605 #else /* not USE_X_TOOLKIT */
9606 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9607 size_hints.width = FRAME_PIXEL_WIDTH (f);
9608 #endif /* not USE_X_TOOLKIT */
9610 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9611 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9612 size_hints.max_width
9613 = FRAME_X_DISPLAY_INFO (f)->width - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9614 size_hints.max_height
9615 = FRAME_X_DISPLAY_INFO (f)->height - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9617 /* Calculate the base and minimum sizes.
9619 (When we use the X toolkit, we don't do it here.
9620 Instead we copy the values that the widgets are using, below.) */
9621 #ifndef USE_X_TOOLKIT
9623 int base_width, base_height;
9624 int min_rows = 0, min_cols = 0;
9626 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9627 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9629 check_frame_size (f, &min_rows, &min_cols);
9631 /* The window manager uses the base width hints to calculate the
9632 current number of rows and columns in the frame while
9633 resizing; min_width and min_height aren't useful for this
9634 purpose, since they might not give the dimensions for a
9635 zero-row, zero-column frame.
9637 We use the base_width and base_height members if we have
9638 them; otherwise, we set the min_width and min_height members
9639 to the size for a zero x zero frame. */
9641 size_hints.flags |= PBaseSize;
9642 size_hints.base_width = base_width;
9643 size_hints.base_height = base_height;
9644 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9645 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9648 /* If we don't need the old flags, we don't need the old hint at all. */
9649 if (flags)
9651 size_hints.flags |= flags;
9652 goto no_read;
9654 #endif /* not USE_X_TOOLKIT */
9657 XSizeHints hints; /* Sometimes I hate X Windows... */
9658 long supplied_return;
9659 int value;
9661 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9662 &supplied_return);
9664 #ifdef USE_X_TOOLKIT
9665 size_hints.base_height = hints.base_height;
9666 size_hints.base_width = hints.base_width;
9667 size_hints.min_height = hints.min_height;
9668 size_hints.min_width = hints.min_width;
9669 #endif
9671 if (flags)
9672 size_hints.flags |= flags;
9673 else
9675 if (value == 0)
9676 hints.flags = 0;
9677 if (hints.flags & PSize)
9678 size_hints.flags |= PSize;
9679 if (hints.flags & PPosition)
9680 size_hints.flags |= PPosition;
9681 if (hints.flags & USPosition)
9682 size_hints.flags |= USPosition;
9683 if (hints.flags & USSize)
9684 size_hints.flags |= USSize;
9688 #ifndef USE_X_TOOLKIT
9689 no_read:
9690 #endif
9692 #ifdef PWinGravity
9693 size_hints.win_gravity = f->win_gravity;
9694 size_hints.flags |= PWinGravity;
9696 if (user_position)
9698 size_hints.flags &= ~ PPosition;
9699 size_hints.flags |= USPosition;
9701 #endif /* PWinGravity */
9703 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9705 #endif /* not USE_GTK */
9707 /* Used for IconicState or NormalState */
9709 void
9710 x_wm_set_window_state (f, state)
9711 struct frame *f;
9712 int state;
9714 #ifdef USE_X_TOOLKIT
9715 Arg al[1];
9717 XtSetArg (al[0], XtNinitialState, state);
9718 XtSetValues (f->output_data.x->widget, al, 1);
9719 #else /* not USE_X_TOOLKIT */
9720 Window window = FRAME_X_WINDOW (f);
9722 f->output_data.x->wm_hints.flags |= StateHint;
9723 f->output_data.x->wm_hints.initial_state = state;
9725 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9726 #endif /* not USE_X_TOOLKIT */
9729 void
9730 x_wm_set_icon_pixmap (f, pixmap_id)
9731 struct frame *f;
9732 int pixmap_id;
9734 Pixmap icon_pixmap, icon_mask;
9736 #ifndef USE_X_TOOLKIT
9737 Window window = FRAME_OUTER_WINDOW (f);
9738 #endif
9740 if (pixmap_id > 0)
9742 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9743 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9744 icon_mask = x_bitmap_mask (f, pixmap_id);
9745 f->output_data.x->wm_hints.icon_mask = icon_mask;
9747 else
9749 /* It seems there is no way to turn off use of an icon pixmap.
9750 The following line does it, only if no icon has yet been created,
9751 for some window managers. But with mwm it crashes.
9752 Some people say it should clear the IconPixmapHint bit in this case,
9753 but that doesn't work, and the X consortium said it isn't the
9754 right thing at all. Since there is no way to win,
9755 best to explicitly give up. */
9756 #if 0
9757 f->output_data.x->wm_hints.icon_pixmap = None;
9758 f->output_data.x->wm_hints.icon_mask = None;
9759 #else
9760 return;
9761 #endif
9765 #ifdef USE_GTK
9767 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9768 return;
9771 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9774 Arg al[1];
9775 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9776 XtSetValues (f->output_data.x->widget, al, 1);
9777 XtSetArg (al[0], XtNiconMask, icon_mask);
9778 XtSetValues (f->output_data.x->widget, al, 1);
9781 #else /* not USE_X_TOOLKIT && not USE_GTK */
9783 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9784 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9786 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9789 void
9790 x_wm_set_icon_position (f, icon_x, icon_y)
9791 struct frame *f;
9792 int icon_x, icon_y;
9794 Window window = FRAME_OUTER_WINDOW (f);
9796 f->output_data.x->wm_hints.flags |= IconPositionHint;
9797 f->output_data.x->wm_hints.icon_x = icon_x;
9798 f->output_data.x->wm_hints.icon_y = icon_y;
9800 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9804 /***********************************************************************
9805 Fonts
9806 ***********************************************************************/
9808 #if GLYPH_DEBUG
9810 /* Check that FONT is valid on frame F. It is if it can be found in F's
9811 font table. */
9813 static void
9814 x_check_font (f, font)
9815 struct frame *f;
9816 struct font *font;
9818 Lisp_Object frame;
9820 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9821 if (font->driver->check)
9822 xassert (font->driver->check (f, font) == 0);
9825 #endif /* GLYPH_DEBUG != 0 */
9828 /***********************************************************************
9829 Initialization
9830 ***********************************************************************/
9832 #ifdef USE_X_TOOLKIT
9833 static XrmOptionDescRec emacs_options[] = {
9834 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9835 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9837 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9838 XrmoptionSepArg, NULL},
9839 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9841 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9842 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9843 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9844 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9845 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9846 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9847 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9850 /* Whether atimer for Xt timeouts is activated or not. */
9852 static int x_timeout_atimer_activated_flag;
9854 #endif /* USE_X_TOOLKIT */
9856 static int x_initialized;
9858 #ifdef HAVE_X_SM
9859 static int x_session_initialized;
9860 #endif
9862 #ifdef MULTI_KBOARD
9863 /* Test whether two display-name strings agree up to the dot that separates
9864 the screen number from the server number. */
9865 static int
9866 same_x_server (name1, name2)
9867 const char *name1, *name2;
9869 int seen_colon = 0;
9870 const unsigned char *system_name = SDATA (Vsystem_name);
9871 int system_name_length = strlen (system_name);
9872 int length_until_period = 0;
9874 while (system_name[length_until_period] != 0
9875 && system_name[length_until_period] != '.')
9876 length_until_period++;
9878 /* Treat `unix' like an empty host name. */
9879 if (! strncmp (name1, "unix:", 5))
9880 name1 += 4;
9881 if (! strncmp (name2, "unix:", 5))
9882 name2 += 4;
9883 /* Treat this host's name like an empty host name. */
9884 if (! strncmp (name1, system_name, system_name_length)
9885 && name1[system_name_length] == ':')
9886 name1 += system_name_length;
9887 if (! strncmp (name2, system_name, system_name_length)
9888 && name2[system_name_length] == ':')
9889 name2 += system_name_length;
9890 /* Treat this host's domainless name like an empty host name. */
9891 if (! strncmp (name1, system_name, length_until_period)
9892 && name1[length_until_period] == ':')
9893 name1 += length_until_period;
9894 if (! strncmp (name2, system_name, length_until_period)
9895 && name2[length_until_period] == ':')
9896 name2 += length_until_period;
9898 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9900 if (*name1 == ':')
9901 seen_colon++;
9902 if (seen_colon && *name1 == '.')
9903 return 1;
9905 return (seen_colon
9906 && (*name1 == '.' || *name1 == '\0')
9907 && (*name2 == '.' || *name2 == '\0'));
9909 #endif
9911 /* Count number of set bits in mask and number of bits to shift to
9912 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9913 to 5. */
9914 static void
9915 get_bits_and_offset (mask, bits, offset)
9916 unsigned long mask;
9917 int *bits;
9918 int *offset;
9920 int nr = 0;
9921 int off = 0;
9923 while (!(mask & 1))
9925 off++;
9926 mask >>= 1;
9929 while (mask & 1)
9931 nr++;
9932 mask >>= 1;
9935 *offset = off;
9936 *bits = nr;
9939 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9940 But don't permanently open it, just test its availability. */
9943 x_display_ok (display)
9944 const char *display;
9946 int dpy_ok = 1;
9947 Display *dpy;
9949 dpy = XOpenDisplay (display);
9950 if (dpy)
9951 XCloseDisplay (dpy);
9952 else
9953 dpy_ok = 0;
9954 return dpy_ok;
9957 /* Open a connection to X display DISPLAY_NAME, and return
9958 the structure that describes the open display.
9959 If we cannot contact the display, return null. */
9961 struct x_display_info *
9962 x_term_init (display_name, xrm_option, resource_name)
9963 Lisp_Object display_name;
9964 char *xrm_option;
9965 char *resource_name;
9967 int connection;
9968 Display *dpy;
9969 struct terminal *terminal;
9970 struct x_display_info *dpyinfo;
9971 XrmDatabase xrdb;
9973 BLOCK_INPUT;
9975 if (!x_initialized)
9977 x_initialize ();
9978 ++x_initialized;
9981 if (! x_display_ok (SDATA (display_name)))
9982 error ("Display %s can't be opened", SDATA (display_name));
9984 #ifdef USE_GTK
9986 #define NUM_ARGV 10
9987 int argc;
9988 char *argv[NUM_ARGV];
9989 char **argv2 = argv;
9990 GdkAtom atom;
9992 #ifndef HAVE_GTK_MULTIDISPLAY
9993 if (!EQ (Vinitial_window_system, intern ("x")))
9994 error ("Sorry, you cannot connect to X servers with the GTK toolkit");
9995 #endif
9997 if (x_initialized++ > 1)
9999 #ifdef HAVE_GTK_MULTIDISPLAY
10000 /* Opening another display. If xg_display_open returns less
10001 than zero, we are probably on GTK 2.0, which can only handle
10002 one display. GTK 2.2 or later can handle more than one. */
10003 if (xg_display_open (SDATA (display_name), &dpy) < 0)
10004 #endif
10005 error ("Sorry, this version of GTK can only handle one display");
10007 else
10009 for (argc = 0; argc < NUM_ARGV; ++argc)
10010 argv[argc] = 0;
10012 argc = 0;
10013 argv[argc++] = initial_argv[0];
10015 if (! NILP (display_name))
10017 argv[argc++] = "--display";
10018 argv[argc++] = SDATA (display_name);
10021 argv[argc++] = "--name";
10022 argv[argc++] = resource_name;
10024 XSetLocaleModifiers ("");
10026 gtk_init (&argc, &argv2);
10028 /* gtk_init does set_locale. We must fix locale after calling it. */
10029 fixup_locale ();
10030 xg_initialize ();
10032 dpy = GDK_DISPLAY ();
10034 /* NULL window -> events for all windows go to our function */
10035 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10037 /* Load our own gtkrc if it exists. */
10039 char *file = "~/.emacs.d/gtkrc";
10040 Lisp_Object s, abs_file;
10042 s = make_string (file, strlen (file));
10043 abs_file = Fexpand_file_name (s, Qnil);
10045 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10046 gtk_rc_parse (SDATA (abs_file));
10049 XSetErrorHandler (x_error_handler);
10050 XSetIOErrorHandler (x_io_error_quitter);
10053 #else /* not USE_GTK */
10054 #ifdef USE_X_TOOLKIT
10055 /* weiner@footloose.sps.mot.com reports that this causes
10056 errors with X11R5:
10057 X protocol error: BadAtom (invalid Atom parameter)
10058 on protocol request 18skiloaf.
10059 So let's not use it until R6. */
10060 #ifdef HAVE_X11XTR6
10061 XtSetLanguageProc (NULL, NULL, NULL);
10062 #endif
10065 int argc = 0;
10066 char *argv[3];
10068 argv[0] = "";
10069 argc = 1;
10070 if (xrm_option)
10072 argv[argc++] = "-xrm";
10073 argv[argc++] = xrm_option;
10075 turn_on_atimers (0);
10076 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10077 resource_name, EMACS_CLASS,
10078 emacs_options, XtNumber (emacs_options),
10079 &argc, argv);
10080 turn_on_atimers (1);
10082 #ifdef HAVE_X11XTR6
10083 /* I think this is to compensate for XtSetLanguageProc. */
10084 fixup_locale ();
10085 #endif
10088 #else /* not USE_X_TOOLKIT */
10089 XSetLocaleModifiers ("");
10090 dpy = XOpenDisplay (SDATA (display_name));
10091 #endif /* not USE_X_TOOLKIT */
10092 #endif /* not USE_GTK*/
10094 /* Detect failure. */
10095 if (dpy == 0)
10097 UNBLOCK_INPUT;
10098 return 0;
10101 /* We have definitely succeeded. Record the new connection. */
10103 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10104 bzero (dpyinfo, sizeof *dpyinfo);
10106 terminal = x_create_terminal (dpyinfo);
10108 #ifdef MULTI_KBOARD
10110 struct x_display_info *share;
10111 Lisp_Object tail;
10113 for (share = x_display_list, tail = x_display_name_list; share;
10114 share = share->next, tail = XCDR (tail))
10115 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10116 SDATA (display_name)))
10117 break;
10118 if (share)
10119 terminal->kboard = share->terminal->kboard;
10120 else
10122 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10123 init_kboard (terminal->kboard);
10124 terminal->kboard->Vwindow_system = intern ("x");
10125 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10127 char *vendor = ServerVendor (dpy);
10128 UNBLOCK_INPUT;
10129 terminal->kboard->Vsystem_key_alist
10130 = call1 (Qvendor_specific_keysyms,
10131 vendor ? build_string (vendor) : empty_unibyte_string);
10132 BLOCK_INPUT;
10135 terminal->kboard->next_kboard = all_kboards;
10136 all_kboards = terminal->kboard;
10137 /* Don't let the initial kboard remain current longer than necessary.
10138 That would cause problems if a file loaded on startup tries to
10139 prompt in the mini-buffer. */
10140 if (current_kboard == initial_kboard)
10141 current_kboard = terminal->kboard;
10143 terminal->kboard->reference_count++;
10145 #endif
10147 /* Put this display on the chain. */
10148 dpyinfo->next = x_display_list;
10149 x_display_list = dpyinfo;
10151 /* Put it on x_display_name_list as well, to keep them parallel. */
10152 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10153 x_display_name_list);
10154 dpyinfo->name_list_element = XCAR (x_display_name_list);
10156 dpyinfo->display = dpy;
10158 /* Set the name of the terminal. */
10159 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10160 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10161 terminal->name[SBYTES (display_name)] = 0;
10163 #if 0
10164 XSetAfterFunction (x_current_display, x_trace_wire);
10165 #endif /* ! 0 */
10167 dpyinfo->x_id_name
10168 = (char *) xmalloc (SBYTES (Vinvocation_name)
10169 + SBYTES (Vsystem_name)
10170 + 2);
10171 sprintf (dpyinfo->x_id_name, "%s@%s",
10172 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10174 /* Figure out which modifier bits mean what. */
10175 x_find_modifier_meanings (dpyinfo);
10177 /* Get the scroll bar cursor. */
10178 #ifdef USE_GTK
10179 /* We must create a GTK cursor, it is required for GTK widgets. */
10180 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10181 #endif /* USE_GTK */
10183 dpyinfo->vertical_scroll_bar_cursor
10184 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10186 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10187 resource_name, EMACS_CLASS);
10188 #ifdef HAVE_XRMSETDATABASE
10189 XrmSetDatabase (dpyinfo->display, xrdb);
10190 #else
10191 dpyinfo->display->db = xrdb;
10192 #endif
10193 /* Put the rdb where we can find it in a way that works on
10194 all versions. */
10195 dpyinfo->xrdb = xrdb;
10197 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10198 DefaultScreen (dpyinfo->display));
10199 select_visual (dpyinfo);
10200 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10201 dpyinfo->height = HeightOfScreen (dpyinfo->screen);
10202 dpyinfo->width = WidthOfScreen (dpyinfo->screen);
10203 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10204 dpyinfo->client_leader_window = 0;
10205 dpyinfo->grabbed = 0;
10206 dpyinfo->reference_count = 0;
10207 dpyinfo->icon_bitmap_id = -1;
10208 dpyinfo->n_fonts = 0;
10209 dpyinfo->bitmaps = 0;
10210 dpyinfo->bitmaps_size = 0;
10211 dpyinfo->bitmaps_last = 0;
10212 dpyinfo->scratch_cursor_gc = 0;
10213 dpyinfo->mouse_face_mouse_frame = 0;
10214 dpyinfo->mouse_face_deferred_gc = 0;
10215 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10216 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10217 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10218 dpyinfo->mouse_face_window = Qnil;
10219 dpyinfo->mouse_face_overlay = Qnil;
10220 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10221 dpyinfo->mouse_face_defer = 0;
10222 dpyinfo->mouse_face_hidden = 0;
10223 dpyinfo->x_focus_frame = 0;
10224 dpyinfo->x_focus_event_frame = 0;
10225 dpyinfo->x_highlight_frame = 0;
10226 dpyinfo->terminal->image_cache = make_image_cache ();
10227 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10229 /* See if we can construct pixel values from RGB values. */
10230 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10231 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10233 if (dpyinfo->visual->class == TrueColor)
10235 get_bits_and_offset (dpyinfo->visual->red_mask,
10236 &dpyinfo->red_bits, &dpyinfo->red_offset);
10237 get_bits_and_offset (dpyinfo->visual->blue_mask,
10238 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10239 get_bits_and_offset (dpyinfo->visual->green_mask,
10240 &dpyinfo->green_bits, &dpyinfo->green_offset);
10243 /* See if a private colormap is requested. */
10244 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10246 if (dpyinfo->visual->class == PseudoColor)
10248 Lisp_Object value;
10249 value = display_x_get_resource (dpyinfo,
10250 build_string ("privateColormap"),
10251 build_string ("PrivateColormap"),
10252 Qnil, Qnil);
10253 if (STRINGP (value)
10254 && (!strcmp (SDATA (value), "true")
10255 || !strcmp (SDATA (value), "on")))
10256 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10259 else
10260 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10261 dpyinfo->visual, AllocNone);
10264 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10265 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10266 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10267 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10268 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10269 pixels = DisplayWidth (dpyinfo->display, screen_number);
10270 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10271 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10272 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10275 dpyinfo->Xatom_wm_protocols
10276 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10277 dpyinfo->Xatom_wm_take_focus
10278 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10279 dpyinfo->Xatom_wm_save_yourself
10280 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10281 dpyinfo->Xatom_wm_delete_window
10282 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10283 dpyinfo->Xatom_wm_change_state
10284 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10285 dpyinfo->Xatom_wm_configure_denied
10286 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10287 dpyinfo->Xatom_wm_window_moved
10288 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10289 dpyinfo->Xatom_wm_client_leader
10290 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10291 dpyinfo->Xatom_editres
10292 = XInternAtom (dpyinfo->display, "Editres", False);
10293 dpyinfo->Xatom_CLIPBOARD
10294 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10295 dpyinfo->Xatom_TIMESTAMP
10296 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10297 dpyinfo->Xatom_TEXT
10298 = XInternAtom (dpyinfo->display, "TEXT", False);
10299 dpyinfo->Xatom_COMPOUND_TEXT
10300 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10301 dpyinfo->Xatom_UTF8_STRING
10302 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10303 dpyinfo->Xatom_DELETE
10304 = XInternAtom (dpyinfo->display, "DELETE", False);
10305 dpyinfo->Xatom_MULTIPLE
10306 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10307 dpyinfo->Xatom_INCR
10308 = XInternAtom (dpyinfo->display, "INCR", False);
10309 dpyinfo->Xatom_EMACS_TMP
10310 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10311 dpyinfo->Xatom_TARGETS
10312 = XInternAtom (dpyinfo->display, "TARGETS", False);
10313 dpyinfo->Xatom_NULL
10314 = XInternAtom (dpyinfo->display, "NULL", False);
10315 dpyinfo->Xatom_ATOM_PAIR
10316 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10317 /* For properties of font. */
10318 dpyinfo->Xatom_PIXEL_SIZE
10319 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10320 dpyinfo->Xatom_AVERAGE_WIDTH
10321 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10322 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10323 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10324 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10325 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10326 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10327 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10329 /* Ghostscript support. */
10330 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10331 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10333 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10334 False);
10336 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10337 False);
10339 dpyinfo->cut_buffers_initialized = 0;
10341 dpyinfo->x_dnd_atoms_size = 8;
10342 dpyinfo->x_dnd_atoms_length = 0;
10343 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10344 * dpyinfo->x_dnd_atoms_size);
10346 dpyinfo->net_supported_atoms = NULL;
10347 dpyinfo->nr_net_supported_atoms = 0;
10348 dpyinfo->net_supported_window = 0;
10350 connection = ConnectionNumber (dpyinfo->display);
10351 dpyinfo->connection = connection;
10354 char null_bits[1];
10356 null_bits[0] = 0x00;
10358 dpyinfo->null_pixel
10359 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10360 null_bits, 1, 1, (long) 0, (long) 0,
10365 extern int gray_bitmap_width, gray_bitmap_height;
10366 extern char *gray_bitmap_bits;
10367 dpyinfo->gray
10368 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10369 gray_bitmap_bits,
10370 gray_bitmap_width, gray_bitmap_height,
10371 (unsigned long) 1, (unsigned long) 0, 1);
10374 #ifdef HAVE_X_I18N
10375 xim_initialize (dpyinfo, resource_name);
10376 #endif
10378 #ifdef subprocesses
10379 /* This is only needed for distinguishing keyboard and process input. */
10380 if (connection != 0)
10381 add_keyboard_wait_descriptor (connection);
10382 #endif
10384 #ifdef F_SETOWN
10385 fcntl (connection, F_SETOWN, getpid ());
10386 #endif /* ! defined (F_SETOWN) */
10388 #ifdef SIGIO
10389 if (interrupt_input)
10390 init_sigio (connection);
10391 #endif /* ! defined (SIGIO) */
10393 #ifdef USE_LUCID
10395 Display *dpy = dpyinfo->display;
10396 XrmValue d, fr, to;
10397 Font font;
10399 d.addr = (XPointer)&dpy;
10400 d.size = sizeof (Display *);
10401 fr.addr = XtDefaultFont;
10402 fr.size = sizeof (XtDefaultFont);
10403 to.size = sizeof (Font *);
10404 to.addr = (XPointer)&font;
10405 x_catch_errors (dpy);
10406 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10407 abort ();
10408 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10409 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10410 x_uncatch_errors ();
10412 #endif
10414 /* See if we should run in synchronous mode. This is useful
10415 for debugging X code. */
10417 Lisp_Object value;
10418 value = display_x_get_resource (dpyinfo,
10419 build_string ("synchronous"),
10420 build_string ("Synchronous"),
10421 Qnil, Qnil);
10422 if (STRINGP (value)
10423 && (!strcmp (SDATA (value), "true")
10424 || !strcmp (SDATA (value), "on")))
10425 XSynchronize (dpyinfo->display, True);
10429 Lisp_Object value;
10430 value = display_x_get_resource (dpyinfo,
10431 build_string ("useXIM"),
10432 build_string ("UseXIM"),
10433 Qnil, Qnil);
10434 #ifdef USE_XIM
10435 if (STRINGP (value)
10436 && (!strcmp (SDATA (value), "false")
10437 || !strcmp (SDATA (value), "off")))
10438 use_xim = 0;
10439 #else
10440 if (STRINGP (value)
10441 && (!strcmp (SDATA (value), "true")
10442 || !strcmp (SDATA (value), "on")))
10443 use_xim = 1;
10444 #endif
10447 #ifdef HAVE_X_SM
10448 /* Only do this for the very first display in the Emacs session.
10449 Ignore X session management when Emacs was first started on a
10450 tty. */
10451 if (terminal->id == 1)
10452 x_session_initialize (dpyinfo);
10453 #endif
10455 UNBLOCK_INPUT;
10457 return dpyinfo;
10460 /* Get rid of display DPYINFO, deleting all frames on it,
10461 and without sending any more commands to the X server. */
10463 void
10464 x_delete_display (dpyinfo)
10465 struct x_display_info *dpyinfo;
10467 int i;
10468 struct terminal *t;
10470 /* Close all frames and delete the generic struct terminal for this
10471 X display. */
10472 for (t = terminal_list; t; t = t->next_terminal)
10473 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10475 #ifdef HAVE_X_SM
10476 /* Close X session management when we close its display. */
10477 if (t->id == 1 && x_session_have_connection ())
10478 x_session_close();
10479 #endif
10480 delete_terminal (t);
10481 break;
10484 delete_keyboard_wait_descriptor (dpyinfo->connection);
10486 /* Discard this display from x_display_name_list and x_display_list.
10487 We can't use Fdelq because that can quit. */
10488 if (! NILP (x_display_name_list)
10489 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10490 x_display_name_list = XCDR (x_display_name_list);
10491 else
10493 Lisp_Object tail;
10495 tail = x_display_name_list;
10496 while (CONSP (tail) && CONSP (XCDR (tail)))
10498 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10500 XSETCDR (tail, XCDR (XCDR (tail)));
10501 break;
10503 tail = XCDR (tail);
10507 if (next_noop_dpyinfo == dpyinfo)
10508 next_noop_dpyinfo = dpyinfo->next;
10510 if (x_display_list == dpyinfo)
10511 x_display_list = dpyinfo->next;
10512 else
10514 struct x_display_info *tail;
10516 for (tail = x_display_list; tail; tail = tail->next)
10517 if (tail->next == dpyinfo)
10518 tail->next = tail->next->next;
10521 #ifndef USE_X_TOOLKIT /* I'm told Xt does this itself. */
10522 #ifndef AIX /* On AIX, XCloseDisplay calls this. */
10523 XrmDestroyDatabase (dpyinfo->xrdb);
10524 #endif
10525 #endif
10526 #ifdef HAVE_X_I18N
10527 if (dpyinfo->xim)
10528 xim_close_dpy (dpyinfo);
10529 #endif
10531 xfree (dpyinfo->x_id_name);
10532 xfree (dpyinfo->color_cells);
10533 xfree (dpyinfo);
10536 #ifdef USE_X_TOOLKIT
10538 /* Atimer callback function for TIMER. Called every 0.1s to process
10539 Xt timeouts, if needed. We must avoid calling XtAppPending as
10540 much as possible because that function does an implicit XFlush
10541 that slows us down. */
10543 static void
10544 x_process_timeouts (timer)
10545 struct atimer *timer;
10547 BLOCK_INPUT;
10548 x_timeout_atimer_activated_flag = 0;
10549 if (toolkit_scroll_bar_interaction || popup_activated ())
10551 while (XtAppPending (Xt_app_con) & XtIMTimer)
10552 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10553 /* Reactivate the atimer for next time. */
10554 x_activate_timeout_atimer ();
10556 UNBLOCK_INPUT;
10559 /* Install an asynchronous timer that processes Xt timeout events
10560 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10561 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10562 function whenever these variables are set. This is necessary
10563 because some widget sets use timeouts internally, for example the
10564 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10565 processed, these widgets don't behave normally. */
10567 void
10568 x_activate_timeout_atimer ()
10570 BLOCK_INPUT;
10571 if (!x_timeout_atimer_activated_flag)
10573 EMACS_TIME interval;
10575 EMACS_SET_SECS_USECS (interval, 0, 100000);
10576 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10577 x_timeout_atimer_activated_flag = 1;
10579 UNBLOCK_INPUT;
10582 #endif /* USE_X_TOOLKIT */
10585 /* Set up use of X before we make the first connection. */
10587 extern frame_parm_handler x_frame_parm_handlers[];
10589 static struct redisplay_interface x_redisplay_interface =
10591 x_frame_parm_handlers,
10592 x_produce_glyphs,
10593 x_write_glyphs,
10594 x_insert_glyphs,
10595 x_clear_end_of_line,
10596 x_scroll_run,
10597 x_after_update_window_line,
10598 x_update_window_begin,
10599 x_update_window_end,
10600 x_cursor_to,
10601 x_flush,
10602 #ifdef XFlush
10603 x_flush,
10604 #else
10605 0, /* flush_display_optional */
10606 #endif
10607 x_clear_window_mouse_face,
10608 x_get_glyph_overhangs,
10609 x_fix_overlapping_area,
10610 x_draw_fringe_bitmap,
10611 0, /* define_fringe_bitmap */
10612 0, /* destroy_fringe_bitmap */
10613 x_compute_glyph_string_overhangs,
10614 x_draw_glyph_string,
10615 x_define_frame_cursor,
10616 x_clear_frame_area,
10617 x_draw_window_cursor,
10618 x_draw_vertical_window_border,
10619 x_shift_glyphs_for_insert
10623 /* This function is called when the last frame on a display is deleted. */
10624 void
10625 x_delete_terminal (struct terminal *terminal)
10627 struct x_display_info *dpyinfo = terminal->display_info.x;
10628 int i;
10630 /* Protect against recursive calls. Fdelete_frame in
10631 delete_terminal calls us back when it deletes our last frame. */
10632 if (!terminal->name)
10633 return;
10635 BLOCK_INPUT;
10636 /* If called from x_connection_closed, the display may already be closed
10637 and dpyinfo->display was set to 0 to indicate that. */
10638 if (dpyinfo->display)
10640 x_destroy_all_bitmaps (dpyinfo);
10641 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10643 #ifdef USE_GTK
10644 xg_display_close (dpyinfo->display);
10645 #else
10646 #ifdef USE_X_TOOLKIT
10647 XtCloseDisplay (dpyinfo->display);
10648 #else
10649 XCloseDisplay (dpyinfo->display);
10650 #endif
10651 #endif /* ! USE_GTK */
10654 x_delete_display (dpyinfo);
10655 UNBLOCK_INPUT;
10658 /* Create a struct terminal, initialize it with the X11 specific
10659 functions and make DISPLAY->TERMINAL point to it. */
10661 static struct terminal *
10662 x_create_terminal (struct x_display_info *dpyinfo)
10664 struct terminal *terminal;
10666 terminal = create_terminal ();
10668 terminal->type = output_x_window;
10669 terminal->display_info.x = dpyinfo;
10670 dpyinfo->terminal = terminal;
10672 /* kboard is initialized in x_term_init. */
10674 terminal->clear_frame_hook = x_clear_frame;
10675 terminal->ins_del_lines_hook = x_ins_del_lines;
10676 terminal->delete_glyphs_hook = x_delete_glyphs;
10677 terminal->ring_bell_hook = XTring_bell;
10678 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10679 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10680 terminal->update_begin_hook = x_update_begin;
10681 terminal->update_end_hook = x_update_end;
10682 terminal->set_terminal_window_hook = XTset_terminal_window;
10683 terminal->read_socket_hook = XTread_socket;
10684 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10685 terminal->mouse_position_hook = XTmouse_position;
10686 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10687 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10688 terminal->fullscreen_hook = XTfullscreen_hook;
10689 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10690 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10691 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10692 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10694 terminal->delete_frame_hook = x_destroy_window;
10695 terminal->delete_terminal_hook = x_delete_terminal;
10697 terminal->rif = &x_redisplay_interface;
10698 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10699 terminal->char_ins_del_ok = 1;
10700 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10701 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10702 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10703 off the bottom. */
10705 return terminal;
10708 void
10709 x_initialize ()
10711 baud_rate = 19200;
10713 x_noop_count = 0;
10714 last_tool_bar_item = -1;
10715 any_help_event_p = 0;
10716 ignore_next_mouse_click_timeout = 0;
10717 #ifdef HAVE_X_SM
10718 x_session_initialized = 0;
10719 #endif
10721 #ifdef USE_GTK
10722 current_count = -1;
10723 #endif
10725 /* Try to use interrupt input; if we can't, then start polling. */
10726 Fset_input_interrupt_mode (Qt);
10728 #ifdef USE_X_TOOLKIT
10729 XtToolkitInitialize ();
10731 Xt_app_con = XtCreateApplicationContext ();
10733 /* Register a converter from strings to pixels, which uses
10734 Emacs' color allocation infrastructure. */
10735 XtAppSetTypeConverter (Xt_app_con,
10736 XtRString, XtRPixel, cvt_string_to_pixel,
10737 cvt_string_to_pixel_args,
10738 XtNumber (cvt_string_to_pixel_args),
10739 XtCacheByDisplay, cvt_pixel_dtor);
10741 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10742 #endif
10744 #ifdef USE_TOOLKIT_SCROLL_BARS
10745 #ifndef USE_GTK
10746 xaw3d_arrow_scroll = False;
10747 xaw3d_pick_top = True;
10748 #endif
10749 #endif
10751 /* Note that there is no real way portable across R3/R4 to get the
10752 original error handler. */
10753 XSetErrorHandler (x_error_handler);
10754 XSetIOErrorHandler (x_io_error_quitter);
10756 /* Disable Window Change signals; they are handled by X events. */
10757 #if 0 /* Don't. We may want to open tty frames later. */
10758 #ifdef SIGWINCH
10759 signal (SIGWINCH, SIG_DFL);
10760 #endif /* SIGWINCH */
10761 #endif
10763 signal (SIGPIPE, x_connection_signal);
10767 void
10768 syms_of_xterm ()
10770 x_error_message = NULL;
10772 staticpro (&x_display_name_list);
10773 x_display_name_list = Qnil;
10775 staticpro (&last_mouse_scroll_bar);
10776 last_mouse_scroll_bar = Qnil;
10778 staticpro (&Qvendor_specific_keysyms);
10779 Qvendor_specific_keysyms = intern ("vendor-specific-keysyms");
10781 staticpro (&Qlatin_1);
10782 Qlatin_1 = intern ("latin-1");
10784 staticpro (&last_mouse_press_frame);
10785 last_mouse_press_frame = Qnil;
10787 DEFVAR_BOOL ("x-use-underline-position-properties",
10788 &x_use_underline_position_properties,
10789 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10790 A value of nil means ignore them. If you encounter fonts with bogus
10791 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10792 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10793 to override the font's UNDERLINE_POSITION for small font display
10794 sizes. */);
10795 x_use_underline_position_properties = 1;
10797 DEFVAR_BOOL ("x-underline-at-descent-line",
10798 &x_underline_at_descent_line,
10799 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10800 A value of nil means to draw the underline according to the value of the
10801 variable `x-use-underline-position-properties', which is usually at the
10802 baseline level. The default value is nil. */);
10803 x_underline_at_descent_line = 0;
10805 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10806 &x_mouse_click_focus_ignore_position,
10807 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10808 This variable is only used when the window manager requires that you
10809 click on a frame to select it (give it focus). In that case, a value
10810 of nil, means that the selected window and cursor position changes to
10811 reflect the mouse click position, while a non-nil value means that the
10812 selected window or cursor position is preserved. */);
10813 x_mouse_click_focus_ignore_position = 0;
10815 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10816 doc: /* What X toolkit scroll bars Emacs uses.
10817 A value of nil means Emacs doesn't use X toolkit scroll bars.
10818 Otherwise, value is a symbol describing the X toolkit. */);
10819 #ifdef USE_TOOLKIT_SCROLL_BARS
10820 #ifdef USE_MOTIF
10821 Vx_toolkit_scroll_bars = intern ("motif");
10822 #elif defined HAVE_XAW3D
10823 Vx_toolkit_scroll_bars = intern ("xaw3d");
10824 #elif USE_GTK
10825 Vx_toolkit_scroll_bars = intern ("gtk");
10826 #else
10827 Vx_toolkit_scroll_bars = intern ("xaw");
10828 #endif
10829 #else
10830 Vx_toolkit_scroll_bars = Qnil;
10831 #endif
10833 staticpro (&last_mouse_motion_frame);
10834 last_mouse_motion_frame = Qnil;
10836 Qmodifier_value = intern ("modifier-value");
10837 Qalt = intern ("alt");
10838 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10839 Qhyper = intern ("hyper");
10840 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10841 Qmeta = intern ("meta");
10842 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10843 Qsuper = intern ("super");
10844 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10846 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10847 doc: /* Which keys Emacs uses for the alt modifier.
10848 This should be one of the symbols `alt', `hyper', `meta', `super'.
10849 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10850 is nil, which is the same as `alt'. */);
10851 Vx_alt_keysym = Qnil;
10853 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10854 doc: /* Which keys Emacs uses for the hyper modifier.
10855 This should be one of the symbols `alt', `hyper', `meta', `super'.
10856 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10857 default is nil, which is the same as `hyper'. */);
10858 Vx_hyper_keysym = Qnil;
10860 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10861 doc: /* Which keys Emacs uses for the meta modifier.
10862 This should be one of the symbols `alt', `hyper', `meta', `super'.
10863 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10864 default is nil, which is the same as `meta'. */);
10865 Vx_meta_keysym = Qnil;
10867 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10868 doc: /* Which keys Emacs uses for the super modifier.
10869 This should be one of the symbols `alt', `hyper', `meta', `super'.
10870 For example, `super' means use the Super_L and Super_R keysyms. The
10871 default is nil, which is the same as `super'. */);
10872 Vx_super_keysym = Qnil;
10874 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10875 doc: /* Hash table of character codes indexed by X keysym codes. */);
10876 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10877 make_float (DEFAULT_REHASH_SIZE),
10878 make_float (DEFAULT_REHASH_THRESHOLD),
10879 Qnil, Qnil, Qnil);
10882 #endif /* HAVE_X_WINDOWS */
10884 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10885 (do not change this comment) */