rmail-new-summary fix for bug#13066
[emacs.git] / src / xterm.c
blobf8420d13a32e619d5d30ab691c3844b85016ccc3
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993-2012 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 "fontset.h"
73 #include "xsettings.h"
74 #include "xgselect.h"
75 #include "sysselect.h"
77 #ifdef USE_X_TOOLKIT
78 #include <X11/Shell.h>
79 #endif
81 #include <unistd.h>
83 #ifdef USE_GTK
84 #include "gtkutil.h"
85 #ifdef HAVE_GTK3
86 #include <X11/Xproto.h>
87 #endif
88 #endif
90 #ifdef USE_LUCID
91 #include "../lwlib/xlwmenu.h"
92 #endif
94 #ifdef USE_X_TOOLKIT
95 #if !defined (NO_EDITRES)
96 #define HACK_EDITRES
97 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
98 #endif /* not NO_EDITRES */
100 /* Include toolkit specific headers for the scroll bar widget. */
102 #ifdef USE_TOOLKIT_SCROLL_BARS
103 #if defined USE_MOTIF
104 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
105 #include <Xm/ScrollBar.h>
106 #else /* !USE_MOTIF i.e. use Xaw */
108 #ifdef HAVE_XAW3D
109 #include <X11/Xaw3d/Simple.h>
110 #include <X11/Xaw3d/Scrollbar.h>
111 #include <X11/Xaw3d/ThreeD.h>
112 #else /* !HAVE_XAW3D */
113 #include <X11/Xaw/Simple.h>
114 #include <X11/Xaw/Scrollbar.h>
115 #endif /* !HAVE_XAW3D */
116 #ifndef XtNpickTop
117 #define XtNpickTop "pickTop"
118 #endif /* !XtNpickTop */
119 #endif /* !USE_MOTIF */
120 #endif /* USE_TOOLKIT_SCROLL_BARS */
122 #endif /* USE_X_TOOLKIT */
124 #ifdef USE_X_TOOLKIT
125 #include "widget.h"
126 #ifndef XtNinitialState
127 #define XtNinitialState "initialState"
128 #endif
129 #endif
131 #include "bitmaps/gray.xbm"
133 /* Default to using XIM if available. */
134 #ifdef USE_XIM
135 int use_xim = 1;
136 #else
137 int use_xim = 0; /* configure --without-xim */
138 #endif
142 /* Non-zero means that a HELP_EVENT has been generated since Emacs
143 start. */
145 static int any_help_event_p;
147 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
148 static Lisp_Object last_window;
150 /* This is a chain of structures for all the X displays currently in
151 use. */
153 struct x_display_info *x_display_list;
155 /* This is a list of cons cells, each of the form (NAME
156 . FONT-LIST-CACHE), one for each element of x_display_list and in
157 the same order. NAME is the name of the frame. FONT-LIST-CACHE
158 records previous values returned by x-list-fonts. */
160 Lisp_Object x_display_name_list;
162 /* This is a frame waiting to be auto-raised, within XTread_socket. */
164 static struct frame *pending_autoraise_frame;
166 /* This is a frame waiting for an event matching mask, within XTread_socket. */
168 static struct {
169 struct frame *f;
170 int eventtype;
171 } pending_event_wait;
173 #ifdef USE_X_TOOLKIT
174 /* The application context for Xt use. */
175 XtAppContext Xt_app_con;
176 static String Xt_default_resources[] = {0};
178 /* Non-zero means user is interacting with a toolkit scroll bar. */
180 static int toolkit_scroll_bar_interaction;
181 #endif /* USE_X_TOOLKIT */
183 /* Non-zero timeout value means ignore next mouse click if it arrives
184 before that timeout elapses (i.e. as part of the same sequence of
185 events resulting from clicking on a frame to select it). */
187 static unsigned long ignore_next_mouse_click_timeout;
189 /* Mouse movement.
191 Formerly, we used PointerMotionHintMask (in standard_event_mask)
192 so that we would have to call XQueryPointer after each MotionNotify
193 event to ask for another such event. However, this made mouse tracking
194 slow, and there was a bug that made it eventually stop.
196 Simply asking for MotionNotify all the time seems to work better.
198 In order to avoid asking for motion events and then throwing most
199 of them away or busy-polling the server for mouse positions, we ask
200 the server for pointer motion hints. This means that we get only
201 one event per group of mouse movements. "Groups" are delimited by
202 other kinds of events (focus changes and button clicks, for
203 example), or by XQueryPointer calls; when one of these happens, we
204 get another MotionNotify event the next time the mouse moves. This
205 is at least as efficient as getting motion events when mouse
206 tracking is on, and I suspect only negligibly worse when tracking
207 is off. */
209 /* Where the mouse was last time we reported a mouse event. */
211 static XRectangle last_mouse_glyph;
212 static FRAME_PTR last_mouse_glyph_frame;
213 static Lisp_Object last_mouse_press_frame;
215 /* The scroll bar in which the last X motion event occurred.
217 If the last X motion event occurred in a scroll bar, we set this so
218 XTmouse_position can know whether to report a scroll bar motion or
219 an ordinary motion.
221 If the last X motion event didn't occur in a scroll bar, we set
222 this to Qnil, to tell XTmouse_position to return an ordinary motion
223 event. */
225 static Lisp_Object last_mouse_scroll_bar;
227 /* This is a hack. We would really prefer that XTmouse_position would
228 return the time associated with the position it returns, but there
229 doesn't seem to be any way to wrest the time-stamp from the server
230 along with the position query. So, we just keep track of the time
231 of the last movement we received, and return that in hopes that
232 it's somewhat accurate. */
234 static Time last_mouse_movement_time;
236 /* Time for last user interaction as returned in X events. */
238 static Time last_user_time;
240 /* Incremented by XTread_socket whenever it really tries to read
241 events. */
243 static int volatile input_signal_count;
245 /* Used locally within XTread_socket. */
247 static int x_noop_count;
249 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
251 static Lisp_Object Qvendor_specific_keysyms;
252 static Lisp_Object Qlatin_1;
254 #ifdef USE_GTK
255 /* The name of the Emacs icon file. */
256 static Lisp_Object xg_default_icon_file;
258 /* Used in gtkutil.c. */
259 Lisp_Object Qx_gtk_map_stock;
260 #endif
262 /* Some functions take this as char *, not const char *. */
263 static char emacs_class[] = EMACS_CLASS;
265 enum xembed_info
267 XEMBED_MAPPED = 1 << 0
270 enum xembed_message
272 XEMBED_EMBEDDED_NOTIFY = 0,
273 XEMBED_WINDOW_ACTIVATE = 1,
274 XEMBED_WINDOW_DEACTIVATE = 2,
275 XEMBED_REQUEST_FOCUS = 3,
276 XEMBED_FOCUS_IN = 4,
277 XEMBED_FOCUS_OUT = 5,
278 XEMBED_FOCUS_NEXT = 6,
279 XEMBED_FOCUS_PREV = 7,
281 XEMBED_MODALITY_ON = 10,
282 XEMBED_MODALITY_OFF = 11,
283 XEMBED_REGISTER_ACCELERATOR = 12,
284 XEMBED_UNREGISTER_ACCELERATOR = 13,
285 XEMBED_ACTIVATE_ACCELERATOR = 14
288 /* Used in x_flush. */
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 == NULL)
359 Lisp_Object rest, frame;
360 FOR_EACH_FRAME (rest, frame)
361 if (FRAME_X_P (XFRAME (frame)))
362 x_flush (XFRAME (frame));
364 else if (FRAME_X_P (f))
365 XFlush (FRAME_X_DISPLAY (f));
366 unblock_input ();
370 /* Remove calls to XFlush by defining XFlush to an empty replacement.
371 Calls to XFlush should be unnecessary because the X output buffer
372 is flushed automatically as needed by calls to XPending,
373 XNextEvent, or XWindowEvent according to the XFlush man page.
374 XTread_socket calls XPending. Removing XFlush improves
375 performance. */
377 #define XFlush(DISPLAY) (void) 0
380 /***********************************************************************
381 Debugging
382 ***********************************************************************/
384 #if 0
386 /* This is a function useful for recording debugging information about
387 the sequence of occurrences in this file. */
389 struct record
391 char *locus;
392 int type;
395 struct record event_record[100];
397 int event_record_index;
399 void
400 record_event (char *locus, int type)
402 if (event_record_index == sizeof (event_record) / sizeof (struct record))
403 event_record_index = 0;
405 event_record[event_record_index].locus = locus;
406 event_record[event_record_index].type = type;
407 event_record_index++;
410 #endif /* 0 */
414 /* Return the struct x_display_info corresponding to DPY. */
416 struct x_display_info *
417 x_display_info_for_display (Display *dpy)
419 struct x_display_info *dpyinfo;
421 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
422 if (dpyinfo->display == dpy)
423 return dpyinfo;
425 return 0;
428 static Window
429 x_find_topmost_parent (struct frame *f)
431 struct x_output *x = f->output_data.x;
432 Window win = None, wi = x->parent_desc;
433 Display *dpy = FRAME_X_DISPLAY (f);
435 while (wi != FRAME_X_DISPLAY_INFO (f)->root_window)
437 Window root;
438 Window *children;
439 unsigned int nchildren;
441 win = wi;
442 XQueryTree (dpy, win, &root, &wi, &children, &nchildren);
443 XFree (children);
446 return win;
449 #define OPAQUE 0xffffffff
451 void
452 x_set_frame_alpha (struct frame *f)
454 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
455 Display *dpy = FRAME_X_DISPLAY (f);
456 Window win = FRAME_OUTER_WINDOW (f);
457 double alpha = 1.0;
458 double alpha_min = 1.0;
459 unsigned long opac;
460 Window parent;
462 if (dpyinfo->x_highlight_frame == f)
463 alpha = f->alpha[0];
464 else
465 alpha = f->alpha[1];
467 if (FLOATP (Vframe_alpha_lower_limit))
468 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
469 else if (INTEGERP (Vframe_alpha_lower_limit))
470 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
472 if (alpha < 0.0)
473 return;
474 else if (alpha > 1.0)
475 alpha = 1.0;
476 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
477 alpha = alpha_min;
479 opac = alpha * OPAQUE;
481 x_catch_errors (dpy);
483 /* If there is a parent from the window manager, put the property there
484 also, to work around broken window managers that fail to do that.
485 Do this unconditionally as this function is called on reparent when
486 alpha has not changed on the frame. */
488 parent = x_find_topmost_parent (f);
489 if (parent != None)
490 XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
491 XA_CARDINAL, 32, PropModeReplace,
492 (unsigned char *) &opac, 1L);
494 /* return unless necessary */
496 unsigned char *data;
497 Atom actual;
498 int rc, format;
499 unsigned long n, left;
501 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
502 0L, 1L, False, XA_CARDINAL,
503 &actual, &format, &n, &left,
504 &data);
506 if (rc == Success && actual != None)
508 unsigned long value = *(unsigned long *)data;
509 XFree (data);
510 if (value == opac)
512 x_uncatch_errors ();
513 return;
518 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
519 XA_CARDINAL, 32, PropModeReplace,
520 (unsigned char *) &opac, 1L);
521 x_uncatch_errors ();
525 x_display_pixel_height (struct x_display_info *dpyinfo)
527 return HeightOfScreen (dpyinfo->screen);
531 x_display_pixel_width (struct x_display_info *dpyinfo)
533 return WidthOfScreen (dpyinfo->screen);
537 /***********************************************************************
538 Starting and ending an update
539 ***********************************************************************/
541 /* Start an update of frame F. This function is installed as a hook
542 for update_begin, i.e. it is called when update_begin is called.
543 This function is called prior to calls to x_update_window_begin for
544 each window being updated. Currently, there is nothing to do here
545 because all interesting stuff is done on a window basis. */
547 static void
548 x_update_begin (struct frame *f)
550 /* Nothing to do. */
554 /* Start update of window W. Set the global variable updated_window
555 to the window being updated and set output_cursor to the cursor
556 position of W. */
558 static void
559 x_update_window_begin (struct window *w)
561 struct frame *f = XFRAME (WINDOW_FRAME (w));
562 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
564 updated_window = w;
565 set_output_cursor (&w->cursor);
567 block_input ();
569 if (f == hlinfo->mouse_face_mouse_frame)
571 /* Don't do highlighting for mouse motion during the update. */
572 hlinfo->mouse_face_defer = 1;
574 /* If F needs to be redrawn, simply forget about any prior mouse
575 highlighting. */
576 if (FRAME_GARBAGED_P (f))
577 hlinfo->mouse_face_window = Qnil;
580 unblock_input ();
584 /* Draw a vertical window border from (x,y0) to (x,y1) */
586 static void
587 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
589 struct frame *f = XFRAME (WINDOW_FRAME (w));
590 struct face *face;
592 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
593 if (face)
594 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
595 face->foreground);
597 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
598 f->output_data.x->normal_gc, x, y0, x, y1);
601 /* End update of window W (which is equal to updated_window).
603 Draw vertical borders between horizontally adjacent windows, and
604 display W's cursor if CURSOR_ON_P is non-zero.
606 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
607 glyphs in mouse-face were overwritten. In that case we have to
608 make sure that the mouse-highlight is properly redrawn.
610 W may be a menu bar pseudo-window in case we don't have X toolkit
611 support. Such windows don't have a cursor, so don't display it
612 here. */
614 static void
615 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
617 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
619 if (!w->pseudo_window_p)
621 block_input ();
623 if (cursor_on_p)
624 display_and_set_cursor (w, 1, output_cursor.hpos,
625 output_cursor.vpos,
626 output_cursor.x, output_cursor.y);
628 if (draw_window_fringes (w, 1))
629 x_draw_vertical_border (w);
631 unblock_input ();
634 /* If a row with mouse-face was overwritten, arrange for
635 XTframe_up_to_date to redisplay the mouse highlight. */
636 if (mouse_face_overwritten_p)
638 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
639 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
640 hlinfo->mouse_face_window = Qnil;
643 updated_window = NULL;
647 /* End update of frame F. This function is installed as a hook in
648 update_end. */
650 static void
651 x_update_end (struct frame *f)
653 /* Mouse highlight may be displayed again. */
654 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
656 #ifndef XFlush
657 block_input ();
658 XFlush (FRAME_X_DISPLAY (f));
659 unblock_input ();
660 #endif
664 /* This function is called from various places in xdisp.c whenever a
665 complete update has been performed. The global variable
666 updated_window is not available here. */
668 static void
669 XTframe_up_to_date (struct frame *f)
671 if (FRAME_X_P (f))
673 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
675 if (hlinfo->mouse_face_deferred_gc
676 || f == hlinfo->mouse_face_mouse_frame)
678 block_input ();
679 if (hlinfo->mouse_face_mouse_frame)
680 note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
681 hlinfo->mouse_face_mouse_x,
682 hlinfo->mouse_face_mouse_y);
683 hlinfo->mouse_face_deferred_gc = 0;
684 unblock_input ();
690 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
691 arrow bitmaps, or clear the fringes if no bitmaps are required
692 before DESIRED_ROW is made current. The window being updated is
693 found in updated_window. This function It is called from
694 update_window_line only if it is known that there are differences
695 between bitmaps to be drawn between current row and DESIRED_ROW. */
697 static void
698 x_after_update_window_line (struct glyph_row *desired_row)
700 struct window *w = updated_window;
701 struct frame *f;
702 int width, height;
704 eassert (w);
706 if (!desired_row->mode_line_p && !w->pseudo_window_p)
707 desired_row->redraw_fringe_bitmaps_p = 1;
709 /* When a window has disappeared, make sure that no rest of
710 full-width rows stays visible in the internal border. Could
711 check here if updated_window is the leftmost/rightmost window,
712 but I guess it's not worth doing since vertically split windows
713 are almost never used, internal border is rarely set, and the
714 overhead is very small. */
715 if (windows_or_buffers_changed
716 && desired_row->full_width_p
717 && (f = XFRAME (w->frame),
718 width = FRAME_INTERNAL_BORDER_WIDTH (f),
719 width != 0)
720 && (height = desired_row->visible_height,
721 height > 0))
723 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
725 block_input ();
726 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
727 0, y, width, height, False);
728 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
729 FRAME_PIXEL_WIDTH (f) - width,
730 y, width, height, False);
731 unblock_input ();
735 static void
736 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
738 struct frame *f = XFRAME (WINDOW_FRAME (w));
739 Display *display = FRAME_X_DISPLAY (f);
740 Window window = FRAME_X_WINDOW (f);
741 GC gc = f->output_data.x->normal_gc;
742 struct face *face = p->face;
744 /* Must clip because of partially visible lines. */
745 x_clip_to_row (w, row, -1, gc);
747 if (!p->overlay_p)
749 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
751 /* In case the same realized face is used for fringes and
752 for something displayed in the text (e.g. face `region' on
753 mono-displays, the fill style may have been changed to
754 FillSolid in x_draw_glyph_string_background. */
755 if (face->stipple)
756 XSetFillStyle (display, face->gc, FillOpaqueStippled);
757 else
758 XSetForeground (display, face->gc, face->background);
760 #ifdef USE_TOOLKIT_SCROLL_BARS
761 /* If the fringe is adjacent to the left (right) scroll bar of a
762 leftmost (rightmost, respectively) window, then extend its
763 background to the gap between the fringe and the bar. */
764 if ((WINDOW_LEFTMOST_P (w)
765 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
766 || (WINDOW_RIGHTMOST_P (w)
767 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
769 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
771 if (sb_width > 0)
773 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
774 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
775 * FRAME_COLUMN_WIDTH (f));
777 if (bx < 0)
779 /* Bitmap fills the fringe. */
780 if (bar_area_x + bar_area_width == p->x)
781 bx = bar_area_x + sb_width;
782 else if (p->x + p->wd == bar_area_x)
783 bx = bar_area_x;
784 if (bx >= 0)
786 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
788 nx = bar_area_width - sb_width;
789 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
790 row->y));
791 ny = row->visible_height;
794 else
796 if (bar_area_x + bar_area_width == bx)
798 bx = bar_area_x + sb_width;
799 nx += bar_area_width - sb_width;
801 else if (bx + nx == bar_area_x)
802 nx += bar_area_width - sb_width;
806 #endif
807 if (bx >= 0 && nx > 0)
808 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
810 if (!face->stipple)
811 XSetForeground (display, face->gc, face->foreground);
814 if (p->which)
816 char *bits;
817 Pixmap pixmap, clipmask = (Pixmap) 0;
818 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
819 XGCValues gcv;
821 if (p->wd > 8)
822 bits = (char *) (p->bits + p->dh);
823 else
824 bits = (char *) p->bits + p->dh;
826 /* Draw the bitmap. I believe these small pixmaps can be cached
827 by the server. */
828 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
829 (p->cursor_p
830 ? (p->overlay_p ? face->background
831 : f->output_data.x->cursor_pixel)
832 : face->foreground),
833 face->background, depth);
835 if (p->overlay_p)
837 clipmask = XCreatePixmapFromBitmapData (display,
838 FRAME_X_DISPLAY_INFO (f)->root_window,
839 bits, p->wd, p->h,
840 1, 0, 1);
841 gcv.clip_mask = clipmask;
842 gcv.clip_x_origin = p->x;
843 gcv.clip_y_origin = p->y;
844 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
847 XCopyArea (display, pixmap, window, gc, 0, 0,
848 p->wd, p->h, p->x, p->y);
849 XFreePixmap (display, pixmap);
851 if (p->overlay_p)
853 gcv.clip_mask = (Pixmap) 0;
854 XChangeGC (display, gc, GCClipMask, &gcv);
855 XFreePixmap (display, clipmask);
859 XSetClipMask (display, gc, None);
864 /* This is called when starting Emacs and when restarting after
865 suspend. When starting Emacs, no X window is mapped. And nothing
866 must be done to Emacs's own window if it is suspended (though that
867 rarely happens). */
869 static void
870 XTset_terminal_modes (struct terminal *terminal)
874 /* This is called when exiting or suspending Emacs. Exiting will make
875 the X-windows go away, and suspending requires no action. */
877 static void
878 XTreset_terminal_modes (struct terminal *terminal)
883 /***********************************************************************
884 Glyph display
885 ***********************************************************************/
889 static void x_set_glyph_string_clipping (struct glyph_string *);
890 static void x_set_glyph_string_gc (struct glyph_string *);
891 static void x_draw_glyph_string_background (struct glyph_string *,
892 int);
893 static void x_draw_glyph_string_foreground (struct glyph_string *);
894 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
895 static void x_draw_glyph_string_box (struct glyph_string *);
896 static void x_draw_glyph_string (struct glyph_string *);
897 static _Noreturn void x_delete_glyphs (struct frame *, int);
898 static void x_compute_glyph_string_overhangs (struct glyph_string *);
899 static void x_set_cursor_gc (struct glyph_string *);
900 static void x_set_mode_line_face_gc (struct glyph_string *);
901 static void x_set_mouse_face_gc (struct glyph_string *);
902 static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
903 unsigned long *, double, int);
904 static void x_setup_relief_color (struct frame *, struct relief *,
905 double, int, unsigned long);
906 static void x_setup_relief_colors (struct glyph_string *);
907 static void x_draw_image_glyph_string (struct glyph_string *);
908 static void x_draw_image_relief (struct glyph_string *);
909 static void x_draw_image_foreground (struct glyph_string *);
910 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
911 static void x_clear_glyph_string_rect (struct glyph_string *, int,
912 int, int, int);
913 static void x_draw_relief_rect (struct frame *, int, int, int, int,
914 int, int, int, int, int, int,
915 XRectangle *);
916 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
917 int, int, int, XRectangle *);
918 static void x_scroll_bar_clear (struct frame *);
920 #ifdef GLYPH_DEBUG
921 static void x_check_font (struct frame *, struct font *);
922 #endif
925 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
926 face. */
928 static void
929 x_set_cursor_gc (struct glyph_string *s)
931 if (s->font == FRAME_FONT (s->f)
932 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
933 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
934 && !s->cmp)
935 s->gc = s->f->output_data.x->cursor_gc;
936 else
938 /* Cursor on non-default face: must merge. */
939 XGCValues xgcv;
940 unsigned long mask;
942 xgcv.background = s->f->output_data.x->cursor_pixel;
943 xgcv.foreground = s->face->background;
945 /* If the glyph would be invisible, try a different foreground. */
946 if (xgcv.foreground == xgcv.background)
947 xgcv.foreground = s->face->foreground;
948 if (xgcv.foreground == xgcv.background)
949 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
950 if (xgcv.foreground == xgcv.background)
951 xgcv.foreground = s->face->foreground;
953 /* Make sure the cursor is distinct from text in this face. */
954 if (xgcv.background == s->face->background
955 && xgcv.foreground == s->face->foreground)
957 xgcv.background = s->face->foreground;
958 xgcv.foreground = s->face->background;
961 IF_DEBUG (x_check_font (s->f, s->font));
962 xgcv.graphics_exposures = False;
963 mask = GCForeground | GCBackground | GCGraphicsExposures;
965 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
966 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
967 mask, &xgcv);
968 else
969 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
970 = XCreateGC (s->display, s->window, mask, &xgcv);
972 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
977 /* Set up S->gc of glyph string S for drawing text in mouse face. */
979 static void
980 x_set_mouse_face_gc (struct glyph_string *s)
982 int face_id;
983 struct face *face;
985 /* What face has to be used last for the mouse face? */
986 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
987 face = FACE_FROM_ID (s->f, face_id);
988 if (face == NULL)
989 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
991 if (s->first_glyph->type == CHAR_GLYPH)
992 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
993 else
994 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
995 s->face = FACE_FROM_ID (s->f, face_id);
996 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
998 if (s->font == s->face->font)
999 s->gc = s->face->gc;
1000 else
1002 /* Otherwise construct scratch_cursor_gc with values from FACE
1003 except for FONT. */
1004 XGCValues xgcv;
1005 unsigned long mask;
1007 xgcv.background = s->face->background;
1008 xgcv.foreground = s->face->foreground;
1009 xgcv.graphics_exposures = False;
1010 mask = GCForeground | GCBackground | GCGraphicsExposures;
1012 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1013 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1014 mask, &xgcv);
1015 else
1016 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1017 = XCreateGC (s->display, s->window, mask, &xgcv);
1019 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1022 eassert (s->gc != 0);
1026 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1027 Faces to use in the mode line have already been computed when the
1028 matrix was built, so there isn't much to do, here. */
1030 static void
1031 x_set_mode_line_face_gc (struct glyph_string *s)
1033 s->gc = s->face->gc;
1037 /* Set S->gc of glyph string S for drawing that glyph string. Set
1038 S->stippled_p to a non-zero value if the face of S has a stipple
1039 pattern. */
1041 static void
1042 x_set_glyph_string_gc (struct glyph_string *s)
1044 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1046 if (s->hl == DRAW_NORMAL_TEXT)
1048 s->gc = s->face->gc;
1049 s->stippled_p = s->face->stipple != 0;
1051 else if (s->hl == DRAW_INVERSE_VIDEO)
1053 x_set_mode_line_face_gc (s);
1054 s->stippled_p = s->face->stipple != 0;
1056 else if (s->hl == DRAW_CURSOR)
1058 x_set_cursor_gc (s);
1059 s->stippled_p = 0;
1061 else if (s->hl == DRAW_MOUSE_FACE)
1063 x_set_mouse_face_gc (s);
1064 s->stippled_p = s->face->stipple != 0;
1066 else if (s->hl == DRAW_IMAGE_RAISED
1067 || s->hl == DRAW_IMAGE_SUNKEN)
1069 s->gc = s->face->gc;
1070 s->stippled_p = s->face->stipple != 0;
1072 else
1074 s->gc = s->face->gc;
1075 s->stippled_p = s->face->stipple != 0;
1078 /* GC must have been set. */
1079 eassert (s->gc != 0);
1083 /* Set clipping for output of glyph string S. S may be part of a mode
1084 line or menu if we don't have X toolkit support. */
1086 static void
1087 x_set_glyph_string_clipping (struct glyph_string *s)
1089 XRectangle *r = s->clip;
1090 int n = get_glyph_string_clip_rects (s, r, 2);
1092 if (n > 0)
1093 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1094 s->num_clips = n;
1098 /* Set SRC's clipping for output of glyph string DST. This is called
1099 when we are drawing DST's left_overhang or right_overhang only in
1100 the area of SRC. */
1102 static void
1103 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1105 XRectangle r;
1107 r.x = src->x;
1108 r.width = src->width;
1109 r.y = src->y;
1110 r.height = src->height;
1111 dst->clip[0] = r;
1112 dst->num_clips = 1;
1113 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1117 /* RIF:
1118 Compute left and right overhang of glyph string S. */
1120 static void
1121 x_compute_glyph_string_overhangs (struct glyph_string *s)
1123 if (s->cmp == NULL
1124 && (s->first_glyph->type == CHAR_GLYPH
1125 || s->first_glyph->type == COMPOSITE_GLYPH))
1127 struct font_metrics metrics;
1129 if (s->first_glyph->type == CHAR_GLYPH)
1131 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1132 struct font *font = s->font;
1133 int i;
1135 for (i = 0; i < s->nchars; i++)
1136 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1137 font->driver->text_extents (font, code, s->nchars, &metrics);
1139 else
1141 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1143 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1145 s->right_overhang = (metrics.rbearing > metrics.width
1146 ? metrics.rbearing - metrics.width : 0);
1147 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1149 else if (s->cmp)
1151 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1152 s->left_overhang = - s->cmp->lbearing;
1157 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1159 static void
1160 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1162 XGCValues xgcv;
1163 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1164 XSetForeground (s->display, s->gc, xgcv.background);
1165 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1166 XSetForeground (s->display, s->gc, xgcv.foreground);
1170 /* Draw the background of glyph_string S. If S->background_filled_p
1171 is non-zero don't draw it. FORCE_P non-zero means draw the
1172 background even if it wouldn't be drawn normally. This is used
1173 when a string preceding S draws into the background of S, or S
1174 contains the first component of a composition. */
1176 static void
1177 x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1179 /* Nothing to do if background has already been drawn or if it
1180 shouldn't be drawn in the first place. */
1181 if (!s->background_filled_p)
1183 int box_line_width = max (s->face->box_line_width, 0);
1185 if (s->stippled_p)
1187 /* Fill background with a stipple pattern. */
1188 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1189 XFillRectangle (s->display, s->window, s->gc, s->x,
1190 s->y + box_line_width,
1191 s->background_width,
1192 s->height - 2 * box_line_width);
1193 XSetFillStyle (s->display, s->gc, FillSolid);
1194 s->background_filled_p = 1;
1196 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1197 || s->font_not_found_p
1198 || s->extends_to_end_of_line_p
1199 || force_p)
1201 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1202 s->background_width,
1203 s->height - 2 * box_line_width);
1204 s->background_filled_p = 1;
1210 /* Draw the foreground of glyph string S. */
1212 static void
1213 x_draw_glyph_string_foreground (struct glyph_string *s)
1215 int i, x;
1217 /* If first glyph of S has a left box line, start drawing the text
1218 of S to the right of that box line. */
1219 if (s->face->box != FACE_NO_BOX
1220 && s->first_glyph->left_box_line_p)
1221 x = s->x + eabs (s->face->box_line_width);
1222 else
1223 x = s->x;
1225 /* Draw characters of S as rectangles if S's font could not be
1226 loaded. */
1227 if (s->font_not_found_p)
1229 for (i = 0; i < s->nchars; ++i)
1231 struct glyph *g = s->first_glyph + i;
1232 XDrawRectangle (s->display, s->window,
1233 s->gc, x, s->y, g->pixel_width - 1,
1234 s->height - 1);
1235 x += g->pixel_width;
1238 else
1240 struct font *font = s->font;
1241 int boff = font->baseline_offset;
1242 int y;
1244 if (font->vertical_centering)
1245 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1247 y = s->ybase - boff;
1248 if (s->for_overlaps
1249 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1250 font->driver->draw (s, 0, s->nchars, x, y, 0);
1251 else
1252 font->driver->draw (s, 0, s->nchars, x, y, 1);
1253 if (s->face->overstrike)
1254 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1258 /* Draw the foreground of composite glyph string S. */
1260 static void
1261 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1263 int i, j, x;
1264 struct font *font = s->font;
1266 /* If first glyph of S has a left box line, start drawing the text
1267 of S to the right of that box line. */
1268 if (s->face && s->face->box != FACE_NO_BOX
1269 && s->first_glyph->left_box_line_p)
1270 x = s->x + eabs (s->face->box_line_width);
1271 else
1272 x = s->x;
1274 /* S is a glyph string for a composition. S->cmp_from is the index
1275 of the first character drawn for glyphs of this composition.
1276 S->cmp_from == 0 means we are drawing the very first character of
1277 this composition. */
1279 /* Draw a rectangle for the composition if the font for the very
1280 first character of the composition could not be loaded. */
1281 if (s->font_not_found_p)
1283 if (s->cmp_from == 0)
1284 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1285 s->width - 1, s->height - 1);
1287 else if (! s->first_glyph->u.cmp.automatic)
1289 int y = s->ybase;
1291 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1292 /* TAB in a composition means display glyphs with padding
1293 space on the left or right. */
1294 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1296 int xx = x + s->cmp->offsets[j * 2];
1297 int yy = y - s->cmp->offsets[j * 2 + 1];
1299 font->driver->draw (s, j, j + 1, xx, yy, 0);
1300 if (s->face->overstrike)
1301 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1304 else
1306 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1307 Lisp_Object glyph;
1308 int y = s->ybase;
1309 int width = 0;
1311 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1313 glyph = LGSTRING_GLYPH (gstring, i);
1314 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1315 width += LGLYPH_WIDTH (glyph);
1316 else
1318 int xoff, yoff, wadjust;
1320 if (j < i)
1322 font->driver->draw (s, j, i, x, y, 0);
1323 if (s->face->overstrike)
1324 font->driver->draw (s, j, i, x + 1, y, 0);
1325 x += width;
1327 xoff = LGLYPH_XOFF (glyph);
1328 yoff = LGLYPH_YOFF (glyph);
1329 wadjust = LGLYPH_WADJUST (glyph);
1330 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1331 if (s->face->overstrike)
1332 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1333 x += wadjust;
1334 j = i + 1;
1335 width = 0;
1338 if (j < i)
1340 font->driver->draw (s, j, i, x, y, 0);
1341 if (s->face->overstrike)
1342 font->driver->draw (s, j, i, x + 1, y, 0);
1348 /* Draw the foreground of glyph string S for glyphless characters. */
1350 static void
1351 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1353 struct glyph *glyph = s->first_glyph;
1354 XChar2b char2b[8];
1355 int x, i, j;
1357 /* If first glyph of S has a left box line, start drawing the text
1358 of S to the right of that box line. */
1359 if (s->face && s->face->box != FACE_NO_BOX
1360 && s->first_glyph->left_box_line_p)
1361 x = s->x + eabs (s->face->box_line_width);
1362 else
1363 x = s->x;
1365 s->char2b = char2b;
1367 for (i = 0; i < s->nchars; i++, glyph++)
1369 char buf[7], *str = NULL;
1370 int len = glyph->u.glyphless.len;
1372 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1374 if (len > 0
1375 && CHAR_TABLE_P (Vglyphless_char_display)
1376 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1377 >= 1))
1379 Lisp_Object acronym
1380 = (! glyph->u.glyphless.for_no_font
1381 ? CHAR_TABLE_REF (Vglyphless_char_display,
1382 glyph->u.glyphless.ch)
1383 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1384 if (STRINGP (acronym))
1385 str = SSDATA (acronym);
1388 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1390 sprintf ((char *) buf, "%0*X",
1391 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1392 glyph->u.glyphless.ch);
1393 str = buf;
1396 if (str)
1398 int upper_len = (len + 1) / 2;
1399 unsigned code;
1401 /* It is assured that all LEN characters in STR is ASCII. */
1402 for (j = 0; j < len; j++)
1404 code = s->font->driver->encode_char (s->font, str[j]);
1405 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1407 s->font->driver->draw (s, 0, upper_len,
1408 x + glyph->slice.glyphless.upper_xoff,
1409 s->ybase + glyph->slice.glyphless.upper_yoff,
1411 s->font->driver->draw (s, upper_len, len,
1412 x + glyph->slice.glyphless.lower_xoff,
1413 s->ybase + glyph->slice.glyphless.lower_yoff,
1416 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1417 XDrawRectangle (s->display, s->window, s->gc,
1418 x, s->ybase - glyph->ascent,
1419 glyph->pixel_width - 1,
1420 glyph->ascent + glyph->descent - 1);
1421 x += glyph->pixel_width;
1425 #ifdef USE_X_TOOLKIT
1427 static Boolean cvt_string_to_pixel (Display *, XrmValue *, Cardinal *,
1428 XrmValue *, XrmValue *, XtPointer *);
1429 static void cvt_pixel_dtor (XtAppContext, XrmValue *, XtPointer,
1430 XrmValue *, Cardinal *);
1432 #ifdef USE_LUCID
1434 /* Return the frame on which widget WIDGET is used.. Abort if frame
1435 cannot be determined. */
1437 static struct frame *
1438 x_frame_of_widget (Widget widget)
1440 struct x_display_info *dpyinfo;
1441 Lisp_Object tail;
1442 struct frame *f;
1444 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1446 /* Find the top-level shell of the widget. Note that this function
1447 can be called when the widget is not yet realized, so XtWindow
1448 (widget) == 0. That's the reason we can't simply use
1449 x_any_window_to_frame. */
1450 while (!XtIsTopLevelShell (widget))
1451 widget = XtParent (widget);
1453 /* Look for a frame with that top-level widget. Allocate the color
1454 on that frame to get the right gamma correction value. */
1455 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1456 if (FRAMEP (XCAR (tail))
1457 && (f = XFRAME (XCAR (tail)),
1458 (FRAME_X_P (f)
1459 && f->output_data.nothing != 1
1460 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1461 && f->output_data.x->widget == widget)
1462 return f;
1464 emacs_abort ();
1467 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1468 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1469 If this produces the same color as PIXEL, try a color where all RGB
1470 values have DELTA added. Return the allocated color in *PIXEL.
1471 DISPLAY is the X display, CMAP is the colormap to operate on.
1472 Value is true if successful. */
1474 bool
1475 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1476 unsigned long *pixel, double factor, int delta)
1478 struct frame *f = x_frame_of_widget (widget);
1479 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1482 #endif /* USE_LUCID */
1485 /* Structure specifying which arguments should be passed by Xt to
1486 cvt_string_to_pixel. We want the widget's screen and colormap. */
1488 static XtConvertArgRec cvt_string_to_pixel_args[] =
1490 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1491 sizeof (Screen *)},
1492 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1493 sizeof (Colormap)}
1497 /* The address of this variable is returned by
1498 cvt_string_to_pixel. */
1500 static Pixel cvt_string_to_pixel_value;
1503 /* Convert a color name to a pixel color.
1505 DPY is the display we are working on.
1507 ARGS is an array of *NARGS XrmValue structures holding additional
1508 information about the widget for which the conversion takes place.
1509 The contents of this array are determined by the specification
1510 in cvt_string_to_pixel_args.
1512 FROM is a pointer to an XrmValue which points to the color name to
1513 convert. TO is an XrmValue in which to return the pixel color.
1515 CLOSURE_RET is a pointer to user-data, in which we record if
1516 we allocated the color or not.
1518 Value is True if successful, False otherwise. */
1520 static Boolean
1521 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1522 XrmValue *from, XrmValue *to,
1523 XtPointer *closure_ret)
1525 Screen *screen;
1526 Colormap cmap;
1527 Pixel pixel;
1528 String color_name;
1529 XColor color;
1531 if (*nargs != 2)
1533 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1534 "wrongParameters", "cvt_string_to_pixel",
1535 "XtToolkitError",
1536 "Screen and colormap args required", NULL, NULL);
1537 return False;
1540 screen = *(Screen **) args[0].addr;
1541 cmap = *(Colormap *) args[1].addr;
1542 color_name = (String) from->addr;
1544 if (strcmp (color_name, XtDefaultBackground) == 0)
1546 *closure_ret = (XtPointer) False;
1547 pixel = WhitePixelOfScreen (screen);
1549 else if (strcmp (color_name, XtDefaultForeground) == 0)
1551 *closure_ret = (XtPointer) False;
1552 pixel = BlackPixelOfScreen (screen);
1554 else if (XParseColor (dpy, cmap, color_name, &color)
1555 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1557 pixel = color.pixel;
1558 *closure_ret = (XtPointer) True;
1560 else
1562 String params[1];
1563 Cardinal nparams = 1;
1565 params[0] = color_name;
1566 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1567 "badValue", "cvt_string_to_pixel",
1568 "XtToolkitError", "Invalid color `%s'",
1569 params, &nparams);
1570 return False;
1573 if (to->addr != NULL)
1575 if (to->size < sizeof (Pixel))
1577 to->size = sizeof (Pixel);
1578 return False;
1581 *(Pixel *) to->addr = pixel;
1583 else
1585 cvt_string_to_pixel_value = pixel;
1586 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1589 to->size = sizeof (Pixel);
1590 return True;
1594 /* Free a pixel color which was previously allocated via
1595 cvt_string_to_pixel. This is registered as the destructor
1596 for this type of resource via XtSetTypeConverter.
1598 APP is the application context in which we work.
1600 TO is a pointer to an XrmValue holding the color to free.
1601 CLOSURE is the value we stored in CLOSURE_RET for this color
1602 in cvt_string_to_pixel.
1604 ARGS and NARGS are like for cvt_string_to_pixel. */
1606 static void
1607 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1608 Cardinal *nargs)
1610 if (*nargs != 2)
1612 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1613 "XtToolkitError",
1614 "Screen and colormap arguments required",
1615 NULL, NULL);
1617 else if (closure != NULL)
1619 /* We did allocate the pixel, so free it. */
1620 Screen *screen = *(Screen **) args[0].addr;
1621 Colormap cmap = *(Colormap *) args[1].addr;
1622 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1623 (Pixel *) to->addr, 1);
1628 #endif /* USE_X_TOOLKIT */
1631 /* Value is an array of XColor structures for the contents of the
1632 color map of display DPY. Set *NCELLS to the size of the array.
1633 Note that this probably shouldn't be called for large color maps,
1634 say a 24-bit TrueColor map. */
1636 static const XColor *
1637 x_color_cells (Display *dpy, int *ncells)
1639 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1641 if (dpyinfo->color_cells == NULL)
1643 Screen *screen = dpyinfo->screen;
1644 int ncolor_cells = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1645 int i;
1647 dpyinfo->color_cells = xnmalloc (ncolor_cells,
1648 sizeof *dpyinfo->color_cells);
1649 dpyinfo->ncolor_cells = ncolor_cells;
1651 for (i = 0; i < ncolor_cells; ++i)
1652 dpyinfo->color_cells[i].pixel = i;
1654 XQueryColors (dpy, dpyinfo->cmap,
1655 dpyinfo->color_cells, ncolor_cells);
1658 *ncells = dpyinfo->ncolor_cells;
1659 return dpyinfo->color_cells;
1663 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1664 colors in COLORS. Use cached information, if available. */
1666 void
1667 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1669 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1671 if (dpyinfo->color_cells)
1673 int i;
1674 for (i = 0; i < ncolors; ++i)
1676 unsigned long pixel = colors[i].pixel;
1677 eassert (pixel < dpyinfo->ncolor_cells);
1678 eassert (dpyinfo->color_cells[pixel].pixel == pixel);
1679 colors[i] = dpyinfo->color_cells[pixel];
1682 else
1683 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1687 /* On frame F, translate pixel color to RGB values for the color in
1688 COLOR. Use cached information, if available. */
1690 void
1691 x_query_color (struct frame *f, XColor *color)
1693 x_query_colors (f, color, 1);
1697 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1698 exact match can't be allocated, try the nearest color available.
1699 Value is true if successful. Set *COLOR to the color
1700 allocated. */
1702 static bool
1703 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1705 bool rc;
1707 rc = XAllocColor (dpy, cmap, color) != 0;
1708 if (rc == 0)
1710 /* If we got to this point, the colormap is full, so we're going
1711 to try to get the next closest color. The algorithm used is
1712 a least-squares matching, which is what X uses for closest
1713 color matching with StaticColor visuals. */
1714 int nearest, i;
1715 int max_color_delta = 255;
1716 int max_delta = 3 * max_color_delta;
1717 int nearest_delta = max_delta + 1;
1718 int ncells;
1719 const XColor *cells = x_color_cells (dpy, &ncells);
1721 for (nearest = i = 0; i < ncells; ++i)
1723 int dred = (color->red >> 8) - (cells[i].red >> 8);
1724 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
1725 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1726 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
1728 if (delta < nearest_delta)
1730 nearest = i;
1731 nearest_delta = delta;
1735 color->red = cells[nearest].red;
1736 color->green = cells[nearest].green;
1737 color->blue = cells[nearest].blue;
1738 rc = XAllocColor (dpy, cmap, color) != 0;
1740 else
1742 /* If allocation succeeded, and the allocated pixel color is not
1743 equal to a cached pixel color recorded earlier, there was a
1744 change in the colormap, so clear the color cache. */
1745 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1746 XColor *cached_color;
1748 if (dpyinfo->color_cells
1749 && (cached_color = &dpyinfo->color_cells[color->pixel],
1750 (cached_color->red != color->red
1751 || cached_color->blue != color->blue
1752 || cached_color->green != color->green)))
1754 xfree (dpyinfo->color_cells);
1755 dpyinfo->color_cells = NULL;
1756 dpyinfo->ncolor_cells = 0;
1760 #ifdef DEBUG_X_COLORS
1761 if (rc)
1762 register_color (color->pixel);
1763 #endif /* DEBUG_X_COLORS */
1765 return rc;
1769 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1770 exact match can't be allocated, try the nearest color available.
1771 Value is true if successful. Set *COLOR to the color
1772 allocated. */
1774 bool
1775 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1777 gamma_correct (f, color);
1778 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1782 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1783 It's necessary to do this instead of just using PIXEL directly to
1784 get color reference counts right. */
1786 unsigned long
1787 x_copy_color (struct frame *f, long unsigned int pixel)
1789 XColor color;
1791 color.pixel = pixel;
1792 block_input ();
1793 x_query_color (f, &color);
1794 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1795 unblock_input ();
1796 #ifdef DEBUG_X_COLORS
1797 register_color (pixel);
1798 #endif
1799 return color.pixel;
1803 /* Brightness beyond which a color won't have its highlight brightness
1804 boosted.
1806 Nominally, highlight colors for `3d' faces are calculated by
1807 brightening an object's color by a constant scale factor, but this
1808 doesn't yield good results for dark colors, so for colors who's
1809 brightness is less than this value (on a scale of 0-65535) have an
1810 use an additional additive factor.
1812 The value here is set so that the default menu-bar/mode-line color
1813 (grey75) will not have its highlights changed at all. */
1814 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1817 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1818 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1819 If this produces the same color as PIXEL, try a color where all RGB
1820 values have DELTA added. Return the allocated color in *PIXEL.
1821 DISPLAY is the X display, CMAP is the colormap to operate on.
1822 Value is non-zero if successful. */
1824 static bool
1825 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1827 XColor color, new;
1828 long bright;
1829 bool success_p;
1831 /* Get RGB color values. */
1832 color.pixel = *pixel;
1833 x_query_color (f, &color);
1835 /* Change RGB values by specified FACTOR. Avoid overflow! */
1836 eassert (factor >= 0);
1837 new.red = min (0xffff, factor * color.red);
1838 new.green = min (0xffff, factor * color.green);
1839 new.blue = min (0xffff, factor * color.blue);
1841 /* Calculate brightness of COLOR. */
1842 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1844 /* We only boost colors that are darker than
1845 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1846 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1847 /* Make an additive adjustment to NEW, because it's dark enough so
1848 that scaling by FACTOR alone isn't enough. */
1850 /* How far below the limit this color is (0 - 1, 1 being darker). */
1851 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1852 /* The additive adjustment. */
1853 int min_delta = delta * dimness * factor / 2;
1855 if (factor < 1)
1857 new.red = max (0, new.red - min_delta);
1858 new.green = max (0, new.green - min_delta);
1859 new.blue = max (0, new.blue - min_delta);
1861 else
1863 new.red = min (0xffff, min_delta + new.red);
1864 new.green = min (0xffff, min_delta + new.green);
1865 new.blue = min (0xffff, min_delta + new.blue);
1869 /* Try to allocate the color. */
1870 success_p = x_alloc_nearest_color (f, cmap, &new);
1871 if (success_p)
1873 if (new.pixel == *pixel)
1875 /* If we end up with the same color as before, try adding
1876 delta to the RGB values. */
1877 x_free_colors (f, &new.pixel, 1);
1879 new.red = min (0xffff, delta + color.red);
1880 new.green = min (0xffff, delta + color.green);
1881 new.blue = min (0xffff, delta + color.blue);
1882 success_p = x_alloc_nearest_color (f, cmap, &new);
1884 else
1885 success_p = 1;
1886 *pixel = new.pixel;
1889 return success_p;
1893 /* Set up the foreground color for drawing relief lines of glyph
1894 string S. RELIEF is a pointer to a struct relief containing the GC
1895 with which lines will be drawn. Use a color that is FACTOR or
1896 DELTA lighter or darker than the relief's background which is found
1897 in S->f->output_data.x->relief_background. If such a color cannot
1898 be allocated, use DEFAULT_PIXEL, instead. */
1900 static void
1901 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1903 XGCValues xgcv;
1904 struct x_output *di = f->output_data.x;
1905 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1906 unsigned long pixel;
1907 unsigned long background = di->relief_background;
1908 Colormap cmap = FRAME_X_COLORMAP (f);
1909 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1910 Display *dpy = FRAME_X_DISPLAY (f);
1912 xgcv.graphics_exposures = False;
1913 xgcv.line_width = 1;
1915 /* Free previously allocated color. The color cell will be reused
1916 when it has been freed as many times as it was allocated, so this
1917 doesn't affect faces using the same colors. */
1918 if (relief->gc
1919 && relief->allocated_p)
1921 x_free_colors (f, &relief->pixel, 1);
1922 relief->allocated_p = 0;
1925 /* Allocate new color. */
1926 xgcv.foreground = default_pixel;
1927 pixel = background;
1928 if (dpyinfo->n_planes != 1
1929 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1931 relief->allocated_p = 1;
1932 xgcv.foreground = relief->pixel = pixel;
1935 if (relief->gc == 0)
1937 xgcv.stipple = dpyinfo->gray;
1938 mask |= GCStipple;
1939 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1941 else
1942 XChangeGC (dpy, relief->gc, mask, &xgcv);
1946 /* Set up colors for the relief lines around glyph string S. */
1948 static void
1949 x_setup_relief_colors (struct glyph_string *s)
1951 struct x_output *di = s->f->output_data.x;
1952 unsigned long color;
1954 if (s->face->use_box_color_for_shadows_p)
1955 color = s->face->box_color;
1956 else if (s->first_glyph->type == IMAGE_GLYPH
1957 && s->img->pixmap
1958 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1959 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1960 else
1962 XGCValues xgcv;
1964 /* Get the background color of the face. */
1965 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1966 color = xgcv.background;
1969 if (di->white_relief.gc == 0
1970 || color != di->relief_background)
1972 di->relief_background = color;
1973 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1974 WHITE_PIX_DEFAULT (s->f));
1975 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1976 BLACK_PIX_DEFAULT (s->f));
1981 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
1982 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
1983 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
1984 relief. LEFT_P non-zero means draw a relief on the left side of
1985 the rectangle. RIGHT_P non-zero means draw a relief on the right
1986 side of the rectangle. CLIP_RECT is the clipping rectangle to use
1987 when drawing. */
1989 static void
1990 x_draw_relief_rect (struct frame *f,
1991 int left_x, int top_y, int right_x, int bottom_y, int width,
1992 int raised_p, int top_p, int bot_p, int left_p, int right_p,
1993 XRectangle *clip_rect)
1995 Display *dpy = FRAME_X_DISPLAY (f);
1996 Window window = FRAME_X_WINDOW (f);
1997 int i;
1998 GC gc;
2000 if (raised_p)
2001 gc = f->output_data.x->white_relief.gc;
2002 else
2003 gc = f->output_data.x->black_relief.gc;
2004 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2006 /* This code is more complicated than it has to be, because of two
2007 minor hacks to make the boxes look nicer: (i) if width > 1, draw
2008 the outermost line using the black relief. (ii) Omit the four
2009 corner pixels. */
2011 /* Top. */
2012 if (top_p)
2014 if (width == 1)
2015 XDrawLine (dpy, window, gc,
2016 left_x + (left_p ? 1 : 0), top_y,
2017 right_x + (right_p ? 0 : 1), top_y);
2019 for (i = 1; i < width; ++i)
2020 XDrawLine (dpy, window, gc,
2021 left_x + i * left_p, top_y + i,
2022 right_x + 1 - i * right_p, top_y + i);
2025 /* Left. */
2026 if (left_p)
2028 if (width == 1)
2029 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2031 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2032 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2034 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2035 XDrawLine (dpy, window, gc,
2036 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2039 XSetClipMask (dpy, gc, None);
2040 if (raised_p)
2041 gc = f->output_data.x->black_relief.gc;
2042 else
2043 gc = f->output_data.x->white_relief.gc;
2044 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2046 if (width > 1)
2048 /* Outermost top line. */
2049 if (top_p)
2050 XDrawLine (dpy, window, gc,
2051 left_x + (left_p ? 1 : 0), top_y,
2052 right_x + (right_p ? 0 : 1), top_y);
2054 /* Outermost left line. */
2055 if (left_p)
2056 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2059 /* Bottom. */
2060 if (bot_p)
2062 XDrawLine (dpy, window, gc,
2063 left_x + (left_p ? 1 : 0), bottom_y,
2064 right_x + (right_p ? 0 : 1), bottom_y);
2065 for (i = 1; i < width; ++i)
2066 XDrawLine (dpy, window, gc,
2067 left_x + i * left_p, bottom_y - i,
2068 right_x + 1 - i * right_p, bottom_y - i);
2071 /* Right. */
2072 if (right_p)
2074 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2075 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2076 for (i = 0; i < width; ++i)
2077 XDrawLine (dpy, window, gc,
2078 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2081 XSetClipMask (dpy, gc, None);
2085 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2086 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2087 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2088 left side of the rectangle. RIGHT_P non-zero means draw a line
2089 on the right side of the rectangle. CLIP_RECT is the clipping
2090 rectangle to use when drawing. */
2092 static void
2093 x_draw_box_rect (struct glyph_string *s,
2094 int left_x, int top_y, int right_x, int bottom_y, int width,
2095 int left_p, int right_p, XRectangle *clip_rect)
2097 XGCValues xgcv;
2099 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2100 XSetForeground (s->display, s->gc, s->face->box_color);
2101 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2103 /* Top. */
2104 XFillRectangle (s->display, s->window, s->gc,
2105 left_x, top_y, right_x - left_x + 1, width);
2107 /* Left. */
2108 if (left_p)
2109 XFillRectangle (s->display, s->window, s->gc,
2110 left_x, top_y, width, bottom_y - top_y + 1);
2112 /* Bottom. */
2113 XFillRectangle (s->display, s->window, s->gc,
2114 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2116 /* Right. */
2117 if (right_p)
2118 XFillRectangle (s->display, s->window, s->gc,
2119 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2121 XSetForeground (s->display, s->gc, xgcv.foreground);
2122 XSetClipMask (s->display, s->gc, None);
2126 /* Draw a box around glyph string S. */
2128 static void
2129 x_draw_glyph_string_box (struct glyph_string *s)
2131 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2132 int left_p, right_p;
2133 struct glyph *last_glyph;
2134 XRectangle clip_rect;
2136 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2137 ? WINDOW_RIGHT_EDGE_X (s->w)
2138 : window_box_right (s->w, s->area));
2140 /* The glyph that may have a right box line. */
2141 last_glyph = (s->cmp || s->img
2142 ? s->first_glyph
2143 : s->first_glyph + s->nchars - 1);
2145 width = eabs (s->face->box_line_width);
2146 raised_p = s->face->box == FACE_RAISED_BOX;
2147 left_x = s->x;
2148 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2149 ? last_x - 1
2150 : min (last_x, s->x + s->background_width) - 1);
2151 top_y = s->y;
2152 bottom_y = top_y + s->height - 1;
2154 left_p = (s->first_glyph->left_box_line_p
2155 || (s->hl == DRAW_MOUSE_FACE
2156 && (s->prev == NULL
2157 || s->prev->hl != s->hl)));
2158 right_p = (last_glyph->right_box_line_p
2159 || (s->hl == DRAW_MOUSE_FACE
2160 && (s->next == NULL
2161 || s->next->hl != s->hl)));
2163 get_glyph_string_clip_rect (s, &clip_rect);
2165 if (s->face->box == FACE_SIMPLE_BOX)
2166 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2167 left_p, right_p, &clip_rect);
2168 else
2170 x_setup_relief_colors (s);
2171 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2172 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2177 /* Draw foreground of image glyph string S. */
2179 static void
2180 x_draw_image_foreground (struct glyph_string *s)
2182 int x = s->x;
2183 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2185 /* If first glyph of S has a left box line, start drawing it to the
2186 right of that line. */
2187 if (s->face->box != FACE_NO_BOX
2188 && s->first_glyph->left_box_line_p
2189 && s->slice.x == 0)
2190 x += eabs (s->face->box_line_width);
2192 /* If there is a margin around the image, adjust x- and y-position
2193 by that margin. */
2194 if (s->slice.x == 0)
2195 x += s->img->hmargin;
2196 if (s->slice.y == 0)
2197 y += s->img->vmargin;
2199 if (s->img->pixmap)
2201 if (s->img->mask)
2203 /* We can't set both a clip mask and use XSetClipRectangles
2204 because the latter also sets a clip mask. We also can't
2205 trust on the shape extension to be available
2206 (XShapeCombineRegion). So, compute the rectangle to draw
2207 manually. */
2208 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2209 | GCFunction);
2210 XGCValues xgcv;
2211 XRectangle clip_rect, image_rect, r;
2213 xgcv.clip_mask = s->img->mask;
2214 xgcv.clip_x_origin = x;
2215 xgcv.clip_y_origin = y;
2216 xgcv.function = GXcopy;
2217 XChangeGC (s->display, s->gc, mask, &xgcv);
2219 get_glyph_string_clip_rect (s, &clip_rect);
2220 image_rect.x = x;
2221 image_rect.y = y;
2222 image_rect.width = s->slice.width;
2223 image_rect.height = s->slice.height;
2224 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2225 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2226 s->slice.x + r.x - x, s->slice.y + r.y - y,
2227 r.width, r.height, r.x, r.y);
2229 else
2231 XRectangle clip_rect, image_rect, r;
2233 get_glyph_string_clip_rect (s, &clip_rect);
2234 image_rect.x = x;
2235 image_rect.y = y;
2236 image_rect.width = s->slice.width;
2237 image_rect.height = s->slice.height;
2238 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2239 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2240 s->slice.x + r.x - x, s->slice.y + r.y - y,
2241 r.width, r.height, r.x, r.y);
2243 /* When the image has a mask, we can expect that at
2244 least part of a mouse highlight or a block cursor will
2245 be visible. If the image doesn't have a mask, make
2246 a block cursor visible by drawing a rectangle around
2247 the image. I believe it's looking better if we do
2248 nothing here for mouse-face. */
2249 if (s->hl == DRAW_CURSOR)
2251 int relief = s->img->relief;
2252 if (relief < 0) relief = -relief;
2253 XDrawRectangle (s->display, s->window, s->gc,
2254 x - relief, y - relief,
2255 s->slice.width + relief*2 - 1,
2256 s->slice.height + relief*2 - 1);
2260 else
2261 /* Draw a rectangle if image could not be loaded. */
2262 XDrawRectangle (s->display, s->window, s->gc, x, y,
2263 s->slice.width - 1, s->slice.height - 1);
2267 /* Draw a relief around the image glyph string S. */
2269 static void
2270 x_draw_image_relief (struct glyph_string *s)
2272 int x0, y0, x1, y1, thick, raised_p;
2273 int extra_x, extra_y;
2274 XRectangle r;
2275 int x = s->x;
2276 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2278 /* If first glyph of S has a left box line, start drawing it to the
2279 right of that line. */
2280 if (s->face->box != FACE_NO_BOX
2281 && s->first_glyph->left_box_line_p
2282 && s->slice.x == 0)
2283 x += eabs (s->face->box_line_width);
2285 /* If there is a margin around the image, adjust x- and y-position
2286 by that margin. */
2287 if (s->slice.x == 0)
2288 x += s->img->hmargin;
2289 if (s->slice.y == 0)
2290 y += s->img->vmargin;
2292 if (s->hl == DRAW_IMAGE_SUNKEN
2293 || s->hl == DRAW_IMAGE_RAISED)
2295 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2296 raised_p = s->hl == DRAW_IMAGE_RAISED;
2298 else
2300 thick = eabs (s->img->relief);
2301 raised_p = s->img->relief > 0;
2304 extra_x = extra_y = 0;
2305 if (s->face->id == TOOL_BAR_FACE_ID)
2307 if (CONSP (Vtool_bar_button_margin)
2308 && INTEGERP (XCAR (Vtool_bar_button_margin))
2309 && INTEGERP (XCDR (Vtool_bar_button_margin)))
2311 extra_x = XINT (XCAR (Vtool_bar_button_margin));
2312 extra_y = XINT (XCDR (Vtool_bar_button_margin));
2314 else if (INTEGERP (Vtool_bar_button_margin))
2315 extra_x = extra_y = XINT (Vtool_bar_button_margin);
2318 x0 = x - thick - extra_x;
2319 y0 = y - thick - extra_y;
2320 x1 = x + s->slice.width + thick - 1 + extra_x;
2321 y1 = y + s->slice.height + thick - 1 + extra_y;
2323 x_setup_relief_colors (s);
2324 get_glyph_string_clip_rect (s, &r);
2325 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2326 s->slice.y == 0,
2327 s->slice.y + s->slice.height == s->img->height,
2328 s->slice.x == 0,
2329 s->slice.x + s->slice.width == s->img->width,
2330 &r);
2334 /* Draw the foreground of image glyph string S to PIXMAP. */
2336 static void
2337 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2339 int x = 0;
2340 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2342 /* If first glyph of S has a left box line, start drawing it to the
2343 right of that line. */
2344 if (s->face->box != FACE_NO_BOX
2345 && s->first_glyph->left_box_line_p
2346 && s->slice.x == 0)
2347 x += eabs (s->face->box_line_width);
2349 /* If there is a margin around the image, adjust x- and y-position
2350 by that margin. */
2351 if (s->slice.x == 0)
2352 x += s->img->hmargin;
2353 if (s->slice.y == 0)
2354 y += s->img->vmargin;
2356 if (s->img->pixmap)
2358 if (s->img->mask)
2360 /* We can't set both a clip mask and use XSetClipRectangles
2361 because the latter also sets a clip mask. We also can't
2362 trust on the shape extension to be available
2363 (XShapeCombineRegion). So, compute the rectangle to draw
2364 manually. */
2365 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2366 | GCFunction);
2367 XGCValues xgcv;
2369 xgcv.clip_mask = s->img->mask;
2370 xgcv.clip_x_origin = x - s->slice.x;
2371 xgcv.clip_y_origin = y - s->slice.y;
2372 xgcv.function = GXcopy;
2373 XChangeGC (s->display, s->gc, mask, &xgcv);
2375 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2376 s->slice.x, s->slice.y,
2377 s->slice.width, s->slice.height, x, y);
2378 XSetClipMask (s->display, s->gc, None);
2380 else
2382 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2383 s->slice.x, s->slice.y,
2384 s->slice.width, s->slice.height, x, y);
2386 /* When the image has a mask, we can expect that at
2387 least part of a mouse highlight or a block cursor will
2388 be visible. If the image doesn't have a mask, make
2389 a block cursor visible by drawing a rectangle around
2390 the image. I believe it's looking better if we do
2391 nothing here for mouse-face. */
2392 if (s->hl == DRAW_CURSOR)
2394 int r = s->img->relief;
2395 if (r < 0) r = -r;
2396 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2397 s->slice.width + r*2 - 1,
2398 s->slice.height + r*2 - 1);
2402 else
2403 /* Draw a rectangle if image could not be loaded. */
2404 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2405 s->slice.width - 1, s->slice.height - 1);
2409 /* Draw part of the background of glyph string S. X, Y, W, and H
2410 give the rectangle to draw. */
2412 static void
2413 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2415 if (s->stippled_p)
2417 /* Fill background with a stipple pattern. */
2418 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2419 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2420 XSetFillStyle (s->display, s->gc, FillSolid);
2422 else
2423 x_clear_glyph_string_rect (s, x, y, w, h);
2427 /* Draw image glyph string S.
2429 s->y
2430 s->x +-------------------------
2431 | s->face->box
2433 | +-------------------------
2434 | | s->img->margin
2436 | | +-------------------
2437 | | | the image
2441 static void
2442 x_draw_image_glyph_string (struct glyph_string *s)
2444 int box_line_hwidth = eabs (s->face->box_line_width);
2445 int box_line_vwidth = max (s->face->box_line_width, 0);
2446 int height;
2447 Pixmap pixmap = None;
2449 height = s->height;
2450 if (s->slice.y == 0)
2451 height -= box_line_vwidth;
2452 if (s->slice.y + s->slice.height >= s->img->height)
2453 height -= box_line_vwidth;
2455 /* Fill background with face under the image. Do it only if row is
2456 taller than image or if image has a clip mask to reduce
2457 flickering. */
2458 s->stippled_p = s->face->stipple != 0;
2459 if (height > s->slice.height
2460 || s->img->hmargin
2461 || s->img->vmargin
2462 || s->img->mask
2463 || s->img->pixmap == 0
2464 || s->width != s->background_width)
2466 if (s->img->mask)
2468 /* Create a pixmap as large as the glyph string. Fill it
2469 with the background color. Copy the image to it, using
2470 its mask. Copy the temporary pixmap to the display. */
2471 Screen *screen = FRAME_X_SCREEN (s->f);
2472 int depth = DefaultDepthOfScreen (screen);
2474 /* Create a pixmap as large as the glyph string. */
2475 pixmap = XCreatePixmap (s->display, s->window,
2476 s->background_width,
2477 s->height, depth);
2479 /* Don't clip in the following because we're working on the
2480 pixmap. */
2481 XSetClipMask (s->display, s->gc, None);
2483 /* Fill the pixmap with the background color/stipple. */
2484 if (s->stippled_p)
2486 /* Fill background with a stipple pattern. */
2487 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2488 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2489 XFillRectangle (s->display, pixmap, s->gc,
2490 0, 0, s->background_width, s->height);
2491 XSetFillStyle (s->display, s->gc, FillSolid);
2492 XSetTSOrigin (s->display, s->gc, 0, 0);
2494 else
2496 XGCValues xgcv;
2497 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2498 &xgcv);
2499 XSetForeground (s->display, s->gc, xgcv.background);
2500 XFillRectangle (s->display, pixmap, s->gc,
2501 0, 0, s->background_width, s->height);
2502 XSetForeground (s->display, s->gc, xgcv.foreground);
2505 else
2507 int x = s->x;
2508 int y = s->y;
2510 if (s->first_glyph->left_box_line_p
2511 && s->slice.x == 0)
2512 x += box_line_hwidth;
2514 if (s->slice.y == 0)
2515 y += box_line_vwidth;
2517 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2520 s->background_filled_p = 1;
2523 /* Draw the foreground. */
2524 if (pixmap != None)
2526 x_draw_image_foreground_1 (s, pixmap);
2527 x_set_glyph_string_clipping (s);
2528 XCopyArea (s->display, pixmap, s->window, s->gc,
2529 0, 0, s->background_width, s->height, s->x, s->y);
2530 XFreePixmap (s->display, pixmap);
2532 else
2533 x_draw_image_foreground (s);
2535 /* If we must draw a relief around the image, do it. */
2536 if (s->img->relief
2537 || s->hl == DRAW_IMAGE_RAISED
2538 || s->hl == DRAW_IMAGE_SUNKEN)
2539 x_draw_image_relief (s);
2543 /* Draw stretch glyph string S. */
2545 static void
2546 x_draw_stretch_glyph_string (struct glyph_string *s)
2548 eassert (s->first_glyph->type == STRETCH_GLYPH);
2550 if (s->hl == DRAW_CURSOR
2551 && !x_stretch_cursor_p)
2553 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2554 wide as the stretch glyph. */
2555 int width, background_width = s->background_width;
2556 int x = s->x;
2558 if (!s->row->reversed_p)
2560 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2562 if (x < left_x)
2564 background_width -= left_x - x;
2565 x = left_x;
2568 else
2570 /* In R2L rows, draw the cursor on the right edge of the
2571 stretch glyph. */
2572 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2574 if (x + background_width > right_x)
2575 background_width -= x - right_x;
2576 x += background_width;
2578 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2579 if (s->row->reversed_p)
2580 x -= width;
2582 /* Draw cursor. */
2583 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2585 /* Clear rest using the GC of the original non-cursor face. */
2586 if (width < background_width)
2588 int y = s->y;
2589 int w = background_width - width, h = s->height;
2590 XRectangle r;
2591 GC gc;
2593 if (!s->row->reversed_p)
2594 x += width;
2595 else
2596 x = s->x;
2597 if (s->row->mouse_face_p
2598 && cursor_in_mouse_face_p (s->w))
2600 x_set_mouse_face_gc (s);
2601 gc = s->gc;
2603 else
2604 gc = s->face->gc;
2606 get_glyph_string_clip_rect (s, &r);
2607 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2609 if (s->face->stipple)
2611 /* Fill background with a stipple pattern. */
2612 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2613 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2614 XSetFillStyle (s->display, gc, FillSolid);
2616 else
2618 XGCValues xgcv;
2619 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2620 XSetForeground (s->display, gc, xgcv.background);
2621 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2622 XSetForeground (s->display, gc, xgcv.foreground);
2626 else if (!s->background_filled_p)
2628 int background_width = s->background_width;
2629 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2631 /* Don't draw into left margin, fringe or scrollbar area
2632 except for header line and mode line. */
2633 if (x < left_x && !s->row->mode_line_p)
2635 background_width -= left_x - x;
2636 x = left_x;
2638 if (background_width > 0)
2639 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2642 s->background_filled_p = 1;
2646 Draw a wavy line under S. The wave fills wave_height pixels from y0.
2648 x0 wave_length = 2
2650 y0 * * * * *
2651 |* * * * * * * * *
2652 wave_height = 3 | * * * *
2656 static void
2657 x_draw_underwave (struct glyph_string *s)
2659 int wave_height = 2, wave_length = 3;
2660 int dx, dy, x0, y0, width, x1, y1, x2, y2, odd, xmax;
2661 XRectangle wave_clip, string_clip, final_clip;
2663 dx = wave_length;
2664 dy = wave_height - 1;
2665 x0 = s->x;
2666 y0 = s->ybase + 1;
2667 width = s->width;
2668 xmax = x0 + width;
2670 /* Find and set clipping rectangle */
2672 wave_clip = (XRectangle){ x0, y0, width, wave_height };
2673 get_glyph_string_clip_rect (s, &string_clip);
2675 if (!x_intersect_rectangles (&wave_clip, &string_clip, &final_clip))
2676 return;
2678 XSetClipRectangles (s->display, s->gc, 0, 0, &final_clip, 1, Unsorted);
2680 /* Draw the waves */
2682 x1 = x0 - (x0 % dx);
2683 x2 = x1 + dx;
2684 odd = (x1/dx) % 2;
2685 y1 = y2 = y0;
2687 if (odd)
2688 y1 += dy;
2689 else
2690 y2 += dy;
2692 if (INT_MAX - dx < xmax)
2693 emacs_abort ();
2695 while (x1 <= xmax)
2697 XDrawLine (s->display, s->window, s->gc, x1, y1, x2, y2);
2698 x1 = x2, y1 = y2;
2699 x2 += dx, y2 = y0 + odd*dy;
2700 odd = !odd;
2703 /* Restore previous clipping rectangle(s) */
2704 XSetClipRectangles (s->display, s->gc, 0, 0, s->clip, s->num_clips, Unsorted);
2708 /* Draw glyph string S. */
2710 static void
2711 x_draw_glyph_string (struct glyph_string *s)
2713 int relief_drawn_p = 0;
2715 /* If S draws into the background of its successors, draw the
2716 background of the successors first so that S can draw into it.
2717 This makes S->next use XDrawString instead of XDrawImageString. */
2718 if (s->next && s->right_overhang && !s->for_overlaps)
2720 int width;
2721 struct glyph_string *next;
2723 for (width = 0, next = s->next;
2724 next && width < s->right_overhang;
2725 width += next->width, next = next->next)
2726 if (next->first_glyph->type != IMAGE_GLYPH)
2728 x_set_glyph_string_gc (next);
2729 x_set_glyph_string_clipping (next);
2730 if (next->first_glyph->type == STRETCH_GLYPH)
2731 x_draw_stretch_glyph_string (next);
2732 else
2733 x_draw_glyph_string_background (next, 1);
2734 next->num_clips = 0;
2738 /* Set up S->gc, set clipping and draw S. */
2739 x_set_glyph_string_gc (s);
2741 /* Draw relief (if any) in advance for char/composition so that the
2742 glyph string can be drawn over it. */
2743 if (!s->for_overlaps
2744 && s->face->box != FACE_NO_BOX
2745 && (s->first_glyph->type == CHAR_GLYPH
2746 || s->first_glyph->type == COMPOSITE_GLYPH))
2749 x_set_glyph_string_clipping (s);
2750 x_draw_glyph_string_background (s, 1);
2751 x_draw_glyph_string_box (s);
2752 x_set_glyph_string_clipping (s);
2753 relief_drawn_p = 1;
2755 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2756 && !s->clip_tail
2757 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2758 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2759 /* We must clip just this glyph. left_overhang part has already
2760 drawn when s->prev was drawn, and right_overhang part will be
2761 drawn later when s->next is drawn. */
2762 x_set_glyph_string_clipping_exactly (s, s);
2763 else
2764 x_set_glyph_string_clipping (s);
2766 switch (s->first_glyph->type)
2768 case IMAGE_GLYPH:
2769 x_draw_image_glyph_string (s);
2770 break;
2772 case STRETCH_GLYPH:
2773 x_draw_stretch_glyph_string (s);
2774 break;
2776 case CHAR_GLYPH:
2777 if (s->for_overlaps)
2778 s->background_filled_p = 1;
2779 else
2780 x_draw_glyph_string_background (s, 0);
2781 x_draw_glyph_string_foreground (s);
2782 break;
2784 case COMPOSITE_GLYPH:
2785 if (s->for_overlaps || (s->cmp_from > 0
2786 && ! s->first_glyph->u.cmp.automatic))
2787 s->background_filled_p = 1;
2788 else
2789 x_draw_glyph_string_background (s, 1);
2790 x_draw_composite_glyph_string_foreground (s);
2791 break;
2793 case GLYPHLESS_GLYPH:
2794 if (s->for_overlaps)
2795 s->background_filled_p = 1;
2796 else
2797 x_draw_glyph_string_background (s, 1);
2798 x_draw_glyphless_glyph_string_foreground (s);
2799 break;
2801 default:
2802 emacs_abort ();
2805 if (!s->for_overlaps)
2807 /* Draw underline. */
2808 if (s->face->underline_p)
2810 if (s->face->underline_type == FACE_UNDER_WAVE)
2812 if (s->face->underline_defaulted_p)
2813 x_draw_underwave (s);
2814 else
2816 XGCValues xgcv;
2817 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2818 XSetForeground (s->display, s->gc, s->face->underline_color);
2819 x_draw_underwave (s);
2820 XSetForeground (s->display, s->gc, xgcv.foreground);
2823 else if (s->face->underline_type == FACE_UNDER_LINE)
2825 unsigned long thickness, position;
2826 int y;
2828 if (s->prev && s->prev->face->underline_p)
2830 /* We use the same underline style as the previous one. */
2831 thickness = s->prev->underline_thickness;
2832 position = s->prev->underline_position;
2834 else
2836 /* Get the underline thickness. Default is 1 pixel. */
2837 if (s->font && s->font->underline_thickness > 0)
2838 thickness = s->font->underline_thickness;
2839 else
2840 thickness = 1;
2841 if (x_underline_at_descent_line)
2842 position = (s->height - thickness) - (s->ybase - s->y);
2843 else
2845 /* Get the underline position. This is the recommended
2846 vertical offset in pixels from the baseline to the top of
2847 the underline. This is a signed value according to the
2848 specs, and its default is
2850 ROUND ((maximum descent) / 2), with
2851 ROUND(x) = floor (x + 0.5) */
2853 if (x_use_underline_position_properties
2854 && s->font && s->font->underline_position >= 0)
2855 position = s->font->underline_position;
2856 else if (s->font)
2857 position = (s->font->descent + 1) / 2;
2858 else
2859 position = underline_minimum_offset;
2861 position = max (position, underline_minimum_offset);
2863 /* Check the sanity of thickness and position. We should
2864 avoid drawing underline out of the current line area. */
2865 if (s->y + s->height <= s->ybase + position)
2866 position = (s->height - 1) - (s->ybase - s->y);
2867 if (s->y + s->height < s->ybase + position + thickness)
2868 thickness = (s->y + s->height) - (s->ybase + position);
2869 s->underline_thickness = thickness;
2870 s->underline_position = position;
2871 y = s->ybase + position;
2872 if (s->face->underline_defaulted_p)
2873 XFillRectangle (s->display, s->window, s->gc,
2874 s->x, y, s->width, thickness);
2875 else
2877 XGCValues xgcv;
2878 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2879 XSetForeground (s->display, s->gc, s->face->underline_color);
2880 XFillRectangle (s->display, s->window, s->gc,
2881 s->x, y, s->width, thickness);
2882 XSetForeground (s->display, s->gc, xgcv.foreground);
2886 /* Draw overline. */
2887 if (s->face->overline_p)
2889 unsigned long dy = 0, h = 1;
2891 if (s->face->overline_color_defaulted_p)
2892 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2893 s->width, h);
2894 else
2896 XGCValues xgcv;
2897 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2898 XSetForeground (s->display, s->gc, s->face->overline_color);
2899 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2900 s->width, h);
2901 XSetForeground (s->display, s->gc, xgcv.foreground);
2905 /* Draw strike-through. */
2906 if (s->face->strike_through_p)
2908 unsigned long h = 1;
2909 unsigned long dy = (s->height - h) / 2;
2911 if (s->face->strike_through_color_defaulted_p)
2912 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2913 s->width, h);
2914 else
2916 XGCValues xgcv;
2917 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2918 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2919 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2920 s->width, h);
2921 XSetForeground (s->display, s->gc, xgcv.foreground);
2925 /* Draw relief if not yet drawn. */
2926 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2927 x_draw_glyph_string_box (s);
2929 if (s->prev)
2931 struct glyph_string *prev;
2933 for (prev = s->prev; prev; prev = prev->prev)
2934 if (prev->hl != s->hl
2935 && prev->x + prev->width + prev->right_overhang > s->x)
2937 /* As prev was drawn while clipped to its own area, we
2938 must draw the right_overhang part using s->hl now. */
2939 enum draw_glyphs_face save = prev->hl;
2941 prev->hl = s->hl;
2942 x_set_glyph_string_gc (prev);
2943 x_set_glyph_string_clipping_exactly (s, prev);
2944 if (prev->first_glyph->type == CHAR_GLYPH)
2945 x_draw_glyph_string_foreground (prev);
2946 else
2947 x_draw_composite_glyph_string_foreground (prev);
2948 XSetClipMask (prev->display, prev->gc, None);
2949 prev->hl = save;
2950 prev->num_clips = 0;
2954 if (s->next)
2956 struct glyph_string *next;
2958 for (next = s->next; next; next = next->next)
2959 if (next->hl != s->hl
2960 && next->x - next->left_overhang < s->x + s->width)
2962 /* As next will be drawn while clipped to its own area,
2963 we must draw the left_overhang part using s->hl now. */
2964 enum draw_glyphs_face save = next->hl;
2966 next->hl = s->hl;
2967 x_set_glyph_string_gc (next);
2968 x_set_glyph_string_clipping_exactly (s, next);
2969 if (next->first_glyph->type == CHAR_GLYPH)
2970 x_draw_glyph_string_foreground (next);
2971 else
2972 x_draw_composite_glyph_string_foreground (next);
2973 XSetClipMask (next->display, next->gc, None);
2974 next->hl = save;
2975 next->num_clips = 0;
2976 next->clip_head = s->next;
2981 /* Reset clipping. */
2982 XSetClipMask (s->display, s->gc, None);
2983 s->num_clips = 0;
2986 /* Shift display to make room for inserted glyphs. */
2988 static void
2989 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2991 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2992 f->output_data.x->normal_gc,
2993 x, y, width, height,
2994 x + shift_by, y);
2997 /* Delete N glyphs at the nominal cursor position. Not implemented
2998 for X frames. */
3000 static void
3001 x_delete_glyphs (struct frame *f, register int n)
3003 emacs_abort ();
3007 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
3008 If they are <= 0, this is probably an error. */
3010 void
3011 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
3013 eassert (width > 0 && height > 0);
3014 XClearArea (dpy, window, x, y, width, height, exposures);
3018 /* Clear an entire frame. */
3020 static void
3021 x_clear_frame (struct frame *f)
3023 /* Clearing the frame will erase any cursor, so mark them all as no
3024 longer visible. */
3025 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
3026 output_cursor.hpos = output_cursor.vpos = 0;
3027 output_cursor.x = -1;
3029 /* We don't set the output cursor here because there will always
3030 follow an explicit cursor_to. */
3031 block_input ();
3033 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
3035 /* We have to clear the scroll bars. If we have changed colors or
3036 something like that, then they should be notified. */
3037 x_scroll_bar_clear (f);
3039 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3040 /* Make sure scroll bars are redrawn. As they aren't redrawn by
3041 redisplay, do it here. */
3042 if (FRAME_GTK_WIDGET (f))
3043 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
3044 #endif
3046 XFlush (FRAME_X_DISPLAY (f));
3048 unblock_input ();
3053 /* Invert the middle quarter of the frame for .15 sec. */
3055 static void
3056 XTflash (struct frame *f)
3058 block_input ();
3061 #ifdef USE_GTK
3062 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3063 when the scroll bars and the edit widget share the same X window. */
3064 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3065 #ifdef HAVE_GTK3
3066 cairo_t *cr = gdk_cairo_create (window);
3067 cairo_set_source_rgb (cr, 1, 1, 1);
3068 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
3069 #define XFillRectangle(d, win, gc, x, y, w, h) \
3070 do { \
3071 cairo_rectangle (cr, x, y, w, h); \
3072 cairo_fill (cr); \
3074 while (0)
3075 #else /* ! HAVE_GTK3 */
3076 GdkGCValues vals;
3077 GdkGC *gc;
3078 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3079 ^ FRAME_BACKGROUND_PIXEL (f));
3080 vals.function = GDK_XOR;
3081 gc = gdk_gc_new_with_values (window,
3082 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3083 #define XFillRectangle(d, win, gc, x, y, w, h) \
3084 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
3085 #endif /* ! HAVE_GTK3 */
3086 #else /* ! USE_GTK */
3087 GC gc;
3089 /* Create a GC that will use the GXxor function to flip foreground
3090 pixels into background pixels. */
3092 XGCValues values;
3094 values.function = GXxor;
3095 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3096 ^ FRAME_BACKGROUND_PIXEL (f));
3098 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3099 GCFunction | GCForeground, &values);
3101 #endif
3103 /* Get the height not including a menu bar widget. */
3104 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3105 /* Height of each line to flash. */
3106 int flash_height = FRAME_LINE_HEIGHT (f);
3107 /* These will be the left and right margins of the rectangles. */
3108 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3109 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3111 int width;
3113 /* Don't flash the area between a scroll bar and the frame
3114 edge it is next to. */
3115 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3117 case vertical_scroll_bar_left:
3118 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3119 break;
3121 case vertical_scroll_bar_right:
3122 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3123 break;
3125 default:
3126 break;
3129 width = flash_right - flash_left;
3131 /* If window is tall, flash top and bottom line. */
3132 if (height > 3 * FRAME_LINE_HEIGHT (f))
3134 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3135 flash_left,
3136 (FRAME_INTERNAL_BORDER_WIDTH (f)
3137 + FRAME_TOP_MARGIN_HEIGHT (f)),
3138 width, flash_height);
3139 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3140 flash_left,
3141 (height - flash_height
3142 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3143 width, flash_height);
3146 else
3147 /* If it is short, flash it all. */
3148 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3149 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3150 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3152 x_flush (f);
3155 EMACS_TIME delay = make_emacs_time (0, 150 * 1000 * 1000);
3156 EMACS_TIME wakeup = add_emacs_time (current_emacs_time (), delay);
3158 /* Keep waiting until past the time wakeup or any input gets
3159 available. */
3160 while (! detect_input_pending ())
3162 EMACS_TIME current = current_emacs_time ();
3163 EMACS_TIME timeout;
3165 /* Break if result would not be positive. */
3166 if (EMACS_TIME_LE (wakeup, current))
3167 break;
3169 /* How long `select' should wait. */
3170 timeout = make_emacs_time (0, 10 * 1000 * 1000);
3172 /* Try to wait that long--but we might wake up sooner. */
3173 pselect (0, NULL, NULL, NULL, &timeout, NULL);
3177 /* If window is tall, flash top and bottom line. */
3178 if (height > 3 * FRAME_LINE_HEIGHT (f))
3180 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3181 flash_left,
3182 (FRAME_INTERNAL_BORDER_WIDTH (f)
3183 + FRAME_TOP_MARGIN_HEIGHT (f)),
3184 width, flash_height);
3185 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3186 flash_left,
3187 (height - flash_height
3188 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3189 width, flash_height);
3191 else
3192 /* If it is short, flash it all. */
3193 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3194 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3195 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3197 #ifdef USE_GTK
3198 #ifdef HAVE_GTK3
3199 cairo_destroy (cr);
3200 #else
3201 g_object_unref (G_OBJECT (gc));
3202 #endif
3203 #undef XFillRectangle
3204 #else
3205 XFreeGC (FRAME_X_DISPLAY (f), gc);
3206 #endif
3207 x_flush (f);
3211 unblock_input ();
3215 static void
3216 XTtoggle_invisible_pointer (FRAME_PTR f, int invisible)
3218 block_input ();
3219 if (invisible)
3221 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3222 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3223 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3225 else
3226 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3227 f->output_data.x->current_cursor);
3228 f->pointer_invisible = invisible;
3229 unblock_input ();
3233 /* Make audible bell. */
3235 static void
3236 XTring_bell (struct frame *f)
3238 if (FRAME_X_DISPLAY (f))
3240 if (visible_bell)
3241 XTflash (f);
3242 else
3244 block_input ();
3245 XBell (FRAME_X_DISPLAY (f), 0);
3246 XFlush (FRAME_X_DISPLAY (f));
3247 unblock_input ();
3253 /* Specify how many text lines, from the top of the window,
3254 should be affected by insert-lines and delete-lines operations.
3255 This, and those operations, are used only within an update
3256 that is bounded by calls to x_update_begin and x_update_end. */
3258 static void
3259 XTset_terminal_window (struct frame *f, int n)
3261 /* This function intentionally left blank. */
3266 /***********************************************************************
3267 Line Dance
3268 ***********************************************************************/
3270 /* Perform an insert-lines or delete-lines operation, inserting N
3271 lines or deleting -N lines at vertical position VPOS. */
3273 static void
3274 x_ins_del_lines (struct frame *f, int vpos, int n)
3276 emacs_abort ();
3280 /* Scroll part of the display as described by RUN. */
3282 static void
3283 x_scroll_run (struct window *w, struct run *run)
3285 struct frame *f = XFRAME (w->frame);
3286 int x, y, width, height, from_y, to_y, bottom_y;
3288 /* Get frame-relative bounding box of the text display area of W,
3289 without mode lines. Include in this box the left and right
3290 fringe of W. */
3291 window_box (w, -1, &x, &y, &width, &height);
3293 #ifdef USE_TOOLKIT_SCROLL_BARS
3294 /* If the fringe is adjacent to the left (right) scroll bar of a
3295 leftmost (rightmost, respectively) window, then extend its
3296 background to the gap between the fringe and the bar. */
3297 if ((WINDOW_LEFTMOST_P (w)
3298 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
3299 || (WINDOW_RIGHTMOST_P (w)
3300 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
3302 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
3304 if (sb_width > 0)
3306 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
3307 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
3308 * FRAME_COLUMN_WIDTH (f));
3310 if (bar_area_x + bar_area_width == x)
3312 x = bar_area_x + sb_width;
3313 width += bar_area_width - sb_width;
3315 else if (x + width == bar_area_x)
3316 width += bar_area_width - sb_width;
3319 #endif
3321 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3322 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3323 bottom_y = y + height;
3325 if (to_y < from_y)
3327 /* Scrolling up. Make sure we don't copy part of the mode
3328 line at the bottom. */
3329 if (from_y + run->height > bottom_y)
3330 height = bottom_y - from_y;
3331 else
3332 height = run->height;
3334 else
3336 /* Scrolling down. Make sure we don't copy over the mode line.
3337 at the bottom. */
3338 if (to_y + run->height > bottom_y)
3339 height = bottom_y - to_y;
3340 else
3341 height = run->height;
3344 block_input ();
3346 /* Cursor off. Will be switched on again in x_update_window_end. */
3347 updated_window = w;
3348 x_clear_cursor (w);
3350 XCopyArea (FRAME_X_DISPLAY (f),
3351 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3352 f->output_data.x->normal_gc,
3353 x, from_y,
3354 width, height,
3355 x, to_y);
3357 unblock_input ();
3362 /***********************************************************************
3363 Exposure Events
3364 ***********************************************************************/
3367 static void
3368 frame_highlight (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 /* I recently started to get errors in this XSetWindowBorder, depending on
3376 the window-manager in use, tho something more is at play since I've been
3377 using that same window-manager binary for ever. Let's not crash just
3378 because of this (bug#9310). */
3379 x_catch_errors (FRAME_X_DISPLAY (f));
3380 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3381 f->output_data.x->border_pixel);
3382 x_uncatch_errors ();
3383 unblock_input ();
3384 x_update_cursor (f, 1);
3385 x_set_frame_alpha (f);
3388 static void
3389 frame_unhighlight (struct frame *f)
3391 /* We used to only do this if Vx_no_window_manager was non-nil, but
3392 the ICCCM (section 4.1.6) says that the window's border pixmap
3393 and border pixel are window attributes which are "private to the
3394 client", so we can always change it to whatever we want. */
3395 block_input ();
3396 /* Same as above for XSetWindowBorder (bug#9310). */
3397 x_catch_errors (FRAME_X_DISPLAY (f));
3398 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3399 f->output_data.x->border_tile);
3400 x_uncatch_errors ();
3401 unblock_input ();
3402 x_update_cursor (f, 1);
3403 x_set_frame_alpha (f);
3406 /* The focus has changed. Update the frames as necessary to reflect
3407 the new situation. Note that we can't change the selected frame
3408 here, because the Lisp code we are interrupting might become confused.
3409 Each event gets marked with the frame in which it occurred, so the
3410 Lisp code can tell when the switch took place by examining the events. */
3412 static void
3413 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3415 struct frame *old_focus = dpyinfo->x_focus_frame;
3417 if (frame != dpyinfo->x_focus_frame)
3419 /* Set this before calling other routines, so that they see
3420 the correct value of x_focus_frame. */
3421 dpyinfo->x_focus_frame = frame;
3423 if (old_focus && old_focus->auto_lower)
3424 x_lower_frame (old_focus);
3426 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3427 pending_autoraise_frame = dpyinfo->x_focus_frame;
3428 else
3429 pending_autoraise_frame = 0;
3432 x_frame_rehighlight (dpyinfo);
3435 /* Handle FocusIn and FocusOut state changes for FRAME.
3436 If FRAME has focus and there exists more than one frame, puts
3437 a FOCUS_IN_EVENT into *BUFP. */
3439 static void
3440 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3442 if (type == FocusIn)
3444 if (dpyinfo->x_focus_event_frame != frame)
3446 x_new_focus_frame (dpyinfo, frame);
3447 dpyinfo->x_focus_event_frame = frame;
3449 /* Don't stop displaying the initial startup message
3450 for a switch-frame event we don't need. */
3451 /* When run as a daemon, Vterminal_frame is always NIL. */
3452 if ((NILP (Vterminal_frame) || EQ (Fdaemonp(), Qt))
3453 && CONSP (Vframe_list)
3454 && !NILP (XCDR (Vframe_list)))
3456 bufp->kind = FOCUS_IN_EVENT;
3457 XSETFRAME (bufp->frame_or_window, frame);
3461 frame->output_data.x->focus_state |= state;
3463 #ifdef HAVE_X_I18N
3464 if (FRAME_XIC (frame))
3465 XSetICFocus (FRAME_XIC (frame));
3466 #endif
3468 else if (type == FocusOut)
3470 frame->output_data.x->focus_state &= ~state;
3472 if (dpyinfo->x_focus_event_frame == frame)
3474 dpyinfo->x_focus_event_frame = 0;
3475 x_new_focus_frame (dpyinfo, 0);
3478 #ifdef HAVE_X_I18N
3479 if (FRAME_XIC (frame))
3480 XUnsetICFocus (FRAME_XIC (frame));
3481 #endif
3482 if (frame->pointer_invisible)
3483 XTtoggle_invisible_pointer (frame, 0);
3487 /* The focus may have changed. Figure out if it is a real focus change,
3488 by checking both FocusIn/Out and Enter/LeaveNotify events.
3490 Returns FOCUS_IN_EVENT event in *BUFP. */
3492 static void
3493 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3495 struct frame *frame;
3497 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3498 if (! frame)
3499 return;
3501 switch (event->type)
3503 case EnterNotify:
3504 case LeaveNotify:
3506 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3507 int focus_state
3508 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3510 if (event->xcrossing.detail != NotifyInferior
3511 && event->xcrossing.focus
3512 && ! (focus_state & FOCUS_EXPLICIT))
3513 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3514 FOCUS_IMPLICIT,
3515 dpyinfo, frame, bufp);
3517 break;
3519 case FocusIn:
3520 case FocusOut:
3521 x_focus_changed (event->type,
3522 (event->xfocus.detail == NotifyPointer ?
3523 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3524 dpyinfo, frame, bufp);
3525 break;
3527 case ClientMessage:
3528 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3530 enum xembed_message msg = event->xclient.data.l[1];
3531 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3532 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3534 break;
3539 #if defined HAVE_MENUS && !defined USE_X_TOOLKIT && !defined USE_GTK
3540 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3542 void
3543 x_mouse_leave (struct x_display_info *dpyinfo)
3545 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3547 #endif
3549 /* The focus has changed, or we have redirected a frame's focus to
3550 another frame (this happens when a frame uses a surrogate
3551 mini-buffer frame). Shift the highlight as appropriate.
3553 The FRAME argument doesn't necessarily have anything to do with which
3554 frame is being highlighted or un-highlighted; we only use it to find
3555 the appropriate X display info. */
3557 static void
3558 XTframe_rehighlight (struct frame *frame)
3560 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3563 static void
3564 x_frame_rehighlight (struct x_display_info *dpyinfo)
3566 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3568 if (dpyinfo->x_focus_frame)
3570 dpyinfo->x_highlight_frame
3571 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3572 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3573 : dpyinfo->x_focus_frame);
3574 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3576 fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
3577 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3580 else
3581 dpyinfo->x_highlight_frame = 0;
3583 if (dpyinfo->x_highlight_frame != old_highlight)
3585 if (old_highlight)
3586 frame_unhighlight (old_highlight);
3587 if (dpyinfo->x_highlight_frame)
3588 frame_highlight (dpyinfo->x_highlight_frame);
3594 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3596 /* Initialize mode_switch_bit and modifier_meaning. */
3597 static void
3598 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3600 int min_code, max_code;
3601 KeySym *syms;
3602 int syms_per_code;
3603 XModifierKeymap *mods;
3605 dpyinfo->meta_mod_mask = 0;
3606 dpyinfo->shift_lock_mask = 0;
3607 dpyinfo->alt_mod_mask = 0;
3608 dpyinfo->super_mod_mask = 0;
3609 dpyinfo->hyper_mod_mask = 0;
3611 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3613 syms = XGetKeyboardMapping (dpyinfo->display,
3614 min_code, max_code - min_code + 1,
3615 &syms_per_code);
3616 mods = XGetModifierMapping (dpyinfo->display);
3618 /* Scan the modifier table to see which modifier bits the Meta and
3619 Alt keysyms are on. */
3621 int row, col; /* The row and column in the modifier table. */
3622 int found_alt_or_meta;
3624 for (row = 3; row < 8; row++)
3626 found_alt_or_meta = 0;
3627 for (col = 0; col < mods->max_keypermod; col++)
3629 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3631 /* Zeroes are used for filler. Skip them. */
3632 if (code == 0)
3633 continue;
3635 /* Are any of this keycode's keysyms a meta key? */
3637 int code_col;
3639 for (code_col = 0; code_col < syms_per_code; code_col++)
3641 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3643 switch (sym)
3645 case XK_Meta_L:
3646 case XK_Meta_R:
3647 found_alt_or_meta = 1;
3648 dpyinfo->meta_mod_mask |= (1 << row);
3649 break;
3651 case XK_Alt_L:
3652 case XK_Alt_R:
3653 found_alt_or_meta = 1;
3654 dpyinfo->alt_mod_mask |= (1 << row);
3655 break;
3657 case XK_Hyper_L:
3658 case XK_Hyper_R:
3659 if (!found_alt_or_meta)
3660 dpyinfo->hyper_mod_mask |= (1 << row);
3661 code_col = syms_per_code;
3662 col = mods->max_keypermod;
3663 break;
3665 case XK_Super_L:
3666 case XK_Super_R:
3667 if (!found_alt_or_meta)
3668 dpyinfo->super_mod_mask |= (1 << row);
3669 code_col = syms_per_code;
3670 col = mods->max_keypermod;
3671 break;
3673 case XK_Shift_Lock:
3674 /* Ignore this if it's not on the lock modifier. */
3675 if (!found_alt_or_meta && ((1 << row) == LockMask))
3676 dpyinfo->shift_lock_mask = LockMask;
3677 code_col = syms_per_code;
3678 col = mods->max_keypermod;
3679 break;
3687 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3688 if (! dpyinfo->meta_mod_mask)
3690 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3691 dpyinfo->alt_mod_mask = 0;
3694 /* If some keys are both alt and meta,
3695 make them just meta, not alt. */
3696 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3698 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3701 XFree (syms);
3702 XFreeModifiermap (mods);
3705 /* Convert between the modifier bits X uses and the modifier bits
3706 Emacs uses. */
3709 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
3711 int mod_meta = meta_modifier;
3712 int mod_alt = alt_modifier;
3713 int mod_hyper = hyper_modifier;
3714 int mod_super = super_modifier;
3715 Lisp_Object tem;
3717 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3718 if (INTEGERP (tem)) mod_alt = XINT (tem) & INT_MAX;
3719 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3720 if (INTEGERP (tem)) mod_meta = XINT (tem) & INT_MAX;
3721 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3722 if (INTEGERP (tem)) mod_hyper = XINT (tem) & INT_MAX;
3723 tem = Fget (Vx_super_keysym, Qmodifier_value);
3724 if (INTEGERP (tem)) mod_super = XINT (tem) & INT_MAX;
3726 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3727 | ((state & ControlMask) ? ctrl_modifier : 0)
3728 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3729 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3730 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3731 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3734 static int
3735 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
3737 EMACS_INT mod_meta = meta_modifier;
3738 EMACS_INT mod_alt = alt_modifier;
3739 EMACS_INT mod_hyper = hyper_modifier;
3740 EMACS_INT mod_super = super_modifier;
3742 Lisp_Object tem;
3744 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3745 if (INTEGERP (tem)) mod_alt = XINT (tem);
3746 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3747 if (INTEGERP (tem)) mod_meta = XINT (tem);
3748 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3749 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3750 tem = Fget (Vx_super_keysym, Qmodifier_value);
3751 if (INTEGERP (tem)) mod_super = XINT (tem);
3754 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3755 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3756 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3757 | ((state & shift_modifier) ? ShiftMask : 0)
3758 | ((state & ctrl_modifier) ? ControlMask : 0)
3759 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3762 /* Convert a keysym to its name. */
3764 char *
3765 x_get_keysym_name (int keysym)
3767 char *value;
3769 block_input ();
3770 value = XKeysymToString (keysym);
3771 unblock_input ();
3773 return value;
3778 /* Mouse clicks and mouse movement. Rah. */
3780 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3782 If the event is a button press, then note that we have grabbed
3783 the mouse. */
3785 static Lisp_Object
3786 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3788 /* Make the event type NO_EVENT; we'll change that when we decide
3789 otherwise. */
3790 result->kind = MOUSE_CLICK_EVENT;
3791 result->code = event->button - Button1;
3792 result->timestamp = event->time;
3793 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3794 event->state)
3795 | (event->type == ButtonRelease
3796 ? up_modifier
3797 : down_modifier));
3799 XSETINT (result->x, event->x);
3800 XSETINT (result->y, event->y);
3801 XSETFRAME (result->frame_or_window, f);
3802 result->arg = Qnil;
3803 return Qnil;
3807 /* Function to report a mouse movement to the mainstream Emacs code.
3808 The input handler calls this.
3810 We have received a mouse movement event, which is given in *event.
3811 If the mouse is over a different glyph than it was last time, tell
3812 the mainstream emacs code by setting mouse_moved. If not, ask for
3813 another motion event, so we can check again the next time it moves. */
3815 static XMotionEvent last_mouse_motion_event;
3816 static Lisp_Object last_mouse_motion_frame;
3818 static int
3819 note_mouse_movement (FRAME_PTR frame, XMotionEvent *event)
3821 last_mouse_movement_time = event->time;
3822 last_mouse_motion_event = *event;
3823 XSETFRAME (last_mouse_motion_frame, frame);
3825 if (!FRAME_X_OUTPUT (frame))
3826 return 0;
3828 if (event->window != FRAME_X_WINDOW (frame))
3830 frame->mouse_moved = 1;
3831 last_mouse_scroll_bar = Qnil;
3832 note_mouse_highlight (frame, -1, -1);
3833 last_mouse_glyph_frame = 0;
3834 return 1;
3838 /* Has the mouse moved off the glyph it was on at the last sighting? */
3839 if (frame != last_mouse_glyph_frame
3840 || event->x < last_mouse_glyph.x
3841 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3842 || event->y < last_mouse_glyph.y
3843 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3845 frame->mouse_moved = 1;
3846 last_mouse_scroll_bar = Qnil;
3847 note_mouse_highlight (frame, event->x, event->y);
3848 /* Remember which glyph we're now on. */
3849 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3850 last_mouse_glyph_frame = frame;
3851 return 1;
3854 return 0;
3858 /************************************************************************
3859 Mouse Face
3860 ************************************************************************/
3862 static void
3863 redo_mouse_highlight (void)
3865 if (!NILP (last_mouse_motion_frame)
3866 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3867 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3868 last_mouse_motion_event.x,
3869 last_mouse_motion_event.y);
3874 /* Return the current position of the mouse.
3875 *FP should be a frame which indicates which display to ask about.
3877 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3878 and *PART to the frame, window, and scroll bar part that the mouse
3879 is over. Set *X and *Y to the portion and whole of the mouse's
3880 position on the scroll bar.
3882 If the mouse movement started elsewhere, set *FP to the frame the
3883 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3884 the mouse is over.
3886 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
3887 was at this position.
3889 Don't store anything if we don't have a valid set of values to report.
3891 This clears the mouse_moved flag, so we can wait for the next mouse
3892 movement. */
3894 static void
3895 XTmouse_position (FRAME_PTR *fp, int insist, Lisp_Object *bar_window,
3896 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
3897 Time *timestamp)
3899 FRAME_PTR f1;
3901 block_input ();
3903 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3904 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
3905 else
3907 Window root;
3908 int root_x, root_y;
3910 Window dummy_window;
3911 int dummy;
3913 Lisp_Object frame, tail;
3915 /* Clear the mouse-moved flag for every frame on this display. */
3916 FOR_EACH_FRAME (tail, frame)
3917 if (FRAME_X_P (XFRAME (frame))
3918 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3919 XFRAME (frame)->mouse_moved = 0;
3921 last_mouse_scroll_bar = Qnil;
3923 /* Figure out which root window we're on. */
3924 XQueryPointer (FRAME_X_DISPLAY (*fp),
3925 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3927 /* The root window which contains the pointer. */
3928 &root,
3930 /* Trash which we can't trust if the pointer is on
3931 a different screen. */
3932 &dummy_window,
3934 /* The position on that root window. */
3935 &root_x, &root_y,
3937 /* More trash we can't trust. */
3938 &dummy, &dummy,
3940 /* Modifier keys and pointer buttons, about which
3941 we don't care. */
3942 (unsigned int *) &dummy);
3944 /* Now we have a position on the root; find the innermost window
3945 containing the pointer. */
3947 Window win, child;
3948 int win_x, win_y;
3949 int parent_x = 0, parent_y = 0;
3951 win = root;
3953 /* XTranslateCoordinates can get errors if the window
3954 structure is changing at the same time this function
3955 is running. So at least we must not crash from them. */
3957 x_catch_errors (FRAME_X_DISPLAY (*fp));
3959 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3960 && FRAME_LIVE_P (last_mouse_frame))
3962 /* If mouse was grabbed on a frame, give coords for that frame
3963 even if the mouse is now outside it. */
3964 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3966 /* From-window, to-window. */
3967 root, FRAME_X_WINDOW (last_mouse_frame),
3969 /* From-position, to-position. */
3970 root_x, root_y, &win_x, &win_y,
3972 /* Child of win. */
3973 &child);
3974 f1 = last_mouse_frame;
3976 else
3978 while (1)
3980 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3982 /* From-window, to-window. */
3983 root, win,
3985 /* From-position, to-position. */
3986 root_x, root_y, &win_x, &win_y,
3988 /* Child of win. */
3989 &child);
3991 if (child == None || child == win)
3992 break;
3993 #ifdef USE_GTK
3994 /* We don't wan't to know the innermost window. We
3995 want the edit window. For non-Gtk+ the innermost
3996 window is the edit window. For Gtk+ it might not
3997 be. It might be the tool bar for example. */
3998 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3999 break;
4000 #endif
4001 win = child;
4002 parent_x = win_x;
4003 parent_y = win_y;
4006 /* Now we know that:
4007 win is the innermost window containing the pointer
4008 (XTC says it has no child containing the pointer),
4009 win_x and win_y are the pointer's position in it
4010 (XTC did this the last time through), and
4011 parent_x and parent_y are the pointer's position in win's parent.
4012 (They are what win_x and win_y were when win was child.
4013 If win is the root window, it has no parent, and
4014 parent_{x,y} are invalid, but that's okay, because we'll
4015 never use them in that case.) */
4017 #ifdef USE_GTK
4018 /* We don't wan't to know the innermost window. We
4019 want the edit window. */
4020 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4021 #else
4022 /* Is win one of our frames? */
4023 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4024 #endif
4026 #ifdef USE_X_TOOLKIT
4027 /* If we end up with the menu bar window, say it's not
4028 on the frame. */
4029 if (f1 != NULL
4030 && f1->output_data.x->menubar_widget
4031 && win == XtWindow (f1->output_data.x->menubar_widget))
4032 f1 = NULL;
4033 #endif /* USE_X_TOOLKIT */
4036 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
4037 f1 = 0;
4039 x_uncatch_errors ();
4041 /* If not, is it one of our scroll bars? */
4042 if (! f1)
4044 struct scroll_bar *bar;
4046 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
4048 if (bar)
4050 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4051 win_x = parent_x;
4052 win_y = parent_y;
4056 if (f1 == 0 && insist > 0)
4057 f1 = SELECTED_FRAME ();
4059 if (f1)
4061 /* Ok, we found a frame. Store all the values.
4062 last_mouse_glyph is a rectangle used to reduce the
4063 generation of mouse events. To not miss any motion
4064 events, we must divide the frame into rectangles of the
4065 size of the smallest character that could be displayed
4066 on it, i.e. into the same rectangles that matrices on
4067 the frame are divided into. */
4069 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
4070 last_mouse_glyph_frame = f1;
4072 *bar_window = Qnil;
4073 *part = 0;
4074 *fp = f1;
4075 XSETINT (*x, win_x);
4076 XSETINT (*y, win_y);
4077 *timestamp = last_mouse_movement_time;
4082 unblock_input ();
4087 /***********************************************************************
4088 Scroll bars
4089 ***********************************************************************/
4091 /* Scroll bar support. */
4093 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4094 manages it.
4095 This can be called in GC, so we have to make sure to strip off mark
4096 bits. */
4098 static struct scroll_bar *
4099 x_window_to_scroll_bar (Display *display, Window window_id)
4101 Lisp_Object tail;
4103 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4104 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4105 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4107 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4109 Lisp_Object frame, bar, condemned;
4111 frame = XCAR (tail);
4112 /* All elements of Vframe_list should be frames. */
4113 if (! FRAMEP (frame))
4114 emacs_abort ();
4116 if (! FRAME_X_P (XFRAME (frame)))
4117 continue;
4119 /* Scan this frame's scroll bar list for a scroll bar with the
4120 right window ID. */
4121 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4122 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4123 /* This trick allows us to search both the ordinary and
4124 condemned scroll bar lists with one loop. */
4125 ! NILP (bar) || (bar = condemned,
4126 condemned = Qnil,
4127 ! NILP (bar));
4128 bar = XSCROLL_BAR (bar)->next)
4129 if (XSCROLL_BAR (bar)->x_window == window_id &&
4130 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4131 return XSCROLL_BAR (bar);
4134 return NULL;
4138 #if defined USE_LUCID
4140 /* Return the Lucid menu bar WINDOW is part of. Return null
4141 if WINDOW is not part of a menu bar. */
4143 static Widget
4144 x_window_to_menu_bar (Window window)
4146 Lisp_Object tail;
4148 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4150 if (FRAME_X_P (XFRAME (XCAR (tail))))
4152 Lisp_Object frame = XCAR (tail);
4153 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4155 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4156 return menu_bar;
4160 return NULL;
4163 #endif /* USE_LUCID */
4166 /************************************************************************
4167 Toolkit scroll bars
4168 ************************************************************************/
4170 #ifdef USE_TOOLKIT_SCROLL_BARS
4172 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4173 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4174 static void x_create_toolkit_scroll_bar (struct frame *,
4175 struct scroll_bar *);
4176 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4177 int, int, int);
4180 /* Lisp window being scrolled. Set when starting to interact with
4181 a toolkit scroll bar, reset to nil when ending the interaction. */
4183 static Lisp_Object window_being_scrolled;
4185 /* Last scroll bar part sent in xm_scroll_callback. */
4187 static int last_scroll_bar_part;
4189 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4190 that movements of 1/20 of the screen size are mapped to up/down. */
4192 #ifndef USE_GTK
4193 /* Id of action hook installed for scroll bars. */
4195 static XtActionHookId action_hook_id;
4197 static Boolean xaw3d_arrow_scroll;
4199 /* Whether the drag scrolling maintains the mouse at the top of the
4200 thumb. If not, resizing the thumb needs to be done more carefully
4201 to avoid jerkiness. */
4203 static Boolean xaw3d_pick_top;
4205 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4206 bars are used.. The hook is responsible for detecting when
4207 the user ends an interaction with the scroll bar, and generates
4208 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4210 static void
4211 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4212 XEvent *event, String *params, Cardinal *num_params)
4214 int scroll_bar_p;
4215 const char *end_action;
4217 #ifdef USE_MOTIF
4218 scroll_bar_p = XmIsScrollBar (widget);
4219 end_action = "Release";
4220 #else /* !USE_MOTIF i.e. use Xaw */
4221 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4222 end_action = "EndScroll";
4223 #endif /* USE_MOTIF */
4225 if (scroll_bar_p
4226 && strcmp (action_name, end_action) == 0
4227 && WINDOWP (window_being_scrolled))
4229 struct window *w;
4231 x_send_scroll_bar_event (window_being_scrolled,
4232 scroll_bar_end_scroll, 0, 0);
4233 w = XWINDOW (window_being_scrolled);
4235 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4237 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4238 /* The thumb size is incorrect while dragging: fix it. */
4239 set_vertical_scroll_bar (w);
4241 window_being_scrolled = Qnil;
4242 last_scroll_bar_part = -1;
4244 /* Xt timeouts no longer needed. */
4245 toolkit_scroll_bar_interaction = 0;
4248 #endif /* not USE_GTK */
4250 /* A vector of windows used for communication between
4251 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4253 static struct window **scroll_bar_windows;
4254 static ptrdiff_t scroll_bar_windows_size;
4257 /* Send a client message with message type Xatom_Scrollbar for a
4258 scroll action to the frame of WINDOW. PART is a value identifying
4259 the part of the scroll bar that was clicked on. PORTION is the
4260 amount to scroll of a whole of WHOLE. */
4262 static void
4263 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4265 XEvent event;
4266 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4267 struct window *w = XWINDOW (window);
4268 struct frame *f = XFRAME (w->frame);
4269 ptrdiff_t i;
4271 block_input ();
4273 /* Construct a ClientMessage event to send to the frame. */
4274 ev->type = ClientMessage;
4275 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4276 ev->display = FRAME_X_DISPLAY (f);
4277 ev->window = FRAME_X_WINDOW (f);
4278 ev->format = 32;
4280 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4281 not enough to store a pointer or Lisp_Object on a 64 bit system.
4282 So, store the window in scroll_bar_windows and pass the index
4283 into that array in the event. */
4284 for (i = 0; i < scroll_bar_windows_size; ++i)
4285 if (scroll_bar_windows[i] == NULL)
4286 break;
4288 if (i == scroll_bar_windows_size)
4290 ptrdiff_t old_nbytes =
4291 scroll_bar_windows_size * sizeof *scroll_bar_windows;
4292 ptrdiff_t nbytes;
4293 enum { XClientMessageEvent_MAX = 0x7fffffff };
4294 scroll_bar_windows =
4295 xpalloc (scroll_bar_windows, &scroll_bar_windows_size, 1,
4296 XClientMessageEvent_MAX, sizeof *scroll_bar_windows);
4297 nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4298 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4301 scroll_bar_windows[i] = w;
4302 ev->data.l[0] = (long) i;
4303 ev->data.l[1] = (long) part;
4304 ev->data.l[2] = (long) 0;
4305 ev->data.l[3] = (long) portion;
4306 ev->data.l[4] = (long) whole;
4308 /* Make Xt timeouts work while the scroll bar is active. */
4309 #ifdef USE_X_TOOLKIT
4310 toolkit_scroll_bar_interaction = 1;
4311 x_activate_timeout_atimer ();
4312 #endif
4314 /* Setting the event mask to zero means that the message will
4315 be sent to the client that created the window, and if that
4316 window no longer exists, no event will be sent. */
4317 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4318 unblock_input ();
4322 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4323 in *IEVENT. */
4325 static void
4326 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4328 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4329 Lisp_Object window;
4330 struct window *w;
4332 w = scroll_bar_windows[ev->data.l[0]];
4333 scroll_bar_windows[ev->data.l[0]] = NULL;
4335 XSETWINDOW (window, w);
4337 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4338 ievent->frame_or_window = window;
4339 ievent->arg = Qnil;
4340 #ifdef USE_GTK
4341 ievent->timestamp = CurrentTime;
4342 #else
4343 ievent->timestamp =
4344 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
4345 #endif
4346 ievent->part = ev->data.l[1];
4347 ievent->code = ev->data.l[2];
4348 ievent->x = make_number ((int) ev->data.l[3]);
4349 ievent->y = make_number ((int) ev->data.l[4]);
4350 ievent->modifiers = 0;
4354 #ifdef USE_MOTIF
4356 /* Minimum and maximum values used for Motif scroll bars. */
4358 #define XM_SB_MAX 10000000
4361 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4362 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4363 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4365 static void
4366 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4368 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4369 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4370 int part = -1, whole = 0, portion = 0;
4372 switch (cs->reason)
4374 case XmCR_DECREMENT:
4375 bar->dragging = Qnil;
4376 part = scroll_bar_up_arrow;
4377 break;
4379 case XmCR_INCREMENT:
4380 bar->dragging = Qnil;
4381 part = scroll_bar_down_arrow;
4382 break;
4384 case XmCR_PAGE_DECREMENT:
4385 bar->dragging = Qnil;
4386 part = scroll_bar_above_handle;
4387 break;
4389 case XmCR_PAGE_INCREMENT:
4390 bar->dragging = Qnil;
4391 part = scroll_bar_below_handle;
4392 break;
4394 case XmCR_TO_TOP:
4395 bar->dragging = Qnil;
4396 part = scroll_bar_to_top;
4397 break;
4399 case XmCR_TO_BOTTOM:
4400 bar->dragging = Qnil;
4401 part = scroll_bar_to_bottom;
4402 break;
4404 case XmCR_DRAG:
4406 int slider_size;
4408 /* Get the slider size. */
4409 block_input ();
4410 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4411 unblock_input ();
4413 whole = XM_SB_MAX - slider_size;
4414 portion = min (cs->value, whole);
4415 part = scroll_bar_handle;
4416 bar->dragging = make_number (cs->value);
4418 break;
4420 case XmCR_VALUE_CHANGED:
4421 break;
4424 if (part >= 0)
4426 window_being_scrolled = bar->window;
4427 last_scroll_bar_part = part;
4428 x_send_scroll_bar_event (bar->window, part, portion, whole);
4432 #elif defined USE_GTK
4434 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4435 bar widget. DATA is a pointer to the scroll_bar structure. */
4437 static gboolean
4438 xg_scroll_callback (GtkRange *range,
4439 GtkScrollType scroll,
4440 gdouble value,
4441 gpointer user_data)
4443 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4444 gdouble position;
4445 int part = -1, whole = 0, portion = 0;
4446 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4447 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4449 if (xg_ignore_gtk_scrollbar) return FALSE;
4450 position = gtk_adjustment_get_value (adj);
4453 switch (scroll)
4455 case GTK_SCROLL_JUMP:
4456 /* Buttons 1 2 or 3 must be grabbed. */
4457 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4458 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4460 part = scroll_bar_handle;
4461 whole = gtk_adjustment_get_upper (adj) -
4462 gtk_adjustment_get_page_size (adj);
4463 portion = min ((int)position, whole);
4464 bar->dragging = make_number ((int)portion);
4466 break;
4467 case GTK_SCROLL_STEP_BACKWARD:
4468 part = scroll_bar_up_arrow;
4469 bar->dragging = Qnil;
4470 break;
4471 case GTK_SCROLL_STEP_FORWARD:
4472 part = scroll_bar_down_arrow;
4473 bar->dragging = Qnil;
4474 break;
4475 case GTK_SCROLL_PAGE_BACKWARD:
4476 part = scroll_bar_above_handle;
4477 bar->dragging = Qnil;
4478 break;
4479 case GTK_SCROLL_PAGE_FORWARD:
4480 part = scroll_bar_below_handle;
4481 bar->dragging = Qnil;
4482 break;
4485 if (part >= 0)
4487 window_being_scrolled = bar->window;
4488 last_scroll_bar_part = part;
4489 x_send_scroll_bar_event (bar->window, part, portion, whole);
4492 return FALSE;
4495 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4497 static gboolean
4498 xg_end_scroll_callback (GtkWidget *widget,
4499 GdkEventButton *event,
4500 gpointer user_data)
4502 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4503 bar->dragging = Qnil;
4504 if (WINDOWP (window_being_scrolled))
4506 x_send_scroll_bar_event (window_being_scrolled,
4507 scroll_bar_end_scroll, 0, 0);
4508 window_being_scrolled = Qnil;
4511 return FALSE;
4515 #else /* not USE_GTK and not USE_MOTIF */
4517 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4518 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4519 scroll bar struct. CALL_DATA is a pointer to a float saying where
4520 the thumb is. */
4522 static void
4523 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4525 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4526 float top = *(float *) call_data;
4527 float shown;
4528 int whole, portion, height;
4529 int part;
4531 /* Get the size of the thumb, a value between 0 and 1. */
4532 block_input ();
4533 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4534 unblock_input ();
4536 whole = 10000000;
4537 portion = shown < 1 ? top * whole : 0;
4539 if (shown < 1 && (eabs (top + shown - 1) < 1.0f / height))
4540 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4541 the bottom, so we force the scrolling whenever we see that we're
4542 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4543 we try to ensure that we always stay two pixels away from the
4544 bottom). */
4545 part = scroll_bar_down_arrow;
4546 else
4547 part = scroll_bar_handle;
4549 window_being_scrolled = bar->window;
4550 bar->dragging = make_number (portion);
4551 last_scroll_bar_part = part;
4552 x_send_scroll_bar_event (bar->window, part, portion, whole);
4556 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4557 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4558 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4559 the scroll bar. CALL_DATA is an integer specifying the action that
4560 has taken place. Its magnitude is in the range 0..height of the
4561 scroll bar. Negative values mean scroll towards buffer start.
4562 Values < height of scroll bar mean line-wise movement. */
4564 static void
4565 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4567 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4568 /* The position really is stored cast to a pointer. */
4569 int position = (long) call_data;
4570 Dimension height;
4571 int part;
4573 /* Get the height of the scroll bar. */
4574 block_input ();
4575 XtVaGetValues (widget, XtNheight, &height, NULL);
4576 unblock_input ();
4578 if (eabs (position) >= height)
4579 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4581 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4582 it maps line-movement to call_data = max(5, height/20). */
4583 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4584 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4585 else
4586 part = scroll_bar_move_ratio;
4588 window_being_scrolled = bar->window;
4589 bar->dragging = Qnil;
4590 last_scroll_bar_part = part;
4591 x_send_scroll_bar_event (bar->window, part, position, height);
4594 #endif /* not USE_GTK and not USE_MOTIF */
4596 #define SCROLL_BAR_NAME "verticalScrollBar"
4598 /* Create the widget for scroll bar BAR on frame F. Record the widget
4599 and X window of the scroll bar in BAR. */
4601 #ifdef USE_GTK
4602 static void
4603 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4605 const char *scroll_bar_name = SCROLL_BAR_NAME;
4607 block_input ();
4608 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4609 G_CALLBACK (xg_end_scroll_callback),
4610 scroll_bar_name);
4611 unblock_input ();
4614 #else /* not USE_GTK */
4616 static void
4617 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4619 Window xwindow;
4620 Widget widget;
4621 Arg av[20];
4622 int ac = 0;
4623 const char *scroll_bar_name = SCROLL_BAR_NAME;
4624 unsigned long pixel;
4626 block_input ();
4628 #ifdef USE_MOTIF
4629 /* Set resources. Create the widget. */
4630 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4631 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4632 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4633 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4634 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4635 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4636 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4638 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4639 if (pixel != -1)
4641 XtSetArg (av[ac], XmNforeground, pixel);
4642 ++ac;
4645 pixel = f->output_data.x->scroll_bar_background_pixel;
4646 if (pixel != -1)
4648 XtSetArg (av[ac], XmNbackground, pixel);
4649 ++ac;
4652 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4653 (char *) scroll_bar_name, av, ac);
4655 /* Add one callback for everything that can happen. */
4656 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4657 (XtPointer) bar);
4658 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4659 (XtPointer) bar);
4660 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4661 (XtPointer) bar);
4662 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4663 (XtPointer) bar);
4664 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4665 (XtPointer) bar);
4666 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4667 (XtPointer) bar);
4668 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4669 (XtPointer) bar);
4671 /* Realize the widget. Only after that is the X window created. */
4672 XtRealizeWidget (widget);
4674 /* Set the cursor to an arrow. I didn't find a resource to do that.
4675 And I'm wondering why it hasn't an arrow cursor by default. */
4676 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4677 f->output_data.x->nontext_cursor);
4679 #else /* !USE_MOTIF i.e. use Xaw */
4681 /* Set resources. Create the widget. The background of the
4682 Xaw3d scroll bar widget is a little bit light for my taste.
4683 We don't alter it here to let users change it according
4684 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4685 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4686 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4687 /* For smoother scrolling with Xaw3d -sm */
4688 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4690 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4691 if (pixel != -1)
4693 XtSetArg (av[ac], XtNforeground, pixel);
4694 ++ac;
4697 pixel = f->output_data.x->scroll_bar_background_pixel;
4698 if (pixel != -1)
4700 XtSetArg (av[ac], XtNbackground, pixel);
4701 ++ac;
4704 /* Top/bottom shadow colors. */
4706 /* Allocate them, if necessary. */
4707 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4709 pixel = f->output_data.x->scroll_bar_background_pixel;
4710 if (pixel != -1)
4712 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4713 FRAME_X_COLORMAP (f),
4714 &pixel, 1.2, 0x8000))
4715 pixel = -1;
4716 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4719 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4721 pixel = f->output_data.x->scroll_bar_background_pixel;
4722 if (pixel != -1)
4724 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4725 FRAME_X_COLORMAP (f),
4726 &pixel, 0.6, 0x4000))
4727 pixel = -1;
4728 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4732 #ifdef XtNbeNiceToColormap
4733 /* Tell the toolkit about them. */
4734 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4735 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4736 /* We tried to allocate a color for the top/bottom shadow, and
4737 failed, so tell Xaw3d to use dithering instead. */
4738 /* But only if we have a small colormap. Xaw3d can allocate nice
4739 colors itself. */
4741 XtSetArg (av[ac], XtNbeNiceToColormap,
4742 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4743 ++ac;
4745 else
4746 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4747 be more consistent with other emacs 3d colors, and since Xaw3d is
4748 not good at dealing with allocation failure. */
4750 /* This tells Xaw3d to use real colors instead of dithering for
4751 the shadows. */
4752 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4753 ++ac;
4755 /* Specify the colors. */
4756 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4757 if (pixel != -1)
4759 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4760 ++ac;
4762 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4763 if (pixel != -1)
4765 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4766 ++ac;
4769 #endif
4771 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4772 f->output_data.x->edit_widget, av, ac);
4775 char const *initial = "";
4776 char const *val = initial;
4777 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4778 #ifdef XtNarrowScrollbars
4779 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4780 #endif
4781 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4782 if (xaw3d_arrow_scroll || val == initial)
4783 { /* ARROW_SCROLL */
4784 xaw3d_arrow_scroll = True;
4785 /* Isn't that just a personal preference ? --Stef */
4786 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4790 /* Define callbacks. */
4791 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4792 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4793 (XtPointer) bar);
4795 /* Realize the widget. Only after that is the X window created. */
4796 XtRealizeWidget (widget);
4798 #endif /* !USE_MOTIF */
4800 /* Install an action hook that lets us detect when the user
4801 finishes interacting with a scroll bar. */
4802 if (action_hook_id == 0)
4803 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4805 /* Remember X window and widget in the scroll bar vector. */
4806 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4807 xwindow = XtWindow (widget);
4808 bar->x_window = xwindow;
4810 unblock_input ();
4812 #endif /* not USE_GTK */
4815 /* Set the thumb size and position of scroll bar BAR. We are currently
4816 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4818 #ifdef USE_GTK
4819 static void
4820 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4822 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4825 #else /* not USE_GTK */
4826 static void
4827 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4828 int whole)
4830 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4831 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4832 float top, shown;
4834 block_input ();
4836 #ifdef USE_MOTIF
4838 /* We use an estimate of 30 chars per line rather than the real
4839 `portion' value. This has the disadvantage that the thumb size
4840 is not very representative, but it makes our life a lot easier.
4841 Otherwise, we have to constantly adjust the thumb size, which
4842 we can't always do quickly enough: while dragging, the size of
4843 the thumb might prevent the user from dragging the thumb all the
4844 way to the end. but Motif and some versions of Xaw3d don't allow
4845 updating the thumb size while dragging. Also, even if we can update
4846 its size, the update will often happen too late.
4847 If you don't believe it, check out revision 1.650 of xterm.c to see
4848 what hoops we were going through and the still poor behavior we got. */
4849 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4850 /* When the thumb is at the bottom, position == whole.
4851 So we need to increase `whole' to make space for the thumb. */
4852 whole += portion;
4854 if (whole <= 0)
4855 top = 0, shown = 1;
4856 else
4858 top = (float) position / whole;
4859 shown = (float) portion / whole;
4862 if (NILP (bar->dragging))
4864 int size, value;
4866 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4867 is the scroll bar's maximum and MIN is the scroll bar's minimum
4868 value. */
4869 size = shown * XM_SB_MAX;
4870 size = min (size, XM_SB_MAX);
4871 size = max (size, 1);
4873 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4874 value = top * XM_SB_MAX;
4875 value = min (value, XM_SB_MAX - size);
4877 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4879 #else /* !USE_MOTIF i.e. use Xaw */
4881 if (whole == 0)
4882 top = 0, shown = 1;
4883 else
4885 top = (float) position / whole;
4886 shown = (float) portion / whole;
4890 float old_top, old_shown;
4891 Dimension height;
4892 XtVaGetValues (widget,
4893 XtNtopOfThumb, &old_top,
4894 XtNshown, &old_shown,
4895 XtNheight, &height,
4896 NULL);
4898 /* Massage the top+shown values. */
4899 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4900 top = max (0, min (1, top));
4901 else
4902 top = old_top;
4903 /* Keep two pixels available for moving the thumb down. */
4904 shown = max (0, min (1 - top - (2.0f / height), shown));
4906 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4907 check that your system's configuration file contains a define
4908 for `NARROWPROTO'. See s/freebsd.h for an example. */
4909 if (top != old_top || shown != old_shown)
4911 if (NILP (bar->dragging))
4912 XawScrollbarSetThumb (widget, top, shown);
4913 else
4915 /* Try to make the scrolling a tad smoother. */
4916 if (!xaw3d_pick_top)
4917 shown = min (shown, old_shown);
4919 XawScrollbarSetThumb (widget, top, shown);
4923 #endif /* !USE_MOTIF */
4925 unblock_input ();
4927 #endif /* not USE_GTK */
4929 #endif /* USE_TOOLKIT_SCROLL_BARS */
4933 /************************************************************************
4934 Scroll bars, general
4935 ************************************************************************/
4937 /* Create a scroll bar and return the scroll bar vector for it. W is
4938 the Emacs window on which to create the scroll bar. TOP, LEFT,
4939 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4940 scroll bar. */
4942 static struct scroll_bar *
4943 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4945 struct frame *f = XFRAME (w->frame);
4946 struct scroll_bar *bar
4947 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4948 Lisp_Object barobj;
4950 block_input ();
4952 #ifdef USE_TOOLKIT_SCROLL_BARS
4953 x_create_toolkit_scroll_bar (f, bar);
4954 #else /* not USE_TOOLKIT_SCROLL_BARS */
4956 XSetWindowAttributes a;
4957 unsigned long mask;
4958 Window window;
4960 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4961 if (a.background_pixel == -1)
4962 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4964 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4965 | ButtonMotionMask | PointerMotionHintMask
4966 | ExposureMask);
4967 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4969 mask = (CWBackPixel | CWEventMask | CWCursor);
4971 /* Clear the area of W that will serve as a scroll bar. This is
4972 for the case that a window has been split horizontally. In
4973 this case, no clear_frame is generated to reduce flickering. */
4974 if (width > 0 && height > 0)
4975 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4976 left, top, width,
4977 window_box_height (w), False);
4979 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4980 /* Position and size of scroll bar. */
4981 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4982 top,
4983 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4984 height,
4985 /* Border width, depth, class, and visual. */
4987 CopyFromParent,
4988 CopyFromParent,
4989 CopyFromParent,
4990 /* Attributes. */
4991 mask, &a);
4992 bar->x_window = window;
4994 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4996 XSETWINDOW (bar->window, w);
4997 bar->top = top;
4998 bar->left = left;
4999 bar->width = width;
5000 bar->height = height;
5001 bar->start = 0;
5002 bar->end = 0;
5003 bar->dragging = Qnil;
5004 bar->fringe_extended_p = 0;
5006 /* Add bar to its frame's list of scroll bars. */
5007 bar->next = FRAME_SCROLL_BARS (f);
5008 bar->prev = Qnil;
5009 XSETVECTOR (barobj, bar);
5010 fset_scroll_bars (f, barobj);
5011 if (!NILP (bar->next))
5012 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5014 /* Map the window/widget. */
5015 #ifdef USE_TOOLKIT_SCROLL_BARS
5017 #ifdef USE_GTK
5018 xg_update_scrollbar_pos (f,
5019 bar->x_window,
5020 top,
5021 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5022 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5023 max (height, 1));
5024 #else /* not USE_GTK */
5025 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
5026 XtConfigureWidget (scroll_bar,
5027 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5028 top,
5029 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5030 max (height, 1), 0);
5031 XtMapWidget (scroll_bar);
5032 #endif /* not USE_GTK */
5034 #else /* not USE_TOOLKIT_SCROLL_BARS */
5035 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
5036 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5038 unblock_input ();
5039 return bar;
5043 #ifndef USE_TOOLKIT_SCROLL_BARS
5045 /* Draw BAR's handle in the proper position.
5047 If the handle is already drawn from START to END, don't bother
5048 redrawing it, unless REBUILD is non-zero; in that case, always
5049 redraw it. (REBUILD is handy for drawing the handle after expose
5050 events.)
5052 Normally, we want to constrain the start and end of the handle to
5053 fit inside its rectangle, but if the user is dragging the scroll
5054 bar handle, we want to let them drag it down all the way, so that
5055 the bar's top is as far down as it goes; otherwise, there's no way
5056 to move to the very end of the buffer. */
5058 static void
5059 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
5061 int dragging = ! NILP (bar->dragging);
5062 Window w = bar->x_window;
5063 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5064 GC gc = f->output_data.x->normal_gc;
5066 /* If the display is already accurate, do nothing. */
5067 if (! rebuild
5068 && start == bar->start
5069 && end == bar->end)
5070 return;
5072 block_input ();
5075 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5076 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5077 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5079 /* Make sure the values are reasonable, and try to preserve
5080 the distance between start and end. */
5082 int length = end - start;
5084 if (start < 0)
5085 start = 0;
5086 else if (start > top_range)
5087 start = top_range;
5088 end = start + length;
5090 if (end < start)
5091 end = start;
5092 else if (end > top_range && ! dragging)
5093 end = top_range;
5096 /* Store the adjusted setting in the scroll bar. */
5097 bar->start = start;
5098 bar->end = end;
5100 /* Clip the end position, just for display. */
5101 if (end > top_range)
5102 end = top_range;
5104 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5105 below top positions, to make sure the handle is always at least
5106 that many pixels tall. */
5107 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5109 /* Draw the empty space above the handle. Note that we can't clear
5110 zero-height areas; that means "clear to end of window." */
5111 if (0 < start)
5112 x_clear_area (FRAME_X_DISPLAY (f), w,
5113 /* x, y, width, height, and exposures. */
5114 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5115 VERTICAL_SCROLL_BAR_TOP_BORDER,
5116 inside_width, start,
5117 False);
5119 /* Change to proper foreground color if one is specified. */
5120 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5121 XSetForeground (FRAME_X_DISPLAY (f), gc,
5122 f->output_data.x->scroll_bar_foreground_pixel);
5124 /* Draw the handle itself. */
5125 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5126 /* x, y, width, height */
5127 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5128 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5129 inside_width, end - start);
5131 /* Restore the foreground color of the GC if we changed it above. */
5132 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5133 XSetForeground (FRAME_X_DISPLAY (f), gc,
5134 FRAME_FOREGROUND_PIXEL (f));
5136 /* Draw the empty space below the handle. Note that we can't
5137 clear zero-height areas; that means "clear to end of window." */
5138 if (end < inside_height)
5139 x_clear_area (FRAME_X_DISPLAY (f), w,
5140 /* x, y, width, height, and exposures. */
5141 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5142 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5143 inside_width, inside_height - end,
5144 False);
5148 unblock_input ();
5151 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5153 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5154 nil. */
5156 static void
5157 x_scroll_bar_remove (struct scroll_bar *bar)
5159 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5160 block_input ();
5162 #ifdef USE_TOOLKIT_SCROLL_BARS
5163 #ifdef USE_GTK
5164 xg_remove_scroll_bar (f, bar->x_window);
5165 #else /* not USE_GTK */
5166 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5167 #endif /* not USE_GTK */
5168 #else
5169 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5170 #endif
5172 /* Dissociate this scroll bar from its window. */
5173 wset_vertical_scroll_bar (XWINDOW (bar->window), Qnil);
5175 unblock_input ();
5179 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5180 that we are displaying PORTION characters out of a total of WHOLE
5181 characters, starting at POSITION. If WINDOW has no scroll bar,
5182 create one. */
5184 static void
5185 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5187 struct frame *f = XFRAME (w->frame);
5188 Lisp_Object barobj;
5189 struct scroll_bar *bar;
5190 int top, height, left, sb_left, width, sb_width;
5191 int window_y, window_height;
5192 #ifdef USE_TOOLKIT_SCROLL_BARS
5193 int fringe_extended_p;
5194 #endif
5196 /* Get window dimensions. */
5197 window_box (w, -1, 0, &window_y, 0, &window_height);
5198 top = window_y;
5199 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5200 height = window_height;
5202 /* Compute the left edge of the scroll bar area. */
5203 left = WINDOW_SCROLL_BAR_AREA_X (w);
5205 /* Compute the width of the scroll bar which might be less than
5206 the width of the area reserved for the scroll bar. */
5207 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5208 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5209 else
5210 sb_width = width;
5212 /* Compute the left edge of the scroll bar. */
5213 #ifdef USE_TOOLKIT_SCROLL_BARS
5214 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5215 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5216 else
5217 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5218 #else
5219 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5220 sb_left = left + width - sb_width;
5221 else
5222 sb_left = left;
5223 #endif
5225 #ifdef USE_TOOLKIT_SCROLL_BARS
5226 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5227 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5228 && WINDOW_LEFT_FRINGE_WIDTH (w)
5229 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5230 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5231 else
5232 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5233 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5234 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5235 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5236 #endif
5238 /* Does the scroll bar exist yet? */
5239 if (NILP (w->vertical_scroll_bar))
5241 if (width > 0 && height > 0)
5243 block_input ();
5244 #ifdef USE_TOOLKIT_SCROLL_BARS
5245 if (fringe_extended_p)
5246 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5247 sb_left, top, sb_width, height, False);
5248 else
5249 #endif
5250 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5251 left, top, width, height, False);
5252 unblock_input ();
5255 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5257 else
5259 /* It may just need to be moved and resized. */
5260 unsigned int mask = 0;
5262 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5264 block_input ();
5266 if (sb_left != bar->left)
5267 mask |= CWX;
5268 if (top != bar->top)
5269 mask |= CWY;
5270 if (sb_width != bar->width)
5271 mask |= CWWidth;
5272 if (height != bar->height)
5273 mask |= CWHeight;
5275 #ifdef USE_TOOLKIT_SCROLL_BARS
5277 /* Move/size the scroll bar widget. */
5278 if (mask || bar->fringe_extended_p != fringe_extended_p)
5280 /* Since toolkit scroll bars are smaller than the space reserved
5281 for them on the frame, we have to clear "under" them. */
5282 if (width > 0 && height > 0)
5284 if (fringe_extended_p)
5285 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5286 sb_left, top, sb_width, height, False);
5287 else
5288 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5289 left, top, width, height, False);
5291 #ifdef USE_GTK
5292 xg_update_scrollbar_pos (f,
5293 bar->x_window,
5294 top,
5295 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5296 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5297 max (height, 1));
5298 #else /* not USE_GTK */
5299 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5300 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5301 top,
5302 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5303 max (height, 1), 0);
5304 #endif /* not USE_GTK */
5306 #else /* not USE_TOOLKIT_SCROLL_BARS */
5308 /* Clear areas not covered by the scroll bar because of
5309 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5310 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5312 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5313 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5314 height, False);
5315 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5316 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5317 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5318 height, False);
5321 /* Clear areas not covered by the scroll bar because it's not as
5322 wide as the area reserved for it. This makes sure a
5323 previous mode line display is cleared after C-x 2 C-x 1, for
5324 example. */
5326 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5327 int rest = area_width - sb_width;
5328 if (rest > 0 && height > 0)
5330 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5331 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5332 left + area_width - rest, top,
5333 rest, height, False);
5334 else
5335 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5336 left, top, rest, height, False);
5340 /* Move/size the scroll bar window. */
5341 if (mask)
5343 XWindowChanges wc;
5345 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5346 wc.y = top;
5347 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5348 wc.height = height;
5349 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5350 mask, &wc);
5353 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5355 /* Remember new settings. */
5356 bar->left = sb_left;
5357 bar->top = top;
5358 bar->width = sb_width;
5359 bar->height = height;
5361 unblock_input ();
5364 #ifdef USE_TOOLKIT_SCROLL_BARS
5365 bar->fringe_extended_p = fringe_extended_p;
5367 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5368 #else /* not USE_TOOLKIT_SCROLL_BARS */
5369 /* Set the scroll bar's current state, unless we're currently being
5370 dragged. */
5371 if (NILP (bar->dragging))
5373 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5375 if (whole == 0)
5376 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5377 else
5379 int start = ((double) position * top_range) / whole;
5380 int end = ((double) (position + portion) * top_range) / whole;
5381 x_scroll_bar_set_handle (bar, start, end, 0);
5384 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5386 XSETVECTOR (barobj, bar);
5387 wset_vertical_scroll_bar (w, barobj);
5391 /* The following three hooks are used when we're doing a thorough
5392 redisplay of the frame. We don't explicitly know which scroll bars
5393 are going to be deleted, because keeping track of when windows go
5394 away is a real pain - "Can you say set-window-configuration, boys
5395 and girls?" Instead, we just assert at the beginning of redisplay
5396 that *all* scroll bars are to be removed, and then save a scroll bar
5397 from the fiery pit when we actually redisplay its window. */
5399 /* Arrange for all scroll bars on FRAME to be removed at the next call
5400 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5401 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5403 static void
5404 XTcondemn_scroll_bars (FRAME_PTR frame)
5406 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5407 while (! NILP (FRAME_SCROLL_BARS (frame)))
5409 Lisp_Object bar;
5410 bar = FRAME_SCROLL_BARS (frame);
5411 fset_scroll_bars (frame, XSCROLL_BAR (bar)->next);
5412 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5413 XSCROLL_BAR (bar)->prev = Qnil;
5414 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5415 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5416 fset_condemned_scroll_bars (frame, bar);
5421 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5422 Note that WINDOW isn't necessarily condemned at all. */
5424 static void
5425 XTredeem_scroll_bar (struct window *window)
5427 struct scroll_bar *bar;
5428 struct frame *f;
5429 Lisp_Object barobj;
5431 /* We can't redeem this window's scroll bar if it doesn't have one. */
5432 if (NILP (window->vertical_scroll_bar))
5433 emacs_abort ();
5435 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5437 /* Unlink it from the condemned list. */
5438 f = XFRAME (WINDOW_FRAME (window));
5439 if (NILP (bar->prev))
5441 /* If the prev pointer is nil, it must be the first in one of
5442 the lists. */
5443 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5444 /* It's not condemned. Everything's fine. */
5445 return;
5446 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5447 window->vertical_scroll_bar))
5448 fset_condemned_scroll_bars (f, bar->next);
5449 else
5450 /* If its prev pointer is nil, it must be at the front of
5451 one or the other! */
5452 emacs_abort ();
5454 else
5455 XSCROLL_BAR (bar->prev)->next = bar->next;
5457 if (! NILP (bar->next))
5458 XSCROLL_BAR (bar->next)->prev = bar->prev;
5460 bar->next = FRAME_SCROLL_BARS (f);
5461 bar->prev = Qnil;
5462 XSETVECTOR (barobj, bar);
5463 fset_scroll_bars (f, barobj);
5464 if (! NILP (bar->next))
5465 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5468 /* Remove all scroll bars on FRAME that haven't been saved since the
5469 last call to `*condemn_scroll_bars_hook'. */
5471 static void
5472 XTjudge_scroll_bars (FRAME_PTR f)
5474 Lisp_Object bar, next;
5476 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5478 /* Clear out the condemned list now so we won't try to process any
5479 more events on the hapless scroll bars. */
5480 fset_condemned_scroll_bars (f, Qnil);
5482 for (; ! NILP (bar); bar = next)
5484 struct scroll_bar *b = XSCROLL_BAR (bar);
5486 x_scroll_bar_remove (b);
5488 next = b->next;
5489 b->next = b->prev = Qnil;
5492 /* Now there should be no references to the condemned scroll bars,
5493 and they should get garbage-collected. */
5497 #ifndef USE_TOOLKIT_SCROLL_BARS
5498 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5499 is a no-op when using toolkit scroll bars.
5501 This may be called from a signal handler, so we have to ignore GC
5502 mark bits. */
5504 static void
5505 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5507 Window w = bar->x_window;
5508 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5509 GC gc = f->output_data.x->normal_gc;
5510 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5512 block_input ();
5514 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5516 /* Switch to scroll bar foreground color. */
5517 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5518 XSetForeground (FRAME_X_DISPLAY (f), gc,
5519 f->output_data.x->scroll_bar_foreground_pixel);
5521 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5522 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5524 /* x, y, width, height */
5525 0, 0,
5526 bar->width - 1 - width_trim - width_trim,
5527 bar->height - 1);
5529 /* Restore the foreground color of the GC if we changed it above. */
5530 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5531 XSetForeground (FRAME_X_DISPLAY (f), gc,
5532 FRAME_FOREGROUND_PIXEL (f));
5534 unblock_input ();
5537 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5539 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5540 is set to something other than NO_EVENT, it is enqueued.
5542 This may be called from a signal handler, so we have to ignore GC
5543 mark bits. */
5546 static void
5547 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5549 if (! WINDOWP (bar->window))
5550 emacs_abort ();
5552 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5553 emacs_event->code = event->xbutton.button - Button1;
5554 emacs_event->modifiers
5555 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5556 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5557 event->xbutton.state)
5558 | (event->type == ButtonRelease
5559 ? up_modifier
5560 : down_modifier));
5561 emacs_event->frame_or_window = bar->window;
5562 emacs_event->arg = Qnil;
5563 emacs_event->timestamp = event->xbutton.time;
5565 int top_range
5566 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5567 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5569 if (y < 0) y = 0;
5570 if (y > top_range) y = top_range;
5572 if (y < bar->start)
5573 emacs_event->part = scroll_bar_above_handle;
5574 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5575 emacs_event->part = scroll_bar_handle;
5576 else
5577 emacs_event->part = scroll_bar_below_handle;
5579 #ifndef USE_TOOLKIT_SCROLL_BARS
5580 /* If the user has released the handle, set it to its final position. */
5581 if (event->type == ButtonRelease
5582 && ! NILP (bar->dragging))
5584 int new_start = y - XINT (bar->dragging);
5585 int new_end = new_start + bar->end - bar->start;
5587 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5588 bar->dragging = Qnil;
5590 #endif
5592 XSETINT (emacs_event->x, y);
5593 XSETINT (emacs_event->y, top_range);
5597 #ifndef USE_TOOLKIT_SCROLL_BARS
5599 /* Handle some mouse motion while someone is dragging the scroll bar.
5601 This may be called from a signal handler, so we have to ignore GC
5602 mark bits. */
5604 static void
5605 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5607 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5609 last_mouse_movement_time = event->xmotion.time;
5611 f->mouse_moved = 1;
5612 XSETVECTOR (last_mouse_scroll_bar, bar);
5614 /* If we're dragging the bar, display it. */
5615 if (! NILP (bar->dragging))
5617 /* Where should the handle be now? */
5618 int new_start = event->xmotion.y - XINT (bar->dragging);
5620 if (new_start != bar->start)
5622 int new_end = new_start + bar->end - bar->start;
5624 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5629 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5631 /* Return information to the user about the current position of the mouse
5632 on the scroll bar. */
5634 static void
5635 x_scroll_bar_report_motion (FRAME_PTR *fp, Lisp_Object *bar_window,
5636 enum scroll_bar_part *part, Lisp_Object *x,
5637 Lisp_Object *y, Time *timestamp)
5639 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5640 Window w = bar->x_window;
5641 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5642 int win_x, win_y;
5643 Window dummy_window;
5644 int dummy_coord;
5645 unsigned int dummy_mask;
5647 block_input ();
5649 /* Get the mouse's position relative to the scroll bar window, and
5650 report that. */
5651 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5653 /* Root, child, root x and root y. */
5654 &dummy_window, &dummy_window,
5655 &dummy_coord, &dummy_coord,
5657 /* Position relative to scroll bar. */
5658 &win_x, &win_y,
5660 /* Mouse buttons and modifier keys. */
5661 &dummy_mask))
5663 else
5665 int top_range
5666 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5668 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5670 if (! NILP (bar->dragging))
5671 win_y -= XINT (bar->dragging);
5673 if (win_y < 0)
5674 win_y = 0;
5675 if (win_y > top_range)
5676 win_y = top_range;
5678 *fp = f;
5679 *bar_window = bar->window;
5681 if (! NILP (bar->dragging))
5682 *part = scroll_bar_handle;
5683 else if (win_y < bar->start)
5684 *part = scroll_bar_above_handle;
5685 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5686 *part = scroll_bar_handle;
5687 else
5688 *part = scroll_bar_below_handle;
5690 XSETINT (*x, win_y);
5691 XSETINT (*y, top_range);
5693 f->mouse_moved = 0;
5694 last_mouse_scroll_bar = Qnil;
5697 *timestamp = last_mouse_movement_time;
5699 unblock_input ();
5703 /* The screen has been cleared so we may have changed foreground or
5704 background colors, and the scroll bars may need to be redrawn.
5705 Clear out the scroll bars, and ask for expose events, so we can
5706 redraw them. */
5708 static void
5709 x_scroll_bar_clear (FRAME_PTR f)
5711 #ifndef USE_TOOLKIT_SCROLL_BARS
5712 Lisp_Object bar;
5714 /* We can have scroll bars even if this is 0,
5715 if we just turned off scroll bar mode.
5716 But in that case we should not clear them. */
5717 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5718 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5719 bar = XSCROLL_BAR (bar)->next)
5720 XClearArea (FRAME_X_DISPLAY (f),
5721 XSCROLL_BAR (bar)->x_window,
5722 0, 0, 0, 0, True);
5723 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5727 /* The main X event-reading loop - XTread_socket. */
5729 /* This holds the state XLookupString needs to implement dead keys
5730 and other tricks known as "compose processing". _X Window System_
5731 says that a portable program can't use this, but Stephen Gildea assures
5732 me that letting the compiler initialize it to zeros will work okay.
5734 This must be defined outside of XTread_socket, for the same reasons
5735 given for enter_timestamp, above. */
5737 static XComposeStatus compose_status;
5739 /* Record the last 100 characters stored
5740 to help debug the loss-of-chars-during-GC problem. */
5742 static int temp_index;
5743 static short temp_buffer[100];
5745 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5746 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5747 temp_index = 0; \
5748 temp_buffer[temp_index++] = (keysym)
5750 /* Set this to nonzero to fake an "X I/O error"
5751 on a particular display. */
5753 static struct x_display_info *XTread_socket_fake_io_error;
5755 /* When we find no input here, we occasionally do a no-op command
5756 to verify that the X server is still running and we can still talk with it.
5757 We try all the open displays, one by one.
5758 This variable is used for cycling thru the displays. */
5760 static struct x_display_info *next_noop_dpyinfo;
5762 #if defined USE_X_TOOLKIT || defined USE_GTK
5763 #define SET_SAVED_BUTTON_EVENT \
5764 do \
5766 if (f->output_data.x->saved_menu_event == 0) \
5767 f->output_data.x->saved_menu_event = \
5768 xmalloc (sizeof (XEvent)); \
5769 *f->output_data.x->saved_menu_event = event; \
5770 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5771 XSETFRAME (inev.ie.frame_or_window, f); \
5773 while (0)
5774 #endif
5776 enum
5778 X_EVENT_NORMAL,
5779 X_EVENT_GOTO_OUT,
5780 X_EVENT_DROP
5783 /* Filter events for the current X input method.
5784 DPYINFO is the display this event is for.
5785 EVENT is the X event to filter.
5787 Returns non-zero if the event was filtered, caller shall not process
5788 this event further.
5789 Returns zero if event is wasn't filtered. */
5791 #ifdef HAVE_X_I18N
5792 static int
5793 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5795 /* XFilterEvent returns non-zero if the input method has
5796 consumed the event. We pass the frame's X window to
5797 XFilterEvent because that's the one for which the IC
5798 was created. */
5800 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5801 event->xclient.window);
5803 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5805 #endif
5807 #ifdef USE_GTK
5808 static int current_count;
5809 static int current_finish;
5810 static struct input_event *current_hold_quit;
5812 /* This is the filter function invoked by the GTK event loop.
5813 It is invoked before the XEvent is translated to a GdkEvent,
5814 so we have a chance to act on the event before GTK. */
5815 static GdkFilterReturn
5816 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5818 XEvent *xev = (XEvent *) gxev;
5820 block_input ();
5821 if (current_count >= 0)
5823 struct x_display_info *dpyinfo;
5825 dpyinfo = x_display_info_for_display (xev->xany.display);
5827 #ifdef HAVE_X_I18N
5828 /* Filter events for the current X input method.
5829 GTK calls XFilterEvent but not for key press and release,
5830 so we do it here. */
5831 if ((xev->type == KeyPress || xev->type == KeyRelease)
5832 && dpyinfo
5833 && x_filter_event (dpyinfo, xev))
5835 unblock_input ();
5836 return GDK_FILTER_REMOVE;
5838 #endif
5840 if (! dpyinfo)
5841 current_finish = X_EVENT_NORMAL;
5842 else
5843 current_count +=
5844 handle_one_xevent (dpyinfo, xev, &current_finish,
5845 current_hold_quit);
5847 else
5848 current_finish = x_dispatch_event (xev, xev->xany.display);
5850 unblock_input ();
5852 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5853 return GDK_FILTER_REMOVE;
5855 return GDK_FILTER_CONTINUE;
5857 #endif /* USE_GTK */
5860 static void xembed_send_message (struct frame *f, Time,
5861 enum xembed_message,
5862 long detail, long data1, long data2);
5864 /* Handles the XEvent EVENT on display DPYINFO.
5866 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5867 *FINISH is zero if caller should continue reading events.
5868 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5870 We return the number of characters stored into the buffer. */
5872 static int
5873 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventptr,
5874 int *finish, struct input_event *hold_quit)
5876 union {
5877 struct input_event ie;
5878 struct selection_input_event sie;
5879 } inev;
5880 int count = 0;
5881 int do_help = 0;
5882 ptrdiff_t nbytes = 0;
5883 struct frame *f = NULL;
5884 struct coding_system coding;
5885 XEvent event = *eventptr;
5886 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5887 USE_SAFE_ALLOCA;
5889 *finish = X_EVENT_NORMAL;
5891 EVENT_INIT (inev.ie);
5892 inev.ie.kind = NO_EVENT;
5893 inev.ie.arg = Qnil;
5895 if (pending_event_wait.eventtype == event.type)
5896 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5898 switch (event.type)
5900 case ClientMessage:
5902 if (event.xclient.message_type
5903 == dpyinfo->Xatom_wm_protocols
5904 && event.xclient.format == 32)
5906 if (event.xclient.data.l[0]
5907 == dpyinfo->Xatom_wm_take_focus)
5909 /* Use x_any_window_to_frame because this
5910 could be the shell widget window
5911 if the frame has no title bar. */
5912 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5913 #ifdef HAVE_X_I18N
5914 /* Not quite sure this is needed -pd */
5915 if (f && FRAME_XIC (f))
5916 XSetICFocus (FRAME_XIC (f));
5917 #endif
5918 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5919 instructs the WM to set the input focus automatically for
5920 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5921 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5922 it has set the focus. So, XSetInputFocus below is not
5923 needed.
5925 The call to XSetInputFocus below has also caused trouble. In
5926 cases where the XSetInputFocus done by the WM and the one
5927 below are temporally close (on a fast machine), the call
5928 below can generate additional FocusIn events which confuse
5929 Emacs. */
5931 /* Since we set WM_TAKE_FOCUS, we must call
5932 XSetInputFocus explicitly. But not if f is null,
5933 since that might be an event for a deleted frame. */
5934 if (f)
5936 Display *d = event.xclient.display;
5937 /* Catch and ignore errors, in case window has been
5938 iconified by a window manager such as GWM. */
5939 x_catch_errors (d);
5940 XSetInputFocus (d, event.xclient.window,
5941 /* The ICCCM says this is
5942 the only valid choice. */
5943 RevertToParent,
5944 event.xclient.data.l[1]);
5945 /* This is needed to detect the error
5946 if there is an error. */
5947 XSync (d, False);
5948 x_uncatch_errors ();
5950 /* Not certain about handling scroll bars here */
5951 #endif /* 0 */
5952 goto done;
5955 if (event.xclient.data.l[0]
5956 == dpyinfo->Xatom_wm_save_yourself)
5958 /* Save state modify the WM_COMMAND property to
5959 something which can reinstate us. This notifies
5960 the session manager, who's looking for such a
5961 PropertyNotify. Can restart processing when
5962 a keyboard or mouse event arrives. */
5963 /* If we have a session manager, don't set this.
5964 KDE will then start two Emacsen, one for the
5965 session manager and one for this. */
5966 #ifdef HAVE_X_SM
5967 if (! x_session_have_connection ())
5968 #endif
5970 f = x_top_window_to_frame (dpyinfo,
5971 event.xclient.window);
5972 /* This is just so we only give real data once
5973 for a single Emacs process. */
5974 if (f == SELECTED_FRAME ())
5975 XSetCommand (FRAME_X_DISPLAY (f),
5976 event.xclient.window,
5977 initial_argv, initial_argc);
5978 else if (f)
5979 XSetCommand (FRAME_X_DISPLAY (f),
5980 event.xclient.window,
5981 0, 0);
5983 goto done;
5986 if (event.xclient.data.l[0]
5987 == dpyinfo->Xatom_wm_delete_window)
5989 f = x_any_window_to_frame (dpyinfo,
5990 event.xclient.window);
5991 if (!f)
5992 goto OTHER; /* May be a dialog that is to be removed */
5994 inev.ie.kind = DELETE_WINDOW_EVENT;
5995 XSETFRAME (inev.ie.frame_or_window, f);
5996 goto done;
5999 goto done;
6002 if (event.xclient.message_type
6003 == dpyinfo->Xatom_wm_configure_denied)
6005 goto done;
6008 if (event.xclient.message_type
6009 == dpyinfo->Xatom_wm_window_moved)
6011 int new_x, new_y;
6012 f = x_window_to_frame (dpyinfo, event.xclient.window);
6014 new_x = event.xclient.data.s[0];
6015 new_y = event.xclient.data.s[1];
6017 if (f)
6019 f->left_pos = new_x;
6020 f->top_pos = new_y;
6022 goto done;
6025 #ifdef HACK_EDITRES
6026 if (event.xclient.message_type
6027 == dpyinfo->Xatom_editres)
6029 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6030 if (f)
6031 _XEditResCheckMessages (f->output_data.x->widget, NULL,
6032 &event, NULL);
6033 goto done;
6035 #endif /* HACK_EDITRES */
6037 if ((event.xclient.message_type
6038 == dpyinfo->Xatom_DONE)
6039 || (event.xclient.message_type
6040 == dpyinfo->Xatom_PAGE))
6042 /* Ghostview job completed. Kill it. We could
6043 reply with "Next" if we received "Page", but we
6044 currently never do because we are interested in
6045 images, only, which should have 1 page. */
6046 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6047 f = x_window_to_frame (dpyinfo, event.xclient.window);
6048 if (!f)
6049 goto OTHER;
6050 x_kill_gs_process (pixmap, f);
6051 expose_frame (f, 0, 0, 0, 0);
6052 goto done;
6055 #ifdef USE_TOOLKIT_SCROLL_BARS
6056 /* Scroll bar callbacks send a ClientMessage from which
6057 we construct an input_event. */
6058 if (event.xclient.message_type
6059 == dpyinfo->Xatom_Scrollbar)
6061 x_scroll_bar_to_input_event (&event, &inev.ie);
6062 *finish = X_EVENT_GOTO_OUT;
6063 goto done;
6065 #endif /* USE_TOOLKIT_SCROLL_BARS */
6067 /* XEmbed messages from the embedder (if any). */
6068 if (event.xclient.message_type
6069 == dpyinfo->Xatom_XEMBED)
6071 enum xembed_message msg = event.xclient.data.l[1];
6072 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6073 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6075 *finish = X_EVENT_GOTO_OUT;
6076 goto done;
6079 xft_settings_event (dpyinfo, &event);
6081 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6082 if (!f)
6083 goto OTHER;
6084 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6085 *finish = X_EVENT_DROP;
6087 break;
6089 case SelectionNotify:
6090 last_user_time = event.xselection.time;
6091 #ifdef USE_X_TOOLKIT
6092 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6093 goto OTHER;
6094 #endif /* not USE_X_TOOLKIT */
6095 x_handle_selection_notify (&event.xselection);
6096 break;
6098 case SelectionClear: /* Someone has grabbed ownership. */
6099 last_user_time = event.xselectionclear.time;
6100 #ifdef USE_X_TOOLKIT
6101 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6102 goto OTHER;
6103 #endif /* USE_X_TOOLKIT */
6105 XSelectionClearEvent *eventp = &(event.xselectionclear);
6107 inev.ie.kind = SELECTION_CLEAR_EVENT;
6108 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6109 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6110 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6111 inev.ie.frame_or_window = Qnil;
6113 break;
6115 case SelectionRequest: /* Someone wants our selection. */
6116 last_user_time = event.xselectionrequest.time;
6117 #ifdef USE_X_TOOLKIT
6118 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6119 goto OTHER;
6120 #endif /* USE_X_TOOLKIT */
6122 XSelectionRequestEvent *eventp = &(event.xselectionrequest);
6124 inev.ie.kind = SELECTION_REQUEST_EVENT;
6125 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6126 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6127 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6128 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6129 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6130 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6131 inev.ie.frame_or_window = Qnil;
6133 break;
6135 case PropertyNotify:
6136 last_user_time = event.xproperty.time;
6137 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6138 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6139 if (x_handle_net_wm_state (f, &event.xproperty) && f->iconified
6140 && f->output_data.x->net_wm_state_hidden_seen)
6142 /* Gnome shell does not iconify us when C-z is pressed. It hides
6143 the frame. So if our state says we aren't hidden anymore,
6144 treat it as deiconified. */
6145 if (! f->async_iconified)
6146 SET_FRAME_GARBAGED (f);
6147 f->async_visible = 1;
6148 f->async_iconified = 0;
6149 f->output_data.x->has_been_visible = 1;
6150 f->output_data.x->net_wm_state_hidden_seen = 0;
6151 inev.ie.kind = DEICONIFY_EVENT;
6152 XSETFRAME (inev.ie.frame_or_window, f);
6155 x_handle_property_notify (&event.xproperty);
6156 xft_settings_event (dpyinfo, &event);
6157 goto OTHER;
6159 case ReparentNotify:
6160 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6161 if (f)
6163 int x, y;
6164 f->output_data.x->parent_desc = event.xreparent.parent;
6165 x_real_positions (f, &x, &y);
6166 f->left_pos = x;
6167 f->top_pos = y;
6169 /* Perhaps reparented due to a WM restart. Reset this. */
6170 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6171 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6173 x_set_frame_alpha (f);
6175 goto OTHER;
6177 case Expose:
6178 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6179 if (f)
6181 #ifdef USE_GTK
6182 /* This seems to be needed for GTK 2.6. */
6183 x_clear_area (event.xexpose.display,
6184 event.xexpose.window,
6185 event.xexpose.x, event.xexpose.y,
6186 event.xexpose.width, event.xexpose.height,
6187 FALSE);
6188 #endif
6189 if (f->async_visible == 0)
6191 f->async_visible = 1;
6192 f->async_iconified = 0;
6193 f->output_data.x->has_been_visible = 1;
6194 SET_FRAME_GARBAGED (f);
6196 else
6197 expose_frame (f,
6198 event.xexpose.x, event.xexpose.y,
6199 event.xexpose.width, event.xexpose.height);
6201 else
6203 #ifndef USE_TOOLKIT_SCROLL_BARS
6204 struct scroll_bar *bar;
6205 #endif
6206 #if defined USE_LUCID
6207 /* Submenus of the Lucid menu bar aren't widgets
6208 themselves, so there's no way to dispatch events
6209 to them. Recognize this case separately. */
6211 Widget widget
6212 = x_window_to_menu_bar (event.xexpose.window);
6213 if (widget)
6214 xlwmenu_redisplay (widget);
6216 #endif /* USE_LUCID */
6218 #ifdef USE_TOOLKIT_SCROLL_BARS
6219 /* Dispatch event to the widget. */
6220 goto OTHER;
6221 #else /* not USE_TOOLKIT_SCROLL_BARS */
6222 bar = x_window_to_scroll_bar (event.xexpose.display,
6223 event.xexpose.window);
6225 if (bar)
6226 x_scroll_bar_expose (bar, &event);
6227 #ifdef USE_X_TOOLKIT
6228 else
6229 goto OTHER;
6230 #endif /* USE_X_TOOLKIT */
6231 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6233 break;
6235 case GraphicsExpose: /* This occurs when an XCopyArea's
6236 source area was obscured or not
6237 available. */
6238 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6239 if (f)
6241 expose_frame (f,
6242 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6243 event.xgraphicsexpose.width,
6244 event.xgraphicsexpose.height);
6246 #ifdef USE_X_TOOLKIT
6247 else
6248 goto OTHER;
6249 #endif /* USE_X_TOOLKIT */
6250 break;
6252 case NoExpose: /* This occurs when an XCopyArea's
6253 source area was completely
6254 available. */
6255 break;
6257 case UnmapNotify:
6258 /* Redo the mouse-highlight after the tooltip has gone. */
6259 if (event.xmap.window == tip_window)
6261 tip_window = 0;
6262 redo_mouse_highlight ();
6265 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6266 if (f) /* F may no longer exist if
6267 the frame was deleted. */
6269 /* While a frame is unmapped, display generation is
6270 disabled; you don't want to spend time updating a
6271 display that won't ever be seen. */
6272 f->async_visible = 0;
6273 /* We can't distinguish, from the event, whether the window
6274 has become iconified or invisible. So assume, if it
6275 was previously visible, than now it is iconified.
6276 But x_make_frame_invisible clears both
6277 the visible flag and the iconified flag;
6278 and that way, we know the window is not iconified now. */
6279 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6281 f->async_iconified = 1;
6283 inev.ie.kind = ICONIFY_EVENT;
6284 XSETFRAME (inev.ie.frame_or_window, f);
6287 goto OTHER;
6289 case MapNotify:
6290 if (event.xmap.window == tip_window)
6291 /* The tooltip has been drawn already. Avoid
6292 the SET_FRAME_GARBAGED below. */
6293 goto OTHER;
6295 /* We use x_top_window_to_frame because map events can
6296 come for sub-windows and they don't mean that the
6297 frame is visible. */
6298 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6299 if (f)
6301 /* wait_reading_process_output will notice this and update
6302 the frame's display structures.
6303 If we where iconified, we should not set garbaged,
6304 because that stops redrawing on Expose events. This looks
6305 bad if we are called from a recursive event loop
6306 (x_dispatch_event), for example when a dialog is up. */
6307 if (! f->async_iconified)
6308 SET_FRAME_GARBAGED (f);
6310 /* Check if fullscreen was specified before we where mapped the
6311 first time, i.e. from the command line. */
6312 if (!f->output_data.x->has_been_visible)
6313 x_check_fullscreen (f);
6315 f->async_visible = 1;
6316 f->async_iconified = 0;
6317 f->output_data.x->has_been_visible = 1;
6319 if (f->iconified)
6321 inev.ie.kind = DEICONIFY_EVENT;
6322 XSETFRAME (inev.ie.frame_or_window, f);
6324 else if (! NILP (Vframe_list)
6325 && ! NILP (XCDR (Vframe_list)))
6326 /* Force a redisplay sooner or later
6327 to update the frame titles
6328 in case this is the second frame. */
6329 record_asynch_buffer_change ();
6331 #ifdef USE_GTK
6332 xg_frame_resized (f, -1, -1);
6333 #endif
6335 goto OTHER;
6337 case KeyPress:
6339 last_user_time = event.xkey.time;
6340 ignore_next_mouse_click_timeout = 0;
6342 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6343 /* Dispatch KeyPress events when in menu. */
6344 if (popup_activated ())
6345 goto OTHER;
6346 #endif
6348 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6350 /* If mouse-highlight is an integer, input clears out
6351 mouse highlighting. */
6352 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6353 && (f == 0
6354 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6356 clear_mouse_face (hlinfo);
6357 hlinfo->mouse_face_hidden = 1;
6360 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6361 if (f == 0)
6363 /* Scroll bars consume key events, but we want
6364 the keys to go to the scroll bar's frame. */
6365 Widget widget = XtWindowToWidget (dpyinfo->display,
6366 event.xkey.window);
6367 if (widget && XmIsScrollBar (widget))
6369 widget = XtParent (widget);
6370 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6373 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6375 if (f != 0)
6377 KeySym keysym, orig_keysym;
6378 /* al%imercury@uunet.uu.net says that making this 81
6379 instead of 80 fixed a bug whereby meta chars made
6380 his Emacs hang.
6382 It seems that some version of XmbLookupString has
6383 a bug of not returning XBufferOverflow in
6384 status_return even if the input is too long to
6385 fit in 81 bytes. So, we must prepare sufficient
6386 bytes for copy_buffer. 513 bytes (256 chars for
6387 two-byte character set) seems to be a fairly good
6388 approximation. -- 2000.8.10 handa@etl.go.jp */
6389 unsigned char copy_buffer[513];
6390 unsigned char *copy_bufptr = copy_buffer;
6391 int copy_bufsiz = sizeof (copy_buffer);
6392 int modifiers;
6393 Lisp_Object coding_system = Qlatin_1;
6394 Lisp_Object c;
6396 #ifdef USE_GTK
6397 /* Don't pass keys to GTK. A Tab will shift focus to the
6398 tool bar in GTK 2.4. Keys will still go to menus and
6399 dialogs because in that case popup_activated is TRUE
6400 (see above). */
6401 *finish = X_EVENT_DROP;
6402 #endif
6404 event.xkey.state
6405 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6406 extra_keyboard_modifiers);
6407 modifiers = event.xkey.state;
6409 /* This will have to go some day... */
6411 /* make_lispy_event turns chars into control chars.
6412 Don't do it here because XLookupString is too eager. */
6413 event.xkey.state &= ~ControlMask;
6414 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6415 | dpyinfo->super_mod_mask
6416 | dpyinfo->hyper_mod_mask
6417 | dpyinfo->alt_mod_mask);
6419 /* In case Meta is ComposeCharacter,
6420 clear its status. According to Markus Ehrnsperger
6421 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6422 this enables ComposeCharacter to work whether or
6423 not it is combined with Meta. */
6424 if (modifiers & dpyinfo->meta_mod_mask)
6425 memset (&compose_status, 0, sizeof (compose_status));
6427 #ifdef HAVE_X_I18N
6428 if (FRAME_XIC (f))
6430 Status status_return;
6432 coding_system = Vlocale_coding_system;
6433 nbytes = XmbLookupString (FRAME_XIC (f),
6434 &event.xkey, (char *) copy_bufptr,
6435 copy_bufsiz, &keysym,
6436 &status_return);
6437 if (status_return == XBufferOverflow)
6439 copy_bufsiz = nbytes + 1;
6440 copy_bufptr = alloca (copy_bufsiz);
6441 nbytes = XmbLookupString (FRAME_XIC (f),
6442 &event.xkey, (char *) copy_bufptr,
6443 copy_bufsiz, &keysym,
6444 &status_return);
6446 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6447 if (status_return == XLookupNone)
6448 break;
6449 else if (status_return == XLookupChars)
6451 keysym = NoSymbol;
6452 modifiers = 0;
6454 else if (status_return != XLookupKeySym
6455 && status_return != XLookupBoth)
6456 emacs_abort ();
6458 else
6459 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6460 copy_bufsiz, &keysym,
6461 &compose_status);
6462 #else
6463 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6464 copy_bufsiz, &keysym,
6465 &compose_status);
6466 #endif
6468 /* If not using XIM/XIC, and a compose sequence is in progress,
6469 we break here. Otherwise, chars_matched is always 0. */
6470 if (compose_status.chars_matched > 0 && nbytes == 0)
6471 break;
6473 memset (&compose_status, 0, sizeof (compose_status));
6474 orig_keysym = keysym;
6476 /* Common for all keysym input events. */
6477 XSETFRAME (inev.ie.frame_or_window, f);
6478 inev.ie.modifiers
6479 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6480 inev.ie.timestamp = event.xkey.time;
6482 /* First deal with keysyms which have defined
6483 translations to characters. */
6484 if (keysym >= 32 && keysym < 128)
6485 /* Avoid explicitly decoding each ASCII character. */
6487 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6488 inev.ie.code = keysym;
6489 goto done_keysym;
6492 /* Keysyms directly mapped to Unicode characters. */
6493 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6495 if (keysym < 0x01000080)
6496 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6497 else
6498 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6499 inev.ie.code = keysym & 0xFFFFFF;
6500 goto done_keysym;
6503 /* Now non-ASCII. */
6504 if (HASH_TABLE_P (Vx_keysym_table)
6505 && (c = Fgethash (make_number (keysym),
6506 Vx_keysym_table,
6507 Qnil),
6508 NATNUMP (c)))
6510 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6511 ? ASCII_KEYSTROKE_EVENT
6512 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6513 inev.ie.code = XFASTINT (c);
6514 goto done_keysym;
6517 /* Random non-modifier sorts of keysyms. */
6518 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6519 || keysym == XK_Delete
6520 #ifdef XK_ISO_Left_Tab
6521 || (keysym >= XK_ISO_Left_Tab
6522 && keysym <= XK_ISO_Enter)
6523 #endif
6524 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6525 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6526 #ifdef HPUX
6527 /* This recognizes the "extended function
6528 keys". It seems there's no cleaner way.
6529 Test IsModifierKey to avoid handling
6530 mode_switch incorrectly. */
6531 || (XK_Select <= keysym && keysym < XK_KP_Space)
6532 #endif
6533 #ifdef XK_dead_circumflex
6534 || orig_keysym == XK_dead_circumflex
6535 #endif
6536 #ifdef XK_dead_grave
6537 || orig_keysym == XK_dead_grave
6538 #endif
6539 #ifdef XK_dead_tilde
6540 || orig_keysym == XK_dead_tilde
6541 #endif
6542 #ifdef XK_dead_diaeresis
6543 || orig_keysym == XK_dead_diaeresis
6544 #endif
6545 #ifdef XK_dead_macron
6546 || orig_keysym == XK_dead_macron
6547 #endif
6548 #ifdef XK_dead_degree
6549 || orig_keysym == XK_dead_degree
6550 #endif
6551 #ifdef XK_dead_acute
6552 || orig_keysym == XK_dead_acute
6553 #endif
6554 #ifdef XK_dead_cedilla
6555 || orig_keysym == XK_dead_cedilla
6556 #endif
6557 #ifdef XK_dead_breve
6558 || orig_keysym == XK_dead_breve
6559 #endif
6560 #ifdef XK_dead_ogonek
6561 || orig_keysym == XK_dead_ogonek
6562 #endif
6563 #ifdef XK_dead_caron
6564 || orig_keysym == XK_dead_caron
6565 #endif
6566 #ifdef XK_dead_doubleacute
6567 || orig_keysym == XK_dead_doubleacute
6568 #endif
6569 #ifdef XK_dead_abovedot
6570 || orig_keysym == XK_dead_abovedot
6571 #endif
6572 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6573 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6574 /* Any "vendor-specific" key is ok. */
6575 || (orig_keysym & (1 << 28))
6576 || (keysym != NoSymbol && nbytes == 0))
6577 && ! (IsModifierKey (orig_keysym)
6578 /* The symbols from XK_ISO_Lock
6579 to XK_ISO_Last_Group_Lock
6580 don't have real modifiers but
6581 should be treated similarly to
6582 Mode_switch by Emacs. */
6583 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6584 || (XK_ISO_Lock <= orig_keysym
6585 && orig_keysym <= XK_ISO_Last_Group_Lock)
6586 #endif
6589 STORE_KEYSYM_FOR_DEBUG (keysym);
6590 /* make_lispy_event will convert this to a symbolic
6591 key. */
6592 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6593 inev.ie.code = keysym;
6594 goto done_keysym;
6597 { /* Raw bytes, not keysym. */
6598 ptrdiff_t i;
6599 int nchars, len;
6601 for (i = 0, nchars = 0; i < nbytes; i++)
6603 if (ASCII_BYTE_P (copy_bufptr[i]))
6604 nchars++;
6605 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6608 if (nchars < nbytes)
6610 /* Decode the input data. */
6612 /* The input should be decoded with `coding_system'
6613 which depends on which X*LookupString function
6614 we used just above and the locale. */
6615 setup_coding_system (coding_system, &coding);
6616 coding.src_multibyte = 0;
6617 coding.dst_multibyte = 1;
6618 /* The input is converted to events, thus we can't
6619 handle composition. Anyway, there's no XIM that
6620 gives us composition information. */
6621 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6623 SAFE_NALLOCA (coding.destination, MAX_MULTIBYTE_LENGTH,
6624 nbytes);
6625 coding.dst_bytes = MAX_MULTIBYTE_LENGTH * nbytes;
6626 coding.mode |= CODING_MODE_LAST_BLOCK;
6627 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6628 nbytes = coding.produced;
6629 nchars = coding.produced_char;
6630 copy_bufptr = coding.destination;
6633 /* Convert the input data to a sequence of
6634 character events. */
6635 for (i = 0; i < nbytes; i += len)
6637 int ch;
6638 if (nchars == nbytes)
6639 ch = copy_bufptr[i], len = 1;
6640 else
6641 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6642 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
6643 ? ASCII_KEYSTROKE_EVENT
6644 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6645 inev.ie.code = ch;
6646 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6649 count += nchars;
6651 inev.ie.kind = NO_EVENT; /* Already stored above. */
6653 if (keysym == NoSymbol)
6654 break;
6657 done_keysym:
6658 #ifdef HAVE_X_I18N
6659 /* Don't dispatch this event since XtDispatchEvent calls
6660 XFilterEvent, and two calls in a row may freeze the
6661 client. */
6662 break;
6663 #else
6664 goto OTHER;
6665 #endif
6667 case KeyRelease:
6668 last_user_time = event.xkey.time;
6669 #ifdef HAVE_X_I18N
6670 /* Don't dispatch this event since XtDispatchEvent calls
6671 XFilterEvent, and two calls in a row may freeze the
6672 client. */
6673 break;
6674 #else
6675 goto OTHER;
6676 #endif
6678 case EnterNotify:
6679 last_user_time = event.xcrossing.time;
6680 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6682 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6684 if (f && x_mouse_click_focus_ignore_position)
6685 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6687 /* EnterNotify counts as mouse movement,
6688 so update things that depend on mouse position. */
6689 if (f && !f->output_data.x->hourglass_p)
6690 note_mouse_movement (f, &event.xmotion);
6691 #ifdef USE_GTK
6692 /* We may get an EnterNotify on the buttons in the toolbar. In that
6693 case we moved out of any highlighted area and need to note this. */
6694 if (!f && last_mouse_glyph_frame)
6695 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6696 #endif
6697 goto OTHER;
6699 case FocusIn:
6700 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6701 goto OTHER;
6703 case LeaveNotify:
6704 last_user_time = event.xcrossing.time;
6705 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6707 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6708 if (f)
6710 if (f == hlinfo->mouse_face_mouse_frame)
6712 /* If we move outside the frame, then we're
6713 certainly no longer on any text in the frame. */
6714 clear_mouse_face (hlinfo);
6715 hlinfo->mouse_face_mouse_frame = 0;
6718 /* Generate a nil HELP_EVENT to cancel a help-echo.
6719 Do it only if there's something to cancel.
6720 Otherwise, the startup message is cleared when
6721 the mouse leaves the frame. */
6722 if (any_help_event_p)
6723 do_help = -1;
6725 #ifdef USE_GTK
6726 /* See comment in EnterNotify above */
6727 else if (last_mouse_glyph_frame)
6728 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6729 #endif
6730 goto OTHER;
6732 case FocusOut:
6733 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6734 goto OTHER;
6736 case MotionNotify:
6738 last_user_time = event.xmotion.time;
6739 previous_help_echo_string = help_echo_string;
6740 help_echo_string = Qnil;
6742 if (dpyinfo->grabbed && last_mouse_frame
6743 && FRAME_LIVE_P (last_mouse_frame))
6744 f = last_mouse_frame;
6745 else
6746 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6748 if (hlinfo->mouse_face_hidden)
6750 hlinfo->mouse_face_hidden = 0;
6751 clear_mouse_face (hlinfo);
6754 #ifdef USE_GTK
6755 if (f && xg_event_is_for_scrollbar (f, &event))
6756 f = 0;
6757 #endif
6758 if (f)
6761 /* Generate SELECT_WINDOW_EVENTs when needed.
6762 Don't let popup menus influence things (bug#1261). */
6763 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6765 Lisp_Object window;
6767 window = window_from_coordinates (f,
6768 event.xmotion.x, event.xmotion.y,
6769 0, 0);
6771 /* Window will be selected only when it is not selected now and
6772 last mouse movement event was not in it. Minibuffer window
6773 will be selected only when it is active. */
6774 if (WINDOWP (window)
6775 && !EQ (window, last_window)
6776 && !EQ (window, selected_window)
6777 /* For click-to-focus window managers
6778 create event iff we don't leave the
6779 selected frame. */
6780 && (focus_follows_mouse
6781 || (EQ (XWINDOW (window)->frame,
6782 XWINDOW (selected_window)->frame))))
6784 inev.ie.kind = SELECT_WINDOW_EVENT;
6785 inev.ie.frame_or_window = window;
6788 last_window=window;
6790 if (!note_mouse_movement (f, &event.xmotion))
6791 help_echo_string = previous_help_echo_string;
6793 else
6795 #ifndef USE_TOOLKIT_SCROLL_BARS
6796 struct scroll_bar *bar
6797 = x_window_to_scroll_bar (event.xmotion.display,
6798 event.xmotion.window);
6800 if (bar)
6801 x_scroll_bar_note_movement (bar, &event);
6802 #endif /* USE_TOOLKIT_SCROLL_BARS */
6804 /* If we move outside the frame, then we're
6805 certainly no longer on any text in the frame. */
6806 clear_mouse_face (hlinfo);
6809 /* If the contents of the global variable help_echo_string
6810 has changed, generate a HELP_EVENT. */
6811 if (!NILP (help_echo_string)
6812 || !NILP (previous_help_echo_string))
6813 do_help = 1;
6814 goto OTHER;
6817 case ConfigureNotify:
6818 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6819 #ifdef USE_GTK
6820 if (!f
6821 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6822 && event.xconfigure.window == FRAME_X_WINDOW (f))
6824 xg_frame_resized (f, event.xconfigure.width,
6825 event.xconfigure.height);
6826 f = 0;
6828 #endif
6829 if (f)
6831 #ifndef USE_X_TOOLKIT
6832 #ifndef USE_GTK
6833 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6834 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6836 /* In the toolkit version, change_frame_size
6837 is called by the code that handles resizing
6838 of the EmacsFrame widget. */
6840 /* Even if the number of character rows and columns has
6841 not changed, the font size may have changed, so we need
6842 to check the pixel dimensions as well. */
6843 if (columns != FRAME_COLS (f)
6844 || rows != FRAME_LINES (f)
6845 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6846 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6848 change_frame_size (f, rows, columns, 0, 1, 0);
6849 SET_FRAME_GARBAGED (f);
6850 cancel_mouse_face (f);
6853 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6854 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6855 #endif /* not USE_GTK */
6856 #endif
6858 #ifdef USE_GTK
6859 /* GTK creates windows but doesn't map them.
6860 Only get real positions when mapped. */
6861 if (FRAME_GTK_OUTER_WIDGET (f)
6862 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6863 #endif
6865 x_real_positions (f, &f->left_pos, &f->top_pos);
6868 #ifdef HAVE_X_I18N
6869 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6870 xic_set_statusarea (f);
6871 #endif
6874 goto OTHER;
6876 case ButtonRelease:
6877 case ButtonPress:
6879 /* If we decide we want to generate an event to be seen
6880 by the rest of Emacs, we put it here. */
6881 int tool_bar_p = 0;
6883 memset (&compose_status, 0, sizeof (compose_status));
6884 last_mouse_glyph_frame = 0;
6885 last_user_time = event.xbutton.time;
6887 if (dpyinfo->grabbed
6888 && last_mouse_frame
6889 && FRAME_LIVE_P (last_mouse_frame))
6890 f = last_mouse_frame;
6891 else
6892 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6894 #ifdef USE_GTK
6895 if (f && xg_event_is_for_scrollbar (f, &event))
6896 f = 0;
6897 #endif
6898 if (f)
6900 /* Is this in the tool-bar? */
6901 if (WINDOWP (f->tool_bar_window)
6902 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6904 Lisp_Object window;
6905 int x = event.xbutton.x;
6906 int y = event.xbutton.y;
6908 window = window_from_coordinates (f, x, y, 0, 1);
6909 tool_bar_p = EQ (window, f->tool_bar_window);
6911 if (tool_bar_p && event.xbutton.button < 4)
6913 handle_tool_bar_click (f, x, y,
6914 event.xbutton.type == ButtonPress,
6915 x_x_to_emacs_modifiers (dpyinfo,
6916 event.xbutton.state));
6920 if (!tool_bar_p)
6921 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6922 if (! popup_activated ())
6923 #endif
6925 if (ignore_next_mouse_click_timeout)
6927 if (event.type == ButtonPress
6928 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6930 ignore_next_mouse_click_timeout = 0;
6931 construct_mouse_click (&inev.ie, &event.xbutton, f);
6933 if (event.type == ButtonRelease)
6934 ignore_next_mouse_click_timeout = 0;
6936 else
6937 construct_mouse_click (&inev.ie, &event.xbutton, f);
6939 if (FRAME_X_EMBEDDED_P (f))
6940 xembed_send_message (f, event.xbutton.time,
6941 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6943 else
6945 struct scroll_bar *bar
6946 = x_window_to_scroll_bar (event.xbutton.display,
6947 event.xbutton.window);
6949 #ifdef USE_TOOLKIT_SCROLL_BARS
6950 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6951 scroll bars. */
6952 if (bar && event.xbutton.state & ControlMask)
6954 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6955 *finish = X_EVENT_DROP;
6957 #else /* not USE_TOOLKIT_SCROLL_BARS */
6958 if (bar)
6959 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6960 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6963 if (event.type == ButtonPress)
6965 dpyinfo->grabbed |= (1 << event.xbutton.button);
6966 last_mouse_frame = f;
6968 if (!tool_bar_p)
6969 last_tool_bar_item = -1;
6971 else
6972 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6974 /* Ignore any mouse motion that happened before this event;
6975 any subsequent mouse-movement Emacs events should reflect
6976 only motion after the ButtonPress/Release. */
6977 if (f != 0)
6978 f->mouse_moved = 0;
6980 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6981 f = x_menubar_window_to_frame (dpyinfo, &event);
6982 /* For a down-event in the menu bar,
6983 don't pass it to Xt right now.
6984 Instead, save it away
6985 and we will pass it to Xt from kbd_buffer_get_event.
6986 That way, we can run some Lisp code first. */
6987 if (! popup_activated ()
6988 #ifdef USE_GTK
6989 /* Gtk+ menus only react to the first three buttons. */
6990 && event.xbutton.button < 3
6991 #endif
6992 && f && event.type == ButtonPress
6993 /* Verify the event is really within the menu bar
6994 and not just sent to it due to grabbing. */
6995 && event.xbutton.x >= 0
6996 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6997 && event.xbutton.y >= 0
6998 && event.xbutton.y < f->output_data.x->menubar_height
6999 && event.xbutton.same_screen)
7001 SET_SAVED_BUTTON_EVENT;
7002 XSETFRAME (last_mouse_press_frame, f);
7003 *finish = X_EVENT_DROP;
7005 else if (event.type == ButtonPress)
7007 last_mouse_press_frame = Qnil;
7008 goto OTHER;
7010 else
7011 goto OTHER;
7012 #endif /* USE_X_TOOLKIT || USE_GTK */
7014 break;
7016 case CirculateNotify:
7017 goto OTHER;
7019 case CirculateRequest:
7020 goto OTHER;
7022 case VisibilityNotify:
7023 goto OTHER;
7025 case MappingNotify:
7026 /* Someone has changed the keyboard mapping - update the
7027 local cache. */
7028 switch (event.xmapping.request)
7030 case MappingModifier:
7031 x_find_modifier_meanings (dpyinfo);
7032 /* This is meant to fall through. */
7033 case MappingKeyboard:
7034 XRefreshKeyboardMapping (&event.xmapping);
7036 goto OTHER;
7038 case DestroyNotify:
7039 xft_settings_event (dpyinfo, &event);
7040 break;
7042 default:
7043 OTHER:
7044 #ifdef USE_X_TOOLKIT
7045 block_input ();
7046 if (*finish != X_EVENT_DROP)
7047 XtDispatchEvent (&event);
7048 unblock_input ();
7049 #endif /* USE_X_TOOLKIT */
7050 break;
7053 done:
7054 if (inev.ie.kind != NO_EVENT)
7056 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7057 count++;
7060 if (do_help
7061 && !(hold_quit && hold_quit->kind != NO_EVENT))
7063 Lisp_Object frame;
7065 if (f)
7066 XSETFRAME (frame, f);
7067 else
7068 frame = Qnil;
7070 if (do_help > 0)
7072 any_help_event_p = 1;
7073 gen_help_event (help_echo_string, frame, help_echo_window,
7074 help_echo_object, help_echo_pos);
7076 else
7078 help_echo_string = Qnil;
7079 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7081 count++;
7084 SAFE_FREE ();
7085 *eventptr = event;
7086 return count;
7089 #if defined USE_GTK || defined USE_X_TOOLKIT
7091 /* Handles the XEvent EVENT on display DISPLAY.
7092 This is used for event loops outside the normal event handling,
7093 i.e. looping while a popup menu or a dialog is posted.
7095 Returns the value handle_one_xevent sets in the finish argument. */
7097 x_dispatch_event (XEvent *event, Display *display)
7099 struct x_display_info *dpyinfo;
7100 int finish = X_EVENT_NORMAL;
7102 dpyinfo = x_display_info_for_display (display);
7104 if (dpyinfo)
7105 handle_one_xevent (dpyinfo, event, &finish, 0);
7107 return finish;
7109 #endif
7112 /* Read events coming from the X server.
7113 Return as soon as there are no more events to be read.
7115 Return the number of characters stored into the buffer,
7116 thus pretending to be `read' (except the characters we store
7117 in the keyboard buffer can be multibyte, so are not necessarily
7118 C chars). */
7120 static int
7121 XTread_socket (struct terminal *terminal, struct input_event *hold_quit)
7123 int count = 0;
7124 int event_found = 0;
7126 block_input ();
7128 /* So people can tell when we have read the available input. */
7129 input_signal_count++;
7131 /* For debugging, this gives a way to fake an I/O error. */
7132 if (terminal->display_info.x == XTread_socket_fake_io_error)
7134 XTread_socket_fake_io_error = 0;
7135 x_io_error_quitter (terminal->display_info.x->display);
7138 #ifndef USE_GTK
7139 while (XPending (terminal->display_info.x->display))
7141 int finish;
7142 XEvent event;
7144 XNextEvent (terminal->display_info.x->display, &event);
7146 #ifdef HAVE_X_I18N
7147 /* Filter events for the current X input method. */
7148 if (x_filter_event (terminal->display_info.x, &event))
7149 continue;
7150 #endif
7151 event_found = 1;
7153 count += handle_one_xevent (terminal->display_info.x,
7154 &event, &finish, hold_quit);
7156 if (finish == X_EVENT_GOTO_OUT)
7157 goto out;
7160 out:;
7162 #else /* USE_GTK */
7164 /* For GTK we must use the GTK event loop. But XEvents gets passed
7165 to our filter function above, and then to the big event switch.
7166 We use a bunch of globals to communicate with our filter function,
7167 that is kind of ugly, but it works.
7169 There is no way to do one display at the time, GTK just does events
7170 from all displays. */
7172 while (gtk_events_pending ())
7174 current_count = count;
7175 current_hold_quit = hold_quit;
7177 gtk_main_iteration ();
7179 count = current_count;
7180 current_count = -1;
7181 current_hold_quit = 0;
7183 if (current_finish == X_EVENT_GOTO_OUT)
7184 break;
7186 #endif /* USE_GTK */
7188 /* On some systems, an X bug causes Emacs to get no more events
7189 when the window is destroyed. Detect that. (1994.) */
7190 if (! event_found)
7192 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7193 One XNOOP in 100 loops will make Emacs terminate.
7194 B. Bretthauer, 1994 */
7195 x_noop_count++;
7196 if (x_noop_count >= 100)
7198 x_noop_count=0;
7200 if (next_noop_dpyinfo == 0)
7201 next_noop_dpyinfo = x_display_list;
7203 XNoOp (next_noop_dpyinfo->display);
7205 /* Each time we get here, cycle through the displays now open. */
7206 next_noop_dpyinfo = next_noop_dpyinfo->next;
7210 /* If the focus was just given to an auto-raising frame,
7211 raise it now. */
7212 /* ??? This ought to be able to handle more than one such frame. */
7213 if (pending_autoraise_frame)
7215 x_raise_frame (pending_autoraise_frame);
7216 pending_autoraise_frame = 0;
7219 unblock_input ();
7221 return count;
7227 /***********************************************************************
7228 Text Cursor
7229 ***********************************************************************/
7231 /* Set clipping for output in glyph row ROW. W is the window in which
7232 we operate. GC is the graphics context to set clipping in.
7234 ROW may be a text row or, e.g., a mode line. Text rows must be
7235 clipped to the interior of the window dedicated to text display,
7236 mode lines must be clipped to the whole window. */
7238 static void
7239 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7241 struct frame *f = XFRAME (WINDOW_FRAME (w));
7242 XRectangle clip_rect;
7243 int window_x, window_y, window_width;
7245 window_box (w, area, &window_x, &window_y, &window_width, 0);
7247 clip_rect.x = window_x;
7248 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7249 clip_rect.y = max (clip_rect.y, window_y);
7250 clip_rect.width = window_width;
7251 clip_rect.height = row->visible_height;
7253 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7257 /* Draw a hollow box cursor on window W in glyph row ROW. */
7259 static void
7260 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7262 struct frame *f = XFRAME (WINDOW_FRAME (w));
7263 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7264 Display *dpy = FRAME_X_DISPLAY (f);
7265 int x, y, wd, h;
7266 XGCValues xgcv;
7267 struct glyph *cursor_glyph;
7268 GC gc;
7270 /* Get the glyph the cursor is on. If we can't tell because
7271 the current matrix is invalid or such, give up. */
7272 cursor_glyph = get_phys_cursor_glyph (w);
7273 if (cursor_glyph == NULL)
7274 return;
7276 /* Compute frame-relative coordinates for phys cursor. */
7277 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7278 wd = w->phys_cursor_width;
7280 /* The foreground of cursor_gc is typically the same as the normal
7281 background color, which can cause the cursor box to be invisible. */
7282 xgcv.foreground = f->output_data.x->cursor_pixel;
7283 if (dpyinfo->scratch_cursor_gc)
7284 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7285 else
7286 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7287 GCForeground, &xgcv);
7288 gc = dpyinfo->scratch_cursor_gc;
7290 /* Set clipping, draw the rectangle, and reset clipping again. */
7291 x_clip_to_row (w, row, TEXT_AREA, gc);
7292 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7293 XSetClipMask (dpy, gc, None);
7297 /* Draw a bar cursor on window W in glyph row ROW.
7299 Implementation note: One would like to draw a bar cursor with an
7300 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7301 Unfortunately, I didn't find a font yet that has this property set.
7302 --gerd. */
7304 static void
7305 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7307 struct frame *f = XFRAME (w->frame);
7308 struct glyph *cursor_glyph;
7310 /* If cursor is out of bounds, don't draw garbage. This can happen
7311 in mini-buffer windows when switching between echo area glyphs
7312 and mini-buffer. */
7313 cursor_glyph = get_phys_cursor_glyph (w);
7314 if (cursor_glyph == NULL)
7315 return;
7317 /* If on an image, draw like a normal cursor. That's usually better
7318 visible than drawing a bar, esp. if the image is large so that
7319 the bar might not be in the window. */
7320 if (cursor_glyph->type == IMAGE_GLYPH)
7322 struct glyph_row *r;
7323 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7324 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
7326 else
7328 Display *dpy = FRAME_X_DISPLAY (f);
7329 Window window = FRAME_X_WINDOW (f);
7330 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7331 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7332 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7333 XGCValues xgcv;
7335 /* If the glyph's background equals the color we normally draw
7336 the bars cursor in, the bar cursor in its normal color is
7337 invisible. Use the glyph's foreground color instead in this
7338 case, on the assumption that the glyph's colors are chosen so
7339 that the glyph is legible. */
7340 if (face->background == f->output_data.x->cursor_pixel)
7341 xgcv.background = xgcv.foreground = face->foreground;
7342 else
7343 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7344 xgcv.graphics_exposures = 0;
7346 if (gc)
7347 XChangeGC (dpy, gc, mask, &xgcv);
7348 else
7350 gc = XCreateGC (dpy, window, mask, &xgcv);
7351 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7354 x_clip_to_row (w, row, TEXT_AREA, gc);
7356 if (kind == BAR_CURSOR)
7358 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7360 if (width < 0)
7361 width = FRAME_CURSOR_WIDTH (f);
7362 width = min (cursor_glyph->pixel_width, width);
7364 w->phys_cursor_width = width;
7366 /* If the character under cursor is R2L, draw the bar cursor
7367 on the right of its glyph, rather than on the left. */
7368 if ((cursor_glyph->resolved_level & 1) != 0)
7369 x += cursor_glyph->pixel_width - width;
7371 XFillRectangle (dpy, window, gc, x,
7372 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7373 width, row->height);
7375 else
7377 int dummy_x, dummy_y, dummy_h;
7379 if (width < 0)
7380 width = row->height;
7382 width = min (row->height, width);
7384 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7385 &dummy_y, &dummy_h);
7387 XFillRectangle (dpy, window, gc,
7388 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7389 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7390 row->height - width),
7391 w->phys_cursor_width, width);
7394 XSetClipMask (dpy, gc, None);
7399 /* RIF: Define cursor CURSOR on frame F. */
7401 static void
7402 x_define_frame_cursor (struct frame *f, Cursor cursor)
7404 if (!f->pointer_invisible
7405 && f->output_data.x->current_cursor != cursor)
7406 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7407 f->output_data.x->current_cursor = cursor;
7411 /* RIF: Clear area on frame F. */
7413 static void
7414 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7416 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7417 x, y, width, height, False);
7418 #ifdef USE_GTK
7419 /* Must queue a redraw, because scroll bars might have been cleared. */
7420 if (FRAME_GTK_WIDGET (f))
7421 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7422 #endif
7426 /* RIF: Draw cursor on window W. */
7428 static void
7429 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)
7431 struct frame *f = XFRAME (WINDOW_FRAME (w));
7433 if (on_p)
7435 w->phys_cursor_type = cursor_type;
7436 w->phys_cursor_on_p = 1;
7438 if (glyph_row->exact_window_width_line_p
7439 && (glyph_row->reversed_p
7440 ? (w->phys_cursor.hpos < 0)
7441 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7443 glyph_row->cursor_in_fringe_p = 1;
7444 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7446 else
7448 switch (cursor_type)
7450 case HOLLOW_BOX_CURSOR:
7451 x_draw_hollow_cursor (w, glyph_row);
7452 break;
7454 case FILLED_BOX_CURSOR:
7455 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7456 break;
7458 case BAR_CURSOR:
7459 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7460 break;
7462 case HBAR_CURSOR:
7463 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7464 break;
7466 case NO_CURSOR:
7467 w->phys_cursor_width = 0;
7468 break;
7470 default:
7471 emacs_abort ();
7475 #ifdef HAVE_X_I18N
7476 if (w == XWINDOW (f->selected_window))
7477 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7478 xic_set_preeditarea (w, x, y);
7479 #endif
7482 #ifndef XFlush
7483 XFlush (FRAME_X_DISPLAY (f));
7484 #endif
7488 /* Icons. */
7490 /* Make the x-window of frame F use the gnu icon bitmap. */
7493 x_bitmap_icon (struct frame *f, Lisp_Object file)
7495 ptrdiff_t bitmap_id;
7497 if (FRAME_X_WINDOW (f) == 0)
7498 return 1;
7500 /* Free up our existing icon bitmap and mask if any. */
7501 if (f->output_data.x->icon_bitmap > 0)
7502 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7503 f->output_data.x->icon_bitmap = 0;
7505 if (STRINGP (file))
7507 #ifdef USE_GTK
7508 /* Use gtk_window_set_icon_from_file () if available,
7509 It's not restricted to bitmaps */
7510 if (xg_set_icon (f, file))
7511 return 0;
7512 #endif /* USE_GTK */
7513 bitmap_id = x_create_bitmap_from_file (f, file);
7514 x_create_bitmap_mask (f, bitmap_id);
7516 else
7518 /* Create the GNU bitmap and mask if necessary. */
7519 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7521 ptrdiff_t rc = -1;
7523 #ifdef USE_GTK
7525 if (xg_set_icon (f, xg_default_icon_file)
7526 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7527 return 0;
7529 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7531 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7532 if (rc != -1)
7533 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7535 #endif
7537 /* If all else fails, use the (black and white) xbm image. */
7538 if (rc == -1)
7540 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
7541 gnu_xbm_width, gnu_xbm_height);
7542 if (rc == -1)
7543 return 1;
7545 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7546 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7550 /* The first time we create the GNU bitmap and mask,
7551 this increments the ref-count one extra time.
7552 As a result, the GNU bitmap and mask are never freed.
7553 That way, we don't have to worry about allocating it again. */
7554 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7556 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7559 x_wm_set_icon_pixmap (f, bitmap_id);
7560 f->output_data.x->icon_bitmap = bitmap_id;
7562 return 0;
7566 /* Make the x-window of frame F use a rectangle with text.
7567 Use ICON_NAME as the text. */
7570 x_text_icon (struct frame *f, const char *icon_name)
7572 if (FRAME_X_WINDOW (f) == 0)
7573 return 1;
7576 XTextProperty text;
7577 text.value = (unsigned char *) icon_name;
7578 text.encoding = XA_STRING;
7579 text.format = 8;
7580 text.nitems = strlen (icon_name);
7581 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7584 if (f->output_data.x->icon_bitmap > 0)
7585 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7586 f->output_data.x->icon_bitmap = 0;
7587 x_wm_set_icon_pixmap (f, 0);
7589 return 0;
7592 #define X_ERROR_MESSAGE_SIZE 200
7594 /* If non-nil, this should be a string.
7595 It means catch X errors and store the error message in this string.
7597 The reason we use a stack is that x_catch_error/x_uncatch_error can
7598 be called from a signal handler.
7601 struct x_error_message_stack {
7602 char string[X_ERROR_MESSAGE_SIZE];
7603 Display *dpy;
7604 struct x_error_message_stack *prev;
7606 static struct x_error_message_stack *x_error_message;
7608 /* An X error handler which stores the error message in
7609 *x_error_message. This is called from x_error_handler if
7610 x_catch_errors is in effect. */
7612 static void
7613 x_error_catcher (Display *display, XErrorEvent *event)
7615 XGetErrorText (display, event->error_code,
7616 x_error_message->string,
7617 X_ERROR_MESSAGE_SIZE);
7620 /* Begin trapping X errors for display DPY. Actually we trap X errors
7621 for all displays, but DPY should be the display you are actually
7622 operating on.
7624 After calling this function, X protocol errors no longer cause
7625 Emacs to exit; instead, they are recorded in the string
7626 stored in *x_error_message.
7628 Calling x_check_errors signals an Emacs error if an X error has
7629 occurred since the last call to x_catch_errors or x_check_errors.
7631 Calling x_uncatch_errors resumes the normal error handling. */
7633 void
7634 x_catch_errors (Display *dpy)
7636 struct x_error_message_stack *data = xmalloc (sizeof *data);
7638 /* Make sure any errors from previous requests have been dealt with. */
7639 XSync (dpy, False);
7641 data->dpy = dpy;
7642 data->string[0] = 0;
7643 data->prev = x_error_message;
7644 x_error_message = data;
7647 /* Undo the last x_catch_errors call.
7648 DPY should be the display that was passed to x_catch_errors. */
7650 void
7651 x_uncatch_errors (void)
7653 struct x_error_message_stack *tmp;
7655 block_input ();
7657 /* The display may have been closed before this function is called.
7658 Check if it is still open before calling XSync. */
7659 if (x_display_info_for_display (x_error_message->dpy) != 0)
7660 XSync (x_error_message->dpy, False);
7662 tmp = x_error_message;
7663 x_error_message = x_error_message->prev;
7664 xfree (tmp);
7665 unblock_input ();
7668 /* If any X protocol errors have arrived since the last call to
7669 x_catch_errors or x_check_errors, signal an Emacs error using
7670 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7672 void
7673 x_check_errors (Display *dpy, const char *format)
7675 /* Make sure to catch any errors incurred so far. */
7676 XSync (dpy, False);
7678 if (x_error_message->string[0])
7680 char string[X_ERROR_MESSAGE_SIZE];
7681 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7682 x_uncatch_errors ();
7683 error (format, string);
7687 /* Nonzero if we had any X protocol errors
7688 since we did x_catch_errors on DPY. */
7691 x_had_errors_p (Display *dpy)
7693 /* Make sure to catch any errors incurred so far. */
7694 XSync (dpy, False);
7696 return x_error_message->string[0] != 0;
7699 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7701 void
7702 x_clear_errors (Display *dpy)
7704 x_error_message->string[0] = 0;
7707 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7708 * idea. --lorentey */
7709 /* Close off all unclosed x_catch_errors calls. */
7711 void
7712 x_fully_uncatch_errors (void)
7714 while (x_error_message)
7715 x_uncatch_errors ();
7717 #endif
7719 #if 0
7720 static unsigned int x_wire_count;
7721 x_trace_wire (void)
7723 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7725 #endif /* ! 0 */
7728 /************************************************************************
7729 Handling X errors
7730 ************************************************************************/
7732 /* Error message passed to x_connection_closed. */
7734 static char *error_msg;
7736 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7737 the text of an error message that lead to the connection loss. */
7739 static void
7740 x_connection_closed (Display *dpy, const char *error_message)
7742 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7743 Lisp_Object frame, tail;
7744 ptrdiff_t idx = SPECPDL_INDEX ();
7746 error_msg = alloca (strlen (error_message) + 1);
7747 strcpy (error_msg, error_message);
7749 /* Inhibit redisplay while frames are being deleted. */
7750 specbind (Qinhibit_redisplay, Qt);
7752 if (dpyinfo)
7754 /* Protect display from being closed when we delete the last
7755 frame on it. */
7756 dpyinfo->reference_count++;
7757 dpyinfo->terminal->reference_count++;
7760 /* First delete frames whose mini-buffers are on frames
7761 that are on the dead display. */
7762 FOR_EACH_FRAME (tail, frame)
7764 Lisp_Object minibuf_frame;
7765 minibuf_frame
7766 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7767 if (FRAME_X_P (XFRAME (frame))
7768 && FRAME_X_P (XFRAME (minibuf_frame))
7769 && ! EQ (frame, minibuf_frame)
7770 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7771 delete_frame (frame, Qnoelisp);
7774 /* Now delete all remaining frames on the dead display.
7775 We are now sure none of these is used as the mini-buffer
7776 for another frame that we need to delete. */
7777 FOR_EACH_FRAME (tail, frame)
7778 if (FRAME_X_P (XFRAME (frame))
7779 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7781 /* Set this to t so that delete_frame won't get confused
7782 trying to find a replacement. */
7783 kset_default_minibuffer_frame (FRAME_KBOARD (XFRAME (frame)), Qt);
7784 delete_frame (frame, Qnoelisp);
7787 /* If DPYINFO is null, this means we didn't open the display in the
7788 first place, so don't try to close it. */
7789 if (dpyinfo)
7791 /* We can not call XtCloseDisplay here because it calls XSync.
7792 XSync inside the error handler apparently hangs Emacs. On
7793 current Xt versions, this isn't needed either. */
7794 #ifdef USE_GTK
7795 /* A long-standing GTK bug prevents proper disconnect handling
7796 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7797 the resulting Glib error message loop filled a user's disk.
7798 To avoid this, kill Emacs unconditionally on disconnect. */
7799 shut_down_emacs (0, Qnil);
7800 fprintf (stderr, "%s\n\
7801 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7802 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7803 For details, see etc/PROBLEMS.\n",
7804 error_msg);
7805 emacs_abort ();
7806 #endif /* USE_GTK */
7808 /* Indicate that this display is dead. */
7809 dpyinfo->display = 0;
7811 dpyinfo->reference_count--;
7812 dpyinfo->terminal->reference_count--;
7813 if (dpyinfo->reference_count != 0)
7814 /* We have just closed all frames on this display. */
7815 emacs_abort ();
7818 Lisp_Object tmp;
7819 XSETTERMINAL (tmp, dpyinfo->terminal);
7820 Fdelete_terminal (tmp, Qnoelisp);
7824 if (terminal_list == 0)
7826 fprintf (stderr, "%s\n", error_msg);
7827 Fkill_emacs (make_number (70));
7828 /* NOTREACHED */
7831 totally_unblock_input ();
7833 unbind_to (idx, Qnil);
7834 clear_waiting_for_input ();
7836 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
7837 IF_LINT (if (! terminal_list) return; )
7839 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7840 longjmp), because returning from this function would get us back into
7841 Xlib's code which will directly call `exit'. */
7842 error ("%s", error_msg);
7845 /* We specifically use it before defining it, so that gcc doesn't inline it,
7846 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7847 static void x_error_quitter (Display *, XErrorEvent *);
7849 /* This is the first-level handler for X protocol errors.
7850 It calls x_error_quitter or x_error_catcher. */
7852 static int
7853 x_error_handler (Display *display, XErrorEvent *event)
7855 #ifdef HAVE_GTK3
7856 if (event->error_code == BadMatch
7857 && event->request_code == X_SetInputFocus
7858 && event->minor_code == 0)
7860 return 0;
7862 #endif
7864 if (x_error_message)
7865 x_error_catcher (display, event);
7866 else
7867 x_error_quitter (display, event);
7868 return 0;
7871 /* This is the usual handler for X protocol errors.
7872 It kills all frames on the display that we got the error for.
7873 If that was the only one, it prints an error message and kills Emacs. */
7875 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7877 /* On older GCC versions, just putting x_error_quitter
7878 after x_error_handler prevents inlining into the former. */
7880 static void NO_INLINE
7881 x_error_quitter (Display *display, XErrorEvent *event)
7883 char buf[256], buf1[356];
7885 /* Ignore BadName errors. They can happen because of fonts
7886 or colors that are not defined. */
7888 if (event->error_code == BadName)
7889 return;
7891 /* Note that there is no real way portable across R3/R4 to get the
7892 original error handler. */
7894 XGetErrorText (display, event->error_code, buf, sizeof (buf));
7895 sprintf (buf1, "X protocol error: %s on protocol request %d",
7896 buf, event->request_code);
7897 x_connection_closed (display, buf1);
7901 /* This is the handler for X IO errors, always.
7902 It kills all frames on the display that we lost touch with.
7903 If that was the only one, it prints an error message and kills Emacs. */
7905 static int
7906 x_io_error_quitter (Display *display)
7908 char buf[256];
7910 snprintf (buf, sizeof buf, "Connection lost to X server `%s'",
7911 DisplayString (display));
7912 x_connection_closed (display, buf);
7913 return 0;
7916 /* Changing the font of the frame. */
7918 /* Give frame F the font FONT-OBJECT as its default font. The return
7919 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7920 frame. If it is negative, generate a new fontset from
7921 FONT-OBJECT. */
7923 Lisp_Object
7924 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7926 struct font *font = XFONT_OBJECT (font_object);
7928 if (fontset < 0)
7929 fontset = fontset_from_font (font_object);
7930 FRAME_FONTSET (f) = fontset;
7931 if (FRAME_FONT (f) == font)
7932 /* This font is already set in frame F. There's nothing more to
7933 do. */
7934 return font_object;
7936 FRAME_FONT (f) = font;
7937 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7938 FRAME_COLUMN_WIDTH (f) = font->average_width;
7939 FRAME_SPACE_WIDTH (f) = font->space_width;
7940 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7942 compute_fringe_widths (f, 1);
7944 /* Compute the scroll bar width in character columns. */
7945 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7947 int wid = FRAME_COLUMN_WIDTH (f);
7948 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7949 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7951 else
7953 int wid = FRAME_COLUMN_WIDTH (f);
7954 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7957 if (FRAME_X_WINDOW (f) != 0)
7959 /* Don't change the size of a tip frame; there's no point in
7960 doing it because it's done in Fx_show_tip, and it leads to
7961 problems because the tip frame has no widget. */
7962 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7963 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7966 #ifdef HAVE_X_I18N
7967 if (FRAME_XIC (f)
7968 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7970 block_input ();
7971 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7972 unblock_input ();
7974 #endif
7976 return font_object;
7980 /***********************************************************************
7981 X Input Methods
7982 ***********************************************************************/
7984 #ifdef HAVE_X_I18N
7986 #ifdef HAVE_X11R6
7988 /* XIM destroy callback function, which is called whenever the
7989 connection to input method XIM dies. CLIENT_DATA contains a
7990 pointer to the x_display_info structure corresponding to XIM. */
7992 static void
7993 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7995 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7996 Lisp_Object frame, tail;
7998 block_input ();
8000 /* No need to call XDestroyIC.. */
8001 FOR_EACH_FRAME (tail, frame)
8003 struct frame *f = XFRAME (frame);
8004 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8006 FRAME_XIC (f) = NULL;
8007 xic_free_xfontset (f);
8011 /* No need to call XCloseIM. */
8012 dpyinfo->xim = NULL;
8013 XFree (dpyinfo->xim_styles);
8014 unblock_input ();
8017 #endif /* HAVE_X11R6 */
8019 #ifdef HAVE_X11R6
8020 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8021 extern char *XSetIMValues (XIM, ...);
8022 #endif
8024 /* Open the connection to the XIM server on display DPYINFO.
8025 RESOURCE_NAME is the resource name Emacs uses. */
8027 static void
8028 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
8030 XIM xim;
8032 #ifdef HAVE_XIM
8033 if (use_xim)
8035 if (dpyinfo->xim)
8036 XCloseIM (dpyinfo->xim);
8037 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8038 emacs_class);
8039 dpyinfo->xim = xim;
8041 if (xim)
8043 #ifdef HAVE_X11R6
8044 XIMCallback destroy;
8045 #endif
8047 /* Get supported styles and XIM values. */
8048 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8050 #ifdef HAVE_X11R6
8051 destroy.callback = xim_destroy_callback;
8052 destroy.client_data = (XPointer)dpyinfo;
8053 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8054 #endif
8058 else
8059 #endif /* HAVE_XIM */
8060 dpyinfo->xim = NULL;
8064 #ifdef HAVE_X11R6_XIM
8066 /* XIM instantiate callback function, which is called whenever an XIM
8067 server is available. DISPLAY is the display of the XIM.
8068 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8069 when the callback was registered. */
8071 static void
8072 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8074 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8075 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8077 /* We don't support multiple XIM connections. */
8078 if (dpyinfo->xim)
8079 return;
8081 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8083 /* Create XIC for the existing frames on the same display, as long
8084 as they have no XIC. */
8085 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8087 Lisp_Object tail, frame;
8089 block_input ();
8090 FOR_EACH_FRAME (tail, frame)
8092 struct frame *f = XFRAME (frame);
8094 if (FRAME_X_P (f)
8095 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8096 if (FRAME_XIC (f) == NULL)
8098 create_frame_xic (f);
8099 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8100 xic_set_statusarea (f);
8101 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8103 struct window *w = XWINDOW (f->selected_window);
8104 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8109 unblock_input ();
8113 #endif /* HAVE_X11R6_XIM */
8116 /* Open a connection to the XIM server on display DPYINFO.
8117 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8118 connection only at the first time. On X11R6, open the connection
8119 in the XIM instantiate callback function. */
8121 static void
8122 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8124 dpyinfo->xim = NULL;
8125 #ifdef HAVE_XIM
8126 if (use_xim)
8128 #ifdef HAVE_X11R6_XIM
8129 struct xim_inst_t *xim_inst = xmalloc (sizeof *xim_inst);
8130 ptrdiff_t len;
8132 dpyinfo->xim_callback_data = xim_inst;
8133 xim_inst->dpyinfo = dpyinfo;
8134 len = strlen (resource_name);
8135 xim_inst->resource_name = xmalloc (len + 1);
8136 memcpy (xim_inst->resource_name, resource_name, len + 1);
8137 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8138 resource_name, emacs_class,
8139 xim_instantiate_callback,
8140 /* This is XPointer in XFree86
8141 but (XPointer *) on Tru64, at
8142 least, hence the configure test. */
8143 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8144 #else /* not HAVE_X11R6_XIM */
8145 xim_open_dpy (dpyinfo, resource_name);
8146 #endif /* not HAVE_X11R6_XIM */
8148 #endif /* HAVE_XIM */
8152 /* Close the connection to the XIM server on display DPYINFO. */
8154 static void
8155 xim_close_dpy (struct x_display_info *dpyinfo)
8157 #ifdef HAVE_XIM
8158 if (use_xim)
8160 #ifdef HAVE_X11R6_XIM
8161 if (dpyinfo->display)
8162 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8163 NULL, emacs_class,
8164 xim_instantiate_callback, NULL);
8165 xfree (dpyinfo->xim_callback_data->resource_name);
8166 xfree (dpyinfo->xim_callback_data);
8167 #endif /* HAVE_X11R6_XIM */
8168 if (dpyinfo->display)
8169 XCloseIM (dpyinfo->xim);
8170 dpyinfo->xim = NULL;
8171 XFree (dpyinfo->xim_styles);
8173 #endif /* HAVE_XIM */
8176 #endif /* not HAVE_X11R6_XIM */
8180 /* Calculate the absolute position in frame F
8181 from its current recorded position values and gravity. */
8183 static void
8184 x_calc_absolute_position (struct frame *f)
8186 int flags = f->size_hint_flags;
8188 /* We have nothing to do if the current position
8189 is already for the top-left corner. */
8190 if (! ((flags & XNegative) || (flags & YNegative)))
8191 return;
8193 /* Treat negative positions as relative to the leftmost bottommost
8194 position that fits on the screen. */
8195 if (flags & XNegative)
8196 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8197 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8200 int height = FRAME_PIXEL_HEIGHT (f);
8202 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8203 /* Something is fishy here. When using Motif, starting Emacs with
8204 `-g -0-0', the frame appears too low by a few pixels.
8206 This seems to be so because initially, while Emacs is starting,
8207 the column widget's height and the frame's pixel height are
8208 different. The column widget's height is the right one. In
8209 later invocations, when Emacs is up, the frame's pixel height
8210 is right, though.
8212 It's not obvious where the initial small difference comes from.
8213 2000-12-01, gerd. */
8215 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8216 #endif
8218 if (flags & YNegative)
8219 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8220 - height + f->top_pos;
8223 /* The left_pos and top_pos
8224 are now relative to the top and left screen edges,
8225 so the flags should correspond. */
8226 f->size_hint_flags &= ~ (XNegative | YNegative);
8229 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8230 to really change the position, and 0 when calling from
8231 x_make_frame_visible (in that case, XOFF and YOFF are the current
8232 position values). It is -1 when calling from x_set_frame_parameters,
8233 which means, do adjust for borders but don't change the gravity. */
8235 void
8236 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8238 int modified_top, modified_left;
8240 if (change_gravity > 0)
8242 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8243 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8245 f->top_pos = yoff;
8246 f->left_pos = xoff;
8247 f->size_hint_flags &= ~ (XNegative | YNegative);
8248 if (xoff < 0)
8249 f->size_hint_flags |= XNegative;
8250 if (yoff < 0)
8251 f->size_hint_flags |= YNegative;
8252 f->win_gravity = NorthWestGravity;
8254 x_calc_absolute_position (f);
8256 block_input ();
8257 x_wm_set_size_hint (f, (long) 0, 0);
8259 modified_left = f->left_pos;
8260 modified_top = f->top_pos;
8262 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8264 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8265 than the WM decorations. So we use the calculated offset instead
8266 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8267 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8268 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8271 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8272 modified_left, modified_top);
8274 x_sync_with_move (f, f->left_pos, f->top_pos,
8275 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8276 ? 1 : 0);
8278 /* change_gravity is non-zero when this function is called from Lisp to
8279 programmatically move a frame. In that case, we call
8280 x_check_expected_move to discover if we have a "Type A" or "Type B"
8281 window manager, and, for a "Type A" window manager, adjust the position
8282 of the frame.
8284 We call x_check_expected_move if a programmatic move occurred, and
8285 either the window manager type (A/B) is unknown or it is Type A but we
8286 need to compute the top/left offset adjustment for this frame. */
8288 if (change_gravity != 0 &&
8289 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8290 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8291 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8292 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8293 x_check_expected_move (f, modified_left, modified_top);
8295 unblock_input ();
8298 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8299 on the root window for frame F contains ATOMNAME.
8300 This is how a WM check shall be done according to the Window Manager
8301 Specification/Extended Window Manager Hints at
8302 http://freedesktop.org/wiki/Specifications/wm-spec. */
8304 static int
8305 wm_supports (struct frame *f, Atom want_atom)
8307 Atom actual_type;
8308 unsigned long actual_size, bytes_remaining;
8309 int i, rc, actual_format;
8310 Window wmcheck_window;
8311 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8312 Window target_window = dpyinfo->root_window;
8313 long max_len = 65536;
8314 Display *dpy = FRAME_X_DISPLAY (f);
8315 unsigned char *tmp_data = NULL;
8316 Atom target_type = XA_WINDOW;
8318 block_input ();
8320 x_catch_errors (dpy);
8321 rc = XGetWindowProperty (dpy, target_window,
8322 dpyinfo->Xatom_net_supporting_wm_check,
8323 0, max_len, False, target_type,
8324 &actual_type, &actual_format, &actual_size,
8325 &bytes_remaining, &tmp_data);
8327 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8329 if (tmp_data) XFree (tmp_data);
8330 x_uncatch_errors ();
8331 unblock_input ();
8332 return 0;
8335 wmcheck_window = *(Window *) tmp_data;
8336 XFree (tmp_data);
8338 /* Check if window exists. */
8339 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8340 x_sync (f);
8341 if (x_had_errors_p (dpy))
8343 x_uncatch_errors ();
8344 unblock_input ();
8345 return 0;
8348 if (dpyinfo->net_supported_window != wmcheck_window)
8350 /* Window changed, reload atoms */
8351 if (dpyinfo->net_supported_atoms != NULL)
8352 XFree (dpyinfo->net_supported_atoms);
8353 dpyinfo->net_supported_atoms = NULL;
8354 dpyinfo->nr_net_supported_atoms = 0;
8355 dpyinfo->net_supported_window = 0;
8357 target_type = XA_ATOM;
8358 tmp_data = NULL;
8359 rc = XGetWindowProperty (dpy, target_window,
8360 dpyinfo->Xatom_net_supported,
8361 0, max_len, False, target_type,
8362 &actual_type, &actual_format, &actual_size,
8363 &bytes_remaining, &tmp_data);
8365 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8367 if (tmp_data) XFree (tmp_data);
8368 x_uncatch_errors ();
8369 unblock_input ();
8370 return 0;
8373 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8374 dpyinfo->nr_net_supported_atoms = actual_size;
8375 dpyinfo->net_supported_window = wmcheck_window;
8378 rc = 0;
8380 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8381 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8383 x_uncatch_errors ();
8384 unblock_input ();
8386 return rc;
8389 static void
8390 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8392 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8394 x_send_client_event (frame, make_number (0), frame,
8395 dpyinfo->Xatom_net_wm_state,
8396 make_number (32),
8397 /* 1 = add, 0 = remove */
8398 Fcons
8399 (make_number (add ? 1 : 0),
8400 Fcons
8401 (make_fixnum_or_float (atom),
8402 value != 0
8403 ? Fcons (make_fixnum_or_float (value), Qnil)
8404 : Qnil)));
8407 void
8408 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8410 Lisp_Object frame;
8411 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8413 XSETFRAME (frame, f);
8415 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8416 dpyinfo->Xatom_net_wm_state_sticky, None);
8419 /* Return the current _NET_WM_STATE.
8420 SIZE_STATE is set to one of the FULLSCREEN_* values.
8421 STICKY is set to 1 if the sticky state is set, 0 if not.
8423 Return non-zero if we are not hidden, zero if we are. */
8425 static int
8426 get_current_wm_state (struct frame *f,
8427 Window window,
8428 int *size_state,
8429 int *sticky)
8431 Atom actual_type;
8432 unsigned long actual_size, bytes_remaining;
8433 int i, rc, actual_format, is_hidden = 0;
8434 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8435 long max_len = 65536;
8436 Display *dpy = FRAME_X_DISPLAY (f);
8437 unsigned char *tmp_data = NULL;
8438 Atom target_type = XA_ATOM;
8440 *sticky = 0;
8441 *size_state = FULLSCREEN_NONE;
8443 block_input ();
8444 x_catch_errors (dpy);
8445 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8446 0, max_len, False, target_type,
8447 &actual_type, &actual_format, &actual_size,
8448 &bytes_remaining, &tmp_data);
8450 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8452 if (tmp_data) XFree (tmp_data);
8453 x_uncatch_errors ();
8454 unblock_input ();
8455 return ! f->iconified;
8458 x_uncatch_errors ();
8460 for (i = 0; i < actual_size; ++i)
8462 Atom a = ((Atom*)tmp_data)[i];
8463 if (a == dpyinfo->Xatom_net_wm_state_hidden)
8465 is_hidden = 1;
8466 f->output_data.x->net_wm_state_hidden_seen = 1;
8468 else if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8470 if (*size_state == FULLSCREEN_HEIGHT)
8471 *size_state = FULLSCREEN_MAXIMIZED;
8472 else
8473 *size_state = FULLSCREEN_WIDTH;
8475 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8477 if (*size_state == FULLSCREEN_WIDTH)
8478 *size_state = FULLSCREEN_MAXIMIZED;
8479 else
8480 *size_state = FULLSCREEN_HEIGHT;
8482 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8483 *size_state = FULLSCREEN_BOTH;
8484 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8485 *sticky = 1;
8488 if (tmp_data) XFree (tmp_data);
8489 unblock_input ();
8490 return ! is_hidden;
8493 /* Do fullscreen as specified in extended window manager hints */
8495 static int
8496 do_ewmh_fullscreen (struct frame *f)
8498 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8499 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8500 int cur, dummy;
8502 (void)get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8504 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8505 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8506 if (!have_net_atom)
8507 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8509 if (have_net_atom && cur != f->want_fullscreen)
8511 Lisp_Object frame;
8513 XSETFRAME (frame, f);
8515 /* Keep number of calls to set_wm_state as low as possible.
8516 Some window managers, or possible Gtk+, hangs when too many
8517 are sent at once. */
8518 switch (f->want_fullscreen)
8520 case FULLSCREEN_BOTH:
8521 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8522 || cur == FULLSCREEN_HEIGHT)
8523 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8524 dpyinfo->Xatom_net_wm_state_maximized_vert);
8525 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8526 break;
8527 case FULLSCREEN_WIDTH:
8528 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8529 || cur == FULLSCREEN_MAXIMIZED)
8530 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8531 dpyinfo->Xatom_net_wm_state_maximized_vert);
8532 if (cur != FULLSCREEN_MAXIMIZED)
8533 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8534 break;
8535 case FULLSCREEN_HEIGHT:
8536 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8537 || cur == FULLSCREEN_MAXIMIZED)
8538 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8539 dpyinfo->Xatom_net_wm_state_maximized_horz);
8540 if (cur != FULLSCREEN_MAXIMIZED)
8541 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8542 break;
8543 case FULLSCREEN_MAXIMIZED:
8544 if (cur == FULLSCREEN_BOTH)
8545 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8546 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8547 dpyinfo->Xatom_net_wm_state_maximized_vert);
8548 break;
8549 case FULLSCREEN_NONE:
8550 if (cur == FULLSCREEN_BOTH)
8551 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8552 else
8553 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8554 dpyinfo->Xatom_net_wm_state_maximized_vert);
8557 f->want_fullscreen = FULLSCREEN_NONE;
8561 return have_net_atom;
8564 static void
8565 XTfullscreen_hook (FRAME_PTR f)
8567 if (f->async_visible)
8569 block_input ();
8570 x_check_fullscreen (f);
8571 x_sync (f);
8572 unblock_input ();
8577 static int
8578 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8580 int value = FULLSCREEN_NONE;
8581 Lisp_Object lval;
8582 int sticky = 0;
8583 int not_hidden = get_current_wm_state (f, event->window, &value, &sticky);
8585 lval = Qnil;
8586 switch (value)
8588 case FULLSCREEN_WIDTH:
8589 lval = Qfullwidth;
8590 break;
8591 case FULLSCREEN_HEIGHT:
8592 lval = Qfullheight;
8593 break;
8594 case FULLSCREEN_BOTH:
8595 lval = Qfullboth;
8596 break;
8597 case FULLSCREEN_MAXIMIZED:
8598 lval = Qmaximized;
8599 break;
8602 store_frame_param (f, Qfullscreen, lval);
8603 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8605 return not_hidden;
8608 /* Check if we need to resize the frame due to a fullscreen request.
8609 If so needed, resize the frame. */
8610 static void
8611 x_check_fullscreen (struct frame *f)
8613 if (do_ewmh_fullscreen (f))
8614 return;
8616 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8617 return; /* Only fullscreen without WM or with EWM hints (above). */
8619 /* Setting fullscreen to nil doesn't do anything. We could save the
8620 last non-fullscreen size and restore it, but it seems like a
8621 lot of work for this unusual case (no window manager running). */
8623 if (f->want_fullscreen != FULLSCREEN_NONE)
8625 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8626 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8628 switch (f->want_fullscreen)
8630 /* No difference between these two when there is no WM */
8631 case FULLSCREEN_BOTH:
8632 case FULLSCREEN_MAXIMIZED:
8633 width = x_display_pixel_width (dpyinfo);
8634 height = x_display_pixel_height (dpyinfo);
8635 break;
8636 case FULLSCREEN_WIDTH:
8637 width = x_display_pixel_width (dpyinfo);
8638 break;
8639 case FULLSCREEN_HEIGHT:
8640 height = x_display_pixel_height (dpyinfo);
8643 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8644 width, height);
8648 /* This function is called by x_set_offset to determine whether the window
8649 manager interfered with the positioning of the frame. Type A window
8650 managers position the surrounding window manager decorations a small
8651 amount above and left of the user-supplied position. Type B window
8652 managers position the surrounding window manager decorations at the
8653 user-specified position. If we detect a Type A window manager, we
8654 compensate by moving the window right and down by the proper amount. */
8656 static void
8657 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8659 int current_left = 0, current_top = 0;
8661 /* x_real_positions returns the left and top offsets of the outermost
8662 window manager window around the frame. */
8664 x_real_positions (f, &current_left, &current_top);
8666 if (current_left != expected_left || current_top != expected_top)
8668 /* It's a "Type A" window manager. */
8670 int adjusted_left;
8671 int adjusted_top;
8673 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8674 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8675 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8677 /* Now fix the mispositioned frame's location. */
8679 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8680 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8682 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8683 adjusted_left, adjusted_top);
8685 x_sync_with_move (f, expected_left, expected_top, 0);
8687 else
8688 /* It's a "Type B" window manager. We don't have to adjust the
8689 frame's position. */
8691 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8695 /* Wait for XGetGeometry to return up-to-date position information for a
8696 recently-moved frame. Call this immediately after calling XMoveWindow.
8697 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8698 frame has been moved to, so we use a fuzzy position comparison instead
8699 of an exact comparison. */
8701 static void
8702 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8704 int count = 0;
8706 while (count++ < 50)
8708 int current_left = 0, current_top = 0;
8710 /* In theory, this call to XSync only needs to happen once, but in
8711 practice, it doesn't seem to work, hence the need for the surrounding
8712 loop. */
8714 XSync (FRAME_X_DISPLAY (f), False);
8715 x_real_positions (f, &current_left, &current_top);
8717 if (fuzzy)
8719 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8720 pixels. */
8722 if (eabs (current_left - left) <= 10
8723 && eabs (current_top - top) <= 40)
8724 return;
8726 else if (current_left == left && current_top == top)
8727 return;
8730 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8731 will then return up-to-date position info. */
8733 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8737 /* Wait for an event on frame F matching EVENTTYPE. */
8738 void
8739 x_wait_for_event (struct frame *f, int eventtype)
8741 int level = interrupt_input_blocked;
8743 SELECT_TYPE fds;
8744 EMACS_TIME tmo, tmo_at, time_now;
8745 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8747 pending_event_wait.f = f;
8748 pending_event_wait.eventtype = eventtype;
8750 /* Set timeout to 0.1 second. Hopefully not noticeable.
8751 Maybe it should be configurable. */
8752 tmo = make_emacs_time (0, 100 * 1000 * 1000);
8753 tmo_at = add_emacs_time (current_emacs_time (), tmo);
8755 while (pending_event_wait.eventtype)
8757 pending_signals = 1;
8758 totally_unblock_input ();
8759 /* XTread_socket is called after unblock. */
8760 block_input ();
8761 interrupt_input_blocked = level;
8763 FD_ZERO (&fds);
8764 FD_SET (fd, &fds);
8766 time_now = current_emacs_time ();
8767 if (EMACS_TIME_LT (tmo_at, time_now))
8768 break;
8770 tmo = sub_emacs_time (tmo_at, time_now);
8771 if (pselect (fd + 1, &fds, NULL, NULL, &tmo, NULL) == 0)
8772 break; /* Timeout */
8774 pending_event_wait.f = 0;
8775 pending_event_wait.eventtype = 0;
8779 /* Change the size of frame F's X window to COLS/ROWS in the case F
8780 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8781 top-left-corner window gravity for this size change and subsequent
8782 size changes. Otherwise we leave the window gravity unchanged. */
8784 static void
8785 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8787 int pixelwidth, pixelheight;
8789 check_frame_size (f, &rows, &cols);
8790 f->scroll_bar_actual_width
8791 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8793 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8795 compute_fringe_widths (f, 0);
8797 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8798 + FRAME_TOOLBAR_WIDTH (f);
8799 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8800 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8802 if (change_gravity) f->win_gravity = NorthWestGravity;
8803 x_wm_set_size_hint (f, (long) 0, 0);
8804 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8805 pixelwidth, pixelheight);
8808 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8809 receive in the ConfigureNotify event; if we get what we asked
8810 for, then the event won't cause the screen to become garbaged, so
8811 we have to make sure to do it here. */
8812 SET_FRAME_GARBAGED (f);
8814 /* Now, strictly speaking, we can't be sure that this is accurate,
8815 but the window manager will get around to dealing with the size
8816 change request eventually, and we'll hear how it went when the
8817 ConfigureNotify event gets here.
8819 We could just not bother storing any of this information here,
8820 and let the ConfigureNotify event set everything up, but that
8821 might be kind of confusing to the Lisp code, since size changes
8822 wouldn't be reported in the frame parameters until some random
8823 point in the future when the ConfigureNotify event arrives.
8825 We pass 1 for DELAY since we can't run Lisp code inside of
8826 a BLOCK_INPUT. */
8828 /* But the ConfigureNotify may in fact never arrive, and then this is
8829 not right if the frame is visible. Instead wait (with timeout)
8830 for the ConfigureNotify. */
8831 if (f->async_visible)
8832 x_wait_for_event (f, ConfigureNotify);
8833 else
8835 change_frame_size (f, rows, cols, 0, 1, 0);
8836 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8837 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8838 x_sync (f);
8843 /* Call this to change the size of frame F's x-window.
8844 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8845 for this size change and subsequent size changes.
8846 Otherwise we leave the window gravity unchanged. */
8848 void
8849 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8851 block_input ();
8853 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8855 int r, c;
8857 /* When the frame is maximized/fullscreen or running under for
8858 example Xmonad, x_set_window_size_1 will be a no-op.
8859 In that case, the right thing to do is extend rows/cols to
8860 the current frame size. We do that first if x_set_window_size_1
8861 turns out to not be a no-op (there is no way to know).
8862 The size will be adjusted again if the frame gets a
8863 ConfigureNotify event as a result of x_set_window_size. */
8864 int pixelh = FRAME_PIXEL_HEIGHT (f);
8865 #ifdef USE_X_TOOLKIT
8866 /* The menu bar is not part of text lines. The tool bar
8867 is however. */
8868 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8869 #endif
8870 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8871 /* Update f->scroll_bar_actual_width because it is used in
8872 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8873 f->scroll_bar_actual_width
8874 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8875 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8876 change_frame_size (f, r, c, 0, 1, 0);
8879 #ifdef USE_GTK
8880 if (FRAME_GTK_WIDGET (f))
8881 xg_frame_set_char_size (f, cols, rows);
8882 else
8883 x_set_window_size_1 (f, change_gravity, cols, rows);
8884 #else /* not USE_GTK */
8886 x_set_window_size_1 (f, change_gravity, cols, rows);
8888 #endif /* not USE_GTK */
8890 /* If cursor was outside the new size, mark it as off. */
8891 mark_window_cursors_off (XWINDOW (f->root_window));
8893 /* Clear out any recollection of where the mouse highlighting was,
8894 since it might be in a place that's outside the new frame size.
8895 Actually checking whether it is outside is a pain in the neck,
8896 so don't try--just let the highlighting be done afresh with new size. */
8897 cancel_mouse_face (f);
8899 unblock_input ();
8902 /* Mouse warping. */
8904 void
8905 x_set_mouse_position (struct frame *f, int x, int y)
8907 int pix_x, pix_y;
8909 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8910 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8912 if (pix_x < 0) pix_x = 0;
8913 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8915 if (pix_y < 0) pix_y = 0;
8916 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8918 block_input ();
8920 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8921 0, 0, 0, 0, pix_x, pix_y);
8922 unblock_input ();
8925 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8927 void
8928 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8930 block_input ();
8932 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8933 0, 0, 0, 0, pix_x, pix_y);
8934 unblock_input ();
8937 /* Raise frame F. */
8939 void
8940 x_raise_frame (struct frame *f)
8942 block_input ();
8943 if (f->async_visible)
8944 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8946 XFlush (FRAME_X_DISPLAY (f));
8947 unblock_input ();
8950 /* Lower frame F. */
8952 static void
8953 x_lower_frame (struct frame *f)
8955 if (f->async_visible)
8957 block_input ();
8958 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8959 XFlush (FRAME_X_DISPLAY (f));
8960 unblock_input ();
8964 /* Request focus with XEmbed */
8966 void
8967 xembed_request_focus (FRAME_PTR f)
8969 /* See XEmbed Protocol Specification at
8970 http://freedesktop.org/wiki/Specifications/xembed-spec */
8971 if (f->async_visible)
8972 xembed_send_message (f, CurrentTime,
8973 XEMBED_REQUEST_FOCUS, 0, 0, 0);
8976 /* Activate frame with Extended Window Manager Hints */
8978 void
8979 x_ewmh_activate_frame (FRAME_PTR f)
8981 /* See Window Manager Specification/Extended Window Manager Hints at
8982 http://freedesktop.org/wiki/Specifications/wm-spec */
8984 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8985 if (f->async_visible && wm_supports (f, dpyinfo->Xatom_net_active_window))
8987 Lisp_Object frame;
8988 XSETFRAME (frame, f);
8989 x_send_client_event (frame, make_number (0), frame,
8990 dpyinfo->Xatom_net_active_window,
8991 make_number (32),
8992 Fcons (make_number (1),
8993 Fcons (make_number (last_user_time),
8994 Qnil)));
8998 static void
8999 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
9001 if (raise_flag)
9002 x_raise_frame (f);
9003 else
9004 x_lower_frame (f);
9007 /* XEmbed implementation. */
9009 #if defined USE_X_TOOLKIT || ! defined USE_GTK
9011 /* XEmbed implementation. */
9013 #define XEMBED_VERSION 0
9015 static void
9016 xembed_set_info (struct frame *f, enum xembed_info flags)
9018 unsigned long data[2];
9019 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9021 data[0] = XEMBED_VERSION;
9022 data[1] = flags;
9024 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9025 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
9026 32, PropModeReplace, (unsigned char *) data, 2);
9028 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
9030 static void
9031 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
9032 long int detail, long int data1, long int data2)
9034 XEvent event;
9036 event.xclient.type = ClientMessage;
9037 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9038 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9039 event.xclient.format = 32;
9040 event.xclient.data.l[0] = t;
9041 event.xclient.data.l[1] = msg;
9042 event.xclient.data.l[2] = detail;
9043 event.xclient.data.l[3] = data1;
9044 event.xclient.data.l[4] = data2;
9046 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9047 False, NoEventMask, &event);
9048 XSync (FRAME_X_DISPLAY (f), False);
9051 /* Change of visibility. */
9053 /* This tries to wait until the frame is really visible.
9054 However, if the window manager asks the user where to position
9055 the frame, this will return before the user finishes doing that.
9056 The frame will not actually be visible at that time,
9057 but it will become visible later when the window manager
9058 finishes with it. */
9060 void
9061 x_make_frame_visible (struct frame *f)
9063 Lisp_Object type;
9064 int original_top, original_left;
9065 int retry_count = 2;
9067 retry:
9069 block_input ();
9071 type = x_icon_type (f);
9072 if (!NILP (type))
9073 x_bitmap_icon (f, type);
9075 if (! FRAME_VISIBLE_P (f))
9077 /* We test FRAME_GARBAGED_P here to make sure we don't
9078 call x_set_offset a second time
9079 if we get to x_make_frame_visible a second time
9080 before the window gets really visible. */
9081 if (! FRAME_ICONIFIED_P (f)
9082 && ! FRAME_X_EMBEDDED_P (f)
9083 && ! f->output_data.x->asked_for_visible)
9084 x_set_offset (f, f->left_pos, f->top_pos, 0);
9086 f->output_data.x->asked_for_visible = 1;
9088 if (! EQ (Vx_no_window_manager, Qt))
9089 x_wm_set_window_state (f, NormalState);
9090 #ifdef USE_X_TOOLKIT
9091 if (FRAME_X_EMBEDDED_P (f))
9092 xembed_set_info (f, XEMBED_MAPPED);
9093 else
9095 /* This was XtPopup, but that did nothing for an iconified frame. */
9096 XtMapWidget (f->output_data.x->widget);
9098 #else /* not USE_X_TOOLKIT */
9099 #ifdef USE_GTK
9100 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9101 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9102 #else
9103 if (FRAME_X_EMBEDDED_P (f))
9104 xembed_set_info (f, XEMBED_MAPPED);
9105 else
9106 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9107 #endif /* not USE_GTK */
9108 #endif /* not USE_X_TOOLKIT */
9111 XFlush (FRAME_X_DISPLAY (f));
9113 /* Synchronize to ensure Emacs knows the frame is visible
9114 before we do anything else. We do this loop with input not blocked
9115 so that incoming events are handled. */
9117 Lisp_Object frame;
9118 int count;
9119 /* This must be before UNBLOCK_INPUT
9120 since events that arrive in response to the actions above
9121 will set it when they are handled. */
9122 int previously_visible = f->output_data.x->has_been_visible;
9124 original_left = f->left_pos;
9125 original_top = f->top_pos;
9127 /* This must come after we set COUNT. */
9128 unblock_input ();
9130 /* We unblock here so that arriving X events are processed. */
9132 /* Now move the window back to where it was "supposed to be".
9133 But don't do it if the gravity is negative.
9134 When the gravity is negative, this uses a position
9135 that is 3 pixels too low. Perhaps that's really the border width.
9137 Don't do this if the window has never been visible before,
9138 because the window manager may choose the position
9139 and we don't want to override it. */
9141 if (! FRAME_VISIBLE_P (f)
9142 && ! FRAME_ICONIFIED_P (f)
9143 && ! FRAME_X_EMBEDDED_P (f)
9144 && f->win_gravity == NorthWestGravity
9145 && previously_visible)
9147 Drawable rootw;
9148 int x, y;
9149 unsigned int width, height, border, depth;
9151 block_input ();
9153 /* On some window managers (such as FVWM) moving an existing
9154 window, even to the same place, causes the window manager
9155 to introduce an offset. This can cause the window to move
9156 to an unexpected location. Check the geometry (a little
9157 slow here) and then verify that the window is in the right
9158 place. If the window is not in the right place, move it
9159 there, and take the potential window manager hit. */
9160 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9161 &rootw, &x, &y, &width, &height, &border, &depth);
9163 if (original_left != x || original_top != y)
9164 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9165 original_left, original_top);
9167 unblock_input ();
9170 XSETFRAME (frame, f);
9172 /* Wait until the frame is visible. Process X events until a
9173 MapNotify event has been seen, or until we think we won't get a
9174 MapNotify at all.. */
9175 for (count = input_signal_count + 10;
9176 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9178 /* Force processing of queued events. */
9179 x_sync (f);
9181 /* Machines that do polling rather than SIGIO have been
9182 observed to go into a busy-wait here. So we'll fake an
9183 alarm signal to let the handler know that there's something
9184 to be read. We used to raise a real alarm, but it seems
9185 that the handler isn't always enabled here. This is
9186 probably a bug. */
9187 if (input_polling_used ())
9189 /* It could be confusing if a real alarm arrives while
9190 processing the fake one. Turn it off and let the
9191 handler reset it. */
9192 int old_poll_suppress_count = poll_suppress_count;
9193 poll_suppress_count = 1;
9194 poll_for_input_1 ();
9195 poll_suppress_count = old_poll_suppress_count;
9198 /* See if a MapNotify event has been processed. */
9199 FRAME_SAMPLE_VISIBILITY (f);
9202 /* 2000-09-28: In
9204 (let ((f (selected-frame)))
9205 (iconify-frame f)
9206 (raise-frame f))
9208 the frame is not raised with various window managers on
9209 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9210 unknown reason, the call to XtMapWidget is completely ignored.
9211 Mapping the widget a second time works. */
9213 if (!FRAME_VISIBLE_P (f) && --retry_count != 0)
9214 goto retry;
9218 /* Change from mapped state to withdrawn state. */
9220 /* Make the frame visible (mapped and not iconified). */
9222 void
9223 x_make_frame_invisible (struct frame *f)
9225 Window window;
9227 /* Use the frame's outermost window, not the one we normally draw on. */
9228 window = FRAME_OUTER_WINDOW (f);
9230 /* Don't keep the highlight on an invisible frame. */
9231 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9232 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9234 block_input ();
9236 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9237 that the current position of the window is user-specified, rather than
9238 program-specified, so that when the window is mapped again, it will be
9239 placed at the same location, without forcing the user to position it
9240 by hand again (they have already done that once for this window.) */
9241 x_wm_set_size_hint (f, (long) 0, 1);
9243 #ifdef USE_GTK
9244 if (FRAME_GTK_OUTER_WIDGET (f))
9245 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9246 else
9247 #else
9248 if (FRAME_X_EMBEDDED_P (f))
9249 xembed_set_info (f, 0);
9250 else
9251 #endif
9254 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9255 DefaultScreen (FRAME_X_DISPLAY (f))))
9257 unblock_input ();
9258 error ("Can't notify window manager of window withdrawal");
9262 /* We can't distinguish this from iconification
9263 just by the event that we get from the server.
9264 So we can't win using the usual strategy of letting
9265 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9266 and synchronize with the server to make sure we agree. */
9267 f->visible = 0;
9268 FRAME_ICONIFIED_P (f) = 0;
9269 f->async_visible = 0;
9270 f->async_iconified = 0;
9272 x_sync (f);
9274 unblock_input ();
9277 /* Change window state from mapped to iconified. */
9279 void
9280 x_iconify_frame (struct frame *f)
9282 #ifdef USE_X_TOOLKIT
9283 int result;
9284 #endif
9285 Lisp_Object type;
9287 /* Don't keep the highlight on an invisible frame. */
9288 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9289 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9291 if (f->async_iconified)
9292 return;
9294 block_input ();
9296 FRAME_SAMPLE_VISIBILITY (f);
9298 type = x_icon_type (f);
9299 if (!NILP (type))
9300 x_bitmap_icon (f, type);
9302 #if defined (USE_GTK)
9303 if (FRAME_GTK_OUTER_WIDGET (f))
9305 if (! FRAME_VISIBLE_P (f))
9306 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9308 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9309 f->iconified = 1;
9310 f->visible = 1;
9311 f->async_iconified = 1;
9312 f->async_visible = 0;
9313 unblock_input ();
9314 return;
9316 #endif
9318 #ifdef USE_X_TOOLKIT
9320 if (! FRAME_VISIBLE_P (f))
9322 if (! EQ (Vx_no_window_manager, Qt))
9323 x_wm_set_window_state (f, IconicState);
9324 /* This was XtPopup, but that did nothing for an iconified frame. */
9325 XtMapWidget (f->output_data.x->widget);
9326 /* The server won't give us any event to indicate
9327 that an invisible frame was changed to an icon,
9328 so we have to record it here. */
9329 f->iconified = 1;
9330 f->visible = 1;
9331 f->async_iconified = 1;
9332 f->async_visible = 0;
9333 unblock_input ();
9334 return;
9337 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9338 XtWindow (f->output_data.x->widget),
9339 DefaultScreen (FRAME_X_DISPLAY (f)));
9340 unblock_input ();
9342 if (!result)
9343 error ("Can't notify window manager of iconification");
9345 f->async_iconified = 1;
9346 f->async_visible = 0;
9349 block_input ();
9350 XFlush (FRAME_X_DISPLAY (f));
9351 unblock_input ();
9352 #else /* not USE_X_TOOLKIT */
9354 /* Make sure the X server knows where the window should be positioned,
9355 in case the user deiconifies with the window manager. */
9356 if (! FRAME_VISIBLE_P (f)
9357 && ! FRAME_ICONIFIED_P (f)
9358 && ! FRAME_X_EMBEDDED_P (f))
9359 x_set_offset (f, f->left_pos, f->top_pos, 0);
9361 /* Since we don't know which revision of X we're running, we'll use both
9362 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9364 /* X11R4: send a ClientMessage to the window manager using the
9365 WM_CHANGE_STATE type. */
9367 XEvent msg;
9369 msg.xclient.window = FRAME_X_WINDOW (f);
9370 msg.xclient.type = ClientMessage;
9371 msg.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9372 msg.xclient.format = 32;
9373 msg.xclient.data.l[0] = IconicState;
9375 if (! XSendEvent (FRAME_X_DISPLAY (f),
9376 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9377 False,
9378 SubstructureRedirectMask | SubstructureNotifyMask,
9379 &msg))
9381 unblock_input ();
9382 error ("Can't notify window manager of iconification");
9386 /* X11R3: set the initial_state field of the window manager hints to
9387 IconicState. */
9388 x_wm_set_window_state (f, IconicState);
9390 if (!FRAME_VISIBLE_P (f))
9392 /* If the frame was withdrawn, before, we must map it. */
9393 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9396 f->async_iconified = 1;
9397 f->async_visible = 0;
9399 XFlush (FRAME_X_DISPLAY (f));
9400 unblock_input ();
9401 #endif /* not USE_X_TOOLKIT */
9405 /* Free X resources of frame F. */
9407 void
9408 x_free_frame_resources (struct frame *f)
9410 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9411 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9412 #ifdef USE_X_TOOLKIT
9413 Lisp_Object bar;
9414 struct scroll_bar *b;
9415 #endif
9417 block_input ();
9419 /* If a display connection is dead, don't try sending more
9420 commands to the X server. */
9421 if (dpyinfo->display)
9423 /* We must free faces before destroying windows because some
9424 font-driver (e.g. xft) access a window while finishing a
9425 face. */
9426 if (FRAME_FACE_CACHE (f))
9427 free_frame_faces (f);
9429 if (f->output_data.x->icon_desc)
9430 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9432 #ifdef USE_X_TOOLKIT
9433 /* Explicitly destroy the scroll bars of the frame. Without
9434 this, we get "BadDrawable" errors from the toolkit later on,
9435 presumably from expose events generated for the disappearing
9436 toolkit scroll bars. */
9437 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9439 b = XSCROLL_BAR (bar);
9440 x_scroll_bar_remove (b);
9442 #endif
9444 #ifdef HAVE_X_I18N
9445 if (FRAME_XIC (f))
9446 free_frame_xic (f);
9447 #endif
9449 #ifdef USE_X_TOOLKIT
9450 if (f->output_data.x->widget)
9452 XtDestroyWidget (f->output_data.x->widget);
9453 f->output_data.x->widget = NULL;
9455 /* Tooltips don't have widgets, only a simple X window, even if
9456 we are using a toolkit. */
9457 else if (FRAME_X_WINDOW (f))
9458 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9460 free_frame_menubar (f);
9461 #else /* !USE_X_TOOLKIT */
9463 #ifdef USE_GTK
9464 xg_free_frame_widgets (f);
9465 #endif /* USE_GTK */
9467 if (FRAME_X_WINDOW (f))
9468 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9469 #endif /* !USE_X_TOOLKIT */
9471 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9472 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9473 unload_color (f, f->output_data.x->cursor_pixel);
9474 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9475 unload_color (f, f->output_data.x->border_pixel);
9476 unload_color (f, f->output_data.x->mouse_pixel);
9478 if (f->output_data.x->scroll_bar_background_pixel != -1)
9479 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9480 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9481 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9482 #ifdef USE_TOOLKIT_SCROLL_BARS
9483 /* Scrollbar shadow colors. */
9484 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9485 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9486 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9487 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9488 #endif /* USE_TOOLKIT_SCROLL_BARS */
9489 if (f->output_data.x->white_relief.allocated_p)
9490 unload_color (f, f->output_data.x->white_relief.pixel);
9491 if (f->output_data.x->black_relief.allocated_p)
9492 unload_color (f, f->output_data.x->black_relief.pixel);
9494 x_free_gcs (f);
9495 XFlush (FRAME_X_DISPLAY (f));
9498 xfree (f->output_data.x->saved_menu_event);
9499 xfree (f->output_data.x);
9500 f->output_data.x = NULL;
9502 if (f == dpyinfo->x_focus_frame)
9503 dpyinfo->x_focus_frame = 0;
9504 if (f == dpyinfo->x_focus_event_frame)
9505 dpyinfo->x_focus_event_frame = 0;
9506 if (f == dpyinfo->x_highlight_frame)
9507 dpyinfo->x_highlight_frame = 0;
9509 if (f == hlinfo->mouse_face_mouse_frame)
9511 hlinfo->mouse_face_beg_row
9512 = hlinfo->mouse_face_beg_col = -1;
9513 hlinfo->mouse_face_end_row
9514 = hlinfo->mouse_face_end_col = -1;
9515 hlinfo->mouse_face_window = Qnil;
9516 hlinfo->mouse_face_deferred_gc = 0;
9517 hlinfo->mouse_face_mouse_frame = 0;
9520 unblock_input ();
9524 /* Destroy the X window of frame F. */
9526 static void
9527 x_destroy_window (struct frame *f)
9529 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9531 /* If a display connection is dead, don't try sending more
9532 commands to the X server. */
9533 if (dpyinfo->display != 0)
9534 x_free_frame_resources (f);
9536 dpyinfo->reference_count--;
9540 /* Setting window manager hints. */
9542 /* Set the normal size hints for the window manager, for frame F.
9543 FLAGS is the flags word to use--or 0 meaning preserve the flags
9544 that the window now has.
9545 If USER_POSITION, set the USPosition
9546 flag (this is useful when FLAGS is 0).
9547 The GTK version is in gtkutils.c. */
9549 #ifndef USE_GTK
9550 void
9551 x_wm_set_size_hint (struct frame *f, long flags, bool user_position)
9553 XSizeHints size_hints;
9554 Window window = FRAME_OUTER_WINDOW (f);
9556 #ifdef USE_X_TOOLKIT
9557 if (f->output_data.x->widget)
9559 widget_update_wm_size_hints (f->output_data.x->widget);
9560 return;
9562 #endif
9564 /* Setting PMaxSize caused various problems. */
9565 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9567 size_hints.x = f->left_pos;
9568 size_hints.y = f->top_pos;
9570 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9571 size_hints.width = FRAME_PIXEL_WIDTH (f);
9573 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9574 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9575 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9576 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9577 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9578 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9580 /* Calculate the base and minimum sizes. */
9582 int base_width, base_height;
9583 int min_rows = 0, min_cols = 0;
9585 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9586 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9588 check_frame_size (f, &min_rows, &min_cols);
9590 /* The window manager uses the base width hints to calculate the
9591 current number of rows and columns in the frame while
9592 resizing; min_width and min_height aren't useful for this
9593 purpose, since they might not give the dimensions for a
9594 zero-row, zero-column frame.
9596 We use the base_width and base_height members if we have
9597 them; otherwise, we set the min_width and min_height members
9598 to the size for a zero x zero frame. */
9600 size_hints.flags |= PBaseSize;
9601 size_hints.base_width = base_width;
9602 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9603 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9604 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9607 /* If we don't need the old flags, we don't need the old hint at all. */
9608 if (flags)
9610 size_hints.flags |= flags;
9611 goto no_read;
9615 XSizeHints hints; /* Sometimes I hate X Windows... */
9616 long supplied_return;
9617 int value;
9619 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9620 &supplied_return);
9622 if (flags)
9623 size_hints.flags |= flags;
9624 else
9626 if (value == 0)
9627 hints.flags = 0;
9628 if (hints.flags & PSize)
9629 size_hints.flags |= PSize;
9630 if (hints.flags & PPosition)
9631 size_hints.flags |= PPosition;
9632 if (hints.flags & USPosition)
9633 size_hints.flags |= USPosition;
9634 if (hints.flags & USSize)
9635 size_hints.flags |= USSize;
9639 no_read:
9641 #ifdef PWinGravity
9642 size_hints.win_gravity = f->win_gravity;
9643 size_hints.flags |= PWinGravity;
9645 if (user_position)
9647 size_hints.flags &= ~ PPosition;
9648 size_hints.flags |= USPosition;
9650 #endif /* PWinGravity */
9652 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9654 #endif /* not USE_GTK */
9656 /* Used for IconicState or NormalState */
9658 static void
9659 x_wm_set_window_state (struct frame *f, int state)
9661 #ifdef USE_X_TOOLKIT
9662 Arg al[1];
9664 XtSetArg (al[0], XtNinitialState, state);
9665 XtSetValues (f->output_data.x->widget, al, 1);
9666 #else /* not USE_X_TOOLKIT */
9667 Window window = FRAME_X_WINDOW (f);
9669 f->output_data.x->wm_hints.flags |= StateHint;
9670 f->output_data.x->wm_hints.initial_state = state;
9672 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9673 #endif /* not USE_X_TOOLKIT */
9676 static void
9677 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
9679 Pixmap icon_pixmap, icon_mask;
9681 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9682 Window window = FRAME_OUTER_WINDOW (f);
9683 #endif
9685 if (pixmap_id > 0)
9687 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9688 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9689 icon_mask = x_bitmap_mask (f, pixmap_id);
9690 f->output_data.x->wm_hints.icon_mask = icon_mask;
9692 else
9694 /* It seems there is no way to turn off use of an icon
9695 pixmap. */
9696 return;
9700 #ifdef USE_GTK
9702 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9703 return;
9706 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9709 Arg al[1];
9710 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9711 XtSetValues (f->output_data.x->widget, al, 1);
9712 XtSetArg (al[0], XtNiconMask, icon_mask);
9713 XtSetValues (f->output_data.x->widget, al, 1);
9716 #else /* not USE_X_TOOLKIT && not USE_GTK */
9718 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9719 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9721 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9724 void
9725 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9727 Window window = FRAME_OUTER_WINDOW (f);
9729 f->output_data.x->wm_hints.flags |= IconPositionHint;
9730 f->output_data.x->wm_hints.icon_x = icon_x;
9731 f->output_data.x->wm_hints.icon_y = icon_y;
9733 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9737 /***********************************************************************
9738 Fonts
9739 ***********************************************************************/
9741 #ifdef GLYPH_DEBUG
9743 /* Check that FONT is valid on frame F. It is if it can be found in F's
9744 font table. */
9746 static void
9747 x_check_font (struct frame *f, struct font *font)
9749 eassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9750 if (font->driver->check)
9751 eassert (font->driver->check (f, font) == 0);
9754 #endif /* GLYPH_DEBUG */
9757 /***********************************************************************
9758 Initialization
9759 ***********************************************************************/
9761 #ifdef USE_X_TOOLKIT
9762 static XrmOptionDescRec emacs_options[] = {
9763 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9764 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9766 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9767 XrmoptionSepArg, NULL},
9768 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9770 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9771 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9772 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9773 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9774 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9775 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9776 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9779 /* Whether atimer for Xt timeouts is activated or not. */
9781 static int x_timeout_atimer_activated_flag;
9783 #endif /* USE_X_TOOLKIT */
9785 static int x_initialized;
9787 /* Test whether two display-name strings agree up to the dot that separates
9788 the screen number from the server number. */
9789 static int
9790 same_x_server (const char *name1, const char *name2)
9792 int seen_colon = 0;
9793 const char *system_name = SSDATA (Vsystem_name);
9794 ptrdiff_t system_name_length = SBYTES (Vsystem_name);
9795 ptrdiff_t length_until_period = 0;
9797 while (system_name[length_until_period] != 0
9798 && system_name[length_until_period] != '.')
9799 length_until_period++;
9801 /* Treat `unix' like an empty host name. */
9802 if (! strncmp (name1, "unix:", 5))
9803 name1 += 4;
9804 if (! strncmp (name2, "unix:", 5))
9805 name2 += 4;
9806 /* Treat this host's name like an empty host name. */
9807 if (! strncmp (name1, system_name, system_name_length)
9808 && name1[system_name_length] == ':')
9809 name1 += system_name_length;
9810 if (! strncmp (name2, system_name, system_name_length)
9811 && name2[system_name_length] == ':')
9812 name2 += system_name_length;
9813 /* Treat this host's domainless name like an empty host name. */
9814 if (! strncmp (name1, system_name, length_until_period)
9815 && name1[length_until_period] == ':')
9816 name1 += length_until_period;
9817 if (! strncmp (name2, system_name, length_until_period)
9818 && name2[length_until_period] == ':')
9819 name2 += length_until_period;
9821 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9823 if (*name1 == ':')
9824 seen_colon = 1;
9825 if (seen_colon && *name1 == '.')
9826 return 1;
9828 return (seen_colon
9829 && (*name1 == '.' || *name1 == '\0')
9830 && (*name2 == '.' || *name2 == '\0'));
9833 /* Count number of set bits in mask and number of bits to shift to
9834 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9835 to 5. */
9836 static void
9837 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9839 int nr = 0;
9840 int off = 0;
9842 while (!(mask & 1))
9844 off++;
9845 mask >>= 1;
9848 while (mask & 1)
9850 nr++;
9851 mask >>= 1;
9854 *offset = off;
9855 *bits = nr;
9858 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9859 But don't permanently open it, just test its availability. */
9862 x_display_ok (const char *display)
9864 int dpy_ok = 1;
9865 Display *dpy;
9867 dpy = XOpenDisplay (display);
9868 if (dpy)
9869 XCloseDisplay (dpy);
9870 else
9871 dpy_ok = 0;
9872 return dpy_ok;
9875 #ifdef USE_GTK
9876 static void
9877 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
9878 const gchar *msg, gpointer user_data)
9880 if (!strstr (msg, "g_set_prgname"))
9881 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
9883 #endif
9885 /* Open a connection to X display DISPLAY_NAME, and return
9886 the structure that describes the open display.
9887 If we cannot contact the display, return null. */
9889 struct x_display_info *
9890 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9892 int connection;
9893 Display *dpy;
9894 struct terminal *terminal;
9895 struct x_display_info *dpyinfo;
9896 XrmDatabase xrdb;
9897 Mouse_HLInfo *hlinfo;
9898 ptrdiff_t lim;
9900 block_input ();
9902 if (!x_initialized)
9904 x_initialize ();
9905 ++x_initialized;
9908 if (! x_display_ok (SSDATA (display_name)))
9909 error ("Display %s can't be opened", SSDATA (display_name));
9911 #ifdef USE_GTK
9913 #define NUM_ARGV 10
9914 int argc;
9915 char *argv[NUM_ARGV];
9916 char **argv2 = argv;
9917 guint id;
9919 if (x_initialized++ > 1)
9921 xg_display_open (SSDATA (display_name), &dpy);
9923 else
9925 static char display_opt[] = "--display";
9926 static char name_opt[] = "--name";
9928 for (argc = 0; argc < NUM_ARGV; ++argc)
9929 argv[argc] = 0;
9931 argc = 0;
9932 argv[argc++] = initial_argv[0];
9934 if (! NILP (display_name))
9936 argv[argc++] = display_opt;
9937 argv[argc++] = SSDATA (display_name);
9940 argv[argc++] = name_opt;
9941 argv[argc++] = resource_name;
9943 XSetLocaleModifiers ("");
9945 /* Emacs can only handle core input events, so make sure
9946 Gtk doesn't use Xinput or Xinput2 extensions. */
9948 static char fix_events[] = "GDK_CORE_DEVICE_EVENTS=1";
9949 putenv (fix_events);
9952 /* Work around GLib bug that outputs a faulty warning. See
9953 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9954 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9955 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9957 /* NULL window -> events for all windows go to our function.
9958 Call before gtk_init so Gtk+ event filters comes after our. */
9959 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9961 /* gtk_init does set_locale. Fix locale before and after. */
9962 fixup_locale ();
9963 gtk_init (&argc, &argv2);
9964 fixup_locale ();
9966 g_log_remove_handler ("GLib", id);
9968 xg_initialize ();
9970 dpy = DEFAULT_GDK_DISPLAY ();
9972 #if GTK_MAJOR_VERSION <= 2 && GTK_MINOR_VERSION <= 90
9973 /* Load our own gtkrc if it exists. */
9975 const char *file = "~/.emacs.d/gtkrc";
9976 Lisp_Object s, abs_file;
9978 s = build_string (file);
9979 abs_file = Fexpand_file_name (s, Qnil);
9981 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9982 gtk_rc_parse (SSDATA (abs_file));
9984 #endif
9986 XSetErrorHandler (x_error_handler);
9987 XSetIOErrorHandler (x_io_error_quitter);
9990 #else /* not USE_GTK */
9991 #ifdef USE_X_TOOLKIT
9992 /* weiner@footloose.sps.mot.com reports that this causes
9993 errors with X11R5:
9994 X protocol error: BadAtom (invalid Atom parameter)
9995 on protocol request 18skiloaf.
9996 So let's not use it until R6. */
9997 #ifdef HAVE_X11XTR6
9998 XtSetLanguageProc (NULL, NULL, NULL);
9999 #endif
10002 int argc = 0;
10003 char *argv[3];
10005 argv[0] = "";
10006 argc = 1;
10007 if (xrm_option)
10009 argv[argc++] = "-xrm";
10010 argv[argc++] = xrm_option;
10012 turn_on_atimers (0);
10013 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
10014 resource_name, EMACS_CLASS,
10015 emacs_options, XtNumber (emacs_options),
10016 &argc, argv);
10017 turn_on_atimers (1);
10019 #ifdef HAVE_X11XTR6
10020 /* I think this is to compensate for XtSetLanguageProc. */
10021 fixup_locale ();
10022 #endif
10025 #else /* not USE_X_TOOLKIT */
10026 XSetLocaleModifiers ("");
10027 dpy = XOpenDisplay (SSDATA (display_name));
10028 #endif /* not USE_X_TOOLKIT */
10029 #endif /* not USE_GTK*/
10031 /* Detect failure. */
10032 if (dpy == 0)
10034 unblock_input ();
10035 return 0;
10038 /* We have definitely succeeded. Record the new connection. */
10040 dpyinfo = xzalloc (sizeof *dpyinfo);
10041 hlinfo = &dpyinfo->mouse_highlight;
10043 terminal = x_create_terminal (dpyinfo);
10046 struct x_display_info *share;
10047 Lisp_Object tail;
10049 for (share = x_display_list, tail = x_display_name_list; share;
10050 share = share->next, tail = XCDR (tail))
10051 if (same_x_server (SSDATA (XCAR (XCAR (tail))),
10052 SSDATA (display_name)))
10053 break;
10054 if (share)
10055 terminal->kboard = share->terminal->kboard;
10056 else
10058 terminal->kboard = xmalloc (sizeof *terminal->kboard);
10059 init_kboard (terminal->kboard);
10060 kset_window_system (terminal->kboard, Qx);
10062 /* Add the keyboard to the list before running Lisp code (via
10063 Qvendor_specific_keysyms below), since these are not traced
10064 via terminals but only through all_kboards. */
10065 terminal->kboard->next_kboard = all_kboards;
10066 all_kboards = terminal->kboard;
10068 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10070 char *vendor = ServerVendor (dpy);
10072 /* Protect terminal from GC before removing it from the
10073 list of terminals. */
10074 struct gcpro gcpro1;
10075 Lisp_Object gcpro_term;
10076 XSETTERMINAL (gcpro_term, terminal);
10077 GCPRO1 (gcpro_term);
10079 /* Temporarily hide the partially initialized terminal. */
10080 terminal_list = terminal->next_terminal;
10081 unblock_input ();
10082 kset_system_key_alist
10083 (terminal->kboard,
10084 call1 (Qvendor_specific_keysyms,
10085 vendor ? build_string (vendor) : empty_unibyte_string));
10086 block_input ();
10087 terminal->next_terminal = terminal_list;
10088 terminal_list = terminal;
10089 UNGCPRO;
10092 /* Don't let the initial kboard remain current longer than necessary.
10093 That would cause problems if a file loaded on startup tries to
10094 prompt in the mini-buffer. */
10095 if (current_kboard == initial_kboard)
10096 current_kboard = terminal->kboard;
10098 terminal->kboard->reference_count++;
10101 /* Put this display on the chain. */
10102 dpyinfo->next = x_display_list;
10103 x_display_list = dpyinfo;
10105 /* Put it on x_display_name_list as well, to keep them parallel. */
10106 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10107 x_display_name_list);
10108 dpyinfo->name_list_element = XCAR (x_display_name_list);
10110 dpyinfo->display = dpy;
10112 /* Set the name of the terminal. */
10113 terminal->name = xmalloc (SBYTES (display_name) + 1);
10114 memcpy (terminal->name, SSDATA (display_name), SBYTES (display_name));
10115 terminal->name[SBYTES (display_name)] = 0;
10117 #if 0
10118 XSetAfterFunction (x_current_display, x_trace_wire);
10119 #endif /* ! 0 */
10121 lim = min (PTRDIFF_MAX, SIZE_MAX) - sizeof "@";
10122 if (lim - SBYTES (Vinvocation_name) < SBYTES (Vsystem_name))
10123 memory_full (SIZE_MAX);
10124 dpyinfo->x_id_name = xmalloc (SBYTES (Vinvocation_name)
10125 + SBYTES (Vsystem_name) + 2);
10126 strcat (strcat (strcpy (dpyinfo->x_id_name, SSDATA (Vinvocation_name)), "@"),
10127 SSDATA (Vsystem_name));
10129 /* Figure out which modifier bits mean what. */
10130 x_find_modifier_meanings (dpyinfo);
10132 /* Get the scroll bar cursor. */
10133 #ifdef USE_GTK
10134 /* We must create a GTK cursor, it is required for GTK widgets. */
10135 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10136 #endif /* USE_GTK */
10138 dpyinfo->vertical_scroll_bar_cursor
10139 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10141 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10142 resource_name, EMACS_CLASS);
10143 #ifdef HAVE_XRMSETDATABASE
10144 XrmSetDatabase (dpyinfo->display, xrdb);
10145 #else
10146 dpyinfo->display->db = xrdb;
10147 #endif
10148 /* Put the rdb where we can find it in a way that works on
10149 all versions. */
10150 dpyinfo->xrdb = xrdb;
10152 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10153 DefaultScreen (dpyinfo->display));
10154 select_visual (dpyinfo);
10155 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10156 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10157 dpyinfo->client_leader_window = 0;
10158 dpyinfo->grabbed = 0;
10159 dpyinfo->reference_count = 0;
10160 dpyinfo->icon_bitmap_id = -1;
10161 dpyinfo->n_fonts = 0;
10162 dpyinfo->bitmaps = 0;
10163 dpyinfo->bitmaps_size = 0;
10164 dpyinfo->bitmaps_last = 0;
10165 dpyinfo->scratch_cursor_gc = 0;
10166 hlinfo->mouse_face_mouse_frame = 0;
10167 hlinfo->mouse_face_deferred_gc = 0;
10168 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10169 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10170 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10171 hlinfo->mouse_face_window = Qnil;
10172 hlinfo->mouse_face_overlay = Qnil;
10173 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10174 hlinfo->mouse_face_defer = 0;
10175 hlinfo->mouse_face_hidden = 0;
10176 dpyinfo->x_focus_frame = 0;
10177 dpyinfo->x_focus_event_frame = 0;
10178 dpyinfo->x_highlight_frame = 0;
10179 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10181 /* See if we can construct pixel values from RGB values. */
10182 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10183 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10185 if (dpyinfo->visual->class == TrueColor)
10187 get_bits_and_offset (dpyinfo->visual->red_mask,
10188 &dpyinfo->red_bits, &dpyinfo->red_offset);
10189 get_bits_and_offset (dpyinfo->visual->blue_mask,
10190 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10191 get_bits_and_offset (dpyinfo->visual->green_mask,
10192 &dpyinfo->green_bits, &dpyinfo->green_offset);
10195 /* See if a private colormap is requested. */
10196 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10198 if (dpyinfo->visual->class == PseudoColor)
10200 Lisp_Object value;
10201 value = display_x_get_resource (dpyinfo,
10202 build_string ("privateColormap"),
10203 build_string ("PrivateColormap"),
10204 Qnil, Qnil);
10205 if (STRINGP (value)
10206 && (!strcmp (SSDATA (value), "true")
10207 || !strcmp (SSDATA (value), "on")))
10208 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10211 else
10212 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10213 dpyinfo->visual, AllocNone);
10215 #ifdef HAVE_XFT
10217 /* If we are using Xft, check dpi value in X resources.
10218 It is better we use it as well, since Xft will use it, as will all
10219 Gnome applications. If our real DPI is smaller or larger than the
10220 one Xft uses, our font will look smaller or larger than other
10221 for other applications, even if it is the same font name (monospace-10
10222 for example). */
10223 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10224 double d;
10225 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10226 dpyinfo->resy = dpyinfo->resx = d;
10228 #endif
10230 if (dpyinfo->resy < 1)
10232 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10233 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10234 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10235 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10236 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10237 pixels = DisplayWidth (dpyinfo->display, screen_number);
10238 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10239 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10240 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10244 const struct
10246 const char *name;
10247 Atom *atom;
10248 } atom_refs[] = {
10249 { "WM_PROTOCOLS", &dpyinfo->Xatom_wm_protocols },
10250 { "WM_TAKE_FOCUS", &dpyinfo->Xatom_wm_take_focus },
10251 { "WM_SAVE_YOURSELF", &dpyinfo->Xatom_wm_save_yourself },
10252 { "WM_DELETE_WINDOW", &dpyinfo->Xatom_wm_delete_window },
10253 { "WM_CHANGE_STATE", &dpyinfo->Xatom_wm_change_state },
10254 { "WM_CONFIGURE_DENIED", &dpyinfo->Xatom_wm_configure_denied },
10255 { "WM_MOVED", &dpyinfo->Xatom_wm_window_moved },
10256 { "WM_CLIENT_LEADER", &dpyinfo->Xatom_wm_client_leader },
10257 { "Editres", &dpyinfo->Xatom_editres },
10258 { "CLIPBOARD", &dpyinfo->Xatom_CLIPBOARD },
10259 { "TIMESTAMP", &dpyinfo->Xatom_TIMESTAMP },
10260 { "TEXT", &dpyinfo->Xatom_TEXT },
10261 { "COMPOUND_TEXT", &dpyinfo->Xatom_COMPOUND_TEXT },
10262 { "UTF8_STRING", &dpyinfo->Xatom_UTF8_STRING },
10263 { "DELETE", &dpyinfo->Xatom_DELETE },
10264 { "MULTIPLE", &dpyinfo->Xatom_MULTIPLE },
10265 { "INCR", &dpyinfo->Xatom_INCR },
10266 { "_EMACS_TMP_", &dpyinfo->Xatom_EMACS_TMP },
10267 { "TARGETS", &dpyinfo->Xatom_TARGETS },
10268 { "NULL", &dpyinfo->Xatom_NULL },
10269 { "ATOM", &dpyinfo->Xatom_ATOM },
10270 { "ATOM_PAIR", &dpyinfo->Xatom_ATOM_PAIR },
10271 { "CLIPBOARD_MANAGER", &dpyinfo->Xatom_CLIPBOARD_MANAGER },
10272 { "_XEMBED_INFO", &dpyinfo->Xatom_XEMBED_INFO },
10273 /* For properties of font. */
10274 { "PIXEL_SIZE", &dpyinfo->Xatom_PIXEL_SIZE },
10275 { "AVERAGE_WIDTH", &dpyinfo->Xatom_AVERAGE_WIDTH },
10276 { "_MULE_BASELINE_OFFSET", &dpyinfo->Xatom_MULE_BASELINE_OFFSET },
10277 { "_MULE_RELATIVE_COMPOSE", &dpyinfo->Xatom_MULE_RELATIVE_COMPOSE },
10278 { "_MULE_DEFAULT_ASCENT", &dpyinfo->Xatom_MULE_DEFAULT_ASCENT },
10279 /* Ghostscript support. */
10280 { "DONE", &dpyinfo->Xatom_DONE },
10281 { "PAGE", &dpyinfo->Xatom_PAGE },
10282 { "SCROLLBAR", &dpyinfo->Xatom_Scrollbar },
10283 { "_XEMBED", &dpyinfo->Xatom_XEMBED },
10284 /* EWMH */
10285 { "_NET_WM_STATE", &dpyinfo->Xatom_net_wm_state },
10286 { "_NET_WM_STATE_FULLSCREEN", &dpyinfo->Xatom_net_wm_state_fullscreen },
10287 { "_NET_WM_STATE_MAXIMIZED_HORZ",
10288 &dpyinfo->Xatom_net_wm_state_maximized_horz },
10289 { "_NET_WM_STATE_MAXIMIZED_VERT",
10290 &dpyinfo->Xatom_net_wm_state_maximized_vert },
10291 { "_NET_WM_STATE_STICKY", &dpyinfo->Xatom_net_wm_state_sticky },
10292 { "_NET_WM_STATE_HIDDEN", &dpyinfo->Xatom_net_wm_state_hidden },
10293 { "_NET_WM_WINDOW_TYPE", &dpyinfo->Xatom_net_window_type },
10294 { "_NET_WM_WINDOW_TYPE_TOOLTIP",
10295 &dpyinfo->Xatom_net_window_type_tooltip },
10296 { "_NET_WM_ICON_NAME", &dpyinfo->Xatom_net_wm_icon_name },
10297 { "_NET_WM_NAME", &dpyinfo->Xatom_net_wm_name },
10298 { "_NET_SUPPORTED", &dpyinfo->Xatom_net_supported },
10299 { "_NET_SUPPORTING_WM_CHECK", &dpyinfo->Xatom_net_supporting_wm_check },
10300 { "_NET_WM_WINDOW_OPACITY", &dpyinfo->Xatom_net_wm_window_opacity },
10301 { "_NET_ACTIVE_WINDOW", &dpyinfo->Xatom_net_active_window },
10302 { "_NET_FRAME_EXTENTS", &dpyinfo->Xatom_net_frame_extents },
10303 /* Session management */
10304 { "SM_CLIENT_ID", &dpyinfo->Xatom_SM_CLIENT_ID },
10305 { "_XSETTINGS_SETTINGS", &dpyinfo->Xatom_xsettings_prop },
10306 { "MANAGER", &dpyinfo->Xatom_xsettings_mgr },
10309 int i;
10310 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10311 /* 1 for _XSETTINGS_SN */
10312 const int total_atom_count = 1 + atom_count;
10313 Atom *atoms_return = xmalloc (total_atom_count * sizeof *atoms_return);
10314 char **atom_names = xmalloc (total_atom_count * sizeof *atom_names);
10315 static char const xsettings_fmt[] = "_XSETTINGS_S%d";
10316 char xsettings_atom_name[sizeof xsettings_fmt - 2
10317 + INT_STRLEN_BOUND (int)];
10319 for (i = 0; i < atom_count; i++)
10320 atom_names[i] = (char *) atom_refs[i].name;
10322 /* Build _XSETTINGS_SN atom name */
10323 sprintf (xsettings_atom_name, xsettings_fmt,
10324 XScreenNumberOfScreen (dpyinfo->screen));
10325 atom_names[i] = xsettings_atom_name;
10327 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10328 False, atoms_return);
10330 for (i = 0; i < atom_count; i++)
10331 *atom_refs[i].atom = atoms_return[i];
10333 /* Manual copy of last atom */
10334 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10336 xfree (atom_names);
10337 xfree (atoms_return);
10340 dpyinfo->x_dnd_atoms_size = 8;
10341 dpyinfo->x_dnd_atoms_length = 0;
10342 dpyinfo->x_dnd_atoms = xmalloc (sizeof *dpyinfo->x_dnd_atoms
10343 * dpyinfo->x_dnd_atoms_size);
10345 dpyinfo->net_supported_atoms = NULL;
10346 dpyinfo->nr_net_supported_atoms = 0;
10347 dpyinfo->net_supported_window = 0;
10349 connection = ConnectionNumber (dpyinfo->display);
10350 dpyinfo->connection = connection;
10351 dpyinfo->gray
10352 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10353 gray_bits, gray_width, gray_height,
10354 1, 0, 1);
10356 #ifdef HAVE_X_I18N
10357 xim_initialize (dpyinfo, resource_name);
10358 #endif
10360 xsettings_initialize (dpyinfo);
10362 /* This is only needed for distinguishing keyboard and process input. */
10363 if (connection != 0)
10364 add_keyboard_wait_descriptor (connection);
10366 #ifdef F_SETOWN
10367 fcntl (connection, F_SETOWN, getpid ());
10368 #endif /* ! defined (F_SETOWN) */
10370 if (interrupt_input)
10371 init_sigio (connection);
10373 #ifdef USE_LUCID
10375 XrmValue d, fr, to;
10376 Font font;
10378 dpy = dpyinfo->display;
10379 d.addr = (XPointer)&dpy;
10380 d.size = sizeof (Display *);
10381 fr.addr = XtDefaultFont;
10382 fr.size = sizeof (XtDefaultFont);
10383 to.size = sizeof (Font *);
10384 to.addr = (XPointer)&font;
10385 x_catch_errors (dpy);
10386 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10387 emacs_abort ();
10388 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10389 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10390 x_uncatch_errors ();
10392 #endif
10394 /* See if we should run in synchronous mode. This is useful
10395 for debugging X code. */
10397 Lisp_Object value;
10398 value = display_x_get_resource (dpyinfo,
10399 build_string ("synchronous"),
10400 build_string ("Synchronous"),
10401 Qnil, Qnil);
10402 if (STRINGP (value)
10403 && (!strcmp (SSDATA (value), "true")
10404 || !strcmp (SSDATA (value), "on")))
10405 XSynchronize (dpyinfo->display, True);
10409 Lisp_Object value;
10410 value = display_x_get_resource (dpyinfo,
10411 build_string ("useXIM"),
10412 build_string ("UseXIM"),
10413 Qnil, Qnil);
10414 #ifdef USE_XIM
10415 if (STRINGP (value)
10416 && (!strcmp (SSDATA (value), "false")
10417 || !strcmp (SSDATA (value), "off")))
10418 use_xim = 0;
10419 #else
10420 if (STRINGP (value)
10421 && (!strcmp (SSDATA (value), "true")
10422 || !strcmp (SSDATA (value), "on")))
10423 use_xim = 1;
10424 #endif
10427 #ifdef HAVE_X_SM
10428 /* Only do this for the very first display in the Emacs session.
10429 Ignore X session management when Emacs was first started on a
10430 tty. */
10431 if (terminal->id == 1)
10432 x_session_initialize (dpyinfo);
10433 #endif
10435 unblock_input ();
10437 return dpyinfo;
10440 /* Get rid of display DPYINFO, deleting all frames on it,
10441 and without sending any more commands to the X server. */
10443 static void
10444 x_delete_display (struct x_display_info *dpyinfo)
10446 struct terminal *t;
10448 /* Close all frames and delete the generic struct terminal for this
10449 X display. */
10450 for (t = terminal_list; t; t = t->next_terminal)
10451 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10453 #ifdef HAVE_X_SM
10454 /* Close X session management when we close its display. */
10455 if (t->id == 1 && x_session_have_connection ())
10456 x_session_close ();
10457 #endif
10458 delete_terminal (t);
10459 break;
10462 delete_keyboard_wait_descriptor (dpyinfo->connection);
10464 /* Discard this display from x_display_name_list and x_display_list.
10465 We can't use Fdelq because that can quit. */
10466 if (! NILP (x_display_name_list)
10467 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10468 x_display_name_list = XCDR (x_display_name_list);
10469 else
10471 Lisp_Object tail;
10473 tail = x_display_name_list;
10474 while (CONSP (tail) && CONSP (XCDR (tail)))
10476 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10478 XSETCDR (tail, XCDR (XCDR (tail)));
10479 break;
10481 tail = XCDR (tail);
10485 if (next_noop_dpyinfo == dpyinfo)
10486 next_noop_dpyinfo = dpyinfo->next;
10488 if (x_display_list == dpyinfo)
10489 x_display_list = dpyinfo->next;
10490 else
10492 struct x_display_info *tail;
10494 for (tail = x_display_list; tail; tail = tail->next)
10495 if (tail->next == dpyinfo)
10496 tail->next = tail->next->next;
10499 xfree (dpyinfo->x_id_name);
10500 xfree (dpyinfo->x_dnd_atoms);
10501 xfree (dpyinfo->color_cells);
10502 xfree (dpyinfo);
10505 #ifdef USE_X_TOOLKIT
10507 /* Atimer callback function for TIMER. Called every 0.1s to process
10508 Xt timeouts, if needed. We must avoid calling XtAppPending as
10509 much as possible because that function does an implicit XFlush
10510 that slows us down. */
10512 static void
10513 x_process_timeouts (struct atimer *timer)
10515 block_input ();
10516 x_timeout_atimer_activated_flag = 0;
10517 if (toolkit_scroll_bar_interaction || popup_activated ())
10519 while (XtAppPending (Xt_app_con) & XtIMTimer)
10520 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10521 /* Reactivate the atimer for next time. */
10522 x_activate_timeout_atimer ();
10524 unblock_input ();
10527 /* Install an asynchronous timer that processes Xt timeout events
10528 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10529 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10530 function whenever these variables are set. This is necessary
10531 because some widget sets use timeouts internally, for example the
10532 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10533 processed, these widgets don't behave normally. */
10535 void
10536 x_activate_timeout_atimer (void)
10538 block_input ();
10539 if (!x_timeout_atimer_activated_flag)
10541 EMACS_TIME interval = make_emacs_time (0, 100 * 1000 * 1000);
10542 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10543 x_timeout_atimer_activated_flag = 1;
10545 unblock_input ();
10548 #endif /* USE_X_TOOLKIT */
10551 /* Set up use of X before we make the first connection. */
10553 static struct redisplay_interface x_redisplay_interface =
10555 x_frame_parm_handlers,
10556 x_produce_glyphs,
10557 x_write_glyphs,
10558 x_insert_glyphs,
10559 x_clear_end_of_line,
10560 x_scroll_run,
10561 x_after_update_window_line,
10562 x_update_window_begin,
10563 x_update_window_end,
10564 x_cursor_to,
10565 x_flush,
10566 #ifdef XFlush
10567 x_flush,
10568 #else
10569 0, /* flush_display_optional */
10570 #endif
10571 x_clear_window_mouse_face,
10572 x_get_glyph_overhangs,
10573 x_fix_overlapping_area,
10574 x_draw_fringe_bitmap,
10575 0, /* define_fringe_bitmap */
10576 0, /* destroy_fringe_bitmap */
10577 x_compute_glyph_string_overhangs,
10578 x_draw_glyph_string,
10579 x_define_frame_cursor,
10580 x_clear_frame_area,
10581 x_draw_window_cursor,
10582 x_draw_vertical_window_border,
10583 x_shift_glyphs_for_insert
10587 /* This function is called when the last frame on a display is deleted. */
10588 void
10589 x_delete_terminal (struct terminal *terminal)
10591 struct x_display_info *dpyinfo = terminal->display_info.x;
10593 /* Protect against recursive calls. delete_frame in
10594 delete_terminal calls us back when it deletes our last frame. */
10595 if (!terminal->name)
10596 return;
10598 block_input ();
10599 #ifdef HAVE_X_I18N
10600 /* We must close our connection to the XIM server before closing the
10601 X display. */
10602 if (dpyinfo->xim)
10603 xim_close_dpy (dpyinfo);
10604 #endif
10606 /* If called from x_connection_closed, the display may already be closed
10607 and dpyinfo->display was set to 0 to indicate that. */
10608 if (dpyinfo->display)
10610 x_destroy_all_bitmaps (dpyinfo);
10611 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10613 /* Whether or not XCloseDisplay destroys the associated resource
10614 database depends on the version of libX11. To avoid both
10615 crash and memory leak, we dissociate the database from the
10616 display and then destroy dpyinfo->xrdb ourselves.
10618 Unfortunately, the above strategy does not work in some
10619 situations due to a bug in newer versions of libX11: because
10620 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10621 dpy->db is NULL, XCloseDisplay destroys the associated
10622 database whereas it has not been created by XGetDefault
10623 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10624 don't destroy the database here in order to avoid the crash
10625 in the above situations for now, though that may cause memory
10626 leaks in other situations. */
10627 #if 0
10628 #ifdef HAVE_XRMSETDATABASE
10629 XrmSetDatabase (dpyinfo->display, NULL);
10630 #else
10631 dpyinfo->display->db = NULL;
10632 #endif
10633 /* We used to call XrmDestroyDatabase from x_delete_display, but
10634 some older versions of libX11 crash if we call it after
10635 closing all the displays. */
10636 XrmDestroyDatabase (dpyinfo->xrdb);
10637 #endif
10639 #ifdef USE_GTK
10640 xg_display_close (dpyinfo->display);
10641 #else
10642 #ifdef USE_X_TOOLKIT
10643 XtCloseDisplay (dpyinfo->display);
10644 #else
10645 XCloseDisplay (dpyinfo->display);
10646 #endif
10647 #endif /* ! USE_GTK */
10650 /* Mark as dead. */
10651 dpyinfo->display = NULL;
10652 x_delete_display (dpyinfo);
10653 unblock_input ();
10656 /* Create a struct terminal, initialize it with the X11 specific
10657 functions and make DISPLAY->TERMINAL point to it. */
10659 static struct terminal *
10660 x_create_terminal (struct x_display_info *dpyinfo)
10662 struct terminal *terminal;
10664 terminal = create_terminal ();
10666 terminal->type = output_x_window;
10667 terminal->display_info.x = dpyinfo;
10668 dpyinfo->terminal = terminal;
10670 /* kboard is initialized in x_term_init. */
10672 terminal->clear_frame_hook = x_clear_frame;
10673 terminal->ins_del_lines_hook = x_ins_del_lines;
10674 terminal->delete_glyphs_hook = x_delete_glyphs;
10675 terminal->ring_bell_hook = XTring_bell;
10676 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10677 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10678 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10679 terminal->update_begin_hook = x_update_begin;
10680 terminal->update_end_hook = x_update_end;
10681 terminal->set_terminal_window_hook = XTset_terminal_window;
10682 terminal->read_socket_hook = XTread_socket;
10683 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10684 terminal->mouse_position_hook = XTmouse_position;
10685 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10686 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10687 terminal->fullscreen_hook = XTfullscreen_hook;
10688 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10689 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10690 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10691 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10693 terminal->delete_frame_hook = x_destroy_window;
10694 terminal->delete_terminal_hook = x_delete_terminal;
10696 terminal->rif = &x_redisplay_interface;
10697 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10698 terminal->char_ins_del_ok = 1;
10699 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10700 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10701 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10702 off the bottom. */
10704 return terminal;
10707 void
10708 x_initialize (void)
10710 baud_rate = 19200;
10712 x_noop_count = 0;
10713 last_tool_bar_item = -1;
10714 any_help_event_p = 0;
10715 ignore_next_mouse_click_timeout = 0;
10717 #ifdef USE_GTK
10718 current_count = -1;
10719 #endif
10721 /* Try to use interrupt input; if we can't, then start polling. */
10722 Fset_input_interrupt_mode (Qt);
10724 #ifdef USE_X_TOOLKIT
10725 XtToolkitInitialize ();
10727 Xt_app_con = XtCreateApplicationContext ();
10729 /* Register a converter from strings to pixels, which uses
10730 Emacs' color allocation infrastructure. */
10731 XtAppSetTypeConverter (Xt_app_con,
10732 XtRString, XtRPixel, cvt_string_to_pixel,
10733 cvt_string_to_pixel_args,
10734 XtNumber (cvt_string_to_pixel_args),
10735 XtCacheByDisplay, cvt_pixel_dtor);
10737 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10738 #endif
10740 #ifdef USE_TOOLKIT_SCROLL_BARS
10741 #ifndef USE_GTK
10742 xaw3d_arrow_scroll = False;
10743 xaw3d_pick_top = True;
10744 #endif
10745 #endif
10747 pending_autoraise_frame = 0;
10748 pending_event_wait.f = 0;
10749 pending_event_wait.eventtype = 0;
10751 /* Note that there is no real way portable across R3/R4 to get the
10752 original error handler. */
10753 XSetErrorHandler (x_error_handler);
10754 XSetIOErrorHandler (x_io_error_quitter);
10758 void
10759 syms_of_xterm (void)
10761 x_error_message = NULL;
10763 staticpro (&x_display_name_list);
10764 x_display_name_list = Qnil;
10766 staticpro (&last_mouse_scroll_bar);
10767 last_mouse_scroll_bar = Qnil;
10769 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
10770 DEFSYM (Qlatin_1, "latin-1");
10772 staticpro (&last_mouse_press_frame);
10773 last_mouse_press_frame = Qnil;
10775 #ifdef USE_GTK
10776 xg_default_icon_file = build_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10777 staticpro (&xg_default_icon_file);
10779 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
10780 #endif
10782 DEFVAR_BOOL ("x-use-underline-position-properties",
10783 x_use_underline_position_properties,
10784 doc: /* Non-nil means make use of UNDERLINE_POSITION font properties.
10785 A value of nil means ignore them. If you encounter fonts with bogus
10786 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10787 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10788 to override the font's UNDERLINE_POSITION for small font display
10789 sizes. */);
10790 x_use_underline_position_properties = 1;
10792 DEFVAR_BOOL ("x-underline-at-descent-line",
10793 x_underline_at_descent_line,
10794 doc: /* Non-nil means to draw the underline at the same place as the descent line.
10795 A value of nil means to draw the underline according to the value of the
10796 variable `x-use-underline-position-properties', which is usually at the
10797 baseline level. The default value is nil. */);
10798 x_underline_at_descent_line = 0;
10800 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10801 x_mouse_click_focus_ignore_position,
10802 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10803 This variable is only used when the window manager requires that you
10804 click on a frame to select it (give it focus). In that case, a value
10805 of nil, means that the selected window and cursor position changes to
10806 reflect the mouse click position, while a non-nil value means that the
10807 selected window or cursor position is preserved. */);
10808 x_mouse_click_focus_ignore_position = 0;
10810 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10811 doc: /* Which toolkit scroll bars Emacs uses, if any.
10812 A value of nil means Emacs doesn't use toolkit scroll bars.
10813 With the X Window system, the value is a symbol describing the
10814 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10815 With MS Windows or Nextstep, the value is t. */);
10816 #ifdef USE_TOOLKIT_SCROLL_BARS
10817 #ifdef USE_MOTIF
10818 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10819 #elif defined HAVE_XAW3D
10820 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10821 #elif USE_GTK
10822 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10823 #else
10824 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10825 #endif
10826 #else
10827 Vx_toolkit_scroll_bars = Qnil;
10828 #endif
10830 staticpro (&last_mouse_motion_frame);
10831 last_mouse_motion_frame = Qnil;
10833 Qmodifier_value = intern_c_string ("modifier-value");
10834 Qalt = intern_c_string ("alt");
10835 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10836 Qhyper = intern_c_string ("hyper");
10837 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10838 Qmeta = intern_c_string ("meta");
10839 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10840 Qsuper = intern_c_string ("super");
10841 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10843 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10844 doc: /* Which keys Emacs uses for the alt modifier.
10845 This should be one of the symbols `alt', `hyper', `meta', `super'.
10846 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10847 is nil, which is the same as `alt'. */);
10848 Vx_alt_keysym = Qnil;
10850 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10851 doc: /* Which keys Emacs uses for the hyper modifier.
10852 This should be one of the symbols `alt', `hyper', `meta', `super'.
10853 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10854 default is nil, which is the same as `hyper'. */);
10855 Vx_hyper_keysym = Qnil;
10857 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10858 doc: /* Which keys Emacs uses for the meta modifier.
10859 This should be one of the symbols `alt', `hyper', `meta', `super'.
10860 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10861 default is nil, which is the same as `meta'. */);
10862 Vx_meta_keysym = Qnil;
10864 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10865 doc: /* Which keys Emacs uses for the super modifier.
10866 This should be one of the symbols `alt', `hyper', `meta', `super'.
10867 For example, `super' means use the Super_L and Super_R keysyms. The
10868 default is nil, which is the same as `super'. */);
10869 Vx_super_keysym = Qnil;
10871 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10872 doc: /* Hash table of character codes indexed by X keysym codes. */);
10873 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10874 make_float (DEFAULT_REHASH_SIZE),
10875 make_float (DEFAULT_REHASH_THRESHOLD),
10876 Qnil, Qnil, Qnil);
10879 #endif /* HAVE_X_WINDOWS */