* eshell/esh-ext.el (eshell-external-command): Do not restrict
[emacs.git] / src / xterm.c
blob909b6978f5ab84398dbc5e69475a6cfb59b3e37c
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
21 /* Xt features made by Fred Pierresteguy. */
23 #include <config.h>
24 #include <signal.h>
25 #include <stdio.h>
26 #include <setjmp.h>
28 #ifdef HAVE_X_WINDOWS
30 #include "lisp.h"
31 #include "blockinput.h"
33 /* Need syssignal.h for various externs and definitions that may be required
34 by some configurations for calls to signal later in this source file. */
35 #include "syssignal.h"
37 /* This may include sys/types.h, and that somehow loses
38 if this is not done before the other system files. */
39 #include "xterm.h"
40 #include <X11/cursorfont.h>
42 /* Load sys/types.h if not already loaded.
43 In some systems loading it twice is suicidal. */
44 #ifndef makedev
45 #include <sys/types.h>
46 #endif /* makedev */
48 #include <sys/ioctl.h>
50 #include "systime.h"
52 #include <fcntl.h>
53 #include <ctype.h>
54 #include <errno.h>
55 #include <setjmp.h>
56 #include <sys/stat.h>
57 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
58 /* #include <sys/param.h> */
60 #include "charset.h"
61 #include "character.h"
62 #include "coding.h"
63 #include "frame.h"
64 #include "dispextern.h"
65 #include "fontset.h"
66 #include "termhooks.h"
67 #include "termopts.h"
68 #include "termchar.h"
69 #include "emacs-icon.h"
70 #include "disptab.h"
71 #include "buffer.h"
72 #include "window.h"
73 #include "keyboard.h"
74 #include "intervals.h"
75 #include "process.h"
76 #include "atimer.h"
77 #include "keymap.h"
78 #include "font.h"
79 #include "fontset.h"
80 #include "xsettings.h"
81 #include "xgselect.h"
82 #include "sysselect.h"
84 #ifdef USE_X_TOOLKIT
85 #include <X11/Shell.h>
86 #endif
88 #ifdef HAVE_SYS_TIME_H
89 #include <sys/time.h>
90 #endif
92 #include <unistd.h>
94 #ifdef USE_GTK
95 #include "gtkutil.h"
96 #endif
98 #ifdef USE_LUCID
99 #include "../lwlib/xlwmenu.h"
100 #endif
102 #ifdef USE_X_TOOLKIT
103 #if !defined(NO_EDITRES)
104 #define HACK_EDITRES
105 extern void _XEditResCheckMessages ();
106 #endif /* not NO_EDITRES */
108 /* Include toolkit specific headers for the scroll bar widget. */
110 #ifdef USE_TOOLKIT_SCROLL_BARS
111 #if defined USE_MOTIF
112 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
113 #include <Xm/ScrollBar.h>
114 #else /* !USE_MOTIF i.e. use Xaw */
116 #ifdef HAVE_XAW3D
117 #include <X11/Xaw3d/Simple.h>
118 #include <X11/Xaw3d/Scrollbar.h>
119 #include <X11/Xaw3d/ThreeD.h>
120 #else /* !HAVE_XAW3D */
121 #include <X11/Xaw/Simple.h>
122 #include <X11/Xaw/Scrollbar.h>
123 #endif /* !HAVE_XAW3D */
124 #ifndef XtNpickTop
125 #define XtNpickTop "pickTop"
126 #endif /* !XtNpickTop */
127 #endif /* !USE_MOTIF */
128 #endif /* USE_TOOLKIT_SCROLL_BARS */
130 #endif /* USE_X_TOOLKIT */
132 #ifdef USE_X_TOOLKIT
133 #include "widget.h"
134 #ifndef XtNinitialState
135 #define XtNinitialState "initialState"
136 #endif
137 #endif
139 /* Default to using XIM if available. */
140 #ifdef USE_XIM
141 int use_xim = 1;
142 #else
143 int use_xim = 0; /* configure --without-xim */
144 #endif
148 /* Non-zero means that a HELP_EVENT has been generated since Emacs
149 start. */
151 static int any_help_event_p;
153 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
154 static Lisp_Object last_window;
156 /* This is a chain of structures for all the X displays currently in
157 use. */
159 struct x_display_info *x_display_list;
161 /* This is a list of cons cells, each of the form (NAME
162 . FONT-LIST-CACHE), one for each element of x_display_list and in
163 the same order. NAME is the name of the frame. FONT-LIST-CACHE
164 records previous values returned by x-list-fonts. */
166 Lisp_Object x_display_name_list;
168 /* Frame being updated by update_frame. This is declared in term.c.
169 This is set by update_begin and looked at by all the XT functions.
170 It is zero while not inside an update. In that case, the XT
171 functions assume that `selected_frame' is the frame to apply to. */
173 extern struct frame *updating_frame;
175 /* This is a frame waiting to be auto-raised, within XTread_socket. */
177 static struct frame *pending_autoraise_frame;
179 /* This is a frame waiting for an event matching mask, within XTread_socket. */
181 static struct {
182 struct frame *f;
183 int eventtype;
184 } pending_event_wait;
186 #ifdef USE_X_TOOLKIT
187 /* The application context for Xt use. */
188 XtAppContext Xt_app_con;
189 static String Xt_default_resources[] = {0};
190 #endif /* USE_X_TOOLKIT */
192 /* Non-zero means user is interacting with a toolkit scroll bar. */
194 static int toolkit_scroll_bar_interaction;
196 /* Non-zero timeout value means ignore next mouse click if it arrives
197 before that timeout elapses (i.e. as part of the same sequence of
198 events resulting from clicking on a frame to select it). */
200 static unsigned long ignore_next_mouse_click_timeout;
202 /* Mouse movement.
204 Formerly, we used PointerMotionHintMask (in standard_event_mask)
205 so that we would have to call XQueryPointer after each MotionNotify
206 event to ask for another such event. However, this made mouse tracking
207 slow, and there was a bug that made it eventually stop.
209 Simply asking for MotionNotify all the time seems to work better.
211 In order to avoid asking for motion events and then throwing most
212 of them away or busy-polling the server for mouse positions, we ask
213 the server for pointer motion hints. This means that we get only
214 one event per group of mouse movements. "Groups" are delimited by
215 other kinds of events (focus changes and button clicks, for
216 example), or by XQueryPointer calls; when one of these happens, we
217 get another MotionNotify event the next time the mouse moves. This
218 is at least as efficient as getting motion events when mouse
219 tracking is on, and I suspect only negligibly worse when tracking
220 is off. */
222 /* Where the mouse was last time we reported a mouse event. */
224 static XRectangle last_mouse_glyph;
225 static FRAME_PTR last_mouse_glyph_frame;
226 static Lisp_Object last_mouse_press_frame;
228 /* The scroll bar in which the last X motion event occurred.
230 If the last X motion event occurred in a scroll bar, we set this so
231 XTmouse_position can know whether to report a scroll bar motion or
232 an ordinary motion.
234 If the last X motion event didn't occur in a scroll bar, we set
235 this to Qnil, to tell XTmouse_position to return an ordinary motion
236 event. */
238 static Lisp_Object last_mouse_scroll_bar;
240 /* This is a hack. We would really prefer that XTmouse_position would
241 return the time associated with the position it returns, but there
242 doesn't seem to be any way to wrest the time-stamp from the server
243 along with the position query. So, we just keep track of the time
244 of the last movement we received, and return that in hopes that
245 it's somewhat accurate. */
247 static Time last_mouse_movement_time;
249 /* Time for last user interaction as returned in X events. */
251 static Time last_user_time;
253 /* Incremented by XTread_socket whenever it really tries to read
254 events. */
256 #ifdef __STDC__
257 static int volatile input_signal_count;
258 #else
259 static int input_signal_count;
260 #endif
262 /* Used locally within XTread_socket. */
264 static int x_noop_count;
266 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
268 static Lisp_Object Qvendor_specific_keysyms;
269 static Lisp_Object Qlatin_1;
271 #ifdef USE_GTK
272 /* The name of the Emacs icon file. */
273 static Lisp_Object xg_default_icon_file;
275 /* Used in gtkutil.c. */
276 Lisp_Object Qx_gtk_map_stock;
277 #endif
279 /* Some functions take this as char *, not const char *. */
280 static char emacs_class[] = EMACS_CLASS;
282 /* XEmbed implementation. */
284 #define XEMBED_VERSION 0
286 enum xembed_info
288 XEMBED_MAPPED = 1 << 0
291 enum xembed_message
293 XEMBED_EMBEDDED_NOTIFY = 0,
294 XEMBED_WINDOW_ACTIVATE = 1,
295 XEMBED_WINDOW_DEACTIVATE = 2,
296 XEMBED_REQUEST_FOCUS = 3,
297 XEMBED_FOCUS_IN = 4,
298 XEMBED_FOCUS_OUT = 5,
299 XEMBED_FOCUS_NEXT = 6,
300 XEMBED_FOCUS_PREV = 7,
302 XEMBED_MODALITY_ON = 10,
303 XEMBED_MODALITY_OFF = 11,
304 XEMBED_REGISTER_ACCELERATOR = 12,
305 XEMBED_UNREGISTER_ACCELERATOR = 13,
306 XEMBED_ACTIVATE_ACCELERATOR = 14
309 /* Used in x_flush. */
311 static int x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
312 static void x_set_window_size_1 (struct frame *, int, int, int);
313 static const XColor *x_color_cells (Display *, int *);
314 static void x_update_window_end (struct window *, int, int);
316 static int x_io_error_quitter (Display *);
317 static struct terminal *x_create_terminal (struct x_display_info *);
318 void x_delete_terminal (struct terminal *);
319 static void x_update_end (struct frame *);
320 static void XTframe_up_to_date (struct frame *);
321 static void XTset_terminal_modes (struct terminal *);
322 static void XTreset_terminal_modes (struct terminal *);
323 static void x_clear_frame (struct frame *);
324 static void frame_highlight (struct frame *);
325 static void frame_unhighlight (struct frame *);
326 static void x_new_focus_frame (struct x_display_info *, struct frame *);
327 static void x_focus_changed (int, int, struct x_display_info *,
328 struct frame *, struct input_event *);
329 static void x_detect_focus_change (struct x_display_info *,
330 XEvent *, struct input_event *);
331 static void XTframe_rehighlight (struct frame *);
332 static void x_frame_rehighlight (struct x_display_info *);
333 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
334 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
335 enum text_cursor_kinds);
337 static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
338 static void x_flush (struct frame *f);
339 static void x_update_begin (struct frame *);
340 static void x_update_window_begin (struct window *);
341 static void x_after_update_window_line (struct glyph_row *);
342 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
343 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
344 enum scroll_bar_part *,
345 Lisp_Object *, Lisp_Object *,
346 unsigned long *);
347 static void x_handle_net_wm_state (struct frame *, XPropertyEvent *);
348 static void x_check_fullscreen (struct frame *);
349 static void x_check_expected_move (struct frame *, int, int);
350 static void x_sync_with_move (struct frame *, int, int, int);
351 static int handle_one_xevent (struct x_display_info *, XEvent *,
352 int *, struct input_event *);
353 /* Don't declare this NO_RETURN because we want no
354 interference with debugging failing X calls. */
355 static SIGTYPE x_connection_closed (Display *, const char *);
358 /* Flush display of frame F, or of all frames if F is null. */
360 static void
361 x_flush (struct frame *f)
363 /* Don't call XFlush when it is not safe to redisplay; the X
364 connection may be broken. */
365 if (!NILP (Vinhibit_redisplay))
366 return;
368 BLOCK_INPUT;
369 if (f == NULL)
371 Lisp_Object rest, frame;
372 FOR_EACH_FRAME (rest, frame)
373 if (FRAME_X_P (XFRAME (frame)))
374 x_flush (XFRAME (frame));
376 else if (FRAME_X_P (f))
377 XFlush (FRAME_X_DISPLAY (f));
378 UNBLOCK_INPUT;
382 /* Remove calls to XFlush by defining XFlush to an empty replacement.
383 Calls to XFlush should be unnecessary because the X output buffer
384 is flushed automatically as needed by calls to XPending,
385 XNextEvent, or XWindowEvent according to the XFlush man page.
386 XTread_socket calls XPending. Removing XFlush improves
387 performance. */
389 #define XFlush(DISPLAY) (void) 0
392 /***********************************************************************
393 Debugging
394 ***********************************************************************/
396 #if 0
398 /* This is a function useful for recording debugging information about
399 the sequence of occurrences in this file. */
401 struct record
403 char *locus;
404 int type;
407 struct record event_record[100];
409 int event_record_index;
411 void
412 record_event (char *locus, int type)
414 if (event_record_index == sizeof (event_record) / sizeof (struct record))
415 event_record_index = 0;
417 event_record[event_record_index].locus = locus;
418 event_record[event_record_index].type = type;
419 event_record_index++;
422 #endif /* 0 */
426 /* Return the struct x_display_info corresponding to DPY. */
428 struct x_display_info *
429 x_display_info_for_display (Display *dpy)
431 struct x_display_info *dpyinfo;
433 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
434 if (dpyinfo->display == dpy)
435 return dpyinfo;
437 return 0;
440 #define OPAQUE 0xffffffff
442 void
443 x_set_frame_alpha (struct frame *f)
445 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
446 Display *dpy = FRAME_X_DISPLAY (f);
447 Window win = FRAME_OUTER_WINDOW (f);
448 double alpha = 1.0;
449 double alpha_min = 1.0;
450 unsigned long opac;
452 if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
453 /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
454 we must treat the former instead of the latter. */
455 win = FRAME_X_OUTPUT (f)->parent_desc;
457 if (dpyinfo->x_highlight_frame == f)
458 alpha = f->alpha[0];
459 else
460 alpha = f->alpha[1];
462 if (FLOATP (Vframe_alpha_lower_limit))
463 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
464 else if (INTEGERP (Vframe_alpha_lower_limit))
465 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
467 if (alpha < 0.0)
468 return;
469 else if (alpha > 1.0)
470 alpha = 1.0;
471 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
472 alpha = alpha_min;
474 opac = alpha * OPAQUE;
476 /* return unless necessary */
478 unsigned char *data;
479 Atom actual;
480 int rc, format;
481 unsigned long n, left;
483 x_catch_errors (dpy);
484 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
485 0L, 1L, False, XA_CARDINAL,
486 &actual, &format, &n, &left,
487 &data);
489 if (rc == Success && actual != None)
491 unsigned long value = *(unsigned long *)data;
492 XFree ((void *) data);
493 if (value == opac)
495 x_uncatch_errors ();
496 return;
501 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
502 XA_CARDINAL, 32, PropModeReplace,
503 (unsigned char *) &opac, 1L);
504 x_uncatch_errors ();
508 x_display_pixel_height (struct x_display_info *dpyinfo)
510 return HeightOfScreen (dpyinfo->screen);
514 x_display_pixel_width (struct x_display_info *dpyinfo)
516 return WidthOfScreen (dpyinfo->screen);
520 /***********************************************************************
521 Starting and ending an update
522 ***********************************************************************/
524 /* Start an update of frame F. This function is installed as a hook
525 for update_begin, i.e. it is called when update_begin is called.
526 This function is called prior to calls to x_update_window_begin for
527 each window being updated. Currently, there is nothing to do here
528 because all interesting stuff is done on a window basis. */
530 static void
531 x_update_begin (struct frame *f)
533 /* Nothing to do. */
537 /* Start update of window W. Set the global variable updated_window
538 to the window being updated and set output_cursor to the cursor
539 position of W. */
541 static void
542 x_update_window_begin (struct window *w)
544 struct frame *f = XFRAME (WINDOW_FRAME (w));
545 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
547 updated_window = w;
548 set_output_cursor (&w->cursor);
550 BLOCK_INPUT;
552 if (f == hlinfo->mouse_face_mouse_frame)
554 /* Don't do highlighting for mouse motion during the update. */
555 hlinfo->mouse_face_defer = 1;
557 /* If F needs to be redrawn, simply forget about any prior mouse
558 highlighting. */
559 if (FRAME_GARBAGED_P (f))
560 hlinfo->mouse_face_window = Qnil;
563 UNBLOCK_INPUT;
567 /* Draw a vertical window border from (x,y0) to (x,y1) */
569 static void
570 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
572 struct frame *f = XFRAME (WINDOW_FRAME (w));
573 struct face *face;
575 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
576 if (face)
577 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
578 face->foreground);
580 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
581 f->output_data.x->normal_gc, x, y0, x, y1);
584 /* End update of window W (which is equal to updated_window).
586 Draw vertical borders between horizontally adjacent windows, and
587 display W's cursor if CURSOR_ON_P is non-zero.
589 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
590 glyphs in mouse-face were overwritten. In that case we have to
591 make sure that the mouse-highlight is properly redrawn.
593 W may be a menu bar pseudo-window in case we don't have X toolkit
594 support. Such windows don't have a cursor, so don't display it
595 here. */
597 static void
598 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
600 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
602 if (!w->pseudo_window_p)
604 BLOCK_INPUT;
606 if (cursor_on_p)
607 display_and_set_cursor (w, 1, output_cursor.hpos,
608 output_cursor.vpos,
609 output_cursor.x, output_cursor.y);
611 if (draw_window_fringes (w, 1))
612 x_draw_vertical_border (w);
614 UNBLOCK_INPUT;
617 /* If a row with mouse-face was overwritten, arrange for
618 XTframe_up_to_date to redisplay the mouse highlight. */
619 if (mouse_face_overwritten_p)
621 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
622 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
623 hlinfo->mouse_face_window = Qnil;
626 updated_window = NULL;
630 /* End update of frame F. This function is installed as a hook in
631 update_end. */
633 static void
634 x_update_end (struct frame *f)
636 /* Mouse highlight may be displayed again. */
637 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
639 #ifndef XFlush
640 BLOCK_INPUT;
641 XFlush (FRAME_X_DISPLAY (f));
642 UNBLOCK_INPUT;
643 #endif
647 /* This function is called from various places in xdisp.c whenever a
648 complete update has been performed. The global variable
649 updated_window is not available here. */
651 static void
652 XTframe_up_to_date (struct frame *f)
654 if (FRAME_X_P (f))
656 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
658 if (hlinfo->mouse_face_deferred_gc
659 || f == hlinfo->mouse_face_mouse_frame)
661 BLOCK_INPUT;
662 if (hlinfo->mouse_face_mouse_frame)
663 note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
664 hlinfo->mouse_face_mouse_x,
665 hlinfo->mouse_face_mouse_y);
666 hlinfo->mouse_face_deferred_gc = 0;
667 UNBLOCK_INPUT;
673 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
674 arrow bitmaps, or clear the fringes if no bitmaps are required
675 before DESIRED_ROW is made current. The window being updated is
676 found in updated_window. This function It is called from
677 update_window_line only if it is known that there are differences
678 between bitmaps to be drawn between current row and DESIRED_ROW. */
680 static void
681 x_after_update_window_line (struct glyph_row *desired_row)
683 struct window *w = updated_window;
684 struct frame *f;
685 int width, height;
687 xassert (w);
689 if (!desired_row->mode_line_p && !w->pseudo_window_p)
690 desired_row->redraw_fringe_bitmaps_p = 1;
692 /* When a window has disappeared, make sure that no rest of
693 full-width rows stays visible in the internal border. Could
694 check here if updated_window is the leftmost/rightmost window,
695 but I guess it's not worth doing since vertically split windows
696 are almost never used, internal border is rarely set, and the
697 overhead is very small. */
698 if (windows_or_buffers_changed
699 && desired_row->full_width_p
700 && (f = XFRAME (w->frame),
701 width = FRAME_INTERNAL_BORDER_WIDTH (f),
702 width != 0)
703 && (height = desired_row->visible_height,
704 height > 0))
706 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
708 BLOCK_INPUT;
709 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
710 0, y, width, height, False);
711 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
712 FRAME_PIXEL_WIDTH (f) - width,
713 y, width, height, False);
714 UNBLOCK_INPUT;
718 static void
719 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
721 struct frame *f = XFRAME (WINDOW_FRAME (w));
722 Display *display = FRAME_X_DISPLAY (f);
723 Window window = FRAME_X_WINDOW (f);
724 GC gc = f->output_data.x->normal_gc;
725 struct face *face = p->face;
727 /* Must clip because of partially visible lines. */
728 x_clip_to_row (w, row, -1, gc);
730 if (!p->overlay_p)
732 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
734 /* In case the same realized face is used for fringes and
735 for something displayed in the text (e.g. face `region' on
736 mono-displays, the fill style may have been changed to
737 FillSolid in x_draw_glyph_string_background. */
738 if (face->stipple)
739 XSetFillStyle (display, face->gc, FillOpaqueStippled);
740 else
741 XSetForeground (display, face->gc, face->background);
743 #ifdef USE_TOOLKIT_SCROLL_BARS
744 /* If the fringe is adjacent to the left (right) scroll bar of a
745 leftmost (rightmost, respectively) window, then extend its
746 background to the gap between the fringe and the bar. */
747 if ((WINDOW_LEFTMOST_P (w)
748 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
749 || (WINDOW_RIGHTMOST_P (w)
750 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
752 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
754 if (sb_width > 0)
756 int left = WINDOW_SCROLL_BAR_AREA_X (w);
757 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
758 * FRAME_COLUMN_WIDTH (f));
760 if (bx < 0)
762 /* Bitmap fills the fringe. */
763 if (left + width == p->x)
764 bx = left + sb_width;
765 else if (p->x + p->wd == left)
766 bx = left;
767 if (bx >= 0)
769 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
771 nx = width - sb_width;
772 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
773 row->y));
774 ny = row->visible_height;
777 else
779 if (left + width == bx)
781 bx = left + sb_width;
782 nx += width - sb_width;
784 else if (bx + nx == left)
785 nx += width - sb_width;
789 #endif
790 if (bx >= 0 && nx > 0)
791 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
793 if (!face->stipple)
794 XSetForeground (display, face->gc, face->foreground);
797 if (p->which)
799 char *bits;
800 Pixmap pixmap, clipmask = (Pixmap) 0;
801 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
802 XGCValues gcv;
804 if (p->wd > 8)
805 bits = (char *) (p->bits + p->dh);
806 else
807 bits = (char *) p->bits + p->dh;
809 /* Draw the bitmap. I believe these small pixmaps can be cached
810 by the server. */
811 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
812 (p->cursor_p
813 ? (p->overlay_p ? face->background
814 : f->output_data.x->cursor_pixel)
815 : face->foreground),
816 face->background, depth);
818 if (p->overlay_p)
820 clipmask = XCreatePixmapFromBitmapData (display,
821 FRAME_X_DISPLAY_INFO (f)->root_window,
822 bits, p->wd, p->h,
823 1, 0, 1);
824 gcv.clip_mask = clipmask;
825 gcv.clip_x_origin = p->x;
826 gcv.clip_y_origin = p->y;
827 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
830 XCopyArea (display, pixmap, window, gc, 0, 0,
831 p->wd, p->h, p->x, p->y);
832 XFreePixmap (display, pixmap);
834 if (p->overlay_p)
836 gcv.clip_mask = (Pixmap) 0;
837 XChangeGC (display, gc, GCClipMask, &gcv);
838 XFreePixmap (display, clipmask);
842 XSetClipMask (display, gc, None);
847 /* This is called when starting Emacs and when restarting after
848 suspend. When starting Emacs, no X window is mapped. And nothing
849 must be done to Emacs's own window if it is suspended (though that
850 rarely happens). */
852 static void
853 XTset_terminal_modes (struct terminal *terminal)
857 /* This is called when exiting or suspending Emacs. Exiting will make
858 the X-windows go away, and suspending requires no action. */
860 static void
861 XTreset_terminal_modes (struct terminal *terminal)
866 /***********************************************************************
867 Glyph display
868 ***********************************************************************/
872 static void x_set_glyph_string_clipping (struct glyph_string *);
873 static void x_set_glyph_string_gc (struct glyph_string *);
874 static void x_draw_glyph_string_background (struct glyph_string *,
875 int);
876 static void x_draw_glyph_string_foreground (struct glyph_string *);
877 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
878 static void x_draw_glyph_string_box (struct glyph_string *);
879 static void x_draw_glyph_string (struct glyph_string *);
880 static void x_compute_glyph_string_overhangs (struct glyph_string *);
881 static void x_set_cursor_gc (struct glyph_string *);
882 static void x_set_mode_line_face_gc (struct glyph_string *);
883 static void x_set_mouse_face_gc (struct glyph_string *);
884 static int x_alloc_lighter_color (struct frame *, Display *, Colormap,
885 unsigned long *, double, int);
886 static void x_setup_relief_color (struct frame *, struct relief *,
887 double, int, unsigned long);
888 static void x_setup_relief_colors (struct glyph_string *);
889 static void x_draw_image_glyph_string (struct glyph_string *);
890 static void x_draw_image_relief (struct glyph_string *);
891 static void x_draw_image_foreground (struct glyph_string *);
892 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
893 static void x_clear_glyph_string_rect (struct glyph_string *, int,
894 int, int, int);
895 static void x_draw_relief_rect (struct frame *, int, int, int, int,
896 int, int, int, int, int, int,
897 XRectangle *);
898 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
899 int, int, int, XRectangle *);
900 static void x_scroll_bar_clear (struct frame *);
902 #if GLYPH_DEBUG
903 static void x_check_font (struct frame *, struct font *);
904 #endif
907 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
908 face. */
910 static void
911 x_set_cursor_gc (struct glyph_string *s)
913 if (s->font == FRAME_FONT (s->f)
914 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
915 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
916 && !s->cmp)
917 s->gc = s->f->output_data.x->cursor_gc;
918 else
920 /* Cursor on non-default face: must merge. */
921 XGCValues xgcv;
922 unsigned long mask;
924 xgcv.background = s->f->output_data.x->cursor_pixel;
925 xgcv.foreground = s->face->background;
927 /* If the glyph would be invisible, try a different foreground. */
928 if (xgcv.foreground == xgcv.background)
929 xgcv.foreground = s->face->foreground;
930 if (xgcv.foreground == xgcv.background)
931 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
932 if (xgcv.foreground == xgcv.background)
933 xgcv.foreground = s->face->foreground;
935 /* Make sure the cursor is distinct from text in this face. */
936 if (xgcv.background == s->face->background
937 && xgcv.foreground == s->face->foreground)
939 xgcv.background = s->face->foreground;
940 xgcv.foreground = s->face->background;
943 IF_DEBUG (x_check_font (s->f, s->font));
944 xgcv.graphics_exposures = False;
945 mask = GCForeground | GCBackground | GCGraphicsExposures;
947 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
948 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
949 mask, &xgcv);
950 else
951 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
952 = XCreateGC (s->display, s->window, mask, &xgcv);
954 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
959 /* Set up S->gc of glyph string S for drawing text in mouse face. */
961 static void
962 x_set_mouse_face_gc (struct glyph_string *s)
964 int face_id;
965 struct face *face;
967 /* What face has to be used last for the mouse face? */
968 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
969 face = FACE_FROM_ID (s->f, face_id);
970 if (face == NULL)
971 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
973 if (s->first_glyph->type == CHAR_GLYPH)
974 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
975 else
976 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
977 s->face = FACE_FROM_ID (s->f, face_id);
978 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
980 if (s->font == s->face->font)
981 s->gc = s->face->gc;
982 else
984 /* Otherwise construct scratch_cursor_gc with values from FACE
985 except for FONT. */
986 XGCValues xgcv;
987 unsigned long mask;
989 xgcv.background = s->face->background;
990 xgcv.foreground = s->face->foreground;
991 xgcv.graphics_exposures = False;
992 mask = GCForeground | GCBackground | GCGraphicsExposures;
994 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
995 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
996 mask, &xgcv);
997 else
998 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
999 = XCreateGC (s->display, s->window, mask, &xgcv);
1001 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1004 xassert (s->gc != 0);
1008 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1009 Faces to use in the mode line have already been computed when the
1010 matrix was built, so there isn't much to do, here. */
1012 static INLINE void
1013 x_set_mode_line_face_gc (struct glyph_string *s)
1015 s->gc = s->face->gc;
1019 /* Set S->gc of glyph string S for drawing that glyph string. Set
1020 S->stippled_p to a non-zero value if the face of S has a stipple
1021 pattern. */
1023 static INLINE void
1024 x_set_glyph_string_gc (struct glyph_string *s)
1026 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1028 if (s->hl == DRAW_NORMAL_TEXT)
1030 s->gc = s->face->gc;
1031 s->stippled_p = s->face->stipple != 0;
1033 else if (s->hl == DRAW_INVERSE_VIDEO)
1035 x_set_mode_line_face_gc (s);
1036 s->stippled_p = s->face->stipple != 0;
1038 else if (s->hl == DRAW_CURSOR)
1040 x_set_cursor_gc (s);
1041 s->stippled_p = 0;
1043 else if (s->hl == DRAW_MOUSE_FACE)
1045 x_set_mouse_face_gc (s);
1046 s->stippled_p = s->face->stipple != 0;
1048 else if (s->hl == DRAW_IMAGE_RAISED
1049 || s->hl == DRAW_IMAGE_SUNKEN)
1051 s->gc = s->face->gc;
1052 s->stippled_p = s->face->stipple != 0;
1054 else
1056 s->gc = s->face->gc;
1057 s->stippled_p = s->face->stipple != 0;
1060 /* GC must have been set. */
1061 xassert (s->gc != 0);
1065 /* Set clipping for output of glyph string S. S may be part of a mode
1066 line or menu if we don't have X toolkit support. */
1068 static INLINE void
1069 x_set_glyph_string_clipping (struct glyph_string *s)
1071 XRectangle *r = s->clip;
1072 int n = get_glyph_string_clip_rects (s, r, 2);
1074 if (n > 0)
1075 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1076 s->num_clips = n;
1080 /* Set SRC's clipping for output of glyph string DST. This is called
1081 when we are drawing DST's left_overhang or right_overhang only in
1082 the area of SRC. */
1084 static void
1085 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1087 XRectangle r;
1089 r.x = src->x;
1090 r.width = src->width;
1091 r.y = src->y;
1092 r.height = src->height;
1093 dst->clip[0] = r;
1094 dst->num_clips = 1;
1095 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1099 /* RIF:
1100 Compute left and right overhang of glyph string S. */
1102 static void
1103 x_compute_glyph_string_overhangs (struct glyph_string *s)
1105 if (s->cmp == NULL
1106 && (s->first_glyph->type == CHAR_GLYPH
1107 || s->first_glyph->type == COMPOSITE_GLYPH))
1109 struct font_metrics metrics;
1111 if (s->first_glyph->type == CHAR_GLYPH)
1113 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1114 struct font *font = s->font;
1115 int i;
1117 for (i = 0; i < s->nchars; i++)
1118 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1119 font->driver->text_extents (font, code, s->nchars, &metrics);
1121 else
1123 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1125 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1127 s->right_overhang = (metrics.rbearing > metrics.width
1128 ? metrics.rbearing - metrics.width : 0);
1129 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1131 else if (s->cmp)
1133 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1134 s->left_overhang = - s->cmp->lbearing;
1139 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1141 static INLINE void
1142 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1144 XGCValues xgcv;
1145 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1146 XSetForeground (s->display, s->gc, xgcv.background);
1147 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1148 XSetForeground (s->display, s->gc, xgcv.foreground);
1152 /* Draw the background of glyph_string S. If S->background_filled_p
1153 is non-zero don't draw it. FORCE_P non-zero means draw the
1154 background even if it wouldn't be drawn normally. This is used
1155 when a string preceding S draws into the background of S, or S
1156 contains the first component of a composition. */
1158 static void
1159 x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1161 /* Nothing to do if background has already been drawn or if it
1162 shouldn't be drawn in the first place. */
1163 if (!s->background_filled_p)
1165 int box_line_width = max (s->face->box_line_width, 0);
1167 if (s->stippled_p)
1169 /* Fill background with a stipple pattern. */
1170 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1171 XFillRectangle (s->display, s->window, s->gc, s->x,
1172 s->y + box_line_width,
1173 s->background_width,
1174 s->height - 2 * box_line_width);
1175 XSetFillStyle (s->display, s->gc, FillSolid);
1176 s->background_filled_p = 1;
1178 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1179 || s->font_not_found_p
1180 || s->extends_to_end_of_line_p
1181 || force_p)
1183 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1184 s->background_width,
1185 s->height - 2 * box_line_width);
1186 s->background_filled_p = 1;
1192 /* Draw the foreground of glyph string S. */
1194 static void
1195 x_draw_glyph_string_foreground (struct glyph_string *s)
1197 int i, x;
1199 /* If first glyph of S has a left box line, start drawing the text
1200 of S to the right of that box line. */
1201 if (s->face->box != FACE_NO_BOX
1202 && s->first_glyph->left_box_line_p)
1203 x = s->x + eabs (s->face->box_line_width);
1204 else
1205 x = s->x;
1207 /* Draw characters of S as rectangles if S's font could not be
1208 loaded. */
1209 if (s->font_not_found_p)
1211 for (i = 0; i < s->nchars; ++i)
1213 struct glyph *g = s->first_glyph + i;
1214 XDrawRectangle (s->display, s->window,
1215 s->gc, x, s->y, g->pixel_width - 1,
1216 s->height - 1);
1217 x += g->pixel_width;
1220 else
1222 struct font *font = s->font;
1223 int boff = font->baseline_offset;
1224 int y;
1226 if (font->vertical_centering)
1227 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1229 y = s->ybase - boff;
1230 if (s->for_overlaps
1231 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1232 font->driver->draw (s, 0, s->nchars, x, y, 0);
1233 else
1234 font->driver->draw (s, 0, s->nchars, x, y, 1);
1235 if (s->face->overstrike)
1236 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1240 /* Draw the foreground of composite glyph string S. */
1242 static void
1243 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1245 int i, j, x;
1246 struct font *font = s->font;
1248 /* If first glyph of S has a left box line, start drawing the text
1249 of S to the right of that box line. */
1250 if (s->face && s->face->box != FACE_NO_BOX
1251 && s->first_glyph->left_box_line_p)
1252 x = s->x + eabs (s->face->box_line_width);
1253 else
1254 x = s->x;
1256 /* S is a glyph string for a composition. S->cmp_from is the index
1257 of the first character drawn for glyphs of this composition.
1258 S->cmp_from == 0 means we are drawing the very first character of
1259 this composition. */
1261 /* Draw a rectangle for the composition if the font for the very
1262 first character of the composition could not be loaded. */
1263 if (s->font_not_found_p)
1265 if (s->cmp_from == 0)
1266 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1267 s->width - 1, s->height - 1);
1269 else if (! s->first_glyph->u.cmp.automatic)
1271 int y = s->ybase;
1273 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1274 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1276 int xx = x + s->cmp->offsets[j * 2];
1277 int yy = y - s->cmp->offsets[j * 2 + 1];
1279 font->driver->draw (s, j, j + 1, xx, yy, 0);
1280 if (s->face->overstrike)
1281 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1284 else
1286 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1287 Lisp_Object glyph;
1288 int y = s->ybase;
1289 int width = 0;
1291 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1293 glyph = LGSTRING_GLYPH (gstring, i);
1294 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1295 width += LGLYPH_WIDTH (glyph);
1296 else
1298 int xoff, yoff, wadjust;
1300 if (j < i)
1302 font->driver->draw (s, j, i, x, y, 0);
1303 if (s->face->overstrike)
1304 font->driver->draw (s, j, i, x + 1, y, 0);
1305 x += width;
1307 xoff = LGLYPH_XOFF (glyph);
1308 yoff = LGLYPH_YOFF (glyph);
1309 wadjust = LGLYPH_WADJUST (glyph);
1310 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1311 if (s->face->overstrike)
1312 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1313 x += wadjust;
1314 j = i + 1;
1315 width = 0;
1318 if (j < i)
1320 font->driver->draw (s, j, i, x, y, 0);
1321 if (s->face->overstrike)
1322 font->driver->draw (s, j, i, x + 1, y, 0);
1328 /* Draw the foreground of glyph string S for glyphless characters. */
1330 static void
1331 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1333 struct glyph *glyph = s->first_glyph;
1334 XChar2b char2b[8];
1335 int x, i, j;
1337 /* If first glyph of S has a left box line, start drawing the text
1338 of S to the right of that box line. */
1339 if (s->face && s->face->box != FACE_NO_BOX
1340 && s->first_glyph->left_box_line_p)
1341 x = s->x + eabs (s->face->box_line_width);
1342 else
1343 x = s->x;
1345 s->char2b = char2b;
1347 for (i = 0; i < s->nchars; i++, glyph++)
1349 char buf[7], *str = NULL;
1350 int len = glyph->u.glyphless.len;
1352 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1354 if (len > 0
1355 && CHAR_TABLE_P (Vglyphless_char_display)
1356 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1357 >= 1))
1359 Lisp_Object acronym
1360 = (! glyph->u.glyphless.for_no_font
1361 ? CHAR_TABLE_REF (Vglyphless_char_display,
1362 glyph->u.glyphless.ch)
1363 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1364 if (STRINGP (acronym))
1365 str = SSDATA (acronym);
1368 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1370 sprintf ((char *) buf, "%0*X",
1371 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1372 glyph->u.glyphless.ch);
1373 str = buf;
1376 if (str)
1378 int upper_len = (len + 1) / 2;
1379 unsigned code;
1381 /* It is assured that all LEN characters in STR is ASCII. */
1382 for (j = 0; j < len; j++)
1384 code = s->font->driver->encode_char (s->font, str[j]);
1385 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1387 s->font->driver->draw (s, 0, upper_len,
1388 x + glyph->slice.glyphless.upper_xoff,
1389 s->ybase + glyph->slice.glyphless.upper_yoff,
1391 s->font->driver->draw (s, upper_len, len,
1392 x + glyph->slice.glyphless.lower_xoff,
1393 s->ybase + glyph->slice.glyphless.lower_yoff,
1396 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1397 XDrawRectangle (s->display, s->window, s->gc,
1398 x, s->ybase - glyph->ascent,
1399 glyph->pixel_width - 1,
1400 glyph->ascent + glyph->descent - 1);
1401 x += glyph->pixel_width;
1405 #ifdef USE_X_TOOLKIT
1407 static struct frame *x_frame_of_widget (Widget);
1408 static Boolean cvt_string_to_pixel (Display *, XrmValue *, Cardinal *,
1409 XrmValue *, XrmValue *, XtPointer *);
1410 static void cvt_pixel_dtor (XtAppContext, XrmValue *, XtPointer,
1411 XrmValue *, Cardinal *);
1414 /* Return the frame on which widget WIDGET is used.. Abort if frame
1415 cannot be determined. */
1417 static struct frame *
1418 x_frame_of_widget (Widget widget)
1420 struct x_display_info *dpyinfo;
1421 Lisp_Object tail;
1422 struct frame *f;
1424 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1426 /* Find the top-level shell of the widget. Note that this function
1427 can be called when the widget is not yet realized, so XtWindow
1428 (widget) == 0. That's the reason we can't simply use
1429 x_any_window_to_frame. */
1430 while (!XtIsTopLevelShell (widget))
1431 widget = XtParent (widget);
1433 /* Look for a frame with that top-level widget. Allocate the color
1434 on that frame to get the right gamma correction value. */
1435 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1436 if (FRAMEP (XCAR (tail))
1437 && (f = XFRAME (XCAR (tail)),
1438 (FRAME_X_P (f)
1439 && f->output_data.nothing != 1
1440 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1441 && f->output_data.x->widget == widget)
1442 return f;
1444 abort ();
1448 /* Allocate the color COLOR->pixel on the screen and display of
1449 widget WIDGET in colormap CMAP. If an exact match cannot be
1450 allocated, try the nearest color available. Value is non-zero
1451 if successful. This is called from lwlib. */
1454 x_alloc_nearest_color_for_widget (Widget widget, Colormap cmap, XColor *color)
1456 struct frame *f = x_frame_of_widget (widget);
1457 return x_alloc_nearest_color (f, cmap, color);
1461 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1462 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1463 If this produces the same color as PIXEL, try a color where all RGB
1464 values have DELTA added. Return the allocated color in *PIXEL.
1465 DISPLAY is the X display, CMAP is the colormap to operate on.
1466 Value is non-zero if successful. */
1469 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1470 unsigned long *pixel, double factor, int delta)
1472 struct frame *f = x_frame_of_widget (widget);
1473 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1477 /* Structure specifying which arguments should be passed by Xt to
1478 cvt_string_to_pixel. We want the widget's screen and colormap. */
1480 static XtConvertArgRec cvt_string_to_pixel_args[] =
1482 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1483 sizeof (Screen *)},
1484 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1485 sizeof (Colormap)}
1489 /* The address of this variable is returned by
1490 cvt_string_to_pixel. */
1492 static Pixel cvt_string_to_pixel_value;
1495 /* Convert a color name to a pixel color.
1497 DPY is the display we are working on.
1499 ARGS is an array of *NARGS XrmValue structures holding additional
1500 information about the widget for which the conversion takes place.
1501 The contents of this array are determined by the specification
1502 in cvt_string_to_pixel_args.
1504 FROM is a pointer to an XrmValue which points to the color name to
1505 convert. TO is an XrmValue in which to return the pixel color.
1507 CLOSURE_RET is a pointer to user-data, in which we record if
1508 we allocated the color or not.
1510 Value is True if successful, False otherwise. */
1512 static Boolean
1513 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1514 XrmValue *from, XrmValue *to,
1515 XtPointer *closure_ret)
1517 Screen *screen;
1518 Colormap cmap;
1519 Pixel pixel;
1520 String color_name;
1521 XColor color;
1523 if (*nargs != 2)
1525 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1526 "wrongParameters", "cvt_string_to_pixel",
1527 "XtToolkitError",
1528 "Screen and colormap args required", NULL, NULL);
1529 return False;
1532 screen = *(Screen **) args[0].addr;
1533 cmap = *(Colormap *) args[1].addr;
1534 color_name = (String) from->addr;
1536 if (strcmp (color_name, XtDefaultBackground) == 0)
1538 *closure_ret = (XtPointer) False;
1539 pixel = WhitePixelOfScreen (screen);
1541 else if (strcmp (color_name, XtDefaultForeground) == 0)
1543 *closure_ret = (XtPointer) False;
1544 pixel = BlackPixelOfScreen (screen);
1546 else if (XParseColor (dpy, cmap, color_name, &color)
1547 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1549 pixel = color.pixel;
1550 *closure_ret = (XtPointer) True;
1552 else
1554 String params[1];
1555 Cardinal nparams = 1;
1557 params[0] = color_name;
1558 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1559 "badValue", "cvt_string_to_pixel",
1560 "XtToolkitError", "Invalid color `%s'",
1561 params, &nparams);
1562 return False;
1565 if (to->addr != NULL)
1567 if (to->size < sizeof (Pixel))
1569 to->size = sizeof (Pixel);
1570 return False;
1573 *(Pixel *) to->addr = pixel;
1575 else
1577 cvt_string_to_pixel_value = pixel;
1578 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1581 to->size = sizeof (Pixel);
1582 return True;
1586 /* Free a pixel color which was previously allocated via
1587 cvt_string_to_pixel. This is registered as the destructor
1588 for this type of resource via XtSetTypeConverter.
1590 APP is the application context in which we work.
1592 TO is a pointer to an XrmValue holding the color to free.
1593 CLOSURE is the value we stored in CLOSURE_RET for this color
1594 in cvt_string_to_pixel.
1596 ARGS and NARGS are like for cvt_string_to_pixel. */
1598 static void
1599 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1600 Cardinal *nargs)
1602 if (*nargs != 2)
1604 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1605 "XtToolkitError",
1606 "Screen and colormap arguments required",
1607 NULL, NULL);
1609 else if (closure != NULL)
1611 /* We did allocate the pixel, so free it. */
1612 Screen *screen = *(Screen **) args[0].addr;
1613 Colormap cmap = *(Colormap *) args[1].addr;
1614 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1615 (Pixel *) to->addr, 1);
1620 #endif /* USE_X_TOOLKIT */
1623 /* Value is an array of XColor structures for the contents of the
1624 color map of display DPY. Set *NCELLS to the size of the array.
1625 Note that this probably shouldn't be called for large color maps,
1626 say a 24-bit TrueColor map. */
1628 static const XColor *
1629 x_color_cells (Display *dpy, int *ncells)
1631 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1633 if (dpyinfo->color_cells == NULL)
1635 Screen *screen = dpyinfo->screen;
1636 int i;
1638 dpyinfo->ncolor_cells
1639 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1640 dpyinfo->color_cells
1641 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1642 * sizeof *dpyinfo->color_cells);
1644 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1645 dpyinfo->color_cells[i].pixel = i;
1647 XQueryColors (dpy, dpyinfo->cmap,
1648 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1651 *ncells = dpyinfo->ncolor_cells;
1652 return dpyinfo->color_cells;
1656 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1657 colors in COLORS. Use cached information, if available. */
1659 void
1660 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1662 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1664 if (dpyinfo->color_cells)
1666 int i;
1667 for (i = 0; i < ncolors; ++i)
1669 unsigned long pixel = colors[i].pixel;
1670 xassert (pixel < dpyinfo->ncolor_cells);
1671 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1672 colors[i] = dpyinfo->color_cells[pixel];
1675 else
1676 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1680 /* On frame F, translate pixel color to RGB values for the color in
1681 COLOR. Use cached information, if available. */
1683 void
1684 x_query_color (struct frame *f, XColor *color)
1686 x_query_colors (f, color, 1);
1690 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1691 exact match can't be allocated, try the nearest color available.
1692 Value is non-zero if successful. Set *COLOR to the color
1693 allocated. */
1695 static int
1696 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1698 int rc;
1700 rc = XAllocColor (dpy, cmap, color);
1701 if (rc == 0)
1703 /* If we got to this point, the colormap is full, so we're going
1704 to try to get the next closest color. The algorithm used is
1705 a least-squares matching, which is what X uses for closest
1706 color matching with StaticColor visuals. */
1707 int nearest, i;
1708 unsigned long nearest_delta = ~ (unsigned long) 0;
1709 int ncells;
1710 const XColor *cells = x_color_cells (dpy, &ncells);
1712 for (nearest = i = 0; i < ncells; ++i)
1714 long dred = (color->red >> 8) - (cells[i].red >> 8);
1715 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1716 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1717 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1719 if (delta < nearest_delta)
1721 nearest = i;
1722 nearest_delta = delta;
1726 color->red = cells[nearest].red;
1727 color->green = cells[nearest].green;
1728 color->blue = cells[nearest].blue;
1729 rc = XAllocColor (dpy, cmap, color);
1731 else
1733 /* If allocation succeeded, and the allocated pixel color is not
1734 equal to a cached pixel color recorded earlier, there was a
1735 change in the colormap, so clear the color cache. */
1736 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1737 XColor *cached_color;
1739 if (dpyinfo->color_cells
1740 && (cached_color = &dpyinfo->color_cells[color->pixel],
1741 (cached_color->red != color->red
1742 || cached_color->blue != color->blue
1743 || cached_color->green != color->green)))
1745 xfree (dpyinfo->color_cells);
1746 dpyinfo->color_cells = NULL;
1747 dpyinfo->ncolor_cells = 0;
1751 #ifdef DEBUG_X_COLORS
1752 if (rc)
1753 register_color (color->pixel);
1754 #endif /* DEBUG_X_COLORS */
1756 return rc;
1760 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1761 exact match can't be allocated, try the nearest color available.
1762 Value is non-zero if successful. Set *COLOR to the color
1763 allocated. */
1766 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1768 gamma_correct (f, color);
1769 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1773 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1774 It's necessary to do this instead of just using PIXEL directly to
1775 get color reference counts right. */
1777 unsigned long
1778 x_copy_color (struct frame *f, long unsigned int pixel)
1780 XColor color;
1782 color.pixel = pixel;
1783 BLOCK_INPUT;
1784 x_query_color (f, &color);
1785 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1786 UNBLOCK_INPUT;
1787 #ifdef DEBUG_X_COLORS
1788 register_color (pixel);
1789 #endif
1790 return color.pixel;
1794 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1795 It's necessary to do this instead of just using PIXEL directly to
1796 get color reference counts right. */
1798 unsigned long
1799 x_copy_dpy_color (Display *dpy, Colormap cmap, long unsigned int pixel)
1801 XColor color;
1803 color.pixel = pixel;
1804 BLOCK_INPUT;
1805 XQueryColor (dpy, cmap, &color);
1806 XAllocColor (dpy, cmap, &color);
1807 UNBLOCK_INPUT;
1808 #ifdef DEBUG_X_COLORS
1809 register_color (pixel);
1810 #endif
1811 return color.pixel;
1815 /* Brightness beyond which a color won't have its highlight brightness
1816 boosted.
1818 Nominally, highlight colors for `3d' faces are calculated by
1819 brightening an object's color by a constant scale factor, but this
1820 doesn't yield good results for dark colors, so for colors who's
1821 brightness is less than this value (on a scale of 0-65535) have an
1822 use an additional additive factor.
1824 The value here is set so that the default menu-bar/mode-line color
1825 (grey75) will not have its highlights changed at all. */
1826 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1829 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1830 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1831 If this produces the same color as PIXEL, try a color where all RGB
1832 values have DELTA added. Return the allocated color in *PIXEL.
1833 DISPLAY is the X display, CMAP is the colormap to operate on.
1834 Value is non-zero if successful. */
1836 static int
1837 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1839 XColor color, new;
1840 long bright;
1841 int success_p;
1843 /* Get RGB color values. */
1844 color.pixel = *pixel;
1845 x_query_color (f, &color);
1847 /* Change RGB values by specified FACTOR. Avoid overflow! */
1848 xassert (factor >= 0);
1849 new.red = min (0xffff, factor * color.red);
1850 new.green = min (0xffff, factor * color.green);
1851 new.blue = min (0xffff, factor * color.blue);
1853 /* Calculate brightness of COLOR. */
1854 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1856 /* We only boost colors that are darker than
1857 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1858 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1859 /* Make an additive adjustment to NEW, because it's dark enough so
1860 that scaling by FACTOR alone isn't enough. */
1862 /* How far below the limit this color is (0 - 1, 1 being darker). */
1863 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1864 /* The additive adjustment. */
1865 int min_delta = delta * dimness * factor / 2;
1867 if (factor < 1)
1869 new.red = max (0, new.red - min_delta);
1870 new.green = max (0, new.green - min_delta);
1871 new.blue = max (0, new.blue - min_delta);
1873 else
1875 new.red = min (0xffff, min_delta + new.red);
1876 new.green = min (0xffff, min_delta + new.green);
1877 new.blue = min (0xffff, min_delta + new.blue);
1881 /* Try to allocate the color. */
1882 success_p = x_alloc_nearest_color (f, cmap, &new);
1883 if (success_p)
1885 if (new.pixel == *pixel)
1887 /* If we end up with the same color as before, try adding
1888 delta to the RGB values. */
1889 x_free_colors (f, &new.pixel, 1);
1891 new.red = min (0xffff, delta + color.red);
1892 new.green = min (0xffff, delta + color.green);
1893 new.blue = min (0xffff, delta + color.blue);
1894 success_p = x_alloc_nearest_color (f, cmap, &new);
1896 else
1897 success_p = 1;
1898 *pixel = new.pixel;
1901 return success_p;
1905 /* Set up the foreground color for drawing relief lines of glyph
1906 string S. RELIEF is a pointer to a struct relief containing the GC
1907 with which lines will be drawn. Use a color that is FACTOR or
1908 DELTA lighter or darker than the relief's background which is found
1909 in S->f->output_data.x->relief_background. If such a color cannot
1910 be allocated, use DEFAULT_PIXEL, instead. */
1912 static void
1913 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1915 XGCValues xgcv;
1916 struct x_output *di = f->output_data.x;
1917 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1918 unsigned long pixel;
1919 unsigned long background = di->relief_background;
1920 Colormap cmap = FRAME_X_COLORMAP (f);
1921 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1922 Display *dpy = FRAME_X_DISPLAY (f);
1924 xgcv.graphics_exposures = False;
1925 xgcv.line_width = 1;
1927 /* Free previously allocated color. The color cell will be reused
1928 when it has been freed as many times as it was allocated, so this
1929 doesn't affect faces using the same colors. */
1930 if (relief->gc
1931 && relief->allocated_p)
1933 x_free_colors (f, &relief->pixel, 1);
1934 relief->allocated_p = 0;
1937 /* Allocate new color. */
1938 xgcv.foreground = default_pixel;
1939 pixel = background;
1940 if (dpyinfo->n_planes != 1
1941 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1943 relief->allocated_p = 1;
1944 xgcv.foreground = relief->pixel = pixel;
1947 if (relief->gc == 0)
1949 xgcv.stipple = dpyinfo->gray;
1950 mask |= GCStipple;
1951 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1953 else
1954 XChangeGC (dpy, relief->gc, mask, &xgcv);
1958 /* Set up colors for the relief lines around glyph string S. */
1960 static void
1961 x_setup_relief_colors (struct glyph_string *s)
1963 struct x_output *di = s->f->output_data.x;
1964 unsigned long color;
1966 if (s->face->use_box_color_for_shadows_p)
1967 color = s->face->box_color;
1968 else if (s->first_glyph->type == IMAGE_GLYPH
1969 && s->img->pixmap
1970 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1971 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1972 else
1974 XGCValues xgcv;
1976 /* Get the background color of the face. */
1977 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1978 color = xgcv.background;
1981 if (di->white_relief.gc == 0
1982 || color != di->relief_background)
1984 di->relief_background = color;
1985 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1986 WHITE_PIX_DEFAULT (s->f));
1987 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1988 BLACK_PIX_DEFAULT (s->f));
1993 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
1994 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
1995 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
1996 relief. LEFT_P non-zero means draw a relief on the left side of
1997 the rectangle. RIGHT_P non-zero means draw a relief on the right
1998 side of the rectangle. CLIP_RECT is the clipping rectangle to use
1999 when drawing. */
2001 static void
2002 x_draw_relief_rect (struct frame *f,
2003 int left_x, int top_y, int right_x, int bottom_y, int width,
2004 int raised_p, int top_p, int bot_p, int left_p, int right_p,
2005 XRectangle *clip_rect)
2007 Display *dpy = FRAME_X_DISPLAY (f);
2008 Window window = FRAME_X_WINDOW (f);
2009 int i;
2010 GC gc;
2012 if (raised_p)
2013 gc = f->output_data.x->white_relief.gc;
2014 else
2015 gc = f->output_data.x->black_relief.gc;
2016 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2018 /* This code is more complicated than it has to be, because of two
2019 minor hacks to make the boxes look nicer: (i) if width > 1, draw
2020 the outermost line using the black relief. (ii) Omit the four
2021 corner pixels. */
2023 /* Top. */
2024 if (top_p)
2026 if (width == 1)
2027 XDrawLine (dpy, window, gc,
2028 left_x + (left_p ? 1 : 0), top_y,
2029 right_x + (right_p ? 0 : 1), top_y);
2031 for (i = 1; i < width; ++i)
2032 XDrawLine (dpy, window, gc,
2033 left_x + i * left_p, top_y + i,
2034 right_x + 1 - i * right_p, top_y + i);
2037 /* Left. */
2038 if (left_p)
2040 if (width == 1)
2041 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2043 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2044 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2046 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2047 XDrawLine (dpy, window, gc,
2048 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2051 XSetClipMask (dpy, gc, None);
2052 if (raised_p)
2053 gc = f->output_data.x->black_relief.gc;
2054 else
2055 gc = f->output_data.x->white_relief.gc;
2056 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2058 if (width > 1)
2060 /* Outermost top line. */
2061 if (top_p)
2062 XDrawLine (dpy, window, gc,
2063 left_x + (left_p ? 1 : 0), top_y,
2064 right_x + (right_p ? 0 : 1), top_y);
2066 /* Outermost left line. */
2067 if (left_p)
2068 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2071 /* Bottom. */
2072 if (bot_p)
2074 XDrawLine (dpy, window, gc,
2075 left_x + (left_p ? 1 : 0), bottom_y,
2076 right_x + (right_p ? 0 : 1), bottom_y);
2077 for (i = 1; i < width; ++i)
2078 XDrawLine (dpy, window, gc,
2079 left_x + i * left_p, bottom_y - i,
2080 right_x + 1 - i * right_p, bottom_y - i);
2083 /* Right. */
2084 if (right_p)
2086 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2087 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2088 for (i = 0; i < width; ++i)
2089 XDrawLine (dpy, window, gc,
2090 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2093 XSetClipMask (dpy, gc, None);
2097 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2098 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2099 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2100 left side of the rectangle. RIGHT_P non-zero means draw a line
2101 on the right side of the rectangle. CLIP_RECT is the clipping
2102 rectangle to use when drawing. */
2104 static void
2105 x_draw_box_rect (struct glyph_string *s,
2106 int left_x, int top_y, int right_x, int bottom_y, int width,
2107 int left_p, int right_p, XRectangle *clip_rect)
2109 XGCValues xgcv;
2111 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2112 XSetForeground (s->display, s->gc, s->face->box_color);
2113 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2115 /* Top. */
2116 XFillRectangle (s->display, s->window, s->gc,
2117 left_x, top_y, right_x - left_x + 1, width);
2119 /* Left. */
2120 if (left_p)
2121 XFillRectangle (s->display, s->window, s->gc,
2122 left_x, top_y, width, bottom_y - top_y + 1);
2124 /* Bottom. */
2125 XFillRectangle (s->display, s->window, s->gc,
2126 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2128 /* Right. */
2129 if (right_p)
2130 XFillRectangle (s->display, s->window, s->gc,
2131 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2133 XSetForeground (s->display, s->gc, xgcv.foreground);
2134 XSetClipMask (s->display, s->gc, None);
2138 /* Draw a box around glyph string S. */
2140 static void
2141 x_draw_glyph_string_box (struct glyph_string *s)
2143 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2144 int left_p, right_p;
2145 struct glyph *last_glyph;
2146 XRectangle clip_rect;
2148 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2149 ? WINDOW_RIGHT_EDGE_X (s->w)
2150 : window_box_right (s->w, s->area));
2152 /* The glyph that may have a right box line. */
2153 last_glyph = (s->cmp || s->img
2154 ? s->first_glyph
2155 : s->first_glyph + s->nchars - 1);
2157 width = eabs (s->face->box_line_width);
2158 raised_p = s->face->box == FACE_RAISED_BOX;
2159 left_x = s->x;
2160 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2161 ? last_x - 1
2162 : min (last_x, s->x + s->background_width) - 1);
2163 top_y = s->y;
2164 bottom_y = top_y + s->height - 1;
2166 left_p = (s->first_glyph->left_box_line_p
2167 || (s->hl == DRAW_MOUSE_FACE
2168 && (s->prev == NULL
2169 || s->prev->hl != s->hl)));
2170 right_p = (last_glyph->right_box_line_p
2171 || (s->hl == DRAW_MOUSE_FACE
2172 && (s->next == NULL
2173 || s->next->hl != s->hl)));
2175 get_glyph_string_clip_rect (s, &clip_rect);
2177 if (s->face->box == FACE_SIMPLE_BOX)
2178 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2179 left_p, right_p, &clip_rect);
2180 else
2182 x_setup_relief_colors (s);
2183 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2184 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2189 /* Draw foreground of image glyph string S. */
2191 static void
2192 x_draw_image_foreground (struct glyph_string *s)
2194 int x = s->x;
2195 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2197 /* If first glyph of S has a left box line, start drawing it to the
2198 right of that line. */
2199 if (s->face->box != FACE_NO_BOX
2200 && s->first_glyph->left_box_line_p
2201 && s->slice.x == 0)
2202 x += eabs (s->face->box_line_width);
2204 /* If there is a margin around the image, adjust x- and y-position
2205 by that margin. */
2206 if (s->slice.x == 0)
2207 x += s->img->hmargin;
2208 if (s->slice.y == 0)
2209 y += s->img->vmargin;
2211 if (s->img->pixmap)
2213 if (s->img->mask)
2215 /* We can't set both a clip mask and use XSetClipRectangles
2216 because the latter also sets a clip mask. We also can't
2217 trust on the shape extension to be available
2218 (XShapeCombineRegion). So, compute the rectangle to draw
2219 manually. */
2220 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2221 | GCFunction);
2222 XGCValues xgcv;
2223 XRectangle clip_rect, image_rect, r;
2225 xgcv.clip_mask = s->img->mask;
2226 xgcv.clip_x_origin = x;
2227 xgcv.clip_y_origin = y;
2228 xgcv.function = GXcopy;
2229 XChangeGC (s->display, s->gc, mask, &xgcv);
2231 get_glyph_string_clip_rect (s, &clip_rect);
2232 image_rect.x = x;
2233 image_rect.y = y;
2234 image_rect.width = s->slice.width;
2235 image_rect.height = s->slice.height;
2236 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2237 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2238 s->slice.x + r.x - x, s->slice.y + r.y - y,
2239 r.width, r.height, r.x, r.y);
2241 else
2243 XRectangle clip_rect, image_rect, r;
2245 get_glyph_string_clip_rect (s, &clip_rect);
2246 image_rect.x = x;
2247 image_rect.y = y;
2248 image_rect.width = s->slice.width;
2249 image_rect.height = s->slice.height;
2250 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2251 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2252 s->slice.x + r.x - x, s->slice.y + r.y - y,
2253 r.width, r.height, r.x, r.y);
2255 /* When the image has a mask, we can expect that at
2256 least part of a mouse highlight or a block cursor will
2257 be visible. If the image doesn't have a mask, make
2258 a block cursor visible by drawing a rectangle around
2259 the image. I believe it's looking better if we do
2260 nothing here for mouse-face. */
2261 if (s->hl == DRAW_CURSOR)
2263 int r = s->img->relief;
2264 if (r < 0) r = -r;
2265 XDrawRectangle (s->display, s->window, s->gc,
2266 x - r, y - r,
2267 s->slice.width + r*2 - 1,
2268 s->slice.height + r*2 - 1);
2272 else
2273 /* Draw a rectangle if image could not be loaded. */
2274 XDrawRectangle (s->display, s->window, s->gc, x, y,
2275 s->slice.width - 1, s->slice.height - 1);
2279 /* Draw a relief around the image glyph string S. */
2281 static void
2282 x_draw_image_relief (struct glyph_string *s)
2284 int x0, y0, x1, y1, thick, raised_p, extra;
2285 XRectangle r;
2286 int x = s->x;
2287 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2289 /* If first glyph of S has a left box line, start drawing it to the
2290 right of that line. */
2291 if (s->face->box != FACE_NO_BOX
2292 && s->first_glyph->left_box_line_p
2293 && s->slice.x == 0)
2294 x += eabs (s->face->box_line_width);
2296 /* If there is a margin around the image, adjust x- and y-position
2297 by that margin. */
2298 if (s->slice.x == 0)
2299 x += s->img->hmargin;
2300 if (s->slice.y == 0)
2301 y += s->img->vmargin;
2303 if (s->hl == DRAW_IMAGE_SUNKEN
2304 || s->hl == DRAW_IMAGE_RAISED)
2306 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2307 raised_p = s->hl == DRAW_IMAGE_RAISED;
2309 else
2311 thick = eabs (s->img->relief);
2312 raised_p = s->img->relief > 0;
2315 extra = s->face->id == TOOL_BAR_FACE_ID
2316 ? XINT (Vtool_bar_button_margin) : 0;
2318 x0 = x - thick - extra;
2319 y0 = y - thick - extra;
2320 x1 = x + s->slice.width + thick - 1 + extra;
2321 y1 = y + s->slice.height + thick - 1 + extra;
2323 x_setup_relief_colors (s);
2324 get_glyph_string_clip_rect (s, &r);
2325 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2326 s->slice.y == 0,
2327 s->slice.y + s->slice.height == s->img->height,
2328 s->slice.x == 0,
2329 s->slice.x + s->slice.width == s->img->width,
2330 &r);
2334 /* Draw the foreground of image glyph string S to PIXMAP. */
2336 static void
2337 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2339 int x = 0;
2340 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2342 /* If first glyph of S has a left box line, start drawing it to the
2343 right of that line. */
2344 if (s->face->box != FACE_NO_BOX
2345 && s->first_glyph->left_box_line_p
2346 && s->slice.x == 0)
2347 x += eabs (s->face->box_line_width);
2349 /* If there is a margin around the image, adjust x- and y-position
2350 by that margin. */
2351 if (s->slice.x == 0)
2352 x += s->img->hmargin;
2353 if (s->slice.y == 0)
2354 y += s->img->vmargin;
2356 if (s->img->pixmap)
2358 if (s->img->mask)
2360 /* We can't set both a clip mask and use XSetClipRectangles
2361 because the latter also sets a clip mask. We also can't
2362 trust on the shape extension to be available
2363 (XShapeCombineRegion). So, compute the rectangle to draw
2364 manually. */
2365 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2366 | GCFunction);
2367 XGCValues xgcv;
2369 xgcv.clip_mask = s->img->mask;
2370 xgcv.clip_x_origin = x - s->slice.x;
2371 xgcv.clip_y_origin = y - s->slice.y;
2372 xgcv.function = GXcopy;
2373 XChangeGC (s->display, s->gc, mask, &xgcv);
2375 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2376 s->slice.x, s->slice.y,
2377 s->slice.width, s->slice.height, x, y);
2378 XSetClipMask (s->display, s->gc, None);
2380 else
2382 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2383 s->slice.x, s->slice.y,
2384 s->slice.width, s->slice.height, x, y);
2386 /* When the image has a mask, we can expect that at
2387 least part of a mouse highlight or a block cursor will
2388 be visible. If the image doesn't have a mask, make
2389 a block cursor visible by drawing a rectangle around
2390 the image. I believe it's looking better if we do
2391 nothing here for mouse-face. */
2392 if (s->hl == DRAW_CURSOR)
2394 int r = s->img->relief;
2395 if (r < 0) r = -r;
2396 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2397 s->slice.width + r*2 - 1,
2398 s->slice.height + r*2 - 1);
2402 else
2403 /* Draw a rectangle if image could not be loaded. */
2404 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2405 s->slice.width - 1, s->slice.height - 1);
2409 /* Draw part of the background of glyph string S. X, Y, W, and H
2410 give the rectangle to draw. */
2412 static void
2413 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2415 if (s->stippled_p)
2417 /* Fill background with a stipple pattern. */
2418 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2419 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2420 XSetFillStyle (s->display, s->gc, FillSolid);
2422 else
2423 x_clear_glyph_string_rect (s, x, y, w, h);
2427 /* Draw image glyph string S.
2429 s->y
2430 s->x +-------------------------
2431 | s->face->box
2433 | +-------------------------
2434 | | s->img->margin
2436 | | +-------------------
2437 | | | the image
2441 static void
2442 x_draw_image_glyph_string (struct glyph_string *s)
2444 int box_line_hwidth = eabs (s->face->box_line_width);
2445 int box_line_vwidth = max (s->face->box_line_width, 0);
2446 int height;
2447 Pixmap pixmap = None;
2449 height = s->height;
2450 if (s->slice.y == 0)
2451 height -= box_line_vwidth;
2452 if (s->slice.y + s->slice.height >= s->img->height)
2453 height -= box_line_vwidth;
2455 /* Fill background with face under the image. Do it only if row is
2456 taller than image or if image has a clip mask to reduce
2457 flickering. */
2458 s->stippled_p = s->face->stipple != 0;
2459 if (height > s->slice.height
2460 || s->img->hmargin
2461 || s->img->vmargin
2462 || s->img->mask
2463 || s->img->pixmap == 0
2464 || s->width != s->background_width)
2466 if (s->img->mask)
2468 /* Create a pixmap as large as the glyph string. Fill it
2469 with the background color. Copy the image to it, using
2470 its mask. Copy the temporary pixmap to the display. */
2471 Screen *screen = FRAME_X_SCREEN (s->f);
2472 int depth = DefaultDepthOfScreen (screen);
2474 /* Create a pixmap as large as the glyph string. */
2475 pixmap = XCreatePixmap (s->display, s->window,
2476 s->background_width,
2477 s->height, depth);
2479 /* Don't clip in the following because we're working on the
2480 pixmap. */
2481 XSetClipMask (s->display, s->gc, None);
2483 /* Fill the pixmap with the background color/stipple. */
2484 if (s->stippled_p)
2486 /* Fill background with a stipple pattern. */
2487 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2488 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2489 XFillRectangle (s->display, pixmap, s->gc,
2490 0, 0, s->background_width, s->height);
2491 XSetFillStyle (s->display, s->gc, FillSolid);
2492 XSetTSOrigin (s->display, s->gc, 0, 0);
2494 else
2496 XGCValues xgcv;
2497 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2498 &xgcv);
2499 XSetForeground (s->display, s->gc, xgcv.background);
2500 XFillRectangle (s->display, pixmap, s->gc,
2501 0, 0, s->background_width, s->height);
2502 XSetForeground (s->display, s->gc, xgcv.foreground);
2505 else
2507 int x = s->x;
2508 int y = s->y;
2510 if (s->first_glyph->left_box_line_p
2511 && s->slice.x == 0)
2512 x += box_line_hwidth;
2514 if (s->slice.y == 0)
2515 y += box_line_vwidth;
2517 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2520 s->background_filled_p = 1;
2523 /* Draw the foreground. */
2524 if (pixmap != None)
2526 x_draw_image_foreground_1 (s, pixmap);
2527 x_set_glyph_string_clipping (s);
2528 XCopyArea (s->display, pixmap, s->window, s->gc,
2529 0, 0, s->background_width, s->height, s->x, s->y);
2530 XFreePixmap (s->display, pixmap);
2532 else
2533 x_draw_image_foreground (s);
2535 /* If we must draw a relief around the image, do it. */
2536 if (s->img->relief
2537 || s->hl == DRAW_IMAGE_RAISED
2538 || s->hl == DRAW_IMAGE_SUNKEN)
2539 x_draw_image_relief (s);
2543 /* Draw stretch glyph string S. */
2545 static void
2546 x_draw_stretch_glyph_string (struct glyph_string *s)
2548 xassert (s->first_glyph->type == STRETCH_GLYPH);
2550 if (s->hl == DRAW_CURSOR
2551 && !x_stretch_cursor_p)
2553 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2554 wide as the stretch glyph. */
2555 int width, background_width = s->background_width;
2556 int x = s->x;
2558 if (!s->row->reversed_p)
2560 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2562 if (x < left_x)
2564 background_width -= left_x - x;
2565 x = left_x;
2568 else
2570 /* In R2L rows, draw the cursor on the right edge of the
2571 stretch glyph. */
2572 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2574 if (x + background_width > right_x)
2575 background_width -= x - right_x;
2576 x += background_width;
2578 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2579 if (s->row->reversed_p)
2580 x -= width;
2582 /* Draw cursor. */
2583 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2585 /* Clear rest using the GC of the original non-cursor face. */
2586 if (width < background_width)
2588 int y = s->y;
2589 int w = background_width - width, h = s->height;
2590 XRectangle r;
2591 GC gc;
2593 if (!s->row->reversed_p)
2594 x += width;
2595 else
2596 x = s->x;
2597 if (s->row->mouse_face_p
2598 && cursor_in_mouse_face_p (s->w))
2600 x_set_mouse_face_gc (s);
2601 gc = s->gc;
2603 else
2604 gc = s->face->gc;
2606 get_glyph_string_clip_rect (s, &r);
2607 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2609 if (s->face->stipple)
2611 /* Fill background with a stipple pattern. */
2612 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2613 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2614 XSetFillStyle (s->display, gc, FillSolid);
2616 else
2618 XGCValues xgcv;
2619 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2620 XSetForeground (s->display, gc, xgcv.background);
2621 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2622 XSetForeground (s->display, gc, xgcv.foreground);
2626 else if (!s->background_filled_p)
2628 int background_width = s->background_width;
2629 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2631 /* Don't draw into left margin, fringe or scrollbar area
2632 except for header line and mode line. */
2633 if (x < left_x && !s->row->mode_line_p)
2635 background_width -= left_x - x;
2636 x = left_x;
2638 if (background_width > 0)
2639 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2642 s->background_filled_p = 1;
2646 /* Draw glyph string S. */
2648 static void
2649 x_draw_glyph_string (struct glyph_string *s)
2651 int relief_drawn_p = 0;
2653 /* If S draws into the background of its successors, draw the
2654 background of the successors first so that S can draw into it.
2655 This makes S->next use XDrawString instead of XDrawImageString. */
2656 if (s->next && s->right_overhang && !s->for_overlaps)
2658 int width;
2659 struct glyph_string *next;
2661 for (width = 0, next = s->next;
2662 next && width < s->right_overhang;
2663 width += next->width, next = next->next)
2664 if (next->first_glyph->type != IMAGE_GLYPH)
2666 x_set_glyph_string_gc (next);
2667 x_set_glyph_string_clipping (next);
2668 if (next->first_glyph->type == STRETCH_GLYPH)
2669 x_draw_stretch_glyph_string (next);
2670 else
2671 x_draw_glyph_string_background (next, 1);
2672 next->num_clips = 0;
2676 /* Set up S->gc, set clipping and draw S. */
2677 x_set_glyph_string_gc (s);
2679 /* Draw relief (if any) in advance for char/composition so that the
2680 glyph string can be drawn over it. */
2681 if (!s->for_overlaps
2682 && s->face->box != FACE_NO_BOX
2683 && (s->first_glyph->type == CHAR_GLYPH
2684 || s->first_glyph->type == COMPOSITE_GLYPH))
2687 x_set_glyph_string_clipping (s);
2688 x_draw_glyph_string_background (s, 1);
2689 x_draw_glyph_string_box (s);
2690 x_set_glyph_string_clipping (s);
2691 relief_drawn_p = 1;
2693 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2694 && !s->clip_tail
2695 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2696 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2697 /* We must clip just this glyph. left_overhang part has already
2698 drawn when s->prev was drawn, and right_overhang part will be
2699 drawn later when s->next is drawn. */
2700 x_set_glyph_string_clipping_exactly (s, s);
2701 else
2702 x_set_glyph_string_clipping (s);
2704 switch (s->first_glyph->type)
2706 case IMAGE_GLYPH:
2707 x_draw_image_glyph_string (s);
2708 break;
2710 case STRETCH_GLYPH:
2711 x_draw_stretch_glyph_string (s);
2712 break;
2714 case CHAR_GLYPH:
2715 if (s->for_overlaps)
2716 s->background_filled_p = 1;
2717 else
2718 x_draw_glyph_string_background (s, 0);
2719 x_draw_glyph_string_foreground (s);
2720 break;
2722 case COMPOSITE_GLYPH:
2723 if (s->for_overlaps || (s->cmp_from > 0
2724 && ! s->first_glyph->u.cmp.automatic))
2725 s->background_filled_p = 1;
2726 else
2727 x_draw_glyph_string_background (s, 1);
2728 x_draw_composite_glyph_string_foreground (s);
2729 break;
2731 case GLYPHLESS_GLYPH:
2732 if (s->for_overlaps)
2733 s->background_filled_p = 1;
2734 else
2735 x_draw_glyph_string_background (s, 1);
2736 x_draw_glyphless_glyph_string_foreground (s);
2737 break;
2739 default:
2740 abort ();
2743 if (!s->for_overlaps)
2745 /* Draw underline. */
2746 if (s->face->underline_p)
2748 unsigned long thickness, position;
2749 int y;
2751 if (s->prev && s->prev->face->underline_p)
2753 /* We use the same underline style as the previous one. */
2754 thickness = s->prev->underline_thickness;
2755 position = s->prev->underline_position;
2757 else
2759 /* Get the underline thickness. Default is 1 pixel. */
2760 if (s->font && s->font->underline_thickness > 0)
2761 thickness = s->font->underline_thickness;
2762 else
2763 thickness = 1;
2764 if (x_underline_at_descent_line)
2765 position = (s->height - thickness) - (s->ybase - s->y);
2766 else
2768 /* Get the underline position. This is the recommended
2769 vertical offset in pixels from the baseline to the top of
2770 the underline. This is a signed value according to the
2771 specs, and its default is
2773 ROUND ((maximum descent) / 2), with
2774 ROUND(x) = floor (x + 0.5) */
2776 if (x_use_underline_position_properties
2777 && s->font && s->font->underline_position >= 0)
2778 position = s->font->underline_position;
2779 else if (s->font)
2780 position = (s->font->descent + 1) / 2;
2781 else
2782 position = underline_minimum_offset;
2784 position = max (position, underline_minimum_offset);
2786 /* Check the sanity of thickness and position. We should
2787 avoid drawing underline out of the current line area. */
2788 if (s->y + s->height <= s->ybase + position)
2789 position = (s->height - 1) - (s->ybase - s->y);
2790 if (s->y + s->height < s->ybase + position + thickness)
2791 thickness = (s->y + s->height) - (s->ybase + position);
2792 s->underline_thickness = thickness;
2793 s->underline_position = position;
2794 y = s->ybase + position;
2795 if (s->face->underline_defaulted_p)
2796 XFillRectangle (s->display, s->window, s->gc,
2797 s->x, y, s->width, thickness);
2798 else
2800 XGCValues xgcv;
2801 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2802 XSetForeground (s->display, s->gc, s->face->underline_color);
2803 XFillRectangle (s->display, s->window, s->gc,
2804 s->x, y, s->width, thickness);
2805 XSetForeground (s->display, s->gc, xgcv.foreground);
2809 /* Draw overline. */
2810 if (s->face->overline_p)
2812 unsigned long dy = 0, h = 1;
2814 if (s->face->overline_color_defaulted_p)
2815 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2816 s->width, h);
2817 else
2819 XGCValues xgcv;
2820 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2821 XSetForeground (s->display, s->gc, s->face->overline_color);
2822 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2823 s->width, h);
2824 XSetForeground (s->display, s->gc, xgcv.foreground);
2828 /* Draw strike-through. */
2829 if (s->face->strike_through_p)
2831 unsigned long h = 1;
2832 unsigned long dy = (s->height - h) / 2;
2834 if (s->face->strike_through_color_defaulted_p)
2835 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2836 s->width, h);
2837 else
2839 XGCValues xgcv;
2840 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2841 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2842 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2843 s->width, h);
2844 XSetForeground (s->display, s->gc, xgcv.foreground);
2848 /* Draw relief if not yet drawn. */
2849 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2850 x_draw_glyph_string_box (s);
2852 if (s->prev)
2854 struct glyph_string *prev;
2856 for (prev = s->prev; prev; prev = prev->prev)
2857 if (prev->hl != s->hl
2858 && prev->x + prev->width + prev->right_overhang > s->x)
2860 /* As prev was drawn while clipped to its own area, we
2861 must draw the right_overhang part using s->hl now. */
2862 enum draw_glyphs_face save = prev->hl;
2864 prev->hl = s->hl;
2865 x_set_glyph_string_gc (prev);
2866 x_set_glyph_string_clipping_exactly (s, prev);
2867 if (prev->first_glyph->type == CHAR_GLYPH)
2868 x_draw_glyph_string_foreground (prev);
2869 else
2870 x_draw_composite_glyph_string_foreground (prev);
2871 XSetClipMask (prev->display, prev->gc, None);
2872 prev->hl = save;
2873 prev->num_clips = 0;
2877 if (s->next)
2879 struct glyph_string *next;
2881 for (next = s->next; next; next = next->next)
2882 if (next->hl != s->hl
2883 && next->x - next->left_overhang < s->x + s->width)
2885 /* As next will be drawn while clipped to its own area,
2886 we must draw the left_overhang part using s->hl now. */
2887 enum draw_glyphs_face save = next->hl;
2889 next->hl = s->hl;
2890 x_set_glyph_string_gc (next);
2891 x_set_glyph_string_clipping_exactly (s, next);
2892 if (next->first_glyph->type == CHAR_GLYPH)
2893 x_draw_glyph_string_foreground (next);
2894 else
2895 x_draw_composite_glyph_string_foreground (next);
2896 XSetClipMask (next->display, next->gc, None);
2897 next->hl = save;
2898 next->num_clips = 0;
2903 /* Reset clipping. */
2904 XSetClipMask (s->display, s->gc, None);
2905 s->num_clips = 0;
2908 /* Shift display to make room for inserted glyphs. */
2910 void
2911 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2913 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2914 f->output_data.x->normal_gc,
2915 x, y, width, height,
2916 x + shift_by, y);
2919 /* Delete N glyphs at the nominal cursor position. Not implemented
2920 for X frames. */
2922 static void
2923 x_delete_glyphs (struct frame *f, register int n)
2925 abort ();
2929 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2930 If they are <= 0, this is probably an error. */
2932 void
2933 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
2935 xassert (width > 0 && height > 0);
2936 XClearArea (dpy, window, x, y, width, height, exposures);
2940 /* Clear an entire frame. */
2942 static void
2943 x_clear_frame (struct frame *f)
2945 /* Clearing the frame will erase any cursor, so mark them all as no
2946 longer visible. */
2947 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2948 output_cursor.hpos = output_cursor.vpos = 0;
2949 output_cursor.x = -1;
2951 /* We don't set the output cursor here because there will always
2952 follow an explicit cursor_to. */
2953 BLOCK_INPUT;
2954 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2956 /* We have to clear the scroll bars, too. If we have changed
2957 colors or something like that, then they should be notified. */
2958 x_scroll_bar_clear (f);
2960 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
2961 /* Make sure scroll bars are redrawn. As they aren't redrawn by
2962 redisplay, do it here. */
2963 if (FRAME_GTK_WIDGET (f))
2964 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
2965 #endif
2967 XFlush (FRAME_X_DISPLAY (f));
2969 UNBLOCK_INPUT;
2974 /* Invert the middle quarter of the frame for .15 sec. */
2976 /* We use the select system call to do the waiting, so we have to make
2977 sure it's available. If it isn't, we just won't do visual bells. */
2979 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2982 /* Subtract the `struct timeval' values X and Y, storing the result in
2983 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2985 static int
2986 timeval_subtract (struct timeval *result, struct timeval x, struct timeval y)
2988 /* Perform the carry for the later subtraction by updating y. This
2989 is safer because on some systems the tv_sec member is unsigned. */
2990 if (x.tv_usec < y.tv_usec)
2992 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2993 y.tv_usec -= 1000000 * nsec;
2994 y.tv_sec += nsec;
2997 if (x.tv_usec - y.tv_usec > 1000000)
2999 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
3000 y.tv_usec += 1000000 * nsec;
3001 y.tv_sec -= nsec;
3004 /* Compute the time remaining to wait. tv_usec is certainly
3005 positive. */
3006 result->tv_sec = x.tv_sec - y.tv_sec;
3007 result->tv_usec = x.tv_usec - y.tv_usec;
3009 /* Return indication of whether the result should be considered
3010 negative. */
3011 return x.tv_sec < y.tv_sec;
3014 void
3015 XTflash (struct frame *f)
3017 BLOCK_INPUT;
3020 #ifdef USE_GTK
3021 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3022 when the scroll bars and the edit widget share the same X window. */
3023 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3024 GdkGCValues vals;
3025 GdkGC *gc;
3026 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3027 ^ FRAME_BACKGROUND_PIXEL (f));
3028 vals.function = GDK_XOR;
3029 gc = gdk_gc_new_with_values (window,
3030 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3031 #define XFillRectangle(d, win, gc, x, y, w, h) \
3032 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
3033 #else
3034 GC gc;
3036 /* Create a GC that will use the GXxor function to flip foreground
3037 pixels into background pixels. */
3039 XGCValues values;
3041 values.function = GXxor;
3042 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3043 ^ FRAME_BACKGROUND_PIXEL (f));
3045 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3046 GCFunction | GCForeground, &values);
3048 #endif
3050 /* Get the height not including a menu bar widget. */
3051 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3052 /* Height of each line to flash. */
3053 int flash_height = FRAME_LINE_HEIGHT (f);
3054 /* These will be the left and right margins of the rectangles. */
3055 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3056 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3058 int width;
3060 /* Don't flash the area between a scroll bar and the frame
3061 edge it is next to. */
3062 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3064 case vertical_scroll_bar_left:
3065 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3066 break;
3068 case vertical_scroll_bar_right:
3069 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3070 break;
3072 default:
3073 break;
3076 width = flash_right - flash_left;
3078 /* If window is tall, flash top and bottom line. */
3079 if (height > 3 * FRAME_LINE_HEIGHT (f))
3081 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3082 flash_left,
3083 (FRAME_INTERNAL_BORDER_WIDTH (f)
3084 + FRAME_TOP_MARGIN_HEIGHT (f)),
3085 width, flash_height);
3086 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3087 flash_left,
3088 (height - flash_height
3089 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3090 width, flash_height);
3093 else
3094 /* If it is short, flash it all. */
3095 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3096 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3097 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3099 x_flush (f);
3102 struct timeval wakeup;
3104 EMACS_GET_TIME (wakeup);
3106 /* Compute time to wait until, propagating carry from usecs. */
3107 wakeup.tv_usec += 150000;
3108 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3109 wakeup.tv_usec %= 1000000;
3111 /* Keep waiting until past the time wakeup or any input gets
3112 available. */
3113 while (! detect_input_pending ())
3115 struct timeval current;
3116 struct timeval timeout;
3118 EMACS_GET_TIME (current);
3120 /* Break if result would be negative. */
3121 if (timeval_subtract (&current, wakeup, current))
3122 break;
3124 /* How long `select' should wait. */
3125 timeout.tv_sec = 0;
3126 timeout.tv_usec = 10000;
3128 /* Try to wait that long--but we might wake up sooner. */
3129 select (0, NULL, NULL, NULL, &timeout);
3133 /* If window is tall, flash top and bottom line. */
3134 if (height > 3 * FRAME_LINE_HEIGHT (f))
3136 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3137 flash_left,
3138 (FRAME_INTERNAL_BORDER_WIDTH (f)
3139 + FRAME_TOP_MARGIN_HEIGHT (f)),
3140 width, flash_height);
3141 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3142 flash_left,
3143 (height - flash_height
3144 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3145 width, flash_height);
3147 else
3148 /* If it is short, flash it all. */
3149 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3150 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3151 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3153 #ifdef USE_GTK
3154 g_object_unref (G_OBJECT (gc));
3155 #undef XFillRectangle
3156 #else
3157 XFreeGC (FRAME_X_DISPLAY (f), gc);
3158 #endif
3159 x_flush (f);
3163 UNBLOCK_INPUT;
3166 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3169 static void
3170 XTtoggle_invisible_pointer (FRAME_PTR f, int invisible)
3172 BLOCK_INPUT;
3173 if (invisible)
3175 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3176 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3177 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3179 else
3180 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3181 f->output_data.x->current_cursor);
3182 f->pointer_invisible = invisible;
3183 UNBLOCK_INPUT;
3187 /* Make audible bell. */
3189 void
3190 XTring_bell (struct frame *f)
3192 if (FRAME_X_DISPLAY (f))
3194 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3195 if (visible_bell)
3196 XTflash (f);
3197 else
3198 #endif
3200 BLOCK_INPUT;
3201 XBell (FRAME_X_DISPLAY (f), 0);
3202 XFlush (FRAME_X_DISPLAY (f));
3203 UNBLOCK_INPUT;
3209 /* Specify how many text lines, from the top of the window,
3210 should be affected by insert-lines and delete-lines operations.
3211 This, and those operations, are used only within an update
3212 that is bounded by calls to x_update_begin and x_update_end. */
3214 static void
3215 XTset_terminal_window (struct frame *f, int n)
3217 /* This function intentionally left blank. */
3222 /***********************************************************************
3223 Line Dance
3224 ***********************************************************************/
3226 /* Perform an insert-lines or delete-lines operation, inserting N
3227 lines or deleting -N lines at vertical position VPOS. */
3229 static void
3230 x_ins_del_lines (struct frame *f, int vpos, int n)
3232 abort ();
3236 /* Scroll part of the display as described by RUN. */
3238 static void
3239 x_scroll_run (struct window *w, struct run *run)
3241 struct frame *f = XFRAME (w->frame);
3242 int x, y, width, height, from_y, to_y, bottom_y;
3244 /* Get frame-relative bounding box of the text display area of W,
3245 without mode lines. Include in this box the left and right
3246 fringe of W. */
3247 window_box (w, -1, &x, &y, &width, &height);
3249 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3250 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3251 bottom_y = y + height;
3253 if (to_y < from_y)
3255 /* Scrolling up. Make sure we don't copy part of the mode
3256 line at the bottom. */
3257 if (from_y + run->height > bottom_y)
3258 height = bottom_y - from_y;
3259 else
3260 height = run->height;
3262 else
3264 /* Scolling down. Make sure we don't copy over the mode line.
3265 at the bottom. */
3266 if (to_y + run->height > bottom_y)
3267 height = bottom_y - to_y;
3268 else
3269 height = run->height;
3272 BLOCK_INPUT;
3274 /* Cursor off. Will be switched on again in x_update_window_end. */
3275 updated_window = w;
3276 x_clear_cursor (w);
3278 XCopyArea (FRAME_X_DISPLAY (f),
3279 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3280 f->output_data.x->normal_gc,
3281 x, from_y,
3282 width, height,
3283 x, to_y);
3285 UNBLOCK_INPUT;
3290 /***********************************************************************
3291 Exposure Events
3292 ***********************************************************************/
3295 static void
3296 frame_highlight (struct frame *f)
3298 /* We used to only do this if Vx_no_window_manager was non-nil, but
3299 the ICCCM (section 4.1.6) says that the window's border pixmap
3300 and border pixel are window attributes which are "private to the
3301 client", so we can always change it to whatever we want. */
3302 BLOCK_INPUT;
3303 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3304 f->output_data.x->border_pixel);
3305 UNBLOCK_INPUT;
3306 x_update_cursor (f, 1);
3307 x_set_frame_alpha (f);
3310 static void
3311 frame_unhighlight (struct frame *f)
3313 /* We used to only do this if Vx_no_window_manager was non-nil, but
3314 the ICCCM (section 4.1.6) says that the window's border pixmap
3315 and border pixel are window attributes which are "private to the
3316 client", so we can always change it to whatever we want. */
3317 BLOCK_INPUT;
3318 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3319 f->output_data.x->border_tile);
3320 UNBLOCK_INPUT;
3321 x_update_cursor (f, 1);
3322 x_set_frame_alpha (f);
3325 /* The focus has changed. Update the frames as necessary to reflect
3326 the new situation. Note that we can't change the selected frame
3327 here, because the Lisp code we are interrupting might become confused.
3328 Each event gets marked with the frame in which it occurred, so the
3329 Lisp code can tell when the switch took place by examining the events. */
3331 static void
3332 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3334 struct frame *old_focus = dpyinfo->x_focus_frame;
3336 if (frame != dpyinfo->x_focus_frame)
3338 /* Set this before calling other routines, so that they see
3339 the correct value of x_focus_frame. */
3340 dpyinfo->x_focus_frame = frame;
3342 if (old_focus && old_focus->auto_lower)
3343 x_lower_frame (old_focus);
3345 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3346 pending_autoraise_frame = dpyinfo->x_focus_frame;
3347 else
3348 pending_autoraise_frame = 0;
3351 x_frame_rehighlight (dpyinfo);
3354 /* Handle FocusIn and FocusOut state changes for FRAME.
3355 If FRAME has focus and there exists more than one frame, puts
3356 a FOCUS_IN_EVENT into *BUFP. */
3358 static void
3359 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3361 if (type == FocusIn)
3363 if (dpyinfo->x_focus_event_frame != frame)
3365 x_new_focus_frame (dpyinfo, frame);
3366 dpyinfo->x_focus_event_frame = frame;
3368 /* Don't stop displaying the initial startup message
3369 for a switch-frame event we don't need. */
3370 if (NILP (Vterminal_frame)
3371 && CONSP (Vframe_list)
3372 && !NILP (XCDR (Vframe_list)))
3374 bufp->kind = FOCUS_IN_EVENT;
3375 XSETFRAME (bufp->frame_or_window, frame);
3379 frame->output_data.x->focus_state |= state;
3381 #ifdef HAVE_X_I18N
3382 if (FRAME_XIC (frame))
3383 XSetICFocus (FRAME_XIC (frame));
3384 #endif
3386 else if (type == FocusOut)
3388 frame->output_data.x->focus_state &= ~state;
3390 if (dpyinfo->x_focus_event_frame == frame)
3392 dpyinfo->x_focus_event_frame = 0;
3393 x_new_focus_frame (dpyinfo, 0);
3396 #ifdef HAVE_X_I18N
3397 if (FRAME_XIC (frame))
3398 XUnsetICFocus (FRAME_XIC (frame));
3399 #endif
3400 if (frame->pointer_invisible)
3401 XTtoggle_invisible_pointer (frame, 0);
3405 /* The focus may have changed. Figure out if it is a real focus change,
3406 by checking both FocusIn/Out and Enter/LeaveNotify events.
3408 Returns FOCUS_IN_EVENT event in *BUFP. */
3410 static void
3411 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3413 struct frame *frame;
3415 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3416 if (! frame)
3417 return;
3419 switch (event->type)
3421 case EnterNotify:
3422 case LeaveNotify:
3424 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3425 int focus_state
3426 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3428 if (event->xcrossing.detail != NotifyInferior
3429 && event->xcrossing.focus
3430 && ! (focus_state & FOCUS_EXPLICIT))
3431 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3432 FOCUS_IMPLICIT,
3433 dpyinfo, frame, bufp);
3435 break;
3437 case FocusIn:
3438 case FocusOut:
3439 x_focus_changed (event->type,
3440 (event->xfocus.detail == NotifyPointer ?
3441 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3442 dpyinfo, frame, bufp);
3443 break;
3445 case ClientMessage:
3446 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3448 enum xembed_message msg = event->xclient.data.l[1];
3449 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3450 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3452 break;
3457 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3459 void
3460 x_mouse_leave (struct x_display_info *dpyinfo)
3462 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3465 /* The focus has changed, or we have redirected a frame's focus to
3466 another frame (this happens when a frame uses a surrogate
3467 mini-buffer frame). Shift the highlight as appropriate.
3469 The FRAME argument doesn't necessarily have anything to do with which
3470 frame is being highlighted or un-highlighted; we only use it to find
3471 the appropriate X display info. */
3473 static void
3474 XTframe_rehighlight (struct frame *frame)
3476 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3479 static void
3480 x_frame_rehighlight (struct x_display_info *dpyinfo)
3482 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3484 if (dpyinfo->x_focus_frame)
3486 dpyinfo->x_highlight_frame
3487 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3488 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3489 : dpyinfo->x_focus_frame);
3490 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3492 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3493 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3496 else
3497 dpyinfo->x_highlight_frame = 0;
3499 if (dpyinfo->x_highlight_frame != old_highlight)
3501 if (old_highlight)
3502 frame_unhighlight (old_highlight);
3503 if (dpyinfo->x_highlight_frame)
3504 frame_highlight (dpyinfo->x_highlight_frame);
3510 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3512 /* Initialize mode_switch_bit and modifier_meaning. */
3513 static void
3514 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3516 int min_code, max_code;
3517 KeySym *syms;
3518 int syms_per_code;
3519 XModifierKeymap *mods;
3521 dpyinfo->meta_mod_mask = 0;
3522 dpyinfo->shift_lock_mask = 0;
3523 dpyinfo->alt_mod_mask = 0;
3524 dpyinfo->super_mod_mask = 0;
3525 dpyinfo->hyper_mod_mask = 0;
3527 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3529 syms = XGetKeyboardMapping (dpyinfo->display,
3530 min_code, max_code - min_code + 1,
3531 &syms_per_code);
3532 mods = XGetModifierMapping (dpyinfo->display);
3534 /* Scan the modifier table to see which modifier bits the Meta and
3535 Alt keysyms are on. */
3537 int row, col; /* The row and column in the modifier table. */
3538 int found_alt_or_meta;
3540 for (row = 3; row < 8; row++)
3542 found_alt_or_meta = 0;
3543 for (col = 0; col < mods->max_keypermod; col++)
3545 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3547 /* Zeroes are used for filler. Skip them. */
3548 if (code == 0)
3549 continue;
3551 /* Are any of this keycode's keysyms a meta key? */
3553 int code_col;
3555 for (code_col = 0; code_col < syms_per_code; code_col++)
3557 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3559 switch (sym)
3561 case XK_Meta_L:
3562 case XK_Meta_R:
3563 found_alt_or_meta = 1;
3564 dpyinfo->meta_mod_mask |= (1 << row);
3565 break;
3567 case XK_Alt_L:
3568 case XK_Alt_R:
3569 found_alt_or_meta = 1;
3570 dpyinfo->alt_mod_mask |= (1 << row);
3571 break;
3573 case XK_Hyper_L:
3574 case XK_Hyper_R:
3575 if (!found_alt_or_meta)
3576 dpyinfo->hyper_mod_mask |= (1 << row);
3577 code_col = syms_per_code;
3578 col = mods->max_keypermod;
3579 break;
3581 case XK_Super_L:
3582 case XK_Super_R:
3583 if (!found_alt_or_meta)
3584 dpyinfo->super_mod_mask |= (1 << row);
3585 code_col = syms_per_code;
3586 col = mods->max_keypermod;
3587 break;
3589 case XK_Shift_Lock:
3590 /* Ignore this if it's not on the lock modifier. */
3591 if (!found_alt_or_meta && ((1 << row) == LockMask))
3592 dpyinfo->shift_lock_mask = LockMask;
3593 code_col = syms_per_code;
3594 col = mods->max_keypermod;
3595 break;
3603 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3604 if (! dpyinfo->meta_mod_mask)
3606 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3607 dpyinfo->alt_mod_mask = 0;
3610 /* If some keys are both alt and meta,
3611 make them just meta, not alt. */
3612 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3614 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3617 XFree ((char *) syms);
3618 XFreeModifiermap (mods);
3621 /* Convert between the modifier bits X uses and the modifier bits
3622 Emacs uses. */
3624 unsigned int
3625 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, unsigned int state)
3627 EMACS_UINT mod_meta = meta_modifier;
3628 EMACS_UINT mod_alt = alt_modifier;
3629 EMACS_UINT mod_hyper = hyper_modifier;
3630 EMACS_UINT mod_super = super_modifier;
3631 Lisp_Object tem;
3633 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3634 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3635 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3636 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3637 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3638 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3639 tem = Fget (Vx_super_keysym, Qmodifier_value);
3640 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3643 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3644 | ((state & ControlMask) ? ctrl_modifier : 0)
3645 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3646 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3647 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3648 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3651 static unsigned int
3652 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, unsigned int state)
3654 EMACS_UINT mod_meta = meta_modifier;
3655 EMACS_UINT mod_alt = alt_modifier;
3656 EMACS_UINT mod_hyper = hyper_modifier;
3657 EMACS_UINT mod_super = super_modifier;
3659 Lisp_Object tem;
3661 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3662 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3663 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3664 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3665 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3666 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3667 tem = Fget (Vx_super_keysym, Qmodifier_value);
3668 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3671 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3672 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3673 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3674 | ((state & shift_modifier) ? ShiftMask : 0)
3675 | ((state & ctrl_modifier) ? ControlMask : 0)
3676 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3679 /* Convert a keysym to its name. */
3681 char *
3682 x_get_keysym_name (int keysym)
3684 char *value;
3686 BLOCK_INPUT;
3687 value = XKeysymToString (keysym);
3688 UNBLOCK_INPUT;
3690 return value;
3695 /* Mouse clicks and mouse movement. Rah. */
3697 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3699 If the event is a button press, then note that we have grabbed
3700 the mouse. */
3702 static Lisp_Object
3703 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3705 /* Make the event type NO_EVENT; we'll change that when we decide
3706 otherwise. */
3707 result->kind = MOUSE_CLICK_EVENT;
3708 result->code = event->button - Button1;
3709 result->timestamp = event->time;
3710 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3711 event->state)
3712 | (event->type == ButtonRelease
3713 ? up_modifier
3714 : down_modifier));
3716 XSETINT (result->x, event->x);
3717 XSETINT (result->y, event->y);
3718 XSETFRAME (result->frame_or_window, f);
3719 result->arg = Qnil;
3720 return Qnil;
3724 /* Function to report a mouse movement to the mainstream Emacs code.
3725 The input handler calls this.
3727 We have received a mouse movement event, which is given in *event.
3728 If the mouse is over a different glyph than it was last time, tell
3729 the mainstream emacs code by setting mouse_moved. If not, ask for
3730 another motion event, so we can check again the next time it moves. */
3732 static XMotionEvent last_mouse_motion_event;
3733 static Lisp_Object last_mouse_motion_frame;
3735 static int
3736 note_mouse_movement (FRAME_PTR frame, XMotionEvent *event)
3738 last_mouse_movement_time = event->time;
3739 last_mouse_motion_event = *event;
3740 XSETFRAME (last_mouse_motion_frame, frame);
3742 if (!FRAME_X_OUTPUT (frame))
3743 return 0;
3745 if (event->window != FRAME_X_WINDOW (frame))
3747 frame->mouse_moved = 1;
3748 last_mouse_scroll_bar = Qnil;
3749 note_mouse_highlight (frame, -1, -1);
3750 last_mouse_glyph_frame = 0;
3751 return 1;
3755 /* Has the mouse moved off the glyph it was on at the last sighting? */
3756 if (frame != last_mouse_glyph_frame
3757 || event->x < last_mouse_glyph.x
3758 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3759 || event->y < last_mouse_glyph.y
3760 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3762 frame->mouse_moved = 1;
3763 last_mouse_scroll_bar = Qnil;
3764 note_mouse_highlight (frame, event->x, event->y);
3765 /* Remember which glyph we're now on. */
3766 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3767 last_mouse_glyph_frame = frame;
3768 return 1;
3771 return 0;
3775 /************************************************************************
3776 Mouse Face
3777 ************************************************************************/
3779 static void
3780 redo_mouse_highlight (void)
3782 if (!NILP (last_mouse_motion_frame)
3783 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3784 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3785 last_mouse_motion_event.x,
3786 last_mouse_motion_event.y);
3791 /* Return the current position of the mouse.
3792 *FP should be a frame which indicates which display to ask about.
3794 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3795 and *PART to the frame, window, and scroll bar part that the mouse
3796 is over. Set *X and *Y to the portion and whole of the mouse's
3797 position on the scroll bar.
3799 If the mouse movement started elsewhere, set *FP to the frame the
3800 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3801 the mouse is over.
3803 Set *TIME to the server time-stamp for the time at which the mouse
3804 was at this position.
3806 Don't store anything if we don't have a valid set of values to report.
3808 This clears the mouse_moved flag, so we can wait for the next mouse
3809 movement. */
3811 static void
3812 XTmouse_position (FRAME_PTR *fp, int insist, Lisp_Object *bar_window, enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y, long unsigned int *time)
3814 FRAME_PTR f1;
3816 BLOCK_INPUT;
3818 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3819 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3820 else
3822 Window root;
3823 int root_x, root_y;
3825 Window dummy_window;
3826 int dummy;
3828 Lisp_Object frame, tail;
3830 /* Clear the mouse-moved flag for every frame on this display. */
3831 FOR_EACH_FRAME (tail, frame)
3832 if (FRAME_X_P (XFRAME (frame))
3833 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3834 XFRAME (frame)->mouse_moved = 0;
3836 last_mouse_scroll_bar = Qnil;
3838 /* Figure out which root window we're on. */
3839 XQueryPointer (FRAME_X_DISPLAY (*fp),
3840 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3842 /* The root window which contains the pointer. */
3843 &root,
3845 /* Trash which we can't trust if the pointer is on
3846 a different screen. */
3847 &dummy_window,
3849 /* The position on that root window. */
3850 &root_x, &root_y,
3852 /* More trash we can't trust. */
3853 &dummy, &dummy,
3855 /* Modifier keys and pointer buttons, about which
3856 we don't care. */
3857 (unsigned int *) &dummy);
3859 /* Now we have a position on the root; find the innermost window
3860 containing the pointer. */
3862 Window win, child;
3863 int win_x, win_y;
3864 int parent_x = 0, parent_y = 0;
3866 win = root;
3868 /* XTranslateCoordinates can get errors if the window
3869 structure is changing at the same time this function
3870 is running. So at least we must not crash from them. */
3872 x_catch_errors (FRAME_X_DISPLAY (*fp));
3874 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3875 && FRAME_LIVE_P (last_mouse_frame))
3877 /* If mouse was grabbed on a frame, give coords for that frame
3878 even if the mouse is now outside it. */
3879 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3881 /* From-window, to-window. */
3882 root, FRAME_X_WINDOW (last_mouse_frame),
3884 /* From-position, to-position. */
3885 root_x, root_y, &win_x, &win_y,
3887 /* Child of win. */
3888 &child);
3889 f1 = last_mouse_frame;
3891 else
3893 while (1)
3895 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3897 /* From-window, to-window. */
3898 root, win,
3900 /* From-position, to-position. */
3901 root_x, root_y, &win_x, &win_y,
3903 /* Child of win. */
3904 &child);
3906 if (child == None || child == win)
3907 break;
3908 #ifdef USE_GTK
3909 /* We don't wan't to know the innermost window. We
3910 want the edit window. For non-Gtk+ the innermost
3911 window is the edit window. For Gtk+ it might not
3912 be. It might be the tool bar for example. */
3913 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3914 break;
3915 #endif
3916 win = child;
3917 parent_x = win_x;
3918 parent_y = win_y;
3921 /* Now we know that:
3922 win is the innermost window containing the pointer
3923 (XTC says it has no child containing the pointer),
3924 win_x and win_y are the pointer's position in it
3925 (XTC did this the last time through), and
3926 parent_x and parent_y are the pointer's position in win's parent.
3927 (They are what win_x and win_y were when win was child.
3928 If win is the root window, it has no parent, and
3929 parent_{x,y} are invalid, but that's okay, because we'll
3930 never use them in that case.) */
3932 #ifdef USE_GTK
3933 /* We don't wan't to know the innermost window. We
3934 want the edit window. */
3935 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3936 #else
3937 /* Is win one of our frames? */
3938 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3939 #endif
3941 #ifdef USE_X_TOOLKIT
3942 /* If we end up with the menu bar window, say it's not
3943 on the frame. */
3944 if (f1 != NULL
3945 && f1->output_data.x->menubar_widget
3946 && win == XtWindow (f1->output_data.x->menubar_widget))
3947 f1 = NULL;
3948 #endif /* USE_X_TOOLKIT */
3951 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3952 f1 = 0;
3954 x_uncatch_errors ();
3956 /* If not, is it one of our scroll bars? */
3957 if (! f1)
3959 struct scroll_bar *bar;
3961 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3963 if (bar)
3965 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3966 win_x = parent_x;
3967 win_y = parent_y;
3971 if (f1 == 0 && insist > 0)
3972 f1 = SELECTED_FRAME ();
3974 if (f1)
3976 /* Ok, we found a frame. Store all the values.
3977 last_mouse_glyph is a rectangle used to reduce the
3978 generation of mouse events. To not miss any motion
3979 events, we must divide the frame into rectangles of the
3980 size of the smallest character that could be displayed
3981 on it, i.e. into the same rectangles that matrices on
3982 the frame are divided into. */
3984 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3985 last_mouse_glyph_frame = f1;
3987 *bar_window = Qnil;
3988 *part = 0;
3989 *fp = f1;
3990 XSETINT (*x, win_x);
3991 XSETINT (*y, win_y);
3992 *time = last_mouse_movement_time;
3997 UNBLOCK_INPUT;
4002 /***********************************************************************
4003 Scroll bars
4004 ***********************************************************************/
4006 /* Scroll bar support. */
4008 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4009 manages it.
4010 This can be called in GC, so we have to make sure to strip off mark
4011 bits. */
4013 static struct scroll_bar *
4014 x_window_to_scroll_bar (Display *display, Window window_id)
4016 Lisp_Object tail;
4018 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4019 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4020 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4022 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4024 Lisp_Object frame, bar, condemned;
4026 frame = XCAR (tail);
4027 /* All elements of Vframe_list should be frames. */
4028 if (! FRAMEP (frame))
4029 abort ();
4031 if (! FRAME_X_P (XFRAME (frame)))
4032 continue;
4034 /* Scan this frame's scroll bar list for a scroll bar with the
4035 right window ID. */
4036 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4037 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4038 /* This trick allows us to search both the ordinary and
4039 condemned scroll bar lists with one loop. */
4040 ! NILP (bar) || (bar = condemned,
4041 condemned = Qnil,
4042 ! NILP (bar));
4043 bar = XSCROLL_BAR (bar)->next)
4044 if (XSCROLL_BAR (bar)->x_window == window_id &&
4045 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4046 return XSCROLL_BAR (bar);
4049 return 0;
4053 #if defined USE_LUCID
4055 /* Return the Lucid menu bar WINDOW is part of. Return null
4056 if WINDOW is not part of a menu bar. */
4058 static Widget
4059 x_window_to_menu_bar (Window window)
4061 Lisp_Object tail;
4063 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4065 if (FRAME_X_P (XFRAME (XCAR (tail))))
4067 Lisp_Object frame = XCAR (tail);
4068 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4070 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4071 return menu_bar;
4075 return NULL;
4078 #endif /* USE_LUCID */
4081 /************************************************************************
4082 Toolkit scroll bars
4083 ************************************************************************/
4085 #ifdef USE_TOOLKIT_SCROLL_BARS
4087 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4088 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4089 static void x_create_toolkit_scroll_bar (struct frame *,
4090 struct scroll_bar *);
4091 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4092 int, int, int);
4095 /* Lisp window being scrolled. Set when starting to interact with
4096 a toolkit scroll bar, reset to nil when ending the interaction. */
4098 static Lisp_Object window_being_scrolled;
4100 /* Last scroll bar part sent in xm_scroll_callback. */
4102 static int last_scroll_bar_part;
4104 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4105 that movements of 1/20 of the screen size are mapped to up/down. */
4107 #ifndef USE_GTK
4108 /* Id of action hook installed for scroll bars. */
4110 static XtActionHookId action_hook_id;
4112 static Boolean xaw3d_arrow_scroll;
4114 /* Whether the drag scrolling maintains the mouse at the top of the
4115 thumb. If not, resizing the thumb needs to be done more carefully
4116 to avoid jerkyness. */
4118 static Boolean xaw3d_pick_top;
4120 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4121 bars are used.. The hook is responsible for detecting when
4122 the user ends an interaction with the scroll bar, and generates
4123 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4125 static void
4126 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4127 XEvent *event, String *params, Cardinal *num_params)
4129 int scroll_bar_p;
4130 const char *end_action;
4132 #ifdef USE_MOTIF
4133 scroll_bar_p = XmIsScrollBar (widget);
4134 end_action = "Release";
4135 #else /* !USE_MOTIF i.e. use Xaw */
4136 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4137 end_action = "EndScroll";
4138 #endif /* USE_MOTIF */
4140 if (scroll_bar_p
4141 && strcmp (action_name, end_action) == 0
4142 && WINDOWP (window_being_scrolled))
4144 struct window *w;
4146 x_send_scroll_bar_event (window_being_scrolled,
4147 scroll_bar_end_scroll, 0, 0);
4148 w = XWINDOW (window_being_scrolled);
4150 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4152 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4153 /* The thumb size is incorrect while dragging: fix it. */
4154 set_vertical_scroll_bar (w);
4156 window_being_scrolled = Qnil;
4157 last_scroll_bar_part = -1;
4159 /* Xt timeouts no longer needed. */
4160 toolkit_scroll_bar_interaction = 0;
4163 #endif /* not USE_GTK */
4165 /* A vector of windows used for communication between
4166 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4168 static struct window **scroll_bar_windows;
4169 static int scroll_bar_windows_size;
4172 /* Send a client message with message type Xatom_Scrollbar for a
4173 scroll action to the frame of WINDOW. PART is a value identifying
4174 the part of the scroll bar that was clicked on. PORTION is the
4175 amount to scroll of a whole of WHOLE. */
4177 static void
4178 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4180 XEvent event;
4181 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4182 struct window *w = XWINDOW (window);
4183 struct frame *f = XFRAME (w->frame);
4184 int i;
4186 BLOCK_INPUT;
4188 /* Construct a ClientMessage event to send to the frame. */
4189 ev->type = ClientMessage;
4190 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4191 ev->display = FRAME_X_DISPLAY (f);
4192 ev->window = FRAME_X_WINDOW (f);
4193 ev->format = 32;
4195 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4196 not enough to store a pointer or Lisp_Object on a 64 bit system.
4197 So, store the window in scroll_bar_windows and pass the index
4198 into that array in the event. */
4199 for (i = 0; i < scroll_bar_windows_size; ++i)
4200 if (scroll_bar_windows[i] == NULL)
4201 break;
4203 if (i == scroll_bar_windows_size)
4205 int new_size = max (10, 2 * scroll_bar_windows_size);
4206 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4207 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4209 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4210 nbytes);
4211 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4212 scroll_bar_windows_size = new_size;
4215 scroll_bar_windows[i] = w;
4216 ev->data.l[0] = (long) i;
4217 ev->data.l[1] = (long) part;
4218 ev->data.l[2] = (long) 0;
4219 ev->data.l[3] = (long) portion;
4220 ev->data.l[4] = (long) whole;
4222 /* Make Xt timeouts work while the scroll bar is active. */
4223 toolkit_scroll_bar_interaction = 1;
4224 #ifdef USE_X_TOOLKIT
4225 x_activate_timeout_atimer ();
4226 #endif
4228 /* Setting the event mask to zero means that the message will
4229 be sent to the client that created the window, and if that
4230 window no longer exists, no event will be sent. */
4231 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4232 UNBLOCK_INPUT;
4236 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4237 in *IEVENT. */
4239 static void
4240 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4242 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4243 Lisp_Object window;
4244 struct frame *f;
4245 struct window *w;
4247 w = scroll_bar_windows[ev->data.l[0]];
4248 scroll_bar_windows[ev->data.l[0]] = NULL;
4250 XSETWINDOW (window, w);
4251 f = XFRAME (w->frame);
4253 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4254 ievent->frame_or_window = window;
4255 ievent->arg = Qnil;
4256 #ifdef USE_GTK
4257 ievent->timestamp = CurrentTime;
4258 #else
4259 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4260 #endif
4261 ievent->part = ev->data.l[1];
4262 ievent->code = ev->data.l[2];
4263 ievent->x = make_number ((int) ev->data.l[3]);
4264 ievent->y = make_number ((int) ev->data.l[4]);
4265 ievent->modifiers = 0;
4269 #ifdef USE_MOTIF
4271 /* Minimum and maximum values used for Motif scroll bars. */
4273 #define XM_SB_MAX 10000000
4276 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4277 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4278 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4280 static void
4281 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4283 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4284 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4285 int part = -1, whole = 0, portion = 0;
4287 switch (cs->reason)
4289 case XmCR_DECREMENT:
4290 bar->dragging = Qnil;
4291 part = scroll_bar_up_arrow;
4292 break;
4294 case XmCR_INCREMENT:
4295 bar->dragging = Qnil;
4296 part = scroll_bar_down_arrow;
4297 break;
4299 case XmCR_PAGE_DECREMENT:
4300 bar->dragging = Qnil;
4301 part = scroll_bar_above_handle;
4302 break;
4304 case XmCR_PAGE_INCREMENT:
4305 bar->dragging = Qnil;
4306 part = scroll_bar_below_handle;
4307 break;
4309 case XmCR_TO_TOP:
4310 bar->dragging = Qnil;
4311 part = scroll_bar_to_top;
4312 break;
4314 case XmCR_TO_BOTTOM:
4315 bar->dragging = Qnil;
4316 part = scroll_bar_to_bottom;
4317 break;
4319 case XmCR_DRAG:
4321 int slider_size;
4323 /* Get the slider size. */
4324 BLOCK_INPUT;
4325 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4326 UNBLOCK_INPUT;
4328 whole = XM_SB_MAX - slider_size;
4329 portion = min (cs->value, whole);
4330 part = scroll_bar_handle;
4331 bar->dragging = make_number (cs->value);
4333 break;
4335 case XmCR_VALUE_CHANGED:
4336 break;
4339 if (part >= 0)
4341 window_being_scrolled = bar->window;
4342 last_scroll_bar_part = part;
4343 x_send_scroll_bar_event (bar->window, part, portion, whole);
4347 #elif defined USE_GTK
4349 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4350 bar widget. DATA is a pointer to the scroll_bar structure. */
4352 static gboolean
4353 xg_scroll_callback (GtkRange *range,
4354 GtkScrollType scroll,
4355 gdouble value,
4356 gpointer user_data)
4358 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4359 gdouble position;
4360 int part = -1, whole = 0, portion = 0;
4361 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4362 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4364 if (xg_ignore_gtk_scrollbar) return FALSE;
4365 position = gtk_adjustment_get_value (adj);
4368 switch (scroll)
4370 case GTK_SCROLL_JUMP:
4371 /* Buttons 1 2 or 3 must be grabbed. */
4372 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4373 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4375 part = scroll_bar_handle;
4376 whole = gtk_adjustment_get_upper (adj) -
4377 gtk_adjustment_get_page_size (adj);
4378 portion = min ((int)position, whole);
4379 bar->dragging = make_number ((int)portion);
4381 break;
4382 case GTK_SCROLL_STEP_BACKWARD:
4383 part = scroll_bar_up_arrow;
4384 bar->dragging = Qnil;
4385 break;
4386 case GTK_SCROLL_STEP_FORWARD:
4387 part = scroll_bar_down_arrow;
4388 bar->dragging = Qnil;
4389 break;
4390 case GTK_SCROLL_PAGE_BACKWARD:
4391 part = scroll_bar_above_handle;
4392 bar->dragging = Qnil;
4393 break;
4394 case GTK_SCROLL_PAGE_FORWARD:
4395 part = scroll_bar_below_handle;
4396 bar->dragging = Qnil;
4397 break;
4400 if (part >= 0)
4402 window_being_scrolled = bar->window;
4403 last_scroll_bar_part = part;
4404 x_send_scroll_bar_event (bar->window, part, portion, whole);
4407 return FALSE;
4410 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4412 static gboolean
4413 xg_end_scroll_callback (GtkWidget *widget,
4414 GdkEventButton *event,
4415 gpointer user_data)
4417 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4418 bar->dragging = Qnil;
4419 if (WINDOWP (window_being_scrolled))
4421 x_send_scroll_bar_event (window_being_scrolled,
4422 scroll_bar_end_scroll, 0, 0);
4423 window_being_scrolled = Qnil;
4426 return FALSE;
4430 #else /* not USE_GTK and not USE_MOTIF */
4432 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4433 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4434 scroll bar struct. CALL_DATA is a pointer to a float saying where
4435 the thumb is. */
4437 static void
4438 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4440 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4441 float top = *(float *) call_data;
4442 float shown;
4443 int whole, portion, height;
4444 int part;
4446 /* Get the size of the thumb, a value between 0 and 1. */
4447 BLOCK_INPUT;
4448 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4449 UNBLOCK_INPUT;
4451 whole = 10000000;
4452 portion = shown < 1 ? top * whole : 0;
4454 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4455 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4456 the bottom, so we force the scrolling whenever we see that we're
4457 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4458 we try to ensure that we always stay two pixels away from the
4459 bottom). */
4460 part = scroll_bar_down_arrow;
4461 else
4462 part = scroll_bar_handle;
4464 window_being_scrolled = bar->window;
4465 bar->dragging = make_number (portion);
4466 last_scroll_bar_part = part;
4467 x_send_scroll_bar_event (bar->window, part, portion, whole);
4471 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4472 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4473 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4474 the scroll bar. CALL_DATA is an integer specifying the action that
4475 has taken place. Its magnitude is in the range 0..height of the
4476 scroll bar. Negative values mean scroll towards buffer start.
4477 Values < height of scroll bar mean line-wise movement. */
4479 static void
4480 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4482 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4483 /* The position really is stored cast to a pointer. */
4484 int position = (long) call_data;
4485 Dimension height;
4486 int part;
4488 /* Get the height of the scroll bar. */
4489 BLOCK_INPUT;
4490 XtVaGetValues (widget, XtNheight, &height, NULL);
4491 UNBLOCK_INPUT;
4493 if (eabs (position) >= height)
4494 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4496 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4497 it maps line-movement to call_data = max(5, height/20). */
4498 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4499 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4500 else
4501 part = scroll_bar_move_ratio;
4503 window_being_scrolled = bar->window;
4504 bar->dragging = Qnil;
4505 last_scroll_bar_part = part;
4506 x_send_scroll_bar_event (bar->window, part, position, height);
4509 #endif /* not USE_GTK and not USE_MOTIF */
4511 #define SCROLL_BAR_NAME "verticalScrollBar"
4513 /* Create the widget for scroll bar BAR on frame F. Record the widget
4514 and X window of the scroll bar in BAR. */
4516 #ifdef USE_GTK
4517 static void
4518 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4520 const char *scroll_bar_name = SCROLL_BAR_NAME;
4522 BLOCK_INPUT;
4523 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4524 G_CALLBACK (xg_end_scroll_callback),
4525 scroll_bar_name);
4526 UNBLOCK_INPUT;
4529 #else /* not USE_GTK */
4531 static void
4532 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4534 Window xwindow;
4535 Widget widget;
4536 Arg av[20];
4537 int ac = 0;
4538 char *scroll_bar_name = SCROLL_BAR_NAME;
4539 unsigned long pixel;
4541 BLOCK_INPUT;
4543 #ifdef USE_MOTIF
4544 /* Set resources. Create the widget. */
4545 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4546 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4547 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4548 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4549 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4550 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4551 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4553 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4554 if (pixel != -1)
4556 XtSetArg (av[ac], XmNforeground, pixel);
4557 ++ac;
4560 pixel = f->output_data.x->scroll_bar_background_pixel;
4561 if (pixel != -1)
4563 XtSetArg (av[ac], XmNbackground, pixel);
4564 ++ac;
4567 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4568 scroll_bar_name, av, ac);
4570 /* Add one callback for everything that can happen. */
4571 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4572 (XtPointer) bar);
4573 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4574 (XtPointer) bar);
4575 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4576 (XtPointer) bar);
4577 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4578 (XtPointer) bar);
4579 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4580 (XtPointer) bar);
4581 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4582 (XtPointer) bar);
4583 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4584 (XtPointer) bar);
4586 /* Realize the widget. Only after that is the X window created. */
4587 XtRealizeWidget (widget);
4589 /* Set the cursor to an arrow. I didn't find a resource to do that.
4590 And I'm wondering why it hasn't an arrow cursor by default. */
4591 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4592 f->output_data.x->nontext_cursor);
4594 #else /* !USE_MOTIF i.e. use Xaw */
4596 /* Set resources. Create the widget. The background of the
4597 Xaw3d scroll bar widget is a little bit light for my taste.
4598 We don't alter it here to let users change it according
4599 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4600 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4601 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4602 /* For smoother scrolling with Xaw3d -sm */
4603 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4605 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4606 if (pixel != -1)
4608 XtSetArg (av[ac], XtNforeground, pixel);
4609 ++ac;
4612 pixel = f->output_data.x->scroll_bar_background_pixel;
4613 if (pixel != -1)
4615 XtSetArg (av[ac], XtNbackground, pixel);
4616 ++ac;
4619 /* Top/bottom shadow colors. */
4621 /* Allocate them, if necessary. */
4622 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4624 pixel = f->output_data.x->scroll_bar_background_pixel;
4625 if (pixel != -1)
4627 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4628 FRAME_X_COLORMAP (f),
4629 &pixel, 1.2, 0x8000))
4630 pixel = -1;
4631 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4634 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4636 pixel = f->output_data.x->scroll_bar_background_pixel;
4637 if (pixel != -1)
4639 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4640 FRAME_X_COLORMAP (f),
4641 &pixel, 0.6, 0x4000))
4642 pixel = -1;
4643 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4647 #ifdef XtNbeNiceToColormap
4648 /* Tell the toolkit about them. */
4649 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4650 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4651 /* We tried to allocate a color for the top/bottom shadow, and
4652 failed, so tell Xaw3d to use dithering instead. */
4653 /* But only if we have a small colormap. Xaw3d can allocate nice
4654 colors itself. */
4656 XtSetArg (av[ac], XtNbeNiceToColormap,
4657 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4658 ++ac;
4660 else
4661 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4662 be more consistent with other emacs 3d colors, and since Xaw3d is
4663 not good at dealing with allocation failure. */
4665 /* This tells Xaw3d to use real colors instead of dithering for
4666 the shadows. */
4667 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4668 ++ac;
4670 /* Specify the colors. */
4671 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4672 if (pixel != -1)
4674 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4675 ++ac;
4677 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4678 if (pixel != -1)
4680 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4681 ++ac;
4684 #endif
4686 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4687 f->output_data.x->edit_widget, av, ac);
4690 char *initial = "";
4691 char *val = initial;
4692 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4693 #ifdef XtNarrowScrollbars
4694 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4695 #endif
4696 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4697 if (xaw3d_arrow_scroll || val == initial)
4698 { /* ARROW_SCROLL */
4699 xaw3d_arrow_scroll = True;
4700 /* Isn't that just a personal preference ? --Stef */
4701 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4705 /* Define callbacks. */
4706 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4707 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4708 (XtPointer) bar);
4710 /* Realize the widget. Only after that is the X window created. */
4711 XtRealizeWidget (widget);
4713 #endif /* !USE_MOTIF */
4715 /* Install an action hook that lets us detect when the user
4716 finishes interacting with a scroll bar. */
4717 if (action_hook_id == 0)
4718 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4720 /* Remember X window and widget in the scroll bar vector. */
4721 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4722 xwindow = XtWindow (widget);
4723 bar->x_window = xwindow;
4725 UNBLOCK_INPUT;
4727 #endif /* not USE_GTK */
4730 /* Set the thumb size and position of scroll bar BAR. We are currently
4731 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4733 #ifdef USE_GTK
4734 static void
4735 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4737 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4740 #else /* not USE_GTK */
4741 static void
4742 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4743 int whole)
4745 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4746 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4747 float top, shown;
4749 BLOCK_INPUT;
4751 #ifdef USE_MOTIF
4753 /* We use an estimate of 30 chars per line rather than the real
4754 `portion' value. This has the disadvantage that the thumb size
4755 is not very representative, but it makes our life a lot easier.
4756 Otherwise, we have to constantly adjust the thumb size, which
4757 we can't always do quickly enough: while dragging, the size of
4758 the thumb might prevent the user from dragging the thumb all the
4759 way to the end. but Motif and some versions of Xaw3d don't allow
4760 updating the thumb size while dragging. Also, even if we can update
4761 its size, the update will often happen too late.
4762 If you don't believe it, check out revision 1.650 of xterm.c to see
4763 what hoops we were going through and the still poor behavior we got. */
4764 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4765 /* When the thumb is at the bottom, position == whole.
4766 So we need to increase `whole' to make space for the thumb. */
4767 whole += portion;
4769 if (whole <= 0)
4770 top = 0, shown = 1;
4771 else
4773 top = (float) position / whole;
4774 shown = (float) portion / whole;
4777 if (NILP (bar->dragging))
4779 int size, value;
4781 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4782 is the scroll bar's maximum and MIN is the scroll bar's minimum
4783 value. */
4784 size = shown * XM_SB_MAX;
4785 size = min (size, XM_SB_MAX);
4786 size = max (size, 1);
4788 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4789 value = top * XM_SB_MAX;
4790 value = min (value, XM_SB_MAX - size);
4792 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4794 #else /* !USE_MOTIF i.e. use Xaw */
4796 if (whole == 0)
4797 top = 0, shown = 1;
4798 else
4800 top = (float) position / whole;
4801 shown = (float) portion / whole;
4805 float old_top, old_shown;
4806 Dimension height;
4807 XtVaGetValues (widget,
4808 XtNtopOfThumb, &old_top,
4809 XtNshown, &old_shown,
4810 XtNheight, &height,
4811 NULL);
4813 /* Massage the top+shown values. */
4814 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4815 top = max (0, min (1, top));
4816 else
4817 top = old_top;
4818 /* Keep two pixels available for moving the thumb down. */
4819 shown = max (0, min (1 - top - (2.0 / height), shown));
4821 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4822 check that your system's configuration file contains a define
4823 for `NARROWPROTO'. See s/freebsd.h for an example. */
4824 if (top != old_top || shown != old_shown)
4826 if (NILP (bar->dragging))
4827 XawScrollbarSetThumb (widget, top, shown);
4828 else
4830 /* Try to make the scrolling a tad smoother. */
4831 if (!xaw3d_pick_top)
4832 shown = min (shown, old_shown);
4834 XawScrollbarSetThumb (widget, top, shown);
4838 #endif /* !USE_MOTIF */
4840 UNBLOCK_INPUT;
4842 #endif /* not USE_GTK */
4844 #endif /* USE_TOOLKIT_SCROLL_BARS */
4848 /************************************************************************
4849 Scroll bars, general
4850 ************************************************************************/
4852 /* Create a scroll bar and return the scroll bar vector for it. W is
4853 the Emacs window on which to create the scroll bar. TOP, LEFT,
4854 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4855 scroll bar. */
4857 static struct scroll_bar *
4858 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4860 struct frame *f = XFRAME (w->frame);
4861 struct scroll_bar *bar
4862 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4864 BLOCK_INPUT;
4866 #ifdef USE_TOOLKIT_SCROLL_BARS
4867 x_create_toolkit_scroll_bar (f, bar);
4868 #else /* not USE_TOOLKIT_SCROLL_BARS */
4870 XSetWindowAttributes a;
4871 unsigned long mask;
4872 Window window;
4874 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4875 if (a.background_pixel == -1)
4876 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4878 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4879 | ButtonMotionMask | PointerMotionHintMask
4880 | ExposureMask);
4881 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4883 mask = (CWBackPixel | CWEventMask | CWCursor);
4885 /* Clear the area of W that will serve as a scroll bar. This is
4886 for the case that a window has been split horizontally. In
4887 this case, no clear_frame is generated to reduce flickering. */
4888 if (width > 0 && height > 0)
4889 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4890 left, top, width,
4891 window_box_height (w), False);
4893 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4894 /* Position and size of scroll bar. */
4895 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4896 top,
4897 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4898 height,
4899 /* Border width, depth, class, and visual. */
4901 CopyFromParent,
4902 CopyFromParent,
4903 CopyFromParent,
4904 /* Attributes. */
4905 mask, &a);
4906 bar->x_window = window;
4908 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4910 XSETWINDOW (bar->window, w);
4911 bar->top = top;
4912 bar->left = left;
4913 bar->width = width;
4914 bar->height = height;
4915 bar->start = 0;
4916 bar->end = 0;
4917 bar->dragging = Qnil;
4918 bar->fringe_extended_p = 0;
4920 /* Add bar to its frame's list of scroll bars. */
4921 bar->next = FRAME_SCROLL_BARS (f);
4922 bar->prev = Qnil;
4923 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4924 if (!NILP (bar->next))
4925 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4927 /* Map the window/widget. */
4928 #ifdef USE_TOOLKIT_SCROLL_BARS
4930 #ifdef USE_GTK
4931 xg_update_scrollbar_pos (f,
4932 bar->x_window,
4933 top,
4934 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4935 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4936 max (height, 1));
4937 #else /* not USE_GTK */
4938 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4939 XtConfigureWidget (scroll_bar,
4940 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4941 top,
4942 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4943 max (height, 1), 0);
4944 XtMapWidget (scroll_bar);
4945 #endif /* not USE_GTK */
4947 #else /* not USE_TOOLKIT_SCROLL_BARS */
4948 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4949 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4951 UNBLOCK_INPUT;
4952 return bar;
4956 #ifndef USE_TOOLKIT_SCROLL_BARS
4958 /* Draw BAR's handle in the proper position.
4960 If the handle is already drawn from START to END, don't bother
4961 redrawing it, unless REBUILD is non-zero; in that case, always
4962 redraw it. (REBUILD is handy for drawing the handle after expose
4963 events.)
4965 Normally, we want to constrain the start and end of the handle to
4966 fit inside its rectangle, but if the user is dragging the scroll
4967 bar handle, we want to let them drag it down all the way, so that
4968 the bar's top is as far down as it goes; otherwise, there's no way
4969 to move to the very end of the buffer. */
4971 static void
4972 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
4974 int dragging = ! NILP (bar->dragging);
4975 Window w = bar->x_window;
4976 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4977 GC gc = f->output_data.x->normal_gc;
4979 /* If the display is already accurate, do nothing. */
4980 if (! rebuild
4981 && start == bar->start
4982 && end == bar->end)
4983 return;
4985 BLOCK_INPUT;
4988 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4989 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4990 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4992 /* Make sure the values are reasonable, and try to preserve
4993 the distance between start and end. */
4995 int length = end - start;
4997 if (start < 0)
4998 start = 0;
4999 else if (start > top_range)
5000 start = top_range;
5001 end = start + length;
5003 if (end < start)
5004 end = start;
5005 else if (end > top_range && ! dragging)
5006 end = top_range;
5009 /* Store the adjusted setting in the scroll bar. */
5010 bar->start = start;
5011 bar->end = end;
5013 /* Clip the end position, just for display. */
5014 if (end > top_range)
5015 end = top_range;
5017 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5018 below top positions, to make sure the handle is always at least
5019 that many pixels tall. */
5020 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5022 /* Draw the empty space above the handle. Note that we can't clear
5023 zero-height areas; that means "clear to end of window." */
5024 if (0 < start)
5025 x_clear_area (FRAME_X_DISPLAY (f), w,
5026 /* x, y, width, height, and exposures. */
5027 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5028 VERTICAL_SCROLL_BAR_TOP_BORDER,
5029 inside_width, start,
5030 False);
5032 /* Change to proper foreground color if one is specified. */
5033 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5034 XSetForeground (FRAME_X_DISPLAY (f), gc,
5035 f->output_data.x->scroll_bar_foreground_pixel);
5037 /* Draw the handle itself. */
5038 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5039 /* x, y, width, height */
5040 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5041 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5042 inside_width, end - start);
5044 /* Restore the foreground color of the GC if we changed it above. */
5045 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5046 XSetForeground (FRAME_X_DISPLAY (f), gc,
5047 FRAME_FOREGROUND_PIXEL (f));
5049 /* Draw the empty space below the handle. Note that we can't
5050 clear zero-height areas; that means "clear to end of window." */
5051 if (end < inside_height)
5052 x_clear_area (FRAME_X_DISPLAY (f), w,
5053 /* x, y, width, height, and exposures. */
5054 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5055 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5056 inside_width, inside_height - end,
5057 False);
5061 UNBLOCK_INPUT;
5064 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5066 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5067 nil. */
5069 static void
5070 x_scroll_bar_remove (struct scroll_bar *bar)
5072 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5073 BLOCK_INPUT;
5075 #ifdef USE_TOOLKIT_SCROLL_BARS
5076 #ifdef USE_GTK
5077 xg_remove_scroll_bar (f, bar->x_window);
5078 #else /* not USE_GTK */
5079 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5080 #endif /* not USE_GTK */
5081 #else
5082 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5083 #endif
5085 /* Disassociate this scroll bar from its window. */
5086 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5088 UNBLOCK_INPUT;
5092 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5093 that we are displaying PORTION characters out of a total of WHOLE
5094 characters, starting at POSITION. If WINDOW has no scroll bar,
5095 create one. */
5097 static void
5098 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5100 struct frame *f = XFRAME (w->frame);
5101 struct scroll_bar *bar;
5102 int top, height, left, sb_left, width, sb_width;
5103 int window_y, window_height;
5104 #ifdef USE_TOOLKIT_SCROLL_BARS
5105 int fringe_extended_p;
5106 #endif
5108 /* Get window dimensions. */
5109 window_box (w, -1, 0, &window_y, 0, &window_height);
5110 top = window_y;
5111 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5112 height = window_height;
5114 /* Compute the left edge of the scroll bar area. */
5115 left = WINDOW_SCROLL_BAR_AREA_X (w);
5117 /* Compute the width of the scroll bar which might be less than
5118 the width of the area reserved for the scroll bar. */
5119 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5120 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5121 else
5122 sb_width = width;
5124 /* Compute the left edge of the scroll bar. */
5125 #ifdef USE_TOOLKIT_SCROLL_BARS
5126 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5127 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5128 else
5129 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5130 #else
5131 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5132 sb_left = left + width - sb_width;
5133 else
5134 sb_left = left;
5135 #endif
5137 #ifdef USE_TOOLKIT_SCROLL_BARS
5138 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5139 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5140 && WINDOW_LEFT_FRINGE_WIDTH (w)
5141 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5142 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5143 else
5144 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5145 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5146 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5147 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5148 #endif
5150 /* Does the scroll bar exist yet? */
5151 if (NILP (w->vertical_scroll_bar))
5153 if (width > 0 && height > 0)
5155 BLOCK_INPUT;
5156 #ifdef USE_TOOLKIT_SCROLL_BARS
5157 if (fringe_extended_p)
5158 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5159 sb_left, top, sb_width, height, False);
5160 else
5161 #endif
5162 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5163 left, top, width, height, False);
5164 UNBLOCK_INPUT;
5167 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5169 else
5171 /* It may just need to be moved and resized. */
5172 unsigned int mask = 0;
5174 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5176 BLOCK_INPUT;
5178 if (sb_left != bar->left)
5179 mask |= CWX;
5180 if (top != bar->top)
5181 mask |= CWY;
5182 if (sb_width != bar->width)
5183 mask |= CWWidth;
5184 if (height != bar->height)
5185 mask |= CWHeight;
5187 #ifdef USE_TOOLKIT_SCROLL_BARS
5189 /* Move/size the scroll bar widget. */
5190 if (mask || bar->fringe_extended_p != fringe_extended_p)
5192 /* Since toolkit scroll bars are smaller than the space reserved
5193 for them on the frame, we have to clear "under" them. */
5194 if (width > 0 && height > 0)
5196 if (fringe_extended_p)
5197 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5198 sb_left, top, sb_width, height, False);
5199 else
5200 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5201 left, top, width, height, False);
5203 #ifdef USE_GTK
5204 xg_update_scrollbar_pos (f,
5205 bar->x_window,
5206 top,
5207 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5208 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5209 max (height, 1));
5210 #else /* not USE_GTK */
5211 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5212 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5213 top,
5214 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5215 max (height, 1), 0);
5216 #endif /* not USE_GTK */
5218 #else /* not USE_TOOLKIT_SCROLL_BARS */
5220 /* Clear areas not covered by the scroll bar because of
5221 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5222 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5224 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5225 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5226 height, False);
5227 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5228 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5229 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5230 height, False);
5233 /* Clear areas not covered by the scroll bar because it's not as
5234 wide as the area reserved for it. This makes sure a
5235 previous mode line display is cleared after C-x 2 C-x 1, for
5236 example. */
5238 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5239 int rest = area_width - sb_width;
5240 if (rest > 0 && height > 0)
5242 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5243 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5244 left + area_width - rest, top,
5245 rest, height, False);
5246 else
5247 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5248 left, top, rest, height, False);
5252 /* Move/size the scroll bar window. */
5253 if (mask)
5255 XWindowChanges wc;
5257 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5258 wc.y = top;
5259 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5260 wc.height = height;
5261 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5262 mask, &wc);
5265 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5267 /* Remember new settings. */
5268 bar->left = sb_left;
5269 bar->top = top;
5270 bar->width = sb_width;
5271 bar->height = height;
5273 UNBLOCK_INPUT;
5276 #ifdef USE_TOOLKIT_SCROLL_BARS
5277 bar->fringe_extended_p = fringe_extended_p;
5279 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5280 #else /* not USE_TOOLKIT_SCROLL_BARS */
5281 /* Set the scroll bar's current state, unless we're currently being
5282 dragged. */
5283 if (NILP (bar->dragging))
5285 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5287 if (whole == 0)
5288 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5289 else
5291 int start = ((double) position * top_range) / whole;
5292 int end = ((double) (position + portion) * top_range) / whole;
5293 x_scroll_bar_set_handle (bar, start, end, 0);
5296 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5298 XSETVECTOR (w->vertical_scroll_bar, bar);
5302 /* The following three hooks are used when we're doing a thorough
5303 redisplay of the frame. We don't explicitly know which scroll bars
5304 are going to be deleted, because keeping track of when windows go
5305 away is a real pain - "Can you say set-window-configuration, boys
5306 and girls?" Instead, we just assert at the beginning of redisplay
5307 that *all* scroll bars are to be removed, and then save a scroll bar
5308 from the fiery pit when we actually redisplay its window. */
5310 /* Arrange for all scroll bars on FRAME to be removed at the next call
5311 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5312 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5314 static void
5315 XTcondemn_scroll_bars (FRAME_PTR frame)
5317 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5318 while (! NILP (FRAME_SCROLL_BARS (frame)))
5320 Lisp_Object bar;
5321 bar = FRAME_SCROLL_BARS (frame);
5322 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5323 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5324 XSCROLL_BAR (bar)->prev = Qnil;
5325 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5326 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5327 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5332 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5333 Note that WINDOW isn't necessarily condemned at all. */
5335 static void
5336 XTredeem_scroll_bar (struct window *window)
5338 struct scroll_bar *bar;
5339 struct frame *f;
5341 /* We can't redeem this window's scroll bar if it doesn't have one. */
5342 if (NILP (window->vertical_scroll_bar))
5343 abort ();
5345 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5347 /* Unlink it from the condemned list. */
5348 f = XFRAME (WINDOW_FRAME (window));
5349 if (NILP (bar->prev))
5351 /* If the prev pointer is nil, it must be the first in one of
5352 the lists. */
5353 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5354 /* It's not condemned. Everything's fine. */
5355 return;
5356 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5357 window->vertical_scroll_bar))
5358 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5359 else
5360 /* If its prev pointer is nil, it must be at the front of
5361 one or the other! */
5362 abort ();
5364 else
5365 XSCROLL_BAR (bar->prev)->next = bar->next;
5367 if (! NILP (bar->next))
5368 XSCROLL_BAR (bar->next)->prev = bar->prev;
5370 bar->next = FRAME_SCROLL_BARS (f);
5371 bar->prev = Qnil;
5372 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5373 if (! NILP (bar->next))
5374 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5377 /* Remove all scroll bars on FRAME that haven't been saved since the
5378 last call to `*condemn_scroll_bars_hook'. */
5380 static void
5381 XTjudge_scroll_bars (FRAME_PTR f)
5383 Lisp_Object bar, next;
5385 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5387 /* Clear out the condemned list now so we won't try to process any
5388 more events on the hapless scroll bars. */
5389 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5391 for (; ! NILP (bar); bar = next)
5393 struct scroll_bar *b = XSCROLL_BAR (bar);
5395 x_scroll_bar_remove (b);
5397 next = b->next;
5398 b->next = b->prev = Qnil;
5401 /* Now there should be no references to the condemned scroll bars,
5402 and they should get garbage-collected. */
5406 #ifndef USE_TOOLKIT_SCROLL_BARS
5407 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5408 is a no-op when using toolkit scroll bars.
5410 This may be called from a signal handler, so we have to ignore GC
5411 mark bits. */
5413 static void
5414 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5416 Window w = bar->x_window;
5417 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5418 GC gc = f->output_data.x->normal_gc;
5419 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5421 BLOCK_INPUT;
5423 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5425 /* Switch to scroll bar foreground color. */
5426 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5427 XSetForeground (FRAME_X_DISPLAY (f), gc,
5428 f->output_data.x->scroll_bar_foreground_pixel);
5430 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5431 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5433 /* x, y, width, height */
5434 0, 0,
5435 bar->width - 1 - width_trim - width_trim,
5436 bar->height - 1);
5438 /* Restore the foreground color of the GC if we changed it above. */
5439 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5440 XSetForeground (FRAME_X_DISPLAY (f), gc,
5441 FRAME_FOREGROUND_PIXEL (f));
5443 UNBLOCK_INPUT;
5446 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5448 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5449 is set to something other than NO_EVENT, it is enqueued.
5451 This may be called from a signal handler, so we have to ignore GC
5452 mark bits. */
5455 static void
5456 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5458 if (! WINDOWP (bar->window))
5459 abort ();
5461 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5462 emacs_event->code = event->xbutton.button - Button1;
5463 emacs_event->modifiers
5464 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5465 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5466 event->xbutton.state)
5467 | (event->type == ButtonRelease
5468 ? up_modifier
5469 : down_modifier));
5470 emacs_event->frame_or_window = bar->window;
5471 emacs_event->arg = Qnil;
5472 emacs_event->timestamp = event->xbutton.time;
5474 int top_range
5475 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5476 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5478 if (y < 0) y = 0;
5479 if (y > top_range) y = top_range;
5481 if (y < bar->start)
5482 emacs_event->part = scroll_bar_above_handle;
5483 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5484 emacs_event->part = scroll_bar_handle;
5485 else
5486 emacs_event->part = scroll_bar_below_handle;
5488 #ifndef USE_TOOLKIT_SCROLL_BARS
5489 /* If the user has released the handle, set it to its final position. */
5490 if (event->type == ButtonRelease
5491 && ! NILP (bar->dragging))
5493 int new_start = y - XINT (bar->dragging);
5494 int new_end = new_start + bar->end - bar->start;
5496 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5497 bar->dragging = Qnil;
5499 #endif
5501 XSETINT (emacs_event->x, y);
5502 XSETINT (emacs_event->y, top_range);
5506 #ifndef USE_TOOLKIT_SCROLL_BARS
5508 /* Handle some mouse motion while someone is dragging the scroll bar.
5510 This may be called from a signal handler, so we have to ignore GC
5511 mark bits. */
5513 static void
5514 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5516 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5518 last_mouse_movement_time = event->xmotion.time;
5520 f->mouse_moved = 1;
5521 XSETVECTOR (last_mouse_scroll_bar, bar);
5523 /* If we're dragging the bar, display it. */
5524 if (! NILP (bar->dragging))
5526 /* Where should the handle be now? */
5527 int new_start = event->xmotion.y - XINT (bar->dragging);
5529 if (new_start != bar->start)
5531 int new_end = new_start + bar->end - bar->start;
5533 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5538 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5540 /* Return information to the user about the current position of the mouse
5541 on the scroll bar. */
5543 static void
5544 x_scroll_bar_report_motion (FRAME_PTR *fp, Lisp_Object *bar_window, enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y, long unsigned int *time)
5546 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5547 Window w = bar->x_window;
5548 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5549 int win_x, win_y;
5550 Window dummy_window;
5551 int dummy_coord;
5552 unsigned int dummy_mask;
5554 BLOCK_INPUT;
5556 /* Get the mouse's position relative to the scroll bar window, and
5557 report that. */
5558 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5560 /* Root, child, root x and root y. */
5561 &dummy_window, &dummy_window,
5562 &dummy_coord, &dummy_coord,
5564 /* Position relative to scroll bar. */
5565 &win_x, &win_y,
5567 /* Mouse buttons and modifier keys. */
5568 &dummy_mask))
5570 else
5572 int top_range
5573 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5575 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5577 if (! NILP (bar->dragging))
5578 win_y -= XINT (bar->dragging);
5580 if (win_y < 0)
5581 win_y = 0;
5582 if (win_y > top_range)
5583 win_y = top_range;
5585 *fp = f;
5586 *bar_window = bar->window;
5588 if (! NILP (bar->dragging))
5589 *part = scroll_bar_handle;
5590 else if (win_y < bar->start)
5591 *part = scroll_bar_above_handle;
5592 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5593 *part = scroll_bar_handle;
5594 else
5595 *part = scroll_bar_below_handle;
5597 XSETINT (*x, win_y);
5598 XSETINT (*y, top_range);
5600 f->mouse_moved = 0;
5601 last_mouse_scroll_bar = Qnil;
5604 *time = last_mouse_movement_time;
5606 UNBLOCK_INPUT;
5610 /* The screen has been cleared so we may have changed foreground or
5611 background colors, and the scroll bars may need to be redrawn.
5612 Clear out the scroll bars, and ask for expose events, so we can
5613 redraw them. */
5615 static void
5616 x_scroll_bar_clear (FRAME_PTR f)
5618 #ifndef USE_TOOLKIT_SCROLL_BARS
5619 Lisp_Object bar;
5621 /* We can have scroll bars even if this is 0,
5622 if we just turned off scroll bar mode.
5623 But in that case we should not clear them. */
5624 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5625 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5626 bar = XSCROLL_BAR (bar)->next)
5627 XClearArea (FRAME_X_DISPLAY (f),
5628 XSCROLL_BAR (bar)->x_window,
5629 0, 0, 0, 0, True);
5630 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5634 /* The main X event-reading loop - XTread_socket. */
5636 /* This holds the state XLookupString needs to implement dead keys
5637 and other tricks known as "compose processing". _X Window System_
5638 says that a portable program can't use this, but Stephen Gildea assures
5639 me that letting the compiler initialize it to zeros will work okay.
5641 This must be defined outside of XTread_socket, for the same reasons
5642 given for enter_timestamp, above. */
5644 static XComposeStatus compose_status;
5646 /* Record the last 100 characters stored
5647 to help debug the loss-of-chars-during-GC problem. */
5649 static int temp_index;
5650 static short temp_buffer[100];
5652 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5653 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5654 temp_index = 0; \
5655 temp_buffer[temp_index++] = (keysym)
5657 /* Set this to nonzero to fake an "X I/O error"
5658 on a particular display. */
5660 struct x_display_info *XTread_socket_fake_io_error;
5662 /* When we find no input here, we occasionally do a no-op command
5663 to verify that the X server is still running and we can still talk with it.
5664 We try all the open displays, one by one.
5665 This variable is used for cycling thru the displays. */
5667 static struct x_display_info *next_noop_dpyinfo;
5669 #define SET_SAVED_BUTTON_EVENT \
5670 do \
5672 if (f->output_data.x->saved_menu_event == 0) \
5673 f->output_data.x->saved_menu_event \
5674 = (XEvent *) xmalloc (sizeof (XEvent)); \
5675 *f->output_data.x->saved_menu_event = event; \
5676 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5677 XSETFRAME (inev.ie.frame_or_window, f); \
5679 while (0)
5681 enum
5683 X_EVENT_NORMAL,
5684 X_EVENT_GOTO_OUT,
5685 X_EVENT_DROP
5688 /* Filter events for the current X input method.
5689 DPYINFO is the display this event is for.
5690 EVENT is the X event to filter.
5692 Returns non-zero if the event was filtered, caller shall not process
5693 this event further.
5694 Returns zero if event is wasn't filtered. */
5696 #ifdef HAVE_X_I18N
5697 static int
5698 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5700 /* XFilterEvent returns non-zero if the input method has
5701 consumed the event. We pass the frame's X window to
5702 XFilterEvent because that's the one for which the IC
5703 was created. */
5705 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5706 event->xclient.window);
5708 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5710 #endif
5712 #ifdef USE_GTK
5713 static int current_count;
5714 static int current_finish;
5715 static struct input_event *current_hold_quit;
5717 /* This is the filter function invoked by the GTK event loop.
5718 It is invoked before the XEvent is translated to a GdkEvent,
5719 so we have a chance to act on the event before GTK. */
5720 static GdkFilterReturn
5721 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5723 XEvent *xev = (XEvent *) gxev;
5725 BLOCK_INPUT;
5726 if (current_count >= 0)
5728 struct x_display_info *dpyinfo;
5730 dpyinfo = x_display_info_for_display (xev->xany.display);
5732 #ifdef HAVE_X_I18N
5733 /* Filter events for the current X input method.
5734 GTK calls XFilterEvent but not for key press and release,
5735 so we do it here. */
5736 if ((xev->type == KeyPress || xev->type == KeyRelease)
5737 && dpyinfo
5738 && x_filter_event (dpyinfo, xev))
5740 UNBLOCK_INPUT;
5741 return GDK_FILTER_REMOVE;
5743 #endif
5745 if (! dpyinfo)
5746 current_finish = X_EVENT_NORMAL;
5747 else
5748 current_count +=
5749 handle_one_xevent (dpyinfo, xev, &current_finish,
5750 current_hold_quit);
5752 else
5753 current_finish = x_dispatch_event (xev, xev->xany.display);
5755 UNBLOCK_INPUT;
5757 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5758 return GDK_FILTER_REMOVE;
5760 return GDK_FILTER_CONTINUE;
5762 #endif /* USE_GTK */
5765 static void xembed_send_message (struct frame *f, Time time,
5766 enum xembed_message message,
5767 long detail, long data1, long data2);
5769 /* Handles the XEvent EVENT on display DPYINFO.
5771 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5772 *FINISH is zero if caller should continue reading events.
5773 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5775 We return the number of characters stored into the buffer. */
5777 static int
5778 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventp, int *finish, struct input_event *hold_quit)
5780 union {
5781 struct input_event ie;
5782 struct selection_input_event sie;
5783 } inev;
5784 int count = 0;
5785 int do_help = 0;
5786 int nbytes = 0;
5787 struct frame *f = NULL;
5788 struct coding_system coding;
5789 XEvent event = *eventp;
5790 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5792 *finish = X_EVENT_NORMAL;
5794 EVENT_INIT (inev.ie);
5795 inev.ie.kind = NO_EVENT;
5796 inev.ie.arg = Qnil;
5798 if (pending_event_wait.eventtype == event.type)
5799 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5801 switch (event.type)
5803 case ClientMessage:
5805 if (event.xclient.message_type
5806 == dpyinfo->Xatom_wm_protocols
5807 && event.xclient.format == 32)
5809 if (event.xclient.data.l[0]
5810 == dpyinfo->Xatom_wm_take_focus)
5812 /* Use x_any_window_to_frame because this
5813 could be the shell widget window
5814 if the frame has no title bar. */
5815 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5816 #ifdef HAVE_X_I18N
5817 /* Not quite sure this is needed -pd */
5818 if (f && FRAME_XIC (f))
5819 XSetICFocus (FRAME_XIC (f));
5820 #endif
5821 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5822 instructs the WM to set the input focus automatically for
5823 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5824 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5825 it has set the focus. So, XSetInputFocus below is not
5826 needed.
5828 The call to XSetInputFocus below has also caused trouble. In
5829 cases where the XSetInputFocus done by the WM and the one
5830 below are temporally close (on a fast machine), the call
5831 below can generate additional FocusIn events which confuse
5832 Emacs. */
5834 /* Since we set WM_TAKE_FOCUS, we must call
5835 XSetInputFocus explicitly. But not if f is null,
5836 since that might be an event for a deleted frame. */
5837 if (f)
5839 Display *d = event.xclient.display;
5840 /* Catch and ignore errors, in case window has been
5841 iconified by a window manager such as GWM. */
5842 x_catch_errors (d);
5843 XSetInputFocus (d, event.xclient.window,
5844 /* The ICCCM says this is
5845 the only valid choice. */
5846 RevertToParent,
5847 event.xclient.data.l[1]);
5848 /* This is needed to detect the error
5849 if there is an error. */
5850 XSync (d, False);
5851 x_uncatch_errors ();
5853 /* Not certain about handling scroll bars here */
5854 #endif /* 0 */
5855 goto done;
5858 if (event.xclient.data.l[0]
5859 == dpyinfo->Xatom_wm_save_yourself)
5861 /* Save state modify the WM_COMMAND property to
5862 something which can reinstate us. This notifies
5863 the session manager, who's looking for such a
5864 PropertyNotify. Can restart processing when
5865 a keyboard or mouse event arrives. */
5866 /* If we have a session manager, don't set this.
5867 KDE will then start two Emacsen, one for the
5868 session manager and one for this. */
5869 #ifdef HAVE_X_SM
5870 if (! x_session_have_connection ())
5871 #endif
5873 f = x_top_window_to_frame (dpyinfo,
5874 event.xclient.window);
5875 /* This is just so we only give real data once
5876 for a single Emacs process. */
5877 if (f == SELECTED_FRAME ())
5878 XSetCommand (FRAME_X_DISPLAY (f),
5879 event.xclient.window,
5880 initial_argv, initial_argc);
5881 else if (f)
5882 XSetCommand (FRAME_X_DISPLAY (f),
5883 event.xclient.window,
5884 0, 0);
5886 goto done;
5889 if (event.xclient.data.l[0]
5890 == dpyinfo->Xatom_wm_delete_window)
5892 f = x_any_window_to_frame (dpyinfo,
5893 event.xclient.window);
5894 if (!f)
5895 goto OTHER; /* May be a dialog that is to be removed */
5897 inev.ie.kind = DELETE_WINDOW_EVENT;
5898 XSETFRAME (inev.ie.frame_or_window, f);
5899 goto done;
5902 goto done;
5905 if (event.xclient.message_type
5906 == dpyinfo->Xatom_wm_configure_denied)
5908 goto done;
5911 if (event.xclient.message_type
5912 == dpyinfo->Xatom_wm_window_moved)
5914 int new_x, new_y;
5915 f = x_window_to_frame (dpyinfo, event.xclient.window);
5917 new_x = event.xclient.data.s[0];
5918 new_y = event.xclient.data.s[1];
5920 if (f)
5922 f->left_pos = new_x;
5923 f->top_pos = new_y;
5925 goto done;
5928 #ifdef HACK_EDITRES
5929 if (event.xclient.message_type
5930 == dpyinfo->Xatom_editres)
5932 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5933 if (f)
5934 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5935 &event, NULL);
5936 goto done;
5938 #endif /* HACK_EDITRES */
5940 if ((event.xclient.message_type
5941 == dpyinfo->Xatom_DONE)
5942 || (event.xclient.message_type
5943 == dpyinfo->Xatom_PAGE))
5945 /* Ghostview job completed. Kill it. We could
5946 reply with "Next" if we received "Page", but we
5947 currently never do because we are interested in
5948 images, only, which should have 1 page. */
5949 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5950 f = x_window_to_frame (dpyinfo, event.xclient.window);
5951 if (!f)
5952 goto OTHER;
5953 x_kill_gs_process (pixmap, f);
5954 expose_frame (f, 0, 0, 0, 0);
5955 goto done;
5958 #ifdef USE_TOOLKIT_SCROLL_BARS
5959 /* Scroll bar callbacks send a ClientMessage from which
5960 we construct an input_event. */
5961 if (event.xclient.message_type
5962 == dpyinfo->Xatom_Scrollbar)
5964 x_scroll_bar_to_input_event (&event, &inev.ie);
5965 *finish = X_EVENT_GOTO_OUT;
5966 goto done;
5968 #endif /* USE_TOOLKIT_SCROLL_BARS */
5970 /* XEmbed messages from the embedder (if any). */
5971 if (event.xclient.message_type
5972 == dpyinfo->Xatom_XEMBED)
5974 enum xembed_message msg = event.xclient.data.l[1];
5975 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
5976 x_detect_focus_change (dpyinfo, &event, &inev.ie);
5978 *finish = X_EVENT_GOTO_OUT;
5979 goto done;
5982 xft_settings_event (dpyinfo, &event);
5984 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5985 if (!f)
5986 goto OTHER;
5987 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
5988 *finish = X_EVENT_DROP;
5990 break;
5992 case SelectionNotify:
5993 last_user_time = event.xselection.time;
5994 #ifdef USE_X_TOOLKIT
5995 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
5996 goto OTHER;
5997 #endif /* not USE_X_TOOLKIT */
5998 x_handle_selection_notify (&event.xselection);
5999 break;
6001 case SelectionClear: /* Someone has grabbed ownership. */
6002 last_user_time = event.xselectionclear.time;
6003 #ifdef USE_X_TOOLKIT
6004 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6005 goto OTHER;
6006 #endif /* USE_X_TOOLKIT */
6008 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6010 inev.ie.kind = SELECTION_CLEAR_EVENT;
6011 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6012 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6013 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6014 inev.ie.frame_or_window = Qnil;
6016 break;
6018 case SelectionRequest: /* Someone wants our selection. */
6019 last_user_time = event.xselectionrequest.time;
6020 #ifdef USE_X_TOOLKIT
6021 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6022 goto OTHER;
6023 #endif /* USE_X_TOOLKIT */
6025 XSelectionRequestEvent *eventp
6026 = (XSelectionRequestEvent *) &event;
6028 inev.ie.kind = SELECTION_REQUEST_EVENT;
6029 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6030 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6031 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6032 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6033 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6034 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6035 inev.ie.frame_or_window = Qnil;
6037 break;
6039 case PropertyNotify:
6040 last_user_time = event.xproperty.time;
6041 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6042 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6043 x_handle_net_wm_state (f, &event.xproperty);
6045 x_handle_property_notify (&event.xproperty);
6046 xft_settings_event (dpyinfo, &event);
6047 goto OTHER;
6049 case ReparentNotify:
6050 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6051 if (f)
6053 int x, y;
6054 f->output_data.x->parent_desc = event.xreparent.parent;
6055 x_real_positions (f, &x, &y);
6056 f->left_pos = x;
6057 f->top_pos = y;
6059 /* Perhaps reparented due to a WM restart. Reset this. */
6060 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6061 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6063 goto OTHER;
6065 case Expose:
6066 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6067 if (f)
6069 #ifdef USE_GTK
6070 /* This seems to be needed for GTK 2.6. */
6071 x_clear_area (event.xexpose.display,
6072 event.xexpose.window,
6073 event.xexpose.x, event.xexpose.y,
6074 event.xexpose.width, event.xexpose.height,
6075 FALSE);
6076 #endif
6077 if (f->async_visible == 0)
6079 f->async_visible = 1;
6080 f->async_iconified = 0;
6081 f->output_data.x->has_been_visible = 1;
6082 SET_FRAME_GARBAGED (f);
6084 else
6085 expose_frame (f,
6086 event.xexpose.x, event.xexpose.y,
6087 event.xexpose.width, event.xexpose.height);
6089 else
6091 #ifndef USE_TOOLKIT_SCROLL_BARS
6092 struct scroll_bar *bar;
6093 #endif
6094 #if defined USE_LUCID
6095 /* Submenus of the Lucid menu bar aren't widgets
6096 themselves, so there's no way to dispatch events
6097 to them. Recognize this case separately. */
6099 Widget widget
6100 = x_window_to_menu_bar (event.xexpose.window);
6101 if (widget)
6102 xlwmenu_redisplay (widget);
6104 #endif /* USE_LUCID */
6106 #ifdef USE_TOOLKIT_SCROLL_BARS
6107 /* Dispatch event to the widget. */
6108 goto OTHER;
6109 #else /* not USE_TOOLKIT_SCROLL_BARS */
6110 bar = x_window_to_scroll_bar (event.xexpose.display,
6111 event.xexpose.window);
6113 if (bar)
6114 x_scroll_bar_expose (bar, &event);
6115 #ifdef USE_X_TOOLKIT
6116 else
6117 goto OTHER;
6118 #endif /* USE_X_TOOLKIT */
6119 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6121 break;
6123 case GraphicsExpose: /* This occurs when an XCopyArea's
6124 source area was obscured or not
6125 available. */
6126 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6127 if (f)
6129 expose_frame (f,
6130 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6131 event.xgraphicsexpose.width,
6132 event.xgraphicsexpose.height);
6134 #ifdef USE_X_TOOLKIT
6135 else
6136 goto OTHER;
6137 #endif /* USE_X_TOOLKIT */
6138 break;
6140 case NoExpose: /* This occurs when an XCopyArea's
6141 source area was completely
6142 available. */
6143 break;
6145 case UnmapNotify:
6146 /* Redo the mouse-highlight after the tooltip has gone. */
6147 if (event.xmap.window == tip_window)
6149 tip_window = 0;
6150 redo_mouse_highlight ();
6153 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6154 if (f) /* F may no longer exist if
6155 the frame was deleted. */
6157 /* While a frame is unmapped, display generation is
6158 disabled; you don't want to spend time updating a
6159 display that won't ever be seen. */
6160 f->async_visible = 0;
6161 /* We can't distinguish, from the event, whether the window
6162 has become iconified or invisible. So assume, if it
6163 was previously visible, than now it is iconified.
6164 But x_make_frame_invisible clears both
6165 the visible flag and the iconified flag;
6166 and that way, we know the window is not iconified now. */
6167 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6169 f->async_iconified = 1;
6171 inev.ie.kind = ICONIFY_EVENT;
6172 XSETFRAME (inev.ie.frame_or_window, f);
6175 goto OTHER;
6177 case MapNotify:
6178 if (event.xmap.window == tip_window)
6179 /* The tooltip has been drawn already. Avoid
6180 the SET_FRAME_GARBAGED below. */
6181 goto OTHER;
6183 /* We use x_top_window_to_frame because map events can
6184 come for sub-windows and they don't mean that the
6185 frame is visible. */
6186 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6187 if (f)
6189 /* wait_reading_process_output will notice this and update
6190 the frame's display structures.
6191 If we where iconified, we should not set garbaged,
6192 because that stops redrawing on Expose events. This looks
6193 bad if we are called from a recursive event loop
6194 (x_dispatch_event), for example when a dialog is up. */
6195 if (! f->async_iconified)
6196 SET_FRAME_GARBAGED (f);
6198 /* Check if fullscreen was specified before we where mapped the
6199 first time, i.e. from the command line. */
6200 if (!f->output_data.x->has_been_visible)
6201 x_check_fullscreen (f);
6203 f->async_visible = 1;
6204 f->async_iconified = 0;
6205 f->output_data.x->has_been_visible = 1;
6207 if (f->iconified)
6209 inev.ie.kind = DEICONIFY_EVENT;
6210 XSETFRAME (inev.ie.frame_or_window, f);
6212 else if (! NILP (Vframe_list)
6213 && ! NILP (XCDR (Vframe_list)))
6214 /* Force a redisplay sooner or later
6215 to update the frame titles
6216 in case this is the second frame. */
6217 record_asynch_buffer_change ();
6219 #ifdef USE_GTK
6220 xg_frame_resized (f, -1, -1);
6221 #endif
6223 goto OTHER;
6225 case KeyPress:
6227 last_user_time = event.xkey.time;
6228 ignore_next_mouse_click_timeout = 0;
6230 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6231 /* Dispatch KeyPress events when in menu. */
6232 if (popup_activated ())
6233 goto OTHER;
6234 #endif
6236 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6238 /* If mouse-highlight is an integer, input clears out
6239 mouse highlighting. */
6240 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6241 && (f == 0
6242 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6244 clear_mouse_face (hlinfo);
6245 hlinfo->mouse_face_hidden = 1;
6248 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6249 if (f == 0)
6251 /* Scroll bars consume key events, but we want
6252 the keys to go to the scroll bar's frame. */
6253 Widget widget = XtWindowToWidget (dpyinfo->display,
6254 event.xkey.window);
6255 if (widget && XmIsScrollBar (widget))
6257 widget = XtParent (widget);
6258 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6261 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6263 if (f != 0)
6265 KeySym keysym, orig_keysym;
6266 /* al%imercury@uunet.uu.net says that making this 81
6267 instead of 80 fixed a bug whereby meta chars made
6268 his Emacs hang.
6270 It seems that some version of XmbLookupString has
6271 a bug of not returning XBufferOverflow in
6272 status_return even if the input is too long to
6273 fit in 81 bytes. So, we must prepare sufficient
6274 bytes for copy_buffer. 513 bytes (256 chars for
6275 two-byte character set) seems to be a fairly good
6276 approximation. -- 2000.8.10 handa@etl.go.jp */
6277 unsigned char copy_buffer[513];
6278 unsigned char *copy_bufptr = copy_buffer;
6279 int copy_bufsiz = sizeof (copy_buffer);
6280 int modifiers;
6281 Lisp_Object coding_system = Qlatin_1;
6282 Lisp_Object c;
6284 #ifdef USE_GTK
6285 /* Don't pass keys to GTK. A Tab will shift focus to the
6286 tool bar in GTK 2.4. Keys will still go to menus and
6287 dialogs because in that case popup_activated is TRUE
6288 (see above). */
6289 *finish = X_EVENT_DROP;
6290 #endif
6292 event.xkey.state
6293 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6294 extra_keyboard_modifiers);
6295 modifiers = event.xkey.state;
6297 /* This will have to go some day... */
6299 /* make_lispy_event turns chars into control chars.
6300 Don't do it here because XLookupString is too eager. */
6301 event.xkey.state &= ~ControlMask;
6302 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6303 | dpyinfo->super_mod_mask
6304 | dpyinfo->hyper_mod_mask
6305 | dpyinfo->alt_mod_mask);
6307 /* In case Meta is ComposeCharacter,
6308 clear its status. According to Markus Ehrnsperger
6309 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6310 this enables ComposeCharacter to work whether or
6311 not it is combined with Meta. */
6312 if (modifiers & dpyinfo->meta_mod_mask)
6313 memset (&compose_status, 0, sizeof (compose_status));
6315 #ifdef HAVE_X_I18N
6316 if (FRAME_XIC (f))
6318 Status status_return;
6320 coding_system = Vlocale_coding_system;
6321 nbytes = XmbLookupString (FRAME_XIC (f),
6322 &event.xkey, (char *) copy_bufptr,
6323 copy_bufsiz, &keysym,
6324 &status_return);
6325 if (status_return == XBufferOverflow)
6327 copy_bufsiz = nbytes + 1;
6328 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6329 nbytes = XmbLookupString (FRAME_XIC (f),
6330 &event.xkey, (char *) copy_bufptr,
6331 copy_bufsiz, &keysym,
6332 &status_return);
6334 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6335 if (status_return == XLookupNone)
6336 break;
6337 else if (status_return == XLookupChars)
6339 keysym = NoSymbol;
6340 modifiers = 0;
6342 else if (status_return != XLookupKeySym
6343 && status_return != XLookupBoth)
6344 abort ();
6346 else
6347 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6348 copy_bufsiz, &keysym,
6349 &compose_status);
6350 #else
6351 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6352 copy_bufsiz, &keysym,
6353 &compose_status);
6354 #endif
6356 /* If not using XIM/XIC, and a compose sequence is in progress,
6357 we break here. Otherwise, chars_matched is always 0. */
6358 if (compose_status.chars_matched > 0 && nbytes == 0)
6359 break;
6361 memset (&compose_status, 0, sizeof (compose_status));
6362 orig_keysym = keysym;
6364 /* Common for all keysym input events. */
6365 XSETFRAME (inev.ie.frame_or_window, f);
6366 inev.ie.modifiers
6367 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6368 inev.ie.timestamp = event.xkey.time;
6370 /* First deal with keysyms which have defined
6371 translations to characters. */
6372 if (keysym >= 32 && keysym < 128)
6373 /* Avoid explicitly decoding each ASCII character. */
6375 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6376 inev.ie.code = keysym;
6377 goto done_keysym;
6380 /* Keysyms directly mapped to Unicode characters. */
6381 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6383 if (keysym < 0x01000080)
6384 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6385 else
6386 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6387 inev.ie.code = keysym & 0xFFFFFF;
6388 goto done_keysym;
6391 /* Now non-ASCII. */
6392 if (HASH_TABLE_P (Vx_keysym_table)
6393 && (NATNUMP (c = Fgethash (make_number (keysym),
6394 Vx_keysym_table,
6395 Qnil))))
6397 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6398 ? ASCII_KEYSTROKE_EVENT
6399 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6400 inev.ie.code = XFASTINT (c);
6401 goto done_keysym;
6404 /* Random non-modifier sorts of keysyms. */
6405 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6406 || keysym == XK_Delete
6407 #ifdef XK_ISO_Left_Tab
6408 || (keysym >= XK_ISO_Left_Tab
6409 && keysym <= XK_ISO_Enter)
6410 #endif
6411 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6412 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6413 #ifdef HPUX
6414 /* This recognizes the "extended function
6415 keys". It seems there's no cleaner way.
6416 Test IsModifierKey to avoid handling
6417 mode_switch incorrectly. */
6418 || ((unsigned) (keysym) >= XK_Select
6419 && (unsigned)(keysym) < XK_KP_Space)
6420 #endif
6421 #ifdef XK_dead_circumflex
6422 || orig_keysym == XK_dead_circumflex
6423 #endif
6424 #ifdef XK_dead_grave
6425 || orig_keysym == XK_dead_grave
6426 #endif
6427 #ifdef XK_dead_tilde
6428 || orig_keysym == XK_dead_tilde
6429 #endif
6430 #ifdef XK_dead_diaeresis
6431 || orig_keysym == XK_dead_diaeresis
6432 #endif
6433 #ifdef XK_dead_macron
6434 || orig_keysym == XK_dead_macron
6435 #endif
6436 #ifdef XK_dead_degree
6437 || orig_keysym == XK_dead_degree
6438 #endif
6439 #ifdef XK_dead_acute
6440 || orig_keysym == XK_dead_acute
6441 #endif
6442 #ifdef XK_dead_cedilla
6443 || orig_keysym == XK_dead_cedilla
6444 #endif
6445 #ifdef XK_dead_breve
6446 || orig_keysym == XK_dead_breve
6447 #endif
6448 #ifdef XK_dead_ogonek
6449 || orig_keysym == XK_dead_ogonek
6450 #endif
6451 #ifdef XK_dead_caron
6452 || orig_keysym == XK_dead_caron
6453 #endif
6454 #ifdef XK_dead_doubleacute
6455 || orig_keysym == XK_dead_doubleacute
6456 #endif
6457 #ifdef XK_dead_abovedot
6458 || orig_keysym == XK_dead_abovedot
6459 #endif
6460 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6461 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6462 /* Any "vendor-specific" key is ok. */
6463 || (orig_keysym & (1 << 28))
6464 || (keysym != NoSymbol && nbytes == 0))
6465 && ! (IsModifierKey (orig_keysym)
6466 /* The symbols from XK_ISO_Lock
6467 to XK_ISO_Last_Group_Lock
6468 don't have real modifiers but
6469 should be treated similarly to
6470 Mode_switch by Emacs. */
6471 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6472 || ((unsigned)(orig_keysym)
6473 >= XK_ISO_Lock
6474 && (unsigned)(orig_keysym)
6475 <= XK_ISO_Last_Group_Lock)
6476 #endif
6479 STORE_KEYSYM_FOR_DEBUG (keysym);
6480 /* make_lispy_event will convert this to a symbolic
6481 key. */
6482 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6483 inev.ie.code = keysym;
6484 goto done_keysym;
6487 { /* Raw bytes, not keysym. */
6488 register int i;
6489 register int c;
6490 int nchars, len;
6492 for (i = 0, nchars = 0; i < nbytes; i++)
6494 if (ASCII_BYTE_P (copy_bufptr[i]))
6495 nchars++;
6496 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6499 if (nchars < nbytes)
6501 /* Decode the input data. */
6502 int require;
6504 /* The input should be decoded with `coding_system'
6505 which depends on which X*LookupString function
6506 we used just above and the locale. */
6507 setup_coding_system (coding_system, &coding);
6508 coding.src_multibyte = 0;
6509 coding.dst_multibyte = 1;
6510 /* The input is converted to events, thus we can't
6511 handle composition. Anyway, there's no XIM that
6512 gives us composition information. */
6513 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6515 require = MAX_MULTIBYTE_LENGTH * nbytes;
6516 coding.destination = alloca (require);
6517 coding.dst_bytes = require;
6518 coding.mode |= CODING_MODE_LAST_BLOCK;
6519 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6520 nbytes = coding.produced;
6521 nchars = coding.produced_char;
6522 copy_bufptr = coding.destination;
6525 /* Convert the input data to a sequence of
6526 character events. */
6527 for (i = 0; i < nbytes; i += len)
6529 if (nchars == nbytes)
6530 c = copy_bufptr[i], len = 1;
6531 else
6532 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6533 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6534 ? ASCII_KEYSTROKE_EVENT
6535 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6536 inev.ie.code = c;
6537 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6540 count += nchars;
6542 inev.ie.kind = NO_EVENT; /* Already stored above. */
6544 if (keysym == NoSymbol)
6545 break;
6548 done_keysym:
6549 #ifdef HAVE_X_I18N
6550 /* Don't dispatch this event since XtDispatchEvent calls
6551 XFilterEvent, and two calls in a row may freeze the
6552 client. */
6553 break;
6554 #else
6555 goto OTHER;
6556 #endif
6558 case KeyRelease:
6559 last_user_time = event.xkey.time;
6560 #ifdef HAVE_X_I18N
6561 /* Don't dispatch this event since XtDispatchEvent calls
6562 XFilterEvent, and two calls in a row may freeze the
6563 client. */
6564 break;
6565 #else
6566 goto OTHER;
6567 #endif
6569 case EnterNotify:
6570 last_user_time = event.xcrossing.time;
6571 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6573 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6575 if (f && x_mouse_click_focus_ignore_position)
6576 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6578 /* EnterNotify counts as mouse movement,
6579 so update things that depend on mouse position. */
6580 if (f && !f->output_data.x->hourglass_p)
6581 note_mouse_movement (f, &event.xmotion);
6582 #ifdef USE_GTK
6583 /* We may get an EnterNotify on the buttons in the toolbar. In that
6584 case we moved out of any highlighted area and need to note this. */
6585 if (!f && last_mouse_glyph_frame)
6586 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6587 #endif
6588 goto OTHER;
6590 case FocusIn:
6591 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6592 goto OTHER;
6594 case LeaveNotify:
6595 last_user_time = event.xcrossing.time;
6596 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6598 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6599 if (f)
6601 if (f == hlinfo->mouse_face_mouse_frame)
6603 /* If we move outside the frame, then we're
6604 certainly no longer on any text in the frame. */
6605 clear_mouse_face (hlinfo);
6606 hlinfo->mouse_face_mouse_frame = 0;
6609 /* Generate a nil HELP_EVENT to cancel a help-echo.
6610 Do it only if there's something to cancel.
6611 Otherwise, the startup message is cleared when
6612 the mouse leaves the frame. */
6613 if (any_help_event_p)
6614 do_help = -1;
6616 #ifdef USE_GTK
6617 /* See comment in EnterNotify above */
6618 else if (last_mouse_glyph_frame)
6619 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6620 #endif
6621 goto OTHER;
6623 case FocusOut:
6624 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6625 goto OTHER;
6627 case MotionNotify:
6629 last_user_time = event.xmotion.time;
6630 previous_help_echo_string = help_echo_string;
6631 help_echo_string = Qnil;
6633 if (dpyinfo->grabbed && last_mouse_frame
6634 && FRAME_LIVE_P (last_mouse_frame))
6635 f = last_mouse_frame;
6636 else
6637 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6639 if (hlinfo->mouse_face_hidden)
6641 hlinfo->mouse_face_hidden = 0;
6642 clear_mouse_face (hlinfo);
6645 #ifdef USE_GTK
6646 if (f && xg_event_is_for_scrollbar (f, &event))
6647 f = 0;
6648 #endif
6649 if (f)
6652 /* Generate SELECT_WINDOW_EVENTs when needed.
6653 Don't let popup menus influence things (bug#1261). */
6654 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6656 Lisp_Object window;
6658 window = window_from_coordinates (f,
6659 event.xmotion.x, event.xmotion.y,
6660 0, 0);
6662 /* Window will be selected only when it is not selected now and
6663 last mouse movement event was not in it. Minibuffer window
6664 will be selected only when it is active. */
6665 if (WINDOWP (window)
6666 && !EQ (window, last_window)
6667 && !EQ (window, selected_window)
6668 /* For click-to-focus window managers
6669 create event iff we don't leave the
6670 selected frame. */
6671 && (focus_follows_mouse
6672 || (EQ (XWINDOW (window)->frame,
6673 XWINDOW (selected_window)->frame))))
6675 inev.ie.kind = SELECT_WINDOW_EVENT;
6676 inev.ie.frame_or_window = window;
6679 last_window=window;
6681 if (!note_mouse_movement (f, &event.xmotion))
6682 help_echo_string = previous_help_echo_string;
6684 else
6686 #ifndef USE_TOOLKIT_SCROLL_BARS
6687 struct scroll_bar *bar
6688 = x_window_to_scroll_bar (event.xmotion.display,
6689 event.xmotion.window);
6691 if (bar)
6692 x_scroll_bar_note_movement (bar, &event);
6693 #endif /* USE_TOOLKIT_SCROLL_BARS */
6695 /* If we move outside the frame, then we're
6696 certainly no longer on any text in the frame. */
6697 clear_mouse_face (hlinfo);
6700 /* If the contents of the global variable help_echo_string
6701 has changed, generate a HELP_EVENT. */
6702 if (!NILP (help_echo_string)
6703 || !NILP (previous_help_echo_string))
6704 do_help = 1;
6705 goto OTHER;
6708 case ConfigureNotify:
6709 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6710 #ifdef USE_GTK
6711 if (!f
6712 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6713 && event.xconfigure.window == FRAME_X_WINDOW (f))
6715 xg_frame_resized (f, event.xconfigure.width,
6716 event.xconfigure.height);
6717 f = 0;
6719 #endif
6720 if (f)
6722 #ifndef USE_X_TOOLKIT
6723 #ifndef USE_GTK
6724 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6725 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6727 /* In the toolkit version, change_frame_size
6728 is called by the code that handles resizing
6729 of the EmacsFrame widget. */
6731 /* Even if the number of character rows and columns has
6732 not changed, the font size may have changed, so we need
6733 to check the pixel dimensions as well. */
6734 if (columns != FRAME_COLS (f)
6735 || rows != FRAME_LINES (f)
6736 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6737 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6739 change_frame_size (f, rows, columns, 0, 1, 0);
6740 SET_FRAME_GARBAGED (f);
6741 cancel_mouse_face (f);
6744 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6745 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6746 #endif /* not USE_GTK */
6747 #endif
6749 #ifdef USE_GTK
6750 /* GTK creates windows but doesn't map them.
6751 Only get real positions when mapped. */
6752 if (FRAME_GTK_OUTER_WIDGET (f)
6753 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6754 #endif
6756 x_real_positions (f, &f->left_pos, &f->top_pos);
6759 #ifdef HAVE_X_I18N
6760 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6761 xic_set_statusarea (f);
6762 #endif
6765 goto OTHER;
6767 case ButtonRelease:
6768 case ButtonPress:
6770 /* If we decide we want to generate an event to be seen
6771 by the rest of Emacs, we put it here. */
6772 int tool_bar_p = 0;
6774 memset (&compose_status, 0, sizeof (compose_status));
6775 last_mouse_glyph_frame = 0;
6776 last_user_time = event.xbutton.time;
6778 if (dpyinfo->grabbed
6779 && last_mouse_frame
6780 && FRAME_LIVE_P (last_mouse_frame))
6781 f = last_mouse_frame;
6782 else
6783 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6785 #ifdef USE_GTK
6786 if (f && xg_event_is_for_scrollbar (f, &event))
6787 f = 0;
6788 #endif
6789 if (f)
6791 /* Is this in the tool-bar? */
6792 if (WINDOWP (f->tool_bar_window)
6793 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6795 Lisp_Object window;
6796 int x = event.xbutton.x;
6797 int y = event.xbutton.y;
6799 window = window_from_coordinates (f, x, y, 0, 1);
6800 tool_bar_p = EQ (window, f->tool_bar_window);
6802 if (tool_bar_p && event.xbutton.button < 4)
6804 handle_tool_bar_click (f, x, y,
6805 event.xbutton.type == ButtonPress,
6806 x_x_to_emacs_modifiers (dpyinfo,
6807 event.xbutton.state));
6811 if (!tool_bar_p)
6812 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6813 if (! popup_activated ())
6814 #endif
6816 if (ignore_next_mouse_click_timeout)
6818 if (event.type == ButtonPress
6819 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6821 ignore_next_mouse_click_timeout = 0;
6822 construct_mouse_click (&inev.ie, &event.xbutton, f);
6824 if (event.type == ButtonRelease)
6825 ignore_next_mouse_click_timeout = 0;
6827 else
6828 construct_mouse_click (&inev.ie, &event.xbutton, f);
6830 if (FRAME_X_EMBEDDED_P (f))
6831 xembed_send_message (f, event.xbutton.time,
6832 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6834 else
6836 struct scroll_bar *bar
6837 = x_window_to_scroll_bar (event.xbutton.display,
6838 event.xbutton.window);
6840 #ifdef USE_TOOLKIT_SCROLL_BARS
6841 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6842 scroll bars. */
6843 if (bar && event.xbutton.state & ControlMask)
6845 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6846 *finish = X_EVENT_DROP;
6848 #else /* not USE_TOOLKIT_SCROLL_BARS */
6849 if (bar)
6850 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6851 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6854 if (event.type == ButtonPress)
6856 dpyinfo->grabbed |= (1 << event.xbutton.button);
6857 last_mouse_frame = f;
6859 if (!tool_bar_p)
6860 last_tool_bar_item = -1;
6862 else
6863 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6865 /* Ignore any mouse motion that happened before this event;
6866 any subsequent mouse-movement Emacs events should reflect
6867 only motion after the ButtonPress/Release. */
6868 if (f != 0)
6869 f->mouse_moved = 0;
6871 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6872 f = x_menubar_window_to_frame (dpyinfo, &event);
6873 /* For a down-event in the menu bar,
6874 don't pass it to Xt right now.
6875 Instead, save it away
6876 and we will pass it to Xt from kbd_buffer_get_event.
6877 That way, we can run some Lisp code first. */
6878 if (! popup_activated ()
6879 #ifdef USE_GTK
6880 /* Gtk+ menus only react to the first three buttons. */
6881 && event.xbutton.button < 3
6882 #endif
6883 && f && event.type == ButtonPress
6884 /* Verify the event is really within the menu bar
6885 and not just sent to it due to grabbing. */
6886 && event.xbutton.x >= 0
6887 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6888 && event.xbutton.y >= 0
6889 && event.xbutton.y < f->output_data.x->menubar_height
6890 && event.xbutton.same_screen)
6892 SET_SAVED_BUTTON_EVENT;
6893 XSETFRAME (last_mouse_press_frame, f);
6894 *finish = X_EVENT_DROP;
6896 else if (event.type == ButtonPress)
6898 last_mouse_press_frame = Qnil;
6899 goto OTHER;
6901 else
6902 goto OTHER;
6903 #endif /* USE_X_TOOLKIT || USE_GTK */
6905 break;
6907 case CirculateNotify:
6908 goto OTHER;
6910 case CirculateRequest:
6911 goto OTHER;
6913 case VisibilityNotify:
6914 goto OTHER;
6916 case MappingNotify:
6917 /* Someone has changed the keyboard mapping - update the
6918 local cache. */
6919 switch (event.xmapping.request)
6921 case MappingModifier:
6922 x_find_modifier_meanings (dpyinfo);
6923 /* This is meant to fall through. */
6924 case MappingKeyboard:
6925 XRefreshKeyboardMapping (&event.xmapping);
6927 goto OTHER;
6929 case DestroyNotify:
6930 xft_settings_event (dpyinfo, &event);
6931 break;
6933 default:
6934 OTHER:
6935 #ifdef USE_X_TOOLKIT
6936 BLOCK_INPUT;
6937 if (*finish != X_EVENT_DROP)
6938 XtDispatchEvent (&event);
6939 UNBLOCK_INPUT;
6940 #endif /* USE_X_TOOLKIT */
6941 break;
6944 done:
6945 if (inev.ie.kind != NO_EVENT)
6947 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6948 count++;
6951 if (do_help
6952 && !(hold_quit && hold_quit->kind != NO_EVENT))
6954 Lisp_Object frame;
6956 if (f)
6957 XSETFRAME (frame, f);
6958 else
6959 frame = Qnil;
6961 if (do_help > 0)
6963 any_help_event_p = 1;
6964 gen_help_event (help_echo_string, frame, help_echo_window,
6965 help_echo_object, help_echo_pos);
6967 else
6969 help_echo_string = Qnil;
6970 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6972 count++;
6975 *eventp = event;
6976 return count;
6980 /* Handles the XEvent EVENT on display DISPLAY.
6981 This is used for event loops outside the normal event handling,
6982 i.e. looping while a popup menu or a dialog is posted.
6984 Returns the value handle_one_xevent sets in the finish argument. */
6986 x_dispatch_event (XEvent *event, Display *display)
6988 struct x_display_info *dpyinfo;
6989 int finish = X_EVENT_NORMAL;
6991 dpyinfo = x_display_info_for_display (display);
6993 if (dpyinfo)
6994 handle_one_xevent (dpyinfo, event, &finish, 0);
6996 return finish;
7000 /* Read events coming from the X server.
7001 This routine is called by the SIGIO handler.
7002 We return as soon as there are no more events to be read.
7004 We return the number of characters stored into the buffer,
7005 thus pretending to be `read' (except the characters we store
7006 in the keyboard buffer can be multibyte, so are not necessarily
7007 C chars).
7009 EXPECTED is nonzero if the caller knows input is available. */
7011 static int
7012 XTread_socket (struct terminal *terminal, int expected, struct input_event *hold_quit)
7014 int count = 0;
7015 XEvent event;
7016 int event_found = 0;
7018 if (interrupt_input_blocked)
7020 interrupt_input_pending = 1;
7021 #ifdef SYNC_INPUT
7022 pending_signals = 1;
7023 #endif
7024 return -1;
7027 interrupt_input_pending = 0;
7028 #ifdef SYNC_INPUT
7029 pending_signals = pending_atimers;
7030 #endif
7031 BLOCK_INPUT;
7033 /* So people can tell when we have read the available input. */
7034 input_signal_count++;
7036 ++handling_signal;
7038 /* For debugging, this gives a way to fake an I/O error. */
7039 if (terminal->display_info.x == XTread_socket_fake_io_error)
7041 XTread_socket_fake_io_error = 0;
7042 x_io_error_quitter (terminal->display_info.x->display);
7045 #ifndef USE_GTK
7046 while (XPending (terminal->display_info.x->display))
7048 int finish;
7050 XNextEvent (terminal->display_info.x->display, &event);
7052 #ifdef HAVE_X_I18N
7053 /* Filter events for the current X input method. */
7054 if (x_filter_event (terminal->display_info.x, &event))
7055 continue;
7056 #endif
7057 event_found = 1;
7059 count += handle_one_xevent (terminal->display_info.x,
7060 &event, &finish, hold_quit);
7062 if (finish == X_EVENT_GOTO_OUT)
7063 goto out;
7066 #else /* USE_GTK */
7068 /* For GTK we must use the GTK event loop. But XEvents gets passed
7069 to our filter function above, and then to the big event switch.
7070 We use a bunch of globals to communicate with our filter function,
7071 that is kind of ugly, but it works.
7073 There is no way to do one display at the time, GTK just does events
7074 from all displays. */
7076 while (gtk_events_pending ())
7078 current_count = count;
7079 current_hold_quit = hold_quit;
7081 gtk_main_iteration ();
7083 count = current_count;
7084 current_count = -1;
7085 current_hold_quit = 0;
7087 if (current_finish == X_EVENT_GOTO_OUT)
7088 break;
7090 #endif /* USE_GTK */
7092 out:;
7094 /* On some systems, an X bug causes Emacs to get no more events
7095 when the window is destroyed. Detect that. (1994.) */
7096 if (! event_found)
7098 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7099 One XNOOP in 100 loops will make Emacs terminate.
7100 B. Bretthauer, 1994 */
7101 x_noop_count++;
7102 if (x_noop_count >= 100)
7104 x_noop_count=0;
7106 if (next_noop_dpyinfo == 0)
7107 next_noop_dpyinfo = x_display_list;
7109 XNoOp (next_noop_dpyinfo->display);
7111 /* Each time we get here, cycle through the displays now open. */
7112 next_noop_dpyinfo = next_noop_dpyinfo->next;
7116 /* If the focus was just given to an auto-raising frame,
7117 raise it now. */
7118 /* ??? This ought to be able to handle more than one such frame. */
7119 if (pending_autoraise_frame)
7121 x_raise_frame (pending_autoraise_frame);
7122 pending_autoraise_frame = 0;
7125 --handling_signal;
7126 UNBLOCK_INPUT;
7128 return count;
7134 /***********************************************************************
7135 Text Cursor
7136 ***********************************************************************/
7138 /* Set clipping for output in glyph row ROW. W is the window in which
7139 we operate. GC is the graphics context to set clipping in.
7141 ROW may be a text row or, e.g., a mode line. Text rows must be
7142 clipped to the interior of the window dedicated to text display,
7143 mode lines must be clipped to the whole window. */
7145 static void
7146 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7148 struct frame *f = XFRAME (WINDOW_FRAME (w));
7149 XRectangle clip_rect;
7150 int window_x, window_y, window_width;
7152 window_box (w, area, &window_x, &window_y, &window_width, 0);
7154 clip_rect.x = window_x;
7155 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7156 clip_rect.y = max (clip_rect.y, window_y);
7157 clip_rect.width = window_width;
7158 clip_rect.height = row->visible_height;
7160 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7164 /* Draw a hollow box cursor on window W in glyph row ROW. */
7166 static void
7167 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7169 struct frame *f = XFRAME (WINDOW_FRAME (w));
7170 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7171 Display *dpy = FRAME_X_DISPLAY (f);
7172 int x, y, wd, h;
7173 XGCValues xgcv;
7174 struct glyph *cursor_glyph;
7175 GC gc;
7177 /* Get the glyph the cursor is on. If we can't tell because
7178 the current matrix is invalid or such, give up. */
7179 cursor_glyph = get_phys_cursor_glyph (w);
7180 if (cursor_glyph == NULL)
7181 return;
7183 /* Compute frame-relative coordinates for phys cursor. */
7184 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7185 wd = w->phys_cursor_width;
7187 /* The foreground of cursor_gc is typically the same as the normal
7188 background color, which can cause the cursor box to be invisible. */
7189 xgcv.foreground = f->output_data.x->cursor_pixel;
7190 if (dpyinfo->scratch_cursor_gc)
7191 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7192 else
7193 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7194 GCForeground, &xgcv);
7195 gc = dpyinfo->scratch_cursor_gc;
7197 /* Set clipping, draw the rectangle, and reset clipping again. */
7198 x_clip_to_row (w, row, TEXT_AREA, gc);
7199 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7200 XSetClipMask (dpy, gc, None);
7204 /* Draw a bar cursor on window W in glyph row ROW.
7206 Implementation note: One would like to draw a bar cursor with an
7207 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7208 Unfortunately, I didn't find a font yet that has this property set.
7209 --gerd. */
7211 static void
7212 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7214 struct frame *f = XFRAME (w->frame);
7215 struct glyph *cursor_glyph;
7217 /* If cursor is out of bounds, don't draw garbage. This can happen
7218 in mini-buffer windows when switching between echo area glyphs
7219 and mini-buffer. */
7220 cursor_glyph = get_phys_cursor_glyph (w);
7221 if (cursor_glyph == NULL)
7222 return;
7224 /* If on an image, draw like a normal cursor. That's usually better
7225 visible than drawing a bar, esp. if the image is large so that
7226 the bar might not be in the window. */
7227 if (cursor_glyph->type == IMAGE_GLYPH)
7229 struct glyph_row *row;
7230 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7231 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7233 else
7235 Display *dpy = FRAME_X_DISPLAY (f);
7236 Window window = FRAME_X_WINDOW (f);
7237 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7238 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7239 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7240 XGCValues xgcv;
7242 /* If the glyph's background equals the color we normally draw
7243 the bars cursor in, the bar cursor in its normal color is
7244 invisible. Use the glyph's foreground color instead in this
7245 case, on the assumption that the glyph's colors are chosen so
7246 that the glyph is legible. */
7247 if (face->background == f->output_data.x->cursor_pixel)
7248 xgcv.background = xgcv.foreground = face->foreground;
7249 else
7250 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7251 xgcv.graphics_exposures = 0;
7253 if (gc)
7254 XChangeGC (dpy, gc, mask, &xgcv);
7255 else
7257 gc = XCreateGC (dpy, window, mask, &xgcv);
7258 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7261 x_clip_to_row (w, row, TEXT_AREA, gc);
7263 if (kind == BAR_CURSOR)
7265 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7267 if (width < 0)
7268 width = FRAME_CURSOR_WIDTH (f);
7269 width = min (cursor_glyph->pixel_width, width);
7271 w->phys_cursor_width = width;
7273 /* If the character under cursor is R2L, draw the bar cursor
7274 on the right of its glyph, rather than on the left. */
7275 if ((cursor_glyph->resolved_level & 1) != 0)
7276 x += cursor_glyph->pixel_width - width;
7278 XFillRectangle (dpy, window, gc, x,
7279 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7280 width, row->height);
7282 else
7284 int dummy_x, dummy_y, dummy_h;
7286 if (width < 0)
7287 width = row->height;
7289 width = min (row->height, width);
7291 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7292 &dummy_y, &dummy_h);
7294 XFillRectangle (dpy, window, gc,
7295 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7296 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7297 row->height - width),
7298 w->phys_cursor_width, width);
7301 XSetClipMask (dpy, gc, None);
7306 /* RIF: Define cursor CURSOR on frame F. */
7308 static void
7309 x_define_frame_cursor (struct frame *f, Cursor cursor)
7311 if (!f->pointer_invisible
7312 && f->output_data.x->current_cursor != cursor)
7313 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7314 f->output_data.x->current_cursor = cursor;
7318 /* RIF: Clear area on frame F. */
7320 static void
7321 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7323 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7324 x, y, width, height, False);
7325 #ifdef USE_GTK
7326 /* Must queue a redraw, because scroll bars might have been cleared. */
7327 if (FRAME_GTK_WIDGET (f))
7328 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7329 #endif
7333 /* RIF: Draw cursor on window W. */
7335 static void
7336 x_draw_window_cursor (struct window *w, struct glyph_row *glyph_row, int x, int y, int cursor_type, int cursor_width, int on_p, int active_p)
7338 struct frame *f = XFRAME (WINDOW_FRAME (w));
7340 if (on_p)
7342 w->phys_cursor_type = cursor_type;
7343 w->phys_cursor_on_p = 1;
7345 if (glyph_row->exact_window_width_line_p
7346 && (glyph_row->reversed_p
7347 ? (w->phys_cursor.hpos < 0)
7348 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7350 glyph_row->cursor_in_fringe_p = 1;
7351 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7353 else
7355 switch (cursor_type)
7357 case HOLLOW_BOX_CURSOR:
7358 x_draw_hollow_cursor (w, glyph_row);
7359 break;
7361 case FILLED_BOX_CURSOR:
7362 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7363 break;
7365 case BAR_CURSOR:
7366 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7367 break;
7369 case HBAR_CURSOR:
7370 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7371 break;
7373 case NO_CURSOR:
7374 w->phys_cursor_width = 0;
7375 break;
7377 default:
7378 abort ();
7382 #ifdef HAVE_X_I18N
7383 if (w == XWINDOW (f->selected_window))
7384 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7385 xic_set_preeditarea (w, x, y);
7386 #endif
7389 #ifndef XFlush
7390 XFlush (FRAME_X_DISPLAY (f));
7391 #endif
7395 /* Icons. */
7397 /* Make the x-window of frame F use the gnu icon bitmap. */
7400 x_bitmap_icon (struct frame *f, Lisp_Object file)
7402 int bitmap_id;
7404 if (FRAME_X_WINDOW (f) == 0)
7405 return 1;
7407 /* Free up our existing icon bitmap and mask if any. */
7408 if (f->output_data.x->icon_bitmap > 0)
7409 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7410 f->output_data.x->icon_bitmap = 0;
7412 if (STRINGP (file))
7414 #ifdef USE_GTK
7415 /* Use gtk_window_set_icon_from_file () if available,
7416 It's not restricted to bitmaps */
7417 if (xg_set_icon (f, file))
7418 return 0;
7419 #endif /* USE_GTK */
7420 bitmap_id = x_create_bitmap_from_file (f, file);
7421 x_create_bitmap_mask (f, bitmap_id);
7423 else
7425 /* Create the GNU bitmap and mask if necessary. */
7426 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7428 int rc = -1;
7430 #ifdef USE_GTK
7432 if (xg_set_icon (f, xg_default_icon_file)
7433 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7434 return 0;
7436 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7438 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7439 if (rc != -1)
7440 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7442 #endif
7444 /* If all else fails, use the (black and white) xbm image. */
7445 if (rc == -1)
7447 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
7448 gnu_xbm_width, gnu_xbm_height);
7449 if (rc == -1)
7450 return 1;
7452 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7453 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7457 /* The first time we create the GNU bitmap and mask,
7458 this increments the ref-count one extra time.
7459 As a result, the GNU bitmap and mask are never freed.
7460 That way, we don't have to worry about allocating it again. */
7461 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7463 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7466 x_wm_set_icon_pixmap (f, bitmap_id);
7467 f->output_data.x->icon_bitmap = bitmap_id;
7469 return 0;
7473 /* Make the x-window of frame F use a rectangle with text.
7474 Use ICON_NAME as the text. */
7477 x_text_icon (struct frame *f, const char *icon_name)
7479 if (FRAME_X_WINDOW (f) == 0)
7480 return 1;
7483 XTextProperty text;
7484 text.value = (unsigned char *) icon_name;
7485 text.encoding = XA_STRING;
7486 text.format = 8;
7487 text.nitems = strlen (icon_name);
7488 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7491 if (f->output_data.x->icon_bitmap > 0)
7492 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7493 f->output_data.x->icon_bitmap = 0;
7494 x_wm_set_icon_pixmap (f, 0);
7496 return 0;
7499 #define X_ERROR_MESSAGE_SIZE 200
7501 /* If non-nil, this should be a string.
7502 It means catch X errors and store the error message in this string.
7504 The reason we use a stack is that x_catch_error/x_uncatch_error can
7505 be called from a signal handler.
7508 struct x_error_message_stack {
7509 char string[X_ERROR_MESSAGE_SIZE];
7510 Display *dpy;
7511 struct x_error_message_stack *prev;
7513 static struct x_error_message_stack *x_error_message;
7515 /* An X error handler which stores the error message in
7516 *x_error_message. This is called from x_error_handler if
7517 x_catch_errors is in effect. */
7519 static void
7520 x_error_catcher (Display *display, XErrorEvent *error)
7522 XGetErrorText (display, error->error_code,
7523 x_error_message->string,
7524 X_ERROR_MESSAGE_SIZE);
7527 /* Begin trapping X errors for display DPY. Actually we trap X errors
7528 for all displays, but DPY should be the display you are actually
7529 operating on.
7531 After calling this function, X protocol errors no longer cause
7532 Emacs to exit; instead, they are recorded in the string
7533 stored in *x_error_message.
7535 Calling x_check_errors signals an Emacs error if an X error has
7536 occurred since the last call to x_catch_errors or x_check_errors.
7538 Calling x_uncatch_errors resumes the normal error handling. */
7540 void x_check_errors (Display *dpy, const char *format);
7542 void
7543 x_catch_errors (Display *dpy)
7545 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7547 /* Make sure any errors from previous requests have been dealt with. */
7548 XSync (dpy, False);
7550 data->dpy = dpy;
7551 data->string[0] = 0;
7552 data->prev = x_error_message;
7553 x_error_message = data;
7556 /* Undo the last x_catch_errors call.
7557 DPY should be the display that was passed to x_catch_errors. */
7559 void
7560 x_uncatch_errors (void)
7562 struct x_error_message_stack *tmp;
7564 BLOCK_INPUT;
7566 /* The display may have been closed before this function is called.
7567 Check if it is still open before calling XSync. */
7568 if (x_display_info_for_display (x_error_message->dpy) != 0)
7569 XSync (x_error_message->dpy, False);
7571 tmp = x_error_message;
7572 x_error_message = x_error_message->prev;
7573 xfree (tmp);
7574 UNBLOCK_INPUT;
7577 /* If any X protocol errors have arrived since the last call to
7578 x_catch_errors or x_check_errors, signal an Emacs error using
7579 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7581 void
7582 x_check_errors (Display *dpy, const char *format)
7584 /* Make sure to catch any errors incurred so far. */
7585 XSync (dpy, False);
7587 if (x_error_message->string[0])
7589 char string[X_ERROR_MESSAGE_SIZE];
7590 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7591 x_uncatch_errors ();
7592 error (format, string);
7596 /* Nonzero if we had any X protocol errors
7597 since we did x_catch_errors on DPY. */
7600 x_had_errors_p (Display *dpy)
7602 /* Make sure to catch any errors incurred so far. */
7603 XSync (dpy, False);
7605 return x_error_message->string[0] != 0;
7608 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7610 void
7611 x_clear_errors (Display *dpy)
7613 x_error_message->string[0] = 0;
7616 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7617 * idea. --lorentey */
7618 /* Close off all unclosed x_catch_errors calls. */
7620 void
7621 x_fully_uncatch_errors (void)
7623 while (x_error_message)
7624 x_uncatch_errors ();
7626 #endif
7628 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7631 x_catching_errors (void)
7633 return x_error_message != 0;
7636 #if 0
7637 static unsigned int x_wire_count;
7638 x_trace_wire (void)
7640 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7642 #endif /* ! 0 */
7645 /* Handle SIGPIPE, which can happen when the connection to a server
7646 simply goes away. SIGPIPE is handled by x_connection_signal.
7647 Don't need to do anything, because the write which caused the
7648 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7649 which will do the appropriate cleanup for us. */
7651 static SIGTYPE
7652 x_connection_signal (int signalnum) /* If we don't have an argument, */
7653 /* some compilers complain in signal calls. */
7655 #ifdef USG
7656 /* USG systems forget handlers when they are used;
7657 must reestablish each time */
7658 signal (signalnum, x_connection_signal);
7659 #endif /* USG */
7663 /************************************************************************
7664 Handling X errors
7665 ************************************************************************/
7667 /* Error message passed to x_connection_closed. */
7669 static char *error_msg;
7671 /* Function installed as fatal_error_signal_hook in
7672 x_connection_closed. Print the X error message, and exit normally,
7673 instead of dumping core when XtCloseDisplay fails. */
7675 static void
7676 x_fatal_error_signal (void)
7678 fprintf (stderr, "%s\n", error_msg);
7679 exit (70);
7682 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7683 the text of an error message that lead to the connection loss. */
7685 static SIGTYPE
7686 x_connection_closed (Display *dpy, const char *error_message)
7688 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7689 Lisp_Object frame, tail;
7690 int index = SPECPDL_INDEX ();
7692 error_msg = (char *) alloca (strlen (error_message) + 1);
7693 strcpy (error_msg, error_message);
7694 handling_signal = 0;
7696 /* Inhibit redisplay while frames are being deleted. */
7697 specbind (Qinhibit_redisplay, Qt);
7699 if (dpyinfo)
7701 /* Protect display from being closed when we delete the last
7702 frame on it. */
7703 dpyinfo->reference_count++;
7704 dpyinfo->terminal->reference_count++;
7707 /* First delete frames whose mini-buffers are on frames
7708 that are on the dead display. */
7709 FOR_EACH_FRAME (tail, frame)
7711 Lisp_Object minibuf_frame;
7712 minibuf_frame
7713 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7714 if (FRAME_X_P (XFRAME (frame))
7715 && FRAME_X_P (XFRAME (minibuf_frame))
7716 && ! EQ (frame, minibuf_frame)
7717 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7718 delete_frame (frame, Qnoelisp);
7721 /* Now delete all remaining frames on the dead display.
7722 We are now sure none of these is used as the mini-buffer
7723 for another frame that we need to delete. */
7724 FOR_EACH_FRAME (tail, frame)
7725 if (FRAME_X_P (XFRAME (frame))
7726 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7728 /* Set this to t so that delete_frame won't get confused
7729 trying to find a replacement. */
7730 KVAR (FRAME_KBOARD (XFRAME (frame)), Vdefault_minibuffer_frame) = Qt;
7731 delete_frame (frame, Qnoelisp);
7734 /* If DPYINFO is null, this means we didn't open the display in the
7735 first place, so don't try to close it. */
7736 if (dpyinfo)
7738 /* We can not call XtCloseDisplay here because it calls XSync.
7739 XSync inside the error handler apparently hangs Emacs. On
7740 current Xt versions, this isn't needed either. */
7741 #ifdef USE_GTK
7742 /* A long-standing GTK bug prevents proper disconnect handling
7743 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7744 the resulting Glib error message loop filled a user's disk.
7745 To avoid this, kill Emacs unconditionally on disconnect. */
7746 shut_down_emacs (0, 0, Qnil);
7747 fprintf (stderr, "%s\n\
7748 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7749 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7750 For details, see etc/PROBLEMS.\n",
7751 error_msg);
7752 abort ();
7753 #endif /* USE_GTK */
7755 /* Indicate that this display is dead. */
7756 dpyinfo->display = 0;
7758 dpyinfo->reference_count--;
7759 dpyinfo->terminal->reference_count--;
7760 if (dpyinfo->reference_count != 0)
7761 /* We have just closed all frames on this display. */
7762 abort ();
7765 Lisp_Object tmp;
7766 XSETTERMINAL (tmp, dpyinfo->terminal);
7767 Fdelete_terminal (tmp, Qnoelisp);
7771 if (terminal_list == 0)
7773 fprintf (stderr, "%s\n", error_msg);
7774 Fkill_emacs (make_number (70));
7775 /* NOTREACHED */
7778 /* Ordinary stack unwind doesn't deal with these. */
7779 #ifdef SIGIO
7780 sigunblock (sigmask (SIGIO));
7781 #endif
7782 sigunblock (sigmask (SIGALRM));
7783 TOTALLY_UNBLOCK_INPUT;
7785 unbind_to (index, Qnil);
7786 clear_waiting_for_input ();
7787 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7788 longjmp), because returning from this function would get us back into
7789 Xlib's code which will directly call `exit'. */
7790 error ("%s", error_msg);
7793 /* We specifically use it before defining it, so that gcc doesn't inline it,
7794 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7795 static void x_error_quitter (Display *, XErrorEvent *);
7797 /* This is the first-level handler for X protocol errors.
7798 It calls x_error_quitter or x_error_catcher. */
7800 static int
7801 x_error_handler (Display *display, XErrorEvent *error)
7803 if (x_error_message)
7804 x_error_catcher (display, error);
7805 else
7806 x_error_quitter (display, error);
7807 return 0;
7810 /* This is the usual handler for X protocol errors.
7811 It kills all frames on the display that we got the error for.
7812 If that was the only one, it prints an error message and kills Emacs. */
7814 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7816 /* On older GCC versions, just putting x_error_quitter
7817 after x_error_handler prevents inlining into the former. */
7819 static void NO_INLINE
7820 x_error_quitter (Display *display, XErrorEvent *error)
7822 char buf[256], buf1[356];
7824 /* Ignore BadName errors. They can happen because of fonts
7825 or colors that are not defined. */
7827 if (error->error_code == BadName)
7828 return;
7830 /* Note that there is no real way portable across R3/R4 to get the
7831 original error handler. */
7833 XGetErrorText (display, error->error_code, buf, sizeof (buf));
7834 sprintf (buf1, "X protocol error: %s on protocol request %d",
7835 buf, error->request_code);
7836 x_connection_closed (display, buf1);
7840 /* This is the handler for X IO errors, always.
7841 It kills all frames on the display that we lost touch with.
7842 If that was the only one, it prints an error message and kills Emacs. */
7844 static int
7845 x_io_error_quitter (Display *display)
7847 char buf[256];
7849 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
7850 x_connection_closed (display, buf);
7851 return 0;
7854 /* Changing the font of the frame. */
7856 /* Give frame F the font FONT-OBJECT as its default font. The return
7857 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7858 frame. If it is negative, generate a new fontset from
7859 FONT-OBJECT. */
7861 Lisp_Object
7862 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7864 struct font *font = XFONT_OBJECT (font_object);
7866 if (fontset < 0)
7867 fontset = fontset_from_font (font_object);
7868 FRAME_FONTSET (f) = fontset;
7869 if (FRAME_FONT (f) == font)
7870 /* This font is already set in frame F. There's nothing more to
7871 do. */
7872 return font_object;
7874 FRAME_FONT (f) = font;
7875 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7876 FRAME_COLUMN_WIDTH (f) = font->average_width;
7877 FRAME_SPACE_WIDTH (f) = font->space_width;
7878 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7880 compute_fringe_widths (f, 1);
7882 /* Compute the scroll bar width in character columns. */
7883 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7885 int wid = FRAME_COLUMN_WIDTH (f);
7886 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7887 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7889 else
7891 int wid = FRAME_COLUMN_WIDTH (f);
7892 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7895 if (FRAME_X_WINDOW (f) != 0)
7897 /* Don't change the size of a tip frame; there's no point in
7898 doing it because it's done in Fx_show_tip, and it leads to
7899 problems because the tip frame has no widget. */
7900 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7901 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7904 #ifdef HAVE_X_I18N
7905 if (FRAME_XIC (f)
7906 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7908 BLOCK_INPUT;
7909 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7910 UNBLOCK_INPUT;
7912 #endif
7914 return font_object;
7918 /***********************************************************************
7919 X Input Methods
7920 ***********************************************************************/
7922 #ifdef HAVE_X_I18N
7924 #ifdef HAVE_X11R6
7926 /* XIM destroy callback function, which is called whenever the
7927 connection to input method XIM dies. CLIENT_DATA contains a
7928 pointer to the x_display_info structure corresponding to XIM. */
7930 static void
7931 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7933 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7934 Lisp_Object frame, tail;
7936 BLOCK_INPUT;
7938 /* No need to call XDestroyIC.. */
7939 FOR_EACH_FRAME (tail, frame)
7941 struct frame *f = XFRAME (frame);
7942 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7944 FRAME_XIC (f) = NULL;
7945 xic_free_xfontset (f);
7949 /* No need to call XCloseIM. */
7950 dpyinfo->xim = NULL;
7951 XFree (dpyinfo->xim_styles);
7952 UNBLOCK_INPUT;
7955 #endif /* HAVE_X11R6 */
7957 #ifdef HAVE_X11R6
7958 /* This isn't prototyped in OSF 5.0 or 5.1a. */
7959 extern char *XSetIMValues (XIM, ...);
7960 #endif
7962 /* Open the connection to the XIM server on display DPYINFO.
7963 RESOURCE_NAME is the resource name Emacs uses. */
7965 static void
7966 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
7968 XIM xim;
7970 #ifdef HAVE_XIM
7971 if (use_xim)
7973 if (dpyinfo->xim)
7974 XCloseIM (dpyinfo->xim);
7975 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
7976 emacs_class);
7977 dpyinfo->xim = xim;
7979 if (xim)
7981 #ifdef HAVE_X11R6
7982 XIMCallback destroy;
7983 #endif
7985 /* Get supported styles and XIM values. */
7986 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
7988 #ifdef HAVE_X11R6
7989 destroy.callback = xim_destroy_callback;
7990 destroy.client_data = (XPointer)dpyinfo;
7991 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
7992 #endif
7996 else
7997 #endif /* HAVE_XIM */
7998 dpyinfo->xim = NULL;
8002 #ifdef HAVE_X11R6_XIM
8004 /* XIM instantiate callback function, which is called whenever an XIM
8005 server is available. DISPLAY is the display of the XIM.
8006 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8007 when the callback was registered. */
8009 static void
8010 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8012 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8013 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8015 /* We don't support multiple XIM connections. */
8016 if (dpyinfo->xim)
8017 return;
8019 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8021 /* Create XIC for the existing frames on the same display, as long
8022 as they have no XIC. */
8023 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8025 Lisp_Object tail, frame;
8027 BLOCK_INPUT;
8028 FOR_EACH_FRAME (tail, frame)
8030 struct frame *f = XFRAME (frame);
8032 if (FRAME_X_P (f)
8033 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8034 if (FRAME_XIC (f) == NULL)
8036 create_frame_xic (f);
8037 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8038 xic_set_statusarea (f);
8039 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8041 struct window *w = XWINDOW (f->selected_window);
8042 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8047 UNBLOCK_INPUT;
8051 #endif /* HAVE_X11R6_XIM */
8054 /* Open a connection to the XIM server on display DPYINFO.
8055 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8056 connection only at the first time. On X11R6, open the connection
8057 in the XIM instantiate callback function. */
8059 static void
8060 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8062 dpyinfo->xim = NULL;
8063 #ifdef HAVE_XIM
8064 if (use_xim)
8066 #ifdef HAVE_X11R6_XIM
8067 struct xim_inst_t *xim_inst;
8068 int len;
8070 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8071 dpyinfo->xim_callback_data = xim_inst;
8072 xim_inst->dpyinfo = dpyinfo;
8073 len = strlen (resource_name);
8074 xim_inst->resource_name = (char *) xmalloc (len + 1);
8075 memcpy (xim_inst->resource_name, resource_name, len + 1);
8076 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8077 resource_name, emacs_class,
8078 xim_instantiate_callback,
8079 /* This is XPointer in XFree86
8080 but (XPointer *) on Tru64, at
8081 least, hence the configure test. */
8082 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8083 #else /* not HAVE_X11R6_XIM */
8084 xim_open_dpy (dpyinfo, resource_name);
8085 #endif /* not HAVE_X11R6_XIM */
8087 #endif /* HAVE_XIM */
8091 /* Close the connection to the XIM server on display DPYINFO. */
8093 static void
8094 xim_close_dpy (struct x_display_info *dpyinfo)
8096 #ifdef HAVE_XIM
8097 if (use_xim)
8099 #ifdef HAVE_X11R6_XIM
8100 if (dpyinfo->display)
8101 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8102 NULL, emacs_class,
8103 xim_instantiate_callback, NULL);
8104 xfree (dpyinfo->xim_callback_data->resource_name);
8105 xfree (dpyinfo->xim_callback_data);
8106 #endif /* HAVE_X11R6_XIM */
8107 if (dpyinfo->display)
8108 XCloseIM (dpyinfo->xim);
8109 dpyinfo->xim = NULL;
8110 XFree (dpyinfo->xim_styles);
8112 #endif /* HAVE_XIM */
8115 #endif /* not HAVE_X11R6_XIM */
8119 /* Calculate the absolute position in frame F
8120 from its current recorded position values and gravity. */
8122 void
8123 x_calc_absolute_position (struct frame *f)
8125 int flags = f->size_hint_flags;
8127 /* We have nothing to do if the current position
8128 is already for the top-left corner. */
8129 if (! ((flags & XNegative) || (flags & YNegative)))
8130 return;
8132 /* Treat negative positions as relative to the leftmost bottommost
8133 position that fits on the screen. */
8134 if (flags & XNegative)
8135 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8136 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8139 int height = FRAME_PIXEL_HEIGHT (f);
8141 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8142 /* Something is fishy here. When using Motif, starting Emacs with
8143 `-g -0-0', the frame appears too low by a few pixels.
8145 This seems to be so because initially, while Emacs is starting,
8146 the column widget's height and the frame's pixel height are
8147 different. The column widget's height is the right one. In
8148 later invocations, when Emacs is up, the frame's pixel height
8149 is right, though.
8151 It's not obvious where the initial small difference comes from.
8152 2000-12-01, gerd. */
8154 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8155 #endif
8157 if (flags & YNegative)
8158 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8159 - height + f->top_pos;
8162 /* The left_pos and top_pos
8163 are now relative to the top and left screen edges,
8164 so the flags should correspond. */
8165 f->size_hint_flags &= ~ (XNegative | YNegative);
8168 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8169 to really change the position, and 0 when calling from
8170 x_make_frame_visible (in that case, XOFF and YOFF are the current
8171 position values). It is -1 when calling from x_set_frame_parameters,
8172 which means, do adjust for borders but don't change the gravity. */
8174 void
8175 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8177 int modified_top, modified_left;
8179 if (change_gravity > 0)
8181 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8182 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8184 f->top_pos = yoff;
8185 f->left_pos = xoff;
8186 f->size_hint_flags &= ~ (XNegative | YNegative);
8187 if (xoff < 0)
8188 f->size_hint_flags |= XNegative;
8189 if (yoff < 0)
8190 f->size_hint_flags |= YNegative;
8191 f->win_gravity = NorthWestGravity;
8193 x_calc_absolute_position (f);
8195 BLOCK_INPUT;
8196 x_wm_set_size_hint (f, (long) 0, 0);
8198 modified_left = f->left_pos;
8199 modified_top = f->top_pos;
8201 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8203 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8204 than the WM decorations. So we use the calculated offset instead
8205 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8206 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8207 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8210 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8211 modified_left, modified_top);
8213 x_sync_with_move (f, f->left_pos, f->top_pos,
8214 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8215 ? 1 : 0);
8217 /* change_gravity is non-zero when this function is called from Lisp to
8218 programmatically move a frame. In that case, we call
8219 x_check_expected_move to discover if we have a "Type A" or "Type B"
8220 window manager, and, for a "Type A" window manager, adjust the position
8221 of the frame.
8223 We call x_check_expected_move if a programmatic move occurred, and
8224 either the window manager type (A/B) is unknown or it is Type A but we
8225 need to compute the top/left offset adjustment for this frame. */
8227 if (change_gravity != 0 &&
8228 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8229 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8230 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8231 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8232 x_check_expected_move (f, modified_left, modified_top);
8234 UNBLOCK_INPUT;
8237 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8238 on the root window for frame F contains ATOMNAME.
8239 This is how a WM check shall be done according to the Window Manager
8240 Specification/Extended Window Manager Hints at
8241 http://freedesktop.org/wiki/Specifications/wm-spec. */
8243 static int
8244 wm_supports (struct frame *f, Atom want_atom)
8246 Atom actual_type;
8247 unsigned long actual_size, bytes_remaining;
8248 int i, rc, actual_format;
8249 Window wmcheck_window;
8250 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8251 Window target_window = dpyinfo->root_window;
8252 long max_len = 65536;
8253 Display *dpy = FRAME_X_DISPLAY (f);
8254 unsigned char *tmp_data = NULL;
8255 Atom target_type = XA_WINDOW;
8257 BLOCK_INPUT;
8259 x_catch_errors (dpy);
8260 rc = XGetWindowProperty (dpy, target_window,
8261 dpyinfo->Xatom_net_supporting_wm_check,
8262 0, max_len, False, target_type,
8263 &actual_type, &actual_format, &actual_size,
8264 &bytes_remaining, &tmp_data);
8266 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8268 if (tmp_data) XFree (tmp_data);
8269 x_uncatch_errors ();
8270 UNBLOCK_INPUT;
8271 return 0;
8274 wmcheck_window = *(Window *) tmp_data;
8275 XFree (tmp_data);
8277 /* Check if window exists. */
8278 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8279 x_sync (f);
8280 if (x_had_errors_p (dpy))
8282 x_uncatch_errors ();
8283 UNBLOCK_INPUT;
8284 return 0;
8287 if (dpyinfo->net_supported_window != wmcheck_window)
8289 /* Window changed, reload atoms */
8290 if (dpyinfo->net_supported_atoms != NULL)
8291 XFree (dpyinfo->net_supported_atoms);
8292 dpyinfo->net_supported_atoms = NULL;
8293 dpyinfo->nr_net_supported_atoms = 0;
8294 dpyinfo->net_supported_window = 0;
8296 target_type = XA_ATOM;
8297 tmp_data = NULL;
8298 rc = XGetWindowProperty (dpy, target_window,
8299 dpyinfo->Xatom_net_supported,
8300 0, max_len, False, target_type,
8301 &actual_type, &actual_format, &actual_size,
8302 &bytes_remaining, &tmp_data);
8304 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8306 if (tmp_data) XFree (tmp_data);
8307 x_uncatch_errors ();
8308 UNBLOCK_INPUT;
8309 return 0;
8312 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8313 dpyinfo->nr_net_supported_atoms = actual_size;
8314 dpyinfo->net_supported_window = wmcheck_window;
8317 rc = 0;
8319 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8320 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8322 x_uncatch_errors ();
8323 UNBLOCK_INPUT;
8325 return rc;
8328 static void
8329 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8331 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8333 x_send_client_event (frame, make_number (0), frame,
8334 dpyinfo->Xatom_net_wm_state,
8335 make_number (32),
8336 /* 1 = add, 0 = remove */
8337 Fcons
8338 (make_number (add ? 1 : 0),
8339 Fcons
8340 (make_fixnum_or_float (atom),
8341 value != 0
8342 ? Fcons (make_fixnum_or_float (value), Qnil)
8343 : Qnil)));
8346 void
8347 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8349 Lisp_Object frame;
8350 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8352 XSETFRAME (frame, f);
8354 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8355 dpyinfo->Xatom_net_wm_state_sticky, None);
8358 /* Return the current _NET_WM_STATE.
8359 SIZE_STATE is set to one of the FULLSCREEN_* values.
8360 STICKY is set to 1 if the sticky state is set, 0 if not. */
8362 static void
8363 get_current_wm_state (struct frame *f,
8364 Window window,
8365 int *size_state,
8366 int *sticky)
8368 Atom actual_type;
8369 unsigned long actual_size, bytes_remaining;
8370 int i, rc, actual_format;
8371 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8372 long max_len = 65536;
8373 Display *dpy = FRAME_X_DISPLAY (f);
8374 unsigned char *tmp_data = NULL;
8375 Atom target_type = XA_ATOM;
8377 *sticky = 0;
8378 *size_state = FULLSCREEN_NONE;
8380 BLOCK_INPUT;
8381 x_catch_errors (dpy);
8382 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8383 0, max_len, False, target_type,
8384 &actual_type, &actual_format, &actual_size,
8385 &bytes_remaining, &tmp_data);
8387 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8389 if (tmp_data) XFree (tmp_data);
8390 x_uncatch_errors ();
8391 UNBLOCK_INPUT;
8392 return;
8395 x_uncatch_errors ();
8397 for (i = 0; i < actual_size; ++i)
8399 Atom a = ((Atom*)tmp_data)[i];
8400 if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8402 if (*size_state == FULLSCREEN_HEIGHT)
8403 *size_state = FULLSCREEN_MAXIMIZED;
8404 else
8405 *size_state = FULLSCREEN_WIDTH;
8407 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8409 if (*size_state == FULLSCREEN_WIDTH)
8410 *size_state = FULLSCREEN_MAXIMIZED;
8411 else
8412 *size_state = FULLSCREEN_HEIGHT;
8414 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8415 *size_state = FULLSCREEN_BOTH;
8416 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8417 *sticky = 1;
8420 if (tmp_data) XFree (tmp_data);
8421 UNBLOCK_INPUT;
8424 /* Do fullscreen as specified in extended window manager hints */
8426 static int
8427 do_ewmh_fullscreen (struct frame *f)
8429 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8430 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8431 int cur, dummy;
8433 get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8435 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8436 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8437 if (!have_net_atom)
8438 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8440 if (have_net_atom && cur != f->want_fullscreen)
8442 Lisp_Object frame;
8444 XSETFRAME (frame, f);
8446 /* Keep number of calls to set_wm_state as low as possible.
8447 Some window managers, or possible Gtk+, hangs when too many
8448 are sent at once. */
8449 switch (f->want_fullscreen)
8451 case FULLSCREEN_BOTH:
8452 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8453 || cur == FULLSCREEN_HEIGHT)
8454 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8455 dpyinfo->Xatom_net_wm_state_maximized_vert);
8456 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8457 break;
8458 case FULLSCREEN_WIDTH:
8459 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8460 || cur == FULLSCREEN_MAXIMIZED)
8461 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8462 dpyinfo->Xatom_net_wm_state_maximized_vert);
8463 if (cur != FULLSCREEN_MAXIMIZED)
8464 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8465 break;
8466 case FULLSCREEN_HEIGHT:
8467 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8468 || cur == FULLSCREEN_MAXIMIZED)
8469 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8470 dpyinfo->Xatom_net_wm_state_maximized_horz);
8471 if (cur != FULLSCREEN_MAXIMIZED)
8472 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8473 break;
8474 case FULLSCREEN_MAXIMIZED:
8475 if (cur == FULLSCREEN_BOTH)
8476 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8477 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8478 dpyinfo->Xatom_net_wm_state_maximized_vert);
8479 break;
8480 case FULLSCREEN_NONE:
8481 if (cur == FULLSCREEN_BOTH)
8482 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8483 else
8484 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8485 dpyinfo->Xatom_net_wm_state_maximized_vert);
8488 f->want_fullscreen = FULLSCREEN_NONE;
8492 return have_net_atom;
8495 static void
8496 XTfullscreen_hook (FRAME_PTR f)
8498 if (f->async_visible)
8500 BLOCK_INPUT;
8501 x_check_fullscreen (f);
8502 x_sync (f);
8503 UNBLOCK_INPUT;
8508 static void
8509 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8511 int value = FULLSCREEN_NONE;
8512 Lisp_Object lval;
8513 int sticky = 0;
8515 get_current_wm_state (f, event->window, &value, &sticky);
8516 lval = Qnil;
8517 switch (value)
8519 case FULLSCREEN_WIDTH:
8520 lval = Qfullwidth;
8521 break;
8522 case FULLSCREEN_HEIGHT:
8523 lval = Qfullheight;
8524 break;
8525 case FULLSCREEN_BOTH:
8526 lval = Qfullboth;
8527 break;
8528 case FULLSCREEN_MAXIMIZED:
8529 lval = Qmaximized;
8530 break;
8533 store_frame_param (f, Qfullscreen, lval);
8534 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8537 /* Check if we need to resize the frame due to a fullscreen request.
8538 If so needed, resize the frame. */
8539 static void
8540 x_check_fullscreen (struct frame *f)
8542 if (do_ewmh_fullscreen (f))
8543 return;
8545 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8546 return; /* Only fullscreen without WM or with EWM hints (above). */
8548 /* Setting fullscreen to nil doesn't do anything. We could save the
8549 last non-fullscreen size and restore it, but it seems like a
8550 lot of work for this unusual case (no window manager running). */
8552 if (f->want_fullscreen != FULLSCREEN_NONE)
8554 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8555 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8557 switch (f->want_fullscreen)
8559 /* No difference between these two when there is no WM */
8560 case FULLSCREEN_BOTH:
8561 case FULLSCREEN_MAXIMIZED:
8562 width = x_display_pixel_width (dpyinfo);
8563 height = x_display_pixel_height (dpyinfo);
8564 break;
8565 case FULLSCREEN_WIDTH:
8566 width = x_display_pixel_width (dpyinfo);
8567 break;
8568 case FULLSCREEN_HEIGHT:
8569 height = x_display_pixel_height (dpyinfo);
8572 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8573 width, height);
8577 /* This function is called by x_set_offset to determine whether the window
8578 manager interfered with the positioning of the frame. Type A window
8579 managers position the surrounding window manager decorations a small
8580 amount above and left of the user-supplied position. Type B window
8581 managers position the surrounding window manager decorations at the
8582 user-specified position. If we detect a Type A window manager, we
8583 compensate by moving the window right and down by the proper amount. */
8585 static void
8586 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8588 int current_left = 0, current_top = 0;
8590 /* x_real_positions returns the left and top offsets of the outermost
8591 window manager window around the frame. */
8593 x_real_positions (f, &current_left, &current_top);
8595 if (current_left != expected_left || current_top != expected_top)
8597 /* It's a "Type A" window manager. */
8599 int adjusted_left;
8600 int adjusted_top;
8602 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8603 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8604 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8606 /* Now fix the mispositioned frame's location. */
8608 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8609 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8611 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8612 adjusted_left, adjusted_top);
8614 x_sync_with_move (f, expected_left, expected_top, 0);
8616 else
8617 /* It's a "Type B" window manager. We don't have to adjust the
8618 frame's position. */
8620 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8624 /* Wait for XGetGeometry to return up-to-date position information for a
8625 recently-moved frame. Call this immediately after calling XMoveWindow.
8626 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8627 frame has been moved to, so we use a fuzzy position comparison instead
8628 of an exact comparison. */
8630 static void
8631 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8633 int count = 0;
8635 while (count++ < 50)
8637 int current_left = 0, current_top = 0;
8639 /* In theory, this call to XSync only needs to happen once, but in
8640 practice, it doesn't seem to work, hence the need for the surrounding
8641 loop. */
8643 XSync (FRAME_X_DISPLAY (f), False);
8644 x_real_positions (f, &current_left, &current_top);
8646 if (fuzzy)
8648 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8649 pixels. */
8651 if (eabs (current_left - left) <= 10
8652 && eabs (current_top - top) <= 40)
8653 return;
8655 else if (current_left == left && current_top == top)
8656 return;
8659 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8660 will then return up-to-date position info. */
8662 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8666 /* Wait for an event on frame F matching EVENTTYPE. */
8667 void
8668 x_wait_for_event (struct frame *f, int eventtype)
8670 int level = interrupt_input_blocked;
8672 SELECT_TYPE fds;
8673 EMACS_TIME tmo, tmo_at, time_now;
8674 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8676 pending_event_wait.f = f;
8677 pending_event_wait.eventtype = eventtype;
8679 /* Set timeout to 0.1 second. Hopefully not noticable.
8680 Maybe it should be configurable. */
8681 EMACS_SET_SECS_USECS (tmo, 0, 100000);
8682 EMACS_GET_TIME (tmo_at);
8683 EMACS_ADD_TIME (tmo_at, tmo_at, tmo);
8685 while (pending_event_wait.eventtype)
8687 interrupt_input_pending = 1;
8688 TOTALLY_UNBLOCK_INPUT;
8689 /* XTread_socket is called after unblock. */
8690 BLOCK_INPUT;
8691 interrupt_input_blocked = level;
8693 FD_ZERO (&fds);
8694 FD_SET (fd, &fds);
8696 EMACS_GET_TIME (time_now);
8697 EMACS_SUB_TIME (tmo, tmo_at, time_now);
8699 if (EMACS_TIME_NEG_P (tmo) || select (fd+1, &fds, NULL, NULL, &tmo) == 0)
8700 break; /* Timeout */
8702 pending_event_wait.f = 0;
8703 pending_event_wait.eventtype = 0;
8707 /* Change the size of frame F's X window to COLS/ROWS in the case F
8708 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8709 top-left-corner window gravity for this size change and subsequent
8710 size changes. Otherwise we leave the window gravity unchanged. */
8712 static void
8713 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8715 int pixelwidth, pixelheight;
8717 check_frame_size (f, &rows, &cols);
8718 f->scroll_bar_actual_width
8719 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8721 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8723 compute_fringe_widths (f, 0);
8725 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8726 + FRAME_TOOLBAR_WIDTH (f);
8727 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8728 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8730 if (change_gravity) f->win_gravity = NorthWestGravity;
8731 x_wm_set_size_hint (f, (long) 0, 0);
8732 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8733 pixelwidth, pixelheight);
8736 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8737 receive in the ConfigureNotify event; if we get what we asked
8738 for, then the event won't cause the screen to become garbaged, so
8739 we have to make sure to do it here. */
8740 SET_FRAME_GARBAGED (f);
8742 /* Now, strictly speaking, we can't be sure that this is accurate,
8743 but the window manager will get around to dealing with the size
8744 change request eventually, and we'll hear how it went when the
8745 ConfigureNotify event gets here.
8747 We could just not bother storing any of this information here,
8748 and let the ConfigureNotify event set everything up, but that
8749 might be kind of confusing to the Lisp code, since size changes
8750 wouldn't be reported in the frame parameters until some random
8751 point in the future when the ConfigureNotify event arrives.
8753 We pass 1 for DELAY since we can't run Lisp code inside of
8754 a BLOCK_INPUT. */
8756 /* But the ConfigureNotify may in fact never arrive, and then this is
8757 not right if the frame is visible. Instead wait (with timeout)
8758 for the ConfigureNotify. */
8759 if (f->async_visible)
8760 x_wait_for_event (f, ConfigureNotify);
8761 else
8763 change_frame_size (f, rows, cols, 0, 1, 0);
8764 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8765 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8766 x_sync (f);
8771 /* Call this to change the size of frame F's x-window.
8772 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8773 for this size change and subsequent size changes.
8774 Otherwise we leave the window gravity unchanged. */
8776 void
8777 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8779 BLOCK_INPUT;
8781 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8783 int r, c;
8785 /* When the frame is maximized/fullscreen or running under for
8786 example Xmonad, x_set_window_size_1 will be a no-op.
8787 In that case, the right thing to do is extend rows/cols to
8788 the current frame size. We do that first if x_set_window_size_1
8789 turns out to not be a no-op (there is no way to know).
8790 The size will be adjusted again if the frame gets a
8791 ConfigureNotify event as a result of x_set_window_size. */
8792 int pixelh = FRAME_PIXEL_HEIGHT (f);
8793 #ifdef USE_X_TOOLKIT
8794 /* The menu bar is not part of text lines. The tool bar
8795 is however. */
8796 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8797 #endif
8798 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8799 /* Update f->scroll_bar_actual_width because it is used in
8800 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8801 f->scroll_bar_actual_width
8802 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8803 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8804 change_frame_size (f, r, c, 0, 1, 0);
8807 #ifdef USE_GTK
8808 if (FRAME_GTK_WIDGET (f))
8809 xg_frame_set_char_size (f, cols, rows);
8810 else
8811 x_set_window_size_1 (f, change_gravity, cols, rows);
8812 #else /* not USE_GTK */
8814 x_set_window_size_1 (f, change_gravity, cols, rows);
8816 #endif /* not USE_GTK */
8818 /* If cursor was outside the new size, mark it as off. */
8819 mark_window_cursors_off (XWINDOW (f->root_window));
8821 /* Clear out any recollection of where the mouse highlighting was,
8822 since it might be in a place that's outside the new frame size.
8823 Actually checking whether it is outside is a pain in the neck,
8824 so don't try--just let the highlighting be done afresh with new size. */
8825 cancel_mouse_face (f);
8827 UNBLOCK_INPUT;
8830 /* Mouse warping. */
8832 void
8833 x_set_mouse_position (struct frame *f, int x, int y)
8835 int pix_x, pix_y;
8837 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8838 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8840 if (pix_x < 0) pix_x = 0;
8841 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8843 if (pix_y < 0) pix_y = 0;
8844 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8846 BLOCK_INPUT;
8848 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8849 0, 0, 0, 0, pix_x, pix_y);
8850 UNBLOCK_INPUT;
8853 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8855 void
8856 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8858 BLOCK_INPUT;
8860 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8861 0, 0, 0, 0, pix_x, pix_y);
8862 UNBLOCK_INPUT;
8865 /* focus shifting, raising and lowering. */
8867 void
8868 x_focus_on_frame (struct frame *f)
8870 #if 0
8871 /* I don't think that the ICCCM allows programs to do things like this
8872 without the interaction of the window manager. Whatever you end up
8873 doing with this code, do it to x_unfocus_frame too. */
8874 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8875 RevertToPointerRoot, CurrentTime);
8876 #endif /* ! 0 */
8879 void
8880 x_unfocus_frame (struct frame *f)
8882 #if 0
8883 /* Look at the remarks in x_focus_on_frame. */
8884 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8885 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8886 RevertToPointerRoot, CurrentTime);
8887 #endif /* ! 0 */
8890 /* Raise frame F. */
8892 void
8893 x_raise_frame (struct frame *f)
8895 BLOCK_INPUT;
8896 if (f->async_visible)
8897 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8899 XFlush (FRAME_X_DISPLAY (f));
8900 UNBLOCK_INPUT;
8903 /* Lower frame F. */
8905 void
8906 x_lower_frame (struct frame *f)
8908 if (f->async_visible)
8910 BLOCK_INPUT;
8911 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8912 XFlush (FRAME_X_DISPLAY (f));
8913 UNBLOCK_INPUT;
8917 /* Activate frame with Extended Window Manager Hints */
8919 void
8920 x_ewmh_activate_frame (FRAME_PTR f)
8922 /* See Window Manager Specification/Extended Window Manager Hints at
8923 http://freedesktop.org/wiki/Specifications/wm-spec */
8925 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8926 if (f->async_visible && wm_supports (f, dpyinfo->Xatom_net_active_window))
8928 Lisp_Object frame;
8929 XSETFRAME (frame, f);
8930 x_send_client_event (frame, make_number (0), frame,
8931 dpyinfo->Xatom_net_active_window,
8932 make_number (32),
8933 Fcons (make_number (1),
8934 Fcons (make_number (last_user_time),
8935 Qnil)));
8939 static void
8940 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
8942 if (raise_flag)
8943 x_raise_frame (f);
8944 else
8945 x_lower_frame (f);
8948 /* XEmbed implementation. */
8950 static void
8951 xembed_set_info (struct frame *f, enum xembed_info flags)
8953 unsigned long data[2];
8954 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8956 data[0] = XEMBED_VERSION;
8957 data[1] = flags;
8959 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8960 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
8961 32, PropModeReplace, (unsigned char *) data, 2);
8964 static void
8965 xembed_send_message (struct frame *f, Time time, enum xembed_message message, long int detail, long int data1, long int data2)
8967 XEvent event;
8969 event.xclient.type = ClientMessage;
8970 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
8971 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
8972 event.xclient.format = 32;
8973 event.xclient.data.l[0] = time;
8974 event.xclient.data.l[1] = message;
8975 event.xclient.data.l[2] = detail;
8976 event.xclient.data.l[3] = data1;
8977 event.xclient.data.l[4] = data2;
8979 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
8980 False, NoEventMask, &event);
8981 XSync (FRAME_X_DISPLAY (f), False);
8984 /* Change of visibility. */
8986 /* This tries to wait until the frame is really visible.
8987 However, if the window manager asks the user where to position
8988 the frame, this will return before the user finishes doing that.
8989 The frame will not actually be visible at that time,
8990 but it will become visible later when the window manager
8991 finishes with it. */
8993 void
8994 x_make_frame_visible (struct frame *f)
8996 Lisp_Object type;
8997 int original_top, original_left;
8998 int retry_count = 2;
9000 retry:
9002 BLOCK_INPUT;
9004 type = x_icon_type (f);
9005 if (!NILP (type))
9006 x_bitmap_icon (f, type);
9008 if (! FRAME_VISIBLE_P (f))
9010 /* We test FRAME_GARBAGED_P here to make sure we don't
9011 call x_set_offset a second time
9012 if we get to x_make_frame_visible a second time
9013 before the window gets really visible. */
9014 if (! FRAME_ICONIFIED_P (f)
9015 && ! FRAME_X_EMBEDDED_P (f)
9016 && ! f->output_data.x->asked_for_visible)
9017 x_set_offset (f, f->left_pos, f->top_pos, 0);
9019 f->output_data.x->asked_for_visible = 1;
9021 if (! EQ (Vx_no_window_manager, Qt))
9022 x_wm_set_window_state (f, NormalState);
9023 #ifdef USE_X_TOOLKIT
9024 if (FRAME_X_EMBEDDED_P (f))
9025 xembed_set_info (f, XEMBED_MAPPED);
9026 else
9028 /* This was XtPopup, but that did nothing for an iconified frame. */
9029 XtMapWidget (f->output_data.x->widget);
9031 #else /* not USE_X_TOOLKIT */
9032 #ifdef USE_GTK
9033 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9034 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9035 #else
9036 if (FRAME_X_EMBEDDED_P (f))
9037 xembed_set_info (f, XEMBED_MAPPED);
9038 else
9039 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9040 #endif /* not USE_GTK */
9041 #endif /* not USE_X_TOOLKIT */
9044 XFlush (FRAME_X_DISPLAY (f));
9046 /* Synchronize to ensure Emacs knows the frame is visible
9047 before we do anything else. We do this loop with input not blocked
9048 so that incoming events are handled. */
9050 Lisp_Object frame;
9051 int count;
9052 /* This must be before UNBLOCK_INPUT
9053 since events that arrive in response to the actions above
9054 will set it when they are handled. */
9055 int previously_visible = f->output_data.x->has_been_visible;
9057 original_left = f->left_pos;
9058 original_top = f->top_pos;
9060 /* This must come after we set COUNT. */
9061 UNBLOCK_INPUT;
9063 /* We unblock here so that arriving X events are processed. */
9065 /* Now move the window back to where it was "supposed to be".
9066 But don't do it if the gravity is negative.
9067 When the gravity is negative, this uses a position
9068 that is 3 pixels too low. Perhaps that's really the border width.
9070 Don't do this if the window has never been visible before,
9071 because the window manager may choose the position
9072 and we don't want to override it. */
9074 if (! FRAME_VISIBLE_P (f)
9075 && ! FRAME_ICONIFIED_P (f)
9076 && ! FRAME_X_EMBEDDED_P (f)
9077 && f->win_gravity == NorthWestGravity
9078 && previously_visible)
9080 Drawable rootw;
9081 int x, y;
9082 unsigned int width, height, border, depth;
9084 BLOCK_INPUT;
9086 /* On some window managers (such as FVWM) moving an existing
9087 window, even to the same place, causes the window manager
9088 to introduce an offset. This can cause the window to move
9089 to an unexpected location. Check the geometry (a little
9090 slow here) and then verify that the window is in the right
9091 place. If the window is not in the right place, move it
9092 there, and take the potential window manager hit. */
9093 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9094 &rootw, &x, &y, &width, &height, &border, &depth);
9096 if (original_left != x || original_top != y)
9097 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9098 original_left, original_top);
9100 UNBLOCK_INPUT;
9103 XSETFRAME (frame, f);
9105 /* Wait until the frame is visible. Process X events until a
9106 MapNotify event has been seen, or until we think we won't get a
9107 MapNotify at all.. */
9108 for (count = input_signal_count + 10;
9109 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9111 /* Force processing of queued events. */
9112 x_sync (f);
9114 /* Machines that do polling rather than SIGIO have been
9115 observed to go into a busy-wait here. So we'll fake an
9116 alarm signal to let the handler know that there's something
9117 to be read. We used to raise a real alarm, but it seems
9118 that the handler isn't always enabled here. This is
9119 probably a bug. */
9120 if (input_polling_used ())
9122 /* It could be confusing if a real alarm arrives while
9123 processing the fake one. Turn it off and let the
9124 handler reset it. */
9125 int old_poll_suppress_count = poll_suppress_count;
9126 poll_suppress_count = 1;
9127 poll_for_input_1 ();
9128 poll_suppress_count = old_poll_suppress_count;
9131 /* See if a MapNotify event has been processed. */
9132 FRAME_SAMPLE_VISIBILITY (f);
9135 /* 2000-09-28: In
9137 (let ((f (selected-frame)))
9138 (iconify-frame f)
9139 (raise-frame f))
9141 the frame is not raised with various window managers on
9142 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9143 unknown reason, the call to XtMapWidget is completely ignored.
9144 Mapping the widget a second time works. */
9146 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9147 goto retry;
9151 /* Change from mapped state to withdrawn state. */
9153 /* Make the frame visible (mapped and not iconified). */
9155 void
9156 x_make_frame_invisible (struct frame *f)
9158 Window window;
9160 /* Use the frame's outermost window, not the one we normally draw on. */
9161 window = FRAME_OUTER_WINDOW (f);
9163 /* Don't keep the highlight on an invisible frame. */
9164 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9165 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9167 BLOCK_INPUT;
9169 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9170 that the current position of the window is user-specified, rather than
9171 program-specified, so that when the window is mapped again, it will be
9172 placed at the same location, without forcing the user to position it
9173 by hand again (they have already done that once for this window.) */
9174 x_wm_set_size_hint (f, (long) 0, 1);
9176 #ifdef USE_GTK
9177 if (FRAME_GTK_OUTER_WIDGET (f))
9178 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9179 else
9180 #else
9181 if (FRAME_X_EMBEDDED_P (f))
9182 xembed_set_info (f, 0);
9183 else
9184 #endif
9187 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9188 DefaultScreen (FRAME_X_DISPLAY (f))))
9190 UNBLOCK_INPUT_RESIGNAL;
9191 error ("Can't notify window manager of window withdrawal");
9195 /* We can't distinguish this from iconification
9196 just by the event that we get from the server.
9197 So we can't win using the usual strategy of letting
9198 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9199 and synchronize with the server to make sure we agree. */
9200 f->visible = 0;
9201 FRAME_ICONIFIED_P (f) = 0;
9202 f->async_visible = 0;
9203 f->async_iconified = 0;
9205 x_sync (f);
9207 UNBLOCK_INPUT;
9210 /* Change window state from mapped to iconified. */
9212 void
9213 x_iconify_frame (struct frame *f)
9215 int result;
9216 Lisp_Object type;
9218 /* Don't keep the highlight on an invisible frame. */
9219 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9220 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9222 if (f->async_iconified)
9223 return;
9225 BLOCK_INPUT;
9227 FRAME_SAMPLE_VISIBILITY (f);
9229 type = x_icon_type (f);
9230 if (!NILP (type))
9231 x_bitmap_icon (f, type);
9233 #ifdef USE_GTK
9234 if (FRAME_GTK_OUTER_WIDGET (f))
9236 if (! FRAME_VISIBLE_P (f))
9237 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9239 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9240 f->iconified = 1;
9241 f->visible = 1;
9242 f->async_iconified = 1;
9243 f->async_visible = 0;
9244 UNBLOCK_INPUT;
9245 return;
9247 #endif
9249 #ifdef USE_X_TOOLKIT
9251 if (! FRAME_VISIBLE_P (f))
9253 if (! EQ (Vx_no_window_manager, Qt))
9254 x_wm_set_window_state (f, IconicState);
9255 /* This was XtPopup, but that did nothing for an iconified frame. */
9256 XtMapWidget (f->output_data.x->widget);
9257 /* The server won't give us any event to indicate
9258 that an invisible frame was changed to an icon,
9259 so we have to record it here. */
9260 f->iconified = 1;
9261 f->visible = 1;
9262 f->async_iconified = 1;
9263 f->async_visible = 0;
9264 UNBLOCK_INPUT;
9265 return;
9268 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9269 XtWindow (f->output_data.x->widget),
9270 DefaultScreen (FRAME_X_DISPLAY (f)));
9271 UNBLOCK_INPUT;
9273 if (!result)
9274 error ("Can't notify window manager of iconification");
9276 f->async_iconified = 1;
9277 f->async_visible = 0;
9280 BLOCK_INPUT;
9281 XFlush (FRAME_X_DISPLAY (f));
9282 UNBLOCK_INPUT;
9283 #else /* not USE_X_TOOLKIT */
9285 /* Make sure the X server knows where the window should be positioned,
9286 in case the user deiconifies with the window manager. */
9287 if (! FRAME_VISIBLE_P (f)
9288 && ! FRAME_ICONIFIED_P (f)
9289 && ! FRAME_X_EMBEDDED_P (f))
9290 x_set_offset (f, f->left_pos, f->top_pos, 0);
9292 /* Since we don't know which revision of X we're running, we'll use both
9293 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9295 /* X11R4: send a ClientMessage to the window manager using the
9296 WM_CHANGE_STATE type. */
9298 XEvent message;
9300 message.xclient.window = FRAME_X_WINDOW (f);
9301 message.xclient.type = ClientMessage;
9302 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9303 message.xclient.format = 32;
9304 message.xclient.data.l[0] = IconicState;
9306 if (! XSendEvent (FRAME_X_DISPLAY (f),
9307 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9308 False,
9309 SubstructureRedirectMask | SubstructureNotifyMask,
9310 &message))
9312 UNBLOCK_INPUT_RESIGNAL;
9313 error ("Can't notify window manager of iconification");
9317 /* X11R3: set the initial_state field of the window manager hints to
9318 IconicState. */
9319 x_wm_set_window_state (f, IconicState);
9321 if (!FRAME_VISIBLE_P (f))
9323 /* If the frame was withdrawn, before, we must map it. */
9324 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9327 f->async_iconified = 1;
9328 f->async_visible = 0;
9330 XFlush (FRAME_X_DISPLAY (f));
9331 UNBLOCK_INPUT;
9332 #endif /* not USE_X_TOOLKIT */
9336 /* Free X resources of frame F. */
9338 void
9339 x_free_frame_resources (struct frame *f)
9341 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9342 Lisp_Object bar;
9343 struct scroll_bar *b;
9344 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9346 BLOCK_INPUT;
9348 /* If a display connection is dead, don't try sending more
9349 commands to the X server. */
9350 if (dpyinfo->display)
9352 /* We must free faces before destroying windows because some
9353 font-driver (e.g. xft) access a window while finishing a
9354 face. */
9355 if (FRAME_FACE_CACHE (f))
9356 free_frame_faces (f);
9358 if (f->output_data.x->icon_desc)
9359 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9361 #ifdef USE_X_TOOLKIT
9362 /* Explicitly destroy the scroll bars of the frame. Without
9363 this, we get "BadDrawable" errors from the toolkit later on,
9364 presumably from expose events generated for the disappearing
9365 toolkit scroll bars. */
9366 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9368 b = XSCROLL_BAR (bar);
9369 x_scroll_bar_remove (b);
9371 #endif
9373 #ifdef HAVE_X_I18N
9374 if (FRAME_XIC (f))
9375 free_frame_xic (f);
9376 #endif
9378 #ifdef USE_X_TOOLKIT
9379 if (f->output_data.x->widget)
9381 XtDestroyWidget (f->output_data.x->widget);
9382 f->output_data.x->widget = NULL;
9384 /* Tooltips don't have widgets, only a simple X window, even if
9385 we are using a toolkit. */
9386 else if (FRAME_X_WINDOW (f))
9387 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9389 free_frame_menubar (f);
9390 #else /* !USE_X_TOOLKIT */
9392 #ifdef USE_GTK
9393 xg_free_frame_widgets (f);
9394 #endif /* USE_GTK */
9396 if (FRAME_X_WINDOW (f))
9397 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9398 #endif /* !USE_X_TOOLKIT */
9400 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9401 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9402 unload_color (f, f->output_data.x->cursor_pixel);
9403 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9404 unload_color (f, f->output_data.x->border_pixel);
9405 unload_color (f, f->output_data.x->mouse_pixel);
9407 if (f->output_data.x->scroll_bar_background_pixel != -1)
9408 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9409 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9410 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9411 #ifdef USE_TOOLKIT_SCROLL_BARS
9412 /* Scrollbar shadow colors. */
9413 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9414 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9415 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9416 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9417 #endif /* USE_TOOLKIT_SCROLL_BARS */
9418 if (f->output_data.x->white_relief.allocated_p)
9419 unload_color (f, f->output_data.x->white_relief.pixel);
9420 if (f->output_data.x->black_relief.allocated_p)
9421 unload_color (f, f->output_data.x->black_relief.pixel);
9423 x_free_gcs (f);
9424 XFlush (FRAME_X_DISPLAY (f));
9427 xfree (f->output_data.x->saved_menu_event);
9428 xfree (f->output_data.x);
9429 f->output_data.x = NULL;
9431 if (f == dpyinfo->x_focus_frame)
9432 dpyinfo->x_focus_frame = 0;
9433 if (f == dpyinfo->x_focus_event_frame)
9434 dpyinfo->x_focus_event_frame = 0;
9435 if (f == dpyinfo->x_highlight_frame)
9436 dpyinfo->x_highlight_frame = 0;
9438 if (f == hlinfo->mouse_face_mouse_frame)
9440 hlinfo->mouse_face_beg_row
9441 = hlinfo->mouse_face_beg_col = -1;
9442 hlinfo->mouse_face_end_row
9443 = hlinfo->mouse_face_end_col = -1;
9444 hlinfo->mouse_face_window = Qnil;
9445 hlinfo->mouse_face_deferred_gc = 0;
9446 hlinfo->mouse_face_mouse_frame = 0;
9449 UNBLOCK_INPUT;
9453 /* Destroy the X window of frame F. */
9455 void
9456 x_destroy_window (struct frame *f)
9458 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9460 /* If a display connection is dead, don't try sending more
9461 commands to the X server. */
9462 if (dpyinfo->display != 0)
9463 x_free_frame_resources (f);
9465 dpyinfo->reference_count--;
9469 /* Setting window manager hints. */
9471 /* Set the normal size hints for the window manager, for frame F.
9472 FLAGS is the flags word to use--or 0 meaning preserve the flags
9473 that the window now has.
9474 If USER_POSITION is nonzero, we set the USPosition
9475 flag (this is useful when FLAGS is 0).
9476 The GTK version is in gtkutils.c */
9478 #ifndef USE_GTK
9479 void
9480 x_wm_set_size_hint (struct frame *f, long flags, int user_position)
9482 XSizeHints size_hints;
9483 Window window = FRAME_OUTER_WINDOW (f);
9485 /* Setting PMaxSize caused various problems. */
9486 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9488 size_hints.x = f->left_pos;
9489 size_hints.y = f->top_pos;
9491 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9492 size_hints.width = FRAME_PIXEL_WIDTH (f);
9494 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9495 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9496 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9497 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9498 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9499 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9501 /* Calculate the base and minimum sizes. */
9503 int base_width, base_height;
9504 int min_rows = 0, min_cols = 0;
9506 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9507 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9509 check_frame_size (f, &min_rows, &min_cols);
9511 /* The window manager uses the base width hints to calculate the
9512 current number of rows and columns in the frame while
9513 resizing; min_width and min_height aren't useful for this
9514 purpose, since they might not give the dimensions for a
9515 zero-row, zero-column frame.
9517 We use the base_width and base_height members if we have
9518 them; otherwise, we set the min_width and min_height members
9519 to the size for a zero x zero frame. */
9521 size_hints.flags |= PBaseSize;
9522 size_hints.base_width = base_width;
9523 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9524 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9525 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9528 /* If we don't need the old flags, we don't need the old hint at all. */
9529 if (flags)
9531 size_hints.flags |= flags;
9532 goto no_read;
9536 XSizeHints hints; /* Sometimes I hate X Windows... */
9537 long supplied_return;
9538 int value;
9540 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9541 &supplied_return);
9543 if (flags)
9544 size_hints.flags |= flags;
9545 else
9547 if (value == 0)
9548 hints.flags = 0;
9549 if (hints.flags & PSize)
9550 size_hints.flags |= PSize;
9551 if (hints.flags & PPosition)
9552 size_hints.flags |= PPosition;
9553 if (hints.flags & USPosition)
9554 size_hints.flags |= USPosition;
9555 if (hints.flags & USSize)
9556 size_hints.flags |= USSize;
9560 no_read:
9562 #ifdef PWinGravity
9563 size_hints.win_gravity = f->win_gravity;
9564 size_hints.flags |= PWinGravity;
9566 if (user_position)
9568 size_hints.flags &= ~ PPosition;
9569 size_hints.flags |= USPosition;
9571 #endif /* PWinGravity */
9573 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9575 #endif /* not USE_GTK */
9577 /* Used for IconicState or NormalState */
9579 void
9580 x_wm_set_window_state (struct frame *f, int state)
9582 #ifdef USE_X_TOOLKIT
9583 Arg al[1];
9585 XtSetArg (al[0], XtNinitialState, state);
9586 XtSetValues (f->output_data.x->widget, al, 1);
9587 #else /* not USE_X_TOOLKIT */
9588 Window window = FRAME_X_WINDOW (f);
9590 f->output_data.x->wm_hints.flags |= StateHint;
9591 f->output_data.x->wm_hints.initial_state = state;
9593 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9594 #endif /* not USE_X_TOOLKIT */
9597 void
9598 x_wm_set_icon_pixmap (struct frame *f, int pixmap_id)
9600 Pixmap icon_pixmap, icon_mask;
9602 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9603 Window window = FRAME_OUTER_WINDOW (f);
9604 #endif
9606 if (pixmap_id > 0)
9608 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9609 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9610 icon_mask = x_bitmap_mask (f, pixmap_id);
9611 f->output_data.x->wm_hints.icon_mask = icon_mask;
9613 else
9615 /* It seems there is no way to turn off use of an icon
9616 pixmap. */
9617 return;
9621 #ifdef USE_GTK
9623 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9624 return;
9627 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9630 Arg al[1];
9631 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9632 XtSetValues (f->output_data.x->widget, al, 1);
9633 XtSetArg (al[0], XtNiconMask, icon_mask);
9634 XtSetValues (f->output_data.x->widget, al, 1);
9637 #else /* not USE_X_TOOLKIT && not USE_GTK */
9639 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9640 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9642 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9645 void
9646 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9648 Window window = FRAME_OUTER_WINDOW (f);
9650 f->output_data.x->wm_hints.flags |= IconPositionHint;
9651 f->output_data.x->wm_hints.icon_x = icon_x;
9652 f->output_data.x->wm_hints.icon_y = icon_y;
9654 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9658 /***********************************************************************
9659 Fonts
9660 ***********************************************************************/
9662 #if GLYPH_DEBUG
9664 /* Check that FONT is valid on frame F. It is if it can be found in F's
9665 font table. */
9667 static void
9668 x_check_font (struct frame *f, struct font *font)
9670 Lisp_Object frame;
9672 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9673 if (font->driver->check)
9674 xassert (font->driver->check (f, font) == 0);
9677 #endif /* GLYPH_DEBUG != 0 */
9680 /***********************************************************************
9681 Initialization
9682 ***********************************************************************/
9684 #ifdef USE_X_TOOLKIT
9685 static XrmOptionDescRec emacs_options[] = {
9686 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9687 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9689 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9690 XrmoptionSepArg, NULL},
9691 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9693 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9694 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9695 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9696 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9697 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9698 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9699 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9702 /* Whether atimer for Xt timeouts is activated or not. */
9704 static int x_timeout_atimer_activated_flag;
9706 #endif /* USE_X_TOOLKIT */
9708 static int x_initialized;
9710 /* Test whether two display-name strings agree up to the dot that separates
9711 the screen number from the server number. */
9712 static int
9713 same_x_server (const char *name1, const char *name2)
9715 int seen_colon = 0;
9716 const char *system_name = SSDATA (Vsystem_name);
9717 int system_name_length = strlen (system_name);
9718 int length_until_period = 0;
9720 while (system_name[length_until_period] != 0
9721 && system_name[length_until_period] != '.')
9722 length_until_period++;
9724 /* Treat `unix' like an empty host name. */
9725 if (! strncmp (name1, "unix:", 5))
9726 name1 += 4;
9727 if (! strncmp (name2, "unix:", 5))
9728 name2 += 4;
9729 /* Treat this host's name like an empty host name. */
9730 if (! strncmp (name1, system_name, system_name_length)
9731 && name1[system_name_length] == ':')
9732 name1 += system_name_length;
9733 if (! strncmp (name2, system_name, system_name_length)
9734 && name2[system_name_length] == ':')
9735 name2 += system_name_length;
9736 /* Treat this host's domainless name like an empty host name. */
9737 if (! strncmp (name1, system_name, length_until_period)
9738 && name1[length_until_period] == ':')
9739 name1 += length_until_period;
9740 if (! strncmp (name2, system_name, length_until_period)
9741 && name2[length_until_period] == ':')
9742 name2 += length_until_period;
9744 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9746 if (*name1 == ':')
9747 seen_colon++;
9748 if (seen_colon && *name1 == '.')
9749 return 1;
9751 return (seen_colon
9752 && (*name1 == '.' || *name1 == '\0')
9753 && (*name2 == '.' || *name2 == '\0'));
9756 /* Count number of set bits in mask and number of bits to shift to
9757 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9758 to 5. */
9759 static void
9760 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9762 int nr = 0;
9763 int off = 0;
9765 while (!(mask & 1))
9767 off++;
9768 mask >>= 1;
9771 while (mask & 1)
9773 nr++;
9774 mask >>= 1;
9777 *offset = off;
9778 *bits = nr;
9781 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9782 But don't permanently open it, just test its availability. */
9785 x_display_ok (const char *display)
9787 int dpy_ok = 1;
9788 Display *dpy;
9790 dpy = XOpenDisplay (display);
9791 if (dpy)
9792 XCloseDisplay (dpy);
9793 else
9794 dpy_ok = 0;
9795 return dpy_ok;
9798 #ifdef USE_GTK
9799 static void
9800 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data)
9802 if (!strstr (message, "g_set_prgname"))
9803 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, message);
9805 #endif
9807 /* Open a connection to X display DISPLAY_NAME, and return
9808 the structure that describes the open display.
9809 If we cannot contact the display, return null. */
9811 struct x_display_info *
9812 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9814 int connection;
9815 Display *dpy;
9816 struct terminal *terminal;
9817 struct x_display_info *dpyinfo;
9818 XrmDatabase xrdb;
9819 Mouse_HLInfo *hlinfo;
9821 BLOCK_INPUT;
9823 if (!x_initialized)
9825 x_initialize ();
9826 ++x_initialized;
9829 if (! x_display_ok (SSDATA (display_name)))
9830 error ("Display %s can't be opened", SSDATA (display_name));
9832 #ifdef USE_GTK
9834 #define NUM_ARGV 10
9835 int argc;
9836 char *argv[NUM_ARGV];
9837 char **argv2 = argv;
9838 guint id;
9840 if (x_initialized++ > 1)
9842 xg_display_open (SSDATA (display_name), &dpy);
9844 else
9846 static char display_opt[] = "--display";
9847 static char name_opt[] = "--name";
9849 for (argc = 0; argc < NUM_ARGV; ++argc)
9850 argv[argc] = 0;
9852 argc = 0;
9853 argv[argc++] = initial_argv[0];
9855 if (! NILP (display_name))
9857 argv[argc++] = display_opt;
9858 argv[argc++] = SSDATA (display_name);
9861 argv[argc++] = name_opt;
9862 argv[argc++] = resource_name;
9864 XSetLocaleModifiers ("");
9866 /* Work around GLib bug that outputs a faulty warning. See
9867 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9868 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9869 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9870 gtk_init (&argc, &argv2);
9871 g_log_remove_handler ("GLib", id);
9873 /* gtk_init does set_locale. We must fix locale after calling it. */
9874 fixup_locale ();
9875 xg_initialize ();
9877 dpy = GDK_DISPLAY ();
9879 /* NULL window -> events for all windows go to our function */
9880 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9882 /* Load our own gtkrc if it exists. */
9884 const char *file = "~/.emacs.d/gtkrc";
9885 Lisp_Object s, abs_file;
9887 s = make_string (file, strlen (file));
9888 abs_file = Fexpand_file_name (s, Qnil);
9890 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9891 gtk_rc_parse (SSDATA (abs_file));
9894 XSetErrorHandler (x_error_handler);
9895 XSetIOErrorHandler (x_io_error_quitter);
9898 #else /* not USE_GTK */
9899 #ifdef USE_X_TOOLKIT
9900 /* weiner@footloose.sps.mot.com reports that this causes
9901 errors with X11R5:
9902 X protocol error: BadAtom (invalid Atom parameter)
9903 on protocol request 18skiloaf.
9904 So let's not use it until R6. */
9905 #ifdef HAVE_X11XTR6
9906 XtSetLanguageProc (NULL, NULL, NULL);
9907 #endif
9910 int argc = 0;
9911 char *argv[3];
9913 argv[0] = "";
9914 argc = 1;
9915 if (xrm_option)
9917 argv[argc++] = "-xrm";
9918 argv[argc++] = xrm_option;
9920 turn_on_atimers (0);
9921 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
9922 resource_name, EMACS_CLASS,
9923 emacs_options, XtNumber (emacs_options),
9924 &argc, argv);
9925 turn_on_atimers (1);
9927 #ifdef HAVE_X11XTR6
9928 /* I think this is to compensate for XtSetLanguageProc. */
9929 fixup_locale ();
9930 #endif
9933 #else /* not USE_X_TOOLKIT */
9934 XSetLocaleModifiers ("");
9935 dpy = XOpenDisplay (SSDATA (display_name));
9936 #endif /* not USE_X_TOOLKIT */
9937 #endif /* not USE_GTK*/
9939 /* Detect failure. */
9940 if (dpy == 0)
9942 UNBLOCK_INPUT;
9943 return 0;
9946 /* We have definitely succeeded. Record the new connection. */
9948 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
9949 memset (dpyinfo, 0, sizeof *dpyinfo);
9950 hlinfo = &dpyinfo->mouse_highlight;
9952 terminal = x_create_terminal (dpyinfo);
9955 struct x_display_info *share;
9956 Lisp_Object tail;
9958 for (share = x_display_list, tail = x_display_name_list; share;
9959 share = share->next, tail = XCDR (tail))
9960 if (same_x_server (SSDATA (XCAR (XCAR (tail))),
9961 SSDATA (display_name)))
9962 break;
9963 if (share)
9964 terminal->kboard = share->terminal->kboard;
9965 else
9967 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
9968 init_kboard (terminal->kboard);
9969 KVAR (terminal->kboard, Vwindow_system) = Qx;
9971 /* Add the keyboard to the list before running Lisp code (via
9972 Qvendor_specific_keysyms below), since these are not traced
9973 via terminals but only through all_kboards. */
9974 terminal->kboard->next_kboard = all_kboards;
9975 all_kboards = terminal->kboard;
9977 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
9979 char *vendor = ServerVendor (dpy);
9981 /* Protect terminal from GC before removing it from the
9982 list of terminals. */
9983 struct gcpro gcpro1;
9984 Lisp_Object gcpro_term;
9985 XSETTERMINAL (gcpro_term, terminal);
9986 GCPRO1 (gcpro_term);
9988 /* Temporarily hide the partially initialized terminal. */
9989 terminal_list = terminal->next_terminal;
9990 UNBLOCK_INPUT;
9991 KVAR (terminal->kboard, Vsystem_key_alist)
9992 = call1 (Qvendor_specific_keysyms,
9993 vendor ? build_string (vendor) : empty_unibyte_string);
9994 BLOCK_INPUT;
9995 terminal->next_terminal = terminal_list;
9996 terminal_list = terminal;
9997 UNGCPRO;
10000 /* Don't let the initial kboard remain current longer than necessary.
10001 That would cause problems if a file loaded on startup tries to
10002 prompt in the mini-buffer. */
10003 if (current_kboard == initial_kboard)
10004 current_kboard = terminal->kboard;
10006 terminal->kboard->reference_count++;
10009 /* Put this display on the chain. */
10010 dpyinfo->next = x_display_list;
10011 x_display_list = dpyinfo;
10013 /* Put it on x_display_name_list as well, to keep them parallel. */
10014 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10015 x_display_name_list);
10016 dpyinfo->name_list_element = XCAR (x_display_name_list);
10018 dpyinfo->display = dpy;
10020 /* Set the name of the terminal. */
10021 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10022 strncpy (terminal->name, SSDATA (display_name), SBYTES (display_name));
10023 terminal->name[SBYTES (display_name)] = 0;
10025 #if 0
10026 XSetAfterFunction (x_current_display, x_trace_wire);
10027 #endif /* ! 0 */
10029 dpyinfo->x_id_name
10030 = (char *) xmalloc (SBYTES (Vinvocation_name)
10031 + SBYTES (Vsystem_name)
10032 + 2);
10033 sprintf (dpyinfo->x_id_name, "%s@%s",
10034 SSDATA (Vinvocation_name), SSDATA (Vsystem_name));
10036 /* Figure out which modifier bits mean what. */
10037 x_find_modifier_meanings (dpyinfo);
10039 /* Get the scroll bar cursor. */
10040 #ifdef USE_GTK
10041 /* We must create a GTK cursor, it is required for GTK widgets. */
10042 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10043 #endif /* USE_GTK */
10045 dpyinfo->vertical_scroll_bar_cursor
10046 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10048 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10049 resource_name, EMACS_CLASS);
10050 #ifdef HAVE_XRMSETDATABASE
10051 XrmSetDatabase (dpyinfo->display, xrdb);
10052 #else
10053 dpyinfo->display->db = xrdb;
10054 #endif
10055 /* Put the rdb where we can find it in a way that works on
10056 all versions. */
10057 dpyinfo->xrdb = xrdb;
10059 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10060 DefaultScreen (dpyinfo->display));
10061 select_visual (dpyinfo);
10062 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10063 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10064 dpyinfo->client_leader_window = 0;
10065 dpyinfo->grabbed = 0;
10066 dpyinfo->reference_count = 0;
10067 dpyinfo->icon_bitmap_id = -1;
10068 dpyinfo->n_fonts = 0;
10069 dpyinfo->bitmaps = 0;
10070 dpyinfo->bitmaps_size = 0;
10071 dpyinfo->bitmaps_last = 0;
10072 dpyinfo->scratch_cursor_gc = 0;
10073 hlinfo->mouse_face_mouse_frame = 0;
10074 hlinfo->mouse_face_deferred_gc = 0;
10075 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10076 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10077 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10078 hlinfo->mouse_face_window = Qnil;
10079 hlinfo->mouse_face_overlay = Qnil;
10080 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10081 hlinfo->mouse_face_defer = 0;
10082 hlinfo->mouse_face_hidden = 0;
10083 dpyinfo->x_focus_frame = 0;
10084 dpyinfo->x_focus_event_frame = 0;
10085 dpyinfo->x_highlight_frame = 0;
10086 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10088 /* See if we can construct pixel values from RGB values. */
10089 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10090 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10092 if (dpyinfo->visual->class == TrueColor)
10094 get_bits_and_offset (dpyinfo->visual->red_mask,
10095 &dpyinfo->red_bits, &dpyinfo->red_offset);
10096 get_bits_and_offset (dpyinfo->visual->blue_mask,
10097 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10098 get_bits_and_offset (dpyinfo->visual->green_mask,
10099 &dpyinfo->green_bits, &dpyinfo->green_offset);
10102 /* See if a private colormap is requested. */
10103 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10105 if (dpyinfo->visual->class == PseudoColor)
10107 Lisp_Object value;
10108 value = display_x_get_resource (dpyinfo,
10109 build_string ("privateColormap"),
10110 build_string ("PrivateColormap"),
10111 Qnil, Qnil);
10112 if (STRINGP (value)
10113 && (!strcmp (SSDATA (value), "true")
10114 || !strcmp (SSDATA (value), "on")))
10115 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10118 else
10119 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10120 dpyinfo->visual, AllocNone);
10122 #ifdef HAVE_XFT
10124 /* If we are using Xft, check dpi value in X resources.
10125 It is better we use it as well, since Xft will use it, as will all
10126 Gnome applications. If our real DPI is smaller or larger than the
10127 one Xft uses, our font will look smaller or larger than other
10128 for other applications, even if it is the same font name (monospace-10
10129 for example). */
10130 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10131 double d;
10132 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10133 dpyinfo->resy = dpyinfo->resx = d;
10135 #endif
10137 if (dpyinfo->resy < 1)
10139 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10140 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10141 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10142 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10143 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10144 pixels = DisplayWidth (dpyinfo->display, screen_number);
10145 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10146 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10147 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10151 const struct
10153 const char *name;
10154 Atom *atom;
10155 } atom_refs[] = {
10156 { "WM_PROTOCOLS", &dpyinfo->Xatom_wm_protocols },
10157 { "WM_TAKE_FOCUS", &dpyinfo->Xatom_wm_take_focus },
10158 { "WM_SAVE_YOURSELF", &dpyinfo->Xatom_wm_save_yourself },
10159 { "WM_DELETE_WINDOW", &dpyinfo->Xatom_wm_delete_window },
10160 { "WM_CHANGE_STATE", &dpyinfo->Xatom_wm_change_state },
10161 { "WM_CONFIGURE_DENIED", &dpyinfo->Xatom_wm_configure_denied },
10162 { "WM_MOVED", &dpyinfo->Xatom_wm_window_moved },
10163 { "WM_CLIENT_LEADER", &dpyinfo->Xatom_wm_client_leader },
10164 { "Editres", &dpyinfo->Xatom_editres },
10165 { "CLIPBOARD", &dpyinfo->Xatom_CLIPBOARD },
10166 { "TIMESTAMP", &dpyinfo->Xatom_TIMESTAMP },
10167 { "TEXT", &dpyinfo->Xatom_TEXT },
10168 { "COMPOUND_TEXT", &dpyinfo->Xatom_COMPOUND_TEXT },
10169 { "UTF8_STRING", &dpyinfo->Xatom_UTF8_STRING },
10170 { "DELETE", &dpyinfo->Xatom_DELETE },
10171 { "MULTIPLE", &dpyinfo->Xatom_MULTIPLE },
10172 { "INCR", &dpyinfo->Xatom_INCR },
10173 { "_EMACS_TMP_", &dpyinfo->Xatom_EMACS_TMP },
10174 { "TARGETS", &dpyinfo->Xatom_TARGETS },
10175 { "NULL", &dpyinfo->Xatom_NULL },
10176 { "ATOM_PAIR", &dpyinfo->Xatom_ATOM_PAIR },
10177 { "_XEMBED_INFO", &dpyinfo->Xatom_XEMBED_INFO },
10178 /* For properties of font. */
10179 { "PIXEL_SIZE", &dpyinfo->Xatom_PIXEL_SIZE },
10180 { "AVERAGE_WIDTH", &dpyinfo->Xatom_AVERAGE_WIDTH },
10181 { "_MULE_BASELINE_OFFSET", &dpyinfo->Xatom_MULE_BASELINE_OFFSET },
10182 { "_MULE_RELATIVE_COMPOSE", &dpyinfo->Xatom_MULE_RELATIVE_COMPOSE },
10183 { "_MULE_DEFAULT_ASCENT", &dpyinfo->Xatom_MULE_DEFAULT_ASCENT },
10184 /* Ghostscript support. */
10185 { "DONE", &dpyinfo->Xatom_DONE },
10186 { "PAGE", &dpyinfo->Xatom_PAGE },
10187 { "SCROLLBAR", &dpyinfo->Xatom_Scrollbar },
10188 { "_XEMBED", &dpyinfo->Xatom_XEMBED },
10189 /* EWMH */
10190 { "_NET_WM_STATE", &dpyinfo->Xatom_net_wm_state },
10191 { "_NET_WM_STATE_FULLSCREEN", &dpyinfo->Xatom_net_wm_state_fullscreen },
10192 { "_NET_WM_STATE_MAXIMIZED_HORZ",
10193 &dpyinfo->Xatom_net_wm_state_maximized_horz },
10194 { "_NET_WM_STATE_MAXIMIZED_VERT",
10195 &dpyinfo->Xatom_net_wm_state_maximized_vert },
10196 { "_NET_WM_STATE_STICKY", &dpyinfo->Xatom_net_wm_state_sticky },
10197 { "_NET_WM_WINDOW_TYPE", &dpyinfo->Xatom_net_window_type },
10198 { "_NET_WM_WINDOW_TYPE_TOOLTIP",
10199 &dpyinfo->Xatom_net_window_type_tooltip },
10200 { "_NET_WM_ICON_NAME", &dpyinfo->Xatom_net_wm_icon_name },
10201 { "_NET_WM_NAME", &dpyinfo->Xatom_net_wm_name },
10202 { "_NET_SUPPORTED", &dpyinfo->Xatom_net_supported },
10203 { "_NET_SUPPORTING_WM_CHECK", &dpyinfo->Xatom_net_supporting_wm_check },
10204 { "_NET_WM_WINDOW_OPACITY", &dpyinfo->Xatom_net_wm_window_opacity },
10205 { "_NET_ACTIVE_WINDOW", &dpyinfo->Xatom_net_active_window },
10206 { "_NET_FRAME_EXTENTS", &dpyinfo->Xatom_net_frame_extents },
10207 /* Session management */
10208 { "SM_CLIENT_ID", &dpyinfo->Xatom_SM_CLIENT_ID },
10209 { "_XSETTINGS_SETTINGS", &dpyinfo->Xatom_xsettings_prop },
10210 { "MANAGER", &dpyinfo->Xatom_xsettings_mgr },
10213 int i;
10214 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10215 /* 1 for _XSETTINGS_SN */
10216 const int total_atom_count = 1 + atom_count;
10217 Atom *atoms_return = xmalloc (sizeof (Atom) * total_atom_count);
10218 char **atom_names = xmalloc (sizeof (char *) * total_atom_count);
10219 char xsettings_atom_name[64];
10221 for (i = 0; i < atom_count; i++)
10222 atom_names[i] = (char *) atom_refs[i].name;
10224 /* Build _XSETTINGS_SN atom name */
10225 snprintf (xsettings_atom_name, sizeof (xsettings_atom_name),
10226 "_XSETTINGS_S%d", XScreenNumberOfScreen (dpyinfo->screen));
10227 atom_names[i] = xsettings_atom_name;
10229 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10230 False, atoms_return);
10232 for (i = 0; i < atom_count; i++)
10233 *atom_refs[i].atom = atoms_return[i];
10235 /* Manual copy of last atom */
10236 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10238 xfree (atom_names);
10239 xfree (atoms_return);
10242 dpyinfo->x_dnd_atoms_size = 8;
10243 dpyinfo->x_dnd_atoms_length = 0;
10244 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10245 * dpyinfo->x_dnd_atoms_size);
10247 dpyinfo->net_supported_atoms = NULL;
10248 dpyinfo->nr_net_supported_atoms = 0;
10249 dpyinfo->net_supported_window = 0;
10251 connection = ConnectionNumber (dpyinfo->display);
10252 dpyinfo->connection = connection;
10255 dpyinfo->gray
10256 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10257 gray_bitmap_bits,
10258 gray_bitmap_width, gray_bitmap_height,
10259 (unsigned long) 1, (unsigned long) 0, 1);
10262 #ifdef HAVE_X_I18N
10263 xim_initialize (dpyinfo, resource_name);
10264 #endif
10266 xsettings_initialize (dpyinfo);
10268 /* This is only needed for distinguishing keyboard and process input. */
10269 if (connection != 0)
10270 add_keyboard_wait_descriptor (connection);
10272 #ifdef F_SETOWN
10273 fcntl (connection, F_SETOWN, getpid ());
10274 #endif /* ! defined (F_SETOWN) */
10276 #ifdef SIGIO
10277 if (interrupt_input)
10278 init_sigio (connection);
10279 #endif /* ! defined (SIGIO) */
10281 #ifdef USE_LUCID
10283 Display *dpy = dpyinfo->display;
10284 XrmValue d, fr, to;
10285 Font font;
10287 d.addr = (XPointer)&dpy;
10288 d.size = sizeof (Display *);
10289 fr.addr = XtDefaultFont;
10290 fr.size = sizeof (XtDefaultFont);
10291 to.size = sizeof (Font *);
10292 to.addr = (XPointer)&font;
10293 x_catch_errors (dpy);
10294 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10295 abort ();
10296 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10297 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10298 x_uncatch_errors ();
10300 #endif
10302 /* See if we should run in synchronous mode. This is useful
10303 for debugging X code. */
10305 Lisp_Object value;
10306 value = display_x_get_resource (dpyinfo,
10307 build_string ("synchronous"),
10308 build_string ("Synchronous"),
10309 Qnil, Qnil);
10310 if (STRINGP (value)
10311 && (!strcmp (SSDATA (value), "true")
10312 || !strcmp (SSDATA (value), "on")))
10313 XSynchronize (dpyinfo->display, True);
10317 Lisp_Object value;
10318 value = display_x_get_resource (dpyinfo,
10319 build_string ("useXIM"),
10320 build_string ("UseXIM"),
10321 Qnil, Qnil);
10322 #ifdef USE_XIM
10323 if (STRINGP (value)
10324 && (!strcmp (SSDATA (value), "false")
10325 || !strcmp (SSDATA (value), "off")))
10326 use_xim = 0;
10327 #else
10328 if (STRINGP (value)
10329 && (!strcmp (SSDATA (value), "true")
10330 || !strcmp (SSDATA (value), "on")))
10331 use_xim = 1;
10332 #endif
10335 #ifdef HAVE_X_SM
10336 /* Only do this for the very first display in the Emacs session.
10337 Ignore X session management when Emacs was first started on a
10338 tty. */
10339 if (terminal->id == 1)
10340 x_session_initialize (dpyinfo);
10341 #endif
10343 UNBLOCK_INPUT;
10345 return dpyinfo;
10348 /* Get rid of display DPYINFO, deleting all frames on it,
10349 and without sending any more commands to the X server. */
10351 void
10352 x_delete_display (struct x_display_info *dpyinfo)
10354 struct terminal *t;
10356 /* Close all frames and delete the generic struct terminal for this
10357 X display. */
10358 for (t = terminal_list; t; t = t->next_terminal)
10359 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10361 #ifdef HAVE_X_SM
10362 /* Close X session management when we close its display. */
10363 if (t->id == 1 && x_session_have_connection ())
10364 x_session_close ();
10365 #endif
10366 delete_terminal (t);
10367 break;
10370 delete_keyboard_wait_descriptor (dpyinfo->connection);
10372 /* Discard this display from x_display_name_list and x_display_list.
10373 We can't use Fdelq because that can quit. */
10374 if (! NILP (x_display_name_list)
10375 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10376 x_display_name_list = XCDR (x_display_name_list);
10377 else
10379 Lisp_Object tail;
10381 tail = x_display_name_list;
10382 while (CONSP (tail) && CONSP (XCDR (tail)))
10384 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10386 XSETCDR (tail, XCDR (XCDR (tail)));
10387 break;
10389 tail = XCDR (tail);
10393 if (next_noop_dpyinfo == dpyinfo)
10394 next_noop_dpyinfo = dpyinfo->next;
10396 if (x_display_list == dpyinfo)
10397 x_display_list = dpyinfo->next;
10398 else
10400 struct x_display_info *tail;
10402 for (tail = x_display_list; tail; tail = tail->next)
10403 if (tail->next == dpyinfo)
10404 tail->next = tail->next->next;
10407 xfree (dpyinfo->x_id_name);
10408 xfree (dpyinfo->x_dnd_atoms);
10409 xfree (dpyinfo->color_cells);
10410 xfree (dpyinfo);
10413 #ifdef USE_X_TOOLKIT
10415 /* Atimer callback function for TIMER. Called every 0.1s to process
10416 Xt timeouts, if needed. We must avoid calling XtAppPending as
10417 much as possible because that function does an implicit XFlush
10418 that slows us down. */
10420 static void
10421 x_process_timeouts (struct atimer *timer)
10423 BLOCK_INPUT;
10424 x_timeout_atimer_activated_flag = 0;
10425 if (toolkit_scroll_bar_interaction || popup_activated ())
10427 while (XtAppPending (Xt_app_con) & XtIMTimer)
10428 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10429 /* Reactivate the atimer for next time. */
10430 x_activate_timeout_atimer ();
10432 UNBLOCK_INPUT;
10435 /* Install an asynchronous timer that processes Xt timeout events
10436 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10437 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10438 function whenever these variables are set. This is necessary
10439 because some widget sets use timeouts internally, for example the
10440 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10441 processed, these widgets don't behave normally. */
10443 void
10444 x_activate_timeout_atimer (void)
10446 BLOCK_INPUT;
10447 if (!x_timeout_atimer_activated_flag)
10449 EMACS_TIME interval;
10451 EMACS_SET_SECS_USECS (interval, 0, 100000);
10452 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10453 x_timeout_atimer_activated_flag = 1;
10455 UNBLOCK_INPUT;
10458 #endif /* USE_X_TOOLKIT */
10461 /* Set up use of X before we make the first connection. */
10463 extern frame_parm_handler x_frame_parm_handlers[];
10465 static struct redisplay_interface x_redisplay_interface =
10467 x_frame_parm_handlers,
10468 x_produce_glyphs,
10469 x_write_glyphs,
10470 x_insert_glyphs,
10471 x_clear_end_of_line,
10472 x_scroll_run,
10473 x_after_update_window_line,
10474 x_update_window_begin,
10475 x_update_window_end,
10476 x_cursor_to,
10477 x_flush,
10478 #ifdef XFlush
10479 x_flush,
10480 #else
10481 0, /* flush_display_optional */
10482 #endif
10483 x_clear_window_mouse_face,
10484 x_get_glyph_overhangs,
10485 x_fix_overlapping_area,
10486 x_draw_fringe_bitmap,
10487 0, /* define_fringe_bitmap */
10488 0, /* destroy_fringe_bitmap */
10489 x_compute_glyph_string_overhangs,
10490 x_draw_glyph_string,
10491 x_define_frame_cursor,
10492 x_clear_frame_area,
10493 x_draw_window_cursor,
10494 x_draw_vertical_window_border,
10495 x_shift_glyphs_for_insert
10499 /* This function is called when the last frame on a display is deleted. */
10500 void
10501 x_delete_terminal (struct terminal *terminal)
10503 struct x_display_info *dpyinfo = terminal->display_info.x;
10505 /* Protect against recursive calls. delete_frame in
10506 delete_terminal calls us back when it deletes our last frame. */
10507 if (!terminal->name)
10508 return;
10510 BLOCK_INPUT;
10511 #ifdef HAVE_X_I18N
10512 /* We must close our connection to the XIM server before closing the
10513 X display. */
10514 if (dpyinfo->xim)
10515 xim_close_dpy (dpyinfo);
10516 #endif
10518 /* If called from x_connection_closed, the display may already be closed
10519 and dpyinfo->display was set to 0 to indicate that. */
10520 if (dpyinfo->display)
10522 x_destroy_all_bitmaps (dpyinfo);
10523 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10525 /* Whether or not XCloseDisplay destroys the associated resource
10526 database depends on the version of libX11. To avoid both
10527 crash and memory leak, we dissociate the database from the
10528 display and then destroy dpyinfo->xrdb ourselves.
10530 Unfortunately, the above strategy does not work in some
10531 situations due to a bug in newer versions of libX11: because
10532 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10533 dpy->db is NULL, XCloseDisplay destroys the associated
10534 database whereas it has not been created by XGetDefault
10535 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10536 don't destroy the database here in order to avoid the crash
10537 in the above situations for now, though that may cause memory
10538 leaks in other situations. */
10539 #if 0
10540 #ifdef HAVE_XRMSETDATABASE
10541 XrmSetDatabase (dpyinfo->display, NULL);
10542 #else
10543 dpyinfo->display->db = NULL;
10544 #endif
10545 /* We used to call XrmDestroyDatabase from x_delete_display, but
10546 some older versions of libX11 crash if we call it after
10547 closing all the displays. */
10548 XrmDestroyDatabase (dpyinfo->xrdb);
10549 #endif
10551 #ifdef USE_GTK
10552 xg_display_close (dpyinfo->display);
10553 #else
10554 #ifdef USE_X_TOOLKIT
10555 XtCloseDisplay (dpyinfo->display);
10556 #else
10557 XCloseDisplay (dpyinfo->display);
10558 #endif
10559 #endif /* ! USE_GTK */
10562 /* Mark as dead. */
10563 dpyinfo->display = NULL;
10564 x_delete_display (dpyinfo);
10565 UNBLOCK_INPUT;
10568 /* Create a struct terminal, initialize it with the X11 specific
10569 functions and make DISPLAY->TERMINAL point to it. */
10571 static struct terminal *
10572 x_create_terminal (struct x_display_info *dpyinfo)
10574 struct terminal *terminal;
10576 terminal = create_terminal ();
10578 terminal->type = output_x_window;
10579 terminal->display_info.x = dpyinfo;
10580 dpyinfo->terminal = terminal;
10582 /* kboard is initialized in x_term_init. */
10584 terminal->clear_frame_hook = x_clear_frame;
10585 terminal->ins_del_lines_hook = x_ins_del_lines;
10586 terminal->delete_glyphs_hook = x_delete_glyphs;
10587 terminal->ring_bell_hook = XTring_bell;
10588 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10589 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10590 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10591 terminal->update_begin_hook = x_update_begin;
10592 terminal->update_end_hook = x_update_end;
10593 terminal->set_terminal_window_hook = XTset_terminal_window;
10594 terminal->read_socket_hook = XTread_socket;
10595 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10596 terminal->mouse_position_hook = XTmouse_position;
10597 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10598 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10599 terminal->fullscreen_hook = XTfullscreen_hook;
10600 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10601 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10602 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10603 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10605 terminal->delete_frame_hook = x_destroy_window;
10606 terminal->delete_terminal_hook = x_delete_terminal;
10608 terminal->rif = &x_redisplay_interface;
10609 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10610 terminal->char_ins_del_ok = 1;
10611 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10612 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10613 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10614 off the bottom. */
10616 return terminal;
10619 void
10620 x_initialize (void)
10622 baud_rate = 19200;
10624 x_noop_count = 0;
10625 last_tool_bar_item = -1;
10626 any_help_event_p = 0;
10627 ignore_next_mouse_click_timeout = 0;
10629 #ifdef USE_GTK
10630 current_count = -1;
10631 #endif
10633 /* Try to use interrupt input; if we can't, then start polling. */
10634 Fset_input_interrupt_mode (Qt);
10636 #ifdef USE_X_TOOLKIT
10637 XtToolkitInitialize ();
10639 Xt_app_con = XtCreateApplicationContext ();
10641 /* Register a converter from strings to pixels, which uses
10642 Emacs' color allocation infrastructure. */
10643 XtAppSetTypeConverter (Xt_app_con,
10644 XtRString, XtRPixel, cvt_string_to_pixel,
10645 cvt_string_to_pixel_args,
10646 XtNumber (cvt_string_to_pixel_args),
10647 XtCacheByDisplay, cvt_pixel_dtor);
10649 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10650 #endif
10652 #ifdef USE_TOOLKIT_SCROLL_BARS
10653 #ifndef USE_GTK
10654 xaw3d_arrow_scroll = False;
10655 xaw3d_pick_top = True;
10656 #endif
10657 #endif
10659 pending_autoraise_frame = 0;
10660 pending_event_wait.f = 0;
10661 pending_event_wait.eventtype = 0;
10663 /* Note that there is no real way portable across R3/R4 to get the
10664 original error handler. */
10665 XSetErrorHandler (x_error_handler);
10666 XSetIOErrorHandler (x_io_error_quitter);
10668 signal (SIGPIPE, x_connection_signal);
10670 xgselect_initialize ();
10674 void
10675 syms_of_xterm (void)
10677 x_error_message = NULL;
10679 staticpro (&x_display_name_list);
10680 x_display_name_list = Qnil;
10682 staticpro (&last_mouse_scroll_bar);
10683 last_mouse_scroll_bar = Qnil;
10685 staticpro (&Qvendor_specific_keysyms);
10686 Qvendor_specific_keysyms = intern_c_string ("vendor-specific-keysyms");
10688 staticpro (&Qlatin_1);
10689 Qlatin_1 = intern_c_string ("latin-1");
10691 staticpro (&last_mouse_press_frame);
10692 last_mouse_press_frame = Qnil;
10694 #ifdef USE_GTK
10695 xg_default_icon_file = make_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10696 staticpro (&xg_default_icon_file);
10698 Qx_gtk_map_stock = intern_c_string ("x-gtk-map-stock");
10699 staticpro (&Qx_gtk_map_stock);
10700 #endif
10702 DEFVAR_BOOL ("x-use-underline-position-properties",
10703 x_use_underline_position_properties,
10704 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10705 A value of nil means ignore them. If you encounter fonts with bogus
10706 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10707 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10708 to override the font's UNDERLINE_POSITION for small font display
10709 sizes. */);
10710 x_use_underline_position_properties = 1;
10712 DEFVAR_BOOL ("x-underline-at-descent-line",
10713 x_underline_at_descent_line,
10714 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10715 A value of nil means to draw the underline according to the value of the
10716 variable `x-use-underline-position-properties', which is usually at the
10717 baseline level. The default value is nil. */);
10718 x_underline_at_descent_line = 0;
10720 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10721 x_mouse_click_focus_ignore_position,
10722 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10723 This variable is only used when the window manager requires that you
10724 click on a frame to select it (give it focus). In that case, a value
10725 of nil, means that the selected window and cursor position changes to
10726 reflect the mouse click position, while a non-nil value means that the
10727 selected window or cursor position is preserved. */);
10728 x_mouse_click_focus_ignore_position = 0;
10730 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10731 doc: /* Which toolkit scroll bars Emacs uses, if any.
10732 A value of nil means Emacs doesn't use toolkit scroll bars.
10733 With the X Window system, the value is a symbol describing the
10734 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10735 With MS Windows, the value is t. */);
10736 #ifdef USE_TOOLKIT_SCROLL_BARS
10737 #ifdef USE_MOTIF
10738 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10739 #elif defined HAVE_XAW3D
10740 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10741 #elif USE_GTK
10742 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10743 #else
10744 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10745 #endif
10746 #else
10747 Vx_toolkit_scroll_bars = Qnil;
10748 #endif
10750 staticpro (&last_mouse_motion_frame);
10751 last_mouse_motion_frame = Qnil;
10753 Qmodifier_value = intern_c_string ("modifier-value");
10754 Qalt = intern_c_string ("alt");
10755 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10756 Qhyper = intern_c_string ("hyper");
10757 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10758 Qmeta = intern_c_string ("meta");
10759 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10760 Qsuper = intern_c_string ("super");
10761 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10763 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10764 doc: /* Which keys Emacs uses for the alt modifier.
10765 This should be one of the symbols `alt', `hyper', `meta', `super'.
10766 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10767 is nil, which is the same as `alt'. */);
10768 Vx_alt_keysym = Qnil;
10770 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10771 doc: /* Which keys Emacs uses for the hyper modifier.
10772 This should be one of the symbols `alt', `hyper', `meta', `super'.
10773 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10774 default is nil, which is the same as `hyper'. */);
10775 Vx_hyper_keysym = Qnil;
10777 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10778 doc: /* Which keys Emacs uses for the meta modifier.
10779 This should be one of the symbols `alt', `hyper', `meta', `super'.
10780 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10781 default is nil, which is the same as `meta'. */);
10782 Vx_meta_keysym = Qnil;
10784 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10785 doc: /* Which keys Emacs uses for the super modifier.
10786 This should be one of the symbols `alt', `hyper', `meta', `super'.
10787 For example, `super' means use the Super_L and Super_R keysyms. The
10788 default is nil, which is the same as `super'. */);
10789 Vx_super_keysym = Qnil;
10791 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10792 doc: /* Hash table of character codes indexed by X keysym codes. */);
10793 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10794 make_float (DEFAULT_REHASH_SIZE),
10795 make_float (DEFAULT_REHASH_THRESHOLD),
10796 Qnil, Qnil, Qnil);
10799 #endif /* HAVE_X_WINDOWS */