Rename .dir-settings.el to .dir-locals.
[emacs.git] / src / xterm.c
blob4d74910fec7fe21e61dbb45b69dc82eda8c802fe
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)
491 return;
492 else if (alpha > 1.0)
493 alpha = 1.0;
494 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
495 alpha = alpha_min;
497 opac = alpha * OPAQUE;
499 /* return unless necessary */
501 unsigned char *data;
502 Atom actual;
503 int rc, format;
504 unsigned long n, left;
506 x_catch_errors (dpy);
507 rc = XGetWindowProperty(dpy, win, XInternAtom(dpy, OPACITY, False),
508 0L, 1L, False, XA_CARDINAL,
509 &actual, &format, &n, &left,
510 &data);
512 if (rc == Success && actual != None)
513 if (*(unsigned long *)data == opac)
515 XFree ((void *) data);
516 x_uncatch_errors ();
517 return;
519 else
520 XFree ((void *) data);
521 x_uncatch_errors ();
524 x_catch_errors (dpy);
525 XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
526 XA_CARDINAL, 32, PropModeReplace,
527 (unsigned char *) &opac, 1L);
528 x_uncatch_errors ();
532 x_display_pixel_height (dpyinfo)
533 struct x_display_info *dpyinfo;
535 return HeightOfScreen (dpyinfo->screen);
539 x_display_pixel_width (dpyinfo)
540 struct x_display_info *dpyinfo;
542 return WidthOfScreen (dpyinfo->screen);
546 /***********************************************************************
547 Starting and ending an update
548 ***********************************************************************/
550 /* Start an update of frame F. This function is installed as a hook
551 for update_begin, i.e. it is called when update_begin is called.
552 This function is called prior to calls to x_update_window_begin for
553 each window being updated. Currently, there is nothing to do here
554 because all interesting stuff is done on a window basis. */
556 static void
557 x_update_begin (f)
558 struct frame *f;
560 /* Nothing to do. */
564 /* Start update of window W. Set the global variable updated_window
565 to the window being updated and set output_cursor to the cursor
566 position of W. */
568 static void
569 x_update_window_begin (w)
570 struct window *w;
572 struct frame *f = XFRAME (WINDOW_FRAME (w));
573 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
575 updated_window = w;
576 set_output_cursor (&w->cursor);
578 BLOCK_INPUT;
580 if (f == display_info->mouse_face_mouse_frame)
582 /* Don't do highlighting for mouse motion during the update. */
583 display_info->mouse_face_defer = 1;
585 /* If F needs to be redrawn, simply forget about any prior mouse
586 highlighting. */
587 if (FRAME_GARBAGED_P (f))
588 display_info->mouse_face_window = Qnil;
590 #if 0 /* Rows in a current matrix containing glyphs in mouse-face have
591 their mouse_face_p flag set, which means that they are always
592 unequal to rows in a desired matrix which never have that
593 flag set. So, rows containing mouse-face glyphs are never
594 scrolled, and we don't have to switch the mouse highlight off
595 here to prevent it from being scrolled. */
597 /* Can we tell that this update does not affect the window
598 where the mouse highlight is? If so, no need to turn off.
599 Likewise, don't do anything if the frame is garbaged;
600 in that case, the frame's current matrix that we would use
601 is all wrong, and we will redisplay that line anyway. */
602 if (!NILP (display_info->mouse_face_window)
603 && w == XWINDOW (display_info->mouse_face_window))
605 int i;
607 for (i = 0; i < w->desired_matrix->nrows; ++i)
608 if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
609 break;
611 if (i < w->desired_matrix->nrows)
612 clear_mouse_face (display_info);
614 #endif /* 0 */
617 UNBLOCK_INPUT;
621 /* Draw a vertical window border from (x,y0) to (x,y1) */
623 static void
624 x_draw_vertical_window_border (w, x, y0, y1)
625 struct window *w;
626 int x, y0, y1;
628 struct frame *f = XFRAME (WINDOW_FRAME (w));
629 struct face *face;
631 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
632 if (face)
633 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
634 face->foreground);
636 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
637 f->output_data.x->normal_gc, x, y0, x, y1);
640 /* End update of window W (which is equal to updated_window).
642 Draw vertical borders between horizontally adjacent windows, and
643 display W's cursor if CURSOR_ON_P is non-zero.
645 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
646 glyphs in mouse-face were overwritten. In that case we have to
647 make sure that the mouse-highlight is properly redrawn.
649 W may be a menu bar pseudo-window in case we don't have X toolkit
650 support. Such windows don't have a cursor, so don't display it
651 here. */
653 static void
654 x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
655 struct window *w;
656 int cursor_on_p, mouse_face_overwritten_p;
658 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
660 if (!w->pseudo_window_p)
662 BLOCK_INPUT;
664 if (cursor_on_p)
665 display_and_set_cursor (w, 1, output_cursor.hpos,
666 output_cursor.vpos,
667 output_cursor.x, output_cursor.y);
669 if (draw_window_fringes (w, 1))
670 x_draw_vertical_border (w);
672 UNBLOCK_INPUT;
675 /* If a row with mouse-face was overwritten, arrange for
676 XTframe_up_to_date to redisplay the mouse highlight. */
677 if (mouse_face_overwritten_p)
679 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
680 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
681 dpyinfo->mouse_face_window = Qnil;
684 updated_window = NULL;
688 /* End update of frame F. This function is installed as a hook in
689 update_end. */
691 static void
692 x_update_end (f)
693 struct frame *f;
695 /* Mouse highlight may be displayed again. */
696 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
698 #ifndef XFlush
699 BLOCK_INPUT;
700 XFlush (FRAME_X_DISPLAY (f));
701 UNBLOCK_INPUT;
702 #endif
706 /* This function is called from various places in xdisp.c whenever a
707 complete update has been performed. The global variable
708 updated_window is not available here. */
710 static void
711 XTframe_up_to_date (f)
712 struct frame *f;
714 if (FRAME_X_P (f))
716 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
718 if (dpyinfo->mouse_face_deferred_gc
719 || f == dpyinfo->mouse_face_mouse_frame)
721 BLOCK_INPUT;
722 if (dpyinfo->mouse_face_mouse_frame)
723 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
724 dpyinfo->mouse_face_mouse_x,
725 dpyinfo->mouse_face_mouse_y);
726 dpyinfo->mouse_face_deferred_gc = 0;
727 UNBLOCK_INPUT;
733 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
734 arrow bitmaps, or clear the fringes if no bitmaps are required
735 before DESIRED_ROW is made current. The window being updated is
736 found in updated_window. This function It is called from
737 update_window_line only if it is known that there are differences
738 between bitmaps to be drawn between current row and DESIRED_ROW. */
740 static void
741 x_after_update_window_line (desired_row)
742 struct glyph_row *desired_row;
744 struct window *w = updated_window;
745 struct frame *f;
746 int width, height;
748 xassert (w);
750 if (!desired_row->mode_line_p && !w->pseudo_window_p)
751 desired_row->redraw_fringe_bitmaps_p = 1;
753 /* When a window has disappeared, make sure that no rest of
754 full-width rows stays visible in the internal border. Could
755 check here if updated_window is the leftmost/rightmost window,
756 but I guess it's not worth doing since vertically split windows
757 are almost never used, internal border is rarely set, and the
758 overhead is very small. */
759 if (windows_or_buffers_changed
760 && desired_row->full_width_p
761 && (f = XFRAME (w->frame),
762 width = FRAME_INTERNAL_BORDER_WIDTH (f),
763 width != 0)
764 && (height = desired_row->visible_height,
765 height > 0))
767 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
769 /* Internal border is drawn below the tool bar. */
770 if (WINDOWP (f->tool_bar_window)
771 && w == XWINDOW (f->tool_bar_window))
772 y -= width;
774 BLOCK_INPUT;
775 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
776 0, y, width, height, False);
777 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
778 FRAME_PIXEL_WIDTH (f) - width,
779 y, width, height, False);
780 UNBLOCK_INPUT;
784 static void
785 x_draw_fringe_bitmap (w, row, p)
786 struct window *w;
787 struct glyph_row *row;
788 struct draw_fringe_bitmap_params *p;
790 struct frame *f = XFRAME (WINDOW_FRAME (w));
791 Display *display = FRAME_X_DISPLAY (f);
792 Window window = FRAME_X_WINDOW (f);
793 GC gc = f->output_data.x->normal_gc;
794 struct face *face = p->face;
795 int rowY;
797 /* Must clip because of partially visible lines. */
798 rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
799 if (p->y < rowY)
801 /* Adjust position of "bottom aligned" bitmap on partially
802 visible last row. */
803 int oldY = row->y;
804 int oldVH = row->visible_height;
805 row->visible_height = p->h;
806 row->y -= rowY - p->y;
807 x_clip_to_row (w, row, -1, gc);
808 row->y = oldY;
809 row->visible_height = oldVH;
811 else
812 x_clip_to_row (w, row, -1, gc);
814 if (!p->overlay_p)
816 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
818 /* In case the same realized face is used for fringes and
819 for something displayed in the text (e.g. face `region' on
820 mono-displays, the fill style may have been changed to
821 FillSolid in x_draw_glyph_string_background. */
822 if (face->stipple)
823 XSetFillStyle (display, face->gc, FillOpaqueStippled);
824 else
825 XSetForeground (display, face->gc, face->background);
827 #ifdef USE_TOOLKIT_SCROLL_BARS
828 /* If the fringe is adjacent to the left (right) scroll bar of a
829 leftmost (rightmost, respectively) window, then extend its
830 background to the gap between the fringe and the bar. */
831 if ((WINDOW_LEFTMOST_P (w)
832 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
833 || (WINDOW_RIGHTMOST_P (w)
834 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
836 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
838 if (sb_width > 0)
840 int left = WINDOW_SCROLL_BAR_AREA_X (w);
841 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
842 * FRAME_COLUMN_WIDTH (f));
844 if (bx < 0)
846 /* Bitmap fills the fringe. */
847 if (left + width == p->x)
848 bx = left + sb_width;
849 else if (p->x + p->wd == left)
850 bx = left;
851 if (bx >= 0)
853 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
855 nx = width - sb_width;
856 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
857 row->y));
858 ny = row->visible_height;
861 else
863 if (left + width == bx)
865 bx = left + sb_width;
866 nx += width - sb_width;
868 else if (bx + nx == left)
869 nx += width - sb_width;
873 #endif
874 if (bx >= 0 && nx > 0)
875 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
877 if (!face->stipple)
878 XSetForeground (display, face->gc, face->foreground);
881 if (p->which)
883 unsigned char *bits;
884 Pixmap pixmap, clipmask = (Pixmap) 0;
885 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
886 XGCValues gcv;
888 if (p->wd > 8)
889 bits = (unsigned char *)(p->bits + p->dh);
890 else
891 bits = (unsigned char *)p->bits + p->dh;
893 /* Draw the bitmap. I believe these small pixmaps can be cached
894 by the server. */
895 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
896 (p->cursor_p
897 ? (p->overlay_p ? face->background
898 : f->output_data.x->cursor_pixel)
899 : face->foreground),
900 face->background, depth);
902 if (p->overlay_p)
904 clipmask = XCreatePixmapFromBitmapData (display,
905 FRAME_X_DISPLAY_INFO (f)->root_window,
906 bits, p->wd, p->h,
907 1, 0, 1);
908 gcv.clip_mask = clipmask;
909 gcv.clip_x_origin = p->x;
910 gcv.clip_y_origin = p->y;
911 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
914 XCopyArea (display, pixmap, window, gc, 0, 0,
915 p->wd, p->h, p->x, p->y);
916 XFreePixmap (display, pixmap);
918 if (p->overlay_p)
920 gcv.clip_mask = (Pixmap) 0;
921 XChangeGC (display, gc, GCClipMask, &gcv);
922 XFreePixmap (display, clipmask);
926 XSetClipMask (display, gc, None);
931 /* This is called when starting Emacs and when restarting after
932 suspend. When starting Emacs, no X window is mapped. And nothing
933 must be done to Emacs's own window if it is suspended (though that
934 rarely happens). */
936 static void
937 XTset_terminal_modes (struct terminal *terminal)
941 /* This is called when exiting or suspending Emacs. Exiting will make
942 the X-windows go away, and suspending requires no action. */
944 static void
945 XTreset_terminal_modes (struct terminal *terminal)
950 /***********************************************************************
951 Glyph display
952 ***********************************************************************/
956 static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
957 static void x_set_glyph_string_gc P_ ((struct glyph_string *));
958 static void x_draw_glyph_string_background P_ ((struct glyph_string *,
959 int));
960 static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
961 static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
962 static void x_draw_glyph_string_box P_ ((struct glyph_string *));
963 static void x_draw_glyph_string P_ ((struct glyph_string *));
964 static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
965 static void x_set_cursor_gc P_ ((struct glyph_string *));
966 static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
967 static void x_set_mouse_face_gc P_ ((struct glyph_string *));
968 static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
969 unsigned long *, double, int));
970 static void x_setup_relief_color P_ ((struct frame *, struct relief *,
971 double, int, unsigned long));
972 static void x_setup_relief_colors P_ ((struct glyph_string *));
973 static void x_draw_image_glyph_string P_ ((struct glyph_string *));
974 static void x_draw_image_relief P_ ((struct glyph_string *));
975 static void x_draw_image_foreground P_ ((struct glyph_string *));
976 static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
977 static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
978 int, int, int));
979 static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
980 int, int, int, int, int, int,
981 XRectangle *));
982 static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
983 int, int, int, XRectangle *));
985 #if GLYPH_DEBUG
986 static void x_check_font P_ ((struct frame *, struct font *));
987 #endif
990 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
991 face. */
993 static void
994 x_set_cursor_gc (s)
995 struct glyph_string *s;
997 if (s->font == FRAME_FONT (s->f)
998 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
999 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
1000 && !s->cmp)
1001 s->gc = s->f->output_data.x->cursor_gc;
1002 else
1004 /* Cursor on non-default face: must merge. */
1005 XGCValues xgcv;
1006 unsigned long mask;
1008 xgcv.background = s->f->output_data.x->cursor_pixel;
1009 xgcv.foreground = s->face->background;
1011 /* If the glyph would be invisible, try a different foreground. */
1012 if (xgcv.foreground == xgcv.background)
1013 xgcv.foreground = s->face->foreground;
1014 if (xgcv.foreground == xgcv.background)
1015 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
1016 if (xgcv.foreground == xgcv.background)
1017 xgcv.foreground = s->face->foreground;
1019 /* Make sure the cursor is distinct from text in this face. */
1020 if (xgcv.background == s->face->background
1021 && xgcv.foreground == s->face->foreground)
1023 xgcv.background = s->face->foreground;
1024 xgcv.foreground = s->face->background;
1027 IF_DEBUG (x_check_font (s->f, s->font));
1028 xgcv.graphics_exposures = False;
1029 mask = GCForeground | GCBackground | GCGraphicsExposures;
1031 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1032 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1033 mask, &xgcv);
1034 else
1035 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1036 = XCreateGC (s->display, s->window, mask, &xgcv);
1038 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1043 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1045 static void
1046 x_set_mouse_face_gc (s)
1047 struct glyph_string *s;
1049 int face_id;
1050 struct face *face;
1052 /* What face has to be used last for the mouse face? */
1053 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1054 face = FACE_FROM_ID (s->f, face_id);
1055 if (face == NULL)
1056 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1058 if (s->first_glyph->type == CHAR_GLYPH)
1059 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1060 else
1061 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1062 s->face = FACE_FROM_ID (s->f, face_id);
1063 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1065 if (s->font == s->face->font)
1066 s->gc = s->face->gc;
1067 else
1069 /* Otherwise construct scratch_cursor_gc with values from FACE
1070 except for FONT. */
1071 XGCValues xgcv;
1072 unsigned long mask;
1074 xgcv.background = s->face->background;
1075 xgcv.foreground = s->face->foreground;
1076 xgcv.graphics_exposures = False;
1077 mask = GCForeground | GCBackground | GCGraphicsExposures;
1079 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1080 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1081 mask, &xgcv);
1082 else
1083 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1084 = XCreateGC (s->display, s->window, mask, &xgcv);
1086 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1089 xassert (s->gc != 0);
1093 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1094 Faces to use in the mode line have already been computed when the
1095 matrix was built, so there isn't much to do, here. */
1097 static INLINE void
1098 x_set_mode_line_face_gc (s)
1099 struct glyph_string *s;
1101 s->gc = s->face->gc;
1105 /* Set S->gc of glyph string S for drawing that glyph string. Set
1106 S->stippled_p to a non-zero value if the face of S has a stipple
1107 pattern. */
1109 static INLINE void
1110 x_set_glyph_string_gc (s)
1111 struct glyph_string *s;
1113 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1115 if (s->hl == DRAW_NORMAL_TEXT)
1117 s->gc = s->face->gc;
1118 s->stippled_p = s->face->stipple != 0;
1120 else if (s->hl == DRAW_INVERSE_VIDEO)
1122 x_set_mode_line_face_gc (s);
1123 s->stippled_p = s->face->stipple != 0;
1125 else if (s->hl == DRAW_CURSOR)
1127 x_set_cursor_gc (s);
1128 s->stippled_p = 0;
1130 else if (s->hl == DRAW_MOUSE_FACE)
1132 x_set_mouse_face_gc (s);
1133 s->stippled_p = s->face->stipple != 0;
1135 else if (s->hl == DRAW_IMAGE_RAISED
1136 || s->hl == DRAW_IMAGE_SUNKEN)
1138 s->gc = s->face->gc;
1139 s->stippled_p = s->face->stipple != 0;
1141 else
1143 s->gc = s->face->gc;
1144 s->stippled_p = s->face->stipple != 0;
1147 /* GC must have been set. */
1148 xassert (s->gc != 0);
1152 /* Set clipping for output of glyph string S. S may be part of a mode
1153 line or menu if we don't have X toolkit support. */
1155 static INLINE void
1156 x_set_glyph_string_clipping (s)
1157 struct glyph_string *s;
1159 XRectangle *r = s->clip;
1160 int n = get_glyph_string_clip_rects (s, r, 2);
1162 if (n > 0)
1163 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1164 s->num_clips = n;
1168 /* Set SRC's clipping for output of glyph string DST. This is called
1169 when we are drawing DST's left_overhang or right_overhang only in
1170 the area of SRC. */
1172 static void
1173 x_set_glyph_string_clipping_exactly (src, dst)
1174 struct glyph_string *src, *dst;
1176 XRectangle r;
1178 r.x = src->x;
1179 r.width = src->width;
1180 r.y = src->y;
1181 r.height = src->height;
1182 dst->clip[0] = r;
1183 dst->num_clips = 1;
1184 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1188 /* RIF:
1189 Compute left and right overhang of glyph string S. */
1191 static void
1192 x_compute_glyph_string_overhangs (s)
1193 struct glyph_string *s;
1195 if (s->cmp == NULL
1196 && s->first_glyph->type == CHAR_GLYPH)
1198 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1199 struct font *font = s->font;
1200 struct font_metrics metrics;
1201 int i;
1203 for (i = 0; i < s->nchars; i++)
1204 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1205 font->driver->text_extents (font, code, s->nchars, &metrics);
1206 s->right_overhang = (metrics.rbearing > metrics.width
1207 ? metrics.rbearing - metrics.width : 0);
1208 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1210 else if (s->cmp)
1212 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1213 s->left_overhang = - s->cmp->lbearing;
1218 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1220 static INLINE void
1221 x_clear_glyph_string_rect (s, x, y, w, h)
1222 struct glyph_string *s;
1223 int x, y, w, h;
1225 XGCValues xgcv;
1226 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1227 XSetForeground (s->display, s->gc, xgcv.background);
1228 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1229 XSetForeground (s->display, s->gc, xgcv.foreground);
1233 /* Draw the background of glyph_string S. If S->background_filled_p
1234 is non-zero don't draw it. FORCE_P non-zero means draw the
1235 background even if it wouldn't be drawn normally. This is used
1236 when a string preceding S draws into the background of S, or S
1237 contains the first component of a composition. */
1239 static void
1240 x_draw_glyph_string_background (s, force_p)
1241 struct glyph_string *s;
1242 int force_p;
1244 /* Nothing to do if background has already been drawn or if it
1245 shouldn't be drawn in the first place. */
1246 if (!s->background_filled_p)
1248 int box_line_width = max (s->face->box_line_width, 0);
1250 if (s->stippled_p)
1252 /* Fill background with a stipple pattern. */
1253 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1254 XFillRectangle (s->display, s->window, s->gc, s->x,
1255 s->y + box_line_width,
1256 s->background_width,
1257 s->height - 2 * box_line_width);
1258 XSetFillStyle (s->display, s->gc, FillSolid);
1259 s->background_filled_p = 1;
1261 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1262 || s->font_not_found_p
1263 || s->extends_to_end_of_line_p
1264 || force_p)
1266 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1267 s->background_width,
1268 s->height - 2 * box_line_width);
1269 s->background_filled_p = 1;
1275 /* Draw the foreground of glyph string S. */
1277 static void
1278 x_draw_glyph_string_foreground (s)
1279 struct glyph_string *s;
1281 int i, x;
1283 /* If first glyph of S has a left box line, start drawing the text
1284 of S to the right of that box line. */
1285 if (s->face->box != FACE_NO_BOX
1286 && s->first_glyph->left_box_line_p)
1287 x = s->x + eabs (s->face->box_line_width);
1288 else
1289 x = s->x;
1291 /* Draw characters of S as rectangles if S's font could not be
1292 loaded. */
1293 if (s->font_not_found_p)
1295 for (i = 0; i < s->nchars; ++i)
1297 struct glyph *g = s->first_glyph + i;
1298 XDrawRectangle (s->display, s->window,
1299 s->gc, x, s->y, g->pixel_width - 1,
1300 s->height - 1);
1301 x += g->pixel_width;
1304 else
1306 struct font *font = s->font;
1307 int boff = font->baseline_offset;
1308 int y;
1310 if (font->vertical_centering)
1311 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1313 y = s->ybase - boff;
1314 if (s->for_overlaps
1315 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1316 font->driver->draw (s, 0, s->nchars, x, y, 0);
1317 else
1318 font->driver->draw (s, 0, s->nchars, x, y, 1);
1319 if (s->face->overstrike)
1320 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1324 /* Draw the foreground of composite glyph string S. */
1326 static void
1327 x_draw_composite_glyph_string_foreground (s)
1328 struct glyph_string *s;
1330 int i, j, x;
1331 struct font *font = s->font;
1333 /* If first glyph of S has a left box line, start drawing the text
1334 of S to the right of that box line. */
1335 if (s->face && s->face->box != FACE_NO_BOX
1336 && s->first_glyph->left_box_line_p)
1337 x = s->x + eabs (s->face->box_line_width);
1338 else
1339 x = s->x;
1341 /* S is a glyph string for a composition. S->cmp_from is the index
1342 of the first character drawn for glyphs of this composition.
1343 S->cmp_from == 0 means we are drawing the very first character of
1344 this composition. */
1346 /* Draw a rectangle for the composition if the font for the very
1347 first character of the composition could not be loaded. */
1348 if (s->font_not_found_p)
1350 if (s->cmp_from == 0)
1351 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1352 s->width - 1, s->height - 1);
1354 else if (! s->first_glyph->u.cmp.automatic)
1356 int y = s->ybase;
1358 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1359 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1361 int xx = x + s->cmp->offsets[j * 2];
1362 int yy = y - s->cmp->offsets[j * 2 + 1];
1364 font->driver->draw (s, j, j + 1, xx, yy, 0);
1365 if (s->face->overstrike)
1366 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1369 else
1371 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1372 Lisp_Object glyph;
1373 int y = s->ybase;
1374 int width = 0;
1376 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1378 glyph = LGSTRING_GLYPH (gstring, i);
1379 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1380 width += LGLYPH_WIDTH (glyph);
1381 else
1383 int xoff, yoff, wadjust;
1385 if (j < i)
1387 font->driver->draw (s, j, i, x, y, 0);
1388 x += width;
1390 xoff = LGLYPH_XOFF (glyph);
1391 yoff = LGLYPH_YOFF (glyph);
1392 wadjust = LGLYPH_WADJUST (glyph);
1393 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1394 x += wadjust;
1395 j = i + 1;
1396 width = 0;
1399 if (j < i)
1400 font->driver->draw (s, j, i, x, y, 0);
1405 #ifdef USE_X_TOOLKIT
1407 static struct frame *x_frame_of_widget P_ ((Widget));
1408 static Boolean cvt_string_to_pixel P_ ((Display *, XrmValue *, Cardinal *,
1409 XrmValue *, XrmValue *, XtPointer *));
1410 static void cvt_pixel_dtor P_ ((XtAppContext, XrmValue *, XtPointer,
1411 XrmValue *, Cardinal *));
1414 /* Return the frame on which widget WIDGET is used.. Abort if frame
1415 cannot be determined. */
1417 static struct frame *
1418 x_frame_of_widget (widget)
1419 Widget widget;
1421 struct x_display_info *dpyinfo;
1422 Lisp_Object tail;
1423 struct frame *f;
1425 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1427 /* Find the top-level shell of the widget. Note that this function
1428 can be called when the widget is not yet realized, so XtWindow
1429 (widget) == 0. That's the reason we can't simply use
1430 x_any_window_to_frame. */
1431 while (!XtIsTopLevelShell (widget))
1432 widget = XtParent (widget);
1434 /* Look for a frame with that top-level widget. Allocate the color
1435 on that frame to get the right gamma correction value. */
1436 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1437 if (FRAMEP (XCAR (tail))
1438 && (f = XFRAME (XCAR (tail)),
1439 (FRAME_X_P (f)
1440 && f->output_data.nothing != 1
1441 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1442 && f->output_data.x->widget == widget)
1443 return f;
1445 abort ();
1449 /* Allocate the color COLOR->pixel on the screen and display of
1450 widget WIDGET in colormap CMAP. If an exact match cannot be
1451 allocated, try the nearest color available. Value is non-zero
1452 if successful. This is called from lwlib. */
1455 x_alloc_nearest_color_for_widget (widget, cmap, color)
1456 Widget widget;
1457 Colormap cmap;
1458 XColor *color;
1460 struct frame *f = x_frame_of_widget (widget);
1461 return x_alloc_nearest_color (f, cmap, color);
1465 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1466 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1467 If this produces the same color as PIXEL, try a color where all RGB
1468 values have DELTA added. Return the allocated color in *PIXEL.
1469 DISPLAY is the X display, CMAP is the colormap to operate on.
1470 Value is non-zero if successful. */
1473 x_alloc_lighter_color_for_widget (widget, display, cmap, pixel, factor, delta)
1474 Widget widget;
1475 Display *display;
1476 Colormap cmap;
1477 unsigned long *pixel;
1478 double factor;
1479 int delta;
1481 struct frame *f = x_frame_of_widget (widget);
1482 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1486 /* Structure specifying which arguments should be passed by Xt to
1487 cvt_string_to_pixel. We want the widget's screen and colormap. */
1489 static XtConvertArgRec cvt_string_to_pixel_args[] =
1491 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1492 sizeof (Screen *)},
1493 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1494 sizeof (Colormap)}
1498 /* The address of this variable is returned by
1499 cvt_string_to_pixel. */
1501 static Pixel cvt_string_to_pixel_value;
1504 /* Convert a color name to a pixel color.
1506 DPY is the display we are working on.
1508 ARGS is an array of *NARGS XrmValue structures holding additional
1509 information about the widget for which the conversion takes place.
1510 The contents of this array are determined by the specification
1511 in cvt_string_to_pixel_args.
1513 FROM is a pointer to an XrmValue which points to the color name to
1514 convert. TO is an XrmValue in which to return the pixel color.
1516 CLOSURE_RET is a pointer to user-data, in which we record if
1517 we allocated the color or not.
1519 Value is True if successful, False otherwise. */
1521 static Boolean
1522 cvt_string_to_pixel (dpy, args, nargs, from, to, closure_ret)
1523 Display *dpy;
1524 XrmValue *args;
1525 Cardinal *nargs;
1526 XrmValue *from, *to;
1527 XtPointer *closure_ret;
1529 Screen *screen;
1530 Colormap cmap;
1531 Pixel pixel;
1532 String color_name;
1533 XColor color;
1535 if (*nargs != 2)
1537 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1538 "wrongParameters", "cvt_string_to_pixel",
1539 "XtToolkitError",
1540 "Screen and colormap args required", NULL, NULL);
1541 return False;
1544 screen = *(Screen **) args[0].addr;
1545 cmap = *(Colormap *) args[1].addr;
1546 color_name = (String) from->addr;
1548 if (strcmp (color_name, XtDefaultBackground) == 0)
1550 *closure_ret = (XtPointer) False;
1551 pixel = WhitePixelOfScreen (screen);
1553 else if (strcmp (color_name, XtDefaultForeground) == 0)
1555 *closure_ret = (XtPointer) False;
1556 pixel = BlackPixelOfScreen (screen);
1558 else if (XParseColor (dpy, cmap, color_name, &color)
1559 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1561 pixel = color.pixel;
1562 *closure_ret = (XtPointer) True;
1564 else
1566 String params[1];
1567 Cardinal nparams = 1;
1569 params[0] = color_name;
1570 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1571 "badValue", "cvt_string_to_pixel",
1572 "XtToolkitError", "Invalid color `%s'",
1573 params, &nparams);
1574 return False;
1577 if (to->addr != NULL)
1579 if (to->size < sizeof (Pixel))
1581 to->size = sizeof (Pixel);
1582 return False;
1585 *(Pixel *) to->addr = pixel;
1587 else
1589 cvt_string_to_pixel_value = pixel;
1590 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1593 to->size = sizeof (Pixel);
1594 return True;
1598 /* Free a pixel color which was previously allocated via
1599 cvt_string_to_pixel. This is registered as the destructor
1600 for this type of resource via XtSetTypeConverter.
1602 APP is the application context in which we work.
1604 TO is a pointer to an XrmValue holding the color to free.
1605 CLOSURE is the value we stored in CLOSURE_RET for this color
1606 in cvt_string_to_pixel.
1608 ARGS and NARGS are like for cvt_string_to_pixel. */
1610 static void
1611 cvt_pixel_dtor (app, to, closure, args, nargs)
1612 XtAppContext app;
1613 XrmValuePtr to;
1614 XtPointer closure;
1615 XrmValuePtr args;
1616 Cardinal *nargs;
1618 if (*nargs != 2)
1620 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1621 "XtToolkitError",
1622 "Screen and colormap arguments required",
1623 NULL, NULL);
1625 else if (closure != NULL)
1627 /* We did allocate the pixel, so free it. */
1628 Screen *screen = *(Screen **) args[0].addr;
1629 Colormap cmap = *(Colormap *) args[1].addr;
1630 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1631 (Pixel *) to->addr, 1);
1636 #endif /* USE_X_TOOLKIT */
1639 /* Value is an array of XColor structures for the contents of the
1640 color map of display DPY. Set *NCELLS to the size of the array.
1641 Note that this probably shouldn't be called for large color maps,
1642 say a 24-bit TrueColor map. */
1644 static const XColor *
1645 x_color_cells (dpy, ncells)
1646 Display *dpy;
1647 int *ncells;
1649 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1651 if (dpyinfo->color_cells == NULL)
1653 Screen *screen = dpyinfo->screen;
1654 int i;
1656 dpyinfo->ncolor_cells
1657 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1658 dpyinfo->color_cells
1659 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1660 * sizeof *dpyinfo->color_cells);
1662 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1663 dpyinfo->color_cells[i].pixel = i;
1665 XQueryColors (dpy, dpyinfo->cmap,
1666 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1669 *ncells = dpyinfo->ncolor_cells;
1670 return dpyinfo->color_cells;
1674 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1675 colors in COLORS. Use cached information, if available. */
1677 void
1678 x_query_colors (f, colors, ncolors)
1679 struct frame *f;
1680 XColor *colors;
1681 int ncolors;
1683 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1685 if (dpyinfo->color_cells)
1687 int i;
1688 for (i = 0; i < ncolors; ++i)
1690 unsigned long pixel = colors[i].pixel;
1691 xassert (pixel < dpyinfo->ncolor_cells);
1692 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1693 colors[i] = dpyinfo->color_cells[pixel];
1696 else
1697 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1701 /* On frame F, translate pixel color to RGB values for the color in
1702 COLOR. Use cached information, if available. */
1704 void
1705 x_query_color (f, color)
1706 struct frame *f;
1707 XColor *color;
1709 x_query_colors (f, color, 1);
1713 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1714 exact match can't be allocated, try the nearest color available.
1715 Value is non-zero if successful. Set *COLOR to the color
1716 allocated. */
1718 static int
1719 x_alloc_nearest_color_1 (dpy, cmap, color)
1720 Display *dpy;
1721 Colormap cmap;
1722 XColor *color;
1724 int rc;
1726 rc = XAllocColor (dpy, cmap, color);
1727 if (rc == 0)
1729 /* If we got to this point, the colormap is full, so we're going
1730 to try to get the next closest color. The algorithm used is
1731 a least-squares matching, which is what X uses for closest
1732 color matching with StaticColor visuals. */
1733 int nearest, i;
1734 unsigned long nearest_delta = ~0;
1735 int ncells;
1736 const XColor *cells = x_color_cells (dpy, &ncells);
1738 for (nearest = i = 0; i < ncells; ++i)
1740 long dred = (color->red >> 8) - (cells[i].red >> 8);
1741 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1742 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1743 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1745 if (delta < nearest_delta)
1747 nearest = i;
1748 nearest_delta = delta;
1752 color->red = cells[nearest].red;
1753 color->green = cells[nearest].green;
1754 color->blue = cells[nearest].blue;
1755 rc = XAllocColor (dpy, cmap, color);
1757 else
1759 /* If allocation succeeded, and the allocated pixel color is not
1760 equal to a cached pixel color recorded earlier, there was a
1761 change in the colormap, so clear the color cache. */
1762 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1763 XColor *cached_color;
1765 if (dpyinfo->color_cells
1766 && (cached_color = &dpyinfo->color_cells[color->pixel],
1767 (cached_color->red != color->red
1768 || cached_color->blue != color->blue
1769 || cached_color->green != color->green)))
1771 xfree (dpyinfo->color_cells);
1772 dpyinfo->color_cells = NULL;
1773 dpyinfo->ncolor_cells = 0;
1777 #ifdef DEBUG_X_COLORS
1778 if (rc)
1779 register_color (color->pixel);
1780 #endif /* DEBUG_X_COLORS */
1782 return rc;
1786 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1787 exact match can't be allocated, try the nearest color available.
1788 Value is non-zero if successful. Set *COLOR to the color
1789 allocated. */
1792 x_alloc_nearest_color (f, cmap, color)
1793 struct frame *f;
1794 Colormap cmap;
1795 XColor *color;
1797 gamma_correct (f, color);
1798 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1802 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1803 It's necessary to do this instead of just using PIXEL directly to
1804 get color reference counts right. */
1806 unsigned long
1807 x_copy_color (f, pixel)
1808 struct frame *f;
1809 unsigned long pixel;
1811 XColor color;
1813 color.pixel = pixel;
1814 BLOCK_INPUT;
1815 x_query_color (f, &color);
1816 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1817 UNBLOCK_INPUT;
1818 #ifdef DEBUG_X_COLORS
1819 register_color (pixel);
1820 #endif
1821 return color.pixel;
1825 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1826 It's necessary to do this instead of just using PIXEL directly to
1827 get color reference counts right. */
1829 unsigned long
1830 x_copy_dpy_color (dpy, cmap, pixel)
1831 Display *dpy;
1832 Colormap cmap;
1833 unsigned long pixel;
1835 XColor color;
1837 color.pixel = pixel;
1838 BLOCK_INPUT;
1839 XQueryColor (dpy, cmap, &color);
1840 XAllocColor (dpy, cmap, &color);
1841 UNBLOCK_INPUT;
1842 #ifdef DEBUG_X_COLORS
1843 register_color (pixel);
1844 #endif
1845 return color.pixel;
1849 /* Brightness beyond which a color won't have its highlight brightness
1850 boosted.
1852 Nominally, highlight colors for `3d' faces are calculated by
1853 brightening an object's color by a constant scale factor, but this
1854 doesn't yield good results for dark colors, so for colors who's
1855 brightness is less than this value (on a scale of 0-65535) have an
1856 use an additional additive factor.
1858 The value here is set so that the default menu-bar/mode-line color
1859 (grey75) will not have its highlights changed at all. */
1860 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1863 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1864 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1865 If this produces the same color as PIXEL, try a color where all RGB
1866 values have DELTA added. Return the allocated color in *PIXEL.
1867 DISPLAY is the X display, CMAP is the colormap to operate on.
1868 Value is non-zero if successful. */
1870 static int
1871 x_alloc_lighter_color (f, display, cmap, pixel, factor, delta)
1872 struct frame *f;
1873 Display *display;
1874 Colormap cmap;
1875 unsigned long *pixel;
1876 double factor;
1877 int delta;
1879 XColor color, new;
1880 long bright;
1881 int success_p;
1883 /* Get RGB color values. */
1884 color.pixel = *pixel;
1885 x_query_color (f, &color);
1887 /* Change RGB values by specified FACTOR. Avoid overflow! */
1888 xassert (factor >= 0);
1889 new.red = min (0xffff, factor * color.red);
1890 new.green = min (0xffff, factor * color.green);
1891 new.blue = min (0xffff, factor * color.blue);
1893 /* Calculate brightness of COLOR. */
1894 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1896 /* We only boost colors that are darker than
1897 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1898 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1899 /* Make an additive adjustment to NEW, because it's dark enough so
1900 that scaling by FACTOR alone isn't enough. */
1902 /* How far below the limit this color is (0 - 1, 1 being darker). */
1903 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1904 /* The additive adjustment. */
1905 int min_delta = delta * dimness * factor / 2;
1907 if (factor < 1)
1909 new.red = max (0, new.red - min_delta);
1910 new.green = max (0, new.green - min_delta);
1911 new.blue = max (0, new.blue - min_delta);
1913 else
1915 new.red = min (0xffff, min_delta + new.red);
1916 new.green = min (0xffff, min_delta + new.green);
1917 new.blue = min (0xffff, min_delta + new.blue);
1921 /* Try to allocate the color. */
1922 success_p = x_alloc_nearest_color (f, cmap, &new);
1923 if (success_p)
1925 if (new.pixel == *pixel)
1927 /* If we end up with the same color as before, try adding
1928 delta to the RGB values. */
1929 x_free_colors (f, &new.pixel, 1);
1931 new.red = min (0xffff, delta + color.red);
1932 new.green = min (0xffff, delta + color.green);
1933 new.blue = min (0xffff, delta + color.blue);
1934 success_p = x_alloc_nearest_color (f, cmap, &new);
1936 else
1937 success_p = 1;
1938 *pixel = new.pixel;
1941 return success_p;
1945 /* Set up the foreground color for drawing relief lines of glyph
1946 string S. RELIEF is a pointer to a struct relief containing the GC
1947 with which lines will be drawn. Use a color that is FACTOR or
1948 DELTA lighter or darker than the relief's background which is found
1949 in S->f->output_data.x->relief_background. If such a color cannot
1950 be allocated, use DEFAULT_PIXEL, instead. */
1952 static void
1953 x_setup_relief_color (f, relief, factor, delta, default_pixel)
1954 struct frame *f;
1955 struct relief *relief;
1956 double factor;
1957 int delta;
1958 unsigned long default_pixel;
1960 XGCValues xgcv;
1961 struct x_output *di = f->output_data.x;
1962 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1963 unsigned long pixel;
1964 unsigned long background = di->relief_background;
1965 Colormap cmap = FRAME_X_COLORMAP (f);
1966 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1967 Display *dpy = FRAME_X_DISPLAY (f);
1969 xgcv.graphics_exposures = False;
1970 xgcv.line_width = 1;
1972 /* Free previously allocated color. The color cell will be reused
1973 when it has been freed as many times as it was allocated, so this
1974 doesn't affect faces using the same colors. */
1975 if (relief->gc
1976 && relief->allocated_p)
1978 x_free_colors (f, &relief->pixel, 1);
1979 relief->allocated_p = 0;
1982 /* Allocate new color. */
1983 xgcv.foreground = default_pixel;
1984 pixel = background;
1985 if (dpyinfo->n_planes != 1
1986 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1988 relief->allocated_p = 1;
1989 xgcv.foreground = relief->pixel = pixel;
1992 if (relief->gc == 0)
1994 xgcv.stipple = dpyinfo->gray;
1995 mask |= GCStipple;
1996 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1998 else
1999 XChangeGC (dpy, relief->gc, mask, &xgcv);
2003 /* Set up colors for the relief lines around glyph string S. */
2005 static void
2006 x_setup_relief_colors (s)
2007 struct glyph_string *s;
2009 struct x_output *di = s->f->output_data.x;
2010 unsigned long color;
2012 if (s->face->use_box_color_for_shadows_p)
2013 color = s->face->box_color;
2014 else if (s->first_glyph->type == IMAGE_GLYPH
2015 && s->img->pixmap
2016 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2017 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2018 else
2020 XGCValues xgcv;
2022 /* Get the background color of the face. */
2023 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2024 color = xgcv.background;
2027 if (di->white_relief.gc == 0
2028 || color != di->relief_background)
2030 di->relief_background = color;
2031 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2032 WHITE_PIX_DEFAULT (s->f));
2033 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2034 BLACK_PIX_DEFAULT (s->f));
2039 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2040 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2041 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2042 relief. LEFT_P non-zero means draw a relief on the left side of
2043 the rectangle. RIGHT_P non-zero means draw a relief on the right
2044 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2045 when drawing. */
2047 static void
2048 x_draw_relief_rect (f, left_x, top_y, right_x, bottom_y, width,
2049 raised_p, top_p, bot_p, left_p, right_p, clip_rect)
2050 struct frame *f;
2051 int left_x, top_y, right_x, bottom_y, width;
2052 int top_p, bot_p, left_p, right_p, raised_p;
2053 XRectangle *clip_rect;
2055 Display *dpy = FRAME_X_DISPLAY (f);
2056 Window window = FRAME_X_WINDOW (f);
2057 int i;
2058 GC gc;
2060 if (raised_p)
2061 gc = f->output_data.x->white_relief.gc;
2062 else
2063 gc = f->output_data.x->black_relief.gc;
2064 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2066 /* Top. */
2067 if (top_p)
2068 for (i = 0; i < width; ++i)
2069 XDrawLine (dpy, window, gc,
2070 left_x + i * left_p, top_y + i,
2071 right_x + 1 - i * right_p, top_y + i);
2073 /* Left. */
2074 if (left_p)
2075 for (i = 0; i < width; ++i)
2076 XDrawLine (dpy, window, gc,
2077 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2079 XSetClipMask (dpy, gc, None);
2080 if (raised_p)
2081 gc = f->output_data.x->black_relief.gc;
2082 else
2083 gc = f->output_data.x->white_relief.gc;
2084 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2086 /* Bottom. */
2087 if (bot_p)
2088 for (i = 0; i < width; ++i)
2089 XDrawLine (dpy, window, gc,
2090 left_x + i * left_p, bottom_y - i,
2091 right_x + 1 - i * right_p, bottom_y - i);
2093 /* Right. */
2094 if (right_p)
2095 for (i = 0; i < width; ++i)
2096 XDrawLine (dpy, window, gc,
2097 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2099 XSetClipMask (dpy, gc, None);
2103 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2104 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2105 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2106 left side of the rectangle. RIGHT_P non-zero means draw a line
2107 on the right side of the rectangle. CLIP_RECT is the clipping
2108 rectangle to use when drawing. */
2110 static void
2111 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2112 left_p, right_p, clip_rect)
2113 struct glyph_string *s;
2114 int left_x, top_y, right_x, bottom_y, width, left_p, right_p;
2115 XRectangle *clip_rect;
2117 XGCValues xgcv;
2119 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2120 XSetForeground (s->display, s->gc, s->face->box_color);
2121 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2123 /* Top. */
2124 XFillRectangle (s->display, s->window, s->gc,
2125 left_x, top_y, right_x - left_x + 1, width);
2127 /* Left. */
2128 if (left_p)
2129 XFillRectangle (s->display, s->window, s->gc,
2130 left_x, top_y, width, bottom_y - top_y + 1);
2132 /* Bottom. */
2133 XFillRectangle (s->display, s->window, s->gc,
2134 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2136 /* Right. */
2137 if (right_p)
2138 XFillRectangle (s->display, s->window, s->gc,
2139 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2141 XSetForeground (s->display, s->gc, xgcv.foreground);
2142 XSetClipMask (s->display, s->gc, None);
2146 /* Draw a box around glyph string S. */
2148 static void
2149 x_draw_glyph_string_box (s)
2150 struct glyph_string *s;
2152 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2153 int left_p, right_p;
2154 struct glyph *last_glyph;
2155 XRectangle clip_rect;
2157 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2158 ? WINDOW_RIGHT_EDGE_X (s->w)
2159 : window_box_right (s->w, s->area));
2161 /* The glyph that may have a right box line. */
2162 last_glyph = (s->cmp || s->img
2163 ? s->first_glyph
2164 : s->first_glyph + s->nchars - 1);
2166 width = eabs (s->face->box_line_width);
2167 raised_p = s->face->box == FACE_RAISED_BOX;
2168 left_x = s->x;
2169 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2170 ? last_x - 1
2171 : min (last_x, s->x + s->background_width) - 1);
2172 top_y = s->y;
2173 bottom_y = top_y + s->height - 1;
2175 left_p = (s->first_glyph->left_box_line_p
2176 || (s->hl == DRAW_MOUSE_FACE
2177 && (s->prev == NULL
2178 || s->prev->hl != s->hl)));
2179 right_p = (last_glyph->right_box_line_p
2180 || (s->hl == DRAW_MOUSE_FACE
2181 && (s->next == NULL
2182 || s->next->hl != s->hl)));
2184 get_glyph_string_clip_rect (s, &clip_rect);
2186 if (s->face->box == FACE_SIMPLE_BOX)
2187 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2188 left_p, right_p, &clip_rect);
2189 else
2191 x_setup_relief_colors (s);
2192 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2193 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2198 /* Draw foreground of image glyph string S. */
2200 static void
2201 x_draw_image_foreground (s)
2202 struct glyph_string *s;
2204 int x = s->x;
2205 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2207 /* If first glyph of S has a left box line, start drawing it to the
2208 right of that line. */
2209 if (s->face->box != FACE_NO_BOX
2210 && s->first_glyph->left_box_line_p
2211 && s->slice.x == 0)
2212 x += eabs (s->face->box_line_width);
2214 /* If there is a margin around the image, adjust x- and y-position
2215 by that margin. */
2216 if (s->slice.x == 0)
2217 x += s->img->hmargin;
2218 if (s->slice.y == 0)
2219 y += s->img->vmargin;
2221 if (s->img->pixmap)
2223 if (s->img->mask)
2225 /* We can't set both a clip mask and use XSetClipRectangles
2226 because the latter also sets a clip mask. We also can't
2227 trust on the shape extension to be available
2228 (XShapeCombineRegion). So, compute the rectangle to draw
2229 manually. */
2230 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2231 | GCFunction);
2232 XGCValues xgcv;
2233 XRectangle clip_rect, image_rect, r;
2235 xgcv.clip_mask = s->img->mask;
2236 xgcv.clip_x_origin = x;
2237 xgcv.clip_y_origin = y;
2238 xgcv.function = GXcopy;
2239 XChangeGC (s->display, s->gc, mask, &xgcv);
2241 get_glyph_string_clip_rect (s, &clip_rect);
2242 image_rect.x = x;
2243 image_rect.y = y;
2244 image_rect.width = s->slice.width;
2245 image_rect.height = s->slice.height;
2246 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2247 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2248 s->slice.x + r.x - x, s->slice.y + r.y - y,
2249 r.width, r.height, r.x, r.y);
2251 else
2253 XRectangle clip_rect, image_rect, r;
2255 get_glyph_string_clip_rect (s, &clip_rect);
2256 image_rect.x = x;
2257 image_rect.y = y;
2258 image_rect.width = s->slice.width;
2259 image_rect.height = s->slice.height;
2260 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2261 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2262 s->slice.x + r.x - x, s->slice.y + r.y - y,
2263 r.width, r.height, r.x, r.y);
2265 /* When the image has a mask, we can expect that at
2266 least part of a mouse highlight or a block cursor will
2267 be visible. If the image doesn't have a mask, make
2268 a block cursor visible by drawing a rectangle around
2269 the image. I believe it's looking better if we do
2270 nothing here for mouse-face. */
2271 if (s->hl == DRAW_CURSOR)
2273 int r = s->img->relief;
2274 if (r < 0) r = -r;
2275 XDrawRectangle (s->display, s->window, s->gc,
2276 x - r, y - r,
2277 s->slice.width + r*2 - 1,
2278 s->slice.height + r*2 - 1);
2282 else
2283 /* Draw a rectangle if image could not be loaded. */
2284 XDrawRectangle (s->display, s->window, s->gc, x, y,
2285 s->slice.width - 1, s->slice.height - 1);
2289 /* Draw a relief around the image glyph string S. */
2291 static void
2292 x_draw_image_relief (s)
2293 struct glyph_string *s;
2295 int x0, y0, x1, y1, thick, raised_p;
2296 XRectangle r;
2297 int x = s->x;
2298 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2300 /* If first glyph of S has a left box line, start drawing it to the
2301 right of that line. */
2302 if (s->face->box != FACE_NO_BOX
2303 && s->first_glyph->left_box_line_p
2304 && s->slice.x == 0)
2305 x += eabs (s->face->box_line_width);
2307 /* If there is a margin around the image, adjust x- and y-position
2308 by that margin. */
2309 if (s->slice.x == 0)
2310 x += s->img->hmargin;
2311 if (s->slice.y == 0)
2312 y += s->img->vmargin;
2314 if (s->hl == DRAW_IMAGE_SUNKEN
2315 || s->hl == DRAW_IMAGE_RAISED)
2317 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2318 raised_p = s->hl == DRAW_IMAGE_RAISED;
2320 else
2322 thick = eabs (s->img->relief);
2323 raised_p = s->img->relief > 0;
2326 x0 = x - thick;
2327 y0 = y - thick;
2328 x1 = x + s->slice.width + thick - 1;
2329 y1 = y + s->slice.height + thick - 1;
2331 x_setup_relief_colors (s);
2332 get_glyph_string_clip_rect (s, &r);
2333 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2334 s->slice.y == 0,
2335 s->slice.y + s->slice.height == s->img->height,
2336 s->slice.x == 0,
2337 s->slice.x + s->slice.width == s->img->width,
2338 &r);
2342 /* Draw the foreground of image glyph string S to PIXMAP. */
2344 static void
2345 x_draw_image_foreground_1 (s, pixmap)
2346 struct glyph_string *s;
2347 Pixmap pixmap;
2349 int x = 0;
2350 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2352 /* If first glyph of S has a left box line, start drawing it to the
2353 right of that line. */
2354 if (s->face->box != FACE_NO_BOX
2355 && s->first_glyph->left_box_line_p
2356 && s->slice.x == 0)
2357 x += eabs (s->face->box_line_width);
2359 /* If there is a margin around the image, adjust x- and y-position
2360 by that margin. */
2361 if (s->slice.x == 0)
2362 x += s->img->hmargin;
2363 if (s->slice.y == 0)
2364 y += s->img->vmargin;
2366 if (s->img->pixmap)
2368 if (s->img->mask)
2370 /* We can't set both a clip mask and use XSetClipRectangles
2371 because the latter also sets a clip mask. We also can't
2372 trust on the shape extension to be available
2373 (XShapeCombineRegion). So, compute the rectangle to draw
2374 manually. */
2375 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2376 | GCFunction);
2377 XGCValues xgcv;
2379 xgcv.clip_mask = s->img->mask;
2380 xgcv.clip_x_origin = x - s->slice.x;
2381 xgcv.clip_y_origin = y - s->slice.y;
2382 xgcv.function = GXcopy;
2383 XChangeGC (s->display, s->gc, mask, &xgcv);
2385 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2386 s->slice.x, s->slice.y,
2387 s->slice.width, s->slice.height, x, y);
2388 XSetClipMask (s->display, s->gc, None);
2390 else
2392 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2393 s->slice.x, s->slice.y,
2394 s->slice.width, s->slice.height, x, y);
2396 /* When the image has a mask, we can expect that at
2397 least part of a mouse highlight or a block cursor will
2398 be visible. If the image doesn't have a mask, make
2399 a block cursor visible by drawing a rectangle around
2400 the image. I believe it's looking better if we do
2401 nothing here for mouse-face. */
2402 if (s->hl == DRAW_CURSOR)
2404 int r = s->img->relief;
2405 if (r < 0) r = -r;
2406 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2407 s->slice.width + r*2 - 1,
2408 s->slice.height + r*2 - 1);
2412 else
2413 /* Draw a rectangle if image could not be loaded. */
2414 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2415 s->slice.width - 1, s->slice.height - 1);
2419 /* Draw part of the background of glyph string S. X, Y, W, and H
2420 give the rectangle to draw. */
2422 static void
2423 x_draw_glyph_string_bg_rect (s, x, y, w, h)
2424 struct glyph_string *s;
2425 int x, y, w, h;
2427 if (s->stippled_p)
2429 /* Fill background with a stipple pattern. */
2430 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2431 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2432 XSetFillStyle (s->display, s->gc, FillSolid);
2434 else
2435 x_clear_glyph_string_rect (s, x, y, w, h);
2439 /* Draw image glyph string S.
2441 s->y
2442 s->x +-------------------------
2443 | s->face->box
2445 | +-------------------------
2446 | | s->img->margin
2448 | | +-------------------
2449 | | | the image
2453 static void
2454 x_draw_image_glyph_string (s)
2455 struct glyph_string *s;
2457 int box_line_hwidth = eabs (s->face->box_line_width);
2458 int box_line_vwidth = max (s->face->box_line_width, 0);
2459 int height;
2460 Pixmap pixmap = None;
2462 height = s->height;
2463 if (s->slice.y == 0)
2464 height -= box_line_vwidth;
2465 if (s->slice.y + s->slice.height >= s->img->height)
2466 height -= box_line_vwidth;
2468 /* Fill background with face under the image. Do it only if row is
2469 taller than image or if image has a clip mask to reduce
2470 flickering. */
2471 s->stippled_p = s->face->stipple != 0;
2472 if (height > s->slice.height
2473 || s->img->hmargin
2474 || s->img->vmargin
2475 || s->img->mask
2476 || s->img->pixmap == 0
2477 || s->width != s->background_width)
2479 if (s->img->mask)
2481 /* Create a pixmap as large as the glyph string. Fill it
2482 with the background color. Copy the image to it, using
2483 its mask. Copy the temporary pixmap to the display. */
2484 Screen *screen = FRAME_X_SCREEN (s->f);
2485 int depth = DefaultDepthOfScreen (screen);
2487 /* Create a pixmap as large as the glyph string. */
2488 pixmap = XCreatePixmap (s->display, s->window,
2489 s->background_width,
2490 s->height, depth);
2492 /* Don't clip in the following because we're working on the
2493 pixmap. */
2494 XSetClipMask (s->display, s->gc, None);
2496 /* Fill the pixmap with the background color/stipple. */
2497 if (s->stippled_p)
2499 /* Fill background with a stipple pattern. */
2500 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2501 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2502 XFillRectangle (s->display, pixmap, s->gc,
2503 0, 0, s->background_width, s->height);
2504 XSetFillStyle (s->display, s->gc, FillSolid);
2505 XSetTSOrigin (s->display, s->gc, 0, 0);
2507 else
2509 XGCValues xgcv;
2510 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2511 &xgcv);
2512 XSetForeground (s->display, s->gc, xgcv.background);
2513 XFillRectangle (s->display, pixmap, s->gc,
2514 0, 0, s->background_width, s->height);
2515 XSetForeground (s->display, s->gc, xgcv.foreground);
2518 else
2520 int x = s->x;
2521 int y = s->y;
2523 if (s->first_glyph->left_box_line_p
2524 && s->slice.x == 0)
2525 x += box_line_hwidth;
2527 if (s->slice.y == 0)
2528 y += box_line_vwidth;
2530 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2533 s->background_filled_p = 1;
2536 /* Draw the foreground. */
2537 if (pixmap != None)
2539 x_draw_image_foreground_1 (s, pixmap);
2540 x_set_glyph_string_clipping (s);
2541 XCopyArea (s->display, pixmap, s->window, s->gc,
2542 0, 0, s->background_width, s->height, s->x, s->y);
2543 XFreePixmap (s->display, pixmap);
2545 else
2546 x_draw_image_foreground (s);
2548 /* If we must draw a relief around the image, do it. */
2549 if (s->img->relief
2550 || s->hl == DRAW_IMAGE_RAISED
2551 || s->hl == DRAW_IMAGE_SUNKEN)
2552 x_draw_image_relief (s);
2556 /* Draw stretch glyph string S. */
2558 static void
2559 x_draw_stretch_glyph_string (s)
2560 struct glyph_string *s;
2562 xassert (s->first_glyph->type == STRETCH_GLYPH);
2564 if (s->hl == DRAW_CURSOR
2565 && !x_stretch_cursor_p)
2567 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2568 as wide as the stretch glyph. */
2569 int width, background_width = s->background_width;
2570 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2572 if (x < left_x)
2574 background_width -= left_x - x;
2575 x = left_x;
2577 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2579 /* Draw cursor. */
2580 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2582 /* Clear rest using the GC of the original non-cursor face. */
2583 if (width < background_width)
2585 int y = s->y;
2586 int w = background_width - width, h = s->height;
2587 XRectangle r;
2588 GC gc;
2590 x += width;
2591 if (s->row->mouse_face_p
2592 && cursor_in_mouse_face_p (s->w))
2594 x_set_mouse_face_gc (s);
2595 gc = s->gc;
2597 else
2598 gc = s->face->gc;
2600 get_glyph_string_clip_rect (s, &r);
2601 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2603 if (s->face->stipple)
2605 /* Fill background with a stipple pattern. */
2606 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2607 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2608 XSetFillStyle (s->display, gc, FillSolid);
2610 else
2612 XGCValues xgcv;
2613 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2614 XSetForeground (s->display, gc, xgcv.background);
2615 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2616 XSetForeground (s->display, gc, xgcv.foreground);
2620 else if (!s->background_filled_p)
2622 int background_width = s->background_width;
2623 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2625 /* Don't draw into left margin, fringe or scrollbar area
2626 except for header line and mode line. */
2627 if (x < left_x && !s->row->mode_line_p)
2629 background_width -= left_x - x;
2630 x = left_x;
2632 if (background_width > 0)
2633 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2636 s->background_filled_p = 1;
2640 /* Draw glyph string S. */
2642 static void
2643 x_draw_glyph_string (s)
2644 struct glyph_string *s;
2646 int relief_drawn_p = 0;
2648 /* If S draws into the background of its successors, draw the
2649 background of the successors first so that S can draw into it.
2650 This makes S->next use XDrawString instead of XDrawImageString. */
2651 if (s->next && s->right_overhang && !s->for_overlaps)
2653 int width;
2654 struct glyph_string *next;
2656 for (width = 0, next = s->next;
2657 next && width < s->right_overhang;
2658 width += next->width, next = next->next)
2659 if (next->first_glyph->type != IMAGE_GLYPH)
2661 x_set_glyph_string_gc (next);
2662 x_set_glyph_string_clipping (next);
2663 if (next->first_glyph->type == STRETCH_GLYPH)
2664 x_draw_stretch_glyph_string (next);
2665 else
2666 x_draw_glyph_string_background (next, 1);
2667 next->num_clips = 0;
2671 /* Set up S->gc, set clipping and draw S. */
2672 x_set_glyph_string_gc (s);
2674 /* Draw relief (if any) in advance for char/composition so that the
2675 glyph string can be drawn over it. */
2676 if (!s->for_overlaps
2677 && s->face->box != FACE_NO_BOX
2678 && (s->first_glyph->type == CHAR_GLYPH
2679 || s->first_glyph->type == COMPOSITE_GLYPH))
2682 x_set_glyph_string_clipping (s);
2683 x_draw_glyph_string_background (s, 1);
2684 x_draw_glyph_string_box (s);
2685 x_set_glyph_string_clipping (s);
2686 relief_drawn_p = 1;
2688 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2689 && !s->clip_tail
2690 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2691 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2692 /* We must clip just this glyph. left_overhang part has already
2693 drawn when s->prev was drawn, and right_overhang part will be
2694 drawn later when s->next is drawn. */
2695 x_set_glyph_string_clipping_exactly (s, s);
2696 else
2697 x_set_glyph_string_clipping (s);
2699 switch (s->first_glyph->type)
2701 case IMAGE_GLYPH:
2702 x_draw_image_glyph_string (s);
2703 break;
2705 case STRETCH_GLYPH:
2706 x_draw_stretch_glyph_string (s);
2707 break;
2709 case CHAR_GLYPH:
2710 if (s->for_overlaps)
2711 s->background_filled_p = 1;
2712 else
2713 x_draw_glyph_string_background (s, 0);
2714 x_draw_glyph_string_foreground (s);
2715 break;
2717 case COMPOSITE_GLYPH:
2718 if (s->for_overlaps || (s->cmp_from > 0
2719 && ! s->first_glyph->u.cmp.automatic))
2720 s->background_filled_p = 1;
2721 else
2722 x_draw_glyph_string_background (s, 1);
2723 x_draw_composite_glyph_string_foreground (s);
2724 break;
2726 default:
2727 abort ();
2730 if (!s->for_overlaps)
2732 /* Draw underline. */
2733 if (s->face->underline_p)
2735 unsigned long thickness, position;
2736 int y;
2738 if (s->prev && s->prev->face->underline_p)
2740 /* We use the same underline style as the previous one. */
2741 thickness = s->prev->underline_thickness;
2742 position = s->prev->underline_position;
2744 else
2746 /* Get the underline thickness. Default is 1 pixel. */
2747 if (s->font && s->font->underline_thickness > 0)
2748 thickness = s->font->underline_thickness;
2749 else
2750 thickness = 1;
2751 if (x_underline_at_descent_line)
2752 position = (s->height - thickness) - (s->ybase - s->y);
2753 else
2755 /* Get the underline position. This is the recommended
2756 vertical offset in pixels from the baseline to the top of
2757 the underline. This is a signed value according to the
2758 specs, and its default is
2760 ROUND ((maximum descent) / 2), with
2761 ROUND(x) = floor (x + 0.5) */
2763 if (x_use_underline_position_properties
2764 && s->font && s->font->underline_position >= 0)
2765 position = s->font->underline_position;
2766 else if (s->font)
2767 position = (s->font->descent + 1) / 2;
2769 position = max (position, underline_minimum_offset);
2771 /* Check the sanity of thickness and position. We should
2772 avoid drawing underline out of the current line area. */
2773 if (s->y + s->height <= s->ybase + position)
2774 position = (s->height - 1) - (s->ybase - s->y);
2775 if (s->y + s->height < s->ybase + position + thickness)
2776 thickness = (s->y + s->height) - (s->ybase + position);
2777 s->underline_thickness = thickness;
2778 s->underline_position = position;
2779 y = s->ybase + position;
2780 if (s->face->underline_defaulted_p)
2781 XFillRectangle (s->display, s->window, s->gc,
2782 s->x, y, s->background_width, thickness);
2783 else
2785 XGCValues xgcv;
2786 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2787 XSetForeground (s->display, s->gc, s->face->underline_color);
2788 XFillRectangle (s->display, s->window, s->gc,
2789 s->x, y, s->background_width, thickness);
2790 XSetForeground (s->display, s->gc, xgcv.foreground);
2794 /* Draw overline. */
2795 if (s->face->overline_p)
2797 unsigned long dy = 0, h = 1;
2799 if (s->face->overline_color_defaulted_p)
2800 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2801 s->background_width, h);
2802 else
2804 XGCValues xgcv;
2805 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2806 XSetForeground (s->display, s->gc, s->face->overline_color);
2807 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2808 s->background_width, h);
2809 XSetForeground (s->display, s->gc, xgcv.foreground);
2813 /* Draw strike-through. */
2814 if (s->face->strike_through_p)
2816 unsigned long h = 1;
2817 unsigned long dy = (s->height - h) / 2;
2819 if (s->face->strike_through_color_defaulted_p)
2820 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2821 s->width, h);
2822 else
2824 XGCValues xgcv;
2825 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2826 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2827 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2828 s->width, h);
2829 XSetForeground (s->display, s->gc, xgcv.foreground);
2833 /* Draw relief if not yet drawn. */
2834 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2835 x_draw_glyph_string_box (s);
2837 if (s->prev)
2839 struct glyph_string *prev;
2841 for (prev = s->prev; prev; prev = prev->prev)
2842 if (prev->hl != s->hl
2843 && prev->x + prev->width + prev->right_overhang > s->x)
2845 /* As prev was drawn while clipped to its own area, we
2846 must draw the right_overhang part using s->hl now. */
2847 enum draw_glyphs_face save = prev->hl;
2849 prev->hl = s->hl;
2850 x_set_glyph_string_gc (prev);
2851 x_set_glyph_string_clipping_exactly (s, prev);
2852 if (prev->first_glyph->type == CHAR_GLYPH)
2853 x_draw_glyph_string_foreground (prev);
2854 else
2855 x_draw_composite_glyph_string_foreground (prev);
2856 XSetClipMask (prev->display, prev->gc, None);
2857 prev->hl = save;
2858 prev->num_clips = 0;
2862 if (s->next)
2864 struct glyph_string *next;
2866 for (next = s->next; next; next = next->next)
2867 if (next->hl != s->hl
2868 && next->x - next->left_overhang < s->x + s->width)
2870 /* As next will be drawn while clipped to its own area,
2871 we must draw the left_overhang part using s->hl now. */
2872 enum draw_glyphs_face save = next->hl;
2874 next->hl = s->hl;
2875 x_set_glyph_string_gc (next);
2876 x_set_glyph_string_clipping_exactly (s, next);
2877 if (next->first_glyph->type == CHAR_GLYPH)
2878 x_draw_glyph_string_foreground (next);
2879 else
2880 x_draw_composite_glyph_string_foreground (next);
2881 XSetClipMask (next->display, next->gc, None);
2882 next->hl = save;
2883 next->num_clips = 0;
2888 /* Reset clipping. */
2889 XSetClipMask (s->display, s->gc, None);
2890 s->num_clips = 0;
2893 /* Shift display to make room for inserted glyphs. */
2895 void
2896 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2897 struct frame *f;
2898 int x, y, width, height, shift_by;
2900 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2901 f->output_data.x->normal_gc,
2902 x, y, width, height,
2903 x + shift_by, y);
2906 /* Delete N glyphs at the nominal cursor position. Not implemented
2907 for X frames. */
2909 static void
2910 x_delete_glyphs (f, n)
2911 struct frame *f;
2912 register int n;
2914 abort ();
2918 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2919 If they are <= 0, this is probably an error. */
2921 void
2922 x_clear_area (dpy, window, x, y, width, height, exposures)
2923 Display *dpy;
2924 Window window;
2925 int x, y;
2926 int width, height;
2927 int exposures;
2929 xassert (width > 0 && height > 0);
2930 XClearArea (dpy, window, x, y, width, height, exposures);
2934 /* Clear an entire frame. */
2936 static void
2937 x_clear_frame (struct frame *f)
2939 /* Clearing the frame will erase any cursor, so mark them all as no
2940 longer visible. */
2941 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2942 output_cursor.hpos = output_cursor.vpos = 0;
2943 output_cursor.x = -1;
2945 /* We don't set the output cursor here because there will always
2946 follow an explicit cursor_to. */
2947 BLOCK_INPUT;
2948 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2950 /* We have to clear the scroll bars, too. If we have changed
2951 colors or something like that, then they should be notified. */
2952 x_scroll_bar_clear (f);
2954 XFlush (FRAME_X_DISPLAY (f));
2956 UNBLOCK_INPUT;
2961 /* Invert the middle quarter of the frame for .15 sec. */
2963 /* We use the select system call to do the waiting, so we have to make
2964 sure it's available. If it isn't, we just won't do visual bells. */
2966 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2969 /* Subtract the `struct timeval' values X and Y, storing the result in
2970 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2972 static int
2973 timeval_subtract (result, x, y)
2974 struct timeval *result, x, y;
2976 /* Perform the carry for the later subtraction by updating y. This
2977 is safer because on some systems the tv_sec member is unsigned. */
2978 if (x.tv_usec < y.tv_usec)
2980 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2981 y.tv_usec -= 1000000 * nsec;
2982 y.tv_sec += nsec;
2985 if (x.tv_usec - y.tv_usec > 1000000)
2987 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2988 y.tv_usec += 1000000 * nsec;
2989 y.tv_sec -= nsec;
2992 /* Compute the time remaining to wait. tv_usec is certainly
2993 positive. */
2994 result->tv_sec = x.tv_sec - y.tv_sec;
2995 result->tv_usec = x.tv_usec - y.tv_usec;
2997 /* Return indication of whether the result should be considered
2998 negative. */
2999 return x.tv_sec < y.tv_sec;
3002 void
3003 XTflash (f)
3004 struct frame *f;
3006 BLOCK_INPUT;
3009 GC gc;
3011 /* Create a GC that will use the GXxor function to flip foreground
3012 pixels into background pixels. */
3014 XGCValues values;
3016 values.function = GXxor;
3017 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3018 ^ FRAME_BACKGROUND_PIXEL (f));
3020 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3021 GCFunction | GCForeground, &values);
3025 /* Get the height not including a menu bar widget. */
3026 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3027 /* Height of each line to flash. */
3028 int flash_height = FRAME_LINE_HEIGHT (f);
3029 /* These will be the left and right margins of the rectangles. */
3030 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3031 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3033 int width;
3035 /* Don't flash the area between a scroll bar and the frame
3036 edge it is next to. */
3037 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3039 case vertical_scroll_bar_left:
3040 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3041 break;
3043 case vertical_scroll_bar_right:
3044 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3045 break;
3047 default:
3048 break;
3051 width = flash_right - flash_left;
3053 /* If window is tall, flash top and bottom line. */
3054 if (height > 3 * FRAME_LINE_HEIGHT (f))
3056 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3057 flash_left,
3058 (FRAME_INTERNAL_BORDER_WIDTH (f)
3059 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3060 width, flash_height);
3061 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3062 flash_left,
3063 (height - flash_height
3064 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3065 width, flash_height);
3067 else
3068 /* If it is short, flash it all. */
3069 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3070 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3071 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3073 x_flush (f);
3076 struct timeval wakeup;
3078 EMACS_GET_TIME (wakeup);
3080 /* Compute time to wait until, propagating carry from usecs. */
3081 wakeup.tv_usec += 150000;
3082 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3083 wakeup.tv_usec %= 1000000;
3085 /* Keep waiting until past the time wakeup or any input gets
3086 available. */
3087 while (! detect_input_pending ())
3089 struct timeval current;
3090 struct timeval timeout;
3092 EMACS_GET_TIME (current);
3094 /* Break if result would be negative. */
3095 if (timeval_subtract (&current, wakeup, current))
3096 break;
3098 /* How long `select' should wait. */
3099 timeout.tv_sec = 0;
3100 timeout.tv_usec = 10000;
3102 /* Try to wait that long--but we might wake up sooner. */
3103 select (0, NULL, NULL, NULL, &timeout);
3107 /* If window is tall, flash top and bottom line. */
3108 if (height > 3 * FRAME_LINE_HEIGHT (f))
3110 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3111 flash_left,
3112 (FRAME_INTERNAL_BORDER_WIDTH (f)
3113 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3114 width, flash_height);
3115 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3116 flash_left,
3117 (height - flash_height
3118 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3119 width, flash_height);
3121 else
3122 /* If it is short, flash it all. */
3123 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3124 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3125 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3127 XFreeGC (FRAME_X_DISPLAY (f), gc);
3128 x_flush (f);
3132 UNBLOCK_INPUT;
3135 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3138 /* Make audible bell. */
3140 void
3141 XTring_bell ()
3143 struct frame *f = SELECTED_FRAME ();
3145 if (FRAME_X_DISPLAY (f))
3147 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3148 if (visible_bell)
3149 XTflash (f);
3150 else
3151 #endif
3153 BLOCK_INPUT;
3154 XBell (FRAME_X_DISPLAY (f), 0);
3155 XFlush (FRAME_X_DISPLAY (f));
3156 UNBLOCK_INPUT;
3162 /* Specify how many text lines, from the top of the window,
3163 should be affected by insert-lines and delete-lines operations.
3164 This, and those operations, are used only within an update
3165 that is bounded by calls to x_update_begin and x_update_end. */
3167 static void
3168 XTset_terminal_window (n)
3169 register int n;
3171 /* This function intentionally left blank. */
3176 /***********************************************************************
3177 Line Dance
3178 ***********************************************************************/
3180 /* Perform an insert-lines or delete-lines operation, inserting N
3181 lines or deleting -N lines at vertical position VPOS. */
3183 static void
3184 x_ins_del_lines (f, vpos, n)
3185 struct frame *f;
3186 int vpos, n;
3188 abort ();
3192 /* Scroll part of the display as described by RUN. */
3194 static void
3195 x_scroll_run (w, run)
3196 struct window *w;
3197 struct run *run;
3199 struct frame *f = XFRAME (w->frame);
3200 int x, y, width, height, from_y, to_y, bottom_y;
3202 /* Get frame-relative bounding box of the text display area of W,
3203 without mode lines. Include in this box the left and right
3204 fringe of W. */
3205 window_box (w, -1, &x, &y, &width, &height);
3207 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3208 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3209 bottom_y = y + height;
3211 if (to_y < from_y)
3213 /* Scrolling up. Make sure we don't copy part of the mode
3214 line at the bottom. */
3215 if (from_y + run->height > bottom_y)
3216 height = bottom_y - from_y;
3217 else
3218 height = run->height;
3220 else
3222 /* Scolling down. Make sure we don't copy over the mode line.
3223 at the bottom. */
3224 if (to_y + run->height > bottom_y)
3225 height = bottom_y - to_y;
3226 else
3227 height = run->height;
3230 BLOCK_INPUT;
3232 /* Cursor off. Will be switched on again in x_update_window_end. */
3233 updated_window = w;
3234 x_clear_cursor (w);
3236 XCopyArea (FRAME_X_DISPLAY (f),
3237 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3238 f->output_data.x->normal_gc,
3239 x, from_y,
3240 width, height,
3241 x, to_y);
3243 UNBLOCK_INPUT;
3248 /***********************************************************************
3249 Exposure Events
3250 ***********************************************************************/
3253 static void
3254 frame_highlight (f)
3255 struct frame *f;
3257 /* We used to only do this if Vx_no_window_manager was non-nil, but
3258 the ICCCM (section 4.1.6) says that the window's border pixmap
3259 and border pixel are window attributes which are "private to the
3260 client", so we can always change it to whatever we want. */
3261 BLOCK_INPUT;
3262 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3263 f->output_data.x->border_pixel);
3264 UNBLOCK_INPUT;
3265 x_update_cursor (f, 1);
3266 x_set_frame_alpha (f);
3269 static void
3270 frame_unhighlight (f)
3271 struct frame *f;
3273 /* We used to only do this if Vx_no_window_manager was non-nil, but
3274 the ICCCM (section 4.1.6) says that the window's border pixmap
3275 and border pixel are window attributes which are "private to the
3276 client", so we can always change it to whatever we want. */
3277 BLOCK_INPUT;
3278 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3279 f->output_data.x->border_tile);
3280 UNBLOCK_INPUT;
3281 x_update_cursor (f, 1);
3282 x_set_frame_alpha (f);
3285 /* The focus has changed. Update the frames as necessary to reflect
3286 the new situation. Note that we can't change the selected frame
3287 here, because the Lisp code we are interrupting might become confused.
3288 Each event gets marked with the frame in which it occurred, so the
3289 Lisp code can tell when the switch took place by examining the events. */
3291 static void
3292 x_new_focus_frame (dpyinfo, frame)
3293 struct x_display_info *dpyinfo;
3294 struct frame *frame;
3296 struct frame *old_focus = dpyinfo->x_focus_frame;
3298 if (frame != dpyinfo->x_focus_frame)
3300 /* Set this before calling other routines, so that they see
3301 the correct value of x_focus_frame. */
3302 dpyinfo->x_focus_frame = frame;
3304 if (old_focus && old_focus->auto_lower)
3305 x_lower_frame (old_focus);
3307 #if 0
3308 selected_frame = frame;
3309 XSETFRAME (XWINDOW (selected_frame->selected_window)->frame,
3310 selected_frame);
3311 Fselect_window (selected_frame->selected_window, Qnil);
3312 choose_minibuf_frame ();
3313 #endif /* ! 0 */
3315 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3316 pending_autoraise_frame = dpyinfo->x_focus_frame;
3317 else
3318 pending_autoraise_frame = 0;
3321 x_frame_rehighlight (dpyinfo);
3324 /* Handle FocusIn and FocusOut state changes for FRAME.
3325 If FRAME has focus and there exists more than one frame, puts
3326 a FOCUS_IN_EVENT into *BUFP. */
3328 static void
3329 x_focus_changed (type, state, dpyinfo, frame, bufp)
3330 int type;
3331 int state;
3332 struct x_display_info *dpyinfo;
3333 struct frame *frame;
3334 struct input_event *bufp;
3336 if (type == FocusIn)
3338 if (dpyinfo->x_focus_event_frame != frame)
3340 x_new_focus_frame (dpyinfo, frame);
3341 dpyinfo->x_focus_event_frame = frame;
3343 /* Don't stop displaying the initial startup message
3344 for a switch-frame event we don't need. */
3345 if (NILP (Vterminal_frame)
3346 && CONSP (Vframe_list)
3347 && !NILP (XCDR (Vframe_list)))
3349 bufp->kind = FOCUS_IN_EVENT;
3350 XSETFRAME (bufp->frame_or_window, frame);
3354 frame->output_data.x->focus_state |= state;
3356 #ifdef HAVE_X_I18N
3357 if (FRAME_XIC (frame))
3358 XSetICFocus (FRAME_XIC (frame));
3359 #endif
3361 else if (type == FocusOut)
3363 frame->output_data.x->focus_state &= ~state;
3365 if (dpyinfo->x_focus_event_frame == frame)
3367 dpyinfo->x_focus_event_frame = 0;
3368 x_new_focus_frame (dpyinfo, 0);
3371 #ifdef HAVE_X_I18N
3372 if (FRAME_XIC (frame))
3373 XUnsetICFocus (FRAME_XIC (frame));
3374 #endif
3378 /* The focus may have changed. Figure out if it is a real focus change,
3379 by checking both FocusIn/Out and Enter/LeaveNotify events.
3381 Returns FOCUS_IN_EVENT event in *BUFP. */
3383 static void
3384 x_detect_focus_change (dpyinfo, event, bufp)
3385 struct x_display_info *dpyinfo;
3386 XEvent *event;
3387 struct input_event *bufp;
3389 struct frame *frame;
3391 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3392 if (! frame)
3393 return;
3395 switch (event->type)
3397 case EnterNotify:
3398 case LeaveNotify:
3400 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3401 int focus_state
3402 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3404 if (event->xcrossing.detail != NotifyInferior
3405 && event->xcrossing.focus
3406 && ! (focus_state & FOCUS_EXPLICIT))
3407 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3408 FOCUS_IMPLICIT,
3409 dpyinfo, frame, bufp);
3411 break;
3413 case FocusIn:
3414 case FocusOut:
3415 x_focus_changed (event->type,
3416 (event->xfocus.detail == NotifyPointer ?
3417 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3418 dpyinfo, frame, bufp);
3419 break;
3421 case ClientMessage:
3422 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3424 enum xembed_message msg = event->xclient.data.l[1];
3425 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3426 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3428 break;
3433 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3435 void
3436 x_mouse_leave (dpyinfo)
3437 struct x_display_info *dpyinfo;
3439 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3442 /* The focus has changed, or we have redirected a frame's focus to
3443 another frame (this happens when a frame uses a surrogate
3444 mini-buffer frame). Shift the highlight as appropriate.
3446 The FRAME argument doesn't necessarily have anything to do with which
3447 frame is being highlighted or un-highlighted; we only use it to find
3448 the appropriate X display info. */
3450 static void
3451 XTframe_rehighlight (frame)
3452 struct frame *frame;
3454 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3457 static void
3458 x_frame_rehighlight (dpyinfo)
3459 struct x_display_info *dpyinfo;
3461 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3463 if (dpyinfo->x_focus_frame)
3465 dpyinfo->x_highlight_frame
3466 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3467 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3468 : dpyinfo->x_focus_frame);
3469 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3471 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3472 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3475 else
3476 dpyinfo->x_highlight_frame = 0;
3478 if (dpyinfo->x_highlight_frame != old_highlight)
3480 if (old_highlight)
3481 frame_unhighlight (old_highlight);
3482 if (dpyinfo->x_highlight_frame)
3483 frame_highlight (dpyinfo->x_highlight_frame);
3489 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3491 /* Initialize mode_switch_bit and modifier_meaning. */
3492 static void
3493 x_find_modifier_meanings (dpyinfo)
3494 struct x_display_info *dpyinfo;
3496 int min_code, max_code;
3497 KeySym *syms;
3498 int syms_per_code;
3499 XModifierKeymap *mods;
3501 dpyinfo->meta_mod_mask = 0;
3502 dpyinfo->shift_lock_mask = 0;
3503 dpyinfo->alt_mod_mask = 0;
3504 dpyinfo->super_mod_mask = 0;
3505 dpyinfo->hyper_mod_mask = 0;
3507 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3509 syms = XGetKeyboardMapping (dpyinfo->display,
3510 min_code, max_code - min_code + 1,
3511 &syms_per_code);
3512 mods = XGetModifierMapping (dpyinfo->display);
3514 /* Scan the modifier table to see which modifier bits the Meta and
3515 Alt keysyms are on. */
3517 int row, col; /* The row and column in the modifier table. */
3518 int found_alt_or_meta;
3520 for (row = 3; row < 8; row++)
3522 found_alt_or_meta = 0;
3523 for (col = 0; col < mods->max_keypermod; col++)
3525 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3527 /* Zeroes are used for filler. Skip them. */
3528 if (code == 0)
3529 continue;
3531 /* Are any of this keycode's keysyms a meta key? */
3533 int code_col;
3535 for (code_col = 0; code_col < syms_per_code; code_col++)
3537 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3539 switch (sym)
3541 case XK_Meta_L:
3542 case XK_Meta_R:
3543 found_alt_or_meta = 1;
3544 dpyinfo->meta_mod_mask |= (1 << row);
3545 break;
3547 case XK_Alt_L:
3548 case XK_Alt_R:
3549 found_alt_or_meta = 1;
3550 dpyinfo->alt_mod_mask |= (1 << row);
3551 break;
3553 case XK_Hyper_L:
3554 case XK_Hyper_R:
3555 if (!found_alt_or_meta)
3556 dpyinfo->hyper_mod_mask |= (1 << row);
3557 code_col = syms_per_code;
3558 col = mods->max_keypermod;
3559 break;
3561 case XK_Super_L:
3562 case XK_Super_R:
3563 if (!found_alt_or_meta)
3564 dpyinfo->super_mod_mask |= (1 << row);
3565 code_col = syms_per_code;
3566 col = mods->max_keypermod;
3567 break;
3569 case XK_Shift_Lock:
3570 /* Ignore this if it's not on the lock modifier. */
3571 if (!found_alt_or_meta && ((1 << row) == LockMask))
3572 dpyinfo->shift_lock_mask = LockMask;
3573 code_col = syms_per_code;
3574 col = mods->max_keypermod;
3575 break;
3583 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3584 if (! dpyinfo->meta_mod_mask)
3586 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3587 dpyinfo->alt_mod_mask = 0;
3590 /* If some keys are both alt and meta,
3591 make them just meta, not alt. */
3592 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3594 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3597 XFree ((char *) syms);
3598 XFreeModifiermap (mods);
3601 /* Convert between the modifier bits X uses and the modifier bits
3602 Emacs uses. */
3604 unsigned int
3605 x_x_to_emacs_modifiers (dpyinfo, state)
3606 struct x_display_info *dpyinfo;
3607 unsigned int state;
3609 EMACS_UINT mod_meta = meta_modifier;
3610 EMACS_UINT mod_alt = alt_modifier;
3611 EMACS_UINT mod_hyper = hyper_modifier;
3612 EMACS_UINT mod_super = super_modifier;
3613 Lisp_Object tem;
3615 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3616 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3617 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3618 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3619 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3620 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3621 tem = Fget (Vx_super_keysym, Qmodifier_value);
3622 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3625 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3626 | ((state & ControlMask) ? ctrl_modifier : 0)
3627 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3628 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3629 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3630 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3633 static unsigned int
3634 x_emacs_to_x_modifiers (dpyinfo, state)
3635 struct x_display_info *dpyinfo;
3636 unsigned int state;
3638 EMACS_UINT mod_meta = meta_modifier;
3639 EMACS_UINT mod_alt = alt_modifier;
3640 EMACS_UINT mod_hyper = hyper_modifier;
3641 EMACS_UINT mod_super = super_modifier;
3643 Lisp_Object tem;
3645 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3646 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3647 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3648 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3649 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3650 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3651 tem = Fget (Vx_super_keysym, Qmodifier_value);
3652 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3655 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3656 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3657 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3658 | ((state & shift_modifier) ? ShiftMask : 0)
3659 | ((state & ctrl_modifier) ? ControlMask : 0)
3660 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3663 /* Convert a keysym to its name. */
3665 char *
3666 x_get_keysym_name (keysym)
3667 KeySym keysym;
3669 char *value;
3671 BLOCK_INPUT;
3672 value = XKeysymToString (keysym);
3673 UNBLOCK_INPUT;
3675 return value;
3680 /* Mouse clicks and mouse movement. Rah. */
3682 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3684 If the event is a button press, then note that we have grabbed
3685 the mouse. */
3687 static Lisp_Object
3688 construct_mouse_click (result, event, f)
3689 struct input_event *result;
3690 XButtonEvent *event;
3691 struct frame *f;
3693 /* Make the event type NO_EVENT; we'll change that when we decide
3694 otherwise. */
3695 result->kind = MOUSE_CLICK_EVENT;
3696 result->code = event->button - Button1;
3697 result->timestamp = event->time;
3698 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3699 event->state)
3700 | (event->type == ButtonRelease
3701 ? up_modifier
3702 : down_modifier));
3704 XSETINT (result->x, event->x);
3705 XSETINT (result->y, event->y);
3706 XSETFRAME (result->frame_or_window, f);
3707 result->arg = Qnil;
3708 return Qnil;
3712 /* Function to report a mouse movement to the mainstream Emacs code.
3713 The input handler calls this.
3715 We have received a mouse movement event, which is given in *event.
3716 If the mouse is over a different glyph than it was last time, tell
3717 the mainstream emacs code by setting mouse_moved. If not, ask for
3718 another motion event, so we can check again the next time it moves. */
3720 static XMotionEvent last_mouse_motion_event;
3721 static Lisp_Object last_mouse_motion_frame;
3723 static int
3724 note_mouse_movement (frame, event)
3725 FRAME_PTR frame;
3726 XMotionEvent *event;
3728 last_mouse_movement_time = event->time;
3729 last_mouse_motion_event = *event;
3730 XSETFRAME (last_mouse_motion_frame, frame);
3732 if (!FRAME_X_OUTPUT (frame))
3733 return 0;
3735 if (event->window != FRAME_X_WINDOW (frame))
3737 frame->mouse_moved = 1;
3738 last_mouse_scroll_bar = Qnil;
3739 note_mouse_highlight (frame, -1, -1);
3740 last_mouse_glyph_frame = 0;
3741 return 1;
3745 /* Has the mouse moved off the glyph it was on at the last sighting? */
3746 if (frame != last_mouse_glyph_frame
3747 || event->x < last_mouse_glyph.x
3748 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3749 || event->y < last_mouse_glyph.y
3750 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3752 frame->mouse_moved = 1;
3753 last_mouse_scroll_bar = Qnil;
3754 note_mouse_highlight (frame, event->x, event->y);
3755 /* Remember which glyph we're now on. */
3756 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3757 last_mouse_glyph_frame = frame;
3758 return 1;
3761 return 0;
3765 /************************************************************************
3766 Mouse Face
3767 ************************************************************************/
3769 static void
3770 redo_mouse_highlight ()
3772 if (!NILP (last_mouse_motion_frame)
3773 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3774 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3775 last_mouse_motion_event.x,
3776 last_mouse_motion_event.y);
3781 /* Return the current position of the mouse.
3782 *FP should be a frame which indicates which display to ask about.
3784 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3785 and *PART to the frame, window, and scroll bar part that the mouse
3786 is over. Set *X and *Y to the portion and whole of the mouse's
3787 position on the scroll bar.
3789 If the mouse movement started elsewhere, set *FP to the frame the
3790 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3791 the mouse is over.
3793 Set *TIME to the server time-stamp for the time at which the mouse
3794 was at this position.
3796 Don't store anything if we don't have a valid set of values to report.
3798 This clears the mouse_moved flag, so we can wait for the next mouse
3799 movement. */
3801 static void
3802 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3803 FRAME_PTR *fp;
3804 int insist;
3805 Lisp_Object *bar_window;
3806 enum scroll_bar_part *part;
3807 Lisp_Object *x, *y;
3808 unsigned long *time;
3810 FRAME_PTR f1;
3812 BLOCK_INPUT;
3814 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3815 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3816 else
3818 Window root;
3819 int root_x, root_y;
3821 Window dummy_window;
3822 int dummy;
3824 Lisp_Object frame, tail;
3826 /* Clear the mouse-moved flag for every frame on this display. */
3827 FOR_EACH_FRAME (tail, frame)
3828 if (FRAME_X_P (XFRAME (frame))
3829 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3830 XFRAME (frame)->mouse_moved = 0;
3832 last_mouse_scroll_bar = Qnil;
3834 /* Figure out which root window we're on. */
3835 XQueryPointer (FRAME_X_DISPLAY (*fp),
3836 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3838 /* The root window which contains the pointer. */
3839 &root,
3841 /* Trash which we can't trust if the pointer is on
3842 a different screen. */
3843 &dummy_window,
3845 /* The position on that root window. */
3846 &root_x, &root_y,
3848 /* More trash we can't trust. */
3849 &dummy, &dummy,
3851 /* Modifier keys and pointer buttons, about which
3852 we don't care. */
3853 (unsigned int *) &dummy);
3855 /* Now we have a position on the root; find the innermost window
3856 containing the pointer. */
3858 Window win, child;
3859 int win_x, win_y;
3860 int parent_x = 0, parent_y = 0;
3862 win = root;
3864 /* XTranslateCoordinates can get errors if the window
3865 structure is changing at the same time this function
3866 is running. So at least we must not crash from them. */
3868 x_catch_errors (FRAME_X_DISPLAY (*fp));
3870 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3871 && FRAME_LIVE_P (last_mouse_frame))
3873 /* If mouse was grabbed on a frame, give coords for that frame
3874 even if the mouse is now outside it. */
3875 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3877 /* From-window, to-window. */
3878 root, FRAME_X_WINDOW (last_mouse_frame),
3880 /* From-position, to-position. */
3881 root_x, root_y, &win_x, &win_y,
3883 /* Child of win. */
3884 &child);
3885 f1 = last_mouse_frame;
3887 else
3889 while (1)
3891 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3893 /* From-window, to-window. */
3894 root, win,
3896 /* From-position, to-position. */
3897 root_x, root_y, &win_x, &win_y,
3899 /* Child of win. */
3900 &child);
3902 if (child == None || child == win)
3903 break;
3905 win = child;
3906 parent_x = win_x;
3907 parent_y = win_y;
3910 /* Now we know that:
3911 win is the innermost window containing the pointer
3912 (XTC says it has no child containing the pointer),
3913 win_x and win_y are the pointer's position in it
3914 (XTC did this the last time through), and
3915 parent_x and parent_y are the pointer's position in win's parent.
3916 (They are what win_x and win_y were when win was child.
3917 If win is the root window, it has no parent, and
3918 parent_{x,y} are invalid, but that's okay, because we'll
3919 never use them in that case.) */
3921 /* Is win one of our frames? */
3922 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3924 #ifdef USE_X_TOOLKIT
3925 /* If we end up with the menu bar window, say it's not
3926 on the frame. */
3927 if (f1 != NULL
3928 && f1->output_data.x->menubar_widget
3929 && win == XtWindow (f1->output_data.x->menubar_widget))
3930 f1 = NULL;
3931 #endif /* USE_X_TOOLKIT */
3934 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3935 f1 = 0;
3937 x_uncatch_errors ();
3939 /* If not, is it one of our scroll bars? */
3940 if (! f1)
3942 struct scroll_bar *bar;
3944 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3946 if (bar)
3948 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3949 win_x = parent_x;
3950 win_y = parent_y;
3954 if (f1 == 0 && insist > 0)
3955 f1 = SELECTED_FRAME ();
3957 if (f1)
3959 /* Ok, we found a frame. Store all the values.
3960 last_mouse_glyph is a rectangle used to reduce the
3961 generation of mouse events. To not miss any motion
3962 events, we must divide the frame into rectangles of the
3963 size of the smallest character that could be displayed
3964 on it, i.e. into the same rectangles that matrices on
3965 the frame are divided into. */
3967 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3968 last_mouse_glyph_frame = f1;
3970 *bar_window = Qnil;
3971 *part = 0;
3972 *fp = f1;
3973 XSETINT (*x, win_x);
3974 XSETINT (*y, win_y);
3975 *time = last_mouse_movement_time;
3980 UNBLOCK_INPUT;
3985 /***********************************************************************
3986 Scroll bars
3987 ***********************************************************************/
3989 /* Scroll bar support. */
3991 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
3992 manages it.
3993 This can be called in GC, so we have to make sure to strip off mark
3994 bits. */
3996 static struct scroll_bar *
3997 x_window_to_scroll_bar (display, window_id)
3998 Display *display;
3999 Window window_id;
4001 Lisp_Object tail;
4003 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4004 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4005 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4007 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4009 Lisp_Object frame, bar, condemned;
4011 frame = XCAR (tail);
4012 /* All elements of Vframe_list should be frames. */
4013 if (! FRAMEP (frame))
4014 abort ();
4016 if (! FRAME_X_P (XFRAME (frame)))
4017 continue;
4019 /* Scan this frame's scroll bar list for a scroll bar with the
4020 right window ID. */
4021 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4022 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4023 /* This trick allows us to search both the ordinary and
4024 condemned scroll bar lists with one loop. */
4025 ! NILP (bar) || (bar = condemned,
4026 condemned = Qnil,
4027 ! NILP (bar));
4028 bar = XSCROLL_BAR (bar)->next)
4029 if (XSCROLL_BAR (bar)->x_window == window_id &&
4030 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4031 return XSCROLL_BAR (bar);
4034 return 0;
4038 #if defined USE_LUCID
4040 /* Return the Lucid menu bar WINDOW is part of. Return null
4041 if WINDOW is not part of a menu bar. */
4043 static Widget
4044 x_window_to_menu_bar (window)
4045 Window window;
4047 Lisp_Object tail;
4049 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4051 if (FRAME_X_P (XFRAME (XCAR (tail))))
4053 Lisp_Object frame = XCAR (tail);
4054 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4056 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4057 return menu_bar;
4061 return NULL;
4064 #endif /* USE_LUCID */
4067 /************************************************************************
4068 Toolkit scroll bars
4069 ************************************************************************/
4071 #ifdef USE_TOOLKIT_SCROLL_BARS
4073 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
4074 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
4075 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
4076 struct scroll_bar *));
4077 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
4078 int, int, int));
4081 /* Lisp window being scrolled. Set when starting to interact with
4082 a toolkit scroll bar, reset to nil when ending the interaction. */
4084 static Lisp_Object window_being_scrolled;
4086 /* Last scroll bar part sent in xm_scroll_callback. */
4088 static int last_scroll_bar_part;
4090 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4091 that movements of 1/20 of the screen size are mapped to up/down. */
4093 #ifndef USE_GTK
4094 /* Id of action hook installed for scroll bars. */
4096 static XtActionHookId action_hook_id;
4098 static Boolean xaw3d_arrow_scroll;
4100 /* Whether the drag scrolling maintains the mouse at the top of the
4101 thumb. If not, resizing the thumb needs to be done more carefully
4102 to avoid jerkyness. */
4104 static Boolean xaw3d_pick_top;
4106 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4107 bars are used.. The hook is responsible for detecting when
4108 the user ends an interaction with the scroll bar, and generates
4109 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4111 static void
4112 xt_action_hook (widget, client_data, action_name, event, params,
4113 num_params)
4114 Widget widget;
4115 XtPointer client_data;
4116 String action_name;
4117 XEvent *event;
4118 String *params;
4119 Cardinal *num_params;
4121 int scroll_bar_p;
4122 char *end_action;
4124 #ifdef USE_MOTIF
4125 scroll_bar_p = XmIsScrollBar (widget);
4126 end_action = "Release";
4127 #else /* !USE_MOTIF i.e. use Xaw */
4128 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4129 end_action = "EndScroll";
4130 #endif /* USE_MOTIF */
4132 if (scroll_bar_p
4133 && strcmp (action_name, end_action) == 0
4134 && WINDOWP (window_being_scrolled))
4136 struct window *w;
4138 x_send_scroll_bar_event (window_being_scrolled,
4139 scroll_bar_end_scroll, 0, 0);
4140 w = XWINDOW (window_being_scrolled);
4142 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4144 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4145 /* The thumb size is incorrect while dragging: fix it. */
4146 set_vertical_scroll_bar (w);
4148 window_being_scrolled = Qnil;
4149 last_scroll_bar_part = -1;
4151 /* Xt timeouts no longer needed. */
4152 toolkit_scroll_bar_interaction = 0;
4155 #endif /* not USE_GTK */
4157 /* A vector of windows used for communication between
4158 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4160 static struct window **scroll_bar_windows;
4161 static int scroll_bar_windows_size;
4164 /* Send a client message with message type Xatom_Scrollbar for a
4165 scroll action to the frame of WINDOW. PART is a value identifying
4166 the part of the scroll bar that was clicked on. PORTION is the
4167 amount to scroll of a whole of WHOLE. */
4169 static void
4170 x_send_scroll_bar_event (window, part, portion, whole)
4171 Lisp_Object window;
4172 int part, portion, whole;
4174 XEvent event;
4175 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4176 struct window *w = XWINDOW (window);
4177 struct frame *f = XFRAME (w->frame);
4178 int i;
4180 BLOCK_INPUT;
4182 /* Construct a ClientMessage event to send to the frame. */
4183 ev->type = ClientMessage;
4184 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4185 ev->display = FRAME_X_DISPLAY (f);
4186 ev->window = FRAME_X_WINDOW (f);
4187 ev->format = 32;
4189 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4190 not enough to store a pointer or Lisp_Object on a 64 bit system.
4191 So, store the window in scroll_bar_windows and pass the index
4192 into that array in the event. */
4193 for (i = 0; i < scroll_bar_windows_size; ++i)
4194 if (scroll_bar_windows[i] == NULL)
4195 break;
4197 if (i == scroll_bar_windows_size)
4199 int new_size = max (10, 2 * scroll_bar_windows_size);
4200 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4201 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4203 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4204 nbytes);
4205 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4206 scroll_bar_windows_size = new_size;
4209 scroll_bar_windows[i] = w;
4210 ev->data.l[0] = (long) i;
4211 ev->data.l[1] = (long) part;
4212 ev->data.l[2] = (long) 0;
4213 ev->data.l[3] = (long) portion;
4214 ev->data.l[4] = (long) whole;
4216 /* Make Xt timeouts work while the scroll bar is active. */
4217 toolkit_scroll_bar_interaction = 1;
4218 #ifdef USE_X_TOOLKIT
4219 x_activate_timeout_atimer ();
4220 #endif
4222 /* Setting the event mask to zero means that the message will
4223 be sent to the client that created the window, and if that
4224 window no longer exists, no event will be sent. */
4225 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4226 UNBLOCK_INPUT;
4230 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4231 in *IEVENT. */
4233 static void
4234 x_scroll_bar_to_input_event (event, ievent)
4235 XEvent *event;
4236 struct input_event *ievent;
4238 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4239 Lisp_Object window;
4240 struct frame *f;
4241 struct window *w;
4243 w = scroll_bar_windows[ev->data.l[0]];
4244 scroll_bar_windows[ev->data.l[0]] = NULL;
4246 XSETWINDOW (window, w);
4247 f = XFRAME (w->frame);
4249 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4250 ievent->frame_or_window = window;
4251 ievent->arg = Qnil;
4252 #ifdef USE_GTK
4253 ievent->timestamp = CurrentTime;
4254 #else
4255 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4256 #endif
4257 ievent->part = ev->data.l[1];
4258 ievent->code = ev->data.l[2];
4259 ievent->x = make_number ((int) ev->data.l[3]);
4260 ievent->y = make_number ((int) ev->data.l[4]);
4261 ievent->modifiers = 0;
4265 #ifdef USE_MOTIF
4267 /* Minimum and maximum values used for Motif scroll bars. */
4269 #define XM_SB_MAX 10000000
4272 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4273 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4274 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4276 static void
4277 xm_scroll_callback (widget, client_data, call_data)
4278 Widget widget;
4279 XtPointer client_data, call_data;
4281 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4282 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4283 int part = -1, whole = 0, portion = 0;
4285 switch (cs->reason)
4287 case XmCR_DECREMENT:
4288 bar->dragging = Qnil;
4289 part = scroll_bar_up_arrow;
4290 break;
4292 case XmCR_INCREMENT:
4293 bar->dragging = Qnil;
4294 part = scroll_bar_down_arrow;
4295 break;
4297 case XmCR_PAGE_DECREMENT:
4298 bar->dragging = Qnil;
4299 part = scroll_bar_above_handle;
4300 break;
4302 case XmCR_PAGE_INCREMENT:
4303 bar->dragging = Qnil;
4304 part = scroll_bar_below_handle;
4305 break;
4307 case XmCR_TO_TOP:
4308 bar->dragging = Qnil;
4309 part = scroll_bar_to_top;
4310 break;
4312 case XmCR_TO_BOTTOM:
4313 bar->dragging = Qnil;
4314 part = scroll_bar_to_bottom;
4315 break;
4317 case XmCR_DRAG:
4319 int slider_size;
4321 /* Get the slider size. */
4322 BLOCK_INPUT;
4323 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4324 UNBLOCK_INPUT;
4326 whole = XM_SB_MAX - slider_size;
4327 portion = min (cs->value, whole);
4328 part = scroll_bar_handle;
4329 bar->dragging = make_number (cs->value);
4331 break;
4333 case XmCR_VALUE_CHANGED:
4334 break;
4337 if (part >= 0)
4339 window_being_scrolled = bar->window;
4340 last_scroll_bar_part = part;
4341 x_send_scroll_bar_event (bar->window, part, portion, whole);
4345 #elif defined USE_GTK
4347 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4348 bar widget. DATA is a pointer to the scroll_bar structure. */
4350 static void
4351 xg_scroll_callback (widget, data)
4352 GtkRange *widget;
4353 gpointer data;
4355 struct scroll_bar *bar = (struct scroll_bar *) data;
4356 gdouble previous;
4357 gdouble position;
4358 gdouble *p;
4359 int diff;
4361 int part = -1, whole = 0, portion = 0;
4362 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (widget));
4364 position = gtk_adjustment_get_value (adj);
4366 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
4367 if (! p)
4369 p = (gdouble*) xmalloc (sizeof (gdouble));
4370 *p = XG_SB_MIN;
4371 g_object_set_data (G_OBJECT (widget), XG_LAST_SB_DATA, p);
4374 previous = *p;
4375 *p = position;
4377 if (xg_ignore_gtk_scrollbar) return;
4379 diff = (int) (position - previous);
4381 if (diff == (int) adj->step_increment)
4383 part = scroll_bar_down_arrow;
4384 bar->dragging = Qnil;
4386 else if (-diff == (int) adj->step_increment)
4388 part = scroll_bar_up_arrow;
4389 bar->dragging = Qnil;
4391 else if (diff == (int) adj->page_increment)
4393 part = scroll_bar_below_handle;
4394 bar->dragging = Qnil;
4396 else if (-diff == (int) adj->page_increment)
4398 part = scroll_bar_above_handle;
4399 bar->dragging = Qnil;
4401 else
4403 part = scroll_bar_handle;
4404 whole = adj->upper - adj->page_size;
4405 portion = min ((int)position, whole);
4406 bar->dragging = make_number ((int)portion);
4409 if (part >= 0)
4411 window_being_scrolled = bar->window;
4412 last_scroll_bar_part = part;
4413 x_send_scroll_bar_event (bar->window, part, portion, whole);
4417 #else /* not USE_GTK and not USE_MOTIF */
4419 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4420 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4421 scroll bar struct. CALL_DATA is a pointer to a float saying where
4422 the thumb is. */
4424 static void
4425 xaw_jump_callback (widget, client_data, call_data)
4426 Widget widget;
4427 XtPointer client_data, call_data;
4429 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4430 float top = *(float *) call_data;
4431 float shown;
4432 int whole, portion, height;
4433 int part;
4435 /* Get the size of the thumb, a value between 0 and 1. */
4436 BLOCK_INPUT;
4437 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4438 UNBLOCK_INPUT;
4440 whole = 10000000;
4441 portion = shown < 1 ? top * whole : 0;
4443 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4444 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4445 the bottom, so we force the scrolling whenever we see that we're
4446 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4447 we try to ensure that we always stay two pixels away from the
4448 bottom). */
4449 part = scroll_bar_down_arrow;
4450 else
4451 part = scroll_bar_handle;
4453 window_being_scrolled = bar->window;
4454 bar->dragging = make_number (portion);
4455 last_scroll_bar_part = part;
4456 x_send_scroll_bar_event (bar->window, part, portion, whole);
4460 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4461 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4462 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4463 the scroll bar. CALL_DATA is an integer specifying the action that
4464 has taken place. Its magnitude is in the range 0..height of the
4465 scroll bar. Negative values mean scroll towards buffer start.
4466 Values < height of scroll bar mean line-wise movement. */
4468 static void
4469 xaw_scroll_callback (widget, client_data, call_data)
4470 Widget widget;
4471 XtPointer client_data, call_data;
4473 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4474 /* The position really is stored cast to a pointer. */
4475 int position = (long) call_data;
4476 Dimension height;
4477 int part;
4479 /* Get the height of the scroll bar. */
4480 BLOCK_INPUT;
4481 XtVaGetValues (widget, XtNheight, &height, NULL);
4482 UNBLOCK_INPUT;
4484 if (eabs (position) >= height)
4485 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4487 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4488 it maps line-movement to call_data = max(5, height/20). */
4489 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4490 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4491 else
4492 part = scroll_bar_move_ratio;
4494 window_being_scrolled = bar->window;
4495 bar->dragging = Qnil;
4496 last_scroll_bar_part = part;
4497 x_send_scroll_bar_event (bar->window, part, position, height);
4500 #endif /* not USE_GTK and not USE_MOTIF */
4502 #define SCROLL_BAR_NAME "verticalScrollBar"
4504 /* Create the widget for scroll bar BAR on frame F. Record the widget
4505 and X window of the scroll bar in BAR. */
4507 #ifdef USE_GTK
4508 static void
4509 x_create_toolkit_scroll_bar (f, bar)
4510 struct frame *f;
4511 struct scroll_bar *bar;
4513 char *scroll_bar_name = SCROLL_BAR_NAME;
4515 BLOCK_INPUT;
4516 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4517 scroll_bar_name);
4518 UNBLOCK_INPUT;
4521 #else /* not USE_GTK */
4523 static void
4524 x_create_toolkit_scroll_bar (f, bar)
4525 struct frame *f;
4526 struct scroll_bar *bar;
4528 Window xwindow;
4529 Widget widget;
4530 Arg av[20];
4531 int ac = 0;
4532 char *scroll_bar_name = SCROLL_BAR_NAME;
4533 unsigned long pixel;
4535 BLOCK_INPUT;
4537 #ifdef USE_MOTIF
4538 /* Set resources. Create the widget. */
4539 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4540 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4541 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4542 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4543 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4544 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4545 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4547 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4548 if (pixel != -1)
4550 XtSetArg (av[ac], XmNforeground, pixel);
4551 ++ac;
4554 pixel = f->output_data.x->scroll_bar_background_pixel;
4555 if (pixel != -1)
4557 XtSetArg (av[ac], XmNbackground, pixel);
4558 ++ac;
4561 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4562 scroll_bar_name, av, ac);
4564 /* Add one callback for everything that can happen. */
4565 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4566 (XtPointer) bar);
4567 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4568 (XtPointer) bar);
4569 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4570 (XtPointer) bar);
4571 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4572 (XtPointer) bar);
4573 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4574 (XtPointer) bar);
4575 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4576 (XtPointer) bar);
4577 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4578 (XtPointer) bar);
4580 /* Realize the widget. Only after that is the X window created. */
4581 XtRealizeWidget (widget);
4583 /* Set the cursor to an arrow. I didn't find a resource to do that.
4584 And I'm wondering why it hasn't an arrow cursor by default. */
4585 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4586 f->output_data.x->nontext_cursor);
4588 #else /* !USE_MOTIF i.e. use Xaw */
4590 /* Set resources. Create the widget. The background of the
4591 Xaw3d scroll bar widget is a little bit light for my taste.
4592 We don't alter it here to let users change it according
4593 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4594 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4595 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4596 /* For smoother scrolling with Xaw3d -sm */
4597 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4599 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4600 if (pixel != -1)
4602 XtSetArg (av[ac], XtNforeground, pixel);
4603 ++ac;
4606 pixel = f->output_data.x->scroll_bar_background_pixel;
4607 if (pixel != -1)
4609 XtSetArg (av[ac], XtNbackground, pixel);
4610 ++ac;
4613 /* Top/bottom shadow colors. */
4615 /* Allocate them, if necessary. */
4616 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4618 pixel = f->output_data.x->scroll_bar_background_pixel;
4619 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4620 &pixel, 1.2, 0x8000))
4621 pixel = -1;
4622 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4624 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4626 pixel = f->output_data.x->scroll_bar_background_pixel;
4627 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4628 &pixel, 0.6, 0x4000))
4629 pixel = -1;
4630 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4633 #ifdef XtNbeNiceToColormap
4634 /* Tell the toolkit about them. */
4635 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4636 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4637 /* We tried to allocate a color for the top/bottom shadow, and
4638 failed, so tell Xaw3d to use dithering instead. */
4640 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4641 ++ac;
4643 else
4644 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4645 be more consistent with other emacs 3d colors, and since Xaw3d is
4646 not good at dealing with allocation failure. */
4648 /* This tells Xaw3d to use real colors instead of dithering for
4649 the shadows. */
4650 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4651 ++ac;
4653 /* Specify the colors. */
4654 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4655 if (pixel != -1)
4657 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4658 ++ac;
4660 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4661 if (pixel != -1)
4663 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4664 ++ac;
4667 #endif
4669 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4670 f->output_data.x->edit_widget, av, ac);
4673 char *initial = "";
4674 char *val = initial;
4675 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4676 #ifdef XtNarrowScrollbars
4677 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4678 #endif
4679 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4680 if (xaw3d_arrow_scroll || val == initial)
4681 { /* ARROW_SCROLL */
4682 xaw3d_arrow_scroll = True;
4683 /* Isn't that just a personal preference ? --Stef */
4684 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4688 /* Define callbacks. */
4689 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4690 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4691 (XtPointer) bar);
4693 /* Realize the widget. Only after that is the X window created. */
4694 XtRealizeWidget (widget);
4696 #endif /* !USE_MOTIF */
4698 /* Install an action hook that lets us detect when the user
4699 finishes interacting with a scroll bar. */
4700 if (action_hook_id == 0)
4701 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4703 /* Remember X window and widget in the scroll bar vector. */
4704 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4705 xwindow = XtWindow (widget);
4706 bar->x_window = xwindow;
4708 UNBLOCK_INPUT;
4710 #endif /* not USE_GTK */
4713 /* Set the thumb size and position of scroll bar BAR. We are currently
4714 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4716 #ifdef USE_GTK
4717 static void
4718 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4719 struct scroll_bar *bar;
4720 int portion, position, whole;
4722 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4725 #else /* not USE_GTK */
4726 static void
4727 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4728 struct scroll_bar *bar;
4729 int portion, position, whole;
4731 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4732 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4733 float top, shown;
4735 BLOCK_INPUT;
4737 #ifdef USE_MOTIF
4739 /* We use an estimate of 30 chars per line rather than the real
4740 `portion' value. This has the disadvantage that the thumb size
4741 is not very representative, but it makes our life a lot easier.
4742 Otherwise, we have to constantly adjust the thumb size, which
4743 we can't always do quickly enough: while dragging, the size of
4744 the thumb might prevent the user from dragging the thumb all the
4745 way to the end. but Motif and some versions of Xaw3d don't allow
4746 updating the thumb size while dragging. Also, even if we can update
4747 its size, the update will often happen too late.
4748 If you don't believe it, check out revision 1.650 of xterm.c to see
4749 what hoops we were going through and the still poor behavior we got. */
4750 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4751 /* When the thumb is at the bottom, position == whole.
4752 So we need to increase `whole' to make space for the thumb. */
4753 whole += portion;
4755 if (whole <= 0)
4756 top = 0, shown = 1;
4757 else
4759 top = (float) position / whole;
4760 shown = (float) portion / whole;
4763 if (NILP (bar->dragging))
4765 int size, value;
4767 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4768 is the scroll bar's maximum and MIN is the scroll bar's minimum
4769 value. */
4770 size = shown * XM_SB_MAX;
4771 size = min (size, XM_SB_MAX);
4772 size = max (size, 1);
4774 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4775 value = top * XM_SB_MAX;
4776 value = min (value, XM_SB_MAX - size);
4778 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4780 #else /* !USE_MOTIF i.e. use Xaw */
4782 if (whole == 0)
4783 top = 0, shown = 1;
4784 else
4786 top = (float) position / whole;
4787 shown = (float) portion / whole;
4791 float old_top, old_shown;
4792 Dimension height;
4793 XtVaGetValues (widget,
4794 XtNtopOfThumb, &old_top,
4795 XtNshown, &old_shown,
4796 XtNheight, &height,
4797 NULL);
4799 /* Massage the top+shown values. */
4800 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4801 top = max (0, min (1, top));
4802 else
4803 top = old_top;
4804 /* Keep two pixels available for moving the thumb down. */
4805 shown = max (0, min (1 - top - (2.0 / height), shown));
4807 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4808 check that your system's configuration file contains a define
4809 for `NARROWPROTO'. See s/freebsd.h for an example. */
4810 if (top != old_top || shown != old_shown)
4812 if (NILP (bar->dragging))
4813 XawScrollbarSetThumb (widget, top, shown);
4814 else
4816 /* Try to make the scrolling a tad smoother. */
4817 if (!xaw3d_pick_top)
4818 shown = min (shown, old_shown);
4820 XawScrollbarSetThumb (widget, top, shown);
4824 #endif /* !USE_MOTIF */
4826 UNBLOCK_INPUT;
4828 #endif /* not USE_GTK */
4830 #endif /* USE_TOOLKIT_SCROLL_BARS */
4834 /************************************************************************
4835 Scroll bars, general
4836 ************************************************************************/
4838 /* Create a scroll bar and return the scroll bar vector for it. W is
4839 the Emacs window on which to create the scroll bar. TOP, LEFT,
4840 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4841 scroll bar. */
4843 static struct scroll_bar *
4844 x_scroll_bar_create (w, top, left, width, height)
4845 struct window *w;
4846 int top, left, width, height;
4848 struct frame *f = XFRAME (w->frame);
4849 struct scroll_bar *bar
4850 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4852 BLOCK_INPUT;
4854 #ifdef USE_TOOLKIT_SCROLL_BARS
4855 x_create_toolkit_scroll_bar (f, bar);
4856 #else /* not USE_TOOLKIT_SCROLL_BARS */
4858 XSetWindowAttributes a;
4859 unsigned long mask;
4860 Window window;
4862 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4863 if (a.background_pixel == -1)
4864 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4866 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4867 | ButtonMotionMask | PointerMotionHintMask
4868 | ExposureMask);
4869 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4871 mask = (CWBackPixel | CWEventMask | CWCursor);
4873 /* Clear the area of W that will serve as a scroll bar. This is
4874 for the case that a window has been split horizontally. In
4875 this case, no clear_frame is generated to reduce flickering. */
4876 if (width > 0 && height > 0)
4877 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4878 left, top, width,
4879 window_box_height (w), False);
4881 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4882 /* Position and size of scroll bar. */
4883 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4884 top,
4885 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4886 height,
4887 /* Border width, depth, class, and visual. */
4889 CopyFromParent,
4890 CopyFromParent,
4891 CopyFromParent,
4892 /* Attributes. */
4893 mask, &a);
4894 bar->x_window = window;
4896 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4898 XSETWINDOW (bar->window, w);
4899 bar->top = top;
4900 bar->left = left;
4901 bar->width = width;
4902 bar->height = height;
4903 bar->start = 0;
4904 bar->end = 0;
4905 bar->dragging = Qnil;
4906 bar->fringe_extended_p = 0;
4908 /* Add bar to its frame's list of scroll bars. */
4909 bar->next = FRAME_SCROLL_BARS (f);
4910 bar->prev = Qnil;
4911 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4912 if (!NILP (bar->next))
4913 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4915 /* Map the window/widget. */
4916 #ifdef USE_TOOLKIT_SCROLL_BARS
4918 #ifdef USE_GTK
4919 xg_update_scrollbar_pos (f,
4920 bar->x_window,
4921 top,
4922 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4923 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4924 max (height, 1));
4925 xg_show_scroll_bar (bar->x_window);
4926 #else /* not USE_GTK */
4927 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4928 XtConfigureWidget (scroll_bar,
4929 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4930 top,
4931 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4932 max (height, 1), 0);
4933 XtMapWidget (scroll_bar);
4934 #endif /* not USE_GTK */
4936 #else /* not USE_TOOLKIT_SCROLL_BARS */
4937 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4938 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4940 UNBLOCK_INPUT;
4941 return bar;
4945 #ifndef USE_TOOLKIT_SCROLL_BARS
4947 /* Draw BAR's handle in the proper position.
4949 If the handle is already drawn from START to END, don't bother
4950 redrawing it, unless REBUILD is non-zero; in that case, always
4951 redraw it. (REBUILD is handy for drawing the handle after expose
4952 events.)
4954 Normally, we want to constrain the start and end of the handle to
4955 fit inside its rectangle, but if the user is dragging the scroll
4956 bar handle, we want to let them drag it down all the way, so that
4957 the bar's top is as far down as it goes; otherwise, there's no way
4958 to move to the very end of the buffer. */
4960 static void
4961 x_scroll_bar_set_handle (bar, start, end, rebuild)
4962 struct scroll_bar *bar;
4963 int start, end;
4964 int rebuild;
4966 int dragging = ! NILP (bar->dragging);
4967 Window w = bar->x_window;
4968 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4969 GC gc = f->output_data.x->normal_gc;
4971 /* If the display is already accurate, do nothing. */
4972 if (! rebuild
4973 && start == bar->start
4974 && end == bar->end)
4975 return;
4977 BLOCK_INPUT;
4980 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4981 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4982 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4984 /* Make sure the values are reasonable, and try to preserve
4985 the distance between start and end. */
4987 int length = end - start;
4989 if (start < 0)
4990 start = 0;
4991 else if (start > top_range)
4992 start = top_range;
4993 end = start + length;
4995 if (end < start)
4996 end = start;
4997 else if (end > top_range && ! dragging)
4998 end = top_range;
5001 /* Store the adjusted setting in the scroll bar. */
5002 bar->start = start;
5003 bar->end = end;
5005 /* Clip the end position, just for display. */
5006 if (end > top_range)
5007 end = top_range;
5009 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5010 below top positions, to make sure the handle is always at least
5011 that many pixels tall. */
5012 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5014 /* Draw the empty space above the handle. Note that we can't clear
5015 zero-height areas; that means "clear to end of window." */
5016 if (0 < start)
5017 x_clear_area (FRAME_X_DISPLAY (f), w,
5018 /* x, y, width, height, and exposures. */
5019 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5020 VERTICAL_SCROLL_BAR_TOP_BORDER,
5021 inside_width, start,
5022 False);
5024 /* Change to proper foreground color if one is specified. */
5025 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5026 XSetForeground (FRAME_X_DISPLAY (f), gc,
5027 f->output_data.x->scroll_bar_foreground_pixel);
5029 /* Draw the handle itself. */
5030 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5031 /* x, y, width, height */
5032 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5033 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5034 inside_width, end - start);
5036 /* Restore the foreground color of the GC if we changed it above. */
5037 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5038 XSetForeground (FRAME_X_DISPLAY (f), gc,
5039 FRAME_FOREGROUND_PIXEL (f));
5041 /* Draw the empty space below the handle. Note that we can't
5042 clear zero-height areas; that means "clear to end of window." */
5043 if (end < inside_height)
5044 x_clear_area (FRAME_X_DISPLAY (f), w,
5045 /* x, y, width, height, and exposures. */
5046 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5047 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5048 inside_width, inside_height - end,
5049 False);
5053 UNBLOCK_INPUT;
5056 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5058 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5059 nil. */
5061 static void
5062 x_scroll_bar_remove (bar)
5063 struct scroll_bar *bar;
5065 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5066 BLOCK_INPUT;
5068 #ifdef USE_TOOLKIT_SCROLL_BARS
5069 #ifdef USE_GTK
5070 xg_remove_scroll_bar (f, bar->x_window);
5071 #else /* not USE_GTK */
5072 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5073 #endif /* not USE_GTK */
5074 #else
5075 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5076 #endif
5078 /* Disassociate this scroll bar from its window. */
5079 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5081 UNBLOCK_INPUT;
5085 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5086 that we are displaying PORTION characters out of a total of WHOLE
5087 characters, starting at POSITION. If WINDOW has no scroll bar,
5088 create one. */
5090 static void
5091 XTset_vertical_scroll_bar (w, portion, whole, position)
5092 struct window *w;
5093 int portion, whole, position;
5095 struct frame *f = XFRAME (w->frame);
5096 struct scroll_bar *bar;
5097 int top, height, left, sb_left, width, sb_width;
5098 int window_y, window_height;
5099 #ifdef USE_TOOLKIT_SCROLL_BARS
5100 int fringe_extended_p;
5101 #endif
5103 /* Get window dimensions. */
5104 window_box (w, -1, 0, &window_y, 0, &window_height);
5105 top = window_y;
5106 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5107 height = window_height;
5109 /* Compute the left edge of the scroll bar area. */
5110 left = WINDOW_SCROLL_BAR_AREA_X (w);
5112 /* Compute the width of the scroll bar which might be less than
5113 the width of the area reserved for the scroll bar. */
5114 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5115 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5116 else
5117 sb_width = width;
5119 /* Compute the left edge of the scroll bar. */
5120 #ifdef USE_TOOLKIT_SCROLL_BARS
5121 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5122 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5123 else
5124 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5125 #else
5126 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5127 sb_left = left + width - sb_width;
5128 else
5129 sb_left = left;
5130 #endif
5132 #ifdef USE_TOOLKIT_SCROLL_BARS
5133 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5134 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5135 && WINDOW_LEFT_FRINGE_WIDTH (w)
5136 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5137 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5138 else
5139 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5140 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5141 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5142 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5143 #endif
5145 /* Does the scroll bar exist yet? */
5146 if (NILP (w->vertical_scroll_bar))
5148 if (width > 0 && height > 0)
5150 BLOCK_INPUT;
5151 #ifdef USE_TOOLKIT_SCROLL_BARS
5152 if (fringe_extended_p)
5153 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5154 sb_left, top, sb_width, height, False);
5155 else
5156 #endif
5157 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5158 left, top, width, height, False);
5159 UNBLOCK_INPUT;
5162 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5164 else
5166 /* It may just need to be moved and resized. */
5167 unsigned int mask = 0;
5169 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5171 BLOCK_INPUT;
5173 if (sb_left != bar->left)
5174 mask |= CWX;
5175 if (top != bar->top)
5176 mask |= CWY;
5177 if (sb_width != bar->width)
5178 mask |= CWWidth;
5179 if (height != bar->height)
5180 mask |= CWHeight;
5182 #ifdef USE_TOOLKIT_SCROLL_BARS
5184 /* Move/size the scroll bar widget. */
5185 if (mask || bar->fringe_extended_p != fringe_extended_p)
5187 /* Since toolkit scroll bars are smaller than the space reserved
5188 for them on the frame, we have to clear "under" them. */
5189 if (width > 0 && height > 0)
5191 if (fringe_extended_p)
5192 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5193 sb_left, top, sb_width, height, False);
5194 else
5195 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5196 left, top, width, height, False);
5198 #ifdef USE_GTK
5199 xg_update_scrollbar_pos (f,
5200 bar->x_window,
5201 top,
5202 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5203 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5204 max (height, 1));
5205 #else /* not USE_GTK */
5206 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5207 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5208 top,
5209 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5210 max (height, 1), 0);
5211 #endif /* not USE_GTK */
5213 #else /* not USE_TOOLKIT_SCROLL_BARS */
5215 /* Clear areas not covered by the scroll bar because of
5216 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5217 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5219 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5220 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5221 height, False);
5222 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5223 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5224 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5225 height, False);
5228 /* Clear areas not covered by the scroll bar because it's not as
5229 wide as the area reserved for it. This makes sure a
5230 previous mode line display is cleared after C-x 2 C-x 1, for
5231 example. */
5233 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5234 int rest = area_width - sb_width;
5235 if (rest > 0 && height > 0)
5237 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5238 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5239 left + area_width - rest, top,
5240 rest, height, False);
5241 else
5242 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5243 left, top, rest, height, False);
5247 /* Move/size the scroll bar window. */
5248 if (mask)
5250 XWindowChanges wc;
5252 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5253 wc.y = top;
5254 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5255 wc.height = height;
5256 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5257 mask, &wc);
5260 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5262 /* Remember new settings. */
5263 bar->left = sb_left;
5264 bar->top = top;
5265 bar->width = sb_width;
5266 bar->height = height;
5268 UNBLOCK_INPUT;
5271 #ifdef USE_TOOLKIT_SCROLL_BARS
5272 bar->fringe_extended_p = fringe_extended_p;
5274 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5275 #else /* not USE_TOOLKIT_SCROLL_BARS */
5276 /* Set the scroll bar's current state, unless we're currently being
5277 dragged. */
5278 if (NILP (bar->dragging))
5280 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5282 if (whole == 0)
5283 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5284 else
5286 int start = ((double) position * top_range) / whole;
5287 int end = ((double) (position + portion) * top_range) / whole;
5288 x_scroll_bar_set_handle (bar, start, end, 0);
5291 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5293 XSETVECTOR (w->vertical_scroll_bar, bar);
5297 /* The following three hooks are used when we're doing a thorough
5298 redisplay of the frame. We don't explicitly know which scroll bars
5299 are going to be deleted, because keeping track of when windows go
5300 away is a real pain - "Can you say set-window-configuration, boys
5301 and girls?" Instead, we just assert at the beginning of redisplay
5302 that *all* scroll bars are to be removed, and then save a scroll bar
5303 from the fiery pit when we actually redisplay its window. */
5305 /* Arrange for all scroll bars on FRAME to be removed at the next call
5306 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5307 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5309 static void
5310 XTcondemn_scroll_bars (frame)
5311 FRAME_PTR frame;
5313 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5314 while (! NILP (FRAME_SCROLL_BARS (frame)))
5316 Lisp_Object bar;
5317 bar = FRAME_SCROLL_BARS (frame);
5318 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5319 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5320 XSCROLL_BAR (bar)->prev = Qnil;
5321 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5322 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5323 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5328 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5329 Note that WINDOW isn't necessarily condemned at all. */
5331 static void
5332 XTredeem_scroll_bar (window)
5333 struct window *window;
5335 struct scroll_bar *bar;
5336 struct frame *f;
5338 /* We can't redeem this window's scroll bar if it doesn't have one. */
5339 if (NILP (window->vertical_scroll_bar))
5340 abort ();
5342 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5344 /* Unlink it from the condemned list. */
5345 f = XFRAME (WINDOW_FRAME (window));
5346 if (NILP (bar->prev))
5348 /* If the prev pointer is nil, it must be the first in one of
5349 the lists. */
5350 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5351 /* It's not condemned. Everything's fine. */
5352 return;
5353 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5354 window->vertical_scroll_bar))
5355 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5356 else
5357 /* If its prev pointer is nil, it must be at the front of
5358 one or the other! */
5359 abort ();
5361 else
5362 XSCROLL_BAR (bar->prev)->next = bar->next;
5364 if (! NILP (bar->next))
5365 XSCROLL_BAR (bar->next)->prev = bar->prev;
5367 bar->next = FRAME_SCROLL_BARS (f);
5368 bar->prev = Qnil;
5369 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5370 if (! NILP (bar->next))
5371 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5374 /* Remove all scroll bars on FRAME that haven't been saved since the
5375 last call to `*condemn_scroll_bars_hook'. */
5377 static void
5378 XTjudge_scroll_bars (f)
5379 FRAME_PTR f;
5381 Lisp_Object bar, next;
5383 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5385 /* Clear out the condemned list now so we won't try to process any
5386 more events on the hapless scroll bars. */
5387 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5389 for (; ! NILP (bar); bar = next)
5391 struct scroll_bar *b = XSCROLL_BAR (bar);
5393 x_scroll_bar_remove (b);
5395 next = b->next;
5396 b->next = b->prev = Qnil;
5399 /* Now there should be no references to the condemned scroll bars,
5400 and they should get garbage-collected. */
5404 #ifndef USE_TOOLKIT_SCROLL_BARS
5405 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5406 is a no-op when using toolkit scroll bars.
5408 This may be called from a signal handler, so we have to ignore GC
5409 mark bits. */
5411 static void
5412 x_scroll_bar_expose (bar, event)
5413 struct scroll_bar *bar;
5414 XEvent *event;
5416 Window w = bar->x_window;
5417 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5418 GC gc = f->output_data.x->normal_gc;
5419 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5421 BLOCK_INPUT;
5423 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5425 /* Switch to scroll bar foreground color. */
5426 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5427 XSetForeground (FRAME_X_DISPLAY (f), gc,
5428 f->output_data.x->scroll_bar_foreground_pixel);
5430 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5431 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5433 /* x, y, width, height */
5434 0, 0,
5435 bar->width - 1 - width_trim - width_trim,
5436 bar->height - 1);
5438 /* Restore the foreground color of the GC if we changed it above. */
5439 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5440 XSetForeground (FRAME_X_DISPLAY (f), gc,
5441 FRAME_FOREGROUND_PIXEL (f));
5443 UNBLOCK_INPUT;
5446 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5448 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5449 is set to something other than NO_EVENT, it is enqueued.
5451 This may be called from a signal handler, so we have to ignore GC
5452 mark bits. */
5455 static void
5456 x_scroll_bar_handle_click (bar, event, emacs_event)
5457 struct scroll_bar *bar;
5458 XEvent *event;
5459 struct input_event *emacs_event;
5461 if (! WINDOWP (bar->window))
5462 abort ();
5464 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5465 emacs_event->code = event->xbutton.button - Button1;
5466 emacs_event->modifiers
5467 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5468 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5469 event->xbutton.state)
5470 | (event->type == ButtonRelease
5471 ? up_modifier
5472 : down_modifier));
5473 emacs_event->frame_or_window = bar->window;
5474 emacs_event->arg = Qnil;
5475 emacs_event->timestamp = event->xbutton.time;
5477 #if 0
5478 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5479 int internal_height
5480 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5481 #endif
5482 int top_range
5483 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5484 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5486 if (y < 0) y = 0;
5487 if (y > top_range) y = top_range;
5489 if (y < bar->start)
5490 emacs_event->part = scroll_bar_above_handle;
5491 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5492 emacs_event->part = scroll_bar_handle;
5493 else
5494 emacs_event->part = scroll_bar_below_handle;
5496 /* Just because the user has clicked on the handle doesn't mean
5497 they want to drag it. Lisp code needs to be able to decide
5498 whether or not we're dragging. */
5499 #if 0
5500 /* If the user has just clicked on the handle, record where they're
5501 holding it. */
5502 if (event->type == ButtonPress
5503 && emacs_event->part == scroll_bar_handle)
5504 XSETINT (bar->dragging, y - bar->start);
5505 #endif
5507 #ifndef USE_TOOLKIT_SCROLL_BARS
5508 /* If the user has released the handle, set it to its final position. */
5509 if (event->type == ButtonRelease
5510 && ! NILP (bar->dragging))
5512 int new_start = y - XINT (bar->dragging);
5513 int new_end = new_start + bar->end - bar->start;
5515 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5516 bar->dragging = Qnil;
5518 #endif
5520 /* Same deal here as the other #if 0. */
5521 #if 0
5522 /* Clicks on the handle are always reported as occurring at the top of
5523 the handle. */
5524 if (emacs_event->part == scroll_bar_handle)
5525 emacs_event->x = bar->start;
5526 else
5527 XSETINT (emacs_event->x, y);
5528 #else
5529 XSETINT (emacs_event->x, y);
5530 #endif
5532 XSETINT (emacs_event->y, top_range);
5536 #ifndef USE_TOOLKIT_SCROLL_BARS
5538 /* Handle some mouse motion while someone is dragging the scroll bar.
5540 This may be called from a signal handler, so we have to ignore GC
5541 mark bits. */
5543 static void
5544 x_scroll_bar_note_movement (bar, event)
5545 struct scroll_bar *bar;
5546 XEvent *event;
5548 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5550 last_mouse_movement_time = event->xmotion.time;
5552 f->mouse_moved = 1;
5553 XSETVECTOR (last_mouse_scroll_bar, bar);
5555 /* If we're dragging the bar, display it. */
5556 if (! NILP (bar->dragging))
5558 /* Where should the handle be now? */
5559 int new_start = event->xmotion.y - XINT (bar->dragging);
5561 if (new_start != bar->start)
5563 int new_end = new_start + bar->end - bar->start;
5565 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5570 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5572 /* Return information to the user about the current position of the mouse
5573 on the scroll bar. */
5575 static void
5576 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5577 FRAME_PTR *fp;
5578 Lisp_Object *bar_window;
5579 enum scroll_bar_part *part;
5580 Lisp_Object *x, *y;
5581 unsigned long *time;
5583 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5584 Window w = bar->x_window;
5585 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5586 int win_x, win_y;
5587 Window dummy_window;
5588 int dummy_coord;
5589 unsigned int dummy_mask;
5591 BLOCK_INPUT;
5593 /* Get the mouse's position relative to the scroll bar window, and
5594 report that. */
5595 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5597 /* Root, child, root x and root y. */
5598 &dummy_window, &dummy_window,
5599 &dummy_coord, &dummy_coord,
5601 /* Position relative to scroll bar. */
5602 &win_x, &win_y,
5604 /* Mouse buttons and modifier keys. */
5605 &dummy_mask))
5607 else
5609 #if 0
5610 int inside_height
5611 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5612 #endif
5613 int top_range
5614 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5616 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5618 if (! NILP (bar->dragging))
5619 win_y -= XINT (bar->dragging);
5621 if (win_y < 0)
5622 win_y = 0;
5623 if (win_y > top_range)
5624 win_y = top_range;
5626 *fp = f;
5627 *bar_window = bar->window;
5629 if (! NILP (bar->dragging))
5630 *part = scroll_bar_handle;
5631 else if (win_y < bar->start)
5632 *part = scroll_bar_above_handle;
5633 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5634 *part = scroll_bar_handle;
5635 else
5636 *part = scroll_bar_below_handle;
5638 XSETINT (*x, win_y);
5639 XSETINT (*y, top_range);
5641 f->mouse_moved = 0;
5642 last_mouse_scroll_bar = Qnil;
5645 *time = last_mouse_movement_time;
5647 UNBLOCK_INPUT;
5651 /* The screen has been cleared so we may have changed foreground or
5652 background colors, and the scroll bars may need to be redrawn.
5653 Clear out the scroll bars, and ask for expose events, so we can
5654 redraw them. */
5656 void
5657 x_scroll_bar_clear (f)
5658 FRAME_PTR f;
5660 #ifndef USE_TOOLKIT_SCROLL_BARS
5661 Lisp_Object bar;
5663 /* We can have scroll bars even if this is 0,
5664 if we just turned off scroll bar mode.
5665 But in that case we should not clear them. */
5666 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5667 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5668 bar = XSCROLL_BAR (bar)->next)
5669 XClearArea (FRAME_X_DISPLAY (f),
5670 XSCROLL_BAR (bar)->x_window,
5671 0, 0, 0, 0, True);
5672 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5676 /* The main X event-reading loop - XTread_socket. */
5678 #if 0
5679 /* Time stamp of enter window event. This is only used by XTread_socket,
5680 but we have to put it out here, since static variables within functions
5681 sometimes don't work. */
5683 static Time enter_timestamp;
5684 #endif
5686 /* This holds the state XLookupString needs to implement dead keys
5687 and other tricks known as "compose processing". _X Window System_
5688 says that a portable program can't use this, but Stephen Gildea assures
5689 me that letting the compiler initialize it to zeros will work okay.
5691 This must be defined outside of XTread_socket, for the same reasons
5692 given for enter_timestamp, above. */
5694 static XComposeStatus compose_status;
5696 /* Record the last 100 characters stored
5697 to help debug the loss-of-chars-during-GC problem. */
5699 static int temp_index;
5700 static short temp_buffer[100];
5702 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5703 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5704 temp_index = 0; \
5705 temp_buffer[temp_index++] = (keysym)
5707 /* Set this to nonzero to fake an "X I/O error"
5708 on a particular display. */
5710 struct x_display_info *XTread_socket_fake_io_error;
5712 /* When we find no input here, we occasionally do a no-op command
5713 to verify that the X server is still running and we can still talk with it.
5714 We try all the open displays, one by one.
5715 This variable is used for cycling thru the displays. */
5717 static struct x_display_info *next_noop_dpyinfo;
5719 #define SET_SAVED_MENU_EVENT(size) \
5720 do \
5722 if (f->output_data.x->saved_menu_event == 0) \
5723 f->output_data.x->saved_menu_event \
5724 = (XEvent *) xmalloc (sizeof (XEvent)); \
5725 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5726 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5727 XSETFRAME (inev.ie.frame_or_window, f); \
5729 while (0)
5731 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5732 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5735 enum
5737 X_EVENT_NORMAL,
5738 X_EVENT_GOTO_OUT,
5739 X_EVENT_DROP
5742 /* Filter events for the current X input method.
5743 DPYINFO is the display this event is for.
5744 EVENT is the X event to filter.
5746 Returns non-zero if the event was filtered, caller shall not process
5747 this event further.
5748 Returns zero if event is wasn't filtered. */
5750 #ifdef HAVE_X_I18N
5751 static int
5752 x_filter_event (dpyinfo, event)
5753 struct x_display_info *dpyinfo;
5754 XEvent *event;
5756 /* XFilterEvent returns non-zero if the input method has
5757 consumed the event. We pass the frame's X window to
5758 XFilterEvent because that's the one for which the IC
5759 was created. */
5761 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5762 event->xclient.window);
5764 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5766 #endif
5768 #ifdef USE_GTK
5769 static int current_count;
5770 static int current_finish;
5771 static struct input_event *current_hold_quit;
5773 /* This is the filter function invoked by the GTK event loop.
5774 It is invoked before the XEvent is translated to a GdkEvent,
5775 so we have a chance to act on the event before GTK. */
5776 static GdkFilterReturn
5777 event_handler_gdk (gxev, ev, data)
5778 GdkXEvent *gxev;
5779 GdkEvent *ev;
5780 gpointer data;
5782 XEvent *xev = (XEvent *) gxev;
5784 if (current_count >= 0)
5786 struct x_display_info *dpyinfo;
5788 dpyinfo = x_display_info_for_display (xev->xany.display);
5790 #ifdef HAVE_X_I18N
5791 /* Filter events for the current X input method.
5792 GTK calls XFilterEvent but not for key press and release,
5793 so we do it here. */
5794 if (xev->type == KeyPress || xev->type == KeyRelease)
5795 if (dpyinfo && x_filter_event (dpyinfo, xev))
5796 return GDK_FILTER_REMOVE;
5797 #endif
5799 if (! dpyinfo)
5800 current_finish = X_EVENT_NORMAL;
5801 else
5803 current_count +=
5804 handle_one_xevent (dpyinfo, xev, &current_finish,
5805 current_hold_quit);
5808 else
5809 current_finish = x_dispatch_event (xev, xev->xany.display);
5811 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5812 return GDK_FILTER_REMOVE;
5814 return GDK_FILTER_CONTINUE;
5816 #endif /* USE_GTK */
5819 /* Handles the XEvent EVENT on display DPYINFO.
5821 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5822 *FINISH is zero if caller should continue reading events.
5823 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5825 We return the number of characters stored into the buffer. */
5827 static int
5828 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5829 struct x_display_info *dpyinfo;
5830 XEvent *eventp;
5831 int *finish;
5832 struct input_event *hold_quit;
5834 union {
5835 struct input_event ie;
5836 struct selection_input_event sie;
5837 } inev;
5838 int count = 0;
5839 int do_help = 0;
5840 int nbytes = 0;
5841 struct frame *f = NULL;
5842 struct coding_system coding;
5843 XEvent event = *eventp;
5845 *finish = X_EVENT_NORMAL;
5847 EVENT_INIT (inev.ie);
5848 inev.ie.kind = NO_EVENT;
5849 inev.ie.arg = Qnil;
5851 switch (event.type)
5853 case ClientMessage:
5855 if (event.xclient.message_type
5856 == dpyinfo->Xatom_wm_protocols
5857 && event.xclient.format == 32)
5859 if (event.xclient.data.l[0]
5860 == dpyinfo->Xatom_wm_take_focus)
5862 /* Use x_any_window_to_frame because this
5863 could be the shell widget window
5864 if the frame has no title bar. */
5865 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5866 #ifdef HAVE_X_I18N
5867 /* Not quite sure this is needed -pd */
5868 if (f && FRAME_XIC (f))
5869 XSetICFocus (FRAME_XIC (f));
5870 #endif
5871 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5872 instructs the WM to set the input focus automatically for
5873 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5874 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5875 it has set the focus. So, XSetInputFocus below is not
5876 needed.
5878 The call to XSetInputFocus below has also caused trouble. In
5879 cases where the XSetInputFocus done by the WM and the one
5880 below are temporally close (on a fast machine), the call
5881 below can generate additional FocusIn events which confuse
5882 Emacs. */
5884 /* Since we set WM_TAKE_FOCUS, we must call
5885 XSetInputFocus explicitly. But not if f is null,
5886 since that might be an event for a deleted frame. */
5887 if (f)
5889 Display *d = event.xclient.display;
5890 /* Catch and ignore errors, in case window has been
5891 iconified by a window manager such as GWM. */
5892 x_catch_errors (d);
5893 XSetInputFocus (d, event.xclient.window,
5894 /* The ICCCM says this is
5895 the only valid choice. */
5896 RevertToParent,
5897 event.xclient.data.l[1]);
5898 /* This is needed to detect the error
5899 if there is an error. */
5900 XSync (d, False);
5901 x_uncatch_errors ();
5903 /* Not certain about handling scroll bars here */
5904 #endif /* 0 */
5905 goto done;
5908 if (event.xclient.data.l[0]
5909 == dpyinfo->Xatom_wm_save_yourself)
5911 /* Save state modify the WM_COMMAND property to
5912 something which can reinstate us. This notifies
5913 the session manager, who's looking for such a
5914 PropertyNotify. Can restart processing when
5915 a keyboard or mouse event arrives. */
5916 /* If we have a session manager, don't set this.
5917 KDE will then start two Emacsen, one for the
5918 session manager and one for this. */
5919 #ifdef HAVE_X_SM
5920 if (! x_session_have_connection ())
5921 #endif
5923 f = x_top_window_to_frame (dpyinfo,
5924 event.xclient.window);
5925 /* This is just so we only give real data once
5926 for a single Emacs process. */
5927 if (f == SELECTED_FRAME ())
5928 XSetCommand (FRAME_X_DISPLAY (f),
5929 event.xclient.window,
5930 initial_argv, initial_argc);
5931 else if (f)
5932 XSetCommand (FRAME_X_DISPLAY (f),
5933 event.xclient.window,
5934 0, 0);
5936 goto done;
5939 if (event.xclient.data.l[0]
5940 == dpyinfo->Xatom_wm_delete_window)
5942 f = x_any_window_to_frame (dpyinfo,
5943 event.xclient.window);
5944 if (!f)
5945 goto OTHER; /* May be a dialog that is to be removed */
5947 inev.ie.kind = DELETE_WINDOW_EVENT;
5948 XSETFRAME (inev.ie.frame_or_window, f);
5949 goto done;
5952 goto done;
5955 if (event.xclient.message_type
5956 == dpyinfo->Xatom_wm_configure_denied)
5958 goto done;
5961 if (event.xclient.message_type
5962 == dpyinfo->Xatom_wm_window_moved)
5964 int new_x, new_y;
5965 f = x_window_to_frame (dpyinfo, event.xclient.window);
5967 new_x = event.xclient.data.s[0];
5968 new_y = event.xclient.data.s[1];
5970 if (f)
5972 f->left_pos = new_x;
5973 f->top_pos = new_y;
5975 goto done;
5978 #ifdef HACK_EDITRES
5979 if (event.xclient.message_type
5980 == dpyinfo->Xatom_editres)
5982 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5983 if (f)
5984 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5985 &event, NULL);
5986 goto done;
5988 #endif /* HACK_EDITRES */
5990 if ((event.xclient.message_type
5991 == dpyinfo->Xatom_DONE)
5992 || (event.xclient.message_type
5993 == dpyinfo->Xatom_PAGE))
5995 /* Ghostview job completed. Kill it. We could
5996 reply with "Next" if we received "Page", but we
5997 currently never do because we are interested in
5998 images, only, which should have 1 page. */
5999 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6000 f = x_window_to_frame (dpyinfo, event.xclient.window);
6001 if (!f)
6002 goto OTHER;
6003 x_kill_gs_process (pixmap, f);
6004 expose_frame (f, 0, 0, 0, 0);
6005 goto done;
6008 #ifdef USE_TOOLKIT_SCROLL_BARS
6009 /* Scroll bar callbacks send a ClientMessage from which
6010 we construct an input_event. */
6011 if (event.xclient.message_type
6012 == dpyinfo->Xatom_Scrollbar)
6014 x_scroll_bar_to_input_event (&event, &inev.ie);
6015 *finish = X_EVENT_GOTO_OUT;
6016 goto done;
6018 #endif /* USE_TOOLKIT_SCROLL_BARS */
6020 /* XEmbed messages from the embedder (if any). */
6021 if (event.xclient.message_type
6022 == dpyinfo->Xatom_XEMBED)
6024 enum xembed_message msg = event.xclient.data.l[1];
6025 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6026 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6028 *finish = X_EVENT_GOTO_OUT;
6029 goto done;
6032 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6033 if (!f)
6034 goto OTHER;
6035 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6036 *finish = X_EVENT_DROP;
6038 break;
6040 case SelectionNotify:
6041 last_user_time = event.xselection.time;
6042 #ifdef USE_X_TOOLKIT
6043 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6044 goto OTHER;
6045 #endif /* not USE_X_TOOLKIT */
6046 x_handle_selection_notify (&event.xselection);
6047 break;
6049 case SelectionClear: /* Someone has grabbed ownership. */
6050 last_user_time = event.xselectionclear.time;
6051 #ifdef USE_X_TOOLKIT
6052 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6053 goto OTHER;
6054 #endif /* USE_X_TOOLKIT */
6056 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6058 inev.ie.kind = SELECTION_CLEAR_EVENT;
6059 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6060 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6061 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6062 inev.ie.frame_or_window = Qnil;
6064 break;
6066 case SelectionRequest: /* Someone wants our selection. */
6067 last_user_time = event.xselectionrequest.time;
6068 #ifdef USE_X_TOOLKIT
6069 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6070 goto OTHER;
6071 #endif /* USE_X_TOOLKIT */
6073 XSelectionRequestEvent *eventp
6074 = (XSelectionRequestEvent *) &event;
6076 inev.ie.kind = SELECTION_REQUEST_EVENT;
6077 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6078 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6079 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6080 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6081 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6082 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6083 inev.ie.frame_or_window = Qnil;
6085 break;
6087 case PropertyNotify:
6088 last_user_time = event.xproperty.time;
6089 #if 0 /* This is plain wrong. In the case that we are waiting for a
6090 PropertyNotify used as an ACK in incremental selection
6091 transfer, the property will be on the receiver's window. */
6092 #if defined USE_X_TOOLKIT
6093 if (!x_any_window_to_frame (dpyinfo, event.xproperty.window))
6094 goto OTHER;
6095 #endif
6096 #endif
6097 x_handle_property_notify (&event.xproperty);
6098 goto OTHER;
6100 case ReparentNotify:
6101 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6102 if (f)
6104 int x, y;
6105 f->output_data.x->parent_desc = event.xreparent.parent;
6106 x_real_positions (f, &x, &y);
6107 f->left_pos = x;
6108 f->top_pos = y;
6110 /* Perhaps reparented due to a WM restart. Reset this. */
6111 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6112 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6114 goto OTHER;
6116 case Expose:
6117 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6118 if (f)
6120 x_check_fullscreen (f);
6122 #ifdef USE_GTK
6123 /* This seems to be needed for GTK 2.6. */
6124 x_clear_area (event.xexpose.display,
6125 event.xexpose.window,
6126 event.xexpose.x, event.xexpose.y,
6127 event.xexpose.width, event.xexpose.height,
6128 FALSE);
6129 #endif
6130 if (f->async_visible == 0)
6132 f->async_visible = 1;
6133 f->async_iconified = 0;
6134 f->output_data.x->has_been_visible = 1;
6135 SET_FRAME_GARBAGED (f);
6137 else
6138 expose_frame (f,
6139 event.xexpose.x, event.xexpose.y,
6140 event.xexpose.width, event.xexpose.height);
6142 else
6144 #ifndef USE_TOOLKIT_SCROLL_BARS
6145 struct scroll_bar *bar;
6146 #endif
6147 #if defined USE_LUCID
6148 /* Submenus of the Lucid menu bar aren't widgets
6149 themselves, so there's no way to dispatch events
6150 to them. Recognize this case separately. */
6152 Widget widget
6153 = x_window_to_menu_bar (event.xexpose.window);
6154 if (widget)
6155 xlwmenu_redisplay (widget);
6157 #endif /* USE_LUCID */
6159 #ifdef USE_TOOLKIT_SCROLL_BARS
6160 /* Dispatch event to the widget. */
6161 goto OTHER;
6162 #else /* not USE_TOOLKIT_SCROLL_BARS */
6163 bar = x_window_to_scroll_bar (event.xexpose.display,
6164 event.xexpose.window);
6166 if (bar)
6167 x_scroll_bar_expose (bar, &event);
6168 #ifdef USE_X_TOOLKIT
6169 else
6170 goto OTHER;
6171 #endif /* USE_X_TOOLKIT */
6172 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6174 break;
6176 case GraphicsExpose: /* This occurs when an XCopyArea's
6177 source area was obscured or not
6178 available. */
6179 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6180 if (f)
6182 expose_frame (f,
6183 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6184 event.xgraphicsexpose.width,
6185 event.xgraphicsexpose.height);
6187 #ifdef USE_X_TOOLKIT
6188 else
6189 goto OTHER;
6190 #endif /* USE_X_TOOLKIT */
6191 break;
6193 case NoExpose: /* This occurs when an XCopyArea's
6194 source area was completely
6195 available. */
6196 break;
6198 case UnmapNotify:
6199 /* Redo the mouse-highlight after the tooltip has gone. */
6200 if (event.xmap.window == tip_window)
6202 tip_window = 0;
6203 redo_mouse_highlight ();
6206 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6207 if (f) /* F may no longer exist if
6208 the frame was deleted. */
6210 /* While a frame is unmapped, display generation is
6211 disabled; you don't want to spend time updating a
6212 display that won't ever be seen. */
6213 f->async_visible = 0;
6214 /* We can't distinguish, from the event, whether the window
6215 has become iconified or invisible. So assume, if it
6216 was previously visible, than now it is iconified.
6217 But x_make_frame_invisible clears both
6218 the visible flag and the iconified flag;
6219 and that way, we know the window is not iconified now. */
6220 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6222 f->async_iconified = 1;
6224 inev.ie.kind = ICONIFY_EVENT;
6225 XSETFRAME (inev.ie.frame_or_window, f);
6228 goto OTHER;
6230 case MapNotify:
6231 if (event.xmap.window == tip_window)
6232 /* The tooltip has been drawn already. Avoid
6233 the SET_FRAME_GARBAGED below. */
6234 goto OTHER;
6236 /* We use x_top_window_to_frame because map events can
6237 come for sub-windows and they don't mean that the
6238 frame is visible. */
6239 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6240 if (f)
6242 /* wait_reading_process_output will notice this and update
6243 the frame's display structures.
6244 If we where iconified, we should not set garbaged,
6245 because that stops redrawing on Expose events. This looks
6246 bad if we are called from a recursive event loop
6247 (x_dispatch_event), for example when a dialog is up. */
6248 if (! f->async_iconified)
6249 SET_FRAME_GARBAGED (f);
6251 f->async_visible = 1;
6252 f->async_iconified = 0;
6253 f->output_data.x->has_been_visible = 1;
6255 if (f->iconified)
6257 inev.ie.kind = DEICONIFY_EVENT;
6258 XSETFRAME (inev.ie.frame_or_window, f);
6260 else if (! NILP (Vframe_list)
6261 && ! NILP (XCDR (Vframe_list)))
6262 /* Force a redisplay sooner or later
6263 to update the frame titles
6264 in case this is the second frame. */
6265 record_asynch_buffer_change ();
6267 goto OTHER;
6269 case KeyPress:
6271 last_user_time = event.xkey.time;
6272 ignore_next_mouse_click_timeout = 0;
6274 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6275 /* Dispatch KeyPress events when in menu. */
6276 if (popup_activated ())
6277 goto OTHER;
6278 #endif
6280 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6282 /* If mouse-highlight is an integer, input clears out
6283 mouse highlighting. */
6284 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6285 && (f == 0
6286 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6288 clear_mouse_face (dpyinfo);
6289 dpyinfo->mouse_face_hidden = 1;
6292 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6293 if (f == 0)
6295 /* Scroll bars consume key events, but we want
6296 the keys to go to the scroll bar's frame. */
6297 Widget widget = XtWindowToWidget (dpyinfo->display,
6298 event.xkey.window);
6299 if (widget && XmIsScrollBar (widget))
6301 widget = XtParent (widget);
6302 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6305 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6307 if (f != 0)
6309 KeySym keysym, orig_keysym;
6310 /* al%imercury@uunet.uu.net says that making this 81
6311 instead of 80 fixed a bug whereby meta chars made
6312 his Emacs hang.
6314 It seems that some version of XmbLookupString has
6315 a bug of not returning XBufferOverflow in
6316 status_return even if the input is too long to
6317 fit in 81 bytes. So, we must prepare sufficient
6318 bytes for copy_buffer. 513 bytes (256 chars for
6319 two-byte character set) seems to be a fairly good
6320 approximation. -- 2000.8.10 handa@etl.go.jp */
6321 unsigned char copy_buffer[513];
6322 unsigned char *copy_bufptr = copy_buffer;
6323 int copy_bufsiz = sizeof (copy_buffer);
6324 int modifiers;
6325 Lisp_Object coding_system = Qlatin_1;
6326 Lisp_Object c;
6328 #ifdef USE_GTK
6329 /* Don't pass keys to GTK. A Tab will shift focus to the
6330 tool bar in GTK 2.4. Keys will still go to menus and
6331 dialogs because in that case popup_activated is TRUE
6332 (see above). */
6333 *finish = X_EVENT_DROP;
6334 #endif
6336 event.xkey.state
6337 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6338 extra_keyboard_modifiers);
6339 modifiers = event.xkey.state;
6341 /* This will have to go some day... */
6343 /* make_lispy_event turns chars into control chars.
6344 Don't do it here because XLookupString is too eager. */
6345 event.xkey.state &= ~ControlMask;
6346 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6347 | dpyinfo->super_mod_mask
6348 | dpyinfo->hyper_mod_mask
6349 | dpyinfo->alt_mod_mask);
6351 /* In case Meta is ComposeCharacter,
6352 clear its status. According to Markus Ehrnsperger
6353 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6354 this enables ComposeCharacter to work whether or
6355 not it is combined with Meta. */
6356 if (modifiers & dpyinfo->meta_mod_mask)
6357 bzero (&compose_status, sizeof (compose_status));
6359 #ifdef HAVE_X_I18N
6360 if (FRAME_XIC (f))
6362 Status status_return;
6364 coding_system = Vlocale_coding_system;
6365 nbytes = XmbLookupString (FRAME_XIC (f),
6366 &event.xkey, copy_bufptr,
6367 copy_bufsiz, &keysym,
6368 &status_return);
6369 if (status_return == XBufferOverflow)
6371 copy_bufsiz = nbytes + 1;
6372 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6373 nbytes = XmbLookupString (FRAME_XIC (f),
6374 &event.xkey, copy_bufptr,
6375 copy_bufsiz, &keysym,
6376 &status_return);
6378 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6379 #if 0 && defined X_HAVE_UTF8_STRING
6380 else if (status_return == XLookupKeySym)
6381 { /* Try again but with utf-8. */
6382 coding_system = Qutf_8;
6383 nbytes = Xutf8LookupString (FRAME_XIC (f),
6384 &event.xkey, copy_bufptr,
6385 copy_bufsiz, &keysym,
6386 &status_return);
6387 if (status_return == XBufferOverflow)
6389 copy_bufsiz = nbytes + 1;
6390 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6391 nbytes = Xutf8LookupString (FRAME_XIC (f),
6392 &event.xkey,
6393 copy_bufptr,
6394 copy_bufsiz, &keysym,
6395 &status_return);
6398 #endif
6400 if (status_return == XLookupNone)
6401 break;
6402 else if (status_return == XLookupChars)
6404 keysym = NoSymbol;
6405 modifiers = 0;
6407 else if (status_return != XLookupKeySym
6408 && status_return != XLookupBoth)
6409 abort ();
6411 else
6412 nbytes = XLookupString (&event.xkey, copy_bufptr,
6413 copy_bufsiz, &keysym,
6414 &compose_status);
6415 #else
6416 nbytes = XLookupString (&event.xkey, copy_bufptr,
6417 copy_bufsiz, &keysym,
6418 &compose_status);
6419 #endif
6421 /* If not using XIM/XIC, and a compose sequence is in progress,
6422 we break here. Otherwise, chars_matched is always 0. */
6423 if (compose_status.chars_matched > 0 && nbytes == 0)
6424 break;
6426 bzero (&compose_status, sizeof (compose_status));
6427 orig_keysym = keysym;
6429 /* Common for all keysym input events. */
6430 XSETFRAME (inev.ie.frame_or_window, f);
6431 inev.ie.modifiers
6432 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6433 inev.ie.timestamp = event.xkey.time;
6435 /* First deal with keysyms which have defined
6436 translations to characters. */
6437 if (keysym >= 32 && keysym < 128)
6438 /* Avoid explicitly decoding each ASCII character. */
6440 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6441 inev.ie.code = keysym;
6442 goto done_keysym;
6445 /* Keysyms directly mapped to Unicode characters. */
6446 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6448 if (keysym < 0x01000080)
6449 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6450 else
6451 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6452 inev.ie.code = keysym & 0xFFFFFF;
6453 goto done_keysym;
6456 /* Now non-ASCII. */
6457 if (HASH_TABLE_P (Vx_keysym_table)
6458 && (NATNUMP (c = Fgethash (make_number (keysym),
6459 Vx_keysym_table,
6460 Qnil))))
6462 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6463 ? ASCII_KEYSTROKE_EVENT
6464 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6465 inev.ie.code = XFASTINT (c);
6466 goto done_keysym;
6469 /* Random non-modifier sorts of keysyms. */
6470 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6471 || keysym == XK_Delete
6472 #ifdef XK_ISO_Left_Tab
6473 || (keysym >= XK_ISO_Left_Tab
6474 && keysym <= XK_ISO_Enter)
6475 #endif
6476 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6477 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6478 #ifdef HPUX
6479 /* This recognizes the "extended function
6480 keys". It seems there's no cleaner way.
6481 Test IsModifierKey to avoid handling
6482 mode_switch incorrectly. */
6483 || ((unsigned) (keysym) >= XK_Select
6484 && (unsigned)(keysym) < XK_KP_Space)
6485 #endif
6486 #ifdef XK_dead_circumflex
6487 || orig_keysym == XK_dead_circumflex
6488 #endif
6489 #ifdef XK_dead_grave
6490 || orig_keysym == XK_dead_grave
6491 #endif
6492 #ifdef XK_dead_tilde
6493 || orig_keysym == XK_dead_tilde
6494 #endif
6495 #ifdef XK_dead_diaeresis
6496 || orig_keysym == XK_dead_diaeresis
6497 #endif
6498 #ifdef XK_dead_macron
6499 || orig_keysym == XK_dead_macron
6500 #endif
6501 #ifdef XK_dead_degree
6502 || orig_keysym == XK_dead_degree
6503 #endif
6504 #ifdef XK_dead_acute
6505 || orig_keysym == XK_dead_acute
6506 #endif
6507 #ifdef XK_dead_cedilla
6508 || orig_keysym == XK_dead_cedilla
6509 #endif
6510 #ifdef XK_dead_breve
6511 || orig_keysym == XK_dead_breve
6512 #endif
6513 #ifdef XK_dead_ogonek
6514 || orig_keysym == XK_dead_ogonek
6515 #endif
6516 #ifdef XK_dead_caron
6517 || orig_keysym == XK_dead_caron
6518 #endif
6519 #ifdef XK_dead_doubleacute
6520 || orig_keysym == XK_dead_doubleacute
6521 #endif
6522 #ifdef XK_dead_abovedot
6523 || orig_keysym == XK_dead_abovedot
6524 #endif
6525 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6526 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6527 /* Any "vendor-specific" key is ok. */
6528 || (orig_keysym & (1 << 28))
6529 || (keysym != NoSymbol && nbytes == 0))
6530 && ! (IsModifierKey (orig_keysym)
6531 /* The symbols from XK_ISO_Lock
6532 to XK_ISO_Last_Group_Lock
6533 don't have real modifiers but
6534 should be treated similarly to
6535 Mode_switch by Emacs. */
6536 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6537 || ((unsigned)(orig_keysym)
6538 >= XK_ISO_Lock
6539 && (unsigned)(orig_keysym)
6540 <= XK_ISO_Last_Group_Lock)
6541 #endif
6544 STORE_KEYSYM_FOR_DEBUG (keysym);
6545 /* make_lispy_event will convert this to a symbolic
6546 key. */
6547 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6548 inev.ie.code = keysym;
6549 goto done_keysym;
6552 { /* Raw bytes, not keysym. */
6553 register int i;
6554 register int c;
6555 int nchars, len;
6557 for (i = 0, nchars = 0; i < nbytes; i++)
6559 if (ASCII_BYTE_P (copy_bufptr[i]))
6560 nchars++;
6561 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6564 if (nchars < nbytes)
6566 /* Decode the input data. */
6567 int require;
6568 unsigned char *p;
6570 /* The input should be decoded with `coding_system'
6571 which depends on which X*LookupString function
6572 we used just above and the locale. */
6573 setup_coding_system (coding_system, &coding);
6574 coding.src_multibyte = 0;
6575 coding.dst_multibyte = 1;
6576 /* The input is converted to events, thus we can't
6577 handle composition. Anyway, there's no XIM that
6578 gives us composition information. */
6579 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6581 require = MAX_MULTIBYTE_LENGTH * nbytes;
6582 coding.destination = alloca (require);
6583 coding.dst_bytes = require;
6584 coding.mode |= CODING_MODE_LAST_BLOCK;
6585 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6586 nbytes = coding.produced;
6587 nchars = coding.produced_char;
6588 copy_bufptr = coding.destination;
6591 /* Convert the input data to a sequence of
6592 character events. */
6593 for (i = 0; i < nbytes; i += len)
6595 if (nchars == nbytes)
6596 c = copy_bufptr[i], len = 1;
6597 else
6598 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i,
6599 nbytes - i, len);
6600 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6601 ? ASCII_KEYSTROKE_EVENT
6602 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6603 inev.ie.code = c;
6604 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6607 count += nchars;
6609 inev.ie.kind = NO_EVENT; /* Already stored above. */
6611 if (keysym == NoSymbol)
6612 break;
6615 done_keysym:
6616 #ifdef HAVE_X_I18N
6617 /* Don't dispatch this event since XtDispatchEvent calls
6618 XFilterEvent, and two calls in a row may freeze the
6619 client. */
6620 break;
6621 #else
6622 goto OTHER;
6623 #endif
6625 case KeyRelease:
6626 last_user_time = event.xkey.time;
6627 #ifdef HAVE_X_I18N
6628 /* Don't dispatch this event since XtDispatchEvent calls
6629 XFilterEvent, and two calls in a row may freeze the
6630 client. */
6631 break;
6632 #else
6633 goto OTHER;
6634 #endif
6636 case EnterNotify:
6637 last_user_time = event.xcrossing.time;
6638 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6640 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6642 if (f && x_mouse_click_focus_ignore_position)
6643 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6645 #if 0
6646 if (event.xcrossing.focus)
6648 /* Avoid nasty pop/raise loops. */
6649 if (f && (!(f->auto_raise)
6650 || !(f->auto_lower)
6651 || (event.xcrossing.time - enter_timestamp) > 500))
6653 x_new_focus_frame (dpyinfo, f);
6654 enter_timestamp = event.xcrossing.time;
6657 else if (f == dpyinfo->x_focus_frame)
6658 x_new_focus_frame (dpyinfo, 0);
6659 #endif
6661 /* EnterNotify counts as mouse movement,
6662 so update things that depend on mouse position. */
6663 if (f && !f->output_data.x->hourglass_p)
6664 note_mouse_movement (f, &event.xmotion);
6665 #ifdef USE_GTK
6666 /* We may get an EnterNotify on the buttons in the toolbar. In that
6667 case we moved out of any highlighted area and need to note this. */
6668 if (!f && last_mouse_glyph_frame)
6669 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6670 #endif
6671 goto OTHER;
6673 case FocusIn:
6674 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6675 goto OTHER;
6677 case LeaveNotify:
6678 last_user_time = event.xcrossing.time;
6679 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6681 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6682 if (f)
6684 if (f == dpyinfo->mouse_face_mouse_frame)
6686 /* If we move outside the frame, then we're
6687 certainly no longer on any text in the frame. */
6688 clear_mouse_face (dpyinfo);
6689 dpyinfo->mouse_face_mouse_frame = 0;
6692 /* Generate a nil HELP_EVENT to cancel a help-echo.
6693 Do it only if there's something to cancel.
6694 Otherwise, the startup message is cleared when
6695 the mouse leaves the frame. */
6696 if (any_help_event_p)
6697 do_help = -1;
6699 #ifdef USE_GTK
6700 /* See comment in EnterNotify above */
6701 else if (last_mouse_glyph_frame)
6702 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6703 #endif
6704 goto OTHER;
6706 case FocusOut:
6707 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6708 goto OTHER;
6710 case MotionNotify:
6712 last_user_time = event.xmotion.time;
6713 previous_help_echo_string = help_echo_string;
6714 help_echo_string = Qnil;
6716 if (dpyinfo->grabbed && last_mouse_frame
6717 && FRAME_LIVE_P (last_mouse_frame))
6718 f = last_mouse_frame;
6719 else
6720 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6722 if (dpyinfo->mouse_face_hidden)
6724 dpyinfo->mouse_face_hidden = 0;
6725 clear_mouse_face (dpyinfo);
6728 if (f)
6731 /* Generate SELECT_WINDOW_EVENTs when needed.
6732 Don't let popup menus influence things (bug#1261). */
6733 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6735 Lisp_Object window;
6737 window = window_from_coordinates (f,
6738 event.xmotion.x, event.xmotion.y,
6739 0, 0, 0, 0);
6741 /* Window will be selected only when it is not selected now and
6742 last mouse movement event was not in it. Minibuffer window
6743 will be selected only when it is active. */
6744 if (WINDOWP (window)
6745 && !EQ (window, last_window)
6746 && !EQ (window, selected_window)
6747 /* For click-to-focus window managers
6748 create event iff we don't leave the
6749 selected frame. */
6750 && (focus_follows_mouse
6751 || (EQ (XWINDOW (window)->frame,
6752 XWINDOW (selected_window)->frame))))
6754 inev.ie.kind = SELECT_WINDOW_EVENT;
6755 inev.ie.frame_or_window = window;
6758 last_window=window;
6760 if (!note_mouse_movement (f, &event.xmotion))
6761 help_echo_string = previous_help_echo_string;
6763 else
6765 #ifndef USE_TOOLKIT_SCROLL_BARS
6766 struct scroll_bar *bar
6767 = x_window_to_scroll_bar (event.xmotion.display,
6768 event.xmotion.window);
6770 if (bar)
6771 x_scroll_bar_note_movement (bar, &event);
6772 #endif /* USE_TOOLKIT_SCROLL_BARS */
6774 /* If we move outside the frame, then we're
6775 certainly no longer on any text in the frame. */
6776 clear_mouse_face (dpyinfo);
6779 /* If the contents of the global variable help_echo_string
6780 has changed, generate a HELP_EVENT. */
6781 if (!NILP (help_echo_string)
6782 || !NILP (previous_help_echo_string))
6783 do_help = 1;
6784 goto OTHER;
6787 case ConfigureNotify:
6788 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6789 #ifdef USE_GTK
6790 if (!f
6791 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6792 && event.xconfigure.window == FRAME_X_WINDOW (f))
6794 xg_frame_resized (f, event.xconfigure.width,
6795 event.xconfigure.height);
6796 f = 0;
6798 #endif
6799 if (f)
6801 #ifndef USE_X_TOOLKIT
6802 #ifndef USE_GTK
6803 /* If there is a pending resize for fullscreen, don't
6804 do this one, the right one will come later.
6805 The toolkit version doesn't seem to need this, but we
6806 need to reset it below. */
6807 int dont_resize
6808 = ((f->want_fullscreen & FULLSCREEN_WAIT)
6809 && f->new_text_cols != 0);
6810 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6811 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6813 if (dont_resize)
6814 goto OTHER;
6816 /* In the toolkit version, change_frame_size
6817 is called by the code that handles resizing
6818 of the EmacsFrame widget. */
6820 /* Even if the number of character rows and columns has
6821 not changed, the font size may have changed, so we need
6822 to check the pixel dimensions as well. */
6823 if (columns != FRAME_COLS (f)
6824 || rows != FRAME_LINES (f)
6825 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6826 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6828 change_frame_size (f, rows, columns, 0, 1, 0);
6829 SET_FRAME_GARBAGED (f);
6830 cancel_mouse_face (f);
6833 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6834 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6835 #endif /* not USE_GTK */
6836 #endif
6838 #ifdef USE_GTK
6839 /* GTK creates windows but doesn't map them.
6840 Only get real positions and check fullscreen when mapped. */
6841 if (FRAME_GTK_OUTER_WIDGET (f)
6842 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6843 #endif
6845 x_real_positions (f, &f->left_pos, &f->top_pos);
6847 if (f->want_fullscreen & FULLSCREEN_WAIT)
6848 f->want_fullscreen &= ~(FULLSCREEN_WAIT|FULLSCREEN_BOTH);
6851 #ifdef HAVE_X_I18N
6852 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6853 xic_set_statusarea (f);
6854 #endif
6856 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
6858 /* Since the WM decorations come below top_pos now,
6859 we must put them below top_pos in the future. */
6860 f->win_gravity = NorthWestGravity;
6861 x_wm_set_size_hint (f, (long) 0, 0);
6864 goto OTHER;
6866 case ButtonRelease:
6867 case ButtonPress:
6869 /* If we decide we want to generate an event to be seen
6870 by the rest of Emacs, we put it here. */
6871 int tool_bar_p = 0;
6873 bzero (&compose_status, sizeof (compose_status));
6874 last_mouse_glyph_frame = 0;
6875 last_user_time = event.xbutton.time;
6877 if (dpyinfo->grabbed
6878 && last_mouse_frame
6879 && FRAME_LIVE_P (last_mouse_frame))
6880 f = last_mouse_frame;
6881 else
6882 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6884 if (f)
6886 /* Is this in the tool-bar? */
6887 if (WINDOWP (f->tool_bar_window)
6888 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6890 Lisp_Object window;
6891 int x = event.xbutton.x;
6892 int y = event.xbutton.y;
6894 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6895 tool_bar_p = EQ (window, f->tool_bar_window);
6897 if (tool_bar_p && event.xbutton.button < 4)
6899 handle_tool_bar_click (f, x, y,
6900 event.xbutton.type == ButtonPress,
6901 x_x_to_emacs_modifiers (dpyinfo,
6902 event.xbutton.state));
6906 if (!tool_bar_p)
6907 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6908 if (! popup_activated ())
6909 #endif
6911 if (ignore_next_mouse_click_timeout)
6913 if (event.type == ButtonPress
6914 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6916 ignore_next_mouse_click_timeout = 0;
6917 construct_mouse_click (&inev.ie, &event.xbutton, f);
6919 if (event.type == ButtonRelease)
6920 ignore_next_mouse_click_timeout = 0;
6922 else
6923 construct_mouse_click (&inev.ie, &event.xbutton, f);
6925 if (FRAME_X_EMBEDDED_P (f))
6926 xembed_send_message (f, event.xbutton.time,
6927 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6929 else
6931 struct scroll_bar *bar
6932 = x_window_to_scroll_bar (event.xbutton.display,
6933 event.xbutton.window);
6935 #ifdef USE_TOOLKIT_SCROLL_BARS
6936 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6937 scroll bars. */
6938 if (bar && event.xbutton.state & ControlMask)
6940 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6941 *finish = X_EVENT_DROP;
6943 #else /* not USE_TOOLKIT_SCROLL_BARS */
6944 if (bar)
6945 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6946 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6949 if (event.type == ButtonPress)
6951 dpyinfo->grabbed |= (1 << event.xbutton.button);
6952 last_mouse_frame = f;
6954 if (!tool_bar_p)
6955 last_tool_bar_item = -1;
6957 else
6958 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6960 /* Ignore any mouse motion that happened before this event;
6961 any subsequent mouse-movement Emacs events should reflect
6962 only motion after the ButtonPress/Release. */
6963 if (f != 0)
6964 f->mouse_moved = 0;
6966 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6967 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6968 /* For a down-event in the menu bar,
6969 don't pass it to Xt right now.
6970 Instead, save it away
6971 and we will pass it to Xt from kbd_buffer_get_event.
6972 That way, we can run some Lisp code first. */
6973 if (
6974 #ifdef USE_GTK
6975 ! popup_activated ()
6976 /* Gtk+ menus only react to the first three buttons. */
6977 && event.xbutton.button < 3
6979 #endif
6980 f && event.type == ButtonPress
6981 /* Verify the event is really within the menu bar
6982 and not just sent to it due to grabbing. */
6983 && event.xbutton.x >= 0
6984 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6985 && event.xbutton.y >= 0
6986 && event.xbutton.y < f->output_data.x->menubar_height
6987 && event.xbutton.same_screen)
6989 SET_SAVED_BUTTON_EVENT;
6990 XSETFRAME (last_mouse_press_frame, f);
6991 #ifdef USE_GTK
6992 *finish = X_EVENT_DROP;
6993 #endif
6995 else if (event.type == ButtonPress)
6997 last_mouse_press_frame = Qnil;
6998 goto OTHER;
7001 #ifdef USE_MOTIF /* This should do not harm for Lucid,
7002 but I am trying to be cautious. */
7003 else if (event.type == ButtonRelease)
7005 if (!NILP (last_mouse_press_frame))
7007 f = XFRAME (last_mouse_press_frame);
7008 if (f->output_data.x)
7009 SET_SAVED_BUTTON_EVENT;
7011 else
7012 goto OTHER;
7014 #endif /* USE_MOTIF */
7015 else
7016 goto OTHER;
7017 #endif /* USE_X_TOOLKIT || USE_GTK */
7019 break;
7021 case CirculateNotify:
7022 goto OTHER;
7024 case CirculateRequest:
7025 goto OTHER;
7027 case VisibilityNotify:
7028 goto OTHER;
7030 case MappingNotify:
7031 /* Someone has changed the keyboard mapping - update the
7032 local cache. */
7033 switch (event.xmapping.request)
7035 case MappingModifier:
7036 x_find_modifier_meanings (dpyinfo);
7037 /* This is meant to fall through. */
7038 case MappingKeyboard:
7039 XRefreshKeyboardMapping (&event.xmapping);
7041 goto OTHER;
7043 default:
7044 OTHER:
7045 #ifdef USE_X_TOOLKIT
7046 BLOCK_INPUT;
7047 if (*finish != X_EVENT_DROP)
7048 XtDispatchEvent (&event);
7049 UNBLOCK_INPUT;
7050 #endif /* USE_X_TOOLKIT */
7051 break;
7054 done:
7055 if (inev.ie.kind != NO_EVENT)
7057 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7058 count++;
7061 if (do_help
7062 && !(hold_quit && hold_quit->kind != NO_EVENT))
7064 Lisp_Object frame;
7066 if (f)
7067 XSETFRAME (frame, f);
7068 else
7069 frame = Qnil;
7071 if (do_help > 0)
7073 any_help_event_p = 1;
7074 gen_help_event (help_echo_string, frame, help_echo_window,
7075 help_echo_object, help_echo_pos);
7077 else
7079 help_echo_string = Qnil;
7080 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7082 count++;
7085 *eventp = event;
7086 return count;
7090 /* Handles the XEvent EVENT on display DISPLAY.
7091 This is used for event loops outside the normal event handling,
7092 i.e. looping while a popup menu or a dialog is posted.
7094 Returns the value handle_one_xevent sets in the finish argument. */
7096 x_dispatch_event (event, display)
7097 XEvent *event;
7098 Display *display;
7100 struct x_display_info *dpyinfo;
7101 int finish = X_EVENT_NORMAL;
7103 dpyinfo = x_display_info_for_display (display);
7105 if (dpyinfo)
7106 handle_one_xevent (dpyinfo, event, &finish, 0);
7108 return finish;
7112 /* Read events coming from the X server.
7113 This routine is called by the SIGIO handler.
7114 We return as soon as there are no more events to be read.
7116 We return the number of characters stored into the buffer,
7117 thus pretending to be `read' (except the characters we store
7118 in the keyboard buffer can be multibyte, so are not necessarily
7119 C chars).
7121 EXPECTED is nonzero if the caller knows input is available. */
7123 static int
7124 XTread_socket (terminal, expected, hold_quit)
7125 struct terminal *terminal;
7126 int expected;
7127 struct input_event *hold_quit;
7129 int count = 0;
7130 XEvent event;
7131 int event_found = 0;
7132 #if 0
7133 struct x_display_info *dpyinfo;
7134 #endif
7136 if (interrupt_input_blocked)
7138 interrupt_input_pending = 1;
7139 return -1;
7142 interrupt_input_pending = 0;
7143 BLOCK_INPUT;
7145 /* So people can tell when we have read the available input. */
7146 input_signal_count++;
7148 ++handling_signal;
7150 #ifdef HAVE_X_SM
7151 /* Only check session manager input for the primary display. */
7152 if (terminal->id == 1 && x_session_have_connection ())
7154 struct input_event inev;
7155 BLOCK_INPUT;
7156 /* We don't need to EVENT_INIT (inev) here, as
7157 x_session_check_input copies an entire input_event. */
7158 if (x_session_check_input (&inev))
7160 kbd_buffer_store_event_hold (&inev, hold_quit);
7161 count++;
7163 UNBLOCK_INPUT;
7165 #endif
7167 /* For debugging, this gives a way to fake an I/O error. */
7168 if (terminal->display_info.x == XTread_socket_fake_io_error)
7170 XTread_socket_fake_io_error = 0;
7171 x_io_error_quitter (terminal->display_info.x->display);
7174 #if 0 /* This loop is a noop now. */
7175 /* Find the display we are supposed to read input for.
7176 It's the one communicating on descriptor SD. */
7177 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
7179 #if 0 /* This ought to be unnecessary; let's verify it. */
7180 #ifdef FIOSNBIO
7181 /* If available, Xlib uses FIOSNBIO to make the socket
7182 non-blocking, and then looks for EWOULDBLOCK. If O_NDELAY is set,
7183 FIOSNBIO is ignored, and instead of signaling EWOULDBLOCK,
7184 a read returns 0, which Xlib interprets as equivalent to EPIPE. */
7185 fcntl (dpyinfo->connection, F_SETFL, 0);
7186 #endif /* ! defined (FIOSNBIO) */
7187 #endif
7189 #if 0 /* This code can't be made to work, with multiple displays,
7190 and appears not to be used on any system any more.
7191 Also keyboard.c doesn't turn O_NDELAY on and off
7192 for X connections. */
7193 #ifndef SIGIO
7194 #ifndef HAVE_SELECT
7195 if (! (fcntl (dpyinfo->connection, F_GETFL, 0) & O_NDELAY))
7197 extern int read_alarm_should_throw;
7198 read_alarm_should_throw = 1;
7199 XPeekEvent (dpyinfo->display, &event);
7200 read_alarm_should_throw = 0;
7202 #endif /* HAVE_SELECT */
7203 #endif /* SIGIO */
7204 #endif
7206 #endif
7208 #ifndef USE_GTK
7209 while (XPending (terminal->display_info.x->display))
7211 int finish;
7213 XNextEvent (terminal->display_info.x->display, &event);
7215 #ifdef HAVE_X_I18N
7216 /* Filter events for the current X input method. */
7217 if (x_filter_event (terminal->display_info.x, &event))
7218 break;
7219 #endif
7220 event_found = 1;
7222 count += handle_one_xevent (terminal->display_info.x,
7223 &event, &finish, hold_quit);
7225 if (finish == X_EVENT_GOTO_OUT)
7226 goto out;
7229 #else /* USE_GTK */
7231 /* For GTK we must use the GTK event loop. But XEvents gets passed
7232 to our filter function above, and then to the big event switch.
7233 We use a bunch of globals to communicate with our filter function,
7234 that is kind of ugly, but it works.
7236 There is no way to do one display at the time, GTK just does events
7237 from all displays. */
7239 while (gtk_events_pending ())
7241 current_count = count;
7242 current_hold_quit = hold_quit;
7244 gtk_main_iteration ();
7246 count = current_count;
7247 current_count = -1;
7248 current_hold_quit = 0;
7250 if (current_finish == X_EVENT_GOTO_OUT)
7251 break;
7253 #endif /* USE_GTK */
7255 out:;
7257 /* On some systems, an X bug causes Emacs to get no more events
7258 when the window is destroyed. Detect that. (1994.) */
7259 if (! event_found)
7261 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7262 One XNOOP in 100 loops will make Emacs terminate.
7263 B. Bretthauer, 1994 */
7264 x_noop_count++;
7265 if (x_noop_count >= 100)
7267 x_noop_count=0;
7269 if (next_noop_dpyinfo == 0)
7270 next_noop_dpyinfo = x_display_list;
7272 XNoOp (next_noop_dpyinfo->display);
7274 /* Each time we get here, cycle through the displays now open. */
7275 next_noop_dpyinfo = next_noop_dpyinfo->next;
7279 /* If the focus was just given to an auto-raising frame,
7280 raise it now. */
7281 /* ??? This ought to be able to handle more than one such frame. */
7282 if (pending_autoraise_frame)
7284 x_raise_frame (pending_autoraise_frame);
7285 pending_autoraise_frame = 0;
7288 --handling_signal;
7289 UNBLOCK_INPUT;
7291 return count;
7297 /***********************************************************************
7298 Text Cursor
7299 ***********************************************************************/
7301 /* Set clipping for output in glyph row ROW. W is the window in which
7302 we operate. GC is the graphics context to set clipping in.
7304 ROW may be a text row or, e.g., a mode line. Text rows must be
7305 clipped to the interior of the window dedicated to text display,
7306 mode lines must be clipped to the whole window. */
7308 static void
7309 x_clip_to_row (w, row, area, gc)
7310 struct window *w;
7311 struct glyph_row *row;
7312 int area;
7313 GC gc;
7315 struct frame *f = XFRAME (WINDOW_FRAME (w));
7316 XRectangle clip_rect;
7317 int window_x, window_y, window_width;
7319 window_box (w, area, &window_x, &window_y, &window_width, 0);
7321 clip_rect.x = window_x;
7322 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7323 clip_rect.y = max (clip_rect.y, window_y);
7324 clip_rect.width = window_width;
7325 clip_rect.height = row->visible_height;
7327 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7331 /* Draw a hollow box cursor on window W in glyph row ROW. */
7333 static void
7334 x_draw_hollow_cursor (w, row)
7335 struct window *w;
7336 struct glyph_row *row;
7338 struct frame *f = XFRAME (WINDOW_FRAME (w));
7339 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7340 Display *dpy = FRAME_X_DISPLAY (f);
7341 int x, y, wd, h;
7342 XGCValues xgcv;
7343 struct glyph *cursor_glyph;
7344 GC gc;
7346 /* Get the glyph the cursor is on. If we can't tell because
7347 the current matrix is invalid or such, give up. */
7348 cursor_glyph = get_phys_cursor_glyph (w);
7349 if (cursor_glyph == NULL)
7350 return;
7352 /* Compute frame-relative coordinates for phys cursor. */
7353 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7354 wd = w->phys_cursor_width;
7356 /* The foreground of cursor_gc is typically the same as the normal
7357 background color, which can cause the cursor box to be invisible. */
7358 xgcv.foreground = f->output_data.x->cursor_pixel;
7359 if (dpyinfo->scratch_cursor_gc)
7360 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7361 else
7362 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7363 GCForeground, &xgcv);
7364 gc = dpyinfo->scratch_cursor_gc;
7366 /* Set clipping, draw the rectangle, and reset clipping again. */
7367 x_clip_to_row (w, row, TEXT_AREA, gc);
7368 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7369 XSetClipMask (dpy, gc, None);
7373 /* Draw a bar cursor on window W in glyph row ROW.
7375 Implementation note: One would like to draw a bar cursor with an
7376 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7377 Unfortunately, I didn't find a font yet that has this property set.
7378 --gerd. */
7380 static void
7381 x_draw_bar_cursor (w, row, width, kind)
7382 struct window *w;
7383 struct glyph_row *row;
7384 int width;
7385 enum text_cursor_kinds kind;
7387 struct frame *f = XFRAME (w->frame);
7388 struct glyph *cursor_glyph;
7390 /* If cursor is out of bounds, don't draw garbage. This can happen
7391 in mini-buffer windows when switching between echo area glyphs
7392 and mini-buffer. */
7393 cursor_glyph = get_phys_cursor_glyph (w);
7394 if (cursor_glyph == NULL)
7395 return;
7397 /* If on an image, draw like a normal cursor. That's usually better
7398 visible than drawing a bar, esp. if the image is large so that
7399 the bar might not be in the window. */
7400 if (cursor_glyph->type == IMAGE_GLYPH)
7402 struct glyph_row *row;
7403 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7404 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7406 else
7408 Display *dpy = FRAME_X_DISPLAY (f);
7409 Window window = FRAME_X_WINDOW (f);
7410 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7411 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7412 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7413 XGCValues xgcv;
7415 /* If the glyph's background equals the color we normally draw
7416 the bar cursor in, the bar cursor in its normal color is
7417 invisible. Use the glyph's foreground color instead in this
7418 case, on the assumption that the glyph's colors are chosen so
7419 that the glyph is legible. */
7420 if (face->background == f->output_data.x->cursor_pixel)
7421 xgcv.background = xgcv.foreground = face->foreground;
7422 else
7423 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7424 xgcv.graphics_exposures = 0;
7426 if (gc)
7427 XChangeGC (dpy, gc, mask, &xgcv);
7428 else
7430 gc = XCreateGC (dpy, window, mask, &xgcv);
7431 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7434 if (width < 0)
7435 width = FRAME_CURSOR_WIDTH (f);
7436 width = min (cursor_glyph->pixel_width, width);
7438 w->phys_cursor_width = width;
7439 x_clip_to_row (w, row, TEXT_AREA, gc);
7441 if (kind == BAR_CURSOR)
7442 XFillRectangle (dpy, window, gc,
7443 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7444 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7445 width, row->height);
7446 else
7447 XFillRectangle (dpy, window, gc,
7448 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7449 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7450 row->height - width),
7451 min (FRAME_COLUMN_WIDTH (f), cursor_glyph->pixel_width),
7452 width);
7454 XSetClipMask (dpy, gc, None);
7459 /* RIF: Define cursor CURSOR on frame F. */
7461 static void
7462 x_define_frame_cursor (f, cursor)
7463 struct frame *f;
7464 Cursor cursor;
7466 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7470 /* RIF: Clear area on frame F. */
7472 static void
7473 x_clear_frame_area (f, x, y, width, height)
7474 struct frame *f;
7475 int x, y, width, height;
7477 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7478 x, y, width, height, False);
7482 /* RIF: Draw cursor on window W. */
7484 static void
7485 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7486 struct window *w;
7487 struct glyph_row *glyph_row;
7488 int x, y;
7489 int cursor_type, cursor_width;
7490 int on_p, active_p;
7492 struct frame *f = XFRAME (WINDOW_FRAME (w));
7494 if (on_p)
7496 w->phys_cursor_type = cursor_type;
7497 w->phys_cursor_on_p = 1;
7499 if (glyph_row->exact_window_width_line_p
7500 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7502 glyph_row->cursor_in_fringe_p = 1;
7503 draw_fringe_bitmap (w, glyph_row, 0);
7505 else
7506 switch (cursor_type)
7508 case HOLLOW_BOX_CURSOR:
7509 x_draw_hollow_cursor (w, glyph_row);
7510 break;
7512 case FILLED_BOX_CURSOR:
7513 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7514 break;
7516 case BAR_CURSOR:
7517 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7518 break;
7520 case HBAR_CURSOR:
7521 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7522 break;
7524 case NO_CURSOR:
7525 w->phys_cursor_width = 0;
7526 break;
7528 default:
7529 abort ();
7532 #ifdef HAVE_X_I18N
7533 if (w == XWINDOW (f->selected_window))
7534 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7535 xic_set_preeditarea (w, x, y);
7536 #endif
7539 #ifndef XFlush
7540 XFlush (FRAME_X_DISPLAY (f));
7541 #endif
7545 /* Icons. */
7547 /* Make the x-window of frame F use the gnu icon bitmap. */
7550 x_bitmap_icon (f, file)
7551 struct frame *f;
7552 Lisp_Object file;
7554 int bitmap_id;
7556 if (FRAME_X_WINDOW (f) == 0)
7557 return 1;
7559 /* Free up our existing icon bitmap and mask if any. */
7560 if (f->output_data.x->icon_bitmap > 0)
7561 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7562 f->output_data.x->icon_bitmap = 0;
7564 if (STRINGP (file))
7566 #ifdef USE_GTK
7567 /* Use gtk_window_set_icon_from_file () if available,
7568 It's not restricted to bitmaps */
7569 if (xg_set_icon (f, file))
7570 return 0;
7571 #endif /* USE_GTK */
7572 bitmap_id = x_create_bitmap_from_file (f, file);
7573 x_create_bitmap_mask (f, bitmap_id);
7575 else
7577 /* Create the GNU bitmap and mask if necessary. */
7578 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7580 int rc = -1;
7582 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7583 #ifdef USE_GTK
7584 if (xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7585 return 0;
7586 #else
7587 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7588 if (rc != -1)
7589 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7590 #endif /* USE_GTK */
7591 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
7593 /* If all else fails, use the (black and white) xbm image. */
7594 if (rc == -1)
7596 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7597 gnu_xbm_width, gnu_xbm_height);
7598 if (rc == -1)
7599 return 1;
7601 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7602 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7606 /* The first time we create the GNU bitmap and mask,
7607 this increments the ref-count one extra time.
7608 As a result, the GNU bitmap and mask are never freed.
7609 That way, we don't have to worry about allocating it again. */
7610 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7612 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7615 x_wm_set_icon_pixmap (f, bitmap_id);
7616 f->output_data.x->icon_bitmap = bitmap_id;
7618 return 0;
7622 /* Make the x-window of frame F use a rectangle with text.
7623 Use ICON_NAME as the text. */
7626 x_text_icon (f, icon_name)
7627 struct frame *f;
7628 char *icon_name;
7630 if (FRAME_X_WINDOW (f) == 0)
7631 return 1;
7634 XTextProperty text;
7635 text.value = (unsigned char *) icon_name;
7636 text.encoding = XA_STRING;
7637 text.format = 8;
7638 text.nitems = strlen (icon_name);
7639 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7642 if (f->output_data.x->icon_bitmap > 0)
7643 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7644 f->output_data.x->icon_bitmap = 0;
7645 x_wm_set_icon_pixmap (f, 0);
7647 return 0;
7650 #define X_ERROR_MESSAGE_SIZE 200
7652 /* If non-nil, this should be a string.
7653 It means catch X errors and store the error message in this string.
7655 The reason we use a stack is that x_catch_error/x_uncatch_error can
7656 be called from a signal handler.
7659 struct x_error_message_stack {
7660 char string[X_ERROR_MESSAGE_SIZE];
7661 Display *dpy;
7662 struct x_error_message_stack *prev;
7664 static struct x_error_message_stack *x_error_message;
7666 /* An X error handler which stores the error message in
7667 *x_error_message. This is called from x_error_handler if
7668 x_catch_errors is in effect. */
7670 static void
7671 x_error_catcher (display, error)
7672 Display *display;
7673 XErrorEvent *error;
7675 XGetErrorText (display, error->error_code,
7676 x_error_message->string,
7677 X_ERROR_MESSAGE_SIZE);
7680 /* Begin trapping X errors for display DPY. Actually we trap X errors
7681 for all displays, but DPY should be the display you are actually
7682 operating on.
7684 After calling this function, X protocol errors no longer cause
7685 Emacs to exit; instead, they are recorded in the string
7686 stored in *x_error_message.
7688 Calling x_check_errors signals an Emacs error if an X error has
7689 occurred since the last call to x_catch_errors or x_check_errors.
7691 Calling x_uncatch_errors resumes the normal error handling. */
7693 void x_check_errors ();
7695 void
7696 x_catch_errors (dpy)
7697 Display *dpy;
7699 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7701 /* Make sure any errors from previous requests have been dealt with. */
7702 XSync (dpy, False);
7704 data->dpy = dpy;
7705 data->string[0] = 0;
7706 data->prev = x_error_message;
7707 x_error_message = data;
7710 /* Undo the last x_catch_errors call.
7711 DPY should be the display that was passed to x_catch_errors. */
7713 void
7714 x_uncatch_errors ()
7716 struct x_error_message_stack *tmp;
7718 BLOCK_INPUT;
7720 /* The display may have been closed before this function is called.
7721 Check if it is still open before calling XSync. */
7722 if (x_display_info_for_display (x_error_message->dpy) != 0)
7723 XSync (x_error_message->dpy, False);
7725 tmp = x_error_message;
7726 x_error_message = x_error_message->prev;
7727 xfree (tmp);
7728 UNBLOCK_INPUT;
7731 /* If any X protocol errors have arrived since the last call to
7732 x_catch_errors or x_check_errors, signal an Emacs error using
7733 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7735 void
7736 x_check_errors (dpy, format)
7737 Display *dpy;
7738 char *format;
7740 /* Make sure to catch any errors incurred so far. */
7741 XSync (dpy, False);
7743 if (x_error_message->string[0])
7745 char string[X_ERROR_MESSAGE_SIZE];
7746 bcopy (x_error_message->string, string, X_ERROR_MESSAGE_SIZE);
7747 x_uncatch_errors ();
7748 error (format, string);
7752 /* Nonzero if we had any X protocol errors
7753 since we did x_catch_errors on DPY. */
7756 x_had_errors_p (dpy)
7757 Display *dpy;
7759 /* Make sure to catch any errors incurred so far. */
7760 XSync (dpy, False);
7762 return x_error_message->string[0] != 0;
7765 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7767 void
7768 x_clear_errors (dpy)
7769 Display *dpy;
7771 x_error_message->string[0] = 0;
7774 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7775 * idea. --lorentey */
7776 /* Close off all unclosed x_catch_errors calls. */
7778 void
7779 x_fully_uncatch_errors ()
7781 while (x_error_message)
7782 x_uncatch_errors ();
7784 #endif
7786 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7789 x_catching_errors ()
7791 return x_error_message != 0;
7794 #if 0
7795 static unsigned int x_wire_count;
7796 x_trace_wire ()
7798 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7800 #endif /* ! 0 */
7803 /* Handle SIGPIPE, which can happen when the connection to a server
7804 simply goes away. SIGPIPE is handled by x_connection_signal.
7805 Don't need to do anything, because the write which caused the
7806 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7807 which will do the appropriate cleanup for us. */
7809 static SIGTYPE
7810 x_connection_signal (signalnum) /* If we don't have an argument, */
7811 int signalnum; /* some compilers complain in signal calls. */
7813 #ifdef USG
7814 /* USG systems forget handlers when they are used;
7815 must reestablish each time */
7816 signal (signalnum, x_connection_signal);
7817 #endif /* USG */
7821 /************************************************************************
7822 Handling X errors
7823 ************************************************************************/
7825 /* Error message passed to x_connection_closed. */
7827 static char *error_msg;
7829 /* Function installed as fatal_error_signal_hook in
7830 x_connection_closed. Print the X error message, and exit normally,
7831 instead of dumping core when XtCloseDisplay fails. */
7833 static void
7834 x_fatal_error_signal ()
7836 fprintf (stderr, "%s\n", error_msg);
7837 exit (70);
7840 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7841 the text of an error message that lead to the connection loss. */
7843 static SIGTYPE
7844 x_connection_closed (dpy, error_message)
7845 Display *dpy;
7846 char *error_message;
7848 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7849 Lisp_Object frame, tail;
7850 int index = SPECPDL_INDEX ();
7852 error_msg = (char *) alloca (strlen (error_message) + 1);
7853 strcpy (error_msg, error_message);
7854 handling_signal = 0;
7856 /* Prevent being called recursively because of an error condition
7857 below. Otherwise, we might end up with printing ``can't find per
7858 display information'' in the recursive call instead of printing
7859 the original message here. */
7860 x_catch_errors (dpy);
7862 /* Inhibit redisplay while frames are being deleted. */
7863 specbind (Qinhibit_redisplay, Qt);
7865 if (dpyinfo)
7867 /* Protect display from being closed when we delete the last
7868 frame on it. */
7869 dpyinfo->reference_count++;
7870 dpyinfo->terminal->reference_count++;
7873 /* First delete frames whose mini-buffers are on frames
7874 that are on the dead display. */
7875 FOR_EACH_FRAME (tail, frame)
7877 Lisp_Object minibuf_frame;
7878 minibuf_frame
7879 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7880 if (FRAME_X_P (XFRAME (frame))
7881 && FRAME_X_P (XFRAME (minibuf_frame))
7882 && ! EQ (frame, minibuf_frame)
7883 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7884 Fdelete_frame (frame, Qnoelisp);
7887 /* Now delete all remaining frames on the dead display.
7888 We are now sure none of these is used as the mini-buffer
7889 for another frame that we need to delete. */
7890 FOR_EACH_FRAME (tail, frame)
7891 if (FRAME_X_P (XFRAME (frame))
7892 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7894 /* Set this to t so that Fdelete_frame won't get confused
7895 trying to find a replacement. */
7896 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7897 Fdelete_frame (frame, Qnoelisp);
7900 /* We have to close the display to inform Xt that it doesn't
7901 exist anymore. If we don't, Xt will continue to wait for
7902 events from the display. As a consequence, a sequence of
7904 M-x make-frame-on-display RET :1 RET
7905 ...kill the new frame, so that we get an IO error...
7906 M-x make-frame-on-display RET :1 RET
7908 will indefinitely wait in Xt for events for display `:1', opened
7909 in the first call to make-frame-on-display.
7911 Closing the display is reported to lead to a bus error on
7912 OpenWindows in certain situations. I suspect that is a bug
7913 in OpenWindows. I don't know how to circumvent it here. */
7915 if (dpyinfo)
7917 #ifdef USE_X_TOOLKIT
7918 /* If DPYINFO is null, this means we didn't open the display
7919 in the first place, so don't try to close it. */
7921 extern void (*fatal_error_signal_hook) P_ ((void));
7922 fatal_error_signal_hook = x_fatal_error_signal;
7923 XtCloseDisplay (dpy);
7924 fatal_error_signal_hook = NULL;
7926 #endif
7928 #ifdef USE_GTK
7929 /* Due to bugs in some Gtk+ versions, just exit here if this
7930 is the last display/terminal. */
7931 if (terminal_list->next_terminal == NULL)
7933 fprintf (stderr, "%s\n", error_msg);
7934 shut_down_emacs (0, 0, Qnil);
7935 exit (70);
7937 xg_display_close (dpyinfo->display);
7938 #endif
7940 /* Indicate that this display is dead. */
7941 dpyinfo->display = 0;
7943 dpyinfo->reference_count--;
7944 dpyinfo->terminal->reference_count--;
7945 if (dpyinfo->reference_count != 0)
7946 /* We have just closed all frames on this display. */
7947 abort ();
7950 Lisp_Object tmp;
7951 XSETTERMINAL (tmp, dpyinfo->terminal);
7952 Fdelete_terminal (tmp, Qnoelisp);
7956 x_uncatch_errors ();
7958 if (terminal_list == 0)
7960 fprintf (stderr, "%s\n", error_msg);
7961 shut_down_emacs (0, 0, Qnil);
7962 exit (70);
7965 /* Ordinary stack unwind doesn't deal with these. */
7966 #ifdef SIGIO
7967 sigunblock (sigmask (SIGIO));
7968 #endif
7969 sigunblock (sigmask (SIGALRM));
7970 TOTALLY_UNBLOCK_INPUT;
7972 unbind_to (index, Qnil);
7973 clear_waiting_for_input ();
7974 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7975 longjmp), because returning from this function would get us back into
7976 Xlib's code which will directly call `exit'. */
7977 error ("%s", error_msg);
7980 /* We specifically use it before defining it, so that gcc doesn't inline it,
7981 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7982 static void x_error_quitter P_ ((Display *, XErrorEvent *));
7984 /* This is the first-level handler for X protocol errors.
7985 It calls x_error_quitter or x_error_catcher. */
7987 static int
7988 x_error_handler (display, error)
7989 Display *display;
7990 XErrorEvent *error;
7992 if (x_error_message)
7993 x_error_catcher (display, error);
7994 else
7995 x_error_quitter (display, error);
7996 return 0;
7999 /* This is the usual handler for X protocol errors.
8000 It kills all frames on the display that we got the error for.
8001 If that was the only one, it prints an error message and kills Emacs. */
8003 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
8005 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
8006 #define NO_INLINE __attribute__((noinline))
8007 #else
8008 #define NO_INLINE
8009 #endif
8011 /* Some versions of GNU/Linux define noinline in their headers. */
8013 #ifdef noinline
8014 #undef noinline
8015 #endif
8017 /* On older GCC versions, just putting x_error_quitter
8018 after x_error_handler prevents inlining into the former. */
8020 static void NO_INLINE
8021 x_error_quitter (display, error)
8022 Display *display;
8023 XErrorEvent *error;
8025 char buf[256], buf1[356];
8027 /* Ignore BadName errors. They can happen because of fonts
8028 or colors that are not defined. */
8030 if (error->error_code == BadName)
8031 return;
8033 /* Note that there is no real way portable across R3/R4 to get the
8034 original error handler. */
8036 XGetErrorText (display, error->error_code, buf, sizeof (buf));
8037 sprintf (buf1, "X protocol error: %s on protocol request %d",
8038 buf, error->request_code);
8039 x_connection_closed (display, buf1);
8043 /* This is the handler for X IO errors, always.
8044 It kills all frames on the display that we lost touch with.
8045 If that was the only one, it prints an error message and kills Emacs. */
8047 static int
8048 x_io_error_quitter (display)
8049 Display *display;
8051 char buf[256];
8053 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
8054 x_connection_closed (display, buf);
8055 return 0;
8058 /* Changing the font of the frame. */
8060 /* Give frame F the font FONT-OBJECT as its default font. The return
8061 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
8062 frame. If it is negative, generate a new fontset from
8063 FONT-OBJECT. */
8065 Lisp_Object
8066 x_new_font (f, font_object, fontset)
8067 struct frame *f;
8068 Lisp_Object font_object;
8069 int fontset;
8071 struct font *font = XFONT_OBJECT (font_object);
8073 if (fontset < 0)
8074 fontset = fontset_from_font (font_object);
8075 FRAME_FONTSET (f) = fontset;
8076 if (FRAME_FONT (f) == font)
8077 /* This font is already set in frame F. There's nothing more to
8078 do. */
8079 return font_object;
8081 FRAME_FONT (f) = font;
8082 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
8083 FRAME_COLUMN_WIDTH (f) = font->average_width;
8084 FRAME_SPACE_WIDTH (f) = font->space_width;
8085 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
8087 compute_fringe_widths (f, 1);
8089 /* Compute the scroll bar width in character columns. */
8090 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
8092 int wid = FRAME_COLUMN_WIDTH (f);
8093 FRAME_CONFIG_SCROLL_BAR_COLS (f)
8094 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
8096 else
8098 int wid = FRAME_COLUMN_WIDTH (f);
8099 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
8102 if (FRAME_X_WINDOW (f) != 0)
8104 /* Don't change the size of a tip frame; there's no point in
8105 doing it because it's done in Fx_show_tip, and it leads to
8106 problems because the tip frame has no widget. */
8107 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8108 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
8111 #ifdef HAVE_X_I18N
8112 if (FRAME_XIC (f)
8113 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
8115 BLOCK_INPUT;
8116 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
8117 UNBLOCK_INPUT;
8119 #endif
8121 return font_object;
8125 /***********************************************************************
8126 X Input Methods
8127 ***********************************************************************/
8129 #ifdef HAVE_X_I18N
8131 #ifdef HAVE_X11R6
8133 /* XIM destroy callback function, which is called whenever the
8134 connection to input method XIM dies. CLIENT_DATA contains a
8135 pointer to the x_display_info structure corresponding to XIM. */
8137 static void
8138 xim_destroy_callback (xim, client_data, call_data)
8139 XIM xim;
8140 XPointer client_data;
8141 XPointer call_data;
8143 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8144 Lisp_Object frame, tail;
8146 BLOCK_INPUT;
8148 /* No need to call XDestroyIC.. */
8149 FOR_EACH_FRAME (tail, frame)
8151 struct frame *f = XFRAME (frame);
8152 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8154 FRAME_XIC (f) = NULL;
8155 xic_free_xfontset (f);
8159 /* No need to call XCloseIM. */
8160 dpyinfo->xim = NULL;
8161 XFree (dpyinfo->xim_styles);
8162 UNBLOCK_INPUT;
8165 #endif /* HAVE_X11R6 */
8167 #ifdef HAVE_X11R6
8168 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8169 extern char *XSetIMValues P_ ((XIM, ...));
8170 #endif
8172 /* Open the connection to the XIM server on display DPYINFO.
8173 RESOURCE_NAME is the resource name Emacs uses. */
8175 static void
8176 xim_open_dpy (dpyinfo, resource_name)
8177 struct x_display_info *dpyinfo;
8178 char *resource_name;
8180 XIM xim;
8182 #ifdef HAVE_XIM
8183 if (use_xim)
8185 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8186 EMACS_CLASS);
8187 dpyinfo->xim = xim;
8189 if (xim)
8191 #ifdef HAVE_X11R6
8192 XIMCallback destroy;
8193 #endif
8195 /* Get supported styles and XIM values. */
8196 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8198 #ifdef HAVE_X11R6
8199 destroy.callback = xim_destroy_callback;
8200 destroy.client_data = (XPointer)dpyinfo;
8201 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8202 #endif
8206 else
8207 #endif /* HAVE_XIM */
8208 dpyinfo->xim = NULL;
8212 #ifdef HAVE_X11R6_XIM
8214 struct xim_inst_t
8216 struct x_display_info *dpyinfo;
8217 char *resource_name;
8220 /* XIM instantiate callback function, which is called whenever an XIM
8221 server is available. DISPLAY is the display of the XIM.
8222 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8223 when the callback was registered. */
8225 static void
8226 xim_instantiate_callback (display, client_data, call_data)
8227 Display *display;
8228 XPointer client_data;
8229 XPointer call_data;
8231 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8232 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8234 /* We don't support multiple XIM connections. */
8235 if (dpyinfo->xim)
8236 return;
8238 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8240 /* Create XIC for the existing frames on the same display, as long
8241 as they have no XIC. */
8242 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8244 Lisp_Object tail, frame;
8246 BLOCK_INPUT;
8247 FOR_EACH_FRAME (tail, frame)
8249 struct frame *f = XFRAME (frame);
8251 if (FRAME_X_P (f)
8252 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8253 if (FRAME_XIC (f) == NULL)
8255 create_frame_xic (f);
8256 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8257 xic_set_statusarea (f);
8258 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8260 struct window *w = XWINDOW (f->selected_window);
8261 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8266 UNBLOCK_INPUT;
8270 #endif /* HAVE_X11R6_XIM */
8273 /* Open a connection to the XIM server on display DPYINFO.
8274 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8275 connection only at the first time. On X11R6, open the connection
8276 in the XIM instantiate callback function. */
8278 static void
8279 xim_initialize (dpyinfo, resource_name)
8280 struct x_display_info *dpyinfo;
8281 char *resource_name;
8283 #ifdef HAVE_XIM
8284 if (use_xim)
8286 #ifdef HAVE_X11R6_XIM
8287 struct xim_inst_t *xim_inst;
8288 int len;
8290 dpyinfo->xim = NULL;
8291 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8292 xim_inst->dpyinfo = dpyinfo;
8293 len = strlen (resource_name);
8294 xim_inst->resource_name = (char *) xmalloc (len + 1);
8295 bcopy (resource_name, xim_inst->resource_name, len + 1);
8296 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8297 resource_name, EMACS_CLASS,
8298 xim_instantiate_callback,
8299 /* This is XPointer in XFree86
8300 but (XPointer *) on Tru64, at
8301 least, hence the configure test. */
8302 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8303 #else /* not HAVE_X11R6_XIM */
8304 dpyinfo->xim = NULL;
8305 xim_open_dpy (dpyinfo, resource_name);
8306 #endif /* not HAVE_X11R6_XIM */
8309 else
8310 #endif /* HAVE_XIM */
8311 dpyinfo->xim = NULL;
8315 /* Close the connection to the XIM server on display DPYINFO. */
8317 static void
8318 xim_close_dpy (dpyinfo)
8319 struct x_display_info *dpyinfo;
8321 #ifdef HAVE_XIM
8322 if (use_xim)
8324 #ifdef HAVE_X11R6_XIM
8325 if (dpyinfo->display)
8326 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8327 NULL, EMACS_CLASS,
8328 xim_instantiate_callback, NULL);
8329 #else /* not HAVE_X11R6_XIM */
8330 /* If we have X11R6 xim, this causes a double-free. */
8331 if (dpyinfo->display)
8332 XCloseIM (dpyinfo->xim);
8333 #endif /* HAVE_X11R6_XIM */
8334 dpyinfo->xim = NULL;
8335 XFree (dpyinfo->xim_styles);
8337 #endif /* HAVE_XIM */
8340 #endif /* not HAVE_X11R6_XIM */
8344 /* Calculate the absolute position in frame F
8345 from its current recorded position values and gravity. */
8347 void
8348 x_calc_absolute_position (f)
8349 struct frame *f;
8351 int flags = f->size_hint_flags;
8353 /* We have nothing to do if the current position
8354 is already for the top-left corner. */
8355 if (! ((flags & XNegative) || (flags & YNegative)))
8356 return;
8358 /* Treat negative positions as relative to the leftmost bottommost
8359 position that fits on the screen. */
8360 if (flags & XNegative)
8361 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8362 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8365 int height = FRAME_PIXEL_HEIGHT (f);
8367 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8368 /* Something is fishy here. When using Motif, starting Emacs with
8369 `-g -0-0', the frame appears too low by a few pixels.
8371 This seems to be so because initially, while Emacs is starting,
8372 the column widget's height and the frame's pixel height are
8373 different. The column widget's height is the right one. In
8374 later invocations, when Emacs is up, the frame's pixel height
8375 is right, though.
8377 It's not obvious where the initial small difference comes from.
8378 2000-12-01, gerd. */
8380 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8381 #endif
8383 if (flags & YNegative)
8384 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8385 - height + f->top_pos;
8388 /* The left_pos and top_pos
8389 are now relative to the top and left screen edges,
8390 so the flags should correspond. */
8391 f->size_hint_flags &= ~ (XNegative | YNegative);
8394 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8395 to really change the position, and 0 when calling from
8396 x_make_frame_visible (in that case, XOFF and YOFF are the current
8397 position values). It is -1 when calling from x_set_frame_parameters,
8398 which means, do adjust for borders but don't change the gravity. */
8400 void
8401 x_set_offset (f, xoff, yoff, change_gravity)
8402 struct frame *f;
8403 register int xoff, yoff;
8404 int change_gravity;
8406 int modified_top, modified_left;
8408 if (change_gravity > 0)
8410 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8411 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8413 f->top_pos = yoff;
8414 f->left_pos = xoff;
8415 f->size_hint_flags &= ~ (XNegative | YNegative);
8416 if (xoff < 0)
8417 f->size_hint_flags |= XNegative;
8418 if (yoff < 0)
8419 f->size_hint_flags |= YNegative;
8420 f->win_gravity = NorthWestGravity;
8422 x_calc_absolute_position (f);
8424 BLOCK_INPUT;
8425 x_wm_set_size_hint (f, (long) 0, 0);
8427 modified_left = f->left_pos;
8428 modified_top = f->top_pos;
8430 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8432 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8433 than the WM decorations. So we use the calculated offset instead
8434 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8435 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8436 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8439 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8440 modified_left, modified_top);
8442 x_sync_with_move (f, f->left_pos, f->top_pos,
8443 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8444 ? 1 : 0);
8446 /* change_gravity is non-zero when this function is called from Lisp to
8447 programmatically move a frame. In that case, we call
8448 x_check_expected_move to discover if we have a "Type A" or "Type B"
8449 window manager, and, for a "Type A" window manager, adjust the position
8450 of the frame.
8452 We call x_check_expected_move if a programmatic move occurred, and
8453 either the window manager type (A/B) is unknown or it is Type A but we
8454 need to compute the top/left offset adjustment for this frame. */
8456 if (change_gravity != 0 &&
8457 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8458 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8459 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8460 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8461 x_check_expected_move (f, modified_left, modified_top);
8463 UNBLOCK_INPUT;
8466 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8467 on the root window for frame F contains ATOMNAME.
8468 This is how a WM check shall be done according to the Window Manager
8469 Specification/Extended Window Manager Hints at
8470 http://freedesktop.org/wiki/Specifications/wm-spec. */
8472 static int
8473 wm_supports (f, atomname)
8474 struct frame *f;
8475 const char *atomname;
8477 Atom actual_type;
8478 unsigned long actual_size, bytes_remaining;
8479 int i, rc, actual_format;
8480 Atom prop_atom;
8481 Window wmcheck_window;
8482 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8483 Window target_window = dpyinfo->root_window;
8484 long max_len = 65536;
8485 Display *dpy = FRAME_X_DISPLAY (f);
8486 unsigned char *tmp_data = NULL;
8487 Atom target_type = XA_WINDOW;
8488 Atom want_atom;
8490 BLOCK_INPUT;
8492 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8494 x_catch_errors (dpy);
8495 rc = XGetWindowProperty (dpy, target_window,
8496 prop_atom, 0, max_len, False, target_type,
8497 &actual_type, &actual_format, &actual_size,
8498 &bytes_remaining, &tmp_data);
8500 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8502 if (tmp_data) XFree (tmp_data);
8503 x_uncatch_errors ();
8504 UNBLOCK_INPUT;
8505 return 0;
8508 wmcheck_window = *(Window *) tmp_data;
8509 XFree (tmp_data);
8511 /* Check if window exists. */
8512 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8513 x_sync (f);
8514 if (x_had_errors_p (dpy))
8516 x_uncatch_errors ();
8517 UNBLOCK_INPUT;
8518 return 0;
8521 if (dpyinfo->net_supported_window != wmcheck_window)
8523 /* Window changed, reload atoms */
8524 if (dpyinfo->net_supported_atoms != NULL)
8525 XFree (dpyinfo->net_supported_atoms);
8526 dpyinfo->net_supported_atoms = NULL;
8527 dpyinfo->nr_net_supported_atoms = 0;
8528 dpyinfo->net_supported_window = 0;
8530 target_type = XA_ATOM;
8531 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8532 tmp_data = NULL;
8533 rc = XGetWindowProperty (dpy, target_window,
8534 prop_atom, 0, max_len, False, target_type,
8535 &actual_type, &actual_format, &actual_size,
8536 &bytes_remaining, &tmp_data);
8538 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8540 if (tmp_data) XFree (tmp_data);
8541 x_uncatch_errors ();
8542 UNBLOCK_INPUT;
8543 return 0;
8546 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8547 dpyinfo->nr_net_supported_atoms = actual_size;
8548 dpyinfo->net_supported_window = wmcheck_window;
8551 rc = 0;
8552 want_atom = XInternAtom (dpy, atomname, False);
8554 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8555 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8557 x_uncatch_errors ();
8558 UNBLOCK_INPUT;
8560 return rc;
8563 /* Do fullscreen as specified in extended window manager hints */
8565 static int
8566 do_ewmh_fullscreen (f)
8567 struct frame *f;
8569 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8571 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8572 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8573 if (!have_net_atom)
8574 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8576 if (have_net_atom)
8578 Lisp_Object frame;
8579 const char *atom = "_NET_WM_STATE";
8580 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8581 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8582 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8583 const char *what = NULL;
8585 XSETFRAME (frame, f);
8587 /* If there are _NET_ atoms we assume we have extended window manager
8588 hints. */
8589 switch (f->want_fullscreen)
8591 case FULLSCREEN_BOTH:
8592 what = fs;
8593 break;
8594 case FULLSCREEN_WIDTH:
8595 what = fw;
8596 break;
8597 case FULLSCREEN_HEIGHT:
8598 what = fh;
8599 break;
8602 if (what != NULL && !wm_supports (f, what)) return 0;
8605 Fx_send_client_event (frame, make_number (0), frame,
8606 make_unibyte_string (atom, strlen (atom)),
8607 make_number (32),
8608 Fcons (make_number (0), /* Remove */
8609 Fcons
8610 (make_unibyte_string (fs,
8611 strlen (fs)),
8612 Qnil)));
8613 Fx_send_client_event (frame, make_number (0), frame,
8614 make_unibyte_string (atom, strlen (atom)),
8615 make_number (32),
8616 Fcons (make_number (0), /* Remove */
8617 Fcons
8618 (make_unibyte_string (fh,
8619 strlen (fh)),
8620 Qnil)));
8621 Fx_send_client_event (frame, make_number (0), frame,
8622 make_unibyte_string (atom, strlen (atom)),
8623 make_number (32),
8624 Fcons (make_number (0), /* Remove */
8625 Fcons
8626 (make_unibyte_string (fw,
8627 strlen (fw)),
8628 Qnil)));
8629 f->want_fullscreen = FULLSCREEN_NONE;
8630 if (what != NULL)
8631 Fx_send_client_event (frame, make_number (0), frame,
8632 make_unibyte_string (atom, strlen (atom)),
8633 make_number (32),
8634 Fcons (make_number (1), /* Add */
8635 Fcons
8636 (make_unibyte_string (what,
8637 strlen (what)),
8638 Qnil)));
8641 return have_net_atom;
8644 static void
8645 XTfullscreen_hook (f)
8646 FRAME_PTR f;
8648 if (f->async_visible)
8650 BLOCK_INPUT;
8651 do_ewmh_fullscreen (f);
8652 x_sync (f);
8653 UNBLOCK_INPUT;
8658 /* Check if we need to resize the frame due to a fullscreen request.
8659 If so needed, resize the frame. */
8660 static void
8661 x_check_fullscreen (f)
8662 struct frame *f;
8664 if (f->want_fullscreen & FULLSCREEN_BOTH)
8666 int width, height, ign;
8668 if (do_ewmh_fullscreen (f))
8669 return;
8671 x_real_positions (f, &f->left_pos, &f->top_pos);
8673 x_fullscreen_adjust (f, &width, &height, &ign, &ign);
8675 /* We do not need to move the window, it shall be taken care of
8676 when setting WM manager hints.
8677 If the frame is visible already, the position is checked by
8678 x_check_expected_move. */
8679 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8681 change_frame_size (f, height, width, 0, 1, 0);
8682 SET_FRAME_GARBAGED (f);
8683 cancel_mouse_face (f);
8685 /* Wait for the change of frame size to occur */
8686 f->want_fullscreen |= FULLSCREEN_WAIT;
8691 /* This function is called by x_set_offset to determine whether the window
8692 manager interfered with the positioning of the frame. Type A window
8693 managers position the surrounding window manager decorations a small
8694 amount above and left of the user-supplied position. Type B window
8695 managers position the surrounding window manager decorations at the
8696 user-specified position. If we detect a Type A window manager, we
8697 compensate by moving the window right and down by the proper amount. */
8699 static void
8700 x_check_expected_move (f, expected_left, expected_top)
8701 struct frame *f;
8702 int expected_left;
8703 int expected_top;
8705 int current_left = 0, current_top = 0;
8707 /* x_real_positions returns the left and top offsets of the outermost
8708 window manager window around the frame. */
8710 x_real_positions (f, &current_left, &current_top);
8712 if (current_left != expected_left || current_top != expected_top)
8714 /* It's a "Type A" window manager. */
8716 int adjusted_left;
8717 int adjusted_top;
8719 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8720 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8721 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8723 /* Now fix the mispositioned frame's location. */
8725 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8726 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8728 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8729 adjusted_left, adjusted_top);
8731 x_sync_with_move (f, expected_left, expected_top, 0);
8733 else
8734 /* It's a "Type B" window manager. We don't have to adjust the
8735 frame's position. */
8737 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8741 /* Wait for XGetGeometry to return up-to-date position information for a
8742 recently-moved frame. Call this immediately after calling XMoveWindow.
8743 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8744 frame has been moved to, so we use a fuzzy position comparison instead
8745 of an exact comparison. */
8747 static void
8748 x_sync_with_move (f, left, top, fuzzy)
8749 struct frame *f;
8750 int left, top, fuzzy;
8752 int count = 0;
8754 while (count++ < 50)
8756 int current_left = 0, current_top = 0;
8758 /* In theory, this call to XSync only needs to happen once, but in
8759 practice, it doesn't seem to work, hence the need for the surrounding
8760 loop. */
8762 XSync (FRAME_X_DISPLAY (f), False);
8763 x_real_positions (f, &current_left, &current_top);
8765 if (fuzzy)
8767 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8768 pixels. */
8770 if (eabs (current_left - left) <= 10
8771 && eabs (current_top - top) <= 40)
8772 return;
8774 else if (current_left == left && current_top == top)
8775 return;
8778 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8779 will then return up-to-date position info. */
8781 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8785 /* Change the size of frame F's X window to COLS/ROWS in the case F
8786 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8787 top-left-corner window gravity for this size change and subsequent
8788 size changes. Otherwise we leave the window gravity unchanged. */
8790 static void
8791 x_set_window_size_1 (f, change_gravity, cols, rows)
8792 struct frame *f;
8793 int change_gravity;
8794 int cols, rows;
8796 int pixelwidth, pixelheight;
8798 check_frame_size (f, &rows, &cols);
8799 f->scroll_bar_actual_width
8800 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8802 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8803 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8804 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8806 compute_fringe_widths (f, 0);
8808 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8809 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
8811 f->win_gravity = NorthWestGravity;
8812 x_wm_set_size_hint (f, (long) 0, 0);
8814 XSync (FRAME_X_DISPLAY (f), False);
8815 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8816 pixelwidth, pixelheight);
8818 /* Now, strictly speaking, we can't be sure that this is accurate,
8819 but the window manager will get around to dealing with the size
8820 change request eventually, and we'll hear how it went when the
8821 ConfigureNotify event gets here.
8823 We could just not bother storing any of this information here,
8824 and let the ConfigureNotify event set everything up, but that
8825 might be kind of confusing to the Lisp code, since size changes
8826 wouldn't be reported in the frame parameters until some random
8827 point in the future when the ConfigureNotify event arrives.
8829 We pass 1 for DELAY since we can't run Lisp code inside of
8830 a BLOCK_INPUT. */
8831 change_frame_size (f, rows, cols, 0, 1, 0);
8832 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8833 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8835 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8836 receive in the ConfigureNotify event; if we get what we asked
8837 for, then the event won't cause the screen to become garbaged, so
8838 we have to make sure to do it here. */
8839 SET_FRAME_GARBAGED (f);
8841 XFlush (FRAME_X_DISPLAY (f));
8845 /* Call this to change the size of frame F's x-window.
8846 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8847 for this size change and subsequent size changes.
8848 Otherwise we leave the window gravity unchanged. */
8850 void
8851 x_set_window_size (f, change_gravity, cols, rows)
8852 struct frame *f;
8853 int change_gravity;
8854 int cols, rows;
8856 BLOCK_INPUT;
8858 #ifdef USE_GTK
8859 if (FRAME_GTK_WIDGET (f))
8860 xg_frame_set_char_size (f, cols, rows);
8861 else
8862 x_set_window_size_1 (f, change_gravity, cols, rows);
8863 #elif USE_X_TOOLKIT
8865 if (f->output_data.x->widget != NULL)
8867 /* The x and y position of the widget is clobbered by the
8868 call to XtSetValues within EmacsFrameSetCharSize.
8869 This is a real kludge, but I don't understand Xt so I can't
8870 figure out a correct fix. Can anyone else tell me? -- rms. */
8871 int xpos = f->output_data.x->widget->core.x;
8872 int ypos = f->output_data.x->widget->core.y;
8873 EmacsFrameSetCharSize (f->output_data.x->edit_widget, cols, rows);
8874 f->output_data.x->widget->core.x = xpos;
8875 f->output_data.x->widget->core.y = ypos;
8877 else
8878 x_set_window_size_1 (f, change_gravity, cols, rows);
8880 #else /* not USE_X_TOOLKIT */
8882 x_set_window_size_1 (f, change_gravity, cols, rows);
8884 #endif /* not USE_X_TOOLKIT */
8886 /* If cursor was outside the new size, mark it as off. */
8887 mark_window_cursors_off (XWINDOW (f->root_window));
8889 /* Clear out any recollection of where the mouse highlighting was,
8890 since it might be in a place that's outside the new frame size.
8891 Actually checking whether it is outside is a pain in the neck,
8892 so don't try--just let the highlighting be done afresh with new size. */
8893 cancel_mouse_face (f);
8895 UNBLOCK_INPUT;
8898 /* Mouse warping. */
8900 void
8901 x_set_mouse_position (f, x, y)
8902 struct frame *f;
8903 int x, y;
8905 int pix_x, pix_y;
8907 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8908 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8910 if (pix_x < 0) pix_x = 0;
8911 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8913 if (pix_y < 0) pix_y = 0;
8914 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8916 BLOCK_INPUT;
8918 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8919 0, 0, 0, 0, pix_x, pix_y);
8920 UNBLOCK_INPUT;
8923 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8925 void
8926 x_set_mouse_pixel_position (f, pix_x, pix_y)
8927 struct frame *f;
8928 int pix_x, pix_y;
8930 BLOCK_INPUT;
8932 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8933 0, 0, 0, 0, pix_x, pix_y);
8934 UNBLOCK_INPUT;
8937 /* focus shifting, raising and lowering. */
8939 void
8940 x_focus_on_frame (f)
8941 struct frame *f;
8943 #if 0 /* This proves to be unpleasant. */
8944 x_raise_frame (f);
8945 #endif
8946 #if 0
8947 /* I don't think that the ICCCM allows programs to do things like this
8948 without the interaction of the window manager. Whatever you end up
8949 doing with this code, do it to x_unfocus_frame too. */
8950 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8951 RevertToPointerRoot, CurrentTime);
8952 #endif /* ! 0 */
8955 void
8956 x_unfocus_frame (f)
8957 struct frame *f;
8959 #if 0
8960 /* Look at the remarks in x_focus_on_frame. */
8961 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8962 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8963 RevertToPointerRoot, CurrentTime);
8964 #endif /* ! 0 */
8967 /* Raise frame F. */
8969 void
8970 x_raise_frame (f)
8971 struct frame *f;
8973 BLOCK_INPUT;
8974 if (f->async_visible)
8975 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8977 XFlush (FRAME_X_DISPLAY (f));
8978 UNBLOCK_INPUT;
8981 /* Lower frame F. */
8983 void
8984 x_lower_frame (f)
8985 struct frame *f;
8987 if (f->async_visible)
8989 BLOCK_INPUT;
8990 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8991 XFlush (FRAME_X_DISPLAY (f));
8992 UNBLOCK_INPUT;
8996 /* Activate frame with Extended Window Manager Hints */
8998 void
8999 x_ewmh_activate_frame (f)
9000 FRAME_PTR f;
9002 /* See Window Manager Specification/Extended Window Manager Hints at
9003 http://freedesktop.org/wiki/Specifications/wm-spec */
9005 const char *atom = "_NET_ACTIVE_WINDOW";
9006 if (f->async_visible && wm_supports (f, atom))
9008 Lisp_Object frame;
9009 XSETFRAME (frame, f);
9010 Fx_send_client_event (frame, make_number (0), frame,
9011 make_unibyte_string (atom, strlen (atom)),
9012 make_number (32),
9013 Fcons (make_number (1),
9014 Fcons (make_number (last_user_time),
9015 Qnil)));
9019 static void
9020 XTframe_raise_lower (f, raise_flag)
9021 FRAME_PTR f;
9022 int raise_flag;
9024 if (raise_flag)
9025 x_raise_frame (f);
9026 else
9027 x_lower_frame (f);
9030 /* XEmbed implementation. */
9032 void
9033 xembed_set_info (f, flags)
9034 struct frame *f;
9035 enum xembed_info flags;
9037 Atom atom;
9038 unsigned long data[2];
9040 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
9042 data[0] = XEMBED_VERSION;
9043 data[1] = flags;
9045 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
9046 32, PropModeReplace, (unsigned char *) data, 2);
9049 void
9050 xembed_send_message (f, time, message, detail, data1, data2)
9051 struct frame *f;
9052 Time time;
9053 enum xembed_message message;
9054 long detail;
9055 long data1;
9056 long data2;
9058 XEvent event;
9060 event.xclient.type = ClientMessage;
9061 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9062 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9063 event.xclient.format = 32;
9064 event.xclient.data.l[0] = time;
9065 event.xclient.data.l[1] = message;
9066 event.xclient.data.l[2] = detail;
9067 event.xclient.data.l[3] = data1;
9068 event.xclient.data.l[4] = data2;
9070 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9071 False, NoEventMask, &event);
9072 XSync (FRAME_X_DISPLAY (f), False);
9075 /* Change of visibility. */
9077 /* This tries to wait until the frame is really visible.
9078 However, if the window manager asks the user where to position
9079 the frame, this will return before the user finishes doing that.
9080 The frame will not actually be visible at that time,
9081 but it will become visible later when the window manager
9082 finishes with it. */
9084 void
9085 x_make_frame_visible (f)
9086 struct frame *f;
9088 Lisp_Object type;
9089 int original_top, original_left;
9090 int retry_count = 2;
9092 retry:
9094 BLOCK_INPUT;
9096 type = x_icon_type (f);
9097 if (!NILP (type))
9098 x_bitmap_icon (f, type);
9100 if (! FRAME_VISIBLE_P (f))
9102 /* We test FRAME_GARBAGED_P here to make sure we don't
9103 call x_set_offset a second time
9104 if we get to x_make_frame_visible a second time
9105 before the window gets really visible. */
9106 if (! FRAME_ICONIFIED_P (f)
9107 && ! FRAME_X_EMBEDDED_P (f)
9108 && ! f->output_data.x->asked_for_visible)
9109 x_set_offset (f, f->left_pos, f->top_pos, 0);
9111 f->output_data.x->asked_for_visible = 1;
9113 if (! EQ (Vx_no_window_manager, Qt))
9114 x_wm_set_window_state (f, NormalState);
9115 #ifdef USE_X_TOOLKIT
9116 if (FRAME_X_EMBEDDED_P (f))
9117 xembed_set_info (f, XEMBED_MAPPED);
9118 else
9120 /* This was XtPopup, but that did nothing for an iconified frame. */
9121 XtMapWidget (f->output_data.x->widget);
9123 #else /* not USE_X_TOOLKIT */
9124 #ifdef USE_GTK
9125 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9126 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9127 #else
9128 if (FRAME_X_EMBEDDED_P (f))
9129 xembed_set_info (f, XEMBED_MAPPED);
9130 else
9131 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9132 #endif /* not USE_GTK */
9133 #endif /* not USE_X_TOOLKIT */
9134 #if 0 /* This seems to bring back scroll bars in the wrong places
9135 if the window configuration has changed. They seem
9136 to come back ok without this. */
9137 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
9138 XMapSubwindows (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9139 #endif
9142 XFlush (FRAME_X_DISPLAY (f));
9144 /* Synchronize to ensure Emacs knows the frame is visible
9145 before we do anything else. We do this loop with input not blocked
9146 so that incoming events are handled. */
9148 Lisp_Object frame;
9149 int count;
9150 /* This must be before UNBLOCK_INPUT
9151 since events that arrive in response to the actions above
9152 will set it when they are handled. */
9153 int previously_visible = f->output_data.x->has_been_visible;
9155 original_left = f->left_pos;
9156 original_top = f->top_pos;
9158 /* This must come after we set COUNT. */
9159 UNBLOCK_INPUT;
9161 /* We unblock here so that arriving X events are processed. */
9163 /* Now move the window back to where it was "supposed to be".
9164 But don't do it if the gravity is negative.
9165 When the gravity is negative, this uses a position
9166 that is 3 pixels too low. Perhaps that's really the border width.
9168 Don't do this if the window has never been visible before,
9169 because the window manager may choose the position
9170 and we don't want to override it. */
9172 if (! FRAME_VISIBLE_P (f)
9173 && ! FRAME_ICONIFIED_P (f)
9174 && ! FRAME_X_EMBEDDED_P (f)
9175 && f->win_gravity == NorthWestGravity
9176 && previously_visible)
9178 Drawable rootw;
9179 int x, y;
9180 unsigned int width, height, border, depth;
9182 BLOCK_INPUT;
9184 /* On some window managers (such as FVWM) moving an existing
9185 window, even to the same place, causes the window manager
9186 to introduce an offset. This can cause the window to move
9187 to an unexpected location. Check the geometry (a little
9188 slow here) and then verify that the window is in the right
9189 place. If the window is not in the right place, move it
9190 there, and take the potential window manager hit. */
9191 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9192 &rootw, &x, &y, &width, &height, &border, &depth);
9194 if (original_left != x || original_top != y)
9195 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9196 original_left, original_top);
9198 UNBLOCK_INPUT;
9201 XSETFRAME (frame, f);
9203 /* Wait until the frame is visible. Process X events until a
9204 MapNotify event has been seen, or until we think we won't get a
9205 MapNotify at all.. */
9206 for (count = input_signal_count + 10;
9207 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9209 /* Force processing of queued events. */
9210 x_sync (f);
9212 /* Machines that do polling rather than SIGIO have been
9213 observed to go into a busy-wait here. So we'll fake an
9214 alarm signal to let the handler know that there's something
9215 to be read. We used to raise a real alarm, but it seems
9216 that the handler isn't always enabled here. This is
9217 probably a bug. */
9218 if (input_polling_used ())
9220 /* It could be confusing if a real alarm arrives while
9221 processing the fake one. Turn it off and let the
9222 handler reset it. */
9223 extern void poll_for_input_1 P_ ((void));
9224 int old_poll_suppress_count = poll_suppress_count;
9225 poll_suppress_count = 1;
9226 poll_for_input_1 ();
9227 poll_suppress_count = old_poll_suppress_count;
9230 /* See if a MapNotify event has been processed. */
9231 FRAME_SAMPLE_VISIBILITY (f);
9234 /* 2000-09-28: In
9236 (let ((f (selected-frame)))
9237 (iconify-frame f)
9238 (raise-frame f))
9240 the frame is not raised with various window managers on
9241 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9242 unknown reason, the call to XtMapWidget is completely ignored.
9243 Mapping the widget a second time works. */
9245 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9246 goto retry;
9250 /* Change from mapped state to withdrawn state. */
9252 /* Make the frame visible (mapped and not iconified). */
9254 void
9255 x_make_frame_invisible (f)
9256 struct frame *f;
9258 Window window;
9260 /* Use the frame's outermost window, not the one we normally draw on. */
9261 window = FRAME_OUTER_WINDOW (f);
9263 /* Don't keep the highlight on an invisible frame. */
9264 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9265 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9267 #if 0/* This might add unreliability; I don't trust it -- rms. */
9268 if (! f->async_visible && ! f->async_iconified)
9269 return;
9270 #endif
9272 BLOCK_INPUT;
9274 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9275 that the current position of the window is user-specified, rather than
9276 program-specified, so that when the window is mapped again, it will be
9277 placed at the same location, without forcing the user to position it
9278 by hand again (they have already done that once for this window.) */
9279 x_wm_set_size_hint (f, (long) 0, 1);
9281 #ifdef USE_GTK
9282 if (FRAME_GTK_OUTER_WIDGET (f))
9283 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9284 else
9285 #else
9286 if (FRAME_X_EMBEDDED_P (f))
9287 xembed_set_info (f, 0);
9288 else
9289 #endif
9292 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9293 DefaultScreen (FRAME_X_DISPLAY (f))))
9295 UNBLOCK_INPUT_RESIGNAL;
9296 error ("Can't notify window manager of window withdrawal");
9300 /* We can't distinguish this from iconification
9301 just by the event that we get from the server.
9302 So we can't win using the usual strategy of letting
9303 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9304 and synchronize with the server to make sure we agree. */
9305 f->visible = 0;
9306 FRAME_ICONIFIED_P (f) = 0;
9307 f->async_visible = 0;
9308 f->async_iconified = 0;
9310 x_sync (f);
9312 UNBLOCK_INPUT;
9315 /* Change window state from mapped to iconified. */
9317 void
9318 x_iconify_frame (f)
9319 struct frame *f;
9321 int result;
9322 Lisp_Object type;
9324 /* Don't keep the highlight on an invisible frame. */
9325 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9326 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9328 if (f->async_iconified)
9329 return;
9331 BLOCK_INPUT;
9333 FRAME_SAMPLE_VISIBILITY (f);
9335 type = x_icon_type (f);
9336 if (!NILP (type))
9337 x_bitmap_icon (f, type);
9339 #ifdef USE_GTK
9340 if (FRAME_GTK_OUTER_WIDGET (f))
9342 if (! FRAME_VISIBLE_P (f))
9343 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9345 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9346 f->iconified = 1;
9347 f->visible = 1;
9348 f->async_iconified = 1;
9349 f->async_visible = 0;
9350 UNBLOCK_INPUT;
9351 return;
9353 #endif
9355 #ifdef USE_X_TOOLKIT
9357 if (! FRAME_VISIBLE_P (f))
9359 if (! EQ (Vx_no_window_manager, Qt))
9360 x_wm_set_window_state (f, IconicState);
9361 /* This was XtPopup, but that did nothing for an iconified frame. */
9362 XtMapWidget (f->output_data.x->widget);
9363 /* The server won't give us any event to indicate
9364 that an invisible frame was changed to an icon,
9365 so we have to record it here. */
9366 f->iconified = 1;
9367 f->visible = 1;
9368 f->async_iconified = 1;
9369 f->async_visible = 0;
9370 UNBLOCK_INPUT;
9371 return;
9374 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9375 XtWindow (f->output_data.x->widget),
9376 DefaultScreen (FRAME_X_DISPLAY (f)));
9377 UNBLOCK_INPUT;
9379 if (!result)
9380 error ("Can't notify window manager of iconification");
9382 f->async_iconified = 1;
9383 f->async_visible = 0;
9386 BLOCK_INPUT;
9387 XFlush (FRAME_X_DISPLAY (f));
9388 UNBLOCK_INPUT;
9389 #else /* not USE_X_TOOLKIT */
9391 /* Make sure the X server knows where the window should be positioned,
9392 in case the user deiconifies with the window manager. */
9393 if (! FRAME_VISIBLE_P (f)
9394 && ! FRAME_ICONIFIED_P (f)
9395 && ! FRAME_X_EMBEDDED_P (f))
9396 x_set_offset (f, f->left_pos, f->top_pos, 0);
9398 /* Since we don't know which revision of X we're running, we'll use both
9399 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9401 /* X11R4: send a ClientMessage to the window manager using the
9402 WM_CHANGE_STATE type. */
9404 XEvent message;
9406 message.xclient.window = FRAME_X_WINDOW (f);
9407 message.xclient.type = ClientMessage;
9408 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9409 message.xclient.format = 32;
9410 message.xclient.data.l[0] = IconicState;
9412 if (! XSendEvent (FRAME_X_DISPLAY (f),
9413 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9414 False,
9415 SubstructureRedirectMask | SubstructureNotifyMask,
9416 &message))
9418 UNBLOCK_INPUT_RESIGNAL;
9419 error ("Can't notify window manager of iconification");
9423 /* X11R3: set the initial_state field of the window manager hints to
9424 IconicState. */
9425 x_wm_set_window_state (f, IconicState);
9427 if (!FRAME_VISIBLE_P (f))
9429 /* If the frame was withdrawn, before, we must map it. */
9430 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9433 f->async_iconified = 1;
9434 f->async_visible = 0;
9436 XFlush (FRAME_X_DISPLAY (f));
9437 UNBLOCK_INPUT;
9438 #endif /* not USE_X_TOOLKIT */
9442 /* Free X resources of frame F. */
9444 void
9445 x_free_frame_resources (f)
9446 struct frame *f;
9448 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9449 Lisp_Object bar;
9450 struct scroll_bar *b;
9452 BLOCK_INPUT;
9454 /* If a display connection is dead, don't try sending more
9455 commands to the X server. */
9456 if (dpyinfo->display)
9458 /* We must free faces before destroying windows because some
9459 font-driver (e.g. xft) access a window while finishing a
9460 face. */
9461 if (FRAME_FACE_CACHE (f))
9462 free_frame_faces (f);
9464 if (f->output_data.x->icon_desc)
9465 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9467 #ifdef USE_X_TOOLKIT
9468 /* Explicitly destroy the scroll bars of the frame. Without
9469 this, we get "BadDrawable" errors from the toolkit later on,
9470 presumably from expose events generated for the disappearing
9471 toolkit scroll bars. */
9472 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9474 b = XSCROLL_BAR (bar);
9475 x_scroll_bar_remove (b);
9477 #endif
9479 #ifdef HAVE_X_I18N
9480 if (FRAME_XIC (f))
9481 free_frame_xic (f);
9482 #endif
9484 #ifdef USE_X_TOOLKIT
9485 if (f->output_data.x->widget)
9487 XtDestroyWidget (f->output_data.x->widget);
9488 f->output_data.x->widget = NULL;
9490 /* Tooltips don't have widgets, only a simple X window, even if
9491 we are using a toolkit. */
9492 else if (FRAME_X_WINDOW (f))
9493 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9495 free_frame_menubar (f);
9496 #else /* !USE_X_TOOLKIT */
9498 #ifdef USE_GTK
9499 /* In the GTK version, tooltips are normal X
9500 frames. We must check and free both types. */
9501 if (FRAME_GTK_OUTER_WIDGET (f))
9503 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
9504 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
9505 FRAME_GTK_OUTER_WIDGET (f) = 0;
9507 #endif /* USE_GTK */
9509 if (FRAME_X_WINDOW (f))
9510 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9511 #endif /* !USE_X_TOOLKIT */
9513 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9514 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9515 unload_color (f, f->output_data.x->cursor_pixel);
9516 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9517 unload_color (f, f->output_data.x->border_pixel);
9518 unload_color (f, f->output_data.x->mouse_pixel);
9520 if (f->output_data.x->scroll_bar_background_pixel != -1)
9521 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9522 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9523 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9524 #ifdef USE_TOOLKIT_SCROLL_BARS
9525 /* Scrollbar shadow colors. */
9526 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9527 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9528 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9529 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9530 #endif /* USE_TOOLKIT_SCROLL_BARS */
9531 if (f->output_data.x->white_relief.allocated_p)
9532 unload_color (f, f->output_data.x->white_relief.pixel);
9533 if (f->output_data.x->black_relief.allocated_p)
9534 unload_color (f, f->output_data.x->black_relief.pixel);
9536 if (FRAME_FACE_CACHE (f))
9537 free_frame_faces (f);
9539 x_free_gcs (f);
9540 XFlush (FRAME_X_DISPLAY (f));
9543 xfree (f->output_data.x->saved_menu_event);
9544 xfree (f->output_data.x);
9545 f->output_data.x = NULL;
9547 if (f == dpyinfo->x_focus_frame)
9548 dpyinfo->x_focus_frame = 0;
9549 if (f == dpyinfo->x_focus_event_frame)
9550 dpyinfo->x_focus_event_frame = 0;
9551 if (f == dpyinfo->x_highlight_frame)
9552 dpyinfo->x_highlight_frame = 0;
9554 if (f == dpyinfo->mouse_face_mouse_frame)
9556 dpyinfo->mouse_face_beg_row
9557 = dpyinfo->mouse_face_beg_col = -1;
9558 dpyinfo->mouse_face_end_row
9559 = dpyinfo->mouse_face_end_col = -1;
9560 dpyinfo->mouse_face_window = Qnil;
9561 dpyinfo->mouse_face_deferred_gc = 0;
9562 dpyinfo->mouse_face_mouse_frame = 0;
9565 UNBLOCK_INPUT;
9569 /* Destroy the X window of frame F. */
9571 void
9572 x_destroy_window (f)
9573 struct frame *f;
9575 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9577 /* If a display connection is dead, don't try sending more
9578 commands to the X server. */
9579 if (dpyinfo->display != 0)
9580 x_free_frame_resources (f);
9582 dpyinfo->reference_count--;
9586 /* Setting window manager hints. */
9588 /* Set the normal size hints for the window manager, for frame F.
9589 FLAGS is the flags word to use--or 0 meaning preserve the flags
9590 that the window now has.
9591 If USER_POSITION is nonzero, we set the USPosition
9592 flag (this is useful when FLAGS is 0).
9593 The GTK version is in gtkutils.c */
9595 #ifndef USE_GTK
9596 void
9597 x_wm_set_size_hint (f, flags, user_position)
9598 struct frame *f;
9599 long flags;
9600 int user_position;
9602 XSizeHints size_hints;
9604 #ifdef USE_X_TOOLKIT
9605 Arg al[2];
9606 int ac = 0;
9607 Dimension widget_width, widget_height;
9608 #endif
9610 Window window = FRAME_OUTER_WINDOW (f);
9612 /* Setting PMaxSize caused various problems. */
9613 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9615 size_hints.x = f->left_pos;
9616 size_hints.y = f->top_pos;
9618 #ifdef USE_X_TOOLKIT
9619 XtSetArg (al[ac], XtNwidth, &widget_width); ac++;
9620 XtSetArg (al[ac], XtNheight, &widget_height); ac++;
9621 XtGetValues (f->output_data.x->widget, al, ac);
9622 size_hints.height = widget_height;
9623 size_hints.width = widget_width;
9624 #else /* not USE_X_TOOLKIT */
9625 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9626 size_hints.width = FRAME_PIXEL_WIDTH (f);
9627 #endif /* not USE_X_TOOLKIT */
9629 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9630 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9631 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9632 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9633 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9634 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9636 /* Calculate the base and minimum sizes.
9638 (When we use the X toolkit, we don't do it here.
9639 Instead we copy the values that the widgets are using, below.) */
9640 #ifndef USE_X_TOOLKIT
9642 int base_width, base_height;
9643 int min_rows = 0, min_cols = 0;
9645 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9646 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9648 check_frame_size (f, &min_rows, &min_cols);
9650 /* The window manager uses the base width hints to calculate the
9651 current number of rows and columns in the frame while
9652 resizing; min_width and min_height aren't useful for this
9653 purpose, since they might not give the dimensions for a
9654 zero-row, zero-column frame.
9656 We use the base_width and base_height members if we have
9657 them; otherwise, we set the min_width and min_height members
9658 to the size for a zero x zero frame. */
9660 size_hints.flags |= PBaseSize;
9661 size_hints.base_width = base_width;
9662 size_hints.base_height = base_height;
9663 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9664 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9667 /* If we don't need the old flags, we don't need the old hint at all. */
9668 if (flags)
9670 size_hints.flags |= flags;
9671 goto no_read;
9673 #endif /* not USE_X_TOOLKIT */
9676 XSizeHints hints; /* Sometimes I hate X Windows... */
9677 long supplied_return;
9678 int value;
9680 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9681 &supplied_return);
9683 #ifdef USE_X_TOOLKIT
9684 size_hints.base_height = hints.base_height;
9685 size_hints.base_width = hints.base_width;
9686 size_hints.min_height = hints.min_height;
9687 size_hints.min_width = hints.min_width;
9688 #endif
9690 if (flags)
9691 size_hints.flags |= flags;
9692 else
9694 if (value == 0)
9695 hints.flags = 0;
9696 if (hints.flags & PSize)
9697 size_hints.flags |= PSize;
9698 if (hints.flags & PPosition)
9699 size_hints.flags |= PPosition;
9700 if (hints.flags & USPosition)
9701 size_hints.flags |= USPosition;
9702 if (hints.flags & USSize)
9703 size_hints.flags |= USSize;
9707 #ifndef USE_X_TOOLKIT
9708 no_read:
9709 #endif
9711 #ifdef PWinGravity
9712 size_hints.win_gravity = f->win_gravity;
9713 size_hints.flags |= PWinGravity;
9715 if (user_position)
9717 size_hints.flags &= ~ PPosition;
9718 size_hints.flags |= USPosition;
9720 #endif /* PWinGravity */
9722 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9724 #endif /* not USE_GTK */
9726 /* Used for IconicState or NormalState */
9728 void
9729 x_wm_set_window_state (f, state)
9730 struct frame *f;
9731 int state;
9733 #ifdef USE_X_TOOLKIT
9734 Arg al[1];
9736 XtSetArg (al[0], XtNinitialState, state);
9737 XtSetValues (f->output_data.x->widget, al, 1);
9738 #else /* not USE_X_TOOLKIT */
9739 Window window = FRAME_X_WINDOW (f);
9741 f->output_data.x->wm_hints.flags |= StateHint;
9742 f->output_data.x->wm_hints.initial_state = state;
9744 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9745 #endif /* not USE_X_TOOLKIT */
9748 void
9749 x_wm_set_icon_pixmap (f, pixmap_id)
9750 struct frame *f;
9751 int pixmap_id;
9753 Pixmap icon_pixmap, icon_mask;
9755 #ifndef USE_X_TOOLKIT
9756 Window window = FRAME_OUTER_WINDOW (f);
9757 #endif
9759 if (pixmap_id > 0)
9761 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9762 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9763 icon_mask = x_bitmap_mask (f, pixmap_id);
9764 f->output_data.x->wm_hints.icon_mask = icon_mask;
9766 else
9768 /* It seems there is no way to turn off use of an icon pixmap.
9769 The following line does it, only if no icon has yet been created,
9770 for some window managers. But with mwm it crashes.
9771 Some people say it should clear the IconPixmapHint bit in this case,
9772 but that doesn't work, and the X consortium said it isn't the
9773 right thing at all. Since there is no way to win,
9774 best to explicitly give up. */
9775 #if 0
9776 f->output_data.x->wm_hints.icon_pixmap = None;
9777 f->output_data.x->wm_hints.icon_mask = None;
9778 #else
9779 return;
9780 #endif
9784 #ifdef USE_GTK
9786 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9787 return;
9790 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9793 Arg al[1];
9794 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9795 XtSetValues (f->output_data.x->widget, al, 1);
9796 XtSetArg (al[0], XtNiconMask, icon_mask);
9797 XtSetValues (f->output_data.x->widget, al, 1);
9800 #else /* not USE_X_TOOLKIT && not USE_GTK */
9802 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9803 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9805 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9808 void
9809 x_wm_set_icon_position (f, icon_x, icon_y)
9810 struct frame *f;
9811 int icon_x, icon_y;
9813 Window window = FRAME_OUTER_WINDOW (f);
9815 f->output_data.x->wm_hints.flags |= IconPositionHint;
9816 f->output_data.x->wm_hints.icon_x = icon_x;
9817 f->output_data.x->wm_hints.icon_y = icon_y;
9819 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9823 /***********************************************************************
9824 Fonts
9825 ***********************************************************************/
9827 #if GLYPH_DEBUG
9829 /* Check that FONT is valid on frame F. It is if it can be found in F's
9830 font table. */
9832 static void
9833 x_check_font (f, font)
9834 struct frame *f;
9835 struct font *font;
9837 Lisp_Object frame;
9839 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9840 if (font->driver->check)
9841 xassert (font->driver->check (f, font) == 0);
9844 #endif /* GLYPH_DEBUG != 0 */
9847 /***********************************************************************
9848 Initialization
9849 ***********************************************************************/
9851 #ifdef USE_X_TOOLKIT
9852 static XrmOptionDescRec emacs_options[] = {
9853 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9854 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9856 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9857 XrmoptionSepArg, NULL},
9858 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9860 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9861 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9862 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9863 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9864 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9865 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9866 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9869 /* Whether atimer for Xt timeouts is activated or not. */
9871 static int x_timeout_atimer_activated_flag;
9873 #endif /* USE_X_TOOLKIT */
9875 static int x_initialized;
9877 #ifdef HAVE_X_SM
9878 static int x_session_initialized;
9879 #endif
9881 /* Test whether two display-name strings agree up to the dot that separates
9882 the screen number from the server number. */
9883 static int
9884 same_x_server (name1, name2)
9885 const char *name1, *name2;
9887 int seen_colon = 0;
9888 const unsigned char *system_name = SDATA (Vsystem_name);
9889 int system_name_length = strlen (system_name);
9890 int length_until_period = 0;
9892 while (system_name[length_until_period] != 0
9893 && system_name[length_until_period] != '.')
9894 length_until_period++;
9896 /* Treat `unix' like an empty host name. */
9897 if (! strncmp (name1, "unix:", 5))
9898 name1 += 4;
9899 if (! strncmp (name2, "unix:", 5))
9900 name2 += 4;
9901 /* Treat this host's name like an empty host name. */
9902 if (! strncmp (name1, system_name, system_name_length)
9903 && name1[system_name_length] == ':')
9904 name1 += system_name_length;
9905 if (! strncmp (name2, system_name, system_name_length)
9906 && name2[system_name_length] == ':')
9907 name2 += system_name_length;
9908 /* Treat this host's domainless name like an empty host name. */
9909 if (! strncmp (name1, system_name, length_until_period)
9910 && name1[length_until_period] == ':')
9911 name1 += length_until_period;
9912 if (! strncmp (name2, system_name, length_until_period)
9913 && name2[length_until_period] == ':')
9914 name2 += length_until_period;
9916 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9918 if (*name1 == ':')
9919 seen_colon++;
9920 if (seen_colon && *name1 == '.')
9921 return 1;
9923 return (seen_colon
9924 && (*name1 == '.' || *name1 == '\0')
9925 && (*name2 == '.' || *name2 == '\0'));
9928 /* Count number of set bits in mask and number of bits to shift to
9929 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9930 to 5. */
9931 static void
9932 get_bits_and_offset (mask, bits, offset)
9933 unsigned long mask;
9934 int *bits;
9935 int *offset;
9937 int nr = 0;
9938 int off = 0;
9940 while (!(mask & 1))
9942 off++;
9943 mask >>= 1;
9946 while (mask & 1)
9948 nr++;
9949 mask >>= 1;
9952 *offset = off;
9953 *bits = nr;
9956 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9957 But don't permanently open it, just test its availability. */
9960 x_display_ok (display)
9961 const char *display;
9963 int dpy_ok = 1;
9964 Display *dpy;
9966 dpy = XOpenDisplay (display);
9967 if (dpy)
9968 XCloseDisplay (dpy);
9969 else
9970 dpy_ok = 0;
9971 return dpy_ok;
9974 /* Open a connection to X display DISPLAY_NAME, and return
9975 the structure that describes the open display.
9976 If we cannot contact the display, return null. */
9978 struct x_display_info *
9979 x_term_init (display_name, xrm_option, resource_name)
9980 Lisp_Object display_name;
9981 char *xrm_option;
9982 char *resource_name;
9984 int connection;
9985 Display *dpy;
9986 struct terminal *terminal;
9987 struct x_display_info *dpyinfo;
9988 XrmDatabase xrdb;
9990 BLOCK_INPUT;
9992 if (!x_initialized)
9994 x_initialize ();
9995 ++x_initialized;
9998 if (! x_display_ok (SDATA (display_name)))
9999 error ("Display %s can't be opened", SDATA (display_name));
10001 #ifdef USE_GTK
10003 #define NUM_ARGV 10
10004 int argc;
10005 char *argv[NUM_ARGV];
10006 char **argv2 = argv;
10007 GdkAtom atom;
10009 #ifndef HAVE_GTK_MULTIDISPLAY
10010 if (!EQ (Vinitial_window_system, intern ("x")))
10011 error ("Sorry, you cannot connect to X servers with the GTK toolkit");
10012 #endif
10014 if (x_initialized++ > 1)
10016 #ifdef HAVE_GTK_MULTIDISPLAY
10017 /* Opening another display. If xg_display_open returns less
10018 than zero, we are probably on GTK 2.0, which can only handle
10019 one display. GTK 2.2 or later can handle more than one. */
10020 if (xg_display_open (SDATA (display_name), &dpy) < 0)
10021 #endif
10022 error ("Sorry, this version of GTK can only handle one display");
10024 else
10026 for (argc = 0; argc < NUM_ARGV; ++argc)
10027 argv[argc] = 0;
10029 argc = 0;
10030 argv[argc++] = initial_argv[0];
10032 if (! NILP (display_name))
10034 argv[argc++] = "--display";
10035 argv[argc++] = SDATA (display_name);
10038 argv[argc++] = "--name";
10039 argv[argc++] = resource_name;
10041 XSetLocaleModifiers ("");
10043 gtk_init (&argc, &argv2);
10045 /* gtk_init does set_locale. We must fix locale after calling it. */
10046 fixup_locale ();
10047 xg_initialize ();
10049 dpy = GDK_DISPLAY ();
10051 /* NULL window -> events for all windows go to our function */
10052 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10054 /* Load our own gtkrc if it exists. */
10056 char *file = "~/.emacs.d/gtkrc";
10057 Lisp_Object s, abs_file;
10059 s = make_string (file, strlen (file));
10060 abs_file = Fexpand_file_name (s, Qnil);
10062 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10063 gtk_rc_parse (SDATA (abs_file));
10066 XSetErrorHandler (x_error_handler);
10067 XSetIOErrorHandler (x_io_error_quitter);
10070 #else /* not USE_GTK */
10071 #ifdef USE_X_TOOLKIT
10072 /* weiner@footloose.sps.mot.com reports that this causes
10073 errors with X11R5:
10074 X protocol error: BadAtom (invalid Atom parameter)
10075 on protocol request 18skiloaf.
10076 So let's not use it until R6. */
10077 #ifdef HAVE_X11XTR6
10078 XtSetLanguageProc (NULL, NULL, NULL);
10079 #endif
10082 int argc = 0;
10083 char *argv[3];
10085 argv[0] = "";
10086 argc = 1;
10087 if (xrm_option)
10089 argv[argc++] = "-xrm";
10090 argv[argc++] = xrm_option;
10092 turn_on_atimers (0);
10093 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10094 resource_name, EMACS_CLASS,
10095 emacs_options, XtNumber (emacs_options),
10096 &argc, argv);
10097 turn_on_atimers (1);
10099 #ifdef HAVE_X11XTR6
10100 /* I think this is to compensate for XtSetLanguageProc. */
10101 fixup_locale ();
10102 #endif
10105 #else /* not USE_X_TOOLKIT */
10106 XSetLocaleModifiers ("");
10107 dpy = XOpenDisplay (SDATA (display_name));
10108 #endif /* not USE_X_TOOLKIT */
10109 #endif /* not USE_GTK*/
10111 /* Detect failure. */
10112 if (dpy == 0)
10114 UNBLOCK_INPUT;
10115 return 0;
10118 /* We have definitely succeeded. Record the new connection. */
10120 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10121 bzero (dpyinfo, sizeof *dpyinfo);
10123 terminal = x_create_terminal (dpyinfo);
10126 struct x_display_info *share;
10127 Lisp_Object tail;
10129 for (share = x_display_list, tail = x_display_name_list; share;
10130 share = share->next, tail = XCDR (tail))
10131 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10132 SDATA (display_name)))
10133 break;
10134 if (share)
10135 terminal->kboard = share->terminal->kboard;
10136 else
10138 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10139 init_kboard (terminal->kboard);
10140 terminal->kboard->Vwindow_system = intern ("x");
10141 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10143 char *vendor = ServerVendor (dpy);
10144 /* Temporarily hide the partially initialized terminal */
10145 terminal_list = terminal->next_terminal;
10146 UNBLOCK_INPUT;
10147 terminal->kboard->Vsystem_key_alist
10148 = call1 (Qvendor_specific_keysyms,
10149 vendor ? build_string (vendor) : empty_unibyte_string);
10150 BLOCK_INPUT;
10151 terminal->next_terminal = terminal_list;
10152 terminal_list = terminal;
10155 terminal->kboard->next_kboard = all_kboards;
10156 all_kboards = terminal->kboard;
10157 /* Don't let the initial kboard remain current longer than necessary.
10158 That would cause problems if a file loaded on startup tries to
10159 prompt in the mini-buffer. */
10160 if (current_kboard == initial_kboard)
10161 current_kboard = terminal->kboard;
10163 terminal->kboard->reference_count++;
10166 /* Put this display on the chain. */
10167 dpyinfo->next = x_display_list;
10168 x_display_list = dpyinfo;
10170 /* Put it on x_display_name_list as well, to keep them parallel. */
10171 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10172 x_display_name_list);
10173 dpyinfo->name_list_element = XCAR (x_display_name_list);
10175 dpyinfo->display = dpy;
10177 /* Set the name of the terminal. */
10178 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10179 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10180 terminal->name[SBYTES (display_name)] = 0;
10182 #if 0
10183 XSetAfterFunction (x_current_display, x_trace_wire);
10184 #endif /* ! 0 */
10186 dpyinfo->x_id_name
10187 = (char *) xmalloc (SBYTES (Vinvocation_name)
10188 + SBYTES (Vsystem_name)
10189 + 2);
10190 sprintf (dpyinfo->x_id_name, "%s@%s",
10191 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10193 /* Figure out which modifier bits mean what. */
10194 x_find_modifier_meanings (dpyinfo);
10196 /* Get the scroll bar cursor. */
10197 #ifdef USE_GTK
10198 /* We must create a GTK cursor, it is required for GTK widgets. */
10199 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10200 #endif /* USE_GTK */
10202 dpyinfo->vertical_scroll_bar_cursor
10203 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10205 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10206 resource_name, EMACS_CLASS);
10207 #ifdef HAVE_XRMSETDATABASE
10208 XrmSetDatabase (dpyinfo->display, xrdb);
10209 #else
10210 dpyinfo->display->db = xrdb;
10211 #endif
10212 /* Put the rdb where we can find it in a way that works on
10213 all versions. */
10214 dpyinfo->xrdb = xrdb;
10216 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10217 DefaultScreen (dpyinfo->display));
10218 select_visual (dpyinfo);
10219 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10220 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10221 dpyinfo->client_leader_window = 0;
10222 dpyinfo->grabbed = 0;
10223 dpyinfo->reference_count = 0;
10224 dpyinfo->icon_bitmap_id = -1;
10225 dpyinfo->n_fonts = 0;
10226 dpyinfo->bitmaps = 0;
10227 dpyinfo->bitmaps_size = 0;
10228 dpyinfo->bitmaps_last = 0;
10229 dpyinfo->scratch_cursor_gc = 0;
10230 dpyinfo->mouse_face_mouse_frame = 0;
10231 dpyinfo->mouse_face_deferred_gc = 0;
10232 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10233 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10234 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10235 dpyinfo->mouse_face_window = Qnil;
10236 dpyinfo->mouse_face_overlay = Qnil;
10237 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10238 dpyinfo->mouse_face_defer = 0;
10239 dpyinfo->mouse_face_hidden = 0;
10240 dpyinfo->x_focus_frame = 0;
10241 dpyinfo->x_focus_event_frame = 0;
10242 dpyinfo->x_highlight_frame = 0;
10243 dpyinfo->terminal->image_cache = make_image_cache ();
10244 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10246 /* See if we can construct pixel values from RGB values. */
10247 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10248 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10250 if (dpyinfo->visual->class == TrueColor)
10252 get_bits_and_offset (dpyinfo->visual->red_mask,
10253 &dpyinfo->red_bits, &dpyinfo->red_offset);
10254 get_bits_and_offset (dpyinfo->visual->blue_mask,
10255 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10256 get_bits_and_offset (dpyinfo->visual->green_mask,
10257 &dpyinfo->green_bits, &dpyinfo->green_offset);
10260 /* See if a private colormap is requested. */
10261 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10263 if (dpyinfo->visual->class == PseudoColor)
10265 Lisp_Object value;
10266 value = display_x_get_resource (dpyinfo,
10267 build_string ("privateColormap"),
10268 build_string ("PrivateColormap"),
10269 Qnil, Qnil);
10270 if (STRINGP (value)
10271 && (!strcmp (SDATA (value), "true")
10272 || !strcmp (SDATA (value), "on")))
10273 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10276 else
10277 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10278 dpyinfo->visual, AllocNone);
10281 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10282 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10283 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10284 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10285 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10286 pixels = DisplayWidth (dpyinfo->display, screen_number);
10287 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10288 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10289 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10292 dpyinfo->Xatom_wm_protocols
10293 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10294 dpyinfo->Xatom_wm_take_focus
10295 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10296 dpyinfo->Xatom_wm_save_yourself
10297 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10298 dpyinfo->Xatom_wm_delete_window
10299 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10300 dpyinfo->Xatom_wm_change_state
10301 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10302 dpyinfo->Xatom_wm_configure_denied
10303 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10304 dpyinfo->Xatom_wm_window_moved
10305 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10306 dpyinfo->Xatom_wm_client_leader
10307 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10308 dpyinfo->Xatom_editres
10309 = XInternAtom (dpyinfo->display, "Editres", False);
10310 dpyinfo->Xatom_CLIPBOARD
10311 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10312 dpyinfo->Xatom_TIMESTAMP
10313 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10314 dpyinfo->Xatom_TEXT
10315 = XInternAtom (dpyinfo->display, "TEXT", False);
10316 dpyinfo->Xatom_COMPOUND_TEXT
10317 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10318 dpyinfo->Xatom_UTF8_STRING
10319 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10320 dpyinfo->Xatom_DELETE
10321 = XInternAtom (dpyinfo->display, "DELETE", False);
10322 dpyinfo->Xatom_MULTIPLE
10323 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10324 dpyinfo->Xatom_INCR
10325 = XInternAtom (dpyinfo->display, "INCR", False);
10326 dpyinfo->Xatom_EMACS_TMP
10327 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10328 dpyinfo->Xatom_TARGETS
10329 = XInternAtom (dpyinfo->display, "TARGETS", False);
10330 dpyinfo->Xatom_NULL
10331 = XInternAtom (dpyinfo->display, "NULL", False);
10332 dpyinfo->Xatom_ATOM_PAIR
10333 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10334 /* For properties of font. */
10335 dpyinfo->Xatom_PIXEL_SIZE
10336 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10337 dpyinfo->Xatom_AVERAGE_WIDTH
10338 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10339 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10340 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10341 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10342 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10343 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10344 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10346 /* Ghostscript support. */
10347 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10348 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10350 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10351 False);
10353 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10354 False);
10356 dpyinfo->cut_buffers_initialized = 0;
10358 dpyinfo->x_dnd_atoms_size = 8;
10359 dpyinfo->x_dnd_atoms_length = 0;
10360 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10361 * dpyinfo->x_dnd_atoms_size);
10363 dpyinfo->net_supported_atoms = NULL;
10364 dpyinfo->nr_net_supported_atoms = 0;
10365 dpyinfo->net_supported_window = 0;
10367 connection = ConnectionNumber (dpyinfo->display);
10368 dpyinfo->connection = connection;
10371 char null_bits[1];
10373 null_bits[0] = 0x00;
10375 dpyinfo->null_pixel
10376 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10377 null_bits, 1, 1, (long) 0, (long) 0,
10382 extern int gray_bitmap_width, gray_bitmap_height;
10383 extern char *gray_bitmap_bits;
10384 dpyinfo->gray
10385 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10386 gray_bitmap_bits,
10387 gray_bitmap_width, gray_bitmap_height,
10388 (unsigned long) 1, (unsigned long) 0, 1);
10391 #ifdef HAVE_X_I18N
10392 xim_initialize (dpyinfo, resource_name);
10393 #endif
10395 #ifdef subprocesses
10396 /* This is only needed for distinguishing keyboard and process input. */
10397 if (connection != 0)
10398 add_keyboard_wait_descriptor (connection);
10399 #endif
10401 #ifdef F_SETOWN
10402 fcntl (connection, F_SETOWN, getpid ());
10403 #endif /* ! defined (F_SETOWN) */
10405 #ifdef SIGIO
10406 if (interrupt_input)
10407 init_sigio (connection);
10408 #endif /* ! defined (SIGIO) */
10410 #ifdef USE_LUCID
10412 Display *dpy = dpyinfo->display;
10413 XrmValue d, fr, to;
10414 Font font;
10416 d.addr = (XPointer)&dpy;
10417 d.size = sizeof (Display *);
10418 fr.addr = XtDefaultFont;
10419 fr.size = sizeof (XtDefaultFont);
10420 to.size = sizeof (Font *);
10421 to.addr = (XPointer)&font;
10422 x_catch_errors (dpy);
10423 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10424 abort ();
10425 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10426 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10427 x_uncatch_errors ();
10429 #endif
10431 /* See if we should run in synchronous mode. This is useful
10432 for debugging X code. */
10434 Lisp_Object value;
10435 value = display_x_get_resource (dpyinfo,
10436 build_string ("synchronous"),
10437 build_string ("Synchronous"),
10438 Qnil, Qnil);
10439 if (STRINGP (value)
10440 && (!strcmp (SDATA (value), "true")
10441 || !strcmp (SDATA (value), "on")))
10442 XSynchronize (dpyinfo->display, True);
10446 Lisp_Object value;
10447 value = display_x_get_resource (dpyinfo,
10448 build_string ("useXIM"),
10449 build_string ("UseXIM"),
10450 Qnil, Qnil);
10451 #ifdef USE_XIM
10452 if (STRINGP (value)
10453 && (!strcmp (SDATA (value), "false")
10454 || !strcmp (SDATA (value), "off")))
10455 use_xim = 0;
10456 #else
10457 if (STRINGP (value)
10458 && (!strcmp (SDATA (value), "true")
10459 || !strcmp (SDATA (value), "on")))
10460 use_xim = 1;
10461 #endif
10464 #ifdef HAVE_X_SM
10465 /* Only do this for the very first display in the Emacs session.
10466 Ignore X session management when Emacs was first started on a
10467 tty. */
10468 if (terminal->id == 1)
10469 x_session_initialize (dpyinfo);
10470 #endif
10472 UNBLOCK_INPUT;
10474 return dpyinfo;
10477 /* Get rid of display DPYINFO, deleting all frames on it,
10478 and without sending any more commands to the X server. */
10480 void
10481 x_delete_display (dpyinfo)
10482 struct x_display_info *dpyinfo;
10484 int i;
10485 struct terminal *t;
10487 /* Close all frames and delete the generic struct terminal for this
10488 X display. */
10489 for (t = terminal_list; t; t = t->next_terminal)
10490 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10492 #ifdef HAVE_X_SM
10493 /* Close X session management when we close its display. */
10494 if (t->id == 1 && x_session_have_connection ())
10495 x_session_close();
10496 #endif
10497 delete_terminal (t);
10498 break;
10501 delete_keyboard_wait_descriptor (dpyinfo->connection);
10503 /* Discard this display from x_display_name_list and x_display_list.
10504 We can't use Fdelq because that can quit. */
10505 if (! NILP (x_display_name_list)
10506 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10507 x_display_name_list = XCDR (x_display_name_list);
10508 else
10510 Lisp_Object tail;
10512 tail = x_display_name_list;
10513 while (CONSP (tail) && CONSP (XCDR (tail)))
10515 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10517 XSETCDR (tail, XCDR (XCDR (tail)));
10518 break;
10520 tail = XCDR (tail);
10524 if (next_noop_dpyinfo == dpyinfo)
10525 next_noop_dpyinfo = dpyinfo->next;
10527 if (x_display_list == dpyinfo)
10528 x_display_list = dpyinfo->next;
10529 else
10531 struct x_display_info *tail;
10533 for (tail = x_display_list; tail; tail = tail->next)
10534 if (tail->next == dpyinfo)
10535 tail->next = tail->next->next;
10538 /* Xt and GTK do this themselves. */
10539 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
10540 #ifndef AIX /* On AIX, XCloseDisplay calls this. */
10541 XrmDestroyDatabase (dpyinfo->xrdb);
10542 #endif
10543 #endif
10544 #ifdef HAVE_X_I18N
10545 if (dpyinfo->xim)
10546 xim_close_dpy (dpyinfo);
10547 #endif
10549 xfree (dpyinfo->x_id_name);
10550 xfree (dpyinfo->color_cells);
10551 xfree (dpyinfo);
10554 #ifdef USE_X_TOOLKIT
10556 /* Atimer callback function for TIMER. Called every 0.1s to process
10557 Xt timeouts, if needed. We must avoid calling XtAppPending as
10558 much as possible because that function does an implicit XFlush
10559 that slows us down. */
10561 static void
10562 x_process_timeouts (timer)
10563 struct atimer *timer;
10565 BLOCK_INPUT;
10566 x_timeout_atimer_activated_flag = 0;
10567 if (toolkit_scroll_bar_interaction || popup_activated ())
10569 while (XtAppPending (Xt_app_con) & XtIMTimer)
10570 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10571 /* Reactivate the atimer for next time. */
10572 x_activate_timeout_atimer ();
10574 UNBLOCK_INPUT;
10577 /* Install an asynchronous timer that processes Xt timeout events
10578 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10579 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10580 function whenever these variables are set. This is necessary
10581 because some widget sets use timeouts internally, for example the
10582 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10583 processed, these widgets don't behave normally. */
10585 void
10586 x_activate_timeout_atimer ()
10588 BLOCK_INPUT;
10589 if (!x_timeout_atimer_activated_flag)
10591 EMACS_TIME interval;
10593 EMACS_SET_SECS_USECS (interval, 0, 100000);
10594 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10595 x_timeout_atimer_activated_flag = 1;
10597 UNBLOCK_INPUT;
10600 #endif /* USE_X_TOOLKIT */
10603 /* Set up use of X before we make the first connection. */
10605 extern frame_parm_handler x_frame_parm_handlers[];
10607 static struct redisplay_interface x_redisplay_interface =
10609 x_frame_parm_handlers,
10610 x_produce_glyphs,
10611 x_write_glyphs,
10612 x_insert_glyphs,
10613 x_clear_end_of_line,
10614 x_scroll_run,
10615 x_after_update_window_line,
10616 x_update_window_begin,
10617 x_update_window_end,
10618 x_cursor_to,
10619 x_flush,
10620 #ifdef XFlush
10621 x_flush,
10622 #else
10623 0, /* flush_display_optional */
10624 #endif
10625 x_clear_window_mouse_face,
10626 x_get_glyph_overhangs,
10627 x_fix_overlapping_area,
10628 x_draw_fringe_bitmap,
10629 0, /* define_fringe_bitmap */
10630 0, /* destroy_fringe_bitmap */
10631 x_compute_glyph_string_overhangs,
10632 x_draw_glyph_string,
10633 x_define_frame_cursor,
10634 x_clear_frame_area,
10635 x_draw_window_cursor,
10636 x_draw_vertical_window_border,
10637 x_shift_glyphs_for_insert
10641 /* This function is called when the last frame on a display is deleted. */
10642 void
10643 x_delete_terminal (struct terminal *terminal)
10645 struct x_display_info *dpyinfo = terminal->display_info.x;
10646 int i;
10648 /* Protect against recursive calls. Fdelete_frame in
10649 delete_terminal calls us back when it deletes our last frame. */
10650 if (!terminal->name)
10651 return;
10653 BLOCK_INPUT;
10654 /* If called from x_connection_closed, the display may already be closed
10655 and dpyinfo->display was set to 0 to indicate that. */
10656 if (dpyinfo->display)
10658 x_destroy_all_bitmaps (dpyinfo);
10659 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10661 #ifdef USE_GTK
10662 xg_display_close (dpyinfo->display);
10663 #else
10664 #ifdef USE_X_TOOLKIT
10665 XtCloseDisplay (dpyinfo->display);
10666 #else
10667 XCloseDisplay (dpyinfo->display);
10668 #endif
10669 #endif /* ! USE_GTK */
10672 x_delete_display (dpyinfo);
10673 UNBLOCK_INPUT;
10676 /* Create a struct terminal, initialize it with the X11 specific
10677 functions and make DISPLAY->TERMINAL point to it. */
10679 static struct terminal *
10680 x_create_terminal (struct x_display_info *dpyinfo)
10682 struct terminal *terminal;
10684 terminal = create_terminal ();
10686 terminal->type = output_x_window;
10687 terminal->display_info.x = dpyinfo;
10688 dpyinfo->terminal = terminal;
10690 /* kboard is initialized in x_term_init. */
10692 terminal->clear_frame_hook = x_clear_frame;
10693 terminal->ins_del_lines_hook = x_ins_del_lines;
10694 terminal->delete_glyphs_hook = x_delete_glyphs;
10695 terminal->ring_bell_hook = XTring_bell;
10696 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10697 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10698 terminal->update_begin_hook = x_update_begin;
10699 terminal->update_end_hook = x_update_end;
10700 terminal->set_terminal_window_hook = XTset_terminal_window;
10701 terminal->read_socket_hook = XTread_socket;
10702 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10703 terminal->mouse_position_hook = XTmouse_position;
10704 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10705 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10706 terminal->fullscreen_hook = XTfullscreen_hook;
10707 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10708 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10709 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10710 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10712 terminal->delete_frame_hook = x_destroy_window;
10713 terminal->delete_terminal_hook = x_delete_terminal;
10715 terminal->rif = &x_redisplay_interface;
10716 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10717 terminal->char_ins_del_ok = 1;
10718 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10719 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10720 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10721 off the bottom. */
10723 return terminal;
10726 void
10727 x_initialize ()
10729 baud_rate = 19200;
10731 x_noop_count = 0;
10732 last_tool_bar_item = -1;
10733 any_help_event_p = 0;
10734 ignore_next_mouse_click_timeout = 0;
10735 #ifdef HAVE_X_SM
10736 x_session_initialized = 0;
10737 #endif
10739 #ifdef USE_GTK
10740 current_count = -1;
10741 #endif
10743 /* Try to use interrupt input; if we can't, then start polling. */
10744 Fset_input_interrupt_mode (Qt);
10746 #ifdef USE_X_TOOLKIT
10747 XtToolkitInitialize ();
10749 Xt_app_con = XtCreateApplicationContext ();
10751 /* Register a converter from strings to pixels, which uses
10752 Emacs' color allocation infrastructure. */
10753 XtAppSetTypeConverter (Xt_app_con,
10754 XtRString, XtRPixel, cvt_string_to_pixel,
10755 cvt_string_to_pixel_args,
10756 XtNumber (cvt_string_to_pixel_args),
10757 XtCacheByDisplay, cvt_pixel_dtor);
10759 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10760 #endif
10762 #ifdef USE_TOOLKIT_SCROLL_BARS
10763 #ifndef USE_GTK
10764 xaw3d_arrow_scroll = False;
10765 xaw3d_pick_top = True;
10766 #endif
10767 #endif
10769 /* Note that there is no real way portable across R3/R4 to get the
10770 original error handler. */
10771 XSetErrorHandler (x_error_handler);
10772 XSetIOErrorHandler (x_io_error_quitter);
10774 /* Disable Window Change signals; they are handled by X events. */
10775 #if 0 /* Don't. We may want to open tty frames later. */
10776 #ifdef SIGWINCH
10777 signal (SIGWINCH, SIG_DFL);
10778 #endif /* SIGWINCH */
10779 #endif
10781 signal (SIGPIPE, x_connection_signal);
10785 void
10786 syms_of_xterm ()
10788 x_error_message = NULL;
10790 staticpro (&x_display_name_list);
10791 x_display_name_list = Qnil;
10793 staticpro (&last_mouse_scroll_bar);
10794 last_mouse_scroll_bar = Qnil;
10796 staticpro (&Qvendor_specific_keysyms);
10797 Qvendor_specific_keysyms = intern ("vendor-specific-keysyms");
10799 staticpro (&Qlatin_1);
10800 Qlatin_1 = intern ("latin-1");
10802 staticpro (&last_mouse_press_frame);
10803 last_mouse_press_frame = Qnil;
10805 DEFVAR_BOOL ("x-use-underline-position-properties",
10806 &x_use_underline_position_properties,
10807 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10808 A value of nil means ignore them. If you encounter fonts with bogus
10809 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10810 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10811 to override the font's UNDERLINE_POSITION for small font display
10812 sizes. */);
10813 x_use_underline_position_properties = 1;
10815 DEFVAR_BOOL ("x-underline-at-descent-line",
10816 &x_underline_at_descent_line,
10817 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10818 A value of nil means to draw the underline according to the value of the
10819 variable `x-use-underline-position-properties', which is usually at the
10820 baseline level. The default value is nil. */);
10821 x_underline_at_descent_line = 0;
10823 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10824 &x_mouse_click_focus_ignore_position,
10825 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10826 This variable is only used when the window manager requires that you
10827 click on a frame to select it (give it focus). In that case, a value
10828 of nil, means that the selected window and cursor position changes to
10829 reflect the mouse click position, while a non-nil value means that the
10830 selected window or cursor position is preserved. */);
10831 x_mouse_click_focus_ignore_position = 0;
10833 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10834 doc: /* What X toolkit scroll bars Emacs uses.
10835 A value of nil means Emacs doesn't use X toolkit scroll bars.
10836 Otherwise, value is a symbol describing the X toolkit. */);
10837 #ifdef USE_TOOLKIT_SCROLL_BARS
10838 #ifdef USE_MOTIF
10839 Vx_toolkit_scroll_bars = intern ("motif");
10840 #elif defined HAVE_XAW3D
10841 Vx_toolkit_scroll_bars = intern ("xaw3d");
10842 #elif USE_GTK
10843 Vx_toolkit_scroll_bars = intern ("gtk");
10844 #else
10845 Vx_toolkit_scroll_bars = intern ("xaw");
10846 #endif
10847 #else
10848 Vx_toolkit_scroll_bars = Qnil;
10849 #endif
10851 staticpro (&last_mouse_motion_frame);
10852 last_mouse_motion_frame = Qnil;
10854 Qmodifier_value = intern ("modifier-value");
10855 Qalt = intern ("alt");
10856 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10857 Qhyper = intern ("hyper");
10858 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10859 Qmeta = intern ("meta");
10860 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10861 Qsuper = intern ("super");
10862 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10864 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10865 doc: /* Which keys Emacs uses for the alt modifier.
10866 This should be one of the symbols `alt', `hyper', `meta', `super'.
10867 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10868 is nil, which is the same as `alt'. */);
10869 Vx_alt_keysym = Qnil;
10871 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10872 doc: /* Which keys Emacs uses for the hyper modifier.
10873 This should be one of the symbols `alt', `hyper', `meta', `super'.
10874 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10875 default is nil, which is the same as `hyper'. */);
10876 Vx_hyper_keysym = Qnil;
10878 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10879 doc: /* Which keys Emacs uses for the meta modifier.
10880 This should be one of the symbols `alt', `hyper', `meta', `super'.
10881 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10882 default is nil, which is the same as `meta'. */);
10883 Vx_meta_keysym = Qnil;
10885 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10886 doc: /* Which keys Emacs uses for the super modifier.
10887 This should be one of the symbols `alt', `hyper', `meta', `super'.
10888 For example, `super' means use the Super_L and Super_R keysyms. The
10889 default is nil, which is the same as `super'. */);
10890 Vx_super_keysym = Qnil;
10892 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10893 doc: /* Hash table of character codes indexed by X keysym codes. */);
10894 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10895 make_float (DEFAULT_REHASH_SIZE),
10896 make_float (DEFAULT_REHASH_THRESHOLD),
10897 Qnil, Qnil, Qnil);
10900 #endif /* HAVE_X_WINDOWS */
10902 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10903 (do not change this comment) */