Fix last ChangeLog entry.
[emacs.git] / src / xterm.c
blobfc61fb248ef8bf9e63f4881e836d6051754ef199
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993-2014 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 <stdio.h>
26 #include "lisp.h"
27 #include "blockinput.h"
28 #include "syssignal.h"
30 /* This may include sys/types.h, and that somehow loses
31 if this is not done before the other system files. */
32 #include "xterm.h"
33 #include <X11/cursorfont.h>
35 /* Load sys/types.h if not already loaded.
36 In some systems loading it twice is suicidal. */
37 #ifndef makedev
38 #include <sys/types.h>
39 #endif /* makedev */
41 #include <sys/ioctl.h>
43 #include "systime.h"
45 #include <fcntl.h>
46 #include <errno.h>
47 #include <sys/stat.h>
48 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
49 /* #include <sys/param.h> */
51 #include "charset.h"
52 #include "character.h"
53 #include "coding.h"
54 #include "frame.h"
55 #include "dispextern.h"
56 #include "fontset.h"
57 #include "termhooks.h"
58 #include "termopts.h"
59 #include "termchar.h"
60 #include "emacs-icon.h"
61 #include "disptab.h"
62 #include "buffer.h"
63 #include "window.h"
64 #include "keyboard.h"
65 #include "intervals.h"
66 #include "process.h"
67 #include "atimer.h"
68 #include "keymap.h"
69 #include "font.h"
70 #include "xsettings.h"
71 #include "xgselect.h"
72 #include "sysselect.h"
74 #ifdef USE_X_TOOLKIT
75 #include <X11/Shell.h>
76 #endif
78 #include <unistd.h>
80 #ifdef USE_GTK
81 #include "gtkutil.h"
82 #ifdef HAVE_GTK3
83 #include <X11/Xproto.h>
84 #endif
85 #endif
87 #if defined (USE_LUCID) || defined (USE_MOTIF)
88 #include "../lwlib/xlwmenu.h"
89 #endif
91 #ifdef USE_X_TOOLKIT
92 #if !defined (NO_EDITRES)
93 #define HACK_EDITRES
94 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
95 #endif /* not NO_EDITRES */
97 /* Include toolkit specific headers for the scroll bar widget. */
99 #ifdef USE_TOOLKIT_SCROLL_BARS
100 #if defined USE_MOTIF
101 #include <Xm/Xm.h> /* For LESSTIF_VERSION */
102 #include <Xm/ScrollBar.h>
103 #else /* !USE_MOTIF i.e. use Xaw */
105 #ifdef HAVE_XAW3D
106 #include <X11/Xaw3d/Simple.h>
107 #include <X11/Xaw3d/Scrollbar.h>
108 #include <X11/Xaw3d/ThreeD.h>
109 #else /* !HAVE_XAW3D */
110 #include <X11/Xaw/Simple.h>
111 #include <X11/Xaw/Scrollbar.h>
112 #endif /* !HAVE_XAW3D */
113 #ifndef XtNpickTop
114 #define XtNpickTop "pickTop"
115 #endif /* !XtNpickTop */
116 #endif /* !USE_MOTIF */
117 #endif /* USE_TOOLKIT_SCROLL_BARS */
119 #endif /* USE_X_TOOLKIT */
121 #ifdef USE_X_TOOLKIT
122 #include "widget.h"
123 #ifndef XtNinitialState
124 #define XtNinitialState "initialState"
125 #endif
126 #endif
128 #include "bitmaps/gray.xbm"
130 #ifdef HAVE_XKB
131 #include <X11/XKBlib.h>
132 #endif
134 /* Default to using XIM if available. */
135 #ifdef USE_XIM
136 bool use_xim = true;
137 #else
138 bool use_xim = false; /* configure --without-xim */
139 #endif
141 /* Non-zero means that a HELP_EVENT has been generated since Emacs
142 start. */
144 static bool any_help_event_p;
146 /* This is a chain of structures for all the X displays currently in
147 use. */
149 struct x_display_info *x_display_list;
151 #ifdef USE_X_TOOLKIT
153 /* The application context for Xt use. */
154 XtAppContext Xt_app_con;
155 static String Xt_default_resources[] = {0};
157 /* Non-zero means user is interacting with a toolkit scroll bar. */
158 static bool toolkit_scroll_bar_interaction;
160 #endif /* USE_X_TOOLKIT */
162 /* Non-zero timeout value means ignore next mouse click if it arrives
163 before that timeout elapses (i.e. as part of the same sequence of
164 events resulting from clicking on a frame to select it). */
166 static Time ignore_next_mouse_click_timeout;
168 /* Used locally within XTread_socket. */
170 static int x_noop_count;
172 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
174 static Lisp_Object Qvendor_specific_keysyms;
175 static Lisp_Object Qlatin_1;
177 #ifdef USE_GTK
178 /* The name of the Emacs icon file. */
179 static Lisp_Object xg_default_icon_file;
181 /* Used in gtkutil.c. */
182 Lisp_Object Qx_gtk_map_stock;
183 #endif
185 /* Some functions take this as char *, not const char *. */
186 static char emacs_class[] = EMACS_CLASS;
188 enum xembed_info
190 XEMBED_MAPPED = 1 << 0
193 enum xembed_message
195 XEMBED_EMBEDDED_NOTIFY = 0,
196 XEMBED_WINDOW_ACTIVATE = 1,
197 XEMBED_WINDOW_DEACTIVATE = 2,
198 XEMBED_REQUEST_FOCUS = 3,
199 XEMBED_FOCUS_IN = 4,
200 XEMBED_FOCUS_OUT = 5,
201 XEMBED_FOCUS_NEXT = 6,
202 XEMBED_FOCUS_PREV = 7,
204 XEMBED_MODALITY_ON = 10,
205 XEMBED_MODALITY_OFF = 11,
206 XEMBED_REGISTER_ACCELERATOR = 12,
207 XEMBED_UNREGISTER_ACCELERATOR = 13,
208 XEMBED_ACTIVATE_ACCELERATOR = 14
211 static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
212 static void x_set_window_size_1 (struct frame *, int, int, int, bool);
213 static void x_raise_frame (struct frame *);
214 static void x_lower_frame (struct frame *);
215 static const XColor *x_color_cells (Display *, int *);
216 static int x_io_error_quitter (Display *);
217 static struct terminal *x_create_terminal (struct x_display_info *);
218 void x_delete_terminal (struct terminal *);
219 static void x_update_end (struct frame *);
220 static void XTframe_up_to_date (struct frame *);
221 static void x_clear_frame (struct frame *);
222 static _Noreturn void x_ins_del_lines (struct frame *, int, int);
223 static void frame_highlight (struct frame *);
224 static void frame_unhighlight (struct frame *);
225 static void x_new_focus_frame (struct x_display_info *, struct frame *);
226 static void x_focus_changed (int, int, struct x_display_info *,
227 struct frame *, struct input_event *);
228 static void XTframe_rehighlight (struct frame *);
229 static void x_frame_rehighlight (struct x_display_info *);
230 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
231 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
232 enum text_cursor_kinds);
234 static void x_clip_to_row (struct window *, struct glyph_row *,
235 enum glyph_row_area, GC);
236 static void x_flush (struct frame *f);
237 static void x_update_begin (struct frame *);
238 static void x_update_window_begin (struct window *);
239 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
240 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
241 enum scroll_bar_part *,
242 Lisp_Object *, Lisp_Object *,
243 Time *);
244 static int x_handle_net_wm_state (struct frame *, const XPropertyEvent *);
245 static void x_check_fullscreen (struct frame *);
246 static void x_check_expected_move (struct frame *, int, int);
247 static void x_sync_with_move (struct frame *, int, int, int);
248 static int handle_one_xevent (struct x_display_info *,
249 const XEvent *, int *,
250 struct input_event *);
251 #if ! (defined USE_X_TOOLKIT || defined USE_MOTIF)
252 static int x_dispatch_event (XEvent *, Display *);
253 #endif
254 /* Don't declare this _Noreturn because we want no
255 interference with debugging failing X calls. */
256 static void x_connection_closed (Display *, const char *);
257 static void x_wm_set_window_state (struct frame *, int);
258 static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
259 static void x_initialize (void);
262 /* Flush display of frame F. */
264 static void
265 x_flush (struct frame *f)
267 eassert (f && FRAME_X_P (f));
268 /* Don't call XFlush when it is not safe to redisplay; the X
269 connection may be broken. */
270 if (!NILP (Vinhibit_redisplay))
271 return;
273 block_input ();
274 XFlush (FRAME_X_DISPLAY (f));
275 unblock_input ();
279 /* Remove calls to XFlush by defining XFlush to an empty replacement.
280 Calls to XFlush should be unnecessary because the X output buffer
281 is flushed automatically as needed by calls to XPending,
282 XNextEvent, or XWindowEvent according to the XFlush man page.
283 XTread_socket calls XPending. Removing XFlush improves
284 performance. */
286 #define XFlush(DISPLAY) (void) 0
289 /***********************************************************************
290 Debugging
291 ***********************************************************************/
293 #if 0
295 /* This is a function useful for recording debugging information about
296 the sequence of occurrences in this file. */
298 struct record
300 char *locus;
301 int type;
304 struct record event_record[100];
306 int event_record_index;
308 void
309 record_event (char *locus, int type)
311 if (event_record_index == sizeof (event_record) / sizeof (struct record))
312 event_record_index = 0;
314 event_record[event_record_index].locus = locus;
315 event_record[event_record_index].type = type;
316 event_record_index++;
319 #endif /* 0 */
323 /* Return the struct x_display_info corresponding to DPY. */
325 struct x_display_info *
326 x_display_info_for_display (Display *dpy)
328 struct x_display_info *dpyinfo;
330 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
331 if (dpyinfo->display == dpy)
332 return dpyinfo;
334 return 0;
337 static Window
338 x_find_topmost_parent (struct frame *f)
340 struct x_output *x = f->output_data.x;
341 Window win = None, wi = x->parent_desc;
342 Display *dpy = FRAME_X_DISPLAY (f);
344 while (wi != FRAME_DISPLAY_INFO (f)->root_window)
346 Window root;
347 Window *children;
348 unsigned int nchildren;
350 win = wi;
351 XQueryTree (dpy, win, &root, &wi, &children, &nchildren);
352 XFree (children);
355 return win;
358 #define OPAQUE 0xffffffff
360 void
361 x_set_frame_alpha (struct frame *f)
363 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
364 Display *dpy = FRAME_X_DISPLAY (f);
365 Window win = FRAME_OUTER_WINDOW (f);
366 double alpha = 1.0;
367 double alpha_min = 1.0;
368 unsigned long opac;
369 Window parent;
371 if (dpyinfo->x_highlight_frame == f)
372 alpha = f->alpha[0];
373 else
374 alpha = f->alpha[1];
376 if (FLOATP (Vframe_alpha_lower_limit))
377 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
378 else if (INTEGERP (Vframe_alpha_lower_limit))
379 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
381 if (alpha < 0.0)
382 return;
383 else if (alpha > 1.0)
384 alpha = 1.0;
385 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
386 alpha = alpha_min;
388 opac = alpha * OPAQUE;
390 x_catch_errors (dpy);
392 /* If there is a parent from the window manager, put the property there
393 also, to work around broken window managers that fail to do that.
394 Do this unconditionally as this function is called on reparent when
395 alpha has not changed on the frame. */
397 parent = x_find_topmost_parent (f);
398 if (parent != None)
399 XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
400 XA_CARDINAL, 32, PropModeReplace,
401 (unsigned char *) &opac, 1L);
403 /* return unless necessary */
405 unsigned char *data;
406 Atom actual;
407 int rc, format;
408 unsigned long n, left;
410 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
411 0L, 1L, False, XA_CARDINAL,
412 &actual, &format, &n, &left,
413 &data);
415 if (rc == Success && actual != None)
417 unsigned long value = *(unsigned long *)data;
418 XFree (data);
419 if (value == opac)
421 x_uncatch_errors ();
422 return;
427 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
428 XA_CARDINAL, 32, PropModeReplace,
429 (unsigned char *) &opac, 1L);
430 x_uncatch_errors ();
434 x_display_pixel_height (struct x_display_info *dpyinfo)
436 return HeightOfScreen (dpyinfo->screen);
440 x_display_pixel_width (struct x_display_info *dpyinfo)
442 return WidthOfScreen (dpyinfo->screen);
446 /***********************************************************************
447 Starting and ending an update
448 ***********************************************************************/
450 /* Start an update of frame F. This function is installed as a hook
451 for update_begin, i.e. it is called when update_begin is called.
452 This function is called prior to calls to x_update_window_begin for
453 each window being updated. Currently, there is nothing to do here
454 because all interesting stuff is done on a window basis. */
456 static void
457 x_update_begin (struct frame *f)
459 /* Nothing to do. */
463 /* Start update of window W. */
465 static void
466 x_update_window_begin (struct window *w)
468 struct frame *f = XFRAME (WINDOW_FRAME (w));
469 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
471 w->output_cursor = w->cursor;
473 block_input ();
475 if (f == hlinfo->mouse_face_mouse_frame)
477 /* Don't do highlighting for mouse motion during the update. */
478 hlinfo->mouse_face_defer = 1;
480 /* If F needs to be redrawn, simply forget about any prior mouse
481 highlighting. */
482 if (FRAME_GARBAGED_P (f))
483 hlinfo->mouse_face_window = Qnil;
486 unblock_input ();
490 /* Draw a vertical window border from (x,y0) to (x,y1) */
492 static void
493 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
495 struct frame *f = XFRAME (WINDOW_FRAME (w));
496 struct face *face;
498 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
499 if (face)
500 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
501 face->foreground);
503 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
504 f->output_data.x->normal_gc, x, y0, x, y1);
507 /* Draw a window divider from (x0,y0) to (x1,y1) */
509 static void
510 x_draw_window_divider (struct window *w, int x0, int x1, int y0, int y1)
512 struct frame *f = XFRAME (WINDOW_FRAME (w));
513 struct face *face = FACE_FROM_ID (f, WINDOW_DIVIDER_FACE_ID);
514 struct face *face_first = FACE_FROM_ID (f, WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID);
515 struct face *face_last = FACE_FROM_ID (f, WINDOW_DIVIDER_LAST_PIXEL_FACE_ID);
516 unsigned long color = face ? face->foreground : FRAME_FOREGROUND_PIXEL (f);
517 unsigned long color_first = (face_first
518 ? face_first->foreground
519 : FRAME_FOREGROUND_PIXEL (f));
520 unsigned long color_last = (face_last
521 ? face_last->foreground
522 : FRAME_FOREGROUND_PIXEL (f));
523 Display *display = FRAME_X_DISPLAY (f);
524 Window window = FRAME_X_WINDOW (f);
526 if (y1 - y0 > x1 - x0 && x1 - x0 > 2)
527 /* Vertical. */
529 XSetForeground (display, f->output_data.x->normal_gc, color_first);
530 XFillRectangle (display, window, f->output_data.x->normal_gc,
531 x0, y0, 1, y1 - y0);
532 XSetForeground (display, f->output_data.x->normal_gc, color);
533 XFillRectangle (display, window, f->output_data.x->normal_gc,
534 x0 + 1, y0, x1 - x0 - 2, y1 - y0);
535 XSetForeground (display, f->output_data.x->normal_gc, color_last);
536 XFillRectangle (display, window, f->output_data.x->normal_gc,
537 x1 - 1, y0, 1, y1 - y0);
539 else if (x1 - x0 > y1 - y0 && y1 - y0 > 3)
540 /* Horizontal. */
542 XSetForeground (display, f->output_data.x->normal_gc, color_first);
543 XFillRectangle (display, window, f->output_data.x->normal_gc,
544 x0, y0, x1 - x0, 1);
545 XSetForeground (display, f->output_data.x->normal_gc, color);
546 XFillRectangle (display, window, f->output_data.x->normal_gc,
547 x0, y0 + 1, x1 - x0, y1 - y0 - 2);
548 XSetForeground (display, f->output_data.x->normal_gc, color_last);
549 XFillRectangle (display, window, f->output_data.x->normal_gc,
550 x0, y1 - 1, x1 - x0, 1);
552 else
554 XSetForeground (display, f->output_data.x->normal_gc, color);
555 XFillRectangle (display, window, f->output_data.x->normal_gc,
556 x0, y0, x1 - x0, y1 - y0);
560 /* End update of window W.
562 Draw vertical borders between horizontally adjacent windows, and
563 display W's cursor if CURSOR_ON_P is non-zero.
565 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
566 glyphs in mouse-face were overwritten. In that case we have to
567 make sure that the mouse-highlight is properly redrawn.
569 W may be a menu bar pseudo-window in case we don't have X toolkit
570 support. Such windows don't have a cursor, so don't display it
571 here. */
573 static void
574 x_update_window_end (struct window *w, bool cursor_on_p,
575 bool mouse_face_overwritten_p)
577 if (!w->pseudo_window_p)
579 block_input ();
581 if (cursor_on_p)
582 display_and_set_cursor (w, 1,
583 w->output_cursor.hpos, w->output_cursor.vpos,
584 w->output_cursor.x, w->output_cursor.y);
586 if (draw_window_fringes (w, 1))
588 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
589 x_draw_right_divider (w);
590 else
591 x_draw_vertical_border (w);
594 unblock_input ();
597 /* If a row with mouse-face was overwritten, arrange for
598 XTframe_up_to_date to redisplay the mouse highlight. */
599 if (mouse_face_overwritten_p)
600 reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
604 /* End update of frame F. This function is installed as a hook in
605 update_end. */
607 static void
608 x_update_end (struct frame *f)
610 /* Mouse highlight may be displayed again. */
611 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
613 #ifndef XFlush
614 block_input ();
615 XFlush (FRAME_X_DISPLAY (f));
616 unblock_input ();
617 #endif
621 /* This function is called from various places in xdisp.c
622 whenever a complete update has been performed. */
624 static void
625 XTframe_up_to_date (struct frame *f)
627 if (FRAME_X_P (f))
628 FRAME_MOUSE_UPDATE (f);
632 /* Clear under internal border if any for non-toolkit builds. */
635 #if !defined USE_X_TOOLKIT && !defined USE_GTK
636 void
637 x_clear_under_internal_border (struct frame *f)
639 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
641 Display *display = FRAME_X_DISPLAY (f);
642 Window window = FRAME_X_WINDOW (f);
643 int border = FRAME_INTERNAL_BORDER_WIDTH (f);
644 int width = FRAME_PIXEL_WIDTH (f);
645 int height = FRAME_PIXEL_HEIGHT (f);
646 int margin = FRAME_TOP_MARGIN_HEIGHT (f);
648 block_input ();
649 x_clear_area (display, window, 0, 0, border, height);
650 x_clear_area (display, window, 0, margin, width, border);
651 x_clear_area (display, window, width - border, 0, border, height);
652 x_clear_area (display, window, 0, height - border, width, border);
653 unblock_input ();
656 #endif
658 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
659 arrow bitmaps, or clear the fringes if no bitmaps are required
660 before DESIRED_ROW is made current. This function is called from
661 update_window_line only if it is known that there are differences
662 between bitmaps to be drawn between current row and DESIRED_ROW. */
664 static void
665 x_after_update_window_line (struct window *w, struct glyph_row *desired_row)
667 eassert (w);
669 if (!desired_row->mode_line_p && !w->pseudo_window_p)
670 desired_row->redraw_fringe_bitmaps_p = 1;
672 #ifdef USE_X_TOOLKIT
673 /* When a window has disappeared, make sure that no rest of
674 full-width rows stays visible in the internal border. Could
675 check here if updated window is the leftmost/rightmost window,
676 but I guess it's not worth doing since vertically split windows
677 are almost never used, internal border is rarely set, and the
678 overhead is very small. */
680 struct frame *f;
681 int width, height;
683 if (windows_or_buffers_changed
684 && desired_row->full_width_p
685 && (f = XFRAME (w->frame),
686 width = FRAME_INTERNAL_BORDER_WIDTH (f),
687 width != 0)
688 && (height = desired_row->visible_height,
689 height > 0))
691 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
693 block_input ();
694 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
695 0, y, width, height);
696 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
697 FRAME_PIXEL_WIDTH (f) - width,
698 y, width, height);
699 unblock_input ();
702 #endif
705 static void
706 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
708 struct frame *f = XFRAME (WINDOW_FRAME (w));
709 Display *display = FRAME_X_DISPLAY (f);
710 Window window = FRAME_X_WINDOW (f);
711 GC gc = f->output_data.x->normal_gc;
712 struct face *face = p->face;
714 /* Must clip because of partially visible lines. */
715 x_clip_to_row (w, row, ANY_AREA, gc);
717 if (p->bx >= 0 && !p->overlay_p)
719 /* In case the same realized face is used for fringes and
720 for something displayed in the text (e.g. face `region' on
721 mono-displays, the fill style may have been changed to
722 FillSolid in x_draw_glyph_string_background. */
723 if (face->stipple)
724 XSetFillStyle (display, face->gc, FillOpaqueStippled);
725 else
726 XSetForeground (display, face->gc, face->background);
728 XFillRectangle (display, window, face->gc,
729 p->bx, p->by, p->nx, p->ny);
731 if (!face->stipple)
732 XSetForeground (display, face->gc, face->foreground);
735 if (p->which)
737 char *bits;
738 Pixmap pixmap, clipmask = (Pixmap) 0;
739 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
740 XGCValues gcv;
742 if (p->wd > 8)
743 bits = (char *) (p->bits + p->dh);
744 else
745 bits = (char *) p->bits + p->dh;
747 /* Draw the bitmap. I believe these small pixmaps can be cached
748 by the server. */
749 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
750 (p->cursor_p
751 ? (p->overlay_p ? face->background
752 : f->output_data.x->cursor_pixel)
753 : face->foreground),
754 face->background, depth);
756 if (p->overlay_p)
758 clipmask = XCreatePixmapFromBitmapData (display,
759 FRAME_DISPLAY_INFO (f)->root_window,
760 bits, p->wd, p->h,
761 1, 0, 1);
762 gcv.clip_mask = clipmask;
763 gcv.clip_x_origin = p->x;
764 gcv.clip_y_origin = p->y;
765 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
768 XCopyArea (display, pixmap, window, gc, 0, 0,
769 p->wd, p->h, p->x, p->y);
770 XFreePixmap (display, pixmap);
772 if (p->overlay_p)
774 gcv.clip_mask = (Pixmap) 0;
775 XChangeGC (display, gc, GCClipMask, &gcv);
776 XFreePixmap (display, clipmask);
780 XSetClipMask (display, gc, None);
783 /***********************************************************************
784 Glyph display
785 ***********************************************************************/
789 static void x_set_glyph_string_clipping (struct glyph_string *);
790 static void x_set_glyph_string_gc (struct glyph_string *);
791 static void x_draw_glyph_string_foreground (struct glyph_string *);
792 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
793 static void x_draw_glyph_string_box (struct glyph_string *);
794 static void x_draw_glyph_string (struct glyph_string *);
795 static _Noreturn void x_delete_glyphs (struct frame *, int);
796 static void x_compute_glyph_string_overhangs (struct glyph_string *);
797 static void x_set_cursor_gc (struct glyph_string *);
798 static void x_set_mode_line_face_gc (struct glyph_string *);
799 static void x_set_mouse_face_gc (struct glyph_string *);
800 static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
801 unsigned long *, double, int);
802 static void x_setup_relief_color (struct frame *, struct relief *,
803 double, int, unsigned long);
804 static void x_setup_relief_colors (struct glyph_string *);
805 static void x_draw_image_glyph_string (struct glyph_string *);
806 static void x_draw_image_relief (struct glyph_string *);
807 static void x_draw_image_foreground (struct glyph_string *);
808 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
809 static void x_clear_glyph_string_rect (struct glyph_string *, int,
810 int, int, int);
811 static void x_draw_relief_rect (struct frame *, int, int, int, int,
812 int, int, int, int, int, int,
813 XRectangle *);
814 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
815 int, int, int, XRectangle *);
816 static void x_scroll_bar_clear (struct frame *);
818 #ifdef GLYPH_DEBUG
819 static void x_check_font (struct frame *, struct font *);
820 #endif
823 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
824 face. */
826 static void
827 x_set_cursor_gc (struct glyph_string *s)
829 if (s->font == FRAME_FONT (s->f)
830 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
831 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
832 && !s->cmp)
833 s->gc = s->f->output_data.x->cursor_gc;
834 else
836 /* Cursor on non-default face: must merge. */
837 XGCValues xgcv;
838 unsigned long mask;
840 xgcv.background = s->f->output_data.x->cursor_pixel;
841 xgcv.foreground = s->face->background;
843 /* If the glyph would be invisible, try a different foreground. */
844 if (xgcv.foreground == xgcv.background)
845 xgcv.foreground = s->face->foreground;
846 if (xgcv.foreground == xgcv.background)
847 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
848 if (xgcv.foreground == xgcv.background)
849 xgcv.foreground = s->face->foreground;
851 /* Make sure the cursor is distinct from text in this face. */
852 if (xgcv.background == s->face->background
853 && xgcv.foreground == s->face->foreground)
855 xgcv.background = s->face->foreground;
856 xgcv.foreground = s->face->background;
859 IF_DEBUG (x_check_font (s->f, s->font));
860 xgcv.graphics_exposures = False;
861 mask = GCForeground | GCBackground | GCGraphicsExposures;
863 if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
864 XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
865 mask, &xgcv);
866 else
867 FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
868 = XCreateGC (s->display, s->window, mask, &xgcv);
870 s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
875 /* Set up S->gc of glyph string S for drawing text in mouse face. */
877 static void
878 x_set_mouse_face_gc (struct glyph_string *s)
880 int face_id;
881 struct face *face;
883 /* What face has to be used last for the mouse face? */
884 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
885 face = FACE_FROM_ID (s->f, face_id);
886 if (face == NULL)
887 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
889 if (s->first_glyph->type == CHAR_GLYPH)
890 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
891 else
892 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
893 s->face = FACE_FROM_ID (s->f, face_id);
894 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
896 if (s->font == s->face->font)
897 s->gc = s->face->gc;
898 else
900 /* Otherwise construct scratch_cursor_gc with values from FACE
901 except for FONT. */
902 XGCValues xgcv;
903 unsigned long mask;
905 xgcv.background = s->face->background;
906 xgcv.foreground = s->face->foreground;
907 xgcv.graphics_exposures = False;
908 mask = GCForeground | GCBackground | GCGraphicsExposures;
910 if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
911 XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
912 mask, &xgcv);
913 else
914 FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
915 = XCreateGC (s->display, s->window, mask, &xgcv);
917 s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
920 eassert (s->gc != 0);
924 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
925 Faces to use in the mode line have already been computed when the
926 matrix was built, so there isn't much to do, here. */
928 static void
929 x_set_mode_line_face_gc (struct glyph_string *s)
931 s->gc = s->face->gc;
935 /* Set S->gc of glyph string S for drawing that glyph string. Set
936 S->stippled_p to a non-zero value if the face of S has a stipple
937 pattern. */
939 static void
940 x_set_glyph_string_gc (struct glyph_string *s)
942 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
944 if (s->hl == DRAW_NORMAL_TEXT)
946 s->gc = s->face->gc;
947 s->stippled_p = s->face->stipple != 0;
949 else if (s->hl == DRAW_INVERSE_VIDEO)
951 x_set_mode_line_face_gc (s);
952 s->stippled_p = s->face->stipple != 0;
954 else if (s->hl == DRAW_CURSOR)
956 x_set_cursor_gc (s);
957 s->stippled_p = 0;
959 else if (s->hl == DRAW_MOUSE_FACE)
961 x_set_mouse_face_gc (s);
962 s->stippled_p = s->face->stipple != 0;
964 else if (s->hl == DRAW_IMAGE_RAISED
965 || s->hl == DRAW_IMAGE_SUNKEN)
967 s->gc = s->face->gc;
968 s->stippled_p = s->face->stipple != 0;
970 else
972 s->gc = s->face->gc;
973 s->stippled_p = s->face->stipple != 0;
976 /* GC must have been set. */
977 eassert (s->gc != 0);
981 /* Set clipping for output of glyph string S. S may be part of a mode
982 line or menu if we don't have X toolkit support. */
984 static void
985 x_set_glyph_string_clipping (struct glyph_string *s)
987 XRectangle *r = s->clip;
988 int n = get_glyph_string_clip_rects (s, r, 2);
990 if (n > 0)
991 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
992 s->num_clips = n;
996 /* Set SRC's clipping for output of glyph string DST. This is called
997 when we are drawing DST's left_overhang or right_overhang only in
998 the area of SRC. */
1000 static void
1001 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1003 XRectangle r;
1005 r.x = src->x;
1006 r.width = src->width;
1007 r.y = src->y;
1008 r.height = src->height;
1009 dst->clip[0] = r;
1010 dst->num_clips = 1;
1011 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1015 /* RIF:
1016 Compute left and right overhang of glyph string S. */
1018 static void
1019 x_compute_glyph_string_overhangs (struct glyph_string *s)
1021 if (s->cmp == NULL
1022 && (s->first_glyph->type == CHAR_GLYPH
1023 || s->first_glyph->type == COMPOSITE_GLYPH))
1025 struct font_metrics metrics;
1027 if (s->first_glyph->type == CHAR_GLYPH)
1029 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1030 struct font *font = s->font;
1031 int i;
1033 for (i = 0; i < s->nchars; i++)
1034 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1035 font->driver->text_extents (font, code, s->nchars, &metrics);
1037 else
1039 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1041 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1043 s->right_overhang = (metrics.rbearing > metrics.width
1044 ? metrics.rbearing - metrics.width : 0);
1045 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1047 else if (s->cmp)
1049 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1050 s->left_overhang = - s->cmp->lbearing;
1055 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1057 static void
1058 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1060 XGCValues xgcv;
1061 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1062 XSetForeground (s->display, s->gc, xgcv.background);
1063 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1064 XSetForeground (s->display, s->gc, xgcv.foreground);
1068 /* Draw the background of glyph_string S. If S->background_filled_p
1069 is non-zero don't draw it. FORCE_P non-zero means draw the
1070 background even if it wouldn't be drawn normally. This is used
1071 when a string preceding S draws into the background of S, or S
1072 contains the first component of a composition. */
1074 static void
1075 x_draw_glyph_string_background (struct glyph_string *s, bool force_p)
1077 /* Nothing to do if background has already been drawn or if it
1078 shouldn't be drawn in the first place. */
1079 if (!s->background_filled_p)
1081 int box_line_width = max (s->face->box_line_width, 0);
1083 if (s->stippled_p)
1085 /* Fill background with a stipple pattern. */
1086 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1087 XFillRectangle (s->display, s->window, s->gc, s->x,
1088 s->y + box_line_width,
1089 s->background_width,
1090 s->height - 2 * box_line_width);
1091 XSetFillStyle (s->display, s->gc, FillSolid);
1092 s->background_filled_p = 1;
1094 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1095 || s->font_not_found_p
1096 || s->extends_to_end_of_line_p
1097 || force_p)
1099 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1100 s->background_width,
1101 s->height - 2 * box_line_width);
1102 s->background_filled_p = 1;
1108 /* Draw the foreground of glyph string S. */
1110 static void
1111 x_draw_glyph_string_foreground (struct glyph_string *s)
1113 int i, x;
1115 /* If first glyph of S has a left box line, start drawing the text
1116 of S to the right of that box line. */
1117 if (s->face->box != FACE_NO_BOX
1118 && s->first_glyph->left_box_line_p)
1119 x = s->x + eabs (s->face->box_line_width);
1120 else
1121 x = s->x;
1123 /* Draw characters of S as rectangles if S's font could not be
1124 loaded. */
1125 if (s->font_not_found_p)
1127 for (i = 0; i < s->nchars; ++i)
1129 struct glyph *g = s->first_glyph + i;
1130 XDrawRectangle (s->display, s->window,
1131 s->gc, x, s->y, g->pixel_width - 1,
1132 s->height - 1);
1133 x += g->pixel_width;
1136 else
1138 struct font *font = s->font;
1139 int boff = font->baseline_offset;
1140 int y;
1142 if (font->vertical_centering)
1143 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1145 y = s->ybase - boff;
1146 if (s->for_overlaps
1147 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1148 font->driver->draw (s, 0, s->nchars, x, y, 0);
1149 else
1150 font->driver->draw (s, 0, s->nchars, x, y, 1);
1151 if (s->face->overstrike)
1152 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1156 /* Draw the foreground of composite glyph string S. */
1158 static void
1159 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1161 int i, j, x;
1162 struct font *font = s->font;
1164 /* If first glyph of S has a left box line, start drawing the text
1165 of S to the right of that box line. */
1166 if (s->face && s->face->box != FACE_NO_BOX
1167 && s->first_glyph->left_box_line_p)
1168 x = s->x + eabs (s->face->box_line_width);
1169 else
1170 x = s->x;
1172 /* S is a glyph string for a composition. S->cmp_from is the index
1173 of the first character drawn for glyphs of this composition.
1174 S->cmp_from == 0 means we are drawing the very first character of
1175 this composition. */
1177 /* Draw a rectangle for the composition if the font for the very
1178 first character of the composition could not be loaded. */
1179 if (s->font_not_found_p)
1181 if (s->cmp_from == 0)
1182 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1183 s->width - 1, s->height - 1);
1185 else if (! s->first_glyph->u.cmp.automatic)
1187 int y = s->ybase;
1189 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1190 /* TAB in a composition means display glyphs with padding
1191 space on the left or right. */
1192 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1194 int xx = x + s->cmp->offsets[j * 2];
1195 int yy = y - s->cmp->offsets[j * 2 + 1];
1197 font->driver->draw (s, j, j + 1, xx, yy, 0);
1198 if (s->face->overstrike)
1199 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1202 else
1204 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1205 Lisp_Object glyph;
1206 int y = s->ybase;
1207 int width = 0;
1209 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1211 glyph = LGSTRING_GLYPH (gstring, i);
1212 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1213 width += LGLYPH_WIDTH (glyph);
1214 else
1216 int xoff, yoff, wadjust;
1218 if (j < i)
1220 font->driver->draw (s, j, i, x, y, 0);
1221 if (s->face->overstrike)
1222 font->driver->draw (s, j, i, x + 1, y, 0);
1223 x += width;
1225 xoff = LGLYPH_XOFF (glyph);
1226 yoff = LGLYPH_YOFF (glyph);
1227 wadjust = LGLYPH_WADJUST (glyph);
1228 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1229 if (s->face->overstrike)
1230 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1231 x += wadjust;
1232 j = i + 1;
1233 width = 0;
1236 if (j < i)
1238 font->driver->draw (s, j, i, x, y, 0);
1239 if (s->face->overstrike)
1240 font->driver->draw (s, j, i, x + 1, y, 0);
1246 /* Draw the foreground of glyph string S for glyphless characters. */
1248 static void
1249 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1251 struct glyph *glyph = s->first_glyph;
1252 XChar2b char2b[8];
1253 int x, i, j;
1255 /* If first glyph of S has a left box line, start drawing the text
1256 of S to the right of that box line. */
1257 if (s->face && s->face->box != FACE_NO_BOX
1258 && s->first_glyph->left_box_line_p)
1259 x = s->x + eabs (s->face->box_line_width);
1260 else
1261 x = s->x;
1263 s->char2b = char2b;
1265 for (i = 0; i < s->nchars; i++, glyph++)
1267 char buf[7], *str = NULL;
1268 int len = glyph->u.glyphless.len;
1270 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1272 if (len > 0
1273 && CHAR_TABLE_P (Vglyphless_char_display)
1274 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1275 >= 1))
1277 Lisp_Object acronym
1278 = (! glyph->u.glyphless.for_no_font
1279 ? CHAR_TABLE_REF (Vglyphless_char_display,
1280 glyph->u.glyphless.ch)
1281 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1282 if (STRINGP (acronym))
1283 str = SSDATA (acronym);
1286 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1288 sprintf (buf, "%0*X",
1289 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1290 glyph->u.glyphless.ch);
1291 str = buf;
1294 if (str)
1296 int upper_len = (len + 1) / 2;
1297 unsigned code;
1299 /* It is assured that all LEN characters in STR is ASCII. */
1300 for (j = 0; j < len; j++)
1302 code = s->font->driver->encode_char (s->font, str[j]);
1303 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1305 s->font->driver->draw (s, 0, upper_len,
1306 x + glyph->slice.glyphless.upper_xoff,
1307 s->ybase + glyph->slice.glyphless.upper_yoff,
1309 s->font->driver->draw (s, upper_len, len,
1310 x + glyph->slice.glyphless.lower_xoff,
1311 s->ybase + glyph->slice.glyphless.lower_yoff,
1314 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1315 XDrawRectangle (s->display, s->window, s->gc,
1316 x, s->ybase - glyph->ascent,
1317 glyph->pixel_width - 1,
1318 glyph->ascent + glyph->descent - 1);
1319 x += glyph->pixel_width;
1323 #ifdef USE_X_TOOLKIT
1325 #ifdef USE_LUCID
1327 /* Return the frame on which widget WIDGET is used.. Abort if frame
1328 cannot be determined. */
1330 static struct frame *
1331 x_frame_of_widget (Widget widget)
1333 struct x_display_info *dpyinfo;
1334 Lisp_Object tail, frame;
1335 struct frame *f;
1337 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1339 /* Find the top-level shell of the widget. Note that this function
1340 can be called when the widget is not yet realized, so XtWindow
1341 (widget) == 0. That's the reason we can't simply use
1342 x_any_window_to_frame. */
1343 while (!XtIsTopLevelShell (widget))
1344 widget = XtParent (widget);
1346 /* Look for a frame with that top-level widget. Allocate the color
1347 on that frame to get the right gamma correction value. */
1348 FOR_EACH_FRAME (tail, frame)
1350 f = XFRAME (frame);
1351 if (FRAME_X_P (f)
1352 && f->output_data.nothing != 1
1353 && FRAME_DISPLAY_INFO (f) == dpyinfo
1354 && f->output_data.x->widget == widget)
1355 return f;
1357 emacs_abort ();
1360 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1361 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1362 If this produces the same color as PIXEL, try a color where all RGB
1363 values have DELTA added. Return the allocated color in *PIXEL.
1364 DISPLAY is the X display, CMAP is the colormap to operate on.
1365 Value is true if successful. */
1367 bool
1368 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1369 unsigned long *pixel, double factor, int delta)
1371 struct frame *f = x_frame_of_widget (widget);
1372 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1375 #endif /* USE_LUCID */
1378 /* Structure specifying which arguments should be passed by Xt to
1379 cvt_string_to_pixel. We want the widget's screen and colormap. */
1381 static XtConvertArgRec cvt_string_to_pixel_args[] =
1383 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1384 sizeof (Screen *)},
1385 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1386 sizeof (Colormap)}
1390 /* The address of this variable is returned by
1391 cvt_string_to_pixel. */
1393 static Pixel cvt_string_to_pixel_value;
1396 /* Convert a color name to a pixel color.
1398 DPY is the display we are working on.
1400 ARGS is an array of *NARGS XrmValue structures holding additional
1401 information about the widget for which the conversion takes place.
1402 The contents of this array are determined by the specification
1403 in cvt_string_to_pixel_args.
1405 FROM is a pointer to an XrmValue which points to the color name to
1406 convert. TO is an XrmValue in which to return the pixel color.
1408 CLOSURE_RET is a pointer to user-data, in which we record if
1409 we allocated the color or not.
1411 Value is True if successful, False otherwise. */
1413 static Boolean
1414 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1415 XrmValue *from, XrmValue *to,
1416 XtPointer *closure_ret)
1418 Screen *screen;
1419 Colormap cmap;
1420 Pixel pixel;
1421 String color_name;
1422 XColor color;
1424 if (*nargs != 2)
1426 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1427 "wrongParameters", "cvt_string_to_pixel",
1428 "XtToolkitError",
1429 "Screen and colormap args required", NULL, NULL);
1430 return False;
1433 screen = *(Screen **) args[0].addr;
1434 cmap = *(Colormap *) args[1].addr;
1435 color_name = (String) from->addr;
1437 if (strcmp (color_name, XtDefaultBackground) == 0)
1439 *closure_ret = (XtPointer) False;
1440 pixel = WhitePixelOfScreen (screen);
1442 else if (strcmp (color_name, XtDefaultForeground) == 0)
1444 *closure_ret = (XtPointer) False;
1445 pixel = BlackPixelOfScreen (screen);
1447 else if (XParseColor (dpy, cmap, color_name, &color)
1448 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1450 pixel = color.pixel;
1451 *closure_ret = (XtPointer) True;
1453 else
1455 String params[1];
1456 Cardinal nparams = 1;
1458 params[0] = color_name;
1459 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1460 "badValue", "cvt_string_to_pixel",
1461 "XtToolkitError", "Invalid color `%s'",
1462 params, &nparams);
1463 return False;
1466 if (to->addr != NULL)
1468 if (to->size < sizeof (Pixel))
1470 to->size = sizeof (Pixel);
1471 return False;
1474 *(Pixel *) to->addr = pixel;
1476 else
1478 cvt_string_to_pixel_value = pixel;
1479 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1482 to->size = sizeof (Pixel);
1483 return True;
1487 /* Free a pixel color which was previously allocated via
1488 cvt_string_to_pixel. This is registered as the destructor
1489 for this type of resource via XtSetTypeConverter.
1491 APP is the application context in which we work.
1493 TO is a pointer to an XrmValue holding the color to free.
1494 CLOSURE is the value we stored in CLOSURE_RET for this color
1495 in cvt_string_to_pixel.
1497 ARGS and NARGS are like for cvt_string_to_pixel. */
1499 static void
1500 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1501 Cardinal *nargs)
1503 if (*nargs != 2)
1505 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1506 "XtToolkitError",
1507 "Screen and colormap arguments required",
1508 NULL, NULL);
1510 else if (closure != NULL)
1512 /* We did allocate the pixel, so free it. */
1513 Screen *screen = *(Screen **) args[0].addr;
1514 Colormap cmap = *(Colormap *) args[1].addr;
1515 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1516 (Pixel *) to->addr, 1);
1521 #endif /* USE_X_TOOLKIT */
1524 /* Value is an array of XColor structures for the contents of the
1525 color map of display DPY. Set *NCELLS to the size of the array.
1526 Note that this probably shouldn't be called for large color maps,
1527 say a 24-bit TrueColor map. */
1529 static const XColor *
1530 x_color_cells (Display *dpy, int *ncells)
1532 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1534 if (dpyinfo->color_cells == NULL)
1536 Screen *screen = dpyinfo->screen;
1537 int ncolor_cells = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1538 int i;
1540 dpyinfo->color_cells = xnmalloc (ncolor_cells,
1541 sizeof *dpyinfo->color_cells);
1542 dpyinfo->ncolor_cells = ncolor_cells;
1544 for (i = 0; i < ncolor_cells; ++i)
1545 dpyinfo->color_cells[i].pixel = i;
1547 XQueryColors (dpy, dpyinfo->cmap,
1548 dpyinfo->color_cells, ncolor_cells);
1551 *ncells = dpyinfo->ncolor_cells;
1552 return dpyinfo->color_cells;
1556 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1557 colors in COLORS. Use cached information, if available. */
1559 void
1560 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1562 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
1564 if (dpyinfo->color_cells)
1566 int i;
1567 for (i = 0; i < ncolors; ++i)
1569 unsigned long pixel = colors[i].pixel;
1570 eassert (pixel < dpyinfo->ncolor_cells);
1571 eassert (dpyinfo->color_cells[pixel].pixel == pixel);
1572 colors[i] = dpyinfo->color_cells[pixel];
1575 else
1576 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1580 /* On frame F, translate pixel color to RGB values for the color in
1581 COLOR. Use cached information, if available. */
1583 void
1584 x_query_color (struct frame *f, XColor *color)
1586 x_query_colors (f, color, 1);
1590 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1591 exact match can't be allocated, try the nearest color available.
1592 Value is true if successful. Set *COLOR to the color
1593 allocated. */
1595 static bool
1596 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1598 bool rc;
1600 rc = XAllocColor (dpy, cmap, color) != 0;
1601 if (rc == 0)
1603 /* If we got to this point, the colormap is full, so we're going
1604 to try to get the next closest color. The algorithm used is
1605 a least-squares matching, which is what X uses for closest
1606 color matching with StaticColor visuals. */
1607 int nearest, i;
1608 int max_color_delta = 255;
1609 int max_delta = 3 * max_color_delta;
1610 int nearest_delta = max_delta + 1;
1611 int ncells;
1612 const XColor *cells = x_color_cells (dpy, &ncells);
1614 for (nearest = i = 0; i < ncells; ++i)
1616 int dred = (color->red >> 8) - (cells[i].red >> 8);
1617 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
1618 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1619 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
1621 if (delta < nearest_delta)
1623 nearest = i;
1624 nearest_delta = delta;
1628 color->red = cells[nearest].red;
1629 color->green = cells[nearest].green;
1630 color->blue = cells[nearest].blue;
1631 rc = XAllocColor (dpy, cmap, color) != 0;
1633 else
1635 /* If allocation succeeded, and the allocated pixel color is not
1636 equal to a cached pixel color recorded earlier, there was a
1637 change in the colormap, so clear the color cache. */
1638 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1639 XColor *cached_color;
1641 if (dpyinfo->color_cells
1642 && (cached_color = &dpyinfo->color_cells[color->pixel],
1643 (cached_color->red != color->red
1644 || cached_color->blue != color->blue
1645 || cached_color->green != color->green)))
1647 xfree (dpyinfo->color_cells);
1648 dpyinfo->color_cells = NULL;
1649 dpyinfo->ncolor_cells = 0;
1653 #ifdef DEBUG_X_COLORS
1654 if (rc)
1655 register_color (color->pixel);
1656 #endif /* DEBUG_X_COLORS */
1658 return rc;
1662 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1663 exact match can't be allocated, try the nearest color available.
1664 Value is true if successful. Set *COLOR to the color
1665 allocated. */
1667 bool
1668 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1670 gamma_correct (f, color);
1671 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1675 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1676 It's necessary to do this instead of just using PIXEL directly to
1677 get color reference counts right. */
1679 unsigned long
1680 x_copy_color (struct frame *f, unsigned long pixel)
1682 XColor color;
1684 color.pixel = pixel;
1685 block_input ();
1686 x_query_color (f, &color);
1687 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1688 unblock_input ();
1689 #ifdef DEBUG_X_COLORS
1690 register_color (pixel);
1691 #endif
1692 return color.pixel;
1696 /* Brightness beyond which a color won't have its highlight brightness
1697 boosted.
1699 Nominally, highlight colors for `3d' faces are calculated by
1700 brightening an object's color by a constant scale factor, but this
1701 doesn't yield good results for dark colors, so for colors who's
1702 brightness is less than this value (on a scale of 0-65535) have an
1703 use an additional additive factor.
1705 The value here is set so that the default menu-bar/mode-line color
1706 (grey75) will not have its highlights changed at all. */
1707 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1710 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1711 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1712 If this produces the same color as PIXEL, try a color where all RGB
1713 values have DELTA added. Return the allocated color in *PIXEL.
1714 DISPLAY is the X display, CMAP is the colormap to operate on.
1715 Value is non-zero if successful. */
1717 static bool
1718 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap,
1719 unsigned long *pixel, double factor, int delta)
1721 XColor color, new;
1722 long bright;
1723 bool success_p;
1725 /* Get RGB color values. */
1726 color.pixel = *pixel;
1727 x_query_color (f, &color);
1729 /* Change RGB values by specified FACTOR. Avoid overflow! */
1730 eassert (factor >= 0);
1731 new.red = min (0xffff, factor * color.red);
1732 new.green = min (0xffff, factor * color.green);
1733 new.blue = min (0xffff, factor * color.blue);
1735 /* Calculate brightness of COLOR. */
1736 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1738 /* We only boost colors that are darker than
1739 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1740 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1741 /* Make an additive adjustment to NEW, because it's dark enough so
1742 that scaling by FACTOR alone isn't enough. */
1744 /* How far below the limit this color is (0 - 1, 1 being darker). */
1745 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1746 /* The additive adjustment. */
1747 int min_delta = delta * dimness * factor / 2;
1749 if (factor < 1)
1751 new.red = max (0, new.red - min_delta);
1752 new.green = max (0, new.green - min_delta);
1753 new.blue = max (0, new.blue - min_delta);
1755 else
1757 new.red = min (0xffff, min_delta + new.red);
1758 new.green = min (0xffff, min_delta + new.green);
1759 new.blue = min (0xffff, min_delta + new.blue);
1763 /* Try to allocate the color. */
1764 success_p = x_alloc_nearest_color (f, cmap, &new);
1765 if (success_p)
1767 if (new.pixel == *pixel)
1769 /* If we end up with the same color as before, try adding
1770 delta to the RGB values. */
1771 x_free_colors (f, &new.pixel, 1);
1773 new.red = min (0xffff, delta + color.red);
1774 new.green = min (0xffff, delta + color.green);
1775 new.blue = min (0xffff, delta + color.blue);
1776 success_p = x_alloc_nearest_color (f, cmap, &new);
1778 else
1779 success_p = 1;
1780 *pixel = new.pixel;
1783 return success_p;
1787 /* Set up the foreground color for drawing relief lines of glyph
1788 string S. RELIEF is a pointer to a struct relief containing the GC
1789 with which lines will be drawn. Use a color that is FACTOR or
1790 DELTA lighter or darker than the relief's background which is found
1791 in S->f->output_data.x->relief_background. If such a color cannot
1792 be allocated, use DEFAULT_PIXEL, instead. */
1794 static void
1795 x_setup_relief_color (struct frame *f, struct relief *relief, double factor,
1796 int delta, unsigned long default_pixel)
1798 XGCValues xgcv;
1799 struct x_output *di = f->output_data.x;
1800 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1801 unsigned long pixel;
1802 unsigned long background = di->relief_background;
1803 Colormap cmap = FRAME_X_COLORMAP (f);
1804 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
1805 Display *dpy = FRAME_X_DISPLAY (f);
1807 xgcv.graphics_exposures = False;
1808 xgcv.line_width = 1;
1810 /* Free previously allocated color. The color cell will be reused
1811 when it has been freed as many times as it was allocated, so this
1812 doesn't affect faces using the same colors. */
1813 if (relief->gc && relief->pixel != -1)
1815 x_free_colors (f, &relief->pixel, 1);
1816 relief->pixel = -1;
1819 /* Allocate new color. */
1820 xgcv.foreground = default_pixel;
1821 pixel = background;
1822 if (dpyinfo->n_planes != 1
1823 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1824 xgcv.foreground = relief->pixel = pixel;
1826 if (relief->gc == 0)
1828 xgcv.stipple = dpyinfo->gray;
1829 mask |= GCStipple;
1830 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1832 else
1833 XChangeGC (dpy, relief->gc, mask, &xgcv);
1837 /* Set up colors for the relief lines around glyph string S. */
1839 static void
1840 x_setup_relief_colors (struct glyph_string *s)
1842 struct x_output *di = s->f->output_data.x;
1843 unsigned long color;
1845 if (s->face->use_box_color_for_shadows_p)
1846 color = s->face->box_color;
1847 else if (s->first_glyph->type == IMAGE_GLYPH
1848 && s->img->pixmap
1849 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1850 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1851 else
1853 XGCValues xgcv;
1855 /* Get the background color of the face. */
1856 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1857 color = xgcv.background;
1860 if (di->white_relief.gc == 0
1861 || color != di->relief_background)
1863 di->relief_background = color;
1864 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1865 WHITE_PIX_DEFAULT (s->f));
1866 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1867 BLACK_PIX_DEFAULT (s->f));
1872 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
1873 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
1874 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
1875 relief. LEFT_P non-zero means draw a relief on the left side of
1876 the rectangle. RIGHT_P non-zero means draw a relief on the right
1877 side of the rectangle. CLIP_RECT is the clipping rectangle to use
1878 when drawing. */
1880 static void
1881 x_draw_relief_rect (struct frame *f,
1882 int left_x, int top_y, int right_x, int bottom_y, int width,
1883 int raised_p, int top_p, int bot_p, int left_p, int right_p,
1884 XRectangle *clip_rect)
1886 Display *dpy = FRAME_X_DISPLAY (f);
1887 Window window = FRAME_X_WINDOW (f);
1888 int i;
1889 GC gc;
1891 if (raised_p)
1892 gc = f->output_data.x->white_relief.gc;
1893 else
1894 gc = f->output_data.x->black_relief.gc;
1895 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
1897 /* This code is more complicated than it has to be, because of two
1898 minor hacks to make the boxes look nicer: (i) if width > 1, draw
1899 the outermost line using the black relief. (ii) Omit the four
1900 corner pixels. */
1902 /* Top. */
1903 if (top_p)
1905 if (width == 1)
1906 XDrawLine (dpy, window, gc,
1907 left_x + (left_p ? 1 : 0), top_y,
1908 right_x + (right_p ? 0 : 1), top_y);
1910 for (i = 1; i < width; ++i)
1911 XDrawLine (dpy, window, gc,
1912 left_x + i * left_p, top_y + i,
1913 right_x + 1 - i * right_p, top_y + i);
1916 /* Left. */
1917 if (left_p)
1919 if (width == 1)
1920 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
1922 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
1923 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
1925 for (i = (width > 1 ? 1 : 0); i < width; ++i)
1926 XDrawLine (dpy, window, gc,
1927 left_x + i, top_y + (i + 1) * top_p,
1928 left_x + i, bottom_y + 1 - (i + 1) * bot_p);
1931 XSetClipMask (dpy, gc, None);
1932 if (raised_p)
1933 gc = f->output_data.x->black_relief.gc;
1934 else
1935 gc = f->output_data.x->white_relief.gc;
1936 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
1938 if (width > 1)
1940 /* Outermost top line. */
1941 if (top_p)
1942 XDrawLine (dpy, window, gc,
1943 left_x + (left_p ? 1 : 0), top_y,
1944 right_x + (right_p ? 0 : 1), top_y);
1946 /* Outermost left line. */
1947 if (left_p)
1948 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
1951 /* Bottom. */
1952 if (bot_p)
1954 XDrawLine (dpy, window, gc,
1955 left_x + (left_p ? 1 : 0), bottom_y,
1956 right_x + (right_p ? 0 : 1), bottom_y);
1957 for (i = 1; i < width; ++i)
1958 XDrawLine (dpy, window, gc,
1959 left_x + i * left_p, bottom_y - i,
1960 right_x + 1 - i * right_p, bottom_y - i);
1963 /* Right. */
1964 if (right_p)
1966 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
1967 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
1968 for (i = 0; i < width; ++i)
1969 XDrawLine (dpy, window, gc,
1970 right_x - i, top_y + (i + 1) * top_p,
1971 right_x - i, bottom_y + 1 - (i + 1) * bot_p);
1974 XSetClipMask (dpy, gc, None);
1978 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
1979 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
1980 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
1981 left side of the rectangle. RIGHT_P non-zero means draw a line
1982 on the right side of the rectangle. CLIP_RECT is the clipping
1983 rectangle to use when drawing. */
1985 static void
1986 x_draw_box_rect (struct glyph_string *s,
1987 int left_x, int top_y, int right_x, int bottom_y, int width,
1988 int left_p, int right_p, XRectangle *clip_rect)
1990 XGCValues xgcv;
1992 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
1993 XSetForeground (s->display, s->gc, s->face->box_color);
1994 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
1996 /* Top. */
1997 XFillRectangle (s->display, s->window, s->gc,
1998 left_x, top_y, right_x - left_x + 1, width);
2000 /* Left. */
2001 if (left_p)
2002 XFillRectangle (s->display, s->window, s->gc,
2003 left_x, top_y, width, bottom_y - top_y + 1);
2005 /* Bottom. */
2006 XFillRectangle (s->display, s->window, s->gc,
2007 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2009 /* Right. */
2010 if (right_p)
2011 XFillRectangle (s->display, s->window, s->gc,
2012 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2014 XSetForeground (s->display, s->gc, xgcv.foreground);
2015 XSetClipMask (s->display, s->gc, None);
2019 /* Draw a box around glyph string S. */
2021 static void
2022 x_draw_glyph_string_box (struct glyph_string *s)
2024 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2025 int left_p, right_p;
2026 struct glyph *last_glyph;
2027 XRectangle clip_rect;
2029 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2030 ? WINDOW_RIGHT_EDGE_X (s->w)
2031 : window_box_right (s->w, s->area));
2033 /* The glyph that may have a right box line. */
2034 last_glyph = (s->cmp || s->img
2035 ? s->first_glyph
2036 : s->first_glyph + s->nchars - 1);
2038 width = eabs (s->face->box_line_width);
2039 raised_p = s->face->box == FACE_RAISED_BOX;
2040 left_x = s->x;
2041 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2042 ? last_x - 1
2043 : min (last_x, s->x + s->background_width) - 1);
2044 top_y = s->y;
2045 bottom_y = top_y + s->height - 1;
2047 left_p = (s->first_glyph->left_box_line_p
2048 || (s->hl == DRAW_MOUSE_FACE
2049 && (s->prev == NULL
2050 || s->prev->hl != s->hl)));
2051 right_p = (last_glyph->right_box_line_p
2052 || (s->hl == DRAW_MOUSE_FACE
2053 && (s->next == NULL
2054 || s->next->hl != s->hl)));
2056 get_glyph_string_clip_rect (s, &clip_rect);
2058 if (s->face->box == FACE_SIMPLE_BOX)
2059 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2060 left_p, right_p, &clip_rect);
2061 else
2063 x_setup_relief_colors (s);
2064 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2065 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2070 /* Draw foreground of image glyph string S. */
2072 static void
2073 x_draw_image_foreground (struct glyph_string *s)
2075 int x = s->x;
2076 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2078 /* If first glyph of S has a left box line, start drawing it to the
2079 right of that line. */
2080 if (s->face->box != FACE_NO_BOX
2081 && s->first_glyph->left_box_line_p
2082 && s->slice.x == 0)
2083 x += eabs (s->face->box_line_width);
2085 /* If there is a margin around the image, adjust x- and y-position
2086 by that margin. */
2087 if (s->slice.x == 0)
2088 x += s->img->hmargin;
2089 if (s->slice.y == 0)
2090 y += s->img->vmargin;
2092 if (s->img->pixmap)
2094 if (s->img->mask)
2096 /* We can't set both a clip mask and use XSetClipRectangles
2097 because the latter also sets a clip mask. We also can't
2098 trust on the shape extension to be available
2099 (XShapeCombineRegion). So, compute the rectangle to draw
2100 manually. */
2101 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2102 | GCFunction);
2103 XGCValues xgcv;
2104 XRectangle clip_rect, image_rect, r;
2106 xgcv.clip_mask = s->img->mask;
2107 xgcv.clip_x_origin = x;
2108 xgcv.clip_y_origin = y;
2109 xgcv.function = GXcopy;
2110 XChangeGC (s->display, s->gc, mask, &xgcv);
2112 get_glyph_string_clip_rect (s, &clip_rect);
2113 image_rect.x = x;
2114 image_rect.y = y;
2115 image_rect.width = s->slice.width;
2116 image_rect.height = s->slice.height;
2117 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2118 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2119 s->slice.x + r.x - x, s->slice.y + r.y - y,
2120 r.width, r.height, r.x, r.y);
2122 else
2124 XRectangle clip_rect, image_rect, r;
2126 get_glyph_string_clip_rect (s, &clip_rect);
2127 image_rect.x = x;
2128 image_rect.y = y;
2129 image_rect.width = s->slice.width;
2130 image_rect.height = s->slice.height;
2131 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2132 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2133 s->slice.x + r.x - x, s->slice.y + r.y - y,
2134 r.width, r.height, r.x, r.y);
2136 /* When the image has a mask, we can expect that at
2137 least part of a mouse highlight or a block cursor will
2138 be visible. If the image doesn't have a mask, make
2139 a block cursor visible by drawing a rectangle around
2140 the image. I believe it's looking better if we do
2141 nothing here for mouse-face. */
2142 if (s->hl == DRAW_CURSOR)
2144 int relief = eabs (s->img->relief);
2145 XDrawRectangle (s->display, s->window, s->gc,
2146 x - relief, y - relief,
2147 s->slice.width + relief*2 - 1,
2148 s->slice.height + relief*2 - 1);
2152 else
2153 /* Draw a rectangle if image could not be loaded. */
2154 XDrawRectangle (s->display, s->window, s->gc, x, y,
2155 s->slice.width - 1, s->slice.height - 1);
2159 /* Draw a relief around the image glyph string S. */
2161 static void
2162 x_draw_image_relief (struct glyph_string *s)
2164 int x1, y1, thick, raised_p, top_p, bot_p, left_p, right_p;
2165 int extra_x, extra_y;
2166 XRectangle r;
2167 int x = s->x;
2168 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2170 /* If first glyph of S has a left box line, start drawing it to the
2171 right of that line. */
2172 if (s->face->box != FACE_NO_BOX
2173 && s->first_glyph->left_box_line_p
2174 && s->slice.x == 0)
2175 x += eabs (s->face->box_line_width);
2177 /* If there is a margin around the image, adjust x- and y-position
2178 by that margin. */
2179 if (s->slice.x == 0)
2180 x += s->img->hmargin;
2181 if (s->slice.y == 0)
2182 y += s->img->vmargin;
2184 if (s->hl == DRAW_IMAGE_SUNKEN
2185 || s->hl == DRAW_IMAGE_RAISED)
2187 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2188 raised_p = s->hl == DRAW_IMAGE_RAISED;
2190 else
2192 thick = eabs (s->img->relief);
2193 raised_p = s->img->relief > 0;
2196 x1 = x + s->slice.width - 1;
2197 y1 = y + s->slice.height - 1;
2199 extra_x = extra_y = 0;
2200 if (s->face->id == TOOL_BAR_FACE_ID)
2202 if (CONSP (Vtool_bar_button_margin)
2203 && INTEGERP (XCAR (Vtool_bar_button_margin))
2204 && INTEGERP (XCDR (Vtool_bar_button_margin)))
2206 extra_x = XINT (XCAR (Vtool_bar_button_margin));
2207 extra_y = XINT (XCDR (Vtool_bar_button_margin));
2209 else if (INTEGERP (Vtool_bar_button_margin))
2210 extra_x = extra_y = XINT (Vtool_bar_button_margin);
2213 top_p = bot_p = left_p = right_p = 0;
2215 if (s->slice.x == 0)
2216 x -= thick + extra_x, left_p = 1;
2217 if (s->slice.y == 0)
2218 y -= thick + extra_y, top_p = 1;
2219 if (s->slice.x + s->slice.width == s->img->width)
2220 x1 += thick + extra_x, right_p = 1;
2221 if (s->slice.y + s->slice.height == s->img->height)
2222 y1 += thick + extra_y, bot_p = 1;
2224 x_setup_relief_colors (s);
2225 get_glyph_string_clip_rect (s, &r);
2226 x_draw_relief_rect (s->f, x, y, x1, y1, thick, raised_p,
2227 top_p, bot_p, left_p, right_p, &r);
2231 /* Draw the foreground of image glyph string S to PIXMAP. */
2233 static void
2234 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2236 int x = 0;
2237 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2239 /* If first glyph of S has a left box line, start drawing it to the
2240 right of that line. */
2241 if (s->face->box != FACE_NO_BOX
2242 && s->first_glyph->left_box_line_p
2243 && s->slice.x == 0)
2244 x += eabs (s->face->box_line_width);
2246 /* If there is a margin around the image, adjust x- and y-position
2247 by that margin. */
2248 if (s->slice.x == 0)
2249 x += s->img->hmargin;
2250 if (s->slice.y == 0)
2251 y += s->img->vmargin;
2253 if (s->img->pixmap)
2255 if (s->img->mask)
2257 /* We can't set both a clip mask and use XSetClipRectangles
2258 because the latter also sets a clip mask. We also can't
2259 trust on the shape extension to be available
2260 (XShapeCombineRegion). So, compute the rectangle to draw
2261 manually. */
2262 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2263 | GCFunction);
2264 XGCValues xgcv;
2266 xgcv.clip_mask = s->img->mask;
2267 xgcv.clip_x_origin = x - s->slice.x;
2268 xgcv.clip_y_origin = y - s->slice.y;
2269 xgcv.function = GXcopy;
2270 XChangeGC (s->display, s->gc, mask, &xgcv);
2272 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2273 s->slice.x, s->slice.y,
2274 s->slice.width, s->slice.height, x, y);
2275 XSetClipMask (s->display, s->gc, None);
2277 else
2279 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2280 s->slice.x, s->slice.y,
2281 s->slice.width, s->slice.height, x, y);
2283 /* When the image has a mask, we can expect that at
2284 least part of a mouse highlight or a block cursor will
2285 be visible. If the image doesn't have a mask, make
2286 a block cursor visible by drawing a rectangle around
2287 the image. I believe it's looking better if we do
2288 nothing here for mouse-face. */
2289 if (s->hl == DRAW_CURSOR)
2291 int r = eabs (s->img->relief);
2292 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2293 s->slice.width + r*2 - 1,
2294 s->slice.height + r*2 - 1);
2298 else
2299 /* Draw a rectangle if image could not be loaded. */
2300 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2301 s->slice.width - 1, s->slice.height - 1);
2305 /* Draw part of the background of glyph string S. X, Y, W, and H
2306 give the rectangle to draw. */
2308 static void
2309 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2311 if (s->stippled_p)
2313 /* Fill background with a stipple pattern. */
2314 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2315 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2316 XSetFillStyle (s->display, s->gc, FillSolid);
2318 else
2319 x_clear_glyph_string_rect (s, x, y, w, h);
2323 /* Draw image glyph string S.
2325 s->y
2326 s->x +-------------------------
2327 | s->face->box
2329 | +-------------------------
2330 | | s->img->margin
2332 | | +-------------------
2333 | | | the image
2337 static void
2338 x_draw_image_glyph_string (struct glyph_string *s)
2340 int box_line_hwidth = eabs (s->face->box_line_width);
2341 int box_line_vwidth = max (s->face->box_line_width, 0);
2342 int height;
2343 Pixmap pixmap = None;
2345 height = s->height;
2346 if (s->slice.y == 0)
2347 height -= box_line_vwidth;
2348 if (s->slice.y + s->slice.height >= s->img->height)
2349 height -= box_line_vwidth;
2351 /* Fill background with face under the image. Do it only if row is
2352 taller than image or if image has a clip mask to reduce
2353 flickering. */
2354 s->stippled_p = s->face->stipple != 0;
2355 if (height > s->slice.height
2356 || s->img->hmargin
2357 || s->img->vmargin
2358 || s->img->mask
2359 || s->img->pixmap == 0
2360 || s->width != s->background_width)
2362 if (s->img->mask)
2364 /* Create a pixmap as large as the glyph string. Fill it
2365 with the background color. Copy the image to it, using
2366 its mask. Copy the temporary pixmap to the display. */
2367 Screen *screen = FRAME_X_SCREEN (s->f);
2368 int depth = DefaultDepthOfScreen (screen);
2370 /* Create a pixmap as large as the glyph string. */
2371 pixmap = XCreatePixmap (s->display, s->window,
2372 s->background_width,
2373 s->height, depth);
2375 /* Don't clip in the following because we're working on the
2376 pixmap. */
2377 XSetClipMask (s->display, s->gc, None);
2379 /* Fill the pixmap with the background color/stipple. */
2380 if (s->stippled_p)
2382 /* Fill background with a stipple pattern. */
2383 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2384 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2385 XFillRectangle (s->display, pixmap, s->gc,
2386 0, 0, s->background_width, s->height);
2387 XSetFillStyle (s->display, s->gc, FillSolid);
2388 XSetTSOrigin (s->display, s->gc, 0, 0);
2390 else
2392 XGCValues xgcv;
2393 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2394 &xgcv);
2395 XSetForeground (s->display, s->gc, xgcv.background);
2396 XFillRectangle (s->display, pixmap, s->gc,
2397 0, 0, s->background_width, s->height);
2398 XSetForeground (s->display, s->gc, xgcv.foreground);
2401 else
2403 int x = s->x;
2404 int y = s->y;
2406 if (s->first_glyph->left_box_line_p
2407 && s->slice.x == 0)
2408 x += box_line_hwidth;
2410 if (s->slice.y == 0)
2411 y += box_line_vwidth;
2413 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2416 s->background_filled_p = 1;
2419 /* Draw the foreground. */
2420 if (pixmap != None)
2422 x_draw_image_foreground_1 (s, pixmap);
2423 x_set_glyph_string_clipping (s);
2424 XCopyArea (s->display, pixmap, s->window, s->gc,
2425 0, 0, s->background_width, s->height, s->x, s->y);
2426 XFreePixmap (s->display, pixmap);
2428 else
2429 x_draw_image_foreground (s);
2431 /* If we must draw a relief around the image, do it. */
2432 if (s->img->relief
2433 || s->hl == DRAW_IMAGE_RAISED
2434 || s->hl == DRAW_IMAGE_SUNKEN)
2435 x_draw_image_relief (s);
2439 /* Draw stretch glyph string S. */
2441 static void
2442 x_draw_stretch_glyph_string (struct glyph_string *s)
2444 eassert (s->first_glyph->type == STRETCH_GLYPH);
2446 if (s->hl == DRAW_CURSOR
2447 && !x_stretch_cursor_p)
2449 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2450 wide as the stretch glyph. */
2451 int width, background_width = s->background_width;
2452 int x = s->x;
2454 if (!s->row->reversed_p)
2456 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2458 if (x < left_x)
2460 background_width -= left_x - x;
2461 x = left_x;
2464 else
2466 /* In R2L rows, draw the cursor on the right edge of the
2467 stretch glyph. */
2468 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2470 if (x + background_width > right_x)
2471 background_width -= x - right_x;
2472 x += background_width;
2474 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2475 if (s->row->reversed_p)
2476 x -= width;
2478 /* Draw cursor. */
2479 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2481 /* Clear rest using the GC of the original non-cursor face. */
2482 if (width < background_width)
2484 int y = s->y;
2485 int w = background_width - width, h = s->height;
2486 XRectangle r;
2487 GC gc;
2489 if (!s->row->reversed_p)
2490 x += width;
2491 else
2492 x = s->x;
2493 if (s->row->mouse_face_p
2494 && cursor_in_mouse_face_p (s->w))
2496 x_set_mouse_face_gc (s);
2497 gc = s->gc;
2499 else
2500 gc = s->face->gc;
2502 get_glyph_string_clip_rect (s, &r);
2503 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2505 if (s->face->stipple)
2507 /* Fill background with a stipple pattern. */
2508 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2509 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2510 XSetFillStyle (s->display, gc, FillSolid);
2512 else
2514 XGCValues xgcv;
2515 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2516 XSetForeground (s->display, gc, xgcv.background);
2517 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2518 XSetForeground (s->display, gc, xgcv.foreground);
2521 XSetClipMask (s->display, gc, None);
2524 else if (!s->background_filled_p)
2526 int background_width = s->background_width;
2527 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2529 /* Don't draw into left margin, fringe or scrollbar area
2530 except for header line and mode line. */
2531 if (x < left_x && !s->row->mode_line_p)
2533 background_width -= left_x - x;
2534 x = left_x;
2536 if (background_width > 0)
2537 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2540 s->background_filled_p = 1;
2544 Draw a wavy line under S. The wave fills wave_height pixels from y0.
2546 x0 wave_length = 2
2548 y0 * * * * *
2549 |* * * * * * * * *
2550 wave_height = 3 | * * * *
2554 static void
2555 x_draw_underwave (struct glyph_string *s)
2557 int wave_height = 3, wave_length = 2;
2558 int dx, dy, x0, y0, width, x1, y1, x2, y2, odd, xmax;
2559 XRectangle wave_clip, string_clip, final_clip;
2561 dx = wave_length;
2562 dy = wave_height - 1;
2563 x0 = s->x;
2564 y0 = s->ybase - wave_height + 3;
2565 width = s->width;
2566 xmax = x0 + width;
2568 /* Find and set clipping rectangle */
2570 wave_clip.x = x0;
2571 wave_clip.y = y0;
2572 wave_clip.width = width;
2573 wave_clip.height = wave_height;
2574 get_glyph_string_clip_rect (s, &string_clip);
2576 if (!x_intersect_rectangles (&wave_clip, &string_clip, &final_clip))
2577 return;
2579 XSetClipRectangles (s->display, s->gc, 0, 0, &final_clip, 1, Unsorted);
2581 /* Draw the waves */
2583 x1 = x0 - (x0 % dx);
2584 x2 = x1 + dx;
2585 odd = (x1/dx) % 2;
2586 y1 = y2 = y0;
2588 if (odd)
2589 y1 += dy;
2590 else
2591 y2 += dy;
2593 if (INT_MAX - dx < xmax)
2594 emacs_abort ();
2596 while (x1 <= xmax)
2598 XDrawLine (s->display, s->window, s->gc, x1, y1, x2, y2);
2599 x1 = x2, y1 = y2;
2600 x2 += dx, y2 = y0 + odd*dy;
2601 odd = !odd;
2604 /* Restore previous clipping rectangle(s) */
2605 XSetClipRectangles (s->display, s->gc, 0, 0, s->clip, s->num_clips, Unsorted);
2609 /* Draw glyph string S. */
2611 static void
2612 x_draw_glyph_string (struct glyph_string *s)
2614 bool relief_drawn_p = 0;
2616 /* If S draws into the background of its successors, draw the
2617 background of the successors first so that S can draw into it.
2618 This makes S->next use XDrawString instead of XDrawImageString. */
2619 if (s->next && s->right_overhang && !s->for_overlaps)
2621 int width;
2622 struct glyph_string *next;
2624 for (width = 0, next = s->next;
2625 next && width < s->right_overhang;
2626 width += next->width, next = next->next)
2627 if (next->first_glyph->type != IMAGE_GLYPH)
2629 x_set_glyph_string_gc (next);
2630 x_set_glyph_string_clipping (next);
2631 if (next->first_glyph->type == STRETCH_GLYPH)
2632 x_draw_stretch_glyph_string (next);
2633 else
2634 x_draw_glyph_string_background (next, 1);
2635 next->num_clips = 0;
2639 /* Set up S->gc, set clipping and draw S. */
2640 x_set_glyph_string_gc (s);
2642 /* Draw relief (if any) in advance for char/composition so that the
2643 glyph string can be drawn over it. */
2644 if (!s->for_overlaps
2645 && s->face->box != FACE_NO_BOX
2646 && (s->first_glyph->type == CHAR_GLYPH
2647 || s->first_glyph->type == COMPOSITE_GLYPH))
2650 x_set_glyph_string_clipping (s);
2651 x_draw_glyph_string_background (s, 1);
2652 x_draw_glyph_string_box (s);
2653 x_set_glyph_string_clipping (s);
2654 relief_drawn_p = 1;
2656 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2657 && !s->clip_tail
2658 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2659 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2660 /* We must clip just this glyph. left_overhang part has already
2661 drawn when s->prev was drawn, and right_overhang part will be
2662 drawn later when s->next is drawn. */
2663 x_set_glyph_string_clipping_exactly (s, s);
2664 else
2665 x_set_glyph_string_clipping (s);
2667 switch (s->first_glyph->type)
2669 case IMAGE_GLYPH:
2670 x_draw_image_glyph_string (s);
2671 break;
2673 case STRETCH_GLYPH:
2674 x_draw_stretch_glyph_string (s);
2675 break;
2677 case CHAR_GLYPH:
2678 if (s->for_overlaps)
2679 s->background_filled_p = 1;
2680 else
2681 x_draw_glyph_string_background (s, 0);
2682 x_draw_glyph_string_foreground (s);
2683 break;
2685 case COMPOSITE_GLYPH:
2686 if (s->for_overlaps || (s->cmp_from > 0
2687 && ! s->first_glyph->u.cmp.automatic))
2688 s->background_filled_p = 1;
2689 else
2690 x_draw_glyph_string_background (s, 1);
2691 x_draw_composite_glyph_string_foreground (s);
2692 break;
2694 case GLYPHLESS_GLYPH:
2695 if (s->for_overlaps)
2696 s->background_filled_p = 1;
2697 else
2698 x_draw_glyph_string_background (s, 1);
2699 x_draw_glyphless_glyph_string_foreground (s);
2700 break;
2702 default:
2703 emacs_abort ();
2706 if (!s->for_overlaps)
2708 /* Draw underline. */
2709 if (s->face->underline_p)
2711 if (s->face->underline_type == FACE_UNDER_WAVE)
2713 if (s->face->underline_defaulted_p)
2714 x_draw_underwave (s);
2715 else
2717 XGCValues xgcv;
2718 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2719 XSetForeground (s->display, s->gc, s->face->underline_color);
2720 x_draw_underwave (s);
2721 XSetForeground (s->display, s->gc, xgcv.foreground);
2724 else if (s->face->underline_type == FACE_UNDER_LINE)
2726 unsigned long thickness, position;
2727 int y;
2729 if (s->prev && s->prev->face->underline_p
2730 && s->prev->face->underline_type == FACE_UNDER_LINE)
2732 /* We use the same underline style as the previous one. */
2733 thickness = s->prev->underline_thickness;
2734 position = s->prev->underline_position;
2736 else
2738 /* Get the underline thickness. Default is 1 pixel. */
2739 if (s->font && s->font->underline_thickness > 0)
2740 thickness = s->font->underline_thickness;
2741 else
2742 thickness = 1;
2743 if (x_underline_at_descent_line)
2744 position = (s->height - thickness) - (s->ybase - s->y);
2745 else
2747 /* Get the underline position. This is the recommended
2748 vertical offset in pixels from the baseline to the top of
2749 the underline. This is a signed value according to the
2750 specs, and its default is
2752 ROUND ((maximum descent) / 2), with
2753 ROUND(x) = floor (x + 0.5) */
2755 if (x_use_underline_position_properties
2756 && s->font && s->font->underline_position >= 0)
2757 position = s->font->underline_position;
2758 else if (s->font)
2759 position = (s->font->descent + 1) / 2;
2760 else
2761 position = underline_minimum_offset;
2763 position = max (position, underline_minimum_offset);
2765 /* Check the sanity of thickness and position. We should
2766 avoid drawing underline out of the current line area. */
2767 if (s->y + s->height <= s->ybase + position)
2768 position = (s->height - 1) - (s->ybase - s->y);
2769 if (s->y + s->height < s->ybase + position + thickness)
2770 thickness = (s->y + s->height) - (s->ybase + position);
2771 s->underline_thickness = thickness;
2772 s->underline_position = position;
2773 y = s->ybase + position;
2774 if (s->face->underline_defaulted_p)
2775 XFillRectangle (s->display, s->window, s->gc,
2776 s->x, y, s->width, thickness);
2777 else
2779 XGCValues xgcv;
2780 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2781 XSetForeground (s->display, s->gc, s->face->underline_color);
2782 XFillRectangle (s->display, s->window, s->gc,
2783 s->x, y, s->width, thickness);
2784 XSetForeground (s->display, s->gc, xgcv.foreground);
2788 /* Draw overline. */
2789 if (s->face->overline_p)
2791 unsigned long dy = 0, h = 1;
2793 if (s->face->overline_color_defaulted_p)
2794 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2795 s->width, h);
2796 else
2798 XGCValues xgcv;
2799 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2800 XSetForeground (s->display, s->gc, s->face->overline_color);
2801 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2802 s->width, h);
2803 XSetForeground (s->display, s->gc, xgcv.foreground);
2807 /* Draw strike-through. */
2808 if (s->face->strike_through_p)
2810 unsigned long h = 1;
2811 unsigned long dy = (s->height - h) / 2;
2813 if (s->face->strike_through_color_defaulted_p)
2814 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2815 s->width, h);
2816 else
2818 XGCValues xgcv;
2819 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2820 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2821 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2822 s->width, h);
2823 XSetForeground (s->display, s->gc, xgcv.foreground);
2827 /* Draw relief if not yet drawn. */
2828 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2829 x_draw_glyph_string_box (s);
2831 if (s->prev)
2833 struct glyph_string *prev;
2835 for (prev = s->prev; prev; prev = prev->prev)
2836 if (prev->hl != s->hl
2837 && prev->x + prev->width + prev->right_overhang > s->x)
2839 /* As prev was drawn while clipped to its own area, we
2840 must draw the right_overhang part using s->hl now. */
2841 enum draw_glyphs_face save = prev->hl;
2843 prev->hl = s->hl;
2844 x_set_glyph_string_gc (prev);
2845 x_set_glyph_string_clipping_exactly (s, prev);
2846 if (prev->first_glyph->type == CHAR_GLYPH)
2847 x_draw_glyph_string_foreground (prev);
2848 else
2849 x_draw_composite_glyph_string_foreground (prev);
2850 XSetClipMask (prev->display, prev->gc, None);
2851 prev->hl = save;
2852 prev->num_clips = 0;
2856 if (s->next)
2858 struct glyph_string *next;
2860 for (next = s->next; next; next = next->next)
2861 if (next->hl != s->hl
2862 && next->x - next->left_overhang < s->x + s->width)
2864 /* As next will be drawn while clipped to its own area,
2865 we must draw the left_overhang part using s->hl now. */
2866 enum draw_glyphs_face save = next->hl;
2868 next->hl = s->hl;
2869 x_set_glyph_string_gc (next);
2870 x_set_glyph_string_clipping_exactly (s, next);
2871 if (next->first_glyph->type == CHAR_GLYPH)
2872 x_draw_glyph_string_foreground (next);
2873 else
2874 x_draw_composite_glyph_string_foreground (next);
2875 XSetClipMask (next->display, next->gc, None);
2876 next->hl = save;
2877 next->num_clips = 0;
2878 next->clip_head = s->next;
2883 /* Reset clipping. */
2884 XSetClipMask (s->display, s->gc, None);
2885 s->num_clips = 0;
2888 /* Shift display to make room for inserted glyphs. */
2890 static void
2891 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2893 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2894 f->output_data.x->normal_gc,
2895 x, y, width, height,
2896 x + shift_by, y);
2899 /* Delete N glyphs at the nominal cursor position. Not implemented
2900 for X frames. */
2902 static void
2903 x_delete_glyphs (struct frame *f, register int n)
2905 emacs_abort ();
2909 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2910 If they are <= 0, this is probably an error. */
2912 void
2913 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height)
2915 eassert (width > 0 && height > 0);
2916 XClearArea (dpy, window, x, y, width, height, False);
2920 /* Clear an entire frame. */
2922 static void
2923 x_clear_frame (struct frame *f)
2925 /* Clearing the frame will erase any cursor, so mark them all as no
2926 longer visible. */
2927 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2929 block_input ();
2931 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2933 /* We have to clear the scroll bars. If we have changed colors or
2934 something like that, then they should be notified. */
2935 x_scroll_bar_clear (f);
2937 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
2938 /* Make sure scroll bars are redrawn. As they aren't redrawn by
2939 redisplay, do it here. */
2940 if (FRAME_GTK_WIDGET (f))
2941 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
2942 #endif
2944 XFlush (FRAME_X_DISPLAY (f));
2946 unblock_input ();
2951 /* Invert the middle quarter of the frame for .15 sec. */
2953 static void
2954 XTflash (struct frame *f)
2956 block_input ();
2959 #ifdef USE_GTK
2960 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
2961 when the scroll bars and the edit widget share the same X window. */
2962 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
2963 #ifdef HAVE_GTK3
2964 cairo_t *cr = gdk_cairo_create (window);
2965 cairo_set_source_rgb (cr, 1, 1, 1);
2966 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
2967 #define XFillRectangle(d, win, gc, x, y, w, h) \
2968 do { \
2969 cairo_rectangle (cr, x, y, w, h); \
2970 cairo_fill (cr); \
2972 while (0)
2973 #else /* ! HAVE_GTK3 */
2974 GdkGCValues vals;
2975 GdkGC *gc;
2976 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
2977 ^ FRAME_BACKGROUND_PIXEL (f));
2978 vals.function = GDK_XOR;
2979 gc = gdk_gc_new_with_values (window,
2980 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
2981 #define XFillRectangle(d, win, gc, x, y, w, h) \
2982 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
2983 #endif /* ! HAVE_GTK3 */
2984 #else /* ! USE_GTK */
2985 GC gc;
2987 /* Create a GC that will use the GXxor function to flip foreground
2988 pixels into background pixels. */
2990 XGCValues values;
2992 values.function = GXxor;
2993 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
2994 ^ FRAME_BACKGROUND_PIXEL (f));
2996 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2997 GCFunction | GCForeground, &values);
2999 #endif
3001 /* Get the height not including a menu bar widget. */
3002 int height = FRAME_PIXEL_HEIGHT (f);
3003 /* Height of each line to flash. */
3004 int flash_height = FRAME_LINE_HEIGHT (f);
3005 /* These will be the left and right margins of the rectangles. */
3006 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3007 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3008 int width = flash_right - flash_left;
3010 /* If window is tall, flash top and bottom line. */
3011 if (height > 3 * FRAME_LINE_HEIGHT (f))
3013 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3014 flash_left,
3015 (FRAME_INTERNAL_BORDER_WIDTH (f)
3016 + FRAME_TOP_MARGIN_HEIGHT (f)),
3017 width, flash_height);
3018 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3019 flash_left,
3020 (height - flash_height
3021 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3022 width, flash_height);
3025 else
3026 /* If it is short, flash it all. */
3027 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3028 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3029 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3031 x_flush (f);
3034 struct timespec delay = make_timespec (0, 150 * 1000 * 1000);
3035 struct timespec wakeup = timespec_add (current_timespec (), delay);
3037 /* Keep waiting until past the time wakeup or any input gets
3038 available. */
3039 while (! detect_input_pending ())
3041 struct timespec current = current_timespec ();
3042 struct timespec timeout;
3044 /* Break if result would not be positive. */
3045 if (timespec_cmp (wakeup, current) <= 0)
3046 break;
3048 /* How long `select' should wait. */
3049 timeout = make_timespec (0, 10 * 1000 * 1000);
3051 /* Try to wait that long--but we might wake up sooner. */
3052 pselect (0, NULL, NULL, NULL, &timeout, NULL);
3056 /* If window is tall, flash top and bottom line. */
3057 if (height > 3 * FRAME_LINE_HEIGHT (f))
3059 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3060 flash_left,
3061 (FRAME_INTERNAL_BORDER_WIDTH (f)
3062 + FRAME_TOP_MARGIN_HEIGHT (f)),
3063 width, flash_height);
3064 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3065 flash_left,
3066 (height - flash_height
3067 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3068 width, flash_height);
3070 else
3071 /* If it is short, flash it all. */
3072 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3073 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3074 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3076 #ifdef USE_GTK
3077 #ifdef HAVE_GTK3
3078 cairo_destroy (cr);
3079 #else
3080 g_object_unref (G_OBJECT (gc));
3081 #endif
3082 #undef XFillRectangle
3083 #else
3084 XFreeGC (FRAME_X_DISPLAY (f), gc);
3085 #endif
3086 x_flush (f);
3090 unblock_input ();
3094 static void
3095 XTtoggle_invisible_pointer (struct frame *f, int invisible)
3097 block_input ();
3098 if (invisible)
3100 if (FRAME_DISPLAY_INFO (f)->invisible_cursor != 0)
3101 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3102 FRAME_DISPLAY_INFO (f)->invisible_cursor);
3104 else
3105 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3106 f->output_data.x->current_cursor);
3107 f->pointer_invisible = invisible;
3108 unblock_input ();
3112 /* Make audible bell. */
3114 static void
3115 XTring_bell (struct frame *f)
3117 if (FRAME_X_DISPLAY (f))
3119 if (visible_bell)
3120 XTflash (f);
3121 else
3123 block_input ();
3124 #ifdef HAVE_XKB
3125 XkbBell (FRAME_X_DISPLAY (f), None, 0, None);
3126 #else
3127 XBell (FRAME_X_DISPLAY (f), 0);
3128 #endif
3129 XFlush (FRAME_X_DISPLAY (f));
3130 unblock_input ();
3135 /***********************************************************************
3136 Line Dance
3137 ***********************************************************************/
3139 /* Perform an insert-lines or delete-lines operation, inserting N
3140 lines or deleting -N lines at vertical position VPOS. */
3142 static void
3143 x_ins_del_lines (struct frame *f, int vpos, int n)
3145 emacs_abort ();
3149 /* Scroll part of the display as described by RUN. */
3151 static void
3152 x_scroll_run (struct window *w, struct run *run)
3154 struct frame *f = XFRAME (w->frame);
3155 int x, y, width, height, from_y, to_y, bottom_y;
3157 /* Get frame-relative bounding box of the text display area of W,
3158 without mode lines. Include in this box the left and right
3159 fringe of W. */
3160 window_box (w, ANY_AREA, &x, &y, &width, &height);
3162 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3163 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3164 bottom_y = y + height;
3166 if (to_y < from_y)
3168 /* Scrolling up. Make sure we don't copy part of the mode
3169 line at the bottom. */
3170 if (from_y + run->height > bottom_y)
3171 height = bottom_y - from_y;
3172 else
3173 height = run->height;
3175 else
3177 /* Scrolling down. Make sure we don't copy over the mode line.
3178 at the bottom. */
3179 if (to_y + run->height > bottom_y)
3180 height = bottom_y - to_y;
3181 else
3182 height = run->height;
3185 block_input ();
3187 /* Cursor off. Will be switched on again in x_update_window_end. */
3188 x_clear_cursor (w);
3190 XCopyArea (FRAME_X_DISPLAY (f),
3191 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3192 f->output_data.x->normal_gc,
3193 x, from_y,
3194 width, height,
3195 x, to_y);
3197 unblock_input ();
3202 /***********************************************************************
3203 Exposure Events
3204 ***********************************************************************/
3207 static void
3208 frame_highlight (struct frame *f)
3210 /* We used to only do this if Vx_no_window_manager was non-nil, but
3211 the ICCCM (section 4.1.6) says that the window's border pixmap
3212 and border pixel are window attributes which are "private to the
3213 client", so we can always change it to whatever we want. */
3214 block_input ();
3215 /* I recently started to get errors in this XSetWindowBorder, depending on
3216 the window-manager in use, tho something more is at play since I've been
3217 using that same window-manager binary for ever. Let's not crash just
3218 because of this (bug#9310). */
3219 x_catch_errors (FRAME_X_DISPLAY (f));
3220 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3221 f->output_data.x->border_pixel);
3222 x_uncatch_errors ();
3223 unblock_input ();
3224 x_update_cursor (f, 1);
3225 x_set_frame_alpha (f);
3228 static void
3229 frame_unhighlight (struct frame *f)
3231 /* We used to only do this if Vx_no_window_manager was non-nil, but
3232 the ICCCM (section 4.1.6) says that the window's border pixmap
3233 and border pixel are window attributes which are "private to the
3234 client", so we can always change it to whatever we want. */
3235 block_input ();
3236 /* Same as above for XSetWindowBorder (bug#9310). */
3237 x_catch_errors (FRAME_X_DISPLAY (f));
3238 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3239 f->output_data.x->border_tile);
3240 x_uncatch_errors ();
3241 unblock_input ();
3242 x_update_cursor (f, 1);
3243 x_set_frame_alpha (f);
3246 /* The focus has changed. Update the frames as necessary to reflect
3247 the new situation. Note that we can't change the selected frame
3248 here, because the Lisp code we are interrupting might become confused.
3249 Each event gets marked with the frame in which it occurred, so the
3250 Lisp code can tell when the switch took place by examining the events. */
3252 static void
3253 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3255 struct frame *old_focus = dpyinfo->x_focus_frame;
3257 if (frame != dpyinfo->x_focus_frame)
3259 /* Set this before calling other routines, so that they see
3260 the correct value of x_focus_frame. */
3261 dpyinfo->x_focus_frame = frame;
3263 if (old_focus && old_focus->auto_lower)
3264 x_lower_frame (old_focus);
3266 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3267 dpyinfo->x_pending_autoraise_frame = dpyinfo->x_focus_frame;
3268 else
3269 dpyinfo->x_pending_autoraise_frame = NULL;
3272 x_frame_rehighlight (dpyinfo);
3275 /* Handle FocusIn and FocusOut state changes for FRAME.
3276 If FRAME has focus and there exists more than one frame, puts
3277 a FOCUS_IN_EVENT into *BUFP. */
3279 static void
3280 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3282 if (type == FocusIn)
3284 if (dpyinfo->x_focus_event_frame != frame)
3286 x_new_focus_frame (dpyinfo, frame);
3287 dpyinfo->x_focus_event_frame = frame;
3289 /* Don't stop displaying the initial startup message
3290 for a switch-frame event we don't need. */
3291 /* When run as a daemon, Vterminal_frame is always NIL. */
3292 bufp->arg = (((NILP (Vterminal_frame)
3293 || ! FRAME_X_P (XFRAME (Vterminal_frame))
3294 || EQ (Fdaemonp (), Qt))
3295 && CONSP (Vframe_list)
3296 && !NILP (XCDR (Vframe_list)))
3297 ? Qt : Qnil);
3298 bufp->kind = FOCUS_IN_EVENT;
3299 XSETFRAME (bufp->frame_or_window, frame);
3302 frame->output_data.x->focus_state |= state;
3304 #ifdef HAVE_X_I18N
3305 if (FRAME_XIC (frame))
3306 XSetICFocus (FRAME_XIC (frame));
3307 #endif
3309 else if (type == FocusOut)
3311 frame->output_data.x->focus_state &= ~state;
3313 if (dpyinfo->x_focus_event_frame == frame)
3315 dpyinfo->x_focus_event_frame = 0;
3316 x_new_focus_frame (dpyinfo, 0);
3318 bufp->kind = FOCUS_OUT_EVENT;
3319 XSETFRAME (bufp->frame_or_window, frame);
3322 #ifdef HAVE_X_I18N
3323 if (FRAME_XIC (frame))
3324 XUnsetICFocus (FRAME_XIC (frame));
3325 #endif
3326 if (frame->pointer_invisible)
3327 XTtoggle_invisible_pointer (frame, 0);
3331 /* Return the Emacs frame-object corresponding to an X window.
3332 It could be the frame's main window or an icon window. */
3334 static struct frame *
3335 x_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
3337 Lisp_Object tail, frame;
3338 struct frame *f;
3340 if (wdesc == None)
3341 return NULL;
3343 FOR_EACH_FRAME (tail, frame)
3345 f = XFRAME (frame);
3346 if (!FRAME_X_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
3347 continue;
3348 if (f->output_data.x->hourglass_window == wdesc)
3349 return f;
3350 #ifdef USE_X_TOOLKIT
3351 if ((f->output_data.x->edit_widget
3352 && XtWindow (f->output_data.x->edit_widget) == wdesc)
3353 /* A tooltip frame? */
3354 || (!f->output_data.x->edit_widget
3355 && FRAME_X_WINDOW (f) == wdesc)
3356 || f->output_data.x->icon_desc == wdesc)
3357 return f;
3358 #else /* not USE_X_TOOLKIT */
3359 #ifdef USE_GTK
3360 if (f->output_data.x->edit_widget)
3362 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
3363 struct x_output *x = f->output_data.x;
3364 if (gwdesc != 0 && gwdesc == x->edit_widget)
3365 return f;
3367 #endif /* USE_GTK */
3368 if (FRAME_X_WINDOW (f) == wdesc
3369 || f->output_data.x->icon_desc == wdesc)
3370 return f;
3371 #endif /* not USE_X_TOOLKIT */
3373 return 0;
3376 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3378 /* Like x_window_to_frame but also compares the window with the widget's
3379 windows. */
3381 static struct frame *
3382 x_any_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
3384 Lisp_Object tail, frame;
3385 struct frame *f, *found = NULL;
3386 struct x_output *x;
3388 if (wdesc == None)
3389 return NULL;
3391 FOR_EACH_FRAME (tail, frame)
3393 if (found)
3394 break;
3395 f = XFRAME (frame);
3396 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo)
3398 /* This frame matches if the window is any of its widgets. */
3399 x = f->output_data.x;
3400 if (x->hourglass_window == wdesc)
3401 found = f;
3402 else if (x->widget)
3404 #ifdef USE_GTK
3405 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
3406 if (gwdesc != 0
3407 && gtk_widget_get_toplevel (gwdesc) == x->widget)
3408 found = f;
3409 #else
3410 if (wdesc == XtWindow (x->widget)
3411 || wdesc == XtWindow (x->column_widget)
3412 || wdesc == XtWindow (x->edit_widget))
3413 found = f;
3414 /* Match if the window is this frame's menubar. */
3415 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
3416 found = f;
3417 #endif
3419 else if (FRAME_X_WINDOW (f) == wdesc)
3420 /* A tooltip frame. */
3421 found = f;
3425 return found;
3428 /* Likewise, but consider only the menu bar widget. */
3430 static struct frame *
3431 x_menubar_window_to_frame (struct x_display_info *dpyinfo,
3432 const XEvent *event)
3434 Window wdesc = event->xany.window;
3435 Lisp_Object tail, frame;
3436 struct frame *f;
3437 struct x_output *x;
3439 if (wdesc == None)
3440 return NULL;
3442 FOR_EACH_FRAME (tail, frame)
3444 f = XFRAME (frame);
3445 if (!FRAME_X_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
3446 continue;
3447 x = f->output_data.x;
3448 #ifdef USE_GTK
3449 if (x->menubar_widget && xg_event_is_for_menubar (f, event))
3450 return f;
3451 #else
3452 /* Match if the window is this frame's menubar. */
3453 if (x->menubar_widget
3454 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
3455 return f;
3456 #endif
3458 return 0;
3461 /* Return the frame whose principal (outermost) window is WDESC.
3462 If WDESC is some other (smaller) window, we return 0. */
3464 struct frame *
3465 x_top_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
3467 Lisp_Object tail, frame;
3468 struct frame *f;
3469 struct x_output *x;
3471 if (wdesc == None)
3472 return NULL;
3474 FOR_EACH_FRAME (tail, frame)
3476 f = XFRAME (frame);
3477 if (!FRAME_X_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
3478 continue;
3479 x = f->output_data.x;
3481 if (x->widget)
3483 /* This frame matches if the window is its topmost widget. */
3484 #ifdef USE_GTK
3485 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
3486 if (gwdesc == x->widget)
3487 return f;
3488 #else
3489 if (wdesc == XtWindow (x->widget))
3490 return f;
3491 #endif
3493 else if (FRAME_X_WINDOW (f) == wdesc)
3494 /* Tooltip frame. */
3495 return f;
3497 return 0;
3500 #else /* !USE_X_TOOLKIT && !USE_GTK */
3502 #define x_any_window_to_frame(d, i) x_window_to_frame (d, i)
3503 #define x_top_window_to_frame(d, i) x_window_to_frame (d, i)
3505 #endif /* USE_X_TOOLKIT || USE_GTK */
3507 /* The focus may have changed. Figure out if it is a real focus change,
3508 by checking both FocusIn/Out and Enter/LeaveNotify events.
3510 Returns FOCUS_IN_EVENT event in *BUFP. */
3512 static void
3513 x_detect_focus_change (struct x_display_info *dpyinfo, struct frame *frame,
3514 const XEvent *event, struct input_event *bufp)
3516 if (!frame)
3517 return;
3519 switch (event->type)
3521 case EnterNotify:
3522 case LeaveNotify:
3524 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3525 int focus_state
3526 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3528 if (event->xcrossing.detail != NotifyInferior
3529 && event->xcrossing.focus
3530 && ! (focus_state & FOCUS_EXPLICIT))
3531 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3532 FOCUS_IMPLICIT,
3533 dpyinfo, frame, bufp);
3535 break;
3537 case FocusIn:
3538 case FocusOut:
3539 x_focus_changed (event->type,
3540 (event->xfocus.detail == NotifyPointer ?
3541 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3542 dpyinfo, frame, bufp);
3543 break;
3545 case ClientMessage:
3546 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3548 enum xembed_message msg = event->xclient.data.l[1];
3549 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3550 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3552 break;
3557 #if !defined USE_X_TOOLKIT && !defined USE_GTK
3558 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3560 void
3561 x_mouse_leave (struct x_display_info *dpyinfo)
3563 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3565 #endif
3567 /* The focus has changed, or we have redirected a frame's focus to
3568 another frame (this happens when a frame uses a surrogate
3569 mini-buffer frame). Shift the highlight as appropriate.
3571 The FRAME argument doesn't necessarily have anything to do with which
3572 frame is being highlighted or un-highlighted; we only use it to find
3573 the appropriate X display info. */
3575 static void
3576 XTframe_rehighlight (struct frame *frame)
3578 x_frame_rehighlight (FRAME_DISPLAY_INFO (frame));
3581 static void
3582 x_frame_rehighlight (struct x_display_info *dpyinfo)
3584 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3586 if (dpyinfo->x_focus_frame)
3588 dpyinfo->x_highlight_frame
3589 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3590 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3591 : dpyinfo->x_focus_frame);
3592 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3594 fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
3595 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3598 else
3599 dpyinfo->x_highlight_frame = 0;
3601 if (dpyinfo->x_highlight_frame != old_highlight)
3603 if (old_highlight)
3604 frame_unhighlight (old_highlight);
3605 if (dpyinfo->x_highlight_frame)
3606 frame_highlight (dpyinfo->x_highlight_frame);
3612 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3614 /* Initialize mode_switch_bit and modifier_meaning. */
3615 static void
3616 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3618 int min_code, max_code;
3619 KeySym *syms;
3620 int syms_per_code;
3621 XModifierKeymap *mods;
3623 dpyinfo->meta_mod_mask = 0;
3624 dpyinfo->shift_lock_mask = 0;
3625 dpyinfo->alt_mod_mask = 0;
3626 dpyinfo->super_mod_mask = 0;
3627 dpyinfo->hyper_mod_mask = 0;
3629 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3631 syms = XGetKeyboardMapping (dpyinfo->display,
3632 min_code, max_code - min_code + 1,
3633 &syms_per_code);
3634 mods = XGetModifierMapping (dpyinfo->display);
3636 /* Scan the modifier table to see which modifier bits the Meta and
3637 Alt keysyms are on. */
3639 int row, col; /* The row and column in the modifier table. */
3640 int found_alt_or_meta;
3642 for (row = 3; row < 8; row++)
3644 found_alt_or_meta = 0;
3645 for (col = 0; col < mods->max_keypermod; col++)
3647 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3649 /* Zeroes are used for filler. Skip them. */
3650 if (code == 0)
3651 continue;
3653 /* Are any of this keycode's keysyms a meta key? */
3655 int code_col;
3657 for (code_col = 0; code_col < syms_per_code; code_col++)
3659 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3661 switch (sym)
3663 case XK_Meta_L:
3664 case XK_Meta_R:
3665 found_alt_or_meta = 1;
3666 dpyinfo->meta_mod_mask |= (1 << row);
3667 break;
3669 case XK_Alt_L:
3670 case XK_Alt_R:
3671 found_alt_or_meta = 1;
3672 dpyinfo->alt_mod_mask |= (1 << row);
3673 break;
3675 case XK_Hyper_L:
3676 case XK_Hyper_R:
3677 if (!found_alt_or_meta)
3678 dpyinfo->hyper_mod_mask |= (1 << row);
3679 code_col = syms_per_code;
3680 col = mods->max_keypermod;
3681 break;
3683 case XK_Super_L:
3684 case XK_Super_R:
3685 if (!found_alt_or_meta)
3686 dpyinfo->super_mod_mask |= (1 << row);
3687 code_col = syms_per_code;
3688 col = mods->max_keypermod;
3689 break;
3691 case XK_Shift_Lock:
3692 /* Ignore this if it's not on the lock modifier. */
3693 if (!found_alt_or_meta && ((1 << row) == LockMask))
3694 dpyinfo->shift_lock_mask = LockMask;
3695 code_col = syms_per_code;
3696 col = mods->max_keypermod;
3697 break;
3705 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3706 if (! dpyinfo->meta_mod_mask)
3708 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3709 dpyinfo->alt_mod_mask = 0;
3712 /* If some keys are both alt and meta,
3713 make them just meta, not alt. */
3714 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3716 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3719 XFree (syms);
3720 XFreeModifiermap (mods);
3723 /* Convert between the modifier bits X uses and the modifier bits
3724 Emacs uses. */
3727 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
3729 int mod_meta = meta_modifier;
3730 int mod_alt = alt_modifier;
3731 int mod_hyper = hyper_modifier;
3732 int mod_super = super_modifier;
3733 Lisp_Object tem;
3735 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3736 if (INTEGERP (tem)) mod_alt = XINT (tem) & INT_MAX;
3737 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3738 if (INTEGERP (tem)) mod_meta = XINT (tem) & INT_MAX;
3739 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3740 if (INTEGERP (tem)) mod_hyper = XINT (tem) & INT_MAX;
3741 tem = Fget (Vx_super_keysym, Qmodifier_value);
3742 if (INTEGERP (tem)) mod_super = XINT (tem) & INT_MAX;
3744 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3745 | ((state & ControlMask) ? ctrl_modifier : 0)
3746 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3747 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3748 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3749 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3752 static int
3753 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
3755 EMACS_INT mod_meta = meta_modifier;
3756 EMACS_INT mod_alt = alt_modifier;
3757 EMACS_INT mod_hyper = hyper_modifier;
3758 EMACS_INT mod_super = super_modifier;
3760 Lisp_Object tem;
3762 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3763 if (INTEGERP (tem)) mod_alt = XINT (tem);
3764 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3765 if (INTEGERP (tem)) mod_meta = XINT (tem);
3766 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3767 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3768 tem = Fget (Vx_super_keysym, Qmodifier_value);
3769 if (INTEGERP (tem)) mod_super = XINT (tem);
3772 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3773 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3774 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3775 | ((state & shift_modifier) ? ShiftMask : 0)
3776 | ((state & ctrl_modifier) ? ControlMask : 0)
3777 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3780 /* Convert a keysym to its name. */
3782 char *
3783 x_get_keysym_name (int keysym)
3785 char *value;
3787 block_input ();
3788 value = XKeysymToString (keysym);
3789 unblock_input ();
3791 return value;
3794 /* Mouse clicks and mouse movement. Rah.
3796 Formerly, we used PointerMotionHintMask (in standard_event_mask)
3797 so that we would have to call XQueryPointer after each MotionNotify
3798 event to ask for another such event. However, this made mouse tracking
3799 slow, and there was a bug that made it eventually stop.
3801 Simply asking for MotionNotify all the time seems to work better.
3803 In order to avoid asking for motion events and then throwing most
3804 of them away or busy-polling the server for mouse positions, we ask
3805 the server for pointer motion hints. This means that we get only
3806 one event per group of mouse movements. "Groups" are delimited by
3807 other kinds of events (focus changes and button clicks, for
3808 example), or by XQueryPointer calls; when one of these happens, we
3809 get another MotionNotify event the next time the mouse moves. This
3810 is at least as efficient as getting motion events when mouse
3811 tracking is on, and I suspect only negligibly worse when tracking
3812 is off. */
3814 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3816 If the event is a button press, then note that we have grabbed
3817 the mouse. */
3819 static Lisp_Object
3820 construct_mouse_click (struct input_event *result,
3821 const XButtonEvent *event,
3822 struct frame *f)
3824 /* Make the event type NO_EVENT; we'll change that when we decide
3825 otherwise. */
3826 result->kind = MOUSE_CLICK_EVENT;
3827 result->code = event->button - Button1;
3828 result->timestamp = event->time;
3829 result->modifiers = (x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO (f),
3830 event->state)
3831 | (event->type == ButtonRelease
3832 ? up_modifier
3833 : down_modifier));
3835 XSETINT (result->x, event->x);
3836 XSETINT (result->y, event->y);
3837 XSETFRAME (result->frame_or_window, f);
3838 result->arg = Qnil;
3839 return Qnil;
3842 /* Function to report a mouse movement to the mainstream Emacs code.
3843 The input handler calls this.
3845 We have received a mouse movement event, which is given in *event.
3846 If the mouse is over a different glyph than it was last time, tell
3847 the mainstream emacs code by setting mouse_moved. If not, ask for
3848 another motion event, so we can check again the next time it moves. */
3850 static int
3851 note_mouse_movement (struct frame *frame, const XMotionEvent *event)
3853 XRectangle *r;
3854 struct x_display_info *dpyinfo;
3856 if (!FRAME_X_OUTPUT (frame))
3857 return 0;
3859 dpyinfo = FRAME_DISPLAY_INFO (frame);
3860 dpyinfo->last_mouse_movement_time = event->time;
3861 dpyinfo->last_mouse_motion_frame = frame;
3862 dpyinfo->last_mouse_motion_x = event->x;
3863 dpyinfo->last_mouse_motion_y = event->y;
3865 if (event->window != FRAME_X_WINDOW (frame))
3867 frame->mouse_moved = 1;
3868 dpyinfo->last_mouse_scroll_bar = NULL;
3869 note_mouse_highlight (frame, -1, -1);
3870 dpyinfo->last_mouse_glyph_frame = NULL;
3871 return 1;
3875 /* Has the mouse moved off the glyph it was on at the last sighting? */
3876 r = &dpyinfo->last_mouse_glyph;
3877 if (frame != dpyinfo->last_mouse_glyph_frame
3878 || event->x < r->x || event->x >= r->x + r->width
3879 || event->y < r->y || event->y >= r->y + r->height)
3881 frame->mouse_moved = 1;
3882 dpyinfo->last_mouse_scroll_bar = NULL;
3883 note_mouse_highlight (frame, event->x, event->y);
3884 /* Remember which glyph we're now on. */
3885 remember_mouse_glyph (frame, event->x, event->y, r);
3886 dpyinfo->last_mouse_glyph_frame = frame;
3887 return 1;
3890 return 0;
3893 /* Return the current position of the mouse.
3894 *FP should be a frame which indicates which display to ask about.
3896 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3897 and *PART to the frame, window, and scroll bar part that the mouse
3898 is over. Set *X and *Y to the portion and whole of the mouse's
3899 position on the scroll bar.
3901 If the mouse movement started elsewhere, set *FP to the frame the
3902 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3903 the mouse is over.
3905 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
3906 was at this position.
3908 Don't store anything if we don't have a valid set of values to report.
3910 This clears the mouse_moved flag, so we can wait for the next mouse
3911 movement. */
3913 static void
3914 XTmouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
3915 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
3916 Time *timestamp)
3918 struct frame *f1;
3919 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (*fp);
3921 block_input ();
3923 if (dpyinfo->last_mouse_scroll_bar && insist == 0)
3924 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
3925 else
3927 Window root;
3928 int root_x, root_y;
3930 Window dummy_window;
3931 int dummy;
3933 Lisp_Object frame, tail;
3935 /* Clear the mouse-moved flag for every frame on this display. */
3936 FOR_EACH_FRAME (tail, frame)
3937 if (FRAME_X_P (XFRAME (frame))
3938 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3939 XFRAME (frame)->mouse_moved = 0;
3941 dpyinfo->last_mouse_scroll_bar = NULL;
3943 /* Figure out which root window we're on. */
3944 XQueryPointer (FRAME_X_DISPLAY (*fp),
3945 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3947 /* The root window which contains the pointer. */
3948 &root,
3950 /* Trash which we can't trust if the pointer is on
3951 a different screen. */
3952 &dummy_window,
3954 /* The position on that root window. */
3955 &root_x, &root_y,
3957 /* More trash we can't trust. */
3958 &dummy, &dummy,
3960 /* Modifier keys and pointer buttons, about which
3961 we don't care. */
3962 (unsigned int *) &dummy);
3964 /* Now we have a position on the root; find the innermost window
3965 containing the pointer. */
3967 Window win, child;
3968 int win_x, win_y;
3969 int parent_x = 0, parent_y = 0;
3971 win = root;
3973 /* XTranslateCoordinates can get errors if the window
3974 structure is changing at the same time this function
3975 is running. So at least we must not crash from them. */
3977 x_catch_errors (FRAME_X_DISPLAY (*fp));
3979 if (x_mouse_grabbed (dpyinfo))
3981 /* If mouse was grabbed on a frame, give coords for that frame
3982 even if the mouse is now outside it. */
3983 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3985 /* From-window. */
3986 root,
3988 /* To-window. */
3989 FRAME_X_WINDOW (dpyinfo->last_mouse_frame),
3991 /* From-position, to-position. */
3992 root_x, root_y, &win_x, &win_y,
3994 /* Child of win. */
3995 &child);
3996 f1 = dpyinfo->last_mouse_frame;
3998 else
4000 while (1)
4002 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
4004 /* From-window, to-window. */
4005 root, win,
4007 /* From-position, to-position. */
4008 root_x, root_y, &win_x, &win_y,
4010 /* Child of win. */
4011 &child);
4013 if (child == None || child == win)
4014 break;
4015 #ifdef USE_GTK
4016 /* We don't wan't to know the innermost window. We
4017 want the edit window. For non-Gtk+ the innermost
4018 window is the edit window. For Gtk+ it might not
4019 be. It might be the tool bar for example. */
4020 if (x_window_to_frame (dpyinfo, win))
4021 break;
4022 #endif
4023 win = child;
4024 parent_x = win_x;
4025 parent_y = win_y;
4028 /* Now we know that:
4029 win is the innermost window containing the pointer
4030 (XTC says it has no child containing the pointer),
4031 win_x and win_y are the pointer's position in it
4032 (XTC did this the last time through), and
4033 parent_x and parent_y are the pointer's position in win's parent.
4034 (They are what win_x and win_y were when win was child.
4035 If win is the root window, it has no parent, and
4036 parent_{x,y} are invalid, but that's okay, because we'll
4037 never use them in that case.) */
4039 #ifdef USE_GTK
4040 /* We don't wan't to know the innermost window. We
4041 want the edit window. */
4042 f1 = x_window_to_frame (dpyinfo, win);
4043 #else
4044 /* Is win one of our frames? */
4045 f1 = x_any_window_to_frame (dpyinfo, win);
4046 #endif
4048 #ifdef USE_X_TOOLKIT
4049 /* If we end up with the menu bar window, say it's not
4050 on the frame. */
4051 if (f1 != NULL
4052 && f1->output_data.x->menubar_widget
4053 && win == XtWindow (f1->output_data.x->menubar_widget))
4054 f1 = NULL;
4055 #endif /* USE_X_TOOLKIT */
4058 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
4059 f1 = 0;
4061 x_uncatch_errors ();
4063 /* If not, is it one of our scroll bars? */
4064 if (! f1)
4066 struct scroll_bar *bar;
4068 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
4070 if (bar)
4072 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4073 win_x = parent_x;
4074 win_y = parent_y;
4078 if (f1 == 0 && insist > 0)
4079 f1 = SELECTED_FRAME ();
4081 if (f1)
4083 /* Ok, we found a frame. Store all the values.
4084 last_mouse_glyph is a rectangle used to reduce the
4085 generation of mouse events. To not miss any motion
4086 events, we must divide the frame into rectangles of the
4087 size of the smallest character that could be displayed
4088 on it, i.e. into the same rectangles that matrices on
4089 the frame are divided into. */
4091 /* FIXME: what if F1 is not an X frame? */
4092 dpyinfo = FRAME_DISPLAY_INFO (f1);
4093 remember_mouse_glyph (f1, win_x, win_y, &dpyinfo->last_mouse_glyph);
4094 dpyinfo->last_mouse_glyph_frame = f1;
4096 *bar_window = Qnil;
4097 *part = 0;
4098 *fp = f1;
4099 XSETINT (*x, win_x);
4100 XSETINT (*y, win_y);
4101 *timestamp = dpyinfo->last_mouse_movement_time;
4106 unblock_input ();
4111 /***********************************************************************
4112 Scroll bars
4113 ***********************************************************************/
4115 /* Scroll bar support. */
4117 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4118 manages it.
4119 This can be called in GC, so we have to make sure to strip off mark
4120 bits. */
4122 static struct scroll_bar *
4123 x_window_to_scroll_bar (Display *display, Window window_id)
4125 Lisp_Object tail, frame;
4127 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4128 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4129 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4131 FOR_EACH_FRAME (tail, frame)
4133 Lisp_Object bar, condemned;
4135 if (! FRAME_X_P (XFRAME (frame)))
4136 continue;
4138 /* Scan this frame's scroll bar list for a scroll bar with the
4139 right window ID. */
4140 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4141 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4142 /* This trick allows us to search both the ordinary and
4143 condemned scroll bar lists with one loop. */
4144 ! NILP (bar) || (bar = condemned,
4145 condemned = Qnil,
4146 ! NILP (bar));
4147 bar = XSCROLL_BAR (bar)->next)
4148 if (XSCROLL_BAR (bar)->x_window == window_id &&
4149 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4150 return XSCROLL_BAR (bar);
4153 return NULL;
4157 #if defined USE_LUCID
4159 /* Return the Lucid menu bar WINDOW is part of. Return null
4160 if WINDOW is not part of a menu bar. */
4162 static Widget
4163 x_window_to_menu_bar (Window window)
4165 Lisp_Object tail, frame;
4167 FOR_EACH_FRAME (tail, frame)
4168 if (FRAME_X_P (XFRAME (frame)))
4170 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4172 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4173 return menu_bar;
4175 return NULL;
4178 #endif /* USE_LUCID */
4181 /************************************************************************
4182 Toolkit scroll bars
4183 ************************************************************************/
4185 #ifdef USE_TOOLKIT_SCROLL_BARS
4187 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4189 /* Lisp window being scrolled. Set when starting to interact with
4190 a toolkit scroll bar, reset to nil when ending the interaction. */
4192 static Lisp_Object window_being_scrolled;
4194 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4195 that movements of 1/20 of the screen size are mapped to up/down. */
4197 #ifndef USE_GTK
4198 /* Id of action hook installed for scroll bars. */
4200 static XtActionHookId action_hook_id;
4202 static Boolean xaw3d_arrow_scroll;
4204 /* Whether the drag scrolling maintains the mouse at the top of the
4205 thumb. If not, resizing the thumb needs to be done more carefully
4206 to avoid jerkiness. */
4208 static Boolean xaw3d_pick_top;
4210 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4211 bars are used.. The hook is responsible for detecting when
4212 the user ends an interaction with the scroll bar, and generates
4213 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4215 static void
4216 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4217 XEvent *event, String *params, Cardinal *num_params)
4219 int scroll_bar_p;
4220 const char *end_action;
4222 #ifdef USE_MOTIF
4223 scroll_bar_p = XmIsScrollBar (widget);
4224 end_action = "Release";
4225 #else /* !USE_MOTIF i.e. use Xaw */
4226 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4227 end_action = "EndScroll";
4228 #endif /* USE_MOTIF */
4230 if (scroll_bar_p
4231 && strcmp (action_name, end_action) == 0
4232 && WINDOWP (window_being_scrolled))
4234 struct window *w;
4235 struct scroll_bar *bar;
4237 x_send_scroll_bar_event (window_being_scrolled,
4238 scroll_bar_end_scroll, 0, 0);
4239 w = XWINDOW (window_being_scrolled);
4240 bar = XSCROLL_BAR (w->vertical_scroll_bar);
4242 if (bar->dragging != -1)
4244 bar->dragging = -1;
4245 /* The thumb size is incorrect while dragging: fix it. */
4246 set_vertical_scroll_bar (w);
4248 window_being_scrolled = Qnil;
4249 #if defined (USE_LUCID)
4250 bar->last_seen_part = scroll_bar_nowhere;
4251 #endif
4252 /* Xt timeouts no longer needed. */
4253 toolkit_scroll_bar_interaction = 0;
4256 #endif /* not USE_GTK */
4258 /* Send a client message with message type Xatom_Scrollbar for a
4259 scroll action to the frame of WINDOW. PART is a value identifying
4260 the part of the scroll bar that was clicked on. PORTION is the
4261 amount to scroll of a whole of WHOLE. */
4263 static void
4264 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4266 XEvent event;
4267 XClientMessageEvent *ev = &event.xclient;
4268 struct window *w = XWINDOW (window);
4269 struct frame *f = XFRAME (w->frame);
4270 intptr_t iw = (intptr_t) w;
4271 enum { BITS_PER_INTPTR = CHAR_BIT * sizeof iw };
4272 verify (BITS_PER_INTPTR <= 64);
4273 int sign_shift = BITS_PER_INTPTR - 32;
4275 block_input ();
4277 /* Construct a ClientMessage event to send to the frame. */
4278 ev->type = ClientMessage;
4279 ev->message_type = FRAME_DISPLAY_INFO (f)->Xatom_Scrollbar;
4280 ev->display = FRAME_X_DISPLAY (f);
4281 ev->window = FRAME_X_WINDOW (f);
4282 ev->format = 32;
4284 /* A 32-bit X client on a 64-bit X server can pass a window pointer
4285 as-is. A 64-bit client on a 32-bit X server is in trouble
4286 because a pointer does not fit and would be truncated while
4287 passing through the server. So use two slots and hope that X12
4288 will resolve such issues someday. */
4289 ev->data.l[0] = iw >> 31 >> 1;
4290 ev->data.l[1] = sign_shift <= 0 ? iw : iw << sign_shift >> sign_shift;
4291 ev->data.l[2] = part;
4292 ev->data.l[3] = portion;
4293 ev->data.l[4] = whole;
4295 /* Make Xt timeouts work while the scroll bar is active. */
4296 #ifdef USE_X_TOOLKIT
4297 toolkit_scroll_bar_interaction = 1;
4298 x_activate_timeout_atimer ();
4299 #endif
4301 /* Setting the event mask to zero means that the message will
4302 be sent to the client that created the window, and if that
4303 window no longer exists, no event will be sent. */
4304 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4305 unblock_input ();
4309 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4310 in *IEVENT. */
4312 static void
4313 x_scroll_bar_to_input_event (const XEvent *event,
4314 struct input_event *ievent)
4316 const XClientMessageEvent *ev = &event->xclient;
4317 Lisp_Object window;
4318 struct window *w;
4320 /* See the comment in the function above. */
4321 intptr_t iw0 = ev->data.l[0];
4322 intptr_t iw1 = ev->data.l[1];
4323 intptr_t iw = (iw0 << 31 << 1) + (iw1 & 0xffffffffu);
4324 w = (struct window *) iw;
4326 XSETWINDOW (window, w);
4328 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4329 ievent->frame_or_window = window;
4330 ievent->arg = Qnil;
4331 #ifdef USE_GTK
4332 ievent->timestamp = CurrentTime;
4333 #else
4334 ievent->timestamp =
4335 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
4336 #endif
4337 ievent->code = 0;
4338 ievent->part = ev->data.l[2];
4339 ievent->x = make_number (ev->data.l[3]);
4340 ievent->y = make_number (ev->data.l[4]);
4341 ievent->modifiers = 0;
4345 #ifdef USE_MOTIF
4347 /* Minimum and maximum values used for Motif scroll bars. */
4349 #define XM_SB_MAX 10000000
4352 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4353 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4354 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4356 static void
4357 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4359 struct scroll_bar *bar = client_data;
4360 XmScrollBarCallbackStruct *cs = call_data;
4361 int part = -1, whole = 0, portion = 0;
4363 switch (cs->reason)
4365 case XmCR_DECREMENT:
4366 bar->dragging = -1;
4367 part = scroll_bar_up_arrow;
4368 break;
4370 case XmCR_INCREMENT:
4371 bar->dragging = -1;
4372 part = scroll_bar_down_arrow;
4373 break;
4375 case XmCR_PAGE_DECREMENT:
4376 bar->dragging = -1;
4377 part = scroll_bar_above_handle;
4378 break;
4380 case XmCR_PAGE_INCREMENT:
4381 bar->dragging = -1;
4382 part = scroll_bar_below_handle;
4383 break;
4385 case XmCR_TO_TOP:
4386 bar->dragging = -1;
4387 part = scroll_bar_to_top;
4388 break;
4390 case XmCR_TO_BOTTOM:
4391 bar->dragging = -1;
4392 part = scroll_bar_to_bottom;
4393 break;
4395 case XmCR_DRAG:
4397 int slider_size;
4399 /* Get the slider size. */
4400 block_input ();
4401 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4402 unblock_input ();
4404 whole = XM_SB_MAX - slider_size;
4405 portion = min (cs->value, whole);
4406 part = scroll_bar_handle;
4407 bar->dragging = cs->value;
4409 break;
4411 case XmCR_VALUE_CHANGED:
4412 break;
4415 if (part >= 0)
4417 window_being_scrolled = bar->window;
4418 x_send_scroll_bar_event (bar->window, part, portion, whole);
4422 #elif defined USE_GTK
4424 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4425 bar widget. DATA is a pointer to the scroll_bar structure. */
4427 static gboolean
4428 xg_scroll_callback (GtkRange *range,
4429 GtkScrollType scroll,
4430 gdouble value,
4431 gpointer user_data)
4433 struct scroll_bar *bar = user_data;
4434 gdouble position;
4435 int part = -1, whole = 0, portion = 0;
4436 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4437 struct frame *f = g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4439 if (xg_ignore_gtk_scrollbar) return FALSE;
4440 position = gtk_adjustment_get_value (adj);
4443 switch (scroll)
4445 case GTK_SCROLL_JUMP:
4446 /* Buttons 1 2 or 3 must be grabbed. */
4447 if (FRAME_DISPLAY_INFO (f)->grabbed != 0
4448 && FRAME_DISPLAY_INFO (f)->grabbed < (1 << 4))
4450 part = scroll_bar_handle;
4451 whole = gtk_adjustment_get_upper (adj) -
4452 gtk_adjustment_get_page_size (adj);
4453 portion = min ((int)position, whole);
4454 bar->dragging = portion;
4456 break;
4457 case GTK_SCROLL_STEP_BACKWARD:
4458 part = scroll_bar_up_arrow;
4459 bar->dragging = -1;
4460 break;
4461 case GTK_SCROLL_STEP_FORWARD:
4462 part = scroll_bar_down_arrow;
4463 bar->dragging = -1;
4464 break;
4465 case GTK_SCROLL_PAGE_BACKWARD:
4466 part = scroll_bar_above_handle;
4467 bar->dragging = -1;
4468 break;
4469 case GTK_SCROLL_PAGE_FORWARD:
4470 part = scroll_bar_below_handle;
4471 bar->dragging = -1;
4472 break;
4475 if (part >= 0)
4477 window_being_scrolled = bar->window;
4478 x_send_scroll_bar_event (bar->window, part, portion, whole);
4481 return FALSE;
4484 /* Callback for button release. Sets dragging to -1 when dragging is done. */
4486 static gboolean
4487 xg_end_scroll_callback (GtkWidget *widget,
4488 GdkEventButton *event,
4489 gpointer user_data)
4491 struct scroll_bar *bar = user_data;
4492 bar->dragging = -1;
4493 if (WINDOWP (window_being_scrolled))
4495 x_send_scroll_bar_event (window_being_scrolled,
4496 scroll_bar_end_scroll, 0, 0);
4497 window_being_scrolled = Qnil;
4500 return FALSE;
4504 #else /* not USE_GTK and not USE_MOTIF */
4506 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4507 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4508 scroll bar struct. CALL_DATA is a pointer to a float saying where
4509 the thumb is. */
4511 static void
4512 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4514 struct scroll_bar *bar = client_data;
4515 float *top_addr = call_data;
4516 float top = *top_addr;
4517 float shown;
4518 int whole, portion, height;
4519 enum scroll_bar_part part;
4521 /* Get the size of the thumb, a value between 0 and 1. */
4522 block_input ();
4523 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4524 unblock_input ();
4526 whole = 10000000;
4527 portion = shown < 1 ? top * whole : 0;
4529 if (shown < 1 && (eabs (top + shown - 1) < 1.0f / height))
4530 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4531 the bottom, so we force the scrolling whenever we see that we're
4532 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4533 we try to ensure that we always stay two pixels away from the
4534 bottom). */
4535 part = scroll_bar_down_arrow;
4536 else
4537 part = scroll_bar_handle;
4539 window_being_scrolled = bar->window;
4540 bar->dragging = portion;
4541 bar->last_seen_part = part;
4542 x_send_scroll_bar_event (bar->window, part, portion, whole);
4546 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4547 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4548 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4549 the scroll bar. CALL_DATA is an integer specifying the action that
4550 has taken place. Its magnitude is in the range 0..height of the
4551 scroll bar. Negative values mean scroll towards buffer start.
4552 Values < height of scroll bar mean line-wise movement. */
4554 static void
4555 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4557 struct scroll_bar *bar = client_data;
4558 /* The position really is stored cast to a pointer. */
4559 int position = (intptr_t) call_data;
4560 Dimension height;
4561 enum scroll_bar_part part;
4563 /* Get the height of the scroll bar. */
4564 block_input ();
4565 XtVaGetValues (widget, XtNheight, &height, NULL);
4566 unblock_input ();
4568 if (eabs (position) >= height)
4569 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4571 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4572 it maps line-movement to call_data = max(5, height/20). */
4573 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4574 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4575 else
4576 part = scroll_bar_move_ratio;
4578 window_being_scrolled = bar->window;
4579 bar->dragging = -1;
4580 bar->last_seen_part = part;
4581 x_send_scroll_bar_event (bar->window, part, position, height);
4584 #endif /* not USE_GTK and not USE_MOTIF */
4586 #define SCROLL_BAR_NAME "verticalScrollBar"
4588 /* Create the widget for scroll bar BAR on frame F. Record the widget
4589 and X window of the scroll bar in BAR. */
4591 #ifdef USE_GTK
4592 static void
4593 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4595 const char *scroll_bar_name = SCROLL_BAR_NAME;
4597 block_input ();
4598 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4599 G_CALLBACK (xg_end_scroll_callback),
4600 scroll_bar_name);
4601 unblock_input ();
4604 #else /* not USE_GTK */
4606 static void
4607 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4609 Window xwindow;
4610 Widget widget;
4611 Arg av[20];
4612 int ac = 0;
4613 const char *scroll_bar_name = SCROLL_BAR_NAME;
4614 unsigned long pixel;
4616 block_input ();
4618 #ifdef USE_MOTIF
4619 /* Set resources. Create the widget. */
4620 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4621 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4622 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4623 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4624 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4625 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4626 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4628 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4629 if (pixel != -1)
4631 XtSetArg (av[ac], XmNforeground, pixel);
4632 ++ac;
4635 pixel = f->output_data.x->scroll_bar_background_pixel;
4636 if (pixel != -1)
4638 XtSetArg (av[ac], XmNbackground, pixel);
4639 ++ac;
4642 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4643 (char *) scroll_bar_name, av, ac);
4645 /* Add one callback for everything that can happen. */
4646 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4647 (XtPointer) bar);
4648 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4649 (XtPointer) bar);
4650 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4651 (XtPointer) bar);
4652 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4653 (XtPointer) bar);
4654 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4655 (XtPointer) bar);
4656 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4657 (XtPointer) bar);
4658 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4659 (XtPointer) bar);
4661 /* Realize the widget. Only after that is the X window created. */
4662 XtRealizeWidget (widget);
4664 /* Set the cursor to an arrow. I didn't find a resource to do that.
4665 And I'm wondering why it hasn't an arrow cursor by default. */
4666 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4667 f->output_data.x->nontext_cursor);
4669 #else /* !USE_MOTIF i.e. use Xaw */
4671 /* Set resources. Create the widget. The background of the
4672 Xaw3d scroll bar widget is a little bit light for my taste.
4673 We don't alter it here to let users change it according
4674 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4675 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4676 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4677 /* For smoother scrolling with Xaw3d -sm */
4678 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4680 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4681 if (pixel != -1)
4683 XtSetArg (av[ac], XtNforeground, pixel);
4684 ++ac;
4687 pixel = f->output_data.x->scroll_bar_background_pixel;
4688 if (pixel != -1)
4690 XtSetArg (av[ac], XtNbackground, pixel);
4691 ++ac;
4694 /* Top/bottom shadow colors. */
4696 /* Allocate them, if necessary. */
4697 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4699 pixel = f->output_data.x->scroll_bar_background_pixel;
4700 if (pixel != -1)
4702 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4703 FRAME_X_COLORMAP (f),
4704 &pixel, 1.2, 0x8000))
4705 pixel = -1;
4706 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4709 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4711 pixel = f->output_data.x->scroll_bar_background_pixel;
4712 if (pixel != -1)
4714 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4715 FRAME_X_COLORMAP (f),
4716 &pixel, 0.6, 0x4000))
4717 pixel = -1;
4718 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4722 #ifdef XtNbeNiceToColormap
4723 /* Tell the toolkit about them. */
4724 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4725 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4726 /* We tried to allocate a color for the top/bottom shadow, and
4727 failed, so tell Xaw3d to use dithering instead. */
4728 /* But only if we have a small colormap. Xaw3d can allocate nice
4729 colors itself. */
4731 XtSetArg (av[ac], XtNbeNiceToColormap,
4732 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4733 ++ac;
4735 else
4736 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4737 be more consistent with other emacs 3d colors, and since Xaw3d is
4738 not good at dealing with allocation failure. */
4740 /* This tells Xaw3d to use real colors instead of dithering for
4741 the shadows. */
4742 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4743 ++ac;
4745 /* Specify the colors. */
4746 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4747 if (pixel != -1)
4749 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4750 ++ac;
4752 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4753 if (pixel != -1)
4755 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4756 ++ac;
4759 #endif
4761 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4762 f->output_data.x->edit_widget, av, ac);
4765 char const *initial = "";
4766 char const *val = initial;
4767 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4768 #ifdef XtNarrowScrollbars
4769 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4770 #endif
4771 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4772 if (xaw3d_arrow_scroll || val == initial)
4773 { /* ARROW_SCROLL */
4774 xaw3d_arrow_scroll = True;
4775 /* Isn't that just a personal preference ? --Stef */
4776 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4780 /* Define callbacks. */
4781 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4782 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4783 (XtPointer) bar);
4785 /* Realize the widget. Only after that is the X window created. */
4786 XtRealizeWidget (widget);
4788 #endif /* !USE_MOTIF */
4790 /* Install an action hook that lets us detect when the user
4791 finishes interacting with a scroll bar. */
4792 if (action_hook_id == 0)
4793 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4795 /* Remember X window and widget in the scroll bar vector. */
4796 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4797 xwindow = XtWindow (widget);
4798 bar->x_window = xwindow;
4800 unblock_input ();
4802 #endif /* not USE_GTK */
4805 /* Set the thumb size and position of scroll bar BAR. We are currently
4806 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4808 #ifdef USE_GTK
4809 static void
4810 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4812 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4815 #else /* not USE_GTK */
4816 static void
4817 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4818 int whole)
4820 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4821 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4822 float top, shown;
4824 block_input ();
4826 #ifdef USE_MOTIF
4828 if (scroll_bar_adjust_thumb_portion_p)
4830 /* We use an estimate of 30 chars per line rather than the real
4831 `portion' value. This has the disadvantage that the thumb size
4832 is not very representative, but it makes our life a lot easier.
4833 Otherwise, we have to constantly adjust the thumb size, which
4834 we can't always do quickly enough: while dragging, the size of
4835 the thumb might prevent the user from dragging the thumb all the
4836 way to the end. but Motif and some versions of Xaw3d don't allow
4837 updating the thumb size while dragging. Also, even if we can update
4838 its size, the update will often happen too late.
4839 If you don't believe it, check out revision 1.650 of xterm.c to see
4840 what hoops we were going through and the still poor behavior we got. */
4841 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4842 /* When the thumb is at the bottom, position == whole.
4843 So we need to increase `whole' to make space for the thumb. */
4844 whole += portion;
4847 if (whole <= 0)
4848 top = 0, shown = 1;
4849 else
4851 top = (float) position / whole;
4852 shown = (float) portion / whole;
4855 if (bar->dragging == -1)
4857 int size, value;
4859 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4860 is the scroll bar's maximum and MIN is the scroll bar's minimum
4861 value. */
4862 size = clip_to_bounds (1, shown * XM_SB_MAX, XM_SB_MAX);
4864 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4865 value = top * XM_SB_MAX;
4866 value = min (value, XM_SB_MAX - size);
4868 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4870 #else /* !USE_MOTIF i.e. use Xaw */
4872 if (whole == 0)
4873 top = 0, shown = 1;
4874 else
4876 top = (float) position / whole;
4877 shown = (float) portion / whole;
4881 float old_top, old_shown;
4882 Dimension height;
4883 XtVaGetValues (widget,
4884 XtNtopOfThumb, &old_top,
4885 XtNshown, &old_shown,
4886 XtNheight, &height,
4887 NULL);
4889 /* Massage the top+shown values. */
4890 if (bar->dragging == -1 || bar->last_seen_part == scroll_bar_down_arrow)
4891 top = max (0, min (1, top));
4892 else
4893 top = old_top;
4894 #if ! defined (HAVE_XAW3D)
4895 /* With Xaw, 'top' values too closer to 1.0 may
4896 cause the thumb to disappear. Fix that. */
4897 top = min (top, 0.99f);
4898 #endif
4899 /* Keep two pixels available for moving the thumb down. */
4900 shown = max (0, min (1 - top - (2.0f / height), shown));
4901 #if ! defined (HAVE_XAW3D)
4902 /* Likewise with too small 'shown'. */
4903 shown = max (shown, 0.01f);
4904 #endif
4906 /* If the call to XawScrollbarSetThumb below doesn't seem to
4907 work, check that 'NARROWPROTO' is defined in src/config.h.
4908 If this is not so, most likely you need to fix configure. */
4909 if (top != old_top || shown != old_shown)
4911 if (bar->dragging == -1)
4912 XawScrollbarSetThumb (widget, top, shown);
4913 else
4915 /* Try to make the scrolling a tad smoother. */
4916 if (!xaw3d_pick_top)
4917 shown = min (shown, old_shown);
4919 XawScrollbarSetThumb (widget, top, shown);
4923 #endif /* !USE_MOTIF */
4925 unblock_input ();
4927 #endif /* not USE_GTK */
4929 #endif /* USE_TOOLKIT_SCROLL_BARS */
4933 /************************************************************************
4934 Scroll bars, general
4935 ************************************************************************/
4937 /* Create a scroll bar and return the scroll bar vector for it. W is
4938 the Emacs window on which to create the scroll bar. TOP, LEFT,
4939 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4940 scroll bar. */
4942 static struct scroll_bar *
4943 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4945 struct frame *f = XFRAME (w->frame);
4946 struct scroll_bar *bar
4947 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4948 Lisp_Object barobj;
4950 block_input ();
4952 #ifdef USE_TOOLKIT_SCROLL_BARS
4953 x_create_toolkit_scroll_bar (f, bar);
4954 #else /* not USE_TOOLKIT_SCROLL_BARS */
4956 XSetWindowAttributes a;
4957 unsigned long mask;
4958 Window window;
4960 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4961 if (a.background_pixel == -1)
4962 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4964 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4965 | ButtonMotionMask | PointerMotionHintMask
4966 | ExposureMask);
4967 a.cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4969 mask = (CWBackPixel | CWEventMask | CWCursor);
4971 /* Clear the area of W that will serve as a scroll bar. This is
4972 for the case that a window has been split horizontally. In
4973 this case, no clear_frame is generated to reduce flickering. */
4974 if (width > 0 && window_box_height (w) > 0)
4975 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4976 left, top, width, window_box_height (w));
4978 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4979 /* Position and size of scroll bar. */
4980 left, top, width, height,
4981 /* Border width, depth, class, and visual. */
4983 CopyFromParent,
4984 CopyFromParent,
4985 CopyFromParent,
4986 /* Attributes. */
4987 mask, &a);
4988 bar->x_window = window;
4990 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4992 XSETWINDOW (bar->window, w);
4993 bar->top = top;
4994 bar->left = left;
4995 bar->width = width;
4996 bar->height = height;
4997 bar->start = 0;
4998 bar->end = 0;
4999 bar->dragging = -1;
5000 #if defined (USE_TOOLKIT_SCROLL_BARS) && defined (USE_LUCID)
5001 bar->last_seen_part = scroll_bar_nowhere;
5002 #endif
5004 /* Add bar to its frame's list of scroll bars. */
5005 bar->next = FRAME_SCROLL_BARS (f);
5006 bar->prev = Qnil;
5007 XSETVECTOR (barobj, bar);
5008 fset_scroll_bars (f, barobj);
5009 if (!NILP (bar->next))
5010 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5012 /* Map the window/widget. */
5013 #ifdef USE_TOOLKIT_SCROLL_BARS
5015 #ifdef USE_GTK
5016 xg_update_scrollbar_pos (f, bar->x_window, top,
5017 left,width, max (height, 1));
5018 #else /* not USE_GTK */
5019 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
5020 XtConfigureWidget (scroll_bar, left, top, width, max (height, 1), 0);
5021 XtMapWidget (scroll_bar);
5022 #endif /* not USE_GTK */
5024 #else /* not USE_TOOLKIT_SCROLL_BARS */
5025 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
5026 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5028 unblock_input ();
5029 return bar;
5033 #ifndef USE_TOOLKIT_SCROLL_BARS
5035 /* Draw BAR's handle in the proper position.
5037 If the handle is already drawn from START to END, don't bother
5038 redrawing it, unless REBUILD is non-zero; in that case, always
5039 redraw it. (REBUILD is handy for drawing the handle after expose
5040 events.)
5042 Normally, we want to constrain the start and end of the handle to
5043 fit inside its rectangle, but if the user is dragging the scroll
5044 bar handle, we want to let them drag it down all the way, so that
5045 the bar's top is as far down as it goes; otherwise, there's no way
5046 to move to the very end of the buffer. */
5048 static void
5049 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
5051 bool dragging = bar->dragging != -1;
5052 Window w = bar->x_window;
5053 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5054 GC gc = f->output_data.x->normal_gc;
5056 /* If the display is already accurate, do nothing. */
5057 if (! rebuild
5058 && start == bar->start
5059 && end == bar->end)
5060 return;
5062 block_input ();
5065 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5066 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5067 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5069 /* Make sure the values are reasonable, and try to preserve
5070 the distance between start and end. */
5072 int length = end - start;
5074 if (start < 0)
5075 start = 0;
5076 else if (start > top_range)
5077 start = top_range;
5078 end = start + length;
5080 if (end < start)
5081 end = start;
5082 else if (end > top_range && ! dragging)
5083 end = top_range;
5086 /* Store the adjusted setting in the scroll bar. */
5087 bar->start = start;
5088 bar->end = end;
5090 /* Clip the end position, just for display. */
5091 if (end > top_range)
5092 end = top_range;
5094 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5095 below top positions, to make sure the handle is always at least
5096 that many pixels tall. */
5097 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5099 /* Draw the empty space above the handle. Note that we can't clear
5100 zero-height areas; that means "clear to end of window." */
5101 if (start > 0)
5102 x_clear_area (FRAME_X_DISPLAY (f), w,
5103 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5104 VERTICAL_SCROLL_BAR_TOP_BORDER,
5105 inside_width, start);
5107 /* Change to proper foreground color if one is specified. */
5108 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5109 XSetForeground (FRAME_X_DISPLAY (f), gc,
5110 f->output_data.x->scroll_bar_foreground_pixel);
5112 /* Draw the handle itself. */
5113 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5114 /* x, y, width, height */
5115 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5116 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5117 inside_width, end - start);
5119 /* Restore the foreground color of the GC if we changed it above. */
5120 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5121 XSetForeground (FRAME_X_DISPLAY (f), gc,
5122 FRAME_FOREGROUND_PIXEL (f));
5124 /* Draw the empty space below the handle. Note that we can't
5125 clear zero-height areas; that means "clear to end of window." */
5126 if (end < inside_height)
5127 x_clear_area (FRAME_X_DISPLAY (f), w,
5128 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5129 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5130 inside_width, inside_height - end);
5133 unblock_input ();
5136 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5138 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5139 nil. */
5141 static void
5142 x_scroll_bar_remove (struct scroll_bar *bar)
5144 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5145 block_input ();
5147 #ifdef USE_TOOLKIT_SCROLL_BARS
5148 #ifdef USE_GTK
5149 xg_remove_scroll_bar (f, bar->x_window);
5150 #else /* not USE_GTK */
5151 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5152 #endif /* not USE_GTK */
5153 #else
5154 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5155 #endif
5157 /* Dissociate this scroll bar from its window. */
5158 wset_vertical_scroll_bar (XWINDOW (bar->window), Qnil);
5160 unblock_input ();
5164 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5165 that we are displaying PORTION characters out of a total of WHOLE
5166 characters, starting at POSITION. If WINDOW has no scroll bar,
5167 create one. */
5169 static void
5170 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5172 struct frame *f = XFRAME (w->frame);
5173 Lisp_Object barobj;
5174 struct scroll_bar *bar;
5175 int top, height, left, width;
5176 int window_y, window_height;
5178 /* Get window dimensions. */
5179 window_box (w, ANY_AREA, 0, &window_y, 0, &window_height);
5180 top = window_y;
5181 height = window_height;
5183 /* Compute the left edge and the width of the scroll bar area. */
5184 left = WINDOW_SCROLL_BAR_AREA_X (w);
5185 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
5187 /* Does the scroll bar exist yet? */
5188 if (NILP (w->vertical_scroll_bar))
5190 if (width > 0 && height > 0)
5192 block_input ();
5193 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5194 left, top, width, height);
5195 unblock_input ();
5198 bar = x_scroll_bar_create (w, top, left, width, max (height, 1));
5200 else
5202 /* It may just need to be moved and resized. */
5203 unsigned int mask = 0;
5205 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5207 block_input ();
5209 if (left != bar->left)
5210 mask |= CWX;
5211 if (top != bar->top)
5212 mask |= CWY;
5213 if (width != bar->width)
5214 mask |= CWWidth;
5215 if (height != bar->height)
5216 mask |= CWHeight;
5218 #ifdef USE_TOOLKIT_SCROLL_BARS
5220 /* Move/size the scroll bar widget. */
5221 if (mask)
5223 /* Since toolkit scroll bars are smaller than the space reserved
5224 for them on the frame, we have to clear "under" them. */
5225 if (width > 0 && height > 0)
5226 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5227 left, top, width, height);
5228 #ifdef USE_GTK
5229 xg_update_scrollbar_pos (f, bar->x_window, top,
5230 left, width, max (height, 1));
5231 #else /* not USE_GTK */
5232 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5233 left, top, width, max (height, 1), 0);
5234 #endif /* not USE_GTK */
5236 #else /* not USE_TOOLKIT_SCROLL_BARS */
5238 /* Move/size the scroll bar window. */
5239 if (mask)
5241 XWindowChanges wc;
5243 wc.x = left;
5244 wc.y = top;
5245 wc.width = width;
5246 wc.height = height;
5247 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5248 mask, &wc);
5251 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5253 /* Remember new settings. */
5254 bar->left = left;
5255 bar->top = top;
5256 bar->width = width;
5257 bar->height = height;
5259 unblock_input ();
5262 #ifdef USE_TOOLKIT_SCROLL_BARS
5263 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5264 #else /* not USE_TOOLKIT_SCROLL_BARS */
5265 /* Set the scroll bar's current state, unless we're currently being
5266 dragged. */
5267 if (bar->dragging == -1)
5269 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5271 if (whole == 0)
5272 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5273 else
5275 int start = ((double) position * top_range) / whole;
5276 int end = ((double) (position + portion) * top_range) / whole;
5277 x_scroll_bar_set_handle (bar, start, end, 0);
5280 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5282 XSETVECTOR (barobj, bar);
5283 wset_vertical_scroll_bar (w, barobj);
5287 /* The following three hooks are used when we're doing a thorough
5288 redisplay of the frame. We don't explicitly know which scroll bars
5289 are going to be deleted, because keeping track of when windows go
5290 away is a real pain - "Can you say set-window-configuration, boys
5291 and girls?" Instead, we just assert at the beginning of redisplay
5292 that *all* scroll bars are to be removed, and then save a scroll bar
5293 from the fiery pit when we actually redisplay its window. */
5295 /* Arrange for all scroll bars on FRAME to be removed at the next call
5296 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5297 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5299 static void
5300 XTcondemn_scroll_bars (struct frame *frame)
5302 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5303 while (! NILP (FRAME_SCROLL_BARS (frame)))
5305 Lisp_Object bar;
5306 bar = FRAME_SCROLL_BARS (frame);
5307 fset_scroll_bars (frame, XSCROLL_BAR (bar)->next);
5308 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5309 XSCROLL_BAR (bar)->prev = Qnil;
5310 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5311 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5312 fset_condemned_scroll_bars (frame, bar);
5317 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5318 Note that WINDOW isn't necessarily condemned at all. */
5320 static void
5321 XTredeem_scroll_bar (struct window *window)
5323 struct scroll_bar *bar;
5324 struct frame *f;
5325 Lisp_Object barobj;
5327 /* We can't redeem this window's scroll bar if it doesn't have one. */
5328 if (NILP (window->vertical_scroll_bar))
5329 emacs_abort ();
5331 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5333 /* Unlink it from the condemned list. */
5334 f = XFRAME (WINDOW_FRAME (window));
5335 if (NILP (bar->prev))
5337 /* If the prev pointer is nil, it must be the first in one of
5338 the lists. */
5339 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5340 /* It's not condemned. Everything's fine. */
5341 return;
5342 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5343 window->vertical_scroll_bar))
5344 fset_condemned_scroll_bars (f, bar->next);
5345 else
5346 /* If its prev pointer is nil, it must be at the front of
5347 one or the other! */
5348 emacs_abort ();
5350 else
5351 XSCROLL_BAR (bar->prev)->next = bar->next;
5353 if (! NILP (bar->next))
5354 XSCROLL_BAR (bar->next)->prev = bar->prev;
5356 bar->next = FRAME_SCROLL_BARS (f);
5357 bar->prev = Qnil;
5358 XSETVECTOR (barobj, bar);
5359 fset_scroll_bars (f, barobj);
5360 if (! NILP (bar->next))
5361 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5364 /* Remove all scroll bars on FRAME that haven't been saved since the
5365 last call to `*condemn_scroll_bars_hook'. */
5367 static void
5368 XTjudge_scroll_bars (struct frame *f)
5370 Lisp_Object bar, next;
5372 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5374 /* Clear out the condemned list now so we won't try to process any
5375 more events on the hapless scroll bars. */
5376 fset_condemned_scroll_bars (f, Qnil);
5378 for (; ! NILP (bar); bar = next)
5380 struct scroll_bar *b = XSCROLL_BAR (bar);
5382 x_scroll_bar_remove (b);
5384 next = b->next;
5385 b->next = b->prev = Qnil;
5388 /* Now there should be no references to the condemned scroll bars,
5389 and they should get garbage-collected. */
5393 #ifndef USE_TOOLKIT_SCROLL_BARS
5394 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5395 is a no-op when using toolkit scroll bars.
5397 This may be called from a signal handler, so we have to ignore GC
5398 mark bits. */
5400 static void
5401 x_scroll_bar_expose (struct scroll_bar *bar, const XEvent *event)
5403 Window w = bar->x_window;
5404 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5405 GC gc = f->output_data.x->normal_gc;
5407 block_input ();
5409 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5411 /* Switch to scroll bar foreground color. */
5412 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5413 XSetForeground (FRAME_X_DISPLAY (f), gc,
5414 f->output_data.x->scroll_bar_foreground_pixel);
5416 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5417 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5418 /* x, y, width, height */
5419 0, 0, bar->width - 1, bar->height - 1);
5421 /* Restore the foreground color of the GC if we changed it above. */
5422 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5423 XSetForeground (FRAME_X_DISPLAY (f), gc,
5424 FRAME_FOREGROUND_PIXEL (f));
5426 unblock_input ();
5429 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5431 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5432 is set to something other than NO_EVENT, it is enqueued.
5434 This may be called from a signal handler, so we have to ignore GC
5435 mark bits. */
5438 static void
5439 x_scroll_bar_handle_click (struct scroll_bar *bar,
5440 const XEvent *event,
5441 struct input_event *emacs_event)
5443 if (! WINDOWP (bar->window))
5444 emacs_abort ();
5446 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5447 emacs_event->code = event->xbutton.button - Button1;
5448 emacs_event->modifiers
5449 = (x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO
5450 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5451 event->xbutton.state)
5452 | (event->type == ButtonRelease
5453 ? up_modifier
5454 : down_modifier));
5455 emacs_event->frame_or_window = bar->window;
5456 emacs_event->arg = Qnil;
5457 emacs_event->timestamp = event->xbutton.time;
5459 int top_range
5460 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5461 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5463 if (y < 0) y = 0;
5464 if (y > top_range) y = top_range;
5466 if (y < bar->start)
5467 emacs_event->part = scroll_bar_above_handle;
5468 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5469 emacs_event->part = scroll_bar_handle;
5470 else
5471 emacs_event->part = scroll_bar_below_handle;
5473 #ifndef USE_TOOLKIT_SCROLL_BARS
5474 /* If the user has released the handle, set it to its final position. */
5475 if (event->type == ButtonRelease && bar->dragging != -1)
5477 int new_start = y - bar->dragging;
5478 int new_end = new_start + bar->end - bar->start;
5480 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5481 bar->dragging = -1;
5483 #endif
5485 XSETINT (emacs_event->x, y);
5486 XSETINT (emacs_event->y, top_range);
5490 #ifndef USE_TOOLKIT_SCROLL_BARS
5492 /* Handle some mouse motion while someone is dragging the scroll bar.
5494 This may be called from a signal handler, so we have to ignore GC
5495 mark bits. */
5497 static void
5498 x_scroll_bar_note_movement (struct scroll_bar *bar,
5499 const XMotionEvent *event)
5501 struct frame *f = XFRAME (XWINDOW (bar->window)->frame);
5502 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
5504 dpyinfo->last_mouse_movement_time = event->time;
5505 dpyinfo->last_mouse_scroll_bar = bar;
5506 f->mouse_moved = 1;
5508 /* If we're dragging the bar, display it. */
5509 if (bar->dragging != -1)
5511 /* Where should the handle be now? */
5512 int new_start = event->y - bar->dragging;
5514 if (new_start != bar->start)
5516 int new_end = new_start + bar->end - bar->start;
5518 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5523 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5525 /* Return information to the user about the current position of the mouse
5526 on the scroll bar. */
5528 static void
5529 x_scroll_bar_report_motion (struct frame **fp, Lisp_Object *bar_window,
5530 enum scroll_bar_part *part, Lisp_Object *x,
5531 Lisp_Object *y, Time *timestamp)
5533 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (*fp);
5534 struct scroll_bar *bar = dpyinfo->last_mouse_scroll_bar;
5535 Window w = bar->x_window;
5536 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5537 int win_x, win_y;
5538 Window dummy_window;
5539 int dummy_coord;
5540 unsigned int dummy_mask;
5542 block_input ();
5544 /* Get the mouse's position relative to the scroll bar window, and
5545 report that. */
5546 if (XQueryPointer (FRAME_X_DISPLAY (f), w,
5548 /* Root, child, root x and root y. */
5549 &dummy_window, &dummy_window,
5550 &dummy_coord, &dummy_coord,
5552 /* Position relative to scroll bar. */
5553 &win_x, &win_y,
5555 /* Mouse buttons and modifier keys. */
5556 &dummy_mask))
5558 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5560 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5562 if (bar->dragging != -1)
5563 win_y -= bar->dragging;
5565 if (win_y < 0)
5566 win_y = 0;
5567 if (win_y > top_range)
5568 win_y = top_range;
5570 *fp = f;
5571 *bar_window = bar->window;
5573 if (bar->dragging != -1)
5574 *part = scroll_bar_handle;
5575 else if (win_y < bar->start)
5576 *part = scroll_bar_above_handle;
5577 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5578 *part = scroll_bar_handle;
5579 else
5580 *part = scroll_bar_below_handle;
5582 XSETINT (*x, win_y);
5583 XSETINT (*y, top_range);
5585 f->mouse_moved = 0;
5586 dpyinfo->last_mouse_scroll_bar = NULL;
5587 *timestamp = dpyinfo->last_mouse_movement_time;
5590 unblock_input ();
5594 /* The screen has been cleared so we may have changed foreground or
5595 background colors, and the scroll bars may need to be redrawn.
5596 Clear out the scroll bars, and ask for expose events, so we can
5597 redraw them. */
5599 static void
5600 x_scroll_bar_clear (struct frame *f)
5602 #ifndef USE_TOOLKIT_SCROLL_BARS
5603 Lisp_Object bar;
5605 /* We can have scroll bars even if this is 0,
5606 if we just turned off scroll bar mode.
5607 But in that case we should not clear them. */
5608 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5609 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5610 bar = XSCROLL_BAR (bar)->next)
5611 XClearArea (FRAME_X_DISPLAY (f),
5612 XSCROLL_BAR (bar)->x_window,
5613 0, 0, 0, 0, True);
5614 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5617 #ifdef ENABLE_CHECKING
5619 /* Record the last 100 characters stored
5620 to help debug the loss-of-chars-during-GC problem. */
5622 static int temp_index;
5623 static short temp_buffer[100];
5625 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5626 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5627 temp_index = 0; \
5628 temp_buffer[temp_index++] = (keysym)
5630 #else /* not ENABLE_CHECKING */
5632 #define STORE_KEYSYM_FOR_DEBUG(keysym) ((void)0)
5634 #endif /* ENABLE_CHECKING */
5636 /* Set this to nonzero to fake an "X I/O error"
5637 on a particular display. */
5639 static struct x_display_info *XTread_socket_fake_io_error;
5641 /* When we find no input here, we occasionally do a no-op command
5642 to verify that the X server is still running and we can still talk with it.
5643 We try all the open displays, one by one.
5644 This variable is used for cycling thru the displays. */
5646 static struct x_display_info *next_noop_dpyinfo;
5648 enum
5650 X_EVENT_NORMAL,
5651 X_EVENT_GOTO_OUT,
5652 X_EVENT_DROP
5655 /* Filter events for the current X input method.
5656 DPYINFO is the display this event is for.
5657 EVENT is the X event to filter.
5659 Returns non-zero if the event was filtered, caller shall not process
5660 this event further.
5661 Returns zero if event is wasn't filtered. */
5663 #ifdef HAVE_X_I18N
5664 static int
5665 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5667 /* XFilterEvent returns non-zero if the input method has
5668 consumed the event. We pass the frame's X window to
5669 XFilterEvent because that's the one for which the IC
5670 was created. */
5672 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5673 event->xclient.window);
5675 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5677 #endif
5679 #ifdef USE_GTK
5680 static int current_count;
5681 static int current_finish;
5682 static struct input_event *current_hold_quit;
5684 /* This is the filter function invoked by the GTK event loop.
5685 It is invoked before the XEvent is translated to a GdkEvent,
5686 so we have a chance to act on the event before GTK. */
5687 static GdkFilterReturn
5688 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5690 XEvent *xev = (XEvent *) gxev;
5692 block_input ();
5693 if (current_count >= 0)
5695 struct x_display_info *dpyinfo;
5697 dpyinfo = x_display_info_for_display (xev->xany.display);
5699 #ifdef HAVE_X_I18N
5700 /* Filter events for the current X input method.
5701 GTK calls XFilterEvent but not for key press and release,
5702 so we do it here. */
5703 if ((xev->type == KeyPress || xev->type == KeyRelease)
5704 && dpyinfo
5705 && x_filter_event (dpyinfo, xev))
5707 unblock_input ();
5708 return GDK_FILTER_REMOVE;
5710 #endif
5712 if (! dpyinfo)
5713 current_finish = X_EVENT_NORMAL;
5714 else
5715 current_count
5716 += handle_one_xevent (dpyinfo, xev, &current_finish,
5717 current_hold_quit);
5719 else
5720 current_finish = x_dispatch_event (xev, xev->xany.display);
5722 unblock_input ();
5724 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5725 return GDK_FILTER_REMOVE;
5727 return GDK_FILTER_CONTINUE;
5729 #endif /* USE_GTK */
5732 static void xembed_send_message (struct frame *f, Time,
5733 enum xembed_message,
5734 long detail, long data1, long data2);
5736 /* Handles the XEvent EVENT on display DPYINFO.
5738 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5739 *FINISH is zero if caller should continue reading events.
5740 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5741 *EVENT is unchanged unless we're processing KeyPress event.
5743 We return the number of characters stored into the buffer. */
5745 static int
5746 handle_one_xevent (struct x_display_info *dpyinfo,
5747 const XEvent *event,
5748 int *finish, struct input_event *hold_quit)
5750 union {
5751 struct input_event ie;
5752 struct selection_input_event sie;
5753 } inev;
5754 int count = 0;
5755 int do_help = 0;
5756 ptrdiff_t nbytes = 0;
5757 struct frame *any, *f = NULL;
5758 struct coding_system coding;
5759 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5760 /* This holds the state XLookupString needs to implement dead keys
5761 and other tricks known as "compose processing". _X Window System_
5762 says that a portable program can't use this, but Stephen Gildea assures
5763 me that letting the compiler initialize it to zeros will work okay. */
5764 static XComposeStatus compose_status;
5766 USE_SAFE_ALLOCA;
5768 *finish = X_EVENT_NORMAL;
5770 EVENT_INIT (inev.ie);
5771 inev.ie.kind = NO_EVENT;
5772 inev.ie.arg = Qnil;
5774 any = x_any_window_to_frame (dpyinfo, event->xany.window);
5776 if (any && any->wait_event_type == event->type)
5777 any->wait_event_type = 0; /* Indicates we got it. */
5779 switch (event->type)
5781 case ClientMessage:
5783 if (event->xclient.message_type == dpyinfo->Xatom_wm_protocols
5784 && event->xclient.format == 32)
5786 if (event->xclient.data.l[0] == dpyinfo->Xatom_wm_take_focus)
5788 /* Use the value returned by x_any_window_to_frame
5789 because this could be the shell widget window
5790 if the frame has no title bar. */
5791 f = any;
5792 #ifdef HAVE_X_I18N
5793 /* Not quite sure this is needed -pd */
5794 if (f && FRAME_XIC (f))
5795 XSetICFocus (FRAME_XIC (f));
5796 #endif
5797 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5798 instructs the WM to set the input focus automatically for
5799 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5800 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5801 it has set the focus. So, XSetInputFocus below is not
5802 needed.
5804 The call to XSetInputFocus below has also caused trouble. In
5805 cases where the XSetInputFocus done by the WM and the one
5806 below are temporally close (on a fast machine), the call
5807 below can generate additional FocusIn events which confuse
5808 Emacs. */
5810 /* Since we set WM_TAKE_FOCUS, we must call
5811 XSetInputFocus explicitly. But not if f is null,
5812 since that might be an event for a deleted frame. */
5813 if (f)
5815 Display *d = event->xclient.display;
5816 /* Catch and ignore errors, in case window has been
5817 iconified by a window manager such as GWM. */
5818 x_catch_errors (d);
5819 XSetInputFocus (d, event->xclient.window,
5820 /* The ICCCM says this is
5821 the only valid choice. */
5822 RevertToParent,
5823 event->xclient.data.l[1]);
5824 /* This is needed to detect the error
5825 if there is an error. */
5826 XSync (d, False);
5827 x_uncatch_errors ();
5829 /* Not certain about handling scroll bars here */
5830 #endif /* 0 */
5831 goto done;
5834 if (event->xclient.data.l[0] == dpyinfo->Xatom_wm_save_yourself)
5836 /* Save state modify the WM_COMMAND property to
5837 something which can reinstate us. This notifies
5838 the session manager, who's looking for such a
5839 PropertyNotify. Can restart processing when
5840 a keyboard or mouse event arrives. */
5841 /* If we have a session manager, don't set this.
5842 KDE will then start two Emacsen, one for the
5843 session manager and one for this. */
5844 #ifdef HAVE_X_SM
5845 if (! x_session_have_connection ())
5846 #endif
5848 f = x_top_window_to_frame (dpyinfo,
5849 event->xclient.window);
5850 /* This is just so we only give real data once
5851 for a single Emacs process. */
5852 if (f == SELECTED_FRAME ())
5853 XSetCommand (FRAME_X_DISPLAY (f),
5854 event->xclient.window,
5855 initial_argv, initial_argc);
5856 else if (f)
5857 XSetCommand (FRAME_X_DISPLAY (f),
5858 event->xclient.window,
5859 0, 0);
5861 goto done;
5864 if (event->xclient.data.l[0] == dpyinfo->Xatom_wm_delete_window)
5866 f = any;
5867 if (!f)
5868 goto OTHER; /* May be a dialog that is to be removed */
5870 inev.ie.kind = DELETE_WINDOW_EVENT;
5871 XSETFRAME (inev.ie.frame_or_window, f);
5872 goto done;
5875 goto done;
5878 if (event->xclient.message_type == dpyinfo->Xatom_wm_configure_denied)
5879 goto done;
5881 if (event->xclient.message_type == dpyinfo->Xatom_wm_window_moved)
5883 int new_x, new_y;
5884 f = x_window_to_frame (dpyinfo, event->xclient.window);
5886 new_x = event->xclient.data.s[0];
5887 new_y = event->xclient.data.s[1];
5889 if (f)
5891 f->left_pos = new_x;
5892 f->top_pos = new_y;
5894 goto done;
5897 #ifdef HACK_EDITRES
5898 if (event->xclient.message_type == dpyinfo->Xatom_editres)
5900 f = any;
5901 if (f)
5902 _XEditResCheckMessages (f->output_data.x->widget,
5903 NULL, (XEvent *) event, NULL);
5904 goto done;
5906 #endif /* HACK_EDITRES */
5908 if (event->xclient.message_type == dpyinfo->Xatom_DONE
5909 || event->xclient.message_type == dpyinfo->Xatom_PAGE)
5911 /* Ghostview job completed. Kill it. We could
5912 reply with "Next" if we received "Page", but we
5913 currently never do because we are interested in
5914 images, only, which should have 1 page. */
5915 Pixmap pixmap = (Pixmap) event->xclient.data.l[1];
5916 f = x_window_to_frame (dpyinfo, event->xclient.window);
5917 if (!f)
5918 goto OTHER;
5919 x_kill_gs_process (pixmap, f);
5920 expose_frame (f, 0, 0, 0, 0);
5921 goto done;
5924 #ifdef USE_TOOLKIT_SCROLL_BARS
5925 /* Scroll bar callbacks send a ClientMessage from which
5926 we construct an input_event. */
5927 if (event->xclient.message_type == dpyinfo->Xatom_Scrollbar)
5929 x_scroll_bar_to_input_event (event, &inev.ie);
5930 *finish = X_EVENT_GOTO_OUT;
5931 goto done;
5933 #endif /* USE_TOOLKIT_SCROLL_BARS */
5935 /* XEmbed messages from the embedder (if any). */
5936 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
5938 enum xembed_message msg = event->xclient.data.l[1];
5939 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
5940 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
5942 *finish = X_EVENT_GOTO_OUT;
5943 goto done;
5946 xft_settings_event (dpyinfo, event);
5948 f = any;
5949 if (!f)
5950 goto OTHER;
5951 if (x_handle_dnd_message (f, &event->xclient, dpyinfo, &inev.ie))
5952 *finish = X_EVENT_DROP;
5954 break;
5956 case SelectionNotify:
5957 dpyinfo->last_user_time = event->xselection.time;
5958 #ifdef USE_X_TOOLKIT
5959 if (! x_window_to_frame (dpyinfo, event->xselection.requestor))
5960 goto OTHER;
5961 #endif /* not USE_X_TOOLKIT */
5962 x_handle_selection_notify (&event->xselection);
5963 break;
5965 case SelectionClear: /* Someone has grabbed ownership. */
5966 dpyinfo->last_user_time = event->xselectionclear.time;
5967 #ifdef USE_X_TOOLKIT
5968 if (! x_window_to_frame (dpyinfo, event->xselectionclear.window))
5969 goto OTHER;
5970 #endif /* USE_X_TOOLKIT */
5972 const XSelectionClearEvent *eventp = &event->xselectionclear;
5974 inev.ie.kind = SELECTION_CLEAR_EVENT;
5975 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
5976 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
5977 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
5979 break;
5981 case SelectionRequest: /* Someone wants our selection. */
5982 dpyinfo->last_user_time = event->xselectionrequest.time;
5983 #ifdef USE_X_TOOLKIT
5984 if (!x_window_to_frame (dpyinfo, event->xselectionrequest.owner))
5985 goto OTHER;
5986 #endif /* USE_X_TOOLKIT */
5988 const XSelectionRequestEvent *eventp = &event->xselectionrequest;
5990 inev.ie.kind = SELECTION_REQUEST_EVENT;
5991 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
5992 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
5993 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
5994 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
5995 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
5996 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
5998 break;
6000 case PropertyNotify:
6001 dpyinfo->last_user_time = event->xproperty.time;
6002 f = x_top_window_to_frame (dpyinfo, event->xproperty.window);
6003 if (f && event->xproperty.atom == dpyinfo->Xatom_net_wm_state)
6004 if (x_handle_net_wm_state (f, &event->xproperty)
6005 && FRAME_ICONIFIED_P (f)
6006 && f->output_data.x->net_wm_state_hidden_seen)
6008 /* Gnome shell does not iconify us when C-z is pressed.
6009 It hides the frame. So if our state says we aren't
6010 hidden anymore, treat it as deiconified. */
6011 SET_FRAME_VISIBLE (f, 1);
6012 SET_FRAME_ICONIFIED (f, 0);
6013 f->output_data.x->has_been_visible = 1;
6014 f->output_data.x->net_wm_state_hidden_seen = 0;
6015 inev.ie.kind = DEICONIFY_EVENT;
6016 XSETFRAME (inev.ie.frame_or_window, f);
6019 x_handle_property_notify (&event->xproperty);
6020 xft_settings_event (dpyinfo, event);
6021 goto OTHER;
6023 case ReparentNotify:
6024 f = x_top_window_to_frame (dpyinfo, event->xreparent.window);
6025 if (f)
6027 f->output_data.x->parent_desc = event->xreparent.parent;
6028 x_real_positions (f, &f->left_pos, &f->top_pos);
6030 /* Perhaps reparented due to a WM restart. Reset this. */
6031 FRAME_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6032 FRAME_DISPLAY_INFO (f)->net_supported_window = 0;
6034 x_set_frame_alpha (f);
6036 goto OTHER;
6038 case Expose:
6039 f = x_window_to_frame (dpyinfo, event->xexpose.window);
6040 if (f)
6042 if (!FRAME_VISIBLE_P (f))
6044 SET_FRAME_VISIBLE (f, 1);
6045 SET_FRAME_ICONIFIED (f, 0);
6046 f->output_data.x->has_been_visible = 1;
6047 SET_FRAME_GARBAGED (f);
6049 else
6051 #ifdef USE_GTK
6052 /* This seems to be needed for GTK 2.6 and later, see
6053 http://debbugs.gnu.org/cgi/bugreport.cgi?bug=15398. */
6054 x_clear_area (event->xexpose.display,
6055 event->xexpose.window,
6056 event->xexpose.x, event->xexpose.y,
6057 event->xexpose.width, event->xexpose.height);
6058 #endif
6059 expose_frame (f, event->xexpose.x, event->xexpose.y,
6060 event->xexpose.width, event->xexpose.height);
6063 else
6065 #ifndef USE_TOOLKIT_SCROLL_BARS
6066 struct scroll_bar *bar;
6067 #endif
6068 #if defined USE_LUCID
6069 /* Submenus of the Lucid menu bar aren't widgets
6070 themselves, so there's no way to dispatch events
6071 to them. Recognize this case separately. */
6073 Widget widget = x_window_to_menu_bar (event->xexpose.window);
6074 if (widget)
6075 xlwmenu_redisplay (widget);
6077 #endif /* USE_LUCID */
6079 #ifdef USE_TOOLKIT_SCROLL_BARS
6080 /* Dispatch event to the widget. */
6081 goto OTHER;
6082 #else /* not USE_TOOLKIT_SCROLL_BARS */
6083 bar = x_window_to_scroll_bar (event->xexpose.display,
6084 event->xexpose.window);
6086 if (bar)
6087 x_scroll_bar_expose (bar, event);
6088 #ifdef USE_X_TOOLKIT
6089 else
6090 goto OTHER;
6091 #endif /* USE_X_TOOLKIT */
6092 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6094 break;
6096 case GraphicsExpose: /* This occurs when an XCopyArea's
6097 source area was obscured or not
6098 available. */
6099 f = x_window_to_frame (dpyinfo, event->xgraphicsexpose.drawable);
6100 if (f)
6101 expose_frame (f, event->xgraphicsexpose.x,
6102 event->xgraphicsexpose.y,
6103 event->xgraphicsexpose.width,
6104 event->xgraphicsexpose.height);
6105 #ifdef USE_X_TOOLKIT
6106 else
6107 goto OTHER;
6108 #endif /* USE_X_TOOLKIT */
6109 break;
6111 case NoExpose: /* This occurs when an XCopyArea's
6112 source area was completely
6113 available. */
6114 break;
6116 case UnmapNotify:
6117 /* Redo the mouse-highlight after the tooltip has gone. */
6118 if (event->xunmap.window == tip_window)
6120 tip_window = 0;
6121 x_redo_mouse_highlight (dpyinfo);
6124 f = x_top_window_to_frame (dpyinfo, event->xunmap.window);
6125 if (f) /* F may no longer exist if
6126 the frame was deleted. */
6128 bool visible = FRAME_VISIBLE_P (f);
6129 /* While a frame is unmapped, display generation is
6130 disabled; you don't want to spend time updating a
6131 display that won't ever be seen. */
6132 SET_FRAME_VISIBLE (f, 0);
6133 /* We can't distinguish, from the event, whether the window
6134 has become iconified or invisible. So assume, if it
6135 was previously visible, than now it is iconified.
6136 But x_make_frame_invisible clears both
6137 the visible flag and the iconified flag;
6138 and that way, we know the window is not iconified now. */
6139 if (visible || FRAME_ICONIFIED_P (f))
6141 SET_FRAME_ICONIFIED (f, 1);
6142 inev.ie.kind = ICONIFY_EVENT;
6143 XSETFRAME (inev.ie.frame_or_window, f);
6146 goto OTHER;
6148 case MapNotify:
6149 if (event->xmap.window == tip_window)
6150 /* The tooltip has been drawn already. Avoid
6151 the SET_FRAME_GARBAGED below. */
6152 goto OTHER;
6154 /* We use x_top_window_to_frame because map events can
6155 come for sub-windows and they don't mean that the
6156 frame is visible. */
6157 f = x_top_window_to_frame (dpyinfo, event->xmap.window);
6158 if (f)
6160 bool iconified = FRAME_ICONIFIED_P (f);
6162 /* Check if fullscreen was specified before we where mapped the
6163 first time, i.e. from the command line. */
6164 if (!f->output_data.x->has_been_visible)
6165 x_check_fullscreen (f);
6167 SET_FRAME_VISIBLE (f, 1);
6168 SET_FRAME_ICONIFIED (f, 0);
6169 f->output_data.x->has_been_visible = 1;
6171 if (iconified)
6173 inev.ie.kind = DEICONIFY_EVENT;
6174 XSETFRAME (inev.ie.frame_or_window, f);
6176 else if (! NILP (Vframe_list) && ! NILP (XCDR (Vframe_list)))
6177 /* Force a redisplay sooner or later to update the
6178 frame titles in case this is the second frame. */
6179 record_asynch_buffer_change ();
6181 #ifdef USE_GTK
6182 xg_frame_resized (f, -1, -1);
6183 #endif
6185 goto OTHER;
6187 case KeyPress:
6189 dpyinfo->last_user_time = event->xkey.time;
6190 ignore_next_mouse_click_timeout = 0;
6192 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6193 /* Dispatch KeyPress events when in menu. */
6194 if (popup_activated ())
6195 goto OTHER;
6196 #endif
6198 f = any;
6200 #if ! defined (USE_GTK)
6201 /* If mouse-highlight is an integer, input clears out
6202 mouse highlighting. */
6203 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6204 && (f == 0
6205 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6207 clear_mouse_face (hlinfo);
6208 hlinfo->mouse_face_hidden = 1;
6210 #endif
6212 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6213 if (f == 0)
6215 /* Scroll bars consume key events, but we want
6216 the keys to go to the scroll bar's frame. */
6217 Widget widget = XtWindowToWidget (dpyinfo->display,
6218 event->xkey.window);
6219 if (widget && XmIsScrollBar (widget))
6221 widget = XtParent (widget);
6222 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6225 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6227 if (f != 0)
6229 KeySym keysym, orig_keysym;
6230 /* al%imercury@uunet.uu.net says that making this 81
6231 instead of 80 fixed a bug whereby meta chars made
6232 his Emacs hang.
6234 It seems that some version of XmbLookupString has
6235 a bug of not returning XBufferOverflow in
6236 status_return even if the input is too long to
6237 fit in 81 bytes. So, we must prepare sufficient
6238 bytes for copy_buffer. 513 bytes (256 chars for
6239 two-byte character set) seems to be a fairly good
6240 approximation. -- 2000.8.10 handa@etl.go.jp */
6241 unsigned char copy_buffer[513];
6242 unsigned char *copy_bufptr = copy_buffer;
6243 int copy_bufsiz = sizeof (copy_buffer);
6244 int modifiers;
6245 Lisp_Object coding_system = Qlatin_1;
6246 Lisp_Object c;
6247 /* Event will be modified. */
6248 XKeyEvent xkey = event->xkey;
6250 #ifdef USE_GTK
6251 /* Don't pass keys to GTK. A Tab will shift focus to the
6252 tool bar in GTK 2.4. Keys will still go to menus and
6253 dialogs because in that case popup_activated is nonzero
6254 (see above). */
6255 *finish = X_EVENT_DROP;
6256 #endif
6258 xkey.state |= x_emacs_to_x_modifiers (FRAME_DISPLAY_INFO (f),
6259 extra_keyboard_modifiers);
6260 modifiers = xkey.state;
6262 /* This will have to go some day... */
6264 /* make_lispy_event turns chars into control chars.
6265 Don't do it here because XLookupString is too eager. */
6266 xkey.state &= ~ControlMask;
6267 xkey.state &= ~(dpyinfo->meta_mod_mask
6268 | dpyinfo->super_mod_mask
6269 | dpyinfo->hyper_mod_mask
6270 | dpyinfo->alt_mod_mask);
6272 /* In case Meta is ComposeCharacter,
6273 clear its status. According to Markus Ehrnsperger
6274 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6275 this enables ComposeCharacter to work whether or
6276 not it is combined with Meta. */
6277 if (modifiers & dpyinfo->meta_mod_mask)
6278 memset (&compose_status, 0, sizeof (compose_status));
6280 #ifdef HAVE_X_I18N
6281 if (FRAME_XIC (f))
6283 Status status_return;
6285 coding_system = Vlocale_coding_system;
6286 nbytes = XmbLookupString (FRAME_XIC (f),
6287 &xkey, (char *) copy_bufptr,
6288 copy_bufsiz, &keysym,
6289 &status_return);
6290 if (status_return == XBufferOverflow)
6292 copy_bufsiz = nbytes + 1;
6293 copy_bufptr = alloca (copy_bufsiz);
6294 nbytes = XmbLookupString (FRAME_XIC (f),
6295 &xkey, (char *) copy_bufptr,
6296 copy_bufsiz, &keysym,
6297 &status_return);
6299 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6300 if (status_return == XLookupNone)
6301 break;
6302 else if (status_return == XLookupChars)
6304 keysym = NoSymbol;
6305 modifiers = 0;
6307 else if (status_return != XLookupKeySym
6308 && status_return != XLookupBoth)
6309 emacs_abort ();
6311 else
6312 nbytes = XLookupString (&xkey, (char *) copy_bufptr,
6313 copy_bufsiz, &keysym,
6314 &compose_status);
6315 #else
6316 nbytes = XLookupString (&xkey, (char *) copy_bufptr,
6317 copy_bufsiz, &keysym,
6318 &compose_status);
6319 #endif
6321 /* If not using XIM/XIC, and a compose sequence is in progress,
6322 we break here. Otherwise, chars_matched is always 0. */
6323 if (compose_status.chars_matched > 0 && nbytes == 0)
6324 break;
6326 memset (&compose_status, 0, sizeof (compose_status));
6327 orig_keysym = keysym;
6329 /* Common for all keysym input events. */
6330 XSETFRAME (inev.ie.frame_or_window, f);
6331 inev.ie.modifiers
6332 = x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO (f), modifiers);
6333 inev.ie.timestamp = xkey.time;
6335 /* First deal with keysyms which have defined
6336 translations to characters. */
6337 if (keysym >= 32 && keysym < 128)
6338 /* Avoid explicitly decoding each ASCII character. */
6340 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6341 inev.ie.code = keysym;
6342 goto done_keysym;
6345 /* Keysyms directly mapped to Unicode characters. */
6346 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6348 if (keysym < 0x01000080)
6349 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6350 else
6351 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6352 inev.ie.code = keysym & 0xFFFFFF;
6353 goto done_keysym;
6356 /* Now non-ASCII. */
6357 if (HASH_TABLE_P (Vx_keysym_table)
6358 && (c = Fgethash (make_number (keysym),
6359 Vx_keysym_table,
6360 Qnil),
6361 NATNUMP (c)))
6363 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6364 ? ASCII_KEYSTROKE_EVENT
6365 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6366 inev.ie.code = XFASTINT (c);
6367 goto done_keysym;
6370 /* Random non-modifier sorts of keysyms. */
6371 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6372 || keysym == XK_Delete
6373 #ifdef XK_ISO_Left_Tab
6374 || (keysym >= XK_ISO_Left_Tab
6375 && keysym <= XK_ISO_Enter)
6376 #endif
6377 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6378 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6379 #ifdef HPUX
6380 /* This recognizes the "extended function
6381 keys". It seems there's no cleaner way.
6382 Test IsModifierKey to avoid handling
6383 mode_switch incorrectly. */
6384 || (XK_Select <= keysym && keysym < XK_KP_Space)
6385 #endif
6386 #ifdef XK_dead_circumflex
6387 || orig_keysym == XK_dead_circumflex
6388 #endif
6389 #ifdef XK_dead_grave
6390 || orig_keysym == XK_dead_grave
6391 #endif
6392 #ifdef XK_dead_tilde
6393 || orig_keysym == XK_dead_tilde
6394 #endif
6395 #ifdef XK_dead_diaeresis
6396 || orig_keysym == XK_dead_diaeresis
6397 #endif
6398 #ifdef XK_dead_macron
6399 || orig_keysym == XK_dead_macron
6400 #endif
6401 #ifdef XK_dead_degree
6402 || orig_keysym == XK_dead_degree
6403 #endif
6404 #ifdef XK_dead_acute
6405 || orig_keysym == XK_dead_acute
6406 #endif
6407 #ifdef XK_dead_cedilla
6408 || orig_keysym == XK_dead_cedilla
6409 #endif
6410 #ifdef XK_dead_breve
6411 || orig_keysym == XK_dead_breve
6412 #endif
6413 #ifdef XK_dead_ogonek
6414 || orig_keysym == XK_dead_ogonek
6415 #endif
6416 #ifdef XK_dead_caron
6417 || orig_keysym == XK_dead_caron
6418 #endif
6419 #ifdef XK_dead_doubleacute
6420 || orig_keysym == XK_dead_doubleacute
6421 #endif
6422 #ifdef XK_dead_abovedot
6423 || orig_keysym == XK_dead_abovedot
6424 #endif
6425 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6426 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6427 /* Any "vendor-specific" key is ok. */
6428 || (orig_keysym & (1 << 28))
6429 || (keysym != NoSymbol && nbytes == 0))
6430 && ! (IsModifierKey (orig_keysym)
6431 /* The symbols from XK_ISO_Lock
6432 to XK_ISO_Last_Group_Lock
6433 don't have real modifiers but
6434 should be treated similarly to
6435 Mode_switch by Emacs. */
6436 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6437 || (XK_ISO_Lock <= orig_keysym
6438 && orig_keysym <= XK_ISO_Last_Group_Lock)
6439 #endif
6442 STORE_KEYSYM_FOR_DEBUG (keysym);
6443 /* make_lispy_event will convert this to a symbolic
6444 key. */
6445 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6446 inev.ie.code = keysym;
6447 goto done_keysym;
6450 { /* Raw bytes, not keysym. */
6451 ptrdiff_t i;
6452 int nchars, len;
6454 for (i = 0, nchars = 0; i < nbytes; i++)
6456 if (ASCII_BYTE_P (copy_bufptr[i]))
6457 nchars++;
6458 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6461 if (nchars < nbytes)
6463 /* Decode the input data. */
6465 /* The input should be decoded with `coding_system'
6466 which depends on which X*LookupString function
6467 we used just above and the locale. */
6468 setup_coding_system (coding_system, &coding);
6469 coding.src_multibyte = 0;
6470 coding.dst_multibyte = 1;
6471 /* The input is converted to events, thus we can't
6472 handle composition. Anyway, there's no XIM that
6473 gives us composition information. */
6474 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6476 SAFE_NALLOCA (coding.destination, MAX_MULTIBYTE_LENGTH,
6477 nbytes);
6478 coding.dst_bytes = MAX_MULTIBYTE_LENGTH * nbytes;
6479 coding.mode |= CODING_MODE_LAST_BLOCK;
6480 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6481 nbytes = coding.produced;
6482 nchars = coding.produced_char;
6483 copy_bufptr = coding.destination;
6486 /* Convert the input data to a sequence of
6487 character events. */
6488 for (i = 0; i < nbytes; i += len)
6490 int ch;
6491 if (nchars == nbytes)
6492 ch = copy_bufptr[i], len = 1;
6493 else
6494 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6495 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
6496 ? ASCII_KEYSTROKE_EVENT
6497 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6498 inev.ie.code = ch;
6499 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6502 count += nchars;
6504 inev.ie.kind = NO_EVENT; /* Already stored above. */
6506 if (keysym == NoSymbol)
6507 break;
6509 /* FIXME: check side effects and remove this. */
6510 ((XEvent *) event)->xkey = xkey;
6512 done_keysym:
6513 #ifdef HAVE_X_I18N
6514 /* Don't dispatch this event since XtDispatchEvent calls
6515 XFilterEvent, and two calls in a row may freeze the
6516 client. */
6517 break;
6518 #else
6519 goto OTHER;
6520 #endif
6522 case KeyRelease:
6523 dpyinfo->last_user_time = event->xkey.time;
6524 #ifdef HAVE_X_I18N
6525 /* Don't dispatch this event since XtDispatchEvent calls
6526 XFilterEvent, and two calls in a row may freeze the
6527 client. */
6528 break;
6529 #else
6530 goto OTHER;
6531 #endif
6533 case EnterNotify:
6534 dpyinfo->last_user_time = event->xcrossing.time;
6535 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
6537 f = any;
6539 if (f && x_mouse_click_focus_ignore_position)
6540 ignore_next_mouse_click_timeout = event->xmotion.time + 200;
6542 /* EnterNotify counts as mouse movement,
6543 so update things that depend on mouse position. */
6544 if (f && !f->output_data.x->hourglass_p)
6545 note_mouse_movement (f, &event->xmotion);
6546 #ifdef USE_GTK
6547 /* We may get an EnterNotify on the buttons in the toolbar. In that
6548 case we moved out of any highlighted area and need to note this. */
6549 if (!f && dpyinfo->last_mouse_glyph_frame)
6550 note_mouse_movement (dpyinfo->last_mouse_glyph_frame, &event->xmotion);
6551 #endif
6552 goto OTHER;
6554 case FocusIn:
6555 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
6556 goto OTHER;
6558 case LeaveNotify:
6559 dpyinfo->last_user_time = event->xcrossing.time;
6560 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
6562 f = x_top_window_to_frame (dpyinfo, event->xcrossing.window);
6563 if (f)
6565 if (f == hlinfo->mouse_face_mouse_frame)
6567 /* If we move outside the frame, then we're
6568 certainly no longer on any text in the frame. */
6569 clear_mouse_face (hlinfo);
6570 hlinfo->mouse_face_mouse_frame = 0;
6573 /* Generate a nil HELP_EVENT to cancel a help-echo.
6574 Do it only if there's something to cancel.
6575 Otherwise, the startup message is cleared when
6576 the mouse leaves the frame. */
6577 if (any_help_event_p)
6578 do_help = -1;
6580 #ifdef USE_GTK
6581 /* See comment in EnterNotify above */
6582 else if (dpyinfo->last_mouse_glyph_frame)
6583 note_mouse_movement (dpyinfo->last_mouse_glyph_frame, &event->xmotion);
6584 #endif
6585 goto OTHER;
6587 case FocusOut:
6588 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
6589 goto OTHER;
6591 case MotionNotify:
6593 dpyinfo->last_user_time = event->xmotion.time;
6594 previous_help_echo_string = help_echo_string;
6595 help_echo_string = Qnil;
6597 f = (x_mouse_grabbed (dpyinfo) ? dpyinfo->last_mouse_frame
6598 : x_window_to_frame (dpyinfo, event->xmotion.window));
6600 if (hlinfo->mouse_face_hidden)
6602 hlinfo->mouse_face_hidden = 0;
6603 clear_mouse_face (hlinfo);
6606 #ifdef USE_GTK
6607 if (f && xg_event_is_for_scrollbar (f, event))
6608 f = 0;
6609 #endif
6610 if (f)
6613 /* Generate SELECT_WINDOW_EVENTs when needed.
6614 Don't let popup menus influence things (bug#1261). */
6615 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6617 static Lisp_Object last_mouse_window;
6618 Lisp_Object window = window_from_coordinates
6619 (f, event->xmotion.x, event->xmotion.y, 0, 0);
6621 /* Window will be selected only when it is not selected now and
6622 last mouse movement event was not in it. Minibuffer window
6623 will be selected only when it is active. */
6624 if (WINDOWP (window)
6625 && !EQ (window, last_mouse_window)
6626 && !EQ (window, selected_window)
6627 /* For click-to-focus window managers
6628 create event iff we don't leave the
6629 selected frame. */
6630 && (focus_follows_mouse
6631 || (EQ (XWINDOW (window)->frame,
6632 XWINDOW (selected_window)->frame))))
6634 inev.ie.kind = SELECT_WINDOW_EVENT;
6635 inev.ie.frame_or_window = window;
6637 /* Remember the last window where we saw the mouse. */
6638 last_mouse_window = window;
6640 if (!note_mouse_movement (f, &event->xmotion))
6641 help_echo_string = previous_help_echo_string;
6643 else
6645 #ifndef USE_TOOLKIT_SCROLL_BARS
6646 struct scroll_bar *bar
6647 = x_window_to_scroll_bar (event->xmotion.display,
6648 event->xmotion.window);
6650 if (bar)
6651 x_scroll_bar_note_movement (bar, &event->xmotion);
6652 #endif /* USE_TOOLKIT_SCROLL_BARS */
6654 /* If we move outside the frame, then we're
6655 certainly no longer on any text in the frame. */
6656 clear_mouse_face (hlinfo);
6659 /* If the contents of the global variable help_echo_string
6660 has changed, generate a HELP_EVENT. */
6661 if (!NILP (help_echo_string)
6662 || !NILP (previous_help_echo_string))
6663 do_help = 1;
6664 goto OTHER;
6667 case ConfigureNotify:
6668 f = x_top_window_to_frame (dpyinfo, event->xconfigure.window);
6669 #ifdef USE_GTK
6670 if (!f
6671 && (f = any)
6672 && event->xconfigure.window == FRAME_X_WINDOW (f))
6674 xg_frame_resized (f, event->xconfigure.width,
6675 event->xconfigure.height);
6676 f = 0;
6678 #endif
6679 if (f)
6681 #ifndef USE_X_TOOLKIT
6682 #ifndef USE_GTK
6683 int width = FRAME_PIXEL_TO_TEXT_WIDTH (f, event->xconfigure.width);
6684 int height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, event->xconfigure.height);
6686 /* In the toolkit version, change_frame_size
6687 is called by the code that handles resizing
6688 of the EmacsFrame widget. */
6690 /* Even if the number of character rows and columns has
6691 not changed, the font size may have changed, so we need
6692 to check the pixel dimensions as well. */
6693 if (width != FRAME_TEXT_WIDTH (f)
6694 || height != FRAME_TEXT_HEIGHT (f)
6695 || event->xconfigure.width != FRAME_PIXEL_WIDTH (f)
6696 || event->xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6698 change_frame_size (f, width, height, 0, 1, 0, 1);
6699 x_clear_under_internal_border (f);
6700 SET_FRAME_GARBAGED (f);
6701 cancel_mouse_face (f);
6704 /** FRAME_PIXEL_WIDTH (f) = event->xconfigure.width; **/
6705 /** FRAME_PIXEL_HEIGHT (f) = event->xconfigure.height; **/
6706 #endif /* not USE_GTK */
6707 #endif
6709 #ifdef USE_GTK
6710 /* GTK creates windows but doesn't map them.
6711 Only get real positions when mapped. */
6712 if (FRAME_GTK_OUTER_WIDGET (f)
6713 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6714 #endif
6715 x_real_positions (f, &f->left_pos, &f->top_pos);
6717 #ifdef HAVE_X_I18N
6718 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6719 xic_set_statusarea (f);
6720 #endif
6723 goto OTHER;
6725 case ButtonRelease:
6726 case ButtonPress:
6728 /* If we decide we want to generate an event to be seen
6729 by the rest of Emacs, we put it here. */
6730 bool tool_bar_p = 0;
6732 memset (&compose_status, 0, sizeof (compose_status));
6733 dpyinfo->last_mouse_glyph_frame = NULL;
6734 dpyinfo->last_user_time = event->xbutton.time;
6736 f = (x_mouse_grabbed (dpyinfo) ? dpyinfo->last_mouse_frame
6737 : x_window_to_frame (dpyinfo, event->xbutton.window));
6739 #ifdef USE_GTK
6740 if (f && xg_event_is_for_scrollbar (f, event))
6741 f = 0;
6742 #endif
6743 if (f)
6745 #if ! defined (USE_GTK)
6746 /* Is this in the tool-bar? */
6747 if (WINDOWP (f->tool_bar_window)
6748 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6750 Lisp_Object window;
6751 int x = event->xbutton.x;
6752 int y = event->xbutton.y;
6754 window = window_from_coordinates (f, x, y, 0, 1);
6755 tool_bar_p = EQ (window, f->tool_bar_window);
6757 if (tool_bar_p && event->xbutton.button < 4)
6758 handle_tool_bar_click
6759 (f, x, y, event->xbutton.type == ButtonPress,
6760 x_x_to_emacs_modifiers (dpyinfo, event->xbutton.state));
6762 #endif /* !USE_GTK */
6764 if (!tool_bar_p)
6765 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6766 if (! popup_activated ())
6767 #endif
6769 if (ignore_next_mouse_click_timeout)
6771 if (event->type == ButtonPress
6772 && event->xbutton.time > ignore_next_mouse_click_timeout)
6774 ignore_next_mouse_click_timeout = 0;
6775 construct_mouse_click (&inev.ie, &event->xbutton, f);
6777 if (event->type == ButtonRelease)
6778 ignore_next_mouse_click_timeout = 0;
6780 else
6781 construct_mouse_click (&inev.ie, &event->xbutton, f);
6783 if (FRAME_X_EMBEDDED_P (f))
6784 xembed_send_message (f, event->xbutton.time,
6785 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6787 else
6789 struct scroll_bar *bar
6790 = x_window_to_scroll_bar (event->xbutton.display,
6791 event->xbutton.window);
6793 #ifdef USE_TOOLKIT_SCROLL_BARS
6794 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6795 scroll bars. */
6796 if (bar && event->xbutton.state & ControlMask)
6798 x_scroll_bar_handle_click (bar, event, &inev.ie);
6799 *finish = X_EVENT_DROP;
6801 #else /* not USE_TOOLKIT_SCROLL_BARS */
6802 if (bar)
6803 x_scroll_bar_handle_click (bar, event, &inev.ie);
6804 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6807 if (event->type == ButtonPress)
6809 dpyinfo->grabbed |= (1 << event->xbutton.button);
6810 dpyinfo->last_mouse_frame = f;
6812 if (!tool_bar_p)
6813 last_tool_bar_item = -1;
6815 else
6816 dpyinfo->grabbed &= ~(1 << event->xbutton.button);
6818 /* Ignore any mouse motion that happened before this event;
6819 any subsequent mouse-movement Emacs events should reflect
6820 only motion after the ButtonPress/Release. */
6821 if (f != 0)
6822 f->mouse_moved = 0;
6824 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6825 f = x_menubar_window_to_frame (dpyinfo, event);
6826 /* For a down-event in the menu bar,
6827 don't pass it to Xt right now.
6828 Instead, save it away
6829 and we will pass it to Xt from kbd_buffer_get_event.
6830 That way, we can run some Lisp code first. */
6831 if (! popup_activated ()
6832 #ifdef USE_GTK
6833 /* Gtk+ menus only react to the first three buttons. */
6834 && event->xbutton.button < 3
6835 #endif
6836 && f && event->type == ButtonPress
6837 /* Verify the event is really within the menu bar
6838 and not just sent to it due to grabbing. */
6839 && event->xbutton.x >= 0
6840 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
6841 && event->xbutton.y >= 0
6842 && event->xbutton.y < f->output_data.x->menubar_height
6843 && event->xbutton.same_screen)
6845 if (!f->output_data.x->saved_menu_event)
6846 f->output_data.x->saved_menu_event = xmalloc (sizeof *event);
6847 *f->output_data.x->saved_menu_event = *event;
6848 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT;
6849 XSETFRAME (inev.ie.frame_or_window, f);
6850 *finish = X_EVENT_DROP;
6852 else
6853 goto OTHER;
6854 #endif /* USE_X_TOOLKIT || USE_GTK */
6856 break;
6858 case CirculateNotify:
6859 goto OTHER;
6861 case CirculateRequest:
6862 goto OTHER;
6864 case VisibilityNotify:
6865 goto OTHER;
6867 case MappingNotify:
6868 /* Someone has changed the keyboard mapping - update the
6869 local cache. */
6870 switch (event->xmapping.request)
6872 case MappingModifier:
6873 x_find_modifier_meanings (dpyinfo);
6874 /* This is meant to fall through. */
6875 case MappingKeyboard:
6876 XRefreshKeyboardMapping ((XMappingEvent *) &event->xmapping);
6878 goto OTHER;
6880 case DestroyNotify:
6881 xft_settings_event (dpyinfo, event);
6882 break;
6884 default:
6885 OTHER:
6886 #ifdef USE_X_TOOLKIT
6887 block_input ();
6888 if (*finish != X_EVENT_DROP)
6889 XtDispatchEvent ((XEvent *) event);
6890 unblock_input ();
6891 #endif /* USE_X_TOOLKIT */
6892 break;
6895 done:
6896 if (inev.ie.kind != NO_EVENT)
6898 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6899 count++;
6902 if (do_help
6903 && !(hold_quit && hold_quit->kind != NO_EVENT))
6905 Lisp_Object frame;
6907 if (f)
6908 XSETFRAME (frame, f);
6909 else
6910 frame = Qnil;
6912 if (do_help > 0)
6914 any_help_event_p = 1;
6915 gen_help_event (help_echo_string, frame, help_echo_window,
6916 help_echo_object, help_echo_pos);
6918 else
6920 help_echo_string = Qnil;
6921 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6923 count++;
6926 SAFE_FREE ();
6927 return count;
6930 /* Handles the XEvent EVENT on display DISPLAY.
6931 This is used for event loops outside the normal event handling,
6932 i.e. looping while a popup menu or a dialog is posted.
6934 Returns the value handle_one_xevent sets in the finish argument. */
6936 x_dispatch_event (XEvent *event, Display *display)
6938 struct x_display_info *dpyinfo;
6939 int finish = X_EVENT_NORMAL;
6941 dpyinfo = x_display_info_for_display (display);
6943 if (dpyinfo)
6944 handle_one_xevent (dpyinfo, event, &finish, 0);
6946 return finish;
6949 /* Read events coming from the X server.
6950 Return as soon as there are no more events to be read.
6952 Return the number of characters stored into the buffer,
6953 thus pretending to be `read' (except the characters we store
6954 in the keyboard buffer can be multibyte, so are not necessarily
6955 C chars). */
6957 static int
6958 XTread_socket (struct terminal *terminal, struct input_event *hold_quit)
6960 int count = 0;
6961 int event_found = 0;
6962 struct x_display_info *dpyinfo = terminal->display_info.x;
6964 block_input ();
6966 /* For debugging, this gives a way to fake an I/O error. */
6967 if (dpyinfo == XTread_socket_fake_io_error)
6969 XTread_socket_fake_io_error = 0;
6970 x_io_error_quitter (dpyinfo->display);
6973 #ifndef USE_GTK
6974 while (XPending (dpyinfo->display))
6976 int finish;
6977 XEvent event;
6979 XNextEvent (dpyinfo->display, &event);
6981 #ifdef HAVE_X_I18N
6982 /* Filter events for the current X input method. */
6983 if (x_filter_event (dpyinfo, &event))
6984 continue;
6985 #endif
6986 event_found = 1;
6988 count += handle_one_xevent (dpyinfo, &event, &finish, hold_quit);
6990 if (finish == X_EVENT_GOTO_OUT)
6991 break;
6994 #else /* USE_GTK */
6996 /* For GTK we must use the GTK event loop. But XEvents gets passed
6997 to our filter function above, and then to the big event switch.
6998 We use a bunch of globals to communicate with our filter function,
6999 that is kind of ugly, but it works.
7001 There is no way to do one display at the time, GTK just does events
7002 from all displays. */
7004 while (gtk_events_pending ())
7006 current_count = count;
7007 current_hold_quit = hold_quit;
7009 gtk_main_iteration ();
7011 count = current_count;
7012 current_count = -1;
7013 current_hold_quit = 0;
7015 if (current_finish == X_EVENT_GOTO_OUT)
7016 break;
7018 #endif /* USE_GTK */
7020 /* On some systems, an X bug causes Emacs to get no more events
7021 when the window is destroyed. Detect that. (1994.) */
7022 if (! event_found)
7024 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7025 One XNOOP in 100 loops will make Emacs terminate.
7026 B. Bretthauer, 1994 */
7027 x_noop_count++;
7028 if (x_noop_count >= 100)
7030 x_noop_count=0;
7032 if (next_noop_dpyinfo == 0)
7033 next_noop_dpyinfo = x_display_list;
7035 XNoOp (next_noop_dpyinfo->display);
7037 /* Each time we get here, cycle through the displays now open. */
7038 next_noop_dpyinfo = next_noop_dpyinfo->next;
7042 /* If the focus was just given to an auto-raising frame,
7043 raise it now. FIXME: handle more than one such frame. */
7044 if (dpyinfo->x_pending_autoraise_frame)
7046 x_raise_frame (dpyinfo->x_pending_autoraise_frame);
7047 dpyinfo->x_pending_autoraise_frame = NULL;
7050 unblock_input ();
7052 return count;
7058 /***********************************************************************
7059 Text Cursor
7060 ***********************************************************************/
7062 /* Set clipping for output in glyph row ROW. W is the window in which
7063 we operate. GC is the graphics context to set clipping in.
7065 ROW may be a text row or, e.g., a mode line. Text rows must be
7066 clipped to the interior of the window dedicated to text display,
7067 mode lines must be clipped to the whole window. */
7069 static void
7070 x_clip_to_row (struct window *w, struct glyph_row *row,
7071 enum glyph_row_area area, GC gc)
7073 struct frame *f = XFRAME (WINDOW_FRAME (w));
7074 XRectangle clip_rect;
7075 int window_x, window_y, window_width;
7077 window_box (w, area, &window_x, &window_y, &window_width, 0);
7079 clip_rect.x = window_x;
7080 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7081 clip_rect.y = max (clip_rect.y, window_y);
7082 clip_rect.width = window_width;
7083 clip_rect.height = row->visible_height;
7085 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7089 /* Draw a hollow box cursor on window W in glyph row ROW. */
7091 static void
7092 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7094 struct frame *f = XFRAME (WINDOW_FRAME (w));
7095 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
7096 Display *dpy = FRAME_X_DISPLAY (f);
7097 int x, y, wd, h;
7098 XGCValues xgcv;
7099 struct glyph *cursor_glyph;
7100 GC gc;
7102 /* Get the glyph the cursor is on. If we can't tell because
7103 the current matrix is invalid or such, give up. */
7104 cursor_glyph = get_phys_cursor_glyph (w);
7105 if (cursor_glyph == NULL)
7106 return;
7108 /* Compute frame-relative coordinates for phys cursor. */
7109 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7110 wd = w->phys_cursor_width;
7112 /* The foreground of cursor_gc is typically the same as the normal
7113 background color, which can cause the cursor box to be invisible. */
7114 xgcv.foreground = f->output_data.x->cursor_pixel;
7115 if (dpyinfo->scratch_cursor_gc)
7116 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7117 else
7118 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7119 GCForeground, &xgcv);
7120 gc = dpyinfo->scratch_cursor_gc;
7122 /* Set clipping, draw the rectangle, and reset clipping again. */
7123 x_clip_to_row (w, row, TEXT_AREA, gc);
7124 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7125 XSetClipMask (dpy, gc, None);
7129 /* Draw a bar cursor on window W in glyph row ROW.
7131 Implementation note: One would like to draw a bar cursor with an
7132 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7133 Unfortunately, I didn't find a font yet that has this property set.
7134 --gerd. */
7136 static void
7137 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7139 struct frame *f = XFRAME (w->frame);
7140 struct glyph *cursor_glyph;
7142 /* If cursor is out of bounds, don't draw garbage. This can happen
7143 in mini-buffer windows when switching between echo area glyphs
7144 and mini-buffer. */
7145 cursor_glyph = get_phys_cursor_glyph (w);
7146 if (cursor_glyph == NULL)
7147 return;
7149 /* If on an image, draw like a normal cursor. That's usually better
7150 visible than drawing a bar, esp. if the image is large so that
7151 the bar might not be in the window. */
7152 if (cursor_glyph->type == IMAGE_GLYPH)
7154 struct glyph_row *r;
7155 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7156 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
7158 else
7160 Display *dpy = FRAME_X_DISPLAY (f);
7161 Window window = FRAME_X_WINDOW (f);
7162 GC gc = FRAME_DISPLAY_INFO (f)->scratch_cursor_gc;
7163 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7164 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7165 XGCValues xgcv;
7167 /* If the glyph's background equals the color we normally draw
7168 the bars cursor in, the bar cursor in its normal color is
7169 invisible. Use the glyph's foreground color instead in this
7170 case, on the assumption that the glyph's colors are chosen so
7171 that the glyph is legible. */
7172 if (face->background == f->output_data.x->cursor_pixel)
7173 xgcv.background = xgcv.foreground = face->foreground;
7174 else
7175 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7176 xgcv.graphics_exposures = 0;
7178 if (gc)
7179 XChangeGC (dpy, gc, mask, &xgcv);
7180 else
7182 gc = XCreateGC (dpy, window, mask, &xgcv);
7183 FRAME_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7186 x_clip_to_row (w, row, TEXT_AREA, gc);
7188 if (kind == BAR_CURSOR)
7190 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7192 if (width < 0)
7193 width = FRAME_CURSOR_WIDTH (f);
7194 width = min (cursor_glyph->pixel_width, width);
7196 w->phys_cursor_width = width;
7198 /* If the character under cursor is R2L, draw the bar cursor
7199 on the right of its glyph, rather than on the left. */
7200 if ((cursor_glyph->resolved_level & 1) != 0)
7201 x += cursor_glyph->pixel_width - width;
7203 XFillRectangle (dpy, window, gc, x,
7204 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7205 width, row->height);
7207 else
7209 int dummy_x, dummy_y, dummy_h;
7211 if (width < 0)
7212 width = row->height;
7214 width = min (row->height, width);
7216 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7217 &dummy_y, &dummy_h);
7219 XFillRectangle (dpy, window, gc,
7220 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7221 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7222 row->height - width),
7223 w->phys_cursor_width, width);
7226 XSetClipMask (dpy, gc, None);
7231 /* RIF: Define cursor CURSOR on frame F. */
7233 static void
7234 x_define_frame_cursor (struct frame *f, Cursor cursor)
7236 if (!f->pointer_invisible
7237 && f->output_data.x->current_cursor != cursor)
7238 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7239 f->output_data.x->current_cursor = cursor;
7243 /* RIF: Clear area on frame F. */
7245 static void
7246 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7248 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), x, y, width, height);
7249 #ifdef USE_GTK
7250 /* Must queue a redraw, because scroll bars might have been cleared. */
7251 if (FRAME_GTK_WIDGET (f))
7252 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7253 #endif
7257 /* RIF: Draw cursor on window W. */
7259 static void
7260 x_draw_window_cursor (struct window *w, struct glyph_row *glyph_row, int x,
7261 int y, enum text_cursor_kinds cursor_type,
7262 int cursor_width, bool on_p, bool active_p)
7264 struct frame *f = XFRAME (WINDOW_FRAME (w));
7266 if (on_p)
7268 w->phys_cursor_type = cursor_type;
7269 w->phys_cursor_on_p = 1;
7271 if (glyph_row->exact_window_width_line_p
7272 && (glyph_row->reversed_p
7273 ? (w->phys_cursor.hpos < 0)
7274 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7276 glyph_row->cursor_in_fringe_p = 1;
7277 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7279 else
7281 switch (cursor_type)
7283 case HOLLOW_BOX_CURSOR:
7284 x_draw_hollow_cursor (w, glyph_row);
7285 break;
7287 case FILLED_BOX_CURSOR:
7288 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7289 break;
7291 case BAR_CURSOR:
7292 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7293 break;
7295 case HBAR_CURSOR:
7296 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7297 break;
7299 case NO_CURSOR:
7300 w->phys_cursor_width = 0;
7301 break;
7303 default:
7304 emacs_abort ();
7308 #ifdef HAVE_X_I18N
7309 if (w == XWINDOW (f->selected_window))
7310 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7311 xic_set_preeditarea (w, x, y);
7312 #endif
7315 XFlush (FRAME_X_DISPLAY (f));
7319 /* Icons. */
7321 /* Make the x-window of frame F use the gnu icon bitmap. */
7324 x_bitmap_icon (struct frame *f, Lisp_Object file)
7326 ptrdiff_t bitmap_id;
7328 if (FRAME_X_WINDOW (f) == 0)
7329 return 1;
7331 /* Free up our existing icon bitmap and mask if any. */
7332 if (f->output_data.x->icon_bitmap > 0)
7333 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7334 f->output_data.x->icon_bitmap = 0;
7336 if (STRINGP (file))
7338 #ifdef USE_GTK
7339 /* Use gtk_window_set_icon_from_file () if available,
7340 It's not restricted to bitmaps */
7341 if (xg_set_icon (f, file))
7342 return 0;
7343 #endif /* USE_GTK */
7344 bitmap_id = x_create_bitmap_from_file (f, file);
7345 x_create_bitmap_mask (f, bitmap_id);
7347 else
7349 /* Create the GNU bitmap and mask if necessary. */
7350 if (FRAME_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7352 ptrdiff_t rc = -1;
7354 #ifdef USE_GTK
7356 if (xg_set_icon (f, xg_default_icon_file)
7357 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7358 return 0;
7360 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7362 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7363 if (rc != -1)
7364 FRAME_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7366 #endif
7368 /* If all else fails, use the (black and white) xbm image. */
7369 if (rc == -1)
7371 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
7372 gnu_xbm_width, gnu_xbm_height);
7373 if (rc == -1)
7374 return 1;
7376 FRAME_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7377 x_create_bitmap_mask (f, FRAME_DISPLAY_INFO (f)->icon_bitmap_id);
7381 /* The first time we create the GNU bitmap and mask,
7382 this increments the ref-count one extra time.
7383 As a result, the GNU bitmap and mask are never freed.
7384 That way, we don't have to worry about allocating it again. */
7385 x_reference_bitmap (f, FRAME_DISPLAY_INFO (f)->icon_bitmap_id);
7387 bitmap_id = FRAME_DISPLAY_INFO (f)->icon_bitmap_id;
7390 x_wm_set_icon_pixmap (f, bitmap_id);
7391 f->output_data.x->icon_bitmap = bitmap_id;
7393 return 0;
7397 /* Make the x-window of frame F use a rectangle with text.
7398 Use ICON_NAME as the text. */
7401 x_text_icon (struct frame *f, const char *icon_name)
7403 if (FRAME_X_WINDOW (f) == 0)
7404 return 1;
7407 XTextProperty text;
7408 text.value = (unsigned char *) icon_name;
7409 text.encoding = XA_STRING;
7410 text.format = 8;
7411 text.nitems = strlen (icon_name);
7412 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7415 if (f->output_data.x->icon_bitmap > 0)
7416 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7417 f->output_data.x->icon_bitmap = 0;
7418 x_wm_set_icon_pixmap (f, 0);
7420 return 0;
7423 #define X_ERROR_MESSAGE_SIZE 200
7425 /* If non-nil, this should be a string.
7426 It means catch X errors and store the error message in this string.
7428 The reason we use a stack is that x_catch_error/x_uncatch_error can
7429 be called from a signal handler.
7432 struct x_error_message_stack {
7433 char string[X_ERROR_MESSAGE_SIZE];
7434 Display *dpy;
7435 struct x_error_message_stack *prev;
7437 static struct x_error_message_stack *x_error_message;
7439 /* An X error handler which stores the error message in
7440 *x_error_message. This is called from x_error_handler if
7441 x_catch_errors is in effect. */
7443 static void
7444 x_error_catcher (Display *display, XErrorEvent *event)
7446 XGetErrorText (display, event->error_code,
7447 x_error_message->string,
7448 X_ERROR_MESSAGE_SIZE);
7451 /* Begin trapping X errors for display DPY. Actually we trap X errors
7452 for all displays, but DPY should be the display you are actually
7453 operating on.
7455 After calling this function, X protocol errors no longer cause
7456 Emacs to exit; instead, they are recorded in the string
7457 stored in *x_error_message.
7459 Calling x_check_errors signals an Emacs error if an X error has
7460 occurred since the last call to x_catch_errors or x_check_errors.
7462 Calling x_uncatch_errors resumes the normal error handling. */
7464 void
7465 x_catch_errors (Display *dpy)
7467 struct x_error_message_stack *data = xmalloc (sizeof *data);
7469 /* Make sure any errors from previous requests have been dealt with. */
7470 XSync (dpy, False);
7472 data->dpy = dpy;
7473 data->string[0] = 0;
7474 data->prev = x_error_message;
7475 x_error_message = data;
7478 /* Undo the last x_catch_errors call.
7479 DPY should be the display that was passed to x_catch_errors. */
7481 void
7482 x_uncatch_errors (void)
7484 struct x_error_message_stack *tmp;
7486 block_input ();
7488 /* The display may have been closed before this function is called.
7489 Check if it is still open before calling XSync. */
7490 if (x_display_info_for_display (x_error_message->dpy) != 0)
7491 XSync (x_error_message->dpy, False);
7493 tmp = x_error_message;
7494 x_error_message = x_error_message->prev;
7495 xfree (tmp);
7496 unblock_input ();
7499 /* If any X protocol errors have arrived since the last call to
7500 x_catch_errors or x_check_errors, signal an Emacs error using
7501 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7503 void
7504 x_check_errors (Display *dpy, const char *format)
7506 /* Make sure to catch any errors incurred so far. */
7507 XSync (dpy, False);
7509 if (x_error_message->string[0])
7511 char string[X_ERROR_MESSAGE_SIZE];
7512 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7513 x_uncatch_errors ();
7514 error (format, string);
7518 /* Nonzero if we had any X protocol errors
7519 since we did x_catch_errors on DPY. */
7521 bool
7522 x_had_errors_p (Display *dpy)
7524 /* Make sure to catch any errors incurred so far. */
7525 XSync (dpy, False);
7527 return x_error_message->string[0] != 0;
7530 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7532 void
7533 x_clear_errors (Display *dpy)
7535 x_error_message->string[0] = 0;
7538 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7539 * idea. --lorentey */
7540 /* Close off all unclosed x_catch_errors calls. */
7542 void
7543 x_fully_uncatch_errors (void)
7545 while (x_error_message)
7546 x_uncatch_errors ();
7548 #endif
7550 #if 0
7551 static unsigned int x_wire_count;
7552 x_trace_wire (void)
7554 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7556 #endif /* ! 0 */
7559 /************************************************************************
7560 Handling X errors
7561 ************************************************************************/
7563 /* Error message passed to x_connection_closed. */
7565 static char *error_msg;
7567 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7568 the text of an error message that lead to the connection loss. */
7570 static void
7571 x_connection_closed (Display *dpy, const char *error_message)
7573 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7574 Lisp_Object frame, tail;
7575 ptrdiff_t idx = SPECPDL_INDEX ();
7577 error_msg = alloca (strlen (error_message) + 1);
7578 strcpy (error_msg, error_message);
7580 /* Inhibit redisplay while frames are being deleted. */
7581 specbind (Qinhibit_redisplay, Qt);
7583 if (dpyinfo)
7585 /* Protect display from being closed when we delete the last
7586 frame on it. */
7587 dpyinfo->reference_count++;
7588 dpyinfo->terminal->reference_count++;
7591 /* First delete frames whose mini-buffers are on frames
7592 that are on the dead display. */
7593 FOR_EACH_FRAME (tail, frame)
7595 Lisp_Object minibuf_frame;
7596 minibuf_frame
7597 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7598 if (FRAME_X_P (XFRAME (frame))
7599 && FRAME_X_P (XFRAME (minibuf_frame))
7600 && ! EQ (frame, minibuf_frame)
7601 && FRAME_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7602 delete_frame (frame, Qnoelisp);
7605 /* Now delete all remaining frames on the dead display.
7606 We are now sure none of these is used as the mini-buffer
7607 for another frame that we need to delete. */
7608 FOR_EACH_FRAME (tail, frame)
7609 if (FRAME_X_P (XFRAME (frame))
7610 && FRAME_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7612 /* Set this to t so that delete_frame won't get confused
7613 trying to find a replacement. */
7614 kset_default_minibuffer_frame (FRAME_KBOARD (XFRAME (frame)), Qt);
7615 delete_frame (frame, Qnoelisp);
7618 /* If DPYINFO is null, this means we didn't open the display in the
7619 first place, so don't try to close it. */
7620 if (dpyinfo)
7622 /* We can not call XtCloseDisplay here because it calls XSync.
7623 XSync inside the error handler apparently hangs Emacs. On
7624 current Xt versions, this isn't needed either. */
7625 #ifdef USE_GTK
7626 /* A long-standing GTK bug prevents proper disconnect handling
7627 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7628 the resulting Glib error message loop filled a user's disk.
7629 To avoid this, kill Emacs unconditionally on disconnect. */
7630 shut_down_emacs (0, Qnil);
7631 fprintf (stderr, "%s\n\
7632 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7633 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7634 For details, see etc/PROBLEMS.\n",
7635 error_msg);
7636 emacs_abort ();
7637 #endif /* USE_GTK */
7639 /* Indicate that this display is dead. */
7640 dpyinfo->display = 0;
7642 dpyinfo->reference_count--;
7643 dpyinfo->terminal->reference_count--;
7644 if (dpyinfo->reference_count != 0)
7645 /* We have just closed all frames on this display. */
7646 emacs_abort ();
7649 Lisp_Object tmp;
7650 XSETTERMINAL (tmp, dpyinfo->terminal);
7651 Fdelete_terminal (tmp, Qnoelisp);
7655 if (terminal_list == 0)
7657 fprintf (stderr, "%s\n", error_msg);
7658 Fkill_emacs (make_number (70));
7659 /* NOTREACHED */
7662 totally_unblock_input ();
7664 unbind_to (idx, Qnil);
7665 clear_waiting_for_input ();
7667 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
7668 IF_LINT (if (! terminal_list) return; )
7670 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7671 longjmp), because returning from this function would get us back into
7672 Xlib's code which will directly call `exit'. */
7673 error ("%s", error_msg);
7676 /* We specifically use it before defining it, so that gcc doesn't inline it,
7677 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7678 static void x_error_quitter (Display *, XErrorEvent *);
7680 /* This is the first-level handler for X protocol errors.
7681 It calls x_error_quitter or x_error_catcher. */
7683 static int
7684 x_error_handler (Display *display, XErrorEvent *event)
7686 #if defined USE_GTK && defined HAVE_GTK3
7687 if ((event->error_code == BadMatch || event->error_code == BadWindow)
7688 && event->request_code == X_SetInputFocus)
7690 return 0;
7692 #endif
7694 if (x_error_message)
7695 x_error_catcher (display, event);
7696 else
7697 x_error_quitter (display, event);
7698 return 0;
7701 /* This is the usual handler for X protocol errors.
7702 It kills all frames on the display that we got the error for.
7703 If that was the only one, it prints an error message and kills Emacs. */
7705 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7707 /* On older GCC versions, just putting x_error_quitter
7708 after x_error_handler prevents inlining into the former. */
7710 static void NO_INLINE
7711 x_error_quitter (Display *display, XErrorEvent *event)
7713 char buf[256], buf1[356];
7715 /* Ignore BadName errors. They can happen because of fonts
7716 or colors that are not defined. */
7718 if (event->error_code == BadName)
7719 return;
7721 /* Note that there is no real way portable across R3/R4 to get the
7722 original error handler. */
7724 XGetErrorText (display, event->error_code, buf, sizeof (buf));
7725 sprintf (buf1, "X protocol error: %s on protocol request %d",
7726 buf, event->request_code);
7727 x_connection_closed (display, buf1);
7731 /* This is the handler for X IO errors, always.
7732 It kills all frames on the display that we lost touch with.
7733 If that was the only one, it prints an error message and kills Emacs. */
7735 static int
7736 x_io_error_quitter (Display *display)
7738 char buf[256];
7740 snprintf (buf, sizeof buf, "Connection lost to X server `%s'",
7741 DisplayString (display));
7742 x_connection_closed (display, buf);
7743 return 0;
7746 /* Changing the font of the frame. */
7748 /* Give frame F the font FONT-OBJECT as its default font. The return
7749 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7750 frame. If it is negative, generate a new fontset from
7751 FONT-OBJECT. */
7753 Lisp_Object
7754 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7756 struct font *font = XFONT_OBJECT (font_object);
7757 int unit;
7759 if (fontset < 0)
7760 fontset = fontset_from_font (font_object);
7761 FRAME_FONTSET (f) = fontset;
7762 if (FRAME_FONT (f) == font)
7763 /* This font is already set in frame F. There's nothing more to
7764 do. */
7765 return font_object;
7767 FRAME_FONT (f) = font;
7768 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7769 FRAME_COLUMN_WIDTH (f) = font->average_width;
7770 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7772 FRAME_TOOL_BAR_HEIGHT (f) = FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f);
7773 FRAME_MENU_BAR_HEIGHT (f) = FRAME_MENU_BAR_LINES (f) * FRAME_LINE_HEIGHT (f);
7775 compute_fringe_widths (f, 1);
7777 unit = FRAME_COLUMN_WIDTH (f);
7778 #ifdef USE_TOOLKIT_SCROLL_BARS
7779 /* The width of a toolkit scrollbar does not change with the new
7780 font but we have to calculate the number of columns it occupies
7781 anew. */
7782 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7783 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + unit - 1) / unit;
7784 #else
7785 /* The width of a non-toolkit scrollbar is at least 14 pixels and a
7786 multiple of the frame's character width. */
7787 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + unit - 1) / unit;
7788 FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
7789 = FRAME_CONFIG_SCROLL_BAR_COLS (f) * unit;
7790 #endif
7792 if (FRAME_X_WINDOW (f) != 0)
7794 /* Don't change the size of a tip frame; there's no point in
7795 doing it because it's done in Fx_show_tip, and it leads to
7796 problems because the tip frame has no widget. */
7797 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7798 x_set_window_size (f, 0, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
7799 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 1);
7802 #ifdef HAVE_X_I18N
7803 if (FRAME_XIC (f)
7804 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7806 block_input ();
7807 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7808 unblock_input ();
7810 #endif
7812 return font_object;
7816 /***********************************************************************
7817 X Input Methods
7818 ***********************************************************************/
7820 #ifdef HAVE_X_I18N
7822 #ifdef HAVE_X11R6
7824 /* XIM destroy callback function, which is called whenever the
7825 connection to input method XIM dies. CLIENT_DATA contains a
7826 pointer to the x_display_info structure corresponding to XIM. */
7828 static void
7829 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7831 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7832 Lisp_Object frame, tail;
7834 block_input ();
7836 /* No need to call XDestroyIC.. */
7837 FOR_EACH_FRAME (tail, frame)
7839 struct frame *f = XFRAME (frame);
7840 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo)
7842 FRAME_XIC (f) = NULL;
7843 xic_free_xfontset (f);
7847 /* No need to call XCloseIM. */
7848 dpyinfo->xim = NULL;
7849 XFree (dpyinfo->xim_styles);
7850 unblock_input ();
7853 #endif /* HAVE_X11R6 */
7855 #ifdef HAVE_X11R6
7856 /* This isn't prototyped in OSF 5.0 or 5.1a. */
7857 extern char *XSetIMValues (XIM, ...);
7858 #endif
7860 /* Open the connection to the XIM server on display DPYINFO.
7861 RESOURCE_NAME is the resource name Emacs uses. */
7863 static void
7864 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
7866 XIM xim;
7868 #ifdef HAVE_XIM
7869 if (use_xim)
7871 if (dpyinfo->xim)
7872 XCloseIM (dpyinfo->xim);
7873 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
7874 emacs_class);
7875 dpyinfo->xim = xim;
7877 if (xim)
7879 #ifdef HAVE_X11R6
7880 XIMCallback destroy;
7881 #endif
7883 /* Get supported styles and XIM values. */
7884 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
7886 #ifdef HAVE_X11R6
7887 destroy.callback = xim_destroy_callback;
7888 destroy.client_data = (XPointer)dpyinfo;
7889 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
7890 #endif
7894 else
7895 #endif /* HAVE_XIM */
7896 dpyinfo->xim = NULL;
7900 #ifdef HAVE_X11R6_XIM
7902 /* XIM instantiate callback function, which is called whenever an XIM
7903 server is available. DISPLAY is the display of the XIM.
7904 CLIENT_DATA contains a pointer to an xim_inst_t structure created
7905 when the callback was registered. */
7907 static void
7908 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
7910 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
7911 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
7913 /* We don't support multiple XIM connections. */
7914 if (dpyinfo->xim)
7915 return;
7917 xim_open_dpy (dpyinfo, xim_inst->resource_name);
7919 /* Create XIC for the existing frames on the same display, as long
7920 as they have no XIC. */
7921 if (dpyinfo->xim && dpyinfo->reference_count > 0)
7923 Lisp_Object tail, frame;
7925 block_input ();
7926 FOR_EACH_FRAME (tail, frame)
7928 struct frame *f = XFRAME (frame);
7930 if (FRAME_X_P (f)
7931 && FRAME_DISPLAY_INFO (f) == xim_inst->dpyinfo)
7932 if (FRAME_XIC (f) == NULL)
7934 create_frame_xic (f);
7935 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
7936 xic_set_statusarea (f);
7937 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
7939 struct window *w = XWINDOW (f->selected_window);
7940 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
7945 unblock_input ();
7949 #endif /* HAVE_X11R6_XIM */
7952 /* Open a connection to the XIM server on display DPYINFO.
7953 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
7954 connection only at the first time. On X11R6, open the connection
7955 in the XIM instantiate callback function. */
7957 static void
7958 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
7960 dpyinfo->xim = NULL;
7961 #ifdef HAVE_XIM
7962 if (use_xim)
7964 #ifdef HAVE_X11R6_XIM
7965 struct xim_inst_t *xim_inst = xmalloc (sizeof *xim_inst);
7966 Bool ret;
7968 dpyinfo->xim_callback_data = xim_inst;
7969 xim_inst->dpyinfo = dpyinfo;
7970 xim_inst->resource_name = xstrdup (resource_name);
7971 ret = XRegisterIMInstantiateCallback
7972 (dpyinfo->display, dpyinfo->xrdb, xim_inst->resource_name,
7973 emacs_class, xim_instantiate_callback,
7974 /* This is XPointer in XFree86 but (XPointer *)
7975 on Tru64, at least, hence the configure test. */
7976 (XRegisterIMInstantiateCallback_arg6) xim_inst);
7977 eassert (ret == True);
7978 #else /* not HAVE_X11R6_XIM */
7979 xim_open_dpy (dpyinfo, resource_name);
7980 #endif /* not HAVE_X11R6_XIM */
7982 #endif /* HAVE_XIM */
7986 /* Close the connection to the XIM server on display DPYINFO. */
7988 static void
7989 xim_close_dpy (struct x_display_info *dpyinfo)
7991 #ifdef HAVE_XIM
7992 if (use_xim)
7994 #ifdef HAVE_X11R6_XIM
7995 struct xim_inst_t *xim_inst = dpyinfo->xim_callback_data;
7997 if (dpyinfo->display)
7999 Bool ret = XUnregisterIMInstantiateCallback
8000 (dpyinfo->display, dpyinfo->xrdb, xim_inst->resource_name,
8001 emacs_class, xim_instantiate_callback,
8002 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8003 eassert (ret == True);
8005 xfree (xim_inst->resource_name);
8006 xfree (xim_inst);
8007 #endif /* HAVE_X11R6_XIM */
8008 if (dpyinfo->display)
8009 XCloseIM (dpyinfo->xim);
8010 dpyinfo->xim = NULL;
8011 XFree (dpyinfo->xim_styles);
8013 #endif /* HAVE_XIM */
8016 #endif /* not HAVE_X11R6_XIM */
8020 /* Calculate the absolute position in frame F
8021 from its current recorded position values and gravity. */
8023 static void
8024 x_calc_absolute_position (struct frame *f)
8026 int flags = f->size_hint_flags;
8028 /* We have nothing to do if the current position
8029 is already for the top-left corner. */
8030 if (! ((flags & XNegative) || (flags & YNegative)))
8031 return;
8033 /* Treat negative positions as relative to the leftmost bottommost
8034 position that fits on the screen. */
8035 if (flags & XNegative)
8036 f->left_pos = x_display_pixel_width (FRAME_DISPLAY_INFO (f))
8037 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8040 int height = FRAME_PIXEL_HEIGHT (f);
8042 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8043 /* Something is fishy here. When using Motif, starting Emacs with
8044 `-g -0-0', the frame appears too low by a few pixels.
8046 This seems to be so because initially, while Emacs is starting,
8047 the column widget's height and the frame's pixel height are
8048 different. The column widget's height is the right one. In
8049 later invocations, when Emacs is up, the frame's pixel height
8050 is right, though.
8052 It's not obvious where the initial small difference comes from.
8053 2000-12-01, gerd. */
8055 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8056 #endif
8058 if (flags & YNegative)
8059 f->top_pos = x_display_pixel_height (FRAME_DISPLAY_INFO (f))
8060 - height + f->top_pos;
8063 /* The left_pos and top_pos
8064 are now relative to the top and left screen edges,
8065 so the flags should correspond. */
8066 f->size_hint_flags &= ~ (XNegative | YNegative);
8069 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8070 to really change the position, and 0 when calling from
8071 x_make_frame_visible (in that case, XOFF and YOFF are the current
8072 position values). It is -1 when calling from x_set_frame_parameters,
8073 which means, do adjust for borders but don't change the gravity. */
8075 void
8076 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8078 int modified_top, modified_left;
8080 if (change_gravity > 0)
8082 f->top_pos = yoff;
8083 f->left_pos = xoff;
8084 f->size_hint_flags &= ~ (XNegative | YNegative);
8085 if (xoff < 0)
8086 f->size_hint_flags |= XNegative;
8087 if (yoff < 0)
8088 f->size_hint_flags |= YNegative;
8089 f->win_gravity = NorthWestGravity;
8091 x_calc_absolute_position (f);
8093 block_input ();
8094 x_wm_set_size_hint (f, (long) 0, 0);
8096 modified_left = f->left_pos;
8097 modified_top = f->top_pos;
8099 if (change_gravity != 0 && FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8101 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8102 than the WM decorations. So we use the calculated offset instead
8103 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8104 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8105 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8108 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8109 modified_left, modified_top);
8111 x_sync_with_move (f, f->left_pos, f->top_pos,
8112 FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8113 ? 1 : 0);
8115 /* change_gravity is non-zero when this function is called from Lisp to
8116 programmatically move a frame. In that case, we call
8117 x_check_expected_move to discover if we have a "Type A" or "Type B"
8118 window manager, and, for a "Type A" window manager, adjust the position
8119 of the frame.
8121 We call x_check_expected_move if a programmatic move occurred, and
8122 either the window manager type (A/B) is unknown or it is Type A but we
8123 need to compute the top/left offset adjustment for this frame. */
8125 if (change_gravity != 0 &&
8126 (FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8127 || (FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8128 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8129 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8130 x_check_expected_move (f, modified_left, modified_top);
8132 unblock_input ();
8135 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8136 on the root window for frame F contains ATOMNAME.
8137 This is how a WM check shall be done according to the Window Manager
8138 Specification/Extended Window Manager Hints at
8139 http://freedesktop.org/wiki/Specifications/wm-spec. */
8141 static int
8142 wm_supports (struct frame *f, Atom want_atom)
8144 Atom actual_type;
8145 unsigned long actual_size, bytes_remaining;
8146 int i, rc, actual_format;
8147 Window wmcheck_window;
8148 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
8149 Window target_window = dpyinfo->root_window;
8150 long max_len = 65536;
8151 Display *dpy = FRAME_X_DISPLAY (f);
8152 unsigned char *tmp_data = NULL;
8153 Atom target_type = XA_WINDOW;
8155 block_input ();
8157 x_catch_errors (dpy);
8158 rc = XGetWindowProperty (dpy, target_window,
8159 dpyinfo->Xatom_net_supporting_wm_check,
8160 0, max_len, False, target_type,
8161 &actual_type, &actual_format, &actual_size,
8162 &bytes_remaining, &tmp_data);
8164 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8166 if (tmp_data) XFree (tmp_data);
8167 x_uncatch_errors ();
8168 unblock_input ();
8169 return 0;
8172 wmcheck_window = *(Window *) tmp_data;
8173 XFree (tmp_data);
8175 /* Check if window exists. */
8176 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8177 x_sync (f);
8178 if (x_had_errors_p (dpy))
8180 x_uncatch_errors ();
8181 unblock_input ();
8182 return 0;
8185 if (dpyinfo->net_supported_window != wmcheck_window)
8187 /* Window changed, reload atoms */
8188 if (dpyinfo->net_supported_atoms != NULL)
8189 XFree (dpyinfo->net_supported_atoms);
8190 dpyinfo->net_supported_atoms = NULL;
8191 dpyinfo->nr_net_supported_atoms = 0;
8192 dpyinfo->net_supported_window = 0;
8194 target_type = XA_ATOM;
8195 tmp_data = NULL;
8196 rc = XGetWindowProperty (dpy, target_window,
8197 dpyinfo->Xatom_net_supported,
8198 0, max_len, False, target_type,
8199 &actual_type, &actual_format, &actual_size,
8200 &bytes_remaining, &tmp_data);
8202 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8204 if (tmp_data) XFree (tmp_data);
8205 x_uncatch_errors ();
8206 unblock_input ();
8207 return 0;
8210 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8211 dpyinfo->nr_net_supported_atoms = actual_size;
8212 dpyinfo->net_supported_window = wmcheck_window;
8215 rc = 0;
8217 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8218 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8220 x_uncatch_errors ();
8221 unblock_input ();
8223 return rc;
8226 static void
8227 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8229 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (XFRAME (frame));
8231 x_send_client_event (frame, make_number (0), frame,
8232 dpyinfo->Xatom_net_wm_state,
8233 make_number (32),
8234 /* 1 = add, 0 = remove */
8235 Fcons
8236 (make_number (add ? 1 : 0),
8237 Fcons
8238 (make_fixnum_or_float (atom),
8239 (value != 0
8240 ? list1 (make_fixnum_or_float (value))
8241 : Qnil))));
8244 void
8245 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8247 Lisp_Object frame;
8248 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
8250 XSETFRAME (frame, f);
8252 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8253 dpyinfo->Xatom_net_wm_state_sticky, None);
8256 /* Return the current _NET_WM_STATE.
8257 SIZE_STATE is set to one of the FULLSCREEN_* values.
8258 STICKY is set to 1 if the sticky state is set, 0 if not.
8260 Return non-zero if we are not hidden, zero if we are. */
8262 static int
8263 get_current_wm_state (struct frame *f,
8264 Window window,
8265 int *size_state,
8266 int *sticky)
8268 Atom actual_type;
8269 unsigned long actual_size, bytes_remaining;
8270 int i, rc, actual_format, is_hidden = 0;
8271 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
8272 long max_len = 65536;
8273 Display *dpy = FRAME_X_DISPLAY (f);
8274 unsigned char *tmp_data = NULL;
8275 Atom target_type = XA_ATOM;
8277 *sticky = 0;
8278 *size_state = FULLSCREEN_NONE;
8280 block_input ();
8281 x_catch_errors (dpy);
8282 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8283 0, max_len, False, target_type,
8284 &actual_type, &actual_format, &actual_size,
8285 &bytes_remaining, &tmp_data);
8287 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8289 if (tmp_data) XFree (tmp_data);
8290 x_uncatch_errors ();
8291 unblock_input ();
8292 return !FRAME_ICONIFIED_P (f);
8295 x_uncatch_errors ();
8297 for (i = 0; i < actual_size; ++i)
8299 Atom a = ((Atom*)tmp_data)[i];
8300 if (a == dpyinfo->Xatom_net_wm_state_hidden)
8302 is_hidden = 1;
8303 f->output_data.x->net_wm_state_hidden_seen = 1;
8305 else if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8307 if (*size_state == FULLSCREEN_HEIGHT)
8308 *size_state = FULLSCREEN_MAXIMIZED;
8309 else
8310 *size_state = FULLSCREEN_WIDTH;
8312 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8314 if (*size_state == FULLSCREEN_WIDTH)
8315 *size_state = FULLSCREEN_MAXIMIZED;
8316 else
8317 *size_state = FULLSCREEN_HEIGHT;
8319 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8320 *size_state = FULLSCREEN_BOTH;
8321 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8322 *sticky = 1;
8325 if (tmp_data) XFree (tmp_data);
8326 unblock_input ();
8327 return ! is_hidden;
8330 /* Do fullscreen as specified in extended window manager hints */
8332 static int
8333 do_ewmh_fullscreen (struct frame *f)
8335 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
8336 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8337 int cur, dummy;
8339 (void)get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8341 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8342 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8343 if (!have_net_atom)
8344 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8346 if (have_net_atom && cur != f->want_fullscreen)
8348 Lisp_Object frame;
8350 XSETFRAME (frame, f);
8352 /* Keep number of calls to set_wm_state as low as possible.
8353 Some window managers, or possible Gtk+, hangs when too many
8354 are sent at once. */
8355 switch (f->want_fullscreen)
8357 case FULLSCREEN_BOTH:
8358 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8359 || cur == FULLSCREEN_HEIGHT)
8360 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8361 dpyinfo->Xatom_net_wm_state_maximized_vert);
8362 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8363 break;
8364 case FULLSCREEN_WIDTH:
8365 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8366 || cur == FULLSCREEN_MAXIMIZED)
8367 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8368 dpyinfo->Xatom_net_wm_state_maximized_vert);
8369 if (cur != FULLSCREEN_MAXIMIZED)
8370 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8371 break;
8372 case FULLSCREEN_HEIGHT:
8373 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8374 || cur == FULLSCREEN_MAXIMIZED)
8375 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8376 dpyinfo->Xatom_net_wm_state_maximized_horz);
8377 if (cur != FULLSCREEN_MAXIMIZED)
8378 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8379 break;
8380 case FULLSCREEN_MAXIMIZED:
8381 if (cur == FULLSCREEN_BOTH)
8382 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8383 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8384 dpyinfo->Xatom_net_wm_state_maximized_vert);
8385 break;
8386 case FULLSCREEN_NONE:
8387 if (cur == FULLSCREEN_BOTH)
8388 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8389 else
8390 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8391 dpyinfo->Xatom_net_wm_state_maximized_vert);
8394 f->want_fullscreen = FULLSCREEN_NONE;
8398 return have_net_atom;
8401 static void
8402 XTfullscreen_hook (struct frame *f)
8404 if (FRAME_VISIBLE_P (f))
8406 block_input ();
8407 x_check_fullscreen (f);
8408 x_sync (f);
8409 unblock_input ();
8414 static int
8415 x_handle_net_wm_state (struct frame *f, const XPropertyEvent *event)
8417 int value = FULLSCREEN_NONE;
8418 Lisp_Object lval;
8419 int sticky = 0;
8420 int not_hidden = get_current_wm_state (f, event->window, &value, &sticky);
8422 lval = Qnil;
8423 switch (value)
8425 case FULLSCREEN_WIDTH:
8426 lval = Qfullwidth;
8427 break;
8428 case FULLSCREEN_HEIGHT:
8429 lval = Qfullheight;
8430 break;
8431 case FULLSCREEN_BOTH:
8432 lval = Qfullboth;
8433 break;
8434 case FULLSCREEN_MAXIMIZED:
8435 lval = Qmaximized;
8436 break;
8439 store_frame_param (f, Qfullscreen, lval);
8440 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8442 return not_hidden;
8445 /* Check if we need to resize the frame due to a fullscreen request.
8446 If so needed, resize the frame. */
8447 static void
8448 x_check_fullscreen (struct frame *f)
8450 if (do_ewmh_fullscreen (f))
8451 return;
8453 if (f->output_data.x->parent_desc != FRAME_DISPLAY_INFO (f)->root_window)
8454 return; /* Only fullscreen without WM or with EWM hints (above). */
8456 /* Setting fullscreen to nil doesn't do anything. We could save the
8457 last non-fullscreen size and restore it, but it seems like a
8458 lot of work for this unusual case (no window manager running). */
8460 if (f->want_fullscreen != FULLSCREEN_NONE)
8462 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8463 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
8465 switch (f->want_fullscreen)
8467 /* No difference between these two when there is no WM */
8468 case FULLSCREEN_BOTH:
8469 case FULLSCREEN_MAXIMIZED:
8470 width = x_display_pixel_width (dpyinfo);
8471 height = x_display_pixel_height (dpyinfo);
8472 break;
8473 case FULLSCREEN_WIDTH:
8474 width = x_display_pixel_width (dpyinfo);
8475 break;
8476 case FULLSCREEN_HEIGHT:
8477 height = x_display_pixel_height (dpyinfo);
8480 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8481 width, height);
8485 /* This function is called by x_set_offset to determine whether the window
8486 manager interfered with the positioning of the frame. Type A window
8487 managers position the surrounding window manager decorations a small
8488 amount above and left of the user-supplied position. Type B window
8489 managers position the surrounding window manager decorations at the
8490 user-specified position. If we detect a Type A window manager, we
8491 compensate by moving the window right and down by the proper amount. */
8493 static void
8494 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8496 int current_left = 0, current_top = 0;
8498 /* x_real_positions returns the left and top offsets of the outermost
8499 window manager window around the frame. */
8501 x_real_positions (f, &current_left, &current_top);
8503 if (current_left != expected_left || current_top != expected_top)
8505 /* It's a "Type A" window manager. */
8507 int adjusted_left;
8508 int adjusted_top;
8510 FRAME_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8511 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8512 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8514 /* Now fix the mispositioned frame's location. */
8516 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8517 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8519 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8520 adjusted_left, adjusted_top);
8522 x_sync_with_move (f, expected_left, expected_top, 0);
8524 else
8525 /* It's a "Type B" window manager. We don't have to adjust the
8526 frame's position. */
8528 FRAME_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8532 /* Wait for XGetGeometry to return up-to-date position information for a
8533 recently-moved frame. Call this immediately after calling XMoveWindow.
8534 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8535 frame has been moved to, so we use a fuzzy position comparison instead
8536 of an exact comparison. */
8538 static void
8539 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8541 int count = 0;
8543 while (count++ < 50)
8545 int current_left = 0, current_top = 0;
8547 /* In theory, this call to XSync only needs to happen once, but in
8548 practice, it doesn't seem to work, hence the need for the surrounding
8549 loop. */
8551 XSync (FRAME_X_DISPLAY (f), False);
8552 x_real_positions (f, &current_left, &current_top);
8554 if (fuzzy)
8556 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8557 pixels. */
8559 if (eabs (current_left - left) <= 10
8560 && eabs (current_top - top) <= 40)
8561 return;
8563 else if (current_left == left && current_top == top)
8564 return;
8567 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8568 will then return up-to-date position info. */
8570 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8574 /* Wait for an event on frame F matching EVENTTYPE. */
8575 void
8576 x_wait_for_event (struct frame *f, int eventtype)
8578 int level = interrupt_input_blocked;
8580 fd_set fds;
8581 struct timespec tmo, tmo_at, time_now;
8582 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8584 f->wait_event_type = eventtype;
8586 /* Set timeout to 0.1 second. Hopefully not noticeable.
8587 Maybe it should be configurable. */
8588 tmo = make_timespec (0, 100 * 1000 * 1000);
8589 tmo_at = timespec_add (current_timespec (), tmo);
8591 while (f->wait_event_type)
8593 pending_signals = 1;
8594 totally_unblock_input ();
8595 /* XTread_socket is called after unblock. */
8596 block_input ();
8597 interrupt_input_blocked = level;
8599 FD_ZERO (&fds);
8600 FD_SET (fd, &fds);
8602 time_now = current_timespec ();
8603 if (timespec_cmp (tmo_at, time_now) < 0)
8604 break;
8606 tmo = timespec_sub (tmo_at, time_now);
8607 if (pselect (fd + 1, &fds, NULL, NULL, &tmo, NULL) == 0)
8608 break; /* Timeout */
8611 f->wait_event_type = 0;
8615 /* Change the size of frame F's X window to COLS/ROWS in the case F
8616 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8617 top-left-corner window gravity for this size change and subsequent
8618 size changes. Otherwise we leave the window gravity unchanged. */
8620 static void
8621 x_set_window_size_1 (struct frame *f, int change_gravity, int width, int height, bool pixelwise)
8623 int pixelwidth, pixelheight;
8625 check_frame_size (f, &width, &height, pixelwise);
8627 compute_fringe_widths (f, 0);
8629 pixelwidth = ((pixelwise
8630 ? FRAME_TEXT_TO_PIXEL_WIDTH (f, width)
8631 : FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, width))
8632 + FRAME_TOOLBAR_WIDTH (f));
8633 pixelheight = ((pixelwise
8634 ? FRAME_TEXT_TO_PIXEL_HEIGHT (f, height)
8635 : FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, height))
8636 + FRAME_MENUBAR_HEIGHT (f)
8637 + FRAME_TOOLBAR_HEIGHT (f));
8638 if (change_gravity) f->win_gravity = NorthWestGravity;
8639 x_wm_set_size_hint (f, (long) 0, 0);
8640 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8641 pixelwidth, pixelheight);
8644 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8645 receive in the ConfigureNotify event; if we get what we asked
8646 for, then the event won't cause the screen to become garbaged, so
8647 we have to make sure to do it here. */
8648 SET_FRAME_GARBAGED (f);
8650 /* Now, strictly speaking, we can't be sure that this is accurate,
8651 but the window manager will get around to dealing with the size
8652 change request eventually, and we'll hear how it went when the
8653 ConfigureNotify event gets here.
8655 We could just not bother storing any of this information here,
8656 and let the ConfigureNotify event set everything up, but that
8657 might be kind of confusing to the Lisp code, since size changes
8658 wouldn't be reported in the frame parameters until some random
8659 point in the future when the ConfigureNotify event arrives.
8661 We pass 1 for DELAY since we can't run Lisp code inside of
8662 a BLOCK_INPUT. */
8664 /* But the ConfigureNotify may in fact never arrive, and then this is
8665 not right if the frame is visible. Instead wait (with timeout)
8666 for the ConfigureNotify. */
8667 if (FRAME_VISIBLE_P (f))
8668 x_wait_for_event (f, ConfigureNotify);
8669 else
8671 change_frame_size (f, width, height, 0, 1, 0, 1);
8672 x_sync (f);
8677 /* Call this to change the size of frame F's x-window.
8678 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8679 for this size change and subsequent size changes.
8680 Otherwise we leave the window gravity unchanged. */
8682 void
8683 x_set_window_size (struct frame *f, int change_gravity, int width, int height, bool pixelwise)
8685 block_input ();
8687 check_frame_size (f, &width, &height, pixelwise);
8689 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8691 int text_width, text_height;
8693 /* When the frame is maximized/fullscreen or running under for
8694 example Xmonad, x_set_window_size_1 will be a no-op.
8695 In that case, the right thing to do is extend rows/width to
8696 the current frame size. We do that first if x_set_window_size_1
8697 turns out to not be a no-op (there is no way to know).
8698 The size will be adjusted again if the frame gets a
8699 ConfigureNotify event as a result of x_set_window_size. */
8700 int pixelh = FRAME_PIXEL_HEIGHT (f);
8701 #ifdef USE_X_TOOLKIT
8702 /* The menu bar is not part of text lines. The tool bar
8703 is however. */
8704 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8705 #endif
8706 text_width = FRAME_PIXEL_TO_TEXT_WIDTH (f, FRAME_PIXEL_WIDTH (f));
8707 text_height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, pixelh);
8709 change_frame_size (f, text_width, text_height, 0, 1, 0, 1);
8712 #ifdef USE_GTK
8713 if (FRAME_GTK_WIDGET (f))
8714 if (! pixelwise)
8715 xg_frame_set_char_size (f, width * FRAME_COLUMN_WIDTH (f),
8716 height * FRAME_LINE_HEIGHT (f));
8717 else
8718 xg_frame_set_char_size (f, width, height);
8719 else
8720 x_set_window_size_1 (f, change_gravity, width, height, pixelwise);
8721 #else /* not USE_GTK */
8723 x_set_window_size_1 (f, change_gravity, width, height, pixelwise);
8724 #if !defined USE_X_TOOLKIT
8725 x_clear_under_internal_border (f);
8726 #endif
8728 #endif /* not USE_GTK */
8730 /* If cursor was outside the new size, mark it as off. */
8731 mark_window_cursors_off (XWINDOW (f->root_window));
8733 /* Clear out any recollection of where the mouse highlighting was,
8734 since it might be in a place that's outside the new frame size.
8735 Actually checking whether it is outside is a pain in the neck,
8736 so don't try--just let the highlighting be done afresh with new size. */
8737 cancel_mouse_face (f);
8739 unblock_input ();
8742 /* Mouse warping. */
8744 void
8745 x_set_mouse_position (struct frame *f, int x, int y)
8747 int pix_x, pix_y;
8749 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8750 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8752 if (pix_x < 0) pix_x = 0;
8753 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8755 if (pix_y < 0) pix_y = 0;
8756 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8758 block_input ();
8760 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8761 0, 0, 0, 0, pix_x, pix_y);
8762 unblock_input ();
8765 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8767 void
8768 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8770 block_input ();
8772 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8773 0, 0, 0, 0, pix_x, pix_y);
8774 unblock_input ();
8777 /* Raise frame F. */
8779 void
8780 x_raise_frame (struct frame *f)
8782 block_input ();
8783 if (FRAME_VISIBLE_P (f))
8784 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8785 XFlush (FRAME_X_DISPLAY (f));
8786 unblock_input ();
8789 /* Lower frame F. */
8791 static void
8792 x_lower_frame (struct frame *f)
8794 if (FRAME_VISIBLE_P (f))
8796 block_input ();
8797 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8798 XFlush (FRAME_X_DISPLAY (f));
8799 unblock_input ();
8803 /* Request focus with XEmbed */
8805 void
8806 xembed_request_focus (struct frame *f)
8808 /* See XEmbed Protocol Specification at
8809 http://freedesktop.org/wiki/Specifications/xembed-spec */
8810 if (FRAME_VISIBLE_P (f))
8811 xembed_send_message (f, CurrentTime,
8812 XEMBED_REQUEST_FOCUS, 0, 0, 0);
8815 /* Activate frame with Extended Window Manager Hints */
8817 void
8818 x_ewmh_activate_frame (struct frame *f)
8820 /* See Window Manager Specification/Extended Window Manager Hints at
8821 http://freedesktop.org/wiki/Specifications/wm-spec */
8823 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
8825 if (FRAME_VISIBLE_P (f) && wm_supports (f, dpyinfo->Xatom_net_active_window))
8827 Lisp_Object frame;
8828 XSETFRAME (frame, f);
8829 x_send_client_event (frame, make_number (0), frame,
8830 dpyinfo->Xatom_net_active_window,
8831 make_number (32),
8832 list2i (1, dpyinfo->last_user_time));
8836 static void
8837 XTframe_raise_lower (struct frame *f, int raise_flag)
8839 if (raise_flag)
8840 x_raise_frame (f);
8841 else
8842 x_lower_frame (f);
8845 /* XEmbed implementation. */
8847 #if defined USE_X_TOOLKIT || ! defined USE_GTK
8849 /* XEmbed implementation. */
8851 #define XEMBED_VERSION 0
8853 static void
8854 xembed_set_info (struct frame *f, enum xembed_info flags)
8856 unsigned long data[2];
8857 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
8859 data[0] = XEMBED_VERSION;
8860 data[1] = flags;
8862 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8863 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
8864 32, PropModeReplace, (unsigned char *) data, 2);
8866 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
8868 static void
8869 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
8870 long int detail, long int data1, long int data2)
8872 XEvent event;
8874 event.xclient.type = ClientMessage;
8875 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
8876 event.xclient.message_type = FRAME_DISPLAY_INFO (f)->Xatom_XEMBED;
8877 event.xclient.format = 32;
8878 event.xclient.data.l[0] = t;
8879 event.xclient.data.l[1] = msg;
8880 event.xclient.data.l[2] = detail;
8881 event.xclient.data.l[3] = data1;
8882 event.xclient.data.l[4] = data2;
8884 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
8885 False, NoEventMask, &event);
8886 XSync (FRAME_X_DISPLAY (f), False);
8889 /* Change of visibility. */
8891 /* This tries to wait until the frame is really visible.
8892 However, if the window manager asks the user where to position
8893 the frame, this will return before the user finishes doing that.
8894 The frame will not actually be visible at that time,
8895 but it will become visible later when the window manager
8896 finishes with it. */
8898 void
8899 x_make_frame_visible (struct frame *f)
8901 int original_top, original_left;
8903 block_input ();
8905 x_set_bitmap_icon (f);
8907 if (! FRAME_VISIBLE_P (f))
8909 /* We test FRAME_GARBAGED_P here to make sure we don't
8910 call x_set_offset a second time
8911 if we get to x_make_frame_visible a second time
8912 before the window gets really visible. */
8913 if (! FRAME_ICONIFIED_P (f)
8914 && ! FRAME_X_EMBEDDED_P (f)
8915 && ! f->output_data.x->asked_for_visible)
8916 x_set_offset (f, f->left_pos, f->top_pos, 0);
8918 f->output_data.x->asked_for_visible = 1;
8920 if (! EQ (Vx_no_window_manager, Qt))
8921 x_wm_set_window_state (f, NormalState);
8922 #ifdef USE_X_TOOLKIT
8923 if (FRAME_X_EMBEDDED_P (f))
8924 xembed_set_info (f, XEMBED_MAPPED);
8925 else
8927 /* This was XtPopup, but that did nothing for an iconified frame. */
8928 XtMapWidget (f->output_data.x->widget);
8930 #else /* not USE_X_TOOLKIT */
8931 #ifdef USE_GTK
8932 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
8933 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
8934 #else
8935 if (FRAME_X_EMBEDDED_P (f))
8936 xembed_set_info (f, XEMBED_MAPPED);
8937 else
8938 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8939 #endif /* not USE_GTK */
8940 #endif /* not USE_X_TOOLKIT */
8943 XFlush (FRAME_X_DISPLAY (f));
8945 /* Synchronize to ensure Emacs knows the frame is visible
8946 before we do anything else. We do this loop with input not blocked
8947 so that incoming events are handled. */
8949 Lisp_Object frame;
8950 /* This must be before UNBLOCK_INPUT
8951 since events that arrive in response to the actions above
8952 will set it when they are handled. */
8953 int previously_visible = f->output_data.x->has_been_visible;
8955 original_left = f->left_pos;
8956 original_top = f->top_pos;
8958 /* This must come after we set COUNT. */
8959 unblock_input ();
8961 /* We unblock here so that arriving X events are processed. */
8963 /* Now move the window back to where it was "supposed to be".
8964 But don't do it if the gravity is negative.
8965 When the gravity is negative, this uses a position
8966 that is 3 pixels too low. Perhaps that's really the border width.
8968 Don't do this if the window has never been visible before,
8969 because the window manager may choose the position
8970 and we don't want to override it. */
8972 if (! FRAME_VISIBLE_P (f)
8973 && ! FRAME_ICONIFIED_P (f)
8974 && ! FRAME_X_EMBEDDED_P (f)
8975 && f->win_gravity == NorthWestGravity
8976 && previously_visible)
8978 Drawable rootw;
8979 int x, y;
8980 unsigned int width, height, border, depth;
8982 block_input ();
8984 /* On some window managers (such as FVWM) moving an existing
8985 window, even to the same place, causes the window manager
8986 to introduce an offset. This can cause the window to move
8987 to an unexpected location. Check the geometry (a little
8988 slow here) and then verify that the window is in the right
8989 place. If the window is not in the right place, move it
8990 there, and take the potential window manager hit. */
8991 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8992 &rootw, &x, &y, &width, &height, &border, &depth);
8994 if (original_left != x || original_top != y)
8995 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8996 original_left, original_top);
8998 unblock_input ();
9001 XSETFRAME (frame, f);
9003 /* Process X events until a MapNotify event has been seen. */
9004 while (!FRAME_VISIBLE_P (f))
9006 /* Force processing of queued events. */
9007 x_sync (f);
9009 /* This hack is still in use at least for Cygwin. See
9010 http://lists.gnu.org/archive/html/emacs-devel/2013-12/msg00351.html.
9012 Machines that do polling rather than SIGIO have been
9013 observed to go into a busy-wait here. So we'll fake an
9014 alarm signal to let the handler know that there's something
9015 to be read. We used to raise a real alarm, but it seems
9016 that the handler isn't always enabled here. This is
9017 probably a bug. */
9018 if (input_polling_used ())
9020 /* It could be confusing if a real alarm arrives while
9021 processing the fake one. Turn it off and let the
9022 handler reset it. */
9023 int old_poll_suppress_count = poll_suppress_count;
9024 poll_suppress_count = 1;
9025 poll_for_input_1 ();
9026 poll_suppress_count = old_poll_suppress_count;
9029 if (XPending (FRAME_X_DISPLAY (f)))
9031 XEvent xev;
9032 XNextEvent (FRAME_X_DISPLAY (f), &xev);
9033 x_dispatch_event (&xev, FRAME_X_DISPLAY (f));
9039 /* Change from mapped state to withdrawn state. */
9041 /* Make the frame visible (mapped and not iconified). */
9043 void
9044 x_make_frame_invisible (struct frame *f)
9046 Window window;
9048 /* Use the frame's outermost window, not the one we normally draw on. */
9049 window = FRAME_OUTER_WINDOW (f);
9051 /* Don't keep the highlight on an invisible frame. */
9052 if (FRAME_DISPLAY_INFO (f)->x_highlight_frame == f)
9053 FRAME_DISPLAY_INFO (f)->x_highlight_frame = 0;
9055 block_input ();
9057 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9058 that the current position of the window is user-specified, rather than
9059 program-specified, so that when the window is mapped again, it will be
9060 placed at the same location, without forcing the user to position it
9061 by hand again (they have already done that once for this window.) */
9062 x_wm_set_size_hint (f, (long) 0, 1);
9064 #ifdef USE_GTK
9065 if (FRAME_GTK_OUTER_WIDGET (f))
9066 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9067 else
9068 #else
9069 if (FRAME_X_EMBEDDED_P (f))
9070 xembed_set_info (f, 0);
9071 else
9072 #endif
9075 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9076 DefaultScreen (FRAME_X_DISPLAY (f))))
9078 unblock_input ();
9079 error ("Can't notify window manager of window withdrawal");
9083 /* We can't distinguish this from iconification
9084 just by the event that we get from the server.
9085 So we can't win using the usual strategy of letting
9086 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9087 and synchronize with the server to make sure we agree. */
9088 SET_FRAME_VISIBLE (f, 0);
9089 SET_FRAME_ICONIFIED (f, 0);
9091 x_sync (f);
9093 unblock_input ();
9096 /* Change window state from mapped to iconified. */
9098 void
9099 x_iconify_frame (struct frame *f)
9101 #ifdef USE_X_TOOLKIT
9102 int result;
9103 #endif
9105 /* Don't keep the highlight on an invisible frame. */
9106 if (FRAME_DISPLAY_INFO (f)->x_highlight_frame == f)
9107 FRAME_DISPLAY_INFO (f)->x_highlight_frame = 0;
9109 if (FRAME_ICONIFIED_P (f))
9110 return;
9112 block_input ();
9114 x_set_bitmap_icon (f);
9116 #if defined (USE_GTK)
9117 if (FRAME_GTK_OUTER_WIDGET (f))
9119 if (! FRAME_VISIBLE_P (f))
9120 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9122 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9123 SET_FRAME_VISIBLE (f, 0);
9124 SET_FRAME_ICONIFIED (f, 1);
9125 unblock_input ();
9126 return;
9128 #endif
9130 #ifdef USE_X_TOOLKIT
9132 if (! FRAME_VISIBLE_P (f))
9134 if (! EQ (Vx_no_window_manager, Qt))
9135 x_wm_set_window_state (f, IconicState);
9136 /* This was XtPopup, but that did nothing for an iconified frame. */
9137 XtMapWidget (f->output_data.x->widget);
9138 /* The server won't give us any event to indicate
9139 that an invisible frame was changed to an icon,
9140 so we have to record it here. */
9141 SET_FRAME_VISIBLE (f, 0);
9142 SET_FRAME_ICONIFIED (f, 1);
9143 unblock_input ();
9144 return;
9147 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9148 XtWindow (f->output_data.x->widget),
9149 DefaultScreen (FRAME_X_DISPLAY (f)));
9150 unblock_input ();
9152 if (!result)
9153 error ("Can't notify window manager of iconification");
9155 SET_FRAME_ICONIFIED (f, 1);
9156 SET_FRAME_VISIBLE (f, 0);
9158 block_input ();
9159 XFlush (FRAME_X_DISPLAY (f));
9160 unblock_input ();
9161 #else /* not USE_X_TOOLKIT */
9163 /* Make sure the X server knows where the window should be positioned,
9164 in case the user deiconifies with the window manager. */
9165 if (! FRAME_VISIBLE_P (f)
9166 && ! FRAME_ICONIFIED_P (f)
9167 && ! FRAME_X_EMBEDDED_P (f))
9168 x_set_offset (f, f->left_pos, f->top_pos, 0);
9170 /* Since we don't know which revision of X we're running, we'll use both
9171 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9173 /* X11R4: send a ClientMessage to the window manager using the
9174 WM_CHANGE_STATE type. */
9176 XEvent msg;
9178 msg.xclient.window = FRAME_X_WINDOW (f);
9179 msg.xclient.type = ClientMessage;
9180 msg.xclient.message_type = FRAME_DISPLAY_INFO (f)->Xatom_wm_change_state;
9181 msg.xclient.format = 32;
9182 msg.xclient.data.l[0] = IconicState;
9184 if (! XSendEvent (FRAME_X_DISPLAY (f),
9185 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9186 False,
9187 SubstructureRedirectMask | SubstructureNotifyMask,
9188 &msg))
9190 unblock_input ();
9191 error ("Can't notify window manager of iconification");
9195 /* X11R3: set the initial_state field of the window manager hints to
9196 IconicState. */
9197 x_wm_set_window_state (f, IconicState);
9199 if (!FRAME_VISIBLE_P (f))
9201 /* If the frame was withdrawn, before, we must map it. */
9202 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9205 SET_FRAME_ICONIFIED (f, 1);
9206 SET_FRAME_VISIBLE (f, 0);
9208 XFlush (FRAME_X_DISPLAY (f));
9209 unblock_input ();
9210 #endif /* not USE_X_TOOLKIT */
9214 /* Free X resources of frame F. */
9216 void
9217 x_free_frame_resources (struct frame *f)
9219 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
9220 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9221 #ifdef USE_X_TOOLKIT
9222 Lisp_Object bar;
9223 struct scroll_bar *b;
9224 #endif
9226 block_input ();
9228 /* If a display connection is dead, don't try sending more
9229 commands to the X server. */
9230 if (dpyinfo->display)
9232 /* We must free faces before destroying windows because some
9233 font-driver (e.g. xft) access a window while finishing a
9234 face. */
9235 free_frame_faces (f);
9237 if (f->output_data.x->icon_desc)
9238 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9240 #ifdef USE_X_TOOLKIT
9241 /* Explicitly destroy the scroll bars of the frame. Without
9242 this, we get "BadDrawable" errors from the toolkit later on,
9243 presumably from expose events generated for the disappearing
9244 toolkit scroll bars. */
9245 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9247 b = XSCROLL_BAR (bar);
9248 x_scroll_bar_remove (b);
9250 #endif
9252 #ifdef HAVE_X_I18N
9253 if (FRAME_XIC (f))
9254 free_frame_xic (f);
9255 #endif
9257 #ifdef USE_X_TOOLKIT
9258 if (f->output_data.x->widget)
9260 XtDestroyWidget (f->output_data.x->widget);
9261 f->output_data.x->widget = NULL;
9263 /* Tooltips don't have widgets, only a simple X window, even if
9264 we are using a toolkit. */
9265 else if (FRAME_X_WINDOW (f))
9266 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9268 free_frame_menubar (f);
9269 #else /* !USE_X_TOOLKIT */
9271 #ifdef USE_GTK
9272 xg_free_frame_widgets (f);
9273 #endif /* USE_GTK */
9275 if (FRAME_X_WINDOW (f))
9276 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9277 #endif /* !USE_X_TOOLKIT */
9279 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9280 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9281 unload_color (f, f->output_data.x->cursor_pixel);
9282 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9283 unload_color (f, f->output_data.x->border_pixel);
9284 unload_color (f, f->output_data.x->mouse_pixel);
9286 if (f->output_data.x->scroll_bar_background_pixel != -1)
9287 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9288 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9289 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9290 #ifdef USE_TOOLKIT_SCROLL_BARS
9291 /* Scrollbar shadow colors. */
9292 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9293 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9294 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9295 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9296 #endif /* USE_TOOLKIT_SCROLL_BARS */
9297 if (f->output_data.x->white_relief.pixel != -1)
9298 unload_color (f, f->output_data.x->white_relief.pixel);
9299 if (f->output_data.x->black_relief.pixel != -1)
9300 unload_color (f, f->output_data.x->black_relief.pixel);
9302 x_free_gcs (f);
9304 /* Free extra GCs allocated by x_setup_relief_colors. */
9305 if (f->output_data.x->white_relief.gc)
9307 XFreeGC (dpyinfo->display, f->output_data.x->white_relief.gc);
9308 f->output_data.x->white_relief.gc = 0;
9310 if (f->output_data.x->black_relief.gc)
9312 XFreeGC (dpyinfo->display, f->output_data.x->black_relief.gc);
9313 f->output_data.x->black_relief.gc = 0;
9316 /* Free cursors. */
9317 if (f->output_data.x->text_cursor != 0)
9318 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->text_cursor);
9319 if (f->output_data.x->nontext_cursor != 0)
9320 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->nontext_cursor);
9321 if (f->output_data.x->modeline_cursor != 0)
9322 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->modeline_cursor);
9323 if (f->output_data.x->hand_cursor != 0)
9324 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->hand_cursor);
9325 if (f->output_data.x->hourglass_cursor != 0)
9326 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->hourglass_cursor);
9327 if (f->output_data.x->horizontal_drag_cursor != 0)
9328 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->horizontal_drag_cursor);
9329 if (f->output_data.x->vertical_drag_cursor != 0)
9330 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->vertical_drag_cursor);
9332 XFlush (FRAME_X_DISPLAY (f));
9335 xfree (f->output_data.x->saved_menu_event);
9336 xfree (f->output_data.x);
9337 f->output_data.x = NULL;
9339 if (f == dpyinfo->x_focus_frame)
9340 dpyinfo->x_focus_frame = 0;
9341 if (f == dpyinfo->x_focus_event_frame)
9342 dpyinfo->x_focus_event_frame = 0;
9343 if (f == dpyinfo->x_highlight_frame)
9344 dpyinfo->x_highlight_frame = 0;
9345 if (f == hlinfo->mouse_face_mouse_frame)
9346 reset_mouse_highlight (hlinfo);
9348 unblock_input ();
9352 /* Destroy the X window of frame F. */
9354 static void
9355 x_destroy_window (struct frame *f)
9357 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
9359 /* If a display connection is dead, don't try sending more
9360 commands to the X server. */
9361 if (dpyinfo->display != 0)
9362 x_free_frame_resources (f);
9364 dpyinfo->reference_count--;
9368 /* Setting window manager hints. */
9370 /* Set the normal size hints for the window manager, for frame F.
9371 FLAGS is the flags word to use--or 0 meaning preserve the flags
9372 that the window now has.
9373 If USER_POSITION, set the USPosition
9374 flag (this is useful when FLAGS is 0).
9375 The GTK version is in gtkutils.c. */
9377 #ifndef USE_GTK
9378 void
9379 x_wm_set_size_hint (struct frame *f, long flags, bool user_position)
9381 XSizeHints size_hints;
9382 Window window = FRAME_OUTER_WINDOW (f);
9384 #ifdef USE_X_TOOLKIT
9385 if (f->output_data.x->widget)
9387 widget_update_wm_size_hints (f->output_data.x->widget);
9388 return;
9390 #endif
9392 /* Setting PMaxSize caused various problems. */
9393 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9395 size_hints.x = f->left_pos;
9396 size_hints.y = f->top_pos;
9398 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9399 size_hints.width = FRAME_PIXEL_WIDTH (f);
9401 size_hints.width_inc = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
9402 size_hints.height_inc = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
9404 size_hints.max_width = x_display_pixel_width (FRAME_DISPLAY_INFO (f))
9405 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9406 size_hints.max_height = x_display_pixel_height (FRAME_DISPLAY_INFO (f))
9407 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9409 /* Calculate the base and minimum sizes. */
9411 int base_width, base_height;
9412 int min_rows = 0, min_cols = 0;
9414 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9415 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9417 check_frame_size (f, &min_cols, &min_rows, 0);
9419 if (frame_resize_pixelwise)
9420 /* Needed to prevent a bad protocol error crash when making the
9421 frame size very small. */
9423 min_cols = 2 * min_cols;
9424 min_rows = 2 * min_rows;
9427 /* The window manager uses the base width hints to calculate the
9428 current number of rows and columns in the frame while
9429 resizing; min_width and min_height aren't useful for this
9430 purpose, since they might not give the dimensions for a
9431 zero-row, zero-column frame.
9433 We use the base_width and base_height members if we have
9434 them; otherwise, we set the min_width and min_height members
9435 to the size for a zero x zero frame. */
9437 size_hints.flags |= PBaseSize;
9438 size_hints.base_width = base_width;
9439 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9440 size_hints.min_width = base_width + min_cols * FRAME_COLUMN_WIDTH (f);
9441 size_hints.min_height = base_height + min_rows * FRAME_LINE_HEIGHT (f);
9444 /* If we don't need the old flags, we don't need the old hint at all. */
9445 if (flags)
9447 size_hints.flags |= flags;
9448 goto no_read;
9452 XSizeHints hints; /* Sometimes I hate X Windows... */
9453 long supplied_return;
9454 int value;
9456 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9457 &supplied_return);
9459 if (flags)
9460 size_hints.flags |= flags;
9461 else
9463 if (value == 0)
9464 hints.flags = 0;
9465 if (hints.flags & PSize)
9466 size_hints.flags |= PSize;
9467 if (hints.flags & PPosition)
9468 size_hints.flags |= PPosition;
9469 if (hints.flags & USPosition)
9470 size_hints.flags |= USPosition;
9471 if (hints.flags & USSize)
9472 size_hints.flags |= USSize;
9476 no_read:
9478 #ifdef PWinGravity
9479 size_hints.win_gravity = f->win_gravity;
9480 size_hints.flags |= PWinGravity;
9482 if (user_position)
9484 size_hints.flags &= ~ PPosition;
9485 size_hints.flags |= USPosition;
9487 #endif /* PWinGravity */
9489 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9491 #endif /* not USE_GTK */
9493 /* Used for IconicState or NormalState */
9495 static void
9496 x_wm_set_window_state (struct frame *f, int state)
9498 #ifdef USE_X_TOOLKIT
9499 Arg al[1];
9501 XtSetArg (al[0], XtNinitialState, state);
9502 XtSetValues (f->output_data.x->widget, al, 1);
9503 #else /* not USE_X_TOOLKIT */
9504 Window window = FRAME_X_WINDOW (f);
9506 f->output_data.x->wm_hints.flags |= StateHint;
9507 f->output_data.x->wm_hints.initial_state = state;
9509 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9510 #endif /* not USE_X_TOOLKIT */
9513 static void
9514 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
9516 Pixmap icon_pixmap, icon_mask;
9518 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9519 Window window = FRAME_OUTER_WINDOW (f);
9520 #endif
9522 if (pixmap_id > 0)
9524 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9525 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9526 icon_mask = x_bitmap_mask (f, pixmap_id);
9527 f->output_data.x->wm_hints.icon_mask = icon_mask;
9529 else
9531 /* It seems there is no way to turn off use of an icon
9532 pixmap. */
9533 return;
9537 #ifdef USE_GTK
9539 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9540 return;
9543 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9546 Arg al[1];
9547 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9548 XtSetValues (f->output_data.x->widget, al, 1);
9549 XtSetArg (al[0], XtNiconMask, icon_mask);
9550 XtSetValues (f->output_data.x->widget, al, 1);
9553 #else /* not USE_X_TOOLKIT && not USE_GTK */
9555 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9556 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9558 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9561 void
9562 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9564 Window window = FRAME_OUTER_WINDOW (f);
9566 f->output_data.x->wm_hints.flags |= IconPositionHint;
9567 f->output_data.x->wm_hints.icon_x = icon_x;
9568 f->output_data.x->wm_hints.icon_y = icon_y;
9570 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9574 /***********************************************************************
9575 Fonts
9576 ***********************************************************************/
9578 #ifdef GLYPH_DEBUG
9580 /* Check that FONT is valid on frame F. It is if it can be found in F's
9581 font table. */
9583 static void
9584 x_check_font (struct frame *f, struct font *font)
9586 eassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9587 if (font->driver->check)
9588 eassert (font->driver->check (f, font) == 0);
9591 #endif /* GLYPH_DEBUG */
9594 /***********************************************************************
9595 Initialization
9596 ***********************************************************************/
9598 #ifdef USE_X_TOOLKIT
9599 static XrmOptionDescRec emacs_options[] = {
9600 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9601 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9603 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9604 XrmoptionSepArg, NULL},
9605 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9607 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9608 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9609 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9610 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9611 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9612 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9613 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9616 /* Whether atimer for Xt timeouts is activated or not. */
9618 static int x_timeout_atimer_activated_flag;
9620 #endif /* USE_X_TOOLKIT */
9622 static int x_initialized;
9624 /* Test whether two display-name strings agree up to the dot that separates
9625 the screen number from the server number. */
9626 static int
9627 same_x_server (const char *name1, const char *name2)
9629 int seen_colon = 0;
9630 const char *system_name = SSDATA (Vsystem_name);
9631 ptrdiff_t system_name_length = SBYTES (Vsystem_name);
9632 ptrdiff_t length_until_period = 0;
9634 while (system_name[length_until_period] != 0
9635 && system_name[length_until_period] != '.')
9636 length_until_period++;
9638 /* Treat `unix' like an empty host name. */
9639 if (! strncmp (name1, "unix:", 5))
9640 name1 += 4;
9641 if (! strncmp (name2, "unix:", 5))
9642 name2 += 4;
9643 /* Treat this host's name like an empty host name. */
9644 if (! strncmp (name1, system_name, system_name_length)
9645 && name1[system_name_length] == ':')
9646 name1 += system_name_length;
9647 if (! strncmp (name2, system_name, system_name_length)
9648 && name2[system_name_length] == ':')
9649 name2 += system_name_length;
9650 /* Treat this host's domainless name like an empty host name. */
9651 if (! strncmp (name1, system_name, length_until_period)
9652 && name1[length_until_period] == ':')
9653 name1 += length_until_period;
9654 if (! strncmp (name2, system_name, length_until_period)
9655 && name2[length_until_period] == ':')
9656 name2 += length_until_period;
9658 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9660 if (*name1 == ':')
9661 seen_colon = 1;
9662 if (seen_colon && *name1 == '.')
9663 return 1;
9665 return (seen_colon
9666 && (*name1 == '.' || *name1 == '\0')
9667 && (*name2 == '.' || *name2 == '\0'));
9670 /* Count number of set bits in mask and number of bits to shift to
9671 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9672 to 5. */
9673 static void
9674 get_bits_and_offset (unsigned long mask, int *bits, int *offset)
9676 int nr = 0;
9677 int off = 0;
9679 while (!(mask & 1))
9681 off++;
9682 mask >>= 1;
9685 while (mask & 1)
9687 nr++;
9688 mask >>= 1;
9691 *offset = off;
9692 *bits = nr;
9695 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9696 But don't permanently open it, just test its availability. */
9698 bool
9699 x_display_ok (const char *display)
9701 Display *dpy = XOpenDisplay (display);
9702 return dpy ? (XCloseDisplay (dpy), 1) : 0;
9705 #ifdef USE_GTK
9706 static void
9707 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
9708 const gchar *msg, gpointer user_data)
9710 if (!strstr (msg, "g_set_prgname"))
9711 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
9713 #endif
9715 /* Current X display connection identifier. Incremented for each next
9716 connection established. */
9717 static unsigned x_display_id;
9719 /* Open a connection to X display DISPLAY_NAME, and return
9720 the structure that describes the open display.
9721 If we cannot contact the display, return null. */
9723 struct x_display_info *
9724 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9726 int connection;
9727 Display *dpy;
9728 struct terminal *terminal;
9729 struct x_display_info *dpyinfo;
9730 XrmDatabase xrdb;
9731 ptrdiff_t lim;
9733 block_input ();
9735 if (!x_initialized)
9737 x_initialize ();
9738 ++x_initialized;
9741 if (! x_display_ok (SSDATA (display_name)))
9742 error ("Display %s can't be opened", SSDATA (display_name));
9744 #ifdef USE_GTK
9746 #define NUM_ARGV 10
9747 int argc;
9748 char *argv[NUM_ARGV];
9749 char **argv2 = argv;
9750 guint id;
9752 if (x_initialized++ > 1)
9754 xg_display_open (SSDATA (display_name), &dpy);
9756 else
9758 static char display_opt[] = "--display";
9759 static char name_opt[] = "--name";
9761 for (argc = 0; argc < NUM_ARGV; ++argc)
9762 argv[argc] = 0;
9764 argc = 0;
9765 argv[argc++] = initial_argv[0];
9767 if (! NILP (display_name))
9769 argv[argc++] = display_opt;
9770 argv[argc++] = SSDATA (display_name);
9773 argv[argc++] = name_opt;
9774 argv[argc++] = resource_name;
9776 XSetLocaleModifiers ("");
9778 /* Emacs can only handle core input events, so make sure
9779 Gtk doesn't use Xinput or Xinput2 extensions. */
9780 xputenv ("GDK_CORE_DEVICE_EVENTS=1");
9782 /* Work around GLib bug that outputs a faulty warning. See
9783 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9784 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9785 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9787 /* NULL window -> events for all windows go to our function.
9788 Call before gtk_init so Gtk+ event filters comes after our. */
9789 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9791 /* gtk_init does set_locale. Fix locale before and after. */
9792 fixup_locale ();
9793 gtk_init (&argc, &argv2);
9794 fixup_locale ();
9796 g_log_remove_handler ("GLib", id);
9798 xg_initialize ();
9800 dpy = DEFAULT_GDK_DISPLAY ();
9802 #if ! GTK_CHECK_VERSION (2, 90, 0)
9803 /* Load our own gtkrc if it exists. */
9805 const char *file = "~/.emacs.d/gtkrc";
9806 Lisp_Object s, abs_file;
9808 s = build_string (file);
9809 abs_file = Fexpand_file_name (s, Qnil);
9811 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9812 gtk_rc_parse (SSDATA (abs_file));
9814 #endif
9816 XSetErrorHandler (x_error_handler);
9817 XSetIOErrorHandler (x_io_error_quitter);
9820 #else /* not USE_GTK */
9821 #ifdef USE_X_TOOLKIT
9822 /* weiner@footloose.sps.mot.com reports that this causes
9823 errors with X11R5:
9824 X protocol error: BadAtom (invalid Atom parameter)
9825 on protocol request 18skiloaf.
9826 So let's not use it until R6. */
9827 #ifdef HAVE_X11XTR6
9828 XtSetLanguageProc (NULL, NULL, NULL);
9829 #endif
9832 int argc = 0;
9833 char *argv[3];
9835 argv[0] = "";
9836 argc = 1;
9837 if (xrm_option)
9839 argv[argc++] = "-xrm";
9840 argv[argc++] = xrm_option;
9842 turn_on_atimers (0);
9843 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
9844 resource_name, EMACS_CLASS,
9845 emacs_options, XtNumber (emacs_options),
9846 &argc, argv);
9847 turn_on_atimers (1);
9849 #ifdef HAVE_X11XTR6
9850 /* I think this is to compensate for XtSetLanguageProc. */
9851 fixup_locale ();
9852 #endif
9855 #else /* not USE_X_TOOLKIT */
9856 XSetLocaleModifiers ("");
9857 dpy = XOpenDisplay (SSDATA (display_name));
9858 #endif /* not USE_X_TOOLKIT */
9859 #endif /* not USE_GTK*/
9861 /* Detect failure. */
9862 if (dpy == 0)
9864 unblock_input ();
9865 return 0;
9868 /* We have definitely succeeded. Record the new connection. */
9870 dpyinfo = xzalloc (sizeof *dpyinfo);
9871 terminal = x_create_terminal (dpyinfo);
9874 struct x_display_info *share;
9876 for (share = x_display_list; share; share = share->next)
9877 if (same_x_server (SSDATA (XCAR (share->name_list_element)),
9878 SSDATA (display_name)))
9879 break;
9880 if (share)
9881 terminal->kboard = share->terminal->kboard;
9882 else
9884 terminal->kboard = allocate_kboard (Qx);
9886 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
9888 char *vendor = ServerVendor (dpy);
9890 /* Protect terminal from GC before removing it from the
9891 list of terminals. */
9892 struct gcpro gcpro1;
9893 Lisp_Object gcpro_term;
9894 XSETTERMINAL (gcpro_term, terminal);
9895 GCPRO1 (gcpro_term);
9897 /* Temporarily hide the partially initialized terminal. */
9898 terminal_list = terminal->next_terminal;
9899 unblock_input ();
9900 kset_system_key_alist
9901 (terminal->kboard,
9902 call1 (Qvendor_specific_keysyms,
9903 vendor ? build_string (vendor) : empty_unibyte_string));
9904 block_input ();
9905 terminal->next_terminal = terminal_list;
9906 terminal_list = terminal;
9907 UNGCPRO;
9910 /* Don't let the initial kboard remain current longer than necessary.
9911 That would cause problems if a file loaded on startup tries to
9912 prompt in the mini-buffer. */
9913 if (current_kboard == initial_kboard)
9914 current_kboard = terminal->kboard;
9916 terminal->kboard->reference_count++;
9919 /* Put this display on the chain. */
9920 dpyinfo->next = x_display_list;
9921 x_display_list = dpyinfo;
9923 dpyinfo->name_list_element = Fcons (display_name, Qnil);
9924 dpyinfo->display = dpy;
9926 /* Set the name of the terminal. */
9927 terminal->name = xlispstrdup (display_name);
9929 #if 0
9930 XSetAfterFunction (x_current_display, x_trace_wire);
9931 #endif /* ! 0 */
9933 lim = min (PTRDIFF_MAX, SIZE_MAX) - sizeof "@";
9934 if (lim - SBYTES (Vinvocation_name) < SBYTES (Vsystem_name))
9935 memory_full (SIZE_MAX);
9936 dpyinfo->x_id = ++x_display_id;
9937 dpyinfo->x_id_name = xmalloc (SBYTES (Vinvocation_name)
9938 + SBYTES (Vsystem_name) + 2);
9939 strcat (strcat (strcpy (dpyinfo->x_id_name, SSDATA (Vinvocation_name)), "@"),
9940 SSDATA (Vsystem_name));
9942 /* Figure out which modifier bits mean what. */
9943 x_find_modifier_meanings (dpyinfo);
9945 /* Get the scroll bar cursor. */
9946 #ifdef USE_GTK
9947 /* We must create a GTK cursor, it is required for GTK widgets. */
9948 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
9949 #endif /* USE_GTK */
9951 dpyinfo->vertical_scroll_bar_cursor
9952 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
9954 xrdb = x_load_resources (dpyinfo->display, xrm_option,
9955 resource_name, EMACS_CLASS);
9956 #ifdef HAVE_XRMSETDATABASE
9957 XrmSetDatabase (dpyinfo->display, xrdb);
9958 #else
9959 dpyinfo->display->db = xrdb;
9960 #endif
9961 /* Put the rdb where we can find it in a way that works on
9962 all versions. */
9963 dpyinfo->xrdb = xrdb;
9965 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
9966 DefaultScreen (dpyinfo->display));
9967 select_visual (dpyinfo);
9968 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
9969 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
9970 dpyinfo->icon_bitmap_id = -1;
9971 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
9973 reset_mouse_highlight (&dpyinfo->mouse_highlight);
9975 /* See if we can construct pixel values from RGB values. */
9976 if (dpyinfo->visual->class == TrueColor)
9978 get_bits_and_offset (dpyinfo->visual->red_mask,
9979 &dpyinfo->red_bits, &dpyinfo->red_offset);
9980 get_bits_and_offset (dpyinfo->visual->blue_mask,
9981 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
9982 get_bits_and_offset (dpyinfo->visual->green_mask,
9983 &dpyinfo->green_bits, &dpyinfo->green_offset);
9986 /* See if a private colormap is requested. */
9987 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
9989 if (dpyinfo->visual->class == PseudoColor)
9991 Lisp_Object value;
9992 value = display_x_get_resource (dpyinfo,
9993 build_string ("privateColormap"),
9994 build_string ("PrivateColormap"),
9995 Qnil, Qnil);
9996 if (STRINGP (value)
9997 && (!strcmp (SSDATA (value), "true")
9998 || !strcmp (SSDATA (value), "on")))
9999 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10002 else
10003 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10004 dpyinfo->visual, AllocNone);
10006 #ifdef HAVE_XFT
10008 /* If we are using Xft, check dpi value in X resources.
10009 It is better we use it as well, since Xft will use it, as will all
10010 Gnome applications. If our real DPI is smaller or larger than the
10011 one Xft uses, our font will look smaller or larger than other
10012 for other applications, even if it is the same font name (monospace-10
10013 for example). */
10014 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10015 double d;
10016 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10017 dpyinfo->resy = dpyinfo->resx = d;
10019 #endif
10021 if (dpyinfo->resy < 1)
10023 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10024 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10025 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10026 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10027 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10028 pixels = DisplayWidth (dpyinfo->display, screen_number);
10029 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10030 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10031 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10035 static const struct
10037 const char *name;
10038 int offset;
10039 } atom_refs[] = {
10040 #define ATOM_REFS_INIT(string, member) \
10041 { string, offsetof (struct x_display_info, member) },
10042 ATOM_REFS_INIT ("WM_PROTOCOLS", Xatom_wm_protocols)
10043 ATOM_REFS_INIT ("WM_TAKE_FOCUS", Xatom_wm_take_focus)
10044 ATOM_REFS_INIT ("WM_SAVE_YOURSELF", Xatom_wm_save_yourself)
10045 ATOM_REFS_INIT ("WM_DELETE_WINDOW", Xatom_wm_delete_window)
10046 ATOM_REFS_INIT ("WM_CHANGE_STATE", Xatom_wm_change_state)
10047 ATOM_REFS_INIT ("WM_CONFIGURE_DENIED", Xatom_wm_configure_denied)
10048 ATOM_REFS_INIT ("WM_MOVED", Xatom_wm_window_moved)
10049 ATOM_REFS_INIT ("WM_CLIENT_LEADER", Xatom_wm_client_leader)
10050 ATOM_REFS_INIT ("Editres", Xatom_editres)
10051 ATOM_REFS_INIT ("CLIPBOARD", Xatom_CLIPBOARD)
10052 ATOM_REFS_INIT ("TIMESTAMP", Xatom_TIMESTAMP)
10053 ATOM_REFS_INIT ("TEXT", Xatom_TEXT)
10054 ATOM_REFS_INIT ("COMPOUND_TEXT", Xatom_COMPOUND_TEXT)
10055 ATOM_REFS_INIT ("UTF8_STRING", Xatom_UTF8_STRING)
10056 ATOM_REFS_INIT ("DELETE", Xatom_DELETE)
10057 ATOM_REFS_INIT ("MULTIPLE", Xatom_MULTIPLE)
10058 ATOM_REFS_INIT ("INCR", Xatom_INCR)
10059 ATOM_REFS_INIT ("_EMACS_TMP_", Xatom_EMACS_TMP)
10060 ATOM_REFS_INIT ("TARGETS", Xatom_TARGETS)
10061 ATOM_REFS_INIT ("NULL", Xatom_NULL)
10062 ATOM_REFS_INIT ("ATOM", Xatom_ATOM)
10063 ATOM_REFS_INIT ("ATOM_PAIR", Xatom_ATOM_PAIR)
10064 ATOM_REFS_INIT ("CLIPBOARD_MANAGER", Xatom_CLIPBOARD_MANAGER)
10065 ATOM_REFS_INIT ("_XEMBED_INFO", Xatom_XEMBED_INFO)
10066 /* For properties of font. */
10067 ATOM_REFS_INIT ("PIXEL_SIZE", Xatom_PIXEL_SIZE)
10068 ATOM_REFS_INIT ("AVERAGE_WIDTH", Xatom_AVERAGE_WIDTH)
10069 ATOM_REFS_INIT ("_MULE_BASELINE_OFFSET", Xatom_MULE_BASELINE_OFFSET)
10070 ATOM_REFS_INIT ("_MULE_RELATIVE_COMPOSE", Xatom_MULE_RELATIVE_COMPOSE)
10071 ATOM_REFS_INIT ("_MULE_DEFAULT_ASCENT", Xatom_MULE_DEFAULT_ASCENT)
10072 /* Ghostscript support. */
10073 ATOM_REFS_INIT ("DONE", Xatom_DONE)
10074 ATOM_REFS_INIT ("PAGE", Xatom_PAGE)
10075 ATOM_REFS_INIT ("SCROLLBAR", Xatom_Scrollbar)
10076 ATOM_REFS_INIT ("_XEMBED", Xatom_XEMBED)
10077 /* EWMH */
10078 ATOM_REFS_INIT ("_NET_WM_STATE", Xatom_net_wm_state)
10079 ATOM_REFS_INIT ("_NET_WM_STATE_FULLSCREEN", Xatom_net_wm_state_fullscreen)
10080 ATOM_REFS_INIT ("_NET_WM_STATE_MAXIMIZED_HORZ",
10081 Xatom_net_wm_state_maximized_horz)
10082 ATOM_REFS_INIT ("_NET_WM_STATE_MAXIMIZED_VERT",
10083 Xatom_net_wm_state_maximized_vert)
10084 ATOM_REFS_INIT ("_NET_WM_STATE_STICKY", Xatom_net_wm_state_sticky)
10085 ATOM_REFS_INIT ("_NET_WM_STATE_HIDDEN", Xatom_net_wm_state_hidden)
10086 ATOM_REFS_INIT ("_NET_WM_WINDOW_TYPE", Xatom_net_window_type)
10087 ATOM_REFS_INIT ("_NET_WM_WINDOW_TYPE_TOOLTIP",
10088 Xatom_net_window_type_tooltip)
10089 ATOM_REFS_INIT ("_NET_WM_ICON_NAME", Xatom_net_wm_icon_name)
10090 ATOM_REFS_INIT ("_NET_WM_NAME", Xatom_net_wm_name)
10091 ATOM_REFS_INIT ("_NET_SUPPORTED", Xatom_net_supported)
10092 ATOM_REFS_INIT ("_NET_SUPPORTING_WM_CHECK", Xatom_net_supporting_wm_check)
10093 ATOM_REFS_INIT ("_NET_WM_WINDOW_OPACITY", Xatom_net_wm_window_opacity)
10094 ATOM_REFS_INIT ("_NET_ACTIVE_WINDOW", Xatom_net_active_window)
10095 ATOM_REFS_INIT ("_NET_FRAME_EXTENTS", Xatom_net_frame_extents)
10096 ATOM_REFS_INIT ("_NET_CURRENT_DESKTOP", Xatom_net_current_desktop)
10097 ATOM_REFS_INIT ("_NET_WORKAREA", Xatom_net_workarea)
10098 /* Session management */
10099 ATOM_REFS_INIT ("SM_CLIENT_ID", Xatom_SM_CLIENT_ID)
10100 ATOM_REFS_INIT ("_XSETTINGS_SETTINGS", Xatom_xsettings_prop)
10101 ATOM_REFS_INIT ("MANAGER", Xatom_xsettings_mgr)
10104 int i;
10105 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10106 /* 1 for _XSETTINGS_SN */
10107 const int total_atom_count = 1 + atom_count;
10108 Atom *atoms_return = xmalloc (total_atom_count * sizeof *atoms_return);
10109 char **atom_names = xmalloc (total_atom_count * sizeof *atom_names);
10110 static char const xsettings_fmt[] = "_XSETTINGS_S%d";
10111 char xsettings_atom_name[sizeof xsettings_fmt - 2
10112 + INT_STRLEN_BOUND (int)];
10114 for (i = 0; i < atom_count; i++)
10115 atom_names[i] = (char *) atom_refs[i].name;
10117 /* Build _XSETTINGS_SN atom name */
10118 sprintf (xsettings_atom_name, xsettings_fmt,
10119 XScreenNumberOfScreen (dpyinfo->screen));
10120 atom_names[i] = xsettings_atom_name;
10122 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10123 False, atoms_return);
10125 for (i = 0; i < atom_count; i++)
10126 *(Atom *) ((char *) dpyinfo + atom_refs[i].offset) = atoms_return[i];
10128 /* Manual copy of last atom */
10129 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10131 xfree (atom_names);
10132 xfree (atoms_return);
10135 dpyinfo->x_dnd_atoms_size = 8;
10136 dpyinfo->x_dnd_atoms = xmalloc (sizeof *dpyinfo->x_dnd_atoms
10137 * dpyinfo->x_dnd_atoms_size);
10138 dpyinfo->gray
10139 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10140 gray_bits, gray_width, gray_height,
10141 1, 0, 1);
10143 #ifdef HAVE_X_I18N
10144 xim_initialize (dpyinfo, resource_name);
10145 #endif
10147 xsettings_initialize (dpyinfo);
10149 connection = ConnectionNumber (dpyinfo->display);
10151 /* This is only needed for distinguishing keyboard and process input. */
10152 if (connection != 0)
10153 add_keyboard_wait_descriptor (connection);
10155 #ifdef F_SETOWN
10156 fcntl (connection, F_SETOWN, getpid ());
10157 #endif /* ! defined (F_SETOWN) */
10159 if (interrupt_input)
10160 init_sigio (connection);
10162 #ifdef USE_LUCID
10164 XrmValue d, fr, to;
10165 Font font;
10167 dpy = dpyinfo->display;
10168 d.addr = (XPointer)&dpy;
10169 d.size = sizeof (Display *);
10170 fr.addr = XtDefaultFont;
10171 fr.size = sizeof (XtDefaultFont);
10172 to.size = sizeof (Font *);
10173 to.addr = (XPointer)&font;
10174 x_catch_errors (dpy);
10175 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10176 emacs_abort ();
10177 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10178 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10179 x_uncatch_errors ();
10181 #endif
10183 /* See if we should run in synchronous mode. This is useful
10184 for debugging X code. */
10186 Lisp_Object value;
10187 value = display_x_get_resource (dpyinfo,
10188 build_string ("synchronous"),
10189 build_string ("Synchronous"),
10190 Qnil, Qnil);
10191 if (STRINGP (value)
10192 && (!strcmp (SSDATA (value), "true")
10193 || !strcmp (SSDATA (value), "on")))
10194 XSynchronize (dpyinfo->display, True);
10198 Lisp_Object value;
10199 value = display_x_get_resource (dpyinfo,
10200 build_string ("useXIM"),
10201 build_string ("UseXIM"),
10202 Qnil, Qnil);
10203 #ifdef USE_XIM
10204 if (STRINGP (value)
10205 && (!strcmp (SSDATA (value), "false")
10206 || !strcmp (SSDATA (value), "off")))
10207 use_xim = false;
10208 #else
10209 if (STRINGP (value)
10210 && (!strcmp (SSDATA (value), "true")
10211 || !strcmp (SSDATA (value), "on")))
10212 use_xim = true;
10213 #endif
10216 #ifdef HAVE_X_SM
10217 /* Only do this for the very first display in the Emacs session.
10218 Ignore X session management when Emacs was first started on a
10219 tty. */
10220 if (terminal->id == 1)
10221 x_session_initialize (dpyinfo);
10222 #endif
10224 unblock_input ();
10226 return dpyinfo;
10229 /* Get rid of display DPYINFO, deleting all frames on it,
10230 and without sending any more commands to the X server. */
10232 static void
10233 x_delete_display (struct x_display_info *dpyinfo)
10235 struct terminal *t;
10237 /* Close all frames and delete the generic struct terminal for this
10238 X display. */
10239 for (t = terminal_list; t; t = t->next_terminal)
10240 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10242 #ifdef HAVE_X_SM
10243 /* Close X session management when we close its display. */
10244 if (t->id == 1 && x_session_have_connection ())
10245 x_session_close ();
10246 #endif
10247 delete_terminal (t);
10248 break;
10251 if (next_noop_dpyinfo == dpyinfo)
10252 next_noop_dpyinfo = dpyinfo->next;
10254 if (x_display_list == dpyinfo)
10255 x_display_list = dpyinfo->next;
10256 else
10258 struct x_display_info *tail;
10260 for (tail = x_display_list; tail; tail = tail->next)
10261 if (tail->next == dpyinfo)
10262 tail->next = tail->next->next;
10265 xfree (dpyinfo->x_id_name);
10266 xfree (dpyinfo->x_dnd_atoms);
10267 xfree (dpyinfo->color_cells);
10268 xfree (dpyinfo);
10271 #ifdef USE_X_TOOLKIT
10273 /* Atimer callback function for TIMER. Called every 0.1s to process
10274 Xt timeouts, if needed. We must avoid calling XtAppPending as
10275 much as possible because that function does an implicit XFlush
10276 that slows us down. */
10278 static void
10279 x_process_timeouts (struct atimer *timer)
10281 block_input ();
10282 x_timeout_atimer_activated_flag = 0;
10283 if (toolkit_scroll_bar_interaction || popup_activated ())
10285 while (XtAppPending (Xt_app_con) & XtIMTimer)
10286 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10287 /* Reactivate the atimer for next time. */
10288 x_activate_timeout_atimer ();
10290 unblock_input ();
10293 /* Install an asynchronous timer that processes Xt timeout events
10294 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10295 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10296 function whenever these variables are set. This is necessary
10297 because some widget sets use timeouts internally, for example the
10298 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10299 processed, these widgets don't behave normally. */
10301 void
10302 x_activate_timeout_atimer (void)
10304 block_input ();
10305 if (!x_timeout_atimer_activated_flag)
10307 struct timespec interval = make_timespec (0, 100 * 1000 * 1000);
10308 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10309 x_timeout_atimer_activated_flag = 1;
10311 unblock_input ();
10314 #endif /* USE_X_TOOLKIT */
10317 /* Set up use of X before we make the first connection. */
10319 static struct redisplay_interface x_redisplay_interface =
10321 x_frame_parm_handlers,
10322 x_produce_glyphs,
10323 x_write_glyphs,
10324 x_insert_glyphs,
10325 x_clear_end_of_line,
10326 x_scroll_run,
10327 x_after_update_window_line,
10328 x_update_window_begin,
10329 x_update_window_end,
10330 x_flush,
10331 x_clear_window_mouse_face,
10332 x_get_glyph_overhangs,
10333 x_fix_overlapping_area,
10334 x_draw_fringe_bitmap,
10335 0, /* define_fringe_bitmap */
10336 0, /* destroy_fringe_bitmap */
10337 x_compute_glyph_string_overhangs,
10338 x_draw_glyph_string,
10339 x_define_frame_cursor,
10340 x_clear_frame_area,
10341 x_draw_window_cursor,
10342 x_draw_vertical_window_border,
10343 x_draw_window_divider,
10344 x_shift_glyphs_for_insert
10348 /* This function is called when the last frame on a display is deleted. */
10349 void
10350 x_delete_terminal (struct terminal *terminal)
10352 struct x_display_info *dpyinfo = terminal->display_info.x;
10353 int connection = -1;
10355 /* Protect against recursive calls. delete_frame in
10356 delete_terminal calls us back when it deletes our last frame. */
10357 if (!terminal->name)
10358 return;
10360 block_input ();
10361 #ifdef HAVE_X_I18N
10362 /* We must close our connection to the XIM server before closing the
10363 X display. */
10364 if (dpyinfo->xim)
10365 xim_close_dpy (dpyinfo);
10366 #endif
10368 /* If called from x_connection_closed, the display may already be closed
10369 and dpyinfo->display was set to 0 to indicate that. */
10370 if (dpyinfo->display)
10372 connection = ConnectionNumber (dpyinfo->display);
10374 x_destroy_all_bitmaps (dpyinfo);
10375 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10377 /* Whether or not XCloseDisplay destroys the associated resource
10378 database depends on the version of libX11. To avoid both
10379 crash and memory leak, we dissociate the database from the
10380 display and then destroy dpyinfo->xrdb ourselves.
10382 Unfortunately, the above strategy does not work in some
10383 situations due to a bug in newer versions of libX11: because
10384 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10385 dpy->db is NULL, XCloseDisplay destroys the associated
10386 database whereas it has not been created by XGetDefault
10387 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10388 don't destroy the database here in order to avoid the crash
10389 in the above situations for now, though that may cause memory
10390 leaks in other situations. */
10391 #if 0
10392 #ifdef HAVE_XRMSETDATABASE
10393 XrmSetDatabase (dpyinfo->display, NULL);
10394 #else
10395 dpyinfo->display->db = NULL;
10396 #endif
10397 /* We used to call XrmDestroyDatabase from x_delete_display, but
10398 some older versions of libX11 crash if we call it after
10399 closing all the displays. */
10400 XrmDestroyDatabase (dpyinfo->xrdb);
10401 #endif
10403 #ifdef USE_GTK
10404 xg_display_close (dpyinfo->display);
10405 #else
10406 #ifdef USE_X_TOOLKIT
10407 XtCloseDisplay (dpyinfo->display);
10408 #else
10409 XCloseDisplay (dpyinfo->display);
10410 #endif
10411 #endif /* ! USE_GTK */
10414 /* No more input on this descriptor. */
10415 if (connection != -1)
10416 delete_keyboard_wait_descriptor (connection);
10418 /* Mark as dead. */
10419 dpyinfo->display = NULL;
10420 x_delete_display (dpyinfo);
10421 unblock_input ();
10424 /* Create a struct terminal, initialize it with the X11 specific
10425 functions and make DISPLAY->TERMINAL point to it. */
10427 static struct terminal *
10428 x_create_terminal (struct x_display_info *dpyinfo)
10430 struct terminal *terminal;
10432 terminal = create_terminal ();
10434 terminal->type = output_x_window;
10435 terminal->display_info.x = dpyinfo;
10436 dpyinfo->terminal = terminal;
10438 /* kboard is initialized in x_term_init. */
10440 terminal->clear_frame_hook = x_clear_frame;
10441 terminal->ins_del_lines_hook = x_ins_del_lines;
10442 terminal->delete_glyphs_hook = x_delete_glyphs;
10443 terminal->ring_bell_hook = XTring_bell;
10444 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10445 terminal->reset_terminal_modes_hook = NULL;
10446 terminal->set_terminal_modes_hook = NULL;
10447 terminal->update_begin_hook = x_update_begin;
10448 terminal->update_end_hook = x_update_end;
10449 terminal->set_terminal_window_hook = NULL;
10450 terminal->read_socket_hook = XTread_socket;
10451 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10452 terminal->mouse_position_hook = XTmouse_position;
10453 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10454 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10455 terminal->fullscreen_hook = XTfullscreen_hook;
10456 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10457 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10458 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10459 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10461 terminal->delete_frame_hook = x_destroy_window;
10462 terminal->delete_terminal_hook = x_delete_terminal;
10464 terminal->rif = &x_redisplay_interface;
10466 return terminal;
10469 void
10470 x_initialize (void)
10472 baud_rate = 19200;
10474 x_noop_count = 0;
10475 last_tool_bar_item = -1;
10476 any_help_event_p = 0;
10477 ignore_next_mouse_click_timeout = 0;
10479 #ifdef USE_GTK
10480 current_count = -1;
10481 #endif
10483 /* Try to use interrupt input; if we can't, then start polling. */
10484 Fset_input_interrupt_mode (Qt);
10486 #ifdef USE_X_TOOLKIT
10487 XtToolkitInitialize ();
10489 Xt_app_con = XtCreateApplicationContext ();
10491 /* Register a converter from strings to pixels, which uses
10492 Emacs' color allocation infrastructure. */
10493 XtAppSetTypeConverter (Xt_app_con,
10494 XtRString, XtRPixel, cvt_string_to_pixel,
10495 cvt_string_to_pixel_args,
10496 XtNumber (cvt_string_to_pixel_args),
10497 XtCacheByDisplay, cvt_pixel_dtor);
10499 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10500 #endif
10502 #ifdef USE_TOOLKIT_SCROLL_BARS
10503 #ifndef USE_GTK
10504 xaw3d_arrow_scroll = False;
10505 xaw3d_pick_top = True;
10506 #endif
10507 #endif
10509 /* Note that there is no real way portable across R3/R4 to get the
10510 original error handler. */
10511 XSetErrorHandler (x_error_handler);
10512 XSetIOErrorHandler (x_io_error_quitter);
10516 void
10517 syms_of_xterm (void)
10519 x_error_message = NULL;
10521 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
10522 DEFSYM (Qlatin_1, "latin-1");
10524 #ifdef USE_GTK
10525 xg_default_icon_file = build_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10526 staticpro (&xg_default_icon_file);
10528 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
10529 #endif
10531 DEFVAR_BOOL ("x-use-underline-position-properties",
10532 x_use_underline_position_properties,
10533 doc: /* Non-nil means make use of UNDERLINE_POSITION font properties.
10534 A value of nil means ignore them. If you encounter fonts with bogus
10535 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10536 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10537 to override the font's UNDERLINE_POSITION for small font display
10538 sizes. */);
10539 x_use_underline_position_properties = 1;
10541 DEFVAR_BOOL ("x-underline-at-descent-line",
10542 x_underline_at_descent_line,
10543 doc: /* Non-nil means to draw the underline at the same place as the descent line.
10544 A value of nil means to draw the underline according to the value of the
10545 variable `x-use-underline-position-properties', which is usually at the
10546 baseline level. The default value is nil. */);
10547 x_underline_at_descent_line = 0;
10549 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10550 x_mouse_click_focus_ignore_position,
10551 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10552 This variable is only used when the window manager requires that you
10553 click on a frame to select it (give it focus). In that case, a value
10554 of nil, means that the selected window and cursor position changes to
10555 reflect the mouse click position, while a non-nil value means that the
10556 selected window or cursor position is preserved. */);
10557 x_mouse_click_focus_ignore_position = 0;
10559 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10560 doc: /* Which toolkit scroll bars Emacs uses, if any.
10561 A value of nil means Emacs doesn't use toolkit scroll bars.
10562 With the X Window system, the value is a symbol describing the
10563 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10564 With MS Windows or Nextstep, the value is t. */);
10565 #ifdef USE_TOOLKIT_SCROLL_BARS
10566 #ifdef USE_MOTIF
10567 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10568 #elif defined HAVE_XAW3D
10569 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10570 #elif USE_GTK
10571 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10572 #else
10573 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10574 #endif
10575 #else
10576 Vx_toolkit_scroll_bars = Qnil;
10577 #endif
10579 DEFSYM (Qmodifier_value, "modifier-value");
10580 DEFSYM (Qalt, "alt");
10581 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10582 DEFSYM (Qhyper, "hyper");
10583 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10584 DEFSYM (Qmeta, "meta");
10585 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10586 DEFSYM (Qsuper, "super");
10587 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10589 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10590 doc: /* Which keys Emacs uses for the alt modifier.
10591 This should be one of the symbols `alt', `hyper', `meta', `super'.
10592 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10593 is nil, which is the same as `alt'. */);
10594 Vx_alt_keysym = Qnil;
10596 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10597 doc: /* Which keys Emacs uses for the hyper modifier.
10598 This should be one of the symbols `alt', `hyper', `meta', `super'.
10599 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10600 default is nil, which is the same as `hyper'. */);
10601 Vx_hyper_keysym = Qnil;
10603 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10604 doc: /* Which keys Emacs uses for the meta modifier.
10605 This should be one of the symbols `alt', `hyper', `meta', `super'.
10606 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10607 default is nil, which is the same as `meta'. */);
10608 Vx_meta_keysym = Qnil;
10610 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10611 doc: /* Which keys Emacs uses for the super modifier.
10612 This should be one of the symbols `alt', `hyper', `meta', `super'.
10613 For example, `super' means use the Super_L and Super_R keysyms. The
10614 default is nil, which is the same as `super'. */);
10615 Vx_super_keysym = Qnil;
10617 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10618 doc: /* Hash table of character codes indexed by X keysym codes. */);
10619 Vx_keysym_table = make_hash_table (hashtest_eql, make_number (900),
10620 make_float (DEFAULT_REHASH_SIZE),
10621 make_float (DEFAULT_REHASH_THRESHOLD),
10622 Qnil);