Fix a bug in the state cache mechanism. Refactor this a bit.
[emacs.git] / src / xterm.c
blobfb407c876114540e1db7b322167db1e7697609c5
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
21 /* Xt features made by Fred Pierresteguy. */
23 #include <config.h>
24 #include <stdio.h>
26 #ifdef HAVE_X_WINDOWS
28 #include "lisp.h"
29 #include "blockinput.h"
30 #include "syssignal.h"
32 /* This may include sys/types.h, and that somehow loses
33 if this is not done before the other system files. */
34 #include "xterm.h"
35 #include <X11/cursorfont.h>
37 /* Load sys/types.h if not already loaded.
38 In some systems loading it twice is suicidal. */
39 #ifndef makedev
40 #include <sys/types.h>
41 #endif /* makedev */
43 #include <sys/ioctl.h>
45 #include "systime.h"
47 #include <fcntl.h>
48 #include <errno.h>
49 #include <sys/stat.h>
50 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
51 /* #include <sys/param.h> */
53 #include "charset.h"
54 #include "character.h"
55 #include "coding.h"
56 #include "frame.h"
57 #include "dispextern.h"
58 #include "fontset.h"
59 #include "termhooks.h"
60 #include "termopts.h"
61 #include "termchar.h"
62 #include "emacs-icon.h"
63 #include "disptab.h"
64 #include "buffer.h"
65 #include "window.h"
66 #include "keyboard.h"
67 #include "intervals.h"
68 #include "process.h"
69 #include "atimer.h"
70 #include "keymap.h"
71 #include "font.h"
72 #include "fontset.h"
73 #include "xsettings.h"
74 #include "xgselect.h"
75 #include "sysselect.h"
77 #ifdef USE_X_TOOLKIT
78 #include <X11/Shell.h>
79 #endif
81 #include <unistd.h>
83 #ifdef USE_GTK
84 #include "gtkutil.h"
85 #ifdef HAVE_GTK3
86 #include <X11/Xproto.h>
87 #endif
88 #endif
90 #ifdef USE_LUCID
91 #include "../lwlib/xlwmenu.h"
92 #endif
94 #ifdef USE_X_TOOLKIT
95 #if !defined (NO_EDITRES)
96 #define HACK_EDITRES
97 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
98 #endif /* not NO_EDITRES */
100 /* Include toolkit specific headers for the scroll bar widget. */
102 #ifdef USE_TOOLKIT_SCROLL_BARS
103 #if defined USE_MOTIF
104 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
105 #include <Xm/ScrollBar.h>
106 #else /* !USE_MOTIF i.e. use Xaw */
108 #ifdef HAVE_XAW3D
109 #include <X11/Xaw3d/Simple.h>
110 #include <X11/Xaw3d/Scrollbar.h>
111 #include <X11/Xaw3d/ThreeD.h>
112 #else /* !HAVE_XAW3D */
113 #include <X11/Xaw/Simple.h>
114 #include <X11/Xaw/Scrollbar.h>
115 #endif /* !HAVE_XAW3D */
116 #ifndef XtNpickTop
117 #define XtNpickTop "pickTop"
118 #endif /* !XtNpickTop */
119 #endif /* !USE_MOTIF */
120 #endif /* USE_TOOLKIT_SCROLL_BARS */
122 #endif /* USE_X_TOOLKIT */
124 #ifdef USE_X_TOOLKIT
125 #include "widget.h"
126 #ifndef XtNinitialState
127 #define XtNinitialState "initialState"
128 #endif
129 #endif
131 #include "bitmaps/gray.xbm"
133 /* Default to using XIM if available. */
134 #ifdef USE_XIM
135 int use_xim = 1;
136 #else
137 int use_xim = 0; /* configure --without-xim */
138 #endif
142 /* Non-zero means that a HELP_EVENT has been generated since Emacs
143 start. */
145 static int any_help_event_p;
147 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
148 static Lisp_Object last_window;
150 /* This is a chain of structures for all the X displays currently in
151 use. */
153 struct x_display_info *x_display_list;
155 /* This is a list of cons cells, each of the form (NAME
156 . FONT-LIST-CACHE), one for each element of x_display_list and in
157 the same order. NAME is the name of the frame. FONT-LIST-CACHE
158 records previous values returned by x-list-fonts. */
160 Lisp_Object x_display_name_list;
162 /* This is a frame waiting to be auto-raised, within XTread_socket. */
164 static struct frame *pending_autoraise_frame;
166 /* This is a frame waiting for an event matching mask, within XTread_socket. */
168 static struct {
169 struct frame *f;
170 int eventtype;
171 } pending_event_wait;
173 #ifdef USE_X_TOOLKIT
174 /* The application context for Xt use. */
175 XtAppContext Xt_app_con;
176 static String Xt_default_resources[] = {0};
178 /* Non-zero means user is interacting with a toolkit scroll bar. */
180 static int toolkit_scroll_bar_interaction;
181 #endif /* USE_X_TOOLKIT */
183 /* Non-zero timeout value means ignore next mouse click if it arrives
184 before that timeout elapses (i.e. as part of the same sequence of
185 events resulting from clicking on a frame to select it). */
187 static unsigned long ignore_next_mouse_click_timeout;
189 /* Mouse movement.
191 Formerly, we used PointerMotionHintMask (in standard_event_mask)
192 so that we would have to call XQueryPointer after each MotionNotify
193 event to ask for another such event. However, this made mouse tracking
194 slow, and there was a bug that made it eventually stop.
196 Simply asking for MotionNotify all the time seems to work better.
198 In order to avoid asking for motion events and then throwing most
199 of them away or busy-polling the server for mouse positions, we ask
200 the server for pointer motion hints. This means that we get only
201 one event per group of mouse movements. "Groups" are delimited by
202 other kinds of events (focus changes and button clicks, for
203 example), or by XQueryPointer calls; when one of these happens, we
204 get another MotionNotify event the next time the mouse moves. This
205 is at least as efficient as getting motion events when mouse
206 tracking is on, and I suspect only negligibly worse when tracking
207 is off. */
209 /* Where the mouse was last time we reported a mouse event. */
211 static XRectangle last_mouse_glyph;
212 static FRAME_PTR last_mouse_glyph_frame;
213 static Lisp_Object last_mouse_press_frame;
215 /* The scroll bar in which the last X motion event occurred.
217 If the last X motion event occurred in a scroll bar, we set this so
218 XTmouse_position can know whether to report a scroll bar motion or
219 an ordinary motion.
221 If the last X motion event didn't occur in a scroll bar, we set
222 this to Qnil, to tell XTmouse_position to return an ordinary motion
223 event. */
225 static Lisp_Object last_mouse_scroll_bar;
227 /* This is a hack. We would really prefer that XTmouse_position would
228 return the time associated with the position it returns, but there
229 doesn't seem to be any way to wrest the time-stamp from the server
230 along with the position query. So, we just keep track of the time
231 of the last movement we received, and return that in hopes that
232 it's somewhat accurate. */
234 static Time last_mouse_movement_time;
236 /* Time for last user interaction as returned in X events. */
238 static Time last_user_time;
240 /* Incremented by XTread_socket whenever it really tries to read
241 events. */
243 static int volatile input_signal_count;
245 /* Used locally within XTread_socket. */
247 static int x_noop_count;
249 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
251 static Lisp_Object Qvendor_specific_keysyms;
252 static Lisp_Object Qlatin_1;
254 #ifdef USE_GTK
255 /* The name of the Emacs icon file. */
256 static Lisp_Object xg_default_icon_file;
258 /* Used in gtkutil.c. */
259 Lisp_Object Qx_gtk_map_stock;
260 #endif
262 /* Some functions take this as char *, not const char *. */
263 static char emacs_class[] = EMACS_CLASS;
265 enum xembed_info
267 XEMBED_MAPPED = 1 << 0
270 enum xembed_message
272 XEMBED_EMBEDDED_NOTIFY = 0,
273 XEMBED_WINDOW_ACTIVATE = 1,
274 XEMBED_WINDOW_DEACTIVATE = 2,
275 XEMBED_REQUEST_FOCUS = 3,
276 XEMBED_FOCUS_IN = 4,
277 XEMBED_FOCUS_OUT = 5,
278 XEMBED_FOCUS_NEXT = 6,
279 XEMBED_FOCUS_PREV = 7,
281 XEMBED_MODALITY_ON = 10,
282 XEMBED_MODALITY_OFF = 11,
283 XEMBED_REGISTER_ACCELERATOR = 12,
284 XEMBED_UNREGISTER_ACCELERATOR = 13,
285 XEMBED_ACTIVATE_ACCELERATOR = 14
288 /* Used in x_flush. */
290 static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
291 static void x_set_window_size_1 (struct frame *, int, int, int);
292 static void x_raise_frame (struct frame *);
293 static void x_lower_frame (struct frame *);
294 static const XColor *x_color_cells (Display *, int *);
295 static void x_update_window_end (struct window *, int, int);
297 static int x_io_error_quitter (Display *);
298 static struct terminal *x_create_terminal (struct x_display_info *);
299 void x_delete_terminal (struct terminal *);
300 static void x_update_end (struct frame *);
301 static void XTframe_up_to_date (struct frame *);
302 static void XTset_terminal_modes (struct terminal *);
303 static void XTreset_terminal_modes (struct terminal *);
304 static void x_clear_frame (struct frame *);
305 static _Noreturn void x_ins_del_lines (struct frame *, int, int);
306 static void frame_highlight (struct frame *);
307 static void frame_unhighlight (struct frame *);
308 static void x_new_focus_frame (struct x_display_info *, struct frame *);
309 static void x_focus_changed (int, int, struct x_display_info *,
310 struct frame *, struct input_event *);
311 static void x_detect_focus_change (struct x_display_info *,
312 XEvent *, struct input_event *);
313 static void XTframe_rehighlight (struct frame *);
314 static void x_frame_rehighlight (struct x_display_info *);
315 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
316 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
317 enum text_cursor_kinds);
319 static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
320 static void x_flush (struct frame *f);
321 static void x_update_begin (struct frame *);
322 static void x_update_window_begin (struct window *);
323 static void x_after_update_window_line (struct glyph_row *);
324 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
325 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
326 enum scroll_bar_part *,
327 Lisp_Object *, Lisp_Object *,
328 Time *);
329 static int x_handle_net_wm_state (struct frame *, XPropertyEvent *);
330 static void x_check_fullscreen (struct frame *);
331 static void x_check_expected_move (struct frame *, int, int);
332 static void x_sync_with_move (struct frame *, int, int, int);
333 static int handle_one_xevent (struct x_display_info *, XEvent *,
334 int *, struct input_event *);
335 #ifdef USE_GTK
336 static int x_dispatch_event (XEvent *, Display *);
337 #endif
338 /* Don't declare this _Noreturn because we want no
339 interference with debugging failing X calls. */
340 static void x_connection_closed (Display *, const char *);
341 static void x_wm_set_window_state (struct frame *, int);
342 static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
343 static void x_initialize (void);
346 /* Flush display of frame F, or of all frames if F is null. */
348 static void
349 x_flush (struct frame *f)
351 /* Don't call XFlush when it is not safe to redisplay; the X
352 connection may be broken. */
353 if (!NILP (Vinhibit_redisplay))
354 return;
356 block_input ();
357 if (f == NULL)
359 Lisp_Object rest, frame;
360 FOR_EACH_FRAME (rest, frame)
361 if (FRAME_X_P (XFRAME (frame)))
362 x_flush (XFRAME (frame));
364 else if (FRAME_X_P (f))
365 XFlush (FRAME_X_DISPLAY (f));
366 unblock_input ();
370 /* Remove calls to XFlush by defining XFlush to an empty replacement.
371 Calls to XFlush should be unnecessary because the X output buffer
372 is flushed automatically as needed by calls to XPending,
373 XNextEvent, or XWindowEvent according to the XFlush man page.
374 XTread_socket calls XPending. Removing XFlush improves
375 performance. */
377 #define XFlush(DISPLAY) (void) 0
380 /***********************************************************************
381 Debugging
382 ***********************************************************************/
384 #if 0
386 /* This is a function useful for recording debugging information about
387 the sequence of occurrences in this file. */
389 struct record
391 char *locus;
392 int type;
395 struct record event_record[100];
397 int event_record_index;
399 void
400 record_event (char *locus, int type)
402 if (event_record_index == sizeof (event_record) / sizeof (struct record))
403 event_record_index = 0;
405 event_record[event_record_index].locus = locus;
406 event_record[event_record_index].type = type;
407 event_record_index++;
410 #endif /* 0 */
414 /* Return the struct x_display_info corresponding to DPY. */
416 struct x_display_info *
417 x_display_info_for_display (Display *dpy)
419 struct x_display_info *dpyinfo;
421 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
422 if (dpyinfo->display == dpy)
423 return dpyinfo;
425 return 0;
428 static Window
429 x_find_topmost_parent (struct frame *f)
431 struct x_output *x = f->output_data.x;
432 Window win = None, wi = x->parent_desc;
433 Display *dpy = FRAME_X_DISPLAY (f);
435 while (wi != FRAME_X_DISPLAY_INFO (f)->root_window)
437 Window root;
438 Window *children;
439 unsigned int nchildren;
441 win = wi;
442 XQueryTree (dpy, win, &root, &wi, &children, &nchildren);
443 XFree (children);
446 return win;
449 #define OPAQUE 0xffffffff
451 void
452 x_set_frame_alpha (struct frame *f)
454 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
455 Display *dpy = FRAME_X_DISPLAY (f);
456 Window win = FRAME_OUTER_WINDOW (f);
457 double alpha = 1.0;
458 double alpha_min = 1.0;
459 unsigned long opac;
460 Window parent;
462 if (dpyinfo->x_highlight_frame == f)
463 alpha = f->alpha[0];
464 else
465 alpha = f->alpha[1];
467 if (FLOATP (Vframe_alpha_lower_limit))
468 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
469 else if (INTEGERP (Vframe_alpha_lower_limit))
470 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
472 if (alpha < 0.0)
473 return;
474 else if (alpha > 1.0)
475 alpha = 1.0;
476 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
477 alpha = alpha_min;
479 opac = alpha * OPAQUE;
481 x_catch_errors (dpy);
483 /* If there is a parent from the window manager, put the property there
484 also, to work around broken window managers that fail to do that.
485 Do this unconditionally as this function is called on reparent when
486 alpha has not changed on the frame. */
488 parent = x_find_topmost_parent (f);
489 if (parent != None)
490 XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
491 XA_CARDINAL, 32, PropModeReplace,
492 (unsigned char *) &opac, 1L);
494 /* return unless necessary */
496 unsigned char *data;
497 Atom actual;
498 int rc, format;
499 unsigned long n, left;
501 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
502 0L, 1L, False, XA_CARDINAL,
503 &actual, &format, &n, &left,
504 &data);
506 if (rc == Success && actual != None)
508 unsigned long value = *(unsigned long *)data;
509 XFree (data);
510 if (value == opac)
512 x_uncatch_errors ();
513 return;
518 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
519 XA_CARDINAL, 32, PropModeReplace,
520 (unsigned char *) &opac, 1L);
521 x_uncatch_errors ();
525 x_display_pixel_height (struct x_display_info *dpyinfo)
527 return HeightOfScreen (dpyinfo->screen);
531 x_display_pixel_width (struct x_display_info *dpyinfo)
533 return WidthOfScreen (dpyinfo->screen);
537 /***********************************************************************
538 Starting and ending an update
539 ***********************************************************************/
541 /* Start an update of frame F. This function is installed as a hook
542 for update_begin, i.e. it is called when update_begin is called.
543 This function is called prior to calls to x_update_window_begin for
544 each window being updated. Currently, there is nothing to do here
545 because all interesting stuff is done on a window basis. */
547 static void
548 x_update_begin (struct frame *f)
550 /* Nothing to do. */
554 /* Start update of window W. Set the global variable updated_window
555 to the window being updated and set output_cursor to the cursor
556 position of W. */
558 static void
559 x_update_window_begin (struct window *w)
561 struct frame *f = XFRAME (WINDOW_FRAME (w));
562 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
564 updated_window = w;
565 set_output_cursor (&w->cursor);
567 block_input ();
569 if (f == hlinfo->mouse_face_mouse_frame)
571 /* Don't do highlighting for mouse motion during the update. */
572 hlinfo->mouse_face_defer = 1;
574 /* If F needs to be redrawn, simply forget about any prior mouse
575 highlighting. */
576 if (FRAME_GARBAGED_P (f))
577 hlinfo->mouse_face_window = Qnil;
580 unblock_input ();
584 /* Draw a vertical window border from (x,y0) to (x,y1) */
586 static void
587 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
589 struct frame *f = XFRAME (WINDOW_FRAME (w));
590 struct face *face;
592 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
593 if (face)
594 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
595 face->foreground);
597 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
598 f->output_data.x->normal_gc, x, y0, x, y1);
601 /* End update of window W (which is equal to updated_window).
603 Draw vertical borders between horizontally adjacent windows, and
604 display W's cursor if CURSOR_ON_P is non-zero.
606 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
607 glyphs in mouse-face were overwritten. In that case we have to
608 make sure that the mouse-highlight is properly redrawn.
610 W may be a menu bar pseudo-window in case we don't have X toolkit
611 support. Such windows don't have a cursor, so don't display it
612 here. */
614 static void
615 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
617 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
619 if (!w->pseudo_window_p)
621 block_input ();
623 if (cursor_on_p)
624 display_and_set_cursor (w, 1, output_cursor.hpos,
625 output_cursor.vpos,
626 output_cursor.x, output_cursor.y);
628 if (draw_window_fringes (w, 1))
629 x_draw_vertical_border (w);
631 unblock_input ();
634 /* If a row with mouse-face was overwritten, arrange for
635 XTframe_up_to_date to redisplay the mouse highlight. */
636 if (mouse_face_overwritten_p)
638 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
639 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
640 hlinfo->mouse_face_window = Qnil;
643 updated_window = NULL;
647 /* End update of frame F. This function is installed as a hook in
648 update_end. */
650 static void
651 x_update_end (struct frame *f)
653 /* Mouse highlight may be displayed again. */
654 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
656 #ifndef XFlush
657 block_input ();
658 XFlush (FRAME_X_DISPLAY (f));
659 unblock_input ();
660 #endif
664 /* This function is called from various places in xdisp.c whenever a
665 complete update has been performed. The global variable
666 updated_window is not available here. */
668 static void
669 XTframe_up_to_date (struct frame *f)
671 if (FRAME_X_P (f))
673 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
675 if (hlinfo->mouse_face_deferred_gc
676 || f == hlinfo->mouse_face_mouse_frame)
678 block_input ();
679 if (hlinfo->mouse_face_mouse_frame)
680 note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
681 hlinfo->mouse_face_mouse_x,
682 hlinfo->mouse_face_mouse_y);
683 hlinfo->mouse_face_deferred_gc = 0;
684 unblock_input ();
690 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
691 arrow bitmaps, or clear the fringes if no bitmaps are required
692 before DESIRED_ROW is made current. The window being updated is
693 found in updated_window. This function It is called from
694 update_window_line only if it is known that there are differences
695 between bitmaps to be drawn between current row and DESIRED_ROW. */
697 static void
698 x_after_update_window_line (struct glyph_row *desired_row)
700 struct window *w = updated_window;
701 struct frame *f;
702 int width, height;
704 eassert (w);
706 if (!desired_row->mode_line_p && !w->pseudo_window_p)
707 desired_row->redraw_fringe_bitmaps_p = 1;
709 /* When a window has disappeared, make sure that no rest of
710 full-width rows stays visible in the internal border. Could
711 check here if updated_window is the leftmost/rightmost window,
712 but I guess it's not worth doing since vertically split windows
713 are almost never used, internal border is rarely set, and the
714 overhead is very small. */
715 if (windows_or_buffers_changed
716 && desired_row->full_width_p
717 && (f = XFRAME (w->frame),
718 width = FRAME_INTERNAL_BORDER_WIDTH (f),
719 width != 0)
720 && (height = desired_row->visible_height,
721 height > 0))
723 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
725 block_input ();
726 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
727 0, y, width, height, False);
728 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
729 FRAME_PIXEL_WIDTH (f) - width,
730 y, width, height, False);
731 unblock_input ();
735 static void
736 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
738 struct frame *f = XFRAME (WINDOW_FRAME (w));
739 Display *display = FRAME_X_DISPLAY (f);
740 Window window = FRAME_X_WINDOW (f);
741 GC gc = f->output_data.x->normal_gc;
742 struct face *face = p->face;
744 /* Must clip because of partially visible lines. */
745 x_clip_to_row (w, row, -1, gc);
747 if (!p->overlay_p)
749 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
751 /* In case the same realized face is used for fringes and
752 for something displayed in the text (e.g. face `region' on
753 mono-displays, the fill style may have been changed to
754 FillSolid in x_draw_glyph_string_background. */
755 if (face->stipple)
756 XSetFillStyle (display, face->gc, FillOpaqueStippled);
757 else
758 XSetForeground (display, face->gc, face->background);
760 #ifdef USE_TOOLKIT_SCROLL_BARS
761 /* If the fringe is adjacent to the left (right) scroll bar of a
762 leftmost (rightmost, respectively) window, then extend its
763 background to the gap between the fringe and the bar. */
764 if ((WINDOW_LEFTMOST_P (w)
765 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
766 || (WINDOW_RIGHTMOST_P (w)
767 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
769 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
771 if (sb_width > 0)
773 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
774 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
775 * FRAME_COLUMN_WIDTH (f));
777 if (bx < 0)
779 /* Bitmap fills the fringe. */
780 if (bar_area_x + bar_area_width == p->x)
781 bx = bar_area_x + sb_width;
782 else if (p->x + p->wd == bar_area_x)
783 bx = bar_area_x;
784 if (bx >= 0)
786 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
788 nx = bar_area_width - sb_width;
789 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
790 row->y));
791 ny = row->visible_height;
794 else
796 if (bar_area_x + bar_area_width == bx)
798 bx = bar_area_x + sb_width;
799 nx += bar_area_width - sb_width;
801 else if (bx + nx == bar_area_x)
802 nx += bar_area_width - sb_width;
806 #endif
807 if (bx >= 0 && nx > 0)
808 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
810 if (!face->stipple)
811 XSetForeground (display, face->gc, face->foreground);
814 if (p->which)
816 char *bits;
817 Pixmap pixmap, clipmask = (Pixmap) 0;
818 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
819 XGCValues gcv;
821 if (p->wd > 8)
822 bits = (char *) (p->bits + p->dh);
823 else
824 bits = (char *) p->bits + p->dh;
826 /* Draw the bitmap. I believe these small pixmaps can be cached
827 by the server. */
828 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
829 (p->cursor_p
830 ? (p->overlay_p ? face->background
831 : f->output_data.x->cursor_pixel)
832 : face->foreground),
833 face->background, depth);
835 if (p->overlay_p)
837 clipmask = XCreatePixmapFromBitmapData (display,
838 FRAME_X_DISPLAY_INFO (f)->root_window,
839 bits, p->wd, p->h,
840 1, 0, 1);
841 gcv.clip_mask = clipmask;
842 gcv.clip_x_origin = p->x;
843 gcv.clip_y_origin = p->y;
844 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
847 XCopyArea (display, pixmap, window, gc, 0, 0,
848 p->wd, p->h, p->x, p->y);
849 XFreePixmap (display, pixmap);
851 if (p->overlay_p)
853 gcv.clip_mask = (Pixmap) 0;
854 XChangeGC (display, gc, GCClipMask, &gcv);
855 XFreePixmap (display, clipmask);
859 XSetClipMask (display, gc, None);
864 /* This is called when starting Emacs and when restarting after
865 suspend. When starting Emacs, no X window is mapped. And nothing
866 must be done to Emacs's own window if it is suspended (though that
867 rarely happens). */
869 static void
870 XTset_terminal_modes (struct terminal *terminal)
874 /* This is called when exiting or suspending Emacs. Exiting will make
875 the X-windows go away, and suspending requires no action. */
877 static void
878 XTreset_terminal_modes (struct terminal *terminal)
883 /***********************************************************************
884 Glyph display
885 ***********************************************************************/
889 static void x_set_glyph_string_clipping (struct glyph_string *);
890 static void x_set_glyph_string_gc (struct glyph_string *);
891 static void x_draw_glyph_string_background (struct glyph_string *,
892 int);
893 static void x_draw_glyph_string_foreground (struct glyph_string *);
894 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
895 static void x_draw_glyph_string_box (struct glyph_string *);
896 static void x_draw_glyph_string (struct glyph_string *);
897 static _Noreturn void x_delete_glyphs (struct frame *, int);
898 static void x_compute_glyph_string_overhangs (struct glyph_string *);
899 static void x_set_cursor_gc (struct glyph_string *);
900 static void x_set_mode_line_face_gc (struct glyph_string *);
901 static void x_set_mouse_face_gc (struct glyph_string *);
902 static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
903 unsigned long *, double, int);
904 static void x_setup_relief_color (struct frame *, struct relief *,
905 double, int, unsigned long);
906 static void x_setup_relief_colors (struct glyph_string *);
907 static void x_draw_image_glyph_string (struct glyph_string *);
908 static void x_draw_image_relief (struct glyph_string *);
909 static void x_draw_image_foreground (struct glyph_string *);
910 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
911 static void x_clear_glyph_string_rect (struct glyph_string *, int,
912 int, int, int);
913 static void x_draw_relief_rect (struct frame *, int, int, int, int,
914 int, int, int, int, int, int,
915 XRectangle *);
916 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
917 int, int, int, XRectangle *);
918 static void x_scroll_bar_clear (struct frame *);
920 #ifdef GLYPH_DEBUG
921 static void x_check_font (struct frame *, struct font *);
922 #endif
925 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
926 face. */
928 static void
929 x_set_cursor_gc (struct glyph_string *s)
931 if (s->font == FRAME_FONT (s->f)
932 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
933 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
934 && !s->cmp)
935 s->gc = s->f->output_data.x->cursor_gc;
936 else
938 /* Cursor on non-default face: must merge. */
939 XGCValues xgcv;
940 unsigned long mask;
942 xgcv.background = s->f->output_data.x->cursor_pixel;
943 xgcv.foreground = s->face->background;
945 /* If the glyph would be invisible, try a different foreground. */
946 if (xgcv.foreground == xgcv.background)
947 xgcv.foreground = s->face->foreground;
948 if (xgcv.foreground == xgcv.background)
949 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
950 if (xgcv.foreground == xgcv.background)
951 xgcv.foreground = s->face->foreground;
953 /* Make sure the cursor is distinct from text in this face. */
954 if (xgcv.background == s->face->background
955 && xgcv.foreground == s->face->foreground)
957 xgcv.background = s->face->foreground;
958 xgcv.foreground = s->face->background;
961 IF_DEBUG (x_check_font (s->f, s->font));
962 xgcv.graphics_exposures = False;
963 mask = GCForeground | GCBackground | GCGraphicsExposures;
965 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
966 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
967 mask, &xgcv);
968 else
969 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
970 = XCreateGC (s->display, s->window, mask, &xgcv);
972 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
977 /* Set up S->gc of glyph string S for drawing text in mouse face. */
979 static void
980 x_set_mouse_face_gc (struct glyph_string *s)
982 int face_id;
983 struct face *face;
985 /* What face has to be used last for the mouse face? */
986 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
987 face = FACE_FROM_ID (s->f, face_id);
988 if (face == NULL)
989 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
991 if (s->first_glyph->type == CHAR_GLYPH)
992 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
993 else
994 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
995 s->face = FACE_FROM_ID (s->f, face_id);
996 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
998 if (s->font == s->face->font)
999 s->gc = s->face->gc;
1000 else
1002 /* Otherwise construct scratch_cursor_gc with values from FACE
1003 except for FONT. */
1004 XGCValues xgcv;
1005 unsigned long mask;
1007 xgcv.background = s->face->background;
1008 xgcv.foreground = s->face->foreground;
1009 xgcv.graphics_exposures = False;
1010 mask = GCForeground | GCBackground | GCGraphicsExposures;
1012 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1013 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1014 mask, &xgcv);
1015 else
1016 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1017 = XCreateGC (s->display, s->window, mask, &xgcv);
1019 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1022 eassert (s->gc != 0);
1026 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1027 Faces to use in the mode line have already been computed when the
1028 matrix was built, so there isn't much to do, here. */
1030 static void
1031 x_set_mode_line_face_gc (struct glyph_string *s)
1033 s->gc = s->face->gc;
1037 /* Set S->gc of glyph string S for drawing that glyph string. Set
1038 S->stippled_p to a non-zero value if the face of S has a stipple
1039 pattern. */
1041 static void
1042 x_set_glyph_string_gc (struct glyph_string *s)
1044 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1046 if (s->hl == DRAW_NORMAL_TEXT)
1048 s->gc = s->face->gc;
1049 s->stippled_p = s->face->stipple != 0;
1051 else if (s->hl == DRAW_INVERSE_VIDEO)
1053 x_set_mode_line_face_gc (s);
1054 s->stippled_p = s->face->stipple != 0;
1056 else if (s->hl == DRAW_CURSOR)
1058 x_set_cursor_gc (s);
1059 s->stippled_p = 0;
1061 else if (s->hl == DRAW_MOUSE_FACE)
1063 x_set_mouse_face_gc (s);
1064 s->stippled_p = s->face->stipple != 0;
1066 else if (s->hl == DRAW_IMAGE_RAISED
1067 || s->hl == DRAW_IMAGE_SUNKEN)
1069 s->gc = s->face->gc;
1070 s->stippled_p = s->face->stipple != 0;
1072 else
1074 s->gc = s->face->gc;
1075 s->stippled_p = s->face->stipple != 0;
1078 /* GC must have been set. */
1079 eassert (s->gc != 0);
1083 /* Set clipping for output of glyph string S. S may be part of a mode
1084 line or menu if we don't have X toolkit support. */
1086 static void
1087 x_set_glyph_string_clipping (struct glyph_string *s)
1089 XRectangle *r = s->clip;
1090 int n = get_glyph_string_clip_rects (s, r, 2);
1092 if (n > 0)
1093 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1094 s->num_clips = n;
1098 /* Set SRC's clipping for output of glyph string DST. This is called
1099 when we are drawing DST's left_overhang or right_overhang only in
1100 the area of SRC. */
1102 static void
1103 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1105 XRectangle r;
1107 r.x = src->x;
1108 r.width = src->width;
1109 r.y = src->y;
1110 r.height = src->height;
1111 dst->clip[0] = r;
1112 dst->num_clips = 1;
1113 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1117 /* RIF:
1118 Compute left and right overhang of glyph string S. */
1120 static void
1121 x_compute_glyph_string_overhangs (struct glyph_string *s)
1123 if (s->cmp == NULL
1124 && (s->first_glyph->type == CHAR_GLYPH
1125 || s->first_glyph->type == COMPOSITE_GLYPH))
1127 struct font_metrics metrics;
1129 if (s->first_glyph->type == CHAR_GLYPH)
1131 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1132 struct font *font = s->font;
1133 int i;
1135 for (i = 0; i < s->nchars; i++)
1136 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1137 font->driver->text_extents (font, code, s->nchars, &metrics);
1139 else
1141 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1143 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1145 s->right_overhang = (metrics.rbearing > metrics.width
1146 ? metrics.rbearing - metrics.width : 0);
1147 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1149 else if (s->cmp)
1151 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1152 s->left_overhang = - s->cmp->lbearing;
1157 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1159 static void
1160 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1162 XGCValues xgcv;
1163 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1164 XSetForeground (s->display, s->gc, xgcv.background);
1165 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1166 XSetForeground (s->display, s->gc, xgcv.foreground);
1170 /* Draw the background of glyph_string S. If S->background_filled_p
1171 is non-zero don't draw it. FORCE_P non-zero means draw the
1172 background even if it wouldn't be drawn normally. This is used
1173 when a string preceding S draws into the background of S, or S
1174 contains the first component of a composition. */
1176 static void
1177 x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1179 /* Nothing to do if background has already been drawn or if it
1180 shouldn't be drawn in the first place. */
1181 if (!s->background_filled_p)
1183 int box_line_width = max (s->face->box_line_width, 0);
1185 if (s->stippled_p)
1187 /* Fill background with a stipple pattern. */
1188 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1189 XFillRectangle (s->display, s->window, s->gc, s->x,
1190 s->y + box_line_width,
1191 s->background_width,
1192 s->height - 2 * box_line_width);
1193 XSetFillStyle (s->display, s->gc, FillSolid);
1194 s->background_filled_p = 1;
1196 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1197 || s->font_not_found_p
1198 || s->extends_to_end_of_line_p
1199 || force_p)
1201 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1202 s->background_width,
1203 s->height - 2 * box_line_width);
1204 s->background_filled_p = 1;
1210 /* Draw the foreground of glyph string S. */
1212 static void
1213 x_draw_glyph_string_foreground (struct glyph_string *s)
1215 int i, x;
1217 /* If first glyph of S has a left box line, start drawing the text
1218 of S to the right of that box line. */
1219 if (s->face->box != FACE_NO_BOX
1220 && s->first_glyph->left_box_line_p)
1221 x = s->x + eabs (s->face->box_line_width);
1222 else
1223 x = s->x;
1225 /* Draw characters of S as rectangles if S's font could not be
1226 loaded. */
1227 if (s->font_not_found_p)
1229 for (i = 0; i < s->nchars; ++i)
1231 struct glyph *g = s->first_glyph + i;
1232 XDrawRectangle (s->display, s->window,
1233 s->gc, x, s->y, g->pixel_width - 1,
1234 s->height - 1);
1235 x += g->pixel_width;
1238 else
1240 struct font *font = s->font;
1241 int boff = font->baseline_offset;
1242 int y;
1244 if (font->vertical_centering)
1245 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1247 y = s->ybase - boff;
1248 if (s->for_overlaps
1249 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1250 font->driver->draw (s, 0, s->nchars, x, y, 0);
1251 else
1252 font->driver->draw (s, 0, s->nchars, x, y, 1);
1253 if (s->face->overstrike)
1254 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1258 /* Draw the foreground of composite glyph string S. */
1260 static void
1261 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1263 int i, j, x;
1264 struct font *font = s->font;
1266 /* If first glyph of S has a left box line, start drawing the text
1267 of S to the right of that box line. */
1268 if (s->face && s->face->box != FACE_NO_BOX
1269 && s->first_glyph->left_box_line_p)
1270 x = s->x + eabs (s->face->box_line_width);
1271 else
1272 x = s->x;
1274 /* S is a glyph string for a composition. S->cmp_from is the index
1275 of the first character drawn for glyphs of this composition.
1276 S->cmp_from == 0 means we are drawing the very first character of
1277 this composition. */
1279 /* Draw a rectangle for the composition if the font for the very
1280 first character of the composition could not be loaded. */
1281 if (s->font_not_found_p)
1283 if (s->cmp_from == 0)
1284 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1285 s->width - 1, s->height - 1);
1287 else if (! s->first_glyph->u.cmp.automatic)
1289 int y = s->ybase;
1291 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1292 /* TAB in a composition means display glyphs with padding
1293 space on the left or right. */
1294 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1296 int xx = x + s->cmp->offsets[j * 2];
1297 int yy = y - s->cmp->offsets[j * 2 + 1];
1299 font->driver->draw (s, j, j + 1, xx, yy, 0);
1300 if (s->face->overstrike)
1301 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1304 else
1306 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1307 Lisp_Object glyph;
1308 int y = s->ybase;
1309 int width = 0;
1311 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1313 glyph = LGSTRING_GLYPH (gstring, i);
1314 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1315 width += LGLYPH_WIDTH (glyph);
1316 else
1318 int xoff, yoff, wadjust;
1320 if (j < i)
1322 font->driver->draw (s, j, i, x, y, 0);
1323 if (s->face->overstrike)
1324 font->driver->draw (s, j, i, x + 1, y, 0);
1325 x += width;
1327 xoff = LGLYPH_XOFF (glyph);
1328 yoff = LGLYPH_YOFF (glyph);
1329 wadjust = LGLYPH_WADJUST (glyph);
1330 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1331 if (s->face->overstrike)
1332 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1333 x += wadjust;
1334 j = i + 1;
1335 width = 0;
1338 if (j < i)
1340 font->driver->draw (s, j, i, x, y, 0);
1341 if (s->face->overstrike)
1342 font->driver->draw (s, j, i, x + 1, y, 0);
1348 /* Draw the foreground of glyph string S for glyphless characters. */
1350 static void
1351 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1353 struct glyph *glyph = s->first_glyph;
1354 XChar2b char2b[8];
1355 int x, i, j;
1357 /* If first glyph of S has a left box line, start drawing the text
1358 of S to the right of that box line. */
1359 if (s->face && s->face->box != FACE_NO_BOX
1360 && s->first_glyph->left_box_line_p)
1361 x = s->x + eabs (s->face->box_line_width);
1362 else
1363 x = s->x;
1365 s->char2b = char2b;
1367 for (i = 0; i < s->nchars; i++, glyph++)
1369 char buf[7], *str = NULL;
1370 int len = glyph->u.glyphless.len;
1372 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1374 if (len > 0
1375 && CHAR_TABLE_P (Vglyphless_char_display)
1376 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1377 >= 1))
1379 Lisp_Object acronym
1380 = (! glyph->u.glyphless.for_no_font
1381 ? CHAR_TABLE_REF (Vglyphless_char_display,
1382 glyph->u.glyphless.ch)
1383 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1384 if (STRINGP (acronym))
1385 str = SSDATA (acronym);
1388 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1390 sprintf ((char *) buf, "%0*X",
1391 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1392 glyph->u.glyphless.ch);
1393 str = buf;
1396 if (str)
1398 int upper_len = (len + 1) / 2;
1399 unsigned code;
1401 /* It is assured that all LEN characters in STR is ASCII. */
1402 for (j = 0; j < len; j++)
1404 code = s->font->driver->encode_char (s->font, str[j]);
1405 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1407 s->font->driver->draw (s, 0, upper_len,
1408 x + glyph->slice.glyphless.upper_xoff,
1409 s->ybase + glyph->slice.glyphless.upper_yoff,
1411 s->font->driver->draw (s, upper_len, len,
1412 x + glyph->slice.glyphless.lower_xoff,
1413 s->ybase + glyph->slice.glyphless.lower_yoff,
1416 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1417 XDrawRectangle (s->display, s->window, s->gc,
1418 x, s->ybase - glyph->ascent,
1419 glyph->pixel_width - 1,
1420 glyph->ascent + glyph->descent - 1);
1421 x += glyph->pixel_width;
1425 #ifdef USE_X_TOOLKIT
1427 static Boolean cvt_string_to_pixel (Display *, XrmValue *, Cardinal *,
1428 XrmValue *, XrmValue *, XtPointer *);
1429 static void cvt_pixel_dtor (XtAppContext, XrmValue *, XtPointer,
1430 XrmValue *, Cardinal *);
1432 #ifdef USE_LUCID
1434 /* Return the frame on which widget WIDGET is used.. Abort if frame
1435 cannot be determined. */
1437 static struct frame *
1438 x_frame_of_widget (Widget widget)
1440 struct x_display_info *dpyinfo;
1441 Lisp_Object tail;
1442 struct frame *f;
1444 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1446 /* Find the top-level shell of the widget. Note that this function
1447 can be called when the widget is not yet realized, so XtWindow
1448 (widget) == 0. That's the reason we can't simply use
1449 x_any_window_to_frame. */
1450 while (!XtIsTopLevelShell (widget))
1451 widget = XtParent (widget);
1453 /* Look for a frame with that top-level widget. Allocate the color
1454 on that frame to get the right gamma correction value. */
1455 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1456 if (FRAMEP (XCAR (tail))
1457 && (f = XFRAME (XCAR (tail)),
1458 (FRAME_X_P (f)
1459 && f->output_data.nothing != 1
1460 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1461 && f->output_data.x->widget == widget)
1462 return f;
1464 emacs_abort ();
1467 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1468 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1469 If this produces the same color as PIXEL, try a color where all RGB
1470 values have DELTA added. Return the allocated color in *PIXEL.
1471 DISPLAY is the X display, CMAP is the colormap to operate on.
1472 Value is true if successful. */
1474 bool
1475 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1476 unsigned long *pixel, double factor, int delta)
1478 struct frame *f = x_frame_of_widget (widget);
1479 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1482 #endif /* USE_LUCID */
1485 /* Structure specifying which arguments should be passed by Xt to
1486 cvt_string_to_pixel. We want the widget's screen and colormap. */
1488 static XtConvertArgRec cvt_string_to_pixel_args[] =
1490 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1491 sizeof (Screen *)},
1492 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1493 sizeof (Colormap)}
1497 /* The address of this variable is returned by
1498 cvt_string_to_pixel. */
1500 static Pixel cvt_string_to_pixel_value;
1503 /* Convert a color name to a pixel color.
1505 DPY is the display we are working on.
1507 ARGS is an array of *NARGS XrmValue structures holding additional
1508 information about the widget for which the conversion takes place.
1509 The contents of this array are determined by the specification
1510 in cvt_string_to_pixel_args.
1512 FROM is a pointer to an XrmValue which points to the color name to
1513 convert. TO is an XrmValue in which to return the pixel color.
1515 CLOSURE_RET is a pointer to user-data, in which we record if
1516 we allocated the color or not.
1518 Value is True if successful, False otherwise. */
1520 static Boolean
1521 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1522 XrmValue *from, XrmValue *to,
1523 XtPointer *closure_ret)
1525 Screen *screen;
1526 Colormap cmap;
1527 Pixel pixel;
1528 String color_name;
1529 XColor color;
1531 if (*nargs != 2)
1533 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1534 "wrongParameters", "cvt_string_to_pixel",
1535 "XtToolkitError",
1536 "Screen and colormap args required", NULL, NULL);
1537 return False;
1540 screen = *(Screen **) args[0].addr;
1541 cmap = *(Colormap *) args[1].addr;
1542 color_name = (String) from->addr;
1544 if (strcmp (color_name, XtDefaultBackground) == 0)
1546 *closure_ret = (XtPointer) False;
1547 pixel = WhitePixelOfScreen (screen);
1549 else if (strcmp (color_name, XtDefaultForeground) == 0)
1551 *closure_ret = (XtPointer) False;
1552 pixel = BlackPixelOfScreen (screen);
1554 else if (XParseColor (dpy, cmap, color_name, &color)
1555 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1557 pixel = color.pixel;
1558 *closure_ret = (XtPointer) True;
1560 else
1562 String params[1];
1563 Cardinal nparams = 1;
1565 params[0] = color_name;
1566 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1567 "badValue", "cvt_string_to_pixel",
1568 "XtToolkitError", "Invalid color `%s'",
1569 params, &nparams);
1570 return False;
1573 if (to->addr != NULL)
1575 if (to->size < sizeof (Pixel))
1577 to->size = sizeof (Pixel);
1578 return False;
1581 *(Pixel *) to->addr = pixel;
1583 else
1585 cvt_string_to_pixel_value = pixel;
1586 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1589 to->size = sizeof (Pixel);
1590 return True;
1594 /* Free a pixel color which was previously allocated via
1595 cvt_string_to_pixel. This is registered as the destructor
1596 for this type of resource via XtSetTypeConverter.
1598 APP is the application context in which we work.
1600 TO is a pointer to an XrmValue holding the color to free.
1601 CLOSURE is the value we stored in CLOSURE_RET for this color
1602 in cvt_string_to_pixel.
1604 ARGS and NARGS are like for cvt_string_to_pixel. */
1606 static void
1607 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1608 Cardinal *nargs)
1610 if (*nargs != 2)
1612 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1613 "XtToolkitError",
1614 "Screen and colormap arguments required",
1615 NULL, NULL);
1617 else if (closure != NULL)
1619 /* We did allocate the pixel, so free it. */
1620 Screen *screen = *(Screen **) args[0].addr;
1621 Colormap cmap = *(Colormap *) args[1].addr;
1622 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1623 (Pixel *) to->addr, 1);
1628 #endif /* USE_X_TOOLKIT */
1631 /* Value is an array of XColor structures for the contents of the
1632 color map of display DPY. Set *NCELLS to the size of the array.
1633 Note that this probably shouldn't be called for large color maps,
1634 say a 24-bit TrueColor map. */
1636 static const XColor *
1637 x_color_cells (Display *dpy, int *ncells)
1639 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1641 if (dpyinfo->color_cells == NULL)
1643 Screen *screen = dpyinfo->screen;
1644 int ncolor_cells = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1645 int i;
1647 dpyinfo->color_cells = xnmalloc (ncolor_cells,
1648 sizeof *dpyinfo->color_cells);
1649 dpyinfo->ncolor_cells = ncolor_cells;
1651 for (i = 0; i < ncolor_cells; ++i)
1652 dpyinfo->color_cells[i].pixel = i;
1654 XQueryColors (dpy, dpyinfo->cmap,
1655 dpyinfo->color_cells, ncolor_cells);
1658 *ncells = dpyinfo->ncolor_cells;
1659 return dpyinfo->color_cells;
1663 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1664 colors in COLORS. Use cached information, if available. */
1666 void
1667 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1669 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1671 if (dpyinfo->color_cells)
1673 int i;
1674 for (i = 0; i < ncolors; ++i)
1676 unsigned long pixel = colors[i].pixel;
1677 eassert (pixel < dpyinfo->ncolor_cells);
1678 eassert (dpyinfo->color_cells[pixel].pixel == pixel);
1679 colors[i] = dpyinfo->color_cells[pixel];
1682 else
1683 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1687 /* On frame F, translate pixel color to RGB values for the color in
1688 COLOR. Use cached information, if available. */
1690 void
1691 x_query_color (struct frame *f, XColor *color)
1693 x_query_colors (f, color, 1);
1697 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1698 exact match can't be allocated, try the nearest color available.
1699 Value is true if successful. Set *COLOR to the color
1700 allocated. */
1702 static bool
1703 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1705 bool rc;
1707 rc = XAllocColor (dpy, cmap, color) != 0;
1708 if (rc == 0)
1710 /* If we got to this point, the colormap is full, so we're going
1711 to try to get the next closest color. The algorithm used is
1712 a least-squares matching, which is what X uses for closest
1713 color matching with StaticColor visuals. */
1714 int nearest, i;
1715 int max_color_delta = 255;
1716 int max_delta = 3 * max_color_delta;
1717 int nearest_delta = max_delta + 1;
1718 int ncells;
1719 const XColor *cells = x_color_cells (dpy, &ncells);
1721 for (nearest = i = 0; i < ncells; ++i)
1723 int dred = (color->red >> 8) - (cells[i].red >> 8);
1724 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
1725 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1726 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
1728 if (delta < nearest_delta)
1730 nearest = i;
1731 nearest_delta = delta;
1735 color->red = cells[nearest].red;
1736 color->green = cells[nearest].green;
1737 color->blue = cells[nearest].blue;
1738 rc = XAllocColor (dpy, cmap, color) != 0;
1740 else
1742 /* If allocation succeeded, and the allocated pixel color is not
1743 equal to a cached pixel color recorded earlier, there was a
1744 change in the colormap, so clear the color cache. */
1745 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1746 XColor *cached_color;
1748 if (dpyinfo->color_cells
1749 && (cached_color = &dpyinfo->color_cells[color->pixel],
1750 (cached_color->red != color->red
1751 || cached_color->blue != color->blue
1752 || cached_color->green != color->green)))
1754 xfree (dpyinfo->color_cells);
1755 dpyinfo->color_cells = NULL;
1756 dpyinfo->ncolor_cells = 0;
1760 #ifdef DEBUG_X_COLORS
1761 if (rc)
1762 register_color (color->pixel);
1763 #endif /* DEBUG_X_COLORS */
1765 return rc;
1769 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1770 exact match can't be allocated, try the nearest color available.
1771 Value is true if successful. Set *COLOR to the color
1772 allocated. */
1774 bool
1775 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1777 gamma_correct (f, color);
1778 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1782 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1783 It's necessary to do this instead of just using PIXEL directly to
1784 get color reference counts right. */
1786 unsigned long
1787 x_copy_color (struct frame *f, long unsigned int pixel)
1789 XColor color;
1791 color.pixel = pixel;
1792 block_input ();
1793 x_query_color (f, &color);
1794 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1795 unblock_input ();
1796 #ifdef DEBUG_X_COLORS
1797 register_color (pixel);
1798 #endif
1799 return color.pixel;
1803 /* Brightness beyond which a color won't have its highlight brightness
1804 boosted.
1806 Nominally, highlight colors for `3d' faces are calculated by
1807 brightening an object's color by a constant scale factor, but this
1808 doesn't yield good results for dark colors, so for colors who's
1809 brightness is less than this value (on a scale of 0-65535) have an
1810 use an additional additive factor.
1812 The value here is set so that the default menu-bar/mode-line color
1813 (grey75) will not have its highlights changed at all. */
1814 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1817 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1818 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1819 If this produces the same color as PIXEL, try a color where all RGB
1820 values have DELTA added. Return the allocated color in *PIXEL.
1821 DISPLAY is the X display, CMAP is the colormap to operate on.
1822 Value is non-zero if successful. */
1824 static bool
1825 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1827 XColor color, new;
1828 long bright;
1829 bool success_p;
1831 /* Get RGB color values. */
1832 color.pixel = *pixel;
1833 x_query_color (f, &color);
1835 /* Change RGB values by specified FACTOR. Avoid overflow! */
1836 eassert (factor >= 0);
1837 new.red = min (0xffff, factor * color.red);
1838 new.green = min (0xffff, factor * color.green);
1839 new.blue = min (0xffff, factor * color.blue);
1841 /* Calculate brightness of COLOR. */
1842 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1844 /* We only boost colors that are darker than
1845 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1846 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1847 /* Make an additive adjustment to NEW, because it's dark enough so
1848 that scaling by FACTOR alone isn't enough. */
1850 /* How far below the limit this color is (0 - 1, 1 being darker). */
1851 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1852 /* The additive adjustment. */
1853 int min_delta = delta * dimness * factor / 2;
1855 if (factor < 1)
1857 new.red = max (0, new.red - min_delta);
1858 new.green = max (0, new.green - min_delta);
1859 new.blue = max (0, new.blue - min_delta);
1861 else
1863 new.red = min (0xffff, min_delta + new.red);
1864 new.green = min (0xffff, min_delta + new.green);
1865 new.blue = min (0xffff, min_delta + new.blue);
1869 /* Try to allocate the color. */
1870 success_p = x_alloc_nearest_color (f, cmap, &new);
1871 if (success_p)
1873 if (new.pixel == *pixel)
1875 /* If we end up with the same color as before, try adding
1876 delta to the RGB values. */
1877 x_free_colors (f, &new.pixel, 1);
1879 new.red = min (0xffff, delta + color.red);
1880 new.green = min (0xffff, delta + color.green);
1881 new.blue = min (0xffff, delta + color.blue);
1882 success_p = x_alloc_nearest_color (f, cmap, &new);
1884 else
1885 success_p = 1;
1886 *pixel = new.pixel;
1889 return success_p;
1893 /* Set up the foreground color for drawing relief lines of glyph
1894 string S. RELIEF is a pointer to a struct relief containing the GC
1895 with which lines will be drawn. Use a color that is FACTOR or
1896 DELTA lighter or darker than the relief's background which is found
1897 in S->f->output_data.x->relief_background. If such a color cannot
1898 be allocated, use DEFAULT_PIXEL, instead. */
1900 static void
1901 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1903 XGCValues xgcv;
1904 struct x_output *di = f->output_data.x;
1905 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1906 unsigned long pixel;
1907 unsigned long background = di->relief_background;
1908 Colormap cmap = FRAME_X_COLORMAP (f);
1909 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1910 Display *dpy = FRAME_X_DISPLAY (f);
1912 xgcv.graphics_exposures = False;
1913 xgcv.line_width = 1;
1915 /* Free previously allocated color. The color cell will be reused
1916 when it has been freed as many times as it was allocated, so this
1917 doesn't affect faces using the same colors. */
1918 if (relief->gc
1919 && relief->allocated_p)
1921 x_free_colors (f, &relief->pixel, 1);
1922 relief->allocated_p = 0;
1925 /* Allocate new color. */
1926 xgcv.foreground = default_pixel;
1927 pixel = background;
1928 if (dpyinfo->n_planes != 1
1929 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1931 relief->allocated_p = 1;
1932 xgcv.foreground = relief->pixel = pixel;
1935 if (relief->gc == 0)
1937 xgcv.stipple = dpyinfo->gray;
1938 mask |= GCStipple;
1939 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1941 else
1942 XChangeGC (dpy, relief->gc, mask, &xgcv);
1946 /* Set up colors for the relief lines around glyph string S. */
1948 static void
1949 x_setup_relief_colors (struct glyph_string *s)
1951 struct x_output *di = s->f->output_data.x;
1952 unsigned long color;
1954 if (s->face->use_box_color_for_shadows_p)
1955 color = s->face->box_color;
1956 else if (s->first_glyph->type == IMAGE_GLYPH
1957 && s->img->pixmap
1958 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1959 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1960 else
1962 XGCValues xgcv;
1964 /* Get the background color of the face. */
1965 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1966 color = xgcv.background;
1969 if (di->white_relief.gc == 0
1970 || color != di->relief_background)
1972 di->relief_background = color;
1973 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1974 WHITE_PIX_DEFAULT (s->f));
1975 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1976 BLACK_PIX_DEFAULT (s->f));
1981 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
1982 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
1983 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
1984 relief. LEFT_P non-zero means draw a relief on the left side of
1985 the rectangle. RIGHT_P non-zero means draw a relief on the right
1986 side of the rectangle. CLIP_RECT is the clipping rectangle to use
1987 when drawing. */
1989 static void
1990 x_draw_relief_rect (struct frame *f,
1991 int left_x, int top_y, int right_x, int bottom_y, int width,
1992 int raised_p, int top_p, int bot_p, int left_p, int right_p,
1993 XRectangle *clip_rect)
1995 Display *dpy = FRAME_X_DISPLAY (f);
1996 Window window = FRAME_X_WINDOW (f);
1997 int i;
1998 GC gc;
2000 if (raised_p)
2001 gc = f->output_data.x->white_relief.gc;
2002 else
2003 gc = f->output_data.x->black_relief.gc;
2004 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2006 /* This code is more complicated than it has to be, because of two
2007 minor hacks to make the boxes look nicer: (i) if width > 1, draw
2008 the outermost line using the black relief. (ii) Omit the four
2009 corner pixels. */
2011 /* Top. */
2012 if (top_p)
2014 if (width == 1)
2015 XDrawLine (dpy, window, gc,
2016 left_x + (left_p ? 1 : 0), top_y,
2017 right_x + (right_p ? 0 : 1), top_y);
2019 for (i = 1; i < width; ++i)
2020 XDrawLine (dpy, window, gc,
2021 left_x + i * left_p, top_y + i,
2022 right_x + 1 - i * right_p, top_y + i);
2025 /* Left. */
2026 if (left_p)
2028 if (width == 1)
2029 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2031 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2032 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2034 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2035 XDrawLine (dpy, window, gc,
2036 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2039 XSetClipMask (dpy, gc, None);
2040 if (raised_p)
2041 gc = f->output_data.x->black_relief.gc;
2042 else
2043 gc = f->output_data.x->white_relief.gc;
2044 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2046 if (width > 1)
2048 /* Outermost top line. */
2049 if (top_p)
2050 XDrawLine (dpy, window, gc,
2051 left_x + (left_p ? 1 : 0), top_y,
2052 right_x + (right_p ? 0 : 1), top_y);
2054 /* Outermost left line. */
2055 if (left_p)
2056 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2059 /* Bottom. */
2060 if (bot_p)
2062 XDrawLine (dpy, window, gc,
2063 left_x + (left_p ? 1 : 0), bottom_y,
2064 right_x + (right_p ? 0 : 1), bottom_y);
2065 for (i = 1; i < width; ++i)
2066 XDrawLine (dpy, window, gc,
2067 left_x + i * left_p, bottom_y - i,
2068 right_x + 1 - i * right_p, bottom_y - i);
2071 /* Right. */
2072 if (right_p)
2074 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2075 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2076 for (i = 0; i < width; ++i)
2077 XDrawLine (dpy, window, gc,
2078 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2081 XSetClipMask (dpy, gc, None);
2085 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2086 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2087 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2088 left side of the rectangle. RIGHT_P non-zero means draw a line
2089 on the right side of the rectangle. CLIP_RECT is the clipping
2090 rectangle to use when drawing. */
2092 static void
2093 x_draw_box_rect (struct glyph_string *s,
2094 int left_x, int top_y, int right_x, int bottom_y, int width,
2095 int left_p, int right_p, XRectangle *clip_rect)
2097 XGCValues xgcv;
2099 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2100 XSetForeground (s->display, s->gc, s->face->box_color);
2101 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2103 /* Top. */
2104 XFillRectangle (s->display, s->window, s->gc,
2105 left_x, top_y, right_x - left_x + 1, width);
2107 /* Left. */
2108 if (left_p)
2109 XFillRectangle (s->display, s->window, s->gc,
2110 left_x, top_y, width, bottom_y - top_y + 1);
2112 /* Bottom. */
2113 XFillRectangle (s->display, s->window, s->gc,
2114 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2116 /* Right. */
2117 if (right_p)
2118 XFillRectangle (s->display, s->window, s->gc,
2119 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2121 XSetForeground (s->display, s->gc, xgcv.foreground);
2122 XSetClipMask (s->display, s->gc, None);
2126 /* Draw a box around glyph string S. */
2128 static void
2129 x_draw_glyph_string_box (struct glyph_string *s)
2131 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2132 int left_p, right_p;
2133 struct glyph *last_glyph;
2134 XRectangle clip_rect;
2136 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2137 ? WINDOW_RIGHT_EDGE_X (s->w)
2138 : window_box_right (s->w, s->area));
2140 /* The glyph that may have a right box line. */
2141 last_glyph = (s->cmp || s->img
2142 ? s->first_glyph
2143 : s->first_glyph + s->nchars - 1);
2145 width = eabs (s->face->box_line_width);
2146 raised_p = s->face->box == FACE_RAISED_BOX;
2147 left_x = s->x;
2148 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2149 ? last_x - 1
2150 : min (last_x, s->x + s->background_width) - 1);
2151 top_y = s->y;
2152 bottom_y = top_y + s->height - 1;
2154 left_p = (s->first_glyph->left_box_line_p
2155 || (s->hl == DRAW_MOUSE_FACE
2156 && (s->prev == NULL
2157 || s->prev->hl != s->hl)));
2158 right_p = (last_glyph->right_box_line_p
2159 || (s->hl == DRAW_MOUSE_FACE
2160 && (s->next == NULL
2161 || s->next->hl != s->hl)));
2163 get_glyph_string_clip_rect (s, &clip_rect);
2165 if (s->face->box == FACE_SIMPLE_BOX)
2166 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2167 left_p, right_p, &clip_rect);
2168 else
2170 x_setup_relief_colors (s);
2171 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2172 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2177 /* Draw foreground of image glyph string S. */
2179 static void
2180 x_draw_image_foreground (struct glyph_string *s)
2182 int x = s->x;
2183 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2185 /* If first glyph of S has a left box line, start drawing it to the
2186 right of that line. */
2187 if (s->face->box != FACE_NO_BOX
2188 && s->first_glyph->left_box_line_p
2189 && s->slice.x == 0)
2190 x += eabs (s->face->box_line_width);
2192 /* If there is a margin around the image, adjust x- and y-position
2193 by that margin. */
2194 if (s->slice.x == 0)
2195 x += s->img->hmargin;
2196 if (s->slice.y == 0)
2197 y += s->img->vmargin;
2199 if (s->img->pixmap)
2201 if (s->img->mask)
2203 /* We can't set both a clip mask and use XSetClipRectangles
2204 because the latter also sets a clip mask. We also can't
2205 trust on the shape extension to be available
2206 (XShapeCombineRegion). So, compute the rectangle to draw
2207 manually. */
2208 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2209 | GCFunction);
2210 XGCValues xgcv;
2211 XRectangle clip_rect, image_rect, r;
2213 xgcv.clip_mask = s->img->mask;
2214 xgcv.clip_x_origin = x;
2215 xgcv.clip_y_origin = y;
2216 xgcv.function = GXcopy;
2217 XChangeGC (s->display, s->gc, mask, &xgcv);
2219 get_glyph_string_clip_rect (s, &clip_rect);
2220 image_rect.x = x;
2221 image_rect.y = y;
2222 image_rect.width = s->slice.width;
2223 image_rect.height = s->slice.height;
2224 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2225 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2226 s->slice.x + r.x - x, s->slice.y + r.y - y,
2227 r.width, r.height, r.x, r.y);
2229 else
2231 XRectangle clip_rect, image_rect, r;
2233 get_glyph_string_clip_rect (s, &clip_rect);
2234 image_rect.x = x;
2235 image_rect.y = y;
2236 image_rect.width = s->slice.width;
2237 image_rect.height = s->slice.height;
2238 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2239 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2240 s->slice.x + r.x - x, s->slice.y + r.y - y,
2241 r.width, r.height, r.x, r.y);
2243 /* When the image has a mask, we can expect that at
2244 least part of a mouse highlight or a block cursor will
2245 be visible. If the image doesn't have a mask, make
2246 a block cursor visible by drawing a rectangle around
2247 the image. I believe it's looking better if we do
2248 nothing here for mouse-face. */
2249 if (s->hl == DRAW_CURSOR)
2251 int relief = s->img->relief;
2252 if (relief < 0) relief = -relief;
2253 XDrawRectangle (s->display, s->window, s->gc,
2254 x - relief, y - relief,
2255 s->slice.width + relief*2 - 1,
2256 s->slice.height + relief*2 - 1);
2260 else
2261 /* Draw a rectangle if image could not be loaded. */
2262 XDrawRectangle (s->display, s->window, s->gc, x, y,
2263 s->slice.width - 1, s->slice.height - 1);
2267 /* Draw a relief around the image glyph string S. */
2269 static void
2270 x_draw_image_relief (struct glyph_string *s)
2272 int x0, y0, x1, y1, thick, raised_p;
2273 int extra_x, extra_y;
2274 XRectangle r;
2275 int x = s->x;
2276 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2278 /* If first glyph of S has a left box line, start drawing it to the
2279 right of that line. */
2280 if (s->face->box != FACE_NO_BOX
2281 && s->first_glyph->left_box_line_p
2282 && s->slice.x == 0)
2283 x += eabs (s->face->box_line_width);
2285 /* If there is a margin around the image, adjust x- and y-position
2286 by that margin. */
2287 if (s->slice.x == 0)
2288 x += s->img->hmargin;
2289 if (s->slice.y == 0)
2290 y += s->img->vmargin;
2292 if (s->hl == DRAW_IMAGE_SUNKEN
2293 || s->hl == DRAW_IMAGE_RAISED)
2295 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2296 raised_p = s->hl == DRAW_IMAGE_RAISED;
2298 else
2300 thick = eabs (s->img->relief);
2301 raised_p = s->img->relief > 0;
2304 extra_x = extra_y = 0;
2305 if (s->face->id == TOOL_BAR_FACE_ID)
2307 if (CONSP (Vtool_bar_button_margin)
2308 && INTEGERP (XCAR (Vtool_bar_button_margin))
2309 && INTEGERP (XCDR (Vtool_bar_button_margin)))
2311 extra_x = XINT (XCAR (Vtool_bar_button_margin));
2312 extra_y = XINT (XCDR (Vtool_bar_button_margin));
2314 else if (INTEGERP (Vtool_bar_button_margin))
2315 extra_x = extra_y = XINT (Vtool_bar_button_margin);
2318 x0 = x - thick - extra_x;
2319 y0 = y - thick - extra_y;
2320 x1 = x + s->slice.width + thick - 1 + extra_x;
2321 y1 = y + s->slice.height + thick - 1 + extra_y;
2323 x_setup_relief_colors (s);
2324 get_glyph_string_clip_rect (s, &r);
2325 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2326 s->slice.y == 0,
2327 s->slice.y + s->slice.height == s->img->height,
2328 s->slice.x == 0,
2329 s->slice.x + s->slice.width == s->img->width,
2330 &r);
2334 /* Draw the foreground of image glyph string S to PIXMAP. */
2336 static void
2337 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2339 int x = 0;
2340 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2342 /* If first glyph of S has a left box line, start drawing it to the
2343 right of that line. */
2344 if (s->face->box != FACE_NO_BOX
2345 && s->first_glyph->left_box_line_p
2346 && s->slice.x == 0)
2347 x += eabs (s->face->box_line_width);
2349 /* If there is a margin around the image, adjust x- and y-position
2350 by that margin. */
2351 if (s->slice.x == 0)
2352 x += s->img->hmargin;
2353 if (s->slice.y == 0)
2354 y += s->img->vmargin;
2356 if (s->img->pixmap)
2358 if (s->img->mask)
2360 /* We can't set both a clip mask and use XSetClipRectangles
2361 because the latter also sets a clip mask. We also can't
2362 trust on the shape extension to be available
2363 (XShapeCombineRegion). So, compute the rectangle to draw
2364 manually. */
2365 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2366 | GCFunction);
2367 XGCValues xgcv;
2369 xgcv.clip_mask = s->img->mask;
2370 xgcv.clip_x_origin = x - s->slice.x;
2371 xgcv.clip_y_origin = y - s->slice.y;
2372 xgcv.function = GXcopy;
2373 XChangeGC (s->display, s->gc, mask, &xgcv);
2375 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2376 s->slice.x, s->slice.y,
2377 s->slice.width, s->slice.height, x, y);
2378 XSetClipMask (s->display, s->gc, None);
2380 else
2382 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2383 s->slice.x, s->slice.y,
2384 s->slice.width, s->slice.height, x, y);
2386 /* When the image has a mask, we can expect that at
2387 least part of a mouse highlight or a block cursor will
2388 be visible. If the image doesn't have a mask, make
2389 a block cursor visible by drawing a rectangle around
2390 the image. I believe it's looking better if we do
2391 nothing here for mouse-face. */
2392 if (s->hl == DRAW_CURSOR)
2394 int r = s->img->relief;
2395 if (r < 0) r = -r;
2396 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2397 s->slice.width + r*2 - 1,
2398 s->slice.height + r*2 - 1);
2402 else
2403 /* Draw a rectangle if image could not be loaded. */
2404 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2405 s->slice.width - 1, s->slice.height - 1);
2409 /* Draw part of the background of glyph string S. X, Y, W, and H
2410 give the rectangle to draw. */
2412 static void
2413 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2415 if (s->stippled_p)
2417 /* Fill background with a stipple pattern. */
2418 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2419 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2420 XSetFillStyle (s->display, s->gc, FillSolid);
2422 else
2423 x_clear_glyph_string_rect (s, x, y, w, h);
2427 /* Draw image glyph string S.
2429 s->y
2430 s->x +-------------------------
2431 | s->face->box
2433 | +-------------------------
2434 | | s->img->margin
2436 | | +-------------------
2437 | | | the image
2441 static void
2442 x_draw_image_glyph_string (struct glyph_string *s)
2444 int box_line_hwidth = eabs (s->face->box_line_width);
2445 int box_line_vwidth = max (s->face->box_line_width, 0);
2446 int height;
2447 Pixmap pixmap = None;
2449 height = s->height;
2450 if (s->slice.y == 0)
2451 height -= box_line_vwidth;
2452 if (s->slice.y + s->slice.height >= s->img->height)
2453 height -= box_line_vwidth;
2455 /* Fill background with face under the image. Do it only if row is
2456 taller than image or if image has a clip mask to reduce
2457 flickering. */
2458 s->stippled_p = s->face->stipple != 0;
2459 if (height > s->slice.height
2460 || s->img->hmargin
2461 || s->img->vmargin
2462 || s->img->mask
2463 || s->img->pixmap == 0
2464 || s->width != s->background_width)
2466 if (s->img->mask)
2468 /* Create a pixmap as large as the glyph string. Fill it
2469 with the background color. Copy the image to it, using
2470 its mask. Copy the temporary pixmap to the display. */
2471 Screen *screen = FRAME_X_SCREEN (s->f);
2472 int depth = DefaultDepthOfScreen (screen);
2474 /* Create a pixmap as large as the glyph string. */
2475 pixmap = XCreatePixmap (s->display, s->window,
2476 s->background_width,
2477 s->height, depth);
2479 /* Don't clip in the following because we're working on the
2480 pixmap. */
2481 XSetClipMask (s->display, s->gc, None);
2483 /* Fill the pixmap with the background color/stipple. */
2484 if (s->stippled_p)
2486 /* Fill background with a stipple pattern. */
2487 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2488 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2489 XFillRectangle (s->display, pixmap, s->gc,
2490 0, 0, s->background_width, s->height);
2491 XSetFillStyle (s->display, s->gc, FillSolid);
2492 XSetTSOrigin (s->display, s->gc, 0, 0);
2494 else
2496 XGCValues xgcv;
2497 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2498 &xgcv);
2499 XSetForeground (s->display, s->gc, xgcv.background);
2500 XFillRectangle (s->display, pixmap, s->gc,
2501 0, 0, s->background_width, s->height);
2502 XSetForeground (s->display, s->gc, xgcv.foreground);
2505 else
2507 int x = s->x;
2508 int y = s->y;
2510 if (s->first_glyph->left_box_line_p
2511 && s->slice.x == 0)
2512 x += box_line_hwidth;
2514 if (s->slice.y == 0)
2515 y += box_line_vwidth;
2517 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2520 s->background_filled_p = 1;
2523 /* Draw the foreground. */
2524 if (pixmap != None)
2526 x_draw_image_foreground_1 (s, pixmap);
2527 x_set_glyph_string_clipping (s);
2528 XCopyArea (s->display, pixmap, s->window, s->gc,
2529 0, 0, s->background_width, s->height, s->x, s->y);
2530 XFreePixmap (s->display, pixmap);
2532 else
2533 x_draw_image_foreground (s);
2535 /* If we must draw a relief around the image, do it. */
2536 if (s->img->relief
2537 || s->hl == DRAW_IMAGE_RAISED
2538 || s->hl == DRAW_IMAGE_SUNKEN)
2539 x_draw_image_relief (s);
2543 /* Draw stretch glyph string S. */
2545 static void
2546 x_draw_stretch_glyph_string (struct glyph_string *s)
2548 eassert (s->first_glyph->type == STRETCH_GLYPH);
2550 if (s->hl == DRAW_CURSOR
2551 && !x_stretch_cursor_p)
2553 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2554 wide as the stretch glyph. */
2555 int width, background_width = s->background_width;
2556 int x = s->x;
2558 if (!s->row->reversed_p)
2560 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2562 if (x < left_x)
2564 background_width -= left_x - x;
2565 x = left_x;
2568 else
2570 /* In R2L rows, draw the cursor on the right edge of the
2571 stretch glyph. */
2572 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2574 if (x + background_width > right_x)
2575 background_width -= x - right_x;
2576 x += background_width;
2578 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2579 if (s->row->reversed_p)
2580 x -= width;
2582 /* Draw cursor. */
2583 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2585 /* Clear rest using the GC of the original non-cursor face. */
2586 if (width < background_width)
2588 int y = s->y;
2589 int w = background_width - width, h = s->height;
2590 XRectangle r;
2591 GC gc;
2593 if (!s->row->reversed_p)
2594 x += width;
2595 else
2596 x = s->x;
2597 if (s->row->mouse_face_p
2598 && cursor_in_mouse_face_p (s->w))
2600 x_set_mouse_face_gc (s);
2601 gc = s->gc;
2603 else
2604 gc = s->face->gc;
2606 get_glyph_string_clip_rect (s, &r);
2607 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2609 if (s->face->stipple)
2611 /* Fill background with a stipple pattern. */
2612 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2613 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2614 XSetFillStyle (s->display, gc, FillSolid);
2616 else
2618 XGCValues xgcv;
2619 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2620 XSetForeground (s->display, gc, xgcv.background);
2621 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2622 XSetForeground (s->display, gc, xgcv.foreground);
2626 else if (!s->background_filled_p)
2628 int background_width = s->background_width;
2629 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2631 /* Don't draw into left margin, fringe or scrollbar area
2632 except for header line and mode line. */
2633 if (x < left_x && !s->row->mode_line_p)
2635 background_width -= left_x - x;
2636 x = left_x;
2638 if (background_width > 0)
2639 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2642 s->background_filled_p = 1;
2646 Draw a wavy line under S. The wave fills wave_height pixels from y0.
2648 x0 wave_length = 2
2650 y0 * * * * *
2651 |* * * * * * * * *
2652 wave_height = 3 | * * * *
2656 static void
2657 x_draw_underwave (struct glyph_string *s)
2659 int wave_height = 3, wave_length = 2;
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 - wave_height + 3;
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
2829 && s->prev->face->underline_type == FACE_UNDER_LINE)
2831 /* We use the same underline style as the previous one. */
2832 thickness = s->prev->underline_thickness;
2833 position = s->prev->underline_position;
2835 else
2837 /* Get the underline thickness. Default is 1 pixel. */
2838 if (s->font && s->font->underline_thickness > 0)
2839 thickness = s->font->underline_thickness;
2840 else
2841 thickness = 1;
2842 if (x_underline_at_descent_line)
2843 position = (s->height - thickness) - (s->ybase - s->y);
2844 else
2846 /* Get the underline position. This is the recommended
2847 vertical offset in pixels from the baseline to the top of
2848 the underline. This is a signed value according to the
2849 specs, and its default is
2851 ROUND ((maximum descent) / 2), with
2852 ROUND(x) = floor (x + 0.5) */
2854 if (x_use_underline_position_properties
2855 && s->font && s->font->underline_position >= 0)
2856 position = s->font->underline_position;
2857 else if (s->font)
2858 position = (s->font->descent + 1) / 2;
2859 else
2860 position = underline_minimum_offset;
2862 position = max (position, underline_minimum_offset);
2864 /* Check the sanity of thickness and position. We should
2865 avoid drawing underline out of the current line area. */
2866 if (s->y + s->height <= s->ybase + position)
2867 position = (s->height - 1) - (s->ybase - s->y);
2868 if (s->y + s->height < s->ybase + position + thickness)
2869 thickness = (s->y + s->height) - (s->ybase + position);
2870 s->underline_thickness = thickness;
2871 s->underline_position = position;
2872 y = s->ybase + position;
2873 if (s->face->underline_defaulted_p)
2874 XFillRectangle (s->display, s->window, s->gc,
2875 s->x, y, s->width, thickness);
2876 else
2878 XGCValues xgcv;
2879 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2880 XSetForeground (s->display, s->gc, s->face->underline_color);
2881 XFillRectangle (s->display, s->window, s->gc,
2882 s->x, y, s->width, thickness);
2883 XSetForeground (s->display, s->gc, xgcv.foreground);
2887 /* Draw overline. */
2888 if (s->face->overline_p)
2890 unsigned long dy = 0, h = 1;
2892 if (s->face->overline_color_defaulted_p)
2893 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2894 s->width, h);
2895 else
2897 XGCValues xgcv;
2898 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2899 XSetForeground (s->display, s->gc, s->face->overline_color);
2900 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2901 s->width, h);
2902 XSetForeground (s->display, s->gc, xgcv.foreground);
2906 /* Draw strike-through. */
2907 if (s->face->strike_through_p)
2909 unsigned long h = 1;
2910 unsigned long dy = (s->height - h) / 2;
2912 if (s->face->strike_through_color_defaulted_p)
2913 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2914 s->width, h);
2915 else
2917 XGCValues xgcv;
2918 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2919 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2920 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2921 s->width, h);
2922 XSetForeground (s->display, s->gc, xgcv.foreground);
2926 /* Draw relief if not yet drawn. */
2927 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2928 x_draw_glyph_string_box (s);
2930 if (s->prev)
2932 struct glyph_string *prev;
2934 for (prev = s->prev; prev; prev = prev->prev)
2935 if (prev->hl != s->hl
2936 && prev->x + prev->width + prev->right_overhang > s->x)
2938 /* As prev was drawn while clipped to its own area, we
2939 must draw the right_overhang part using s->hl now. */
2940 enum draw_glyphs_face save = prev->hl;
2942 prev->hl = s->hl;
2943 x_set_glyph_string_gc (prev);
2944 x_set_glyph_string_clipping_exactly (s, prev);
2945 if (prev->first_glyph->type == CHAR_GLYPH)
2946 x_draw_glyph_string_foreground (prev);
2947 else
2948 x_draw_composite_glyph_string_foreground (prev);
2949 XSetClipMask (prev->display, prev->gc, None);
2950 prev->hl = save;
2951 prev->num_clips = 0;
2955 if (s->next)
2957 struct glyph_string *next;
2959 for (next = s->next; next; next = next->next)
2960 if (next->hl != s->hl
2961 && next->x - next->left_overhang < s->x + s->width)
2963 /* As next will be drawn while clipped to its own area,
2964 we must draw the left_overhang part using s->hl now. */
2965 enum draw_glyphs_face save = next->hl;
2967 next->hl = s->hl;
2968 x_set_glyph_string_gc (next);
2969 x_set_glyph_string_clipping_exactly (s, next);
2970 if (next->first_glyph->type == CHAR_GLYPH)
2971 x_draw_glyph_string_foreground (next);
2972 else
2973 x_draw_composite_glyph_string_foreground (next);
2974 XSetClipMask (next->display, next->gc, None);
2975 next->hl = save;
2976 next->num_clips = 0;
2977 next->clip_head = s->next;
2982 /* Reset clipping. */
2983 XSetClipMask (s->display, s->gc, None);
2984 s->num_clips = 0;
2987 /* Shift display to make room for inserted glyphs. */
2989 static void
2990 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2992 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2993 f->output_data.x->normal_gc,
2994 x, y, width, height,
2995 x + shift_by, y);
2998 /* Delete N glyphs at the nominal cursor position. Not implemented
2999 for X frames. */
3001 static void
3002 x_delete_glyphs (struct frame *f, register int n)
3004 emacs_abort ();
3008 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
3009 If they are <= 0, this is probably an error. */
3011 void
3012 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
3014 eassert (width > 0 && height > 0);
3015 XClearArea (dpy, window, x, y, width, height, exposures);
3019 /* Clear an entire frame. */
3021 static void
3022 x_clear_frame (struct frame *f)
3024 /* Clearing the frame will erase any cursor, so mark them all as no
3025 longer visible. */
3026 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
3027 output_cursor.hpos = output_cursor.vpos = 0;
3028 output_cursor.x = -1;
3030 /* We don't set the output cursor here because there will always
3031 follow an explicit cursor_to. */
3032 block_input ();
3034 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
3036 /* We have to clear the scroll bars. If we have changed colors or
3037 something like that, then they should be notified. */
3038 x_scroll_bar_clear (f);
3040 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3041 /* Make sure scroll bars are redrawn. As they aren't redrawn by
3042 redisplay, do it here. */
3043 if (FRAME_GTK_WIDGET (f))
3044 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
3045 #endif
3047 XFlush (FRAME_X_DISPLAY (f));
3049 unblock_input ();
3054 /* Invert the middle quarter of the frame for .15 sec. */
3056 static void
3057 XTflash (struct frame *f)
3059 block_input ();
3062 #ifdef USE_GTK
3063 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3064 when the scroll bars and the edit widget share the same X window. */
3065 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3066 #ifdef HAVE_GTK3
3067 cairo_t *cr = gdk_cairo_create (window);
3068 cairo_set_source_rgb (cr, 1, 1, 1);
3069 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
3070 #define XFillRectangle(d, win, gc, x, y, w, h) \
3071 do { \
3072 cairo_rectangle (cr, x, y, w, h); \
3073 cairo_fill (cr); \
3075 while (0)
3076 #else /* ! HAVE_GTK3 */
3077 GdkGCValues vals;
3078 GdkGC *gc;
3079 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3080 ^ FRAME_BACKGROUND_PIXEL (f));
3081 vals.function = GDK_XOR;
3082 gc = gdk_gc_new_with_values (window,
3083 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3084 #define XFillRectangle(d, win, gc, x, y, w, h) \
3085 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
3086 #endif /* ! HAVE_GTK3 */
3087 #else /* ! USE_GTK */
3088 GC gc;
3090 /* Create a GC that will use the GXxor function to flip foreground
3091 pixels into background pixels. */
3093 XGCValues values;
3095 values.function = GXxor;
3096 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3097 ^ FRAME_BACKGROUND_PIXEL (f));
3099 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3100 GCFunction | GCForeground, &values);
3102 #endif
3104 /* Get the height not including a menu bar widget. */
3105 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3106 /* Height of each line to flash. */
3107 int flash_height = FRAME_LINE_HEIGHT (f);
3108 /* These will be the left and right margins of the rectangles. */
3109 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3110 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3112 int width;
3114 /* Don't flash the area between a scroll bar and the frame
3115 edge it is next to. */
3116 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3118 case vertical_scroll_bar_left:
3119 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3120 break;
3122 case vertical_scroll_bar_right:
3123 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3124 break;
3126 default:
3127 break;
3130 width = flash_right - flash_left;
3132 /* If window is tall, flash top and bottom line. */
3133 if (height > 3 * FRAME_LINE_HEIGHT (f))
3135 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3136 flash_left,
3137 (FRAME_INTERNAL_BORDER_WIDTH (f)
3138 + FRAME_TOP_MARGIN_HEIGHT (f)),
3139 width, flash_height);
3140 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3141 flash_left,
3142 (height - flash_height
3143 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3144 width, flash_height);
3147 else
3148 /* If it is short, flash it all. */
3149 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3150 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3151 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3153 x_flush (f);
3156 EMACS_TIME delay = make_emacs_time (0, 150 * 1000 * 1000);
3157 EMACS_TIME wakeup = add_emacs_time (current_emacs_time (), delay);
3159 /* Keep waiting until past the time wakeup or any input gets
3160 available. */
3161 while (! detect_input_pending ())
3163 EMACS_TIME current = current_emacs_time ();
3164 EMACS_TIME timeout;
3166 /* Break if result would not be positive. */
3167 if (EMACS_TIME_LE (wakeup, current))
3168 break;
3170 /* How long `select' should wait. */
3171 timeout = make_emacs_time (0, 10 * 1000 * 1000);
3173 /* Try to wait that long--but we might wake up sooner. */
3174 pselect (0, NULL, NULL, NULL, &timeout, NULL);
3178 /* If window is tall, flash top and bottom line. */
3179 if (height > 3 * FRAME_LINE_HEIGHT (f))
3181 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3182 flash_left,
3183 (FRAME_INTERNAL_BORDER_WIDTH (f)
3184 + FRAME_TOP_MARGIN_HEIGHT (f)),
3185 width, flash_height);
3186 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3187 flash_left,
3188 (height - flash_height
3189 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3190 width, flash_height);
3192 else
3193 /* If it is short, flash it all. */
3194 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3195 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3196 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3198 #ifdef USE_GTK
3199 #ifdef HAVE_GTK3
3200 cairo_destroy (cr);
3201 #else
3202 g_object_unref (G_OBJECT (gc));
3203 #endif
3204 #undef XFillRectangle
3205 #else
3206 XFreeGC (FRAME_X_DISPLAY (f), gc);
3207 #endif
3208 x_flush (f);
3212 unblock_input ();
3216 static void
3217 XTtoggle_invisible_pointer (FRAME_PTR f, int invisible)
3219 block_input ();
3220 if (invisible)
3222 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3223 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3224 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3226 else
3227 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3228 f->output_data.x->current_cursor);
3229 f->pointer_invisible = invisible;
3230 unblock_input ();
3234 /* Make audible bell. */
3236 static void
3237 XTring_bell (struct frame *f)
3239 if (FRAME_X_DISPLAY (f))
3241 if (visible_bell)
3242 XTflash (f);
3243 else
3245 block_input ();
3246 XBell (FRAME_X_DISPLAY (f), 0);
3247 XFlush (FRAME_X_DISPLAY (f));
3248 unblock_input ();
3254 /* Specify how many text lines, from the top of the window,
3255 should be affected by insert-lines and delete-lines operations.
3256 This, and those operations, are used only within an update
3257 that is bounded by calls to x_update_begin and x_update_end. */
3259 static void
3260 XTset_terminal_window (struct frame *f, int n)
3262 /* This function intentionally left blank. */
3267 /***********************************************************************
3268 Line Dance
3269 ***********************************************************************/
3271 /* Perform an insert-lines or delete-lines operation, inserting N
3272 lines or deleting -N lines at vertical position VPOS. */
3274 static void
3275 x_ins_del_lines (struct frame *f, int vpos, int n)
3277 emacs_abort ();
3281 /* Scroll part of the display as described by RUN. */
3283 static void
3284 x_scroll_run (struct window *w, struct run *run)
3286 struct frame *f = XFRAME (w->frame);
3287 int x, y, width, height, from_y, to_y, bottom_y;
3289 /* Get frame-relative bounding box of the text display area of W,
3290 without mode lines. Include in this box the left and right
3291 fringe of W. */
3292 window_box (w, -1, &x, &y, &width, &height);
3294 #ifdef USE_TOOLKIT_SCROLL_BARS
3295 /* If the fringe is adjacent to the left (right) scroll bar of a
3296 leftmost (rightmost, respectively) window, then extend its
3297 background to the gap between the fringe and the bar. */
3298 if ((WINDOW_LEFTMOST_P (w)
3299 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
3300 || (WINDOW_RIGHTMOST_P (w)
3301 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
3303 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
3305 if (sb_width > 0)
3307 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
3308 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
3309 * FRAME_COLUMN_WIDTH (f));
3311 if (bar_area_x + bar_area_width == x)
3313 x = bar_area_x + sb_width;
3314 width += bar_area_width - sb_width;
3316 else if (x + width == bar_area_x)
3317 width += bar_area_width - sb_width;
3320 #endif
3322 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3323 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3324 bottom_y = y + height;
3326 if (to_y < from_y)
3328 /* Scrolling up. Make sure we don't copy part of the mode
3329 line at the bottom. */
3330 if (from_y + run->height > bottom_y)
3331 height = bottom_y - from_y;
3332 else
3333 height = run->height;
3335 else
3337 /* Scrolling down. Make sure we don't copy over the mode line.
3338 at the bottom. */
3339 if (to_y + run->height > bottom_y)
3340 height = bottom_y - to_y;
3341 else
3342 height = run->height;
3345 block_input ();
3347 /* Cursor off. Will be switched on again in x_update_window_end. */
3348 updated_window = w;
3349 x_clear_cursor (w);
3351 XCopyArea (FRAME_X_DISPLAY (f),
3352 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3353 f->output_data.x->normal_gc,
3354 x, from_y,
3355 width, height,
3356 x, to_y);
3358 unblock_input ();
3363 /***********************************************************************
3364 Exposure Events
3365 ***********************************************************************/
3368 static void
3369 frame_highlight (struct frame *f)
3371 /* We used to only do this if Vx_no_window_manager was non-nil, but
3372 the ICCCM (section 4.1.6) says that the window's border pixmap
3373 and border pixel are window attributes which are "private to the
3374 client", so we can always change it to whatever we want. */
3375 block_input ();
3376 /* I recently started to get errors in this XSetWindowBorder, depending on
3377 the window-manager in use, tho something more is at play since I've been
3378 using that same window-manager binary for ever. Let's not crash just
3379 because of this (bug#9310). */
3380 x_catch_errors (FRAME_X_DISPLAY (f));
3381 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3382 f->output_data.x->border_pixel);
3383 x_uncatch_errors ();
3384 unblock_input ();
3385 x_update_cursor (f, 1);
3386 x_set_frame_alpha (f);
3389 static void
3390 frame_unhighlight (struct frame *f)
3392 /* We used to only do this if Vx_no_window_manager was non-nil, but
3393 the ICCCM (section 4.1.6) says that the window's border pixmap
3394 and border pixel are window attributes which are "private to the
3395 client", so we can always change it to whatever we want. */
3396 block_input ();
3397 /* Same as above for XSetWindowBorder (bug#9310). */
3398 x_catch_errors (FRAME_X_DISPLAY (f));
3399 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3400 f->output_data.x->border_tile);
3401 x_uncatch_errors ();
3402 unblock_input ();
3403 x_update_cursor (f, 1);
3404 x_set_frame_alpha (f);
3407 /* The focus has changed. Update the frames as necessary to reflect
3408 the new situation. Note that we can't change the selected frame
3409 here, because the Lisp code we are interrupting might become confused.
3410 Each event gets marked with the frame in which it occurred, so the
3411 Lisp code can tell when the switch took place by examining the events. */
3413 static void
3414 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3416 struct frame *old_focus = dpyinfo->x_focus_frame;
3418 if (frame != dpyinfo->x_focus_frame)
3420 /* Set this before calling other routines, so that they see
3421 the correct value of x_focus_frame. */
3422 dpyinfo->x_focus_frame = frame;
3424 if (old_focus && old_focus->auto_lower)
3425 x_lower_frame (old_focus);
3427 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3428 pending_autoraise_frame = dpyinfo->x_focus_frame;
3429 else
3430 pending_autoraise_frame = 0;
3433 x_frame_rehighlight (dpyinfo);
3436 /* Handle FocusIn and FocusOut state changes for FRAME.
3437 If FRAME has focus and there exists more than one frame, puts
3438 a FOCUS_IN_EVENT into *BUFP. */
3440 static void
3441 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3443 if (type == FocusIn)
3445 if (dpyinfo->x_focus_event_frame != frame)
3447 x_new_focus_frame (dpyinfo, frame);
3448 dpyinfo->x_focus_event_frame = frame;
3450 /* Don't stop displaying the initial startup message
3451 for a switch-frame event we don't need. */
3452 /* When run as a daemon, Vterminal_frame is always NIL. */
3453 if ((NILP (Vterminal_frame) || EQ (Fdaemonp(), Qt))
3454 && CONSP (Vframe_list)
3455 && !NILP (XCDR (Vframe_list)))
3457 bufp->kind = FOCUS_IN_EVENT;
3458 XSETFRAME (bufp->frame_or_window, frame);
3462 frame->output_data.x->focus_state |= state;
3464 #ifdef HAVE_X_I18N
3465 if (FRAME_XIC (frame))
3466 XSetICFocus (FRAME_XIC (frame));
3467 #endif
3469 else if (type == FocusOut)
3471 frame->output_data.x->focus_state &= ~state;
3473 if (dpyinfo->x_focus_event_frame == frame)
3475 dpyinfo->x_focus_event_frame = 0;
3476 x_new_focus_frame (dpyinfo, 0);
3479 #ifdef HAVE_X_I18N
3480 if (FRAME_XIC (frame))
3481 XUnsetICFocus (FRAME_XIC (frame));
3482 #endif
3483 if (frame->pointer_invisible)
3484 XTtoggle_invisible_pointer (frame, 0);
3488 /* The focus may have changed. Figure out if it is a real focus change,
3489 by checking both FocusIn/Out and Enter/LeaveNotify events.
3491 Returns FOCUS_IN_EVENT event in *BUFP. */
3493 static void
3494 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3496 struct frame *frame;
3498 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3499 if (! frame)
3500 return;
3502 switch (event->type)
3504 case EnterNotify:
3505 case LeaveNotify:
3507 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3508 int focus_state
3509 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3511 if (event->xcrossing.detail != NotifyInferior
3512 && event->xcrossing.focus
3513 && ! (focus_state & FOCUS_EXPLICIT))
3514 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3515 FOCUS_IMPLICIT,
3516 dpyinfo, frame, bufp);
3518 break;
3520 case FocusIn:
3521 case FocusOut:
3522 x_focus_changed (event->type,
3523 (event->xfocus.detail == NotifyPointer ?
3524 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3525 dpyinfo, frame, bufp);
3526 break;
3528 case ClientMessage:
3529 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3531 enum xembed_message msg = event->xclient.data.l[1];
3532 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3533 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3535 break;
3540 #if defined HAVE_MENUS && !defined USE_X_TOOLKIT && !defined USE_GTK
3541 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3543 void
3544 x_mouse_leave (struct x_display_info *dpyinfo)
3546 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3548 #endif
3550 /* The focus has changed, or we have redirected a frame's focus to
3551 another frame (this happens when a frame uses a surrogate
3552 mini-buffer frame). Shift the highlight as appropriate.
3554 The FRAME argument doesn't necessarily have anything to do with which
3555 frame is being highlighted or un-highlighted; we only use it to find
3556 the appropriate X display info. */
3558 static void
3559 XTframe_rehighlight (struct frame *frame)
3561 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3564 static void
3565 x_frame_rehighlight (struct x_display_info *dpyinfo)
3567 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3569 if (dpyinfo->x_focus_frame)
3571 dpyinfo->x_highlight_frame
3572 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3573 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3574 : dpyinfo->x_focus_frame);
3575 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3577 fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
3578 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3581 else
3582 dpyinfo->x_highlight_frame = 0;
3584 if (dpyinfo->x_highlight_frame != old_highlight)
3586 if (old_highlight)
3587 frame_unhighlight (old_highlight);
3588 if (dpyinfo->x_highlight_frame)
3589 frame_highlight (dpyinfo->x_highlight_frame);
3595 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3597 /* Initialize mode_switch_bit and modifier_meaning. */
3598 static void
3599 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3601 int min_code, max_code;
3602 KeySym *syms;
3603 int syms_per_code;
3604 XModifierKeymap *mods;
3606 dpyinfo->meta_mod_mask = 0;
3607 dpyinfo->shift_lock_mask = 0;
3608 dpyinfo->alt_mod_mask = 0;
3609 dpyinfo->super_mod_mask = 0;
3610 dpyinfo->hyper_mod_mask = 0;
3612 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3614 syms = XGetKeyboardMapping (dpyinfo->display,
3615 min_code, max_code - min_code + 1,
3616 &syms_per_code);
3617 mods = XGetModifierMapping (dpyinfo->display);
3619 /* Scan the modifier table to see which modifier bits the Meta and
3620 Alt keysyms are on. */
3622 int row, col; /* The row and column in the modifier table. */
3623 int found_alt_or_meta;
3625 for (row = 3; row < 8; row++)
3627 found_alt_or_meta = 0;
3628 for (col = 0; col < mods->max_keypermod; col++)
3630 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3632 /* Zeroes are used for filler. Skip them. */
3633 if (code == 0)
3634 continue;
3636 /* Are any of this keycode's keysyms a meta key? */
3638 int code_col;
3640 for (code_col = 0; code_col < syms_per_code; code_col++)
3642 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3644 switch (sym)
3646 case XK_Meta_L:
3647 case XK_Meta_R:
3648 found_alt_or_meta = 1;
3649 dpyinfo->meta_mod_mask |= (1 << row);
3650 break;
3652 case XK_Alt_L:
3653 case XK_Alt_R:
3654 found_alt_or_meta = 1;
3655 dpyinfo->alt_mod_mask |= (1 << row);
3656 break;
3658 case XK_Hyper_L:
3659 case XK_Hyper_R:
3660 if (!found_alt_or_meta)
3661 dpyinfo->hyper_mod_mask |= (1 << row);
3662 code_col = syms_per_code;
3663 col = mods->max_keypermod;
3664 break;
3666 case XK_Super_L:
3667 case XK_Super_R:
3668 if (!found_alt_or_meta)
3669 dpyinfo->super_mod_mask |= (1 << row);
3670 code_col = syms_per_code;
3671 col = mods->max_keypermod;
3672 break;
3674 case XK_Shift_Lock:
3675 /* Ignore this if it's not on the lock modifier. */
3676 if (!found_alt_or_meta && ((1 << row) == LockMask))
3677 dpyinfo->shift_lock_mask = LockMask;
3678 code_col = syms_per_code;
3679 col = mods->max_keypermod;
3680 break;
3688 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3689 if (! dpyinfo->meta_mod_mask)
3691 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3692 dpyinfo->alt_mod_mask = 0;
3695 /* If some keys are both alt and meta,
3696 make them just meta, not alt. */
3697 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3699 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3702 XFree (syms);
3703 XFreeModifiermap (mods);
3706 /* Convert between the modifier bits X uses and the modifier bits
3707 Emacs uses. */
3710 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
3712 int mod_meta = meta_modifier;
3713 int mod_alt = alt_modifier;
3714 int mod_hyper = hyper_modifier;
3715 int mod_super = super_modifier;
3716 Lisp_Object tem;
3718 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3719 if (INTEGERP (tem)) mod_alt = XINT (tem) & INT_MAX;
3720 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3721 if (INTEGERP (tem)) mod_meta = XINT (tem) & INT_MAX;
3722 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3723 if (INTEGERP (tem)) mod_hyper = XINT (tem) & INT_MAX;
3724 tem = Fget (Vx_super_keysym, Qmodifier_value);
3725 if (INTEGERP (tem)) mod_super = XINT (tem) & INT_MAX;
3727 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3728 | ((state & ControlMask) ? ctrl_modifier : 0)
3729 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3730 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3731 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3732 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3735 static int
3736 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
3738 EMACS_INT mod_meta = meta_modifier;
3739 EMACS_INT mod_alt = alt_modifier;
3740 EMACS_INT mod_hyper = hyper_modifier;
3741 EMACS_INT mod_super = super_modifier;
3743 Lisp_Object tem;
3745 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3746 if (INTEGERP (tem)) mod_alt = XINT (tem);
3747 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3748 if (INTEGERP (tem)) mod_meta = XINT (tem);
3749 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3750 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3751 tem = Fget (Vx_super_keysym, Qmodifier_value);
3752 if (INTEGERP (tem)) mod_super = XINT (tem);
3755 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3756 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3757 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3758 | ((state & shift_modifier) ? ShiftMask : 0)
3759 | ((state & ctrl_modifier) ? ControlMask : 0)
3760 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3763 /* Convert a keysym to its name. */
3765 char *
3766 x_get_keysym_name (int keysym)
3768 char *value;
3770 block_input ();
3771 value = XKeysymToString (keysym);
3772 unblock_input ();
3774 return value;
3779 /* Mouse clicks and mouse movement. Rah. */
3781 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3783 If the event is a button press, then note that we have grabbed
3784 the mouse. */
3786 static Lisp_Object
3787 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3789 /* Make the event type NO_EVENT; we'll change that when we decide
3790 otherwise. */
3791 result->kind = MOUSE_CLICK_EVENT;
3792 result->code = event->button - Button1;
3793 result->timestamp = event->time;
3794 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3795 event->state)
3796 | (event->type == ButtonRelease
3797 ? up_modifier
3798 : down_modifier));
3800 XSETINT (result->x, event->x);
3801 XSETINT (result->y, event->y);
3802 XSETFRAME (result->frame_or_window, f);
3803 result->arg = Qnil;
3804 return Qnil;
3808 /* Function to report a mouse movement to the mainstream Emacs code.
3809 The input handler calls this.
3811 We have received a mouse movement event, which is given in *event.
3812 If the mouse is over a different glyph than it was last time, tell
3813 the mainstream emacs code by setting mouse_moved. If not, ask for
3814 another motion event, so we can check again the next time it moves. */
3816 static XMotionEvent last_mouse_motion_event;
3817 static Lisp_Object last_mouse_motion_frame;
3819 static int
3820 note_mouse_movement (FRAME_PTR frame, XMotionEvent *event)
3822 last_mouse_movement_time = event->time;
3823 last_mouse_motion_event = *event;
3824 XSETFRAME (last_mouse_motion_frame, frame);
3826 if (!FRAME_X_OUTPUT (frame))
3827 return 0;
3829 if (event->window != FRAME_X_WINDOW (frame))
3831 frame->mouse_moved = 1;
3832 last_mouse_scroll_bar = Qnil;
3833 note_mouse_highlight (frame, -1, -1);
3834 last_mouse_glyph_frame = 0;
3835 return 1;
3839 /* Has the mouse moved off the glyph it was on at the last sighting? */
3840 if (frame != last_mouse_glyph_frame
3841 || event->x < last_mouse_glyph.x
3842 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3843 || event->y < last_mouse_glyph.y
3844 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3846 frame->mouse_moved = 1;
3847 last_mouse_scroll_bar = Qnil;
3848 note_mouse_highlight (frame, event->x, event->y);
3849 /* Remember which glyph we're now on. */
3850 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3851 last_mouse_glyph_frame = frame;
3852 return 1;
3855 return 0;
3859 /************************************************************************
3860 Mouse Face
3861 ************************************************************************/
3863 static void
3864 redo_mouse_highlight (void)
3866 if (!NILP (last_mouse_motion_frame)
3867 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3868 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3869 last_mouse_motion_event.x,
3870 last_mouse_motion_event.y);
3875 /* Return the current position of the mouse.
3876 *FP should be a frame which indicates which display to ask about.
3878 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3879 and *PART to the frame, window, and scroll bar part that the mouse
3880 is over. Set *X and *Y to the portion and whole of the mouse's
3881 position on the scroll bar.
3883 If the mouse movement started elsewhere, set *FP to the frame the
3884 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3885 the mouse is over.
3887 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
3888 was at this position.
3890 Don't store anything if we don't have a valid set of values to report.
3892 This clears the mouse_moved flag, so we can wait for the next mouse
3893 movement. */
3895 static void
3896 XTmouse_position (FRAME_PTR *fp, int insist, Lisp_Object *bar_window,
3897 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
3898 Time *timestamp)
3900 FRAME_PTR f1;
3902 block_input ();
3904 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3905 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
3906 else
3908 Window root;
3909 int root_x, root_y;
3911 Window dummy_window;
3912 int dummy;
3914 Lisp_Object frame, tail;
3916 /* Clear the mouse-moved flag for every frame on this display. */
3917 FOR_EACH_FRAME (tail, frame)
3918 if (FRAME_X_P (XFRAME (frame))
3919 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3920 XFRAME (frame)->mouse_moved = 0;
3922 last_mouse_scroll_bar = Qnil;
3924 /* Figure out which root window we're on. */
3925 XQueryPointer (FRAME_X_DISPLAY (*fp),
3926 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3928 /* The root window which contains the pointer. */
3929 &root,
3931 /* Trash which we can't trust if the pointer is on
3932 a different screen. */
3933 &dummy_window,
3935 /* The position on that root window. */
3936 &root_x, &root_y,
3938 /* More trash we can't trust. */
3939 &dummy, &dummy,
3941 /* Modifier keys and pointer buttons, about which
3942 we don't care. */
3943 (unsigned int *) &dummy);
3945 /* Now we have a position on the root; find the innermost window
3946 containing the pointer. */
3948 Window win, child;
3949 int win_x, win_y;
3950 int parent_x = 0, parent_y = 0;
3952 win = root;
3954 /* XTranslateCoordinates can get errors if the window
3955 structure is changing at the same time this function
3956 is running. So at least we must not crash from them. */
3958 x_catch_errors (FRAME_X_DISPLAY (*fp));
3960 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3961 && FRAME_LIVE_P (last_mouse_frame))
3963 /* If mouse was grabbed on a frame, give coords for that frame
3964 even if the mouse is now outside it. */
3965 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3967 /* From-window, to-window. */
3968 root, FRAME_X_WINDOW (last_mouse_frame),
3970 /* From-position, to-position. */
3971 root_x, root_y, &win_x, &win_y,
3973 /* Child of win. */
3974 &child);
3975 f1 = last_mouse_frame;
3977 else
3979 while (1)
3981 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3983 /* From-window, to-window. */
3984 root, win,
3986 /* From-position, to-position. */
3987 root_x, root_y, &win_x, &win_y,
3989 /* Child of win. */
3990 &child);
3992 if (child == None || child == win)
3993 break;
3994 #ifdef USE_GTK
3995 /* We don't wan't to know the innermost window. We
3996 want the edit window. For non-Gtk+ the innermost
3997 window is the edit window. For Gtk+ it might not
3998 be. It might be the tool bar for example. */
3999 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
4000 break;
4001 #endif
4002 win = child;
4003 parent_x = win_x;
4004 parent_y = win_y;
4007 /* Now we know that:
4008 win is the innermost window containing the pointer
4009 (XTC says it has no child containing the pointer),
4010 win_x and win_y are the pointer's position in it
4011 (XTC did this the last time through), and
4012 parent_x and parent_y are the pointer's position in win's parent.
4013 (They are what win_x and win_y were when win was child.
4014 If win is the root window, it has no parent, and
4015 parent_{x,y} are invalid, but that's okay, because we'll
4016 never use them in that case.) */
4018 #ifdef USE_GTK
4019 /* We don't wan't to know the innermost window. We
4020 want the edit window. */
4021 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4022 #else
4023 /* Is win one of our frames? */
4024 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4025 #endif
4027 #ifdef USE_X_TOOLKIT
4028 /* If we end up with the menu bar window, say it's not
4029 on the frame. */
4030 if (f1 != NULL
4031 && f1->output_data.x->menubar_widget
4032 && win == XtWindow (f1->output_data.x->menubar_widget))
4033 f1 = NULL;
4034 #endif /* USE_X_TOOLKIT */
4037 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
4038 f1 = 0;
4040 x_uncatch_errors ();
4042 /* If not, is it one of our scroll bars? */
4043 if (! f1)
4045 struct scroll_bar *bar;
4047 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
4049 if (bar)
4051 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4052 win_x = parent_x;
4053 win_y = parent_y;
4057 if (f1 == 0 && insist > 0)
4058 f1 = SELECTED_FRAME ();
4060 if (f1)
4062 /* Ok, we found a frame. Store all the values.
4063 last_mouse_glyph is a rectangle used to reduce the
4064 generation of mouse events. To not miss any motion
4065 events, we must divide the frame into rectangles of the
4066 size of the smallest character that could be displayed
4067 on it, i.e. into the same rectangles that matrices on
4068 the frame are divided into. */
4070 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
4071 last_mouse_glyph_frame = f1;
4073 *bar_window = Qnil;
4074 *part = 0;
4075 *fp = f1;
4076 XSETINT (*x, win_x);
4077 XSETINT (*y, win_y);
4078 *timestamp = last_mouse_movement_time;
4083 unblock_input ();
4088 /***********************************************************************
4089 Scroll bars
4090 ***********************************************************************/
4092 /* Scroll bar support. */
4094 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4095 manages it.
4096 This can be called in GC, so we have to make sure to strip off mark
4097 bits. */
4099 static struct scroll_bar *
4100 x_window_to_scroll_bar (Display *display, Window window_id)
4102 Lisp_Object tail;
4104 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4105 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4106 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4108 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4110 Lisp_Object frame, bar, condemned;
4112 frame = XCAR (tail);
4113 /* All elements of Vframe_list should be frames. */
4114 if (! FRAMEP (frame))
4115 emacs_abort ();
4117 if (! FRAME_X_P (XFRAME (frame)))
4118 continue;
4120 /* Scan this frame's scroll bar list for a scroll bar with the
4121 right window ID. */
4122 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4123 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4124 /* This trick allows us to search both the ordinary and
4125 condemned scroll bar lists with one loop. */
4126 ! NILP (bar) || (bar = condemned,
4127 condemned = Qnil,
4128 ! NILP (bar));
4129 bar = XSCROLL_BAR (bar)->next)
4130 if (XSCROLL_BAR (bar)->x_window == window_id &&
4131 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4132 return XSCROLL_BAR (bar);
4135 return NULL;
4139 #if defined USE_LUCID
4141 /* Return the Lucid menu bar WINDOW is part of. Return null
4142 if WINDOW is not part of a menu bar. */
4144 static Widget
4145 x_window_to_menu_bar (Window window)
4147 Lisp_Object tail;
4149 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4151 if (FRAME_X_P (XFRAME (XCAR (tail))))
4153 Lisp_Object frame = XCAR (tail);
4154 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4156 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4157 return menu_bar;
4161 return NULL;
4164 #endif /* USE_LUCID */
4167 /************************************************************************
4168 Toolkit scroll bars
4169 ************************************************************************/
4171 #ifdef USE_TOOLKIT_SCROLL_BARS
4173 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4174 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4175 static void x_create_toolkit_scroll_bar (struct frame *,
4176 struct scroll_bar *);
4177 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4178 int, int, int);
4181 /* Lisp window being scrolled. Set when starting to interact with
4182 a toolkit scroll bar, reset to nil when ending the interaction. */
4184 static Lisp_Object window_being_scrolled;
4186 /* Last scroll bar part sent in xm_scroll_callback. */
4188 static int last_scroll_bar_part;
4190 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4191 that movements of 1/20 of the screen size are mapped to up/down. */
4193 #ifndef USE_GTK
4194 /* Id of action hook installed for scroll bars. */
4196 static XtActionHookId action_hook_id;
4198 static Boolean xaw3d_arrow_scroll;
4200 /* Whether the drag scrolling maintains the mouse at the top of the
4201 thumb. If not, resizing the thumb needs to be done more carefully
4202 to avoid jerkiness. */
4204 static Boolean xaw3d_pick_top;
4206 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4207 bars are used.. The hook is responsible for detecting when
4208 the user ends an interaction with the scroll bar, and generates
4209 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4211 static void
4212 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4213 XEvent *event, String *params, Cardinal *num_params)
4215 int scroll_bar_p;
4216 const char *end_action;
4218 #ifdef USE_MOTIF
4219 scroll_bar_p = XmIsScrollBar (widget);
4220 end_action = "Release";
4221 #else /* !USE_MOTIF i.e. use Xaw */
4222 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4223 end_action = "EndScroll";
4224 #endif /* USE_MOTIF */
4226 if (scroll_bar_p
4227 && strcmp (action_name, end_action) == 0
4228 && WINDOWP (window_being_scrolled))
4230 struct window *w;
4232 x_send_scroll_bar_event (window_being_scrolled,
4233 scroll_bar_end_scroll, 0, 0);
4234 w = XWINDOW (window_being_scrolled);
4236 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4238 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4239 /* The thumb size is incorrect while dragging: fix it. */
4240 set_vertical_scroll_bar (w);
4242 window_being_scrolled = Qnil;
4243 last_scroll_bar_part = -1;
4245 /* Xt timeouts no longer needed. */
4246 toolkit_scroll_bar_interaction = 0;
4249 #endif /* not USE_GTK */
4251 /* A vector of windows used for communication between
4252 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4254 static struct window **scroll_bar_windows;
4255 static ptrdiff_t scroll_bar_windows_size;
4258 /* Send a client message with message type Xatom_Scrollbar for a
4259 scroll action to the frame of WINDOW. PART is a value identifying
4260 the part of the scroll bar that was clicked on. PORTION is the
4261 amount to scroll of a whole of WHOLE. */
4263 static void
4264 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4266 XEvent event;
4267 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4268 struct window *w = XWINDOW (window);
4269 struct frame *f = XFRAME (w->frame);
4270 ptrdiff_t i;
4272 block_input ();
4274 /* Construct a ClientMessage event to send to the frame. */
4275 ev->type = ClientMessage;
4276 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4277 ev->display = FRAME_X_DISPLAY (f);
4278 ev->window = FRAME_X_WINDOW (f);
4279 ev->format = 32;
4281 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4282 not enough to store a pointer or Lisp_Object on a 64 bit system.
4283 So, store the window in scroll_bar_windows and pass the index
4284 into that array in the event. */
4285 for (i = 0; i < scroll_bar_windows_size; ++i)
4286 if (scroll_bar_windows[i] == NULL)
4287 break;
4289 if (i == scroll_bar_windows_size)
4291 ptrdiff_t old_nbytes =
4292 scroll_bar_windows_size * sizeof *scroll_bar_windows;
4293 ptrdiff_t nbytes;
4294 enum { XClientMessageEvent_MAX = 0x7fffffff };
4295 scroll_bar_windows =
4296 xpalloc (scroll_bar_windows, &scroll_bar_windows_size, 1,
4297 XClientMessageEvent_MAX, sizeof *scroll_bar_windows);
4298 nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4299 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4302 scroll_bar_windows[i] = w;
4303 ev->data.l[0] = (long) i;
4304 ev->data.l[1] = (long) part;
4305 ev->data.l[2] = (long) 0;
4306 ev->data.l[3] = (long) portion;
4307 ev->data.l[4] = (long) whole;
4309 /* Make Xt timeouts work while the scroll bar is active. */
4310 #ifdef USE_X_TOOLKIT
4311 toolkit_scroll_bar_interaction = 1;
4312 x_activate_timeout_atimer ();
4313 #endif
4315 /* Setting the event mask to zero means that the message will
4316 be sent to the client that created the window, and if that
4317 window no longer exists, no event will be sent. */
4318 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4319 unblock_input ();
4323 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4324 in *IEVENT. */
4326 static void
4327 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4329 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4330 Lisp_Object window;
4331 struct window *w;
4333 w = scroll_bar_windows[ev->data.l[0]];
4334 scroll_bar_windows[ev->data.l[0]] = NULL;
4336 XSETWINDOW (window, w);
4338 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4339 ievent->frame_or_window = window;
4340 ievent->arg = Qnil;
4341 #ifdef USE_GTK
4342 ievent->timestamp = CurrentTime;
4343 #else
4344 ievent->timestamp =
4345 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
4346 #endif
4347 ievent->part = ev->data.l[1];
4348 ievent->code = ev->data.l[2];
4349 ievent->x = make_number ((int) ev->data.l[3]);
4350 ievent->y = make_number ((int) ev->data.l[4]);
4351 ievent->modifiers = 0;
4355 #ifdef USE_MOTIF
4357 /* Minimum and maximum values used for Motif scroll bars. */
4359 #define XM_SB_MAX 10000000
4362 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4363 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4364 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4366 static void
4367 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4369 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4370 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4371 int part = -1, whole = 0, portion = 0;
4373 switch (cs->reason)
4375 case XmCR_DECREMENT:
4376 bar->dragging = Qnil;
4377 part = scroll_bar_up_arrow;
4378 break;
4380 case XmCR_INCREMENT:
4381 bar->dragging = Qnil;
4382 part = scroll_bar_down_arrow;
4383 break;
4385 case XmCR_PAGE_DECREMENT:
4386 bar->dragging = Qnil;
4387 part = scroll_bar_above_handle;
4388 break;
4390 case XmCR_PAGE_INCREMENT:
4391 bar->dragging = Qnil;
4392 part = scroll_bar_below_handle;
4393 break;
4395 case XmCR_TO_TOP:
4396 bar->dragging = Qnil;
4397 part = scroll_bar_to_top;
4398 break;
4400 case XmCR_TO_BOTTOM:
4401 bar->dragging = Qnil;
4402 part = scroll_bar_to_bottom;
4403 break;
4405 case XmCR_DRAG:
4407 int slider_size;
4409 /* Get the slider size. */
4410 block_input ();
4411 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4412 unblock_input ();
4414 whole = XM_SB_MAX - slider_size;
4415 portion = min (cs->value, whole);
4416 part = scroll_bar_handle;
4417 bar->dragging = make_number (cs->value);
4419 break;
4421 case XmCR_VALUE_CHANGED:
4422 break;
4425 if (part >= 0)
4427 window_being_scrolled = bar->window;
4428 last_scroll_bar_part = part;
4429 x_send_scroll_bar_event (bar->window, part, portion, whole);
4433 #elif defined USE_GTK
4435 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4436 bar widget. DATA is a pointer to the scroll_bar structure. */
4438 static gboolean
4439 xg_scroll_callback (GtkRange *range,
4440 GtkScrollType scroll,
4441 gdouble value,
4442 gpointer user_data)
4444 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4445 gdouble position;
4446 int part = -1, whole = 0, portion = 0;
4447 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4448 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4450 if (xg_ignore_gtk_scrollbar) return FALSE;
4451 position = gtk_adjustment_get_value (adj);
4454 switch (scroll)
4456 case GTK_SCROLL_JUMP:
4457 /* Buttons 1 2 or 3 must be grabbed. */
4458 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4459 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4461 part = scroll_bar_handle;
4462 whole = gtk_adjustment_get_upper (adj) -
4463 gtk_adjustment_get_page_size (adj);
4464 portion = min ((int)position, whole);
4465 bar->dragging = make_number ((int)portion);
4467 break;
4468 case GTK_SCROLL_STEP_BACKWARD:
4469 part = scroll_bar_up_arrow;
4470 bar->dragging = Qnil;
4471 break;
4472 case GTK_SCROLL_STEP_FORWARD:
4473 part = scroll_bar_down_arrow;
4474 bar->dragging = Qnil;
4475 break;
4476 case GTK_SCROLL_PAGE_BACKWARD:
4477 part = scroll_bar_above_handle;
4478 bar->dragging = Qnil;
4479 break;
4480 case GTK_SCROLL_PAGE_FORWARD:
4481 part = scroll_bar_below_handle;
4482 bar->dragging = Qnil;
4483 break;
4486 if (part >= 0)
4488 window_being_scrolled = bar->window;
4489 last_scroll_bar_part = part;
4490 x_send_scroll_bar_event (bar->window, part, portion, whole);
4493 return FALSE;
4496 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4498 static gboolean
4499 xg_end_scroll_callback (GtkWidget *widget,
4500 GdkEventButton *event,
4501 gpointer user_data)
4503 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4504 bar->dragging = Qnil;
4505 if (WINDOWP (window_being_scrolled))
4507 x_send_scroll_bar_event (window_being_scrolled,
4508 scroll_bar_end_scroll, 0, 0);
4509 window_being_scrolled = Qnil;
4512 return FALSE;
4516 #else /* not USE_GTK and not USE_MOTIF */
4518 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4519 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4520 scroll bar struct. CALL_DATA is a pointer to a float saying where
4521 the thumb is. */
4523 static void
4524 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4526 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4527 float top = *(float *) call_data;
4528 float shown;
4529 int whole, portion, height;
4530 int part;
4532 /* Get the size of the thumb, a value between 0 and 1. */
4533 block_input ();
4534 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4535 unblock_input ();
4537 whole = 10000000;
4538 portion = shown < 1 ? top * whole : 0;
4540 if (shown < 1 && (eabs (top + shown - 1) < 1.0f / height))
4541 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4542 the bottom, so we force the scrolling whenever we see that we're
4543 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4544 we try to ensure that we always stay two pixels away from the
4545 bottom). */
4546 part = scroll_bar_down_arrow;
4547 else
4548 part = scroll_bar_handle;
4550 window_being_scrolled = bar->window;
4551 bar->dragging = make_number (portion);
4552 last_scroll_bar_part = part;
4553 x_send_scroll_bar_event (bar->window, part, portion, whole);
4557 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4558 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4559 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4560 the scroll bar. CALL_DATA is an integer specifying the action that
4561 has taken place. Its magnitude is in the range 0..height of the
4562 scroll bar. Negative values mean scroll towards buffer start.
4563 Values < height of scroll bar mean line-wise movement. */
4565 static void
4566 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4568 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4569 /* The position really is stored cast to a pointer. */
4570 int position = (long) call_data;
4571 Dimension height;
4572 int part;
4574 /* Get the height of the scroll bar. */
4575 block_input ();
4576 XtVaGetValues (widget, XtNheight, &height, NULL);
4577 unblock_input ();
4579 if (eabs (position) >= height)
4580 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4582 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4583 it maps line-movement to call_data = max(5, height/20). */
4584 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4585 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4586 else
4587 part = scroll_bar_move_ratio;
4589 window_being_scrolled = bar->window;
4590 bar->dragging = Qnil;
4591 last_scroll_bar_part = part;
4592 x_send_scroll_bar_event (bar->window, part, position, height);
4595 #endif /* not USE_GTK and not USE_MOTIF */
4597 #define SCROLL_BAR_NAME "verticalScrollBar"
4599 /* Create the widget for scroll bar BAR on frame F. Record the widget
4600 and X window of the scroll bar in BAR. */
4602 #ifdef USE_GTK
4603 static void
4604 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4606 const char *scroll_bar_name = SCROLL_BAR_NAME;
4608 block_input ();
4609 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4610 G_CALLBACK (xg_end_scroll_callback),
4611 scroll_bar_name);
4612 unblock_input ();
4615 #else /* not USE_GTK */
4617 static void
4618 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4620 Window xwindow;
4621 Widget widget;
4622 Arg av[20];
4623 int ac = 0;
4624 const char *scroll_bar_name = SCROLL_BAR_NAME;
4625 unsigned long pixel;
4627 block_input ();
4629 #ifdef USE_MOTIF
4630 /* Set resources. Create the widget. */
4631 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4632 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4633 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4634 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4635 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4636 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4637 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4639 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4640 if (pixel != -1)
4642 XtSetArg (av[ac], XmNforeground, pixel);
4643 ++ac;
4646 pixel = f->output_data.x->scroll_bar_background_pixel;
4647 if (pixel != -1)
4649 XtSetArg (av[ac], XmNbackground, pixel);
4650 ++ac;
4653 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4654 (char *) scroll_bar_name, av, ac);
4656 /* Add one callback for everything that can happen. */
4657 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4658 (XtPointer) bar);
4659 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4660 (XtPointer) bar);
4661 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4662 (XtPointer) bar);
4663 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4664 (XtPointer) bar);
4665 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4666 (XtPointer) bar);
4667 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4668 (XtPointer) bar);
4669 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4670 (XtPointer) bar);
4672 /* Realize the widget. Only after that is the X window created. */
4673 XtRealizeWidget (widget);
4675 /* Set the cursor to an arrow. I didn't find a resource to do that.
4676 And I'm wondering why it hasn't an arrow cursor by default. */
4677 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4678 f->output_data.x->nontext_cursor);
4680 #else /* !USE_MOTIF i.e. use Xaw */
4682 /* Set resources. Create the widget. The background of the
4683 Xaw3d scroll bar widget is a little bit light for my taste.
4684 We don't alter it here to let users change it according
4685 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4686 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4687 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4688 /* For smoother scrolling with Xaw3d -sm */
4689 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4691 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4692 if (pixel != -1)
4694 XtSetArg (av[ac], XtNforeground, pixel);
4695 ++ac;
4698 pixel = f->output_data.x->scroll_bar_background_pixel;
4699 if (pixel != -1)
4701 XtSetArg (av[ac], XtNbackground, pixel);
4702 ++ac;
4705 /* Top/bottom shadow colors. */
4707 /* Allocate them, if necessary. */
4708 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4710 pixel = f->output_data.x->scroll_bar_background_pixel;
4711 if (pixel != -1)
4713 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4714 FRAME_X_COLORMAP (f),
4715 &pixel, 1.2, 0x8000))
4716 pixel = -1;
4717 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4720 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4722 pixel = f->output_data.x->scroll_bar_background_pixel;
4723 if (pixel != -1)
4725 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4726 FRAME_X_COLORMAP (f),
4727 &pixel, 0.6, 0x4000))
4728 pixel = -1;
4729 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4733 #ifdef XtNbeNiceToColormap
4734 /* Tell the toolkit about them. */
4735 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4736 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4737 /* We tried to allocate a color for the top/bottom shadow, and
4738 failed, so tell Xaw3d to use dithering instead. */
4739 /* But only if we have a small colormap. Xaw3d can allocate nice
4740 colors itself. */
4742 XtSetArg (av[ac], XtNbeNiceToColormap,
4743 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4744 ++ac;
4746 else
4747 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4748 be more consistent with other emacs 3d colors, and since Xaw3d is
4749 not good at dealing with allocation failure. */
4751 /* This tells Xaw3d to use real colors instead of dithering for
4752 the shadows. */
4753 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4754 ++ac;
4756 /* Specify the colors. */
4757 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4758 if (pixel != -1)
4760 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4761 ++ac;
4763 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4764 if (pixel != -1)
4766 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4767 ++ac;
4770 #endif
4772 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4773 f->output_data.x->edit_widget, av, ac);
4776 char const *initial = "";
4777 char const *val = initial;
4778 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4779 #ifdef XtNarrowScrollbars
4780 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4781 #endif
4782 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4783 if (xaw3d_arrow_scroll || val == initial)
4784 { /* ARROW_SCROLL */
4785 xaw3d_arrow_scroll = True;
4786 /* Isn't that just a personal preference ? --Stef */
4787 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4791 /* Define callbacks. */
4792 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4793 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4794 (XtPointer) bar);
4796 /* Realize the widget. Only after that is the X window created. */
4797 XtRealizeWidget (widget);
4799 #endif /* !USE_MOTIF */
4801 /* Install an action hook that lets us detect when the user
4802 finishes interacting with a scroll bar. */
4803 if (action_hook_id == 0)
4804 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4806 /* Remember X window and widget in the scroll bar vector. */
4807 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4808 xwindow = XtWindow (widget);
4809 bar->x_window = xwindow;
4811 unblock_input ();
4813 #endif /* not USE_GTK */
4816 /* Set the thumb size and position of scroll bar BAR. We are currently
4817 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4819 #ifdef USE_GTK
4820 static void
4821 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4823 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4826 #else /* not USE_GTK */
4827 static void
4828 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4829 int whole)
4831 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4832 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4833 float top, shown;
4835 block_input ();
4837 #ifdef USE_MOTIF
4839 /* We use an estimate of 30 chars per line rather than the real
4840 `portion' value. This has the disadvantage that the thumb size
4841 is not very representative, but it makes our life a lot easier.
4842 Otherwise, we have to constantly adjust the thumb size, which
4843 we can't always do quickly enough: while dragging, the size of
4844 the thumb might prevent the user from dragging the thumb all the
4845 way to the end. but Motif and some versions of Xaw3d don't allow
4846 updating the thumb size while dragging. Also, even if we can update
4847 its size, the update will often happen too late.
4848 If you don't believe it, check out revision 1.650 of xterm.c to see
4849 what hoops we were going through and the still poor behavior we got. */
4850 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4851 /* When the thumb is at the bottom, position == whole.
4852 So we need to increase `whole' to make space for the thumb. */
4853 whole += portion;
4855 if (whole <= 0)
4856 top = 0, shown = 1;
4857 else
4859 top = (float) position / whole;
4860 shown = (float) portion / whole;
4863 if (NILP (bar->dragging))
4865 int size, value;
4867 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4868 is the scroll bar's maximum and MIN is the scroll bar's minimum
4869 value. */
4870 size = shown * XM_SB_MAX;
4871 size = min (size, XM_SB_MAX);
4872 size = max (size, 1);
4874 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4875 value = top * XM_SB_MAX;
4876 value = min (value, XM_SB_MAX - size);
4878 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4880 #else /* !USE_MOTIF i.e. use Xaw */
4882 if (whole == 0)
4883 top = 0, shown = 1;
4884 else
4886 top = (float) position / whole;
4887 shown = (float) portion / whole;
4891 float old_top, old_shown;
4892 Dimension height;
4893 XtVaGetValues (widget,
4894 XtNtopOfThumb, &old_top,
4895 XtNshown, &old_shown,
4896 XtNheight, &height,
4897 NULL);
4899 /* Massage the top+shown values. */
4900 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4901 top = max (0, min (1, top));
4902 else
4903 top = old_top;
4904 /* Keep two pixels available for moving the thumb down. */
4905 shown = max (0, min (1 - top - (2.0f / height), shown));
4907 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4908 check that your system's configuration file contains a define
4909 for `NARROWPROTO'. See s/freebsd.h for an example. */
4910 if (top != old_top || shown != old_shown)
4912 if (NILP (bar->dragging))
4913 XawScrollbarSetThumb (widget, top, shown);
4914 else
4916 /* Try to make the scrolling a tad smoother. */
4917 if (!xaw3d_pick_top)
4918 shown = min (shown, old_shown);
4920 XawScrollbarSetThumb (widget, top, shown);
4924 #endif /* !USE_MOTIF */
4926 unblock_input ();
4928 #endif /* not USE_GTK */
4930 #endif /* USE_TOOLKIT_SCROLL_BARS */
4934 /************************************************************************
4935 Scroll bars, general
4936 ************************************************************************/
4938 /* Create a scroll bar and return the scroll bar vector for it. W is
4939 the Emacs window on which to create the scroll bar. TOP, LEFT,
4940 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4941 scroll bar. */
4943 static struct scroll_bar *
4944 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4946 struct frame *f = XFRAME (w->frame);
4947 struct scroll_bar *bar
4948 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4949 Lisp_Object barobj;
4951 block_input ();
4953 #ifdef USE_TOOLKIT_SCROLL_BARS
4954 x_create_toolkit_scroll_bar (f, bar);
4955 #else /* not USE_TOOLKIT_SCROLL_BARS */
4957 XSetWindowAttributes a;
4958 unsigned long mask;
4959 Window window;
4961 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4962 if (a.background_pixel == -1)
4963 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4965 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4966 | ButtonMotionMask | PointerMotionHintMask
4967 | ExposureMask);
4968 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4970 mask = (CWBackPixel | CWEventMask | CWCursor);
4972 /* Clear the area of W that will serve as a scroll bar. This is
4973 for the case that a window has been split horizontally. In
4974 this case, no clear_frame is generated to reduce flickering. */
4975 if (width > 0 && height > 0)
4976 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4977 left, top, width,
4978 window_box_height (w), False);
4980 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4981 /* Position and size of scroll bar. */
4982 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4983 top,
4984 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4985 height,
4986 /* Border width, depth, class, and visual. */
4988 CopyFromParent,
4989 CopyFromParent,
4990 CopyFromParent,
4991 /* Attributes. */
4992 mask, &a);
4993 bar->x_window = window;
4995 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4997 XSETWINDOW (bar->window, w);
4998 bar->top = top;
4999 bar->left = left;
5000 bar->width = width;
5001 bar->height = height;
5002 bar->start = 0;
5003 bar->end = 0;
5004 bar->dragging = Qnil;
5005 bar->fringe_extended_p = 0;
5007 /* Add bar to its frame's list of scroll bars. */
5008 bar->next = FRAME_SCROLL_BARS (f);
5009 bar->prev = Qnil;
5010 XSETVECTOR (barobj, bar);
5011 fset_scroll_bars (f, barobj);
5012 if (!NILP (bar->next))
5013 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5015 /* Map the window/widget. */
5016 #ifdef USE_TOOLKIT_SCROLL_BARS
5018 #ifdef USE_GTK
5019 xg_update_scrollbar_pos (f,
5020 bar->x_window,
5021 top,
5022 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5023 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5024 max (height, 1));
5025 #else /* not USE_GTK */
5026 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
5027 XtConfigureWidget (scroll_bar,
5028 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5029 top,
5030 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5031 max (height, 1), 0);
5032 XtMapWidget (scroll_bar);
5033 #endif /* not USE_GTK */
5035 #else /* not USE_TOOLKIT_SCROLL_BARS */
5036 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
5037 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5039 unblock_input ();
5040 return bar;
5044 #ifndef USE_TOOLKIT_SCROLL_BARS
5046 /* Draw BAR's handle in the proper position.
5048 If the handle is already drawn from START to END, don't bother
5049 redrawing it, unless REBUILD is non-zero; in that case, always
5050 redraw it. (REBUILD is handy for drawing the handle after expose
5051 events.)
5053 Normally, we want to constrain the start and end of the handle to
5054 fit inside its rectangle, but if the user is dragging the scroll
5055 bar handle, we want to let them drag it down all the way, so that
5056 the bar's top is as far down as it goes; otherwise, there's no way
5057 to move to the very end of the buffer. */
5059 static void
5060 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
5062 int dragging = ! NILP (bar->dragging);
5063 Window w = bar->x_window;
5064 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5065 GC gc = f->output_data.x->normal_gc;
5067 /* If the display is already accurate, do nothing. */
5068 if (! rebuild
5069 && start == bar->start
5070 && end == bar->end)
5071 return;
5073 block_input ();
5076 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5077 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5078 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5080 /* Make sure the values are reasonable, and try to preserve
5081 the distance between start and end. */
5083 int length = end - start;
5085 if (start < 0)
5086 start = 0;
5087 else if (start > top_range)
5088 start = top_range;
5089 end = start + length;
5091 if (end < start)
5092 end = start;
5093 else if (end > top_range && ! dragging)
5094 end = top_range;
5097 /* Store the adjusted setting in the scroll bar. */
5098 bar->start = start;
5099 bar->end = end;
5101 /* Clip the end position, just for display. */
5102 if (end > top_range)
5103 end = top_range;
5105 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5106 below top positions, to make sure the handle is always at least
5107 that many pixels tall. */
5108 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5110 /* Draw the empty space above the handle. Note that we can't clear
5111 zero-height areas; that means "clear to end of window." */
5112 if (0 < start)
5113 x_clear_area (FRAME_X_DISPLAY (f), w,
5114 /* x, y, width, height, and exposures. */
5115 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5116 VERTICAL_SCROLL_BAR_TOP_BORDER,
5117 inside_width, start,
5118 False);
5120 /* Change to proper foreground color if one is specified. */
5121 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5122 XSetForeground (FRAME_X_DISPLAY (f), gc,
5123 f->output_data.x->scroll_bar_foreground_pixel);
5125 /* Draw the handle itself. */
5126 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5127 /* x, y, width, height */
5128 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5129 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5130 inside_width, end - start);
5132 /* Restore the foreground color of the GC if we changed it above. */
5133 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5134 XSetForeground (FRAME_X_DISPLAY (f), gc,
5135 FRAME_FOREGROUND_PIXEL (f));
5137 /* Draw the empty space below the handle. Note that we can't
5138 clear zero-height areas; that means "clear to end of window." */
5139 if (end < inside_height)
5140 x_clear_area (FRAME_X_DISPLAY (f), w,
5141 /* x, y, width, height, and exposures. */
5142 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5143 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5144 inside_width, inside_height - end,
5145 False);
5149 unblock_input ();
5152 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5154 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5155 nil. */
5157 static void
5158 x_scroll_bar_remove (struct scroll_bar *bar)
5160 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5161 block_input ();
5163 #ifdef USE_TOOLKIT_SCROLL_BARS
5164 #ifdef USE_GTK
5165 xg_remove_scroll_bar (f, bar->x_window);
5166 #else /* not USE_GTK */
5167 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5168 #endif /* not USE_GTK */
5169 #else
5170 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5171 #endif
5173 /* Dissociate this scroll bar from its window. */
5174 wset_vertical_scroll_bar (XWINDOW (bar->window), Qnil);
5176 unblock_input ();
5180 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5181 that we are displaying PORTION characters out of a total of WHOLE
5182 characters, starting at POSITION. If WINDOW has no scroll bar,
5183 create one. */
5185 static void
5186 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5188 struct frame *f = XFRAME (w->frame);
5189 Lisp_Object barobj;
5190 struct scroll_bar *bar;
5191 int top, height, left, sb_left, width, sb_width;
5192 int window_y, window_height;
5193 #ifdef USE_TOOLKIT_SCROLL_BARS
5194 int fringe_extended_p;
5195 #endif
5197 /* Get window dimensions. */
5198 window_box (w, -1, 0, &window_y, 0, &window_height);
5199 top = window_y;
5200 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5201 height = window_height;
5203 /* Compute the left edge of the scroll bar area. */
5204 left = WINDOW_SCROLL_BAR_AREA_X (w);
5206 /* Compute the width of the scroll bar which might be less than
5207 the width of the area reserved for the scroll bar. */
5208 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5209 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5210 else
5211 sb_width = width;
5213 /* Compute the left edge of the scroll bar. */
5214 #ifdef USE_TOOLKIT_SCROLL_BARS
5215 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5216 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5217 else
5218 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5219 #else
5220 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5221 sb_left = left + width - sb_width;
5222 else
5223 sb_left = left;
5224 #endif
5226 #ifdef USE_TOOLKIT_SCROLL_BARS
5227 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5228 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5229 && WINDOW_LEFT_FRINGE_WIDTH (w)
5230 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5231 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5232 else
5233 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5234 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5235 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5236 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5237 #endif
5239 /* Does the scroll bar exist yet? */
5240 if (NILP (w->vertical_scroll_bar))
5242 if (width > 0 && height > 0)
5244 block_input ();
5245 #ifdef USE_TOOLKIT_SCROLL_BARS
5246 if (fringe_extended_p)
5247 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5248 sb_left, top, sb_width, height, False);
5249 else
5250 #endif
5251 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5252 left, top, width, height, False);
5253 unblock_input ();
5256 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5258 else
5260 /* It may just need to be moved and resized. */
5261 unsigned int mask = 0;
5263 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5265 block_input ();
5267 if (sb_left != bar->left)
5268 mask |= CWX;
5269 if (top != bar->top)
5270 mask |= CWY;
5271 if (sb_width != bar->width)
5272 mask |= CWWidth;
5273 if (height != bar->height)
5274 mask |= CWHeight;
5276 #ifdef USE_TOOLKIT_SCROLL_BARS
5278 /* Move/size the scroll bar widget. */
5279 if (mask || bar->fringe_extended_p != fringe_extended_p)
5281 /* Since toolkit scroll bars are smaller than the space reserved
5282 for them on the frame, we have to clear "under" them. */
5283 if (width > 0 && height > 0)
5285 if (fringe_extended_p)
5286 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5287 sb_left, top, sb_width, height, False);
5288 else
5289 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5290 left, top, width, height, False);
5292 #ifdef USE_GTK
5293 xg_update_scrollbar_pos (f,
5294 bar->x_window,
5295 top,
5296 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5297 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5298 max (height, 1));
5299 #else /* not USE_GTK */
5300 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5301 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5302 top,
5303 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5304 max (height, 1), 0);
5305 #endif /* not USE_GTK */
5307 #else /* not USE_TOOLKIT_SCROLL_BARS */
5309 /* Clear areas not covered by the scroll bar because of
5310 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5311 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5313 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5314 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5315 height, False);
5316 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5317 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5318 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5319 height, False);
5322 /* Clear areas not covered by the scroll bar because it's not as
5323 wide as the area reserved for it. This makes sure a
5324 previous mode line display is cleared after C-x 2 C-x 1, for
5325 example. */
5327 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5328 int rest = area_width - sb_width;
5329 if (rest > 0 && height > 0)
5331 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5332 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5333 left + area_width - rest, top,
5334 rest, height, False);
5335 else
5336 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5337 left, top, rest, height, False);
5341 /* Move/size the scroll bar window. */
5342 if (mask)
5344 XWindowChanges wc;
5346 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5347 wc.y = top;
5348 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5349 wc.height = height;
5350 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5351 mask, &wc);
5354 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5356 /* Remember new settings. */
5357 bar->left = sb_left;
5358 bar->top = top;
5359 bar->width = sb_width;
5360 bar->height = height;
5362 unblock_input ();
5365 #ifdef USE_TOOLKIT_SCROLL_BARS
5366 bar->fringe_extended_p = fringe_extended_p;
5368 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5369 #else /* not USE_TOOLKIT_SCROLL_BARS */
5370 /* Set the scroll bar's current state, unless we're currently being
5371 dragged. */
5372 if (NILP (bar->dragging))
5374 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5376 if (whole == 0)
5377 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5378 else
5380 int start = ((double) position * top_range) / whole;
5381 int end = ((double) (position + portion) * top_range) / whole;
5382 x_scroll_bar_set_handle (bar, start, end, 0);
5385 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5387 XSETVECTOR (barobj, bar);
5388 wset_vertical_scroll_bar (w, barobj);
5392 /* The following three hooks are used when we're doing a thorough
5393 redisplay of the frame. We don't explicitly know which scroll bars
5394 are going to be deleted, because keeping track of when windows go
5395 away is a real pain - "Can you say set-window-configuration, boys
5396 and girls?" Instead, we just assert at the beginning of redisplay
5397 that *all* scroll bars are to be removed, and then save a scroll bar
5398 from the fiery pit when we actually redisplay its window. */
5400 /* Arrange for all scroll bars on FRAME to be removed at the next call
5401 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5402 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5404 static void
5405 XTcondemn_scroll_bars (FRAME_PTR frame)
5407 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5408 while (! NILP (FRAME_SCROLL_BARS (frame)))
5410 Lisp_Object bar;
5411 bar = FRAME_SCROLL_BARS (frame);
5412 fset_scroll_bars (frame, XSCROLL_BAR (bar)->next);
5413 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5414 XSCROLL_BAR (bar)->prev = Qnil;
5415 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5416 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5417 fset_condemned_scroll_bars (frame, bar);
5422 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5423 Note that WINDOW isn't necessarily condemned at all. */
5425 static void
5426 XTredeem_scroll_bar (struct window *window)
5428 struct scroll_bar *bar;
5429 struct frame *f;
5430 Lisp_Object barobj;
5432 /* We can't redeem this window's scroll bar if it doesn't have one. */
5433 if (NILP (window->vertical_scroll_bar))
5434 emacs_abort ();
5436 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5438 /* Unlink it from the condemned list. */
5439 f = XFRAME (WINDOW_FRAME (window));
5440 if (NILP (bar->prev))
5442 /* If the prev pointer is nil, it must be the first in one of
5443 the lists. */
5444 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5445 /* It's not condemned. Everything's fine. */
5446 return;
5447 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5448 window->vertical_scroll_bar))
5449 fset_condemned_scroll_bars (f, bar->next);
5450 else
5451 /* If its prev pointer is nil, it must be at the front of
5452 one or the other! */
5453 emacs_abort ();
5455 else
5456 XSCROLL_BAR (bar->prev)->next = bar->next;
5458 if (! NILP (bar->next))
5459 XSCROLL_BAR (bar->next)->prev = bar->prev;
5461 bar->next = FRAME_SCROLL_BARS (f);
5462 bar->prev = Qnil;
5463 XSETVECTOR (barobj, bar);
5464 fset_scroll_bars (f, barobj);
5465 if (! NILP (bar->next))
5466 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5469 /* Remove all scroll bars on FRAME that haven't been saved since the
5470 last call to `*condemn_scroll_bars_hook'. */
5472 static void
5473 XTjudge_scroll_bars (FRAME_PTR f)
5475 Lisp_Object bar, next;
5477 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5479 /* Clear out the condemned list now so we won't try to process any
5480 more events on the hapless scroll bars. */
5481 fset_condemned_scroll_bars (f, Qnil);
5483 for (; ! NILP (bar); bar = next)
5485 struct scroll_bar *b = XSCROLL_BAR (bar);
5487 x_scroll_bar_remove (b);
5489 next = b->next;
5490 b->next = b->prev = Qnil;
5493 /* Now there should be no references to the condemned scroll bars,
5494 and they should get garbage-collected. */
5498 #ifndef USE_TOOLKIT_SCROLL_BARS
5499 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5500 is a no-op when using toolkit scroll bars.
5502 This may be called from a signal handler, so we have to ignore GC
5503 mark bits. */
5505 static void
5506 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5508 Window w = bar->x_window;
5509 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5510 GC gc = f->output_data.x->normal_gc;
5511 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5513 block_input ();
5515 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5517 /* Switch to scroll bar foreground color. */
5518 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5519 XSetForeground (FRAME_X_DISPLAY (f), gc,
5520 f->output_data.x->scroll_bar_foreground_pixel);
5522 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5523 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5525 /* x, y, width, height */
5526 0, 0,
5527 bar->width - 1 - width_trim - width_trim,
5528 bar->height - 1);
5530 /* Restore the foreground color of the GC if we changed it above. */
5531 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5532 XSetForeground (FRAME_X_DISPLAY (f), gc,
5533 FRAME_FOREGROUND_PIXEL (f));
5535 unblock_input ();
5538 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5540 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5541 is set to something other than NO_EVENT, it is enqueued.
5543 This may be called from a signal handler, so we have to ignore GC
5544 mark bits. */
5547 static void
5548 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5550 if (! WINDOWP (bar->window))
5551 emacs_abort ();
5553 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5554 emacs_event->code = event->xbutton.button - Button1;
5555 emacs_event->modifiers
5556 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5557 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5558 event->xbutton.state)
5559 | (event->type == ButtonRelease
5560 ? up_modifier
5561 : down_modifier));
5562 emacs_event->frame_or_window = bar->window;
5563 emacs_event->arg = Qnil;
5564 emacs_event->timestamp = event->xbutton.time;
5566 int top_range
5567 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5568 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5570 if (y < 0) y = 0;
5571 if (y > top_range) y = top_range;
5573 if (y < bar->start)
5574 emacs_event->part = scroll_bar_above_handle;
5575 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5576 emacs_event->part = scroll_bar_handle;
5577 else
5578 emacs_event->part = scroll_bar_below_handle;
5580 #ifndef USE_TOOLKIT_SCROLL_BARS
5581 /* If the user has released the handle, set it to its final position. */
5582 if (event->type == ButtonRelease
5583 && ! NILP (bar->dragging))
5585 int new_start = y - XINT (bar->dragging);
5586 int new_end = new_start + bar->end - bar->start;
5588 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5589 bar->dragging = Qnil;
5591 #endif
5593 XSETINT (emacs_event->x, y);
5594 XSETINT (emacs_event->y, top_range);
5598 #ifndef USE_TOOLKIT_SCROLL_BARS
5600 /* Handle some mouse motion while someone is dragging the scroll bar.
5602 This may be called from a signal handler, so we have to ignore GC
5603 mark bits. */
5605 static void
5606 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5608 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5610 last_mouse_movement_time = event->xmotion.time;
5612 f->mouse_moved = 1;
5613 XSETVECTOR (last_mouse_scroll_bar, bar);
5615 /* If we're dragging the bar, display it. */
5616 if (! NILP (bar->dragging))
5618 /* Where should the handle be now? */
5619 int new_start = event->xmotion.y - XINT (bar->dragging);
5621 if (new_start != bar->start)
5623 int new_end = new_start + bar->end - bar->start;
5625 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5630 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5632 /* Return information to the user about the current position of the mouse
5633 on the scroll bar. */
5635 static void
5636 x_scroll_bar_report_motion (FRAME_PTR *fp, Lisp_Object *bar_window,
5637 enum scroll_bar_part *part, Lisp_Object *x,
5638 Lisp_Object *y, Time *timestamp)
5640 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5641 Window w = bar->x_window;
5642 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5643 int win_x, win_y;
5644 Window dummy_window;
5645 int dummy_coord;
5646 unsigned int dummy_mask;
5648 block_input ();
5650 /* Get the mouse's position relative to the scroll bar window, and
5651 report that. */
5652 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5654 /* Root, child, root x and root y. */
5655 &dummy_window, &dummy_window,
5656 &dummy_coord, &dummy_coord,
5658 /* Position relative to scroll bar. */
5659 &win_x, &win_y,
5661 /* Mouse buttons and modifier keys. */
5662 &dummy_mask))
5664 else
5666 int top_range
5667 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5669 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5671 if (! NILP (bar->dragging))
5672 win_y -= XINT (bar->dragging);
5674 if (win_y < 0)
5675 win_y = 0;
5676 if (win_y > top_range)
5677 win_y = top_range;
5679 *fp = f;
5680 *bar_window = bar->window;
5682 if (! NILP (bar->dragging))
5683 *part = scroll_bar_handle;
5684 else if (win_y < bar->start)
5685 *part = scroll_bar_above_handle;
5686 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5687 *part = scroll_bar_handle;
5688 else
5689 *part = scroll_bar_below_handle;
5691 XSETINT (*x, win_y);
5692 XSETINT (*y, top_range);
5694 f->mouse_moved = 0;
5695 last_mouse_scroll_bar = Qnil;
5698 *timestamp = last_mouse_movement_time;
5700 unblock_input ();
5704 /* The screen has been cleared so we may have changed foreground or
5705 background colors, and the scroll bars may need to be redrawn.
5706 Clear out the scroll bars, and ask for expose events, so we can
5707 redraw them. */
5709 static void
5710 x_scroll_bar_clear (FRAME_PTR f)
5712 #ifndef USE_TOOLKIT_SCROLL_BARS
5713 Lisp_Object bar;
5715 /* We can have scroll bars even if this is 0,
5716 if we just turned off scroll bar mode.
5717 But in that case we should not clear them. */
5718 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5719 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5720 bar = XSCROLL_BAR (bar)->next)
5721 XClearArea (FRAME_X_DISPLAY (f),
5722 XSCROLL_BAR (bar)->x_window,
5723 0, 0, 0, 0, True);
5724 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5728 /* The main X event-reading loop - XTread_socket. */
5730 /* This holds the state XLookupString needs to implement dead keys
5731 and other tricks known as "compose processing". _X Window System_
5732 says that a portable program can't use this, but Stephen Gildea assures
5733 me that letting the compiler initialize it to zeros will work okay.
5735 This must be defined outside of XTread_socket, for the same reasons
5736 given for enter_timestamp, above. */
5738 static XComposeStatus compose_status;
5740 /* Record the last 100 characters stored
5741 to help debug the loss-of-chars-during-GC problem. */
5743 static int temp_index;
5744 static short temp_buffer[100];
5746 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5747 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5748 temp_index = 0; \
5749 temp_buffer[temp_index++] = (keysym)
5751 /* Set this to nonzero to fake an "X I/O error"
5752 on a particular display. */
5754 static struct x_display_info *XTread_socket_fake_io_error;
5756 /* When we find no input here, we occasionally do a no-op command
5757 to verify that the X server is still running and we can still talk with it.
5758 We try all the open displays, one by one.
5759 This variable is used for cycling thru the displays. */
5761 static struct x_display_info *next_noop_dpyinfo;
5763 #if defined USE_X_TOOLKIT || defined USE_GTK
5764 #define SET_SAVED_BUTTON_EVENT \
5765 do \
5767 if (f->output_data.x->saved_menu_event == 0) \
5768 f->output_data.x->saved_menu_event = \
5769 xmalloc (sizeof (XEvent)); \
5770 *f->output_data.x->saved_menu_event = event; \
5771 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5772 XSETFRAME (inev.ie.frame_or_window, f); \
5774 while (0)
5775 #endif
5777 enum
5779 X_EVENT_NORMAL,
5780 X_EVENT_GOTO_OUT,
5781 X_EVENT_DROP
5784 /* Filter events for the current X input method.
5785 DPYINFO is the display this event is for.
5786 EVENT is the X event to filter.
5788 Returns non-zero if the event was filtered, caller shall not process
5789 this event further.
5790 Returns zero if event is wasn't filtered. */
5792 #ifdef HAVE_X_I18N
5793 static int
5794 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5796 /* XFilterEvent returns non-zero if the input method has
5797 consumed the event. We pass the frame's X window to
5798 XFilterEvent because that's the one for which the IC
5799 was created. */
5801 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5802 event->xclient.window);
5804 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5806 #endif
5808 #ifdef USE_GTK
5809 static int current_count;
5810 static int current_finish;
5811 static struct input_event *current_hold_quit;
5813 /* This is the filter function invoked by the GTK event loop.
5814 It is invoked before the XEvent is translated to a GdkEvent,
5815 so we have a chance to act on the event before GTK. */
5816 static GdkFilterReturn
5817 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5819 XEvent *xev = (XEvent *) gxev;
5821 block_input ();
5822 if (current_count >= 0)
5824 struct x_display_info *dpyinfo;
5826 dpyinfo = x_display_info_for_display (xev->xany.display);
5828 #ifdef HAVE_X_I18N
5829 /* Filter events for the current X input method.
5830 GTK calls XFilterEvent but not for key press and release,
5831 so we do it here. */
5832 if ((xev->type == KeyPress || xev->type == KeyRelease)
5833 && dpyinfo
5834 && x_filter_event (dpyinfo, xev))
5836 unblock_input ();
5837 return GDK_FILTER_REMOVE;
5839 #endif
5841 if (! dpyinfo)
5842 current_finish = X_EVENT_NORMAL;
5843 else
5844 current_count +=
5845 handle_one_xevent (dpyinfo, xev, &current_finish,
5846 current_hold_quit);
5848 else
5849 current_finish = x_dispatch_event (xev, xev->xany.display);
5851 unblock_input ();
5853 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5854 return GDK_FILTER_REMOVE;
5856 return GDK_FILTER_CONTINUE;
5858 #endif /* USE_GTK */
5861 static void xembed_send_message (struct frame *f, Time,
5862 enum xembed_message,
5863 long detail, long data1, long data2);
5865 /* Handles the XEvent EVENT on display DPYINFO.
5867 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5868 *FINISH is zero if caller should continue reading events.
5869 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5871 We return the number of characters stored into the buffer. */
5873 static int
5874 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventptr,
5875 int *finish, struct input_event *hold_quit)
5877 union {
5878 struct input_event ie;
5879 struct selection_input_event sie;
5880 } inev;
5881 int count = 0;
5882 int do_help = 0;
5883 ptrdiff_t nbytes = 0;
5884 struct frame *f = NULL;
5885 struct coding_system coding;
5886 XEvent event = *eventptr;
5887 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5888 USE_SAFE_ALLOCA;
5890 *finish = X_EVENT_NORMAL;
5892 EVENT_INIT (inev.ie);
5893 inev.ie.kind = NO_EVENT;
5894 inev.ie.arg = Qnil;
5896 if (pending_event_wait.eventtype == event.type)
5897 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5899 switch (event.type)
5901 case ClientMessage:
5903 if (event.xclient.message_type
5904 == dpyinfo->Xatom_wm_protocols
5905 && event.xclient.format == 32)
5907 if (event.xclient.data.l[0]
5908 == dpyinfo->Xatom_wm_take_focus)
5910 /* Use x_any_window_to_frame because this
5911 could be the shell widget window
5912 if the frame has no title bar. */
5913 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5914 #ifdef HAVE_X_I18N
5915 /* Not quite sure this is needed -pd */
5916 if (f && FRAME_XIC (f))
5917 XSetICFocus (FRAME_XIC (f));
5918 #endif
5919 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5920 instructs the WM to set the input focus automatically for
5921 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5922 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5923 it has set the focus. So, XSetInputFocus below is not
5924 needed.
5926 The call to XSetInputFocus below has also caused trouble. In
5927 cases where the XSetInputFocus done by the WM and the one
5928 below are temporally close (on a fast machine), the call
5929 below can generate additional FocusIn events which confuse
5930 Emacs. */
5932 /* Since we set WM_TAKE_FOCUS, we must call
5933 XSetInputFocus explicitly. But not if f is null,
5934 since that might be an event for a deleted frame. */
5935 if (f)
5937 Display *d = event.xclient.display;
5938 /* Catch and ignore errors, in case window has been
5939 iconified by a window manager such as GWM. */
5940 x_catch_errors (d);
5941 XSetInputFocus (d, event.xclient.window,
5942 /* The ICCCM says this is
5943 the only valid choice. */
5944 RevertToParent,
5945 event.xclient.data.l[1]);
5946 /* This is needed to detect the error
5947 if there is an error. */
5948 XSync (d, False);
5949 x_uncatch_errors ();
5951 /* Not certain about handling scroll bars here */
5952 #endif /* 0 */
5953 goto done;
5956 if (event.xclient.data.l[0]
5957 == dpyinfo->Xatom_wm_save_yourself)
5959 /* Save state modify the WM_COMMAND property to
5960 something which can reinstate us. This notifies
5961 the session manager, who's looking for such a
5962 PropertyNotify. Can restart processing when
5963 a keyboard or mouse event arrives. */
5964 /* If we have a session manager, don't set this.
5965 KDE will then start two Emacsen, one for the
5966 session manager and one for this. */
5967 #ifdef HAVE_X_SM
5968 if (! x_session_have_connection ())
5969 #endif
5971 f = x_top_window_to_frame (dpyinfo,
5972 event.xclient.window);
5973 /* This is just so we only give real data once
5974 for a single Emacs process. */
5975 if (f == SELECTED_FRAME ())
5976 XSetCommand (FRAME_X_DISPLAY (f),
5977 event.xclient.window,
5978 initial_argv, initial_argc);
5979 else if (f)
5980 XSetCommand (FRAME_X_DISPLAY (f),
5981 event.xclient.window,
5982 0, 0);
5984 goto done;
5987 if (event.xclient.data.l[0]
5988 == dpyinfo->Xatom_wm_delete_window)
5990 f = x_any_window_to_frame (dpyinfo,
5991 event.xclient.window);
5992 if (!f)
5993 goto OTHER; /* May be a dialog that is to be removed */
5995 inev.ie.kind = DELETE_WINDOW_EVENT;
5996 XSETFRAME (inev.ie.frame_or_window, f);
5997 goto done;
6000 goto done;
6003 if (event.xclient.message_type
6004 == dpyinfo->Xatom_wm_configure_denied)
6006 goto done;
6009 if (event.xclient.message_type
6010 == dpyinfo->Xatom_wm_window_moved)
6012 int new_x, new_y;
6013 f = x_window_to_frame (dpyinfo, event.xclient.window);
6015 new_x = event.xclient.data.s[0];
6016 new_y = event.xclient.data.s[1];
6018 if (f)
6020 f->left_pos = new_x;
6021 f->top_pos = new_y;
6023 goto done;
6026 #ifdef HACK_EDITRES
6027 if (event.xclient.message_type
6028 == dpyinfo->Xatom_editres)
6030 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6031 if (f)
6032 _XEditResCheckMessages (f->output_data.x->widget, NULL,
6033 &event, NULL);
6034 goto done;
6036 #endif /* HACK_EDITRES */
6038 if ((event.xclient.message_type
6039 == dpyinfo->Xatom_DONE)
6040 || (event.xclient.message_type
6041 == dpyinfo->Xatom_PAGE))
6043 /* Ghostview job completed. Kill it. We could
6044 reply with "Next" if we received "Page", but we
6045 currently never do because we are interested in
6046 images, only, which should have 1 page. */
6047 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6048 f = x_window_to_frame (dpyinfo, event.xclient.window);
6049 if (!f)
6050 goto OTHER;
6051 x_kill_gs_process (pixmap, f);
6052 expose_frame (f, 0, 0, 0, 0);
6053 goto done;
6056 #ifdef USE_TOOLKIT_SCROLL_BARS
6057 /* Scroll bar callbacks send a ClientMessage from which
6058 we construct an input_event. */
6059 if (event.xclient.message_type
6060 == dpyinfo->Xatom_Scrollbar)
6062 x_scroll_bar_to_input_event (&event, &inev.ie);
6063 *finish = X_EVENT_GOTO_OUT;
6064 goto done;
6066 #endif /* USE_TOOLKIT_SCROLL_BARS */
6068 /* XEmbed messages from the embedder (if any). */
6069 if (event.xclient.message_type
6070 == dpyinfo->Xatom_XEMBED)
6072 enum xembed_message msg = event.xclient.data.l[1];
6073 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6074 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6076 *finish = X_EVENT_GOTO_OUT;
6077 goto done;
6080 xft_settings_event (dpyinfo, &event);
6082 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6083 if (!f)
6084 goto OTHER;
6085 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6086 *finish = X_EVENT_DROP;
6088 break;
6090 case SelectionNotify:
6091 last_user_time = event.xselection.time;
6092 #ifdef USE_X_TOOLKIT
6093 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6094 goto OTHER;
6095 #endif /* not USE_X_TOOLKIT */
6096 x_handle_selection_notify (&event.xselection);
6097 break;
6099 case SelectionClear: /* Someone has grabbed ownership. */
6100 last_user_time = event.xselectionclear.time;
6101 #ifdef USE_X_TOOLKIT
6102 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6103 goto OTHER;
6104 #endif /* USE_X_TOOLKIT */
6106 XSelectionClearEvent *eventp = &(event.xselectionclear);
6108 inev.ie.kind = SELECTION_CLEAR_EVENT;
6109 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6110 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6111 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6112 inev.ie.frame_or_window = Qnil;
6114 break;
6116 case SelectionRequest: /* Someone wants our selection. */
6117 last_user_time = event.xselectionrequest.time;
6118 #ifdef USE_X_TOOLKIT
6119 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6120 goto OTHER;
6121 #endif /* USE_X_TOOLKIT */
6123 XSelectionRequestEvent *eventp = &(event.xselectionrequest);
6125 inev.ie.kind = SELECTION_REQUEST_EVENT;
6126 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6127 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6128 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6129 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6130 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6131 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6132 inev.ie.frame_or_window = Qnil;
6134 break;
6136 case PropertyNotify:
6137 last_user_time = event.xproperty.time;
6138 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6139 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6140 if (x_handle_net_wm_state (f, &event.xproperty) && f->iconified
6141 && f->output_data.x->net_wm_state_hidden_seen)
6143 /* Gnome shell does not iconify us when C-z is pressed. It hides
6144 the frame. So if our state says we aren't hidden anymore,
6145 treat it as deiconified. */
6146 if (! f->async_iconified)
6147 SET_FRAME_GARBAGED (f);
6148 f->async_visible = 1;
6149 f->async_iconified = 0;
6150 f->output_data.x->has_been_visible = 1;
6151 f->output_data.x->net_wm_state_hidden_seen = 0;
6152 inev.ie.kind = DEICONIFY_EVENT;
6153 XSETFRAME (inev.ie.frame_or_window, f);
6156 x_handle_property_notify (&event.xproperty);
6157 xft_settings_event (dpyinfo, &event);
6158 goto OTHER;
6160 case ReparentNotify:
6161 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6162 if (f)
6164 int x, y;
6165 f->output_data.x->parent_desc = event.xreparent.parent;
6166 x_real_positions (f, &x, &y);
6167 f->left_pos = x;
6168 f->top_pos = y;
6170 /* Perhaps reparented due to a WM restart. Reset this. */
6171 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6172 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6174 x_set_frame_alpha (f);
6176 goto OTHER;
6178 case Expose:
6179 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6180 if (f)
6182 #ifdef USE_GTK
6183 /* This seems to be needed for GTK 2.6. */
6184 x_clear_area (event.xexpose.display,
6185 event.xexpose.window,
6186 event.xexpose.x, event.xexpose.y,
6187 event.xexpose.width, event.xexpose.height,
6188 FALSE);
6189 #endif
6190 if (f->async_visible == 0)
6192 f->async_visible = 1;
6193 f->async_iconified = 0;
6194 f->output_data.x->has_been_visible = 1;
6195 SET_FRAME_GARBAGED (f);
6197 else
6198 expose_frame (f,
6199 event.xexpose.x, event.xexpose.y,
6200 event.xexpose.width, event.xexpose.height);
6202 else
6204 #ifndef USE_TOOLKIT_SCROLL_BARS
6205 struct scroll_bar *bar;
6206 #endif
6207 #if defined USE_LUCID
6208 /* Submenus of the Lucid menu bar aren't widgets
6209 themselves, so there's no way to dispatch events
6210 to them. Recognize this case separately. */
6212 Widget widget
6213 = x_window_to_menu_bar (event.xexpose.window);
6214 if (widget)
6215 xlwmenu_redisplay (widget);
6217 #endif /* USE_LUCID */
6219 #ifdef USE_TOOLKIT_SCROLL_BARS
6220 /* Dispatch event to the widget. */
6221 goto OTHER;
6222 #else /* not USE_TOOLKIT_SCROLL_BARS */
6223 bar = x_window_to_scroll_bar (event.xexpose.display,
6224 event.xexpose.window);
6226 if (bar)
6227 x_scroll_bar_expose (bar, &event);
6228 #ifdef USE_X_TOOLKIT
6229 else
6230 goto OTHER;
6231 #endif /* USE_X_TOOLKIT */
6232 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6234 break;
6236 case GraphicsExpose: /* This occurs when an XCopyArea's
6237 source area was obscured or not
6238 available. */
6239 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6240 if (f)
6242 expose_frame (f,
6243 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6244 event.xgraphicsexpose.width,
6245 event.xgraphicsexpose.height);
6247 #ifdef USE_X_TOOLKIT
6248 else
6249 goto OTHER;
6250 #endif /* USE_X_TOOLKIT */
6251 break;
6253 case NoExpose: /* This occurs when an XCopyArea's
6254 source area was completely
6255 available. */
6256 break;
6258 case UnmapNotify:
6259 /* Redo the mouse-highlight after the tooltip has gone. */
6260 if (event.xmap.window == tip_window)
6262 tip_window = 0;
6263 redo_mouse_highlight ();
6266 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6267 if (f) /* F may no longer exist if
6268 the frame was deleted. */
6270 /* While a frame is unmapped, display generation is
6271 disabled; you don't want to spend time updating a
6272 display that won't ever be seen. */
6273 f->async_visible = 0;
6274 /* We can't distinguish, from the event, whether the window
6275 has become iconified or invisible. So assume, if it
6276 was previously visible, than now it is iconified.
6277 But x_make_frame_invisible clears both
6278 the visible flag and the iconified flag;
6279 and that way, we know the window is not iconified now. */
6280 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6282 f->async_iconified = 1;
6284 inev.ie.kind = ICONIFY_EVENT;
6285 XSETFRAME (inev.ie.frame_or_window, f);
6288 goto OTHER;
6290 case MapNotify:
6291 if (event.xmap.window == tip_window)
6292 /* The tooltip has been drawn already. Avoid
6293 the SET_FRAME_GARBAGED below. */
6294 goto OTHER;
6296 /* We use x_top_window_to_frame because map events can
6297 come for sub-windows and they don't mean that the
6298 frame is visible. */
6299 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6300 if (f)
6302 /* wait_reading_process_output will notice this and update
6303 the frame's display structures.
6304 If we where iconified, we should not set garbaged,
6305 because that stops redrawing on Expose events. This looks
6306 bad if we are called from a recursive event loop
6307 (x_dispatch_event), for example when a dialog is up. */
6308 if (! f->async_iconified)
6309 SET_FRAME_GARBAGED (f);
6311 /* Check if fullscreen was specified before we where mapped the
6312 first time, i.e. from the command line. */
6313 if (!f->output_data.x->has_been_visible)
6314 x_check_fullscreen (f);
6316 f->async_visible = 1;
6317 f->async_iconified = 0;
6318 f->output_data.x->has_been_visible = 1;
6320 if (f->iconified)
6322 inev.ie.kind = DEICONIFY_EVENT;
6323 XSETFRAME (inev.ie.frame_or_window, f);
6325 else if (! NILP (Vframe_list)
6326 && ! NILP (XCDR (Vframe_list)))
6327 /* Force a redisplay sooner or later
6328 to update the frame titles
6329 in case this is the second frame. */
6330 record_asynch_buffer_change ();
6332 #ifdef USE_GTK
6333 xg_frame_resized (f, -1, -1);
6334 #endif
6336 goto OTHER;
6338 case KeyPress:
6340 last_user_time = event.xkey.time;
6341 ignore_next_mouse_click_timeout = 0;
6343 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6344 /* Dispatch KeyPress events when in menu. */
6345 if (popup_activated ())
6346 goto OTHER;
6347 #endif
6349 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6351 /* If mouse-highlight is an integer, input clears out
6352 mouse highlighting. */
6353 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6354 && (f == 0
6355 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6357 clear_mouse_face (hlinfo);
6358 hlinfo->mouse_face_hidden = 1;
6361 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6362 if (f == 0)
6364 /* Scroll bars consume key events, but we want
6365 the keys to go to the scroll bar's frame. */
6366 Widget widget = XtWindowToWidget (dpyinfo->display,
6367 event.xkey.window);
6368 if (widget && XmIsScrollBar (widget))
6370 widget = XtParent (widget);
6371 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6374 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6376 if (f != 0)
6378 KeySym keysym, orig_keysym;
6379 /* al%imercury@uunet.uu.net says that making this 81
6380 instead of 80 fixed a bug whereby meta chars made
6381 his Emacs hang.
6383 It seems that some version of XmbLookupString has
6384 a bug of not returning XBufferOverflow in
6385 status_return even if the input is too long to
6386 fit in 81 bytes. So, we must prepare sufficient
6387 bytes for copy_buffer. 513 bytes (256 chars for
6388 two-byte character set) seems to be a fairly good
6389 approximation. -- 2000.8.10 handa@etl.go.jp */
6390 unsigned char copy_buffer[513];
6391 unsigned char *copy_bufptr = copy_buffer;
6392 int copy_bufsiz = sizeof (copy_buffer);
6393 int modifiers;
6394 Lisp_Object coding_system = Qlatin_1;
6395 Lisp_Object c;
6397 #ifdef USE_GTK
6398 /* Don't pass keys to GTK. A Tab will shift focus to the
6399 tool bar in GTK 2.4. Keys will still go to menus and
6400 dialogs because in that case popup_activated is TRUE
6401 (see above). */
6402 *finish = X_EVENT_DROP;
6403 #endif
6405 event.xkey.state
6406 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6407 extra_keyboard_modifiers);
6408 modifiers = event.xkey.state;
6410 /* This will have to go some day... */
6412 /* make_lispy_event turns chars into control chars.
6413 Don't do it here because XLookupString is too eager. */
6414 event.xkey.state &= ~ControlMask;
6415 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6416 | dpyinfo->super_mod_mask
6417 | dpyinfo->hyper_mod_mask
6418 | dpyinfo->alt_mod_mask);
6420 /* In case Meta is ComposeCharacter,
6421 clear its status. According to Markus Ehrnsperger
6422 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6423 this enables ComposeCharacter to work whether or
6424 not it is combined with Meta. */
6425 if (modifiers & dpyinfo->meta_mod_mask)
6426 memset (&compose_status, 0, sizeof (compose_status));
6428 #ifdef HAVE_X_I18N
6429 if (FRAME_XIC (f))
6431 Status status_return;
6433 coding_system = Vlocale_coding_system;
6434 nbytes = XmbLookupString (FRAME_XIC (f),
6435 &event.xkey, (char *) copy_bufptr,
6436 copy_bufsiz, &keysym,
6437 &status_return);
6438 if (status_return == XBufferOverflow)
6440 copy_bufsiz = nbytes + 1;
6441 copy_bufptr = alloca (copy_bufsiz);
6442 nbytes = XmbLookupString (FRAME_XIC (f),
6443 &event.xkey, (char *) copy_bufptr,
6444 copy_bufsiz, &keysym,
6445 &status_return);
6447 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6448 if (status_return == XLookupNone)
6449 break;
6450 else if (status_return == XLookupChars)
6452 keysym = NoSymbol;
6453 modifiers = 0;
6455 else if (status_return != XLookupKeySym
6456 && status_return != XLookupBoth)
6457 emacs_abort ();
6459 else
6460 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6461 copy_bufsiz, &keysym,
6462 &compose_status);
6463 #else
6464 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6465 copy_bufsiz, &keysym,
6466 &compose_status);
6467 #endif
6469 /* If not using XIM/XIC, and a compose sequence is in progress,
6470 we break here. Otherwise, chars_matched is always 0. */
6471 if (compose_status.chars_matched > 0 && nbytes == 0)
6472 break;
6474 memset (&compose_status, 0, sizeof (compose_status));
6475 orig_keysym = keysym;
6477 /* Common for all keysym input events. */
6478 XSETFRAME (inev.ie.frame_or_window, f);
6479 inev.ie.modifiers
6480 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6481 inev.ie.timestamp = event.xkey.time;
6483 /* First deal with keysyms which have defined
6484 translations to characters. */
6485 if (keysym >= 32 && keysym < 128)
6486 /* Avoid explicitly decoding each ASCII character. */
6488 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6489 inev.ie.code = keysym;
6490 goto done_keysym;
6493 /* Keysyms directly mapped to Unicode characters. */
6494 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6496 if (keysym < 0x01000080)
6497 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6498 else
6499 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6500 inev.ie.code = keysym & 0xFFFFFF;
6501 goto done_keysym;
6504 /* Now non-ASCII. */
6505 if (HASH_TABLE_P (Vx_keysym_table)
6506 && (c = Fgethash (make_number (keysym),
6507 Vx_keysym_table,
6508 Qnil),
6509 NATNUMP (c)))
6511 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6512 ? ASCII_KEYSTROKE_EVENT
6513 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6514 inev.ie.code = XFASTINT (c);
6515 goto done_keysym;
6518 /* Random non-modifier sorts of keysyms. */
6519 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6520 || keysym == XK_Delete
6521 #ifdef XK_ISO_Left_Tab
6522 || (keysym >= XK_ISO_Left_Tab
6523 && keysym <= XK_ISO_Enter)
6524 #endif
6525 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6526 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6527 #ifdef HPUX
6528 /* This recognizes the "extended function
6529 keys". It seems there's no cleaner way.
6530 Test IsModifierKey to avoid handling
6531 mode_switch incorrectly. */
6532 || (XK_Select <= keysym && keysym < XK_KP_Space)
6533 #endif
6534 #ifdef XK_dead_circumflex
6535 || orig_keysym == XK_dead_circumflex
6536 #endif
6537 #ifdef XK_dead_grave
6538 || orig_keysym == XK_dead_grave
6539 #endif
6540 #ifdef XK_dead_tilde
6541 || orig_keysym == XK_dead_tilde
6542 #endif
6543 #ifdef XK_dead_diaeresis
6544 || orig_keysym == XK_dead_diaeresis
6545 #endif
6546 #ifdef XK_dead_macron
6547 || orig_keysym == XK_dead_macron
6548 #endif
6549 #ifdef XK_dead_degree
6550 || orig_keysym == XK_dead_degree
6551 #endif
6552 #ifdef XK_dead_acute
6553 || orig_keysym == XK_dead_acute
6554 #endif
6555 #ifdef XK_dead_cedilla
6556 || orig_keysym == XK_dead_cedilla
6557 #endif
6558 #ifdef XK_dead_breve
6559 || orig_keysym == XK_dead_breve
6560 #endif
6561 #ifdef XK_dead_ogonek
6562 || orig_keysym == XK_dead_ogonek
6563 #endif
6564 #ifdef XK_dead_caron
6565 || orig_keysym == XK_dead_caron
6566 #endif
6567 #ifdef XK_dead_doubleacute
6568 || orig_keysym == XK_dead_doubleacute
6569 #endif
6570 #ifdef XK_dead_abovedot
6571 || orig_keysym == XK_dead_abovedot
6572 #endif
6573 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6574 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6575 /* Any "vendor-specific" key is ok. */
6576 || (orig_keysym & (1 << 28))
6577 || (keysym != NoSymbol && nbytes == 0))
6578 && ! (IsModifierKey (orig_keysym)
6579 /* The symbols from XK_ISO_Lock
6580 to XK_ISO_Last_Group_Lock
6581 don't have real modifiers but
6582 should be treated similarly to
6583 Mode_switch by Emacs. */
6584 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6585 || (XK_ISO_Lock <= orig_keysym
6586 && orig_keysym <= XK_ISO_Last_Group_Lock)
6587 #endif
6590 STORE_KEYSYM_FOR_DEBUG (keysym);
6591 /* make_lispy_event will convert this to a symbolic
6592 key. */
6593 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6594 inev.ie.code = keysym;
6595 goto done_keysym;
6598 { /* Raw bytes, not keysym. */
6599 ptrdiff_t i;
6600 int nchars, len;
6602 for (i = 0, nchars = 0; i < nbytes; i++)
6604 if (ASCII_BYTE_P (copy_bufptr[i]))
6605 nchars++;
6606 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6609 if (nchars < nbytes)
6611 /* Decode the input data. */
6613 /* The input should be decoded with `coding_system'
6614 which depends on which X*LookupString function
6615 we used just above and the locale. */
6616 setup_coding_system (coding_system, &coding);
6617 coding.src_multibyte = 0;
6618 coding.dst_multibyte = 1;
6619 /* The input is converted to events, thus we can't
6620 handle composition. Anyway, there's no XIM that
6621 gives us composition information. */
6622 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6624 SAFE_NALLOCA (coding.destination, MAX_MULTIBYTE_LENGTH,
6625 nbytes);
6626 coding.dst_bytes = MAX_MULTIBYTE_LENGTH * nbytes;
6627 coding.mode |= CODING_MODE_LAST_BLOCK;
6628 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6629 nbytes = coding.produced;
6630 nchars = coding.produced_char;
6631 copy_bufptr = coding.destination;
6634 /* Convert the input data to a sequence of
6635 character events. */
6636 for (i = 0; i < nbytes; i += len)
6638 int ch;
6639 if (nchars == nbytes)
6640 ch = copy_bufptr[i], len = 1;
6641 else
6642 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6643 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
6644 ? ASCII_KEYSTROKE_EVENT
6645 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6646 inev.ie.code = ch;
6647 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6650 count += nchars;
6652 inev.ie.kind = NO_EVENT; /* Already stored above. */
6654 if (keysym == NoSymbol)
6655 break;
6658 done_keysym:
6659 #ifdef HAVE_X_I18N
6660 /* Don't dispatch this event since XtDispatchEvent calls
6661 XFilterEvent, and two calls in a row may freeze the
6662 client. */
6663 break;
6664 #else
6665 goto OTHER;
6666 #endif
6668 case KeyRelease:
6669 last_user_time = event.xkey.time;
6670 #ifdef HAVE_X_I18N
6671 /* Don't dispatch this event since XtDispatchEvent calls
6672 XFilterEvent, and two calls in a row may freeze the
6673 client. */
6674 break;
6675 #else
6676 goto OTHER;
6677 #endif
6679 case EnterNotify:
6680 last_user_time = event.xcrossing.time;
6681 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6683 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6685 if (f && x_mouse_click_focus_ignore_position)
6686 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6688 /* EnterNotify counts as mouse movement,
6689 so update things that depend on mouse position. */
6690 if (f && !f->output_data.x->hourglass_p)
6691 note_mouse_movement (f, &event.xmotion);
6692 #ifdef USE_GTK
6693 /* We may get an EnterNotify on the buttons in the toolbar. In that
6694 case we moved out of any highlighted area and need to note this. */
6695 if (!f && last_mouse_glyph_frame)
6696 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6697 #endif
6698 goto OTHER;
6700 case FocusIn:
6701 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6702 goto OTHER;
6704 case LeaveNotify:
6705 last_user_time = event.xcrossing.time;
6706 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6708 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6709 if (f)
6711 if (f == hlinfo->mouse_face_mouse_frame)
6713 /* If we move outside the frame, then we're
6714 certainly no longer on any text in the frame. */
6715 clear_mouse_face (hlinfo);
6716 hlinfo->mouse_face_mouse_frame = 0;
6719 /* Generate a nil HELP_EVENT to cancel a help-echo.
6720 Do it only if there's something to cancel.
6721 Otherwise, the startup message is cleared when
6722 the mouse leaves the frame. */
6723 if (any_help_event_p)
6724 do_help = -1;
6726 #ifdef USE_GTK
6727 /* See comment in EnterNotify above */
6728 else if (last_mouse_glyph_frame)
6729 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6730 #endif
6731 goto OTHER;
6733 case FocusOut:
6734 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6735 goto OTHER;
6737 case MotionNotify:
6739 last_user_time = event.xmotion.time;
6740 previous_help_echo_string = help_echo_string;
6741 help_echo_string = Qnil;
6743 if (dpyinfo->grabbed && last_mouse_frame
6744 && FRAME_LIVE_P (last_mouse_frame))
6745 f = last_mouse_frame;
6746 else
6747 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6749 if (hlinfo->mouse_face_hidden)
6751 hlinfo->mouse_face_hidden = 0;
6752 clear_mouse_face (hlinfo);
6755 #ifdef USE_GTK
6756 if (f && xg_event_is_for_scrollbar (f, &event))
6757 f = 0;
6758 #endif
6759 if (f)
6762 /* Generate SELECT_WINDOW_EVENTs when needed.
6763 Don't let popup menus influence things (bug#1261). */
6764 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6766 Lisp_Object window;
6768 window = window_from_coordinates (f,
6769 event.xmotion.x, event.xmotion.y,
6770 0, 0);
6772 /* Window will be selected only when it is not selected now and
6773 last mouse movement event was not in it. Minibuffer window
6774 will be selected only when it is active. */
6775 if (WINDOWP (window)
6776 && !EQ (window, last_window)
6777 && !EQ (window, selected_window)
6778 /* For click-to-focus window managers
6779 create event iff we don't leave the
6780 selected frame. */
6781 && (focus_follows_mouse
6782 || (EQ (XWINDOW (window)->frame,
6783 XWINDOW (selected_window)->frame))))
6785 inev.ie.kind = SELECT_WINDOW_EVENT;
6786 inev.ie.frame_or_window = window;
6789 last_window=window;
6791 if (!note_mouse_movement (f, &event.xmotion))
6792 help_echo_string = previous_help_echo_string;
6794 else
6796 #ifndef USE_TOOLKIT_SCROLL_BARS
6797 struct scroll_bar *bar
6798 = x_window_to_scroll_bar (event.xmotion.display,
6799 event.xmotion.window);
6801 if (bar)
6802 x_scroll_bar_note_movement (bar, &event);
6803 #endif /* USE_TOOLKIT_SCROLL_BARS */
6805 /* If we move outside the frame, then we're
6806 certainly no longer on any text in the frame. */
6807 clear_mouse_face (hlinfo);
6810 /* If the contents of the global variable help_echo_string
6811 has changed, generate a HELP_EVENT. */
6812 if (!NILP (help_echo_string)
6813 || !NILP (previous_help_echo_string))
6814 do_help = 1;
6815 goto OTHER;
6818 case ConfigureNotify:
6819 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6820 #ifdef USE_GTK
6821 if (!f
6822 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6823 && event.xconfigure.window == FRAME_X_WINDOW (f))
6825 xg_frame_resized (f, event.xconfigure.width,
6826 event.xconfigure.height);
6827 f = 0;
6829 #endif
6830 if (f)
6832 #ifndef USE_X_TOOLKIT
6833 #ifndef USE_GTK
6834 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6835 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6837 /* In the toolkit version, change_frame_size
6838 is called by the code that handles resizing
6839 of the EmacsFrame widget. */
6841 /* Even if the number of character rows and columns has
6842 not changed, the font size may have changed, so we need
6843 to check the pixel dimensions as well. */
6844 if (columns != FRAME_COLS (f)
6845 || rows != FRAME_LINES (f)
6846 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6847 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6849 change_frame_size (f, rows, columns, 0, 1, 0);
6850 SET_FRAME_GARBAGED (f);
6851 cancel_mouse_face (f);
6854 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6855 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6856 #endif /* not USE_GTK */
6857 #endif
6859 #ifdef USE_GTK
6860 /* GTK creates windows but doesn't map them.
6861 Only get real positions when mapped. */
6862 if (FRAME_GTK_OUTER_WIDGET (f)
6863 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6864 #endif
6866 x_real_positions (f, &f->left_pos, &f->top_pos);
6869 #ifdef HAVE_X_I18N
6870 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6871 xic_set_statusarea (f);
6872 #endif
6875 goto OTHER;
6877 case ButtonRelease:
6878 case ButtonPress:
6880 /* If we decide we want to generate an event to be seen
6881 by the rest of Emacs, we put it here. */
6882 int tool_bar_p = 0;
6884 memset (&compose_status, 0, sizeof (compose_status));
6885 last_mouse_glyph_frame = 0;
6886 last_user_time = event.xbutton.time;
6888 if (dpyinfo->grabbed
6889 && last_mouse_frame
6890 && FRAME_LIVE_P (last_mouse_frame))
6891 f = last_mouse_frame;
6892 else
6893 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6895 #ifdef USE_GTK
6896 if (f && xg_event_is_for_scrollbar (f, &event))
6897 f = 0;
6898 #endif
6899 if (f)
6901 /* Is this in the tool-bar? */
6902 if (WINDOWP (f->tool_bar_window)
6903 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6905 Lisp_Object window;
6906 int x = event.xbutton.x;
6907 int y = event.xbutton.y;
6909 window = window_from_coordinates (f, x, y, 0, 1);
6910 tool_bar_p = EQ (window, f->tool_bar_window);
6912 if (tool_bar_p && event.xbutton.button < 4)
6914 handle_tool_bar_click (f, x, y,
6915 event.xbutton.type == ButtonPress,
6916 x_x_to_emacs_modifiers (dpyinfo,
6917 event.xbutton.state));
6921 if (!tool_bar_p)
6922 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6923 if (! popup_activated ())
6924 #endif
6926 if (ignore_next_mouse_click_timeout)
6928 if (event.type == ButtonPress
6929 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6931 ignore_next_mouse_click_timeout = 0;
6932 construct_mouse_click (&inev.ie, &event.xbutton, f);
6934 if (event.type == ButtonRelease)
6935 ignore_next_mouse_click_timeout = 0;
6937 else
6938 construct_mouse_click (&inev.ie, &event.xbutton, f);
6940 if (FRAME_X_EMBEDDED_P (f))
6941 xembed_send_message (f, event.xbutton.time,
6942 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6944 else
6946 struct scroll_bar *bar
6947 = x_window_to_scroll_bar (event.xbutton.display,
6948 event.xbutton.window);
6950 #ifdef USE_TOOLKIT_SCROLL_BARS
6951 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6952 scroll bars. */
6953 if (bar && event.xbutton.state & ControlMask)
6955 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6956 *finish = X_EVENT_DROP;
6958 #else /* not USE_TOOLKIT_SCROLL_BARS */
6959 if (bar)
6960 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6961 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6964 if (event.type == ButtonPress)
6966 dpyinfo->grabbed |= (1 << event.xbutton.button);
6967 last_mouse_frame = f;
6969 if (!tool_bar_p)
6970 last_tool_bar_item = -1;
6972 else
6973 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6975 /* Ignore any mouse motion that happened before this event;
6976 any subsequent mouse-movement Emacs events should reflect
6977 only motion after the ButtonPress/Release. */
6978 if (f != 0)
6979 f->mouse_moved = 0;
6981 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6982 f = x_menubar_window_to_frame (dpyinfo, &event);
6983 /* For a down-event in the menu bar,
6984 don't pass it to Xt right now.
6985 Instead, save it away
6986 and we will pass it to Xt from kbd_buffer_get_event.
6987 That way, we can run some Lisp code first. */
6988 if (! popup_activated ()
6989 #ifdef USE_GTK
6990 /* Gtk+ menus only react to the first three buttons. */
6991 && event.xbutton.button < 3
6992 #endif
6993 && f && event.type == ButtonPress
6994 /* Verify the event is really within the menu bar
6995 and not just sent to it due to grabbing. */
6996 && event.xbutton.x >= 0
6997 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6998 && event.xbutton.y >= 0
6999 && event.xbutton.y < f->output_data.x->menubar_height
7000 && event.xbutton.same_screen)
7002 SET_SAVED_BUTTON_EVENT;
7003 XSETFRAME (last_mouse_press_frame, f);
7004 *finish = X_EVENT_DROP;
7006 else if (event.type == ButtonPress)
7008 last_mouse_press_frame = Qnil;
7009 goto OTHER;
7011 else
7012 goto OTHER;
7013 #endif /* USE_X_TOOLKIT || USE_GTK */
7015 break;
7017 case CirculateNotify:
7018 goto OTHER;
7020 case CirculateRequest:
7021 goto OTHER;
7023 case VisibilityNotify:
7024 goto OTHER;
7026 case MappingNotify:
7027 /* Someone has changed the keyboard mapping - update the
7028 local cache. */
7029 switch (event.xmapping.request)
7031 case MappingModifier:
7032 x_find_modifier_meanings (dpyinfo);
7033 /* This is meant to fall through. */
7034 case MappingKeyboard:
7035 XRefreshKeyboardMapping (&event.xmapping);
7037 goto OTHER;
7039 case DestroyNotify:
7040 xft_settings_event (dpyinfo, &event);
7041 break;
7043 default:
7044 OTHER:
7045 #ifdef USE_X_TOOLKIT
7046 block_input ();
7047 if (*finish != X_EVENT_DROP)
7048 XtDispatchEvent (&event);
7049 unblock_input ();
7050 #endif /* USE_X_TOOLKIT */
7051 break;
7054 done:
7055 if (inev.ie.kind != NO_EVENT)
7057 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7058 count++;
7061 if (do_help
7062 && !(hold_quit && hold_quit->kind != NO_EVENT))
7064 Lisp_Object frame;
7066 if (f)
7067 XSETFRAME (frame, f);
7068 else
7069 frame = Qnil;
7071 if (do_help > 0)
7073 any_help_event_p = 1;
7074 gen_help_event (help_echo_string, frame, help_echo_window,
7075 help_echo_object, help_echo_pos);
7077 else
7079 help_echo_string = Qnil;
7080 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7082 count++;
7085 SAFE_FREE ();
7086 *eventptr = event;
7087 return count;
7090 #if defined USE_GTK || defined USE_X_TOOLKIT
7092 /* Handles the XEvent EVENT on display DISPLAY.
7093 This is used for event loops outside the normal event handling,
7094 i.e. looping while a popup menu or a dialog is posted.
7096 Returns the value handle_one_xevent sets in the finish argument. */
7098 x_dispatch_event (XEvent *event, Display *display)
7100 struct x_display_info *dpyinfo;
7101 int finish = X_EVENT_NORMAL;
7103 dpyinfo = x_display_info_for_display (display);
7105 if (dpyinfo)
7106 handle_one_xevent (dpyinfo, event, &finish, 0);
7108 return finish;
7110 #endif
7113 /* Read events coming from the X server.
7114 Return as soon as there are no more events to be read.
7116 Return the number of characters stored into the buffer,
7117 thus pretending to be `read' (except the characters we store
7118 in the keyboard buffer can be multibyte, so are not necessarily
7119 C chars). */
7121 static int
7122 XTread_socket (struct terminal *terminal, struct input_event *hold_quit)
7124 int count = 0;
7125 int event_found = 0;
7127 block_input ();
7129 /* So people can tell when we have read the available input. */
7130 input_signal_count++;
7132 /* For debugging, this gives a way to fake an I/O error. */
7133 if (terminal->display_info.x == XTread_socket_fake_io_error)
7135 XTread_socket_fake_io_error = 0;
7136 x_io_error_quitter (terminal->display_info.x->display);
7139 #ifndef USE_GTK
7140 while (XPending (terminal->display_info.x->display))
7142 int finish;
7143 XEvent event;
7145 XNextEvent (terminal->display_info.x->display, &event);
7147 #ifdef HAVE_X_I18N
7148 /* Filter events for the current X input method. */
7149 if (x_filter_event (terminal->display_info.x, &event))
7150 continue;
7151 #endif
7152 event_found = 1;
7154 count += handle_one_xevent (terminal->display_info.x,
7155 &event, &finish, hold_quit);
7157 if (finish == X_EVENT_GOTO_OUT)
7158 goto out;
7161 out:;
7163 #else /* USE_GTK */
7165 /* For GTK we must use the GTK event loop. But XEvents gets passed
7166 to our filter function above, and then to the big event switch.
7167 We use a bunch of globals to communicate with our filter function,
7168 that is kind of ugly, but it works.
7170 There is no way to do one display at the time, GTK just does events
7171 from all displays. */
7173 while (gtk_events_pending ())
7175 current_count = count;
7176 current_hold_quit = hold_quit;
7178 gtk_main_iteration ();
7180 count = current_count;
7181 current_count = -1;
7182 current_hold_quit = 0;
7184 if (current_finish == X_EVENT_GOTO_OUT)
7185 break;
7187 #endif /* USE_GTK */
7189 /* On some systems, an X bug causes Emacs to get no more events
7190 when the window is destroyed. Detect that. (1994.) */
7191 if (! event_found)
7193 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7194 One XNOOP in 100 loops will make Emacs terminate.
7195 B. Bretthauer, 1994 */
7196 x_noop_count++;
7197 if (x_noop_count >= 100)
7199 x_noop_count=0;
7201 if (next_noop_dpyinfo == 0)
7202 next_noop_dpyinfo = x_display_list;
7204 XNoOp (next_noop_dpyinfo->display);
7206 /* Each time we get here, cycle through the displays now open. */
7207 next_noop_dpyinfo = next_noop_dpyinfo->next;
7211 /* If the focus was just given to an auto-raising frame,
7212 raise it now. */
7213 /* ??? This ought to be able to handle more than one such frame. */
7214 if (pending_autoraise_frame)
7216 x_raise_frame (pending_autoraise_frame);
7217 pending_autoraise_frame = 0;
7220 unblock_input ();
7222 return count;
7228 /***********************************************************************
7229 Text Cursor
7230 ***********************************************************************/
7232 /* Set clipping for output in glyph row ROW. W is the window in which
7233 we operate. GC is the graphics context to set clipping in.
7235 ROW may be a text row or, e.g., a mode line. Text rows must be
7236 clipped to the interior of the window dedicated to text display,
7237 mode lines must be clipped to the whole window. */
7239 static void
7240 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7242 struct frame *f = XFRAME (WINDOW_FRAME (w));
7243 XRectangle clip_rect;
7244 int window_x, window_y, window_width;
7246 window_box (w, area, &window_x, &window_y, &window_width, 0);
7248 clip_rect.x = window_x;
7249 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7250 clip_rect.y = max (clip_rect.y, window_y);
7251 clip_rect.width = window_width;
7252 clip_rect.height = row->visible_height;
7254 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7258 /* Draw a hollow box cursor on window W in glyph row ROW. */
7260 static void
7261 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7263 struct frame *f = XFRAME (WINDOW_FRAME (w));
7264 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7265 Display *dpy = FRAME_X_DISPLAY (f);
7266 int x, y, wd, h;
7267 XGCValues xgcv;
7268 struct glyph *cursor_glyph;
7269 GC gc;
7271 /* Get the glyph the cursor is on. If we can't tell because
7272 the current matrix is invalid or such, give up. */
7273 cursor_glyph = get_phys_cursor_glyph (w);
7274 if (cursor_glyph == NULL)
7275 return;
7277 /* Compute frame-relative coordinates for phys cursor. */
7278 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7279 wd = w->phys_cursor_width;
7281 /* The foreground of cursor_gc is typically the same as the normal
7282 background color, which can cause the cursor box to be invisible. */
7283 xgcv.foreground = f->output_data.x->cursor_pixel;
7284 if (dpyinfo->scratch_cursor_gc)
7285 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7286 else
7287 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7288 GCForeground, &xgcv);
7289 gc = dpyinfo->scratch_cursor_gc;
7291 /* Set clipping, draw the rectangle, and reset clipping again. */
7292 x_clip_to_row (w, row, TEXT_AREA, gc);
7293 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7294 XSetClipMask (dpy, gc, None);
7298 /* Draw a bar cursor on window W in glyph row ROW.
7300 Implementation note: One would like to draw a bar cursor with an
7301 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7302 Unfortunately, I didn't find a font yet that has this property set.
7303 --gerd. */
7305 static void
7306 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7308 struct frame *f = XFRAME (w->frame);
7309 struct glyph *cursor_glyph;
7311 /* If cursor is out of bounds, don't draw garbage. This can happen
7312 in mini-buffer windows when switching between echo area glyphs
7313 and mini-buffer. */
7314 cursor_glyph = get_phys_cursor_glyph (w);
7315 if (cursor_glyph == NULL)
7316 return;
7318 /* If on an image, draw like a normal cursor. That's usually better
7319 visible than drawing a bar, esp. if the image is large so that
7320 the bar might not be in the window. */
7321 if (cursor_glyph->type == IMAGE_GLYPH)
7323 struct glyph_row *r;
7324 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7325 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
7327 else
7329 Display *dpy = FRAME_X_DISPLAY (f);
7330 Window window = FRAME_X_WINDOW (f);
7331 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7332 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7333 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7334 XGCValues xgcv;
7336 /* If the glyph's background equals the color we normally draw
7337 the bars cursor in, the bar cursor in its normal color is
7338 invisible. Use the glyph's foreground color instead in this
7339 case, on the assumption that the glyph's colors are chosen so
7340 that the glyph is legible. */
7341 if (face->background == f->output_data.x->cursor_pixel)
7342 xgcv.background = xgcv.foreground = face->foreground;
7343 else
7344 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7345 xgcv.graphics_exposures = 0;
7347 if (gc)
7348 XChangeGC (dpy, gc, mask, &xgcv);
7349 else
7351 gc = XCreateGC (dpy, window, mask, &xgcv);
7352 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7355 x_clip_to_row (w, row, TEXT_AREA, gc);
7357 if (kind == BAR_CURSOR)
7359 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7361 if (width < 0)
7362 width = FRAME_CURSOR_WIDTH (f);
7363 width = min (cursor_glyph->pixel_width, width);
7365 w->phys_cursor_width = width;
7367 /* If the character under cursor is R2L, draw the bar cursor
7368 on the right of its glyph, rather than on the left. */
7369 if ((cursor_glyph->resolved_level & 1) != 0)
7370 x += cursor_glyph->pixel_width - width;
7372 XFillRectangle (dpy, window, gc, x,
7373 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7374 width, row->height);
7376 else
7378 int dummy_x, dummy_y, dummy_h;
7380 if (width < 0)
7381 width = row->height;
7383 width = min (row->height, width);
7385 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7386 &dummy_y, &dummy_h);
7388 XFillRectangle (dpy, window, gc,
7389 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7390 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7391 row->height - width),
7392 w->phys_cursor_width, width);
7395 XSetClipMask (dpy, gc, None);
7400 /* RIF: Define cursor CURSOR on frame F. */
7402 static void
7403 x_define_frame_cursor (struct frame *f, Cursor cursor)
7405 if (!f->pointer_invisible
7406 && f->output_data.x->current_cursor != cursor)
7407 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7408 f->output_data.x->current_cursor = cursor;
7412 /* RIF: Clear area on frame F. */
7414 static void
7415 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7417 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7418 x, y, width, height, False);
7419 #ifdef USE_GTK
7420 /* Must queue a redraw, because scroll bars might have been cleared. */
7421 if (FRAME_GTK_WIDGET (f))
7422 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7423 #endif
7427 /* RIF: Draw cursor on window W. */
7429 static void
7430 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)
7432 struct frame *f = XFRAME (WINDOW_FRAME (w));
7434 if (on_p)
7436 w->phys_cursor_type = cursor_type;
7437 w->phys_cursor_on_p = 1;
7439 if (glyph_row->exact_window_width_line_p
7440 && (glyph_row->reversed_p
7441 ? (w->phys_cursor.hpos < 0)
7442 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7444 glyph_row->cursor_in_fringe_p = 1;
7445 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7447 else
7449 switch (cursor_type)
7451 case HOLLOW_BOX_CURSOR:
7452 x_draw_hollow_cursor (w, glyph_row);
7453 break;
7455 case FILLED_BOX_CURSOR:
7456 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7457 break;
7459 case BAR_CURSOR:
7460 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7461 break;
7463 case HBAR_CURSOR:
7464 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7465 break;
7467 case NO_CURSOR:
7468 w->phys_cursor_width = 0;
7469 break;
7471 default:
7472 emacs_abort ();
7476 #ifdef HAVE_X_I18N
7477 if (w == XWINDOW (f->selected_window))
7478 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7479 xic_set_preeditarea (w, x, y);
7480 #endif
7483 #ifndef XFlush
7484 XFlush (FRAME_X_DISPLAY (f));
7485 #endif
7489 /* Icons. */
7491 /* Make the x-window of frame F use the gnu icon bitmap. */
7494 x_bitmap_icon (struct frame *f, Lisp_Object file)
7496 ptrdiff_t bitmap_id;
7498 if (FRAME_X_WINDOW (f) == 0)
7499 return 1;
7501 /* Free up our existing icon bitmap and mask if any. */
7502 if (f->output_data.x->icon_bitmap > 0)
7503 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7504 f->output_data.x->icon_bitmap = 0;
7506 if (STRINGP (file))
7508 #ifdef USE_GTK
7509 /* Use gtk_window_set_icon_from_file () if available,
7510 It's not restricted to bitmaps */
7511 if (xg_set_icon (f, file))
7512 return 0;
7513 #endif /* USE_GTK */
7514 bitmap_id = x_create_bitmap_from_file (f, file);
7515 x_create_bitmap_mask (f, bitmap_id);
7517 else
7519 /* Create the GNU bitmap and mask if necessary. */
7520 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7522 ptrdiff_t rc = -1;
7524 #ifdef USE_GTK
7526 if (xg_set_icon (f, xg_default_icon_file)
7527 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7528 return 0;
7530 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7532 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7533 if (rc != -1)
7534 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7536 #endif
7538 /* If all else fails, use the (black and white) xbm image. */
7539 if (rc == -1)
7541 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
7542 gnu_xbm_width, gnu_xbm_height);
7543 if (rc == -1)
7544 return 1;
7546 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7547 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7551 /* The first time we create the GNU bitmap and mask,
7552 this increments the ref-count one extra time.
7553 As a result, the GNU bitmap and mask are never freed.
7554 That way, we don't have to worry about allocating it again. */
7555 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7557 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7560 x_wm_set_icon_pixmap (f, bitmap_id);
7561 f->output_data.x->icon_bitmap = bitmap_id;
7563 return 0;
7567 /* Make the x-window of frame F use a rectangle with text.
7568 Use ICON_NAME as the text. */
7571 x_text_icon (struct frame *f, const char *icon_name)
7573 if (FRAME_X_WINDOW (f) == 0)
7574 return 1;
7577 XTextProperty text;
7578 text.value = (unsigned char *) icon_name;
7579 text.encoding = XA_STRING;
7580 text.format = 8;
7581 text.nitems = strlen (icon_name);
7582 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7585 if (f->output_data.x->icon_bitmap > 0)
7586 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7587 f->output_data.x->icon_bitmap = 0;
7588 x_wm_set_icon_pixmap (f, 0);
7590 return 0;
7593 #define X_ERROR_MESSAGE_SIZE 200
7595 /* If non-nil, this should be a string.
7596 It means catch X errors and store the error message in this string.
7598 The reason we use a stack is that x_catch_error/x_uncatch_error can
7599 be called from a signal handler.
7602 struct x_error_message_stack {
7603 char string[X_ERROR_MESSAGE_SIZE];
7604 Display *dpy;
7605 struct x_error_message_stack *prev;
7607 static struct x_error_message_stack *x_error_message;
7609 /* An X error handler which stores the error message in
7610 *x_error_message. This is called from x_error_handler if
7611 x_catch_errors is in effect. */
7613 static void
7614 x_error_catcher (Display *display, XErrorEvent *event)
7616 XGetErrorText (display, event->error_code,
7617 x_error_message->string,
7618 X_ERROR_MESSAGE_SIZE);
7621 /* Begin trapping X errors for display DPY. Actually we trap X errors
7622 for all displays, but DPY should be the display you are actually
7623 operating on.
7625 After calling this function, X protocol errors no longer cause
7626 Emacs to exit; instead, they are recorded in the string
7627 stored in *x_error_message.
7629 Calling x_check_errors signals an Emacs error if an X error has
7630 occurred since the last call to x_catch_errors or x_check_errors.
7632 Calling x_uncatch_errors resumes the normal error handling. */
7634 void
7635 x_catch_errors (Display *dpy)
7637 struct x_error_message_stack *data = xmalloc (sizeof *data);
7639 /* Make sure any errors from previous requests have been dealt with. */
7640 XSync (dpy, False);
7642 data->dpy = dpy;
7643 data->string[0] = 0;
7644 data->prev = x_error_message;
7645 x_error_message = data;
7648 /* Undo the last x_catch_errors call.
7649 DPY should be the display that was passed to x_catch_errors. */
7651 void
7652 x_uncatch_errors (void)
7654 struct x_error_message_stack *tmp;
7656 block_input ();
7658 /* The display may have been closed before this function is called.
7659 Check if it is still open before calling XSync. */
7660 if (x_display_info_for_display (x_error_message->dpy) != 0)
7661 XSync (x_error_message->dpy, False);
7663 tmp = x_error_message;
7664 x_error_message = x_error_message->prev;
7665 xfree (tmp);
7666 unblock_input ();
7669 /* If any X protocol errors have arrived since the last call to
7670 x_catch_errors or x_check_errors, signal an Emacs error using
7671 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7673 void
7674 x_check_errors (Display *dpy, const char *format)
7676 /* Make sure to catch any errors incurred so far. */
7677 XSync (dpy, False);
7679 if (x_error_message->string[0])
7681 char string[X_ERROR_MESSAGE_SIZE];
7682 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7683 x_uncatch_errors ();
7684 error (format, string);
7688 /* Nonzero if we had any X protocol errors
7689 since we did x_catch_errors on DPY. */
7692 x_had_errors_p (Display *dpy)
7694 /* Make sure to catch any errors incurred so far. */
7695 XSync (dpy, False);
7697 return x_error_message->string[0] != 0;
7700 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7702 void
7703 x_clear_errors (Display *dpy)
7705 x_error_message->string[0] = 0;
7708 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7709 * idea. --lorentey */
7710 /* Close off all unclosed x_catch_errors calls. */
7712 void
7713 x_fully_uncatch_errors (void)
7715 while (x_error_message)
7716 x_uncatch_errors ();
7718 #endif
7720 #if 0
7721 static unsigned int x_wire_count;
7722 x_trace_wire (void)
7724 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7726 #endif /* ! 0 */
7729 /************************************************************************
7730 Handling X errors
7731 ************************************************************************/
7733 /* Error message passed to x_connection_closed. */
7735 static char *error_msg;
7737 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7738 the text of an error message that lead to the connection loss. */
7740 static void
7741 x_connection_closed (Display *dpy, const char *error_message)
7743 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7744 Lisp_Object frame, tail;
7745 ptrdiff_t idx = SPECPDL_INDEX ();
7747 error_msg = alloca (strlen (error_message) + 1);
7748 strcpy (error_msg, error_message);
7750 /* Inhibit redisplay while frames are being deleted. */
7751 specbind (Qinhibit_redisplay, Qt);
7753 if (dpyinfo)
7755 /* Protect display from being closed when we delete the last
7756 frame on it. */
7757 dpyinfo->reference_count++;
7758 dpyinfo->terminal->reference_count++;
7761 /* First delete frames whose mini-buffers are on frames
7762 that are on the dead display. */
7763 FOR_EACH_FRAME (tail, frame)
7765 Lisp_Object minibuf_frame;
7766 minibuf_frame
7767 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7768 if (FRAME_X_P (XFRAME (frame))
7769 && FRAME_X_P (XFRAME (minibuf_frame))
7770 && ! EQ (frame, minibuf_frame)
7771 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7772 delete_frame (frame, Qnoelisp);
7775 /* Now delete all remaining frames on the dead display.
7776 We are now sure none of these is used as the mini-buffer
7777 for another frame that we need to delete. */
7778 FOR_EACH_FRAME (tail, frame)
7779 if (FRAME_X_P (XFRAME (frame))
7780 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7782 /* Set this to t so that delete_frame won't get confused
7783 trying to find a replacement. */
7784 kset_default_minibuffer_frame (FRAME_KBOARD (XFRAME (frame)), Qt);
7785 delete_frame (frame, Qnoelisp);
7788 /* If DPYINFO is null, this means we didn't open the display in the
7789 first place, so don't try to close it. */
7790 if (dpyinfo)
7792 /* We can not call XtCloseDisplay here because it calls XSync.
7793 XSync inside the error handler apparently hangs Emacs. On
7794 current Xt versions, this isn't needed either. */
7795 #ifdef USE_GTK
7796 /* A long-standing GTK bug prevents proper disconnect handling
7797 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7798 the resulting Glib error message loop filled a user's disk.
7799 To avoid this, kill Emacs unconditionally on disconnect. */
7800 shut_down_emacs (0, Qnil);
7801 fprintf (stderr, "%s\n\
7802 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7803 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7804 For details, see etc/PROBLEMS.\n",
7805 error_msg);
7806 emacs_abort ();
7807 #endif /* USE_GTK */
7809 /* Indicate that this display is dead. */
7810 dpyinfo->display = 0;
7812 dpyinfo->reference_count--;
7813 dpyinfo->terminal->reference_count--;
7814 if (dpyinfo->reference_count != 0)
7815 /* We have just closed all frames on this display. */
7816 emacs_abort ();
7819 Lisp_Object tmp;
7820 XSETTERMINAL (tmp, dpyinfo->terminal);
7821 Fdelete_terminal (tmp, Qnoelisp);
7825 if (terminal_list == 0)
7827 fprintf (stderr, "%s\n", error_msg);
7828 Fkill_emacs (make_number (70));
7829 /* NOTREACHED */
7832 totally_unblock_input ();
7834 unbind_to (idx, Qnil);
7835 clear_waiting_for_input ();
7837 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
7838 IF_LINT (if (! terminal_list) return; )
7840 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7841 longjmp), because returning from this function would get us back into
7842 Xlib's code which will directly call `exit'. */
7843 error ("%s", error_msg);
7846 /* We specifically use it before defining it, so that gcc doesn't inline it,
7847 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7848 static void x_error_quitter (Display *, XErrorEvent *);
7850 /* This is the first-level handler for X protocol errors.
7851 It calls x_error_quitter or x_error_catcher. */
7853 static int
7854 x_error_handler (Display *display, XErrorEvent *event)
7856 #ifdef HAVE_GTK3
7857 if (event->error_code == BadMatch
7858 && event->request_code == X_SetInputFocus
7859 && event->minor_code == 0)
7861 return 0;
7863 #endif
7865 if (x_error_message)
7866 x_error_catcher (display, event);
7867 else
7868 x_error_quitter (display, event);
7869 return 0;
7872 /* This is the usual handler for X protocol errors.
7873 It kills all frames on the display that we got the error for.
7874 If that was the only one, it prints an error message and kills Emacs. */
7876 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7878 /* On older GCC versions, just putting x_error_quitter
7879 after x_error_handler prevents inlining into the former. */
7881 static void NO_INLINE
7882 x_error_quitter (Display *display, XErrorEvent *event)
7884 char buf[256], buf1[356];
7886 /* Ignore BadName errors. They can happen because of fonts
7887 or colors that are not defined. */
7889 if (event->error_code == BadName)
7890 return;
7892 /* Note that there is no real way portable across R3/R4 to get the
7893 original error handler. */
7895 XGetErrorText (display, event->error_code, buf, sizeof (buf));
7896 sprintf (buf1, "X protocol error: %s on protocol request %d",
7897 buf, event->request_code);
7898 x_connection_closed (display, buf1);
7902 /* This is the handler for X IO errors, always.
7903 It kills all frames on the display that we lost touch with.
7904 If that was the only one, it prints an error message and kills Emacs. */
7906 static int
7907 x_io_error_quitter (Display *display)
7909 char buf[256];
7911 snprintf (buf, sizeof buf, "Connection lost to X server `%s'",
7912 DisplayString (display));
7913 x_connection_closed (display, buf);
7914 return 0;
7917 /* Changing the font of the frame. */
7919 /* Give frame F the font FONT-OBJECT as its default font. The return
7920 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7921 frame. If it is negative, generate a new fontset from
7922 FONT-OBJECT. */
7924 Lisp_Object
7925 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7927 struct font *font = XFONT_OBJECT (font_object);
7929 if (fontset < 0)
7930 fontset = fontset_from_font (font_object);
7931 FRAME_FONTSET (f) = fontset;
7932 if (FRAME_FONT (f) == font)
7933 /* This font is already set in frame F. There's nothing more to
7934 do. */
7935 return font_object;
7937 FRAME_FONT (f) = font;
7938 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7939 FRAME_COLUMN_WIDTH (f) = font->average_width;
7940 FRAME_SPACE_WIDTH (f) = font->space_width;
7941 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7943 compute_fringe_widths (f, 1);
7945 /* Compute the scroll bar width in character columns. */
7946 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7948 int wid = FRAME_COLUMN_WIDTH (f);
7949 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7950 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7952 else
7954 int wid = FRAME_COLUMN_WIDTH (f);
7955 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7958 if (FRAME_X_WINDOW (f) != 0)
7960 /* Don't change the size of a tip frame; there's no point in
7961 doing it because it's done in Fx_show_tip, and it leads to
7962 problems because the tip frame has no widget. */
7963 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7964 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7967 #ifdef HAVE_X_I18N
7968 if (FRAME_XIC (f)
7969 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7971 block_input ();
7972 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7973 unblock_input ();
7975 #endif
7977 return font_object;
7981 /***********************************************************************
7982 X Input Methods
7983 ***********************************************************************/
7985 #ifdef HAVE_X_I18N
7987 #ifdef HAVE_X11R6
7989 /* XIM destroy callback function, which is called whenever the
7990 connection to input method XIM dies. CLIENT_DATA contains a
7991 pointer to the x_display_info structure corresponding to XIM. */
7993 static void
7994 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7996 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7997 Lisp_Object frame, tail;
7999 block_input ();
8001 /* No need to call XDestroyIC.. */
8002 FOR_EACH_FRAME (tail, frame)
8004 struct frame *f = XFRAME (frame);
8005 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8007 FRAME_XIC (f) = NULL;
8008 xic_free_xfontset (f);
8012 /* No need to call XCloseIM. */
8013 dpyinfo->xim = NULL;
8014 XFree (dpyinfo->xim_styles);
8015 unblock_input ();
8018 #endif /* HAVE_X11R6 */
8020 #ifdef HAVE_X11R6
8021 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8022 extern char *XSetIMValues (XIM, ...);
8023 #endif
8025 /* Open the connection to the XIM server on display DPYINFO.
8026 RESOURCE_NAME is the resource name Emacs uses. */
8028 static void
8029 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
8031 XIM xim;
8033 #ifdef HAVE_XIM
8034 if (use_xim)
8036 if (dpyinfo->xim)
8037 XCloseIM (dpyinfo->xim);
8038 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8039 emacs_class);
8040 dpyinfo->xim = xim;
8042 if (xim)
8044 #ifdef HAVE_X11R6
8045 XIMCallback destroy;
8046 #endif
8048 /* Get supported styles and XIM values. */
8049 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8051 #ifdef HAVE_X11R6
8052 destroy.callback = xim_destroy_callback;
8053 destroy.client_data = (XPointer)dpyinfo;
8054 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8055 #endif
8059 else
8060 #endif /* HAVE_XIM */
8061 dpyinfo->xim = NULL;
8065 #ifdef HAVE_X11R6_XIM
8067 /* XIM instantiate callback function, which is called whenever an XIM
8068 server is available. DISPLAY is the display of the XIM.
8069 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8070 when the callback was registered. */
8072 static void
8073 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8075 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8076 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8078 /* We don't support multiple XIM connections. */
8079 if (dpyinfo->xim)
8080 return;
8082 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8084 /* Create XIC for the existing frames on the same display, as long
8085 as they have no XIC. */
8086 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8088 Lisp_Object tail, frame;
8090 block_input ();
8091 FOR_EACH_FRAME (tail, frame)
8093 struct frame *f = XFRAME (frame);
8095 if (FRAME_X_P (f)
8096 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8097 if (FRAME_XIC (f) == NULL)
8099 create_frame_xic (f);
8100 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8101 xic_set_statusarea (f);
8102 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8104 struct window *w = XWINDOW (f->selected_window);
8105 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8110 unblock_input ();
8114 #endif /* HAVE_X11R6_XIM */
8117 /* Open a connection to the XIM server on display DPYINFO.
8118 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8119 connection only at the first time. On X11R6, open the connection
8120 in the XIM instantiate callback function. */
8122 static void
8123 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8125 dpyinfo->xim = NULL;
8126 #ifdef HAVE_XIM
8127 if (use_xim)
8129 #ifdef HAVE_X11R6_XIM
8130 struct xim_inst_t *xim_inst = xmalloc (sizeof *xim_inst);
8131 ptrdiff_t len;
8133 dpyinfo->xim_callback_data = xim_inst;
8134 xim_inst->dpyinfo = dpyinfo;
8135 len = strlen (resource_name);
8136 xim_inst->resource_name = xmalloc (len + 1);
8137 memcpy (xim_inst->resource_name, resource_name, len + 1);
8138 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8139 resource_name, emacs_class,
8140 xim_instantiate_callback,
8141 /* This is XPointer in XFree86
8142 but (XPointer *) on Tru64, at
8143 least, hence the configure test. */
8144 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8145 #else /* not HAVE_X11R6_XIM */
8146 xim_open_dpy (dpyinfo, resource_name);
8147 #endif /* not HAVE_X11R6_XIM */
8149 #endif /* HAVE_XIM */
8153 /* Close the connection to the XIM server on display DPYINFO. */
8155 static void
8156 xim_close_dpy (struct x_display_info *dpyinfo)
8158 #ifdef HAVE_XIM
8159 if (use_xim)
8161 #ifdef HAVE_X11R6_XIM
8162 if (dpyinfo->display)
8163 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8164 NULL, emacs_class,
8165 xim_instantiate_callback, NULL);
8166 xfree (dpyinfo->xim_callback_data->resource_name);
8167 xfree (dpyinfo->xim_callback_data);
8168 #endif /* HAVE_X11R6_XIM */
8169 if (dpyinfo->display)
8170 XCloseIM (dpyinfo->xim);
8171 dpyinfo->xim = NULL;
8172 XFree (dpyinfo->xim_styles);
8174 #endif /* HAVE_XIM */
8177 #endif /* not HAVE_X11R6_XIM */
8181 /* Calculate the absolute position in frame F
8182 from its current recorded position values and gravity. */
8184 static void
8185 x_calc_absolute_position (struct frame *f)
8187 int flags = f->size_hint_flags;
8189 /* We have nothing to do if the current position
8190 is already for the top-left corner. */
8191 if (! ((flags & XNegative) || (flags & YNegative)))
8192 return;
8194 /* Treat negative positions as relative to the leftmost bottommost
8195 position that fits on the screen. */
8196 if (flags & XNegative)
8197 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8198 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8201 int height = FRAME_PIXEL_HEIGHT (f);
8203 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8204 /* Something is fishy here. When using Motif, starting Emacs with
8205 `-g -0-0', the frame appears too low by a few pixels.
8207 This seems to be so because initially, while Emacs is starting,
8208 the column widget's height and the frame's pixel height are
8209 different. The column widget's height is the right one. In
8210 later invocations, when Emacs is up, the frame's pixel height
8211 is right, though.
8213 It's not obvious where the initial small difference comes from.
8214 2000-12-01, gerd. */
8216 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8217 #endif
8219 if (flags & YNegative)
8220 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8221 - height + f->top_pos;
8224 /* The left_pos and top_pos
8225 are now relative to the top and left screen edges,
8226 so the flags should correspond. */
8227 f->size_hint_flags &= ~ (XNegative | YNegative);
8230 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8231 to really change the position, and 0 when calling from
8232 x_make_frame_visible (in that case, XOFF and YOFF are the current
8233 position values). It is -1 when calling from x_set_frame_parameters,
8234 which means, do adjust for borders but don't change the gravity. */
8236 void
8237 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8239 int modified_top, modified_left;
8241 if (change_gravity > 0)
8243 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8244 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8246 f->top_pos = yoff;
8247 f->left_pos = xoff;
8248 f->size_hint_flags &= ~ (XNegative | YNegative);
8249 if (xoff < 0)
8250 f->size_hint_flags |= XNegative;
8251 if (yoff < 0)
8252 f->size_hint_flags |= YNegative;
8253 f->win_gravity = NorthWestGravity;
8255 x_calc_absolute_position (f);
8257 block_input ();
8258 x_wm_set_size_hint (f, (long) 0, 0);
8260 modified_left = f->left_pos;
8261 modified_top = f->top_pos;
8263 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8265 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8266 than the WM decorations. So we use the calculated offset instead
8267 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8268 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8269 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8272 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8273 modified_left, modified_top);
8275 x_sync_with_move (f, f->left_pos, f->top_pos,
8276 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8277 ? 1 : 0);
8279 /* change_gravity is non-zero when this function is called from Lisp to
8280 programmatically move a frame. In that case, we call
8281 x_check_expected_move to discover if we have a "Type A" or "Type B"
8282 window manager, and, for a "Type A" window manager, adjust the position
8283 of the frame.
8285 We call x_check_expected_move if a programmatic move occurred, and
8286 either the window manager type (A/B) is unknown or it is Type A but we
8287 need to compute the top/left offset adjustment for this frame. */
8289 if (change_gravity != 0 &&
8290 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8291 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8292 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8293 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8294 x_check_expected_move (f, modified_left, modified_top);
8296 unblock_input ();
8299 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8300 on the root window for frame F contains ATOMNAME.
8301 This is how a WM check shall be done according to the Window Manager
8302 Specification/Extended Window Manager Hints at
8303 http://freedesktop.org/wiki/Specifications/wm-spec. */
8305 static int
8306 wm_supports (struct frame *f, Atom want_atom)
8308 Atom actual_type;
8309 unsigned long actual_size, bytes_remaining;
8310 int i, rc, actual_format;
8311 Window wmcheck_window;
8312 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8313 Window target_window = dpyinfo->root_window;
8314 long max_len = 65536;
8315 Display *dpy = FRAME_X_DISPLAY (f);
8316 unsigned char *tmp_data = NULL;
8317 Atom target_type = XA_WINDOW;
8319 block_input ();
8321 x_catch_errors (dpy);
8322 rc = XGetWindowProperty (dpy, target_window,
8323 dpyinfo->Xatom_net_supporting_wm_check,
8324 0, max_len, False, target_type,
8325 &actual_type, &actual_format, &actual_size,
8326 &bytes_remaining, &tmp_data);
8328 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8330 if (tmp_data) XFree (tmp_data);
8331 x_uncatch_errors ();
8332 unblock_input ();
8333 return 0;
8336 wmcheck_window = *(Window *) tmp_data;
8337 XFree (tmp_data);
8339 /* Check if window exists. */
8340 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8341 x_sync (f);
8342 if (x_had_errors_p (dpy))
8344 x_uncatch_errors ();
8345 unblock_input ();
8346 return 0;
8349 if (dpyinfo->net_supported_window != wmcheck_window)
8351 /* Window changed, reload atoms */
8352 if (dpyinfo->net_supported_atoms != NULL)
8353 XFree (dpyinfo->net_supported_atoms);
8354 dpyinfo->net_supported_atoms = NULL;
8355 dpyinfo->nr_net_supported_atoms = 0;
8356 dpyinfo->net_supported_window = 0;
8358 target_type = XA_ATOM;
8359 tmp_data = NULL;
8360 rc = XGetWindowProperty (dpy, target_window,
8361 dpyinfo->Xatom_net_supported,
8362 0, max_len, False, target_type,
8363 &actual_type, &actual_format, &actual_size,
8364 &bytes_remaining, &tmp_data);
8366 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8368 if (tmp_data) XFree (tmp_data);
8369 x_uncatch_errors ();
8370 unblock_input ();
8371 return 0;
8374 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8375 dpyinfo->nr_net_supported_atoms = actual_size;
8376 dpyinfo->net_supported_window = wmcheck_window;
8379 rc = 0;
8381 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8382 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8384 x_uncatch_errors ();
8385 unblock_input ();
8387 return rc;
8390 static void
8391 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8393 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8395 x_send_client_event (frame, make_number (0), frame,
8396 dpyinfo->Xatom_net_wm_state,
8397 make_number (32),
8398 /* 1 = add, 0 = remove */
8399 Fcons
8400 (make_number (add ? 1 : 0),
8401 Fcons
8402 (make_fixnum_or_float (atom),
8403 value != 0
8404 ? Fcons (make_fixnum_or_float (value), Qnil)
8405 : Qnil)));
8408 void
8409 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8411 Lisp_Object frame;
8412 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8414 XSETFRAME (frame, f);
8416 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8417 dpyinfo->Xatom_net_wm_state_sticky, None);
8420 /* Return the current _NET_WM_STATE.
8421 SIZE_STATE is set to one of the FULLSCREEN_* values.
8422 STICKY is set to 1 if the sticky state is set, 0 if not.
8424 Return non-zero if we are not hidden, zero if we are. */
8426 static int
8427 get_current_wm_state (struct frame *f,
8428 Window window,
8429 int *size_state,
8430 int *sticky)
8432 Atom actual_type;
8433 unsigned long actual_size, bytes_remaining;
8434 int i, rc, actual_format, is_hidden = 0;
8435 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8436 long max_len = 65536;
8437 Display *dpy = FRAME_X_DISPLAY (f);
8438 unsigned char *tmp_data = NULL;
8439 Atom target_type = XA_ATOM;
8441 *sticky = 0;
8442 *size_state = FULLSCREEN_NONE;
8444 block_input ();
8445 x_catch_errors (dpy);
8446 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8447 0, max_len, False, target_type,
8448 &actual_type, &actual_format, &actual_size,
8449 &bytes_remaining, &tmp_data);
8451 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8453 if (tmp_data) XFree (tmp_data);
8454 x_uncatch_errors ();
8455 unblock_input ();
8456 return ! f->iconified;
8459 x_uncatch_errors ();
8461 for (i = 0; i < actual_size; ++i)
8463 Atom a = ((Atom*)tmp_data)[i];
8464 if (a == dpyinfo->Xatom_net_wm_state_hidden)
8466 is_hidden = 1;
8467 f->output_data.x->net_wm_state_hidden_seen = 1;
8469 else if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8471 if (*size_state == FULLSCREEN_HEIGHT)
8472 *size_state = FULLSCREEN_MAXIMIZED;
8473 else
8474 *size_state = FULLSCREEN_WIDTH;
8476 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8478 if (*size_state == FULLSCREEN_WIDTH)
8479 *size_state = FULLSCREEN_MAXIMIZED;
8480 else
8481 *size_state = FULLSCREEN_HEIGHT;
8483 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8484 *size_state = FULLSCREEN_BOTH;
8485 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8486 *sticky = 1;
8489 if (tmp_data) XFree (tmp_data);
8490 unblock_input ();
8491 return ! is_hidden;
8494 /* Do fullscreen as specified in extended window manager hints */
8496 static int
8497 do_ewmh_fullscreen (struct frame *f)
8499 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8500 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8501 int cur, dummy;
8503 (void)get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8505 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8506 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8507 if (!have_net_atom)
8508 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8510 if (have_net_atom && cur != f->want_fullscreen)
8512 Lisp_Object frame;
8514 XSETFRAME (frame, f);
8516 /* Keep number of calls to set_wm_state as low as possible.
8517 Some window managers, or possible Gtk+, hangs when too many
8518 are sent at once. */
8519 switch (f->want_fullscreen)
8521 case FULLSCREEN_BOTH:
8522 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8523 || cur == FULLSCREEN_HEIGHT)
8524 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8525 dpyinfo->Xatom_net_wm_state_maximized_vert);
8526 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8527 break;
8528 case FULLSCREEN_WIDTH:
8529 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8530 || cur == FULLSCREEN_MAXIMIZED)
8531 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8532 dpyinfo->Xatom_net_wm_state_maximized_vert);
8533 if (cur != FULLSCREEN_MAXIMIZED)
8534 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8535 break;
8536 case FULLSCREEN_HEIGHT:
8537 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8538 || cur == FULLSCREEN_MAXIMIZED)
8539 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8540 dpyinfo->Xatom_net_wm_state_maximized_horz);
8541 if (cur != FULLSCREEN_MAXIMIZED)
8542 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8543 break;
8544 case FULLSCREEN_MAXIMIZED:
8545 if (cur == FULLSCREEN_BOTH)
8546 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8547 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8548 dpyinfo->Xatom_net_wm_state_maximized_vert);
8549 break;
8550 case FULLSCREEN_NONE:
8551 if (cur == FULLSCREEN_BOTH)
8552 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8553 else
8554 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8555 dpyinfo->Xatom_net_wm_state_maximized_vert);
8558 f->want_fullscreen = FULLSCREEN_NONE;
8562 return have_net_atom;
8565 static void
8566 XTfullscreen_hook (FRAME_PTR f)
8568 if (f->async_visible)
8570 block_input ();
8571 x_check_fullscreen (f);
8572 x_sync (f);
8573 unblock_input ();
8578 static int
8579 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8581 int value = FULLSCREEN_NONE;
8582 Lisp_Object lval;
8583 int sticky = 0;
8584 int not_hidden = get_current_wm_state (f, event->window, &value, &sticky);
8586 lval = Qnil;
8587 switch (value)
8589 case FULLSCREEN_WIDTH:
8590 lval = Qfullwidth;
8591 break;
8592 case FULLSCREEN_HEIGHT:
8593 lval = Qfullheight;
8594 break;
8595 case FULLSCREEN_BOTH:
8596 lval = Qfullboth;
8597 break;
8598 case FULLSCREEN_MAXIMIZED:
8599 lval = Qmaximized;
8600 break;
8603 store_frame_param (f, Qfullscreen, lval);
8604 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8606 return not_hidden;
8609 /* Check if we need to resize the frame due to a fullscreen request.
8610 If so needed, resize the frame. */
8611 static void
8612 x_check_fullscreen (struct frame *f)
8614 if (do_ewmh_fullscreen (f))
8615 return;
8617 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8618 return; /* Only fullscreen without WM or with EWM hints (above). */
8620 /* Setting fullscreen to nil doesn't do anything. We could save the
8621 last non-fullscreen size and restore it, but it seems like a
8622 lot of work for this unusual case (no window manager running). */
8624 if (f->want_fullscreen != FULLSCREEN_NONE)
8626 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8627 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8629 switch (f->want_fullscreen)
8631 /* No difference between these two when there is no WM */
8632 case FULLSCREEN_BOTH:
8633 case FULLSCREEN_MAXIMIZED:
8634 width = x_display_pixel_width (dpyinfo);
8635 height = x_display_pixel_height (dpyinfo);
8636 break;
8637 case FULLSCREEN_WIDTH:
8638 width = x_display_pixel_width (dpyinfo);
8639 break;
8640 case FULLSCREEN_HEIGHT:
8641 height = x_display_pixel_height (dpyinfo);
8644 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8645 width, height);
8649 /* This function is called by x_set_offset to determine whether the window
8650 manager interfered with the positioning of the frame. Type A window
8651 managers position the surrounding window manager decorations a small
8652 amount above and left of the user-supplied position. Type B window
8653 managers position the surrounding window manager decorations at the
8654 user-specified position. If we detect a Type A window manager, we
8655 compensate by moving the window right and down by the proper amount. */
8657 static void
8658 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8660 int current_left = 0, current_top = 0;
8662 /* x_real_positions returns the left and top offsets of the outermost
8663 window manager window around the frame. */
8665 x_real_positions (f, &current_left, &current_top);
8667 if (current_left != expected_left || current_top != expected_top)
8669 /* It's a "Type A" window manager. */
8671 int adjusted_left;
8672 int adjusted_top;
8674 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8675 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8676 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8678 /* Now fix the mispositioned frame's location. */
8680 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8681 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8683 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8684 adjusted_left, adjusted_top);
8686 x_sync_with_move (f, expected_left, expected_top, 0);
8688 else
8689 /* It's a "Type B" window manager. We don't have to adjust the
8690 frame's position. */
8692 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8696 /* Wait for XGetGeometry to return up-to-date position information for a
8697 recently-moved frame. Call this immediately after calling XMoveWindow.
8698 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8699 frame has been moved to, so we use a fuzzy position comparison instead
8700 of an exact comparison. */
8702 static void
8703 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8705 int count = 0;
8707 while (count++ < 50)
8709 int current_left = 0, current_top = 0;
8711 /* In theory, this call to XSync only needs to happen once, but in
8712 practice, it doesn't seem to work, hence the need for the surrounding
8713 loop. */
8715 XSync (FRAME_X_DISPLAY (f), False);
8716 x_real_positions (f, &current_left, &current_top);
8718 if (fuzzy)
8720 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8721 pixels. */
8723 if (eabs (current_left - left) <= 10
8724 && eabs (current_top - top) <= 40)
8725 return;
8727 else if (current_left == left && current_top == top)
8728 return;
8731 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8732 will then return up-to-date position info. */
8734 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8738 /* Wait for an event on frame F matching EVENTTYPE. */
8739 void
8740 x_wait_for_event (struct frame *f, int eventtype)
8742 int level = interrupt_input_blocked;
8744 SELECT_TYPE fds;
8745 EMACS_TIME tmo, tmo_at, time_now;
8746 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8748 pending_event_wait.f = f;
8749 pending_event_wait.eventtype = eventtype;
8751 /* Set timeout to 0.1 second. Hopefully not noticeable.
8752 Maybe it should be configurable. */
8753 tmo = make_emacs_time (0, 100 * 1000 * 1000);
8754 tmo_at = add_emacs_time (current_emacs_time (), tmo);
8756 while (pending_event_wait.eventtype)
8758 pending_signals = 1;
8759 totally_unblock_input ();
8760 /* XTread_socket is called after unblock. */
8761 block_input ();
8762 interrupt_input_blocked = level;
8764 FD_ZERO (&fds);
8765 FD_SET (fd, &fds);
8767 time_now = current_emacs_time ();
8768 if (EMACS_TIME_LT (tmo_at, time_now))
8769 break;
8771 tmo = sub_emacs_time (tmo_at, time_now);
8772 if (pselect (fd + 1, &fds, NULL, NULL, &tmo, NULL) == 0)
8773 break; /* Timeout */
8775 pending_event_wait.f = 0;
8776 pending_event_wait.eventtype = 0;
8780 /* Change the size of frame F's X window to COLS/ROWS in the case F
8781 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8782 top-left-corner window gravity for this size change and subsequent
8783 size changes. Otherwise we leave the window gravity unchanged. */
8785 static void
8786 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8788 int pixelwidth, pixelheight;
8790 check_frame_size (f, &rows, &cols);
8791 f->scroll_bar_actual_width
8792 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8794 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8796 compute_fringe_widths (f, 0);
8798 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8799 + FRAME_TOOLBAR_WIDTH (f);
8800 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8801 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8803 if (change_gravity) f->win_gravity = NorthWestGravity;
8804 x_wm_set_size_hint (f, (long) 0, 0);
8805 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8806 pixelwidth, pixelheight);
8809 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8810 receive in the ConfigureNotify event; if we get what we asked
8811 for, then the event won't cause the screen to become garbaged, so
8812 we have to make sure to do it here. */
8813 SET_FRAME_GARBAGED (f);
8815 /* Now, strictly speaking, we can't be sure that this is accurate,
8816 but the window manager will get around to dealing with the size
8817 change request eventually, and we'll hear how it went when the
8818 ConfigureNotify event gets here.
8820 We could just not bother storing any of this information here,
8821 and let the ConfigureNotify event set everything up, but that
8822 might be kind of confusing to the Lisp code, since size changes
8823 wouldn't be reported in the frame parameters until some random
8824 point in the future when the ConfigureNotify event arrives.
8826 We pass 1 for DELAY since we can't run Lisp code inside of
8827 a BLOCK_INPUT. */
8829 /* But the ConfigureNotify may in fact never arrive, and then this is
8830 not right if the frame is visible. Instead wait (with timeout)
8831 for the ConfigureNotify. */
8832 if (f->async_visible)
8833 x_wait_for_event (f, ConfigureNotify);
8834 else
8836 change_frame_size (f, rows, cols, 0, 1, 0);
8837 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8838 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8839 x_sync (f);
8844 /* Call this to change the size of frame F's x-window.
8845 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8846 for this size change and subsequent size changes.
8847 Otherwise we leave the window gravity unchanged. */
8849 void
8850 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8852 block_input ();
8854 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8856 int r, c;
8858 /* When the frame is maximized/fullscreen or running under for
8859 example Xmonad, x_set_window_size_1 will be a no-op.
8860 In that case, the right thing to do is extend rows/cols to
8861 the current frame size. We do that first if x_set_window_size_1
8862 turns out to not be a no-op (there is no way to know).
8863 The size will be adjusted again if the frame gets a
8864 ConfigureNotify event as a result of x_set_window_size. */
8865 int pixelh = FRAME_PIXEL_HEIGHT (f);
8866 #ifdef USE_X_TOOLKIT
8867 /* The menu bar is not part of text lines. The tool bar
8868 is however. */
8869 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8870 #endif
8871 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8872 /* Update f->scroll_bar_actual_width because it is used in
8873 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8874 f->scroll_bar_actual_width
8875 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8876 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8877 change_frame_size (f, r, c, 0, 1, 0);
8880 #ifdef USE_GTK
8881 if (FRAME_GTK_WIDGET (f))
8882 xg_frame_set_char_size (f, cols, rows);
8883 else
8884 x_set_window_size_1 (f, change_gravity, cols, rows);
8885 #else /* not USE_GTK */
8887 x_set_window_size_1 (f, change_gravity, cols, rows);
8889 #endif /* not USE_GTK */
8891 /* If cursor was outside the new size, mark it as off. */
8892 mark_window_cursors_off (XWINDOW (f->root_window));
8894 /* Clear out any recollection of where the mouse highlighting was,
8895 since it might be in a place that's outside the new frame size.
8896 Actually checking whether it is outside is a pain in the neck,
8897 so don't try--just let the highlighting be done afresh with new size. */
8898 cancel_mouse_face (f);
8900 unblock_input ();
8903 /* Mouse warping. */
8905 void
8906 x_set_mouse_position (struct frame *f, int x, int y)
8908 int pix_x, pix_y;
8910 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8911 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8913 if (pix_x < 0) pix_x = 0;
8914 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8916 if (pix_y < 0) pix_y = 0;
8917 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
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 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8928 void
8929 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8931 block_input ();
8933 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8934 0, 0, 0, 0, pix_x, pix_y);
8935 unblock_input ();
8938 /* Raise frame F. */
8940 void
8941 x_raise_frame (struct frame *f)
8943 block_input ();
8944 if (f->async_visible)
8945 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8947 XFlush (FRAME_X_DISPLAY (f));
8948 unblock_input ();
8951 /* Lower frame F. */
8953 static void
8954 x_lower_frame (struct frame *f)
8956 if (f->async_visible)
8958 block_input ();
8959 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8960 XFlush (FRAME_X_DISPLAY (f));
8961 unblock_input ();
8965 /* Request focus with XEmbed */
8967 void
8968 xembed_request_focus (FRAME_PTR f)
8970 /* See XEmbed Protocol Specification at
8971 http://freedesktop.org/wiki/Specifications/xembed-spec */
8972 if (f->async_visible)
8973 xembed_send_message (f, CurrentTime,
8974 XEMBED_REQUEST_FOCUS, 0, 0, 0);
8977 /* Activate frame with Extended Window Manager Hints */
8979 void
8980 x_ewmh_activate_frame (FRAME_PTR f)
8982 /* See Window Manager Specification/Extended Window Manager Hints at
8983 http://freedesktop.org/wiki/Specifications/wm-spec */
8985 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8986 if (f->async_visible && wm_supports (f, dpyinfo->Xatom_net_active_window))
8988 Lisp_Object frame;
8989 XSETFRAME (frame, f);
8990 x_send_client_event (frame, make_number (0), frame,
8991 dpyinfo->Xatom_net_active_window,
8992 make_number (32),
8993 Fcons (make_number (1),
8994 Fcons (make_number (last_user_time),
8995 Qnil)));
8999 static void
9000 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
9002 if (raise_flag)
9003 x_raise_frame (f);
9004 else
9005 x_lower_frame (f);
9008 /* XEmbed implementation. */
9010 #if defined USE_X_TOOLKIT || ! defined USE_GTK
9012 /* XEmbed implementation. */
9014 #define XEMBED_VERSION 0
9016 static void
9017 xembed_set_info (struct frame *f, enum xembed_info flags)
9019 unsigned long data[2];
9020 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9022 data[0] = XEMBED_VERSION;
9023 data[1] = flags;
9025 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9026 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
9027 32, PropModeReplace, (unsigned char *) data, 2);
9029 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
9031 static void
9032 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
9033 long int detail, long int data1, long int data2)
9035 XEvent event;
9037 event.xclient.type = ClientMessage;
9038 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9039 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9040 event.xclient.format = 32;
9041 event.xclient.data.l[0] = t;
9042 event.xclient.data.l[1] = msg;
9043 event.xclient.data.l[2] = detail;
9044 event.xclient.data.l[3] = data1;
9045 event.xclient.data.l[4] = data2;
9047 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9048 False, NoEventMask, &event);
9049 XSync (FRAME_X_DISPLAY (f), False);
9052 /* Change of visibility. */
9054 /* This tries to wait until the frame is really visible.
9055 However, if the window manager asks the user where to position
9056 the frame, this will return before the user finishes doing that.
9057 The frame will not actually be visible at that time,
9058 but it will become visible later when the window manager
9059 finishes with it. */
9061 void
9062 x_make_frame_visible (struct frame *f)
9064 Lisp_Object type;
9065 int original_top, original_left;
9066 int retry_count = 2;
9068 retry:
9070 block_input ();
9072 type = x_icon_type (f);
9073 if (!NILP (type))
9074 x_bitmap_icon (f, type);
9076 if (! FRAME_VISIBLE_P (f))
9078 /* We test FRAME_GARBAGED_P here to make sure we don't
9079 call x_set_offset a second time
9080 if we get to x_make_frame_visible a second time
9081 before the window gets really visible. */
9082 if (! FRAME_ICONIFIED_P (f)
9083 && ! FRAME_X_EMBEDDED_P (f)
9084 && ! f->output_data.x->asked_for_visible)
9085 x_set_offset (f, f->left_pos, f->top_pos, 0);
9087 f->output_data.x->asked_for_visible = 1;
9089 if (! EQ (Vx_no_window_manager, Qt))
9090 x_wm_set_window_state (f, NormalState);
9091 #ifdef USE_X_TOOLKIT
9092 if (FRAME_X_EMBEDDED_P (f))
9093 xembed_set_info (f, XEMBED_MAPPED);
9094 else
9096 /* This was XtPopup, but that did nothing for an iconified frame. */
9097 XtMapWidget (f->output_data.x->widget);
9099 #else /* not USE_X_TOOLKIT */
9100 #ifdef USE_GTK
9101 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9102 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9103 #else
9104 if (FRAME_X_EMBEDDED_P (f))
9105 xembed_set_info (f, XEMBED_MAPPED);
9106 else
9107 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9108 #endif /* not USE_GTK */
9109 #endif /* not USE_X_TOOLKIT */
9112 XFlush (FRAME_X_DISPLAY (f));
9114 /* Synchronize to ensure Emacs knows the frame is visible
9115 before we do anything else. We do this loop with input not blocked
9116 so that incoming events are handled. */
9118 Lisp_Object frame;
9119 int count;
9120 /* This must be before UNBLOCK_INPUT
9121 since events that arrive in response to the actions above
9122 will set it when they are handled. */
9123 int previously_visible = f->output_data.x->has_been_visible;
9125 original_left = f->left_pos;
9126 original_top = f->top_pos;
9128 /* This must come after we set COUNT. */
9129 unblock_input ();
9131 /* We unblock here so that arriving X events are processed. */
9133 /* Now move the window back to where it was "supposed to be".
9134 But don't do it if the gravity is negative.
9135 When the gravity is negative, this uses a position
9136 that is 3 pixels too low. Perhaps that's really the border width.
9138 Don't do this if the window has never been visible before,
9139 because the window manager may choose the position
9140 and we don't want to override it. */
9142 if (! FRAME_VISIBLE_P (f)
9143 && ! FRAME_ICONIFIED_P (f)
9144 && ! FRAME_X_EMBEDDED_P (f)
9145 && f->win_gravity == NorthWestGravity
9146 && previously_visible)
9148 Drawable rootw;
9149 int x, y;
9150 unsigned int width, height, border, depth;
9152 block_input ();
9154 /* On some window managers (such as FVWM) moving an existing
9155 window, even to the same place, causes the window manager
9156 to introduce an offset. This can cause the window to move
9157 to an unexpected location. Check the geometry (a little
9158 slow here) and then verify that the window is in the right
9159 place. If the window is not in the right place, move it
9160 there, and take the potential window manager hit. */
9161 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9162 &rootw, &x, &y, &width, &height, &border, &depth);
9164 if (original_left != x || original_top != y)
9165 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9166 original_left, original_top);
9168 unblock_input ();
9171 XSETFRAME (frame, f);
9173 /* Wait until the frame is visible. Process X events until a
9174 MapNotify event has been seen, or until we think we won't get a
9175 MapNotify at all.. */
9176 for (count = input_signal_count + 10;
9177 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9179 /* Force processing of queued events. */
9180 x_sync (f);
9182 /* Machines that do polling rather than SIGIO have been
9183 observed to go into a busy-wait here. So we'll fake an
9184 alarm signal to let the handler know that there's something
9185 to be read. We used to raise a real alarm, but it seems
9186 that the handler isn't always enabled here. This is
9187 probably a bug. */
9188 if (input_polling_used ())
9190 /* It could be confusing if a real alarm arrives while
9191 processing the fake one. Turn it off and let the
9192 handler reset it. */
9193 int old_poll_suppress_count = poll_suppress_count;
9194 poll_suppress_count = 1;
9195 poll_for_input_1 ();
9196 poll_suppress_count = old_poll_suppress_count;
9199 /* See if a MapNotify event has been processed. */
9200 FRAME_SAMPLE_VISIBILITY (f);
9203 /* 2000-09-28: In
9205 (let ((f (selected-frame)))
9206 (iconify-frame f)
9207 (raise-frame f))
9209 the frame is not raised with various window managers on
9210 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9211 unknown reason, the call to XtMapWidget is completely ignored.
9212 Mapping the widget a second time works. */
9214 if (!FRAME_VISIBLE_P (f) && --retry_count != 0)
9215 goto retry;
9219 /* Change from mapped state to withdrawn state. */
9221 /* Make the frame visible (mapped and not iconified). */
9223 void
9224 x_make_frame_invisible (struct frame *f)
9226 Window window;
9228 /* Use the frame's outermost window, not the one we normally draw on. */
9229 window = FRAME_OUTER_WINDOW (f);
9231 /* Don't keep the highlight on an invisible frame. */
9232 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9233 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9235 block_input ();
9237 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9238 that the current position of the window is user-specified, rather than
9239 program-specified, so that when the window is mapped again, it will be
9240 placed at the same location, without forcing the user to position it
9241 by hand again (they have already done that once for this window.) */
9242 x_wm_set_size_hint (f, (long) 0, 1);
9244 #ifdef USE_GTK
9245 if (FRAME_GTK_OUTER_WIDGET (f))
9246 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9247 else
9248 #else
9249 if (FRAME_X_EMBEDDED_P (f))
9250 xembed_set_info (f, 0);
9251 else
9252 #endif
9255 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9256 DefaultScreen (FRAME_X_DISPLAY (f))))
9258 unblock_input ();
9259 error ("Can't notify window manager of window withdrawal");
9263 /* We can't distinguish this from iconification
9264 just by the event that we get from the server.
9265 So we can't win using the usual strategy of letting
9266 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9267 and synchronize with the server to make sure we agree. */
9268 f->visible = 0;
9269 FRAME_ICONIFIED_P (f) = 0;
9270 f->async_visible = 0;
9271 f->async_iconified = 0;
9273 x_sync (f);
9275 unblock_input ();
9278 /* Change window state from mapped to iconified. */
9280 void
9281 x_iconify_frame (struct frame *f)
9283 #ifdef USE_X_TOOLKIT
9284 int result;
9285 #endif
9286 Lisp_Object type;
9288 /* Don't keep the highlight on an invisible frame. */
9289 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9290 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9292 if (f->async_iconified)
9293 return;
9295 block_input ();
9297 FRAME_SAMPLE_VISIBILITY (f);
9299 type = x_icon_type (f);
9300 if (!NILP (type))
9301 x_bitmap_icon (f, type);
9303 #if defined (USE_GTK)
9304 if (FRAME_GTK_OUTER_WIDGET (f))
9306 if (! FRAME_VISIBLE_P (f))
9307 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9309 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9310 f->iconified = 1;
9311 f->visible = 1;
9312 f->async_iconified = 1;
9313 f->async_visible = 0;
9314 unblock_input ();
9315 return;
9317 #endif
9319 #ifdef USE_X_TOOLKIT
9321 if (! FRAME_VISIBLE_P (f))
9323 if (! EQ (Vx_no_window_manager, Qt))
9324 x_wm_set_window_state (f, IconicState);
9325 /* This was XtPopup, but that did nothing for an iconified frame. */
9326 XtMapWidget (f->output_data.x->widget);
9327 /* The server won't give us any event to indicate
9328 that an invisible frame was changed to an icon,
9329 so we have to record it here. */
9330 f->iconified = 1;
9331 f->visible = 1;
9332 f->async_iconified = 1;
9333 f->async_visible = 0;
9334 unblock_input ();
9335 return;
9338 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9339 XtWindow (f->output_data.x->widget),
9340 DefaultScreen (FRAME_X_DISPLAY (f)));
9341 unblock_input ();
9343 if (!result)
9344 error ("Can't notify window manager of iconification");
9346 f->async_iconified = 1;
9347 f->async_visible = 0;
9350 block_input ();
9351 XFlush (FRAME_X_DISPLAY (f));
9352 unblock_input ();
9353 #else /* not USE_X_TOOLKIT */
9355 /* Make sure the X server knows where the window should be positioned,
9356 in case the user deiconifies with the window manager. */
9357 if (! FRAME_VISIBLE_P (f)
9358 && ! FRAME_ICONIFIED_P (f)
9359 && ! FRAME_X_EMBEDDED_P (f))
9360 x_set_offset (f, f->left_pos, f->top_pos, 0);
9362 /* Since we don't know which revision of X we're running, we'll use both
9363 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9365 /* X11R4: send a ClientMessage to the window manager using the
9366 WM_CHANGE_STATE type. */
9368 XEvent msg;
9370 msg.xclient.window = FRAME_X_WINDOW (f);
9371 msg.xclient.type = ClientMessage;
9372 msg.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9373 msg.xclient.format = 32;
9374 msg.xclient.data.l[0] = IconicState;
9376 if (! XSendEvent (FRAME_X_DISPLAY (f),
9377 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9378 False,
9379 SubstructureRedirectMask | SubstructureNotifyMask,
9380 &msg))
9382 unblock_input ();
9383 error ("Can't notify window manager of iconification");
9387 /* X11R3: set the initial_state field of the window manager hints to
9388 IconicState. */
9389 x_wm_set_window_state (f, IconicState);
9391 if (!FRAME_VISIBLE_P (f))
9393 /* If the frame was withdrawn, before, we must map it. */
9394 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9397 f->async_iconified = 1;
9398 f->async_visible = 0;
9400 XFlush (FRAME_X_DISPLAY (f));
9401 unblock_input ();
9402 #endif /* not USE_X_TOOLKIT */
9406 /* Free X resources of frame F. */
9408 void
9409 x_free_frame_resources (struct frame *f)
9411 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9412 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9413 #ifdef USE_X_TOOLKIT
9414 Lisp_Object bar;
9415 struct scroll_bar *b;
9416 #endif
9418 block_input ();
9420 /* If a display connection is dead, don't try sending more
9421 commands to the X server. */
9422 if (dpyinfo->display)
9424 /* We must free faces before destroying windows because some
9425 font-driver (e.g. xft) access a window while finishing a
9426 face. */
9427 if (FRAME_FACE_CACHE (f))
9428 free_frame_faces (f);
9430 if (f->output_data.x->icon_desc)
9431 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9433 #ifdef USE_X_TOOLKIT
9434 /* Explicitly destroy the scroll bars of the frame. Without
9435 this, we get "BadDrawable" errors from the toolkit later on,
9436 presumably from expose events generated for the disappearing
9437 toolkit scroll bars. */
9438 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9440 b = XSCROLL_BAR (bar);
9441 x_scroll_bar_remove (b);
9443 #endif
9445 #ifdef HAVE_X_I18N
9446 if (FRAME_XIC (f))
9447 free_frame_xic (f);
9448 #endif
9450 #ifdef USE_X_TOOLKIT
9451 if (f->output_data.x->widget)
9453 XtDestroyWidget (f->output_data.x->widget);
9454 f->output_data.x->widget = NULL;
9456 /* Tooltips don't have widgets, only a simple X window, even if
9457 we are using a toolkit. */
9458 else if (FRAME_X_WINDOW (f))
9459 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9461 free_frame_menubar (f);
9462 #else /* !USE_X_TOOLKIT */
9464 #ifdef USE_GTK
9465 xg_free_frame_widgets (f);
9466 #endif /* USE_GTK */
9468 if (FRAME_X_WINDOW (f))
9469 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9470 #endif /* !USE_X_TOOLKIT */
9472 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9473 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9474 unload_color (f, f->output_data.x->cursor_pixel);
9475 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9476 unload_color (f, f->output_data.x->border_pixel);
9477 unload_color (f, f->output_data.x->mouse_pixel);
9479 if (f->output_data.x->scroll_bar_background_pixel != -1)
9480 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9481 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9482 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9483 #ifdef USE_TOOLKIT_SCROLL_BARS
9484 /* Scrollbar shadow colors. */
9485 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9486 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9487 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9488 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9489 #endif /* USE_TOOLKIT_SCROLL_BARS */
9490 if (f->output_data.x->white_relief.allocated_p)
9491 unload_color (f, f->output_data.x->white_relief.pixel);
9492 if (f->output_data.x->black_relief.allocated_p)
9493 unload_color (f, f->output_data.x->black_relief.pixel);
9495 x_free_gcs (f);
9496 XFlush (FRAME_X_DISPLAY (f));
9499 xfree (f->output_data.x->saved_menu_event);
9500 xfree (f->output_data.x);
9501 f->output_data.x = NULL;
9503 if (f == dpyinfo->x_focus_frame)
9504 dpyinfo->x_focus_frame = 0;
9505 if (f == dpyinfo->x_focus_event_frame)
9506 dpyinfo->x_focus_event_frame = 0;
9507 if (f == dpyinfo->x_highlight_frame)
9508 dpyinfo->x_highlight_frame = 0;
9510 if (f == hlinfo->mouse_face_mouse_frame)
9512 hlinfo->mouse_face_beg_row
9513 = hlinfo->mouse_face_beg_col = -1;
9514 hlinfo->mouse_face_end_row
9515 = hlinfo->mouse_face_end_col = -1;
9516 hlinfo->mouse_face_window = Qnil;
9517 hlinfo->mouse_face_deferred_gc = 0;
9518 hlinfo->mouse_face_mouse_frame = 0;
9521 unblock_input ();
9525 /* Destroy the X window of frame F. */
9527 static void
9528 x_destroy_window (struct frame *f)
9530 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9532 /* If a display connection is dead, don't try sending more
9533 commands to the X server. */
9534 if (dpyinfo->display != 0)
9535 x_free_frame_resources (f);
9537 dpyinfo->reference_count--;
9541 /* Setting window manager hints. */
9543 /* Set the normal size hints for the window manager, for frame F.
9544 FLAGS is the flags word to use--or 0 meaning preserve the flags
9545 that the window now has.
9546 If USER_POSITION, set the USPosition
9547 flag (this is useful when FLAGS is 0).
9548 The GTK version is in gtkutils.c. */
9550 #ifndef USE_GTK
9551 void
9552 x_wm_set_size_hint (struct frame *f, long flags, bool user_position)
9554 XSizeHints size_hints;
9555 Window window = FRAME_OUTER_WINDOW (f);
9557 #ifdef USE_X_TOOLKIT
9558 if (f->output_data.x->widget)
9560 widget_update_wm_size_hints (f->output_data.x->widget);
9561 return;
9563 #endif
9565 /* Setting PMaxSize caused various problems. */
9566 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9568 size_hints.x = f->left_pos;
9569 size_hints.y = f->top_pos;
9571 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9572 size_hints.width = FRAME_PIXEL_WIDTH (f);
9574 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9575 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9576 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9577 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9578 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9579 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9581 /* Calculate the base and minimum sizes. */
9583 int base_width, base_height;
9584 int min_rows = 0, min_cols = 0;
9586 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9587 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9589 check_frame_size (f, &min_rows, &min_cols);
9591 /* The window manager uses the base width hints to calculate the
9592 current number of rows and columns in the frame while
9593 resizing; min_width and min_height aren't useful for this
9594 purpose, since they might not give the dimensions for a
9595 zero-row, zero-column frame.
9597 We use the base_width and base_height members if we have
9598 them; otherwise, we set the min_width and min_height members
9599 to the size for a zero x zero frame. */
9601 size_hints.flags |= PBaseSize;
9602 size_hints.base_width = base_width;
9603 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9604 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9605 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9608 /* If we don't need the old flags, we don't need the old hint at all. */
9609 if (flags)
9611 size_hints.flags |= flags;
9612 goto no_read;
9616 XSizeHints hints; /* Sometimes I hate X Windows... */
9617 long supplied_return;
9618 int value;
9620 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9621 &supplied_return);
9623 if (flags)
9624 size_hints.flags |= flags;
9625 else
9627 if (value == 0)
9628 hints.flags = 0;
9629 if (hints.flags & PSize)
9630 size_hints.flags |= PSize;
9631 if (hints.flags & PPosition)
9632 size_hints.flags |= PPosition;
9633 if (hints.flags & USPosition)
9634 size_hints.flags |= USPosition;
9635 if (hints.flags & USSize)
9636 size_hints.flags |= USSize;
9640 no_read:
9642 #ifdef PWinGravity
9643 size_hints.win_gravity = f->win_gravity;
9644 size_hints.flags |= PWinGravity;
9646 if (user_position)
9648 size_hints.flags &= ~ PPosition;
9649 size_hints.flags |= USPosition;
9651 #endif /* PWinGravity */
9653 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9655 #endif /* not USE_GTK */
9657 /* Used for IconicState or NormalState */
9659 static void
9660 x_wm_set_window_state (struct frame *f, int state)
9662 #ifdef USE_X_TOOLKIT
9663 Arg al[1];
9665 XtSetArg (al[0], XtNinitialState, state);
9666 XtSetValues (f->output_data.x->widget, al, 1);
9667 #else /* not USE_X_TOOLKIT */
9668 Window window = FRAME_X_WINDOW (f);
9670 f->output_data.x->wm_hints.flags |= StateHint;
9671 f->output_data.x->wm_hints.initial_state = state;
9673 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9674 #endif /* not USE_X_TOOLKIT */
9677 static void
9678 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
9680 Pixmap icon_pixmap, icon_mask;
9682 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9683 Window window = FRAME_OUTER_WINDOW (f);
9684 #endif
9686 if (pixmap_id > 0)
9688 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9689 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9690 icon_mask = x_bitmap_mask (f, pixmap_id);
9691 f->output_data.x->wm_hints.icon_mask = icon_mask;
9693 else
9695 /* It seems there is no way to turn off use of an icon
9696 pixmap. */
9697 return;
9701 #ifdef USE_GTK
9703 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9704 return;
9707 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9710 Arg al[1];
9711 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9712 XtSetValues (f->output_data.x->widget, al, 1);
9713 XtSetArg (al[0], XtNiconMask, icon_mask);
9714 XtSetValues (f->output_data.x->widget, al, 1);
9717 #else /* not USE_X_TOOLKIT && not USE_GTK */
9719 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9720 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9722 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9725 void
9726 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9728 Window window = FRAME_OUTER_WINDOW (f);
9730 f->output_data.x->wm_hints.flags |= IconPositionHint;
9731 f->output_data.x->wm_hints.icon_x = icon_x;
9732 f->output_data.x->wm_hints.icon_y = icon_y;
9734 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9738 /***********************************************************************
9739 Fonts
9740 ***********************************************************************/
9742 #ifdef GLYPH_DEBUG
9744 /* Check that FONT is valid on frame F. It is if it can be found in F's
9745 font table. */
9747 static void
9748 x_check_font (struct frame *f, struct font *font)
9750 eassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9751 if (font->driver->check)
9752 eassert (font->driver->check (f, font) == 0);
9755 #endif /* GLYPH_DEBUG */
9758 /***********************************************************************
9759 Initialization
9760 ***********************************************************************/
9762 #ifdef USE_X_TOOLKIT
9763 static XrmOptionDescRec emacs_options[] = {
9764 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9765 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9767 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9768 XrmoptionSepArg, NULL},
9769 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9771 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9772 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9773 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9774 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9775 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9776 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9777 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9780 /* Whether atimer for Xt timeouts is activated or not. */
9782 static int x_timeout_atimer_activated_flag;
9784 #endif /* USE_X_TOOLKIT */
9786 static int x_initialized;
9788 /* Test whether two display-name strings agree up to the dot that separates
9789 the screen number from the server number. */
9790 static int
9791 same_x_server (const char *name1, const char *name2)
9793 int seen_colon = 0;
9794 const char *system_name = SSDATA (Vsystem_name);
9795 ptrdiff_t system_name_length = SBYTES (Vsystem_name);
9796 ptrdiff_t length_until_period = 0;
9798 while (system_name[length_until_period] != 0
9799 && system_name[length_until_period] != '.')
9800 length_until_period++;
9802 /* Treat `unix' like an empty host name. */
9803 if (! strncmp (name1, "unix:", 5))
9804 name1 += 4;
9805 if (! strncmp (name2, "unix:", 5))
9806 name2 += 4;
9807 /* Treat this host's name like an empty host name. */
9808 if (! strncmp (name1, system_name, system_name_length)
9809 && name1[system_name_length] == ':')
9810 name1 += system_name_length;
9811 if (! strncmp (name2, system_name, system_name_length)
9812 && name2[system_name_length] == ':')
9813 name2 += system_name_length;
9814 /* Treat this host's domainless name like an empty host name. */
9815 if (! strncmp (name1, system_name, length_until_period)
9816 && name1[length_until_period] == ':')
9817 name1 += length_until_period;
9818 if (! strncmp (name2, system_name, length_until_period)
9819 && name2[length_until_period] == ':')
9820 name2 += length_until_period;
9822 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9824 if (*name1 == ':')
9825 seen_colon = 1;
9826 if (seen_colon && *name1 == '.')
9827 return 1;
9829 return (seen_colon
9830 && (*name1 == '.' || *name1 == '\0')
9831 && (*name2 == '.' || *name2 == '\0'));
9834 /* Count number of set bits in mask and number of bits to shift to
9835 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9836 to 5. */
9837 static void
9838 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9840 int nr = 0;
9841 int off = 0;
9843 while (!(mask & 1))
9845 off++;
9846 mask >>= 1;
9849 while (mask & 1)
9851 nr++;
9852 mask >>= 1;
9855 *offset = off;
9856 *bits = nr;
9859 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9860 But don't permanently open it, just test its availability. */
9863 x_display_ok (const char *display)
9865 int dpy_ok = 1;
9866 Display *dpy;
9868 dpy = XOpenDisplay (display);
9869 if (dpy)
9870 XCloseDisplay (dpy);
9871 else
9872 dpy_ok = 0;
9873 return dpy_ok;
9876 #ifdef USE_GTK
9877 static void
9878 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
9879 const gchar *msg, gpointer user_data)
9881 if (!strstr (msg, "g_set_prgname"))
9882 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
9884 #endif
9886 /* Open a connection to X display DISPLAY_NAME, and return
9887 the structure that describes the open display.
9888 If we cannot contact the display, return null. */
9890 struct x_display_info *
9891 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9893 int connection;
9894 Display *dpy;
9895 struct terminal *terminal;
9896 struct x_display_info *dpyinfo;
9897 XrmDatabase xrdb;
9898 Mouse_HLInfo *hlinfo;
9899 ptrdiff_t lim;
9901 block_input ();
9903 if (!x_initialized)
9905 x_initialize ();
9906 ++x_initialized;
9909 if (! x_display_ok (SSDATA (display_name)))
9910 error ("Display %s can't be opened", SSDATA (display_name));
9912 #ifdef USE_GTK
9914 #define NUM_ARGV 10
9915 int argc;
9916 char *argv[NUM_ARGV];
9917 char **argv2 = argv;
9918 guint id;
9920 if (x_initialized++ > 1)
9922 xg_display_open (SSDATA (display_name), &dpy);
9924 else
9926 static char display_opt[] = "--display";
9927 static char name_opt[] = "--name";
9929 for (argc = 0; argc < NUM_ARGV; ++argc)
9930 argv[argc] = 0;
9932 argc = 0;
9933 argv[argc++] = initial_argv[0];
9935 if (! NILP (display_name))
9937 argv[argc++] = display_opt;
9938 argv[argc++] = SSDATA (display_name);
9941 argv[argc++] = name_opt;
9942 argv[argc++] = resource_name;
9944 XSetLocaleModifiers ("");
9946 /* Emacs can only handle core input events, so make sure
9947 Gtk doesn't use Xinput or Xinput2 extensions. */
9949 static char fix_events[] = "GDK_CORE_DEVICE_EVENTS=1";
9950 putenv (fix_events);
9953 /* Work around GLib bug that outputs a faulty warning. See
9954 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9955 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9956 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9958 /* NULL window -> events for all windows go to our function.
9959 Call before gtk_init so Gtk+ event filters comes after our. */
9960 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9962 /* gtk_init does set_locale. Fix locale before and after. */
9963 fixup_locale ();
9964 gtk_init (&argc, &argv2);
9965 fixup_locale ();
9967 g_log_remove_handler ("GLib", id);
9969 xg_initialize ();
9971 dpy = DEFAULT_GDK_DISPLAY ();
9973 #if GTK_MAJOR_VERSION <= 2 && GTK_MINOR_VERSION <= 90
9974 /* Load our own gtkrc if it exists. */
9976 const char *file = "~/.emacs.d/gtkrc";
9977 Lisp_Object s, abs_file;
9979 s = build_string (file);
9980 abs_file = Fexpand_file_name (s, Qnil);
9982 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9983 gtk_rc_parse (SSDATA (abs_file));
9985 #endif
9987 XSetErrorHandler (x_error_handler);
9988 XSetIOErrorHandler (x_io_error_quitter);
9991 #else /* not USE_GTK */
9992 #ifdef USE_X_TOOLKIT
9993 /* weiner@footloose.sps.mot.com reports that this causes
9994 errors with X11R5:
9995 X protocol error: BadAtom (invalid Atom parameter)
9996 on protocol request 18skiloaf.
9997 So let's not use it until R6. */
9998 #ifdef HAVE_X11XTR6
9999 XtSetLanguageProc (NULL, NULL, NULL);
10000 #endif
10003 int argc = 0;
10004 char *argv[3];
10006 argv[0] = "";
10007 argc = 1;
10008 if (xrm_option)
10010 argv[argc++] = "-xrm";
10011 argv[argc++] = xrm_option;
10013 turn_on_atimers (0);
10014 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
10015 resource_name, EMACS_CLASS,
10016 emacs_options, XtNumber (emacs_options),
10017 &argc, argv);
10018 turn_on_atimers (1);
10020 #ifdef HAVE_X11XTR6
10021 /* I think this is to compensate for XtSetLanguageProc. */
10022 fixup_locale ();
10023 #endif
10026 #else /* not USE_X_TOOLKIT */
10027 XSetLocaleModifiers ("");
10028 dpy = XOpenDisplay (SSDATA (display_name));
10029 #endif /* not USE_X_TOOLKIT */
10030 #endif /* not USE_GTK*/
10032 /* Detect failure. */
10033 if (dpy == 0)
10035 unblock_input ();
10036 return 0;
10039 /* We have definitely succeeded. Record the new connection. */
10041 dpyinfo = xzalloc (sizeof *dpyinfo);
10042 hlinfo = &dpyinfo->mouse_highlight;
10044 terminal = x_create_terminal (dpyinfo);
10047 struct x_display_info *share;
10048 Lisp_Object tail;
10050 for (share = x_display_list, tail = x_display_name_list; share;
10051 share = share->next, tail = XCDR (tail))
10052 if (same_x_server (SSDATA (XCAR (XCAR (tail))),
10053 SSDATA (display_name)))
10054 break;
10055 if (share)
10056 terminal->kboard = share->terminal->kboard;
10057 else
10059 terminal->kboard = xmalloc (sizeof *terminal->kboard);
10060 init_kboard (terminal->kboard);
10061 kset_window_system (terminal->kboard, Qx);
10063 /* Add the keyboard to the list before running Lisp code (via
10064 Qvendor_specific_keysyms below), since these are not traced
10065 via terminals but only through all_kboards. */
10066 terminal->kboard->next_kboard = all_kboards;
10067 all_kboards = terminal->kboard;
10069 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10071 char *vendor = ServerVendor (dpy);
10073 /* Protect terminal from GC before removing it from the
10074 list of terminals. */
10075 struct gcpro gcpro1;
10076 Lisp_Object gcpro_term;
10077 XSETTERMINAL (gcpro_term, terminal);
10078 GCPRO1 (gcpro_term);
10080 /* Temporarily hide the partially initialized terminal. */
10081 terminal_list = terminal->next_terminal;
10082 unblock_input ();
10083 kset_system_key_alist
10084 (terminal->kboard,
10085 call1 (Qvendor_specific_keysyms,
10086 vendor ? build_string (vendor) : empty_unibyte_string));
10087 block_input ();
10088 terminal->next_terminal = terminal_list;
10089 terminal_list = terminal;
10090 UNGCPRO;
10093 /* Don't let the initial kboard remain current longer than necessary.
10094 That would cause problems if a file loaded on startup tries to
10095 prompt in the mini-buffer. */
10096 if (current_kboard == initial_kboard)
10097 current_kboard = terminal->kboard;
10099 terminal->kboard->reference_count++;
10102 /* Put this display on the chain. */
10103 dpyinfo->next = x_display_list;
10104 x_display_list = dpyinfo;
10106 /* Put it on x_display_name_list as well, to keep them parallel. */
10107 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10108 x_display_name_list);
10109 dpyinfo->name_list_element = XCAR (x_display_name_list);
10111 dpyinfo->display = dpy;
10113 /* Set the name of the terminal. */
10114 terminal->name = xmalloc (SBYTES (display_name) + 1);
10115 memcpy (terminal->name, SSDATA (display_name), SBYTES (display_name));
10116 terminal->name[SBYTES (display_name)] = 0;
10118 #if 0
10119 XSetAfterFunction (x_current_display, x_trace_wire);
10120 #endif /* ! 0 */
10122 lim = min (PTRDIFF_MAX, SIZE_MAX) - sizeof "@";
10123 if (lim - SBYTES (Vinvocation_name) < SBYTES (Vsystem_name))
10124 memory_full (SIZE_MAX);
10125 dpyinfo->x_id_name = xmalloc (SBYTES (Vinvocation_name)
10126 + SBYTES (Vsystem_name) + 2);
10127 strcat (strcat (strcpy (dpyinfo->x_id_name, SSDATA (Vinvocation_name)), "@"),
10128 SSDATA (Vsystem_name));
10130 /* Figure out which modifier bits mean what. */
10131 x_find_modifier_meanings (dpyinfo);
10133 /* Get the scroll bar cursor. */
10134 #ifdef USE_GTK
10135 /* We must create a GTK cursor, it is required for GTK widgets. */
10136 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10137 #endif /* USE_GTK */
10139 dpyinfo->vertical_scroll_bar_cursor
10140 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10142 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10143 resource_name, EMACS_CLASS);
10144 #ifdef HAVE_XRMSETDATABASE
10145 XrmSetDatabase (dpyinfo->display, xrdb);
10146 #else
10147 dpyinfo->display->db = xrdb;
10148 #endif
10149 /* Put the rdb where we can find it in a way that works on
10150 all versions. */
10151 dpyinfo->xrdb = xrdb;
10153 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10154 DefaultScreen (dpyinfo->display));
10155 select_visual (dpyinfo);
10156 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10157 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10158 dpyinfo->client_leader_window = 0;
10159 dpyinfo->grabbed = 0;
10160 dpyinfo->reference_count = 0;
10161 dpyinfo->icon_bitmap_id = -1;
10162 dpyinfo->n_fonts = 0;
10163 dpyinfo->bitmaps = 0;
10164 dpyinfo->bitmaps_size = 0;
10165 dpyinfo->bitmaps_last = 0;
10166 dpyinfo->scratch_cursor_gc = 0;
10167 hlinfo->mouse_face_mouse_frame = 0;
10168 hlinfo->mouse_face_deferred_gc = 0;
10169 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10170 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10171 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10172 hlinfo->mouse_face_window = Qnil;
10173 hlinfo->mouse_face_overlay = Qnil;
10174 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10175 hlinfo->mouse_face_defer = 0;
10176 hlinfo->mouse_face_hidden = 0;
10177 dpyinfo->x_focus_frame = 0;
10178 dpyinfo->x_focus_event_frame = 0;
10179 dpyinfo->x_highlight_frame = 0;
10180 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10182 /* See if we can construct pixel values from RGB values. */
10183 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10184 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10186 if (dpyinfo->visual->class == TrueColor)
10188 get_bits_and_offset (dpyinfo->visual->red_mask,
10189 &dpyinfo->red_bits, &dpyinfo->red_offset);
10190 get_bits_and_offset (dpyinfo->visual->blue_mask,
10191 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10192 get_bits_and_offset (dpyinfo->visual->green_mask,
10193 &dpyinfo->green_bits, &dpyinfo->green_offset);
10196 /* See if a private colormap is requested. */
10197 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10199 if (dpyinfo->visual->class == PseudoColor)
10201 Lisp_Object value;
10202 value = display_x_get_resource (dpyinfo,
10203 build_string ("privateColormap"),
10204 build_string ("PrivateColormap"),
10205 Qnil, Qnil);
10206 if (STRINGP (value)
10207 && (!strcmp (SSDATA (value), "true")
10208 || !strcmp (SSDATA (value), "on")))
10209 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10212 else
10213 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10214 dpyinfo->visual, AllocNone);
10216 #ifdef HAVE_XFT
10218 /* If we are using Xft, check dpi value in X resources.
10219 It is better we use it as well, since Xft will use it, as will all
10220 Gnome applications. If our real DPI is smaller or larger than the
10221 one Xft uses, our font will look smaller or larger than other
10222 for other applications, even if it is the same font name (monospace-10
10223 for example). */
10224 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10225 double d;
10226 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10227 dpyinfo->resy = dpyinfo->resx = d;
10229 #endif
10231 if (dpyinfo->resy < 1)
10233 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10234 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10235 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10236 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10237 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10238 pixels = DisplayWidth (dpyinfo->display, screen_number);
10239 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10240 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10241 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10245 const struct
10247 const char *name;
10248 Atom *atom;
10249 } atom_refs[] = {
10250 { "WM_PROTOCOLS", &dpyinfo->Xatom_wm_protocols },
10251 { "WM_TAKE_FOCUS", &dpyinfo->Xatom_wm_take_focus },
10252 { "WM_SAVE_YOURSELF", &dpyinfo->Xatom_wm_save_yourself },
10253 { "WM_DELETE_WINDOW", &dpyinfo->Xatom_wm_delete_window },
10254 { "WM_CHANGE_STATE", &dpyinfo->Xatom_wm_change_state },
10255 { "WM_CONFIGURE_DENIED", &dpyinfo->Xatom_wm_configure_denied },
10256 { "WM_MOVED", &dpyinfo->Xatom_wm_window_moved },
10257 { "WM_CLIENT_LEADER", &dpyinfo->Xatom_wm_client_leader },
10258 { "Editres", &dpyinfo->Xatom_editres },
10259 { "CLIPBOARD", &dpyinfo->Xatom_CLIPBOARD },
10260 { "TIMESTAMP", &dpyinfo->Xatom_TIMESTAMP },
10261 { "TEXT", &dpyinfo->Xatom_TEXT },
10262 { "COMPOUND_TEXT", &dpyinfo->Xatom_COMPOUND_TEXT },
10263 { "UTF8_STRING", &dpyinfo->Xatom_UTF8_STRING },
10264 { "DELETE", &dpyinfo->Xatom_DELETE },
10265 { "MULTIPLE", &dpyinfo->Xatom_MULTIPLE },
10266 { "INCR", &dpyinfo->Xatom_INCR },
10267 { "_EMACS_TMP_", &dpyinfo->Xatom_EMACS_TMP },
10268 { "TARGETS", &dpyinfo->Xatom_TARGETS },
10269 { "NULL", &dpyinfo->Xatom_NULL },
10270 { "ATOM", &dpyinfo->Xatom_ATOM },
10271 { "ATOM_PAIR", &dpyinfo->Xatom_ATOM_PAIR },
10272 { "CLIPBOARD_MANAGER", &dpyinfo->Xatom_CLIPBOARD_MANAGER },
10273 { "_XEMBED_INFO", &dpyinfo->Xatom_XEMBED_INFO },
10274 /* For properties of font. */
10275 { "PIXEL_SIZE", &dpyinfo->Xatom_PIXEL_SIZE },
10276 { "AVERAGE_WIDTH", &dpyinfo->Xatom_AVERAGE_WIDTH },
10277 { "_MULE_BASELINE_OFFSET", &dpyinfo->Xatom_MULE_BASELINE_OFFSET },
10278 { "_MULE_RELATIVE_COMPOSE", &dpyinfo->Xatom_MULE_RELATIVE_COMPOSE },
10279 { "_MULE_DEFAULT_ASCENT", &dpyinfo->Xatom_MULE_DEFAULT_ASCENT },
10280 /* Ghostscript support. */
10281 { "DONE", &dpyinfo->Xatom_DONE },
10282 { "PAGE", &dpyinfo->Xatom_PAGE },
10283 { "SCROLLBAR", &dpyinfo->Xatom_Scrollbar },
10284 { "_XEMBED", &dpyinfo->Xatom_XEMBED },
10285 /* EWMH */
10286 { "_NET_WM_STATE", &dpyinfo->Xatom_net_wm_state },
10287 { "_NET_WM_STATE_FULLSCREEN", &dpyinfo->Xatom_net_wm_state_fullscreen },
10288 { "_NET_WM_STATE_MAXIMIZED_HORZ",
10289 &dpyinfo->Xatom_net_wm_state_maximized_horz },
10290 { "_NET_WM_STATE_MAXIMIZED_VERT",
10291 &dpyinfo->Xatom_net_wm_state_maximized_vert },
10292 { "_NET_WM_STATE_STICKY", &dpyinfo->Xatom_net_wm_state_sticky },
10293 { "_NET_WM_STATE_HIDDEN", &dpyinfo->Xatom_net_wm_state_hidden },
10294 { "_NET_WM_WINDOW_TYPE", &dpyinfo->Xatom_net_window_type },
10295 { "_NET_WM_WINDOW_TYPE_TOOLTIP",
10296 &dpyinfo->Xatom_net_window_type_tooltip },
10297 { "_NET_WM_ICON_NAME", &dpyinfo->Xatom_net_wm_icon_name },
10298 { "_NET_WM_NAME", &dpyinfo->Xatom_net_wm_name },
10299 { "_NET_SUPPORTED", &dpyinfo->Xatom_net_supported },
10300 { "_NET_SUPPORTING_WM_CHECK", &dpyinfo->Xatom_net_supporting_wm_check },
10301 { "_NET_WM_WINDOW_OPACITY", &dpyinfo->Xatom_net_wm_window_opacity },
10302 { "_NET_ACTIVE_WINDOW", &dpyinfo->Xatom_net_active_window },
10303 { "_NET_FRAME_EXTENTS", &dpyinfo->Xatom_net_frame_extents },
10304 /* Session management */
10305 { "SM_CLIENT_ID", &dpyinfo->Xatom_SM_CLIENT_ID },
10306 { "_XSETTINGS_SETTINGS", &dpyinfo->Xatom_xsettings_prop },
10307 { "MANAGER", &dpyinfo->Xatom_xsettings_mgr },
10310 int i;
10311 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10312 /* 1 for _XSETTINGS_SN */
10313 const int total_atom_count = 1 + atom_count;
10314 Atom *atoms_return = xmalloc (total_atom_count * sizeof *atoms_return);
10315 char **atom_names = xmalloc (total_atom_count * sizeof *atom_names);
10316 static char const xsettings_fmt[] = "_XSETTINGS_S%d";
10317 char xsettings_atom_name[sizeof xsettings_fmt - 2
10318 + INT_STRLEN_BOUND (int)];
10320 for (i = 0; i < atom_count; i++)
10321 atom_names[i] = (char *) atom_refs[i].name;
10323 /* Build _XSETTINGS_SN atom name */
10324 sprintf (xsettings_atom_name, xsettings_fmt,
10325 XScreenNumberOfScreen (dpyinfo->screen));
10326 atom_names[i] = xsettings_atom_name;
10328 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10329 False, atoms_return);
10331 for (i = 0; i < atom_count; i++)
10332 *atom_refs[i].atom = atoms_return[i];
10334 /* Manual copy of last atom */
10335 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10337 xfree (atom_names);
10338 xfree (atoms_return);
10341 dpyinfo->x_dnd_atoms_size = 8;
10342 dpyinfo->x_dnd_atoms_length = 0;
10343 dpyinfo->x_dnd_atoms = xmalloc (sizeof *dpyinfo->x_dnd_atoms
10344 * dpyinfo->x_dnd_atoms_size);
10346 dpyinfo->net_supported_atoms = NULL;
10347 dpyinfo->nr_net_supported_atoms = 0;
10348 dpyinfo->net_supported_window = 0;
10350 connection = ConnectionNumber (dpyinfo->display);
10351 dpyinfo->connection = connection;
10352 dpyinfo->gray
10353 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10354 gray_bits, gray_width, gray_height,
10355 1, 0, 1);
10357 #ifdef HAVE_X_I18N
10358 xim_initialize (dpyinfo, resource_name);
10359 #endif
10361 xsettings_initialize (dpyinfo);
10363 /* This is only needed for distinguishing keyboard and process input. */
10364 if (connection != 0)
10365 add_keyboard_wait_descriptor (connection);
10367 #ifdef F_SETOWN
10368 fcntl (connection, F_SETOWN, getpid ());
10369 #endif /* ! defined (F_SETOWN) */
10371 if (interrupt_input)
10372 init_sigio (connection);
10374 #ifdef USE_LUCID
10376 XrmValue d, fr, to;
10377 Font font;
10379 dpy = dpyinfo->display;
10380 d.addr = (XPointer)&dpy;
10381 d.size = sizeof (Display *);
10382 fr.addr = XtDefaultFont;
10383 fr.size = sizeof (XtDefaultFont);
10384 to.size = sizeof (Font *);
10385 to.addr = (XPointer)&font;
10386 x_catch_errors (dpy);
10387 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10388 emacs_abort ();
10389 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10390 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10391 x_uncatch_errors ();
10393 #endif
10395 /* See if we should run in synchronous mode. This is useful
10396 for debugging X code. */
10398 Lisp_Object value;
10399 value = display_x_get_resource (dpyinfo,
10400 build_string ("synchronous"),
10401 build_string ("Synchronous"),
10402 Qnil, Qnil);
10403 if (STRINGP (value)
10404 && (!strcmp (SSDATA (value), "true")
10405 || !strcmp (SSDATA (value), "on")))
10406 XSynchronize (dpyinfo->display, True);
10410 Lisp_Object value;
10411 value = display_x_get_resource (dpyinfo,
10412 build_string ("useXIM"),
10413 build_string ("UseXIM"),
10414 Qnil, Qnil);
10415 #ifdef USE_XIM
10416 if (STRINGP (value)
10417 && (!strcmp (SSDATA (value), "false")
10418 || !strcmp (SSDATA (value), "off")))
10419 use_xim = 0;
10420 #else
10421 if (STRINGP (value)
10422 && (!strcmp (SSDATA (value), "true")
10423 || !strcmp (SSDATA (value), "on")))
10424 use_xim = 1;
10425 #endif
10428 #ifdef HAVE_X_SM
10429 /* Only do this for the very first display in the Emacs session.
10430 Ignore X session management when Emacs was first started on a
10431 tty. */
10432 if (terminal->id == 1)
10433 x_session_initialize (dpyinfo);
10434 #endif
10436 unblock_input ();
10438 return dpyinfo;
10441 /* Get rid of display DPYINFO, deleting all frames on it,
10442 and without sending any more commands to the X server. */
10444 static void
10445 x_delete_display (struct x_display_info *dpyinfo)
10447 struct terminal *t;
10449 /* Close all frames and delete the generic struct terminal for this
10450 X display. */
10451 for (t = terminal_list; t; t = t->next_terminal)
10452 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10454 #ifdef HAVE_X_SM
10455 /* Close X session management when we close its display. */
10456 if (t->id == 1 && x_session_have_connection ())
10457 x_session_close ();
10458 #endif
10459 delete_terminal (t);
10460 break;
10463 delete_keyboard_wait_descriptor (dpyinfo->connection);
10465 /* Discard this display from x_display_name_list and x_display_list.
10466 We can't use Fdelq because that can quit. */
10467 if (! NILP (x_display_name_list)
10468 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10469 x_display_name_list = XCDR (x_display_name_list);
10470 else
10472 Lisp_Object tail;
10474 tail = x_display_name_list;
10475 while (CONSP (tail) && CONSP (XCDR (tail)))
10477 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10479 XSETCDR (tail, XCDR (XCDR (tail)));
10480 break;
10482 tail = XCDR (tail);
10486 if (next_noop_dpyinfo == dpyinfo)
10487 next_noop_dpyinfo = dpyinfo->next;
10489 if (x_display_list == dpyinfo)
10490 x_display_list = dpyinfo->next;
10491 else
10493 struct x_display_info *tail;
10495 for (tail = x_display_list; tail; tail = tail->next)
10496 if (tail->next == dpyinfo)
10497 tail->next = tail->next->next;
10500 xfree (dpyinfo->x_id_name);
10501 xfree (dpyinfo->x_dnd_atoms);
10502 xfree (dpyinfo->color_cells);
10503 xfree (dpyinfo);
10506 #ifdef USE_X_TOOLKIT
10508 /* Atimer callback function for TIMER. Called every 0.1s to process
10509 Xt timeouts, if needed. We must avoid calling XtAppPending as
10510 much as possible because that function does an implicit XFlush
10511 that slows us down. */
10513 static void
10514 x_process_timeouts (struct atimer *timer)
10516 block_input ();
10517 x_timeout_atimer_activated_flag = 0;
10518 if (toolkit_scroll_bar_interaction || popup_activated ())
10520 while (XtAppPending (Xt_app_con) & XtIMTimer)
10521 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10522 /* Reactivate the atimer for next time. */
10523 x_activate_timeout_atimer ();
10525 unblock_input ();
10528 /* Install an asynchronous timer that processes Xt timeout events
10529 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10530 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10531 function whenever these variables are set. This is necessary
10532 because some widget sets use timeouts internally, for example the
10533 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10534 processed, these widgets don't behave normally. */
10536 void
10537 x_activate_timeout_atimer (void)
10539 block_input ();
10540 if (!x_timeout_atimer_activated_flag)
10542 EMACS_TIME interval = make_emacs_time (0, 100 * 1000 * 1000);
10543 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10544 x_timeout_atimer_activated_flag = 1;
10546 unblock_input ();
10549 #endif /* USE_X_TOOLKIT */
10552 /* Set up use of X before we make the first connection. */
10554 static struct redisplay_interface x_redisplay_interface =
10556 x_frame_parm_handlers,
10557 x_produce_glyphs,
10558 x_write_glyphs,
10559 x_insert_glyphs,
10560 x_clear_end_of_line,
10561 x_scroll_run,
10562 x_after_update_window_line,
10563 x_update_window_begin,
10564 x_update_window_end,
10565 x_cursor_to,
10566 x_flush,
10567 #ifdef XFlush
10568 x_flush,
10569 #else
10570 0, /* flush_display_optional */
10571 #endif
10572 x_clear_window_mouse_face,
10573 x_get_glyph_overhangs,
10574 x_fix_overlapping_area,
10575 x_draw_fringe_bitmap,
10576 0, /* define_fringe_bitmap */
10577 0, /* destroy_fringe_bitmap */
10578 x_compute_glyph_string_overhangs,
10579 x_draw_glyph_string,
10580 x_define_frame_cursor,
10581 x_clear_frame_area,
10582 x_draw_window_cursor,
10583 x_draw_vertical_window_border,
10584 x_shift_glyphs_for_insert
10588 /* This function is called when the last frame on a display is deleted. */
10589 void
10590 x_delete_terminal (struct terminal *terminal)
10592 struct x_display_info *dpyinfo = terminal->display_info.x;
10594 /* Protect against recursive calls. delete_frame in
10595 delete_terminal calls us back when it deletes our last frame. */
10596 if (!terminal->name)
10597 return;
10599 block_input ();
10600 #ifdef HAVE_X_I18N
10601 /* We must close our connection to the XIM server before closing the
10602 X display. */
10603 if (dpyinfo->xim)
10604 xim_close_dpy (dpyinfo);
10605 #endif
10607 /* If called from x_connection_closed, the display may already be closed
10608 and dpyinfo->display was set to 0 to indicate that. */
10609 if (dpyinfo->display)
10611 x_destroy_all_bitmaps (dpyinfo);
10612 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10614 /* Whether or not XCloseDisplay destroys the associated resource
10615 database depends on the version of libX11. To avoid both
10616 crash and memory leak, we dissociate the database from the
10617 display and then destroy dpyinfo->xrdb ourselves.
10619 Unfortunately, the above strategy does not work in some
10620 situations due to a bug in newer versions of libX11: because
10621 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10622 dpy->db is NULL, XCloseDisplay destroys the associated
10623 database whereas it has not been created by XGetDefault
10624 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10625 don't destroy the database here in order to avoid the crash
10626 in the above situations for now, though that may cause memory
10627 leaks in other situations. */
10628 #if 0
10629 #ifdef HAVE_XRMSETDATABASE
10630 XrmSetDatabase (dpyinfo->display, NULL);
10631 #else
10632 dpyinfo->display->db = NULL;
10633 #endif
10634 /* We used to call XrmDestroyDatabase from x_delete_display, but
10635 some older versions of libX11 crash if we call it after
10636 closing all the displays. */
10637 XrmDestroyDatabase (dpyinfo->xrdb);
10638 #endif
10640 #ifdef USE_GTK
10641 xg_display_close (dpyinfo->display);
10642 #else
10643 #ifdef USE_X_TOOLKIT
10644 XtCloseDisplay (dpyinfo->display);
10645 #else
10646 XCloseDisplay (dpyinfo->display);
10647 #endif
10648 #endif /* ! USE_GTK */
10651 /* Mark as dead. */
10652 dpyinfo->display = NULL;
10653 x_delete_display (dpyinfo);
10654 unblock_input ();
10657 /* Create a struct terminal, initialize it with the X11 specific
10658 functions and make DISPLAY->TERMINAL point to it. */
10660 static struct terminal *
10661 x_create_terminal (struct x_display_info *dpyinfo)
10663 struct terminal *terminal;
10665 terminal = create_terminal ();
10667 terminal->type = output_x_window;
10668 terminal->display_info.x = dpyinfo;
10669 dpyinfo->terminal = terminal;
10671 /* kboard is initialized in x_term_init. */
10673 terminal->clear_frame_hook = x_clear_frame;
10674 terminal->ins_del_lines_hook = x_ins_del_lines;
10675 terminal->delete_glyphs_hook = x_delete_glyphs;
10676 terminal->ring_bell_hook = XTring_bell;
10677 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10678 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10679 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10680 terminal->update_begin_hook = x_update_begin;
10681 terminal->update_end_hook = x_update_end;
10682 terminal->set_terminal_window_hook = XTset_terminal_window;
10683 terminal->read_socket_hook = XTread_socket;
10684 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10685 terminal->mouse_position_hook = XTmouse_position;
10686 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10687 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10688 terminal->fullscreen_hook = XTfullscreen_hook;
10689 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10690 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10691 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10692 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10694 terminal->delete_frame_hook = x_destroy_window;
10695 terminal->delete_terminal_hook = x_delete_terminal;
10697 terminal->rif = &x_redisplay_interface;
10698 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10699 terminal->char_ins_del_ok = 1;
10700 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10701 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10702 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10703 off the bottom. */
10705 return terminal;
10708 void
10709 x_initialize (void)
10711 baud_rate = 19200;
10713 x_noop_count = 0;
10714 last_tool_bar_item = -1;
10715 any_help_event_p = 0;
10716 ignore_next_mouse_click_timeout = 0;
10718 #ifdef USE_GTK
10719 current_count = -1;
10720 #endif
10722 /* Try to use interrupt input; if we can't, then start polling. */
10723 Fset_input_interrupt_mode (Qt);
10725 #ifdef USE_X_TOOLKIT
10726 XtToolkitInitialize ();
10728 Xt_app_con = XtCreateApplicationContext ();
10730 /* Register a converter from strings to pixels, which uses
10731 Emacs' color allocation infrastructure. */
10732 XtAppSetTypeConverter (Xt_app_con,
10733 XtRString, XtRPixel, cvt_string_to_pixel,
10734 cvt_string_to_pixel_args,
10735 XtNumber (cvt_string_to_pixel_args),
10736 XtCacheByDisplay, cvt_pixel_dtor);
10738 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10739 #endif
10741 #ifdef USE_TOOLKIT_SCROLL_BARS
10742 #ifndef USE_GTK
10743 xaw3d_arrow_scroll = False;
10744 xaw3d_pick_top = True;
10745 #endif
10746 #endif
10748 pending_autoraise_frame = 0;
10749 pending_event_wait.f = 0;
10750 pending_event_wait.eventtype = 0;
10752 /* Note that there is no real way portable across R3/R4 to get the
10753 original error handler. */
10754 XSetErrorHandler (x_error_handler);
10755 XSetIOErrorHandler (x_io_error_quitter);
10759 void
10760 syms_of_xterm (void)
10762 x_error_message = NULL;
10764 staticpro (&x_display_name_list);
10765 x_display_name_list = Qnil;
10767 staticpro (&last_mouse_scroll_bar);
10768 last_mouse_scroll_bar = Qnil;
10770 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
10771 DEFSYM (Qlatin_1, "latin-1");
10773 staticpro (&last_mouse_press_frame);
10774 last_mouse_press_frame = Qnil;
10776 #ifdef USE_GTK
10777 xg_default_icon_file = build_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10778 staticpro (&xg_default_icon_file);
10780 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
10781 #endif
10783 DEFVAR_BOOL ("x-use-underline-position-properties",
10784 x_use_underline_position_properties,
10785 doc: /* Non-nil means make use of UNDERLINE_POSITION font properties.
10786 A value of nil means ignore them. If you encounter fonts with bogus
10787 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10788 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10789 to override the font's UNDERLINE_POSITION for small font display
10790 sizes. */);
10791 x_use_underline_position_properties = 1;
10793 DEFVAR_BOOL ("x-underline-at-descent-line",
10794 x_underline_at_descent_line,
10795 doc: /* Non-nil means to draw the underline at the same place as the descent line.
10796 A value of nil means to draw the underline according to the value of the
10797 variable `x-use-underline-position-properties', which is usually at the
10798 baseline level. The default value is nil. */);
10799 x_underline_at_descent_line = 0;
10801 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10802 x_mouse_click_focus_ignore_position,
10803 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10804 This variable is only used when the window manager requires that you
10805 click on a frame to select it (give it focus). In that case, a value
10806 of nil, means that the selected window and cursor position changes to
10807 reflect the mouse click position, while a non-nil value means that the
10808 selected window or cursor position is preserved. */);
10809 x_mouse_click_focus_ignore_position = 0;
10811 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10812 doc: /* Which toolkit scroll bars Emacs uses, if any.
10813 A value of nil means Emacs doesn't use toolkit scroll bars.
10814 With the X Window system, the value is a symbol describing the
10815 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10816 With MS Windows or Nextstep, the value is t. */);
10817 #ifdef USE_TOOLKIT_SCROLL_BARS
10818 #ifdef USE_MOTIF
10819 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10820 #elif defined HAVE_XAW3D
10821 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10822 #elif USE_GTK
10823 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10824 #else
10825 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10826 #endif
10827 #else
10828 Vx_toolkit_scroll_bars = Qnil;
10829 #endif
10831 staticpro (&last_mouse_motion_frame);
10832 last_mouse_motion_frame = Qnil;
10834 Qmodifier_value = intern_c_string ("modifier-value");
10835 Qalt = intern_c_string ("alt");
10836 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10837 Qhyper = intern_c_string ("hyper");
10838 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10839 Qmeta = intern_c_string ("meta");
10840 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10841 Qsuper = intern_c_string ("super");
10842 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10844 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10845 doc: /* Which keys Emacs uses for the alt modifier.
10846 This should be one of the symbols `alt', `hyper', `meta', `super'.
10847 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10848 is nil, which is the same as `alt'. */);
10849 Vx_alt_keysym = Qnil;
10851 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10852 doc: /* Which keys Emacs uses for the hyper modifier.
10853 This should be one of the symbols `alt', `hyper', `meta', `super'.
10854 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10855 default is nil, which is the same as `hyper'. */);
10856 Vx_hyper_keysym = Qnil;
10858 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10859 doc: /* Which keys Emacs uses for the meta modifier.
10860 This should be one of the symbols `alt', `hyper', `meta', `super'.
10861 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10862 default is nil, which is the same as `meta'. */);
10863 Vx_meta_keysym = Qnil;
10865 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10866 doc: /* Which keys Emacs uses for the super modifier.
10867 This should be one of the symbols `alt', `hyper', `meta', `super'.
10868 For example, `super' means use the Super_L and Super_R keysyms. The
10869 default is nil, which is the same as `super'. */);
10870 Vx_super_keysym = Qnil;
10872 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10873 doc: /* Hash table of character codes indexed by X keysym codes. */);
10874 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10875 make_float (DEFAULT_REHASH_SIZE),
10876 make_float (DEFAULT_REHASH_THRESHOLD),
10877 Qnil, Qnil, Qnil);
10880 #endif /* HAVE_X_WINDOWS */