* lisp/emacs-lisp/bytecomp.el (byte-compile): Fix handling of closures.
[emacs.git] / src / xterm.c
blob463d82b4ee207115bdb7f5a81d4621ddf5d07083
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, frame;
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_EACH_FRAME (tail, frame)
1457 f = XFRAME (frame);
1458 if (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, frame;
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_EACH_FRAME (tail, frame)
4109 Lisp_Object bar, condemned;
4111 if (! FRAME_X_P (XFRAME (frame)))
4112 continue;
4114 /* Scan this frame's scroll bar list for a scroll bar with the
4115 right window ID. */
4116 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4117 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4118 /* This trick allows us to search both the ordinary and
4119 condemned scroll bar lists with one loop. */
4120 ! NILP (bar) || (bar = condemned,
4121 condemned = Qnil,
4122 ! NILP (bar));
4123 bar = XSCROLL_BAR (bar)->next)
4124 if (XSCROLL_BAR (bar)->x_window == window_id &&
4125 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4126 return XSCROLL_BAR (bar);
4129 return NULL;
4133 #if defined USE_LUCID
4135 /* Return the Lucid menu bar WINDOW is part of. Return null
4136 if WINDOW is not part of a menu bar. */
4138 static Widget
4139 x_window_to_menu_bar (Window window)
4141 Lisp_Object tail, frame;
4143 FOR_EACH_FRAME (tail, frame)
4144 if (FRAME_X_P (XFRAME (frame)))
4146 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4148 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4149 return menu_bar;
4151 return NULL;
4154 #endif /* USE_LUCID */
4157 /************************************************************************
4158 Toolkit scroll bars
4159 ************************************************************************/
4161 #ifdef USE_TOOLKIT_SCROLL_BARS
4163 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4164 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4165 static void x_create_toolkit_scroll_bar (struct frame *,
4166 struct scroll_bar *);
4167 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4168 int, int, int);
4171 /* Lisp window being scrolled. Set when starting to interact with
4172 a toolkit scroll bar, reset to nil when ending the interaction. */
4174 static Lisp_Object window_being_scrolled;
4176 /* Last scroll bar part sent in xm_scroll_callback. */
4178 static int last_scroll_bar_part;
4180 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4181 that movements of 1/20 of the screen size are mapped to up/down. */
4183 #ifndef USE_GTK
4184 /* Id of action hook installed for scroll bars. */
4186 static XtActionHookId action_hook_id;
4188 static Boolean xaw3d_arrow_scroll;
4190 /* Whether the drag scrolling maintains the mouse at the top of the
4191 thumb. If not, resizing the thumb needs to be done more carefully
4192 to avoid jerkiness. */
4194 static Boolean xaw3d_pick_top;
4196 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4197 bars are used.. The hook is responsible for detecting when
4198 the user ends an interaction with the scroll bar, and generates
4199 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4201 static void
4202 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4203 XEvent *event, String *params, Cardinal *num_params)
4205 int scroll_bar_p;
4206 const char *end_action;
4208 #ifdef USE_MOTIF
4209 scroll_bar_p = XmIsScrollBar (widget);
4210 end_action = "Release";
4211 #else /* !USE_MOTIF i.e. use Xaw */
4212 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4213 end_action = "EndScroll";
4214 #endif /* USE_MOTIF */
4216 if (scroll_bar_p
4217 && strcmp (action_name, end_action) == 0
4218 && WINDOWP (window_being_scrolled))
4220 struct window *w;
4222 x_send_scroll_bar_event (window_being_scrolled,
4223 scroll_bar_end_scroll, 0, 0);
4224 w = XWINDOW (window_being_scrolled);
4226 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4228 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4229 /* The thumb size is incorrect while dragging: fix it. */
4230 set_vertical_scroll_bar (w);
4232 window_being_scrolled = Qnil;
4233 last_scroll_bar_part = -1;
4235 /* Xt timeouts no longer needed. */
4236 toolkit_scroll_bar_interaction = 0;
4239 #endif /* not USE_GTK */
4241 /* A vector of windows used for communication between
4242 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4244 static struct window **scroll_bar_windows;
4245 static ptrdiff_t scroll_bar_windows_size;
4248 /* Send a client message with message type Xatom_Scrollbar for a
4249 scroll action to the frame of WINDOW. PART is a value identifying
4250 the part of the scroll bar that was clicked on. PORTION is the
4251 amount to scroll of a whole of WHOLE. */
4253 static void
4254 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4256 XEvent event;
4257 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4258 struct window *w = XWINDOW (window);
4259 struct frame *f = XFRAME (w->frame);
4260 ptrdiff_t i;
4262 block_input ();
4264 /* Construct a ClientMessage event to send to the frame. */
4265 ev->type = ClientMessage;
4266 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4267 ev->display = FRAME_X_DISPLAY (f);
4268 ev->window = FRAME_X_WINDOW (f);
4269 ev->format = 32;
4271 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4272 not enough to store a pointer or Lisp_Object on a 64 bit system.
4273 So, store the window in scroll_bar_windows and pass the index
4274 into that array in the event. */
4275 for (i = 0; i < scroll_bar_windows_size; ++i)
4276 if (scroll_bar_windows[i] == NULL)
4277 break;
4279 if (i == scroll_bar_windows_size)
4281 ptrdiff_t old_nbytes =
4282 scroll_bar_windows_size * sizeof *scroll_bar_windows;
4283 ptrdiff_t nbytes;
4284 enum { XClientMessageEvent_MAX = 0x7fffffff };
4285 scroll_bar_windows =
4286 xpalloc (scroll_bar_windows, &scroll_bar_windows_size, 1,
4287 XClientMessageEvent_MAX, sizeof *scroll_bar_windows);
4288 nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4289 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4292 scroll_bar_windows[i] = w;
4293 ev->data.l[0] = (long) i;
4294 ev->data.l[1] = (long) part;
4295 ev->data.l[2] = (long) 0;
4296 ev->data.l[3] = (long) portion;
4297 ev->data.l[4] = (long) whole;
4299 /* Make Xt timeouts work while the scroll bar is active. */
4300 #ifdef USE_X_TOOLKIT
4301 toolkit_scroll_bar_interaction = 1;
4302 x_activate_timeout_atimer ();
4303 #endif
4305 /* Setting the event mask to zero means that the message will
4306 be sent to the client that created the window, and if that
4307 window no longer exists, no event will be sent. */
4308 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4309 unblock_input ();
4313 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4314 in *IEVENT. */
4316 static void
4317 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4319 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4320 Lisp_Object window;
4321 struct window *w;
4323 w = scroll_bar_windows[ev->data.l[0]];
4324 scroll_bar_windows[ev->data.l[0]] = NULL;
4326 XSETWINDOW (window, w);
4328 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4329 ievent->frame_or_window = window;
4330 ievent->arg = Qnil;
4331 #ifdef USE_GTK
4332 ievent->timestamp = CurrentTime;
4333 #else
4334 ievent->timestamp =
4335 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
4336 #endif
4337 ievent->part = ev->data.l[1];
4338 ievent->code = ev->data.l[2];
4339 ievent->x = make_number ((int) ev->data.l[3]);
4340 ievent->y = make_number ((int) ev->data.l[4]);
4341 ievent->modifiers = 0;
4345 #ifdef USE_MOTIF
4347 /* Minimum and maximum values used for Motif scroll bars. */
4349 #define XM_SB_MAX 10000000
4352 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4353 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4354 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4356 static void
4357 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4359 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4360 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4361 int part = -1, whole = 0, portion = 0;
4363 switch (cs->reason)
4365 case XmCR_DECREMENT:
4366 bar->dragging = Qnil;
4367 part = scroll_bar_up_arrow;
4368 break;
4370 case XmCR_INCREMENT:
4371 bar->dragging = Qnil;
4372 part = scroll_bar_down_arrow;
4373 break;
4375 case XmCR_PAGE_DECREMENT:
4376 bar->dragging = Qnil;
4377 part = scroll_bar_above_handle;
4378 break;
4380 case XmCR_PAGE_INCREMENT:
4381 bar->dragging = Qnil;
4382 part = scroll_bar_below_handle;
4383 break;
4385 case XmCR_TO_TOP:
4386 bar->dragging = Qnil;
4387 part = scroll_bar_to_top;
4388 break;
4390 case XmCR_TO_BOTTOM:
4391 bar->dragging = Qnil;
4392 part = scroll_bar_to_bottom;
4393 break;
4395 case XmCR_DRAG:
4397 int slider_size;
4399 /* Get the slider size. */
4400 block_input ();
4401 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4402 unblock_input ();
4404 whole = XM_SB_MAX - slider_size;
4405 portion = min (cs->value, whole);
4406 part = scroll_bar_handle;
4407 bar->dragging = make_number (cs->value);
4409 break;
4411 case XmCR_VALUE_CHANGED:
4412 break;
4415 if (part >= 0)
4417 window_being_scrolled = bar->window;
4418 last_scroll_bar_part = part;
4419 x_send_scroll_bar_event (bar->window, part, portion, whole);
4423 #elif defined USE_GTK
4425 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4426 bar widget. DATA is a pointer to the scroll_bar structure. */
4428 static gboolean
4429 xg_scroll_callback (GtkRange *range,
4430 GtkScrollType scroll,
4431 gdouble value,
4432 gpointer user_data)
4434 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4435 gdouble position;
4436 int part = -1, whole = 0, portion = 0;
4437 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4438 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4440 if (xg_ignore_gtk_scrollbar) return FALSE;
4441 position = gtk_adjustment_get_value (adj);
4444 switch (scroll)
4446 case GTK_SCROLL_JUMP:
4447 /* Buttons 1 2 or 3 must be grabbed. */
4448 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4449 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4451 part = scroll_bar_handle;
4452 whole = gtk_adjustment_get_upper (adj) -
4453 gtk_adjustment_get_page_size (adj);
4454 portion = min ((int)position, whole);
4455 bar->dragging = make_number ((int)portion);
4457 break;
4458 case GTK_SCROLL_STEP_BACKWARD:
4459 part = scroll_bar_up_arrow;
4460 bar->dragging = Qnil;
4461 break;
4462 case GTK_SCROLL_STEP_FORWARD:
4463 part = scroll_bar_down_arrow;
4464 bar->dragging = Qnil;
4465 break;
4466 case GTK_SCROLL_PAGE_BACKWARD:
4467 part = scroll_bar_above_handle;
4468 bar->dragging = Qnil;
4469 break;
4470 case GTK_SCROLL_PAGE_FORWARD:
4471 part = scroll_bar_below_handle;
4472 bar->dragging = Qnil;
4473 break;
4476 if (part >= 0)
4478 window_being_scrolled = bar->window;
4479 last_scroll_bar_part = part;
4480 x_send_scroll_bar_event (bar->window, part, portion, whole);
4483 return FALSE;
4486 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4488 static gboolean
4489 xg_end_scroll_callback (GtkWidget *widget,
4490 GdkEventButton *event,
4491 gpointer user_data)
4493 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4494 bar->dragging = Qnil;
4495 if (WINDOWP (window_being_scrolled))
4497 x_send_scroll_bar_event (window_being_scrolled,
4498 scroll_bar_end_scroll, 0, 0);
4499 window_being_scrolled = Qnil;
4502 return FALSE;
4506 #else /* not USE_GTK and not USE_MOTIF */
4508 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4509 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4510 scroll bar struct. CALL_DATA is a pointer to a float saying where
4511 the thumb is. */
4513 static void
4514 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4516 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4517 float top = *(float *) call_data;
4518 float shown;
4519 int whole, portion, height;
4520 int part;
4522 /* Get the size of the thumb, a value between 0 and 1. */
4523 block_input ();
4524 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4525 unblock_input ();
4527 whole = 10000000;
4528 portion = shown < 1 ? top * whole : 0;
4530 if (shown < 1 && (eabs (top + shown - 1) < 1.0f / height))
4531 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4532 the bottom, so we force the scrolling whenever we see that we're
4533 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4534 we try to ensure that we always stay two pixels away from the
4535 bottom). */
4536 part = scroll_bar_down_arrow;
4537 else
4538 part = scroll_bar_handle;
4540 window_being_scrolled = bar->window;
4541 bar->dragging = make_number (portion);
4542 last_scroll_bar_part = part;
4543 x_send_scroll_bar_event (bar->window, part, portion, whole);
4547 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4548 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4549 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4550 the scroll bar. CALL_DATA is an integer specifying the action that
4551 has taken place. Its magnitude is in the range 0..height of the
4552 scroll bar. Negative values mean scroll towards buffer start.
4553 Values < height of scroll bar mean line-wise movement. */
4555 static void
4556 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4558 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4559 /* The position really is stored cast to a pointer. */
4560 int position = (long) call_data;
4561 Dimension height;
4562 int part;
4564 /* Get the height of the scroll bar. */
4565 block_input ();
4566 XtVaGetValues (widget, XtNheight, &height, NULL);
4567 unblock_input ();
4569 if (eabs (position) >= height)
4570 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4572 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4573 it maps line-movement to call_data = max(5, height/20). */
4574 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4575 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4576 else
4577 part = scroll_bar_move_ratio;
4579 window_being_scrolled = bar->window;
4580 bar->dragging = Qnil;
4581 last_scroll_bar_part = part;
4582 x_send_scroll_bar_event (bar->window, part, position, height);
4585 #endif /* not USE_GTK and not USE_MOTIF */
4587 #define SCROLL_BAR_NAME "verticalScrollBar"
4589 /* Create the widget for scroll bar BAR on frame F. Record the widget
4590 and X window of the scroll bar in BAR. */
4592 #ifdef USE_GTK
4593 static void
4594 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4596 const char *scroll_bar_name = SCROLL_BAR_NAME;
4598 block_input ();
4599 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4600 G_CALLBACK (xg_end_scroll_callback),
4601 scroll_bar_name);
4602 unblock_input ();
4605 #else /* not USE_GTK */
4607 static void
4608 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4610 Window xwindow;
4611 Widget widget;
4612 Arg av[20];
4613 int ac = 0;
4614 const char *scroll_bar_name = SCROLL_BAR_NAME;
4615 unsigned long pixel;
4617 block_input ();
4619 #ifdef USE_MOTIF
4620 /* Set resources. Create the widget. */
4621 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4622 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4623 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4624 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4625 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4626 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4627 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4629 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4630 if (pixel != -1)
4632 XtSetArg (av[ac], XmNforeground, pixel);
4633 ++ac;
4636 pixel = f->output_data.x->scroll_bar_background_pixel;
4637 if (pixel != -1)
4639 XtSetArg (av[ac], XmNbackground, pixel);
4640 ++ac;
4643 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4644 (char *) scroll_bar_name, av, ac);
4646 /* Add one callback for everything that can happen. */
4647 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4648 (XtPointer) bar);
4649 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4650 (XtPointer) bar);
4651 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4652 (XtPointer) bar);
4653 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4654 (XtPointer) bar);
4655 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4656 (XtPointer) bar);
4657 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4658 (XtPointer) bar);
4659 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4660 (XtPointer) bar);
4662 /* Realize the widget. Only after that is the X window created. */
4663 XtRealizeWidget (widget);
4665 /* Set the cursor to an arrow. I didn't find a resource to do that.
4666 And I'm wondering why it hasn't an arrow cursor by default. */
4667 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4668 f->output_data.x->nontext_cursor);
4670 #else /* !USE_MOTIF i.e. use Xaw */
4672 /* Set resources. Create the widget. The background of the
4673 Xaw3d scroll bar widget is a little bit light for my taste.
4674 We don't alter it here to let users change it according
4675 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4676 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4677 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4678 /* For smoother scrolling with Xaw3d -sm */
4679 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4681 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4682 if (pixel != -1)
4684 XtSetArg (av[ac], XtNforeground, pixel);
4685 ++ac;
4688 pixel = f->output_data.x->scroll_bar_background_pixel;
4689 if (pixel != -1)
4691 XtSetArg (av[ac], XtNbackground, pixel);
4692 ++ac;
4695 /* Top/bottom shadow colors. */
4697 /* Allocate them, if necessary. */
4698 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4700 pixel = f->output_data.x->scroll_bar_background_pixel;
4701 if (pixel != -1)
4703 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4704 FRAME_X_COLORMAP (f),
4705 &pixel, 1.2, 0x8000))
4706 pixel = -1;
4707 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4710 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4712 pixel = f->output_data.x->scroll_bar_background_pixel;
4713 if (pixel != -1)
4715 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4716 FRAME_X_COLORMAP (f),
4717 &pixel, 0.6, 0x4000))
4718 pixel = -1;
4719 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4723 #ifdef XtNbeNiceToColormap
4724 /* Tell the toolkit about them. */
4725 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4726 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4727 /* We tried to allocate a color for the top/bottom shadow, and
4728 failed, so tell Xaw3d to use dithering instead. */
4729 /* But only if we have a small colormap. Xaw3d can allocate nice
4730 colors itself. */
4732 XtSetArg (av[ac], XtNbeNiceToColormap,
4733 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4734 ++ac;
4736 else
4737 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4738 be more consistent with other emacs 3d colors, and since Xaw3d is
4739 not good at dealing with allocation failure. */
4741 /* This tells Xaw3d to use real colors instead of dithering for
4742 the shadows. */
4743 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4744 ++ac;
4746 /* Specify the colors. */
4747 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4748 if (pixel != -1)
4750 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4751 ++ac;
4753 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4754 if (pixel != -1)
4756 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4757 ++ac;
4760 #endif
4762 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4763 f->output_data.x->edit_widget, av, ac);
4766 char const *initial = "";
4767 char const *val = initial;
4768 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4769 #ifdef XtNarrowScrollbars
4770 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4771 #endif
4772 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4773 if (xaw3d_arrow_scroll || val == initial)
4774 { /* ARROW_SCROLL */
4775 xaw3d_arrow_scroll = True;
4776 /* Isn't that just a personal preference ? --Stef */
4777 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4781 /* Define callbacks. */
4782 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4783 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4784 (XtPointer) bar);
4786 /* Realize the widget. Only after that is the X window created. */
4787 XtRealizeWidget (widget);
4789 #endif /* !USE_MOTIF */
4791 /* Install an action hook that lets us detect when the user
4792 finishes interacting with a scroll bar. */
4793 if (action_hook_id == 0)
4794 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4796 /* Remember X window and widget in the scroll bar vector. */
4797 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4798 xwindow = XtWindow (widget);
4799 bar->x_window = xwindow;
4801 unblock_input ();
4803 #endif /* not USE_GTK */
4806 /* Set the thumb size and position of scroll bar BAR. We are currently
4807 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4809 #ifdef USE_GTK
4810 static void
4811 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4813 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4816 #else /* not USE_GTK */
4817 static void
4818 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4819 int whole)
4821 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4822 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4823 float top, shown;
4825 block_input ();
4827 #ifdef USE_MOTIF
4829 /* We use an estimate of 30 chars per line rather than the real
4830 `portion' value. This has the disadvantage that the thumb size
4831 is not very representative, but it makes our life a lot easier.
4832 Otherwise, we have to constantly adjust the thumb size, which
4833 we can't always do quickly enough: while dragging, the size of
4834 the thumb might prevent the user from dragging the thumb all the
4835 way to the end. but Motif and some versions of Xaw3d don't allow
4836 updating the thumb size while dragging. Also, even if we can update
4837 its size, the update will often happen too late.
4838 If you don't believe it, check out revision 1.650 of xterm.c to see
4839 what hoops we were going through and the still poor behavior we got. */
4840 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4841 /* When the thumb is at the bottom, position == whole.
4842 So we need to increase `whole' to make space for the thumb. */
4843 whole += portion;
4845 if (whole <= 0)
4846 top = 0, shown = 1;
4847 else
4849 top = (float) position / whole;
4850 shown = (float) portion / whole;
4853 if (NILP (bar->dragging))
4855 int size, value;
4857 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4858 is the scroll bar's maximum and MIN is the scroll bar's minimum
4859 value. */
4860 size = shown * XM_SB_MAX;
4861 size = min (size, XM_SB_MAX);
4862 size = max (size, 1);
4864 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4865 value = top * XM_SB_MAX;
4866 value = min (value, XM_SB_MAX - size);
4868 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4870 #else /* !USE_MOTIF i.e. use Xaw */
4872 if (whole == 0)
4873 top = 0, shown = 1;
4874 else
4876 top = (float) position / whole;
4877 shown = (float) portion / whole;
4881 float old_top, old_shown;
4882 Dimension height;
4883 XtVaGetValues (widget,
4884 XtNtopOfThumb, &old_top,
4885 XtNshown, &old_shown,
4886 XtNheight, &height,
4887 NULL);
4889 /* Massage the top+shown values. */
4890 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4891 top = max (0, min (1, top));
4892 else
4893 top = old_top;
4894 /* Keep two pixels available for moving the thumb down. */
4895 shown = max (0, min (1 - top - (2.0f / height), shown));
4897 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4898 check that your system's configuration file contains a define
4899 for `NARROWPROTO'. See s/freebsd.h for an example. */
4900 if (top != old_top || shown != old_shown)
4902 if (NILP (bar->dragging))
4903 XawScrollbarSetThumb (widget, top, shown);
4904 else
4906 /* Try to make the scrolling a tad smoother. */
4907 if (!xaw3d_pick_top)
4908 shown = min (shown, old_shown);
4910 XawScrollbarSetThumb (widget, top, shown);
4914 #endif /* !USE_MOTIF */
4916 unblock_input ();
4918 #endif /* not USE_GTK */
4920 #endif /* USE_TOOLKIT_SCROLL_BARS */
4924 /************************************************************************
4925 Scroll bars, general
4926 ************************************************************************/
4928 /* Create a scroll bar and return the scroll bar vector for it. W is
4929 the Emacs window on which to create the scroll bar. TOP, LEFT,
4930 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4931 scroll bar. */
4933 static struct scroll_bar *
4934 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4936 struct frame *f = XFRAME (w->frame);
4937 struct scroll_bar *bar
4938 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4939 Lisp_Object barobj;
4941 block_input ();
4943 #ifdef USE_TOOLKIT_SCROLL_BARS
4944 x_create_toolkit_scroll_bar (f, bar);
4945 #else /* not USE_TOOLKIT_SCROLL_BARS */
4947 XSetWindowAttributes a;
4948 unsigned long mask;
4949 Window window;
4951 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4952 if (a.background_pixel == -1)
4953 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4955 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4956 | ButtonMotionMask | PointerMotionHintMask
4957 | ExposureMask);
4958 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4960 mask = (CWBackPixel | CWEventMask | CWCursor);
4962 /* Clear the area of W that will serve as a scroll bar. This is
4963 for the case that a window has been split horizontally. In
4964 this case, no clear_frame is generated to reduce flickering. */
4965 if (width > 0 && height > 0)
4966 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4967 left, top, width,
4968 window_box_height (w), False);
4970 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4971 /* Position and size of scroll bar. */
4972 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4973 top,
4974 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4975 height,
4976 /* Border width, depth, class, and visual. */
4978 CopyFromParent,
4979 CopyFromParent,
4980 CopyFromParent,
4981 /* Attributes. */
4982 mask, &a);
4983 bar->x_window = window;
4985 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4987 XSETWINDOW (bar->window, w);
4988 bar->top = top;
4989 bar->left = left;
4990 bar->width = width;
4991 bar->height = height;
4992 bar->start = 0;
4993 bar->end = 0;
4994 bar->dragging = Qnil;
4995 bar->fringe_extended_p = 0;
4997 /* Add bar to its frame's list of scroll bars. */
4998 bar->next = FRAME_SCROLL_BARS (f);
4999 bar->prev = Qnil;
5000 XSETVECTOR (barobj, bar);
5001 fset_scroll_bars (f, barobj);
5002 if (!NILP (bar->next))
5003 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5005 /* Map the window/widget. */
5006 #ifdef USE_TOOLKIT_SCROLL_BARS
5008 #ifdef USE_GTK
5009 xg_update_scrollbar_pos (f,
5010 bar->x_window,
5011 top,
5012 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5013 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5014 max (height, 1));
5015 #else /* not USE_GTK */
5016 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
5017 XtConfigureWidget (scroll_bar,
5018 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5019 top,
5020 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5021 max (height, 1), 0);
5022 XtMapWidget (scroll_bar);
5023 #endif /* not USE_GTK */
5025 #else /* not USE_TOOLKIT_SCROLL_BARS */
5026 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
5027 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5029 unblock_input ();
5030 return bar;
5034 #ifndef USE_TOOLKIT_SCROLL_BARS
5036 /* Draw BAR's handle in the proper position.
5038 If the handle is already drawn from START to END, don't bother
5039 redrawing it, unless REBUILD is non-zero; in that case, always
5040 redraw it. (REBUILD is handy for drawing the handle after expose
5041 events.)
5043 Normally, we want to constrain the start and end of the handle to
5044 fit inside its rectangle, but if the user is dragging the scroll
5045 bar handle, we want to let them drag it down all the way, so that
5046 the bar's top is as far down as it goes; otherwise, there's no way
5047 to move to the very end of the buffer. */
5049 static void
5050 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
5052 int dragging = ! NILP (bar->dragging);
5053 Window w = bar->x_window;
5054 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5055 GC gc = f->output_data.x->normal_gc;
5057 /* If the display is already accurate, do nothing. */
5058 if (! rebuild
5059 && start == bar->start
5060 && end == bar->end)
5061 return;
5063 block_input ();
5066 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5067 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5068 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5070 /* Make sure the values are reasonable, and try to preserve
5071 the distance between start and end. */
5073 int length = end - start;
5075 if (start < 0)
5076 start = 0;
5077 else if (start > top_range)
5078 start = top_range;
5079 end = start + length;
5081 if (end < start)
5082 end = start;
5083 else if (end > top_range && ! dragging)
5084 end = top_range;
5087 /* Store the adjusted setting in the scroll bar. */
5088 bar->start = start;
5089 bar->end = end;
5091 /* Clip the end position, just for display. */
5092 if (end > top_range)
5093 end = top_range;
5095 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5096 below top positions, to make sure the handle is always at least
5097 that many pixels tall. */
5098 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5100 /* Draw the empty space above the handle. Note that we can't clear
5101 zero-height areas; that means "clear to end of window." */
5102 if (0 < start)
5103 x_clear_area (FRAME_X_DISPLAY (f), w,
5104 /* x, y, width, height, and exposures. */
5105 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5106 VERTICAL_SCROLL_BAR_TOP_BORDER,
5107 inside_width, start,
5108 False);
5110 /* Change to proper foreground color if one is specified. */
5111 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5112 XSetForeground (FRAME_X_DISPLAY (f), gc,
5113 f->output_data.x->scroll_bar_foreground_pixel);
5115 /* Draw the handle itself. */
5116 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5117 /* x, y, width, height */
5118 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5119 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5120 inside_width, end - start);
5122 /* Restore the foreground color of the GC if we changed it above. */
5123 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5124 XSetForeground (FRAME_X_DISPLAY (f), gc,
5125 FRAME_FOREGROUND_PIXEL (f));
5127 /* Draw the empty space below the handle. Note that we can't
5128 clear zero-height areas; that means "clear to end of window." */
5129 if (end < inside_height)
5130 x_clear_area (FRAME_X_DISPLAY (f), w,
5131 /* x, y, width, height, and exposures. */
5132 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5133 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5134 inside_width, inside_height - end,
5135 False);
5139 unblock_input ();
5142 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5144 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5145 nil. */
5147 static void
5148 x_scroll_bar_remove (struct scroll_bar *bar)
5150 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5151 block_input ();
5153 #ifdef USE_TOOLKIT_SCROLL_BARS
5154 #ifdef USE_GTK
5155 xg_remove_scroll_bar (f, bar->x_window);
5156 #else /* not USE_GTK */
5157 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5158 #endif /* not USE_GTK */
5159 #else
5160 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5161 #endif
5163 /* Dissociate this scroll bar from its window. */
5164 wset_vertical_scroll_bar (XWINDOW (bar->window), Qnil);
5166 unblock_input ();
5170 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5171 that we are displaying PORTION characters out of a total of WHOLE
5172 characters, starting at POSITION. If WINDOW has no scroll bar,
5173 create one. */
5175 static void
5176 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5178 struct frame *f = XFRAME (w->frame);
5179 Lisp_Object barobj;
5180 struct scroll_bar *bar;
5181 int top, height, left, sb_left, width, sb_width;
5182 int window_y, window_height;
5183 #ifdef USE_TOOLKIT_SCROLL_BARS
5184 int fringe_extended_p;
5185 #endif
5187 /* Get window dimensions. */
5188 window_box (w, -1, 0, &window_y, 0, &window_height);
5189 top = window_y;
5190 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5191 height = window_height;
5193 /* Compute the left edge of the scroll bar area. */
5194 left = WINDOW_SCROLL_BAR_AREA_X (w);
5196 /* Compute the width of the scroll bar which might be less than
5197 the width of the area reserved for the scroll bar. */
5198 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5199 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5200 else
5201 sb_width = width;
5203 /* Compute the left edge of the scroll bar. */
5204 #ifdef USE_TOOLKIT_SCROLL_BARS
5205 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5206 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5207 else
5208 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5209 #else
5210 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5211 sb_left = left + width - sb_width;
5212 else
5213 sb_left = left;
5214 #endif
5216 #ifdef USE_TOOLKIT_SCROLL_BARS
5217 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5218 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5219 && WINDOW_LEFT_FRINGE_WIDTH (w)
5220 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5221 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5222 else
5223 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5224 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5225 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5226 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5227 #endif
5229 /* Does the scroll bar exist yet? */
5230 if (NILP (w->vertical_scroll_bar))
5232 if (width > 0 && height > 0)
5234 block_input ();
5235 #ifdef USE_TOOLKIT_SCROLL_BARS
5236 if (fringe_extended_p)
5237 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5238 sb_left, top, sb_width, height, False);
5239 else
5240 #endif
5241 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5242 left, top, width, height, False);
5243 unblock_input ();
5246 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5248 else
5250 /* It may just need to be moved and resized. */
5251 unsigned int mask = 0;
5253 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5255 block_input ();
5257 if (sb_left != bar->left)
5258 mask |= CWX;
5259 if (top != bar->top)
5260 mask |= CWY;
5261 if (sb_width != bar->width)
5262 mask |= CWWidth;
5263 if (height != bar->height)
5264 mask |= CWHeight;
5266 #ifdef USE_TOOLKIT_SCROLL_BARS
5268 /* Move/size the scroll bar widget. */
5269 if (mask || bar->fringe_extended_p != fringe_extended_p)
5271 /* Since toolkit scroll bars are smaller than the space reserved
5272 for them on the frame, we have to clear "under" them. */
5273 if (width > 0 && height > 0)
5275 if (fringe_extended_p)
5276 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5277 sb_left, top, sb_width, height, False);
5278 else
5279 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5280 left, top, width, height, False);
5282 #ifdef USE_GTK
5283 xg_update_scrollbar_pos (f,
5284 bar->x_window,
5285 top,
5286 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5287 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5288 max (height, 1));
5289 #else /* not USE_GTK */
5290 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5291 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5292 top,
5293 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5294 max (height, 1), 0);
5295 #endif /* not USE_GTK */
5297 #else /* not USE_TOOLKIT_SCROLL_BARS */
5299 /* Clear areas not covered by the scroll bar because of
5300 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5301 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5303 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5304 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5305 height, False);
5306 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5307 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5308 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5309 height, False);
5312 /* Clear areas not covered by the scroll bar because it's not as
5313 wide as the area reserved for it. This makes sure a
5314 previous mode line display is cleared after C-x 2 C-x 1, for
5315 example. */
5317 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5318 int rest = area_width - sb_width;
5319 if (rest > 0 && height > 0)
5321 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5322 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5323 left + area_width - rest, top,
5324 rest, height, False);
5325 else
5326 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5327 left, top, rest, height, False);
5331 /* Move/size the scroll bar window. */
5332 if (mask)
5334 XWindowChanges wc;
5336 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5337 wc.y = top;
5338 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5339 wc.height = height;
5340 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5341 mask, &wc);
5344 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5346 /* Remember new settings. */
5347 bar->left = sb_left;
5348 bar->top = top;
5349 bar->width = sb_width;
5350 bar->height = height;
5352 unblock_input ();
5355 #ifdef USE_TOOLKIT_SCROLL_BARS
5356 bar->fringe_extended_p = fringe_extended_p;
5358 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5359 #else /* not USE_TOOLKIT_SCROLL_BARS */
5360 /* Set the scroll bar's current state, unless we're currently being
5361 dragged. */
5362 if (NILP (bar->dragging))
5364 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5366 if (whole == 0)
5367 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5368 else
5370 int start = ((double) position * top_range) / whole;
5371 int end = ((double) (position + portion) * top_range) / whole;
5372 x_scroll_bar_set_handle (bar, start, end, 0);
5375 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5377 XSETVECTOR (barobj, bar);
5378 wset_vertical_scroll_bar (w, barobj);
5382 /* The following three hooks are used when we're doing a thorough
5383 redisplay of the frame. We don't explicitly know which scroll bars
5384 are going to be deleted, because keeping track of when windows go
5385 away is a real pain - "Can you say set-window-configuration, boys
5386 and girls?" Instead, we just assert at the beginning of redisplay
5387 that *all* scroll bars are to be removed, and then save a scroll bar
5388 from the fiery pit when we actually redisplay its window. */
5390 /* Arrange for all scroll bars on FRAME to be removed at the next call
5391 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5392 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5394 static void
5395 XTcondemn_scroll_bars (FRAME_PTR frame)
5397 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5398 while (! NILP (FRAME_SCROLL_BARS (frame)))
5400 Lisp_Object bar;
5401 bar = FRAME_SCROLL_BARS (frame);
5402 fset_scroll_bars (frame, XSCROLL_BAR (bar)->next);
5403 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5404 XSCROLL_BAR (bar)->prev = Qnil;
5405 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5406 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5407 fset_condemned_scroll_bars (frame, bar);
5412 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5413 Note that WINDOW isn't necessarily condemned at all. */
5415 static void
5416 XTredeem_scroll_bar (struct window *window)
5418 struct scroll_bar *bar;
5419 struct frame *f;
5420 Lisp_Object barobj;
5422 /* We can't redeem this window's scroll bar if it doesn't have one. */
5423 if (NILP (window->vertical_scroll_bar))
5424 emacs_abort ();
5426 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5428 /* Unlink it from the condemned list. */
5429 f = XFRAME (WINDOW_FRAME (window));
5430 if (NILP (bar->prev))
5432 /* If the prev pointer is nil, it must be the first in one of
5433 the lists. */
5434 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5435 /* It's not condemned. Everything's fine. */
5436 return;
5437 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5438 window->vertical_scroll_bar))
5439 fset_condemned_scroll_bars (f, bar->next);
5440 else
5441 /* If its prev pointer is nil, it must be at the front of
5442 one or the other! */
5443 emacs_abort ();
5445 else
5446 XSCROLL_BAR (bar->prev)->next = bar->next;
5448 if (! NILP (bar->next))
5449 XSCROLL_BAR (bar->next)->prev = bar->prev;
5451 bar->next = FRAME_SCROLL_BARS (f);
5452 bar->prev = Qnil;
5453 XSETVECTOR (barobj, bar);
5454 fset_scroll_bars (f, barobj);
5455 if (! NILP (bar->next))
5456 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5459 /* Remove all scroll bars on FRAME that haven't been saved since the
5460 last call to `*condemn_scroll_bars_hook'. */
5462 static void
5463 XTjudge_scroll_bars (FRAME_PTR f)
5465 Lisp_Object bar, next;
5467 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5469 /* Clear out the condemned list now so we won't try to process any
5470 more events on the hapless scroll bars. */
5471 fset_condemned_scroll_bars (f, Qnil);
5473 for (; ! NILP (bar); bar = next)
5475 struct scroll_bar *b = XSCROLL_BAR (bar);
5477 x_scroll_bar_remove (b);
5479 next = b->next;
5480 b->next = b->prev = Qnil;
5483 /* Now there should be no references to the condemned scroll bars,
5484 and they should get garbage-collected. */
5488 #ifndef USE_TOOLKIT_SCROLL_BARS
5489 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5490 is a no-op when using toolkit scroll bars.
5492 This may be called from a signal handler, so we have to ignore GC
5493 mark bits. */
5495 static void
5496 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5498 Window w = bar->x_window;
5499 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5500 GC gc = f->output_data.x->normal_gc;
5501 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5503 block_input ();
5505 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5507 /* Switch to scroll bar foreground color. */
5508 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5509 XSetForeground (FRAME_X_DISPLAY (f), gc,
5510 f->output_data.x->scroll_bar_foreground_pixel);
5512 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5513 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5515 /* x, y, width, height */
5516 0, 0,
5517 bar->width - 1 - width_trim - width_trim,
5518 bar->height - 1);
5520 /* Restore the foreground color of the GC if we changed it above. */
5521 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5522 XSetForeground (FRAME_X_DISPLAY (f), gc,
5523 FRAME_FOREGROUND_PIXEL (f));
5525 unblock_input ();
5528 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5530 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5531 is set to something other than NO_EVENT, it is enqueued.
5533 This may be called from a signal handler, so we have to ignore GC
5534 mark bits. */
5537 static void
5538 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5540 if (! WINDOWP (bar->window))
5541 emacs_abort ();
5543 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5544 emacs_event->code = event->xbutton.button - Button1;
5545 emacs_event->modifiers
5546 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5547 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5548 event->xbutton.state)
5549 | (event->type == ButtonRelease
5550 ? up_modifier
5551 : down_modifier));
5552 emacs_event->frame_or_window = bar->window;
5553 emacs_event->arg = Qnil;
5554 emacs_event->timestamp = event->xbutton.time;
5556 int top_range
5557 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5558 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5560 if (y < 0) y = 0;
5561 if (y > top_range) y = top_range;
5563 if (y < bar->start)
5564 emacs_event->part = scroll_bar_above_handle;
5565 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5566 emacs_event->part = scroll_bar_handle;
5567 else
5568 emacs_event->part = scroll_bar_below_handle;
5570 #ifndef USE_TOOLKIT_SCROLL_BARS
5571 /* If the user has released the handle, set it to its final position. */
5572 if (event->type == ButtonRelease
5573 && ! NILP (bar->dragging))
5575 int new_start = y - XINT (bar->dragging);
5576 int new_end = new_start + bar->end - bar->start;
5578 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5579 bar->dragging = Qnil;
5581 #endif
5583 XSETINT (emacs_event->x, y);
5584 XSETINT (emacs_event->y, top_range);
5588 #ifndef USE_TOOLKIT_SCROLL_BARS
5590 /* Handle some mouse motion while someone is dragging the scroll bar.
5592 This may be called from a signal handler, so we have to ignore GC
5593 mark bits. */
5595 static void
5596 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5598 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5600 last_mouse_movement_time = event->xmotion.time;
5602 f->mouse_moved = 1;
5603 XSETVECTOR (last_mouse_scroll_bar, bar);
5605 /* If we're dragging the bar, display it. */
5606 if (! NILP (bar->dragging))
5608 /* Where should the handle be now? */
5609 int new_start = event->xmotion.y - XINT (bar->dragging);
5611 if (new_start != bar->start)
5613 int new_end = new_start + bar->end - bar->start;
5615 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5620 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5622 /* Return information to the user about the current position of the mouse
5623 on the scroll bar. */
5625 static void
5626 x_scroll_bar_report_motion (FRAME_PTR *fp, Lisp_Object *bar_window,
5627 enum scroll_bar_part *part, Lisp_Object *x,
5628 Lisp_Object *y, Time *timestamp)
5630 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5631 Window w = bar->x_window;
5632 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5633 int win_x, win_y;
5634 Window dummy_window;
5635 int dummy_coord;
5636 unsigned int dummy_mask;
5638 block_input ();
5640 /* Get the mouse's position relative to the scroll bar window, and
5641 report that. */
5642 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5644 /* Root, child, root x and root y. */
5645 &dummy_window, &dummy_window,
5646 &dummy_coord, &dummy_coord,
5648 /* Position relative to scroll bar. */
5649 &win_x, &win_y,
5651 /* Mouse buttons and modifier keys. */
5652 &dummy_mask))
5654 else
5656 int top_range
5657 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5659 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5661 if (! NILP (bar->dragging))
5662 win_y -= XINT (bar->dragging);
5664 if (win_y < 0)
5665 win_y = 0;
5666 if (win_y > top_range)
5667 win_y = top_range;
5669 *fp = f;
5670 *bar_window = bar->window;
5672 if (! NILP (bar->dragging))
5673 *part = scroll_bar_handle;
5674 else if (win_y < bar->start)
5675 *part = scroll_bar_above_handle;
5676 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5677 *part = scroll_bar_handle;
5678 else
5679 *part = scroll_bar_below_handle;
5681 XSETINT (*x, win_y);
5682 XSETINT (*y, top_range);
5684 f->mouse_moved = 0;
5685 last_mouse_scroll_bar = Qnil;
5688 *timestamp = last_mouse_movement_time;
5690 unblock_input ();
5694 /* The screen has been cleared so we may have changed foreground or
5695 background colors, and the scroll bars may need to be redrawn.
5696 Clear out the scroll bars, and ask for expose events, so we can
5697 redraw them. */
5699 static void
5700 x_scroll_bar_clear (FRAME_PTR f)
5702 #ifndef USE_TOOLKIT_SCROLL_BARS
5703 Lisp_Object bar;
5705 /* We can have scroll bars even if this is 0,
5706 if we just turned off scroll bar mode.
5707 But in that case we should not clear them. */
5708 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5709 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5710 bar = XSCROLL_BAR (bar)->next)
5711 XClearArea (FRAME_X_DISPLAY (f),
5712 XSCROLL_BAR (bar)->x_window,
5713 0, 0, 0, 0, True);
5714 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5718 /* The main X event-reading loop - XTread_socket. */
5720 /* This holds the state XLookupString needs to implement dead keys
5721 and other tricks known as "compose processing". _X Window System_
5722 says that a portable program can't use this, but Stephen Gildea assures
5723 me that letting the compiler initialize it to zeros will work okay.
5725 This must be defined outside of XTread_socket, for the same reasons
5726 given for enter_timestamp, above. */
5728 static XComposeStatus compose_status;
5730 /* Record the last 100 characters stored
5731 to help debug the loss-of-chars-during-GC problem. */
5733 static int temp_index;
5734 static short temp_buffer[100];
5736 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5737 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5738 temp_index = 0; \
5739 temp_buffer[temp_index++] = (keysym)
5741 /* Set this to nonzero to fake an "X I/O error"
5742 on a particular display. */
5744 static struct x_display_info *XTread_socket_fake_io_error;
5746 /* When we find no input here, we occasionally do a no-op command
5747 to verify that the X server is still running and we can still talk with it.
5748 We try all the open displays, one by one.
5749 This variable is used for cycling thru the displays. */
5751 static struct x_display_info *next_noop_dpyinfo;
5753 #if defined USE_X_TOOLKIT || defined USE_GTK
5754 #define SET_SAVED_BUTTON_EVENT \
5755 do \
5757 if (f->output_data.x->saved_menu_event == 0) \
5758 f->output_data.x->saved_menu_event = \
5759 xmalloc (sizeof (XEvent)); \
5760 *f->output_data.x->saved_menu_event = event; \
5761 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5762 XSETFRAME (inev.ie.frame_or_window, f); \
5764 while (0)
5765 #endif
5767 enum
5769 X_EVENT_NORMAL,
5770 X_EVENT_GOTO_OUT,
5771 X_EVENT_DROP
5774 /* Filter events for the current X input method.
5775 DPYINFO is the display this event is for.
5776 EVENT is the X event to filter.
5778 Returns non-zero if the event was filtered, caller shall not process
5779 this event further.
5780 Returns zero if event is wasn't filtered. */
5782 #ifdef HAVE_X_I18N
5783 static int
5784 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5786 /* XFilterEvent returns non-zero if the input method has
5787 consumed the event. We pass the frame's X window to
5788 XFilterEvent because that's the one for which the IC
5789 was created. */
5791 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5792 event->xclient.window);
5794 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5796 #endif
5798 #ifdef USE_GTK
5799 static int current_count;
5800 static int current_finish;
5801 static struct input_event *current_hold_quit;
5803 /* This is the filter function invoked by the GTK event loop.
5804 It is invoked before the XEvent is translated to a GdkEvent,
5805 so we have a chance to act on the event before GTK. */
5806 static GdkFilterReturn
5807 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5809 XEvent *xev = (XEvent *) gxev;
5811 block_input ();
5812 if (current_count >= 0)
5814 struct x_display_info *dpyinfo;
5816 dpyinfo = x_display_info_for_display (xev->xany.display);
5818 #ifdef HAVE_X_I18N
5819 /* Filter events for the current X input method.
5820 GTK calls XFilterEvent but not for key press and release,
5821 so we do it here. */
5822 if ((xev->type == KeyPress || xev->type == KeyRelease)
5823 && dpyinfo
5824 && x_filter_event (dpyinfo, xev))
5826 unblock_input ();
5827 return GDK_FILTER_REMOVE;
5829 #endif
5831 if (! dpyinfo)
5832 current_finish = X_EVENT_NORMAL;
5833 else
5834 current_count +=
5835 handle_one_xevent (dpyinfo, xev, &current_finish,
5836 current_hold_quit);
5838 else
5839 current_finish = x_dispatch_event (xev, xev->xany.display);
5841 unblock_input ();
5843 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5844 return GDK_FILTER_REMOVE;
5846 return GDK_FILTER_CONTINUE;
5848 #endif /* USE_GTK */
5851 static void xembed_send_message (struct frame *f, Time,
5852 enum xembed_message,
5853 long detail, long data1, long data2);
5855 /* Handles the XEvent EVENT on display DPYINFO.
5857 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5858 *FINISH is zero if caller should continue reading events.
5859 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5861 We return the number of characters stored into the buffer. */
5863 static int
5864 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventptr,
5865 int *finish, struct input_event *hold_quit)
5867 union {
5868 struct input_event ie;
5869 struct selection_input_event sie;
5870 } inev;
5871 int count = 0;
5872 int do_help = 0;
5873 ptrdiff_t nbytes = 0;
5874 struct frame *f = NULL;
5875 struct coding_system coding;
5876 XEvent event = *eventptr;
5877 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5878 USE_SAFE_ALLOCA;
5880 *finish = X_EVENT_NORMAL;
5882 EVENT_INIT (inev.ie);
5883 inev.ie.kind = NO_EVENT;
5884 inev.ie.arg = Qnil;
5886 if (pending_event_wait.eventtype == event.type)
5887 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5889 switch (event.type)
5891 case ClientMessage:
5893 if (event.xclient.message_type
5894 == dpyinfo->Xatom_wm_protocols
5895 && event.xclient.format == 32)
5897 if (event.xclient.data.l[0]
5898 == dpyinfo->Xatom_wm_take_focus)
5900 /* Use x_any_window_to_frame because this
5901 could be the shell widget window
5902 if the frame has no title bar. */
5903 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5904 #ifdef HAVE_X_I18N
5905 /* Not quite sure this is needed -pd */
5906 if (f && FRAME_XIC (f))
5907 XSetICFocus (FRAME_XIC (f));
5908 #endif
5909 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5910 instructs the WM to set the input focus automatically for
5911 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5912 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5913 it has set the focus. So, XSetInputFocus below is not
5914 needed.
5916 The call to XSetInputFocus below has also caused trouble. In
5917 cases where the XSetInputFocus done by the WM and the one
5918 below are temporally close (on a fast machine), the call
5919 below can generate additional FocusIn events which confuse
5920 Emacs. */
5922 /* Since we set WM_TAKE_FOCUS, we must call
5923 XSetInputFocus explicitly. But not if f is null,
5924 since that might be an event for a deleted frame. */
5925 if (f)
5927 Display *d = event.xclient.display;
5928 /* Catch and ignore errors, in case window has been
5929 iconified by a window manager such as GWM. */
5930 x_catch_errors (d);
5931 XSetInputFocus (d, event.xclient.window,
5932 /* The ICCCM says this is
5933 the only valid choice. */
5934 RevertToParent,
5935 event.xclient.data.l[1]);
5936 /* This is needed to detect the error
5937 if there is an error. */
5938 XSync (d, False);
5939 x_uncatch_errors ();
5941 /* Not certain about handling scroll bars here */
5942 #endif /* 0 */
5943 goto done;
5946 if (event.xclient.data.l[0]
5947 == dpyinfo->Xatom_wm_save_yourself)
5949 /* Save state modify the WM_COMMAND property to
5950 something which can reinstate us. This notifies
5951 the session manager, who's looking for such a
5952 PropertyNotify. Can restart processing when
5953 a keyboard or mouse event arrives. */
5954 /* If we have a session manager, don't set this.
5955 KDE will then start two Emacsen, one for the
5956 session manager and one for this. */
5957 #ifdef HAVE_X_SM
5958 if (! x_session_have_connection ())
5959 #endif
5961 f = x_top_window_to_frame (dpyinfo,
5962 event.xclient.window);
5963 /* This is just so we only give real data once
5964 for a single Emacs process. */
5965 if (f == SELECTED_FRAME ())
5966 XSetCommand (FRAME_X_DISPLAY (f),
5967 event.xclient.window,
5968 initial_argv, initial_argc);
5969 else if (f)
5970 XSetCommand (FRAME_X_DISPLAY (f),
5971 event.xclient.window,
5972 0, 0);
5974 goto done;
5977 if (event.xclient.data.l[0]
5978 == dpyinfo->Xatom_wm_delete_window)
5980 f = x_any_window_to_frame (dpyinfo,
5981 event.xclient.window);
5982 if (!f)
5983 goto OTHER; /* May be a dialog that is to be removed */
5985 inev.ie.kind = DELETE_WINDOW_EVENT;
5986 XSETFRAME (inev.ie.frame_or_window, f);
5987 goto done;
5990 goto done;
5993 if (event.xclient.message_type
5994 == dpyinfo->Xatom_wm_configure_denied)
5996 goto done;
5999 if (event.xclient.message_type
6000 == dpyinfo->Xatom_wm_window_moved)
6002 int new_x, new_y;
6003 f = x_window_to_frame (dpyinfo, event.xclient.window);
6005 new_x = event.xclient.data.s[0];
6006 new_y = event.xclient.data.s[1];
6008 if (f)
6010 f->left_pos = new_x;
6011 f->top_pos = new_y;
6013 goto done;
6016 #ifdef HACK_EDITRES
6017 if (event.xclient.message_type
6018 == dpyinfo->Xatom_editres)
6020 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6021 if (f)
6022 _XEditResCheckMessages (f->output_data.x->widget, NULL,
6023 &event, NULL);
6024 goto done;
6026 #endif /* HACK_EDITRES */
6028 if ((event.xclient.message_type
6029 == dpyinfo->Xatom_DONE)
6030 || (event.xclient.message_type
6031 == dpyinfo->Xatom_PAGE))
6033 /* Ghostview job completed. Kill it. We could
6034 reply with "Next" if we received "Page", but we
6035 currently never do because we are interested in
6036 images, only, which should have 1 page. */
6037 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6038 f = x_window_to_frame (dpyinfo, event.xclient.window);
6039 if (!f)
6040 goto OTHER;
6041 x_kill_gs_process (pixmap, f);
6042 expose_frame (f, 0, 0, 0, 0);
6043 goto done;
6046 #ifdef USE_TOOLKIT_SCROLL_BARS
6047 /* Scroll bar callbacks send a ClientMessage from which
6048 we construct an input_event. */
6049 if (event.xclient.message_type
6050 == dpyinfo->Xatom_Scrollbar)
6052 x_scroll_bar_to_input_event (&event, &inev.ie);
6053 *finish = X_EVENT_GOTO_OUT;
6054 goto done;
6056 #endif /* USE_TOOLKIT_SCROLL_BARS */
6058 /* XEmbed messages from the embedder (if any). */
6059 if (event.xclient.message_type
6060 == dpyinfo->Xatom_XEMBED)
6062 enum xembed_message msg = event.xclient.data.l[1];
6063 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6064 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6066 *finish = X_EVENT_GOTO_OUT;
6067 goto done;
6070 xft_settings_event (dpyinfo, &event);
6072 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6073 if (!f)
6074 goto OTHER;
6075 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6076 *finish = X_EVENT_DROP;
6078 break;
6080 case SelectionNotify:
6081 last_user_time = event.xselection.time;
6082 #ifdef USE_X_TOOLKIT
6083 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6084 goto OTHER;
6085 #endif /* not USE_X_TOOLKIT */
6086 x_handle_selection_notify (&event.xselection);
6087 break;
6089 case SelectionClear: /* Someone has grabbed ownership. */
6090 last_user_time = event.xselectionclear.time;
6091 #ifdef USE_X_TOOLKIT
6092 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6093 goto OTHER;
6094 #endif /* USE_X_TOOLKIT */
6096 XSelectionClearEvent *eventp = &(event.xselectionclear);
6098 inev.ie.kind = SELECTION_CLEAR_EVENT;
6099 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6100 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6101 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6103 break;
6105 case SelectionRequest: /* Someone wants our selection. */
6106 last_user_time = event.xselectionrequest.time;
6107 #ifdef USE_X_TOOLKIT
6108 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6109 goto OTHER;
6110 #endif /* USE_X_TOOLKIT */
6112 XSelectionRequestEvent *eventp = &(event.xselectionrequest);
6114 inev.ie.kind = SELECTION_REQUEST_EVENT;
6115 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6116 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6117 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6118 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6119 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6120 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6122 break;
6124 case PropertyNotify:
6125 last_user_time = event.xproperty.time;
6126 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6127 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6128 if (x_handle_net_wm_state (f, &event.xproperty) && f->iconified
6129 && f->output_data.x->net_wm_state_hidden_seen)
6131 /* Gnome shell does not iconify us when C-z is pressed. It hides
6132 the frame. So if our state says we aren't hidden anymore,
6133 treat it as deiconified. */
6134 if (! f->async_iconified)
6135 SET_FRAME_GARBAGED (f);
6136 f->async_visible = 1;
6137 f->async_iconified = 0;
6138 f->output_data.x->has_been_visible = 1;
6139 f->output_data.x->net_wm_state_hidden_seen = 0;
6140 inev.ie.kind = DEICONIFY_EVENT;
6141 XSETFRAME (inev.ie.frame_or_window, f);
6144 x_handle_property_notify (&event.xproperty);
6145 xft_settings_event (dpyinfo, &event);
6146 goto OTHER;
6148 case ReparentNotify:
6149 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6150 if (f)
6152 int x, y;
6153 f->output_data.x->parent_desc = event.xreparent.parent;
6154 x_real_positions (f, &x, &y);
6155 f->left_pos = x;
6156 f->top_pos = y;
6158 /* Perhaps reparented due to a WM restart. Reset this. */
6159 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6160 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6162 x_set_frame_alpha (f);
6164 goto OTHER;
6166 case Expose:
6167 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6168 if (f)
6170 #ifdef USE_GTK
6171 /* This seems to be needed for GTK 2.6. */
6172 x_clear_area (event.xexpose.display,
6173 event.xexpose.window,
6174 event.xexpose.x, event.xexpose.y,
6175 event.xexpose.width, event.xexpose.height,
6176 FALSE);
6177 #endif
6178 if (f->async_visible == 0)
6180 f->async_visible = 1;
6181 f->async_iconified = 0;
6182 f->output_data.x->has_been_visible = 1;
6183 SET_FRAME_GARBAGED (f);
6185 else
6186 expose_frame (f,
6187 event.xexpose.x, event.xexpose.y,
6188 event.xexpose.width, event.xexpose.height);
6190 else
6192 #ifndef USE_TOOLKIT_SCROLL_BARS
6193 struct scroll_bar *bar;
6194 #endif
6195 #if defined USE_LUCID
6196 /* Submenus of the Lucid menu bar aren't widgets
6197 themselves, so there's no way to dispatch events
6198 to them. Recognize this case separately. */
6200 Widget widget
6201 = x_window_to_menu_bar (event.xexpose.window);
6202 if (widget)
6203 xlwmenu_redisplay (widget);
6205 #endif /* USE_LUCID */
6207 #ifdef USE_TOOLKIT_SCROLL_BARS
6208 /* Dispatch event to the widget. */
6209 goto OTHER;
6210 #else /* not USE_TOOLKIT_SCROLL_BARS */
6211 bar = x_window_to_scroll_bar (event.xexpose.display,
6212 event.xexpose.window);
6214 if (bar)
6215 x_scroll_bar_expose (bar, &event);
6216 #ifdef USE_X_TOOLKIT
6217 else
6218 goto OTHER;
6219 #endif /* USE_X_TOOLKIT */
6220 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6222 break;
6224 case GraphicsExpose: /* This occurs when an XCopyArea's
6225 source area was obscured or not
6226 available. */
6227 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6228 if (f)
6230 expose_frame (f,
6231 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6232 event.xgraphicsexpose.width,
6233 event.xgraphicsexpose.height);
6235 #ifdef USE_X_TOOLKIT
6236 else
6237 goto OTHER;
6238 #endif /* USE_X_TOOLKIT */
6239 break;
6241 case NoExpose: /* This occurs when an XCopyArea's
6242 source area was completely
6243 available. */
6244 break;
6246 case UnmapNotify:
6247 /* Redo the mouse-highlight after the tooltip has gone. */
6248 if (event.xmap.window == tip_window)
6250 tip_window = 0;
6251 redo_mouse_highlight ();
6254 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6255 if (f) /* F may no longer exist if
6256 the frame was deleted. */
6258 /* While a frame is unmapped, display generation is
6259 disabled; you don't want to spend time updating a
6260 display that won't ever be seen. */
6261 f->async_visible = 0;
6262 /* We can't distinguish, from the event, whether the window
6263 has become iconified or invisible. So assume, if it
6264 was previously visible, than now it is iconified.
6265 But x_make_frame_invisible clears both
6266 the visible flag and the iconified flag;
6267 and that way, we know the window is not iconified now. */
6268 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6270 f->async_iconified = 1;
6272 inev.ie.kind = ICONIFY_EVENT;
6273 XSETFRAME (inev.ie.frame_or_window, f);
6276 goto OTHER;
6278 case MapNotify:
6279 if (event.xmap.window == tip_window)
6280 /* The tooltip has been drawn already. Avoid
6281 the SET_FRAME_GARBAGED below. */
6282 goto OTHER;
6284 /* We use x_top_window_to_frame because map events can
6285 come for sub-windows and they don't mean that the
6286 frame is visible. */
6287 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6288 if (f)
6290 /* wait_reading_process_output will notice this and update
6291 the frame's display structures.
6292 If we where iconified, we should not set garbaged,
6293 because that stops redrawing on Expose events. This looks
6294 bad if we are called from a recursive event loop
6295 (x_dispatch_event), for example when a dialog is up. */
6296 if (! f->async_iconified)
6297 SET_FRAME_GARBAGED (f);
6299 /* Check if fullscreen was specified before we where mapped the
6300 first time, i.e. from the command line. */
6301 if (!f->output_data.x->has_been_visible)
6302 x_check_fullscreen (f);
6304 f->async_visible = 1;
6305 f->async_iconified = 0;
6306 f->output_data.x->has_been_visible = 1;
6308 if (f->iconified)
6310 inev.ie.kind = DEICONIFY_EVENT;
6311 XSETFRAME (inev.ie.frame_or_window, f);
6313 else if (! NILP (Vframe_list)
6314 && ! NILP (XCDR (Vframe_list)))
6315 /* Force a redisplay sooner or later
6316 to update the frame titles
6317 in case this is the second frame. */
6318 record_asynch_buffer_change ();
6320 #ifdef USE_GTK
6321 xg_frame_resized (f, -1, -1);
6322 #endif
6324 goto OTHER;
6326 case KeyPress:
6328 last_user_time = event.xkey.time;
6329 ignore_next_mouse_click_timeout = 0;
6331 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6332 /* Dispatch KeyPress events when in menu. */
6333 if (popup_activated ())
6334 goto OTHER;
6335 #endif
6337 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6339 /* If mouse-highlight is an integer, input clears out
6340 mouse highlighting. */
6341 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6342 && (f == 0
6343 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6345 clear_mouse_face (hlinfo);
6346 hlinfo->mouse_face_hidden = 1;
6349 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6350 if (f == 0)
6352 /* Scroll bars consume key events, but we want
6353 the keys to go to the scroll bar's frame. */
6354 Widget widget = XtWindowToWidget (dpyinfo->display,
6355 event.xkey.window);
6356 if (widget && XmIsScrollBar (widget))
6358 widget = XtParent (widget);
6359 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6362 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6364 if (f != 0)
6366 KeySym keysym, orig_keysym;
6367 /* al%imercury@uunet.uu.net says that making this 81
6368 instead of 80 fixed a bug whereby meta chars made
6369 his Emacs hang.
6371 It seems that some version of XmbLookupString has
6372 a bug of not returning XBufferOverflow in
6373 status_return even if the input is too long to
6374 fit in 81 bytes. So, we must prepare sufficient
6375 bytes for copy_buffer. 513 bytes (256 chars for
6376 two-byte character set) seems to be a fairly good
6377 approximation. -- 2000.8.10 handa@etl.go.jp */
6378 unsigned char copy_buffer[513];
6379 unsigned char *copy_bufptr = copy_buffer;
6380 int copy_bufsiz = sizeof (copy_buffer);
6381 int modifiers;
6382 Lisp_Object coding_system = Qlatin_1;
6383 Lisp_Object c;
6385 #ifdef USE_GTK
6386 /* Don't pass keys to GTK. A Tab will shift focus to the
6387 tool bar in GTK 2.4. Keys will still go to menus and
6388 dialogs because in that case popup_activated is TRUE
6389 (see above). */
6390 *finish = X_EVENT_DROP;
6391 #endif
6393 event.xkey.state
6394 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6395 extra_keyboard_modifiers);
6396 modifiers = event.xkey.state;
6398 /* This will have to go some day... */
6400 /* make_lispy_event turns chars into control chars.
6401 Don't do it here because XLookupString is too eager. */
6402 event.xkey.state &= ~ControlMask;
6403 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6404 | dpyinfo->super_mod_mask
6405 | dpyinfo->hyper_mod_mask
6406 | dpyinfo->alt_mod_mask);
6408 /* In case Meta is ComposeCharacter,
6409 clear its status. According to Markus Ehrnsperger
6410 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6411 this enables ComposeCharacter to work whether or
6412 not it is combined with Meta. */
6413 if (modifiers & dpyinfo->meta_mod_mask)
6414 memset (&compose_status, 0, sizeof (compose_status));
6416 #ifdef HAVE_X_I18N
6417 if (FRAME_XIC (f))
6419 Status status_return;
6421 coding_system = Vlocale_coding_system;
6422 nbytes = XmbLookupString (FRAME_XIC (f),
6423 &event.xkey, (char *) copy_bufptr,
6424 copy_bufsiz, &keysym,
6425 &status_return);
6426 if (status_return == XBufferOverflow)
6428 copy_bufsiz = nbytes + 1;
6429 copy_bufptr = alloca (copy_bufsiz);
6430 nbytes = XmbLookupString (FRAME_XIC (f),
6431 &event.xkey, (char *) copy_bufptr,
6432 copy_bufsiz, &keysym,
6433 &status_return);
6435 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6436 if (status_return == XLookupNone)
6437 break;
6438 else if (status_return == XLookupChars)
6440 keysym = NoSymbol;
6441 modifiers = 0;
6443 else if (status_return != XLookupKeySym
6444 && status_return != XLookupBoth)
6445 emacs_abort ();
6447 else
6448 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6449 copy_bufsiz, &keysym,
6450 &compose_status);
6451 #else
6452 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6453 copy_bufsiz, &keysym,
6454 &compose_status);
6455 #endif
6457 /* If not using XIM/XIC, and a compose sequence is in progress,
6458 we break here. Otherwise, chars_matched is always 0. */
6459 if (compose_status.chars_matched > 0 && nbytes == 0)
6460 break;
6462 memset (&compose_status, 0, sizeof (compose_status));
6463 orig_keysym = keysym;
6465 /* Common for all keysym input events. */
6466 XSETFRAME (inev.ie.frame_or_window, f);
6467 inev.ie.modifiers
6468 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6469 inev.ie.timestamp = event.xkey.time;
6471 /* First deal with keysyms which have defined
6472 translations to characters. */
6473 if (keysym >= 32 && keysym < 128)
6474 /* Avoid explicitly decoding each ASCII character. */
6476 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6477 inev.ie.code = keysym;
6478 goto done_keysym;
6481 /* Keysyms directly mapped to Unicode characters. */
6482 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6484 if (keysym < 0x01000080)
6485 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6486 else
6487 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6488 inev.ie.code = keysym & 0xFFFFFF;
6489 goto done_keysym;
6492 /* Now non-ASCII. */
6493 if (HASH_TABLE_P (Vx_keysym_table)
6494 && (c = Fgethash (make_number (keysym),
6495 Vx_keysym_table,
6496 Qnil),
6497 NATNUMP (c)))
6499 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6500 ? ASCII_KEYSTROKE_EVENT
6501 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6502 inev.ie.code = XFASTINT (c);
6503 goto done_keysym;
6506 /* Random non-modifier sorts of keysyms. */
6507 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6508 || keysym == XK_Delete
6509 #ifdef XK_ISO_Left_Tab
6510 || (keysym >= XK_ISO_Left_Tab
6511 && keysym <= XK_ISO_Enter)
6512 #endif
6513 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6514 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6515 #ifdef HPUX
6516 /* This recognizes the "extended function
6517 keys". It seems there's no cleaner way.
6518 Test IsModifierKey to avoid handling
6519 mode_switch incorrectly. */
6520 || (XK_Select <= keysym && keysym < XK_KP_Space)
6521 #endif
6522 #ifdef XK_dead_circumflex
6523 || orig_keysym == XK_dead_circumflex
6524 #endif
6525 #ifdef XK_dead_grave
6526 || orig_keysym == XK_dead_grave
6527 #endif
6528 #ifdef XK_dead_tilde
6529 || orig_keysym == XK_dead_tilde
6530 #endif
6531 #ifdef XK_dead_diaeresis
6532 || orig_keysym == XK_dead_diaeresis
6533 #endif
6534 #ifdef XK_dead_macron
6535 || orig_keysym == XK_dead_macron
6536 #endif
6537 #ifdef XK_dead_degree
6538 || orig_keysym == XK_dead_degree
6539 #endif
6540 #ifdef XK_dead_acute
6541 || orig_keysym == XK_dead_acute
6542 #endif
6543 #ifdef XK_dead_cedilla
6544 || orig_keysym == XK_dead_cedilla
6545 #endif
6546 #ifdef XK_dead_breve
6547 || orig_keysym == XK_dead_breve
6548 #endif
6549 #ifdef XK_dead_ogonek
6550 || orig_keysym == XK_dead_ogonek
6551 #endif
6552 #ifdef XK_dead_caron
6553 || orig_keysym == XK_dead_caron
6554 #endif
6555 #ifdef XK_dead_doubleacute
6556 || orig_keysym == XK_dead_doubleacute
6557 #endif
6558 #ifdef XK_dead_abovedot
6559 || orig_keysym == XK_dead_abovedot
6560 #endif
6561 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6562 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6563 /* Any "vendor-specific" key is ok. */
6564 || (orig_keysym & (1 << 28))
6565 || (keysym != NoSymbol && nbytes == 0))
6566 && ! (IsModifierKey (orig_keysym)
6567 /* The symbols from XK_ISO_Lock
6568 to XK_ISO_Last_Group_Lock
6569 don't have real modifiers but
6570 should be treated similarly to
6571 Mode_switch by Emacs. */
6572 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6573 || (XK_ISO_Lock <= orig_keysym
6574 && orig_keysym <= XK_ISO_Last_Group_Lock)
6575 #endif
6578 STORE_KEYSYM_FOR_DEBUG (keysym);
6579 /* make_lispy_event will convert this to a symbolic
6580 key. */
6581 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6582 inev.ie.code = keysym;
6583 goto done_keysym;
6586 { /* Raw bytes, not keysym. */
6587 ptrdiff_t i;
6588 int nchars, len;
6590 for (i = 0, nchars = 0; i < nbytes; i++)
6592 if (ASCII_BYTE_P (copy_bufptr[i]))
6593 nchars++;
6594 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6597 if (nchars < nbytes)
6599 /* Decode the input data. */
6601 /* The input should be decoded with `coding_system'
6602 which depends on which X*LookupString function
6603 we used just above and the locale. */
6604 setup_coding_system (coding_system, &coding);
6605 coding.src_multibyte = 0;
6606 coding.dst_multibyte = 1;
6607 /* The input is converted to events, thus we can't
6608 handle composition. Anyway, there's no XIM that
6609 gives us composition information. */
6610 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6612 SAFE_NALLOCA (coding.destination, MAX_MULTIBYTE_LENGTH,
6613 nbytes);
6614 coding.dst_bytes = MAX_MULTIBYTE_LENGTH * nbytes;
6615 coding.mode |= CODING_MODE_LAST_BLOCK;
6616 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6617 nbytes = coding.produced;
6618 nchars = coding.produced_char;
6619 copy_bufptr = coding.destination;
6622 /* Convert the input data to a sequence of
6623 character events. */
6624 for (i = 0; i < nbytes; i += len)
6626 int ch;
6627 if (nchars == nbytes)
6628 ch = copy_bufptr[i], len = 1;
6629 else
6630 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6631 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
6632 ? ASCII_KEYSTROKE_EVENT
6633 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6634 inev.ie.code = ch;
6635 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6638 count += nchars;
6640 inev.ie.kind = NO_EVENT; /* Already stored above. */
6642 if (keysym == NoSymbol)
6643 break;
6646 done_keysym:
6647 #ifdef HAVE_X_I18N
6648 /* Don't dispatch this event since XtDispatchEvent calls
6649 XFilterEvent, and two calls in a row may freeze the
6650 client. */
6651 break;
6652 #else
6653 goto OTHER;
6654 #endif
6656 case KeyRelease:
6657 last_user_time = event.xkey.time;
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 EnterNotify:
6668 last_user_time = event.xcrossing.time;
6669 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6671 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6673 if (f && x_mouse_click_focus_ignore_position)
6674 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6676 /* EnterNotify counts as mouse movement,
6677 so update things that depend on mouse position. */
6678 if (f && !f->output_data.x->hourglass_p)
6679 note_mouse_movement (f, &event.xmotion);
6680 #ifdef USE_GTK
6681 /* We may get an EnterNotify on the buttons in the toolbar. In that
6682 case we moved out of any highlighted area and need to note this. */
6683 if (!f && last_mouse_glyph_frame)
6684 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6685 #endif
6686 goto OTHER;
6688 case FocusIn:
6689 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6690 goto OTHER;
6692 case LeaveNotify:
6693 last_user_time = event.xcrossing.time;
6694 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6696 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6697 if (f)
6699 if (f == hlinfo->mouse_face_mouse_frame)
6701 /* If we move outside the frame, then we're
6702 certainly no longer on any text in the frame. */
6703 clear_mouse_face (hlinfo);
6704 hlinfo->mouse_face_mouse_frame = 0;
6707 /* Generate a nil HELP_EVENT to cancel a help-echo.
6708 Do it only if there's something to cancel.
6709 Otherwise, the startup message is cleared when
6710 the mouse leaves the frame. */
6711 if (any_help_event_p)
6712 do_help = -1;
6714 #ifdef USE_GTK
6715 /* See comment in EnterNotify above */
6716 else if (last_mouse_glyph_frame)
6717 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6718 #endif
6719 goto OTHER;
6721 case FocusOut:
6722 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6723 goto OTHER;
6725 case MotionNotify:
6727 last_user_time = event.xmotion.time;
6728 previous_help_echo_string = help_echo_string;
6729 help_echo_string = Qnil;
6731 if (dpyinfo->grabbed && last_mouse_frame
6732 && FRAME_LIVE_P (last_mouse_frame))
6733 f = last_mouse_frame;
6734 else
6735 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6737 if (hlinfo->mouse_face_hidden)
6739 hlinfo->mouse_face_hidden = 0;
6740 clear_mouse_face (hlinfo);
6743 #ifdef USE_GTK
6744 if (f && xg_event_is_for_scrollbar (f, &event))
6745 f = 0;
6746 #endif
6747 if (f)
6750 /* Generate SELECT_WINDOW_EVENTs when needed.
6751 Don't let popup menus influence things (bug#1261). */
6752 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6754 Lisp_Object window;
6756 window = window_from_coordinates (f,
6757 event.xmotion.x, event.xmotion.y,
6758 0, 0);
6760 /* Window will be selected only when it is not selected now and
6761 last mouse movement event was not in it. Minibuffer window
6762 will be selected only when it is active. */
6763 if (WINDOWP (window)
6764 && !EQ (window, last_window)
6765 && !EQ (window, selected_window)
6766 /* For click-to-focus window managers
6767 create event iff we don't leave the
6768 selected frame. */
6769 && (focus_follows_mouse
6770 || (EQ (XWINDOW (window)->frame,
6771 XWINDOW (selected_window)->frame))))
6773 inev.ie.kind = SELECT_WINDOW_EVENT;
6774 inev.ie.frame_or_window = window;
6777 last_window=window;
6779 if (!note_mouse_movement (f, &event.xmotion))
6780 help_echo_string = previous_help_echo_string;
6782 else
6784 #ifndef USE_TOOLKIT_SCROLL_BARS
6785 struct scroll_bar *bar
6786 = x_window_to_scroll_bar (event.xmotion.display,
6787 event.xmotion.window);
6789 if (bar)
6790 x_scroll_bar_note_movement (bar, &event);
6791 #endif /* USE_TOOLKIT_SCROLL_BARS */
6793 /* If we move outside the frame, then we're
6794 certainly no longer on any text in the frame. */
6795 clear_mouse_face (hlinfo);
6798 /* If the contents of the global variable help_echo_string
6799 has changed, generate a HELP_EVENT. */
6800 if (!NILP (help_echo_string)
6801 || !NILP (previous_help_echo_string))
6802 do_help = 1;
6803 goto OTHER;
6806 case ConfigureNotify:
6807 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6808 #ifdef USE_GTK
6809 if (!f
6810 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6811 && event.xconfigure.window == FRAME_X_WINDOW (f))
6813 xg_frame_resized (f, event.xconfigure.width,
6814 event.xconfigure.height);
6815 f = 0;
6817 #endif
6818 if (f)
6820 #ifndef USE_X_TOOLKIT
6821 #ifndef USE_GTK
6822 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6823 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6825 /* In the toolkit version, change_frame_size
6826 is called by the code that handles resizing
6827 of the EmacsFrame widget. */
6829 /* Even if the number of character rows and columns has
6830 not changed, the font size may have changed, so we need
6831 to check the pixel dimensions as well. */
6832 if (columns != FRAME_COLS (f)
6833 || rows != FRAME_LINES (f)
6834 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6835 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6837 change_frame_size (f, rows, columns, 0, 1, 0);
6838 SET_FRAME_GARBAGED (f);
6839 cancel_mouse_face (f);
6842 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6843 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6844 #endif /* not USE_GTK */
6845 #endif
6847 #ifdef USE_GTK
6848 /* GTK creates windows but doesn't map them.
6849 Only get real positions when mapped. */
6850 if (FRAME_GTK_OUTER_WIDGET (f)
6851 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6852 #endif
6854 x_real_positions (f, &f->left_pos, &f->top_pos);
6857 #ifdef HAVE_X_I18N
6858 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6859 xic_set_statusarea (f);
6860 #endif
6863 goto OTHER;
6865 case ButtonRelease:
6866 case ButtonPress:
6868 /* If we decide we want to generate an event to be seen
6869 by the rest of Emacs, we put it here. */
6870 int tool_bar_p = 0;
6872 memset (&compose_status, 0, sizeof (compose_status));
6873 last_mouse_glyph_frame = 0;
6874 last_user_time = event.xbutton.time;
6876 if (dpyinfo->grabbed
6877 && last_mouse_frame
6878 && FRAME_LIVE_P (last_mouse_frame))
6879 f = last_mouse_frame;
6880 else
6881 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6883 #ifdef USE_GTK
6884 if (f && xg_event_is_for_scrollbar (f, &event))
6885 f = 0;
6886 #endif
6887 if (f)
6889 /* Is this in the tool-bar? */
6890 if (WINDOWP (f->tool_bar_window)
6891 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6893 Lisp_Object window;
6894 int x = event.xbutton.x;
6895 int y = event.xbutton.y;
6897 window = window_from_coordinates (f, x, y, 0, 1);
6898 tool_bar_p = EQ (window, f->tool_bar_window);
6900 if (tool_bar_p && event.xbutton.button < 4)
6902 handle_tool_bar_click (f, x, y,
6903 event.xbutton.type == ButtonPress,
6904 x_x_to_emacs_modifiers (dpyinfo,
6905 event.xbutton.state));
6909 if (!tool_bar_p)
6910 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6911 if (! popup_activated ())
6912 #endif
6914 if (ignore_next_mouse_click_timeout)
6916 if (event.type == ButtonPress
6917 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6919 ignore_next_mouse_click_timeout = 0;
6920 construct_mouse_click (&inev.ie, &event.xbutton, f);
6922 if (event.type == ButtonRelease)
6923 ignore_next_mouse_click_timeout = 0;
6925 else
6926 construct_mouse_click (&inev.ie, &event.xbutton, f);
6928 if (FRAME_X_EMBEDDED_P (f))
6929 xembed_send_message (f, event.xbutton.time,
6930 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6932 else
6934 struct scroll_bar *bar
6935 = x_window_to_scroll_bar (event.xbutton.display,
6936 event.xbutton.window);
6938 #ifdef USE_TOOLKIT_SCROLL_BARS
6939 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6940 scroll bars. */
6941 if (bar && event.xbutton.state & ControlMask)
6943 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6944 *finish = X_EVENT_DROP;
6946 #else /* not USE_TOOLKIT_SCROLL_BARS */
6947 if (bar)
6948 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6949 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6952 if (event.type == ButtonPress)
6954 dpyinfo->grabbed |= (1 << event.xbutton.button);
6955 last_mouse_frame = f;
6957 if (!tool_bar_p)
6958 last_tool_bar_item = -1;
6960 else
6961 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6963 /* Ignore any mouse motion that happened before this event;
6964 any subsequent mouse-movement Emacs events should reflect
6965 only motion after the ButtonPress/Release. */
6966 if (f != 0)
6967 f->mouse_moved = 0;
6969 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6970 f = x_menubar_window_to_frame (dpyinfo, &event);
6971 /* For a down-event in the menu bar,
6972 don't pass it to Xt right now.
6973 Instead, save it away
6974 and we will pass it to Xt from kbd_buffer_get_event.
6975 That way, we can run some Lisp code first. */
6976 if (! popup_activated ()
6977 #ifdef USE_GTK
6978 /* Gtk+ menus only react to the first three buttons. */
6979 && event.xbutton.button < 3
6980 #endif
6981 && f && event.type == ButtonPress
6982 /* Verify the event is really within the menu bar
6983 and not just sent to it due to grabbing. */
6984 && event.xbutton.x >= 0
6985 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6986 && event.xbutton.y >= 0
6987 && event.xbutton.y < f->output_data.x->menubar_height
6988 && event.xbutton.same_screen)
6990 SET_SAVED_BUTTON_EVENT;
6991 XSETFRAME (last_mouse_press_frame, f);
6992 *finish = X_EVENT_DROP;
6994 else if (event.type == ButtonPress)
6996 last_mouse_press_frame = Qnil;
6997 goto OTHER;
6999 else
7000 goto OTHER;
7001 #endif /* USE_X_TOOLKIT || USE_GTK */
7003 break;
7005 case CirculateNotify:
7006 goto OTHER;
7008 case CirculateRequest:
7009 goto OTHER;
7011 case VisibilityNotify:
7012 goto OTHER;
7014 case MappingNotify:
7015 /* Someone has changed the keyboard mapping - update the
7016 local cache. */
7017 switch (event.xmapping.request)
7019 case MappingModifier:
7020 x_find_modifier_meanings (dpyinfo);
7021 /* This is meant to fall through. */
7022 case MappingKeyboard:
7023 XRefreshKeyboardMapping (&event.xmapping);
7025 goto OTHER;
7027 case DestroyNotify:
7028 xft_settings_event (dpyinfo, &event);
7029 break;
7031 default:
7032 OTHER:
7033 #ifdef USE_X_TOOLKIT
7034 block_input ();
7035 if (*finish != X_EVENT_DROP)
7036 XtDispatchEvent (&event);
7037 unblock_input ();
7038 #endif /* USE_X_TOOLKIT */
7039 break;
7042 done:
7043 if (inev.ie.kind != NO_EVENT)
7045 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7046 count++;
7049 if (do_help
7050 && !(hold_quit && hold_quit->kind != NO_EVENT))
7052 Lisp_Object frame;
7054 if (f)
7055 XSETFRAME (frame, f);
7056 else
7057 frame = Qnil;
7059 if (do_help > 0)
7061 any_help_event_p = 1;
7062 gen_help_event (help_echo_string, frame, help_echo_window,
7063 help_echo_object, help_echo_pos);
7065 else
7067 help_echo_string = Qnil;
7068 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7070 count++;
7073 SAFE_FREE ();
7074 *eventptr = event;
7075 return count;
7078 #if defined USE_GTK || defined USE_X_TOOLKIT
7080 /* Handles the XEvent EVENT on display DISPLAY.
7081 This is used for event loops outside the normal event handling,
7082 i.e. looping while a popup menu or a dialog is posted.
7084 Returns the value handle_one_xevent sets in the finish argument. */
7086 x_dispatch_event (XEvent *event, Display *display)
7088 struct x_display_info *dpyinfo;
7089 int finish = X_EVENT_NORMAL;
7091 dpyinfo = x_display_info_for_display (display);
7093 if (dpyinfo)
7094 handle_one_xevent (dpyinfo, event, &finish, 0);
7096 return finish;
7098 #endif
7101 /* Read events coming from the X server.
7102 Return as soon as there are no more events to be read.
7104 Return the number of characters stored into the buffer,
7105 thus pretending to be `read' (except the characters we store
7106 in the keyboard buffer can be multibyte, so are not necessarily
7107 C chars). */
7109 static int
7110 XTread_socket (struct terminal *terminal, struct input_event *hold_quit)
7112 int count = 0;
7113 int event_found = 0;
7115 block_input ();
7117 /* So people can tell when we have read the available input. */
7118 input_signal_count++;
7120 /* For debugging, this gives a way to fake an I/O error. */
7121 if (terminal->display_info.x == XTread_socket_fake_io_error)
7123 XTread_socket_fake_io_error = 0;
7124 x_io_error_quitter (terminal->display_info.x->display);
7127 #ifndef USE_GTK
7128 while (XPending (terminal->display_info.x->display))
7130 int finish;
7131 XEvent event;
7133 XNextEvent (terminal->display_info.x->display, &event);
7135 #ifdef HAVE_X_I18N
7136 /* Filter events for the current X input method. */
7137 if (x_filter_event (terminal->display_info.x, &event))
7138 continue;
7139 #endif
7140 event_found = 1;
7142 count += handle_one_xevent (terminal->display_info.x,
7143 &event, &finish, hold_quit);
7145 if (finish == X_EVENT_GOTO_OUT)
7146 goto out;
7149 out:;
7151 #else /* USE_GTK */
7153 /* For GTK we must use the GTK event loop. But XEvents gets passed
7154 to our filter function above, and then to the big event switch.
7155 We use a bunch of globals to communicate with our filter function,
7156 that is kind of ugly, but it works.
7158 There is no way to do one display at the time, GTK just does events
7159 from all displays. */
7161 while (gtk_events_pending ())
7163 current_count = count;
7164 current_hold_quit = hold_quit;
7166 gtk_main_iteration ();
7168 count = current_count;
7169 current_count = -1;
7170 current_hold_quit = 0;
7172 if (current_finish == X_EVENT_GOTO_OUT)
7173 break;
7175 #endif /* USE_GTK */
7177 /* On some systems, an X bug causes Emacs to get no more events
7178 when the window is destroyed. Detect that. (1994.) */
7179 if (! event_found)
7181 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7182 One XNOOP in 100 loops will make Emacs terminate.
7183 B. Bretthauer, 1994 */
7184 x_noop_count++;
7185 if (x_noop_count >= 100)
7187 x_noop_count=0;
7189 if (next_noop_dpyinfo == 0)
7190 next_noop_dpyinfo = x_display_list;
7192 XNoOp (next_noop_dpyinfo->display);
7194 /* Each time we get here, cycle through the displays now open. */
7195 next_noop_dpyinfo = next_noop_dpyinfo->next;
7199 /* If the focus was just given to an auto-raising frame,
7200 raise it now. */
7201 /* ??? This ought to be able to handle more than one such frame. */
7202 if (pending_autoraise_frame)
7204 x_raise_frame (pending_autoraise_frame);
7205 pending_autoraise_frame = 0;
7208 unblock_input ();
7210 return count;
7216 /***********************************************************************
7217 Text Cursor
7218 ***********************************************************************/
7220 /* Set clipping for output in glyph row ROW. W is the window in which
7221 we operate. GC is the graphics context to set clipping in.
7223 ROW may be a text row or, e.g., a mode line. Text rows must be
7224 clipped to the interior of the window dedicated to text display,
7225 mode lines must be clipped to the whole window. */
7227 static void
7228 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7230 struct frame *f = XFRAME (WINDOW_FRAME (w));
7231 XRectangle clip_rect;
7232 int window_x, window_y, window_width;
7234 window_box (w, area, &window_x, &window_y, &window_width, 0);
7236 clip_rect.x = window_x;
7237 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7238 clip_rect.y = max (clip_rect.y, window_y);
7239 clip_rect.width = window_width;
7240 clip_rect.height = row->visible_height;
7242 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7246 /* Draw a hollow box cursor on window W in glyph row ROW. */
7248 static void
7249 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7251 struct frame *f = XFRAME (WINDOW_FRAME (w));
7252 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7253 Display *dpy = FRAME_X_DISPLAY (f);
7254 int x, y, wd, h;
7255 XGCValues xgcv;
7256 struct glyph *cursor_glyph;
7257 GC gc;
7259 /* Get the glyph the cursor is on. If we can't tell because
7260 the current matrix is invalid or such, give up. */
7261 cursor_glyph = get_phys_cursor_glyph (w);
7262 if (cursor_glyph == NULL)
7263 return;
7265 /* Compute frame-relative coordinates for phys cursor. */
7266 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7267 wd = w->phys_cursor_width;
7269 /* The foreground of cursor_gc is typically the same as the normal
7270 background color, which can cause the cursor box to be invisible. */
7271 xgcv.foreground = f->output_data.x->cursor_pixel;
7272 if (dpyinfo->scratch_cursor_gc)
7273 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7274 else
7275 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7276 GCForeground, &xgcv);
7277 gc = dpyinfo->scratch_cursor_gc;
7279 /* Set clipping, draw the rectangle, and reset clipping again. */
7280 x_clip_to_row (w, row, TEXT_AREA, gc);
7281 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7282 XSetClipMask (dpy, gc, None);
7286 /* Draw a bar cursor on window W in glyph row ROW.
7288 Implementation note: One would like to draw a bar cursor with an
7289 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7290 Unfortunately, I didn't find a font yet that has this property set.
7291 --gerd. */
7293 static void
7294 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7296 struct frame *f = XFRAME (w->frame);
7297 struct glyph *cursor_glyph;
7299 /* If cursor is out of bounds, don't draw garbage. This can happen
7300 in mini-buffer windows when switching between echo area glyphs
7301 and mini-buffer. */
7302 cursor_glyph = get_phys_cursor_glyph (w);
7303 if (cursor_glyph == NULL)
7304 return;
7306 /* If on an image, draw like a normal cursor. That's usually better
7307 visible than drawing a bar, esp. if the image is large so that
7308 the bar might not be in the window. */
7309 if (cursor_glyph->type == IMAGE_GLYPH)
7311 struct glyph_row *r;
7312 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7313 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
7315 else
7317 Display *dpy = FRAME_X_DISPLAY (f);
7318 Window window = FRAME_X_WINDOW (f);
7319 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7320 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7321 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7322 XGCValues xgcv;
7324 /* If the glyph's background equals the color we normally draw
7325 the bars cursor in, the bar cursor in its normal color is
7326 invisible. Use the glyph's foreground color instead in this
7327 case, on the assumption that the glyph's colors are chosen so
7328 that the glyph is legible. */
7329 if (face->background == f->output_data.x->cursor_pixel)
7330 xgcv.background = xgcv.foreground = face->foreground;
7331 else
7332 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7333 xgcv.graphics_exposures = 0;
7335 if (gc)
7336 XChangeGC (dpy, gc, mask, &xgcv);
7337 else
7339 gc = XCreateGC (dpy, window, mask, &xgcv);
7340 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7343 x_clip_to_row (w, row, TEXT_AREA, gc);
7345 if (kind == BAR_CURSOR)
7347 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7349 if (width < 0)
7350 width = FRAME_CURSOR_WIDTH (f);
7351 width = min (cursor_glyph->pixel_width, width);
7353 w->phys_cursor_width = width;
7355 /* If the character under cursor is R2L, draw the bar cursor
7356 on the right of its glyph, rather than on the left. */
7357 if ((cursor_glyph->resolved_level & 1) != 0)
7358 x += cursor_glyph->pixel_width - width;
7360 XFillRectangle (dpy, window, gc, x,
7361 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7362 width, row->height);
7364 else
7366 int dummy_x, dummy_y, dummy_h;
7368 if (width < 0)
7369 width = row->height;
7371 width = min (row->height, width);
7373 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7374 &dummy_y, &dummy_h);
7376 XFillRectangle (dpy, window, gc,
7377 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7378 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7379 row->height - width),
7380 w->phys_cursor_width, width);
7383 XSetClipMask (dpy, gc, None);
7388 /* RIF: Define cursor CURSOR on frame F. */
7390 static void
7391 x_define_frame_cursor (struct frame *f, Cursor cursor)
7393 if (!f->pointer_invisible
7394 && f->output_data.x->current_cursor != cursor)
7395 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7396 f->output_data.x->current_cursor = cursor;
7400 /* RIF: Clear area on frame F. */
7402 static void
7403 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7405 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7406 x, y, width, height, False);
7407 #ifdef USE_GTK
7408 /* Must queue a redraw, because scroll bars might have been cleared. */
7409 if (FRAME_GTK_WIDGET (f))
7410 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7411 #endif
7415 /* RIF: Draw cursor on window W. */
7417 static void
7418 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)
7420 struct frame *f = XFRAME (WINDOW_FRAME (w));
7422 if (on_p)
7424 w->phys_cursor_type = cursor_type;
7425 w->phys_cursor_on_p = 1;
7427 if (glyph_row->exact_window_width_line_p
7428 && (glyph_row->reversed_p
7429 ? (w->phys_cursor.hpos < 0)
7430 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7432 glyph_row->cursor_in_fringe_p = 1;
7433 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7435 else
7437 switch (cursor_type)
7439 case HOLLOW_BOX_CURSOR:
7440 x_draw_hollow_cursor (w, glyph_row);
7441 break;
7443 case FILLED_BOX_CURSOR:
7444 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7445 break;
7447 case BAR_CURSOR:
7448 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7449 break;
7451 case HBAR_CURSOR:
7452 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7453 break;
7455 case NO_CURSOR:
7456 w->phys_cursor_width = 0;
7457 break;
7459 default:
7460 emacs_abort ();
7464 #ifdef HAVE_X_I18N
7465 if (w == XWINDOW (f->selected_window))
7466 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7467 xic_set_preeditarea (w, x, y);
7468 #endif
7471 #ifndef XFlush
7472 XFlush (FRAME_X_DISPLAY (f));
7473 #endif
7477 /* Icons. */
7479 /* Make the x-window of frame F use the gnu icon bitmap. */
7482 x_bitmap_icon (struct frame *f, Lisp_Object file)
7484 ptrdiff_t bitmap_id;
7486 if (FRAME_X_WINDOW (f) == 0)
7487 return 1;
7489 /* Free up our existing icon bitmap and mask if any. */
7490 if (f->output_data.x->icon_bitmap > 0)
7491 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7492 f->output_data.x->icon_bitmap = 0;
7494 if (STRINGP (file))
7496 #ifdef USE_GTK
7497 /* Use gtk_window_set_icon_from_file () if available,
7498 It's not restricted to bitmaps */
7499 if (xg_set_icon (f, file))
7500 return 0;
7501 #endif /* USE_GTK */
7502 bitmap_id = x_create_bitmap_from_file (f, file);
7503 x_create_bitmap_mask (f, bitmap_id);
7505 else
7507 /* Create the GNU bitmap and mask if necessary. */
7508 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7510 ptrdiff_t rc = -1;
7512 #ifdef USE_GTK
7514 if (xg_set_icon (f, xg_default_icon_file)
7515 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7516 return 0;
7518 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7520 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7521 if (rc != -1)
7522 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7524 #endif
7526 /* If all else fails, use the (black and white) xbm image. */
7527 if (rc == -1)
7529 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
7530 gnu_xbm_width, gnu_xbm_height);
7531 if (rc == -1)
7532 return 1;
7534 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7535 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7539 /* The first time we create the GNU bitmap and mask,
7540 this increments the ref-count one extra time.
7541 As a result, the GNU bitmap and mask are never freed.
7542 That way, we don't have to worry about allocating it again. */
7543 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7545 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7548 x_wm_set_icon_pixmap (f, bitmap_id);
7549 f->output_data.x->icon_bitmap = bitmap_id;
7551 return 0;
7555 /* Make the x-window of frame F use a rectangle with text.
7556 Use ICON_NAME as the text. */
7559 x_text_icon (struct frame *f, const char *icon_name)
7561 if (FRAME_X_WINDOW (f) == 0)
7562 return 1;
7565 XTextProperty text;
7566 text.value = (unsigned char *) icon_name;
7567 text.encoding = XA_STRING;
7568 text.format = 8;
7569 text.nitems = strlen (icon_name);
7570 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7573 if (f->output_data.x->icon_bitmap > 0)
7574 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7575 f->output_data.x->icon_bitmap = 0;
7576 x_wm_set_icon_pixmap (f, 0);
7578 return 0;
7581 #define X_ERROR_MESSAGE_SIZE 200
7583 /* If non-nil, this should be a string.
7584 It means catch X errors and store the error message in this string.
7586 The reason we use a stack is that x_catch_error/x_uncatch_error can
7587 be called from a signal handler.
7590 struct x_error_message_stack {
7591 char string[X_ERROR_MESSAGE_SIZE];
7592 Display *dpy;
7593 struct x_error_message_stack *prev;
7595 static struct x_error_message_stack *x_error_message;
7597 /* An X error handler which stores the error message in
7598 *x_error_message. This is called from x_error_handler if
7599 x_catch_errors is in effect. */
7601 static void
7602 x_error_catcher (Display *display, XErrorEvent *event)
7604 XGetErrorText (display, event->error_code,
7605 x_error_message->string,
7606 X_ERROR_MESSAGE_SIZE);
7609 /* Begin trapping X errors for display DPY. Actually we trap X errors
7610 for all displays, but DPY should be the display you are actually
7611 operating on.
7613 After calling this function, X protocol errors no longer cause
7614 Emacs to exit; instead, they are recorded in the string
7615 stored in *x_error_message.
7617 Calling x_check_errors signals an Emacs error if an X error has
7618 occurred since the last call to x_catch_errors or x_check_errors.
7620 Calling x_uncatch_errors resumes the normal error handling. */
7622 void
7623 x_catch_errors (Display *dpy)
7625 struct x_error_message_stack *data = xmalloc (sizeof *data);
7627 /* Make sure any errors from previous requests have been dealt with. */
7628 XSync (dpy, False);
7630 data->dpy = dpy;
7631 data->string[0] = 0;
7632 data->prev = x_error_message;
7633 x_error_message = data;
7636 /* Undo the last x_catch_errors call.
7637 DPY should be the display that was passed to x_catch_errors. */
7639 void
7640 x_uncatch_errors (void)
7642 struct x_error_message_stack *tmp;
7644 block_input ();
7646 /* The display may have been closed before this function is called.
7647 Check if it is still open before calling XSync. */
7648 if (x_display_info_for_display (x_error_message->dpy) != 0)
7649 XSync (x_error_message->dpy, False);
7651 tmp = x_error_message;
7652 x_error_message = x_error_message->prev;
7653 xfree (tmp);
7654 unblock_input ();
7657 /* If any X protocol errors have arrived since the last call to
7658 x_catch_errors or x_check_errors, signal an Emacs error using
7659 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7661 void
7662 x_check_errors (Display *dpy, const char *format)
7664 /* Make sure to catch any errors incurred so far. */
7665 XSync (dpy, False);
7667 if (x_error_message->string[0])
7669 char string[X_ERROR_MESSAGE_SIZE];
7670 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7671 x_uncatch_errors ();
7672 error (format, string);
7676 /* Nonzero if we had any X protocol errors
7677 since we did x_catch_errors on DPY. */
7680 x_had_errors_p (Display *dpy)
7682 /* Make sure to catch any errors incurred so far. */
7683 XSync (dpy, False);
7685 return x_error_message->string[0] != 0;
7688 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7690 void
7691 x_clear_errors (Display *dpy)
7693 x_error_message->string[0] = 0;
7696 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7697 * idea. --lorentey */
7698 /* Close off all unclosed x_catch_errors calls. */
7700 void
7701 x_fully_uncatch_errors (void)
7703 while (x_error_message)
7704 x_uncatch_errors ();
7706 #endif
7708 #if 0
7709 static unsigned int x_wire_count;
7710 x_trace_wire (void)
7712 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7714 #endif /* ! 0 */
7717 /************************************************************************
7718 Handling X errors
7719 ************************************************************************/
7721 /* Error message passed to x_connection_closed. */
7723 static char *error_msg;
7725 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7726 the text of an error message that lead to the connection loss. */
7728 static void
7729 x_connection_closed (Display *dpy, const char *error_message)
7731 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7732 Lisp_Object frame, tail;
7733 ptrdiff_t idx = SPECPDL_INDEX ();
7735 error_msg = alloca (strlen (error_message) + 1);
7736 strcpy (error_msg, error_message);
7738 /* Inhibit redisplay while frames are being deleted. */
7739 specbind (Qinhibit_redisplay, Qt);
7741 if (dpyinfo)
7743 /* Protect display from being closed when we delete the last
7744 frame on it. */
7745 dpyinfo->reference_count++;
7746 dpyinfo->terminal->reference_count++;
7749 /* First delete frames whose mini-buffers are on frames
7750 that are on the dead display. */
7751 FOR_EACH_FRAME (tail, frame)
7753 Lisp_Object minibuf_frame;
7754 minibuf_frame
7755 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7756 if (FRAME_X_P (XFRAME (frame))
7757 && FRAME_X_P (XFRAME (minibuf_frame))
7758 && ! EQ (frame, minibuf_frame)
7759 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7760 delete_frame (frame, Qnoelisp);
7763 /* Now delete all remaining frames on the dead display.
7764 We are now sure none of these is used as the mini-buffer
7765 for another frame that we need to delete. */
7766 FOR_EACH_FRAME (tail, frame)
7767 if (FRAME_X_P (XFRAME (frame))
7768 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7770 /* Set this to t so that delete_frame won't get confused
7771 trying to find a replacement. */
7772 kset_default_minibuffer_frame (FRAME_KBOARD (XFRAME (frame)), Qt);
7773 delete_frame (frame, Qnoelisp);
7776 /* If DPYINFO is null, this means we didn't open the display in the
7777 first place, so don't try to close it. */
7778 if (dpyinfo)
7780 /* We can not call XtCloseDisplay here because it calls XSync.
7781 XSync inside the error handler apparently hangs Emacs. On
7782 current Xt versions, this isn't needed either. */
7783 #ifdef USE_GTK
7784 /* A long-standing GTK bug prevents proper disconnect handling
7785 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7786 the resulting Glib error message loop filled a user's disk.
7787 To avoid this, kill Emacs unconditionally on disconnect. */
7788 shut_down_emacs (0, Qnil);
7789 fprintf (stderr, "%s\n\
7790 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7791 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7792 For details, see etc/PROBLEMS.\n",
7793 error_msg);
7794 emacs_abort ();
7795 #endif /* USE_GTK */
7797 /* Indicate that this display is dead. */
7798 dpyinfo->display = 0;
7800 dpyinfo->reference_count--;
7801 dpyinfo->terminal->reference_count--;
7802 if (dpyinfo->reference_count != 0)
7803 /* We have just closed all frames on this display. */
7804 emacs_abort ();
7807 Lisp_Object tmp;
7808 XSETTERMINAL (tmp, dpyinfo->terminal);
7809 Fdelete_terminal (tmp, Qnoelisp);
7813 if (terminal_list == 0)
7815 fprintf (stderr, "%s\n", error_msg);
7816 Fkill_emacs (make_number (70));
7817 /* NOTREACHED */
7820 totally_unblock_input ();
7822 unbind_to (idx, Qnil);
7823 clear_waiting_for_input ();
7825 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
7826 IF_LINT (if (! terminal_list) return; )
7828 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7829 longjmp), because returning from this function would get us back into
7830 Xlib's code which will directly call `exit'. */
7831 error ("%s", error_msg);
7834 /* We specifically use it before defining it, so that gcc doesn't inline it,
7835 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7836 static void x_error_quitter (Display *, XErrorEvent *);
7838 /* This is the first-level handler for X protocol errors.
7839 It calls x_error_quitter or x_error_catcher. */
7841 static int
7842 x_error_handler (Display *display, XErrorEvent *event)
7844 #ifdef HAVE_GTK3
7845 if (event->error_code == BadMatch
7846 && event->request_code == X_SetInputFocus
7847 && event->minor_code == 0)
7849 return 0;
7851 #endif
7853 if (x_error_message)
7854 x_error_catcher (display, event);
7855 else
7856 x_error_quitter (display, event);
7857 return 0;
7860 /* This is the usual handler for X protocol errors.
7861 It kills all frames on the display that we got the error for.
7862 If that was the only one, it prints an error message and kills Emacs. */
7864 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7866 /* On older GCC versions, just putting x_error_quitter
7867 after x_error_handler prevents inlining into the former. */
7869 static void NO_INLINE
7870 x_error_quitter (Display *display, XErrorEvent *event)
7872 char buf[256], buf1[356];
7874 /* Ignore BadName errors. They can happen because of fonts
7875 or colors that are not defined. */
7877 if (event->error_code == BadName)
7878 return;
7880 /* Note that there is no real way portable across R3/R4 to get the
7881 original error handler. */
7883 XGetErrorText (display, event->error_code, buf, sizeof (buf));
7884 sprintf (buf1, "X protocol error: %s on protocol request %d",
7885 buf, event->request_code);
7886 x_connection_closed (display, buf1);
7890 /* This is the handler for X IO errors, always.
7891 It kills all frames on the display that we lost touch with.
7892 If that was the only one, it prints an error message and kills Emacs. */
7894 static int
7895 x_io_error_quitter (Display *display)
7897 char buf[256];
7899 snprintf (buf, sizeof buf, "Connection lost to X server `%s'",
7900 DisplayString (display));
7901 x_connection_closed (display, buf);
7902 return 0;
7905 /* Changing the font of the frame. */
7907 /* Give frame F the font FONT-OBJECT as its default font. The return
7908 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7909 frame. If it is negative, generate a new fontset from
7910 FONT-OBJECT. */
7912 Lisp_Object
7913 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7915 struct font *font = XFONT_OBJECT (font_object);
7917 if (fontset < 0)
7918 fontset = fontset_from_font (font_object);
7919 FRAME_FONTSET (f) = fontset;
7920 if (FRAME_FONT (f) == font)
7921 /* This font is already set in frame F. There's nothing more to
7922 do. */
7923 return font_object;
7925 FRAME_FONT (f) = font;
7926 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7927 FRAME_COLUMN_WIDTH (f) = font->average_width;
7928 FRAME_SPACE_WIDTH (f) = font->space_width;
7929 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7931 compute_fringe_widths (f, 1);
7933 /* Compute the scroll bar width in character columns. */
7934 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7936 int wid = FRAME_COLUMN_WIDTH (f);
7937 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7938 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7940 else
7942 int wid = FRAME_COLUMN_WIDTH (f);
7943 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7946 if (FRAME_X_WINDOW (f) != 0)
7948 /* Don't change the size of a tip frame; there's no point in
7949 doing it because it's done in Fx_show_tip, and it leads to
7950 problems because the tip frame has no widget. */
7951 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7952 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7955 #ifdef HAVE_X_I18N
7956 if (FRAME_XIC (f)
7957 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7959 block_input ();
7960 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7961 unblock_input ();
7963 #endif
7965 return font_object;
7969 /***********************************************************************
7970 X Input Methods
7971 ***********************************************************************/
7973 #ifdef HAVE_X_I18N
7975 #ifdef HAVE_X11R6
7977 /* XIM destroy callback function, which is called whenever the
7978 connection to input method XIM dies. CLIENT_DATA contains a
7979 pointer to the x_display_info structure corresponding to XIM. */
7981 static void
7982 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7984 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7985 Lisp_Object frame, tail;
7987 block_input ();
7989 /* No need to call XDestroyIC.. */
7990 FOR_EACH_FRAME (tail, frame)
7992 struct frame *f = XFRAME (frame);
7993 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7995 FRAME_XIC (f) = NULL;
7996 xic_free_xfontset (f);
8000 /* No need to call XCloseIM. */
8001 dpyinfo->xim = NULL;
8002 XFree (dpyinfo->xim_styles);
8003 unblock_input ();
8006 #endif /* HAVE_X11R6 */
8008 #ifdef HAVE_X11R6
8009 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8010 extern char *XSetIMValues (XIM, ...);
8011 #endif
8013 /* Open the connection to the XIM server on display DPYINFO.
8014 RESOURCE_NAME is the resource name Emacs uses. */
8016 static void
8017 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
8019 XIM xim;
8021 #ifdef HAVE_XIM
8022 if (use_xim)
8024 if (dpyinfo->xim)
8025 XCloseIM (dpyinfo->xim);
8026 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8027 emacs_class);
8028 dpyinfo->xim = xim;
8030 if (xim)
8032 #ifdef HAVE_X11R6
8033 XIMCallback destroy;
8034 #endif
8036 /* Get supported styles and XIM values. */
8037 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8039 #ifdef HAVE_X11R6
8040 destroy.callback = xim_destroy_callback;
8041 destroy.client_data = (XPointer)dpyinfo;
8042 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8043 #endif
8047 else
8048 #endif /* HAVE_XIM */
8049 dpyinfo->xim = NULL;
8053 #ifdef HAVE_X11R6_XIM
8055 /* XIM instantiate callback function, which is called whenever an XIM
8056 server is available. DISPLAY is the display of the XIM.
8057 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8058 when the callback was registered. */
8060 static void
8061 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8063 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8064 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8066 /* We don't support multiple XIM connections. */
8067 if (dpyinfo->xim)
8068 return;
8070 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8072 /* Create XIC for the existing frames on the same display, as long
8073 as they have no XIC. */
8074 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8076 Lisp_Object tail, frame;
8078 block_input ();
8079 FOR_EACH_FRAME (tail, frame)
8081 struct frame *f = XFRAME (frame);
8083 if (FRAME_X_P (f)
8084 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8085 if (FRAME_XIC (f) == NULL)
8087 create_frame_xic (f);
8088 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8089 xic_set_statusarea (f);
8090 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8092 struct window *w = XWINDOW (f->selected_window);
8093 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8098 unblock_input ();
8102 #endif /* HAVE_X11R6_XIM */
8105 /* Open a connection to the XIM server on display DPYINFO.
8106 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8107 connection only at the first time. On X11R6, open the connection
8108 in the XIM instantiate callback function. */
8110 static void
8111 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8113 dpyinfo->xim = NULL;
8114 #ifdef HAVE_XIM
8115 if (use_xim)
8117 #ifdef HAVE_X11R6_XIM
8118 struct xim_inst_t *xim_inst = xmalloc (sizeof *xim_inst);
8119 ptrdiff_t len;
8121 dpyinfo->xim_callback_data = xim_inst;
8122 xim_inst->dpyinfo = dpyinfo;
8123 len = strlen (resource_name);
8124 xim_inst->resource_name = xmalloc (len + 1);
8125 memcpy (xim_inst->resource_name, resource_name, len + 1);
8126 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8127 resource_name, emacs_class,
8128 xim_instantiate_callback,
8129 /* This is XPointer in XFree86
8130 but (XPointer *) on Tru64, at
8131 least, hence the configure test. */
8132 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8133 #else /* not HAVE_X11R6_XIM */
8134 xim_open_dpy (dpyinfo, resource_name);
8135 #endif /* not HAVE_X11R6_XIM */
8137 #endif /* HAVE_XIM */
8141 /* Close the connection to the XIM server on display DPYINFO. */
8143 static void
8144 xim_close_dpy (struct x_display_info *dpyinfo)
8146 #ifdef HAVE_XIM
8147 if (use_xim)
8149 #ifdef HAVE_X11R6_XIM
8150 if (dpyinfo->display)
8151 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8152 NULL, emacs_class,
8153 xim_instantiate_callback, NULL);
8154 xfree (dpyinfo->xim_callback_data->resource_name);
8155 xfree (dpyinfo->xim_callback_data);
8156 #endif /* HAVE_X11R6_XIM */
8157 if (dpyinfo->display)
8158 XCloseIM (dpyinfo->xim);
8159 dpyinfo->xim = NULL;
8160 XFree (dpyinfo->xim_styles);
8162 #endif /* HAVE_XIM */
8165 #endif /* not HAVE_X11R6_XIM */
8169 /* Calculate the absolute position in frame F
8170 from its current recorded position values and gravity. */
8172 static void
8173 x_calc_absolute_position (struct frame *f)
8175 int flags = f->size_hint_flags;
8177 /* We have nothing to do if the current position
8178 is already for the top-left corner. */
8179 if (! ((flags & XNegative) || (flags & YNegative)))
8180 return;
8182 /* Treat negative positions as relative to the leftmost bottommost
8183 position that fits on the screen. */
8184 if (flags & XNegative)
8185 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8186 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8189 int height = FRAME_PIXEL_HEIGHT (f);
8191 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8192 /* Something is fishy here. When using Motif, starting Emacs with
8193 `-g -0-0', the frame appears too low by a few pixels.
8195 This seems to be so because initially, while Emacs is starting,
8196 the column widget's height and the frame's pixel height are
8197 different. The column widget's height is the right one. In
8198 later invocations, when Emacs is up, the frame's pixel height
8199 is right, though.
8201 It's not obvious where the initial small difference comes from.
8202 2000-12-01, gerd. */
8204 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8205 #endif
8207 if (flags & YNegative)
8208 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8209 - height + f->top_pos;
8212 /* The left_pos and top_pos
8213 are now relative to the top and left screen edges,
8214 so the flags should correspond. */
8215 f->size_hint_flags &= ~ (XNegative | YNegative);
8218 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8219 to really change the position, and 0 when calling from
8220 x_make_frame_visible (in that case, XOFF and YOFF are the current
8221 position values). It is -1 when calling from x_set_frame_parameters,
8222 which means, do adjust for borders but don't change the gravity. */
8224 void
8225 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8227 int modified_top, modified_left;
8229 if (change_gravity > 0)
8231 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8232 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8234 f->top_pos = yoff;
8235 f->left_pos = xoff;
8236 f->size_hint_flags &= ~ (XNegative | YNegative);
8237 if (xoff < 0)
8238 f->size_hint_flags |= XNegative;
8239 if (yoff < 0)
8240 f->size_hint_flags |= YNegative;
8241 f->win_gravity = NorthWestGravity;
8243 x_calc_absolute_position (f);
8245 block_input ();
8246 x_wm_set_size_hint (f, (long) 0, 0);
8248 modified_left = f->left_pos;
8249 modified_top = f->top_pos;
8251 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8253 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8254 than the WM decorations. So we use the calculated offset instead
8255 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8256 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8257 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8260 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8261 modified_left, modified_top);
8263 x_sync_with_move (f, f->left_pos, f->top_pos,
8264 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8265 ? 1 : 0);
8267 /* change_gravity is non-zero when this function is called from Lisp to
8268 programmatically move a frame. In that case, we call
8269 x_check_expected_move to discover if we have a "Type A" or "Type B"
8270 window manager, and, for a "Type A" window manager, adjust the position
8271 of the frame.
8273 We call x_check_expected_move if a programmatic move occurred, and
8274 either the window manager type (A/B) is unknown or it is Type A but we
8275 need to compute the top/left offset adjustment for this frame. */
8277 if (change_gravity != 0 &&
8278 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8279 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8280 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8281 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8282 x_check_expected_move (f, modified_left, modified_top);
8284 unblock_input ();
8287 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8288 on the root window for frame F contains ATOMNAME.
8289 This is how a WM check shall be done according to the Window Manager
8290 Specification/Extended Window Manager Hints at
8291 http://freedesktop.org/wiki/Specifications/wm-spec. */
8293 static int
8294 wm_supports (struct frame *f, Atom want_atom)
8296 Atom actual_type;
8297 unsigned long actual_size, bytes_remaining;
8298 int i, rc, actual_format;
8299 Window wmcheck_window;
8300 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8301 Window target_window = dpyinfo->root_window;
8302 long max_len = 65536;
8303 Display *dpy = FRAME_X_DISPLAY (f);
8304 unsigned char *tmp_data = NULL;
8305 Atom target_type = XA_WINDOW;
8307 block_input ();
8309 x_catch_errors (dpy);
8310 rc = XGetWindowProperty (dpy, target_window,
8311 dpyinfo->Xatom_net_supporting_wm_check,
8312 0, max_len, False, target_type,
8313 &actual_type, &actual_format, &actual_size,
8314 &bytes_remaining, &tmp_data);
8316 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8318 if (tmp_data) XFree (tmp_data);
8319 x_uncatch_errors ();
8320 unblock_input ();
8321 return 0;
8324 wmcheck_window = *(Window *) tmp_data;
8325 XFree (tmp_data);
8327 /* Check if window exists. */
8328 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8329 x_sync (f);
8330 if (x_had_errors_p (dpy))
8332 x_uncatch_errors ();
8333 unblock_input ();
8334 return 0;
8337 if (dpyinfo->net_supported_window != wmcheck_window)
8339 /* Window changed, reload atoms */
8340 if (dpyinfo->net_supported_atoms != NULL)
8341 XFree (dpyinfo->net_supported_atoms);
8342 dpyinfo->net_supported_atoms = NULL;
8343 dpyinfo->nr_net_supported_atoms = 0;
8344 dpyinfo->net_supported_window = 0;
8346 target_type = XA_ATOM;
8347 tmp_data = NULL;
8348 rc = XGetWindowProperty (dpy, target_window,
8349 dpyinfo->Xatom_net_supported,
8350 0, max_len, False, target_type,
8351 &actual_type, &actual_format, &actual_size,
8352 &bytes_remaining, &tmp_data);
8354 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8356 if (tmp_data) XFree (tmp_data);
8357 x_uncatch_errors ();
8358 unblock_input ();
8359 return 0;
8362 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8363 dpyinfo->nr_net_supported_atoms = actual_size;
8364 dpyinfo->net_supported_window = wmcheck_window;
8367 rc = 0;
8369 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8370 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8372 x_uncatch_errors ();
8373 unblock_input ();
8375 return rc;
8378 static void
8379 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8381 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8383 x_send_client_event (frame, make_number (0), frame,
8384 dpyinfo->Xatom_net_wm_state,
8385 make_number (32),
8386 /* 1 = add, 0 = remove */
8387 Fcons
8388 (make_number (add ? 1 : 0),
8389 Fcons
8390 (make_fixnum_or_float (atom),
8391 value != 0
8392 ? Fcons (make_fixnum_or_float (value), Qnil)
8393 : Qnil)));
8396 void
8397 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8399 Lisp_Object frame;
8400 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8402 XSETFRAME (frame, f);
8404 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8405 dpyinfo->Xatom_net_wm_state_sticky, None);
8408 /* Return the current _NET_WM_STATE.
8409 SIZE_STATE is set to one of the FULLSCREEN_* values.
8410 STICKY is set to 1 if the sticky state is set, 0 if not.
8412 Return non-zero if we are not hidden, zero if we are. */
8414 static int
8415 get_current_wm_state (struct frame *f,
8416 Window window,
8417 int *size_state,
8418 int *sticky)
8420 Atom actual_type;
8421 unsigned long actual_size, bytes_remaining;
8422 int i, rc, actual_format, is_hidden = 0;
8423 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8424 long max_len = 65536;
8425 Display *dpy = FRAME_X_DISPLAY (f);
8426 unsigned char *tmp_data = NULL;
8427 Atom target_type = XA_ATOM;
8429 *sticky = 0;
8430 *size_state = FULLSCREEN_NONE;
8432 block_input ();
8433 x_catch_errors (dpy);
8434 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8435 0, max_len, False, target_type,
8436 &actual_type, &actual_format, &actual_size,
8437 &bytes_remaining, &tmp_data);
8439 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8441 if (tmp_data) XFree (tmp_data);
8442 x_uncatch_errors ();
8443 unblock_input ();
8444 return ! f->iconified;
8447 x_uncatch_errors ();
8449 for (i = 0; i < actual_size; ++i)
8451 Atom a = ((Atom*)tmp_data)[i];
8452 if (a == dpyinfo->Xatom_net_wm_state_hidden)
8454 is_hidden = 1;
8455 f->output_data.x->net_wm_state_hidden_seen = 1;
8457 else if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8459 if (*size_state == FULLSCREEN_HEIGHT)
8460 *size_state = FULLSCREEN_MAXIMIZED;
8461 else
8462 *size_state = FULLSCREEN_WIDTH;
8464 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8466 if (*size_state == FULLSCREEN_WIDTH)
8467 *size_state = FULLSCREEN_MAXIMIZED;
8468 else
8469 *size_state = FULLSCREEN_HEIGHT;
8471 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8472 *size_state = FULLSCREEN_BOTH;
8473 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8474 *sticky = 1;
8477 if (tmp_data) XFree (tmp_data);
8478 unblock_input ();
8479 return ! is_hidden;
8482 /* Do fullscreen as specified in extended window manager hints */
8484 static int
8485 do_ewmh_fullscreen (struct frame *f)
8487 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8488 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8489 int cur, dummy;
8491 (void)get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8493 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8494 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8495 if (!have_net_atom)
8496 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8498 if (have_net_atom && cur != f->want_fullscreen)
8500 Lisp_Object frame;
8502 XSETFRAME (frame, f);
8504 /* Keep number of calls to set_wm_state as low as possible.
8505 Some window managers, or possible Gtk+, hangs when too many
8506 are sent at once. */
8507 switch (f->want_fullscreen)
8509 case FULLSCREEN_BOTH:
8510 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8511 || cur == FULLSCREEN_HEIGHT)
8512 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8513 dpyinfo->Xatom_net_wm_state_maximized_vert);
8514 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8515 break;
8516 case FULLSCREEN_WIDTH:
8517 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8518 || cur == FULLSCREEN_MAXIMIZED)
8519 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8520 dpyinfo->Xatom_net_wm_state_maximized_vert);
8521 if (cur != FULLSCREEN_MAXIMIZED)
8522 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8523 break;
8524 case FULLSCREEN_HEIGHT:
8525 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8526 || cur == FULLSCREEN_MAXIMIZED)
8527 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8528 dpyinfo->Xatom_net_wm_state_maximized_horz);
8529 if (cur != FULLSCREEN_MAXIMIZED)
8530 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8531 break;
8532 case FULLSCREEN_MAXIMIZED:
8533 if (cur == FULLSCREEN_BOTH)
8534 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8535 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8536 dpyinfo->Xatom_net_wm_state_maximized_vert);
8537 break;
8538 case FULLSCREEN_NONE:
8539 if (cur == FULLSCREEN_BOTH)
8540 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8541 else
8542 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8543 dpyinfo->Xatom_net_wm_state_maximized_vert);
8546 f->want_fullscreen = FULLSCREEN_NONE;
8550 return have_net_atom;
8553 static void
8554 XTfullscreen_hook (FRAME_PTR f)
8556 if (f->async_visible)
8558 block_input ();
8559 x_check_fullscreen (f);
8560 x_sync (f);
8561 unblock_input ();
8566 static int
8567 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8569 int value = FULLSCREEN_NONE;
8570 Lisp_Object lval;
8571 int sticky = 0;
8572 int not_hidden = get_current_wm_state (f, event->window, &value, &sticky);
8574 lval = Qnil;
8575 switch (value)
8577 case FULLSCREEN_WIDTH:
8578 lval = Qfullwidth;
8579 break;
8580 case FULLSCREEN_HEIGHT:
8581 lval = Qfullheight;
8582 break;
8583 case FULLSCREEN_BOTH:
8584 lval = Qfullboth;
8585 break;
8586 case FULLSCREEN_MAXIMIZED:
8587 lval = Qmaximized;
8588 break;
8591 store_frame_param (f, Qfullscreen, lval);
8592 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8594 return not_hidden;
8597 /* Check if we need to resize the frame due to a fullscreen request.
8598 If so needed, resize the frame. */
8599 static void
8600 x_check_fullscreen (struct frame *f)
8602 if (do_ewmh_fullscreen (f))
8603 return;
8605 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8606 return; /* Only fullscreen without WM or with EWM hints (above). */
8608 /* Setting fullscreen to nil doesn't do anything. We could save the
8609 last non-fullscreen size and restore it, but it seems like a
8610 lot of work for this unusual case (no window manager running). */
8612 if (f->want_fullscreen != FULLSCREEN_NONE)
8614 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8615 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8617 switch (f->want_fullscreen)
8619 /* No difference between these two when there is no WM */
8620 case FULLSCREEN_BOTH:
8621 case FULLSCREEN_MAXIMIZED:
8622 width = x_display_pixel_width (dpyinfo);
8623 height = x_display_pixel_height (dpyinfo);
8624 break;
8625 case FULLSCREEN_WIDTH:
8626 width = x_display_pixel_width (dpyinfo);
8627 break;
8628 case FULLSCREEN_HEIGHT:
8629 height = x_display_pixel_height (dpyinfo);
8632 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8633 width, height);
8637 /* This function is called by x_set_offset to determine whether the window
8638 manager interfered with the positioning of the frame. Type A window
8639 managers position the surrounding window manager decorations a small
8640 amount above and left of the user-supplied position. Type B window
8641 managers position the surrounding window manager decorations at the
8642 user-specified position. If we detect a Type A window manager, we
8643 compensate by moving the window right and down by the proper amount. */
8645 static void
8646 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8648 int current_left = 0, current_top = 0;
8650 /* x_real_positions returns the left and top offsets of the outermost
8651 window manager window around the frame. */
8653 x_real_positions (f, &current_left, &current_top);
8655 if (current_left != expected_left || current_top != expected_top)
8657 /* It's a "Type A" window manager. */
8659 int adjusted_left;
8660 int adjusted_top;
8662 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8663 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8664 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8666 /* Now fix the mispositioned frame's location. */
8668 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8669 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8671 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8672 adjusted_left, adjusted_top);
8674 x_sync_with_move (f, expected_left, expected_top, 0);
8676 else
8677 /* It's a "Type B" window manager. We don't have to adjust the
8678 frame's position. */
8680 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8684 /* Wait for XGetGeometry to return up-to-date position information for a
8685 recently-moved frame. Call this immediately after calling XMoveWindow.
8686 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8687 frame has been moved to, so we use a fuzzy position comparison instead
8688 of an exact comparison. */
8690 static void
8691 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8693 int count = 0;
8695 while (count++ < 50)
8697 int current_left = 0, current_top = 0;
8699 /* In theory, this call to XSync only needs to happen once, but in
8700 practice, it doesn't seem to work, hence the need for the surrounding
8701 loop. */
8703 XSync (FRAME_X_DISPLAY (f), False);
8704 x_real_positions (f, &current_left, &current_top);
8706 if (fuzzy)
8708 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8709 pixels. */
8711 if (eabs (current_left - left) <= 10
8712 && eabs (current_top - top) <= 40)
8713 return;
8715 else if (current_left == left && current_top == top)
8716 return;
8719 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8720 will then return up-to-date position info. */
8722 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8726 /* Wait for an event on frame F matching EVENTTYPE. */
8727 void
8728 x_wait_for_event (struct frame *f, int eventtype)
8730 int level = interrupt_input_blocked;
8732 SELECT_TYPE fds;
8733 EMACS_TIME tmo, tmo_at, time_now;
8734 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8736 pending_event_wait.f = f;
8737 pending_event_wait.eventtype = eventtype;
8739 /* Set timeout to 0.1 second. Hopefully not noticeable.
8740 Maybe it should be configurable. */
8741 tmo = make_emacs_time (0, 100 * 1000 * 1000);
8742 tmo_at = add_emacs_time (current_emacs_time (), tmo);
8744 while (pending_event_wait.eventtype)
8746 pending_signals = 1;
8747 totally_unblock_input ();
8748 /* XTread_socket is called after unblock. */
8749 block_input ();
8750 interrupt_input_blocked = level;
8752 FD_ZERO (&fds);
8753 FD_SET (fd, &fds);
8755 time_now = current_emacs_time ();
8756 if (EMACS_TIME_LT (tmo_at, time_now))
8757 break;
8759 tmo = sub_emacs_time (tmo_at, time_now);
8760 if (pselect (fd + 1, &fds, NULL, NULL, &tmo, NULL) == 0)
8761 break; /* Timeout */
8763 pending_event_wait.f = 0;
8764 pending_event_wait.eventtype = 0;
8768 /* Change the size of frame F's X window to COLS/ROWS in the case F
8769 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8770 top-left-corner window gravity for this size change and subsequent
8771 size changes. Otherwise we leave the window gravity unchanged. */
8773 static void
8774 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8776 int pixelwidth, pixelheight;
8778 check_frame_size (f, &rows, &cols);
8779 f->scroll_bar_actual_width
8780 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8782 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8784 compute_fringe_widths (f, 0);
8786 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8787 + FRAME_TOOLBAR_WIDTH (f);
8788 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8789 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8791 if (change_gravity) f->win_gravity = NorthWestGravity;
8792 x_wm_set_size_hint (f, (long) 0, 0);
8793 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8794 pixelwidth, pixelheight);
8797 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8798 receive in the ConfigureNotify event; if we get what we asked
8799 for, then the event won't cause the screen to become garbaged, so
8800 we have to make sure to do it here. */
8801 SET_FRAME_GARBAGED (f);
8803 /* Now, strictly speaking, we can't be sure that this is accurate,
8804 but the window manager will get around to dealing with the size
8805 change request eventually, and we'll hear how it went when the
8806 ConfigureNotify event gets here.
8808 We could just not bother storing any of this information here,
8809 and let the ConfigureNotify event set everything up, but that
8810 might be kind of confusing to the Lisp code, since size changes
8811 wouldn't be reported in the frame parameters until some random
8812 point in the future when the ConfigureNotify event arrives.
8814 We pass 1 for DELAY since we can't run Lisp code inside of
8815 a BLOCK_INPUT. */
8817 /* But the ConfigureNotify may in fact never arrive, and then this is
8818 not right if the frame is visible. Instead wait (with timeout)
8819 for the ConfigureNotify. */
8820 if (f->async_visible)
8821 x_wait_for_event (f, ConfigureNotify);
8822 else
8824 change_frame_size (f, rows, cols, 0, 1, 0);
8825 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8826 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8827 x_sync (f);
8832 /* Call this to change the size of frame F's x-window.
8833 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8834 for this size change and subsequent size changes.
8835 Otherwise we leave the window gravity unchanged. */
8837 void
8838 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8840 block_input ();
8842 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8844 int r, c;
8846 /* When the frame is maximized/fullscreen or running under for
8847 example Xmonad, x_set_window_size_1 will be a no-op.
8848 In that case, the right thing to do is extend rows/cols to
8849 the current frame size. We do that first if x_set_window_size_1
8850 turns out to not be a no-op (there is no way to know).
8851 The size will be adjusted again if the frame gets a
8852 ConfigureNotify event as a result of x_set_window_size. */
8853 int pixelh = FRAME_PIXEL_HEIGHT (f);
8854 #ifdef USE_X_TOOLKIT
8855 /* The menu bar is not part of text lines. The tool bar
8856 is however. */
8857 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8858 #endif
8859 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8860 /* Update f->scroll_bar_actual_width because it is used in
8861 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8862 f->scroll_bar_actual_width
8863 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8864 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8865 change_frame_size (f, r, c, 0, 1, 0);
8868 #ifdef USE_GTK
8869 if (FRAME_GTK_WIDGET (f))
8870 xg_frame_set_char_size (f, cols, rows);
8871 else
8872 x_set_window_size_1 (f, change_gravity, cols, rows);
8873 #else /* not USE_GTK */
8875 x_set_window_size_1 (f, change_gravity, cols, rows);
8877 #endif /* not USE_GTK */
8879 /* If cursor was outside the new size, mark it as off. */
8880 mark_window_cursors_off (XWINDOW (f->root_window));
8882 /* Clear out any recollection of where the mouse highlighting was,
8883 since it might be in a place that's outside the new frame size.
8884 Actually checking whether it is outside is a pain in the neck,
8885 so don't try--just let the highlighting be done afresh with new size. */
8886 cancel_mouse_face (f);
8888 unblock_input ();
8891 /* Mouse warping. */
8893 void
8894 x_set_mouse_position (struct frame *f, int x, int y)
8896 int pix_x, pix_y;
8898 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8899 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8901 if (pix_x < 0) pix_x = 0;
8902 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8904 if (pix_y < 0) pix_y = 0;
8905 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8907 block_input ();
8909 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8910 0, 0, 0, 0, pix_x, pix_y);
8911 unblock_input ();
8914 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8916 void
8917 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8919 block_input ();
8921 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8922 0, 0, 0, 0, pix_x, pix_y);
8923 unblock_input ();
8926 /* Raise frame F. */
8928 void
8929 x_raise_frame (struct frame *f)
8931 block_input ();
8932 if (f->async_visible)
8933 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8935 XFlush (FRAME_X_DISPLAY (f));
8936 unblock_input ();
8939 /* Lower frame F. */
8941 static void
8942 x_lower_frame (struct frame *f)
8944 if (f->async_visible)
8946 block_input ();
8947 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8948 XFlush (FRAME_X_DISPLAY (f));
8949 unblock_input ();
8953 /* Request focus with XEmbed */
8955 void
8956 xembed_request_focus (FRAME_PTR f)
8958 /* See XEmbed Protocol Specification at
8959 http://freedesktop.org/wiki/Specifications/xembed-spec */
8960 if (f->async_visible)
8961 xembed_send_message (f, CurrentTime,
8962 XEMBED_REQUEST_FOCUS, 0, 0, 0);
8965 /* Activate frame with Extended Window Manager Hints */
8967 void
8968 x_ewmh_activate_frame (FRAME_PTR f)
8970 /* See Window Manager Specification/Extended Window Manager Hints at
8971 http://freedesktop.org/wiki/Specifications/wm-spec */
8973 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8974 if (f->async_visible && wm_supports (f, dpyinfo->Xatom_net_active_window))
8976 Lisp_Object frame;
8977 XSETFRAME (frame, f);
8978 x_send_client_event (frame, make_number (0), frame,
8979 dpyinfo->Xatom_net_active_window,
8980 make_number (32),
8981 Fcons (make_number (1),
8982 Fcons (make_number (last_user_time),
8983 Qnil)));
8987 static void
8988 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
8990 if (raise_flag)
8991 x_raise_frame (f);
8992 else
8993 x_lower_frame (f);
8996 /* XEmbed implementation. */
8998 #if defined USE_X_TOOLKIT || ! defined USE_GTK
9000 /* XEmbed implementation. */
9002 #define XEMBED_VERSION 0
9004 static void
9005 xembed_set_info (struct frame *f, enum xembed_info flags)
9007 unsigned long data[2];
9008 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9010 data[0] = XEMBED_VERSION;
9011 data[1] = flags;
9013 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9014 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
9015 32, PropModeReplace, (unsigned char *) data, 2);
9017 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
9019 static void
9020 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
9021 long int detail, long int data1, long int data2)
9023 XEvent event;
9025 event.xclient.type = ClientMessage;
9026 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9027 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9028 event.xclient.format = 32;
9029 event.xclient.data.l[0] = t;
9030 event.xclient.data.l[1] = msg;
9031 event.xclient.data.l[2] = detail;
9032 event.xclient.data.l[3] = data1;
9033 event.xclient.data.l[4] = data2;
9035 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9036 False, NoEventMask, &event);
9037 XSync (FRAME_X_DISPLAY (f), False);
9040 /* Change of visibility. */
9042 /* This tries to wait until the frame is really visible.
9043 However, if the window manager asks the user where to position
9044 the frame, this will return before the user finishes doing that.
9045 The frame will not actually be visible at that time,
9046 but it will become visible later when the window manager
9047 finishes with it. */
9049 void
9050 x_make_frame_visible (struct frame *f)
9052 Lisp_Object type;
9053 int original_top, original_left;
9054 int retry_count = 2;
9056 retry:
9058 block_input ();
9060 type = x_icon_type (f);
9061 if (!NILP (type))
9062 x_bitmap_icon (f, type);
9064 if (! FRAME_VISIBLE_P (f))
9066 /* We test FRAME_GARBAGED_P here to make sure we don't
9067 call x_set_offset a second time
9068 if we get to x_make_frame_visible a second time
9069 before the window gets really visible. */
9070 if (! FRAME_ICONIFIED_P (f)
9071 && ! FRAME_X_EMBEDDED_P (f)
9072 && ! f->output_data.x->asked_for_visible)
9073 x_set_offset (f, f->left_pos, f->top_pos, 0);
9075 f->output_data.x->asked_for_visible = 1;
9077 if (! EQ (Vx_no_window_manager, Qt))
9078 x_wm_set_window_state (f, NormalState);
9079 #ifdef USE_X_TOOLKIT
9080 if (FRAME_X_EMBEDDED_P (f))
9081 xembed_set_info (f, XEMBED_MAPPED);
9082 else
9084 /* This was XtPopup, but that did nothing for an iconified frame. */
9085 XtMapWidget (f->output_data.x->widget);
9087 #else /* not USE_X_TOOLKIT */
9088 #ifdef USE_GTK
9089 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9090 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9091 #else
9092 if (FRAME_X_EMBEDDED_P (f))
9093 xembed_set_info (f, XEMBED_MAPPED);
9094 else
9095 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9096 #endif /* not USE_GTK */
9097 #endif /* not USE_X_TOOLKIT */
9100 XFlush (FRAME_X_DISPLAY (f));
9102 /* Synchronize to ensure Emacs knows the frame is visible
9103 before we do anything else. We do this loop with input not blocked
9104 so that incoming events are handled. */
9106 Lisp_Object frame;
9107 int count;
9108 /* This must be before UNBLOCK_INPUT
9109 since events that arrive in response to the actions above
9110 will set it when they are handled. */
9111 int previously_visible = f->output_data.x->has_been_visible;
9113 original_left = f->left_pos;
9114 original_top = f->top_pos;
9116 /* This must come after we set COUNT. */
9117 unblock_input ();
9119 /* We unblock here so that arriving X events are processed. */
9121 /* Now move the window back to where it was "supposed to be".
9122 But don't do it if the gravity is negative.
9123 When the gravity is negative, this uses a position
9124 that is 3 pixels too low. Perhaps that's really the border width.
9126 Don't do this if the window has never been visible before,
9127 because the window manager may choose the position
9128 and we don't want to override it. */
9130 if (! FRAME_VISIBLE_P (f)
9131 && ! FRAME_ICONIFIED_P (f)
9132 && ! FRAME_X_EMBEDDED_P (f)
9133 && f->win_gravity == NorthWestGravity
9134 && previously_visible)
9136 Drawable rootw;
9137 int x, y;
9138 unsigned int width, height, border, depth;
9140 block_input ();
9142 /* On some window managers (such as FVWM) moving an existing
9143 window, even to the same place, causes the window manager
9144 to introduce an offset. This can cause the window to move
9145 to an unexpected location. Check the geometry (a little
9146 slow here) and then verify that the window is in the right
9147 place. If the window is not in the right place, move it
9148 there, and take the potential window manager hit. */
9149 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9150 &rootw, &x, &y, &width, &height, &border, &depth);
9152 if (original_left != x || original_top != y)
9153 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9154 original_left, original_top);
9156 unblock_input ();
9159 XSETFRAME (frame, f);
9161 /* Wait until the frame is visible. Process X events until a
9162 MapNotify event has been seen, or until we think we won't get a
9163 MapNotify at all.. */
9164 for (count = input_signal_count + 10;
9165 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9167 /* Force processing of queued events. */
9168 x_sync (f);
9170 /* Machines that do polling rather than SIGIO have been
9171 observed to go into a busy-wait here. So we'll fake an
9172 alarm signal to let the handler know that there's something
9173 to be read. We used to raise a real alarm, but it seems
9174 that the handler isn't always enabled here. This is
9175 probably a bug. */
9176 if (input_polling_used ())
9178 /* It could be confusing if a real alarm arrives while
9179 processing the fake one. Turn it off and let the
9180 handler reset it. */
9181 int old_poll_suppress_count = poll_suppress_count;
9182 poll_suppress_count = 1;
9183 poll_for_input_1 ();
9184 poll_suppress_count = old_poll_suppress_count;
9187 /* See if a MapNotify event has been processed. */
9188 FRAME_SAMPLE_VISIBILITY (f);
9191 /* 2000-09-28: In
9193 (let ((f (selected-frame)))
9194 (iconify-frame f)
9195 (raise-frame f))
9197 the frame is not raised with various window managers on
9198 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9199 unknown reason, the call to XtMapWidget is completely ignored.
9200 Mapping the widget a second time works. */
9202 if (!FRAME_VISIBLE_P (f) && --retry_count != 0)
9203 goto retry;
9207 /* Change from mapped state to withdrawn state. */
9209 /* Make the frame visible (mapped and not iconified). */
9211 void
9212 x_make_frame_invisible (struct frame *f)
9214 Window window;
9216 /* Use the frame's outermost window, not the one we normally draw on. */
9217 window = FRAME_OUTER_WINDOW (f);
9219 /* Don't keep the highlight on an invisible frame. */
9220 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9221 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9223 block_input ();
9225 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9226 that the current position of the window is user-specified, rather than
9227 program-specified, so that when the window is mapped again, it will be
9228 placed at the same location, without forcing the user to position it
9229 by hand again (they have already done that once for this window.) */
9230 x_wm_set_size_hint (f, (long) 0, 1);
9232 #ifdef USE_GTK
9233 if (FRAME_GTK_OUTER_WIDGET (f))
9234 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9235 else
9236 #else
9237 if (FRAME_X_EMBEDDED_P (f))
9238 xembed_set_info (f, 0);
9239 else
9240 #endif
9243 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9244 DefaultScreen (FRAME_X_DISPLAY (f))))
9246 unblock_input ();
9247 error ("Can't notify window manager of window withdrawal");
9251 /* We can't distinguish this from iconification
9252 just by the event that we get from the server.
9253 So we can't win using the usual strategy of letting
9254 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9255 and synchronize with the server to make sure we agree. */
9256 f->visible = 0;
9257 FRAME_ICONIFIED_P (f) = 0;
9258 f->async_visible = 0;
9259 f->async_iconified = 0;
9261 x_sync (f);
9263 unblock_input ();
9266 /* Change window state from mapped to iconified. */
9268 void
9269 x_iconify_frame (struct frame *f)
9271 #ifdef USE_X_TOOLKIT
9272 int result;
9273 #endif
9274 Lisp_Object type;
9276 /* Don't keep the highlight on an invisible frame. */
9277 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9278 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9280 if (f->async_iconified)
9281 return;
9283 block_input ();
9285 FRAME_SAMPLE_VISIBILITY (f);
9287 type = x_icon_type (f);
9288 if (!NILP (type))
9289 x_bitmap_icon (f, type);
9291 #if defined (USE_GTK)
9292 if (FRAME_GTK_OUTER_WIDGET (f))
9294 if (! FRAME_VISIBLE_P (f))
9295 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9297 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9298 f->iconified = 1;
9299 f->visible = 1;
9300 f->async_iconified = 1;
9301 f->async_visible = 0;
9302 unblock_input ();
9303 return;
9305 #endif
9307 #ifdef USE_X_TOOLKIT
9309 if (! FRAME_VISIBLE_P (f))
9311 if (! EQ (Vx_no_window_manager, Qt))
9312 x_wm_set_window_state (f, IconicState);
9313 /* This was XtPopup, but that did nothing for an iconified frame. */
9314 XtMapWidget (f->output_data.x->widget);
9315 /* The server won't give us any event to indicate
9316 that an invisible frame was changed to an icon,
9317 so we have to record it here. */
9318 f->iconified = 1;
9319 f->visible = 1;
9320 f->async_iconified = 1;
9321 f->async_visible = 0;
9322 unblock_input ();
9323 return;
9326 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9327 XtWindow (f->output_data.x->widget),
9328 DefaultScreen (FRAME_X_DISPLAY (f)));
9329 unblock_input ();
9331 if (!result)
9332 error ("Can't notify window manager of iconification");
9334 f->async_iconified = 1;
9335 f->async_visible = 0;
9338 block_input ();
9339 XFlush (FRAME_X_DISPLAY (f));
9340 unblock_input ();
9341 #else /* not USE_X_TOOLKIT */
9343 /* Make sure the X server knows where the window should be positioned,
9344 in case the user deiconifies with the window manager. */
9345 if (! FRAME_VISIBLE_P (f)
9346 && ! FRAME_ICONIFIED_P (f)
9347 && ! FRAME_X_EMBEDDED_P (f))
9348 x_set_offset (f, f->left_pos, f->top_pos, 0);
9350 /* Since we don't know which revision of X we're running, we'll use both
9351 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9353 /* X11R4: send a ClientMessage to the window manager using the
9354 WM_CHANGE_STATE type. */
9356 XEvent msg;
9358 msg.xclient.window = FRAME_X_WINDOW (f);
9359 msg.xclient.type = ClientMessage;
9360 msg.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9361 msg.xclient.format = 32;
9362 msg.xclient.data.l[0] = IconicState;
9364 if (! XSendEvent (FRAME_X_DISPLAY (f),
9365 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9366 False,
9367 SubstructureRedirectMask | SubstructureNotifyMask,
9368 &msg))
9370 unblock_input ();
9371 error ("Can't notify window manager of iconification");
9375 /* X11R3: set the initial_state field of the window manager hints to
9376 IconicState. */
9377 x_wm_set_window_state (f, IconicState);
9379 if (!FRAME_VISIBLE_P (f))
9381 /* If the frame was withdrawn, before, we must map it. */
9382 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9385 f->async_iconified = 1;
9386 f->async_visible = 0;
9388 XFlush (FRAME_X_DISPLAY (f));
9389 unblock_input ();
9390 #endif /* not USE_X_TOOLKIT */
9394 /* Free X resources of frame F. */
9396 void
9397 x_free_frame_resources (struct frame *f)
9399 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9400 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9401 #ifdef USE_X_TOOLKIT
9402 Lisp_Object bar;
9403 struct scroll_bar *b;
9404 #endif
9406 block_input ();
9408 /* If a display connection is dead, don't try sending more
9409 commands to the X server. */
9410 if (dpyinfo->display)
9412 /* We must free faces before destroying windows because some
9413 font-driver (e.g. xft) access a window while finishing a
9414 face. */
9415 if (FRAME_FACE_CACHE (f))
9416 free_frame_faces (f);
9418 if (f->output_data.x->icon_desc)
9419 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9421 #ifdef USE_X_TOOLKIT
9422 /* Explicitly destroy the scroll bars of the frame. Without
9423 this, we get "BadDrawable" errors from the toolkit later on,
9424 presumably from expose events generated for the disappearing
9425 toolkit scroll bars. */
9426 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9428 b = XSCROLL_BAR (bar);
9429 x_scroll_bar_remove (b);
9431 #endif
9433 #ifdef HAVE_X_I18N
9434 if (FRAME_XIC (f))
9435 free_frame_xic (f);
9436 #endif
9438 #ifdef USE_X_TOOLKIT
9439 if (f->output_data.x->widget)
9441 XtDestroyWidget (f->output_data.x->widget);
9442 f->output_data.x->widget = NULL;
9444 /* Tooltips don't have widgets, only a simple X window, even if
9445 we are using a toolkit. */
9446 else if (FRAME_X_WINDOW (f))
9447 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9449 free_frame_menubar (f);
9450 #else /* !USE_X_TOOLKIT */
9452 #ifdef USE_GTK
9453 xg_free_frame_widgets (f);
9454 #endif /* USE_GTK */
9456 if (FRAME_X_WINDOW (f))
9457 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9458 #endif /* !USE_X_TOOLKIT */
9460 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9461 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9462 unload_color (f, f->output_data.x->cursor_pixel);
9463 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9464 unload_color (f, f->output_data.x->border_pixel);
9465 unload_color (f, f->output_data.x->mouse_pixel);
9467 if (f->output_data.x->scroll_bar_background_pixel != -1)
9468 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9469 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9470 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9471 #ifdef USE_TOOLKIT_SCROLL_BARS
9472 /* Scrollbar shadow colors. */
9473 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9474 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9475 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9476 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9477 #endif /* USE_TOOLKIT_SCROLL_BARS */
9478 if (f->output_data.x->white_relief.allocated_p)
9479 unload_color (f, f->output_data.x->white_relief.pixel);
9480 if (f->output_data.x->black_relief.allocated_p)
9481 unload_color (f, f->output_data.x->black_relief.pixel);
9483 x_free_gcs (f);
9484 XFlush (FRAME_X_DISPLAY (f));
9487 xfree (f->output_data.x->saved_menu_event);
9488 xfree (f->output_data.x);
9489 f->output_data.x = NULL;
9491 if (f == dpyinfo->x_focus_frame)
9492 dpyinfo->x_focus_frame = 0;
9493 if (f == dpyinfo->x_focus_event_frame)
9494 dpyinfo->x_focus_event_frame = 0;
9495 if (f == dpyinfo->x_highlight_frame)
9496 dpyinfo->x_highlight_frame = 0;
9498 if (f == hlinfo->mouse_face_mouse_frame)
9500 hlinfo->mouse_face_beg_row
9501 = hlinfo->mouse_face_beg_col = -1;
9502 hlinfo->mouse_face_end_row
9503 = hlinfo->mouse_face_end_col = -1;
9504 hlinfo->mouse_face_window = Qnil;
9505 hlinfo->mouse_face_deferred_gc = 0;
9506 hlinfo->mouse_face_mouse_frame = 0;
9509 unblock_input ();
9513 /* Destroy the X window of frame F. */
9515 static void
9516 x_destroy_window (struct frame *f)
9518 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9520 /* If a display connection is dead, don't try sending more
9521 commands to the X server. */
9522 if (dpyinfo->display != 0)
9523 x_free_frame_resources (f);
9525 dpyinfo->reference_count--;
9529 /* Setting window manager hints. */
9531 /* Set the normal size hints for the window manager, for frame F.
9532 FLAGS is the flags word to use--or 0 meaning preserve the flags
9533 that the window now has.
9534 If USER_POSITION, set the USPosition
9535 flag (this is useful when FLAGS is 0).
9536 The GTK version is in gtkutils.c. */
9538 #ifndef USE_GTK
9539 void
9540 x_wm_set_size_hint (struct frame *f, long flags, bool user_position)
9542 XSizeHints size_hints;
9543 Window window = FRAME_OUTER_WINDOW (f);
9545 #ifdef USE_X_TOOLKIT
9546 if (f->output_data.x->widget)
9548 widget_update_wm_size_hints (f->output_data.x->widget);
9549 return;
9551 #endif
9553 /* Setting PMaxSize caused various problems. */
9554 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9556 size_hints.x = f->left_pos;
9557 size_hints.y = f->top_pos;
9559 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9560 size_hints.width = FRAME_PIXEL_WIDTH (f);
9562 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9563 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9564 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9565 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9566 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9567 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9569 /* Calculate the base and minimum sizes. */
9571 int base_width, base_height;
9572 int min_rows = 0, min_cols = 0;
9574 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9575 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9577 check_frame_size (f, &min_rows, &min_cols);
9579 /* The window manager uses the base width hints to calculate the
9580 current number of rows and columns in the frame while
9581 resizing; min_width and min_height aren't useful for this
9582 purpose, since they might not give the dimensions for a
9583 zero-row, zero-column frame.
9585 We use the base_width and base_height members if we have
9586 them; otherwise, we set the min_width and min_height members
9587 to the size for a zero x zero frame. */
9589 size_hints.flags |= PBaseSize;
9590 size_hints.base_width = base_width;
9591 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9592 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9593 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9596 /* If we don't need the old flags, we don't need the old hint at all. */
9597 if (flags)
9599 size_hints.flags |= flags;
9600 goto no_read;
9604 XSizeHints hints; /* Sometimes I hate X Windows... */
9605 long supplied_return;
9606 int value;
9608 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9609 &supplied_return);
9611 if (flags)
9612 size_hints.flags |= flags;
9613 else
9615 if (value == 0)
9616 hints.flags = 0;
9617 if (hints.flags & PSize)
9618 size_hints.flags |= PSize;
9619 if (hints.flags & PPosition)
9620 size_hints.flags |= PPosition;
9621 if (hints.flags & USPosition)
9622 size_hints.flags |= USPosition;
9623 if (hints.flags & USSize)
9624 size_hints.flags |= USSize;
9628 no_read:
9630 #ifdef PWinGravity
9631 size_hints.win_gravity = f->win_gravity;
9632 size_hints.flags |= PWinGravity;
9634 if (user_position)
9636 size_hints.flags &= ~ PPosition;
9637 size_hints.flags |= USPosition;
9639 #endif /* PWinGravity */
9641 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9643 #endif /* not USE_GTK */
9645 /* Used for IconicState or NormalState */
9647 static void
9648 x_wm_set_window_state (struct frame *f, int state)
9650 #ifdef USE_X_TOOLKIT
9651 Arg al[1];
9653 XtSetArg (al[0], XtNinitialState, state);
9654 XtSetValues (f->output_data.x->widget, al, 1);
9655 #else /* not USE_X_TOOLKIT */
9656 Window window = FRAME_X_WINDOW (f);
9658 f->output_data.x->wm_hints.flags |= StateHint;
9659 f->output_data.x->wm_hints.initial_state = state;
9661 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9662 #endif /* not USE_X_TOOLKIT */
9665 static void
9666 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
9668 Pixmap icon_pixmap, icon_mask;
9670 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9671 Window window = FRAME_OUTER_WINDOW (f);
9672 #endif
9674 if (pixmap_id > 0)
9676 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9677 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9678 icon_mask = x_bitmap_mask (f, pixmap_id);
9679 f->output_data.x->wm_hints.icon_mask = icon_mask;
9681 else
9683 /* It seems there is no way to turn off use of an icon
9684 pixmap. */
9685 return;
9689 #ifdef USE_GTK
9691 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9692 return;
9695 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9698 Arg al[1];
9699 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9700 XtSetValues (f->output_data.x->widget, al, 1);
9701 XtSetArg (al[0], XtNiconMask, icon_mask);
9702 XtSetValues (f->output_data.x->widget, al, 1);
9705 #else /* not USE_X_TOOLKIT && not USE_GTK */
9707 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9708 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9710 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9713 void
9714 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9716 Window window = FRAME_OUTER_WINDOW (f);
9718 f->output_data.x->wm_hints.flags |= IconPositionHint;
9719 f->output_data.x->wm_hints.icon_x = icon_x;
9720 f->output_data.x->wm_hints.icon_y = icon_y;
9722 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9726 /***********************************************************************
9727 Fonts
9728 ***********************************************************************/
9730 #ifdef GLYPH_DEBUG
9732 /* Check that FONT is valid on frame F. It is if it can be found in F's
9733 font table. */
9735 static void
9736 x_check_font (struct frame *f, struct font *font)
9738 eassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9739 if (font->driver->check)
9740 eassert (font->driver->check (f, font) == 0);
9743 #endif /* GLYPH_DEBUG */
9746 /***********************************************************************
9747 Initialization
9748 ***********************************************************************/
9750 #ifdef USE_X_TOOLKIT
9751 static XrmOptionDescRec emacs_options[] = {
9752 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9753 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9755 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9756 XrmoptionSepArg, NULL},
9757 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9759 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9760 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9761 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9762 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9763 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9764 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9765 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9768 /* Whether atimer for Xt timeouts is activated or not. */
9770 static int x_timeout_atimer_activated_flag;
9772 #endif /* USE_X_TOOLKIT */
9774 static int x_initialized;
9776 /* Test whether two display-name strings agree up to the dot that separates
9777 the screen number from the server number. */
9778 static int
9779 same_x_server (const char *name1, const char *name2)
9781 int seen_colon = 0;
9782 const char *system_name = SSDATA (Vsystem_name);
9783 ptrdiff_t system_name_length = SBYTES (Vsystem_name);
9784 ptrdiff_t length_until_period = 0;
9786 while (system_name[length_until_period] != 0
9787 && system_name[length_until_period] != '.')
9788 length_until_period++;
9790 /* Treat `unix' like an empty host name. */
9791 if (! strncmp (name1, "unix:", 5))
9792 name1 += 4;
9793 if (! strncmp (name2, "unix:", 5))
9794 name2 += 4;
9795 /* Treat this host's name like an empty host name. */
9796 if (! strncmp (name1, system_name, system_name_length)
9797 && name1[system_name_length] == ':')
9798 name1 += system_name_length;
9799 if (! strncmp (name2, system_name, system_name_length)
9800 && name2[system_name_length] == ':')
9801 name2 += system_name_length;
9802 /* Treat this host's domainless name like an empty host name. */
9803 if (! strncmp (name1, system_name, length_until_period)
9804 && name1[length_until_period] == ':')
9805 name1 += length_until_period;
9806 if (! strncmp (name2, system_name, length_until_period)
9807 && name2[length_until_period] == ':')
9808 name2 += length_until_period;
9810 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9812 if (*name1 == ':')
9813 seen_colon = 1;
9814 if (seen_colon && *name1 == '.')
9815 return 1;
9817 return (seen_colon
9818 && (*name1 == '.' || *name1 == '\0')
9819 && (*name2 == '.' || *name2 == '\0'));
9822 /* Count number of set bits in mask and number of bits to shift to
9823 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9824 to 5. */
9825 static void
9826 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9828 int nr = 0;
9829 int off = 0;
9831 while (!(mask & 1))
9833 off++;
9834 mask >>= 1;
9837 while (mask & 1)
9839 nr++;
9840 mask >>= 1;
9843 *offset = off;
9844 *bits = nr;
9847 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9848 But don't permanently open it, just test its availability. */
9851 x_display_ok (const char *display)
9853 int dpy_ok = 1;
9854 Display *dpy;
9856 dpy = XOpenDisplay (display);
9857 if (dpy)
9858 XCloseDisplay (dpy);
9859 else
9860 dpy_ok = 0;
9861 return dpy_ok;
9864 #ifdef USE_GTK
9865 static void
9866 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
9867 const gchar *msg, gpointer user_data)
9869 if (!strstr (msg, "g_set_prgname"))
9870 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
9872 #endif
9874 /* Open a connection to X display DISPLAY_NAME, and return
9875 the structure that describes the open display.
9876 If we cannot contact the display, return null. */
9878 struct x_display_info *
9879 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9881 int connection;
9882 Display *dpy;
9883 struct terminal *terminal;
9884 struct x_display_info *dpyinfo;
9885 XrmDatabase xrdb;
9886 Mouse_HLInfo *hlinfo;
9887 ptrdiff_t lim;
9889 block_input ();
9891 if (!x_initialized)
9893 x_initialize ();
9894 ++x_initialized;
9897 if (! x_display_ok (SSDATA (display_name)))
9898 error ("Display %s can't be opened", SSDATA (display_name));
9900 #ifdef USE_GTK
9902 #define NUM_ARGV 10
9903 int argc;
9904 char *argv[NUM_ARGV];
9905 char **argv2 = argv;
9906 guint id;
9908 if (x_initialized++ > 1)
9910 xg_display_open (SSDATA (display_name), &dpy);
9912 else
9914 static char display_opt[] = "--display";
9915 static char name_opt[] = "--name";
9917 for (argc = 0; argc < NUM_ARGV; ++argc)
9918 argv[argc] = 0;
9920 argc = 0;
9921 argv[argc++] = initial_argv[0];
9923 if (! NILP (display_name))
9925 argv[argc++] = display_opt;
9926 argv[argc++] = SSDATA (display_name);
9929 argv[argc++] = name_opt;
9930 argv[argc++] = resource_name;
9932 XSetLocaleModifiers ("");
9934 /* Emacs can only handle core input events, so make sure
9935 Gtk doesn't use Xinput or Xinput2 extensions. */
9937 static char fix_events[] = "GDK_CORE_DEVICE_EVENTS=1";
9938 putenv (fix_events);
9941 /* Work around GLib bug that outputs a faulty warning. See
9942 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9943 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9944 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9946 /* NULL window -> events for all windows go to our function.
9947 Call before gtk_init so Gtk+ event filters comes after our. */
9948 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9950 /* gtk_init does set_locale. Fix locale before and after. */
9951 fixup_locale ();
9952 gtk_init (&argc, &argv2);
9953 fixup_locale ();
9955 g_log_remove_handler ("GLib", id);
9957 xg_initialize ();
9959 dpy = DEFAULT_GDK_DISPLAY ();
9961 #if GTK_MAJOR_VERSION <= 2 && GTK_MINOR_VERSION <= 90
9962 /* Load our own gtkrc if it exists. */
9964 const char *file = "~/.emacs.d/gtkrc";
9965 Lisp_Object s, abs_file;
9967 s = build_string (file);
9968 abs_file = Fexpand_file_name (s, Qnil);
9970 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9971 gtk_rc_parse (SSDATA (abs_file));
9973 #endif
9975 XSetErrorHandler (x_error_handler);
9976 XSetIOErrorHandler (x_io_error_quitter);
9979 #else /* not USE_GTK */
9980 #ifdef USE_X_TOOLKIT
9981 /* weiner@footloose.sps.mot.com reports that this causes
9982 errors with X11R5:
9983 X protocol error: BadAtom (invalid Atom parameter)
9984 on protocol request 18skiloaf.
9985 So let's not use it until R6. */
9986 #ifdef HAVE_X11XTR6
9987 XtSetLanguageProc (NULL, NULL, NULL);
9988 #endif
9991 int argc = 0;
9992 char *argv[3];
9994 argv[0] = "";
9995 argc = 1;
9996 if (xrm_option)
9998 argv[argc++] = "-xrm";
9999 argv[argc++] = xrm_option;
10001 turn_on_atimers (0);
10002 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
10003 resource_name, EMACS_CLASS,
10004 emacs_options, XtNumber (emacs_options),
10005 &argc, argv);
10006 turn_on_atimers (1);
10008 #ifdef HAVE_X11XTR6
10009 /* I think this is to compensate for XtSetLanguageProc. */
10010 fixup_locale ();
10011 #endif
10014 #else /* not USE_X_TOOLKIT */
10015 XSetLocaleModifiers ("");
10016 dpy = XOpenDisplay (SSDATA (display_name));
10017 #endif /* not USE_X_TOOLKIT */
10018 #endif /* not USE_GTK*/
10020 /* Detect failure. */
10021 if (dpy == 0)
10023 unblock_input ();
10024 return 0;
10027 /* We have definitely succeeded. Record the new connection. */
10029 dpyinfo = xzalloc (sizeof *dpyinfo);
10030 hlinfo = &dpyinfo->mouse_highlight;
10032 terminal = x_create_terminal (dpyinfo);
10035 struct x_display_info *share;
10036 Lisp_Object tail;
10038 for (share = x_display_list, tail = x_display_name_list; share;
10039 share = share->next, tail = XCDR (tail))
10040 if (same_x_server (SSDATA (XCAR (XCAR (tail))),
10041 SSDATA (display_name)))
10042 break;
10043 if (share)
10044 terminal->kboard = share->terminal->kboard;
10045 else
10047 terminal->kboard = xmalloc (sizeof *terminal->kboard);
10048 init_kboard (terminal->kboard);
10049 kset_window_system (terminal->kboard, Qx);
10051 /* Add the keyboard to the list before running Lisp code (via
10052 Qvendor_specific_keysyms below), since these are not traced
10053 via terminals but only through all_kboards. */
10054 terminal->kboard->next_kboard = all_kboards;
10055 all_kboards = terminal->kboard;
10057 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10059 char *vendor = ServerVendor (dpy);
10061 /* Protect terminal from GC before removing it from the
10062 list of terminals. */
10063 struct gcpro gcpro1;
10064 Lisp_Object gcpro_term;
10065 XSETTERMINAL (gcpro_term, terminal);
10066 GCPRO1 (gcpro_term);
10068 /* Temporarily hide the partially initialized terminal. */
10069 terminal_list = terminal->next_terminal;
10070 unblock_input ();
10071 kset_system_key_alist
10072 (terminal->kboard,
10073 call1 (Qvendor_specific_keysyms,
10074 vendor ? build_string (vendor) : empty_unibyte_string));
10075 block_input ();
10076 terminal->next_terminal = terminal_list;
10077 terminal_list = terminal;
10078 UNGCPRO;
10081 /* Don't let the initial kboard remain current longer than necessary.
10082 That would cause problems if a file loaded on startup tries to
10083 prompt in the mini-buffer. */
10084 if (current_kboard == initial_kboard)
10085 current_kboard = terminal->kboard;
10087 terminal->kboard->reference_count++;
10090 /* Put this display on the chain. */
10091 dpyinfo->next = x_display_list;
10092 x_display_list = dpyinfo;
10094 /* Put it on x_display_name_list as well, to keep them parallel. */
10095 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10096 x_display_name_list);
10097 dpyinfo->name_list_element = XCAR (x_display_name_list);
10099 dpyinfo->display = dpy;
10101 /* Set the name of the terminal. */
10102 terminal->name = xmalloc (SBYTES (display_name) + 1);
10103 memcpy (terminal->name, SSDATA (display_name), SBYTES (display_name));
10104 terminal->name[SBYTES (display_name)] = 0;
10106 #if 0
10107 XSetAfterFunction (x_current_display, x_trace_wire);
10108 #endif /* ! 0 */
10110 lim = min (PTRDIFF_MAX, SIZE_MAX) - sizeof "@";
10111 if (lim - SBYTES (Vinvocation_name) < SBYTES (Vsystem_name))
10112 memory_full (SIZE_MAX);
10113 dpyinfo->x_id_name = xmalloc (SBYTES (Vinvocation_name)
10114 + SBYTES (Vsystem_name) + 2);
10115 strcat (strcat (strcpy (dpyinfo->x_id_name, SSDATA (Vinvocation_name)), "@"),
10116 SSDATA (Vsystem_name));
10118 /* Figure out which modifier bits mean what. */
10119 x_find_modifier_meanings (dpyinfo);
10121 /* Get the scroll bar cursor. */
10122 #ifdef USE_GTK
10123 /* We must create a GTK cursor, it is required for GTK widgets. */
10124 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10125 #endif /* USE_GTK */
10127 dpyinfo->vertical_scroll_bar_cursor
10128 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10130 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10131 resource_name, EMACS_CLASS);
10132 #ifdef HAVE_XRMSETDATABASE
10133 XrmSetDatabase (dpyinfo->display, xrdb);
10134 #else
10135 dpyinfo->display->db = xrdb;
10136 #endif
10137 /* Put the rdb where we can find it in a way that works on
10138 all versions. */
10139 dpyinfo->xrdb = xrdb;
10141 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10142 DefaultScreen (dpyinfo->display));
10143 select_visual (dpyinfo);
10144 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10145 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10146 dpyinfo->client_leader_window = 0;
10147 dpyinfo->grabbed = 0;
10148 dpyinfo->reference_count = 0;
10149 dpyinfo->icon_bitmap_id = -1;
10150 dpyinfo->n_fonts = 0;
10151 dpyinfo->bitmaps = 0;
10152 dpyinfo->bitmaps_size = 0;
10153 dpyinfo->bitmaps_last = 0;
10154 dpyinfo->scratch_cursor_gc = 0;
10155 hlinfo->mouse_face_mouse_frame = 0;
10156 hlinfo->mouse_face_deferred_gc = 0;
10157 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10158 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10159 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10160 hlinfo->mouse_face_window = Qnil;
10161 hlinfo->mouse_face_overlay = Qnil;
10162 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10163 hlinfo->mouse_face_defer = 0;
10164 hlinfo->mouse_face_hidden = 0;
10165 dpyinfo->x_focus_frame = 0;
10166 dpyinfo->x_focus_event_frame = 0;
10167 dpyinfo->x_highlight_frame = 0;
10168 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10170 /* See if we can construct pixel values from RGB values. */
10171 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10172 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10174 if (dpyinfo->visual->class == TrueColor)
10176 get_bits_and_offset (dpyinfo->visual->red_mask,
10177 &dpyinfo->red_bits, &dpyinfo->red_offset);
10178 get_bits_and_offset (dpyinfo->visual->blue_mask,
10179 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10180 get_bits_and_offset (dpyinfo->visual->green_mask,
10181 &dpyinfo->green_bits, &dpyinfo->green_offset);
10184 /* See if a private colormap is requested. */
10185 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10187 if (dpyinfo->visual->class == PseudoColor)
10189 Lisp_Object value;
10190 value = display_x_get_resource (dpyinfo,
10191 build_string ("privateColormap"),
10192 build_string ("PrivateColormap"),
10193 Qnil, Qnil);
10194 if (STRINGP (value)
10195 && (!strcmp (SSDATA (value), "true")
10196 || !strcmp (SSDATA (value), "on")))
10197 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10200 else
10201 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10202 dpyinfo->visual, AllocNone);
10204 #ifdef HAVE_XFT
10206 /* If we are using Xft, check dpi value in X resources.
10207 It is better we use it as well, since Xft will use it, as will all
10208 Gnome applications. If our real DPI is smaller or larger than the
10209 one Xft uses, our font will look smaller or larger than other
10210 for other applications, even if it is the same font name (monospace-10
10211 for example). */
10212 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10213 double d;
10214 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10215 dpyinfo->resy = dpyinfo->resx = d;
10217 #endif
10219 if (dpyinfo->resy < 1)
10221 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10222 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10223 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10224 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10225 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10226 pixels = DisplayWidth (dpyinfo->display, screen_number);
10227 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10228 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10229 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10233 const struct
10235 const char *name;
10236 Atom *atom;
10237 } atom_refs[] = {
10238 { "WM_PROTOCOLS", &dpyinfo->Xatom_wm_protocols },
10239 { "WM_TAKE_FOCUS", &dpyinfo->Xatom_wm_take_focus },
10240 { "WM_SAVE_YOURSELF", &dpyinfo->Xatom_wm_save_yourself },
10241 { "WM_DELETE_WINDOW", &dpyinfo->Xatom_wm_delete_window },
10242 { "WM_CHANGE_STATE", &dpyinfo->Xatom_wm_change_state },
10243 { "WM_CONFIGURE_DENIED", &dpyinfo->Xatom_wm_configure_denied },
10244 { "WM_MOVED", &dpyinfo->Xatom_wm_window_moved },
10245 { "WM_CLIENT_LEADER", &dpyinfo->Xatom_wm_client_leader },
10246 { "Editres", &dpyinfo->Xatom_editres },
10247 { "CLIPBOARD", &dpyinfo->Xatom_CLIPBOARD },
10248 { "TIMESTAMP", &dpyinfo->Xatom_TIMESTAMP },
10249 { "TEXT", &dpyinfo->Xatom_TEXT },
10250 { "COMPOUND_TEXT", &dpyinfo->Xatom_COMPOUND_TEXT },
10251 { "UTF8_STRING", &dpyinfo->Xatom_UTF8_STRING },
10252 { "DELETE", &dpyinfo->Xatom_DELETE },
10253 { "MULTIPLE", &dpyinfo->Xatom_MULTIPLE },
10254 { "INCR", &dpyinfo->Xatom_INCR },
10255 { "_EMACS_TMP_", &dpyinfo->Xatom_EMACS_TMP },
10256 { "TARGETS", &dpyinfo->Xatom_TARGETS },
10257 { "NULL", &dpyinfo->Xatom_NULL },
10258 { "ATOM", &dpyinfo->Xatom_ATOM },
10259 { "ATOM_PAIR", &dpyinfo->Xatom_ATOM_PAIR },
10260 { "CLIPBOARD_MANAGER", &dpyinfo->Xatom_CLIPBOARD_MANAGER },
10261 { "_XEMBED_INFO", &dpyinfo->Xatom_XEMBED_INFO },
10262 /* For properties of font. */
10263 { "PIXEL_SIZE", &dpyinfo->Xatom_PIXEL_SIZE },
10264 { "AVERAGE_WIDTH", &dpyinfo->Xatom_AVERAGE_WIDTH },
10265 { "_MULE_BASELINE_OFFSET", &dpyinfo->Xatom_MULE_BASELINE_OFFSET },
10266 { "_MULE_RELATIVE_COMPOSE", &dpyinfo->Xatom_MULE_RELATIVE_COMPOSE },
10267 { "_MULE_DEFAULT_ASCENT", &dpyinfo->Xatom_MULE_DEFAULT_ASCENT },
10268 /* Ghostscript support. */
10269 { "DONE", &dpyinfo->Xatom_DONE },
10270 { "PAGE", &dpyinfo->Xatom_PAGE },
10271 { "SCROLLBAR", &dpyinfo->Xatom_Scrollbar },
10272 { "_XEMBED", &dpyinfo->Xatom_XEMBED },
10273 /* EWMH */
10274 { "_NET_WM_STATE", &dpyinfo->Xatom_net_wm_state },
10275 { "_NET_WM_STATE_FULLSCREEN", &dpyinfo->Xatom_net_wm_state_fullscreen },
10276 { "_NET_WM_STATE_MAXIMIZED_HORZ",
10277 &dpyinfo->Xatom_net_wm_state_maximized_horz },
10278 { "_NET_WM_STATE_MAXIMIZED_VERT",
10279 &dpyinfo->Xatom_net_wm_state_maximized_vert },
10280 { "_NET_WM_STATE_STICKY", &dpyinfo->Xatom_net_wm_state_sticky },
10281 { "_NET_WM_STATE_HIDDEN", &dpyinfo->Xatom_net_wm_state_hidden },
10282 { "_NET_WM_WINDOW_TYPE", &dpyinfo->Xatom_net_window_type },
10283 { "_NET_WM_WINDOW_TYPE_TOOLTIP",
10284 &dpyinfo->Xatom_net_window_type_tooltip },
10285 { "_NET_WM_ICON_NAME", &dpyinfo->Xatom_net_wm_icon_name },
10286 { "_NET_WM_NAME", &dpyinfo->Xatom_net_wm_name },
10287 { "_NET_SUPPORTED", &dpyinfo->Xatom_net_supported },
10288 { "_NET_SUPPORTING_WM_CHECK", &dpyinfo->Xatom_net_supporting_wm_check },
10289 { "_NET_WM_WINDOW_OPACITY", &dpyinfo->Xatom_net_wm_window_opacity },
10290 { "_NET_ACTIVE_WINDOW", &dpyinfo->Xatom_net_active_window },
10291 { "_NET_FRAME_EXTENTS", &dpyinfo->Xatom_net_frame_extents },
10292 /* Session management */
10293 { "SM_CLIENT_ID", &dpyinfo->Xatom_SM_CLIENT_ID },
10294 { "_XSETTINGS_SETTINGS", &dpyinfo->Xatom_xsettings_prop },
10295 { "MANAGER", &dpyinfo->Xatom_xsettings_mgr },
10298 int i;
10299 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10300 /* 1 for _XSETTINGS_SN */
10301 const int total_atom_count = 1 + atom_count;
10302 Atom *atoms_return = xmalloc (total_atom_count * sizeof *atoms_return);
10303 char **atom_names = xmalloc (total_atom_count * sizeof *atom_names);
10304 static char const xsettings_fmt[] = "_XSETTINGS_S%d";
10305 char xsettings_atom_name[sizeof xsettings_fmt - 2
10306 + INT_STRLEN_BOUND (int)];
10308 for (i = 0; i < atom_count; i++)
10309 atom_names[i] = (char *) atom_refs[i].name;
10311 /* Build _XSETTINGS_SN atom name */
10312 sprintf (xsettings_atom_name, xsettings_fmt,
10313 XScreenNumberOfScreen (dpyinfo->screen));
10314 atom_names[i] = xsettings_atom_name;
10316 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10317 False, atoms_return);
10319 for (i = 0; i < atom_count; i++)
10320 *atom_refs[i].atom = atoms_return[i];
10322 /* Manual copy of last atom */
10323 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10325 xfree (atom_names);
10326 xfree (atoms_return);
10329 dpyinfo->x_dnd_atoms_size = 8;
10330 dpyinfo->x_dnd_atoms_length = 0;
10331 dpyinfo->x_dnd_atoms = xmalloc (sizeof *dpyinfo->x_dnd_atoms
10332 * dpyinfo->x_dnd_atoms_size);
10334 dpyinfo->net_supported_atoms = NULL;
10335 dpyinfo->nr_net_supported_atoms = 0;
10336 dpyinfo->net_supported_window = 0;
10338 connection = ConnectionNumber (dpyinfo->display);
10339 dpyinfo->connection = connection;
10340 dpyinfo->gray
10341 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10342 gray_bits, gray_width, gray_height,
10343 1, 0, 1);
10345 #ifdef HAVE_X_I18N
10346 xim_initialize (dpyinfo, resource_name);
10347 #endif
10349 xsettings_initialize (dpyinfo);
10351 /* This is only needed for distinguishing keyboard and process input. */
10352 if (connection != 0)
10353 add_keyboard_wait_descriptor (connection);
10355 #ifdef F_SETOWN
10356 fcntl (connection, F_SETOWN, getpid ());
10357 #endif /* ! defined (F_SETOWN) */
10359 if (interrupt_input)
10360 init_sigio (connection);
10362 #ifdef USE_LUCID
10364 XrmValue d, fr, to;
10365 Font font;
10367 dpy = dpyinfo->display;
10368 d.addr = (XPointer)&dpy;
10369 d.size = sizeof (Display *);
10370 fr.addr = XtDefaultFont;
10371 fr.size = sizeof (XtDefaultFont);
10372 to.size = sizeof (Font *);
10373 to.addr = (XPointer)&font;
10374 x_catch_errors (dpy);
10375 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10376 emacs_abort ();
10377 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10378 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10379 x_uncatch_errors ();
10381 #endif
10383 /* See if we should run in synchronous mode. This is useful
10384 for debugging X code. */
10386 Lisp_Object value;
10387 value = display_x_get_resource (dpyinfo,
10388 build_string ("synchronous"),
10389 build_string ("Synchronous"),
10390 Qnil, Qnil);
10391 if (STRINGP (value)
10392 && (!strcmp (SSDATA (value), "true")
10393 || !strcmp (SSDATA (value), "on")))
10394 XSynchronize (dpyinfo->display, True);
10398 Lisp_Object value;
10399 value = display_x_get_resource (dpyinfo,
10400 build_string ("useXIM"),
10401 build_string ("UseXIM"),
10402 Qnil, Qnil);
10403 #ifdef USE_XIM
10404 if (STRINGP (value)
10405 && (!strcmp (SSDATA (value), "false")
10406 || !strcmp (SSDATA (value), "off")))
10407 use_xim = 0;
10408 #else
10409 if (STRINGP (value)
10410 && (!strcmp (SSDATA (value), "true")
10411 || !strcmp (SSDATA (value), "on")))
10412 use_xim = 1;
10413 #endif
10416 #ifdef HAVE_X_SM
10417 /* Only do this for the very first display in the Emacs session.
10418 Ignore X session management when Emacs was first started on a
10419 tty. */
10420 if (terminal->id == 1)
10421 x_session_initialize (dpyinfo);
10422 #endif
10424 unblock_input ();
10426 return dpyinfo;
10429 /* Get rid of display DPYINFO, deleting all frames on it,
10430 and without sending any more commands to the X server. */
10432 static void
10433 x_delete_display (struct x_display_info *dpyinfo)
10435 struct terminal *t;
10437 /* Close all frames and delete the generic struct terminal for this
10438 X display. */
10439 for (t = terminal_list; t; t = t->next_terminal)
10440 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10442 #ifdef HAVE_X_SM
10443 /* Close X session management when we close its display. */
10444 if (t->id == 1 && x_session_have_connection ())
10445 x_session_close ();
10446 #endif
10447 delete_terminal (t);
10448 break;
10451 delete_keyboard_wait_descriptor (dpyinfo->connection);
10453 /* Discard this display from x_display_name_list and x_display_list.
10454 We can't use Fdelq because that can quit. */
10455 if (! NILP (x_display_name_list)
10456 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10457 x_display_name_list = XCDR (x_display_name_list);
10458 else
10460 Lisp_Object tail;
10462 tail = x_display_name_list;
10463 while (CONSP (tail) && CONSP (XCDR (tail)))
10465 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10467 XSETCDR (tail, XCDR (XCDR (tail)));
10468 break;
10470 tail = XCDR (tail);
10474 if (next_noop_dpyinfo == dpyinfo)
10475 next_noop_dpyinfo = dpyinfo->next;
10477 if (x_display_list == dpyinfo)
10478 x_display_list = dpyinfo->next;
10479 else
10481 struct x_display_info *tail;
10483 for (tail = x_display_list; tail; tail = tail->next)
10484 if (tail->next == dpyinfo)
10485 tail->next = tail->next->next;
10488 xfree (dpyinfo->x_id_name);
10489 xfree (dpyinfo->x_dnd_atoms);
10490 xfree (dpyinfo->color_cells);
10491 xfree (dpyinfo);
10494 #ifdef USE_X_TOOLKIT
10496 /* Atimer callback function for TIMER. Called every 0.1s to process
10497 Xt timeouts, if needed. We must avoid calling XtAppPending as
10498 much as possible because that function does an implicit XFlush
10499 that slows us down. */
10501 static void
10502 x_process_timeouts (struct atimer *timer)
10504 block_input ();
10505 x_timeout_atimer_activated_flag = 0;
10506 if (toolkit_scroll_bar_interaction || popup_activated ())
10508 while (XtAppPending (Xt_app_con) & XtIMTimer)
10509 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10510 /* Reactivate the atimer for next time. */
10511 x_activate_timeout_atimer ();
10513 unblock_input ();
10516 /* Install an asynchronous timer that processes Xt timeout events
10517 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10518 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10519 function whenever these variables are set. This is necessary
10520 because some widget sets use timeouts internally, for example the
10521 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10522 processed, these widgets don't behave normally. */
10524 void
10525 x_activate_timeout_atimer (void)
10527 block_input ();
10528 if (!x_timeout_atimer_activated_flag)
10530 EMACS_TIME interval = make_emacs_time (0, 100 * 1000 * 1000);
10531 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10532 x_timeout_atimer_activated_flag = 1;
10534 unblock_input ();
10537 #endif /* USE_X_TOOLKIT */
10540 /* Set up use of X before we make the first connection. */
10542 static struct redisplay_interface x_redisplay_interface =
10544 x_frame_parm_handlers,
10545 x_produce_glyphs,
10546 x_write_glyphs,
10547 x_insert_glyphs,
10548 x_clear_end_of_line,
10549 x_scroll_run,
10550 x_after_update_window_line,
10551 x_update_window_begin,
10552 x_update_window_end,
10553 x_cursor_to,
10554 x_flush,
10555 #ifdef XFlush
10556 x_flush,
10557 #else
10558 0, /* flush_display_optional */
10559 #endif
10560 x_clear_window_mouse_face,
10561 x_get_glyph_overhangs,
10562 x_fix_overlapping_area,
10563 x_draw_fringe_bitmap,
10564 0, /* define_fringe_bitmap */
10565 0, /* destroy_fringe_bitmap */
10566 x_compute_glyph_string_overhangs,
10567 x_draw_glyph_string,
10568 x_define_frame_cursor,
10569 x_clear_frame_area,
10570 x_draw_window_cursor,
10571 x_draw_vertical_window_border,
10572 x_shift_glyphs_for_insert
10576 /* This function is called when the last frame on a display is deleted. */
10577 void
10578 x_delete_terminal (struct terminal *terminal)
10580 struct x_display_info *dpyinfo = terminal->display_info.x;
10582 /* Protect against recursive calls. delete_frame in
10583 delete_terminal calls us back when it deletes our last frame. */
10584 if (!terminal->name)
10585 return;
10587 block_input ();
10588 #ifdef HAVE_X_I18N
10589 /* We must close our connection to the XIM server before closing the
10590 X display. */
10591 if (dpyinfo->xim)
10592 xim_close_dpy (dpyinfo);
10593 #endif
10595 /* If called from x_connection_closed, the display may already be closed
10596 and dpyinfo->display was set to 0 to indicate that. */
10597 if (dpyinfo->display)
10599 x_destroy_all_bitmaps (dpyinfo);
10600 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10602 /* Whether or not XCloseDisplay destroys the associated resource
10603 database depends on the version of libX11. To avoid both
10604 crash and memory leak, we dissociate the database from the
10605 display and then destroy dpyinfo->xrdb ourselves.
10607 Unfortunately, the above strategy does not work in some
10608 situations due to a bug in newer versions of libX11: because
10609 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10610 dpy->db is NULL, XCloseDisplay destroys the associated
10611 database whereas it has not been created by XGetDefault
10612 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10613 don't destroy the database here in order to avoid the crash
10614 in the above situations for now, though that may cause memory
10615 leaks in other situations. */
10616 #if 0
10617 #ifdef HAVE_XRMSETDATABASE
10618 XrmSetDatabase (dpyinfo->display, NULL);
10619 #else
10620 dpyinfo->display->db = NULL;
10621 #endif
10622 /* We used to call XrmDestroyDatabase from x_delete_display, but
10623 some older versions of libX11 crash if we call it after
10624 closing all the displays. */
10625 XrmDestroyDatabase (dpyinfo->xrdb);
10626 #endif
10628 #ifdef USE_GTK
10629 xg_display_close (dpyinfo->display);
10630 #else
10631 #ifdef USE_X_TOOLKIT
10632 XtCloseDisplay (dpyinfo->display);
10633 #else
10634 XCloseDisplay (dpyinfo->display);
10635 #endif
10636 #endif /* ! USE_GTK */
10639 /* Mark as dead. */
10640 dpyinfo->display = NULL;
10641 x_delete_display (dpyinfo);
10642 unblock_input ();
10645 /* Create a struct terminal, initialize it with the X11 specific
10646 functions and make DISPLAY->TERMINAL point to it. */
10648 static struct terminal *
10649 x_create_terminal (struct x_display_info *dpyinfo)
10651 struct terminal *terminal;
10653 terminal = create_terminal ();
10655 terminal->type = output_x_window;
10656 terminal->display_info.x = dpyinfo;
10657 dpyinfo->terminal = terminal;
10659 /* kboard is initialized in x_term_init. */
10661 terminal->clear_frame_hook = x_clear_frame;
10662 terminal->ins_del_lines_hook = x_ins_del_lines;
10663 terminal->delete_glyphs_hook = x_delete_glyphs;
10664 terminal->ring_bell_hook = XTring_bell;
10665 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10666 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10667 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10668 terminal->update_begin_hook = x_update_begin;
10669 terminal->update_end_hook = x_update_end;
10670 terminal->set_terminal_window_hook = XTset_terminal_window;
10671 terminal->read_socket_hook = XTread_socket;
10672 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10673 terminal->mouse_position_hook = XTmouse_position;
10674 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10675 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10676 terminal->fullscreen_hook = XTfullscreen_hook;
10677 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10678 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10679 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10680 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10682 terminal->delete_frame_hook = x_destroy_window;
10683 terminal->delete_terminal_hook = x_delete_terminal;
10685 terminal->rif = &x_redisplay_interface;
10686 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10687 terminal->char_ins_del_ok = 1;
10688 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10689 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10690 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10691 off the bottom. */
10693 return terminal;
10696 void
10697 x_initialize (void)
10699 baud_rate = 19200;
10701 x_noop_count = 0;
10702 last_tool_bar_item = -1;
10703 any_help_event_p = 0;
10704 ignore_next_mouse_click_timeout = 0;
10706 #ifdef USE_GTK
10707 current_count = -1;
10708 #endif
10710 /* Try to use interrupt input; if we can't, then start polling. */
10711 Fset_input_interrupt_mode (Qt);
10713 #ifdef USE_X_TOOLKIT
10714 XtToolkitInitialize ();
10716 Xt_app_con = XtCreateApplicationContext ();
10718 /* Register a converter from strings to pixels, which uses
10719 Emacs' color allocation infrastructure. */
10720 XtAppSetTypeConverter (Xt_app_con,
10721 XtRString, XtRPixel, cvt_string_to_pixel,
10722 cvt_string_to_pixel_args,
10723 XtNumber (cvt_string_to_pixel_args),
10724 XtCacheByDisplay, cvt_pixel_dtor);
10726 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10727 #endif
10729 #ifdef USE_TOOLKIT_SCROLL_BARS
10730 #ifndef USE_GTK
10731 xaw3d_arrow_scroll = False;
10732 xaw3d_pick_top = True;
10733 #endif
10734 #endif
10736 pending_autoraise_frame = 0;
10737 pending_event_wait.f = 0;
10738 pending_event_wait.eventtype = 0;
10740 /* Note that there is no real way portable across R3/R4 to get the
10741 original error handler. */
10742 XSetErrorHandler (x_error_handler);
10743 XSetIOErrorHandler (x_io_error_quitter);
10747 void
10748 syms_of_xterm (void)
10750 x_error_message = NULL;
10752 staticpro (&x_display_name_list);
10753 x_display_name_list = Qnil;
10755 staticpro (&last_mouse_scroll_bar);
10756 last_mouse_scroll_bar = Qnil;
10758 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
10759 DEFSYM (Qlatin_1, "latin-1");
10761 staticpro (&last_mouse_press_frame);
10762 last_mouse_press_frame = Qnil;
10764 #ifdef USE_GTK
10765 xg_default_icon_file = build_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10766 staticpro (&xg_default_icon_file);
10768 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
10769 #endif
10771 DEFVAR_BOOL ("x-use-underline-position-properties",
10772 x_use_underline_position_properties,
10773 doc: /* Non-nil means make use of UNDERLINE_POSITION font properties.
10774 A value of nil means ignore them. If you encounter fonts with bogus
10775 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10776 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10777 to override the font's UNDERLINE_POSITION for small font display
10778 sizes. */);
10779 x_use_underline_position_properties = 1;
10781 DEFVAR_BOOL ("x-underline-at-descent-line",
10782 x_underline_at_descent_line,
10783 doc: /* Non-nil means to draw the underline at the same place as the descent line.
10784 A value of nil means to draw the underline according to the value of the
10785 variable `x-use-underline-position-properties', which is usually at the
10786 baseline level. The default value is nil. */);
10787 x_underline_at_descent_line = 0;
10789 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10790 x_mouse_click_focus_ignore_position,
10791 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10792 This variable is only used when the window manager requires that you
10793 click on a frame to select it (give it focus). In that case, a value
10794 of nil, means that the selected window and cursor position changes to
10795 reflect the mouse click position, while a non-nil value means that the
10796 selected window or cursor position is preserved. */);
10797 x_mouse_click_focus_ignore_position = 0;
10799 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10800 doc: /* Which toolkit scroll bars Emacs uses, if any.
10801 A value of nil means Emacs doesn't use toolkit scroll bars.
10802 With the X Window system, the value is a symbol describing the
10803 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10804 With MS Windows or Nextstep, the value is t. */);
10805 #ifdef USE_TOOLKIT_SCROLL_BARS
10806 #ifdef USE_MOTIF
10807 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10808 #elif defined HAVE_XAW3D
10809 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10810 #elif USE_GTK
10811 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10812 #else
10813 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10814 #endif
10815 #else
10816 Vx_toolkit_scroll_bars = Qnil;
10817 #endif
10819 staticpro (&last_mouse_motion_frame);
10820 last_mouse_motion_frame = Qnil;
10822 Qmodifier_value = intern_c_string ("modifier-value");
10823 Qalt = intern_c_string ("alt");
10824 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10825 Qhyper = intern_c_string ("hyper");
10826 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10827 Qmeta = intern_c_string ("meta");
10828 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10829 Qsuper = intern_c_string ("super");
10830 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10832 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10833 doc: /* Which keys Emacs uses for the alt modifier.
10834 This should be one of the symbols `alt', `hyper', `meta', `super'.
10835 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10836 is nil, which is the same as `alt'. */);
10837 Vx_alt_keysym = Qnil;
10839 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10840 doc: /* Which keys Emacs uses for the hyper modifier.
10841 This should be one of the symbols `alt', `hyper', `meta', `super'.
10842 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10843 default is nil, which is the same as `hyper'. */);
10844 Vx_hyper_keysym = Qnil;
10846 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10847 doc: /* Which keys Emacs uses for the meta modifier.
10848 This should be one of the symbols `alt', `hyper', `meta', `super'.
10849 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10850 default is nil, which is the same as `meta'. */);
10851 Vx_meta_keysym = Qnil;
10853 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10854 doc: /* Which keys Emacs uses for the super modifier.
10855 This should be one of the symbols `alt', `hyper', `meta', `super'.
10856 For example, `super' means use the Super_L and Super_R keysyms. The
10857 default is nil, which is the same as `super'. */);
10858 Vx_super_keysym = Qnil;
10860 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10861 doc: /* Hash table of character codes indexed by X keysym codes. */);
10862 Vx_keysym_table = make_hash_table (hashtest_eql, make_number (900),
10863 make_float (DEFAULT_REHASH_SIZE),
10864 make_float (DEFAULT_REHASH_THRESHOLD),
10865 Qnil);
10868 #endif /* HAVE_X_WINDOWS */