merge from trunk
[emacs.git] / src / xterm.c
blobf0b95d585e3ec354ba244c8f6cbea860e17ffb4b
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
21 /* Xt features made by Fred Pierresteguy. */
23 #include <config.h>
24 #include <stdio.h>
26 #ifdef HAVE_X_WINDOWS
28 #include "lisp.h"
29 #include "blockinput.h"
30 #include "syssignal.h"
32 /* This may include sys/types.h, and that somehow loses
33 if this is not done before the other system files. */
34 #include "xterm.h"
35 #include <X11/cursorfont.h>
37 /* Load sys/types.h if not already loaded.
38 In some systems loading it twice is suicidal. */
39 #ifndef makedev
40 #include <sys/types.h>
41 #endif /* makedev */
43 #include <sys/ioctl.h>
45 #include "systime.h"
47 #include <fcntl.h>
48 #include <errno.h>
49 #include <sys/stat.h>
50 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
51 /* #include <sys/param.h> */
53 #include "charset.h"
54 #include "character.h"
55 #include "coding.h"
56 #include "frame.h"
57 #include "dispextern.h"
58 #include "fontset.h"
59 #include "termhooks.h"
60 #include "termopts.h"
61 #include "termchar.h"
62 #include "emacs-icon.h"
63 #include "disptab.h"
64 #include "buffer.h"
65 #include "window.h"
66 #include "keyboard.h"
67 #include "intervals.h"
68 #include "process.h"
69 #include "atimer.h"
70 #include "keymap.h"
71 #include "font.h"
72 #include "xsettings.h"
73 #include "xgselect.h"
74 #include "sysselect.h"
76 #ifdef USE_X_TOOLKIT
77 #include <X11/Shell.h>
78 #endif
80 #include <unistd.h>
82 #ifdef USE_GTK
83 #include "gtkutil.h"
84 #ifdef HAVE_GTK3
85 #include <X11/Xproto.h>
86 #endif
87 #endif
89 #ifdef USE_LUCID
90 #include "../lwlib/xlwmenu.h"
91 #endif
93 #ifdef USE_X_TOOLKIT
94 #if !defined (NO_EDITRES)
95 #define HACK_EDITRES
96 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
97 #endif /* not NO_EDITRES */
99 /* Include toolkit specific headers for the scroll bar widget. */
101 #ifdef USE_TOOLKIT_SCROLL_BARS
102 #if defined USE_MOTIF
103 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
104 #include <Xm/ScrollBar.h>
105 #else /* !USE_MOTIF i.e. use Xaw */
107 #ifdef HAVE_XAW3D
108 #include <X11/Xaw3d/Simple.h>
109 #include <X11/Xaw3d/Scrollbar.h>
110 #include <X11/Xaw3d/ThreeD.h>
111 #else /* !HAVE_XAW3D */
112 #include <X11/Xaw/Simple.h>
113 #include <X11/Xaw/Scrollbar.h>
114 #endif /* !HAVE_XAW3D */
115 #ifndef XtNpickTop
116 #define XtNpickTop "pickTop"
117 #endif /* !XtNpickTop */
118 #endif /* !USE_MOTIF */
119 #endif /* USE_TOOLKIT_SCROLL_BARS */
121 #endif /* USE_X_TOOLKIT */
123 #ifdef USE_X_TOOLKIT
124 #include "widget.h"
125 #ifndef XtNinitialState
126 #define XtNinitialState "initialState"
127 #endif
128 #endif
130 #include "bitmaps/gray.xbm"
132 #ifdef HAVE_XKB
133 #include <X11/XKBlib.h>
134 #endif
136 /* Default to using XIM if available. */
137 #ifdef USE_XIM
138 int use_xim = 1;
139 #else
140 int use_xim = 0; /* configure --without-xim */
141 #endif
145 /* Non-zero means that a HELP_EVENT has been generated since Emacs
146 start. */
148 static int any_help_event_p;
150 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
151 static Lisp_Object last_window;
153 /* This is a chain of structures for all the X displays currently in
154 use. */
156 struct x_display_info *x_display_list;
158 /* This is a list of cons cells, each of the form (NAME
159 . FONT-LIST-CACHE), one for each element of x_display_list and in
160 the same order. NAME is the name of the frame. FONT-LIST-CACHE
161 records previous values returned by x-list-fonts. */
163 Lisp_Object x_display_name_list;
165 /* This is a frame waiting to be auto-raised, within XTread_socket. */
167 static struct frame *pending_autoraise_frame;
169 /* This is a frame waiting for an event matching mask, within XTread_socket. */
171 static struct {
172 struct frame *f;
173 int eventtype;
174 } pending_event_wait;
176 #ifdef USE_X_TOOLKIT
177 /* The application context for Xt use. */
178 XtAppContext Xt_app_con;
179 static String Xt_default_resources[] = {0};
181 /* Non-zero means user is interacting with a toolkit scroll bar. */
183 static int toolkit_scroll_bar_interaction;
184 #endif /* USE_X_TOOLKIT */
186 /* Non-zero timeout value means ignore next mouse click if it arrives
187 before that timeout elapses (i.e. as part of the same sequence of
188 events resulting from clicking on a frame to select it). */
190 static unsigned long ignore_next_mouse_click_timeout;
192 /* Mouse movement.
194 Formerly, we used PointerMotionHintMask (in standard_event_mask)
195 so that we would have to call XQueryPointer after each MotionNotify
196 event to ask for another such event. However, this made mouse tracking
197 slow, and there was a bug that made it eventually stop.
199 Simply asking for MotionNotify all the time seems to work better.
201 In order to avoid asking for motion events and then throwing most
202 of them away or busy-polling the server for mouse positions, we ask
203 the server for pointer motion hints. This means that we get only
204 one event per group of mouse movements. "Groups" are delimited by
205 other kinds of events (focus changes and button clicks, for
206 example), or by XQueryPointer calls; when one of these happens, we
207 get another MotionNotify event the next time the mouse moves. This
208 is at least as efficient as getting motion events when mouse
209 tracking is on, and I suspect only negligibly worse when tracking
210 is off. */
212 /* Where the mouse was last time we reported a mouse event. */
214 static XRectangle last_mouse_glyph;
215 static FRAME_PTR last_mouse_glyph_frame;
216 static Lisp_Object last_mouse_press_frame;
218 /* The scroll bar in which the last X motion event occurred.
220 If the last X motion event occurred in a scroll bar, we set this so
221 XTmouse_position can know whether to report a scroll bar motion or
222 an ordinary motion.
224 If the last X motion event didn't occur in a scroll bar, we set
225 this to Qnil, to tell XTmouse_position to return an ordinary motion
226 event. */
228 static Lisp_Object last_mouse_scroll_bar;
230 /* This is a hack. We would really prefer that XTmouse_position would
231 return the time associated with the position it returns, but there
232 doesn't seem to be any way to wrest the time-stamp from the server
233 along with the position query. So, we just keep track of the time
234 of the last movement we received, and return that in hopes that
235 it's somewhat accurate. */
237 static Time last_mouse_movement_time;
239 /* Time for last user interaction as returned in X events. */
241 static Time last_user_time;
243 /* Incremented by XTread_socket whenever it really tries to read
244 events. */
246 static int volatile input_signal_count;
248 /* Used locally within XTread_socket. */
250 static int x_noop_count;
252 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
254 static Lisp_Object Qvendor_specific_keysyms;
255 static Lisp_Object Qlatin_1;
257 #ifdef USE_GTK
258 /* The name of the Emacs icon file. */
259 static Lisp_Object xg_default_icon_file;
261 /* Used in gtkutil.c. */
262 Lisp_Object Qx_gtk_map_stock;
263 #endif
265 /* Some functions take this as char *, not const char *. */
266 static char emacs_class[] = EMACS_CLASS;
268 enum xembed_info
270 XEMBED_MAPPED = 1 << 0
273 enum xembed_message
275 XEMBED_EMBEDDED_NOTIFY = 0,
276 XEMBED_WINDOW_ACTIVATE = 1,
277 XEMBED_WINDOW_DEACTIVATE = 2,
278 XEMBED_REQUEST_FOCUS = 3,
279 XEMBED_FOCUS_IN = 4,
280 XEMBED_FOCUS_OUT = 5,
281 XEMBED_FOCUS_NEXT = 6,
282 XEMBED_FOCUS_PREV = 7,
284 XEMBED_MODALITY_ON = 10,
285 XEMBED_MODALITY_OFF = 11,
286 XEMBED_REGISTER_ACCELERATOR = 12,
287 XEMBED_UNREGISTER_ACCELERATOR = 13,
288 XEMBED_ACTIVATE_ACCELERATOR = 14
291 /* Used in x_flush. */
293 static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
294 static void x_set_window_size_1 (struct frame *, int, int, int);
295 static void x_raise_frame (struct frame *);
296 static void x_lower_frame (struct frame *);
297 static const XColor *x_color_cells (Display *, int *);
298 static void x_update_window_end (struct window *, int, int);
300 static int x_io_error_quitter (Display *);
301 static struct terminal *x_create_terminal (struct x_display_info *);
302 void x_delete_terminal (struct terminal *);
303 static void x_update_end (struct frame *);
304 static void XTframe_up_to_date (struct frame *);
305 static void XTset_terminal_modes (struct terminal *);
306 static void XTreset_terminal_modes (struct terminal *);
307 static void x_clear_frame (struct frame *);
308 static _Noreturn void x_ins_del_lines (struct frame *, int, int);
309 static void frame_highlight (struct frame *);
310 static void frame_unhighlight (struct frame *);
311 static void x_new_focus_frame (struct x_display_info *, struct frame *);
312 static void x_focus_changed (int, int, struct x_display_info *,
313 struct frame *, struct input_event *);
314 static void x_detect_focus_change (struct x_display_info *,
315 XEvent *, struct input_event *);
316 static void XTframe_rehighlight (struct frame *);
317 static void x_frame_rehighlight (struct x_display_info *);
318 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
319 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
320 enum text_cursor_kinds);
322 static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
323 static void x_flush (struct frame *f);
324 static void x_update_begin (struct frame *);
325 static void x_update_window_begin (struct window *);
326 static void x_after_update_window_line (struct glyph_row *);
327 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
328 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
329 enum scroll_bar_part *,
330 Lisp_Object *, Lisp_Object *,
331 Time *);
332 static int x_handle_net_wm_state (struct frame *, XPropertyEvent *);
333 static void x_check_fullscreen (struct frame *);
334 static void x_check_expected_move (struct frame *, int, int);
335 static void x_sync_with_move (struct frame *, int, int, int);
336 static int handle_one_xevent (struct x_display_info *, XEvent *,
337 int *, struct input_event *);
338 #ifdef USE_GTK
339 static int x_dispatch_event (XEvent *, Display *);
340 #endif
341 /* Don't declare this _Noreturn because we want no
342 interference with debugging failing X calls. */
343 static void x_connection_closed (Display *, const char *);
344 static void x_wm_set_window_state (struct frame *, int);
345 static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
346 static void x_initialize (void);
349 /* Flush display of frame F, or of all frames if F is null. */
351 static void
352 x_flush (struct frame *f)
354 /* Don't call XFlush when it is not safe to redisplay; the X
355 connection may be broken. */
356 if (!NILP (Vinhibit_redisplay))
357 return;
359 block_input ();
360 if (f == NULL)
362 Lisp_Object rest, frame;
363 FOR_EACH_FRAME (rest, frame)
364 if (FRAME_X_P (XFRAME (frame)))
365 x_flush (XFRAME (frame));
367 else if (FRAME_X_P (f))
368 XFlush (FRAME_X_DISPLAY (f));
369 unblock_input ();
373 /* Remove calls to XFlush by defining XFlush to an empty replacement.
374 Calls to XFlush should be unnecessary because the X output buffer
375 is flushed automatically as needed by calls to XPending,
376 XNextEvent, or XWindowEvent according to the XFlush man page.
377 XTread_socket calls XPending. Removing XFlush improves
378 performance. */
380 #define XFlush(DISPLAY) (void) 0
383 /***********************************************************************
384 Debugging
385 ***********************************************************************/
387 #if 0
389 /* This is a function useful for recording debugging information about
390 the sequence of occurrences in this file. */
392 struct record
394 char *locus;
395 int type;
398 struct record event_record[100];
400 int event_record_index;
402 void
403 record_event (char *locus, int type)
405 if (event_record_index == sizeof (event_record) / sizeof (struct record))
406 event_record_index = 0;
408 event_record[event_record_index].locus = locus;
409 event_record[event_record_index].type = type;
410 event_record_index++;
413 #endif /* 0 */
417 /* Return the struct x_display_info corresponding to DPY. */
419 struct x_display_info *
420 x_display_info_for_display (Display *dpy)
422 struct x_display_info *dpyinfo;
424 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
425 if (dpyinfo->display == dpy)
426 return dpyinfo;
428 return 0;
431 static Window
432 x_find_topmost_parent (struct frame *f)
434 struct x_output *x = f->output_data.x;
435 Window win = None, wi = x->parent_desc;
436 Display *dpy = FRAME_X_DISPLAY (f);
438 while (wi != FRAME_X_DISPLAY_INFO (f)->root_window)
440 Window root;
441 Window *children;
442 unsigned int nchildren;
444 win = wi;
445 XQueryTree (dpy, win, &root, &wi, &children, &nchildren);
446 XFree (children);
449 return win;
452 #define OPAQUE 0xffffffff
454 void
455 x_set_frame_alpha (struct frame *f)
457 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
458 Display *dpy = FRAME_X_DISPLAY (f);
459 Window win = FRAME_OUTER_WINDOW (f);
460 double alpha = 1.0;
461 double alpha_min = 1.0;
462 unsigned long opac;
463 Window parent;
465 if (dpyinfo->x_highlight_frame == f)
466 alpha = f->alpha[0];
467 else
468 alpha = f->alpha[1];
470 if (FLOATP (Vframe_alpha_lower_limit))
471 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
472 else if (INTEGERP (Vframe_alpha_lower_limit))
473 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
475 if (alpha < 0.0)
476 return;
477 else if (alpha > 1.0)
478 alpha = 1.0;
479 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
480 alpha = alpha_min;
482 opac = alpha * OPAQUE;
484 x_catch_errors (dpy);
486 /* If there is a parent from the window manager, put the property there
487 also, to work around broken window managers that fail to do that.
488 Do this unconditionally as this function is called on reparent when
489 alpha has not changed on the frame. */
491 parent = x_find_topmost_parent (f);
492 if (parent != None)
493 XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
494 XA_CARDINAL, 32, PropModeReplace,
495 (unsigned char *) &opac, 1L);
497 /* return unless necessary */
499 unsigned char *data;
500 Atom actual;
501 int rc, format;
502 unsigned long n, left;
504 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
505 0L, 1L, False, XA_CARDINAL,
506 &actual, &format, &n, &left,
507 &data);
509 if (rc == Success && actual != None)
511 unsigned long value = *(unsigned long *)data;
512 XFree (data);
513 if (value == opac)
515 x_uncatch_errors ();
516 return;
521 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
522 XA_CARDINAL, 32, PropModeReplace,
523 (unsigned char *) &opac, 1L);
524 x_uncatch_errors ();
528 x_display_pixel_height (struct x_display_info *dpyinfo)
530 return HeightOfScreen (dpyinfo->screen);
534 x_display_pixel_width (struct x_display_info *dpyinfo)
536 return WidthOfScreen (dpyinfo->screen);
540 /***********************************************************************
541 Starting and ending an update
542 ***********************************************************************/
544 /* Start an update of frame F. This function is installed as a hook
545 for update_begin, i.e. it is called when update_begin is called.
546 This function is called prior to calls to x_update_window_begin for
547 each window being updated. Currently, there is nothing to do here
548 because all interesting stuff is done on a window basis. */
550 static void
551 x_update_begin (struct frame *f)
553 /* Nothing to do. */
557 /* Start update of window W. Set the global variable updated_window
558 to the window being updated and set output_cursor to the cursor
559 position of W. */
561 static void
562 x_update_window_begin (struct window *w)
564 struct frame *f = XFRAME (WINDOW_FRAME (w));
565 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
567 updated_window = w;
568 set_output_cursor (&w->cursor);
570 block_input ();
572 if (f == hlinfo->mouse_face_mouse_frame)
574 /* Don't do highlighting for mouse motion during the update. */
575 hlinfo->mouse_face_defer = 1;
577 /* If F needs to be redrawn, simply forget about any prior mouse
578 highlighting. */
579 if (FRAME_GARBAGED_P (f))
580 hlinfo->mouse_face_window = Qnil;
583 unblock_input ();
587 /* Draw a vertical window border from (x,y0) to (x,y1) */
589 static void
590 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
592 struct frame *f = XFRAME (WINDOW_FRAME (w));
593 struct face *face;
595 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
596 if (face)
597 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
598 face->foreground);
600 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
601 f->output_data.x->normal_gc, x, y0, x, y1);
604 /* End update of window W (which is equal to updated_window).
606 Draw vertical borders between horizontally adjacent windows, and
607 display W's cursor if CURSOR_ON_P is non-zero.
609 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
610 glyphs in mouse-face were overwritten. In that case we have to
611 make sure that the mouse-highlight is properly redrawn.
613 W may be a menu bar pseudo-window in case we don't have X toolkit
614 support. Such windows don't have a cursor, so don't display it
615 here. */
617 static void
618 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
620 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
622 if (!w->pseudo_window_p)
624 block_input ();
626 if (cursor_on_p)
627 display_and_set_cursor (w, 1, output_cursor.hpos,
628 output_cursor.vpos,
629 output_cursor.x, output_cursor.y);
631 if (draw_window_fringes (w, 1))
632 x_draw_vertical_border (w);
634 unblock_input ();
637 /* If a row with mouse-face was overwritten, arrange for
638 XTframe_up_to_date to redisplay the mouse highlight. */
639 if (mouse_face_overwritten_p)
641 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
642 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
643 hlinfo->mouse_face_window = Qnil;
646 updated_window = NULL;
650 /* End update of frame F. This function is installed as a hook in
651 update_end. */
653 static void
654 x_update_end (struct frame *f)
656 /* Mouse highlight may be displayed again. */
657 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
659 #ifndef XFlush
660 block_input ();
661 XFlush (FRAME_X_DISPLAY (f));
662 unblock_input ();
663 #endif
667 /* This function is called from various places in xdisp.c whenever a
668 complete update has been performed. The global variable
669 updated_window is not available here. */
671 static void
672 XTframe_up_to_date (struct frame *f)
674 if (FRAME_X_P (f))
675 FRAME_MOUSE_UPDATE (f);
679 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
680 arrow bitmaps, or clear the fringes if no bitmaps are required
681 before DESIRED_ROW is made current. The window being updated is
682 found in updated_window. This function It is called from
683 update_window_line only if it is known that there are differences
684 between bitmaps to be drawn between current row and DESIRED_ROW. */
686 static void
687 x_after_update_window_line (struct glyph_row *desired_row)
689 struct window *w = updated_window;
690 struct frame *f;
691 int width, height;
693 eassert (w);
695 if (!desired_row->mode_line_p && !w->pseudo_window_p)
696 desired_row->redraw_fringe_bitmaps_p = 1;
698 /* When a window has disappeared, make sure that no rest of
699 full-width rows stays visible in the internal border. Could
700 check here if updated_window is the leftmost/rightmost window,
701 but I guess it's not worth doing since vertically split windows
702 are almost never used, internal border is rarely set, and the
703 overhead is very small. */
704 if (windows_or_buffers_changed
705 && desired_row->full_width_p
706 && (f = XFRAME (w->frame),
707 width = FRAME_INTERNAL_BORDER_WIDTH (f),
708 width != 0)
709 && (height = desired_row->visible_height,
710 height > 0))
712 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
714 block_input ();
715 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
716 0, y, width, height, False);
717 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
718 FRAME_PIXEL_WIDTH (f) - width,
719 y, width, height, False);
720 unblock_input ();
724 static void
725 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
727 struct frame *f = XFRAME (WINDOW_FRAME (w));
728 Display *display = FRAME_X_DISPLAY (f);
729 Window window = FRAME_X_WINDOW (f);
730 GC gc = f->output_data.x->normal_gc;
731 struct face *face = p->face;
733 /* Must clip because of partially visible lines. */
734 x_clip_to_row (w, row, -1, gc);
736 if (!p->overlay_p)
738 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
740 /* In case the same realized face is used for fringes and
741 for something displayed in the text (e.g. face `region' on
742 mono-displays, the fill style may have been changed to
743 FillSolid in x_draw_glyph_string_background. */
744 if (face->stipple)
745 XSetFillStyle (display, face->gc, FillOpaqueStippled);
746 else
747 XSetForeground (display, face->gc, face->background);
749 #ifdef USE_TOOLKIT_SCROLL_BARS
750 /* If the fringe is adjacent to the left (right) scroll bar of a
751 leftmost (rightmost, respectively) window, then extend its
752 background to the gap between the fringe and the bar. */
753 if ((WINDOW_LEFTMOST_P (w)
754 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
755 || (WINDOW_RIGHTMOST_P (w)
756 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
758 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
760 if (sb_width > 0)
762 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
763 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
764 * FRAME_COLUMN_WIDTH (f));
766 if (bx < 0)
768 /* Bitmap fills the fringe. */
769 if (bar_area_x + bar_area_width == p->x)
770 bx = bar_area_x + sb_width;
771 else if (p->x + p->wd == bar_area_x)
772 bx = bar_area_x;
773 if (bx >= 0)
775 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
777 nx = bar_area_width - sb_width;
778 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
779 row->y));
780 ny = row->visible_height;
783 else
785 if (bar_area_x + bar_area_width == bx)
787 bx = bar_area_x + sb_width;
788 nx += bar_area_width - sb_width;
790 else if (bx + nx == bar_area_x)
791 nx += bar_area_width - sb_width;
795 #endif
796 if (bx >= 0 && nx > 0)
797 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
799 if (!face->stipple)
800 XSetForeground (display, face->gc, face->foreground);
803 if (p->which)
805 char *bits;
806 Pixmap pixmap, clipmask = (Pixmap) 0;
807 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
808 XGCValues gcv;
810 if (p->wd > 8)
811 bits = (char *) (p->bits + p->dh);
812 else
813 bits = (char *) p->bits + p->dh;
815 /* Draw the bitmap. I believe these small pixmaps can be cached
816 by the server. */
817 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
818 (p->cursor_p
819 ? (p->overlay_p ? face->background
820 : f->output_data.x->cursor_pixel)
821 : face->foreground),
822 face->background, depth);
824 if (p->overlay_p)
826 clipmask = XCreatePixmapFromBitmapData (display,
827 FRAME_X_DISPLAY_INFO (f)->root_window,
828 bits, p->wd, p->h,
829 1, 0, 1);
830 gcv.clip_mask = clipmask;
831 gcv.clip_x_origin = p->x;
832 gcv.clip_y_origin = p->y;
833 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
836 XCopyArea (display, pixmap, window, gc, 0, 0,
837 p->wd, p->h, p->x, p->y);
838 XFreePixmap (display, pixmap);
840 if (p->overlay_p)
842 gcv.clip_mask = (Pixmap) 0;
843 XChangeGC (display, gc, GCClipMask, &gcv);
844 XFreePixmap (display, clipmask);
848 XSetClipMask (display, gc, None);
853 /* This is called when starting Emacs and when restarting after
854 suspend. When starting Emacs, no X window is mapped. And nothing
855 must be done to Emacs's own window if it is suspended (though that
856 rarely happens). */
858 static void
859 XTset_terminal_modes (struct terminal *terminal)
863 /* This is called when exiting or suspending Emacs. Exiting will make
864 the X-windows go away, and suspending requires no action. */
866 static void
867 XTreset_terminal_modes (struct terminal *terminal)
872 /***********************************************************************
873 Glyph display
874 ***********************************************************************/
878 static void x_set_glyph_string_clipping (struct glyph_string *);
879 static void x_set_glyph_string_gc (struct glyph_string *);
880 static void x_draw_glyph_string_background (struct glyph_string *,
881 int);
882 static void x_draw_glyph_string_foreground (struct glyph_string *);
883 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
884 static void x_draw_glyph_string_box (struct glyph_string *);
885 static void x_draw_glyph_string (struct glyph_string *);
886 static _Noreturn void x_delete_glyphs (struct frame *, int);
887 static void x_compute_glyph_string_overhangs (struct glyph_string *);
888 static void x_set_cursor_gc (struct glyph_string *);
889 static void x_set_mode_line_face_gc (struct glyph_string *);
890 static void x_set_mouse_face_gc (struct glyph_string *);
891 static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
892 unsigned long *, double, int);
893 static void x_setup_relief_color (struct frame *, struct relief *,
894 double, int, unsigned long);
895 static void x_setup_relief_colors (struct glyph_string *);
896 static void x_draw_image_glyph_string (struct glyph_string *);
897 static void x_draw_image_relief (struct glyph_string *);
898 static void x_draw_image_foreground (struct glyph_string *);
899 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
900 static void x_clear_glyph_string_rect (struct glyph_string *, int,
901 int, int, int);
902 static void x_draw_relief_rect (struct frame *, int, int, int, int,
903 int, int, int, int, int, int,
904 XRectangle *);
905 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
906 int, int, int, XRectangle *);
907 static void x_scroll_bar_clear (struct frame *);
909 #ifdef GLYPH_DEBUG
910 static void x_check_font (struct frame *, struct font *);
911 #endif
914 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
915 face. */
917 static void
918 x_set_cursor_gc (struct glyph_string *s)
920 if (s->font == FRAME_FONT (s->f)
921 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
922 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
923 && !s->cmp)
924 s->gc = s->f->output_data.x->cursor_gc;
925 else
927 /* Cursor on non-default face: must merge. */
928 XGCValues xgcv;
929 unsigned long mask;
931 xgcv.background = s->f->output_data.x->cursor_pixel;
932 xgcv.foreground = s->face->background;
934 /* If the glyph would be invisible, try a different foreground. */
935 if (xgcv.foreground == xgcv.background)
936 xgcv.foreground = s->face->foreground;
937 if (xgcv.foreground == xgcv.background)
938 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
939 if (xgcv.foreground == xgcv.background)
940 xgcv.foreground = s->face->foreground;
942 /* Make sure the cursor is distinct from text in this face. */
943 if (xgcv.background == s->face->background
944 && xgcv.foreground == s->face->foreground)
946 xgcv.background = s->face->foreground;
947 xgcv.foreground = s->face->background;
950 IF_DEBUG (x_check_font (s->f, s->font));
951 xgcv.graphics_exposures = False;
952 mask = GCForeground | GCBackground | GCGraphicsExposures;
954 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
955 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
956 mask, &xgcv);
957 else
958 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
959 = XCreateGC (s->display, s->window, mask, &xgcv);
961 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
966 /* Set up S->gc of glyph string S for drawing text in mouse face. */
968 static void
969 x_set_mouse_face_gc (struct glyph_string *s)
971 int face_id;
972 struct face *face;
974 /* What face has to be used last for the mouse face? */
975 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
976 face = FACE_FROM_ID (s->f, face_id);
977 if (face == NULL)
978 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
980 if (s->first_glyph->type == CHAR_GLYPH)
981 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
982 else
983 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
984 s->face = FACE_FROM_ID (s->f, face_id);
985 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
987 if (s->font == s->face->font)
988 s->gc = s->face->gc;
989 else
991 /* Otherwise construct scratch_cursor_gc with values from FACE
992 except for FONT. */
993 XGCValues xgcv;
994 unsigned long mask;
996 xgcv.background = s->face->background;
997 xgcv.foreground = s->face->foreground;
998 xgcv.graphics_exposures = False;
999 mask = GCForeground | GCBackground | GCGraphicsExposures;
1001 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1002 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1003 mask, &xgcv);
1004 else
1005 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1006 = XCreateGC (s->display, s->window, mask, &xgcv);
1008 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1011 eassert (s->gc != 0);
1015 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1016 Faces to use in the mode line have already been computed when the
1017 matrix was built, so there isn't much to do, here. */
1019 static void
1020 x_set_mode_line_face_gc (struct glyph_string *s)
1022 s->gc = s->face->gc;
1026 /* Set S->gc of glyph string S for drawing that glyph string. Set
1027 S->stippled_p to a non-zero value if the face of S has a stipple
1028 pattern. */
1030 static void
1031 x_set_glyph_string_gc (struct glyph_string *s)
1033 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1035 if (s->hl == DRAW_NORMAL_TEXT)
1037 s->gc = s->face->gc;
1038 s->stippled_p = s->face->stipple != 0;
1040 else if (s->hl == DRAW_INVERSE_VIDEO)
1042 x_set_mode_line_face_gc (s);
1043 s->stippled_p = s->face->stipple != 0;
1045 else if (s->hl == DRAW_CURSOR)
1047 x_set_cursor_gc (s);
1048 s->stippled_p = 0;
1050 else if (s->hl == DRAW_MOUSE_FACE)
1052 x_set_mouse_face_gc (s);
1053 s->stippled_p = s->face->stipple != 0;
1055 else if (s->hl == DRAW_IMAGE_RAISED
1056 || s->hl == DRAW_IMAGE_SUNKEN)
1058 s->gc = s->face->gc;
1059 s->stippled_p = s->face->stipple != 0;
1061 else
1063 s->gc = s->face->gc;
1064 s->stippled_p = s->face->stipple != 0;
1067 /* GC must have been set. */
1068 eassert (s->gc != 0);
1072 /* Set clipping for output of glyph string S. S may be part of a mode
1073 line or menu if we don't have X toolkit support. */
1075 static void
1076 x_set_glyph_string_clipping (struct glyph_string *s)
1078 XRectangle *r = s->clip;
1079 int n = get_glyph_string_clip_rects (s, r, 2);
1081 if (n > 0)
1082 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1083 s->num_clips = n;
1087 /* Set SRC's clipping for output of glyph string DST. This is called
1088 when we are drawing DST's left_overhang or right_overhang only in
1089 the area of SRC. */
1091 static void
1092 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1094 XRectangle r;
1096 r.x = src->x;
1097 r.width = src->width;
1098 r.y = src->y;
1099 r.height = src->height;
1100 dst->clip[0] = r;
1101 dst->num_clips = 1;
1102 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1106 /* RIF:
1107 Compute left and right overhang of glyph string S. */
1109 static void
1110 x_compute_glyph_string_overhangs (struct glyph_string *s)
1112 if (s->cmp == NULL
1113 && (s->first_glyph->type == CHAR_GLYPH
1114 || s->first_glyph->type == COMPOSITE_GLYPH))
1116 struct font_metrics metrics;
1118 if (s->first_glyph->type == CHAR_GLYPH)
1120 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1121 struct font *font = s->font;
1122 int i;
1124 for (i = 0; i < s->nchars; i++)
1125 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1126 font->driver->text_extents (font, code, s->nchars, &metrics);
1128 else
1130 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1132 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1134 s->right_overhang = (metrics.rbearing > metrics.width
1135 ? metrics.rbearing - metrics.width : 0);
1136 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1138 else if (s->cmp)
1140 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1141 s->left_overhang = - s->cmp->lbearing;
1146 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1148 static void
1149 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1151 XGCValues xgcv;
1152 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1153 XSetForeground (s->display, s->gc, xgcv.background);
1154 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1155 XSetForeground (s->display, s->gc, xgcv.foreground);
1159 /* Draw the background of glyph_string S. If S->background_filled_p
1160 is non-zero don't draw it. FORCE_P non-zero means draw the
1161 background even if it wouldn't be drawn normally. This is used
1162 when a string preceding S draws into the background of S, or S
1163 contains the first component of a composition. */
1165 static void
1166 x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1168 /* Nothing to do if background has already been drawn or if it
1169 shouldn't be drawn in the first place. */
1170 if (!s->background_filled_p)
1172 int box_line_width = max (s->face->box_line_width, 0);
1174 if (s->stippled_p)
1176 /* Fill background with a stipple pattern. */
1177 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1178 XFillRectangle (s->display, s->window, s->gc, s->x,
1179 s->y + box_line_width,
1180 s->background_width,
1181 s->height - 2 * box_line_width);
1182 XSetFillStyle (s->display, s->gc, FillSolid);
1183 s->background_filled_p = 1;
1185 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1186 || s->font_not_found_p
1187 || s->extends_to_end_of_line_p
1188 || force_p)
1190 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1191 s->background_width,
1192 s->height - 2 * box_line_width);
1193 s->background_filled_p = 1;
1199 /* Draw the foreground of glyph string S. */
1201 static void
1202 x_draw_glyph_string_foreground (struct glyph_string *s)
1204 int i, x;
1206 /* If first glyph of S has a left box line, start drawing the text
1207 of S to the right of that box line. */
1208 if (s->face->box != FACE_NO_BOX
1209 && s->first_glyph->left_box_line_p)
1210 x = s->x + eabs (s->face->box_line_width);
1211 else
1212 x = s->x;
1214 /* Draw characters of S as rectangles if S's font could not be
1215 loaded. */
1216 if (s->font_not_found_p)
1218 for (i = 0; i < s->nchars; ++i)
1220 struct glyph *g = s->first_glyph + i;
1221 XDrawRectangle (s->display, s->window,
1222 s->gc, x, s->y, g->pixel_width - 1,
1223 s->height - 1);
1224 x += g->pixel_width;
1227 else
1229 struct font *font = s->font;
1230 int boff = font->baseline_offset;
1231 int y;
1233 if (font->vertical_centering)
1234 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1236 y = s->ybase - boff;
1237 if (s->for_overlaps
1238 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1239 font->driver->draw (s, 0, s->nchars, x, y, 0);
1240 else
1241 font->driver->draw (s, 0, s->nchars, x, y, 1);
1242 if (s->face->overstrike)
1243 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1247 /* Draw the foreground of composite glyph string S. */
1249 static void
1250 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1252 int i, j, x;
1253 struct font *font = s->font;
1255 /* If first glyph of S has a left box line, start drawing the text
1256 of S to the right of that box line. */
1257 if (s->face && s->face->box != FACE_NO_BOX
1258 && s->first_glyph->left_box_line_p)
1259 x = s->x + eabs (s->face->box_line_width);
1260 else
1261 x = s->x;
1263 /* S is a glyph string for a composition. S->cmp_from is the index
1264 of the first character drawn for glyphs of this composition.
1265 S->cmp_from == 0 means we are drawing the very first character of
1266 this composition. */
1268 /* Draw a rectangle for the composition if the font for the very
1269 first character of the composition could not be loaded. */
1270 if (s->font_not_found_p)
1272 if (s->cmp_from == 0)
1273 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1274 s->width - 1, s->height - 1);
1276 else if (! s->first_glyph->u.cmp.automatic)
1278 int y = s->ybase;
1280 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1281 /* TAB in a composition means display glyphs with padding
1282 space on the left or right. */
1283 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1285 int xx = x + s->cmp->offsets[j * 2];
1286 int yy = y - s->cmp->offsets[j * 2 + 1];
1288 font->driver->draw (s, j, j + 1, xx, yy, 0);
1289 if (s->face->overstrike)
1290 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1293 else
1295 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1296 Lisp_Object glyph;
1297 int y = s->ybase;
1298 int width = 0;
1300 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1302 glyph = LGSTRING_GLYPH (gstring, i);
1303 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1304 width += LGLYPH_WIDTH (glyph);
1305 else
1307 int xoff, yoff, wadjust;
1309 if (j < i)
1311 font->driver->draw (s, j, i, x, y, 0);
1312 if (s->face->overstrike)
1313 font->driver->draw (s, j, i, x + 1, y, 0);
1314 x += width;
1316 xoff = LGLYPH_XOFF (glyph);
1317 yoff = LGLYPH_YOFF (glyph);
1318 wadjust = LGLYPH_WADJUST (glyph);
1319 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1320 if (s->face->overstrike)
1321 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1322 x += wadjust;
1323 j = i + 1;
1324 width = 0;
1327 if (j < i)
1329 font->driver->draw (s, j, i, x, y, 0);
1330 if (s->face->overstrike)
1331 font->driver->draw (s, j, i, x + 1, y, 0);
1337 /* Draw the foreground of glyph string S for glyphless characters. */
1339 static void
1340 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1342 struct glyph *glyph = s->first_glyph;
1343 XChar2b char2b[8];
1344 int x, i, j;
1346 /* If first glyph of S has a left box line, start drawing the text
1347 of S to the right of that box line. */
1348 if (s->face && s->face->box != FACE_NO_BOX
1349 && s->first_glyph->left_box_line_p)
1350 x = s->x + eabs (s->face->box_line_width);
1351 else
1352 x = s->x;
1354 s->char2b = char2b;
1356 for (i = 0; i < s->nchars; i++, glyph++)
1358 char buf[7], *str = NULL;
1359 int len = glyph->u.glyphless.len;
1361 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1363 if (len > 0
1364 && CHAR_TABLE_P (Vglyphless_char_display)
1365 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1366 >= 1))
1368 Lisp_Object acronym
1369 = (! glyph->u.glyphless.for_no_font
1370 ? CHAR_TABLE_REF (Vglyphless_char_display,
1371 glyph->u.glyphless.ch)
1372 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1373 if (STRINGP (acronym))
1374 str = SSDATA (acronym);
1377 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1379 sprintf ((char *) buf, "%0*X",
1380 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1381 glyph->u.glyphless.ch);
1382 str = buf;
1385 if (str)
1387 int upper_len = (len + 1) / 2;
1388 unsigned code;
1390 /* It is assured that all LEN characters in STR is ASCII. */
1391 for (j = 0; j < len; j++)
1393 code = s->font->driver->encode_char (s->font, str[j]);
1394 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1396 s->font->driver->draw (s, 0, upper_len,
1397 x + glyph->slice.glyphless.upper_xoff,
1398 s->ybase + glyph->slice.glyphless.upper_yoff,
1400 s->font->driver->draw (s, upper_len, len,
1401 x + glyph->slice.glyphless.lower_xoff,
1402 s->ybase + glyph->slice.glyphless.lower_yoff,
1405 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1406 XDrawRectangle (s->display, s->window, s->gc,
1407 x, s->ybase - glyph->ascent,
1408 glyph->pixel_width - 1,
1409 glyph->ascent + glyph->descent - 1);
1410 x += glyph->pixel_width;
1414 #ifdef USE_X_TOOLKIT
1416 static Boolean cvt_string_to_pixel (Display *, XrmValue *, Cardinal *,
1417 XrmValue *, XrmValue *, XtPointer *);
1418 static void cvt_pixel_dtor (XtAppContext, XrmValue *, XtPointer,
1419 XrmValue *, Cardinal *);
1421 #ifdef USE_LUCID
1423 /* Return the frame on which widget WIDGET is used.. Abort if frame
1424 cannot be determined. */
1426 static struct frame *
1427 x_frame_of_widget (Widget widget)
1429 struct x_display_info *dpyinfo;
1430 Lisp_Object tail, frame;
1431 struct frame *f;
1433 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1435 /* Find the top-level shell of the widget. Note that this function
1436 can be called when the widget is not yet realized, so XtWindow
1437 (widget) == 0. That's the reason we can't simply use
1438 x_any_window_to_frame. */
1439 while (!XtIsTopLevelShell (widget))
1440 widget = XtParent (widget);
1442 /* Look for a frame with that top-level widget. Allocate the color
1443 on that frame to get the right gamma correction value. */
1444 FOR_EACH_FRAME (tail, frame)
1446 f = XFRAME (frame);
1447 if (FRAME_X_P (f)
1448 && f->output_data.nothing != 1
1449 && FRAME_X_DISPLAY_INFO (f) == dpyinfo
1450 && f->output_data.x->widget == widget)
1451 return f;
1453 emacs_abort ();
1456 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1457 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1458 If this produces the same color as PIXEL, try a color where all RGB
1459 values have DELTA added. Return the allocated color in *PIXEL.
1460 DISPLAY is the X display, CMAP is the colormap to operate on.
1461 Value is true if successful. */
1463 bool
1464 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1465 unsigned long *pixel, double factor, int delta)
1467 struct frame *f = x_frame_of_widget (widget);
1468 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1471 #endif /* USE_LUCID */
1474 /* Structure specifying which arguments should be passed by Xt to
1475 cvt_string_to_pixel. We want the widget's screen and colormap. */
1477 static XtConvertArgRec cvt_string_to_pixel_args[] =
1479 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1480 sizeof (Screen *)},
1481 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1482 sizeof (Colormap)}
1486 /* The address of this variable is returned by
1487 cvt_string_to_pixel. */
1489 static Pixel cvt_string_to_pixel_value;
1492 /* Convert a color name to a pixel color.
1494 DPY is the display we are working on.
1496 ARGS is an array of *NARGS XrmValue structures holding additional
1497 information about the widget for which the conversion takes place.
1498 The contents of this array are determined by the specification
1499 in cvt_string_to_pixel_args.
1501 FROM is a pointer to an XrmValue which points to the color name to
1502 convert. TO is an XrmValue in which to return the pixel color.
1504 CLOSURE_RET is a pointer to user-data, in which we record if
1505 we allocated the color or not.
1507 Value is True if successful, False otherwise. */
1509 static Boolean
1510 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1511 XrmValue *from, XrmValue *to,
1512 XtPointer *closure_ret)
1514 Screen *screen;
1515 Colormap cmap;
1516 Pixel pixel;
1517 String color_name;
1518 XColor color;
1520 if (*nargs != 2)
1522 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1523 "wrongParameters", "cvt_string_to_pixel",
1524 "XtToolkitError",
1525 "Screen and colormap args required", NULL, NULL);
1526 return False;
1529 screen = *(Screen **) args[0].addr;
1530 cmap = *(Colormap *) args[1].addr;
1531 color_name = (String) from->addr;
1533 if (strcmp (color_name, XtDefaultBackground) == 0)
1535 *closure_ret = (XtPointer) False;
1536 pixel = WhitePixelOfScreen (screen);
1538 else if (strcmp (color_name, XtDefaultForeground) == 0)
1540 *closure_ret = (XtPointer) False;
1541 pixel = BlackPixelOfScreen (screen);
1543 else if (XParseColor (dpy, cmap, color_name, &color)
1544 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1546 pixel = color.pixel;
1547 *closure_ret = (XtPointer) True;
1549 else
1551 String params[1];
1552 Cardinal nparams = 1;
1554 params[0] = color_name;
1555 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1556 "badValue", "cvt_string_to_pixel",
1557 "XtToolkitError", "Invalid color `%s'",
1558 params, &nparams);
1559 return False;
1562 if (to->addr != NULL)
1564 if (to->size < sizeof (Pixel))
1566 to->size = sizeof (Pixel);
1567 return False;
1570 *(Pixel *) to->addr = pixel;
1572 else
1574 cvt_string_to_pixel_value = pixel;
1575 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1578 to->size = sizeof (Pixel);
1579 return True;
1583 /* Free a pixel color which was previously allocated via
1584 cvt_string_to_pixel. This is registered as the destructor
1585 for this type of resource via XtSetTypeConverter.
1587 APP is the application context in which we work.
1589 TO is a pointer to an XrmValue holding the color to free.
1590 CLOSURE is the value we stored in CLOSURE_RET for this color
1591 in cvt_string_to_pixel.
1593 ARGS and NARGS are like for cvt_string_to_pixel. */
1595 static void
1596 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1597 Cardinal *nargs)
1599 if (*nargs != 2)
1601 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1602 "XtToolkitError",
1603 "Screen and colormap arguments required",
1604 NULL, NULL);
1606 else if (closure != NULL)
1608 /* We did allocate the pixel, so free it. */
1609 Screen *screen = *(Screen **) args[0].addr;
1610 Colormap cmap = *(Colormap *) args[1].addr;
1611 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1612 (Pixel *) to->addr, 1);
1617 #endif /* USE_X_TOOLKIT */
1620 /* Value is an array of XColor structures for the contents of the
1621 color map of display DPY. Set *NCELLS to the size of the array.
1622 Note that this probably shouldn't be called for large color maps,
1623 say a 24-bit TrueColor map. */
1625 static const XColor *
1626 x_color_cells (Display *dpy, int *ncells)
1628 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1630 if (dpyinfo->color_cells == NULL)
1632 Screen *screen = dpyinfo->screen;
1633 int ncolor_cells = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1634 int i;
1636 dpyinfo->color_cells = xnmalloc (ncolor_cells,
1637 sizeof *dpyinfo->color_cells);
1638 dpyinfo->ncolor_cells = ncolor_cells;
1640 for (i = 0; i < ncolor_cells; ++i)
1641 dpyinfo->color_cells[i].pixel = i;
1643 XQueryColors (dpy, dpyinfo->cmap,
1644 dpyinfo->color_cells, ncolor_cells);
1647 *ncells = dpyinfo->ncolor_cells;
1648 return dpyinfo->color_cells;
1652 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1653 colors in COLORS. Use cached information, if available. */
1655 void
1656 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1658 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1660 if (dpyinfo->color_cells)
1662 int i;
1663 for (i = 0; i < ncolors; ++i)
1665 unsigned long pixel = colors[i].pixel;
1666 eassert (pixel < dpyinfo->ncolor_cells);
1667 eassert (dpyinfo->color_cells[pixel].pixel == pixel);
1668 colors[i] = dpyinfo->color_cells[pixel];
1671 else
1672 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1676 /* On frame F, translate pixel color to RGB values for the color in
1677 COLOR. Use cached information, if available. */
1679 void
1680 x_query_color (struct frame *f, XColor *color)
1682 x_query_colors (f, color, 1);
1686 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1687 exact match can't be allocated, try the nearest color available.
1688 Value is true if successful. Set *COLOR to the color
1689 allocated. */
1691 static bool
1692 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1694 bool rc;
1696 rc = XAllocColor (dpy, cmap, color) != 0;
1697 if (rc == 0)
1699 /* If we got to this point, the colormap is full, so we're going
1700 to try to get the next closest color. The algorithm used is
1701 a least-squares matching, which is what X uses for closest
1702 color matching with StaticColor visuals. */
1703 int nearest, i;
1704 int max_color_delta = 255;
1705 int max_delta = 3 * max_color_delta;
1706 int nearest_delta = max_delta + 1;
1707 int ncells;
1708 const XColor *cells = x_color_cells (dpy, &ncells);
1710 for (nearest = i = 0; i < ncells; ++i)
1712 int dred = (color->red >> 8) - (cells[i].red >> 8);
1713 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
1714 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1715 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
1717 if (delta < nearest_delta)
1719 nearest = i;
1720 nearest_delta = delta;
1724 color->red = cells[nearest].red;
1725 color->green = cells[nearest].green;
1726 color->blue = cells[nearest].blue;
1727 rc = XAllocColor (dpy, cmap, color) != 0;
1729 else
1731 /* If allocation succeeded, and the allocated pixel color is not
1732 equal to a cached pixel color recorded earlier, there was a
1733 change in the colormap, so clear the color cache. */
1734 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1735 XColor *cached_color;
1737 if (dpyinfo->color_cells
1738 && (cached_color = &dpyinfo->color_cells[color->pixel],
1739 (cached_color->red != color->red
1740 || cached_color->blue != color->blue
1741 || cached_color->green != color->green)))
1743 xfree (dpyinfo->color_cells);
1744 dpyinfo->color_cells = NULL;
1745 dpyinfo->ncolor_cells = 0;
1749 #ifdef DEBUG_X_COLORS
1750 if (rc)
1751 register_color (color->pixel);
1752 #endif /* DEBUG_X_COLORS */
1754 return rc;
1758 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1759 exact match can't be allocated, try the nearest color available.
1760 Value is true if successful. Set *COLOR to the color
1761 allocated. */
1763 bool
1764 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1766 gamma_correct (f, color);
1767 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1771 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1772 It's necessary to do this instead of just using PIXEL directly to
1773 get color reference counts right. */
1775 unsigned long
1776 x_copy_color (struct frame *f, long unsigned int pixel)
1778 XColor color;
1780 color.pixel = pixel;
1781 block_input ();
1782 x_query_color (f, &color);
1783 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1784 unblock_input ();
1785 #ifdef DEBUG_X_COLORS
1786 register_color (pixel);
1787 #endif
1788 return color.pixel;
1792 /* Brightness beyond which a color won't have its highlight brightness
1793 boosted.
1795 Nominally, highlight colors for `3d' faces are calculated by
1796 brightening an object's color by a constant scale factor, but this
1797 doesn't yield good results for dark colors, so for colors who's
1798 brightness is less than this value (on a scale of 0-65535) have an
1799 use an additional additive factor.
1801 The value here is set so that the default menu-bar/mode-line color
1802 (grey75) will not have its highlights changed at all. */
1803 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1806 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1807 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1808 If this produces the same color as PIXEL, try a color where all RGB
1809 values have DELTA added. Return the allocated color in *PIXEL.
1810 DISPLAY is the X display, CMAP is the colormap to operate on.
1811 Value is non-zero if successful. */
1813 static bool
1814 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1816 XColor color, new;
1817 long bright;
1818 bool success_p;
1820 /* Get RGB color values. */
1821 color.pixel = *pixel;
1822 x_query_color (f, &color);
1824 /* Change RGB values by specified FACTOR. Avoid overflow! */
1825 eassert (factor >= 0);
1826 new.red = min (0xffff, factor * color.red);
1827 new.green = min (0xffff, factor * color.green);
1828 new.blue = min (0xffff, factor * color.blue);
1830 /* Calculate brightness of COLOR. */
1831 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1833 /* We only boost colors that are darker than
1834 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1835 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1836 /* Make an additive adjustment to NEW, because it's dark enough so
1837 that scaling by FACTOR alone isn't enough. */
1839 /* How far below the limit this color is (0 - 1, 1 being darker). */
1840 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1841 /* The additive adjustment. */
1842 int min_delta = delta * dimness * factor / 2;
1844 if (factor < 1)
1846 new.red = max (0, new.red - min_delta);
1847 new.green = max (0, new.green - min_delta);
1848 new.blue = max (0, new.blue - min_delta);
1850 else
1852 new.red = min (0xffff, min_delta + new.red);
1853 new.green = min (0xffff, min_delta + new.green);
1854 new.blue = min (0xffff, min_delta + new.blue);
1858 /* Try to allocate the color. */
1859 success_p = x_alloc_nearest_color (f, cmap, &new);
1860 if (success_p)
1862 if (new.pixel == *pixel)
1864 /* If we end up with the same color as before, try adding
1865 delta to the RGB values. */
1866 x_free_colors (f, &new.pixel, 1);
1868 new.red = min (0xffff, delta + color.red);
1869 new.green = min (0xffff, delta + color.green);
1870 new.blue = min (0xffff, delta + color.blue);
1871 success_p = x_alloc_nearest_color (f, cmap, &new);
1873 else
1874 success_p = 1;
1875 *pixel = new.pixel;
1878 return success_p;
1882 /* Set up the foreground color for drawing relief lines of glyph
1883 string S. RELIEF is a pointer to a struct relief containing the GC
1884 with which lines will be drawn. Use a color that is FACTOR or
1885 DELTA lighter or darker than the relief's background which is found
1886 in S->f->output_data.x->relief_background. If such a color cannot
1887 be allocated, use DEFAULT_PIXEL, instead. */
1889 static void
1890 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1892 XGCValues xgcv;
1893 struct x_output *di = f->output_data.x;
1894 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1895 unsigned long pixel;
1896 unsigned long background = di->relief_background;
1897 Colormap cmap = FRAME_X_COLORMAP (f);
1898 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1899 Display *dpy = FRAME_X_DISPLAY (f);
1901 xgcv.graphics_exposures = False;
1902 xgcv.line_width = 1;
1904 /* Free previously allocated color. The color cell will be reused
1905 when it has been freed as many times as it was allocated, so this
1906 doesn't affect faces using the same colors. */
1907 if (relief->gc
1908 && relief->allocated_p)
1910 x_free_colors (f, &relief->pixel, 1);
1911 relief->allocated_p = 0;
1914 /* Allocate new color. */
1915 xgcv.foreground = default_pixel;
1916 pixel = background;
1917 if (dpyinfo->n_planes != 1
1918 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1920 relief->allocated_p = 1;
1921 xgcv.foreground = relief->pixel = pixel;
1924 if (relief->gc == 0)
1926 xgcv.stipple = dpyinfo->gray;
1927 mask |= GCStipple;
1928 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1930 else
1931 XChangeGC (dpy, relief->gc, mask, &xgcv);
1935 /* Set up colors for the relief lines around glyph string S. */
1937 static void
1938 x_setup_relief_colors (struct glyph_string *s)
1940 struct x_output *di = s->f->output_data.x;
1941 unsigned long color;
1943 if (s->face->use_box_color_for_shadows_p)
1944 color = s->face->box_color;
1945 else if (s->first_glyph->type == IMAGE_GLYPH
1946 && s->img->pixmap
1947 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1948 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1949 else
1951 XGCValues xgcv;
1953 /* Get the background color of the face. */
1954 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1955 color = xgcv.background;
1958 if (di->white_relief.gc == 0
1959 || color != di->relief_background)
1961 di->relief_background = color;
1962 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1963 WHITE_PIX_DEFAULT (s->f));
1964 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1965 BLACK_PIX_DEFAULT (s->f));
1970 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
1971 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
1972 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
1973 relief. LEFT_P non-zero means draw a relief on the left side of
1974 the rectangle. RIGHT_P non-zero means draw a relief on the right
1975 side of the rectangle. CLIP_RECT is the clipping rectangle to use
1976 when drawing. */
1978 static void
1979 x_draw_relief_rect (struct frame *f,
1980 int left_x, int top_y, int right_x, int bottom_y, int width,
1981 int raised_p, int top_p, int bot_p, int left_p, int right_p,
1982 XRectangle *clip_rect)
1984 Display *dpy = FRAME_X_DISPLAY (f);
1985 Window window = FRAME_X_WINDOW (f);
1986 int i;
1987 GC gc;
1989 if (raised_p)
1990 gc = f->output_data.x->white_relief.gc;
1991 else
1992 gc = f->output_data.x->black_relief.gc;
1993 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
1995 /* This code is more complicated than it has to be, because of two
1996 minor hacks to make the boxes look nicer: (i) if width > 1, draw
1997 the outermost line using the black relief. (ii) Omit the four
1998 corner pixels. */
2000 /* Top. */
2001 if (top_p)
2003 if (width == 1)
2004 XDrawLine (dpy, window, gc,
2005 left_x + (left_p ? 1 : 0), top_y,
2006 right_x + (right_p ? 0 : 1), top_y);
2008 for (i = 1; i < width; ++i)
2009 XDrawLine (dpy, window, gc,
2010 left_x + i * left_p, top_y + i,
2011 right_x + 1 - i * right_p, top_y + i);
2014 /* Left. */
2015 if (left_p)
2017 if (width == 1)
2018 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2020 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2021 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2023 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2024 XDrawLine (dpy, window, gc,
2025 left_x + i, top_y + (i + 1) * top_p,
2026 left_x + i, bottom_y + 1 - (i + 1) * bot_p);
2029 XSetClipMask (dpy, gc, None);
2030 if (raised_p)
2031 gc = f->output_data.x->black_relief.gc;
2032 else
2033 gc = f->output_data.x->white_relief.gc;
2034 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2036 if (width > 1)
2038 /* Outermost top line. */
2039 if (top_p)
2040 XDrawLine (dpy, window, gc,
2041 left_x + (left_p ? 1 : 0), top_y,
2042 right_x + (right_p ? 0 : 1), top_y);
2044 /* Outermost left line. */
2045 if (left_p)
2046 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2049 /* Bottom. */
2050 if (bot_p)
2052 XDrawLine (dpy, window, gc,
2053 left_x + (left_p ? 1 : 0), bottom_y,
2054 right_x + (right_p ? 0 : 1), bottom_y);
2055 for (i = 1; i < width; ++i)
2056 XDrawLine (dpy, window, gc,
2057 left_x + i * left_p, bottom_y - i,
2058 right_x + 1 - i * right_p, bottom_y - i);
2061 /* Right. */
2062 if (right_p)
2064 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2065 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2066 for (i = 0; i < width; ++i)
2067 XDrawLine (dpy, window, gc,
2068 right_x - i, top_y + (i + 1) * top_p,
2069 right_x - i, bottom_y + 1 - (i + 1) * bot_p);
2072 XSetClipMask (dpy, gc, None);
2076 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2077 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2078 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2079 left side of the rectangle. RIGHT_P non-zero means draw a line
2080 on the right side of the rectangle. CLIP_RECT is the clipping
2081 rectangle to use when drawing. */
2083 static void
2084 x_draw_box_rect (struct glyph_string *s,
2085 int left_x, int top_y, int right_x, int bottom_y, int width,
2086 int left_p, int right_p, XRectangle *clip_rect)
2088 XGCValues xgcv;
2090 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2091 XSetForeground (s->display, s->gc, s->face->box_color);
2092 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2094 /* Top. */
2095 XFillRectangle (s->display, s->window, s->gc,
2096 left_x, top_y, right_x - left_x + 1, width);
2098 /* Left. */
2099 if (left_p)
2100 XFillRectangle (s->display, s->window, s->gc,
2101 left_x, top_y, width, bottom_y - top_y + 1);
2103 /* Bottom. */
2104 XFillRectangle (s->display, s->window, s->gc,
2105 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2107 /* Right. */
2108 if (right_p)
2109 XFillRectangle (s->display, s->window, s->gc,
2110 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2112 XSetForeground (s->display, s->gc, xgcv.foreground);
2113 XSetClipMask (s->display, s->gc, None);
2117 /* Draw a box around glyph string S. */
2119 static void
2120 x_draw_glyph_string_box (struct glyph_string *s)
2122 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2123 int left_p, right_p;
2124 struct glyph *last_glyph;
2125 XRectangle clip_rect;
2127 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2128 ? WINDOW_RIGHT_EDGE_X (s->w)
2129 : window_box_right (s->w, s->area));
2131 /* The glyph that may have a right box line. */
2132 last_glyph = (s->cmp || s->img
2133 ? s->first_glyph
2134 : s->first_glyph + s->nchars - 1);
2136 width = eabs (s->face->box_line_width);
2137 raised_p = s->face->box == FACE_RAISED_BOX;
2138 left_x = s->x;
2139 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2140 ? last_x - 1
2141 : min (last_x, s->x + s->background_width) - 1);
2142 top_y = s->y;
2143 bottom_y = top_y + s->height - 1;
2145 left_p = (s->first_glyph->left_box_line_p
2146 || (s->hl == DRAW_MOUSE_FACE
2147 && (s->prev == NULL
2148 || s->prev->hl != s->hl)));
2149 right_p = (last_glyph->right_box_line_p
2150 || (s->hl == DRAW_MOUSE_FACE
2151 && (s->next == NULL
2152 || s->next->hl != s->hl)));
2154 get_glyph_string_clip_rect (s, &clip_rect);
2156 if (s->face->box == FACE_SIMPLE_BOX)
2157 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2158 left_p, right_p, &clip_rect);
2159 else
2161 x_setup_relief_colors (s);
2162 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2163 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2168 /* Draw foreground of image glyph string S. */
2170 static void
2171 x_draw_image_foreground (struct glyph_string *s)
2173 int x = s->x;
2174 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2176 /* If first glyph of S has a left box line, start drawing it to the
2177 right of that line. */
2178 if (s->face->box != FACE_NO_BOX
2179 && s->first_glyph->left_box_line_p
2180 && s->slice.x == 0)
2181 x += eabs (s->face->box_line_width);
2183 /* If there is a margin around the image, adjust x- and y-position
2184 by that margin. */
2185 if (s->slice.x == 0)
2186 x += s->img->hmargin;
2187 if (s->slice.y == 0)
2188 y += s->img->vmargin;
2190 if (s->img->pixmap)
2192 if (s->img->mask)
2194 /* We can't set both a clip mask and use XSetClipRectangles
2195 because the latter also sets a clip mask. We also can't
2196 trust on the shape extension to be available
2197 (XShapeCombineRegion). So, compute the rectangle to draw
2198 manually. */
2199 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2200 | GCFunction);
2201 XGCValues xgcv;
2202 XRectangle clip_rect, image_rect, r;
2204 xgcv.clip_mask = s->img->mask;
2205 xgcv.clip_x_origin = x;
2206 xgcv.clip_y_origin = y;
2207 xgcv.function = GXcopy;
2208 XChangeGC (s->display, s->gc, mask, &xgcv);
2210 get_glyph_string_clip_rect (s, &clip_rect);
2211 image_rect.x = x;
2212 image_rect.y = y;
2213 image_rect.width = s->slice.width;
2214 image_rect.height = s->slice.height;
2215 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2216 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2217 s->slice.x + r.x - x, s->slice.y + r.y - y,
2218 r.width, r.height, r.x, r.y);
2220 else
2222 XRectangle clip_rect, image_rect, r;
2224 get_glyph_string_clip_rect (s, &clip_rect);
2225 image_rect.x = x;
2226 image_rect.y = y;
2227 image_rect.width = s->slice.width;
2228 image_rect.height = s->slice.height;
2229 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2230 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2231 s->slice.x + r.x - x, s->slice.y + r.y - y,
2232 r.width, r.height, r.x, r.y);
2234 /* When the image has a mask, we can expect that at
2235 least part of a mouse highlight or a block cursor will
2236 be visible. If the image doesn't have a mask, make
2237 a block cursor visible by drawing a rectangle around
2238 the image. I believe it's looking better if we do
2239 nothing here for mouse-face. */
2240 if (s->hl == DRAW_CURSOR)
2242 int relief = eabs (s->img->relief);
2243 XDrawRectangle (s->display, s->window, s->gc,
2244 x - relief, y - relief,
2245 s->slice.width + relief*2 - 1,
2246 s->slice.height + relief*2 - 1);
2250 else
2251 /* Draw a rectangle if image could not be loaded. */
2252 XDrawRectangle (s->display, s->window, s->gc, x, y,
2253 s->slice.width - 1, s->slice.height - 1);
2257 /* Draw a relief around the image glyph string S. */
2259 static void
2260 x_draw_image_relief (struct glyph_string *s)
2262 int x1, y1, thick, raised_p, top_p, bot_p, left_p, right_p;
2263 XRectangle r;
2264 int x = s->x;
2265 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2267 /* If first glyph of S has a left box line, start drawing it to the
2268 right of that line. */
2269 if (s->face->box != FACE_NO_BOX
2270 && s->first_glyph->left_box_line_p
2271 && s->slice.x == 0)
2272 x += eabs (s->face->box_line_width);
2274 /* If there is a margin around the image, adjust x- and y-position
2275 by that margin. */
2276 if (s->slice.x == 0)
2277 x += s->img->hmargin;
2278 if (s->slice.y == 0)
2279 y += s->img->vmargin;
2281 if (s->hl == DRAW_IMAGE_SUNKEN
2282 || s->hl == DRAW_IMAGE_RAISED)
2284 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2285 raised_p = s->hl == DRAW_IMAGE_RAISED;
2287 else
2289 thick = eabs (s->img->relief);
2290 raised_p = s->img->relief > 0;
2293 x1 = x + s->slice.width - 1;
2294 y1 = y + s->slice.height - 1;
2295 top_p = bot_p = left_p = right_p = 0;
2297 if (s->slice.x == 0)
2298 x -= thick, left_p = 1;
2299 if (s->slice.y == 0)
2300 y -= thick, top_p = 1;
2301 if (s->slice.x + s->slice.width == s->img->width)
2302 x1 += thick, right_p = 1;
2303 if (s->slice.y + s->slice.height == s->img->height)
2304 y1 += thick, bot_p = 1;
2306 x_setup_relief_colors (s);
2307 get_glyph_string_clip_rect (s, &r);
2308 x_draw_relief_rect (s->f, x, y, x1, y1, thick, raised_p,
2309 top_p, bot_p, left_p, right_p, &r);
2313 /* Draw the foreground of image glyph string S to PIXMAP. */
2315 static void
2316 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2318 int x = 0;
2319 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2321 /* If first glyph of S has a left box line, start drawing it to the
2322 right of that line. */
2323 if (s->face->box != FACE_NO_BOX
2324 && s->first_glyph->left_box_line_p
2325 && s->slice.x == 0)
2326 x += eabs (s->face->box_line_width);
2328 /* If there is a margin around the image, adjust x- and y-position
2329 by that margin. */
2330 if (s->slice.x == 0)
2331 x += s->img->hmargin;
2332 if (s->slice.y == 0)
2333 y += s->img->vmargin;
2335 if (s->img->pixmap)
2337 if (s->img->mask)
2339 /* We can't set both a clip mask and use XSetClipRectangles
2340 because the latter also sets a clip mask. We also can't
2341 trust on the shape extension to be available
2342 (XShapeCombineRegion). So, compute the rectangle to draw
2343 manually. */
2344 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2345 | GCFunction);
2346 XGCValues xgcv;
2348 xgcv.clip_mask = s->img->mask;
2349 xgcv.clip_x_origin = x - s->slice.x;
2350 xgcv.clip_y_origin = y - s->slice.y;
2351 xgcv.function = GXcopy;
2352 XChangeGC (s->display, s->gc, mask, &xgcv);
2354 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2355 s->slice.x, s->slice.y,
2356 s->slice.width, s->slice.height, x, y);
2357 XSetClipMask (s->display, s->gc, None);
2359 else
2361 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2362 s->slice.x, s->slice.y,
2363 s->slice.width, s->slice.height, x, y);
2365 /* When the image has a mask, we can expect that at
2366 least part of a mouse highlight or a block cursor will
2367 be visible. If the image doesn't have a mask, make
2368 a block cursor visible by drawing a rectangle around
2369 the image. I believe it's looking better if we do
2370 nothing here for mouse-face. */
2371 if (s->hl == DRAW_CURSOR)
2373 int r = eabs (s->img->relief);
2374 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2375 s->slice.width + r*2 - 1,
2376 s->slice.height + r*2 - 1);
2380 else
2381 /* Draw a rectangle if image could not be loaded. */
2382 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2383 s->slice.width - 1, s->slice.height - 1);
2387 /* Draw part of the background of glyph string S. X, Y, W, and H
2388 give the rectangle to draw. */
2390 static void
2391 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2393 if (s->stippled_p)
2395 /* Fill background with a stipple pattern. */
2396 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2397 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2398 XSetFillStyle (s->display, s->gc, FillSolid);
2400 else
2401 x_clear_glyph_string_rect (s, x, y, w, h);
2405 /* Draw image glyph string S.
2407 s->y
2408 s->x +-------------------------
2409 | s->face->box
2411 | +-------------------------
2412 | | s->img->margin
2414 | | +-------------------
2415 | | | the image
2419 static void
2420 x_draw_image_glyph_string (struct glyph_string *s)
2422 int box_line_hwidth = eabs (s->face->box_line_width);
2423 int box_line_vwidth = max (s->face->box_line_width, 0);
2424 int height;
2425 Pixmap pixmap = None;
2427 height = s->height;
2428 if (s->slice.y == 0)
2429 height -= box_line_vwidth;
2430 if (s->slice.y + s->slice.height >= s->img->height)
2431 height -= box_line_vwidth;
2433 /* Fill background with face under the image. Do it only if row is
2434 taller than image or if image has a clip mask to reduce
2435 flickering. */
2436 s->stippled_p = s->face->stipple != 0;
2437 if (height > s->slice.height
2438 || s->img->hmargin
2439 || s->img->vmargin
2440 || s->img->mask
2441 || s->img->pixmap == 0
2442 || s->width != s->background_width)
2444 if (s->img->mask)
2446 /* Create a pixmap as large as the glyph string. Fill it
2447 with the background color. Copy the image to it, using
2448 its mask. Copy the temporary pixmap to the display. */
2449 Screen *screen = FRAME_X_SCREEN (s->f);
2450 int depth = DefaultDepthOfScreen (screen);
2452 /* Create a pixmap as large as the glyph string. */
2453 pixmap = XCreatePixmap (s->display, s->window,
2454 s->background_width,
2455 s->height, depth);
2457 /* Don't clip in the following because we're working on the
2458 pixmap. */
2459 XSetClipMask (s->display, s->gc, None);
2461 /* Fill the pixmap with the background color/stipple. */
2462 if (s->stippled_p)
2464 /* Fill background with a stipple pattern. */
2465 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2466 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2467 XFillRectangle (s->display, pixmap, s->gc,
2468 0, 0, s->background_width, s->height);
2469 XSetFillStyle (s->display, s->gc, FillSolid);
2470 XSetTSOrigin (s->display, s->gc, 0, 0);
2472 else
2474 XGCValues xgcv;
2475 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2476 &xgcv);
2477 XSetForeground (s->display, s->gc, xgcv.background);
2478 XFillRectangle (s->display, pixmap, s->gc,
2479 0, 0, s->background_width, s->height);
2480 XSetForeground (s->display, s->gc, xgcv.foreground);
2483 else
2485 int x = s->x;
2486 int y = s->y;
2488 if (s->first_glyph->left_box_line_p
2489 && s->slice.x == 0)
2490 x += box_line_hwidth;
2492 if (s->slice.y == 0)
2493 y += box_line_vwidth;
2495 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2498 s->background_filled_p = 1;
2501 /* Draw the foreground. */
2502 if (pixmap != None)
2504 x_draw_image_foreground_1 (s, pixmap);
2505 x_set_glyph_string_clipping (s);
2506 XCopyArea (s->display, pixmap, s->window, s->gc,
2507 0, 0, s->background_width, s->height, s->x, s->y);
2508 XFreePixmap (s->display, pixmap);
2510 else
2511 x_draw_image_foreground (s);
2513 /* If we must draw a relief around the image, do it. */
2514 if (s->img->relief
2515 || s->hl == DRAW_IMAGE_RAISED
2516 || s->hl == DRAW_IMAGE_SUNKEN)
2517 x_draw_image_relief (s);
2521 /* Draw stretch glyph string S. */
2523 static void
2524 x_draw_stretch_glyph_string (struct glyph_string *s)
2526 eassert (s->first_glyph->type == STRETCH_GLYPH);
2528 if (s->hl == DRAW_CURSOR
2529 && !x_stretch_cursor_p)
2531 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2532 wide as the stretch glyph. */
2533 int width, background_width = s->background_width;
2534 int x = s->x;
2536 if (!s->row->reversed_p)
2538 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2540 if (x < left_x)
2542 background_width -= left_x - x;
2543 x = left_x;
2546 else
2548 /* In R2L rows, draw the cursor on the right edge of the
2549 stretch glyph. */
2550 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2552 if (x + background_width > right_x)
2553 background_width -= x - right_x;
2554 x += background_width;
2556 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2557 if (s->row->reversed_p)
2558 x -= width;
2560 /* Draw cursor. */
2561 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2563 /* Clear rest using the GC of the original non-cursor face. */
2564 if (width < background_width)
2566 int y = s->y;
2567 int w = background_width - width, h = s->height;
2568 XRectangle r;
2569 GC gc;
2571 if (!s->row->reversed_p)
2572 x += width;
2573 else
2574 x = s->x;
2575 if (s->row->mouse_face_p
2576 && cursor_in_mouse_face_p (s->w))
2578 x_set_mouse_face_gc (s);
2579 gc = s->gc;
2581 else
2582 gc = s->face->gc;
2584 get_glyph_string_clip_rect (s, &r);
2585 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2587 if (s->face->stipple)
2589 /* Fill background with a stipple pattern. */
2590 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2591 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2592 XSetFillStyle (s->display, gc, FillSolid);
2594 else
2596 XGCValues xgcv;
2597 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2598 XSetForeground (s->display, gc, xgcv.background);
2599 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2600 XSetForeground (s->display, gc, xgcv.foreground);
2604 else if (!s->background_filled_p)
2606 int background_width = s->background_width;
2607 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2609 /* Don't draw into left margin, fringe or scrollbar area
2610 except for header line and mode line. */
2611 if (x < left_x && !s->row->mode_line_p)
2613 background_width -= left_x - x;
2614 x = left_x;
2616 if (background_width > 0)
2617 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2620 s->background_filled_p = 1;
2624 Draw a wavy line under S. The wave fills wave_height pixels from y0.
2626 x0 wave_length = 2
2628 y0 * * * * *
2629 |* * * * * * * * *
2630 wave_height = 3 | * * * *
2634 static void
2635 x_draw_underwave (struct glyph_string *s)
2637 int wave_height = 3, wave_length = 2;
2638 int dx, dy, x0, y0, width, x1, y1, x2, y2, odd, xmax;
2639 XRectangle wave_clip, string_clip, final_clip;
2641 dx = wave_length;
2642 dy = wave_height - 1;
2643 x0 = s->x;
2644 y0 = s->ybase - wave_height + 3;
2645 width = s->width;
2646 xmax = x0 + width;
2648 /* Find and set clipping rectangle */
2650 wave_clip = (XRectangle){ x0, y0, width, wave_height };
2651 get_glyph_string_clip_rect (s, &string_clip);
2653 if (!x_intersect_rectangles (&wave_clip, &string_clip, &final_clip))
2654 return;
2656 XSetClipRectangles (s->display, s->gc, 0, 0, &final_clip, 1, Unsorted);
2658 /* Draw the waves */
2660 x1 = x0 - (x0 % dx);
2661 x2 = x1 + dx;
2662 odd = (x1/dx) % 2;
2663 y1 = y2 = y0;
2665 if (odd)
2666 y1 += dy;
2667 else
2668 y2 += dy;
2670 if (INT_MAX - dx < xmax)
2671 emacs_abort ();
2673 while (x1 <= xmax)
2675 XDrawLine (s->display, s->window, s->gc, x1, y1, x2, y2);
2676 x1 = x2, y1 = y2;
2677 x2 += dx, y2 = y0 + odd*dy;
2678 odd = !odd;
2681 /* Restore previous clipping rectangle(s) */
2682 XSetClipRectangles (s->display, s->gc, 0, 0, s->clip, s->num_clips, Unsorted);
2686 /* Draw glyph string S. */
2688 static void
2689 x_draw_glyph_string (struct glyph_string *s)
2691 int relief_drawn_p = 0;
2693 /* If S draws into the background of its successors, draw the
2694 background of the successors first so that S can draw into it.
2695 This makes S->next use XDrawString instead of XDrawImageString. */
2696 if (s->next && s->right_overhang && !s->for_overlaps)
2698 int width;
2699 struct glyph_string *next;
2701 for (width = 0, next = s->next;
2702 next && width < s->right_overhang;
2703 width += next->width, next = next->next)
2704 if (next->first_glyph->type != IMAGE_GLYPH)
2706 x_set_glyph_string_gc (next);
2707 x_set_glyph_string_clipping (next);
2708 if (next->first_glyph->type == STRETCH_GLYPH)
2709 x_draw_stretch_glyph_string (next);
2710 else
2711 x_draw_glyph_string_background (next, 1);
2712 next->num_clips = 0;
2716 /* Set up S->gc, set clipping and draw S. */
2717 x_set_glyph_string_gc (s);
2719 /* Draw relief (if any) in advance for char/composition so that the
2720 glyph string can be drawn over it. */
2721 if (!s->for_overlaps
2722 && s->face->box != FACE_NO_BOX
2723 && (s->first_glyph->type == CHAR_GLYPH
2724 || s->first_glyph->type == COMPOSITE_GLYPH))
2727 x_set_glyph_string_clipping (s);
2728 x_draw_glyph_string_background (s, 1);
2729 x_draw_glyph_string_box (s);
2730 x_set_glyph_string_clipping (s);
2731 relief_drawn_p = 1;
2733 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2734 && !s->clip_tail
2735 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2736 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2737 /* We must clip just this glyph. left_overhang part has already
2738 drawn when s->prev was drawn, and right_overhang part will be
2739 drawn later when s->next is drawn. */
2740 x_set_glyph_string_clipping_exactly (s, s);
2741 else
2742 x_set_glyph_string_clipping (s);
2744 switch (s->first_glyph->type)
2746 case IMAGE_GLYPH:
2747 x_draw_image_glyph_string (s);
2748 break;
2750 case STRETCH_GLYPH:
2751 x_draw_stretch_glyph_string (s);
2752 break;
2754 case CHAR_GLYPH:
2755 if (s->for_overlaps)
2756 s->background_filled_p = 1;
2757 else
2758 x_draw_glyph_string_background (s, 0);
2759 x_draw_glyph_string_foreground (s);
2760 break;
2762 case COMPOSITE_GLYPH:
2763 if (s->for_overlaps || (s->cmp_from > 0
2764 && ! s->first_glyph->u.cmp.automatic))
2765 s->background_filled_p = 1;
2766 else
2767 x_draw_glyph_string_background (s, 1);
2768 x_draw_composite_glyph_string_foreground (s);
2769 break;
2771 case GLYPHLESS_GLYPH:
2772 if (s->for_overlaps)
2773 s->background_filled_p = 1;
2774 else
2775 x_draw_glyph_string_background (s, 1);
2776 x_draw_glyphless_glyph_string_foreground (s);
2777 break;
2779 default:
2780 emacs_abort ();
2783 if (!s->for_overlaps)
2785 /* Draw underline. */
2786 if (s->face->underline_p)
2788 if (s->face->underline_type == FACE_UNDER_WAVE)
2790 if (s->face->underline_defaulted_p)
2791 x_draw_underwave (s);
2792 else
2794 XGCValues xgcv;
2795 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2796 XSetForeground (s->display, s->gc, s->face->underline_color);
2797 x_draw_underwave (s);
2798 XSetForeground (s->display, s->gc, xgcv.foreground);
2801 else if (s->face->underline_type == FACE_UNDER_LINE)
2803 unsigned long thickness, position;
2804 int y;
2806 if (s->prev && s->prev->face->underline_p
2807 && s->prev->face->underline_type == FACE_UNDER_LINE)
2809 /* We use the same underline style as the previous one. */
2810 thickness = s->prev->underline_thickness;
2811 position = s->prev->underline_position;
2813 else
2815 /* Get the underline thickness. Default is 1 pixel. */
2816 if (s->font && s->font->underline_thickness > 0)
2817 thickness = s->font->underline_thickness;
2818 else
2819 thickness = 1;
2820 if (x_underline_at_descent_line)
2821 position = (s->height - thickness) - (s->ybase - s->y);
2822 else
2824 /* Get the underline position. This is the recommended
2825 vertical offset in pixels from the baseline to the top of
2826 the underline. This is a signed value according to the
2827 specs, and its default is
2829 ROUND ((maximum descent) / 2), with
2830 ROUND(x) = floor (x + 0.5) */
2832 if (x_use_underline_position_properties
2833 && s->font && s->font->underline_position >= 0)
2834 position = s->font->underline_position;
2835 else if (s->font)
2836 position = (s->font->descent + 1) / 2;
2837 else
2838 position = underline_minimum_offset;
2840 position = max (position, underline_minimum_offset);
2842 /* Check the sanity of thickness and position. We should
2843 avoid drawing underline out of the current line area. */
2844 if (s->y + s->height <= s->ybase + position)
2845 position = (s->height - 1) - (s->ybase - s->y);
2846 if (s->y + s->height < s->ybase + position + thickness)
2847 thickness = (s->y + s->height) - (s->ybase + position);
2848 s->underline_thickness = thickness;
2849 s->underline_position = position;
2850 y = s->ybase + position;
2851 if (s->face->underline_defaulted_p)
2852 XFillRectangle (s->display, s->window, s->gc,
2853 s->x, y, s->width, thickness);
2854 else
2856 XGCValues xgcv;
2857 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2858 XSetForeground (s->display, s->gc, s->face->underline_color);
2859 XFillRectangle (s->display, s->window, s->gc,
2860 s->x, y, s->width, thickness);
2861 XSetForeground (s->display, s->gc, xgcv.foreground);
2865 /* Draw overline. */
2866 if (s->face->overline_p)
2868 unsigned long dy = 0, h = 1;
2870 if (s->face->overline_color_defaulted_p)
2871 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2872 s->width, h);
2873 else
2875 XGCValues xgcv;
2876 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2877 XSetForeground (s->display, s->gc, s->face->overline_color);
2878 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2879 s->width, h);
2880 XSetForeground (s->display, s->gc, xgcv.foreground);
2884 /* Draw strike-through. */
2885 if (s->face->strike_through_p)
2887 unsigned long h = 1;
2888 unsigned long dy = (s->height - h) / 2;
2890 if (s->face->strike_through_color_defaulted_p)
2891 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2892 s->width, h);
2893 else
2895 XGCValues xgcv;
2896 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2897 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2898 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2899 s->width, h);
2900 XSetForeground (s->display, s->gc, xgcv.foreground);
2904 /* Draw relief if not yet drawn. */
2905 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2906 x_draw_glyph_string_box (s);
2908 if (s->prev)
2910 struct glyph_string *prev;
2912 for (prev = s->prev; prev; prev = prev->prev)
2913 if (prev->hl != s->hl
2914 && prev->x + prev->width + prev->right_overhang > s->x)
2916 /* As prev was drawn while clipped to its own area, we
2917 must draw the right_overhang part using s->hl now. */
2918 enum draw_glyphs_face save = prev->hl;
2920 prev->hl = s->hl;
2921 x_set_glyph_string_gc (prev);
2922 x_set_glyph_string_clipping_exactly (s, prev);
2923 if (prev->first_glyph->type == CHAR_GLYPH)
2924 x_draw_glyph_string_foreground (prev);
2925 else
2926 x_draw_composite_glyph_string_foreground (prev);
2927 XSetClipMask (prev->display, prev->gc, None);
2928 prev->hl = save;
2929 prev->num_clips = 0;
2933 if (s->next)
2935 struct glyph_string *next;
2937 for (next = s->next; next; next = next->next)
2938 if (next->hl != s->hl
2939 && next->x - next->left_overhang < s->x + s->width)
2941 /* As next will be drawn while clipped to its own area,
2942 we must draw the left_overhang part using s->hl now. */
2943 enum draw_glyphs_face save = next->hl;
2945 next->hl = s->hl;
2946 x_set_glyph_string_gc (next);
2947 x_set_glyph_string_clipping_exactly (s, next);
2948 if (next->first_glyph->type == CHAR_GLYPH)
2949 x_draw_glyph_string_foreground (next);
2950 else
2951 x_draw_composite_glyph_string_foreground (next);
2952 XSetClipMask (next->display, next->gc, None);
2953 next->hl = save;
2954 next->num_clips = 0;
2955 next->clip_head = s->next;
2960 /* Reset clipping. */
2961 XSetClipMask (s->display, s->gc, None);
2962 s->num_clips = 0;
2965 /* Shift display to make room for inserted glyphs. */
2967 static void
2968 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2970 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2971 f->output_data.x->normal_gc,
2972 x, y, width, height,
2973 x + shift_by, y);
2976 /* Delete N glyphs at the nominal cursor position. Not implemented
2977 for X frames. */
2979 static void
2980 x_delete_glyphs (struct frame *f, register int n)
2982 emacs_abort ();
2986 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2987 If they are <= 0, this is probably an error. */
2989 void
2990 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
2992 eassert (width > 0 && height > 0);
2993 XClearArea (dpy, window, x, y, width, height, exposures);
2997 /* Clear an entire frame. */
2999 static void
3000 x_clear_frame (struct frame *f)
3002 /* Clearing the frame will erase any cursor, so mark them all as no
3003 longer visible. */
3004 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
3005 output_cursor.hpos = output_cursor.vpos = 0;
3006 output_cursor.x = -1;
3008 /* We don't set the output cursor here because there will always
3009 follow an explicit cursor_to. */
3010 block_input ();
3012 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
3014 /* We have to clear the scroll bars. If we have changed colors or
3015 something like that, then they should be notified. */
3016 x_scroll_bar_clear (f);
3018 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3019 /* Make sure scroll bars are redrawn. As they aren't redrawn by
3020 redisplay, do it here. */
3021 if (FRAME_GTK_WIDGET (f))
3022 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
3023 #endif
3025 XFlush (FRAME_X_DISPLAY (f));
3027 unblock_input ();
3032 /* Invert the middle quarter of the frame for .15 sec. */
3034 static void
3035 XTflash (struct frame *f)
3037 block_input ();
3040 #ifdef USE_GTK
3041 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3042 when the scroll bars and the edit widget share the same X window. */
3043 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3044 #ifdef HAVE_GTK3
3045 cairo_t *cr = gdk_cairo_create (window);
3046 cairo_set_source_rgb (cr, 1, 1, 1);
3047 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
3048 #define XFillRectangle(d, win, gc, x, y, w, h) \
3049 do { \
3050 cairo_rectangle (cr, x, y, w, h); \
3051 cairo_fill (cr); \
3053 while (0)
3054 #else /* ! HAVE_GTK3 */
3055 GdkGCValues vals;
3056 GdkGC *gc;
3057 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3058 ^ FRAME_BACKGROUND_PIXEL (f));
3059 vals.function = GDK_XOR;
3060 gc = gdk_gc_new_with_values (window,
3061 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3062 #define XFillRectangle(d, win, gc, x, y, w, h) \
3063 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
3064 #endif /* ! HAVE_GTK3 */
3065 #else /* ! USE_GTK */
3066 GC gc;
3068 /* Create a GC that will use the GXxor function to flip foreground
3069 pixels into background pixels. */
3071 XGCValues values;
3073 values.function = GXxor;
3074 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3075 ^ FRAME_BACKGROUND_PIXEL (f));
3077 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3078 GCFunction | GCForeground, &values);
3080 #endif
3082 /* Get the height not including a menu bar widget. */
3083 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3084 /* Height of each line to flash. */
3085 int flash_height = FRAME_LINE_HEIGHT (f);
3086 /* These will be the left and right margins of the rectangles. */
3087 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3088 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3090 int width;
3092 /* Don't flash the area between a scroll bar and the frame
3093 edge it is next to. */
3094 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3096 case vertical_scroll_bar_left:
3097 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3098 break;
3100 case vertical_scroll_bar_right:
3101 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3102 break;
3104 default:
3105 break;
3108 width = flash_right - flash_left;
3110 /* If window is tall, flash top and bottom line. */
3111 if (height > 3 * FRAME_LINE_HEIGHT (f))
3113 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3114 flash_left,
3115 (FRAME_INTERNAL_BORDER_WIDTH (f)
3116 + FRAME_TOP_MARGIN_HEIGHT (f)),
3117 width, flash_height);
3118 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3119 flash_left,
3120 (height - flash_height
3121 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3122 width, flash_height);
3125 else
3126 /* If it is short, flash it all. */
3127 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3128 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3129 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3131 x_flush (f);
3134 EMACS_TIME delay = make_emacs_time (0, 150 * 1000 * 1000);
3135 EMACS_TIME wakeup = add_emacs_time (current_emacs_time (), delay);
3137 /* Keep waiting until past the time wakeup or any input gets
3138 available. */
3139 while (! detect_input_pending ())
3141 EMACS_TIME current = current_emacs_time ();
3142 EMACS_TIME timeout;
3144 /* Break if result would not be positive. */
3145 if (EMACS_TIME_LE (wakeup, current))
3146 break;
3148 /* How long `select' should wait. */
3149 timeout = make_emacs_time (0, 10 * 1000 * 1000);
3151 /* Try to wait that long--but we might wake up sooner. */
3152 pselect (0, NULL, NULL, NULL, &timeout, NULL);
3156 /* If window is tall, flash top and bottom line. */
3157 if (height > 3 * FRAME_LINE_HEIGHT (f))
3159 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3160 flash_left,
3161 (FRAME_INTERNAL_BORDER_WIDTH (f)
3162 + FRAME_TOP_MARGIN_HEIGHT (f)),
3163 width, flash_height);
3164 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3165 flash_left,
3166 (height - flash_height
3167 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3168 width, flash_height);
3170 else
3171 /* If it is short, flash it all. */
3172 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3173 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3174 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3176 #ifdef USE_GTK
3177 #ifdef HAVE_GTK3
3178 cairo_destroy (cr);
3179 #else
3180 g_object_unref (G_OBJECT (gc));
3181 #endif
3182 #undef XFillRectangle
3183 #else
3184 XFreeGC (FRAME_X_DISPLAY (f), gc);
3185 #endif
3186 x_flush (f);
3190 unblock_input ();
3194 static void
3195 XTtoggle_invisible_pointer (FRAME_PTR f, int invisible)
3197 block_input ();
3198 if (invisible)
3200 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3201 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3202 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3204 else
3205 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3206 f->output_data.x->current_cursor);
3207 f->pointer_invisible = invisible;
3208 unblock_input ();
3212 /* Make audible bell. */
3214 static void
3215 XTring_bell (struct frame *f)
3217 if (FRAME_X_DISPLAY (f))
3219 if (visible_bell)
3220 XTflash (f);
3221 else
3223 block_input ();
3224 #ifdef HAVE_XKB
3225 XkbBell (FRAME_X_DISPLAY (f), None, 0, None);
3226 #else
3227 XBell (FRAME_X_DISPLAY (f), 0);
3228 #endif
3229 XFlush (FRAME_X_DISPLAY (f));
3230 unblock_input ();
3236 /* Specify how many text lines, from the top of the window,
3237 should be affected by insert-lines and delete-lines operations.
3238 This, and those operations, are used only within an update
3239 that is bounded by calls to x_update_begin and x_update_end. */
3241 static void
3242 XTset_terminal_window (struct frame *f, int n)
3244 /* This function intentionally left blank. */
3249 /***********************************************************************
3250 Line Dance
3251 ***********************************************************************/
3253 /* Perform an insert-lines or delete-lines operation, inserting N
3254 lines or deleting -N lines at vertical position VPOS. */
3256 static void
3257 x_ins_del_lines (struct frame *f, int vpos, int n)
3259 emacs_abort ();
3263 /* Scroll part of the display as described by RUN. */
3265 static void
3266 x_scroll_run (struct window *w, struct run *run)
3268 struct frame *f = XFRAME (w->frame);
3269 int x, y, width, height, from_y, to_y, bottom_y;
3271 /* Get frame-relative bounding box of the text display area of W,
3272 without mode lines. Include in this box the left and right
3273 fringe of W. */
3274 window_box (w, -1, &x, &y, &width, &height);
3276 #ifdef USE_TOOLKIT_SCROLL_BARS
3277 /* If the fringe is adjacent to the left (right) scroll bar of a
3278 leftmost (rightmost, respectively) window, then extend its
3279 background to the gap between the fringe and the bar. */
3280 if ((WINDOW_LEFTMOST_P (w)
3281 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
3282 || (WINDOW_RIGHTMOST_P (w)
3283 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
3285 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
3287 if (sb_width > 0)
3289 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
3290 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
3291 * FRAME_COLUMN_WIDTH (f));
3293 if (bar_area_x + bar_area_width == x)
3295 x = bar_area_x + sb_width;
3296 width += bar_area_width - sb_width;
3298 else if (x + width == bar_area_x)
3299 width += bar_area_width - sb_width;
3302 #endif
3304 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3305 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3306 bottom_y = y + height;
3308 if (to_y < from_y)
3310 /* Scrolling up. Make sure we don't copy part of the mode
3311 line at the bottom. */
3312 if (from_y + run->height > bottom_y)
3313 height = bottom_y - from_y;
3314 else
3315 height = run->height;
3317 else
3319 /* Scrolling down. Make sure we don't copy over the mode line.
3320 at the bottom. */
3321 if (to_y + run->height > bottom_y)
3322 height = bottom_y - to_y;
3323 else
3324 height = run->height;
3327 block_input ();
3329 /* Cursor off. Will be switched on again in x_update_window_end. */
3330 updated_window = w;
3331 x_clear_cursor (w);
3333 XCopyArea (FRAME_X_DISPLAY (f),
3334 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3335 f->output_data.x->normal_gc,
3336 x, from_y,
3337 width, height,
3338 x, to_y);
3340 unblock_input ();
3345 /***********************************************************************
3346 Exposure Events
3347 ***********************************************************************/
3350 static void
3351 frame_highlight (struct frame *f)
3353 /* We used to only do this if Vx_no_window_manager was non-nil, but
3354 the ICCCM (section 4.1.6) says that the window's border pixmap
3355 and border pixel are window attributes which are "private to the
3356 client", so we can always change it to whatever we want. */
3357 block_input ();
3358 /* I recently started to get errors in this XSetWindowBorder, depending on
3359 the window-manager in use, tho something more is at play since I've been
3360 using that same window-manager binary for ever. Let's not crash just
3361 because of this (bug#9310). */
3362 x_catch_errors (FRAME_X_DISPLAY (f));
3363 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3364 f->output_data.x->border_pixel);
3365 x_uncatch_errors ();
3366 unblock_input ();
3367 x_update_cursor (f, 1);
3368 x_set_frame_alpha (f);
3371 static void
3372 frame_unhighlight (struct frame *f)
3374 /* We used to only do this if Vx_no_window_manager was non-nil, but
3375 the ICCCM (section 4.1.6) says that the window's border pixmap
3376 and border pixel are window attributes which are "private to the
3377 client", so we can always change it to whatever we want. */
3378 block_input ();
3379 /* Same as above for XSetWindowBorder (bug#9310). */
3380 x_catch_errors (FRAME_X_DISPLAY (f));
3381 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3382 f->output_data.x->border_tile);
3383 x_uncatch_errors ();
3384 unblock_input ();
3385 x_update_cursor (f, 1);
3386 x_set_frame_alpha (f);
3389 /* The focus has changed. Update the frames as necessary to reflect
3390 the new situation. Note that we can't change the selected frame
3391 here, because the Lisp code we are interrupting might become confused.
3392 Each event gets marked with the frame in which it occurred, so the
3393 Lisp code can tell when the switch took place by examining the events. */
3395 static void
3396 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3398 struct frame *old_focus = dpyinfo->x_focus_frame;
3400 if (frame != dpyinfo->x_focus_frame)
3402 /* Set this before calling other routines, so that they see
3403 the correct value of x_focus_frame. */
3404 dpyinfo->x_focus_frame = frame;
3406 if (old_focus && old_focus->auto_lower)
3407 x_lower_frame (old_focus);
3409 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3410 pending_autoraise_frame = dpyinfo->x_focus_frame;
3411 else
3412 pending_autoraise_frame = 0;
3415 x_frame_rehighlight (dpyinfo);
3418 /* Handle FocusIn and FocusOut state changes for FRAME.
3419 If FRAME has focus and there exists more than one frame, puts
3420 a FOCUS_IN_EVENT into *BUFP. */
3422 static void
3423 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3425 if (type == FocusIn)
3427 if (dpyinfo->x_focus_event_frame != frame)
3429 x_new_focus_frame (dpyinfo, frame);
3430 dpyinfo->x_focus_event_frame = frame;
3432 /* Don't stop displaying the initial startup message
3433 for a switch-frame event we don't need. */
3434 /* When run as a daemon, Vterminal_frame is always NIL. */
3435 if ((NILP (Vterminal_frame) || EQ (Fdaemonp(), Qt))
3436 && CONSP (Vframe_list)
3437 && !NILP (XCDR (Vframe_list)))
3439 bufp->kind = FOCUS_IN_EVENT;
3440 XSETFRAME (bufp->frame_or_window, frame);
3444 frame->output_data.x->focus_state |= state;
3446 #ifdef HAVE_X_I18N
3447 if (FRAME_XIC (frame))
3448 XSetICFocus (FRAME_XIC (frame));
3449 #endif
3451 else if (type == FocusOut)
3453 frame->output_data.x->focus_state &= ~state;
3455 if (dpyinfo->x_focus_event_frame == frame)
3457 dpyinfo->x_focus_event_frame = 0;
3458 x_new_focus_frame (dpyinfo, 0);
3461 #ifdef HAVE_X_I18N
3462 if (FRAME_XIC (frame))
3463 XUnsetICFocus (FRAME_XIC (frame));
3464 #endif
3465 if (frame->pointer_invisible)
3466 XTtoggle_invisible_pointer (frame, 0);
3470 /* The focus may have changed. Figure out if it is a real focus change,
3471 by checking both FocusIn/Out and Enter/LeaveNotify events.
3473 Returns FOCUS_IN_EVENT event in *BUFP. */
3475 static void
3476 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3478 struct frame *frame;
3480 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3481 if (! frame)
3482 return;
3484 switch (event->type)
3486 case EnterNotify:
3487 case LeaveNotify:
3489 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3490 int focus_state
3491 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3493 if (event->xcrossing.detail != NotifyInferior
3494 && event->xcrossing.focus
3495 && ! (focus_state & FOCUS_EXPLICIT))
3496 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3497 FOCUS_IMPLICIT,
3498 dpyinfo, frame, bufp);
3500 break;
3502 case FocusIn:
3503 case FocusOut:
3504 x_focus_changed (event->type,
3505 (event->xfocus.detail == NotifyPointer ?
3506 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3507 dpyinfo, frame, bufp);
3508 break;
3510 case ClientMessage:
3511 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3513 enum xembed_message msg = event->xclient.data.l[1];
3514 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3515 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3517 break;
3522 #if defined HAVE_MENUS && !defined USE_X_TOOLKIT && !defined USE_GTK
3523 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3525 void
3526 x_mouse_leave (struct x_display_info *dpyinfo)
3528 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3530 #endif
3532 /* The focus has changed, or we have redirected a frame's focus to
3533 another frame (this happens when a frame uses a surrogate
3534 mini-buffer frame). Shift the highlight as appropriate.
3536 The FRAME argument doesn't necessarily have anything to do with which
3537 frame is being highlighted or un-highlighted; we only use it to find
3538 the appropriate X display info. */
3540 static void
3541 XTframe_rehighlight (struct frame *frame)
3543 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3546 static void
3547 x_frame_rehighlight (struct x_display_info *dpyinfo)
3549 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3551 if (dpyinfo->x_focus_frame)
3553 dpyinfo->x_highlight_frame
3554 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3555 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3556 : dpyinfo->x_focus_frame);
3557 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3559 fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
3560 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3563 else
3564 dpyinfo->x_highlight_frame = 0;
3566 if (dpyinfo->x_highlight_frame != old_highlight)
3568 if (old_highlight)
3569 frame_unhighlight (old_highlight);
3570 if (dpyinfo->x_highlight_frame)
3571 frame_highlight (dpyinfo->x_highlight_frame);
3577 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3579 /* Initialize mode_switch_bit and modifier_meaning. */
3580 static void
3581 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3583 int min_code, max_code;
3584 KeySym *syms;
3585 int syms_per_code;
3586 XModifierKeymap *mods;
3588 dpyinfo->meta_mod_mask = 0;
3589 dpyinfo->shift_lock_mask = 0;
3590 dpyinfo->alt_mod_mask = 0;
3591 dpyinfo->super_mod_mask = 0;
3592 dpyinfo->hyper_mod_mask = 0;
3594 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3596 syms = XGetKeyboardMapping (dpyinfo->display,
3597 min_code, max_code - min_code + 1,
3598 &syms_per_code);
3599 mods = XGetModifierMapping (dpyinfo->display);
3601 /* Scan the modifier table to see which modifier bits the Meta and
3602 Alt keysyms are on. */
3604 int row, col; /* The row and column in the modifier table. */
3605 int found_alt_or_meta;
3607 for (row = 3; row < 8; row++)
3609 found_alt_or_meta = 0;
3610 for (col = 0; col < mods->max_keypermod; col++)
3612 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3614 /* Zeroes are used for filler. Skip them. */
3615 if (code == 0)
3616 continue;
3618 /* Are any of this keycode's keysyms a meta key? */
3620 int code_col;
3622 for (code_col = 0; code_col < syms_per_code; code_col++)
3624 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3626 switch (sym)
3628 case XK_Meta_L:
3629 case XK_Meta_R:
3630 found_alt_or_meta = 1;
3631 dpyinfo->meta_mod_mask |= (1 << row);
3632 break;
3634 case XK_Alt_L:
3635 case XK_Alt_R:
3636 found_alt_or_meta = 1;
3637 dpyinfo->alt_mod_mask |= (1 << row);
3638 break;
3640 case XK_Hyper_L:
3641 case XK_Hyper_R:
3642 if (!found_alt_or_meta)
3643 dpyinfo->hyper_mod_mask |= (1 << row);
3644 code_col = syms_per_code;
3645 col = mods->max_keypermod;
3646 break;
3648 case XK_Super_L:
3649 case XK_Super_R:
3650 if (!found_alt_or_meta)
3651 dpyinfo->super_mod_mask |= (1 << row);
3652 code_col = syms_per_code;
3653 col = mods->max_keypermod;
3654 break;
3656 case XK_Shift_Lock:
3657 /* Ignore this if it's not on the lock modifier. */
3658 if (!found_alt_or_meta && ((1 << row) == LockMask))
3659 dpyinfo->shift_lock_mask = LockMask;
3660 code_col = syms_per_code;
3661 col = mods->max_keypermod;
3662 break;
3670 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3671 if (! dpyinfo->meta_mod_mask)
3673 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3674 dpyinfo->alt_mod_mask = 0;
3677 /* If some keys are both alt and meta,
3678 make them just meta, not alt. */
3679 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3681 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3684 XFree (syms);
3685 XFreeModifiermap (mods);
3688 /* Convert between the modifier bits X uses and the modifier bits
3689 Emacs uses. */
3692 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
3694 int mod_meta = meta_modifier;
3695 int mod_alt = alt_modifier;
3696 int mod_hyper = hyper_modifier;
3697 int mod_super = super_modifier;
3698 Lisp_Object tem;
3700 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3701 if (INTEGERP (tem)) mod_alt = XINT (tem) & INT_MAX;
3702 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3703 if (INTEGERP (tem)) mod_meta = XINT (tem) & INT_MAX;
3704 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3705 if (INTEGERP (tem)) mod_hyper = XINT (tem) & INT_MAX;
3706 tem = Fget (Vx_super_keysym, Qmodifier_value);
3707 if (INTEGERP (tem)) mod_super = XINT (tem) & INT_MAX;
3709 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3710 | ((state & ControlMask) ? ctrl_modifier : 0)
3711 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3712 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3713 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3714 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3717 static int
3718 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
3720 EMACS_INT mod_meta = meta_modifier;
3721 EMACS_INT mod_alt = alt_modifier;
3722 EMACS_INT mod_hyper = hyper_modifier;
3723 EMACS_INT mod_super = super_modifier;
3725 Lisp_Object tem;
3727 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3728 if (INTEGERP (tem)) mod_alt = XINT (tem);
3729 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3730 if (INTEGERP (tem)) mod_meta = XINT (tem);
3731 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3732 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3733 tem = Fget (Vx_super_keysym, Qmodifier_value);
3734 if (INTEGERP (tem)) mod_super = XINT (tem);
3737 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3738 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3739 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3740 | ((state & shift_modifier) ? ShiftMask : 0)
3741 | ((state & ctrl_modifier) ? ControlMask : 0)
3742 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3745 /* Convert a keysym to its name. */
3747 char *
3748 x_get_keysym_name (int keysym)
3750 char *value;
3752 block_input ();
3753 value = XKeysymToString (keysym);
3754 unblock_input ();
3756 return value;
3761 /* Mouse clicks and mouse movement. Rah. */
3763 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3765 If the event is a button press, then note that we have grabbed
3766 the mouse. */
3768 static Lisp_Object
3769 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3771 /* Make the event type NO_EVENT; we'll change that when we decide
3772 otherwise. */
3773 result->kind = MOUSE_CLICK_EVENT;
3774 result->code = event->button - Button1;
3775 result->timestamp = event->time;
3776 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3777 event->state)
3778 | (event->type == ButtonRelease
3779 ? up_modifier
3780 : down_modifier));
3782 XSETINT (result->x, event->x);
3783 XSETINT (result->y, event->y);
3784 XSETFRAME (result->frame_or_window, f);
3785 result->arg = Qnil;
3786 return Qnil;
3790 /* Function to report a mouse movement to the mainstream Emacs code.
3791 The input handler calls this.
3793 We have received a mouse movement event, which is given in *event.
3794 If the mouse is over a different glyph than it was last time, tell
3795 the mainstream emacs code by setting mouse_moved. If not, ask for
3796 another motion event, so we can check again the next time it moves. */
3798 static XMotionEvent last_mouse_motion_event;
3799 static Lisp_Object last_mouse_motion_frame;
3801 static int
3802 note_mouse_movement (FRAME_PTR frame, XMotionEvent *event)
3804 last_mouse_movement_time = event->time;
3805 last_mouse_motion_event = *event;
3806 XSETFRAME (last_mouse_motion_frame, frame);
3808 if (!FRAME_X_OUTPUT (frame))
3809 return 0;
3811 if (event->window != FRAME_X_WINDOW (frame))
3813 frame->mouse_moved = 1;
3814 last_mouse_scroll_bar = Qnil;
3815 note_mouse_highlight (frame, -1, -1);
3816 last_mouse_glyph_frame = 0;
3817 return 1;
3821 /* Has the mouse moved off the glyph it was on at the last sighting? */
3822 if (frame != last_mouse_glyph_frame
3823 || event->x < last_mouse_glyph.x
3824 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3825 || event->y < last_mouse_glyph.y
3826 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3828 frame->mouse_moved = 1;
3829 last_mouse_scroll_bar = Qnil;
3830 note_mouse_highlight (frame, event->x, event->y);
3831 /* Remember which glyph we're now on. */
3832 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3833 last_mouse_glyph_frame = frame;
3834 return 1;
3837 return 0;
3841 /************************************************************************
3842 Mouse Face
3843 ************************************************************************/
3845 static void
3846 redo_mouse_highlight (void)
3848 if (!NILP (last_mouse_motion_frame)
3849 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3850 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3851 last_mouse_motion_event.x,
3852 last_mouse_motion_event.y);
3857 /* Return the current position of the mouse.
3858 *FP should be a frame which indicates which display to ask about.
3860 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3861 and *PART to the frame, window, and scroll bar part that the mouse
3862 is over. Set *X and *Y to the portion and whole of the mouse's
3863 position on the scroll bar.
3865 If the mouse movement started elsewhere, set *FP to the frame the
3866 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3867 the mouse is over.
3869 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
3870 was at this position.
3872 Don't store anything if we don't have a valid set of values to report.
3874 This clears the mouse_moved flag, so we can wait for the next mouse
3875 movement. */
3877 static void
3878 XTmouse_position (FRAME_PTR *fp, int insist, Lisp_Object *bar_window,
3879 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
3880 Time *timestamp)
3882 FRAME_PTR f1;
3884 block_input ();
3886 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3887 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
3888 else
3890 Window root;
3891 int root_x, root_y;
3893 Window dummy_window;
3894 int dummy;
3896 Lisp_Object frame, tail;
3898 /* Clear the mouse-moved flag for every frame on this display. */
3899 FOR_EACH_FRAME (tail, frame)
3900 if (FRAME_X_P (XFRAME (frame))
3901 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3902 XFRAME (frame)->mouse_moved = 0;
3904 last_mouse_scroll_bar = Qnil;
3906 /* Figure out which root window we're on. */
3907 XQueryPointer (FRAME_X_DISPLAY (*fp),
3908 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3910 /* The root window which contains the pointer. */
3911 &root,
3913 /* Trash which we can't trust if the pointer is on
3914 a different screen. */
3915 &dummy_window,
3917 /* The position on that root window. */
3918 &root_x, &root_y,
3920 /* More trash we can't trust. */
3921 &dummy, &dummy,
3923 /* Modifier keys and pointer buttons, about which
3924 we don't care. */
3925 (unsigned int *) &dummy);
3927 /* Now we have a position on the root; find the innermost window
3928 containing the pointer. */
3930 Window win, child;
3931 int win_x, win_y;
3932 int parent_x = 0, parent_y = 0;
3934 win = root;
3936 /* XTranslateCoordinates can get errors if the window
3937 structure is changing at the same time this function
3938 is running. So at least we must not crash from them. */
3940 x_catch_errors (FRAME_X_DISPLAY (*fp));
3942 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3943 && FRAME_LIVE_P (last_mouse_frame))
3945 /* If mouse was grabbed on a frame, give coords for that frame
3946 even if the mouse is now outside it. */
3947 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3949 /* From-window, to-window. */
3950 root, FRAME_X_WINDOW (last_mouse_frame),
3952 /* From-position, to-position. */
3953 root_x, root_y, &win_x, &win_y,
3955 /* Child of win. */
3956 &child);
3957 f1 = last_mouse_frame;
3959 else
3961 while (1)
3963 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3965 /* From-window, to-window. */
3966 root, win,
3968 /* From-position, to-position. */
3969 root_x, root_y, &win_x, &win_y,
3971 /* Child of win. */
3972 &child);
3974 if (child == None || child == win)
3975 break;
3976 #ifdef USE_GTK
3977 /* We don't wan't to know the innermost window. We
3978 want the edit window. For non-Gtk+ the innermost
3979 window is the edit window. For Gtk+ it might not
3980 be. It might be the tool bar for example. */
3981 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3982 break;
3983 #endif
3984 win = child;
3985 parent_x = win_x;
3986 parent_y = win_y;
3989 /* Now we know that:
3990 win is the innermost window containing the pointer
3991 (XTC says it has no child containing the pointer),
3992 win_x and win_y are the pointer's position in it
3993 (XTC did this the last time through), and
3994 parent_x and parent_y are the pointer's position in win's parent.
3995 (They are what win_x and win_y were when win was child.
3996 If win is the root window, it has no parent, and
3997 parent_{x,y} are invalid, but that's okay, because we'll
3998 never use them in that case.) */
4000 #ifdef USE_GTK
4001 /* We don't wan't to know the innermost window. We
4002 want the edit window. */
4003 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4004 #else
4005 /* Is win one of our frames? */
4006 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4007 #endif
4009 #ifdef USE_X_TOOLKIT
4010 /* If we end up with the menu bar window, say it's not
4011 on the frame. */
4012 if (f1 != NULL
4013 && f1->output_data.x->menubar_widget
4014 && win == XtWindow (f1->output_data.x->menubar_widget))
4015 f1 = NULL;
4016 #endif /* USE_X_TOOLKIT */
4019 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
4020 f1 = 0;
4022 x_uncatch_errors ();
4024 /* If not, is it one of our scroll bars? */
4025 if (! f1)
4027 struct scroll_bar *bar;
4029 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
4031 if (bar)
4033 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4034 win_x = parent_x;
4035 win_y = parent_y;
4039 if (f1 == 0 && insist > 0)
4040 f1 = SELECTED_FRAME ();
4042 if (f1)
4044 /* Ok, we found a frame. Store all the values.
4045 last_mouse_glyph is a rectangle used to reduce the
4046 generation of mouse events. To not miss any motion
4047 events, we must divide the frame into rectangles of the
4048 size of the smallest character that could be displayed
4049 on it, i.e. into the same rectangles that matrices on
4050 the frame are divided into. */
4052 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
4053 last_mouse_glyph_frame = f1;
4055 *bar_window = Qnil;
4056 *part = 0;
4057 *fp = f1;
4058 XSETINT (*x, win_x);
4059 XSETINT (*y, win_y);
4060 *timestamp = last_mouse_movement_time;
4065 unblock_input ();
4070 /***********************************************************************
4071 Scroll bars
4072 ***********************************************************************/
4074 /* Scroll bar support. */
4076 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4077 manages it.
4078 This can be called in GC, so we have to make sure to strip off mark
4079 bits. */
4081 static struct scroll_bar *
4082 x_window_to_scroll_bar (Display *display, Window window_id)
4084 Lisp_Object tail, frame;
4086 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4087 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4088 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4090 FOR_EACH_FRAME (tail, frame)
4092 Lisp_Object bar, condemned;
4094 if (! FRAME_X_P (XFRAME (frame)))
4095 continue;
4097 /* Scan this frame's scroll bar list for a scroll bar with the
4098 right window ID. */
4099 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4100 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4101 /* This trick allows us to search both the ordinary and
4102 condemned scroll bar lists with one loop. */
4103 ! NILP (bar) || (bar = condemned,
4104 condemned = Qnil,
4105 ! NILP (bar));
4106 bar = XSCROLL_BAR (bar)->next)
4107 if (XSCROLL_BAR (bar)->x_window == window_id &&
4108 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4109 return XSCROLL_BAR (bar);
4112 return NULL;
4116 #if defined USE_LUCID
4118 /* Return the Lucid menu bar WINDOW is part of. Return null
4119 if WINDOW is not part of a menu bar. */
4121 static Widget
4122 x_window_to_menu_bar (Window window)
4124 Lisp_Object tail, frame;
4126 FOR_EACH_FRAME (tail, frame)
4127 if (FRAME_X_P (XFRAME (frame)))
4129 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4131 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4132 return menu_bar;
4134 return NULL;
4137 #endif /* USE_LUCID */
4140 /************************************************************************
4141 Toolkit scroll bars
4142 ************************************************************************/
4144 #ifdef USE_TOOLKIT_SCROLL_BARS
4146 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4147 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4148 static void x_create_toolkit_scroll_bar (struct frame *,
4149 struct scroll_bar *);
4150 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4151 int, int, int);
4154 /* Lisp window being scrolled. Set when starting to interact with
4155 a toolkit scroll bar, reset to nil when ending the interaction. */
4157 static Lisp_Object window_being_scrolled;
4159 /* Last scroll bar part sent in xm_scroll_callback. */
4161 static int last_scroll_bar_part;
4163 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4164 that movements of 1/20 of the screen size are mapped to up/down. */
4166 #ifndef USE_GTK
4167 /* Id of action hook installed for scroll bars. */
4169 static XtActionHookId action_hook_id;
4171 static Boolean xaw3d_arrow_scroll;
4173 /* Whether the drag scrolling maintains the mouse at the top of the
4174 thumb. If not, resizing the thumb needs to be done more carefully
4175 to avoid jerkiness. */
4177 static Boolean xaw3d_pick_top;
4179 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4180 bars are used.. The hook is responsible for detecting when
4181 the user ends an interaction with the scroll bar, and generates
4182 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4184 static void
4185 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4186 XEvent *event, String *params, Cardinal *num_params)
4188 int scroll_bar_p;
4189 const char *end_action;
4191 #ifdef USE_MOTIF
4192 scroll_bar_p = XmIsScrollBar (widget);
4193 end_action = "Release";
4194 #else /* !USE_MOTIF i.e. use Xaw */
4195 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4196 end_action = "EndScroll";
4197 #endif /* USE_MOTIF */
4199 if (scroll_bar_p
4200 && strcmp (action_name, end_action) == 0
4201 && WINDOWP (window_being_scrolled))
4203 struct window *w;
4205 x_send_scroll_bar_event (window_being_scrolled,
4206 scroll_bar_end_scroll, 0, 0);
4207 w = XWINDOW (window_being_scrolled);
4209 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4211 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4212 /* The thumb size is incorrect while dragging: fix it. */
4213 set_vertical_scroll_bar (w);
4215 window_being_scrolled = Qnil;
4216 last_scroll_bar_part = -1;
4218 /* Xt timeouts no longer needed. */
4219 toolkit_scroll_bar_interaction = 0;
4222 #endif /* not USE_GTK */
4224 /* A vector of windows used for communication between
4225 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4227 static struct window **scroll_bar_windows;
4228 static ptrdiff_t scroll_bar_windows_size;
4231 /* Send a client message with message type Xatom_Scrollbar for a
4232 scroll action to the frame of WINDOW. PART is a value identifying
4233 the part of the scroll bar that was clicked on. PORTION is the
4234 amount to scroll of a whole of WHOLE. */
4236 static void
4237 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4239 XEvent event;
4240 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4241 struct window *w = XWINDOW (window);
4242 struct frame *f = XFRAME (w->frame);
4243 ptrdiff_t i;
4245 block_input ();
4247 /* Construct a ClientMessage event to send to the frame. */
4248 ev->type = ClientMessage;
4249 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4250 ev->display = FRAME_X_DISPLAY (f);
4251 ev->window = FRAME_X_WINDOW (f);
4252 ev->format = 32;
4254 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4255 not enough to store a pointer or Lisp_Object on a 64 bit system.
4256 So, store the window in scroll_bar_windows and pass the index
4257 into that array in the event. */
4258 for (i = 0; i < scroll_bar_windows_size; ++i)
4259 if (scroll_bar_windows[i] == NULL)
4260 break;
4262 if (i == scroll_bar_windows_size)
4264 ptrdiff_t old_nbytes =
4265 scroll_bar_windows_size * sizeof *scroll_bar_windows;
4266 ptrdiff_t nbytes;
4267 enum { XClientMessageEvent_MAX = 0x7fffffff };
4268 scroll_bar_windows =
4269 xpalloc (scroll_bar_windows, &scroll_bar_windows_size, 1,
4270 XClientMessageEvent_MAX, sizeof *scroll_bar_windows);
4271 nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4272 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4275 scroll_bar_windows[i] = w;
4276 ev->data.l[0] = (long) i;
4277 ev->data.l[1] = (long) part;
4278 ev->data.l[2] = (long) 0;
4279 ev->data.l[3] = (long) portion;
4280 ev->data.l[4] = (long) whole;
4282 /* Make Xt timeouts work while the scroll bar is active. */
4283 #ifdef USE_X_TOOLKIT
4284 toolkit_scroll_bar_interaction = 1;
4285 x_activate_timeout_atimer ();
4286 #endif
4288 /* Setting the event mask to zero means that the message will
4289 be sent to the client that created the window, and if that
4290 window no longer exists, no event will be sent. */
4291 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4292 unblock_input ();
4296 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4297 in *IEVENT. */
4299 static void
4300 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4302 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4303 Lisp_Object window;
4304 struct window *w;
4306 w = scroll_bar_windows[ev->data.l[0]];
4307 scroll_bar_windows[ev->data.l[0]] = NULL;
4309 XSETWINDOW (window, w);
4311 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4312 ievent->frame_or_window = window;
4313 ievent->arg = Qnil;
4314 #ifdef USE_GTK
4315 ievent->timestamp = CurrentTime;
4316 #else
4317 ievent->timestamp =
4318 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
4319 #endif
4320 ievent->part = ev->data.l[1];
4321 ievent->code = ev->data.l[2];
4322 ievent->x = make_number ((int) ev->data.l[3]);
4323 ievent->y = make_number ((int) ev->data.l[4]);
4324 ievent->modifiers = 0;
4328 #ifdef USE_MOTIF
4330 /* Minimum and maximum values used for Motif scroll bars. */
4332 #define XM_SB_MAX 10000000
4335 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4336 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4337 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4339 static void
4340 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4342 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4343 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4344 int part = -1, whole = 0, portion = 0;
4346 switch (cs->reason)
4348 case XmCR_DECREMENT:
4349 bar->dragging = Qnil;
4350 part = scroll_bar_up_arrow;
4351 break;
4353 case XmCR_INCREMENT:
4354 bar->dragging = Qnil;
4355 part = scroll_bar_down_arrow;
4356 break;
4358 case XmCR_PAGE_DECREMENT:
4359 bar->dragging = Qnil;
4360 part = scroll_bar_above_handle;
4361 break;
4363 case XmCR_PAGE_INCREMENT:
4364 bar->dragging = Qnil;
4365 part = scroll_bar_below_handle;
4366 break;
4368 case XmCR_TO_TOP:
4369 bar->dragging = Qnil;
4370 part = scroll_bar_to_top;
4371 break;
4373 case XmCR_TO_BOTTOM:
4374 bar->dragging = Qnil;
4375 part = scroll_bar_to_bottom;
4376 break;
4378 case XmCR_DRAG:
4380 int slider_size;
4382 /* Get the slider size. */
4383 block_input ();
4384 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4385 unblock_input ();
4387 whole = XM_SB_MAX - slider_size;
4388 portion = min (cs->value, whole);
4389 part = scroll_bar_handle;
4390 bar->dragging = make_number (cs->value);
4392 break;
4394 case XmCR_VALUE_CHANGED:
4395 break;
4398 if (part >= 0)
4400 window_being_scrolled = bar->window;
4401 last_scroll_bar_part = part;
4402 x_send_scroll_bar_event (bar->window, part, portion, whole);
4406 #elif defined USE_GTK
4408 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4409 bar widget. DATA is a pointer to the scroll_bar structure. */
4411 static gboolean
4412 xg_scroll_callback (GtkRange *range,
4413 GtkScrollType scroll,
4414 gdouble value,
4415 gpointer user_data)
4417 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4418 gdouble position;
4419 int part = -1, whole = 0, portion = 0;
4420 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4421 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4423 if (xg_ignore_gtk_scrollbar) return FALSE;
4424 position = gtk_adjustment_get_value (adj);
4427 switch (scroll)
4429 case GTK_SCROLL_JUMP:
4430 /* Buttons 1 2 or 3 must be grabbed. */
4431 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4432 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4434 part = scroll_bar_handle;
4435 whole = gtk_adjustment_get_upper (adj) -
4436 gtk_adjustment_get_page_size (adj);
4437 portion = min ((int)position, whole);
4438 bar->dragging = make_number ((int)portion);
4440 break;
4441 case GTK_SCROLL_STEP_BACKWARD:
4442 part = scroll_bar_up_arrow;
4443 bar->dragging = Qnil;
4444 break;
4445 case GTK_SCROLL_STEP_FORWARD:
4446 part = scroll_bar_down_arrow;
4447 bar->dragging = Qnil;
4448 break;
4449 case GTK_SCROLL_PAGE_BACKWARD:
4450 part = scroll_bar_above_handle;
4451 bar->dragging = Qnil;
4452 break;
4453 case GTK_SCROLL_PAGE_FORWARD:
4454 part = scroll_bar_below_handle;
4455 bar->dragging = Qnil;
4456 break;
4459 if (part >= 0)
4461 window_being_scrolled = bar->window;
4462 last_scroll_bar_part = part;
4463 x_send_scroll_bar_event (bar->window, part, portion, whole);
4466 return FALSE;
4469 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4471 static gboolean
4472 xg_end_scroll_callback (GtkWidget *widget,
4473 GdkEventButton *event,
4474 gpointer user_data)
4476 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4477 bar->dragging = Qnil;
4478 if (WINDOWP (window_being_scrolled))
4480 x_send_scroll_bar_event (window_being_scrolled,
4481 scroll_bar_end_scroll, 0, 0);
4482 window_being_scrolled = Qnil;
4485 return FALSE;
4489 #else /* not USE_GTK and not USE_MOTIF */
4491 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4492 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4493 scroll bar struct. CALL_DATA is a pointer to a float saying where
4494 the thumb is. */
4496 static void
4497 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4499 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4500 float top = *(float *) call_data;
4501 float shown;
4502 int whole, portion, height;
4503 int part;
4505 /* Get the size of the thumb, a value between 0 and 1. */
4506 block_input ();
4507 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4508 unblock_input ();
4510 whole = 10000000;
4511 portion = shown < 1 ? top * whole : 0;
4513 if (shown < 1 && (eabs (top + shown - 1) < 1.0f / height))
4514 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4515 the bottom, so we force the scrolling whenever we see that we're
4516 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4517 we try to ensure that we always stay two pixels away from the
4518 bottom). */
4519 part = scroll_bar_down_arrow;
4520 else
4521 part = scroll_bar_handle;
4523 window_being_scrolled = bar->window;
4524 bar->dragging = make_number (portion);
4525 last_scroll_bar_part = part;
4526 x_send_scroll_bar_event (bar->window, part, portion, whole);
4530 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4531 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4532 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4533 the scroll bar. CALL_DATA is an integer specifying the action that
4534 has taken place. Its magnitude is in the range 0..height of the
4535 scroll bar. Negative values mean scroll towards buffer start.
4536 Values < height of scroll bar mean line-wise movement. */
4538 static void
4539 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4541 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4542 /* The position really is stored cast to a pointer. */
4543 int position = (long) call_data;
4544 Dimension height;
4545 int part;
4547 /* Get the height of the scroll bar. */
4548 block_input ();
4549 XtVaGetValues (widget, XtNheight, &height, NULL);
4550 unblock_input ();
4552 if (eabs (position) >= height)
4553 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4555 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4556 it maps line-movement to call_data = max(5, height/20). */
4557 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4558 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4559 else
4560 part = scroll_bar_move_ratio;
4562 window_being_scrolled = bar->window;
4563 bar->dragging = Qnil;
4564 last_scroll_bar_part = part;
4565 x_send_scroll_bar_event (bar->window, part, position, height);
4568 #endif /* not USE_GTK and not USE_MOTIF */
4570 #define SCROLL_BAR_NAME "verticalScrollBar"
4572 /* Create the widget for scroll bar BAR on frame F. Record the widget
4573 and X window of the scroll bar in BAR. */
4575 #ifdef USE_GTK
4576 static void
4577 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4579 const char *scroll_bar_name = SCROLL_BAR_NAME;
4581 block_input ();
4582 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4583 G_CALLBACK (xg_end_scroll_callback),
4584 scroll_bar_name);
4585 unblock_input ();
4588 #else /* not USE_GTK */
4590 static void
4591 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4593 Window xwindow;
4594 Widget widget;
4595 Arg av[20];
4596 int ac = 0;
4597 const char *scroll_bar_name = SCROLL_BAR_NAME;
4598 unsigned long pixel;
4600 block_input ();
4602 #ifdef USE_MOTIF
4603 /* Set resources. Create the widget. */
4604 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4605 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4606 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4607 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4608 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4609 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4610 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4612 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4613 if (pixel != -1)
4615 XtSetArg (av[ac], XmNforeground, pixel);
4616 ++ac;
4619 pixel = f->output_data.x->scroll_bar_background_pixel;
4620 if (pixel != -1)
4622 XtSetArg (av[ac], XmNbackground, pixel);
4623 ++ac;
4626 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4627 (char *) scroll_bar_name, av, ac);
4629 /* Add one callback for everything that can happen. */
4630 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4631 (XtPointer) bar);
4632 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4633 (XtPointer) bar);
4634 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4635 (XtPointer) bar);
4636 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4637 (XtPointer) bar);
4638 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4639 (XtPointer) bar);
4640 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4641 (XtPointer) bar);
4642 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4643 (XtPointer) bar);
4645 /* Realize the widget. Only after that is the X window created. */
4646 XtRealizeWidget (widget);
4648 /* Set the cursor to an arrow. I didn't find a resource to do that.
4649 And I'm wondering why it hasn't an arrow cursor by default. */
4650 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4651 f->output_data.x->nontext_cursor);
4653 #else /* !USE_MOTIF i.e. use Xaw */
4655 /* Set resources. Create the widget. The background of the
4656 Xaw3d scroll bar widget is a little bit light for my taste.
4657 We don't alter it here to let users change it according
4658 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4659 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4660 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4661 /* For smoother scrolling with Xaw3d -sm */
4662 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4664 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4665 if (pixel != -1)
4667 XtSetArg (av[ac], XtNforeground, pixel);
4668 ++ac;
4671 pixel = f->output_data.x->scroll_bar_background_pixel;
4672 if (pixel != -1)
4674 XtSetArg (av[ac], XtNbackground, pixel);
4675 ++ac;
4678 /* Top/bottom shadow colors. */
4680 /* Allocate them, if necessary. */
4681 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4683 pixel = f->output_data.x->scroll_bar_background_pixel;
4684 if (pixel != -1)
4686 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4687 FRAME_X_COLORMAP (f),
4688 &pixel, 1.2, 0x8000))
4689 pixel = -1;
4690 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4693 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4695 pixel = f->output_data.x->scroll_bar_background_pixel;
4696 if (pixel != -1)
4698 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4699 FRAME_X_COLORMAP (f),
4700 &pixel, 0.6, 0x4000))
4701 pixel = -1;
4702 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4706 #ifdef XtNbeNiceToColormap
4707 /* Tell the toolkit about them. */
4708 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4709 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4710 /* We tried to allocate a color for the top/bottom shadow, and
4711 failed, so tell Xaw3d to use dithering instead. */
4712 /* But only if we have a small colormap. Xaw3d can allocate nice
4713 colors itself. */
4715 XtSetArg (av[ac], XtNbeNiceToColormap,
4716 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4717 ++ac;
4719 else
4720 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4721 be more consistent with other emacs 3d colors, and since Xaw3d is
4722 not good at dealing with allocation failure. */
4724 /* This tells Xaw3d to use real colors instead of dithering for
4725 the shadows. */
4726 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4727 ++ac;
4729 /* Specify the colors. */
4730 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4731 if (pixel != -1)
4733 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4734 ++ac;
4736 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4737 if (pixel != -1)
4739 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4740 ++ac;
4743 #endif
4745 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4746 f->output_data.x->edit_widget, av, ac);
4749 char const *initial = "";
4750 char const *val = initial;
4751 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4752 #ifdef XtNarrowScrollbars
4753 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4754 #endif
4755 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4756 if (xaw3d_arrow_scroll || val == initial)
4757 { /* ARROW_SCROLL */
4758 xaw3d_arrow_scroll = True;
4759 /* Isn't that just a personal preference ? --Stef */
4760 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4764 /* Define callbacks. */
4765 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4766 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4767 (XtPointer) bar);
4769 /* Realize the widget. Only after that is the X window created. */
4770 XtRealizeWidget (widget);
4772 #endif /* !USE_MOTIF */
4774 /* Install an action hook that lets us detect when the user
4775 finishes interacting with a scroll bar. */
4776 if (action_hook_id == 0)
4777 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4779 /* Remember X window and widget in the scroll bar vector. */
4780 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4781 xwindow = XtWindow (widget);
4782 bar->x_window = xwindow;
4784 unblock_input ();
4786 #endif /* not USE_GTK */
4789 /* Set the thumb size and position of scroll bar BAR. We are currently
4790 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4792 #ifdef USE_GTK
4793 static void
4794 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4796 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4799 #else /* not USE_GTK */
4800 static void
4801 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4802 int whole)
4804 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4805 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4806 float top, shown;
4808 block_input ();
4810 #ifdef USE_MOTIF
4812 if (scroll_bar_adjust_thumb_portion_p)
4814 /* We use an estimate of 30 chars per line rather than the real
4815 `portion' value. This has the disadvantage that the thumb size
4816 is not very representative, but it makes our life a lot easier.
4817 Otherwise, we have to constantly adjust the thumb size, which
4818 we can't always do quickly enough: while dragging, the size of
4819 the thumb might prevent the user from dragging the thumb all the
4820 way to the end. but Motif and some versions of Xaw3d don't allow
4821 updating the thumb size while dragging. Also, even if we can update
4822 its size, the update will often happen too late.
4823 If you don't believe it, check out revision 1.650 of xterm.c to see
4824 what hoops we were going through and the still poor behavior we got. */
4825 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4826 /* When the thumb is at the bottom, position == whole.
4827 So we need to increase `whole' to make space for the thumb. */
4828 whole += portion;
4831 if (whole <= 0)
4832 top = 0, shown = 1;
4833 else
4835 top = (float) position / whole;
4836 shown = (float) portion / whole;
4839 if (NILP (bar->dragging))
4841 int size, value;
4843 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4844 is the scroll bar's maximum and MIN is the scroll bar's minimum
4845 value. */
4846 size = clip_to_bounds (1, shown * XM_SB_MAX, XM_SB_MAX);
4848 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4849 value = top * XM_SB_MAX;
4850 value = min (value, XM_SB_MAX - size);
4852 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4854 #else /* !USE_MOTIF i.e. use Xaw */
4856 if (whole == 0)
4857 top = 0, shown = 1;
4858 else
4860 top = (float) position / whole;
4861 shown = (float) portion / whole;
4865 float old_top, old_shown;
4866 Dimension height;
4867 XtVaGetValues (widget,
4868 XtNtopOfThumb, &old_top,
4869 XtNshown, &old_shown,
4870 XtNheight, &height,
4871 NULL);
4873 /* Massage the top+shown values. */
4874 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4875 top = max (0, min (1, top));
4876 else
4877 top = old_top;
4878 /* Keep two pixels available for moving the thumb down. */
4879 shown = max (0, min (1 - top - (2.0f / height), shown));
4881 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4882 check that your system's configuration file contains a define
4883 for `NARROWPROTO'. See s/freebsd.h for an example. */
4884 if (top != old_top || shown != old_shown)
4886 if (NILP (bar->dragging))
4887 XawScrollbarSetThumb (widget, top, shown);
4888 else
4890 /* Try to make the scrolling a tad smoother. */
4891 if (!xaw3d_pick_top)
4892 shown = min (shown, old_shown);
4894 XawScrollbarSetThumb (widget, top, shown);
4898 #endif /* !USE_MOTIF */
4900 unblock_input ();
4902 #endif /* not USE_GTK */
4904 #endif /* USE_TOOLKIT_SCROLL_BARS */
4908 /************************************************************************
4909 Scroll bars, general
4910 ************************************************************************/
4912 /* Create a scroll bar and return the scroll bar vector for it. W is
4913 the Emacs window on which to create the scroll bar. TOP, LEFT,
4914 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4915 scroll bar. */
4917 static struct scroll_bar *
4918 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4920 struct frame *f = XFRAME (w->frame);
4921 struct scroll_bar *bar
4922 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4923 Lisp_Object barobj;
4925 block_input ();
4927 #ifdef USE_TOOLKIT_SCROLL_BARS
4928 x_create_toolkit_scroll_bar (f, bar);
4929 #else /* not USE_TOOLKIT_SCROLL_BARS */
4931 XSetWindowAttributes a;
4932 unsigned long mask;
4933 Window window;
4935 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4936 if (a.background_pixel == -1)
4937 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4939 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4940 | ButtonMotionMask | PointerMotionHintMask
4941 | ExposureMask);
4942 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4944 mask = (CWBackPixel | CWEventMask | CWCursor);
4946 /* Clear the area of W that will serve as a scroll bar. This is
4947 for the case that a window has been split horizontally. In
4948 this case, no clear_frame is generated to reduce flickering. */
4949 if (width > 0 && height > 0)
4950 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4951 left, top, width,
4952 window_box_height (w), False);
4954 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4955 /* Position and size of scroll bar. */
4956 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4957 top,
4958 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4959 height,
4960 /* Border width, depth, class, and visual. */
4962 CopyFromParent,
4963 CopyFromParent,
4964 CopyFromParent,
4965 /* Attributes. */
4966 mask, &a);
4967 bar->x_window = window;
4969 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4971 XSETWINDOW (bar->window, w);
4972 bar->top = top;
4973 bar->left = left;
4974 bar->width = width;
4975 bar->height = height;
4976 bar->start = 0;
4977 bar->end = 0;
4978 bar->dragging = Qnil;
4979 bar->fringe_extended_p = 0;
4981 /* Add bar to its frame's list of scroll bars. */
4982 bar->next = FRAME_SCROLL_BARS (f);
4983 bar->prev = Qnil;
4984 XSETVECTOR (barobj, bar);
4985 fset_scroll_bars (f, barobj);
4986 if (!NILP (bar->next))
4987 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4989 /* Map the window/widget. */
4990 #ifdef USE_TOOLKIT_SCROLL_BARS
4992 #ifdef USE_GTK
4993 xg_update_scrollbar_pos (f,
4994 bar->x_window,
4995 top,
4996 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4997 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4998 max (height, 1));
4999 #else /* not USE_GTK */
5000 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
5001 XtConfigureWidget (scroll_bar,
5002 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5003 top,
5004 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5005 max (height, 1), 0);
5006 XtMapWidget (scroll_bar);
5007 #endif /* not USE_GTK */
5009 #else /* not USE_TOOLKIT_SCROLL_BARS */
5010 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
5011 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5013 unblock_input ();
5014 return bar;
5018 #ifndef USE_TOOLKIT_SCROLL_BARS
5020 /* Draw BAR's handle in the proper position.
5022 If the handle is already drawn from START to END, don't bother
5023 redrawing it, unless REBUILD is non-zero; in that case, always
5024 redraw it. (REBUILD is handy for drawing the handle after expose
5025 events.)
5027 Normally, we want to constrain the start and end of the handle to
5028 fit inside its rectangle, but if the user is dragging the scroll
5029 bar handle, we want to let them drag it down all the way, so that
5030 the bar's top is as far down as it goes; otherwise, there's no way
5031 to move to the very end of the buffer. */
5033 static void
5034 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
5036 int dragging = ! NILP (bar->dragging);
5037 Window w = bar->x_window;
5038 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5039 GC gc = f->output_data.x->normal_gc;
5041 /* If the display is already accurate, do nothing. */
5042 if (! rebuild
5043 && start == bar->start
5044 && end == bar->end)
5045 return;
5047 block_input ();
5050 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5051 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5052 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5054 /* Make sure the values are reasonable, and try to preserve
5055 the distance between start and end. */
5057 int length = end - start;
5059 if (start < 0)
5060 start = 0;
5061 else if (start > top_range)
5062 start = top_range;
5063 end = start + length;
5065 if (end < start)
5066 end = start;
5067 else if (end > top_range && ! dragging)
5068 end = top_range;
5071 /* Store the adjusted setting in the scroll bar. */
5072 bar->start = start;
5073 bar->end = end;
5075 /* Clip the end position, just for display. */
5076 if (end > top_range)
5077 end = top_range;
5079 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5080 below top positions, to make sure the handle is always at least
5081 that many pixels tall. */
5082 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5084 /* Draw the empty space above the handle. Note that we can't clear
5085 zero-height areas; that means "clear to end of window." */
5086 if (start > 0)
5087 x_clear_area (FRAME_X_DISPLAY (f), w,
5088 /* x, y, width, height, and exposures. */
5089 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5090 VERTICAL_SCROLL_BAR_TOP_BORDER,
5091 inside_width, start,
5092 False);
5094 /* Change to proper foreground color if one is specified. */
5095 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5096 XSetForeground (FRAME_X_DISPLAY (f), gc,
5097 f->output_data.x->scroll_bar_foreground_pixel);
5099 /* Draw the handle itself. */
5100 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5101 /* x, y, width, height */
5102 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5103 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5104 inside_width, end - start);
5106 /* Restore the foreground color of the GC if we changed it above. */
5107 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5108 XSetForeground (FRAME_X_DISPLAY (f), gc,
5109 FRAME_FOREGROUND_PIXEL (f));
5111 /* Draw the empty space below the handle. Note that we can't
5112 clear zero-height areas; that means "clear to end of window." */
5113 if (end < inside_height)
5114 x_clear_area (FRAME_X_DISPLAY (f), w,
5115 /* x, y, width, height, and exposures. */
5116 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5117 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5118 inside_width, inside_height - end,
5119 False);
5123 unblock_input ();
5126 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5128 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5129 nil. */
5131 static void
5132 x_scroll_bar_remove (struct scroll_bar *bar)
5134 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5135 block_input ();
5137 #ifdef USE_TOOLKIT_SCROLL_BARS
5138 #ifdef USE_GTK
5139 xg_remove_scroll_bar (f, bar->x_window);
5140 #else /* not USE_GTK */
5141 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5142 #endif /* not USE_GTK */
5143 #else
5144 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5145 #endif
5147 /* Dissociate this scroll bar from its window. */
5148 wset_vertical_scroll_bar (XWINDOW (bar->window), Qnil);
5150 unblock_input ();
5154 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5155 that we are displaying PORTION characters out of a total of WHOLE
5156 characters, starting at POSITION. If WINDOW has no scroll bar,
5157 create one. */
5159 static void
5160 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5162 struct frame *f = XFRAME (w->frame);
5163 Lisp_Object barobj;
5164 struct scroll_bar *bar;
5165 int top, height, left, sb_left, width, sb_width;
5166 int window_y, window_height;
5167 #ifdef USE_TOOLKIT_SCROLL_BARS
5168 int fringe_extended_p;
5169 #endif
5171 /* Get window dimensions. */
5172 window_box (w, -1, 0, &window_y, 0, &window_height);
5173 top = window_y;
5174 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5175 height = window_height;
5177 /* Compute the left edge of the scroll bar area. */
5178 left = WINDOW_SCROLL_BAR_AREA_X (w);
5180 /* Compute the width of the scroll bar which might be less than
5181 the width of the area reserved for the scroll bar. */
5182 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5183 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5184 else
5185 sb_width = width;
5187 /* Compute the left edge of the scroll bar. */
5188 #ifdef USE_TOOLKIT_SCROLL_BARS
5189 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5190 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5191 else
5192 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5193 #else
5194 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5195 sb_left = left + width - sb_width;
5196 else
5197 sb_left = left;
5198 #endif
5200 #ifdef USE_TOOLKIT_SCROLL_BARS
5201 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5202 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5203 && WINDOW_LEFT_FRINGE_WIDTH (w)
5204 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5205 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5206 else
5207 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5208 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5209 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5210 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5211 #endif
5213 /* Does the scroll bar exist yet? */
5214 if (NILP (w->vertical_scroll_bar))
5216 if (width > 0 && height > 0)
5218 block_input ();
5219 #ifdef USE_TOOLKIT_SCROLL_BARS
5220 if (fringe_extended_p)
5221 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5222 sb_left, top, sb_width, height, False);
5223 else
5224 #endif
5225 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5226 left, top, width, height, False);
5227 unblock_input ();
5230 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5232 else
5234 /* It may just need to be moved and resized. */
5235 unsigned int mask = 0;
5237 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5239 block_input ();
5241 if (sb_left != bar->left)
5242 mask |= CWX;
5243 if (top != bar->top)
5244 mask |= CWY;
5245 if (sb_width != bar->width)
5246 mask |= CWWidth;
5247 if (height != bar->height)
5248 mask |= CWHeight;
5250 #ifdef USE_TOOLKIT_SCROLL_BARS
5252 /* Move/size the scroll bar widget. */
5253 if (mask || bar->fringe_extended_p != fringe_extended_p)
5255 /* Since toolkit scroll bars are smaller than the space reserved
5256 for them on the frame, we have to clear "under" them. */
5257 if (width > 0 && height > 0)
5259 if (fringe_extended_p)
5260 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5261 sb_left, top, sb_width, height, False);
5262 else
5263 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5264 left, top, width, height, False);
5266 #ifdef USE_GTK
5267 xg_update_scrollbar_pos (f,
5268 bar->x_window,
5269 top,
5270 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5271 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5272 max (height, 1));
5273 #else /* not USE_GTK */
5274 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5275 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5276 top,
5277 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5278 max (height, 1), 0);
5279 #endif /* not USE_GTK */
5281 #else /* not USE_TOOLKIT_SCROLL_BARS */
5283 /* Clear areas not covered by the scroll bar because of
5284 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5285 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5287 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5288 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5289 height, False);
5290 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5291 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5292 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5293 height, False);
5296 /* Clear areas not covered by the scroll bar because it's not as
5297 wide as the area reserved for it. This makes sure a
5298 previous mode line display is cleared after C-x 2 C-x 1, for
5299 example. */
5301 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5302 int rest = area_width - sb_width;
5303 if (rest > 0 && height > 0)
5305 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5306 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5307 left + area_width - rest, top,
5308 rest, height, False);
5309 else
5310 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5311 left, top, rest, height, False);
5315 /* Move/size the scroll bar window. */
5316 if (mask)
5318 XWindowChanges wc;
5320 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5321 wc.y = top;
5322 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5323 wc.height = height;
5324 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5325 mask, &wc);
5328 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5330 /* Remember new settings. */
5331 bar->left = sb_left;
5332 bar->top = top;
5333 bar->width = sb_width;
5334 bar->height = height;
5336 unblock_input ();
5339 #ifdef USE_TOOLKIT_SCROLL_BARS
5340 bar->fringe_extended_p = fringe_extended_p;
5342 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5343 #else /* not USE_TOOLKIT_SCROLL_BARS */
5344 /* Set the scroll bar's current state, unless we're currently being
5345 dragged. */
5346 if (NILP (bar->dragging))
5348 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5350 if (whole == 0)
5351 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5352 else
5354 int start = ((double) position * top_range) / whole;
5355 int end = ((double) (position + portion) * top_range) / whole;
5356 x_scroll_bar_set_handle (bar, start, end, 0);
5359 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5361 XSETVECTOR (barobj, bar);
5362 wset_vertical_scroll_bar (w, barobj);
5366 /* The following three hooks are used when we're doing a thorough
5367 redisplay of the frame. We don't explicitly know which scroll bars
5368 are going to be deleted, because keeping track of when windows go
5369 away is a real pain - "Can you say set-window-configuration, boys
5370 and girls?" Instead, we just assert at the beginning of redisplay
5371 that *all* scroll bars are to be removed, and then save a scroll bar
5372 from the fiery pit when we actually redisplay its window. */
5374 /* Arrange for all scroll bars on FRAME to be removed at the next call
5375 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5376 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5378 static void
5379 XTcondemn_scroll_bars (FRAME_PTR frame)
5381 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5382 while (! NILP (FRAME_SCROLL_BARS (frame)))
5384 Lisp_Object bar;
5385 bar = FRAME_SCROLL_BARS (frame);
5386 fset_scroll_bars (frame, XSCROLL_BAR (bar)->next);
5387 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5388 XSCROLL_BAR (bar)->prev = Qnil;
5389 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5390 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5391 fset_condemned_scroll_bars (frame, bar);
5396 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5397 Note that WINDOW isn't necessarily condemned at all. */
5399 static void
5400 XTredeem_scroll_bar (struct window *window)
5402 struct scroll_bar *bar;
5403 struct frame *f;
5404 Lisp_Object barobj;
5406 /* We can't redeem this window's scroll bar if it doesn't have one. */
5407 if (NILP (window->vertical_scroll_bar))
5408 emacs_abort ();
5410 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5412 /* Unlink it from the condemned list. */
5413 f = XFRAME (WINDOW_FRAME (window));
5414 if (NILP (bar->prev))
5416 /* If the prev pointer is nil, it must be the first in one of
5417 the lists. */
5418 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5419 /* It's not condemned. Everything's fine. */
5420 return;
5421 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5422 window->vertical_scroll_bar))
5423 fset_condemned_scroll_bars (f, bar->next);
5424 else
5425 /* If its prev pointer is nil, it must be at the front of
5426 one or the other! */
5427 emacs_abort ();
5429 else
5430 XSCROLL_BAR (bar->prev)->next = bar->next;
5432 if (! NILP (bar->next))
5433 XSCROLL_BAR (bar->next)->prev = bar->prev;
5435 bar->next = FRAME_SCROLL_BARS (f);
5436 bar->prev = Qnil;
5437 XSETVECTOR (barobj, bar);
5438 fset_scroll_bars (f, barobj);
5439 if (! NILP (bar->next))
5440 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5443 /* Remove all scroll bars on FRAME that haven't been saved since the
5444 last call to `*condemn_scroll_bars_hook'. */
5446 static void
5447 XTjudge_scroll_bars (FRAME_PTR f)
5449 Lisp_Object bar, next;
5451 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5453 /* Clear out the condemned list now so we won't try to process any
5454 more events on the hapless scroll bars. */
5455 fset_condemned_scroll_bars (f, Qnil);
5457 for (; ! NILP (bar); bar = next)
5459 struct scroll_bar *b = XSCROLL_BAR (bar);
5461 x_scroll_bar_remove (b);
5463 next = b->next;
5464 b->next = b->prev = Qnil;
5467 /* Now there should be no references to the condemned scroll bars,
5468 and they should get garbage-collected. */
5472 #ifndef USE_TOOLKIT_SCROLL_BARS
5473 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5474 is a no-op when using toolkit scroll bars.
5476 This may be called from a signal handler, so we have to ignore GC
5477 mark bits. */
5479 static void
5480 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5482 Window w = bar->x_window;
5483 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5484 GC gc = f->output_data.x->normal_gc;
5485 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5487 block_input ();
5489 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5491 /* Switch to scroll bar foreground color. */
5492 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5493 XSetForeground (FRAME_X_DISPLAY (f), gc,
5494 f->output_data.x->scroll_bar_foreground_pixel);
5496 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5497 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5499 /* x, y, width, height */
5500 0, 0,
5501 bar->width - 1 - width_trim - width_trim,
5502 bar->height - 1);
5504 /* Restore the foreground color of the GC if we changed it above. */
5505 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5506 XSetForeground (FRAME_X_DISPLAY (f), gc,
5507 FRAME_FOREGROUND_PIXEL (f));
5509 unblock_input ();
5512 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5514 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5515 is set to something other than NO_EVENT, it is enqueued.
5517 This may be called from a signal handler, so we have to ignore GC
5518 mark bits. */
5521 static void
5522 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5524 if (! WINDOWP (bar->window))
5525 emacs_abort ();
5527 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5528 emacs_event->code = event->xbutton.button - Button1;
5529 emacs_event->modifiers
5530 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5531 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5532 event->xbutton.state)
5533 | (event->type == ButtonRelease
5534 ? up_modifier
5535 : down_modifier));
5536 emacs_event->frame_or_window = bar->window;
5537 emacs_event->arg = Qnil;
5538 emacs_event->timestamp = event->xbutton.time;
5540 int top_range
5541 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5542 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5544 if (y < 0) y = 0;
5545 if (y > top_range) y = top_range;
5547 if (y < bar->start)
5548 emacs_event->part = scroll_bar_above_handle;
5549 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5550 emacs_event->part = scroll_bar_handle;
5551 else
5552 emacs_event->part = scroll_bar_below_handle;
5554 #ifndef USE_TOOLKIT_SCROLL_BARS
5555 /* If the user has released the handle, set it to its final position. */
5556 if (event->type == ButtonRelease
5557 && ! NILP (bar->dragging))
5559 int new_start = y - XINT (bar->dragging);
5560 int new_end = new_start + bar->end - bar->start;
5562 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5563 bar->dragging = Qnil;
5565 #endif
5567 XSETINT (emacs_event->x, y);
5568 XSETINT (emacs_event->y, top_range);
5572 #ifndef USE_TOOLKIT_SCROLL_BARS
5574 /* Handle some mouse motion while someone is dragging the scroll bar.
5576 This may be called from a signal handler, so we have to ignore GC
5577 mark bits. */
5579 static void
5580 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5582 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5584 last_mouse_movement_time = event->xmotion.time;
5586 f->mouse_moved = 1;
5587 XSETVECTOR (last_mouse_scroll_bar, bar);
5589 /* If we're dragging the bar, display it. */
5590 if (! NILP (bar->dragging))
5592 /* Where should the handle be now? */
5593 int new_start = event->xmotion.y - XINT (bar->dragging);
5595 if (new_start != bar->start)
5597 int new_end = new_start + bar->end - bar->start;
5599 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5604 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5606 /* Return information to the user about the current position of the mouse
5607 on the scroll bar. */
5609 static void
5610 x_scroll_bar_report_motion (FRAME_PTR *fp, Lisp_Object *bar_window,
5611 enum scroll_bar_part *part, Lisp_Object *x,
5612 Lisp_Object *y, Time *timestamp)
5614 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5615 Window w = bar->x_window;
5616 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5617 int win_x, win_y;
5618 Window dummy_window;
5619 int dummy_coord;
5620 unsigned int dummy_mask;
5622 block_input ();
5624 /* Get the mouse's position relative to the scroll bar window, and
5625 report that. */
5626 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5628 /* Root, child, root x and root y. */
5629 &dummy_window, &dummy_window,
5630 &dummy_coord, &dummy_coord,
5632 /* Position relative to scroll bar. */
5633 &win_x, &win_y,
5635 /* Mouse buttons and modifier keys. */
5636 &dummy_mask))
5638 else
5640 int top_range
5641 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5643 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5645 if (! NILP (bar->dragging))
5646 win_y -= XINT (bar->dragging);
5648 if (win_y < 0)
5649 win_y = 0;
5650 if (win_y > top_range)
5651 win_y = top_range;
5653 *fp = f;
5654 *bar_window = bar->window;
5656 if (! NILP (bar->dragging))
5657 *part = scroll_bar_handle;
5658 else if (win_y < bar->start)
5659 *part = scroll_bar_above_handle;
5660 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5661 *part = scroll_bar_handle;
5662 else
5663 *part = scroll_bar_below_handle;
5665 XSETINT (*x, win_y);
5666 XSETINT (*y, top_range);
5668 f->mouse_moved = 0;
5669 last_mouse_scroll_bar = Qnil;
5672 *timestamp = last_mouse_movement_time;
5674 unblock_input ();
5678 /* The screen has been cleared so we may have changed foreground or
5679 background colors, and the scroll bars may need to be redrawn.
5680 Clear out the scroll bars, and ask for expose events, so we can
5681 redraw them. */
5683 static void
5684 x_scroll_bar_clear (FRAME_PTR f)
5686 #ifndef USE_TOOLKIT_SCROLL_BARS
5687 Lisp_Object bar;
5689 /* We can have scroll bars even if this is 0,
5690 if we just turned off scroll bar mode.
5691 But in that case we should not clear them. */
5692 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5693 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5694 bar = XSCROLL_BAR (bar)->next)
5695 XClearArea (FRAME_X_DISPLAY (f),
5696 XSCROLL_BAR (bar)->x_window,
5697 0, 0, 0, 0, True);
5698 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5702 /* The main X event-reading loop - XTread_socket. */
5704 /* This holds the state XLookupString needs to implement dead keys
5705 and other tricks known as "compose processing". _X Window System_
5706 says that a portable program can't use this, but Stephen Gildea assures
5707 me that letting the compiler initialize it to zeros will work okay.
5709 This must be defined outside of XTread_socket, for the same reasons
5710 given for enter_timestamp, above. */
5712 static XComposeStatus compose_status;
5714 /* Record the last 100 characters stored
5715 to help debug the loss-of-chars-during-GC problem. */
5717 static int temp_index;
5718 static short temp_buffer[100];
5720 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5721 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5722 temp_index = 0; \
5723 temp_buffer[temp_index++] = (keysym)
5725 /* Set this to nonzero to fake an "X I/O error"
5726 on a particular display. */
5728 static struct x_display_info *XTread_socket_fake_io_error;
5730 /* When we find no input here, we occasionally do a no-op command
5731 to verify that the X server is still running and we can still talk with it.
5732 We try all the open displays, one by one.
5733 This variable is used for cycling thru the displays. */
5735 static struct x_display_info *next_noop_dpyinfo;
5737 #if defined USE_X_TOOLKIT || defined USE_GTK
5738 #define SET_SAVED_BUTTON_EVENT \
5739 do \
5741 if (f->output_data.x->saved_menu_event == 0) \
5742 f->output_data.x->saved_menu_event = \
5743 xmalloc (sizeof (XEvent)); \
5744 *f->output_data.x->saved_menu_event = event; \
5745 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5746 XSETFRAME (inev.ie.frame_or_window, f); \
5748 while (0)
5749 #endif
5751 enum
5753 X_EVENT_NORMAL,
5754 X_EVENT_GOTO_OUT,
5755 X_EVENT_DROP
5758 /* Filter events for the current X input method.
5759 DPYINFO is the display this event is for.
5760 EVENT is the X event to filter.
5762 Returns non-zero if the event was filtered, caller shall not process
5763 this event further.
5764 Returns zero if event is wasn't filtered. */
5766 #ifdef HAVE_X_I18N
5767 static int
5768 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5770 /* XFilterEvent returns non-zero if the input method has
5771 consumed the event. We pass the frame's X window to
5772 XFilterEvent because that's the one for which the IC
5773 was created. */
5775 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5776 event->xclient.window);
5778 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5780 #endif
5782 #ifdef USE_GTK
5783 static int current_count;
5784 static int current_finish;
5785 static struct input_event *current_hold_quit;
5787 /* This is the filter function invoked by the GTK event loop.
5788 It is invoked before the XEvent is translated to a GdkEvent,
5789 so we have a chance to act on the event before GTK. */
5790 static GdkFilterReturn
5791 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5793 XEvent *xev = (XEvent *) gxev;
5795 block_input ();
5796 if (current_count >= 0)
5798 struct x_display_info *dpyinfo;
5800 dpyinfo = x_display_info_for_display (xev->xany.display);
5802 #ifdef HAVE_X_I18N
5803 /* Filter events for the current X input method.
5804 GTK calls XFilterEvent but not for key press and release,
5805 so we do it here. */
5806 if ((xev->type == KeyPress || xev->type == KeyRelease)
5807 && dpyinfo
5808 && x_filter_event (dpyinfo, xev))
5810 unblock_input ();
5811 return GDK_FILTER_REMOVE;
5813 #endif
5815 if (! dpyinfo)
5816 current_finish = X_EVENT_NORMAL;
5817 else
5818 current_count +=
5819 handle_one_xevent (dpyinfo, xev, &current_finish,
5820 current_hold_quit);
5822 else
5823 current_finish = x_dispatch_event (xev, xev->xany.display);
5825 unblock_input ();
5827 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5828 return GDK_FILTER_REMOVE;
5830 return GDK_FILTER_CONTINUE;
5832 #endif /* USE_GTK */
5835 static void xembed_send_message (struct frame *f, Time,
5836 enum xembed_message,
5837 long detail, long data1, long data2);
5839 /* Handles the XEvent EVENT on display DPYINFO.
5841 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5842 *FINISH is zero if caller should continue reading events.
5843 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5845 We return the number of characters stored into the buffer. */
5847 static int
5848 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventptr,
5849 int *finish, struct input_event *hold_quit)
5851 union {
5852 struct input_event ie;
5853 struct selection_input_event sie;
5854 } inev;
5855 int count = 0;
5856 int do_help = 0;
5857 ptrdiff_t nbytes = 0;
5858 struct frame *f = NULL;
5859 struct coding_system coding;
5860 XEvent event = *eventptr;
5861 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5862 USE_SAFE_ALLOCA;
5864 *finish = X_EVENT_NORMAL;
5866 EVENT_INIT (inev.ie);
5867 inev.ie.kind = NO_EVENT;
5868 inev.ie.arg = Qnil;
5870 if (pending_event_wait.eventtype == event.type)
5871 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5873 switch (event.type)
5875 case ClientMessage:
5877 if (event.xclient.message_type
5878 == dpyinfo->Xatom_wm_protocols
5879 && event.xclient.format == 32)
5881 if (event.xclient.data.l[0]
5882 == dpyinfo->Xatom_wm_take_focus)
5884 /* Use x_any_window_to_frame because this
5885 could be the shell widget window
5886 if the frame has no title bar. */
5887 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5888 #ifdef HAVE_X_I18N
5889 /* Not quite sure this is needed -pd */
5890 if (f && FRAME_XIC (f))
5891 XSetICFocus (FRAME_XIC (f));
5892 #endif
5893 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5894 instructs the WM to set the input focus automatically for
5895 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5896 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5897 it has set the focus. So, XSetInputFocus below is not
5898 needed.
5900 The call to XSetInputFocus below has also caused trouble. In
5901 cases where the XSetInputFocus done by the WM and the one
5902 below are temporally close (on a fast machine), the call
5903 below can generate additional FocusIn events which confuse
5904 Emacs. */
5906 /* Since we set WM_TAKE_FOCUS, we must call
5907 XSetInputFocus explicitly. But not if f is null,
5908 since that might be an event for a deleted frame. */
5909 if (f)
5911 Display *d = event.xclient.display;
5912 /* Catch and ignore errors, in case window has been
5913 iconified by a window manager such as GWM. */
5914 x_catch_errors (d);
5915 XSetInputFocus (d, event.xclient.window,
5916 /* The ICCCM says this is
5917 the only valid choice. */
5918 RevertToParent,
5919 event.xclient.data.l[1]);
5920 /* This is needed to detect the error
5921 if there is an error. */
5922 XSync (d, False);
5923 x_uncatch_errors ();
5925 /* Not certain about handling scroll bars here */
5926 #endif /* 0 */
5927 goto done;
5930 if (event.xclient.data.l[0]
5931 == dpyinfo->Xatom_wm_save_yourself)
5933 /* Save state modify the WM_COMMAND property to
5934 something which can reinstate us. This notifies
5935 the session manager, who's looking for such a
5936 PropertyNotify. Can restart processing when
5937 a keyboard or mouse event arrives. */
5938 /* If we have a session manager, don't set this.
5939 KDE will then start two Emacsen, one for the
5940 session manager and one for this. */
5941 #ifdef HAVE_X_SM
5942 if (! x_session_have_connection ())
5943 #endif
5945 f = x_top_window_to_frame (dpyinfo,
5946 event.xclient.window);
5947 /* This is just so we only give real data once
5948 for a single Emacs process. */
5949 if (f == SELECTED_FRAME ())
5950 XSetCommand (FRAME_X_DISPLAY (f),
5951 event.xclient.window,
5952 initial_argv, initial_argc);
5953 else if (f)
5954 XSetCommand (FRAME_X_DISPLAY (f),
5955 event.xclient.window,
5956 0, 0);
5958 goto done;
5961 if (event.xclient.data.l[0]
5962 == dpyinfo->Xatom_wm_delete_window)
5964 f = x_any_window_to_frame (dpyinfo,
5965 event.xclient.window);
5966 if (!f)
5967 goto OTHER; /* May be a dialog that is to be removed */
5969 inev.ie.kind = DELETE_WINDOW_EVENT;
5970 XSETFRAME (inev.ie.frame_or_window, f);
5971 goto done;
5974 goto done;
5977 if (event.xclient.message_type
5978 == dpyinfo->Xatom_wm_configure_denied)
5980 goto done;
5983 if (event.xclient.message_type
5984 == dpyinfo->Xatom_wm_window_moved)
5986 int new_x, new_y;
5987 f = x_window_to_frame (dpyinfo, event.xclient.window);
5989 new_x = event.xclient.data.s[0];
5990 new_y = event.xclient.data.s[1];
5992 if (f)
5994 f->left_pos = new_x;
5995 f->top_pos = new_y;
5997 goto done;
6000 #ifdef HACK_EDITRES
6001 if (event.xclient.message_type
6002 == dpyinfo->Xatom_editres)
6004 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6005 if (f)
6006 _XEditResCheckMessages (f->output_data.x->widget, NULL,
6007 &event, NULL);
6008 goto done;
6010 #endif /* HACK_EDITRES */
6012 if ((event.xclient.message_type
6013 == dpyinfo->Xatom_DONE)
6014 || (event.xclient.message_type
6015 == dpyinfo->Xatom_PAGE))
6017 /* Ghostview job completed. Kill it. We could
6018 reply with "Next" if we received "Page", but we
6019 currently never do because we are interested in
6020 images, only, which should have 1 page. */
6021 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6022 f = x_window_to_frame (dpyinfo, event.xclient.window);
6023 if (!f)
6024 goto OTHER;
6025 x_kill_gs_process (pixmap, f);
6026 expose_frame (f, 0, 0, 0, 0);
6027 goto done;
6030 #ifdef USE_TOOLKIT_SCROLL_BARS
6031 /* Scroll bar callbacks send a ClientMessage from which
6032 we construct an input_event. */
6033 if (event.xclient.message_type
6034 == dpyinfo->Xatom_Scrollbar)
6036 x_scroll_bar_to_input_event (&event, &inev.ie);
6037 *finish = X_EVENT_GOTO_OUT;
6038 goto done;
6040 #endif /* USE_TOOLKIT_SCROLL_BARS */
6042 /* XEmbed messages from the embedder (if any). */
6043 if (event.xclient.message_type
6044 == dpyinfo->Xatom_XEMBED)
6046 enum xembed_message msg = event.xclient.data.l[1];
6047 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6048 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6050 *finish = X_EVENT_GOTO_OUT;
6051 goto done;
6054 xft_settings_event (dpyinfo, &event);
6056 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6057 if (!f)
6058 goto OTHER;
6059 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6060 *finish = X_EVENT_DROP;
6062 break;
6064 case SelectionNotify:
6065 last_user_time = event.xselection.time;
6066 #ifdef USE_X_TOOLKIT
6067 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6068 goto OTHER;
6069 #endif /* not USE_X_TOOLKIT */
6070 x_handle_selection_notify (&event.xselection);
6071 break;
6073 case SelectionClear: /* Someone has grabbed ownership. */
6074 last_user_time = event.xselectionclear.time;
6075 #ifdef USE_X_TOOLKIT
6076 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6077 goto OTHER;
6078 #endif /* USE_X_TOOLKIT */
6080 XSelectionClearEvent *eventp = &(event.xselectionclear);
6082 inev.ie.kind = SELECTION_CLEAR_EVENT;
6083 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6084 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6085 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6087 break;
6089 case SelectionRequest: /* Someone wants our selection. */
6090 last_user_time = event.xselectionrequest.time;
6091 #ifdef USE_X_TOOLKIT
6092 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6093 goto OTHER;
6094 #endif /* USE_X_TOOLKIT */
6096 XSelectionRequestEvent *eventp = &(event.xselectionrequest);
6098 inev.ie.kind = SELECTION_REQUEST_EVENT;
6099 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6100 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6101 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6102 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6103 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6104 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6106 break;
6108 case PropertyNotify:
6109 last_user_time = event.xproperty.time;
6110 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6111 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6112 if (x_handle_net_wm_state (f, &event.xproperty)
6113 && FRAME_ICONIFIED_P (f)
6114 && f->output_data.x->net_wm_state_hidden_seen)
6116 /* Gnome shell does not iconify us when C-z is pressed.
6117 It hides the frame. So if our state says we aren't
6118 hidden anymore, treat it as deiconified. */
6119 SET_FRAME_VISIBLE (f, 1);
6120 SET_FRAME_ICONIFIED (f, 0);
6121 f->output_data.x->has_been_visible = 1;
6122 f->output_data.x->net_wm_state_hidden_seen = 0;
6123 inev.ie.kind = DEICONIFY_EVENT;
6124 XSETFRAME (inev.ie.frame_or_window, f);
6127 x_handle_property_notify (&event.xproperty);
6128 xft_settings_event (dpyinfo, &event);
6129 goto OTHER;
6131 case ReparentNotify:
6132 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6133 if (f)
6135 int x, y;
6136 f->output_data.x->parent_desc = event.xreparent.parent;
6137 x_real_positions (f, &x, &y);
6138 f->left_pos = x;
6139 f->top_pos = y;
6141 /* Perhaps reparented due to a WM restart. Reset this. */
6142 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6143 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6145 x_set_frame_alpha (f);
6147 goto OTHER;
6149 case Expose:
6150 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6151 if (f)
6153 #ifdef USE_GTK
6154 /* This seems to be needed for GTK 2.6. */
6155 x_clear_area (event.xexpose.display,
6156 event.xexpose.window,
6157 event.xexpose.x, event.xexpose.y,
6158 event.xexpose.width, event.xexpose.height,
6159 FALSE);
6160 #endif
6161 if (!FRAME_VISIBLE_P (f))
6163 SET_FRAME_VISIBLE (f, 1);
6164 SET_FRAME_ICONIFIED (f, 0);
6165 f->output_data.x->has_been_visible = 1;
6166 SET_FRAME_GARBAGED (f);
6168 else
6169 expose_frame (f,
6170 event.xexpose.x, event.xexpose.y,
6171 event.xexpose.width, event.xexpose.height);
6173 else
6175 #ifndef USE_TOOLKIT_SCROLL_BARS
6176 struct scroll_bar *bar;
6177 #endif
6178 #if defined USE_LUCID
6179 /* Submenus of the Lucid menu bar aren't widgets
6180 themselves, so there's no way to dispatch events
6181 to them. Recognize this case separately. */
6183 Widget widget
6184 = x_window_to_menu_bar (event.xexpose.window);
6185 if (widget)
6186 xlwmenu_redisplay (widget);
6188 #endif /* USE_LUCID */
6190 #ifdef USE_TOOLKIT_SCROLL_BARS
6191 /* Dispatch event to the widget. */
6192 goto OTHER;
6193 #else /* not USE_TOOLKIT_SCROLL_BARS */
6194 bar = x_window_to_scroll_bar (event.xexpose.display,
6195 event.xexpose.window);
6197 if (bar)
6198 x_scroll_bar_expose (bar, &event);
6199 #ifdef USE_X_TOOLKIT
6200 else
6201 goto OTHER;
6202 #endif /* USE_X_TOOLKIT */
6203 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6205 break;
6207 case GraphicsExpose: /* This occurs when an XCopyArea's
6208 source area was obscured or not
6209 available. */
6210 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6211 if (f)
6213 expose_frame (f,
6214 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6215 event.xgraphicsexpose.width,
6216 event.xgraphicsexpose.height);
6218 #ifdef USE_X_TOOLKIT
6219 else
6220 goto OTHER;
6221 #endif /* USE_X_TOOLKIT */
6222 break;
6224 case NoExpose: /* This occurs when an XCopyArea's
6225 source area was completely
6226 available. */
6227 break;
6229 case UnmapNotify:
6230 /* Redo the mouse-highlight after the tooltip has gone. */
6231 if (event.xmap.window == tip_window)
6233 tip_window = 0;
6234 redo_mouse_highlight ();
6237 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6238 if (f) /* F may no longer exist if
6239 the frame was deleted. */
6241 bool visible = FRAME_VISIBLE_P (f);
6242 /* While a frame is unmapped, display generation is
6243 disabled; you don't want to spend time updating a
6244 display that won't ever be seen. */
6245 SET_FRAME_VISIBLE (f, 0);
6246 /* We can't distinguish, from the event, whether the window
6247 has become iconified or invisible. So assume, if it
6248 was previously visible, than now it is iconified.
6249 But x_make_frame_invisible clears both
6250 the visible flag and the iconified flag;
6251 and that way, we know the window is not iconified now. */
6252 if (visible || FRAME_ICONIFIED_P (f))
6254 SET_FRAME_ICONIFIED (f, 1);
6255 inev.ie.kind = ICONIFY_EVENT;
6256 XSETFRAME (inev.ie.frame_or_window, f);
6259 goto OTHER;
6261 case MapNotify:
6262 if (event.xmap.window == tip_window)
6263 /* The tooltip has been drawn already. Avoid
6264 the SET_FRAME_GARBAGED below. */
6265 goto OTHER;
6267 /* We use x_top_window_to_frame because map events can
6268 come for sub-windows and they don't mean that the
6269 frame is visible. */
6270 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6271 if (f)
6273 bool iconified = FRAME_ICONIFIED_P (f);
6274 /* wait_reading_process_output will notice this and update
6275 the frame's display structures.
6276 If we where iconified, we should not set garbaged,
6277 because that stops redrawing on Expose events. This looks
6278 bad if we are called from a recursive event loop
6279 (x_dispatch_event), for example when a dialog is up. */
6280 if (!iconified)
6281 SET_FRAME_GARBAGED (f);
6283 /* Check if fullscreen was specified before we where mapped the
6284 first time, i.e. from the command line. */
6285 if (!f->output_data.x->has_been_visible)
6286 x_check_fullscreen (f);
6288 SET_FRAME_VISIBLE (f, 1);
6289 SET_FRAME_ICONIFIED (f, 0);
6290 f->output_data.x->has_been_visible = 1;
6292 if (iconified)
6294 inev.ie.kind = DEICONIFY_EVENT;
6295 XSETFRAME (inev.ie.frame_or_window, f);
6297 else if (! NILP (Vframe_list) && ! NILP (XCDR (Vframe_list)))
6298 /* Force a redisplay sooner or later to update the
6299 frame titles in case this is the second frame. */
6300 record_asynch_buffer_change ();
6302 #ifdef USE_GTK
6303 xg_frame_resized (f, -1, -1);
6304 #endif
6306 goto OTHER;
6308 case KeyPress:
6310 last_user_time = event.xkey.time;
6311 ignore_next_mouse_click_timeout = 0;
6313 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6314 /* Dispatch KeyPress events when in menu. */
6315 if (popup_activated ())
6316 goto OTHER;
6317 #endif
6319 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6321 /* If mouse-highlight is an integer, input clears out
6322 mouse highlighting. */
6323 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6324 && (f == 0
6325 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6327 clear_mouse_face (hlinfo);
6328 hlinfo->mouse_face_hidden = 1;
6331 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6332 if (f == 0)
6334 /* Scroll bars consume key events, but we want
6335 the keys to go to the scroll bar's frame. */
6336 Widget widget = XtWindowToWidget (dpyinfo->display,
6337 event.xkey.window);
6338 if (widget && XmIsScrollBar (widget))
6340 widget = XtParent (widget);
6341 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6344 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6346 if (f != 0)
6348 KeySym keysym, orig_keysym;
6349 /* al%imercury@uunet.uu.net says that making this 81
6350 instead of 80 fixed a bug whereby meta chars made
6351 his Emacs hang.
6353 It seems that some version of XmbLookupString has
6354 a bug of not returning XBufferOverflow in
6355 status_return even if the input is too long to
6356 fit in 81 bytes. So, we must prepare sufficient
6357 bytes for copy_buffer. 513 bytes (256 chars for
6358 two-byte character set) seems to be a fairly good
6359 approximation. -- 2000.8.10 handa@etl.go.jp */
6360 unsigned char copy_buffer[513];
6361 unsigned char *copy_bufptr = copy_buffer;
6362 int copy_bufsiz = sizeof (copy_buffer);
6363 int modifiers;
6364 Lisp_Object coding_system = Qlatin_1;
6365 Lisp_Object c;
6367 #ifdef USE_GTK
6368 /* Don't pass keys to GTK. A Tab will shift focus to the
6369 tool bar in GTK 2.4. Keys will still go to menus and
6370 dialogs because in that case popup_activated is TRUE
6371 (see above). */
6372 *finish = X_EVENT_DROP;
6373 #endif
6375 event.xkey.state
6376 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6377 extra_keyboard_modifiers);
6378 modifiers = event.xkey.state;
6380 /* This will have to go some day... */
6382 /* make_lispy_event turns chars into control chars.
6383 Don't do it here because XLookupString is too eager. */
6384 event.xkey.state &= ~ControlMask;
6385 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6386 | dpyinfo->super_mod_mask
6387 | dpyinfo->hyper_mod_mask
6388 | dpyinfo->alt_mod_mask);
6390 /* In case Meta is ComposeCharacter,
6391 clear its status. According to Markus Ehrnsperger
6392 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6393 this enables ComposeCharacter to work whether or
6394 not it is combined with Meta. */
6395 if (modifiers & dpyinfo->meta_mod_mask)
6396 memset (&compose_status, 0, sizeof (compose_status));
6398 #ifdef HAVE_X_I18N
6399 if (FRAME_XIC (f))
6401 Status status_return;
6403 coding_system = Vlocale_coding_system;
6404 nbytes = XmbLookupString (FRAME_XIC (f),
6405 &event.xkey, (char *) copy_bufptr,
6406 copy_bufsiz, &keysym,
6407 &status_return);
6408 if (status_return == XBufferOverflow)
6410 copy_bufsiz = nbytes + 1;
6411 copy_bufptr = alloca (copy_bufsiz);
6412 nbytes = XmbLookupString (FRAME_XIC (f),
6413 &event.xkey, (char *) copy_bufptr,
6414 copy_bufsiz, &keysym,
6415 &status_return);
6417 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6418 if (status_return == XLookupNone)
6419 break;
6420 else if (status_return == XLookupChars)
6422 keysym = NoSymbol;
6423 modifiers = 0;
6425 else if (status_return != XLookupKeySym
6426 && status_return != XLookupBoth)
6427 emacs_abort ();
6429 else
6430 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6431 copy_bufsiz, &keysym,
6432 &compose_status);
6433 #else
6434 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6435 copy_bufsiz, &keysym,
6436 &compose_status);
6437 #endif
6439 /* If not using XIM/XIC, and a compose sequence is in progress,
6440 we break here. Otherwise, chars_matched is always 0. */
6441 if (compose_status.chars_matched > 0 && nbytes == 0)
6442 break;
6444 memset (&compose_status, 0, sizeof (compose_status));
6445 orig_keysym = keysym;
6447 /* Common for all keysym input events. */
6448 XSETFRAME (inev.ie.frame_or_window, f);
6449 inev.ie.modifiers
6450 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6451 inev.ie.timestamp = event.xkey.time;
6453 /* First deal with keysyms which have defined
6454 translations to characters. */
6455 if (keysym >= 32 && keysym < 128)
6456 /* Avoid explicitly decoding each ASCII character. */
6458 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6459 inev.ie.code = keysym;
6460 goto done_keysym;
6463 /* Keysyms directly mapped to Unicode characters. */
6464 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6466 if (keysym < 0x01000080)
6467 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6468 else
6469 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6470 inev.ie.code = keysym & 0xFFFFFF;
6471 goto done_keysym;
6474 /* Now non-ASCII. */
6475 if (HASH_TABLE_P (Vx_keysym_table)
6476 && (c = Fgethash (make_number (keysym),
6477 Vx_keysym_table,
6478 Qnil),
6479 NATNUMP (c)))
6481 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6482 ? ASCII_KEYSTROKE_EVENT
6483 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6484 inev.ie.code = XFASTINT (c);
6485 goto done_keysym;
6488 /* Random non-modifier sorts of keysyms. */
6489 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6490 || keysym == XK_Delete
6491 #ifdef XK_ISO_Left_Tab
6492 || (keysym >= XK_ISO_Left_Tab
6493 && keysym <= XK_ISO_Enter)
6494 #endif
6495 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6496 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6497 #ifdef HPUX
6498 /* This recognizes the "extended function
6499 keys". It seems there's no cleaner way.
6500 Test IsModifierKey to avoid handling
6501 mode_switch incorrectly. */
6502 || (XK_Select <= keysym && keysym < XK_KP_Space)
6503 #endif
6504 #ifdef XK_dead_circumflex
6505 || orig_keysym == XK_dead_circumflex
6506 #endif
6507 #ifdef XK_dead_grave
6508 || orig_keysym == XK_dead_grave
6509 #endif
6510 #ifdef XK_dead_tilde
6511 || orig_keysym == XK_dead_tilde
6512 #endif
6513 #ifdef XK_dead_diaeresis
6514 || orig_keysym == XK_dead_diaeresis
6515 #endif
6516 #ifdef XK_dead_macron
6517 || orig_keysym == XK_dead_macron
6518 #endif
6519 #ifdef XK_dead_degree
6520 || orig_keysym == XK_dead_degree
6521 #endif
6522 #ifdef XK_dead_acute
6523 || orig_keysym == XK_dead_acute
6524 #endif
6525 #ifdef XK_dead_cedilla
6526 || orig_keysym == XK_dead_cedilla
6527 #endif
6528 #ifdef XK_dead_breve
6529 || orig_keysym == XK_dead_breve
6530 #endif
6531 #ifdef XK_dead_ogonek
6532 || orig_keysym == XK_dead_ogonek
6533 #endif
6534 #ifdef XK_dead_caron
6535 || orig_keysym == XK_dead_caron
6536 #endif
6537 #ifdef XK_dead_doubleacute
6538 || orig_keysym == XK_dead_doubleacute
6539 #endif
6540 #ifdef XK_dead_abovedot
6541 || orig_keysym == XK_dead_abovedot
6542 #endif
6543 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6544 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6545 /* Any "vendor-specific" key is ok. */
6546 || (orig_keysym & (1 << 28))
6547 || (keysym != NoSymbol && nbytes == 0))
6548 && ! (IsModifierKey (orig_keysym)
6549 /* The symbols from XK_ISO_Lock
6550 to XK_ISO_Last_Group_Lock
6551 don't have real modifiers but
6552 should be treated similarly to
6553 Mode_switch by Emacs. */
6554 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6555 || (XK_ISO_Lock <= orig_keysym
6556 && orig_keysym <= XK_ISO_Last_Group_Lock)
6557 #endif
6560 STORE_KEYSYM_FOR_DEBUG (keysym);
6561 /* make_lispy_event will convert this to a symbolic
6562 key. */
6563 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6564 inev.ie.code = keysym;
6565 goto done_keysym;
6568 { /* Raw bytes, not keysym. */
6569 ptrdiff_t i;
6570 int nchars, len;
6572 for (i = 0, nchars = 0; i < nbytes; i++)
6574 if (ASCII_BYTE_P (copy_bufptr[i]))
6575 nchars++;
6576 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6579 if (nchars < nbytes)
6581 /* Decode the input data. */
6583 /* The input should be decoded with `coding_system'
6584 which depends on which X*LookupString function
6585 we used just above and the locale. */
6586 setup_coding_system (coding_system, &coding);
6587 coding.src_multibyte = 0;
6588 coding.dst_multibyte = 1;
6589 /* The input is converted to events, thus we can't
6590 handle composition. Anyway, there's no XIM that
6591 gives us composition information. */
6592 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6594 SAFE_NALLOCA (coding.destination, MAX_MULTIBYTE_LENGTH,
6595 nbytes);
6596 coding.dst_bytes = MAX_MULTIBYTE_LENGTH * nbytes;
6597 coding.mode |= CODING_MODE_LAST_BLOCK;
6598 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6599 nbytes = coding.produced;
6600 nchars = coding.produced_char;
6601 copy_bufptr = coding.destination;
6604 /* Convert the input data to a sequence of
6605 character events. */
6606 for (i = 0; i < nbytes; i += len)
6608 int ch;
6609 if (nchars == nbytes)
6610 ch = copy_bufptr[i], len = 1;
6611 else
6612 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6613 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
6614 ? ASCII_KEYSTROKE_EVENT
6615 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6616 inev.ie.code = ch;
6617 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6620 count += nchars;
6622 inev.ie.kind = NO_EVENT; /* Already stored above. */
6624 if (keysym == NoSymbol)
6625 break;
6628 done_keysym:
6629 #ifdef HAVE_X_I18N
6630 /* Don't dispatch this event since XtDispatchEvent calls
6631 XFilterEvent, and two calls in a row may freeze the
6632 client. */
6633 break;
6634 #else
6635 goto OTHER;
6636 #endif
6638 case KeyRelease:
6639 last_user_time = event.xkey.time;
6640 #ifdef HAVE_X_I18N
6641 /* Don't dispatch this event since XtDispatchEvent calls
6642 XFilterEvent, and two calls in a row may freeze the
6643 client. */
6644 break;
6645 #else
6646 goto OTHER;
6647 #endif
6649 case EnterNotify:
6650 last_user_time = event.xcrossing.time;
6651 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6653 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6655 if (f && x_mouse_click_focus_ignore_position)
6656 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6658 /* EnterNotify counts as mouse movement,
6659 so update things that depend on mouse position. */
6660 if (f && !f->output_data.x->hourglass_p)
6661 note_mouse_movement (f, &event.xmotion);
6662 #ifdef USE_GTK
6663 /* We may get an EnterNotify on the buttons in the toolbar. In that
6664 case we moved out of any highlighted area and need to note this. */
6665 if (!f && last_mouse_glyph_frame)
6666 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6667 #endif
6668 goto OTHER;
6670 case FocusIn:
6671 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6672 goto OTHER;
6674 case LeaveNotify:
6675 last_user_time = event.xcrossing.time;
6676 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6678 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6679 if (f)
6681 if (f == hlinfo->mouse_face_mouse_frame)
6683 /* If we move outside the frame, then we're
6684 certainly no longer on any text in the frame. */
6685 clear_mouse_face (hlinfo);
6686 hlinfo->mouse_face_mouse_frame = 0;
6689 /* Generate a nil HELP_EVENT to cancel a help-echo.
6690 Do it only if there's something to cancel.
6691 Otherwise, the startup message is cleared when
6692 the mouse leaves the frame. */
6693 if (any_help_event_p)
6694 do_help = -1;
6696 #ifdef USE_GTK
6697 /* See comment in EnterNotify above */
6698 else if (last_mouse_glyph_frame)
6699 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6700 #endif
6701 goto OTHER;
6703 case FocusOut:
6704 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6705 goto OTHER;
6707 case MotionNotify:
6709 last_user_time = event.xmotion.time;
6710 previous_help_echo_string = help_echo_string;
6711 help_echo_string = Qnil;
6713 if (dpyinfo->grabbed && last_mouse_frame
6714 && FRAME_LIVE_P (last_mouse_frame))
6715 f = last_mouse_frame;
6716 else
6717 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6719 if (hlinfo->mouse_face_hidden)
6721 hlinfo->mouse_face_hidden = 0;
6722 clear_mouse_face (hlinfo);
6725 #ifdef USE_GTK
6726 if (f && xg_event_is_for_scrollbar (f, &event))
6727 f = 0;
6728 #endif
6729 if (f)
6732 /* Generate SELECT_WINDOW_EVENTs when needed.
6733 Don't let popup menus influence things (bug#1261). */
6734 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6736 Lisp_Object window;
6738 window = window_from_coordinates (f,
6739 event.xmotion.x, event.xmotion.y,
6740 0, 0);
6742 /* Window will be selected only when it is not selected now and
6743 last mouse movement event was not in it. Minibuffer window
6744 will be selected only when it is active. */
6745 if (WINDOWP (window)
6746 && !EQ (window, last_window)
6747 && !EQ (window, selected_window)
6748 /* For click-to-focus window managers
6749 create event iff we don't leave the
6750 selected frame. */
6751 && (focus_follows_mouse
6752 || (EQ (XWINDOW (window)->frame,
6753 XWINDOW (selected_window)->frame))))
6755 inev.ie.kind = SELECT_WINDOW_EVENT;
6756 inev.ie.frame_or_window = window;
6759 last_window=window;
6761 if (!note_mouse_movement (f, &event.xmotion))
6762 help_echo_string = previous_help_echo_string;
6764 else
6766 #ifndef USE_TOOLKIT_SCROLL_BARS
6767 struct scroll_bar *bar
6768 = x_window_to_scroll_bar (event.xmotion.display,
6769 event.xmotion.window);
6771 if (bar)
6772 x_scroll_bar_note_movement (bar, &event);
6773 #endif /* USE_TOOLKIT_SCROLL_BARS */
6775 /* If we move outside the frame, then we're
6776 certainly no longer on any text in the frame. */
6777 clear_mouse_face (hlinfo);
6780 /* If the contents of the global variable help_echo_string
6781 has changed, generate a HELP_EVENT. */
6782 if (!NILP (help_echo_string)
6783 || !NILP (previous_help_echo_string))
6784 do_help = 1;
6785 goto OTHER;
6788 case ConfigureNotify:
6789 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6790 #ifdef USE_GTK
6791 if (!f
6792 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6793 && event.xconfigure.window == FRAME_X_WINDOW (f))
6795 xg_frame_resized (f, event.xconfigure.width,
6796 event.xconfigure.height);
6797 f = 0;
6799 #endif
6800 if (f)
6802 #ifndef USE_X_TOOLKIT
6803 #ifndef USE_GTK
6804 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6805 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6807 /* In the toolkit version, change_frame_size
6808 is called by the code that handles resizing
6809 of the EmacsFrame widget. */
6811 /* Even if the number of character rows and columns has
6812 not changed, the font size may have changed, so we need
6813 to check the pixel dimensions as well. */
6814 if (columns != FRAME_COLS (f)
6815 || rows != FRAME_LINES (f)
6816 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6817 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6819 change_frame_size (f, rows, columns, 0, 1, 0);
6820 SET_FRAME_GARBAGED (f);
6821 cancel_mouse_face (f);
6824 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6825 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6826 #endif /* not USE_GTK */
6827 #endif
6829 #ifdef USE_GTK
6830 /* GTK creates windows but doesn't map them.
6831 Only get real positions when mapped. */
6832 if (FRAME_GTK_OUTER_WIDGET (f)
6833 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6834 #endif
6836 x_real_positions (f, &f->left_pos, &f->top_pos);
6839 #ifdef HAVE_X_I18N
6840 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6841 xic_set_statusarea (f);
6842 #endif
6845 goto OTHER;
6847 case ButtonRelease:
6848 case ButtonPress:
6850 /* If we decide we want to generate an event to be seen
6851 by the rest of Emacs, we put it here. */
6852 int tool_bar_p = 0;
6854 memset (&compose_status, 0, sizeof (compose_status));
6855 last_mouse_glyph_frame = 0;
6856 last_user_time = event.xbutton.time;
6858 if (dpyinfo->grabbed
6859 && last_mouse_frame
6860 && FRAME_LIVE_P (last_mouse_frame))
6861 f = last_mouse_frame;
6862 else
6863 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6865 #ifdef USE_GTK
6866 if (f && xg_event_is_for_scrollbar (f, &event))
6867 f = 0;
6868 #endif
6869 if (f)
6871 /* Is this in the tool-bar? */
6872 if (WINDOWP (f->tool_bar_window)
6873 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6875 Lisp_Object window;
6876 int x = event.xbutton.x;
6877 int y = event.xbutton.y;
6879 window = window_from_coordinates (f, x, y, 0, 1);
6880 tool_bar_p = EQ (window, f->tool_bar_window);
6882 if (tool_bar_p && event.xbutton.button < 4)
6884 handle_tool_bar_click (f, x, y,
6885 event.xbutton.type == ButtonPress,
6886 x_x_to_emacs_modifiers (dpyinfo,
6887 event.xbutton.state));
6891 if (!tool_bar_p)
6892 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6893 if (! popup_activated ())
6894 #endif
6896 if (ignore_next_mouse_click_timeout)
6898 if (event.type == ButtonPress
6899 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6901 ignore_next_mouse_click_timeout = 0;
6902 construct_mouse_click (&inev.ie, &event.xbutton, f);
6904 if (event.type == ButtonRelease)
6905 ignore_next_mouse_click_timeout = 0;
6907 else
6908 construct_mouse_click (&inev.ie, &event.xbutton, f);
6910 if (FRAME_X_EMBEDDED_P (f))
6911 xembed_send_message (f, event.xbutton.time,
6912 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6914 else
6916 struct scroll_bar *bar
6917 = x_window_to_scroll_bar (event.xbutton.display,
6918 event.xbutton.window);
6920 #ifdef USE_TOOLKIT_SCROLL_BARS
6921 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6922 scroll bars. */
6923 if (bar && event.xbutton.state & ControlMask)
6925 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6926 *finish = X_EVENT_DROP;
6928 #else /* not USE_TOOLKIT_SCROLL_BARS */
6929 if (bar)
6930 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6931 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6934 if (event.type == ButtonPress)
6936 dpyinfo->grabbed |= (1 << event.xbutton.button);
6937 last_mouse_frame = f;
6939 if (!tool_bar_p)
6940 last_tool_bar_item = -1;
6942 else
6943 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6945 /* Ignore any mouse motion that happened before this event;
6946 any subsequent mouse-movement Emacs events should reflect
6947 only motion after the ButtonPress/Release. */
6948 if (f != 0)
6949 f->mouse_moved = 0;
6951 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6952 f = x_menubar_window_to_frame (dpyinfo, &event);
6953 /* For a down-event in the menu bar,
6954 don't pass it to Xt right now.
6955 Instead, save it away
6956 and we will pass it to Xt from kbd_buffer_get_event.
6957 That way, we can run some Lisp code first. */
6958 if (! popup_activated ()
6959 #ifdef USE_GTK
6960 /* Gtk+ menus only react to the first three buttons. */
6961 && event.xbutton.button < 3
6962 #endif
6963 && f && event.type == ButtonPress
6964 /* Verify the event is really within the menu bar
6965 and not just sent to it due to grabbing. */
6966 && event.xbutton.x >= 0
6967 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6968 && event.xbutton.y >= 0
6969 && event.xbutton.y < f->output_data.x->menubar_height
6970 && event.xbutton.same_screen)
6972 SET_SAVED_BUTTON_EVENT;
6973 XSETFRAME (last_mouse_press_frame, f);
6974 *finish = X_EVENT_DROP;
6976 else if (event.type == ButtonPress)
6978 last_mouse_press_frame = Qnil;
6979 goto OTHER;
6981 else
6982 goto OTHER;
6983 #endif /* USE_X_TOOLKIT || USE_GTK */
6985 break;
6987 case CirculateNotify:
6988 goto OTHER;
6990 case CirculateRequest:
6991 goto OTHER;
6993 case VisibilityNotify:
6994 goto OTHER;
6996 case MappingNotify:
6997 /* Someone has changed the keyboard mapping - update the
6998 local cache. */
6999 switch (event.xmapping.request)
7001 case MappingModifier:
7002 x_find_modifier_meanings (dpyinfo);
7003 /* This is meant to fall through. */
7004 case MappingKeyboard:
7005 XRefreshKeyboardMapping (&event.xmapping);
7007 goto OTHER;
7009 case DestroyNotify:
7010 xft_settings_event (dpyinfo, &event);
7011 break;
7013 default:
7014 OTHER:
7015 #ifdef USE_X_TOOLKIT
7016 block_input ();
7017 if (*finish != X_EVENT_DROP)
7018 XtDispatchEvent (&event);
7019 unblock_input ();
7020 #endif /* USE_X_TOOLKIT */
7021 break;
7024 done:
7025 if (inev.ie.kind != NO_EVENT)
7027 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7028 count++;
7031 if (do_help
7032 && !(hold_quit && hold_quit->kind != NO_EVENT))
7034 Lisp_Object frame;
7036 if (f)
7037 XSETFRAME (frame, f);
7038 else
7039 frame = Qnil;
7041 if (do_help > 0)
7043 any_help_event_p = 1;
7044 gen_help_event (help_echo_string, frame, help_echo_window,
7045 help_echo_object, help_echo_pos);
7047 else
7049 help_echo_string = Qnil;
7050 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7052 count++;
7055 SAFE_FREE ();
7056 *eventptr = event;
7057 return count;
7060 #if defined USE_GTK || defined USE_X_TOOLKIT
7062 /* Handles the XEvent EVENT on display DISPLAY.
7063 This is used for event loops outside the normal event handling,
7064 i.e. looping while a popup menu or a dialog is posted.
7066 Returns the value handle_one_xevent sets in the finish argument. */
7068 x_dispatch_event (XEvent *event, Display *display)
7070 struct x_display_info *dpyinfo;
7071 int finish = X_EVENT_NORMAL;
7073 dpyinfo = x_display_info_for_display (display);
7075 if (dpyinfo)
7076 handle_one_xevent (dpyinfo, event, &finish, 0);
7078 return finish;
7080 #endif
7083 /* Read events coming from the X server.
7084 Return as soon as there are no more events to be read.
7086 Return the number of characters stored into the buffer,
7087 thus pretending to be `read' (except the characters we store
7088 in the keyboard buffer can be multibyte, so are not necessarily
7089 C chars). */
7091 static int
7092 XTread_socket (struct terminal *terminal, struct input_event *hold_quit)
7094 int count = 0;
7095 int event_found = 0;
7097 block_input ();
7099 /* So people can tell when we have read the available input. */
7100 input_signal_count++;
7102 /* For debugging, this gives a way to fake an I/O error. */
7103 if (terminal->display_info.x == XTread_socket_fake_io_error)
7105 XTread_socket_fake_io_error = 0;
7106 x_io_error_quitter (terminal->display_info.x->display);
7109 #ifndef USE_GTK
7110 while (XPending (terminal->display_info.x->display))
7112 int finish;
7113 XEvent event;
7115 XNextEvent (terminal->display_info.x->display, &event);
7117 #ifdef HAVE_X_I18N
7118 /* Filter events for the current X input method. */
7119 if (x_filter_event (terminal->display_info.x, &event))
7120 continue;
7121 #endif
7122 event_found = 1;
7124 count += handle_one_xevent (terminal->display_info.x,
7125 &event, &finish, hold_quit);
7127 if (finish == X_EVENT_GOTO_OUT)
7128 goto out;
7131 out:;
7133 #else /* USE_GTK */
7135 /* For GTK we must use the GTK event loop. But XEvents gets passed
7136 to our filter function above, and then to the big event switch.
7137 We use a bunch of globals to communicate with our filter function,
7138 that is kind of ugly, but it works.
7140 There is no way to do one display at the time, GTK just does events
7141 from all displays. */
7143 while (gtk_events_pending ())
7145 current_count = count;
7146 current_hold_quit = hold_quit;
7148 gtk_main_iteration ();
7150 count = current_count;
7151 current_count = -1;
7152 current_hold_quit = 0;
7154 if (current_finish == X_EVENT_GOTO_OUT)
7155 break;
7157 #endif /* USE_GTK */
7159 /* On some systems, an X bug causes Emacs to get no more events
7160 when the window is destroyed. Detect that. (1994.) */
7161 if (! event_found)
7163 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7164 One XNOOP in 100 loops will make Emacs terminate.
7165 B. Bretthauer, 1994 */
7166 x_noop_count++;
7167 if (x_noop_count >= 100)
7169 x_noop_count=0;
7171 if (next_noop_dpyinfo == 0)
7172 next_noop_dpyinfo = x_display_list;
7174 XNoOp (next_noop_dpyinfo->display);
7176 /* Each time we get here, cycle through the displays now open. */
7177 next_noop_dpyinfo = next_noop_dpyinfo->next;
7181 /* If the focus was just given to an auto-raising frame,
7182 raise it now. */
7183 /* ??? This ought to be able to handle more than one such frame. */
7184 if (pending_autoraise_frame)
7186 x_raise_frame (pending_autoraise_frame);
7187 pending_autoraise_frame = 0;
7190 unblock_input ();
7192 return count;
7198 /***********************************************************************
7199 Text Cursor
7200 ***********************************************************************/
7202 /* Set clipping for output in glyph row ROW. W is the window in which
7203 we operate. GC is the graphics context to set clipping in.
7205 ROW may be a text row or, e.g., a mode line. Text rows must be
7206 clipped to the interior of the window dedicated to text display,
7207 mode lines must be clipped to the whole window. */
7209 static void
7210 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7212 struct frame *f = XFRAME (WINDOW_FRAME (w));
7213 XRectangle clip_rect;
7214 int window_x, window_y, window_width;
7216 window_box (w, area, &window_x, &window_y, &window_width, 0);
7218 clip_rect.x = window_x;
7219 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7220 clip_rect.y = max (clip_rect.y, window_y);
7221 clip_rect.width = window_width;
7222 clip_rect.height = row->visible_height;
7224 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7228 /* Draw a hollow box cursor on window W in glyph row ROW. */
7230 static void
7231 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7233 struct frame *f = XFRAME (WINDOW_FRAME (w));
7234 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7235 Display *dpy = FRAME_X_DISPLAY (f);
7236 int x, y, wd, h;
7237 XGCValues xgcv;
7238 struct glyph *cursor_glyph;
7239 GC gc;
7241 /* Get the glyph the cursor is on. If we can't tell because
7242 the current matrix is invalid or such, give up. */
7243 cursor_glyph = get_phys_cursor_glyph (w);
7244 if (cursor_glyph == NULL)
7245 return;
7247 /* Compute frame-relative coordinates for phys cursor. */
7248 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7249 wd = w->phys_cursor_width;
7251 /* The foreground of cursor_gc is typically the same as the normal
7252 background color, which can cause the cursor box to be invisible. */
7253 xgcv.foreground = f->output_data.x->cursor_pixel;
7254 if (dpyinfo->scratch_cursor_gc)
7255 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7256 else
7257 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7258 GCForeground, &xgcv);
7259 gc = dpyinfo->scratch_cursor_gc;
7261 /* Set clipping, draw the rectangle, and reset clipping again. */
7262 x_clip_to_row (w, row, TEXT_AREA, gc);
7263 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7264 XSetClipMask (dpy, gc, None);
7268 /* Draw a bar cursor on window W in glyph row ROW.
7270 Implementation note: One would like to draw a bar cursor with an
7271 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7272 Unfortunately, I didn't find a font yet that has this property set.
7273 --gerd. */
7275 static void
7276 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7278 struct frame *f = XFRAME (w->frame);
7279 struct glyph *cursor_glyph;
7281 /* If cursor is out of bounds, don't draw garbage. This can happen
7282 in mini-buffer windows when switching between echo area glyphs
7283 and mini-buffer. */
7284 cursor_glyph = get_phys_cursor_glyph (w);
7285 if (cursor_glyph == NULL)
7286 return;
7288 /* If on an image, draw like a normal cursor. That's usually better
7289 visible than drawing a bar, esp. if the image is large so that
7290 the bar might not be in the window. */
7291 if (cursor_glyph->type == IMAGE_GLYPH)
7293 struct glyph_row *r;
7294 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7295 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
7297 else
7299 Display *dpy = FRAME_X_DISPLAY (f);
7300 Window window = FRAME_X_WINDOW (f);
7301 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7302 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7303 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7304 XGCValues xgcv;
7306 /* If the glyph's background equals the color we normally draw
7307 the bars cursor in, the bar cursor in its normal color is
7308 invisible. Use the glyph's foreground color instead in this
7309 case, on the assumption that the glyph's colors are chosen so
7310 that the glyph is legible. */
7311 if (face->background == f->output_data.x->cursor_pixel)
7312 xgcv.background = xgcv.foreground = face->foreground;
7313 else
7314 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7315 xgcv.graphics_exposures = 0;
7317 if (gc)
7318 XChangeGC (dpy, gc, mask, &xgcv);
7319 else
7321 gc = XCreateGC (dpy, window, mask, &xgcv);
7322 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7325 x_clip_to_row (w, row, TEXT_AREA, gc);
7327 if (kind == BAR_CURSOR)
7329 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7331 if (width < 0)
7332 width = FRAME_CURSOR_WIDTH (f);
7333 width = min (cursor_glyph->pixel_width, width);
7335 w->phys_cursor_width = width;
7337 /* If the character under cursor is R2L, draw the bar cursor
7338 on the right of its glyph, rather than on the left. */
7339 if ((cursor_glyph->resolved_level & 1) != 0)
7340 x += cursor_glyph->pixel_width - width;
7342 XFillRectangle (dpy, window, gc, x,
7343 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7344 width, row->height);
7346 else
7348 int dummy_x, dummy_y, dummy_h;
7350 if (width < 0)
7351 width = row->height;
7353 width = min (row->height, width);
7355 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7356 &dummy_y, &dummy_h);
7358 XFillRectangle (dpy, window, gc,
7359 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7360 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7361 row->height - width),
7362 w->phys_cursor_width, width);
7365 XSetClipMask (dpy, gc, None);
7370 /* RIF: Define cursor CURSOR on frame F. */
7372 static void
7373 x_define_frame_cursor (struct frame *f, Cursor cursor)
7375 if (!f->pointer_invisible
7376 && f->output_data.x->current_cursor != cursor)
7377 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7378 f->output_data.x->current_cursor = cursor;
7382 /* RIF: Clear area on frame F. */
7384 static void
7385 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7387 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7388 x, y, width, height, False);
7389 #ifdef USE_GTK
7390 /* Must queue a redraw, because scroll bars might have been cleared. */
7391 if (FRAME_GTK_WIDGET (f))
7392 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7393 #endif
7397 /* RIF: Draw cursor on window W. */
7399 static void
7400 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)
7402 struct frame *f = XFRAME (WINDOW_FRAME (w));
7404 if (on_p)
7406 w->phys_cursor_type = cursor_type;
7407 w->phys_cursor_on_p = 1;
7409 if (glyph_row->exact_window_width_line_p
7410 && (glyph_row->reversed_p
7411 ? (w->phys_cursor.hpos < 0)
7412 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7414 glyph_row->cursor_in_fringe_p = 1;
7415 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7417 else
7419 switch (cursor_type)
7421 case HOLLOW_BOX_CURSOR:
7422 x_draw_hollow_cursor (w, glyph_row);
7423 break;
7425 case FILLED_BOX_CURSOR:
7426 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7427 break;
7429 case BAR_CURSOR:
7430 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7431 break;
7433 case HBAR_CURSOR:
7434 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7435 break;
7437 case NO_CURSOR:
7438 w->phys_cursor_width = 0;
7439 break;
7441 default:
7442 emacs_abort ();
7446 #ifdef HAVE_X_I18N
7447 if (w == XWINDOW (f->selected_window))
7448 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7449 xic_set_preeditarea (w, x, y);
7450 #endif
7453 #ifndef XFlush
7454 XFlush (FRAME_X_DISPLAY (f));
7455 #endif
7459 /* Icons. */
7461 /* Make the x-window of frame F use the gnu icon bitmap. */
7464 x_bitmap_icon (struct frame *f, Lisp_Object file)
7466 ptrdiff_t bitmap_id;
7468 if (FRAME_X_WINDOW (f) == 0)
7469 return 1;
7471 /* Free up our existing icon bitmap and mask if any. */
7472 if (f->output_data.x->icon_bitmap > 0)
7473 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7474 f->output_data.x->icon_bitmap = 0;
7476 if (STRINGP (file))
7478 #ifdef USE_GTK
7479 /* Use gtk_window_set_icon_from_file () if available,
7480 It's not restricted to bitmaps */
7481 if (xg_set_icon (f, file))
7482 return 0;
7483 #endif /* USE_GTK */
7484 bitmap_id = x_create_bitmap_from_file (f, file);
7485 x_create_bitmap_mask (f, bitmap_id);
7487 else
7489 /* Create the GNU bitmap and mask if necessary. */
7490 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7492 ptrdiff_t rc = -1;
7494 #ifdef USE_GTK
7496 if (xg_set_icon (f, xg_default_icon_file)
7497 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7498 return 0;
7500 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7502 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7503 if (rc != -1)
7504 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7506 #endif
7508 /* If all else fails, use the (black and white) xbm image. */
7509 if (rc == -1)
7511 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
7512 gnu_xbm_width, gnu_xbm_height);
7513 if (rc == -1)
7514 return 1;
7516 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7517 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7521 /* The first time we create the GNU bitmap and mask,
7522 this increments the ref-count one extra time.
7523 As a result, the GNU bitmap and mask are never freed.
7524 That way, we don't have to worry about allocating it again. */
7525 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7527 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7530 x_wm_set_icon_pixmap (f, bitmap_id);
7531 f->output_data.x->icon_bitmap = bitmap_id;
7533 return 0;
7537 /* Make the x-window of frame F use a rectangle with text.
7538 Use ICON_NAME as the text. */
7541 x_text_icon (struct frame *f, const char *icon_name)
7543 if (FRAME_X_WINDOW (f) == 0)
7544 return 1;
7547 XTextProperty text;
7548 text.value = (unsigned char *) icon_name;
7549 text.encoding = XA_STRING;
7550 text.format = 8;
7551 text.nitems = strlen (icon_name);
7552 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7555 if (f->output_data.x->icon_bitmap > 0)
7556 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7557 f->output_data.x->icon_bitmap = 0;
7558 x_wm_set_icon_pixmap (f, 0);
7560 return 0;
7563 #define X_ERROR_MESSAGE_SIZE 200
7565 /* If non-nil, this should be a string.
7566 It means catch X errors and store the error message in this string.
7568 The reason we use a stack is that x_catch_error/x_uncatch_error can
7569 be called from a signal handler.
7572 struct x_error_message_stack {
7573 char string[X_ERROR_MESSAGE_SIZE];
7574 Display *dpy;
7575 struct x_error_message_stack *prev;
7577 static struct x_error_message_stack *x_error_message;
7579 /* An X error handler which stores the error message in
7580 *x_error_message. This is called from x_error_handler if
7581 x_catch_errors is in effect. */
7583 static void
7584 x_error_catcher (Display *display, XErrorEvent *event)
7586 XGetErrorText (display, event->error_code,
7587 x_error_message->string,
7588 X_ERROR_MESSAGE_SIZE);
7591 /* Begin trapping X errors for display DPY. Actually we trap X errors
7592 for all displays, but DPY should be the display you are actually
7593 operating on.
7595 After calling this function, X protocol errors no longer cause
7596 Emacs to exit; instead, they are recorded in the string
7597 stored in *x_error_message.
7599 Calling x_check_errors signals an Emacs error if an X error has
7600 occurred since the last call to x_catch_errors or x_check_errors.
7602 Calling x_uncatch_errors resumes the normal error handling. */
7604 void
7605 x_catch_errors (Display *dpy)
7607 struct x_error_message_stack *data = xmalloc (sizeof *data);
7609 /* Make sure any errors from previous requests have been dealt with. */
7610 XSync (dpy, False);
7612 data->dpy = dpy;
7613 data->string[0] = 0;
7614 data->prev = x_error_message;
7615 x_error_message = data;
7618 /* Undo the last x_catch_errors call.
7619 DPY should be the display that was passed to x_catch_errors. */
7621 void
7622 x_uncatch_errors (void)
7624 struct x_error_message_stack *tmp;
7626 block_input ();
7628 /* The display may have been closed before this function is called.
7629 Check if it is still open before calling XSync. */
7630 if (x_display_info_for_display (x_error_message->dpy) != 0)
7631 XSync (x_error_message->dpy, False);
7633 tmp = x_error_message;
7634 x_error_message = x_error_message->prev;
7635 xfree (tmp);
7636 unblock_input ();
7639 /* If any X protocol errors have arrived since the last call to
7640 x_catch_errors or x_check_errors, signal an Emacs error using
7641 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7643 void
7644 x_check_errors (Display *dpy, const char *format)
7646 /* Make sure to catch any errors incurred so far. */
7647 XSync (dpy, False);
7649 if (x_error_message->string[0])
7651 char string[X_ERROR_MESSAGE_SIZE];
7652 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7653 x_uncatch_errors ();
7654 error (format, string);
7658 /* Nonzero if we had any X protocol errors
7659 since we did x_catch_errors on DPY. */
7662 x_had_errors_p (Display *dpy)
7664 /* Make sure to catch any errors incurred so far. */
7665 XSync (dpy, False);
7667 return x_error_message->string[0] != 0;
7670 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7672 void
7673 x_clear_errors (Display *dpy)
7675 x_error_message->string[0] = 0;
7678 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7679 * idea. --lorentey */
7680 /* Close off all unclosed x_catch_errors calls. */
7682 void
7683 x_fully_uncatch_errors (void)
7685 while (x_error_message)
7686 x_uncatch_errors ();
7688 #endif
7690 #if 0
7691 static unsigned int x_wire_count;
7692 x_trace_wire (void)
7694 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7696 #endif /* ! 0 */
7699 /************************************************************************
7700 Handling X errors
7701 ************************************************************************/
7703 /* Error message passed to x_connection_closed. */
7705 static char *error_msg;
7707 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7708 the text of an error message that lead to the connection loss. */
7710 static void
7711 x_connection_closed (Display *dpy, const char *error_message)
7713 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7714 Lisp_Object frame, tail;
7715 ptrdiff_t idx = SPECPDL_INDEX ();
7717 error_msg = alloca (strlen (error_message) + 1);
7718 strcpy (error_msg, error_message);
7720 /* Inhibit redisplay while frames are being deleted. */
7721 specbind (Qinhibit_redisplay, Qt);
7723 if (dpyinfo)
7725 /* Protect display from being closed when we delete the last
7726 frame on it. */
7727 dpyinfo->reference_count++;
7728 dpyinfo->terminal->reference_count++;
7731 /* First delete frames whose mini-buffers are on frames
7732 that are on the dead display. */
7733 FOR_EACH_FRAME (tail, frame)
7735 Lisp_Object minibuf_frame;
7736 minibuf_frame
7737 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7738 if (FRAME_X_P (XFRAME (frame))
7739 && FRAME_X_P (XFRAME (minibuf_frame))
7740 && ! EQ (frame, minibuf_frame)
7741 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7742 delete_frame (frame, Qnoelisp);
7745 /* Now delete all remaining frames on the dead display.
7746 We are now sure none of these is used as the mini-buffer
7747 for another frame that we need to delete. */
7748 FOR_EACH_FRAME (tail, frame)
7749 if (FRAME_X_P (XFRAME (frame))
7750 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7752 /* Set this to t so that delete_frame won't get confused
7753 trying to find a replacement. */
7754 kset_default_minibuffer_frame (FRAME_KBOARD (XFRAME (frame)), Qt);
7755 delete_frame (frame, Qnoelisp);
7758 /* If DPYINFO is null, this means we didn't open the display in the
7759 first place, so don't try to close it. */
7760 if (dpyinfo)
7762 /* We can not call XtCloseDisplay here because it calls XSync.
7763 XSync inside the error handler apparently hangs Emacs. On
7764 current Xt versions, this isn't needed either. */
7765 #ifdef USE_GTK
7766 /* A long-standing GTK bug prevents proper disconnect handling
7767 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7768 the resulting Glib error message loop filled a user's disk.
7769 To avoid this, kill Emacs unconditionally on disconnect. */
7770 shut_down_emacs (0, Qnil);
7771 fprintf (stderr, "%s\n\
7772 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7773 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7774 For details, see etc/PROBLEMS.\n",
7775 error_msg);
7776 emacs_abort ();
7777 #endif /* USE_GTK */
7779 /* Indicate that this display is dead. */
7780 dpyinfo->display = 0;
7782 dpyinfo->reference_count--;
7783 dpyinfo->terminal->reference_count--;
7784 if (dpyinfo->reference_count != 0)
7785 /* We have just closed all frames on this display. */
7786 emacs_abort ();
7789 Lisp_Object tmp;
7790 XSETTERMINAL (tmp, dpyinfo->terminal);
7791 Fdelete_terminal (tmp, Qnoelisp);
7795 if (terminal_list == 0)
7797 fprintf (stderr, "%s\n", error_msg);
7798 Fkill_emacs (make_number (70));
7799 /* NOTREACHED */
7802 totally_unblock_input ();
7804 unbind_to (idx, Qnil);
7805 clear_waiting_for_input ();
7807 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
7808 IF_LINT (if (! terminal_list) return; )
7810 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7811 longjmp), because returning from this function would get us back into
7812 Xlib's code which will directly call `exit'. */
7813 error ("%s", error_msg);
7816 /* We specifically use it before defining it, so that gcc doesn't inline it,
7817 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7818 static void x_error_quitter (Display *, XErrorEvent *);
7820 /* This is the first-level handler for X protocol errors.
7821 It calls x_error_quitter or x_error_catcher. */
7823 static int
7824 x_error_handler (Display *display, XErrorEvent *event)
7826 #if defined USE_GTK && defined HAVE_GTK3
7827 if (event->error_code == BadMatch
7828 && event->request_code == X_SetInputFocus
7829 && event->minor_code == 0)
7831 return 0;
7833 #endif
7835 if (x_error_message)
7836 x_error_catcher (display, event);
7837 else
7838 x_error_quitter (display, event);
7839 return 0;
7842 /* This is the usual handler for X protocol errors.
7843 It kills all frames on the display that we got the error for.
7844 If that was the only one, it prints an error message and kills Emacs. */
7846 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7848 /* On older GCC versions, just putting x_error_quitter
7849 after x_error_handler prevents inlining into the former. */
7851 static void NO_INLINE
7852 x_error_quitter (Display *display, XErrorEvent *event)
7854 char buf[256], buf1[356];
7856 /* Ignore BadName errors. They can happen because of fonts
7857 or colors that are not defined. */
7859 if (event->error_code == BadName)
7860 return;
7862 /* Note that there is no real way portable across R3/R4 to get the
7863 original error handler. */
7865 XGetErrorText (display, event->error_code, buf, sizeof (buf));
7866 sprintf (buf1, "X protocol error: %s on protocol request %d",
7867 buf, event->request_code);
7868 x_connection_closed (display, buf1);
7872 /* This is the handler for X IO errors, always.
7873 It kills all frames on the display that we lost touch with.
7874 If that was the only one, it prints an error message and kills Emacs. */
7876 static int
7877 x_io_error_quitter (Display *display)
7879 char buf[256];
7881 snprintf (buf, sizeof buf, "Connection lost to X server `%s'",
7882 DisplayString (display));
7883 x_connection_closed (display, buf);
7884 return 0;
7887 /* Changing the font of the frame. */
7889 /* Give frame F the font FONT-OBJECT as its default font. The return
7890 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7891 frame. If it is negative, generate a new fontset from
7892 FONT-OBJECT. */
7894 Lisp_Object
7895 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7897 struct font *font = XFONT_OBJECT (font_object);
7899 if (fontset < 0)
7900 fontset = fontset_from_font (font_object);
7901 FRAME_FONTSET (f) = fontset;
7902 if (FRAME_FONT (f) == font)
7903 /* This font is already set in frame F. There's nothing more to
7904 do. */
7905 return font_object;
7907 FRAME_FONT (f) = font;
7908 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7909 FRAME_COLUMN_WIDTH (f) = font->average_width;
7910 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7912 compute_fringe_widths (f, 1);
7914 /* Compute the scroll bar width in character columns. */
7915 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7917 int wid = FRAME_COLUMN_WIDTH (f);
7918 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7919 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7921 else
7923 int wid = FRAME_COLUMN_WIDTH (f);
7924 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7927 if (FRAME_X_WINDOW (f) != 0)
7929 /* Don't change the size of a tip frame; there's no point in
7930 doing it because it's done in Fx_show_tip, and it leads to
7931 problems because the tip frame has no widget. */
7932 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7933 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7936 #ifdef HAVE_X_I18N
7937 if (FRAME_XIC (f)
7938 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7940 block_input ();
7941 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7942 unblock_input ();
7944 #endif
7946 return font_object;
7950 /***********************************************************************
7951 X Input Methods
7952 ***********************************************************************/
7954 #ifdef HAVE_X_I18N
7956 #ifdef HAVE_X11R6
7958 /* XIM destroy callback function, which is called whenever the
7959 connection to input method XIM dies. CLIENT_DATA contains a
7960 pointer to the x_display_info structure corresponding to XIM. */
7962 static void
7963 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7965 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7966 Lisp_Object frame, tail;
7968 block_input ();
7970 /* No need to call XDestroyIC.. */
7971 FOR_EACH_FRAME (tail, frame)
7973 struct frame *f = XFRAME (frame);
7974 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7976 FRAME_XIC (f) = NULL;
7977 xic_free_xfontset (f);
7981 /* No need to call XCloseIM. */
7982 dpyinfo->xim = NULL;
7983 XFree (dpyinfo->xim_styles);
7984 unblock_input ();
7987 #endif /* HAVE_X11R6 */
7989 #ifdef HAVE_X11R6
7990 /* This isn't prototyped in OSF 5.0 or 5.1a. */
7991 extern char *XSetIMValues (XIM, ...);
7992 #endif
7994 /* Open the connection to the XIM server on display DPYINFO.
7995 RESOURCE_NAME is the resource name Emacs uses. */
7997 static void
7998 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
8000 XIM xim;
8002 #ifdef HAVE_XIM
8003 if (use_xim)
8005 if (dpyinfo->xim)
8006 XCloseIM (dpyinfo->xim);
8007 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8008 emacs_class);
8009 dpyinfo->xim = xim;
8011 if (xim)
8013 #ifdef HAVE_X11R6
8014 XIMCallback destroy;
8015 #endif
8017 /* Get supported styles and XIM values. */
8018 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8020 #ifdef HAVE_X11R6
8021 destroy.callback = xim_destroy_callback;
8022 destroy.client_data = (XPointer)dpyinfo;
8023 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8024 #endif
8028 else
8029 #endif /* HAVE_XIM */
8030 dpyinfo->xim = NULL;
8034 #ifdef HAVE_X11R6_XIM
8036 /* XIM instantiate callback function, which is called whenever an XIM
8037 server is available. DISPLAY is the display of the XIM.
8038 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8039 when the callback was registered. */
8041 static void
8042 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8044 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8045 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8047 /* We don't support multiple XIM connections. */
8048 if (dpyinfo->xim)
8049 return;
8051 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8053 /* Create XIC for the existing frames on the same display, as long
8054 as they have no XIC. */
8055 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8057 Lisp_Object tail, frame;
8059 block_input ();
8060 FOR_EACH_FRAME (tail, frame)
8062 struct frame *f = XFRAME (frame);
8064 if (FRAME_X_P (f)
8065 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8066 if (FRAME_XIC (f) == NULL)
8068 create_frame_xic (f);
8069 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8070 xic_set_statusarea (f);
8071 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8073 struct window *w = XWINDOW (f->selected_window);
8074 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8079 unblock_input ();
8083 #endif /* HAVE_X11R6_XIM */
8086 /* Open a connection to the XIM server on display DPYINFO.
8087 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8088 connection only at the first time. On X11R6, open the connection
8089 in the XIM instantiate callback function. */
8091 static void
8092 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8094 dpyinfo->xim = NULL;
8095 #ifdef HAVE_XIM
8096 if (use_xim)
8098 #ifdef HAVE_X11R6_XIM
8099 struct xim_inst_t *xim_inst = xmalloc (sizeof *xim_inst);
8100 ptrdiff_t len;
8102 dpyinfo->xim_callback_data = xim_inst;
8103 xim_inst->dpyinfo = dpyinfo;
8104 len = strlen (resource_name);
8105 xim_inst->resource_name = xmalloc (len + 1);
8106 memcpy (xim_inst->resource_name, resource_name, len + 1);
8107 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8108 resource_name, emacs_class,
8109 xim_instantiate_callback,
8110 /* This is XPointer in XFree86
8111 but (XPointer *) on Tru64, at
8112 least, hence the configure test. */
8113 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8114 #else /* not HAVE_X11R6_XIM */
8115 xim_open_dpy (dpyinfo, resource_name);
8116 #endif /* not HAVE_X11R6_XIM */
8118 #endif /* HAVE_XIM */
8122 /* Close the connection to the XIM server on display DPYINFO. */
8124 static void
8125 xim_close_dpy (struct x_display_info *dpyinfo)
8127 #ifdef HAVE_XIM
8128 if (use_xim)
8130 #ifdef HAVE_X11R6_XIM
8131 if (dpyinfo->display)
8132 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8133 NULL, emacs_class,
8134 xim_instantiate_callback, NULL);
8135 xfree (dpyinfo->xim_callback_data->resource_name);
8136 xfree (dpyinfo->xim_callback_data);
8137 #endif /* HAVE_X11R6_XIM */
8138 if (dpyinfo->display)
8139 XCloseIM (dpyinfo->xim);
8140 dpyinfo->xim = NULL;
8141 XFree (dpyinfo->xim_styles);
8143 #endif /* HAVE_XIM */
8146 #endif /* not HAVE_X11R6_XIM */
8150 /* Calculate the absolute position in frame F
8151 from its current recorded position values and gravity. */
8153 static void
8154 x_calc_absolute_position (struct frame *f)
8156 int flags = f->size_hint_flags;
8158 /* We have nothing to do if the current position
8159 is already for the top-left corner. */
8160 if (! ((flags & XNegative) || (flags & YNegative)))
8161 return;
8163 /* Treat negative positions as relative to the leftmost bottommost
8164 position that fits on the screen. */
8165 if (flags & XNegative)
8166 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8167 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8170 int height = FRAME_PIXEL_HEIGHT (f);
8172 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8173 /* Something is fishy here. When using Motif, starting Emacs with
8174 `-g -0-0', the frame appears too low by a few pixels.
8176 This seems to be so because initially, while Emacs is starting,
8177 the column widget's height and the frame's pixel height are
8178 different. The column widget's height is the right one. In
8179 later invocations, when Emacs is up, the frame's pixel height
8180 is right, though.
8182 It's not obvious where the initial small difference comes from.
8183 2000-12-01, gerd. */
8185 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8186 #endif
8188 if (flags & YNegative)
8189 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8190 - height + f->top_pos;
8193 /* The left_pos and top_pos
8194 are now relative to the top and left screen edges,
8195 so the flags should correspond. */
8196 f->size_hint_flags &= ~ (XNegative | YNegative);
8199 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8200 to really change the position, and 0 when calling from
8201 x_make_frame_visible (in that case, XOFF and YOFF are the current
8202 position values). It is -1 when calling from x_set_frame_parameters,
8203 which means, do adjust for borders but don't change the gravity. */
8205 void
8206 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8208 int modified_top, modified_left;
8210 if (change_gravity > 0)
8212 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8213 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8215 f->top_pos = yoff;
8216 f->left_pos = xoff;
8217 f->size_hint_flags &= ~ (XNegative | YNegative);
8218 if (xoff < 0)
8219 f->size_hint_flags |= XNegative;
8220 if (yoff < 0)
8221 f->size_hint_flags |= YNegative;
8222 f->win_gravity = NorthWestGravity;
8224 x_calc_absolute_position (f);
8226 block_input ();
8227 x_wm_set_size_hint (f, (long) 0, 0);
8229 modified_left = f->left_pos;
8230 modified_top = f->top_pos;
8232 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8234 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8235 than the WM decorations. So we use the calculated offset instead
8236 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8237 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8238 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8241 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8242 modified_left, modified_top);
8244 x_sync_with_move (f, f->left_pos, f->top_pos,
8245 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8246 ? 1 : 0);
8248 /* change_gravity is non-zero when this function is called from Lisp to
8249 programmatically move a frame. In that case, we call
8250 x_check_expected_move to discover if we have a "Type A" or "Type B"
8251 window manager, and, for a "Type A" window manager, adjust the position
8252 of the frame.
8254 We call x_check_expected_move if a programmatic move occurred, and
8255 either the window manager type (A/B) is unknown or it is Type A but we
8256 need to compute the top/left offset adjustment for this frame. */
8258 if (change_gravity != 0 &&
8259 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8260 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8261 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8262 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8263 x_check_expected_move (f, modified_left, modified_top);
8265 unblock_input ();
8268 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8269 on the root window for frame F contains ATOMNAME.
8270 This is how a WM check shall be done according to the Window Manager
8271 Specification/Extended Window Manager Hints at
8272 http://freedesktop.org/wiki/Specifications/wm-spec. */
8274 static int
8275 wm_supports (struct frame *f, Atom want_atom)
8277 Atom actual_type;
8278 unsigned long actual_size, bytes_remaining;
8279 int i, rc, actual_format;
8280 Window wmcheck_window;
8281 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8282 Window target_window = dpyinfo->root_window;
8283 long max_len = 65536;
8284 Display *dpy = FRAME_X_DISPLAY (f);
8285 unsigned char *tmp_data = NULL;
8286 Atom target_type = XA_WINDOW;
8288 block_input ();
8290 x_catch_errors (dpy);
8291 rc = XGetWindowProperty (dpy, target_window,
8292 dpyinfo->Xatom_net_supporting_wm_check,
8293 0, max_len, False, target_type,
8294 &actual_type, &actual_format, &actual_size,
8295 &bytes_remaining, &tmp_data);
8297 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8299 if (tmp_data) XFree (tmp_data);
8300 x_uncatch_errors ();
8301 unblock_input ();
8302 return 0;
8305 wmcheck_window = *(Window *) tmp_data;
8306 XFree (tmp_data);
8308 /* Check if window exists. */
8309 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8310 x_sync (f);
8311 if (x_had_errors_p (dpy))
8313 x_uncatch_errors ();
8314 unblock_input ();
8315 return 0;
8318 if (dpyinfo->net_supported_window != wmcheck_window)
8320 /* Window changed, reload atoms */
8321 if (dpyinfo->net_supported_atoms != NULL)
8322 XFree (dpyinfo->net_supported_atoms);
8323 dpyinfo->net_supported_atoms = NULL;
8324 dpyinfo->nr_net_supported_atoms = 0;
8325 dpyinfo->net_supported_window = 0;
8327 target_type = XA_ATOM;
8328 tmp_data = NULL;
8329 rc = XGetWindowProperty (dpy, target_window,
8330 dpyinfo->Xatom_net_supported,
8331 0, max_len, False, target_type,
8332 &actual_type, &actual_format, &actual_size,
8333 &bytes_remaining, &tmp_data);
8335 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8337 if (tmp_data) XFree (tmp_data);
8338 x_uncatch_errors ();
8339 unblock_input ();
8340 return 0;
8343 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8344 dpyinfo->nr_net_supported_atoms = actual_size;
8345 dpyinfo->net_supported_window = wmcheck_window;
8348 rc = 0;
8350 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8351 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8353 x_uncatch_errors ();
8354 unblock_input ();
8356 return rc;
8359 static void
8360 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8362 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8364 x_send_client_event (frame, make_number (0), frame,
8365 dpyinfo->Xatom_net_wm_state,
8366 make_number (32),
8367 /* 1 = add, 0 = remove */
8368 Fcons
8369 (make_number (add ? 1 : 0),
8370 Fcons
8371 (make_fixnum_or_float (atom),
8372 value != 0
8373 ? Fcons (make_fixnum_or_float (value), Qnil)
8374 : Qnil)));
8377 void
8378 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8380 Lisp_Object frame;
8381 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8383 XSETFRAME (frame, f);
8385 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8386 dpyinfo->Xatom_net_wm_state_sticky, None);
8389 /* Return the current _NET_WM_STATE.
8390 SIZE_STATE is set to one of the FULLSCREEN_* values.
8391 STICKY is set to 1 if the sticky state is set, 0 if not.
8393 Return non-zero if we are not hidden, zero if we are. */
8395 static int
8396 get_current_wm_state (struct frame *f,
8397 Window window,
8398 int *size_state,
8399 int *sticky)
8401 Atom actual_type;
8402 unsigned long actual_size, bytes_remaining;
8403 int i, rc, actual_format, is_hidden = 0;
8404 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8405 long max_len = 65536;
8406 Display *dpy = FRAME_X_DISPLAY (f);
8407 unsigned char *tmp_data = NULL;
8408 Atom target_type = XA_ATOM;
8410 *sticky = 0;
8411 *size_state = FULLSCREEN_NONE;
8413 block_input ();
8414 x_catch_errors (dpy);
8415 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8416 0, max_len, False, target_type,
8417 &actual_type, &actual_format, &actual_size,
8418 &bytes_remaining, &tmp_data);
8420 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8422 if (tmp_data) XFree (tmp_data);
8423 x_uncatch_errors ();
8424 unblock_input ();
8425 return !FRAME_ICONIFIED_P (f);
8428 x_uncatch_errors ();
8430 for (i = 0; i < actual_size; ++i)
8432 Atom a = ((Atom*)tmp_data)[i];
8433 if (a == dpyinfo->Xatom_net_wm_state_hidden)
8435 is_hidden = 1;
8436 f->output_data.x->net_wm_state_hidden_seen = 1;
8438 else if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8440 if (*size_state == FULLSCREEN_HEIGHT)
8441 *size_state = FULLSCREEN_MAXIMIZED;
8442 else
8443 *size_state = FULLSCREEN_WIDTH;
8445 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8447 if (*size_state == FULLSCREEN_WIDTH)
8448 *size_state = FULLSCREEN_MAXIMIZED;
8449 else
8450 *size_state = FULLSCREEN_HEIGHT;
8452 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8453 *size_state = FULLSCREEN_BOTH;
8454 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8455 *sticky = 1;
8458 if (tmp_data) XFree (tmp_data);
8459 unblock_input ();
8460 return ! is_hidden;
8463 /* Do fullscreen as specified in extended window manager hints */
8465 static int
8466 do_ewmh_fullscreen (struct frame *f)
8468 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8469 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8470 int cur, dummy;
8472 (void)get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8474 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8475 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8476 if (!have_net_atom)
8477 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8479 if (have_net_atom && cur != f->want_fullscreen)
8481 Lisp_Object frame;
8483 XSETFRAME (frame, f);
8485 /* Keep number of calls to set_wm_state as low as possible.
8486 Some window managers, or possible Gtk+, hangs when too many
8487 are sent at once. */
8488 switch (f->want_fullscreen)
8490 case FULLSCREEN_BOTH:
8491 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8492 || cur == FULLSCREEN_HEIGHT)
8493 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8494 dpyinfo->Xatom_net_wm_state_maximized_vert);
8495 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8496 break;
8497 case FULLSCREEN_WIDTH:
8498 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8499 || cur == FULLSCREEN_MAXIMIZED)
8500 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8501 dpyinfo->Xatom_net_wm_state_maximized_vert);
8502 if (cur != FULLSCREEN_MAXIMIZED)
8503 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8504 break;
8505 case FULLSCREEN_HEIGHT:
8506 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8507 || cur == FULLSCREEN_MAXIMIZED)
8508 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8509 dpyinfo->Xatom_net_wm_state_maximized_horz);
8510 if (cur != FULLSCREEN_MAXIMIZED)
8511 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8512 break;
8513 case FULLSCREEN_MAXIMIZED:
8514 if (cur == FULLSCREEN_BOTH)
8515 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8516 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8517 dpyinfo->Xatom_net_wm_state_maximized_vert);
8518 break;
8519 case FULLSCREEN_NONE:
8520 if (cur == FULLSCREEN_BOTH)
8521 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8522 else
8523 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8524 dpyinfo->Xatom_net_wm_state_maximized_vert);
8527 f->want_fullscreen = FULLSCREEN_NONE;
8531 return have_net_atom;
8534 static void
8535 XTfullscreen_hook (FRAME_PTR f)
8537 if (FRAME_VISIBLE_P (f))
8539 block_input ();
8540 x_check_fullscreen (f);
8541 x_sync (f);
8542 unblock_input ();
8547 static int
8548 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8550 int value = FULLSCREEN_NONE;
8551 Lisp_Object lval;
8552 int sticky = 0;
8553 int not_hidden = get_current_wm_state (f, event->window, &value, &sticky);
8555 lval = Qnil;
8556 switch (value)
8558 case FULLSCREEN_WIDTH:
8559 lval = Qfullwidth;
8560 break;
8561 case FULLSCREEN_HEIGHT:
8562 lval = Qfullheight;
8563 break;
8564 case FULLSCREEN_BOTH:
8565 lval = Qfullboth;
8566 break;
8567 case FULLSCREEN_MAXIMIZED:
8568 lval = Qmaximized;
8569 break;
8572 store_frame_param (f, Qfullscreen, lval);
8573 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8575 return not_hidden;
8578 /* Check if we need to resize the frame due to a fullscreen request.
8579 If so needed, resize the frame. */
8580 static void
8581 x_check_fullscreen (struct frame *f)
8583 if (do_ewmh_fullscreen (f))
8584 return;
8586 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8587 return; /* Only fullscreen without WM or with EWM hints (above). */
8589 /* Setting fullscreen to nil doesn't do anything. We could save the
8590 last non-fullscreen size and restore it, but it seems like a
8591 lot of work for this unusual case (no window manager running). */
8593 if (f->want_fullscreen != FULLSCREEN_NONE)
8595 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8596 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8598 switch (f->want_fullscreen)
8600 /* No difference between these two when there is no WM */
8601 case FULLSCREEN_BOTH:
8602 case FULLSCREEN_MAXIMIZED:
8603 width = x_display_pixel_width (dpyinfo);
8604 height = x_display_pixel_height (dpyinfo);
8605 break;
8606 case FULLSCREEN_WIDTH:
8607 width = x_display_pixel_width (dpyinfo);
8608 break;
8609 case FULLSCREEN_HEIGHT:
8610 height = x_display_pixel_height (dpyinfo);
8613 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8614 width, height);
8618 /* This function is called by x_set_offset to determine whether the window
8619 manager interfered with the positioning of the frame. Type A window
8620 managers position the surrounding window manager decorations a small
8621 amount above and left of the user-supplied position. Type B window
8622 managers position the surrounding window manager decorations at the
8623 user-specified position. If we detect a Type A window manager, we
8624 compensate by moving the window right and down by the proper amount. */
8626 static void
8627 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8629 int current_left = 0, current_top = 0;
8631 /* x_real_positions returns the left and top offsets of the outermost
8632 window manager window around the frame. */
8634 x_real_positions (f, &current_left, &current_top);
8636 if (current_left != expected_left || current_top != expected_top)
8638 /* It's a "Type A" window manager. */
8640 int adjusted_left;
8641 int adjusted_top;
8643 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8644 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8645 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8647 /* Now fix the mispositioned frame's location. */
8649 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8650 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8652 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8653 adjusted_left, adjusted_top);
8655 x_sync_with_move (f, expected_left, expected_top, 0);
8657 else
8658 /* It's a "Type B" window manager. We don't have to adjust the
8659 frame's position. */
8661 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8665 /* Wait for XGetGeometry to return up-to-date position information for a
8666 recently-moved frame. Call this immediately after calling XMoveWindow.
8667 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8668 frame has been moved to, so we use a fuzzy position comparison instead
8669 of an exact comparison. */
8671 static void
8672 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8674 int count = 0;
8676 while (count++ < 50)
8678 int current_left = 0, current_top = 0;
8680 /* In theory, this call to XSync only needs to happen once, but in
8681 practice, it doesn't seem to work, hence the need for the surrounding
8682 loop. */
8684 XSync (FRAME_X_DISPLAY (f), False);
8685 x_real_positions (f, &current_left, &current_top);
8687 if (fuzzy)
8689 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8690 pixels. */
8692 if (eabs (current_left - left) <= 10
8693 && eabs (current_top - top) <= 40)
8694 return;
8696 else if (current_left == left && current_top == top)
8697 return;
8700 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8701 will then return up-to-date position info. */
8703 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8707 /* Wait for an event on frame F matching EVENTTYPE. */
8708 void
8709 x_wait_for_event (struct frame *f, int eventtype)
8711 int level = interrupt_input_blocked;
8713 SELECT_TYPE fds;
8714 EMACS_TIME tmo, tmo_at, time_now;
8715 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8717 pending_event_wait.f = f;
8718 pending_event_wait.eventtype = eventtype;
8720 /* Set timeout to 0.1 second. Hopefully not noticeable.
8721 Maybe it should be configurable. */
8722 tmo = make_emacs_time (0, 100 * 1000 * 1000);
8723 tmo_at = add_emacs_time (current_emacs_time (), tmo);
8725 while (pending_event_wait.eventtype)
8727 pending_signals = 1;
8728 totally_unblock_input ();
8729 /* XTread_socket is called after unblock. */
8730 block_input ();
8731 interrupt_input_blocked = level;
8733 FD_ZERO (&fds);
8734 FD_SET (fd, &fds);
8736 time_now = current_emacs_time ();
8737 if (EMACS_TIME_LT (tmo_at, time_now))
8738 break;
8740 tmo = sub_emacs_time (tmo_at, time_now);
8741 if (pselect (fd + 1, &fds, NULL, NULL, &tmo, NULL) == 0)
8742 break; /* Timeout */
8744 pending_event_wait.f = 0;
8745 pending_event_wait.eventtype = 0;
8749 /* Change the size of frame F's X window to COLS/ROWS in the case F
8750 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8751 top-left-corner window gravity for this size change and subsequent
8752 size changes. Otherwise we leave the window gravity unchanged. */
8754 static void
8755 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8757 int pixelwidth, pixelheight;
8759 check_frame_size (f, &rows, &cols);
8760 f->scroll_bar_actual_width
8761 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8763 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8765 compute_fringe_widths (f, 0);
8767 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8768 + FRAME_TOOLBAR_WIDTH (f);
8769 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8770 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8772 if (change_gravity) f->win_gravity = NorthWestGravity;
8773 x_wm_set_size_hint (f, (long) 0, 0);
8774 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8775 pixelwidth, pixelheight);
8778 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8779 receive in the ConfigureNotify event; if we get what we asked
8780 for, then the event won't cause the screen to become garbaged, so
8781 we have to make sure to do it here. */
8782 SET_FRAME_GARBAGED (f);
8784 /* Now, strictly speaking, we can't be sure that this is accurate,
8785 but the window manager will get around to dealing with the size
8786 change request eventually, and we'll hear how it went when the
8787 ConfigureNotify event gets here.
8789 We could just not bother storing any of this information here,
8790 and let the ConfigureNotify event set everything up, but that
8791 might be kind of confusing to the Lisp code, since size changes
8792 wouldn't be reported in the frame parameters until some random
8793 point in the future when the ConfigureNotify event arrives.
8795 We pass 1 for DELAY since we can't run Lisp code inside of
8796 a BLOCK_INPUT. */
8798 /* But the ConfigureNotify may in fact never arrive, and then this is
8799 not right if the frame is visible. Instead wait (with timeout)
8800 for the ConfigureNotify. */
8801 if (FRAME_VISIBLE_P (f))
8802 x_wait_for_event (f, ConfigureNotify);
8803 else
8805 change_frame_size (f, rows, cols, 0, 1, 0);
8806 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8807 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8808 x_sync (f);
8813 /* Call this to change the size of frame F's x-window.
8814 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8815 for this size change and subsequent size changes.
8816 Otherwise we leave the window gravity unchanged. */
8818 void
8819 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8821 block_input ();
8823 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8825 int r, c;
8827 /* When the frame is maximized/fullscreen or running under for
8828 example Xmonad, x_set_window_size_1 will be a no-op.
8829 In that case, the right thing to do is extend rows/cols to
8830 the current frame size. We do that first if x_set_window_size_1
8831 turns out to not be a no-op (there is no way to know).
8832 The size will be adjusted again if the frame gets a
8833 ConfigureNotify event as a result of x_set_window_size. */
8834 int pixelh = FRAME_PIXEL_HEIGHT (f);
8835 #ifdef USE_X_TOOLKIT
8836 /* The menu bar is not part of text lines. The tool bar
8837 is however. */
8838 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8839 #endif
8840 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8841 /* Update f->scroll_bar_actual_width because it is used in
8842 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8843 f->scroll_bar_actual_width
8844 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8845 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8846 change_frame_size (f, r, c, 0, 1, 0);
8849 #ifdef USE_GTK
8850 if (FRAME_GTK_WIDGET (f))
8851 xg_frame_set_char_size (f, cols, rows);
8852 else
8853 x_set_window_size_1 (f, change_gravity, cols, rows);
8854 #else /* not USE_GTK */
8856 x_set_window_size_1 (f, change_gravity, cols, rows);
8858 #endif /* not USE_GTK */
8860 /* If cursor was outside the new size, mark it as off. */
8861 mark_window_cursors_off (XWINDOW (f->root_window));
8863 /* Clear out any recollection of where the mouse highlighting was,
8864 since it might be in a place that's outside the new frame size.
8865 Actually checking whether it is outside is a pain in the neck,
8866 so don't try--just let the highlighting be done afresh with new size. */
8867 cancel_mouse_face (f);
8869 unblock_input ();
8872 /* Mouse warping. */
8874 void
8875 x_set_mouse_position (struct frame *f, int x, int y)
8877 int pix_x, pix_y;
8879 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8880 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8882 if (pix_x < 0) pix_x = 0;
8883 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8885 if (pix_y < 0) pix_y = 0;
8886 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8888 block_input ();
8890 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8891 0, 0, 0, 0, pix_x, pix_y);
8892 unblock_input ();
8895 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8897 void
8898 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8900 block_input ();
8902 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8903 0, 0, 0, 0, pix_x, pix_y);
8904 unblock_input ();
8907 /* Raise frame F. */
8909 void
8910 x_raise_frame (struct frame *f)
8912 block_input ();
8913 if (FRAME_VISIBLE_P (f))
8914 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8915 XFlush (FRAME_X_DISPLAY (f));
8916 unblock_input ();
8919 /* Lower frame F. */
8921 static void
8922 x_lower_frame (struct frame *f)
8924 if (FRAME_VISIBLE_P (f))
8926 block_input ();
8927 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8928 XFlush (FRAME_X_DISPLAY (f));
8929 unblock_input ();
8933 /* Request focus with XEmbed */
8935 void
8936 xembed_request_focus (FRAME_PTR f)
8938 /* See XEmbed Protocol Specification at
8939 http://freedesktop.org/wiki/Specifications/xembed-spec */
8940 if (FRAME_VISIBLE_P (f))
8941 xembed_send_message (f, CurrentTime,
8942 XEMBED_REQUEST_FOCUS, 0, 0, 0);
8945 /* Activate frame with Extended Window Manager Hints */
8947 void
8948 x_ewmh_activate_frame (FRAME_PTR f)
8950 /* See Window Manager Specification/Extended Window Manager Hints at
8951 http://freedesktop.org/wiki/Specifications/wm-spec */
8953 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8955 if (FRAME_VISIBLE_P (f) && wm_supports (f, dpyinfo->Xatom_net_active_window))
8957 Lisp_Object frame;
8958 XSETFRAME (frame, f);
8959 x_send_client_event (frame, make_number (0), frame,
8960 dpyinfo->Xatom_net_active_window,
8961 make_number (32), list2i (1, last_user_time));
8965 static void
8966 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
8968 if (raise_flag)
8969 x_raise_frame (f);
8970 else
8971 x_lower_frame (f);
8974 /* XEmbed implementation. */
8976 #if defined USE_X_TOOLKIT || ! defined USE_GTK
8978 /* XEmbed implementation. */
8980 #define XEMBED_VERSION 0
8982 static void
8983 xembed_set_info (struct frame *f, enum xembed_info flags)
8985 unsigned long data[2];
8986 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8988 data[0] = XEMBED_VERSION;
8989 data[1] = flags;
8991 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8992 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
8993 32, PropModeReplace, (unsigned char *) data, 2);
8995 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
8997 static void
8998 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
8999 long int detail, long int data1, long int data2)
9001 XEvent event;
9003 event.xclient.type = ClientMessage;
9004 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9005 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9006 event.xclient.format = 32;
9007 event.xclient.data.l[0] = t;
9008 event.xclient.data.l[1] = msg;
9009 event.xclient.data.l[2] = detail;
9010 event.xclient.data.l[3] = data1;
9011 event.xclient.data.l[4] = data2;
9013 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9014 False, NoEventMask, &event);
9015 XSync (FRAME_X_DISPLAY (f), False);
9018 /* Change of visibility. */
9020 /* This tries to wait until the frame is really visible.
9021 However, if the window manager asks the user where to position
9022 the frame, this will return before the user finishes doing that.
9023 The frame will not actually be visible at that time,
9024 but it will become visible later when the window manager
9025 finishes with it. */
9027 void
9028 x_make_frame_visible (struct frame *f)
9030 Lisp_Object type;
9031 int original_top, original_left;
9032 int retry_count = 2;
9034 retry:
9036 block_input ();
9038 type = x_icon_type (f);
9039 if (!NILP (type))
9040 x_bitmap_icon (f, type);
9042 if (! FRAME_VISIBLE_P (f))
9044 /* We test FRAME_GARBAGED_P here to make sure we don't
9045 call x_set_offset a second time
9046 if we get to x_make_frame_visible a second time
9047 before the window gets really visible. */
9048 if (! FRAME_ICONIFIED_P (f)
9049 && ! FRAME_X_EMBEDDED_P (f)
9050 && ! f->output_data.x->asked_for_visible)
9051 x_set_offset (f, f->left_pos, f->top_pos, 0);
9053 f->output_data.x->asked_for_visible = 1;
9055 if (! EQ (Vx_no_window_manager, Qt))
9056 x_wm_set_window_state (f, NormalState);
9057 #ifdef USE_X_TOOLKIT
9058 if (FRAME_X_EMBEDDED_P (f))
9059 xembed_set_info (f, XEMBED_MAPPED);
9060 else
9062 /* This was XtPopup, but that did nothing for an iconified frame. */
9063 XtMapWidget (f->output_data.x->widget);
9065 #else /* not USE_X_TOOLKIT */
9066 #ifdef USE_GTK
9067 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9068 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9069 #else
9070 if (FRAME_X_EMBEDDED_P (f))
9071 xembed_set_info (f, XEMBED_MAPPED);
9072 else
9073 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9074 #endif /* not USE_GTK */
9075 #endif /* not USE_X_TOOLKIT */
9078 XFlush (FRAME_X_DISPLAY (f));
9080 /* Synchronize to ensure Emacs knows the frame is visible
9081 before we do anything else. We do this loop with input not blocked
9082 so that incoming events are handled. */
9084 Lisp_Object frame;
9085 int count;
9086 /* This must be before UNBLOCK_INPUT
9087 since events that arrive in response to the actions above
9088 will set it when they are handled. */
9089 int previously_visible = f->output_data.x->has_been_visible;
9091 original_left = f->left_pos;
9092 original_top = f->top_pos;
9094 /* This must come after we set COUNT. */
9095 unblock_input ();
9097 /* We unblock here so that arriving X events are processed. */
9099 /* Now move the window back to where it was "supposed to be".
9100 But don't do it if the gravity is negative.
9101 When the gravity is negative, this uses a position
9102 that is 3 pixels too low. Perhaps that's really the border width.
9104 Don't do this if the window has never been visible before,
9105 because the window manager may choose the position
9106 and we don't want to override it. */
9108 if (! FRAME_VISIBLE_P (f)
9109 && ! FRAME_ICONIFIED_P (f)
9110 && ! FRAME_X_EMBEDDED_P (f)
9111 && f->win_gravity == NorthWestGravity
9112 && previously_visible)
9114 Drawable rootw;
9115 int x, y;
9116 unsigned int width, height, border, depth;
9118 block_input ();
9120 /* On some window managers (such as FVWM) moving an existing
9121 window, even to the same place, causes the window manager
9122 to introduce an offset. This can cause the window to move
9123 to an unexpected location. Check the geometry (a little
9124 slow here) and then verify that the window is in the right
9125 place. If the window is not in the right place, move it
9126 there, and take the potential window manager hit. */
9127 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9128 &rootw, &x, &y, &width, &height, &border, &depth);
9130 if (original_left != x || original_top != y)
9131 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9132 original_left, original_top);
9134 unblock_input ();
9137 XSETFRAME (frame, f);
9139 /* Wait until the frame is visible. Process X events until a
9140 MapNotify event has been seen, or until we think we won't get a
9141 MapNotify at all.. */
9142 for (count = input_signal_count + 10;
9143 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9145 /* Force processing of queued events. */
9146 x_sync (f);
9148 /* Machines that do polling rather than SIGIO have been
9149 observed to go into a busy-wait here. So we'll fake an
9150 alarm signal to let the handler know that there's something
9151 to be read. We used to raise a real alarm, but it seems
9152 that the handler isn't always enabled here. This is
9153 probably a bug. */
9154 if (input_polling_used ())
9156 /* It could be confusing if a real alarm arrives while
9157 processing the fake one. Turn it off and let the
9158 handler reset it. */
9159 int old_poll_suppress_count = poll_suppress_count;
9160 poll_suppress_count = 1;
9161 poll_for_input_1 ();
9162 poll_suppress_count = old_poll_suppress_count;
9166 /* 2000-09-28: In
9168 (let ((f (selected-frame)))
9169 (iconify-frame f)
9170 (raise-frame f))
9172 the frame is not raised with various window managers on
9173 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9174 unknown reason, the call to XtMapWidget is completely ignored.
9175 Mapping the widget a second time works. */
9177 if (!FRAME_VISIBLE_P (f) && --retry_count != 0)
9178 goto retry;
9182 /* Change from mapped state to withdrawn state. */
9184 /* Make the frame visible (mapped and not iconified). */
9186 void
9187 x_make_frame_invisible (struct frame *f)
9189 Window window;
9191 /* Use the frame's outermost window, not the one we normally draw on. */
9192 window = FRAME_OUTER_WINDOW (f);
9194 /* Don't keep the highlight on an invisible frame. */
9195 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9196 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9198 block_input ();
9200 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9201 that the current position of the window is user-specified, rather than
9202 program-specified, so that when the window is mapped again, it will be
9203 placed at the same location, without forcing the user to position it
9204 by hand again (they have already done that once for this window.) */
9205 x_wm_set_size_hint (f, (long) 0, 1);
9207 #ifdef USE_GTK
9208 if (FRAME_GTK_OUTER_WIDGET (f))
9209 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9210 else
9211 #else
9212 if (FRAME_X_EMBEDDED_P (f))
9213 xembed_set_info (f, 0);
9214 else
9215 #endif
9218 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9219 DefaultScreen (FRAME_X_DISPLAY (f))))
9221 unblock_input ();
9222 error ("Can't notify window manager of window withdrawal");
9226 /* We can't distinguish this from iconification
9227 just by the event that we get from the server.
9228 So we can't win using the usual strategy of letting
9229 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9230 and synchronize with the server to make sure we agree. */
9231 SET_FRAME_VISIBLE (f, 0);
9232 SET_FRAME_ICONIFIED (f, 0);
9234 x_sync (f);
9236 unblock_input ();
9239 /* Change window state from mapped to iconified. */
9241 void
9242 x_iconify_frame (struct frame *f)
9244 #ifdef USE_X_TOOLKIT
9245 int result;
9246 #endif
9247 Lisp_Object type;
9249 /* Don't keep the highlight on an invisible frame. */
9250 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9251 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9253 if (FRAME_ICONIFIED_P (f))
9254 return;
9256 block_input ();
9258 type = x_icon_type (f);
9259 if (!NILP (type))
9260 x_bitmap_icon (f, type);
9262 #if defined (USE_GTK)
9263 if (FRAME_GTK_OUTER_WIDGET (f))
9265 if (! FRAME_VISIBLE_P (f))
9266 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9268 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9269 SET_FRAME_VISIBLE (f, 0);
9270 SET_FRAME_ICONIFIED (f, 1);
9271 unblock_input ();
9272 return;
9274 #endif
9276 #ifdef USE_X_TOOLKIT
9278 if (! FRAME_VISIBLE_P (f))
9280 if (! EQ (Vx_no_window_manager, Qt))
9281 x_wm_set_window_state (f, IconicState);
9282 /* This was XtPopup, but that did nothing for an iconified frame. */
9283 XtMapWidget (f->output_data.x->widget);
9284 /* The server won't give us any event to indicate
9285 that an invisible frame was changed to an icon,
9286 so we have to record it here. */
9287 SET_FRAME_VISIBLE (f, 0);
9288 SET_FRAME_ICONIFIED (f, 1);
9289 unblock_input ();
9290 return;
9293 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9294 XtWindow (f->output_data.x->widget),
9295 DefaultScreen (FRAME_X_DISPLAY (f)));
9296 unblock_input ();
9298 if (!result)
9299 error ("Can't notify window manager of iconification");
9301 SET_FRAME_ICONIFIED (f, 1);
9302 SET_FRAME_VISIBLE (f, 0);
9304 block_input ();
9305 XFlush (FRAME_X_DISPLAY (f));
9306 unblock_input ();
9307 #else /* not USE_X_TOOLKIT */
9309 /* Make sure the X server knows where the window should be positioned,
9310 in case the user deiconifies with the window manager. */
9311 if (! FRAME_VISIBLE_P (f)
9312 && ! FRAME_ICONIFIED_P (f)
9313 && ! FRAME_X_EMBEDDED_P (f))
9314 x_set_offset (f, f->left_pos, f->top_pos, 0);
9316 /* Since we don't know which revision of X we're running, we'll use both
9317 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9319 /* X11R4: send a ClientMessage to the window manager using the
9320 WM_CHANGE_STATE type. */
9322 XEvent msg;
9324 msg.xclient.window = FRAME_X_WINDOW (f);
9325 msg.xclient.type = ClientMessage;
9326 msg.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9327 msg.xclient.format = 32;
9328 msg.xclient.data.l[0] = IconicState;
9330 if (! XSendEvent (FRAME_X_DISPLAY (f),
9331 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9332 False,
9333 SubstructureRedirectMask | SubstructureNotifyMask,
9334 &msg))
9336 unblock_input ();
9337 error ("Can't notify window manager of iconification");
9341 /* X11R3: set the initial_state field of the window manager hints to
9342 IconicState. */
9343 x_wm_set_window_state (f, IconicState);
9345 if (!FRAME_VISIBLE_P (f))
9347 /* If the frame was withdrawn, before, we must map it. */
9348 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9351 SET_FRAME_ICONIFIED (f, 1);
9352 SET_FRAME_VISIBLE (f, 0);
9354 XFlush (FRAME_X_DISPLAY (f));
9355 unblock_input ();
9356 #endif /* not USE_X_TOOLKIT */
9360 /* Free X resources of frame F. */
9362 void
9363 x_free_frame_resources (struct frame *f)
9365 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9366 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9367 #ifdef USE_X_TOOLKIT
9368 Lisp_Object bar;
9369 struct scroll_bar *b;
9370 #endif
9372 block_input ();
9374 /* If a display connection is dead, don't try sending more
9375 commands to the X server. */
9376 if (dpyinfo->display)
9378 /* We must free faces before destroying windows because some
9379 font-driver (e.g. xft) access a window while finishing a
9380 face. */
9381 if (FRAME_FACE_CACHE (f))
9382 free_frame_faces (f);
9384 if (f->output_data.x->icon_desc)
9385 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9387 #ifdef USE_X_TOOLKIT
9388 /* Explicitly destroy the scroll bars of the frame. Without
9389 this, we get "BadDrawable" errors from the toolkit later on,
9390 presumably from expose events generated for the disappearing
9391 toolkit scroll bars. */
9392 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9394 b = XSCROLL_BAR (bar);
9395 x_scroll_bar_remove (b);
9397 #endif
9399 #ifdef HAVE_X_I18N
9400 if (FRAME_XIC (f))
9401 free_frame_xic (f);
9402 #endif
9404 #ifdef USE_X_TOOLKIT
9405 if (f->output_data.x->widget)
9407 XtDestroyWidget (f->output_data.x->widget);
9408 f->output_data.x->widget = NULL;
9410 /* Tooltips don't have widgets, only a simple X window, even if
9411 we are using a toolkit. */
9412 else if (FRAME_X_WINDOW (f))
9413 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9415 free_frame_menubar (f);
9416 #else /* !USE_X_TOOLKIT */
9418 #ifdef USE_GTK
9419 xg_free_frame_widgets (f);
9420 #endif /* USE_GTK */
9422 if (FRAME_X_WINDOW (f))
9423 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9424 #endif /* !USE_X_TOOLKIT */
9426 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9427 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9428 unload_color (f, f->output_data.x->cursor_pixel);
9429 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9430 unload_color (f, f->output_data.x->border_pixel);
9431 unload_color (f, f->output_data.x->mouse_pixel);
9433 if (f->output_data.x->scroll_bar_background_pixel != -1)
9434 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9435 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9436 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9437 #ifdef USE_TOOLKIT_SCROLL_BARS
9438 /* Scrollbar shadow colors. */
9439 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9440 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9441 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9442 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9443 #endif /* USE_TOOLKIT_SCROLL_BARS */
9444 if (f->output_data.x->white_relief.allocated_p)
9445 unload_color (f, f->output_data.x->white_relief.pixel);
9446 if (f->output_data.x->black_relief.allocated_p)
9447 unload_color (f, f->output_data.x->black_relief.pixel);
9449 x_free_gcs (f);
9450 XFlush (FRAME_X_DISPLAY (f));
9453 xfree (f->output_data.x->saved_menu_event);
9454 xfree (f->output_data.x);
9455 f->output_data.x = NULL;
9457 if (f == dpyinfo->x_focus_frame)
9458 dpyinfo->x_focus_frame = 0;
9459 if (f == dpyinfo->x_focus_event_frame)
9460 dpyinfo->x_focus_event_frame = 0;
9461 if (f == dpyinfo->x_highlight_frame)
9462 dpyinfo->x_highlight_frame = 0;
9464 if (f == hlinfo->mouse_face_mouse_frame)
9466 hlinfo->mouse_face_beg_row
9467 = hlinfo->mouse_face_beg_col = -1;
9468 hlinfo->mouse_face_end_row
9469 = hlinfo->mouse_face_end_col = -1;
9470 hlinfo->mouse_face_window = Qnil;
9471 hlinfo->mouse_face_mouse_frame = 0;
9474 unblock_input ();
9478 /* Destroy the X window of frame F. */
9480 static void
9481 x_destroy_window (struct frame *f)
9483 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9485 /* If a display connection is dead, don't try sending more
9486 commands to the X server. */
9487 if (dpyinfo->display != 0)
9488 x_free_frame_resources (f);
9490 dpyinfo->reference_count--;
9494 /* Setting window manager hints. */
9496 /* Set the normal size hints for the window manager, for frame F.
9497 FLAGS is the flags word to use--or 0 meaning preserve the flags
9498 that the window now has.
9499 If USER_POSITION, set the USPosition
9500 flag (this is useful when FLAGS is 0).
9501 The GTK version is in gtkutils.c. */
9503 #ifndef USE_GTK
9504 void
9505 x_wm_set_size_hint (struct frame *f, long flags, bool user_position)
9507 XSizeHints size_hints;
9508 Window window = FRAME_OUTER_WINDOW (f);
9510 #ifdef USE_X_TOOLKIT
9511 if (f->output_data.x->widget)
9513 widget_update_wm_size_hints (f->output_data.x->widget);
9514 return;
9516 #endif
9518 /* Setting PMaxSize caused various problems. */
9519 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9521 size_hints.x = f->left_pos;
9522 size_hints.y = f->top_pos;
9524 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9525 size_hints.width = FRAME_PIXEL_WIDTH (f);
9527 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9528 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9529 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9530 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9531 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9532 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9534 /* Calculate the base and minimum sizes. */
9536 int base_width, base_height;
9537 int min_rows = 0, min_cols = 0;
9539 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9540 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9542 check_frame_size (f, &min_rows, &min_cols);
9544 /* The window manager uses the base width hints to calculate the
9545 current number of rows and columns in the frame while
9546 resizing; min_width and min_height aren't useful for this
9547 purpose, since they might not give the dimensions for a
9548 zero-row, zero-column frame.
9550 We use the base_width and base_height members if we have
9551 them; otherwise, we set the min_width and min_height members
9552 to the size for a zero x zero frame. */
9554 size_hints.flags |= PBaseSize;
9555 size_hints.base_width = base_width;
9556 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9557 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9558 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9561 /* If we don't need the old flags, we don't need the old hint at all. */
9562 if (flags)
9564 size_hints.flags |= flags;
9565 goto no_read;
9569 XSizeHints hints; /* Sometimes I hate X Windows... */
9570 long supplied_return;
9571 int value;
9573 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9574 &supplied_return);
9576 if (flags)
9577 size_hints.flags |= flags;
9578 else
9580 if (value == 0)
9581 hints.flags = 0;
9582 if (hints.flags & PSize)
9583 size_hints.flags |= PSize;
9584 if (hints.flags & PPosition)
9585 size_hints.flags |= PPosition;
9586 if (hints.flags & USPosition)
9587 size_hints.flags |= USPosition;
9588 if (hints.flags & USSize)
9589 size_hints.flags |= USSize;
9593 no_read:
9595 #ifdef PWinGravity
9596 size_hints.win_gravity = f->win_gravity;
9597 size_hints.flags |= PWinGravity;
9599 if (user_position)
9601 size_hints.flags &= ~ PPosition;
9602 size_hints.flags |= USPosition;
9604 #endif /* PWinGravity */
9606 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9608 #endif /* not USE_GTK */
9610 /* Used for IconicState or NormalState */
9612 static void
9613 x_wm_set_window_state (struct frame *f, int state)
9615 #ifdef USE_X_TOOLKIT
9616 Arg al[1];
9618 XtSetArg (al[0], XtNinitialState, state);
9619 XtSetValues (f->output_data.x->widget, al, 1);
9620 #else /* not USE_X_TOOLKIT */
9621 Window window = FRAME_X_WINDOW (f);
9623 f->output_data.x->wm_hints.flags |= StateHint;
9624 f->output_data.x->wm_hints.initial_state = state;
9626 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9627 #endif /* not USE_X_TOOLKIT */
9630 static void
9631 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
9633 Pixmap icon_pixmap, icon_mask;
9635 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9636 Window window = FRAME_OUTER_WINDOW (f);
9637 #endif
9639 if (pixmap_id > 0)
9641 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9642 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9643 icon_mask = x_bitmap_mask (f, pixmap_id);
9644 f->output_data.x->wm_hints.icon_mask = icon_mask;
9646 else
9648 /* It seems there is no way to turn off use of an icon
9649 pixmap. */
9650 return;
9654 #ifdef USE_GTK
9656 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9657 return;
9660 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9663 Arg al[1];
9664 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9665 XtSetValues (f->output_data.x->widget, al, 1);
9666 XtSetArg (al[0], XtNiconMask, icon_mask);
9667 XtSetValues (f->output_data.x->widget, al, 1);
9670 #else /* not USE_X_TOOLKIT && not USE_GTK */
9672 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9673 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9675 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9678 void
9679 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9681 Window window = FRAME_OUTER_WINDOW (f);
9683 f->output_data.x->wm_hints.flags |= IconPositionHint;
9684 f->output_data.x->wm_hints.icon_x = icon_x;
9685 f->output_data.x->wm_hints.icon_y = icon_y;
9687 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9691 /***********************************************************************
9692 Fonts
9693 ***********************************************************************/
9695 #ifdef GLYPH_DEBUG
9697 /* Check that FONT is valid on frame F. It is if it can be found in F's
9698 font table. */
9700 static void
9701 x_check_font (struct frame *f, struct font *font)
9703 eassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9704 if (font->driver->check)
9705 eassert (font->driver->check (f, font) == 0);
9708 #endif /* GLYPH_DEBUG */
9711 /***********************************************************************
9712 Initialization
9713 ***********************************************************************/
9715 #ifdef USE_X_TOOLKIT
9716 static XrmOptionDescRec emacs_options[] = {
9717 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9718 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9720 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9721 XrmoptionSepArg, NULL},
9722 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9724 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9725 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9726 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9727 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9728 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9729 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9730 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9733 /* Whether atimer for Xt timeouts is activated or not. */
9735 static int x_timeout_atimer_activated_flag;
9737 #endif /* USE_X_TOOLKIT */
9739 static int x_initialized;
9741 /* Test whether two display-name strings agree up to the dot that separates
9742 the screen number from the server number. */
9743 static int
9744 same_x_server (const char *name1, const char *name2)
9746 int seen_colon = 0;
9747 const char *system_name = SSDATA (Vsystem_name);
9748 ptrdiff_t system_name_length = SBYTES (Vsystem_name);
9749 ptrdiff_t length_until_period = 0;
9751 while (system_name[length_until_period] != 0
9752 && system_name[length_until_period] != '.')
9753 length_until_period++;
9755 /* Treat `unix' like an empty host name. */
9756 if (! strncmp (name1, "unix:", 5))
9757 name1 += 4;
9758 if (! strncmp (name2, "unix:", 5))
9759 name2 += 4;
9760 /* Treat this host's name like an empty host name. */
9761 if (! strncmp (name1, system_name, system_name_length)
9762 && name1[system_name_length] == ':')
9763 name1 += system_name_length;
9764 if (! strncmp (name2, system_name, system_name_length)
9765 && name2[system_name_length] == ':')
9766 name2 += system_name_length;
9767 /* Treat this host's domainless name like an empty host name. */
9768 if (! strncmp (name1, system_name, length_until_period)
9769 && name1[length_until_period] == ':')
9770 name1 += length_until_period;
9771 if (! strncmp (name2, system_name, length_until_period)
9772 && name2[length_until_period] == ':')
9773 name2 += length_until_period;
9775 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9777 if (*name1 == ':')
9778 seen_colon = 1;
9779 if (seen_colon && *name1 == '.')
9780 return 1;
9782 return (seen_colon
9783 && (*name1 == '.' || *name1 == '\0')
9784 && (*name2 == '.' || *name2 == '\0'));
9787 /* Count number of set bits in mask and number of bits to shift to
9788 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9789 to 5. */
9790 static void
9791 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9793 int nr = 0;
9794 int off = 0;
9796 while (!(mask & 1))
9798 off++;
9799 mask >>= 1;
9802 while (mask & 1)
9804 nr++;
9805 mask >>= 1;
9808 *offset = off;
9809 *bits = nr;
9812 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9813 But don't permanently open it, just test its availability. */
9816 x_display_ok (const char *display)
9818 int dpy_ok = 1;
9819 Display *dpy;
9821 dpy = XOpenDisplay (display);
9822 if (dpy)
9823 XCloseDisplay (dpy);
9824 else
9825 dpy_ok = 0;
9826 return dpy_ok;
9829 #ifdef USE_GTK
9830 static void
9831 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
9832 const gchar *msg, gpointer user_data)
9834 if (!strstr (msg, "g_set_prgname"))
9835 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
9837 #endif
9839 /* Open a connection to X display DISPLAY_NAME, and return
9840 the structure that describes the open display.
9841 If we cannot contact the display, return null. */
9843 struct x_display_info *
9844 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9846 int connection;
9847 Display *dpy;
9848 struct terminal *terminal;
9849 struct x_display_info *dpyinfo;
9850 XrmDatabase xrdb;
9851 Mouse_HLInfo *hlinfo;
9852 ptrdiff_t lim;
9854 block_input ();
9856 if (!x_initialized)
9858 x_initialize ();
9859 ++x_initialized;
9862 if (! x_display_ok (SSDATA (display_name)))
9863 error ("Display %s can't be opened", SSDATA (display_name));
9865 #ifdef USE_GTK
9867 #define NUM_ARGV 10
9868 int argc;
9869 char *argv[NUM_ARGV];
9870 char **argv2 = argv;
9871 guint id;
9873 if (x_initialized++ > 1)
9875 xg_display_open (SSDATA (display_name), &dpy);
9877 else
9879 static char display_opt[] = "--display";
9880 static char name_opt[] = "--name";
9882 for (argc = 0; argc < NUM_ARGV; ++argc)
9883 argv[argc] = 0;
9885 argc = 0;
9886 argv[argc++] = initial_argv[0];
9888 if (! NILP (display_name))
9890 argv[argc++] = display_opt;
9891 argv[argc++] = SSDATA (display_name);
9894 argv[argc++] = name_opt;
9895 argv[argc++] = resource_name;
9897 XSetLocaleModifiers ("");
9899 /* Emacs can only handle core input events, so make sure
9900 Gtk doesn't use Xinput or Xinput2 extensions. */
9901 xputenv ("GDK_CORE_DEVICE_EVENTS=1");
9903 /* Work around GLib bug that outputs a faulty warning. See
9904 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9905 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9906 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9908 /* NULL window -> events for all windows go to our function.
9909 Call before gtk_init so Gtk+ event filters comes after our. */
9910 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9912 /* gtk_init does set_locale. Fix locale before and after. */
9913 fixup_locale ();
9914 gtk_init (&argc, &argv2);
9915 fixup_locale ();
9917 g_log_remove_handler ("GLib", id);
9919 xg_initialize ();
9921 dpy = DEFAULT_GDK_DISPLAY ();
9923 #if ! GTK_CHECK_VERSION (2, 90, 0)
9924 /* Load our own gtkrc if it exists. */
9926 const char *file = "~/.emacs.d/gtkrc";
9927 Lisp_Object s, abs_file;
9929 s = build_string (file);
9930 abs_file = Fexpand_file_name (s, Qnil);
9932 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9933 gtk_rc_parse (SSDATA (abs_file));
9935 #endif
9937 XSetErrorHandler (x_error_handler);
9938 XSetIOErrorHandler (x_io_error_quitter);
9941 #else /* not USE_GTK */
9942 #ifdef USE_X_TOOLKIT
9943 /* weiner@footloose.sps.mot.com reports that this causes
9944 errors with X11R5:
9945 X protocol error: BadAtom (invalid Atom parameter)
9946 on protocol request 18skiloaf.
9947 So let's not use it until R6. */
9948 #ifdef HAVE_X11XTR6
9949 XtSetLanguageProc (NULL, NULL, NULL);
9950 #endif
9953 int argc = 0;
9954 char *argv[3];
9956 argv[0] = "";
9957 argc = 1;
9958 if (xrm_option)
9960 argv[argc++] = "-xrm";
9961 argv[argc++] = xrm_option;
9963 turn_on_atimers (0);
9964 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
9965 resource_name, EMACS_CLASS,
9966 emacs_options, XtNumber (emacs_options),
9967 &argc, argv);
9968 turn_on_atimers (1);
9970 #ifdef HAVE_X11XTR6
9971 /* I think this is to compensate for XtSetLanguageProc. */
9972 fixup_locale ();
9973 #endif
9976 #else /* not USE_X_TOOLKIT */
9977 XSetLocaleModifiers ("");
9978 dpy = XOpenDisplay (SSDATA (display_name));
9979 #endif /* not USE_X_TOOLKIT */
9980 #endif /* not USE_GTK*/
9982 /* Detect failure. */
9983 if (dpy == 0)
9985 unblock_input ();
9986 return 0;
9989 /* We have definitely succeeded. Record the new connection. */
9991 dpyinfo = xzalloc (sizeof *dpyinfo);
9992 hlinfo = &dpyinfo->mouse_highlight;
9994 terminal = x_create_terminal (dpyinfo);
9997 struct x_display_info *share;
9998 Lisp_Object tail;
10000 for (share = x_display_list, tail = x_display_name_list; share;
10001 share = share->next, tail = XCDR (tail))
10002 if (same_x_server (SSDATA (XCAR (XCAR (tail))),
10003 SSDATA (display_name)))
10004 break;
10005 if (share)
10006 terminal->kboard = share->terminal->kboard;
10007 else
10009 terminal->kboard = xmalloc (sizeof *terminal->kboard);
10010 init_kboard (terminal->kboard);
10011 kset_window_system (terminal->kboard, Qx);
10013 /* Add the keyboard to the list before running Lisp code (via
10014 Qvendor_specific_keysyms below), since these are not traced
10015 via terminals but only through all_kboards. */
10016 terminal->kboard->next_kboard = all_kboards;
10017 all_kboards = terminal->kboard;
10019 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10021 char *vendor = ServerVendor (dpy);
10023 /* Protect terminal from GC before removing it from the
10024 list of terminals. */
10025 struct gcpro gcpro1;
10026 Lisp_Object gcpro_term;
10027 XSETTERMINAL (gcpro_term, terminal);
10028 GCPRO1 (gcpro_term);
10030 /* Temporarily hide the partially initialized terminal. */
10031 terminal_list = terminal->next_terminal;
10032 unblock_input ();
10033 kset_system_key_alist
10034 (terminal->kboard,
10035 call1 (Qvendor_specific_keysyms,
10036 vendor ? build_string (vendor) : empty_unibyte_string));
10037 block_input ();
10038 terminal->next_terminal = terminal_list;
10039 terminal_list = terminal;
10040 UNGCPRO;
10043 /* Don't let the initial kboard remain current longer than necessary.
10044 That would cause problems if a file loaded on startup tries to
10045 prompt in the mini-buffer. */
10046 if (current_kboard == initial_kboard)
10047 current_kboard = terminal->kboard;
10049 terminal->kboard->reference_count++;
10052 /* Put this display on the chain. */
10053 dpyinfo->next = x_display_list;
10054 x_display_list = dpyinfo;
10056 /* Put it on x_display_name_list as well, to keep them parallel. */
10057 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10058 x_display_name_list);
10059 dpyinfo->name_list_element = XCAR (x_display_name_list);
10061 dpyinfo->display = dpy;
10063 /* Set the name of the terminal. */
10064 terminal->name = xmalloc (SBYTES (display_name) + 1);
10065 memcpy (terminal->name, SSDATA (display_name), SBYTES (display_name));
10066 terminal->name[SBYTES (display_name)] = 0;
10068 #if 0
10069 XSetAfterFunction (x_current_display, x_trace_wire);
10070 #endif /* ! 0 */
10072 lim = min (PTRDIFF_MAX, SIZE_MAX) - sizeof "@";
10073 if (lim - SBYTES (Vinvocation_name) < SBYTES (Vsystem_name))
10074 memory_full (SIZE_MAX);
10075 dpyinfo->x_id_name = xmalloc (SBYTES (Vinvocation_name)
10076 + SBYTES (Vsystem_name) + 2);
10077 strcat (strcat (strcpy (dpyinfo->x_id_name, SSDATA (Vinvocation_name)), "@"),
10078 SSDATA (Vsystem_name));
10080 /* Figure out which modifier bits mean what. */
10081 x_find_modifier_meanings (dpyinfo);
10083 /* Get the scroll bar cursor. */
10084 #ifdef USE_GTK
10085 /* We must create a GTK cursor, it is required for GTK widgets. */
10086 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10087 #endif /* USE_GTK */
10089 dpyinfo->vertical_scroll_bar_cursor
10090 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10092 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10093 resource_name, EMACS_CLASS);
10094 #ifdef HAVE_XRMSETDATABASE
10095 XrmSetDatabase (dpyinfo->display, xrdb);
10096 #else
10097 dpyinfo->display->db = xrdb;
10098 #endif
10099 /* Put the rdb where we can find it in a way that works on
10100 all versions. */
10101 dpyinfo->xrdb = xrdb;
10103 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10104 DefaultScreen (dpyinfo->display));
10105 select_visual (dpyinfo);
10106 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10107 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10108 dpyinfo->client_leader_window = 0;
10109 dpyinfo->grabbed = 0;
10110 dpyinfo->reference_count = 0;
10111 dpyinfo->icon_bitmap_id = -1;
10112 dpyinfo->n_fonts = 0;
10113 dpyinfo->bitmaps = 0;
10114 dpyinfo->bitmaps_size = 0;
10115 dpyinfo->bitmaps_last = 0;
10116 dpyinfo->scratch_cursor_gc = 0;
10117 hlinfo->mouse_face_mouse_frame = 0;
10118 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10119 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10120 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10121 hlinfo->mouse_face_window = Qnil;
10122 hlinfo->mouse_face_overlay = Qnil;
10123 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10124 hlinfo->mouse_face_defer = 0;
10125 hlinfo->mouse_face_hidden = 0;
10126 dpyinfo->x_focus_frame = 0;
10127 dpyinfo->x_focus_event_frame = 0;
10128 dpyinfo->x_highlight_frame = 0;
10129 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10131 /* See if we can construct pixel values from RGB values. */
10132 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10133 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10135 if (dpyinfo->visual->class == TrueColor)
10137 get_bits_and_offset (dpyinfo->visual->red_mask,
10138 &dpyinfo->red_bits, &dpyinfo->red_offset);
10139 get_bits_and_offset (dpyinfo->visual->blue_mask,
10140 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10141 get_bits_and_offset (dpyinfo->visual->green_mask,
10142 &dpyinfo->green_bits, &dpyinfo->green_offset);
10145 /* See if a private colormap is requested. */
10146 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10148 if (dpyinfo->visual->class == PseudoColor)
10150 Lisp_Object value;
10151 value = display_x_get_resource (dpyinfo,
10152 build_string ("privateColormap"),
10153 build_string ("PrivateColormap"),
10154 Qnil, Qnil);
10155 if (STRINGP (value)
10156 && (!strcmp (SSDATA (value), "true")
10157 || !strcmp (SSDATA (value), "on")))
10158 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10161 else
10162 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10163 dpyinfo->visual, AllocNone);
10165 #ifdef HAVE_XFT
10167 /* If we are using Xft, check dpi value in X resources.
10168 It is better we use it as well, since Xft will use it, as will all
10169 Gnome applications. If our real DPI is smaller or larger than the
10170 one Xft uses, our font will look smaller or larger than other
10171 for other applications, even if it is the same font name (monospace-10
10172 for example). */
10173 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10174 double d;
10175 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10176 dpyinfo->resy = dpyinfo->resx = d;
10178 #endif
10180 if (dpyinfo->resy < 1)
10182 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10183 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10184 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10185 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10186 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10187 pixels = DisplayWidth (dpyinfo->display, screen_number);
10188 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10189 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10190 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10194 const struct
10196 const char *name;
10197 Atom *atom;
10198 } atom_refs[] = {
10199 { "WM_PROTOCOLS", &dpyinfo->Xatom_wm_protocols },
10200 { "WM_TAKE_FOCUS", &dpyinfo->Xatom_wm_take_focus },
10201 { "WM_SAVE_YOURSELF", &dpyinfo->Xatom_wm_save_yourself },
10202 { "WM_DELETE_WINDOW", &dpyinfo->Xatom_wm_delete_window },
10203 { "WM_CHANGE_STATE", &dpyinfo->Xatom_wm_change_state },
10204 { "WM_CONFIGURE_DENIED", &dpyinfo->Xatom_wm_configure_denied },
10205 { "WM_MOVED", &dpyinfo->Xatom_wm_window_moved },
10206 { "WM_CLIENT_LEADER", &dpyinfo->Xatom_wm_client_leader },
10207 { "Editres", &dpyinfo->Xatom_editres },
10208 { "CLIPBOARD", &dpyinfo->Xatom_CLIPBOARD },
10209 { "TIMESTAMP", &dpyinfo->Xatom_TIMESTAMP },
10210 { "TEXT", &dpyinfo->Xatom_TEXT },
10211 { "COMPOUND_TEXT", &dpyinfo->Xatom_COMPOUND_TEXT },
10212 { "UTF8_STRING", &dpyinfo->Xatom_UTF8_STRING },
10213 { "DELETE", &dpyinfo->Xatom_DELETE },
10214 { "MULTIPLE", &dpyinfo->Xatom_MULTIPLE },
10215 { "INCR", &dpyinfo->Xatom_INCR },
10216 { "_EMACS_TMP_", &dpyinfo->Xatom_EMACS_TMP },
10217 { "TARGETS", &dpyinfo->Xatom_TARGETS },
10218 { "NULL", &dpyinfo->Xatom_NULL },
10219 { "ATOM", &dpyinfo->Xatom_ATOM },
10220 { "ATOM_PAIR", &dpyinfo->Xatom_ATOM_PAIR },
10221 { "CLIPBOARD_MANAGER", &dpyinfo->Xatom_CLIPBOARD_MANAGER },
10222 { "_XEMBED_INFO", &dpyinfo->Xatom_XEMBED_INFO },
10223 /* For properties of font. */
10224 { "PIXEL_SIZE", &dpyinfo->Xatom_PIXEL_SIZE },
10225 { "AVERAGE_WIDTH", &dpyinfo->Xatom_AVERAGE_WIDTH },
10226 { "_MULE_BASELINE_OFFSET", &dpyinfo->Xatom_MULE_BASELINE_OFFSET },
10227 { "_MULE_RELATIVE_COMPOSE", &dpyinfo->Xatom_MULE_RELATIVE_COMPOSE },
10228 { "_MULE_DEFAULT_ASCENT", &dpyinfo->Xatom_MULE_DEFAULT_ASCENT },
10229 /* Ghostscript support. */
10230 { "DONE", &dpyinfo->Xatom_DONE },
10231 { "PAGE", &dpyinfo->Xatom_PAGE },
10232 { "SCROLLBAR", &dpyinfo->Xatom_Scrollbar },
10233 { "_XEMBED", &dpyinfo->Xatom_XEMBED },
10234 /* EWMH */
10235 { "_NET_WM_STATE", &dpyinfo->Xatom_net_wm_state },
10236 { "_NET_WM_STATE_FULLSCREEN", &dpyinfo->Xatom_net_wm_state_fullscreen },
10237 { "_NET_WM_STATE_MAXIMIZED_HORZ",
10238 &dpyinfo->Xatom_net_wm_state_maximized_horz },
10239 { "_NET_WM_STATE_MAXIMIZED_VERT",
10240 &dpyinfo->Xatom_net_wm_state_maximized_vert },
10241 { "_NET_WM_STATE_STICKY", &dpyinfo->Xatom_net_wm_state_sticky },
10242 { "_NET_WM_STATE_HIDDEN", &dpyinfo->Xatom_net_wm_state_hidden },
10243 { "_NET_WM_WINDOW_TYPE", &dpyinfo->Xatom_net_window_type },
10244 { "_NET_WM_WINDOW_TYPE_TOOLTIP",
10245 &dpyinfo->Xatom_net_window_type_tooltip },
10246 { "_NET_WM_ICON_NAME", &dpyinfo->Xatom_net_wm_icon_name },
10247 { "_NET_WM_NAME", &dpyinfo->Xatom_net_wm_name },
10248 { "_NET_SUPPORTED", &dpyinfo->Xatom_net_supported },
10249 { "_NET_SUPPORTING_WM_CHECK", &dpyinfo->Xatom_net_supporting_wm_check },
10250 { "_NET_WM_WINDOW_OPACITY", &dpyinfo->Xatom_net_wm_window_opacity },
10251 { "_NET_ACTIVE_WINDOW", &dpyinfo->Xatom_net_active_window },
10252 { "_NET_FRAME_EXTENTS", &dpyinfo->Xatom_net_frame_extents },
10253 { "_NET_CURRENT_DESKTOP", &dpyinfo->Xatom_net_current_desktop },
10254 { "_NET_WORKAREA", &dpyinfo->Xatom_net_workarea },
10255 /* Session management */
10256 { "SM_CLIENT_ID", &dpyinfo->Xatom_SM_CLIENT_ID },
10257 { "_XSETTINGS_SETTINGS", &dpyinfo->Xatom_xsettings_prop },
10258 { "MANAGER", &dpyinfo->Xatom_xsettings_mgr },
10261 int i;
10262 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10263 /* 1 for _XSETTINGS_SN */
10264 const int total_atom_count = 1 + atom_count;
10265 Atom *atoms_return = xmalloc (total_atom_count * sizeof *atoms_return);
10266 char **atom_names = xmalloc (total_atom_count * sizeof *atom_names);
10267 static char const xsettings_fmt[] = "_XSETTINGS_S%d";
10268 char xsettings_atom_name[sizeof xsettings_fmt - 2
10269 + INT_STRLEN_BOUND (int)];
10271 for (i = 0; i < atom_count; i++)
10272 atom_names[i] = (char *) atom_refs[i].name;
10274 /* Build _XSETTINGS_SN atom name */
10275 sprintf (xsettings_atom_name, xsettings_fmt,
10276 XScreenNumberOfScreen (dpyinfo->screen));
10277 atom_names[i] = xsettings_atom_name;
10279 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10280 False, atoms_return);
10282 for (i = 0; i < atom_count; i++)
10283 *atom_refs[i].atom = atoms_return[i];
10285 /* Manual copy of last atom */
10286 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10288 xfree (atom_names);
10289 xfree (atoms_return);
10292 dpyinfo->x_dnd_atoms_size = 8;
10293 dpyinfo->x_dnd_atoms_length = 0;
10294 dpyinfo->x_dnd_atoms = xmalloc (sizeof *dpyinfo->x_dnd_atoms
10295 * dpyinfo->x_dnd_atoms_size);
10297 dpyinfo->net_supported_atoms = NULL;
10298 dpyinfo->nr_net_supported_atoms = 0;
10299 dpyinfo->net_supported_window = 0;
10301 connection = ConnectionNumber (dpyinfo->display);
10302 dpyinfo->connection = connection;
10303 dpyinfo->gray
10304 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10305 gray_bits, gray_width, gray_height,
10306 1, 0, 1);
10308 #ifdef HAVE_X_I18N
10309 xim_initialize (dpyinfo, resource_name);
10310 #endif
10312 xsettings_initialize (dpyinfo);
10314 /* This is only needed for distinguishing keyboard and process input. */
10315 if (connection != 0)
10316 add_keyboard_wait_descriptor (connection);
10318 #ifdef F_SETOWN
10319 fcntl (connection, F_SETOWN, getpid ());
10320 #endif /* ! defined (F_SETOWN) */
10322 if (interrupt_input)
10323 init_sigio (connection);
10325 #ifdef USE_LUCID
10327 XrmValue d, fr, to;
10328 Font font;
10330 dpy = dpyinfo->display;
10331 d.addr = (XPointer)&dpy;
10332 d.size = sizeof (Display *);
10333 fr.addr = XtDefaultFont;
10334 fr.size = sizeof (XtDefaultFont);
10335 to.size = sizeof (Font *);
10336 to.addr = (XPointer)&font;
10337 x_catch_errors (dpy);
10338 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10339 emacs_abort ();
10340 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10341 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10342 x_uncatch_errors ();
10344 #endif
10346 /* See if we should run in synchronous mode. This is useful
10347 for debugging X code. */
10349 Lisp_Object value;
10350 value = display_x_get_resource (dpyinfo,
10351 build_string ("synchronous"),
10352 build_string ("Synchronous"),
10353 Qnil, Qnil);
10354 if (STRINGP (value)
10355 && (!strcmp (SSDATA (value), "true")
10356 || !strcmp (SSDATA (value), "on")))
10357 XSynchronize (dpyinfo->display, True);
10361 Lisp_Object value;
10362 value = display_x_get_resource (dpyinfo,
10363 build_string ("useXIM"),
10364 build_string ("UseXIM"),
10365 Qnil, Qnil);
10366 #ifdef USE_XIM
10367 if (STRINGP (value)
10368 && (!strcmp (SSDATA (value), "false")
10369 || !strcmp (SSDATA (value), "off")))
10370 use_xim = 0;
10371 #else
10372 if (STRINGP (value)
10373 && (!strcmp (SSDATA (value), "true")
10374 || !strcmp (SSDATA (value), "on")))
10375 use_xim = 1;
10376 #endif
10379 #ifdef HAVE_X_SM
10380 /* Only do this for the very first display in the Emacs session.
10381 Ignore X session management when Emacs was first started on a
10382 tty. */
10383 if (terminal->id == 1)
10384 x_session_initialize (dpyinfo);
10385 #endif
10387 unblock_input ();
10389 return dpyinfo;
10392 /* Get rid of display DPYINFO, deleting all frames on it,
10393 and without sending any more commands to the X server. */
10395 static void
10396 x_delete_display (struct x_display_info *dpyinfo)
10398 struct terminal *t;
10400 /* Close all frames and delete the generic struct terminal for this
10401 X display. */
10402 for (t = terminal_list; t; t = t->next_terminal)
10403 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10405 #ifdef HAVE_X_SM
10406 /* Close X session management when we close its display. */
10407 if (t->id == 1 && x_session_have_connection ())
10408 x_session_close ();
10409 #endif
10410 delete_terminal (t);
10411 break;
10414 delete_keyboard_wait_descriptor (dpyinfo->connection);
10416 /* Discard this display from x_display_name_list and x_display_list.
10417 We can't use Fdelq because that can quit. */
10418 if (! NILP (x_display_name_list)
10419 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10420 x_display_name_list = XCDR (x_display_name_list);
10421 else
10423 Lisp_Object tail;
10425 tail = x_display_name_list;
10426 while (CONSP (tail) && CONSP (XCDR (tail)))
10428 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10430 XSETCDR (tail, XCDR (XCDR (tail)));
10431 break;
10433 tail = XCDR (tail);
10437 if (next_noop_dpyinfo == dpyinfo)
10438 next_noop_dpyinfo = dpyinfo->next;
10440 if (x_display_list == dpyinfo)
10441 x_display_list = dpyinfo->next;
10442 else
10444 struct x_display_info *tail;
10446 for (tail = x_display_list; tail; tail = tail->next)
10447 if (tail->next == dpyinfo)
10448 tail->next = tail->next->next;
10451 xfree (dpyinfo->x_id_name);
10452 xfree (dpyinfo->x_dnd_atoms);
10453 xfree (dpyinfo->color_cells);
10454 xfree (dpyinfo);
10457 #ifdef USE_X_TOOLKIT
10459 /* Atimer callback function for TIMER. Called every 0.1s to process
10460 Xt timeouts, if needed. We must avoid calling XtAppPending as
10461 much as possible because that function does an implicit XFlush
10462 that slows us down. */
10464 static void
10465 x_process_timeouts (struct atimer *timer)
10467 block_input ();
10468 x_timeout_atimer_activated_flag = 0;
10469 if (toolkit_scroll_bar_interaction || popup_activated ())
10471 while (XtAppPending (Xt_app_con) & XtIMTimer)
10472 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10473 /* Reactivate the atimer for next time. */
10474 x_activate_timeout_atimer ();
10476 unblock_input ();
10479 /* Install an asynchronous timer that processes Xt timeout events
10480 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10481 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10482 function whenever these variables are set. This is necessary
10483 because some widget sets use timeouts internally, for example the
10484 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10485 processed, these widgets don't behave normally. */
10487 void
10488 x_activate_timeout_atimer (void)
10490 block_input ();
10491 if (!x_timeout_atimer_activated_flag)
10493 EMACS_TIME interval = make_emacs_time (0, 100 * 1000 * 1000);
10494 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10495 x_timeout_atimer_activated_flag = 1;
10497 unblock_input ();
10500 #endif /* USE_X_TOOLKIT */
10503 /* Set up use of X before we make the first connection. */
10505 static struct redisplay_interface x_redisplay_interface =
10507 x_frame_parm_handlers,
10508 x_produce_glyphs,
10509 x_write_glyphs,
10510 x_insert_glyphs,
10511 x_clear_end_of_line,
10512 x_scroll_run,
10513 x_after_update_window_line,
10514 x_update_window_begin,
10515 x_update_window_end,
10516 x_cursor_to,
10517 x_flush,
10518 #ifdef XFlush
10519 x_flush,
10520 #else
10521 0, /* flush_display_optional */
10522 #endif
10523 x_clear_window_mouse_face,
10524 x_get_glyph_overhangs,
10525 x_fix_overlapping_area,
10526 x_draw_fringe_bitmap,
10527 0, /* define_fringe_bitmap */
10528 0, /* destroy_fringe_bitmap */
10529 x_compute_glyph_string_overhangs,
10530 x_draw_glyph_string,
10531 x_define_frame_cursor,
10532 x_clear_frame_area,
10533 x_draw_window_cursor,
10534 x_draw_vertical_window_border,
10535 x_shift_glyphs_for_insert
10539 /* This function is called when the last frame on a display is deleted. */
10540 void
10541 x_delete_terminal (struct terminal *terminal)
10543 struct x_display_info *dpyinfo = terminal->display_info.x;
10545 /* Protect against recursive calls. delete_frame in
10546 delete_terminal calls us back when it deletes our last frame. */
10547 if (!terminal->name)
10548 return;
10550 block_input ();
10551 #ifdef HAVE_X_I18N
10552 /* We must close our connection to the XIM server before closing the
10553 X display. */
10554 if (dpyinfo->xim)
10555 xim_close_dpy (dpyinfo);
10556 #endif
10558 /* If called from x_connection_closed, the display may already be closed
10559 and dpyinfo->display was set to 0 to indicate that. */
10560 if (dpyinfo->display)
10562 x_destroy_all_bitmaps (dpyinfo);
10563 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10565 /* Whether or not XCloseDisplay destroys the associated resource
10566 database depends on the version of libX11. To avoid both
10567 crash and memory leak, we dissociate the database from the
10568 display and then destroy dpyinfo->xrdb ourselves.
10570 Unfortunately, the above strategy does not work in some
10571 situations due to a bug in newer versions of libX11: because
10572 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10573 dpy->db is NULL, XCloseDisplay destroys the associated
10574 database whereas it has not been created by XGetDefault
10575 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10576 don't destroy the database here in order to avoid the crash
10577 in the above situations for now, though that may cause memory
10578 leaks in other situations. */
10579 #if 0
10580 #ifdef HAVE_XRMSETDATABASE
10581 XrmSetDatabase (dpyinfo->display, NULL);
10582 #else
10583 dpyinfo->display->db = NULL;
10584 #endif
10585 /* We used to call XrmDestroyDatabase from x_delete_display, but
10586 some older versions of libX11 crash if we call it after
10587 closing all the displays. */
10588 XrmDestroyDatabase (dpyinfo->xrdb);
10589 #endif
10591 #ifdef USE_GTK
10592 xg_display_close (dpyinfo->display);
10593 #else
10594 #ifdef USE_X_TOOLKIT
10595 XtCloseDisplay (dpyinfo->display);
10596 #else
10597 XCloseDisplay (dpyinfo->display);
10598 #endif
10599 #endif /* ! USE_GTK */
10602 /* Mark as dead. */
10603 dpyinfo->display = NULL;
10604 x_delete_display (dpyinfo);
10605 unblock_input ();
10608 /* Create a struct terminal, initialize it with the X11 specific
10609 functions and make DISPLAY->TERMINAL point to it. */
10611 static struct terminal *
10612 x_create_terminal (struct x_display_info *dpyinfo)
10614 struct terminal *terminal;
10616 terminal = create_terminal ();
10618 terminal->type = output_x_window;
10619 terminal->display_info.x = dpyinfo;
10620 dpyinfo->terminal = terminal;
10622 /* kboard is initialized in x_term_init. */
10624 terminal->clear_frame_hook = x_clear_frame;
10625 terminal->ins_del_lines_hook = x_ins_del_lines;
10626 terminal->delete_glyphs_hook = x_delete_glyphs;
10627 terminal->ring_bell_hook = XTring_bell;
10628 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10629 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10630 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10631 terminal->update_begin_hook = x_update_begin;
10632 terminal->update_end_hook = x_update_end;
10633 terminal->set_terminal_window_hook = XTset_terminal_window;
10634 terminal->read_socket_hook = XTread_socket;
10635 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10636 terminal->mouse_position_hook = XTmouse_position;
10637 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10638 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10639 terminal->fullscreen_hook = XTfullscreen_hook;
10640 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10641 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10642 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10643 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10645 terminal->delete_frame_hook = x_destroy_window;
10646 terminal->delete_terminal_hook = x_delete_terminal;
10648 terminal->rif = &x_redisplay_interface;
10649 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10650 terminal->char_ins_del_ok = 1;
10651 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10652 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10653 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10654 off the bottom. */
10656 return terminal;
10659 void
10660 x_initialize (void)
10662 baud_rate = 19200;
10664 x_noop_count = 0;
10665 last_tool_bar_item = -1;
10666 any_help_event_p = 0;
10667 ignore_next_mouse_click_timeout = 0;
10669 #ifdef USE_GTK
10670 current_count = -1;
10671 #endif
10673 /* Try to use interrupt input; if we can't, then start polling. */
10674 Fset_input_interrupt_mode (Qt);
10676 #ifdef USE_X_TOOLKIT
10677 XtToolkitInitialize ();
10679 Xt_app_con = XtCreateApplicationContext ();
10681 /* Register a converter from strings to pixels, which uses
10682 Emacs' color allocation infrastructure. */
10683 XtAppSetTypeConverter (Xt_app_con,
10684 XtRString, XtRPixel, cvt_string_to_pixel,
10685 cvt_string_to_pixel_args,
10686 XtNumber (cvt_string_to_pixel_args),
10687 XtCacheByDisplay, cvt_pixel_dtor);
10689 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10690 #endif
10692 #ifdef USE_TOOLKIT_SCROLL_BARS
10693 #ifndef USE_GTK
10694 xaw3d_arrow_scroll = False;
10695 xaw3d_pick_top = True;
10696 #endif
10697 #endif
10699 pending_autoraise_frame = 0;
10700 pending_event_wait.f = 0;
10701 pending_event_wait.eventtype = 0;
10703 /* Note that there is no real way portable across R3/R4 to get the
10704 original error handler. */
10705 XSetErrorHandler (x_error_handler);
10706 XSetIOErrorHandler (x_io_error_quitter);
10710 void
10711 syms_of_xterm (void)
10713 x_error_message = NULL;
10715 staticpro (&x_display_name_list);
10716 x_display_name_list = Qnil;
10718 staticpro (&last_mouse_scroll_bar);
10719 last_mouse_scroll_bar = Qnil;
10721 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
10722 DEFSYM (Qlatin_1, "latin-1");
10724 staticpro (&last_mouse_press_frame);
10725 last_mouse_press_frame = Qnil;
10727 #ifdef USE_GTK
10728 xg_default_icon_file = build_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10729 staticpro (&xg_default_icon_file);
10731 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
10732 #endif
10734 DEFVAR_BOOL ("x-use-underline-position-properties",
10735 x_use_underline_position_properties,
10736 doc: /* Non-nil means make use of UNDERLINE_POSITION font properties.
10737 A value of nil means ignore them. If you encounter fonts with bogus
10738 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10739 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10740 to override the font's UNDERLINE_POSITION for small font display
10741 sizes. */);
10742 x_use_underline_position_properties = 1;
10744 DEFVAR_BOOL ("x-underline-at-descent-line",
10745 x_underline_at_descent_line,
10746 doc: /* Non-nil means to draw the underline at the same place as the descent line.
10747 A value of nil means to draw the underline according to the value of the
10748 variable `x-use-underline-position-properties', which is usually at the
10749 baseline level. The default value is nil. */);
10750 x_underline_at_descent_line = 0;
10752 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10753 x_mouse_click_focus_ignore_position,
10754 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10755 This variable is only used when the window manager requires that you
10756 click on a frame to select it (give it focus). In that case, a value
10757 of nil, means that the selected window and cursor position changes to
10758 reflect the mouse click position, while a non-nil value means that the
10759 selected window or cursor position is preserved. */);
10760 x_mouse_click_focus_ignore_position = 0;
10762 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10763 doc: /* Which toolkit scroll bars Emacs uses, if any.
10764 A value of nil means Emacs doesn't use toolkit scroll bars.
10765 With the X Window system, the value is a symbol describing the
10766 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10767 With MS Windows or Nextstep, the value is t. */);
10768 #ifdef USE_TOOLKIT_SCROLL_BARS
10769 #ifdef USE_MOTIF
10770 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10771 #elif defined HAVE_XAW3D
10772 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10773 #elif USE_GTK
10774 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10775 #else
10776 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10777 #endif
10778 #else
10779 Vx_toolkit_scroll_bars = Qnil;
10780 #endif
10782 staticpro (&last_mouse_motion_frame);
10783 last_mouse_motion_frame = Qnil;
10785 Qmodifier_value = intern_c_string ("modifier-value");
10786 Qalt = intern_c_string ("alt");
10787 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10788 Qhyper = intern_c_string ("hyper");
10789 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10790 Qmeta = intern_c_string ("meta");
10791 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10792 Qsuper = intern_c_string ("super");
10793 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10795 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10796 doc: /* Which keys Emacs uses for the alt modifier.
10797 This should be one of the symbols `alt', `hyper', `meta', `super'.
10798 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10799 is nil, which is the same as `alt'. */);
10800 Vx_alt_keysym = Qnil;
10802 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10803 doc: /* Which keys Emacs uses for the hyper modifier.
10804 This should be one of the symbols `alt', `hyper', `meta', `super'.
10805 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10806 default is nil, which is the same as `hyper'. */);
10807 Vx_hyper_keysym = Qnil;
10809 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10810 doc: /* Which keys Emacs uses for the meta modifier.
10811 This should be one of the symbols `alt', `hyper', `meta', `super'.
10812 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10813 default is nil, which is the same as `meta'. */);
10814 Vx_meta_keysym = Qnil;
10816 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10817 doc: /* Which keys Emacs uses for the super modifier.
10818 This should be one of the symbols `alt', `hyper', `meta', `super'.
10819 For example, `super' means use the Super_L and Super_R keysyms. The
10820 default is nil, which is the same as `super'. */);
10821 Vx_super_keysym = Qnil;
10823 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10824 doc: /* Hash table of character codes indexed by X keysym codes. */);
10825 Vx_keysym_table = make_hash_table (hashtest_eql, make_number (900),
10826 make_float (DEFAULT_REHASH_SIZE),
10827 make_float (DEFAULT_REHASH_THRESHOLD),
10828 Qnil);
10831 #endif /* HAVE_X_WINDOWS */