* src/fileio.c (Fwrite_region): Delay the defaulting to beg&z to after
[emacs.git] / src / xterm.c
bloba14a8ed20ebbfd8ba1c989ddcf8dfbe2f2bb9a66
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"
88 #ifdef USE_X_TOOLKIT
89 #include <X11/Shell.h>
90 #endif
92 #ifdef HAVE_SYS_TIME_H
93 #include <sys/time.h>
94 #endif
95 #ifdef HAVE_UNISTD_H
96 #include <unistd.h>
97 #endif
99 #ifdef USE_GTK
100 #include "gtkutil.h"
101 #endif
103 #ifdef USE_LUCID
104 extern int xlwmenu_window_p P_ ((Widget w, Window window));
105 extern void xlwmenu_redisplay P_ ((Widget));
106 #endif
108 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
110 extern void free_frame_menubar P_ ((struct frame *));
111 extern struct frame *x_menubar_window_to_frame P_ ((struct x_display_info *,
112 int));
113 #endif
115 #ifdef USE_X_TOOLKIT
116 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
117 #define HACK_EDITRES
118 extern void _XEditResCheckMessages ();
119 #endif /* not NO_EDITRES */
121 /* Include toolkit specific headers for the scroll bar widget. */
123 #ifdef USE_TOOLKIT_SCROLL_BARS
124 #if defined USE_MOTIF
125 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
126 #include <Xm/ScrollBar.h>
127 #else /* !USE_MOTIF i.e. use Xaw */
129 #ifdef HAVE_XAW3D
130 #include <X11/Xaw3d/Simple.h>
131 #include <X11/Xaw3d/Scrollbar.h>
132 #include <X11/Xaw3d/ThreeD.h>
133 #else /* !HAVE_XAW3D */
134 #include <X11/Xaw/Simple.h>
135 #include <X11/Xaw/Scrollbar.h>
136 #endif /* !HAVE_XAW3D */
137 #ifndef XtNpickTop
138 #define XtNpickTop "pickTop"
139 #endif /* !XtNpickTop */
140 #endif /* !USE_MOTIF */
141 #endif /* USE_TOOLKIT_SCROLL_BARS */
143 #endif /* USE_X_TOOLKIT */
145 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
146 #define x_any_window_to_frame x_window_to_frame
147 #define x_top_window_to_frame x_window_to_frame
148 #endif
150 #ifdef USE_X_TOOLKIT
151 #include "widget.h"
152 #ifndef XtNinitialState
153 #define XtNinitialState "initialState"
154 #endif
155 #endif
157 /* Default to using XIM if available. */
158 #ifdef USE_XIM
159 int use_xim = 1;
160 #else
161 int use_xim = 0; /* configure --without-xim */
162 #endif
166 /* Non-nil means Emacs uses toolkit scroll bars. */
168 Lisp_Object Vx_toolkit_scroll_bars;
170 /* Non-zero means that a HELP_EVENT has been generated since Emacs
171 start. */
173 static int any_help_event_p;
175 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
176 static Lisp_Object last_window;
178 /* Non-zero means make use of UNDERLINE_POSITION font properties. */
180 int x_use_underline_position_properties;
182 /* Non-zero means to draw the underline at the same place as the descent line. */
184 int x_underline_at_descent_line;
186 /* This is a chain of structures for all the X displays currently in
187 use. */
189 struct x_display_info *x_display_list;
191 /* This is a list of cons cells, each of the form (NAME
192 . FONT-LIST-CACHE), one for each element of x_display_list and in
193 the same order. NAME is the name of the frame. FONT-LIST-CACHE
194 records previous values returned by x-list-fonts. */
196 Lisp_Object x_display_name_list;
198 /* Frame being updated by update_frame. This is declared in term.c.
199 This is set by update_begin and looked at by all the XT functions.
200 It is zero while not inside an update. In that case, the XT
201 functions assume that `selected_frame' is the frame to apply to. */
203 extern struct frame *updating_frame;
205 /* This is a frame waiting to be auto-raised, within XTread_socket. */
207 struct frame *pending_autoraise_frame;
209 #ifdef USE_X_TOOLKIT
210 /* The application context for Xt use. */
211 XtAppContext Xt_app_con;
212 static String Xt_default_resources[] = {0};
213 #endif /* USE_X_TOOLKIT */
215 /* Non-zero means user is interacting with a toolkit scroll bar. */
217 static int toolkit_scroll_bar_interaction;
219 /* Non-zero means to not move point as a result of clicking on a
220 frame to focus it (when focus-follows-mouse is nil). */
222 int x_mouse_click_focus_ignore_position;
224 /* Non-zero timeout value means ignore next mouse click if it arrives
225 before that timeout elapses (i.e. as part of the same sequence of
226 events resulting from clicking on a frame to select it). */
228 static unsigned long ignore_next_mouse_click_timeout;
230 /* Mouse movement.
232 Formerly, we used PointerMotionHintMask (in standard_event_mask)
233 so that we would have to call XQueryPointer after each MotionNotify
234 event to ask for another such event. However, this made mouse tracking
235 slow, and there was a bug that made it eventually stop.
237 Simply asking for MotionNotify all the time seems to work better.
239 In order to avoid asking for motion events and then throwing most
240 of them away or busy-polling the server for mouse positions, we ask
241 the server for pointer motion hints. This means that we get only
242 one event per group of mouse movements. "Groups" are delimited by
243 other kinds of events (focus changes and button clicks, for
244 example), or by XQueryPointer calls; when one of these happens, we
245 get another MotionNotify event the next time the mouse moves. This
246 is at least as efficient as getting motion events when mouse
247 tracking is on, and I suspect only negligibly worse when tracking
248 is off. */
250 /* Where the mouse was last time we reported a mouse event. */
252 static XRectangle last_mouse_glyph;
253 static FRAME_PTR last_mouse_glyph_frame;
254 static Lisp_Object last_mouse_press_frame;
256 /* The scroll bar in which the last X motion event occurred.
258 If the last X motion event occurred in a scroll bar, we set this so
259 XTmouse_position can know whether to report a scroll bar motion or
260 an ordinary motion.
262 If the last X motion event didn't occur in a scroll bar, we set
263 this to Qnil, to tell XTmouse_position to return an ordinary motion
264 event. */
266 static Lisp_Object last_mouse_scroll_bar;
268 /* This is a hack. We would really prefer that XTmouse_position would
269 return the time associated with the position it returns, but there
270 doesn't seem to be any way to wrest the time-stamp from the server
271 along with the position query. So, we just keep track of the time
272 of the last movement we received, and return that in hopes that
273 it's somewhat accurate. */
275 static Time last_mouse_movement_time;
277 /* Time for last user interaction as returned in X events. */
279 static Time last_user_time;
281 /* Incremented by XTread_socket whenever it really tries to read
282 events. */
284 #ifdef __STDC__
285 static int volatile input_signal_count;
286 #else
287 static int input_signal_count;
288 #endif
290 /* Used locally within XTread_socket. */
292 static int x_noop_count;
294 /* Initial values of argv and argc. */
296 extern char **initial_argv;
297 extern int initial_argc;
299 extern Lisp_Object Vcommand_line_args, Vsystem_name;
301 /* Tells if a window manager is present or not. */
303 extern Lisp_Object Vx_no_window_manager;
305 extern Lisp_Object Qeql;
307 extern int errno;
309 /* A mask of extra modifier bits to put into every keyboard char. */
311 extern EMACS_INT extra_keyboard_modifiers;
313 /* The keysyms to use for the various modifiers. */
315 Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
316 Lisp_Object Vx_keysym_table;
317 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
319 static Lisp_Object Qvendor_specific_keysyms;
320 static Lisp_Object Qlatin_1;
322 /* Used in x_flush. */
324 extern Lisp_Object Vinhibit_redisplay;
326 extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
327 extern int x_bitmap_mask P_ ((FRAME_PTR, int));
329 static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
330 static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
331 static const XColor *x_color_cells P_ ((Display *, int *));
332 static void x_update_window_end P_ ((struct window *, int, int));
334 static int x_io_error_quitter P_ ((Display *));
335 static struct terminal *x_create_terminal P_ ((struct x_display_info *));
336 void x_delete_terminal P_ ((struct terminal *));
337 static void x_update_end P_ ((struct frame *));
338 static void XTframe_up_to_date P_ ((struct frame *));
339 static void XTset_terminal_modes P_ ((struct terminal *));
340 static void XTreset_terminal_modes P_ ((struct terminal *));
341 static void x_clear_frame P_ ((struct frame *));
342 static void frame_highlight P_ ((struct frame *));
343 static void frame_unhighlight P_ ((struct frame *));
344 static void x_new_focus_frame P_ ((struct x_display_info *, struct frame *));
345 static void x_focus_changed P_ ((int, int, struct x_display_info *,
346 struct frame *, struct input_event *));
347 static void x_detect_focus_change P_ ((struct x_display_info *,
348 XEvent *, struct input_event *));
349 static void XTframe_rehighlight P_ ((struct frame *));
350 static void x_frame_rehighlight P_ ((struct x_display_info *));
351 static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
352 static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
353 enum text_cursor_kinds));
355 static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
356 static void x_flush P_ ((struct frame *f));
357 static void x_update_begin P_ ((struct frame *));
358 static void x_update_window_begin P_ ((struct window *));
359 static void x_after_update_window_line P_ ((struct glyph_row *));
360 static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
361 static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
362 enum scroll_bar_part *,
363 Lisp_Object *, Lisp_Object *,
364 unsigned long *));
365 static void x_check_fullscreen P_ ((struct frame *));
366 static void x_check_expected_move P_ ((struct frame *, int, int));
367 static void x_sync_with_move P_ ((struct frame *, int, int, int));
368 static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
369 int *, struct input_event *));
370 /* Don't declare this NO_RETURN because we want no
371 interference with debugging failing X calls. */
372 static SIGTYPE x_connection_closed P_ ((Display *, char *));
375 /* Flush display of frame F, or of all frames if F is null. */
377 static void
378 x_flush (f)
379 struct frame *f;
381 /* Don't call XFlush when it is not safe to redisplay; the X
382 connection may be broken. */
383 if (!NILP (Vinhibit_redisplay))
384 return;
386 BLOCK_INPUT;
387 if (f == NULL)
389 Lisp_Object rest, frame;
390 FOR_EACH_FRAME (rest, frame)
391 if (FRAME_X_P (XFRAME (frame)))
392 x_flush (XFRAME (frame));
394 else if (FRAME_X_P (f))
395 XFlush (FRAME_X_DISPLAY (f));
396 UNBLOCK_INPUT;
400 /* Remove calls to XFlush by defining XFlush to an empty replacement.
401 Calls to XFlush should be unnecessary because the X output buffer
402 is flushed automatically as needed by calls to XPending,
403 XNextEvent, or XWindowEvent according to the XFlush man page.
404 XTread_socket calls XPending. Removing XFlush improves
405 performance. */
407 #define XFlush(DISPLAY) (void) 0
410 /***********************************************************************
411 Debugging
412 ***********************************************************************/
414 #if 0
416 /* This is a function useful for recording debugging information about
417 the sequence of occurrences in this file. */
419 struct record
421 char *locus;
422 int type;
425 struct record event_record[100];
427 int event_record_index;
429 record_event (locus, type)
430 char *locus;
431 int type;
433 if (event_record_index == sizeof (event_record) / sizeof (struct record))
434 event_record_index = 0;
436 event_record[event_record_index].locus = locus;
437 event_record[event_record_index].type = type;
438 event_record_index++;
441 #endif /* 0 */
445 /* Return the struct x_display_info corresponding to DPY. */
447 struct x_display_info *
448 x_display_info_for_display (dpy)
449 Display *dpy;
451 struct x_display_info *dpyinfo;
453 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
454 if (dpyinfo->display == dpy)
455 return dpyinfo;
457 return 0;
460 #define OPAQUE 0xffffffff
461 #define OPACITY "_NET_WM_WINDOW_OPACITY"
463 void
464 x_set_frame_alpha (f)
465 struct frame *f;
467 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
468 Display *dpy = FRAME_X_DISPLAY (f);
469 Window win = FRAME_OUTER_WINDOW (f);
470 double alpha = 1.0;
471 double alpha_min = 1.0;
472 unsigned long opac;
474 if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
475 /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
476 we must treat the former instead of the latter. */
477 win = FRAME_X_OUTPUT(f)->parent_desc;
479 if (dpyinfo->x_highlight_frame == f)
480 alpha = f->alpha[0];
481 else
482 alpha = f->alpha[1];
484 if (FLOATP (Vframe_alpha_lower_limit))
485 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
486 else if (INTEGERP (Vframe_alpha_lower_limit))
487 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
489 if (alpha < 0.0 || 1.0 < alpha)
490 alpha = 1.0;
491 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
492 alpha = alpha_min;
494 opac = alpha * OPAQUE;
496 /* return unless necessary */
498 unsigned char *data;
499 Atom actual;
500 int format;
501 unsigned long n, left;
503 XGetWindowProperty(dpy, win, XInternAtom(dpy, OPACITY, False),
504 0L, 1L, False, XA_CARDINAL, &actual, &format, &n, &left,
505 &data);
506 if (actual != None)
507 if (*(unsigned long *)data == opac)
509 XFree ((void *) data);
510 return;
512 else
513 XFree ((void *) data);
516 XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
517 XA_CARDINAL, 32, PropModeReplace,
518 (unsigned char *) &opac, 1L);
519 XSync (dpy, False);
523 /***********************************************************************
524 Starting and ending an update
525 ***********************************************************************/
527 /* Start an update of frame F. This function is installed as a hook
528 for update_begin, i.e. it is called when update_begin is called.
529 This function is called prior to calls to x_update_window_begin for
530 each window being updated. Currently, there is nothing to do here
531 because all interesting stuff is done on a window basis. */
533 static void
534 x_update_begin (f)
535 struct frame *f;
537 /* Nothing to do. */
541 /* Start update of window W. Set the global variable updated_window
542 to the window being updated and set output_cursor to the cursor
543 position of W. */
545 static void
546 x_update_window_begin (w)
547 struct window *w;
549 struct frame *f = XFRAME (WINDOW_FRAME (w));
550 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
552 updated_window = w;
553 set_output_cursor (&w->cursor);
555 BLOCK_INPUT;
557 if (f == display_info->mouse_face_mouse_frame)
559 /* Don't do highlighting for mouse motion during the update. */
560 display_info->mouse_face_defer = 1;
562 /* If F needs to be redrawn, simply forget about any prior mouse
563 highlighting. */
564 if (FRAME_GARBAGED_P (f))
565 display_info->mouse_face_window = Qnil;
567 #if 0 /* Rows in a current matrix containing glyphs in mouse-face have
568 their mouse_face_p flag set, which means that they are always
569 unequal to rows in a desired matrix which never have that
570 flag set. So, rows containing mouse-face glyphs are never
571 scrolled, and we don't have to switch the mouse highlight off
572 here to prevent it from being scrolled. */
574 /* Can we tell that this update does not affect the window
575 where the mouse highlight is? If so, no need to turn off.
576 Likewise, don't do anything if the frame is garbaged;
577 in that case, the frame's current matrix that we would use
578 is all wrong, and we will redisplay that line anyway. */
579 if (!NILP (display_info->mouse_face_window)
580 && w == XWINDOW (display_info->mouse_face_window))
582 int i;
584 for (i = 0; i < w->desired_matrix->nrows; ++i)
585 if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
586 break;
588 if (i < w->desired_matrix->nrows)
589 clear_mouse_face (display_info);
591 #endif /* 0 */
594 UNBLOCK_INPUT;
598 /* Draw a vertical window border from (x,y0) to (x,y1) */
600 static void
601 x_draw_vertical_window_border (w, x, y0, y1)
602 struct window *w;
603 int x, y0, y1;
605 struct frame *f = XFRAME (WINDOW_FRAME (w));
606 struct face *face;
608 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
609 if (face)
610 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
611 face->foreground);
613 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
614 f->output_data.x->normal_gc, x, y0, x, y1);
617 /* End update of window W (which is equal to updated_window).
619 Draw vertical borders between horizontally adjacent windows, and
620 display W's cursor if CURSOR_ON_P is non-zero.
622 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
623 glyphs in mouse-face were overwritten. In that case we have to
624 make sure that the mouse-highlight is properly redrawn.
626 W may be a menu bar pseudo-window in case we don't have X toolkit
627 support. Such windows don't have a cursor, so don't display it
628 here. */
630 static void
631 x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
632 struct window *w;
633 int cursor_on_p, mouse_face_overwritten_p;
635 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
637 if (!w->pseudo_window_p)
639 BLOCK_INPUT;
641 if (cursor_on_p)
642 display_and_set_cursor (w, 1, output_cursor.hpos,
643 output_cursor.vpos,
644 output_cursor.x, output_cursor.y);
646 if (draw_window_fringes (w, 1))
647 x_draw_vertical_border (w);
649 UNBLOCK_INPUT;
652 /* If a row with mouse-face was overwritten, arrange for
653 XTframe_up_to_date to redisplay the mouse highlight. */
654 if (mouse_face_overwritten_p)
656 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
657 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
658 dpyinfo->mouse_face_window = Qnil;
661 updated_window = NULL;
665 /* End update of frame F. This function is installed as a hook in
666 update_end. */
668 static void
669 x_update_end (f)
670 struct frame *f;
672 /* Mouse highlight may be displayed again. */
673 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
675 #ifndef XFlush
676 BLOCK_INPUT;
677 XFlush (FRAME_X_DISPLAY (f));
678 UNBLOCK_INPUT;
679 #endif
683 /* This function is called from various places in xdisp.c whenever a
684 complete update has been performed. The global variable
685 updated_window is not available here. */
687 static void
688 XTframe_up_to_date (f)
689 struct frame *f;
691 if (FRAME_X_P (f))
693 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
695 if (dpyinfo->mouse_face_deferred_gc
696 || f == dpyinfo->mouse_face_mouse_frame)
698 BLOCK_INPUT;
699 if (dpyinfo->mouse_face_mouse_frame)
700 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
701 dpyinfo->mouse_face_mouse_x,
702 dpyinfo->mouse_face_mouse_y);
703 dpyinfo->mouse_face_deferred_gc = 0;
704 UNBLOCK_INPUT;
710 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
711 arrow bitmaps, or clear the fringes if no bitmaps are required
712 before DESIRED_ROW is made current. The window being updated is
713 found in updated_window. This function It is called from
714 update_window_line only if it is known that there are differences
715 between bitmaps to be drawn between current row and DESIRED_ROW. */
717 static void
718 x_after_update_window_line (desired_row)
719 struct glyph_row *desired_row;
721 struct window *w = updated_window;
722 struct frame *f;
723 int width, height;
725 xassert (w);
727 if (!desired_row->mode_line_p && !w->pseudo_window_p)
728 desired_row->redraw_fringe_bitmaps_p = 1;
730 /* When a window has disappeared, make sure that no rest of
731 full-width rows stays visible in the internal border. Could
732 check here if updated_window is the leftmost/rightmost window,
733 but I guess it's not worth doing since vertically split windows
734 are almost never used, internal border is rarely set, and the
735 overhead is very small. */
736 if (windows_or_buffers_changed
737 && desired_row->full_width_p
738 && (f = XFRAME (w->frame),
739 width = FRAME_INTERNAL_BORDER_WIDTH (f),
740 width != 0)
741 && (height = desired_row->visible_height,
742 height > 0))
744 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
746 /* Internal border is drawn below the tool bar. */
747 if (WINDOWP (f->tool_bar_window)
748 && w == XWINDOW (f->tool_bar_window))
749 y -= width;
751 BLOCK_INPUT;
752 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
753 0, y, width, height, False);
754 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
755 FRAME_PIXEL_WIDTH (f) - width,
756 y, width, height, False);
757 UNBLOCK_INPUT;
761 static void
762 x_draw_fringe_bitmap (w, row, p)
763 struct window *w;
764 struct glyph_row *row;
765 struct draw_fringe_bitmap_params *p;
767 struct frame *f = XFRAME (WINDOW_FRAME (w));
768 Display *display = FRAME_X_DISPLAY (f);
769 Window window = FRAME_X_WINDOW (f);
770 GC gc = f->output_data.x->normal_gc;
771 struct face *face = p->face;
772 int rowY;
774 /* Must clip because of partially visible lines. */
775 rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
776 if (p->y < rowY)
778 /* Adjust position of "bottom aligned" bitmap on partially
779 visible last row. */
780 int oldY = row->y;
781 int oldVH = row->visible_height;
782 row->visible_height = p->h;
783 row->y -= rowY - p->y;
784 x_clip_to_row (w, row, -1, gc);
785 row->y = oldY;
786 row->visible_height = oldVH;
788 else
789 x_clip_to_row (w, row, -1, gc);
791 if (!p->overlay_p)
793 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
795 /* In case the same realized face is used for fringes and
796 for something displayed in the text (e.g. face `region' on
797 mono-displays, the fill style may have been changed to
798 FillSolid in x_draw_glyph_string_background. */
799 if (face->stipple)
800 XSetFillStyle (display, face->gc, FillOpaqueStippled);
801 else
802 XSetForeground (display, face->gc, face->background);
804 #ifdef USE_TOOLKIT_SCROLL_BARS
805 /* If the fringe is adjacent to the left (right) scroll bar of a
806 leftmost (rightmost, respectively) window, then extend its
807 background to the gap between the fringe and the bar. */
808 if ((WINDOW_LEFTMOST_P (w)
809 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
810 || (WINDOW_RIGHTMOST_P (w)
811 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
813 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
815 if (sb_width > 0)
817 int left = WINDOW_SCROLL_BAR_AREA_X (w);
818 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
819 * FRAME_COLUMN_WIDTH (f));
821 if (bx < 0)
823 /* Bitmap fills the fringe. */
824 if (left + width == p->x)
825 bx = left + sb_width;
826 else if (p->x + p->wd == left)
827 bx = left;
828 if (bx >= 0)
830 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
832 nx = width - sb_width;
833 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
834 row->y));
835 ny = row->visible_height;
838 else
840 if (left + width == bx)
842 bx = left + sb_width;
843 nx += width - sb_width;
845 else if (bx + nx == left)
846 nx += width - sb_width;
850 #endif
851 if (bx >= 0 && nx > 0)
852 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
854 if (!face->stipple)
855 XSetForeground (display, face->gc, face->foreground);
858 if (p->which)
860 unsigned char *bits;
861 Pixmap pixmap, clipmask = (Pixmap) 0;
862 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
863 XGCValues gcv;
865 if (p->wd > 8)
866 bits = (unsigned char *)(p->bits + p->dh);
867 else
868 bits = (unsigned char *)p->bits + p->dh;
870 /* Draw the bitmap. I believe these small pixmaps can be cached
871 by the server. */
872 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
873 (p->cursor_p
874 ? (p->overlay_p ? face->background
875 : f->output_data.x->cursor_pixel)
876 : face->foreground),
877 face->background, depth);
879 if (p->overlay_p)
881 clipmask = XCreatePixmapFromBitmapData (display,
882 FRAME_X_DISPLAY_INFO (f)->root_window,
883 bits, p->wd, p->h,
884 1, 0, 1);
885 gcv.clip_mask = clipmask;
886 gcv.clip_x_origin = p->x;
887 gcv.clip_y_origin = p->y;
888 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
891 XCopyArea (display, pixmap, window, gc, 0, 0,
892 p->wd, p->h, p->x, p->y);
893 XFreePixmap (display, pixmap);
895 if (p->overlay_p)
897 gcv.clip_mask = (Pixmap) 0;
898 XChangeGC (display, gc, GCClipMask, &gcv);
899 XFreePixmap (display, clipmask);
903 XSetClipMask (display, gc, None);
908 /* This is called when starting Emacs and when restarting after
909 suspend. When starting Emacs, no X window is mapped. And nothing
910 must be done to Emacs's own window if it is suspended (though that
911 rarely happens). */
913 static void
914 XTset_terminal_modes (struct terminal *terminal)
918 /* This is called when exiting or suspending Emacs. Exiting will make
919 the X-windows go away, and suspending requires no action. */
921 static void
922 XTreset_terminal_modes (struct terminal *terminal)
927 /***********************************************************************
928 Glyph display
929 ***********************************************************************/
933 static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
934 static void x_set_glyph_string_gc P_ ((struct glyph_string *));
935 static void x_draw_glyph_string_background P_ ((struct glyph_string *,
936 int));
937 static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
938 static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
939 static void x_draw_glyph_string_box P_ ((struct glyph_string *));
940 static void x_draw_glyph_string P_ ((struct glyph_string *));
941 static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
942 static void x_set_cursor_gc P_ ((struct glyph_string *));
943 static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
944 static void x_set_mouse_face_gc P_ ((struct glyph_string *));
945 static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
946 unsigned long *, double, int));
947 static void x_setup_relief_color P_ ((struct frame *, struct relief *,
948 double, int, unsigned long));
949 static void x_setup_relief_colors P_ ((struct glyph_string *));
950 static void x_draw_image_glyph_string P_ ((struct glyph_string *));
951 static void x_draw_image_relief P_ ((struct glyph_string *));
952 static void x_draw_image_foreground P_ ((struct glyph_string *));
953 static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
954 static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
955 int, int, int));
956 static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
957 int, int, int, int, int, int,
958 XRectangle *));
959 static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
960 int, int, int, XRectangle *));
962 #if GLYPH_DEBUG
963 static void x_check_font P_ ((struct frame *, struct font *));
964 #endif
967 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
968 face. */
970 static void
971 x_set_cursor_gc (s)
972 struct glyph_string *s;
974 if (s->font == FRAME_FONT (s->f)
975 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
976 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
977 && !s->cmp)
978 s->gc = s->f->output_data.x->cursor_gc;
979 else
981 /* Cursor on non-default face: must merge. */
982 XGCValues xgcv;
983 unsigned long mask;
985 xgcv.background = s->f->output_data.x->cursor_pixel;
986 xgcv.foreground = s->face->background;
988 /* If the glyph would be invisible, try a different foreground. */
989 if (xgcv.foreground == xgcv.background)
990 xgcv.foreground = s->face->foreground;
991 if (xgcv.foreground == xgcv.background)
992 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
993 if (xgcv.foreground == xgcv.background)
994 xgcv.foreground = s->face->foreground;
996 /* Make sure the cursor is distinct from text in this face. */
997 if (xgcv.background == s->face->background
998 && xgcv.foreground == s->face->foreground)
1000 xgcv.background = s->face->foreground;
1001 xgcv.foreground = s->face->background;
1004 IF_DEBUG (x_check_font (s->f, s->font));
1005 xgcv.graphics_exposures = False;
1006 mask = GCForeground | GCBackground | GCGraphicsExposures;
1008 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1009 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1010 mask, &xgcv);
1011 else
1012 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1013 = XCreateGC (s->display, s->window, mask, &xgcv);
1015 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1020 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1022 static void
1023 x_set_mouse_face_gc (s)
1024 struct glyph_string *s;
1026 int face_id;
1027 struct face *face;
1029 /* What face has to be used last for the mouse face? */
1030 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1031 face = FACE_FROM_ID (s->f, face_id);
1032 if (face == NULL)
1033 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1035 if (s->first_glyph->type == CHAR_GLYPH)
1036 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1037 else
1038 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1039 s->face = FACE_FROM_ID (s->f, face_id);
1040 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1042 if (s->font == s->face->font)
1043 s->gc = s->face->gc;
1044 else
1046 /* Otherwise construct scratch_cursor_gc with values from FACE
1047 except for FONT. */
1048 XGCValues xgcv;
1049 unsigned long mask;
1051 xgcv.background = s->face->background;
1052 xgcv.foreground = s->face->foreground;
1053 xgcv.graphics_exposures = False;
1054 mask = GCForeground | GCBackground | GCGraphicsExposures;
1056 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1057 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1058 mask, &xgcv);
1059 else
1060 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1061 = XCreateGC (s->display, s->window, mask, &xgcv);
1063 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1066 xassert (s->gc != 0);
1070 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1071 Faces to use in the mode line have already been computed when the
1072 matrix was built, so there isn't much to do, here. */
1074 static INLINE void
1075 x_set_mode_line_face_gc (s)
1076 struct glyph_string *s;
1078 s->gc = s->face->gc;
1082 /* Set S->gc of glyph string S for drawing that glyph string. Set
1083 S->stippled_p to a non-zero value if the face of S has a stipple
1084 pattern. */
1086 static INLINE void
1087 x_set_glyph_string_gc (s)
1088 struct glyph_string *s;
1090 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1092 if (s->hl == DRAW_NORMAL_TEXT)
1094 s->gc = s->face->gc;
1095 s->stippled_p = s->face->stipple != 0;
1097 else if (s->hl == DRAW_INVERSE_VIDEO)
1099 x_set_mode_line_face_gc (s);
1100 s->stippled_p = s->face->stipple != 0;
1102 else if (s->hl == DRAW_CURSOR)
1104 x_set_cursor_gc (s);
1105 s->stippled_p = 0;
1107 else if (s->hl == DRAW_MOUSE_FACE)
1109 x_set_mouse_face_gc (s);
1110 s->stippled_p = s->face->stipple != 0;
1112 else if (s->hl == DRAW_IMAGE_RAISED
1113 || s->hl == DRAW_IMAGE_SUNKEN)
1115 s->gc = s->face->gc;
1116 s->stippled_p = s->face->stipple != 0;
1118 else
1120 s->gc = s->face->gc;
1121 s->stippled_p = s->face->stipple != 0;
1124 /* GC must have been set. */
1125 xassert (s->gc != 0);
1129 /* Set clipping for output of glyph string S. S may be part of a mode
1130 line or menu if we don't have X toolkit support. */
1132 static INLINE void
1133 x_set_glyph_string_clipping (s)
1134 struct glyph_string *s;
1136 XRectangle *r = s->clip;
1137 int n = get_glyph_string_clip_rects (s, r, 2);
1139 if (n > 0)
1140 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1141 s->num_clips = n;
1145 /* Set SRC's clipping for output of glyph string DST. This is called
1146 when we are drawing DST's left_overhang or right_overhang only in
1147 the area of SRC. */
1149 static void
1150 x_set_glyph_string_clipping_exactly (src, dst)
1151 struct glyph_string *src, *dst;
1153 XRectangle r;
1155 r.x = src->x;
1156 r.width = src->width;
1157 r.y = src->y;
1158 r.height = src->height;
1159 dst->clip[0] = r;
1160 dst->num_clips = 1;
1161 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1165 /* RIF:
1166 Compute left and right overhang of glyph string S. */
1168 static void
1169 x_compute_glyph_string_overhangs (s)
1170 struct glyph_string *s;
1172 if (s->cmp == NULL
1173 && s->first_glyph->type == CHAR_GLYPH)
1175 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1176 struct font *font = s->font;
1177 struct font_metrics metrics;
1178 int i;
1180 for (i = 0; i < s->nchars; i++)
1181 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1182 font->driver->text_extents (font, code, s->nchars, &metrics);
1183 s->right_overhang = (metrics.rbearing > metrics.width
1184 ? metrics.rbearing - metrics.width : 0);
1185 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1187 else if (s->cmp)
1189 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1190 s->left_overhang = - s->cmp->lbearing;
1195 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1197 static INLINE void
1198 x_clear_glyph_string_rect (s, x, y, w, h)
1199 struct glyph_string *s;
1200 int x, y, w, h;
1202 XGCValues xgcv;
1203 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1204 XSetForeground (s->display, s->gc, xgcv.background);
1205 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1206 XSetForeground (s->display, s->gc, xgcv.foreground);
1210 /* Draw the background of glyph_string S. If S->background_filled_p
1211 is non-zero don't draw it. FORCE_P non-zero means draw the
1212 background even if it wouldn't be drawn normally. This is used
1213 when a string preceding S draws into the background of S, or S
1214 contains the first component of a composition. */
1216 static void
1217 x_draw_glyph_string_background (s, force_p)
1218 struct glyph_string *s;
1219 int force_p;
1221 /* Nothing to do if background has already been drawn or if it
1222 shouldn't be drawn in the first place. */
1223 if (!s->background_filled_p)
1225 int box_line_width = max (s->face->box_line_width, 0);
1227 if (s->stippled_p)
1229 /* Fill background with a stipple pattern. */
1230 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1231 XFillRectangle (s->display, s->window, s->gc, s->x,
1232 s->y + box_line_width,
1233 s->background_width,
1234 s->height - 2 * box_line_width);
1235 XSetFillStyle (s->display, s->gc, FillSolid);
1236 s->background_filled_p = 1;
1238 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1239 || s->font_not_found_p
1240 || s->extends_to_end_of_line_p
1241 || force_p)
1243 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1244 s->background_width,
1245 s->height - 2 * box_line_width);
1246 s->background_filled_p = 1;
1252 /* Draw the foreground of glyph string S. */
1254 static void
1255 x_draw_glyph_string_foreground (s)
1256 struct glyph_string *s;
1258 int i, x;
1260 /* If first glyph of S has a left box line, start drawing the text
1261 of S to the right of that box line. */
1262 if (s->face->box != FACE_NO_BOX
1263 && s->first_glyph->left_box_line_p)
1264 x = s->x + eabs (s->face->box_line_width);
1265 else
1266 x = s->x;
1268 /* Draw characters of S as rectangles if S's font could not be
1269 loaded. */
1270 if (s->font_not_found_p)
1272 for (i = 0; i < s->nchars; ++i)
1274 struct glyph *g = s->first_glyph + i;
1275 XDrawRectangle (s->display, s->window,
1276 s->gc, x, s->y, g->pixel_width - 1,
1277 s->height - 1);
1278 x += g->pixel_width;
1281 else
1283 struct font *font = s->font;
1284 int boff = font->baseline_offset;
1285 int y;
1287 if (font->vertical_centering)
1288 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1290 y = s->ybase - boff;
1291 if (s->for_overlaps
1292 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1293 font->driver->draw (s, 0, s->nchars, x, y, 0);
1294 else
1295 font->driver->draw (s, 0, s->nchars, x, y, 1);
1296 if (s->face->overstrike)
1297 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1301 /* Draw the foreground of composite glyph string S. */
1303 static void
1304 x_draw_composite_glyph_string_foreground (s)
1305 struct glyph_string *s;
1307 int i, j, x;
1309 /* If first glyph of S has a left box line, start drawing the text
1310 of S to the right of that box line. */
1311 if (s->face && s->face->box != FACE_NO_BOX
1312 && s->first_glyph->left_box_line_p)
1313 x = s->x + eabs (s->face->box_line_width);
1314 else
1315 x = s->x;
1317 /* S is a glyph string for a composition. S->gidx is the index of
1318 the first character drawn for glyphs of this composition.
1319 S->gidx == 0 means we are drawing the very first character of
1320 this composition. */
1322 /* Draw a rectangle for the composition if the font for the very
1323 first character of the composition could not be loaded. */
1324 if (s->font_not_found_p)
1326 if (s->gidx == 0)
1327 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1328 s->width - 1, s->height - 1);
1330 else
1332 struct font *font = s->font;
1333 int y = s->ybase;
1334 int width = 0;
1336 if (s->cmp->method == COMPOSITION_WITH_GLYPH_STRING)
1338 Lisp_Object gstring = AREF (XHASH_TABLE (composition_hash_table)
1339 ->key_and_value,
1340 s->cmp->hash_index * 2);
1341 int from;
1343 for (i = from = 0; i < s->nchars; i++)
1345 Lisp_Object g = LGSTRING_GLYPH (gstring, i);
1346 Lisp_Object adjustment = LGLYPH_ADJUSTMENT (g);
1347 int xoff, yoff, wadjust;
1349 if (! VECTORP (adjustment))
1351 width += LGLYPH_WIDTH (g);
1352 continue;
1354 if (from < i)
1356 font->driver->draw (s, from, i, x, y, 0);
1357 x += width;
1359 xoff = XINT (AREF (adjustment, 0));
1360 yoff = XINT (AREF (adjustment, 1));
1361 wadjust = XINT (AREF (adjustment, 2));
1363 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1364 x += wadjust;
1365 from = i + 1;
1366 width = 0;
1368 if (from < i)
1369 font->driver->draw (s, from, i, x, y, 0);
1371 else
1373 for (i = 0, j = s->gidx; i < s->nchars; i++, j++)
1374 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1376 int xx = x + s->cmp->offsets[j * 2];
1377 int yy = y - s->cmp->offsets[j * 2 + 1];
1379 font->driver->draw (s, j, j + 1, xx, yy, 0);
1380 if (s->face->overstrike)
1381 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1388 #ifdef USE_X_TOOLKIT
1390 static struct frame *x_frame_of_widget P_ ((Widget));
1391 static Boolean cvt_string_to_pixel P_ ((Display *, XrmValue *, Cardinal *,
1392 XrmValue *, XrmValue *, XtPointer *));
1393 static void cvt_pixel_dtor P_ ((XtAppContext, XrmValue *, XtPointer,
1394 XrmValue *, Cardinal *));
1397 /* Return the frame on which widget WIDGET is used.. Abort if frame
1398 cannot be determined. */
1400 static struct frame *
1401 x_frame_of_widget (widget)
1402 Widget widget;
1404 struct x_display_info *dpyinfo;
1405 Lisp_Object tail;
1406 struct frame *f;
1408 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1410 /* Find the top-level shell of the widget. Note that this function
1411 can be called when the widget is not yet realized, so XtWindow
1412 (widget) == 0. That's the reason we can't simply use
1413 x_any_window_to_frame. */
1414 while (!XtIsTopLevelShell (widget))
1415 widget = XtParent (widget);
1417 /* Look for a frame with that top-level widget. Allocate the color
1418 on that frame to get the right gamma correction value. */
1419 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1420 if (FRAMEP (XCAR (tail))
1421 && (f = XFRAME (XCAR (tail)),
1422 (FRAME_X_P (f)
1423 && f->output_data.nothing != 1
1424 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1425 && f->output_data.x->widget == widget)
1426 return f;
1428 abort ();
1432 /* Allocate the color COLOR->pixel on the screen and display of
1433 widget WIDGET in colormap CMAP. If an exact match cannot be
1434 allocated, try the nearest color available. Value is non-zero
1435 if successful. This is called from lwlib. */
1438 x_alloc_nearest_color_for_widget (widget, cmap, color)
1439 Widget widget;
1440 Colormap cmap;
1441 XColor *color;
1443 struct frame *f = x_frame_of_widget (widget);
1444 return x_alloc_nearest_color (f, cmap, color);
1448 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1449 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1450 If this produces the same color as PIXEL, try a color where all RGB
1451 values have DELTA added. Return the allocated color in *PIXEL.
1452 DISPLAY is the X display, CMAP is the colormap to operate on.
1453 Value is non-zero if successful. */
1456 x_alloc_lighter_color_for_widget (widget, display, cmap, pixel, factor, delta)
1457 Widget widget;
1458 Display *display;
1459 Colormap cmap;
1460 unsigned long *pixel;
1461 double factor;
1462 int delta;
1464 struct frame *f = x_frame_of_widget (widget);
1465 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1469 /* Structure specifying which arguments should be passed by Xt to
1470 cvt_string_to_pixel. We want the widget's screen and colormap. */
1472 static XtConvertArgRec cvt_string_to_pixel_args[] =
1474 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1475 sizeof (Screen *)},
1476 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1477 sizeof (Colormap)}
1481 /* The address of this variable is returned by
1482 cvt_string_to_pixel. */
1484 static Pixel cvt_string_to_pixel_value;
1487 /* Convert a color name to a pixel color.
1489 DPY is the display we are working on.
1491 ARGS is an array of *NARGS XrmValue structures holding additional
1492 information about the widget for which the conversion takes place.
1493 The contents of this array are determined by the specification
1494 in cvt_string_to_pixel_args.
1496 FROM is a pointer to an XrmValue which points to the color name to
1497 convert. TO is an XrmValue in which to return the pixel color.
1499 CLOSURE_RET is a pointer to user-data, in which we record if
1500 we allocated the color or not.
1502 Value is True if successful, False otherwise. */
1504 static Boolean
1505 cvt_string_to_pixel (dpy, args, nargs, from, to, closure_ret)
1506 Display *dpy;
1507 XrmValue *args;
1508 Cardinal *nargs;
1509 XrmValue *from, *to;
1510 XtPointer *closure_ret;
1512 Screen *screen;
1513 Colormap cmap;
1514 Pixel pixel;
1515 String color_name;
1516 XColor color;
1518 if (*nargs != 2)
1520 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1521 "wrongParameters", "cvt_string_to_pixel",
1522 "XtToolkitError",
1523 "Screen and colormap args required", NULL, NULL);
1524 return False;
1527 screen = *(Screen **) args[0].addr;
1528 cmap = *(Colormap *) args[1].addr;
1529 color_name = (String) from->addr;
1531 if (strcmp (color_name, XtDefaultBackground) == 0)
1533 *closure_ret = (XtPointer) False;
1534 pixel = WhitePixelOfScreen (screen);
1536 else if (strcmp (color_name, XtDefaultForeground) == 0)
1538 *closure_ret = (XtPointer) False;
1539 pixel = BlackPixelOfScreen (screen);
1541 else if (XParseColor (dpy, cmap, color_name, &color)
1542 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1544 pixel = color.pixel;
1545 *closure_ret = (XtPointer) True;
1547 else
1549 String params[1];
1550 Cardinal nparams = 1;
1552 params[0] = color_name;
1553 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1554 "badValue", "cvt_string_to_pixel",
1555 "XtToolkitError", "Invalid color `%s'",
1556 params, &nparams);
1557 return False;
1560 if (to->addr != NULL)
1562 if (to->size < sizeof (Pixel))
1564 to->size = sizeof (Pixel);
1565 return False;
1568 *(Pixel *) to->addr = pixel;
1570 else
1572 cvt_string_to_pixel_value = pixel;
1573 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1576 to->size = sizeof (Pixel);
1577 return True;
1581 /* Free a pixel color which was previously allocated via
1582 cvt_string_to_pixel. This is registered as the destructor
1583 for this type of resource via XtSetTypeConverter.
1585 APP is the application context in which we work.
1587 TO is a pointer to an XrmValue holding the color to free.
1588 CLOSURE is the value we stored in CLOSURE_RET for this color
1589 in cvt_string_to_pixel.
1591 ARGS and NARGS are like for cvt_string_to_pixel. */
1593 static void
1594 cvt_pixel_dtor (app, to, closure, args, nargs)
1595 XtAppContext app;
1596 XrmValuePtr to;
1597 XtPointer closure;
1598 XrmValuePtr args;
1599 Cardinal *nargs;
1601 if (*nargs != 2)
1603 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1604 "XtToolkitError",
1605 "Screen and colormap arguments required",
1606 NULL, NULL);
1608 else if (closure != NULL)
1610 /* We did allocate the pixel, so free it. */
1611 Screen *screen = *(Screen **) args[0].addr;
1612 Colormap cmap = *(Colormap *) args[1].addr;
1613 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1614 (Pixel *) to->addr, 1);
1619 #endif /* USE_X_TOOLKIT */
1622 /* Value is an array of XColor structures for the contents of the
1623 color map of display DPY. Set *NCELLS to the size of the array.
1624 Note that this probably shouldn't be called for large color maps,
1625 say a 24-bit TrueColor map. */
1627 static const XColor *
1628 x_color_cells (dpy, ncells)
1629 Display *dpy;
1630 int *ncells;
1632 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1634 if (dpyinfo->color_cells == NULL)
1636 Screen *screen = dpyinfo->screen;
1637 int i;
1639 dpyinfo->ncolor_cells
1640 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1641 dpyinfo->color_cells
1642 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1643 * sizeof *dpyinfo->color_cells);
1645 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1646 dpyinfo->color_cells[i].pixel = i;
1648 XQueryColors (dpy, dpyinfo->cmap,
1649 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1652 *ncells = dpyinfo->ncolor_cells;
1653 return dpyinfo->color_cells;
1657 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1658 colors in COLORS. Use cached information, if available. */
1660 void
1661 x_query_colors (f, colors, ncolors)
1662 struct frame *f;
1663 XColor *colors;
1664 int ncolors;
1666 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1668 if (dpyinfo->color_cells)
1670 int i;
1671 for (i = 0; i < ncolors; ++i)
1673 unsigned long pixel = colors[i].pixel;
1674 xassert (pixel < dpyinfo->ncolor_cells);
1675 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1676 colors[i] = dpyinfo->color_cells[pixel];
1679 else
1680 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1684 /* On frame F, translate pixel color to RGB values for the color in
1685 COLOR. Use cached information, if available. */
1687 void
1688 x_query_color (f, color)
1689 struct frame *f;
1690 XColor *color;
1692 x_query_colors (f, color, 1);
1696 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1697 exact match can't be allocated, try the nearest color available.
1698 Value is non-zero if successful. Set *COLOR to the color
1699 allocated. */
1701 static int
1702 x_alloc_nearest_color_1 (dpy, cmap, color)
1703 Display *dpy;
1704 Colormap cmap;
1705 XColor *color;
1707 int rc;
1709 rc = XAllocColor (dpy, cmap, color);
1710 if (rc == 0)
1712 /* If we got to this point, the colormap is full, so we're going
1713 to try to get the next closest color. The algorithm used is
1714 a least-squares matching, which is what X uses for closest
1715 color matching with StaticColor visuals. */
1716 int nearest, i;
1717 unsigned long nearest_delta = ~0;
1718 int ncells;
1719 const XColor *cells = x_color_cells (dpy, &ncells);
1721 for (nearest = i = 0; i < ncells; ++i)
1723 long dred = (color->red >> 8) - (cells[i].red >> 8);
1724 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1725 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1726 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1728 if (delta < nearest_delta)
1730 nearest = i;
1731 nearest_delta = delta;
1735 color->red = cells[nearest].red;
1736 color->green = cells[nearest].green;
1737 color->blue = cells[nearest].blue;
1738 rc = XAllocColor (dpy, cmap, color);
1740 else
1742 /* If allocation succeeded, and the allocated pixel color is not
1743 equal to a cached pixel color recorded earlier, there was a
1744 change in the colormap, so clear the color cache. */
1745 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1746 XColor *cached_color;
1748 if (dpyinfo->color_cells
1749 && (cached_color = &dpyinfo->color_cells[color->pixel],
1750 (cached_color->red != color->red
1751 || cached_color->blue != color->blue
1752 || cached_color->green != color->green)))
1754 xfree (dpyinfo->color_cells);
1755 dpyinfo->color_cells = NULL;
1756 dpyinfo->ncolor_cells = 0;
1760 #ifdef DEBUG_X_COLORS
1761 if (rc)
1762 register_color (color->pixel);
1763 #endif /* DEBUG_X_COLORS */
1765 return rc;
1769 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1770 exact match can't be allocated, try the nearest color available.
1771 Value is non-zero if successful. Set *COLOR to the color
1772 allocated. */
1775 x_alloc_nearest_color (f, cmap, color)
1776 struct frame *f;
1777 Colormap cmap;
1778 XColor *color;
1780 gamma_correct (f, color);
1781 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1785 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1786 It's necessary to do this instead of just using PIXEL directly to
1787 get color reference counts right. */
1789 unsigned long
1790 x_copy_color (f, pixel)
1791 struct frame *f;
1792 unsigned long pixel;
1794 XColor color;
1796 color.pixel = pixel;
1797 BLOCK_INPUT;
1798 x_query_color (f, &color);
1799 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1800 UNBLOCK_INPUT;
1801 #ifdef DEBUG_X_COLORS
1802 register_color (pixel);
1803 #endif
1804 return color.pixel;
1808 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1809 It's necessary to do this instead of just using PIXEL directly to
1810 get color reference counts right. */
1812 unsigned long
1813 x_copy_dpy_color (dpy, cmap, pixel)
1814 Display *dpy;
1815 Colormap cmap;
1816 unsigned long pixel;
1818 XColor color;
1820 color.pixel = pixel;
1821 BLOCK_INPUT;
1822 XQueryColor (dpy, cmap, &color);
1823 XAllocColor (dpy, cmap, &color);
1824 UNBLOCK_INPUT;
1825 #ifdef DEBUG_X_COLORS
1826 register_color (pixel);
1827 #endif
1828 return color.pixel;
1832 /* Brightness beyond which a color won't have its highlight brightness
1833 boosted.
1835 Nominally, highlight colors for `3d' faces are calculated by
1836 brightening an object's color by a constant scale factor, but this
1837 doesn't yield good results for dark colors, so for colors who's
1838 brightness is less than this value (on a scale of 0-65535) have an
1839 use an additional additive factor.
1841 The value here is set so that the default menu-bar/mode-line color
1842 (grey75) will not have its highlights changed at all. */
1843 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1846 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1847 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1848 If this produces the same color as PIXEL, try a color where all RGB
1849 values have DELTA added. Return the allocated color in *PIXEL.
1850 DISPLAY is the X display, CMAP is the colormap to operate on.
1851 Value is non-zero if successful. */
1853 static int
1854 x_alloc_lighter_color (f, display, cmap, pixel, factor, delta)
1855 struct frame *f;
1856 Display *display;
1857 Colormap cmap;
1858 unsigned long *pixel;
1859 double factor;
1860 int delta;
1862 XColor color, new;
1863 long bright;
1864 int success_p;
1866 /* Get RGB color values. */
1867 color.pixel = *pixel;
1868 x_query_color (f, &color);
1870 /* Change RGB values by specified FACTOR. Avoid overflow! */
1871 xassert (factor >= 0);
1872 new.red = min (0xffff, factor * color.red);
1873 new.green = min (0xffff, factor * color.green);
1874 new.blue = min (0xffff, factor * color.blue);
1876 /* Calculate brightness of COLOR. */
1877 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1879 /* We only boost colors that are darker than
1880 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1881 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1882 /* Make an additive adjustment to NEW, because it's dark enough so
1883 that scaling by FACTOR alone isn't enough. */
1885 /* How far below the limit this color is (0 - 1, 1 being darker). */
1886 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1887 /* The additive adjustment. */
1888 int min_delta = delta * dimness * factor / 2;
1890 if (factor < 1)
1892 new.red = max (0, new.red - min_delta);
1893 new.green = max (0, new.green - min_delta);
1894 new.blue = max (0, new.blue - min_delta);
1896 else
1898 new.red = min (0xffff, min_delta + new.red);
1899 new.green = min (0xffff, min_delta + new.green);
1900 new.blue = min (0xffff, min_delta + new.blue);
1904 /* Try to allocate the color. */
1905 success_p = x_alloc_nearest_color (f, cmap, &new);
1906 if (success_p)
1908 if (new.pixel == *pixel)
1910 /* If we end up with the same color as before, try adding
1911 delta to the RGB values. */
1912 x_free_colors (f, &new.pixel, 1);
1914 new.red = min (0xffff, delta + color.red);
1915 new.green = min (0xffff, delta + color.green);
1916 new.blue = min (0xffff, delta + color.blue);
1917 success_p = x_alloc_nearest_color (f, cmap, &new);
1919 else
1920 success_p = 1;
1921 *pixel = new.pixel;
1924 return success_p;
1928 /* Set up the foreground color for drawing relief lines of glyph
1929 string S. RELIEF is a pointer to a struct relief containing the GC
1930 with which lines will be drawn. Use a color that is FACTOR or
1931 DELTA lighter or darker than the relief's background which is found
1932 in S->f->output_data.x->relief_background. If such a color cannot
1933 be allocated, use DEFAULT_PIXEL, instead. */
1935 static void
1936 x_setup_relief_color (f, relief, factor, delta, default_pixel)
1937 struct frame *f;
1938 struct relief *relief;
1939 double factor;
1940 int delta;
1941 unsigned long default_pixel;
1943 XGCValues xgcv;
1944 struct x_output *di = f->output_data.x;
1945 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1946 unsigned long pixel;
1947 unsigned long background = di->relief_background;
1948 Colormap cmap = FRAME_X_COLORMAP (f);
1949 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1950 Display *dpy = FRAME_X_DISPLAY (f);
1952 xgcv.graphics_exposures = False;
1953 xgcv.line_width = 1;
1955 /* Free previously allocated color. The color cell will be reused
1956 when it has been freed as many times as it was allocated, so this
1957 doesn't affect faces using the same colors. */
1958 if (relief->gc
1959 && relief->allocated_p)
1961 x_free_colors (f, &relief->pixel, 1);
1962 relief->allocated_p = 0;
1965 /* Allocate new color. */
1966 xgcv.foreground = default_pixel;
1967 pixel = background;
1968 if (dpyinfo->n_planes != 1
1969 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1971 relief->allocated_p = 1;
1972 xgcv.foreground = relief->pixel = pixel;
1975 if (relief->gc == 0)
1977 xgcv.stipple = dpyinfo->gray;
1978 mask |= GCStipple;
1979 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1981 else
1982 XChangeGC (dpy, relief->gc, mask, &xgcv);
1986 /* Set up colors for the relief lines around glyph string S. */
1988 static void
1989 x_setup_relief_colors (s)
1990 struct glyph_string *s;
1992 struct x_output *di = s->f->output_data.x;
1993 unsigned long color;
1995 if (s->face->use_box_color_for_shadows_p)
1996 color = s->face->box_color;
1997 else if (s->first_glyph->type == IMAGE_GLYPH
1998 && s->img->pixmap
1999 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2000 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2001 else
2003 XGCValues xgcv;
2005 /* Get the background color of the face. */
2006 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2007 color = xgcv.background;
2010 if (di->white_relief.gc == 0
2011 || color != di->relief_background)
2013 di->relief_background = color;
2014 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2015 WHITE_PIX_DEFAULT (s->f));
2016 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2017 BLACK_PIX_DEFAULT (s->f));
2022 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2023 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2024 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2025 relief. LEFT_P non-zero means draw a relief on the left side of
2026 the rectangle. RIGHT_P non-zero means draw a relief on the right
2027 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2028 when drawing. */
2030 static void
2031 x_draw_relief_rect (f, left_x, top_y, right_x, bottom_y, width,
2032 raised_p, top_p, bot_p, left_p, right_p, clip_rect)
2033 struct frame *f;
2034 int left_x, top_y, right_x, bottom_y, width;
2035 int top_p, bot_p, left_p, right_p, raised_p;
2036 XRectangle *clip_rect;
2038 Display *dpy = FRAME_X_DISPLAY (f);
2039 Window window = FRAME_X_WINDOW (f);
2040 int i;
2041 GC gc;
2043 if (raised_p)
2044 gc = f->output_data.x->white_relief.gc;
2045 else
2046 gc = f->output_data.x->black_relief.gc;
2047 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2049 /* Top. */
2050 if (top_p)
2051 for (i = 0; i < width; ++i)
2052 XDrawLine (dpy, window, gc,
2053 left_x + i * left_p, top_y + i,
2054 right_x + 1 - i * right_p, top_y + i);
2056 /* Left. */
2057 if (left_p)
2058 for (i = 0; i < width; ++i)
2059 XDrawLine (dpy, window, gc,
2060 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2062 XSetClipMask (dpy, gc, None);
2063 if (raised_p)
2064 gc = f->output_data.x->black_relief.gc;
2065 else
2066 gc = f->output_data.x->white_relief.gc;
2067 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2069 /* Bottom. */
2070 if (bot_p)
2071 for (i = 0; i < width; ++i)
2072 XDrawLine (dpy, window, gc,
2073 left_x + i * left_p, bottom_y - i,
2074 right_x + 1 - i * right_p, bottom_y - i);
2076 /* Right. */
2077 if (right_p)
2078 for (i = 0; i < width; ++i)
2079 XDrawLine (dpy, window, gc,
2080 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2082 XSetClipMask (dpy, gc, None);
2086 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2087 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2088 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2089 left side of the rectangle. RIGHT_P non-zero means draw a line
2090 on the right side of the rectangle. CLIP_RECT is the clipping
2091 rectangle to use when drawing. */
2093 static void
2094 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2095 left_p, right_p, clip_rect)
2096 struct glyph_string *s;
2097 int left_x, top_y, right_x, bottom_y, width, left_p, right_p;
2098 XRectangle *clip_rect;
2100 XGCValues xgcv;
2102 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2103 XSetForeground (s->display, s->gc, s->face->box_color);
2104 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2106 /* Top. */
2107 XFillRectangle (s->display, s->window, s->gc,
2108 left_x, top_y, right_x - left_x + 1, width);
2110 /* Left. */
2111 if (left_p)
2112 XFillRectangle (s->display, s->window, s->gc,
2113 left_x, top_y, width, bottom_y - top_y + 1);
2115 /* Bottom. */
2116 XFillRectangle (s->display, s->window, s->gc,
2117 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2119 /* Right. */
2120 if (right_p)
2121 XFillRectangle (s->display, s->window, s->gc,
2122 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2124 XSetForeground (s->display, s->gc, xgcv.foreground);
2125 XSetClipMask (s->display, s->gc, None);
2129 /* Draw a box around glyph string S. */
2131 static void
2132 x_draw_glyph_string_box (s)
2133 struct glyph_string *s;
2135 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2136 int left_p, right_p;
2137 struct glyph *last_glyph;
2138 XRectangle clip_rect;
2140 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2141 ? WINDOW_RIGHT_EDGE_X (s->w)
2142 : window_box_right (s->w, s->area));
2144 /* The glyph that may have a right box line. */
2145 last_glyph = (s->cmp || s->img
2146 ? s->first_glyph
2147 : s->first_glyph + s->nchars - 1);
2149 width = eabs (s->face->box_line_width);
2150 raised_p = s->face->box == FACE_RAISED_BOX;
2151 left_x = s->x;
2152 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2153 ? last_x - 1
2154 : min (last_x, s->x + s->background_width) - 1);
2155 top_y = s->y;
2156 bottom_y = top_y + s->height - 1;
2158 left_p = (s->first_glyph->left_box_line_p
2159 || (s->hl == DRAW_MOUSE_FACE
2160 && (s->prev == NULL
2161 || s->prev->hl != s->hl)));
2162 right_p = (last_glyph->right_box_line_p
2163 || (s->hl == DRAW_MOUSE_FACE
2164 && (s->next == NULL
2165 || s->next->hl != s->hl)));
2167 get_glyph_string_clip_rect (s, &clip_rect);
2169 if (s->face->box == FACE_SIMPLE_BOX)
2170 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2171 left_p, right_p, &clip_rect);
2172 else
2174 x_setup_relief_colors (s);
2175 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2176 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2181 /* Draw foreground of image glyph string S. */
2183 static void
2184 x_draw_image_foreground (s)
2185 struct glyph_string *s;
2187 int x = s->x;
2188 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2190 /* If first glyph of S has a left box line, start drawing it to the
2191 right of that line. */
2192 if (s->face->box != FACE_NO_BOX
2193 && s->first_glyph->left_box_line_p
2194 && s->slice.x == 0)
2195 x += eabs (s->face->box_line_width);
2197 /* If there is a margin around the image, adjust x- and y-position
2198 by that margin. */
2199 if (s->slice.x == 0)
2200 x += s->img->hmargin;
2201 if (s->slice.y == 0)
2202 y += s->img->vmargin;
2204 if (s->img->pixmap)
2206 if (s->img->mask)
2208 /* We can't set both a clip mask and use XSetClipRectangles
2209 because the latter also sets a clip mask. We also can't
2210 trust on the shape extension to be available
2211 (XShapeCombineRegion). So, compute the rectangle to draw
2212 manually. */
2213 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2214 | GCFunction);
2215 XGCValues xgcv;
2216 XRectangle clip_rect, image_rect, r;
2218 xgcv.clip_mask = s->img->mask;
2219 xgcv.clip_x_origin = x;
2220 xgcv.clip_y_origin = y;
2221 xgcv.function = GXcopy;
2222 XChangeGC (s->display, s->gc, mask, &xgcv);
2224 get_glyph_string_clip_rect (s, &clip_rect);
2225 image_rect.x = x;
2226 image_rect.y = y;
2227 image_rect.width = s->slice.width;
2228 image_rect.height = s->slice.height;
2229 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2230 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2231 s->slice.x + r.x - x, s->slice.y + r.y - y,
2232 r.width, r.height, r.x, r.y);
2234 else
2236 XRectangle clip_rect, image_rect, r;
2238 get_glyph_string_clip_rect (s, &clip_rect);
2239 image_rect.x = x;
2240 image_rect.y = y;
2241 image_rect.width = s->slice.width;
2242 image_rect.height = s->slice.height;
2243 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2244 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2245 s->slice.x + r.x - x, s->slice.y + r.y - y,
2246 r.width, r.height, r.x, r.y);
2248 /* When the image has a mask, we can expect that at
2249 least part of a mouse highlight or a block cursor will
2250 be visible. If the image doesn't have a mask, make
2251 a block cursor visible by drawing a rectangle around
2252 the image. I believe it's looking better if we do
2253 nothing here for mouse-face. */
2254 if (s->hl == DRAW_CURSOR)
2256 int r = s->img->relief;
2257 if (r < 0) r = -r;
2258 XDrawRectangle (s->display, s->window, s->gc,
2259 x - r, y - r,
2260 s->slice.width + r*2 - 1,
2261 s->slice.height + r*2 - 1);
2265 else
2266 /* Draw a rectangle if image could not be loaded. */
2267 XDrawRectangle (s->display, s->window, s->gc, x, y,
2268 s->slice.width - 1, s->slice.height - 1);
2272 /* Draw a relief around the image glyph string S. */
2274 static void
2275 x_draw_image_relief (s)
2276 struct glyph_string *s;
2278 int x0, y0, x1, y1, thick, raised_p;
2279 XRectangle r;
2280 int x = s->x;
2281 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2283 /* If first glyph of S has a left box line, start drawing it to the
2284 right of that line. */
2285 if (s->face->box != FACE_NO_BOX
2286 && s->first_glyph->left_box_line_p
2287 && s->slice.x == 0)
2288 x += eabs (s->face->box_line_width);
2290 /* If there is a margin around the image, adjust x- and y-position
2291 by that margin. */
2292 if (s->slice.x == 0)
2293 x += s->img->hmargin;
2294 if (s->slice.y == 0)
2295 y += s->img->vmargin;
2297 if (s->hl == DRAW_IMAGE_SUNKEN
2298 || s->hl == DRAW_IMAGE_RAISED)
2300 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2301 raised_p = s->hl == DRAW_IMAGE_RAISED;
2303 else
2305 thick = eabs (s->img->relief);
2306 raised_p = s->img->relief > 0;
2309 x0 = x - thick;
2310 y0 = y - thick;
2311 x1 = x + s->slice.width + thick - 1;
2312 y1 = y + s->slice.height + thick - 1;
2314 x_setup_relief_colors (s);
2315 get_glyph_string_clip_rect (s, &r);
2316 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2317 s->slice.y == 0,
2318 s->slice.y + s->slice.height == s->img->height,
2319 s->slice.x == 0,
2320 s->slice.x + s->slice.width == s->img->width,
2321 &r);
2325 /* Draw the foreground of image glyph string S to PIXMAP. */
2327 static void
2328 x_draw_image_foreground_1 (s, pixmap)
2329 struct glyph_string *s;
2330 Pixmap pixmap;
2332 int x = 0;
2333 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2335 /* If first glyph of S has a left box line, start drawing it to the
2336 right of that line. */
2337 if (s->face->box != FACE_NO_BOX
2338 && s->first_glyph->left_box_line_p
2339 && s->slice.x == 0)
2340 x += eabs (s->face->box_line_width);
2342 /* If there is a margin around the image, adjust x- and y-position
2343 by that margin. */
2344 if (s->slice.x == 0)
2345 x += s->img->hmargin;
2346 if (s->slice.y == 0)
2347 y += s->img->vmargin;
2349 if (s->img->pixmap)
2351 if (s->img->mask)
2353 /* We can't set both a clip mask and use XSetClipRectangles
2354 because the latter also sets a clip mask. We also can't
2355 trust on the shape extension to be available
2356 (XShapeCombineRegion). So, compute the rectangle to draw
2357 manually. */
2358 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2359 | GCFunction);
2360 XGCValues xgcv;
2362 xgcv.clip_mask = s->img->mask;
2363 xgcv.clip_x_origin = x - s->slice.x;
2364 xgcv.clip_y_origin = y - s->slice.y;
2365 xgcv.function = GXcopy;
2366 XChangeGC (s->display, s->gc, mask, &xgcv);
2368 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2369 s->slice.x, s->slice.y,
2370 s->slice.width, s->slice.height, x, y);
2371 XSetClipMask (s->display, s->gc, None);
2373 else
2375 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2376 s->slice.x, s->slice.y,
2377 s->slice.width, s->slice.height, x, y);
2379 /* When the image has a mask, we can expect that at
2380 least part of a mouse highlight or a block cursor will
2381 be visible. If the image doesn't have a mask, make
2382 a block cursor visible by drawing a rectangle around
2383 the image. I believe it's looking better if we do
2384 nothing here for mouse-face. */
2385 if (s->hl == DRAW_CURSOR)
2387 int r = s->img->relief;
2388 if (r < 0) r = -r;
2389 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2390 s->slice.width + r*2 - 1,
2391 s->slice.height + r*2 - 1);
2395 else
2396 /* Draw a rectangle if image could not be loaded. */
2397 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2398 s->slice.width - 1, s->slice.height - 1);
2402 /* Draw part of the background of glyph string S. X, Y, W, and H
2403 give the rectangle to draw. */
2405 static void
2406 x_draw_glyph_string_bg_rect (s, x, y, w, h)
2407 struct glyph_string *s;
2408 int x, y, w, h;
2410 if (s->stippled_p)
2412 /* Fill background with a stipple pattern. */
2413 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2414 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2415 XSetFillStyle (s->display, s->gc, FillSolid);
2417 else
2418 x_clear_glyph_string_rect (s, x, y, w, h);
2422 /* Draw image glyph string S.
2424 s->y
2425 s->x +-------------------------
2426 | s->face->box
2428 | +-------------------------
2429 | | s->img->margin
2431 | | +-------------------
2432 | | | the image
2436 static void
2437 x_draw_image_glyph_string (s)
2438 struct glyph_string *s;
2440 int box_line_hwidth = eabs (s->face->box_line_width);
2441 int box_line_vwidth = max (s->face->box_line_width, 0);
2442 int height;
2443 Pixmap pixmap = None;
2445 height = s->height;
2446 if (s->slice.y == 0)
2447 height -= box_line_vwidth;
2448 if (s->slice.y + s->slice.height >= s->img->height)
2449 height -= box_line_vwidth;
2451 /* Fill background with face under the image. Do it only if row is
2452 taller than image or if image has a clip mask to reduce
2453 flickering. */
2454 s->stippled_p = s->face->stipple != 0;
2455 if (height > s->slice.height
2456 || s->img->hmargin
2457 || s->img->vmargin
2458 || s->img->mask
2459 || s->img->pixmap == 0
2460 || s->width != s->background_width)
2462 if (s->img->mask)
2464 /* Create a pixmap as large as the glyph string. Fill it
2465 with the background color. Copy the image to it, using
2466 its mask. Copy the temporary pixmap to the display. */
2467 Screen *screen = FRAME_X_SCREEN (s->f);
2468 int depth = DefaultDepthOfScreen (screen);
2470 /* Create a pixmap as large as the glyph string. */
2471 pixmap = XCreatePixmap (s->display, s->window,
2472 s->background_width,
2473 s->height, depth);
2475 /* Don't clip in the following because we're working on the
2476 pixmap. */
2477 XSetClipMask (s->display, s->gc, None);
2479 /* Fill the pixmap with the background color/stipple. */
2480 if (s->stippled_p)
2482 /* Fill background with a stipple pattern. */
2483 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2484 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2485 XFillRectangle (s->display, pixmap, s->gc,
2486 0, 0, s->background_width, s->height);
2487 XSetFillStyle (s->display, s->gc, FillSolid);
2488 XSetTSOrigin (s->display, s->gc, 0, 0);
2490 else
2492 XGCValues xgcv;
2493 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2494 &xgcv);
2495 XSetForeground (s->display, s->gc, xgcv.background);
2496 XFillRectangle (s->display, pixmap, s->gc,
2497 0, 0, s->background_width, s->height);
2498 XSetForeground (s->display, s->gc, xgcv.foreground);
2501 else
2503 int x = s->x;
2504 int y = s->y;
2506 if (s->first_glyph->left_box_line_p
2507 && s->slice.x == 0)
2508 x += box_line_hwidth;
2510 if (s->slice.y == 0)
2511 y += box_line_vwidth;
2513 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2516 s->background_filled_p = 1;
2519 /* Draw the foreground. */
2520 if (pixmap != None)
2522 x_draw_image_foreground_1 (s, pixmap);
2523 x_set_glyph_string_clipping (s);
2524 XCopyArea (s->display, pixmap, s->window, s->gc,
2525 0, 0, s->background_width, s->height, s->x, s->y);
2526 XFreePixmap (s->display, pixmap);
2528 else
2529 x_draw_image_foreground (s);
2531 /* If we must draw a relief around the image, do it. */
2532 if (s->img->relief
2533 || s->hl == DRAW_IMAGE_RAISED
2534 || s->hl == DRAW_IMAGE_SUNKEN)
2535 x_draw_image_relief (s);
2539 /* Draw stretch glyph string S. */
2541 static void
2542 x_draw_stretch_glyph_string (s)
2543 struct glyph_string *s;
2545 xassert (s->first_glyph->type == STRETCH_GLYPH);
2547 if (s->hl == DRAW_CURSOR
2548 && !x_stretch_cursor_p)
2550 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2551 as wide as the stretch glyph. */
2552 int width, background_width = s->background_width;
2553 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2555 if (x < left_x)
2557 background_width -= left_x - x;
2558 x = left_x;
2560 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2562 /* Draw cursor. */
2563 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2565 /* Clear rest using the GC of the original non-cursor face. */
2566 if (width < background_width)
2568 int y = s->y;
2569 int w = background_width - width, h = s->height;
2570 XRectangle r;
2571 GC gc;
2573 x += width;
2574 if (s->row->mouse_face_p
2575 && cursor_in_mouse_face_p (s->w))
2577 x_set_mouse_face_gc (s);
2578 gc = s->gc;
2580 else
2581 gc = s->face->gc;
2583 get_glyph_string_clip_rect (s, &r);
2584 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2586 if (s->face->stipple)
2588 /* Fill background with a stipple pattern. */
2589 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2590 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2591 XSetFillStyle (s->display, gc, FillSolid);
2593 else
2595 XGCValues xgcv;
2596 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2597 XSetForeground (s->display, gc, xgcv.background);
2598 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2599 XSetForeground (s->display, gc, xgcv.foreground);
2603 else if (!s->background_filled_p)
2605 int background_width = s->background_width;
2606 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2608 /* Don't draw into left margin, fringe or scrollbar area
2609 except for header line and mode line. */
2610 if (x < left_x && !s->row->mode_line_p)
2612 background_width -= left_x - x;
2613 x = left_x;
2615 if (background_width > 0)
2616 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2619 s->background_filled_p = 1;
2623 /* Draw glyph string S. */
2625 static void
2626 x_draw_glyph_string (s)
2627 struct glyph_string *s;
2629 int relief_drawn_p = 0;
2631 /* If S draws into the background of its successors, draw the
2632 background of the successors first so that S can draw into it.
2633 This makes S->next use XDrawString instead of XDrawImageString. */
2634 if (s->next && s->right_overhang && !s->for_overlaps)
2636 int width;
2637 struct glyph_string *next;
2639 for (width = 0, next = s->next; next;
2640 width += next->width, next = next->next)
2641 if (next->first_glyph->type != IMAGE_GLYPH)
2643 x_set_glyph_string_gc (next);
2644 x_set_glyph_string_clipping (next);
2645 x_draw_glyph_string_background (next, 1);
2646 next->num_clips = 0;
2650 /* Set up S->gc, set clipping and draw S. */
2651 x_set_glyph_string_gc (s);
2653 /* Draw relief (if any) in advance for char/composition so that the
2654 glyph string can be drawn over it. */
2655 if (!s->for_overlaps
2656 && s->face->box != FACE_NO_BOX
2657 && (s->first_glyph->type == CHAR_GLYPH
2658 || s->first_glyph->type == COMPOSITE_GLYPH))
2661 x_set_glyph_string_clipping (s);
2662 x_draw_glyph_string_background (s, 1);
2663 x_draw_glyph_string_box (s);
2664 x_set_glyph_string_clipping (s);
2665 relief_drawn_p = 1;
2667 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2668 && !s->clip_tail
2669 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2670 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2671 /* We must clip just this glyph. left_overhang part has already
2672 drawn when s->prev was drawn, and right_overhang part will be
2673 drawn later when s->next is drawn. */
2674 x_set_glyph_string_clipping_exactly (s, s);
2675 else
2676 x_set_glyph_string_clipping (s);
2678 switch (s->first_glyph->type)
2680 case IMAGE_GLYPH:
2681 x_draw_image_glyph_string (s);
2682 break;
2684 case STRETCH_GLYPH:
2685 x_draw_stretch_glyph_string (s);
2686 break;
2688 case CHAR_GLYPH:
2689 if (s->for_overlaps)
2690 s->background_filled_p = 1;
2691 else
2692 x_draw_glyph_string_background (s, 0);
2693 x_draw_glyph_string_foreground (s);
2694 break;
2696 case COMPOSITE_GLYPH:
2697 if (s->for_overlaps || s->gidx > 0)
2698 s->background_filled_p = 1;
2699 else
2700 x_draw_glyph_string_background (s, 1);
2701 x_draw_composite_glyph_string_foreground (s);
2702 break;
2704 default:
2705 abort ();
2708 if (!s->for_overlaps)
2710 /* Draw underline. */
2711 if (s->face->underline_p)
2713 unsigned long thickness, position;
2714 int y;
2716 if (s->prev && s->prev->face->underline_p)
2718 /* We use the same underline style as the previous one. */
2719 thickness = s->prev->underline_thickness;
2720 position = s->prev->underline_position;
2722 else
2724 /* Get the underline thickness. Default is 1 pixel. */
2725 if (s->font && s->font->underline_thickness > 0)
2726 thickness = s->font->underline_thickness;
2727 else
2728 thickness = 1;
2729 if (x_underline_at_descent_line)
2730 position = (s->height - thickness) - (s->ybase - s->y);
2731 else
2733 /* Get the underline position. This is the recommended
2734 vertical offset in pixels from the baseline to the top of
2735 the underline. This is a signed value according to the
2736 specs, and its default is
2738 ROUND ((maximum descent) / 2), with
2739 ROUND(x) = floor (x + 0.5) */
2741 if (x_use_underline_position_properties
2742 && s->font && s->font->underline_position >= 0)
2743 position = s->font->underline_position;
2744 else if (s->font)
2745 position = (s->font->descent + 1) / 2;
2748 /* Check the sanity of thickness and position. We should
2749 avoid drawing underline out of the current line area. */
2750 if (s->y + s->height <= s->ybase + position)
2751 position = (s->height - 1) - (s->ybase - s->y);
2752 if (s->y + s->height < s->ybase + position + thickness)
2753 thickness = (s->y + s->height) - (s->ybase + position);
2754 s->underline_thickness = thickness;
2755 s->underline_position = position;
2756 y = s->ybase + position;
2757 if (s->face->underline_defaulted_p)
2758 XFillRectangle (s->display, s->window, s->gc,
2759 s->x, y, s->background_width, thickness);
2760 else
2762 XGCValues xgcv;
2763 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2764 XSetForeground (s->display, s->gc, s->face->underline_color);
2765 XFillRectangle (s->display, s->window, s->gc,
2766 s->x, y, s->background_width, thickness);
2767 XSetForeground (s->display, s->gc, xgcv.foreground);
2771 /* Draw overline. */
2772 if (s->face->overline_p)
2774 unsigned long dy = 0, h = 1;
2776 if (s->face->overline_color_defaulted_p)
2777 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2778 s->background_width, h);
2779 else
2781 XGCValues xgcv;
2782 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2783 XSetForeground (s->display, s->gc, s->face->overline_color);
2784 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2785 s->background_width, h);
2786 XSetForeground (s->display, s->gc, xgcv.foreground);
2790 /* Draw strike-through. */
2791 if (s->face->strike_through_p)
2793 unsigned long h = 1;
2794 unsigned long dy = (s->height - h) / 2;
2796 if (s->face->strike_through_color_defaulted_p)
2797 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2798 s->width, h);
2799 else
2801 XGCValues xgcv;
2802 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2803 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2804 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2805 s->width, h);
2806 XSetForeground (s->display, s->gc, xgcv.foreground);
2810 /* Draw relief if not yet drawn. */
2811 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2812 x_draw_glyph_string_box (s);
2814 if (s->prev)
2816 struct glyph_string *prev;
2818 for (prev = s->prev; prev; prev = prev->prev)
2819 if (prev->hl != s->hl
2820 && prev->x + prev->width + prev->right_overhang > s->x)
2822 /* As prev was drawn while clipped to its own area, we
2823 must draw the right_overhang part using s->hl now. */
2824 enum draw_glyphs_face save = prev->hl;
2826 prev->hl = s->hl;
2827 x_set_glyph_string_gc (prev);
2828 x_set_glyph_string_clipping_exactly (s, prev);
2829 if (prev->first_glyph->type == CHAR_GLYPH)
2830 x_draw_glyph_string_foreground (prev);
2831 else
2832 x_draw_composite_glyph_string_foreground (prev);
2833 XSetClipMask (prev->display, prev->gc, None);
2834 prev->hl = save;
2835 prev->num_clips = 0;
2839 if (s->next)
2841 struct glyph_string *next;
2843 for (next = s->next; next; next = next->next)
2844 if (next->hl != s->hl
2845 && next->x - next->left_overhang < s->x + s->width)
2847 /* As next will be drawn while clipped to its own area,
2848 we must draw the left_overhang part using s->hl now. */
2849 enum draw_glyphs_face save = next->hl;
2851 next->hl = s->hl;
2852 x_set_glyph_string_gc (next);
2853 x_set_glyph_string_clipping_exactly (s, next);
2854 if (next->first_glyph->type == CHAR_GLYPH)
2855 x_draw_glyph_string_foreground (next);
2856 else
2857 x_draw_composite_glyph_string_foreground (next);
2858 XSetClipMask (next->display, next->gc, None);
2859 next->hl = save;
2860 next->num_clips = 0;
2865 /* Reset clipping. */
2866 XSetClipMask (s->display, s->gc, None);
2867 s->num_clips = 0;
2870 /* Shift display to make room for inserted glyphs. */
2872 void
2873 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2874 struct frame *f;
2875 int x, y, width, height, shift_by;
2877 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2878 f->output_data.x->normal_gc,
2879 x, y, width, height,
2880 x + shift_by, y);
2883 /* Delete N glyphs at the nominal cursor position. Not implemented
2884 for X frames. */
2886 static void
2887 x_delete_glyphs (f, n)
2888 struct frame *f;
2889 register int n;
2891 abort ();
2895 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2896 If they are <= 0, this is probably an error. */
2898 void
2899 x_clear_area (dpy, window, x, y, width, height, exposures)
2900 Display *dpy;
2901 Window window;
2902 int x, y;
2903 int width, height;
2904 int exposures;
2906 xassert (width > 0 && height > 0);
2907 XClearArea (dpy, window, x, y, width, height, exposures);
2911 /* Clear an entire frame. */
2913 static void
2914 x_clear_frame (struct frame *f)
2916 /* Clearing the frame will erase any cursor, so mark them all as no
2917 longer visible. */
2918 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2919 output_cursor.hpos = output_cursor.vpos = 0;
2920 output_cursor.x = -1;
2922 /* We don't set the output cursor here because there will always
2923 follow an explicit cursor_to. */
2924 BLOCK_INPUT;
2925 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2927 /* We have to clear the scroll bars, too. If we have changed
2928 colors or something like that, then they should be notified. */
2929 x_scroll_bar_clear (f);
2931 XFlush (FRAME_X_DISPLAY (f));
2933 UNBLOCK_INPUT;
2938 /* Invert the middle quarter of the frame for .15 sec. */
2940 /* We use the select system call to do the waiting, so we have to make
2941 sure it's available. If it isn't, we just won't do visual bells. */
2943 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2946 /* Subtract the `struct timeval' values X and Y, storing the result in
2947 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2949 static int
2950 timeval_subtract (result, x, y)
2951 struct timeval *result, x, y;
2953 /* Perform the carry for the later subtraction by updating y. This
2954 is safer because on some systems the tv_sec member is unsigned. */
2955 if (x.tv_usec < y.tv_usec)
2957 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2958 y.tv_usec -= 1000000 * nsec;
2959 y.tv_sec += nsec;
2962 if (x.tv_usec - y.tv_usec > 1000000)
2964 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2965 y.tv_usec += 1000000 * nsec;
2966 y.tv_sec -= nsec;
2969 /* Compute the time remaining to wait. tv_usec is certainly
2970 positive. */
2971 result->tv_sec = x.tv_sec - y.tv_sec;
2972 result->tv_usec = x.tv_usec - y.tv_usec;
2974 /* Return indication of whether the result should be considered
2975 negative. */
2976 return x.tv_sec < y.tv_sec;
2979 void
2980 XTflash (f)
2981 struct frame *f;
2983 BLOCK_INPUT;
2986 GC gc;
2988 /* Create a GC that will use the GXxor function to flip foreground
2989 pixels into background pixels. */
2991 XGCValues values;
2993 values.function = GXxor;
2994 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
2995 ^ FRAME_BACKGROUND_PIXEL (f));
2997 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2998 GCFunction | GCForeground, &values);
3002 /* Get the height not including a menu bar widget. */
3003 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3004 /* Height of each line to flash. */
3005 int flash_height = FRAME_LINE_HEIGHT (f);
3006 /* These will be the left and right margins of the rectangles. */
3007 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3008 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3010 int width;
3012 /* Don't flash the area between a scroll bar and the frame
3013 edge it is next to. */
3014 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3016 case vertical_scroll_bar_left:
3017 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3018 break;
3020 case vertical_scroll_bar_right:
3021 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3022 break;
3024 default:
3025 break;
3028 width = flash_right - flash_left;
3030 /* If window is tall, flash top and bottom line. */
3031 if (height > 3 * FRAME_LINE_HEIGHT (f))
3033 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3034 flash_left,
3035 (FRAME_INTERNAL_BORDER_WIDTH (f)
3036 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3037 width, flash_height);
3038 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3039 flash_left,
3040 (height - flash_height
3041 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3042 width, flash_height);
3044 else
3045 /* If it is short, flash it all. */
3046 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3047 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3048 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3050 x_flush (f);
3053 struct timeval wakeup;
3055 EMACS_GET_TIME (wakeup);
3057 /* Compute time to wait until, propagating carry from usecs. */
3058 wakeup.tv_usec += 150000;
3059 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3060 wakeup.tv_usec %= 1000000;
3062 /* Keep waiting until past the time wakeup or any input gets
3063 available. */
3064 while (! detect_input_pending ())
3066 struct timeval current;
3067 struct timeval timeout;
3069 EMACS_GET_TIME (current);
3071 /* Break if result would be negative. */
3072 if (timeval_subtract (&current, wakeup, current))
3073 break;
3075 /* How long `select' should wait. */
3076 timeout.tv_sec = 0;
3077 timeout.tv_usec = 10000;
3079 /* Try to wait that long--but we might wake up sooner. */
3080 select (0, NULL, NULL, NULL, &timeout);
3084 /* If window is tall, flash top and bottom line. */
3085 if (height > 3 * FRAME_LINE_HEIGHT (f))
3087 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3088 flash_left,
3089 (FRAME_INTERNAL_BORDER_WIDTH (f)
3090 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3091 width, flash_height);
3092 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3093 flash_left,
3094 (height - flash_height
3095 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3096 width, flash_height);
3098 else
3099 /* If it is short, flash it all. */
3100 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3101 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3102 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3104 XFreeGC (FRAME_X_DISPLAY (f), gc);
3105 x_flush (f);
3109 UNBLOCK_INPUT;
3112 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3115 /* Make audible bell. */
3117 void
3118 XTring_bell ()
3120 struct frame *f = SELECTED_FRAME ();
3122 if (FRAME_X_DISPLAY (f))
3124 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3125 if (visible_bell)
3126 XTflash (f);
3127 else
3128 #endif
3130 BLOCK_INPUT;
3131 XBell (FRAME_X_DISPLAY (f), 0);
3132 XFlush (FRAME_X_DISPLAY (f));
3133 UNBLOCK_INPUT;
3139 /* Specify how many text lines, from the top of the window,
3140 should be affected by insert-lines and delete-lines operations.
3141 This, and those operations, are used only within an update
3142 that is bounded by calls to x_update_begin and x_update_end. */
3144 static void
3145 XTset_terminal_window (n)
3146 register int n;
3148 /* This function intentionally left blank. */
3153 /***********************************************************************
3154 Line Dance
3155 ***********************************************************************/
3157 /* Perform an insert-lines or delete-lines operation, inserting N
3158 lines or deleting -N lines at vertical position VPOS. */
3160 static void
3161 x_ins_del_lines (f, vpos, n)
3162 struct frame *f;
3163 int vpos, n;
3165 abort ();
3169 /* Scroll part of the display as described by RUN. */
3171 static void
3172 x_scroll_run (w, run)
3173 struct window *w;
3174 struct run *run;
3176 struct frame *f = XFRAME (w->frame);
3177 int x, y, width, height, from_y, to_y, bottom_y;
3179 /* Get frame-relative bounding box of the text display area of W,
3180 without mode lines. Include in this box the left and right
3181 fringe of W. */
3182 window_box (w, -1, &x, &y, &width, &height);
3184 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3185 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3186 bottom_y = y + height;
3188 if (to_y < from_y)
3190 /* Scrolling up. Make sure we don't copy part of the mode
3191 line at the bottom. */
3192 if (from_y + run->height > bottom_y)
3193 height = bottom_y - from_y;
3194 else
3195 height = run->height;
3197 else
3199 /* Scolling down. Make sure we don't copy over the mode line.
3200 at the bottom. */
3201 if (to_y + run->height > bottom_y)
3202 height = bottom_y - to_y;
3203 else
3204 height = run->height;
3207 BLOCK_INPUT;
3209 /* Cursor off. Will be switched on again in x_update_window_end. */
3210 updated_window = w;
3211 x_clear_cursor (w);
3213 XCopyArea (FRAME_X_DISPLAY (f),
3214 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3215 f->output_data.x->normal_gc,
3216 x, from_y,
3217 width, height,
3218 x, to_y);
3220 UNBLOCK_INPUT;
3225 /***********************************************************************
3226 Exposure Events
3227 ***********************************************************************/
3230 static void
3231 frame_highlight (f)
3232 struct frame *f;
3234 /* We used to only do this if Vx_no_window_manager was non-nil, but
3235 the ICCCM (section 4.1.6) says that the window's border pixmap
3236 and border pixel are window attributes which are "private to the
3237 client", so we can always change it to whatever we want. */
3238 BLOCK_INPUT;
3239 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3240 f->output_data.x->border_pixel);
3241 UNBLOCK_INPUT;
3242 x_update_cursor (f, 1);
3243 x_set_frame_alpha (f);
3246 static void
3247 frame_unhighlight (f)
3248 struct frame *f;
3250 /* We used to only do this if Vx_no_window_manager was non-nil, but
3251 the ICCCM (section 4.1.6) says that the window's border pixmap
3252 and border pixel are window attributes which are "private to the
3253 client", so we can always change it to whatever we want. */
3254 BLOCK_INPUT;
3255 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3256 f->output_data.x->border_tile);
3257 UNBLOCK_INPUT;
3258 x_update_cursor (f, 1);
3259 x_set_frame_alpha (f);
3262 /* The focus has changed. Update the frames as necessary to reflect
3263 the new situation. Note that we can't change the selected frame
3264 here, because the Lisp code we are interrupting might become confused.
3265 Each event gets marked with the frame in which it occurred, so the
3266 Lisp code can tell when the switch took place by examining the events. */
3268 static void
3269 x_new_focus_frame (dpyinfo, frame)
3270 struct x_display_info *dpyinfo;
3271 struct frame *frame;
3273 struct frame *old_focus = dpyinfo->x_focus_frame;
3275 if (frame != dpyinfo->x_focus_frame)
3277 /* Set this before calling other routines, so that they see
3278 the correct value of x_focus_frame. */
3279 dpyinfo->x_focus_frame = frame;
3281 if (old_focus && old_focus->auto_lower)
3282 x_lower_frame (old_focus);
3284 #if 0
3285 selected_frame = frame;
3286 XSETFRAME (XWINDOW (selected_frame->selected_window)->frame,
3287 selected_frame);
3288 Fselect_window (selected_frame->selected_window, Qnil);
3289 choose_minibuf_frame ();
3290 #endif /* ! 0 */
3292 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3293 pending_autoraise_frame = dpyinfo->x_focus_frame;
3294 else
3295 pending_autoraise_frame = 0;
3298 x_frame_rehighlight (dpyinfo);
3301 /* Handle FocusIn and FocusOut state changes for FRAME.
3302 If FRAME has focus and there exists more than one frame, puts
3303 a FOCUS_IN_EVENT into *BUFP. */
3305 static void
3306 x_focus_changed (type, state, dpyinfo, frame, bufp)
3307 int type;
3308 int state;
3309 struct x_display_info *dpyinfo;
3310 struct frame *frame;
3311 struct input_event *bufp;
3313 if (type == FocusIn)
3315 if (dpyinfo->x_focus_event_frame != frame)
3317 x_new_focus_frame (dpyinfo, frame);
3318 dpyinfo->x_focus_event_frame = frame;
3320 /* Don't stop displaying the initial startup message
3321 for a switch-frame event we don't need. */
3322 if (NILP (Vterminal_frame)
3323 && CONSP (Vframe_list)
3324 && !NILP (XCDR (Vframe_list)))
3326 bufp->kind = FOCUS_IN_EVENT;
3327 XSETFRAME (bufp->frame_or_window, frame);
3331 frame->output_data.x->focus_state |= state;
3333 #ifdef HAVE_X_I18N
3334 if (FRAME_XIC (frame))
3335 XSetICFocus (FRAME_XIC (frame));
3336 #endif
3338 else if (type == FocusOut)
3340 frame->output_data.x->focus_state &= ~state;
3342 if (dpyinfo->x_focus_event_frame == frame)
3344 dpyinfo->x_focus_event_frame = 0;
3345 x_new_focus_frame (dpyinfo, 0);
3348 #ifdef HAVE_X_I18N
3349 if (FRAME_XIC (frame))
3350 XUnsetICFocus (FRAME_XIC (frame));
3351 #endif
3355 /* The focus may have changed. Figure out if it is a real focus change,
3356 by checking both FocusIn/Out and Enter/LeaveNotify events.
3358 Returns FOCUS_IN_EVENT event in *BUFP. */
3360 static void
3361 x_detect_focus_change (dpyinfo, event, bufp)
3362 struct x_display_info *dpyinfo;
3363 XEvent *event;
3364 struct input_event *bufp;
3366 struct frame *frame;
3368 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3369 if (! frame)
3370 return;
3372 switch (event->type)
3374 case EnterNotify:
3375 case LeaveNotify:
3377 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3378 int focus_state
3379 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3381 if (event->xcrossing.detail != NotifyInferior
3382 && event->xcrossing.focus
3383 && ! (focus_state & FOCUS_EXPLICIT))
3384 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3385 FOCUS_IMPLICIT,
3386 dpyinfo, frame, bufp);
3388 break;
3390 case FocusIn:
3391 case FocusOut:
3392 x_focus_changed (event->type,
3393 (event->xfocus.detail == NotifyPointer ?
3394 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3395 dpyinfo, frame, bufp);
3396 break;
3398 case ClientMessage:
3399 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3401 enum xembed_message msg = event->xclient.data.l[1];
3402 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3403 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3405 break;
3410 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3412 void
3413 x_mouse_leave (dpyinfo)
3414 struct x_display_info *dpyinfo;
3416 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3419 /* The focus has changed, or we have redirected a frame's focus to
3420 another frame (this happens when a frame uses a surrogate
3421 mini-buffer frame). Shift the highlight as appropriate.
3423 The FRAME argument doesn't necessarily have anything to do with which
3424 frame is being highlighted or un-highlighted; we only use it to find
3425 the appropriate X display info. */
3427 static void
3428 XTframe_rehighlight (frame)
3429 struct frame *frame;
3431 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3434 static void
3435 x_frame_rehighlight (dpyinfo)
3436 struct x_display_info *dpyinfo;
3438 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3440 if (dpyinfo->x_focus_frame)
3442 dpyinfo->x_highlight_frame
3443 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3444 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3445 : dpyinfo->x_focus_frame);
3446 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3448 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3449 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3452 else
3453 dpyinfo->x_highlight_frame = 0;
3455 if (dpyinfo->x_highlight_frame != old_highlight)
3457 if (old_highlight)
3458 frame_unhighlight (old_highlight);
3459 if (dpyinfo->x_highlight_frame)
3460 frame_highlight (dpyinfo->x_highlight_frame);
3466 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3468 /* Initialize mode_switch_bit and modifier_meaning. */
3469 static void
3470 x_find_modifier_meanings (dpyinfo)
3471 struct x_display_info *dpyinfo;
3473 int min_code, max_code;
3474 KeySym *syms;
3475 int syms_per_code;
3476 XModifierKeymap *mods;
3478 dpyinfo->meta_mod_mask = 0;
3479 dpyinfo->shift_lock_mask = 0;
3480 dpyinfo->alt_mod_mask = 0;
3481 dpyinfo->super_mod_mask = 0;
3482 dpyinfo->hyper_mod_mask = 0;
3484 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3486 syms = XGetKeyboardMapping (dpyinfo->display,
3487 min_code, max_code - min_code + 1,
3488 &syms_per_code);
3489 mods = XGetModifierMapping (dpyinfo->display);
3491 /* Scan the modifier table to see which modifier bits the Meta and
3492 Alt keysyms are on. */
3494 int row, col; /* The row and column in the modifier table. */
3495 int found_alt_or_meta;
3497 for (row = 3; row < 8; row++)
3499 found_alt_or_meta = 0;
3500 for (col = 0; col < mods->max_keypermod; col++)
3502 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3504 /* Zeroes are used for filler. Skip them. */
3505 if (code == 0)
3506 continue;
3508 /* Are any of this keycode's keysyms a meta key? */
3510 int code_col;
3512 for (code_col = 0; code_col < syms_per_code; code_col++)
3514 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3516 switch (sym)
3518 case XK_Meta_L:
3519 case XK_Meta_R:
3520 found_alt_or_meta = 1;
3521 dpyinfo->meta_mod_mask |= (1 << row);
3522 break;
3524 case XK_Alt_L:
3525 case XK_Alt_R:
3526 found_alt_or_meta = 1;
3527 dpyinfo->alt_mod_mask |= (1 << row);
3528 break;
3530 case XK_Hyper_L:
3531 case XK_Hyper_R:
3532 if (!found_alt_or_meta)
3533 dpyinfo->hyper_mod_mask |= (1 << row);
3534 code_col = syms_per_code;
3535 col = mods->max_keypermod;
3536 break;
3538 case XK_Super_L:
3539 case XK_Super_R:
3540 if (!found_alt_or_meta)
3541 dpyinfo->super_mod_mask |= (1 << row);
3542 code_col = syms_per_code;
3543 col = mods->max_keypermod;
3544 break;
3546 case XK_Shift_Lock:
3547 /* Ignore this if it's not on the lock modifier. */
3548 if (!found_alt_or_meta && ((1 << row) == LockMask))
3549 dpyinfo->shift_lock_mask = LockMask;
3550 code_col = syms_per_code;
3551 col = mods->max_keypermod;
3552 break;
3560 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3561 if (! dpyinfo->meta_mod_mask)
3563 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3564 dpyinfo->alt_mod_mask = 0;
3567 /* If some keys are both alt and meta,
3568 make them just meta, not alt. */
3569 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3571 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3574 XFree ((char *) syms);
3575 XFreeModifiermap (mods);
3578 /* Convert between the modifier bits X uses and the modifier bits
3579 Emacs uses. */
3581 unsigned int
3582 x_x_to_emacs_modifiers (dpyinfo, state)
3583 struct x_display_info *dpyinfo;
3584 unsigned int state;
3586 EMACS_UINT mod_meta = meta_modifier;
3587 EMACS_UINT mod_alt = alt_modifier;
3588 EMACS_UINT mod_hyper = hyper_modifier;
3589 EMACS_UINT mod_super = super_modifier;
3590 Lisp_Object tem;
3592 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3593 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3594 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3595 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3596 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3597 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3598 tem = Fget (Vx_super_keysym, Qmodifier_value);
3599 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3602 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3603 | ((state & ControlMask) ? ctrl_modifier : 0)
3604 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3605 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3606 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3607 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3610 static unsigned int
3611 x_emacs_to_x_modifiers (dpyinfo, state)
3612 struct x_display_info *dpyinfo;
3613 unsigned int state;
3615 EMACS_UINT mod_meta = meta_modifier;
3616 EMACS_UINT mod_alt = alt_modifier;
3617 EMACS_UINT mod_hyper = hyper_modifier;
3618 EMACS_UINT mod_super = super_modifier;
3620 Lisp_Object tem;
3622 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3623 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3624 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3625 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3626 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3627 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3628 tem = Fget (Vx_super_keysym, Qmodifier_value);
3629 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3632 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3633 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3634 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3635 | ((state & shift_modifier) ? ShiftMask : 0)
3636 | ((state & ctrl_modifier) ? ControlMask : 0)
3637 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3640 /* Convert a keysym to its name. */
3642 char *
3643 x_get_keysym_name (keysym)
3644 KeySym keysym;
3646 char *value;
3648 BLOCK_INPUT;
3649 value = XKeysymToString (keysym);
3650 UNBLOCK_INPUT;
3652 return value;
3657 /* Mouse clicks and mouse movement. Rah. */
3659 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3661 If the event is a button press, then note that we have grabbed
3662 the mouse. */
3664 static Lisp_Object
3665 construct_mouse_click (result, event, f)
3666 struct input_event *result;
3667 XButtonEvent *event;
3668 struct frame *f;
3670 /* Make the event type NO_EVENT; we'll change that when we decide
3671 otherwise. */
3672 result->kind = MOUSE_CLICK_EVENT;
3673 result->code = event->button - Button1;
3674 result->timestamp = event->time;
3675 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3676 event->state)
3677 | (event->type == ButtonRelease
3678 ? up_modifier
3679 : down_modifier));
3681 XSETINT (result->x, event->x);
3682 XSETINT (result->y, event->y);
3683 XSETFRAME (result->frame_or_window, f);
3684 result->arg = Qnil;
3685 return Qnil;
3689 /* Function to report a mouse movement to the mainstream Emacs code.
3690 The input handler calls this.
3692 We have received a mouse movement event, which is given in *event.
3693 If the mouse is over a different glyph than it was last time, tell
3694 the mainstream emacs code by setting mouse_moved. If not, ask for
3695 another motion event, so we can check again the next time it moves. */
3697 static XMotionEvent last_mouse_motion_event;
3698 static Lisp_Object last_mouse_motion_frame;
3700 static int
3701 note_mouse_movement (frame, event)
3702 FRAME_PTR frame;
3703 XMotionEvent *event;
3705 last_mouse_movement_time = event->time;
3706 last_mouse_motion_event = *event;
3707 XSETFRAME (last_mouse_motion_frame, frame);
3709 if (!FRAME_X_OUTPUT (frame))
3710 return 0;
3712 if (event->window != FRAME_X_WINDOW (frame))
3714 frame->mouse_moved = 1;
3715 last_mouse_scroll_bar = Qnil;
3716 note_mouse_highlight (frame, -1, -1);
3717 last_mouse_glyph_frame = 0;
3718 return 1;
3722 /* Has the mouse moved off the glyph it was on at the last sighting? */
3723 if (frame != last_mouse_glyph_frame
3724 || event->x < last_mouse_glyph.x
3725 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3726 || event->y < last_mouse_glyph.y
3727 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3729 frame->mouse_moved = 1;
3730 last_mouse_scroll_bar = Qnil;
3731 note_mouse_highlight (frame, event->x, event->y);
3732 /* Remember which glyph we're now on. */
3733 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3734 last_mouse_glyph_frame = frame;
3735 return 1;
3738 return 0;
3742 /************************************************************************
3743 Mouse Face
3744 ************************************************************************/
3746 static void
3747 redo_mouse_highlight ()
3749 if (!NILP (last_mouse_motion_frame)
3750 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3751 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3752 last_mouse_motion_event.x,
3753 last_mouse_motion_event.y);
3758 /* Return the current position of the mouse.
3759 *FP should be a frame which indicates which display to ask about.
3761 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3762 and *PART to the frame, window, and scroll bar part that the mouse
3763 is over. Set *X and *Y to the portion and whole of the mouse's
3764 position on the scroll bar.
3766 If the mouse movement started elsewhere, set *FP to the frame the
3767 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3768 the mouse is over.
3770 Set *TIME to the server time-stamp for the time at which the mouse
3771 was at this position.
3773 Don't store anything if we don't have a valid set of values to report.
3775 This clears the mouse_moved flag, so we can wait for the next mouse
3776 movement. */
3778 static void
3779 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3780 FRAME_PTR *fp;
3781 int insist;
3782 Lisp_Object *bar_window;
3783 enum scroll_bar_part *part;
3784 Lisp_Object *x, *y;
3785 unsigned long *time;
3787 FRAME_PTR f1;
3789 BLOCK_INPUT;
3791 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3792 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3793 else
3795 Window root;
3796 int root_x, root_y;
3798 Window dummy_window;
3799 int dummy;
3801 Lisp_Object frame, tail;
3803 /* Clear the mouse-moved flag for every frame on this display. */
3804 FOR_EACH_FRAME (tail, frame)
3805 if (FRAME_X_P (XFRAME (frame))
3806 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3807 XFRAME (frame)->mouse_moved = 0;
3809 last_mouse_scroll_bar = Qnil;
3811 /* Figure out which root window we're on. */
3812 XQueryPointer (FRAME_X_DISPLAY (*fp),
3813 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3815 /* The root window which contains the pointer. */
3816 &root,
3818 /* Trash which we can't trust if the pointer is on
3819 a different screen. */
3820 &dummy_window,
3822 /* The position on that root window. */
3823 &root_x, &root_y,
3825 /* More trash we can't trust. */
3826 &dummy, &dummy,
3828 /* Modifier keys and pointer buttons, about which
3829 we don't care. */
3830 (unsigned int *) &dummy);
3832 /* Now we have a position on the root; find the innermost window
3833 containing the pointer. */
3835 Window win, child;
3836 int win_x, win_y;
3837 int parent_x = 0, parent_y = 0;
3839 win = root;
3841 /* XTranslateCoordinates can get errors if the window
3842 structure is changing at the same time this function
3843 is running. So at least we must not crash from them. */
3845 x_catch_errors (FRAME_X_DISPLAY (*fp));
3847 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3848 && FRAME_LIVE_P (last_mouse_frame))
3850 /* If mouse was grabbed on a frame, give coords for that frame
3851 even if the mouse is now outside it. */
3852 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3854 /* From-window, to-window. */
3855 root, FRAME_X_WINDOW (last_mouse_frame),
3857 /* From-position, to-position. */
3858 root_x, root_y, &win_x, &win_y,
3860 /* Child of win. */
3861 &child);
3862 f1 = last_mouse_frame;
3864 else
3866 while (1)
3868 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3870 /* From-window, to-window. */
3871 root, win,
3873 /* From-position, to-position. */
3874 root_x, root_y, &win_x, &win_y,
3876 /* Child of win. */
3877 &child);
3879 if (child == None || child == win)
3880 break;
3882 win = child;
3883 parent_x = win_x;
3884 parent_y = win_y;
3887 /* Now we know that:
3888 win is the innermost window containing the pointer
3889 (XTC says it has no child containing the pointer),
3890 win_x and win_y are the pointer's position in it
3891 (XTC did this the last time through), and
3892 parent_x and parent_y are the pointer's position in win's parent.
3893 (They are what win_x and win_y were when win was child.
3894 If win is the root window, it has no parent, and
3895 parent_{x,y} are invalid, but that's okay, because we'll
3896 never use them in that case.) */
3898 /* Is win one of our frames? */
3899 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3901 #ifdef USE_X_TOOLKIT
3902 /* If we end up with the menu bar window, say it's not
3903 on the frame. */
3904 if (f1 != NULL
3905 && f1->output_data.x->menubar_widget
3906 && win == XtWindow (f1->output_data.x->menubar_widget))
3907 f1 = NULL;
3908 #endif /* USE_X_TOOLKIT */
3911 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3912 f1 = 0;
3914 x_uncatch_errors ();
3916 /* If not, is it one of our scroll bars? */
3917 if (! f1)
3919 struct scroll_bar *bar;
3921 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3923 if (bar)
3925 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3926 win_x = parent_x;
3927 win_y = parent_y;
3931 if (f1 == 0 && insist > 0)
3932 f1 = SELECTED_FRAME ();
3934 if (f1)
3936 /* Ok, we found a frame. Store all the values.
3937 last_mouse_glyph is a rectangle used to reduce the
3938 generation of mouse events. To not miss any motion
3939 events, we must divide the frame into rectangles of the
3940 size of the smallest character that could be displayed
3941 on it, i.e. into the same rectangles that matrices on
3942 the frame are divided into. */
3944 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3945 last_mouse_glyph_frame = f1;
3947 *bar_window = Qnil;
3948 *part = 0;
3949 *fp = f1;
3950 XSETINT (*x, win_x);
3951 XSETINT (*y, win_y);
3952 *time = last_mouse_movement_time;
3957 UNBLOCK_INPUT;
3962 /***********************************************************************
3963 Scroll bars
3964 ***********************************************************************/
3966 /* Scroll bar support. */
3968 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
3969 manages it.
3970 This can be called in GC, so we have to make sure to strip off mark
3971 bits. */
3973 static struct scroll_bar *
3974 x_window_to_scroll_bar (display, window_id)
3975 Display *display;
3976 Window window_id;
3978 Lisp_Object tail;
3980 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3981 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
3982 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
3984 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
3986 Lisp_Object frame, bar, condemned;
3988 frame = XCAR (tail);
3989 /* All elements of Vframe_list should be frames. */
3990 if (! FRAMEP (frame))
3991 abort ();
3993 if (! FRAME_X_P (XFRAME (frame)))
3994 continue;
3996 /* Scan this frame's scroll bar list for a scroll bar with the
3997 right window ID. */
3998 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
3999 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4000 /* This trick allows us to search both the ordinary and
4001 condemned scroll bar lists with one loop. */
4002 ! NILP (bar) || (bar = condemned,
4003 condemned = Qnil,
4004 ! NILP (bar));
4005 bar = XSCROLL_BAR (bar)->next)
4006 if (XSCROLL_BAR (bar)->x_window == window_id &&
4007 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4008 return XSCROLL_BAR (bar);
4011 return 0;
4015 #if defined USE_LUCID
4017 /* Return the Lucid menu bar WINDOW is part of. Return null
4018 if WINDOW is not part of a menu bar. */
4020 static Widget
4021 x_window_to_menu_bar (window)
4022 Window window;
4024 Lisp_Object tail;
4026 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4028 if (FRAME_X_P (XFRAME (XCAR (tail))))
4030 Lisp_Object frame = XCAR (tail);
4031 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4033 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4034 return menu_bar;
4038 return NULL;
4041 #endif /* USE_LUCID */
4044 /************************************************************************
4045 Toolkit scroll bars
4046 ************************************************************************/
4048 #ifdef USE_TOOLKIT_SCROLL_BARS
4050 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
4051 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
4052 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
4053 struct scroll_bar *));
4054 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
4055 int, int, int));
4058 /* Lisp window being scrolled. Set when starting to interact with
4059 a toolkit scroll bar, reset to nil when ending the interaction. */
4061 static Lisp_Object window_being_scrolled;
4063 /* Last scroll bar part sent in xm_scroll_callback. */
4065 static int last_scroll_bar_part;
4067 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4068 that movements of 1/20 of the screen size are mapped to up/down. */
4070 #ifndef USE_GTK
4071 /* Id of action hook installed for scroll bars. */
4073 static XtActionHookId action_hook_id;
4075 static Boolean xaw3d_arrow_scroll;
4077 /* Whether the drag scrolling maintains the mouse at the top of the
4078 thumb. If not, resizing the thumb needs to be done more carefully
4079 to avoid jerkyness. */
4081 static Boolean xaw3d_pick_top;
4083 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4084 bars are used.. The hook is responsible for detecting when
4085 the user ends an interaction with the scroll bar, and generates
4086 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4088 static void
4089 xt_action_hook (widget, client_data, action_name, event, params,
4090 num_params)
4091 Widget widget;
4092 XtPointer client_data;
4093 String action_name;
4094 XEvent *event;
4095 String *params;
4096 Cardinal *num_params;
4098 int scroll_bar_p;
4099 char *end_action;
4101 #ifdef USE_MOTIF
4102 scroll_bar_p = XmIsScrollBar (widget);
4103 end_action = "Release";
4104 #else /* !USE_MOTIF i.e. use Xaw */
4105 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4106 end_action = "EndScroll";
4107 #endif /* USE_MOTIF */
4109 if (scroll_bar_p
4110 && strcmp (action_name, end_action) == 0
4111 && WINDOWP (window_being_scrolled))
4113 struct window *w;
4115 x_send_scroll_bar_event (window_being_scrolled,
4116 scroll_bar_end_scroll, 0, 0);
4117 w = XWINDOW (window_being_scrolled);
4119 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4121 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4122 /* The thumb size is incorrect while dragging: fix it. */
4123 set_vertical_scroll_bar (w);
4125 window_being_scrolled = Qnil;
4126 last_scroll_bar_part = -1;
4128 /* Xt timeouts no longer needed. */
4129 toolkit_scroll_bar_interaction = 0;
4132 #endif /* not USE_GTK */
4134 /* A vector of windows used for communication between
4135 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4137 static struct window **scroll_bar_windows;
4138 static int scroll_bar_windows_size;
4141 /* Send a client message with message type Xatom_Scrollbar for a
4142 scroll action to the frame of WINDOW. PART is a value identifying
4143 the part of the scroll bar that was clicked on. PORTION is the
4144 amount to scroll of a whole of WHOLE. */
4146 static void
4147 x_send_scroll_bar_event (window, part, portion, whole)
4148 Lisp_Object window;
4149 int part, portion, whole;
4151 XEvent event;
4152 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4153 struct window *w = XWINDOW (window);
4154 struct frame *f = XFRAME (w->frame);
4155 int i;
4157 BLOCK_INPUT;
4159 /* Construct a ClientMessage event to send to the frame. */
4160 ev->type = ClientMessage;
4161 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4162 ev->display = FRAME_X_DISPLAY (f);
4163 ev->window = FRAME_X_WINDOW (f);
4164 ev->format = 32;
4166 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4167 not enough to store a pointer or Lisp_Object on a 64 bit system.
4168 So, store the window in scroll_bar_windows and pass the index
4169 into that array in the event. */
4170 for (i = 0; i < scroll_bar_windows_size; ++i)
4171 if (scroll_bar_windows[i] == NULL)
4172 break;
4174 if (i == scroll_bar_windows_size)
4176 int new_size = max (10, 2 * scroll_bar_windows_size);
4177 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4178 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4180 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4181 nbytes);
4182 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4183 scroll_bar_windows_size = new_size;
4186 scroll_bar_windows[i] = w;
4187 ev->data.l[0] = (long) i;
4188 ev->data.l[1] = (long) part;
4189 ev->data.l[2] = (long) 0;
4190 ev->data.l[3] = (long) portion;
4191 ev->data.l[4] = (long) whole;
4193 /* Make Xt timeouts work while the scroll bar is active. */
4194 toolkit_scroll_bar_interaction = 1;
4195 #ifdef USE_X_TOOLKIT
4196 x_activate_timeout_atimer ();
4197 #endif
4199 /* Setting the event mask to zero means that the message will
4200 be sent to the client that created the window, and if that
4201 window no longer exists, no event will be sent. */
4202 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4203 UNBLOCK_INPUT;
4207 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4208 in *IEVENT. */
4210 static void
4211 x_scroll_bar_to_input_event (event, ievent)
4212 XEvent *event;
4213 struct input_event *ievent;
4215 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4216 Lisp_Object window;
4217 struct frame *f;
4218 struct window *w;
4220 w = scroll_bar_windows[ev->data.l[0]];
4221 scroll_bar_windows[ev->data.l[0]] = NULL;
4223 XSETWINDOW (window, w);
4224 f = XFRAME (w->frame);
4226 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4227 ievent->frame_or_window = window;
4228 ievent->arg = Qnil;
4229 #ifdef USE_GTK
4230 ievent->timestamp = CurrentTime;
4231 #else
4232 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4233 #endif
4234 ievent->part = ev->data.l[1];
4235 ievent->code = ev->data.l[2];
4236 ievent->x = make_number ((int) ev->data.l[3]);
4237 ievent->y = make_number ((int) ev->data.l[4]);
4238 ievent->modifiers = 0;
4242 #ifdef USE_MOTIF
4244 /* Minimum and maximum values used for Motif scroll bars. */
4246 #define XM_SB_MAX 10000000
4249 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4250 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4251 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4253 static void
4254 xm_scroll_callback (widget, client_data, call_data)
4255 Widget widget;
4256 XtPointer client_data, call_data;
4258 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4259 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4260 int part = -1, whole = 0, portion = 0;
4262 switch (cs->reason)
4264 case XmCR_DECREMENT:
4265 bar->dragging = Qnil;
4266 part = scroll_bar_up_arrow;
4267 break;
4269 case XmCR_INCREMENT:
4270 bar->dragging = Qnil;
4271 part = scroll_bar_down_arrow;
4272 break;
4274 case XmCR_PAGE_DECREMENT:
4275 bar->dragging = Qnil;
4276 part = scroll_bar_above_handle;
4277 break;
4279 case XmCR_PAGE_INCREMENT:
4280 bar->dragging = Qnil;
4281 part = scroll_bar_below_handle;
4282 break;
4284 case XmCR_TO_TOP:
4285 bar->dragging = Qnil;
4286 part = scroll_bar_to_top;
4287 break;
4289 case XmCR_TO_BOTTOM:
4290 bar->dragging = Qnil;
4291 part = scroll_bar_to_bottom;
4292 break;
4294 case XmCR_DRAG:
4296 int slider_size;
4298 /* Get the slider size. */
4299 BLOCK_INPUT;
4300 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4301 UNBLOCK_INPUT;
4303 whole = XM_SB_MAX - slider_size;
4304 portion = min (cs->value, whole);
4305 part = scroll_bar_handle;
4306 bar->dragging = make_number (cs->value);
4308 break;
4310 case XmCR_VALUE_CHANGED:
4311 break;
4314 if (part >= 0)
4316 window_being_scrolled = bar->window;
4317 last_scroll_bar_part = part;
4318 x_send_scroll_bar_event (bar->window, part, portion, whole);
4322 #elif defined USE_GTK
4324 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4325 bar widget. DATA is a pointer to the scroll_bar structure. */
4327 static void
4328 xg_scroll_callback (widget, data)
4329 GtkRange *widget;
4330 gpointer data;
4332 struct scroll_bar *bar = (struct scroll_bar *) data;
4333 gdouble previous;
4334 gdouble position;
4335 gdouble *p;
4336 int diff;
4338 int part = -1, whole = 0, portion = 0;
4339 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (widget));
4341 position = gtk_adjustment_get_value (adj);
4343 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
4344 if (! p)
4346 p = (gdouble*) xmalloc (sizeof (gdouble));
4347 *p = XG_SB_MIN;
4348 g_object_set_data (G_OBJECT (widget), XG_LAST_SB_DATA, p);
4351 previous = *p;
4352 *p = position;
4354 if (xg_ignore_gtk_scrollbar) return;
4356 diff = (int) (position - previous);
4358 if (diff == (int) adj->step_increment)
4360 part = scroll_bar_down_arrow;
4361 bar->dragging = Qnil;
4363 else if (-diff == (int) adj->step_increment)
4365 part = scroll_bar_up_arrow;
4366 bar->dragging = Qnil;
4368 else if (diff == (int) adj->page_increment)
4370 part = scroll_bar_below_handle;
4371 bar->dragging = Qnil;
4373 else if (-diff == (int) adj->page_increment)
4375 part = scroll_bar_above_handle;
4376 bar->dragging = Qnil;
4378 else
4380 part = scroll_bar_handle;
4381 whole = adj->upper - adj->page_size;
4382 portion = min ((int)position, whole);
4383 bar->dragging = make_number ((int)portion);
4386 if (part >= 0)
4388 window_being_scrolled = bar->window;
4389 last_scroll_bar_part = part;
4390 x_send_scroll_bar_event (bar->window, part, portion, whole);
4394 #else /* not USE_GTK and not USE_MOTIF */
4396 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4397 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4398 scroll bar struct. CALL_DATA is a pointer to a float saying where
4399 the thumb is. */
4401 static void
4402 xaw_jump_callback (widget, client_data, call_data)
4403 Widget widget;
4404 XtPointer client_data, call_data;
4406 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4407 float top = *(float *) call_data;
4408 float shown;
4409 int whole, portion, height;
4410 int part;
4412 /* Get the size of the thumb, a value between 0 and 1. */
4413 BLOCK_INPUT;
4414 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4415 UNBLOCK_INPUT;
4417 whole = 10000000;
4418 portion = shown < 1 ? top * whole : 0;
4420 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4421 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4422 the bottom, so we force the scrolling whenever we see that we're
4423 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4424 we try to ensure that we always stay two pixels away from the
4425 bottom). */
4426 part = scroll_bar_down_arrow;
4427 else
4428 part = scroll_bar_handle;
4430 window_being_scrolled = bar->window;
4431 bar->dragging = make_number (portion);
4432 last_scroll_bar_part = part;
4433 x_send_scroll_bar_event (bar->window, part, portion, whole);
4437 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4438 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4439 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4440 the scroll bar. CALL_DATA is an integer specifying the action that
4441 has taken place. Its magnitude is in the range 0..height of the
4442 scroll bar. Negative values mean scroll towards buffer start.
4443 Values < height of scroll bar mean line-wise movement. */
4445 static void
4446 xaw_scroll_callback (widget, client_data, call_data)
4447 Widget widget;
4448 XtPointer client_data, call_data;
4450 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4451 /* The position really is stored cast to a pointer. */
4452 int position = (long) call_data;
4453 Dimension height;
4454 int part;
4456 /* Get the height of the scroll bar. */
4457 BLOCK_INPUT;
4458 XtVaGetValues (widget, XtNheight, &height, NULL);
4459 UNBLOCK_INPUT;
4461 if (eabs (position) >= height)
4462 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4464 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4465 it maps line-movement to call_data = max(5, height/20). */
4466 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4467 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4468 else
4469 part = scroll_bar_move_ratio;
4471 window_being_scrolled = bar->window;
4472 bar->dragging = Qnil;
4473 last_scroll_bar_part = part;
4474 x_send_scroll_bar_event (bar->window, part, position, height);
4477 #endif /* not USE_GTK and not USE_MOTIF */
4479 #define SCROLL_BAR_NAME "verticalScrollBar"
4481 /* Create the widget for scroll bar BAR on frame F. Record the widget
4482 and X window of the scroll bar in BAR. */
4484 #ifdef USE_GTK
4485 static void
4486 x_create_toolkit_scroll_bar (f, bar)
4487 struct frame *f;
4488 struct scroll_bar *bar;
4490 char *scroll_bar_name = SCROLL_BAR_NAME;
4492 BLOCK_INPUT;
4493 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4494 scroll_bar_name);
4495 UNBLOCK_INPUT;
4498 #else /* not USE_GTK */
4500 static void
4501 x_create_toolkit_scroll_bar (f, bar)
4502 struct frame *f;
4503 struct scroll_bar *bar;
4505 Window xwindow;
4506 Widget widget;
4507 Arg av[20];
4508 int ac = 0;
4509 char *scroll_bar_name = SCROLL_BAR_NAME;
4510 unsigned long pixel;
4512 BLOCK_INPUT;
4514 #ifdef USE_MOTIF
4515 /* Set resources. Create the widget. */
4516 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4517 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4518 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4519 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4520 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4521 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4522 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4524 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4525 if (pixel != -1)
4527 XtSetArg (av[ac], XmNforeground, pixel);
4528 ++ac;
4531 pixel = f->output_data.x->scroll_bar_background_pixel;
4532 if (pixel != -1)
4534 XtSetArg (av[ac], XmNbackground, pixel);
4535 ++ac;
4538 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4539 scroll_bar_name, av, ac);
4541 /* Add one callback for everything that can happen. */
4542 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4543 (XtPointer) bar);
4544 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4545 (XtPointer) bar);
4546 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4547 (XtPointer) bar);
4548 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4549 (XtPointer) bar);
4550 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4551 (XtPointer) bar);
4552 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4553 (XtPointer) bar);
4554 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4555 (XtPointer) bar);
4557 /* Realize the widget. Only after that is the X window created. */
4558 XtRealizeWidget (widget);
4560 /* Set the cursor to an arrow. I didn't find a resource to do that.
4561 And I'm wondering why it hasn't an arrow cursor by default. */
4562 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4563 f->output_data.x->nontext_cursor);
4565 #else /* !USE_MOTIF i.e. use Xaw */
4567 /* Set resources. Create the widget. The background of the
4568 Xaw3d scroll bar widget is a little bit light for my taste.
4569 We don't alter it here to let users change it according
4570 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4571 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4572 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4573 /* For smoother scrolling with Xaw3d -sm */
4574 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4576 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4577 if (pixel != -1)
4579 XtSetArg (av[ac], XtNforeground, pixel);
4580 ++ac;
4583 pixel = f->output_data.x->scroll_bar_background_pixel;
4584 if (pixel != -1)
4586 XtSetArg (av[ac], XtNbackground, pixel);
4587 ++ac;
4590 /* Top/bottom shadow colors. */
4592 /* Allocate them, if necessary. */
4593 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4595 pixel = f->output_data.x->scroll_bar_background_pixel;
4596 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4597 &pixel, 1.2, 0x8000))
4598 pixel = -1;
4599 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4601 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4603 pixel = f->output_data.x->scroll_bar_background_pixel;
4604 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4605 &pixel, 0.6, 0x4000))
4606 pixel = -1;
4607 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4610 #ifdef XtNbeNiceToColormap
4611 /* Tell the toolkit about them. */
4612 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4613 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4614 /* We tried to allocate a color for the top/bottom shadow, and
4615 failed, so tell Xaw3d to use dithering instead. */
4617 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4618 ++ac;
4620 else
4621 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4622 be more consistent with other emacs 3d colors, and since Xaw3d is
4623 not good at dealing with allocation failure. */
4625 /* This tells Xaw3d to use real colors instead of dithering for
4626 the shadows. */
4627 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4628 ++ac;
4630 /* Specify the colors. */
4631 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4632 if (pixel != -1)
4634 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4635 ++ac;
4637 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4638 if (pixel != -1)
4640 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4641 ++ac;
4644 #endif
4646 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4647 f->output_data.x->edit_widget, av, ac);
4650 char *initial = "";
4651 char *val = initial;
4652 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4653 #ifdef XtNarrowScrollbars
4654 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4655 #endif
4656 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4657 if (xaw3d_arrow_scroll || val == initial)
4658 { /* ARROW_SCROLL */
4659 xaw3d_arrow_scroll = True;
4660 /* Isn't that just a personal preference ? --Stef */
4661 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4665 /* Define callbacks. */
4666 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4667 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4668 (XtPointer) bar);
4670 /* Realize the widget. Only after that is the X window created. */
4671 XtRealizeWidget (widget);
4673 #endif /* !USE_MOTIF */
4675 /* Install an action hook that lets us detect when the user
4676 finishes interacting with a scroll bar. */
4677 if (action_hook_id == 0)
4678 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4680 /* Remember X window and widget in the scroll bar vector. */
4681 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4682 xwindow = XtWindow (widget);
4683 bar->x_window = xwindow;
4685 UNBLOCK_INPUT;
4687 #endif /* not USE_GTK */
4690 /* Set the thumb size and position of scroll bar BAR. We are currently
4691 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4693 #ifdef USE_GTK
4694 static void
4695 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4696 struct scroll_bar *bar;
4697 int portion, position, whole;
4699 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4702 #else /* not USE_GTK */
4703 static void
4704 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4705 struct scroll_bar *bar;
4706 int portion, position, whole;
4708 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4709 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4710 float top, shown;
4712 BLOCK_INPUT;
4714 #ifdef USE_MOTIF
4716 /* We use an estimate of 30 chars per line rather than the real
4717 `portion' value. This has the disadvantage that the thumb size
4718 is not very representative, but it makes our life a lot easier.
4719 Otherwise, we have to constantly adjust the thumb size, which
4720 we can't always do quickly enough: while dragging, the size of
4721 the thumb might prevent the user from dragging the thumb all the
4722 way to the end. but Motif and some versions of Xaw3d don't allow
4723 updating the thumb size while dragging. Also, even if we can update
4724 its size, the update will often happen too late.
4725 If you don't believe it, check out revision 1.650 of xterm.c to see
4726 what hoops we were going through and the still poor behavior we got. */
4727 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4728 /* When the thumb is at the bottom, position == whole.
4729 So we need to increase `whole' to make space for the thumb. */
4730 whole += portion;
4732 if (whole <= 0)
4733 top = 0, shown = 1;
4734 else
4736 top = (float) position / whole;
4737 shown = (float) portion / whole;
4740 if (NILP (bar->dragging))
4742 int size, value;
4744 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4745 is the scroll bar's maximum and MIN is the scroll bar's minimum
4746 value. */
4747 size = shown * XM_SB_MAX;
4748 size = min (size, XM_SB_MAX);
4749 size = max (size, 1);
4751 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4752 value = top * XM_SB_MAX;
4753 value = min (value, XM_SB_MAX - size);
4755 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4757 #else /* !USE_MOTIF i.e. use Xaw */
4759 if (whole == 0)
4760 top = 0, shown = 1;
4761 else
4763 top = (float) position / whole;
4764 shown = (float) portion / whole;
4768 float old_top, old_shown;
4769 Dimension height;
4770 XtVaGetValues (widget,
4771 XtNtopOfThumb, &old_top,
4772 XtNshown, &old_shown,
4773 XtNheight, &height,
4774 NULL);
4776 /* Massage the top+shown values. */
4777 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4778 top = max (0, min (1, top));
4779 else
4780 top = old_top;
4781 /* Keep two pixels available for moving the thumb down. */
4782 shown = max (0, min (1 - top - (2.0 / height), shown));
4784 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4785 check that your system's configuration file contains a define
4786 for `NARROWPROTO'. See s/freebsd.h for an example. */
4787 if (top != old_top || shown != old_shown)
4789 if (NILP (bar->dragging))
4790 XawScrollbarSetThumb (widget, top, shown);
4791 else
4793 /* Try to make the scrolling a tad smoother. */
4794 if (!xaw3d_pick_top)
4795 shown = min (shown, old_shown);
4797 XawScrollbarSetThumb (widget, top, shown);
4801 #endif /* !USE_MOTIF */
4803 UNBLOCK_INPUT;
4805 #endif /* not USE_GTK */
4807 #endif /* USE_TOOLKIT_SCROLL_BARS */
4811 /************************************************************************
4812 Scroll bars, general
4813 ************************************************************************/
4815 /* Create a scroll bar and return the scroll bar vector for it. W is
4816 the Emacs window on which to create the scroll bar. TOP, LEFT,
4817 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4818 scroll bar. */
4820 static struct scroll_bar *
4821 x_scroll_bar_create (w, top, left, width, height)
4822 struct window *w;
4823 int top, left, width, height;
4825 struct frame *f = XFRAME (w->frame);
4826 struct scroll_bar *bar
4827 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4829 BLOCK_INPUT;
4831 #ifdef USE_TOOLKIT_SCROLL_BARS
4832 x_create_toolkit_scroll_bar (f, bar);
4833 #else /* not USE_TOOLKIT_SCROLL_BARS */
4835 XSetWindowAttributes a;
4836 unsigned long mask;
4837 Window window;
4839 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4840 if (a.background_pixel == -1)
4841 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4843 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4844 | ButtonMotionMask | PointerMotionHintMask
4845 | ExposureMask);
4846 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4848 mask = (CWBackPixel | CWEventMask | CWCursor);
4850 /* Clear the area of W that will serve as a scroll bar. This is
4851 for the case that a window has been split horizontally. In
4852 this case, no clear_frame is generated to reduce flickering. */
4853 if (width > 0 && height > 0)
4854 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4855 left, top, width,
4856 window_box_height (w), False);
4858 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4859 /* Position and size of scroll bar. */
4860 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4861 top,
4862 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4863 height,
4864 /* Border width, depth, class, and visual. */
4866 CopyFromParent,
4867 CopyFromParent,
4868 CopyFromParent,
4869 /* Attributes. */
4870 mask, &a);
4871 bar->x_window = window;
4873 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4875 XSETWINDOW (bar->window, w);
4876 bar->top = top;
4877 bar->left = left;
4878 bar->width = width;
4879 bar->height = height;
4880 bar->start = 0;
4881 bar->end = 0;
4882 bar->dragging = Qnil;
4883 bar->fringe_extended_p = 0;
4885 /* Add bar to its frame's list of scroll bars. */
4886 bar->next = FRAME_SCROLL_BARS (f);
4887 bar->prev = Qnil;
4888 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4889 if (!NILP (bar->next))
4890 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4892 /* Map the window/widget. */
4893 #ifdef USE_TOOLKIT_SCROLL_BARS
4895 #ifdef USE_GTK
4896 xg_update_scrollbar_pos (f,
4897 bar->x_window,
4898 top,
4899 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4900 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4901 max (height, 1));
4902 xg_show_scroll_bar (bar->x_window);
4903 #else /* not USE_GTK */
4904 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4905 XtConfigureWidget (scroll_bar,
4906 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4907 top,
4908 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4909 max (height, 1), 0);
4910 XtMapWidget (scroll_bar);
4911 #endif /* not USE_GTK */
4913 #else /* not USE_TOOLKIT_SCROLL_BARS */
4914 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4915 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4917 UNBLOCK_INPUT;
4918 return bar;
4922 #ifndef USE_TOOLKIT_SCROLL_BARS
4924 /* Draw BAR's handle in the proper position.
4926 If the handle is already drawn from START to END, don't bother
4927 redrawing it, unless REBUILD is non-zero; in that case, always
4928 redraw it. (REBUILD is handy for drawing the handle after expose
4929 events.)
4931 Normally, we want to constrain the start and end of the handle to
4932 fit inside its rectangle, but if the user is dragging the scroll
4933 bar handle, we want to let them drag it down all the way, so that
4934 the bar's top is as far down as it goes; otherwise, there's no way
4935 to move to the very end of the buffer. */
4937 static void
4938 x_scroll_bar_set_handle (bar, start, end, rebuild)
4939 struct scroll_bar *bar;
4940 int start, end;
4941 int rebuild;
4943 int dragging = ! NILP (bar->dragging);
4944 Window w = bar->x_window;
4945 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4946 GC gc = f->output_data.x->normal_gc;
4948 /* If the display is already accurate, do nothing. */
4949 if (! rebuild
4950 && start == bar->start
4951 && end == bar->end)
4952 return;
4954 BLOCK_INPUT;
4957 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4958 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4959 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4961 /* Make sure the values are reasonable, and try to preserve
4962 the distance between start and end. */
4964 int length = end - start;
4966 if (start < 0)
4967 start = 0;
4968 else if (start > top_range)
4969 start = top_range;
4970 end = start + length;
4972 if (end < start)
4973 end = start;
4974 else if (end > top_range && ! dragging)
4975 end = top_range;
4978 /* Store the adjusted setting in the scroll bar. */
4979 bar->start = start;
4980 bar->end = end;
4982 /* Clip the end position, just for display. */
4983 if (end > top_range)
4984 end = top_range;
4986 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
4987 below top positions, to make sure the handle is always at least
4988 that many pixels tall. */
4989 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
4991 /* Draw the empty space above the handle. Note that we can't clear
4992 zero-height areas; that means "clear to end of window." */
4993 if (0 < start)
4994 x_clear_area (FRAME_X_DISPLAY (f), w,
4995 /* x, y, width, height, and exposures. */
4996 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4997 VERTICAL_SCROLL_BAR_TOP_BORDER,
4998 inside_width, start,
4999 False);
5001 /* Change to proper foreground color if one is specified. */
5002 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5003 XSetForeground (FRAME_X_DISPLAY (f), gc,
5004 f->output_data.x->scroll_bar_foreground_pixel);
5006 /* Draw the handle itself. */
5007 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5008 /* x, y, width, height */
5009 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5010 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5011 inside_width, end - start);
5013 /* Restore the foreground color of the GC if we changed it above. */
5014 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5015 XSetForeground (FRAME_X_DISPLAY (f), gc,
5016 FRAME_FOREGROUND_PIXEL (f));
5018 /* Draw the empty space below the handle. Note that we can't
5019 clear zero-height areas; that means "clear to end of window." */
5020 if (end < inside_height)
5021 x_clear_area (FRAME_X_DISPLAY (f), w,
5022 /* x, y, width, height, and exposures. */
5023 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5024 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5025 inside_width, inside_height - end,
5026 False);
5030 UNBLOCK_INPUT;
5033 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5035 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5036 nil. */
5038 static void
5039 x_scroll_bar_remove (bar)
5040 struct scroll_bar *bar;
5042 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5043 BLOCK_INPUT;
5045 #ifdef USE_TOOLKIT_SCROLL_BARS
5046 #ifdef USE_GTK
5047 xg_remove_scroll_bar (f, bar->x_window);
5048 #else /* not USE_GTK */
5049 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5050 #endif /* not USE_GTK */
5051 #else
5052 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5053 #endif
5055 /* Disassociate this scroll bar from its window. */
5056 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5058 UNBLOCK_INPUT;
5062 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5063 that we are displaying PORTION characters out of a total of WHOLE
5064 characters, starting at POSITION. If WINDOW has no scroll bar,
5065 create one. */
5067 static void
5068 XTset_vertical_scroll_bar (w, portion, whole, position)
5069 struct window *w;
5070 int portion, whole, position;
5072 struct frame *f = XFRAME (w->frame);
5073 struct scroll_bar *bar;
5074 int top, height, left, sb_left, width, sb_width;
5075 int window_y, window_height;
5076 #ifdef USE_TOOLKIT_SCROLL_BARS
5077 int fringe_extended_p;
5078 #endif
5080 /* Get window dimensions. */
5081 window_box (w, -1, 0, &window_y, 0, &window_height);
5082 top = window_y;
5083 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5084 height = window_height;
5086 /* Compute the left edge of the scroll bar area. */
5087 left = WINDOW_SCROLL_BAR_AREA_X (w);
5089 /* Compute the width of the scroll bar which might be less than
5090 the width of the area reserved for the scroll bar. */
5091 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5092 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5093 else
5094 sb_width = width;
5096 /* Compute the left edge of the scroll bar. */
5097 #ifdef USE_TOOLKIT_SCROLL_BARS
5098 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5099 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5100 else
5101 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5102 #else
5103 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5104 sb_left = left + width - sb_width;
5105 else
5106 sb_left = left;
5107 #endif
5109 #ifdef USE_TOOLKIT_SCROLL_BARS
5110 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5111 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5112 && WINDOW_LEFT_FRINGE_WIDTH (w)
5113 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5114 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5115 else
5116 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5117 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5118 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5119 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5120 #endif
5122 /* Does the scroll bar exist yet? */
5123 if (NILP (w->vertical_scroll_bar))
5125 if (width > 0 && height > 0)
5127 BLOCK_INPUT;
5128 #ifdef USE_TOOLKIT_SCROLL_BARS
5129 if (fringe_extended_p)
5130 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5131 sb_left, top, sb_width, height, False);
5132 else
5133 #endif
5134 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5135 left, top, width, height, False);
5136 UNBLOCK_INPUT;
5139 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5141 else
5143 /* It may just need to be moved and resized. */
5144 unsigned int mask = 0;
5146 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5148 BLOCK_INPUT;
5150 if (sb_left != bar->left)
5151 mask |= CWX;
5152 if (top != bar->top)
5153 mask |= CWY;
5154 if (sb_width != bar->width)
5155 mask |= CWWidth;
5156 if (height != bar->height)
5157 mask |= CWHeight;
5159 #ifdef USE_TOOLKIT_SCROLL_BARS
5161 /* Move/size the scroll bar widget. */
5162 if (mask || bar->fringe_extended_p != fringe_extended_p)
5164 /* Since toolkit scroll bars are smaller than the space reserved
5165 for them on the frame, we have to clear "under" them. */
5166 if (width > 0 && height > 0)
5168 if (fringe_extended_p)
5169 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5170 sb_left, top, sb_width, height, False);
5171 else
5172 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5173 left, top, width, height, False);
5175 #ifdef USE_GTK
5176 xg_update_scrollbar_pos (f,
5177 bar->x_window,
5178 top,
5179 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5180 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5181 max (height, 1));
5182 #else /* not USE_GTK */
5183 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5184 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5185 top,
5186 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5187 max (height, 1), 0);
5188 #endif /* not USE_GTK */
5190 #else /* not USE_TOOLKIT_SCROLL_BARS */
5192 /* Clear areas not covered by the scroll bar because of
5193 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5194 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5196 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5197 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5198 height, False);
5199 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5200 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5201 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5202 height, False);
5205 /* Clear areas not covered by the scroll bar because it's not as
5206 wide as the area reserved for it. This makes sure a
5207 previous mode line display is cleared after C-x 2 C-x 1, for
5208 example. */
5210 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5211 int rest = area_width - sb_width;
5212 if (rest > 0 && height > 0)
5214 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5215 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5216 left + area_width - rest, top,
5217 rest, height, False);
5218 else
5219 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5220 left, top, rest, height, False);
5224 /* Move/size the scroll bar window. */
5225 if (mask)
5227 XWindowChanges wc;
5229 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5230 wc.y = top;
5231 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5232 wc.height = height;
5233 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5234 mask, &wc);
5237 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5239 /* Remember new settings. */
5240 bar->left = sb_left;
5241 bar->top = top;
5242 bar->width = sb_width;
5243 bar->height = height;
5245 UNBLOCK_INPUT;
5248 #ifdef USE_TOOLKIT_SCROLL_BARS
5249 bar->fringe_extended_p = fringe_extended_p;
5251 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5252 #else /* not USE_TOOLKIT_SCROLL_BARS */
5253 /* Set the scroll bar's current state, unless we're currently being
5254 dragged. */
5255 if (NILP (bar->dragging))
5257 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5259 if (whole == 0)
5260 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5261 else
5263 int start = ((double) position * top_range) / whole;
5264 int end = ((double) (position + portion) * top_range) / whole;
5265 x_scroll_bar_set_handle (bar, start, end, 0);
5268 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5270 XSETVECTOR (w->vertical_scroll_bar, bar);
5274 /* The following three hooks are used when we're doing a thorough
5275 redisplay of the frame. We don't explicitly know which scroll bars
5276 are going to be deleted, because keeping track of when windows go
5277 away is a real pain - "Can you say set-window-configuration, boys
5278 and girls?" Instead, we just assert at the beginning of redisplay
5279 that *all* scroll bars are to be removed, and then save a scroll bar
5280 from the fiery pit when we actually redisplay its window. */
5282 /* Arrange for all scroll bars on FRAME to be removed at the next call
5283 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5284 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5286 static void
5287 XTcondemn_scroll_bars (frame)
5288 FRAME_PTR frame;
5290 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5291 while (! NILP (FRAME_SCROLL_BARS (frame)))
5293 Lisp_Object bar;
5294 bar = FRAME_SCROLL_BARS (frame);
5295 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5296 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5297 XSCROLL_BAR (bar)->prev = Qnil;
5298 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5299 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5300 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5305 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5306 Note that WINDOW isn't necessarily condemned at all. */
5308 static void
5309 XTredeem_scroll_bar (window)
5310 struct window *window;
5312 struct scroll_bar *bar;
5313 struct frame *f;
5315 /* We can't redeem this window's scroll bar if it doesn't have one. */
5316 if (NILP (window->vertical_scroll_bar))
5317 abort ();
5319 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5321 /* Unlink it from the condemned list. */
5322 f = XFRAME (WINDOW_FRAME (window));
5323 if (NILP (bar->prev))
5325 /* If the prev pointer is nil, it must be the first in one of
5326 the lists. */
5327 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5328 /* It's not condemned. Everything's fine. */
5329 return;
5330 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5331 window->vertical_scroll_bar))
5332 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5333 else
5334 /* If its prev pointer is nil, it must be at the front of
5335 one or the other! */
5336 abort ();
5338 else
5339 XSCROLL_BAR (bar->prev)->next = bar->next;
5341 if (! NILP (bar->next))
5342 XSCROLL_BAR (bar->next)->prev = bar->prev;
5344 bar->next = FRAME_SCROLL_BARS (f);
5345 bar->prev = Qnil;
5346 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5347 if (! NILP (bar->next))
5348 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5351 /* Remove all scroll bars on FRAME that haven't been saved since the
5352 last call to `*condemn_scroll_bars_hook'. */
5354 static void
5355 XTjudge_scroll_bars (f)
5356 FRAME_PTR f;
5358 Lisp_Object bar, next;
5360 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5362 /* Clear out the condemned list now so we won't try to process any
5363 more events on the hapless scroll bars. */
5364 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5366 for (; ! NILP (bar); bar = next)
5368 struct scroll_bar *b = XSCROLL_BAR (bar);
5370 x_scroll_bar_remove (b);
5372 next = b->next;
5373 b->next = b->prev = Qnil;
5376 /* Now there should be no references to the condemned scroll bars,
5377 and they should get garbage-collected. */
5381 #ifndef USE_TOOLKIT_SCROLL_BARS
5382 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5383 is a no-op when using toolkit scroll bars.
5385 This may be called from a signal handler, so we have to ignore GC
5386 mark bits. */
5388 static void
5389 x_scroll_bar_expose (bar, event)
5390 struct scroll_bar *bar;
5391 XEvent *event;
5393 Window w = bar->x_window;
5394 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5395 GC gc = f->output_data.x->normal_gc;
5396 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5398 BLOCK_INPUT;
5400 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5402 /* Switch to scroll bar foreground color. */
5403 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5404 XSetForeground (FRAME_X_DISPLAY (f), gc,
5405 f->output_data.x->scroll_bar_foreground_pixel);
5407 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5408 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5410 /* x, y, width, height */
5411 0, 0,
5412 bar->width - 1 - width_trim - width_trim,
5413 bar->height - 1);
5415 /* Restore the foreground color of the GC if we changed it above. */
5416 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5417 XSetForeground (FRAME_X_DISPLAY (f), gc,
5418 FRAME_FOREGROUND_PIXEL (f));
5420 UNBLOCK_INPUT;
5423 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5425 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5426 is set to something other than NO_EVENT, it is enqueued.
5428 This may be called from a signal handler, so we have to ignore GC
5429 mark bits. */
5432 static void
5433 x_scroll_bar_handle_click (bar, event, emacs_event)
5434 struct scroll_bar *bar;
5435 XEvent *event;
5436 struct input_event *emacs_event;
5438 if (! WINDOWP (bar->window))
5439 abort ();
5441 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5442 emacs_event->code = event->xbutton.button - Button1;
5443 emacs_event->modifiers
5444 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5445 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5446 event->xbutton.state)
5447 | (event->type == ButtonRelease
5448 ? up_modifier
5449 : down_modifier));
5450 emacs_event->frame_or_window = bar->window;
5451 emacs_event->arg = Qnil;
5452 emacs_event->timestamp = event->xbutton.time;
5454 #if 0
5455 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5456 int internal_height
5457 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5458 #endif
5459 int top_range
5460 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5461 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5463 if (y < 0) y = 0;
5464 if (y > top_range) y = top_range;
5466 if (y < bar->start)
5467 emacs_event->part = scroll_bar_above_handle;
5468 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5469 emacs_event->part = scroll_bar_handle;
5470 else
5471 emacs_event->part = scroll_bar_below_handle;
5473 /* Just because the user has clicked on the handle doesn't mean
5474 they want to drag it. Lisp code needs to be able to decide
5475 whether or not we're dragging. */
5476 #if 0
5477 /* If the user has just clicked on the handle, record where they're
5478 holding it. */
5479 if (event->type == ButtonPress
5480 && emacs_event->part == scroll_bar_handle)
5481 XSETINT (bar->dragging, y - bar->start);
5482 #endif
5484 #ifndef USE_TOOLKIT_SCROLL_BARS
5485 /* If the user has released the handle, set it to its final position. */
5486 if (event->type == ButtonRelease
5487 && ! NILP (bar->dragging))
5489 int new_start = y - XINT (bar->dragging);
5490 int new_end = new_start + bar->end - bar->start;
5492 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5493 bar->dragging = Qnil;
5495 #endif
5497 /* Same deal here as the other #if 0. */
5498 #if 0
5499 /* Clicks on the handle are always reported as occurring at the top of
5500 the handle. */
5501 if (emacs_event->part == scroll_bar_handle)
5502 emacs_event->x = bar->start;
5503 else
5504 XSETINT (emacs_event->x, y);
5505 #else
5506 XSETINT (emacs_event->x, y);
5507 #endif
5509 XSETINT (emacs_event->y, top_range);
5513 #ifndef USE_TOOLKIT_SCROLL_BARS
5515 /* Handle some mouse motion while someone is dragging the scroll bar.
5517 This may be called from a signal handler, so we have to ignore GC
5518 mark bits. */
5520 static void
5521 x_scroll_bar_note_movement (bar, event)
5522 struct scroll_bar *bar;
5523 XEvent *event;
5525 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5527 last_mouse_movement_time = event->xmotion.time;
5529 f->mouse_moved = 1;
5530 XSETVECTOR (last_mouse_scroll_bar, bar);
5532 /* If we're dragging the bar, display it. */
5533 if (! NILP (bar->dragging))
5535 /* Where should the handle be now? */
5536 int new_start = event->xmotion.y - XINT (bar->dragging);
5538 if (new_start != bar->start)
5540 int new_end = new_start + bar->end - bar->start;
5542 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5547 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5549 /* Return information to the user about the current position of the mouse
5550 on the scroll bar. */
5552 static void
5553 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5554 FRAME_PTR *fp;
5555 Lisp_Object *bar_window;
5556 enum scroll_bar_part *part;
5557 Lisp_Object *x, *y;
5558 unsigned long *time;
5560 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5561 Window w = bar->x_window;
5562 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5563 int win_x, win_y;
5564 Window dummy_window;
5565 int dummy_coord;
5566 unsigned int dummy_mask;
5568 BLOCK_INPUT;
5570 /* Get the mouse's position relative to the scroll bar window, and
5571 report that. */
5572 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5574 /* Root, child, root x and root y. */
5575 &dummy_window, &dummy_window,
5576 &dummy_coord, &dummy_coord,
5578 /* Position relative to scroll bar. */
5579 &win_x, &win_y,
5581 /* Mouse buttons and modifier keys. */
5582 &dummy_mask))
5584 else
5586 #if 0
5587 int inside_height
5588 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5589 #endif
5590 int top_range
5591 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5593 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5595 if (! NILP (bar->dragging))
5596 win_y -= XINT (bar->dragging);
5598 if (win_y < 0)
5599 win_y = 0;
5600 if (win_y > top_range)
5601 win_y = top_range;
5603 *fp = f;
5604 *bar_window = bar->window;
5606 if (! NILP (bar->dragging))
5607 *part = scroll_bar_handle;
5608 else if (win_y < bar->start)
5609 *part = scroll_bar_above_handle;
5610 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5611 *part = scroll_bar_handle;
5612 else
5613 *part = scroll_bar_below_handle;
5615 XSETINT (*x, win_y);
5616 XSETINT (*y, top_range);
5618 f->mouse_moved = 0;
5619 last_mouse_scroll_bar = Qnil;
5622 *time = last_mouse_movement_time;
5624 UNBLOCK_INPUT;
5628 /* The screen has been cleared so we may have changed foreground or
5629 background colors, and the scroll bars may need to be redrawn.
5630 Clear out the scroll bars, and ask for expose events, so we can
5631 redraw them. */
5633 void
5634 x_scroll_bar_clear (f)
5635 FRAME_PTR f;
5637 #ifndef USE_TOOLKIT_SCROLL_BARS
5638 Lisp_Object bar;
5640 /* We can have scroll bars even if this is 0,
5641 if we just turned off scroll bar mode.
5642 But in that case we should not clear them. */
5643 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5644 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5645 bar = XSCROLL_BAR (bar)->next)
5646 XClearArea (FRAME_X_DISPLAY (f),
5647 XSCROLL_BAR (bar)->x_window,
5648 0, 0, 0, 0, True);
5649 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5653 /* The main X event-reading loop - XTread_socket. */
5655 #if 0
5656 /* Time stamp of enter window event. This is only used by XTread_socket,
5657 but we have to put it out here, since static variables within functions
5658 sometimes don't work. */
5660 static Time enter_timestamp;
5661 #endif
5663 /* This holds the state XLookupString needs to implement dead keys
5664 and other tricks known as "compose processing". _X Window System_
5665 says that a portable program can't use this, but Stephen Gildea assures
5666 me that letting the compiler initialize it to zeros will work okay.
5668 This must be defined outside of XTread_socket, for the same reasons
5669 given for enter_timestamp, above. */
5671 static XComposeStatus compose_status;
5673 /* Record the last 100 characters stored
5674 to help debug the loss-of-chars-during-GC problem. */
5676 static int temp_index;
5677 static short temp_buffer[100];
5679 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5680 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5681 temp_index = 0; \
5682 temp_buffer[temp_index++] = (keysym)
5684 /* Set this to nonzero to fake an "X I/O error"
5685 on a particular display. */
5687 struct x_display_info *XTread_socket_fake_io_error;
5689 /* When we find no input here, we occasionally do a no-op command
5690 to verify that the X server is still running and we can still talk with it.
5691 We try all the open displays, one by one.
5692 This variable is used for cycling thru the displays. */
5694 static struct x_display_info *next_noop_dpyinfo;
5696 #define SET_SAVED_MENU_EVENT(size) \
5697 do \
5699 if (f->output_data.x->saved_menu_event == 0) \
5700 f->output_data.x->saved_menu_event \
5701 = (XEvent *) xmalloc (sizeof (XEvent)); \
5702 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5703 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5704 XSETFRAME (inev.ie.frame_or_window, f); \
5706 while (0)
5708 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5709 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5712 enum
5714 X_EVENT_NORMAL,
5715 X_EVENT_GOTO_OUT,
5716 X_EVENT_DROP
5719 /* Filter events for the current X input method.
5720 DPYINFO is the display this event is for.
5721 EVENT is the X event to filter.
5723 Returns non-zero if the event was filtered, caller shall not process
5724 this event further.
5725 Returns zero if event is wasn't filtered. */
5727 #ifdef HAVE_X_I18N
5728 static int
5729 x_filter_event (dpyinfo, event)
5730 struct x_display_info *dpyinfo;
5731 XEvent *event;
5733 /* XFilterEvent returns non-zero if the input method has
5734 consumed the event. We pass the frame's X window to
5735 XFilterEvent because that's the one for which the IC
5736 was created. */
5738 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5739 event->xclient.window);
5741 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5743 #endif
5745 #ifdef USE_GTK
5746 static int current_count;
5747 static int current_finish;
5748 static struct input_event *current_hold_quit;
5750 /* This is the filter function invoked by the GTK event loop.
5751 It is invoked before the XEvent is translated to a GdkEvent,
5752 so we have a chance to act on the event before GTK. */
5753 static GdkFilterReturn
5754 event_handler_gdk (gxev, ev, data)
5755 GdkXEvent *gxev;
5756 GdkEvent *ev;
5757 gpointer data;
5759 XEvent *xev = (XEvent *) gxev;
5761 if (current_count >= 0)
5763 struct x_display_info *dpyinfo;
5765 dpyinfo = x_display_info_for_display (xev->xany.display);
5767 #ifdef HAVE_X_I18N
5768 /* Filter events for the current X input method.
5769 GTK calls XFilterEvent but not for key press and release,
5770 so we do it here. */
5771 if (xev->type == KeyPress || xev->type == KeyRelease)
5772 if (dpyinfo && x_filter_event (dpyinfo, xev))
5773 return GDK_FILTER_REMOVE;
5774 #endif
5776 if (! dpyinfo)
5777 current_finish = X_EVENT_NORMAL;
5778 else
5780 current_count +=
5781 handle_one_xevent (dpyinfo, xev, &current_finish,
5782 current_hold_quit);
5785 else
5786 current_finish = x_dispatch_event (xev, xev->xany.display);
5788 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5789 return GDK_FILTER_REMOVE;
5791 return GDK_FILTER_CONTINUE;
5793 #endif /* USE_GTK */
5796 /* Handles the XEvent EVENT on display DPYINFO.
5798 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5799 *FINISH is zero if caller should continue reading events.
5800 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5802 We return the number of characters stored into the buffer. */
5804 static int
5805 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5806 struct x_display_info *dpyinfo;
5807 XEvent *eventp;
5808 int *finish;
5809 struct input_event *hold_quit;
5811 union {
5812 struct input_event ie;
5813 struct selection_input_event sie;
5814 } inev;
5815 int count = 0;
5816 int do_help = 0;
5817 int nbytes = 0;
5818 struct frame *f = NULL;
5819 struct coding_system coding;
5820 XEvent event = *eventp;
5822 *finish = X_EVENT_NORMAL;
5824 EVENT_INIT (inev.ie);
5825 inev.ie.kind = NO_EVENT;
5826 inev.ie.arg = Qnil;
5828 switch (event.type)
5830 case ClientMessage:
5832 if (event.xclient.message_type
5833 == dpyinfo->Xatom_wm_protocols
5834 && event.xclient.format == 32)
5836 if (event.xclient.data.l[0]
5837 == dpyinfo->Xatom_wm_take_focus)
5839 /* Use x_any_window_to_frame because this
5840 could be the shell widget window
5841 if the frame has no title bar. */
5842 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5843 #ifdef HAVE_X_I18N
5844 /* Not quite sure this is needed -pd */
5845 if (f && FRAME_XIC (f))
5846 XSetICFocus (FRAME_XIC (f));
5847 #endif
5848 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5849 instructs the WM to set the input focus automatically for
5850 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5851 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5852 it has set the focus. So, XSetInputFocus below is not
5853 needed.
5855 The call to XSetInputFocus below has also caused trouble. In
5856 cases where the XSetInputFocus done by the WM and the one
5857 below are temporally close (on a fast machine), the call
5858 below can generate additional FocusIn events which confuse
5859 Emacs. */
5861 /* Since we set WM_TAKE_FOCUS, we must call
5862 XSetInputFocus explicitly. But not if f is null,
5863 since that might be an event for a deleted frame. */
5864 if (f)
5866 Display *d = event.xclient.display;
5867 /* Catch and ignore errors, in case window has been
5868 iconified by a window manager such as GWM. */
5869 x_catch_errors (d);
5870 XSetInputFocus (d, event.xclient.window,
5871 /* The ICCCM says this is
5872 the only valid choice. */
5873 RevertToParent,
5874 event.xclient.data.l[1]);
5875 /* This is needed to detect the error
5876 if there is an error. */
5877 XSync (d, False);
5878 x_uncatch_errors ();
5880 /* Not certain about handling scroll bars here */
5881 #endif /* 0 */
5882 goto done;
5885 if (event.xclient.data.l[0]
5886 == dpyinfo->Xatom_wm_save_yourself)
5888 /* Save state modify the WM_COMMAND property to
5889 something which can reinstate us. This notifies
5890 the session manager, who's looking for such a
5891 PropertyNotify. Can restart processing when
5892 a keyboard or mouse event arrives. */
5893 /* If we have a session manager, don't set this.
5894 KDE will then start two Emacsen, one for the
5895 session manager and one for this. */
5896 #ifdef HAVE_X_SM
5897 if (! x_session_have_connection ())
5898 #endif
5900 f = x_top_window_to_frame (dpyinfo,
5901 event.xclient.window);
5902 /* This is just so we only give real data once
5903 for a single Emacs process. */
5904 if (f == SELECTED_FRAME ())
5905 XSetCommand (FRAME_X_DISPLAY (f),
5906 event.xclient.window,
5907 initial_argv, initial_argc);
5908 else if (f)
5909 XSetCommand (FRAME_X_DISPLAY (f),
5910 event.xclient.window,
5911 0, 0);
5913 goto done;
5916 if (event.xclient.data.l[0]
5917 == dpyinfo->Xatom_wm_delete_window)
5919 f = x_any_window_to_frame (dpyinfo,
5920 event.xclient.window);
5921 if (!f)
5922 goto OTHER; /* May be a dialog that is to be removed */
5924 inev.ie.kind = DELETE_WINDOW_EVENT;
5925 XSETFRAME (inev.ie.frame_or_window, f);
5926 goto done;
5929 goto done;
5932 if (event.xclient.message_type
5933 == dpyinfo->Xatom_wm_configure_denied)
5935 goto done;
5938 if (event.xclient.message_type
5939 == dpyinfo->Xatom_wm_window_moved)
5941 int new_x, new_y;
5942 f = x_window_to_frame (dpyinfo, event.xclient.window);
5944 new_x = event.xclient.data.s[0];
5945 new_y = event.xclient.data.s[1];
5947 if (f)
5949 f->left_pos = new_x;
5950 f->top_pos = new_y;
5952 goto done;
5955 #ifdef HACK_EDITRES
5956 if (event.xclient.message_type
5957 == dpyinfo->Xatom_editres)
5959 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5960 if (f)
5961 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5962 &event, NULL);
5963 goto done;
5965 #endif /* HACK_EDITRES */
5967 if ((event.xclient.message_type
5968 == dpyinfo->Xatom_DONE)
5969 || (event.xclient.message_type
5970 == dpyinfo->Xatom_PAGE))
5972 /* Ghostview job completed. Kill it. We could
5973 reply with "Next" if we received "Page", but we
5974 currently never do because we are interested in
5975 images, only, which should have 1 page. */
5976 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5977 f = x_window_to_frame (dpyinfo, event.xclient.window);
5978 if (!f)
5979 goto OTHER;
5980 x_kill_gs_process (pixmap, f);
5981 expose_frame (f, 0, 0, 0, 0);
5982 goto done;
5985 #ifdef USE_TOOLKIT_SCROLL_BARS
5986 /* Scroll bar callbacks send a ClientMessage from which
5987 we construct an input_event. */
5988 if (event.xclient.message_type
5989 == dpyinfo->Xatom_Scrollbar)
5991 x_scroll_bar_to_input_event (&event, &inev.ie);
5992 *finish = X_EVENT_GOTO_OUT;
5993 goto done;
5995 #endif /* USE_TOOLKIT_SCROLL_BARS */
5997 /* XEmbed messages from the embedder (if any). */
5998 if (event.xclient.message_type
5999 == dpyinfo->Xatom_XEMBED)
6001 enum xembed_message msg = event.xclient.data.l[1];
6002 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6003 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6005 *finish = X_EVENT_GOTO_OUT;
6006 goto done;
6009 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6010 if (!f)
6011 goto OTHER;
6012 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6013 *finish = X_EVENT_DROP;
6015 break;
6017 case SelectionNotify:
6018 last_user_time = event.xselection.time;
6019 #ifdef USE_X_TOOLKIT
6020 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6021 goto OTHER;
6022 #endif /* not USE_X_TOOLKIT */
6023 x_handle_selection_notify (&event.xselection);
6024 break;
6026 case SelectionClear: /* Someone has grabbed ownership. */
6027 last_user_time = event.xselectionclear.time;
6028 #ifdef USE_X_TOOLKIT
6029 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6030 goto OTHER;
6031 #endif /* USE_X_TOOLKIT */
6033 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6035 inev.ie.kind = SELECTION_CLEAR_EVENT;
6036 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6037 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6038 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6039 inev.ie.frame_or_window = Qnil;
6041 break;
6043 case SelectionRequest: /* Someone wants our selection. */
6044 last_user_time = event.xselectionrequest.time;
6045 #ifdef USE_X_TOOLKIT
6046 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6047 goto OTHER;
6048 #endif /* USE_X_TOOLKIT */
6050 XSelectionRequestEvent *eventp
6051 = (XSelectionRequestEvent *) &event;
6053 inev.ie.kind = SELECTION_REQUEST_EVENT;
6054 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6055 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6056 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6057 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6058 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6059 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6060 inev.ie.frame_or_window = Qnil;
6062 break;
6064 case PropertyNotify:
6065 last_user_time = event.xproperty.time;
6066 #if 0 /* This is plain wrong. In the case that we are waiting for a
6067 PropertyNotify used as an ACK in incremental selection
6068 transfer, the property will be on the receiver's window. */
6069 #if defined USE_X_TOOLKIT
6070 if (!x_any_window_to_frame (dpyinfo, event.xproperty.window))
6071 goto OTHER;
6072 #endif
6073 #endif
6074 x_handle_property_notify (&event.xproperty);
6075 goto OTHER;
6077 case ReparentNotify:
6078 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6079 if (f)
6081 int x, y;
6082 f->output_data.x->parent_desc = event.xreparent.parent;
6083 x_real_positions (f, &x, &y);
6084 f->left_pos = x;
6085 f->top_pos = y;
6087 /* Perhaps reparented due to a WM restart. Reset this. */
6088 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6089 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6091 goto OTHER;
6093 case Expose:
6094 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6095 if (f)
6097 x_check_fullscreen (f);
6099 #ifdef USE_GTK
6100 /* This seems to be needed for GTK 2.6. */
6101 x_clear_area (event.xexpose.display,
6102 event.xexpose.window,
6103 event.xexpose.x, event.xexpose.y,
6104 event.xexpose.width, event.xexpose.height,
6105 FALSE);
6106 #endif
6107 if (f->async_visible == 0)
6109 f->async_visible = 1;
6110 f->async_iconified = 0;
6111 f->output_data.x->has_been_visible = 1;
6112 SET_FRAME_GARBAGED (f);
6114 else
6115 expose_frame (f,
6116 event.xexpose.x, event.xexpose.y,
6117 event.xexpose.width, event.xexpose.height);
6119 else
6121 #ifndef USE_TOOLKIT_SCROLL_BARS
6122 struct scroll_bar *bar;
6123 #endif
6124 #if defined USE_LUCID
6125 /* Submenus of the Lucid menu bar aren't widgets
6126 themselves, so there's no way to dispatch events
6127 to them. Recognize this case separately. */
6129 Widget widget
6130 = x_window_to_menu_bar (event.xexpose.window);
6131 if (widget)
6132 xlwmenu_redisplay (widget);
6134 #endif /* USE_LUCID */
6136 #ifdef USE_TOOLKIT_SCROLL_BARS
6137 /* Dispatch event to the widget. */
6138 goto OTHER;
6139 #else /* not USE_TOOLKIT_SCROLL_BARS */
6140 bar = x_window_to_scroll_bar (event.xexpose.display,
6141 event.xexpose.window);
6143 if (bar)
6144 x_scroll_bar_expose (bar, &event);
6145 #ifdef USE_X_TOOLKIT
6146 else
6147 goto OTHER;
6148 #endif /* USE_X_TOOLKIT */
6149 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6151 break;
6153 case GraphicsExpose: /* This occurs when an XCopyArea's
6154 source area was obscured or not
6155 available. */
6156 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6157 if (f)
6159 expose_frame (f,
6160 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6161 event.xgraphicsexpose.width,
6162 event.xgraphicsexpose.height);
6164 #ifdef USE_X_TOOLKIT
6165 else
6166 goto OTHER;
6167 #endif /* USE_X_TOOLKIT */
6168 break;
6170 case NoExpose: /* This occurs when an XCopyArea's
6171 source area was completely
6172 available. */
6173 break;
6175 case UnmapNotify:
6176 /* Redo the mouse-highlight after the tooltip has gone. */
6177 if (event.xmap.window == tip_window)
6179 tip_window = 0;
6180 redo_mouse_highlight ();
6183 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6184 if (f) /* F may no longer exist if
6185 the frame was deleted. */
6187 /* While a frame is unmapped, display generation is
6188 disabled; you don't want to spend time updating a
6189 display that won't ever be seen. */
6190 f->async_visible = 0;
6191 /* We can't distinguish, from the event, whether the window
6192 has become iconified or invisible. So assume, if it
6193 was previously visible, than now it is iconified.
6194 But x_make_frame_invisible clears both
6195 the visible flag and the iconified flag;
6196 and that way, we know the window is not iconified now. */
6197 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6199 f->async_iconified = 1;
6201 inev.ie.kind = ICONIFY_EVENT;
6202 XSETFRAME (inev.ie.frame_or_window, f);
6205 goto OTHER;
6207 case MapNotify:
6208 if (event.xmap.window == tip_window)
6209 /* The tooltip has been drawn already. Avoid
6210 the SET_FRAME_GARBAGED below. */
6211 goto OTHER;
6213 /* We use x_top_window_to_frame because map events can
6214 come for sub-windows and they don't mean that the
6215 frame is visible. */
6216 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6217 if (f)
6219 /* wait_reading_process_output will notice this and update
6220 the frame's display structures.
6221 If we where iconified, we should not set garbaged,
6222 because that stops redrawing on Expose events. This looks
6223 bad if we are called from a recursive event loop
6224 (x_dispatch_event), for example when a dialog is up. */
6225 if (! f->async_iconified)
6226 SET_FRAME_GARBAGED (f);
6228 f->async_visible = 1;
6229 f->async_iconified = 0;
6230 f->output_data.x->has_been_visible = 1;
6232 if (f->iconified)
6234 inev.ie.kind = DEICONIFY_EVENT;
6235 XSETFRAME (inev.ie.frame_or_window, f);
6237 else if (! NILP (Vframe_list)
6238 && ! NILP (XCDR (Vframe_list)))
6239 /* Force a redisplay sooner or later
6240 to update the frame titles
6241 in case this is the second frame. */
6242 record_asynch_buffer_change ();
6244 goto OTHER;
6246 case KeyPress:
6248 last_user_time = event.xkey.time;
6249 ignore_next_mouse_click_timeout = 0;
6251 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6252 /* Dispatch KeyPress events when in menu. */
6253 if (popup_activated ())
6254 goto OTHER;
6255 #endif
6257 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6259 /* If mouse-highlight is an integer, input clears out
6260 mouse highlighting. */
6261 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6262 && (f == 0
6263 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6265 clear_mouse_face (dpyinfo);
6266 dpyinfo->mouse_face_hidden = 1;
6269 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6270 if (f == 0)
6272 /* Scroll bars consume key events, but we want
6273 the keys to go to the scroll bar's frame. */
6274 Widget widget = XtWindowToWidget (dpyinfo->display,
6275 event.xkey.window);
6276 if (widget && XmIsScrollBar (widget))
6278 widget = XtParent (widget);
6279 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6282 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6284 if (f != 0)
6286 KeySym keysym, orig_keysym;
6287 /* al%imercury@uunet.uu.net says that making this 81
6288 instead of 80 fixed a bug whereby meta chars made
6289 his Emacs hang.
6291 It seems that some version of XmbLookupString has
6292 a bug of not returning XBufferOverflow in
6293 status_return even if the input is too long to
6294 fit in 81 bytes. So, we must prepare sufficient
6295 bytes for copy_buffer. 513 bytes (256 chars for
6296 two-byte character set) seems to be a fairly good
6297 approximation. -- 2000.8.10 handa@etl.go.jp */
6298 unsigned char copy_buffer[513];
6299 unsigned char *copy_bufptr = copy_buffer;
6300 int copy_bufsiz = sizeof (copy_buffer);
6301 int modifiers;
6302 Lisp_Object coding_system = Qlatin_1;
6303 Lisp_Object c;
6305 #ifdef USE_GTK
6306 /* Don't pass keys to GTK. A Tab will shift focus to the
6307 tool bar in GTK 2.4. Keys will still go to menus and
6308 dialogs because in that case popup_activated is TRUE
6309 (see above). */
6310 *finish = X_EVENT_DROP;
6311 #endif
6313 event.xkey.state
6314 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6315 extra_keyboard_modifiers);
6316 modifiers = event.xkey.state;
6318 /* This will have to go some day... */
6320 /* make_lispy_event turns chars into control chars.
6321 Don't do it here because XLookupString is too eager. */
6322 event.xkey.state &= ~ControlMask;
6323 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6324 | dpyinfo->super_mod_mask
6325 | dpyinfo->hyper_mod_mask
6326 | dpyinfo->alt_mod_mask);
6328 /* In case Meta is ComposeCharacter,
6329 clear its status. According to Markus Ehrnsperger
6330 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6331 this enables ComposeCharacter to work whether or
6332 not it is combined with Meta. */
6333 if (modifiers & dpyinfo->meta_mod_mask)
6334 bzero (&compose_status, sizeof (compose_status));
6336 #ifdef HAVE_X_I18N
6337 if (FRAME_XIC (f))
6339 Status status_return;
6341 coding_system = Vlocale_coding_system;
6342 nbytes = XmbLookupString (FRAME_XIC (f),
6343 &event.xkey, copy_bufptr,
6344 copy_bufsiz, &keysym,
6345 &status_return);
6346 if (status_return == XBufferOverflow)
6348 copy_bufsiz = nbytes + 1;
6349 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6350 nbytes = XmbLookupString (FRAME_XIC (f),
6351 &event.xkey, copy_bufptr,
6352 copy_bufsiz, &keysym,
6353 &status_return);
6355 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6356 #if 0 && defined X_HAVE_UTF8_STRING
6357 else if (status_return == XLookupKeySym)
6358 { /* Try again but with utf-8. */
6359 coding_system = Qutf_8;
6360 nbytes = Xutf8LookupString (FRAME_XIC (f),
6361 &event.xkey, copy_bufptr,
6362 copy_bufsiz, &keysym,
6363 &status_return);
6364 if (status_return == XBufferOverflow)
6366 copy_bufsiz = nbytes + 1;
6367 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6368 nbytes = Xutf8LookupString (FRAME_XIC (f),
6369 &event.xkey,
6370 copy_bufptr,
6371 copy_bufsiz, &keysym,
6372 &status_return);
6375 #endif
6377 if (status_return == XLookupNone)
6378 break;
6379 else if (status_return == XLookupChars)
6381 keysym = NoSymbol;
6382 modifiers = 0;
6384 else if (status_return != XLookupKeySym
6385 && status_return != XLookupBoth)
6386 abort ();
6388 else
6389 nbytes = XLookupString (&event.xkey, copy_bufptr,
6390 copy_bufsiz, &keysym,
6391 &compose_status);
6392 #else
6393 nbytes = XLookupString (&event.xkey, copy_bufptr,
6394 copy_bufsiz, &keysym,
6395 &compose_status);
6396 #endif
6398 /* If not using XIM/XIC, and a compose sequence is in progress,
6399 we break here. Otherwise, chars_matched is always 0. */
6400 if (compose_status.chars_matched > 0 && nbytes == 0)
6401 break;
6403 bzero (&compose_status, sizeof (compose_status));
6404 orig_keysym = keysym;
6406 /* Common for all keysym input events. */
6407 XSETFRAME (inev.ie.frame_or_window, f);
6408 inev.ie.modifiers
6409 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6410 inev.ie.timestamp = event.xkey.time;
6412 /* First deal with keysyms which have defined
6413 translations to characters. */
6414 if (keysym >= 32 && keysym < 128)
6415 /* Avoid explicitly decoding each ASCII character. */
6417 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6418 inev.ie.code = keysym;
6419 goto done_keysym;
6422 /* Keysyms directly mapped to Unicode characters. */
6423 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6425 if (keysym < 0x01000080)
6426 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6427 else
6428 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6429 inev.ie.code = keysym & 0xFFFFFF;
6430 goto done_keysym;
6433 /* Now non-ASCII. */
6434 if (HASH_TABLE_P (Vx_keysym_table)
6435 && (NATNUMP (c = Fgethash (make_number (keysym),
6436 Vx_keysym_table,
6437 Qnil))))
6439 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6440 ? ASCII_KEYSTROKE_EVENT
6441 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6442 inev.ie.code = XFASTINT (c);
6443 goto done_keysym;
6446 /* Random non-modifier sorts of keysyms. */
6447 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6448 || keysym == XK_Delete
6449 #ifdef XK_ISO_Left_Tab
6450 || (keysym >= XK_ISO_Left_Tab
6451 && keysym <= XK_ISO_Enter)
6452 #endif
6453 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6454 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6455 #ifdef HPUX
6456 /* This recognizes the "extended function
6457 keys". It seems there's no cleaner way.
6458 Test IsModifierKey to avoid handling
6459 mode_switch incorrectly. */
6460 || ((unsigned) (keysym) >= XK_Select
6461 && (unsigned)(keysym) < XK_KP_Space)
6462 #endif
6463 #ifdef XK_dead_circumflex
6464 || orig_keysym == XK_dead_circumflex
6465 #endif
6466 #ifdef XK_dead_grave
6467 || orig_keysym == XK_dead_grave
6468 #endif
6469 #ifdef XK_dead_tilde
6470 || orig_keysym == XK_dead_tilde
6471 #endif
6472 #ifdef XK_dead_diaeresis
6473 || orig_keysym == XK_dead_diaeresis
6474 #endif
6475 #ifdef XK_dead_macron
6476 || orig_keysym == XK_dead_macron
6477 #endif
6478 #ifdef XK_dead_degree
6479 || orig_keysym == XK_dead_degree
6480 #endif
6481 #ifdef XK_dead_acute
6482 || orig_keysym == XK_dead_acute
6483 #endif
6484 #ifdef XK_dead_cedilla
6485 || orig_keysym == XK_dead_cedilla
6486 #endif
6487 #ifdef XK_dead_breve
6488 || orig_keysym == XK_dead_breve
6489 #endif
6490 #ifdef XK_dead_ogonek
6491 || orig_keysym == XK_dead_ogonek
6492 #endif
6493 #ifdef XK_dead_caron
6494 || orig_keysym == XK_dead_caron
6495 #endif
6496 #ifdef XK_dead_doubleacute
6497 || orig_keysym == XK_dead_doubleacute
6498 #endif
6499 #ifdef XK_dead_abovedot
6500 || orig_keysym == XK_dead_abovedot
6501 #endif
6502 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6503 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6504 /* Any "vendor-specific" key is ok. */
6505 || (orig_keysym & (1 << 28))
6506 || (keysym != NoSymbol && nbytes == 0))
6507 && ! (IsModifierKey (orig_keysym)
6508 /* The symbols from XK_ISO_Lock
6509 to XK_ISO_Last_Group_Lock
6510 don't have real modifiers but
6511 should be treated similarly to
6512 Mode_switch by Emacs. */
6513 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6514 || ((unsigned)(orig_keysym)
6515 >= XK_ISO_Lock
6516 && (unsigned)(orig_keysym)
6517 <= XK_ISO_Last_Group_Lock)
6518 #endif
6521 STORE_KEYSYM_FOR_DEBUG (keysym);
6522 /* make_lispy_event will convert this to a symbolic
6523 key. */
6524 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6525 inev.ie.code = keysym;
6526 goto done_keysym;
6529 { /* Raw bytes, not keysym. */
6530 register int i;
6531 register int c;
6532 int nchars, len;
6534 for (i = 0, nchars = 0; i < nbytes; i++)
6536 if (ASCII_BYTE_P (copy_bufptr[i]))
6537 nchars++;
6538 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6541 if (nchars < nbytes)
6543 /* Decode the input data. */
6544 int require;
6545 unsigned char *p;
6547 /* The input should be decoded with `coding_system'
6548 which depends on which X*LookupString function
6549 we used just above and the locale. */
6550 setup_coding_system (coding_system, &coding);
6551 coding.src_multibyte = 0;
6552 coding.dst_multibyte = 1;
6553 /* The input is converted to events, thus we can't
6554 handle composition. Anyway, there's no XIM that
6555 gives us composition information. */
6556 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6558 require = MAX_MULTIBYTE_LENGTH * nbytes;
6559 coding.destination = alloca (require);
6560 coding.dst_bytes = require;
6561 coding.mode |= CODING_MODE_LAST_BLOCK;
6562 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6563 nbytes = coding.produced;
6564 nchars = coding.produced_char;
6565 copy_bufptr = coding.destination;
6568 /* Convert the input data to a sequence of
6569 character events. */
6570 for (i = 0; i < nbytes; i += len)
6572 if (nchars == nbytes)
6573 c = copy_bufptr[i], len = 1;
6574 else
6575 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i,
6576 nbytes - i, len);
6577 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6578 ? ASCII_KEYSTROKE_EVENT
6579 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6580 inev.ie.code = c;
6581 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6584 count += nchars;
6586 inev.ie.kind = NO_EVENT; /* Already stored above. */
6588 if (keysym == NoSymbol)
6589 break;
6592 done_keysym:
6593 #ifdef HAVE_X_I18N
6594 /* Don't dispatch this event since XtDispatchEvent calls
6595 XFilterEvent, and two calls in a row may freeze the
6596 client. */
6597 break;
6598 #else
6599 goto OTHER;
6600 #endif
6602 case KeyRelease:
6603 last_user_time = event.xkey.time;
6604 #ifdef HAVE_X_I18N
6605 /* Don't dispatch this event since XtDispatchEvent calls
6606 XFilterEvent, and two calls in a row may freeze the
6607 client. */
6608 break;
6609 #else
6610 goto OTHER;
6611 #endif
6613 case EnterNotify:
6614 last_user_time = event.xcrossing.time;
6615 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6617 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6619 if (f && x_mouse_click_focus_ignore_position)
6620 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6622 #if 0
6623 if (event.xcrossing.focus)
6625 /* Avoid nasty pop/raise loops. */
6626 if (f && (!(f->auto_raise)
6627 || !(f->auto_lower)
6628 || (event.xcrossing.time - enter_timestamp) > 500))
6630 x_new_focus_frame (dpyinfo, f);
6631 enter_timestamp = event.xcrossing.time;
6634 else if (f == dpyinfo->x_focus_frame)
6635 x_new_focus_frame (dpyinfo, 0);
6636 #endif
6638 /* EnterNotify counts as mouse movement,
6639 so update things that depend on mouse position. */
6640 if (f && !f->output_data.x->hourglass_p)
6641 note_mouse_movement (f, &event.xmotion);
6642 #ifdef USE_GTK
6643 /* We may get an EnterNotify on the buttons in the toolbar. In that
6644 case we moved out of any highlighted area and need to note this. */
6645 if (!f && last_mouse_glyph_frame)
6646 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6647 #endif
6648 goto OTHER;
6650 case FocusIn:
6651 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6652 goto OTHER;
6654 case LeaveNotify:
6655 last_user_time = event.xcrossing.time;
6656 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6658 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6659 if (f)
6661 if (f == dpyinfo->mouse_face_mouse_frame)
6663 /* If we move outside the frame, then we're
6664 certainly no longer on any text in the frame. */
6665 clear_mouse_face (dpyinfo);
6666 dpyinfo->mouse_face_mouse_frame = 0;
6669 /* Generate a nil HELP_EVENT to cancel a help-echo.
6670 Do it only if there's something to cancel.
6671 Otherwise, the startup message is cleared when
6672 the mouse leaves the frame. */
6673 if (any_help_event_p)
6674 do_help = -1;
6676 #ifdef USE_GTK
6677 /* See comment in EnterNotify above */
6678 else if (last_mouse_glyph_frame)
6679 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6680 #endif
6681 goto OTHER;
6683 case FocusOut:
6684 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6685 goto OTHER;
6687 case MotionNotify:
6689 last_user_time = event.xmotion.time;
6690 previous_help_echo_string = help_echo_string;
6691 help_echo_string = Qnil;
6693 if (dpyinfo->grabbed && last_mouse_frame
6694 && FRAME_LIVE_P (last_mouse_frame))
6695 f = last_mouse_frame;
6696 else
6697 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6699 if (dpyinfo->mouse_face_hidden)
6701 dpyinfo->mouse_face_hidden = 0;
6702 clear_mouse_face (dpyinfo);
6705 if (f)
6708 /* Generate SELECT_WINDOW_EVENTs when needed. */
6709 if (!NILP (Vmouse_autoselect_window))
6711 Lisp_Object window;
6713 window = window_from_coordinates (f,
6714 event.xmotion.x, event.xmotion.y,
6715 0, 0, 0, 0);
6717 /* Window will be selected only when it is not selected now and
6718 last mouse movement event was not in it. Minibuffer window
6719 will be selected only when it is active. */
6720 if (WINDOWP (window)
6721 && !EQ (window, last_window)
6722 && !EQ (window, selected_window)
6723 /* For click-to-focus window managers
6724 create event iff we don't leave the
6725 selected frame. */
6726 && (focus_follows_mouse
6727 || (EQ (XWINDOW (window)->frame,
6728 XWINDOW (selected_window)->frame))))
6730 inev.ie.kind = SELECT_WINDOW_EVENT;
6731 inev.ie.frame_or_window = window;
6734 last_window=window;
6736 if (!note_mouse_movement (f, &event.xmotion))
6737 help_echo_string = previous_help_echo_string;
6739 else
6741 #ifndef USE_TOOLKIT_SCROLL_BARS
6742 struct scroll_bar *bar
6743 = x_window_to_scroll_bar (event.xmotion.display,
6744 event.xmotion.window);
6746 if (bar)
6747 x_scroll_bar_note_movement (bar, &event);
6748 #endif /* USE_TOOLKIT_SCROLL_BARS */
6750 /* If we move outside the frame, then we're
6751 certainly no longer on any text in the frame. */
6752 clear_mouse_face (dpyinfo);
6755 /* If the contents of the global variable help_echo_string
6756 has changed, generate a HELP_EVENT. */
6757 if (!NILP (help_echo_string)
6758 || !NILP (previous_help_echo_string))
6759 do_help = 1;
6760 goto OTHER;
6763 case ConfigureNotify:
6764 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6765 #ifdef USE_GTK
6766 if (!f
6767 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6768 && event.xconfigure.window == FRAME_X_WINDOW (f))
6770 xg_frame_resized (f, event.xconfigure.width,
6771 event.xconfigure.height);
6772 f = 0;
6774 #endif
6775 if (f)
6777 #ifndef USE_X_TOOLKIT
6778 #ifndef USE_GTK
6779 /* If there is a pending resize for fullscreen, don't
6780 do this one, the right one will come later.
6781 The toolkit version doesn't seem to need this, but we
6782 need to reset it below. */
6783 int dont_resize
6784 = ((f->want_fullscreen & FULLSCREEN_WAIT)
6785 && f->new_text_cols != 0);
6786 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6787 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6789 if (dont_resize)
6790 goto OTHER;
6792 /* In the toolkit version, change_frame_size
6793 is called by the code that handles resizing
6794 of the EmacsFrame widget. */
6796 /* Even if the number of character rows and columns has
6797 not changed, the font size may have changed, so we need
6798 to check the pixel dimensions as well. */
6799 if (columns != FRAME_COLS (f)
6800 || rows != FRAME_LINES (f)
6801 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6802 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6804 change_frame_size (f, rows, columns, 0, 1, 0);
6805 SET_FRAME_GARBAGED (f);
6806 cancel_mouse_face (f);
6809 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6810 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6811 #endif /* not USE_GTK */
6812 #endif
6814 #ifdef USE_GTK
6815 /* GTK creates windows but doesn't map them.
6816 Only get real positions and check fullscreen when mapped. */
6817 if (FRAME_GTK_OUTER_WIDGET (f)
6818 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6819 #endif
6821 x_real_positions (f, &f->left_pos, &f->top_pos);
6823 if (f->want_fullscreen & FULLSCREEN_WAIT)
6824 f->want_fullscreen &= ~(FULLSCREEN_WAIT|FULLSCREEN_BOTH);
6827 #ifdef HAVE_X_I18N
6828 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6829 xic_set_statusarea (f);
6830 #endif
6832 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
6834 /* Since the WM decorations come below top_pos now,
6835 we must put them below top_pos in the future. */
6836 f->win_gravity = NorthWestGravity;
6837 x_wm_set_size_hint (f, (long) 0, 0);
6840 goto OTHER;
6842 case ButtonRelease:
6843 case ButtonPress:
6845 /* If we decide we want to generate an event to be seen
6846 by the rest of Emacs, we put it here. */
6847 int tool_bar_p = 0;
6849 bzero (&compose_status, sizeof (compose_status));
6850 last_mouse_glyph_frame = 0;
6851 last_user_time = event.xbutton.time;
6853 if (dpyinfo->grabbed
6854 && last_mouse_frame
6855 && FRAME_LIVE_P (last_mouse_frame))
6856 f = last_mouse_frame;
6857 else
6858 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6860 if (f)
6862 /* Is this in the tool-bar? */
6863 if (WINDOWP (f->tool_bar_window)
6864 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6866 Lisp_Object window;
6867 int x = event.xbutton.x;
6868 int y = event.xbutton.y;
6870 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6871 tool_bar_p = EQ (window, f->tool_bar_window);
6873 if (tool_bar_p && event.xbutton.button < 4)
6875 handle_tool_bar_click (f, x, y,
6876 event.xbutton.type == ButtonPress,
6877 x_x_to_emacs_modifiers (dpyinfo,
6878 event.xbutton.state));
6882 if (!tool_bar_p)
6883 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6884 if (! popup_activated ())
6885 #endif
6887 if (ignore_next_mouse_click_timeout)
6889 if (event.type == ButtonPress
6890 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6892 ignore_next_mouse_click_timeout = 0;
6893 construct_mouse_click (&inev.ie, &event.xbutton, f);
6895 if (event.type == ButtonRelease)
6896 ignore_next_mouse_click_timeout = 0;
6898 else
6899 construct_mouse_click (&inev.ie, &event.xbutton, f);
6901 if (FRAME_X_EMBEDDED_P (f))
6902 xembed_send_message (f, event.xbutton.time,
6903 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6905 else
6907 struct scroll_bar *bar
6908 = x_window_to_scroll_bar (event.xbutton.display,
6909 event.xbutton.window);
6911 #ifdef USE_TOOLKIT_SCROLL_BARS
6912 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6913 scroll bars. */
6914 if (bar && event.xbutton.state & ControlMask)
6916 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6917 *finish = X_EVENT_DROP;
6919 #else /* not USE_TOOLKIT_SCROLL_BARS */
6920 if (bar)
6921 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6922 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6925 if (event.type == ButtonPress)
6927 dpyinfo->grabbed |= (1 << event.xbutton.button);
6928 last_mouse_frame = f;
6930 if (!tool_bar_p)
6931 last_tool_bar_item = -1;
6933 else
6934 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6936 /* Ignore any mouse motion that happened before this event;
6937 any subsequent mouse-movement Emacs events should reflect
6938 only motion after the ButtonPress/Release. */
6939 if (f != 0)
6940 f->mouse_moved = 0;
6942 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6943 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6944 /* For a down-event in the menu bar,
6945 don't pass it to Xt right now.
6946 Instead, save it away
6947 and we will pass it to Xt from kbd_buffer_get_event.
6948 That way, we can run some Lisp code first. */
6949 if (
6950 #ifdef USE_GTK
6951 ! popup_activated ()
6952 /* Gtk+ menus only react to the first three buttons. */
6953 && event.xbutton.button < 3
6955 #endif
6956 f && event.type == ButtonPress
6957 /* Verify the event is really within the menu bar
6958 and not just sent to it due to grabbing. */
6959 && event.xbutton.x >= 0
6960 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6961 && event.xbutton.y >= 0
6962 && event.xbutton.y < f->output_data.x->menubar_height
6963 && event.xbutton.same_screen)
6965 SET_SAVED_BUTTON_EVENT;
6966 XSETFRAME (last_mouse_press_frame, f);
6967 #ifdef USE_GTK
6968 *finish = X_EVENT_DROP;
6969 #endif
6971 else if (event.type == ButtonPress)
6973 last_mouse_press_frame = Qnil;
6974 goto OTHER;
6977 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6978 but I am trying to be cautious. */
6979 else if (event.type == ButtonRelease)
6981 if (!NILP (last_mouse_press_frame))
6983 f = XFRAME (last_mouse_press_frame);
6984 if (f->output_data.x)
6985 SET_SAVED_BUTTON_EVENT;
6987 else
6988 goto OTHER;
6990 #endif /* USE_MOTIF */
6991 else
6992 goto OTHER;
6993 #endif /* USE_X_TOOLKIT || USE_GTK */
6995 break;
6997 case CirculateNotify:
6998 goto OTHER;
7000 case CirculateRequest:
7001 goto OTHER;
7003 case VisibilityNotify:
7004 goto OTHER;
7006 case MappingNotify:
7007 /* Someone has changed the keyboard mapping - update the
7008 local cache. */
7009 switch (event.xmapping.request)
7011 case MappingModifier:
7012 x_find_modifier_meanings (dpyinfo);
7013 /* This is meant to fall through. */
7014 case MappingKeyboard:
7015 XRefreshKeyboardMapping (&event.xmapping);
7017 goto OTHER;
7019 default:
7020 OTHER:
7021 #ifdef USE_X_TOOLKIT
7022 BLOCK_INPUT;
7023 if (*finish != X_EVENT_DROP)
7024 XtDispatchEvent (&event);
7025 UNBLOCK_INPUT;
7026 #endif /* USE_X_TOOLKIT */
7027 break;
7030 done:
7031 if (inev.ie.kind != NO_EVENT)
7033 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7034 count++;
7037 if (do_help
7038 && !(hold_quit && hold_quit->kind != NO_EVENT))
7040 Lisp_Object frame;
7042 if (f)
7043 XSETFRAME (frame, f);
7044 else
7045 frame = Qnil;
7047 if (do_help > 0)
7049 any_help_event_p = 1;
7050 gen_help_event (help_echo_string, frame, help_echo_window,
7051 help_echo_object, help_echo_pos);
7053 else
7055 help_echo_string = Qnil;
7056 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7058 count++;
7061 *eventp = event;
7062 return count;
7066 /* Handles the XEvent EVENT on display DISPLAY.
7067 This is used for event loops outside the normal event handling,
7068 i.e. looping while a popup menu or a dialog is posted.
7070 Returns the value handle_one_xevent sets in the finish argument. */
7072 x_dispatch_event (event, display)
7073 XEvent *event;
7074 Display *display;
7076 struct x_display_info *dpyinfo;
7077 int finish = X_EVENT_NORMAL;
7079 dpyinfo = x_display_info_for_display (display);
7081 if (dpyinfo)
7082 handle_one_xevent (dpyinfo, event, &finish, 0);
7084 return finish;
7088 /* Read events coming from the X server.
7089 This routine is called by the SIGIO handler.
7090 We return as soon as there are no more events to be read.
7092 We return the number of characters stored into the buffer,
7093 thus pretending to be `read' (except the characters we store
7094 in the keyboard buffer can be multibyte, so are not necessarily
7095 C chars).
7097 EXPECTED is nonzero if the caller knows input is available. */
7099 static int
7100 XTread_socket (terminal, expected, hold_quit)
7101 struct terminal *terminal;
7102 int expected;
7103 struct input_event *hold_quit;
7105 int count = 0;
7106 XEvent event;
7107 int event_found = 0;
7108 #if 0
7109 struct x_display_info *dpyinfo;
7110 #endif
7112 if (interrupt_input_blocked)
7114 interrupt_input_pending = 1;
7115 return -1;
7118 interrupt_input_pending = 0;
7119 BLOCK_INPUT;
7121 /* So people can tell when we have read the available input. */
7122 input_signal_count++;
7124 ++handling_signal;
7126 #ifdef HAVE_X_SM
7127 /* Only check session manager input for the primary display. */
7128 if (terminal->id == 1 && x_session_have_connection ())
7130 struct input_event inev;
7131 BLOCK_INPUT;
7132 /* We don't need to EVENT_INIT (inev) here, as
7133 x_session_check_input copies an entire input_event. */
7134 if (x_session_check_input (&inev))
7136 kbd_buffer_store_event_hold (&inev, hold_quit);
7137 count++;
7139 UNBLOCK_INPUT;
7141 #endif
7143 /* For debugging, this gives a way to fake an I/O error. */
7144 if (terminal->display_info.x == XTread_socket_fake_io_error)
7146 XTread_socket_fake_io_error = 0;
7147 x_io_error_quitter (terminal->display_info.x->display);
7150 #if 0 /* This loop is a noop now. */
7151 /* Find the display we are supposed to read input for.
7152 It's the one communicating on descriptor SD. */
7153 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
7155 #if 0 /* This ought to be unnecessary; let's verify it. */
7156 #ifdef FIOSNBIO
7157 /* If available, Xlib uses FIOSNBIO to make the socket
7158 non-blocking, and then looks for EWOULDBLOCK. If O_NDELAY is set,
7159 FIOSNBIO is ignored, and instead of signaling EWOULDBLOCK,
7160 a read returns 0, which Xlib interprets as equivalent to EPIPE. */
7161 fcntl (dpyinfo->connection, F_SETFL, 0);
7162 #endif /* ! defined (FIOSNBIO) */
7163 #endif
7165 #if 0 /* This code can't be made to work, with multiple displays,
7166 and appears not to be used on any system any more.
7167 Also keyboard.c doesn't turn O_NDELAY on and off
7168 for X connections. */
7169 #ifndef SIGIO
7170 #ifndef HAVE_SELECT
7171 if (! (fcntl (dpyinfo->connection, F_GETFL, 0) & O_NDELAY))
7173 extern int read_alarm_should_throw;
7174 read_alarm_should_throw = 1;
7175 XPeekEvent (dpyinfo->display, &event);
7176 read_alarm_should_throw = 0;
7178 #endif /* HAVE_SELECT */
7179 #endif /* SIGIO */
7180 #endif
7182 #endif
7184 #ifndef USE_GTK
7185 while (XPending (terminal->display_info.x->display))
7187 int finish;
7189 XNextEvent (terminal->display_info.x->display, &event);
7191 #ifdef HAVE_X_I18N
7192 /* Filter events for the current X input method. */
7193 if (x_filter_event (terminal->display_info.x, &event))
7194 break;
7195 #endif
7196 event_found = 1;
7198 count += handle_one_xevent (terminal->display_info.x,
7199 &event, &finish, hold_quit);
7201 if (finish == X_EVENT_GOTO_OUT)
7202 goto out;
7205 #else /* USE_GTK */
7207 /* For GTK we must use the GTK event loop. But XEvents gets passed
7208 to our filter function above, and then to the big event switch.
7209 We use a bunch of globals to communicate with our filter function,
7210 that is kind of ugly, but it works.
7212 There is no way to do one display at the time, GTK just does events
7213 from all displays. */
7215 while (gtk_events_pending ())
7217 current_count = count;
7218 current_hold_quit = hold_quit;
7220 gtk_main_iteration ();
7222 count = current_count;
7223 current_count = -1;
7224 current_hold_quit = 0;
7226 if (current_finish == X_EVENT_GOTO_OUT)
7227 break;
7229 #endif /* USE_GTK */
7231 out:;
7233 /* On some systems, an X bug causes Emacs to get no more events
7234 when the window is destroyed. Detect that. (1994.) */
7235 if (! event_found)
7237 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7238 One XNOOP in 100 loops will make Emacs terminate.
7239 B. Bretthauer, 1994 */
7240 x_noop_count++;
7241 if (x_noop_count >= 100)
7243 x_noop_count=0;
7245 if (next_noop_dpyinfo == 0)
7246 next_noop_dpyinfo = x_display_list;
7248 XNoOp (next_noop_dpyinfo->display);
7250 /* Each time we get here, cycle through the displays now open. */
7251 next_noop_dpyinfo = next_noop_dpyinfo->next;
7255 /* If the focus was just given to an auto-raising frame,
7256 raise it now. */
7257 /* ??? This ought to be able to handle more than one such frame. */
7258 if (pending_autoraise_frame)
7260 x_raise_frame (pending_autoraise_frame);
7261 pending_autoraise_frame = 0;
7264 --handling_signal;
7265 UNBLOCK_INPUT;
7267 return count;
7273 /***********************************************************************
7274 Text Cursor
7275 ***********************************************************************/
7277 /* Set clipping for output in glyph row ROW. W is the window in which
7278 we operate. GC is the graphics context to set clipping in.
7280 ROW may be a text row or, e.g., a mode line. Text rows must be
7281 clipped to the interior of the window dedicated to text display,
7282 mode lines must be clipped to the whole window. */
7284 static void
7285 x_clip_to_row (w, row, area, gc)
7286 struct window *w;
7287 struct glyph_row *row;
7288 int area;
7289 GC gc;
7291 struct frame *f = XFRAME (WINDOW_FRAME (w));
7292 XRectangle clip_rect;
7293 int window_x, window_y, window_width;
7295 window_box (w, area, &window_x, &window_y, &window_width, 0);
7297 clip_rect.x = window_x;
7298 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7299 clip_rect.y = max (clip_rect.y, window_y);
7300 clip_rect.width = window_width;
7301 clip_rect.height = row->visible_height;
7303 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7307 /* Draw a hollow box cursor on window W in glyph row ROW. */
7309 static void
7310 x_draw_hollow_cursor (w, row)
7311 struct window *w;
7312 struct glyph_row *row;
7314 struct frame *f = XFRAME (WINDOW_FRAME (w));
7315 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7316 Display *dpy = FRAME_X_DISPLAY (f);
7317 int x, y, wd, h;
7318 XGCValues xgcv;
7319 struct glyph *cursor_glyph;
7320 GC gc;
7322 /* Get the glyph the cursor is on. If we can't tell because
7323 the current matrix is invalid or such, give up. */
7324 cursor_glyph = get_phys_cursor_glyph (w);
7325 if (cursor_glyph == NULL)
7326 return;
7328 /* Compute frame-relative coordinates for phys cursor. */
7329 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7330 wd = w->phys_cursor_width;
7332 /* The foreground of cursor_gc is typically the same as the normal
7333 background color, which can cause the cursor box to be invisible. */
7334 xgcv.foreground = f->output_data.x->cursor_pixel;
7335 if (dpyinfo->scratch_cursor_gc)
7336 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7337 else
7338 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7339 GCForeground, &xgcv);
7340 gc = dpyinfo->scratch_cursor_gc;
7342 /* Set clipping, draw the rectangle, and reset clipping again. */
7343 x_clip_to_row (w, row, TEXT_AREA, gc);
7344 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7345 XSetClipMask (dpy, gc, None);
7349 /* Draw a bar cursor on window W in glyph row ROW.
7351 Implementation note: One would like to draw a bar cursor with an
7352 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7353 Unfortunately, I didn't find a font yet that has this property set.
7354 --gerd. */
7356 static void
7357 x_draw_bar_cursor (w, row, width, kind)
7358 struct window *w;
7359 struct glyph_row *row;
7360 int width;
7361 enum text_cursor_kinds kind;
7363 struct frame *f = XFRAME (w->frame);
7364 struct glyph *cursor_glyph;
7366 /* If cursor is out of bounds, don't draw garbage. This can happen
7367 in mini-buffer windows when switching between echo area glyphs
7368 and mini-buffer. */
7369 cursor_glyph = get_phys_cursor_glyph (w);
7370 if (cursor_glyph == NULL)
7371 return;
7373 /* If on an image, draw like a normal cursor. That's usually better
7374 visible than drawing a bar, esp. if the image is large so that
7375 the bar might not be in the window. */
7376 if (cursor_glyph->type == IMAGE_GLYPH)
7378 struct glyph_row *row;
7379 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7380 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7382 else
7384 Display *dpy = FRAME_X_DISPLAY (f);
7385 Window window = FRAME_X_WINDOW (f);
7386 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7387 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7388 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7389 XGCValues xgcv;
7391 /* If the glyph's background equals the color we normally draw
7392 the bar cursor in, the bar cursor in its normal color is
7393 invisible. Use the glyph's foreground color instead in this
7394 case, on the assumption that the glyph's colors are chosen so
7395 that the glyph is legible. */
7396 if (face->background == f->output_data.x->cursor_pixel)
7397 xgcv.background = xgcv.foreground = face->foreground;
7398 else
7399 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7400 xgcv.graphics_exposures = 0;
7402 if (gc)
7403 XChangeGC (dpy, gc, mask, &xgcv);
7404 else
7406 gc = XCreateGC (dpy, window, mask, &xgcv);
7407 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7410 if (width < 0)
7411 width = FRAME_CURSOR_WIDTH (f);
7412 width = min (cursor_glyph->pixel_width, width);
7414 w->phys_cursor_width = width;
7415 x_clip_to_row (w, row, TEXT_AREA, gc);
7417 if (kind == BAR_CURSOR)
7418 XFillRectangle (dpy, window, gc,
7419 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7420 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7421 width, row->height);
7422 else
7423 XFillRectangle (dpy, window, gc,
7424 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7425 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7426 row->height - width),
7427 cursor_glyph->pixel_width,
7428 width);
7430 XSetClipMask (dpy, gc, None);
7435 /* RIF: Define cursor CURSOR on frame F. */
7437 static void
7438 x_define_frame_cursor (f, cursor)
7439 struct frame *f;
7440 Cursor cursor;
7442 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7446 /* RIF: Clear area on frame F. */
7448 static void
7449 x_clear_frame_area (f, x, y, width, height)
7450 struct frame *f;
7451 int x, y, width, height;
7453 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7454 x, y, width, height, False);
7458 /* RIF: Draw cursor on window W. */
7460 static void
7461 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7462 struct window *w;
7463 struct glyph_row *glyph_row;
7464 int x, y;
7465 int cursor_type, cursor_width;
7466 int on_p, active_p;
7468 struct frame *f = XFRAME (WINDOW_FRAME (w));
7470 if (on_p)
7472 w->phys_cursor_type = cursor_type;
7473 w->phys_cursor_on_p = 1;
7475 if (glyph_row->exact_window_width_line_p
7476 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7478 glyph_row->cursor_in_fringe_p = 1;
7479 draw_fringe_bitmap (w, glyph_row, 0);
7481 else
7482 switch (cursor_type)
7484 case HOLLOW_BOX_CURSOR:
7485 x_draw_hollow_cursor (w, glyph_row);
7486 break;
7488 case FILLED_BOX_CURSOR:
7489 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7490 break;
7492 case BAR_CURSOR:
7493 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7494 break;
7496 case HBAR_CURSOR:
7497 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7498 break;
7500 case NO_CURSOR:
7501 w->phys_cursor_width = 0;
7502 break;
7504 default:
7505 abort ();
7508 #ifdef HAVE_X_I18N
7509 if (w == XWINDOW (f->selected_window))
7510 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7511 xic_set_preeditarea (w, x, y);
7512 #endif
7515 #ifndef XFlush
7516 XFlush (FRAME_X_DISPLAY (f));
7517 #endif
7521 /* Icons. */
7523 /* Make the x-window of frame F use the gnu icon bitmap. */
7526 x_bitmap_icon (f, file)
7527 struct frame *f;
7528 Lisp_Object file;
7530 int bitmap_id;
7532 if (FRAME_X_WINDOW (f) == 0)
7533 return 1;
7535 /* Free up our existing icon bitmap and mask if any. */
7536 if (f->output_data.x->icon_bitmap > 0)
7537 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7538 f->output_data.x->icon_bitmap = 0;
7540 if (STRINGP (file))
7542 #ifdef USE_GTK
7543 /* Use gtk_window_set_icon_from_file () if available,
7544 It's not restricted to bitmaps */
7545 if (xg_set_icon (f, file))
7546 return 0;
7547 #endif /* USE_GTK */
7548 bitmap_id = x_create_bitmap_from_file (f, file);
7549 x_create_bitmap_mask (f, bitmap_id);
7551 else
7553 /* Create the GNU bitmap and mask if necessary. */
7554 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7556 int rc = -1;
7558 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7559 #ifdef USE_GTK
7560 if (xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7561 return 0;
7562 #else
7563 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7564 if (rc != -1)
7565 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7566 #endif /* USE_GTK */
7567 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
7569 /* If all else fails, use the (black and white) xbm image. */
7570 if (rc == -1)
7572 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7573 gnu_xbm_width, gnu_xbm_height);
7574 if (rc == -1)
7575 return 1;
7577 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7578 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7582 /* The first time we create the GNU bitmap and mask,
7583 this increments the ref-count one extra time.
7584 As a result, the GNU bitmap and mask are never freed.
7585 That way, we don't have to worry about allocating it again. */
7586 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7588 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7591 x_wm_set_icon_pixmap (f, bitmap_id);
7592 f->output_data.x->icon_bitmap = bitmap_id;
7594 return 0;
7598 /* Make the x-window of frame F use a rectangle with text.
7599 Use ICON_NAME as the text. */
7602 x_text_icon (f, icon_name)
7603 struct frame *f;
7604 char *icon_name;
7606 if (FRAME_X_WINDOW (f) == 0)
7607 return 1;
7610 XTextProperty text;
7611 text.value = (unsigned char *) icon_name;
7612 text.encoding = XA_STRING;
7613 text.format = 8;
7614 text.nitems = strlen (icon_name);
7615 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7618 if (f->output_data.x->icon_bitmap > 0)
7619 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7620 f->output_data.x->icon_bitmap = 0;
7621 x_wm_set_icon_pixmap (f, 0);
7623 return 0;
7626 #define X_ERROR_MESSAGE_SIZE 200
7628 /* If non-nil, this should be a string.
7629 It means catch X errors and store the error message in this string.
7631 The reason we use a stack is that x_catch_error/x_uncatch_error can
7632 be called from a signal handler.
7635 struct x_error_message_stack {
7636 char string[X_ERROR_MESSAGE_SIZE];
7637 Display *dpy;
7638 struct x_error_message_stack *prev;
7640 static struct x_error_message_stack *x_error_message;
7642 /* An X error handler which stores the error message in
7643 *x_error_message. This is called from x_error_handler if
7644 x_catch_errors is in effect. */
7646 static void
7647 x_error_catcher (display, error)
7648 Display *display;
7649 XErrorEvent *error;
7651 XGetErrorText (display, error->error_code,
7652 x_error_message->string,
7653 X_ERROR_MESSAGE_SIZE);
7656 /* Begin trapping X errors for display DPY. Actually we trap X errors
7657 for all displays, but DPY should be the display you are actually
7658 operating on.
7660 After calling this function, X protocol errors no longer cause
7661 Emacs to exit; instead, they are recorded in the string
7662 stored in *x_error_message.
7664 Calling x_check_errors signals an Emacs error if an X error has
7665 occurred since the last call to x_catch_errors or x_check_errors.
7667 Calling x_uncatch_errors resumes the normal error handling. */
7669 void x_check_errors ();
7671 void
7672 x_catch_errors (dpy)
7673 Display *dpy;
7675 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7677 /* Make sure any errors from previous requests have been dealt with. */
7678 XSync (dpy, False);
7680 data->dpy = dpy;
7681 data->string[0] = 0;
7682 data->prev = x_error_message;
7683 x_error_message = data;
7686 /* Undo the last x_catch_errors call.
7687 DPY should be the display that was passed to x_catch_errors. */
7689 void
7690 x_uncatch_errors ()
7692 struct x_error_message_stack *tmp;
7694 BLOCK_INPUT;
7696 /* The display may have been closed before this function is called.
7697 Check if it is still open before calling XSync. */
7698 if (x_display_info_for_display (x_error_message->dpy) != 0)
7699 XSync (x_error_message->dpy, False);
7701 tmp = x_error_message;
7702 x_error_message = x_error_message->prev;
7703 xfree (tmp);
7704 UNBLOCK_INPUT;
7707 /* If any X protocol errors have arrived since the last call to
7708 x_catch_errors or x_check_errors, signal an Emacs error using
7709 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7711 void
7712 x_check_errors (dpy, format)
7713 Display *dpy;
7714 char *format;
7716 /* Make sure to catch any errors incurred so far. */
7717 XSync (dpy, False);
7719 if (x_error_message->string[0])
7721 char string[X_ERROR_MESSAGE_SIZE];
7722 bcopy (x_error_message->string, string, X_ERROR_MESSAGE_SIZE);
7723 x_uncatch_errors ();
7724 error (format, string);
7728 /* Nonzero if we had any X protocol errors
7729 since we did x_catch_errors on DPY. */
7732 x_had_errors_p (dpy)
7733 Display *dpy;
7735 /* Make sure to catch any errors incurred so far. */
7736 XSync (dpy, False);
7738 return x_error_message->string[0] != 0;
7741 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7743 void
7744 x_clear_errors (dpy)
7745 Display *dpy;
7747 x_error_message->string[0] = 0;
7750 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7751 * idea. --lorentey */
7752 /* Close off all unclosed x_catch_errors calls. */
7754 void
7755 x_fully_uncatch_errors ()
7757 while (x_error_message)
7758 x_uncatch_errors ();
7760 #endif
7762 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7765 x_catching_errors ()
7767 return x_error_message != 0;
7770 #if 0
7771 static unsigned int x_wire_count;
7772 x_trace_wire ()
7774 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7776 #endif /* ! 0 */
7779 /* Handle SIGPIPE, which can happen when the connection to a server
7780 simply goes away. SIGPIPE is handled by x_connection_signal.
7781 Don't need to do anything, because the write which caused the
7782 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7783 which will do the appropriate cleanup for us. */
7785 static SIGTYPE
7786 x_connection_signal (signalnum) /* If we don't have an argument, */
7787 int signalnum; /* some compilers complain in signal calls. */
7789 #ifdef USG
7790 /* USG systems forget handlers when they are used;
7791 must reestablish each time */
7792 signal (signalnum, x_connection_signal);
7793 #endif /* USG */
7797 /************************************************************************
7798 Handling X errors
7799 ************************************************************************/
7801 /* Error message passed to x_connection_closed. */
7803 static char *error_msg;
7805 /* Function installed as fatal_error_signal_hook in
7806 x_connection_closed. Print the X error message, and exit normally,
7807 instead of dumping core when XtCloseDisplay fails. */
7809 static void
7810 x_fatal_error_signal ()
7812 fprintf (stderr, "%s\n", error_msg);
7813 exit (70);
7816 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7817 the text of an error message that lead to the connection loss. */
7819 static SIGTYPE
7820 x_connection_closed (dpy, error_message)
7821 Display *dpy;
7822 char *error_message;
7824 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7825 Lisp_Object frame, tail;
7826 int index = SPECPDL_INDEX ();
7828 error_msg = (char *) alloca (strlen (error_message) + 1);
7829 strcpy (error_msg, error_message);
7830 handling_signal = 0;
7832 /* Prevent being called recursively because of an error condition
7833 below. Otherwise, we might end up with printing ``can't find per
7834 display information'' in the recursive call instead of printing
7835 the original message here. */
7836 x_catch_errors (dpy);
7838 /* Inhibit redisplay while frames are being deleted. */
7839 specbind (Qinhibit_redisplay, Qt);
7841 if (dpyinfo)
7843 /* Protect display from being closed when we delete the last
7844 frame on it. */
7845 dpyinfo->reference_count++;
7846 dpyinfo->terminal->reference_count++;
7849 /* First delete frames whose mini-buffers are on frames
7850 that are on the dead display. */
7851 FOR_EACH_FRAME (tail, frame)
7853 Lisp_Object minibuf_frame;
7854 minibuf_frame
7855 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7856 if (FRAME_X_P (XFRAME (frame))
7857 && FRAME_X_P (XFRAME (minibuf_frame))
7858 && ! EQ (frame, minibuf_frame)
7859 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7860 Fdelete_frame (frame, Qnoelisp);
7863 /* Now delete all remaining frames on the dead display.
7864 We are now sure none of these is used as the mini-buffer
7865 for another frame that we need to delete. */
7866 FOR_EACH_FRAME (tail, frame)
7867 if (FRAME_X_P (XFRAME (frame))
7868 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7870 /* Set this to t so that Fdelete_frame won't get confused
7871 trying to find a replacement. */
7872 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7873 Fdelete_frame (frame, Qnoelisp);
7876 /* We have to close the display to inform Xt that it doesn't
7877 exist anymore. If we don't, Xt will continue to wait for
7878 events from the display. As a consequence, a sequence of
7880 M-x make-frame-on-display RET :1 RET
7881 ...kill the new frame, so that we get an IO error...
7882 M-x make-frame-on-display RET :1 RET
7884 will indefinitely wait in Xt for events for display `:1', opened
7885 in the first call to make-frame-on-display.
7887 Closing the display is reported to lead to a bus error on
7888 OpenWindows in certain situations. I suspect that is a bug
7889 in OpenWindows. I don't know how to circumvent it here. */
7891 if (dpyinfo)
7893 #ifdef USE_X_TOOLKIT
7894 /* If DPYINFO is null, this means we didn't open the display
7895 in the first place, so don't try to close it. */
7897 extern void (*fatal_error_signal_hook) P_ ((void));
7898 fatal_error_signal_hook = x_fatal_error_signal;
7899 XtCloseDisplay (dpy);
7900 fatal_error_signal_hook = NULL;
7902 #endif
7904 #ifdef USE_GTK
7905 /* Due to bugs in some Gtk+ versions, just exit here if this
7906 is the last display/terminal. */
7907 if (terminal_list->next_terminal == NULL)
7909 fprintf (stderr, "%s\n", error_msg);
7910 shut_down_emacs (0, 0, Qnil);
7911 exit (70);
7913 xg_display_close (dpyinfo->display);
7914 #endif
7916 /* Indicate that this display is dead. */
7917 dpyinfo->display = 0;
7919 dpyinfo->reference_count--;
7920 dpyinfo->terminal->reference_count--;
7921 if (dpyinfo->reference_count != 0)
7922 /* We have just closed all frames on this display. */
7923 abort ();
7926 Lisp_Object tmp;
7927 XSETTERMINAL (tmp, dpyinfo->terminal);
7928 Fdelete_terminal (tmp, Qnoelisp);
7932 x_uncatch_errors ();
7934 if (terminal_list == 0)
7936 fprintf (stderr, "%s\n", error_msg);
7937 shut_down_emacs (0, 0, Qnil);
7938 exit (70);
7941 /* Ordinary stack unwind doesn't deal with these. */
7942 #ifdef SIGIO
7943 sigunblock (sigmask (SIGIO));
7944 #endif
7945 sigunblock (sigmask (SIGALRM));
7946 TOTALLY_UNBLOCK_INPUT;
7948 unbind_to (index, Qnil);
7949 clear_waiting_for_input ();
7950 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7951 longjmp), because returning from this function would get us back into
7952 Xlib's code which will directly call `exit'. */
7953 error ("%s", error_msg);
7956 /* We specifically use it before defining it, so that gcc doesn't inline it,
7957 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7958 static void x_error_quitter P_ ((Display *, XErrorEvent *));
7960 /* This is the first-level handler for X protocol errors.
7961 It calls x_error_quitter or x_error_catcher. */
7963 static int
7964 x_error_handler (display, error)
7965 Display *display;
7966 XErrorEvent *error;
7968 if (x_error_message)
7969 x_error_catcher (display, error);
7970 else
7971 x_error_quitter (display, error);
7972 return 0;
7975 /* This is the usual handler for X protocol errors.
7976 It kills all frames on the display that we got the error for.
7977 If that was the only one, it prints an error message and kills Emacs. */
7979 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7981 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7982 #define NO_INLINE __attribute__((noinline))
7983 #else
7984 #define NO_INLINE
7985 #endif
7987 /* Some versions of GNU/Linux define noinline in their headers. */
7989 #ifdef noinline
7990 #undef noinline
7991 #endif
7993 /* On older GCC versions, just putting x_error_quitter
7994 after x_error_handler prevents inlining into the former. */
7996 static void NO_INLINE
7997 x_error_quitter (display, error)
7998 Display *display;
7999 XErrorEvent *error;
8001 char buf[256], buf1[356];
8003 /* Ignore BadName errors. They can happen because of fonts
8004 or colors that are not defined. */
8006 if (error->error_code == BadName)
8007 return;
8009 /* Note that there is no real way portable across R3/R4 to get the
8010 original error handler. */
8012 XGetErrorText (display, error->error_code, buf, sizeof (buf));
8013 sprintf (buf1, "X protocol error: %s on protocol request %d",
8014 buf, error->request_code);
8015 x_connection_closed (display, buf1);
8019 /* This is the handler for X IO errors, always.
8020 It kills all frames on the display that we lost touch with.
8021 If that was the only one, it prints an error message and kills Emacs. */
8023 static int
8024 x_io_error_quitter (display)
8025 Display *display;
8027 char buf[256];
8029 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
8030 x_connection_closed (display, buf);
8031 return 0;
8034 /* Changing the font of the frame. */
8036 /* Give frame F the font FONT-OBJECT as its default font. The return
8037 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
8038 frame. If it is negative, generate a new fontset from
8039 FONT-OBJECT. */
8041 Lisp_Object
8042 x_new_font (f, font_object, fontset)
8043 struct frame *f;
8044 Lisp_Object font_object;
8045 int fontset;
8047 struct font *font = XFONT_OBJECT (font_object);
8049 if (fontset < 0)
8050 fontset = fontset_from_font (font_object);
8051 FRAME_FONTSET (f) = fontset;
8052 if (FRAME_FONT (f) == font)
8053 /* This font is already set in frame F. There's nothing more to
8054 do. */
8055 return font_object;
8057 FRAME_FONT (f) = font;
8058 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
8059 FRAME_COLUMN_WIDTH (f) = font->average_width;
8060 FRAME_SPACE_WIDTH (f) = font->space_width;
8061 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
8063 compute_fringe_widths (f, 1);
8065 /* Compute the scroll bar width in character columns. */
8066 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
8068 int wid = FRAME_COLUMN_WIDTH (f);
8069 FRAME_CONFIG_SCROLL_BAR_COLS (f)
8070 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
8072 else
8074 int wid = FRAME_COLUMN_WIDTH (f);
8075 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
8078 if (FRAME_X_WINDOW (f) != 0)
8080 /* Don't change the size of a tip frame; there's no point in
8081 doing it because it's done in Fx_show_tip, and it leads to
8082 problems because the tip frame has no widget. */
8083 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8084 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
8087 #ifdef HAVE_X_I18N
8088 if (FRAME_XIC (f)
8089 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
8091 BLOCK_INPUT;
8092 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
8093 UNBLOCK_INPUT;
8095 #endif
8097 return font_object;
8101 /***********************************************************************
8102 X Input Methods
8103 ***********************************************************************/
8105 #ifdef HAVE_X_I18N
8107 #ifdef HAVE_X11R6
8109 /* XIM destroy callback function, which is called whenever the
8110 connection to input method XIM dies. CLIENT_DATA contains a
8111 pointer to the x_display_info structure corresponding to XIM. */
8113 static void
8114 xim_destroy_callback (xim, client_data, call_data)
8115 XIM xim;
8116 XPointer client_data;
8117 XPointer call_data;
8119 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8120 Lisp_Object frame, tail;
8122 BLOCK_INPUT;
8124 /* No need to call XDestroyIC.. */
8125 FOR_EACH_FRAME (tail, frame)
8127 struct frame *f = XFRAME (frame);
8128 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8130 FRAME_XIC (f) = NULL;
8131 xic_free_xfontset (f);
8135 /* No need to call XCloseIM. */
8136 dpyinfo->xim = NULL;
8137 XFree (dpyinfo->xim_styles);
8138 UNBLOCK_INPUT;
8141 #endif /* HAVE_X11R6 */
8143 #ifdef HAVE_X11R6
8144 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8145 extern char *XSetIMValues P_ ((XIM, ...));
8146 #endif
8148 /* Open the connection to the XIM server on display DPYINFO.
8149 RESOURCE_NAME is the resource name Emacs uses. */
8151 static void
8152 xim_open_dpy (dpyinfo, resource_name)
8153 struct x_display_info *dpyinfo;
8154 char *resource_name;
8156 XIM xim;
8158 #ifdef HAVE_XIM
8159 if (use_xim)
8161 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8162 EMACS_CLASS);
8163 dpyinfo->xim = xim;
8165 if (xim)
8167 #ifdef HAVE_X11R6
8168 XIMCallback destroy;
8169 #endif
8171 /* Get supported styles and XIM values. */
8172 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8174 #ifdef HAVE_X11R6
8175 destroy.callback = xim_destroy_callback;
8176 destroy.client_data = (XPointer)dpyinfo;
8177 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8178 #endif
8182 else
8183 #endif /* HAVE_XIM */
8184 dpyinfo->xim = NULL;
8188 #ifdef HAVE_X11R6_XIM
8190 struct xim_inst_t
8192 struct x_display_info *dpyinfo;
8193 char *resource_name;
8196 /* XIM instantiate callback function, which is called whenever an XIM
8197 server is available. DISPLAY is the display of the XIM.
8198 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8199 when the callback was registered. */
8201 static void
8202 xim_instantiate_callback (display, client_data, call_data)
8203 Display *display;
8204 XPointer client_data;
8205 XPointer call_data;
8207 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8208 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8210 /* We don't support multiple XIM connections. */
8211 if (dpyinfo->xim)
8212 return;
8214 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8216 /* Create XIC for the existing frames on the same display, as long
8217 as they have no XIC. */
8218 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8220 Lisp_Object tail, frame;
8222 BLOCK_INPUT;
8223 FOR_EACH_FRAME (tail, frame)
8225 struct frame *f = XFRAME (frame);
8227 if (FRAME_X_P (f)
8228 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8229 if (FRAME_XIC (f) == NULL)
8231 create_frame_xic (f);
8232 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8233 xic_set_statusarea (f);
8234 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8236 struct window *w = XWINDOW (f->selected_window);
8237 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8242 UNBLOCK_INPUT;
8246 #endif /* HAVE_X11R6_XIM */
8249 /* Open a connection to the XIM server on display DPYINFO.
8250 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8251 connection only at the first time. On X11R6, open the connection
8252 in the XIM instantiate callback function. */
8254 static void
8255 xim_initialize (dpyinfo, resource_name)
8256 struct x_display_info *dpyinfo;
8257 char *resource_name;
8259 #ifdef HAVE_XIM
8260 if (use_xim)
8262 #ifdef HAVE_X11R6_XIM
8263 struct xim_inst_t *xim_inst;
8264 int len;
8266 dpyinfo->xim = NULL;
8267 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8268 xim_inst->dpyinfo = dpyinfo;
8269 len = strlen (resource_name);
8270 xim_inst->resource_name = (char *) xmalloc (len + 1);
8271 bcopy (resource_name, xim_inst->resource_name, len + 1);
8272 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8273 resource_name, EMACS_CLASS,
8274 xim_instantiate_callback,
8275 /* This is XPointer in XFree86
8276 but (XPointer *) on Tru64, at
8277 least, hence the configure test. */
8278 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8279 #else /* not HAVE_X11R6_XIM */
8280 dpyinfo->xim = NULL;
8281 xim_open_dpy (dpyinfo, resource_name);
8282 #endif /* not HAVE_X11R6_XIM */
8285 else
8286 #endif /* HAVE_XIM */
8287 dpyinfo->xim = NULL;
8291 /* Close the connection to the XIM server on display DPYINFO. */
8293 static void
8294 xim_close_dpy (dpyinfo)
8295 struct x_display_info *dpyinfo;
8297 #ifdef HAVE_XIM
8298 if (use_xim)
8300 #ifdef HAVE_X11R6_XIM
8301 if (dpyinfo->display)
8302 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8303 NULL, EMACS_CLASS,
8304 xim_instantiate_callback, NULL);
8305 #endif /* not HAVE_X11R6_XIM */
8306 if (dpyinfo->display)
8307 XCloseIM (dpyinfo->xim);
8308 dpyinfo->xim = NULL;
8309 XFree (dpyinfo->xim_styles);
8311 #endif /* HAVE_XIM */
8314 #endif /* not HAVE_X11R6_XIM */
8318 /* Calculate the absolute position in frame F
8319 from its current recorded position values and gravity. */
8321 void
8322 x_calc_absolute_position (f)
8323 struct frame *f;
8325 int flags = f->size_hint_flags;
8327 /* We have nothing to do if the current position
8328 is already for the top-left corner. */
8329 if (! ((flags & XNegative) || (flags & YNegative)))
8330 return;
8332 /* Treat negative positions as relative to the leftmost bottommost
8333 position that fits on the screen. */
8334 if (flags & XNegative)
8335 f->left_pos = (FRAME_X_DISPLAY_INFO (f)->width
8336 - FRAME_PIXEL_WIDTH (f) + f->left_pos);
8339 int height = FRAME_PIXEL_HEIGHT (f);
8341 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8342 /* Something is fishy here. When using Motif, starting Emacs with
8343 `-g -0-0', the frame appears too low by a few pixels.
8345 This seems to be so because initially, while Emacs is starting,
8346 the column widget's height and the frame's pixel height are
8347 different. The column widget's height is the right one. In
8348 later invocations, when Emacs is up, the frame's pixel height
8349 is right, though.
8351 It's not obvious where the initial small difference comes from.
8352 2000-12-01, gerd. */
8354 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8355 #endif
8357 if (flags & YNegative)
8358 f->top_pos = (FRAME_X_DISPLAY_INFO (f)->height - height + f->top_pos);
8361 /* The left_pos and top_pos
8362 are now relative to the top and left screen edges,
8363 so the flags should correspond. */
8364 f->size_hint_flags &= ~ (XNegative | YNegative);
8367 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8368 to really change the position, and 0 when calling from
8369 x_make_frame_visible (in that case, XOFF and YOFF are the current
8370 position values). It is -1 when calling from x_set_frame_parameters,
8371 which means, do adjust for borders but don't change the gravity. */
8373 void
8374 x_set_offset (f, xoff, yoff, change_gravity)
8375 struct frame *f;
8376 register int xoff, yoff;
8377 int change_gravity;
8379 int modified_top, modified_left;
8381 if (change_gravity > 0)
8383 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8384 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8386 f->top_pos = yoff;
8387 f->left_pos = xoff;
8388 f->size_hint_flags &= ~ (XNegative | YNegative);
8389 if (xoff < 0)
8390 f->size_hint_flags |= XNegative;
8391 if (yoff < 0)
8392 f->size_hint_flags |= YNegative;
8393 f->win_gravity = NorthWestGravity;
8395 x_calc_absolute_position (f);
8397 BLOCK_INPUT;
8398 x_wm_set_size_hint (f, (long) 0, 0);
8400 modified_left = f->left_pos;
8401 modified_top = f->top_pos;
8403 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8405 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8406 than the WM decorations. So we use the calculated offset instead
8407 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8408 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8409 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8412 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8413 modified_left, modified_top);
8415 x_sync_with_move (f, f->left_pos, f->top_pos,
8416 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8417 ? 1 : 0);
8419 /* change_gravity is non-zero when this function is called from Lisp to
8420 programmatically move a frame. In that case, we call
8421 x_check_expected_move to discover if we have a "Type A" or "Type B"
8422 window manager, and, for a "Type A" window manager, adjust the position
8423 of the frame.
8425 We call x_check_expected_move if a programmatic move occurred, and
8426 either the window manager type (A/B) is unknown or it is Type A but we
8427 need to compute the top/left offset adjustment for this frame. */
8429 if (change_gravity != 0 &&
8430 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8431 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8432 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8433 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8434 x_check_expected_move (f, modified_left, modified_top);
8436 UNBLOCK_INPUT;
8439 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8440 on the root window for frame F contains ATOMNAME.
8441 This is how a WM check shall be done according to the Window Manager
8442 Specification/Extended Window Manager Hints at
8443 http://freedesktop.org/wiki/Specifications/wm-spec. */
8445 static int
8446 wm_supports (f, atomname)
8447 struct frame *f;
8448 const char *atomname;
8450 Atom actual_type;
8451 unsigned long actual_size, bytes_remaining;
8452 int i, rc, actual_format;
8453 Atom prop_atom;
8454 Window wmcheck_window;
8455 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8456 Window target_window = dpyinfo->root_window;
8457 long max_len = 65536;
8458 Display *dpy = FRAME_X_DISPLAY (f);
8459 unsigned char *tmp_data = NULL;
8460 Atom target_type = XA_WINDOW;
8461 Atom want_atom;
8463 BLOCK_INPUT;
8465 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8467 x_catch_errors (dpy);
8468 rc = XGetWindowProperty (dpy, target_window,
8469 prop_atom, 0, max_len, False, target_type,
8470 &actual_type, &actual_format, &actual_size,
8471 &bytes_remaining, &tmp_data);
8473 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8475 if (tmp_data) XFree (tmp_data);
8476 x_uncatch_errors ();
8477 UNBLOCK_INPUT;
8478 return 0;
8481 wmcheck_window = *(Window *) tmp_data;
8482 XFree (tmp_data);
8484 /* Check if window exists. */
8485 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8486 x_sync (f);
8487 if (x_had_errors_p (dpy))
8489 x_uncatch_errors ();
8490 UNBLOCK_INPUT;
8491 return 0;
8494 if (dpyinfo->net_supported_window != wmcheck_window)
8496 /* Window changed, reload atoms */
8497 if (dpyinfo->net_supported_atoms != NULL)
8498 XFree (dpyinfo->net_supported_atoms);
8499 dpyinfo->net_supported_atoms = NULL;
8500 dpyinfo->nr_net_supported_atoms = 0;
8501 dpyinfo->net_supported_window = 0;
8503 target_type = XA_ATOM;
8504 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8505 tmp_data = NULL;
8506 rc = XGetWindowProperty (dpy, target_window,
8507 prop_atom, 0, max_len, False, target_type,
8508 &actual_type, &actual_format, &actual_size,
8509 &bytes_remaining, &tmp_data);
8511 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8513 if (tmp_data) XFree (tmp_data);
8514 x_uncatch_errors ();
8515 UNBLOCK_INPUT;
8516 return 0;
8519 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8520 dpyinfo->nr_net_supported_atoms = actual_size;
8521 dpyinfo->net_supported_window = wmcheck_window;
8524 rc = 0;
8525 want_atom = XInternAtom (dpy, atomname, False);
8527 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8528 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8530 x_uncatch_errors ();
8531 UNBLOCK_INPUT;
8533 return rc;
8536 /* Do fullscreen as specified in extended window manager hints */
8538 static int
8539 do_ewmh_fullscreen (f)
8540 struct frame *f;
8542 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8544 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8545 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8546 if (!have_net_atom)
8547 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8549 if (have_net_atom)
8551 Lisp_Object frame;
8552 const char *atom = "_NET_WM_STATE";
8553 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8554 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8555 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8556 const char *what = NULL;
8558 XSETFRAME (frame, f);
8560 /* If there are _NET_ atoms we assume we have extended window manager
8561 hints. */
8562 switch (f->want_fullscreen)
8564 case FULLSCREEN_BOTH:
8565 what = fs;
8566 break;
8567 case FULLSCREEN_WIDTH:
8568 what = fw;
8569 break;
8570 case FULLSCREEN_HEIGHT:
8571 what = fh;
8572 break;
8575 if (what != NULL && !wm_supports (f, what)) return 0;
8578 Fx_send_client_event (frame, make_number (0), frame,
8579 make_unibyte_string (atom, strlen (atom)),
8580 make_number (32),
8581 Fcons (make_number (0), /* Remove */
8582 Fcons
8583 (make_unibyte_string (fs,
8584 strlen (fs)),
8585 Qnil)));
8586 Fx_send_client_event (frame, make_number (0), frame,
8587 make_unibyte_string (atom, strlen (atom)),
8588 make_number (32),
8589 Fcons (make_number (0), /* Remove */
8590 Fcons
8591 (make_unibyte_string (fh,
8592 strlen (fh)),
8593 Qnil)));
8594 Fx_send_client_event (frame, make_number (0), frame,
8595 make_unibyte_string (atom, strlen (atom)),
8596 make_number (32),
8597 Fcons (make_number (0), /* Remove */
8598 Fcons
8599 (make_unibyte_string (fw,
8600 strlen (fw)),
8601 Qnil)));
8602 f->want_fullscreen = FULLSCREEN_NONE;
8603 if (what != NULL)
8604 Fx_send_client_event (frame, make_number (0), frame,
8605 make_unibyte_string (atom, strlen (atom)),
8606 make_number (32),
8607 Fcons (make_number (1), /* Add */
8608 Fcons
8609 (make_unibyte_string (what,
8610 strlen (what)),
8611 Qnil)));
8614 return have_net_atom;
8617 static void
8618 XTfullscreen_hook (f)
8619 FRAME_PTR f;
8621 if (f->async_visible)
8623 BLOCK_INPUT;
8624 do_ewmh_fullscreen (f);
8625 x_sync (f);
8626 UNBLOCK_INPUT;
8631 /* Check if we need to resize the frame due to a fullscreen request.
8632 If so needed, resize the frame. */
8633 static void
8634 x_check_fullscreen (f)
8635 struct frame *f;
8637 if (f->want_fullscreen & FULLSCREEN_BOTH)
8639 int width, height, ign;
8641 if (do_ewmh_fullscreen (f))
8642 return;
8644 x_real_positions (f, &f->left_pos, &f->top_pos);
8646 x_fullscreen_adjust (f, &width, &height, &ign, &ign);
8648 /* We do not need to move the window, it shall be taken care of
8649 when setting WM manager hints.
8650 If the frame is visible already, the position is checked by
8651 x_check_expected_move. */
8652 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8654 change_frame_size (f, height, width, 0, 1, 0);
8655 SET_FRAME_GARBAGED (f);
8656 cancel_mouse_face (f);
8658 /* Wait for the change of frame size to occur */
8659 f->want_fullscreen |= FULLSCREEN_WAIT;
8664 /* This function is called by x_set_offset to determine whether the window
8665 manager interfered with the positioning of the frame. Type A window
8666 managers position the surrounding window manager decorations a small
8667 amount above and left of the user-supplied position. Type B window
8668 managers position the surrounding window manager decorations at the
8669 user-specified position. If we detect a Type A window manager, we
8670 compensate by moving the window right and down by the proper amount. */
8672 static void
8673 x_check_expected_move (f, expected_left, expected_top)
8674 struct frame *f;
8675 int expected_left;
8676 int expected_top;
8678 int current_left = 0, current_top = 0;
8680 /* x_real_positions returns the left and top offsets of the outermost
8681 window manager window around the frame. */
8683 x_real_positions (f, &current_left, &current_top);
8685 if (current_left != expected_left || current_top != expected_top)
8687 /* It's a "Type A" window manager. */
8689 int adjusted_left;
8690 int adjusted_top;
8692 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8693 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8694 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8696 /* Now fix the mispositioned frame's location. */
8698 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8699 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8701 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8702 adjusted_left, adjusted_top);
8704 x_sync_with_move (f, expected_left, expected_top, 0);
8706 else
8707 /* It's a "Type B" window manager. We don't have to adjust the
8708 frame's position. */
8710 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8714 /* Wait for XGetGeometry to return up-to-date position information for a
8715 recently-moved frame. Call this immediately after calling XMoveWindow.
8716 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8717 frame has been moved to, so we use a fuzzy position comparison instead
8718 of an exact comparison. */
8720 static void
8721 x_sync_with_move (f, left, top, fuzzy)
8722 struct frame *f;
8723 int left, top, fuzzy;
8725 int count = 0;
8727 while (count++ < 50)
8729 int current_left = 0, current_top = 0;
8731 /* In theory, this call to XSync only needs to happen once, but in
8732 practice, it doesn't seem to work, hence the need for the surrounding
8733 loop. */
8735 XSync (FRAME_X_DISPLAY (f), False);
8736 x_real_positions (f, &current_left, &current_top);
8738 if (fuzzy)
8740 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8741 pixels. */
8743 if (eabs (current_left - left) <= 10
8744 && eabs (current_top - top) <= 40)
8745 return;
8747 else if (current_left == left && current_top == top)
8748 return;
8751 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8752 will then return up-to-date position info. */
8754 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8758 /* Change the size of frame F's X window to COLS/ROWS in the case F
8759 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8760 top-left-corner window gravity for this size change and subsequent
8761 size changes. Otherwise we leave the window gravity unchanged. */
8763 static void
8764 x_set_window_size_1 (f, change_gravity, cols, rows)
8765 struct frame *f;
8766 int change_gravity;
8767 int cols, rows;
8769 int pixelwidth, pixelheight;
8771 check_frame_size (f, &rows, &cols);
8772 f->scroll_bar_actual_width
8773 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8775 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8776 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8777 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8779 compute_fringe_widths (f, 0);
8781 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8782 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
8784 f->win_gravity = NorthWestGravity;
8785 x_wm_set_size_hint (f, (long) 0, 0);
8787 XSync (FRAME_X_DISPLAY (f), False);
8788 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8789 pixelwidth, pixelheight);
8791 /* Now, strictly speaking, we can't be sure that this is accurate,
8792 but the window manager will get around to dealing with the size
8793 change request eventually, and we'll hear how it went when the
8794 ConfigureNotify event gets here.
8796 We could just not bother storing any of this information here,
8797 and let the ConfigureNotify event set everything up, but that
8798 might be kind of confusing to the Lisp code, since size changes
8799 wouldn't be reported in the frame parameters until some random
8800 point in the future when the ConfigureNotify event arrives.
8802 We pass 1 for DELAY since we can't run Lisp code inside of
8803 a BLOCK_INPUT. */
8804 change_frame_size (f, rows, cols, 0, 1, 0);
8805 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8806 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8808 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8809 receive in the ConfigureNotify event; if we get what we asked
8810 for, then the event won't cause the screen to become garbaged, so
8811 we have to make sure to do it here. */
8812 SET_FRAME_GARBAGED (f);
8814 XFlush (FRAME_X_DISPLAY (f));
8818 /* Call this to change the size of frame F's x-window.
8819 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8820 for this size change and subsequent size changes.
8821 Otherwise we leave the window gravity unchanged. */
8823 void
8824 x_set_window_size (f, change_gravity, cols, rows)
8825 struct frame *f;
8826 int change_gravity;
8827 int cols, rows;
8829 BLOCK_INPUT;
8831 #ifdef USE_GTK
8832 if (FRAME_GTK_WIDGET (f))
8833 xg_frame_set_char_size (f, cols, rows);
8834 else
8835 x_set_window_size_1 (f, change_gravity, cols, rows);
8836 #elif USE_X_TOOLKIT
8838 if (f->output_data.x->widget != NULL)
8840 /* The x and y position of the widget is clobbered by the
8841 call to XtSetValues within EmacsFrameSetCharSize.
8842 This is a real kludge, but I don't understand Xt so I can't
8843 figure out a correct fix. Can anyone else tell me? -- rms. */
8844 int xpos = f->output_data.x->widget->core.x;
8845 int ypos = f->output_data.x->widget->core.y;
8846 EmacsFrameSetCharSize (f->output_data.x->edit_widget, cols, rows);
8847 f->output_data.x->widget->core.x = xpos;
8848 f->output_data.x->widget->core.y = ypos;
8850 else
8851 x_set_window_size_1 (f, change_gravity, cols, rows);
8853 #else /* not USE_X_TOOLKIT */
8855 x_set_window_size_1 (f, change_gravity, cols, rows);
8857 #endif /* not USE_X_TOOLKIT */
8859 /* If cursor was outside the new size, mark it as off. */
8860 mark_window_cursors_off (XWINDOW (f->root_window));
8862 /* Clear out any recollection of where the mouse highlighting was,
8863 since it might be in a place that's outside the new frame size.
8864 Actually checking whether it is outside is a pain in the neck,
8865 so don't try--just let the highlighting be done afresh with new size. */
8866 cancel_mouse_face (f);
8868 UNBLOCK_INPUT;
8871 /* Mouse warping. */
8873 void
8874 x_set_mouse_position (f, x, y)
8875 struct frame *f;
8876 int x, y;
8878 int pix_x, pix_y;
8880 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8881 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8883 if (pix_x < 0) pix_x = 0;
8884 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8886 if (pix_y < 0) pix_y = 0;
8887 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8889 BLOCK_INPUT;
8891 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8892 0, 0, 0, 0, pix_x, pix_y);
8893 UNBLOCK_INPUT;
8896 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8898 void
8899 x_set_mouse_pixel_position (f, pix_x, pix_y)
8900 struct frame *f;
8901 int pix_x, pix_y;
8903 BLOCK_INPUT;
8905 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8906 0, 0, 0, 0, pix_x, pix_y);
8907 UNBLOCK_INPUT;
8910 /* focus shifting, raising and lowering. */
8912 void
8913 x_focus_on_frame (f)
8914 struct frame *f;
8916 #if 0 /* This proves to be unpleasant. */
8917 x_raise_frame (f);
8918 #endif
8919 #if 0
8920 /* I don't think that the ICCCM allows programs to do things like this
8921 without the interaction of the window manager. Whatever you end up
8922 doing with this code, do it to x_unfocus_frame too. */
8923 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8924 RevertToPointerRoot, CurrentTime);
8925 #endif /* ! 0 */
8928 void
8929 x_unfocus_frame (f)
8930 struct frame *f;
8932 #if 0
8933 /* Look at the remarks in x_focus_on_frame. */
8934 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8935 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8936 RevertToPointerRoot, CurrentTime);
8937 #endif /* ! 0 */
8940 /* Raise frame F. */
8942 void
8943 x_raise_frame (f)
8944 struct frame *f;
8946 BLOCK_INPUT;
8947 if (f->async_visible)
8948 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8950 XFlush (FRAME_X_DISPLAY (f));
8951 UNBLOCK_INPUT;
8954 /* Lower frame F. */
8956 void
8957 x_lower_frame (f)
8958 struct frame *f;
8960 if (f->async_visible)
8962 BLOCK_INPUT;
8963 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8964 XFlush (FRAME_X_DISPLAY (f));
8965 UNBLOCK_INPUT;
8969 /* Activate frame with Extended Window Manager Hints */
8971 void
8972 x_ewmh_activate_frame (f)
8973 FRAME_PTR f;
8975 /* See Window Manager Specification/Extended Window Manager Hints at
8976 http://freedesktop.org/wiki/Specifications/wm-spec */
8978 const char *atom = "_NET_ACTIVE_WINDOW";
8979 if (f->async_visible && wm_supports (f, atom))
8981 Lisp_Object frame;
8982 XSETFRAME (frame, f);
8983 Fx_send_client_event (frame, make_number (0), frame,
8984 make_unibyte_string (atom, strlen (atom)),
8985 make_number (32),
8986 Fcons (make_number (1),
8987 Fcons (make_number (last_user_time),
8988 Qnil)));
8992 static void
8993 XTframe_raise_lower (f, raise_flag)
8994 FRAME_PTR f;
8995 int raise_flag;
8997 if (raise_flag)
8998 x_raise_frame (f);
8999 else
9000 x_lower_frame (f);
9003 /* XEmbed implementation. */
9005 void
9006 xembed_set_info (f, flags)
9007 struct frame *f;
9008 enum xembed_info flags;
9010 Atom atom;
9011 unsigned long data[2];
9013 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
9015 data[0] = XEMBED_VERSION;
9016 data[1] = flags;
9018 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
9019 32, PropModeReplace, (unsigned char *) data, 2);
9022 void
9023 xembed_send_message (f, time, message, detail, data1, data2)
9024 struct frame *f;
9025 Time time;
9026 enum xembed_message message;
9027 long detail;
9028 long data1;
9029 long data2;
9031 XEvent event;
9033 event.xclient.type = ClientMessage;
9034 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9035 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9036 event.xclient.format = 32;
9037 event.xclient.data.l[0] = time;
9038 event.xclient.data.l[1] = message;
9039 event.xclient.data.l[2] = detail;
9040 event.xclient.data.l[3] = data1;
9041 event.xclient.data.l[4] = data2;
9043 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9044 False, NoEventMask, &event);
9045 XSync (FRAME_X_DISPLAY (f), False);
9048 /* Change of visibility. */
9050 /* This tries to wait until the frame is really visible.
9051 However, if the window manager asks the user where to position
9052 the frame, this will return before the user finishes doing that.
9053 The frame will not actually be visible at that time,
9054 but it will become visible later when the window manager
9055 finishes with it. */
9057 void
9058 x_make_frame_visible (f)
9059 struct frame *f;
9061 Lisp_Object type;
9062 int original_top, original_left;
9063 int retry_count = 2;
9065 retry:
9067 BLOCK_INPUT;
9069 type = x_icon_type (f);
9070 if (!NILP (type))
9071 x_bitmap_icon (f, type);
9073 if (! FRAME_VISIBLE_P (f))
9075 /* We test FRAME_GARBAGED_P here to make sure we don't
9076 call x_set_offset a second time
9077 if we get to x_make_frame_visible a second time
9078 before the window gets really visible. */
9079 if (! FRAME_ICONIFIED_P (f)
9080 && ! FRAME_X_EMBEDDED_P (f)
9081 && ! f->output_data.x->asked_for_visible)
9082 x_set_offset (f, f->left_pos, f->top_pos, 0);
9084 f->output_data.x->asked_for_visible = 1;
9086 if (! EQ (Vx_no_window_manager, Qt))
9087 x_wm_set_window_state (f, NormalState);
9088 #ifdef USE_X_TOOLKIT
9089 if (FRAME_X_EMBEDDED_P (f))
9090 xembed_set_info (f, XEMBED_MAPPED);
9091 else
9093 /* This was XtPopup, but that did nothing for an iconified frame. */
9094 XtMapWidget (f->output_data.x->widget);
9096 #else /* not USE_X_TOOLKIT */
9097 #ifdef USE_GTK
9098 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9099 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9100 #else
9101 if (FRAME_X_EMBEDDED_P (f))
9102 xembed_set_info (f, XEMBED_MAPPED);
9103 else
9104 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9105 #endif /* not USE_GTK */
9106 #endif /* not USE_X_TOOLKIT */
9107 #if 0 /* This seems to bring back scroll bars in the wrong places
9108 if the window configuration has changed. They seem
9109 to come back ok without this. */
9110 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
9111 XMapSubwindows (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9112 #endif
9115 XFlush (FRAME_X_DISPLAY (f));
9117 /* Synchronize to ensure Emacs knows the frame is visible
9118 before we do anything else. We do this loop with input not blocked
9119 so that incoming events are handled. */
9121 Lisp_Object frame;
9122 int count;
9123 /* This must be before UNBLOCK_INPUT
9124 since events that arrive in response to the actions above
9125 will set it when they are handled. */
9126 int previously_visible = f->output_data.x->has_been_visible;
9128 original_left = f->left_pos;
9129 original_top = f->top_pos;
9131 /* This must come after we set COUNT. */
9132 UNBLOCK_INPUT;
9134 /* We unblock here so that arriving X events are processed. */
9136 /* Now move the window back to where it was "supposed to be".
9137 But don't do it if the gravity is negative.
9138 When the gravity is negative, this uses a position
9139 that is 3 pixels too low. Perhaps that's really the border width.
9141 Don't do this if the window has never been visible before,
9142 because the window manager may choose the position
9143 and we don't want to override it. */
9145 if (! FRAME_VISIBLE_P (f)
9146 && ! FRAME_ICONIFIED_P (f)
9147 && ! FRAME_X_EMBEDDED_P (f)
9148 && f->win_gravity == NorthWestGravity
9149 && previously_visible)
9151 Drawable rootw;
9152 int x, y;
9153 unsigned int width, height, border, depth;
9155 BLOCK_INPUT;
9157 /* On some window managers (such as FVWM) moving an existing
9158 window, even to the same place, causes the window manager
9159 to introduce an offset. This can cause the window to move
9160 to an unexpected location. Check the geometry (a little
9161 slow here) and then verify that the window is in the right
9162 place. If the window is not in the right place, move it
9163 there, and take the potential window manager hit. */
9164 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9165 &rootw, &x, &y, &width, &height, &border, &depth);
9167 if (original_left != x || original_top != y)
9168 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9169 original_left, original_top);
9171 UNBLOCK_INPUT;
9174 XSETFRAME (frame, f);
9176 /* Wait until the frame is visible. Process X events until a
9177 MapNotify event has been seen, or until we think we won't get a
9178 MapNotify at all.. */
9179 for (count = input_signal_count + 10;
9180 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9182 /* Force processing of queued events. */
9183 x_sync (f);
9185 /* Machines that do polling rather than SIGIO have been
9186 observed to go into a busy-wait here. So we'll fake an
9187 alarm signal to let the handler know that there's something
9188 to be read. We used to raise a real alarm, but it seems
9189 that the handler isn't always enabled here. This is
9190 probably a bug. */
9191 if (input_polling_used ())
9193 /* It could be confusing if a real alarm arrives while
9194 processing the fake one. Turn it off and let the
9195 handler reset it. */
9196 extern void poll_for_input_1 P_ ((void));
9197 int old_poll_suppress_count = poll_suppress_count;
9198 poll_suppress_count = 1;
9199 poll_for_input_1 ();
9200 poll_suppress_count = old_poll_suppress_count;
9203 /* See if a MapNotify event has been processed. */
9204 FRAME_SAMPLE_VISIBILITY (f);
9207 /* 2000-09-28: In
9209 (let ((f (selected-frame)))
9210 (iconify-frame f)
9211 (raise-frame f))
9213 the frame is not raised with various window managers on
9214 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9215 unknown reason, the call to XtMapWidget is completely ignored.
9216 Mapping the widget a second time works. */
9218 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9219 goto retry;
9223 /* Change from mapped state to withdrawn state. */
9225 /* Make the frame visible (mapped and not iconified). */
9227 void
9228 x_make_frame_invisible (f)
9229 struct frame *f;
9231 Window window;
9233 /* Use the frame's outermost window, not the one we normally draw on. */
9234 window = FRAME_OUTER_WINDOW (f);
9236 /* Don't keep the highlight on an invisible frame. */
9237 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9238 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9240 #if 0/* This might add unreliability; I don't trust it -- rms. */
9241 if (! f->async_visible && ! f->async_iconified)
9242 return;
9243 #endif
9245 BLOCK_INPUT;
9247 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9248 that the current position of the window is user-specified, rather than
9249 program-specified, so that when the window is mapped again, it will be
9250 placed at the same location, without forcing the user to position it
9251 by hand again (they have already done that once for this window.) */
9252 x_wm_set_size_hint (f, (long) 0, 1);
9254 #ifdef USE_GTK
9255 if (FRAME_GTK_OUTER_WIDGET (f))
9256 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9257 else
9258 #else
9259 if (FRAME_X_EMBEDDED_P (f))
9260 xembed_set_info (f, 0);
9261 else
9262 #endif
9265 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9266 DefaultScreen (FRAME_X_DISPLAY (f))))
9268 UNBLOCK_INPUT_RESIGNAL;
9269 error ("Can't notify window manager of window withdrawal");
9273 /* We can't distinguish this from iconification
9274 just by the event that we get from the server.
9275 So we can't win using the usual strategy of letting
9276 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9277 and synchronize with the server to make sure we agree. */
9278 f->visible = 0;
9279 FRAME_ICONIFIED_P (f) = 0;
9280 f->async_visible = 0;
9281 f->async_iconified = 0;
9283 x_sync (f);
9285 UNBLOCK_INPUT;
9288 /* Change window state from mapped to iconified. */
9290 void
9291 x_iconify_frame (f)
9292 struct frame *f;
9294 int result;
9295 Lisp_Object type;
9297 /* Don't keep the highlight on an invisible frame. */
9298 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9299 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9301 if (f->async_iconified)
9302 return;
9304 BLOCK_INPUT;
9306 FRAME_SAMPLE_VISIBILITY (f);
9308 type = x_icon_type (f);
9309 if (!NILP (type))
9310 x_bitmap_icon (f, type);
9312 #ifdef USE_GTK
9313 if (FRAME_GTK_OUTER_WIDGET (f))
9315 if (! FRAME_VISIBLE_P (f))
9316 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9318 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9319 f->iconified = 1;
9320 f->visible = 1;
9321 f->async_iconified = 1;
9322 f->async_visible = 0;
9323 UNBLOCK_INPUT;
9324 return;
9326 #endif
9328 #ifdef USE_X_TOOLKIT
9330 if (! FRAME_VISIBLE_P (f))
9332 if (! EQ (Vx_no_window_manager, Qt))
9333 x_wm_set_window_state (f, IconicState);
9334 /* This was XtPopup, but that did nothing for an iconified frame. */
9335 XtMapWidget (f->output_data.x->widget);
9336 /* The server won't give us any event to indicate
9337 that an invisible frame was changed to an icon,
9338 so we have to record it here. */
9339 f->iconified = 1;
9340 f->visible = 1;
9341 f->async_iconified = 1;
9342 f->async_visible = 0;
9343 UNBLOCK_INPUT;
9344 return;
9347 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9348 XtWindow (f->output_data.x->widget),
9349 DefaultScreen (FRAME_X_DISPLAY (f)));
9350 UNBLOCK_INPUT;
9352 if (!result)
9353 error ("Can't notify window manager of iconification");
9355 f->async_iconified = 1;
9356 f->async_visible = 0;
9359 BLOCK_INPUT;
9360 XFlush (FRAME_X_DISPLAY (f));
9361 UNBLOCK_INPUT;
9362 #else /* not USE_X_TOOLKIT */
9364 /* Make sure the X server knows where the window should be positioned,
9365 in case the user deiconifies with the window manager. */
9366 if (! FRAME_VISIBLE_P (f)
9367 && ! FRAME_ICONIFIED_P (f)
9368 && ! FRAME_X_EMBEDDED_P (f))
9369 x_set_offset (f, f->left_pos, f->top_pos, 0);
9371 /* Since we don't know which revision of X we're running, we'll use both
9372 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9374 /* X11R4: send a ClientMessage to the window manager using the
9375 WM_CHANGE_STATE type. */
9377 XEvent message;
9379 message.xclient.window = FRAME_X_WINDOW (f);
9380 message.xclient.type = ClientMessage;
9381 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9382 message.xclient.format = 32;
9383 message.xclient.data.l[0] = IconicState;
9385 if (! XSendEvent (FRAME_X_DISPLAY (f),
9386 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9387 False,
9388 SubstructureRedirectMask | SubstructureNotifyMask,
9389 &message))
9391 UNBLOCK_INPUT_RESIGNAL;
9392 error ("Can't notify window manager of iconification");
9396 /* X11R3: set the initial_state field of the window manager hints to
9397 IconicState. */
9398 x_wm_set_window_state (f, IconicState);
9400 if (!FRAME_VISIBLE_P (f))
9402 /* If the frame was withdrawn, before, we must map it. */
9403 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9406 f->async_iconified = 1;
9407 f->async_visible = 0;
9409 XFlush (FRAME_X_DISPLAY (f));
9410 UNBLOCK_INPUT;
9411 #endif /* not USE_X_TOOLKIT */
9415 /* Free X resources of frame F. */
9417 void
9418 x_free_frame_resources (f)
9419 struct frame *f;
9421 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9422 Lisp_Object bar;
9423 struct scroll_bar *b;
9425 BLOCK_INPUT;
9427 /* If a display connection is dead, don't try sending more
9428 commands to the X server. */
9429 if (dpyinfo->display)
9431 /* We must free faces before destroying windows because some
9432 font-driver (e.g. xft) access a window while finishing a
9433 face. */
9434 if (FRAME_FACE_CACHE (f))
9435 free_frame_faces (f);
9437 if (f->output_data.x->icon_desc)
9438 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9440 #ifdef USE_X_TOOLKIT
9441 /* Explicitly destroy the scroll bars of the frame. Without
9442 this, we get "BadDrawable" errors from the toolkit later on,
9443 presumably from expose events generated for the disappearing
9444 toolkit scroll bars. */
9445 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9447 b = XSCROLL_BAR (bar);
9448 x_scroll_bar_remove (b);
9450 #endif
9452 #ifdef HAVE_X_I18N
9453 if (FRAME_XIC (f))
9454 free_frame_xic (f);
9455 #endif
9457 #ifdef USE_X_TOOLKIT
9458 if (f->output_data.x->widget)
9460 XtDestroyWidget (f->output_data.x->widget);
9461 f->output_data.x->widget = NULL;
9463 /* Tooltips don't have widgets, only a simple X window, even if
9464 we are using a toolkit. */
9465 else if (FRAME_X_WINDOW (f))
9466 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9468 free_frame_menubar (f);
9469 #else /* !USE_X_TOOLKIT */
9471 #ifdef USE_GTK
9472 /* In the GTK version, tooltips are normal X
9473 frames. We must check and free both types. */
9474 if (FRAME_GTK_OUTER_WIDGET (f))
9476 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
9477 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
9478 FRAME_GTK_OUTER_WIDGET (f) = 0;
9480 #endif /* USE_GTK */
9482 if (FRAME_X_WINDOW (f))
9483 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9484 #endif /* !USE_X_TOOLKIT */
9486 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9487 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9488 unload_color (f, f->output_data.x->cursor_pixel);
9489 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9490 unload_color (f, f->output_data.x->border_pixel);
9491 unload_color (f, f->output_data.x->mouse_pixel);
9493 if (f->output_data.x->scroll_bar_background_pixel != -1)
9494 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9495 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9496 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9497 #ifdef USE_TOOLKIT_SCROLL_BARS
9498 /* Scrollbar shadow colors. */
9499 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9500 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9501 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9502 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9503 #endif /* USE_TOOLKIT_SCROLL_BARS */
9504 if (f->output_data.x->white_relief.allocated_p)
9505 unload_color (f, f->output_data.x->white_relief.pixel);
9506 if (f->output_data.x->black_relief.allocated_p)
9507 unload_color (f, f->output_data.x->black_relief.pixel);
9509 if (FRAME_FACE_CACHE (f))
9510 free_frame_faces (f);
9512 x_free_gcs (f);
9513 XFlush (FRAME_X_DISPLAY (f));
9516 if (f->output_data.x->saved_menu_event)
9517 xfree (f->output_data.x->saved_menu_event);
9519 xfree (f->output_data.x);
9520 f->output_data.x = NULL;
9522 if (f == dpyinfo->x_focus_frame)
9523 dpyinfo->x_focus_frame = 0;
9524 if (f == dpyinfo->x_focus_event_frame)
9525 dpyinfo->x_focus_event_frame = 0;
9526 if (f == dpyinfo->x_highlight_frame)
9527 dpyinfo->x_highlight_frame = 0;
9529 if (f == dpyinfo->mouse_face_mouse_frame)
9531 dpyinfo->mouse_face_beg_row
9532 = dpyinfo->mouse_face_beg_col = -1;
9533 dpyinfo->mouse_face_end_row
9534 = dpyinfo->mouse_face_end_col = -1;
9535 dpyinfo->mouse_face_window = Qnil;
9536 dpyinfo->mouse_face_deferred_gc = 0;
9537 dpyinfo->mouse_face_mouse_frame = 0;
9540 UNBLOCK_INPUT;
9544 /* Destroy the X window of frame F. */
9546 void
9547 x_destroy_window (f)
9548 struct frame *f;
9550 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9552 /* If a display connection is dead, don't try sending more
9553 commands to the X server. */
9554 if (dpyinfo->display != 0)
9555 x_free_frame_resources (f);
9557 dpyinfo->reference_count--;
9561 /* Setting window manager hints. */
9563 /* Set the normal size hints for the window manager, for frame F.
9564 FLAGS is the flags word to use--or 0 meaning preserve the flags
9565 that the window now has.
9566 If USER_POSITION is nonzero, we set the USPosition
9567 flag (this is useful when FLAGS is 0).
9568 The GTK version is in gtkutils.c */
9570 #ifndef USE_GTK
9571 void
9572 x_wm_set_size_hint (f, flags, user_position)
9573 struct frame *f;
9574 long flags;
9575 int user_position;
9577 XSizeHints size_hints;
9579 #ifdef USE_X_TOOLKIT
9580 Arg al[2];
9581 int ac = 0;
9582 Dimension widget_width, widget_height;
9583 #endif
9585 Window window = FRAME_OUTER_WINDOW (f);
9587 /* Setting PMaxSize caused various problems. */
9588 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9590 size_hints.x = f->left_pos;
9591 size_hints.y = f->top_pos;
9593 #ifdef USE_X_TOOLKIT
9594 XtSetArg (al[ac], XtNwidth, &widget_width); ac++;
9595 XtSetArg (al[ac], XtNheight, &widget_height); ac++;
9596 XtGetValues (f->output_data.x->widget, al, ac);
9597 size_hints.height = widget_height;
9598 size_hints.width = widget_width;
9599 #else /* not USE_X_TOOLKIT */
9600 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9601 size_hints.width = FRAME_PIXEL_WIDTH (f);
9602 #endif /* not USE_X_TOOLKIT */
9604 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9605 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9606 size_hints.max_width
9607 = FRAME_X_DISPLAY_INFO (f)->width - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9608 size_hints.max_height
9609 = FRAME_X_DISPLAY_INFO (f)->height - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9611 /* Calculate the base and minimum sizes.
9613 (When we use the X toolkit, we don't do it here.
9614 Instead we copy the values that the widgets are using, below.) */
9615 #ifndef USE_X_TOOLKIT
9617 int base_width, base_height;
9618 int min_rows = 0, min_cols = 0;
9620 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9621 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9623 check_frame_size (f, &min_rows, &min_cols);
9625 /* The window manager uses the base width hints to calculate the
9626 current number of rows and columns in the frame while
9627 resizing; min_width and min_height aren't useful for this
9628 purpose, since they might not give the dimensions for a
9629 zero-row, zero-column frame.
9631 We use the base_width and base_height members if we have
9632 them; otherwise, we set the min_width and min_height members
9633 to the size for a zero x zero frame. */
9635 size_hints.flags |= PBaseSize;
9636 size_hints.base_width = base_width;
9637 size_hints.base_height = base_height;
9638 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9639 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9642 /* If we don't need the old flags, we don't need the old hint at all. */
9643 if (flags)
9645 size_hints.flags |= flags;
9646 goto no_read;
9648 #endif /* not USE_X_TOOLKIT */
9651 XSizeHints hints; /* Sometimes I hate X Windows... */
9652 long supplied_return;
9653 int value;
9655 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9656 &supplied_return);
9658 #ifdef USE_X_TOOLKIT
9659 size_hints.base_height = hints.base_height;
9660 size_hints.base_width = hints.base_width;
9661 size_hints.min_height = hints.min_height;
9662 size_hints.min_width = hints.min_width;
9663 #endif
9665 if (flags)
9666 size_hints.flags |= flags;
9667 else
9669 if (value == 0)
9670 hints.flags = 0;
9671 if (hints.flags & PSize)
9672 size_hints.flags |= PSize;
9673 if (hints.flags & PPosition)
9674 size_hints.flags |= PPosition;
9675 if (hints.flags & USPosition)
9676 size_hints.flags |= USPosition;
9677 if (hints.flags & USSize)
9678 size_hints.flags |= USSize;
9682 #ifndef USE_X_TOOLKIT
9683 no_read:
9684 #endif
9686 #ifdef PWinGravity
9687 size_hints.win_gravity = f->win_gravity;
9688 size_hints.flags |= PWinGravity;
9690 if (user_position)
9692 size_hints.flags &= ~ PPosition;
9693 size_hints.flags |= USPosition;
9695 #endif /* PWinGravity */
9697 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9699 #endif /* not USE_GTK */
9701 /* Used for IconicState or NormalState */
9703 void
9704 x_wm_set_window_state (f, state)
9705 struct frame *f;
9706 int state;
9708 #ifdef USE_X_TOOLKIT
9709 Arg al[1];
9711 XtSetArg (al[0], XtNinitialState, state);
9712 XtSetValues (f->output_data.x->widget, al, 1);
9713 #else /* not USE_X_TOOLKIT */
9714 Window window = FRAME_X_WINDOW (f);
9716 f->output_data.x->wm_hints.flags |= StateHint;
9717 f->output_data.x->wm_hints.initial_state = state;
9719 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9720 #endif /* not USE_X_TOOLKIT */
9723 void
9724 x_wm_set_icon_pixmap (f, pixmap_id)
9725 struct frame *f;
9726 int pixmap_id;
9728 Pixmap icon_pixmap, icon_mask;
9730 #ifndef USE_X_TOOLKIT
9731 Window window = FRAME_OUTER_WINDOW (f);
9732 #endif
9734 if (pixmap_id > 0)
9736 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9737 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9738 icon_mask = x_bitmap_mask (f, pixmap_id);
9739 f->output_data.x->wm_hints.icon_mask = icon_mask;
9741 else
9743 /* It seems there is no way to turn off use of an icon pixmap.
9744 The following line does it, only if no icon has yet been created,
9745 for some window managers. But with mwm it crashes.
9746 Some people say it should clear the IconPixmapHint bit in this case,
9747 but that doesn't work, and the X consortium said it isn't the
9748 right thing at all. Since there is no way to win,
9749 best to explicitly give up. */
9750 #if 0
9751 f->output_data.x->wm_hints.icon_pixmap = None;
9752 f->output_data.x->wm_hints.icon_mask = None;
9753 #else
9754 return;
9755 #endif
9759 #ifdef USE_GTK
9761 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9762 return;
9765 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9768 Arg al[1];
9769 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9770 XtSetValues (f->output_data.x->widget, al, 1);
9771 XtSetArg (al[0], XtNiconMask, icon_mask);
9772 XtSetValues (f->output_data.x->widget, al, 1);
9775 #else /* not USE_X_TOOLKIT && not USE_GTK */
9777 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9778 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9780 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9783 void
9784 x_wm_set_icon_position (f, icon_x, icon_y)
9785 struct frame *f;
9786 int icon_x, icon_y;
9788 Window window = FRAME_OUTER_WINDOW (f);
9790 f->output_data.x->wm_hints.flags |= IconPositionHint;
9791 f->output_data.x->wm_hints.icon_x = icon_x;
9792 f->output_data.x->wm_hints.icon_y = icon_y;
9794 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9798 /***********************************************************************
9799 Fonts
9800 ***********************************************************************/
9802 #if GLYPH_DEBUG
9804 /* Check that FONT is valid on frame F. It is if it can be found in F's
9805 font table. */
9807 static void
9808 x_check_font (f, font)
9809 struct frame *f;
9810 struct font *font;
9812 Lisp_Object frame;
9814 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9815 if (font->driver->check)
9816 xassert (font->driver->check (f, font) == 0);
9819 #endif /* GLYPH_DEBUG != 0 */
9822 /***********************************************************************
9823 Initialization
9824 ***********************************************************************/
9826 #ifdef USE_X_TOOLKIT
9827 static XrmOptionDescRec emacs_options[] = {
9828 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9829 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9831 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9832 XrmoptionSepArg, NULL},
9833 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9835 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9836 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9837 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9838 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9839 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9840 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9841 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9844 /* Whether atimer for Xt timeouts is activated or not. */
9846 static int x_timeout_atimer_activated_flag;
9848 #endif /* USE_X_TOOLKIT */
9850 static int x_initialized;
9852 #ifdef HAVE_X_SM
9853 static int x_session_initialized;
9854 #endif
9856 #ifdef MULTI_KBOARD
9857 /* Test whether two display-name strings agree up to the dot that separates
9858 the screen number from the server number. */
9859 static int
9860 same_x_server (name1, name2)
9861 const char *name1, *name2;
9863 int seen_colon = 0;
9864 const unsigned char *system_name = SDATA (Vsystem_name);
9865 int system_name_length = strlen (system_name);
9866 int length_until_period = 0;
9868 while (system_name[length_until_period] != 0
9869 && system_name[length_until_period] != '.')
9870 length_until_period++;
9872 /* Treat `unix' like an empty host name. */
9873 if (! strncmp (name1, "unix:", 5))
9874 name1 += 4;
9875 if (! strncmp (name2, "unix:", 5))
9876 name2 += 4;
9877 /* Treat this host's name like an empty host name. */
9878 if (! strncmp (name1, system_name, system_name_length)
9879 && name1[system_name_length] == ':')
9880 name1 += system_name_length;
9881 if (! strncmp (name2, system_name, system_name_length)
9882 && name2[system_name_length] == ':')
9883 name2 += system_name_length;
9884 /* Treat this host's domainless name like an empty host name. */
9885 if (! strncmp (name1, system_name, length_until_period)
9886 && name1[length_until_period] == ':')
9887 name1 += length_until_period;
9888 if (! strncmp (name2, system_name, length_until_period)
9889 && name2[length_until_period] == ':')
9890 name2 += length_until_period;
9892 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9894 if (*name1 == ':')
9895 seen_colon++;
9896 if (seen_colon && *name1 == '.')
9897 return 1;
9899 return (seen_colon
9900 && (*name1 == '.' || *name1 == '\0')
9901 && (*name2 == '.' || *name2 == '\0'));
9903 #endif
9905 /* Count number of set bits in mask and number of bits to shift to
9906 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9907 to 5. */
9908 static void
9909 get_bits_and_offset (mask, bits, offset)
9910 unsigned long mask;
9911 int *bits;
9912 int *offset;
9914 int nr = 0;
9915 int off = 0;
9917 while (!(mask & 1))
9919 off++;
9920 mask >>= 1;
9923 while (mask & 1)
9925 nr++;
9926 mask >>= 1;
9929 *offset = off;
9930 *bits = nr;
9933 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9934 But don't permanently open it, just test its availability. */
9937 x_display_ok (display)
9938 const char *display;
9940 int dpy_ok = 1;
9941 Display *dpy;
9943 dpy = XOpenDisplay (display);
9944 if (dpy)
9945 XCloseDisplay (dpy);
9946 else
9947 dpy_ok = 0;
9948 return dpy_ok;
9951 /* Open a connection to X display DISPLAY_NAME, and return
9952 the structure that describes the open display.
9953 If we cannot contact the display, return null. */
9955 struct x_display_info *
9956 x_term_init (display_name, xrm_option, resource_name)
9957 Lisp_Object display_name;
9958 char *xrm_option;
9959 char *resource_name;
9961 int connection;
9962 Display *dpy;
9963 struct terminal *terminal;
9964 struct x_display_info *dpyinfo;
9965 XrmDatabase xrdb;
9967 BLOCK_INPUT;
9969 if (!x_initialized)
9971 x_initialize ();
9972 ++x_initialized;
9975 if (! x_display_ok (SDATA (display_name)))
9976 error ("Display %s can't be opened", SDATA (display_name));
9978 #ifdef USE_GTK
9980 #define NUM_ARGV 10
9981 int argc;
9982 char *argv[NUM_ARGV];
9983 char **argv2 = argv;
9984 GdkAtom atom;
9986 #ifndef HAVE_GTK_MULTIDISPLAY
9987 if (!EQ (Vinitial_window_system, intern ("x")))
9988 error ("Sorry, you cannot connect to X servers with the GTK toolkit");
9989 #endif
9991 if (x_initialized++ > 1)
9993 #ifdef HAVE_GTK_MULTIDISPLAY
9994 /* Opening another display. If xg_display_open returns less
9995 than zero, we are probably on GTK 2.0, which can only handle
9996 one display. GTK 2.2 or later can handle more than one. */
9997 if (xg_display_open (SDATA (display_name), &dpy) < 0)
9998 #endif
9999 error ("Sorry, this version of GTK can only handle one display");
10001 else
10003 for (argc = 0; argc < NUM_ARGV; ++argc)
10004 argv[argc] = 0;
10006 argc = 0;
10007 argv[argc++] = initial_argv[0];
10009 if (! NILP (display_name))
10011 argv[argc++] = "--display";
10012 argv[argc++] = SDATA (display_name);
10015 argv[argc++] = "--name";
10016 argv[argc++] = resource_name;
10018 XSetLocaleModifiers ("");
10020 gtk_init (&argc, &argv2);
10022 /* gtk_init does set_locale. We must fix locale after calling it. */
10023 fixup_locale ();
10024 xg_initialize ();
10026 dpy = GDK_DISPLAY ();
10028 /* NULL window -> events for all windows go to our function */
10029 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10031 /* Load our own gtkrc if it exists. */
10033 char *file = "~/.emacs.d/gtkrc";
10034 Lisp_Object s, abs_file;
10036 s = make_string (file, strlen (file));
10037 abs_file = Fexpand_file_name (s, Qnil);
10039 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10040 gtk_rc_parse (SDATA (abs_file));
10043 XSetErrorHandler (x_error_handler);
10044 XSetIOErrorHandler (x_io_error_quitter);
10047 #else /* not USE_GTK */
10048 #ifdef USE_X_TOOLKIT
10049 /* weiner@footloose.sps.mot.com reports that this causes
10050 errors with X11R5:
10051 X protocol error: BadAtom (invalid Atom parameter)
10052 on protocol request 18skiloaf.
10053 So let's not use it until R6. */
10054 #ifdef HAVE_X11XTR6
10055 XtSetLanguageProc (NULL, NULL, NULL);
10056 #endif
10059 int argc = 0;
10060 char *argv[3];
10062 argv[0] = "";
10063 argc = 1;
10064 if (xrm_option)
10066 argv[argc++] = "-xrm";
10067 argv[argc++] = xrm_option;
10069 turn_on_atimers (0);
10070 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10071 resource_name, EMACS_CLASS,
10072 emacs_options, XtNumber (emacs_options),
10073 &argc, argv);
10074 turn_on_atimers (1);
10076 #ifdef HAVE_X11XTR6
10077 /* I think this is to compensate for XtSetLanguageProc. */
10078 fixup_locale ();
10079 #endif
10082 #else /* not USE_X_TOOLKIT */
10083 XSetLocaleModifiers ("");
10084 dpy = XOpenDisplay (SDATA (display_name));
10085 #endif /* not USE_X_TOOLKIT */
10086 #endif /* not USE_GTK*/
10088 /* Detect failure. */
10089 if (dpy == 0)
10091 UNBLOCK_INPUT;
10092 return 0;
10095 /* We have definitely succeeded. Record the new connection. */
10097 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10098 bzero (dpyinfo, sizeof *dpyinfo);
10100 terminal = x_create_terminal (dpyinfo);
10102 #ifdef MULTI_KBOARD
10104 struct x_display_info *share;
10105 Lisp_Object tail;
10107 for (share = x_display_list, tail = x_display_name_list; share;
10108 share = share->next, tail = XCDR (tail))
10109 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10110 SDATA (display_name)))
10111 break;
10112 if (share)
10113 terminal->kboard = share->terminal->kboard;
10114 else
10116 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10117 init_kboard (terminal->kboard);
10118 terminal->kboard->Vwindow_system = intern ("x");
10119 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10121 char *vendor = ServerVendor (dpy);
10122 UNBLOCK_INPUT;
10123 terminal->kboard->Vsystem_key_alist
10124 = call1 (Qvendor_specific_keysyms,
10125 vendor ? build_string (vendor) : empty_unibyte_string);
10126 BLOCK_INPUT;
10129 terminal->kboard->next_kboard = all_kboards;
10130 all_kboards = terminal->kboard;
10131 /* Don't let the initial kboard remain current longer than necessary.
10132 That would cause problems if a file loaded on startup tries to
10133 prompt in the mini-buffer. */
10134 if (current_kboard == initial_kboard)
10135 current_kboard = terminal->kboard;
10137 terminal->kboard->reference_count++;
10139 #endif
10141 /* Put this display on the chain. */
10142 dpyinfo->next = x_display_list;
10143 x_display_list = dpyinfo;
10145 /* Put it on x_display_name_list as well, to keep them parallel. */
10146 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10147 x_display_name_list);
10148 dpyinfo->name_list_element = XCAR (x_display_name_list);
10150 dpyinfo->display = dpy;
10152 /* Set the name of the terminal. */
10153 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10154 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10155 terminal->name[SBYTES (display_name)] = 0;
10157 #if 0
10158 XSetAfterFunction (x_current_display, x_trace_wire);
10159 #endif /* ! 0 */
10161 dpyinfo->x_id_name
10162 = (char *) xmalloc (SBYTES (Vinvocation_name)
10163 + SBYTES (Vsystem_name)
10164 + 2);
10165 sprintf (dpyinfo->x_id_name, "%s@%s",
10166 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10168 /* Figure out which modifier bits mean what. */
10169 x_find_modifier_meanings (dpyinfo);
10171 /* Get the scroll bar cursor. */
10172 #ifdef USE_GTK
10173 /* We must create a GTK cursor, it is required for GTK widgets. */
10174 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10175 #endif /* USE_GTK */
10177 dpyinfo->vertical_scroll_bar_cursor
10178 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10180 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10181 resource_name, EMACS_CLASS);
10182 #ifdef HAVE_XRMSETDATABASE
10183 XrmSetDatabase (dpyinfo->display, xrdb);
10184 #else
10185 dpyinfo->display->db = xrdb;
10186 #endif
10187 /* Put the rdb where we can find it in a way that works on
10188 all versions. */
10189 dpyinfo->xrdb = xrdb;
10191 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10192 DefaultScreen (dpyinfo->display));
10193 select_visual (dpyinfo);
10194 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10195 dpyinfo->height = HeightOfScreen (dpyinfo->screen);
10196 dpyinfo->width = WidthOfScreen (dpyinfo->screen);
10197 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10198 dpyinfo->client_leader_window = 0;
10199 dpyinfo->grabbed = 0;
10200 dpyinfo->reference_count = 0;
10201 dpyinfo->icon_bitmap_id = -1;
10202 dpyinfo->n_fonts = 0;
10203 dpyinfo->bitmaps = 0;
10204 dpyinfo->bitmaps_size = 0;
10205 dpyinfo->bitmaps_last = 0;
10206 dpyinfo->scratch_cursor_gc = 0;
10207 dpyinfo->mouse_face_mouse_frame = 0;
10208 dpyinfo->mouse_face_deferred_gc = 0;
10209 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10210 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10211 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10212 dpyinfo->mouse_face_window = Qnil;
10213 dpyinfo->mouse_face_overlay = Qnil;
10214 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10215 dpyinfo->mouse_face_defer = 0;
10216 dpyinfo->mouse_face_hidden = 0;
10217 dpyinfo->x_focus_frame = 0;
10218 dpyinfo->x_focus_event_frame = 0;
10219 dpyinfo->x_highlight_frame = 0;
10220 dpyinfo->terminal->image_cache = make_image_cache ();
10221 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10223 /* See if we can construct pixel values from RGB values. */
10224 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10225 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10227 if (dpyinfo->visual->class == TrueColor)
10229 get_bits_and_offset (dpyinfo->visual->red_mask,
10230 &dpyinfo->red_bits, &dpyinfo->red_offset);
10231 get_bits_and_offset (dpyinfo->visual->blue_mask,
10232 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10233 get_bits_and_offset (dpyinfo->visual->green_mask,
10234 &dpyinfo->green_bits, &dpyinfo->green_offset);
10237 /* See if a private colormap is requested. */
10238 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10240 if (dpyinfo->visual->class == PseudoColor)
10242 Lisp_Object value;
10243 value = display_x_get_resource (dpyinfo,
10244 build_string ("privateColormap"),
10245 build_string ("PrivateColormap"),
10246 Qnil, Qnil);
10247 if (STRINGP (value)
10248 && (!strcmp (SDATA (value), "true")
10249 || !strcmp (SDATA (value), "on")))
10250 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10253 else
10254 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10255 dpyinfo->visual, AllocNone);
10258 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10259 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10260 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10261 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10262 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10263 pixels = DisplayWidth (dpyinfo->display, screen_number);
10264 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10265 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10266 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10269 dpyinfo->Xatom_wm_protocols
10270 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10271 dpyinfo->Xatom_wm_take_focus
10272 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10273 dpyinfo->Xatom_wm_save_yourself
10274 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10275 dpyinfo->Xatom_wm_delete_window
10276 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10277 dpyinfo->Xatom_wm_change_state
10278 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10279 dpyinfo->Xatom_wm_configure_denied
10280 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10281 dpyinfo->Xatom_wm_window_moved
10282 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10283 dpyinfo->Xatom_wm_client_leader
10284 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10285 dpyinfo->Xatom_editres
10286 = XInternAtom (dpyinfo->display, "Editres", False);
10287 dpyinfo->Xatom_CLIPBOARD
10288 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10289 dpyinfo->Xatom_TIMESTAMP
10290 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10291 dpyinfo->Xatom_TEXT
10292 = XInternAtom (dpyinfo->display, "TEXT", False);
10293 dpyinfo->Xatom_COMPOUND_TEXT
10294 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10295 dpyinfo->Xatom_UTF8_STRING
10296 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10297 dpyinfo->Xatom_DELETE
10298 = XInternAtom (dpyinfo->display, "DELETE", False);
10299 dpyinfo->Xatom_MULTIPLE
10300 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10301 dpyinfo->Xatom_INCR
10302 = XInternAtom (dpyinfo->display, "INCR", False);
10303 dpyinfo->Xatom_EMACS_TMP
10304 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10305 dpyinfo->Xatom_TARGETS
10306 = XInternAtom (dpyinfo->display, "TARGETS", False);
10307 dpyinfo->Xatom_NULL
10308 = XInternAtom (dpyinfo->display, "NULL", False);
10309 dpyinfo->Xatom_ATOM_PAIR
10310 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10311 /* For properties of font. */
10312 dpyinfo->Xatom_PIXEL_SIZE
10313 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10314 dpyinfo->Xatom_AVERAGE_WIDTH
10315 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10316 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10317 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10318 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10319 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10320 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10321 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10323 /* Ghostscript support. */
10324 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10325 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10327 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10328 False);
10330 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10331 False);
10333 dpyinfo->cut_buffers_initialized = 0;
10335 dpyinfo->x_dnd_atoms_size = 8;
10336 dpyinfo->x_dnd_atoms_length = 0;
10337 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10338 * dpyinfo->x_dnd_atoms_size);
10340 dpyinfo->net_supported_atoms = NULL;
10341 dpyinfo->nr_net_supported_atoms = 0;
10342 dpyinfo->net_supported_window = 0;
10344 connection = ConnectionNumber (dpyinfo->display);
10345 dpyinfo->connection = connection;
10348 char null_bits[1];
10350 null_bits[0] = 0x00;
10352 dpyinfo->null_pixel
10353 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10354 null_bits, 1, 1, (long) 0, (long) 0,
10359 extern int gray_bitmap_width, gray_bitmap_height;
10360 extern char *gray_bitmap_bits;
10361 dpyinfo->gray
10362 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10363 gray_bitmap_bits,
10364 gray_bitmap_width, gray_bitmap_height,
10365 (unsigned long) 1, (unsigned long) 0, 1);
10368 #ifdef HAVE_X_I18N
10369 xim_initialize (dpyinfo, resource_name);
10370 #endif
10372 #ifdef subprocesses
10373 /* This is only needed for distinguishing keyboard and process input. */
10374 if (connection != 0)
10375 add_keyboard_wait_descriptor (connection);
10376 #endif
10378 #ifdef F_SETOWN
10379 fcntl (connection, F_SETOWN, getpid ());
10380 #endif /* ! defined (F_SETOWN) */
10382 #ifdef SIGIO
10383 if (interrupt_input)
10384 init_sigio (connection);
10385 #endif /* ! defined (SIGIO) */
10387 #ifdef USE_LUCID
10389 Display *dpy = dpyinfo->display;
10390 XrmValue d, fr, to;
10391 Font font;
10393 d.addr = (XPointer)&dpy;
10394 d.size = sizeof (Display *);
10395 fr.addr = XtDefaultFont;
10396 fr.size = sizeof (XtDefaultFont);
10397 to.size = sizeof (Font *);
10398 to.addr = (XPointer)&font;
10399 x_catch_errors (dpy);
10400 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10401 abort ();
10402 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10403 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10404 x_uncatch_errors ();
10406 #endif
10408 /* See if we should run in synchronous mode. This is useful
10409 for debugging X code. */
10411 Lisp_Object value;
10412 value = display_x_get_resource (dpyinfo,
10413 build_string ("synchronous"),
10414 build_string ("Synchronous"),
10415 Qnil, Qnil);
10416 if (STRINGP (value)
10417 && (!strcmp (SDATA (value), "true")
10418 || !strcmp (SDATA (value), "on")))
10419 XSynchronize (dpyinfo->display, True);
10423 Lisp_Object value;
10424 value = display_x_get_resource (dpyinfo,
10425 build_string ("useXIM"),
10426 build_string ("UseXIM"),
10427 Qnil, Qnil);
10428 #ifdef USE_XIM
10429 if (STRINGP (value)
10430 && (!strcmp (SDATA (value), "false")
10431 || !strcmp (SDATA (value), "off")))
10432 use_xim = 0;
10433 #else
10434 if (STRINGP (value)
10435 && (!strcmp (SDATA (value), "true")
10436 || !strcmp (SDATA (value), "on")))
10437 use_xim = 1;
10438 #endif
10441 #ifdef HAVE_X_SM
10442 /* Only do this for the very first display in the Emacs session.
10443 Ignore X session management when Emacs was first started on a
10444 tty. */
10445 if (terminal->id == 1)
10446 x_session_initialize (dpyinfo);
10447 #endif
10449 UNBLOCK_INPUT;
10451 return dpyinfo;
10454 /* Get rid of display DPYINFO, deleting all frames on it,
10455 and without sending any more commands to the X server. */
10457 void
10458 x_delete_display (dpyinfo)
10459 struct x_display_info *dpyinfo;
10461 int i;
10462 struct terminal *t;
10464 /* Close all frames and delete the generic struct terminal for this
10465 X display. */
10466 for (t = terminal_list; t; t = t->next_terminal)
10467 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10469 #ifdef HAVE_X_SM
10470 /* Close X session management when we close its display. */
10471 if (t->id == 1 && x_session_have_connection ())
10472 x_session_close();
10473 #endif
10474 delete_terminal (t);
10475 break;
10478 delete_keyboard_wait_descriptor (dpyinfo->connection);
10480 /* Discard this display from x_display_name_list and x_display_list.
10481 We can't use Fdelq because that can quit. */
10482 if (! NILP (x_display_name_list)
10483 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10484 x_display_name_list = XCDR (x_display_name_list);
10485 else
10487 Lisp_Object tail;
10489 tail = x_display_name_list;
10490 while (CONSP (tail) && CONSP (XCDR (tail)))
10492 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10494 XSETCDR (tail, XCDR (XCDR (tail)));
10495 break;
10497 tail = XCDR (tail);
10501 if (next_noop_dpyinfo == dpyinfo)
10502 next_noop_dpyinfo = dpyinfo->next;
10504 if (x_display_list == dpyinfo)
10505 x_display_list = dpyinfo->next;
10506 else
10508 struct x_display_info *tail;
10510 for (tail = x_display_list; tail; tail = tail->next)
10511 if (tail->next == dpyinfo)
10512 tail->next = tail->next->next;
10515 #ifndef USE_X_TOOLKIT /* I'm told Xt does this itself. */
10516 #ifndef AIX /* On AIX, XCloseDisplay calls this. */
10517 XrmDestroyDatabase (dpyinfo->xrdb);
10518 #endif
10519 #endif
10520 #ifdef HAVE_X_I18N
10521 if (dpyinfo->xim)
10522 xim_close_dpy (dpyinfo);
10523 #endif
10525 if (dpyinfo->x_id_name)
10526 xfree (dpyinfo->x_id_name);
10527 if (dpyinfo->color_cells)
10528 xfree (dpyinfo->color_cells);
10529 xfree (dpyinfo);
10532 #ifdef USE_X_TOOLKIT
10534 /* Atimer callback function for TIMER. Called every 0.1s to process
10535 Xt timeouts, if needed. We must avoid calling XtAppPending as
10536 much as possible because that function does an implicit XFlush
10537 that slows us down. */
10539 static void
10540 x_process_timeouts (timer)
10541 struct atimer *timer;
10543 BLOCK_INPUT;
10544 x_timeout_atimer_activated_flag = 0;
10545 if (toolkit_scroll_bar_interaction || popup_activated ())
10547 while (XtAppPending (Xt_app_con) & XtIMTimer)
10548 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10549 /* Reactivate the atimer for next time. */
10550 x_activate_timeout_atimer ();
10552 UNBLOCK_INPUT;
10555 /* Install an asynchronous timer that processes Xt timeout events
10556 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10557 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10558 function whenever these variables are set. This is necessary
10559 because some widget sets use timeouts internally, for example the
10560 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10561 processed, these widgets don't behave normally. */
10563 void
10564 x_activate_timeout_atimer ()
10566 BLOCK_INPUT;
10567 if (!x_timeout_atimer_activated_flag)
10569 EMACS_TIME interval;
10571 EMACS_SET_SECS_USECS (interval, 0, 100000);
10572 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10573 x_timeout_atimer_activated_flag = 1;
10575 UNBLOCK_INPUT;
10578 #endif /* USE_X_TOOLKIT */
10581 /* Set up use of X before we make the first connection. */
10583 extern frame_parm_handler x_frame_parm_handlers[];
10585 static struct redisplay_interface x_redisplay_interface =
10587 x_frame_parm_handlers,
10588 x_produce_glyphs,
10589 x_write_glyphs,
10590 x_insert_glyphs,
10591 x_clear_end_of_line,
10592 x_scroll_run,
10593 x_after_update_window_line,
10594 x_update_window_begin,
10595 x_update_window_end,
10596 x_cursor_to,
10597 x_flush,
10598 #ifdef XFlush
10599 x_flush,
10600 #else
10601 0, /* flush_display_optional */
10602 #endif
10603 x_clear_window_mouse_face,
10604 x_get_glyph_overhangs,
10605 x_fix_overlapping_area,
10606 x_draw_fringe_bitmap,
10607 0, /* define_fringe_bitmap */
10608 0, /* destroy_fringe_bitmap */
10609 x_compute_glyph_string_overhangs,
10610 x_draw_glyph_string,
10611 x_define_frame_cursor,
10612 x_clear_frame_area,
10613 x_draw_window_cursor,
10614 x_draw_vertical_window_border,
10615 x_shift_glyphs_for_insert
10619 /* This function is called when the last frame on a display is deleted. */
10620 void
10621 x_delete_terminal (struct terminal *terminal)
10623 struct x_display_info *dpyinfo = terminal->display_info.x;
10624 int i;
10626 /* Protect against recursive calls. Fdelete_frame in
10627 delete_terminal calls us back when it deletes our last frame. */
10628 if (!terminal->name)
10629 return;
10631 BLOCK_INPUT;
10632 /* If called from x_connection_closed, the display may already be closed
10633 and dpyinfo->display was set to 0 to indicate that. */
10634 if (dpyinfo->display)
10636 x_destroy_all_bitmaps (dpyinfo);
10637 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10639 #ifdef USE_GTK
10640 xg_display_close (dpyinfo->display);
10641 #else
10642 #ifdef USE_X_TOOLKIT
10643 XtCloseDisplay (dpyinfo->display);
10644 #else
10645 XCloseDisplay (dpyinfo->display);
10646 #endif
10647 #endif /* ! USE_GTK */
10650 x_delete_display (dpyinfo);
10651 UNBLOCK_INPUT;
10654 /* Create a struct terminal, initialize it with the X11 specific
10655 functions and make DISPLAY->TERMINAL point to it. */
10657 static struct terminal *
10658 x_create_terminal (struct x_display_info *dpyinfo)
10660 struct terminal *terminal;
10662 terminal = create_terminal ();
10664 terminal->type = output_x_window;
10665 terminal->display_info.x = dpyinfo;
10666 dpyinfo->terminal = terminal;
10668 /* kboard is initialized in x_term_init. */
10670 terminal->clear_frame_hook = x_clear_frame;
10671 terminal->ins_del_lines_hook = x_ins_del_lines;
10672 terminal->delete_glyphs_hook = x_delete_glyphs;
10673 terminal->ring_bell_hook = XTring_bell;
10674 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10675 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10676 terminal->update_begin_hook = x_update_begin;
10677 terminal->update_end_hook = x_update_end;
10678 terminal->set_terminal_window_hook = XTset_terminal_window;
10679 terminal->read_socket_hook = XTread_socket;
10680 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10681 terminal->mouse_position_hook = XTmouse_position;
10682 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10683 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10684 terminal->fullscreen_hook = XTfullscreen_hook;
10685 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10686 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10687 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10688 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10690 terminal->delete_frame_hook = x_destroy_window;
10691 terminal->delete_terminal_hook = x_delete_terminal;
10693 terminal->rif = &x_redisplay_interface;
10694 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10695 terminal->char_ins_del_ok = 1;
10696 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10697 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10698 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10699 off the bottom. */
10701 return terminal;
10704 void
10705 x_initialize ()
10707 baud_rate = 19200;
10709 x_noop_count = 0;
10710 last_tool_bar_item = -1;
10711 any_help_event_p = 0;
10712 ignore_next_mouse_click_timeout = 0;
10713 #ifdef HAVE_X_SM
10714 x_session_initialized = 0;
10715 #endif
10717 #ifdef USE_GTK
10718 current_count = -1;
10719 #endif
10721 /* Try to use interrupt input; if we can't, then start polling. */
10722 Fset_input_interrupt_mode (Qt);
10724 #ifdef USE_X_TOOLKIT
10725 XtToolkitInitialize ();
10727 Xt_app_con = XtCreateApplicationContext ();
10729 /* Register a converter from strings to pixels, which uses
10730 Emacs' color allocation infrastructure. */
10731 XtAppSetTypeConverter (Xt_app_con,
10732 XtRString, XtRPixel, cvt_string_to_pixel,
10733 cvt_string_to_pixel_args,
10734 XtNumber (cvt_string_to_pixel_args),
10735 XtCacheByDisplay, cvt_pixel_dtor);
10737 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10738 #endif
10740 #ifdef USE_TOOLKIT_SCROLL_BARS
10741 #ifndef USE_GTK
10742 xaw3d_arrow_scroll = False;
10743 xaw3d_pick_top = True;
10744 #endif
10745 #endif
10747 /* Note that there is no real way portable across R3/R4 to get the
10748 original error handler. */
10749 XSetErrorHandler (x_error_handler);
10750 XSetIOErrorHandler (x_io_error_quitter);
10752 /* Disable Window Change signals; they are handled by X events. */
10753 #if 0 /* Don't. We may want to open tty frames later. */
10754 #ifdef SIGWINCH
10755 signal (SIGWINCH, SIG_DFL);
10756 #endif /* SIGWINCH */
10757 #endif
10759 signal (SIGPIPE, x_connection_signal);
10763 void
10764 syms_of_xterm ()
10766 x_error_message = NULL;
10768 staticpro (&x_display_name_list);
10769 x_display_name_list = Qnil;
10771 staticpro (&last_mouse_scroll_bar);
10772 last_mouse_scroll_bar = Qnil;
10774 staticpro (&Qvendor_specific_keysyms);
10775 Qvendor_specific_keysyms = intern ("vendor-specific-keysyms");
10777 staticpro (&Qlatin_1);
10778 Qlatin_1 = intern ("latin-1");
10780 staticpro (&last_mouse_press_frame);
10781 last_mouse_press_frame = Qnil;
10783 DEFVAR_BOOL ("x-use-underline-position-properties",
10784 &x_use_underline_position_properties,
10785 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10786 A value of nil means ignore them. If you encounter fonts with bogus
10787 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10788 to 4.1, set this to nil. */);
10789 x_use_underline_position_properties = 1;
10791 DEFVAR_BOOL ("x-underline-at-descent-line",
10792 &x_underline_at_descent_line,
10793 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10794 A value of nil means to draw the underline according to the value of the
10795 variable `x-use-underline-position-properties', which is usually at the
10796 baseline level. The default value is nil. */);
10797 x_underline_at_descent_line = 0;
10799 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10800 &x_mouse_click_focus_ignore_position,
10801 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10802 This variable is only used when the window manager requires that you
10803 click on a frame to select it (give it focus). In that case, a value
10804 of nil, means that the selected window and cursor position changes to
10805 reflect the mouse click position, while a non-nil value means that the
10806 selected window or cursor position is preserved. */);
10807 x_mouse_click_focus_ignore_position = 0;
10809 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10810 doc: /* What X toolkit scroll bars Emacs uses.
10811 A value of nil means Emacs doesn't use X toolkit scroll bars.
10812 Otherwise, value is a symbol describing the X toolkit. */);
10813 #ifdef USE_TOOLKIT_SCROLL_BARS
10814 #ifdef USE_MOTIF
10815 Vx_toolkit_scroll_bars = intern ("motif");
10816 #elif defined HAVE_XAW3D
10817 Vx_toolkit_scroll_bars = intern ("xaw3d");
10818 #elif USE_GTK
10819 Vx_toolkit_scroll_bars = intern ("gtk");
10820 #else
10821 Vx_toolkit_scroll_bars = intern ("xaw");
10822 #endif
10823 #else
10824 Vx_toolkit_scroll_bars = Qnil;
10825 #endif
10827 staticpro (&last_mouse_motion_frame);
10828 last_mouse_motion_frame = Qnil;
10830 Qmodifier_value = intern ("modifier-value");
10831 Qalt = intern ("alt");
10832 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10833 Qhyper = intern ("hyper");
10834 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10835 Qmeta = intern ("meta");
10836 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10837 Qsuper = intern ("super");
10838 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10840 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10841 doc: /* Which keys Emacs uses for the alt modifier.
10842 This should be one of the symbols `alt', `hyper', `meta', `super'.
10843 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10844 is nil, which is the same as `alt'. */);
10845 Vx_alt_keysym = Qnil;
10847 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10848 doc: /* Which keys Emacs uses for the hyper modifier.
10849 This should be one of the symbols `alt', `hyper', `meta', `super'.
10850 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10851 default is nil, which is the same as `hyper'. */);
10852 Vx_hyper_keysym = Qnil;
10854 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10855 doc: /* Which keys Emacs uses for the meta modifier.
10856 This should be one of the symbols `alt', `hyper', `meta', `super'.
10857 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10858 default is nil, which is the same as `meta'. */);
10859 Vx_meta_keysym = Qnil;
10861 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10862 doc: /* Which keys Emacs uses for the super modifier.
10863 This should be one of the symbols `alt', `hyper', `meta', `super'.
10864 For example, `super' means use the Super_L and Super_R keysyms. The
10865 default is nil, which is the same as `super'. */);
10866 Vx_super_keysym = Qnil;
10868 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10869 doc: /* Hash table of character codes indexed by X keysym codes. */);
10870 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10871 make_float (DEFAULT_REHASH_SIZE),
10872 make_float (DEFAULT_REHASH_THRESHOLD),
10873 Qnil, Qnil, Qnil);
10876 #endif /* HAVE_X_WINDOWS */
10878 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10879 (do not change this comment) */