Set _NET_WM_WINDOW_OPACITY on outer window manager window also.
[emacs.git] / src / xterm.c
blob74e905cd246112e4b001bb08c03ffba7468b3c69
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993-2011 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 <signal.h>
25 #include <stdio.h>
26 #include <setjmp.h>
28 #ifdef HAVE_X_WINDOWS
30 #include "lisp.h"
31 #include "blockinput.h"
33 /* Need syssignal.h for various externs and definitions that may be required
34 by some configurations for calls to signal later in this source file. */
35 #include "syssignal.h"
37 /* This may include sys/types.h, and that somehow loses
38 if this is not done before the other system files. */
39 #include "xterm.h"
40 #include <X11/cursorfont.h>
42 /* Load sys/types.h if not already loaded.
43 In some systems loading it twice is suicidal. */
44 #ifndef makedev
45 #include <sys/types.h>
46 #endif /* makedev */
48 #include <sys/ioctl.h>
50 #include "systime.h"
52 #include <fcntl.h>
53 #include <ctype.h>
54 #include <errno.h>
55 #include <setjmp.h>
56 #include <sys/stat.h>
57 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
58 /* #include <sys/param.h> */
60 #include "charset.h"
61 #include "character.h"
62 #include "coding.h"
63 #include "frame.h"
64 #include "dispextern.h"
65 #include "fontset.h"
66 #include "termhooks.h"
67 #include "termopts.h"
68 #include "termchar.h"
69 #include "emacs-icon.h"
70 #include "disptab.h"
71 #include "buffer.h"
72 #include "window.h"
73 #include "keyboard.h"
74 #include "intervals.h"
75 #include "process.h"
76 #include "atimer.h"
77 #include "keymap.h"
78 #include "font.h"
79 #include "fontset.h"
80 #include "xsettings.h"
81 #include "xgselect.h"
82 #include "sysselect.h"
84 #ifdef USE_X_TOOLKIT
85 #include <X11/Shell.h>
86 #endif
88 #ifdef HAVE_SYS_TIME_H
89 #include <sys/time.h>
90 #endif
92 #include <unistd.h>
94 #ifdef USE_GTK
95 #include "gtkutil.h"
96 #endif
98 #ifdef USE_LUCID
99 #include "../lwlib/xlwmenu.h"
100 #endif
102 #ifdef USE_X_TOOLKIT
103 #if !defined(NO_EDITRES)
104 #define HACK_EDITRES
105 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
106 #endif /* not NO_EDITRES */
108 /* Include toolkit specific headers for the scroll bar widget. */
110 #ifdef USE_TOOLKIT_SCROLL_BARS
111 #if defined USE_MOTIF
112 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
113 #include <Xm/ScrollBar.h>
114 #else /* !USE_MOTIF i.e. use Xaw */
116 #ifdef HAVE_XAW3D
117 #include <X11/Xaw3d/Simple.h>
118 #include <X11/Xaw3d/Scrollbar.h>
119 #include <X11/Xaw3d/ThreeD.h>
120 #else /* !HAVE_XAW3D */
121 #include <X11/Xaw/Simple.h>
122 #include <X11/Xaw/Scrollbar.h>
123 #endif /* !HAVE_XAW3D */
124 #ifndef XtNpickTop
125 #define XtNpickTop "pickTop"
126 #endif /* !XtNpickTop */
127 #endif /* !USE_MOTIF */
128 #endif /* USE_TOOLKIT_SCROLL_BARS */
130 #endif /* USE_X_TOOLKIT */
132 #ifdef USE_X_TOOLKIT
133 #include "widget.h"
134 #ifndef XtNinitialState
135 #define XtNinitialState "initialState"
136 #endif
137 #endif
139 /* Default to using XIM if available. */
140 #ifdef USE_XIM
141 int use_xim = 1;
142 #else
143 int use_xim = 0; /* configure --without-xim */
144 #endif
148 /* Non-zero means that a HELP_EVENT has been generated since Emacs
149 start. */
151 static int any_help_event_p;
153 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
154 static Lisp_Object last_window;
156 /* This is a chain of structures for all the X displays currently in
157 use. */
159 struct x_display_info *x_display_list;
161 /* This is a list of cons cells, each of the form (NAME
162 . FONT-LIST-CACHE), one for each element of x_display_list and in
163 the same order. NAME is the name of the frame. FONT-LIST-CACHE
164 records previous values returned by x-list-fonts. */
166 Lisp_Object x_display_name_list;
168 /* Frame being updated by update_frame. This is declared in term.c.
169 This is set by update_begin and looked at by all the XT functions.
170 It is zero while not inside an update. In that case, the XT
171 functions assume that `selected_frame' is the frame to apply to. */
173 extern struct frame *updating_frame;
175 /* This is a frame waiting to be auto-raised, within XTread_socket. */
177 static struct frame *pending_autoraise_frame;
179 /* This is a frame waiting for an event matching mask, within XTread_socket. */
181 static struct {
182 struct frame *f;
183 int eventtype;
184 } pending_event_wait;
186 #ifdef USE_X_TOOLKIT
187 /* The application context for Xt use. */
188 XtAppContext Xt_app_con;
189 static String Xt_default_resources[] = {0};
191 /* Non-zero means user is interacting with a toolkit scroll bar. */
193 static int toolkit_scroll_bar_interaction;
194 #endif /* USE_X_TOOLKIT */
196 /* Non-zero timeout value means ignore next mouse click if it arrives
197 before that timeout elapses (i.e. as part of the same sequence of
198 events resulting from clicking on a frame to select it). */
200 static unsigned long ignore_next_mouse_click_timeout;
202 /* Mouse movement.
204 Formerly, we used PointerMotionHintMask (in standard_event_mask)
205 so that we would have to call XQueryPointer after each MotionNotify
206 event to ask for another such event. However, this made mouse tracking
207 slow, and there was a bug that made it eventually stop.
209 Simply asking for MotionNotify all the time seems to work better.
211 In order to avoid asking for motion events and then throwing most
212 of them away or busy-polling the server for mouse positions, we ask
213 the server for pointer motion hints. This means that we get only
214 one event per group of mouse movements. "Groups" are delimited by
215 other kinds of events (focus changes and button clicks, for
216 example), or by XQueryPointer calls; when one of these happens, we
217 get another MotionNotify event the next time the mouse moves. This
218 is at least as efficient as getting motion events when mouse
219 tracking is on, and I suspect only negligibly worse when tracking
220 is off. */
222 /* Where the mouse was last time we reported a mouse event. */
224 static XRectangle last_mouse_glyph;
225 static FRAME_PTR last_mouse_glyph_frame;
226 static Lisp_Object last_mouse_press_frame;
228 /* The scroll bar in which the last X motion event occurred.
230 If the last X motion event occurred in a scroll bar, we set this so
231 XTmouse_position can know whether to report a scroll bar motion or
232 an ordinary motion.
234 If the last X motion event didn't occur in a scroll bar, we set
235 this to Qnil, to tell XTmouse_position to return an ordinary motion
236 event. */
238 static Lisp_Object last_mouse_scroll_bar;
240 /* This is a hack. We would really prefer that XTmouse_position would
241 return the time associated with the position it returns, but there
242 doesn't seem to be any way to wrest the time-stamp from the server
243 along with the position query. So, we just keep track of the time
244 of the last movement we received, and return that in hopes that
245 it's somewhat accurate. */
247 static Time last_mouse_movement_time;
249 /* Time for last user interaction as returned in X events. */
251 static Time last_user_time;
253 /* Incremented by XTread_socket whenever it really tries to read
254 events. */
256 #ifdef __STDC__
257 static int volatile input_signal_count;
258 #else
259 static int input_signal_count;
260 #endif
262 /* Used locally within XTread_socket. */
264 static int x_noop_count;
266 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
268 static Lisp_Object Qvendor_specific_keysyms;
269 static Lisp_Object Qlatin_1;
271 #ifdef USE_GTK
272 /* The name of the Emacs icon file. */
273 static Lisp_Object xg_default_icon_file;
275 /* Used in gtkutil.c. */
276 Lisp_Object Qx_gtk_map_stock;
277 #endif
279 /* Some functions take this as char *, not const char *. */
280 static char emacs_class[] = EMACS_CLASS;
282 enum xembed_info
284 XEMBED_MAPPED = 1 << 0
287 enum xembed_message
289 XEMBED_EMBEDDED_NOTIFY = 0,
290 XEMBED_WINDOW_ACTIVATE = 1,
291 XEMBED_WINDOW_DEACTIVATE = 2,
292 XEMBED_REQUEST_FOCUS = 3,
293 XEMBED_FOCUS_IN = 4,
294 XEMBED_FOCUS_OUT = 5,
295 XEMBED_FOCUS_NEXT = 6,
296 XEMBED_FOCUS_PREV = 7,
298 XEMBED_MODALITY_ON = 10,
299 XEMBED_MODALITY_OFF = 11,
300 XEMBED_REGISTER_ACCELERATOR = 12,
301 XEMBED_UNREGISTER_ACCELERATOR = 13,
302 XEMBED_ACTIVATE_ACCELERATOR = 14
305 /* Used in x_flush. */
307 static int x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
308 static void x_set_window_size_1 (struct frame *, int, int, int);
309 static void x_raise_frame (struct frame *);
310 static void x_lower_frame (struct frame *);
311 static const XColor *x_color_cells (Display *, int *);
312 static void x_update_window_end (struct window *, int, int);
314 static int x_io_error_quitter (Display *);
315 static struct terminal *x_create_terminal (struct x_display_info *);
316 void x_delete_terminal (struct terminal *);
317 static void x_update_end (struct frame *);
318 static void XTframe_up_to_date (struct frame *);
319 static void XTset_terminal_modes (struct terminal *);
320 static void XTreset_terminal_modes (struct terminal *);
321 static void x_clear_frame (struct frame *);
322 static void x_ins_del_lines (struct frame *, int, int) NO_RETURN;
323 static void frame_highlight (struct frame *);
324 static void frame_unhighlight (struct frame *);
325 static void x_new_focus_frame (struct x_display_info *, struct frame *);
326 static void x_focus_changed (int, int, struct x_display_info *,
327 struct frame *, struct input_event *);
328 static void x_detect_focus_change (struct x_display_info *,
329 XEvent *, struct input_event *);
330 static void XTframe_rehighlight (struct frame *);
331 static void x_frame_rehighlight (struct x_display_info *);
332 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
333 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
334 enum text_cursor_kinds);
336 static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
337 static void x_flush (struct frame *f);
338 static void x_update_begin (struct frame *);
339 static void x_update_window_begin (struct window *);
340 static void x_after_update_window_line (struct glyph_row *);
341 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
342 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
343 enum scroll_bar_part *,
344 Lisp_Object *, Lisp_Object *,
345 Time *);
346 static void x_handle_net_wm_state (struct frame *, XPropertyEvent *);
347 static void x_check_fullscreen (struct frame *);
348 static void x_check_expected_move (struct frame *, int, int);
349 static void x_sync_with_move (struct frame *, int, int, int);
350 static int handle_one_xevent (struct x_display_info *, XEvent *,
351 int *, struct input_event *);
352 #ifdef USE_GTK
353 static int x_dispatch_event (XEvent *, Display *);
354 #endif
355 /* Don't declare this NO_RETURN because we want no
356 interference with debugging failing X calls. */
357 static void x_connection_closed (Display *, const char *);
358 static void x_wm_set_window_state (struct frame *, int);
359 static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
360 static void x_initialize (void);
363 /* Flush display of frame F, or of all frames if F is null. */
365 static void
366 x_flush (struct frame *f)
368 /* Don't call XFlush when it is not safe to redisplay; the X
369 connection may be broken. */
370 if (!NILP (Vinhibit_redisplay))
371 return;
373 BLOCK_INPUT;
374 if (f == NULL)
376 Lisp_Object rest, frame;
377 FOR_EACH_FRAME (rest, frame)
378 if (FRAME_X_P (XFRAME (frame)))
379 x_flush (XFRAME (frame));
381 else if (FRAME_X_P (f))
382 XFlush (FRAME_X_DISPLAY (f));
383 UNBLOCK_INPUT;
387 /* Remove calls to XFlush by defining XFlush to an empty replacement.
388 Calls to XFlush should be unnecessary because the X output buffer
389 is flushed automatically as needed by calls to XPending,
390 XNextEvent, or XWindowEvent according to the XFlush man page.
391 XTread_socket calls XPending. Removing XFlush improves
392 performance. */
394 #define XFlush(DISPLAY) (void) 0
397 /***********************************************************************
398 Debugging
399 ***********************************************************************/
401 #if 0
403 /* This is a function useful for recording debugging information about
404 the sequence of occurrences in this file. */
406 struct record
408 char *locus;
409 int type;
412 struct record event_record[100];
414 int event_record_index;
416 void
417 record_event (char *locus, int type)
419 if (event_record_index == sizeof (event_record) / sizeof (struct record))
420 event_record_index = 0;
422 event_record[event_record_index].locus = locus;
423 event_record[event_record_index].type = type;
424 event_record_index++;
427 #endif /* 0 */
431 /* Return the struct x_display_info corresponding to DPY. */
433 struct x_display_info *
434 x_display_info_for_display (Display *dpy)
436 struct x_display_info *dpyinfo;
438 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
439 if (dpyinfo->display == dpy)
440 return dpyinfo;
442 return 0;
445 static Window
446 x_find_topmost_parent (struct frame *f)
448 struct x_output *x = f->output_data.x;
449 Window win = None, wi = x->parent_desc;
450 Display *dpy = FRAME_X_DISPLAY (f);
452 while (wi != FRAME_X_DISPLAY_INFO (f)->root_window)
454 Window root;
455 Window *children;
456 unsigned int nchildren;
458 win = wi;
459 XQueryTree (dpy, win, &root, &wi, &children, &nchildren);
460 XFree (children);
463 return win;
466 #define OPAQUE 0xffffffff
468 void
469 x_set_frame_alpha (struct frame *f)
471 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
472 Display *dpy = FRAME_X_DISPLAY (f);
473 Window win = FRAME_OUTER_WINDOW (f);
474 double alpha = 1.0;
475 double alpha_min = 1.0;
476 unsigned long opac;
477 Window parent;
479 if (dpyinfo->x_highlight_frame == f)
480 alpha = f->alpha[0];
481 else
482 alpha = f->alpha[1];
484 if (FLOATP (Vframe_alpha_lower_limit))
485 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
486 else if (INTEGERP (Vframe_alpha_lower_limit))
487 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
489 if (alpha < 0.0)
490 return;
491 else if (alpha > 1.0)
492 alpha = 1.0;
493 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
494 alpha = alpha_min;
496 opac = alpha * OPAQUE;
498 x_catch_errors (dpy);
500 /* If there is a parent from the window manager, put the property there
501 also, to work around broken window managers that fail to do that.
502 Do this unconditionally as this function is called on reparent when
503 alpha has not changed on the frame. */
505 parent = x_find_topmost_parent (f);
506 if (parent != None)
507 XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
508 XA_CARDINAL, 32, PropModeReplace,
509 (unsigned char *) &opac, 1L);
511 /* return unless necessary */
513 unsigned char *data;
514 Atom actual;
515 int rc, format;
516 unsigned long n, left;
518 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
519 0L, 1L, False, XA_CARDINAL,
520 &actual, &format, &n, &left,
521 &data);
523 if (rc == Success && actual != None)
525 unsigned long value = *(unsigned long *)data;
526 XFree ((void *) data);
527 if (value == opac)
529 x_uncatch_errors ();
530 return;
535 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
536 XA_CARDINAL, 32, PropModeReplace,
537 (unsigned char *) &opac, 1L);
538 x_uncatch_errors ();
542 x_display_pixel_height (struct x_display_info *dpyinfo)
544 return HeightOfScreen (dpyinfo->screen);
548 x_display_pixel_width (struct x_display_info *dpyinfo)
550 return WidthOfScreen (dpyinfo->screen);
554 /***********************************************************************
555 Starting and ending an update
556 ***********************************************************************/
558 /* Start an update of frame F. This function is installed as a hook
559 for update_begin, i.e. it is called when update_begin is called.
560 This function is called prior to calls to x_update_window_begin for
561 each window being updated. Currently, there is nothing to do here
562 because all interesting stuff is done on a window basis. */
564 static void
565 x_update_begin (struct frame *f)
567 /* Nothing to do. */
571 /* Start update of window W. Set the global variable updated_window
572 to the window being updated and set output_cursor to the cursor
573 position of W. */
575 static void
576 x_update_window_begin (struct window *w)
578 struct frame *f = XFRAME (WINDOW_FRAME (w));
579 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
581 updated_window = w;
582 set_output_cursor (&w->cursor);
584 BLOCK_INPUT;
586 if (f == hlinfo->mouse_face_mouse_frame)
588 /* Don't do highlighting for mouse motion during the update. */
589 hlinfo->mouse_face_defer = 1;
591 /* If F needs to be redrawn, simply forget about any prior mouse
592 highlighting. */
593 if (FRAME_GARBAGED_P (f))
594 hlinfo->mouse_face_window = Qnil;
597 UNBLOCK_INPUT;
601 /* Draw a vertical window border from (x,y0) to (x,y1) */
603 static void
604 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
606 struct frame *f = XFRAME (WINDOW_FRAME (w));
607 struct face *face;
609 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
610 if (face)
611 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
612 face->foreground);
614 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
615 f->output_data.x->normal_gc, x, y0, x, y1);
618 /* End update of window W (which is equal to updated_window).
620 Draw vertical borders between horizontally adjacent windows, and
621 display W's cursor if CURSOR_ON_P is non-zero.
623 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
624 glyphs in mouse-face were overwritten. In that case we have to
625 make sure that the mouse-highlight is properly redrawn.
627 W may be a menu bar pseudo-window in case we don't have X toolkit
628 support. Such windows don't have a cursor, so don't display it
629 here. */
631 static void
632 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
634 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
636 if (!w->pseudo_window_p)
638 BLOCK_INPUT;
640 if (cursor_on_p)
641 display_and_set_cursor (w, 1, output_cursor.hpos,
642 output_cursor.vpos,
643 output_cursor.x, output_cursor.y);
645 if (draw_window_fringes (w, 1))
646 x_draw_vertical_border (w);
648 UNBLOCK_INPUT;
651 /* If a row with mouse-face was overwritten, arrange for
652 XTframe_up_to_date to redisplay the mouse highlight. */
653 if (mouse_face_overwritten_p)
655 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
656 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
657 hlinfo->mouse_face_window = Qnil;
660 updated_window = NULL;
664 /* End update of frame F. This function is installed as a hook in
665 update_end. */
667 static void
668 x_update_end (struct frame *f)
670 /* Mouse highlight may be displayed again. */
671 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
673 #ifndef XFlush
674 BLOCK_INPUT;
675 XFlush (FRAME_X_DISPLAY (f));
676 UNBLOCK_INPUT;
677 #endif
681 /* This function is called from various places in xdisp.c whenever a
682 complete update has been performed. The global variable
683 updated_window is not available here. */
685 static void
686 XTframe_up_to_date (struct frame *f)
688 if (FRAME_X_P (f))
690 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
692 if (hlinfo->mouse_face_deferred_gc
693 || f == hlinfo->mouse_face_mouse_frame)
695 BLOCK_INPUT;
696 if (hlinfo->mouse_face_mouse_frame)
697 note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
698 hlinfo->mouse_face_mouse_x,
699 hlinfo->mouse_face_mouse_y);
700 hlinfo->mouse_face_deferred_gc = 0;
701 UNBLOCK_INPUT;
707 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
708 arrow bitmaps, or clear the fringes if no bitmaps are required
709 before DESIRED_ROW is made current. The window being updated is
710 found in updated_window. This function It is called from
711 update_window_line only if it is known that there are differences
712 between bitmaps to be drawn between current row and DESIRED_ROW. */
714 static void
715 x_after_update_window_line (struct glyph_row *desired_row)
717 struct window *w = updated_window;
718 struct frame *f;
719 int width, height;
721 xassert (w);
723 if (!desired_row->mode_line_p && !w->pseudo_window_p)
724 desired_row->redraw_fringe_bitmaps_p = 1;
726 /* When a window has disappeared, make sure that no rest of
727 full-width rows stays visible in the internal border. Could
728 check here if updated_window is the leftmost/rightmost window,
729 but I guess it's not worth doing since vertically split windows
730 are almost never used, internal border is rarely set, and the
731 overhead is very small. */
732 if (windows_or_buffers_changed
733 && desired_row->full_width_p
734 && (f = XFRAME (w->frame),
735 width = FRAME_INTERNAL_BORDER_WIDTH (f),
736 width != 0)
737 && (height = desired_row->visible_height,
738 height > 0))
740 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
742 BLOCK_INPUT;
743 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
744 0, y, width, height, False);
745 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
746 FRAME_PIXEL_WIDTH (f) - width,
747 y, width, height, False);
748 UNBLOCK_INPUT;
752 static void
753 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
755 struct frame *f = XFRAME (WINDOW_FRAME (w));
756 Display *display = FRAME_X_DISPLAY (f);
757 Window window = FRAME_X_WINDOW (f);
758 GC gc = f->output_data.x->normal_gc;
759 struct face *face = p->face;
761 /* Must clip because of partially visible lines. */
762 x_clip_to_row (w, row, -1, gc);
764 if (!p->overlay_p)
766 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
768 /* In case the same realized face is used for fringes and
769 for something displayed in the text (e.g. face `region' on
770 mono-displays, the fill style may have been changed to
771 FillSolid in x_draw_glyph_string_background. */
772 if (face->stipple)
773 XSetFillStyle (display, face->gc, FillOpaqueStippled);
774 else
775 XSetForeground (display, face->gc, face->background);
777 #ifdef USE_TOOLKIT_SCROLL_BARS
778 /* If the fringe is adjacent to the left (right) scroll bar of a
779 leftmost (rightmost, respectively) window, then extend its
780 background to the gap between the fringe and the bar. */
781 if ((WINDOW_LEFTMOST_P (w)
782 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
783 || (WINDOW_RIGHTMOST_P (w)
784 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
786 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
788 if (sb_width > 0)
790 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
791 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
792 * FRAME_COLUMN_WIDTH (f));
794 if (bx < 0)
796 /* Bitmap fills the fringe. */
797 if (bar_area_x + bar_area_width == p->x)
798 bx = bar_area_x + sb_width;
799 else if (p->x + p->wd == bar_area_x)
800 bx = bar_area_x;
801 if (bx >= 0)
803 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
805 nx = bar_area_width - sb_width;
806 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
807 row->y));
808 ny = row->visible_height;
811 else
813 if (bar_area_x + bar_area_width == bx)
815 bx = bar_area_x + sb_width;
816 nx += bar_area_width - sb_width;
818 else if (bx + nx == bar_area_x)
819 nx += bar_area_width - sb_width;
823 #endif
824 if (bx >= 0 && nx > 0)
825 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
827 if (!face->stipple)
828 XSetForeground (display, face->gc, face->foreground);
831 if (p->which)
833 char *bits;
834 Pixmap pixmap, clipmask = (Pixmap) 0;
835 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
836 XGCValues gcv;
838 if (p->wd > 8)
839 bits = (char *) (p->bits + p->dh);
840 else
841 bits = (char *) p->bits + p->dh;
843 /* Draw the bitmap. I believe these small pixmaps can be cached
844 by the server. */
845 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
846 (p->cursor_p
847 ? (p->overlay_p ? face->background
848 : f->output_data.x->cursor_pixel)
849 : face->foreground),
850 face->background, depth);
852 if (p->overlay_p)
854 clipmask = XCreatePixmapFromBitmapData (display,
855 FRAME_X_DISPLAY_INFO (f)->root_window,
856 bits, p->wd, p->h,
857 1, 0, 1);
858 gcv.clip_mask = clipmask;
859 gcv.clip_x_origin = p->x;
860 gcv.clip_y_origin = p->y;
861 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
864 XCopyArea (display, pixmap, window, gc, 0, 0,
865 p->wd, p->h, p->x, p->y);
866 XFreePixmap (display, pixmap);
868 if (p->overlay_p)
870 gcv.clip_mask = (Pixmap) 0;
871 XChangeGC (display, gc, GCClipMask, &gcv);
872 XFreePixmap (display, clipmask);
876 XSetClipMask (display, gc, None);
881 /* This is called when starting Emacs and when restarting after
882 suspend. When starting Emacs, no X window is mapped. And nothing
883 must be done to Emacs's own window if it is suspended (though that
884 rarely happens). */
886 static void
887 XTset_terminal_modes (struct terminal *terminal)
891 /* This is called when exiting or suspending Emacs. Exiting will make
892 the X-windows go away, and suspending requires no action. */
894 static void
895 XTreset_terminal_modes (struct terminal *terminal)
900 /***********************************************************************
901 Glyph display
902 ***********************************************************************/
906 static void x_set_glyph_string_clipping (struct glyph_string *);
907 static void x_set_glyph_string_gc (struct glyph_string *);
908 static void x_draw_glyph_string_background (struct glyph_string *,
909 int);
910 static void x_draw_glyph_string_foreground (struct glyph_string *);
911 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
912 static void x_draw_glyph_string_box (struct glyph_string *);
913 static void x_draw_glyph_string (struct glyph_string *);
914 static void x_delete_glyphs (struct frame *, int) NO_RETURN;
915 static void x_compute_glyph_string_overhangs (struct glyph_string *);
916 static void x_set_cursor_gc (struct glyph_string *);
917 static void x_set_mode_line_face_gc (struct glyph_string *);
918 static void x_set_mouse_face_gc (struct glyph_string *);
919 static int x_alloc_lighter_color (struct frame *, Display *, Colormap,
920 unsigned long *, double, int);
921 static void x_setup_relief_color (struct frame *, struct relief *,
922 double, int, unsigned long);
923 static void x_setup_relief_colors (struct glyph_string *);
924 static void x_draw_image_glyph_string (struct glyph_string *);
925 static void x_draw_image_relief (struct glyph_string *);
926 static void x_draw_image_foreground (struct glyph_string *);
927 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
928 static void x_clear_glyph_string_rect (struct glyph_string *, int,
929 int, int, int);
930 static void x_draw_relief_rect (struct frame *, int, int, int, int,
931 int, int, int, int, int, int,
932 XRectangle *);
933 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
934 int, int, int, XRectangle *);
935 static void x_scroll_bar_clear (struct frame *);
937 #if GLYPH_DEBUG
938 static void x_check_font (struct frame *, struct font *);
939 #endif
942 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
943 face. */
945 static void
946 x_set_cursor_gc (struct glyph_string *s)
948 if (s->font == FRAME_FONT (s->f)
949 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
950 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
951 && !s->cmp)
952 s->gc = s->f->output_data.x->cursor_gc;
953 else
955 /* Cursor on non-default face: must merge. */
956 XGCValues xgcv;
957 unsigned long mask;
959 xgcv.background = s->f->output_data.x->cursor_pixel;
960 xgcv.foreground = s->face->background;
962 /* If the glyph would be invisible, try a different foreground. */
963 if (xgcv.foreground == xgcv.background)
964 xgcv.foreground = s->face->foreground;
965 if (xgcv.foreground == xgcv.background)
966 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
967 if (xgcv.foreground == xgcv.background)
968 xgcv.foreground = s->face->foreground;
970 /* Make sure the cursor is distinct from text in this face. */
971 if (xgcv.background == s->face->background
972 && xgcv.foreground == s->face->foreground)
974 xgcv.background = s->face->foreground;
975 xgcv.foreground = s->face->background;
978 IF_DEBUG (x_check_font (s->f, s->font));
979 xgcv.graphics_exposures = False;
980 mask = GCForeground | GCBackground | GCGraphicsExposures;
982 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
983 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
984 mask, &xgcv);
985 else
986 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
987 = XCreateGC (s->display, s->window, mask, &xgcv);
989 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
994 /* Set up S->gc of glyph string S for drawing text in mouse face. */
996 static void
997 x_set_mouse_face_gc (struct glyph_string *s)
999 int face_id;
1000 struct face *face;
1002 /* What face has to be used last for the mouse face? */
1003 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
1004 face = FACE_FROM_ID (s->f, face_id);
1005 if (face == NULL)
1006 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1008 if (s->first_glyph->type == CHAR_GLYPH)
1009 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1010 else
1011 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1012 s->face = FACE_FROM_ID (s->f, face_id);
1013 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1015 if (s->font == s->face->font)
1016 s->gc = s->face->gc;
1017 else
1019 /* Otherwise construct scratch_cursor_gc with values from FACE
1020 except for FONT. */
1021 XGCValues xgcv;
1022 unsigned long mask;
1024 xgcv.background = s->face->background;
1025 xgcv.foreground = s->face->foreground;
1026 xgcv.graphics_exposures = False;
1027 mask = GCForeground | GCBackground | GCGraphicsExposures;
1029 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1030 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1031 mask, &xgcv);
1032 else
1033 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1034 = XCreateGC (s->display, s->window, mask, &xgcv);
1036 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1039 xassert (s->gc != 0);
1043 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1044 Faces to use in the mode line have already been computed when the
1045 matrix was built, so there isn't much to do, here. */
1047 static inline void
1048 x_set_mode_line_face_gc (struct glyph_string *s)
1050 s->gc = s->face->gc;
1054 /* Set S->gc of glyph string S for drawing that glyph string. Set
1055 S->stippled_p to a non-zero value if the face of S has a stipple
1056 pattern. */
1058 static inline void
1059 x_set_glyph_string_gc (struct glyph_string *s)
1061 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1063 if (s->hl == DRAW_NORMAL_TEXT)
1065 s->gc = s->face->gc;
1066 s->stippled_p = s->face->stipple != 0;
1068 else if (s->hl == DRAW_INVERSE_VIDEO)
1070 x_set_mode_line_face_gc (s);
1071 s->stippled_p = s->face->stipple != 0;
1073 else if (s->hl == DRAW_CURSOR)
1075 x_set_cursor_gc (s);
1076 s->stippled_p = 0;
1078 else if (s->hl == DRAW_MOUSE_FACE)
1080 x_set_mouse_face_gc (s);
1081 s->stippled_p = s->face->stipple != 0;
1083 else if (s->hl == DRAW_IMAGE_RAISED
1084 || s->hl == DRAW_IMAGE_SUNKEN)
1086 s->gc = s->face->gc;
1087 s->stippled_p = s->face->stipple != 0;
1089 else
1091 s->gc = s->face->gc;
1092 s->stippled_p = s->face->stipple != 0;
1095 /* GC must have been set. */
1096 xassert (s->gc != 0);
1100 /* Set clipping for output of glyph string S. S may be part of a mode
1101 line or menu if we don't have X toolkit support. */
1103 static inline void
1104 x_set_glyph_string_clipping (struct glyph_string *s)
1106 XRectangle *r = s->clip;
1107 int n = get_glyph_string_clip_rects (s, r, 2);
1109 if (n > 0)
1110 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1111 s->num_clips = n;
1115 /* Set SRC's clipping for output of glyph string DST. This is called
1116 when we are drawing DST's left_overhang or right_overhang only in
1117 the area of SRC. */
1119 static void
1120 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1122 XRectangle r;
1124 r.x = src->x;
1125 r.width = src->width;
1126 r.y = src->y;
1127 r.height = src->height;
1128 dst->clip[0] = r;
1129 dst->num_clips = 1;
1130 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1134 /* RIF:
1135 Compute left and right overhang of glyph string S. */
1137 static void
1138 x_compute_glyph_string_overhangs (struct glyph_string *s)
1140 if (s->cmp == NULL
1141 && (s->first_glyph->type == CHAR_GLYPH
1142 || s->first_glyph->type == COMPOSITE_GLYPH))
1144 struct font_metrics metrics;
1146 if (s->first_glyph->type == CHAR_GLYPH)
1148 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1149 struct font *font = s->font;
1150 int i;
1152 for (i = 0; i < s->nchars; i++)
1153 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1154 font->driver->text_extents (font, code, s->nchars, &metrics);
1156 else
1158 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1160 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1162 s->right_overhang = (metrics.rbearing > metrics.width
1163 ? metrics.rbearing - metrics.width : 0);
1164 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1166 else if (s->cmp)
1168 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1169 s->left_overhang = - s->cmp->lbearing;
1174 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1176 static inline void
1177 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1179 XGCValues xgcv;
1180 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1181 XSetForeground (s->display, s->gc, xgcv.background);
1182 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1183 XSetForeground (s->display, s->gc, xgcv.foreground);
1187 /* Draw the background of glyph_string S. If S->background_filled_p
1188 is non-zero don't draw it. FORCE_P non-zero means draw the
1189 background even if it wouldn't be drawn normally. This is used
1190 when a string preceding S draws into the background of S, or S
1191 contains the first component of a composition. */
1193 static void
1194 x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1196 /* Nothing to do if background has already been drawn or if it
1197 shouldn't be drawn in the first place. */
1198 if (!s->background_filled_p)
1200 int box_line_width = max (s->face->box_line_width, 0);
1202 if (s->stippled_p)
1204 /* Fill background with a stipple pattern. */
1205 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1206 XFillRectangle (s->display, s->window, s->gc, s->x,
1207 s->y + box_line_width,
1208 s->background_width,
1209 s->height - 2 * box_line_width);
1210 XSetFillStyle (s->display, s->gc, FillSolid);
1211 s->background_filled_p = 1;
1213 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1214 || s->font_not_found_p
1215 || s->extends_to_end_of_line_p
1216 || force_p)
1218 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1219 s->background_width,
1220 s->height - 2 * box_line_width);
1221 s->background_filled_p = 1;
1227 /* Draw the foreground of glyph string S. */
1229 static void
1230 x_draw_glyph_string_foreground (struct glyph_string *s)
1232 int i, x;
1234 /* If first glyph of S has a left box line, start drawing the text
1235 of S to the right of that box line. */
1236 if (s->face->box != FACE_NO_BOX
1237 && s->first_glyph->left_box_line_p)
1238 x = s->x + eabs (s->face->box_line_width);
1239 else
1240 x = s->x;
1242 /* Draw characters of S as rectangles if S's font could not be
1243 loaded. */
1244 if (s->font_not_found_p)
1246 for (i = 0; i < s->nchars; ++i)
1248 struct glyph *g = s->first_glyph + i;
1249 XDrawRectangle (s->display, s->window,
1250 s->gc, x, s->y, g->pixel_width - 1,
1251 s->height - 1);
1252 x += g->pixel_width;
1255 else
1257 struct font *font = s->font;
1258 int boff = font->baseline_offset;
1259 int y;
1261 if (font->vertical_centering)
1262 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1264 y = s->ybase - boff;
1265 if (s->for_overlaps
1266 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1267 font->driver->draw (s, 0, s->nchars, x, y, 0);
1268 else
1269 font->driver->draw (s, 0, s->nchars, x, y, 1);
1270 if (s->face->overstrike)
1271 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1275 /* Draw the foreground of composite glyph string S. */
1277 static void
1278 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1280 int i, j, x;
1281 struct font *font = s->font;
1283 /* If first glyph of S has a left box line, start drawing the text
1284 of S to the right of that box line. */
1285 if (s->face && s->face->box != FACE_NO_BOX
1286 && s->first_glyph->left_box_line_p)
1287 x = s->x + eabs (s->face->box_line_width);
1288 else
1289 x = s->x;
1291 /* S is a glyph string for a composition. S->cmp_from is the index
1292 of the first character drawn for glyphs of this composition.
1293 S->cmp_from == 0 means we are drawing the very first character of
1294 this composition. */
1296 /* Draw a rectangle for the composition if the font for the very
1297 first character of the composition could not be loaded. */
1298 if (s->font_not_found_p)
1300 if (s->cmp_from == 0)
1301 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1302 s->width - 1, s->height - 1);
1304 else if (! s->first_glyph->u.cmp.automatic)
1306 int y = s->ybase;
1308 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1309 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1311 int xx = x + s->cmp->offsets[j * 2];
1312 int yy = y - s->cmp->offsets[j * 2 + 1];
1314 font->driver->draw (s, j, j + 1, xx, yy, 0);
1315 if (s->face->overstrike)
1316 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1319 else
1321 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1322 Lisp_Object glyph;
1323 int y = s->ybase;
1324 int width = 0;
1326 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1328 glyph = LGSTRING_GLYPH (gstring, i);
1329 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1330 width += LGLYPH_WIDTH (glyph);
1331 else
1333 int xoff, yoff, wadjust;
1335 if (j < i)
1337 font->driver->draw (s, j, i, x, y, 0);
1338 if (s->face->overstrike)
1339 font->driver->draw (s, j, i, x + 1, y, 0);
1340 x += width;
1342 xoff = LGLYPH_XOFF (glyph);
1343 yoff = LGLYPH_YOFF (glyph);
1344 wadjust = LGLYPH_WADJUST (glyph);
1345 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1346 if (s->face->overstrike)
1347 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1348 x += wadjust;
1349 j = i + 1;
1350 width = 0;
1353 if (j < i)
1355 font->driver->draw (s, j, i, x, y, 0);
1356 if (s->face->overstrike)
1357 font->driver->draw (s, j, i, x + 1, y, 0);
1363 /* Draw the foreground of glyph string S for glyphless characters. */
1365 static void
1366 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1368 struct glyph *glyph = s->first_glyph;
1369 XChar2b char2b[8];
1370 int x, i, j;
1372 /* If first glyph of S has a left box line, start drawing the text
1373 of S to the right of that box line. */
1374 if (s->face && s->face->box != FACE_NO_BOX
1375 && s->first_glyph->left_box_line_p)
1376 x = s->x + eabs (s->face->box_line_width);
1377 else
1378 x = s->x;
1380 s->char2b = char2b;
1382 for (i = 0; i < s->nchars; i++, glyph++)
1384 char buf[7], *str = NULL;
1385 int len = glyph->u.glyphless.len;
1387 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1389 if (len > 0
1390 && CHAR_TABLE_P (Vglyphless_char_display)
1391 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1392 >= 1))
1394 Lisp_Object acronym
1395 = (! glyph->u.glyphless.for_no_font
1396 ? CHAR_TABLE_REF (Vglyphless_char_display,
1397 glyph->u.glyphless.ch)
1398 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1399 if (STRINGP (acronym))
1400 str = SSDATA (acronym);
1403 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1405 sprintf ((char *) buf, "%0*X",
1406 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1407 glyph->u.glyphless.ch);
1408 str = buf;
1411 if (str)
1413 int upper_len = (len + 1) / 2;
1414 unsigned code;
1416 /* It is assured that all LEN characters in STR is ASCII. */
1417 for (j = 0; j < len; j++)
1419 code = s->font->driver->encode_char (s->font, str[j]);
1420 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1422 s->font->driver->draw (s, 0, upper_len,
1423 x + glyph->slice.glyphless.upper_xoff,
1424 s->ybase + glyph->slice.glyphless.upper_yoff,
1426 s->font->driver->draw (s, upper_len, len,
1427 x + glyph->slice.glyphless.lower_xoff,
1428 s->ybase + glyph->slice.glyphless.lower_yoff,
1431 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1432 XDrawRectangle (s->display, s->window, s->gc,
1433 x, s->ybase - glyph->ascent,
1434 glyph->pixel_width - 1,
1435 glyph->ascent + glyph->descent - 1);
1436 x += glyph->pixel_width;
1440 #ifdef USE_X_TOOLKIT
1442 static struct frame *x_frame_of_widget (Widget);
1443 static Boolean cvt_string_to_pixel (Display *, XrmValue *, Cardinal *,
1444 XrmValue *, XrmValue *, XtPointer *);
1445 static void cvt_pixel_dtor (XtAppContext, XrmValue *, XtPointer,
1446 XrmValue *, Cardinal *);
1449 /* Return the frame on which widget WIDGET is used.. Abort if frame
1450 cannot be determined. */
1452 static struct frame *
1453 x_frame_of_widget (Widget widget)
1455 struct x_display_info *dpyinfo;
1456 Lisp_Object tail;
1457 struct frame *f;
1459 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1461 /* Find the top-level shell of the widget. Note that this function
1462 can be called when the widget is not yet realized, so XtWindow
1463 (widget) == 0. That's the reason we can't simply use
1464 x_any_window_to_frame. */
1465 while (!XtIsTopLevelShell (widget))
1466 widget = XtParent (widget);
1468 /* Look for a frame with that top-level widget. Allocate the color
1469 on that frame to get the right gamma correction value. */
1470 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1471 if (FRAMEP (XCAR (tail))
1472 && (f = XFRAME (XCAR (tail)),
1473 (FRAME_X_P (f)
1474 && f->output_data.nothing != 1
1475 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1476 && f->output_data.x->widget == widget)
1477 return f;
1479 abort ();
1483 #ifdef USE_LUCID
1485 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1486 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1487 If this produces the same color as PIXEL, try a color where all RGB
1488 values have DELTA added. Return the allocated color in *PIXEL.
1489 DISPLAY is the X display, CMAP is the colormap to operate on.
1490 Value is non-zero if successful. */
1493 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1494 unsigned long *pixel, double factor, int delta)
1496 struct frame *f = x_frame_of_widget (widget);
1497 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1500 #endif
1503 /* Structure specifying which arguments should be passed by Xt to
1504 cvt_string_to_pixel. We want the widget's screen and colormap. */
1506 static XtConvertArgRec cvt_string_to_pixel_args[] =
1508 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1509 sizeof (Screen *)},
1510 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1511 sizeof (Colormap)}
1515 /* The address of this variable is returned by
1516 cvt_string_to_pixel. */
1518 static Pixel cvt_string_to_pixel_value;
1521 /* Convert a color name to a pixel color.
1523 DPY is the display we are working on.
1525 ARGS is an array of *NARGS XrmValue structures holding additional
1526 information about the widget for which the conversion takes place.
1527 The contents of this array are determined by the specification
1528 in cvt_string_to_pixel_args.
1530 FROM is a pointer to an XrmValue which points to the color name to
1531 convert. TO is an XrmValue in which to return the pixel color.
1533 CLOSURE_RET is a pointer to user-data, in which we record if
1534 we allocated the color or not.
1536 Value is True if successful, False otherwise. */
1538 static Boolean
1539 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1540 XrmValue *from, XrmValue *to,
1541 XtPointer *closure_ret)
1543 Screen *screen;
1544 Colormap cmap;
1545 Pixel pixel;
1546 String color_name;
1547 XColor color;
1549 if (*nargs != 2)
1551 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1552 "wrongParameters", "cvt_string_to_pixel",
1553 "XtToolkitError",
1554 "Screen and colormap args required", NULL, NULL);
1555 return False;
1558 screen = *(Screen **) args[0].addr;
1559 cmap = *(Colormap *) args[1].addr;
1560 color_name = (String) from->addr;
1562 if (strcmp (color_name, XtDefaultBackground) == 0)
1564 *closure_ret = (XtPointer) False;
1565 pixel = WhitePixelOfScreen (screen);
1567 else if (strcmp (color_name, XtDefaultForeground) == 0)
1569 *closure_ret = (XtPointer) False;
1570 pixel = BlackPixelOfScreen (screen);
1572 else if (XParseColor (dpy, cmap, color_name, &color)
1573 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1575 pixel = color.pixel;
1576 *closure_ret = (XtPointer) True;
1578 else
1580 String params[1];
1581 Cardinal nparams = 1;
1583 params[0] = color_name;
1584 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1585 "badValue", "cvt_string_to_pixel",
1586 "XtToolkitError", "Invalid color `%s'",
1587 params, &nparams);
1588 return False;
1591 if (to->addr != NULL)
1593 if (to->size < sizeof (Pixel))
1595 to->size = sizeof (Pixel);
1596 return False;
1599 *(Pixel *) to->addr = pixel;
1601 else
1603 cvt_string_to_pixel_value = pixel;
1604 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1607 to->size = sizeof (Pixel);
1608 return True;
1612 /* Free a pixel color which was previously allocated via
1613 cvt_string_to_pixel. This is registered as the destructor
1614 for this type of resource via XtSetTypeConverter.
1616 APP is the application context in which we work.
1618 TO is a pointer to an XrmValue holding the color to free.
1619 CLOSURE is the value we stored in CLOSURE_RET for this color
1620 in cvt_string_to_pixel.
1622 ARGS and NARGS are like for cvt_string_to_pixel. */
1624 static void
1625 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1626 Cardinal *nargs)
1628 if (*nargs != 2)
1630 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1631 "XtToolkitError",
1632 "Screen and colormap arguments required",
1633 NULL, NULL);
1635 else if (closure != NULL)
1637 /* We did allocate the pixel, so free it. */
1638 Screen *screen = *(Screen **) args[0].addr;
1639 Colormap cmap = *(Colormap *) args[1].addr;
1640 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1641 (Pixel *) to->addr, 1);
1646 #endif /* USE_X_TOOLKIT */
1649 /* Value is an array of XColor structures for the contents of the
1650 color map of display DPY. Set *NCELLS to the size of the array.
1651 Note that this probably shouldn't be called for large color maps,
1652 say a 24-bit TrueColor map. */
1654 static const XColor *
1655 x_color_cells (Display *dpy, int *ncells)
1657 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1659 if (dpyinfo->color_cells == NULL)
1661 Screen *screen = dpyinfo->screen;
1662 int i;
1664 dpyinfo->ncolor_cells
1665 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1666 dpyinfo->color_cells
1667 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1668 * sizeof *dpyinfo->color_cells);
1670 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1671 dpyinfo->color_cells[i].pixel = i;
1673 XQueryColors (dpy, dpyinfo->cmap,
1674 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1677 *ncells = dpyinfo->ncolor_cells;
1678 return dpyinfo->color_cells;
1682 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1683 colors in COLORS. Use cached information, if available. */
1685 void
1686 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1688 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1690 if (dpyinfo->color_cells)
1692 int i;
1693 for (i = 0; i < ncolors; ++i)
1695 unsigned long pixel = colors[i].pixel;
1696 xassert (pixel < dpyinfo->ncolor_cells);
1697 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1698 colors[i] = dpyinfo->color_cells[pixel];
1701 else
1702 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1706 /* On frame F, translate pixel color to RGB values for the color in
1707 COLOR. Use cached information, if available. */
1709 void
1710 x_query_color (struct frame *f, XColor *color)
1712 x_query_colors (f, color, 1);
1716 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1717 exact match can't be allocated, try the nearest color available.
1718 Value is non-zero if successful. Set *COLOR to the color
1719 allocated. */
1721 static int
1722 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1724 int rc;
1726 rc = XAllocColor (dpy, cmap, color);
1727 if (rc == 0)
1729 /* If we got to this point, the colormap is full, so we're going
1730 to try to get the next closest color. The algorithm used is
1731 a least-squares matching, which is what X uses for closest
1732 color matching with StaticColor visuals. */
1733 int nearest, i;
1734 int max_color_delta = 255;
1735 int max_delta = 3 * max_color_delta;
1736 int nearest_delta = max_delta + 1;
1737 int ncells;
1738 const XColor *cells = x_color_cells (dpy, &ncells);
1740 for (nearest = i = 0; i < ncells; ++i)
1742 int dred = (color->red >> 8) - (cells[i].red >> 8);
1743 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
1744 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1745 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
1747 if (delta < nearest_delta)
1749 nearest = i;
1750 nearest_delta = delta;
1754 color->red = cells[nearest].red;
1755 color->green = cells[nearest].green;
1756 color->blue = cells[nearest].blue;
1757 rc = XAllocColor (dpy, cmap, color);
1759 else
1761 /* If allocation succeeded, and the allocated pixel color is not
1762 equal to a cached pixel color recorded earlier, there was a
1763 change in the colormap, so clear the color cache. */
1764 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1765 XColor *cached_color;
1767 if (dpyinfo->color_cells
1768 && (cached_color = &dpyinfo->color_cells[color->pixel],
1769 (cached_color->red != color->red
1770 || cached_color->blue != color->blue
1771 || cached_color->green != color->green)))
1773 xfree (dpyinfo->color_cells);
1774 dpyinfo->color_cells = NULL;
1775 dpyinfo->ncolor_cells = 0;
1779 #ifdef DEBUG_X_COLORS
1780 if (rc)
1781 register_color (color->pixel);
1782 #endif /* DEBUG_X_COLORS */
1784 return rc;
1788 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1789 exact match can't be allocated, try the nearest color available.
1790 Value is non-zero if successful. Set *COLOR to the color
1791 allocated. */
1794 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1796 gamma_correct (f, color);
1797 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1801 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1802 It's necessary to do this instead of just using PIXEL directly to
1803 get color reference counts right. */
1805 unsigned long
1806 x_copy_color (struct frame *f, long unsigned int pixel)
1808 XColor color;
1810 color.pixel = pixel;
1811 BLOCK_INPUT;
1812 x_query_color (f, &color);
1813 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1814 UNBLOCK_INPUT;
1815 #ifdef DEBUG_X_COLORS
1816 register_color (pixel);
1817 #endif
1818 return color.pixel;
1822 /* Brightness beyond which a color won't have its highlight brightness
1823 boosted.
1825 Nominally, highlight colors for `3d' faces are calculated by
1826 brightening an object's color by a constant scale factor, but this
1827 doesn't yield good results for dark colors, so for colors who's
1828 brightness is less than this value (on a scale of 0-65535) have an
1829 use an additional additive factor.
1831 The value here is set so that the default menu-bar/mode-line color
1832 (grey75) will not have its highlights changed at all. */
1833 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1836 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1837 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1838 If this produces the same color as PIXEL, try a color where all RGB
1839 values have DELTA added. Return the allocated color in *PIXEL.
1840 DISPLAY is the X display, CMAP is the colormap to operate on.
1841 Value is non-zero if successful. */
1843 static int
1844 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1846 XColor color, new;
1847 long bright;
1848 int success_p;
1850 /* Get RGB color values. */
1851 color.pixel = *pixel;
1852 x_query_color (f, &color);
1854 /* Change RGB values by specified FACTOR. Avoid overflow! */
1855 xassert (factor >= 0);
1856 new.red = min (0xffff, factor * color.red);
1857 new.green = min (0xffff, factor * color.green);
1858 new.blue = min (0xffff, factor * color.blue);
1860 /* Calculate brightness of COLOR. */
1861 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1863 /* We only boost colors that are darker than
1864 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1865 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1866 /* Make an additive adjustment to NEW, because it's dark enough so
1867 that scaling by FACTOR alone isn't enough. */
1869 /* How far below the limit this color is (0 - 1, 1 being darker). */
1870 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1871 /* The additive adjustment. */
1872 int min_delta = delta * dimness * factor / 2;
1874 if (factor < 1)
1876 new.red = max (0, new.red - min_delta);
1877 new.green = max (0, new.green - min_delta);
1878 new.blue = max (0, new.blue - min_delta);
1880 else
1882 new.red = min (0xffff, min_delta + new.red);
1883 new.green = min (0xffff, min_delta + new.green);
1884 new.blue = min (0xffff, min_delta + new.blue);
1888 /* Try to allocate the color. */
1889 success_p = x_alloc_nearest_color (f, cmap, &new);
1890 if (success_p)
1892 if (new.pixel == *pixel)
1894 /* If we end up with the same color as before, try adding
1895 delta to the RGB values. */
1896 x_free_colors (f, &new.pixel, 1);
1898 new.red = min (0xffff, delta + color.red);
1899 new.green = min (0xffff, delta + color.green);
1900 new.blue = min (0xffff, delta + color.blue);
1901 success_p = x_alloc_nearest_color (f, cmap, &new);
1903 else
1904 success_p = 1;
1905 *pixel = new.pixel;
1908 return success_p;
1912 /* Set up the foreground color for drawing relief lines of glyph
1913 string S. RELIEF is a pointer to a struct relief containing the GC
1914 with which lines will be drawn. Use a color that is FACTOR or
1915 DELTA lighter or darker than the relief's background which is found
1916 in S->f->output_data.x->relief_background. If such a color cannot
1917 be allocated, use DEFAULT_PIXEL, instead. */
1919 static void
1920 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1922 XGCValues xgcv;
1923 struct x_output *di = f->output_data.x;
1924 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1925 unsigned long pixel;
1926 unsigned long background = di->relief_background;
1927 Colormap cmap = FRAME_X_COLORMAP (f);
1928 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1929 Display *dpy = FRAME_X_DISPLAY (f);
1931 xgcv.graphics_exposures = False;
1932 xgcv.line_width = 1;
1934 /* Free previously allocated color. The color cell will be reused
1935 when it has been freed as many times as it was allocated, so this
1936 doesn't affect faces using the same colors. */
1937 if (relief->gc
1938 && relief->allocated_p)
1940 x_free_colors (f, &relief->pixel, 1);
1941 relief->allocated_p = 0;
1944 /* Allocate new color. */
1945 xgcv.foreground = default_pixel;
1946 pixel = background;
1947 if (dpyinfo->n_planes != 1
1948 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1950 relief->allocated_p = 1;
1951 xgcv.foreground = relief->pixel = pixel;
1954 if (relief->gc == 0)
1956 xgcv.stipple = dpyinfo->gray;
1957 mask |= GCStipple;
1958 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1960 else
1961 XChangeGC (dpy, relief->gc, mask, &xgcv);
1965 /* Set up colors for the relief lines around glyph string S. */
1967 static void
1968 x_setup_relief_colors (struct glyph_string *s)
1970 struct x_output *di = s->f->output_data.x;
1971 unsigned long color;
1973 if (s->face->use_box_color_for_shadows_p)
1974 color = s->face->box_color;
1975 else if (s->first_glyph->type == IMAGE_GLYPH
1976 && s->img->pixmap
1977 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1978 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1979 else
1981 XGCValues xgcv;
1983 /* Get the background color of the face. */
1984 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1985 color = xgcv.background;
1988 if (di->white_relief.gc == 0
1989 || color != di->relief_background)
1991 di->relief_background = color;
1992 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1993 WHITE_PIX_DEFAULT (s->f));
1994 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1995 BLACK_PIX_DEFAULT (s->f));
2000 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2001 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2002 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2003 relief. LEFT_P non-zero means draw a relief on the left side of
2004 the rectangle. RIGHT_P non-zero means draw a relief on the right
2005 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2006 when drawing. */
2008 static void
2009 x_draw_relief_rect (struct frame *f,
2010 int left_x, int top_y, int right_x, int bottom_y, int width,
2011 int raised_p, int top_p, int bot_p, int left_p, int right_p,
2012 XRectangle *clip_rect)
2014 Display *dpy = FRAME_X_DISPLAY (f);
2015 Window window = FRAME_X_WINDOW (f);
2016 int i;
2017 GC gc;
2019 if (raised_p)
2020 gc = f->output_data.x->white_relief.gc;
2021 else
2022 gc = f->output_data.x->black_relief.gc;
2023 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2025 /* This code is more complicated than it has to be, because of two
2026 minor hacks to make the boxes look nicer: (i) if width > 1, draw
2027 the outermost line using the black relief. (ii) Omit the four
2028 corner pixels. */
2030 /* Top. */
2031 if (top_p)
2033 if (width == 1)
2034 XDrawLine (dpy, window, gc,
2035 left_x + (left_p ? 1 : 0), top_y,
2036 right_x + (right_p ? 0 : 1), top_y);
2038 for (i = 1; i < width; ++i)
2039 XDrawLine (dpy, window, gc,
2040 left_x + i * left_p, top_y + i,
2041 right_x + 1 - i * right_p, top_y + i);
2044 /* Left. */
2045 if (left_p)
2047 if (width == 1)
2048 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2050 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2051 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2053 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2054 XDrawLine (dpy, window, gc,
2055 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2058 XSetClipMask (dpy, gc, None);
2059 if (raised_p)
2060 gc = f->output_data.x->black_relief.gc;
2061 else
2062 gc = f->output_data.x->white_relief.gc;
2063 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2065 if (width > 1)
2067 /* Outermost top line. */
2068 if (top_p)
2069 XDrawLine (dpy, window, gc,
2070 left_x + (left_p ? 1 : 0), top_y,
2071 right_x + (right_p ? 0 : 1), top_y);
2073 /* Outermost left line. */
2074 if (left_p)
2075 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2078 /* Bottom. */
2079 if (bot_p)
2081 XDrawLine (dpy, window, gc,
2082 left_x + (left_p ? 1 : 0), bottom_y,
2083 right_x + (right_p ? 0 : 1), bottom_y);
2084 for (i = 1; i < width; ++i)
2085 XDrawLine (dpy, window, gc,
2086 left_x + i * left_p, bottom_y - i,
2087 right_x + 1 - i * right_p, bottom_y - i);
2090 /* Right. */
2091 if (right_p)
2093 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2094 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2095 for (i = 0; i < width; ++i)
2096 XDrawLine (dpy, window, gc,
2097 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2100 XSetClipMask (dpy, gc, None);
2104 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2105 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2106 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2107 left side of the rectangle. RIGHT_P non-zero means draw a line
2108 on the right side of the rectangle. CLIP_RECT is the clipping
2109 rectangle to use when drawing. */
2111 static void
2112 x_draw_box_rect (struct glyph_string *s,
2113 int left_x, int top_y, int right_x, int bottom_y, int width,
2114 int left_p, int right_p, XRectangle *clip_rect)
2116 XGCValues xgcv;
2118 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2119 XSetForeground (s->display, s->gc, s->face->box_color);
2120 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2122 /* Top. */
2123 XFillRectangle (s->display, s->window, s->gc,
2124 left_x, top_y, right_x - left_x + 1, width);
2126 /* Left. */
2127 if (left_p)
2128 XFillRectangle (s->display, s->window, s->gc,
2129 left_x, top_y, width, bottom_y - top_y + 1);
2131 /* Bottom. */
2132 XFillRectangle (s->display, s->window, s->gc,
2133 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2135 /* Right. */
2136 if (right_p)
2137 XFillRectangle (s->display, s->window, s->gc,
2138 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2140 XSetForeground (s->display, s->gc, xgcv.foreground);
2141 XSetClipMask (s->display, s->gc, None);
2145 /* Draw a box around glyph string S. */
2147 static void
2148 x_draw_glyph_string_box (struct glyph_string *s)
2150 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2151 int left_p, right_p;
2152 struct glyph *last_glyph;
2153 XRectangle clip_rect;
2155 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2156 ? WINDOW_RIGHT_EDGE_X (s->w)
2157 : window_box_right (s->w, s->area));
2159 /* The glyph that may have a right box line. */
2160 last_glyph = (s->cmp || s->img
2161 ? s->first_glyph
2162 : s->first_glyph + s->nchars - 1);
2164 width = eabs (s->face->box_line_width);
2165 raised_p = s->face->box == FACE_RAISED_BOX;
2166 left_x = s->x;
2167 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2168 ? last_x - 1
2169 : min (last_x, s->x + s->background_width) - 1);
2170 top_y = s->y;
2171 bottom_y = top_y + s->height - 1;
2173 left_p = (s->first_glyph->left_box_line_p
2174 || (s->hl == DRAW_MOUSE_FACE
2175 && (s->prev == NULL
2176 || s->prev->hl != s->hl)));
2177 right_p = (last_glyph->right_box_line_p
2178 || (s->hl == DRAW_MOUSE_FACE
2179 && (s->next == NULL
2180 || s->next->hl != s->hl)));
2182 get_glyph_string_clip_rect (s, &clip_rect);
2184 if (s->face->box == FACE_SIMPLE_BOX)
2185 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2186 left_p, right_p, &clip_rect);
2187 else
2189 x_setup_relief_colors (s);
2190 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2191 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2196 /* Draw foreground of image glyph string S. */
2198 static void
2199 x_draw_image_foreground (struct glyph_string *s)
2201 int x = s->x;
2202 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2204 /* If first glyph of S has a left box line, start drawing it to the
2205 right of that line. */
2206 if (s->face->box != FACE_NO_BOX
2207 && s->first_glyph->left_box_line_p
2208 && s->slice.x == 0)
2209 x += eabs (s->face->box_line_width);
2211 /* If there is a margin around the image, adjust x- and y-position
2212 by that margin. */
2213 if (s->slice.x == 0)
2214 x += s->img->hmargin;
2215 if (s->slice.y == 0)
2216 y += s->img->vmargin;
2218 if (s->img->pixmap)
2220 if (s->img->mask)
2222 /* We can't set both a clip mask and use XSetClipRectangles
2223 because the latter also sets a clip mask. We also can't
2224 trust on the shape extension to be available
2225 (XShapeCombineRegion). So, compute the rectangle to draw
2226 manually. */
2227 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2228 | GCFunction);
2229 XGCValues xgcv;
2230 XRectangle clip_rect, image_rect, r;
2232 xgcv.clip_mask = s->img->mask;
2233 xgcv.clip_x_origin = x;
2234 xgcv.clip_y_origin = y;
2235 xgcv.function = GXcopy;
2236 XChangeGC (s->display, s->gc, mask, &xgcv);
2238 get_glyph_string_clip_rect (s, &clip_rect);
2239 image_rect.x = x;
2240 image_rect.y = y;
2241 image_rect.width = s->slice.width;
2242 image_rect.height = s->slice.height;
2243 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2244 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2245 s->slice.x + r.x - x, s->slice.y + r.y - y,
2246 r.width, r.height, r.x, r.y);
2248 else
2250 XRectangle clip_rect, image_rect, r;
2252 get_glyph_string_clip_rect (s, &clip_rect);
2253 image_rect.x = x;
2254 image_rect.y = y;
2255 image_rect.width = s->slice.width;
2256 image_rect.height = s->slice.height;
2257 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2258 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2259 s->slice.x + r.x - x, s->slice.y + r.y - y,
2260 r.width, r.height, r.x, r.y);
2262 /* When the image has a mask, we can expect that at
2263 least part of a mouse highlight or a block cursor will
2264 be visible. If the image doesn't have a mask, make
2265 a block cursor visible by drawing a rectangle around
2266 the image. I believe it's looking better if we do
2267 nothing here for mouse-face. */
2268 if (s->hl == DRAW_CURSOR)
2270 int relief = s->img->relief;
2271 if (relief < 0) relief = -relief;
2272 XDrawRectangle (s->display, s->window, s->gc,
2273 x - relief, y - relief,
2274 s->slice.width + relief*2 - 1,
2275 s->slice.height + relief*2 - 1);
2279 else
2280 /* Draw a rectangle if image could not be loaded. */
2281 XDrawRectangle (s->display, s->window, s->gc, x, y,
2282 s->slice.width - 1, s->slice.height - 1);
2286 /* Draw a relief around the image glyph string S. */
2288 static void
2289 x_draw_image_relief (struct glyph_string *s)
2291 int x0, y0, x1, y1, thick, raised_p, extra;
2292 XRectangle r;
2293 int x = s->x;
2294 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2296 /* If first glyph of S has a left box line, start drawing it to the
2297 right of that line. */
2298 if (s->face->box != FACE_NO_BOX
2299 && s->first_glyph->left_box_line_p
2300 && s->slice.x == 0)
2301 x += eabs (s->face->box_line_width);
2303 /* If there is a margin around the image, adjust x- and y-position
2304 by that margin. */
2305 if (s->slice.x == 0)
2306 x += s->img->hmargin;
2307 if (s->slice.y == 0)
2308 y += s->img->vmargin;
2310 if (s->hl == DRAW_IMAGE_SUNKEN
2311 || s->hl == DRAW_IMAGE_RAISED)
2313 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2314 raised_p = s->hl == DRAW_IMAGE_RAISED;
2316 else
2318 thick = eabs (s->img->relief);
2319 raised_p = s->img->relief > 0;
2322 extra = s->face->id == TOOL_BAR_FACE_ID
2323 ? XINT (Vtool_bar_button_margin) : 0;
2325 x0 = x - thick - extra;
2326 y0 = y - thick - extra;
2327 x1 = x + s->slice.width + thick - 1 + extra;
2328 y1 = y + s->slice.height + thick - 1 + extra;
2330 x_setup_relief_colors (s);
2331 get_glyph_string_clip_rect (s, &r);
2332 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2333 s->slice.y == 0,
2334 s->slice.y + s->slice.height == s->img->height,
2335 s->slice.x == 0,
2336 s->slice.x + s->slice.width == s->img->width,
2337 &r);
2341 /* Draw the foreground of image glyph string S to PIXMAP. */
2343 static void
2344 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2346 int x = 0;
2347 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2349 /* If first glyph of S has a left box line, start drawing it to the
2350 right of that line. */
2351 if (s->face->box != FACE_NO_BOX
2352 && s->first_glyph->left_box_line_p
2353 && s->slice.x == 0)
2354 x += eabs (s->face->box_line_width);
2356 /* If there is a margin around the image, adjust x- and y-position
2357 by that margin. */
2358 if (s->slice.x == 0)
2359 x += s->img->hmargin;
2360 if (s->slice.y == 0)
2361 y += s->img->vmargin;
2363 if (s->img->pixmap)
2365 if (s->img->mask)
2367 /* We can't set both a clip mask and use XSetClipRectangles
2368 because the latter also sets a clip mask. We also can't
2369 trust on the shape extension to be available
2370 (XShapeCombineRegion). So, compute the rectangle to draw
2371 manually. */
2372 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2373 | GCFunction);
2374 XGCValues xgcv;
2376 xgcv.clip_mask = s->img->mask;
2377 xgcv.clip_x_origin = x - s->slice.x;
2378 xgcv.clip_y_origin = y - s->slice.y;
2379 xgcv.function = GXcopy;
2380 XChangeGC (s->display, s->gc, mask, &xgcv);
2382 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2383 s->slice.x, s->slice.y,
2384 s->slice.width, s->slice.height, x, y);
2385 XSetClipMask (s->display, s->gc, None);
2387 else
2389 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2390 s->slice.x, s->slice.y,
2391 s->slice.width, s->slice.height, x, y);
2393 /* When the image has a mask, we can expect that at
2394 least part of a mouse highlight or a block cursor will
2395 be visible. If the image doesn't have a mask, make
2396 a block cursor visible by drawing a rectangle around
2397 the image. I believe it's looking better if we do
2398 nothing here for mouse-face. */
2399 if (s->hl == DRAW_CURSOR)
2401 int r = s->img->relief;
2402 if (r < 0) r = -r;
2403 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2404 s->slice.width + r*2 - 1,
2405 s->slice.height + r*2 - 1);
2409 else
2410 /* Draw a rectangle if image could not be loaded. */
2411 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2412 s->slice.width - 1, s->slice.height - 1);
2416 /* Draw part of the background of glyph string S. X, Y, W, and H
2417 give the rectangle to draw. */
2419 static void
2420 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2422 if (s->stippled_p)
2424 /* Fill background with a stipple pattern. */
2425 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2426 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2427 XSetFillStyle (s->display, s->gc, FillSolid);
2429 else
2430 x_clear_glyph_string_rect (s, x, y, w, h);
2434 /* Draw image glyph string S.
2436 s->y
2437 s->x +-------------------------
2438 | s->face->box
2440 | +-------------------------
2441 | | s->img->margin
2443 | | +-------------------
2444 | | | the image
2448 static void
2449 x_draw_image_glyph_string (struct glyph_string *s)
2451 int box_line_hwidth = eabs (s->face->box_line_width);
2452 int box_line_vwidth = max (s->face->box_line_width, 0);
2453 int height;
2454 Pixmap pixmap = None;
2456 height = s->height;
2457 if (s->slice.y == 0)
2458 height -= box_line_vwidth;
2459 if (s->slice.y + s->slice.height >= s->img->height)
2460 height -= box_line_vwidth;
2462 /* Fill background with face under the image. Do it only if row is
2463 taller than image or if image has a clip mask to reduce
2464 flickering. */
2465 s->stippled_p = s->face->stipple != 0;
2466 if (height > s->slice.height
2467 || s->img->hmargin
2468 || s->img->vmargin
2469 || s->img->mask
2470 || s->img->pixmap == 0
2471 || s->width != s->background_width)
2473 if (s->img->mask)
2475 /* Create a pixmap as large as the glyph string. Fill it
2476 with the background color. Copy the image to it, using
2477 its mask. Copy the temporary pixmap to the display. */
2478 Screen *screen = FRAME_X_SCREEN (s->f);
2479 int depth = DefaultDepthOfScreen (screen);
2481 /* Create a pixmap as large as the glyph string. */
2482 pixmap = XCreatePixmap (s->display, s->window,
2483 s->background_width,
2484 s->height, depth);
2486 /* Don't clip in the following because we're working on the
2487 pixmap. */
2488 XSetClipMask (s->display, s->gc, None);
2490 /* Fill the pixmap with the background color/stipple. */
2491 if (s->stippled_p)
2493 /* Fill background with a stipple pattern. */
2494 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2495 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2496 XFillRectangle (s->display, pixmap, s->gc,
2497 0, 0, s->background_width, s->height);
2498 XSetFillStyle (s->display, s->gc, FillSolid);
2499 XSetTSOrigin (s->display, s->gc, 0, 0);
2501 else
2503 XGCValues xgcv;
2504 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2505 &xgcv);
2506 XSetForeground (s->display, s->gc, xgcv.background);
2507 XFillRectangle (s->display, pixmap, s->gc,
2508 0, 0, s->background_width, s->height);
2509 XSetForeground (s->display, s->gc, xgcv.foreground);
2512 else
2514 int x = s->x;
2515 int y = s->y;
2517 if (s->first_glyph->left_box_line_p
2518 && s->slice.x == 0)
2519 x += box_line_hwidth;
2521 if (s->slice.y == 0)
2522 y += box_line_vwidth;
2524 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2527 s->background_filled_p = 1;
2530 /* Draw the foreground. */
2531 if (pixmap != None)
2533 x_draw_image_foreground_1 (s, pixmap);
2534 x_set_glyph_string_clipping (s);
2535 XCopyArea (s->display, pixmap, s->window, s->gc,
2536 0, 0, s->background_width, s->height, s->x, s->y);
2537 XFreePixmap (s->display, pixmap);
2539 else
2540 x_draw_image_foreground (s);
2542 /* If we must draw a relief around the image, do it. */
2543 if (s->img->relief
2544 || s->hl == DRAW_IMAGE_RAISED
2545 || s->hl == DRAW_IMAGE_SUNKEN)
2546 x_draw_image_relief (s);
2550 /* Draw stretch glyph string S. */
2552 static void
2553 x_draw_stretch_glyph_string (struct glyph_string *s)
2555 xassert (s->first_glyph->type == STRETCH_GLYPH);
2557 if (s->hl == DRAW_CURSOR
2558 && !x_stretch_cursor_p)
2560 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2561 wide as the stretch glyph. */
2562 int width, background_width = s->background_width;
2563 int x = s->x;
2565 if (!s->row->reversed_p)
2567 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2569 if (x < left_x)
2571 background_width -= left_x - x;
2572 x = left_x;
2575 else
2577 /* In R2L rows, draw the cursor on the right edge of the
2578 stretch glyph. */
2579 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2581 if (x + background_width > right_x)
2582 background_width -= x - right_x;
2583 x += background_width;
2585 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2586 if (s->row->reversed_p)
2587 x -= width;
2589 /* Draw cursor. */
2590 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2592 /* Clear rest using the GC of the original non-cursor face. */
2593 if (width < background_width)
2595 int y = s->y;
2596 int w = background_width - width, h = s->height;
2597 XRectangle r;
2598 GC gc;
2600 if (!s->row->reversed_p)
2601 x += width;
2602 else
2603 x = s->x;
2604 if (s->row->mouse_face_p
2605 && cursor_in_mouse_face_p (s->w))
2607 x_set_mouse_face_gc (s);
2608 gc = s->gc;
2610 else
2611 gc = s->face->gc;
2613 get_glyph_string_clip_rect (s, &r);
2614 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2616 if (s->face->stipple)
2618 /* Fill background with a stipple pattern. */
2619 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2620 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2621 XSetFillStyle (s->display, gc, FillSolid);
2623 else
2625 XGCValues xgcv;
2626 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2627 XSetForeground (s->display, gc, xgcv.background);
2628 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2629 XSetForeground (s->display, gc, xgcv.foreground);
2633 else if (!s->background_filled_p)
2635 int background_width = s->background_width;
2636 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2638 /* Don't draw into left margin, fringe or scrollbar area
2639 except for header line and mode line. */
2640 if (x < left_x && !s->row->mode_line_p)
2642 background_width -= left_x - x;
2643 x = left_x;
2645 if (background_width > 0)
2646 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2649 s->background_filled_p = 1;
2653 /* Draw glyph string S. */
2655 static void
2656 x_draw_glyph_string (struct glyph_string *s)
2658 int relief_drawn_p = 0;
2660 /* If S draws into the background of its successors, draw the
2661 background of the successors first so that S can draw into it.
2662 This makes S->next use XDrawString instead of XDrawImageString. */
2663 if (s->next && s->right_overhang && !s->for_overlaps)
2665 int width;
2666 struct glyph_string *next;
2668 for (width = 0, next = s->next;
2669 next && width < s->right_overhang;
2670 width += next->width, next = next->next)
2671 if (next->first_glyph->type != IMAGE_GLYPH)
2673 x_set_glyph_string_gc (next);
2674 x_set_glyph_string_clipping (next);
2675 if (next->first_glyph->type == STRETCH_GLYPH)
2676 x_draw_stretch_glyph_string (next);
2677 else
2678 x_draw_glyph_string_background (next, 1);
2679 next->num_clips = 0;
2683 /* Set up S->gc, set clipping and draw S. */
2684 x_set_glyph_string_gc (s);
2686 /* Draw relief (if any) in advance for char/composition so that the
2687 glyph string can be drawn over it. */
2688 if (!s->for_overlaps
2689 && s->face->box != FACE_NO_BOX
2690 && (s->first_glyph->type == CHAR_GLYPH
2691 || s->first_glyph->type == COMPOSITE_GLYPH))
2694 x_set_glyph_string_clipping (s);
2695 x_draw_glyph_string_background (s, 1);
2696 x_draw_glyph_string_box (s);
2697 x_set_glyph_string_clipping (s);
2698 relief_drawn_p = 1;
2700 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2701 && !s->clip_tail
2702 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2703 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2704 /* We must clip just this glyph. left_overhang part has already
2705 drawn when s->prev was drawn, and right_overhang part will be
2706 drawn later when s->next is drawn. */
2707 x_set_glyph_string_clipping_exactly (s, s);
2708 else
2709 x_set_glyph_string_clipping (s);
2711 switch (s->first_glyph->type)
2713 case IMAGE_GLYPH:
2714 x_draw_image_glyph_string (s);
2715 break;
2717 case STRETCH_GLYPH:
2718 x_draw_stretch_glyph_string (s);
2719 break;
2721 case CHAR_GLYPH:
2722 if (s->for_overlaps)
2723 s->background_filled_p = 1;
2724 else
2725 x_draw_glyph_string_background (s, 0);
2726 x_draw_glyph_string_foreground (s);
2727 break;
2729 case COMPOSITE_GLYPH:
2730 if (s->for_overlaps || (s->cmp_from > 0
2731 && ! s->first_glyph->u.cmp.automatic))
2732 s->background_filled_p = 1;
2733 else
2734 x_draw_glyph_string_background (s, 1);
2735 x_draw_composite_glyph_string_foreground (s);
2736 break;
2738 case GLYPHLESS_GLYPH:
2739 if (s->for_overlaps)
2740 s->background_filled_p = 1;
2741 else
2742 x_draw_glyph_string_background (s, 1);
2743 x_draw_glyphless_glyph_string_foreground (s);
2744 break;
2746 default:
2747 abort ();
2750 if (!s->for_overlaps)
2752 /* Draw underline. */
2753 if (s->face->underline_p)
2755 unsigned long thickness, position;
2756 int y;
2758 if (s->prev && s->prev->face->underline_p)
2760 /* We use the same underline style as the previous one. */
2761 thickness = s->prev->underline_thickness;
2762 position = s->prev->underline_position;
2764 else
2766 /* Get the underline thickness. Default is 1 pixel. */
2767 if (s->font && s->font->underline_thickness > 0)
2768 thickness = s->font->underline_thickness;
2769 else
2770 thickness = 1;
2771 if (x_underline_at_descent_line)
2772 position = (s->height - thickness) - (s->ybase - s->y);
2773 else
2775 /* Get the underline position. This is the recommended
2776 vertical offset in pixels from the baseline to the top of
2777 the underline. This is a signed value according to the
2778 specs, and its default is
2780 ROUND ((maximum descent) / 2), with
2781 ROUND(x) = floor (x + 0.5) */
2783 if (x_use_underline_position_properties
2784 && s->font && s->font->underline_position >= 0)
2785 position = s->font->underline_position;
2786 else if (s->font)
2787 position = (s->font->descent + 1) / 2;
2788 else
2789 position = underline_minimum_offset;
2791 position = max (position, underline_minimum_offset);
2793 /* Check the sanity of thickness and position. We should
2794 avoid drawing underline out of the current line area. */
2795 if (s->y + s->height <= s->ybase + position)
2796 position = (s->height - 1) - (s->ybase - s->y);
2797 if (s->y + s->height < s->ybase + position + thickness)
2798 thickness = (s->y + s->height) - (s->ybase + position);
2799 s->underline_thickness = thickness;
2800 s->underline_position = position;
2801 y = s->ybase + position;
2802 if (s->face->underline_defaulted_p)
2803 XFillRectangle (s->display, s->window, s->gc,
2804 s->x, y, s->width, thickness);
2805 else
2807 XGCValues xgcv;
2808 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2809 XSetForeground (s->display, s->gc, s->face->underline_color);
2810 XFillRectangle (s->display, s->window, s->gc,
2811 s->x, y, s->width, thickness);
2812 XSetForeground (s->display, s->gc, xgcv.foreground);
2816 /* Draw overline. */
2817 if (s->face->overline_p)
2819 unsigned long dy = 0, h = 1;
2821 if (s->face->overline_color_defaulted_p)
2822 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2823 s->width, h);
2824 else
2826 XGCValues xgcv;
2827 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2828 XSetForeground (s->display, s->gc, s->face->overline_color);
2829 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2830 s->width, h);
2831 XSetForeground (s->display, s->gc, xgcv.foreground);
2835 /* Draw strike-through. */
2836 if (s->face->strike_through_p)
2838 unsigned long h = 1;
2839 unsigned long dy = (s->height - h) / 2;
2841 if (s->face->strike_through_color_defaulted_p)
2842 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2843 s->width, h);
2844 else
2846 XGCValues xgcv;
2847 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2848 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2849 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2850 s->width, h);
2851 XSetForeground (s->display, s->gc, xgcv.foreground);
2855 /* Draw relief if not yet drawn. */
2856 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2857 x_draw_glyph_string_box (s);
2859 if (s->prev)
2861 struct glyph_string *prev;
2863 for (prev = s->prev; prev; prev = prev->prev)
2864 if (prev->hl != s->hl
2865 && prev->x + prev->width + prev->right_overhang > s->x)
2867 /* As prev was drawn while clipped to its own area, we
2868 must draw the right_overhang part using s->hl now. */
2869 enum draw_glyphs_face save = prev->hl;
2871 prev->hl = s->hl;
2872 x_set_glyph_string_gc (prev);
2873 x_set_glyph_string_clipping_exactly (s, prev);
2874 if (prev->first_glyph->type == CHAR_GLYPH)
2875 x_draw_glyph_string_foreground (prev);
2876 else
2877 x_draw_composite_glyph_string_foreground (prev);
2878 XSetClipMask (prev->display, prev->gc, None);
2879 prev->hl = save;
2880 prev->num_clips = 0;
2884 if (s->next)
2886 struct glyph_string *next;
2888 for (next = s->next; next; next = next->next)
2889 if (next->hl != s->hl
2890 && next->x - next->left_overhang < s->x + s->width)
2892 /* As next will be drawn while clipped to its own area,
2893 we must draw the left_overhang part using s->hl now. */
2894 enum draw_glyphs_face save = next->hl;
2896 next->hl = s->hl;
2897 x_set_glyph_string_gc (next);
2898 x_set_glyph_string_clipping_exactly (s, next);
2899 if (next->first_glyph->type == CHAR_GLYPH)
2900 x_draw_glyph_string_foreground (next);
2901 else
2902 x_draw_composite_glyph_string_foreground (next);
2903 XSetClipMask (next->display, next->gc, None);
2904 next->hl = save;
2905 next->num_clips = 0;
2910 /* Reset clipping. */
2911 XSetClipMask (s->display, s->gc, None);
2912 s->num_clips = 0;
2915 /* Shift display to make room for inserted glyphs. */
2917 static void
2918 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2920 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2921 f->output_data.x->normal_gc,
2922 x, y, width, height,
2923 x + shift_by, y);
2926 /* Delete N glyphs at the nominal cursor position. Not implemented
2927 for X frames. */
2929 static void
2930 x_delete_glyphs (struct frame *f, register int n)
2932 abort ();
2936 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2937 If they are <= 0, this is probably an error. */
2939 void
2940 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
2942 xassert (width > 0 && height > 0);
2943 XClearArea (dpy, window, x, y, width, height, exposures);
2947 /* Clear an entire frame. */
2949 static void
2950 x_clear_frame (struct frame *f)
2952 /* Clearing the frame will erase any cursor, so mark them all as no
2953 longer visible. */
2954 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2955 output_cursor.hpos = output_cursor.vpos = 0;
2956 output_cursor.x = -1;
2958 /* We don't set the output cursor here because there will always
2959 follow an explicit cursor_to. */
2960 BLOCK_INPUT;
2962 /* The following call is commented out because it does not seem to accomplish
2963 anything, apart from causing flickering during window resize. */
2964 /* XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f)); */
2966 /* We have to clear the scroll bars. If we have changed colors or
2967 something like that, then they should be notified. */
2968 x_scroll_bar_clear (f);
2970 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
2971 /* Make sure scroll bars are redrawn. As they aren't redrawn by
2972 redisplay, do it here. */
2973 if (FRAME_GTK_WIDGET (f))
2974 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
2975 #endif
2977 XFlush (FRAME_X_DISPLAY (f));
2979 UNBLOCK_INPUT;
2984 /* Invert the middle quarter of the frame for .15 sec. */
2986 /* We use the select system call to do the waiting, so we have to make
2987 sure it's available. If it isn't, we just won't do visual bells. */
2989 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2992 /* Subtract the `struct timeval' values X and Y, storing the result in
2993 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2995 static int
2996 timeval_subtract (struct timeval *result, struct timeval x, struct timeval y)
2998 /* Perform the carry for the later subtraction by updating y. This
2999 is safer because on some systems the tv_sec member is unsigned. */
3000 if (x.tv_usec < y.tv_usec)
3002 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
3003 y.tv_usec -= 1000000 * nsec;
3004 y.tv_sec += nsec;
3007 if (x.tv_usec - y.tv_usec > 1000000)
3009 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
3010 y.tv_usec += 1000000 * nsec;
3011 y.tv_sec -= nsec;
3014 /* Compute the time remaining to wait. tv_usec is certainly
3015 positive. */
3016 result->tv_sec = x.tv_sec - y.tv_sec;
3017 result->tv_usec = x.tv_usec - y.tv_usec;
3019 /* Return indication of whether the result should be considered
3020 negative. */
3021 return x.tv_sec < y.tv_sec;
3024 static void
3025 XTflash (struct frame *f)
3027 BLOCK_INPUT;
3030 #ifdef USE_GTK
3031 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3032 when the scroll bars and the edit widget share the same X window. */
3033 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3034 #ifdef HAVE_GTK3
3035 cairo_t *cr = gdk_cairo_create (window);
3036 cairo_set_source_rgb (cr, 1, 1, 1);
3037 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
3038 #define XFillRectangle(d, win, gc, x, y, w, h) \
3039 do { \
3040 cairo_rectangle (cr, x, y, w, h); \
3041 cairo_fill (cr); \
3043 while (0)
3044 #else /* ! HAVE_GTK3 */
3045 GdkGCValues vals;
3046 GdkGC *gc;
3047 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3048 ^ FRAME_BACKGROUND_PIXEL (f));
3049 vals.function = GDK_XOR;
3050 gc = gdk_gc_new_with_values (window,
3051 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3052 #define XFillRectangle(d, win, gc, x, y, w, h) \
3053 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
3054 #endif /* ! HAVE_GTK3 */
3055 #else /* ! USE_GTK */
3056 GC gc;
3058 /* Create a GC that will use the GXxor function to flip foreground
3059 pixels into background pixels. */
3061 XGCValues values;
3063 values.function = GXxor;
3064 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3065 ^ FRAME_BACKGROUND_PIXEL (f));
3067 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3068 GCFunction | GCForeground, &values);
3070 #endif
3072 /* Get the height not including a menu bar widget. */
3073 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3074 /* Height of each line to flash. */
3075 int flash_height = FRAME_LINE_HEIGHT (f);
3076 /* These will be the left and right margins of the rectangles. */
3077 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3078 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3080 int width;
3082 /* Don't flash the area between a scroll bar and the frame
3083 edge it is next to. */
3084 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3086 case vertical_scroll_bar_left:
3087 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3088 break;
3090 case vertical_scroll_bar_right:
3091 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3092 break;
3094 default:
3095 break;
3098 width = flash_right - flash_left;
3100 /* If window is tall, flash top and bottom line. */
3101 if (height > 3 * FRAME_LINE_HEIGHT (f))
3103 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3104 flash_left,
3105 (FRAME_INTERNAL_BORDER_WIDTH (f)
3106 + FRAME_TOP_MARGIN_HEIGHT (f)),
3107 width, flash_height);
3108 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3109 flash_left,
3110 (height - flash_height
3111 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3112 width, flash_height);
3115 else
3116 /* If it is short, flash it all. */
3117 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3118 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3119 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3121 x_flush (f);
3124 struct timeval wakeup;
3126 EMACS_GET_TIME (wakeup);
3128 /* Compute time to wait until, propagating carry from usecs. */
3129 wakeup.tv_usec += 150000;
3130 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3131 wakeup.tv_usec %= 1000000;
3133 /* Keep waiting until past the time wakeup or any input gets
3134 available. */
3135 while (! detect_input_pending ())
3137 struct timeval current;
3138 struct timeval timeout;
3140 EMACS_GET_TIME (current);
3142 /* Break if result would be negative. */
3143 if (timeval_subtract (&current, wakeup, current))
3144 break;
3146 /* How long `select' should wait. */
3147 timeout.tv_sec = 0;
3148 timeout.tv_usec = 10000;
3150 /* Try to wait that long--but we might wake up sooner. */
3151 select (0, NULL, NULL, NULL, &timeout);
3155 /* If window is tall, flash top and bottom line. */
3156 if (height > 3 * FRAME_LINE_HEIGHT (f))
3158 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3159 flash_left,
3160 (FRAME_INTERNAL_BORDER_WIDTH (f)
3161 + FRAME_TOP_MARGIN_HEIGHT (f)),
3162 width, flash_height);
3163 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3164 flash_left,
3165 (height - flash_height
3166 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3167 width, flash_height);
3169 else
3170 /* If it is short, flash it all. */
3171 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3172 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3173 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3175 #ifdef USE_GTK
3176 #ifdef HAVE_GTK3
3177 cairo_destroy (cr);
3178 #else
3179 g_object_unref (G_OBJECT (gc));
3180 #endif
3181 #undef XFillRectangle
3182 #else
3183 XFreeGC (FRAME_X_DISPLAY (f), gc);
3184 #endif
3185 x_flush (f);
3189 UNBLOCK_INPUT;
3192 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3195 static void
3196 XTtoggle_invisible_pointer (FRAME_PTR f, int invisible)
3198 BLOCK_INPUT;
3199 if (invisible)
3201 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3202 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3203 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3205 else
3206 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3207 f->output_data.x->current_cursor);
3208 f->pointer_invisible = invisible;
3209 UNBLOCK_INPUT;
3213 /* Make audible bell. */
3215 static void
3216 XTring_bell (struct frame *f)
3218 if (FRAME_X_DISPLAY (f))
3220 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3221 if (visible_bell)
3222 XTflash (f);
3223 else
3224 #endif
3226 BLOCK_INPUT;
3227 XBell (FRAME_X_DISPLAY (f), 0);
3228 XFlush (FRAME_X_DISPLAY (f));
3229 UNBLOCK_INPUT;
3235 /* Specify how many text lines, from the top of the window,
3236 should be affected by insert-lines and delete-lines operations.
3237 This, and those operations, are used only within an update
3238 that is bounded by calls to x_update_begin and x_update_end. */
3240 static void
3241 XTset_terminal_window (struct frame *f, int n)
3243 /* This function intentionally left blank. */
3248 /***********************************************************************
3249 Line Dance
3250 ***********************************************************************/
3252 /* Perform an insert-lines or delete-lines operation, inserting N
3253 lines or deleting -N lines at vertical position VPOS. */
3255 static void
3256 x_ins_del_lines (struct frame *f, int vpos, int n)
3258 abort ();
3262 /* Scroll part of the display as described by RUN. */
3264 static void
3265 x_scroll_run (struct window *w, struct run *run)
3267 struct frame *f = XFRAME (w->frame);
3268 int x, y, width, height, from_y, to_y, bottom_y;
3270 /* Get frame-relative bounding box of the text display area of W,
3271 without mode lines. Include in this box the left and right
3272 fringe of W. */
3273 window_box (w, -1, &x, &y, &width, &height);
3275 #ifdef USE_TOOLKIT_SCROLL_BARS
3276 /* If the fringe is adjacent to the left (right) scroll bar of a
3277 leftmost (rightmost, respectively) window, then extend its
3278 background to the gap between the fringe and the bar. */
3279 if ((WINDOW_LEFTMOST_P (w)
3280 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
3281 || (WINDOW_RIGHTMOST_P (w)
3282 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
3284 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
3286 if (sb_width > 0)
3288 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
3289 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
3290 * FRAME_COLUMN_WIDTH (f));
3292 if (bar_area_x + bar_area_width == x)
3294 x = bar_area_x + sb_width;
3295 width += bar_area_width - sb_width;
3297 else if (x + width == bar_area_x)
3298 width += bar_area_width - sb_width;
3301 #endif
3303 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3304 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3305 bottom_y = y + height;
3307 if (to_y < from_y)
3309 /* Scrolling up. Make sure we don't copy part of the mode
3310 line at the bottom. */
3311 if (from_y + run->height > bottom_y)
3312 height = bottom_y - from_y;
3313 else
3314 height = run->height;
3316 else
3318 /* Scolling down. Make sure we don't copy over the mode line.
3319 at the bottom. */
3320 if (to_y + run->height > bottom_y)
3321 height = bottom_y - to_y;
3322 else
3323 height = run->height;
3326 BLOCK_INPUT;
3328 /* Cursor off. Will be switched on again in x_update_window_end. */
3329 updated_window = w;
3330 x_clear_cursor (w);
3332 XCopyArea (FRAME_X_DISPLAY (f),
3333 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3334 f->output_data.x->normal_gc,
3335 x, from_y,
3336 width, height,
3337 x, to_y);
3339 UNBLOCK_INPUT;
3344 /***********************************************************************
3345 Exposure Events
3346 ***********************************************************************/
3349 static void
3350 frame_highlight (struct frame *f)
3352 /* We used to only do this if Vx_no_window_manager was non-nil, but
3353 the ICCCM (section 4.1.6) says that the window's border pixmap
3354 and border pixel are window attributes which are "private to the
3355 client", so we can always change it to whatever we want. */
3356 BLOCK_INPUT;
3357 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3358 f->output_data.x->border_pixel);
3359 UNBLOCK_INPUT;
3360 x_update_cursor (f, 1);
3361 x_set_frame_alpha (f);
3364 static void
3365 frame_unhighlight (struct frame *f)
3367 /* We used to only do this if Vx_no_window_manager was non-nil, but
3368 the ICCCM (section 4.1.6) says that the window's border pixmap
3369 and border pixel are window attributes which are "private to the
3370 client", so we can always change it to whatever we want. */
3371 BLOCK_INPUT;
3372 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3373 f->output_data.x->border_tile);
3374 UNBLOCK_INPUT;
3375 x_update_cursor (f, 1);
3376 x_set_frame_alpha (f);
3379 /* The focus has changed. Update the frames as necessary to reflect
3380 the new situation. Note that we can't change the selected frame
3381 here, because the Lisp code we are interrupting might become confused.
3382 Each event gets marked with the frame in which it occurred, so the
3383 Lisp code can tell when the switch took place by examining the events. */
3385 static void
3386 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3388 struct frame *old_focus = dpyinfo->x_focus_frame;
3390 if (frame != dpyinfo->x_focus_frame)
3392 /* Set this before calling other routines, so that they see
3393 the correct value of x_focus_frame. */
3394 dpyinfo->x_focus_frame = frame;
3396 if (old_focus && old_focus->auto_lower)
3397 x_lower_frame (old_focus);
3399 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3400 pending_autoraise_frame = dpyinfo->x_focus_frame;
3401 else
3402 pending_autoraise_frame = 0;
3405 x_frame_rehighlight (dpyinfo);
3408 /* Handle FocusIn and FocusOut state changes for FRAME.
3409 If FRAME has focus and there exists more than one frame, puts
3410 a FOCUS_IN_EVENT into *BUFP. */
3412 static void
3413 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3415 if (type == FocusIn)
3417 if (dpyinfo->x_focus_event_frame != frame)
3419 x_new_focus_frame (dpyinfo, frame);
3420 dpyinfo->x_focus_event_frame = frame;
3422 /* Don't stop displaying the initial startup message
3423 for a switch-frame event we don't need. */
3424 if (NILP (Vterminal_frame)
3425 && CONSP (Vframe_list)
3426 && !NILP (XCDR (Vframe_list)))
3428 bufp->kind = FOCUS_IN_EVENT;
3429 XSETFRAME (bufp->frame_or_window, frame);
3433 frame->output_data.x->focus_state |= state;
3435 #ifdef HAVE_X_I18N
3436 if (FRAME_XIC (frame))
3437 XSetICFocus (FRAME_XIC (frame));
3438 #endif
3440 else if (type == FocusOut)
3442 frame->output_data.x->focus_state &= ~state;
3444 if (dpyinfo->x_focus_event_frame == frame)
3446 dpyinfo->x_focus_event_frame = 0;
3447 x_new_focus_frame (dpyinfo, 0);
3450 #ifdef HAVE_X_I18N
3451 if (FRAME_XIC (frame))
3452 XUnsetICFocus (FRAME_XIC (frame));
3453 #endif
3454 if (frame->pointer_invisible)
3455 XTtoggle_invisible_pointer (frame, 0);
3459 /* The focus may have changed. Figure out if it is a real focus change,
3460 by checking both FocusIn/Out and Enter/LeaveNotify events.
3462 Returns FOCUS_IN_EVENT event in *BUFP. */
3464 static void
3465 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3467 struct frame *frame;
3469 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3470 if (! frame)
3471 return;
3473 switch (event->type)
3475 case EnterNotify:
3476 case LeaveNotify:
3478 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3479 int focus_state
3480 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3482 if (event->xcrossing.detail != NotifyInferior
3483 && event->xcrossing.focus
3484 && ! (focus_state & FOCUS_EXPLICIT))
3485 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3486 FOCUS_IMPLICIT,
3487 dpyinfo, frame, bufp);
3489 break;
3491 case FocusIn:
3492 case FocusOut:
3493 x_focus_changed (event->type,
3494 (event->xfocus.detail == NotifyPointer ?
3495 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3496 dpyinfo, frame, bufp);
3497 break;
3499 case ClientMessage:
3500 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3502 enum xembed_message msg = event->xclient.data.l[1];
3503 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3504 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3506 break;
3511 #if defined HAVE_MENUS && !defined USE_X_TOOLKIT && !defined USE_GTK
3512 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3514 void
3515 x_mouse_leave (struct x_display_info *dpyinfo)
3517 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3519 #endif
3521 /* The focus has changed, or we have redirected a frame's focus to
3522 another frame (this happens when a frame uses a surrogate
3523 mini-buffer frame). Shift the highlight as appropriate.
3525 The FRAME argument doesn't necessarily have anything to do with which
3526 frame is being highlighted or un-highlighted; we only use it to find
3527 the appropriate X display info. */
3529 static void
3530 XTframe_rehighlight (struct frame *frame)
3532 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3535 static void
3536 x_frame_rehighlight (struct x_display_info *dpyinfo)
3538 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3540 if (dpyinfo->x_focus_frame)
3542 dpyinfo->x_highlight_frame
3543 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3544 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3545 : dpyinfo->x_focus_frame);
3546 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3548 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3549 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3552 else
3553 dpyinfo->x_highlight_frame = 0;
3555 if (dpyinfo->x_highlight_frame != old_highlight)
3557 if (old_highlight)
3558 frame_unhighlight (old_highlight);
3559 if (dpyinfo->x_highlight_frame)
3560 frame_highlight (dpyinfo->x_highlight_frame);
3566 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3568 /* Initialize mode_switch_bit and modifier_meaning. */
3569 static void
3570 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3572 int min_code, max_code;
3573 KeySym *syms;
3574 int syms_per_code;
3575 XModifierKeymap *mods;
3577 dpyinfo->meta_mod_mask = 0;
3578 dpyinfo->shift_lock_mask = 0;
3579 dpyinfo->alt_mod_mask = 0;
3580 dpyinfo->super_mod_mask = 0;
3581 dpyinfo->hyper_mod_mask = 0;
3583 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3585 syms = XGetKeyboardMapping (dpyinfo->display,
3586 min_code, max_code - min_code + 1,
3587 &syms_per_code);
3588 mods = XGetModifierMapping (dpyinfo->display);
3590 /* Scan the modifier table to see which modifier bits the Meta and
3591 Alt keysyms are on. */
3593 int row, col; /* The row and column in the modifier table. */
3594 int found_alt_or_meta;
3596 for (row = 3; row < 8; row++)
3598 found_alt_or_meta = 0;
3599 for (col = 0; col < mods->max_keypermod; col++)
3601 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3603 /* Zeroes are used for filler. Skip them. */
3604 if (code == 0)
3605 continue;
3607 /* Are any of this keycode's keysyms a meta key? */
3609 int code_col;
3611 for (code_col = 0; code_col < syms_per_code; code_col++)
3613 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3615 switch (sym)
3617 case XK_Meta_L:
3618 case XK_Meta_R:
3619 found_alt_or_meta = 1;
3620 dpyinfo->meta_mod_mask |= (1 << row);
3621 break;
3623 case XK_Alt_L:
3624 case XK_Alt_R:
3625 found_alt_or_meta = 1;
3626 dpyinfo->alt_mod_mask |= (1 << row);
3627 break;
3629 case XK_Hyper_L:
3630 case XK_Hyper_R:
3631 if (!found_alt_or_meta)
3632 dpyinfo->hyper_mod_mask |= (1 << row);
3633 code_col = syms_per_code;
3634 col = mods->max_keypermod;
3635 break;
3637 case XK_Super_L:
3638 case XK_Super_R:
3639 if (!found_alt_or_meta)
3640 dpyinfo->super_mod_mask |= (1 << row);
3641 code_col = syms_per_code;
3642 col = mods->max_keypermod;
3643 break;
3645 case XK_Shift_Lock:
3646 /* Ignore this if it's not on the lock modifier. */
3647 if (!found_alt_or_meta && ((1 << row) == LockMask))
3648 dpyinfo->shift_lock_mask = LockMask;
3649 code_col = syms_per_code;
3650 col = mods->max_keypermod;
3651 break;
3659 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3660 if (! dpyinfo->meta_mod_mask)
3662 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3663 dpyinfo->alt_mod_mask = 0;
3666 /* If some keys are both alt and meta,
3667 make them just meta, not alt. */
3668 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3670 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3673 XFree ((char *) syms);
3674 XFreeModifiermap (mods);
3677 /* Convert between the modifier bits X uses and the modifier bits
3678 Emacs uses. */
3680 EMACS_INT
3681 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
3683 EMACS_INT mod_meta = meta_modifier;
3684 EMACS_INT mod_alt = alt_modifier;
3685 EMACS_INT mod_hyper = hyper_modifier;
3686 EMACS_INT mod_super = super_modifier;
3687 Lisp_Object tem;
3689 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3690 if (INTEGERP (tem)) mod_alt = XINT (tem);
3691 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3692 if (INTEGERP (tem)) mod_meta = XINT (tem);
3693 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3694 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3695 tem = Fget (Vx_super_keysym, Qmodifier_value);
3696 if (INTEGERP (tem)) mod_super = XINT (tem);
3699 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3700 | ((state & ControlMask) ? ctrl_modifier : 0)
3701 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3702 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3703 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3704 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3707 static int
3708 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
3710 int mod_meta = meta_modifier;
3711 int mod_alt = alt_modifier;
3712 int mod_hyper = hyper_modifier;
3713 int mod_super = super_modifier;
3715 Lisp_Object tem;
3717 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3718 if (INTEGERP (tem)) mod_alt = XINT (tem);
3719 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3720 if (INTEGERP (tem)) mod_meta = XINT (tem);
3721 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3722 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3723 tem = Fget (Vx_super_keysym, Qmodifier_value);
3724 if (INTEGERP (tem)) mod_super = XINT (tem);
3727 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3728 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3729 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3730 | ((state & shift_modifier) ? ShiftMask : 0)
3731 | ((state & ctrl_modifier) ? ControlMask : 0)
3732 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3735 /* Convert a keysym to its name. */
3737 char *
3738 x_get_keysym_name (int keysym)
3740 char *value;
3742 BLOCK_INPUT;
3743 value = XKeysymToString (keysym);
3744 UNBLOCK_INPUT;
3746 return value;
3751 /* Mouse clicks and mouse movement. Rah. */
3753 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3755 If the event is a button press, then note that we have grabbed
3756 the mouse. */
3758 static Lisp_Object
3759 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3761 /* Make the event type NO_EVENT; we'll change that when we decide
3762 otherwise. */
3763 result->kind = MOUSE_CLICK_EVENT;
3764 result->code = event->button - Button1;
3765 result->timestamp = event->time;
3766 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3767 event->state)
3768 | (event->type == ButtonRelease
3769 ? up_modifier
3770 : down_modifier));
3772 XSETINT (result->x, event->x);
3773 XSETINT (result->y, event->y);
3774 XSETFRAME (result->frame_or_window, f);
3775 result->arg = Qnil;
3776 return Qnil;
3780 /* Function to report a mouse movement to the mainstream Emacs code.
3781 The input handler calls this.
3783 We have received a mouse movement event, which is given in *event.
3784 If the mouse is over a different glyph than it was last time, tell
3785 the mainstream emacs code by setting mouse_moved. If not, ask for
3786 another motion event, so we can check again the next time it moves. */
3788 static XMotionEvent last_mouse_motion_event;
3789 static Lisp_Object last_mouse_motion_frame;
3791 static int
3792 note_mouse_movement (FRAME_PTR frame, XMotionEvent *event)
3794 last_mouse_movement_time = event->time;
3795 last_mouse_motion_event = *event;
3796 XSETFRAME (last_mouse_motion_frame, frame);
3798 if (!FRAME_X_OUTPUT (frame))
3799 return 0;
3801 if (event->window != FRAME_X_WINDOW (frame))
3803 frame->mouse_moved = 1;
3804 last_mouse_scroll_bar = Qnil;
3805 note_mouse_highlight (frame, -1, -1);
3806 last_mouse_glyph_frame = 0;
3807 return 1;
3811 /* Has the mouse moved off the glyph it was on at the last sighting? */
3812 if (frame != last_mouse_glyph_frame
3813 || event->x < last_mouse_glyph.x
3814 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3815 || event->y < last_mouse_glyph.y
3816 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3818 frame->mouse_moved = 1;
3819 last_mouse_scroll_bar = Qnil;
3820 note_mouse_highlight (frame, event->x, event->y);
3821 /* Remember which glyph we're now on. */
3822 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3823 last_mouse_glyph_frame = frame;
3824 return 1;
3827 return 0;
3831 /************************************************************************
3832 Mouse Face
3833 ************************************************************************/
3835 static void
3836 redo_mouse_highlight (void)
3838 if (!NILP (last_mouse_motion_frame)
3839 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3840 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3841 last_mouse_motion_event.x,
3842 last_mouse_motion_event.y);
3847 /* Return the current position of the mouse.
3848 *FP should be a frame which indicates which display to ask about.
3850 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3851 and *PART to the frame, window, and scroll bar part that the mouse
3852 is over. Set *X and *Y to the portion and whole of the mouse's
3853 position on the scroll bar.
3855 If the mouse movement started elsewhere, set *FP to the frame the
3856 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3857 the mouse is over.
3859 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
3860 was at this position.
3862 Don't store anything if we don't have a valid set of values to report.
3864 This clears the mouse_moved flag, so we can wait for the next mouse
3865 movement. */
3867 static void
3868 XTmouse_position (FRAME_PTR *fp, int insist, Lisp_Object *bar_window,
3869 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
3870 Time *timestamp)
3872 FRAME_PTR f1;
3874 BLOCK_INPUT;
3876 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3877 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
3878 else
3880 Window root;
3881 int root_x, root_y;
3883 Window dummy_window;
3884 int dummy;
3886 Lisp_Object frame, tail;
3888 /* Clear the mouse-moved flag for every frame on this display. */
3889 FOR_EACH_FRAME (tail, frame)
3890 if (FRAME_X_P (XFRAME (frame))
3891 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3892 XFRAME (frame)->mouse_moved = 0;
3894 last_mouse_scroll_bar = Qnil;
3896 /* Figure out which root window we're on. */
3897 XQueryPointer (FRAME_X_DISPLAY (*fp),
3898 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3900 /* The root window which contains the pointer. */
3901 &root,
3903 /* Trash which we can't trust if the pointer is on
3904 a different screen. */
3905 &dummy_window,
3907 /* The position on that root window. */
3908 &root_x, &root_y,
3910 /* More trash we can't trust. */
3911 &dummy, &dummy,
3913 /* Modifier keys and pointer buttons, about which
3914 we don't care. */
3915 (unsigned int *) &dummy);
3917 /* Now we have a position on the root; find the innermost window
3918 containing the pointer. */
3920 Window win, child;
3921 int win_x, win_y;
3922 int parent_x = 0, parent_y = 0;
3924 win = root;
3926 /* XTranslateCoordinates can get errors if the window
3927 structure is changing at the same time this function
3928 is running. So at least we must not crash from them. */
3930 x_catch_errors (FRAME_X_DISPLAY (*fp));
3932 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3933 && FRAME_LIVE_P (last_mouse_frame))
3935 /* If mouse was grabbed on a frame, give coords for that frame
3936 even if the mouse is now outside it. */
3937 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3939 /* From-window, to-window. */
3940 root, FRAME_X_WINDOW (last_mouse_frame),
3942 /* From-position, to-position. */
3943 root_x, root_y, &win_x, &win_y,
3945 /* Child of win. */
3946 &child);
3947 f1 = last_mouse_frame;
3949 else
3951 while (1)
3953 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3955 /* From-window, to-window. */
3956 root, win,
3958 /* From-position, to-position. */
3959 root_x, root_y, &win_x, &win_y,
3961 /* Child of win. */
3962 &child);
3964 if (child == None || child == win)
3965 break;
3966 #ifdef USE_GTK
3967 /* We don't wan't to know the innermost window. We
3968 want the edit window. For non-Gtk+ the innermost
3969 window is the edit window. For Gtk+ it might not
3970 be. It might be the tool bar for example. */
3971 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3972 break;
3973 #endif
3974 win = child;
3975 parent_x = win_x;
3976 parent_y = win_y;
3979 /* Now we know that:
3980 win is the innermost window containing the pointer
3981 (XTC says it has no child containing the pointer),
3982 win_x and win_y are the pointer's position in it
3983 (XTC did this the last time through), and
3984 parent_x and parent_y are the pointer's position in win's parent.
3985 (They are what win_x and win_y were when win was child.
3986 If win is the root window, it has no parent, and
3987 parent_{x,y} are invalid, but that's okay, because we'll
3988 never use them in that case.) */
3990 #ifdef USE_GTK
3991 /* We don't wan't to know the innermost window. We
3992 want the edit window. */
3993 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3994 #else
3995 /* Is win one of our frames? */
3996 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3997 #endif
3999 #ifdef USE_X_TOOLKIT
4000 /* If we end up with the menu bar window, say it's not
4001 on the frame. */
4002 if (f1 != NULL
4003 && f1->output_data.x->menubar_widget
4004 && win == XtWindow (f1->output_data.x->menubar_widget))
4005 f1 = NULL;
4006 #endif /* USE_X_TOOLKIT */
4009 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
4010 f1 = 0;
4012 x_uncatch_errors ();
4014 /* If not, is it one of our scroll bars? */
4015 if (! f1)
4017 struct scroll_bar *bar;
4019 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
4021 if (bar)
4023 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4024 win_x = parent_x;
4025 win_y = parent_y;
4029 if (f1 == 0 && insist > 0)
4030 f1 = SELECTED_FRAME ();
4032 if (f1)
4034 /* Ok, we found a frame. Store all the values.
4035 last_mouse_glyph is a rectangle used to reduce the
4036 generation of mouse events. To not miss any motion
4037 events, we must divide the frame into rectangles of the
4038 size of the smallest character that could be displayed
4039 on it, i.e. into the same rectangles that matrices on
4040 the frame are divided into. */
4042 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
4043 last_mouse_glyph_frame = f1;
4045 *bar_window = Qnil;
4046 *part = 0;
4047 *fp = f1;
4048 XSETINT (*x, win_x);
4049 XSETINT (*y, win_y);
4050 *timestamp = last_mouse_movement_time;
4055 UNBLOCK_INPUT;
4060 /***********************************************************************
4061 Scroll bars
4062 ***********************************************************************/
4064 /* Scroll bar support. */
4066 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4067 manages it.
4068 This can be called in GC, so we have to make sure to strip off mark
4069 bits. */
4071 static struct scroll_bar *
4072 x_window_to_scroll_bar (Display *display, Window window_id)
4074 Lisp_Object tail;
4076 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4077 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4078 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4080 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4082 Lisp_Object frame, bar, condemned;
4084 frame = XCAR (tail);
4085 /* All elements of Vframe_list should be frames. */
4086 if (! FRAMEP (frame))
4087 abort ();
4089 if (! FRAME_X_P (XFRAME (frame)))
4090 continue;
4092 /* Scan this frame's scroll bar list for a scroll bar with the
4093 right window ID. */
4094 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4095 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4096 /* This trick allows us to search both the ordinary and
4097 condemned scroll bar lists with one loop. */
4098 ! NILP (bar) || (bar = condemned,
4099 condemned = Qnil,
4100 ! NILP (bar));
4101 bar = XSCROLL_BAR (bar)->next)
4102 if (XSCROLL_BAR (bar)->x_window == window_id &&
4103 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4104 return XSCROLL_BAR (bar);
4107 return NULL;
4111 #if defined USE_LUCID
4113 /* Return the Lucid menu bar WINDOW is part of. Return null
4114 if WINDOW is not part of a menu bar. */
4116 static Widget
4117 x_window_to_menu_bar (Window window)
4119 Lisp_Object tail;
4121 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4123 if (FRAME_X_P (XFRAME (XCAR (tail))))
4125 Lisp_Object frame = XCAR (tail);
4126 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4128 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4129 return menu_bar;
4133 return NULL;
4136 #endif /* USE_LUCID */
4139 /************************************************************************
4140 Toolkit scroll bars
4141 ************************************************************************/
4143 #ifdef USE_TOOLKIT_SCROLL_BARS
4145 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4146 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4147 static void x_create_toolkit_scroll_bar (struct frame *,
4148 struct scroll_bar *);
4149 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4150 int, int, int);
4153 /* Lisp window being scrolled. Set when starting to interact with
4154 a toolkit scroll bar, reset to nil when ending the interaction. */
4156 static Lisp_Object window_being_scrolled;
4158 /* Last scroll bar part sent in xm_scroll_callback. */
4160 static int last_scroll_bar_part;
4162 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4163 that movements of 1/20 of the screen size are mapped to up/down. */
4165 #ifndef USE_GTK
4166 /* Id of action hook installed for scroll bars. */
4168 static XtActionHookId action_hook_id;
4170 static Boolean xaw3d_arrow_scroll;
4172 /* Whether the drag scrolling maintains the mouse at the top of the
4173 thumb. If not, resizing the thumb needs to be done more carefully
4174 to avoid jerkyness. */
4176 static Boolean xaw3d_pick_top;
4178 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4179 bars are used.. The hook is responsible for detecting when
4180 the user ends an interaction with the scroll bar, and generates
4181 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4183 static void
4184 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4185 XEvent *event, String *params, Cardinal *num_params)
4187 int scroll_bar_p;
4188 const char *end_action;
4190 #ifdef USE_MOTIF
4191 scroll_bar_p = XmIsScrollBar (widget);
4192 end_action = "Release";
4193 #else /* !USE_MOTIF i.e. use Xaw */
4194 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4195 end_action = "EndScroll";
4196 #endif /* USE_MOTIF */
4198 if (scroll_bar_p
4199 && strcmp (action_name, end_action) == 0
4200 && WINDOWP (window_being_scrolled))
4202 struct window *w;
4204 x_send_scroll_bar_event (window_being_scrolled,
4205 scroll_bar_end_scroll, 0, 0);
4206 w = XWINDOW (window_being_scrolled);
4208 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4210 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4211 /* The thumb size is incorrect while dragging: fix it. */
4212 set_vertical_scroll_bar (w);
4214 window_being_scrolled = Qnil;
4215 last_scroll_bar_part = -1;
4217 /* Xt timeouts no longer needed. */
4218 toolkit_scroll_bar_interaction = 0;
4221 #endif /* not USE_GTK */
4223 /* A vector of windows used for communication between
4224 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4226 static struct window **scroll_bar_windows;
4227 static size_t scroll_bar_windows_size;
4230 /* Send a client message with message type Xatom_Scrollbar for a
4231 scroll action to the frame of WINDOW. PART is a value identifying
4232 the part of the scroll bar that was clicked on. PORTION is the
4233 amount to scroll of a whole of WHOLE. */
4235 static void
4236 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4238 XEvent event;
4239 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4240 struct window *w = XWINDOW (window);
4241 struct frame *f = XFRAME (w->frame);
4242 size_t i;
4244 BLOCK_INPUT;
4246 /* Construct a ClientMessage event to send to the frame. */
4247 ev->type = ClientMessage;
4248 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4249 ev->display = FRAME_X_DISPLAY (f);
4250 ev->window = FRAME_X_WINDOW (f);
4251 ev->format = 32;
4253 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4254 not enough to store a pointer or Lisp_Object on a 64 bit system.
4255 So, store the window in scroll_bar_windows and pass the index
4256 into that array in the event. */
4257 for (i = 0; i < scroll_bar_windows_size; ++i)
4258 if (scroll_bar_windows[i] == NULL)
4259 break;
4261 if (i == scroll_bar_windows_size)
4263 size_t new_size = max (10, 2 * scroll_bar_windows_size);
4264 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4265 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4267 if ((size_t) -1 / sizeof *scroll_bar_windows < new_size)
4268 memory_full (SIZE_MAX);
4269 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4270 nbytes);
4271 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4272 scroll_bar_windows_size = new_size;
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.0/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 char const *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 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 /* We use an estimate of 30 chars per line rather than the real
4813 `portion' value. This has the disadvantage that the thumb size
4814 is not very representative, but it makes our life a lot easier.
4815 Otherwise, we have to constantly adjust the thumb size, which
4816 we can't always do quickly enough: while dragging, the size of
4817 the thumb might prevent the user from dragging the thumb all the
4818 way to the end. but Motif and some versions of Xaw3d don't allow
4819 updating the thumb size while dragging. Also, even if we can update
4820 its size, the update will often happen too late.
4821 If you don't believe it, check out revision 1.650 of xterm.c to see
4822 what hoops we were going through and the still poor behavior we got. */
4823 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4824 /* When the thumb is at the bottom, position == whole.
4825 So we need to increase `whole' to make space for the thumb. */
4826 whole += portion;
4828 if (whole <= 0)
4829 top = 0, shown = 1;
4830 else
4832 top = (float) position / whole;
4833 shown = (float) portion / whole;
4836 if (NILP (bar->dragging))
4838 int size, value;
4840 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4841 is the scroll bar's maximum and MIN is the scroll bar's minimum
4842 value. */
4843 size = shown * XM_SB_MAX;
4844 size = min (size, XM_SB_MAX);
4845 size = max (size, 1);
4847 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4848 value = top * XM_SB_MAX;
4849 value = min (value, XM_SB_MAX - size);
4851 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4853 #else /* !USE_MOTIF i.e. use Xaw */
4855 if (whole == 0)
4856 top = 0, shown = 1;
4857 else
4859 top = (float) position / whole;
4860 shown = (float) portion / whole;
4864 float old_top, old_shown;
4865 Dimension height;
4866 XtVaGetValues (widget,
4867 XtNtopOfThumb, &old_top,
4868 XtNshown, &old_shown,
4869 XtNheight, &height,
4870 NULL);
4872 /* Massage the top+shown values. */
4873 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4874 top = max (0, min (1, top));
4875 else
4876 top = old_top;
4877 /* Keep two pixels available for moving the thumb down. */
4878 shown = max (0, min (1 - top - (2.0 / height), shown));
4880 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4881 check that your system's configuration file contains a define
4882 for `NARROWPROTO'. See s/freebsd.h for an example. */
4883 if (top != old_top || shown != old_shown)
4885 if (NILP (bar->dragging))
4886 XawScrollbarSetThumb (widget, top, shown);
4887 else
4889 /* Try to make the scrolling a tad smoother. */
4890 if (!xaw3d_pick_top)
4891 shown = min (shown, old_shown);
4893 XawScrollbarSetThumb (widget, top, shown);
4897 #endif /* !USE_MOTIF */
4899 UNBLOCK_INPUT;
4901 #endif /* not USE_GTK */
4903 #endif /* USE_TOOLKIT_SCROLL_BARS */
4907 /************************************************************************
4908 Scroll bars, general
4909 ************************************************************************/
4911 /* Create a scroll bar and return the scroll bar vector for it. W is
4912 the Emacs window on which to create the scroll bar. TOP, LEFT,
4913 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4914 scroll bar. */
4916 static struct scroll_bar *
4917 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4919 struct frame *f = XFRAME (w->frame);
4920 struct scroll_bar *bar
4921 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4923 BLOCK_INPUT;
4925 #ifdef USE_TOOLKIT_SCROLL_BARS
4926 x_create_toolkit_scroll_bar (f, bar);
4927 #else /* not USE_TOOLKIT_SCROLL_BARS */
4929 XSetWindowAttributes a;
4930 unsigned long mask;
4931 Window window;
4933 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4934 if (a.background_pixel == -1)
4935 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4937 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4938 | ButtonMotionMask | PointerMotionHintMask
4939 | ExposureMask);
4940 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4942 mask = (CWBackPixel | CWEventMask | CWCursor);
4944 /* Clear the area of W that will serve as a scroll bar. This is
4945 for the case that a window has been split horizontally. In
4946 this case, no clear_frame is generated to reduce flickering. */
4947 if (width > 0 && height > 0)
4948 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4949 left, top, width,
4950 window_box_height (w), False);
4952 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4953 /* Position and size of scroll bar. */
4954 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4955 top,
4956 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4957 height,
4958 /* Border width, depth, class, and visual. */
4960 CopyFromParent,
4961 CopyFromParent,
4962 CopyFromParent,
4963 /* Attributes. */
4964 mask, &a);
4965 bar->x_window = window;
4967 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4969 XSETWINDOW (bar->window, w);
4970 bar->top = top;
4971 bar->left = left;
4972 bar->width = width;
4973 bar->height = height;
4974 bar->start = 0;
4975 bar->end = 0;
4976 bar->dragging = Qnil;
4977 bar->fringe_extended_p = 0;
4979 /* Add bar to its frame's list of scroll bars. */
4980 bar->next = FRAME_SCROLL_BARS (f);
4981 bar->prev = Qnil;
4982 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4983 if (!NILP (bar->next))
4984 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4986 /* Map the window/widget. */
4987 #ifdef USE_TOOLKIT_SCROLL_BARS
4989 #ifdef USE_GTK
4990 xg_update_scrollbar_pos (f,
4991 bar->x_window,
4992 top,
4993 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4994 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4995 max (height, 1));
4996 #else /* not USE_GTK */
4997 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4998 XtConfigureWidget (scroll_bar,
4999 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5000 top,
5001 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5002 max (height, 1), 0);
5003 XtMapWidget (scroll_bar);
5004 #endif /* not USE_GTK */
5006 #else /* not USE_TOOLKIT_SCROLL_BARS */
5007 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
5008 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5010 UNBLOCK_INPUT;
5011 return bar;
5015 #ifndef USE_TOOLKIT_SCROLL_BARS
5017 /* Draw BAR's handle in the proper position.
5019 If the handle is already drawn from START to END, don't bother
5020 redrawing it, unless REBUILD is non-zero; in that case, always
5021 redraw it. (REBUILD is handy for drawing the handle after expose
5022 events.)
5024 Normally, we want to constrain the start and end of the handle to
5025 fit inside its rectangle, but if the user is dragging the scroll
5026 bar handle, we want to let them drag it down all the way, so that
5027 the bar's top is as far down as it goes; otherwise, there's no way
5028 to move to the very end of the buffer. */
5030 static void
5031 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
5033 int dragging = ! NILP (bar->dragging);
5034 Window w = bar->x_window;
5035 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5036 GC gc = f->output_data.x->normal_gc;
5038 /* If the display is already accurate, do nothing. */
5039 if (! rebuild
5040 && start == bar->start
5041 && end == bar->end)
5042 return;
5044 BLOCK_INPUT;
5047 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5048 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5049 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5051 /* Make sure the values are reasonable, and try to preserve
5052 the distance between start and end. */
5054 int length = end - start;
5056 if (start < 0)
5057 start = 0;
5058 else if (start > top_range)
5059 start = top_range;
5060 end = start + length;
5062 if (end < start)
5063 end = start;
5064 else if (end > top_range && ! dragging)
5065 end = top_range;
5068 /* Store the adjusted setting in the scroll bar. */
5069 bar->start = start;
5070 bar->end = end;
5072 /* Clip the end position, just for display. */
5073 if (end > top_range)
5074 end = top_range;
5076 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5077 below top positions, to make sure the handle is always at least
5078 that many pixels tall. */
5079 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5081 /* Draw the empty space above the handle. Note that we can't clear
5082 zero-height areas; that means "clear to end of window." */
5083 if (0 < start)
5084 x_clear_area (FRAME_X_DISPLAY (f), w,
5085 /* x, y, width, height, and exposures. */
5086 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5087 VERTICAL_SCROLL_BAR_TOP_BORDER,
5088 inside_width, start,
5089 False);
5091 /* Change to proper foreground color if one is specified. */
5092 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5093 XSetForeground (FRAME_X_DISPLAY (f), gc,
5094 f->output_data.x->scroll_bar_foreground_pixel);
5096 /* Draw the handle itself. */
5097 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5098 /* x, y, width, height */
5099 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5100 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5101 inside_width, end - start);
5103 /* Restore the foreground color of the GC if we changed it above. */
5104 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5105 XSetForeground (FRAME_X_DISPLAY (f), gc,
5106 FRAME_FOREGROUND_PIXEL (f));
5108 /* Draw the empty space below the handle. Note that we can't
5109 clear zero-height areas; that means "clear to end of window." */
5110 if (end < inside_height)
5111 x_clear_area (FRAME_X_DISPLAY (f), w,
5112 /* x, y, width, height, and exposures. */
5113 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5114 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5115 inside_width, inside_height - end,
5116 False);
5120 UNBLOCK_INPUT;
5123 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5125 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5126 nil. */
5128 static void
5129 x_scroll_bar_remove (struct scroll_bar *bar)
5131 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5132 BLOCK_INPUT;
5134 #ifdef USE_TOOLKIT_SCROLL_BARS
5135 #ifdef USE_GTK
5136 xg_remove_scroll_bar (f, bar->x_window);
5137 #else /* not USE_GTK */
5138 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5139 #endif /* not USE_GTK */
5140 #else
5141 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5142 #endif
5144 /* Disassociate this scroll bar from its window. */
5145 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5147 UNBLOCK_INPUT;
5151 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5152 that we are displaying PORTION characters out of a total of WHOLE
5153 characters, starting at POSITION. If WINDOW has no scroll bar,
5154 create one. */
5156 static void
5157 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5159 struct frame *f = XFRAME (w->frame);
5160 struct scroll_bar *bar;
5161 int top, height, left, sb_left, width, sb_width;
5162 int window_y, window_height;
5163 #ifdef USE_TOOLKIT_SCROLL_BARS
5164 int fringe_extended_p;
5165 #endif
5167 /* Get window dimensions. */
5168 window_box (w, -1, 0, &window_y, 0, &window_height);
5169 top = window_y;
5170 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5171 height = window_height;
5173 /* Compute the left edge of the scroll bar area. */
5174 left = WINDOW_SCROLL_BAR_AREA_X (w);
5176 /* Compute the width of the scroll bar which might be less than
5177 the width of the area reserved for the scroll bar. */
5178 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5179 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5180 else
5181 sb_width = width;
5183 /* Compute the left edge of the scroll bar. */
5184 #ifdef USE_TOOLKIT_SCROLL_BARS
5185 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5186 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5187 else
5188 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5189 #else
5190 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5191 sb_left = left + width - sb_width;
5192 else
5193 sb_left = left;
5194 #endif
5196 #ifdef USE_TOOLKIT_SCROLL_BARS
5197 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5198 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5199 && WINDOW_LEFT_FRINGE_WIDTH (w)
5200 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5201 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5202 else
5203 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5204 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5205 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5206 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5207 #endif
5209 /* Does the scroll bar exist yet? */
5210 if (NILP (w->vertical_scroll_bar))
5212 if (width > 0 && height > 0)
5214 BLOCK_INPUT;
5215 #ifdef USE_TOOLKIT_SCROLL_BARS
5216 if (fringe_extended_p)
5217 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5218 sb_left, top, sb_width, height, False);
5219 else
5220 #endif
5221 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5222 left, top, width, height, False);
5223 UNBLOCK_INPUT;
5226 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5228 else
5230 /* It may just need to be moved and resized. */
5231 unsigned int mask = 0;
5233 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5235 BLOCK_INPUT;
5237 if (sb_left != bar->left)
5238 mask |= CWX;
5239 if (top != bar->top)
5240 mask |= CWY;
5241 if (sb_width != bar->width)
5242 mask |= CWWidth;
5243 if (height != bar->height)
5244 mask |= CWHeight;
5246 #ifdef USE_TOOLKIT_SCROLL_BARS
5248 /* Move/size the scroll bar widget. */
5249 if (mask || bar->fringe_extended_p != fringe_extended_p)
5251 /* Since toolkit scroll bars are smaller than the space reserved
5252 for them on the frame, we have to clear "under" them. */
5253 if (width > 0 && height > 0)
5255 if (fringe_extended_p)
5256 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5257 sb_left, top, sb_width, height, False);
5258 else
5259 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5260 left, top, width, height, False);
5262 #ifdef USE_GTK
5263 xg_update_scrollbar_pos (f,
5264 bar->x_window,
5265 top,
5266 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5267 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5268 max (height, 1));
5269 #else /* not USE_GTK */
5270 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5271 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5272 top,
5273 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5274 max (height, 1), 0);
5275 #endif /* not USE_GTK */
5277 #else /* not USE_TOOLKIT_SCROLL_BARS */
5279 /* Clear areas not covered by the scroll bar because of
5280 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5281 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5283 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5284 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5285 height, False);
5286 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5287 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5288 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5289 height, False);
5292 /* Clear areas not covered by the scroll bar because it's not as
5293 wide as the area reserved for it. This makes sure a
5294 previous mode line display is cleared after C-x 2 C-x 1, for
5295 example. */
5297 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5298 int rest = area_width - sb_width;
5299 if (rest > 0 && height > 0)
5301 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5302 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5303 left + area_width - rest, top,
5304 rest, height, False);
5305 else
5306 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5307 left, top, rest, height, False);
5311 /* Move/size the scroll bar window. */
5312 if (mask)
5314 XWindowChanges wc;
5316 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5317 wc.y = top;
5318 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5319 wc.height = height;
5320 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5321 mask, &wc);
5324 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5326 /* Remember new settings. */
5327 bar->left = sb_left;
5328 bar->top = top;
5329 bar->width = sb_width;
5330 bar->height = height;
5332 UNBLOCK_INPUT;
5335 #ifdef USE_TOOLKIT_SCROLL_BARS
5336 bar->fringe_extended_p = fringe_extended_p;
5338 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5339 #else /* not USE_TOOLKIT_SCROLL_BARS */
5340 /* Set the scroll bar's current state, unless we're currently being
5341 dragged. */
5342 if (NILP (bar->dragging))
5344 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5346 if (whole == 0)
5347 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5348 else
5350 int start = ((double) position * top_range) / whole;
5351 int end = ((double) (position + portion) * top_range) / whole;
5352 x_scroll_bar_set_handle (bar, start, end, 0);
5355 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5357 XSETVECTOR (w->vertical_scroll_bar, bar);
5361 /* The following three hooks are used when we're doing a thorough
5362 redisplay of the frame. We don't explicitly know which scroll bars
5363 are going to be deleted, because keeping track of when windows go
5364 away is a real pain - "Can you say set-window-configuration, boys
5365 and girls?" Instead, we just assert at the beginning of redisplay
5366 that *all* scroll bars are to be removed, and then save a scroll bar
5367 from the fiery pit when we actually redisplay its window. */
5369 /* Arrange for all scroll bars on FRAME to be removed at the next call
5370 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5371 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5373 static void
5374 XTcondemn_scroll_bars (FRAME_PTR frame)
5376 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5377 while (! NILP (FRAME_SCROLL_BARS (frame)))
5379 Lisp_Object bar;
5380 bar = FRAME_SCROLL_BARS (frame);
5381 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5382 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5383 XSCROLL_BAR (bar)->prev = Qnil;
5384 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5385 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5386 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5391 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5392 Note that WINDOW isn't necessarily condemned at all. */
5394 static void
5395 XTredeem_scroll_bar (struct window *window)
5397 struct scroll_bar *bar;
5398 struct frame *f;
5400 /* We can't redeem this window's scroll bar if it doesn't have one. */
5401 if (NILP (window->vertical_scroll_bar))
5402 abort ();
5404 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5406 /* Unlink it from the condemned list. */
5407 f = XFRAME (WINDOW_FRAME (window));
5408 if (NILP (bar->prev))
5410 /* If the prev pointer is nil, it must be the first in one of
5411 the lists. */
5412 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5413 /* It's not condemned. Everything's fine. */
5414 return;
5415 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5416 window->vertical_scroll_bar))
5417 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5418 else
5419 /* If its prev pointer is nil, it must be at the front of
5420 one or the other! */
5421 abort ();
5423 else
5424 XSCROLL_BAR (bar->prev)->next = bar->next;
5426 if (! NILP (bar->next))
5427 XSCROLL_BAR (bar->next)->prev = bar->prev;
5429 bar->next = FRAME_SCROLL_BARS (f);
5430 bar->prev = Qnil;
5431 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5432 if (! NILP (bar->next))
5433 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5436 /* Remove all scroll bars on FRAME that haven't been saved since the
5437 last call to `*condemn_scroll_bars_hook'. */
5439 static void
5440 XTjudge_scroll_bars (FRAME_PTR f)
5442 Lisp_Object bar, next;
5444 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5446 /* Clear out the condemned list now so we won't try to process any
5447 more events on the hapless scroll bars. */
5448 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5450 for (; ! NILP (bar); bar = next)
5452 struct scroll_bar *b = XSCROLL_BAR (bar);
5454 x_scroll_bar_remove (b);
5456 next = b->next;
5457 b->next = b->prev = Qnil;
5460 /* Now there should be no references to the condemned scroll bars,
5461 and they should get garbage-collected. */
5465 #ifndef USE_TOOLKIT_SCROLL_BARS
5466 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5467 is a no-op when using toolkit scroll bars.
5469 This may be called from a signal handler, so we have to ignore GC
5470 mark bits. */
5472 static void
5473 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5475 Window w = bar->x_window;
5476 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5477 GC gc = f->output_data.x->normal_gc;
5478 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5480 BLOCK_INPUT;
5482 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5484 /* Switch to scroll bar foreground color. */
5485 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5486 XSetForeground (FRAME_X_DISPLAY (f), gc,
5487 f->output_data.x->scroll_bar_foreground_pixel);
5489 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5490 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5492 /* x, y, width, height */
5493 0, 0,
5494 bar->width - 1 - width_trim - width_trim,
5495 bar->height - 1);
5497 /* Restore the foreground color of the GC if we changed it above. */
5498 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5499 XSetForeground (FRAME_X_DISPLAY (f), gc,
5500 FRAME_FOREGROUND_PIXEL (f));
5502 UNBLOCK_INPUT;
5505 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5507 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5508 is set to something other than NO_EVENT, it is enqueued.
5510 This may be called from a signal handler, so we have to ignore GC
5511 mark bits. */
5514 static void
5515 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5517 if (! WINDOWP (bar->window))
5518 abort ();
5520 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5521 emacs_event->code = event->xbutton.button - Button1;
5522 emacs_event->modifiers
5523 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5524 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5525 event->xbutton.state)
5526 | (event->type == ButtonRelease
5527 ? up_modifier
5528 : down_modifier));
5529 emacs_event->frame_or_window = bar->window;
5530 emacs_event->arg = Qnil;
5531 emacs_event->timestamp = event->xbutton.time;
5533 int top_range
5534 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5535 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5537 if (y < 0) y = 0;
5538 if (y > top_range) y = top_range;
5540 if (y < bar->start)
5541 emacs_event->part = scroll_bar_above_handle;
5542 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5543 emacs_event->part = scroll_bar_handle;
5544 else
5545 emacs_event->part = scroll_bar_below_handle;
5547 #ifndef USE_TOOLKIT_SCROLL_BARS
5548 /* If the user has released the handle, set it to its final position. */
5549 if (event->type == ButtonRelease
5550 && ! NILP (bar->dragging))
5552 int new_start = y - XINT (bar->dragging);
5553 int new_end = new_start + bar->end - bar->start;
5555 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5556 bar->dragging = Qnil;
5558 #endif
5560 XSETINT (emacs_event->x, y);
5561 XSETINT (emacs_event->y, top_range);
5565 #ifndef USE_TOOLKIT_SCROLL_BARS
5567 /* Handle some mouse motion while someone is dragging the scroll bar.
5569 This may be called from a signal handler, so we have to ignore GC
5570 mark bits. */
5572 static void
5573 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5575 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5577 last_mouse_movement_time = event->xmotion.time;
5579 f->mouse_moved = 1;
5580 XSETVECTOR (last_mouse_scroll_bar, bar);
5582 /* If we're dragging the bar, display it. */
5583 if (! NILP (bar->dragging))
5585 /* Where should the handle be now? */
5586 int new_start = event->xmotion.y - XINT (bar->dragging);
5588 if (new_start != bar->start)
5590 int new_end = new_start + bar->end - bar->start;
5592 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5597 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5599 /* Return information to the user about the current position of the mouse
5600 on the scroll bar. */
5602 static void
5603 x_scroll_bar_report_motion (FRAME_PTR *fp, Lisp_Object *bar_window,
5604 enum scroll_bar_part *part, Lisp_Object *x,
5605 Lisp_Object *y, Time *timestamp)
5607 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5608 Window w = bar->x_window;
5609 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5610 int win_x, win_y;
5611 Window dummy_window;
5612 int dummy_coord;
5613 unsigned int dummy_mask;
5615 BLOCK_INPUT;
5617 /* Get the mouse's position relative to the scroll bar window, and
5618 report that. */
5619 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5621 /* Root, child, root x and root y. */
5622 &dummy_window, &dummy_window,
5623 &dummy_coord, &dummy_coord,
5625 /* Position relative to scroll bar. */
5626 &win_x, &win_y,
5628 /* Mouse buttons and modifier keys. */
5629 &dummy_mask))
5631 else
5633 int top_range
5634 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5636 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5638 if (! NILP (bar->dragging))
5639 win_y -= XINT (bar->dragging);
5641 if (win_y < 0)
5642 win_y = 0;
5643 if (win_y > top_range)
5644 win_y = top_range;
5646 *fp = f;
5647 *bar_window = bar->window;
5649 if (! NILP (bar->dragging))
5650 *part = scroll_bar_handle;
5651 else if (win_y < bar->start)
5652 *part = scroll_bar_above_handle;
5653 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5654 *part = scroll_bar_handle;
5655 else
5656 *part = scroll_bar_below_handle;
5658 XSETINT (*x, win_y);
5659 XSETINT (*y, top_range);
5661 f->mouse_moved = 0;
5662 last_mouse_scroll_bar = Qnil;
5665 *timestamp = last_mouse_movement_time;
5667 UNBLOCK_INPUT;
5671 /* The screen has been cleared so we may have changed foreground or
5672 background colors, and the scroll bars may need to be redrawn.
5673 Clear out the scroll bars, and ask for expose events, so we can
5674 redraw them. */
5676 static void
5677 x_scroll_bar_clear (FRAME_PTR f)
5679 #ifndef USE_TOOLKIT_SCROLL_BARS
5680 Lisp_Object bar;
5682 /* We can have scroll bars even if this is 0,
5683 if we just turned off scroll bar mode.
5684 But in that case we should not clear them. */
5685 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5686 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5687 bar = XSCROLL_BAR (bar)->next)
5688 XClearArea (FRAME_X_DISPLAY (f),
5689 XSCROLL_BAR (bar)->x_window,
5690 0, 0, 0, 0, True);
5691 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5695 /* The main X event-reading loop - XTread_socket. */
5697 /* This holds the state XLookupString needs to implement dead keys
5698 and other tricks known as "compose processing". _X Window System_
5699 says that a portable program can't use this, but Stephen Gildea assures
5700 me that letting the compiler initialize it to zeros will work okay.
5702 This must be defined outside of XTread_socket, for the same reasons
5703 given for enter_timestamp, above. */
5705 static XComposeStatus compose_status;
5707 /* Record the last 100 characters stored
5708 to help debug the loss-of-chars-during-GC problem. */
5710 static int temp_index;
5711 static short temp_buffer[100];
5713 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5714 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5715 temp_index = 0; \
5716 temp_buffer[temp_index++] = (keysym)
5718 /* Set this to nonzero to fake an "X I/O error"
5719 on a particular display. */
5721 static struct x_display_info *XTread_socket_fake_io_error;
5723 /* When we find no input here, we occasionally do a no-op command
5724 to verify that the X server is still running and we can still talk with it.
5725 We try all the open displays, one by one.
5726 This variable is used for cycling thru the displays. */
5728 static struct x_display_info *next_noop_dpyinfo;
5730 #if defined USE_X_TOOLKIT || defined USE_GTK
5731 #define SET_SAVED_BUTTON_EVENT \
5732 do \
5734 if (f->output_data.x->saved_menu_event == 0) \
5735 f->output_data.x->saved_menu_event \
5736 = (XEvent *) xmalloc (sizeof (XEvent)); \
5737 *f->output_data.x->saved_menu_event = event; \
5738 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5739 XSETFRAME (inev.ie.frame_or_window, f); \
5741 while (0)
5742 #endif
5744 enum
5746 X_EVENT_NORMAL,
5747 X_EVENT_GOTO_OUT,
5748 X_EVENT_DROP
5751 /* Filter events for the current X input method.
5752 DPYINFO is the display this event is for.
5753 EVENT is the X event to filter.
5755 Returns non-zero if the event was filtered, caller shall not process
5756 this event further.
5757 Returns zero if event is wasn't filtered. */
5759 #ifdef HAVE_X_I18N
5760 static int
5761 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5763 /* XFilterEvent returns non-zero if the input method has
5764 consumed the event. We pass the frame's X window to
5765 XFilterEvent because that's the one for which the IC
5766 was created. */
5768 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5769 event->xclient.window);
5771 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5773 #endif
5775 #ifdef USE_GTK
5776 static int current_count;
5777 static int current_finish;
5778 static struct input_event *current_hold_quit;
5780 /* This is the filter function invoked by the GTK event loop.
5781 It is invoked before the XEvent is translated to a GdkEvent,
5782 so we have a chance to act on the event before GTK. */
5783 static GdkFilterReturn
5784 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5786 XEvent *xev = (XEvent *) gxev;
5788 BLOCK_INPUT;
5789 if (current_count >= 0)
5791 struct x_display_info *dpyinfo;
5793 dpyinfo = x_display_info_for_display (xev->xany.display);
5795 #ifdef HAVE_X_I18N
5796 /* Filter events for the current X input method.
5797 GTK calls XFilterEvent but not for key press and release,
5798 so we do it here. */
5799 if ((xev->type == KeyPress || xev->type == KeyRelease)
5800 && dpyinfo
5801 && x_filter_event (dpyinfo, xev))
5803 UNBLOCK_INPUT;
5804 return GDK_FILTER_REMOVE;
5806 #endif
5808 if (! dpyinfo)
5809 current_finish = X_EVENT_NORMAL;
5810 else
5811 current_count +=
5812 handle_one_xevent (dpyinfo, xev, &current_finish,
5813 current_hold_quit);
5815 else
5816 current_finish = x_dispatch_event (xev, xev->xany.display);
5818 UNBLOCK_INPUT;
5820 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5821 return GDK_FILTER_REMOVE;
5823 return GDK_FILTER_CONTINUE;
5825 #endif /* USE_GTK */
5828 static void xembed_send_message (struct frame *f, Time,
5829 enum xembed_message,
5830 long detail, long data1, long data2);
5832 /* Handles the XEvent EVENT on display DPYINFO.
5834 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5835 *FINISH is zero if caller should continue reading events.
5836 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5838 We return the number of characters stored into the buffer. */
5840 static int
5841 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventptr,
5842 int *finish, struct input_event *hold_quit)
5844 union {
5845 struct input_event ie;
5846 struct selection_input_event sie;
5847 } inev;
5848 int count = 0;
5849 int do_help = 0;
5850 int nbytes = 0;
5851 struct frame *f = NULL;
5852 struct coding_system coding;
5853 XEvent event = *eventptr;
5854 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5856 *finish = X_EVENT_NORMAL;
5858 EVENT_INIT (inev.ie);
5859 inev.ie.kind = NO_EVENT;
5860 inev.ie.arg = Qnil;
5862 if (pending_event_wait.eventtype == event.type)
5863 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5865 switch (event.type)
5867 case ClientMessage:
5869 if (event.xclient.message_type
5870 == dpyinfo->Xatom_wm_protocols
5871 && event.xclient.format == 32)
5873 if (event.xclient.data.l[0]
5874 == dpyinfo->Xatom_wm_take_focus)
5876 /* Use x_any_window_to_frame because this
5877 could be the shell widget window
5878 if the frame has no title bar. */
5879 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5880 #ifdef HAVE_X_I18N
5881 /* Not quite sure this is needed -pd */
5882 if (f && FRAME_XIC (f))
5883 XSetICFocus (FRAME_XIC (f));
5884 #endif
5885 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5886 instructs the WM to set the input focus automatically for
5887 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5888 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5889 it has set the focus. So, XSetInputFocus below is not
5890 needed.
5892 The call to XSetInputFocus below has also caused trouble. In
5893 cases where the XSetInputFocus done by the WM and the one
5894 below are temporally close (on a fast machine), the call
5895 below can generate additional FocusIn events which confuse
5896 Emacs. */
5898 /* Since we set WM_TAKE_FOCUS, we must call
5899 XSetInputFocus explicitly. But not if f is null,
5900 since that might be an event for a deleted frame. */
5901 if (f)
5903 Display *d = event.xclient.display;
5904 /* Catch and ignore errors, in case window has been
5905 iconified by a window manager such as GWM. */
5906 x_catch_errors (d);
5907 XSetInputFocus (d, event.xclient.window,
5908 /* The ICCCM says this is
5909 the only valid choice. */
5910 RevertToParent,
5911 event.xclient.data.l[1]);
5912 /* This is needed to detect the error
5913 if there is an error. */
5914 XSync (d, False);
5915 x_uncatch_errors ();
5917 /* Not certain about handling scroll bars here */
5918 #endif /* 0 */
5919 goto done;
5922 if (event.xclient.data.l[0]
5923 == dpyinfo->Xatom_wm_save_yourself)
5925 /* Save state modify the WM_COMMAND property to
5926 something which can reinstate us. This notifies
5927 the session manager, who's looking for such a
5928 PropertyNotify. Can restart processing when
5929 a keyboard or mouse event arrives. */
5930 /* If we have a session manager, don't set this.
5931 KDE will then start two Emacsen, one for the
5932 session manager and one for this. */
5933 #ifdef HAVE_X_SM
5934 if (! x_session_have_connection ())
5935 #endif
5937 f = x_top_window_to_frame (dpyinfo,
5938 event.xclient.window);
5939 /* This is just so we only give real data once
5940 for a single Emacs process. */
5941 if (f == SELECTED_FRAME ())
5942 XSetCommand (FRAME_X_DISPLAY (f),
5943 event.xclient.window,
5944 initial_argv, initial_argc);
5945 else if (f)
5946 XSetCommand (FRAME_X_DISPLAY (f),
5947 event.xclient.window,
5948 0, 0);
5950 goto done;
5953 if (event.xclient.data.l[0]
5954 == dpyinfo->Xatom_wm_delete_window)
5956 f = x_any_window_to_frame (dpyinfo,
5957 event.xclient.window);
5958 if (!f)
5959 goto OTHER; /* May be a dialog that is to be removed */
5961 inev.ie.kind = DELETE_WINDOW_EVENT;
5962 XSETFRAME (inev.ie.frame_or_window, f);
5963 goto done;
5966 goto done;
5969 if (event.xclient.message_type
5970 == dpyinfo->Xatom_wm_configure_denied)
5972 goto done;
5975 if (event.xclient.message_type
5976 == dpyinfo->Xatom_wm_window_moved)
5978 int new_x, new_y;
5979 f = x_window_to_frame (dpyinfo, event.xclient.window);
5981 new_x = event.xclient.data.s[0];
5982 new_y = event.xclient.data.s[1];
5984 if (f)
5986 f->left_pos = new_x;
5987 f->top_pos = new_y;
5989 goto done;
5992 #ifdef HACK_EDITRES
5993 if (event.xclient.message_type
5994 == dpyinfo->Xatom_editres)
5996 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5997 if (f)
5998 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5999 &event, NULL);
6000 goto done;
6002 #endif /* HACK_EDITRES */
6004 if ((event.xclient.message_type
6005 == dpyinfo->Xatom_DONE)
6006 || (event.xclient.message_type
6007 == dpyinfo->Xatom_PAGE))
6009 /* Ghostview job completed. Kill it. We could
6010 reply with "Next" if we received "Page", but we
6011 currently never do because we are interested in
6012 images, only, which should have 1 page. */
6013 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6014 f = x_window_to_frame (dpyinfo, event.xclient.window);
6015 if (!f)
6016 goto OTHER;
6017 x_kill_gs_process (pixmap, f);
6018 expose_frame (f, 0, 0, 0, 0);
6019 goto done;
6022 #ifdef USE_TOOLKIT_SCROLL_BARS
6023 /* Scroll bar callbacks send a ClientMessage from which
6024 we construct an input_event. */
6025 if (event.xclient.message_type
6026 == dpyinfo->Xatom_Scrollbar)
6028 x_scroll_bar_to_input_event (&event, &inev.ie);
6029 *finish = X_EVENT_GOTO_OUT;
6030 goto done;
6032 #endif /* USE_TOOLKIT_SCROLL_BARS */
6034 /* XEmbed messages from the embedder (if any). */
6035 if (event.xclient.message_type
6036 == dpyinfo->Xatom_XEMBED)
6038 enum xembed_message msg = event.xclient.data.l[1];
6039 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6040 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6042 *finish = X_EVENT_GOTO_OUT;
6043 goto done;
6046 xft_settings_event (dpyinfo, &event);
6048 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6049 if (!f)
6050 goto OTHER;
6051 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6052 *finish = X_EVENT_DROP;
6054 break;
6056 case SelectionNotify:
6057 last_user_time = event.xselection.time;
6058 #ifdef USE_X_TOOLKIT
6059 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6060 goto OTHER;
6061 #endif /* not USE_X_TOOLKIT */
6062 x_handle_selection_notify (&event.xselection);
6063 break;
6065 case SelectionClear: /* Someone has grabbed ownership. */
6066 last_user_time = event.xselectionclear.time;
6067 #ifdef USE_X_TOOLKIT
6068 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6069 goto OTHER;
6070 #endif /* USE_X_TOOLKIT */
6072 XSelectionClearEvent *eventp = &(event.xselectionclear);
6074 inev.ie.kind = SELECTION_CLEAR_EVENT;
6075 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6076 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6077 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6078 inev.ie.frame_or_window = Qnil;
6080 break;
6082 case SelectionRequest: /* Someone wants our selection. */
6083 last_user_time = event.xselectionrequest.time;
6084 #ifdef USE_X_TOOLKIT
6085 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6086 goto OTHER;
6087 #endif /* USE_X_TOOLKIT */
6089 XSelectionRequestEvent *eventp = &(event.xselectionrequest);
6091 inev.ie.kind = SELECTION_REQUEST_EVENT;
6092 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6093 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6094 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6095 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6096 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6097 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6098 inev.ie.frame_or_window = Qnil;
6100 break;
6102 case PropertyNotify:
6103 last_user_time = event.xproperty.time;
6104 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6105 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6106 x_handle_net_wm_state (f, &event.xproperty);
6108 x_handle_property_notify (&event.xproperty);
6109 xft_settings_event (dpyinfo, &event);
6110 goto OTHER;
6112 case ReparentNotify:
6113 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6114 if (f)
6116 int x, y;
6117 f->output_data.x->parent_desc = event.xreparent.parent;
6118 x_real_positions (f, &x, &y);
6119 f->left_pos = x;
6120 f->top_pos = y;
6122 /* Perhaps reparented due to a WM restart. Reset this. */
6123 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6124 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6126 x_set_frame_alpha (f);
6128 goto OTHER;
6130 case Expose:
6131 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6132 if (f)
6134 #ifdef USE_GTK
6135 /* This seems to be needed for GTK 2.6. */
6136 x_clear_area (event.xexpose.display,
6137 event.xexpose.window,
6138 event.xexpose.x, event.xexpose.y,
6139 event.xexpose.width, event.xexpose.height,
6140 FALSE);
6141 #endif
6142 if (f->async_visible == 0)
6144 f->async_visible = 1;
6145 f->async_iconified = 0;
6146 f->output_data.x->has_been_visible = 1;
6147 SET_FRAME_GARBAGED (f);
6149 else
6150 expose_frame (f,
6151 event.xexpose.x, event.xexpose.y,
6152 event.xexpose.width, event.xexpose.height);
6154 else
6156 #ifndef USE_TOOLKIT_SCROLL_BARS
6157 struct scroll_bar *bar;
6158 #endif
6159 #if defined USE_LUCID
6160 /* Submenus of the Lucid menu bar aren't widgets
6161 themselves, so there's no way to dispatch events
6162 to them. Recognize this case separately. */
6164 Widget widget
6165 = x_window_to_menu_bar (event.xexpose.window);
6166 if (widget)
6167 xlwmenu_redisplay (widget);
6169 #endif /* USE_LUCID */
6171 #ifdef USE_TOOLKIT_SCROLL_BARS
6172 /* Dispatch event to the widget. */
6173 goto OTHER;
6174 #else /* not USE_TOOLKIT_SCROLL_BARS */
6175 bar = x_window_to_scroll_bar (event.xexpose.display,
6176 event.xexpose.window);
6178 if (bar)
6179 x_scroll_bar_expose (bar, &event);
6180 #ifdef USE_X_TOOLKIT
6181 else
6182 goto OTHER;
6183 #endif /* USE_X_TOOLKIT */
6184 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6186 break;
6188 case GraphicsExpose: /* This occurs when an XCopyArea's
6189 source area was obscured or not
6190 available. */
6191 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6192 if (f)
6194 expose_frame (f,
6195 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6196 event.xgraphicsexpose.width,
6197 event.xgraphicsexpose.height);
6199 #ifdef USE_X_TOOLKIT
6200 else
6201 goto OTHER;
6202 #endif /* USE_X_TOOLKIT */
6203 break;
6205 case NoExpose: /* This occurs when an XCopyArea's
6206 source area was completely
6207 available. */
6208 break;
6210 case UnmapNotify:
6211 /* Redo the mouse-highlight after the tooltip has gone. */
6212 if (event.xmap.window == tip_window)
6214 tip_window = 0;
6215 redo_mouse_highlight ();
6218 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6219 if (f) /* F may no longer exist if
6220 the frame was deleted. */
6222 /* While a frame is unmapped, display generation is
6223 disabled; you don't want to spend time updating a
6224 display that won't ever be seen. */
6225 f->async_visible = 0;
6226 /* We can't distinguish, from the event, whether the window
6227 has become iconified or invisible. So assume, if it
6228 was previously visible, than now it is iconified.
6229 But x_make_frame_invisible clears both
6230 the visible flag and the iconified flag;
6231 and that way, we know the window is not iconified now. */
6232 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6234 f->async_iconified = 1;
6236 inev.ie.kind = ICONIFY_EVENT;
6237 XSETFRAME (inev.ie.frame_or_window, f);
6240 goto OTHER;
6242 case MapNotify:
6243 if (event.xmap.window == tip_window)
6244 /* The tooltip has been drawn already. Avoid
6245 the SET_FRAME_GARBAGED below. */
6246 goto OTHER;
6248 /* We use x_top_window_to_frame because map events can
6249 come for sub-windows and they don't mean that the
6250 frame is visible. */
6251 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6252 if (f)
6254 /* wait_reading_process_output will notice this and update
6255 the frame's display structures.
6256 If we where iconified, we should not set garbaged,
6257 because that stops redrawing on Expose events. This looks
6258 bad if we are called from a recursive event loop
6259 (x_dispatch_event), for example when a dialog is up. */
6260 if (! f->async_iconified)
6261 SET_FRAME_GARBAGED (f);
6263 /* Check if fullscreen was specified before we where mapped the
6264 first time, i.e. from the command line. */
6265 if (!f->output_data.x->has_been_visible)
6266 x_check_fullscreen (f);
6268 f->async_visible = 1;
6269 f->async_iconified = 0;
6270 f->output_data.x->has_been_visible = 1;
6272 if (f->iconified)
6274 inev.ie.kind = DEICONIFY_EVENT;
6275 XSETFRAME (inev.ie.frame_or_window, f);
6277 else if (! NILP (Vframe_list)
6278 && ! NILP (XCDR (Vframe_list)))
6279 /* Force a redisplay sooner or later
6280 to update the frame titles
6281 in case this is the second frame. */
6282 record_asynch_buffer_change ();
6284 #ifdef USE_GTK
6285 xg_frame_resized (f, -1, -1);
6286 #endif
6288 goto OTHER;
6290 case KeyPress:
6292 last_user_time = event.xkey.time;
6293 ignore_next_mouse_click_timeout = 0;
6295 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6296 /* Dispatch KeyPress events when in menu. */
6297 if (popup_activated ())
6298 goto OTHER;
6299 #endif
6301 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6303 /* If mouse-highlight is an integer, input clears out
6304 mouse highlighting. */
6305 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6306 && (f == 0
6307 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6309 clear_mouse_face (hlinfo);
6310 hlinfo->mouse_face_hidden = 1;
6313 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6314 if (f == 0)
6316 /* Scroll bars consume key events, but we want
6317 the keys to go to the scroll bar's frame. */
6318 Widget widget = XtWindowToWidget (dpyinfo->display,
6319 event.xkey.window);
6320 if (widget && XmIsScrollBar (widget))
6322 widget = XtParent (widget);
6323 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6326 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6328 if (f != 0)
6330 KeySym keysym, orig_keysym;
6331 /* al%imercury@uunet.uu.net says that making this 81
6332 instead of 80 fixed a bug whereby meta chars made
6333 his Emacs hang.
6335 It seems that some version of XmbLookupString has
6336 a bug of not returning XBufferOverflow in
6337 status_return even if the input is too long to
6338 fit in 81 bytes. So, we must prepare sufficient
6339 bytes for copy_buffer. 513 bytes (256 chars for
6340 two-byte character set) seems to be a fairly good
6341 approximation. -- 2000.8.10 handa@etl.go.jp */
6342 unsigned char copy_buffer[513];
6343 unsigned char *copy_bufptr = copy_buffer;
6344 int copy_bufsiz = sizeof (copy_buffer);
6345 int modifiers;
6346 Lisp_Object coding_system = Qlatin_1;
6347 Lisp_Object c;
6349 #ifdef USE_GTK
6350 /* Don't pass keys to GTK. A Tab will shift focus to the
6351 tool bar in GTK 2.4. Keys will still go to menus and
6352 dialogs because in that case popup_activated is TRUE
6353 (see above). */
6354 *finish = X_EVENT_DROP;
6355 #endif
6357 event.xkey.state
6358 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6359 extra_keyboard_modifiers);
6360 modifiers = event.xkey.state;
6362 /* This will have to go some day... */
6364 /* make_lispy_event turns chars into control chars.
6365 Don't do it here because XLookupString is too eager. */
6366 event.xkey.state &= ~ControlMask;
6367 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6368 | dpyinfo->super_mod_mask
6369 | dpyinfo->hyper_mod_mask
6370 | dpyinfo->alt_mod_mask);
6372 /* In case Meta is ComposeCharacter,
6373 clear its status. According to Markus Ehrnsperger
6374 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6375 this enables ComposeCharacter to work whether or
6376 not it is combined with Meta. */
6377 if (modifiers & dpyinfo->meta_mod_mask)
6378 memset (&compose_status, 0, sizeof (compose_status));
6380 #ifdef HAVE_X_I18N
6381 if (FRAME_XIC (f))
6383 Status status_return;
6385 coding_system = Vlocale_coding_system;
6386 nbytes = XmbLookupString (FRAME_XIC (f),
6387 &event.xkey, (char *) copy_bufptr,
6388 copy_bufsiz, &keysym,
6389 &status_return);
6390 if (status_return == XBufferOverflow)
6392 copy_bufsiz = nbytes + 1;
6393 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6394 nbytes = XmbLookupString (FRAME_XIC (f),
6395 &event.xkey, (char *) copy_bufptr,
6396 copy_bufsiz, &keysym,
6397 &status_return);
6399 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6400 if (status_return == XLookupNone)
6401 break;
6402 else if (status_return == XLookupChars)
6404 keysym = NoSymbol;
6405 modifiers = 0;
6407 else if (status_return != XLookupKeySym
6408 && status_return != XLookupBoth)
6409 abort ();
6411 else
6412 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6413 copy_bufsiz, &keysym,
6414 &compose_status);
6415 #else
6416 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6417 copy_bufsiz, &keysym,
6418 &compose_status);
6419 #endif
6421 /* If not using XIM/XIC, and a compose sequence is in progress,
6422 we break here. Otherwise, chars_matched is always 0. */
6423 if (compose_status.chars_matched > 0 && nbytes == 0)
6424 break;
6426 memset (&compose_status, 0, sizeof (compose_status));
6427 orig_keysym = keysym;
6429 /* Common for all keysym input events. */
6430 XSETFRAME (inev.ie.frame_or_window, f);
6431 inev.ie.modifiers
6432 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6433 inev.ie.timestamp = event.xkey.time;
6435 /* First deal with keysyms which have defined
6436 translations to characters. */
6437 if (keysym >= 32 && keysym < 128)
6438 /* Avoid explicitly decoding each ASCII character. */
6440 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6441 inev.ie.code = keysym;
6442 goto done_keysym;
6445 /* Keysyms directly mapped to Unicode characters. */
6446 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6448 if (keysym < 0x01000080)
6449 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6450 else
6451 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6452 inev.ie.code = keysym & 0xFFFFFF;
6453 goto done_keysym;
6456 /* Now non-ASCII. */
6457 if (HASH_TABLE_P (Vx_keysym_table)
6458 && (NATNUMP (c = Fgethash (make_number (keysym),
6459 Vx_keysym_table,
6460 Qnil))))
6462 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6463 ? ASCII_KEYSTROKE_EVENT
6464 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6465 inev.ie.code = XFASTINT (c);
6466 goto done_keysym;
6469 /* Random non-modifier sorts of keysyms. */
6470 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6471 || keysym == XK_Delete
6472 #ifdef XK_ISO_Left_Tab
6473 || (keysym >= XK_ISO_Left_Tab
6474 && keysym <= XK_ISO_Enter)
6475 #endif
6476 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6477 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6478 #ifdef HPUX
6479 /* This recognizes the "extended function
6480 keys". It seems there's no cleaner way.
6481 Test IsModifierKey to avoid handling
6482 mode_switch incorrectly. */
6483 || (XK_Select <= keysym && keysym < XK_KP_Space)
6484 #endif
6485 #ifdef XK_dead_circumflex
6486 || orig_keysym == XK_dead_circumflex
6487 #endif
6488 #ifdef XK_dead_grave
6489 || orig_keysym == XK_dead_grave
6490 #endif
6491 #ifdef XK_dead_tilde
6492 || orig_keysym == XK_dead_tilde
6493 #endif
6494 #ifdef XK_dead_diaeresis
6495 || orig_keysym == XK_dead_diaeresis
6496 #endif
6497 #ifdef XK_dead_macron
6498 || orig_keysym == XK_dead_macron
6499 #endif
6500 #ifdef XK_dead_degree
6501 || orig_keysym == XK_dead_degree
6502 #endif
6503 #ifdef XK_dead_acute
6504 || orig_keysym == XK_dead_acute
6505 #endif
6506 #ifdef XK_dead_cedilla
6507 || orig_keysym == XK_dead_cedilla
6508 #endif
6509 #ifdef XK_dead_breve
6510 || orig_keysym == XK_dead_breve
6511 #endif
6512 #ifdef XK_dead_ogonek
6513 || orig_keysym == XK_dead_ogonek
6514 #endif
6515 #ifdef XK_dead_caron
6516 || orig_keysym == XK_dead_caron
6517 #endif
6518 #ifdef XK_dead_doubleacute
6519 || orig_keysym == XK_dead_doubleacute
6520 #endif
6521 #ifdef XK_dead_abovedot
6522 || orig_keysym == XK_dead_abovedot
6523 #endif
6524 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6525 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6526 /* Any "vendor-specific" key is ok. */
6527 || (orig_keysym & (1 << 28))
6528 || (keysym != NoSymbol && nbytes == 0))
6529 && ! (IsModifierKey (orig_keysym)
6530 /* The symbols from XK_ISO_Lock
6531 to XK_ISO_Last_Group_Lock
6532 don't have real modifiers but
6533 should be treated similarly to
6534 Mode_switch by Emacs. */
6535 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6536 || (XK_ISO_Lock <= orig_keysym
6537 && orig_keysym <= XK_ISO_Last_Group_Lock)
6538 #endif
6541 STORE_KEYSYM_FOR_DEBUG (keysym);
6542 /* make_lispy_event will convert this to a symbolic
6543 key. */
6544 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6545 inev.ie.code = keysym;
6546 goto done_keysym;
6549 { /* Raw bytes, not keysym. */
6550 register int i;
6551 int nchars, len;
6553 for (i = 0, nchars = 0; i < nbytes; i++)
6555 if (ASCII_BYTE_P (copy_bufptr[i]))
6556 nchars++;
6557 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6560 if (nchars < nbytes)
6562 /* Decode the input data. */
6563 int require;
6565 /* The input should be decoded with `coding_system'
6566 which depends on which X*LookupString function
6567 we used just above and the locale. */
6568 setup_coding_system (coding_system, &coding);
6569 coding.src_multibyte = 0;
6570 coding.dst_multibyte = 1;
6571 /* The input is converted to events, thus we can't
6572 handle composition. Anyway, there's no XIM that
6573 gives us composition information. */
6574 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6576 require = MAX_MULTIBYTE_LENGTH * nbytes;
6577 coding.destination = alloca (require);
6578 coding.dst_bytes = require;
6579 coding.mode |= CODING_MODE_LAST_BLOCK;
6580 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6581 nbytes = coding.produced;
6582 nchars = coding.produced_char;
6583 copy_bufptr = coding.destination;
6586 /* Convert the input data to a sequence of
6587 character events. */
6588 for (i = 0; i < nbytes; i += len)
6590 int ch;
6591 if (nchars == nbytes)
6592 ch = copy_bufptr[i], len = 1;
6593 else
6594 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6595 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
6596 ? ASCII_KEYSTROKE_EVENT
6597 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6598 inev.ie.code = ch;
6599 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6602 count += nchars;
6604 inev.ie.kind = NO_EVENT; /* Already stored above. */
6606 if (keysym == NoSymbol)
6607 break;
6610 done_keysym:
6611 #ifdef HAVE_X_I18N
6612 /* Don't dispatch this event since XtDispatchEvent calls
6613 XFilterEvent, and two calls in a row may freeze the
6614 client. */
6615 break;
6616 #else
6617 goto OTHER;
6618 #endif
6620 case KeyRelease:
6621 last_user_time = event.xkey.time;
6622 #ifdef HAVE_X_I18N
6623 /* Don't dispatch this event since XtDispatchEvent calls
6624 XFilterEvent, and two calls in a row may freeze the
6625 client. */
6626 break;
6627 #else
6628 goto OTHER;
6629 #endif
6631 case EnterNotify:
6632 last_user_time = event.xcrossing.time;
6633 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6635 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6637 if (f && x_mouse_click_focus_ignore_position)
6638 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6640 /* EnterNotify counts as mouse movement,
6641 so update things that depend on mouse position. */
6642 if (f && !f->output_data.x->hourglass_p)
6643 note_mouse_movement (f, &event.xmotion);
6644 #ifdef USE_GTK
6645 /* We may get an EnterNotify on the buttons in the toolbar. In that
6646 case we moved out of any highlighted area and need to note this. */
6647 if (!f && last_mouse_glyph_frame)
6648 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6649 #endif
6650 goto OTHER;
6652 case FocusIn:
6653 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6654 goto OTHER;
6656 case LeaveNotify:
6657 last_user_time = event.xcrossing.time;
6658 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6660 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6661 if (f)
6663 if (f == hlinfo->mouse_face_mouse_frame)
6665 /* If we move outside the frame, then we're
6666 certainly no longer on any text in the frame. */
6667 clear_mouse_face (hlinfo);
6668 hlinfo->mouse_face_mouse_frame = 0;
6671 /* Generate a nil HELP_EVENT to cancel a help-echo.
6672 Do it only if there's something to cancel.
6673 Otherwise, the startup message is cleared when
6674 the mouse leaves the frame. */
6675 if (any_help_event_p)
6676 do_help = -1;
6678 #ifdef USE_GTK
6679 /* See comment in EnterNotify above */
6680 else if (last_mouse_glyph_frame)
6681 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6682 #endif
6683 goto OTHER;
6685 case FocusOut:
6686 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6687 goto OTHER;
6689 case MotionNotify:
6691 last_user_time = event.xmotion.time;
6692 previous_help_echo_string = help_echo_string;
6693 help_echo_string = Qnil;
6695 if (dpyinfo->grabbed && last_mouse_frame
6696 && FRAME_LIVE_P (last_mouse_frame))
6697 f = last_mouse_frame;
6698 else
6699 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6701 if (hlinfo->mouse_face_hidden)
6703 hlinfo->mouse_face_hidden = 0;
6704 clear_mouse_face (hlinfo);
6707 #ifdef USE_GTK
6708 if (f && xg_event_is_for_scrollbar (f, &event))
6709 f = 0;
6710 #endif
6711 if (f)
6714 /* Generate SELECT_WINDOW_EVENTs when needed.
6715 Don't let popup menus influence things (bug#1261). */
6716 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6718 Lisp_Object window;
6720 window = window_from_coordinates (f,
6721 event.xmotion.x, event.xmotion.y,
6722 0, 0);
6724 /* Window will be selected only when it is not selected now and
6725 last mouse movement event was not in it. Minibuffer window
6726 will be selected only when it is active. */
6727 if (WINDOWP (window)
6728 && !EQ (window, last_window)
6729 && !EQ (window, selected_window)
6730 /* For click-to-focus window managers
6731 create event iff we don't leave the
6732 selected frame. */
6733 && (focus_follows_mouse
6734 || (EQ (XWINDOW (window)->frame,
6735 XWINDOW (selected_window)->frame))))
6737 inev.ie.kind = SELECT_WINDOW_EVENT;
6738 inev.ie.frame_or_window = window;
6741 last_window=window;
6743 if (!note_mouse_movement (f, &event.xmotion))
6744 help_echo_string = previous_help_echo_string;
6746 else
6748 #ifndef USE_TOOLKIT_SCROLL_BARS
6749 struct scroll_bar *bar
6750 = x_window_to_scroll_bar (event.xmotion.display,
6751 event.xmotion.window);
6753 if (bar)
6754 x_scroll_bar_note_movement (bar, &event);
6755 #endif /* USE_TOOLKIT_SCROLL_BARS */
6757 /* If we move outside the frame, then we're
6758 certainly no longer on any text in the frame. */
6759 clear_mouse_face (hlinfo);
6762 /* If the contents of the global variable help_echo_string
6763 has changed, generate a HELP_EVENT. */
6764 if (!NILP (help_echo_string)
6765 || !NILP (previous_help_echo_string))
6766 do_help = 1;
6767 goto OTHER;
6770 case ConfigureNotify:
6771 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6772 #ifdef USE_GTK
6773 if (!f
6774 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6775 && event.xconfigure.window == FRAME_X_WINDOW (f))
6777 xg_frame_resized (f, event.xconfigure.width,
6778 event.xconfigure.height);
6779 f = 0;
6781 #endif
6782 if (f)
6784 #ifndef USE_X_TOOLKIT
6785 #ifndef USE_GTK
6786 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6787 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6789 /* In the toolkit version, change_frame_size
6790 is called by the code that handles resizing
6791 of the EmacsFrame widget. */
6793 /* Even if the number of character rows and columns has
6794 not changed, the font size may have changed, so we need
6795 to check the pixel dimensions as well. */
6796 if (columns != FRAME_COLS (f)
6797 || rows != FRAME_LINES (f)
6798 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6799 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6801 change_frame_size (f, rows, columns, 0, 1, 0);
6802 SET_FRAME_GARBAGED (f);
6803 cancel_mouse_face (f);
6806 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6807 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6808 #endif /* not USE_GTK */
6809 #endif
6811 #ifdef USE_GTK
6812 /* GTK creates windows but doesn't map them.
6813 Only get real positions when mapped. */
6814 if (FRAME_GTK_OUTER_WIDGET (f)
6815 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6816 #endif
6818 x_real_positions (f, &f->left_pos, &f->top_pos);
6821 #ifdef HAVE_X_I18N
6822 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6823 xic_set_statusarea (f);
6824 #endif
6827 goto OTHER;
6829 case ButtonRelease:
6830 case ButtonPress:
6832 /* If we decide we want to generate an event to be seen
6833 by the rest of Emacs, we put it here. */
6834 int tool_bar_p = 0;
6836 memset (&compose_status, 0, sizeof (compose_status));
6837 last_mouse_glyph_frame = 0;
6838 last_user_time = event.xbutton.time;
6840 if (dpyinfo->grabbed
6841 && last_mouse_frame
6842 && FRAME_LIVE_P (last_mouse_frame))
6843 f = last_mouse_frame;
6844 else
6845 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6847 #ifdef USE_GTK
6848 if (f && xg_event_is_for_scrollbar (f, &event))
6849 f = 0;
6850 #endif
6851 if (f)
6853 /* Is this in the tool-bar? */
6854 if (WINDOWP (f->tool_bar_window)
6855 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6857 Lisp_Object window;
6858 int x = event.xbutton.x;
6859 int y = event.xbutton.y;
6861 window = window_from_coordinates (f, x, y, 0, 1);
6862 tool_bar_p = EQ (window, f->tool_bar_window);
6864 if (tool_bar_p && event.xbutton.button < 4)
6866 handle_tool_bar_click (f, x, y,
6867 event.xbutton.type == ButtonPress,
6868 x_x_to_emacs_modifiers (dpyinfo,
6869 event.xbutton.state));
6873 if (!tool_bar_p)
6874 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6875 if (! popup_activated ())
6876 #endif
6878 if (ignore_next_mouse_click_timeout)
6880 if (event.type == ButtonPress
6881 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6883 ignore_next_mouse_click_timeout = 0;
6884 construct_mouse_click (&inev.ie, &event.xbutton, f);
6886 if (event.type == ButtonRelease)
6887 ignore_next_mouse_click_timeout = 0;
6889 else
6890 construct_mouse_click (&inev.ie, &event.xbutton, f);
6892 if (FRAME_X_EMBEDDED_P (f))
6893 xembed_send_message (f, event.xbutton.time,
6894 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6896 else
6898 struct scroll_bar *bar
6899 = x_window_to_scroll_bar (event.xbutton.display,
6900 event.xbutton.window);
6902 #ifdef USE_TOOLKIT_SCROLL_BARS
6903 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6904 scroll bars. */
6905 if (bar && event.xbutton.state & ControlMask)
6907 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6908 *finish = X_EVENT_DROP;
6910 #else /* not USE_TOOLKIT_SCROLL_BARS */
6911 if (bar)
6912 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6913 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6916 if (event.type == ButtonPress)
6918 dpyinfo->grabbed |= (1 << event.xbutton.button);
6919 last_mouse_frame = f;
6921 if (!tool_bar_p)
6922 last_tool_bar_item = -1;
6924 else
6925 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6927 /* Ignore any mouse motion that happened before this event;
6928 any subsequent mouse-movement Emacs events should reflect
6929 only motion after the ButtonPress/Release. */
6930 if (f != 0)
6931 f->mouse_moved = 0;
6933 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6934 f = x_menubar_window_to_frame (dpyinfo, &event);
6935 /* For a down-event in the menu bar,
6936 don't pass it to Xt right now.
6937 Instead, save it away
6938 and we will pass it to Xt from kbd_buffer_get_event.
6939 That way, we can run some Lisp code first. */
6940 if (! popup_activated ()
6941 #ifdef USE_GTK
6942 /* Gtk+ menus only react to the first three buttons. */
6943 && event.xbutton.button < 3
6944 #endif
6945 && f && event.type == ButtonPress
6946 /* Verify the event is really within the menu bar
6947 and not just sent to it due to grabbing. */
6948 && event.xbutton.x >= 0
6949 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6950 && event.xbutton.y >= 0
6951 && event.xbutton.y < f->output_data.x->menubar_height
6952 && event.xbutton.same_screen)
6954 SET_SAVED_BUTTON_EVENT;
6955 XSETFRAME (last_mouse_press_frame, f);
6956 *finish = X_EVENT_DROP;
6958 else if (event.type == ButtonPress)
6960 last_mouse_press_frame = Qnil;
6961 goto OTHER;
6963 else
6964 goto OTHER;
6965 #endif /* USE_X_TOOLKIT || USE_GTK */
6967 break;
6969 case CirculateNotify:
6970 goto OTHER;
6972 case CirculateRequest:
6973 goto OTHER;
6975 case VisibilityNotify:
6976 goto OTHER;
6978 case MappingNotify:
6979 /* Someone has changed the keyboard mapping - update the
6980 local cache. */
6981 switch (event.xmapping.request)
6983 case MappingModifier:
6984 x_find_modifier_meanings (dpyinfo);
6985 /* This is meant to fall through. */
6986 case MappingKeyboard:
6987 XRefreshKeyboardMapping (&event.xmapping);
6989 goto OTHER;
6991 case DestroyNotify:
6992 xft_settings_event (dpyinfo, &event);
6993 break;
6995 default:
6996 OTHER:
6997 #ifdef USE_X_TOOLKIT
6998 BLOCK_INPUT;
6999 if (*finish != X_EVENT_DROP)
7000 XtDispatchEvent (&event);
7001 UNBLOCK_INPUT;
7002 #endif /* USE_X_TOOLKIT */
7003 break;
7006 done:
7007 if (inev.ie.kind != NO_EVENT)
7009 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7010 count++;
7013 if (do_help
7014 && !(hold_quit && hold_quit->kind != NO_EVENT))
7016 Lisp_Object frame;
7018 if (f)
7019 XSETFRAME (frame, f);
7020 else
7021 frame = Qnil;
7023 if (do_help > 0)
7025 any_help_event_p = 1;
7026 gen_help_event (help_echo_string, frame, help_echo_window,
7027 help_echo_object, help_echo_pos);
7029 else
7031 help_echo_string = Qnil;
7032 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7034 count++;
7037 *eventptr = event;
7038 return count;
7041 #if defined USE_GTK || defined USE_X_TOOLKIT
7043 /* Handles the XEvent EVENT on display DISPLAY.
7044 This is used for event loops outside the normal event handling,
7045 i.e. looping while a popup menu or a dialog is posted.
7047 Returns the value handle_one_xevent sets in the finish argument. */
7049 x_dispatch_event (XEvent *event, Display *display)
7051 struct x_display_info *dpyinfo;
7052 int finish = X_EVENT_NORMAL;
7054 dpyinfo = x_display_info_for_display (display);
7056 if (dpyinfo)
7057 handle_one_xevent (dpyinfo, event, &finish, 0);
7059 return finish;
7061 #endif
7064 /* Read events coming from the X server.
7065 This routine is called by the SIGIO handler.
7066 We return as soon as there are no more events to be read.
7068 We return the number of characters stored into the buffer,
7069 thus pretending to be `read' (except the characters we store
7070 in the keyboard buffer can be multibyte, so are not necessarily
7071 C chars).
7073 EXPECTED is nonzero if the caller knows input is available. */
7075 static int
7076 XTread_socket (struct terminal *terminal, int expected, struct input_event *hold_quit)
7078 int count = 0;
7079 int event_found = 0;
7081 if (interrupt_input_blocked)
7083 interrupt_input_pending = 1;
7084 #ifdef SYNC_INPUT
7085 pending_signals = 1;
7086 #endif
7087 return -1;
7090 interrupt_input_pending = 0;
7091 #ifdef SYNC_INPUT
7092 pending_signals = pending_atimers;
7093 #endif
7094 BLOCK_INPUT;
7096 /* So people can tell when we have read the available input. */
7097 input_signal_count++;
7099 ++handling_signal;
7101 /* For debugging, this gives a way to fake an I/O error. */
7102 if (terminal->display_info.x == XTread_socket_fake_io_error)
7104 XTread_socket_fake_io_error = 0;
7105 x_io_error_quitter (terminal->display_info.x->display);
7108 #ifndef USE_GTK
7109 while (XPending (terminal->display_info.x->display))
7111 int finish;
7112 XEvent event;
7114 XNextEvent (terminal->display_info.x->display, &event);
7116 #ifdef HAVE_X_I18N
7117 /* Filter events for the current X input method. */
7118 if (x_filter_event (terminal->display_info.x, &event))
7119 continue;
7120 #endif
7121 event_found = 1;
7123 count += handle_one_xevent (terminal->display_info.x,
7124 &event, &finish, hold_quit);
7126 if (finish == X_EVENT_GOTO_OUT)
7127 goto out;
7130 out:;
7132 #else /* USE_GTK */
7134 /* For GTK we must use the GTK event loop. But XEvents gets passed
7135 to our filter function above, and then to the big event switch.
7136 We use a bunch of globals to communicate with our filter function,
7137 that is kind of ugly, but it works.
7139 There is no way to do one display at the time, GTK just does events
7140 from all displays. */
7142 while (gtk_events_pending ())
7144 current_count = count;
7145 current_hold_quit = hold_quit;
7147 gtk_main_iteration ();
7149 count = current_count;
7150 current_count = -1;
7151 current_hold_quit = 0;
7153 if (current_finish == X_EVENT_GOTO_OUT)
7154 break;
7156 #endif /* USE_GTK */
7158 /* On some systems, an X bug causes Emacs to get no more events
7159 when the window is destroyed. Detect that. (1994.) */
7160 if (! event_found)
7162 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7163 One XNOOP in 100 loops will make Emacs terminate.
7164 B. Bretthauer, 1994 */
7165 x_noop_count++;
7166 if (x_noop_count >= 100)
7168 x_noop_count=0;
7170 if (next_noop_dpyinfo == 0)
7171 next_noop_dpyinfo = x_display_list;
7173 XNoOp (next_noop_dpyinfo->display);
7175 /* Each time we get here, cycle through the displays now open. */
7176 next_noop_dpyinfo = next_noop_dpyinfo->next;
7180 /* If the focus was just given to an auto-raising frame,
7181 raise it now. */
7182 /* ??? This ought to be able to handle more than one such frame. */
7183 if (pending_autoraise_frame)
7185 x_raise_frame (pending_autoraise_frame);
7186 pending_autoraise_frame = 0;
7189 --handling_signal;
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 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 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7693 x_catching_errors (void)
7695 return x_error_message != 0;
7698 #if 0
7699 static unsigned int x_wire_count;
7700 x_trace_wire (void)
7702 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7704 #endif /* ! 0 */
7707 /* Handle SIGPIPE, which can happen when the connection to a server
7708 simply goes away. SIGPIPE is handled by x_connection_signal.
7709 Don't need to do anything, because the write which caused the
7710 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7711 which will do the appropriate cleanup for us. */
7713 static void
7714 x_connection_signal (int signalnum) /* If we don't have an argument, */
7715 /* some compilers complain in signal calls. */
7717 #ifdef USG
7718 /* USG systems forget handlers when they are used;
7719 must reestablish each time */
7720 signal (signalnum, x_connection_signal);
7721 #endif /* USG */
7725 /************************************************************************
7726 Handling X errors
7727 ************************************************************************/
7729 /* Error message passed to x_connection_closed. */
7731 static char *error_msg;
7733 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7734 the text of an error message that lead to the connection loss. */
7736 static void
7737 x_connection_closed (Display *dpy, const char *error_message)
7739 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7740 Lisp_Object frame, tail;
7741 int idx = SPECPDL_INDEX ();
7743 error_msg = (char *) alloca (strlen (error_message) + 1);
7744 strcpy (error_msg, error_message);
7745 handling_signal = 0;
7747 /* Inhibit redisplay while frames are being deleted. */
7748 specbind (Qinhibit_redisplay, Qt);
7750 if (dpyinfo)
7752 /* Protect display from being closed when we delete the last
7753 frame on it. */
7754 dpyinfo->reference_count++;
7755 dpyinfo->terminal->reference_count++;
7758 /* First delete frames whose mini-buffers are on frames
7759 that are on the dead display. */
7760 FOR_EACH_FRAME (tail, frame)
7762 Lisp_Object minibuf_frame;
7763 minibuf_frame
7764 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7765 if (FRAME_X_P (XFRAME (frame))
7766 && FRAME_X_P (XFRAME (minibuf_frame))
7767 && ! EQ (frame, minibuf_frame)
7768 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7769 delete_frame (frame, Qnoelisp);
7772 /* Now delete all remaining frames on the dead display.
7773 We are now sure none of these is used as the mini-buffer
7774 for another frame that we need to delete. */
7775 FOR_EACH_FRAME (tail, frame)
7776 if (FRAME_X_P (XFRAME (frame))
7777 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7779 /* Set this to t so that delete_frame won't get confused
7780 trying to find a replacement. */
7781 KVAR (FRAME_KBOARD (XFRAME (frame)), Vdefault_minibuffer_frame) = Qt;
7782 delete_frame (frame, Qnoelisp);
7785 /* If DPYINFO is null, this means we didn't open the display in the
7786 first place, so don't try to close it. */
7787 if (dpyinfo)
7789 /* We can not call XtCloseDisplay here because it calls XSync.
7790 XSync inside the error handler apparently hangs Emacs. On
7791 current Xt versions, this isn't needed either. */
7792 #ifdef USE_GTK
7793 /* A long-standing GTK bug prevents proper disconnect handling
7794 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7795 the resulting Glib error message loop filled a user's disk.
7796 To avoid this, kill Emacs unconditionally on disconnect. */
7797 shut_down_emacs (0, 0, Qnil);
7798 fprintf (stderr, "%s\n\
7799 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7800 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7801 For details, see etc/PROBLEMS.\n",
7802 error_msg);
7803 abort ();
7804 #endif /* USE_GTK */
7806 /* Indicate that this display is dead. */
7807 dpyinfo->display = 0;
7809 dpyinfo->reference_count--;
7810 dpyinfo->terminal->reference_count--;
7811 if (dpyinfo->reference_count != 0)
7812 /* We have just closed all frames on this display. */
7813 abort ();
7816 Lisp_Object tmp;
7817 XSETTERMINAL (tmp, dpyinfo->terminal);
7818 Fdelete_terminal (tmp, Qnoelisp);
7822 if (terminal_list == 0)
7824 fprintf (stderr, "%s\n", error_msg);
7825 Fkill_emacs (make_number (70));
7826 /* NOTREACHED */
7829 /* Ordinary stack unwind doesn't deal with these. */
7830 #ifdef SIGIO
7831 sigunblock (sigmask (SIGIO));
7832 #endif
7833 sigunblock (sigmask (SIGALRM));
7834 TOTALLY_UNBLOCK_INPUT;
7836 unbind_to (idx, Qnil);
7837 clear_waiting_for_input ();
7839 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
7840 IF_LINT (if (! terminal_list) return; )
7842 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7843 longjmp), because returning from this function would get us back into
7844 Xlib's code which will directly call `exit'. */
7845 error ("%s", error_msg);
7848 /* We specifically use it before defining it, so that gcc doesn't inline it,
7849 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7850 static void x_error_quitter (Display *, XErrorEvent *);
7852 /* This is the first-level handler for X protocol errors.
7853 It calls x_error_quitter or x_error_catcher. */
7855 static int
7856 x_error_handler (Display *display, XErrorEvent *event)
7858 if (x_error_message)
7859 x_error_catcher (display, event);
7860 else
7861 x_error_quitter (display, event);
7862 return 0;
7865 /* This is the usual handler for X protocol errors.
7866 It kills all frames on the display that we got the error for.
7867 If that was the only one, it prints an error message and kills Emacs. */
7869 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7871 /* On older GCC versions, just putting x_error_quitter
7872 after x_error_handler prevents inlining into the former. */
7874 static void NO_INLINE
7875 x_error_quitter (Display *display, XErrorEvent *event)
7877 char buf[256], buf1[356];
7879 /* Ignore BadName errors. They can happen because of fonts
7880 or colors that are not defined. */
7882 if (event->error_code == BadName)
7883 return;
7885 /* Note that there is no real way portable across R3/R4 to get the
7886 original error handler. */
7888 XGetErrorText (display, event->error_code, buf, sizeof (buf));
7889 sprintf (buf1, "X protocol error: %s on protocol request %d",
7890 buf, event->request_code);
7891 x_connection_closed (display, buf1);
7895 /* This is the handler for X IO errors, always.
7896 It kills all frames on the display that we lost touch with.
7897 If that was the only one, it prints an error message and kills Emacs. */
7899 static int
7900 x_io_error_quitter (Display *display)
7902 char buf[256];
7904 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
7905 x_connection_closed (display, buf);
7906 return 0;
7909 /* Changing the font of the frame. */
7911 /* Give frame F the font FONT-OBJECT as its default font. The return
7912 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7913 frame. If it is negative, generate a new fontset from
7914 FONT-OBJECT. */
7916 Lisp_Object
7917 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7919 struct font *font = XFONT_OBJECT (font_object);
7921 if (fontset < 0)
7922 fontset = fontset_from_font (font_object);
7923 FRAME_FONTSET (f) = fontset;
7924 if (FRAME_FONT (f) == font)
7925 /* This font is already set in frame F. There's nothing more to
7926 do. */
7927 return font_object;
7929 FRAME_FONT (f) = font;
7930 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7931 FRAME_COLUMN_WIDTH (f) = font->average_width;
7932 FRAME_SPACE_WIDTH (f) = font->space_width;
7933 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7935 compute_fringe_widths (f, 1);
7937 /* Compute the scroll bar width in character columns. */
7938 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7940 int wid = FRAME_COLUMN_WIDTH (f);
7941 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7942 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7944 else
7946 int wid = FRAME_COLUMN_WIDTH (f);
7947 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7950 if (FRAME_X_WINDOW (f) != 0)
7952 /* Don't change the size of a tip frame; there's no point in
7953 doing it because it's done in Fx_show_tip, and it leads to
7954 problems because the tip frame has no widget. */
7955 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7956 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7959 #ifdef HAVE_X_I18N
7960 if (FRAME_XIC (f)
7961 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7963 BLOCK_INPUT;
7964 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7965 UNBLOCK_INPUT;
7967 #endif
7969 return font_object;
7973 /***********************************************************************
7974 X Input Methods
7975 ***********************************************************************/
7977 #ifdef HAVE_X_I18N
7979 #ifdef HAVE_X11R6
7981 /* XIM destroy callback function, which is called whenever the
7982 connection to input method XIM dies. CLIENT_DATA contains a
7983 pointer to the x_display_info structure corresponding to XIM. */
7985 static void
7986 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7988 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7989 Lisp_Object frame, tail;
7991 BLOCK_INPUT;
7993 /* No need to call XDestroyIC.. */
7994 FOR_EACH_FRAME (tail, frame)
7996 struct frame *f = XFRAME (frame);
7997 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7999 FRAME_XIC (f) = NULL;
8000 xic_free_xfontset (f);
8004 /* No need to call XCloseIM. */
8005 dpyinfo->xim = NULL;
8006 XFree (dpyinfo->xim_styles);
8007 UNBLOCK_INPUT;
8010 #endif /* HAVE_X11R6 */
8012 #ifdef HAVE_X11R6
8013 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8014 extern char *XSetIMValues (XIM, ...);
8015 #endif
8017 /* Open the connection to the XIM server on display DPYINFO.
8018 RESOURCE_NAME is the resource name Emacs uses. */
8020 static void
8021 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
8023 XIM xim;
8025 #ifdef HAVE_XIM
8026 if (use_xim)
8028 if (dpyinfo->xim)
8029 XCloseIM (dpyinfo->xim);
8030 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8031 emacs_class);
8032 dpyinfo->xim = xim;
8034 if (xim)
8036 #ifdef HAVE_X11R6
8037 XIMCallback destroy;
8038 #endif
8040 /* Get supported styles and XIM values. */
8041 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8043 #ifdef HAVE_X11R6
8044 destroy.callback = xim_destroy_callback;
8045 destroy.client_data = (XPointer)dpyinfo;
8046 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8047 #endif
8051 else
8052 #endif /* HAVE_XIM */
8053 dpyinfo->xim = NULL;
8057 #ifdef HAVE_X11R6_XIM
8059 /* XIM instantiate callback function, which is called whenever an XIM
8060 server is available. DISPLAY is the display of the XIM.
8061 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8062 when the callback was registered. */
8064 static void
8065 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8067 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8068 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8070 /* We don't support multiple XIM connections. */
8071 if (dpyinfo->xim)
8072 return;
8074 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8076 /* Create XIC for the existing frames on the same display, as long
8077 as they have no XIC. */
8078 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8080 Lisp_Object tail, frame;
8082 BLOCK_INPUT;
8083 FOR_EACH_FRAME (tail, frame)
8085 struct frame *f = XFRAME (frame);
8087 if (FRAME_X_P (f)
8088 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8089 if (FRAME_XIC (f) == NULL)
8091 create_frame_xic (f);
8092 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8093 xic_set_statusarea (f);
8094 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8096 struct window *w = XWINDOW (f->selected_window);
8097 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8102 UNBLOCK_INPUT;
8106 #endif /* HAVE_X11R6_XIM */
8109 /* Open a connection to the XIM server on display DPYINFO.
8110 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8111 connection only at the first time. On X11R6, open the connection
8112 in the XIM instantiate callback function. */
8114 static void
8115 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8117 dpyinfo->xim = NULL;
8118 #ifdef HAVE_XIM
8119 if (use_xim)
8121 #ifdef HAVE_X11R6_XIM
8122 struct xim_inst_t *xim_inst;
8123 ptrdiff_t len;
8125 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8126 dpyinfo->xim_callback_data = xim_inst;
8127 xim_inst->dpyinfo = dpyinfo;
8128 len = strlen (resource_name);
8129 xim_inst->resource_name = (char *) xmalloc (len + 1);
8130 memcpy (xim_inst->resource_name, resource_name, len + 1);
8131 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8132 resource_name, emacs_class,
8133 xim_instantiate_callback,
8134 /* This is XPointer in XFree86
8135 but (XPointer *) on Tru64, at
8136 least, hence the configure test. */
8137 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8138 #else /* not HAVE_X11R6_XIM */
8139 xim_open_dpy (dpyinfo, resource_name);
8140 #endif /* not HAVE_X11R6_XIM */
8142 #endif /* HAVE_XIM */
8146 /* Close the connection to the XIM server on display DPYINFO. */
8148 static void
8149 xim_close_dpy (struct x_display_info *dpyinfo)
8151 #ifdef HAVE_XIM
8152 if (use_xim)
8154 #ifdef HAVE_X11R6_XIM
8155 if (dpyinfo->display)
8156 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8157 NULL, emacs_class,
8158 xim_instantiate_callback, NULL);
8159 xfree (dpyinfo->xim_callback_data->resource_name);
8160 xfree (dpyinfo->xim_callback_data);
8161 #endif /* HAVE_X11R6_XIM */
8162 if (dpyinfo->display)
8163 XCloseIM (dpyinfo->xim);
8164 dpyinfo->xim = NULL;
8165 XFree (dpyinfo->xim_styles);
8167 #endif /* HAVE_XIM */
8170 #endif /* not HAVE_X11R6_XIM */
8174 /* Calculate the absolute position in frame F
8175 from its current recorded position values and gravity. */
8177 static void
8178 x_calc_absolute_position (struct frame *f)
8180 int flags = f->size_hint_flags;
8182 /* We have nothing to do if the current position
8183 is already for the top-left corner. */
8184 if (! ((flags & XNegative) || (flags & YNegative)))
8185 return;
8187 /* Treat negative positions as relative to the leftmost bottommost
8188 position that fits on the screen. */
8189 if (flags & XNegative)
8190 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8191 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8194 int height = FRAME_PIXEL_HEIGHT (f);
8196 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8197 /* Something is fishy here. When using Motif, starting Emacs with
8198 `-g -0-0', the frame appears too low by a few pixels.
8200 This seems to be so because initially, while Emacs is starting,
8201 the column widget's height and the frame's pixel height are
8202 different. The column widget's height is the right one. In
8203 later invocations, when Emacs is up, the frame's pixel height
8204 is right, though.
8206 It's not obvious where the initial small difference comes from.
8207 2000-12-01, gerd. */
8209 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8210 #endif
8212 if (flags & YNegative)
8213 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8214 - height + f->top_pos;
8217 /* The left_pos and top_pos
8218 are now relative to the top and left screen edges,
8219 so the flags should correspond. */
8220 f->size_hint_flags &= ~ (XNegative | YNegative);
8223 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8224 to really change the position, and 0 when calling from
8225 x_make_frame_visible (in that case, XOFF and YOFF are the current
8226 position values). It is -1 when calling from x_set_frame_parameters,
8227 which means, do adjust for borders but don't change the gravity. */
8229 void
8230 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8232 int modified_top, modified_left;
8234 if (change_gravity > 0)
8236 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8237 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8239 f->top_pos = yoff;
8240 f->left_pos = xoff;
8241 f->size_hint_flags &= ~ (XNegative | YNegative);
8242 if (xoff < 0)
8243 f->size_hint_flags |= XNegative;
8244 if (yoff < 0)
8245 f->size_hint_flags |= YNegative;
8246 f->win_gravity = NorthWestGravity;
8248 x_calc_absolute_position (f);
8250 BLOCK_INPUT;
8251 x_wm_set_size_hint (f, (long) 0, 0);
8253 modified_left = f->left_pos;
8254 modified_top = f->top_pos;
8256 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8258 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8259 than the WM decorations. So we use the calculated offset instead
8260 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8261 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8262 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8265 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8266 modified_left, modified_top);
8268 x_sync_with_move (f, f->left_pos, f->top_pos,
8269 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8270 ? 1 : 0);
8272 /* change_gravity is non-zero when this function is called from Lisp to
8273 programmatically move a frame. In that case, we call
8274 x_check_expected_move to discover if we have a "Type A" or "Type B"
8275 window manager, and, for a "Type A" window manager, adjust the position
8276 of the frame.
8278 We call x_check_expected_move if a programmatic move occurred, and
8279 either the window manager type (A/B) is unknown or it is Type A but we
8280 need to compute the top/left offset adjustment for this frame. */
8282 if (change_gravity != 0 &&
8283 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8284 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8285 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8286 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8287 x_check_expected_move (f, modified_left, modified_top);
8289 UNBLOCK_INPUT;
8292 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8293 on the root window for frame F contains ATOMNAME.
8294 This is how a WM check shall be done according to the Window Manager
8295 Specification/Extended Window Manager Hints at
8296 http://freedesktop.org/wiki/Specifications/wm-spec. */
8298 static int
8299 wm_supports (struct frame *f, Atom want_atom)
8301 Atom actual_type;
8302 unsigned long actual_size, bytes_remaining;
8303 int i, rc, actual_format;
8304 Window wmcheck_window;
8305 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8306 Window target_window = dpyinfo->root_window;
8307 long max_len = 65536;
8308 Display *dpy = FRAME_X_DISPLAY (f);
8309 unsigned char *tmp_data = NULL;
8310 Atom target_type = XA_WINDOW;
8312 BLOCK_INPUT;
8314 x_catch_errors (dpy);
8315 rc = XGetWindowProperty (dpy, target_window,
8316 dpyinfo->Xatom_net_supporting_wm_check,
8317 0, max_len, False, target_type,
8318 &actual_type, &actual_format, &actual_size,
8319 &bytes_remaining, &tmp_data);
8321 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8323 if (tmp_data) XFree (tmp_data);
8324 x_uncatch_errors ();
8325 UNBLOCK_INPUT;
8326 return 0;
8329 wmcheck_window = *(Window *) tmp_data;
8330 XFree (tmp_data);
8332 /* Check if window exists. */
8333 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8334 x_sync (f);
8335 if (x_had_errors_p (dpy))
8337 x_uncatch_errors ();
8338 UNBLOCK_INPUT;
8339 return 0;
8342 if (dpyinfo->net_supported_window != wmcheck_window)
8344 /* Window changed, reload atoms */
8345 if (dpyinfo->net_supported_atoms != NULL)
8346 XFree (dpyinfo->net_supported_atoms);
8347 dpyinfo->net_supported_atoms = NULL;
8348 dpyinfo->nr_net_supported_atoms = 0;
8349 dpyinfo->net_supported_window = 0;
8351 target_type = XA_ATOM;
8352 tmp_data = NULL;
8353 rc = XGetWindowProperty (dpy, target_window,
8354 dpyinfo->Xatom_net_supported,
8355 0, max_len, False, target_type,
8356 &actual_type, &actual_format, &actual_size,
8357 &bytes_remaining, &tmp_data);
8359 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8361 if (tmp_data) XFree (tmp_data);
8362 x_uncatch_errors ();
8363 UNBLOCK_INPUT;
8364 return 0;
8367 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8368 dpyinfo->nr_net_supported_atoms = actual_size;
8369 dpyinfo->net_supported_window = wmcheck_window;
8372 rc = 0;
8374 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8375 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8377 x_uncatch_errors ();
8378 UNBLOCK_INPUT;
8380 return rc;
8383 static void
8384 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8386 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8388 x_send_client_event (frame, make_number (0), frame,
8389 dpyinfo->Xatom_net_wm_state,
8390 make_number (32),
8391 /* 1 = add, 0 = remove */
8392 Fcons
8393 (make_number (add ? 1 : 0),
8394 Fcons
8395 (make_fixnum_or_float (atom),
8396 value != 0
8397 ? Fcons (make_fixnum_or_float (value), Qnil)
8398 : Qnil)));
8401 void
8402 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8404 Lisp_Object frame;
8405 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8407 XSETFRAME (frame, f);
8409 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8410 dpyinfo->Xatom_net_wm_state_sticky, None);
8413 /* Return the current _NET_WM_STATE.
8414 SIZE_STATE is set to one of the FULLSCREEN_* values.
8415 STICKY is set to 1 if the sticky state is set, 0 if not. */
8417 static void
8418 get_current_wm_state (struct frame *f,
8419 Window window,
8420 int *size_state,
8421 int *sticky)
8423 Atom actual_type;
8424 unsigned long actual_size, bytes_remaining;
8425 int i, rc, actual_format;
8426 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8427 long max_len = 65536;
8428 Display *dpy = FRAME_X_DISPLAY (f);
8429 unsigned char *tmp_data = NULL;
8430 Atom target_type = XA_ATOM;
8432 *sticky = 0;
8433 *size_state = FULLSCREEN_NONE;
8435 BLOCK_INPUT;
8436 x_catch_errors (dpy);
8437 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8438 0, max_len, False, target_type,
8439 &actual_type, &actual_format, &actual_size,
8440 &bytes_remaining, &tmp_data);
8442 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8444 if (tmp_data) XFree (tmp_data);
8445 x_uncatch_errors ();
8446 UNBLOCK_INPUT;
8447 return;
8450 x_uncatch_errors ();
8452 for (i = 0; i < actual_size; ++i)
8454 Atom a = ((Atom*)tmp_data)[i];
8455 if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8457 if (*size_state == FULLSCREEN_HEIGHT)
8458 *size_state = FULLSCREEN_MAXIMIZED;
8459 else
8460 *size_state = FULLSCREEN_WIDTH;
8462 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8464 if (*size_state == FULLSCREEN_WIDTH)
8465 *size_state = FULLSCREEN_MAXIMIZED;
8466 else
8467 *size_state = FULLSCREEN_HEIGHT;
8469 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8470 *size_state = FULLSCREEN_BOTH;
8471 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8472 *sticky = 1;
8475 if (tmp_data) XFree (tmp_data);
8476 UNBLOCK_INPUT;
8479 /* Do fullscreen as specified in extended window manager hints */
8481 static int
8482 do_ewmh_fullscreen (struct frame *f)
8484 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8485 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8486 int cur, dummy;
8488 get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8490 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8491 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8492 if (!have_net_atom)
8493 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8495 if (have_net_atom && cur != f->want_fullscreen)
8497 Lisp_Object frame;
8499 XSETFRAME (frame, f);
8501 /* Keep number of calls to set_wm_state as low as possible.
8502 Some window managers, or possible Gtk+, hangs when too many
8503 are sent at once. */
8504 switch (f->want_fullscreen)
8506 case FULLSCREEN_BOTH:
8507 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8508 || cur == FULLSCREEN_HEIGHT)
8509 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8510 dpyinfo->Xatom_net_wm_state_maximized_vert);
8511 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8512 break;
8513 case FULLSCREEN_WIDTH:
8514 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8515 || cur == FULLSCREEN_MAXIMIZED)
8516 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8517 dpyinfo->Xatom_net_wm_state_maximized_vert);
8518 if (cur != FULLSCREEN_MAXIMIZED)
8519 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8520 break;
8521 case FULLSCREEN_HEIGHT:
8522 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8523 || cur == FULLSCREEN_MAXIMIZED)
8524 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8525 dpyinfo->Xatom_net_wm_state_maximized_horz);
8526 if (cur != FULLSCREEN_MAXIMIZED)
8527 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8528 break;
8529 case FULLSCREEN_MAXIMIZED:
8530 if (cur == FULLSCREEN_BOTH)
8531 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8532 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8533 dpyinfo->Xatom_net_wm_state_maximized_vert);
8534 break;
8535 case FULLSCREEN_NONE:
8536 if (cur == FULLSCREEN_BOTH)
8537 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8538 else
8539 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8540 dpyinfo->Xatom_net_wm_state_maximized_vert);
8543 f->want_fullscreen = FULLSCREEN_NONE;
8547 return have_net_atom;
8550 static void
8551 XTfullscreen_hook (FRAME_PTR f)
8553 if (f->async_visible)
8555 BLOCK_INPUT;
8556 x_check_fullscreen (f);
8557 x_sync (f);
8558 UNBLOCK_INPUT;
8563 static void
8564 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8566 int value = FULLSCREEN_NONE;
8567 Lisp_Object lval;
8568 int sticky = 0;
8570 get_current_wm_state (f, event->window, &value, &sticky);
8571 lval = Qnil;
8572 switch (value)
8574 case FULLSCREEN_WIDTH:
8575 lval = Qfullwidth;
8576 break;
8577 case FULLSCREEN_HEIGHT:
8578 lval = Qfullheight;
8579 break;
8580 case FULLSCREEN_BOTH:
8581 lval = Qfullboth;
8582 break;
8583 case FULLSCREEN_MAXIMIZED:
8584 lval = Qmaximized;
8585 break;
8588 store_frame_param (f, Qfullscreen, lval);
8589 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8592 /* Check if we need to resize the frame due to a fullscreen request.
8593 If so needed, resize the frame. */
8594 static void
8595 x_check_fullscreen (struct frame *f)
8597 if (do_ewmh_fullscreen (f))
8598 return;
8600 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8601 return; /* Only fullscreen without WM or with EWM hints (above). */
8603 /* Setting fullscreen to nil doesn't do anything. We could save the
8604 last non-fullscreen size and restore it, but it seems like a
8605 lot of work for this unusual case (no window manager running). */
8607 if (f->want_fullscreen != FULLSCREEN_NONE)
8609 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8610 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8612 switch (f->want_fullscreen)
8614 /* No difference between these two when there is no WM */
8615 case FULLSCREEN_BOTH:
8616 case FULLSCREEN_MAXIMIZED:
8617 width = x_display_pixel_width (dpyinfo);
8618 height = x_display_pixel_height (dpyinfo);
8619 break;
8620 case FULLSCREEN_WIDTH:
8621 width = x_display_pixel_width (dpyinfo);
8622 break;
8623 case FULLSCREEN_HEIGHT:
8624 height = x_display_pixel_height (dpyinfo);
8627 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8628 width, height);
8632 /* This function is called by x_set_offset to determine whether the window
8633 manager interfered with the positioning of the frame. Type A window
8634 managers position the surrounding window manager decorations a small
8635 amount above and left of the user-supplied position. Type B window
8636 managers position the surrounding window manager decorations at the
8637 user-specified position. If we detect a Type A window manager, we
8638 compensate by moving the window right and down by the proper amount. */
8640 static void
8641 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8643 int current_left = 0, current_top = 0;
8645 /* x_real_positions returns the left and top offsets of the outermost
8646 window manager window around the frame. */
8648 x_real_positions (f, &current_left, &current_top);
8650 if (current_left != expected_left || current_top != expected_top)
8652 /* It's a "Type A" window manager. */
8654 int adjusted_left;
8655 int adjusted_top;
8657 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8658 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8659 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8661 /* Now fix the mispositioned frame's location. */
8663 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8664 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8666 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8667 adjusted_left, adjusted_top);
8669 x_sync_with_move (f, expected_left, expected_top, 0);
8671 else
8672 /* It's a "Type B" window manager. We don't have to adjust the
8673 frame's position. */
8675 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8679 /* Wait for XGetGeometry to return up-to-date position information for a
8680 recently-moved frame. Call this immediately after calling XMoveWindow.
8681 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8682 frame has been moved to, so we use a fuzzy position comparison instead
8683 of an exact comparison. */
8685 static void
8686 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8688 int count = 0;
8690 while (count++ < 50)
8692 int current_left = 0, current_top = 0;
8694 /* In theory, this call to XSync only needs to happen once, but in
8695 practice, it doesn't seem to work, hence the need for the surrounding
8696 loop. */
8698 XSync (FRAME_X_DISPLAY (f), False);
8699 x_real_positions (f, &current_left, &current_top);
8701 if (fuzzy)
8703 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8704 pixels. */
8706 if (eabs (current_left - left) <= 10
8707 && eabs (current_top - top) <= 40)
8708 return;
8710 else if (current_left == left && current_top == top)
8711 return;
8714 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8715 will then return up-to-date position info. */
8717 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8721 /* Wait for an event on frame F matching EVENTTYPE. */
8722 void
8723 x_wait_for_event (struct frame *f, int eventtype)
8725 int level = interrupt_input_blocked;
8727 SELECT_TYPE fds;
8728 EMACS_TIME tmo, tmo_at, time_now;
8729 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8731 pending_event_wait.f = f;
8732 pending_event_wait.eventtype = eventtype;
8734 /* Set timeout to 0.1 second. Hopefully not noticable.
8735 Maybe it should be configurable. */
8736 EMACS_SET_SECS_USECS (tmo, 0, 100000);
8737 EMACS_GET_TIME (tmo_at);
8738 EMACS_ADD_TIME (tmo_at, tmo_at, tmo);
8740 while (pending_event_wait.eventtype)
8742 interrupt_input_pending = 1;
8743 TOTALLY_UNBLOCK_INPUT;
8744 /* XTread_socket is called after unblock. */
8745 BLOCK_INPUT;
8746 interrupt_input_blocked = level;
8748 FD_ZERO (&fds);
8749 FD_SET (fd, &fds);
8751 EMACS_GET_TIME (time_now);
8752 EMACS_SUB_TIME (tmo, tmo_at, time_now);
8754 if (EMACS_TIME_NEG_P (tmo) || select (fd+1, &fds, NULL, NULL, &tmo) == 0)
8755 break; /* Timeout */
8757 pending_event_wait.f = 0;
8758 pending_event_wait.eventtype = 0;
8762 /* Change the size of frame F's X window to COLS/ROWS in the case F
8763 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8764 top-left-corner window gravity for this size change and subsequent
8765 size changes. Otherwise we leave the window gravity unchanged. */
8767 static void
8768 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8770 int pixelwidth, pixelheight;
8772 check_frame_size (f, &rows, &cols);
8773 f->scroll_bar_actual_width
8774 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8776 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8778 compute_fringe_widths (f, 0);
8780 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8781 + FRAME_TOOLBAR_WIDTH (f);
8782 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8783 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8785 if (change_gravity) f->win_gravity = NorthWestGravity;
8786 x_wm_set_size_hint (f, (long) 0, 0);
8787 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8788 pixelwidth, pixelheight);
8791 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8792 receive in the ConfigureNotify event; if we get what we asked
8793 for, then the event won't cause the screen to become garbaged, so
8794 we have to make sure to do it here. */
8795 SET_FRAME_GARBAGED (f);
8797 /* Now, strictly speaking, we can't be sure that this is accurate,
8798 but the window manager will get around to dealing with the size
8799 change request eventually, and we'll hear how it went when the
8800 ConfigureNotify event gets here.
8802 We could just not bother storing any of this information here,
8803 and let the ConfigureNotify event set everything up, but that
8804 might be kind of confusing to the Lisp code, since size changes
8805 wouldn't be reported in the frame parameters until some random
8806 point in the future when the ConfigureNotify event arrives.
8808 We pass 1 for DELAY since we can't run Lisp code inside of
8809 a BLOCK_INPUT. */
8811 /* But the ConfigureNotify may in fact never arrive, and then this is
8812 not right if the frame is visible. Instead wait (with timeout)
8813 for the ConfigureNotify. */
8814 if (f->async_visible)
8815 x_wait_for_event (f, ConfigureNotify);
8816 else
8818 change_frame_size (f, rows, cols, 0, 1, 0);
8819 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8820 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8821 x_sync (f);
8826 /* Call this to change the size of frame F's x-window.
8827 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8828 for this size change and subsequent size changes.
8829 Otherwise we leave the window gravity unchanged. */
8831 void
8832 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8834 BLOCK_INPUT;
8836 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8838 int r, c;
8840 /* When the frame is maximized/fullscreen or running under for
8841 example Xmonad, x_set_window_size_1 will be a no-op.
8842 In that case, the right thing to do is extend rows/cols to
8843 the current frame size. We do that first if x_set_window_size_1
8844 turns out to not be a no-op (there is no way to know).
8845 The size will be adjusted again if the frame gets a
8846 ConfigureNotify event as a result of x_set_window_size. */
8847 int pixelh = FRAME_PIXEL_HEIGHT (f);
8848 #ifdef USE_X_TOOLKIT
8849 /* The menu bar is not part of text lines. The tool bar
8850 is however. */
8851 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8852 #endif
8853 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8854 /* Update f->scroll_bar_actual_width because it is used in
8855 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8856 f->scroll_bar_actual_width
8857 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8858 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8859 change_frame_size (f, r, c, 0, 1, 0);
8862 #ifdef USE_GTK
8863 if (FRAME_GTK_WIDGET (f))
8864 xg_frame_set_char_size (f, cols, rows);
8865 else
8866 x_set_window_size_1 (f, change_gravity, cols, rows);
8867 #else /* not USE_GTK */
8869 x_set_window_size_1 (f, change_gravity, cols, rows);
8871 #endif /* not USE_GTK */
8873 /* If cursor was outside the new size, mark it as off. */
8874 mark_window_cursors_off (XWINDOW (f->root_window));
8876 /* Clear out any recollection of where the mouse highlighting was,
8877 since it might be in a place that's outside the new frame size.
8878 Actually checking whether it is outside is a pain in the neck,
8879 so don't try--just let the highlighting be done afresh with new size. */
8880 cancel_mouse_face (f);
8882 UNBLOCK_INPUT;
8885 /* Mouse warping. */
8887 void
8888 x_set_mouse_position (struct frame *f, int x, int y)
8890 int pix_x, pix_y;
8892 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8893 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8895 if (pix_x < 0) pix_x = 0;
8896 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8898 if (pix_y < 0) pix_y = 0;
8899 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8901 BLOCK_INPUT;
8903 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8904 0, 0, 0, 0, pix_x, pix_y);
8905 UNBLOCK_INPUT;
8908 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8910 void
8911 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8913 BLOCK_INPUT;
8915 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8916 0, 0, 0, 0, pix_x, pix_y);
8917 UNBLOCK_INPUT;
8920 /* Raise frame F. */
8922 void
8923 x_raise_frame (struct frame *f)
8925 BLOCK_INPUT;
8926 if (f->async_visible)
8927 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8929 XFlush (FRAME_X_DISPLAY (f));
8930 UNBLOCK_INPUT;
8933 /* Lower frame F. */
8935 static void
8936 x_lower_frame (struct frame *f)
8938 if (f->async_visible)
8940 BLOCK_INPUT;
8941 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8942 XFlush (FRAME_X_DISPLAY (f));
8943 UNBLOCK_INPUT;
8947 /* Activate frame with Extended Window Manager Hints */
8949 void
8950 x_ewmh_activate_frame (FRAME_PTR f)
8952 /* See Window Manager Specification/Extended Window Manager Hints at
8953 http://freedesktop.org/wiki/Specifications/wm-spec */
8955 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8956 if (f->async_visible && wm_supports (f, dpyinfo->Xatom_net_active_window))
8958 Lisp_Object frame;
8959 XSETFRAME (frame, f);
8960 x_send_client_event (frame, make_number (0), frame,
8961 dpyinfo->Xatom_net_active_window,
8962 make_number (32),
8963 Fcons (make_number (1),
8964 Fcons (make_number (last_user_time),
8965 Qnil)));
8969 static void
8970 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
8972 if (raise_flag)
8973 x_raise_frame (f);
8974 else
8975 x_lower_frame (f);
8978 /* XEmbed implementation. */
8980 #if defined USE_X_TOOLKIT || ! defined USE_GTK
8982 /* XEmbed implementation. */
8984 #define XEMBED_VERSION 0
8986 static void
8987 xembed_set_info (struct frame *f, enum xembed_info flags)
8989 unsigned long data[2];
8990 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8992 data[0] = XEMBED_VERSION;
8993 data[1] = flags;
8995 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8996 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
8997 32, PropModeReplace, (unsigned char *) data, 2);
8999 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
9001 static void
9002 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
9003 long int detail, long int data1, long int data2)
9005 XEvent event;
9007 event.xclient.type = ClientMessage;
9008 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9009 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9010 event.xclient.format = 32;
9011 event.xclient.data.l[0] = t;
9012 event.xclient.data.l[1] = msg;
9013 event.xclient.data.l[2] = detail;
9014 event.xclient.data.l[3] = data1;
9015 event.xclient.data.l[4] = data2;
9017 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9018 False, NoEventMask, &event);
9019 XSync (FRAME_X_DISPLAY (f), False);
9022 /* Change of visibility. */
9024 /* This tries to wait until the frame is really visible.
9025 However, if the window manager asks the user where to position
9026 the frame, this will return before the user finishes doing that.
9027 The frame will not actually be visible at that time,
9028 but it will become visible later when the window manager
9029 finishes with it. */
9031 void
9032 x_make_frame_visible (struct frame *f)
9034 Lisp_Object type;
9035 int original_top, original_left;
9036 int retry_count = 2;
9038 retry:
9040 BLOCK_INPUT;
9042 type = x_icon_type (f);
9043 if (!NILP (type))
9044 x_bitmap_icon (f, type);
9046 if (! FRAME_VISIBLE_P (f))
9048 /* We test FRAME_GARBAGED_P here to make sure we don't
9049 call x_set_offset a second time
9050 if we get to x_make_frame_visible a second time
9051 before the window gets really visible. */
9052 if (! FRAME_ICONIFIED_P (f)
9053 && ! FRAME_X_EMBEDDED_P (f)
9054 && ! f->output_data.x->asked_for_visible)
9055 x_set_offset (f, f->left_pos, f->top_pos, 0);
9057 f->output_data.x->asked_for_visible = 1;
9059 if (! EQ (Vx_no_window_manager, Qt))
9060 x_wm_set_window_state (f, NormalState);
9061 #ifdef USE_X_TOOLKIT
9062 if (FRAME_X_EMBEDDED_P (f))
9063 xembed_set_info (f, XEMBED_MAPPED);
9064 else
9066 /* This was XtPopup, but that did nothing for an iconified frame. */
9067 XtMapWidget (f->output_data.x->widget);
9069 #else /* not USE_X_TOOLKIT */
9070 #ifdef USE_GTK
9071 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9072 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9073 #else
9074 if (FRAME_X_EMBEDDED_P (f))
9075 xembed_set_info (f, XEMBED_MAPPED);
9076 else
9077 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9078 #endif /* not USE_GTK */
9079 #endif /* not USE_X_TOOLKIT */
9082 XFlush (FRAME_X_DISPLAY (f));
9084 /* Synchronize to ensure Emacs knows the frame is visible
9085 before we do anything else. We do this loop with input not blocked
9086 so that incoming events are handled. */
9088 Lisp_Object frame;
9089 int count;
9090 /* This must be before UNBLOCK_INPUT
9091 since events that arrive in response to the actions above
9092 will set it when they are handled. */
9093 int previously_visible = f->output_data.x->has_been_visible;
9095 original_left = f->left_pos;
9096 original_top = f->top_pos;
9098 /* This must come after we set COUNT. */
9099 UNBLOCK_INPUT;
9101 /* We unblock here so that arriving X events are processed. */
9103 /* Now move the window back to where it was "supposed to be".
9104 But don't do it if the gravity is negative.
9105 When the gravity is negative, this uses a position
9106 that is 3 pixels too low. Perhaps that's really the border width.
9108 Don't do this if the window has never been visible before,
9109 because the window manager may choose the position
9110 and we don't want to override it. */
9112 if (! FRAME_VISIBLE_P (f)
9113 && ! FRAME_ICONIFIED_P (f)
9114 && ! FRAME_X_EMBEDDED_P (f)
9115 && f->win_gravity == NorthWestGravity
9116 && previously_visible)
9118 Drawable rootw;
9119 int x, y;
9120 unsigned int width, height, border, depth;
9122 BLOCK_INPUT;
9124 /* On some window managers (such as FVWM) moving an existing
9125 window, even to the same place, causes the window manager
9126 to introduce an offset. This can cause the window to move
9127 to an unexpected location. Check the geometry (a little
9128 slow here) and then verify that the window is in the right
9129 place. If the window is not in the right place, move it
9130 there, and take the potential window manager hit. */
9131 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9132 &rootw, &x, &y, &width, &height, &border, &depth);
9134 if (original_left != x || original_top != y)
9135 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9136 original_left, original_top);
9138 UNBLOCK_INPUT;
9141 XSETFRAME (frame, f);
9143 /* Wait until the frame is visible. Process X events until a
9144 MapNotify event has been seen, or until we think we won't get a
9145 MapNotify at all.. */
9146 for (count = input_signal_count + 10;
9147 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9149 /* Force processing of queued events. */
9150 x_sync (f);
9152 /* Machines that do polling rather than SIGIO have been
9153 observed to go into a busy-wait here. So we'll fake an
9154 alarm signal to let the handler know that there's something
9155 to be read. We used to raise a real alarm, but it seems
9156 that the handler isn't always enabled here. This is
9157 probably a bug. */
9158 if (input_polling_used ())
9160 /* It could be confusing if a real alarm arrives while
9161 processing the fake one. Turn it off and let the
9162 handler reset it. */
9163 int old_poll_suppress_count = poll_suppress_count;
9164 poll_suppress_count = 1;
9165 poll_for_input_1 ();
9166 poll_suppress_count = old_poll_suppress_count;
9169 /* See if a MapNotify event has been processed. */
9170 FRAME_SAMPLE_VISIBILITY (f);
9173 /* 2000-09-28: In
9175 (let ((f (selected-frame)))
9176 (iconify-frame f)
9177 (raise-frame f))
9179 the frame is not raised with various window managers on
9180 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9181 unknown reason, the call to XtMapWidget is completely ignored.
9182 Mapping the widget a second time works. */
9184 if (!FRAME_VISIBLE_P (f) && --retry_count != 0)
9185 goto retry;
9189 /* Change from mapped state to withdrawn state. */
9191 /* Make the frame visible (mapped and not iconified). */
9193 void
9194 x_make_frame_invisible (struct frame *f)
9196 Window window;
9198 /* Use the frame's outermost window, not the one we normally draw on. */
9199 window = FRAME_OUTER_WINDOW (f);
9201 /* Don't keep the highlight on an invisible frame. */
9202 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9203 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9205 BLOCK_INPUT;
9207 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9208 that the current position of the window is user-specified, rather than
9209 program-specified, so that when the window is mapped again, it will be
9210 placed at the same location, without forcing the user to position it
9211 by hand again (they have already done that once for this window.) */
9212 x_wm_set_size_hint (f, (long) 0, 1);
9214 #ifdef USE_GTK
9215 if (FRAME_GTK_OUTER_WIDGET (f))
9216 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9217 else
9218 #else
9219 if (FRAME_X_EMBEDDED_P (f))
9220 xembed_set_info (f, 0);
9221 else
9222 #endif
9225 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9226 DefaultScreen (FRAME_X_DISPLAY (f))))
9228 UNBLOCK_INPUT_RESIGNAL;
9229 error ("Can't notify window manager of window withdrawal");
9233 /* We can't distinguish this from iconification
9234 just by the event that we get from the server.
9235 So we can't win using the usual strategy of letting
9236 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9237 and synchronize with the server to make sure we agree. */
9238 f->visible = 0;
9239 FRAME_ICONIFIED_P (f) = 0;
9240 f->async_visible = 0;
9241 f->async_iconified = 0;
9243 x_sync (f);
9245 UNBLOCK_INPUT;
9248 /* Change window state from mapped to iconified. */
9250 void
9251 x_iconify_frame (struct frame *f)
9253 #ifdef USE_X_TOOLKIT
9254 int result;
9255 #endif
9256 Lisp_Object type;
9258 /* Don't keep the highlight on an invisible frame. */
9259 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9260 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9262 if (f->async_iconified)
9263 return;
9265 BLOCK_INPUT;
9267 FRAME_SAMPLE_VISIBILITY (f);
9269 type = x_icon_type (f);
9270 if (!NILP (type))
9271 x_bitmap_icon (f, type);
9273 #ifdef USE_GTK
9274 if (FRAME_GTK_OUTER_WIDGET (f))
9276 if (! FRAME_VISIBLE_P (f))
9277 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9279 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9280 f->iconified = 1;
9281 f->visible = 1;
9282 f->async_iconified = 1;
9283 f->async_visible = 0;
9284 UNBLOCK_INPUT;
9285 return;
9287 #endif
9289 #ifdef USE_X_TOOLKIT
9291 if (! FRAME_VISIBLE_P (f))
9293 if (! EQ (Vx_no_window_manager, Qt))
9294 x_wm_set_window_state (f, IconicState);
9295 /* This was XtPopup, but that did nothing for an iconified frame. */
9296 XtMapWidget (f->output_data.x->widget);
9297 /* The server won't give us any event to indicate
9298 that an invisible frame was changed to an icon,
9299 so we have to record it here. */
9300 f->iconified = 1;
9301 f->visible = 1;
9302 f->async_iconified = 1;
9303 f->async_visible = 0;
9304 UNBLOCK_INPUT;
9305 return;
9308 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9309 XtWindow (f->output_data.x->widget),
9310 DefaultScreen (FRAME_X_DISPLAY (f)));
9311 UNBLOCK_INPUT;
9313 if (!result)
9314 error ("Can't notify window manager of iconification");
9316 f->async_iconified = 1;
9317 f->async_visible = 0;
9320 BLOCK_INPUT;
9321 XFlush (FRAME_X_DISPLAY (f));
9322 UNBLOCK_INPUT;
9323 #else /* not USE_X_TOOLKIT */
9325 /* Make sure the X server knows where the window should be positioned,
9326 in case the user deiconifies with the window manager. */
9327 if (! FRAME_VISIBLE_P (f)
9328 && ! FRAME_ICONIFIED_P (f)
9329 && ! FRAME_X_EMBEDDED_P (f))
9330 x_set_offset (f, f->left_pos, f->top_pos, 0);
9332 /* Since we don't know which revision of X we're running, we'll use both
9333 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9335 /* X11R4: send a ClientMessage to the window manager using the
9336 WM_CHANGE_STATE type. */
9338 XEvent msg;
9340 msg.xclient.window = FRAME_X_WINDOW (f);
9341 msg.xclient.type = ClientMessage;
9342 msg.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9343 msg.xclient.format = 32;
9344 msg.xclient.data.l[0] = IconicState;
9346 if (! XSendEvent (FRAME_X_DISPLAY (f),
9347 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9348 False,
9349 SubstructureRedirectMask | SubstructureNotifyMask,
9350 &msg))
9352 UNBLOCK_INPUT_RESIGNAL;
9353 error ("Can't notify window manager of iconification");
9357 /* X11R3: set the initial_state field of the window manager hints to
9358 IconicState. */
9359 x_wm_set_window_state (f, IconicState);
9361 if (!FRAME_VISIBLE_P (f))
9363 /* If the frame was withdrawn, before, we must map it. */
9364 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9367 f->async_iconified = 1;
9368 f->async_visible = 0;
9370 XFlush (FRAME_X_DISPLAY (f));
9371 UNBLOCK_INPUT;
9372 #endif /* not USE_X_TOOLKIT */
9376 /* Free X resources of frame F. */
9378 void
9379 x_free_frame_resources (struct frame *f)
9381 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9382 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9383 #ifdef USE_X_TOOLKIT
9384 Lisp_Object bar;
9385 struct scroll_bar *b;
9386 #endif
9388 BLOCK_INPUT;
9390 /* If a display connection is dead, don't try sending more
9391 commands to the X server. */
9392 if (dpyinfo->display)
9394 /* We must free faces before destroying windows because some
9395 font-driver (e.g. xft) access a window while finishing a
9396 face. */
9397 if (FRAME_FACE_CACHE (f))
9398 free_frame_faces (f);
9400 if (f->output_data.x->icon_desc)
9401 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9403 #ifdef USE_X_TOOLKIT
9404 /* Explicitly destroy the scroll bars of the frame. Without
9405 this, we get "BadDrawable" errors from the toolkit later on,
9406 presumably from expose events generated for the disappearing
9407 toolkit scroll bars. */
9408 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9410 b = XSCROLL_BAR (bar);
9411 x_scroll_bar_remove (b);
9413 #endif
9415 #ifdef HAVE_X_I18N
9416 if (FRAME_XIC (f))
9417 free_frame_xic (f);
9418 #endif
9420 #ifdef USE_X_TOOLKIT
9421 if (f->output_data.x->widget)
9423 XtDestroyWidget (f->output_data.x->widget);
9424 f->output_data.x->widget = NULL;
9426 /* Tooltips don't have widgets, only a simple X window, even if
9427 we are using a toolkit. */
9428 else if (FRAME_X_WINDOW (f))
9429 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9431 free_frame_menubar (f);
9432 #else /* !USE_X_TOOLKIT */
9434 #ifdef USE_GTK
9435 xg_free_frame_widgets (f);
9436 #endif /* USE_GTK */
9438 if (FRAME_X_WINDOW (f))
9439 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9440 #endif /* !USE_X_TOOLKIT */
9442 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9443 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9444 unload_color (f, f->output_data.x->cursor_pixel);
9445 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9446 unload_color (f, f->output_data.x->border_pixel);
9447 unload_color (f, f->output_data.x->mouse_pixel);
9449 if (f->output_data.x->scroll_bar_background_pixel != -1)
9450 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9451 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9452 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9453 #ifdef USE_TOOLKIT_SCROLL_BARS
9454 /* Scrollbar shadow colors. */
9455 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9456 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9457 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9458 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9459 #endif /* USE_TOOLKIT_SCROLL_BARS */
9460 if (f->output_data.x->white_relief.allocated_p)
9461 unload_color (f, f->output_data.x->white_relief.pixel);
9462 if (f->output_data.x->black_relief.allocated_p)
9463 unload_color (f, f->output_data.x->black_relief.pixel);
9465 x_free_gcs (f);
9466 XFlush (FRAME_X_DISPLAY (f));
9469 xfree (f->output_data.x->saved_menu_event);
9470 xfree (f->output_data.x);
9471 f->output_data.x = NULL;
9473 if (f == dpyinfo->x_focus_frame)
9474 dpyinfo->x_focus_frame = 0;
9475 if (f == dpyinfo->x_focus_event_frame)
9476 dpyinfo->x_focus_event_frame = 0;
9477 if (f == dpyinfo->x_highlight_frame)
9478 dpyinfo->x_highlight_frame = 0;
9480 if (f == hlinfo->mouse_face_mouse_frame)
9482 hlinfo->mouse_face_beg_row
9483 = hlinfo->mouse_face_beg_col = -1;
9484 hlinfo->mouse_face_end_row
9485 = hlinfo->mouse_face_end_col = -1;
9486 hlinfo->mouse_face_window = Qnil;
9487 hlinfo->mouse_face_deferred_gc = 0;
9488 hlinfo->mouse_face_mouse_frame = 0;
9491 UNBLOCK_INPUT;
9495 /* Destroy the X window of frame F. */
9497 static void
9498 x_destroy_window (struct frame *f)
9500 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9502 /* If a display connection is dead, don't try sending more
9503 commands to the X server. */
9504 if (dpyinfo->display != 0)
9505 x_free_frame_resources (f);
9507 dpyinfo->reference_count--;
9511 /* Setting window manager hints. */
9513 /* Set the normal size hints for the window manager, for frame F.
9514 FLAGS is the flags word to use--or 0 meaning preserve the flags
9515 that the window now has.
9516 If USER_POSITION is nonzero, we set the USPosition
9517 flag (this is useful when FLAGS is 0).
9518 The GTK version is in gtkutils.c */
9520 #ifndef USE_GTK
9521 void
9522 x_wm_set_size_hint (struct frame *f, long flags, int user_position)
9524 XSizeHints size_hints;
9525 Window window = FRAME_OUTER_WINDOW (f);
9527 /* Setting PMaxSize caused various problems. */
9528 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9530 size_hints.x = f->left_pos;
9531 size_hints.y = f->top_pos;
9533 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9534 size_hints.width = FRAME_PIXEL_WIDTH (f);
9536 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9537 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9538 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9539 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9540 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9541 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9543 /* Calculate the base and minimum sizes. */
9545 int base_width, base_height;
9546 int min_rows = 0, min_cols = 0;
9548 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9549 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9551 check_frame_size (f, &min_rows, &min_cols);
9553 /* The window manager uses the base width hints to calculate the
9554 current number of rows and columns in the frame while
9555 resizing; min_width and min_height aren't useful for this
9556 purpose, since they might not give the dimensions for a
9557 zero-row, zero-column frame.
9559 We use the base_width and base_height members if we have
9560 them; otherwise, we set the min_width and min_height members
9561 to the size for a zero x zero frame. */
9563 size_hints.flags |= PBaseSize;
9564 size_hints.base_width = base_width;
9565 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9566 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9567 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9570 /* If we don't need the old flags, we don't need the old hint at all. */
9571 if (flags)
9573 size_hints.flags |= flags;
9574 goto no_read;
9578 XSizeHints hints; /* Sometimes I hate X Windows... */
9579 long supplied_return;
9580 int value;
9582 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9583 &supplied_return);
9585 if (flags)
9586 size_hints.flags |= flags;
9587 else
9589 if (value == 0)
9590 hints.flags = 0;
9591 if (hints.flags & PSize)
9592 size_hints.flags |= PSize;
9593 if (hints.flags & PPosition)
9594 size_hints.flags |= PPosition;
9595 if (hints.flags & USPosition)
9596 size_hints.flags |= USPosition;
9597 if (hints.flags & USSize)
9598 size_hints.flags |= USSize;
9602 no_read:
9604 #ifdef PWinGravity
9605 size_hints.win_gravity = f->win_gravity;
9606 size_hints.flags |= PWinGravity;
9608 if (user_position)
9610 size_hints.flags &= ~ PPosition;
9611 size_hints.flags |= USPosition;
9613 #endif /* PWinGravity */
9615 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9617 #endif /* not USE_GTK */
9619 /* Used for IconicState or NormalState */
9621 static void
9622 x_wm_set_window_state (struct frame *f, int state)
9624 #ifdef USE_X_TOOLKIT
9625 Arg al[1];
9627 XtSetArg (al[0], XtNinitialState, state);
9628 XtSetValues (f->output_data.x->widget, al, 1);
9629 #else /* not USE_X_TOOLKIT */
9630 Window window = FRAME_X_WINDOW (f);
9632 f->output_data.x->wm_hints.flags |= StateHint;
9633 f->output_data.x->wm_hints.initial_state = state;
9635 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9636 #endif /* not USE_X_TOOLKIT */
9639 static void
9640 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
9642 Pixmap icon_pixmap, icon_mask;
9644 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9645 Window window = FRAME_OUTER_WINDOW (f);
9646 #endif
9648 if (pixmap_id > 0)
9650 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9651 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9652 icon_mask = x_bitmap_mask (f, pixmap_id);
9653 f->output_data.x->wm_hints.icon_mask = icon_mask;
9655 else
9657 /* It seems there is no way to turn off use of an icon
9658 pixmap. */
9659 return;
9663 #ifdef USE_GTK
9665 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9666 return;
9669 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9672 Arg al[1];
9673 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9674 XtSetValues (f->output_data.x->widget, al, 1);
9675 XtSetArg (al[0], XtNiconMask, icon_mask);
9676 XtSetValues (f->output_data.x->widget, al, 1);
9679 #else /* not USE_X_TOOLKIT && not USE_GTK */
9681 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9682 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9684 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9687 void
9688 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9690 Window window = FRAME_OUTER_WINDOW (f);
9692 f->output_data.x->wm_hints.flags |= IconPositionHint;
9693 f->output_data.x->wm_hints.icon_x = icon_x;
9694 f->output_data.x->wm_hints.icon_y = icon_y;
9696 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9700 /***********************************************************************
9701 Fonts
9702 ***********************************************************************/
9704 #if GLYPH_DEBUG
9706 /* Check that FONT is valid on frame F. It is if it can be found in F's
9707 font table. */
9709 static void
9710 x_check_font (struct frame *f, struct font *font)
9712 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9713 if (font->driver->check)
9714 xassert (font->driver->check (f, font) == 0);
9717 #endif /* GLYPH_DEBUG != 0 */
9720 /***********************************************************************
9721 Initialization
9722 ***********************************************************************/
9724 #ifdef USE_X_TOOLKIT
9725 static XrmOptionDescRec emacs_options[] = {
9726 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9727 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9729 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9730 XrmoptionSepArg, NULL},
9731 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9733 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9734 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9735 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9736 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9737 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9738 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9739 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9742 /* Whether atimer for Xt timeouts is activated or not. */
9744 static int x_timeout_atimer_activated_flag;
9746 #endif /* USE_X_TOOLKIT */
9748 static int x_initialized;
9750 /* Test whether two display-name strings agree up to the dot that separates
9751 the screen number from the server number. */
9752 static int
9753 same_x_server (const char *name1, const char *name2)
9755 int seen_colon = 0;
9756 const char *system_name = SSDATA (Vsystem_name);
9757 ptrdiff_t system_name_length = SBYTES (Vsystem_name);
9758 ptrdiff_t length_until_period = 0;
9760 while (system_name[length_until_period] != 0
9761 && system_name[length_until_period] != '.')
9762 length_until_period++;
9764 /* Treat `unix' like an empty host name. */
9765 if (! strncmp (name1, "unix:", 5))
9766 name1 += 4;
9767 if (! strncmp (name2, "unix:", 5))
9768 name2 += 4;
9769 /* Treat this host's name like an empty host name. */
9770 if (! strncmp (name1, system_name, system_name_length)
9771 && name1[system_name_length] == ':')
9772 name1 += system_name_length;
9773 if (! strncmp (name2, system_name, system_name_length)
9774 && name2[system_name_length] == ':')
9775 name2 += system_name_length;
9776 /* Treat this host's domainless name like an empty host name. */
9777 if (! strncmp (name1, system_name, length_until_period)
9778 && name1[length_until_period] == ':')
9779 name1 += length_until_period;
9780 if (! strncmp (name2, system_name, length_until_period)
9781 && name2[length_until_period] == ':')
9782 name2 += length_until_period;
9784 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9786 if (*name1 == ':')
9787 seen_colon = 1;
9788 if (seen_colon && *name1 == '.')
9789 return 1;
9791 return (seen_colon
9792 && (*name1 == '.' || *name1 == '\0')
9793 && (*name2 == '.' || *name2 == '\0'));
9796 /* Count number of set bits in mask and number of bits to shift to
9797 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9798 to 5. */
9799 static void
9800 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9802 int nr = 0;
9803 int off = 0;
9805 while (!(mask & 1))
9807 off++;
9808 mask >>= 1;
9811 while (mask & 1)
9813 nr++;
9814 mask >>= 1;
9817 *offset = off;
9818 *bits = nr;
9821 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9822 But don't permanently open it, just test its availability. */
9825 x_display_ok (const char *display)
9827 int dpy_ok = 1;
9828 Display *dpy;
9830 dpy = XOpenDisplay (display);
9831 if (dpy)
9832 XCloseDisplay (dpy);
9833 else
9834 dpy_ok = 0;
9835 return dpy_ok;
9838 #ifdef USE_GTK
9839 static void
9840 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
9841 const gchar *msg, gpointer user_data)
9843 if (!strstr (msg, "g_set_prgname"))
9844 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
9846 #endif
9848 /* Open a connection to X display DISPLAY_NAME, and return
9849 the structure that describes the open display.
9850 If we cannot contact the display, return null. */
9852 struct x_display_info *
9853 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9855 int connection;
9856 Display *dpy;
9857 struct terminal *terminal;
9858 struct x_display_info *dpyinfo;
9859 XrmDatabase xrdb;
9860 Mouse_HLInfo *hlinfo;
9862 BLOCK_INPUT;
9864 if (!x_initialized)
9866 x_initialize ();
9867 ++x_initialized;
9870 if (! x_display_ok (SSDATA (display_name)))
9871 error ("Display %s can't be opened", SSDATA (display_name));
9873 #ifdef USE_GTK
9875 #define NUM_ARGV 10
9876 int argc;
9877 char *argv[NUM_ARGV];
9878 char **argv2 = argv;
9879 guint id;
9881 if (x_initialized++ > 1)
9883 xg_display_open (SSDATA (display_name), &dpy);
9885 else
9887 static char display_opt[] = "--display";
9888 static char name_opt[] = "--name";
9890 for (argc = 0; argc < NUM_ARGV; ++argc)
9891 argv[argc] = 0;
9893 argc = 0;
9894 argv[argc++] = initial_argv[0];
9896 if (! NILP (display_name))
9898 argv[argc++] = display_opt;
9899 argv[argc++] = SSDATA (display_name);
9902 argv[argc++] = name_opt;
9903 argv[argc++] = resource_name;
9905 XSetLocaleModifiers ("");
9907 /* Emacs can only handle core input events, so make sure
9908 Gtk doesn't use Xinput or Xinput2 extensions. */
9910 static char fix_events[] = "GDK_CORE_DEVICE_EVENTS=1";
9911 putenv (fix_events);
9914 /* Work around GLib bug that outputs a faulty warning. See
9915 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9916 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9917 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9918 gtk_init (&argc, &argv2);
9919 g_log_remove_handler ("GLib", id);
9921 /* gtk_init does set_locale. We must fix locale after calling it. */
9922 fixup_locale ();
9923 xg_initialize ();
9925 dpy = DEFAULT_GDK_DISPLAY ();
9927 /* NULL window -> events for all windows go to our function */
9928 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9930 #if GTK_MAJOR_VERSION <= 2 && GTK_MINOR_VERSION <= 90
9931 /* Load our own gtkrc if it exists. */
9933 const char *file = "~/.emacs.d/gtkrc";
9934 Lisp_Object s, abs_file;
9936 s = make_string (file, strlen (file));
9937 abs_file = Fexpand_file_name (s, Qnil);
9939 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9940 gtk_rc_parse (SSDATA (abs_file));
9942 #endif
9944 XSetErrorHandler (x_error_handler);
9945 XSetIOErrorHandler (x_io_error_quitter);
9948 #else /* not USE_GTK */
9949 #ifdef USE_X_TOOLKIT
9950 /* weiner@footloose.sps.mot.com reports that this causes
9951 errors with X11R5:
9952 X protocol error: BadAtom (invalid Atom parameter)
9953 on protocol request 18skiloaf.
9954 So let's not use it until R6. */
9955 #ifdef HAVE_X11XTR6
9956 XtSetLanguageProc (NULL, NULL, NULL);
9957 #endif
9960 int argc = 0;
9961 char *argv[3];
9963 argv[0] = "";
9964 argc = 1;
9965 if (xrm_option)
9967 argv[argc++] = "-xrm";
9968 argv[argc++] = xrm_option;
9970 turn_on_atimers (0);
9971 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
9972 resource_name, EMACS_CLASS,
9973 emacs_options, XtNumber (emacs_options),
9974 &argc, argv);
9975 turn_on_atimers (1);
9977 #ifdef HAVE_X11XTR6
9978 /* I think this is to compensate for XtSetLanguageProc. */
9979 fixup_locale ();
9980 #endif
9983 #else /* not USE_X_TOOLKIT */
9984 XSetLocaleModifiers ("");
9985 dpy = XOpenDisplay (SSDATA (display_name));
9986 #endif /* not USE_X_TOOLKIT */
9987 #endif /* not USE_GTK*/
9989 /* Detect failure. */
9990 if (dpy == 0)
9992 UNBLOCK_INPUT;
9993 return 0;
9996 /* We have definitely succeeded. Record the new connection. */
9998 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
9999 memset (dpyinfo, 0, sizeof *dpyinfo);
10000 hlinfo = &dpyinfo->mouse_highlight;
10002 terminal = x_create_terminal (dpyinfo);
10005 struct x_display_info *share;
10006 Lisp_Object tail;
10008 for (share = x_display_list, tail = x_display_name_list; share;
10009 share = share->next, tail = XCDR (tail))
10010 if (same_x_server (SSDATA (XCAR (XCAR (tail))),
10011 SSDATA (display_name)))
10012 break;
10013 if (share)
10014 terminal->kboard = share->terminal->kboard;
10015 else
10017 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10018 init_kboard (terminal->kboard);
10019 KVAR (terminal->kboard, Vwindow_system) = Qx;
10021 /* Add the keyboard to the list before running Lisp code (via
10022 Qvendor_specific_keysyms below), since these are not traced
10023 via terminals but only through all_kboards. */
10024 terminal->kboard->next_kboard = all_kboards;
10025 all_kboards = terminal->kboard;
10027 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10029 char *vendor = ServerVendor (dpy);
10031 /* Protect terminal from GC before removing it from the
10032 list of terminals. */
10033 struct gcpro gcpro1;
10034 Lisp_Object gcpro_term;
10035 XSETTERMINAL (gcpro_term, terminal);
10036 GCPRO1 (gcpro_term);
10038 /* Temporarily hide the partially initialized terminal. */
10039 terminal_list = terminal->next_terminal;
10040 UNBLOCK_INPUT;
10041 KVAR (terminal->kboard, Vsystem_key_alist)
10042 = call1 (Qvendor_specific_keysyms,
10043 vendor ? build_string (vendor) : empty_unibyte_string);
10044 BLOCK_INPUT;
10045 terminal->next_terminal = terminal_list;
10046 terminal_list = terminal;
10047 UNGCPRO;
10050 /* Don't let the initial kboard remain current longer than necessary.
10051 That would cause problems if a file loaded on startup tries to
10052 prompt in the mini-buffer. */
10053 if (current_kboard == initial_kboard)
10054 current_kboard = terminal->kboard;
10056 terminal->kboard->reference_count++;
10059 /* Put this display on the chain. */
10060 dpyinfo->next = x_display_list;
10061 x_display_list = dpyinfo;
10063 /* Put it on x_display_name_list as well, to keep them parallel. */
10064 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10065 x_display_name_list);
10066 dpyinfo->name_list_element = XCAR (x_display_name_list);
10068 dpyinfo->display = dpy;
10070 /* Set the name of the terminal. */
10071 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10072 strncpy (terminal->name, SSDATA (display_name), SBYTES (display_name));
10073 terminal->name[SBYTES (display_name)] = 0;
10075 #if 0
10076 XSetAfterFunction (x_current_display, x_trace_wire);
10077 #endif /* ! 0 */
10079 dpyinfo->x_id_name
10080 = (char *) xmalloc (SBYTES (Vinvocation_name)
10081 + SBYTES (Vsystem_name)
10082 + 2);
10083 sprintf (dpyinfo->x_id_name, "%s@%s",
10084 SSDATA (Vinvocation_name), SSDATA (Vsystem_name));
10086 /* Figure out which modifier bits mean what. */
10087 x_find_modifier_meanings (dpyinfo);
10089 /* Get the scroll bar cursor. */
10090 #ifdef USE_GTK
10091 /* We must create a GTK cursor, it is required for GTK widgets. */
10092 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10093 #endif /* USE_GTK */
10095 dpyinfo->vertical_scroll_bar_cursor
10096 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10098 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10099 resource_name, EMACS_CLASS);
10100 #ifdef HAVE_XRMSETDATABASE
10101 XrmSetDatabase (dpyinfo->display, xrdb);
10102 #else
10103 dpyinfo->display->db = xrdb;
10104 #endif
10105 /* Put the rdb where we can find it in a way that works on
10106 all versions. */
10107 dpyinfo->xrdb = xrdb;
10109 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10110 DefaultScreen (dpyinfo->display));
10111 select_visual (dpyinfo);
10112 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10113 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10114 dpyinfo->client_leader_window = 0;
10115 dpyinfo->grabbed = 0;
10116 dpyinfo->reference_count = 0;
10117 dpyinfo->icon_bitmap_id = -1;
10118 dpyinfo->n_fonts = 0;
10119 dpyinfo->bitmaps = 0;
10120 dpyinfo->bitmaps_size = 0;
10121 dpyinfo->bitmaps_last = 0;
10122 dpyinfo->scratch_cursor_gc = 0;
10123 hlinfo->mouse_face_mouse_frame = 0;
10124 hlinfo->mouse_face_deferred_gc = 0;
10125 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10126 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10127 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10128 hlinfo->mouse_face_window = Qnil;
10129 hlinfo->mouse_face_overlay = Qnil;
10130 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10131 hlinfo->mouse_face_defer = 0;
10132 hlinfo->mouse_face_hidden = 0;
10133 dpyinfo->x_focus_frame = 0;
10134 dpyinfo->x_focus_event_frame = 0;
10135 dpyinfo->x_highlight_frame = 0;
10136 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10138 /* See if we can construct pixel values from RGB values. */
10139 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10140 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10142 if (dpyinfo->visual->class == TrueColor)
10144 get_bits_and_offset (dpyinfo->visual->red_mask,
10145 &dpyinfo->red_bits, &dpyinfo->red_offset);
10146 get_bits_and_offset (dpyinfo->visual->blue_mask,
10147 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10148 get_bits_and_offset (dpyinfo->visual->green_mask,
10149 &dpyinfo->green_bits, &dpyinfo->green_offset);
10152 /* See if a private colormap is requested. */
10153 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10155 if (dpyinfo->visual->class == PseudoColor)
10157 Lisp_Object value;
10158 value = display_x_get_resource (dpyinfo,
10159 build_string ("privateColormap"),
10160 build_string ("PrivateColormap"),
10161 Qnil, Qnil);
10162 if (STRINGP (value)
10163 && (!strcmp (SSDATA (value), "true")
10164 || !strcmp (SSDATA (value), "on")))
10165 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10168 else
10169 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10170 dpyinfo->visual, AllocNone);
10172 #ifdef HAVE_XFT
10174 /* If we are using Xft, check dpi value in X resources.
10175 It is better we use it as well, since Xft will use it, as will all
10176 Gnome applications. If our real DPI is smaller or larger than the
10177 one Xft uses, our font will look smaller or larger than other
10178 for other applications, even if it is the same font name (monospace-10
10179 for example). */
10180 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10181 double d;
10182 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10183 dpyinfo->resy = dpyinfo->resx = d;
10185 #endif
10187 if (dpyinfo->resy < 1)
10189 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10190 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10191 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10192 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10193 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10194 pixels = DisplayWidth (dpyinfo->display, screen_number);
10195 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10196 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10197 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10201 const struct
10203 const char *name;
10204 Atom *atom;
10205 } atom_refs[] = {
10206 { "WM_PROTOCOLS", &dpyinfo->Xatom_wm_protocols },
10207 { "WM_TAKE_FOCUS", &dpyinfo->Xatom_wm_take_focus },
10208 { "WM_SAVE_YOURSELF", &dpyinfo->Xatom_wm_save_yourself },
10209 { "WM_DELETE_WINDOW", &dpyinfo->Xatom_wm_delete_window },
10210 { "WM_CHANGE_STATE", &dpyinfo->Xatom_wm_change_state },
10211 { "WM_CONFIGURE_DENIED", &dpyinfo->Xatom_wm_configure_denied },
10212 { "WM_MOVED", &dpyinfo->Xatom_wm_window_moved },
10213 { "WM_CLIENT_LEADER", &dpyinfo->Xatom_wm_client_leader },
10214 { "Editres", &dpyinfo->Xatom_editres },
10215 { "CLIPBOARD", &dpyinfo->Xatom_CLIPBOARD },
10216 { "TIMESTAMP", &dpyinfo->Xatom_TIMESTAMP },
10217 { "TEXT", &dpyinfo->Xatom_TEXT },
10218 { "COMPOUND_TEXT", &dpyinfo->Xatom_COMPOUND_TEXT },
10219 { "UTF8_STRING", &dpyinfo->Xatom_UTF8_STRING },
10220 { "DELETE", &dpyinfo->Xatom_DELETE },
10221 { "MULTIPLE", &dpyinfo->Xatom_MULTIPLE },
10222 { "INCR", &dpyinfo->Xatom_INCR },
10223 { "_EMACS_TMP_", &dpyinfo->Xatom_EMACS_TMP },
10224 { "TARGETS", &dpyinfo->Xatom_TARGETS },
10225 { "NULL", &dpyinfo->Xatom_NULL },
10226 { "ATOM", &dpyinfo->Xatom_ATOM },
10227 { "ATOM_PAIR", &dpyinfo->Xatom_ATOM_PAIR },
10228 { "CLIPBOARD_MANAGER", &dpyinfo->Xatom_CLIPBOARD_MANAGER },
10229 { "_XEMBED_INFO", &dpyinfo->Xatom_XEMBED_INFO },
10230 /* For properties of font. */
10231 { "PIXEL_SIZE", &dpyinfo->Xatom_PIXEL_SIZE },
10232 { "AVERAGE_WIDTH", &dpyinfo->Xatom_AVERAGE_WIDTH },
10233 { "_MULE_BASELINE_OFFSET", &dpyinfo->Xatom_MULE_BASELINE_OFFSET },
10234 { "_MULE_RELATIVE_COMPOSE", &dpyinfo->Xatom_MULE_RELATIVE_COMPOSE },
10235 { "_MULE_DEFAULT_ASCENT", &dpyinfo->Xatom_MULE_DEFAULT_ASCENT },
10236 /* Ghostscript support. */
10237 { "DONE", &dpyinfo->Xatom_DONE },
10238 { "PAGE", &dpyinfo->Xatom_PAGE },
10239 { "SCROLLBAR", &dpyinfo->Xatom_Scrollbar },
10240 { "_XEMBED", &dpyinfo->Xatom_XEMBED },
10241 /* EWMH */
10242 { "_NET_WM_STATE", &dpyinfo->Xatom_net_wm_state },
10243 { "_NET_WM_STATE_FULLSCREEN", &dpyinfo->Xatom_net_wm_state_fullscreen },
10244 { "_NET_WM_STATE_MAXIMIZED_HORZ",
10245 &dpyinfo->Xatom_net_wm_state_maximized_horz },
10246 { "_NET_WM_STATE_MAXIMIZED_VERT",
10247 &dpyinfo->Xatom_net_wm_state_maximized_vert },
10248 { "_NET_WM_STATE_STICKY", &dpyinfo->Xatom_net_wm_state_sticky },
10249 { "_NET_WM_WINDOW_TYPE", &dpyinfo->Xatom_net_window_type },
10250 { "_NET_WM_WINDOW_TYPE_TOOLTIP",
10251 &dpyinfo->Xatom_net_window_type_tooltip },
10252 { "_NET_WM_ICON_NAME", &dpyinfo->Xatom_net_wm_icon_name },
10253 { "_NET_WM_NAME", &dpyinfo->Xatom_net_wm_name },
10254 { "_NET_SUPPORTED", &dpyinfo->Xatom_net_supported },
10255 { "_NET_SUPPORTING_WM_CHECK", &dpyinfo->Xatom_net_supporting_wm_check },
10256 { "_NET_WM_WINDOW_OPACITY", &dpyinfo->Xatom_net_wm_window_opacity },
10257 { "_NET_ACTIVE_WINDOW", &dpyinfo->Xatom_net_active_window },
10258 { "_NET_FRAME_EXTENTS", &dpyinfo->Xatom_net_frame_extents },
10259 /* Session management */
10260 { "SM_CLIENT_ID", &dpyinfo->Xatom_SM_CLIENT_ID },
10261 { "_XSETTINGS_SETTINGS", &dpyinfo->Xatom_xsettings_prop },
10262 { "MANAGER", &dpyinfo->Xatom_xsettings_mgr },
10265 int i;
10266 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10267 /* 1 for _XSETTINGS_SN */
10268 const int total_atom_count = 1 + atom_count;
10269 Atom *atoms_return = xmalloc (sizeof (Atom) * total_atom_count);
10270 char **atom_names = xmalloc (sizeof (char *) * total_atom_count);
10271 char xsettings_atom_name[64];
10273 for (i = 0; i < atom_count; i++)
10274 atom_names[i] = (char *) atom_refs[i].name;
10276 /* Build _XSETTINGS_SN atom name */
10277 snprintf (xsettings_atom_name, sizeof (xsettings_atom_name),
10278 "_XSETTINGS_S%d", XScreenNumberOfScreen (dpyinfo->screen));
10279 atom_names[i] = xsettings_atom_name;
10281 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10282 False, atoms_return);
10284 for (i = 0; i < atom_count; i++)
10285 *atom_refs[i].atom = atoms_return[i];
10287 /* Manual copy of last atom */
10288 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10290 xfree (atom_names);
10291 xfree (atoms_return);
10294 dpyinfo->x_dnd_atoms_size = 8;
10295 dpyinfo->x_dnd_atoms_length = 0;
10296 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10297 * dpyinfo->x_dnd_atoms_size);
10299 dpyinfo->net_supported_atoms = NULL;
10300 dpyinfo->nr_net_supported_atoms = 0;
10301 dpyinfo->net_supported_window = 0;
10303 connection = ConnectionNumber (dpyinfo->display);
10304 dpyinfo->connection = connection;
10307 dpyinfo->gray
10308 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10309 gray_bitmap_bits,
10310 gray_bitmap_width, gray_bitmap_height,
10311 1, 0, 1);
10314 #ifdef HAVE_X_I18N
10315 xim_initialize (dpyinfo, resource_name);
10316 #endif
10318 xsettings_initialize (dpyinfo);
10320 /* This is only needed for distinguishing keyboard and process input. */
10321 if (connection != 0)
10322 add_keyboard_wait_descriptor (connection);
10324 #ifdef F_SETOWN
10325 fcntl (connection, F_SETOWN, getpid ());
10326 #endif /* ! defined (F_SETOWN) */
10328 #ifdef SIGIO
10329 if (interrupt_input)
10330 init_sigio (connection);
10331 #endif /* ! defined (SIGIO) */
10333 #ifdef USE_LUCID
10335 XrmValue d, fr, to;
10336 Font font;
10338 dpy = dpyinfo->display;
10339 d.addr = (XPointer)&dpy;
10340 d.size = sizeof (Display *);
10341 fr.addr = XtDefaultFont;
10342 fr.size = sizeof (XtDefaultFont);
10343 to.size = sizeof (Font *);
10344 to.addr = (XPointer)&font;
10345 x_catch_errors (dpy);
10346 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10347 abort ();
10348 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10349 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10350 x_uncatch_errors ();
10352 #endif
10354 /* See if we should run in synchronous mode. This is useful
10355 for debugging X code. */
10357 Lisp_Object value;
10358 value = display_x_get_resource (dpyinfo,
10359 build_string ("synchronous"),
10360 build_string ("Synchronous"),
10361 Qnil, Qnil);
10362 if (STRINGP (value)
10363 && (!strcmp (SSDATA (value), "true")
10364 || !strcmp (SSDATA (value), "on")))
10365 XSynchronize (dpyinfo->display, True);
10369 Lisp_Object value;
10370 value = display_x_get_resource (dpyinfo,
10371 build_string ("useXIM"),
10372 build_string ("UseXIM"),
10373 Qnil, Qnil);
10374 #ifdef USE_XIM
10375 if (STRINGP (value)
10376 && (!strcmp (SSDATA (value), "false")
10377 || !strcmp (SSDATA (value), "off")))
10378 use_xim = 0;
10379 #else
10380 if (STRINGP (value)
10381 && (!strcmp (SSDATA (value), "true")
10382 || !strcmp (SSDATA (value), "on")))
10383 use_xim = 1;
10384 #endif
10387 #ifdef HAVE_X_SM
10388 /* Only do this for the very first display in the Emacs session.
10389 Ignore X session management when Emacs was first started on a
10390 tty. */
10391 if (terminal->id == 1)
10392 x_session_initialize (dpyinfo);
10393 #endif
10395 UNBLOCK_INPUT;
10397 return dpyinfo;
10400 /* Get rid of display DPYINFO, deleting all frames on it,
10401 and without sending any more commands to the X server. */
10403 static void
10404 x_delete_display (struct x_display_info *dpyinfo)
10406 struct terminal *t;
10408 /* Close all frames and delete the generic struct terminal for this
10409 X display. */
10410 for (t = terminal_list; t; t = t->next_terminal)
10411 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10413 #ifdef HAVE_X_SM
10414 /* Close X session management when we close its display. */
10415 if (t->id == 1 && x_session_have_connection ())
10416 x_session_close ();
10417 #endif
10418 delete_terminal (t);
10419 break;
10422 delete_keyboard_wait_descriptor (dpyinfo->connection);
10424 /* Discard this display from x_display_name_list and x_display_list.
10425 We can't use Fdelq because that can quit. */
10426 if (! NILP (x_display_name_list)
10427 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10428 x_display_name_list = XCDR (x_display_name_list);
10429 else
10431 Lisp_Object tail;
10433 tail = x_display_name_list;
10434 while (CONSP (tail) && CONSP (XCDR (tail)))
10436 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10438 XSETCDR (tail, XCDR (XCDR (tail)));
10439 break;
10441 tail = XCDR (tail);
10445 if (next_noop_dpyinfo == dpyinfo)
10446 next_noop_dpyinfo = dpyinfo->next;
10448 if (x_display_list == dpyinfo)
10449 x_display_list = dpyinfo->next;
10450 else
10452 struct x_display_info *tail;
10454 for (tail = x_display_list; tail; tail = tail->next)
10455 if (tail->next == dpyinfo)
10456 tail->next = tail->next->next;
10459 xfree (dpyinfo->x_id_name);
10460 xfree (dpyinfo->x_dnd_atoms);
10461 xfree (dpyinfo->color_cells);
10462 xfree (dpyinfo);
10465 #ifdef USE_X_TOOLKIT
10467 /* Atimer callback function for TIMER. Called every 0.1s to process
10468 Xt timeouts, if needed. We must avoid calling XtAppPending as
10469 much as possible because that function does an implicit XFlush
10470 that slows us down. */
10472 static void
10473 x_process_timeouts (struct atimer *timer)
10475 BLOCK_INPUT;
10476 x_timeout_atimer_activated_flag = 0;
10477 if (toolkit_scroll_bar_interaction || popup_activated ())
10479 while (XtAppPending (Xt_app_con) & XtIMTimer)
10480 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10481 /* Reactivate the atimer for next time. */
10482 x_activate_timeout_atimer ();
10484 UNBLOCK_INPUT;
10487 /* Install an asynchronous timer that processes Xt timeout events
10488 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10489 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10490 function whenever these variables are set. This is necessary
10491 because some widget sets use timeouts internally, for example the
10492 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10493 processed, these widgets don't behave normally. */
10495 void
10496 x_activate_timeout_atimer (void)
10498 BLOCK_INPUT;
10499 if (!x_timeout_atimer_activated_flag)
10501 EMACS_TIME interval;
10503 EMACS_SET_SECS_USECS (interval, 0, 100000);
10504 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10505 x_timeout_atimer_activated_flag = 1;
10507 UNBLOCK_INPUT;
10510 #endif /* USE_X_TOOLKIT */
10513 /* Set up use of X before we make the first connection. */
10515 extern frame_parm_handler x_frame_parm_handlers[];
10517 static struct redisplay_interface x_redisplay_interface =
10519 x_frame_parm_handlers,
10520 x_produce_glyphs,
10521 x_write_glyphs,
10522 x_insert_glyphs,
10523 x_clear_end_of_line,
10524 x_scroll_run,
10525 x_after_update_window_line,
10526 x_update_window_begin,
10527 x_update_window_end,
10528 x_cursor_to,
10529 x_flush,
10530 #ifdef XFlush
10531 x_flush,
10532 #else
10533 0, /* flush_display_optional */
10534 #endif
10535 x_clear_window_mouse_face,
10536 x_get_glyph_overhangs,
10537 x_fix_overlapping_area,
10538 x_draw_fringe_bitmap,
10539 0, /* define_fringe_bitmap */
10540 0, /* destroy_fringe_bitmap */
10541 x_compute_glyph_string_overhangs,
10542 x_draw_glyph_string,
10543 x_define_frame_cursor,
10544 x_clear_frame_area,
10545 x_draw_window_cursor,
10546 x_draw_vertical_window_border,
10547 x_shift_glyphs_for_insert
10551 /* This function is called when the last frame on a display is deleted. */
10552 void
10553 x_delete_terminal (struct terminal *terminal)
10555 struct x_display_info *dpyinfo = terminal->display_info.x;
10557 /* Protect against recursive calls. delete_frame in
10558 delete_terminal calls us back when it deletes our last frame. */
10559 if (!terminal->name)
10560 return;
10562 BLOCK_INPUT;
10563 #ifdef HAVE_X_I18N
10564 /* We must close our connection to the XIM server before closing the
10565 X display. */
10566 if (dpyinfo->xim)
10567 xim_close_dpy (dpyinfo);
10568 #endif
10570 /* If called from x_connection_closed, the display may already be closed
10571 and dpyinfo->display was set to 0 to indicate that. */
10572 if (dpyinfo->display)
10574 x_destroy_all_bitmaps (dpyinfo);
10575 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10577 /* Whether or not XCloseDisplay destroys the associated resource
10578 database depends on the version of libX11. To avoid both
10579 crash and memory leak, we dissociate the database from the
10580 display and then destroy dpyinfo->xrdb ourselves.
10582 Unfortunately, the above strategy does not work in some
10583 situations due to a bug in newer versions of libX11: because
10584 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10585 dpy->db is NULL, XCloseDisplay destroys the associated
10586 database whereas it has not been created by XGetDefault
10587 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10588 don't destroy the database here in order to avoid the crash
10589 in the above situations for now, though that may cause memory
10590 leaks in other situations. */
10591 #if 0
10592 #ifdef HAVE_XRMSETDATABASE
10593 XrmSetDatabase (dpyinfo->display, NULL);
10594 #else
10595 dpyinfo->display->db = NULL;
10596 #endif
10597 /* We used to call XrmDestroyDatabase from x_delete_display, but
10598 some older versions of libX11 crash if we call it after
10599 closing all the displays. */
10600 XrmDestroyDatabase (dpyinfo->xrdb);
10601 #endif
10603 #ifdef USE_GTK
10604 xg_display_close (dpyinfo->display);
10605 #else
10606 #ifdef USE_X_TOOLKIT
10607 XtCloseDisplay (dpyinfo->display);
10608 #else
10609 XCloseDisplay (dpyinfo->display);
10610 #endif
10611 #endif /* ! USE_GTK */
10614 /* Mark as dead. */
10615 dpyinfo->display = NULL;
10616 x_delete_display (dpyinfo);
10617 UNBLOCK_INPUT;
10620 /* Create a struct terminal, initialize it with the X11 specific
10621 functions and make DISPLAY->TERMINAL point to it. */
10623 static struct terminal *
10624 x_create_terminal (struct x_display_info *dpyinfo)
10626 struct terminal *terminal;
10628 terminal = create_terminal ();
10630 terminal->type = output_x_window;
10631 terminal->display_info.x = dpyinfo;
10632 dpyinfo->terminal = terminal;
10634 /* kboard is initialized in x_term_init. */
10636 terminal->clear_frame_hook = x_clear_frame;
10637 terminal->ins_del_lines_hook = x_ins_del_lines;
10638 terminal->delete_glyphs_hook = x_delete_glyphs;
10639 terminal->ring_bell_hook = XTring_bell;
10640 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10641 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10642 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10643 terminal->update_begin_hook = x_update_begin;
10644 terminal->update_end_hook = x_update_end;
10645 terminal->set_terminal_window_hook = XTset_terminal_window;
10646 terminal->read_socket_hook = XTread_socket;
10647 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10648 terminal->mouse_position_hook = XTmouse_position;
10649 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10650 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10651 terminal->fullscreen_hook = XTfullscreen_hook;
10652 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10653 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10654 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10655 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10657 terminal->delete_frame_hook = x_destroy_window;
10658 terminal->delete_terminal_hook = x_delete_terminal;
10660 terminal->rif = &x_redisplay_interface;
10661 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10662 terminal->char_ins_del_ok = 1;
10663 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10664 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10665 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10666 off the bottom. */
10668 return terminal;
10671 void
10672 x_initialize (void)
10674 baud_rate = 19200;
10676 x_noop_count = 0;
10677 last_tool_bar_item = -1;
10678 any_help_event_p = 0;
10679 ignore_next_mouse_click_timeout = 0;
10681 #ifdef USE_GTK
10682 current_count = -1;
10683 #endif
10685 /* Try to use interrupt input; if we can't, then start polling. */
10686 Fset_input_interrupt_mode (Qt);
10688 #ifdef USE_X_TOOLKIT
10689 XtToolkitInitialize ();
10691 Xt_app_con = XtCreateApplicationContext ();
10693 /* Register a converter from strings to pixels, which uses
10694 Emacs' color allocation infrastructure. */
10695 XtAppSetTypeConverter (Xt_app_con,
10696 XtRString, XtRPixel, cvt_string_to_pixel,
10697 cvt_string_to_pixel_args,
10698 XtNumber (cvt_string_to_pixel_args),
10699 XtCacheByDisplay, cvt_pixel_dtor);
10701 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10702 #endif
10704 #ifdef USE_TOOLKIT_SCROLL_BARS
10705 #ifndef USE_GTK
10706 xaw3d_arrow_scroll = False;
10707 xaw3d_pick_top = True;
10708 #endif
10709 #endif
10711 pending_autoraise_frame = 0;
10712 pending_event_wait.f = 0;
10713 pending_event_wait.eventtype = 0;
10715 /* Note that there is no real way portable across R3/R4 to get the
10716 original error handler. */
10717 XSetErrorHandler (x_error_handler);
10718 XSetIOErrorHandler (x_io_error_quitter);
10720 signal (SIGPIPE, x_connection_signal);
10722 xgselect_initialize ();
10726 void
10727 syms_of_xterm (void)
10729 x_error_message = NULL;
10731 staticpro (&x_display_name_list);
10732 x_display_name_list = Qnil;
10734 staticpro (&last_mouse_scroll_bar);
10735 last_mouse_scroll_bar = Qnil;
10737 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
10738 DEFSYM (Qlatin_1, "latin-1");
10740 staticpro (&last_mouse_press_frame);
10741 last_mouse_press_frame = Qnil;
10743 #ifdef USE_GTK
10744 xg_default_icon_file = make_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10745 staticpro (&xg_default_icon_file);
10747 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
10748 #endif
10750 DEFVAR_BOOL ("x-use-underline-position-properties",
10751 x_use_underline_position_properties,
10752 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10753 A value of nil means ignore them. If you encounter fonts with bogus
10754 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10755 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10756 to override the font's UNDERLINE_POSITION for small font display
10757 sizes. */);
10758 x_use_underline_position_properties = 1;
10760 DEFVAR_BOOL ("x-underline-at-descent-line",
10761 x_underline_at_descent_line,
10762 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10763 A value of nil means to draw the underline according to the value of the
10764 variable `x-use-underline-position-properties', which is usually at the
10765 baseline level. The default value is nil. */);
10766 x_underline_at_descent_line = 0;
10768 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10769 x_mouse_click_focus_ignore_position,
10770 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10771 This variable is only used when the window manager requires that you
10772 click on a frame to select it (give it focus). In that case, a value
10773 of nil, means that the selected window and cursor position changes to
10774 reflect the mouse click position, while a non-nil value means that the
10775 selected window or cursor position is preserved. */);
10776 x_mouse_click_focus_ignore_position = 0;
10778 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10779 doc: /* Which toolkit scroll bars Emacs uses, if any.
10780 A value of nil means Emacs doesn't use toolkit scroll bars.
10781 With the X Window system, the value is a symbol describing the
10782 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10783 With MS Windows, the value is t. */);
10784 #ifdef USE_TOOLKIT_SCROLL_BARS
10785 #ifdef USE_MOTIF
10786 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10787 #elif defined HAVE_XAW3D
10788 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10789 #elif USE_GTK
10790 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10791 #else
10792 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10793 #endif
10794 #else
10795 Vx_toolkit_scroll_bars = Qnil;
10796 #endif
10798 staticpro (&last_mouse_motion_frame);
10799 last_mouse_motion_frame = Qnil;
10801 Qmodifier_value = intern_c_string ("modifier-value");
10802 Qalt = intern_c_string ("alt");
10803 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10804 Qhyper = intern_c_string ("hyper");
10805 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10806 Qmeta = intern_c_string ("meta");
10807 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10808 Qsuper = intern_c_string ("super");
10809 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10811 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10812 doc: /* Which keys Emacs uses for the alt modifier.
10813 This should be one of the symbols `alt', `hyper', `meta', `super'.
10814 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10815 is nil, which is the same as `alt'. */);
10816 Vx_alt_keysym = Qnil;
10818 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10819 doc: /* Which keys Emacs uses for the hyper modifier.
10820 This should be one of the symbols `alt', `hyper', `meta', `super'.
10821 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10822 default is nil, which is the same as `hyper'. */);
10823 Vx_hyper_keysym = Qnil;
10825 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10826 doc: /* Which keys Emacs uses for the meta modifier.
10827 This should be one of the symbols `alt', `hyper', `meta', `super'.
10828 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10829 default is nil, which is the same as `meta'. */);
10830 Vx_meta_keysym = Qnil;
10832 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10833 doc: /* Which keys Emacs uses for the super modifier.
10834 This should be one of the symbols `alt', `hyper', `meta', `super'.
10835 For example, `super' means use the Super_L and Super_R keysyms. The
10836 default is nil, which is the same as `super'. */);
10837 Vx_super_keysym = Qnil;
10839 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10840 doc: /* Hash table of character codes indexed by X keysym codes. */);
10841 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10842 make_float (DEFAULT_REHASH_SIZE),
10843 make_float (DEFAULT_REHASH_THRESHOLD),
10844 Qnil, Qnil, Qnil);
10847 #endif /* HAVE_X_WINDOWS */