Add Todo mode user manual.
[emacs.git] / src / xterm.c
bloba486242b8c3d2fcca6bba73f2cf73db4015a307d
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993-2013 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 #ifdef HAVE_X_WINDOWS
28 #include "lisp.h"
29 #include "blockinput.h"
30 #include "syssignal.h"
32 /* This may include sys/types.h, and that somehow loses
33 if this is not done before the other system files. */
34 #include "xterm.h"
35 #include <X11/cursorfont.h>
37 /* Load sys/types.h if not already loaded.
38 In some systems loading it twice is suicidal. */
39 #ifndef makedev
40 #include <sys/types.h>
41 #endif /* makedev */
43 #include <sys/ioctl.h>
45 #include "systime.h"
47 #include <fcntl.h>
48 #include <errno.h>
49 #include <sys/stat.h>
50 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
51 /* #include <sys/param.h> */
53 #include "charset.h"
54 #include "character.h"
55 #include "coding.h"
56 #include "frame.h"
57 #include "dispextern.h"
58 #include "fontset.h"
59 #include "termhooks.h"
60 #include "termopts.h"
61 #include "termchar.h"
62 #include "emacs-icon.h"
63 #include "disptab.h"
64 #include "buffer.h"
65 #include "window.h"
66 #include "keyboard.h"
67 #include "intervals.h"
68 #include "process.h"
69 #include "atimer.h"
70 #include "keymap.h"
71 #include "font.h"
72 #include "xsettings.h"
73 #include "xgselect.h"
74 #include "sysselect.h"
76 #ifdef USE_X_TOOLKIT
77 #include <X11/Shell.h>
78 #endif
80 #include <unistd.h>
82 #ifdef USE_GTK
83 #include "gtkutil.h"
84 #ifdef HAVE_GTK3
85 #include <X11/Xproto.h>
86 #endif
87 #endif
89 #ifdef USE_LUCID
90 #include "../lwlib/xlwmenu.h"
91 #endif
93 #ifdef USE_X_TOOLKIT
94 #if !defined (NO_EDITRES)
95 #define HACK_EDITRES
96 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
97 #endif /* not NO_EDITRES */
99 /* Include toolkit specific headers for the scroll bar widget. */
101 #ifdef USE_TOOLKIT_SCROLL_BARS
102 #if defined USE_MOTIF
103 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
104 #include <Xm/ScrollBar.h>
105 #else /* !USE_MOTIF i.e. use Xaw */
107 #ifdef HAVE_XAW3D
108 #include <X11/Xaw3d/Simple.h>
109 #include <X11/Xaw3d/Scrollbar.h>
110 #include <X11/Xaw3d/ThreeD.h>
111 #else /* !HAVE_XAW3D */
112 #include <X11/Xaw/Simple.h>
113 #include <X11/Xaw/Scrollbar.h>
114 #endif /* !HAVE_XAW3D */
115 #ifndef XtNpickTop
116 #define XtNpickTop "pickTop"
117 #endif /* !XtNpickTop */
118 #endif /* !USE_MOTIF */
119 #endif /* USE_TOOLKIT_SCROLL_BARS */
121 #endif /* USE_X_TOOLKIT */
123 #ifdef USE_X_TOOLKIT
124 #include "widget.h"
125 #ifndef XtNinitialState
126 #define XtNinitialState "initialState"
127 #endif
128 #endif
130 #include "bitmaps/gray.xbm"
132 #ifdef HAVE_XKB
133 #include <X11/XKBlib.h>
134 #endif
136 /* Default to using XIM if available. */
137 #ifdef USE_XIM
138 int use_xim = 1;
139 #else
140 int use_xim = 0; /* configure --without-xim */
141 #endif
145 /* Non-zero means that a HELP_EVENT has been generated since Emacs
146 start. */
148 static bool any_help_event_p;
150 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
151 static Lisp_Object last_window;
153 /* This is a chain of structures for all the X displays currently in
154 use. */
156 struct x_display_info *x_display_list;
158 /* This is a list of cons cells, each of the form (NAME
159 . FONT-LIST-CACHE), one for each element of x_display_list and in
160 the same order. NAME is the name of the frame. FONT-LIST-CACHE
161 records previous values returned by x-list-fonts. */
163 Lisp_Object x_display_name_list;
165 /* This is a frame waiting to be auto-raised, within XTread_socket. */
167 static struct frame *pending_autoraise_frame;
169 /* This is a frame waiting for an event matching mask, within XTread_socket. */
171 static struct {
172 struct frame *f;
173 int eventtype;
174 } pending_event_wait;
176 #ifdef USE_X_TOOLKIT
177 /* The application context for Xt use. */
178 XtAppContext Xt_app_con;
179 static String Xt_default_resources[] = {0};
181 /* Non-zero means user is interacting with a toolkit scroll bar. */
183 static int toolkit_scroll_bar_interaction;
184 #endif /* USE_X_TOOLKIT */
186 /* Non-zero timeout value means ignore next mouse click if it arrives
187 before that timeout elapses (i.e. as part of the same sequence of
188 events resulting from clicking on a frame to select it). */
190 static unsigned long ignore_next_mouse_click_timeout;
192 /* Mouse movement.
194 Formerly, we used PointerMotionHintMask (in standard_event_mask)
195 so that we would have to call XQueryPointer after each MotionNotify
196 event to ask for another such event. However, this made mouse tracking
197 slow, and there was a bug that made it eventually stop.
199 Simply asking for MotionNotify all the time seems to work better.
201 In order to avoid asking for motion events and then throwing most
202 of them away or busy-polling the server for mouse positions, we ask
203 the server for pointer motion hints. This means that we get only
204 one event per group of mouse movements. "Groups" are delimited by
205 other kinds of events (focus changes and button clicks, for
206 example), or by XQueryPointer calls; when one of these happens, we
207 get another MotionNotify event the next time the mouse moves. This
208 is at least as efficient as getting motion events when mouse
209 tracking is on, and I suspect only negligibly worse when tracking
210 is off. */
212 /* Where the mouse was last time we reported a mouse event. */
214 static XRectangle last_mouse_glyph;
215 static struct frame *last_mouse_glyph_frame;
217 /* The scroll bar in which the last X motion event occurred.
219 If the last X motion event occurred in a scroll bar, we set this so
220 XTmouse_position can know whether to report a scroll bar motion or
221 an ordinary motion.
223 If the last X motion event didn't occur in a scroll bar, we set
224 this to Qnil, to tell XTmouse_position to return an ordinary motion
225 event. */
227 static Lisp_Object last_mouse_scroll_bar;
229 /* This is a hack. We would really prefer that XTmouse_position would
230 return the time associated with the position it returns, but there
231 doesn't seem to be any way to wrest the time-stamp from the server
232 along with the position query. So, we just keep track of the time
233 of the last movement we received, and return that in hopes that
234 it's somewhat accurate. */
236 static Time last_mouse_movement_time;
238 /* Time for last user interaction as returned in X events. */
240 static Time last_user_time;
242 /* Incremented by XTread_socket whenever it really tries to read
243 events. */
245 static int volatile input_signal_count;
247 /* Used locally within XTread_socket. */
249 static int x_noop_count;
251 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
253 static Lisp_Object Qvendor_specific_keysyms;
254 static Lisp_Object Qlatin_1;
256 #ifdef USE_GTK
257 /* The name of the Emacs icon file. */
258 static Lisp_Object xg_default_icon_file;
260 /* Used in gtkutil.c. */
261 Lisp_Object Qx_gtk_map_stock;
262 #endif
264 /* Some functions take this as char *, not const char *. */
265 static char emacs_class[] = EMACS_CLASS;
267 enum xembed_info
269 XEMBED_MAPPED = 1 << 0
272 enum xembed_message
274 XEMBED_EMBEDDED_NOTIFY = 0,
275 XEMBED_WINDOW_ACTIVATE = 1,
276 XEMBED_WINDOW_DEACTIVATE = 2,
277 XEMBED_REQUEST_FOCUS = 3,
278 XEMBED_FOCUS_IN = 4,
279 XEMBED_FOCUS_OUT = 5,
280 XEMBED_FOCUS_NEXT = 6,
281 XEMBED_FOCUS_PREV = 7,
283 XEMBED_MODALITY_ON = 10,
284 XEMBED_MODALITY_OFF = 11,
285 XEMBED_REGISTER_ACCELERATOR = 12,
286 XEMBED_UNREGISTER_ACCELERATOR = 13,
287 XEMBED_ACTIVATE_ACCELERATOR = 14
290 static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
291 static void x_set_window_size_1 (struct frame *, int, int, int);
292 static void x_raise_frame (struct frame *);
293 static void x_lower_frame (struct frame *);
294 static const XColor *x_color_cells (Display *, int *);
295 static void x_update_window_end (struct window *, int, int);
297 static int x_io_error_quitter (Display *);
298 static struct terminal *x_create_terminal (struct x_display_info *);
299 void x_delete_terminal (struct terminal *);
300 static void x_update_end (struct frame *);
301 static void XTframe_up_to_date (struct frame *);
302 static void XTset_terminal_modes (struct terminal *);
303 static void XTreset_terminal_modes (struct terminal *);
304 static void x_clear_frame (struct frame *);
305 static _Noreturn void x_ins_del_lines (struct frame *, int, int);
306 static void frame_highlight (struct frame *);
307 static void frame_unhighlight (struct frame *);
308 static void x_new_focus_frame (struct x_display_info *, struct frame *);
309 static void x_focus_changed (int, int, struct x_display_info *,
310 struct frame *, struct input_event *);
311 static void x_detect_focus_change (struct x_display_info *,
312 XEvent *, struct input_event *);
313 static void XTframe_rehighlight (struct frame *);
314 static void x_frame_rehighlight (struct x_display_info *);
315 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
316 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
317 enum text_cursor_kinds);
319 static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
320 static void x_flush (struct frame *f);
321 static void x_update_begin (struct frame *);
322 static void x_update_window_begin (struct window *);
323 static void x_after_update_window_line (struct glyph_row *);
324 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
325 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
326 enum scroll_bar_part *,
327 Lisp_Object *, Lisp_Object *,
328 Time *);
329 static int x_handle_net_wm_state (struct frame *, XPropertyEvent *);
330 static void x_check_fullscreen (struct frame *);
331 static void x_check_expected_move (struct frame *, int, int);
332 static void x_sync_with_move (struct frame *, int, int, int);
333 static int handle_one_xevent (struct x_display_info *, XEvent *,
334 int *, struct input_event *);
335 #ifdef USE_GTK
336 static int x_dispatch_event (XEvent *, Display *);
337 #endif
338 /* Don't declare this _Noreturn because we want no
339 interference with debugging failing X calls. */
340 static void x_connection_closed (Display *, const char *);
341 static void x_wm_set_window_state (struct frame *, int);
342 static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
343 static void x_initialize (void);
346 /* Flush display of frame F, or of all frames if F is null. */
348 static void
349 x_flush (struct frame *f)
351 /* Don't call XFlush when it is not safe to redisplay; the X
352 connection may be broken. */
353 if (!NILP (Vinhibit_redisplay))
354 return;
356 block_input ();
357 if (f)
359 eassert (FRAME_X_P (f));
360 XFlush (FRAME_X_DISPLAY (f));
362 else
364 /* Flush all displays and so all frames on them. */
365 struct x_display_info *xdi;
366 for (xdi = x_display_list; xdi; xdi = xdi->next)
367 XFlush (xdi->display);
369 unblock_input ();
373 /* Remove calls to XFlush by defining XFlush to an empty replacement.
374 Calls to XFlush should be unnecessary because the X output buffer
375 is flushed automatically as needed by calls to XPending,
376 XNextEvent, or XWindowEvent according to the XFlush man page.
377 XTread_socket calls XPending. Removing XFlush improves
378 performance. */
380 #define XFlush(DISPLAY) (void) 0
383 /***********************************************************************
384 Debugging
385 ***********************************************************************/
387 #if 0
389 /* This is a function useful for recording debugging information about
390 the sequence of occurrences in this file. */
392 struct record
394 char *locus;
395 int type;
398 struct record event_record[100];
400 int event_record_index;
402 void
403 record_event (char *locus, int type)
405 if (event_record_index == sizeof (event_record) / sizeof (struct record))
406 event_record_index = 0;
408 event_record[event_record_index].locus = locus;
409 event_record[event_record_index].type = type;
410 event_record_index++;
413 #endif /* 0 */
417 /* Return the struct x_display_info corresponding to DPY. */
419 struct x_display_info *
420 x_display_info_for_display (Display *dpy)
422 struct x_display_info *dpyinfo;
424 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
425 if (dpyinfo->display == dpy)
426 return dpyinfo;
428 return 0;
431 static Window
432 x_find_topmost_parent (struct frame *f)
434 struct x_output *x = f->output_data.x;
435 Window win = None, wi = x->parent_desc;
436 Display *dpy = FRAME_X_DISPLAY (f);
438 while (wi != FRAME_X_DISPLAY_INFO (f)->root_window)
440 Window root;
441 Window *children;
442 unsigned int nchildren;
444 win = wi;
445 XQueryTree (dpy, win, &root, &wi, &children, &nchildren);
446 XFree (children);
449 return win;
452 #define OPAQUE 0xffffffff
454 void
455 x_set_frame_alpha (struct frame *f)
457 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
458 Display *dpy = FRAME_X_DISPLAY (f);
459 Window win = FRAME_OUTER_WINDOW (f);
460 double alpha = 1.0;
461 double alpha_min = 1.0;
462 unsigned long opac;
463 Window parent;
465 if (dpyinfo->x_highlight_frame == f)
466 alpha = f->alpha[0];
467 else
468 alpha = f->alpha[1];
470 if (FLOATP (Vframe_alpha_lower_limit))
471 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
472 else if (INTEGERP (Vframe_alpha_lower_limit))
473 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
475 if (alpha < 0.0)
476 return;
477 else if (alpha > 1.0)
478 alpha = 1.0;
479 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
480 alpha = alpha_min;
482 opac = alpha * OPAQUE;
484 x_catch_errors (dpy);
486 /* If there is a parent from the window manager, put the property there
487 also, to work around broken window managers that fail to do that.
488 Do this unconditionally as this function is called on reparent when
489 alpha has not changed on the frame. */
491 parent = x_find_topmost_parent (f);
492 if (parent != None)
493 XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
494 XA_CARDINAL, 32, PropModeReplace,
495 (unsigned char *) &opac, 1L);
497 /* return unless necessary */
499 unsigned char *data;
500 Atom actual;
501 int rc, format;
502 unsigned long n, left;
504 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
505 0L, 1L, False, XA_CARDINAL,
506 &actual, &format, &n, &left,
507 &data);
509 if (rc == Success && actual != None)
511 unsigned long value = *(unsigned long *)data;
512 XFree (data);
513 if (value == opac)
515 x_uncatch_errors ();
516 return;
521 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
522 XA_CARDINAL, 32, PropModeReplace,
523 (unsigned char *) &opac, 1L);
524 x_uncatch_errors ();
528 x_display_pixel_height (struct x_display_info *dpyinfo)
530 return HeightOfScreen (dpyinfo->screen);
534 x_display_pixel_width (struct x_display_info *dpyinfo)
536 return WidthOfScreen (dpyinfo->screen);
540 /***********************************************************************
541 Starting and ending an update
542 ***********************************************************************/
544 /* Start an update of frame F. This function is installed as a hook
545 for update_begin, i.e. it is called when update_begin is called.
546 This function is called prior to calls to x_update_window_begin for
547 each window being updated. Currently, there is nothing to do here
548 because all interesting stuff is done on a window basis. */
550 static void
551 x_update_begin (struct frame *f)
553 /* Nothing to do. */
557 /* Start update of window W. Set the global variable updated_window
558 to the window being updated and set output_cursor to the cursor
559 position of W. */
561 static void
562 x_update_window_begin (struct window *w)
564 struct frame *f = XFRAME (WINDOW_FRAME (w));
565 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
567 updated_window = w;
568 set_output_cursor (&w->cursor);
570 block_input ();
572 if (f == hlinfo->mouse_face_mouse_frame)
574 /* Don't do highlighting for mouse motion during the update. */
575 hlinfo->mouse_face_defer = 1;
577 /* If F needs to be redrawn, simply forget about any prior mouse
578 highlighting. */
579 if (FRAME_GARBAGED_P (f))
580 hlinfo->mouse_face_window = Qnil;
583 unblock_input ();
587 /* Draw a vertical window border from (x,y0) to (x,y1) */
589 static void
590 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
592 struct frame *f = XFRAME (WINDOW_FRAME (w));
593 struct face *face;
595 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
596 if (face)
597 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
598 face->foreground);
600 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
601 f->output_data.x->normal_gc, x, y0, x, y1);
604 /* End update of window W (which is equal to updated_window).
606 Draw vertical borders between horizontally adjacent windows, and
607 display W's cursor if CURSOR_ON_P is non-zero.
609 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
610 glyphs in mouse-face were overwritten. In that case we have to
611 make sure that the mouse-highlight is properly redrawn.
613 W may be a menu bar pseudo-window in case we don't have X toolkit
614 support. Such windows don't have a cursor, so don't display it
615 here. */
617 static void
618 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
620 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
622 if (!w->pseudo_window_p)
624 block_input ();
626 if (cursor_on_p)
627 display_and_set_cursor (w, 1, output_cursor.hpos,
628 output_cursor.vpos,
629 output_cursor.x, output_cursor.y);
631 if (draw_window_fringes (w, 1))
632 x_draw_vertical_border (w);
634 unblock_input ();
637 /* If a row with mouse-face was overwritten, arrange for
638 XTframe_up_to_date to redisplay the mouse highlight. */
639 if (mouse_face_overwritten_p)
641 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
642 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
643 hlinfo->mouse_face_window = Qnil;
646 updated_window = NULL;
650 /* End update of frame F. This function is installed as a hook in
651 update_end. */
653 static void
654 x_update_end (struct frame *f)
656 /* Mouse highlight may be displayed again. */
657 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
659 #ifndef XFlush
660 block_input ();
661 XFlush (FRAME_X_DISPLAY (f));
662 unblock_input ();
663 #endif
667 /* This function is called from various places in xdisp.c whenever a
668 complete update has been performed. The global variable
669 updated_window is not available here. */
671 static void
672 XTframe_up_to_date (struct frame *f)
674 if (FRAME_X_P (f))
675 FRAME_MOUSE_UPDATE (f);
679 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
680 arrow bitmaps, or clear the fringes if no bitmaps are required
681 before DESIRED_ROW is made current. The window being updated is
682 found in updated_window. This function It is called from
683 update_window_line only if it is known that there are differences
684 between bitmaps to be drawn between current row and DESIRED_ROW. */
686 static void
687 x_after_update_window_line (struct glyph_row *desired_row)
689 struct window *w = updated_window;
690 struct frame *f;
691 int width, height;
693 eassert (w);
695 if (!desired_row->mode_line_p && !w->pseudo_window_p)
696 desired_row->redraw_fringe_bitmaps_p = 1;
698 /* When a window has disappeared, make sure that no rest of
699 full-width rows stays visible in the internal border. Could
700 check here if updated_window is the leftmost/rightmost window,
701 but I guess it's not worth doing since vertically split windows
702 are almost never used, internal border is rarely set, and the
703 overhead is very small. */
704 if (windows_or_buffers_changed
705 && desired_row->full_width_p
706 && (f = XFRAME (w->frame),
707 width = FRAME_INTERNAL_BORDER_WIDTH (f),
708 width != 0)
709 && (height = desired_row->visible_height,
710 height > 0))
712 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
714 block_input ();
715 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
716 0, y, width, height, False);
717 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
718 FRAME_PIXEL_WIDTH (f) - width,
719 y, width, height, False);
720 unblock_input ();
724 static void
725 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
727 struct frame *f = XFRAME (WINDOW_FRAME (w));
728 Display *display = FRAME_X_DISPLAY (f);
729 Window window = FRAME_X_WINDOW (f);
730 GC gc = f->output_data.x->normal_gc;
731 struct face *face = p->face;
733 /* Must clip because of partially visible lines. */
734 x_clip_to_row (w, row, -1, gc);
736 if (!p->overlay_p)
738 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
740 /* In case the same realized face is used for fringes and
741 for something displayed in the text (e.g. face `region' on
742 mono-displays, the fill style may have been changed to
743 FillSolid in x_draw_glyph_string_background. */
744 if (face->stipple)
745 XSetFillStyle (display, face->gc, FillOpaqueStippled);
746 else
747 XSetForeground (display, face->gc, face->background);
749 #ifdef USE_TOOLKIT_SCROLL_BARS
750 /* If the fringe is adjacent to the left (right) scroll bar of a
751 leftmost (rightmost, respectively) window, then extend its
752 background to the gap between the fringe and the bar. */
753 if ((WINDOW_LEFTMOST_P (w)
754 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
755 || (WINDOW_RIGHTMOST_P (w)
756 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
758 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
760 if (sb_width > 0)
762 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
763 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
764 * FRAME_COLUMN_WIDTH (f));
766 if (bx < 0)
768 /* Bitmap fills the fringe. */
769 if (bar_area_x + bar_area_width == p->x)
770 bx = bar_area_x + sb_width;
771 else if (p->x + p->wd == bar_area_x)
772 bx = bar_area_x;
773 if (bx >= 0)
775 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
777 nx = bar_area_width - sb_width;
778 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
779 row->y));
780 ny = row->visible_height;
783 else
785 if (bar_area_x + bar_area_width == bx)
787 bx = bar_area_x + sb_width;
788 nx += bar_area_width - sb_width;
790 else if (bx + nx == bar_area_x)
791 nx += bar_area_width - sb_width;
795 #endif
796 if (bx >= 0 && nx > 0)
797 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
799 if (!face->stipple)
800 XSetForeground (display, face->gc, face->foreground);
803 if (p->which)
805 char *bits;
806 Pixmap pixmap, clipmask = (Pixmap) 0;
807 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
808 XGCValues gcv;
810 if (p->wd > 8)
811 bits = (char *) (p->bits + p->dh);
812 else
813 bits = (char *) p->bits + p->dh;
815 /* Draw the bitmap. I believe these small pixmaps can be cached
816 by the server. */
817 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
818 (p->cursor_p
819 ? (p->overlay_p ? face->background
820 : f->output_data.x->cursor_pixel)
821 : face->foreground),
822 face->background, depth);
824 if (p->overlay_p)
826 clipmask = XCreatePixmapFromBitmapData (display,
827 FRAME_X_DISPLAY_INFO (f)->root_window,
828 bits, p->wd, p->h,
829 1, 0, 1);
830 gcv.clip_mask = clipmask;
831 gcv.clip_x_origin = p->x;
832 gcv.clip_y_origin = p->y;
833 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
836 XCopyArea (display, pixmap, window, gc, 0, 0,
837 p->wd, p->h, p->x, p->y);
838 XFreePixmap (display, pixmap);
840 if (p->overlay_p)
842 gcv.clip_mask = (Pixmap) 0;
843 XChangeGC (display, gc, GCClipMask, &gcv);
844 XFreePixmap (display, clipmask);
848 XSetClipMask (display, gc, None);
853 /* This is called when starting Emacs and when restarting after
854 suspend. When starting Emacs, no X window is mapped. And nothing
855 must be done to Emacs's own window if it is suspended (though that
856 rarely happens). */
858 static void
859 XTset_terminal_modes (struct terminal *terminal)
863 /* This is called when exiting or suspending Emacs. Exiting will make
864 the X-windows go away, and suspending requires no action. */
866 static void
867 XTreset_terminal_modes (struct terminal *terminal)
872 /***********************************************************************
873 Glyph display
874 ***********************************************************************/
878 static void x_set_glyph_string_clipping (struct glyph_string *);
879 static void x_set_glyph_string_gc (struct glyph_string *);
880 static void x_draw_glyph_string_foreground (struct glyph_string *);
881 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
882 static void x_draw_glyph_string_box (struct glyph_string *);
883 static void x_draw_glyph_string (struct glyph_string *);
884 static _Noreturn void x_delete_glyphs (struct frame *, int);
885 static void x_compute_glyph_string_overhangs (struct glyph_string *);
886 static void x_set_cursor_gc (struct glyph_string *);
887 static void x_set_mode_line_face_gc (struct glyph_string *);
888 static void x_set_mouse_face_gc (struct glyph_string *);
889 static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
890 unsigned long *, double, int);
891 static void x_setup_relief_color (struct frame *, struct relief *,
892 double, int, unsigned long);
893 static void x_setup_relief_colors (struct glyph_string *);
894 static void x_draw_image_glyph_string (struct glyph_string *);
895 static void x_draw_image_relief (struct glyph_string *);
896 static void x_draw_image_foreground (struct glyph_string *);
897 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
898 static void x_clear_glyph_string_rect (struct glyph_string *, int,
899 int, int, int);
900 static void x_draw_relief_rect (struct frame *, int, int, int, int,
901 int, int, int, int, int, int,
902 XRectangle *);
903 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
904 int, int, int, XRectangle *);
905 static void x_scroll_bar_clear (struct frame *);
907 #ifdef GLYPH_DEBUG
908 static void x_check_font (struct frame *, struct font *);
909 #endif
912 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
913 face. */
915 static void
916 x_set_cursor_gc (struct glyph_string *s)
918 if (s->font == FRAME_FONT (s->f)
919 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
920 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
921 && !s->cmp)
922 s->gc = s->f->output_data.x->cursor_gc;
923 else
925 /* Cursor on non-default face: must merge. */
926 XGCValues xgcv;
927 unsigned long mask;
929 xgcv.background = s->f->output_data.x->cursor_pixel;
930 xgcv.foreground = s->face->background;
932 /* If the glyph would be invisible, try a different foreground. */
933 if (xgcv.foreground == xgcv.background)
934 xgcv.foreground = s->face->foreground;
935 if (xgcv.foreground == xgcv.background)
936 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
937 if (xgcv.foreground == xgcv.background)
938 xgcv.foreground = s->face->foreground;
940 /* Make sure the cursor is distinct from text in this face. */
941 if (xgcv.background == s->face->background
942 && xgcv.foreground == s->face->foreground)
944 xgcv.background = s->face->foreground;
945 xgcv.foreground = s->face->background;
948 IF_DEBUG (x_check_font (s->f, s->font));
949 xgcv.graphics_exposures = False;
950 mask = GCForeground | GCBackground | GCGraphicsExposures;
952 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
953 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
954 mask, &xgcv);
955 else
956 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
957 = XCreateGC (s->display, s->window, mask, &xgcv);
959 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
964 /* Set up S->gc of glyph string S for drawing text in mouse face. */
966 static void
967 x_set_mouse_face_gc (struct glyph_string *s)
969 int face_id;
970 struct face *face;
972 /* What face has to be used last for the mouse face? */
973 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
974 face = FACE_FROM_ID (s->f, face_id);
975 if (face == NULL)
976 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
978 if (s->first_glyph->type == CHAR_GLYPH)
979 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
980 else
981 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
982 s->face = FACE_FROM_ID (s->f, face_id);
983 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
985 if (s->font == s->face->font)
986 s->gc = s->face->gc;
987 else
989 /* Otherwise construct scratch_cursor_gc with values from FACE
990 except for FONT. */
991 XGCValues xgcv;
992 unsigned long mask;
994 xgcv.background = s->face->background;
995 xgcv.foreground = s->face->foreground;
996 xgcv.graphics_exposures = False;
997 mask = GCForeground | GCBackground | GCGraphicsExposures;
999 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1000 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1001 mask, &xgcv);
1002 else
1003 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1004 = XCreateGC (s->display, s->window, mask, &xgcv);
1006 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1009 eassert (s->gc != 0);
1013 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1014 Faces to use in the mode line have already been computed when the
1015 matrix was built, so there isn't much to do, here. */
1017 static void
1018 x_set_mode_line_face_gc (struct glyph_string *s)
1020 s->gc = s->face->gc;
1024 /* Set S->gc of glyph string S for drawing that glyph string. Set
1025 S->stippled_p to a non-zero value if the face of S has a stipple
1026 pattern. */
1028 static void
1029 x_set_glyph_string_gc (struct glyph_string *s)
1031 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1033 if (s->hl == DRAW_NORMAL_TEXT)
1035 s->gc = s->face->gc;
1036 s->stippled_p = s->face->stipple != 0;
1038 else if (s->hl == DRAW_INVERSE_VIDEO)
1040 x_set_mode_line_face_gc (s);
1041 s->stippled_p = s->face->stipple != 0;
1043 else if (s->hl == DRAW_CURSOR)
1045 x_set_cursor_gc (s);
1046 s->stippled_p = 0;
1048 else if (s->hl == DRAW_MOUSE_FACE)
1050 x_set_mouse_face_gc (s);
1051 s->stippled_p = s->face->stipple != 0;
1053 else if (s->hl == DRAW_IMAGE_RAISED
1054 || s->hl == DRAW_IMAGE_SUNKEN)
1056 s->gc = s->face->gc;
1057 s->stippled_p = s->face->stipple != 0;
1059 else
1061 s->gc = s->face->gc;
1062 s->stippled_p = s->face->stipple != 0;
1065 /* GC must have been set. */
1066 eassert (s->gc != 0);
1070 /* Set clipping for output of glyph string S. S may be part of a mode
1071 line or menu if we don't have X toolkit support. */
1073 static void
1074 x_set_glyph_string_clipping (struct glyph_string *s)
1076 XRectangle *r = s->clip;
1077 int n = get_glyph_string_clip_rects (s, r, 2);
1079 if (n > 0)
1080 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1081 s->num_clips = n;
1085 /* Set SRC's clipping for output of glyph string DST. This is called
1086 when we are drawing DST's left_overhang or right_overhang only in
1087 the area of SRC. */
1089 static void
1090 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1092 XRectangle r;
1094 r.x = src->x;
1095 r.width = src->width;
1096 r.y = src->y;
1097 r.height = src->height;
1098 dst->clip[0] = r;
1099 dst->num_clips = 1;
1100 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1104 /* RIF:
1105 Compute left and right overhang of glyph string S. */
1107 static void
1108 x_compute_glyph_string_overhangs (struct glyph_string *s)
1110 if (s->cmp == NULL
1111 && (s->first_glyph->type == CHAR_GLYPH
1112 || s->first_glyph->type == COMPOSITE_GLYPH))
1114 struct font_metrics metrics;
1116 if (s->first_glyph->type == CHAR_GLYPH)
1118 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1119 struct font *font = s->font;
1120 int i;
1122 for (i = 0; i < s->nchars; i++)
1123 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1124 font->driver->text_extents (font, code, s->nchars, &metrics);
1126 else
1128 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1130 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1132 s->right_overhang = (metrics.rbearing > metrics.width
1133 ? metrics.rbearing - metrics.width : 0);
1134 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1136 else if (s->cmp)
1138 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1139 s->left_overhang = - s->cmp->lbearing;
1144 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1146 static void
1147 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1149 XGCValues xgcv;
1150 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1151 XSetForeground (s->display, s->gc, xgcv.background);
1152 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1153 XSetForeground (s->display, s->gc, xgcv.foreground);
1157 /* Draw the background of glyph_string S. If S->background_filled_p
1158 is non-zero don't draw it. FORCE_P non-zero means draw the
1159 background even if it wouldn't be drawn normally. This is used
1160 when a string preceding S draws into the background of S, or S
1161 contains the first component of a composition. */
1163 static void
1164 x_draw_glyph_string_background (struct glyph_string *s, bool force_p)
1166 /* Nothing to do if background has already been drawn or if it
1167 shouldn't be drawn in the first place. */
1168 if (!s->background_filled_p)
1170 int box_line_width = max (s->face->box_line_width, 0);
1172 if (s->stippled_p)
1174 /* Fill background with a stipple pattern. */
1175 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1176 XFillRectangle (s->display, s->window, s->gc, s->x,
1177 s->y + box_line_width,
1178 s->background_width,
1179 s->height - 2 * box_line_width);
1180 XSetFillStyle (s->display, s->gc, FillSolid);
1181 s->background_filled_p = 1;
1183 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1184 || s->font_not_found_p
1185 || s->extends_to_end_of_line_p
1186 || force_p)
1188 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1189 s->background_width,
1190 s->height - 2 * box_line_width);
1191 s->background_filled_p = 1;
1197 /* Draw the foreground of glyph string S. */
1199 static void
1200 x_draw_glyph_string_foreground (struct glyph_string *s)
1202 int i, x;
1204 /* If first glyph of S has a left box line, start drawing the text
1205 of S to the right of that box line. */
1206 if (s->face->box != FACE_NO_BOX
1207 && s->first_glyph->left_box_line_p)
1208 x = s->x + eabs (s->face->box_line_width);
1209 else
1210 x = s->x;
1212 /* Draw characters of S as rectangles if S's font could not be
1213 loaded. */
1214 if (s->font_not_found_p)
1216 for (i = 0; i < s->nchars; ++i)
1218 struct glyph *g = s->first_glyph + i;
1219 XDrawRectangle (s->display, s->window,
1220 s->gc, x, s->y, g->pixel_width - 1,
1221 s->height - 1);
1222 x += g->pixel_width;
1225 else
1227 struct font *font = s->font;
1228 int boff = font->baseline_offset;
1229 int y;
1231 if (font->vertical_centering)
1232 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1234 y = s->ybase - boff;
1235 if (s->for_overlaps
1236 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1237 font->driver->draw (s, 0, s->nchars, x, y, 0);
1238 else
1239 font->driver->draw (s, 0, s->nchars, x, y, 1);
1240 if (s->face->overstrike)
1241 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1245 /* Draw the foreground of composite glyph string S. */
1247 static void
1248 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1250 int i, j, x;
1251 struct font *font = s->font;
1253 /* If first glyph of S has a left box line, start drawing the text
1254 of S to the right of that box line. */
1255 if (s->face && s->face->box != FACE_NO_BOX
1256 && s->first_glyph->left_box_line_p)
1257 x = s->x + eabs (s->face->box_line_width);
1258 else
1259 x = s->x;
1261 /* S is a glyph string for a composition. S->cmp_from is the index
1262 of the first character drawn for glyphs of this composition.
1263 S->cmp_from == 0 means we are drawing the very first character of
1264 this composition. */
1266 /* Draw a rectangle for the composition if the font for the very
1267 first character of the composition could not be loaded. */
1268 if (s->font_not_found_p)
1270 if (s->cmp_from == 0)
1271 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1272 s->width - 1, s->height - 1);
1274 else if (! s->first_glyph->u.cmp.automatic)
1276 int y = s->ybase;
1278 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1279 /* TAB in a composition means display glyphs with padding
1280 space on the left or right. */
1281 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1283 int xx = x + s->cmp->offsets[j * 2];
1284 int yy = y - s->cmp->offsets[j * 2 + 1];
1286 font->driver->draw (s, j, j + 1, xx, yy, 0);
1287 if (s->face->overstrike)
1288 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1291 else
1293 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1294 Lisp_Object glyph;
1295 int y = s->ybase;
1296 int width = 0;
1298 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1300 glyph = LGSTRING_GLYPH (gstring, i);
1301 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1302 width += LGLYPH_WIDTH (glyph);
1303 else
1305 int xoff, yoff, wadjust;
1307 if (j < i)
1309 font->driver->draw (s, j, i, x, y, 0);
1310 if (s->face->overstrike)
1311 font->driver->draw (s, j, i, x + 1, y, 0);
1312 x += width;
1314 xoff = LGLYPH_XOFF (glyph);
1315 yoff = LGLYPH_YOFF (glyph);
1316 wadjust = LGLYPH_WADJUST (glyph);
1317 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1318 if (s->face->overstrike)
1319 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1320 x += wadjust;
1321 j = i + 1;
1322 width = 0;
1325 if (j < i)
1327 font->driver->draw (s, j, i, x, y, 0);
1328 if (s->face->overstrike)
1329 font->driver->draw (s, j, i, x + 1, y, 0);
1335 /* Draw the foreground of glyph string S for glyphless characters. */
1337 static void
1338 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1340 struct glyph *glyph = s->first_glyph;
1341 XChar2b char2b[8];
1342 int x, i, j;
1344 /* If first glyph of S has a left box line, start drawing the text
1345 of S to the right of that box line. */
1346 if (s->face && s->face->box != FACE_NO_BOX
1347 && s->first_glyph->left_box_line_p)
1348 x = s->x + eabs (s->face->box_line_width);
1349 else
1350 x = s->x;
1352 s->char2b = char2b;
1354 for (i = 0; i < s->nchars; i++, glyph++)
1356 char buf[7], *str = NULL;
1357 int len = glyph->u.glyphless.len;
1359 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1361 if (len > 0
1362 && CHAR_TABLE_P (Vglyphless_char_display)
1363 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1364 >= 1))
1366 Lisp_Object acronym
1367 = (! glyph->u.glyphless.for_no_font
1368 ? CHAR_TABLE_REF (Vglyphless_char_display,
1369 glyph->u.glyphless.ch)
1370 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1371 if (STRINGP (acronym))
1372 str = SSDATA (acronym);
1375 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1377 sprintf ((char *) buf, "%0*X",
1378 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1379 glyph->u.glyphless.ch);
1380 str = buf;
1383 if (str)
1385 int upper_len = (len + 1) / 2;
1386 unsigned code;
1388 /* It is assured that all LEN characters in STR is ASCII. */
1389 for (j = 0; j < len; j++)
1391 code = s->font->driver->encode_char (s->font, str[j]);
1392 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1394 s->font->driver->draw (s, 0, upper_len,
1395 x + glyph->slice.glyphless.upper_xoff,
1396 s->ybase + glyph->slice.glyphless.upper_yoff,
1398 s->font->driver->draw (s, upper_len, len,
1399 x + glyph->slice.glyphless.lower_xoff,
1400 s->ybase + glyph->slice.glyphless.lower_yoff,
1403 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1404 XDrawRectangle (s->display, s->window, s->gc,
1405 x, s->ybase - glyph->ascent,
1406 glyph->pixel_width - 1,
1407 glyph->ascent + glyph->descent - 1);
1408 x += glyph->pixel_width;
1412 #ifdef USE_X_TOOLKIT
1414 #ifdef USE_LUCID
1416 /* Return the frame on which widget WIDGET is used.. Abort if frame
1417 cannot be determined. */
1419 static struct frame *
1420 x_frame_of_widget (Widget widget)
1422 struct x_display_info *dpyinfo;
1423 Lisp_Object tail, frame;
1424 struct frame *f;
1426 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1428 /* Find the top-level shell of the widget. Note that this function
1429 can be called when the widget is not yet realized, so XtWindow
1430 (widget) == 0. That's the reason we can't simply use
1431 x_any_window_to_frame. */
1432 while (!XtIsTopLevelShell (widget))
1433 widget = XtParent (widget);
1435 /* Look for a frame with that top-level widget. Allocate the color
1436 on that frame to get the right gamma correction value. */
1437 FOR_EACH_FRAME (tail, frame)
1439 f = XFRAME (frame);
1440 if (FRAME_X_P (f)
1441 && f->output_data.nothing != 1
1442 && FRAME_X_DISPLAY_INFO (f) == dpyinfo
1443 && f->output_data.x->widget == widget)
1444 return f;
1446 emacs_abort ();
1449 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1450 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1451 If this produces the same color as PIXEL, try a color where all RGB
1452 values have DELTA added. Return the allocated color in *PIXEL.
1453 DISPLAY is the X display, CMAP is the colormap to operate on.
1454 Value is true if successful. */
1456 bool
1457 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1458 unsigned long *pixel, double factor, int delta)
1460 struct frame *f = x_frame_of_widget (widget);
1461 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1464 #endif /* USE_LUCID */
1467 /* Structure specifying which arguments should be passed by Xt to
1468 cvt_string_to_pixel. We want the widget's screen and colormap. */
1470 static XtConvertArgRec cvt_string_to_pixel_args[] =
1472 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1473 sizeof (Screen *)},
1474 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1475 sizeof (Colormap)}
1479 /* The address of this variable is returned by
1480 cvt_string_to_pixel. */
1482 static Pixel cvt_string_to_pixel_value;
1485 /* Convert a color name to a pixel color.
1487 DPY is the display we are working on.
1489 ARGS is an array of *NARGS XrmValue structures holding additional
1490 information about the widget for which the conversion takes place.
1491 The contents of this array are determined by the specification
1492 in cvt_string_to_pixel_args.
1494 FROM is a pointer to an XrmValue which points to the color name to
1495 convert. TO is an XrmValue in which to return the pixel color.
1497 CLOSURE_RET is a pointer to user-data, in which we record if
1498 we allocated the color or not.
1500 Value is True if successful, False otherwise. */
1502 static Boolean
1503 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1504 XrmValue *from, XrmValue *to,
1505 XtPointer *closure_ret)
1507 Screen *screen;
1508 Colormap cmap;
1509 Pixel pixel;
1510 String color_name;
1511 XColor color;
1513 if (*nargs != 2)
1515 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1516 "wrongParameters", "cvt_string_to_pixel",
1517 "XtToolkitError",
1518 "Screen and colormap args required", NULL, NULL);
1519 return False;
1522 screen = *(Screen **) args[0].addr;
1523 cmap = *(Colormap *) args[1].addr;
1524 color_name = (String) from->addr;
1526 if (strcmp (color_name, XtDefaultBackground) == 0)
1528 *closure_ret = (XtPointer) False;
1529 pixel = WhitePixelOfScreen (screen);
1531 else if (strcmp (color_name, XtDefaultForeground) == 0)
1533 *closure_ret = (XtPointer) False;
1534 pixel = BlackPixelOfScreen (screen);
1536 else if (XParseColor (dpy, cmap, color_name, &color)
1537 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1539 pixel = color.pixel;
1540 *closure_ret = (XtPointer) True;
1542 else
1544 String params[1];
1545 Cardinal nparams = 1;
1547 params[0] = color_name;
1548 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1549 "badValue", "cvt_string_to_pixel",
1550 "XtToolkitError", "Invalid color `%s'",
1551 params, &nparams);
1552 return False;
1555 if (to->addr != NULL)
1557 if (to->size < sizeof (Pixel))
1559 to->size = sizeof (Pixel);
1560 return False;
1563 *(Pixel *) to->addr = pixel;
1565 else
1567 cvt_string_to_pixel_value = pixel;
1568 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1571 to->size = sizeof (Pixel);
1572 return True;
1576 /* Free a pixel color which was previously allocated via
1577 cvt_string_to_pixel. This is registered as the destructor
1578 for this type of resource via XtSetTypeConverter.
1580 APP is the application context in which we work.
1582 TO is a pointer to an XrmValue holding the color to free.
1583 CLOSURE is the value we stored in CLOSURE_RET for this color
1584 in cvt_string_to_pixel.
1586 ARGS and NARGS are like for cvt_string_to_pixel. */
1588 static void
1589 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1590 Cardinal *nargs)
1592 if (*nargs != 2)
1594 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1595 "XtToolkitError",
1596 "Screen and colormap arguments required",
1597 NULL, NULL);
1599 else if (closure != NULL)
1601 /* We did allocate the pixel, so free it. */
1602 Screen *screen = *(Screen **) args[0].addr;
1603 Colormap cmap = *(Colormap *) args[1].addr;
1604 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1605 (Pixel *) to->addr, 1);
1610 #endif /* USE_X_TOOLKIT */
1613 /* Value is an array of XColor structures for the contents of the
1614 color map of display DPY. Set *NCELLS to the size of the array.
1615 Note that this probably shouldn't be called for large color maps,
1616 say a 24-bit TrueColor map. */
1618 static const XColor *
1619 x_color_cells (Display *dpy, int *ncells)
1621 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1623 if (dpyinfo->color_cells == NULL)
1625 Screen *screen = dpyinfo->screen;
1626 int ncolor_cells = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1627 int i;
1629 dpyinfo->color_cells = xnmalloc (ncolor_cells,
1630 sizeof *dpyinfo->color_cells);
1631 dpyinfo->ncolor_cells = ncolor_cells;
1633 for (i = 0; i < ncolor_cells; ++i)
1634 dpyinfo->color_cells[i].pixel = i;
1636 XQueryColors (dpy, dpyinfo->cmap,
1637 dpyinfo->color_cells, ncolor_cells);
1640 *ncells = dpyinfo->ncolor_cells;
1641 return dpyinfo->color_cells;
1645 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1646 colors in COLORS. Use cached information, if available. */
1648 void
1649 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1651 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1653 if (dpyinfo->color_cells)
1655 int i;
1656 for (i = 0; i < ncolors; ++i)
1658 unsigned long pixel = colors[i].pixel;
1659 eassert (pixel < dpyinfo->ncolor_cells);
1660 eassert (dpyinfo->color_cells[pixel].pixel == pixel);
1661 colors[i] = dpyinfo->color_cells[pixel];
1664 else
1665 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1669 /* On frame F, translate pixel color to RGB values for the color in
1670 COLOR. Use cached information, if available. */
1672 void
1673 x_query_color (struct frame *f, XColor *color)
1675 x_query_colors (f, color, 1);
1679 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1680 exact match can't be allocated, try the nearest color available.
1681 Value is true if successful. Set *COLOR to the color
1682 allocated. */
1684 static bool
1685 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1687 bool rc;
1689 rc = XAllocColor (dpy, cmap, color) != 0;
1690 if (rc == 0)
1692 /* If we got to this point, the colormap is full, so we're going
1693 to try to get the next closest color. The algorithm used is
1694 a least-squares matching, which is what X uses for closest
1695 color matching with StaticColor visuals. */
1696 int nearest, i;
1697 int max_color_delta = 255;
1698 int max_delta = 3 * max_color_delta;
1699 int nearest_delta = max_delta + 1;
1700 int ncells;
1701 const XColor *cells = x_color_cells (dpy, &ncells);
1703 for (nearest = i = 0; i < ncells; ++i)
1705 int dred = (color->red >> 8) - (cells[i].red >> 8);
1706 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
1707 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1708 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
1710 if (delta < nearest_delta)
1712 nearest = i;
1713 nearest_delta = delta;
1717 color->red = cells[nearest].red;
1718 color->green = cells[nearest].green;
1719 color->blue = cells[nearest].blue;
1720 rc = XAllocColor (dpy, cmap, color) != 0;
1722 else
1724 /* If allocation succeeded, and the allocated pixel color is not
1725 equal to a cached pixel color recorded earlier, there was a
1726 change in the colormap, so clear the color cache. */
1727 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1728 XColor *cached_color;
1730 if (dpyinfo->color_cells
1731 && (cached_color = &dpyinfo->color_cells[color->pixel],
1732 (cached_color->red != color->red
1733 || cached_color->blue != color->blue
1734 || cached_color->green != color->green)))
1736 xfree (dpyinfo->color_cells);
1737 dpyinfo->color_cells = NULL;
1738 dpyinfo->ncolor_cells = 0;
1742 #ifdef DEBUG_X_COLORS
1743 if (rc)
1744 register_color (color->pixel);
1745 #endif /* DEBUG_X_COLORS */
1747 return rc;
1751 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1752 exact match can't be allocated, try the nearest color available.
1753 Value is true if successful. Set *COLOR to the color
1754 allocated. */
1756 bool
1757 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1759 gamma_correct (f, color);
1760 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1764 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1765 It's necessary to do this instead of just using PIXEL directly to
1766 get color reference counts right. */
1768 unsigned long
1769 x_copy_color (struct frame *f, long unsigned int pixel)
1771 XColor color;
1773 color.pixel = pixel;
1774 block_input ();
1775 x_query_color (f, &color);
1776 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1777 unblock_input ();
1778 #ifdef DEBUG_X_COLORS
1779 register_color (pixel);
1780 #endif
1781 return color.pixel;
1785 /* Brightness beyond which a color won't have its highlight brightness
1786 boosted.
1788 Nominally, highlight colors for `3d' faces are calculated by
1789 brightening an object's color by a constant scale factor, but this
1790 doesn't yield good results for dark colors, so for colors who's
1791 brightness is less than this value (on a scale of 0-65535) have an
1792 use an additional additive factor.
1794 The value here is set so that the default menu-bar/mode-line color
1795 (grey75) will not have its highlights changed at all. */
1796 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1799 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1800 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1801 If this produces the same color as PIXEL, try a color where all RGB
1802 values have DELTA added. Return the allocated color in *PIXEL.
1803 DISPLAY is the X display, CMAP is the colormap to operate on.
1804 Value is non-zero if successful. */
1806 static bool
1807 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1809 XColor color, new;
1810 long bright;
1811 bool success_p;
1813 /* Get RGB color values. */
1814 color.pixel = *pixel;
1815 x_query_color (f, &color);
1817 /* Change RGB values by specified FACTOR. Avoid overflow! */
1818 eassert (factor >= 0);
1819 new.red = min (0xffff, factor * color.red);
1820 new.green = min (0xffff, factor * color.green);
1821 new.blue = min (0xffff, factor * color.blue);
1823 /* Calculate brightness of COLOR. */
1824 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1826 /* We only boost colors that are darker than
1827 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1828 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1829 /* Make an additive adjustment to NEW, because it's dark enough so
1830 that scaling by FACTOR alone isn't enough. */
1832 /* How far below the limit this color is (0 - 1, 1 being darker). */
1833 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1834 /* The additive adjustment. */
1835 int min_delta = delta * dimness * factor / 2;
1837 if (factor < 1)
1839 new.red = max (0, new.red - min_delta);
1840 new.green = max (0, new.green - min_delta);
1841 new.blue = max (0, new.blue - min_delta);
1843 else
1845 new.red = min (0xffff, min_delta + new.red);
1846 new.green = min (0xffff, min_delta + new.green);
1847 new.blue = min (0xffff, min_delta + new.blue);
1851 /* Try to allocate the color. */
1852 success_p = x_alloc_nearest_color (f, cmap, &new);
1853 if (success_p)
1855 if (new.pixel == *pixel)
1857 /* If we end up with the same color as before, try adding
1858 delta to the RGB values. */
1859 x_free_colors (f, &new.pixel, 1);
1861 new.red = min (0xffff, delta + color.red);
1862 new.green = min (0xffff, delta + color.green);
1863 new.blue = min (0xffff, delta + color.blue);
1864 success_p = x_alloc_nearest_color (f, cmap, &new);
1866 else
1867 success_p = 1;
1868 *pixel = new.pixel;
1871 return success_p;
1875 /* Set up the foreground color for drawing relief lines of glyph
1876 string S. RELIEF is a pointer to a struct relief containing the GC
1877 with which lines will be drawn. Use a color that is FACTOR or
1878 DELTA lighter or darker than the relief's background which is found
1879 in S->f->output_data.x->relief_background. If such a color cannot
1880 be allocated, use DEFAULT_PIXEL, instead. */
1882 static void
1883 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1885 XGCValues xgcv;
1886 struct x_output *di = f->output_data.x;
1887 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1888 unsigned long pixel;
1889 unsigned long background = di->relief_background;
1890 Colormap cmap = FRAME_X_COLORMAP (f);
1891 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1892 Display *dpy = FRAME_X_DISPLAY (f);
1894 xgcv.graphics_exposures = False;
1895 xgcv.line_width = 1;
1897 /* Free previously allocated color. The color cell will be reused
1898 when it has been freed as many times as it was allocated, so this
1899 doesn't affect faces using the same colors. */
1900 if (relief->gc
1901 && relief->allocated_p)
1903 x_free_colors (f, &relief->pixel, 1);
1904 relief->allocated_p = 0;
1907 /* Allocate new color. */
1908 xgcv.foreground = default_pixel;
1909 pixel = background;
1910 if (dpyinfo->n_planes != 1
1911 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1913 relief->allocated_p = 1;
1914 xgcv.foreground = relief->pixel = pixel;
1917 if (relief->gc == 0)
1919 xgcv.stipple = dpyinfo->gray;
1920 mask |= GCStipple;
1921 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1923 else
1924 XChangeGC (dpy, relief->gc, mask, &xgcv);
1928 /* Set up colors for the relief lines around glyph string S. */
1930 static void
1931 x_setup_relief_colors (struct glyph_string *s)
1933 struct x_output *di = s->f->output_data.x;
1934 unsigned long color;
1936 if (s->face->use_box_color_for_shadows_p)
1937 color = s->face->box_color;
1938 else if (s->first_glyph->type == IMAGE_GLYPH
1939 && s->img->pixmap
1940 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1941 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1942 else
1944 XGCValues xgcv;
1946 /* Get the background color of the face. */
1947 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1948 color = xgcv.background;
1951 if (di->white_relief.gc == 0
1952 || color != di->relief_background)
1954 di->relief_background = color;
1955 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1956 WHITE_PIX_DEFAULT (s->f));
1957 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1958 BLACK_PIX_DEFAULT (s->f));
1963 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
1964 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
1965 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
1966 relief. LEFT_P non-zero means draw a relief on the left side of
1967 the rectangle. RIGHT_P non-zero means draw a relief on the right
1968 side of the rectangle. CLIP_RECT is the clipping rectangle to use
1969 when drawing. */
1971 static void
1972 x_draw_relief_rect (struct frame *f,
1973 int left_x, int top_y, int right_x, int bottom_y, int width,
1974 int raised_p, int top_p, int bot_p, int left_p, int right_p,
1975 XRectangle *clip_rect)
1977 Display *dpy = FRAME_X_DISPLAY (f);
1978 Window window = FRAME_X_WINDOW (f);
1979 int i;
1980 GC gc;
1982 if (raised_p)
1983 gc = f->output_data.x->white_relief.gc;
1984 else
1985 gc = f->output_data.x->black_relief.gc;
1986 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
1988 /* This code is more complicated than it has to be, because of two
1989 minor hacks to make the boxes look nicer: (i) if width > 1, draw
1990 the outermost line using the black relief. (ii) Omit the four
1991 corner pixels. */
1993 /* Top. */
1994 if (top_p)
1996 if (width == 1)
1997 XDrawLine (dpy, window, gc,
1998 left_x + (left_p ? 1 : 0), top_y,
1999 right_x + (right_p ? 0 : 1), top_y);
2001 for (i = 1; i < width; ++i)
2002 XDrawLine (dpy, window, gc,
2003 left_x + i * left_p, top_y + i,
2004 right_x + 1 - i * right_p, top_y + i);
2007 /* Left. */
2008 if (left_p)
2010 if (width == 1)
2011 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2013 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2014 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2016 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2017 XDrawLine (dpy, window, gc,
2018 left_x + i, top_y + (i + 1) * top_p,
2019 left_x + i, bottom_y + 1 - (i + 1) * bot_p);
2022 XSetClipMask (dpy, gc, None);
2023 if (raised_p)
2024 gc = f->output_data.x->black_relief.gc;
2025 else
2026 gc = f->output_data.x->white_relief.gc;
2027 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2029 if (width > 1)
2031 /* Outermost top line. */
2032 if (top_p)
2033 XDrawLine (dpy, window, gc,
2034 left_x + (left_p ? 1 : 0), top_y,
2035 right_x + (right_p ? 0 : 1), top_y);
2037 /* Outermost left line. */
2038 if (left_p)
2039 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2042 /* Bottom. */
2043 if (bot_p)
2045 XDrawLine (dpy, window, gc,
2046 left_x + (left_p ? 1 : 0), bottom_y,
2047 right_x + (right_p ? 0 : 1), bottom_y);
2048 for (i = 1; i < width; ++i)
2049 XDrawLine (dpy, window, gc,
2050 left_x + i * left_p, bottom_y - i,
2051 right_x + 1 - i * right_p, bottom_y - i);
2054 /* Right. */
2055 if (right_p)
2057 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2058 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2059 for (i = 0; i < width; ++i)
2060 XDrawLine (dpy, window, gc,
2061 right_x - i, top_y + (i + 1) * top_p,
2062 right_x - i, bottom_y + 1 - (i + 1) * bot_p);
2065 XSetClipMask (dpy, gc, None);
2069 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2070 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2071 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2072 left side of the rectangle. RIGHT_P non-zero means draw a line
2073 on the right side of the rectangle. CLIP_RECT is the clipping
2074 rectangle to use when drawing. */
2076 static void
2077 x_draw_box_rect (struct glyph_string *s,
2078 int left_x, int top_y, int right_x, int bottom_y, int width,
2079 int left_p, int right_p, XRectangle *clip_rect)
2081 XGCValues xgcv;
2083 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2084 XSetForeground (s->display, s->gc, s->face->box_color);
2085 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2087 /* Top. */
2088 XFillRectangle (s->display, s->window, s->gc,
2089 left_x, top_y, right_x - left_x + 1, width);
2091 /* Left. */
2092 if (left_p)
2093 XFillRectangle (s->display, s->window, s->gc,
2094 left_x, top_y, width, bottom_y - top_y + 1);
2096 /* Bottom. */
2097 XFillRectangle (s->display, s->window, s->gc,
2098 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2100 /* Right. */
2101 if (right_p)
2102 XFillRectangle (s->display, s->window, s->gc,
2103 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2105 XSetForeground (s->display, s->gc, xgcv.foreground);
2106 XSetClipMask (s->display, s->gc, None);
2110 /* Draw a box around glyph string S. */
2112 static void
2113 x_draw_glyph_string_box (struct glyph_string *s)
2115 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2116 int left_p, right_p;
2117 struct glyph *last_glyph;
2118 XRectangle clip_rect;
2120 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2121 ? WINDOW_RIGHT_EDGE_X (s->w)
2122 : window_box_right (s->w, s->area));
2124 /* The glyph that may have a right box line. */
2125 last_glyph = (s->cmp || s->img
2126 ? s->first_glyph
2127 : s->first_glyph + s->nchars - 1);
2129 width = eabs (s->face->box_line_width);
2130 raised_p = s->face->box == FACE_RAISED_BOX;
2131 left_x = s->x;
2132 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2133 ? last_x - 1
2134 : min (last_x, s->x + s->background_width) - 1);
2135 top_y = s->y;
2136 bottom_y = top_y + s->height - 1;
2138 left_p = (s->first_glyph->left_box_line_p
2139 || (s->hl == DRAW_MOUSE_FACE
2140 && (s->prev == NULL
2141 || s->prev->hl != s->hl)));
2142 right_p = (last_glyph->right_box_line_p
2143 || (s->hl == DRAW_MOUSE_FACE
2144 && (s->next == NULL
2145 || s->next->hl != s->hl)));
2147 get_glyph_string_clip_rect (s, &clip_rect);
2149 if (s->face->box == FACE_SIMPLE_BOX)
2150 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2151 left_p, right_p, &clip_rect);
2152 else
2154 x_setup_relief_colors (s);
2155 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2156 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2161 /* Draw foreground of image glyph string S. */
2163 static void
2164 x_draw_image_foreground (struct glyph_string *s)
2166 int x = s->x;
2167 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2169 /* If first glyph of S has a left box line, start drawing it to the
2170 right of that line. */
2171 if (s->face->box != FACE_NO_BOX
2172 && s->first_glyph->left_box_line_p
2173 && s->slice.x == 0)
2174 x += eabs (s->face->box_line_width);
2176 /* If there is a margin around the image, adjust x- and y-position
2177 by that margin. */
2178 if (s->slice.x == 0)
2179 x += s->img->hmargin;
2180 if (s->slice.y == 0)
2181 y += s->img->vmargin;
2183 if (s->img->pixmap)
2185 if (s->img->mask)
2187 /* We can't set both a clip mask and use XSetClipRectangles
2188 because the latter also sets a clip mask. We also can't
2189 trust on the shape extension to be available
2190 (XShapeCombineRegion). So, compute the rectangle to draw
2191 manually. */
2192 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2193 | GCFunction);
2194 XGCValues xgcv;
2195 XRectangle clip_rect, image_rect, r;
2197 xgcv.clip_mask = s->img->mask;
2198 xgcv.clip_x_origin = x;
2199 xgcv.clip_y_origin = y;
2200 xgcv.function = GXcopy;
2201 XChangeGC (s->display, s->gc, mask, &xgcv);
2203 get_glyph_string_clip_rect (s, &clip_rect);
2204 image_rect.x = x;
2205 image_rect.y = y;
2206 image_rect.width = s->slice.width;
2207 image_rect.height = s->slice.height;
2208 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2209 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2210 s->slice.x + r.x - x, s->slice.y + r.y - y,
2211 r.width, r.height, r.x, r.y);
2213 else
2215 XRectangle clip_rect, image_rect, r;
2217 get_glyph_string_clip_rect (s, &clip_rect);
2218 image_rect.x = x;
2219 image_rect.y = y;
2220 image_rect.width = s->slice.width;
2221 image_rect.height = s->slice.height;
2222 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2223 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2224 s->slice.x + r.x - x, s->slice.y + r.y - y,
2225 r.width, r.height, r.x, r.y);
2227 /* When the image has a mask, we can expect that at
2228 least part of a mouse highlight or a block cursor will
2229 be visible. If the image doesn't have a mask, make
2230 a block cursor visible by drawing a rectangle around
2231 the image. I believe it's looking better if we do
2232 nothing here for mouse-face. */
2233 if (s->hl == DRAW_CURSOR)
2235 int relief = eabs (s->img->relief);
2236 XDrawRectangle (s->display, s->window, s->gc,
2237 x - relief, y - relief,
2238 s->slice.width + relief*2 - 1,
2239 s->slice.height + relief*2 - 1);
2243 else
2244 /* Draw a rectangle if image could not be loaded. */
2245 XDrawRectangle (s->display, s->window, s->gc, x, y,
2246 s->slice.width - 1, s->slice.height - 1);
2250 /* Draw a relief around the image glyph string S. */
2252 static void
2253 x_draw_image_relief (struct glyph_string *s)
2255 int x1, y1, thick, raised_p, top_p, bot_p, left_p, right_p;
2256 XRectangle r;
2257 int x = s->x;
2258 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2260 /* If first glyph of S has a left box line, start drawing it to the
2261 right of that line. */
2262 if (s->face->box != FACE_NO_BOX
2263 && s->first_glyph->left_box_line_p
2264 && s->slice.x == 0)
2265 x += eabs (s->face->box_line_width);
2267 /* If there is a margin around the image, adjust x- and y-position
2268 by that margin. */
2269 if (s->slice.x == 0)
2270 x += s->img->hmargin;
2271 if (s->slice.y == 0)
2272 y += s->img->vmargin;
2274 if (s->hl == DRAW_IMAGE_SUNKEN
2275 || s->hl == DRAW_IMAGE_RAISED)
2277 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2278 raised_p = s->hl == DRAW_IMAGE_RAISED;
2280 else
2282 thick = eabs (s->img->relief);
2283 raised_p = s->img->relief > 0;
2286 x1 = x + s->slice.width - 1;
2287 y1 = y + s->slice.height - 1;
2288 top_p = bot_p = left_p = right_p = 0;
2290 if (s->slice.x == 0)
2291 x -= thick, left_p = 1;
2292 if (s->slice.y == 0)
2293 y -= thick, top_p = 1;
2294 if (s->slice.x + s->slice.width == s->img->width)
2295 x1 += thick, right_p = 1;
2296 if (s->slice.y + s->slice.height == s->img->height)
2297 y1 += thick, bot_p = 1;
2299 x_setup_relief_colors (s);
2300 get_glyph_string_clip_rect (s, &r);
2301 x_draw_relief_rect (s->f, x, y, x1, y1, thick, raised_p,
2302 top_p, bot_p, left_p, right_p, &r);
2306 /* Draw the foreground of image glyph string S to PIXMAP. */
2308 static void
2309 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2311 int x = 0;
2312 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2314 /* If first glyph of S has a left box line, start drawing it to the
2315 right of that line. */
2316 if (s->face->box != FACE_NO_BOX
2317 && s->first_glyph->left_box_line_p
2318 && s->slice.x == 0)
2319 x += eabs (s->face->box_line_width);
2321 /* If there is a margin around the image, adjust x- and y-position
2322 by that margin. */
2323 if (s->slice.x == 0)
2324 x += s->img->hmargin;
2325 if (s->slice.y == 0)
2326 y += s->img->vmargin;
2328 if (s->img->pixmap)
2330 if (s->img->mask)
2332 /* We can't set both a clip mask and use XSetClipRectangles
2333 because the latter also sets a clip mask. We also can't
2334 trust on the shape extension to be available
2335 (XShapeCombineRegion). So, compute the rectangle to draw
2336 manually. */
2337 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2338 | GCFunction);
2339 XGCValues xgcv;
2341 xgcv.clip_mask = s->img->mask;
2342 xgcv.clip_x_origin = x - s->slice.x;
2343 xgcv.clip_y_origin = y - s->slice.y;
2344 xgcv.function = GXcopy;
2345 XChangeGC (s->display, s->gc, mask, &xgcv);
2347 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2348 s->slice.x, s->slice.y,
2349 s->slice.width, s->slice.height, x, y);
2350 XSetClipMask (s->display, s->gc, None);
2352 else
2354 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2355 s->slice.x, s->slice.y,
2356 s->slice.width, s->slice.height, x, y);
2358 /* When the image has a mask, we can expect that at
2359 least part of a mouse highlight or a block cursor will
2360 be visible. If the image doesn't have a mask, make
2361 a block cursor visible by drawing a rectangle around
2362 the image. I believe it's looking better if we do
2363 nothing here for mouse-face. */
2364 if (s->hl == DRAW_CURSOR)
2366 int r = eabs (s->img->relief);
2367 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2368 s->slice.width + r*2 - 1,
2369 s->slice.height + r*2 - 1);
2373 else
2374 /* Draw a rectangle if image could not be loaded. */
2375 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2376 s->slice.width - 1, s->slice.height - 1);
2380 /* Draw part of the background of glyph string S. X, Y, W, and H
2381 give the rectangle to draw. */
2383 static void
2384 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2386 if (s->stippled_p)
2388 /* Fill background with a stipple pattern. */
2389 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2390 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2391 XSetFillStyle (s->display, s->gc, FillSolid);
2393 else
2394 x_clear_glyph_string_rect (s, x, y, w, h);
2398 /* Draw image glyph string S.
2400 s->y
2401 s->x +-------------------------
2402 | s->face->box
2404 | +-------------------------
2405 | | s->img->margin
2407 | | +-------------------
2408 | | | the image
2412 static void
2413 x_draw_image_glyph_string (struct glyph_string *s)
2415 int box_line_hwidth = eabs (s->face->box_line_width);
2416 int box_line_vwidth = max (s->face->box_line_width, 0);
2417 int height;
2418 Pixmap pixmap = None;
2420 height = s->height;
2421 if (s->slice.y == 0)
2422 height -= box_line_vwidth;
2423 if (s->slice.y + s->slice.height >= s->img->height)
2424 height -= box_line_vwidth;
2426 /* Fill background with face under the image. Do it only if row is
2427 taller than image or if image has a clip mask to reduce
2428 flickering. */
2429 s->stippled_p = s->face->stipple != 0;
2430 if (height > s->slice.height
2431 || s->img->hmargin
2432 || s->img->vmargin
2433 || s->img->mask
2434 || s->img->pixmap == 0
2435 || s->width != s->background_width)
2437 if (s->img->mask)
2439 /* Create a pixmap as large as the glyph string. Fill it
2440 with the background color. Copy the image to it, using
2441 its mask. Copy the temporary pixmap to the display. */
2442 Screen *screen = FRAME_X_SCREEN (s->f);
2443 int depth = DefaultDepthOfScreen (screen);
2445 /* Create a pixmap as large as the glyph string. */
2446 pixmap = XCreatePixmap (s->display, s->window,
2447 s->background_width,
2448 s->height, depth);
2450 /* Don't clip in the following because we're working on the
2451 pixmap. */
2452 XSetClipMask (s->display, s->gc, None);
2454 /* Fill the pixmap with the background color/stipple. */
2455 if (s->stippled_p)
2457 /* Fill background with a stipple pattern. */
2458 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2459 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2460 XFillRectangle (s->display, pixmap, s->gc,
2461 0, 0, s->background_width, s->height);
2462 XSetFillStyle (s->display, s->gc, FillSolid);
2463 XSetTSOrigin (s->display, s->gc, 0, 0);
2465 else
2467 XGCValues xgcv;
2468 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2469 &xgcv);
2470 XSetForeground (s->display, s->gc, xgcv.background);
2471 XFillRectangle (s->display, pixmap, s->gc,
2472 0, 0, s->background_width, s->height);
2473 XSetForeground (s->display, s->gc, xgcv.foreground);
2476 else
2478 int x = s->x;
2479 int y = s->y;
2481 if (s->first_glyph->left_box_line_p
2482 && s->slice.x == 0)
2483 x += box_line_hwidth;
2485 if (s->slice.y == 0)
2486 y += box_line_vwidth;
2488 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2491 s->background_filled_p = 1;
2494 /* Draw the foreground. */
2495 if (pixmap != None)
2497 x_draw_image_foreground_1 (s, pixmap);
2498 x_set_glyph_string_clipping (s);
2499 XCopyArea (s->display, pixmap, s->window, s->gc,
2500 0, 0, s->background_width, s->height, s->x, s->y);
2501 XFreePixmap (s->display, pixmap);
2503 else
2504 x_draw_image_foreground (s);
2506 /* If we must draw a relief around the image, do it. */
2507 if (s->img->relief
2508 || s->hl == DRAW_IMAGE_RAISED
2509 || s->hl == DRAW_IMAGE_SUNKEN)
2510 x_draw_image_relief (s);
2514 /* Draw stretch glyph string S. */
2516 static void
2517 x_draw_stretch_glyph_string (struct glyph_string *s)
2519 eassert (s->first_glyph->type == STRETCH_GLYPH);
2521 if (s->hl == DRAW_CURSOR
2522 && !x_stretch_cursor_p)
2524 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2525 wide as the stretch glyph. */
2526 int width, background_width = s->background_width;
2527 int x = s->x;
2529 if (!s->row->reversed_p)
2531 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2533 if (x < left_x)
2535 background_width -= left_x - x;
2536 x = left_x;
2539 else
2541 /* In R2L rows, draw the cursor on the right edge of the
2542 stretch glyph. */
2543 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2545 if (x + background_width > right_x)
2546 background_width -= x - right_x;
2547 x += background_width;
2549 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2550 if (s->row->reversed_p)
2551 x -= width;
2553 /* Draw cursor. */
2554 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2556 /* Clear rest using the GC of the original non-cursor face. */
2557 if (width < background_width)
2559 int y = s->y;
2560 int w = background_width - width, h = s->height;
2561 XRectangle r;
2562 GC gc;
2564 if (!s->row->reversed_p)
2565 x += width;
2566 else
2567 x = s->x;
2568 if (s->row->mouse_face_p
2569 && cursor_in_mouse_face_p (s->w))
2571 x_set_mouse_face_gc (s);
2572 gc = s->gc;
2574 else
2575 gc = s->face->gc;
2577 get_glyph_string_clip_rect (s, &r);
2578 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2580 if (s->face->stipple)
2582 /* Fill background with a stipple pattern. */
2583 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2584 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2585 XSetFillStyle (s->display, gc, FillSolid);
2587 else
2589 XGCValues xgcv;
2590 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2591 XSetForeground (s->display, gc, xgcv.background);
2592 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2593 XSetForeground (s->display, gc, xgcv.foreground);
2597 else if (!s->background_filled_p)
2599 int background_width = s->background_width;
2600 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2602 /* Don't draw into left margin, fringe or scrollbar area
2603 except for header line and mode line. */
2604 if (x < left_x && !s->row->mode_line_p)
2606 background_width -= left_x - x;
2607 x = left_x;
2609 if (background_width > 0)
2610 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2613 s->background_filled_p = 1;
2617 Draw a wavy line under S. The wave fills wave_height pixels from y0.
2619 x0 wave_length = 2
2621 y0 * * * * *
2622 |* * * * * * * * *
2623 wave_height = 3 | * * * *
2627 static void
2628 x_draw_underwave (struct glyph_string *s)
2630 int wave_height = 3, wave_length = 2;
2631 int dx, dy, x0, y0, width, x1, y1, x2, y2, odd, xmax;
2632 XRectangle wave_clip, string_clip, final_clip;
2634 dx = wave_length;
2635 dy = wave_height - 1;
2636 x0 = s->x;
2637 y0 = s->ybase - wave_height + 3;
2638 width = s->width;
2639 xmax = x0 + width;
2641 /* Find and set clipping rectangle */
2643 wave_clip.x = x0;
2644 wave_clip.y = y0;
2645 wave_clip.width = width;
2646 wave_clip.height = wave_height;
2647 get_glyph_string_clip_rect (s, &string_clip);
2649 if (!x_intersect_rectangles (&wave_clip, &string_clip, &final_clip))
2650 return;
2652 XSetClipRectangles (s->display, s->gc, 0, 0, &final_clip, 1, Unsorted);
2654 /* Draw the waves */
2656 x1 = x0 - (x0 % dx);
2657 x2 = x1 + dx;
2658 odd = (x1/dx) % 2;
2659 y1 = y2 = y0;
2661 if (odd)
2662 y1 += dy;
2663 else
2664 y2 += dy;
2666 if (INT_MAX - dx < xmax)
2667 emacs_abort ();
2669 while (x1 <= xmax)
2671 XDrawLine (s->display, s->window, s->gc, x1, y1, x2, y2);
2672 x1 = x2, y1 = y2;
2673 x2 += dx, y2 = y0 + odd*dy;
2674 odd = !odd;
2677 /* Restore previous clipping rectangle(s) */
2678 XSetClipRectangles (s->display, s->gc, 0, 0, s->clip, s->num_clips, Unsorted);
2682 /* Draw glyph string S. */
2684 static void
2685 x_draw_glyph_string (struct glyph_string *s)
2687 bool relief_drawn_p = 0;
2689 /* If S draws into the background of its successors, draw the
2690 background of the successors first so that S can draw into it.
2691 This makes S->next use XDrawString instead of XDrawImageString. */
2692 if (s->next && s->right_overhang && !s->for_overlaps)
2694 int width;
2695 struct glyph_string *next;
2697 for (width = 0, next = s->next;
2698 next && width < s->right_overhang;
2699 width += next->width, next = next->next)
2700 if (next->first_glyph->type != IMAGE_GLYPH)
2702 x_set_glyph_string_gc (next);
2703 x_set_glyph_string_clipping (next);
2704 if (next->first_glyph->type == STRETCH_GLYPH)
2705 x_draw_stretch_glyph_string (next);
2706 else
2707 x_draw_glyph_string_background (next, 1);
2708 next->num_clips = 0;
2712 /* Set up S->gc, set clipping and draw S. */
2713 x_set_glyph_string_gc (s);
2715 /* Draw relief (if any) in advance for char/composition so that the
2716 glyph string can be drawn over it. */
2717 if (!s->for_overlaps
2718 && s->face->box != FACE_NO_BOX
2719 && (s->first_glyph->type == CHAR_GLYPH
2720 || s->first_glyph->type == COMPOSITE_GLYPH))
2723 x_set_glyph_string_clipping (s);
2724 x_draw_glyph_string_background (s, 1);
2725 x_draw_glyph_string_box (s);
2726 x_set_glyph_string_clipping (s);
2727 relief_drawn_p = 1;
2729 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2730 && !s->clip_tail
2731 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2732 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2733 /* We must clip just this glyph. left_overhang part has already
2734 drawn when s->prev was drawn, and right_overhang part will be
2735 drawn later when s->next is drawn. */
2736 x_set_glyph_string_clipping_exactly (s, s);
2737 else
2738 x_set_glyph_string_clipping (s);
2740 switch (s->first_glyph->type)
2742 case IMAGE_GLYPH:
2743 x_draw_image_glyph_string (s);
2744 break;
2746 case STRETCH_GLYPH:
2747 x_draw_stretch_glyph_string (s);
2748 break;
2750 case CHAR_GLYPH:
2751 if (s->for_overlaps)
2752 s->background_filled_p = 1;
2753 else
2754 x_draw_glyph_string_background (s, 0);
2755 x_draw_glyph_string_foreground (s);
2756 break;
2758 case COMPOSITE_GLYPH:
2759 if (s->for_overlaps || (s->cmp_from > 0
2760 && ! s->first_glyph->u.cmp.automatic))
2761 s->background_filled_p = 1;
2762 else
2763 x_draw_glyph_string_background (s, 1);
2764 x_draw_composite_glyph_string_foreground (s);
2765 break;
2767 case GLYPHLESS_GLYPH:
2768 if (s->for_overlaps)
2769 s->background_filled_p = 1;
2770 else
2771 x_draw_glyph_string_background (s, 1);
2772 x_draw_glyphless_glyph_string_foreground (s);
2773 break;
2775 default:
2776 emacs_abort ();
2779 if (!s->for_overlaps)
2781 /* Draw underline. */
2782 if (s->face->underline_p)
2784 if (s->face->underline_type == FACE_UNDER_WAVE)
2786 if (s->face->underline_defaulted_p)
2787 x_draw_underwave (s);
2788 else
2790 XGCValues xgcv;
2791 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2792 XSetForeground (s->display, s->gc, s->face->underline_color);
2793 x_draw_underwave (s);
2794 XSetForeground (s->display, s->gc, xgcv.foreground);
2797 else if (s->face->underline_type == FACE_UNDER_LINE)
2799 unsigned long thickness, position;
2800 int y;
2802 if (s->prev && s->prev->face->underline_p
2803 && s->prev->face->underline_type == FACE_UNDER_LINE)
2805 /* We use the same underline style as the previous one. */
2806 thickness = s->prev->underline_thickness;
2807 position = s->prev->underline_position;
2809 else
2811 /* Get the underline thickness. Default is 1 pixel. */
2812 if (s->font && s->font->underline_thickness > 0)
2813 thickness = s->font->underline_thickness;
2814 else
2815 thickness = 1;
2816 if (x_underline_at_descent_line)
2817 position = (s->height - thickness) - (s->ybase - s->y);
2818 else
2820 /* Get the underline position. This is the recommended
2821 vertical offset in pixels from the baseline to the top of
2822 the underline. This is a signed value according to the
2823 specs, and its default is
2825 ROUND ((maximum descent) / 2), with
2826 ROUND(x) = floor (x + 0.5) */
2828 if (x_use_underline_position_properties
2829 && s->font && s->font->underline_position >= 0)
2830 position = s->font->underline_position;
2831 else if (s->font)
2832 position = (s->font->descent + 1) / 2;
2833 else
2834 position = underline_minimum_offset;
2836 position = max (position, underline_minimum_offset);
2838 /* Check the sanity of thickness and position. We should
2839 avoid drawing underline out of the current line area. */
2840 if (s->y + s->height <= s->ybase + position)
2841 position = (s->height - 1) - (s->ybase - s->y);
2842 if (s->y + s->height < s->ybase + position + thickness)
2843 thickness = (s->y + s->height) - (s->ybase + position);
2844 s->underline_thickness = thickness;
2845 s->underline_position = position;
2846 y = s->ybase + position;
2847 if (s->face->underline_defaulted_p)
2848 XFillRectangle (s->display, s->window, s->gc,
2849 s->x, y, s->width, thickness);
2850 else
2852 XGCValues xgcv;
2853 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2854 XSetForeground (s->display, s->gc, s->face->underline_color);
2855 XFillRectangle (s->display, s->window, s->gc,
2856 s->x, y, s->width, thickness);
2857 XSetForeground (s->display, s->gc, xgcv.foreground);
2861 /* Draw overline. */
2862 if (s->face->overline_p)
2864 unsigned long dy = 0, h = 1;
2866 if (s->face->overline_color_defaulted_p)
2867 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2868 s->width, h);
2869 else
2871 XGCValues xgcv;
2872 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2873 XSetForeground (s->display, s->gc, s->face->overline_color);
2874 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2875 s->width, h);
2876 XSetForeground (s->display, s->gc, xgcv.foreground);
2880 /* Draw strike-through. */
2881 if (s->face->strike_through_p)
2883 unsigned long h = 1;
2884 unsigned long dy = (s->height - h) / 2;
2886 if (s->face->strike_through_color_defaulted_p)
2887 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2888 s->width, h);
2889 else
2891 XGCValues xgcv;
2892 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2893 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2894 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2895 s->width, h);
2896 XSetForeground (s->display, s->gc, xgcv.foreground);
2900 /* Draw relief if not yet drawn. */
2901 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2902 x_draw_glyph_string_box (s);
2904 if (s->prev)
2906 struct glyph_string *prev;
2908 for (prev = s->prev; prev; prev = prev->prev)
2909 if (prev->hl != s->hl
2910 && prev->x + prev->width + prev->right_overhang > s->x)
2912 /* As prev was drawn while clipped to its own area, we
2913 must draw the right_overhang part using s->hl now. */
2914 enum draw_glyphs_face save = prev->hl;
2916 prev->hl = s->hl;
2917 x_set_glyph_string_gc (prev);
2918 x_set_glyph_string_clipping_exactly (s, prev);
2919 if (prev->first_glyph->type == CHAR_GLYPH)
2920 x_draw_glyph_string_foreground (prev);
2921 else
2922 x_draw_composite_glyph_string_foreground (prev);
2923 XSetClipMask (prev->display, prev->gc, None);
2924 prev->hl = save;
2925 prev->num_clips = 0;
2929 if (s->next)
2931 struct glyph_string *next;
2933 for (next = s->next; next; next = next->next)
2934 if (next->hl != s->hl
2935 && next->x - next->left_overhang < s->x + s->width)
2937 /* As next will be drawn while clipped to its own area,
2938 we must draw the left_overhang part using s->hl now. */
2939 enum draw_glyphs_face save = next->hl;
2941 next->hl = s->hl;
2942 x_set_glyph_string_gc (next);
2943 x_set_glyph_string_clipping_exactly (s, next);
2944 if (next->first_glyph->type == CHAR_GLYPH)
2945 x_draw_glyph_string_foreground (next);
2946 else
2947 x_draw_composite_glyph_string_foreground (next);
2948 XSetClipMask (next->display, next->gc, None);
2949 next->hl = save;
2950 next->num_clips = 0;
2951 next->clip_head = s->next;
2956 /* Reset clipping. */
2957 XSetClipMask (s->display, s->gc, None);
2958 s->num_clips = 0;
2961 /* Shift display to make room for inserted glyphs. */
2963 static void
2964 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2966 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2967 f->output_data.x->normal_gc,
2968 x, y, width, height,
2969 x + shift_by, y);
2972 /* Delete N glyphs at the nominal cursor position. Not implemented
2973 for X frames. */
2975 static void
2976 x_delete_glyphs (struct frame *f, register int n)
2978 emacs_abort ();
2982 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2983 If they are <= 0, this is probably an error. */
2985 void
2986 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
2988 eassert (width > 0 && height > 0);
2989 XClearArea (dpy, window, x, y, width, height, exposures);
2993 /* Clear an entire frame. */
2995 static void
2996 x_clear_frame (struct frame *f)
2998 /* Clearing the frame will erase any cursor, so mark them all as no
2999 longer visible. */
3000 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
3001 output_cursor.hpos = output_cursor.vpos = 0;
3002 output_cursor.x = -1;
3004 /* We don't set the output cursor here because there will always
3005 follow an explicit cursor_to. */
3006 block_input ();
3008 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
3010 /* We have to clear the scroll bars. If we have changed colors or
3011 something like that, then they should be notified. */
3012 x_scroll_bar_clear (f);
3014 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3015 /* Make sure scroll bars are redrawn. As they aren't redrawn by
3016 redisplay, do it here. */
3017 if (FRAME_GTK_WIDGET (f))
3018 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
3019 #endif
3021 XFlush (FRAME_X_DISPLAY (f));
3023 unblock_input ();
3028 /* Invert the middle quarter of the frame for .15 sec. */
3030 static void
3031 XTflash (struct frame *f)
3033 block_input ();
3036 #ifdef USE_GTK
3037 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3038 when the scroll bars and the edit widget share the same X window. */
3039 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3040 #ifdef HAVE_GTK3
3041 cairo_t *cr = gdk_cairo_create (window);
3042 cairo_set_source_rgb (cr, 1, 1, 1);
3043 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
3044 #define XFillRectangle(d, win, gc, x, y, w, h) \
3045 do { \
3046 cairo_rectangle (cr, x, y, w, h); \
3047 cairo_fill (cr); \
3049 while (0)
3050 #else /* ! HAVE_GTK3 */
3051 GdkGCValues vals;
3052 GdkGC *gc;
3053 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3054 ^ FRAME_BACKGROUND_PIXEL (f));
3055 vals.function = GDK_XOR;
3056 gc = gdk_gc_new_with_values (window,
3057 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3058 #define XFillRectangle(d, win, gc, x, y, w, h) \
3059 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
3060 #endif /* ! HAVE_GTK3 */
3061 #else /* ! USE_GTK */
3062 GC gc;
3064 /* Create a GC that will use the GXxor function to flip foreground
3065 pixels into background pixels. */
3067 XGCValues values;
3069 values.function = GXxor;
3070 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3071 ^ FRAME_BACKGROUND_PIXEL (f));
3073 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3074 GCFunction | GCForeground, &values);
3076 #endif
3078 /* Get the height not including a menu bar widget. */
3079 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3080 /* Height of each line to flash. */
3081 int flash_height = FRAME_LINE_HEIGHT (f);
3082 /* These will be the left and right margins of the rectangles. */
3083 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3084 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3086 int width;
3088 /* Don't flash the area between a scroll bar and the frame
3089 edge it is next to. */
3090 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3092 case vertical_scroll_bar_left:
3093 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3094 break;
3096 case vertical_scroll_bar_right:
3097 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3098 break;
3100 default:
3101 break;
3104 width = flash_right - flash_left;
3106 /* If window is tall, flash top and bottom line. */
3107 if (height > 3 * FRAME_LINE_HEIGHT (f))
3109 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3110 flash_left,
3111 (FRAME_INTERNAL_BORDER_WIDTH (f)
3112 + FRAME_TOP_MARGIN_HEIGHT (f)),
3113 width, flash_height);
3114 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3115 flash_left,
3116 (height - flash_height
3117 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3118 width, flash_height);
3121 else
3122 /* If it is short, flash it all. */
3123 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3124 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3125 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3127 x_flush (f);
3130 EMACS_TIME delay = make_emacs_time (0, 150 * 1000 * 1000);
3131 EMACS_TIME wakeup = add_emacs_time (current_emacs_time (), delay);
3133 /* Keep waiting until past the time wakeup or any input gets
3134 available. */
3135 while (! detect_input_pending ())
3137 EMACS_TIME current = current_emacs_time ();
3138 EMACS_TIME timeout;
3140 /* Break if result would not be positive. */
3141 if (EMACS_TIME_LE (wakeup, current))
3142 break;
3144 /* How long `select' should wait. */
3145 timeout = make_emacs_time (0, 10 * 1000 * 1000);
3147 /* Try to wait that long--but we might wake up sooner. */
3148 pselect (0, NULL, NULL, NULL, &timeout, NULL);
3152 /* If window is tall, flash top and bottom line. */
3153 if (height > 3 * FRAME_LINE_HEIGHT (f))
3155 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3156 flash_left,
3157 (FRAME_INTERNAL_BORDER_WIDTH (f)
3158 + FRAME_TOP_MARGIN_HEIGHT (f)),
3159 width, flash_height);
3160 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3161 flash_left,
3162 (height - flash_height
3163 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3164 width, flash_height);
3166 else
3167 /* If it is short, flash it all. */
3168 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3169 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3170 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3172 #ifdef USE_GTK
3173 #ifdef HAVE_GTK3
3174 cairo_destroy (cr);
3175 #else
3176 g_object_unref (G_OBJECT (gc));
3177 #endif
3178 #undef XFillRectangle
3179 #else
3180 XFreeGC (FRAME_X_DISPLAY (f), gc);
3181 #endif
3182 x_flush (f);
3186 unblock_input ();
3190 static void
3191 XTtoggle_invisible_pointer (struct frame *f, int invisible)
3193 block_input ();
3194 if (invisible)
3196 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3197 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3198 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3200 else
3201 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3202 f->output_data.x->current_cursor);
3203 f->pointer_invisible = invisible;
3204 unblock_input ();
3208 /* Make audible bell. */
3210 static void
3211 XTring_bell (struct frame *f)
3213 if (FRAME_X_DISPLAY (f))
3215 if (visible_bell)
3216 XTflash (f);
3217 else
3219 block_input ();
3220 #ifdef HAVE_XKB
3221 XkbBell (FRAME_X_DISPLAY (f), None, 0, None);
3222 #else
3223 XBell (FRAME_X_DISPLAY (f), 0);
3224 #endif
3225 XFlush (FRAME_X_DISPLAY (f));
3226 unblock_input ();
3232 /* Specify how many text lines, from the top of the window,
3233 should be affected by insert-lines and delete-lines operations.
3234 This, and those operations, are used only within an update
3235 that is bounded by calls to x_update_begin and x_update_end. */
3237 static void
3238 XTset_terminal_window (struct frame *f, int n)
3240 /* This function intentionally left blank. */
3245 /***********************************************************************
3246 Line Dance
3247 ***********************************************************************/
3249 /* Perform an insert-lines or delete-lines operation, inserting N
3250 lines or deleting -N lines at vertical position VPOS. */
3252 static void
3253 x_ins_del_lines (struct frame *f, int vpos, int n)
3255 emacs_abort ();
3259 /* Scroll part of the display as described by RUN. */
3261 static void
3262 x_scroll_run (struct window *w, struct run *run)
3264 struct frame *f = XFRAME (w->frame);
3265 int x, y, width, height, from_y, to_y, bottom_y;
3267 /* Get frame-relative bounding box of the text display area of W,
3268 without mode lines. Include in this box the left and right
3269 fringe of W. */
3270 window_box (w, -1, &x, &y, &width, &height);
3272 #ifdef USE_TOOLKIT_SCROLL_BARS
3273 /* If the fringe is adjacent to the left (right) scroll bar of a
3274 leftmost (rightmost, respectively) window, then extend its
3275 background to the gap between the fringe and the bar. */
3276 if ((WINDOW_LEFTMOST_P (w)
3277 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
3278 || (WINDOW_RIGHTMOST_P (w)
3279 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
3281 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
3283 if (sb_width > 0)
3285 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
3286 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
3287 * FRAME_COLUMN_WIDTH (f));
3289 if (bar_area_x + bar_area_width == x)
3291 x = bar_area_x + sb_width;
3292 width += bar_area_width - sb_width;
3294 else if (x + width == bar_area_x)
3295 width += bar_area_width - sb_width;
3298 #endif
3300 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3301 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3302 bottom_y = y + height;
3304 if (to_y < from_y)
3306 /* Scrolling up. Make sure we don't copy part of the mode
3307 line at the bottom. */
3308 if (from_y + run->height > bottom_y)
3309 height = bottom_y - from_y;
3310 else
3311 height = run->height;
3313 else
3315 /* Scrolling down. Make sure we don't copy over the mode line.
3316 at the bottom. */
3317 if (to_y + run->height > bottom_y)
3318 height = bottom_y - to_y;
3319 else
3320 height = run->height;
3323 block_input ();
3325 /* Cursor off. Will be switched on again in x_update_window_end. */
3326 updated_window = w;
3327 x_clear_cursor (w);
3329 XCopyArea (FRAME_X_DISPLAY (f),
3330 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3331 f->output_data.x->normal_gc,
3332 x, from_y,
3333 width, height,
3334 x, to_y);
3336 unblock_input ();
3341 /***********************************************************************
3342 Exposure Events
3343 ***********************************************************************/
3346 static void
3347 frame_highlight (struct frame *f)
3349 /* We used to only do this if Vx_no_window_manager was non-nil, but
3350 the ICCCM (section 4.1.6) says that the window's border pixmap
3351 and border pixel are window attributes which are "private to the
3352 client", so we can always change it to whatever we want. */
3353 block_input ();
3354 /* I recently started to get errors in this XSetWindowBorder, depending on
3355 the window-manager in use, tho something more is at play since I've been
3356 using that same window-manager binary for ever. Let's not crash just
3357 because of this (bug#9310). */
3358 x_catch_errors (FRAME_X_DISPLAY (f));
3359 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3360 f->output_data.x->border_pixel);
3361 x_uncatch_errors ();
3362 unblock_input ();
3363 x_update_cursor (f, 1);
3364 x_set_frame_alpha (f);
3367 static void
3368 frame_unhighlight (struct frame *f)
3370 /* We used to only do this if Vx_no_window_manager was non-nil, but
3371 the ICCCM (section 4.1.6) says that the window's border pixmap
3372 and border pixel are window attributes which are "private to the
3373 client", so we can always change it to whatever we want. */
3374 block_input ();
3375 /* Same as above for XSetWindowBorder (bug#9310). */
3376 x_catch_errors (FRAME_X_DISPLAY (f));
3377 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3378 f->output_data.x->border_tile);
3379 x_uncatch_errors ();
3380 unblock_input ();
3381 x_update_cursor (f, 1);
3382 x_set_frame_alpha (f);
3385 /* The focus has changed. Update the frames as necessary to reflect
3386 the new situation. Note that we can't change the selected frame
3387 here, because the Lisp code we are interrupting might become confused.
3388 Each event gets marked with the frame in which it occurred, so the
3389 Lisp code can tell when the switch took place by examining the events. */
3391 static void
3392 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3394 struct frame *old_focus = dpyinfo->x_focus_frame;
3396 if (frame != dpyinfo->x_focus_frame)
3398 /* Set this before calling other routines, so that they see
3399 the correct value of x_focus_frame. */
3400 dpyinfo->x_focus_frame = frame;
3402 if (old_focus && old_focus->auto_lower)
3403 x_lower_frame (old_focus);
3405 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3406 pending_autoraise_frame = dpyinfo->x_focus_frame;
3407 else
3408 pending_autoraise_frame = 0;
3411 x_frame_rehighlight (dpyinfo);
3414 /* Handle FocusIn and FocusOut state changes for FRAME.
3415 If FRAME has focus and there exists more than one frame, puts
3416 a FOCUS_IN_EVENT into *BUFP. */
3418 static void
3419 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3421 if (type == FocusIn)
3423 if (dpyinfo->x_focus_event_frame != frame)
3425 x_new_focus_frame (dpyinfo, frame);
3426 dpyinfo->x_focus_event_frame = frame;
3428 /* Don't stop displaying the initial startup message
3429 for a switch-frame event we don't need. */
3430 /* When run as a daemon, Vterminal_frame is always NIL. */
3431 bufp->arg = (((NILP (Vterminal_frame) || EQ (Fdaemonp (), Qt))
3432 && CONSP (Vframe_list)
3433 && !NILP (XCDR (Vframe_list)))
3434 ? Qt : Qnil);
3435 bufp->kind = FOCUS_IN_EVENT;
3436 XSETFRAME (bufp->frame_or_window, frame);
3439 frame->output_data.x->focus_state |= state;
3441 #ifdef HAVE_X_I18N
3442 if (FRAME_XIC (frame))
3443 XSetICFocus (FRAME_XIC (frame));
3444 #endif
3446 else if (type == FocusOut)
3448 frame->output_data.x->focus_state &= ~state;
3450 if (dpyinfo->x_focus_event_frame == frame)
3452 dpyinfo->x_focus_event_frame = 0;
3453 x_new_focus_frame (dpyinfo, 0);
3455 bufp->kind = FOCUS_OUT_EVENT;
3456 XSETFRAME (bufp->frame_or_window, frame);
3459 #ifdef HAVE_X_I18N
3460 if (FRAME_XIC (frame))
3461 XUnsetICFocus (FRAME_XIC (frame));
3462 #endif
3463 if (frame->pointer_invisible)
3464 XTtoggle_invisible_pointer (frame, 0);
3468 /* The focus may have changed. Figure out if it is a real focus change,
3469 by checking both FocusIn/Out and Enter/LeaveNotify events.
3471 Returns FOCUS_IN_EVENT event in *BUFP. */
3473 static void
3474 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3476 struct frame *frame;
3478 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3479 if (! frame)
3480 return;
3482 switch (event->type)
3484 case EnterNotify:
3485 case LeaveNotify:
3487 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3488 int focus_state
3489 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3491 if (event->xcrossing.detail != NotifyInferior
3492 && event->xcrossing.focus
3493 && ! (focus_state & FOCUS_EXPLICIT))
3494 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3495 FOCUS_IMPLICIT,
3496 dpyinfo, frame, bufp);
3498 break;
3500 case FocusIn:
3501 case FocusOut:
3502 x_focus_changed (event->type,
3503 (event->xfocus.detail == NotifyPointer ?
3504 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3505 dpyinfo, frame, bufp);
3506 break;
3508 case ClientMessage:
3509 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3511 enum xembed_message msg = event->xclient.data.l[1];
3512 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3513 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3515 break;
3520 #if defined HAVE_MENUS && !defined USE_X_TOOLKIT && !defined USE_GTK
3521 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3523 void
3524 x_mouse_leave (struct x_display_info *dpyinfo)
3526 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3528 #endif
3530 /* The focus has changed, or we have redirected a frame's focus to
3531 another frame (this happens when a frame uses a surrogate
3532 mini-buffer frame). Shift the highlight as appropriate.
3534 The FRAME argument doesn't necessarily have anything to do with which
3535 frame is being highlighted or un-highlighted; we only use it to find
3536 the appropriate X display info. */
3538 static void
3539 XTframe_rehighlight (struct frame *frame)
3541 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3544 static void
3545 x_frame_rehighlight (struct x_display_info *dpyinfo)
3547 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3549 if (dpyinfo->x_focus_frame)
3551 dpyinfo->x_highlight_frame
3552 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3553 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3554 : dpyinfo->x_focus_frame);
3555 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3557 fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
3558 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3561 else
3562 dpyinfo->x_highlight_frame = 0;
3564 if (dpyinfo->x_highlight_frame != old_highlight)
3566 if (old_highlight)
3567 frame_unhighlight (old_highlight);
3568 if (dpyinfo->x_highlight_frame)
3569 frame_highlight (dpyinfo->x_highlight_frame);
3575 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3577 /* Initialize mode_switch_bit and modifier_meaning. */
3578 static void
3579 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3581 int min_code, max_code;
3582 KeySym *syms;
3583 int syms_per_code;
3584 XModifierKeymap *mods;
3586 dpyinfo->meta_mod_mask = 0;
3587 dpyinfo->shift_lock_mask = 0;
3588 dpyinfo->alt_mod_mask = 0;
3589 dpyinfo->super_mod_mask = 0;
3590 dpyinfo->hyper_mod_mask = 0;
3592 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3594 syms = XGetKeyboardMapping (dpyinfo->display,
3595 min_code, max_code - min_code + 1,
3596 &syms_per_code);
3597 mods = XGetModifierMapping (dpyinfo->display);
3599 /* Scan the modifier table to see which modifier bits the Meta and
3600 Alt keysyms are on. */
3602 int row, col; /* The row and column in the modifier table. */
3603 int found_alt_or_meta;
3605 for (row = 3; row < 8; row++)
3607 found_alt_or_meta = 0;
3608 for (col = 0; col < mods->max_keypermod; col++)
3610 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3612 /* Zeroes are used for filler. Skip them. */
3613 if (code == 0)
3614 continue;
3616 /* Are any of this keycode's keysyms a meta key? */
3618 int code_col;
3620 for (code_col = 0; code_col < syms_per_code; code_col++)
3622 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3624 switch (sym)
3626 case XK_Meta_L:
3627 case XK_Meta_R:
3628 found_alt_or_meta = 1;
3629 dpyinfo->meta_mod_mask |= (1 << row);
3630 break;
3632 case XK_Alt_L:
3633 case XK_Alt_R:
3634 found_alt_or_meta = 1;
3635 dpyinfo->alt_mod_mask |= (1 << row);
3636 break;
3638 case XK_Hyper_L:
3639 case XK_Hyper_R:
3640 if (!found_alt_or_meta)
3641 dpyinfo->hyper_mod_mask |= (1 << row);
3642 code_col = syms_per_code;
3643 col = mods->max_keypermod;
3644 break;
3646 case XK_Super_L:
3647 case XK_Super_R:
3648 if (!found_alt_or_meta)
3649 dpyinfo->super_mod_mask |= (1 << row);
3650 code_col = syms_per_code;
3651 col = mods->max_keypermod;
3652 break;
3654 case XK_Shift_Lock:
3655 /* Ignore this if it's not on the lock modifier. */
3656 if (!found_alt_or_meta && ((1 << row) == LockMask))
3657 dpyinfo->shift_lock_mask = LockMask;
3658 code_col = syms_per_code;
3659 col = mods->max_keypermod;
3660 break;
3668 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3669 if (! dpyinfo->meta_mod_mask)
3671 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3672 dpyinfo->alt_mod_mask = 0;
3675 /* If some keys are both alt and meta,
3676 make them just meta, not alt. */
3677 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3679 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3682 XFree (syms);
3683 XFreeModifiermap (mods);
3686 /* Convert between the modifier bits X uses and the modifier bits
3687 Emacs uses. */
3690 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
3692 int mod_meta = meta_modifier;
3693 int mod_alt = alt_modifier;
3694 int mod_hyper = hyper_modifier;
3695 int mod_super = super_modifier;
3696 Lisp_Object tem;
3698 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3699 if (INTEGERP (tem)) mod_alt = XINT (tem) & INT_MAX;
3700 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3701 if (INTEGERP (tem)) mod_meta = XINT (tem) & INT_MAX;
3702 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3703 if (INTEGERP (tem)) mod_hyper = XINT (tem) & INT_MAX;
3704 tem = Fget (Vx_super_keysym, Qmodifier_value);
3705 if (INTEGERP (tem)) mod_super = XINT (tem) & INT_MAX;
3707 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3708 | ((state & ControlMask) ? ctrl_modifier : 0)
3709 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3710 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3711 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3712 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3715 static int
3716 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
3718 EMACS_INT mod_meta = meta_modifier;
3719 EMACS_INT mod_alt = alt_modifier;
3720 EMACS_INT mod_hyper = hyper_modifier;
3721 EMACS_INT mod_super = super_modifier;
3723 Lisp_Object tem;
3725 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3726 if (INTEGERP (tem)) mod_alt = XINT (tem);
3727 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3728 if (INTEGERP (tem)) mod_meta = XINT (tem);
3729 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3730 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3731 tem = Fget (Vx_super_keysym, Qmodifier_value);
3732 if (INTEGERP (tem)) mod_super = XINT (tem);
3735 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3736 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3737 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3738 | ((state & shift_modifier) ? ShiftMask : 0)
3739 | ((state & ctrl_modifier) ? ControlMask : 0)
3740 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3743 /* Convert a keysym to its name. */
3745 char *
3746 x_get_keysym_name (int keysym)
3748 char *value;
3750 block_input ();
3751 value = XKeysymToString (keysym);
3752 unblock_input ();
3754 return value;
3759 /* Mouse clicks and mouse movement. Rah. */
3761 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3763 If the event is a button press, then note that we have grabbed
3764 the mouse. */
3766 static Lisp_Object
3767 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3769 /* Make the event type NO_EVENT; we'll change that when we decide
3770 otherwise. */
3771 result->kind = MOUSE_CLICK_EVENT;
3772 result->code = event->button - Button1;
3773 result->timestamp = event->time;
3774 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3775 event->state)
3776 | (event->type == ButtonRelease
3777 ? up_modifier
3778 : down_modifier));
3780 XSETINT (result->x, event->x);
3781 XSETINT (result->y, event->y);
3782 XSETFRAME (result->frame_or_window, f);
3783 result->arg = Qnil;
3784 return Qnil;
3788 /* Function to report a mouse movement to the mainstream Emacs code.
3789 The input handler calls this.
3791 We have received a mouse movement event, which is given in *event.
3792 If the mouse is over a different glyph than it was last time, tell
3793 the mainstream emacs code by setting mouse_moved. If not, ask for
3794 another motion event, so we can check again the next time it moves. */
3796 static XMotionEvent last_mouse_motion_event;
3797 static Lisp_Object last_mouse_motion_frame;
3799 static int
3800 note_mouse_movement (struct frame *frame, XMotionEvent *event)
3802 last_mouse_movement_time = event->time;
3803 last_mouse_motion_event = *event;
3804 XSETFRAME (last_mouse_motion_frame, frame);
3806 if (!FRAME_X_OUTPUT (frame))
3807 return 0;
3809 if (event->window != FRAME_X_WINDOW (frame))
3811 frame->mouse_moved = 1;
3812 last_mouse_scroll_bar = Qnil;
3813 note_mouse_highlight (frame, -1, -1);
3814 last_mouse_glyph_frame = 0;
3815 return 1;
3819 /* Has the mouse moved off the glyph it was on at the last sighting? */
3820 if (frame != last_mouse_glyph_frame
3821 || event->x < last_mouse_glyph.x
3822 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3823 || event->y < last_mouse_glyph.y
3824 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3826 frame->mouse_moved = 1;
3827 last_mouse_scroll_bar = Qnil;
3828 note_mouse_highlight (frame, event->x, event->y);
3829 /* Remember which glyph we're now on. */
3830 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3831 last_mouse_glyph_frame = frame;
3832 return 1;
3835 return 0;
3839 /************************************************************************
3840 Mouse Face
3841 ************************************************************************/
3843 static void
3844 redo_mouse_highlight (void)
3846 if (!NILP (last_mouse_motion_frame)
3847 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3848 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3849 last_mouse_motion_event.x,
3850 last_mouse_motion_event.y);
3855 /* Return the current position of the mouse.
3856 *FP should be a frame which indicates which display to ask about.
3858 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3859 and *PART to the frame, window, and scroll bar part that the mouse
3860 is over. Set *X and *Y to the portion and whole of the mouse's
3861 position on the scroll bar.
3863 If the mouse movement started elsewhere, set *FP to the frame the
3864 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3865 the mouse is over.
3867 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
3868 was at this position.
3870 Don't store anything if we don't have a valid set of values to report.
3872 This clears the mouse_moved flag, so we can wait for the next mouse
3873 movement. */
3875 static void
3876 XTmouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
3877 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
3878 Time *timestamp)
3880 struct frame *f1;
3882 block_input ();
3884 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3885 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
3886 else
3888 Window root;
3889 int root_x, root_y;
3891 Window dummy_window;
3892 int dummy;
3894 Lisp_Object frame, tail;
3896 /* Clear the mouse-moved flag for every frame on this display. */
3897 FOR_EACH_FRAME (tail, frame)
3898 if (FRAME_X_P (XFRAME (frame))
3899 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3900 XFRAME (frame)->mouse_moved = 0;
3902 last_mouse_scroll_bar = Qnil;
3904 /* Figure out which root window we're on. */
3905 XQueryPointer (FRAME_X_DISPLAY (*fp),
3906 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3908 /* The root window which contains the pointer. */
3909 &root,
3911 /* Trash which we can't trust if the pointer is on
3912 a different screen. */
3913 &dummy_window,
3915 /* The position on that root window. */
3916 &root_x, &root_y,
3918 /* More trash we can't trust. */
3919 &dummy, &dummy,
3921 /* Modifier keys and pointer buttons, about which
3922 we don't care. */
3923 (unsigned int *) &dummy);
3925 /* Now we have a position on the root; find the innermost window
3926 containing the pointer. */
3928 Window win, child;
3929 int win_x, win_y;
3930 int parent_x = 0, parent_y = 0;
3932 win = root;
3934 /* XTranslateCoordinates can get errors if the window
3935 structure is changing at the same time this function
3936 is running. So at least we must not crash from them. */
3938 x_catch_errors (FRAME_X_DISPLAY (*fp));
3940 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3941 && FRAME_LIVE_P (last_mouse_frame))
3943 /* If mouse was grabbed on a frame, give coords for that frame
3944 even if the mouse is now outside it. */
3945 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3947 /* From-window, to-window. */
3948 root, FRAME_X_WINDOW (last_mouse_frame),
3950 /* From-position, to-position. */
3951 root_x, root_y, &win_x, &win_y,
3953 /* Child of win. */
3954 &child);
3955 f1 = last_mouse_frame;
3957 else
3959 while (1)
3961 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3963 /* From-window, to-window. */
3964 root, win,
3966 /* From-position, to-position. */
3967 root_x, root_y, &win_x, &win_y,
3969 /* Child of win. */
3970 &child);
3972 if (child == None || child == win)
3973 break;
3974 #ifdef USE_GTK
3975 /* We don't wan't to know the innermost window. We
3976 want the edit window. For non-Gtk+ the innermost
3977 window is the edit window. For Gtk+ it might not
3978 be. It might be the tool bar for example. */
3979 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3980 break;
3981 #endif
3982 win = child;
3983 parent_x = win_x;
3984 parent_y = win_y;
3987 /* Now we know that:
3988 win is the innermost window containing the pointer
3989 (XTC says it has no child containing the pointer),
3990 win_x and win_y are the pointer's position in it
3991 (XTC did this the last time through), and
3992 parent_x and parent_y are the pointer's position in win's parent.
3993 (They are what win_x and win_y were when win was child.
3994 If win is the root window, it has no parent, and
3995 parent_{x,y} are invalid, but that's okay, because we'll
3996 never use them in that case.) */
3998 #ifdef USE_GTK
3999 /* We don't wan't to know the innermost window. We
4000 want the edit window. */
4001 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4002 #else
4003 /* Is win one of our frames? */
4004 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4005 #endif
4007 #ifdef USE_X_TOOLKIT
4008 /* If we end up with the menu bar window, say it's not
4009 on the frame. */
4010 if (f1 != NULL
4011 && f1->output_data.x->menubar_widget
4012 && win == XtWindow (f1->output_data.x->menubar_widget))
4013 f1 = NULL;
4014 #endif /* USE_X_TOOLKIT */
4017 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
4018 f1 = 0;
4020 x_uncatch_errors ();
4022 /* If not, is it one of our scroll bars? */
4023 if (! f1)
4025 struct scroll_bar *bar;
4027 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
4029 if (bar)
4031 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4032 win_x = parent_x;
4033 win_y = parent_y;
4037 if (f1 == 0 && insist > 0)
4038 f1 = SELECTED_FRAME ();
4040 if (f1)
4042 /* Ok, we found a frame. Store all the values.
4043 last_mouse_glyph is a rectangle used to reduce the
4044 generation of mouse events. To not miss any motion
4045 events, we must divide the frame into rectangles of the
4046 size of the smallest character that could be displayed
4047 on it, i.e. into the same rectangles that matrices on
4048 the frame are divided into. */
4050 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
4051 last_mouse_glyph_frame = f1;
4053 *bar_window = Qnil;
4054 *part = 0;
4055 *fp = f1;
4056 XSETINT (*x, win_x);
4057 XSETINT (*y, win_y);
4058 *timestamp = last_mouse_movement_time;
4063 unblock_input ();
4068 /***********************************************************************
4069 Scroll bars
4070 ***********************************************************************/
4072 /* Scroll bar support. */
4074 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4075 manages it.
4076 This can be called in GC, so we have to make sure to strip off mark
4077 bits. */
4079 static struct scroll_bar *
4080 x_window_to_scroll_bar (Display *display, Window window_id)
4082 Lisp_Object tail, frame;
4084 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4085 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4086 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4088 FOR_EACH_FRAME (tail, frame)
4090 Lisp_Object bar, condemned;
4092 if (! FRAME_X_P (XFRAME (frame)))
4093 continue;
4095 /* Scan this frame's scroll bar list for a scroll bar with the
4096 right window ID. */
4097 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4098 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4099 /* This trick allows us to search both the ordinary and
4100 condemned scroll bar lists with one loop. */
4101 ! NILP (bar) || (bar = condemned,
4102 condemned = Qnil,
4103 ! NILP (bar));
4104 bar = XSCROLL_BAR (bar)->next)
4105 if (XSCROLL_BAR (bar)->x_window == window_id &&
4106 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4107 return XSCROLL_BAR (bar);
4110 return NULL;
4114 #if defined USE_LUCID
4116 /* Return the Lucid menu bar WINDOW is part of. Return null
4117 if WINDOW is not part of a menu bar. */
4119 static Widget
4120 x_window_to_menu_bar (Window window)
4122 Lisp_Object tail, frame;
4124 FOR_EACH_FRAME (tail, frame)
4125 if (FRAME_X_P (XFRAME (frame)))
4127 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4129 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4130 return menu_bar;
4132 return NULL;
4135 #endif /* USE_LUCID */
4138 /************************************************************************
4139 Toolkit scroll bars
4140 ************************************************************************/
4142 #ifdef USE_TOOLKIT_SCROLL_BARS
4144 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4145 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4146 static void x_create_toolkit_scroll_bar (struct frame *,
4147 struct scroll_bar *);
4148 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4149 int, int, int);
4152 /* Lisp window being scrolled. Set when starting to interact with
4153 a toolkit scroll bar, reset to nil when ending the interaction. */
4155 static Lisp_Object window_being_scrolled;
4157 /* Last scroll bar part sent in xm_scroll_callback. */
4159 static int last_scroll_bar_part;
4161 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4162 that movements of 1/20 of the screen size are mapped to up/down. */
4164 #ifndef USE_GTK
4165 /* Id of action hook installed for scroll bars. */
4167 static XtActionHookId action_hook_id;
4169 static Boolean xaw3d_arrow_scroll;
4171 /* Whether the drag scrolling maintains the mouse at the top of the
4172 thumb. If not, resizing the thumb needs to be done more carefully
4173 to avoid jerkiness. */
4175 static Boolean xaw3d_pick_top;
4177 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4178 bars are used.. The hook is responsible for detecting when
4179 the user ends an interaction with the scroll bar, and generates
4180 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4182 static void
4183 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4184 XEvent *event, String *params, Cardinal *num_params)
4186 int scroll_bar_p;
4187 const char *end_action;
4189 #ifdef USE_MOTIF
4190 scroll_bar_p = XmIsScrollBar (widget);
4191 end_action = "Release";
4192 #else /* !USE_MOTIF i.e. use Xaw */
4193 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4194 end_action = "EndScroll";
4195 #endif /* USE_MOTIF */
4197 if (scroll_bar_p
4198 && strcmp (action_name, end_action) == 0
4199 && WINDOWP (window_being_scrolled))
4201 struct window *w;
4203 x_send_scroll_bar_event (window_being_scrolled,
4204 scroll_bar_end_scroll, 0, 0);
4205 w = XWINDOW (window_being_scrolled);
4207 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4209 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4210 /* The thumb size is incorrect while dragging: fix it. */
4211 set_vertical_scroll_bar (w);
4213 window_being_scrolled = Qnil;
4214 last_scroll_bar_part = -1;
4216 /* Xt timeouts no longer needed. */
4217 toolkit_scroll_bar_interaction = 0;
4220 #endif /* not USE_GTK */
4222 /* A vector of windows used for communication between
4223 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4225 static struct window **scroll_bar_windows;
4226 static ptrdiff_t scroll_bar_windows_size;
4229 /* Send a client message with message type Xatom_Scrollbar for a
4230 scroll action to the frame of WINDOW. PART is a value identifying
4231 the part of the scroll bar that was clicked on. PORTION is the
4232 amount to scroll of a whole of WHOLE. */
4234 static void
4235 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4237 XEvent event;
4238 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4239 struct window *w = XWINDOW (window);
4240 struct frame *f = XFRAME (w->frame);
4241 ptrdiff_t i;
4243 block_input ();
4245 /* Construct a ClientMessage event to send to the frame. */
4246 ev->type = ClientMessage;
4247 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4248 ev->display = FRAME_X_DISPLAY (f);
4249 ev->window = FRAME_X_WINDOW (f);
4250 ev->format = 32;
4252 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4253 not enough to store a pointer or Lisp_Object on a 64 bit system.
4254 So, store the window in scroll_bar_windows and pass the index
4255 into that array in the event. */
4256 for (i = 0; i < scroll_bar_windows_size; ++i)
4257 if (scroll_bar_windows[i] == NULL)
4258 break;
4260 if (i == scroll_bar_windows_size)
4262 ptrdiff_t old_nbytes =
4263 scroll_bar_windows_size * sizeof *scroll_bar_windows;
4264 ptrdiff_t nbytes;
4265 enum { XClientMessageEvent_MAX = 0x7fffffff };
4266 scroll_bar_windows =
4267 xpalloc (scroll_bar_windows, &scroll_bar_windows_size, 1,
4268 XClientMessageEvent_MAX, sizeof *scroll_bar_windows);
4269 nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4270 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4273 scroll_bar_windows[i] = w;
4274 ev->data.l[0] = (long) i;
4275 ev->data.l[1] = (long) part;
4276 ev->data.l[2] = (long) 0;
4277 ev->data.l[3] = (long) portion;
4278 ev->data.l[4] = (long) whole;
4280 /* Make Xt timeouts work while the scroll bar is active. */
4281 #ifdef USE_X_TOOLKIT
4282 toolkit_scroll_bar_interaction = 1;
4283 x_activate_timeout_atimer ();
4284 #endif
4286 /* Setting the event mask to zero means that the message will
4287 be sent to the client that created the window, and if that
4288 window no longer exists, no event will be sent. */
4289 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4290 unblock_input ();
4294 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4295 in *IEVENT. */
4297 static void
4298 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4300 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4301 Lisp_Object window;
4302 struct window *w;
4304 w = scroll_bar_windows[ev->data.l[0]];
4305 scroll_bar_windows[ev->data.l[0]] = NULL;
4307 XSETWINDOW (window, w);
4309 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4310 ievent->frame_or_window = window;
4311 ievent->arg = Qnil;
4312 #ifdef USE_GTK
4313 ievent->timestamp = CurrentTime;
4314 #else
4315 ievent->timestamp =
4316 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
4317 #endif
4318 ievent->part = ev->data.l[1];
4319 ievent->code = ev->data.l[2];
4320 ievent->x = make_number ((int) ev->data.l[3]);
4321 ievent->y = make_number ((int) ev->data.l[4]);
4322 ievent->modifiers = 0;
4326 #ifdef USE_MOTIF
4328 /* Minimum and maximum values used for Motif scroll bars. */
4330 #define XM_SB_MAX 10000000
4333 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4334 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4335 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4337 static void
4338 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4340 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4341 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4342 int part = -1, whole = 0, portion = 0;
4344 switch (cs->reason)
4346 case XmCR_DECREMENT:
4347 bar->dragging = Qnil;
4348 part = scroll_bar_up_arrow;
4349 break;
4351 case XmCR_INCREMENT:
4352 bar->dragging = Qnil;
4353 part = scroll_bar_down_arrow;
4354 break;
4356 case XmCR_PAGE_DECREMENT:
4357 bar->dragging = Qnil;
4358 part = scroll_bar_above_handle;
4359 break;
4361 case XmCR_PAGE_INCREMENT:
4362 bar->dragging = Qnil;
4363 part = scroll_bar_below_handle;
4364 break;
4366 case XmCR_TO_TOP:
4367 bar->dragging = Qnil;
4368 part = scroll_bar_to_top;
4369 break;
4371 case XmCR_TO_BOTTOM:
4372 bar->dragging = Qnil;
4373 part = scroll_bar_to_bottom;
4374 break;
4376 case XmCR_DRAG:
4378 int slider_size;
4380 /* Get the slider size. */
4381 block_input ();
4382 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4383 unblock_input ();
4385 whole = XM_SB_MAX - slider_size;
4386 portion = min (cs->value, whole);
4387 part = scroll_bar_handle;
4388 bar->dragging = make_number (cs->value);
4390 break;
4392 case XmCR_VALUE_CHANGED:
4393 break;
4396 if (part >= 0)
4398 window_being_scrolled = bar->window;
4399 last_scroll_bar_part = part;
4400 x_send_scroll_bar_event (bar->window, part, portion, whole);
4404 #elif defined USE_GTK
4406 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4407 bar widget. DATA is a pointer to the scroll_bar structure. */
4409 static gboolean
4410 xg_scroll_callback (GtkRange *range,
4411 GtkScrollType scroll,
4412 gdouble value,
4413 gpointer user_data)
4415 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4416 gdouble position;
4417 int part = -1, whole = 0, portion = 0;
4418 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4419 struct frame *f = (struct frame *) g_object_get_data (G_OBJECT (range),
4420 XG_FRAME_DATA);
4422 if (xg_ignore_gtk_scrollbar) return FALSE;
4423 position = gtk_adjustment_get_value (adj);
4426 switch (scroll)
4428 case GTK_SCROLL_JUMP:
4429 /* Buttons 1 2 or 3 must be grabbed. */
4430 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4431 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4433 part = scroll_bar_handle;
4434 whole = gtk_adjustment_get_upper (adj) -
4435 gtk_adjustment_get_page_size (adj);
4436 portion = min ((int)position, whole);
4437 bar->dragging = make_number ((int)portion);
4439 break;
4440 case GTK_SCROLL_STEP_BACKWARD:
4441 part = scroll_bar_up_arrow;
4442 bar->dragging = Qnil;
4443 break;
4444 case GTK_SCROLL_STEP_FORWARD:
4445 part = scroll_bar_down_arrow;
4446 bar->dragging = Qnil;
4447 break;
4448 case GTK_SCROLL_PAGE_BACKWARD:
4449 part = scroll_bar_above_handle;
4450 bar->dragging = Qnil;
4451 break;
4452 case GTK_SCROLL_PAGE_FORWARD:
4453 part = scroll_bar_below_handle;
4454 bar->dragging = Qnil;
4455 break;
4458 if (part >= 0)
4460 window_being_scrolled = bar->window;
4461 last_scroll_bar_part = part;
4462 x_send_scroll_bar_event (bar->window, part, portion, whole);
4465 return FALSE;
4468 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4470 static gboolean
4471 xg_end_scroll_callback (GtkWidget *widget,
4472 GdkEventButton *event,
4473 gpointer user_data)
4475 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4476 bar->dragging = Qnil;
4477 if (WINDOWP (window_being_scrolled))
4479 x_send_scroll_bar_event (window_being_scrolled,
4480 scroll_bar_end_scroll, 0, 0);
4481 window_being_scrolled = Qnil;
4484 return FALSE;
4488 #else /* not USE_GTK and not USE_MOTIF */
4490 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4491 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4492 scroll bar struct. CALL_DATA is a pointer to a float saying where
4493 the thumb is. */
4495 static void
4496 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4498 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4499 float top = *(float *) call_data;
4500 float shown;
4501 int whole, portion, height;
4502 int part;
4504 /* Get the size of the thumb, a value between 0 and 1. */
4505 block_input ();
4506 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4507 unblock_input ();
4509 whole = 10000000;
4510 portion = shown < 1 ? top * whole : 0;
4512 if (shown < 1 && (eabs (top + shown - 1) < 1.0f / height))
4513 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4514 the bottom, so we force the scrolling whenever we see that we're
4515 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4516 we try to ensure that we always stay two pixels away from the
4517 bottom). */
4518 part = scroll_bar_down_arrow;
4519 else
4520 part = scroll_bar_handle;
4522 window_being_scrolled = bar->window;
4523 bar->dragging = make_number (portion);
4524 last_scroll_bar_part = part;
4525 x_send_scroll_bar_event (bar->window, part, portion, whole);
4529 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4530 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4531 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4532 the scroll bar. CALL_DATA is an integer specifying the action that
4533 has taken place. Its magnitude is in the range 0..height of the
4534 scroll bar. Negative values mean scroll towards buffer start.
4535 Values < height of scroll bar mean line-wise movement. */
4537 static void
4538 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4540 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4541 /* The position really is stored cast to a pointer. */
4542 int position = (long) call_data;
4543 Dimension height;
4544 int part;
4546 /* Get the height of the scroll bar. */
4547 block_input ();
4548 XtVaGetValues (widget, XtNheight, &height, NULL);
4549 unblock_input ();
4551 if (eabs (position) >= height)
4552 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4554 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4555 it maps line-movement to call_data = max(5, height/20). */
4556 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4557 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4558 else
4559 part = scroll_bar_move_ratio;
4561 window_being_scrolled = bar->window;
4562 bar->dragging = Qnil;
4563 last_scroll_bar_part = part;
4564 x_send_scroll_bar_event (bar->window, part, position, height);
4567 #endif /* not USE_GTK and not USE_MOTIF */
4569 #define SCROLL_BAR_NAME "verticalScrollBar"
4571 /* Create the widget for scroll bar BAR on frame F. Record the widget
4572 and X window of the scroll bar in BAR. */
4574 #ifdef USE_GTK
4575 static void
4576 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4578 const char *scroll_bar_name = SCROLL_BAR_NAME;
4580 block_input ();
4581 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4582 G_CALLBACK (xg_end_scroll_callback),
4583 scroll_bar_name);
4584 unblock_input ();
4587 #else /* not USE_GTK */
4589 static void
4590 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4592 Window xwindow;
4593 Widget widget;
4594 Arg av[20];
4595 int ac = 0;
4596 const char *scroll_bar_name = SCROLL_BAR_NAME;
4597 unsigned long pixel;
4599 block_input ();
4601 #ifdef USE_MOTIF
4602 /* Set resources. Create the widget. */
4603 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4604 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4605 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4606 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4607 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4608 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4609 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4611 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4612 if (pixel != -1)
4614 XtSetArg (av[ac], XmNforeground, pixel);
4615 ++ac;
4618 pixel = f->output_data.x->scroll_bar_background_pixel;
4619 if (pixel != -1)
4621 XtSetArg (av[ac], XmNbackground, pixel);
4622 ++ac;
4625 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4626 (char *) scroll_bar_name, av, ac);
4628 /* Add one callback for everything that can happen. */
4629 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4630 (XtPointer) bar);
4631 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4632 (XtPointer) bar);
4633 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4634 (XtPointer) bar);
4635 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4636 (XtPointer) bar);
4637 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4638 (XtPointer) bar);
4639 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4640 (XtPointer) bar);
4641 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4642 (XtPointer) bar);
4644 /* Realize the widget. Only after that is the X window created. */
4645 XtRealizeWidget (widget);
4647 /* Set the cursor to an arrow. I didn't find a resource to do that.
4648 And I'm wondering why it hasn't an arrow cursor by default. */
4649 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4650 f->output_data.x->nontext_cursor);
4652 #else /* !USE_MOTIF i.e. use Xaw */
4654 /* Set resources. Create the widget. The background of the
4655 Xaw3d scroll bar widget is a little bit light for my taste.
4656 We don't alter it here to let users change it according
4657 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4658 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4659 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4660 /* For smoother scrolling with Xaw3d -sm */
4661 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4663 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4664 if (pixel != -1)
4666 XtSetArg (av[ac], XtNforeground, pixel);
4667 ++ac;
4670 pixel = f->output_data.x->scroll_bar_background_pixel;
4671 if (pixel != -1)
4673 XtSetArg (av[ac], XtNbackground, pixel);
4674 ++ac;
4677 /* Top/bottom shadow colors. */
4679 /* Allocate them, if necessary. */
4680 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4682 pixel = f->output_data.x->scroll_bar_background_pixel;
4683 if (pixel != -1)
4685 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4686 FRAME_X_COLORMAP (f),
4687 &pixel, 1.2, 0x8000))
4688 pixel = -1;
4689 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4692 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4694 pixel = f->output_data.x->scroll_bar_background_pixel;
4695 if (pixel != -1)
4697 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4698 FRAME_X_COLORMAP (f),
4699 &pixel, 0.6, 0x4000))
4700 pixel = -1;
4701 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4705 #ifdef XtNbeNiceToColormap
4706 /* Tell the toolkit about them. */
4707 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4708 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4709 /* We tried to allocate a color for the top/bottom shadow, and
4710 failed, so tell Xaw3d to use dithering instead. */
4711 /* But only if we have a small colormap. Xaw3d can allocate nice
4712 colors itself. */
4714 XtSetArg (av[ac], XtNbeNiceToColormap,
4715 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4716 ++ac;
4718 else
4719 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4720 be more consistent with other emacs 3d colors, and since Xaw3d is
4721 not good at dealing with allocation failure. */
4723 /* This tells Xaw3d to use real colors instead of dithering for
4724 the shadows. */
4725 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4726 ++ac;
4728 /* Specify the colors. */
4729 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4730 if (pixel != -1)
4732 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4733 ++ac;
4735 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4736 if (pixel != -1)
4738 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4739 ++ac;
4742 #endif
4744 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4745 f->output_data.x->edit_widget, av, ac);
4748 char const *initial = "";
4749 char const *val = initial;
4750 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4751 #ifdef XtNarrowScrollbars
4752 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4753 #endif
4754 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4755 if (xaw3d_arrow_scroll || val == initial)
4756 { /* ARROW_SCROLL */
4757 xaw3d_arrow_scroll = True;
4758 /* Isn't that just a personal preference ? --Stef */
4759 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4763 /* Define callbacks. */
4764 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4765 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4766 (XtPointer) bar);
4768 /* Realize the widget. Only after that is the X window created. */
4769 XtRealizeWidget (widget);
4771 #endif /* !USE_MOTIF */
4773 /* Install an action hook that lets us detect when the user
4774 finishes interacting with a scroll bar. */
4775 if (action_hook_id == 0)
4776 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4778 /* Remember X window and widget in the scroll bar vector. */
4779 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4780 xwindow = XtWindow (widget);
4781 bar->x_window = xwindow;
4783 unblock_input ();
4785 #endif /* not USE_GTK */
4788 /* Set the thumb size and position of scroll bar BAR. We are currently
4789 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4791 #ifdef USE_GTK
4792 static void
4793 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4795 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4798 #else /* not USE_GTK */
4799 static void
4800 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4801 int whole)
4803 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4804 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4805 float top, shown;
4807 block_input ();
4809 #ifdef USE_MOTIF
4811 if (scroll_bar_adjust_thumb_portion_p)
4813 /* We use an estimate of 30 chars per line rather than the real
4814 `portion' value. This has the disadvantage that the thumb size
4815 is not very representative, but it makes our life a lot easier.
4816 Otherwise, we have to constantly adjust the thumb size, which
4817 we can't always do quickly enough: while dragging, the size of
4818 the thumb might prevent the user from dragging the thumb all the
4819 way to the end. but Motif and some versions of Xaw3d don't allow
4820 updating the thumb size while dragging. Also, even if we can update
4821 its size, the update will often happen too late.
4822 If you don't believe it, check out revision 1.650 of xterm.c to see
4823 what hoops we were going through and the still poor behavior we got. */
4824 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4825 /* When the thumb is at the bottom, position == whole.
4826 So we need to increase `whole' to make space for the thumb. */
4827 whole += portion;
4830 if (whole <= 0)
4831 top = 0, shown = 1;
4832 else
4834 top = (float) position / whole;
4835 shown = (float) portion / whole;
4838 if (NILP (bar->dragging))
4840 int size, value;
4842 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4843 is the scroll bar's maximum and MIN is the scroll bar's minimum
4844 value. */
4845 size = clip_to_bounds (1, shown * XM_SB_MAX, XM_SB_MAX);
4847 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4848 value = top * XM_SB_MAX;
4849 value = min (value, XM_SB_MAX - size);
4851 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4853 #else /* !USE_MOTIF i.e. use Xaw */
4855 if (whole == 0)
4856 top = 0, shown = 1;
4857 else
4859 top = (float) position / whole;
4860 shown = (float) portion / whole;
4864 float old_top, old_shown;
4865 Dimension height;
4866 XtVaGetValues (widget,
4867 XtNtopOfThumb, &old_top,
4868 XtNshown, &old_shown,
4869 XtNheight, &height,
4870 NULL);
4872 /* Massage the top+shown values. */
4873 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4874 top = max (0, min (1, top));
4875 else
4876 top = old_top;
4877 /* Keep two pixels available for moving the thumb down. */
4878 shown = max (0, min (1 - top - (2.0f / height), shown));
4880 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4881 check that your system's configuration file contains a define
4882 for `NARROWPROTO'. See s/freebsd.h for an example. */
4883 if (top != old_top || shown != old_shown)
4885 if (NILP (bar->dragging))
4886 XawScrollbarSetThumb (widget, top, shown);
4887 else
4889 /* Try to make the scrolling a tad smoother. */
4890 if (!xaw3d_pick_top)
4891 shown = min (shown, old_shown);
4893 XawScrollbarSetThumb (widget, top, shown);
4897 #endif /* !USE_MOTIF */
4899 unblock_input ();
4901 #endif /* not USE_GTK */
4903 #endif /* USE_TOOLKIT_SCROLL_BARS */
4907 /************************************************************************
4908 Scroll bars, general
4909 ************************************************************************/
4911 /* Create a scroll bar and return the scroll bar vector for it. W is
4912 the Emacs window on which to create the scroll bar. TOP, LEFT,
4913 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4914 scroll bar. */
4916 static struct scroll_bar *
4917 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4919 struct frame *f = XFRAME (w->frame);
4920 struct scroll_bar *bar
4921 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4922 Lisp_Object barobj;
4924 block_input ();
4926 #ifdef USE_TOOLKIT_SCROLL_BARS
4927 x_create_toolkit_scroll_bar (f, bar);
4928 #else /* not USE_TOOLKIT_SCROLL_BARS */
4930 XSetWindowAttributes a;
4931 unsigned long mask;
4932 Window window;
4934 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4935 if (a.background_pixel == -1)
4936 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4938 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4939 | ButtonMotionMask | PointerMotionHintMask
4940 | ExposureMask);
4941 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4943 mask = (CWBackPixel | CWEventMask | CWCursor);
4945 /* Clear the area of W that will serve as a scroll bar. This is
4946 for the case that a window has been split horizontally. In
4947 this case, no clear_frame is generated to reduce flickering. */
4948 if (width > 0 && height > 0)
4949 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4950 left, top, width,
4951 window_box_height (w), False);
4953 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4954 /* Position and size of scroll bar. */
4955 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4956 top,
4957 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4958 height,
4959 /* Border width, depth, class, and visual. */
4961 CopyFromParent,
4962 CopyFromParent,
4963 CopyFromParent,
4964 /* Attributes. */
4965 mask, &a);
4966 bar->x_window = window;
4968 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4970 XSETWINDOW (bar->window, w);
4971 bar->top = top;
4972 bar->left = left;
4973 bar->width = width;
4974 bar->height = height;
4975 bar->start = 0;
4976 bar->end = 0;
4977 bar->dragging = Qnil;
4978 bar->fringe_extended_p = 0;
4980 /* Add bar to its frame's list of scroll bars. */
4981 bar->next = FRAME_SCROLL_BARS (f);
4982 bar->prev = Qnil;
4983 XSETVECTOR (barobj, bar);
4984 fset_scroll_bars (f, barobj);
4985 if (!NILP (bar->next))
4986 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4988 /* Map the window/widget. */
4989 #ifdef USE_TOOLKIT_SCROLL_BARS
4991 #ifdef USE_GTK
4992 xg_update_scrollbar_pos (f,
4993 bar->x_window,
4994 top,
4995 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4996 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4997 max (height, 1));
4998 #else /* not USE_GTK */
4999 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
5000 XtConfigureWidget (scroll_bar,
5001 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5002 top,
5003 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5004 max (height, 1), 0);
5005 XtMapWidget (scroll_bar);
5006 #endif /* not USE_GTK */
5008 #else /* not USE_TOOLKIT_SCROLL_BARS */
5009 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
5010 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5012 unblock_input ();
5013 return bar;
5017 #ifndef USE_TOOLKIT_SCROLL_BARS
5019 /* Draw BAR's handle in the proper position.
5021 If the handle is already drawn from START to END, don't bother
5022 redrawing it, unless REBUILD is non-zero; in that case, always
5023 redraw it. (REBUILD is handy for drawing the handle after expose
5024 events.)
5026 Normally, we want to constrain the start and end of the handle to
5027 fit inside its rectangle, but if the user is dragging the scroll
5028 bar handle, we want to let them drag it down all the way, so that
5029 the bar's top is as far down as it goes; otherwise, there's no way
5030 to move to the very end of the buffer. */
5032 static void
5033 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
5035 int dragging = ! NILP (bar->dragging);
5036 Window w = bar->x_window;
5037 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5038 GC gc = f->output_data.x->normal_gc;
5040 /* If the display is already accurate, do nothing. */
5041 if (! rebuild
5042 && start == bar->start
5043 && end == bar->end)
5044 return;
5046 block_input ();
5049 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5050 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5051 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5053 /* Make sure the values are reasonable, and try to preserve
5054 the distance between start and end. */
5056 int length = end - start;
5058 if (start < 0)
5059 start = 0;
5060 else if (start > top_range)
5061 start = top_range;
5062 end = start + length;
5064 if (end < start)
5065 end = start;
5066 else if (end > top_range && ! dragging)
5067 end = top_range;
5070 /* Store the adjusted setting in the scroll bar. */
5071 bar->start = start;
5072 bar->end = end;
5074 /* Clip the end position, just for display. */
5075 if (end > top_range)
5076 end = top_range;
5078 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5079 below top positions, to make sure the handle is always at least
5080 that many pixels tall. */
5081 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5083 /* Draw the empty space above the handle. Note that we can't clear
5084 zero-height areas; that means "clear to end of window." */
5085 if (start > 0)
5086 x_clear_area (FRAME_X_DISPLAY (f), w,
5087 /* x, y, width, height, and exposures. */
5088 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5089 VERTICAL_SCROLL_BAR_TOP_BORDER,
5090 inside_width, start,
5091 False);
5093 /* Change to proper foreground color if one is specified. */
5094 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5095 XSetForeground (FRAME_X_DISPLAY (f), gc,
5096 f->output_data.x->scroll_bar_foreground_pixel);
5098 /* Draw the handle itself. */
5099 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5100 /* x, y, width, height */
5101 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5102 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5103 inside_width, end - start);
5105 /* Restore the foreground color of the GC if we changed it above. */
5106 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5107 XSetForeground (FRAME_X_DISPLAY (f), gc,
5108 FRAME_FOREGROUND_PIXEL (f));
5110 /* Draw the empty space below the handle. Note that we can't
5111 clear zero-height areas; that means "clear to end of window." */
5112 if (end < inside_height)
5113 x_clear_area (FRAME_X_DISPLAY (f), w,
5114 /* x, y, width, height, and exposures. */
5115 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5116 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5117 inside_width, inside_height - end,
5118 False);
5122 unblock_input ();
5125 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5127 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5128 nil. */
5130 static void
5131 x_scroll_bar_remove (struct scroll_bar *bar)
5133 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5134 block_input ();
5136 #ifdef USE_TOOLKIT_SCROLL_BARS
5137 #ifdef USE_GTK
5138 xg_remove_scroll_bar (f, bar->x_window);
5139 #else /* not USE_GTK */
5140 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5141 #endif /* not USE_GTK */
5142 #else
5143 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5144 #endif
5146 /* Dissociate this scroll bar from its window. */
5147 wset_vertical_scroll_bar (XWINDOW (bar->window), Qnil);
5149 unblock_input ();
5153 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5154 that we are displaying PORTION characters out of a total of WHOLE
5155 characters, starting at POSITION. If WINDOW has no scroll bar,
5156 create one. */
5158 static void
5159 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5161 struct frame *f = XFRAME (w->frame);
5162 Lisp_Object barobj;
5163 struct scroll_bar *bar;
5164 int top, height, left, sb_left, width, sb_width;
5165 int window_y, window_height;
5166 #ifdef USE_TOOLKIT_SCROLL_BARS
5167 int fringe_extended_p;
5168 #endif
5170 /* Get window dimensions. */
5171 window_box (w, -1, 0, &window_y, 0, &window_height);
5172 top = window_y;
5173 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5174 height = window_height;
5176 /* Compute the left edge of the scroll bar area. */
5177 left = WINDOW_SCROLL_BAR_AREA_X (w);
5179 /* Compute the width of the scroll bar which might be less than
5180 the width of the area reserved for the scroll bar. */
5181 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5182 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5183 else
5184 sb_width = width;
5186 /* Compute the left edge of the scroll bar. */
5187 #ifdef USE_TOOLKIT_SCROLL_BARS
5188 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5189 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5190 else
5191 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5192 #else
5193 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5194 sb_left = left + width - sb_width;
5195 else
5196 sb_left = left;
5197 #endif
5199 #ifdef USE_TOOLKIT_SCROLL_BARS
5200 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5201 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5202 && WINDOW_LEFT_FRINGE_WIDTH (w)
5203 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5204 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5205 else
5206 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5207 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5208 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5209 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5210 #endif
5212 /* Does the scroll bar exist yet? */
5213 if (NILP (w->vertical_scroll_bar))
5215 if (width > 0 && height > 0)
5217 block_input ();
5218 #ifdef USE_TOOLKIT_SCROLL_BARS
5219 if (fringe_extended_p)
5220 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5221 sb_left, top, sb_width, height, False);
5222 else
5223 #endif
5224 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5225 left, top, width, height, False);
5226 unblock_input ();
5229 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5231 else
5233 /* It may just need to be moved and resized. */
5234 unsigned int mask = 0;
5236 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5238 block_input ();
5240 if (sb_left != bar->left)
5241 mask |= CWX;
5242 if (top != bar->top)
5243 mask |= CWY;
5244 if (sb_width != bar->width)
5245 mask |= CWWidth;
5246 if (height != bar->height)
5247 mask |= CWHeight;
5249 #ifdef USE_TOOLKIT_SCROLL_BARS
5251 /* Move/size the scroll bar widget. */
5252 if (mask || bar->fringe_extended_p != fringe_extended_p)
5254 /* Since toolkit scroll bars are smaller than the space reserved
5255 for them on the frame, we have to clear "under" them. */
5256 if (width > 0 && height > 0)
5258 if (fringe_extended_p)
5259 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5260 sb_left, top, sb_width, height, False);
5261 else
5262 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5263 left, top, width, height, False);
5265 #ifdef USE_GTK
5266 xg_update_scrollbar_pos (f,
5267 bar->x_window,
5268 top,
5269 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5270 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5271 max (height, 1));
5272 #else /* not USE_GTK */
5273 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5274 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5275 top,
5276 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5277 max (height, 1), 0);
5278 #endif /* not USE_GTK */
5280 #else /* not USE_TOOLKIT_SCROLL_BARS */
5282 /* Clear areas not covered by the scroll bar because of
5283 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5284 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5286 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5287 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5288 height, False);
5289 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5290 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5291 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5292 height, False);
5295 /* Clear areas not covered by the scroll bar because it's not as
5296 wide as the area reserved for it. This makes sure a
5297 previous mode line display is cleared after C-x 2 C-x 1, for
5298 example. */
5300 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5301 int rest = area_width - sb_width;
5302 if (rest > 0 && height > 0)
5304 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5305 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5306 left + area_width - rest, top,
5307 rest, height, False);
5308 else
5309 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5310 left, top, rest, height, False);
5314 /* Move/size the scroll bar window. */
5315 if (mask)
5317 XWindowChanges wc;
5319 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5320 wc.y = top;
5321 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5322 wc.height = height;
5323 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5324 mask, &wc);
5327 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5329 /* Remember new settings. */
5330 bar->left = sb_left;
5331 bar->top = top;
5332 bar->width = sb_width;
5333 bar->height = height;
5335 unblock_input ();
5338 #ifdef USE_TOOLKIT_SCROLL_BARS
5339 bar->fringe_extended_p = fringe_extended_p;
5341 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5342 #else /* not USE_TOOLKIT_SCROLL_BARS */
5343 /* Set the scroll bar's current state, unless we're currently being
5344 dragged. */
5345 if (NILP (bar->dragging))
5347 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5349 if (whole == 0)
5350 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5351 else
5353 int start = ((double) position * top_range) / whole;
5354 int end = ((double) (position + portion) * top_range) / whole;
5355 x_scroll_bar_set_handle (bar, start, end, 0);
5358 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5360 XSETVECTOR (barobj, bar);
5361 wset_vertical_scroll_bar (w, barobj);
5365 /* The following three hooks are used when we're doing a thorough
5366 redisplay of the frame. We don't explicitly know which scroll bars
5367 are going to be deleted, because keeping track of when windows go
5368 away is a real pain - "Can you say set-window-configuration, boys
5369 and girls?" Instead, we just assert at the beginning of redisplay
5370 that *all* scroll bars are to be removed, and then save a scroll bar
5371 from the fiery pit when we actually redisplay its window. */
5373 /* Arrange for all scroll bars on FRAME to be removed at the next call
5374 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5375 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5377 static void
5378 XTcondemn_scroll_bars (struct frame *frame)
5380 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5381 while (! NILP (FRAME_SCROLL_BARS (frame)))
5383 Lisp_Object bar;
5384 bar = FRAME_SCROLL_BARS (frame);
5385 fset_scroll_bars (frame, XSCROLL_BAR (bar)->next);
5386 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5387 XSCROLL_BAR (bar)->prev = Qnil;
5388 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5389 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5390 fset_condemned_scroll_bars (frame, bar);
5395 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5396 Note that WINDOW isn't necessarily condemned at all. */
5398 static void
5399 XTredeem_scroll_bar (struct window *window)
5401 struct scroll_bar *bar;
5402 struct frame *f;
5403 Lisp_Object barobj;
5405 /* We can't redeem this window's scroll bar if it doesn't have one. */
5406 if (NILP (window->vertical_scroll_bar))
5407 emacs_abort ();
5409 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5411 /* Unlink it from the condemned list. */
5412 f = XFRAME (WINDOW_FRAME (window));
5413 if (NILP (bar->prev))
5415 /* If the prev pointer is nil, it must be the first in one of
5416 the lists. */
5417 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5418 /* It's not condemned. Everything's fine. */
5419 return;
5420 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5421 window->vertical_scroll_bar))
5422 fset_condemned_scroll_bars (f, bar->next);
5423 else
5424 /* If its prev pointer is nil, it must be at the front of
5425 one or the other! */
5426 emacs_abort ();
5428 else
5429 XSCROLL_BAR (bar->prev)->next = bar->next;
5431 if (! NILP (bar->next))
5432 XSCROLL_BAR (bar->next)->prev = bar->prev;
5434 bar->next = FRAME_SCROLL_BARS (f);
5435 bar->prev = Qnil;
5436 XSETVECTOR (barobj, bar);
5437 fset_scroll_bars (f, barobj);
5438 if (! NILP (bar->next))
5439 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5442 /* Remove all scroll bars on FRAME that haven't been saved since the
5443 last call to `*condemn_scroll_bars_hook'. */
5445 static void
5446 XTjudge_scroll_bars (struct frame *f)
5448 Lisp_Object bar, next;
5450 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5452 /* Clear out the condemned list now so we won't try to process any
5453 more events on the hapless scroll bars. */
5454 fset_condemned_scroll_bars (f, Qnil);
5456 for (; ! NILP (bar); bar = next)
5458 struct scroll_bar *b = XSCROLL_BAR (bar);
5460 x_scroll_bar_remove (b);
5462 next = b->next;
5463 b->next = b->prev = Qnil;
5466 /* Now there should be no references to the condemned scroll bars,
5467 and they should get garbage-collected. */
5471 #ifndef USE_TOOLKIT_SCROLL_BARS
5472 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5473 is a no-op when using toolkit scroll bars.
5475 This may be called from a signal handler, so we have to ignore GC
5476 mark bits. */
5478 static void
5479 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5481 Window w = bar->x_window;
5482 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5483 GC gc = f->output_data.x->normal_gc;
5484 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5486 block_input ();
5488 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5490 /* Switch to scroll bar foreground color. */
5491 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5492 XSetForeground (FRAME_X_DISPLAY (f), gc,
5493 f->output_data.x->scroll_bar_foreground_pixel);
5495 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5496 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5498 /* x, y, width, height */
5499 0, 0,
5500 bar->width - 1 - width_trim - width_trim,
5501 bar->height - 1);
5503 /* Restore the foreground color of the GC if we changed it above. */
5504 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5505 XSetForeground (FRAME_X_DISPLAY (f), gc,
5506 FRAME_FOREGROUND_PIXEL (f));
5508 unblock_input ();
5511 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5513 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5514 is set to something other than NO_EVENT, it is enqueued.
5516 This may be called from a signal handler, so we have to ignore GC
5517 mark bits. */
5520 static void
5521 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5523 if (! WINDOWP (bar->window))
5524 emacs_abort ();
5526 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5527 emacs_event->code = event->xbutton.button - Button1;
5528 emacs_event->modifiers
5529 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5530 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5531 event->xbutton.state)
5532 | (event->type == ButtonRelease
5533 ? up_modifier
5534 : down_modifier));
5535 emacs_event->frame_or_window = bar->window;
5536 emacs_event->arg = Qnil;
5537 emacs_event->timestamp = event->xbutton.time;
5539 int top_range
5540 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5541 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5543 if (y < 0) y = 0;
5544 if (y > top_range) y = top_range;
5546 if (y < bar->start)
5547 emacs_event->part = scroll_bar_above_handle;
5548 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5549 emacs_event->part = scroll_bar_handle;
5550 else
5551 emacs_event->part = scroll_bar_below_handle;
5553 #ifndef USE_TOOLKIT_SCROLL_BARS
5554 /* If the user has released the handle, set it to its final position. */
5555 if (event->type == ButtonRelease
5556 && ! NILP (bar->dragging))
5558 int new_start = y - XINT (bar->dragging);
5559 int new_end = new_start + bar->end - bar->start;
5561 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5562 bar->dragging = Qnil;
5564 #endif
5566 XSETINT (emacs_event->x, y);
5567 XSETINT (emacs_event->y, top_range);
5571 #ifndef USE_TOOLKIT_SCROLL_BARS
5573 /* Handle some mouse motion while someone is dragging the scroll bar.
5575 This may be called from a signal handler, so we have to ignore GC
5576 mark bits. */
5578 static void
5579 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5581 struct frame *f = XFRAME (XWINDOW (bar->window)->frame);
5583 last_mouse_movement_time = event->xmotion.time;
5585 f->mouse_moved = 1;
5586 XSETVECTOR (last_mouse_scroll_bar, bar);
5588 /* If we're dragging the bar, display it. */
5589 if (! NILP (bar->dragging))
5591 /* Where should the handle be now? */
5592 int new_start = event->xmotion.y - XINT (bar->dragging);
5594 if (new_start != bar->start)
5596 int new_end = new_start + bar->end - bar->start;
5598 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5603 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5605 /* Return information to the user about the current position of the mouse
5606 on the scroll bar. */
5608 static void
5609 x_scroll_bar_report_motion (struct frame **fp, Lisp_Object *bar_window,
5610 enum scroll_bar_part *part, Lisp_Object *x,
5611 Lisp_Object *y, Time *timestamp)
5613 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5614 Window w = bar->x_window;
5615 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5616 int win_x, win_y;
5617 Window dummy_window;
5618 int dummy_coord;
5619 unsigned int dummy_mask;
5621 block_input ();
5623 /* Get the mouse's position relative to the scroll bar window, and
5624 report that. */
5625 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5627 /* Root, child, root x and root y. */
5628 &dummy_window, &dummy_window,
5629 &dummy_coord, &dummy_coord,
5631 /* Position relative to scroll bar. */
5632 &win_x, &win_y,
5634 /* Mouse buttons and modifier keys. */
5635 &dummy_mask))
5637 else
5639 int top_range
5640 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5642 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5644 if (! NILP (bar->dragging))
5645 win_y -= XINT (bar->dragging);
5647 if (win_y < 0)
5648 win_y = 0;
5649 if (win_y > top_range)
5650 win_y = top_range;
5652 *fp = f;
5653 *bar_window = bar->window;
5655 if (! NILP (bar->dragging))
5656 *part = scroll_bar_handle;
5657 else if (win_y < bar->start)
5658 *part = scroll_bar_above_handle;
5659 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5660 *part = scroll_bar_handle;
5661 else
5662 *part = scroll_bar_below_handle;
5664 XSETINT (*x, win_y);
5665 XSETINT (*y, top_range);
5667 f->mouse_moved = 0;
5668 last_mouse_scroll_bar = Qnil;
5671 *timestamp = last_mouse_movement_time;
5673 unblock_input ();
5677 /* The screen has been cleared so we may have changed foreground or
5678 background colors, and the scroll bars may need to be redrawn.
5679 Clear out the scroll bars, and ask for expose events, so we can
5680 redraw them. */
5682 static void
5683 x_scroll_bar_clear (struct frame *f)
5685 #ifndef USE_TOOLKIT_SCROLL_BARS
5686 Lisp_Object bar;
5688 /* We can have scroll bars even if this is 0,
5689 if we just turned off scroll bar mode.
5690 But in that case we should not clear them. */
5691 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5692 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5693 bar = XSCROLL_BAR (bar)->next)
5694 XClearArea (FRAME_X_DISPLAY (f),
5695 XSCROLL_BAR (bar)->x_window,
5696 0, 0, 0, 0, True);
5697 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5701 /* The main X event-reading loop - XTread_socket. */
5703 /* This holds the state XLookupString needs to implement dead keys
5704 and other tricks known as "compose processing". _X Window System_
5705 says that a portable program can't use this, but Stephen Gildea assures
5706 me that letting the compiler initialize it to zeros will work okay.
5708 This must be defined outside of XTread_socket, for the same reasons
5709 given for enter_timestamp, above. */
5711 static XComposeStatus compose_status;
5713 /* Record the last 100 characters stored
5714 to help debug the loss-of-chars-during-GC problem. */
5716 static int temp_index;
5717 static short temp_buffer[100];
5719 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5720 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5721 temp_index = 0; \
5722 temp_buffer[temp_index++] = (keysym)
5724 /* Set this to nonzero to fake an "X I/O error"
5725 on a particular display. */
5727 static struct x_display_info *XTread_socket_fake_io_error;
5729 /* When we find no input here, we occasionally do a no-op command
5730 to verify that the X server is still running and we can still talk with it.
5731 We try all the open displays, one by one.
5732 This variable is used for cycling thru the displays. */
5734 static struct x_display_info *next_noop_dpyinfo;
5736 #if defined USE_X_TOOLKIT || defined USE_GTK
5737 #define SET_SAVED_BUTTON_EVENT \
5738 do \
5740 if (f->output_data.x->saved_menu_event == 0) \
5741 f->output_data.x->saved_menu_event = \
5742 xmalloc (sizeof (XEvent)); \
5743 *f->output_data.x->saved_menu_event = event; \
5744 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5745 XSETFRAME (inev.ie.frame_or_window, f); \
5747 while (0)
5748 #endif
5750 enum
5752 X_EVENT_NORMAL,
5753 X_EVENT_GOTO_OUT,
5754 X_EVENT_DROP
5757 /* Filter events for the current X input method.
5758 DPYINFO is the display this event is for.
5759 EVENT is the X event to filter.
5761 Returns non-zero if the event was filtered, caller shall not process
5762 this event further.
5763 Returns zero if event is wasn't filtered. */
5765 #ifdef HAVE_X_I18N
5766 static int
5767 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5769 /* XFilterEvent returns non-zero if the input method has
5770 consumed the event. We pass the frame's X window to
5771 XFilterEvent because that's the one for which the IC
5772 was created. */
5774 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5775 event->xclient.window);
5777 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5779 #endif
5781 #ifdef USE_GTK
5782 static int current_count;
5783 static int current_finish;
5784 static struct input_event *current_hold_quit;
5786 /* This is the filter function invoked by the GTK event loop.
5787 It is invoked before the XEvent is translated to a GdkEvent,
5788 so we have a chance to act on the event before GTK. */
5789 static GdkFilterReturn
5790 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5792 XEvent *xev = (XEvent *) gxev;
5794 block_input ();
5795 if (current_count >= 0)
5797 struct x_display_info *dpyinfo;
5799 dpyinfo = x_display_info_for_display (xev->xany.display);
5801 #ifdef HAVE_X_I18N
5802 /* Filter events for the current X input method.
5803 GTK calls XFilterEvent but not for key press and release,
5804 so we do it here. */
5805 if ((xev->type == KeyPress || xev->type == KeyRelease)
5806 && dpyinfo
5807 && x_filter_event (dpyinfo, xev))
5809 unblock_input ();
5810 return GDK_FILTER_REMOVE;
5812 #endif
5814 if (! dpyinfo)
5815 current_finish = X_EVENT_NORMAL;
5816 else
5817 current_count +=
5818 handle_one_xevent (dpyinfo, xev, &current_finish,
5819 current_hold_quit);
5821 else
5822 current_finish = x_dispatch_event (xev, xev->xany.display);
5824 unblock_input ();
5826 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5827 return GDK_FILTER_REMOVE;
5829 return GDK_FILTER_CONTINUE;
5831 #endif /* USE_GTK */
5834 static void xembed_send_message (struct frame *f, Time,
5835 enum xembed_message,
5836 long detail, long data1, long data2);
5838 /* Handles the XEvent EVENT on display DPYINFO.
5840 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5841 *FINISH is zero if caller should continue reading events.
5842 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5844 We return the number of characters stored into the buffer. */
5846 static int
5847 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventptr,
5848 int *finish, struct input_event *hold_quit)
5850 union {
5851 struct input_event ie;
5852 struct selection_input_event sie;
5853 } inev;
5854 int count = 0;
5855 int do_help = 0;
5856 ptrdiff_t nbytes = 0;
5857 struct frame *f = NULL;
5858 struct coding_system coding;
5859 XEvent event = *eventptr;
5860 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5861 USE_SAFE_ALLOCA;
5863 *finish = X_EVENT_NORMAL;
5865 EVENT_INIT (inev.ie);
5866 inev.ie.kind = NO_EVENT;
5867 inev.ie.arg = Qnil;
5869 if (pending_event_wait.eventtype == event.type)
5870 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5872 switch (event.type)
5874 case ClientMessage:
5876 if (event.xclient.message_type
5877 == dpyinfo->Xatom_wm_protocols
5878 && event.xclient.format == 32)
5880 if (event.xclient.data.l[0]
5881 == dpyinfo->Xatom_wm_take_focus)
5883 /* Use x_any_window_to_frame because this
5884 could be the shell widget window
5885 if the frame has no title bar. */
5886 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5887 #ifdef HAVE_X_I18N
5888 /* Not quite sure this is needed -pd */
5889 if (f && FRAME_XIC (f))
5890 XSetICFocus (FRAME_XIC (f));
5891 #endif
5892 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5893 instructs the WM to set the input focus automatically for
5894 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5895 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5896 it has set the focus. So, XSetInputFocus below is not
5897 needed.
5899 The call to XSetInputFocus below has also caused trouble. In
5900 cases where the XSetInputFocus done by the WM and the one
5901 below are temporally close (on a fast machine), the call
5902 below can generate additional FocusIn events which confuse
5903 Emacs. */
5905 /* Since we set WM_TAKE_FOCUS, we must call
5906 XSetInputFocus explicitly. But not if f is null,
5907 since that might be an event for a deleted frame. */
5908 if (f)
5910 Display *d = event.xclient.display;
5911 /* Catch and ignore errors, in case window has been
5912 iconified by a window manager such as GWM. */
5913 x_catch_errors (d);
5914 XSetInputFocus (d, event.xclient.window,
5915 /* The ICCCM says this is
5916 the only valid choice. */
5917 RevertToParent,
5918 event.xclient.data.l[1]);
5919 /* This is needed to detect the error
5920 if there is an error. */
5921 XSync (d, False);
5922 x_uncatch_errors ();
5924 /* Not certain about handling scroll bars here */
5925 #endif /* 0 */
5926 goto done;
5929 if (event.xclient.data.l[0]
5930 == dpyinfo->Xatom_wm_save_yourself)
5932 /* Save state modify the WM_COMMAND property to
5933 something which can reinstate us. This notifies
5934 the session manager, who's looking for such a
5935 PropertyNotify. Can restart processing when
5936 a keyboard or mouse event arrives. */
5937 /* If we have a session manager, don't set this.
5938 KDE will then start two Emacsen, one for the
5939 session manager and one for this. */
5940 #ifdef HAVE_X_SM
5941 if (! x_session_have_connection ())
5942 #endif
5944 f = x_top_window_to_frame (dpyinfo,
5945 event.xclient.window);
5946 /* This is just so we only give real data once
5947 for a single Emacs process. */
5948 if (f == SELECTED_FRAME ())
5949 XSetCommand (FRAME_X_DISPLAY (f),
5950 event.xclient.window,
5951 initial_argv, initial_argc);
5952 else if (f)
5953 XSetCommand (FRAME_X_DISPLAY (f),
5954 event.xclient.window,
5955 0, 0);
5957 goto done;
5960 if (event.xclient.data.l[0]
5961 == dpyinfo->Xatom_wm_delete_window)
5963 f = x_any_window_to_frame (dpyinfo,
5964 event.xclient.window);
5965 if (!f)
5966 goto OTHER; /* May be a dialog that is to be removed */
5968 inev.ie.kind = DELETE_WINDOW_EVENT;
5969 XSETFRAME (inev.ie.frame_or_window, f);
5970 goto done;
5973 goto done;
5976 if (event.xclient.message_type
5977 == dpyinfo->Xatom_wm_configure_denied)
5979 goto done;
5982 if (event.xclient.message_type
5983 == dpyinfo->Xatom_wm_window_moved)
5985 int new_x, new_y;
5986 f = x_window_to_frame (dpyinfo, event.xclient.window);
5988 new_x = event.xclient.data.s[0];
5989 new_y = event.xclient.data.s[1];
5991 if (f)
5993 f->left_pos = new_x;
5994 f->top_pos = new_y;
5996 goto done;
5999 #ifdef HACK_EDITRES
6000 if (event.xclient.message_type
6001 == dpyinfo->Xatom_editres)
6003 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6004 if (f)
6005 _XEditResCheckMessages (f->output_data.x->widget, NULL,
6006 &event, NULL);
6007 goto done;
6009 #endif /* HACK_EDITRES */
6011 if ((event.xclient.message_type
6012 == dpyinfo->Xatom_DONE)
6013 || (event.xclient.message_type
6014 == dpyinfo->Xatom_PAGE))
6016 /* Ghostview job completed. Kill it. We could
6017 reply with "Next" if we received "Page", but we
6018 currently never do because we are interested in
6019 images, only, which should have 1 page. */
6020 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6021 f = x_window_to_frame (dpyinfo, event.xclient.window);
6022 if (!f)
6023 goto OTHER;
6024 x_kill_gs_process (pixmap, f);
6025 expose_frame (f, 0, 0, 0, 0);
6026 goto done;
6029 #ifdef USE_TOOLKIT_SCROLL_BARS
6030 /* Scroll bar callbacks send a ClientMessage from which
6031 we construct an input_event. */
6032 if (event.xclient.message_type
6033 == dpyinfo->Xatom_Scrollbar)
6035 x_scroll_bar_to_input_event (&event, &inev.ie);
6036 *finish = X_EVENT_GOTO_OUT;
6037 goto done;
6039 #endif /* USE_TOOLKIT_SCROLL_BARS */
6041 /* XEmbed messages from the embedder (if any). */
6042 if (event.xclient.message_type
6043 == dpyinfo->Xatom_XEMBED)
6045 enum xembed_message msg = event.xclient.data.l[1];
6046 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6047 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6049 *finish = X_EVENT_GOTO_OUT;
6050 goto done;
6053 xft_settings_event (dpyinfo, &event);
6055 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6056 if (!f)
6057 goto OTHER;
6058 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6059 *finish = X_EVENT_DROP;
6061 break;
6063 case SelectionNotify:
6064 last_user_time = event.xselection.time;
6065 #ifdef USE_X_TOOLKIT
6066 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6067 goto OTHER;
6068 #endif /* not USE_X_TOOLKIT */
6069 x_handle_selection_notify (&event.xselection);
6070 break;
6072 case SelectionClear: /* Someone has grabbed ownership. */
6073 last_user_time = event.xselectionclear.time;
6074 #ifdef USE_X_TOOLKIT
6075 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6076 goto OTHER;
6077 #endif /* USE_X_TOOLKIT */
6079 XSelectionClearEvent *eventp = &(event.xselectionclear);
6081 inev.ie.kind = SELECTION_CLEAR_EVENT;
6082 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6083 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6084 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6086 break;
6088 case SelectionRequest: /* Someone wants our selection. */
6089 last_user_time = event.xselectionrequest.time;
6090 #ifdef USE_X_TOOLKIT
6091 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6092 goto OTHER;
6093 #endif /* USE_X_TOOLKIT */
6095 XSelectionRequestEvent *eventp = &(event.xselectionrequest);
6097 inev.ie.kind = SELECTION_REQUEST_EVENT;
6098 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6099 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6100 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6101 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6102 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6103 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6105 break;
6107 case PropertyNotify:
6108 last_user_time = event.xproperty.time;
6109 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6110 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6111 if (x_handle_net_wm_state (f, &event.xproperty)
6112 && FRAME_ICONIFIED_P (f)
6113 && f->output_data.x->net_wm_state_hidden_seen)
6115 /* Gnome shell does not iconify us when C-z is pressed.
6116 It hides the frame. So if our state says we aren't
6117 hidden anymore, treat it as deiconified. */
6118 SET_FRAME_VISIBLE (f, 1);
6119 SET_FRAME_ICONIFIED (f, 0);
6120 f->output_data.x->has_been_visible = 1;
6121 f->output_data.x->net_wm_state_hidden_seen = 0;
6122 inev.ie.kind = DEICONIFY_EVENT;
6123 XSETFRAME (inev.ie.frame_or_window, f);
6126 x_handle_property_notify (&event.xproperty);
6127 xft_settings_event (dpyinfo, &event);
6128 goto OTHER;
6130 case ReparentNotify:
6131 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6132 if (f)
6134 int x, y;
6135 f->output_data.x->parent_desc = event.xreparent.parent;
6136 x_real_positions (f, &x, &y);
6137 f->left_pos = x;
6138 f->top_pos = y;
6140 /* Perhaps reparented due to a WM restart. Reset this. */
6141 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6142 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6144 x_set_frame_alpha (f);
6146 goto OTHER;
6148 case Expose:
6149 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6150 if (f)
6152 #ifdef USE_GTK
6153 /* This seems to be needed for GTK 2.6. */
6154 x_clear_area (event.xexpose.display,
6155 event.xexpose.window,
6156 event.xexpose.x, event.xexpose.y,
6157 event.xexpose.width, event.xexpose.height,
6158 FALSE);
6159 #endif
6160 if (!FRAME_VISIBLE_P (f))
6162 SET_FRAME_VISIBLE (f, 1);
6163 SET_FRAME_ICONIFIED (f, 0);
6164 f->output_data.x->has_been_visible = 1;
6165 SET_FRAME_GARBAGED (f);
6167 else
6168 expose_frame (f,
6169 event.xexpose.x, event.xexpose.y,
6170 event.xexpose.width, event.xexpose.height);
6172 else
6174 #ifndef USE_TOOLKIT_SCROLL_BARS
6175 struct scroll_bar *bar;
6176 #endif
6177 #if defined USE_LUCID
6178 /* Submenus of the Lucid menu bar aren't widgets
6179 themselves, so there's no way to dispatch events
6180 to them. Recognize this case separately. */
6182 Widget widget
6183 = x_window_to_menu_bar (event.xexpose.window);
6184 if (widget)
6185 xlwmenu_redisplay (widget);
6187 #endif /* USE_LUCID */
6189 #ifdef USE_TOOLKIT_SCROLL_BARS
6190 /* Dispatch event to the widget. */
6191 goto OTHER;
6192 #else /* not USE_TOOLKIT_SCROLL_BARS */
6193 bar = x_window_to_scroll_bar (event.xexpose.display,
6194 event.xexpose.window);
6196 if (bar)
6197 x_scroll_bar_expose (bar, &event);
6198 #ifdef USE_X_TOOLKIT
6199 else
6200 goto OTHER;
6201 #endif /* USE_X_TOOLKIT */
6202 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6204 break;
6206 case GraphicsExpose: /* This occurs when an XCopyArea's
6207 source area was obscured or not
6208 available. */
6209 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6210 if (f)
6212 expose_frame (f,
6213 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6214 event.xgraphicsexpose.width,
6215 event.xgraphicsexpose.height);
6217 #ifdef USE_X_TOOLKIT
6218 else
6219 goto OTHER;
6220 #endif /* USE_X_TOOLKIT */
6221 break;
6223 case NoExpose: /* This occurs when an XCopyArea's
6224 source area was completely
6225 available. */
6226 break;
6228 case UnmapNotify:
6229 /* Redo the mouse-highlight after the tooltip has gone. */
6230 if (event.xmap.window == tip_window)
6232 tip_window = 0;
6233 redo_mouse_highlight ();
6236 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6237 if (f) /* F may no longer exist if
6238 the frame was deleted. */
6240 bool visible = FRAME_VISIBLE_P (f);
6241 /* While a frame is unmapped, display generation is
6242 disabled; you don't want to spend time updating a
6243 display that won't ever be seen. */
6244 SET_FRAME_VISIBLE (f, 0);
6245 /* We can't distinguish, from the event, whether the window
6246 has become iconified or invisible. So assume, if it
6247 was previously visible, than now it is iconified.
6248 But x_make_frame_invisible clears both
6249 the visible flag and the iconified flag;
6250 and that way, we know the window is not iconified now. */
6251 if (visible || FRAME_ICONIFIED_P (f))
6253 SET_FRAME_ICONIFIED (f, 1);
6254 inev.ie.kind = ICONIFY_EVENT;
6255 XSETFRAME (inev.ie.frame_or_window, f);
6258 goto OTHER;
6260 case MapNotify:
6261 if (event.xmap.window == tip_window)
6262 /* The tooltip has been drawn already. Avoid
6263 the SET_FRAME_GARBAGED below. */
6264 goto OTHER;
6266 /* We use x_top_window_to_frame because map events can
6267 come for sub-windows and they don't mean that the
6268 frame is visible. */
6269 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6270 if (f)
6272 bool iconified = FRAME_ICONIFIED_P (f);
6273 /* wait_reading_process_output will notice this and update
6274 the frame's display structures.
6275 If we where iconified, we should not set garbaged,
6276 because that stops redrawing on Expose events. This looks
6277 bad if we are called from a recursive event loop
6278 (x_dispatch_event), for example when a dialog is up. */
6279 if (!iconified)
6280 SET_FRAME_GARBAGED (f);
6282 /* Check if fullscreen was specified before we where mapped the
6283 first time, i.e. from the command line. */
6284 if (!f->output_data.x->has_been_visible)
6285 x_check_fullscreen (f);
6287 SET_FRAME_VISIBLE (f, 1);
6288 SET_FRAME_ICONIFIED (f, 0);
6289 f->output_data.x->has_been_visible = 1;
6291 if (iconified)
6293 inev.ie.kind = DEICONIFY_EVENT;
6294 XSETFRAME (inev.ie.frame_or_window, f);
6296 else if (! NILP (Vframe_list) && ! NILP (XCDR (Vframe_list)))
6297 /* Force a redisplay sooner or later to update the
6298 frame titles in case this is the second frame. */
6299 record_asynch_buffer_change ();
6301 #ifdef USE_GTK
6302 xg_frame_resized (f, -1, -1);
6303 #endif
6305 goto OTHER;
6307 case KeyPress:
6309 last_user_time = event.xkey.time;
6310 ignore_next_mouse_click_timeout = 0;
6312 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6313 /* Dispatch KeyPress events when in menu. */
6314 if (popup_activated ())
6315 goto OTHER;
6316 #endif
6318 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6320 /* If mouse-highlight is an integer, input clears out
6321 mouse highlighting. */
6322 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6323 && (f == 0
6324 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6326 clear_mouse_face (hlinfo);
6327 hlinfo->mouse_face_hidden = 1;
6330 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6331 if (f == 0)
6333 /* Scroll bars consume key events, but we want
6334 the keys to go to the scroll bar's frame. */
6335 Widget widget = XtWindowToWidget (dpyinfo->display,
6336 event.xkey.window);
6337 if (widget && XmIsScrollBar (widget))
6339 widget = XtParent (widget);
6340 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6343 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6345 if (f != 0)
6347 KeySym keysym, orig_keysym;
6348 /* al%imercury@uunet.uu.net says that making this 81
6349 instead of 80 fixed a bug whereby meta chars made
6350 his Emacs hang.
6352 It seems that some version of XmbLookupString has
6353 a bug of not returning XBufferOverflow in
6354 status_return even if the input is too long to
6355 fit in 81 bytes. So, we must prepare sufficient
6356 bytes for copy_buffer. 513 bytes (256 chars for
6357 two-byte character set) seems to be a fairly good
6358 approximation. -- 2000.8.10 handa@etl.go.jp */
6359 unsigned char copy_buffer[513];
6360 unsigned char *copy_bufptr = copy_buffer;
6361 int copy_bufsiz = sizeof (copy_buffer);
6362 int modifiers;
6363 Lisp_Object coding_system = Qlatin_1;
6364 Lisp_Object c;
6366 #ifdef USE_GTK
6367 /* Don't pass keys to GTK. A Tab will shift focus to the
6368 tool bar in GTK 2.4. Keys will still go to menus and
6369 dialogs because in that case popup_activated is TRUE
6370 (see above). */
6371 *finish = X_EVENT_DROP;
6372 #endif
6374 event.xkey.state
6375 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6376 extra_keyboard_modifiers);
6377 modifiers = event.xkey.state;
6379 /* This will have to go some day... */
6381 /* make_lispy_event turns chars into control chars.
6382 Don't do it here because XLookupString is too eager. */
6383 event.xkey.state &= ~ControlMask;
6384 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6385 | dpyinfo->super_mod_mask
6386 | dpyinfo->hyper_mod_mask
6387 | dpyinfo->alt_mod_mask);
6389 /* In case Meta is ComposeCharacter,
6390 clear its status. According to Markus Ehrnsperger
6391 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6392 this enables ComposeCharacter to work whether or
6393 not it is combined with Meta. */
6394 if (modifiers & dpyinfo->meta_mod_mask)
6395 memset (&compose_status, 0, sizeof (compose_status));
6397 #ifdef HAVE_X_I18N
6398 if (FRAME_XIC (f))
6400 Status status_return;
6402 coding_system = Vlocale_coding_system;
6403 nbytes = XmbLookupString (FRAME_XIC (f),
6404 &event.xkey, (char *) copy_bufptr,
6405 copy_bufsiz, &keysym,
6406 &status_return);
6407 if (status_return == XBufferOverflow)
6409 copy_bufsiz = nbytes + 1;
6410 copy_bufptr = alloca (copy_bufsiz);
6411 nbytes = XmbLookupString (FRAME_XIC (f),
6412 &event.xkey, (char *) copy_bufptr,
6413 copy_bufsiz, &keysym,
6414 &status_return);
6416 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6417 if (status_return == XLookupNone)
6418 break;
6419 else if (status_return == XLookupChars)
6421 keysym = NoSymbol;
6422 modifiers = 0;
6424 else if (status_return != XLookupKeySym
6425 && status_return != XLookupBoth)
6426 emacs_abort ();
6428 else
6429 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6430 copy_bufsiz, &keysym,
6431 &compose_status);
6432 #else
6433 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6434 copy_bufsiz, &keysym,
6435 &compose_status);
6436 #endif
6438 /* If not using XIM/XIC, and a compose sequence is in progress,
6439 we break here. Otherwise, chars_matched is always 0. */
6440 if (compose_status.chars_matched > 0 && nbytes == 0)
6441 break;
6443 memset (&compose_status, 0, sizeof (compose_status));
6444 orig_keysym = keysym;
6446 /* Common for all keysym input events. */
6447 XSETFRAME (inev.ie.frame_or_window, f);
6448 inev.ie.modifiers
6449 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6450 inev.ie.timestamp = event.xkey.time;
6452 /* First deal with keysyms which have defined
6453 translations to characters. */
6454 if (keysym >= 32 && keysym < 128)
6455 /* Avoid explicitly decoding each ASCII character. */
6457 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6458 inev.ie.code = keysym;
6459 goto done_keysym;
6462 /* Keysyms directly mapped to Unicode characters. */
6463 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6465 if (keysym < 0x01000080)
6466 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6467 else
6468 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6469 inev.ie.code = keysym & 0xFFFFFF;
6470 goto done_keysym;
6473 /* Now non-ASCII. */
6474 if (HASH_TABLE_P (Vx_keysym_table)
6475 && (c = Fgethash (make_number (keysym),
6476 Vx_keysym_table,
6477 Qnil),
6478 NATNUMP (c)))
6480 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6481 ? ASCII_KEYSTROKE_EVENT
6482 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6483 inev.ie.code = XFASTINT (c);
6484 goto done_keysym;
6487 /* Random non-modifier sorts of keysyms. */
6488 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6489 || keysym == XK_Delete
6490 #ifdef XK_ISO_Left_Tab
6491 || (keysym >= XK_ISO_Left_Tab
6492 && keysym <= XK_ISO_Enter)
6493 #endif
6494 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6495 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6496 #ifdef HPUX
6497 /* This recognizes the "extended function
6498 keys". It seems there's no cleaner way.
6499 Test IsModifierKey to avoid handling
6500 mode_switch incorrectly. */
6501 || (XK_Select <= keysym && keysym < XK_KP_Space)
6502 #endif
6503 #ifdef XK_dead_circumflex
6504 || orig_keysym == XK_dead_circumflex
6505 #endif
6506 #ifdef XK_dead_grave
6507 || orig_keysym == XK_dead_grave
6508 #endif
6509 #ifdef XK_dead_tilde
6510 || orig_keysym == XK_dead_tilde
6511 #endif
6512 #ifdef XK_dead_diaeresis
6513 || orig_keysym == XK_dead_diaeresis
6514 #endif
6515 #ifdef XK_dead_macron
6516 || orig_keysym == XK_dead_macron
6517 #endif
6518 #ifdef XK_dead_degree
6519 || orig_keysym == XK_dead_degree
6520 #endif
6521 #ifdef XK_dead_acute
6522 || orig_keysym == XK_dead_acute
6523 #endif
6524 #ifdef XK_dead_cedilla
6525 || orig_keysym == XK_dead_cedilla
6526 #endif
6527 #ifdef XK_dead_breve
6528 || orig_keysym == XK_dead_breve
6529 #endif
6530 #ifdef XK_dead_ogonek
6531 || orig_keysym == XK_dead_ogonek
6532 #endif
6533 #ifdef XK_dead_caron
6534 || orig_keysym == XK_dead_caron
6535 #endif
6536 #ifdef XK_dead_doubleacute
6537 || orig_keysym == XK_dead_doubleacute
6538 #endif
6539 #ifdef XK_dead_abovedot
6540 || orig_keysym == XK_dead_abovedot
6541 #endif
6542 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6543 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6544 /* Any "vendor-specific" key is ok. */
6545 || (orig_keysym & (1 << 28))
6546 || (keysym != NoSymbol && nbytes == 0))
6547 && ! (IsModifierKey (orig_keysym)
6548 /* The symbols from XK_ISO_Lock
6549 to XK_ISO_Last_Group_Lock
6550 don't have real modifiers but
6551 should be treated similarly to
6552 Mode_switch by Emacs. */
6553 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6554 || (XK_ISO_Lock <= orig_keysym
6555 && orig_keysym <= XK_ISO_Last_Group_Lock)
6556 #endif
6559 STORE_KEYSYM_FOR_DEBUG (keysym);
6560 /* make_lispy_event will convert this to a symbolic
6561 key. */
6562 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6563 inev.ie.code = keysym;
6564 goto done_keysym;
6567 { /* Raw bytes, not keysym. */
6568 ptrdiff_t i;
6569 int nchars, len;
6571 for (i = 0, nchars = 0; i < nbytes; i++)
6573 if (ASCII_BYTE_P (copy_bufptr[i]))
6574 nchars++;
6575 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6578 if (nchars < nbytes)
6580 /* Decode the input data. */
6582 /* The input should be decoded with `coding_system'
6583 which depends on which X*LookupString function
6584 we used just above and the locale. */
6585 setup_coding_system (coding_system, &coding);
6586 coding.src_multibyte = 0;
6587 coding.dst_multibyte = 1;
6588 /* The input is converted to events, thus we can't
6589 handle composition. Anyway, there's no XIM that
6590 gives us composition information. */
6591 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6593 SAFE_NALLOCA (coding.destination, MAX_MULTIBYTE_LENGTH,
6594 nbytes);
6595 coding.dst_bytes = MAX_MULTIBYTE_LENGTH * nbytes;
6596 coding.mode |= CODING_MODE_LAST_BLOCK;
6597 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6598 nbytes = coding.produced;
6599 nchars = coding.produced_char;
6600 copy_bufptr = coding.destination;
6603 /* Convert the input data to a sequence of
6604 character events. */
6605 for (i = 0; i < nbytes; i += len)
6607 int ch;
6608 if (nchars == nbytes)
6609 ch = copy_bufptr[i], len = 1;
6610 else
6611 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6612 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
6613 ? ASCII_KEYSTROKE_EVENT
6614 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6615 inev.ie.code = ch;
6616 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6619 count += nchars;
6621 inev.ie.kind = NO_EVENT; /* Already stored above. */
6623 if (keysym == NoSymbol)
6624 break;
6627 done_keysym:
6628 #ifdef HAVE_X_I18N
6629 /* Don't dispatch this event since XtDispatchEvent calls
6630 XFilterEvent, and two calls in a row may freeze the
6631 client. */
6632 break;
6633 #else
6634 goto OTHER;
6635 #endif
6637 case KeyRelease:
6638 last_user_time = event.xkey.time;
6639 #ifdef HAVE_X_I18N
6640 /* Don't dispatch this event since XtDispatchEvent calls
6641 XFilterEvent, and two calls in a row may freeze the
6642 client. */
6643 break;
6644 #else
6645 goto OTHER;
6646 #endif
6648 case EnterNotify:
6649 last_user_time = event.xcrossing.time;
6650 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6652 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6654 if (f && x_mouse_click_focus_ignore_position)
6655 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6657 /* EnterNotify counts as mouse movement,
6658 so update things that depend on mouse position. */
6659 if (f && !f->output_data.x->hourglass_p)
6660 note_mouse_movement (f, &event.xmotion);
6661 #ifdef USE_GTK
6662 /* We may get an EnterNotify on the buttons in the toolbar. In that
6663 case we moved out of any highlighted area and need to note this. */
6664 if (!f && last_mouse_glyph_frame)
6665 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6666 #endif
6667 goto OTHER;
6669 case FocusIn:
6670 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6671 goto OTHER;
6673 case LeaveNotify:
6674 last_user_time = event.xcrossing.time;
6675 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6677 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6678 if (f)
6680 if (f == hlinfo->mouse_face_mouse_frame)
6682 /* If we move outside the frame, then we're
6683 certainly no longer on any text in the frame. */
6684 clear_mouse_face (hlinfo);
6685 hlinfo->mouse_face_mouse_frame = 0;
6688 /* Generate a nil HELP_EVENT to cancel a help-echo.
6689 Do it only if there's something to cancel.
6690 Otherwise, the startup message is cleared when
6691 the mouse leaves the frame. */
6692 if (any_help_event_p)
6693 do_help = -1;
6695 #ifdef USE_GTK
6696 /* See comment in EnterNotify above */
6697 else if (last_mouse_glyph_frame)
6698 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6699 #endif
6700 goto OTHER;
6702 case FocusOut:
6703 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6704 goto OTHER;
6706 case MotionNotify:
6708 last_user_time = event.xmotion.time;
6709 previous_help_echo_string = help_echo_string;
6710 help_echo_string = Qnil;
6712 if (dpyinfo->grabbed && last_mouse_frame
6713 && FRAME_LIVE_P (last_mouse_frame))
6714 f = last_mouse_frame;
6715 else
6716 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6718 if (hlinfo->mouse_face_hidden)
6720 hlinfo->mouse_face_hidden = 0;
6721 clear_mouse_face (hlinfo);
6724 #ifdef USE_GTK
6725 if (f && xg_event_is_for_scrollbar (f, &event))
6726 f = 0;
6727 #endif
6728 if (f)
6731 /* Generate SELECT_WINDOW_EVENTs when needed.
6732 Don't let popup menus influence things (bug#1261). */
6733 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6735 Lisp_Object window;
6737 window = window_from_coordinates (f,
6738 event.xmotion.x, event.xmotion.y,
6739 0, 0);
6741 /* Window will be selected only when it is not selected now and
6742 last mouse movement event was not in it. Minibuffer window
6743 will be selected only when it is active. */
6744 if (WINDOWP (window)
6745 && !EQ (window, last_window)
6746 && !EQ (window, selected_window)
6747 /* For click-to-focus window managers
6748 create event iff we don't leave the
6749 selected frame. */
6750 && (focus_follows_mouse
6751 || (EQ (XWINDOW (window)->frame,
6752 XWINDOW (selected_window)->frame))))
6754 inev.ie.kind = SELECT_WINDOW_EVENT;
6755 inev.ie.frame_or_window = window;
6758 last_window=window;
6760 if (!note_mouse_movement (f, &event.xmotion))
6761 help_echo_string = previous_help_echo_string;
6763 else
6765 #ifndef USE_TOOLKIT_SCROLL_BARS
6766 struct scroll_bar *bar
6767 = x_window_to_scroll_bar (event.xmotion.display,
6768 event.xmotion.window);
6770 if (bar)
6771 x_scroll_bar_note_movement (bar, &event);
6772 #endif /* USE_TOOLKIT_SCROLL_BARS */
6774 /* If we move outside the frame, then we're
6775 certainly no longer on any text in the frame. */
6776 clear_mouse_face (hlinfo);
6779 /* If the contents of the global variable help_echo_string
6780 has changed, generate a HELP_EVENT. */
6781 if (!NILP (help_echo_string)
6782 || !NILP (previous_help_echo_string))
6783 do_help = 1;
6784 goto OTHER;
6787 case ConfigureNotify:
6788 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6789 #ifdef USE_GTK
6790 if (!f
6791 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6792 && event.xconfigure.window == FRAME_X_WINDOW (f))
6794 xg_frame_resized (f, event.xconfigure.width,
6795 event.xconfigure.height);
6796 f = 0;
6798 #endif
6799 if (f)
6801 #ifndef USE_X_TOOLKIT
6802 #ifndef USE_GTK
6803 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6804 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6806 /* In the toolkit version, change_frame_size
6807 is called by the code that handles resizing
6808 of the EmacsFrame widget. */
6810 /* Even if the number of character rows and columns has
6811 not changed, the font size may have changed, so we need
6812 to check the pixel dimensions as well. */
6813 if (columns != FRAME_COLS (f)
6814 || rows != FRAME_LINES (f)
6815 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6816 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6818 change_frame_size (f, rows, columns, 0, 1, 0);
6819 SET_FRAME_GARBAGED (f);
6820 cancel_mouse_face (f);
6823 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6824 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6825 #endif /* not USE_GTK */
6826 #endif
6828 #ifdef USE_GTK
6829 /* GTK creates windows but doesn't map them.
6830 Only get real positions when mapped. */
6831 if (FRAME_GTK_OUTER_WIDGET (f)
6832 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6833 #endif
6835 x_real_positions (f, &f->left_pos, &f->top_pos);
6838 #ifdef HAVE_X_I18N
6839 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6840 xic_set_statusarea (f);
6841 #endif
6844 goto OTHER;
6846 case ButtonRelease:
6847 case ButtonPress:
6849 /* If we decide we want to generate an event to be seen
6850 by the rest of Emacs, we put it here. */
6851 bool tool_bar_p = 0;
6853 memset (&compose_status, 0, sizeof (compose_status));
6854 last_mouse_glyph_frame = 0;
6855 last_user_time = event.xbutton.time;
6857 if (dpyinfo->grabbed
6858 && last_mouse_frame
6859 && FRAME_LIVE_P (last_mouse_frame))
6860 f = last_mouse_frame;
6861 else
6862 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6864 #ifdef USE_GTK
6865 if (f && xg_event_is_for_scrollbar (f, &event))
6866 f = 0;
6867 #endif
6868 if (f)
6870 /* Is this in the tool-bar? */
6871 if (WINDOWP (f->tool_bar_window)
6872 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6874 Lisp_Object window;
6875 int x = event.xbutton.x;
6876 int y = event.xbutton.y;
6878 window = window_from_coordinates (f, x, y, 0, 1);
6879 tool_bar_p = EQ (window, f->tool_bar_window);
6881 if (tool_bar_p && event.xbutton.button < 4)
6883 handle_tool_bar_click (f, x, y,
6884 event.xbutton.type == ButtonPress,
6885 x_x_to_emacs_modifiers (dpyinfo,
6886 event.xbutton.state));
6890 if (!tool_bar_p)
6891 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6892 if (! popup_activated ())
6893 #endif
6895 if (ignore_next_mouse_click_timeout)
6897 if (event.type == ButtonPress
6898 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6900 ignore_next_mouse_click_timeout = 0;
6901 construct_mouse_click (&inev.ie, &event.xbutton, f);
6903 if (event.type == ButtonRelease)
6904 ignore_next_mouse_click_timeout = 0;
6906 else
6907 construct_mouse_click (&inev.ie, &event.xbutton, f);
6909 if (FRAME_X_EMBEDDED_P (f))
6910 xembed_send_message (f, event.xbutton.time,
6911 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6913 else
6915 struct scroll_bar *bar
6916 = x_window_to_scroll_bar (event.xbutton.display,
6917 event.xbutton.window);
6919 #ifdef USE_TOOLKIT_SCROLL_BARS
6920 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6921 scroll bars. */
6922 if (bar && event.xbutton.state & ControlMask)
6924 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6925 *finish = X_EVENT_DROP;
6927 #else /* not USE_TOOLKIT_SCROLL_BARS */
6928 if (bar)
6929 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6930 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6933 if (event.type == ButtonPress)
6935 dpyinfo->grabbed |= (1 << event.xbutton.button);
6936 last_mouse_frame = f;
6938 if (!tool_bar_p)
6939 last_tool_bar_item = -1;
6941 else
6942 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6944 /* Ignore any mouse motion that happened before this event;
6945 any subsequent mouse-movement Emacs events should reflect
6946 only motion after the ButtonPress/Release. */
6947 if (f != 0)
6948 f->mouse_moved = 0;
6950 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6951 f = x_menubar_window_to_frame (dpyinfo, &event);
6952 /* For a down-event in the menu bar,
6953 don't pass it to Xt right now.
6954 Instead, save it away
6955 and we will pass it to Xt from kbd_buffer_get_event.
6956 That way, we can run some Lisp code first. */
6957 if (! popup_activated ()
6958 #ifdef USE_GTK
6959 /* Gtk+ menus only react to the first three buttons. */
6960 && event.xbutton.button < 3
6961 #endif
6962 && f && event.type == ButtonPress
6963 /* Verify the event is really within the menu bar
6964 and not just sent to it due to grabbing. */
6965 && event.xbutton.x >= 0
6966 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6967 && event.xbutton.y >= 0
6968 && event.xbutton.y < f->output_data.x->menubar_height
6969 && event.xbutton.same_screen)
6971 SET_SAVED_BUTTON_EVENT;
6972 *finish = X_EVENT_DROP;
6974 else
6975 goto OTHER;
6976 #endif /* USE_X_TOOLKIT || USE_GTK */
6978 break;
6980 case CirculateNotify:
6981 goto OTHER;
6983 case CirculateRequest:
6984 goto OTHER;
6986 case VisibilityNotify:
6987 goto OTHER;
6989 case MappingNotify:
6990 /* Someone has changed the keyboard mapping - update the
6991 local cache. */
6992 switch (event.xmapping.request)
6994 case MappingModifier:
6995 x_find_modifier_meanings (dpyinfo);
6996 /* This is meant to fall through. */
6997 case MappingKeyboard:
6998 XRefreshKeyboardMapping (&event.xmapping);
7000 goto OTHER;
7002 case DestroyNotify:
7003 xft_settings_event (dpyinfo, &event);
7004 break;
7006 default:
7007 OTHER:
7008 #ifdef USE_X_TOOLKIT
7009 block_input ();
7010 if (*finish != X_EVENT_DROP)
7011 XtDispatchEvent (&event);
7012 unblock_input ();
7013 #endif /* USE_X_TOOLKIT */
7014 break;
7017 done:
7018 if (inev.ie.kind != NO_EVENT)
7020 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7021 count++;
7024 if (do_help
7025 && !(hold_quit && hold_quit->kind != NO_EVENT))
7027 Lisp_Object frame;
7029 if (f)
7030 XSETFRAME (frame, f);
7031 else
7032 frame = Qnil;
7034 if (do_help > 0)
7036 any_help_event_p = 1;
7037 gen_help_event (help_echo_string, frame, help_echo_window,
7038 help_echo_object, help_echo_pos);
7040 else
7042 help_echo_string = Qnil;
7043 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7045 count++;
7048 SAFE_FREE ();
7049 *eventptr = event;
7050 return count;
7053 #if defined USE_GTK || defined USE_X_TOOLKIT
7055 /* Handles the XEvent EVENT on display DISPLAY.
7056 This is used for event loops outside the normal event handling,
7057 i.e. looping while a popup menu or a dialog is posted.
7059 Returns the value handle_one_xevent sets in the finish argument. */
7061 x_dispatch_event (XEvent *event, Display *display)
7063 struct x_display_info *dpyinfo;
7064 int finish = X_EVENT_NORMAL;
7066 dpyinfo = x_display_info_for_display (display);
7068 if (dpyinfo)
7069 handle_one_xevent (dpyinfo, event, &finish, 0);
7071 return finish;
7073 #endif
7076 /* Read events coming from the X server.
7077 Return as soon as there are no more events to be read.
7079 Return the number of characters stored into the buffer,
7080 thus pretending to be `read' (except the characters we store
7081 in the keyboard buffer can be multibyte, so are not necessarily
7082 C chars). */
7084 static int
7085 XTread_socket (struct terminal *terminal, struct input_event *hold_quit)
7087 int count = 0;
7088 int event_found = 0;
7090 block_input ();
7092 /* So people can tell when we have read the available input. */
7093 input_signal_count++;
7095 /* For debugging, this gives a way to fake an I/O error. */
7096 if (terminal->display_info.x == XTread_socket_fake_io_error)
7098 XTread_socket_fake_io_error = 0;
7099 x_io_error_quitter (terminal->display_info.x->display);
7102 #ifndef USE_GTK
7103 while (XPending (terminal->display_info.x->display))
7105 int finish;
7106 XEvent event;
7108 XNextEvent (terminal->display_info.x->display, &event);
7110 #ifdef HAVE_X_I18N
7111 /* Filter events for the current X input method. */
7112 if (x_filter_event (terminal->display_info.x, &event))
7113 continue;
7114 #endif
7115 event_found = 1;
7117 count += handle_one_xevent (terminal->display_info.x,
7118 &event, &finish, hold_quit);
7120 if (finish == X_EVENT_GOTO_OUT)
7121 goto out;
7124 out:;
7126 #else /* USE_GTK */
7128 /* For GTK we must use the GTK event loop. But XEvents gets passed
7129 to our filter function above, and then to the big event switch.
7130 We use a bunch of globals to communicate with our filter function,
7131 that is kind of ugly, but it works.
7133 There is no way to do one display at the time, GTK just does events
7134 from all displays. */
7136 while (gtk_events_pending ())
7138 current_count = count;
7139 current_hold_quit = hold_quit;
7141 gtk_main_iteration ();
7143 count = current_count;
7144 current_count = -1;
7145 current_hold_quit = 0;
7147 if (current_finish == X_EVENT_GOTO_OUT)
7148 break;
7150 #endif /* USE_GTK */
7152 /* On some systems, an X bug causes Emacs to get no more events
7153 when the window is destroyed. Detect that. (1994.) */
7154 if (! event_found)
7156 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7157 One XNOOP in 100 loops will make Emacs terminate.
7158 B. Bretthauer, 1994 */
7159 x_noop_count++;
7160 if (x_noop_count >= 100)
7162 x_noop_count=0;
7164 if (next_noop_dpyinfo == 0)
7165 next_noop_dpyinfo = x_display_list;
7167 XNoOp (next_noop_dpyinfo->display);
7169 /* Each time we get here, cycle through the displays now open. */
7170 next_noop_dpyinfo = next_noop_dpyinfo->next;
7174 /* If the focus was just given to an auto-raising frame,
7175 raise it now. */
7176 /* ??? This ought to be able to handle more than one such frame. */
7177 if (pending_autoraise_frame)
7179 x_raise_frame (pending_autoraise_frame);
7180 pending_autoraise_frame = 0;
7183 unblock_input ();
7185 return count;
7191 /***********************************************************************
7192 Text Cursor
7193 ***********************************************************************/
7195 /* Set clipping for output in glyph row ROW. W is the window in which
7196 we operate. GC is the graphics context to set clipping in.
7198 ROW may be a text row or, e.g., a mode line. Text rows must be
7199 clipped to the interior of the window dedicated to text display,
7200 mode lines must be clipped to the whole window. */
7202 static void
7203 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7205 struct frame *f = XFRAME (WINDOW_FRAME (w));
7206 XRectangle clip_rect;
7207 int window_x, window_y, window_width;
7209 window_box (w, area, &window_x, &window_y, &window_width, 0);
7211 clip_rect.x = window_x;
7212 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7213 clip_rect.y = max (clip_rect.y, window_y);
7214 clip_rect.width = window_width;
7215 clip_rect.height = row->visible_height;
7217 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7221 /* Draw a hollow box cursor on window W in glyph row ROW. */
7223 static void
7224 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7226 struct frame *f = XFRAME (WINDOW_FRAME (w));
7227 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7228 Display *dpy = FRAME_X_DISPLAY (f);
7229 int x, y, wd, h;
7230 XGCValues xgcv;
7231 struct glyph *cursor_glyph;
7232 GC gc;
7234 /* Get the glyph the cursor is on. If we can't tell because
7235 the current matrix is invalid or such, give up. */
7236 cursor_glyph = get_phys_cursor_glyph (w);
7237 if (cursor_glyph == NULL)
7238 return;
7240 /* Compute frame-relative coordinates for phys cursor. */
7241 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7242 wd = w->phys_cursor_width;
7244 /* The foreground of cursor_gc is typically the same as the normal
7245 background color, which can cause the cursor box to be invisible. */
7246 xgcv.foreground = f->output_data.x->cursor_pixel;
7247 if (dpyinfo->scratch_cursor_gc)
7248 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7249 else
7250 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7251 GCForeground, &xgcv);
7252 gc = dpyinfo->scratch_cursor_gc;
7254 /* Set clipping, draw the rectangle, and reset clipping again. */
7255 x_clip_to_row (w, row, TEXT_AREA, gc);
7256 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7257 XSetClipMask (dpy, gc, None);
7261 /* Draw a bar cursor on window W in glyph row ROW.
7263 Implementation note: One would like to draw a bar cursor with an
7264 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7265 Unfortunately, I didn't find a font yet that has this property set.
7266 --gerd. */
7268 static void
7269 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7271 struct frame *f = XFRAME (w->frame);
7272 struct glyph *cursor_glyph;
7274 /* If cursor is out of bounds, don't draw garbage. This can happen
7275 in mini-buffer windows when switching between echo area glyphs
7276 and mini-buffer. */
7277 cursor_glyph = get_phys_cursor_glyph (w);
7278 if (cursor_glyph == NULL)
7279 return;
7281 /* If on an image, draw like a normal cursor. That's usually better
7282 visible than drawing a bar, esp. if the image is large so that
7283 the bar might not be in the window. */
7284 if (cursor_glyph->type == IMAGE_GLYPH)
7286 struct glyph_row *r;
7287 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7288 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
7290 else
7292 Display *dpy = FRAME_X_DISPLAY (f);
7293 Window window = FRAME_X_WINDOW (f);
7294 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7295 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7296 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7297 XGCValues xgcv;
7299 /* If the glyph's background equals the color we normally draw
7300 the bars cursor in, the bar cursor in its normal color is
7301 invisible. Use the glyph's foreground color instead in this
7302 case, on the assumption that the glyph's colors are chosen so
7303 that the glyph is legible. */
7304 if (face->background == f->output_data.x->cursor_pixel)
7305 xgcv.background = xgcv.foreground = face->foreground;
7306 else
7307 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7308 xgcv.graphics_exposures = 0;
7310 if (gc)
7311 XChangeGC (dpy, gc, mask, &xgcv);
7312 else
7314 gc = XCreateGC (dpy, window, mask, &xgcv);
7315 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7318 x_clip_to_row (w, row, TEXT_AREA, gc);
7320 if (kind == BAR_CURSOR)
7322 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7324 if (width < 0)
7325 width = FRAME_CURSOR_WIDTH (f);
7326 width = min (cursor_glyph->pixel_width, width);
7328 w->phys_cursor_width = width;
7330 /* If the character under cursor is R2L, draw the bar cursor
7331 on the right of its glyph, rather than on the left. */
7332 if ((cursor_glyph->resolved_level & 1) != 0)
7333 x += cursor_glyph->pixel_width - width;
7335 XFillRectangle (dpy, window, gc, x,
7336 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7337 width, row->height);
7339 else
7341 int dummy_x, dummy_y, dummy_h;
7343 if (width < 0)
7344 width = row->height;
7346 width = min (row->height, width);
7348 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7349 &dummy_y, &dummy_h);
7351 XFillRectangle (dpy, window, gc,
7352 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7353 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7354 row->height - width),
7355 w->phys_cursor_width, width);
7358 XSetClipMask (dpy, gc, None);
7363 /* RIF: Define cursor CURSOR on frame F. */
7365 static void
7366 x_define_frame_cursor (struct frame *f, Cursor cursor)
7368 if (!f->pointer_invisible
7369 && f->output_data.x->current_cursor != cursor)
7370 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7371 f->output_data.x->current_cursor = cursor;
7375 /* RIF: Clear area on frame F. */
7377 static void
7378 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7380 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7381 x, y, width, height, False);
7382 #ifdef USE_GTK
7383 /* Must queue a redraw, because scroll bars might have been cleared. */
7384 if (FRAME_GTK_WIDGET (f))
7385 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7386 #endif
7390 /* RIF: Draw cursor on window W. */
7392 static void
7393 x_draw_window_cursor (struct window *w, struct glyph_row *glyph_row, int x, int y, int cursor_type, int cursor_width, int on_p, int active_p)
7395 struct frame *f = XFRAME (WINDOW_FRAME (w));
7397 if (on_p)
7399 w->phys_cursor_type = cursor_type;
7400 w->phys_cursor_on_p = 1;
7402 if (glyph_row->exact_window_width_line_p
7403 && (glyph_row->reversed_p
7404 ? (w->phys_cursor.hpos < 0)
7405 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7407 glyph_row->cursor_in_fringe_p = 1;
7408 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7410 else
7412 switch (cursor_type)
7414 case HOLLOW_BOX_CURSOR:
7415 x_draw_hollow_cursor (w, glyph_row);
7416 break;
7418 case FILLED_BOX_CURSOR:
7419 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7420 break;
7422 case BAR_CURSOR:
7423 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7424 break;
7426 case HBAR_CURSOR:
7427 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7428 break;
7430 case NO_CURSOR:
7431 w->phys_cursor_width = 0;
7432 break;
7434 default:
7435 emacs_abort ();
7439 #ifdef HAVE_X_I18N
7440 if (w == XWINDOW (f->selected_window))
7441 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7442 xic_set_preeditarea (w, x, y);
7443 #endif
7446 #ifndef XFlush
7447 XFlush (FRAME_X_DISPLAY (f));
7448 #endif
7452 /* Icons. */
7454 /* Make the x-window of frame F use the gnu icon bitmap. */
7457 x_bitmap_icon (struct frame *f, Lisp_Object file)
7459 ptrdiff_t bitmap_id;
7461 if (FRAME_X_WINDOW (f) == 0)
7462 return 1;
7464 /* Free up our existing icon bitmap and mask if any. */
7465 if (f->output_data.x->icon_bitmap > 0)
7466 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7467 f->output_data.x->icon_bitmap = 0;
7469 if (STRINGP (file))
7471 #ifdef USE_GTK
7472 /* Use gtk_window_set_icon_from_file () if available,
7473 It's not restricted to bitmaps */
7474 if (xg_set_icon (f, file))
7475 return 0;
7476 #endif /* USE_GTK */
7477 bitmap_id = x_create_bitmap_from_file (f, file);
7478 x_create_bitmap_mask (f, bitmap_id);
7480 else
7482 /* Create the GNU bitmap and mask if necessary. */
7483 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7485 ptrdiff_t rc = -1;
7487 #ifdef USE_GTK
7489 if (xg_set_icon (f, xg_default_icon_file)
7490 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7491 return 0;
7493 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7495 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7496 if (rc != -1)
7497 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7499 #endif
7501 /* If all else fails, use the (black and white) xbm image. */
7502 if (rc == -1)
7504 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
7505 gnu_xbm_width, gnu_xbm_height);
7506 if (rc == -1)
7507 return 1;
7509 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7510 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7514 /* The first time we create the GNU bitmap and mask,
7515 this increments the ref-count one extra time.
7516 As a result, the GNU bitmap and mask are never freed.
7517 That way, we don't have to worry about allocating it again. */
7518 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7520 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7523 x_wm_set_icon_pixmap (f, bitmap_id);
7524 f->output_data.x->icon_bitmap = bitmap_id;
7526 return 0;
7530 /* Make the x-window of frame F use a rectangle with text.
7531 Use ICON_NAME as the text. */
7534 x_text_icon (struct frame *f, const char *icon_name)
7536 if (FRAME_X_WINDOW (f) == 0)
7537 return 1;
7540 XTextProperty text;
7541 text.value = (unsigned char *) icon_name;
7542 text.encoding = XA_STRING;
7543 text.format = 8;
7544 text.nitems = strlen (icon_name);
7545 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7548 if (f->output_data.x->icon_bitmap > 0)
7549 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7550 f->output_data.x->icon_bitmap = 0;
7551 x_wm_set_icon_pixmap (f, 0);
7553 return 0;
7556 #define X_ERROR_MESSAGE_SIZE 200
7558 /* If non-nil, this should be a string.
7559 It means catch X errors and store the error message in this string.
7561 The reason we use a stack is that x_catch_error/x_uncatch_error can
7562 be called from a signal handler.
7565 struct x_error_message_stack {
7566 char string[X_ERROR_MESSAGE_SIZE];
7567 Display *dpy;
7568 struct x_error_message_stack *prev;
7570 static struct x_error_message_stack *x_error_message;
7572 /* An X error handler which stores the error message in
7573 *x_error_message. This is called from x_error_handler if
7574 x_catch_errors is in effect. */
7576 static void
7577 x_error_catcher (Display *display, XErrorEvent *event)
7579 XGetErrorText (display, event->error_code,
7580 x_error_message->string,
7581 X_ERROR_MESSAGE_SIZE);
7584 /* Begin trapping X errors for display DPY. Actually we trap X errors
7585 for all displays, but DPY should be the display you are actually
7586 operating on.
7588 After calling this function, X protocol errors no longer cause
7589 Emacs to exit; instead, they are recorded in the string
7590 stored in *x_error_message.
7592 Calling x_check_errors signals an Emacs error if an X error has
7593 occurred since the last call to x_catch_errors or x_check_errors.
7595 Calling x_uncatch_errors resumes the normal error handling. */
7597 void
7598 x_catch_errors (Display *dpy)
7600 struct x_error_message_stack *data = xmalloc (sizeof *data);
7602 /* Make sure any errors from previous requests have been dealt with. */
7603 XSync (dpy, False);
7605 data->dpy = dpy;
7606 data->string[0] = 0;
7607 data->prev = x_error_message;
7608 x_error_message = data;
7611 /* Undo the last x_catch_errors call.
7612 DPY should be the display that was passed to x_catch_errors. */
7614 void
7615 x_uncatch_errors (void)
7617 struct x_error_message_stack *tmp;
7619 block_input ();
7621 /* The display may have been closed before this function is called.
7622 Check if it is still open before calling XSync. */
7623 if (x_display_info_for_display (x_error_message->dpy) != 0)
7624 XSync (x_error_message->dpy, False);
7626 tmp = x_error_message;
7627 x_error_message = x_error_message->prev;
7628 xfree (tmp);
7629 unblock_input ();
7632 /* If any X protocol errors have arrived since the last call to
7633 x_catch_errors or x_check_errors, signal an Emacs error using
7634 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7636 void
7637 x_check_errors (Display *dpy, const char *format)
7639 /* Make sure to catch any errors incurred so far. */
7640 XSync (dpy, False);
7642 if (x_error_message->string[0])
7644 char string[X_ERROR_MESSAGE_SIZE];
7645 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7646 x_uncatch_errors ();
7647 error (format, string);
7651 /* Nonzero if we had any X protocol errors
7652 since we did x_catch_errors on DPY. */
7654 bool
7655 x_had_errors_p (Display *dpy)
7657 /* Make sure to catch any errors incurred so far. */
7658 XSync (dpy, False);
7660 return x_error_message->string[0] != 0;
7663 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7665 void
7666 x_clear_errors (Display *dpy)
7668 x_error_message->string[0] = 0;
7671 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7672 * idea. --lorentey */
7673 /* Close off all unclosed x_catch_errors calls. */
7675 void
7676 x_fully_uncatch_errors (void)
7678 while (x_error_message)
7679 x_uncatch_errors ();
7681 #endif
7683 #if 0
7684 static unsigned int x_wire_count;
7685 x_trace_wire (void)
7687 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7689 #endif /* ! 0 */
7692 /************************************************************************
7693 Handling X errors
7694 ************************************************************************/
7696 /* Error message passed to x_connection_closed. */
7698 static char *error_msg;
7700 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7701 the text of an error message that lead to the connection loss. */
7703 static void
7704 x_connection_closed (Display *dpy, const char *error_message)
7706 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7707 Lisp_Object frame, tail;
7708 ptrdiff_t idx = SPECPDL_INDEX ();
7710 error_msg = alloca (strlen (error_message) + 1);
7711 strcpy (error_msg, error_message);
7713 /* Inhibit redisplay while frames are being deleted. */
7714 specbind (Qinhibit_redisplay, Qt);
7716 if (dpyinfo)
7718 /* Protect display from being closed when we delete the last
7719 frame on it. */
7720 dpyinfo->reference_count++;
7721 dpyinfo->terminal->reference_count++;
7724 /* First delete frames whose mini-buffers are on frames
7725 that are on the dead display. */
7726 FOR_EACH_FRAME (tail, frame)
7728 Lisp_Object minibuf_frame;
7729 minibuf_frame
7730 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7731 if (FRAME_X_P (XFRAME (frame))
7732 && FRAME_X_P (XFRAME (minibuf_frame))
7733 && ! EQ (frame, minibuf_frame)
7734 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7735 delete_frame (frame, Qnoelisp);
7738 /* Now delete all remaining frames on the dead display.
7739 We are now sure none of these is used as the mini-buffer
7740 for another frame that we need to delete. */
7741 FOR_EACH_FRAME (tail, frame)
7742 if (FRAME_X_P (XFRAME (frame))
7743 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7745 /* Set this to t so that delete_frame won't get confused
7746 trying to find a replacement. */
7747 kset_default_minibuffer_frame (FRAME_KBOARD (XFRAME (frame)), Qt);
7748 delete_frame (frame, Qnoelisp);
7751 /* If DPYINFO is null, this means we didn't open the display in the
7752 first place, so don't try to close it. */
7753 if (dpyinfo)
7755 /* We can not call XtCloseDisplay here because it calls XSync.
7756 XSync inside the error handler apparently hangs Emacs. On
7757 current Xt versions, this isn't needed either. */
7758 #ifdef USE_GTK
7759 /* A long-standing GTK bug prevents proper disconnect handling
7760 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7761 the resulting Glib error message loop filled a user's disk.
7762 To avoid this, kill Emacs unconditionally on disconnect. */
7763 shut_down_emacs (0, Qnil);
7764 fprintf (stderr, "%s\n\
7765 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7766 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7767 For details, see etc/PROBLEMS.\n",
7768 error_msg);
7769 emacs_abort ();
7770 #endif /* USE_GTK */
7772 /* Indicate that this display is dead. */
7773 dpyinfo->display = 0;
7775 dpyinfo->reference_count--;
7776 dpyinfo->terminal->reference_count--;
7777 if (dpyinfo->reference_count != 0)
7778 /* We have just closed all frames on this display. */
7779 emacs_abort ();
7782 Lisp_Object tmp;
7783 XSETTERMINAL (tmp, dpyinfo->terminal);
7784 Fdelete_terminal (tmp, Qnoelisp);
7788 if (terminal_list == 0)
7790 fprintf (stderr, "%s\n", error_msg);
7791 Fkill_emacs (make_number (70));
7792 /* NOTREACHED */
7795 totally_unblock_input ();
7797 unbind_to (idx, Qnil);
7798 clear_waiting_for_input ();
7800 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
7801 IF_LINT (if (! terminal_list) return; )
7803 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7804 longjmp), because returning from this function would get us back into
7805 Xlib's code which will directly call `exit'. */
7806 error ("%s", error_msg);
7809 /* We specifically use it before defining it, so that gcc doesn't inline it,
7810 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7811 static void x_error_quitter (Display *, XErrorEvent *);
7813 /* This is the first-level handler for X protocol errors.
7814 It calls x_error_quitter or x_error_catcher. */
7816 static int
7817 x_error_handler (Display *display, XErrorEvent *event)
7819 #if defined USE_GTK && defined HAVE_GTK3
7820 if (event->error_code == BadMatch
7821 && event->request_code == X_SetInputFocus
7822 && event->minor_code == 0)
7824 return 0;
7826 #endif
7828 if (x_error_message)
7829 x_error_catcher (display, event);
7830 else
7831 x_error_quitter (display, event);
7832 return 0;
7835 /* This is the usual handler for X protocol errors.
7836 It kills all frames on the display that we got the error for.
7837 If that was the only one, it prints an error message and kills Emacs. */
7839 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7841 /* On older GCC versions, just putting x_error_quitter
7842 after x_error_handler prevents inlining into the former. */
7844 static void NO_INLINE
7845 x_error_quitter (Display *display, XErrorEvent *event)
7847 char buf[256], buf1[356];
7849 /* Ignore BadName errors. They can happen because of fonts
7850 or colors that are not defined. */
7852 if (event->error_code == BadName)
7853 return;
7855 /* Note that there is no real way portable across R3/R4 to get the
7856 original error handler. */
7858 XGetErrorText (display, event->error_code, buf, sizeof (buf));
7859 sprintf (buf1, "X protocol error: %s on protocol request %d",
7860 buf, event->request_code);
7861 x_connection_closed (display, buf1);
7865 /* This is the handler for X IO errors, always.
7866 It kills all frames on the display that we lost touch with.
7867 If that was the only one, it prints an error message and kills Emacs. */
7869 static int
7870 x_io_error_quitter (Display *display)
7872 char buf[256];
7874 snprintf (buf, sizeof buf, "Connection lost to X server `%s'",
7875 DisplayString (display));
7876 x_connection_closed (display, buf);
7877 return 0;
7880 /* Changing the font of the frame. */
7882 /* Give frame F the font FONT-OBJECT as its default font. The return
7883 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7884 frame. If it is negative, generate a new fontset from
7885 FONT-OBJECT. */
7887 Lisp_Object
7888 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7890 struct font *font = XFONT_OBJECT (font_object);
7892 if (fontset < 0)
7893 fontset = fontset_from_font (font_object);
7894 FRAME_FONTSET (f) = fontset;
7895 if (FRAME_FONT (f) == font)
7896 /* This font is already set in frame F. There's nothing more to
7897 do. */
7898 return font_object;
7900 FRAME_FONT (f) = font;
7901 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7902 FRAME_COLUMN_WIDTH (f) = font->average_width;
7903 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7905 compute_fringe_widths (f, 1);
7907 /* Compute the scroll bar width in character columns. */
7908 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7910 int wid = FRAME_COLUMN_WIDTH (f);
7911 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7912 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7914 else
7916 int wid = FRAME_COLUMN_WIDTH (f);
7917 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7920 if (FRAME_X_WINDOW (f) != 0)
7922 /* Don't change the size of a tip frame; there's no point in
7923 doing it because it's done in Fx_show_tip, and it leads to
7924 problems because the tip frame has no widget. */
7925 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7926 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7929 #ifdef HAVE_X_I18N
7930 if (FRAME_XIC (f)
7931 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7933 block_input ();
7934 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7935 unblock_input ();
7937 #endif
7939 return font_object;
7943 /***********************************************************************
7944 X Input Methods
7945 ***********************************************************************/
7947 #ifdef HAVE_X_I18N
7949 #ifdef HAVE_X11R6
7951 /* XIM destroy callback function, which is called whenever the
7952 connection to input method XIM dies. CLIENT_DATA contains a
7953 pointer to the x_display_info structure corresponding to XIM. */
7955 static void
7956 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7958 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7959 Lisp_Object frame, tail;
7961 block_input ();
7963 /* No need to call XDestroyIC.. */
7964 FOR_EACH_FRAME (tail, frame)
7966 struct frame *f = XFRAME (frame);
7967 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7969 FRAME_XIC (f) = NULL;
7970 xic_free_xfontset (f);
7974 /* No need to call XCloseIM. */
7975 dpyinfo->xim = NULL;
7976 XFree (dpyinfo->xim_styles);
7977 unblock_input ();
7980 #endif /* HAVE_X11R6 */
7982 #ifdef HAVE_X11R6
7983 /* This isn't prototyped in OSF 5.0 or 5.1a. */
7984 extern char *XSetIMValues (XIM, ...);
7985 #endif
7987 /* Open the connection to the XIM server on display DPYINFO.
7988 RESOURCE_NAME is the resource name Emacs uses. */
7990 static void
7991 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
7993 XIM xim;
7995 #ifdef HAVE_XIM
7996 if (use_xim)
7998 if (dpyinfo->xim)
7999 XCloseIM (dpyinfo->xim);
8000 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8001 emacs_class);
8002 dpyinfo->xim = xim;
8004 if (xim)
8006 #ifdef HAVE_X11R6
8007 XIMCallback destroy;
8008 #endif
8010 /* Get supported styles and XIM values. */
8011 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8013 #ifdef HAVE_X11R6
8014 destroy.callback = xim_destroy_callback;
8015 destroy.client_data = (XPointer)dpyinfo;
8016 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8017 #endif
8021 else
8022 #endif /* HAVE_XIM */
8023 dpyinfo->xim = NULL;
8027 #ifdef HAVE_X11R6_XIM
8029 /* XIM instantiate callback function, which is called whenever an XIM
8030 server is available. DISPLAY is the display of the XIM.
8031 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8032 when the callback was registered. */
8034 static void
8035 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8037 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8038 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8040 /* We don't support multiple XIM connections. */
8041 if (dpyinfo->xim)
8042 return;
8044 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8046 /* Create XIC for the existing frames on the same display, as long
8047 as they have no XIC. */
8048 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8050 Lisp_Object tail, frame;
8052 block_input ();
8053 FOR_EACH_FRAME (tail, frame)
8055 struct frame *f = XFRAME (frame);
8057 if (FRAME_X_P (f)
8058 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8059 if (FRAME_XIC (f) == NULL)
8061 create_frame_xic (f);
8062 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8063 xic_set_statusarea (f);
8064 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8066 struct window *w = XWINDOW (f->selected_window);
8067 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8072 unblock_input ();
8076 #endif /* HAVE_X11R6_XIM */
8079 /* Open a connection to the XIM server on display DPYINFO.
8080 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8081 connection only at the first time. On X11R6, open the connection
8082 in the XIM instantiate callback function. */
8084 static void
8085 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8087 dpyinfo->xim = NULL;
8088 #ifdef HAVE_XIM
8089 if (use_xim)
8091 #ifdef HAVE_X11R6_XIM
8092 struct xim_inst_t *xim_inst = xmalloc (sizeof *xim_inst);
8093 ptrdiff_t len;
8095 dpyinfo->xim_callback_data = xim_inst;
8096 xim_inst->dpyinfo = dpyinfo;
8097 len = strlen (resource_name);
8098 xim_inst->resource_name = xmalloc (len + 1);
8099 memcpy (xim_inst->resource_name, resource_name, len + 1);
8100 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8101 resource_name, emacs_class,
8102 xim_instantiate_callback,
8103 /* This is XPointer in XFree86
8104 but (XPointer *) on Tru64, at
8105 least, hence the configure test. */
8106 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8107 #else /* not HAVE_X11R6_XIM */
8108 xim_open_dpy (dpyinfo, resource_name);
8109 #endif /* not HAVE_X11R6_XIM */
8111 #endif /* HAVE_XIM */
8115 /* Close the connection to the XIM server on display DPYINFO. */
8117 static void
8118 xim_close_dpy (struct x_display_info *dpyinfo)
8120 #ifdef HAVE_XIM
8121 if (use_xim)
8123 #ifdef HAVE_X11R6_XIM
8124 if (dpyinfo->display)
8125 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8126 NULL, emacs_class,
8127 xim_instantiate_callback, NULL);
8128 xfree (dpyinfo->xim_callback_data->resource_name);
8129 xfree (dpyinfo->xim_callback_data);
8130 #endif /* HAVE_X11R6_XIM */
8131 if (dpyinfo->display)
8132 XCloseIM (dpyinfo->xim);
8133 dpyinfo->xim = NULL;
8134 XFree (dpyinfo->xim_styles);
8136 #endif /* HAVE_XIM */
8139 #endif /* not HAVE_X11R6_XIM */
8143 /* Calculate the absolute position in frame F
8144 from its current recorded position values and gravity. */
8146 static void
8147 x_calc_absolute_position (struct frame *f)
8149 int flags = f->size_hint_flags;
8151 /* We have nothing to do if the current position
8152 is already for the top-left corner. */
8153 if (! ((flags & XNegative) || (flags & YNegative)))
8154 return;
8156 /* Treat negative positions as relative to the leftmost bottommost
8157 position that fits on the screen. */
8158 if (flags & XNegative)
8159 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8160 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8163 int height = FRAME_PIXEL_HEIGHT (f);
8165 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8166 /* Something is fishy here. When using Motif, starting Emacs with
8167 `-g -0-0', the frame appears too low by a few pixels.
8169 This seems to be so because initially, while Emacs is starting,
8170 the column widget's height and the frame's pixel height are
8171 different. The column widget's height is the right one. In
8172 later invocations, when Emacs is up, the frame's pixel height
8173 is right, though.
8175 It's not obvious where the initial small difference comes from.
8176 2000-12-01, gerd. */
8178 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8179 #endif
8181 if (flags & YNegative)
8182 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8183 - height + f->top_pos;
8186 /* The left_pos and top_pos
8187 are now relative to the top and left screen edges,
8188 so the flags should correspond. */
8189 f->size_hint_flags &= ~ (XNegative | YNegative);
8192 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8193 to really change the position, and 0 when calling from
8194 x_make_frame_visible (in that case, XOFF and YOFF are the current
8195 position values). It is -1 when calling from x_set_frame_parameters,
8196 which means, do adjust for borders but don't change the gravity. */
8198 void
8199 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8201 int modified_top, modified_left;
8203 if (change_gravity > 0)
8205 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8206 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8208 f->top_pos = yoff;
8209 f->left_pos = xoff;
8210 f->size_hint_flags &= ~ (XNegative | YNegative);
8211 if (xoff < 0)
8212 f->size_hint_flags |= XNegative;
8213 if (yoff < 0)
8214 f->size_hint_flags |= YNegative;
8215 f->win_gravity = NorthWestGravity;
8217 x_calc_absolute_position (f);
8219 block_input ();
8220 x_wm_set_size_hint (f, (long) 0, 0);
8222 modified_left = f->left_pos;
8223 modified_top = f->top_pos;
8225 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8227 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8228 than the WM decorations. So we use the calculated offset instead
8229 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8230 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8231 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8234 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8235 modified_left, modified_top);
8237 x_sync_with_move (f, f->left_pos, f->top_pos,
8238 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8239 ? 1 : 0);
8241 /* change_gravity is non-zero when this function is called from Lisp to
8242 programmatically move a frame. In that case, we call
8243 x_check_expected_move to discover if we have a "Type A" or "Type B"
8244 window manager, and, for a "Type A" window manager, adjust the position
8245 of the frame.
8247 We call x_check_expected_move if a programmatic move occurred, and
8248 either the window manager type (A/B) is unknown or it is Type A but we
8249 need to compute the top/left offset adjustment for this frame. */
8251 if (change_gravity != 0 &&
8252 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8253 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8254 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8255 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8256 x_check_expected_move (f, modified_left, modified_top);
8258 unblock_input ();
8261 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8262 on the root window for frame F contains ATOMNAME.
8263 This is how a WM check shall be done according to the Window Manager
8264 Specification/Extended Window Manager Hints at
8265 http://freedesktop.org/wiki/Specifications/wm-spec. */
8267 static int
8268 wm_supports (struct frame *f, Atom want_atom)
8270 Atom actual_type;
8271 unsigned long actual_size, bytes_remaining;
8272 int i, rc, actual_format;
8273 Window wmcheck_window;
8274 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8275 Window target_window = dpyinfo->root_window;
8276 long max_len = 65536;
8277 Display *dpy = FRAME_X_DISPLAY (f);
8278 unsigned char *tmp_data = NULL;
8279 Atom target_type = XA_WINDOW;
8281 block_input ();
8283 x_catch_errors (dpy);
8284 rc = XGetWindowProperty (dpy, target_window,
8285 dpyinfo->Xatom_net_supporting_wm_check,
8286 0, max_len, False, target_type,
8287 &actual_type, &actual_format, &actual_size,
8288 &bytes_remaining, &tmp_data);
8290 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8292 if (tmp_data) XFree (tmp_data);
8293 x_uncatch_errors ();
8294 unblock_input ();
8295 return 0;
8298 wmcheck_window = *(Window *) tmp_data;
8299 XFree (tmp_data);
8301 /* Check if window exists. */
8302 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8303 x_sync (f);
8304 if (x_had_errors_p (dpy))
8306 x_uncatch_errors ();
8307 unblock_input ();
8308 return 0;
8311 if (dpyinfo->net_supported_window != wmcheck_window)
8313 /* Window changed, reload atoms */
8314 if (dpyinfo->net_supported_atoms != NULL)
8315 XFree (dpyinfo->net_supported_atoms);
8316 dpyinfo->net_supported_atoms = NULL;
8317 dpyinfo->nr_net_supported_atoms = 0;
8318 dpyinfo->net_supported_window = 0;
8320 target_type = XA_ATOM;
8321 tmp_data = NULL;
8322 rc = XGetWindowProperty (dpy, target_window,
8323 dpyinfo->Xatom_net_supported,
8324 0, max_len, False, target_type,
8325 &actual_type, &actual_format, &actual_size,
8326 &bytes_remaining, &tmp_data);
8328 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8330 if (tmp_data) XFree (tmp_data);
8331 x_uncatch_errors ();
8332 unblock_input ();
8333 return 0;
8336 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8337 dpyinfo->nr_net_supported_atoms = actual_size;
8338 dpyinfo->net_supported_window = wmcheck_window;
8341 rc = 0;
8343 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8344 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8346 x_uncatch_errors ();
8347 unblock_input ();
8349 return rc;
8352 static void
8353 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8355 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8357 x_send_client_event (frame, make_number (0), frame,
8358 dpyinfo->Xatom_net_wm_state,
8359 make_number (32),
8360 /* 1 = add, 0 = remove */
8361 Fcons
8362 (make_number (add ? 1 : 0),
8363 Fcons
8364 (make_fixnum_or_float (atom),
8365 (value != 0
8366 ? list1 (make_fixnum_or_float (value))
8367 : Qnil))));
8370 void
8371 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8373 Lisp_Object frame;
8374 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8376 XSETFRAME (frame, f);
8378 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8379 dpyinfo->Xatom_net_wm_state_sticky, None);
8382 /* Return the current _NET_WM_STATE.
8383 SIZE_STATE is set to one of the FULLSCREEN_* values.
8384 STICKY is set to 1 if the sticky state is set, 0 if not.
8386 Return non-zero if we are not hidden, zero if we are. */
8388 static int
8389 get_current_wm_state (struct frame *f,
8390 Window window,
8391 int *size_state,
8392 int *sticky)
8394 Atom actual_type;
8395 unsigned long actual_size, bytes_remaining;
8396 int i, rc, actual_format, is_hidden = 0;
8397 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8398 long max_len = 65536;
8399 Display *dpy = FRAME_X_DISPLAY (f);
8400 unsigned char *tmp_data = NULL;
8401 Atom target_type = XA_ATOM;
8403 *sticky = 0;
8404 *size_state = FULLSCREEN_NONE;
8406 block_input ();
8407 x_catch_errors (dpy);
8408 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8409 0, max_len, False, target_type,
8410 &actual_type, &actual_format, &actual_size,
8411 &bytes_remaining, &tmp_data);
8413 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8415 if (tmp_data) XFree (tmp_data);
8416 x_uncatch_errors ();
8417 unblock_input ();
8418 return !FRAME_ICONIFIED_P (f);
8421 x_uncatch_errors ();
8423 for (i = 0; i < actual_size; ++i)
8425 Atom a = ((Atom*)tmp_data)[i];
8426 if (a == dpyinfo->Xatom_net_wm_state_hidden)
8428 is_hidden = 1;
8429 f->output_data.x->net_wm_state_hidden_seen = 1;
8431 else if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8433 if (*size_state == FULLSCREEN_HEIGHT)
8434 *size_state = FULLSCREEN_MAXIMIZED;
8435 else
8436 *size_state = FULLSCREEN_WIDTH;
8438 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8440 if (*size_state == FULLSCREEN_WIDTH)
8441 *size_state = FULLSCREEN_MAXIMIZED;
8442 else
8443 *size_state = FULLSCREEN_HEIGHT;
8445 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8446 *size_state = FULLSCREEN_BOTH;
8447 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8448 *sticky = 1;
8451 if (tmp_data) XFree (tmp_data);
8452 unblock_input ();
8453 return ! is_hidden;
8456 /* Do fullscreen as specified in extended window manager hints */
8458 static int
8459 do_ewmh_fullscreen (struct frame *f)
8461 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8462 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8463 int cur, dummy;
8465 (void)get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8467 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8468 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8469 if (!have_net_atom)
8470 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8472 if (have_net_atom && cur != f->want_fullscreen)
8474 Lisp_Object frame;
8476 XSETFRAME (frame, f);
8478 /* Keep number of calls to set_wm_state as low as possible.
8479 Some window managers, or possible Gtk+, hangs when too many
8480 are sent at once. */
8481 switch (f->want_fullscreen)
8483 case FULLSCREEN_BOTH:
8484 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8485 || cur == FULLSCREEN_HEIGHT)
8486 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8487 dpyinfo->Xatom_net_wm_state_maximized_vert);
8488 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8489 break;
8490 case FULLSCREEN_WIDTH:
8491 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8492 || cur == FULLSCREEN_MAXIMIZED)
8493 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8494 dpyinfo->Xatom_net_wm_state_maximized_vert);
8495 if (cur != FULLSCREEN_MAXIMIZED)
8496 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8497 break;
8498 case FULLSCREEN_HEIGHT:
8499 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8500 || cur == FULLSCREEN_MAXIMIZED)
8501 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8502 dpyinfo->Xatom_net_wm_state_maximized_horz);
8503 if (cur != FULLSCREEN_MAXIMIZED)
8504 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8505 break;
8506 case FULLSCREEN_MAXIMIZED:
8507 if (cur == FULLSCREEN_BOTH)
8508 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8509 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8510 dpyinfo->Xatom_net_wm_state_maximized_vert);
8511 break;
8512 case FULLSCREEN_NONE:
8513 if (cur == FULLSCREEN_BOTH)
8514 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8515 else
8516 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8517 dpyinfo->Xatom_net_wm_state_maximized_vert);
8520 f->want_fullscreen = FULLSCREEN_NONE;
8524 return have_net_atom;
8527 static void
8528 XTfullscreen_hook (struct frame *f)
8530 if (FRAME_VISIBLE_P (f))
8532 block_input ();
8533 x_check_fullscreen (f);
8534 x_sync (f);
8535 unblock_input ();
8540 static int
8541 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8543 int value = FULLSCREEN_NONE;
8544 Lisp_Object lval;
8545 int sticky = 0;
8546 int not_hidden = get_current_wm_state (f, event->window, &value, &sticky);
8548 lval = Qnil;
8549 switch (value)
8551 case FULLSCREEN_WIDTH:
8552 lval = Qfullwidth;
8553 break;
8554 case FULLSCREEN_HEIGHT:
8555 lval = Qfullheight;
8556 break;
8557 case FULLSCREEN_BOTH:
8558 lval = Qfullboth;
8559 break;
8560 case FULLSCREEN_MAXIMIZED:
8561 lval = Qmaximized;
8562 break;
8565 store_frame_param (f, Qfullscreen, lval);
8566 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8568 return not_hidden;
8571 /* Check if we need to resize the frame due to a fullscreen request.
8572 If so needed, resize the frame. */
8573 static void
8574 x_check_fullscreen (struct frame *f)
8576 if (do_ewmh_fullscreen (f))
8577 return;
8579 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8580 return; /* Only fullscreen without WM or with EWM hints (above). */
8582 /* Setting fullscreen to nil doesn't do anything. We could save the
8583 last non-fullscreen size and restore it, but it seems like a
8584 lot of work for this unusual case (no window manager running). */
8586 if (f->want_fullscreen != FULLSCREEN_NONE)
8588 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8589 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8591 switch (f->want_fullscreen)
8593 /* No difference between these two when there is no WM */
8594 case FULLSCREEN_BOTH:
8595 case FULLSCREEN_MAXIMIZED:
8596 width = x_display_pixel_width (dpyinfo);
8597 height = x_display_pixel_height (dpyinfo);
8598 break;
8599 case FULLSCREEN_WIDTH:
8600 width = x_display_pixel_width (dpyinfo);
8601 break;
8602 case FULLSCREEN_HEIGHT:
8603 height = x_display_pixel_height (dpyinfo);
8606 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8607 width, height);
8611 /* This function is called by x_set_offset to determine whether the window
8612 manager interfered with the positioning of the frame. Type A window
8613 managers position the surrounding window manager decorations a small
8614 amount above and left of the user-supplied position. Type B window
8615 managers position the surrounding window manager decorations at the
8616 user-specified position. If we detect a Type A window manager, we
8617 compensate by moving the window right and down by the proper amount. */
8619 static void
8620 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8622 int current_left = 0, current_top = 0;
8624 /* x_real_positions returns the left and top offsets of the outermost
8625 window manager window around the frame. */
8627 x_real_positions (f, &current_left, &current_top);
8629 if (current_left != expected_left || current_top != expected_top)
8631 /* It's a "Type A" window manager. */
8633 int adjusted_left;
8634 int adjusted_top;
8636 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8637 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8638 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8640 /* Now fix the mispositioned frame's location. */
8642 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8643 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8645 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8646 adjusted_left, adjusted_top);
8648 x_sync_with_move (f, expected_left, expected_top, 0);
8650 else
8651 /* It's a "Type B" window manager. We don't have to adjust the
8652 frame's position. */
8654 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8658 /* Wait for XGetGeometry to return up-to-date position information for a
8659 recently-moved frame. Call this immediately after calling XMoveWindow.
8660 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8661 frame has been moved to, so we use a fuzzy position comparison instead
8662 of an exact comparison. */
8664 static void
8665 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8667 int count = 0;
8669 while (count++ < 50)
8671 int current_left = 0, current_top = 0;
8673 /* In theory, this call to XSync only needs to happen once, but in
8674 practice, it doesn't seem to work, hence the need for the surrounding
8675 loop. */
8677 XSync (FRAME_X_DISPLAY (f), False);
8678 x_real_positions (f, &current_left, &current_top);
8680 if (fuzzy)
8682 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8683 pixels. */
8685 if (eabs (current_left - left) <= 10
8686 && eabs (current_top - top) <= 40)
8687 return;
8689 else if (current_left == left && current_top == top)
8690 return;
8693 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8694 will then return up-to-date position info. */
8696 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8700 /* Wait for an event on frame F matching EVENTTYPE. */
8701 void
8702 x_wait_for_event (struct frame *f, int eventtype)
8704 int level = interrupt_input_blocked;
8706 SELECT_TYPE fds;
8707 EMACS_TIME tmo, tmo_at, time_now;
8708 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8710 pending_event_wait.f = f;
8711 pending_event_wait.eventtype = eventtype;
8713 /* Set timeout to 0.1 second. Hopefully not noticeable.
8714 Maybe it should be configurable. */
8715 tmo = make_emacs_time (0, 100 * 1000 * 1000);
8716 tmo_at = add_emacs_time (current_emacs_time (), tmo);
8718 while (pending_event_wait.eventtype)
8720 pending_signals = 1;
8721 totally_unblock_input ();
8722 /* XTread_socket is called after unblock. */
8723 block_input ();
8724 interrupt_input_blocked = level;
8726 FD_ZERO (&fds);
8727 FD_SET (fd, &fds);
8729 time_now = current_emacs_time ();
8730 if (EMACS_TIME_LT (tmo_at, time_now))
8731 break;
8733 tmo = sub_emacs_time (tmo_at, time_now);
8734 if (pselect (fd + 1, &fds, NULL, NULL, &tmo, NULL) == 0)
8735 break; /* Timeout */
8737 pending_event_wait.f = 0;
8738 pending_event_wait.eventtype = 0;
8742 /* Change the size of frame F's X window to COLS/ROWS in the case F
8743 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8744 top-left-corner window gravity for this size change and subsequent
8745 size changes. Otherwise we leave the window gravity unchanged. */
8747 static void
8748 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8750 int pixelwidth, pixelheight;
8752 check_frame_size (f, &rows, &cols);
8753 f->scroll_bar_actual_width
8754 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8756 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8758 compute_fringe_widths (f, 0);
8760 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8761 + FRAME_TOOLBAR_WIDTH (f);
8762 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8763 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8765 if (change_gravity) f->win_gravity = NorthWestGravity;
8766 x_wm_set_size_hint (f, (long) 0, 0);
8767 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8768 pixelwidth, pixelheight);
8771 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8772 receive in the ConfigureNotify event; if we get what we asked
8773 for, then the event won't cause the screen to become garbaged, so
8774 we have to make sure to do it here. */
8775 SET_FRAME_GARBAGED (f);
8777 /* Now, strictly speaking, we can't be sure that this is accurate,
8778 but the window manager will get around to dealing with the size
8779 change request eventually, and we'll hear how it went when the
8780 ConfigureNotify event gets here.
8782 We could just not bother storing any of this information here,
8783 and let the ConfigureNotify event set everything up, but that
8784 might be kind of confusing to the Lisp code, since size changes
8785 wouldn't be reported in the frame parameters until some random
8786 point in the future when the ConfigureNotify event arrives.
8788 We pass 1 for DELAY since we can't run Lisp code inside of
8789 a BLOCK_INPUT. */
8791 /* But the ConfigureNotify may in fact never arrive, and then this is
8792 not right if the frame is visible. Instead wait (with timeout)
8793 for the ConfigureNotify. */
8794 if (FRAME_VISIBLE_P (f))
8795 x_wait_for_event (f, ConfigureNotify);
8796 else
8798 change_frame_size (f, rows, cols, 0, 1, 0);
8799 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8800 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8801 x_sync (f);
8806 /* Call this to change the size of frame F's x-window.
8807 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8808 for this size change and subsequent size changes.
8809 Otherwise we leave the window gravity unchanged. */
8811 void
8812 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8814 block_input ();
8816 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8818 int r, c;
8820 /* When the frame is maximized/fullscreen or running under for
8821 example Xmonad, x_set_window_size_1 will be a no-op.
8822 In that case, the right thing to do is extend rows/cols to
8823 the current frame size. We do that first if x_set_window_size_1
8824 turns out to not be a no-op (there is no way to know).
8825 The size will be adjusted again if the frame gets a
8826 ConfigureNotify event as a result of x_set_window_size. */
8827 int pixelh = FRAME_PIXEL_HEIGHT (f);
8828 #ifdef USE_X_TOOLKIT
8829 /* The menu bar is not part of text lines. The tool bar
8830 is however. */
8831 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8832 #endif
8833 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8834 /* Update f->scroll_bar_actual_width because it is used in
8835 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8836 f->scroll_bar_actual_width
8837 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8838 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8839 change_frame_size (f, r, c, 0, 1, 0);
8842 #ifdef USE_GTK
8843 if (FRAME_GTK_WIDGET (f))
8844 xg_frame_set_char_size (f, cols, rows);
8845 else
8846 x_set_window_size_1 (f, change_gravity, cols, rows);
8847 #else /* not USE_GTK */
8849 x_set_window_size_1 (f, change_gravity, cols, rows);
8851 #endif /* not USE_GTK */
8853 /* If cursor was outside the new size, mark it as off. */
8854 mark_window_cursors_off (XWINDOW (f->root_window));
8856 /* Clear out any recollection of where the mouse highlighting was,
8857 since it might be in a place that's outside the new frame size.
8858 Actually checking whether it is outside is a pain in the neck,
8859 so don't try--just let the highlighting be done afresh with new size. */
8860 cancel_mouse_face (f);
8862 unblock_input ();
8865 /* Mouse warping. */
8867 void
8868 x_set_mouse_position (struct frame *f, int x, int y)
8870 int pix_x, pix_y;
8872 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8873 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8875 if (pix_x < 0) pix_x = 0;
8876 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8878 if (pix_y < 0) pix_y = 0;
8879 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8881 block_input ();
8883 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8884 0, 0, 0, 0, pix_x, pix_y);
8885 unblock_input ();
8888 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8890 void
8891 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8893 block_input ();
8895 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8896 0, 0, 0, 0, pix_x, pix_y);
8897 unblock_input ();
8900 /* Raise frame F. */
8902 void
8903 x_raise_frame (struct frame *f)
8905 block_input ();
8906 if (FRAME_VISIBLE_P (f))
8907 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8908 XFlush (FRAME_X_DISPLAY (f));
8909 unblock_input ();
8912 /* Lower frame F. */
8914 static void
8915 x_lower_frame (struct frame *f)
8917 if (FRAME_VISIBLE_P (f))
8919 block_input ();
8920 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8921 XFlush (FRAME_X_DISPLAY (f));
8922 unblock_input ();
8926 /* Request focus with XEmbed */
8928 void
8929 xembed_request_focus (struct frame *f)
8931 /* See XEmbed Protocol Specification at
8932 http://freedesktop.org/wiki/Specifications/xembed-spec */
8933 if (FRAME_VISIBLE_P (f))
8934 xembed_send_message (f, CurrentTime,
8935 XEMBED_REQUEST_FOCUS, 0, 0, 0);
8938 /* Activate frame with Extended Window Manager Hints */
8940 void
8941 x_ewmh_activate_frame (struct frame *f)
8943 /* See Window Manager Specification/Extended Window Manager Hints at
8944 http://freedesktop.org/wiki/Specifications/wm-spec */
8946 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8948 if (FRAME_VISIBLE_P (f) && wm_supports (f, dpyinfo->Xatom_net_active_window))
8950 Lisp_Object frame;
8951 XSETFRAME (frame, f);
8952 x_send_client_event (frame, make_number (0), frame,
8953 dpyinfo->Xatom_net_active_window,
8954 make_number (32), list2i (1, last_user_time));
8958 static void
8959 XTframe_raise_lower (struct frame *f, int raise_flag)
8961 if (raise_flag)
8962 x_raise_frame (f);
8963 else
8964 x_lower_frame (f);
8967 /* XEmbed implementation. */
8969 #if defined USE_X_TOOLKIT || ! defined USE_GTK
8971 /* XEmbed implementation. */
8973 #define XEMBED_VERSION 0
8975 static void
8976 xembed_set_info (struct frame *f, enum xembed_info flags)
8978 unsigned long data[2];
8979 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8981 data[0] = XEMBED_VERSION;
8982 data[1] = flags;
8984 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8985 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
8986 32, PropModeReplace, (unsigned char *) data, 2);
8988 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
8990 static void
8991 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
8992 long int detail, long int data1, long int data2)
8994 XEvent event;
8996 event.xclient.type = ClientMessage;
8997 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
8998 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
8999 event.xclient.format = 32;
9000 event.xclient.data.l[0] = t;
9001 event.xclient.data.l[1] = msg;
9002 event.xclient.data.l[2] = detail;
9003 event.xclient.data.l[3] = data1;
9004 event.xclient.data.l[4] = data2;
9006 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9007 False, NoEventMask, &event);
9008 XSync (FRAME_X_DISPLAY (f), False);
9011 /* Change of visibility. */
9013 /* This tries to wait until the frame is really visible.
9014 However, if the window manager asks the user where to position
9015 the frame, this will return before the user finishes doing that.
9016 The frame will not actually be visible at that time,
9017 but it will become visible later when the window manager
9018 finishes with it. */
9020 void
9021 x_make_frame_visible (struct frame *f)
9023 Lisp_Object type;
9024 int original_top, original_left;
9025 int retry_count = 2;
9027 retry:
9029 block_input ();
9031 type = x_icon_type (f);
9032 if (!NILP (type))
9033 x_bitmap_icon (f, type);
9035 if (! FRAME_VISIBLE_P (f))
9037 /* We test FRAME_GARBAGED_P here to make sure we don't
9038 call x_set_offset a second time
9039 if we get to x_make_frame_visible a second time
9040 before the window gets really visible. */
9041 if (! FRAME_ICONIFIED_P (f)
9042 && ! FRAME_X_EMBEDDED_P (f)
9043 && ! f->output_data.x->asked_for_visible)
9044 x_set_offset (f, f->left_pos, f->top_pos, 0);
9046 f->output_data.x->asked_for_visible = 1;
9048 if (! EQ (Vx_no_window_manager, Qt))
9049 x_wm_set_window_state (f, NormalState);
9050 #ifdef USE_X_TOOLKIT
9051 if (FRAME_X_EMBEDDED_P (f))
9052 xembed_set_info (f, XEMBED_MAPPED);
9053 else
9055 /* This was XtPopup, but that did nothing for an iconified frame. */
9056 XtMapWidget (f->output_data.x->widget);
9058 #else /* not USE_X_TOOLKIT */
9059 #ifdef USE_GTK
9060 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9061 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9062 #else
9063 if (FRAME_X_EMBEDDED_P (f))
9064 xembed_set_info (f, XEMBED_MAPPED);
9065 else
9066 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9067 #endif /* not USE_GTK */
9068 #endif /* not USE_X_TOOLKIT */
9071 XFlush (FRAME_X_DISPLAY (f));
9073 /* Synchronize to ensure Emacs knows the frame is visible
9074 before we do anything else. We do this loop with input not blocked
9075 so that incoming events are handled. */
9077 Lisp_Object frame;
9078 int count;
9079 /* This must be before UNBLOCK_INPUT
9080 since events that arrive in response to the actions above
9081 will set it when they are handled. */
9082 int previously_visible = f->output_data.x->has_been_visible;
9084 original_left = f->left_pos;
9085 original_top = f->top_pos;
9087 /* This must come after we set COUNT. */
9088 unblock_input ();
9090 /* We unblock here so that arriving X events are processed. */
9092 /* Now move the window back to where it was "supposed to be".
9093 But don't do it if the gravity is negative.
9094 When the gravity is negative, this uses a position
9095 that is 3 pixels too low. Perhaps that's really the border width.
9097 Don't do this if the window has never been visible before,
9098 because the window manager may choose the position
9099 and we don't want to override it. */
9101 if (! FRAME_VISIBLE_P (f)
9102 && ! FRAME_ICONIFIED_P (f)
9103 && ! FRAME_X_EMBEDDED_P (f)
9104 && f->win_gravity == NorthWestGravity
9105 && previously_visible)
9107 Drawable rootw;
9108 int x, y;
9109 unsigned int width, height, border, depth;
9111 block_input ();
9113 /* On some window managers (such as FVWM) moving an existing
9114 window, even to the same place, causes the window manager
9115 to introduce an offset. This can cause the window to move
9116 to an unexpected location. Check the geometry (a little
9117 slow here) and then verify that the window is in the right
9118 place. If the window is not in the right place, move it
9119 there, and take the potential window manager hit. */
9120 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9121 &rootw, &x, &y, &width, &height, &border, &depth);
9123 if (original_left != x || original_top != y)
9124 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9125 original_left, original_top);
9127 unblock_input ();
9130 XSETFRAME (frame, f);
9132 /* Wait until the frame is visible. Process X events until a
9133 MapNotify event has been seen, or until we think we won't get a
9134 MapNotify at all.. */
9135 for (count = input_signal_count + 10;
9136 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9138 /* Force processing of queued events. */
9139 x_sync (f);
9141 /* Machines that do polling rather than SIGIO have been
9142 observed to go into a busy-wait here. So we'll fake an
9143 alarm signal to let the handler know that there's something
9144 to be read. We used to raise a real alarm, but it seems
9145 that the handler isn't always enabled here. This is
9146 probably a bug. */
9147 if (input_polling_used ())
9149 /* It could be confusing if a real alarm arrives while
9150 processing the fake one. Turn it off and let the
9151 handler reset it. */
9152 int old_poll_suppress_count = poll_suppress_count;
9153 poll_suppress_count = 1;
9154 poll_for_input_1 ();
9155 poll_suppress_count = old_poll_suppress_count;
9159 /* 2000-09-28: In
9161 (let ((f (selected-frame)))
9162 (iconify-frame f)
9163 (raise-frame f))
9165 the frame is not raised with various window managers on
9166 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9167 unknown reason, the call to XtMapWidget is completely ignored.
9168 Mapping the widget a second time works. */
9170 if (!FRAME_VISIBLE_P (f) && --retry_count != 0)
9171 goto retry;
9175 /* Change from mapped state to withdrawn state. */
9177 /* Make the frame visible (mapped and not iconified). */
9179 void
9180 x_make_frame_invisible (struct frame *f)
9182 Window window;
9184 /* Use the frame's outermost window, not the one we normally draw on. */
9185 window = FRAME_OUTER_WINDOW (f);
9187 /* Don't keep the highlight on an invisible frame. */
9188 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9189 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9191 block_input ();
9193 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9194 that the current position of the window is user-specified, rather than
9195 program-specified, so that when the window is mapped again, it will be
9196 placed at the same location, without forcing the user to position it
9197 by hand again (they have already done that once for this window.) */
9198 x_wm_set_size_hint (f, (long) 0, 1);
9200 #ifdef USE_GTK
9201 if (FRAME_GTK_OUTER_WIDGET (f))
9202 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9203 else
9204 #else
9205 if (FRAME_X_EMBEDDED_P (f))
9206 xembed_set_info (f, 0);
9207 else
9208 #endif
9211 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9212 DefaultScreen (FRAME_X_DISPLAY (f))))
9214 unblock_input ();
9215 error ("Can't notify window manager of window withdrawal");
9219 /* We can't distinguish this from iconification
9220 just by the event that we get from the server.
9221 So we can't win using the usual strategy of letting
9222 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9223 and synchronize with the server to make sure we agree. */
9224 SET_FRAME_VISIBLE (f, 0);
9225 SET_FRAME_ICONIFIED (f, 0);
9227 x_sync (f);
9229 unblock_input ();
9232 /* Change window state from mapped to iconified. */
9234 void
9235 x_iconify_frame (struct frame *f)
9237 #ifdef USE_X_TOOLKIT
9238 int result;
9239 #endif
9240 Lisp_Object type;
9242 /* Don't keep the highlight on an invisible frame. */
9243 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9244 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9246 if (FRAME_ICONIFIED_P (f))
9247 return;
9249 block_input ();
9251 type = x_icon_type (f);
9252 if (!NILP (type))
9253 x_bitmap_icon (f, type);
9255 #if defined (USE_GTK)
9256 if (FRAME_GTK_OUTER_WIDGET (f))
9258 if (! FRAME_VISIBLE_P (f))
9259 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9261 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9262 SET_FRAME_VISIBLE (f, 0);
9263 SET_FRAME_ICONIFIED (f, 1);
9264 unblock_input ();
9265 return;
9267 #endif
9269 #ifdef USE_X_TOOLKIT
9271 if (! FRAME_VISIBLE_P (f))
9273 if (! EQ (Vx_no_window_manager, Qt))
9274 x_wm_set_window_state (f, IconicState);
9275 /* This was XtPopup, but that did nothing for an iconified frame. */
9276 XtMapWidget (f->output_data.x->widget);
9277 /* The server won't give us any event to indicate
9278 that an invisible frame was changed to an icon,
9279 so we have to record it here. */
9280 SET_FRAME_VISIBLE (f, 0);
9281 SET_FRAME_ICONIFIED (f, 1);
9282 unblock_input ();
9283 return;
9286 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9287 XtWindow (f->output_data.x->widget),
9288 DefaultScreen (FRAME_X_DISPLAY (f)));
9289 unblock_input ();
9291 if (!result)
9292 error ("Can't notify window manager of iconification");
9294 SET_FRAME_ICONIFIED (f, 1);
9295 SET_FRAME_VISIBLE (f, 0);
9297 block_input ();
9298 XFlush (FRAME_X_DISPLAY (f));
9299 unblock_input ();
9300 #else /* not USE_X_TOOLKIT */
9302 /* Make sure the X server knows where the window should be positioned,
9303 in case the user deiconifies with the window manager. */
9304 if (! FRAME_VISIBLE_P (f)
9305 && ! FRAME_ICONIFIED_P (f)
9306 && ! FRAME_X_EMBEDDED_P (f))
9307 x_set_offset (f, f->left_pos, f->top_pos, 0);
9309 /* Since we don't know which revision of X we're running, we'll use both
9310 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9312 /* X11R4: send a ClientMessage to the window manager using the
9313 WM_CHANGE_STATE type. */
9315 XEvent msg;
9317 msg.xclient.window = FRAME_X_WINDOW (f);
9318 msg.xclient.type = ClientMessage;
9319 msg.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9320 msg.xclient.format = 32;
9321 msg.xclient.data.l[0] = IconicState;
9323 if (! XSendEvent (FRAME_X_DISPLAY (f),
9324 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9325 False,
9326 SubstructureRedirectMask | SubstructureNotifyMask,
9327 &msg))
9329 unblock_input ();
9330 error ("Can't notify window manager of iconification");
9334 /* X11R3: set the initial_state field of the window manager hints to
9335 IconicState. */
9336 x_wm_set_window_state (f, IconicState);
9338 if (!FRAME_VISIBLE_P (f))
9340 /* If the frame was withdrawn, before, we must map it. */
9341 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9344 SET_FRAME_ICONIFIED (f, 1);
9345 SET_FRAME_VISIBLE (f, 0);
9347 XFlush (FRAME_X_DISPLAY (f));
9348 unblock_input ();
9349 #endif /* not USE_X_TOOLKIT */
9353 /* Free X resources of frame F. */
9355 void
9356 x_free_frame_resources (struct frame *f)
9358 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9359 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9360 #ifdef USE_X_TOOLKIT
9361 Lisp_Object bar;
9362 struct scroll_bar *b;
9363 #endif
9365 block_input ();
9367 /* If a display connection is dead, don't try sending more
9368 commands to the X server. */
9369 if (dpyinfo->display)
9371 /* We must free faces before destroying windows because some
9372 font-driver (e.g. xft) access a window while finishing a
9373 face. */
9374 if (FRAME_FACE_CACHE (f))
9375 free_frame_faces (f);
9377 if (f->output_data.x->icon_desc)
9378 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9380 #ifdef USE_X_TOOLKIT
9381 /* Explicitly destroy the scroll bars of the frame. Without
9382 this, we get "BadDrawable" errors from the toolkit later on,
9383 presumably from expose events generated for the disappearing
9384 toolkit scroll bars. */
9385 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9387 b = XSCROLL_BAR (bar);
9388 x_scroll_bar_remove (b);
9390 #endif
9392 #ifdef HAVE_X_I18N
9393 if (FRAME_XIC (f))
9394 free_frame_xic (f);
9395 #endif
9397 #ifdef USE_X_TOOLKIT
9398 if (f->output_data.x->widget)
9400 XtDestroyWidget (f->output_data.x->widget);
9401 f->output_data.x->widget = NULL;
9403 /* Tooltips don't have widgets, only a simple X window, even if
9404 we are using a toolkit. */
9405 else if (FRAME_X_WINDOW (f))
9406 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9408 free_frame_menubar (f);
9409 #else /* !USE_X_TOOLKIT */
9411 #ifdef USE_GTK
9412 xg_free_frame_widgets (f);
9413 #endif /* USE_GTK */
9415 if (FRAME_X_WINDOW (f))
9416 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9417 #endif /* !USE_X_TOOLKIT */
9419 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9420 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9421 unload_color (f, f->output_data.x->cursor_pixel);
9422 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9423 unload_color (f, f->output_data.x->border_pixel);
9424 unload_color (f, f->output_data.x->mouse_pixel);
9426 if (f->output_data.x->scroll_bar_background_pixel != -1)
9427 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9428 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9429 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9430 #ifdef USE_TOOLKIT_SCROLL_BARS
9431 /* Scrollbar shadow colors. */
9432 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9433 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9434 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9435 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9436 #endif /* USE_TOOLKIT_SCROLL_BARS */
9437 if (f->output_data.x->white_relief.allocated_p)
9438 unload_color (f, f->output_data.x->white_relief.pixel);
9439 if (f->output_data.x->black_relief.allocated_p)
9440 unload_color (f, f->output_data.x->black_relief.pixel);
9442 x_free_gcs (f);
9444 /* Free extra GCs allocated by x_setup_relief_colors. */
9445 if (f->output_data.x->white_relief.gc)
9447 XFreeGC (dpyinfo->display, f->output_data.x->white_relief.gc);
9448 f->output_data.x->white_relief.gc = 0;
9450 if (f->output_data.x->black_relief.gc)
9452 XFreeGC (dpyinfo->display, f->output_data.x->black_relief.gc);
9453 f->output_data.x->black_relief.gc = 0;
9456 XFlush (FRAME_X_DISPLAY (f));
9459 xfree (f->output_data.x->saved_menu_event);
9460 xfree (f->output_data.x);
9461 f->output_data.x = NULL;
9463 if (f == dpyinfo->x_focus_frame)
9464 dpyinfo->x_focus_frame = 0;
9465 if (f == dpyinfo->x_focus_event_frame)
9466 dpyinfo->x_focus_event_frame = 0;
9467 if (f == dpyinfo->x_highlight_frame)
9468 dpyinfo->x_highlight_frame = 0;
9470 if (f == hlinfo->mouse_face_mouse_frame)
9472 hlinfo->mouse_face_beg_row
9473 = hlinfo->mouse_face_beg_col = -1;
9474 hlinfo->mouse_face_end_row
9475 = hlinfo->mouse_face_end_col = -1;
9476 hlinfo->mouse_face_window = Qnil;
9477 hlinfo->mouse_face_mouse_frame = 0;
9480 unblock_input ();
9484 /* Destroy the X window of frame F. */
9486 static void
9487 x_destroy_window (struct frame *f)
9489 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9491 /* If a display connection is dead, don't try sending more
9492 commands to the X server. */
9493 if (dpyinfo->display != 0)
9494 x_free_frame_resources (f);
9496 dpyinfo->reference_count--;
9500 /* Setting window manager hints. */
9502 /* Set the normal size hints for the window manager, for frame F.
9503 FLAGS is the flags word to use--or 0 meaning preserve the flags
9504 that the window now has.
9505 If USER_POSITION, set the USPosition
9506 flag (this is useful when FLAGS is 0).
9507 The GTK version is in gtkutils.c. */
9509 #ifndef USE_GTK
9510 void
9511 x_wm_set_size_hint (struct frame *f, long flags, bool user_position)
9513 XSizeHints size_hints;
9514 Window window = FRAME_OUTER_WINDOW (f);
9516 #ifdef USE_X_TOOLKIT
9517 if (f->output_data.x->widget)
9519 widget_update_wm_size_hints (f->output_data.x->widget);
9520 return;
9522 #endif
9524 /* Setting PMaxSize caused various problems. */
9525 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9527 size_hints.x = f->left_pos;
9528 size_hints.y = f->top_pos;
9530 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9531 size_hints.width = FRAME_PIXEL_WIDTH (f);
9533 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9534 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9535 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9536 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9537 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9538 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9540 /* Calculate the base and minimum sizes. */
9542 int base_width, base_height;
9543 int min_rows = 0, min_cols = 0;
9545 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9546 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9548 check_frame_size (f, &min_rows, &min_cols);
9550 /* The window manager uses the base width hints to calculate the
9551 current number of rows and columns in the frame while
9552 resizing; min_width and min_height aren't useful for this
9553 purpose, since they might not give the dimensions for a
9554 zero-row, zero-column frame.
9556 We use the base_width and base_height members if we have
9557 them; otherwise, we set the min_width and min_height members
9558 to the size for a zero x zero frame. */
9560 size_hints.flags |= PBaseSize;
9561 size_hints.base_width = base_width;
9562 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9563 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9564 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9567 /* If we don't need the old flags, we don't need the old hint at all. */
9568 if (flags)
9570 size_hints.flags |= flags;
9571 goto no_read;
9575 XSizeHints hints; /* Sometimes I hate X Windows... */
9576 long supplied_return;
9577 int value;
9579 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9580 &supplied_return);
9582 if (flags)
9583 size_hints.flags |= flags;
9584 else
9586 if (value == 0)
9587 hints.flags = 0;
9588 if (hints.flags & PSize)
9589 size_hints.flags |= PSize;
9590 if (hints.flags & PPosition)
9591 size_hints.flags |= PPosition;
9592 if (hints.flags & USPosition)
9593 size_hints.flags |= USPosition;
9594 if (hints.flags & USSize)
9595 size_hints.flags |= USSize;
9599 no_read:
9601 #ifdef PWinGravity
9602 size_hints.win_gravity = f->win_gravity;
9603 size_hints.flags |= PWinGravity;
9605 if (user_position)
9607 size_hints.flags &= ~ PPosition;
9608 size_hints.flags |= USPosition;
9610 #endif /* PWinGravity */
9612 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9614 #endif /* not USE_GTK */
9616 /* Used for IconicState or NormalState */
9618 static void
9619 x_wm_set_window_state (struct frame *f, int state)
9621 #ifdef USE_X_TOOLKIT
9622 Arg al[1];
9624 XtSetArg (al[0], XtNinitialState, state);
9625 XtSetValues (f->output_data.x->widget, al, 1);
9626 #else /* not USE_X_TOOLKIT */
9627 Window window = FRAME_X_WINDOW (f);
9629 f->output_data.x->wm_hints.flags |= StateHint;
9630 f->output_data.x->wm_hints.initial_state = state;
9632 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9633 #endif /* not USE_X_TOOLKIT */
9636 static void
9637 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
9639 Pixmap icon_pixmap, icon_mask;
9641 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9642 Window window = FRAME_OUTER_WINDOW (f);
9643 #endif
9645 if (pixmap_id > 0)
9647 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9648 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9649 icon_mask = x_bitmap_mask (f, pixmap_id);
9650 f->output_data.x->wm_hints.icon_mask = icon_mask;
9652 else
9654 /* It seems there is no way to turn off use of an icon
9655 pixmap. */
9656 return;
9660 #ifdef USE_GTK
9662 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9663 return;
9666 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9669 Arg al[1];
9670 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9671 XtSetValues (f->output_data.x->widget, al, 1);
9672 XtSetArg (al[0], XtNiconMask, icon_mask);
9673 XtSetValues (f->output_data.x->widget, al, 1);
9676 #else /* not USE_X_TOOLKIT && not USE_GTK */
9678 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9679 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9681 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9684 void
9685 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9687 Window window = FRAME_OUTER_WINDOW (f);
9689 f->output_data.x->wm_hints.flags |= IconPositionHint;
9690 f->output_data.x->wm_hints.icon_x = icon_x;
9691 f->output_data.x->wm_hints.icon_y = icon_y;
9693 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9697 /***********************************************************************
9698 Fonts
9699 ***********************************************************************/
9701 #ifdef GLYPH_DEBUG
9703 /* Check that FONT is valid on frame F. It is if it can be found in F's
9704 font table. */
9706 static void
9707 x_check_font (struct frame *f, struct font *font)
9709 eassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9710 if (font->driver->check)
9711 eassert (font->driver->check (f, font) == 0);
9714 #endif /* GLYPH_DEBUG */
9717 /***********************************************************************
9718 Initialization
9719 ***********************************************************************/
9721 #ifdef USE_X_TOOLKIT
9722 static XrmOptionDescRec emacs_options[] = {
9723 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9724 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9726 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9727 XrmoptionSepArg, NULL},
9728 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9730 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9731 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9732 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9733 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9734 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9735 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9736 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9739 /* Whether atimer for Xt timeouts is activated or not. */
9741 static int x_timeout_atimer_activated_flag;
9743 #endif /* USE_X_TOOLKIT */
9745 static int x_initialized;
9747 /* Test whether two display-name strings agree up to the dot that separates
9748 the screen number from the server number. */
9749 static int
9750 same_x_server (const char *name1, const char *name2)
9752 int seen_colon = 0;
9753 const char *system_name = SSDATA (Vsystem_name);
9754 ptrdiff_t system_name_length = SBYTES (Vsystem_name);
9755 ptrdiff_t length_until_period = 0;
9757 while (system_name[length_until_period] != 0
9758 && system_name[length_until_period] != '.')
9759 length_until_period++;
9761 /* Treat `unix' like an empty host name. */
9762 if (! strncmp (name1, "unix:", 5))
9763 name1 += 4;
9764 if (! strncmp (name2, "unix:", 5))
9765 name2 += 4;
9766 /* Treat this host's name like an empty host name. */
9767 if (! strncmp (name1, system_name, system_name_length)
9768 && name1[system_name_length] == ':')
9769 name1 += system_name_length;
9770 if (! strncmp (name2, system_name, system_name_length)
9771 && name2[system_name_length] == ':')
9772 name2 += system_name_length;
9773 /* Treat this host's domainless name like an empty host name. */
9774 if (! strncmp (name1, system_name, length_until_period)
9775 && name1[length_until_period] == ':')
9776 name1 += length_until_period;
9777 if (! strncmp (name2, system_name, length_until_period)
9778 && name2[length_until_period] == ':')
9779 name2 += length_until_period;
9781 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9783 if (*name1 == ':')
9784 seen_colon = 1;
9785 if (seen_colon && *name1 == '.')
9786 return 1;
9788 return (seen_colon
9789 && (*name1 == '.' || *name1 == '\0')
9790 && (*name2 == '.' || *name2 == '\0'));
9793 /* Count number of set bits in mask and number of bits to shift to
9794 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9795 to 5. */
9796 static void
9797 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9799 int nr = 0;
9800 int off = 0;
9802 while (!(mask & 1))
9804 off++;
9805 mask >>= 1;
9808 while (mask & 1)
9810 nr++;
9811 mask >>= 1;
9814 *offset = off;
9815 *bits = nr;
9818 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9819 But don't permanently open it, just test its availability. */
9821 bool
9822 x_display_ok (const char *display)
9824 Display *dpy = XOpenDisplay (display);
9825 return dpy ? (XCloseDisplay (dpy), 1) : 0;
9828 #ifdef USE_GTK
9829 static void
9830 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
9831 const gchar *msg, gpointer user_data)
9833 if (!strstr (msg, "g_set_prgname"))
9834 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
9836 #endif
9838 /* Open a connection to X display DISPLAY_NAME, and return
9839 the structure that describes the open display.
9840 If we cannot contact the display, return null. */
9842 struct x_display_info *
9843 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9845 int connection;
9846 Display *dpy;
9847 struct terminal *terminal;
9848 struct x_display_info *dpyinfo;
9849 XrmDatabase xrdb;
9850 Mouse_HLInfo *hlinfo;
9851 ptrdiff_t lim;
9853 block_input ();
9855 if (!x_initialized)
9857 x_initialize ();
9858 ++x_initialized;
9861 if (! x_display_ok (SSDATA (display_name)))
9862 error ("Display %s can't be opened", SSDATA (display_name));
9864 #ifdef USE_GTK
9866 #define NUM_ARGV 10
9867 int argc;
9868 char *argv[NUM_ARGV];
9869 char **argv2 = argv;
9870 guint id;
9872 if (x_initialized++ > 1)
9874 xg_display_open (SSDATA (display_name), &dpy);
9876 else
9878 static char display_opt[] = "--display";
9879 static char name_opt[] = "--name";
9881 for (argc = 0; argc < NUM_ARGV; ++argc)
9882 argv[argc] = 0;
9884 argc = 0;
9885 argv[argc++] = initial_argv[0];
9887 if (! NILP (display_name))
9889 argv[argc++] = display_opt;
9890 argv[argc++] = SSDATA (display_name);
9893 argv[argc++] = name_opt;
9894 argv[argc++] = resource_name;
9896 XSetLocaleModifiers ("");
9898 /* Emacs can only handle core input events, so make sure
9899 Gtk doesn't use Xinput or Xinput2 extensions. */
9900 xputenv ("GDK_CORE_DEVICE_EVENTS=1");
9902 /* Work around GLib bug that outputs a faulty warning. See
9903 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9904 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9905 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9907 /* NULL window -> events for all windows go to our function.
9908 Call before gtk_init so Gtk+ event filters comes after our. */
9909 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9911 /* gtk_init does set_locale. Fix locale before and after. */
9912 fixup_locale ();
9913 gtk_init (&argc, &argv2);
9914 fixup_locale ();
9916 g_log_remove_handler ("GLib", id);
9918 xg_initialize ();
9920 dpy = DEFAULT_GDK_DISPLAY ();
9922 #if ! GTK_CHECK_VERSION (2, 90, 0)
9923 /* Load our own gtkrc if it exists. */
9925 const char *file = "~/.emacs.d/gtkrc";
9926 Lisp_Object s, abs_file;
9928 s = build_string (file);
9929 abs_file = Fexpand_file_name (s, Qnil);
9931 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9932 gtk_rc_parse (SSDATA (abs_file));
9934 #endif
9936 XSetErrorHandler (x_error_handler);
9937 XSetIOErrorHandler (x_io_error_quitter);
9940 #else /* not USE_GTK */
9941 #ifdef USE_X_TOOLKIT
9942 /* weiner@footloose.sps.mot.com reports that this causes
9943 errors with X11R5:
9944 X protocol error: BadAtom (invalid Atom parameter)
9945 on protocol request 18skiloaf.
9946 So let's not use it until R6. */
9947 #ifdef HAVE_X11XTR6
9948 XtSetLanguageProc (NULL, NULL, NULL);
9949 #endif
9952 int argc = 0;
9953 char *argv[3];
9955 argv[0] = "";
9956 argc = 1;
9957 if (xrm_option)
9959 argv[argc++] = "-xrm";
9960 argv[argc++] = xrm_option;
9962 turn_on_atimers (0);
9963 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
9964 resource_name, EMACS_CLASS,
9965 emacs_options, XtNumber (emacs_options),
9966 &argc, argv);
9967 turn_on_atimers (1);
9969 #ifdef HAVE_X11XTR6
9970 /* I think this is to compensate for XtSetLanguageProc. */
9971 fixup_locale ();
9972 #endif
9975 #else /* not USE_X_TOOLKIT */
9976 XSetLocaleModifiers ("");
9977 dpy = XOpenDisplay (SSDATA (display_name));
9978 #endif /* not USE_X_TOOLKIT */
9979 #endif /* not USE_GTK*/
9981 /* Detect failure. */
9982 if (dpy == 0)
9984 unblock_input ();
9985 return 0;
9988 /* We have definitely succeeded. Record the new connection. */
9990 dpyinfo = xzalloc (sizeof *dpyinfo);
9991 hlinfo = &dpyinfo->mouse_highlight;
9993 terminal = x_create_terminal (dpyinfo);
9996 struct x_display_info *share;
9997 Lisp_Object tail;
9999 for (share = x_display_list, tail = x_display_name_list; share;
10000 share = share->next, tail = XCDR (tail))
10001 if (same_x_server (SSDATA (XCAR (XCAR (tail))),
10002 SSDATA (display_name)))
10003 break;
10004 if (share)
10005 terminal->kboard = share->terminal->kboard;
10006 else
10008 terminal->kboard = xmalloc (sizeof *terminal->kboard);
10009 init_kboard (terminal->kboard);
10010 kset_window_system (terminal->kboard, Qx);
10012 /* Add the keyboard to the list before running Lisp code (via
10013 Qvendor_specific_keysyms below), since these are not traced
10014 via terminals but only through all_kboards. */
10015 terminal->kboard->next_kboard = all_kboards;
10016 all_kboards = terminal->kboard;
10018 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10020 char *vendor = ServerVendor (dpy);
10022 /* Protect terminal from GC before removing it from the
10023 list of terminals. */
10024 struct gcpro gcpro1;
10025 Lisp_Object gcpro_term;
10026 XSETTERMINAL (gcpro_term, terminal);
10027 GCPRO1 (gcpro_term);
10029 /* Temporarily hide the partially initialized terminal. */
10030 terminal_list = terminal->next_terminal;
10031 unblock_input ();
10032 kset_system_key_alist
10033 (terminal->kboard,
10034 call1 (Qvendor_specific_keysyms,
10035 vendor ? build_string (vendor) : empty_unibyte_string));
10036 block_input ();
10037 terminal->next_terminal = terminal_list;
10038 terminal_list = terminal;
10039 UNGCPRO;
10042 /* Don't let the initial kboard remain current longer than necessary.
10043 That would cause problems if a file loaded on startup tries to
10044 prompt in the mini-buffer. */
10045 if (current_kboard == initial_kboard)
10046 current_kboard = terminal->kboard;
10048 terminal->kboard->reference_count++;
10051 /* Put this display on the chain. */
10052 dpyinfo->next = x_display_list;
10053 x_display_list = dpyinfo;
10055 /* Put it on x_display_name_list as well, to keep them parallel. */
10056 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10057 x_display_name_list);
10058 dpyinfo->name_list_element = XCAR (x_display_name_list);
10060 dpyinfo->display = dpy;
10062 /* Set the name of the terminal. */
10063 terminal->name = xmalloc (SBYTES (display_name) + 1);
10064 memcpy (terminal->name, SSDATA (display_name), SBYTES (display_name));
10065 terminal->name[SBYTES (display_name)] = 0;
10067 #if 0
10068 XSetAfterFunction (x_current_display, x_trace_wire);
10069 #endif /* ! 0 */
10071 lim = min (PTRDIFF_MAX, SIZE_MAX) - sizeof "@";
10072 if (lim - SBYTES (Vinvocation_name) < SBYTES (Vsystem_name))
10073 memory_full (SIZE_MAX);
10074 dpyinfo->x_id_name = xmalloc (SBYTES (Vinvocation_name)
10075 + SBYTES (Vsystem_name) + 2);
10076 strcat (strcat (strcpy (dpyinfo->x_id_name, SSDATA (Vinvocation_name)), "@"),
10077 SSDATA (Vsystem_name));
10079 /* Figure out which modifier bits mean what. */
10080 x_find_modifier_meanings (dpyinfo);
10082 /* Get the scroll bar cursor. */
10083 #ifdef USE_GTK
10084 /* We must create a GTK cursor, it is required for GTK widgets. */
10085 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10086 #endif /* USE_GTK */
10088 dpyinfo->vertical_scroll_bar_cursor
10089 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10091 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10092 resource_name, EMACS_CLASS);
10093 #ifdef HAVE_XRMSETDATABASE
10094 XrmSetDatabase (dpyinfo->display, xrdb);
10095 #else
10096 dpyinfo->display->db = xrdb;
10097 #endif
10098 /* Put the rdb where we can find it in a way that works on
10099 all versions. */
10100 dpyinfo->xrdb = xrdb;
10102 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10103 DefaultScreen (dpyinfo->display));
10104 select_visual (dpyinfo);
10105 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10106 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10107 dpyinfo->client_leader_window = 0;
10108 dpyinfo->grabbed = 0;
10109 dpyinfo->reference_count = 0;
10110 dpyinfo->icon_bitmap_id = -1;
10111 dpyinfo->n_fonts = 0;
10112 dpyinfo->bitmaps = 0;
10113 dpyinfo->bitmaps_size = 0;
10114 dpyinfo->bitmaps_last = 0;
10115 dpyinfo->scratch_cursor_gc = 0;
10116 hlinfo->mouse_face_mouse_frame = 0;
10117 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10118 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10119 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10120 hlinfo->mouse_face_window = Qnil;
10121 hlinfo->mouse_face_overlay = Qnil;
10122 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10123 hlinfo->mouse_face_defer = 0;
10124 hlinfo->mouse_face_hidden = 0;
10125 dpyinfo->x_focus_frame = 0;
10126 dpyinfo->x_focus_event_frame = 0;
10127 dpyinfo->x_highlight_frame = 0;
10128 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10130 /* See if we can construct pixel values from RGB values. */
10131 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10132 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10134 if (dpyinfo->visual->class == TrueColor)
10136 get_bits_and_offset (dpyinfo->visual->red_mask,
10137 &dpyinfo->red_bits, &dpyinfo->red_offset);
10138 get_bits_and_offset (dpyinfo->visual->blue_mask,
10139 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10140 get_bits_and_offset (dpyinfo->visual->green_mask,
10141 &dpyinfo->green_bits, &dpyinfo->green_offset);
10144 /* See if a private colormap is requested. */
10145 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10147 if (dpyinfo->visual->class == PseudoColor)
10149 Lisp_Object value;
10150 value = display_x_get_resource (dpyinfo,
10151 build_string ("privateColormap"),
10152 build_string ("PrivateColormap"),
10153 Qnil, Qnil);
10154 if (STRINGP (value)
10155 && (!strcmp (SSDATA (value), "true")
10156 || !strcmp (SSDATA (value), "on")))
10157 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10160 else
10161 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10162 dpyinfo->visual, AllocNone);
10164 #ifdef HAVE_XFT
10166 /* If we are using Xft, check dpi value in X resources.
10167 It is better we use it as well, since Xft will use it, as will all
10168 Gnome applications. If our real DPI is smaller or larger than the
10169 one Xft uses, our font will look smaller or larger than other
10170 for other applications, even if it is the same font name (monospace-10
10171 for example). */
10172 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10173 double d;
10174 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10175 dpyinfo->resy = dpyinfo->resx = d;
10177 #endif
10179 if (dpyinfo->resy < 1)
10181 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10182 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10183 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10184 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10185 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10186 pixels = DisplayWidth (dpyinfo->display, screen_number);
10187 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10188 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10189 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10193 static const struct
10195 const char *name;
10196 int offset;
10197 } atom_refs[] = {
10198 #define ATOM_REFS_INIT(string, member) \
10199 { string, offsetof (struct x_display_info, member) },
10200 ATOM_REFS_INIT ("WM_PROTOCOLS", Xatom_wm_protocols)
10201 ATOM_REFS_INIT ("WM_TAKE_FOCUS", Xatom_wm_take_focus)
10202 ATOM_REFS_INIT ("WM_SAVE_YOURSELF", Xatom_wm_save_yourself)
10203 ATOM_REFS_INIT ("WM_DELETE_WINDOW", Xatom_wm_delete_window)
10204 ATOM_REFS_INIT ("WM_CHANGE_STATE", Xatom_wm_change_state)
10205 ATOM_REFS_INIT ("WM_CONFIGURE_DENIED", Xatom_wm_configure_denied)
10206 ATOM_REFS_INIT ("WM_MOVED", Xatom_wm_window_moved)
10207 ATOM_REFS_INIT ("WM_CLIENT_LEADER", Xatom_wm_client_leader)
10208 ATOM_REFS_INIT ("Editres", Xatom_editres)
10209 ATOM_REFS_INIT ("CLIPBOARD", Xatom_CLIPBOARD)
10210 ATOM_REFS_INIT ("TIMESTAMP", Xatom_TIMESTAMP)
10211 ATOM_REFS_INIT ("TEXT", Xatom_TEXT)
10212 ATOM_REFS_INIT ("COMPOUND_TEXT", Xatom_COMPOUND_TEXT)
10213 ATOM_REFS_INIT ("UTF8_STRING", Xatom_UTF8_STRING)
10214 ATOM_REFS_INIT ("DELETE", Xatom_DELETE)
10215 ATOM_REFS_INIT ("MULTIPLE", Xatom_MULTIPLE)
10216 ATOM_REFS_INIT ("INCR", Xatom_INCR)
10217 ATOM_REFS_INIT ("_EMACS_TMP_", Xatom_EMACS_TMP)
10218 ATOM_REFS_INIT ("TARGETS", Xatom_TARGETS)
10219 ATOM_REFS_INIT ("NULL", Xatom_NULL)
10220 ATOM_REFS_INIT ("ATOM", Xatom_ATOM)
10221 ATOM_REFS_INIT ("ATOM_PAIR", Xatom_ATOM_PAIR)
10222 ATOM_REFS_INIT ("CLIPBOARD_MANAGER", Xatom_CLIPBOARD_MANAGER)
10223 ATOM_REFS_INIT ("_XEMBED_INFO", Xatom_XEMBED_INFO)
10224 /* For properties of font. */
10225 ATOM_REFS_INIT ("PIXEL_SIZE", Xatom_PIXEL_SIZE)
10226 ATOM_REFS_INIT ("AVERAGE_WIDTH", Xatom_AVERAGE_WIDTH)
10227 ATOM_REFS_INIT ("_MULE_BASELINE_OFFSET", Xatom_MULE_BASELINE_OFFSET)
10228 ATOM_REFS_INIT ("_MULE_RELATIVE_COMPOSE", Xatom_MULE_RELATIVE_COMPOSE)
10229 ATOM_REFS_INIT ("_MULE_DEFAULT_ASCENT", Xatom_MULE_DEFAULT_ASCENT)
10230 /* Ghostscript support. */
10231 ATOM_REFS_INIT ("DONE", Xatom_DONE)
10232 ATOM_REFS_INIT ("PAGE", Xatom_PAGE)
10233 ATOM_REFS_INIT ("SCROLLBAR", Xatom_Scrollbar)
10234 ATOM_REFS_INIT ("_XEMBED", Xatom_XEMBED)
10235 /* EWMH */
10236 ATOM_REFS_INIT ("_NET_WM_STATE", Xatom_net_wm_state)
10237 ATOM_REFS_INIT ("_NET_WM_STATE_FULLSCREEN", Xatom_net_wm_state_fullscreen)
10238 ATOM_REFS_INIT ("_NET_WM_STATE_MAXIMIZED_HORZ",
10239 Xatom_net_wm_state_maximized_horz)
10240 ATOM_REFS_INIT ("_NET_WM_STATE_MAXIMIZED_VERT",
10241 Xatom_net_wm_state_maximized_vert)
10242 ATOM_REFS_INIT ("_NET_WM_STATE_STICKY", Xatom_net_wm_state_sticky)
10243 ATOM_REFS_INIT ("_NET_WM_STATE_HIDDEN", Xatom_net_wm_state_hidden)
10244 ATOM_REFS_INIT ("_NET_WM_WINDOW_TYPE", Xatom_net_window_type)
10245 ATOM_REFS_INIT ("_NET_WM_WINDOW_TYPE_TOOLTIP",
10246 Xatom_net_window_type_tooltip)
10247 ATOM_REFS_INIT ("_NET_WM_ICON_NAME", Xatom_net_wm_icon_name)
10248 ATOM_REFS_INIT ("_NET_WM_NAME", Xatom_net_wm_name)
10249 ATOM_REFS_INIT ("_NET_SUPPORTED", Xatom_net_supported)
10250 ATOM_REFS_INIT ("_NET_SUPPORTING_WM_CHECK", Xatom_net_supporting_wm_check)
10251 ATOM_REFS_INIT ("_NET_WM_WINDOW_OPACITY", Xatom_net_wm_window_opacity)
10252 ATOM_REFS_INIT ("_NET_ACTIVE_WINDOW", Xatom_net_active_window)
10253 ATOM_REFS_INIT ("_NET_FRAME_EXTENTS", Xatom_net_frame_extents)
10254 ATOM_REFS_INIT ("_NET_CURRENT_DESKTOP", Xatom_net_current_desktop)
10255 ATOM_REFS_INIT ("_NET_WORKAREA", Xatom_net_workarea)
10256 /* Session management */
10257 ATOM_REFS_INIT ("SM_CLIENT_ID", Xatom_SM_CLIENT_ID)
10258 ATOM_REFS_INIT ("_XSETTINGS_SETTINGS", Xatom_xsettings_prop)
10259 ATOM_REFS_INIT ("MANAGER", Xatom_xsettings_mgr)
10262 int i;
10263 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10264 /* 1 for _XSETTINGS_SN */
10265 const int total_atom_count = 1 + atom_count;
10266 Atom *atoms_return = xmalloc (total_atom_count * sizeof *atoms_return);
10267 char **atom_names = xmalloc (total_atom_count * sizeof *atom_names);
10268 static char const xsettings_fmt[] = "_XSETTINGS_S%d";
10269 char xsettings_atom_name[sizeof xsettings_fmt - 2
10270 + INT_STRLEN_BOUND (int)];
10272 for (i = 0; i < atom_count; i++)
10273 atom_names[i] = (char *) atom_refs[i].name;
10275 /* Build _XSETTINGS_SN atom name */
10276 sprintf (xsettings_atom_name, xsettings_fmt,
10277 XScreenNumberOfScreen (dpyinfo->screen));
10278 atom_names[i] = xsettings_atom_name;
10280 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10281 False, atoms_return);
10283 for (i = 0; i < atom_count; i++)
10284 *(Atom *) ((char *) dpyinfo + atom_refs[i].offset) = atoms_return[i];
10286 /* Manual copy of last atom */
10287 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10289 xfree (atom_names);
10290 xfree (atoms_return);
10293 dpyinfo->x_dnd_atoms_size = 8;
10294 dpyinfo->x_dnd_atoms_length = 0;
10295 dpyinfo->x_dnd_atoms = xmalloc (sizeof *dpyinfo->x_dnd_atoms
10296 * dpyinfo->x_dnd_atoms_size);
10298 dpyinfo->net_supported_atoms = NULL;
10299 dpyinfo->nr_net_supported_atoms = 0;
10300 dpyinfo->net_supported_window = 0;
10302 connection = ConnectionNumber (dpyinfo->display);
10303 dpyinfo->connection = connection;
10304 dpyinfo->gray
10305 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10306 gray_bits, gray_width, gray_height,
10307 1, 0, 1);
10309 #ifdef HAVE_X_I18N
10310 xim_initialize (dpyinfo, resource_name);
10311 #endif
10313 xsettings_initialize (dpyinfo);
10315 /* This is only needed for distinguishing keyboard and process input. */
10316 if (connection != 0)
10317 add_keyboard_wait_descriptor (connection);
10319 #ifdef F_SETOWN
10320 fcntl (connection, F_SETOWN, getpid ());
10321 #endif /* ! defined (F_SETOWN) */
10323 if (interrupt_input)
10324 init_sigio (connection);
10326 #ifdef USE_LUCID
10328 XrmValue d, fr, to;
10329 Font font;
10331 dpy = dpyinfo->display;
10332 d.addr = (XPointer)&dpy;
10333 d.size = sizeof (Display *);
10334 fr.addr = XtDefaultFont;
10335 fr.size = sizeof (XtDefaultFont);
10336 to.size = sizeof (Font *);
10337 to.addr = (XPointer)&font;
10338 x_catch_errors (dpy);
10339 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10340 emacs_abort ();
10341 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10342 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10343 x_uncatch_errors ();
10345 #endif
10347 /* See if we should run in synchronous mode. This is useful
10348 for debugging X code. */
10350 Lisp_Object value;
10351 value = display_x_get_resource (dpyinfo,
10352 build_string ("synchronous"),
10353 build_string ("Synchronous"),
10354 Qnil, Qnil);
10355 if (STRINGP (value)
10356 && (!strcmp (SSDATA (value), "true")
10357 || !strcmp (SSDATA (value), "on")))
10358 XSynchronize (dpyinfo->display, True);
10362 Lisp_Object value;
10363 value = display_x_get_resource (dpyinfo,
10364 build_string ("useXIM"),
10365 build_string ("UseXIM"),
10366 Qnil, Qnil);
10367 #ifdef USE_XIM
10368 if (STRINGP (value)
10369 && (!strcmp (SSDATA (value), "false")
10370 || !strcmp (SSDATA (value), "off")))
10371 use_xim = 0;
10372 #else
10373 if (STRINGP (value)
10374 && (!strcmp (SSDATA (value), "true")
10375 || !strcmp (SSDATA (value), "on")))
10376 use_xim = 1;
10377 #endif
10380 #ifdef HAVE_X_SM
10381 /* Only do this for the very first display in the Emacs session.
10382 Ignore X session management when Emacs was first started on a
10383 tty. */
10384 if (terminal->id == 1)
10385 x_session_initialize (dpyinfo);
10386 #endif
10388 unblock_input ();
10390 return dpyinfo;
10393 /* Get rid of display DPYINFO, deleting all frames on it,
10394 and without sending any more commands to the X server. */
10396 static void
10397 x_delete_display (struct x_display_info *dpyinfo)
10399 struct terminal *t;
10401 /* Close all frames and delete the generic struct terminal for this
10402 X display. */
10403 for (t = terminal_list; t; t = t->next_terminal)
10404 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10406 #ifdef HAVE_X_SM
10407 /* Close X session management when we close its display. */
10408 if (t->id == 1 && x_session_have_connection ())
10409 x_session_close ();
10410 #endif
10411 delete_terminal (t);
10412 break;
10415 delete_keyboard_wait_descriptor (dpyinfo->connection);
10417 /* Discard this display from x_display_name_list and x_display_list.
10418 We can't use Fdelq because that can quit. */
10419 if (! NILP (x_display_name_list)
10420 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10421 x_display_name_list = XCDR (x_display_name_list);
10422 else
10424 Lisp_Object tail;
10426 tail = x_display_name_list;
10427 while (CONSP (tail) && CONSP (XCDR (tail)))
10429 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10431 XSETCDR (tail, XCDR (XCDR (tail)));
10432 break;
10434 tail = XCDR (tail);
10438 if (next_noop_dpyinfo == dpyinfo)
10439 next_noop_dpyinfo = dpyinfo->next;
10441 if (x_display_list == dpyinfo)
10442 x_display_list = dpyinfo->next;
10443 else
10445 struct x_display_info *tail;
10447 for (tail = x_display_list; tail; tail = tail->next)
10448 if (tail->next == dpyinfo)
10449 tail->next = tail->next->next;
10452 xfree (dpyinfo->x_id_name);
10453 xfree (dpyinfo->x_dnd_atoms);
10454 xfree (dpyinfo->color_cells);
10455 xfree (dpyinfo);
10458 #ifdef USE_X_TOOLKIT
10460 /* Atimer callback function for TIMER. Called every 0.1s to process
10461 Xt timeouts, if needed. We must avoid calling XtAppPending as
10462 much as possible because that function does an implicit XFlush
10463 that slows us down. */
10465 static void
10466 x_process_timeouts (struct atimer *timer)
10468 block_input ();
10469 x_timeout_atimer_activated_flag = 0;
10470 if (toolkit_scroll_bar_interaction || popup_activated ())
10472 while (XtAppPending (Xt_app_con) & XtIMTimer)
10473 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10474 /* Reactivate the atimer for next time. */
10475 x_activate_timeout_atimer ();
10477 unblock_input ();
10480 /* Install an asynchronous timer that processes Xt timeout events
10481 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10482 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10483 function whenever these variables are set. This is necessary
10484 because some widget sets use timeouts internally, for example the
10485 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10486 processed, these widgets don't behave normally. */
10488 void
10489 x_activate_timeout_atimer (void)
10491 block_input ();
10492 if (!x_timeout_atimer_activated_flag)
10494 EMACS_TIME interval = make_emacs_time (0, 100 * 1000 * 1000);
10495 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10496 x_timeout_atimer_activated_flag = 1;
10498 unblock_input ();
10501 #endif /* USE_X_TOOLKIT */
10504 /* Set up use of X before we make the first connection. */
10506 static struct redisplay_interface x_redisplay_interface =
10508 x_frame_parm_handlers,
10509 x_produce_glyphs,
10510 x_write_glyphs,
10511 x_insert_glyphs,
10512 x_clear_end_of_line,
10513 x_scroll_run,
10514 x_after_update_window_line,
10515 x_update_window_begin,
10516 x_update_window_end,
10517 x_cursor_to,
10518 x_flush,
10519 #ifdef XFlush
10520 x_flush,
10521 #else
10522 0, /* flush_display_optional */
10523 #endif
10524 x_clear_window_mouse_face,
10525 x_get_glyph_overhangs,
10526 x_fix_overlapping_area,
10527 x_draw_fringe_bitmap,
10528 0, /* define_fringe_bitmap */
10529 0, /* destroy_fringe_bitmap */
10530 x_compute_glyph_string_overhangs,
10531 x_draw_glyph_string,
10532 x_define_frame_cursor,
10533 x_clear_frame_area,
10534 x_draw_window_cursor,
10535 x_draw_vertical_window_border,
10536 x_shift_glyphs_for_insert
10540 /* This function is called when the last frame on a display is deleted. */
10541 void
10542 x_delete_terminal (struct terminal *terminal)
10544 struct x_display_info *dpyinfo = terminal->display_info.x;
10546 /* Protect against recursive calls. delete_frame in
10547 delete_terminal calls us back when it deletes our last frame. */
10548 if (!terminal->name)
10549 return;
10551 block_input ();
10552 #ifdef HAVE_X_I18N
10553 /* We must close our connection to the XIM server before closing the
10554 X display. */
10555 if (dpyinfo->xim)
10556 xim_close_dpy (dpyinfo);
10557 #endif
10559 /* If called from x_connection_closed, the display may already be closed
10560 and dpyinfo->display was set to 0 to indicate that. */
10561 if (dpyinfo->display)
10563 x_destroy_all_bitmaps (dpyinfo);
10564 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10566 /* Whether or not XCloseDisplay destroys the associated resource
10567 database depends on the version of libX11. To avoid both
10568 crash and memory leak, we dissociate the database from the
10569 display and then destroy dpyinfo->xrdb ourselves.
10571 Unfortunately, the above strategy does not work in some
10572 situations due to a bug in newer versions of libX11: because
10573 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10574 dpy->db is NULL, XCloseDisplay destroys the associated
10575 database whereas it has not been created by XGetDefault
10576 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10577 don't destroy the database here in order to avoid the crash
10578 in the above situations for now, though that may cause memory
10579 leaks in other situations. */
10580 #if 0
10581 #ifdef HAVE_XRMSETDATABASE
10582 XrmSetDatabase (dpyinfo->display, NULL);
10583 #else
10584 dpyinfo->display->db = NULL;
10585 #endif
10586 /* We used to call XrmDestroyDatabase from x_delete_display, but
10587 some older versions of libX11 crash if we call it after
10588 closing all the displays. */
10589 XrmDestroyDatabase (dpyinfo->xrdb);
10590 #endif
10592 #ifdef USE_GTK
10593 xg_display_close (dpyinfo->display);
10594 #else
10595 #ifdef USE_X_TOOLKIT
10596 XtCloseDisplay (dpyinfo->display);
10597 #else
10598 XCloseDisplay (dpyinfo->display);
10599 #endif
10600 #endif /* ! USE_GTK */
10603 /* Mark as dead. */
10604 dpyinfo->display = NULL;
10605 x_delete_display (dpyinfo);
10606 unblock_input ();
10609 /* Create a struct terminal, initialize it with the X11 specific
10610 functions and make DISPLAY->TERMINAL point to it. */
10612 static struct terminal *
10613 x_create_terminal (struct x_display_info *dpyinfo)
10615 struct terminal *terminal;
10617 terminal = create_terminal ();
10619 terminal->type = output_x_window;
10620 terminal->display_info.x = dpyinfo;
10621 dpyinfo->terminal = terminal;
10623 /* kboard is initialized in x_term_init. */
10625 terminal->clear_frame_hook = x_clear_frame;
10626 terminal->ins_del_lines_hook = x_ins_del_lines;
10627 terminal->delete_glyphs_hook = x_delete_glyphs;
10628 terminal->ring_bell_hook = XTring_bell;
10629 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10630 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10631 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10632 terminal->update_begin_hook = x_update_begin;
10633 terminal->update_end_hook = x_update_end;
10634 terminal->set_terminal_window_hook = XTset_terminal_window;
10635 terminal->read_socket_hook = XTread_socket;
10636 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10637 terminal->mouse_position_hook = XTmouse_position;
10638 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10639 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10640 terminal->fullscreen_hook = XTfullscreen_hook;
10641 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10642 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10643 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10644 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10646 terminal->delete_frame_hook = x_destroy_window;
10647 terminal->delete_terminal_hook = x_delete_terminal;
10649 terminal->rif = &x_redisplay_interface;
10650 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10651 terminal->char_ins_del_ok = 1;
10652 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10653 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10654 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10655 off the bottom. */
10657 return terminal;
10660 void
10661 x_initialize (void)
10663 baud_rate = 19200;
10665 x_noop_count = 0;
10666 last_tool_bar_item = -1;
10667 any_help_event_p = 0;
10668 ignore_next_mouse_click_timeout = 0;
10670 #ifdef USE_GTK
10671 current_count = -1;
10672 #endif
10674 /* Try to use interrupt input; if we can't, then start polling. */
10675 Fset_input_interrupt_mode (Qt);
10677 #ifdef USE_X_TOOLKIT
10678 XtToolkitInitialize ();
10680 Xt_app_con = XtCreateApplicationContext ();
10682 /* Register a converter from strings to pixels, which uses
10683 Emacs' color allocation infrastructure. */
10684 XtAppSetTypeConverter (Xt_app_con,
10685 XtRString, XtRPixel, cvt_string_to_pixel,
10686 cvt_string_to_pixel_args,
10687 XtNumber (cvt_string_to_pixel_args),
10688 XtCacheByDisplay, cvt_pixel_dtor);
10690 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10691 #endif
10693 #ifdef USE_TOOLKIT_SCROLL_BARS
10694 #ifndef USE_GTK
10695 xaw3d_arrow_scroll = False;
10696 xaw3d_pick_top = True;
10697 #endif
10698 #endif
10700 pending_autoraise_frame = 0;
10701 pending_event_wait.f = 0;
10702 pending_event_wait.eventtype = 0;
10704 /* Note that there is no real way portable across R3/R4 to get the
10705 original error handler. */
10706 XSetErrorHandler (x_error_handler);
10707 XSetIOErrorHandler (x_io_error_quitter);
10711 void
10712 syms_of_xterm (void)
10714 x_error_message = NULL;
10716 staticpro (&x_display_name_list);
10717 x_display_name_list = Qnil;
10719 staticpro (&last_mouse_scroll_bar);
10720 last_mouse_scroll_bar = Qnil;
10722 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
10723 DEFSYM (Qlatin_1, "latin-1");
10725 #ifdef USE_GTK
10726 xg_default_icon_file = build_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10727 staticpro (&xg_default_icon_file);
10729 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
10730 #endif
10732 DEFVAR_BOOL ("x-use-underline-position-properties",
10733 x_use_underline_position_properties,
10734 doc: /* Non-nil means make use of UNDERLINE_POSITION font properties.
10735 A value of nil means ignore them. If you encounter fonts with bogus
10736 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10737 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10738 to override the font's UNDERLINE_POSITION for small font display
10739 sizes. */);
10740 x_use_underline_position_properties = 1;
10742 DEFVAR_BOOL ("x-underline-at-descent-line",
10743 x_underline_at_descent_line,
10744 doc: /* Non-nil means to draw the underline at the same place as the descent line.
10745 A value of nil means to draw the underline according to the value of the
10746 variable `x-use-underline-position-properties', which is usually at the
10747 baseline level. The default value is nil. */);
10748 x_underline_at_descent_line = 0;
10750 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10751 x_mouse_click_focus_ignore_position,
10752 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10753 This variable is only used when the window manager requires that you
10754 click on a frame to select it (give it focus). In that case, a value
10755 of nil, means that the selected window and cursor position changes to
10756 reflect the mouse click position, while a non-nil value means that the
10757 selected window or cursor position is preserved. */);
10758 x_mouse_click_focus_ignore_position = 0;
10760 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10761 doc: /* Which toolkit scroll bars Emacs uses, if any.
10762 A value of nil means Emacs doesn't use toolkit scroll bars.
10763 With the X Window system, the value is a symbol describing the
10764 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10765 With MS Windows or Nextstep, the value is t. */);
10766 #ifdef USE_TOOLKIT_SCROLL_BARS
10767 #ifdef USE_MOTIF
10768 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10769 #elif defined HAVE_XAW3D
10770 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10771 #elif USE_GTK
10772 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10773 #else
10774 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10775 #endif
10776 #else
10777 Vx_toolkit_scroll_bars = Qnil;
10778 #endif
10780 staticpro (&last_mouse_motion_frame);
10781 last_mouse_motion_frame = Qnil;
10783 Qmodifier_value = intern_c_string ("modifier-value");
10784 Qalt = intern_c_string ("alt");
10785 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10786 Qhyper = intern_c_string ("hyper");
10787 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10788 Qmeta = intern_c_string ("meta");
10789 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10790 Qsuper = intern_c_string ("super");
10791 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10793 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10794 doc: /* Which keys Emacs uses for the alt modifier.
10795 This should be one of the symbols `alt', `hyper', `meta', `super'.
10796 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10797 is nil, which is the same as `alt'. */);
10798 Vx_alt_keysym = Qnil;
10800 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10801 doc: /* Which keys Emacs uses for the hyper modifier.
10802 This should be one of the symbols `alt', `hyper', `meta', `super'.
10803 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10804 default is nil, which is the same as `hyper'. */);
10805 Vx_hyper_keysym = Qnil;
10807 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10808 doc: /* Which keys Emacs uses for the meta modifier.
10809 This should be one of the symbols `alt', `hyper', `meta', `super'.
10810 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10811 default is nil, which is the same as `meta'. */);
10812 Vx_meta_keysym = Qnil;
10814 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10815 doc: /* Which keys Emacs uses for the super modifier.
10816 This should be one of the symbols `alt', `hyper', `meta', `super'.
10817 For example, `super' means use the Super_L and Super_R keysyms. The
10818 default is nil, which is the same as `super'. */);
10819 Vx_super_keysym = Qnil;
10821 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10822 doc: /* Hash table of character codes indexed by X keysym codes. */);
10823 Vx_keysym_table = make_hash_table (hashtest_eql, make_number (900),
10824 make_float (DEFAULT_REHASH_SIZE),
10825 make_float (DEFAULT_REHASH_THRESHOLD),
10826 Qnil);
10829 #endif /* HAVE_X_WINDOWS */