(describe-current-coding-system):
[emacs.git] / src / xterm.c
blob42049c6939e541f0d9bf2a1bf1b6aead84668473
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->prev && s->prev->hl != s->hl && s->left_overhang)
2668 || (s->next && s->next->hl != s->hl && s->right_overhang))
2669 /* We must clip just this glyph. left_overhang part has already
2670 drawn when s->prev was drawn, and right_overhang part will be
2671 drawn later when s->next is drawn. */
2672 x_set_glyph_string_clipping_exactly (s, s);
2673 else
2674 x_set_glyph_string_clipping (s);
2676 switch (s->first_glyph->type)
2678 case IMAGE_GLYPH:
2679 x_draw_image_glyph_string (s);
2680 break;
2682 case STRETCH_GLYPH:
2683 x_draw_stretch_glyph_string (s);
2684 break;
2686 case CHAR_GLYPH:
2687 if (s->for_overlaps)
2688 s->background_filled_p = 1;
2689 else
2690 x_draw_glyph_string_background (s, 0);
2691 x_draw_glyph_string_foreground (s);
2692 break;
2694 case COMPOSITE_GLYPH:
2695 if (s->for_overlaps || s->gidx > 0)
2696 s->background_filled_p = 1;
2697 else
2698 x_draw_glyph_string_background (s, 1);
2699 x_draw_composite_glyph_string_foreground (s);
2700 break;
2702 default:
2703 abort ();
2706 if (!s->for_overlaps)
2708 /* Draw underline. */
2709 if (s->face->underline_p)
2711 unsigned long thickness, position;
2712 int y;
2714 if (s->prev && s->prev->face->underline_p)
2716 /* We use the same underline style as the previous one. */
2717 thickness = s->prev->underline_thickness;
2718 position = s->prev->underline_position;
2720 else
2722 /* Get the underline thickness. Default is 1 pixel. */
2723 if (s->font && s->font->underline_thickness > 0)
2724 thickness = s->font->underline_thickness;
2725 else
2726 thickness = 1;
2727 if (x_underline_at_descent_line)
2728 position = (s->height - thickness) - (s->ybase - s->y);
2729 else
2731 /* Get the underline position. This is the recommended
2732 vertical offset in pixels from the baseline to the top of
2733 the underline. This is a signed value according to the
2734 specs, and its default is
2736 ROUND ((maximum descent) / 2), with
2737 ROUND(x) = floor (x + 0.5) */
2739 if (x_use_underline_position_properties
2740 && s->font && s->font->underline_position >= 0)
2741 position = s->font->underline_position;
2742 else if (s->font)
2743 position = (s->font->descent + 1) / 2;
2746 /* Check the sanity of thickness and position. We should
2747 avoid drawing underline out of the current line area. */
2748 if (s->y + s->height <= s->ybase + position)
2749 position = (s->height - 1) - (s->ybase - s->y);
2750 if (s->y + s->height < s->ybase + position + thickness)
2751 thickness = (s->y + s->height) - (s->ybase + position);
2752 s->underline_thickness = thickness;
2753 s->underline_position = position;
2754 y = s->ybase + position;
2755 if (s->face->underline_defaulted_p)
2756 XFillRectangle (s->display, s->window, s->gc,
2757 s->x, y, s->background_width, thickness);
2758 else
2760 XGCValues xgcv;
2761 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2762 XSetForeground (s->display, s->gc, s->face->underline_color);
2763 XFillRectangle (s->display, s->window, s->gc,
2764 s->x, y, s->background_width, thickness);
2765 XSetForeground (s->display, s->gc, xgcv.foreground);
2769 /* Draw overline. */
2770 if (s->face->overline_p)
2772 unsigned long dy = 0, h = 1;
2774 if (s->face->overline_color_defaulted_p)
2775 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2776 s->background_width, h);
2777 else
2779 XGCValues xgcv;
2780 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2781 XSetForeground (s->display, s->gc, s->face->overline_color);
2782 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2783 s->background_width, h);
2784 XSetForeground (s->display, s->gc, xgcv.foreground);
2788 /* Draw strike-through. */
2789 if (s->face->strike_through_p)
2791 unsigned long h = 1;
2792 unsigned long dy = (s->height - h) / 2;
2794 if (s->face->strike_through_color_defaulted_p)
2795 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2796 s->width, h);
2797 else
2799 XGCValues xgcv;
2800 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2801 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2802 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2803 s->width, h);
2804 XSetForeground (s->display, s->gc, xgcv.foreground);
2808 /* Draw relief if not yet drawn. */
2809 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2810 x_draw_glyph_string_box (s);
2812 if (s->prev)
2814 struct glyph_string *prev;
2816 for (prev = s->prev; prev; prev = prev->prev)
2817 if (prev->hl != s->hl
2818 && prev->x + prev->width + prev->right_overhang > s->x)
2820 /* As prev was drawn while clipped to its own area, we
2821 must draw the right_overhang part using s->hl now. */
2822 enum draw_glyphs_face save = prev->hl;
2824 prev->hl = s->hl;
2825 x_set_glyph_string_gc (prev);
2826 x_set_glyph_string_clipping_exactly (s, prev);
2827 if (prev->first_glyph->type == CHAR_GLYPH)
2828 x_draw_glyph_string_foreground (prev);
2829 else
2830 x_draw_composite_glyph_string_foreground (prev);
2831 XSetClipMask (prev->display, prev->gc, None);
2832 prev->hl = save;
2833 prev->num_clips = 0;
2837 if (s->next)
2839 struct glyph_string *next;
2841 for (next = s->next; next; next = next->next)
2842 if (next->hl != s->hl
2843 && next->x - next->left_overhang < s->x + s->width)
2845 /* As next will be drawn while clipped to its own area,
2846 we must draw the left_overhang part using s->hl now. */
2847 enum draw_glyphs_face save = next->hl;
2849 next->hl = s->hl;
2850 x_set_glyph_string_gc (next);
2851 x_set_glyph_string_clipping_exactly (s, next);
2852 if (next->first_glyph->type == CHAR_GLYPH)
2853 x_draw_glyph_string_foreground (next);
2854 else
2855 x_draw_composite_glyph_string_foreground (next);
2856 XSetClipMask (next->display, next->gc, None);
2857 next->hl = save;
2858 next->num_clips = 0;
2863 /* Reset clipping. */
2864 XSetClipMask (s->display, s->gc, None);
2865 s->num_clips = 0;
2868 /* Shift display to make room for inserted glyphs. */
2870 void
2871 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2872 struct frame *f;
2873 int x, y, width, height, shift_by;
2875 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2876 f->output_data.x->normal_gc,
2877 x, y, width, height,
2878 x + shift_by, y);
2881 /* Delete N glyphs at the nominal cursor position. Not implemented
2882 for X frames. */
2884 static void
2885 x_delete_glyphs (f, n)
2886 struct frame *f;
2887 register int n;
2889 abort ();
2893 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2894 If they are <= 0, this is probably an error. */
2896 void
2897 x_clear_area (dpy, window, x, y, width, height, exposures)
2898 Display *dpy;
2899 Window window;
2900 int x, y;
2901 int width, height;
2902 int exposures;
2904 xassert (width > 0 && height > 0);
2905 XClearArea (dpy, window, x, y, width, height, exposures);
2909 /* Clear an entire frame. */
2911 static void
2912 x_clear_frame (struct frame *f)
2914 /* Clearing the frame will erase any cursor, so mark them all as no
2915 longer visible. */
2916 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2917 output_cursor.hpos = output_cursor.vpos = 0;
2918 output_cursor.x = -1;
2920 /* We don't set the output cursor here because there will always
2921 follow an explicit cursor_to. */
2922 BLOCK_INPUT;
2923 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2925 /* We have to clear the scroll bars, too. If we have changed
2926 colors or something like that, then they should be notified. */
2927 x_scroll_bar_clear (f);
2929 XFlush (FRAME_X_DISPLAY (f));
2931 UNBLOCK_INPUT;
2936 /* Invert the middle quarter of the frame for .15 sec. */
2938 /* We use the select system call to do the waiting, so we have to make
2939 sure it's available. If it isn't, we just won't do visual bells. */
2941 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2944 /* Subtract the `struct timeval' values X and Y, storing the result in
2945 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2947 static int
2948 timeval_subtract (result, x, y)
2949 struct timeval *result, x, y;
2951 /* Perform the carry for the later subtraction by updating y. This
2952 is safer because on some systems the tv_sec member is unsigned. */
2953 if (x.tv_usec < y.tv_usec)
2955 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2956 y.tv_usec -= 1000000 * nsec;
2957 y.tv_sec += nsec;
2960 if (x.tv_usec - y.tv_usec > 1000000)
2962 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2963 y.tv_usec += 1000000 * nsec;
2964 y.tv_sec -= nsec;
2967 /* Compute the time remaining to wait. tv_usec is certainly
2968 positive. */
2969 result->tv_sec = x.tv_sec - y.tv_sec;
2970 result->tv_usec = x.tv_usec - y.tv_usec;
2972 /* Return indication of whether the result should be considered
2973 negative. */
2974 return x.tv_sec < y.tv_sec;
2977 void
2978 XTflash (f)
2979 struct frame *f;
2981 BLOCK_INPUT;
2984 GC gc;
2986 /* Create a GC that will use the GXxor function to flip foreground
2987 pixels into background pixels. */
2989 XGCValues values;
2991 values.function = GXxor;
2992 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
2993 ^ FRAME_BACKGROUND_PIXEL (f));
2995 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2996 GCFunction | GCForeground, &values);
3000 /* Get the height not including a menu bar widget. */
3001 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3002 /* Height of each line to flash. */
3003 int flash_height = FRAME_LINE_HEIGHT (f);
3004 /* These will be the left and right margins of the rectangles. */
3005 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3006 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3008 int width;
3010 /* Don't flash the area between a scroll bar and the frame
3011 edge it is next to. */
3012 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3014 case vertical_scroll_bar_left:
3015 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3016 break;
3018 case vertical_scroll_bar_right:
3019 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3020 break;
3022 default:
3023 break;
3026 width = flash_right - flash_left;
3028 /* If window is tall, flash top and bottom line. */
3029 if (height > 3 * FRAME_LINE_HEIGHT (f))
3031 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3032 flash_left,
3033 (FRAME_INTERNAL_BORDER_WIDTH (f)
3034 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3035 width, flash_height);
3036 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3037 flash_left,
3038 (height - flash_height
3039 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3040 width, flash_height);
3042 else
3043 /* If it is short, flash it all. */
3044 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3045 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3046 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3048 x_flush (f);
3051 struct timeval wakeup;
3053 EMACS_GET_TIME (wakeup);
3055 /* Compute time to wait until, propagating carry from usecs. */
3056 wakeup.tv_usec += 150000;
3057 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3058 wakeup.tv_usec %= 1000000;
3060 /* Keep waiting until past the time wakeup or any input gets
3061 available. */
3062 while (! detect_input_pending ())
3064 struct timeval current;
3065 struct timeval timeout;
3067 EMACS_GET_TIME (current);
3069 /* Break if result would be negative. */
3070 if (timeval_subtract (&current, wakeup, current))
3071 break;
3073 /* How long `select' should wait. */
3074 timeout.tv_sec = 0;
3075 timeout.tv_usec = 10000;
3077 /* Try to wait that long--but we might wake up sooner. */
3078 select (0, NULL, NULL, NULL, &timeout);
3082 /* If window is tall, flash top and bottom line. */
3083 if (height > 3 * FRAME_LINE_HEIGHT (f))
3085 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3086 flash_left,
3087 (FRAME_INTERNAL_BORDER_WIDTH (f)
3088 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3089 width, flash_height);
3090 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3091 flash_left,
3092 (height - flash_height
3093 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3094 width, flash_height);
3096 else
3097 /* If it is short, flash it all. */
3098 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3099 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3100 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3102 XFreeGC (FRAME_X_DISPLAY (f), gc);
3103 x_flush (f);
3107 UNBLOCK_INPUT;
3110 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3113 /* Make audible bell. */
3115 void
3116 XTring_bell ()
3118 struct frame *f = SELECTED_FRAME ();
3120 if (FRAME_X_DISPLAY (f))
3122 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3123 if (visible_bell)
3124 XTflash (f);
3125 else
3126 #endif
3128 BLOCK_INPUT;
3129 XBell (FRAME_X_DISPLAY (f), 0);
3130 XFlush (FRAME_X_DISPLAY (f));
3131 UNBLOCK_INPUT;
3137 /* Specify how many text lines, from the top of the window,
3138 should be affected by insert-lines and delete-lines operations.
3139 This, and those operations, are used only within an update
3140 that is bounded by calls to x_update_begin and x_update_end. */
3142 static void
3143 XTset_terminal_window (n)
3144 register int n;
3146 /* This function intentionally left blank. */
3151 /***********************************************************************
3152 Line Dance
3153 ***********************************************************************/
3155 /* Perform an insert-lines or delete-lines operation, inserting N
3156 lines or deleting -N lines at vertical position VPOS. */
3158 static void
3159 x_ins_del_lines (f, vpos, n)
3160 struct frame *f;
3161 int vpos, n;
3163 abort ();
3167 /* Scroll part of the display as described by RUN. */
3169 static void
3170 x_scroll_run (w, run)
3171 struct window *w;
3172 struct run *run;
3174 struct frame *f = XFRAME (w->frame);
3175 int x, y, width, height, from_y, to_y, bottom_y;
3177 /* Get frame-relative bounding box of the text display area of W,
3178 without mode lines. Include in this box the left and right
3179 fringe of W. */
3180 window_box (w, -1, &x, &y, &width, &height);
3182 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3183 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3184 bottom_y = y + height;
3186 if (to_y < from_y)
3188 /* Scrolling up. Make sure we don't copy part of the mode
3189 line at the bottom. */
3190 if (from_y + run->height > bottom_y)
3191 height = bottom_y - from_y;
3192 else
3193 height = run->height;
3195 else
3197 /* Scolling down. Make sure we don't copy over the mode line.
3198 at the bottom. */
3199 if (to_y + run->height > bottom_y)
3200 height = bottom_y - to_y;
3201 else
3202 height = run->height;
3205 BLOCK_INPUT;
3207 /* Cursor off. Will be switched on again in x_update_window_end. */
3208 updated_window = w;
3209 x_clear_cursor (w);
3211 XCopyArea (FRAME_X_DISPLAY (f),
3212 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3213 f->output_data.x->normal_gc,
3214 x, from_y,
3215 width, height,
3216 x, to_y);
3218 UNBLOCK_INPUT;
3223 /***********************************************************************
3224 Exposure Events
3225 ***********************************************************************/
3228 static void
3229 frame_highlight (f)
3230 struct frame *f;
3232 /* We used to only do this if Vx_no_window_manager was non-nil, but
3233 the ICCCM (section 4.1.6) says that the window's border pixmap
3234 and border pixel are window attributes which are "private to the
3235 client", so we can always change it to whatever we want. */
3236 BLOCK_INPUT;
3237 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3238 f->output_data.x->border_pixel);
3239 UNBLOCK_INPUT;
3240 x_update_cursor (f, 1);
3241 x_set_frame_alpha (f);
3244 static void
3245 frame_unhighlight (f)
3246 struct frame *f;
3248 /* We used to only do this if Vx_no_window_manager was non-nil, but
3249 the ICCCM (section 4.1.6) says that the window's border pixmap
3250 and border pixel are window attributes which are "private to the
3251 client", so we can always change it to whatever we want. */
3252 BLOCK_INPUT;
3253 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3254 f->output_data.x->border_tile);
3255 UNBLOCK_INPUT;
3256 x_update_cursor (f, 1);
3257 x_set_frame_alpha (f);
3260 /* The focus has changed. Update the frames as necessary to reflect
3261 the new situation. Note that we can't change the selected frame
3262 here, because the Lisp code we are interrupting might become confused.
3263 Each event gets marked with the frame in which it occurred, so the
3264 Lisp code can tell when the switch took place by examining the events. */
3266 static void
3267 x_new_focus_frame (dpyinfo, frame)
3268 struct x_display_info *dpyinfo;
3269 struct frame *frame;
3271 struct frame *old_focus = dpyinfo->x_focus_frame;
3273 if (frame != dpyinfo->x_focus_frame)
3275 /* Set this before calling other routines, so that they see
3276 the correct value of x_focus_frame. */
3277 dpyinfo->x_focus_frame = frame;
3279 if (old_focus && old_focus->auto_lower)
3280 x_lower_frame (old_focus);
3282 #if 0
3283 selected_frame = frame;
3284 XSETFRAME (XWINDOW (selected_frame->selected_window)->frame,
3285 selected_frame);
3286 Fselect_window (selected_frame->selected_window, Qnil);
3287 choose_minibuf_frame ();
3288 #endif /* ! 0 */
3290 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3291 pending_autoraise_frame = dpyinfo->x_focus_frame;
3292 else
3293 pending_autoraise_frame = 0;
3296 x_frame_rehighlight (dpyinfo);
3299 /* Handle FocusIn and FocusOut state changes for FRAME.
3300 If FRAME has focus and there exists more than one frame, puts
3301 a FOCUS_IN_EVENT into *BUFP. */
3303 static void
3304 x_focus_changed (type, state, dpyinfo, frame, bufp)
3305 int type;
3306 int state;
3307 struct x_display_info *dpyinfo;
3308 struct frame *frame;
3309 struct input_event *bufp;
3311 if (type == FocusIn)
3313 if (dpyinfo->x_focus_event_frame != frame)
3315 x_new_focus_frame (dpyinfo, frame);
3316 dpyinfo->x_focus_event_frame = frame;
3318 /* Don't stop displaying the initial startup message
3319 for a switch-frame event we don't need. */
3320 if (NILP (Vterminal_frame)
3321 && CONSP (Vframe_list)
3322 && !NILP (XCDR (Vframe_list)))
3324 bufp->kind = FOCUS_IN_EVENT;
3325 XSETFRAME (bufp->frame_or_window, frame);
3329 frame->output_data.x->focus_state |= state;
3331 #ifdef HAVE_X_I18N
3332 if (FRAME_XIC (frame))
3333 XSetICFocus (FRAME_XIC (frame));
3334 #endif
3336 else if (type == FocusOut)
3338 frame->output_data.x->focus_state &= ~state;
3340 if (dpyinfo->x_focus_event_frame == frame)
3342 dpyinfo->x_focus_event_frame = 0;
3343 x_new_focus_frame (dpyinfo, 0);
3346 #ifdef HAVE_X_I18N
3347 if (FRAME_XIC (frame))
3348 XUnsetICFocus (FRAME_XIC (frame));
3349 #endif
3353 /* The focus may have changed. Figure out if it is a real focus change,
3354 by checking both FocusIn/Out and Enter/LeaveNotify events.
3356 Returns FOCUS_IN_EVENT event in *BUFP. */
3358 static void
3359 x_detect_focus_change (dpyinfo, event, bufp)
3360 struct x_display_info *dpyinfo;
3361 XEvent *event;
3362 struct input_event *bufp;
3364 struct frame *frame;
3366 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3367 if (! frame)
3368 return;
3370 switch (event->type)
3372 case EnterNotify:
3373 case LeaveNotify:
3375 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3376 int focus_state
3377 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3379 if (event->xcrossing.detail != NotifyInferior
3380 && event->xcrossing.focus
3381 && ! (focus_state & FOCUS_EXPLICIT))
3382 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3383 FOCUS_IMPLICIT,
3384 dpyinfo, frame, bufp);
3386 break;
3388 case FocusIn:
3389 case FocusOut:
3390 x_focus_changed (event->type,
3391 (event->xfocus.detail == NotifyPointer ?
3392 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3393 dpyinfo, frame, bufp);
3394 break;
3396 case ClientMessage:
3397 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3399 enum xembed_message msg = event->xclient.data.l[1];
3400 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3401 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3403 break;
3408 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3410 void
3411 x_mouse_leave (dpyinfo)
3412 struct x_display_info *dpyinfo;
3414 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3417 /* The focus has changed, or we have redirected a frame's focus to
3418 another frame (this happens when a frame uses a surrogate
3419 mini-buffer frame). Shift the highlight as appropriate.
3421 The FRAME argument doesn't necessarily have anything to do with which
3422 frame is being highlighted or un-highlighted; we only use it to find
3423 the appropriate X display info. */
3425 static void
3426 XTframe_rehighlight (frame)
3427 struct frame *frame;
3429 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3432 static void
3433 x_frame_rehighlight (dpyinfo)
3434 struct x_display_info *dpyinfo;
3436 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3438 if (dpyinfo->x_focus_frame)
3440 dpyinfo->x_highlight_frame
3441 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3442 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3443 : dpyinfo->x_focus_frame);
3444 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3446 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3447 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3450 else
3451 dpyinfo->x_highlight_frame = 0;
3453 if (dpyinfo->x_highlight_frame != old_highlight)
3455 if (old_highlight)
3456 frame_unhighlight (old_highlight);
3457 if (dpyinfo->x_highlight_frame)
3458 frame_highlight (dpyinfo->x_highlight_frame);
3464 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3466 /* Initialize mode_switch_bit and modifier_meaning. */
3467 static void
3468 x_find_modifier_meanings (dpyinfo)
3469 struct x_display_info *dpyinfo;
3471 int min_code, max_code;
3472 KeySym *syms;
3473 int syms_per_code;
3474 XModifierKeymap *mods;
3476 dpyinfo->meta_mod_mask = 0;
3477 dpyinfo->shift_lock_mask = 0;
3478 dpyinfo->alt_mod_mask = 0;
3479 dpyinfo->super_mod_mask = 0;
3480 dpyinfo->hyper_mod_mask = 0;
3482 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3484 syms = XGetKeyboardMapping (dpyinfo->display,
3485 min_code, max_code - min_code + 1,
3486 &syms_per_code);
3487 mods = XGetModifierMapping (dpyinfo->display);
3489 /* Scan the modifier table to see which modifier bits the Meta and
3490 Alt keysyms are on. */
3492 int row, col; /* The row and column in the modifier table. */
3493 int found_alt_or_meta;
3495 for (row = 3; row < 8; row++)
3497 found_alt_or_meta = 0;
3498 for (col = 0; col < mods->max_keypermod; col++)
3500 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3502 /* Zeroes are used for filler. Skip them. */
3503 if (code == 0)
3504 continue;
3506 /* Are any of this keycode's keysyms a meta key? */
3508 int code_col;
3510 for (code_col = 0; code_col < syms_per_code; code_col++)
3512 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3514 switch (sym)
3516 case XK_Meta_L:
3517 case XK_Meta_R:
3518 found_alt_or_meta = 1;
3519 dpyinfo->meta_mod_mask |= (1 << row);
3520 break;
3522 case XK_Alt_L:
3523 case XK_Alt_R:
3524 found_alt_or_meta = 1;
3525 dpyinfo->alt_mod_mask |= (1 << row);
3526 break;
3528 case XK_Hyper_L:
3529 case XK_Hyper_R:
3530 if (!found_alt_or_meta)
3531 dpyinfo->hyper_mod_mask |= (1 << row);
3532 code_col = syms_per_code;
3533 col = mods->max_keypermod;
3534 break;
3536 case XK_Super_L:
3537 case XK_Super_R:
3538 if (!found_alt_or_meta)
3539 dpyinfo->super_mod_mask |= (1 << row);
3540 code_col = syms_per_code;
3541 col = mods->max_keypermod;
3542 break;
3544 case XK_Shift_Lock:
3545 /* Ignore this if it's not on the lock modifier. */
3546 if (!found_alt_or_meta && ((1 << row) == LockMask))
3547 dpyinfo->shift_lock_mask = LockMask;
3548 code_col = syms_per_code;
3549 col = mods->max_keypermod;
3550 break;
3558 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3559 if (! dpyinfo->meta_mod_mask)
3561 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3562 dpyinfo->alt_mod_mask = 0;
3565 /* If some keys are both alt and meta,
3566 make them just meta, not alt. */
3567 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3569 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3572 XFree ((char *) syms);
3573 XFreeModifiermap (mods);
3576 /* Convert between the modifier bits X uses and the modifier bits
3577 Emacs uses. */
3579 unsigned int
3580 x_x_to_emacs_modifiers (dpyinfo, state)
3581 struct x_display_info *dpyinfo;
3582 unsigned int state;
3584 EMACS_UINT mod_meta = meta_modifier;
3585 EMACS_UINT mod_alt = alt_modifier;
3586 EMACS_UINT mod_hyper = hyper_modifier;
3587 EMACS_UINT mod_super = super_modifier;
3588 Lisp_Object tem;
3590 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3591 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3592 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3593 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3594 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3595 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3596 tem = Fget (Vx_super_keysym, Qmodifier_value);
3597 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3600 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3601 | ((state & ControlMask) ? ctrl_modifier : 0)
3602 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3603 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3604 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3605 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3608 static unsigned int
3609 x_emacs_to_x_modifiers (dpyinfo, state)
3610 struct x_display_info *dpyinfo;
3611 unsigned int state;
3613 EMACS_UINT mod_meta = meta_modifier;
3614 EMACS_UINT mod_alt = alt_modifier;
3615 EMACS_UINT mod_hyper = hyper_modifier;
3616 EMACS_UINT mod_super = super_modifier;
3618 Lisp_Object tem;
3620 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3621 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3622 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3623 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3624 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3625 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3626 tem = Fget (Vx_super_keysym, Qmodifier_value);
3627 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3630 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3631 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3632 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3633 | ((state & shift_modifier) ? ShiftMask : 0)
3634 | ((state & ctrl_modifier) ? ControlMask : 0)
3635 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3638 /* Convert a keysym to its name. */
3640 char *
3641 x_get_keysym_name (keysym)
3642 KeySym keysym;
3644 char *value;
3646 BLOCK_INPUT;
3647 value = XKeysymToString (keysym);
3648 UNBLOCK_INPUT;
3650 return value;
3655 /* Mouse clicks and mouse movement. Rah. */
3657 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3659 If the event is a button press, then note that we have grabbed
3660 the mouse. */
3662 static Lisp_Object
3663 construct_mouse_click (result, event, f)
3664 struct input_event *result;
3665 XButtonEvent *event;
3666 struct frame *f;
3668 /* Make the event type NO_EVENT; we'll change that when we decide
3669 otherwise. */
3670 result->kind = MOUSE_CLICK_EVENT;
3671 result->code = event->button - Button1;
3672 result->timestamp = event->time;
3673 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3674 event->state)
3675 | (event->type == ButtonRelease
3676 ? up_modifier
3677 : down_modifier));
3679 XSETINT (result->x, event->x);
3680 XSETINT (result->y, event->y);
3681 XSETFRAME (result->frame_or_window, f);
3682 result->arg = Qnil;
3683 return Qnil;
3687 /* Function to report a mouse movement to the mainstream Emacs code.
3688 The input handler calls this.
3690 We have received a mouse movement event, which is given in *event.
3691 If the mouse is over a different glyph than it was last time, tell
3692 the mainstream emacs code by setting mouse_moved. If not, ask for
3693 another motion event, so we can check again the next time it moves. */
3695 static XMotionEvent last_mouse_motion_event;
3696 static Lisp_Object last_mouse_motion_frame;
3698 static int
3699 note_mouse_movement (frame, event)
3700 FRAME_PTR frame;
3701 XMotionEvent *event;
3703 last_mouse_movement_time = event->time;
3704 last_mouse_motion_event = *event;
3705 XSETFRAME (last_mouse_motion_frame, frame);
3707 if (!FRAME_X_OUTPUT (frame))
3708 return 0;
3710 if (event->window != FRAME_X_WINDOW (frame))
3712 frame->mouse_moved = 1;
3713 last_mouse_scroll_bar = Qnil;
3714 note_mouse_highlight (frame, -1, -1);
3715 last_mouse_glyph_frame = 0;
3716 return 1;
3720 /* Has the mouse moved off the glyph it was on at the last sighting? */
3721 if (frame != last_mouse_glyph_frame
3722 || event->x < last_mouse_glyph.x
3723 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3724 || event->y < last_mouse_glyph.y
3725 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3727 frame->mouse_moved = 1;
3728 last_mouse_scroll_bar = Qnil;
3729 note_mouse_highlight (frame, event->x, event->y);
3730 /* Remember which glyph we're now on. */
3731 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3732 last_mouse_glyph_frame = frame;
3733 return 1;
3736 return 0;
3740 /************************************************************************
3741 Mouse Face
3742 ************************************************************************/
3744 static void
3745 redo_mouse_highlight ()
3747 if (!NILP (last_mouse_motion_frame)
3748 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3749 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3750 last_mouse_motion_event.x,
3751 last_mouse_motion_event.y);
3756 /* Return the current position of the mouse.
3757 *FP should be a frame which indicates which display to ask about.
3759 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3760 and *PART to the frame, window, and scroll bar part that the mouse
3761 is over. Set *X and *Y to the portion and whole of the mouse's
3762 position on the scroll bar.
3764 If the mouse movement started elsewhere, set *FP to the frame the
3765 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3766 the mouse is over.
3768 Set *TIME to the server time-stamp for the time at which the mouse
3769 was at this position.
3771 Don't store anything if we don't have a valid set of values to report.
3773 This clears the mouse_moved flag, so we can wait for the next mouse
3774 movement. */
3776 static void
3777 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3778 FRAME_PTR *fp;
3779 int insist;
3780 Lisp_Object *bar_window;
3781 enum scroll_bar_part *part;
3782 Lisp_Object *x, *y;
3783 unsigned long *time;
3785 FRAME_PTR f1;
3787 BLOCK_INPUT;
3789 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3790 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3791 else
3793 Window root;
3794 int root_x, root_y;
3796 Window dummy_window;
3797 int dummy;
3799 Lisp_Object frame, tail;
3801 /* Clear the mouse-moved flag for every frame on this display. */
3802 FOR_EACH_FRAME (tail, frame)
3803 if (FRAME_X_P (XFRAME (frame))
3804 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3805 XFRAME (frame)->mouse_moved = 0;
3807 last_mouse_scroll_bar = Qnil;
3809 /* Figure out which root window we're on. */
3810 XQueryPointer (FRAME_X_DISPLAY (*fp),
3811 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3813 /* The root window which contains the pointer. */
3814 &root,
3816 /* Trash which we can't trust if the pointer is on
3817 a different screen. */
3818 &dummy_window,
3820 /* The position on that root window. */
3821 &root_x, &root_y,
3823 /* More trash we can't trust. */
3824 &dummy, &dummy,
3826 /* Modifier keys and pointer buttons, about which
3827 we don't care. */
3828 (unsigned int *) &dummy);
3830 /* Now we have a position on the root; find the innermost window
3831 containing the pointer. */
3833 Window win, child;
3834 int win_x, win_y;
3835 int parent_x = 0, parent_y = 0;
3837 win = root;
3839 /* XTranslateCoordinates can get errors if the window
3840 structure is changing at the same time this function
3841 is running. So at least we must not crash from them. */
3843 x_catch_errors (FRAME_X_DISPLAY (*fp));
3845 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3846 && FRAME_LIVE_P (last_mouse_frame))
3848 /* If mouse was grabbed on a frame, give coords for that frame
3849 even if the mouse is now outside it. */
3850 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3852 /* From-window, to-window. */
3853 root, FRAME_X_WINDOW (last_mouse_frame),
3855 /* From-position, to-position. */
3856 root_x, root_y, &win_x, &win_y,
3858 /* Child of win. */
3859 &child);
3860 f1 = last_mouse_frame;
3862 else
3864 while (1)
3866 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3868 /* From-window, to-window. */
3869 root, win,
3871 /* From-position, to-position. */
3872 root_x, root_y, &win_x, &win_y,
3874 /* Child of win. */
3875 &child);
3877 if (child == None || child == win)
3878 break;
3880 win = child;
3881 parent_x = win_x;
3882 parent_y = win_y;
3885 /* Now we know that:
3886 win is the innermost window containing the pointer
3887 (XTC says it has no child containing the pointer),
3888 win_x and win_y are the pointer's position in it
3889 (XTC did this the last time through), and
3890 parent_x and parent_y are the pointer's position in win's parent.
3891 (They are what win_x and win_y were when win was child.
3892 If win is the root window, it has no parent, and
3893 parent_{x,y} are invalid, but that's okay, because we'll
3894 never use them in that case.) */
3896 /* Is win one of our frames? */
3897 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3899 #ifdef USE_X_TOOLKIT
3900 /* If we end up with the menu bar window, say it's not
3901 on the frame. */
3902 if (f1 != NULL
3903 && f1->output_data.x->menubar_widget
3904 && win == XtWindow (f1->output_data.x->menubar_widget))
3905 f1 = NULL;
3906 #endif /* USE_X_TOOLKIT */
3909 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3910 f1 = 0;
3912 x_uncatch_errors ();
3914 /* If not, is it one of our scroll bars? */
3915 if (! f1)
3917 struct scroll_bar *bar;
3919 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3921 if (bar)
3923 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3924 win_x = parent_x;
3925 win_y = parent_y;
3929 if (f1 == 0 && insist > 0)
3930 f1 = SELECTED_FRAME ();
3932 if (f1)
3934 /* Ok, we found a frame. Store all the values.
3935 last_mouse_glyph is a rectangle used to reduce the
3936 generation of mouse events. To not miss any motion
3937 events, we must divide the frame into rectangles of the
3938 size of the smallest character that could be displayed
3939 on it, i.e. into the same rectangles that matrices on
3940 the frame are divided into. */
3942 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3943 last_mouse_glyph_frame = f1;
3945 *bar_window = Qnil;
3946 *part = 0;
3947 *fp = f1;
3948 XSETINT (*x, win_x);
3949 XSETINT (*y, win_y);
3950 *time = last_mouse_movement_time;
3955 UNBLOCK_INPUT;
3960 /***********************************************************************
3961 Scroll bars
3962 ***********************************************************************/
3964 /* Scroll bar support. */
3966 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
3967 manages it.
3968 This can be called in GC, so we have to make sure to strip off mark
3969 bits. */
3971 static struct scroll_bar *
3972 x_window_to_scroll_bar (display, window_id)
3973 Display *display;
3974 Window window_id;
3976 Lisp_Object tail;
3978 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3979 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
3980 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
3982 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
3984 Lisp_Object frame, bar, condemned;
3986 frame = XCAR (tail);
3987 /* All elements of Vframe_list should be frames. */
3988 if (! FRAMEP (frame))
3989 abort ();
3991 if (! FRAME_X_P (XFRAME (frame)))
3992 continue;
3994 /* Scan this frame's scroll bar list for a scroll bar with the
3995 right window ID. */
3996 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
3997 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
3998 /* This trick allows us to search both the ordinary and
3999 condemned scroll bar lists with one loop. */
4000 ! NILP (bar) || (bar = condemned,
4001 condemned = Qnil,
4002 ! NILP (bar));
4003 bar = XSCROLL_BAR (bar)->next)
4004 if (XSCROLL_BAR (bar)->x_window == window_id &&
4005 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4006 return XSCROLL_BAR (bar);
4009 return 0;
4013 #if defined USE_LUCID
4015 /* Return the Lucid menu bar WINDOW is part of. Return null
4016 if WINDOW is not part of a menu bar. */
4018 static Widget
4019 x_window_to_menu_bar (window)
4020 Window window;
4022 Lisp_Object tail;
4024 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4026 if (FRAME_X_P (XFRAME (XCAR (tail))))
4028 Lisp_Object frame = XCAR (tail);
4029 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4031 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4032 return menu_bar;
4036 return NULL;
4039 #endif /* USE_LUCID */
4042 /************************************************************************
4043 Toolkit scroll bars
4044 ************************************************************************/
4046 #ifdef USE_TOOLKIT_SCROLL_BARS
4048 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
4049 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
4050 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
4051 struct scroll_bar *));
4052 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
4053 int, int, int));
4056 /* Lisp window being scrolled. Set when starting to interact with
4057 a toolkit scroll bar, reset to nil when ending the interaction. */
4059 static Lisp_Object window_being_scrolled;
4061 /* Last scroll bar part sent in xm_scroll_callback. */
4063 static int last_scroll_bar_part;
4065 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4066 that movements of 1/20 of the screen size are mapped to up/down. */
4068 #ifndef USE_GTK
4069 /* Id of action hook installed for scroll bars. */
4071 static XtActionHookId action_hook_id;
4073 static Boolean xaw3d_arrow_scroll;
4075 /* Whether the drag scrolling maintains the mouse at the top of the
4076 thumb. If not, resizing the thumb needs to be done more carefully
4077 to avoid jerkyness. */
4079 static Boolean xaw3d_pick_top;
4081 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4082 bars are used.. The hook is responsible for detecting when
4083 the user ends an interaction with the scroll bar, and generates
4084 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4086 static void
4087 xt_action_hook (widget, client_data, action_name, event, params,
4088 num_params)
4089 Widget widget;
4090 XtPointer client_data;
4091 String action_name;
4092 XEvent *event;
4093 String *params;
4094 Cardinal *num_params;
4096 int scroll_bar_p;
4097 char *end_action;
4099 #ifdef USE_MOTIF
4100 scroll_bar_p = XmIsScrollBar (widget);
4101 end_action = "Release";
4102 #else /* !USE_MOTIF i.e. use Xaw */
4103 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4104 end_action = "EndScroll";
4105 #endif /* USE_MOTIF */
4107 if (scroll_bar_p
4108 && strcmp (action_name, end_action) == 0
4109 && WINDOWP (window_being_scrolled))
4111 struct window *w;
4113 x_send_scroll_bar_event (window_being_scrolled,
4114 scroll_bar_end_scroll, 0, 0);
4115 w = XWINDOW (window_being_scrolled);
4117 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4119 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4120 /* The thumb size is incorrect while dragging: fix it. */
4121 set_vertical_scroll_bar (w);
4123 window_being_scrolled = Qnil;
4124 last_scroll_bar_part = -1;
4126 /* Xt timeouts no longer needed. */
4127 toolkit_scroll_bar_interaction = 0;
4130 #endif /* not USE_GTK */
4132 /* A vector of windows used for communication between
4133 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4135 static struct window **scroll_bar_windows;
4136 static int scroll_bar_windows_size;
4139 /* Send a client message with message type Xatom_Scrollbar for a
4140 scroll action to the frame of WINDOW. PART is a value identifying
4141 the part of the scroll bar that was clicked on. PORTION is the
4142 amount to scroll of a whole of WHOLE. */
4144 static void
4145 x_send_scroll_bar_event (window, part, portion, whole)
4146 Lisp_Object window;
4147 int part, portion, whole;
4149 XEvent event;
4150 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4151 struct window *w = XWINDOW (window);
4152 struct frame *f = XFRAME (w->frame);
4153 int i;
4155 BLOCK_INPUT;
4157 /* Construct a ClientMessage event to send to the frame. */
4158 ev->type = ClientMessage;
4159 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4160 ev->display = FRAME_X_DISPLAY (f);
4161 ev->window = FRAME_X_WINDOW (f);
4162 ev->format = 32;
4164 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4165 not enough to store a pointer or Lisp_Object on a 64 bit system.
4166 So, store the window in scroll_bar_windows and pass the index
4167 into that array in the event. */
4168 for (i = 0; i < scroll_bar_windows_size; ++i)
4169 if (scroll_bar_windows[i] == NULL)
4170 break;
4172 if (i == scroll_bar_windows_size)
4174 int new_size = max (10, 2 * scroll_bar_windows_size);
4175 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4176 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4178 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4179 nbytes);
4180 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4181 scroll_bar_windows_size = new_size;
4184 scroll_bar_windows[i] = w;
4185 ev->data.l[0] = (long) i;
4186 ev->data.l[1] = (long) part;
4187 ev->data.l[2] = (long) 0;
4188 ev->data.l[3] = (long) portion;
4189 ev->data.l[4] = (long) whole;
4191 /* Make Xt timeouts work while the scroll bar is active. */
4192 toolkit_scroll_bar_interaction = 1;
4193 #ifdef USE_X_TOOLKIT
4194 x_activate_timeout_atimer ();
4195 #endif
4197 /* Setting the event mask to zero means that the message will
4198 be sent to the client that created the window, and if that
4199 window no longer exists, no event will be sent. */
4200 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4201 UNBLOCK_INPUT;
4205 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4206 in *IEVENT. */
4208 static void
4209 x_scroll_bar_to_input_event (event, ievent)
4210 XEvent *event;
4211 struct input_event *ievent;
4213 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4214 Lisp_Object window;
4215 struct frame *f;
4216 struct window *w;
4218 w = scroll_bar_windows[ev->data.l[0]];
4219 scroll_bar_windows[ev->data.l[0]] = NULL;
4221 XSETWINDOW (window, w);
4222 f = XFRAME (w->frame);
4224 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4225 ievent->frame_or_window = window;
4226 ievent->arg = Qnil;
4227 #ifdef USE_GTK
4228 ievent->timestamp = CurrentTime;
4229 #else
4230 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4231 #endif
4232 ievent->part = ev->data.l[1];
4233 ievent->code = ev->data.l[2];
4234 ievent->x = make_number ((int) ev->data.l[3]);
4235 ievent->y = make_number ((int) ev->data.l[4]);
4236 ievent->modifiers = 0;
4240 #ifdef USE_MOTIF
4242 /* Minimum and maximum values used for Motif scroll bars. */
4244 #define XM_SB_MAX 10000000
4247 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4248 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4249 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4251 static void
4252 xm_scroll_callback (widget, client_data, call_data)
4253 Widget widget;
4254 XtPointer client_data, call_data;
4256 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4257 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4258 int part = -1, whole = 0, portion = 0;
4260 switch (cs->reason)
4262 case XmCR_DECREMENT:
4263 bar->dragging = Qnil;
4264 part = scroll_bar_up_arrow;
4265 break;
4267 case XmCR_INCREMENT:
4268 bar->dragging = Qnil;
4269 part = scroll_bar_down_arrow;
4270 break;
4272 case XmCR_PAGE_DECREMENT:
4273 bar->dragging = Qnil;
4274 part = scroll_bar_above_handle;
4275 break;
4277 case XmCR_PAGE_INCREMENT:
4278 bar->dragging = Qnil;
4279 part = scroll_bar_below_handle;
4280 break;
4282 case XmCR_TO_TOP:
4283 bar->dragging = Qnil;
4284 part = scroll_bar_to_top;
4285 break;
4287 case XmCR_TO_BOTTOM:
4288 bar->dragging = Qnil;
4289 part = scroll_bar_to_bottom;
4290 break;
4292 case XmCR_DRAG:
4294 int slider_size;
4296 /* Get the slider size. */
4297 BLOCK_INPUT;
4298 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4299 UNBLOCK_INPUT;
4301 whole = XM_SB_MAX - slider_size;
4302 portion = min (cs->value, whole);
4303 part = scroll_bar_handle;
4304 bar->dragging = make_number (cs->value);
4306 break;
4308 case XmCR_VALUE_CHANGED:
4309 break;
4312 if (part >= 0)
4314 window_being_scrolled = bar->window;
4315 last_scroll_bar_part = part;
4316 x_send_scroll_bar_event (bar->window, part, portion, whole);
4320 #elif defined USE_GTK
4322 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4323 bar widget. DATA is a pointer to the scroll_bar structure. */
4325 static void
4326 xg_scroll_callback (widget, data)
4327 GtkRange *widget;
4328 gpointer data;
4330 struct scroll_bar *bar = (struct scroll_bar *) data;
4331 gdouble previous;
4332 gdouble position;
4333 gdouble *p;
4334 int diff;
4336 int part = -1, whole = 0, portion = 0;
4337 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (widget));
4339 position = gtk_adjustment_get_value (adj);
4341 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
4342 if (! p)
4344 p = (gdouble*) xmalloc (sizeof (gdouble));
4345 *p = XG_SB_MIN;
4346 g_object_set_data (G_OBJECT (widget), XG_LAST_SB_DATA, p);
4349 previous = *p;
4350 *p = position;
4352 if (xg_ignore_gtk_scrollbar) return;
4354 diff = (int) (position - previous);
4356 if (diff == (int) adj->step_increment)
4358 part = scroll_bar_down_arrow;
4359 bar->dragging = Qnil;
4361 else if (-diff == (int) adj->step_increment)
4363 part = scroll_bar_up_arrow;
4364 bar->dragging = Qnil;
4366 else if (diff == (int) adj->page_increment)
4368 part = scroll_bar_below_handle;
4369 bar->dragging = Qnil;
4371 else if (-diff == (int) adj->page_increment)
4373 part = scroll_bar_above_handle;
4374 bar->dragging = Qnil;
4376 else
4378 part = scroll_bar_handle;
4379 whole = adj->upper - adj->page_size;
4380 portion = min ((int)position, whole);
4381 bar->dragging = make_number ((int)portion);
4384 if (part >= 0)
4386 window_being_scrolled = bar->window;
4387 last_scroll_bar_part = part;
4388 x_send_scroll_bar_event (bar->window, part, portion, whole);
4392 #else /* not USE_GTK and not USE_MOTIF */
4394 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4395 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4396 scroll bar struct. CALL_DATA is a pointer to a float saying where
4397 the thumb is. */
4399 static void
4400 xaw_jump_callback (widget, client_data, call_data)
4401 Widget widget;
4402 XtPointer client_data, call_data;
4404 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4405 float top = *(float *) call_data;
4406 float shown;
4407 int whole, portion, height;
4408 int part;
4410 /* Get the size of the thumb, a value between 0 and 1. */
4411 BLOCK_INPUT;
4412 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4413 UNBLOCK_INPUT;
4415 whole = 10000000;
4416 portion = shown < 1 ? top * whole : 0;
4418 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4419 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4420 the bottom, so we force the scrolling whenever we see that we're
4421 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4422 we try to ensure that we always stay two pixels away from the
4423 bottom). */
4424 part = scroll_bar_down_arrow;
4425 else
4426 part = scroll_bar_handle;
4428 window_being_scrolled = bar->window;
4429 bar->dragging = make_number (portion);
4430 last_scroll_bar_part = part;
4431 x_send_scroll_bar_event (bar->window, part, portion, whole);
4435 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4436 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4437 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4438 the scroll bar. CALL_DATA is an integer specifying the action that
4439 has taken place. Its magnitude is in the range 0..height of the
4440 scroll bar. Negative values mean scroll towards buffer start.
4441 Values < height of scroll bar mean line-wise movement. */
4443 static void
4444 xaw_scroll_callback (widget, client_data, call_data)
4445 Widget widget;
4446 XtPointer client_data, call_data;
4448 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4449 /* The position really is stored cast to a pointer. */
4450 int position = (long) call_data;
4451 Dimension height;
4452 int part;
4454 /* Get the height of the scroll bar. */
4455 BLOCK_INPUT;
4456 XtVaGetValues (widget, XtNheight, &height, NULL);
4457 UNBLOCK_INPUT;
4459 if (eabs (position) >= height)
4460 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4462 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4463 it maps line-movement to call_data = max(5, height/20). */
4464 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4465 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4466 else
4467 part = scroll_bar_move_ratio;
4469 window_being_scrolled = bar->window;
4470 bar->dragging = Qnil;
4471 last_scroll_bar_part = part;
4472 x_send_scroll_bar_event (bar->window, part, position, height);
4475 #endif /* not USE_GTK and not USE_MOTIF */
4477 #define SCROLL_BAR_NAME "verticalScrollBar"
4479 /* Create the widget for scroll bar BAR on frame F. Record the widget
4480 and X window of the scroll bar in BAR. */
4482 #ifdef USE_GTK
4483 static void
4484 x_create_toolkit_scroll_bar (f, bar)
4485 struct frame *f;
4486 struct scroll_bar *bar;
4488 char *scroll_bar_name = SCROLL_BAR_NAME;
4490 BLOCK_INPUT;
4491 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4492 scroll_bar_name);
4493 UNBLOCK_INPUT;
4496 #else /* not USE_GTK */
4498 static void
4499 x_create_toolkit_scroll_bar (f, bar)
4500 struct frame *f;
4501 struct scroll_bar *bar;
4503 Window xwindow;
4504 Widget widget;
4505 Arg av[20];
4506 int ac = 0;
4507 char *scroll_bar_name = SCROLL_BAR_NAME;
4508 unsigned long pixel;
4510 BLOCK_INPUT;
4512 #ifdef USE_MOTIF
4513 /* Set resources. Create the widget. */
4514 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4515 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4516 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4517 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4518 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4519 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4520 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4522 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4523 if (pixel != -1)
4525 XtSetArg (av[ac], XmNforeground, pixel);
4526 ++ac;
4529 pixel = f->output_data.x->scroll_bar_background_pixel;
4530 if (pixel != -1)
4532 XtSetArg (av[ac], XmNbackground, pixel);
4533 ++ac;
4536 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4537 scroll_bar_name, av, ac);
4539 /* Add one callback for everything that can happen. */
4540 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4541 (XtPointer) bar);
4542 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4543 (XtPointer) bar);
4544 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4545 (XtPointer) bar);
4546 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4547 (XtPointer) bar);
4548 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4549 (XtPointer) bar);
4550 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4551 (XtPointer) bar);
4552 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4553 (XtPointer) bar);
4555 /* Realize the widget. Only after that is the X window created. */
4556 XtRealizeWidget (widget);
4558 /* Set the cursor to an arrow. I didn't find a resource to do that.
4559 And I'm wondering why it hasn't an arrow cursor by default. */
4560 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4561 f->output_data.x->nontext_cursor);
4563 #else /* !USE_MOTIF i.e. use Xaw */
4565 /* Set resources. Create the widget. The background of the
4566 Xaw3d scroll bar widget is a little bit light for my taste.
4567 We don't alter it here to let users change it according
4568 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4569 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4570 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4571 /* For smoother scrolling with Xaw3d -sm */
4572 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4574 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4575 if (pixel != -1)
4577 XtSetArg (av[ac], XtNforeground, pixel);
4578 ++ac;
4581 pixel = f->output_data.x->scroll_bar_background_pixel;
4582 if (pixel != -1)
4584 XtSetArg (av[ac], XtNbackground, pixel);
4585 ++ac;
4588 /* Top/bottom shadow colors. */
4590 /* Allocate them, if necessary. */
4591 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4593 pixel = f->output_data.x->scroll_bar_background_pixel;
4594 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4595 &pixel, 1.2, 0x8000))
4596 pixel = -1;
4597 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4599 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4601 pixel = f->output_data.x->scroll_bar_background_pixel;
4602 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4603 &pixel, 0.6, 0x4000))
4604 pixel = -1;
4605 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4608 #ifdef XtNbeNiceToColormap
4609 /* Tell the toolkit about them. */
4610 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4611 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4612 /* We tried to allocate a color for the top/bottom shadow, and
4613 failed, so tell Xaw3d to use dithering instead. */
4615 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4616 ++ac;
4618 else
4619 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4620 be more consistent with other emacs 3d colors, and since Xaw3d is
4621 not good at dealing with allocation failure. */
4623 /* This tells Xaw3d to use real colors instead of dithering for
4624 the shadows. */
4625 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4626 ++ac;
4628 /* Specify the colors. */
4629 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4630 if (pixel != -1)
4632 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4633 ++ac;
4635 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4636 if (pixel != -1)
4638 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4639 ++ac;
4642 #endif
4644 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4645 f->output_data.x->edit_widget, av, ac);
4648 char *initial = "";
4649 char *val = initial;
4650 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4651 #ifdef XtNarrowScrollbars
4652 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4653 #endif
4654 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4655 if (xaw3d_arrow_scroll || val == initial)
4656 { /* ARROW_SCROLL */
4657 xaw3d_arrow_scroll = True;
4658 /* Isn't that just a personal preference ? --Stef */
4659 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4663 /* Define callbacks. */
4664 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4665 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4666 (XtPointer) bar);
4668 /* Realize the widget. Only after that is the X window created. */
4669 XtRealizeWidget (widget);
4671 #endif /* !USE_MOTIF */
4673 /* Install an action hook that lets us detect when the user
4674 finishes interacting with a scroll bar. */
4675 if (action_hook_id == 0)
4676 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4678 /* Remember X window and widget in the scroll bar vector. */
4679 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4680 xwindow = XtWindow (widget);
4681 bar->x_window = xwindow;
4683 UNBLOCK_INPUT;
4685 #endif /* not USE_GTK */
4688 /* Set the thumb size and position of scroll bar BAR. We are currently
4689 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4691 #ifdef USE_GTK
4692 static void
4693 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4694 struct scroll_bar *bar;
4695 int portion, position, whole;
4697 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4700 #else /* not USE_GTK */
4701 static void
4702 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4703 struct scroll_bar *bar;
4704 int portion, position, whole;
4706 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4707 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4708 float top, shown;
4710 BLOCK_INPUT;
4712 #ifdef USE_MOTIF
4714 /* We use an estimate of 30 chars per line rather than the real
4715 `portion' value. This has the disadvantage that the thumb size
4716 is not very representative, but it makes our life a lot easier.
4717 Otherwise, we have to constantly adjust the thumb size, which
4718 we can't always do quickly enough: while dragging, the size of
4719 the thumb might prevent the user from dragging the thumb all the
4720 way to the end. but Motif and some versions of Xaw3d don't allow
4721 updating the thumb size while dragging. Also, even if we can update
4722 its size, the update will often happen too late.
4723 If you don't believe it, check out revision 1.650 of xterm.c to see
4724 what hoops we were going through and the still poor behavior we got. */
4725 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4726 /* When the thumb is at the bottom, position == whole.
4727 So we need to increase `whole' to make space for the thumb. */
4728 whole += portion;
4730 if (whole <= 0)
4731 top = 0, shown = 1;
4732 else
4734 top = (float) position / whole;
4735 shown = (float) portion / whole;
4738 if (NILP (bar->dragging))
4740 int size, value;
4742 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4743 is the scroll bar's maximum and MIN is the scroll bar's minimum
4744 value. */
4745 size = shown * XM_SB_MAX;
4746 size = min (size, XM_SB_MAX);
4747 size = max (size, 1);
4749 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4750 value = top * XM_SB_MAX;
4751 value = min (value, XM_SB_MAX - size);
4753 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4755 #else /* !USE_MOTIF i.e. use Xaw */
4757 if (whole == 0)
4758 top = 0, shown = 1;
4759 else
4761 top = (float) position / whole;
4762 shown = (float) portion / whole;
4766 float old_top, old_shown;
4767 Dimension height;
4768 XtVaGetValues (widget,
4769 XtNtopOfThumb, &old_top,
4770 XtNshown, &old_shown,
4771 XtNheight, &height,
4772 NULL);
4774 /* Massage the top+shown values. */
4775 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4776 top = max (0, min (1, top));
4777 else
4778 top = old_top;
4779 /* Keep two pixels available for moving the thumb down. */
4780 shown = max (0, min (1 - top - (2.0 / height), shown));
4782 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4783 check that your system's configuration file contains a define
4784 for `NARROWPROTO'. See s/freebsd.h for an example. */
4785 if (top != old_top || shown != old_shown)
4787 if (NILP (bar->dragging))
4788 XawScrollbarSetThumb (widget, top, shown);
4789 else
4791 /* Try to make the scrolling a tad smoother. */
4792 if (!xaw3d_pick_top)
4793 shown = min (shown, old_shown);
4795 XawScrollbarSetThumb (widget, top, shown);
4799 #endif /* !USE_MOTIF */
4801 UNBLOCK_INPUT;
4803 #endif /* not USE_GTK */
4805 #endif /* USE_TOOLKIT_SCROLL_BARS */
4809 /************************************************************************
4810 Scroll bars, general
4811 ************************************************************************/
4813 /* Create a scroll bar and return the scroll bar vector for it. W is
4814 the Emacs window on which to create the scroll bar. TOP, LEFT,
4815 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4816 scroll bar. */
4818 static struct scroll_bar *
4819 x_scroll_bar_create (w, top, left, width, height)
4820 struct window *w;
4821 int top, left, width, height;
4823 struct frame *f = XFRAME (w->frame);
4824 struct scroll_bar *bar
4825 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4827 BLOCK_INPUT;
4829 #ifdef USE_TOOLKIT_SCROLL_BARS
4830 x_create_toolkit_scroll_bar (f, bar);
4831 #else /* not USE_TOOLKIT_SCROLL_BARS */
4833 XSetWindowAttributes a;
4834 unsigned long mask;
4835 Window window;
4837 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4838 if (a.background_pixel == -1)
4839 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4841 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4842 | ButtonMotionMask | PointerMotionHintMask
4843 | ExposureMask);
4844 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4846 mask = (CWBackPixel | CWEventMask | CWCursor);
4848 /* Clear the area of W that will serve as a scroll bar. This is
4849 for the case that a window has been split horizontally. In
4850 this case, no clear_frame is generated to reduce flickering. */
4851 if (width > 0 && height > 0)
4852 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4853 left, top, width,
4854 window_box_height (w), False);
4856 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4857 /* Position and size of scroll bar. */
4858 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4859 top,
4860 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4861 height,
4862 /* Border width, depth, class, and visual. */
4864 CopyFromParent,
4865 CopyFromParent,
4866 CopyFromParent,
4867 /* Attributes. */
4868 mask, &a);
4869 bar->x_window = window;
4871 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4873 XSETWINDOW (bar->window, w);
4874 bar->top = top;
4875 bar->left = left;
4876 bar->width = width;
4877 bar->height = height;
4878 bar->start = 0;
4879 bar->end = 0;
4880 bar->dragging = Qnil;
4881 bar->fringe_extended_p = 0;
4883 /* Add bar to its frame's list of scroll bars. */
4884 bar->next = FRAME_SCROLL_BARS (f);
4885 bar->prev = Qnil;
4886 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4887 if (!NILP (bar->next))
4888 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4890 /* Map the window/widget. */
4891 #ifdef USE_TOOLKIT_SCROLL_BARS
4893 #ifdef USE_GTK
4894 xg_update_scrollbar_pos (f,
4895 bar->x_window,
4896 top,
4897 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4898 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4899 max (height, 1));
4900 xg_show_scroll_bar (bar->x_window);
4901 #else /* not USE_GTK */
4902 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4903 XtConfigureWidget (scroll_bar,
4904 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4905 top,
4906 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4907 max (height, 1), 0);
4908 XtMapWidget (scroll_bar);
4909 #endif /* not USE_GTK */
4911 #else /* not USE_TOOLKIT_SCROLL_BARS */
4912 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4913 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4915 UNBLOCK_INPUT;
4916 return bar;
4920 #ifndef USE_TOOLKIT_SCROLL_BARS
4922 /* Draw BAR's handle in the proper position.
4924 If the handle is already drawn from START to END, don't bother
4925 redrawing it, unless REBUILD is non-zero; in that case, always
4926 redraw it. (REBUILD is handy for drawing the handle after expose
4927 events.)
4929 Normally, we want to constrain the start and end of the handle to
4930 fit inside its rectangle, but if the user is dragging the scroll
4931 bar handle, we want to let them drag it down all the way, so that
4932 the bar's top is as far down as it goes; otherwise, there's no way
4933 to move to the very end of the buffer. */
4935 static void
4936 x_scroll_bar_set_handle (bar, start, end, rebuild)
4937 struct scroll_bar *bar;
4938 int start, end;
4939 int rebuild;
4941 int dragging = ! NILP (bar->dragging);
4942 Window w = bar->x_window;
4943 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4944 GC gc = f->output_data.x->normal_gc;
4946 /* If the display is already accurate, do nothing. */
4947 if (! rebuild
4948 && start == bar->start
4949 && end == bar->end)
4950 return;
4952 BLOCK_INPUT;
4955 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4956 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4957 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4959 /* Make sure the values are reasonable, and try to preserve
4960 the distance between start and end. */
4962 int length = end - start;
4964 if (start < 0)
4965 start = 0;
4966 else if (start > top_range)
4967 start = top_range;
4968 end = start + length;
4970 if (end < start)
4971 end = start;
4972 else if (end > top_range && ! dragging)
4973 end = top_range;
4976 /* Store the adjusted setting in the scroll bar. */
4977 bar->start = start;
4978 bar->end = end;
4980 /* Clip the end position, just for display. */
4981 if (end > top_range)
4982 end = top_range;
4984 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
4985 below top positions, to make sure the handle is always at least
4986 that many pixels tall. */
4987 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
4989 /* Draw the empty space above the handle. Note that we can't clear
4990 zero-height areas; that means "clear to end of window." */
4991 if (0 < start)
4992 x_clear_area (FRAME_X_DISPLAY (f), w,
4993 /* x, y, width, height, and exposures. */
4994 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4995 VERTICAL_SCROLL_BAR_TOP_BORDER,
4996 inside_width, start,
4997 False);
4999 /* Change to proper foreground color if one is specified. */
5000 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5001 XSetForeground (FRAME_X_DISPLAY (f), gc,
5002 f->output_data.x->scroll_bar_foreground_pixel);
5004 /* Draw the handle itself. */
5005 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5006 /* x, y, width, height */
5007 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5008 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5009 inside_width, end - start);
5011 /* Restore the foreground color of the GC if we changed it above. */
5012 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5013 XSetForeground (FRAME_X_DISPLAY (f), gc,
5014 FRAME_FOREGROUND_PIXEL (f));
5016 /* Draw the empty space below the handle. Note that we can't
5017 clear zero-height areas; that means "clear to end of window." */
5018 if (end < inside_height)
5019 x_clear_area (FRAME_X_DISPLAY (f), w,
5020 /* x, y, width, height, and exposures. */
5021 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5022 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5023 inside_width, inside_height - end,
5024 False);
5028 UNBLOCK_INPUT;
5031 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5033 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5034 nil. */
5036 static void
5037 x_scroll_bar_remove (bar)
5038 struct scroll_bar *bar;
5040 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5041 BLOCK_INPUT;
5043 #ifdef USE_TOOLKIT_SCROLL_BARS
5044 #ifdef USE_GTK
5045 xg_remove_scroll_bar (f, bar->x_window);
5046 #else /* not USE_GTK */
5047 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5048 #endif /* not USE_GTK */
5049 #else
5050 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5051 #endif
5053 /* Disassociate this scroll bar from its window. */
5054 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5056 UNBLOCK_INPUT;
5060 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5061 that we are displaying PORTION characters out of a total of WHOLE
5062 characters, starting at POSITION. If WINDOW has no scroll bar,
5063 create one. */
5065 static void
5066 XTset_vertical_scroll_bar (w, portion, whole, position)
5067 struct window *w;
5068 int portion, whole, position;
5070 struct frame *f = XFRAME (w->frame);
5071 struct scroll_bar *bar;
5072 int top, height, left, sb_left, width, sb_width;
5073 int window_y, window_height;
5074 #ifdef USE_TOOLKIT_SCROLL_BARS
5075 int fringe_extended_p;
5076 #endif
5078 /* Get window dimensions. */
5079 window_box (w, -1, 0, &window_y, 0, &window_height);
5080 top = window_y;
5081 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5082 height = window_height;
5084 /* Compute the left edge of the scroll bar area. */
5085 left = WINDOW_SCROLL_BAR_AREA_X (w);
5087 /* Compute the width of the scroll bar which might be less than
5088 the width of the area reserved for the scroll bar. */
5089 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5090 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5091 else
5092 sb_width = width;
5094 /* Compute the left edge of the scroll bar. */
5095 #ifdef USE_TOOLKIT_SCROLL_BARS
5096 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5097 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5098 else
5099 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5100 #else
5101 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5102 sb_left = left + width - sb_width;
5103 else
5104 sb_left = left;
5105 #endif
5107 #ifdef USE_TOOLKIT_SCROLL_BARS
5108 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5109 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5110 && WINDOW_LEFT_FRINGE_WIDTH (w)
5111 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5112 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5113 else
5114 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5115 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5116 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5117 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5118 #endif
5120 /* Does the scroll bar exist yet? */
5121 if (NILP (w->vertical_scroll_bar))
5123 if (width > 0 && height > 0)
5125 BLOCK_INPUT;
5126 #ifdef USE_TOOLKIT_SCROLL_BARS
5127 if (fringe_extended_p)
5128 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5129 sb_left, top, sb_width, height, False);
5130 else
5131 #endif
5132 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5133 left, top, width, height, False);
5134 UNBLOCK_INPUT;
5137 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5139 else
5141 /* It may just need to be moved and resized. */
5142 unsigned int mask = 0;
5144 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5146 BLOCK_INPUT;
5148 if (sb_left != bar->left)
5149 mask |= CWX;
5150 if (top != bar->top)
5151 mask |= CWY;
5152 if (sb_width != bar->width)
5153 mask |= CWWidth;
5154 if (height != bar->height)
5155 mask |= CWHeight;
5157 #ifdef USE_TOOLKIT_SCROLL_BARS
5159 /* Move/size the scroll bar widget. */
5160 if (mask || bar->fringe_extended_p != fringe_extended_p)
5162 /* Since toolkit scroll bars are smaller than the space reserved
5163 for them on the frame, we have to clear "under" them. */
5164 if (width > 0 && height > 0)
5166 if (fringe_extended_p)
5167 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5168 sb_left, top, sb_width, height, False);
5169 else
5170 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5171 left, top, width, height, False);
5173 #ifdef USE_GTK
5174 xg_update_scrollbar_pos (f,
5175 bar->x_window,
5176 top,
5177 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5178 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5179 max (height, 1));
5180 #else /* not USE_GTK */
5181 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5182 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5183 top,
5184 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5185 max (height, 1), 0);
5186 #endif /* not USE_GTK */
5188 #else /* not USE_TOOLKIT_SCROLL_BARS */
5190 /* Clear areas not covered by the scroll bar because of
5191 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5192 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5194 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5195 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5196 height, False);
5197 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5198 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5199 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5200 height, False);
5203 /* Clear areas not covered by the scroll bar because it's not as
5204 wide as the area reserved for it. This makes sure a
5205 previous mode line display is cleared after C-x 2 C-x 1, for
5206 example. */
5208 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5209 int rest = area_width - sb_width;
5210 if (rest > 0 && height > 0)
5212 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5213 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5214 left + area_width - rest, top,
5215 rest, height, False);
5216 else
5217 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5218 left, top, rest, height, False);
5222 /* Move/size the scroll bar window. */
5223 if (mask)
5225 XWindowChanges wc;
5227 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5228 wc.y = top;
5229 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5230 wc.height = height;
5231 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5232 mask, &wc);
5235 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5237 /* Remember new settings. */
5238 bar->left = sb_left;
5239 bar->top = top;
5240 bar->width = sb_width;
5241 bar->height = height;
5243 UNBLOCK_INPUT;
5246 #ifdef USE_TOOLKIT_SCROLL_BARS
5247 bar->fringe_extended_p = fringe_extended_p;
5249 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5250 #else /* not USE_TOOLKIT_SCROLL_BARS */
5251 /* Set the scroll bar's current state, unless we're currently being
5252 dragged. */
5253 if (NILP (bar->dragging))
5255 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5257 if (whole == 0)
5258 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5259 else
5261 int start = ((double) position * top_range) / whole;
5262 int end = ((double) (position + portion) * top_range) / whole;
5263 x_scroll_bar_set_handle (bar, start, end, 0);
5266 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5268 XSETVECTOR (w->vertical_scroll_bar, bar);
5272 /* The following three hooks are used when we're doing a thorough
5273 redisplay of the frame. We don't explicitly know which scroll bars
5274 are going to be deleted, because keeping track of when windows go
5275 away is a real pain - "Can you say set-window-configuration, boys
5276 and girls?" Instead, we just assert at the beginning of redisplay
5277 that *all* scroll bars are to be removed, and then save a scroll bar
5278 from the fiery pit when we actually redisplay its window. */
5280 /* Arrange for all scroll bars on FRAME to be removed at the next call
5281 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5282 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5284 static void
5285 XTcondemn_scroll_bars (frame)
5286 FRAME_PTR frame;
5288 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5289 while (! NILP (FRAME_SCROLL_BARS (frame)))
5291 Lisp_Object bar;
5292 bar = FRAME_SCROLL_BARS (frame);
5293 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5294 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5295 XSCROLL_BAR (bar)->prev = Qnil;
5296 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5297 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5298 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5303 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5304 Note that WINDOW isn't necessarily condemned at all. */
5306 static void
5307 XTredeem_scroll_bar (window)
5308 struct window *window;
5310 struct scroll_bar *bar;
5311 struct frame *f;
5313 /* We can't redeem this window's scroll bar if it doesn't have one. */
5314 if (NILP (window->vertical_scroll_bar))
5315 abort ();
5317 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5319 /* Unlink it from the condemned list. */
5320 f = XFRAME (WINDOW_FRAME (window));
5321 if (NILP (bar->prev))
5323 /* If the prev pointer is nil, it must be the first in one of
5324 the lists. */
5325 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5326 /* It's not condemned. Everything's fine. */
5327 return;
5328 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5329 window->vertical_scroll_bar))
5330 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5331 else
5332 /* If its prev pointer is nil, it must be at the front of
5333 one or the other! */
5334 abort ();
5336 else
5337 XSCROLL_BAR (bar->prev)->next = bar->next;
5339 if (! NILP (bar->next))
5340 XSCROLL_BAR (bar->next)->prev = bar->prev;
5342 bar->next = FRAME_SCROLL_BARS (f);
5343 bar->prev = Qnil;
5344 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5345 if (! NILP (bar->next))
5346 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5349 /* Remove all scroll bars on FRAME that haven't been saved since the
5350 last call to `*condemn_scroll_bars_hook'. */
5352 static void
5353 XTjudge_scroll_bars (f)
5354 FRAME_PTR f;
5356 Lisp_Object bar, next;
5358 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5360 /* Clear out the condemned list now so we won't try to process any
5361 more events on the hapless scroll bars. */
5362 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5364 for (; ! NILP (bar); bar = next)
5366 struct scroll_bar *b = XSCROLL_BAR (bar);
5368 x_scroll_bar_remove (b);
5370 next = b->next;
5371 b->next = b->prev = Qnil;
5374 /* Now there should be no references to the condemned scroll bars,
5375 and they should get garbage-collected. */
5379 #ifndef USE_TOOLKIT_SCROLL_BARS
5380 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5381 is a no-op when using toolkit scroll bars.
5383 This may be called from a signal handler, so we have to ignore GC
5384 mark bits. */
5386 static void
5387 x_scroll_bar_expose (bar, event)
5388 struct scroll_bar *bar;
5389 XEvent *event;
5391 Window w = bar->x_window;
5392 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5393 GC gc = f->output_data.x->normal_gc;
5394 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5396 BLOCK_INPUT;
5398 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5400 /* Switch to scroll bar foreground color. */
5401 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5402 XSetForeground (FRAME_X_DISPLAY (f), gc,
5403 f->output_data.x->scroll_bar_foreground_pixel);
5405 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5406 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5408 /* x, y, width, height */
5409 0, 0,
5410 bar->width - 1 - width_trim - width_trim,
5411 bar->height - 1);
5413 /* Restore the foreground color of the GC if we changed it above. */
5414 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5415 XSetForeground (FRAME_X_DISPLAY (f), gc,
5416 FRAME_FOREGROUND_PIXEL (f));
5418 UNBLOCK_INPUT;
5421 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5423 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5424 is set to something other than NO_EVENT, it is enqueued.
5426 This may be called from a signal handler, so we have to ignore GC
5427 mark bits. */
5430 static void
5431 x_scroll_bar_handle_click (bar, event, emacs_event)
5432 struct scroll_bar *bar;
5433 XEvent *event;
5434 struct input_event *emacs_event;
5436 if (! WINDOWP (bar->window))
5437 abort ();
5439 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5440 emacs_event->code = event->xbutton.button - Button1;
5441 emacs_event->modifiers
5442 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5443 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5444 event->xbutton.state)
5445 | (event->type == ButtonRelease
5446 ? up_modifier
5447 : down_modifier));
5448 emacs_event->frame_or_window = bar->window;
5449 emacs_event->arg = Qnil;
5450 emacs_event->timestamp = event->xbutton.time;
5452 #if 0
5453 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5454 int internal_height
5455 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5456 #endif
5457 int top_range
5458 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5459 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5461 if (y < 0) y = 0;
5462 if (y > top_range) y = top_range;
5464 if (y < bar->start)
5465 emacs_event->part = scroll_bar_above_handle;
5466 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5467 emacs_event->part = scroll_bar_handle;
5468 else
5469 emacs_event->part = scroll_bar_below_handle;
5471 /* Just because the user has clicked on the handle doesn't mean
5472 they want to drag it. Lisp code needs to be able to decide
5473 whether or not we're dragging. */
5474 #if 0
5475 /* If the user has just clicked on the handle, record where they're
5476 holding it. */
5477 if (event->type == ButtonPress
5478 && emacs_event->part == scroll_bar_handle)
5479 XSETINT (bar->dragging, y - bar->start);
5480 #endif
5482 #ifndef USE_TOOLKIT_SCROLL_BARS
5483 /* If the user has released the handle, set it to its final position. */
5484 if (event->type == ButtonRelease
5485 && ! NILP (bar->dragging))
5487 int new_start = y - XINT (bar->dragging);
5488 int new_end = new_start + bar->end - bar->start;
5490 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5491 bar->dragging = Qnil;
5493 #endif
5495 /* Same deal here as the other #if 0. */
5496 #if 0
5497 /* Clicks on the handle are always reported as occurring at the top of
5498 the handle. */
5499 if (emacs_event->part == scroll_bar_handle)
5500 emacs_event->x = bar->start;
5501 else
5502 XSETINT (emacs_event->x, y);
5503 #else
5504 XSETINT (emacs_event->x, y);
5505 #endif
5507 XSETINT (emacs_event->y, top_range);
5511 #ifndef USE_TOOLKIT_SCROLL_BARS
5513 /* Handle some mouse motion while someone is dragging the scroll bar.
5515 This may be called from a signal handler, so we have to ignore GC
5516 mark bits. */
5518 static void
5519 x_scroll_bar_note_movement (bar, event)
5520 struct scroll_bar *bar;
5521 XEvent *event;
5523 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5525 last_mouse_movement_time = event->xmotion.time;
5527 f->mouse_moved = 1;
5528 XSETVECTOR (last_mouse_scroll_bar, bar);
5530 /* If we're dragging the bar, display it. */
5531 if (! NILP (bar->dragging))
5533 /* Where should the handle be now? */
5534 int new_start = event->xmotion.y - XINT (bar->dragging);
5536 if (new_start != bar->start)
5538 int new_end = new_start + bar->end - bar->start;
5540 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5545 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5547 /* Return information to the user about the current position of the mouse
5548 on the scroll bar. */
5550 static void
5551 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5552 FRAME_PTR *fp;
5553 Lisp_Object *bar_window;
5554 enum scroll_bar_part *part;
5555 Lisp_Object *x, *y;
5556 unsigned long *time;
5558 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5559 Window w = bar->x_window;
5560 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5561 int win_x, win_y;
5562 Window dummy_window;
5563 int dummy_coord;
5564 unsigned int dummy_mask;
5566 BLOCK_INPUT;
5568 /* Get the mouse's position relative to the scroll bar window, and
5569 report that. */
5570 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5572 /* Root, child, root x and root y. */
5573 &dummy_window, &dummy_window,
5574 &dummy_coord, &dummy_coord,
5576 /* Position relative to scroll bar. */
5577 &win_x, &win_y,
5579 /* Mouse buttons and modifier keys. */
5580 &dummy_mask))
5582 else
5584 #if 0
5585 int inside_height
5586 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5587 #endif
5588 int top_range
5589 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5591 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5593 if (! NILP (bar->dragging))
5594 win_y -= XINT (bar->dragging);
5596 if (win_y < 0)
5597 win_y = 0;
5598 if (win_y > top_range)
5599 win_y = top_range;
5601 *fp = f;
5602 *bar_window = bar->window;
5604 if (! NILP (bar->dragging))
5605 *part = scroll_bar_handle;
5606 else if (win_y < bar->start)
5607 *part = scroll_bar_above_handle;
5608 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5609 *part = scroll_bar_handle;
5610 else
5611 *part = scroll_bar_below_handle;
5613 XSETINT (*x, win_y);
5614 XSETINT (*y, top_range);
5616 f->mouse_moved = 0;
5617 last_mouse_scroll_bar = Qnil;
5620 *time = last_mouse_movement_time;
5622 UNBLOCK_INPUT;
5626 /* The screen has been cleared so we may have changed foreground or
5627 background colors, and the scroll bars may need to be redrawn.
5628 Clear out the scroll bars, and ask for expose events, so we can
5629 redraw them. */
5631 void
5632 x_scroll_bar_clear (f)
5633 FRAME_PTR f;
5635 #ifndef USE_TOOLKIT_SCROLL_BARS
5636 Lisp_Object bar;
5638 /* We can have scroll bars even if this is 0,
5639 if we just turned off scroll bar mode.
5640 But in that case we should not clear them. */
5641 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5642 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5643 bar = XSCROLL_BAR (bar)->next)
5644 XClearArea (FRAME_X_DISPLAY (f),
5645 XSCROLL_BAR (bar)->x_window,
5646 0, 0, 0, 0, True);
5647 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5651 /* The main X event-reading loop - XTread_socket. */
5653 #if 0
5654 /* Time stamp of enter window event. This is only used by XTread_socket,
5655 but we have to put it out here, since static variables within functions
5656 sometimes don't work. */
5658 static Time enter_timestamp;
5659 #endif
5661 /* This holds the state XLookupString needs to implement dead keys
5662 and other tricks known as "compose processing". _X Window System_
5663 says that a portable program can't use this, but Stephen Gildea assures
5664 me that letting the compiler initialize it to zeros will work okay.
5666 This must be defined outside of XTread_socket, for the same reasons
5667 given for enter_timestamp, above. */
5669 static XComposeStatus compose_status;
5671 /* Record the last 100 characters stored
5672 to help debug the loss-of-chars-during-GC problem. */
5674 static int temp_index;
5675 static short temp_buffer[100];
5677 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5678 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5679 temp_index = 0; \
5680 temp_buffer[temp_index++] = (keysym)
5682 /* Set this to nonzero to fake an "X I/O error"
5683 on a particular display. */
5685 struct x_display_info *XTread_socket_fake_io_error;
5687 /* When we find no input here, we occasionally do a no-op command
5688 to verify that the X server is still running and we can still talk with it.
5689 We try all the open displays, one by one.
5690 This variable is used for cycling thru the displays. */
5692 static struct x_display_info *next_noop_dpyinfo;
5694 #define SET_SAVED_MENU_EVENT(size) \
5695 do \
5697 if (f->output_data.x->saved_menu_event == 0) \
5698 f->output_data.x->saved_menu_event \
5699 = (XEvent *) xmalloc (sizeof (XEvent)); \
5700 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5701 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5702 XSETFRAME (inev.ie.frame_or_window, f); \
5704 while (0)
5706 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5707 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5710 enum
5712 X_EVENT_NORMAL,
5713 X_EVENT_GOTO_OUT,
5714 X_EVENT_DROP
5717 /* Filter events for the current X input method.
5718 DPYINFO is the display this event is for.
5719 EVENT is the X event to filter.
5721 Returns non-zero if the event was filtered, caller shall not process
5722 this event further.
5723 Returns zero if event is wasn't filtered. */
5725 #ifdef HAVE_X_I18N
5726 static int
5727 x_filter_event (dpyinfo, event)
5728 struct x_display_info *dpyinfo;
5729 XEvent *event;
5731 /* XFilterEvent returns non-zero if the input method has
5732 consumed the event. We pass the frame's X window to
5733 XFilterEvent because that's the one for which the IC
5734 was created. */
5736 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5737 event->xclient.window);
5739 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5741 #endif
5743 #ifdef USE_GTK
5744 static int current_count;
5745 static int current_finish;
5746 static struct input_event *current_hold_quit;
5748 /* This is the filter function invoked by the GTK event loop.
5749 It is invoked before the XEvent is translated to a GdkEvent,
5750 so we have a chance to act on the event before GTK. */
5751 static GdkFilterReturn
5752 event_handler_gdk (gxev, ev, data)
5753 GdkXEvent *gxev;
5754 GdkEvent *ev;
5755 gpointer data;
5757 XEvent *xev = (XEvent *) gxev;
5759 if (current_count >= 0)
5761 struct x_display_info *dpyinfo;
5763 dpyinfo = x_display_info_for_display (xev->xany.display);
5765 #ifdef HAVE_X_I18N
5766 /* Filter events for the current X input method.
5767 GTK calls XFilterEvent but not for key press and release,
5768 so we do it here. */
5769 if (xev->type == KeyPress || xev->type == KeyRelease)
5770 if (dpyinfo && x_filter_event (dpyinfo, xev))
5771 return GDK_FILTER_REMOVE;
5772 #endif
5774 if (! dpyinfo)
5775 current_finish = X_EVENT_NORMAL;
5776 else
5778 current_count +=
5779 handle_one_xevent (dpyinfo, xev, &current_finish,
5780 current_hold_quit);
5783 else
5784 current_finish = x_dispatch_event (xev, xev->xany.display);
5786 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5787 return GDK_FILTER_REMOVE;
5789 return GDK_FILTER_CONTINUE;
5791 #endif /* USE_GTK */
5794 /* Handles the XEvent EVENT on display DPYINFO.
5796 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5797 *FINISH is zero if caller should continue reading events.
5798 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5800 We return the number of characters stored into the buffer. */
5802 static int
5803 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5804 struct x_display_info *dpyinfo;
5805 XEvent *eventp;
5806 int *finish;
5807 struct input_event *hold_quit;
5809 union {
5810 struct input_event ie;
5811 struct selection_input_event sie;
5812 } inev;
5813 int count = 0;
5814 int do_help = 0;
5815 int nbytes = 0;
5816 struct frame *f = NULL;
5817 struct coding_system coding;
5818 XEvent event = *eventp;
5820 *finish = X_EVENT_NORMAL;
5822 EVENT_INIT (inev.ie);
5823 inev.ie.kind = NO_EVENT;
5824 inev.ie.arg = Qnil;
5826 switch (event.type)
5828 case ClientMessage:
5830 if (event.xclient.message_type
5831 == dpyinfo->Xatom_wm_protocols
5832 && event.xclient.format == 32)
5834 if (event.xclient.data.l[0]
5835 == dpyinfo->Xatom_wm_take_focus)
5837 /* Use x_any_window_to_frame because this
5838 could be the shell widget window
5839 if the frame has no title bar. */
5840 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5841 #ifdef HAVE_X_I18N
5842 /* Not quite sure this is needed -pd */
5843 if (f && FRAME_XIC (f))
5844 XSetICFocus (FRAME_XIC (f));
5845 #endif
5846 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5847 instructs the WM to set the input focus automatically for
5848 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5849 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5850 it has set the focus. So, XSetInputFocus below is not
5851 needed.
5853 The call to XSetInputFocus below has also caused trouble. In
5854 cases where the XSetInputFocus done by the WM and the one
5855 below are temporally close (on a fast machine), the call
5856 below can generate additional FocusIn events which confuse
5857 Emacs. */
5859 /* Since we set WM_TAKE_FOCUS, we must call
5860 XSetInputFocus explicitly. But not if f is null,
5861 since that might be an event for a deleted frame. */
5862 if (f)
5864 Display *d = event.xclient.display;
5865 /* Catch and ignore errors, in case window has been
5866 iconified by a window manager such as GWM. */
5867 x_catch_errors (d);
5868 XSetInputFocus (d, event.xclient.window,
5869 /* The ICCCM says this is
5870 the only valid choice. */
5871 RevertToParent,
5872 event.xclient.data.l[1]);
5873 /* This is needed to detect the error
5874 if there is an error. */
5875 XSync (d, False);
5876 x_uncatch_errors ();
5878 /* Not certain about handling scroll bars here */
5879 #endif /* 0 */
5880 goto done;
5883 if (event.xclient.data.l[0]
5884 == dpyinfo->Xatom_wm_save_yourself)
5886 /* Save state modify the WM_COMMAND property to
5887 something which can reinstate us. This notifies
5888 the session manager, who's looking for such a
5889 PropertyNotify. Can restart processing when
5890 a keyboard or mouse event arrives. */
5891 /* If we have a session manager, don't set this.
5892 KDE will then start two Emacsen, one for the
5893 session manager and one for this. */
5894 #ifdef HAVE_X_SM
5895 if (! x_session_have_connection ())
5896 #endif
5898 f = x_top_window_to_frame (dpyinfo,
5899 event.xclient.window);
5900 /* This is just so we only give real data once
5901 for a single Emacs process. */
5902 if (f == SELECTED_FRAME ())
5903 XSetCommand (FRAME_X_DISPLAY (f),
5904 event.xclient.window,
5905 initial_argv, initial_argc);
5906 else if (f)
5907 XSetCommand (FRAME_X_DISPLAY (f),
5908 event.xclient.window,
5909 0, 0);
5911 goto done;
5914 if (event.xclient.data.l[0]
5915 == dpyinfo->Xatom_wm_delete_window)
5917 f = x_any_window_to_frame (dpyinfo,
5918 event.xclient.window);
5919 if (!f)
5920 goto OTHER; /* May be a dialog that is to be removed */
5922 inev.ie.kind = DELETE_WINDOW_EVENT;
5923 XSETFRAME (inev.ie.frame_or_window, f);
5924 goto done;
5927 goto done;
5930 if (event.xclient.message_type
5931 == dpyinfo->Xatom_wm_configure_denied)
5933 goto done;
5936 if (event.xclient.message_type
5937 == dpyinfo->Xatom_wm_window_moved)
5939 int new_x, new_y;
5940 f = x_window_to_frame (dpyinfo, event.xclient.window);
5942 new_x = event.xclient.data.s[0];
5943 new_y = event.xclient.data.s[1];
5945 if (f)
5947 f->left_pos = new_x;
5948 f->top_pos = new_y;
5950 goto done;
5953 #ifdef HACK_EDITRES
5954 if (event.xclient.message_type
5955 == dpyinfo->Xatom_editres)
5957 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5958 if (f)
5959 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5960 &event, NULL);
5961 goto done;
5963 #endif /* HACK_EDITRES */
5965 if ((event.xclient.message_type
5966 == dpyinfo->Xatom_DONE)
5967 || (event.xclient.message_type
5968 == dpyinfo->Xatom_PAGE))
5970 /* Ghostview job completed. Kill it. We could
5971 reply with "Next" if we received "Page", but we
5972 currently never do because we are interested in
5973 images, only, which should have 1 page. */
5974 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5975 f = x_window_to_frame (dpyinfo, event.xclient.window);
5976 if (!f)
5977 goto OTHER;
5978 x_kill_gs_process (pixmap, f);
5979 expose_frame (f, 0, 0, 0, 0);
5980 goto done;
5983 #ifdef USE_TOOLKIT_SCROLL_BARS
5984 /* Scroll bar callbacks send a ClientMessage from which
5985 we construct an input_event. */
5986 if (event.xclient.message_type
5987 == dpyinfo->Xatom_Scrollbar)
5989 x_scroll_bar_to_input_event (&event, &inev.ie);
5990 *finish = X_EVENT_GOTO_OUT;
5991 goto done;
5993 #endif /* USE_TOOLKIT_SCROLL_BARS */
5995 /* XEmbed messages from the embedder (if any). */
5996 if (event.xclient.message_type
5997 == dpyinfo->Xatom_XEMBED)
5999 enum xembed_message msg = event.xclient.data.l[1];
6000 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6001 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6003 *finish = X_EVENT_GOTO_OUT;
6004 goto done;
6007 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6008 if (!f)
6009 goto OTHER;
6010 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6011 *finish = X_EVENT_DROP;
6013 break;
6015 case SelectionNotify:
6016 last_user_time = event.xselection.time;
6017 #ifdef USE_X_TOOLKIT
6018 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6019 goto OTHER;
6020 #endif /* not USE_X_TOOLKIT */
6021 x_handle_selection_notify (&event.xselection);
6022 break;
6024 case SelectionClear: /* Someone has grabbed ownership. */
6025 last_user_time = event.xselectionclear.time;
6026 #ifdef USE_X_TOOLKIT
6027 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6028 goto OTHER;
6029 #endif /* USE_X_TOOLKIT */
6031 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6033 inev.ie.kind = SELECTION_CLEAR_EVENT;
6034 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6035 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6036 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6037 inev.ie.frame_or_window = Qnil;
6039 break;
6041 case SelectionRequest: /* Someone wants our selection. */
6042 last_user_time = event.xselectionrequest.time;
6043 #ifdef USE_X_TOOLKIT
6044 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6045 goto OTHER;
6046 #endif /* USE_X_TOOLKIT */
6048 XSelectionRequestEvent *eventp
6049 = (XSelectionRequestEvent *) &event;
6051 inev.ie.kind = SELECTION_REQUEST_EVENT;
6052 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6053 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6054 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6055 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6056 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6057 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6058 inev.ie.frame_or_window = Qnil;
6060 break;
6062 case PropertyNotify:
6063 last_user_time = event.xproperty.time;
6064 #if 0 /* This is plain wrong. In the case that we are waiting for a
6065 PropertyNotify used as an ACK in incremental selection
6066 transfer, the property will be on the receiver's window. */
6067 #if defined USE_X_TOOLKIT
6068 if (!x_any_window_to_frame (dpyinfo, event.xproperty.window))
6069 goto OTHER;
6070 #endif
6071 #endif
6072 x_handle_property_notify (&event.xproperty);
6073 goto OTHER;
6075 case ReparentNotify:
6076 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6077 if (f)
6079 int x, y;
6080 f->output_data.x->parent_desc = event.xreparent.parent;
6081 x_real_positions (f, &x, &y);
6082 f->left_pos = x;
6083 f->top_pos = y;
6085 /* Perhaps reparented due to a WM restart. Reset this. */
6086 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6087 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6089 goto OTHER;
6091 case Expose:
6092 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6093 if (f)
6095 x_check_fullscreen (f);
6097 #ifdef USE_GTK
6098 /* This seems to be needed for GTK 2.6. */
6099 x_clear_area (event.xexpose.display,
6100 event.xexpose.window,
6101 event.xexpose.x, event.xexpose.y,
6102 event.xexpose.width, event.xexpose.height,
6103 FALSE);
6104 #endif
6105 if (f->async_visible == 0)
6107 f->async_visible = 1;
6108 f->async_iconified = 0;
6109 f->output_data.x->has_been_visible = 1;
6110 SET_FRAME_GARBAGED (f);
6112 else
6113 expose_frame (f,
6114 event.xexpose.x, event.xexpose.y,
6115 event.xexpose.width, event.xexpose.height);
6117 else
6119 #ifndef USE_TOOLKIT_SCROLL_BARS
6120 struct scroll_bar *bar;
6121 #endif
6122 #if defined USE_LUCID
6123 /* Submenus of the Lucid menu bar aren't widgets
6124 themselves, so there's no way to dispatch events
6125 to them. Recognize this case separately. */
6127 Widget widget
6128 = x_window_to_menu_bar (event.xexpose.window);
6129 if (widget)
6130 xlwmenu_redisplay (widget);
6132 #endif /* USE_LUCID */
6134 #ifdef USE_TOOLKIT_SCROLL_BARS
6135 /* Dispatch event to the widget. */
6136 goto OTHER;
6137 #else /* not USE_TOOLKIT_SCROLL_BARS */
6138 bar = x_window_to_scroll_bar (event.xexpose.display,
6139 event.xexpose.window);
6141 if (bar)
6142 x_scroll_bar_expose (bar, &event);
6143 #ifdef USE_X_TOOLKIT
6144 else
6145 goto OTHER;
6146 #endif /* USE_X_TOOLKIT */
6147 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6149 break;
6151 case GraphicsExpose: /* This occurs when an XCopyArea's
6152 source area was obscured or not
6153 available. */
6154 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6155 if (f)
6157 expose_frame (f,
6158 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6159 event.xgraphicsexpose.width,
6160 event.xgraphicsexpose.height);
6162 #ifdef USE_X_TOOLKIT
6163 else
6164 goto OTHER;
6165 #endif /* USE_X_TOOLKIT */
6166 break;
6168 case NoExpose: /* This occurs when an XCopyArea's
6169 source area was completely
6170 available. */
6171 break;
6173 case UnmapNotify:
6174 /* Redo the mouse-highlight after the tooltip has gone. */
6175 if (event.xmap.window == tip_window)
6177 tip_window = 0;
6178 redo_mouse_highlight ();
6181 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6182 if (f) /* F may no longer exist if
6183 the frame was deleted. */
6185 /* While a frame is unmapped, display generation is
6186 disabled; you don't want to spend time updating a
6187 display that won't ever be seen. */
6188 f->async_visible = 0;
6189 /* We can't distinguish, from the event, whether the window
6190 has become iconified or invisible. So assume, if it
6191 was previously visible, than now it is iconified.
6192 But x_make_frame_invisible clears both
6193 the visible flag and the iconified flag;
6194 and that way, we know the window is not iconified now. */
6195 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6197 f->async_iconified = 1;
6199 inev.ie.kind = ICONIFY_EVENT;
6200 XSETFRAME (inev.ie.frame_or_window, f);
6203 goto OTHER;
6205 case MapNotify:
6206 if (event.xmap.window == tip_window)
6207 /* The tooltip has been drawn already. Avoid
6208 the SET_FRAME_GARBAGED below. */
6209 goto OTHER;
6211 /* We use x_top_window_to_frame because map events can
6212 come for sub-windows and they don't mean that the
6213 frame is visible. */
6214 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6215 if (f)
6217 /* wait_reading_process_output will notice this and update
6218 the frame's display structures.
6219 If we where iconified, we should not set garbaged,
6220 because that stops redrawing on Expose events. This looks
6221 bad if we are called from a recursive event loop
6222 (x_dispatch_event), for example when a dialog is up. */
6223 if (! f->async_iconified)
6224 SET_FRAME_GARBAGED (f);
6226 f->async_visible = 1;
6227 f->async_iconified = 0;
6228 f->output_data.x->has_been_visible = 1;
6230 if (f->iconified)
6232 inev.ie.kind = DEICONIFY_EVENT;
6233 XSETFRAME (inev.ie.frame_or_window, f);
6235 else if (! NILP (Vframe_list)
6236 && ! NILP (XCDR (Vframe_list)))
6237 /* Force a redisplay sooner or later
6238 to update the frame titles
6239 in case this is the second frame. */
6240 record_asynch_buffer_change ();
6242 goto OTHER;
6244 case KeyPress:
6246 last_user_time = event.xkey.time;
6247 ignore_next_mouse_click_timeout = 0;
6249 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6250 /* Dispatch KeyPress events when in menu. */
6251 if (popup_activated ())
6252 goto OTHER;
6253 #endif
6255 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6257 /* If mouse-highlight is an integer, input clears out
6258 mouse highlighting. */
6259 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6260 && (f == 0
6261 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6263 clear_mouse_face (dpyinfo);
6264 dpyinfo->mouse_face_hidden = 1;
6267 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6268 if (f == 0)
6270 /* Scroll bars consume key events, but we want
6271 the keys to go to the scroll bar's frame. */
6272 Widget widget = XtWindowToWidget (dpyinfo->display,
6273 event.xkey.window);
6274 if (widget && XmIsScrollBar (widget))
6276 widget = XtParent (widget);
6277 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6280 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6282 if (f != 0)
6284 KeySym keysym, orig_keysym;
6285 /* al%imercury@uunet.uu.net says that making this 81
6286 instead of 80 fixed a bug whereby meta chars made
6287 his Emacs hang.
6289 It seems that some version of XmbLookupString has
6290 a bug of not returning XBufferOverflow in
6291 status_return even if the input is too long to
6292 fit in 81 bytes. So, we must prepare sufficient
6293 bytes for copy_buffer. 513 bytes (256 chars for
6294 two-byte character set) seems to be a fairly good
6295 approximation. -- 2000.8.10 handa@etl.go.jp */
6296 unsigned char copy_buffer[513];
6297 unsigned char *copy_bufptr = copy_buffer;
6298 int copy_bufsiz = sizeof (copy_buffer);
6299 int modifiers;
6300 Lisp_Object coding_system = Qlatin_1;
6301 Lisp_Object c;
6303 #ifdef USE_GTK
6304 /* Don't pass keys to GTK. A Tab will shift focus to the
6305 tool bar in GTK 2.4. Keys will still go to menus and
6306 dialogs because in that case popup_activated is TRUE
6307 (see above). */
6308 *finish = X_EVENT_DROP;
6309 #endif
6311 event.xkey.state
6312 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6313 extra_keyboard_modifiers);
6314 modifiers = event.xkey.state;
6316 /* This will have to go some day... */
6318 /* make_lispy_event turns chars into control chars.
6319 Don't do it here because XLookupString is too eager. */
6320 event.xkey.state &= ~ControlMask;
6321 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6322 | dpyinfo->super_mod_mask
6323 | dpyinfo->hyper_mod_mask
6324 | dpyinfo->alt_mod_mask);
6326 /* In case Meta is ComposeCharacter,
6327 clear its status. According to Markus Ehrnsperger
6328 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6329 this enables ComposeCharacter to work whether or
6330 not it is combined with Meta. */
6331 if (modifiers & dpyinfo->meta_mod_mask)
6332 bzero (&compose_status, sizeof (compose_status));
6334 #ifdef HAVE_X_I18N
6335 if (FRAME_XIC (f))
6337 Status status_return;
6339 coding_system = Vlocale_coding_system;
6340 nbytes = XmbLookupString (FRAME_XIC (f),
6341 &event.xkey, copy_bufptr,
6342 copy_bufsiz, &keysym,
6343 &status_return);
6344 if (status_return == XBufferOverflow)
6346 copy_bufsiz = nbytes + 1;
6347 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6348 nbytes = XmbLookupString (FRAME_XIC (f),
6349 &event.xkey, copy_bufptr,
6350 copy_bufsiz, &keysym,
6351 &status_return);
6353 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6354 #if 0 && defined X_HAVE_UTF8_STRING
6355 else if (status_return == XLookupKeySym)
6356 { /* Try again but with utf-8. */
6357 coding_system = Qutf_8;
6358 nbytes = Xutf8LookupString (FRAME_XIC (f),
6359 &event.xkey, copy_bufptr,
6360 copy_bufsiz, &keysym,
6361 &status_return);
6362 if (status_return == XBufferOverflow)
6364 copy_bufsiz = nbytes + 1;
6365 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6366 nbytes = Xutf8LookupString (FRAME_XIC (f),
6367 &event.xkey,
6368 copy_bufptr,
6369 copy_bufsiz, &keysym,
6370 &status_return);
6373 #endif
6375 if (status_return == XLookupNone)
6376 break;
6377 else if (status_return == XLookupChars)
6379 keysym = NoSymbol;
6380 modifiers = 0;
6382 else if (status_return != XLookupKeySym
6383 && status_return != XLookupBoth)
6384 abort ();
6386 else
6387 nbytes = XLookupString (&event.xkey, copy_bufptr,
6388 copy_bufsiz, &keysym,
6389 &compose_status);
6390 #else
6391 nbytes = XLookupString (&event.xkey, copy_bufptr,
6392 copy_bufsiz, &keysym,
6393 &compose_status);
6394 #endif
6396 /* If not using XIM/XIC, and a compose sequence is in progress,
6397 we break here. Otherwise, chars_matched is always 0. */
6398 if (compose_status.chars_matched > 0 && nbytes == 0)
6399 break;
6401 bzero (&compose_status, sizeof (compose_status));
6402 orig_keysym = keysym;
6404 /* Common for all keysym input events. */
6405 XSETFRAME (inev.ie.frame_or_window, f);
6406 inev.ie.modifiers
6407 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6408 inev.ie.timestamp = event.xkey.time;
6410 /* First deal with keysyms which have defined
6411 translations to characters. */
6412 if (keysym >= 32 && keysym < 128)
6413 /* Avoid explicitly decoding each ASCII character. */
6415 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6416 inev.ie.code = keysym;
6417 goto done_keysym;
6420 /* Keysyms directly mapped to Unicode characters. */
6421 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6423 if (keysym < 0x01000080)
6424 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6425 else
6426 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6427 inev.ie.code = keysym & 0xFFFFFF;
6428 goto done_keysym;
6431 /* Now non-ASCII. */
6432 if (HASH_TABLE_P (Vx_keysym_table)
6433 && (NATNUMP (c = Fgethash (make_number (keysym),
6434 Vx_keysym_table,
6435 Qnil))))
6437 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6438 ? ASCII_KEYSTROKE_EVENT
6439 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6440 inev.ie.code = XFASTINT (c);
6441 goto done_keysym;
6444 /* Random non-modifier sorts of keysyms. */
6445 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6446 || keysym == XK_Delete
6447 #ifdef XK_ISO_Left_Tab
6448 || (keysym >= XK_ISO_Left_Tab
6449 && keysym <= XK_ISO_Enter)
6450 #endif
6451 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6452 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6453 #ifdef HPUX
6454 /* This recognizes the "extended function
6455 keys". It seems there's no cleaner way.
6456 Test IsModifierKey to avoid handling
6457 mode_switch incorrectly. */
6458 || ((unsigned) (keysym) >= XK_Select
6459 && (unsigned)(keysym) < XK_KP_Space)
6460 #endif
6461 #ifdef XK_dead_circumflex
6462 || orig_keysym == XK_dead_circumflex
6463 #endif
6464 #ifdef XK_dead_grave
6465 || orig_keysym == XK_dead_grave
6466 #endif
6467 #ifdef XK_dead_tilde
6468 || orig_keysym == XK_dead_tilde
6469 #endif
6470 #ifdef XK_dead_diaeresis
6471 || orig_keysym == XK_dead_diaeresis
6472 #endif
6473 #ifdef XK_dead_macron
6474 || orig_keysym == XK_dead_macron
6475 #endif
6476 #ifdef XK_dead_degree
6477 || orig_keysym == XK_dead_degree
6478 #endif
6479 #ifdef XK_dead_acute
6480 || orig_keysym == XK_dead_acute
6481 #endif
6482 #ifdef XK_dead_cedilla
6483 || orig_keysym == XK_dead_cedilla
6484 #endif
6485 #ifdef XK_dead_breve
6486 || orig_keysym == XK_dead_breve
6487 #endif
6488 #ifdef XK_dead_ogonek
6489 || orig_keysym == XK_dead_ogonek
6490 #endif
6491 #ifdef XK_dead_caron
6492 || orig_keysym == XK_dead_caron
6493 #endif
6494 #ifdef XK_dead_doubleacute
6495 || orig_keysym == XK_dead_doubleacute
6496 #endif
6497 #ifdef XK_dead_abovedot
6498 || orig_keysym == XK_dead_abovedot
6499 #endif
6500 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6501 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6502 /* Any "vendor-specific" key is ok. */
6503 || (orig_keysym & (1 << 28))
6504 || (keysym != NoSymbol && nbytes == 0))
6505 && ! (IsModifierKey (orig_keysym)
6506 /* The symbols from XK_ISO_Lock
6507 to XK_ISO_Last_Group_Lock
6508 don't have real modifiers but
6509 should be treated similarly to
6510 Mode_switch by Emacs. */
6511 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6512 || ((unsigned)(orig_keysym)
6513 >= XK_ISO_Lock
6514 && (unsigned)(orig_keysym)
6515 <= XK_ISO_Last_Group_Lock)
6516 #endif
6519 STORE_KEYSYM_FOR_DEBUG (keysym);
6520 /* make_lispy_event will convert this to a symbolic
6521 key. */
6522 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6523 inev.ie.code = keysym;
6524 goto done_keysym;
6527 { /* Raw bytes, not keysym. */
6528 register int i;
6529 register int c;
6530 int nchars, len;
6532 for (i = 0, nchars = 0; i < nbytes; i++)
6534 if (ASCII_BYTE_P (copy_bufptr[i]))
6535 nchars++;
6536 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6539 if (nchars < nbytes)
6541 /* Decode the input data. */
6542 int require;
6543 unsigned char *p;
6545 /* The input should be decoded with `coding_system'
6546 which depends on which X*LookupString function
6547 we used just above and the locale. */
6548 setup_coding_system (coding_system, &coding);
6549 coding.src_multibyte = 0;
6550 coding.dst_multibyte = 1;
6551 /* The input is converted to events, thus we can't
6552 handle composition. Anyway, there's no XIM that
6553 gives us composition information. */
6554 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6556 require = MAX_MULTIBYTE_LENGTH * nbytes;
6557 coding.destination = alloca (require);
6558 coding.dst_bytes = require;
6559 coding.mode |= CODING_MODE_LAST_BLOCK;
6560 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6561 nbytes = coding.produced;
6562 nchars = coding.produced_char;
6563 copy_bufptr = coding.destination;
6566 /* Convert the input data to a sequence of
6567 character events. */
6568 for (i = 0; i < nbytes; i += len)
6570 if (nchars == nbytes)
6571 c = copy_bufptr[i], len = 1;
6572 else
6573 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i,
6574 nbytes - i, len);
6575 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6576 ? ASCII_KEYSTROKE_EVENT
6577 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6578 inev.ie.code = c;
6579 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6582 count += nchars;
6584 inev.ie.kind = NO_EVENT; /* Already stored above. */
6586 if (keysym == NoSymbol)
6587 break;
6590 done_keysym:
6591 #ifdef HAVE_X_I18N
6592 /* Don't dispatch this event since XtDispatchEvent calls
6593 XFilterEvent, and two calls in a row may freeze the
6594 client. */
6595 break;
6596 #else
6597 goto OTHER;
6598 #endif
6600 case KeyRelease:
6601 last_user_time = event.xkey.time;
6602 #ifdef HAVE_X_I18N
6603 /* Don't dispatch this event since XtDispatchEvent calls
6604 XFilterEvent, and two calls in a row may freeze the
6605 client. */
6606 break;
6607 #else
6608 goto OTHER;
6609 #endif
6611 case EnterNotify:
6612 last_user_time = event.xcrossing.time;
6613 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6615 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6617 if (f && x_mouse_click_focus_ignore_position)
6618 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6620 #if 0
6621 if (event.xcrossing.focus)
6623 /* Avoid nasty pop/raise loops. */
6624 if (f && (!(f->auto_raise)
6625 || !(f->auto_lower)
6626 || (event.xcrossing.time - enter_timestamp) > 500))
6628 x_new_focus_frame (dpyinfo, f);
6629 enter_timestamp = event.xcrossing.time;
6632 else if (f == dpyinfo->x_focus_frame)
6633 x_new_focus_frame (dpyinfo, 0);
6634 #endif
6636 /* EnterNotify counts as mouse movement,
6637 so update things that depend on mouse position. */
6638 if (f && !f->output_data.x->hourglass_p)
6639 note_mouse_movement (f, &event.xmotion);
6640 #ifdef USE_GTK
6641 /* We may get an EnterNotify on the buttons in the toolbar. In that
6642 case we moved out of any highlighted area and need to note this. */
6643 if (!f && last_mouse_glyph_frame)
6644 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6645 #endif
6646 goto OTHER;
6648 case FocusIn:
6649 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6650 goto OTHER;
6652 case LeaveNotify:
6653 last_user_time = event.xcrossing.time;
6654 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6656 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6657 if (f)
6659 if (f == dpyinfo->mouse_face_mouse_frame)
6661 /* If we move outside the frame, then we're
6662 certainly no longer on any text in the frame. */
6663 clear_mouse_face (dpyinfo);
6664 dpyinfo->mouse_face_mouse_frame = 0;
6667 /* Generate a nil HELP_EVENT to cancel a help-echo.
6668 Do it only if there's something to cancel.
6669 Otherwise, the startup message is cleared when
6670 the mouse leaves the frame. */
6671 if (any_help_event_p)
6672 do_help = -1;
6674 #ifdef USE_GTK
6675 /* See comment in EnterNotify above */
6676 else if (last_mouse_glyph_frame)
6677 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6678 #endif
6679 goto OTHER;
6681 case FocusOut:
6682 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6683 goto OTHER;
6685 case MotionNotify:
6687 last_user_time = event.xmotion.time;
6688 previous_help_echo_string = help_echo_string;
6689 help_echo_string = Qnil;
6691 if (dpyinfo->grabbed && last_mouse_frame
6692 && FRAME_LIVE_P (last_mouse_frame))
6693 f = last_mouse_frame;
6694 else
6695 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6697 if (dpyinfo->mouse_face_hidden)
6699 dpyinfo->mouse_face_hidden = 0;
6700 clear_mouse_face (dpyinfo);
6703 if (f)
6706 /* Generate SELECT_WINDOW_EVENTs when needed. */
6707 if (!NILP (Vmouse_autoselect_window))
6709 Lisp_Object window;
6711 window = window_from_coordinates (f,
6712 event.xmotion.x, event.xmotion.y,
6713 0, 0, 0, 0);
6715 /* Window will be selected only when it is not selected now and
6716 last mouse movement event was not in it. Minibuffer window
6717 will be selected only when it is active. */
6718 if (WINDOWP (window)
6719 && !EQ (window, last_window)
6720 && !EQ (window, selected_window)
6721 /* For click-to-focus window managers
6722 create event iff we don't leave the
6723 selected frame. */
6724 && (focus_follows_mouse
6725 || (EQ (XWINDOW (window)->frame,
6726 XWINDOW (selected_window)->frame))))
6728 inev.ie.kind = SELECT_WINDOW_EVENT;
6729 inev.ie.frame_or_window = window;
6732 last_window=window;
6734 if (!note_mouse_movement (f, &event.xmotion))
6735 help_echo_string = previous_help_echo_string;
6737 else
6739 #ifndef USE_TOOLKIT_SCROLL_BARS
6740 struct scroll_bar *bar
6741 = x_window_to_scroll_bar (event.xmotion.display,
6742 event.xmotion.window);
6744 if (bar)
6745 x_scroll_bar_note_movement (bar, &event);
6746 #endif /* USE_TOOLKIT_SCROLL_BARS */
6748 /* If we move outside the frame, then we're
6749 certainly no longer on any text in the frame. */
6750 clear_mouse_face (dpyinfo);
6753 /* If the contents of the global variable help_echo_string
6754 has changed, generate a HELP_EVENT. */
6755 if (!NILP (help_echo_string)
6756 || !NILP (previous_help_echo_string))
6757 do_help = 1;
6758 goto OTHER;
6761 case ConfigureNotify:
6762 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6763 #ifdef USE_GTK
6764 if (!f
6765 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6766 && event.xconfigure.window == FRAME_X_WINDOW (f))
6768 xg_frame_resized (f, event.xconfigure.width,
6769 event.xconfigure.height);
6770 f = 0;
6772 #endif
6773 if (f)
6775 #ifndef USE_X_TOOLKIT
6776 #ifndef USE_GTK
6777 /* If there is a pending resize for fullscreen, don't
6778 do this one, the right one will come later.
6779 The toolkit version doesn't seem to need this, but we
6780 need to reset it below. */
6781 int dont_resize
6782 = ((f->want_fullscreen & FULLSCREEN_WAIT)
6783 && f->new_text_cols != 0);
6784 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6785 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6787 if (dont_resize)
6788 goto OTHER;
6790 /* In the toolkit version, change_frame_size
6791 is called by the code that handles resizing
6792 of the EmacsFrame widget. */
6794 /* Even if the number of character rows and columns has
6795 not changed, the font size may have changed, so we need
6796 to check the pixel dimensions as well. */
6797 if (columns != FRAME_COLS (f)
6798 || rows != FRAME_LINES (f)
6799 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6800 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6802 change_frame_size (f, rows, columns, 0, 1, 0);
6803 SET_FRAME_GARBAGED (f);
6804 cancel_mouse_face (f);
6807 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6808 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6809 #endif /* not USE_GTK */
6810 #endif
6812 #ifdef USE_GTK
6813 /* GTK creates windows but doesn't map them.
6814 Only get real positions and check fullscreen when mapped. */
6815 if (FRAME_GTK_OUTER_WIDGET (f)
6816 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6817 #endif
6819 x_real_positions (f, &f->left_pos, &f->top_pos);
6821 if (f->want_fullscreen & FULLSCREEN_WAIT)
6822 f->want_fullscreen &= ~(FULLSCREEN_WAIT|FULLSCREEN_BOTH);
6825 #ifdef HAVE_X_I18N
6826 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6827 xic_set_statusarea (f);
6828 #endif
6830 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
6832 /* Since the WM decorations come below top_pos now,
6833 we must put them below top_pos in the future. */
6834 f->win_gravity = NorthWestGravity;
6835 x_wm_set_size_hint (f, (long) 0, 0);
6838 goto OTHER;
6840 case ButtonRelease:
6841 case ButtonPress:
6843 /* If we decide we want to generate an event to be seen
6844 by the rest of Emacs, we put it here. */
6845 int tool_bar_p = 0;
6847 bzero (&compose_status, sizeof (compose_status));
6848 last_mouse_glyph_frame = 0;
6849 last_user_time = event.xbutton.time;
6851 if (dpyinfo->grabbed
6852 && last_mouse_frame
6853 && FRAME_LIVE_P (last_mouse_frame))
6854 f = last_mouse_frame;
6855 else
6856 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6858 if (f)
6860 /* Is this in the tool-bar? */
6861 if (WINDOWP (f->tool_bar_window)
6862 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6864 Lisp_Object window;
6865 int x = event.xbutton.x;
6866 int y = event.xbutton.y;
6868 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6869 tool_bar_p = EQ (window, f->tool_bar_window);
6871 if (tool_bar_p && event.xbutton.button < 4)
6873 handle_tool_bar_click (f, x, y,
6874 event.xbutton.type == ButtonPress,
6875 x_x_to_emacs_modifiers (dpyinfo,
6876 event.xbutton.state));
6880 if (!tool_bar_p)
6881 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6882 if (! popup_activated ())
6883 #endif
6885 if (ignore_next_mouse_click_timeout)
6887 if (event.type == ButtonPress
6888 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6890 ignore_next_mouse_click_timeout = 0;
6891 construct_mouse_click (&inev.ie, &event.xbutton, f);
6893 if (event.type == ButtonRelease)
6894 ignore_next_mouse_click_timeout = 0;
6896 else
6897 construct_mouse_click (&inev.ie, &event.xbutton, f);
6899 if (FRAME_X_EMBEDDED_P (f))
6900 xembed_send_message (f, event.xbutton.time,
6901 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6903 else
6905 struct scroll_bar *bar
6906 = x_window_to_scroll_bar (event.xbutton.display,
6907 event.xbutton.window);
6909 #ifdef USE_TOOLKIT_SCROLL_BARS
6910 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6911 scroll bars. */
6912 if (bar && event.xbutton.state & ControlMask)
6914 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6915 *finish = X_EVENT_DROP;
6917 #else /* not USE_TOOLKIT_SCROLL_BARS */
6918 if (bar)
6919 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6920 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6923 if (event.type == ButtonPress)
6925 dpyinfo->grabbed |= (1 << event.xbutton.button);
6926 last_mouse_frame = f;
6928 if (!tool_bar_p)
6929 last_tool_bar_item = -1;
6931 else
6932 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6934 /* Ignore any mouse motion that happened before this event;
6935 any subsequent mouse-movement Emacs events should reflect
6936 only motion after the ButtonPress/Release. */
6937 if (f != 0)
6938 f->mouse_moved = 0;
6940 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6941 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6942 /* For a down-event in the menu bar,
6943 don't pass it to Xt right now.
6944 Instead, save it away
6945 and we will pass it to Xt from kbd_buffer_get_event.
6946 That way, we can run some Lisp code first. */
6947 if (
6948 #ifdef USE_GTK
6949 ! popup_activated ()
6950 /* Gtk+ menus only react to the first three buttons. */
6951 && event.xbutton.button < 3
6953 #endif
6954 f && event.type == ButtonPress
6955 /* Verify the event is really within the menu bar
6956 and not just sent to it due to grabbing. */
6957 && event.xbutton.x >= 0
6958 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6959 && event.xbutton.y >= 0
6960 && event.xbutton.y < f->output_data.x->menubar_height
6961 && event.xbutton.same_screen)
6963 SET_SAVED_BUTTON_EVENT;
6964 XSETFRAME (last_mouse_press_frame, f);
6965 #ifdef USE_GTK
6966 *finish = X_EVENT_DROP;
6967 #endif
6969 else if (event.type == ButtonPress)
6971 last_mouse_press_frame = Qnil;
6972 goto OTHER;
6975 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6976 but I am trying to be cautious. */
6977 else if (event.type == ButtonRelease)
6979 if (!NILP (last_mouse_press_frame))
6981 f = XFRAME (last_mouse_press_frame);
6982 if (f->output_data.x)
6983 SET_SAVED_BUTTON_EVENT;
6985 else
6986 goto OTHER;
6988 #endif /* USE_MOTIF */
6989 else
6990 goto OTHER;
6991 #endif /* USE_X_TOOLKIT || USE_GTK */
6993 break;
6995 case CirculateNotify:
6996 goto OTHER;
6998 case CirculateRequest:
6999 goto OTHER;
7001 case VisibilityNotify:
7002 goto OTHER;
7004 case MappingNotify:
7005 /* Someone has changed the keyboard mapping - update the
7006 local cache. */
7007 switch (event.xmapping.request)
7009 case MappingModifier:
7010 x_find_modifier_meanings (dpyinfo);
7011 /* This is meant to fall through. */
7012 case MappingKeyboard:
7013 XRefreshKeyboardMapping (&event.xmapping);
7015 goto OTHER;
7017 default:
7018 OTHER:
7019 #ifdef USE_X_TOOLKIT
7020 BLOCK_INPUT;
7021 if (*finish != X_EVENT_DROP)
7022 XtDispatchEvent (&event);
7023 UNBLOCK_INPUT;
7024 #endif /* USE_X_TOOLKIT */
7025 break;
7028 done:
7029 if (inev.ie.kind != NO_EVENT)
7031 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7032 count++;
7035 if (do_help
7036 && !(hold_quit && hold_quit->kind != NO_EVENT))
7038 Lisp_Object frame;
7040 if (f)
7041 XSETFRAME (frame, f);
7042 else
7043 frame = Qnil;
7045 if (do_help > 0)
7047 any_help_event_p = 1;
7048 gen_help_event (help_echo_string, frame, help_echo_window,
7049 help_echo_object, help_echo_pos);
7051 else
7053 help_echo_string = Qnil;
7054 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7056 count++;
7059 *eventp = event;
7060 return count;
7064 /* Handles the XEvent EVENT on display DISPLAY.
7065 This is used for event loops outside the normal event handling,
7066 i.e. looping while a popup menu or a dialog is posted.
7068 Returns the value handle_one_xevent sets in the finish argument. */
7070 x_dispatch_event (event, display)
7071 XEvent *event;
7072 Display *display;
7074 struct x_display_info *dpyinfo;
7075 int finish = X_EVENT_NORMAL;
7077 dpyinfo = x_display_info_for_display (display);
7079 if (dpyinfo)
7080 handle_one_xevent (dpyinfo, event, &finish, 0);
7082 return finish;
7086 /* Read events coming from the X server.
7087 This routine is called by the SIGIO handler.
7088 We return as soon as there are no more events to be read.
7090 We return the number of characters stored into the buffer,
7091 thus pretending to be `read' (except the characters we store
7092 in the keyboard buffer can be multibyte, so are not necessarily
7093 C chars).
7095 EXPECTED is nonzero if the caller knows input is available. */
7097 static int
7098 XTread_socket (terminal, expected, hold_quit)
7099 struct terminal *terminal;
7100 int expected;
7101 struct input_event *hold_quit;
7103 int count = 0;
7104 XEvent event;
7105 int event_found = 0;
7106 #if 0
7107 struct x_display_info *dpyinfo;
7108 #endif
7110 if (interrupt_input_blocked)
7112 interrupt_input_pending = 1;
7113 return -1;
7116 interrupt_input_pending = 0;
7117 BLOCK_INPUT;
7119 /* So people can tell when we have read the available input. */
7120 input_signal_count++;
7122 ++handling_signal;
7124 #ifdef HAVE_X_SM
7125 /* Only check session manager input for the primary display. */
7126 if (terminal->id == 1 && x_session_have_connection ())
7128 struct input_event inev;
7129 BLOCK_INPUT;
7130 /* We don't need to EVENT_INIT (inev) here, as
7131 x_session_check_input copies an entire input_event. */
7132 if (x_session_check_input (&inev))
7134 kbd_buffer_store_event_hold (&inev, hold_quit);
7135 count++;
7137 UNBLOCK_INPUT;
7139 #endif
7141 /* For debugging, this gives a way to fake an I/O error. */
7142 if (terminal->display_info.x == XTread_socket_fake_io_error)
7144 XTread_socket_fake_io_error = 0;
7145 x_io_error_quitter (terminal->display_info.x->display);
7148 #if 0 /* This loop is a noop now. */
7149 /* Find the display we are supposed to read input for.
7150 It's the one communicating on descriptor SD. */
7151 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
7153 #if 0 /* This ought to be unnecessary; let's verify it. */
7154 #ifdef FIOSNBIO
7155 /* If available, Xlib uses FIOSNBIO to make the socket
7156 non-blocking, and then looks for EWOULDBLOCK. If O_NDELAY is set,
7157 FIOSNBIO is ignored, and instead of signaling EWOULDBLOCK,
7158 a read returns 0, which Xlib interprets as equivalent to EPIPE. */
7159 fcntl (dpyinfo->connection, F_SETFL, 0);
7160 #endif /* ! defined (FIOSNBIO) */
7161 #endif
7163 #if 0 /* This code can't be made to work, with multiple displays,
7164 and appears not to be used on any system any more.
7165 Also keyboard.c doesn't turn O_NDELAY on and off
7166 for X connections. */
7167 #ifndef SIGIO
7168 #ifndef HAVE_SELECT
7169 if (! (fcntl (dpyinfo->connection, F_GETFL, 0) & O_NDELAY))
7171 extern int read_alarm_should_throw;
7172 read_alarm_should_throw = 1;
7173 XPeekEvent (dpyinfo->display, &event);
7174 read_alarm_should_throw = 0;
7176 #endif /* HAVE_SELECT */
7177 #endif /* SIGIO */
7178 #endif
7180 #endif
7182 #ifndef USE_GTK
7183 while (XPending (terminal->display_info.x->display))
7185 int finish;
7187 XNextEvent (terminal->display_info.x->display, &event);
7189 #ifdef HAVE_X_I18N
7190 /* Filter events for the current X input method. */
7191 if (x_filter_event (terminal->display_info.x, &event))
7192 break;
7193 #endif
7194 event_found = 1;
7196 count += handle_one_xevent (terminal->display_info.x,
7197 &event, &finish, hold_quit);
7199 if (finish == X_EVENT_GOTO_OUT)
7200 goto out;
7203 #else /* USE_GTK */
7205 /* For GTK we must use the GTK event loop. But XEvents gets passed
7206 to our filter function above, and then to the big event switch.
7207 We use a bunch of globals to communicate with our filter function,
7208 that is kind of ugly, but it works.
7210 There is no way to do one display at the time, GTK just does events
7211 from all displays. */
7213 while (gtk_events_pending ())
7215 current_count = count;
7216 current_hold_quit = hold_quit;
7218 gtk_main_iteration ();
7220 count = current_count;
7221 current_count = -1;
7222 current_hold_quit = 0;
7224 if (current_finish == X_EVENT_GOTO_OUT)
7225 break;
7227 #endif /* USE_GTK */
7229 out:;
7231 /* On some systems, an X bug causes Emacs to get no more events
7232 when the window is destroyed. Detect that. (1994.) */
7233 if (! event_found)
7235 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7236 One XNOOP in 100 loops will make Emacs terminate.
7237 B. Bretthauer, 1994 */
7238 x_noop_count++;
7239 if (x_noop_count >= 100)
7241 x_noop_count=0;
7243 if (next_noop_dpyinfo == 0)
7244 next_noop_dpyinfo = x_display_list;
7246 XNoOp (next_noop_dpyinfo->display);
7248 /* Each time we get here, cycle through the displays now open. */
7249 next_noop_dpyinfo = next_noop_dpyinfo->next;
7253 /* If the focus was just given to an auto-raising frame,
7254 raise it now. */
7255 /* ??? This ought to be able to handle more than one such frame. */
7256 if (pending_autoraise_frame)
7258 x_raise_frame (pending_autoraise_frame);
7259 pending_autoraise_frame = 0;
7262 --handling_signal;
7263 UNBLOCK_INPUT;
7265 return count;
7271 /***********************************************************************
7272 Text Cursor
7273 ***********************************************************************/
7275 /* Set clipping for output in glyph row ROW. W is the window in which
7276 we operate. GC is the graphics context to set clipping in.
7278 ROW may be a text row or, e.g., a mode line. Text rows must be
7279 clipped to the interior of the window dedicated to text display,
7280 mode lines must be clipped to the whole window. */
7282 static void
7283 x_clip_to_row (w, row, area, gc)
7284 struct window *w;
7285 struct glyph_row *row;
7286 int area;
7287 GC gc;
7289 struct frame *f = XFRAME (WINDOW_FRAME (w));
7290 XRectangle clip_rect;
7291 int window_x, window_y, window_width;
7293 window_box (w, area, &window_x, &window_y, &window_width, 0);
7295 clip_rect.x = window_x;
7296 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7297 clip_rect.y = max (clip_rect.y, window_y);
7298 clip_rect.width = window_width;
7299 clip_rect.height = row->visible_height;
7301 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7305 /* Draw a hollow box cursor on window W in glyph row ROW. */
7307 static void
7308 x_draw_hollow_cursor (w, row)
7309 struct window *w;
7310 struct glyph_row *row;
7312 struct frame *f = XFRAME (WINDOW_FRAME (w));
7313 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7314 Display *dpy = FRAME_X_DISPLAY (f);
7315 int x, y, wd, h;
7316 XGCValues xgcv;
7317 struct glyph *cursor_glyph;
7318 GC gc;
7320 /* Get the glyph the cursor is on. If we can't tell because
7321 the current matrix is invalid or such, give up. */
7322 cursor_glyph = get_phys_cursor_glyph (w);
7323 if (cursor_glyph == NULL)
7324 return;
7326 /* Compute frame-relative coordinates for phys cursor. */
7327 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7328 wd = w->phys_cursor_width;
7330 /* The foreground of cursor_gc is typically the same as the normal
7331 background color, which can cause the cursor box to be invisible. */
7332 xgcv.foreground = f->output_data.x->cursor_pixel;
7333 if (dpyinfo->scratch_cursor_gc)
7334 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7335 else
7336 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7337 GCForeground, &xgcv);
7338 gc = dpyinfo->scratch_cursor_gc;
7340 /* Set clipping, draw the rectangle, and reset clipping again. */
7341 x_clip_to_row (w, row, TEXT_AREA, gc);
7342 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7343 XSetClipMask (dpy, gc, None);
7347 /* Draw a bar cursor on window W in glyph row ROW.
7349 Implementation note: One would like to draw a bar cursor with an
7350 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7351 Unfortunately, I didn't find a font yet that has this property set.
7352 --gerd. */
7354 static void
7355 x_draw_bar_cursor (w, row, width, kind)
7356 struct window *w;
7357 struct glyph_row *row;
7358 int width;
7359 enum text_cursor_kinds kind;
7361 struct frame *f = XFRAME (w->frame);
7362 struct glyph *cursor_glyph;
7364 /* If cursor is out of bounds, don't draw garbage. This can happen
7365 in mini-buffer windows when switching between echo area glyphs
7366 and mini-buffer. */
7367 cursor_glyph = get_phys_cursor_glyph (w);
7368 if (cursor_glyph == NULL)
7369 return;
7371 /* If on an image, draw like a normal cursor. That's usually better
7372 visible than drawing a bar, esp. if the image is large so that
7373 the bar might not be in the window. */
7374 if (cursor_glyph->type == IMAGE_GLYPH)
7376 struct glyph_row *row;
7377 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7378 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7380 else
7382 Display *dpy = FRAME_X_DISPLAY (f);
7383 Window window = FRAME_X_WINDOW (f);
7384 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7385 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7386 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7387 XGCValues xgcv;
7389 /* If the glyph's background equals the color we normally draw
7390 the bar cursor in, the bar cursor in its normal color is
7391 invisible. Use the glyph's foreground color instead in this
7392 case, on the assumption that the glyph's colors are chosen so
7393 that the glyph is legible. */
7394 if (face->background == f->output_data.x->cursor_pixel)
7395 xgcv.background = xgcv.foreground = face->foreground;
7396 else
7397 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7398 xgcv.graphics_exposures = 0;
7400 if (gc)
7401 XChangeGC (dpy, gc, mask, &xgcv);
7402 else
7404 gc = XCreateGC (dpy, window, mask, &xgcv);
7405 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7408 if (width < 0)
7409 width = FRAME_CURSOR_WIDTH (f);
7410 width = min (cursor_glyph->pixel_width, width);
7412 w->phys_cursor_width = width;
7413 x_clip_to_row (w, row, TEXT_AREA, gc);
7415 if (kind == BAR_CURSOR)
7416 XFillRectangle (dpy, window, gc,
7417 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7418 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7419 width, row->height);
7420 else
7421 XFillRectangle (dpy, window, gc,
7422 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7423 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7424 row->height - width),
7425 cursor_glyph->pixel_width,
7426 width);
7428 XSetClipMask (dpy, gc, None);
7433 /* RIF: Define cursor CURSOR on frame F. */
7435 static void
7436 x_define_frame_cursor (f, cursor)
7437 struct frame *f;
7438 Cursor cursor;
7440 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7444 /* RIF: Clear area on frame F. */
7446 static void
7447 x_clear_frame_area (f, x, y, width, height)
7448 struct frame *f;
7449 int x, y, width, height;
7451 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7452 x, y, width, height, False);
7456 /* RIF: Draw cursor on window W. */
7458 static void
7459 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7460 struct window *w;
7461 struct glyph_row *glyph_row;
7462 int x, y;
7463 int cursor_type, cursor_width;
7464 int on_p, active_p;
7466 struct frame *f = XFRAME (WINDOW_FRAME (w));
7468 if (on_p)
7470 w->phys_cursor_type = cursor_type;
7471 w->phys_cursor_on_p = 1;
7473 if (glyph_row->exact_window_width_line_p
7474 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7476 glyph_row->cursor_in_fringe_p = 1;
7477 draw_fringe_bitmap (w, glyph_row, 0);
7479 else
7480 switch (cursor_type)
7482 case HOLLOW_BOX_CURSOR:
7483 x_draw_hollow_cursor (w, glyph_row);
7484 break;
7486 case FILLED_BOX_CURSOR:
7487 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7488 break;
7490 case BAR_CURSOR:
7491 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7492 break;
7494 case HBAR_CURSOR:
7495 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7496 break;
7498 case NO_CURSOR:
7499 w->phys_cursor_width = 0;
7500 break;
7502 default:
7503 abort ();
7506 #ifdef HAVE_X_I18N
7507 if (w == XWINDOW (f->selected_window))
7508 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7509 xic_set_preeditarea (w, x, y);
7510 #endif
7513 #ifndef XFlush
7514 XFlush (FRAME_X_DISPLAY (f));
7515 #endif
7519 /* Icons. */
7521 /* Make the x-window of frame F use the gnu icon bitmap. */
7524 x_bitmap_icon (f, file)
7525 struct frame *f;
7526 Lisp_Object file;
7528 int bitmap_id;
7530 if (FRAME_X_WINDOW (f) == 0)
7531 return 1;
7533 /* Free up our existing icon bitmap and mask if any. */
7534 if (f->output_data.x->icon_bitmap > 0)
7535 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7536 f->output_data.x->icon_bitmap = 0;
7538 if (STRINGP (file))
7540 #ifdef USE_GTK
7541 /* Use gtk_window_set_icon_from_file () if available,
7542 It's not restricted to bitmaps */
7543 if (xg_set_icon (f, file))
7544 return 0;
7545 #endif /* USE_GTK */
7546 bitmap_id = x_create_bitmap_from_file (f, file);
7547 x_create_bitmap_mask (f, bitmap_id);
7549 else
7551 /* Create the GNU bitmap and mask if necessary. */
7552 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7554 int rc = -1;
7556 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7557 #ifdef USE_GTK
7558 if (xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7559 return 0;
7560 #else
7561 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7562 if (rc != -1)
7563 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7564 #endif /* USE_GTK */
7565 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
7567 /* If all else fails, use the (black and white) xbm image. */
7568 if (rc == -1)
7570 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7571 gnu_xbm_width, gnu_xbm_height);
7572 if (rc == -1)
7573 return 1;
7575 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7576 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7580 /* The first time we create the GNU bitmap and mask,
7581 this increments the ref-count one extra time.
7582 As a result, the GNU bitmap and mask are never freed.
7583 That way, we don't have to worry about allocating it again. */
7584 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7586 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7589 x_wm_set_icon_pixmap (f, bitmap_id);
7590 f->output_data.x->icon_bitmap = bitmap_id;
7592 return 0;
7596 /* Make the x-window of frame F use a rectangle with text.
7597 Use ICON_NAME as the text. */
7600 x_text_icon (f, icon_name)
7601 struct frame *f;
7602 char *icon_name;
7604 if (FRAME_X_WINDOW (f) == 0)
7605 return 1;
7608 XTextProperty text;
7609 text.value = (unsigned char *) icon_name;
7610 text.encoding = XA_STRING;
7611 text.format = 8;
7612 text.nitems = strlen (icon_name);
7613 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7616 if (f->output_data.x->icon_bitmap > 0)
7617 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7618 f->output_data.x->icon_bitmap = 0;
7619 x_wm_set_icon_pixmap (f, 0);
7621 return 0;
7624 #define X_ERROR_MESSAGE_SIZE 200
7626 /* If non-nil, this should be a string.
7627 It means catch X errors and store the error message in this string.
7629 The reason we use a stack is that x_catch_error/x_uncatch_error can
7630 be called from a signal handler.
7633 struct x_error_message_stack {
7634 char string[X_ERROR_MESSAGE_SIZE];
7635 Display *dpy;
7636 struct x_error_message_stack *prev;
7638 static struct x_error_message_stack *x_error_message;
7640 /* An X error handler which stores the error message in
7641 *x_error_message. This is called from x_error_handler if
7642 x_catch_errors is in effect. */
7644 static void
7645 x_error_catcher (display, error)
7646 Display *display;
7647 XErrorEvent *error;
7649 XGetErrorText (display, error->error_code,
7650 x_error_message->string,
7651 X_ERROR_MESSAGE_SIZE);
7654 /* Begin trapping X errors for display DPY. Actually we trap X errors
7655 for all displays, but DPY should be the display you are actually
7656 operating on.
7658 After calling this function, X protocol errors no longer cause
7659 Emacs to exit; instead, they are recorded in the string
7660 stored in *x_error_message.
7662 Calling x_check_errors signals an Emacs error if an X error has
7663 occurred since the last call to x_catch_errors or x_check_errors.
7665 Calling x_uncatch_errors resumes the normal error handling. */
7667 void x_check_errors ();
7669 void
7670 x_catch_errors (dpy)
7671 Display *dpy;
7673 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7675 /* Make sure any errors from previous requests have been dealt with. */
7676 XSync (dpy, False);
7678 data->dpy = dpy;
7679 data->string[0] = 0;
7680 data->prev = x_error_message;
7681 x_error_message = data;
7684 /* Undo the last x_catch_errors call.
7685 DPY should be the display that was passed to x_catch_errors. */
7687 void
7688 x_uncatch_errors ()
7690 struct x_error_message_stack *tmp;
7692 BLOCK_INPUT;
7694 /* The display may have been closed before this function is called.
7695 Check if it is still open before calling XSync. */
7696 if (x_display_info_for_display (x_error_message->dpy) != 0)
7697 XSync (x_error_message->dpy, False);
7699 tmp = x_error_message;
7700 x_error_message = x_error_message->prev;
7701 xfree (tmp);
7702 UNBLOCK_INPUT;
7705 /* If any X protocol errors have arrived since the last call to
7706 x_catch_errors or x_check_errors, signal an Emacs error using
7707 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7709 void
7710 x_check_errors (dpy, format)
7711 Display *dpy;
7712 char *format;
7714 /* Make sure to catch any errors incurred so far. */
7715 XSync (dpy, False);
7717 if (x_error_message->string[0])
7719 char string[X_ERROR_MESSAGE_SIZE];
7720 bcopy (x_error_message->string, string, X_ERROR_MESSAGE_SIZE);
7721 x_uncatch_errors ();
7722 error (format, string);
7726 /* Nonzero if we had any X protocol errors
7727 since we did x_catch_errors on DPY. */
7730 x_had_errors_p (dpy)
7731 Display *dpy;
7733 /* Make sure to catch any errors incurred so far. */
7734 XSync (dpy, False);
7736 return x_error_message->string[0] != 0;
7739 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7741 void
7742 x_clear_errors (dpy)
7743 Display *dpy;
7745 x_error_message->string[0] = 0;
7748 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7749 * idea. --lorentey */
7750 /* Close off all unclosed x_catch_errors calls. */
7752 void
7753 x_fully_uncatch_errors ()
7755 while (x_error_message)
7756 x_uncatch_errors ();
7758 #endif
7760 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7763 x_catching_errors ()
7765 return x_error_message != 0;
7768 #if 0
7769 static unsigned int x_wire_count;
7770 x_trace_wire ()
7772 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7774 #endif /* ! 0 */
7777 /* Handle SIGPIPE, which can happen when the connection to a server
7778 simply goes away. SIGPIPE is handled by x_connection_signal.
7779 Don't need to do anything, because the write which caused the
7780 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7781 which will do the appropriate cleanup for us. */
7783 static SIGTYPE
7784 x_connection_signal (signalnum) /* If we don't have an argument, */
7785 int signalnum; /* some compilers complain in signal calls. */
7787 #ifdef USG
7788 /* USG systems forget handlers when they are used;
7789 must reestablish each time */
7790 signal (signalnum, x_connection_signal);
7791 #endif /* USG */
7795 /************************************************************************
7796 Handling X errors
7797 ************************************************************************/
7799 /* Error message passed to x_connection_closed. */
7801 static char *error_msg;
7803 /* Function installed as fatal_error_signal_hook in
7804 x_connection_closed. Print the X error message, and exit normally,
7805 instead of dumping core when XtCloseDisplay fails. */
7807 static void
7808 x_fatal_error_signal ()
7810 fprintf (stderr, "%s\n", error_msg);
7811 exit (70);
7814 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7815 the text of an error message that lead to the connection loss. */
7817 static SIGTYPE
7818 x_connection_closed (dpy, error_message)
7819 Display *dpy;
7820 char *error_message;
7822 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7823 Lisp_Object frame, tail;
7824 int index = SPECPDL_INDEX ();
7826 error_msg = (char *) alloca (strlen (error_message) + 1);
7827 strcpy (error_msg, error_message);
7828 handling_signal = 0;
7830 /* Prevent being called recursively because of an error condition
7831 below. Otherwise, we might end up with printing ``can't find per
7832 display information'' in the recursive call instead of printing
7833 the original message here. */
7834 x_catch_errors (dpy);
7836 /* Inhibit redisplay while frames are being deleted. */
7837 specbind (Qinhibit_redisplay, Qt);
7839 if (dpyinfo)
7841 /* Protect display from being closed when we delete the last
7842 frame on it. */
7843 dpyinfo->reference_count++;
7844 dpyinfo->terminal->reference_count++;
7847 /* First delete frames whose mini-buffers are on frames
7848 that are on the dead display. */
7849 FOR_EACH_FRAME (tail, frame)
7851 Lisp_Object minibuf_frame;
7852 minibuf_frame
7853 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7854 if (FRAME_X_P (XFRAME (frame))
7855 && FRAME_X_P (XFRAME (minibuf_frame))
7856 && ! EQ (frame, minibuf_frame)
7857 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7858 Fdelete_frame (frame, Qnoelisp);
7861 /* Now delete all remaining frames on the dead display.
7862 We are now sure none of these is used as the mini-buffer
7863 for another frame that we need to delete. */
7864 FOR_EACH_FRAME (tail, frame)
7865 if (FRAME_X_P (XFRAME (frame))
7866 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7868 /* Set this to t so that Fdelete_frame won't get confused
7869 trying to find a replacement. */
7870 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7871 Fdelete_frame (frame, Qnoelisp);
7874 /* We have to close the display to inform Xt that it doesn't
7875 exist anymore. If we don't, Xt will continue to wait for
7876 events from the display. As a consequence, a sequence of
7878 M-x make-frame-on-display RET :1 RET
7879 ...kill the new frame, so that we get an IO error...
7880 M-x make-frame-on-display RET :1 RET
7882 will indefinitely wait in Xt for events for display `:1', opened
7883 in the first call to make-frame-on-display.
7885 Closing the display is reported to lead to a bus error on
7886 OpenWindows in certain situations. I suspect that is a bug
7887 in OpenWindows. I don't know how to circumvent it here. */
7889 if (dpyinfo)
7891 #ifdef USE_X_TOOLKIT
7892 /* If DPYINFO is null, this means we didn't open the display
7893 in the first place, so don't try to close it. */
7895 extern void (*fatal_error_signal_hook) P_ ((void));
7896 fatal_error_signal_hook = x_fatal_error_signal;
7897 XtCloseDisplay (dpy);
7898 fatal_error_signal_hook = NULL;
7900 #endif
7902 #ifdef USE_GTK
7903 /* Due to bugs in some Gtk+ versions, just exit here if this
7904 is the last display/terminal. */
7905 if (terminal_list->next_terminal == NULL)
7907 fprintf (stderr, "%s\n", error_msg);
7908 shut_down_emacs (0, 0, Qnil);
7909 exit (70);
7911 xg_display_close (dpyinfo->display);
7912 #endif
7914 /* Indicate that this display is dead. */
7915 dpyinfo->display = 0;
7917 dpyinfo->reference_count--;
7918 dpyinfo->terminal->reference_count--;
7919 if (dpyinfo->reference_count != 0)
7920 /* We have just closed all frames on this display. */
7921 abort ();
7924 Lisp_Object tmp;
7925 XSETTERMINAL (tmp, dpyinfo->terminal);
7926 Fdelete_terminal (tmp, Qnoelisp);
7930 x_uncatch_errors ();
7932 if (terminal_list == 0)
7934 fprintf (stderr, "%s\n", error_msg);
7935 shut_down_emacs (0, 0, Qnil);
7936 exit (70);
7939 /* Ordinary stack unwind doesn't deal with these. */
7940 #ifdef SIGIO
7941 sigunblock (sigmask (SIGIO));
7942 #endif
7943 sigunblock (sigmask (SIGALRM));
7944 TOTALLY_UNBLOCK_INPUT;
7946 unbind_to (index, Qnil);
7947 clear_waiting_for_input ();
7948 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7949 longjmp), because returning from this function would get us back into
7950 Xlib's code which will directly call `exit'. */
7951 error ("%s", error_msg);
7954 /* We specifically use it before defining it, so that gcc doesn't inline it,
7955 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7956 static void x_error_quitter P_ ((Display *, XErrorEvent *));
7958 /* This is the first-level handler for X protocol errors.
7959 It calls x_error_quitter or x_error_catcher. */
7961 static int
7962 x_error_handler (display, error)
7963 Display *display;
7964 XErrorEvent *error;
7966 if (x_error_message)
7967 x_error_catcher (display, error);
7968 else
7969 x_error_quitter (display, error);
7970 return 0;
7973 /* This is the usual handler for X protocol errors.
7974 It kills all frames on the display that we got the error for.
7975 If that was the only one, it prints an error message and kills Emacs. */
7977 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7979 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7980 #define NO_INLINE __attribute__((noinline))
7981 #else
7982 #define NO_INLINE
7983 #endif
7985 /* Some versions of GNU/Linux define noinline in their headers. */
7987 #ifdef noinline
7988 #undef noinline
7989 #endif
7991 /* On older GCC versions, just putting x_error_quitter
7992 after x_error_handler prevents inlining into the former. */
7994 static void NO_INLINE
7995 x_error_quitter (display, error)
7996 Display *display;
7997 XErrorEvent *error;
7999 char buf[256], buf1[356];
8001 /* Ignore BadName errors. They can happen because of fonts
8002 or colors that are not defined. */
8004 if (error->error_code == BadName)
8005 return;
8007 /* Note that there is no real way portable across R3/R4 to get the
8008 original error handler. */
8010 XGetErrorText (display, error->error_code, buf, sizeof (buf));
8011 sprintf (buf1, "X protocol error: %s on protocol request %d",
8012 buf, error->request_code);
8013 x_connection_closed (display, buf1);
8017 /* This is the handler for X IO errors, always.
8018 It kills all frames on the display that we lost touch with.
8019 If that was the only one, it prints an error message and kills Emacs. */
8021 static int
8022 x_io_error_quitter (display)
8023 Display *display;
8025 char buf[256];
8027 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
8028 x_connection_closed (display, buf);
8029 return 0;
8032 /* Changing the font of the frame. */
8034 /* Give frame F the font FONT-OBJECT as its default font. The return
8035 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
8036 frame. If it is negative, generate a new fontset from
8037 FONT-OBJECT. */
8039 Lisp_Object
8040 x_new_font (f, font_object, fontset)
8041 struct frame *f;
8042 Lisp_Object font_object;
8043 int fontset;
8045 struct font *font = XFONT_OBJECT (font_object);
8047 if (fontset < 0)
8048 fontset = fontset_from_font (font_object);
8049 FRAME_FONTSET (f) = fontset;
8050 if (FRAME_FONT (f) == font)
8051 /* This font is already set in frame F. There's nothing more to
8052 do. */
8053 return font_object;
8055 FRAME_FONT (f) = font;
8056 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
8057 FRAME_COLUMN_WIDTH (f) = font->average_width;
8058 FRAME_SPACE_WIDTH (f) = font->space_width;
8059 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
8061 compute_fringe_widths (f, 1);
8063 /* Compute the scroll bar width in character columns. */
8064 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
8066 int wid = FRAME_COLUMN_WIDTH (f);
8067 FRAME_CONFIG_SCROLL_BAR_COLS (f)
8068 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
8070 else
8072 int wid = FRAME_COLUMN_WIDTH (f);
8073 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
8076 if (FRAME_X_WINDOW (f) != 0)
8078 /* Don't change the size of a tip frame; there's no point in
8079 doing it because it's done in Fx_show_tip, and it leads to
8080 problems because the tip frame has no widget. */
8081 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8082 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
8085 #ifdef HAVE_X_I18N
8086 if (FRAME_XIC (f)
8087 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
8089 BLOCK_INPUT;
8090 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
8091 UNBLOCK_INPUT;
8093 #endif
8095 return font_object;
8099 /***********************************************************************
8100 X Input Methods
8101 ***********************************************************************/
8103 #ifdef HAVE_X_I18N
8105 #ifdef HAVE_X11R6
8107 /* XIM destroy callback function, which is called whenever the
8108 connection to input method XIM dies. CLIENT_DATA contains a
8109 pointer to the x_display_info structure corresponding to XIM. */
8111 static void
8112 xim_destroy_callback (xim, client_data, call_data)
8113 XIM xim;
8114 XPointer client_data;
8115 XPointer call_data;
8117 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8118 Lisp_Object frame, tail;
8120 BLOCK_INPUT;
8122 /* No need to call XDestroyIC.. */
8123 FOR_EACH_FRAME (tail, frame)
8125 struct frame *f = XFRAME (frame);
8126 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8128 FRAME_XIC (f) = NULL;
8129 xic_free_xfontset (f);
8133 /* No need to call XCloseIM. */
8134 dpyinfo->xim = NULL;
8135 XFree (dpyinfo->xim_styles);
8136 UNBLOCK_INPUT;
8139 #endif /* HAVE_X11R6 */
8141 #ifdef HAVE_X11R6
8142 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8143 extern char *XSetIMValues P_ ((XIM, ...));
8144 #endif
8146 /* Open the connection to the XIM server on display DPYINFO.
8147 RESOURCE_NAME is the resource name Emacs uses. */
8149 static void
8150 xim_open_dpy (dpyinfo, resource_name)
8151 struct x_display_info *dpyinfo;
8152 char *resource_name;
8154 XIM xim;
8156 #ifdef HAVE_XIM
8157 if (use_xim)
8159 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8160 EMACS_CLASS);
8161 dpyinfo->xim = xim;
8163 if (xim)
8165 #ifdef HAVE_X11R6
8166 XIMCallback destroy;
8167 #endif
8169 /* Get supported styles and XIM values. */
8170 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8172 #ifdef HAVE_X11R6
8173 destroy.callback = xim_destroy_callback;
8174 destroy.client_data = (XPointer)dpyinfo;
8175 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8176 #endif
8180 else
8181 #endif /* HAVE_XIM */
8182 dpyinfo->xim = NULL;
8186 #ifdef HAVE_X11R6_XIM
8188 struct xim_inst_t
8190 struct x_display_info *dpyinfo;
8191 char *resource_name;
8194 /* XIM instantiate callback function, which is called whenever an XIM
8195 server is available. DISPLAY is the display of the XIM.
8196 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8197 when the callback was registered. */
8199 static void
8200 xim_instantiate_callback (display, client_data, call_data)
8201 Display *display;
8202 XPointer client_data;
8203 XPointer call_data;
8205 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8206 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8208 /* We don't support multiple XIM connections. */
8209 if (dpyinfo->xim)
8210 return;
8212 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8214 /* Create XIC for the existing frames on the same display, as long
8215 as they have no XIC. */
8216 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8218 Lisp_Object tail, frame;
8220 BLOCK_INPUT;
8221 FOR_EACH_FRAME (tail, frame)
8223 struct frame *f = XFRAME (frame);
8225 if (FRAME_X_P (f)
8226 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8227 if (FRAME_XIC (f) == NULL)
8229 create_frame_xic (f);
8230 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8231 xic_set_statusarea (f);
8232 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8234 struct window *w = XWINDOW (f->selected_window);
8235 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8240 UNBLOCK_INPUT;
8244 #endif /* HAVE_X11R6_XIM */
8247 /* Open a connection to the XIM server on display DPYINFO.
8248 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8249 connection only at the first time. On X11R6, open the connection
8250 in the XIM instantiate callback function. */
8252 static void
8253 xim_initialize (dpyinfo, resource_name)
8254 struct x_display_info *dpyinfo;
8255 char *resource_name;
8257 #ifdef HAVE_XIM
8258 if (use_xim)
8260 #ifdef HAVE_X11R6_XIM
8261 struct xim_inst_t *xim_inst;
8262 int len;
8264 dpyinfo->xim = NULL;
8265 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8266 xim_inst->dpyinfo = dpyinfo;
8267 len = strlen (resource_name);
8268 xim_inst->resource_name = (char *) xmalloc (len + 1);
8269 bcopy (resource_name, xim_inst->resource_name, len + 1);
8270 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8271 resource_name, EMACS_CLASS,
8272 xim_instantiate_callback,
8273 /* This is XPointer in XFree86
8274 but (XPointer *) on Tru64, at
8275 least, hence the configure test. */
8276 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8277 #else /* not HAVE_X11R6_XIM */
8278 dpyinfo->xim = NULL;
8279 xim_open_dpy (dpyinfo, resource_name);
8280 #endif /* not HAVE_X11R6_XIM */
8283 else
8284 #endif /* HAVE_XIM */
8285 dpyinfo->xim = NULL;
8289 /* Close the connection to the XIM server on display DPYINFO. */
8291 static void
8292 xim_close_dpy (dpyinfo)
8293 struct x_display_info *dpyinfo;
8295 #ifdef HAVE_XIM
8296 if (use_xim)
8298 #ifdef HAVE_X11R6_XIM
8299 if (dpyinfo->display)
8300 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8301 NULL, EMACS_CLASS,
8302 xim_instantiate_callback, NULL);
8303 #endif /* not HAVE_X11R6_XIM */
8304 if (dpyinfo->display)
8305 XCloseIM (dpyinfo->xim);
8306 dpyinfo->xim = NULL;
8307 XFree (dpyinfo->xim_styles);
8309 #endif /* HAVE_XIM */
8312 #endif /* not HAVE_X11R6_XIM */
8316 /* Calculate the absolute position in frame F
8317 from its current recorded position values and gravity. */
8319 void
8320 x_calc_absolute_position (f)
8321 struct frame *f;
8323 int flags = f->size_hint_flags;
8325 /* We have nothing to do if the current position
8326 is already for the top-left corner. */
8327 if (! ((flags & XNegative) || (flags & YNegative)))
8328 return;
8330 /* Treat negative positions as relative to the leftmost bottommost
8331 position that fits on the screen. */
8332 if (flags & XNegative)
8333 f->left_pos = (FRAME_X_DISPLAY_INFO (f)->width
8334 - FRAME_PIXEL_WIDTH (f) + f->left_pos);
8337 int height = FRAME_PIXEL_HEIGHT (f);
8339 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8340 /* Something is fishy here. When using Motif, starting Emacs with
8341 `-g -0-0', the frame appears too low by a few pixels.
8343 This seems to be so because initially, while Emacs is starting,
8344 the column widget's height and the frame's pixel height are
8345 different. The column widget's height is the right one. In
8346 later invocations, when Emacs is up, the frame's pixel height
8347 is right, though.
8349 It's not obvious where the initial small difference comes from.
8350 2000-12-01, gerd. */
8352 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8353 #endif
8355 if (flags & YNegative)
8356 f->top_pos = (FRAME_X_DISPLAY_INFO (f)->height - height + f->top_pos);
8359 /* The left_pos and top_pos
8360 are now relative to the top and left screen edges,
8361 so the flags should correspond. */
8362 f->size_hint_flags &= ~ (XNegative | YNegative);
8365 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8366 to really change the position, and 0 when calling from
8367 x_make_frame_visible (in that case, XOFF and YOFF are the current
8368 position values). It is -1 when calling from x_set_frame_parameters,
8369 which means, do adjust for borders but don't change the gravity. */
8371 void
8372 x_set_offset (f, xoff, yoff, change_gravity)
8373 struct frame *f;
8374 register int xoff, yoff;
8375 int change_gravity;
8377 int modified_top, modified_left;
8379 if (change_gravity > 0)
8381 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8382 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8384 f->top_pos = yoff;
8385 f->left_pos = xoff;
8386 f->size_hint_flags &= ~ (XNegative | YNegative);
8387 if (xoff < 0)
8388 f->size_hint_flags |= XNegative;
8389 if (yoff < 0)
8390 f->size_hint_flags |= YNegative;
8391 f->win_gravity = NorthWestGravity;
8393 x_calc_absolute_position (f);
8395 BLOCK_INPUT;
8396 x_wm_set_size_hint (f, (long) 0, 0);
8398 modified_left = f->left_pos;
8399 modified_top = f->top_pos;
8401 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8403 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8404 than the WM decorations. So we use the calculated offset instead
8405 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8406 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8407 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8410 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8411 modified_left, modified_top);
8413 x_sync_with_move (f, f->left_pos, f->top_pos,
8414 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8415 ? 1 : 0);
8417 /* change_gravity is non-zero when this function is called from Lisp to
8418 programmatically move a frame. In that case, we call
8419 x_check_expected_move to discover if we have a "Type A" or "Type B"
8420 window manager, and, for a "Type A" window manager, adjust the position
8421 of the frame.
8423 We call x_check_expected_move if a programmatic move occurred, and
8424 either the window manager type (A/B) is unknown or it is Type A but we
8425 need to compute the top/left offset adjustment for this frame. */
8427 if (change_gravity != 0 &&
8428 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8429 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8430 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8431 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8432 x_check_expected_move (f, modified_left, modified_top);
8434 UNBLOCK_INPUT;
8437 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8438 on the root window for frame F contains ATOMNAME.
8439 This is how a WM check shall be done according to the Window Manager
8440 Specification/Extended Window Manager Hints at
8441 http://freedesktop.org/wiki/Specifications/wm-spec. */
8443 static int
8444 wm_supports (f, atomname)
8445 struct frame *f;
8446 const char *atomname;
8448 Atom actual_type;
8449 unsigned long actual_size, bytes_remaining;
8450 int i, rc, actual_format;
8451 Atom prop_atom;
8452 Window wmcheck_window;
8453 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8454 Window target_window = dpyinfo->root_window;
8455 long max_len = 65536;
8456 Display *dpy = FRAME_X_DISPLAY (f);
8457 unsigned char *tmp_data = NULL;
8458 Atom target_type = XA_WINDOW;
8459 Atom want_atom;
8461 BLOCK_INPUT;
8463 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8465 x_catch_errors (dpy);
8466 rc = XGetWindowProperty (dpy, target_window,
8467 prop_atom, 0, max_len, False, target_type,
8468 &actual_type, &actual_format, &actual_size,
8469 &bytes_remaining, &tmp_data);
8471 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8473 if (tmp_data) XFree (tmp_data);
8474 x_uncatch_errors ();
8475 UNBLOCK_INPUT;
8476 return 0;
8479 wmcheck_window = *(Window *) tmp_data;
8480 XFree (tmp_data);
8482 /* Check if window exists. */
8483 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8484 x_sync (f);
8485 if (x_had_errors_p (dpy))
8487 x_uncatch_errors ();
8488 UNBLOCK_INPUT;
8489 return 0;
8492 if (dpyinfo->net_supported_window != wmcheck_window)
8494 /* Window changed, reload atoms */
8495 if (dpyinfo->net_supported_atoms != NULL)
8496 XFree (dpyinfo->net_supported_atoms);
8497 dpyinfo->net_supported_atoms = NULL;
8498 dpyinfo->nr_net_supported_atoms = 0;
8499 dpyinfo->net_supported_window = 0;
8501 target_type = XA_ATOM;
8502 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8503 tmp_data = NULL;
8504 rc = XGetWindowProperty (dpy, target_window,
8505 prop_atom, 0, max_len, False, target_type,
8506 &actual_type, &actual_format, &actual_size,
8507 &bytes_remaining, &tmp_data);
8509 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8511 if (tmp_data) XFree (tmp_data);
8512 x_uncatch_errors ();
8513 UNBLOCK_INPUT;
8514 return 0;
8517 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8518 dpyinfo->nr_net_supported_atoms = actual_size;
8519 dpyinfo->net_supported_window = wmcheck_window;
8522 rc = 0;
8523 want_atom = XInternAtom (dpy, atomname, False);
8525 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8526 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8528 x_uncatch_errors ();
8529 UNBLOCK_INPUT;
8531 return rc;
8534 /* Do fullscreen as specified in extended window manager hints */
8536 static int
8537 do_ewmh_fullscreen (f)
8538 struct frame *f;
8540 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8542 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8543 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8544 if (!have_net_atom)
8545 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8547 if (have_net_atom)
8549 Lisp_Object frame;
8550 const char *atom = "_NET_WM_STATE";
8551 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8552 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8553 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8554 const char *what = NULL;
8556 XSETFRAME (frame, f);
8558 /* If there are _NET_ atoms we assume we have extended window manager
8559 hints. */
8560 switch (f->want_fullscreen)
8562 case FULLSCREEN_BOTH:
8563 what = fs;
8564 break;
8565 case FULLSCREEN_WIDTH:
8566 what = fw;
8567 break;
8568 case FULLSCREEN_HEIGHT:
8569 what = fh;
8570 break;
8573 if (what != NULL && !wm_supports (f, what)) return 0;
8576 Fx_send_client_event (frame, make_number (0), frame,
8577 make_unibyte_string (atom, strlen (atom)),
8578 make_number (32),
8579 Fcons (make_number (0), /* Remove */
8580 Fcons
8581 (make_unibyte_string (fs,
8582 strlen (fs)),
8583 Qnil)));
8584 Fx_send_client_event (frame, make_number (0), frame,
8585 make_unibyte_string (atom, strlen (atom)),
8586 make_number (32),
8587 Fcons (make_number (0), /* Remove */
8588 Fcons
8589 (make_unibyte_string (fh,
8590 strlen (fh)),
8591 Qnil)));
8592 Fx_send_client_event (frame, make_number (0), frame,
8593 make_unibyte_string (atom, strlen (atom)),
8594 make_number (32),
8595 Fcons (make_number (0), /* Remove */
8596 Fcons
8597 (make_unibyte_string (fw,
8598 strlen (fw)),
8599 Qnil)));
8600 f->want_fullscreen = FULLSCREEN_NONE;
8601 if (what != NULL)
8602 Fx_send_client_event (frame, make_number (0), frame,
8603 make_unibyte_string (atom, strlen (atom)),
8604 make_number (32),
8605 Fcons (make_number (1), /* Add */
8606 Fcons
8607 (make_unibyte_string (what,
8608 strlen (what)),
8609 Qnil)));
8612 return have_net_atom;
8615 static void
8616 XTfullscreen_hook (f)
8617 FRAME_PTR f;
8619 if (f->async_visible)
8621 BLOCK_INPUT;
8622 do_ewmh_fullscreen (f);
8623 x_sync (f);
8624 UNBLOCK_INPUT;
8629 /* Check if we need to resize the frame due to a fullscreen request.
8630 If so needed, resize the frame. */
8631 static void
8632 x_check_fullscreen (f)
8633 struct frame *f;
8635 if (f->want_fullscreen & FULLSCREEN_BOTH)
8637 int width, height, ign;
8639 if (do_ewmh_fullscreen (f))
8640 return;
8642 x_real_positions (f, &f->left_pos, &f->top_pos);
8644 x_fullscreen_adjust (f, &width, &height, &ign, &ign);
8646 /* We do not need to move the window, it shall be taken care of
8647 when setting WM manager hints.
8648 If the frame is visible already, the position is checked by
8649 x_check_expected_move. */
8650 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8652 change_frame_size (f, height, width, 0, 1, 0);
8653 SET_FRAME_GARBAGED (f);
8654 cancel_mouse_face (f);
8656 /* Wait for the change of frame size to occur */
8657 f->want_fullscreen |= FULLSCREEN_WAIT;
8662 /* This function is called by x_set_offset to determine whether the window
8663 manager interfered with the positioning of the frame. Type A window
8664 managers position the surrounding window manager decorations a small
8665 amount above and left of the user-supplied position. Type B window
8666 managers position the surrounding window manager decorations at the
8667 user-specified position. If we detect a Type A window manager, we
8668 compensate by moving the window right and down by the proper amount. */
8670 static void
8671 x_check_expected_move (f, expected_left, expected_top)
8672 struct frame *f;
8673 int expected_left;
8674 int expected_top;
8676 int current_left = 0, current_top = 0;
8678 /* x_real_positions returns the left and top offsets of the outermost
8679 window manager window around the frame. */
8681 x_real_positions (f, &current_left, &current_top);
8683 if (current_left != expected_left || current_top != expected_top)
8685 /* It's a "Type A" window manager. */
8687 int adjusted_left;
8688 int adjusted_top;
8690 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8691 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8692 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8694 /* Now fix the mispositioned frame's location. */
8696 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8697 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8699 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8700 adjusted_left, adjusted_top);
8702 x_sync_with_move (f, expected_left, expected_top, 0);
8704 else
8705 /* It's a "Type B" window manager. We don't have to adjust the
8706 frame's position. */
8708 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8712 /* Wait for XGetGeometry to return up-to-date position information for a
8713 recently-moved frame. Call this immediately after calling XMoveWindow.
8714 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8715 frame has been moved to, so we use a fuzzy position comparison instead
8716 of an exact comparison. */
8718 static void
8719 x_sync_with_move (f, left, top, fuzzy)
8720 struct frame *f;
8721 int left, top, fuzzy;
8723 int count = 0;
8725 while (count++ < 50)
8727 int current_left = 0, current_top = 0;
8729 /* In theory, this call to XSync only needs to happen once, but in
8730 practice, it doesn't seem to work, hence the need for the surrounding
8731 loop. */
8733 XSync (FRAME_X_DISPLAY (f), False);
8734 x_real_positions (f, &current_left, &current_top);
8736 if (fuzzy)
8738 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8739 pixels. */
8741 if (eabs (current_left - left) <= 10
8742 && eabs (current_top - top) <= 40)
8743 return;
8745 else if (current_left == left && current_top == top)
8746 return;
8749 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8750 will then return up-to-date position info. */
8752 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8756 /* Change the size of frame F's X window to COLS/ROWS in the case F
8757 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8758 top-left-corner window gravity for this size change and subsequent
8759 size changes. Otherwise we leave the window gravity unchanged. */
8761 static void
8762 x_set_window_size_1 (f, change_gravity, cols, rows)
8763 struct frame *f;
8764 int change_gravity;
8765 int cols, rows;
8767 int pixelwidth, pixelheight;
8769 check_frame_size (f, &rows, &cols);
8770 f->scroll_bar_actual_width
8771 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8773 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8774 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8775 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8777 compute_fringe_widths (f, 0);
8779 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8780 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
8782 f->win_gravity = NorthWestGravity;
8783 x_wm_set_size_hint (f, (long) 0, 0);
8785 XSync (FRAME_X_DISPLAY (f), False);
8786 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8787 pixelwidth, pixelheight);
8789 /* Now, strictly speaking, we can't be sure that this is accurate,
8790 but the window manager will get around to dealing with the size
8791 change request eventually, and we'll hear how it went when the
8792 ConfigureNotify event gets here.
8794 We could just not bother storing any of this information here,
8795 and let the ConfigureNotify event set everything up, but that
8796 might be kind of confusing to the Lisp code, since size changes
8797 wouldn't be reported in the frame parameters until some random
8798 point in the future when the ConfigureNotify event arrives.
8800 We pass 1 for DELAY since we can't run Lisp code inside of
8801 a BLOCK_INPUT. */
8802 change_frame_size (f, rows, cols, 0, 1, 0);
8803 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8804 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8806 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8807 receive in the ConfigureNotify event; if we get what we asked
8808 for, then the event won't cause the screen to become garbaged, so
8809 we have to make sure to do it here. */
8810 SET_FRAME_GARBAGED (f);
8812 XFlush (FRAME_X_DISPLAY (f));
8816 /* Call this to change the size of frame F's x-window.
8817 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8818 for this size change and subsequent size changes.
8819 Otherwise we leave the window gravity unchanged. */
8821 void
8822 x_set_window_size (f, change_gravity, cols, rows)
8823 struct frame *f;
8824 int change_gravity;
8825 int cols, rows;
8827 BLOCK_INPUT;
8829 #ifdef USE_GTK
8830 if (FRAME_GTK_WIDGET (f))
8831 xg_frame_set_char_size (f, cols, rows);
8832 else
8833 x_set_window_size_1 (f, change_gravity, cols, rows);
8834 #elif USE_X_TOOLKIT
8836 if (f->output_data.x->widget != NULL)
8838 /* The x and y position of the widget is clobbered by the
8839 call to XtSetValues within EmacsFrameSetCharSize.
8840 This is a real kludge, but I don't understand Xt so I can't
8841 figure out a correct fix. Can anyone else tell me? -- rms. */
8842 int xpos = f->output_data.x->widget->core.x;
8843 int ypos = f->output_data.x->widget->core.y;
8844 EmacsFrameSetCharSize (f->output_data.x->edit_widget, cols, rows);
8845 f->output_data.x->widget->core.x = xpos;
8846 f->output_data.x->widget->core.y = ypos;
8848 else
8849 x_set_window_size_1 (f, change_gravity, cols, rows);
8851 #else /* not USE_X_TOOLKIT */
8853 x_set_window_size_1 (f, change_gravity, cols, rows);
8855 #endif /* not USE_X_TOOLKIT */
8857 /* If cursor was outside the new size, mark it as off. */
8858 mark_window_cursors_off (XWINDOW (f->root_window));
8860 /* Clear out any recollection of where the mouse highlighting was,
8861 since it might be in a place that's outside the new frame size.
8862 Actually checking whether it is outside is a pain in the neck,
8863 so don't try--just let the highlighting be done afresh with new size. */
8864 cancel_mouse_face (f);
8866 UNBLOCK_INPUT;
8869 /* Mouse warping. */
8871 void
8872 x_set_mouse_position (f, x, y)
8873 struct frame *f;
8874 int x, y;
8876 int pix_x, pix_y;
8878 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8879 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8881 if (pix_x < 0) pix_x = 0;
8882 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8884 if (pix_y < 0) pix_y = 0;
8885 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8887 BLOCK_INPUT;
8889 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8890 0, 0, 0, 0, pix_x, pix_y);
8891 UNBLOCK_INPUT;
8894 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8896 void
8897 x_set_mouse_pixel_position (f, pix_x, pix_y)
8898 struct frame *f;
8899 int pix_x, pix_y;
8901 BLOCK_INPUT;
8903 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8904 0, 0, 0, 0, pix_x, pix_y);
8905 UNBLOCK_INPUT;
8908 /* focus shifting, raising and lowering. */
8910 void
8911 x_focus_on_frame (f)
8912 struct frame *f;
8914 #if 0 /* This proves to be unpleasant. */
8915 x_raise_frame (f);
8916 #endif
8917 #if 0
8918 /* I don't think that the ICCCM allows programs to do things like this
8919 without the interaction of the window manager. Whatever you end up
8920 doing with this code, do it to x_unfocus_frame too. */
8921 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8922 RevertToPointerRoot, CurrentTime);
8923 #endif /* ! 0 */
8926 void
8927 x_unfocus_frame (f)
8928 struct frame *f;
8930 #if 0
8931 /* Look at the remarks in x_focus_on_frame. */
8932 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8933 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8934 RevertToPointerRoot, CurrentTime);
8935 #endif /* ! 0 */
8938 /* Raise frame F. */
8940 void
8941 x_raise_frame (f)
8942 struct frame *f;
8944 BLOCK_INPUT;
8945 if (f->async_visible)
8946 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8948 XFlush (FRAME_X_DISPLAY (f));
8949 UNBLOCK_INPUT;
8952 /* Lower frame F. */
8954 void
8955 x_lower_frame (f)
8956 struct frame *f;
8958 if (f->async_visible)
8960 BLOCK_INPUT;
8961 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8962 XFlush (FRAME_X_DISPLAY (f));
8963 UNBLOCK_INPUT;
8967 /* Activate frame with Extended Window Manager Hints */
8969 void
8970 x_ewmh_activate_frame (f)
8971 FRAME_PTR f;
8973 /* See Window Manager Specification/Extended Window Manager Hints at
8974 http://freedesktop.org/wiki/Specifications/wm-spec */
8976 const char *atom = "_NET_ACTIVE_WINDOW";
8977 if (f->async_visible && wm_supports (f, atom))
8979 Lisp_Object frame;
8980 XSETFRAME (frame, f);
8981 Fx_send_client_event (frame, make_number (0), frame,
8982 make_unibyte_string (atom, strlen (atom)),
8983 make_number (32),
8984 Fcons (make_number (1),
8985 Fcons (make_number (last_user_time),
8986 Qnil)));
8990 static void
8991 XTframe_raise_lower (f, raise_flag)
8992 FRAME_PTR f;
8993 int raise_flag;
8995 if (raise_flag)
8996 x_raise_frame (f);
8997 else
8998 x_lower_frame (f);
9001 /* XEmbed implementation. */
9003 void
9004 xembed_set_info (f, flags)
9005 struct frame *f;
9006 enum xembed_info flags;
9008 Atom atom;
9009 unsigned long data[2];
9011 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
9013 data[0] = XEMBED_VERSION;
9014 data[1] = flags;
9016 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
9017 32, PropModeReplace, (unsigned char *) data, 2);
9020 void
9021 xembed_send_message (f, time, message, detail, data1, data2)
9022 struct frame *f;
9023 Time time;
9024 enum xembed_message message;
9025 long detail;
9026 long data1;
9027 long data2;
9029 XEvent event;
9031 event.xclient.type = ClientMessage;
9032 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9033 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9034 event.xclient.format = 32;
9035 event.xclient.data.l[0] = time;
9036 event.xclient.data.l[1] = message;
9037 event.xclient.data.l[2] = detail;
9038 event.xclient.data.l[3] = data1;
9039 event.xclient.data.l[4] = data2;
9041 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9042 False, NoEventMask, &event);
9043 XSync (FRAME_X_DISPLAY (f), False);
9046 /* Change of visibility. */
9048 /* This tries to wait until the frame is really visible.
9049 However, if the window manager asks the user where to position
9050 the frame, this will return before the user finishes doing that.
9051 The frame will not actually be visible at that time,
9052 but it will become visible later when the window manager
9053 finishes with it. */
9055 void
9056 x_make_frame_visible (f)
9057 struct frame *f;
9059 Lisp_Object type;
9060 int original_top, original_left;
9061 int retry_count = 2;
9063 retry:
9065 BLOCK_INPUT;
9067 type = x_icon_type (f);
9068 if (!NILP (type))
9069 x_bitmap_icon (f, type);
9071 if (! FRAME_VISIBLE_P (f))
9073 /* We test FRAME_GARBAGED_P here to make sure we don't
9074 call x_set_offset a second time
9075 if we get to x_make_frame_visible a second time
9076 before the window gets really visible. */
9077 if (! FRAME_ICONIFIED_P (f)
9078 && ! FRAME_X_EMBEDDED_P (f)
9079 && ! f->output_data.x->asked_for_visible)
9080 x_set_offset (f, f->left_pos, f->top_pos, 0);
9082 f->output_data.x->asked_for_visible = 1;
9084 if (! EQ (Vx_no_window_manager, Qt))
9085 x_wm_set_window_state (f, NormalState);
9086 #ifdef USE_X_TOOLKIT
9087 if (FRAME_X_EMBEDDED_P (f))
9088 xembed_set_info (f, XEMBED_MAPPED);
9089 else
9091 /* This was XtPopup, but that did nothing for an iconified frame. */
9092 XtMapWidget (f->output_data.x->widget);
9094 #else /* not USE_X_TOOLKIT */
9095 #ifdef USE_GTK
9096 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9097 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9098 #else
9099 if (FRAME_X_EMBEDDED_P (f))
9100 xembed_set_info (f, XEMBED_MAPPED);
9101 else
9102 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9103 #endif /* not USE_GTK */
9104 #endif /* not USE_X_TOOLKIT */
9105 #if 0 /* This seems to bring back scroll bars in the wrong places
9106 if the window configuration has changed. They seem
9107 to come back ok without this. */
9108 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
9109 XMapSubwindows (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9110 #endif
9113 XFlush (FRAME_X_DISPLAY (f));
9115 /* Synchronize to ensure Emacs knows the frame is visible
9116 before we do anything else. We do this loop with input not blocked
9117 so that incoming events are handled. */
9119 Lisp_Object frame;
9120 int count;
9121 /* This must be before UNBLOCK_INPUT
9122 since events that arrive in response to the actions above
9123 will set it when they are handled. */
9124 int previously_visible = f->output_data.x->has_been_visible;
9126 original_left = f->left_pos;
9127 original_top = f->top_pos;
9129 /* This must come after we set COUNT. */
9130 UNBLOCK_INPUT;
9132 /* We unblock here so that arriving X events are processed. */
9134 /* Now move the window back to where it was "supposed to be".
9135 But don't do it if the gravity is negative.
9136 When the gravity is negative, this uses a position
9137 that is 3 pixels too low. Perhaps that's really the border width.
9139 Don't do this if the window has never been visible before,
9140 because the window manager may choose the position
9141 and we don't want to override it. */
9143 if (! FRAME_VISIBLE_P (f)
9144 && ! FRAME_ICONIFIED_P (f)
9145 && ! FRAME_X_EMBEDDED_P (f)
9146 && f->win_gravity == NorthWestGravity
9147 && previously_visible)
9149 Drawable rootw;
9150 int x, y;
9151 unsigned int width, height, border, depth;
9153 BLOCK_INPUT;
9155 /* On some window managers (such as FVWM) moving an existing
9156 window, even to the same place, causes the window manager
9157 to introduce an offset. This can cause the window to move
9158 to an unexpected location. Check the geometry (a little
9159 slow here) and then verify that the window is in the right
9160 place. If the window is not in the right place, move it
9161 there, and take the potential window manager hit. */
9162 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9163 &rootw, &x, &y, &width, &height, &border, &depth);
9165 if (original_left != x || original_top != y)
9166 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9167 original_left, original_top);
9169 UNBLOCK_INPUT;
9172 XSETFRAME (frame, f);
9174 /* Wait until the frame is visible. Process X events until a
9175 MapNotify event has been seen, or until we think we won't get a
9176 MapNotify at all.. */
9177 for (count = input_signal_count + 10;
9178 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9180 /* Force processing of queued events. */
9181 x_sync (f);
9183 /* Machines that do polling rather than SIGIO have been
9184 observed to go into a busy-wait here. So we'll fake an
9185 alarm signal to let the handler know that there's something
9186 to be read. We used to raise a real alarm, but it seems
9187 that the handler isn't always enabled here. This is
9188 probably a bug. */
9189 if (input_polling_used ())
9191 /* It could be confusing if a real alarm arrives while
9192 processing the fake one. Turn it off and let the
9193 handler reset it. */
9194 extern void poll_for_input_1 P_ ((void));
9195 int old_poll_suppress_count = poll_suppress_count;
9196 poll_suppress_count = 1;
9197 poll_for_input_1 ();
9198 poll_suppress_count = old_poll_suppress_count;
9201 /* See if a MapNotify event has been processed. */
9202 FRAME_SAMPLE_VISIBILITY (f);
9205 /* 2000-09-28: In
9207 (let ((f (selected-frame)))
9208 (iconify-frame f)
9209 (raise-frame f))
9211 the frame is not raised with various window managers on
9212 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9213 unknown reason, the call to XtMapWidget is completely ignored.
9214 Mapping the widget a second time works. */
9216 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9217 goto retry;
9221 /* Change from mapped state to withdrawn state. */
9223 /* Make the frame visible (mapped and not iconified). */
9225 void
9226 x_make_frame_invisible (f)
9227 struct frame *f;
9229 Window window;
9231 /* Use the frame's outermost window, not the one we normally draw on. */
9232 window = FRAME_OUTER_WINDOW (f);
9234 /* Don't keep the highlight on an invisible frame. */
9235 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9236 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9238 #if 0/* This might add unreliability; I don't trust it -- rms. */
9239 if (! f->async_visible && ! f->async_iconified)
9240 return;
9241 #endif
9243 BLOCK_INPUT;
9245 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9246 that the current position of the window is user-specified, rather than
9247 program-specified, so that when the window is mapped again, it will be
9248 placed at the same location, without forcing the user to position it
9249 by hand again (they have already done that once for this window.) */
9250 x_wm_set_size_hint (f, (long) 0, 1);
9252 #ifdef USE_GTK
9253 if (FRAME_GTK_OUTER_WIDGET (f))
9254 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9255 else
9256 #else
9257 if (FRAME_X_EMBEDDED_P (f))
9258 xembed_set_info (f, 0);
9259 else
9260 #endif
9263 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9264 DefaultScreen (FRAME_X_DISPLAY (f))))
9266 UNBLOCK_INPUT_RESIGNAL;
9267 error ("Can't notify window manager of window withdrawal");
9271 /* We can't distinguish this from iconification
9272 just by the event that we get from the server.
9273 So we can't win using the usual strategy of letting
9274 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9275 and synchronize with the server to make sure we agree. */
9276 f->visible = 0;
9277 FRAME_ICONIFIED_P (f) = 0;
9278 f->async_visible = 0;
9279 f->async_iconified = 0;
9281 x_sync (f);
9283 UNBLOCK_INPUT;
9286 /* Change window state from mapped to iconified. */
9288 void
9289 x_iconify_frame (f)
9290 struct frame *f;
9292 int result;
9293 Lisp_Object type;
9295 /* Don't keep the highlight on an invisible frame. */
9296 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9297 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9299 if (f->async_iconified)
9300 return;
9302 BLOCK_INPUT;
9304 FRAME_SAMPLE_VISIBILITY (f);
9306 type = x_icon_type (f);
9307 if (!NILP (type))
9308 x_bitmap_icon (f, type);
9310 #ifdef USE_GTK
9311 if (FRAME_GTK_OUTER_WIDGET (f))
9313 if (! FRAME_VISIBLE_P (f))
9314 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9316 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9317 f->iconified = 1;
9318 f->visible = 1;
9319 f->async_iconified = 1;
9320 f->async_visible = 0;
9321 UNBLOCK_INPUT;
9322 return;
9324 #endif
9326 #ifdef USE_X_TOOLKIT
9328 if (! FRAME_VISIBLE_P (f))
9330 if (! EQ (Vx_no_window_manager, Qt))
9331 x_wm_set_window_state (f, IconicState);
9332 /* This was XtPopup, but that did nothing for an iconified frame. */
9333 XtMapWidget (f->output_data.x->widget);
9334 /* The server won't give us any event to indicate
9335 that an invisible frame was changed to an icon,
9336 so we have to record it here. */
9337 f->iconified = 1;
9338 f->visible = 1;
9339 f->async_iconified = 1;
9340 f->async_visible = 0;
9341 UNBLOCK_INPUT;
9342 return;
9345 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9346 XtWindow (f->output_data.x->widget),
9347 DefaultScreen (FRAME_X_DISPLAY (f)));
9348 UNBLOCK_INPUT;
9350 if (!result)
9351 error ("Can't notify window manager of iconification");
9353 f->async_iconified = 1;
9354 f->async_visible = 0;
9357 BLOCK_INPUT;
9358 XFlush (FRAME_X_DISPLAY (f));
9359 UNBLOCK_INPUT;
9360 #else /* not USE_X_TOOLKIT */
9362 /* Make sure the X server knows where the window should be positioned,
9363 in case the user deiconifies with the window manager. */
9364 if (! FRAME_VISIBLE_P (f)
9365 && ! FRAME_ICONIFIED_P (f)
9366 && ! FRAME_X_EMBEDDED_P (f))
9367 x_set_offset (f, f->left_pos, f->top_pos, 0);
9369 /* Since we don't know which revision of X we're running, we'll use both
9370 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9372 /* X11R4: send a ClientMessage to the window manager using the
9373 WM_CHANGE_STATE type. */
9375 XEvent message;
9377 message.xclient.window = FRAME_X_WINDOW (f);
9378 message.xclient.type = ClientMessage;
9379 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9380 message.xclient.format = 32;
9381 message.xclient.data.l[0] = IconicState;
9383 if (! XSendEvent (FRAME_X_DISPLAY (f),
9384 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9385 False,
9386 SubstructureRedirectMask | SubstructureNotifyMask,
9387 &message))
9389 UNBLOCK_INPUT_RESIGNAL;
9390 error ("Can't notify window manager of iconification");
9394 /* X11R3: set the initial_state field of the window manager hints to
9395 IconicState. */
9396 x_wm_set_window_state (f, IconicState);
9398 if (!FRAME_VISIBLE_P (f))
9400 /* If the frame was withdrawn, before, we must map it. */
9401 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9404 f->async_iconified = 1;
9405 f->async_visible = 0;
9407 XFlush (FRAME_X_DISPLAY (f));
9408 UNBLOCK_INPUT;
9409 #endif /* not USE_X_TOOLKIT */
9413 /* Free X resources of frame F. */
9415 void
9416 x_free_frame_resources (f)
9417 struct frame *f;
9419 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9420 Lisp_Object bar;
9421 struct scroll_bar *b;
9423 BLOCK_INPUT;
9425 /* If a display connection is dead, don't try sending more
9426 commands to the X server. */
9427 if (dpyinfo->display)
9429 /* We must free faces before destroying windows because some
9430 font-driver (e.g. xft) access a window while finishing a
9431 face. */
9432 if (FRAME_FACE_CACHE (f))
9433 free_frame_faces (f);
9435 if (f->output_data.x->icon_desc)
9436 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9438 #ifdef USE_X_TOOLKIT
9439 /* Explicitly destroy the scroll bars of the frame. Without
9440 this, we get "BadDrawable" errors from the toolkit later on,
9441 presumably from expose events generated for the disappearing
9442 toolkit scroll bars. */
9443 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9445 b = XSCROLL_BAR (bar);
9446 x_scroll_bar_remove (b);
9448 #endif
9450 #ifdef HAVE_X_I18N
9451 if (FRAME_XIC (f))
9452 free_frame_xic (f);
9453 #endif
9455 #ifdef USE_X_TOOLKIT
9456 if (f->output_data.x->widget)
9458 XtDestroyWidget (f->output_data.x->widget);
9459 f->output_data.x->widget = NULL;
9461 /* Tooltips don't have widgets, only a simple X window, even if
9462 we are using a toolkit. */
9463 else if (FRAME_X_WINDOW (f))
9464 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9466 free_frame_menubar (f);
9467 #else /* !USE_X_TOOLKIT */
9469 #ifdef USE_GTK
9470 /* In the GTK version, tooltips are normal X
9471 frames. We must check and free both types. */
9472 if (FRAME_GTK_OUTER_WIDGET (f))
9474 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
9475 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
9476 FRAME_GTK_OUTER_WIDGET (f) = 0;
9478 #endif /* USE_GTK */
9480 if (FRAME_X_WINDOW (f))
9481 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9482 #endif /* !USE_X_TOOLKIT */
9484 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9485 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9486 unload_color (f, f->output_data.x->cursor_pixel);
9487 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9488 unload_color (f, f->output_data.x->border_pixel);
9489 unload_color (f, f->output_data.x->mouse_pixel);
9491 if (f->output_data.x->scroll_bar_background_pixel != -1)
9492 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9493 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9494 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9495 #ifdef USE_TOOLKIT_SCROLL_BARS
9496 /* Scrollbar shadow colors. */
9497 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9498 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9499 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9500 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9501 #endif /* USE_TOOLKIT_SCROLL_BARS */
9502 if (f->output_data.x->white_relief.allocated_p)
9503 unload_color (f, f->output_data.x->white_relief.pixel);
9504 if (f->output_data.x->black_relief.allocated_p)
9505 unload_color (f, f->output_data.x->black_relief.pixel);
9507 if (FRAME_FACE_CACHE (f))
9508 free_frame_faces (f);
9510 x_free_gcs (f);
9511 XFlush (FRAME_X_DISPLAY (f));
9514 if (f->output_data.x->saved_menu_event)
9515 xfree (f->output_data.x->saved_menu_event);
9517 xfree (f->output_data.x);
9518 f->output_data.x = NULL;
9520 if (f == dpyinfo->x_focus_frame)
9521 dpyinfo->x_focus_frame = 0;
9522 if (f == dpyinfo->x_focus_event_frame)
9523 dpyinfo->x_focus_event_frame = 0;
9524 if (f == dpyinfo->x_highlight_frame)
9525 dpyinfo->x_highlight_frame = 0;
9527 if (f == dpyinfo->mouse_face_mouse_frame)
9529 dpyinfo->mouse_face_beg_row
9530 = dpyinfo->mouse_face_beg_col = -1;
9531 dpyinfo->mouse_face_end_row
9532 = dpyinfo->mouse_face_end_col = -1;
9533 dpyinfo->mouse_face_window = Qnil;
9534 dpyinfo->mouse_face_deferred_gc = 0;
9535 dpyinfo->mouse_face_mouse_frame = 0;
9538 UNBLOCK_INPUT;
9542 /* Destroy the X window of frame F. */
9544 void
9545 x_destroy_window (f)
9546 struct frame *f;
9548 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9550 /* If a display connection is dead, don't try sending more
9551 commands to the X server. */
9552 if (dpyinfo->display != 0)
9553 x_free_frame_resources (f);
9555 dpyinfo->reference_count--;
9559 /* Setting window manager hints. */
9561 /* Set the normal size hints for the window manager, for frame F.
9562 FLAGS is the flags word to use--or 0 meaning preserve the flags
9563 that the window now has.
9564 If USER_POSITION is nonzero, we set the USPosition
9565 flag (this is useful when FLAGS is 0).
9566 The GTK version is in gtkutils.c */
9568 #ifndef USE_GTK
9569 void
9570 x_wm_set_size_hint (f, flags, user_position)
9571 struct frame *f;
9572 long flags;
9573 int user_position;
9575 XSizeHints size_hints;
9577 #ifdef USE_X_TOOLKIT
9578 Arg al[2];
9579 int ac = 0;
9580 Dimension widget_width, widget_height;
9581 #endif
9583 Window window = FRAME_OUTER_WINDOW (f);
9585 /* Setting PMaxSize caused various problems. */
9586 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9588 size_hints.x = f->left_pos;
9589 size_hints.y = f->top_pos;
9591 #ifdef USE_X_TOOLKIT
9592 XtSetArg (al[ac], XtNwidth, &widget_width); ac++;
9593 XtSetArg (al[ac], XtNheight, &widget_height); ac++;
9594 XtGetValues (f->output_data.x->widget, al, ac);
9595 size_hints.height = widget_height;
9596 size_hints.width = widget_width;
9597 #else /* not USE_X_TOOLKIT */
9598 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9599 size_hints.width = FRAME_PIXEL_WIDTH (f);
9600 #endif /* not USE_X_TOOLKIT */
9602 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9603 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9604 size_hints.max_width
9605 = FRAME_X_DISPLAY_INFO (f)->width - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9606 size_hints.max_height
9607 = FRAME_X_DISPLAY_INFO (f)->height - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9609 /* Calculate the base and minimum sizes.
9611 (When we use the X toolkit, we don't do it here.
9612 Instead we copy the values that the widgets are using, below.) */
9613 #ifndef USE_X_TOOLKIT
9615 int base_width, base_height;
9616 int min_rows = 0, min_cols = 0;
9618 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9619 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9621 check_frame_size (f, &min_rows, &min_cols);
9623 /* The window manager uses the base width hints to calculate the
9624 current number of rows and columns in the frame while
9625 resizing; min_width and min_height aren't useful for this
9626 purpose, since they might not give the dimensions for a
9627 zero-row, zero-column frame.
9629 We use the base_width and base_height members if we have
9630 them; otherwise, we set the min_width and min_height members
9631 to the size for a zero x zero frame. */
9633 size_hints.flags |= PBaseSize;
9634 size_hints.base_width = base_width;
9635 size_hints.base_height = base_height;
9636 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9637 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9640 /* If we don't need the old flags, we don't need the old hint at all. */
9641 if (flags)
9643 size_hints.flags |= flags;
9644 goto no_read;
9646 #endif /* not USE_X_TOOLKIT */
9649 XSizeHints hints; /* Sometimes I hate X Windows... */
9650 long supplied_return;
9651 int value;
9653 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9654 &supplied_return);
9656 #ifdef USE_X_TOOLKIT
9657 size_hints.base_height = hints.base_height;
9658 size_hints.base_width = hints.base_width;
9659 size_hints.min_height = hints.min_height;
9660 size_hints.min_width = hints.min_width;
9661 #endif
9663 if (flags)
9664 size_hints.flags |= flags;
9665 else
9667 if (value == 0)
9668 hints.flags = 0;
9669 if (hints.flags & PSize)
9670 size_hints.flags |= PSize;
9671 if (hints.flags & PPosition)
9672 size_hints.flags |= PPosition;
9673 if (hints.flags & USPosition)
9674 size_hints.flags |= USPosition;
9675 if (hints.flags & USSize)
9676 size_hints.flags |= USSize;
9680 #ifndef USE_X_TOOLKIT
9681 no_read:
9682 #endif
9684 #ifdef PWinGravity
9685 size_hints.win_gravity = f->win_gravity;
9686 size_hints.flags |= PWinGravity;
9688 if (user_position)
9690 size_hints.flags &= ~ PPosition;
9691 size_hints.flags |= USPosition;
9693 #endif /* PWinGravity */
9695 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9697 #endif /* not USE_GTK */
9699 /* Used for IconicState or NormalState */
9701 void
9702 x_wm_set_window_state (f, state)
9703 struct frame *f;
9704 int state;
9706 #ifdef USE_X_TOOLKIT
9707 Arg al[1];
9709 XtSetArg (al[0], XtNinitialState, state);
9710 XtSetValues (f->output_data.x->widget, al, 1);
9711 #else /* not USE_X_TOOLKIT */
9712 Window window = FRAME_X_WINDOW (f);
9714 f->output_data.x->wm_hints.flags |= StateHint;
9715 f->output_data.x->wm_hints.initial_state = state;
9717 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9718 #endif /* not USE_X_TOOLKIT */
9721 void
9722 x_wm_set_icon_pixmap (f, pixmap_id)
9723 struct frame *f;
9724 int pixmap_id;
9726 Pixmap icon_pixmap, icon_mask;
9728 #ifndef USE_X_TOOLKIT
9729 Window window = FRAME_OUTER_WINDOW (f);
9730 #endif
9732 if (pixmap_id > 0)
9734 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9735 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9736 icon_mask = x_bitmap_mask (f, pixmap_id);
9737 f->output_data.x->wm_hints.icon_mask = icon_mask;
9739 else
9741 /* It seems there is no way to turn off use of an icon pixmap.
9742 The following line does it, only if no icon has yet been created,
9743 for some window managers. But with mwm it crashes.
9744 Some people say it should clear the IconPixmapHint bit in this case,
9745 but that doesn't work, and the X consortium said it isn't the
9746 right thing at all. Since there is no way to win,
9747 best to explicitly give up. */
9748 #if 0
9749 f->output_data.x->wm_hints.icon_pixmap = None;
9750 f->output_data.x->wm_hints.icon_mask = None;
9751 #else
9752 return;
9753 #endif
9757 #ifdef USE_GTK
9759 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9760 return;
9763 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9766 Arg al[1];
9767 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9768 XtSetValues (f->output_data.x->widget, al, 1);
9769 XtSetArg (al[0], XtNiconMask, icon_mask);
9770 XtSetValues (f->output_data.x->widget, al, 1);
9773 #else /* not USE_X_TOOLKIT && not USE_GTK */
9775 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9776 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9778 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9781 void
9782 x_wm_set_icon_position (f, icon_x, icon_y)
9783 struct frame *f;
9784 int icon_x, icon_y;
9786 Window window = FRAME_OUTER_WINDOW (f);
9788 f->output_data.x->wm_hints.flags |= IconPositionHint;
9789 f->output_data.x->wm_hints.icon_x = icon_x;
9790 f->output_data.x->wm_hints.icon_y = icon_y;
9792 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9796 /***********************************************************************
9797 Fonts
9798 ***********************************************************************/
9800 #if GLYPH_DEBUG
9802 /* Check that FONT is valid on frame F. It is if it can be found in F's
9803 font table. */
9805 static void
9806 x_check_font (f, font)
9807 struct frame *f;
9808 struct font *font;
9810 Lisp_Object frame;
9812 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9813 if (font->driver->check)
9814 xassert (font->driver->check (f, font) == 0);
9817 #endif /* GLYPH_DEBUG != 0 */
9820 /***********************************************************************
9821 Initialization
9822 ***********************************************************************/
9824 #ifdef USE_X_TOOLKIT
9825 static XrmOptionDescRec emacs_options[] = {
9826 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9827 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9829 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9830 XrmoptionSepArg, NULL},
9831 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9833 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9834 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9835 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9836 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9837 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9838 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9839 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9842 /* Whether atimer for Xt timeouts is activated or not. */
9844 static int x_timeout_atimer_activated_flag;
9846 #endif /* USE_X_TOOLKIT */
9848 static int x_initialized;
9850 #ifdef HAVE_X_SM
9851 static int x_session_initialized;
9852 #endif
9854 #ifdef MULTI_KBOARD
9855 /* Test whether two display-name strings agree up to the dot that separates
9856 the screen number from the server number. */
9857 static int
9858 same_x_server (name1, name2)
9859 const char *name1, *name2;
9861 int seen_colon = 0;
9862 const unsigned char *system_name = SDATA (Vsystem_name);
9863 int system_name_length = strlen (system_name);
9864 int length_until_period = 0;
9866 while (system_name[length_until_period] != 0
9867 && system_name[length_until_period] != '.')
9868 length_until_period++;
9870 /* Treat `unix' like an empty host name. */
9871 if (! strncmp (name1, "unix:", 5))
9872 name1 += 4;
9873 if (! strncmp (name2, "unix:", 5))
9874 name2 += 4;
9875 /* Treat this host's name like an empty host name. */
9876 if (! strncmp (name1, system_name, system_name_length)
9877 && name1[system_name_length] == ':')
9878 name1 += system_name_length;
9879 if (! strncmp (name2, system_name, system_name_length)
9880 && name2[system_name_length] == ':')
9881 name2 += system_name_length;
9882 /* Treat this host's domainless name like an empty host name. */
9883 if (! strncmp (name1, system_name, length_until_period)
9884 && name1[length_until_period] == ':')
9885 name1 += length_until_period;
9886 if (! strncmp (name2, system_name, length_until_period)
9887 && name2[length_until_period] == ':')
9888 name2 += length_until_period;
9890 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9892 if (*name1 == ':')
9893 seen_colon++;
9894 if (seen_colon && *name1 == '.')
9895 return 1;
9897 return (seen_colon
9898 && (*name1 == '.' || *name1 == '\0')
9899 && (*name2 == '.' || *name2 == '\0'));
9901 #endif
9903 /* Count number of set bits in mask and number of bits to shift to
9904 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9905 to 5. */
9906 static void
9907 get_bits_and_offset (mask, bits, offset)
9908 unsigned long mask;
9909 int *bits;
9910 int *offset;
9912 int nr = 0;
9913 int off = 0;
9915 while (!(mask & 1))
9917 off++;
9918 mask >>= 1;
9921 while (mask & 1)
9923 nr++;
9924 mask >>= 1;
9927 *offset = off;
9928 *bits = nr;
9931 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9932 But don't permanently open it, just test its availability. */
9935 x_display_ok (display)
9936 const char *display;
9938 int dpy_ok = 1;
9939 Display *dpy;
9941 dpy = XOpenDisplay (display);
9942 if (dpy)
9943 XCloseDisplay (dpy);
9944 else
9945 dpy_ok = 0;
9946 return dpy_ok;
9949 /* Open a connection to X display DISPLAY_NAME, and return
9950 the structure that describes the open display.
9951 If we cannot contact the display, return null. */
9953 struct x_display_info *
9954 x_term_init (display_name, xrm_option, resource_name)
9955 Lisp_Object display_name;
9956 char *xrm_option;
9957 char *resource_name;
9959 int connection;
9960 Display *dpy;
9961 struct terminal *terminal;
9962 struct x_display_info *dpyinfo;
9963 XrmDatabase xrdb;
9965 BLOCK_INPUT;
9967 if (!x_initialized)
9969 x_initialize ();
9970 ++x_initialized;
9973 if (! x_display_ok (SDATA (display_name)))
9974 error ("Display %s can't be opened", SDATA (display_name));
9976 #ifdef USE_GTK
9978 #define NUM_ARGV 10
9979 int argc;
9980 char *argv[NUM_ARGV];
9981 char **argv2 = argv;
9982 GdkAtom atom;
9984 #ifndef HAVE_GTK_MULTIDISPLAY
9985 if (!EQ (Vinitial_window_system, intern ("x")))
9986 error ("Sorry, you cannot connect to X servers with the GTK toolkit");
9987 #endif
9989 if (x_initialized++ > 1)
9991 #ifdef HAVE_GTK_MULTIDISPLAY
9992 /* Opening another display. If xg_display_open returns less
9993 than zero, we are probably on GTK 2.0, which can only handle
9994 one display. GTK 2.2 or later can handle more than one. */
9995 if (xg_display_open (SDATA (display_name), &dpy) < 0)
9996 #endif
9997 error ("Sorry, this version of GTK can only handle one display");
9999 else
10001 for (argc = 0; argc < NUM_ARGV; ++argc)
10002 argv[argc] = 0;
10004 argc = 0;
10005 argv[argc++] = initial_argv[0];
10007 if (! NILP (display_name))
10009 argv[argc++] = "--display";
10010 argv[argc++] = SDATA (display_name);
10013 argv[argc++] = "--name";
10014 argv[argc++] = resource_name;
10016 XSetLocaleModifiers ("");
10018 gtk_init (&argc, &argv2);
10020 /* gtk_init does set_locale. We must fix locale after calling it. */
10021 fixup_locale ();
10022 xg_initialize ();
10024 dpy = GDK_DISPLAY ();
10026 /* NULL window -> events for all windows go to our function */
10027 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10029 /* Load our own gtkrc if it exists. */
10031 char *file = "~/.emacs.d/gtkrc";
10032 Lisp_Object s, abs_file;
10034 s = make_string (file, strlen (file));
10035 abs_file = Fexpand_file_name (s, Qnil);
10037 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10038 gtk_rc_parse (SDATA (abs_file));
10041 XSetErrorHandler (x_error_handler);
10042 XSetIOErrorHandler (x_io_error_quitter);
10045 #else /* not USE_GTK */
10046 #ifdef USE_X_TOOLKIT
10047 /* weiner@footloose.sps.mot.com reports that this causes
10048 errors with X11R5:
10049 X protocol error: BadAtom (invalid Atom parameter)
10050 on protocol request 18skiloaf.
10051 So let's not use it until R6. */
10052 #ifdef HAVE_X11XTR6
10053 XtSetLanguageProc (NULL, NULL, NULL);
10054 #endif
10057 int argc = 0;
10058 char *argv[3];
10060 argv[0] = "";
10061 argc = 1;
10062 if (xrm_option)
10064 argv[argc++] = "-xrm";
10065 argv[argc++] = xrm_option;
10067 turn_on_atimers (0);
10068 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10069 resource_name, EMACS_CLASS,
10070 emacs_options, XtNumber (emacs_options),
10071 &argc, argv);
10072 turn_on_atimers (1);
10074 #ifdef HAVE_X11XTR6
10075 /* I think this is to compensate for XtSetLanguageProc. */
10076 fixup_locale ();
10077 #endif
10080 #else /* not USE_X_TOOLKIT */
10081 XSetLocaleModifiers ("");
10082 dpy = XOpenDisplay (SDATA (display_name));
10083 #endif /* not USE_X_TOOLKIT */
10084 #endif /* not USE_GTK*/
10086 /* Detect failure. */
10087 if (dpy == 0)
10089 UNBLOCK_INPUT;
10090 return 0;
10093 /* We have definitely succeeded. Record the new connection. */
10095 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10096 bzero (dpyinfo, sizeof *dpyinfo);
10098 terminal = x_create_terminal (dpyinfo);
10100 #ifdef MULTI_KBOARD
10102 struct x_display_info *share;
10103 Lisp_Object tail;
10105 for (share = x_display_list, tail = x_display_name_list; share;
10106 share = share->next, tail = XCDR (tail))
10107 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10108 SDATA (display_name)))
10109 break;
10110 if (share)
10111 terminal->kboard = share->terminal->kboard;
10112 else
10114 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10115 init_kboard (terminal->kboard);
10116 terminal->kboard->Vwindow_system = intern ("x");
10117 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10119 char *vendor = ServerVendor (dpy);
10120 UNBLOCK_INPUT;
10121 terminal->kboard->Vsystem_key_alist
10122 = call1 (Qvendor_specific_keysyms,
10123 vendor ? build_string (vendor) : empty_unibyte_string);
10124 BLOCK_INPUT;
10127 terminal->kboard->next_kboard = all_kboards;
10128 all_kboards = terminal->kboard;
10129 /* Don't let the initial kboard remain current longer than necessary.
10130 That would cause problems if a file loaded on startup tries to
10131 prompt in the mini-buffer. */
10132 if (current_kboard == initial_kboard)
10133 current_kboard = terminal->kboard;
10135 terminal->kboard->reference_count++;
10137 #endif
10139 /* Put this display on the chain. */
10140 dpyinfo->next = x_display_list;
10141 x_display_list = dpyinfo;
10143 /* Put it on x_display_name_list as well, to keep them parallel. */
10144 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10145 x_display_name_list);
10146 dpyinfo->name_list_element = XCAR (x_display_name_list);
10148 dpyinfo->display = dpy;
10150 /* Set the name of the terminal. */
10151 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10152 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10153 terminal->name[SBYTES (display_name)] = 0;
10155 #if 0
10156 XSetAfterFunction (x_current_display, x_trace_wire);
10157 #endif /* ! 0 */
10159 dpyinfo->x_id_name
10160 = (char *) xmalloc (SBYTES (Vinvocation_name)
10161 + SBYTES (Vsystem_name)
10162 + 2);
10163 sprintf (dpyinfo->x_id_name, "%s@%s",
10164 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10166 /* Figure out which modifier bits mean what. */
10167 x_find_modifier_meanings (dpyinfo);
10169 /* Get the scroll bar cursor. */
10170 #ifdef USE_GTK
10171 /* We must create a GTK cursor, it is required for GTK widgets. */
10172 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10173 #endif /* USE_GTK */
10175 dpyinfo->vertical_scroll_bar_cursor
10176 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10178 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10179 resource_name, EMACS_CLASS);
10180 #ifdef HAVE_XRMSETDATABASE
10181 XrmSetDatabase (dpyinfo->display, xrdb);
10182 #else
10183 dpyinfo->display->db = xrdb;
10184 #endif
10185 /* Put the rdb where we can find it in a way that works on
10186 all versions. */
10187 dpyinfo->xrdb = xrdb;
10189 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10190 DefaultScreen (dpyinfo->display));
10191 select_visual (dpyinfo);
10192 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10193 dpyinfo->height = HeightOfScreen (dpyinfo->screen);
10194 dpyinfo->width = WidthOfScreen (dpyinfo->screen);
10195 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10196 dpyinfo->client_leader_window = 0;
10197 dpyinfo->grabbed = 0;
10198 dpyinfo->reference_count = 0;
10199 dpyinfo->icon_bitmap_id = -1;
10200 dpyinfo->n_fonts = 0;
10201 dpyinfo->bitmaps = 0;
10202 dpyinfo->bitmaps_size = 0;
10203 dpyinfo->bitmaps_last = 0;
10204 dpyinfo->scratch_cursor_gc = 0;
10205 dpyinfo->mouse_face_mouse_frame = 0;
10206 dpyinfo->mouse_face_deferred_gc = 0;
10207 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10208 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10209 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10210 dpyinfo->mouse_face_window = Qnil;
10211 dpyinfo->mouse_face_overlay = Qnil;
10212 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10213 dpyinfo->mouse_face_defer = 0;
10214 dpyinfo->mouse_face_hidden = 0;
10215 dpyinfo->x_focus_frame = 0;
10216 dpyinfo->x_focus_event_frame = 0;
10217 dpyinfo->x_highlight_frame = 0;
10218 dpyinfo->terminal->image_cache = make_image_cache ();
10219 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10221 /* See if we can construct pixel values from RGB values. */
10222 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10223 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10225 if (dpyinfo->visual->class == TrueColor)
10227 get_bits_and_offset (dpyinfo->visual->red_mask,
10228 &dpyinfo->red_bits, &dpyinfo->red_offset);
10229 get_bits_and_offset (dpyinfo->visual->blue_mask,
10230 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10231 get_bits_and_offset (dpyinfo->visual->green_mask,
10232 &dpyinfo->green_bits, &dpyinfo->green_offset);
10235 /* See if a private colormap is requested. */
10236 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10238 if (dpyinfo->visual->class == PseudoColor)
10240 Lisp_Object value;
10241 value = display_x_get_resource (dpyinfo,
10242 build_string ("privateColormap"),
10243 build_string ("PrivateColormap"),
10244 Qnil, Qnil);
10245 if (STRINGP (value)
10246 && (!strcmp (SDATA (value), "true")
10247 || !strcmp (SDATA (value), "on")))
10248 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10251 else
10252 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10253 dpyinfo->visual, AllocNone);
10256 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10257 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10258 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10259 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10260 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10261 pixels = DisplayWidth (dpyinfo->display, screen_number);
10262 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10263 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10264 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10267 dpyinfo->Xatom_wm_protocols
10268 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10269 dpyinfo->Xatom_wm_take_focus
10270 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10271 dpyinfo->Xatom_wm_save_yourself
10272 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10273 dpyinfo->Xatom_wm_delete_window
10274 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10275 dpyinfo->Xatom_wm_change_state
10276 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10277 dpyinfo->Xatom_wm_configure_denied
10278 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10279 dpyinfo->Xatom_wm_window_moved
10280 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10281 dpyinfo->Xatom_wm_client_leader
10282 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10283 dpyinfo->Xatom_editres
10284 = XInternAtom (dpyinfo->display, "Editres", False);
10285 dpyinfo->Xatom_CLIPBOARD
10286 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10287 dpyinfo->Xatom_TIMESTAMP
10288 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10289 dpyinfo->Xatom_TEXT
10290 = XInternAtom (dpyinfo->display, "TEXT", False);
10291 dpyinfo->Xatom_COMPOUND_TEXT
10292 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10293 dpyinfo->Xatom_UTF8_STRING
10294 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10295 dpyinfo->Xatom_DELETE
10296 = XInternAtom (dpyinfo->display, "DELETE", False);
10297 dpyinfo->Xatom_MULTIPLE
10298 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10299 dpyinfo->Xatom_INCR
10300 = XInternAtom (dpyinfo->display, "INCR", False);
10301 dpyinfo->Xatom_EMACS_TMP
10302 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10303 dpyinfo->Xatom_TARGETS
10304 = XInternAtom (dpyinfo->display, "TARGETS", False);
10305 dpyinfo->Xatom_NULL
10306 = XInternAtom (dpyinfo->display, "NULL", False);
10307 dpyinfo->Xatom_ATOM_PAIR
10308 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10309 /* For properties of font. */
10310 dpyinfo->Xatom_PIXEL_SIZE
10311 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10312 dpyinfo->Xatom_AVERAGE_WIDTH
10313 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10314 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10315 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10316 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10317 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10318 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10319 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10321 /* Ghostscript support. */
10322 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10323 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10325 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10326 False);
10328 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10329 False);
10331 dpyinfo->cut_buffers_initialized = 0;
10333 dpyinfo->x_dnd_atoms_size = 8;
10334 dpyinfo->x_dnd_atoms_length = 0;
10335 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10336 * dpyinfo->x_dnd_atoms_size);
10338 dpyinfo->net_supported_atoms = NULL;
10339 dpyinfo->nr_net_supported_atoms = 0;
10340 dpyinfo->net_supported_window = 0;
10342 connection = ConnectionNumber (dpyinfo->display);
10343 dpyinfo->connection = connection;
10346 char null_bits[1];
10348 null_bits[0] = 0x00;
10350 dpyinfo->null_pixel
10351 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10352 null_bits, 1, 1, (long) 0, (long) 0,
10357 extern int gray_bitmap_width, gray_bitmap_height;
10358 extern char *gray_bitmap_bits;
10359 dpyinfo->gray
10360 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10361 gray_bitmap_bits,
10362 gray_bitmap_width, gray_bitmap_height,
10363 (unsigned long) 1, (unsigned long) 0, 1);
10366 #ifdef HAVE_X_I18N
10367 xim_initialize (dpyinfo, resource_name);
10368 #endif
10370 #ifdef subprocesses
10371 /* This is only needed for distinguishing keyboard and process input. */
10372 if (connection != 0)
10373 add_keyboard_wait_descriptor (connection);
10374 #endif
10376 #ifdef F_SETOWN
10377 fcntl (connection, F_SETOWN, getpid ());
10378 #endif /* ! defined (F_SETOWN) */
10380 #ifdef SIGIO
10381 if (interrupt_input)
10382 init_sigio (connection);
10383 #endif /* ! defined (SIGIO) */
10385 #ifdef USE_LUCID
10387 Display *dpy = dpyinfo->display;
10388 XrmValue d, fr, to;
10389 Font font;
10391 d.addr = (XPointer)&dpy;
10392 d.size = sizeof (Display *);
10393 fr.addr = XtDefaultFont;
10394 fr.size = sizeof (XtDefaultFont);
10395 to.size = sizeof (Font *);
10396 to.addr = (XPointer)&font;
10397 x_catch_errors (dpy);
10398 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10399 abort ();
10400 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10401 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10402 x_uncatch_errors ();
10404 #endif
10406 /* See if we should run in synchronous mode. This is useful
10407 for debugging X code. */
10409 Lisp_Object value;
10410 value = display_x_get_resource (dpyinfo,
10411 build_string ("synchronous"),
10412 build_string ("Synchronous"),
10413 Qnil, Qnil);
10414 if (STRINGP (value)
10415 && (!strcmp (SDATA (value), "true")
10416 || !strcmp (SDATA (value), "on")))
10417 XSynchronize (dpyinfo->display, True);
10421 Lisp_Object value;
10422 value = display_x_get_resource (dpyinfo,
10423 build_string ("useXIM"),
10424 build_string ("UseXIM"),
10425 Qnil, Qnil);
10426 #ifdef USE_XIM
10427 if (STRINGP (value)
10428 && (!strcmp (SDATA (value), "false")
10429 || !strcmp (SDATA (value), "off")))
10430 use_xim = 0;
10431 #else
10432 if (STRINGP (value)
10433 && (!strcmp (SDATA (value), "true")
10434 || !strcmp (SDATA (value), "on")))
10435 use_xim = 1;
10436 #endif
10439 #ifdef HAVE_X_SM
10440 /* Only do this for the very first display in the Emacs session.
10441 Ignore X session management when Emacs was first started on a
10442 tty. */
10443 if (terminal->id == 1)
10444 x_session_initialize (dpyinfo);
10445 #endif
10447 UNBLOCK_INPUT;
10449 return dpyinfo;
10452 /* Get rid of display DPYINFO, deleting all frames on it,
10453 and without sending any more commands to the X server. */
10455 void
10456 x_delete_display (dpyinfo)
10457 struct x_display_info *dpyinfo;
10459 int i;
10460 struct terminal *t;
10462 /* Close all frames and delete the generic struct terminal for this
10463 X display. */
10464 for (t = terminal_list; t; t = t->next_terminal)
10465 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10467 #ifdef HAVE_X_SM
10468 /* Close X session management when we close its display. */
10469 if (t->id == 1 && x_session_have_connection ())
10470 x_session_close();
10471 #endif
10472 delete_terminal (t);
10473 break;
10476 delete_keyboard_wait_descriptor (dpyinfo->connection);
10478 /* Discard this display from x_display_name_list and x_display_list.
10479 We can't use Fdelq because that can quit. */
10480 if (! NILP (x_display_name_list)
10481 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10482 x_display_name_list = XCDR (x_display_name_list);
10483 else
10485 Lisp_Object tail;
10487 tail = x_display_name_list;
10488 while (CONSP (tail) && CONSP (XCDR (tail)))
10490 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10492 XSETCDR (tail, XCDR (XCDR (tail)));
10493 break;
10495 tail = XCDR (tail);
10499 if (next_noop_dpyinfo == dpyinfo)
10500 next_noop_dpyinfo = dpyinfo->next;
10502 if (x_display_list == dpyinfo)
10503 x_display_list = dpyinfo->next;
10504 else
10506 struct x_display_info *tail;
10508 for (tail = x_display_list; tail; tail = tail->next)
10509 if (tail->next == dpyinfo)
10510 tail->next = tail->next->next;
10513 #ifndef USE_X_TOOLKIT /* I'm told Xt does this itself. */
10514 #ifndef AIX /* On AIX, XCloseDisplay calls this. */
10515 XrmDestroyDatabase (dpyinfo->xrdb);
10516 #endif
10517 #endif
10518 #ifdef HAVE_X_I18N
10519 if (dpyinfo->xim)
10520 xim_close_dpy (dpyinfo);
10521 #endif
10523 if (dpyinfo->x_id_name)
10524 xfree (dpyinfo->x_id_name);
10525 if (dpyinfo->color_cells)
10526 xfree (dpyinfo->color_cells);
10527 xfree (dpyinfo);
10530 #ifdef USE_X_TOOLKIT
10532 /* Atimer callback function for TIMER. Called every 0.1s to process
10533 Xt timeouts, if needed. We must avoid calling XtAppPending as
10534 much as possible because that function does an implicit XFlush
10535 that slows us down. */
10537 static void
10538 x_process_timeouts (timer)
10539 struct atimer *timer;
10541 BLOCK_INPUT;
10542 x_timeout_atimer_activated_flag = 0;
10543 if (toolkit_scroll_bar_interaction || popup_activated ())
10545 while (XtAppPending (Xt_app_con) & XtIMTimer)
10546 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10547 /* Reactivate the atimer for next time. */
10548 x_activate_timeout_atimer ();
10550 UNBLOCK_INPUT;
10553 /* Install an asynchronous timer that processes Xt timeout events
10554 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10555 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10556 function whenever these variables are set. This is necessary
10557 because some widget sets use timeouts internally, for example the
10558 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10559 processed, these widgets don't behave normally. */
10561 void
10562 x_activate_timeout_atimer ()
10564 BLOCK_INPUT;
10565 if (!x_timeout_atimer_activated_flag)
10567 EMACS_TIME interval;
10569 EMACS_SET_SECS_USECS (interval, 0, 100000);
10570 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10571 x_timeout_atimer_activated_flag = 1;
10573 UNBLOCK_INPUT;
10576 #endif /* USE_X_TOOLKIT */
10579 /* Set up use of X before we make the first connection. */
10581 extern frame_parm_handler x_frame_parm_handlers[];
10583 static struct redisplay_interface x_redisplay_interface =
10585 x_frame_parm_handlers,
10586 x_produce_glyphs,
10587 x_write_glyphs,
10588 x_insert_glyphs,
10589 x_clear_end_of_line,
10590 x_scroll_run,
10591 x_after_update_window_line,
10592 x_update_window_begin,
10593 x_update_window_end,
10594 x_cursor_to,
10595 x_flush,
10596 #ifdef XFlush
10597 x_flush,
10598 #else
10599 0, /* flush_display_optional */
10600 #endif
10601 x_clear_window_mouse_face,
10602 x_get_glyph_overhangs,
10603 x_fix_overlapping_area,
10604 x_draw_fringe_bitmap,
10605 0, /* define_fringe_bitmap */
10606 0, /* destroy_fringe_bitmap */
10607 x_compute_glyph_string_overhangs,
10608 x_draw_glyph_string,
10609 x_define_frame_cursor,
10610 x_clear_frame_area,
10611 x_draw_window_cursor,
10612 x_draw_vertical_window_border,
10613 x_shift_glyphs_for_insert
10617 /* This function is called when the last frame on a display is deleted. */
10618 void
10619 x_delete_terminal (struct terminal *terminal)
10621 struct x_display_info *dpyinfo = terminal->display_info.x;
10622 int i;
10624 /* Protect against recursive calls. Fdelete_frame in
10625 delete_terminal calls us back when it deletes our last frame. */
10626 if (!terminal->name)
10627 return;
10629 BLOCK_INPUT;
10630 /* If called from x_connection_closed, the display may already be closed
10631 and dpyinfo->display was set to 0 to indicate that. */
10632 if (dpyinfo->display)
10634 x_destroy_all_bitmaps (dpyinfo);
10635 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10637 #ifdef USE_GTK
10638 xg_display_close (dpyinfo->display);
10639 #else
10640 #ifdef USE_X_TOOLKIT
10641 XtCloseDisplay (dpyinfo->display);
10642 #else
10643 XCloseDisplay (dpyinfo->display);
10644 #endif
10645 #endif /* ! USE_GTK */
10648 x_delete_display (dpyinfo);
10649 UNBLOCK_INPUT;
10652 /* Create a struct terminal, initialize it with the X11 specific
10653 functions and make DISPLAY->TERMINAL point to it. */
10655 static struct terminal *
10656 x_create_terminal (struct x_display_info *dpyinfo)
10658 struct terminal *terminal;
10660 terminal = create_terminal ();
10662 terminal->type = output_x_window;
10663 terminal->display_info.x = dpyinfo;
10664 dpyinfo->terminal = terminal;
10666 /* kboard is initialized in x_term_init. */
10668 terminal->clear_frame_hook = x_clear_frame;
10669 terminal->ins_del_lines_hook = x_ins_del_lines;
10670 terminal->delete_glyphs_hook = x_delete_glyphs;
10671 terminal->ring_bell_hook = XTring_bell;
10672 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10673 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10674 terminal->update_begin_hook = x_update_begin;
10675 terminal->update_end_hook = x_update_end;
10676 terminal->set_terminal_window_hook = XTset_terminal_window;
10677 terminal->read_socket_hook = XTread_socket;
10678 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10679 terminal->mouse_position_hook = XTmouse_position;
10680 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10681 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10682 terminal->fullscreen_hook = XTfullscreen_hook;
10683 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10684 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10685 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10686 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10688 terminal->delete_frame_hook = x_destroy_window;
10689 terminal->delete_terminal_hook = x_delete_terminal;
10691 terminal->rif = &x_redisplay_interface;
10692 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10693 terminal->char_ins_del_ok = 1;
10694 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10695 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10696 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10697 off the bottom. */
10699 return terminal;
10702 void
10703 x_initialize ()
10705 baud_rate = 19200;
10707 x_noop_count = 0;
10708 last_tool_bar_item = -1;
10709 any_help_event_p = 0;
10710 ignore_next_mouse_click_timeout = 0;
10711 #ifdef HAVE_X_SM
10712 x_session_initialized = 0;
10713 #endif
10715 #ifdef USE_GTK
10716 current_count = -1;
10717 #endif
10719 /* Try to use interrupt input; if we can't, then start polling. */
10720 Fset_input_interrupt_mode (Qt);
10722 #ifdef USE_X_TOOLKIT
10723 XtToolkitInitialize ();
10725 Xt_app_con = XtCreateApplicationContext ();
10727 /* Register a converter from strings to pixels, which uses
10728 Emacs' color allocation infrastructure. */
10729 XtAppSetTypeConverter (Xt_app_con,
10730 XtRString, XtRPixel, cvt_string_to_pixel,
10731 cvt_string_to_pixel_args,
10732 XtNumber (cvt_string_to_pixel_args),
10733 XtCacheByDisplay, cvt_pixel_dtor);
10735 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10736 #endif
10738 #ifdef USE_TOOLKIT_SCROLL_BARS
10739 #ifndef USE_GTK
10740 xaw3d_arrow_scroll = False;
10741 xaw3d_pick_top = True;
10742 #endif
10743 #endif
10745 /* Note that there is no real way portable across R3/R4 to get the
10746 original error handler. */
10747 XSetErrorHandler (x_error_handler);
10748 XSetIOErrorHandler (x_io_error_quitter);
10750 /* Disable Window Change signals; they are handled by X events. */
10751 #if 0 /* Don't. We may want to open tty frames later. */
10752 #ifdef SIGWINCH
10753 signal (SIGWINCH, SIG_DFL);
10754 #endif /* SIGWINCH */
10755 #endif
10757 signal (SIGPIPE, x_connection_signal);
10761 void
10762 syms_of_xterm ()
10764 x_error_message = NULL;
10766 staticpro (&x_display_name_list);
10767 x_display_name_list = Qnil;
10769 staticpro (&last_mouse_scroll_bar);
10770 last_mouse_scroll_bar = Qnil;
10772 staticpro (&Qvendor_specific_keysyms);
10773 Qvendor_specific_keysyms = intern ("vendor-specific-keysyms");
10775 staticpro (&Qlatin_1);
10776 Qlatin_1 = intern ("latin-1");
10778 staticpro (&last_mouse_press_frame);
10779 last_mouse_press_frame = Qnil;
10781 DEFVAR_BOOL ("x-use-underline-position-properties",
10782 &x_use_underline_position_properties,
10783 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10784 A value of nil means ignore them. If you encounter fonts with bogus
10785 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10786 to 4.1, set this to nil. */);
10787 x_use_underline_position_properties = 1;
10789 DEFVAR_BOOL ("x-underline-at-descent-line",
10790 &x_underline_at_descent_line,
10791 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10792 A value of nil means to draw the underline according to the value of the
10793 variable `x-use-underline-position-properties', which is usually at the
10794 baseline level. The default value is nil. */);
10795 x_underline_at_descent_line = 0;
10797 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10798 &x_mouse_click_focus_ignore_position,
10799 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10800 This variable is only used when the window manager requires that you
10801 click on a frame to select it (give it focus). In that case, a value
10802 of nil, means that the selected window and cursor position changes to
10803 reflect the mouse click position, while a non-nil value means that the
10804 selected window or cursor position is preserved. */);
10805 x_mouse_click_focus_ignore_position = 0;
10807 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10808 doc: /* What X toolkit scroll bars Emacs uses.
10809 A value of nil means Emacs doesn't use X toolkit scroll bars.
10810 Otherwise, value is a symbol describing the X toolkit. */);
10811 #ifdef USE_TOOLKIT_SCROLL_BARS
10812 #ifdef USE_MOTIF
10813 Vx_toolkit_scroll_bars = intern ("motif");
10814 #elif defined HAVE_XAW3D
10815 Vx_toolkit_scroll_bars = intern ("xaw3d");
10816 #elif USE_GTK
10817 Vx_toolkit_scroll_bars = intern ("gtk");
10818 #else
10819 Vx_toolkit_scroll_bars = intern ("xaw");
10820 #endif
10821 #else
10822 Vx_toolkit_scroll_bars = Qnil;
10823 #endif
10825 staticpro (&last_mouse_motion_frame);
10826 last_mouse_motion_frame = Qnil;
10828 Qmodifier_value = intern ("modifier-value");
10829 Qalt = intern ("alt");
10830 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10831 Qhyper = intern ("hyper");
10832 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10833 Qmeta = intern ("meta");
10834 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10835 Qsuper = intern ("super");
10836 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10838 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10839 doc: /* Which keys Emacs uses for the alt modifier.
10840 This should be one of the symbols `alt', `hyper', `meta', `super'.
10841 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10842 is nil, which is the same as `alt'. */);
10843 Vx_alt_keysym = Qnil;
10845 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10846 doc: /* Which keys Emacs uses for the hyper modifier.
10847 This should be one of the symbols `alt', `hyper', `meta', `super'.
10848 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10849 default is nil, which is the same as `hyper'. */);
10850 Vx_hyper_keysym = Qnil;
10852 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10853 doc: /* Which keys Emacs uses for the meta modifier.
10854 This should be one of the symbols `alt', `hyper', `meta', `super'.
10855 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10856 default is nil, which is the same as `meta'. */);
10857 Vx_meta_keysym = Qnil;
10859 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10860 doc: /* Which keys Emacs uses for the super modifier.
10861 This should be one of the symbols `alt', `hyper', `meta', `super'.
10862 For example, `super' means use the Super_L and Super_R keysyms. The
10863 default is nil, which is the same as `super'. */);
10864 Vx_super_keysym = Qnil;
10866 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10867 doc: /* Hash table of character codes indexed by X keysym codes. */);
10868 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10869 make_float (DEFAULT_REHASH_SIZE),
10870 make_float (DEFAULT_REHASH_THRESHOLD),
10871 Qnil, Qnil, Qnil);
10874 #endif /* HAVE_X_WINDOWS */
10876 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10877 (do not change this comment) */