gnus-util.el (gnus-macroexpand-all): Fix last change.
[emacs.git] / src / xterm.c
bloba571d025571b5d9da04bcee049d247ffea21e919
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
23 /* Xt features made by Fred Pierresteguy. */
25 #include <config.h>
26 #include <signal.h>
27 #include <stdio.h>
28 #include <setjmp.h>
30 #ifdef HAVE_X_WINDOWS
32 #include "lisp.h"
33 #include "blockinput.h"
35 /* Need syssignal.h for various externs and definitions that may be required
36 by some configurations for calls to signal later in this source file. */
37 #include "syssignal.h"
39 /* This may include sys/types.h, and that somehow loses
40 if this is not done before the other system files. */
41 #include "xterm.h"
42 #include <X11/cursorfont.h>
44 /* Load sys/types.h if not already loaded.
45 In some systems loading it twice is suicidal. */
46 #ifndef makedev
47 #include <sys/types.h>
48 #endif /* makedev */
50 #include <sys/ioctl.h>
52 #include "systime.h"
54 #include <fcntl.h>
55 #include <ctype.h>
56 #include <errno.h>
57 #include <setjmp.h>
58 #include <sys/stat.h>
59 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
60 /* #include <sys/param.h> */
62 #include "charset.h"
63 #include "character.h"
64 #include "coding.h"
65 #include "frame.h"
66 #include "dispextern.h"
67 #include "fontset.h"
68 #include "termhooks.h"
69 #include "termopts.h"
70 #include "termchar.h"
71 #include "emacs-icon.h"
72 #include "disptab.h"
73 #include "buffer.h"
74 #include "window.h"
75 #include "keyboard.h"
76 #include "intervals.h"
77 #include "process.h"
78 #include "atimer.h"
79 #include "keymap.h"
80 #include "font.h"
81 #include "fontset.h"
82 #include "xsettings.h"
83 #include "xgselect.h"
84 #include "sysselect.h"
86 #ifdef USE_X_TOOLKIT
87 #include <X11/Shell.h>
88 #endif
90 #ifdef HAVE_SYS_TIME_H
91 #include <sys/time.h>
92 #endif
93 #ifdef HAVE_UNISTD_H
94 #include <unistd.h>
95 #endif
97 #ifdef USE_GTK
98 #include "gtkutil.h"
99 #endif
101 #ifdef USE_LUCID
102 #include "../lwlib/xlwmenu.h"
103 #endif
105 #ifdef USE_X_TOOLKIT
106 #if !defined(NO_EDITRES)
107 #define HACK_EDITRES
108 extern void _XEditResCheckMessages ();
109 #endif /* not NO_EDITRES */
111 /* Include toolkit specific headers for the scroll bar widget. */
113 #ifdef USE_TOOLKIT_SCROLL_BARS
114 #if defined USE_MOTIF
115 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
116 #include <Xm/ScrollBar.h>
117 #else /* !USE_MOTIF i.e. use Xaw */
119 #ifdef HAVE_XAW3D
120 #include <X11/Xaw3d/Simple.h>
121 #include <X11/Xaw3d/Scrollbar.h>
122 #include <X11/Xaw3d/ThreeD.h>
123 #else /* !HAVE_XAW3D */
124 #include <X11/Xaw/Simple.h>
125 #include <X11/Xaw/Scrollbar.h>
126 #endif /* !HAVE_XAW3D */
127 #ifndef XtNpickTop
128 #define XtNpickTop "pickTop"
129 #endif /* !XtNpickTop */
130 #endif /* !USE_MOTIF */
131 #endif /* USE_TOOLKIT_SCROLL_BARS */
133 #endif /* USE_X_TOOLKIT */
135 #ifdef USE_X_TOOLKIT
136 #include "widget.h"
137 #ifndef XtNinitialState
138 #define XtNinitialState "initialState"
139 #endif
140 #endif
142 /* Default to using XIM if available. */
143 #ifdef USE_XIM
144 int use_xim = 1;
145 #else
146 int use_xim = 0; /* configure --without-xim */
147 #endif
151 /* Non-nil means Emacs uses toolkit scroll bars. */
153 Lisp_Object Vx_toolkit_scroll_bars;
155 /* Non-zero means that a HELP_EVENT has been generated since Emacs
156 start. */
158 static int any_help_event_p;
160 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
161 static Lisp_Object last_window;
163 /* Non-zero means make use of UNDERLINE_POSITION font properties. */
165 int x_use_underline_position_properties;
167 /* Non-zero means to draw the underline at the same place as the descent line. */
169 int x_underline_at_descent_line;
171 /* This is a chain of structures for all the X displays currently in
172 use. */
174 struct x_display_info *x_display_list;
176 /* This is a list of cons cells, each of the form (NAME
177 . FONT-LIST-CACHE), one for each element of x_display_list and in
178 the same order. NAME is the name of the frame. FONT-LIST-CACHE
179 records previous values returned by x-list-fonts. */
181 Lisp_Object x_display_name_list;
183 /* Frame being updated by update_frame. This is declared in term.c.
184 This is set by update_begin and looked at by all the XT functions.
185 It is zero while not inside an update. In that case, the XT
186 functions assume that `selected_frame' is the frame to apply to. */
188 extern struct frame *updating_frame;
190 /* This is a frame waiting to be auto-raised, within XTread_socket. */
192 static struct frame *pending_autoraise_frame;
194 /* This is a frame waiting for an event matching mask, within XTread_socket. */
196 static struct {
197 struct frame *f;
198 int eventtype;
199 } pending_event_wait;
201 #ifdef USE_X_TOOLKIT
202 /* The application context for Xt use. */
203 XtAppContext Xt_app_con;
204 static String Xt_default_resources[] = {0};
205 #endif /* USE_X_TOOLKIT */
207 /* Non-zero means user is interacting with a toolkit scroll bar. */
209 static int toolkit_scroll_bar_interaction;
211 /* Non-zero means to not move point as a result of clicking on a
212 frame to focus it (when focus-follows-mouse is nil). */
214 int x_mouse_click_focus_ignore_position;
216 /* Non-zero timeout value means ignore next mouse click if it arrives
217 before that timeout elapses (i.e. as part of the same sequence of
218 events resulting from clicking on a frame to select it). */
220 static unsigned long ignore_next_mouse_click_timeout;
222 /* Mouse movement.
224 Formerly, we used PointerMotionHintMask (in standard_event_mask)
225 so that we would have to call XQueryPointer after each MotionNotify
226 event to ask for another such event. However, this made mouse tracking
227 slow, and there was a bug that made it eventually stop.
229 Simply asking for MotionNotify all the time seems to work better.
231 In order to avoid asking for motion events and then throwing most
232 of them away or busy-polling the server for mouse positions, we ask
233 the server for pointer motion hints. This means that we get only
234 one event per group of mouse movements. "Groups" are delimited by
235 other kinds of events (focus changes and button clicks, for
236 example), or by XQueryPointer calls; when one of these happens, we
237 get another MotionNotify event the next time the mouse moves. This
238 is at least as efficient as getting motion events when mouse
239 tracking is on, and I suspect only negligibly worse when tracking
240 is off. */
242 /* Where the mouse was last time we reported a mouse event. */
244 static XRectangle last_mouse_glyph;
245 static FRAME_PTR last_mouse_glyph_frame;
246 static Lisp_Object last_mouse_press_frame;
248 /* The scroll bar in which the last X motion event occurred.
250 If the last X motion event occurred in a scroll bar, we set this so
251 XTmouse_position can know whether to report a scroll bar motion or
252 an ordinary motion.
254 If the last X motion event didn't occur in a scroll bar, we set
255 this to Qnil, to tell XTmouse_position to return an ordinary motion
256 event. */
258 static Lisp_Object last_mouse_scroll_bar;
260 /* This is a hack. We would really prefer that XTmouse_position would
261 return the time associated with the position it returns, but there
262 doesn't seem to be any way to wrest the time-stamp from the server
263 along with the position query. So, we just keep track of the time
264 of the last movement we received, and return that in hopes that
265 it's somewhat accurate. */
267 static Time last_mouse_movement_time;
269 /* Time for last user interaction as returned in X events. */
271 static Time last_user_time;
273 /* Incremented by XTread_socket whenever it really tries to read
274 events. */
276 #ifdef __STDC__
277 static int volatile input_signal_count;
278 #else
279 static int input_signal_count;
280 #endif
282 /* Used locally within XTread_socket. */
284 static int x_noop_count;
286 /* The keysyms to use for the various modifiers. */
288 Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
289 Lisp_Object Vx_keysym_table;
290 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
292 static Lisp_Object Qvendor_specific_keysyms;
293 static Lisp_Object Qlatin_1;
295 #ifdef USE_GTK
296 /* The name of the Emacs icon file. */
297 static Lisp_Object xg_default_icon_file;
299 /* Used in gtkutil.c. */
300 Lisp_Object Qx_gtk_map_stock;
301 #endif
303 /* Some functions take this as char *, not const char *. */
304 static char emacs_class[] = EMACS_CLASS;
306 /* Used in x_flush. */
308 extern XrmDatabase x_load_resources (Display *, const char *, const char *,
309 const char *);
310 extern int x_bitmap_mask (FRAME_PTR, int);
312 static int x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
313 static void x_set_window_size_1 (struct frame *, int, int, int);
314 static const XColor *x_color_cells (Display *, int *);
315 static void x_update_window_end (struct window *, int, int);
317 static int x_io_error_quitter (Display *);
318 static struct terminal *x_create_terminal (struct x_display_info *);
319 void x_delete_terminal (struct terminal *);
320 static void x_update_end (struct frame *);
321 static void XTframe_up_to_date (struct frame *);
322 static void XTset_terminal_modes (struct terminal *);
323 static void XTreset_terminal_modes (struct terminal *);
324 static void x_clear_frame (struct frame *);
325 static void frame_highlight (struct frame *);
326 static void frame_unhighlight (struct frame *);
327 static void x_new_focus_frame (struct x_display_info *, struct frame *);
328 static void x_focus_changed (int, int, struct x_display_info *,
329 struct frame *, struct input_event *);
330 static void x_detect_focus_change (struct x_display_info *,
331 XEvent *, struct input_event *);
332 static void XTframe_rehighlight (struct frame *);
333 static void x_frame_rehighlight (struct x_display_info *);
334 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
335 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
336 enum text_cursor_kinds);
338 static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
339 static void x_flush (struct frame *f);
340 static void x_update_begin (struct frame *);
341 static void x_update_window_begin (struct window *);
342 static void x_after_update_window_line (struct glyph_row *);
343 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
344 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
345 enum scroll_bar_part *,
346 Lisp_Object *, Lisp_Object *,
347 unsigned long *);
348 static void x_handle_net_wm_state (struct frame *, XPropertyEvent *);
349 static void x_check_fullscreen (struct frame *);
350 static void x_check_expected_move (struct frame *, int, int);
351 static void x_sync_with_move (struct frame *, int, int, int);
352 static int handle_one_xevent (struct x_display_info *, XEvent *,
353 int *, struct input_event *);
354 /* Don't declare this NO_RETURN because we want no
355 interference with debugging failing X calls. */
356 static SIGTYPE x_connection_closed (Display *, const char *);
359 /* Flush display of frame F, or of all frames if F is null. */
361 static void
362 x_flush (struct frame *f)
364 /* Don't call XFlush when it is not safe to redisplay; the X
365 connection may be broken. */
366 if (!NILP (Vinhibit_redisplay))
367 return;
369 BLOCK_INPUT;
370 if (f == NULL)
372 Lisp_Object rest, frame;
373 FOR_EACH_FRAME (rest, frame)
374 if (FRAME_X_P (XFRAME (frame)))
375 x_flush (XFRAME (frame));
377 else if (FRAME_X_P (f))
378 XFlush (FRAME_X_DISPLAY (f));
379 UNBLOCK_INPUT;
383 /* Remove calls to XFlush by defining XFlush to an empty replacement.
384 Calls to XFlush should be unnecessary because the X output buffer
385 is flushed automatically as needed by calls to XPending,
386 XNextEvent, or XWindowEvent according to the XFlush man page.
387 XTread_socket calls XPending. Removing XFlush improves
388 performance. */
390 #define XFlush(DISPLAY) (void) 0
393 /***********************************************************************
394 Debugging
395 ***********************************************************************/
397 #if 0
399 /* This is a function useful for recording debugging information about
400 the sequence of occurrences in this file. */
402 struct record
404 char *locus;
405 int type;
408 struct record event_record[100];
410 int event_record_index;
412 record_event (locus, type)
413 char *locus;
414 int type;
416 if (event_record_index == sizeof (event_record) / sizeof (struct record))
417 event_record_index = 0;
419 event_record[event_record_index].locus = locus;
420 event_record[event_record_index].type = type;
421 event_record_index++;
424 #endif /* 0 */
428 /* Return the struct x_display_info corresponding to DPY. */
430 struct x_display_info *
431 x_display_info_for_display (Display *dpy)
433 struct x_display_info *dpyinfo;
435 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
436 if (dpyinfo->display == dpy)
437 return dpyinfo;
439 return 0;
442 #define OPAQUE 0xffffffff
444 void
445 x_set_frame_alpha (struct frame *f)
447 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
448 Display *dpy = FRAME_X_DISPLAY (f);
449 Window win = FRAME_OUTER_WINDOW (f);
450 double alpha = 1.0;
451 double alpha_min = 1.0;
452 unsigned long opac;
454 if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
455 /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
456 we must treat the former instead of the latter. */
457 win = FRAME_X_OUTPUT (f)->parent_desc;
459 if (dpyinfo->x_highlight_frame == f)
460 alpha = f->alpha[0];
461 else
462 alpha = f->alpha[1];
464 if (FLOATP (Vframe_alpha_lower_limit))
465 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
466 else if (INTEGERP (Vframe_alpha_lower_limit))
467 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
469 if (alpha < 0.0)
470 return;
471 else if (alpha > 1.0)
472 alpha = 1.0;
473 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
474 alpha = alpha_min;
476 opac = alpha * OPAQUE;
478 /* return unless necessary */
480 unsigned char *data;
481 Atom actual;
482 int rc, format;
483 unsigned long n, left;
485 x_catch_errors (dpy);
486 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
487 0L, 1L, False, XA_CARDINAL,
488 &actual, &format, &n, &left,
489 &data);
491 if (rc == Success && actual != None)
492 if (*(unsigned long *)data == opac)
494 XFree ((void *) data);
495 x_uncatch_errors ();
496 return;
498 else
499 XFree ((void *) data);
500 x_uncatch_errors ();
503 x_catch_errors (dpy);
504 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
505 XA_CARDINAL, 32, PropModeReplace,
506 (unsigned char *) &opac, 1L);
507 x_uncatch_errors ();
511 x_display_pixel_height (struct x_display_info *dpyinfo)
513 return HeightOfScreen (dpyinfo->screen);
517 x_display_pixel_width (struct x_display_info *dpyinfo)
519 return WidthOfScreen (dpyinfo->screen);
523 /***********************************************************************
524 Starting and ending an update
525 ***********************************************************************/
527 /* Start an update of frame F. This function is installed as a hook
528 for update_begin, i.e. it is called when update_begin is called.
529 This function is called prior to calls to x_update_window_begin for
530 each window being updated. Currently, there is nothing to do here
531 because all interesting stuff is done on a window basis. */
533 static void
534 x_update_begin (struct frame *f)
536 /* Nothing to do. */
540 /* Start update of window W. Set the global variable updated_window
541 to the window being updated and set output_cursor to the cursor
542 position of W. */
544 static void
545 x_update_window_begin (struct window *w)
547 struct frame *f = XFRAME (WINDOW_FRAME (w));
548 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
550 updated_window = w;
551 set_output_cursor (&w->cursor);
553 BLOCK_INPUT;
555 if (f == hlinfo->mouse_face_mouse_frame)
557 /* Don't do highlighting for mouse motion during the update. */
558 hlinfo->mouse_face_defer = 1;
560 /* If F needs to be redrawn, simply forget about any prior mouse
561 highlighting. */
562 if (FRAME_GARBAGED_P (f))
563 hlinfo->mouse_face_window = Qnil;
566 UNBLOCK_INPUT;
570 /* Draw a vertical window border from (x,y0) to (x,y1) */
572 static void
573 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
575 struct frame *f = XFRAME (WINDOW_FRAME (w));
576 struct face *face;
578 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
579 if (face)
580 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
581 face->foreground);
583 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
584 f->output_data.x->normal_gc, x, y0, x, y1);
587 /* End update of window W (which is equal to updated_window).
589 Draw vertical borders between horizontally adjacent windows, and
590 display W's cursor if CURSOR_ON_P is non-zero.
592 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
593 glyphs in mouse-face were overwritten. In that case we have to
594 make sure that the mouse-highlight is properly redrawn.
596 W may be a menu bar pseudo-window in case we don't have X toolkit
597 support. Such windows don't have a cursor, so don't display it
598 here. */
600 static void
601 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
603 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
605 if (!w->pseudo_window_p)
607 BLOCK_INPUT;
609 if (cursor_on_p)
610 display_and_set_cursor (w, 1, output_cursor.hpos,
611 output_cursor.vpos,
612 output_cursor.x, output_cursor.y);
614 if (draw_window_fringes (w, 1))
615 x_draw_vertical_border (w);
617 UNBLOCK_INPUT;
620 /* If a row with mouse-face was overwritten, arrange for
621 XTframe_up_to_date to redisplay the mouse highlight. */
622 if (mouse_face_overwritten_p)
624 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
625 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
626 hlinfo->mouse_face_window = Qnil;
629 updated_window = NULL;
633 /* End update of frame F. This function is installed as a hook in
634 update_end. */
636 static void
637 x_update_end (struct frame *f)
639 /* Mouse highlight may be displayed again. */
640 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
642 #ifndef XFlush
643 BLOCK_INPUT;
644 XFlush (FRAME_X_DISPLAY (f));
645 UNBLOCK_INPUT;
646 #endif
650 /* This function is called from various places in xdisp.c whenever a
651 complete update has been performed. The global variable
652 updated_window is not available here. */
654 static void
655 XTframe_up_to_date (struct frame *f)
657 if (FRAME_X_P (f))
659 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
661 if (hlinfo->mouse_face_deferred_gc
662 || f == hlinfo->mouse_face_mouse_frame)
664 BLOCK_INPUT;
665 if (hlinfo->mouse_face_mouse_frame)
666 note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
667 hlinfo->mouse_face_mouse_x,
668 hlinfo->mouse_face_mouse_y);
669 hlinfo->mouse_face_deferred_gc = 0;
670 UNBLOCK_INPUT;
676 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
677 arrow bitmaps, or clear the fringes if no bitmaps are required
678 before DESIRED_ROW is made current. The window being updated is
679 found in updated_window. This function It is called from
680 update_window_line only if it is known that there are differences
681 between bitmaps to be drawn between current row and DESIRED_ROW. */
683 static void
684 x_after_update_window_line (struct glyph_row *desired_row)
686 struct window *w = updated_window;
687 struct frame *f;
688 int width, height;
690 xassert (w);
692 if (!desired_row->mode_line_p && !w->pseudo_window_p)
693 desired_row->redraw_fringe_bitmaps_p = 1;
695 /* When a window has disappeared, make sure that no rest of
696 full-width rows stays visible in the internal border. Could
697 check here if updated_window is the leftmost/rightmost window,
698 but I guess it's not worth doing since vertically split windows
699 are almost never used, internal border is rarely set, and the
700 overhead is very small. */
701 if (windows_or_buffers_changed
702 && desired_row->full_width_p
703 && (f = XFRAME (w->frame),
704 width = FRAME_INTERNAL_BORDER_WIDTH (f),
705 width != 0)
706 && (height = desired_row->visible_height,
707 height > 0))
709 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
711 BLOCK_INPUT;
712 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
713 0, y, width, height, False);
714 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
715 FRAME_PIXEL_WIDTH (f) - width,
716 y, width, height, False);
717 UNBLOCK_INPUT;
721 static void
722 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
724 struct frame *f = XFRAME (WINDOW_FRAME (w));
725 Display *display = FRAME_X_DISPLAY (f);
726 Window window = FRAME_X_WINDOW (f);
727 GC gc = f->output_data.x->normal_gc;
728 struct face *face = p->face;
730 /* Must clip because of partially visible lines. */
731 x_clip_to_row (w, row, -1, gc);
733 if (!p->overlay_p)
735 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
737 /* In case the same realized face is used for fringes and
738 for something displayed in the text (e.g. face `region' on
739 mono-displays, the fill style may have been changed to
740 FillSolid in x_draw_glyph_string_background. */
741 if (face->stipple)
742 XSetFillStyle (display, face->gc, FillOpaqueStippled);
743 else
744 XSetForeground (display, face->gc, face->background);
746 #ifdef USE_TOOLKIT_SCROLL_BARS
747 /* If the fringe is adjacent to the left (right) scroll bar of a
748 leftmost (rightmost, respectively) window, then extend its
749 background to the gap between the fringe and the bar. */
750 if ((WINDOW_LEFTMOST_P (w)
751 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
752 || (WINDOW_RIGHTMOST_P (w)
753 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
755 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
757 if (sb_width > 0)
759 int left = WINDOW_SCROLL_BAR_AREA_X (w);
760 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
761 * FRAME_COLUMN_WIDTH (f));
763 if (bx < 0)
765 /* Bitmap fills the fringe. */
766 if (left + width == p->x)
767 bx = left + sb_width;
768 else if (p->x + p->wd == left)
769 bx = left;
770 if (bx >= 0)
772 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
774 nx = width - sb_width;
775 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
776 row->y));
777 ny = row->visible_height;
780 else
782 if (left + width == bx)
784 bx = left + sb_width;
785 nx += width - sb_width;
787 else if (bx + nx == left)
788 nx += width - sb_width;
792 #endif
793 if (bx >= 0 && nx > 0)
794 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
796 if (!face->stipple)
797 XSetForeground (display, face->gc, face->foreground);
800 if (p->which)
802 unsigned char *bits;
803 Pixmap pixmap, clipmask = (Pixmap) 0;
804 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
805 XGCValues gcv;
807 if (p->wd > 8)
808 bits = (unsigned char *)(p->bits + p->dh);
809 else
810 bits = (unsigned char *)p->bits + p->dh;
812 /* Draw the bitmap. I believe these small pixmaps can be cached
813 by the server. */
814 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
815 (p->cursor_p
816 ? (p->overlay_p ? face->background
817 : f->output_data.x->cursor_pixel)
818 : face->foreground),
819 face->background, depth);
821 if (p->overlay_p)
823 clipmask = XCreatePixmapFromBitmapData (display,
824 FRAME_X_DISPLAY_INFO (f)->root_window,
825 bits, p->wd, p->h,
826 1, 0, 1);
827 gcv.clip_mask = clipmask;
828 gcv.clip_x_origin = p->x;
829 gcv.clip_y_origin = p->y;
830 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
833 XCopyArea (display, pixmap, window, gc, 0, 0,
834 p->wd, p->h, p->x, p->y);
835 XFreePixmap (display, pixmap);
837 if (p->overlay_p)
839 gcv.clip_mask = (Pixmap) 0;
840 XChangeGC (display, gc, GCClipMask, &gcv);
841 XFreePixmap (display, clipmask);
845 XSetClipMask (display, gc, None);
850 /* This is called when starting Emacs and when restarting after
851 suspend. When starting Emacs, no X window is mapped. And nothing
852 must be done to Emacs's own window if it is suspended (though that
853 rarely happens). */
855 static void
856 XTset_terminal_modes (struct terminal *terminal)
860 /* This is called when exiting or suspending Emacs. Exiting will make
861 the X-windows go away, and suspending requires no action. */
863 static void
864 XTreset_terminal_modes (struct terminal *terminal)
869 /***********************************************************************
870 Glyph display
871 ***********************************************************************/
875 static void x_set_glyph_string_clipping (struct glyph_string *);
876 static void x_set_glyph_string_gc (struct glyph_string *);
877 static void x_draw_glyph_string_background (struct glyph_string *,
878 int);
879 static void x_draw_glyph_string_foreground (struct glyph_string *);
880 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
881 static void x_draw_glyph_string_box (struct glyph_string *);
882 static void x_draw_glyph_string (struct glyph_string *);
883 static void x_compute_glyph_string_overhangs (struct glyph_string *);
884 static void x_set_cursor_gc (struct glyph_string *);
885 static void x_set_mode_line_face_gc (struct glyph_string *);
886 static void x_set_mouse_face_gc (struct glyph_string *);
887 static int x_alloc_lighter_color (struct frame *, Display *, Colormap,
888 unsigned long *, double, int);
889 static void x_setup_relief_color (struct frame *, struct relief *,
890 double, int, unsigned long);
891 static void x_setup_relief_colors (struct glyph_string *);
892 static void x_draw_image_glyph_string (struct glyph_string *);
893 static void x_draw_image_relief (struct glyph_string *);
894 static void x_draw_image_foreground (struct glyph_string *);
895 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
896 static void x_clear_glyph_string_rect (struct glyph_string *, int,
897 int, int, int);
898 static void x_draw_relief_rect (struct frame *, int, int, int, int,
899 int, int, int, int, int, int,
900 XRectangle *);
901 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
902 int, int, int, XRectangle *);
904 #if GLYPH_DEBUG
905 static void x_check_font (struct frame *, struct font *);
906 #endif
909 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
910 face. */
912 static void
913 x_set_cursor_gc (struct glyph_string *s)
915 if (s->font == FRAME_FONT (s->f)
916 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
917 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
918 && !s->cmp)
919 s->gc = s->f->output_data.x->cursor_gc;
920 else
922 /* Cursor on non-default face: must merge. */
923 XGCValues xgcv;
924 unsigned long mask;
926 xgcv.background = s->f->output_data.x->cursor_pixel;
927 xgcv.foreground = s->face->background;
929 /* If the glyph would be invisible, try a different foreground. */
930 if (xgcv.foreground == xgcv.background)
931 xgcv.foreground = s->face->foreground;
932 if (xgcv.foreground == xgcv.background)
933 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
934 if (xgcv.foreground == xgcv.background)
935 xgcv.foreground = s->face->foreground;
937 /* Make sure the cursor is distinct from text in this face. */
938 if (xgcv.background == s->face->background
939 && xgcv.foreground == s->face->foreground)
941 xgcv.background = s->face->foreground;
942 xgcv.foreground = s->face->background;
945 IF_DEBUG (x_check_font (s->f, s->font));
946 xgcv.graphics_exposures = False;
947 mask = GCForeground | GCBackground | GCGraphicsExposures;
949 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
950 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
951 mask, &xgcv);
952 else
953 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
954 = XCreateGC (s->display, s->window, mask, &xgcv);
956 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
961 /* Set up S->gc of glyph string S for drawing text in mouse face. */
963 static void
964 x_set_mouse_face_gc (struct glyph_string *s)
966 int face_id;
967 struct face *face;
969 /* What face has to be used last for the mouse face? */
970 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
971 face = FACE_FROM_ID (s->f, face_id);
972 if (face == NULL)
973 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
975 if (s->first_glyph->type == CHAR_GLYPH)
976 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
977 else
978 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
979 s->face = FACE_FROM_ID (s->f, face_id);
980 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
982 if (s->font == s->face->font)
983 s->gc = s->face->gc;
984 else
986 /* Otherwise construct scratch_cursor_gc with values from FACE
987 except for FONT. */
988 XGCValues xgcv;
989 unsigned long mask;
991 xgcv.background = s->face->background;
992 xgcv.foreground = s->face->foreground;
993 xgcv.graphics_exposures = False;
994 mask = GCForeground | GCBackground | GCGraphicsExposures;
996 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
997 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
998 mask, &xgcv);
999 else
1000 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1001 = XCreateGC (s->display, s->window, mask, &xgcv);
1003 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1006 xassert (s->gc != 0);
1010 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1011 Faces to use in the mode line have already been computed when the
1012 matrix was built, so there isn't much to do, here. */
1014 static INLINE void
1015 x_set_mode_line_face_gc (struct glyph_string *s)
1017 s->gc = s->face->gc;
1021 /* Set S->gc of glyph string S for drawing that glyph string. Set
1022 S->stippled_p to a non-zero value if the face of S has a stipple
1023 pattern. */
1025 static INLINE void
1026 x_set_glyph_string_gc (struct glyph_string *s)
1028 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1030 if (s->hl == DRAW_NORMAL_TEXT)
1032 s->gc = s->face->gc;
1033 s->stippled_p = s->face->stipple != 0;
1035 else if (s->hl == DRAW_INVERSE_VIDEO)
1037 x_set_mode_line_face_gc (s);
1038 s->stippled_p = s->face->stipple != 0;
1040 else if (s->hl == DRAW_CURSOR)
1042 x_set_cursor_gc (s);
1043 s->stippled_p = 0;
1045 else if (s->hl == DRAW_MOUSE_FACE)
1047 x_set_mouse_face_gc (s);
1048 s->stippled_p = s->face->stipple != 0;
1050 else if (s->hl == DRAW_IMAGE_RAISED
1051 || s->hl == DRAW_IMAGE_SUNKEN)
1053 s->gc = s->face->gc;
1054 s->stippled_p = s->face->stipple != 0;
1056 else
1058 s->gc = s->face->gc;
1059 s->stippled_p = s->face->stipple != 0;
1062 /* GC must have been set. */
1063 xassert (s->gc != 0);
1067 /* Set clipping for output of glyph string S. S may be part of a mode
1068 line or menu if we don't have X toolkit support. */
1070 static INLINE void
1071 x_set_glyph_string_clipping (struct glyph_string *s)
1073 XRectangle *r = s->clip;
1074 int n = get_glyph_string_clip_rects (s, r, 2);
1076 if (n > 0)
1077 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1078 s->num_clips = n;
1082 /* Set SRC's clipping for output of glyph string DST. This is called
1083 when we are drawing DST's left_overhang or right_overhang only in
1084 the area of SRC. */
1086 static void
1087 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1089 XRectangle r;
1091 r.x = src->x;
1092 r.width = src->width;
1093 r.y = src->y;
1094 r.height = src->height;
1095 dst->clip[0] = r;
1096 dst->num_clips = 1;
1097 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1101 /* RIF:
1102 Compute left and right overhang of glyph string S. */
1104 static void
1105 x_compute_glyph_string_overhangs (struct glyph_string *s)
1107 if (s->cmp == NULL
1108 && (s->first_glyph->type == CHAR_GLYPH
1109 || s->first_glyph->type == COMPOSITE_GLYPH))
1111 struct font_metrics metrics;
1113 if (s->first_glyph->type == CHAR_GLYPH)
1115 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1116 struct font *font = s->font;
1117 int i;
1119 for (i = 0; i < s->nchars; i++)
1120 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1121 font->driver->text_extents (font, code, s->nchars, &metrics);
1123 else
1125 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1127 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1129 s->right_overhang = (metrics.rbearing > metrics.width
1130 ? metrics.rbearing - metrics.width : 0);
1131 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1133 else if (s->cmp)
1135 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1136 s->left_overhang = - s->cmp->lbearing;
1141 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1143 static INLINE void
1144 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1146 XGCValues xgcv;
1147 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1148 XSetForeground (s->display, s->gc, xgcv.background);
1149 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1150 XSetForeground (s->display, s->gc, xgcv.foreground);
1154 /* Draw the background of glyph_string S. If S->background_filled_p
1155 is non-zero don't draw it. FORCE_P non-zero means draw the
1156 background even if it wouldn't be drawn normally. This is used
1157 when a string preceding S draws into the background of S, or S
1158 contains the first component of a composition. */
1160 static void
1161 x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1163 /* Nothing to do if background has already been drawn or if it
1164 shouldn't be drawn in the first place. */
1165 if (!s->background_filled_p)
1167 int box_line_width = max (s->face->box_line_width, 0);
1169 if (s->stippled_p)
1171 /* Fill background with a stipple pattern. */
1172 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1173 XFillRectangle (s->display, s->window, s->gc, s->x,
1174 s->y + box_line_width,
1175 s->background_width,
1176 s->height - 2 * box_line_width);
1177 XSetFillStyle (s->display, s->gc, FillSolid);
1178 s->background_filled_p = 1;
1180 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1181 || s->font_not_found_p
1182 || s->extends_to_end_of_line_p
1183 || force_p)
1185 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1186 s->background_width,
1187 s->height - 2 * box_line_width);
1188 s->background_filled_p = 1;
1194 /* Draw the foreground of glyph string S. */
1196 static void
1197 x_draw_glyph_string_foreground (struct glyph_string *s)
1199 int i, x;
1201 /* If first glyph of S has a left box line, start drawing the text
1202 of S to the right of that box line. */
1203 if (s->face->box != FACE_NO_BOX
1204 && s->first_glyph->left_box_line_p)
1205 x = s->x + eabs (s->face->box_line_width);
1206 else
1207 x = s->x;
1209 /* Draw characters of S as rectangles if S's font could not be
1210 loaded. */
1211 if (s->font_not_found_p)
1213 for (i = 0; i < s->nchars; ++i)
1215 struct glyph *g = s->first_glyph + i;
1216 XDrawRectangle (s->display, s->window,
1217 s->gc, x, s->y, g->pixel_width - 1,
1218 s->height - 1);
1219 x += g->pixel_width;
1222 else
1224 struct font *font = s->font;
1225 int boff = font->baseline_offset;
1226 int y;
1228 if (font->vertical_centering)
1229 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1231 y = s->ybase - boff;
1232 if (s->for_overlaps
1233 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1234 font->driver->draw (s, 0, s->nchars, x, y, 0);
1235 else
1236 font->driver->draw (s, 0, s->nchars, x, y, 1);
1237 if (s->face->overstrike)
1238 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1242 /* Draw the foreground of composite glyph string S. */
1244 static void
1245 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1247 int i, j, x;
1248 struct font *font = s->font;
1250 /* If first glyph of S has a left box line, start drawing the text
1251 of S to the right of that box line. */
1252 if (s->face && s->face->box != FACE_NO_BOX
1253 && s->first_glyph->left_box_line_p)
1254 x = s->x + eabs (s->face->box_line_width);
1255 else
1256 x = s->x;
1258 /* S is a glyph string for a composition. S->cmp_from is the index
1259 of the first character drawn for glyphs of this composition.
1260 S->cmp_from == 0 means we are drawing the very first character of
1261 this composition. */
1263 /* Draw a rectangle for the composition if the font for the very
1264 first character of the composition could not be loaded. */
1265 if (s->font_not_found_p)
1267 if (s->cmp_from == 0)
1268 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1269 s->width - 1, s->height - 1);
1271 else if (! s->first_glyph->u.cmp.automatic)
1273 int y = s->ybase;
1275 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1276 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1278 int xx = x + s->cmp->offsets[j * 2];
1279 int yy = y - s->cmp->offsets[j * 2 + 1];
1281 font->driver->draw (s, j, j + 1, xx, yy, 0);
1282 if (s->face->overstrike)
1283 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1286 else
1288 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1289 Lisp_Object glyph;
1290 int y = s->ybase;
1291 int width = 0;
1293 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1295 glyph = LGSTRING_GLYPH (gstring, i);
1296 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1297 width += LGLYPH_WIDTH (glyph);
1298 else
1300 int xoff, yoff, wadjust;
1302 if (j < i)
1304 font->driver->draw (s, j, i, x, y, 0);
1305 if (s->face->overstrike)
1306 font->driver->draw (s, j, i, x + 1, y, 0);
1307 x += width;
1309 xoff = LGLYPH_XOFF (glyph);
1310 yoff = LGLYPH_YOFF (glyph);
1311 wadjust = LGLYPH_WADJUST (glyph);
1312 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1313 if (s->face->overstrike)
1314 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1315 x += wadjust;
1316 j = i + 1;
1317 width = 0;
1320 if (j < i)
1322 font->driver->draw (s, j, i, x, y, 0);
1323 if (s->face->overstrike)
1324 font->driver->draw (s, j, i, x + 1, y, 0);
1330 /* Draw the foreground of glyph string S for glyphless characters. */
1332 static void
1333 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1335 struct glyph *glyph = s->first_glyph;
1336 XChar2b char2b[8];
1337 int x, i, j;
1339 /* If first glyph of S has a left box line, start drawing the text
1340 of S to the right of that box line. */
1341 if (s->face && s->face->box != FACE_NO_BOX
1342 && s->first_glyph->left_box_line_p)
1343 x = s->x + eabs (s->face->box_line_width);
1344 else
1345 x = s->x;
1347 s->char2b = char2b;
1349 for (i = 0; i < s->nchars; i++, glyph++)
1351 char buf[7], *str = NULL;
1352 int len = glyph->u.glyphless.len;
1354 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1356 if (len > 0
1357 && CHAR_TABLE_P (Vglyphless_char_display)
1358 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1359 >= 1))
1361 Lisp_Object acronym
1362 = (! glyph->u.glyphless.for_no_font
1363 ? CHAR_TABLE_REF (Vglyphless_char_display,
1364 glyph->u.glyphless.ch)
1365 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1366 if (STRINGP (acronym))
1367 str = (char *) SDATA (acronym);
1370 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1372 sprintf ((char *) buf, "%0*X",
1373 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1374 glyph->u.glyphless.ch);
1375 str = buf;
1378 if (str)
1380 int upper_len = (len + 1) / 2;
1381 unsigned code;
1383 /* It is assured that all LEN characters in STR is ASCII. */
1384 for (j = 0; j < len; j++)
1386 code = s->font->driver->encode_char (s->font, str[j]);
1387 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1389 s->font->driver->draw (s, 0, upper_len,
1390 x + glyph->slice.glyphless.upper_xoff,
1391 s->ybase + glyph->slice.glyphless.upper_yoff,
1393 s->font->driver->draw (s, upper_len, len,
1394 x + glyph->slice.glyphless.lower_xoff,
1395 s->ybase + glyph->slice.glyphless.lower_yoff,
1398 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1399 XDrawRectangle (s->display, s->window, s->gc,
1400 x, s->ybase - glyph->ascent,
1401 glyph->pixel_width - 1,
1402 glyph->ascent + glyph->descent - 1);
1403 x += glyph->pixel_width;
1407 #ifdef USE_X_TOOLKIT
1409 static struct frame *x_frame_of_widget (Widget);
1410 static Boolean cvt_string_to_pixel (Display *, XrmValue *, Cardinal *,
1411 XrmValue *, XrmValue *, XtPointer *);
1412 static void cvt_pixel_dtor (XtAppContext, XrmValue *, XtPointer,
1413 XrmValue *, Cardinal *);
1416 /* Return the frame on which widget WIDGET is used.. Abort if frame
1417 cannot be determined. */
1419 static struct frame *
1420 x_frame_of_widget (Widget widget)
1422 struct x_display_info *dpyinfo;
1423 Lisp_Object tail;
1424 struct frame *f;
1426 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1428 /* Find the top-level shell of the widget. Note that this function
1429 can be called when the widget is not yet realized, so XtWindow
1430 (widget) == 0. That's the reason we can't simply use
1431 x_any_window_to_frame. */
1432 while (!XtIsTopLevelShell (widget))
1433 widget = XtParent (widget);
1435 /* Look for a frame with that top-level widget. Allocate the color
1436 on that frame to get the right gamma correction value. */
1437 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1438 if (FRAMEP (XCAR (tail))
1439 && (f = XFRAME (XCAR (tail)),
1440 (FRAME_X_P (f)
1441 && f->output_data.nothing != 1
1442 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1443 && f->output_data.x->widget == widget)
1444 return f;
1446 abort ();
1450 /* Allocate the color COLOR->pixel on the screen and display of
1451 widget WIDGET in colormap CMAP. If an exact match cannot be
1452 allocated, try the nearest color available. Value is non-zero
1453 if successful. This is called from lwlib. */
1456 x_alloc_nearest_color_for_widget (Widget widget, Colormap cmap, XColor *color)
1458 struct frame *f = x_frame_of_widget (widget);
1459 return x_alloc_nearest_color (f, cmap, color);
1463 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1464 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1465 If this produces the same color as PIXEL, try a color where all RGB
1466 values have DELTA added. Return the allocated color in *PIXEL.
1467 DISPLAY is the X display, CMAP is the colormap to operate on.
1468 Value is non-zero if successful. */
1471 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1472 unsigned long *pixel, double factor, int delta)
1474 struct frame *f = x_frame_of_widget (widget);
1475 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1479 /* Structure specifying which arguments should be passed by Xt to
1480 cvt_string_to_pixel. We want the widget's screen and colormap. */
1482 static XtConvertArgRec cvt_string_to_pixel_args[] =
1484 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1485 sizeof (Screen *)},
1486 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1487 sizeof (Colormap)}
1491 /* The address of this variable is returned by
1492 cvt_string_to_pixel. */
1494 static Pixel cvt_string_to_pixel_value;
1497 /* Convert a color name to a pixel color.
1499 DPY is the display we are working on.
1501 ARGS is an array of *NARGS XrmValue structures holding additional
1502 information about the widget for which the conversion takes place.
1503 The contents of this array are determined by the specification
1504 in cvt_string_to_pixel_args.
1506 FROM is a pointer to an XrmValue which points to the color name to
1507 convert. TO is an XrmValue in which to return the pixel color.
1509 CLOSURE_RET is a pointer to user-data, in which we record if
1510 we allocated the color or not.
1512 Value is True if successful, False otherwise. */
1514 static Boolean
1515 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1516 XrmValue *from, XrmValue *to,
1517 XtPointer *closure_ret)
1519 Screen *screen;
1520 Colormap cmap;
1521 Pixel pixel;
1522 String color_name;
1523 XColor color;
1525 if (*nargs != 2)
1527 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1528 "wrongParameters", "cvt_string_to_pixel",
1529 "XtToolkitError",
1530 "Screen and colormap args required", NULL, NULL);
1531 return False;
1534 screen = *(Screen **) args[0].addr;
1535 cmap = *(Colormap *) args[1].addr;
1536 color_name = (String) from->addr;
1538 if (strcmp (color_name, XtDefaultBackground) == 0)
1540 *closure_ret = (XtPointer) False;
1541 pixel = WhitePixelOfScreen (screen);
1543 else if (strcmp (color_name, XtDefaultForeground) == 0)
1545 *closure_ret = (XtPointer) False;
1546 pixel = BlackPixelOfScreen (screen);
1548 else if (XParseColor (dpy, cmap, color_name, &color)
1549 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1551 pixel = color.pixel;
1552 *closure_ret = (XtPointer) True;
1554 else
1556 String params[1];
1557 Cardinal nparams = 1;
1559 params[0] = color_name;
1560 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1561 "badValue", "cvt_string_to_pixel",
1562 "XtToolkitError", "Invalid color `%s'",
1563 params, &nparams);
1564 return False;
1567 if (to->addr != NULL)
1569 if (to->size < sizeof (Pixel))
1571 to->size = sizeof (Pixel);
1572 return False;
1575 *(Pixel *) to->addr = pixel;
1577 else
1579 cvt_string_to_pixel_value = pixel;
1580 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1583 to->size = sizeof (Pixel);
1584 return True;
1588 /* Free a pixel color which was previously allocated via
1589 cvt_string_to_pixel. This is registered as the destructor
1590 for this type of resource via XtSetTypeConverter.
1592 APP is the application context in which we work.
1594 TO is a pointer to an XrmValue holding the color to free.
1595 CLOSURE is the value we stored in CLOSURE_RET for this color
1596 in cvt_string_to_pixel.
1598 ARGS and NARGS are like for cvt_string_to_pixel. */
1600 static void
1601 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1602 Cardinal *nargs)
1604 if (*nargs != 2)
1606 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1607 "XtToolkitError",
1608 "Screen and colormap arguments required",
1609 NULL, NULL);
1611 else if (closure != NULL)
1613 /* We did allocate the pixel, so free it. */
1614 Screen *screen = *(Screen **) args[0].addr;
1615 Colormap cmap = *(Colormap *) args[1].addr;
1616 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1617 (Pixel *) to->addr, 1);
1622 #endif /* USE_X_TOOLKIT */
1625 /* Value is an array of XColor structures for the contents of the
1626 color map of display DPY. Set *NCELLS to the size of the array.
1627 Note that this probably shouldn't be called for large color maps,
1628 say a 24-bit TrueColor map. */
1630 static const XColor *
1631 x_color_cells (Display *dpy, int *ncells)
1633 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1635 if (dpyinfo->color_cells == NULL)
1637 Screen *screen = dpyinfo->screen;
1638 int i;
1640 dpyinfo->ncolor_cells
1641 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1642 dpyinfo->color_cells
1643 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1644 * sizeof *dpyinfo->color_cells);
1646 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1647 dpyinfo->color_cells[i].pixel = i;
1649 XQueryColors (dpy, dpyinfo->cmap,
1650 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1653 *ncells = dpyinfo->ncolor_cells;
1654 return dpyinfo->color_cells;
1658 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1659 colors in COLORS. Use cached information, if available. */
1661 void
1662 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1664 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1666 if (dpyinfo->color_cells)
1668 int i;
1669 for (i = 0; i < ncolors; ++i)
1671 unsigned long pixel = colors[i].pixel;
1672 xassert (pixel < dpyinfo->ncolor_cells);
1673 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1674 colors[i] = dpyinfo->color_cells[pixel];
1677 else
1678 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1682 /* On frame F, translate pixel color to RGB values for the color in
1683 COLOR. Use cached information, if available. */
1685 void
1686 x_query_color (struct frame *f, XColor *color)
1688 x_query_colors (f, color, 1);
1692 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1693 exact match can't be allocated, try the nearest color available.
1694 Value is non-zero if successful. Set *COLOR to the color
1695 allocated. */
1697 static int
1698 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1700 int rc;
1702 rc = XAllocColor (dpy, cmap, color);
1703 if (rc == 0)
1705 /* If we got to this point, the colormap is full, so we're going
1706 to try to get the next closest color. The algorithm used is
1707 a least-squares matching, which is what X uses for closest
1708 color matching with StaticColor visuals. */
1709 int nearest, i;
1710 unsigned long nearest_delta = ~0;
1711 int ncells;
1712 const XColor *cells = x_color_cells (dpy, &ncells);
1714 for (nearest = i = 0; i < ncells; ++i)
1716 long dred = (color->red >> 8) - (cells[i].red >> 8);
1717 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1718 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1719 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1721 if (delta < nearest_delta)
1723 nearest = i;
1724 nearest_delta = delta;
1728 color->red = cells[nearest].red;
1729 color->green = cells[nearest].green;
1730 color->blue = cells[nearest].blue;
1731 rc = XAllocColor (dpy, cmap, color);
1733 else
1735 /* If allocation succeeded, and the allocated pixel color is not
1736 equal to a cached pixel color recorded earlier, there was a
1737 change in the colormap, so clear the color cache. */
1738 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1739 XColor *cached_color;
1741 if (dpyinfo->color_cells
1742 && (cached_color = &dpyinfo->color_cells[color->pixel],
1743 (cached_color->red != color->red
1744 || cached_color->blue != color->blue
1745 || cached_color->green != color->green)))
1747 xfree (dpyinfo->color_cells);
1748 dpyinfo->color_cells = NULL;
1749 dpyinfo->ncolor_cells = 0;
1753 #ifdef DEBUG_X_COLORS
1754 if (rc)
1755 register_color (color->pixel);
1756 #endif /* DEBUG_X_COLORS */
1758 return rc;
1762 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1763 exact match can't be allocated, try the nearest color available.
1764 Value is non-zero if successful. Set *COLOR to the color
1765 allocated. */
1768 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1770 gamma_correct (f, color);
1771 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1775 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1776 It's necessary to do this instead of just using PIXEL directly to
1777 get color reference counts right. */
1779 unsigned long
1780 x_copy_color (struct frame *f, long unsigned int pixel)
1782 XColor color;
1784 color.pixel = pixel;
1785 BLOCK_INPUT;
1786 x_query_color (f, &color);
1787 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1788 UNBLOCK_INPUT;
1789 #ifdef DEBUG_X_COLORS
1790 register_color (pixel);
1791 #endif
1792 return color.pixel;
1796 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1797 It's necessary to do this instead of just using PIXEL directly to
1798 get color reference counts right. */
1800 unsigned long
1801 x_copy_dpy_color (Display *dpy, Colormap cmap, long unsigned int pixel)
1803 XColor color;
1805 color.pixel = pixel;
1806 BLOCK_INPUT;
1807 XQueryColor (dpy, cmap, &color);
1808 XAllocColor (dpy, cmap, &color);
1809 UNBLOCK_INPUT;
1810 #ifdef DEBUG_X_COLORS
1811 register_color (pixel);
1812 #endif
1813 return color.pixel;
1817 /* Brightness beyond which a color won't have its highlight brightness
1818 boosted.
1820 Nominally, highlight colors for `3d' faces are calculated by
1821 brightening an object's color by a constant scale factor, but this
1822 doesn't yield good results for dark colors, so for colors who's
1823 brightness is less than this value (on a scale of 0-65535) have an
1824 use an additional additive factor.
1826 The value here is set so that the default menu-bar/mode-line color
1827 (grey75) will not have its highlights changed at all. */
1828 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1831 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1832 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1833 If this produces the same color as PIXEL, try a color where all RGB
1834 values have DELTA added. Return the allocated color in *PIXEL.
1835 DISPLAY is the X display, CMAP is the colormap to operate on.
1836 Value is non-zero if successful. */
1838 static int
1839 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1841 XColor color, new;
1842 long bright;
1843 int success_p;
1845 /* Get RGB color values. */
1846 color.pixel = *pixel;
1847 x_query_color (f, &color);
1849 /* Change RGB values by specified FACTOR. Avoid overflow! */
1850 xassert (factor >= 0);
1851 new.red = min (0xffff, factor * color.red);
1852 new.green = min (0xffff, factor * color.green);
1853 new.blue = min (0xffff, factor * color.blue);
1855 /* Calculate brightness of COLOR. */
1856 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1858 /* We only boost colors that are darker than
1859 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1860 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1861 /* Make an additive adjustment to NEW, because it's dark enough so
1862 that scaling by FACTOR alone isn't enough. */
1864 /* How far below the limit this color is (0 - 1, 1 being darker). */
1865 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1866 /* The additive adjustment. */
1867 int min_delta = delta * dimness * factor / 2;
1869 if (factor < 1)
1871 new.red = max (0, new.red - min_delta);
1872 new.green = max (0, new.green - min_delta);
1873 new.blue = max (0, new.blue - min_delta);
1875 else
1877 new.red = min (0xffff, min_delta + new.red);
1878 new.green = min (0xffff, min_delta + new.green);
1879 new.blue = min (0xffff, min_delta + new.blue);
1883 /* Try to allocate the color. */
1884 success_p = x_alloc_nearest_color (f, cmap, &new);
1885 if (success_p)
1887 if (new.pixel == *pixel)
1889 /* If we end up with the same color as before, try adding
1890 delta to the RGB values. */
1891 x_free_colors (f, &new.pixel, 1);
1893 new.red = min (0xffff, delta + color.red);
1894 new.green = min (0xffff, delta + color.green);
1895 new.blue = min (0xffff, delta + color.blue);
1896 success_p = x_alloc_nearest_color (f, cmap, &new);
1898 else
1899 success_p = 1;
1900 *pixel = new.pixel;
1903 return success_p;
1907 /* Set up the foreground color for drawing relief lines of glyph
1908 string S. RELIEF is a pointer to a struct relief containing the GC
1909 with which lines will be drawn. Use a color that is FACTOR or
1910 DELTA lighter or darker than the relief's background which is found
1911 in S->f->output_data.x->relief_background. If such a color cannot
1912 be allocated, use DEFAULT_PIXEL, instead. */
1914 static void
1915 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1917 XGCValues xgcv;
1918 struct x_output *di = f->output_data.x;
1919 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1920 unsigned long pixel;
1921 unsigned long background = di->relief_background;
1922 Colormap cmap = FRAME_X_COLORMAP (f);
1923 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1924 Display *dpy = FRAME_X_DISPLAY (f);
1926 xgcv.graphics_exposures = False;
1927 xgcv.line_width = 1;
1929 /* Free previously allocated color. The color cell will be reused
1930 when it has been freed as many times as it was allocated, so this
1931 doesn't affect faces using the same colors. */
1932 if (relief->gc
1933 && relief->allocated_p)
1935 x_free_colors (f, &relief->pixel, 1);
1936 relief->allocated_p = 0;
1939 /* Allocate new color. */
1940 xgcv.foreground = default_pixel;
1941 pixel = background;
1942 if (dpyinfo->n_planes != 1
1943 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1945 relief->allocated_p = 1;
1946 xgcv.foreground = relief->pixel = pixel;
1949 if (relief->gc == 0)
1951 xgcv.stipple = dpyinfo->gray;
1952 mask |= GCStipple;
1953 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1955 else
1956 XChangeGC (dpy, relief->gc, mask, &xgcv);
1960 /* Set up colors for the relief lines around glyph string S. */
1962 static void
1963 x_setup_relief_colors (struct glyph_string *s)
1965 struct x_output *di = s->f->output_data.x;
1966 unsigned long color;
1968 if (s->face->use_box_color_for_shadows_p)
1969 color = s->face->box_color;
1970 else if (s->first_glyph->type == IMAGE_GLYPH
1971 && s->img->pixmap
1972 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1973 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1974 else
1976 XGCValues xgcv;
1978 /* Get the background color of the face. */
1979 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1980 color = xgcv.background;
1983 if (di->white_relief.gc == 0
1984 || color != di->relief_background)
1986 di->relief_background = color;
1987 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1988 WHITE_PIX_DEFAULT (s->f));
1989 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1990 BLACK_PIX_DEFAULT (s->f));
1995 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
1996 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
1997 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
1998 relief. LEFT_P non-zero means draw a relief on the left side of
1999 the rectangle. RIGHT_P non-zero means draw a relief on the right
2000 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2001 when drawing. */
2003 static void
2004 x_draw_relief_rect (struct frame *f,
2005 int left_x, int top_y, int right_x, int bottom_y, int width,
2006 int raised_p, int top_p, int bot_p, int left_p, int right_p,
2007 XRectangle *clip_rect)
2009 Display *dpy = FRAME_X_DISPLAY (f);
2010 Window window = FRAME_X_WINDOW (f);
2011 int i;
2012 GC gc;
2014 if (raised_p)
2015 gc = f->output_data.x->white_relief.gc;
2016 else
2017 gc = f->output_data.x->black_relief.gc;
2018 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2020 /* This code is more complicated than it has to be, because of two
2021 minor hacks to make the boxes look nicer: (i) if width > 1, draw
2022 the outermost line using the black relief. (ii) Omit the four
2023 corner pixels. */
2025 /* Top. */
2026 if (top_p)
2028 if (width == 1)
2029 XDrawLine (dpy, window, gc,
2030 left_x + (left_p ? 1 : 0), top_y,
2031 right_x + (right_p ? 0 : 1), top_y);
2033 for (i = 1; i < width; ++i)
2034 XDrawLine (dpy, window, gc,
2035 left_x + i * left_p, top_y + i,
2036 right_x + 1 - i * right_p, top_y + i);
2039 /* Left. */
2040 if (left_p)
2042 if (width == 1)
2043 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2045 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2046 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2048 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2049 XDrawLine (dpy, window, gc,
2050 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2053 XSetClipMask (dpy, gc, None);
2054 if (raised_p)
2055 gc = f->output_data.x->black_relief.gc;
2056 else
2057 gc = f->output_data.x->white_relief.gc;
2058 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2060 if (width > 1)
2062 /* Outermost top line. */
2063 if (top_p)
2064 XDrawLine (dpy, window, gc,
2065 left_x + (left_p ? 1 : 0), top_y,
2066 right_x + (right_p ? 0 : 1), top_y);
2068 /* Outermost left line. */
2069 if (left_p)
2070 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2073 /* Bottom. */
2074 if (bot_p)
2076 XDrawLine (dpy, window, gc,
2077 left_x + (left_p ? 1 : 0), bottom_y,
2078 right_x + (right_p ? 0 : 1), bottom_y);
2079 for (i = 1; i < width; ++i)
2080 XDrawLine (dpy, window, gc,
2081 left_x + i * left_p, bottom_y - i,
2082 right_x + 1 - i * right_p, bottom_y - i);
2085 /* Right. */
2086 if (right_p)
2088 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2089 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2090 for (i = 0; i < width; ++i)
2091 XDrawLine (dpy, window, gc,
2092 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2095 XSetClipMask (dpy, gc, None);
2099 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2100 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2101 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2102 left side of the rectangle. RIGHT_P non-zero means draw a line
2103 on the right side of the rectangle. CLIP_RECT is the clipping
2104 rectangle to use when drawing. */
2106 static void
2107 x_draw_box_rect (struct glyph_string *s,
2108 int left_x, int top_y, int right_x, int bottom_y, int width,
2109 int left_p, int right_p, XRectangle *clip_rect)
2111 XGCValues xgcv;
2113 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2114 XSetForeground (s->display, s->gc, s->face->box_color);
2115 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2117 /* Top. */
2118 XFillRectangle (s->display, s->window, s->gc,
2119 left_x, top_y, right_x - left_x + 1, width);
2121 /* Left. */
2122 if (left_p)
2123 XFillRectangle (s->display, s->window, s->gc,
2124 left_x, top_y, width, bottom_y - top_y + 1);
2126 /* Bottom. */
2127 XFillRectangle (s->display, s->window, s->gc,
2128 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2130 /* Right. */
2131 if (right_p)
2132 XFillRectangle (s->display, s->window, s->gc,
2133 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2135 XSetForeground (s->display, s->gc, xgcv.foreground);
2136 XSetClipMask (s->display, s->gc, None);
2140 /* Draw a box around glyph string S. */
2142 static void
2143 x_draw_glyph_string_box (struct glyph_string *s)
2145 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2146 int left_p, right_p;
2147 struct glyph *last_glyph;
2148 XRectangle clip_rect;
2150 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2151 ? WINDOW_RIGHT_EDGE_X (s->w)
2152 : window_box_right (s->w, s->area));
2154 /* The glyph that may have a right box line. */
2155 last_glyph = (s->cmp || s->img
2156 ? s->first_glyph
2157 : s->first_glyph + s->nchars - 1);
2159 width = eabs (s->face->box_line_width);
2160 raised_p = s->face->box == FACE_RAISED_BOX;
2161 left_x = s->x;
2162 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2163 ? last_x - 1
2164 : min (last_x, s->x + s->background_width) - 1);
2165 top_y = s->y;
2166 bottom_y = top_y + s->height - 1;
2168 left_p = (s->first_glyph->left_box_line_p
2169 || (s->hl == DRAW_MOUSE_FACE
2170 && (s->prev == NULL
2171 || s->prev->hl != s->hl)));
2172 right_p = (last_glyph->right_box_line_p
2173 || (s->hl == DRAW_MOUSE_FACE
2174 && (s->next == NULL
2175 || s->next->hl != s->hl)));
2177 get_glyph_string_clip_rect (s, &clip_rect);
2179 if (s->face->box == FACE_SIMPLE_BOX)
2180 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2181 left_p, right_p, &clip_rect);
2182 else
2184 x_setup_relief_colors (s);
2185 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2186 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2191 /* Draw foreground of image glyph string S. */
2193 static void
2194 x_draw_image_foreground (struct glyph_string *s)
2196 int x = s->x;
2197 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2199 /* If first glyph of S has a left box line, start drawing it to the
2200 right of that line. */
2201 if (s->face->box != FACE_NO_BOX
2202 && s->first_glyph->left_box_line_p
2203 && s->slice.x == 0)
2204 x += eabs (s->face->box_line_width);
2206 /* If there is a margin around the image, adjust x- and y-position
2207 by that margin. */
2208 if (s->slice.x == 0)
2209 x += s->img->hmargin;
2210 if (s->slice.y == 0)
2211 y += s->img->vmargin;
2213 if (s->img->pixmap)
2215 if (s->img->mask)
2217 /* We can't set both a clip mask and use XSetClipRectangles
2218 because the latter also sets a clip mask. We also can't
2219 trust on the shape extension to be available
2220 (XShapeCombineRegion). So, compute the rectangle to draw
2221 manually. */
2222 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2223 | GCFunction);
2224 XGCValues xgcv;
2225 XRectangle clip_rect, image_rect, r;
2227 xgcv.clip_mask = s->img->mask;
2228 xgcv.clip_x_origin = x;
2229 xgcv.clip_y_origin = y;
2230 xgcv.function = GXcopy;
2231 XChangeGC (s->display, s->gc, mask, &xgcv);
2233 get_glyph_string_clip_rect (s, &clip_rect);
2234 image_rect.x = x;
2235 image_rect.y = y;
2236 image_rect.width = s->slice.width;
2237 image_rect.height = s->slice.height;
2238 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2239 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2240 s->slice.x + r.x - x, s->slice.y + r.y - y,
2241 r.width, r.height, r.x, r.y);
2243 else
2245 XRectangle clip_rect, image_rect, r;
2247 get_glyph_string_clip_rect (s, &clip_rect);
2248 image_rect.x = x;
2249 image_rect.y = y;
2250 image_rect.width = s->slice.width;
2251 image_rect.height = s->slice.height;
2252 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2253 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2254 s->slice.x + r.x - x, s->slice.y + r.y - y,
2255 r.width, r.height, r.x, r.y);
2257 /* When the image has a mask, we can expect that at
2258 least part of a mouse highlight or a block cursor will
2259 be visible. If the image doesn't have a mask, make
2260 a block cursor visible by drawing a rectangle around
2261 the image. I believe it's looking better if we do
2262 nothing here for mouse-face. */
2263 if (s->hl == DRAW_CURSOR)
2265 int r = s->img->relief;
2266 if (r < 0) r = -r;
2267 XDrawRectangle (s->display, s->window, s->gc,
2268 x - r, y - r,
2269 s->slice.width + r*2 - 1,
2270 s->slice.height + r*2 - 1);
2274 else
2275 /* Draw a rectangle if image could not be loaded. */
2276 XDrawRectangle (s->display, s->window, s->gc, x, y,
2277 s->slice.width - 1, s->slice.height - 1);
2281 /* Draw a relief around the image glyph string S. */
2283 static void
2284 x_draw_image_relief (struct glyph_string *s)
2286 int x0, y0, x1, y1, thick, raised_p, extra;
2287 XRectangle r;
2288 int x = s->x;
2289 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2291 /* If first glyph of S has a left box line, start drawing it to the
2292 right of that line. */
2293 if (s->face->box != FACE_NO_BOX
2294 && s->first_glyph->left_box_line_p
2295 && s->slice.x == 0)
2296 x += eabs (s->face->box_line_width);
2298 /* If there is a margin around the image, adjust x- and y-position
2299 by that margin. */
2300 if (s->slice.x == 0)
2301 x += s->img->hmargin;
2302 if (s->slice.y == 0)
2303 y += s->img->vmargin;
2305 if (s->hl == DRAW_IMAGE_SUNKEN
2306 || s->hl == DRAW_IMAGE_RAISED)
2308 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2309 raised_p = s->hl == DRAW_IMAGE_RAISED;
2311 else
2313 thick = eabs (s->img->relief);
2314 raised_p = s->img->relief > 0;
2317 extra = s->face->id == TOOL_BAR_FACE_ID
2318 ? XINT (Vtool_bar_button_margin) : 0;
2320 x0 = x - thick - extra;
2321 y0 = y - thick - extra;
2322 x1 = x + s->slice.width + thick - 1 + extra;
2323 y1 = y + s->slice.height + thick - 1 + extra;
2325 x_setup_relief_colors (s);
2326 get_glyph_string_clip_rect (s, &r);
2327 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2328 s->slice.y == 0,
2329 s->slice.y + s->slice.height == s->img->height,
2330 s->slice.x == 0,
2331 s->slice.x + s->slice.width == s->img->width,
2332 &r);
2336 /* Draw the foreground of image glyph string S to PIXMAP. */
2338 static void
2339 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2341 int x = 0;
2342 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2344 /* If first glyph of S has a left box line, start drawing it to the
2345 right of that line. */
2346 if (s->face->box != FACE_NO_BOX
2347 && s->first_glyph->left_box_line_p
2348 && s->slice.x == 0)
2349 x += eabs (s->face->box_line_width);
2351 /* If there is a margin around the image, adjust x- and y-position
2352 by that margin. */
2353 if (s->slice.x == 0)
2354 x += s->img->hmargin;
2355 if (s->slice.y == 0)
2356 y += s->img->vmargin;
2358 if (s->img->pixmap)
2360 if (s->img->mask)
2362 /* We can't set both a clip mask and use XSetClipRectangles
2363 because the latter also sets a clip mask. We also can't
2364 trust on the shape extension to be available
2365 (XShapeCombineRegion). So, compute the rectangle to draw
2366 manually. */
2367 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2368 | GCFunction);
2369 XGCValues xgcv;
2371 xgcv.clip_mask = s->img->mask;
2372 xgcv.clip_x_origin = x - s->slice.x;
2373 xgcv.clip_y_origin = y - s->slice.y;
2374 xgcv.function = GXcopy;
2375 XChangeGC (s->display, s->gc, mask, &xgcv);
2377 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2378 s->slice.x, s->slice.y,
2379 s->slice.width, s->slice.height, x, y);
2380 XSetClipMask (s->display, s->gc, None);
2382 else
2384 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2385 s->slice.x, s->slice.y,
2386 s->slice.width, s->slice.height, x, y);
2388 /* When the image has a mask, we can expect that at
2389 least part of a mouse highlight or a block cursor will
2390 be visible. If the image doesn't have a mask, make
2391 a block cursor visible by drawing a rectangle around
2392 the image. I believe it's looking better if we do
2393 nothing here for mouse-face. */
2394 if (s->hl == DRAW_CURSOR)
2396 int r = s->img->relief;
2397 if (r < 0) r = -r;
2398 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2399 s->slice.width + r*2 - 1,
2400 s->slice.height + r*2 - 1);
2404 else
2405 /* Draw a rectangle if image could not be loaded. */
2406 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2407 s->slice.width - 1, s->slice.height - 1);
2411 /* Draw part of the background of glyph string S. X, Y, W, and H
2412 give the rectangle to draw. */
2414 static void
2415 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2417 if (s->stippled_p)
2419 /* Fill background with a stipple pattern. */
2420 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2421 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2422 XSetFillStyle (s->display, s->gc, FillSolid);
2424 else
2425 x_clear_glyph_string_rect (s, x, y, w, h);
2429 /* Draw image glyph string S.
2431 s->y
2432 s->x +-------------------------
2433 | s->face->box
2435 | +-------------------------
2436 | | s->img->margin
2438 | | +-------------------
2439 | | | the image
2443 static void
2444 x_draw_image_glyph_string (struct glyph_string *s)
2446 int box_line_hwidth = eabs (s->face->box_line_width);
2447 int box_line_vwidth = max (s->face->box_line_width, 0);
2448 int height;
2449 Pixmap pixmap = None;
2451 height = s->height;
2452 if (s->slice.y == 0)
2453 height -= box_line_vwidth;
2454 if (s->slice.y + s->slice.height >= s->img->height)
2455 height -= box_line_vwidth;
2457 /* Fill background with face under the image. Do it only if row is
2458 taller than image or if image has a clip mask to reduce
2459 flickering. */
2460 s->stippled_p = s->face->stipple != 0;
2461 if (height > s->slice.height
2462 || s->img->hmargin
2463 || s->img->vmargin
2464 || s->img->mask
2465 || s->img->pixmap == 0
2466 || s->width != s->background_width)
2468 if (s->img->mask)
2470 /* Create a pixmap as large as the glyph string. Fill it
2471 with the background color. Copy the image to it, using
2472 its mask. Copy the temporary pixmap to the display. */
2473 Screen *screen = FRAME_X_SCREEN (s->f);
2474 int depth = DefaultDepthOfScreen (screen);
2476 /* Create a pixmap as large as the glyph string. */
2477 pixmap = XCreatePixmap (s->display, s->window,
2478 s->background_width,
2479 s->height, depth);
2481 /* Don't clip in the following because we're working on the
2482 pixmap. */
2483 XSetClipMask (s->display, s->gc, None);
2485 /* Fill the pixmap with the background color/stipple. */
2486 if (s->stippled_p)
2488 /* Fill background with a stipple pattern. */
2489 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2490 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2491 XFillRectangle (s->display, pixmap, s->gc,
2492 0, 0, s->background_width, s->height);
2493 XSetFillStyle (s->display, s->gc, FillSolid);
2494 XSetTSOrigin (s->display, s->gc, 0, 0);
2496 else
2498 XGCValues xgcv;
2499 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2500 &xgcv);
2501 XSetForeground (s->display, s->gc, xgcv.background);
2502 XFillRectangle (s->display, pixmap, s->gc,
2503 0, 0, s->background_width, s->height);
2504 XSetForeground (s->display, s->gc, xgcv.foreground);
2507 else
2509 int x = s->x;
2510 int y = s->y;
2512 if (s->first_glyph->left_box_line_p
2513 && s->slice.x == 0)
2514 x += box_line_hwidth;
2516 if (s->slice.y == 0)
2517 y += box_line_vwidth;
2519 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2522 s->background_filled_p = 1;
2525 /* Draw the foreground. */
2526 if (pixmap != None)
2528 x_draw_image_foreground_1 (s, pixmap);
2529 x_set_glyph_string_clipping (s);
2530 XCopyArea (s->display, pixmap, s->window, s->gc,
2531 0, 0, s->background_width, s->height, s->x, s->y);
2532 XFreePixmap (s->display, pixmap);
2534 else
2535 x_draw_image_foreground (s);
2537 /* If we must draw a relief around the image, do it. */
2538 if (s->img->relief
2539 || s->hl == DRAW_IMAGE_RAISED
2540 || s->hl == DRAW_IMAGE_SUNKEN)
2541 x_draw_image_relief (s);
2545 /* Draw stretch glyph string S. */
2547 static void
2548 x_draw_stretch_glyph_string (struct glyph_string *s)
2550 xassert (s->first_glyph->type == STRETCH_GLYPH);
2552 if (s->hl == DRAW_CURSOR
2553 && !x_stretch_cursor_p)
2555 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2556 wide as the stretch glyph. */
2557 int width, background_width = s->background_width;
2558 int x = s->x;
2560 if (!s->row->reversed_p)
2562 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2564 if (x < left_x)
2566 background_width -= left_x - x;
2567 x = left_x;
2570 else
2572 /* In R2L rows, draw the cursor on the right edge of the
2573 stretch glyph. */
2574 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2576 if (x + background_width > right_x)
2577 background_width -= x - right_x;
2578 x += background_width;
2580 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2581 if (s->row->reversed_p)
2582 x -= width;
2584 /* Draw cursor. */
2585 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2587 /* Clear rest using the GC of the original non-cursor face. */
2588 if (width < background_width)
2590 int y = s->y;
2591 int w = background_width - width, h = s->height;
2592 XRectangle r;
2593 GC gc;
2595 if (!s->row->reversed_p)
2596 x += width;
2597 else
2598 x = s->x;
2599 if (s->row->mouse_face_p
2600 && cursor_in_mouse_face_p (s->w))
2602 x_set_mouse_face_gc (s);
2603 gc = s->gc;
2605 else
2606 gc = s->face->gc;
2608 get_glyph_string_clip_rect (s, &r);
2609 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2611 if (s->face->stipple)
2613 /* Fill background with a stipple pattern. */
2614 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2615 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2616 XSetFillStyle (s->display, gc, FillSolid);
2618 else
2620 XGCValues xgcv;
2621 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2622 XSetForeground (s->display, gc, xgcv.background);
2623 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2624 XSetForeground (s->display, gc, xgcv.foreground);
2628 else if (!s->background_filled_p)
2630 int background_width = s->background_width;
2631 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2633 /* Don't draw into left margin, fringe or scrollbar area
2634 except for header line and mode line. */
2635 if (x < left_x && !s->row->mode_line_p)
2637 background_width -= left_x - x;
2638 x = left_x;
2640 if (background_width > 0)
2641 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2644 s->background_filled_p = 1;
2648 /* Draw glyph string S. */
2650 static void
2651 x_draw_glyph_string (struct glyph_string *s)
2653 int relief_drawn_p = 0;
2655 /* If S draws into the background of its successors, draw the
2656 background of the successors first so that S can draw into it.
2657 This makes S->next use XDrawString instead of XDrawImageString. */
2658 if (s->next && s->right_overhang && !s->for_overlaps)
2660 int width;
2661 struct glyph_string *next;
2663 for (width = 0, next = s->next;
2664 next && width < s->right_overhang;
2665 width += next->width, next = next->next)
2666 if (next->first_glyph->type != IMAGE_GLYPH)
2668 x_set_glyph_string_gc (next);
2669 x_set_glyph_string_clipping (next);
2670 if (next->first_glyph->type == STRETCH_GLYPH)
2671 x_draw_stretch_glyph_string (next);
2672 else
2673 x_draw_glyph_string_background (next, 1);
2674 next->num_clips = 0;
2678 /* Set up S->gc, set clipping and draw S. */
2679 x_set_glyph_string_gc (s);
2681 /* Draw relief (if any) in advance for char/composition so that the
2682 glyph string can be drawn over it. */
2683 if (!s->for_overlaps
2684 && s->face->box != FACE_NO_BOX
2685 && (s->first_glyph->type == CHAR_GLYPH
2686 || s->first_glyph->type == COMPOSITE_GLYPH))
2689 x_set_glyph_string_clipping (s);
2690 x_draw_glyph_string_background (s, 1);
2691 x_draw_glyph_string_box (s);
2692 x_set_glyph_string_clipping (s);
2693 relief_drawn_p = 1;
2695 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2696 && !s->clip_tail
2697 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2698 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2699 /* We must clip just this glyph. left_overhang part has already
2700 drawn when s->prev was drawn, and right_overhang part will be
2701 drawn later when s->next is drawn. */
2702 x_set_glyph_string_clipping_exactly (s, s);
2703 else
2704 x_set_glyph_string_clipping (s);
2706 switch (s->first_glyph->type)
2708 case IMAGE_GLYPH:
2709 x_draw_image_glyph_string (s);
2710 break;
2712 case STRETCH_GLYPH:
2713 x_draw_stretch_glyph_string (s);
2714 break;
2716 case CHAR_GLYPH:
2717 if (s->for_overlaps)
2718 s->background_filled_p = 1;
2719 else
2720 x_draw_glyph_string_background (s, 0);
2721 x_draw_glyph_string_foreground (s);
2722 break;
2724 case COMPOSITE_GLYPH:
2725 if (s->for_overlaps || (s->cmp_from > 0
2726 && ! s->first_glyph->u.cmp.automatic))
2727 s->background_filled_p = 1;
2728 else
2729 x_draw_glyph_string_background (s, 1);
2730 x_draw_composite_glyph_string_foreground (s);
2731 break;
2733 case GLYPHLESS_GLYPH:
2734 if (s->for_overlaps)
2735 s->background_filled_p = 1;
2736 else
2737 x_draw_glyph_string_background (s, 1);
2738 x_draw_glyphless_glyph_string_foreground (s);
2739 break;
2741 default:
2742 abort ();
2745 if (!s->for_overlaps)
2747 /* Draw underline. */
2748 if (s->face->underline_p)
2750 unsigned long thickness, position;
2751 int y;
2753 if (s->prev && s->prev->face->underline_p)
2755 /* We use the same underline style as the previous one. */
2756 thickness = s->prev->underline_thickness;
2757 position = s->prev->underline_position;
2759 else
2761 /* Get the underline thickness. Default is 1 pixel. */
2762 if (s->font && s->font->underline_thickness > 0)
2763 thickness = s->font->underline_thickness;
2764 else
2765 thickness = 1;
2766 if (x_underline_at_descent_line)
2767 position = (s->height - thickness) - (s->ybase - s->y);
2768 else
2770 /* Get the underline position. This is the recommended
2771 vertical offset in pixels from the baseline to the top of
2772 the underline. This is a signed value according to the
2773 specs, and its default is
2775 ROUND ((maximum descent) / 2), with
2776 ROUND(x) = floor (x + 0.5) */
2778 if (x_use_underline_position_properties
2779 && s->font && s->font->underline_position >= 0)
2780 position = s->font->underline_position;
2781 else if (s->font)
2782 position = (s->font->descent + 1) / 2;
2783 else
2784 position = underline_minimum_offset;
2786 position = max (position, underline_minimum_offset);
2788 /* Check the sanity of thickness and position. We should
2789 avoid drawing underline out of the current line area. */
2790 if (s->y + s->height <= s->ybase + position)
2791 position = (s->height - 1) - (s->ybase - s->y);
2792 if (s->y + s->height < s->ybase + position + thickness)
2793 thickness = (s->y + s->height) - (s->ybase + position);
2794 s->underline_thickness = thickness;
2795 s->underline_position = position;
2796 y = s->ybase + position;
2797 if (s->face->underline_defaulted_p)
2798 XFillRectangle (s->display, s->window, s->gc,
2799 s->x, y, s->width, thickness);
2800 else
2802 XGCValues xgcv;
2803 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2804 XSetForeground (s->display, s->gc, s->face->underline_color);
2805 XFillRectangle (s->display, s->window, s->gc,
2806 s->x, y, s->width, thickness);
2807 XSetForeground (s->display, s->gc, xgcv.foreground);
2811 /* Draw overline. */
2812 if (s->face->overline_p)
2814 unsigned long dy = 0, h = 1;
2816 if (s->face->overline_color_defaulted_p)
2817 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2818 s->width, h);
2819 else
2821 XGCValues xgcv;
2822 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2823 XSetForeground (s->display, s->gc, s->face->overline_color);
2824 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2825 s->width, h);
2826 XSetForeground (s->display, s->gc, xgcv.foreground);
2830 /* Draw strike-through. */
2831 if (s->face->strike_through_p)
2833 unsigned long h = 1;
2834 unsigned long dy = (s->height - h) / 2;
2836 if (s->face->strike_through_color_defaulted_p)
2837 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2838 s->width, h);
2839 else
2841 XGCValues xgcv;
2842 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2843 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2844 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2845 s->width, h);
2846 XSetForeground (s->display, s->gc, xgcv.foreground);
2850 /* Draw relief if not yet drawn. */
2851 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2852 x_draw_glyph_string_box (s);
2854 if (s->prev)
2856 struct glyph_string *prev;
2858 for (prev = s->prev; prev; prev = prev->prev)
2859 if (prev->hl != s->hl
2860 && prev->x + prev->width + prev->right_overhang > s->x)
2862 /* As prev was drawn while clipped to its own area, we
2863 must draw the right_overhang part using s->hl now. */
2864 enum draw_glyphs_face save = prev->hl;
2866 prev->hl = s->hl;
2867 x_set_glyph_string_gc (prev);
2868 x_set_glyph_string_clipping_exactly (s, prev);
2869 if (prev->first_glyph->type == CHAR_GLYPH)
2870 x_draw_glyph_string_foreground (prev);
2871 else
2872 x_draw_composite_glyph_string_foreground (prev);
2873 XSetClipMask (prev->display, prev->gc, None);
2874 prev->hl = save;
2875 prev->num_clips = 0;
2879 if (s->next)
2881 struct glyph_string *next;
2883 for (next = s->next; next; next = next->next)
2884 if (next->hl != s->hl
2885 && next->x - next->left_overhang < s->x + s->width)
2887 /* As next will be drawn while clipped to its own area,
2888 we must draw the left_overhang part using s->hl now. */
2889 enum draw_glyphs_face save = next->hl;
2891 next->hl = s->hl;
2892 x_set_glyph_string_gc (next);
2893 x_set_glyph_string_clipping_exactly (s, next);
2894 if (next->first_glyph->type == CHAR_GLYPH)
2895 x_draw_glyph_string_foreground (next);
2896 else
2897 x_draw_composite_glyph_string_foreground (next);
2898 XSetClipMask (next->display, next->gc, None);
2899 next->hl = save;
2900 next->num_clips = 0;
2905 /* Reset clipping. */
2906 XSetClipMask (s->display, s->gc, None);
2907 s->num_clips = 0;
2910 /* Shift display to make room for inserted glyphs. */
2912 void
2913 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2915 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2916 f->output_data.x->normal_gc,
2917 x, y, width, height,
2918 x + shift_by, y);
2921 /* Delete N glyphs at the nominal cursor position. Not implemented
2922 for X frames. */
2924 static void
2925 x_delete_glyphs (struct frame *f, register int n)
2927 abort ();
2931 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2932 If they are <= 0, this is probably an error. */
2934 void
2935 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
2937 xassert (width > 0 && height > 0);
2938 XClearArea (dpy, window, x, y, width, height, exposures);
2942 /* Clear an entire frame. */
2944 static void
2945 x_clear_frame (struct frame *f)
2947 /* Clearing the frame will erase any cursor, so mark them all as no
2948 longer visible. */
2949 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2950 output_cursor.hpos = output_cursor.vpos = 0;
2951 output_cursor.x = -1;
2953 /* We don't set the output cursor here because there will always
2954 follow an explicit cursor_to. */
2955 BLOCK_INPUT;
2956 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2958 /* We have to clear the scroll bars, too. If we have changed
2959 colors or something like that, then they should be notified. */
2960 x_scroll_bar_clear (f);
2962 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
2963 /* Make sure scroll bars are redrawn. As they aren't redrawn by
2964 redisplay, do it here. */
2965 if (FRAME_GTK_WIDGET (f))
2966 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
2967 #endif
2969 XFlush (FRAME_X_DISPLAY (f));
2971 UNBLOCK_INPUT;
2976 /* Invert the middle quarter of the frame for .15 sec. */
2978 /* We use the select system call to do the waiting, so we have to make
2979 sure it's available. If it isn't, we just won't do visual bells. */
2981 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2984 /* Subtract the `struct timeval' values X and Y, storing the result in
2985 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2987 static int
2988 timeval_subtract (struct timeval *result, struct timeval x, struct timeval y)
2990 /* Perform the carry for the later subtraction by updating y. This
2991 is safer because on some systems the tv_sec member is unsigned. */
2992 if (x.tv_usec < y.tv_usec)
2994 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2995 y.tv_usec -= 1000000 * nsec;
2996 y.tv_sec += nsec;
2999 if (x.tv_usec - y.tv_usec > 1000000)
3001 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
3002 y.tv_usec += 1000000 * nsec;
3003 y.tv_sec -= nsec;
3006 /* Compute the time remaining to wait. tv_usec is certainly
3007 positive. */
3008 result->tv_sec = x.tv_sec - y.tv_sec;
3009 result->tv_usec = x.tv_usec - y.tv_usec;
3011 /* Return indication of whether the result should be considered
3012 negative. */
3013 return x.tv_sec < y.tv_sec;
3016 void
3017 XTflash (struct frame *f)
3019 BLOCK_INPUT;
3022 #ifdef USE_GTK
3023 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3024 when the scroll bars and the edit widget share the same X window. */
3025 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3026 GdkGCValues vals;
3027 GdkGC *gc;
3028 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3029 ^ FRAME_BACKGROUND_PIXEL (f));
3030 vals.function = GDK_XOR;
3031 gc = gdk_gc_new_with_values (window,
3032 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3033 #define XFillRectangle(d, win, gc, x, y, w, h) \
3034 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
3035 #else
3036 GC gc;
3038 /* Create a GC that will use the GXxor function to flip foreground
3039 pixels into background pixels. */
3041 XGCValues values;
3043 values.function = GXxor;
3044 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3045 ^ FRAME_BACKGROUND_PIXEL (f));
3047 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3048 GCFunction | GCForeground, &values);
3050 #endif
3052 /* Get the height not including a menu bar widget. */
3053 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3054 /* Height of each line to flash. */
3055 int flash_height = FRAME_LINE_HEIGHT (f);
3056 /* These will be the left and right margins of the rectangles. */
3057 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3058 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3060 int width;
3062 /* Don't flash the area between a scroll bar and the frame
3063 edge it is next to. */
3064 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3066 case vertical_scroll_bar_left:
3067 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3068 break;
3070 case vertical_scroll_bar_right:
3071 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3072 break;
3074 default:
3075 break;
3078 width = flash_right - flash_left;
3080 /* If window is tall, flash top and bottom line. */
3081 if (height > 3 * FRAME_LINE_HEIGHT (f))
3083 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3084 flash_left,
3085 (FRAME_INTERNAL_BORDER_WIDTH (f)
3086 + FRAME_TOP_MARGIN_HEIGHT (f)),
3087 width, flash_height);
3088 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3089 flash_left,
3090 (height - flash_height
3091 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3092 width, flash_height);
3095 else
3096 /* If it is short, flash it all. */
3097 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3098 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3099 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3101 x_flush (f);
3104 struct timeval wakeup;
3106 EMACS_GET_TIME (wakeup);
3108 /* Compute time to wait until, propagating carry from usecs. */
3109 wakeup.tv_usec += 150000;
3110 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3111 wakeup.tv_usec %= 1000000;
3113 /* Keep waiting until past the time wakeup or any input gets
3114 available. */
3115 while (! detect_input_pending ())
3117 struct timeval current;
3118 struct timeval timeout;
3120 EMACS_GET_TIME (current);
3122 /* Break if result would be negative. */
3123 if (timeval_subtract (&current, wakeup, current))
3124 break;
3126 /* How long `select' should wait. */
3127 timeout.tv_sec = 0;
3128 timeout.tv_usec = 10000;
3130 /* Try to wait that long--but we might wake up sooner. */
3131 select (0, NULL, NULL, NULL, &timeout);
3135 /* If window is tall, flash top and bottom line. */
3136 if (height > 3 * FRAME_LINE_HEIGHT (f))
3138 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3139 flash_left,
3140 (FRAME_INTERNAL_BORDER_WIDTH (f)
3141 + FRAME_TOP_MARGIN_HEIGHT (f)),
3142 width, flash_height);
3143 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3144 flash_left,
3145 (height - flash_height
3146 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3147 width, flash_height);
3149 else
3150 /* If it is short, flash it all. */
3151 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3152 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3153 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3155 #ifdef USE_GTK
3156 g_object_unref (G_OBJECT (gc));
3157 #undef XFillRectangle
3158 #else
3159 XFreeGC (FRAME_X_DISPLAY (f), gc);
3160 #endif
3161 x_flush (f);
3165 UNBLOCK_INPUT;
3168 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3171 static void
3172 XTtoggle_invisible_pointer (FRAME_PTR f, int invisible)
3174 BLOCK_INPUT;
3175 if (invisible)
3177 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3178 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3179 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3181 else
3182 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3183 f->output_data.x->current_cursor);
3184 f->pointer_invisible = invisible;
3185 UNBLOCK_INPUT;
3189 /* Make audible bell. */
3191 void
3192 XTring_bell (struct frame *f)
3194 if (FRAME_X_DISPLAY (f))
3196 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3197 if (visible_bell)
3198 XTflash (f);
3199 else
3200 #endif
3202 BLOCK_INPUT;
3203 XBell (FRAME_X_DISPLAY (f), 0);
3204 XFlush (FRAME_X_DISPLAY (f));
3205 UNBLOCK_INPUT;
3211 /* Specify how many text lines, from the top of the window,
3212 should be affected by insert-lines and delete-lines operations.
3213 This, and those operations, are used only within an update
3214 that is bounded by calls to x_update_begin and x_update_end. */
3216 static void
3217 XTset_terminal_window (struct frame *f, int n)
3219 /* This function intentionally left blank. */
3224 /***********************************************************************
3225 Line Dance
3226 ***********************************************************************/
3228 /* Perform an insert-lines or delete-lines operation, inserting N
3229 lines or deleting -N lines at vertical position VPOS. */
3231 static void
3232 x_ins_del_lines (struct frame *f, int vpos, int n)
3234 abort ();
3238 /* Scroll part of the display as described by RUN. */
3240 static void
3241 x_scroll_run (struct window *w, struct run *run)
3243 struct frame *f = XFRAME (w->frame);
3244 int x, y, width, height, from_y, to_y, bottom_y;
3246 /* Get frame-relative bounding box of the text display area of W,
3247 without mode lines. Include in this box the left and right
3248 fringe of W. */
3249 window_box (w, -1, &x, &y, &width, &height);
3251 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3252 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3253 bottom_y = y + height;
3255 if (to_y < from_y)
3257 /* Scrolling up. Make sure we don't copy part of the mode
3258 line at the bottom. */
3259 if (from_y + run->height > bottom_y)
3260 height = bottom_y - from_y;
3261 else
3262 height = run->height;
3264 else
3266 /* Scolling down. Make sure we don't copy over the mode line.
3267 at the bottom. */
3268 if (to_y + run->height > bottom_y)
3269 height = bottom_y - to_y;
3270 else
3271 height = run->height;
3274 BLOCK_INPUT;
3276 /* Cursor off. Will be switched on again in x_update_window_end. */
3277 updated_window = w;
3278 x_clear_cursor (w);
3280 XCopyArea (FRAME_X_DISPLAY (f),
3281 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3282 f->output_data.x->normal_gc,
3283 x, from_y,
3284 width, height,
3285 x, to_y);
3287 UNBLOCK_INPUT;
3292 /***********************************************************************
3293 Exposure Events
3294 ***********************************************************************/
3297 static void
3298 frame_highlight (struct frame *f)
3300 /* We used to only do this if Vx_no_window_manager was non-nil, but
3301 the ICCCM (section 4.1.6) says that the window's border pixmap
3302 and border pixel are window attributes which are "private to the
3303 client", so we can always change it to whatever we want. */
3304 BLOCK_INPUT;
3305 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3306 f->output_data.x->border_pixel);
3307 UNBLOCK_INPUT;
3308 x_update_cursor (f, 1);
3309 x_set_frame_alpha (f);
3312 static void
3313 frame_unhighlight (struct frame *f)
3315 /* We used to only do this if Vx_no_window_manager was non-nil, but
3316 the ICCCM (section 4.1.6) says that the window's border pixmap
3317 and border pixel are window attributes which are "private to the
3318 client", so we can always change it to whatever we want. */
3319 BLOCK_INPUT;
3320 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3321 f->output_data.x->border_tile);
3322 UNBLOCK_INPUT;
3323 x_update_cursor (f, 1);
3324 x_set_frame_alpha (f);
3327 /* The focus has changed. Update the frames as necessary to reflect
3328 the new situation. Note that we can't change the selected frame
3329 here, because the Lisp code we are interrupting might become confused.
3330 Each event gets marked with the frame in which it occurred, so the
3331 Lisp code can tell when the switch took place by examining the events. */
3333 static void
3334 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3336 struct frame *old_focus = dpyinfo->x_focus_frame;
3338 if (frame != dpyinfo->x_focus_frame)
3340 /* Set this before calling other routines, so that they see
3341 the correct value of x_focus_frame. */
3342 dpyinfo->x_focus_frame = frame;
3344 if (old_focus && old_focus->auto_lower)
3345 x_lower_frame (old_focus);
3347 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3348 pending_autoraise_frame = dpyinfo->x_focus_frame;
3349 else
3350 pending_autoraise_frame = 0;
3353 x_frame_rehighlight (dpyinfo);
3356 /* Handle FocusIn and FocusOut state changes for FRAME.
3357 If FRAME has focus and there exists more than one frame, puts
3358 a FOCUS_IN_EVENT into *BUFP. */
3360 static void
3361 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3363 if (type == FocusIn)
3365 if (dpyinfo->x_focus_event_frame != frame)
3367 x_new_focus_frame (dpyinfo, frame);
3368 dpyinfo->x_focus_event_frame = frame;
3370 /* Don't stop displaying the initial startup message
3371 for a switch-frame event we don't need. */
3372 if (NILP (Vterminal_frame)
3373 && CONSP (Vframe_list)
3374 && !NILP (XCDR (Vframe_list)))
3376 bufp->kind = FOCUS_IN_EVENT;
3377 XSETFRAME (bufp->frame_or_window, frame);
3381 frame->output_data.x->focus_state |= state;
3383 #ifdef HAVE_X_I18N
3384 if (FRAME_XIC (frame))
3385 XSetICFocus (FRAME_XIC (frame));
3386 #endif
3388 else if (type == FocusOut)
3390 frame->output_data.x->focus_state &= ~state;
3392 if (dpyinfo->x_focus_event_frame == frame)
3394 dpyinfo->x_focus_event_frame = 0;
3395 x_new_focus_frame (dpyinfo, 0);
3398 #ifdef HAVE_X_I18N
3399 if (FRAME_XIC (frame))
3400 XUnsetICFocus (FRAME_XIC (frame));
3401 #endif
3402 if (frame->pointer_invisible)
3403 XTtoggle_invisible_pointer (frame, 0);
3407 /* The focus may have changed. Figure out if it is a real focus change,
3408 by checking both FocusIn/Out and Enter/LeaveNotify events.
3410 Returns FOCUS_IN_EVENT event in *BUFP. */
3412 static void
3413 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3415 struct frame *frame;
3417 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3418 if (! frame)
3419 return;
3421 switch (event->type)
3423 case EnterNotify:
3424 case LeaveNotify:
3426 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3427 int focus_state
3428 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3430 if (event->xcrossing.detail != NotifyInferior
3431 && event->xcrossing.focus
3432 && ! (focus_state & FOCUS_EXPLICIT))
3433 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3434 FOCUS_IMPLICIT,
3435 dpyinfo, frame, bufp);
3437 break;
3439 case FocusIn:
3440 case FocusOut:
3441 x_focus_changed (event->type,
3442 (event->xfocus.detail == NotifyPointer ?
3443 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3444 dpyinfo, frame, bufp);
3445 break;
3447 case ClientMessage:
3448 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3450 enum xembed_message msg = event->xclient.data.l[1];
3451 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3452 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3454 break;
3459 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3461 void
3462 x_mouse_leave (struct x_display_info *dpyinfo)
3464 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3467 /* The focus has changed, or we have redirected a frame's focus to
3468 another frame (this happens when a frame uses a surrogate
3469 mini-buffer frame). Shift the highlight as appropriate.
3471 The FRAME argument doesn't necessarily have anything to do with which
3472 frame is being highlighted or un-highlighted; we only use it to find
3473 the appropriate X display info. */
3475 static void
3476 XTframe_rehighlight (struct frame *frame)
3478 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3481 static void
3482 x_frame_rehighlight (struct x_display_info *dpyinfo)
3484 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3486 if (dpyinfo->x_focus_frame)
3488 dpyinfo->x_highlight_frame
3489 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3490 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3491 : dpyinfo->x_focus_frame);
3492 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3494 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3495 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3498 else
3499 dpyinfo->x_highlight_frame = 0;
3501 if (dpyinfo->x_highlight_frame != old_highlight)
3503 if (old_highlight)
3504 frame_unhighlight (old_highlight);
3505 if (dpyinfo->x_highlight_frame)
3506 frame_highlight (dpyinfo->x_highlight_frame);
3512 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3514 /* Initialize mode_switch_bit and modifier_meaning. */
3515 static void
3516 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3518 int min_code, max_code;
3519 KeySym *syms;
3520 int syms_per_code;
3521 XModifierKeymap *mods;
3523 dpyinfo->meta_mod_mask = 0;
3524 dpyinfo->shift_lock_mask = 0;
3525 dpyinfo->alt_mod_mask = 0;
3526 dpyinfo->super_mod_mask = 0;
3527 dpyinfo->hyper_mod_mask = 0;
3529 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3531 syms = XGetKeyboardMapping (dpyinfo->display,
3532 min_code, max_code - min_code + 1,
3533 &syms_per_code);
3534 mods = XGetModifierMapping (dpyinfo->display);
3536 /* Scan the modifier table to see which modifier bits the Meta and
3537 Alt keysyms are on. */
3539 int row, col; /* The row and column in the modifier table. */
3540 int found_alt_or_meta;
3542 for (row = 3; row < 8; row++)
3544 found_alt_or_meta = 0;
3545 for (col = 0; col < mods->max_keypermod; col++)
3547 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3549 /* Zeroes are used for filler. Skip them. */
3550 if (code == 0)
3551 continue;
3553 /* Are any of this keycode's keysyms a meta key? */
3555 int code_col;
3557 for (code_col = 0; code_col < syms_per_code; code_col++)
3559 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3561 switch (sym)
3563 case XK_Meta_L:
3564 case XK_Meta_R:
3565 found_alt_or_meta = 1;
3566 dpyinfo->meta_mod_mask |= (1 << row);
3567 break;
3569 case XK_Alt_L:
3570 case XK_Alt_R:
3571 found_alt_or_meta = 1;
3572 dpyinfo->alt_mod_mask |= (1 << row);
3573 break;
3575 case XK_Hyper_L:
3576 case XK_Hyper_R:
3577 if (!found_alt_or_meta)
3578 dpyinfo->hyper_mod_mask |= (1 << row);
3579 code_col = syms_per_code;
3580 col = mods->max_keypermod;
3581 break;
3583 case XK_Super_L:
3584 case XK_Super_R:
3585 if (!found_alt_or_meta)
3586 dpyinfo->super_mod_mask |= (1 << row);
3587 code_col = syms_per_code;
3588 col = mods->max_keypermod;
3589 break;
3591 case XK_Shift_Lock:
3592 /* Ignore this if it's not on the lock modifier. */
3593 if (!found_alt_or_meta && ((1 << row) == LockMask))
3594 dpyinfo->shift_lock_mask = LockMask;
3595 code_col = syms_per_code;
3596 col = mods->max_keypermod;
3597 break;
3605 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3606 if (! dpyinfo->meta_mod_mask)
3608 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3609 dpyinfo->alt_mod_mask = 0;
3612 /* If some keys are both alt and meta,
3613 make them just meta, not alt. */
3614 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3616 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3619 XFree ((char *) syms);
3620 XFreeModifiermap (mods);
3623 /* Convert between the modifier bits X uses and the modifier bits
3624 Emacs uses. */
3626 unsigned int
3627 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, unsigned int state)
3629 EMACS_UINT mod_meta = meta_modifier;
3630 EMACS_UINT mod_alt = alt_modifier;
3631 EMACS_UINT mod_hyper = hyper_modifier;
3632 EMACS_UINT mod_super = super_modifier;
3633 Lisp_Object tem;
3635 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3636 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3637 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3638 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3639 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3640 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3641 tem = Fget (Vx_super_keysym, Qmodifier_value);
3642 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3645 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3646 | ((state & ControlMask) ? ctrl_modifier : 0)
3647 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3648 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3649 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3650 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3653 static unsigned int
3654 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, unsigned int state)
3656 EMACS_UINT mod_meta = meta_modifier;
3657 EMACS_UINT mod_alt = alt_modifier;
3658 EMACS_UINT mod_hyper = hyper_modifier;
3659 EMACS_UINT mod_super = super_modifier;
3661 Lisp_Object tem;
3663 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3664 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3665 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3666 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3667 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3668 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3669 tem = Fget (Vx_super_keysym, Qmodifier_value);
3670 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3673 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3674 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3675 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3676 | ((state & shift_modifier) ? ShiftMask : 0)
3677 | ((state & ctrl_modifier) ? ControlMask : 0)
3678 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3681 /* Convert a keysym to its name. */
3683 char *
3684 x_get_keysym_name (int keysym)
3686 char *value;
3688 BLOCK_INPUT;
3689 value = XKeysymToString (keysym);
3690 UNBLOCK_INPUT;
3692 return value;
3697 /* Mouse clicks and mouse movement. Rah. */
3699 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3701 If the event is a button press, then note that we have grabbed
3702 the mouse. */
3704 static Lisp_Object
3705 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3707 /* Make the event type NO_EVENT; we'll change that when we decide
3708 otherwise. */
3709 result->kind = MOUSE_CLICK_EVENT;
3710 result->code = event->button - Button1;
3711 result->timestamp = event->time;
3712 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3713 event->state)
3714 | (event->type == ButtonRelease
3715 ? up_modifier
3716 : down_modifier));
3718 XSETINT (result->x, event->x);
3719 XSETINT (result->y, event->y);
3720 XSETFRAME (result->frame_or_window, f);
3721 result->arg = Qnil;
3722 return Qnil;
3726 /* Function to report a mouse movement to the mainstream Emacs code.
3727 The input handler calls this.
3729 We have received a mouse movement event, which is given in *event.
3730 If the mouse is over a different glyph than it was last time, tell
3731 the mainstream emacs code by setting mouse_moved. If not, ask for
3732 another motion event, so we can check again the next time it moves. */
3734 static XMotionEvent last_mouse_motion_event;
3735 static Lisp_Object last_mouse_motion_frame;
3737 static int
3738 note_mouse_movement (FRAME_PTR frame, XMotionEvent *event)
3740 last_mouse_movement_time = event->time;
3741 last_mouse_motion_event = *event;
3742 XSETFRAME (last_mouse_motion_frame, frame);
3744 if (!FRAME_X_OUTPUT (frame))
3745 return 0;
3747 if (event->window != FRAME_X_WINDOW (frame))
3749 frame->mouse_moved = 1;
3750 last_mouse_scroll_bar = Qnil;
3751 note_mouse_highlight (frame, -1, -1);
3752 last_mouse_glyph_frame = 0;
3753 return 1;
3757 /* Has the mouse moved off the glyph it was on at the last sighting? */
3758 if (frame != last_mouse_glyph_frame
3759 || event->x < last_mouse_glyph.x
3760 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3761 || event->y < last_mouse_glyph.y
3762 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3764 frame->mouse_moved = 1;
3765 last_mouse_scroll_bar = Qnil;
3766 note_mouse_highlight (frame, event->x, event->y);
3767 /* Remember which glyph we're now on. */
3768 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3769 last_mouse_glyph_frame = frame;
3770 return 1;
3773 return 0;
3777 /************************************************************************
3778 Mouse Face
3779 ************************************************************************/
3781 static void
3782 redo_mouse_highlight (void)
3784 if (!NILP (last_mouse_motion_frame)
3785 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3786 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3787 last_mouse_motion_event.x,
3788 last_mouse_motion_event.y);
3793 /* Return the current position of the mouse.
3794 *FP should be a frame which indicates which display to ask about.
3796 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3797 and *PART to the frame, window, and scroll bar part that the mouse
3798 is over. Set *X and *Y to the portion and whole of the mouse's
3799 position on the scroll bar.
3801 If the mouse movement started elsewhere, set *FP to the frame the
3802 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3803 the mouse is over.
3805 Set *TIME to the server time-stamp for the time at which the mouse
3806 was at this position.
3808 Don't store anything if we don't have a valid set of values to report.
3810 This clears the mouse_moved flag, so we can wait for the next mouse
3811 movement. */
3813 static void
3814 XTmouse_position (FRAME_PTR *fp, int insist, Lisp_Object *bar_window, enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y, long unsigned int *time)
3816 FRAME_PTR f1;
3818 BLOCK_INPUT;
3820 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3821 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3822 else
3824 Window root;
3825 int root_x, root_y;
3827 Window dummy_window;
3828 int dummy;
3830 Lisp_Object frame, tail;
3832 /* Clear the mouse-moved flag for every frame on this display. */
3833 FOR_EACH_FRAME (tail, frame)
3834 if (FRAME_X_P (XFRAME (frame))
3835 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3836 XFRAME (frame)->mouse_moved = 0;
3838 last_mouse_scroll_bar = Qnil;
3840 /* Figure out which root window we're on. */
3841 XQueryPointer (FRAME_X_DISPLAY (*fp),
3842 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3844 /* The root window which contains the pointer. */
3845 &root,
3847 /* Trash which we can't trust if the pointer is on
3848 a different screen. */
3849 &dummy_window,
3851 /* The position on that root window. */
3852 &root_x, &root_y,
3854 /* More trash we can't trust. */
3855 &dummy, &dummy,
3857 /* Modifier keys and pointer buttons, about which
3858 we don't care. */
3859 (unsigned int *) &dummy);
3861 /* Now we have a position on the root; find the innermost window
3862 containing the pointer. */
3864 Window win, child;
3865 int win_x, win_y;
3866 int parent_x = 0, parent_y = 0;
3868 win = root;
3870 /* XTranslateCoordinates can get errors if the window
3871 structure is changing at the same time this function
3872 is running. So at least we must not crash from them. */
3874 x_catch_errors (FRAME_X_DISPLAY (*fp));
3876 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3877 && FRAME_LIVE_P (last_mouse_frame))
3879 /* If mouse was grabbed on a frame, give coords for that frame
3880 even if the mouse is now outside it. */
3881 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3883 /* From-window, to-window. */
3884 root, FRAME_X_WINDOW (last_mouse_frame),
3886 /* From-position, to-position. */
3887 root_x, root_y, &win_x, &win_y,
3889 /* Child of win. */
3890 &child);
3891 f1 = last_mouse_frame;
3893 else
3895 while (1)
3897 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3899 /* From-window, to-window. */
3900 root, win,
3902 /* From-position, to-position. */
3903 root_x, root_y, &win_x, &win_y,
3905 /* Child of win. */
3906 &child);
3908 if (child == None || child == win)
3909 break;
3910 #ifdef USE_GTK
3911 /* We don't wan't to know the innermost window. We
3912 want the edit window. For non-Gtk+ the innermost
3913 window is the edit window. For Gtk+ it might not
3914 be. It might be the tool bar for example. */
3915 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3916 break;
3917 #endif
3918 win = child;
3919 parent_x = win_x;
3920 parent_y = win_y;
3923 /* Now we know that:
3924 win is the innermost window containing the pointer
3925 (XTC says it has no child containing the pointer),
3926 win_x and win_y are the pointer's position in it
3927 (XTC did this the last time through), and
3928 parent_x and parent_y are the pointer's position in win's parent.
3929 (They are what win_x and win_y were when win was child.
3930 If win is the root window, it has no parent, and
3931 parent_{x,y} are invalid, but that's okay, because we'll
3932 never use them in that case.) */
3934 #ifdef USE_GTK
3935 /* We don't wan't to know the innermost window. We
3936 want the edit window. */
3937 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3938 #else
3939 /* Is win one of our frames? */
3940 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3941 #endif
3943 #ifdef USE_X_TOOLKIT
3944 /* If we end up with the menu bar window, say it's not
3945 on the frame. */
3946 if (f1 != NULL
3947 && f1->output_data.x->menubar_widget
3948 && win == XtWindow (f1->output_data.x->menubar_widget))
3949 f1 = NULL;
3950 #endif /* USE_X_TOOLKIT */
3953 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3954 f1 = 0;
3956 x_uncatch_errors ();
3958 /* If not, is it one of our scroll bars? */
3959 if (! f1)
3961 struct scroll_bar *bar;
3963 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3965 if (bar)
3967 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3968 win_x = parent_x;
3969 win_y = parent_y;
3973 if (f1 == 0 && insist > 0)
3974 f1 = SELECTED_FRAME ();
3976 if (f1)
3978 /* Ok, we found a frame. Store all the values.
3979 last_mouse_glyph is a rectangle used to reduce the
3980 generation of mouse events. To not miss any motion
3981 events, we must divide the frame into rectangles of the
3982 size of the smallest character that could be displayed
3983 on it, i.e. into the same rectangles that matrices on
3984 the frame are divided into. */
3986 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3987 last_mouse_glyph_frame = f1;
3989 *bar_window = Qnil;
3990 *part = 0;
3991 *fp = f1;
3992 XSETINT (*x, win_x);
3993 XSETINT (*y, win_y);
3994 *time = last_mouse_movement_time;
3999 UNBLOCK_INPUT;
4004 /***********************************************************************
4005 Scroll bars
4006 ***********************************************************************/
4008 /* Scroll bar support. */
4010 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4011 manages it.
4012 This can be called in GC, so we have to make sure to strip off mark
4013 bits. */
4015 static struct scroll_bar *
4016 x_window_to_scroll_bar (Display *display, Window window_id)
4018 Lisp_Object tail;
4020 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4021 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4022 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4024 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4026 Lisp_Object frame, bar, condemned;
4028 frame = XCAR (tail);
4029 /* All elements of Vframe_list should be frames. */
4030 if (! FRAMEP (frame))
4031 abort ();
4033 if (! FRAME_X_P (XFRAME (frame)))
4034 continue;
4036 /* Scan this frame's scroll bar list for a scroll bar with the
4037 right window ID. */
4038 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4039 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4040 /* This trick allows us to search both the ordinary and
4041 condemned scroll bar lists with one loop. */
4042 ! NILP (bar) || (bar = condemned,
4043 condemned = Qnil,
4044 ! NILP (bar));
4045 bar = XSCROLL_BAR (bar)->next)
4046 if (XSCROLL_BAR (bar)->x_window == window_id &&
4047 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4048 return XSCROLL_BAR (bar);
4051 return 0;
4055 #if defined USE_LUCID
4057 /* Return the Lucid menu bar WINDOW is part of. Return null
4058 if WINDOW is not part of a menu bar. */
4060 static Widget
4061 x_window_to_menu_bar (Window window)
4063 Lisp_Object tail;
4065 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4067 if (FRAME_X_P (XFRAME (XCAR (tail))))
4069 Lisp_Object frame = XCAR (tail);
4070 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4072 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4073 return menu_bar;
4077 return NULL;
4080 #endif /* USE_LUCID */
4083 /************************************************************************
4084 Toolkit scroll bars
4085 ************************************************************************/
4087 #ifdef USE_TOOLKIT_SCROLL_BARS
4089 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4090 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4091 static void x_create_toolkit_scroll_bar (struct frame *,
4092 struct scroll_bar *);
4093 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4094 int, int, int);
4097 /* Lisp window being scrolled. Set when starting to interact with
4098 a toolkit scroll bar, reset to nil when ending the interaction. */
4100 static Lisp_Object window_being_scrolled;
4102 /* Last scroll bar part sent in xm_scroll_callback. */
4104 static int last_scroll_bar_part;
4106 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4107 that movements of 1/20 of the screen size are mapped to up/down. */
4109 #ifndef USE_GTK
4110 /* Id of action hook installed for scroll bars. */
4112 static XtActionHookId action_hook_id;
4114 static Boolean xaw3d_arrow_scroll;
4116 /* Whether the drag scrolling maintains the mouse at the top of the
4117 thumb. If not, resizing the thumb needs to be done more carefully
4118 to avoid jerkyness. */
4120 static Boolean xaw3d_pick_top;
4122 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4123 bars are used.. The hook is responsible for detecting when
4124 the user ends an interaction with the scroll bar, and generates
4125 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4127 static void
4128 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4129 XEvent *event, String *params, Cardinal *num_params)
4131 int scroll_bar_p;
4132 const char *end_action;
4134 #ifdef USE_MOTIF
4135 scroll_bar_p = XmIsScrollBar (widget);
4136 end_action = "Release";
4137 #else /* !USE_MOTIF i.e. use Xaw */
4138 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4139 end_action = "EndScroll";
4140 #endif /* USE_MOTIF */
4142 if (scroll_bar_p
4143 && strcmp (action_name, end_action) == 0
4144 && WINDOWP (window_being_scrolled))
4146 struct window *w;
4148 x_send_scroll_bar_event (window_being_scrolled,
4149 scroll_bar_end_scroll, 0, 0);
4150 w = XWINDOW (window_being_scrolled);
4152 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4154 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4155 /* The thumb size is incorrect while dragging: fix it. */
4156 set_vertical_scroll_bar (w);
4158 window_being_scrolled = Qnil;
4159 last_scroll_bar_part = -1;
4161 /* Xt timeouts no longer needed. */
4162 toolkit_scroll_bar_interaction = 0;
4165 #endif /* not USE_GTK */
4167 /* A vector of windows used for communication between
4168 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4170 static struct window **scroll_bar_windows;
4171 static int scroll_bar_windows_size;
4174 /* Send a client message with message type Xatom_Scrollbar for a
4175 scroll action to the frame of WINDOW. PART is a value identifying
4176 the part of the scroll bar that was clicked on. PORTION is the
4177 amount to scroll of a whole of WHOLE. */
4179 static void
4180 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4182 XEvent event;
4183 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4184 struct window *w = XWINDOW (window);
4185 struct frame *f = XFRAME (w->frame);
4186 int i;
4188 BLOCK_INPUT;
4190 /* Construct a ClientMessage event to send to the frame. */
4191 ev->type = ClientMessage;
4192 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4193 ev->display = FRAME_X_DISPLAY (f);
4194 ev->window = FRAME_X_WINDOW (f);
4195 ev->format = 32;
4197 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4198 not enough to store a pointer or Lisp_Object on a 64 bit system.
4199 So, store the window in scroll_bar_windows and pass the index
4200 into that array in the event. */
4201 for (i = 0; i < scroll_bar_windows_size; ++i)
4202 if (scroll_bar_windows[i] == NULL)
4203 break;
4205 if (i == scroll_bar_windows_size)
4207 int new_size = max (10, 2 * scroll_bar_windows_size);
4208 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4209 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4211 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4212 nbytes);
4213 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4214 scroll_bar_windows_size = new_size;
4217 scroll_bar_windows[i] = w;
4218 ev->data.l[0] = (long) i;
4219 ev->data.l[1] = (long) part;
4220 ev->data.l[2] = (long) 0;
4221 ev->data.l[3] = (long) portion;
4222 ev->data.l[4] = (long) whole;
4224 /* Make Xt timeouts work while the scroll bar is active. */
4225 toolkit_scroll_bar_interaction = 1;
4226 #ifdef USE_X_TOOLKIT
4227 x_activate_timeout_atimer ();
4228 #endif
4230 /* Setting the event mask to zero means that the message will
4231 be sent to the client that created the window, and if that
4232 window no longer exists, no event will be sent. */
4233 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4234 UNBLOCK_INPUT;
4238 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4239 in *IEVENT. */
4241 static void
4242 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4244 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4245 Lisp_Object window;
4246 struct frame *f;
4247 struct window *w;
4249 w = scroll_bar_windows[ev->data.l[0]];
4250 scroll_bar_windows[ev->data.l[0]] = NULL;
4252 XSETWINDOW (window, w);
4253 f = XFRAME (w->frame);
4255 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4256 ievent->frame_or_window = window;
4257 ievent->arg = Qnil;
4258 #ifdef USE_GTK
4259 ievent->timestamp = CurrentTime;
4260 #else
4261 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4262 #endif
4263 ievent->part = ev->data.l[1];
4264 ievent->code = ev->data.l[2];
4265 ievent->x = make_number ((int) ev->data.l[3]);
4266 ievent->y = make_number ((int) ev->data.l[4]);
4267 ievent->modifiers = 0;
4271 #ifdef USE_MOTIF
4273 /* Minimum and maximum values used for Motif scroll bars. */
4275 #define XM_SB_MAX 10000000
4278 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4279 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4280 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4282 static void
4283 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4285 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4286 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4287 int part = -1, whole = 0, portion = 0;
4289 switch (cs->reason)
4291 case XmCR_DECREMENT:
4292 bar->dragging = Qnil;
4293 part = scroll_bar_up_arrow;
4294 break;
4296 case XmCR_INCREMENT:
4297 bar->dragging = Qnil;
4298 part = scroll_bar_down_arrow;
4299 break;
4301 case XmCR_PAGE_DECREMENT:
4302 bar->dragging = Qnil;
4303 part = scroll_bar_above_handle;
4304 break;
4306 case XmCR_PAGE_INCREMENT:
4307 bar->dragging = Qnil;
4308 part = scroll_bar_below_handle;
4309 break;
4311 case XmCR_TO_TOP:
4312 bar->dragging = Qnil;
4313 part = scroll_bar_to_top;
4314 break;
4316 case XmCR_TO_BOTTOM:
4317 bar->dragging = Qnil;
4318 part = scroll_bar_to_bottom;
4319 break;
4321 case XmCR_DRAG:
4323 int slider_size;
4325 /* Get the slider size. */
4326 BLOCK_INPUT;
4327 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4328 UNBLOCK_INPUT;
4330 whole = XM_SB_MAX - slider_size;
4331 portion = min (cs->value, whole);
4332 part = scroll_bar_handle;
4333 bar->dragging = make_number (cs->value);
4335 break;
4337 case XmCR_VALUE_CHANGED:
4338 break;
4341 if (part >= 0)
4343 window_being_scrolled = bar->window;
4344 last_scroll_bar_part = part;
4345 x_send_scroll_bar_event (bar->window, part, portion, whole);
4349 #elif defined USE_GTK
4351 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4352 bar widget. DATA is a pointer to the scroll_bar structure. */
4354 static gboolean
4355 xg_scroll_callback (GtkRange *range,
4356 GtkScrollType scroll,
4357 gdouble value,
4358 gpointer user_data)
4360 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4361 gdouble position;
4362 int part = -1, whole = 0, portion = 0;
4363 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4364 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4366 if (xg_ignore_gtk_scrollbar) return FALSE;
4367 position = gtk_adjustment_get_value (adj);
4370 switch (scroll)
4372 case GTK_SCROLL_JUMP:
4373 /* Buttons 1 2 or 3 must be grabbed. */
4374 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4375 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4377 part = scroll_bar_handle;
4378 whole = gtk_adjustment_get_upper (adj) -
4379 gtk_adjustment_get_page_size (adj);
4380 portion = min ((int)position, whole);
4381 bar->dragging = make_number ((int)portion);
4383 break;
4384 case GTK_SCROLL_STEP_BACKWARD:
4385 part = scroll_bar_up_arrow;
4386 bar->dragging = Qnil;
4387 break;
4388 case GTK_SCROLL_STEP_FORWARD:
4389 part = scroll_bar_down_arrow;
4390 bar->dragging = Qnil;
4391 break;
4392 case GTK_SCROLL_PAGE_BACKWARD:
4393 part = scroll_bar_above_handle;
4394 bar->dragging = Qnil;
4395 break;
4396 case GTK_SCROLL_PAGE_FORWARD:
4397 part = scroll_bar_below_handle;
4398 bar->dragging = Qnil;
4399 break;
4402 if (part >= 0)
4404 window_being_scrolled = bar->window;
4405 last_scroll_bar_part = part;
4406 x_send_scroll_bar_event (bar->window, part, portion, whole);
4409 return FALSE;
4412 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4414 static gboolean
4415 xg_end_scroll_callback (GtkWidget *widget,
4416 GdkEventButton *event,
4417 gpointer user_data)
4419 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4420 bar->dragging = Qnil;
4421 if (WINDOWP (window_being_scrolled))
4423 x_send_scroll_bar_event (window_being_scrolled,
4424 scroll_bar_end_scroll, 0, 0);
4425 window_being_scrolled = Qnil;
4428 return FALSE;
4432 #else /* not USE_GTK and not USE_MOTIF */
4434 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4435 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4436 scroll bar struct. CALL_DATA is a pointer to a float saying where
4437 the thumb is. */
4439 static void
4440 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4442 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4443 float top = *(float *) call_data;
4444 float shown;
4445 int whole, portion, height;
4446 int part;
4448 /* Get the size of the thumb, a value between 0 and 1. */
4449 BLOCK_INPUT;
4450 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4451 UNBLOCK_INPUT;
4453 whole = 10000000;
4454 portion = shown < 1 ? top * whole : 0;
4456 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4457 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4458 the bottom, so we force the scrolling whenever we see that we're
4459 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4460 we try to ensure that we always stay two pixels away from the
4461 bottom). */
4462 part = scroll_bar_down_arrow;
4463 else
4464 part = scroll_bar_handle;
4466 window_being_scrolled = bar->window;
4467 bar->dragging = make_number (portion);
4468 last_scroll_bar_part = part;
4469 x_send_scroll_bar_event (bar->window, part, portion, whole);
4473 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4474 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4475 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4476 the scroll bar. CALL_DATA is an integer specifying the action that
4477 has taken place. Its magnitude is in the range 0..height of the
4478 scroll bar. Negative values mean scroll towards buffer start.
4479 Values < height of scroll bar mean line-wise movement. */
4481 static void
4482 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4484 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4485 /* The position really is stored cast to a pointer. */
4486 int position = (long) call_data;
4487 Dimension height;
4488 int part;
4490 /* Get the height of the scroll bar. */
4491 BLOCK_INPUT;
4492 XtVaGetValues (widget, XtNheight, &height, NULL);
4493 UNBLOCK_INPUT;
4495 if (eabs (position) >= height)
4496 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4498 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4499 it maps line-movement to call_data = max(5, height/20). */
4500 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4501 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4502 else
4503 part = scroll_bar_move_ratio;
4505 window_being_scrolled = bar->window;
4506 bar->dragging = Qnil;
4507 last_scroll_bar_part = part;
4508 x_send_scroll_bar_event (bar->window, part, position, height);
4511 #endif /* not USE_GTK and not USE_MOTIF */
4513 #define SCROLL_BAR_NAME "verticalScrollBar"
4515 /* Create the widget for scroll bar BAR on frame F. Record the widget
4516 and X window of the scroll bar in BAR. */
4518 #ifdef USE_GTK
4519 static void
4520 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4522 const char *scroll_bar_name = SCROLL_BAR_NAME;
4524 BLOCK_INPUT;
4525 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4526 G_CALLBACK (xg_end_scroll_callback),
4527 scroll_bar_name);
4528 UNBLOCK_INPUT;
4531 #else /* not USE_GTK */
4533 static void
4534 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4536 Window xwindow;
4537 Widget widget;
4538 Arg av[20];
4539 int ac = 0;
4540 char *scroll_bar_name = SCROLL_BAR_NAME;
4541 unsigned long pixel;
4543 BLOCK_INPUT;
4545 #ifdef USE_MOTIF
4546 /* Set resources. Create the widget. */
4547 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4548 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4549 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4550 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4551 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4552 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4553 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4555 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4556 if (pixel != -1)
4558 XtSetArg (av[ac], XmNforeground, pixel);
4559 ++ac;
4562 pixel = f->output_data.x->scroll_bar_background_pixel;
4563 if (pixel != -1)
4565 XtSetArg (av[ac], XmNbackground, pixel);
4566 ++ac;
4569 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4570 scroll_bar_name, av, ac);
4572 /* Add one callback for everything that can happen. */
4573 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4574 (XtPointer) bar);
4575 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4576 (XtPointer) bar);
4577 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4578 (XtPointer) bar);
4579 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4580 (XtPointer) bar);
4581 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4582 (XtPointer) bar);
4583 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4584 (XtPointer) bar);
4585 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4586 (XtPointer) bar);
4588 /* Realize the widget. Only after that is the X window created. */
4589 XtRealizeWidget (widget);
4591 /* Set the cursor to an arrow. I didn't find a resource to do that.
4592 And I'm wondering why it hasn't an arrow cursor by default. */
4593 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4594 f->output_data.x->nontext_cursor);
4596 #else /* !USE_MOTIF i.e. use Xaw */
4598 /* Set resources. Create the widget. The background of the
4599 Xaw3d scroll bar widget is a little bit light for my taste.
4600 We don't alter it here to let users change it according
4601 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4602 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4603 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4604 /* For smoother scrolling with Xaw3d -sm */
4605 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4607 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4608 if (pixel != -1)
4610 XtSetArg (av[ac], XtNforeground, pixel);
4611 ++ac;
4614 pixel = f->output_data.x->scroll_bar_background_pixel;
4615 if (pixel != -1)
4617 XtSetArg (av[ac], XtNbackground, pixel);
4618 ++ac;
4621 /* Top/bottom shadow colors. */
4623 /* Allocate them, if necessary. */
4624 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4626 pixel = f->output_data.x->scroll_bar_background_pixel;
4627 if (pixel != -1)
4629 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4630 FRAME_X_COLORMAP (f),
4631 &pixel, 1.2, 0x8000))
4632 pixel = -1;
4633 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4636 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4638 pixel = f->output_data.x->scroll_bar_background_pixel;
4639 if (pixel != -1)
4641 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4642 FRAME_X_COLORMAP (f),
4643 &pixel, 0.6, 0x4000))
4644 pixel = -1;
4645 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4649 #ifdef XtNbeNiceToColormap
4650 /* Tell the toolkit about them. */
4651 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4652 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4653 /* We tried to allocate a color for the top/bottom shadow, and
4654 failed, so tell Xaw3d to use dithering instead. */
4655 /* But only if we have a small colormap. Xaw3d can allocate nice
4656 colors itself. */
4658 XtSetArg (av[ac], XtNbeNiceToColormap,
4659 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4660 ++ac;
4662 else
4663 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4664 be more consistent with other emacs 3d colors, and since Xaw3d is
4665 not good at dealing with allocation failure. */
4667 /* This tells Xaw3d to use real colors instead of dithering for
4668 the shadows. */
4669 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4670 ++ac;
4672 /* Specify the colors. */
4673 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4674 if (pixel != -1)
4676 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4677 ++ac;
4679 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4680 if (pixel != -1)
4682 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4683 ++ac;
4686 #endif
4688 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4689 f->output_data.x->edit_widget, av, ac);
4692 char *initial = "";
4693 char *val = initial;
4694 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4695 #ifdef XtNarrowScrollbars
4696 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4697 #endif
4698 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4699 if (xaw3d_arrow_scroll || val == initial)
4700 { /* ARROW_SCROLL */
4701 xaw3d_arrow_scroll = True;
4702 /* Isn't that just a personal preference ? --Stef */
4703 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4707 /* Define callbacks. */
4708 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4709 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4710 (XtPointer) bar);
4712 /* Realize the widget. Only after that is the X window created. */
4713 XtRealizeWidget (widget);
4715 #endif /* !USE_MOTIF */
4717 /* Install an action hook that lets us detect when the user
4718 finishes interacting with a scroll bar. */
4719 if (action_hook_id == 0)
4720 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4722 /* Remember X window and widget in the scroll bar vector. */
4723 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4724 xwindow = XtWindow (widget);
4725 bar->x_window = xwindow;
4727 UNBLOCK_INPUT;
4729 #endif /* not USE_GTK */
4732 /* Set the thumb size and position of scroll bar BAR. We are currently
4733 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4735 #ifdef USE_GTK
4736 static void
4737 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4739 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4742 #else /* not USE_GTK */
4743 static void
4744 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4745 int whole)
4747 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4748 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4749 float top, shown;
4751 BLOCK_INPUT;
4753 #ifdef USE_MOTIF
4755 /* We use an estimate of 30 chars per line rather than the real
4756 `portion' value. This has the disadvantage that the thumb size
4757 is not very representative, but it makes our life a lot easier.
4758 Otherwise, we have to constantly adjust the thumb size, which
4759 we can't always do quickly enough: while dragging, the size of
4760 the thumb might prevent the user from dragging the thumb all the
4761 way to the end. but Motif and some versions of Xaw3d don't allow
4762 updating the thumb size while dragging. Also, even if we can update
4763 its size, the update will often happen too late.
4764 If you don't believe it, check out revision 1.650 of xterm.c to see
4765 what hoops we were going through and the still poor behavior we got. */
4766 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4767 /* When the thumb is at the bottom, position == whole.
4768 So we need to increase `whole' to make space for the thumb. */
4769 whole += portion;
4771 if (whole <= 0)
4772 top = 0, shown = 1;
4773 else
4775 top = (float) position / whole;
4776 shown = (float) portion / whole;
4779 if (NILP (bar->dragging))
4781 int size, value;
4783 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4784 is the scroll bar's maximum and MIN is the scroll bar's minimum
4785 value. */
4786 size = shown * XM_SB_MAX;
4787 size = min (size, XM_SB_MAX);
4788 size = max (size, 1);
4790 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4791 value = top * XM_SB_MAX;
4792 value = min (value, XM_SB_MAX - size);
4794 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4796 #else /* !USE_MOTIF i.e. use Xaw */
4798 if (whole == 0)
4799 top = 0, shown = 1;
4800 else
4802 top = (float) position / whole;
4803 shown = (float) portion / whole;
4807 float old_top, old_shown;
4808 Dimension height;
4809 XtVaGetValues (widget,
4810 XtNtopOfThumb, &old_top,
4811 XtNshown, &old_shown,
4812 XtNheight, &height,
4813 NULL);
4815 /* Massage the top+shown values. */
4816 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4817 top = max (0, min (1, top));
4818 else
4819 top = old_top;
4820 /* Keep two pixels available for moving the thumb down. */
4821 shown = max (0, min (1 - top - (2.0 / height), shown));
4823 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4824 check that your system's configuration file contains a define
4825 for `NARROWPROTO'. See s/freebsd.h for an example. */
4826 if (top != old_top || shown != old_shown)
4828 if (NILP (bar->dragging))
4829 XawScrollbarSetThumb (widget, top, shown);
4830 else
4832 /* Try to make the scrolling a tad smoother. */
4833 if (!xaw3d_pick_top)
4834 shown = min (shown, old_shown);
4836 XawScrollbarSetThumb (widget, top, shown);
4840 #endif /* !USE_MOTIF */
4842 UNBLOCK_INPUT;
4844 #endif /* not USE_GTK */
4846 #endif /* USE_TOOLKIT_SCROLL_BARS */
4850 /************************************************************************
4851 Scroll bars, general
4852 ************************************************************************/
4854 /* Create a scroll bar and return the scroll bar vector for it. W is
4855 the Emacs window on which to create the scroll bar. TOP, LEFT,
4856 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4857 scroll bar. */
4859 static struct scroll_bar *
4860 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4862 struct frame *f = XFRAME (w->frame);
4863 struct scroll_bar *bar
4864 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4866 BLOCK_INPUT;
4868 #ifdef USE_TOOLKIT_SCROLL_BARS
4869 x_create_toolkit_scroll_bar (f, bar);
4870 #else /* not USE_TOOLKIT_SCROLL_BARS */
4872 XSetWindowAttributes a;
4873 unsigned long mask;
4874 Window window;
4876 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4877 if (a.background_pixel == -1)
4878 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4880 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4881 | ButtonMotionMask | PointerMotionHintMask
4882 | ExposureMask);
4883 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4885 mask = (CWBackPixel | CWEventMask | CWCursor);
4887 /* Clear the area of W that will serve as a scroll bar. This is
4888 for the case that a window has been split horizontally. In
4889 this case, no clear_frame is generated to reduce flickering. */
4890 if (width > 0 && height > 0)
4891 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4892 left, top, width,
4893 window_box_height (w), False);
4895 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4896 /* Position and size of scroll bar. */
4897 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4898 top,
4899 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4900 height,
4901 /* Border width, depth, class, and visual. */
4903 CopyFromParent,
4904 CopyFromParent,
4905 CopyFromParent,
4906 /* Attributes. */
4907 mask, &a);
4908 bar->x_window = window;
4910 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4912 XSETWINDOW (bar->window, w);
4913 bar->top = top;
4914 bar->left = left;
4915 bar->width = width;
4916 bar->height = height;
4917 bar->start = 0;
4918 bar->end = 0;
4919 bar->dragging = Qnil;
4920 bar->fringe_extended_p = 0;
4922 /* Add bar to its frame's list of scroll bars. */
4923 bar->next = FRAME_SCROLL_BARS (f);
4924 bar->prev = Qnil;
4925 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4926 if (!NILP (bar->next))
4927 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4929 /* Map the window/widget. */
4930 #ifdef USE_TOOLKIT_SCROLL_BARS
4932 #ifdef USE_GTK
4933 xg_update_scrollbar_pos (f,
4934 bar->x_window,
4935 top,
4936 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4937 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4938 max (height, 1));
4939 #else /* not USE_GTK */
4940 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4941 XtConfigureWidget (scroll_bar,
4942 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4943 top,
4944 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4945 max (height, 1), 0);
4946 XtMapWidget (scroll_bar);
4947 #endif /* not USE_GTK */
4949 #else /* not USE_TOOLKIT_SCROLL_BARS */
4950 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4951 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4953 UNBLOCK_INPUT;
4954 return bar;
4958 #ifndef USE_TOOLKIT_SCROLL_BARS
4960 /* Draw BAR's handle in the proper position.
4962 If the handle is already drawn from START to END, don't bother
4963 redrawing it, unless REBUILD is non-zero; in that case, always
4964 redraw it. (REBUILD is handy for drawing the handle after expose
4965 events.)
4967 Normally, we want to constrain the start and end of the handle to
4968 fit inside its rectangle, but if the user is dragging the scroll
4969 bar handle, we want to let them drag it down all the way, so that
4970 the bar's top is as far down as it goes; otherwise, there's no way
4971 to move to the very end of the buffer. */
4973 static void
4974 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
4976 int dragging = ! NILP (bar->dragging);
4977 Window w = bar->x_window;
4978 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4979 GC gc = f->output_data.x->normal_gc;
4981 /* If the display is already accurate, do nothing. */
4982 if (! rebuild
4983 && start == bar->start
4984 && end == bar->end)
4985 return;
4987 BLOCK_INPUT;
4990 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4991 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4992 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4994 /* Make sure the values are reasonable, and try to preserve
4995 the distance between start and end. */
4997 int length = end - start;
4999 if (start < 0)
5000 start = 0;
5001 else if (start > top_range)
5002 start = top_range;
5003 end = start + length;
5005 if (end < start)
5006 end = start;
5007 else if (end > top_range && ! dragging)
5008 end = top_range;
5011 /* Store the adjusted setting in the scroll bar. */
5012 bar->start = start;
5013 bar->end = end;
5015 /* Clip the end position, just for display. */
5016 if (end > top_range)
5017 end = top_range;
5019 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5020 below top positions, to make sure the handle is always at least
5021 that many pixels tall. */
5022 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5024 /* Draw the empty space above the handle. Note that we can't clear
5025 zero-height areas; that means "clear to end of window." */
5026 if (0 < start)
5027 x_clear_area (FRAME_X_DISPLAY (f), w,
5028 /* x, y, width, height, and exposures. */
5029 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5030 VERTICAL_SCROLL_BAR_TOP_BORDER,
5031 inside_width, start,
5032 False);
5034 /* Change to proper foreground color if one is specified. */
5035 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5036 XSetForeground (FRAME_X_DISPLAY (f), gc,
5037 f->output_data.x->scroll_bar_foreground_pixel);
5039 /* Draw the handle itself. */
5040 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5041 /* x, y, width, height */
5042 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5043 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5044 inside_width, end - start);
5046 /* Restore the foreground color of the GC if we changed it above. */
5047 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5048 XSetForeground (FRAME_X_DISPLAY (f), gc,
5049 FRAME_FOREGROUND_PIXEL (f));
5051 /* Draw the empty space below the handle. Note that we can't
5052 clear zero-height areas; that means "clear to end of window." */
5053 if (end < inside_height)
5054 x_clear_area (FRAME_X_DISPLAY (f), w,
5055 /* x, y, width, height, and exposures. */
5056 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5057 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5058 inside_width, inside_height - end,
5059 False);
5063 UNBLOCK_INPUT;
5066 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5068 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5069 nil. */
5071 static void
5072 x_scroll_bar_remove (struct scroll_bar *bar)
5074 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5075 BLOCK_INPUT;
5077 #ifdef USE_TOOLKIT_SCROLL_BARS
5078 #ifdef USE_GTK
5079 xg_remove_scroll_bar (f, bar->x_window);
5080 #else /* not USE_GTK */
5081 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5082 #endif /* not USE_GTK */
5083 #else
5084 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5085 #endif
5087 /* Disassociate this scroll bar from its window. */
5088 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5090 UNBLOCK_INPUT;
5094 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5095 that we are displaying PORTION characters out of a total of WHOLE
5096 characters, starting at POSITION. If WINDOW has no scroll bar,
5097 create one. */
5099 static void
5100 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5102 struct frame *f = XFRAME (w->frame);
5103 struct scroll_bar *bar;
5104 int top, height, left, sb_left, width, sb_width;
5105 int window_y, window_height;
5106 #ifdef USE_TOOLKIT_SCROLL_BARS
5107 int fringe_extended_p;
5108 #endif
5110 /* Get window dimensions. */
5111 window_box (w, -1, 0, &window_y, 0, &window_height);
5112 top = window_y;
5113 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5114 height = window_height;
5116 /* Compute the left edge of the scroll bar area. */
5117 left = WINDOW_SCROLL_BAR_AREA_X (w);
5119 /* Compute the width of the scroll bar which might be less than
5120 the width of the area reserved for the scroll bar. */
5121 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5122 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5123 else
5124 sb_width = width;
5126 /* Compute the left edge of the scroll bar. */
5127 #ifdef USE_TOOLKIT_SCROLL_BARS
5128 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5129 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5130 else
5131 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5132 #else
5133 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5134 sb_left = left + width - sb_width;
5135 else
5136 sb_left = left;
5137 #endif
5139 #ifdef USE_TOOLKIT_SCROLL_BARS
5140 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5141 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5142 && WINDOW_LEFT_FRINGE_WIDTH (w)
5143 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5144 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5145 else
5146 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5147 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5148 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5149 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5150 #endif
5152 /* Does the scroll bar exist yet? */
5153 if (NILP (w->vertical_scroll_bar))
5155 if (width > 0 && height > 0)
5157 BLOCK_INPUT;
5158 #ifdef USE_TOOLKIT_SCROLL_BARS
5159 if (fringe_extended_p)
5160 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5161 sb_left, top, sb_width, height, False);
5162 else
5163 #endif
5164 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5165 left, top, width, height, False);
5166 UNBLOCK_INPUT;
5169 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5171 else
5173 /* It may just need to be moved and resized. */
5174 unsigned int mask = 0;
5176 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5178 BLOCK_INPUT;
5180 if (sb_left != bar->left)
5181 mask |= CWX;
5182 if (top != bar->top)
5183 mask |= CWY;
5184 if (sb_width != bar->width)
5185 mask |= CWWidth;
5186 if (height != bar->height)
5187 mask |= CWHeight;
5189 #ifdef USE_TOOLKIT_SCROLL_BARS
5191 /* Move/size the scroll bar widget. */
5192 if (mask || bar->fringe_extended_p != fringe_extended_p)
5194 /* Since toolkit scroll bars are smaller than the space reserved
5195 for them on the frame, we have to clear "under" them. */
5196 if (width > 0 && height > 0)
5198 if (fringe_extended_p)
5199 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5200 sb_left, top, sb_width, height, False);
5201 else
5202 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5203 left, top, width, height, False);
5205 #ifdef USE_GTK
5206 xg_update_scrollbar_pos (f,
5207 bar->x_window,
5208 top,
5209 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5210 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5211 max (height, 1));
5212 #else /* not USE_GTK */
5213 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5214 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5215 top,
5216 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5217 max (height, 1), 0);
5218 #endif /* not USE_GTK */
5220 #else /* not USE_TOOLKIT_SCROLL_BARS */
5222 /* Clear areas not covered by the scroll bar because of
5223 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5224 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5226 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5227 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5228 height, False);
5229 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5230 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5231 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5232 height, False);
5235 /* Clear areas not covered by the scroll bar because it's not as
5236 wide as the area reserved for it. This makes sure a
5237 previous mode line display is cleared after C-x 2 C-x 1, for
5238 example. */
5240 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5241 int rest = area_width - sb_width;
5242 if (rest > 0 && height > 0)
5244 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5245 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5246 left + area_width - rest, top,
5247 rest, height, False);
5248 else
5249 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5250 left, top, rest, height, False);
5254 /* Move/size the scroll bar window. */
5255 if (mask)
5257 XWindowChanges wc;
5259 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5260 wc.y = top;
5261 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5262 wc.height = height;
5263 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5264 mask, &wc);
5267 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5269 /* Remember new settings. */
5270 bar->left = sb_left;
5271 bar->top = top;
5272 bar->width = sb_width;
5273 bar->height = height;
5275 UNBLOCK_INPUT;
5278 #ifdef USE_TOOLKIT_SCROLL_BARS
5279 bar->fringe_extended_p = fringe_extended_p;
5281 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5282 #else /* not USE_TOOLKIT_SCROLL_BARS */
5283 /* Set the scroll bar's current state, unless we're currently being
5284 dragged. */
5285 if (NILP (bar->dragging))
5287 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5289 if (whole == 0)
5290 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5291 else
5293 int start = ((double) position * top_range) / whole;
5294 int end = ((double) (position + portion) * top_range) / whole;
5295 x_scroll_bar_set_handle (bar, start, end, 0);
5298 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5300 XSETVECTOR (w->vertical_scroll_bar, bar);
5304 /* The following three hooks are used when we're doing a thorough
5305 redisplay of the frame. We don't explicitly know which scroll bars
5306 are going to be deleted, because keeping track of when windows go
5307 away is a real pain - "Can you say set-window-configuration, boys
5308 and girls?" Instead, we just assert at the beginning of redisplay
5309 that *all* scroll bars are to be removed, and then save a scroll bar
5310 from the fiery pit when we actually redisplay its window. */
5312 /* Arrange for all scroll bars on FRAME to be removed at the next call
5313 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5314 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5316 static void
5317 XTcondemn_scroll_bars (FRAME_PTR frame)
5319 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5320 while (! NILP (FRAME_SCROLL_BARS (frame)))
5322 Lisp_Object bar;
5323 bar = FRAME_SCROLL_BARS (frame);
5324 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5325 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5326 XSCROLL_BAR (bar)->prev = Qnil;
5327 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5328 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5329 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5334 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5335 Note that WINDOW isn't necessarily condemned at all. */
5337 static void
5338 XTredeem_scroll_bar (struct window *window)
5340 struct scroll_bar *bar;
5341 struct frame *f;
5343 /* We can't redeem this window's scroll bar if it doesn't have one. */
5344 if (NILP (window->vertical_scroll_bar))
5345 abort ();
5347 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5349 /* Unlink it from the condemned list. */
5350 f = XFRAME (WINDOW_FRAME (window));
5351 if (NILP (bar->prev))
5353 /* If the prev pointer is nil, it must be the first in one of
5354 the lists. */
5355 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5356 /* It's not condemned. Everything's fine. */
5357 return;
5358 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5359 window->vertical_scroll_bar))
5360 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5361 else
5362 /* If its prev pointer is nil, it must be at the front of
5363 one or the other! */
5364 abort ();
5366 else
5367 XSCROLL_BAR (bar->prev)->next = bar->next;
5369 if (! NILP (bar->next))
5370 XSCROLL_BAR (bar->next)->prev = bar->prev;
5372 bar->next = FRAME_SCROLL_BARS (f);
5373 bar->prev = Qnil;
5374 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5375 if (! NILP (bar->next))
5376 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5379 /* Remove all scroll bars on FRAME that haven't been saved since the
5380 last call to `*condemn_scroll_bars_hook'. */
5382 static void
5383 XTjudge_scroll_bars (FRAME_PTR f)
5385 Lisp_Object bar, next;
5387 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5389 /* Clear out the condemned list now so we won't try to process any
5390 more events on the hapless scroll bars. */
5391 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5393 for (; ! NILP (bar); bar = next)
5395 struct scroll_bar *b = XSCROLL_BAR (bar);
5397 x_scroll_bar_remove (b);
5399 next = b->next;
5400 b->next = b->prev = Qnil;
5403 /* Now there should be no references to the condemned scroll bars,
5404 and they should get garbage-collected. */
5408 #ifndef USE_TOOLKIT_SCROLL_BARS
5409 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5410 is a no-op when using toolkit scroll bars.
5412 This may be called from a signal handler, so we have to ignore GC
5413 mark bits. */
5415 static void
5416 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5418 Window w = bar->x_window;
5419 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5420 GC gc = f->output_data.x->normal_gc;
5421 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5423 BLOCK_INPUT;
5425 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5427 /* Switch to scroll bar foreground color. */
5428 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5429 XSetForeground (FRAME_X_DISPLAY (f), gc,
5430 f->output_data.x->scroll_bar_foreground_pixel);
5432 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5433 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5435 /* x, y, width, height */
5436 0, 0,
5437 bar->width - 1 - width_trim - width_trim,
5438 bar->height - 1);
5440 /* Restore the foreground color of the GC if we changed it above. */
5441 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5442 XSetForeground (FRAME_X_DISPLAY (f), gc,
5443 FRAME_FOREGROUND_PIXEL (f));
5445 UNBLOCK_INPUT;
5448 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5450 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5451 is set to something other than NO_EVENT, it is enqueued.
5453 This may be called from a signal handler, so we have to ignore GC
5454 mark bits. */
5457 static void
5458 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5460 if (! WINDOWP (bar->window))
5461 abort ();
5463 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5464 emacs_event->code = event->xbutton.button - Button1;
5465 emacs_event->modifiers
5466 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5467 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5468 event->xbutton.state)
5469 | (event->type == ButtonRelease
5470 ? up_modifier
5471 : down_modifier));
5472 emacs_event->frame_or_window = bar->window;
5473 emacs_event->arg = Qnil;
5474 emacs_event->timestamp = event->xbutton.time;
5476 int top_range
5477 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5478 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5480 if (y < 0) y = 0;
5481 if (y > top_range) y = top_range;
5483 if (y < bar->start)
5484 emacs_event->part = scroll_bar_above_handle;
5485 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5486 emacs_event->part = scroll_bar_handle;
5487 else
5488 emacs_event->part = scroll_bar_below_handle;
5490 #ifndef USE_TOOLKIT_SCROLL_BARS
5491 /* If the user has released the handle, set it to its final position. */
5492 if (event->type == ButtonRelease
5493 && ! NILP (bar->dragging))
5495 int new_start = y - XINT (bar->dragging);
5496 int new_end = new_start + bar->end - bar->start;
5498 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5499 bar->dragging = Qnil;
5501 #endif
5503 XSETINT (emacs_event->x, y);
5504 XSETINT (emacs_event->y, top_range);
5508 #ifndef USE_TOOLKIT_SCROLL_BARS
5510 /* Handle some mouse motion while someone is dragging the scroll bar.
5512 This may be called from a signal handler, so we have to ignore GC
5513 mark bits. */
5515 static void
5516 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5518 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5520 last_mouse_movement_time = event->xmotion.time;
5522 f->mouse_moved = 1;
5523 XSETVECTOR (last_mouse_scroll_bar, bar);
5525 /* If we're dragging the bar, display it. */
5526 if (! NILP (bar->dragging))
5528 /* Where should the handle be now? */
5529 int new_start = event->xmotion.y - XINT (bar->dragging);
5531 if (new_start != bar->start)
5533 int new_end = new_start + bar->end - bar->start;
5535 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5540 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5542 /* Return information to the user about the current position of the mouse
5543 on the scroll bar. */
5545 static void
5546 x_scroll_bar_report_motion (FRAME_PTR *fp, Lisp_Object *bar_window, enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y, long unsigned int *time)
5548 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5549 Window w = bar->x_window;
5550 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5551 int win_x, win_y;
5552 Window dummy_window;
5553 int dummy_coord;
5554 unsigned int dummy_mask;
5556 BLOCK_INPUT;
5558 /* Get the mouse's position relative to the scroll bar window, and
5559 report that. */
5560 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5562 /* Root, child, root x and root y. */
5563 &dummy_window, &dummy_window,
5564 &dummy_coord, &dummy_coord,
5566 /* Position relative to scroll bar. */
5567 &win_x, &win_y,
5569 /* Mouse buttons and modifier keys. */
5570 &dummy_mask))
5572 else
5574 int top_range
5575 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5577 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5579 if (! NILP (bar->dragging))
5580 win_y -= XINT (bar->dragging);
5582 if (win_y < 0)
5583 win_y = 0;
5584 if (win_y > top_range)
5585 win_y = top_range;
5587 *fp = f;
5588 *bar_window = bar->window;
5590 if (! NILP (bar->dragging))
5591 *part = scroll_bar_handle;
5592 else if (win_y < bar->start)
5593 *part = scroll_bar_above_handle;
5594 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5595 *part = scroll_bar_handle;
5596 else
5597 *part = scroll_bar_below_handle;
5599 XSETINT (*x, win_y);
5600 XSETINT (*y, top_range);
5602 f->mouse_moved = 0;
5603 last_mouse_scroll_bar = Qnil;
5606 *time = last_mouse_movement_time;
5608 UNBLOCK_INPUT;
5612 /* The screen has been cleared so we may have changed foreground or
5613 background colors, and the scroll bars may need to be redrawn.
5614 Clear out the scroll bars, and ask for expose events, so we can
5615 redraw them. */
5617 void
5618 x_scroll_bar_clear (FRAME_PTR f)
5620 #ifndef USE_TOOLKIT_SCROLL_BARS
5621 Lisp_Object bar;
5623 /* We can have scroll bars even if this is 0,
5624 if we just turned off scroll bar mode.
5625 But in that case we should not clear them. */
5626 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5627 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5628 bar = XSCROLL_BAR (bar)->next)
5629 XClearArea (FRAME_X_DISPLAY (f),
5630 XSCROLL_BAR (bar)->x_window,
5631 0, 0, 0, 0, True);
5632 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5636 /* The main X event-reading loop - XTread_socket. */
5638 /* This holds the state XLookupString needs to implement dead keys
5639 and other tricks known as "compose processing". _X Window System_
5640 says that a portable program can't use this, but Stephen Gildea assures
5641 me that letting the compiler initialize it to zeros will work okay.
5643 This must be defined outside of XTread_socket, for the same reasons
5644 given for enter_timestamp, above. */
5646 static XComposeStatus compose_status;
5648 /* Record the last 100 characters stored
5649 to help debug the loss-of-chars-during-GC problem. */
5651 static int temp_index;
5652 static short temp_buffer[100];
5654 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5655 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5656 temp_index = 0; \
5657 temp_buffer[temp_index++] = (keysym)
5659 /* Set this to nonzero to fake an "X I/O error"
5660 on a particular display. */
5662 struct x_display_info *XTread_socket_fake_io_error;
5664 /* When we find no input here, we occasionally do a no-op command
5665 to verify that the X server is still running and we can still talk with it.
5666 We try all the open displays, one by one.
5667 This variable is used for cycling thru the displays. */
5669 static struct x_display_info *next_noop_dpyinfo;
5671 #define SET_SAVED_BUTTON_EVENT \
5672 do \
5674 if (f->output_data.x->saved_menu_event == 0) \
5675 f->output_data.x->saved_menu_event \
5676 = (XEvent *) xmalloc (sizeof (XEvent)); \
5677 *f->output_data.x->saved_menu_event = event; \
5678 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5679 XSETFRAME (inev.ie.frame_or_window, f); \
5681 while (0)
5683 enum
5685 X_EVENT_NORMAL,
5686 X_EVENT_GOTO_OUT,
5687 X_EVENT_DROP
5690 /* Filter events for the current X input method.
5691 DPYINFO is the display this event is for.
5692 EVENT is the X event to filter.
5694 Returns non-zero if the event was filtered, caller shall not process
5695 this event further.
5696 Returns zero if event is wasn't filtered. */
5698 #ifdef HAVE_X_I18N
5699 static int
5700 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5702 /* XFilterEvent returns non-zero if the input method has
5703 consumed the event. We pass the frame's X window to
5704 XFilterEvent because that's the one for which the IC
5705 was created. */
5707 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5708 event->xclient.window);
5710 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5712 #endif
5714 #ifdef USE_GTK
5715 static int current_count;
5716 static int current_finish;
5717 static struct input_event *current_hold_quit;
5719 /* This is the filter function invoked by the GTK event loop.
5720 It is invoked before the XEvent is translated to a GdkEvent,
5721 so we have a chance to act on the event before GTK. */
5722 static GdkFilterReturn
5723 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5725 XEvent *xev = (XEvent *) gxev;
5727 BLOCK_INPUT;
5728 if (current_count >= 0)
5730 struct x_display_info *dpyinfo;
5732 dpyinfo = x_display_info_for_display (xev->xany.display);
5734 #ifdef HAVE_X_I18N
5735 /* Filter events for the current X input method.
5736 GTK calls XFilterEvent but not for key press and release,
5737 so we do it here. */
5738 if ((xev->type == KeyPress || xev->type == KeyRelease)
5739 && dpyinfo
5740 && x_filter_event (dpyinfo, xev))
5742 UNBLOCK_INPUT;
5743 return GDK_FILTER_REMOVE;
5745 #endif
5747 if (! dpyinfo)
5748 current_finish = X_EVENT_NORMAL;
5749 else
5750 current_count +=
5751 handle_one_xevent (dpyinfo, xev, &current_finish,
5752 current_hold_quit);
5754 else
5755 current_finish = x_dispatch_event (xev, xev->xany.display);
5757 UNBLOCK_INPUT;
5759 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5760 return GDK_FILTER_REMOVE;
5762 return GDK_FILTER_CONTINUE;
5764 #endif /* USE_GTK */
5767 /* Handles the XEvent EVENT on display DPYINFO.
5769 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5770 *FINISH is zero if caller should continue reading events.
5771 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5773 We return the number of characters stored into the buffer. */
5775 static int
5776 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventp, int *finish, struct input_event *hold_quit)
5778 union {
5779 struct input_event ie;
5780 struct selection_input_event sie;
5781 } inev;
5782 int count = 0;
5783 int do_help = 0;
5784 int nbytes = 0;
5785 struct frame *f = NULL;
5786 struct coding_system coding;
5787 XEvent event = *eventp;
5788 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5790 *finish = X_EVENT_NORMAL;
5792 EVENT_INIT (inev.ie);
5793 inev.ie.kind = NO_EVENT;
5794 inev.ie.arg = Qnil;
5796 if (pending_event_wait.eventtype == event.type)
5797 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5799 switch (event.type)
5801 case ClientMessage:
5803 if (event.xclient.message_type
5804 == dpyinfo->Xatom_wm_protocols
5805 && event.xclient.format == 32)
5807 if (event.xclient.data.l[0]
5808 == dpyinfo->Xatom_wm_take_focus)
5810 /* Use x_any_window_to_frame because this
5811 could be the shell widget window
5812 if the frame has no title bar. */
5813 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5814 #ifdef HAVE_X_I18N
5815 /* Not quite sure this is needed -pd */
5816 if (f && FRAME_XIC (f))
5817 XSetICFocus (FRAME_XIC (f));
5818 #endif
5819 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5820 instructs the WM to set the input focus automatically for
5821 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5822 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5823 it has set the focus. So, XSetInputFocus below is not
5824 needed.
5826 The call to XSetInputFocus below has also caused trouble. In
5827 cases where the XSetInputFocus done by the WM and the one
5828 below are temporally close (on a fast machine), the call
5829 below can generate additional FocusIn events which confuse
5830 Emacs. */
5832 /* Since we set WM_TAKE_FOCUS, we must call
5833 XSetInputFocus explicitly. But not if f is null,
5834 since that might be an event for a deleted frame. */
5835 if (f)
5837 Display *d = event.xclient.display;
5838 /* Catch and ignore errors, in case window has been
5839 iconified by a window manager such as GWM. */
5840 x_catch_errors (d);
5841 XSetInputFocus (d, event.xclient.window,
5842 /* The ICCCM says this is
5843 the only valid choice. */
5844 RevertToParent,
5845 event.xclient.data.l[1]);
5846 /* This is needed to detect the error
5847 if there is an error. */
5848 XSync (d, False);
5849 x_uncatch_errors ();
5851 /* Not certain about handling scroll bars here */
5852 #endif /* 0 */
5853 goto done;
5856 if (event.xclient.data.l[0]
5857 == dpyinfo->Xatom_wm_save_yourself)
5859 /* Save state modify the WM_COMMAND property to
5860 something which can reinstate us. This notifies
5861 the session manager, who's looking for such a
5862 PropertyNotify. Can restart processing when
5863 a keyboard or mouse event arrives. */
5864 /* If we have a session manager, don't set this.
5865 KDE will then start two Emacsen, one for the
5866 session manager and one for this. */
5867 #ifdef HAVE_X_SM
5868 if (! x_session_have_connection ())
5869 #endif
5871 f = x_top_window_to_frame (dpyinfo,
5872 event.xclient.window);
5873 /* This is just so we only give real data once
5874 for a single Emacs process. */
5875 if (f == SELECTED_FRAME ())
5876 XSetCommand (FRAME_X_DISPLAY (f),
5877 event.xclient.window,
5878 initial_argv, initial_argc);
5879 else if (f)
5880 XSetCommand (FRAME_X_DISPLAY (f),
5881 event.xclient.window,
5882 0, 0);
5884 goto done;
5887 if (event.xclient.data.l[0]
5888 == dpyinfo->Xatom_wm_delete_window)
5890 f = x_any_window_to_frame (dpyinfo,
5891 event.xclient.window);
5892 if (!f)
5893 goto OTHER; /* May be a dialog that is to be removed */
5895 inev.ie.kind = DELETE_WINDOW_EVENT;
5896 XSETFRAME (inev.ie.frame_or_window, f);
5897 goto done;
5900 goto done;
5903 if (event.xclient.message_type
5904 == dpyinfo->Xatom_wm_configure_denied)
5906 goto done;
5909 if (event.xclient.message_type
5910 == dpyinfo->Xatom_wm_window_moved)
5912 int new_x, new_y;
5913 f = x_window_to_frame (dpyinfo, event.xclient.window);
5915 new_x = event.xclient.data.s[0];
5916 new_y = event.xclient.data.s[1];
5918 if (f)
5920 f->left_pos = new_x;
5921 f->top_pos = new_y;
5923 goto done;
5926 #ifdef HACK_EDITRES
5927 if (event.xclient.message_type
5928 == dpyinfo->Xatom_editres)
5930 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5931 if (f)
5932 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5933 &event, NULL);
5934 goto done;
5936 #endif /* HACK_EDITRES */
5938 if ((event.xclient.message_type
5939 == dpyinfo->Xatom_DONE)
5940 || (event.xclient.message_type
5941 == dpyinfo->Xatom_PAGE))
5943 /* Ghostview job completed. Kill it. We could
5944 reply with "Next" if we received "Page", but we
5945 currently never do because we are interested in
5946 images, only, which should have 1 page. */
5947 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5948 f = x_window_to_frame (dpyinfo, event.xclient.window);
5949 if (!f)
5950 goto OTHER;
5951 x_kill_gs_process (pixmap, f);
5952 expose_frame (f, 0, 0, 0, 0);
5953 goto done;
5956 #ifdef USE_TOOLKIT_SCROLL_BARS
5957 /* Scroll bar callbacks send a ClientMessage from which
5958 we construct an input_event. */
5959 if (event.xclient.message_type
5960 == dpyinfo->Xatom_Scrollbar)
5962 x_scroll_bar_to_input_event (&event, &inev.ie);
5963 *finish = X_EVENT_GOTO_OUT;
5964 goto done;
5966 #endif /* USE_TOOLKIT_SCROLL_BARS */
5968 /* XEmbed messages from the embedder (if any). */
5969 if (event.xclient.message_type
5970 == dpyinfo->Xatom_XEMBED)
5972 enum xembed_message msg = event.xclient.data.l[1];
5973 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
5974 x_detect_focus_change (dpyinfo, &event, &inev.ie);
5976 *finish = X_EVENT_GOTO_OUT;
5977 goto done;
5980 xft_settings_event (dpyinfo, &event);
5982 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5983 if (!f)
5984 goto OTHER;
5985 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
5986 *finish = X_EVENT_DROP;
5988 break;
5990 case SelectionNotify:
5991 last_user_time = event.xselection.time;
5992 #ifdef USE_X_TOOLKIT
5993 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
5994 goto OTHER;
5995 #endif /* not USE_X_TOOLKIT */
5996 x_handle_selection_notify (&event.xselection);
5997 break;
5999 case SelectionClear: /* Someone has grabbed ownership. */
6000 last_user_time = event.xselectionclear.time;
6001 #ifdef USE_X_TOOLKIT
6002 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6003 goto OTHER;
6004 #endif /* USE_X_TOOLKIT */
6006 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6008 inev.ie.kind = SELECTION_CLEAR_EVENT;
6009 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6010 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6011 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6012 inev.ie.frame_or_window = Qnil;
6014 break;
6016 case SelectionRequest: /* Someone wants our selection. */
6017 last_user_time = event.xselectionrequest.time;
6018 #ifdef USE_X_TOOLKIT
6019 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6020 goto OTHER;
6021 #endif /* USE_X_TOOLKIT */
6023 XSelectionRequestEvent *eventp
6024 = (XSelectionRequestEvent *) &event;
6026 inev.ie.kind = SELECTION_REQUEST_EVENT;
6027 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6028 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6029 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6030 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6031 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6032 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6033 inev.ie.frame_or_window = Qnil;
6035 break;
6037 case PropertyNotify:
6038 last_user_time = event.xproperty.time;
6039 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6040 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6041 x_handle_net_wm_state (f, &event.xproperty);
6043 x_handle_property_notify (&event.xproperty);
6044 xft_settings_event (dpyinfo, &event);
6045 goto OTHER;
6047 case ReparentNotify:
6048 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6049 if (f)
6051 int x, y;
6052 f->output_data.x->parent_desc = event.xreparent.parent;
6053 x_real_positions (f, &x, &y);
6054 f->left_pos = x;
6055 f->top_pos = y;
6057 /* Perhaps reparented due to a WM restart. Reset this. */
6058 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6059 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6061 goto OTHER;
6063 case Expose:
6064 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6065 if (f)
6067 #ifdef USE_GTK
6068 /* This seems to be needed for GTK 2.6. */
6069 x_clear_area (event.xexpose.display,
6070 event.xexpose.window,
6071 event.xexpose.x, event.xexpose.y,
6072 event.xexpose.width, event.xexpose.height,
6073 FALSE);
6074 #endif
6075 if (f->async_visible == 0)
6077 f->async_visible = 1;
6078 f->async_iconified = 0;
6079 f->output_data.x->has_been_visible = 1;
6080 SET_FRAME_GARBAGED (f);
6082 else
6083 expose_frame (f,
6084 event.xexpose.x, event.xexpose.y,
6085 event.xexpose.width, event.xexpose.height);
6087 else
6089 #ifndef USE_TOOLKIT_SCROLL_BARS
6090 struct scroll_bar *bar;
6091 #endif
6092 #if defined USE_LUCID
6093 /* Submenus of the Lucid menu bar aren't widgets
6094 themselves, so there's no way to dispatch events
6095 to them. Recognize this case separately. */
6097 Widget widget
6098 = x_window_to_menu_bar (event.xexpose.window);
6099 if (widget)
6100 xlwmenu_redisplay (widget);
6102 #endif /* USE_LUCID */
6104 #ifdef USE_TOOLKIT_SCROLL_BARS
6105 /* Dispatch event to the widget. */
6106 goto OTHER;
6107 #else /* not USE_TOOLKIT_SCROLL_BARS */
6108 bar = x_window_to_scroll_bar (event.xexpose.display,
6109 event.xexpose.window);
6111 if (bar)
6112 x_scroll_bar_expose (bar, &event);
6113 #ifdef USE_X_TOOLKIT
6114 else
6115 goto OTHER;
6116 #endif /* USE_X_TOOLKIT */
6117 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6119 break;
6121 case GraphicsExpose: /* This occurs when an XCopyArea's
6122 source area was obscured or not
6123 available. */
6124 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6125 if (f)
6127 expose_frame (f,
6128 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6129 event.xgraphicsexpose.width,
6130 event.xgraphicsexpose.height);
6132 #ifdef USE_X_TOOLKIT
6133 else
6134 goto OTHER;
6135 #endif /* USE_X_TOOLKIT */
6136 break;
6138 case NoExpose: /* This occurs when an XCopyArea's
6139 source area was completely
6140 available. */
6141 break;
6143 case UnmapNotify:
6144 /* Redo the mouse-highlight after the tooltip has gone. */
6145 if (event.xmap.window == tip_window)
6147 tip_window = 0;
6148 redo_mouse_highlight ();
6151 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6152 if (f) /* F may no longer exist if
6153 the frame was deleted. */
6155 /* While a frame is unmapped, display generation is
6156 disabled; you don't want to spend time updating a
6157 display that won't ever be seen. */
6158 f->async_visible = 0;
6159 /* We can't distinguish, from the event, whether the window
6160 has become iconified or invisible. So assume, if it
6161 was previously visible, than now it is iconified.
6162 But x_make_frame_invisible clears both
6163 the visible flag and the iconified flag;
6164 and that way, we know the window is not iconified now. */
6165 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6167 f->async_iconified = 1;
6169 inev.ie.kind = ICONIFY_EVENT;
6170 XSETFRAME (inev.ie.frame_or_window, f);
6173 goto OTHER;
6175 case MapNotify:
6176 if (event.xmap.window == tip_window)
6177 /* The tooltip has been drawn already. Avoid
6178 the SET_FRAME_GARBAGED below. */
6179 goto OTHER;
6181 /* We use x_top_window_to_frame because map events can
6182 come for sub-windows and they don't mean that the
6183 frame is visible. */
6184 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6185 if (f)
6187 /* wait_reading_process_output will notice this and update
6188 the frame's display structures.
6189 If we where iconified, we should not set garbaged,
6190 because that stops redrawing on Expose events. This looks
6191 bad if we are called from a recursive event loop
6192 (x_dispatch_event), for example when a dialog is up. */
6193 if (! f->async_iconified)
6194 SET_FRAME_GARBAGED (f);
6196 /* Check if fullscreen was specified before we where mapped the
6197 first time, i.e. from the command line. */
6198 if (!f->output_data.x->has_been_visible)
6199 x_check_fullscreen (f);
6201 f->async_visible = 1;
6202 f->async_iconified = 0;
6203 f->output_data.x->has_been_visible = 1;
6205 if (f->iconified)
6207 inev.ie.kind = DEICONIFY_EVENT;
6208 XSETFRAME (inev.ie.frame_or_window, f);
6210 else if (! NILP (Vframe_list)
6211 && ! NILP (XCDR (Vframe_list)))
6212 /* Force a redisplay sooner or later
6213 to update the frame titles
6214 in case this is the second frame. */
6215 record_asynch_buffer_change ();
6217 #ifdef USE_GTK
6218 xg_frame_resized (f, -1, -1);
6219 #endif
6221 goto OTHER;
6223 case KeyPress:
6225 last_user_time = event.xkey.time;
6226 ignore_next_mouse_click_timeout = 0;
6228 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6229 /* Dispatch KeyPress events when in menu. */
6230 if (popup_activated ())
6231 goto OTHER;
6232 #endif
6234 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6236 /* If mouse-highlight is an integer, input clears out
6237 mouse highlighting. */
6238 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6239 && (f == 0
6240 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6242 clear_mouse_face (hlinfo);
6243 hlinfo->mouse_face_hidden = 1;
6246 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6247 if (f == 0)
6249 /* Scroll bars consume key events, but we want
6250 the keys to go to the scroll bar's frame. */
6251 Widget widget = XtWindowToWidget (dpyinfo->display,
6252 event.xkey.window);
6253 if (widget && XmIsScrollBar (widget))
6255 widget = XtParent (widget);
6256 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6259 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6261 if (f != 0)
6263 KeySym keysym, orig_keysym;
6264 /* al%imercury@uunet.uu.net says that making this 81
6265 instead of 80 fixed a bug whereby meta chars made
6266 his Emacs hang.
6268 It seems that some version of XmbLookupString has
6269 a bug of not returning XBufferOverflow in
6270 status_return even if the input is too long to
6271 fit in 81 bytes. So, we must prepare sufficient
6272 bytes for copy_buffer. 513 bytes (256 chars for
6273 two-byte character set) seems to be a fairly good
6274 approximation. -- 2000.8.10 handa@etl.go.jp */
6275 unsigned char copy_buffer[513];
6276 unsigned char *copy_bufptr = copy_buffer;
6277 int copy_bufsiz = sizeof (copy_buffer);
6278 int modifiers;
6279 Lisp_Object coding_system = Qlatin_1;
6280 Lisp_Object c;
6282 #ifdef USE_GTK
6283 /* Don't pass keys to GTK. A Tab will shift focus to the
6284 tool bar in GTK 2.4. Keys will still go to menus and
6285 dialogs because in that case popup_activated is TRUE
6286 (see above). */
6287 *finish = X_EVENT_DROP;
6288 #endif
6290 event.xkey.state
6291 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6292 extra_keyboard_modifiers);
6293 modifiers = event.xkey.state;
6295 /* This will have to go some day... */
6297 /* make_lispy_event turns chars into control chars.
6298 Don't do it here because XLookupString is too eager. */
6299 event.xkey.state &= ~ControlMask;
6300 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6301 | dpyinfo->super_mod_mask
6302 | dpyinfo->hyper_mod_mask
6303 | dpyinfo->alt_mod_mask);
6305 /* In case Meta is ComposeCharacter,
6306 clear its status. According to Markus Ehrnsperger
6307 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6308 this enables ComposeCharacter to work whether or
6309 not it is combined with Meta. */
6310 if (modifiers & dpyinfo->meta_mod_mask)
6311 memset (&compose_status, 0, sizeof (compose_status));
6313 #ifdef HAVE_X_I18N
6314 if (FRAME_XIC (f))
6316 Status status_return;
6318 coding_system = Vlocale_coding_system;
6319 nbytes = XmbLookupString (FRAME_XIC (f),
6320 &event.xkey, copy_bufptr,
6321 copy_bufsiz, &keysym,
6322 &status_return);
6323 if (status_return == XBufferOverflow)
6325 copy_bufsiz = nbytes + 1;
6326 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6327 nbytes = XmbLookupString (FRAME_XIC (f),
6328 &event.xkey, copy_bufptr,
6329 copy_bufsiz, &keysym,
6330 &status_return);
6332 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6333 if (status_return == XLookupNone)
6334 break;
6335 else if (status_return == XLookupChars)
6337 keysym = NoSymbol;
6338 modifiers = 0;
6340 else if (status_return != XLookupKeySym
6341 && status_return != XLookupBoth)
6342 abort ();
6344 else
6345 nbytes = XLookupString (&event.xkey, copy_bufptr,
6346 copy_bufsiz, &keysym,
6347 &compose_status);
6348 #else
6349 nbytes = XLookupString (&event.xkey, copy_bufptr,
6350 copy_bufsiz, &keysym,
6351 &compose_status);
6352 #endif
6354 /* If not using XIM/XIC, and a compose sequence is in progress,
6355 we break here. Otherwise, chars_matched is always 0. */
6356 if (compose_status.chars_matched > 0 && nbytes == 0)
6357 break;
6359 memset (&compose_status, 0, sizeof (compose_status));
6360 orig_keysym = keysym;
6362 /* Common for all keysym input events. */
6363 XSETFRAME (inev.ie.frame_or_window, f);
6364 inev.ie.modifiers
6365 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6366 inev.ie.timestamp = event.xkey.time;
6368 /* First deal with keysyms which have defined
6369 translations to characters. */
6370 if (keysym >= 32 && keysym < 128)
6371 /* Avoid explicitly decoding each ASCII character. */
6373 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6374 inev.ie.code = keysym;
6375 goto done_keysym;
6378 /* Keysyms directly mapped to Unicode characters. */
6379 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6381 if (keysym < 0x01000080)
6382 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6383 else
6384 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6385 inev.ie.code = keysym & 0xFFFFFF;
6386 goto done_keysym;
6389 /* Now non-ASCII. */
6390 if (HASH_TABLE_P (Vx_keysym_table)
6391 && (NATNUMP (c = Fgethash (make_number (keysym),
6392 Vx_keysym_table,
6393 Qnil))))
6395 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6396 ? ASCII_KEYSTROKE_EVENT
6397 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6398 inev.ie.code = XFASTINT (c);
6399 goto done_keysym;
6402 /* Random non-modifier sorts of keysyms. */
6403 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6404 || keysym == XK_Delete
6405 #ifdef XK_ISO_Left_Tab
6406 || (keysym >= XK_ISO_Left_Tab
6407 && keysym <= XK_ISO_Enter)
6408 #endif
6409 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6410 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6411 #ifdef HPUX
6412 /* This recognizes the "extended function
6413 keys". It seems there's no cleaner way.
6414 Test IsModifierKey to avoid handling
6415 mode_switch incorrectly. */
6416 || ((unsigned) (keysym) >= XK_Select
6417 && (unsigned)(keysym) < XK_KP_Space)
6418 #endif
6419 #ifdef XK_dead_circumflex
6420 || orig_keysym == XK_dead_circumflex
6421 #endif
6422 #ifdef XK_dead_grave
6423 || orig_keysym == XK_dead_grave
6424 #endif
6425 #ifdef XK_dead_tilde
6426 || orig_keysym == XK_dead_tilde
6427 #endif
6428 #ifdef XK_dead_diaeresis
6429 || orig_keysym == XK_dead_diaeresis
6430 #endif
6431 #ifdef XK_dead_macron
6432 || orig_keysym == XK_dead_macron
6433 #endif
6434 #ifdef XK_dead_degree
6435 || orig_keysym == XK_dead_degree
6436 #endif
6437 #ifdef XK_dead_acute
6438 || orig_keysym == XK_dead_acute
6439 #endif
6440 #ifdef XK_dead_cedilla
6441 || orig_keysym == XK_dead_cedilla
6442 #endif
6443 #ifdef XK_dead_breve
6444 || orig_keysym == XK_dead_breve
6445 #endif
6446 #ifdef XK_dead_ogonek
6447 || orig_keysym == XK_dead_ogonek
6448 #endif
6449 #ifdef XK_dead_caron
6450 || orig_keysym == XK_dead_caron
6451 #endif
6452 #ifdef XK_dead_doubleacute
6453 || orig_keysym == XK_dead_doubleacute
6454 #endif
6455 #ifdef XK_dead_abovedot
6456 || orig_keysym == XK_dead_abovedot
6457 #endif
6458 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6459 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6460 /* Any "vendor-specific" key is ok. */
6461 || (orig_keysym & (1 << 28))
6462 || (keysym != NoSymbol && nbytes == 0))
6463 && ! (IsModifierKey (orig_keysym)
6464 /* The symbols from XK_ISO_Lock
6465 to XK_ISO_Last_Group_Lock
6466 don't have real modifiers but
6467 should be treated similarly to
6468 Mode_switch by Emacs. */
6469 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6470 || ((unsigned)(orig_keysym)
6471 >= XK_ISO_Lock
6472 && (unsigned)(orig_keysym)
6473 <= XK_ISO_Last_Group_Lock)
6474 #endif
6477 STORE_KEYSYM_FOR_DEBUG (keysym);
6478 /* make_lispy_event will convert this to a symbolic
6479 key. */
6480 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6481 inev.ie.code = keysym;
6482 goto done_keysym;
6485 { /* Raw bytes, not keysym. */
6486 register int i;
6487 register int c;
6488 int nchars, len;
6490 for (i = 0, nchars = 0; i < nbytes; i++)
6492 if (ASCII_BYTE_P (copy_bufptr[i]))
6493 nchars++;
6494 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6497 if (nchars < nbytes)
6499 /* Decode the input data. */
6500 int require;
6501 unsigned char *p;
6503 /* The input should be decoded with `coding_system'
6504 which depends on which X*LookupString function
6505 we used just above and the locale. */
6506 setup_coding_system (coding_system, &coding);
6507 coding.src_multibyte = 0;
6508 coding.dst_multibyte = 1;
6509 /* The input is converted to events, thus we can't
6510 handle composition. Anyway, there's no XIM that
6511 gives us composition information. */
6512 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6514 require = MAX_MULTIBYTE_LENGTH * nbytes;
6515 coding.destination = alloca (require);
6516 coding.dst_bytes = require;
6517 coding.mode |= CODING_MODE_LAST_BLOCK;
6518 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6519 nbytes = coding.produced;
6520 nchars = coding.produced_char;
6521 copy_bufptr = coding.destination;
6524 /* Convert the input data to a sequence of
6525 character events. */
6526 for (i = 0; i < nbytes; i += len)
6528 if (nchars == nbytes)
6529 c = copy_bufptr[i], len = 1;
6530 else
6531 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6532 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6533 ? ASCII_KEYSTROKE_EVENT
6534 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6535 inev.ie.code = c;
6536 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6539 count += nchars;
6541 inev.ie.kind = NO_EVENT; /* Already stored above. */
6543 if (keysym == NoSymbol)
6544 break;
6547 done_keysym:
6548 #ifdef HAVE_X_I18N
6549 /* Don't dispatch this event since XtDispatchEvent calls
6550 XFilterEvent, and two calls in a row may freeze the
6551 client. */
6552 break;
6553 #else
6554 goto OTHER;
6555 #endif
6557 case KeyRelease:
6558 last_user_time = event.xkey.time;
6559 #ifdef HAVE_X_I18N
6560 /* Don't dispatch this event since XtDispatchEvent calls
6561 XFilterEvent, and two calls in a row may freeze the
6562 client. */
6563 break;
6564 #else
6565 goto OTHER;
6566 #endif
6568 case EnterNotify:
6569 last_user_time = event.xcrossing.time;
6570 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6572 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6574 if (f && x_mouse_click_focus_ignore_position)
6575 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6577 /* EnterNotify counts as mouse movement,
6578 so update things that depend on mouse position. */
6579 if (f && !f->output_data.x->hourglass_p)
6580 note_mouse_movement (f, &event.xmotion);
6581 #ifdef USE_GTK
6582 /* We may get an EnterNotify on the buttons in the toolbar. In that
6583 case we moved out of any highlighted area and need to note this. */
6584 if (!f && last_mouse_glyph_frame)
6585 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6586 #endif
6587 goto OTHER;
6589 case FocusIn:
6590 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6591 goto OTHER;
6593 case LeaveNotify:
6594 last_user_time = event.xcrossing.time;
6595 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6597 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6598 if (f)
6600 if (f == hlinfo->mouse_face_mouse_frame)
6602 /* If we move outside the frame, then we're
6603 certainly no longer on any text in the frame. */
6604 clear_mouse_face (hlinfo);
6605 hlinfo->mouse_face_mouse_frame = 0;
6608 /* Generate a nil HELP_EVENT to cancel a help-echo.
6609 Do it only if there's something to cancel.
6610 Otherwise, the startup message is cleared when
6611 the mouse leaves the frame. */
6612 if (any_help_event_p)
6613 do_help = -1;
6615 #ifdef USE_GTK
6616 /* See comment in EnterNotify above */
6617 else if (last_mouse_glyph_frame)
6618 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6619 #endif
6620 goto OTHER;
6622 case FocusOut:
6623 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6624 goto OTHER;
6626 case MotionNotify:
6628 last_user_time = event.xmotion.time;
6629 previous_help_echo_string = help_echo_string;
6630 help_echo_string = Qnil;
6632 if (dpyinfo->grabbed && last_mouse_frame
6633 && FRAME_LIVE_P (last_mouse_frame))
6634 f = last_mouse_frame;
6635 else
6636 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6638 if (hlinfo->mouse_face_hidden)
6640 hlinfo->mouse_face_hidden = 0;
6641 clear_mouse_face (hlinfo);
6644 #ifdef USE_GTK
6645 if (f && xg_event_is_for_scrollbar (f, &event))
6646 f = 0;
6647 #endif
6648 if (f)
6651 /* Generate SELECT_WINDOW_EVENTs when needed.
6652 Don't let popup menus influence things (bug#1261). */
6653 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6655 Lisp_Object window;
6657 window = window_from_coordinates (f,
6658 event.xmotion.x, event.xmotion.y,
6659 0, 0);
6661 /* Window will be selected only when it is not selected now and
6662 last mouse movement event was not in it. Minibuffer window
6663 will be selected only when it is active. */
6664 if (WINDOWP (window)
6665 && !EQ (window, last_window)
6666 && !EQ (window, selected_window)
6667 /* For click-to-focus window managers
6668 create event iff we don't leave the
6669 selected frame. */
6670 && (focus_follows_mouse
6671 || (EQ (XWINDOW (window)->frame,
6672 XWINDOW (selected_window)->frame))))
6674 inev.ie.kind = SELECT_WINDOW_EVENT;
6675 inev.ie.frame_or_window = window;
6678 last_window=window;
6680 if (!note_mouse_movement (f, &event.xmotion))
6681 help_echo_string = previous_help_echo_string;
6683 else
6685 #ifndef USE_TOOLKIT_SCROLL_BARS
6686 struct scroll_bar *bar
6687 = x_window_to_scroll_bar (event.xmotion.display,
6688 event.xmotion.window);
6690 if (bar)
6691 x_scroll_bar_note_movement (bar, &event);
6692 #endif /* USE_TOOLKIT_SCROLL_BARS */
6694 /* If we move outside the frame, then we're
6695 certainly no longer on any text in the frame. */
6696 clear_mouse_face (hlinfo);
6699 /* If the contents of the global variable help_echo_string
6700 has changed, generate a HELP_EVENT. */
6701 if (!NILP (help_echo_string)
6702 || !NILP (previous_help_echo_string))
6703 do_help = 1;
6704 goto OTHER;
6707 case ConfigureNotify:
6708 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6709 #ifdef USE_GTK
6710 if (!f
6711 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6712 && event.xconfigure.window == FRAME_X_WINDOW (f))
6714 xg_frame_resized (f, event.xconfigure.width,
6715 event.xconfigure.height);
6716 f = 0;
6718 #endif
6719 if (f)
6721 #ifndef USE_X_TOOLKIT
6722 #ifndef USE_GTK
6723 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6724 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6726 /* In the toolkit version, change_frame_size
6727 is called by the code that handles resizing
6728 of the EmacsFrame widget. */
6730 /* Even if the number of character rows and columns has
6731 not changed, the font size may have changed, so we need
6732 to check the pixel dimensions as well. */
6733 if (columns != FRAME_COLS (f)
6734 || rows != FRAME_LINES (f)
6735 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6736 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6738 change_frame_size (f, rows, columns, 0, 1, 0);
6739 SET_FRAME_GARBAGED (f);
6740 cancel_mouse_face (f);
6743 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6744 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6745 #endif /* not USE_GTK */
6746 #endif
6748 #ifdef USE_GTK
6749 /* GTK creates windows but doesn't map them.
6750 Only get real positions when mapped. */
6751 if (FRAME_GTK_OUTER_WIDGET (f)
6752 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6753 #endif
6755 x_real_positions (f, &f->left_pos, &f->top_pos);
6758 #ifdef HAVE_X_I18N
6759 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6760 xic_set_statusarea (f);
6761 #endif
6764 goto OTHER;
6766 case ButtonRelease:
6767 case ButtonPress:
6769 /* If we decide we want to generate an event to be seen
6770 by the rest of Emacs, we put it here. */
6771 int tool_bar_p = 0;
6773 memset (&compose_status, 0, sizeof (compose_status));
6774 last_mouse_glyph_frame = 0;
6775 last_user_time = event.xbutton.time;
6777 if (dpyinfo->grabbed
6778 && last_mouse_frame
6779 && FRAME_LIVE_P (last_mouse_frame))
6780 f = last_mouse_frame;
6781 else
6782 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6784 #ifdef USE_GTK
6785 if (f && xg_event_is_for_scrollbar (f, &event))
6786 f = 0;
6787 #endif
6788 if (f)
6790 /* Is this in the tool-bar? */
6791 if (WINDOWP (f->tool_bar_window)
6792 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6794 Lisp_Object window;
6795 int x = event.xbutton.x;
6796 int y = event.xbutton.y;
6798 window = window_from_coordinates (f, x, y, 0, 1);
6799 tool_bar_p = EQ (window, f->tool_bar_window);
6801 if (tool_bar_p && event.xbutton.button < 4)
6803 handle_tool_bar_click (f, x, y,
6804 event.xbutton.type == ButtonPress,
6805 x_x_to_emacs_modifiers (dpyinfo,
6806 event.xbutton.state));
6810 if (!tool_bar_p)
6811 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6812 if (! popup_activated ())
6813 #endif
6815 if (ignore_next_mouse_click_timeout)
6817 if (event.type == ButtonPress
6818 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6820 ignore_next_mouse_click_timeout = 0;
6821 construct_mouse_click (&inev.ie, &event.xbutton, f);
6823 if (event.type == ButtonRelease)
6824 ignore_next_mouse_click_timeout = 0;
6826 else
6827 construct_mouse_click (&inev.ie, &event.xbutton, f);
6829 if (FRAME_X_EMBEDDED_P (f))
6830 xembed_send_message (f, event.xbutton.time,
6831 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6833 else
6835 struct scroll_bar *bar
6836 = x_window_to_scroll_bar (event.xbutton.display,
6837 event.xbutton.window);
6839 #ifdef USE_TOOLKIT_SCROLL_BARS
6840 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6841 scroll bars. */
6842 if (bar && event.xbutton.state & ControlMask)
6844 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6845 *finish = X_EVENT_DROP;
6847 #else /* not USE_TOOLKIT_SCROLL_BARS */
6848 if (bar)
6849 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6850 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6853 if (event.type == ButtonPress)
6855 dpyinfo->grabbed |= (1 << event.xbutton.button);
6856 last_mouse_frame = f;
6858 if (!tool_bar_p)
6859 last_tool_bar_item = -1;
6861 else
6862 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6864 /* Ignore any mouse motion that happened before this event;
6865 any subsequent mouse-movement Emacs events should reflect
6866 only motion after the ButtonPress/Release. */
6867 if (f != 0)
6868 f->mouse_moved = 0;
6870 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6871 f = x_menubar_window_to_frame (dpyinfo, &event);
6872 /* For a down-event in the menu bar,
6873 don't pass it to Xt right now.
6874 Instead, save it away
6875 and we will pass it to Xt from kbd_buffer_get_event.
6876 That way, we can run some Lisp code first. */
6877 if (! popup_activated ()
6878 #ifdef USE_GTK
6879 /* Gtk+ menus only react to the first three buttons. */
6880 && event.xbutton.button < 3
6881 #endif
6882 && f && event.type == ButtonPress
6883 /* Verify the event is really within the menu bar
6884 and not just sent to it due to grabbing. */
6885 && event.xbutton.x >= 0
6886 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6887 && event.xbutton.y >= 0
6888 && event.xbutton.y < f->output_data.x->menubar_height
6889 && event.xbutton.same_screen)
6891 SET_SAVED_BUTTON_EVENT;
6892 XSETFRAME (last_mouse_press_frame, f);
6893 *finish = X_EVENT_DROP;
6895 else if (event.type == ButtonPress)
6897 last_mouse_press_frame = Qnil;
6898 goto OTHER;
6900 else
6901 goto OTHER;
6902 #endif /* USE_X_TOOLKIT || USE_GTK */
6904 break;
6906 case CirculateNotify:
6907 goto OTHER;
6909 case CirculateRequest:
6910 goto OTHER;
6912 case VisibilityNotify:
6913 goto OTHER;
6915 case MappingNotify:
6916 /* Someone has changed the keyboard mapping - update the
6917 local cache. */
6918 switch (event.xmapping.request)
6920 case MappingModifier:
6921 x_find_modifier_meanings (dpyinfo);
6922 /* This is meant to fall through. */
6923 case MappingKeyboard:
6924 XRefreshKeyboardMapping (&event.xmapping);
6926 goto OTHER;
6928 case DestroyNotify:
6929 xft_settings_event (dpyinfo, &event);
6930 break;
6932 default:
6933 OTHER:
6934 #ifdef USE_X_TOOLKIT
6935 BLOCK_INPUT;
6936 if (*finish != X_EVENT_DROP)
6937 XtDispatchEvent (&event);
6938 UNBLOCK_INPUT;
6939 #endif /* USE_X_TOOLKIT */
6940 break;
6943 done:
6944 if (inev.ie.kind != NO_EVENT)
6946 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6947 count++;
6950 if (do_help
6951 && !(hold_quit && hold_quit->kind != NO_EVENT))
6953 Lisp_Object frame;
6955 if (f)
6956 XSETFRAME (frame, f);
6957 else
6958 frame = Qnil;
6960 if (do_help > 0)
6962 any_help_event_p = 1;
6963 gen_help_event (help_echo_string, frame, help_echo_window,
6964 help_echo_object, help_echo_pos);
6966 else
6968 help_echo_string = Qnil;
6969 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6971 count++;
6974 *eventp = event;
6975 return count;
6979 /* Handles the XEvent EVENT on display DISPLAY.
6980 This is used for event loops outside the normal event handling,
6981 i.e. looping while a popup menu or a dialog is posted.
6983 Returns the value handle_one_xevent sets in the finish argument. */
6985 x_dispatch_event (XEvent *event, Display *display)
6987 struct x_display_info *dpyinfo;
6988 int finish = X_EVENT_NORMAL;
6990 dpyinfo = x_display_info_for_display (display);
6992 if (dpyinfo)
6993 handle_one_xevent (dpyinfo, event, &finish, 0);
6995 return finish;
6999 /* Read events coming from the X server.
7000 This routine is called by the SIGIO handler.
7001 We return as soon as there are no more events to be read.
7003 We return the number of characters stored into the buffer,
7004 thus pretending to be `read' (except the characters we store
7005 in the keyboard buffer can be multibyte, so are not necessarily
7006 C chars).
7008 EXPECTED is nonzero if the caller knows input is available. */
7010 static int
7011 XTread_socket (struct terminal *terminal, int expected, struct input_event *hold_quit)
7013 int count = 0;
7014 XEvent event;
7015 int event_found = 0;
7017 if (interrupt_input_blocked)
7019 interrupt_input_pending = 1;
7020 #ifdef SYNC_INPUT
7021 pending_signals = 1;
7022 #endif
7023 return -1;
7026 interrupt_input_pending = 0;
7027 #ifdef SYNC_INPUT
7028 pending_signals = pending_atimers;
7029 #endif
7030 BLOCK_INPUT;
7032 /* So people can tell when we have read the available input. */
7033 input_signal_count++;
7035 ++handling_signal;
7037 #ifdef HAVE_X_SM
7038 /* Only check session manager input for the primary display. */
7039 if (terminal->id == 1 && x_session_have_connection ())
7041 struct input_event inev;
7042 BLOCK_INPUT;
7043 /* We don't need to EVENT_INIT (inev) here, as
7044 x_session_check_input copies an entire input_event. */
7045 if (x_session_check_input (&inev))
7047 kbd_buffer_store_event_hold (&inev, hold_quit);
7048 count++;
7050 UNBLOCK_INPUT;
7052 #endif
7054 /* For debugging, this gives a way to fake an I/O error. */
7055 if (terminal->display_info.x == XTread_socket_fake_io_error)
7057 XTread_socket_fake_io_error = 0;
7058 x_io_error_quitter (terminal->display_info.x->display);
7061 #ifndef USE_GTK
7062 while (XPending (terminal->display_info.x->display))
7064 int finish;
7066 XNextEvent (terminal->display_info.x->display, &event);
7068 #ifdef HAVE_X_I18N
7069 /* Filter events for the current X input method. */
7070 if (x_filter_event (terminal->display_info.x, &event))
7071 continue;
7072 #endif
7073 event_found = 1;
7075 count += handle_one_xevent (terminal->display_info.x,
7076 &event, &finish, hold_quit);
7078 if (finish == X_EVENT_GOTO_OUT)
7079 goto out;
7082 #else /* USE_GTK */
7084 /* For GTK we must use the GTK event loop. But XEvents gets passed
7085 to our filter function above, and then to the big event switch.
7086 We use a bunch of globals to communicate with our filter function,
7087 that is kind of ugly, but it works.
7089 There is no way to do one display at the time, GTK just does events
7090 from all displays. */
7092 while (gtk_events_pending ())
7094 current_count = count;
7095 current_hold_quit = hold_quit;
7097 gtk_main_iteration ();
7099 count = current_count;
7100 current_count = -1;
7101 current_hold_quit = 0;
7103 if (current_finish == X_EVENT_GOTO_OUT)
7104 break;
7106 #endif /* USE_GTK */
7108 out:;
7110 /* On some systems, an X bug causes Emacs to get no more events
7111 when the window is destroyed. Detect that. (1994.) */
7112 if (! event_found)
7114 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7115 One XNOOP in 100 loops will make Emacs terminate.
7116 B. Bretthauer, 1994 */
7117 x_noop_count++;
7118 if (x_noop_count >= 100)
7120 x_noop_count=0;
7122 if (next_noop_dpyinfo == 0)
7123 next_noop_dpyinfo = x_display_list;
7125 XNoOp (next_noop_dpyinfo->display);
7127 /* Each time we get here, cycle through the displays now open. */
7128 next_noop_dpyinfo = next_noop_dpyinfo->next;
7132 /* If the focus was just given to an auto-raising frame,
7133 raise it now. */
7134 /* ??? This ought to be able to handle more than one such frame. */
7135 if (pending_autoraise_frame)
7137 x_raise_frame (pending_autoraise_frame);
7138 pending_autoraise_frame = 0;
7141 --handling_signal;
7142 UNBLOCK_INPUT;
7144 return count;
7150 /***********************************************************************
7151 Text Cursor
7152 ***********************************************************************/
7154 /* Set clipping for output in glyph row ROW. W is the window in which
7155 we operate. GC is the graphics context to set clipping in.
7157 ROW may be a text row or, e.g., a mode line. Text rows must be
7158 clipped to the interior of the window dedicated to text display,
7159 mode lines must be clipped to the whole window. */
7161 static void
7162 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7164 struct frame *f = XFRAME (WINDOW_FRAME (w));
7165 XRectangle clip_rect;
7166 int window_x, window_y, window_width;
7168 window_box (w, area, &window_x, &window_y, &window_width, 0);
7170 clip_rect.x = window_x;
7171 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7172 clip_rect.y = max (clip_rect.y, window_y);
7173 clip_rect.width = window_width;
7174 clip_rect.height = row->visible_height;
7176 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7180 /* Draw a hollow box cursor on window W in glyph row ROW. */
7182 static void
7183 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7185 struct frame *f = XFRAME (WINDOW_FRAME (w));
7186 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7187 Display *dpy = FRAME_X_DISPLAY (f);
7188 int x, y, wd, h;
7189 XGCValues xgcv;
7190 struct glyph *cursor_glyph;
7191 GC gc;
7193 /* Get the glyph the cursor is on. If we can't tell because
7194 the current matrix is invalid or such, give up. */
7195 cursor_glyph = get_phys_cursor_glyph (w);
7196 if (cursor_glyph == NULL)
7197 return;
7199 /* Compute frame-relative coordinates for phys cursor. */
7200 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7201 wd = w->phys_cursor_width;
7203 /* The foreground of cursor_gc is typically the same as the normal
7204 background color, which can cause the cursor box to be invisible. */
7205 xgcv.foreground = f->output_data.x->cursor_pixel;
7206 if (dpyinfo->scratch_cursor_gc)
7207 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7208 else
7209 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7210 GCForeground, &xgcv);
7211 gc = dpyinfo->scratch_cursor_gc;
7213 /* Set clipping, draw the rectangle, and reset clipping again. */
7214 x_clip_to_row (w, row, TEXT_AREA, gc);
7215 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7216 XSetClipMask (dpy, gc, None);
7220 /* Draw a bar cursor on window W in glyph row ROW.
7222 Implementation note: One would like to draw a bar cursor with an
7223 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7224 Unfortunately, I didn't find a font yet that has this property set.
7225 --gerd. */
7227 static void
7228 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7230 struct frame *f = XFRAME (w->frame);
7231 struct glyph *cursor_glyph;
7233 /* If cursor is out of bounds, don't draw garbage. This can happen
7234 in mini-buffer windows when switching between echo area glyphs
7235 and mini-buffer. */
7236 cursor_glyph = get_phys_cursor_glyph (w);
7237 if (cursor_glyph == NULL)
7238 return;
7240 /* If on an image, draw like a normal cursor. That's usually better
7241 visible than drawing a bar, esp. if the image is large so that
7242 the bar might not be in the window. */
7243 if (cursor_glyph->type == IMAGE_GLYPH)
7245 struct glyph_row *row;
7246 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7247 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7249 else
7251 Display *dpy = FRAME_X_DISPLAY (f);
7252 Window window = FRAME_X_WINDOW (f);
7253 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7254 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7255 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7256 XGCValues xgcv;
7258 /* If the glyph's background equals the color we normally draw
7259 the bars cursor in, the bar cursor in its normal color is
7260 invisible. Use the glyph's foreground color instead in this
7261 case, on the assumption that the glyph's colors are chosen so
7262 that the glyph is legible. */
7263 if (face->background == f->output_data.x->cursor_pixel)
7264 xgcv.background = xgcv.foreground = face->foreground;
7265 else
7266 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7267 xgcv.graphics_exposures = 0;
7269 if (gc)
7270 XChangeGC (dpy, gc, mask, &xgcv);
7271 else
7273 gc = XCreateGC (dpy, window, mask, &xgcv);
7274 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7277 x_clip_to_row (w, row, TEXT_AREA, gc);
7279 if (kind == BAR_CURSOR)
7281 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7283 if (width < 0)
7284 width = FRAME_CURSOR_WIDTH (f);
7285 width = min (cursor_glyph->pixel_width, width);
7287 w->phys_cursor_width = width;
7289 /* If the character under cursor is R2L, draw the bar cursor
7290 on the right of its glyph, rather than on the left. */
7291 if ((cursor_glyph->resolved_level & 1) != 0)
7292 x += cursor_glyph->pixel_width - width;
7294 XFillRectangle (dpy, window, gc, x,
7295 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7296 width, row->height);
7298 else
7300 int dummy_x, dummy_y, dummy_h;
7302 if (width < 0)
7303 width = row->height;
7305 width = min (row->height, width);
7307 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7308 &dummy_y, &dummy_h);
7310 XFillRectangle (dpy, window, gc,
7311 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7312 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7313 row->height - width),
7314 w->phys_cursor_width, width);
7317 XSetClipMask (dpy, gc, None);
7322 /* RIF: Define cursor CURSOR on frame F. */
7324 static void
7325 x_define_frame_cursor (struct frame *f, Cursor cursor)
7327 if (!f->pointer_invisible
7328 && f->output_data.x->current_cursor != cursor)
7329 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7330 f->output_data.x->current_cursor = cursor;
7334 /* RIF: Clear area on frame F. */
7336 static void
7337 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7339 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7340 x, y, width, height, False);
7341 #ifdef USE_GTK
7342 /* Must queue a redraw, because scroll bars might have been cleared. */
7343 if (FRAME_GTK_WIDGET (f))
7344 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7345 #endif
7349 /* RIF: Draw cursor on window W. */
7351 static void
7352 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)
7354 struct frame *f = XFRAME (WINDOW_FRAME (w));
7356 if (on_p)
7358 w->phys_cursor_type = cursor_type;
7359 w->phys_cursor_on_p = 1;
7361 if (glyph_row->exact_window_width_line_p
7362 && (glyph_row->reversed_p
7363 ? (w->phys_cursor.hpos < 0)
7364 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7366 glyph_row->cursor_in_fringe_p = 1;
7367 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7369 else
7371 switch (cursor_type)
7373 case HOLLOW_BOX_CURSOR:
7374 x_draw_hollow_cursor (w, glyph_row);
7375 break;
7377 case FILLED_BOX_CURSOR:
7378 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7379 break;
7381 case BAR_CURSOR:
7382 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7383 break;
7385 case HBAR_CURSOR:
7386 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7387 break;
7389 case NO_CURSOR:
7390 w->phys_cursor_width = 0;
7391 break;
7393 default:
7394 abort ();
7398 #ifdef HAVE_X_I18N
7399 if (w == XWINDOW (f->selected_window))
7400 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7401 xic_set_preeditarea (w, x, y);
7402 #endif
7405 #ifndef XFlush
7406 XFlush (FRAME_X_DISPLAY (f));
7407 #endif
7411 /* Icons. */
7413 /* Make the x-window of frame F use the gnu icon bitmap. */
7416 x_bitmap_icon (struct frame *f, Lisp_Object file)
7418 int bitmap_id;
7420 if (FRAME_X_WINDOW (f) == 0)
7421 return 1;
7423 /* Free up our existing icon bitmap and mask if any. */
7424 if (f->output_data.x->icon_bitmap > 0)
7425 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7426 f->output_data.x->icon_bitmap = 0;
7428 if (STRINGP (file))
7430 #ifdef USE_GTK
7431 /* Use gtk_window_set_icon_from_file () if available,
7432 It's not restricted to bitmaps */
7433 if (xg_set_icon (f, file))
7434 return 0;
7435 #endif /* USE_GTK */
7436 bitmap_id = x_create_bitmap_from_file (f, file);
7437 x_create_bitmap_mask (f, bitmap_id);
7439 else
7441 /* Create the GNU bitmap and mask if necessary. */
7442 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7444 int rc = -1;
7446 #ifdef USE_GTK
7448 if (xg_set_icon (f, xg_default_icon_file)
7449 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7450 return 0;
7452 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7454 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7455 if (rc != -1)
7456 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7458 #endif
7460 /* If all else fails, use the (black and white) xbm image. */
7461 if (rc == -1)
7463 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7464 gnu_xbm_width, gnu_xbm_height);
7465 if (rc == -1)
7466 return 1;
7468 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7469 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7473 /* The first time we create the GNU bitmap and mask,
7474 this increments the ref-count one extra time.
7475 As a result, the GNU bitmap and mask are never freed.
7476 That way, we don't have to worry about allocating it again. */
7477 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7479 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7482 x_wm_set_icon_pixmap (f, bitmap_id);
7483 f->output_data.x->icon_bitmap = bitmap_id;
7485 return 0;
7489 /* Make the x-window of frame F use a rectangle with text.
7490 Use ICON_NAME as the text. */
7493 x_text_icon (struct frame *f, const char *icon_name)
7495 if (FRAME_X_WINDOW (f) == 0)
7496 return 1;
7499 XTextProperty text;
7500 text.value = (unsigned char *) icon_name;
7501 text.encoding = XA_STRING;
7502 text.format = 8;
7503 text.nitems = strlen (icon_name);
7504 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7507 if (f->output_data.x->icon_bitmap > 0)
7508 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7509 f->output_data.x->icon_bitmap = 0;
7510 x_wm_set_icon_pixmap (f, 0);
7512 return 0;
7515 #define X_ERROR_MESSAGE_SIZE 200
7517 /* If non-nil, this should be a string.
7518 It means catch X errors and store the error message in this string.
7520 The reason we use a stack is that x_catch_error/x_uncatch_error can
7521 be called from a signal handler.
7524 struct x_error_message_stack {
7525 char string[X_ERROR_MESSAGE_SIZE];
7526 Display *dpy;
7527 struct x_error_message_stack *prev;
7529 static struct x_error_message_stack *x_error_message;
7531 /* An X error handler which stores the error message in
7532 *x_error_message. This is called from x_error_handler if
7533 x_catch_errors is in effect. */
7535 static void
7536 x_error_catcher (Display *display, XErrorEvent *error)
7538 XGetErrorText (display, error->error_code,
7539 x_error_message->string,
7540 X_ERROR_MESSAGE_SIZE);
7543 /* Begin trapping X errors for display DPY. Actually we trap X errors
7544 for all displays, but DPY should be the display you are actually
7545 operating on.
7547 After calling this function, X protocol errors no longer cause
7548 Emacs to exit; instead, they are recorded in the string
7549 stored in *x_error_message.
7551 Calling x_check_errors signals an Emacs error if an X error has
7552 occurred since the last call to x_catch_errors or x_check_errors.
7554 Calling x_uncatch_errors resumes the normal error handling. */
7556 void x_check_errors (Display *dpy, const char *format);
7558 void
7559 x_catch_errors (Display *dpy)
7561 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7563 /* Make sure any errors from previous requests have been dealt with. */
7564 XSync (dpy, False);
7566 data->dpy = dpy;
7567 data->string[0] = 0;
7568 data->prev = x_error_message;
7569 x_error_message = data;
7572 /* Undo the last x_catch_errors call.
7573 DPY should be the display that was passed to x_catch_errors. */
7575 void
7576 x_uncatch_errors (void)
7578 struct x_error_message_stack *tmp;
7580 BLOCK_INPUT;
7582 /* The display may have been closed before this function is called.
7583 Check if it is still open before calling XSync. */
7584 if (x_display_info_for_display (x_error_message->dpy) != 0)
7585 XSync (x_error_message->dpy, False);
7587 tmp = x_error_message;
7588 x_error_message = x_error_message->prev;
7589 xfree (tmp);
7590 UNBLOCK_INPUT;
7593 /* If any X protocol errors have arrived since the last call to
7594 x_catch_errors or x_check_errors, signal an Emacs error using
7595 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7597 void
7598 x_check_errors (Display *dpy, const char *format)
7600 /* Make sure to catch any errors incurred so far. */
7601 XSync (dpy, False);
7603 if (x_error_message->string[0])
7605 char string[X_ERROR_MESSAGE_SIZE];
7606 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7607 x_uncatch_errors ();
7608 error (format, string);
7612 /* Nonzero if we had any X protocol errors
7613 since we did x_catch_errors on DPY. */
7616 x_had_errors_p (Display *dpy)
7618 /* Make sure to catch any errors incurred so far. */
7619 XSync (dpy, False);
7621 return x_error_message->string[0] != 0;
7624 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7626 void
7627 x_clear_errors (Display *dpy)
7629 x_error_message->string[0] = 0;
7632 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7633 * idea. --lorentey */
7634 /* Close off all unclosed x_catch_errors calls. */
7636 void
7637 x_fully_uncatch_errors (void)
7639 while (x_error_message)
7640 x_uncatch_errors ();
7642 #endif
7644 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7647 x_catching_errors (void)
7649 return x_error_message != 0;
7652 #if 0
7653 static unsigned int x_wire_count;
7654 x_trace_wire (void)
7656 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7658 #endif /* ! 0 */
7661 /* Handle SIGPIPE, which can happen when the connection to a server
7662 simply goes away. SIGPIPE is handled by x_connection_signal.
7663 Don't need to do anything, because the write which caused the
7664 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7665 which will do the appropriate cleanup for us. */
7667 static SIGTYPE
7668 x_connection_signal (int signalnum) /* If we don't have an argument, */
7669 /* some compilers complain in signal calls. */
7671 #ifdef USG
7672 /* USG systems forget handlers when they are used;
7673 must reestablish each time */
7674 signal (signalnum, x_connection_signal);
7675 #endif /* USG */
7679 /************************************************************************
7680 Handling X errors
7681 ************************************************************************/
7683 /* Error message passed to x_connection_closed. */
7685 static char *error_msg;
7687 /* Function installed as fatal_error_signal_hook in
7688 x_connection_closed. Print the X error message, and exit normally,
7689 instead of dumping core when XtCloseDisplay fails. */
7691 static void
7692 x_fatal_error_signal (void)
7694 fprintf (stderr, "%s\n", error_msg);
7695 exit (70);
7698 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7699 the text of an error message that lead to the connection loss. */
7701 static SIGTYPE
7702 x_connection_closed (Display *dpy, const char *error_message)
7704 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7705 Lisp_Object frame, tail;
7706 int index = SPECPDL_INDEX ();
7708 error_msg = (char *) alloca (strlen (error_message) + 1);
7709 strcpy (error_msg, error_message);
7710 handling_signal = 0;
7712 /* Prevent being called recursively because of an error condition
7713 below. Otherwise, we might end up with printing ``can't find per
7714 display information'' in the recursive call instead of printing
7715 the original message here. */
7716 x_catch_errors (dpy);
7718 /* Inhibit redisplay while frames are being deleted. */
7719 specbind (Qinhibit_redisplay, Qt);
7721 if (dpyinfo)
7723 /* Protect display from being closed when we delete the last
7724 frame on it. */
7725 dpyinfo->reference_count++;
7726 dpyinfo->terminal->reference_count++;
7729 /* First delete frames whose mini-buffers are on frames
7730 that are on the dead display. */
7731 FOR_EACH_FRAME (tail, frame)
7733 Lisp_Object minibuf_frame;
7734 minibuf_frame
7735 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7736 if (FRAME_X_P (XFRAME (frame))
7737 && FRAME_X_P (XFRAME (minibuf_frame))
7738 && ! EQ (frame, minibuf_frame)
7739 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7740 delete_frame (frame, Qnoelisp);
7743 /* Now delete all remaining frames on the dead display.
7744 We are now sure none of these is used as the mini-buffer
7745 for another frame that we need to delete. */
7746 FOR_EACH_FRAME (tail, frame)
7747 if (FRAME_X_P (XFRAME (frame))
7748 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7750 /* Set this to t so that delete_frame won't get confused
7751 trying to find a replacement. */
7752 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7753 delete_frame (frame, Qnoelisp);
7756 /* If DPYINFO is null, this means we didn't open the display in the
7757 first place, so don't try to close it. */
7758 if (dpyinfo)
7760 #ifdef USE_X_TOOLKIT
7761 /* We have to close the display to inform Xt that it doesn't
7762 exist anymore. If we don't, Xt will continue to wait for
7763 events from the display. As a consequence, a sequence of
7765 M-x make-frame-on-display RET :1 RET
7766 ...kill the new frame, so that we get an IO error...
7767 M-x make-frame-on-display RET :1 RET
7769 will indefinitely wait in Xt for events for display `:1',
7770 opened in the first call to make-frame-on-display.
7772 Closing the display is reported to lead to a bus error on
7773 OpenWindows in certain situations. I suspect that is a bug
7774 in OpenWindows. I don't know how to circumvent it here. */
7775 fatal_error_signal_hook = x_fatal_error_signal;
7776 XtCloseDisplay (dpy);
7777 fatal_error_signal_hook = NULL;
7778 #endif /* USE_X_TOOLKIT */
7780 #ifdef USE_GTK
7781 /* A long-standing GTK bug prevents proper disconnect handling
7782 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7783 the resulting Glib error message loop filled a user's disk.
7784 To avoid this, kill Emacs unconditionally on disconnect. */
7785 shut_down_emacs (0, 0, Qnil);
7786 fprintf (stderr, "%s\n\
7787 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7788 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7789 For details, see etc/PROBLEMS.\n",
7790 error_msg);
7791 abort ();
7792 #endif /* USE_GTK */
7794 /* Indicate that this display is dead. */
7795 dpyinfo->display = 0;
7797 dpyinfo->reference_count--;
7798 dpyinfo->terminal->reference_count--;
7799 if (dpyinfo->reference_count != 0)
7800 /* We have just closed all frames on this display. */
7801 abort ();
7804 Lisp_Object tmp;
7805 XSETTERMINAL (tmp, dpyinfo->terminal);
7806 Fdelete_terminal (tmp, Qnoelisp);
7810 x_uncatch_errors ();
7812 if (terminal_list == 0)
7814 fprintf (stderr, "%s\n", error_msg);
7815 Fkill_emacs (make_number (70));
7816 /* NOTREACHED */
7819 /* Ordinary stack unwind doesn't deal with these. */
7820 #ifdef SIGIO
7821 sigunblock (sigmask (SIGIO));
7822 #endif
7823 sigunblock (sigmask (SIGALRM));
7824 TOTALLY_UNBLOCK_INPUT;
7826 unbind_to (index, Qnil);
7827 clear_waiting_for_input ();
7828 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7829 longjmp), because returning from this function would get us back into
7830 Xlib's code which will directly call `exit'. */
7831 error ("%s", error_msg);
7834 /* We specifically use it before defining it, so that gcc doesn't inline it,
7835 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7836 static void x_error_quitter (Display *, XErrorEvent *);
7838 /* This is the first-level handler for X protocol errors.
7839 It calls x_error_quitter or x_error_catcher. */
7841 static int
7842 x_error_handler (Display *display, XErrorEvent *error)
7844 if (x_error_message)
7845 x_error_catcher (display, error);
7846 else
7847 x_error_quitter (display, error);
7848 return 0;
7851 /* This is the usual handler for X protocol errors.
7852 It kills all frames on the display that we got the error for.
7853 If that was the only one, it prints an error message and kills Emacs. */
7855 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7857 /* On older GCC versions, just putting x_error_quitter
7858 after x_error_handler prevents inlining into the former. */
7860 static void NO_INLINE
7861 x_error_quitter (Display *display, XErrorEvent *error)
7863 char buf[256], buf1[356];
7865 /* Ignore BadName errors. They can happen because of fonts
7866 or colors that are not defined. */
7868 if (error->error_code == BadName)
7869 return;
7871 /* Note that there is no real way portable across R3/R4 to get the
7872 original error handler. */
7874 XGetErrorText (display, error->error_code, buf, sizeof (buf));
7875 sprintf (buf1, "X protocol error: %s on protocol request %d",
7876 buf, error->request_code);
7877 x_connection_closed (display, buf1);
7881 /* This is the handler for X IO errors, always.
7882 It kills all frames on the display that we lost touch with.
7883 If that was the only one, it prints an error message and kills Emacs. */
7885 static int
7886 x_io_error_quitter (Display *display)
7888 char buf[256];
7890 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
7891 x_connection_closed (display, buf);
7892 return 0;
7895 /* Changing the font of the frame. */
7897 /* Give frame F the font FONT-OBJECT as its default font. The return
7898 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7899 frame. If it is negative, generate a new fontset from
7900 FONT-OBJECT. */
7902 Lisp_Object
7903 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7905 struct font *font = XFONT_OBJECT (font_object);
7907 if (fontset < 0)
7908 fontset = fontset_from_font (font_object);
7909 FRAME_FONTSET (f) = fontset;
7910 if (FRAME_FONT (f) == font)
7911 /* This font is already set in frame F. There's nothing more to
7912 do. */
7913 return font_object;
7915 FRAME_FONT (f) = font;
7916 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7917 FRAME_COLUMN_WIDTH (f) = font->average_width;
7918 FRAME_SPACE_WIDTH (f) = font->space_width;
7919 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7921 compute_fringe_widths (f, 1);
7923 /* Compute the scroll bar width in character columns. */
7924 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7926 int wid = FRAME_COLUMN_WIDTH (f);
7927 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7928 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7930 else
7932 int wid = FRAME_COLUMN_WIDTH (f);
7933 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7936 if (FRAME_X_WINDOW (f) != 0)
7938 /* Don't change the size of a tip frame; there's no point in
7939 doing it because it's done in Fx_show_tip, and it leads to
7940 problems because the tip frame has no widget. */
7941 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7942 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7945 #ifdef HAVE_X_I18N
7946 if (FRAME_XIC (f)
7947 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7949 BLOCK_INPUT;
7950 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
7951 UNBLOCK_INPUT;
7953 #endif
7955 return font_object;
7959 /***********************************************************************
7960 X Input Methods
7961 ***********************************************************************/
7963 #ifdef HAVE_X_I18N
7965 #ifdef HAVE_X11R6
7967 /* XIM destroy callback function, which is called whenever the
7968 connection to input method XIM dies. CLIENT_DATA contains a
7969 pointer to the x_display_info structure corresponding to XIM. */
7971 static void
7972 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7974 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7975 Lisp_Object frame, tail;
7977 BLOCK_INPUT;
7979 /* No need to call XDestroyIC.. */
7980 FOR_EACH_FRAME (tail, frame)
7982 struct frame *f = XFRAME (frame);
7983 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7985 FRAME_XIC (f) = NULL;
7986 xic_free_xfontset (f);
7990 /* No need to call XCloseIM. */
7991 dpyinfo->xim = NULL;
7992 XFree (dpyinfo->xim_styles);
7993 UNBLOCK_INPUT;
7996 #endif /* HAVE_X11R6 */
7998 #ifdef HAVE_X11R6
7999 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8000 extern char *XSetIMValues (XIM, ...);
8001 #endif
8003 /* Open the connection to the XIM server on display DPYINFO.
8004 RESOURCE_NAME is the resource name Emacs uses. */
8006 static void
8007 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
8009 XIM xim;
8011 #ifdef HAVE_XIM
8012 if (use_xim)
8014 if (dpyinfo->xim)
8015 XCloseIM (dpyinfo->xim);
8016 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8017 emacs_class);
8018 dpyinfo->xim = xim;
8020 if (xim)
8022 #ifdef HAVE_X11R6
8023 XIMCallback destroy;
8024 #endif
8026 /* Get supported styles and XIM values. */
8027 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8029 #ifdef HAVE_X11R6
8030 destroy.callback = xim_destroy_callback;
8031 destroy.client_data = (XPointer)dpyinfo;
8032 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8033 #endif
8037 else
8038 #endif /* HAVE_XIM */
8039 dpyinfo->xim = NULL;
8043 #ifdef HAVE_X11R6_XIM
8045 /* XIM instantiate callback function, which is called whenever an XIM
8046 server is available. DISPLAY is the display of the XIM.
8047 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8048 when the callback was registered. */
8050 static void
8051 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8053 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8054 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8056 /* We don't support multiple XIM connections. */
8057 if (dpyinfo->xim)
8058 return;
8060 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8062 /* Create XIC for the existing frames on the same display, as long
8063 as they have no XIC. */
8064 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8066 Lisp_Object tail, frame;
8068 BLOCK_INPUT;
8069 FOR_EACH_FRAME (tail, frame)
8071 struct frame *f = XFRAME (frame);
8073 if (FRAME_X_P (f)
8074 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8075 if (FRAME_XIC (f) == NULL)
8077 create_frame_xic (f);
8078 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8079 xic_set_statusarea (f);
8080 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8082 struct window *w = XWINDOW (f->selected_window);
8083 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8088 UNBLOCK_INPUT;
8092 #endif /* HAVE_X11R6_XIM */
8095 /* Open a connection to the XIM server on display DPYINFO.
8096 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8097 connection only at the first time. On X11R6, open the connection
8098 in the XIM instantiate callback function. */
8100 static void
8101 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8103 dpyinfo->xim = NULL;
8104 #ifdef HAVE_XIM
8105 if (use_xim)
8107 #ifdef HAVE_X11R6_XIM
8108 struct xim_inst_t *xim_inst;
8109 int len;
8111 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8112 dpyinfo->xim_callback_data = xim_inst;
8113 xim_inst->dpyinfo = dpyinfo;
8114 len = strlen (resource_name);
8115 xim_inst->resource_name = (char *) xmalloc (len + 1);
8116 memcpy (xim_inst->resource_name, resource_name, len + 1);
8117 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8118 resource_name, emacs_class,
8119 xim_instantiate_callback,
8120 /* This is XPointer in XFree86
8121 but (XPointer *) on Tru64, at
8122 least, hence the configure test. */
8123 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8124 #else /* not HAVE_X11R6_XIM */
8125 xim_open_dpy (dpyinfo, resource_name);
8126 #endif /* not HAVE_X11R6_XIM */
8128 #endif /* HAVE_XIM */
8132 /* Close the connection to the XIM server on display DPYINFO. */
8134 static void
8135 xim_close_dpy (struct x_display_info *dpyinfo)
8137 #ifdef HAVE_XIM
8138 if (use_xim)
8140 #ifdef HAVE_X11R6_XIM
8141 if (dpyinfo->display)
8142 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8143 NULL, emacs_class,
8144 xim_instantiate_callback, NULL);
8145 xfree (dpyinfo->xim_callback_data->resource_name);
8146 xfree (dpyinfo->xim_callback_data);
8147 #endif /* HAVE_X11R6_XIM */
8148 if (dpyinfo->display)
8149 XCloseIM (dpyinfo->xim);
8150 dpyinfo->xim = NULL;
8151 XFree (dpyinfo->xim_styles);
8153 #endif /* HAVE_XIM */
8156 #endif /* not HAVE_X11R6_XIM */
8160 /* Calculate the absolute position in frame F
8161 from its current recorded position values and gravity. */
8163 void
8164 x_calc_absolute_position (struct frame *f)
8166 int flags = f->size_hint_flags;
8168 /* We have nothing to do if the current position
8169 is already for the top-left corner. */
8170 if (! ((flags & XNegative) || (flags & YNegative)))
8171 return;
8173 /* Treat negative positions as relative to the leftmost bottommost
8174 position that fits on the screen. */
8175 if (flags & XNegative)
8176 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8177 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8180 int height = FRAME_PIXEL_HEIGHT (f);
8182 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8183 /* Something is fishy here. When using Motif, starting Emacs with
8184 `-g -0-0', the frame appears too low by a few pixels.
8186 This seems to be so because initially, while Emacs is starting,
8187 the column widget's height and the frame's pixel height are
8188 different. The column widget's height is the right one. In
8189 later invocations, when Emacs is up, the frame's pixel height
8190 is right, though.
8192 It's not obvious where the initial small difference comes from.
8193 2000-12-01, gerd. */
8195 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8196 #endif
8198 if (flags & YNegative)
8199 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8200 - height + f->top_pos;
8203 /* The left_pos and top_pos
8204 are now relative to the top and left screen edges,
8205 so the flags should correspond. */
8206 f->size_hint_flags &= ~ (XNegative | YNegative);
8209 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8210 to really change the position, and 0 when calling from
8211 x_make_frame_visible (in that case, XOFF and YOFF are the current
8212 position values). It is -1 when calling from x_set_frame_parameters,
8213 which means, do adjust for borders but don't change the gravity. */
8215 void
8216 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8218 int modified_top, modified_left;
8220 if (change_gravity > 0)
8222 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8223 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8225 f->top_pos = yoff;
8226 f->left_pos = xoff;
8227 f->size_hint_flags &= ~ (XNegative | YNegative);
8228 if (xoff < 0)
8229 f->size_hint_flags |= XNegative;
8230 if (yoff < 0)
8231 f->size_hint_flags |= YNegative;
8232 f->win_gravity = NorthWestGravity;
8234 x_calc_absolute_position (f);
8236 BLOCK_INPUT;
8237 x_wm_set_size_hint (f, (long) 0, 0);
8239 modified_left = f->left_pos;
8240 modified_top = f->top_pos;
8242 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8244 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8245 than the WM decorations. So we use the calculated offset instead
8246 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8247 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8248 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8251 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8252 modified_left, modified_top);
8254 x_sync_with_move (f, f->left_pos, f->top_pos,
8255 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8256 ? 1 : 0);
8258 /* change_gravity is non-zero when this function is called from Lisp to
8259 programmatically move a frame. In that case, we call
8260 x_check_expected_move to discover if we have a "Type A" or "Type B"
8261 window manager, and, for a "Type A" window manager, adjust the position
8262 of the frame.
8264 We call x_check_expected_move if a programmatic move occurred, and
8265 either the window manager type (A/B) is unknown or it is Type A but we
8266 need to compute the top/left offset adjustment for this frame. */
8268 if (change_gravity != 0 &&
8269 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8270 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8271 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8272 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8273 x_check_expected_move (f, modified_left, modified_top);
8275 UNBLOCK_INPUT;
8278 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8279 on the root window for frame F contains ATOMNAME.
8280 This is how a WM check shall be done according to the Window Manager
8281 Specification/Extended Window Manager Hints at
8282 http://freedesktop.org/wiki/Specifications/wm-spec. */
8284 static int
8285 wm_supports (struct frame *f, Atom want_atom)
8287 Atom actual_type;
8288 unsigned long actual_size, bytes_remaining;
8289 int i, rc, actual_format;
8290 Window wmcheck_window;
8291 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8292 Window target_window = dpyinfo->root_window;
8293 long max_len = 65536;
8294 Display *dpy = FRAME_X_DISPLAY (f);
8295 unsigned char *tmp_data = NULL;
8296 Atom target_type = XA_WINDOW;
8298 BLOCK_INPUT;
8300 x_catch_errors (dpy);
8301 rc = XGetWindowProperty (dpy, target_window,
8302 dpyinfo->Xatom_net_supporting_wm_check,
8303 0, max_len, False, target_type,
8304 &actual_type, &actual_format, &actual_size,
8305 &bytes_remaining, &tmp_data);
8307 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8309 if (tmp_data) XFree (tmp_data);
8310 x_uncatch_errors ();
8311 UNBLOCK_INPUT;
8312 return 0;
8315 wmcheck_window = *(Window *) tmp_data;
8316 XFree (tmp_data);
8318 /* Check if window exists. */
8319 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8320 x_sync (f);
8321 if (x_had_errors_p (dpy))
8323 x_uncatch_errors ();
8324 UNBLOCK_INPUT;
8325 return 0;
8328 if (dpyinfo->net_supported_window != wmcheck_window)
8330 /* Window changed, reload atoms */
8331 if (dpyinfo->net_supported_atoms != NULL)
8332 XFree (dpyinfo->net_supported_atoms);
8333 dpyinfo->net_supported_atoms = NULL;
8334 dpyinfo->nr_net_supported_atoms = 0;
8335 dpyinfo->net_supported_window = 0;
8337 target_type = XA_ATOM;
8338 tmp_data = NULL;
8339 rc = XGetWindowProperty (dpy, target_window,
8340 dpyinfo->Xatom_net_supported,
8341 0, max_len, False, target_type,
8342 &actual_type, &actual_format, &actual_size,
8343 &bytes_remaining, &tmp_data);
8345 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8347 if (tmp_data) XFree (tmp_data);
8348 x_uncatch_errors ();
8349 UNBLOCK_INPUT;
8350 return 0;
8353 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8354 dpyinfo->nr_net_supported_atoms = actual_size;
8355 dpyinfo->net_supported_window = wmcheck_window;
8358 rc = 0;
8360 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8361 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8363 x_uncatch_errors ();
8364 UNBLOCK_INPUT;
8366 return rc;
8369 static void
8370 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8372 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8374 x_send_client_event (frame, make_number (0), frame,
8375 dpyinfo->Xatom_net_wm_state,
8376 make_number (32),
8377 /* 1 = add, 0 = remove */
8378 Fcons
8379 (make_number (add ? 1 : 0),
8380 Fcons
8381 (make_fixnum_or_float (atom),
8382 value != 0
8383 ? Fcons (make_fixnum_or_float (value), Qnil)
8384 : Qnil)));
8387 void
8388 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8390 Lisp_Object frame;
8391 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8393 XSETFRAME (frame, f);
8395 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8396 dpyinfo->Xatom_net_wm_state_sticky, None);
8399 /* Return the current _NET_WM_STATE.
8400 SIZE_STATE is set to one of the FULLSCREEN_* values.
8401 STICKY is set to 1 if the sticky state is set, 0 if not. */
8403 static void
8404 get_current_wm_state (struct frame *f,
8405 Window window,
8406 int *size_state,
8407 int *sticky)
8409 Atom actual_type;
8410 unsigned long actual_size, bytes_remaining;
8411 int i, rc, actual_format;
8412 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8413 long max_len = 65536;
8414 Display *dpy = FRAME_X_DISPLAY (f);
8415 unsigned char *tmp_data = NULL;
8416 Atom target_type = XA_ATOM;
8418 *sticky = 0;
8419 *size_state = FULLSCREEN_NONE;
8421 BLOCK_INPUT;
8422 x_catch_errors (dpy);
8423 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8424 0, max_len, False, target_type,
8425 &actual_type, &actual_format, &actual_size,
8426 &bytes_remaining, &tmp_data);
8428 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8430 if (tmp_data) XFree (tmp_data);
8431 x_uncatch_errors ();
8432 UNBLOCK_INPUT;
8433 return;
8436 x_uncatch_errors ();
8438 for (i = 0; i < actual_size; ++i)
8440 Atom a = ((Atom*)tmp_data)[i];
8441 if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8443 if (*size_state == FULLSCREEN_HEIGHT)
8444 *size_state = FULLSCREEN_MAXIMIZED;
8445 else
8446 *size_state = FULLSCREEN_WIDTH;
8448 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8450 if (*size_state == FULLSCREEN_WIDTH)
8451 *size_state = FULLSCREEN_MAXIMIZED;
8452 else
8453 *size_state = FULLSCREEN_HEIGHT;
8455 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8456 *size_state = FULLSCREEN_BOTH;
8457 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8458 *sticky = 1;
8461 if (tmp_data) XFree (tmp_data);
8462 UNBLOCK_INPUT;
8465 /* Do fullscreen as specified in extended window manager hints */
8467 static int
8468 do_ewmh_fullscreen (struct frame *f)
8470 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8471 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8472 Lisp_Object lval = get_frame_param (f, Qfullscreen);
8473 int cur, dummy;
8475 get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8477 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8478 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8479 if (!have_net_atom)
8480 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8482 if (have_net_atom && cur != f->want_fullscreen)
8484 Lisp_Object frame;
8486 XSETFRAME (frame, f);
8488 /* Keep number of calls to set_wm_state as low as possible.
8489 Some window managers, or possible Gtk+, hangs when too many
8490 are sent at once. */
8491 switch (f->want_fullscreen)
8493 case FULLSCREEN_BOTH:
8494 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8495 || cur == FULLSCREEN_HEIGHT)
8496 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8497 dpyinfo->Xatom_net_wm_state_maximized_vert);
8498 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8499 break;
8500 case FULLSCREEN_WIDTH:
8501 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8502 || cur == FULLSCREEN_MAXIMIZED)
8503 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8504 dpyinfo->Xatom_net_wm_state_maximized_vert);
8505 if (cur != FULLSCREEN_MAXIMIZED)
8506 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8507 break;
8508 case FULLSCREEN_HEIGHT:
8509 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8510 || cur == FULLSCREEN_MAXIMIZED)
8511 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8512 dpyinfo->Xatom_net_wm_state_maximized_horz);
8513 if (cur != FULLSCREEN_MAXIMIZED)
8514 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8515 break;
8516 case FULLSCREEN_MAXIMIZED:
8517 if (cur == FULLSCREEN_BOTH)
8518 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8519 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8520 dpyinfo->Xatom_net_wm_state_maximized_vert);
8521 break;
8522 case FULLSCREEN_NONE:
8523 if (cur == FULLSCREEN_BOTH)
8524 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8525 else
8526 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8527 dpyinfo->Xatom_net_wm_state_maximized_vert);
8530 f->want_fullscreen = FULLSCREEN_NONE;
8534 return have_net_atom;
8537 static void
8538 XTfullscreen_hook (FRAME_PTR f)
8540 if (f->async_visible)
8542 BLOCK_INPUT;
8543 x_check_fullscreen (f);
8544 x_sync (f);
8545 UNBLOCK_INPUT;
8550 static void
8551 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8553 int value = FULLSCREEN_NONE;
8554 Lisp_Object lval;
8555 int sticky = 0;
8557 get_current_wm_state (f, event->window, &value, &sticky);
8558 lval = Qnil;
8559 switch (value)
8561 case FULLSCREEN_WIDTH:
8562 lval = Qfullwidth;
8563 break;
8564 case FULLSCREEN_HEIGHT:
8565 lval = Qfullheight;
8566 break;
8567 case FULLSCREEN_BOTH:
8568 lval = Qfullboth;
8569 break;
8570 case FULLSCREEN_MAXIMIZED:
8571 lval = Qmaximized;
8572 break;
8575 store_frame_param (f, Qfullscreen, lval);
8576 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8579 /* Check if we need to resize the frame due to a fullscreen request.
8580 If so needed, resize the frame. */
8581 static void
8582 x_check_fullscreen (struct frame *f)
8584 if (do_ewmh_fullscreen (f))
8585 return;
8587 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8588 return; /* Only fullscreen without WM or with EWM hints (above). */
8590 if (f->want_fullscreen != FULLSCREEN_NONE)
8592 int width = FRAME_COLS (f), height = FRAME_LINES (f);
8593 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8595 switch (f->want_fullscreen)
8597 /* No difference between these two when there is no WM */
8598 case FULLSCREEN_BOTH:
8599 case FULLSCREEN_MAXIMIZED:
8600 width = x_display_pixel_width (dpyinfo);
8601 height = x_display_pixel_height (dpyinfo);
8602 break;
8603 case FULLSCREEN_WIDTH:
8604 width = x_display_pixel_width (dpyinfo);
8605 break;
8606 case FULLSCREEN_HEIGHT:
8607 height = x_display_pixel_height (dpyinfo);
8610 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8612 change_frame_size (f, height, width, 0, 1, 0);
8613 SET_FRAME_GARBAGED (f);
8614 cancel_mouse_face (f);
8619 /* This function is called by x_set_offset to determine whether the window
8620 manager interfered with the positioning of the frame. Type A window
8621 managers position the surrounding window manager decorations a small
8622 amount above and left of the user-supplied position. Type B window
8623 managers position the surrounding window manager decorations at the
8624 user-specified position. If we detect a Type A window manager, we
8625 compensate by moving the window right and down by the proper amount. */
8627 static void
8628 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8630 int current_left = 0, current_top = 0;
8632 /* x_real_positions returns the left and top offsets of the outermost
8633 window manager window around the frame. */
8635 x_real_positions (f, &current_left, &current_top);
8637 if (current_left != expected_left || current_top != expected_top)
8639 /* It's a "Type A" window manager. */
8641 int adjusted_left;
8642 int adjusted_top;
8644 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8645 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8646 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8648 /* Now fix the mispositioned frame's location. */
8650 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8651 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8653 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8654 adjusted_left, adjusted_top);
8656 x_sync_with_move (f, expected_left, expected_top, 0);
8658 else
8659 /* It's a "Type B" window manager. We don't have to adjust the
8660 frame's position. */
8662 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8666 /* Wait for XGetGeometry to return up-to-date position information for a
8667 recently-moved frame. Call this immediately after calling XMoveWindow.
8668 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8669 frame has been moved to, so we use a fuzzy position comparison instead
8670 of an exact comparison. */
8672 static void
8673 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8675 int count = 0;
8677 while (count++ < 50)
8679 int current_left = 0, current_top = 0;
8681 /* In theory, this call to XSync only needs to happen once, but in
8682 practice, it doesn't seem to work, hence the need for the surrounding
8683 loop. */
8685 XSync (FRAME_X_DISPLAY (f), False);
8686 x_real_positions (f, &current_left, &current_top);
8688 if (fuzzy)
8690 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8691 pixels. */
8693 if (eabs (current_left - left) <= 10
8694 && eabs (current_top - top) <= 40)
8695 return;
8697 else if (current_left == left && current_top == top)
8698 return;
8701 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8702 will then return up-to-date position info. */
8704 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8708 /* Wait for an event on frame F matching EVENTTYPE. */
8709 void
8710 x_wait_for_event (struct frame *f, int eventtype)
8712 int level = interrupt_input_blocked;
8714 SELECT_TYPE fds;
8715 EMACS_TIME tmo, tmo_at, time_now;
8716 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8718 pending_event_wait.f = f;
8719 pending_event_wait.eventtype = eventtype;
8721 /* Set timeout to 0.1 second. Hopefully not noticable.
8722 Maybe it should be configurable. */
8723 EMACS_SET_SECS_USECS (tmo, 0, 100000);
8724 EMACS_GET_TIME (tmo_at);
8725 EMACS_ADD_TIME (tmo_at, tmo_at, tmo);
8727 while (pending_event_wait.eventtype)
8729 interrupt_input_pending = 1;
8730 TOTALLY_UNBLOCK_INPUT;
8731 /* XTread_socket is called after unblock. */
8732 BLOCK_INPUT;
8733 interrupt_input_blocked = level;
8735 FD_ZERO (&fds);
8736 FD_SET (fd, &fds);
8738 EMACS_GET_TIME (time_now);
8739 EMACS_SUB_TIME (tmo, tmo_at, time_now);
8741 if (EMACS_TIME_NEG_P (tmo) || select (fd+1, &fds, NULL, NULL, &tmo) == 0)
8742 break; /* Timeout */
8744 pending_event_wait.f = 0;
8745 pending_event_wait.eventtype = 0;
8749 /* Change the size of frame F's X window to COLS/ROWS in the case F
8750 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8751 top-left-corner window gravity for this size change and subsequent
8752 size changes. Otherwise we leave the window gravity unchanged. */
8754 static void
8755 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8757 int pixelwidth, pixelheight;
8759 check_frame_size (f, &rows, &cols);
8760 f->scroll_bar_actual_width
8761 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8763 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8765 compute_fringe_widths (f, 0);
8767 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8768 + FRAME_TOOLBAR_WIDTH (f);
8769 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8770 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8772 if (change_gravity) f->win_gravity = NorthWestGravity;
8773 x_wm_set_size_hint (f, (long) 0, 0);
8774 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8775 pixelwidth, pixelheight);
8778 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8779 receive in the ConfigureNotify event; if we get what we asked
8780 for, then the event won't cause the screen to become garbaged, so
8781 we have to make sure to do it here. */
8782 SET_FRAME_GARBAGED (f);
8784 /* Now, strictly speaking, we can't be sure that this is accurate,
8785 but the window manager will get around to dealing with the size
8786 change request eventually, and we'll hear how it went when the
8787 ConfigureNotify event gets here.
8789 We could just not bother storing any of this information here,
8790 and let the ConfigureNotify event set everything up, but that
8791 might be kind of confusing to the Lisp code, since size changes
8792 wouldn't be reported in the frame parameters until some random
8793 point in the future when the ConfigureNotify event arrives.
8795 We pass 1 for DELAY since we can't run Lisp code inside of
8796 a BLOCK_INPUT. */
8798 /* But the ConfigureNotify may in fact never arrive, and then this is
8799 not right if the frame is visible. Instead wait (with timeout)
8800 for the ConfigureNotify. */
8801 if (f->async_visible)
8802 x_wait_for_event (f, ConfigureNotify);
8803 else
8805 change_frame_size (f, rows, cols, 0, 1, 0);
8806 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8807 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8808 x_sync (f);
8813 /* Call this to change the size of frame F's x-window.
8814 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8815 for this size change and subsequent size changes.
8816 Otherwise we leave the window gravity unchanged. */
8818 void
8819 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8821 BLOCK_INPUT;
8823 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8825 int r, c;
8827 /* When the frame is maximized/fullscreen or running under for
8828 example Xmonad, x_set_window_size_1 will be a no-op.
8829 In that case, the right thing to do is extend rows/cols to
8830 the current frame size. We do that first if x_set_window_size_1
8831 turns out to not be a no-op (there is no way to know).
8832 The size will be adjusted again if the frame gets a
8833 ConfigureNotify event as a result of x_set_window_size. */
8834 int pixelh = FRAME_PIXEL_HEIGHT (f);
8835 #ifdef USE_X_TOOLKIT
8836 /* The menu bar is not part of text lines. The tool bar
8837 is however. */
8838 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8839 #endif
8840 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8841 /* Update f->scroll_bar_actual_width because it is used in
8842 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8843 f->scroll_bar_actual_width
8844 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8845 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8846 change_frame_size (f, r, c, 0, 1, 0);
8849 #ifdef USE_GTK
8850 if (FRAME_GTK_WIDGET (f))
8851 xg_frame_set_char_size (f, cols, rows);
8852 else
8853 x_set_window_size_1 (f, change_gravity, cols, rows);
8854 #else /* not USE_GTK */
8856 x_set_window_size_1 (f, change_gravity, cols, rows);
8858 #endif /* not USE_GTK */
8860 /* If cursor was outside the new size, mark it as off. */
8861 mark_window_cursors_off (XWINDOW (f->root_window));
8863 /* Clear out any recollection of where the mouse highlighting was,
8864 since it might be in a place that's outside the new frame size.
8865 Actually checking whether it is outside is a pain in the neck,
8866 so don't try--just let the highlighting be done afresh with new size. */
8867 cancel_mouse_face (f);
8869 UNBLOCK_INPUT;
8872 /* Mouse warping. */
8874 void
8875 x_set_mouse_position (struct frame *f, int x, int y)
8877 int pix_x, pix_y;
8879 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8880 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8882 if (pix_x < 0) pix_x = 0;
8883 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8885 if (pix_y < 0) pix_y = 0;
8886 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8888 BLOCK_INPUT;
8890 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8891 0, 0, 0, 0, pix_x, pix_y);
8892 UNBLOCK_INPUT;
8895 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8897 void
8898 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8900 BLOCK_INPUT;
8902 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8903 0, 0, 0, 0, pix_x, pix_y);
8904 UNBLOCK_INPUT;
8907 /* focus shifting, raising and lowering. */
8909 void
8910 x_focus_on_frame (struct frame *f)
8912 #if 0
8913 /* I don't think that the ICCCM allows programs to do things like this
8914 without the interaction of the window manager. Whatever you end up
8915 doing with this code, do it to x_unfocus_frame too. */
8916 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8917 RevertToPointerRoot, CurrentTime);
8918 #endif /* ! 0 */
8921 void
8922 x_unfocus_frame (struct frame *f)
8924 #if 0
8925 /* Look at the remarks in x_focus_on_frame. */
8926 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8927 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8928 RevertToPointerRoot, CurrentTime);
8929 #endif /* ! 0 */
8932 /* Raise frame F. */
8934 void
8935 x_raise_frame (struct frame *f)
8937 BLOCK_INPUT;
8938 if (f->async_visible)
8939 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8941 XFlush (FRAME_X_DISPLAY (f));
8942 UNBLOCK_INPUT;
8945 /* Lower frame F. */
8947 void
8948 x_lower_frame (struct frame *f)
8950 if (f->async_visible)
8952 BLOCK_INPUT;
8953 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8954 XFlush (FRAME_X_DISPLAY (f));
8955 UNBLOCK_INPUT;
8959 /* Activate frame with Extended Window Manager Hints */
8961 void
8962 x_ewmh_activate_frame (FRAME_PTR f)
8964 /* See Window Manager Specification/Extended Window Manager Hints at
8965 http://freedesktop.org/wiki/Specifications/wm-spec */
8967 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8968 if (f->async_visible && wm_supports (f, dpyinfo->Xatom_net_active_window))
8970 Lisp_Object frame;
8971 XSETFRAME (frame, f);
8972 x_send_client_event (frame, make_number (0), frame,
8973 dpyinfo->Xatom_net_active_window,
8974 make_number (32),
8975 Fcons (make_number (1),
8976 Fcons (make_number (last_user_time),
8977 Qnil)));
8981 static void
8982 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
8984 if (raise_flag)
8985 x_raise_frame (f);
8986 else
8987 x_lower_frame (f);
8990 /* XEmbed implementation. */
8992 void
8993 xembed_set_info (struct frame *f, enum xembed_info flags)
8995 Atom atom;
8996 unsigned long data[2];
8997 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8999 data[0] = XEMBED_VERSION;
9000 data[1] = flags;
9002 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9003 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
9004 32, PropModeReplace, (unsigned char *) data, 2);
9007 void
9008 xembed_send_message (struct frame *f, Time time, enum xembed_message message, long int detail, long int data1, long int data2)
9010 XEvent event;
9012 event.xclient.type = ClientMessage;
9013 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9014 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9015 event.xclient.format = 32;
9016 event.xclient.data.l[0] = time;
9017 event.xclient.data.l[1] = message;
9018 event.xclient.data.l[2] = detail;
9019 event.xclient.data.l[3] = data1;
9020 event.xclient.data.l[4] = data2;
9022 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9023 False, NoEventMask, &event);
9024 XSync (FRAME_X_DISPLAY (f), False);
9027 /* Change of visibility. */
9029 /* This tries to wait until the frame is really visible.
9030 However, if the window manager asks the user where to position
9031 the frame, this will return before the user finishes doing that.
9032 The frame will not actually be visible at that time,
9033 but it will become visible later when the window manager
9034 finishes with it. */
9036 void
9037 x_make_frame_visible (struct frame *f)
9039 Lisp_Object type;
9040 int original_top, original_left;
9041 int retry_count = 2;
9043 retry:
9045 BLOCK_INPUT;
9047 type = x_icon_type (f);
9048 if (!NILP (type))
9049 x_bitmap_icon (f, type);
9051 if (! FRAME_VISIBLE_P (f))
9053 /* We test FRAME_GARBAGED_P here to make sure we don't
9054 call x_set_offset a second time
9055 if we get to x_make_frame_visible a second time
9056 before the window gets really visible. */
9057 if (! FRAME_ICONIFIED_P (f)
9058 && ! FRAME_X_EMBEDDED_P (f)
9059 && ! f->output_data.x->asked_for_visible)
9060 x_set_offset (f, f->left_pos, f->top_pos, 0);
9062 f->output_data.x->asked_for_visible = 1;
9064 if (! EQ (Vx_no_window_manager, Qt))
9065 x_wm_set_window_state (f, NormalState);
9066 #ifdef USE_X_TOOLKIT
9067 if (FRAME_X_EMBEDDED_P (f))
9068 xembed_set_info (f, XEMBED_MAPPED);
9069 else
9071 /* This was XtPopup, but that did nothing for an iconified frame. */
9072 XtMapWidget (f->output_data.x->widget);
9074 #else /* not USE_X_TOOLKIT */
9075 #ifdef USE_GTK
9076 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9077 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9078 #else
9079 if (FRAME_X_EMBEDDED_P (f))
9080 xembed_set_info (f, XEMBED_MAPPED);
9081 else
9082 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9083 #endif /* not USE_GTK */
9084 #endif /* not USE_X_TOOLKIT */
9087 XFlush (FRAME_X_DISPLAY (f));
9089 /* Synchronize to ensure Emacs knows the frame is visible
9090 before we do anything else. We do this loop with input not blocked
9091 so that incoming events are handled. */
9093 Lisp_Object frame;
9094 int count;
9095 /* This must be before UNBLOCK_INPUT
9096 since events that arrive in response to the actions above
9097 will set it when they are handled. */
9098 int previously_visible = f->output_data.x->has_been_visible;
9100 original_left = f->left_pos;
9101 original_top = f->top_pos;
9103 /* This must come after we set COUNT. */
9104 UNBLOCK_INPUT;
9106 /* We unblock here so that arriving X events are processed. */
9108 /* Now move the window back to where it was "supposed to be".
9109 But don't do it if the gravity is negative.
9110 When the gravity is negative, this uses a position
9111 that is 3 pixels too low. Perhaps that's really the border width.
9113 Don't do this if the window has never been visible before,
9114 because the window manager may choose the position
9115 and we don't want to override it. */
9117 if (! FRAME_VISIBLE_P (f)
9118 && ! FRAME_ICONIFIED_P (f)
9119 && ! FRAME_X_EMBEDDED_P (f)
9120 && f->win_gravity == NorthWestGravity
9121 && previously_visible)
9123 Drawable rootw;
9124 int x, y;
9125 unsigned int width, height, border, depth;
9127 BLOCK_INPUT;
9129 /* On some window managers (such as FVWM) moving an existing
9130 window, even to the same place, causes the window manager
9131 to introduce an offset. This can cause the window to move
9132 to an unexpected location. Check the geometry (a little
9133 slow here) and then verify that the window is in the right
9134 place. If the window is not in the right place, move it
9135 there, and take the potential window manager hit. */
9136 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9137 &rootw, &x, &y, &width, &height, &border, &depth);
9139 if (original_left != x || original_top != y)
9140 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9141 original_left, original_top);
9143 UNBLOCK_INPUT;
9146 XSETFRAME (frame, f);
9148 /* Wait until the frame is visible. Process X events until a
9149 MapNotify event has been seen, or until we think we won't get a
9150 MapNotify at all.. */
9151 for (count = input_signal_count + 10;
9152 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9154 /* Force processing of queued events. */
9155 x_sync (f);
9157 /* Machines that do polling rather than SIGIO have been
9158 observed to go into a busy-wait here. So we'll fake an
9159 alarm signal to let the handler know that there's something
9160 to be read. We used to raise a real alarm, but it seems
9161 that the handler isn't always enabled here. This is
9162 probably a bug. */
9163 if (input_polling_used ())
9165 /* It could be confusing if a real alarm arrives while
9166 processing the fake one. Turn it off and let the
9167 handler reset it. */
9168 int old_poll_suppress_count = poll_suppress_count;
9169 poll_suppress_count = 1;
9170 poll_for_input_1 ();
9171 poll_suppress_count = old_poll_suppress_count;
9174 /* See if a MapNotify event has been processed. */
9175 FRAME_SAMPLE_VISIBILITY (f);
9178 /* 2000-09-28: In
9180 (let ((f (selected-frame)))
9181 (iconify-frame f)
9182 (raise-frame f))
9184 the frame is not raised with various window managers on
9185 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9186 unknown reason, the call to XtMapWidget is completely ignored.
9187 Mapping the widget a second time works. */
9189 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9190 goto retry;
9194 /* Change from mapped state to withdrawn state. */
9196 /* Make the frame visible (mapped and not iconified). */
9198 void
9199 x_make_frame_invisible (struct frame *f)
9201 Window window;
9203 /* Use the frame's outermost window, not the one we normally draw on. */
9204 window = FRAME_OUTER_WINDOW (f);
9206 /* Don't keep the highlight on an invisible frame. */
9207 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9208 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9210 BLOCK_INPUT;
9212 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9213 that the current position of the window is user-specified, rather than
9214 program-specified, so that when the window is mapped again, it will be
9215 placed at the same location, without forcing the user to position it
9216 by hand again (they have already done that once for this window.) */
9217 x_wm_set_size_hint (f, (long) 0, 1);
9219 #ifdef USE_GTK
9220 if (FRAME_GTK_OUTER_WIDGET (f))
9221 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9222 else
9223 #else
9224 if (FRAME_X_EMBEDDED_P (f))
9225 xembed_set_info (f, 0);
9226 else
9227 #endif
9230 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9231 DefaultScreen (FRAME_X_DISPLAY (f))))
9233 UNBLOCK_INPUT_RESIGNAL;
9234 error ("Can't notify window manager of window withdrawal");
9238 /* We can't distinguish this from iconification
9239 just by the event that we get from the server.
9240 So we can't win using the usual strategy of letting
9241 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9242 and synchronize with the server to make sure we agree. */
9243 f->visible = 0;
9244 FRAME_ICONIFIED_P (f) = 0;
9245 f->async_visible = 0;
9246 f->async_iconified = 0;
9248 x_sync (f);
9250 UNBLOCK_INPUT;
9253 /* Change window state from mapped to iconified. */
9255 void
9256 x_iconify_frame (struct frame *f)
9258 int result;
9259 Lisp_Object type;
9261 /* Don't keep the highlight on an invisible frame. */
9262 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9263 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9265 if (f->async_iconified)
9266 return;
9268 BLOCK_INPUT;
9270 FRAME_SAMPLE_VISIBILITY (f);
9272 type = x_icon_type (f);
9273 if (!NILP (type))
9274 x_bitmap_icon (f, type);
9276 #ifdef USE_GTK
9277 if (FRAME_GTK_OUTER_WIDGET (f))
9279 if (! FRAME_VISIBLE_P (f))
9280 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9282 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9283 f->iconified = 1;
9284 f->visible = 1;
9285 f->async_iconified = 1;
9286 f->async_visible = 0;
9287 UNBLOCK_INPUT;
9288 return;
9290 #endif
9292 #ifdef USE_X_TOOLKIT
9294 if (! FRAME_VISIBLE_P (f))
9296 if (! EQ (Vx_no_window_manager, Qt))
9297 x_wm_set_window_state (f, IconicState);
9298 /* This was XtPopup, but that did nothing for an iconified frame. */
9299 XtMapWidget (f->output_data.x->widget);
9300 /* The server won't give us any event to indicate
9301 that an invisible frame was changed to an icon,
9302 so we have to record it here. */
9303 f->iconified = 1;
9304 f->visible = 1;
9305 f->async_iconified = 1;
9306 f->async_visible = 0;
9307 UNBLOCK_INPUT;
9308 return;
9311 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9312 XtWindow (f->output_data.x->widget),
9313 DefaultScreen (FRAME_X_DISPLAY (f)));
9314 UNBLOCK_INPUT;
9316 if (!result)
9317 error ("Can't notify window manager of iconification");
9319 f->async_iconified = 1;
9320 f->async_visible = 0;
9323 BLOCK_INPUT;
9324 XFlush (FRAME_X_DISPLAY (f));
9325 UNBLOCK_INPUT;
9326 #else /* not USE_X_TOOLKIT */
9328 /* Make sure the X server knows where the window should be positioned,
9329 in case the user deiconifies with the window manager. */
9330 if (! FRAME_VISIBLE_P (f)
9331 && ! FRAME_ICONIFIED_P (f)
9332 && ! FRAME_X_EMBEDDED_P (f))
9333 x_set_offset (f, f->left_pos, f->top_pos, 0);
9335 /* Since we don't know which revision of X we're running, we'll use both
9336 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9338 /* X11R4: send a ClientMessage to the window manager using the
9339 WM_CHANGE_STATE type. */
9341 XEvent message;
9343 message.xclient.window = FRAME_X_WINDOW (f);
9344 message.xclient.type = ClientMessage;
9345 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9346 message.xclient.format = 32;
9347 message.xclient.data.l[0] = IconicState;
9349 if (! XSendEvent (FRAME_X_DISPLAY (f),
9350 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9351 False,
9352 SubstructureRedirectMask | SubstructureNotifyMask,
9353 &message))
9355 UNBLOCK_INPUT_RESIGNAL;
9356 error ("Can't notify window manager of iconification");
9360 /* X11R3: set the initial_state field of the window manager hints to
9361 IconicState. */
9362 x_wm_set_window_state (f, IconicState);
9364 if (!FRAME_VISIBLE_P (f))
9366 /* If the frame was withdrawn, before, we must map it. */
9367 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9370 f->async_iconified = 1;
9371 f->async_visible = 0;
9373 XFlush (FRAME_X_DISPLAY (f));
9374 UNBLOCK_INPUT;
9375 #endif /* not USE_X_TOOLKIT */
9379 /* Free X resources of frame F. */
9381 void
9382 x_free_frame_resources (struct frame *f)
9384 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9385 Lisp_Object bar;
9386 struct scroll_bar *b;
9387 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9389 BLOCK_INPUT;
9391 /* If a display connection is dead, don't try sending more
9392 commands to the X server. */
9393 if (dpyinfo->display)
9395 /* We must free faces before destroying windows because some
9396 font-driver (e.g. xft) access a window while finishing a
9397 face. */
9398 if (FRAME_FACE_CACHE (f))
9399 free_frame_faces (f);
9401 if (f->output_data.x->icon_desc)
9402 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9404 #ifdef USE_X_TOOLKIT
9405 /* Explicitly destroy the scroll bars of the frame. Without
9406 this, we get "BadDrawable" errors from the toolkit later on,
9407 presumably from expose events generated for the disappearing
9408 toolkit scroll bars. */
9409 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9411 b = XSCROLL_BAR (bar);
9412 x_scroll_bar_remove (b);
9414 #endif
9416 #ifdef HAVE_X_I18N
9417 if (FRAME_XIC (f))
9418 free_frame_xic (f);
9419 #endif
9421 #ifdef USE_X_TOOLKIT
9422 if (f->output_data.x->widget)
9424 XtDestroyWidget (f->output_data.x->widget);
9425 f->output_data.x->widget = NULL;
9427 /* Tooltips don't have widgets, only a simple X window, even if
9428 we are using a toolkit. */
9429 else if (FRAME_X_WINDOW (f))
9430 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9432 free_frame_menubar (f);
9433 #else /* !USE_X_TOOLKIT */
9435 #ifdef USE_GTK
9436 xg_free_frame_widgets (f);
9437 #endif /* USE_GTK */
9439 if (FRAME_X_WINDOW (f))
9440 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9441 #endif /* !USE_X_TOOLKIT */
9443 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9444 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9445 unload_color (f, f->output_data.x->cursor_pixel);
9446 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9447 unload_color (f, f->output_data.x->border_pixel);
9448 unload_color (f, f->output_data.x->mouse_pixel);
9450 if (f->output_data.x->scroll_bar_background_pixel != -1)
9451 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9452 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9453 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9454 #ifdef USE_TOOLKIT_SCROLL_BARS
9455 /* Scrollbar shadow colors. */
9456 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9457 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9458 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9459 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9460 #endif /* USE_TOOLKIT_SCROLL_BARS */
9461 if (f->output_data.x->white_relief.allocated_p)
9462 unload_color (f, f->output_data.x->white_relief.pixel);
9463 if (f->output_data.x->black_relief.allocated_p)
9464 unload_color (f, f->output_data.x->black_relief.pixel);
9466 x_free_gcs (f);
9467 XFlush (FRAME_X_DISPLAY (f));
9470 xfree (f->output_data.x->saved_menu_event);
9471 xfree (f->output_data.x);
9472 f->output_data.x = NULL;
9474 if (f == dpyinfo->x_focus_frame)
9475 dpyinfo->x_focus_frame = 0;
9476 if (f == dpyinfo->x_focus_event_frame)
9477 dpyinfo->x_focus_event_frame = 0;
9478 if (f == dpyinfo->x_highlight_frame)
9479 dpyinfo->x_highlight_frame = 0;
9481 if (f == hlinfo->mouse_face_mouse_frame)
9483 hlinfo->mouse_face_beg_row
9484 = hlinfo->mouse_face_beg_col = -1;
9485 hlinfo->mouse_face_end_row
9486 = hlinfo->mouse_face_end_col = -1;
9487 hlinfo->mouse_face_window = Qnil;
9488 hlinfo->mouse_face_deferred_gc = 0;
9489 hlinfo->mouse_face_mouse_frame = 0;
9492 UNBLOCK_INPUT;
9496 /* Destroy the X window of frame F. */
9498 void
9499 x_destroy_window (struct frame *f)
9501 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9503 /* If a display connection is dead, don't try sending more
9504 commands to the X server. */
9505 if (dpyinfo->display != 0)
9506 x_free_frame_resources (f);
9508 dpyinfo->reference_count--;
9512 /* Setting window manager hints. */
9514 /* Set the normal size hints for the window manager, for frame F.
9515 FLAGS is the flags word to use--or 0 meaning preserve the flags
9516 that the window now has.
9517 If USER_POSITION is nonzero, we set the USPosition
9518 flag (this is useful when FLAGS is 0).
9519 The GTK version is in gtkutils.c */
9521 #ifndef USE_GTK
9522 void
9523 x_wm_set_size_hint (struct frame *f, long flags, int user_position)
9525 XSizeHints size_hints;
9526 Window window = FRAME_OUTER_WINDOW (f);
9528 /* Setting PMaxSize caused various problems. */
9529 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9531 size_hints.x = f->left_pos;
9532 size_hints.y = f->top_pos;
9534 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9535 size_hints.width = FRAME_PIXEL_WIDTH (f);
9537 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9538 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9539 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9540 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9541 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9542 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9544 /* Calculate the base and minimum sizes. */
9546 int base_width, base_height;
9547 int min_rows = 0, min_cols = 0;
9549 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9550 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9552 check_frame_size (f, &min_rows, &min_cols);
9554 /* The window manager uses the base width hints to calculate the
9555 current number of rows and columns in the frame while
9556 resizing; min_width and min_height aren't useful for this
9557 purpose, since they might not give the dimensions for a
9558 zero-row, zero-column frame.
9560 We use the base_width and base_height members if we have
9561 them; otherwise, we set the min_width and min_height members
9562 to the size for a zero x zero frame. */
9564 size_hints.flags |= PBaseSize;
9565 size_hints.base_width = base_width;
9566 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9567 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9568 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9571 /* If we don't need the old flags, we don't need the old hint at all. */
9572 if (flags)
9574 size_hints.flags |= flags;
9575 goto no_read;
9579 XSizeHints hints; /* Sometimes I hate X Windows... */
9580 long supplied_return;
9581 int value;
9583 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9584 &supplied_return);
9586 if (flags)
9587 size_hints.flags |= flags;
9588 else
9590 if (value == 0)
9591 hints.flags = 0;
9592 if (hints.flags & PSize)
9593 size_hints.flags |= PSize;
9594 if (hints.flags & PPosition)
9595 size_hints.flags |= PPosition;
9596 if (hints.flags & USPosition)
9597 size_hints.flags |= USPosition;
9598 if (hints.flags & USSize)
9599 size_hints.flags |= USSize;
9603 no_read:
9605 #ifdef PWinGravity
9606 size_hints.win_gravity = f->win_gravity;
9607 size_hints.flags |= PWinGravity;
9609 if (user_position)
9611 size_hints.flags &= ~ PPosition;
9612 size_hints.flags |= USPosition;
9614 #endif /* PWinGravity */
9616 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9618 #endif /* not USE_GTK */
9620 /* Used for IconicState or NormalState */
9622 void
9623 x_wm_set_window_state (struct frame *f, int state)
9625 #ifdef USE_X_TOOLKIT
9626 Arg al[1];
9628 XtSetArg (al[0], XtNinitialState, state);
9629 XtSetValues (f->output_data.x->widget, al, 1);
9630 #else /* not USE_X_TOOLKIT */
9631 Window window = FRAME_X_WINDOW (f);
9633 f->output_data.x->wm_hints.flags |= StateHint;
9634 f->output_data.x->wm_hints.initial_state = state;
9636 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9637 #endif /* not USE_X_TOOLKIT */
9640 void
9641 x_wm_set_icon_pixmap (struct frame *f, int pixmap_id)
9643 Pixmap icon_pixmap, icon_mask;
9645 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9646 Window window = FRAME_OUTER_WINDOW (f);
9647 #endif
9649 if (pixmap_id > 0)
9651 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9652 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9653 icon_mask = x_bitmap_mask (f, pixmap_id);
9654 f->output_data.x->wm_hints.icon_mask = icon_mask;
9656 else
9658 /* It seems there is no way to turn off use of an icon
9659 pixmap. */
9660 return;
9664 #ifdef USE_GTK
9666 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9667 return;
9670 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9673 Arg al[1];
9674 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9675 XtSetValues (f->output_data.x->widget, al, 1);
9676 XtSetArg (al[0], XtNiconMask, icon_mask);
9677 XtSetValues (f->output_data.x->widget, al, 1);
9680 #else /* not USE_X_TOOLKIT && not USE_GTK */
9682 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9683 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9685 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9688 void
9689 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9691 Window window = FRAME_OUTER_WINDOW (f);
9693 f->output_data.x->wm_hints.flags |= IconPositionHint;
9694 f->output_data.x->wm_hints.icon_x = icon_x;
9695 f->output_data.x->wm_hints.icon_y = icon_y;
9697 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9701 /***********************************************************************
9702 Fonts
9703 ***********************************************************************/
9705 #if GLYPH_DEBUG
9707 /* Check that FONT is valid on frame F. It is if it can be found in F's
9708 font table. */
9710 static void
9711 x_check_font (struct frame *f, struct font *font)
9713 Lisp_Object frame;
9715 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9716 if (font->driver->check)
9717 xassert (font->driver->check (f, font) == 0);
9720 #endif /* GLYPH_DEBUG != 0 */
9723 /***********************************************************************
9724 Initialization
9725 ***********************************************************************/
9727 #ifdef USE_X_TOOLKIT
9728 static XrmOptionDescRec emacs_options[] = {
9729 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9730 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9732 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9733 XrmoptionSepArg, NULL},
9734 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9736 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9737 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9738 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9739 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9740 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9741 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9742 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9745 /* Whether atimer for Xt timeouts is activated or not. */
9747 static int x_timeout_atimer_activated_flag;
9749 #endif /* USE_X_TOOLKIT */
9751 static int x_initialized;
9753 #ifdef HAVE_X_SM
9754 static int x_session_initialized;
9755 #endif
9757 /* Test whether two display-name strings agree up to the dot that separates
9758 the screen number from the server number. */
9759 static int
9760 same_x_server (const char *name1, const char *name2)
9762 int seen_colon = 0;
9763 const unsigned char *system_name = SDATA (Vsystem_name);
9764 int system_name_length = strlen (system_name);
9765 int length_until_period = 0;
9767 while (system_name[length_until_period] != 0
9768 && system_name[length_until_period] != '.')
9769 length_until_period++;
9771 /* Treat `unix' like an empty host name. */
9772 if (! strncmp (name1, "unix:", 5))
9773 name1 += 4;
9774 if (! strncmp (name2, "unix:", 5))
9775 name2 += 4;
9776 /* Treat this host's name like an empty host name. */
9777 if (! strncmp (name1, system_name, system_name_length)
9778 && name1[system_name_length] == ':')
9779 name1 += system_name_length;
9780 if (! strncmp (name2, system_name, system_name_length)
9781 && name2[system_name_length] == ':')
9782 name2 += system_name_length;
9783 /* Treat this host's domainless name like an empty host name. */
9784 if (! strncmp (name1, system_name, length_until_period)
9785 && name1[length_until_period] == ':')
9786 name1 += length_until_period;
9787 if (! strncmp (name2, system_name, length_until_period)
9788 && name2[length_until_period] == ':')
9789 name2 += length_until_period;
9791 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9793 if (*name1 == ':')
9794 seen_colon++;
9795 if (seen_colon && *name1 == '.')
9796 return 1;
9798 return (seen_colon
9799 && (*name1 == '.' || *name1 == '\0')
9800 && (*name2 == '.' || *name2 == '\0'));
9803 /* Count number of set bits in mask and number of bits to shift to
9804 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9805 to 5. */
9806 static void
9807 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9809 int nr = 0;
9810 int off = 0;
9812 while (!(mask & 1))
9814 off++;
9815 mask >>= 1;
9818 while (mask & 1)
9820 nr++;
9821 mask >>= 1;
9824 *offset = off;
9825 *bits = nr;
9828 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9829 But don't permanently open it, just test its availability. */
9832 x_display_ok (const char *display)
9834 int dpy_ok = 1;
9835 Display *dpy;
9837 dpy = XOpenDisplay (display);
9838 if (dpy)
9839 XCloseDisplay (dpy);
9840 else
9841 dpy_ok = 0;
9842 return dpy_ok;
9845 #ifdef USE_GTK
9846 static void
9847 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data)
9849 if (!strstr (message, "g_set_prgname"))
9850 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, message);
9852 #endif
9854 /* Open a connection to X display DISPLAY_NAME, and return
9855 the structure that describes the open display.
9856 If we cannot contact the display, return null. */
9858 struct x_display_info *
9859 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9861 int connection;
9862 Display *dpy;
9863 struct terminal *terminal;
9864 struct x_display_info *dpyinfo;
9865 XrmDatabase xrdb;
9866 Mouse_HLInfo *hlinfo;
9868 BLOCK_INPUT;
9870 if (!x_initialized)
9872 x_initialize ();
9873 ++x_initialized;
9876 if (! x_display_ok (SDATA (display_name)))
9877 error ("Display %s can't be opened", SDATA (display_name));
9879 #ifdef USE_GTK
9881 #define NUM_ARGV 10
9882 int argc;
9883 char *argv[NUM_ARGV];
9884 char **argv2 = argv;
9885 guint id;
9887 if (x_initialized++ > 1)
9889 xg_display_open (SDATA (display_name), &dpy);
9891 else
9893 static char display_opt[] = "--display";
9894 static char name_opt[] = "--name";
9896 for (argc = 0; argc < NUM_ARGV; ++argc)
9897 argv[argc] = 0;
9899 argc = 0;
9900 argv[argc++] = initial_argv[0];
9902 if (! NILP (display_name))
9904 argv[argc++] = display_opt;
9905 argv[argc++] = SDATA (display_name);
9908 argv[argc++] = name_opt;
9909 argv[argc++] = resource_name;
9911 XSetLocaleModifiers ("");
9913 /* Work around GLib bug that outputs a faulty warning. See
9914 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9915 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9916 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9917 gtk_init (&argc, &argv2);
9918 g_log_remove_handler ("GLib", id);
9920 /* gtk_init does set_locale. We must fix locale after calling it. */
9921 fixup_locale ();
9922 xg_initialize ();
9924 dpy = GDK_DISPLAY ();
9926 /* NULL window -> events for all windows go to our function */
9927 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9929 /* Load our own gtkrc if it exists. */
9931 const char *file = "~/.emacs.d/gtkrc";
9932 Lisp_Object s, abs_file;
9934 s = make_string (file, strlen (file));
9935 abs_file = Fexpand_file_name (s, Qnil);
9937 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9938 gtk_rc_parse (SDATA (abs_file));
9941 XSetErrorHandler (x_error_handler);
9942 XSetIOErrorHandler (x_io_error_quitter);
9945 #else /* not USE_GTK */
9946 #ifdef USE_X_TOOLKIT
9947 /* weiner@footloose.sps.mot.com reports that this causes
9948 errors with X11R5:
9949 X protocol error: BadAtom (invalid Atom parameter)
9950 on protocol request 18skiloaf.
9951 So let's not use it until R6. */
9952 #ifdef HAVE_X11XTR6
9953 XtSetLanguageProc (NULL, NULL, NULL);
9954 #endif
9957 int argc = 0;
9958 char *argv[3];
9960 argv[0] = "";
9961 argc = 1;
9962 if (xrm_option)
9964 argv[argc++] = "-xrm";
9965 argv[argc++] = xrm_option;
9967 turn_on_atimers (0);
9968 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
9969 resource_name, EMACS_CLASS,
9970 emacs_options, XtNumber (emacs_options),
9971 &argc, argv);
9972 turn_on_atimers (1);
9974 #ifdef HAVE_X11XTR6
9975 /* I think this is to compensate for XtSetLanguageProc. */
9976 fixup_locale ();
9977 #endif
9980 #else /* not USE_X_TOOLKIT */
9981 XSetLocaleModifiers ("");
9982 dpy = XOpenDisplay (SDATA (display_name));
9983 #endif /* not USE_X_TOOLKIT */
9984 #endif /* not USE_GTK*/
9986 /* Detect failure. */
9987 if (dpy == 0)
9989 UNBLOCK_INPUT;
9990 return 0;
9993 /* We have definitely succeeded. Record the new connection. */
9995 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
9996 memset (dpyinfo, 0, sizeof *dpyinfo);
9997 hlinfo = &dpyinfo->mouse_highlight;
9999 terminal = x_create_terminal (dpyinfo);
10002 struct x_display_info *share;
10003 Lisp_Object tail;
10005 for (share = x_display_list, tail = x_display_name_list; share;
10006 share = share->next, tail = XCDR (tail))
10007 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10008 SDATA (display_name)))
10009 break;
10010 if (share)
10011 terminal->kboard = share->terminal->kboard;
10012 else
10014 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10015 init_kboard (terminal->kboard);
10016 terminal->kboard->Vwindow_system = Qx;
10018 /* Add the keyboard to the list before running Lisp code (via
10019 Qvendor_specific_keysyms below), since these are not traced
10020 via terminals but only through all_kboards. */
10021 terminal->kboard->next_kboard = all_kboards;
10022 all_kboards = terminal->kboard;
10024 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10026 char *vendor = ServerVendor (dpy);
10028 /* Protect terminal from GC before removing it from the
10029 list of terminals. */
10030 struct gcpro gcpro1;
10031 Lisp_Object gcpro_term;
10032 XSETTERMINAL (gcpro_term, terminal);
10033 GCPRO1 (gcpro_term);
10035 /* Temporarily hide the partially initialized terminal. */
10036 terminal_list = terminal->next_terminal;
10037 UNBLOCK_INPUT;
10038 terminal->kboard->Vsystem_key_alist
10039 = call1 (Qvendor_specific_keysyms,
10040 vendor ? build_string (vendor) : empty_unibyte_string);
10041 BLOCK_INPUT;
10042 terminal->next_terminal = terminal_list;
10043 terminal_list = terminal;
10044 UNGCPRO;
10047 /* Don't let the initial kboard remain current longer than necessary.
10048 That would cause problems if a file loaded on startup tries to
10049 prompt in the mini-buffer. */
10050 if (current_kboard == initial_kboard)
10051 current_kboard = terminal->kboard;
10053 terminal->kboard->reference_count++;
10056 /* Put this display on the chain. */
10057 dpyinfo->next = x_display_list;
10058 x_display_list = dpyinfo;
10060 /* Put it on x_display_name_list as well, to keep them parallel. */
10061 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10062 x_display_name_list);
10063 dpyinfo->name_list_element = XCAR (x_display_name_list);
10065 dpyinfo->display = dpy;
10067 /* Set the name of the terminal. */
10068 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10069 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10070 terminal->name[SBYTES (display_name)] = 0;
10072 #if 0
10073 XSetAfterFunction (x_current_display, x_trace_wire);
10074 #endif /* ! 0 */
10076 dpyinfo->x_id_name
10077 = (char *) xmalloc (SBYTES (Vinvocation_name)
10078 + SBYTES (Vsystem_name)
10079 + 2);
10080 sprintf (dpyinfo->x_id_name, "%s@%s",
10081 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10083 /* Figure out which modifier bits mean what. */
10084 x_find_modifier_meanings (dpyinfo);
10086 /* Get the scroll bar cursor. */
10087 #ifdef USE_GTK
10088 /* We must create a GTK cursor, it is required for GTK widgets. */
10089 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10090 #endif /* USE_GTK */
10092 dpyinfo->vertical_scroll_bar_cursor
10093 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10095 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10096 resource_name, EMACS_CLASS);
10097 #ifdef HAVE_XRMSETDATABASE
10098 XrmSetDatabase (dpyinfo->display, xrdb);
10099 #else
10100 dpyinfo->display->db = xrdb;
10101 #endif
10102 /* Put the rdb where we can find it in a way that works on
10103 all versions. */
10104 dpyinfo->xrdb = xrdb;
10106 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10107 DefaultScreen (dpyinfo->display));
10108 select_visual (dpyinfo);
10109 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10110 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10111 dpyinfo->client_leader_window = 0;
10112 dpyinfo->grabbed = 0;
10113 dpyinfo->reference_count = 0;
10114 dpyinfo->icon_bitmap_id = -1;
10115 dpyinfo->n_fonts = 0;
10116 dpyinfo->bitmaps = 0;
10117 dpyinfo->bitmaps_size = 0;
10118 dpyinfo->bitmaps_last = 0;
10119 dpyinfo->scratch_cursor_gc = 0;
10120 hlinfo->mouse_face_mouse_frame = 0;
10121 hlinfo->mouse_face_deferred_gc = 0;
10122 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10123 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10124 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10125 hlinfo->mouse_face_window = Qnil;
10126 hlinfo->mouse_face_overlay = Qnil;
10127 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10128 hlinfo->mouse_face_defer = 0;
10129 hlinfo->mouse_face_hidden = 0;
10130 dpyinfo->x_focus_frame = 0;
10131 dpyinfo->x_focus_event_frame = 0;
10132 dpyinfo->x_highlight_frame = 0;
10133 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10135 /* See if we can construct pixel values from RGB values. */
10136 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10137 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10139 if (dpyinfo->visual->class == TrueColor)
10141 get_bits_and_offset (dpyinfo->visual->red_mask,
10142 &dpyinfo->red_bits, &dpyinfo->red_offset);
10143 get_bits_and_offset (dpyinfo->visual->blue_mask,
10144 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10145 get_bits_and_offset (dpyinfo->visual->green_mask,
10146 &dpyinfo->green_bits, &dpyinfo->green_offset);
10149 /* See if a private colormap is requested. */
10150 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10152 if (dpyinfo->visual->class == PseudoColor)
10154 Lisp_Object value;
10155 value = display_x_get_resource (dpyinfo,
10156 build_string ("privateColormap"),
10157 build_string ("PrivateColormap"),
10158 Qnil, Qnil);
10159 if (STRINGP (value)
10160 && (!strcmp (SDATA (value), "true")
10161 || !strcmp (SDATA (value), "on")))
10162 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10165 else
10166 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10167 dpyinfo->visual, AllocNone);
10169 #ifdef HAVE_XFT
10171 /* If we are using Xft, check dpi value in X resources.
10172 It is better we use it as well, since Xft will use it, as will all
10173 Gnome applications. If our real DPI is smaller or larger than the
10174 one Xft uses, our font will look smaller or larger than other
10175 for other applications, even if it is the same font name (monospace-10
10176 for example). */
10177 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10178 double d;
10179 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10180 dpyinfo->resy = dpyinfo->resx = d;
10182 #endif
10184 if (dpyinfo->resy < 1)
10186 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10187 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10188 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10189 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10190 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10191 pixels = DisplayWidth (dpyinfo->display, screen_number);
10192 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10193 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10194 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10198 const struct
10200 const char *name;
10201 Atom *atom;
10202 } atom_refs[] = {
10203 { "WM_PROTOCOLS", &dpyinfo->Xatom_wm_protocols },
10204 { "WM_TAKE_FOCUS", &dpyinfo->Xatom_wm_take_focus },
10205 { "WM_SAVE_YOURSELF", &dpyinfo->Xatom_wm_save_yourself },
10206 { "WM_DELETE_WINDOW", &dpyinfo->Xatom_wm_delete_window },
10207 { "WM_CHANGE_STATE", &dpyinfo->Xatom_wm_change_state },
10208 { "WM_CONFIGURE_DENIED", &dpyinfo->Xatom_wm_configure_denied },
10209 { "WM_MOVED", &dpyinfo->Xatom_wm_window_moved },
10210 { "WM_CLIENT_LEADER", &dpyinfo->Xatom_wm_client_leader },
10211 { "Editres", &dpyinfo->Xatom_editres },
10212 { "CLIPBOARD", &dpyinfo->Xatom_CLIPBOARD },
10213 { "TIMESTAMP", &dpyinfo->Xatom_TIMESTAMP },
10214 { "TEXT", &dpyinfo->Xatom_TEXT },
10215 { "COMPOUND_TEXT", &dpyinfo->Xatom_COMPOUND_TEXT },
10216 { "UTF8_STRING", &dpyinfo->Xatom_UTF8_STRING },
10217 { "DELETE", &dpyinfo->Xatom_DELETE },
10218 { "MULTIPLE", &dpyinfo->Xatom_MULTIPLE },
10219 { "INCR", &dpyinfo->Xatom_INCR },
10220 { "_EMACS_TMP_", &dpyinfo->Xatom_EMACS_TMP },
10221 { "TARGETS", &dpyinfo->Xatom_TARGETS },
10222 { "NULL", &dpyinfo->Xatom_NULL },
10223 { "ATOM_PAIR", &dpyinfo->Xatom_ATOM_PAIR },
10224 { "_XEMBED_INFO", &dpyinfo->Xatom_XEMBED_INFO },
10225 /* For properties of font. */
10226 { "PIXEL_SIZE", &dpyinfo->Xatom_PIXEL_SIZE },
10227 { "AVERAGE_WIDTH", &dpyinfo->Xatom_AVERAGE_WIDTH },
10228 { "_MULE_BASELINE_OFFSET", &dpyinfo->Xatom_MULE_BASELINE_OFFSET },
10229 { "_MULE_RELATIVE_COMPOSE", &dpyinfo->Xatom_MULE_RELATIVE_COMPOSE },
10230 { "_MULE_DEFAULT_ASCENT", &dpyinfo->Xatom_MULE_DEFAULT_ASCENT },
10231 /* Ghostscript support. */
10232 { "DONE", &dpyinfo->Xatom_DONE },
10233 { "PAGE", &dpyinfo->Xatom_PAGE },
10234 { "SCROLLBAR", &dpyinfo->Xatom_Scrollbar },
10235 { "_XEMBED", &dpyinfo->Xatom_XEMBED },
10236 /* EWMH */
10237 { "_NET_WM_STATE", &dpyinfo->Xatom_net_wm_state },
10238 { "_NET_WM_STATE_FULLSCREEN", &dpyinfo->Xatom_net_wm_state_fullscreen },
10239 { "_NET_WM_STATE_MAXIMIZED_HORZ",
10240 &dpyinfo->Xatom_net_wm_state_maximized_horz },
10241 { "_NET_WM_STATE_MAXIMIZED_VERT",
10242 &dpyinfo->Xatom_net_wm_state_maximized_vert },
10243 { "_NET_WM_STATE_STICKY", &dpyinfo->Xatom_net_wm_state_sticky },
10244 { "_NET_WM_WINDOW_TYPE", &dpyinfo->Xatom_net_window_type },
10245 { "_NET_WM_WINDOW_TYPE_TOOLTIP",
10246 &dpyinfo->Xatom_net_window_type_tooltip },
10247 { "_NET_WM_ICON_NAME", &dpyinfo->Xatom_net_wm_icon_name },
10248 { "_NET_WM_NAME", &dpyinfo->Xatom_net_wm_name },
10249 { "_NET_SUPPORTED", &dpyinfo->Xatom_net_supported },
10250 { "_NET_SUPPORTING_WM_CHECK", &dpyinfo->Xatom_net_supporting_wm_check },
10251 { "_NET_WM_WINDOW_OPACITY", &dpyinfo->Xatom_net_wm_window_opacity },
10252 { "_NET_ACTIVE_WINDOW", &dpyinfo->Xatom_net_active_window },
10253 { "_NET_FRAME_EXTENTS", &dpyinfo->Xatom_net_frame_extents },
10254 /* Session management */
10255 { "SM_CLIENT_ID", &dpyinfo->Xatom_SM_CLIENT_ID },
10256 { "_XSETTINGS_SETTINGS", &dpyinfo->Xatom_xsettings_prop },
10257 { "MANAGER", &dpyinfo->Xatom_xsettings_mgr },
10260 int i;
10261 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10262 /* 1 for _XSETTINGS_SN */
10263 const int total_atom_count = 1 + atom_count;
10264 Atom *atoms_return = xmalloc (sizeof (Atom) * total_atom_count);
10265 char **atom_names = xmalloc (sizeof (char *) * total_atom_count);
10266 char xsettings_atom_name[64];
10268 for (i = 0; i < atom_count; i++)
10269 atom_names[i] = (char *) atom_refs[i].name;
10271 /* Build _XSETTINGS_SN atom name */
10272 snprintf (xsettings_atom_name, sizeof (xsettings_atom_name),
10273 "_XSETTINGS_S%d", XScreenNumberOfScreen (dpyinfo->screen));
10274 atom_names[i] = xsettings_atom_name;
10276 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10277 False, atoms_return);
10279 for (i = 0; i < atom_count; i++)
10280 *atom_refs[i].atom = atoms_return[i];
10282 /* Manual copy of last atom */
10283 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10285 xfree (atom_names);
10286 xfree (atoms_return);
10289 dpyinfo->x_dnd_atoms_size = 8;
10290 dpyinfo->x_dnd_atoms_length = 0;
10291 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10292 * dpyinfo->x_dnd_atoms_size);
10294 dpyinfo->net_supported_atoms = NULL;
10295 dpyinfo->nr_net_supported_atoms = 0;
10296 dpyinfo->net_supported_window = 0;
10298 connection = ConnectionNumber (dpyinfo->display);
10299 dpyinfo->connection = connection;
10302 dpyinfo->gray
10303 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10304 gray_bitmap_bits,
10305 gray_bitmap_width, gray_bitmap_height,
10306 (unsigned long) 1, (unsigned long) 0, 1);
10309 #ifdef HAVE_X_I18N
10310 xim_initialize (dpyinfo, resource_name);
10311 #endif
10313 xsettings_initialize (dpyinfo);
10315 /* This is only needed for distinguishing keyboard and process input. */
10316 if (connection != 0)
10317 add_keyboard_wait_descriptor (connection);
10319 #ifdef F_SETOWN
10320 fcntl (connection, F_SETOWN, getpid ());
10321 #endif /* ! defined (F_SETOWN) */
10323 #ifdef SIGIO
10324 if (interrupt_input)
10325 init_sigio (connection);
10326 #endif /* ! defined (SIGIO) */
10328 #ifdef USE_LUCID
10330 Display *dpy = dpyinfo->display;
10331 XrmValue d, fr, to;
10332 Font font;
10334 d.addr = (XPointer)&dpy;
10335 d.size = sizeof (Display *);
10336 fr.addr = XtDefaultFont;
10337 fr.size = sizeof (XtDefaultFont);
10338 to.size = sizeof (Font *);
10339 to.addr = (XPointer)&font;
10340 x_catch_errors (dpy);
10341 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10342 abort ();
10343 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10344 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10345 x_uncatch_errors ();
10347 #endif
10349 /* See if we should run in synchronous mode. This is useful
10350 for debugging X code. */
10352 Lisp_Object value;
10353 value = display_x_get_resource (dpyinfo,
10354 build_string ("synchronous"),
10355 build_string ("Synchronous"),
10356 Qnil, Qnil);
10357 if (STRINGP (value)
10358 && (!strcmp (SDATA (value), "true")
10359 || !strcmp (SDATA (value), "on")))
10360 XSynchronize (dpyinfo->display, True);
10364 Lisp_Object value;
10365 value = display_x_get_resource (dpyinfo,
10366 build_string ("useXIM"),
10367 build_string ("UseXIM"),
10368 Qnil, Qnil);
10369 #ifdef USE_XIM
10370 if (STRINGP (value)
10371 && (!strcmp (SDATA (value), "false")
10372 || !strcmp (SDATA (value), "off")))
10373 use_xim = 0;
10374 #else
10375 if (STRINGP (value)
10376 && (!strcmp (SDATA (value), "true")
10377 || !strcmp (SDATA (value), "on")))
10378 use_xim = 1;
10379 #endif
10382 #ifdef HAVE_X_SM
10383 /* Only do this for the very first display in the Emacs session.
10384 Ignore X session management when Emacs was first started on a
10385 tty. */
10386 if (terminal->id == 1)
10387 x_session_initialize (dpyinfo);
10388 #endif
10390 UNBLOCK_INPUT;
10392 return dpyinfo;
10395 /* Get rid of display DPYINFO, deleting all frames on it,
10396 and without sending any more commands to the X server. */
10398 void
10399 x_delete_display (struct x_display_info *dpyinfo)
10401 struct terminal *t;
10403 /* Close all frames and delete the generic struct terminal for this
10404 X display. */
10405 for (t = terminal_list; t; t = t->next_terminal)
10406 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10408 #ifdef HAVE_X_SM
10409 /* Close X session management when we close its display. */
10410 if (t->id == 1 && x_session_have_connection ())
10411 x_session_close ();
10412 #endif
10413 delete_terminal (t);
10414 break;
10417 delete_keyboard_wait_descriptor (dpyinfo->connection);
10419 /* Discard this display from x_display_name_list and x_display_list.
10420 We can't use Fdelq because that can quit. */
10421 if (! NILP (x_display_name_list)
10422 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10423 x_display_name_list = XCDR (x_display_name_list);
10424 else
10426 Lisp_Object tail;
10428 tail = x_display_name_list;
10429 while (CONSP (tail) && CONSP (XCDR (tail)))
10431 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10433 XSETCDR (tail, XCDR (XCDR (tail)));
10434 break;
10436 tail = XCDR (tail);
10440 if (next_noop_dpyinfo == dpyinfo)
10441 next_noop_dpyinfo = dpyinfo->next;
10443 if (x_display_list == dpyinfo)
10444 x_display_list = dpyinfo->next;
10445 else
10447 struct x_display_info *tail;
10449 for (tail = x_display_list; tail; tail = tail->next)
10450 if (tail->next == dpyinfo)
10451 tail->next = tail->next->next;
10454 xfree (dpyinfo->x_id_name);
10455 xfree (dpyinfo->x_dnd_atoms);
10456 xfree (dpyinfo->color_cells);
10457 xfree (dpyinfo);
10460 #ifdef USE_X_TOOLKIT
10462 /* Atimer callback function for TIMER. Called every 0.1s to process
10463 Xt timeouts, if needed. We must avoid calling XtAppPending as
10464 much as possible because that function does an implicit XFlush
10465 that slows us down. */
10467 static void
10468 x_process_timeouts (struct atimer *timer)
10470 BLOCK_INPUT;
10471 x_timeout_atimer_activated_flag = 0;
10472 if (toolkit_scroll_bar_interaction || popup_activated ())
10474 while (XtAppPending (Xt_app_con) & XtIMTimer)
10475 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10476 /* Reactivate the atimer for next time. */
10477 x_activate_timeout_atimer ();
10479 UNBLOCK_INPUT;
10482 /* Install an asynchronous timer that processes Xt timeout events
10483 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10484 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10485 function whenever these variables are set. This is necessary
10486 because some widget sets use timeouts internally, for example the
10487 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10488 processed, these widgets don't behave normally. */
10490 void
10491 x_activate_timeout_atimer (void)
10493 BLOCK_INPUT;
10494 if (!x_timeout_atimer_activated_flag)
10496 EMACS_TIME interval;
10498 EMACS_SET_SECS_USECS (interval, 0, 100000);
10499 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10500 x_timeout_atimer_activated_flag = 1;
10502 UNBLOCK_INPUT;
10505 #endif /* USE_X_TOOLKIT */
10508 /* Set up use of X before we make the first connection. */
10510 extern frame_parm_handler x_frame_parm_handlers[];
10512 static struct redisplay_interface x_redisplay_interface =
10514 x_frame_parm_handlers,
10515 x_produce_glyphs,
10516 x_write_glyphs,
10517 x_insert_glyphs,
10518 x_clear_end_of_line,
10519 x_scroll_run,
10520 x_after_update_window_line,
10521 x_update_window_begin,
10522 x_update_window_end,
10523 x_cursor_to,
10524 x_flush,
10525 #ifdef XFlush
10526 x_flush,
10527 #else
10528 0, /* flush_display_optional */
10529 #endif
10530 x_clear_window_mouse_face,
10531 x_get_glyph_overhangs,
10532 x_fix_overlapping_area,
10533 x_draw_fringe_bitmap,
10534 0, /* define_fringe_bitmap */
10535 0, /* destroy_fringe_bitmap */
10536 x_compute_glyph_string_overhangs,
10537 x_draw_glyph_string,
10538 x_define_frame_cursor,
10539 x_clear_frame_area,
10540 x_draw_window_cursor,
10541 x_draw_vertical_window_border,
10542 x_shift_glyphs_for_insert
10546 /* This function is called when the last frame on a display is deleted. */
10547 void
10548 x_delete_terminal (struct terminal *terminal)
10550 struct x_display_info *dpyinfo = terminal->display_info.x;
10552 /* Protect against recursive calls. delete_frame in
10553 delete_terminal calls us back when it deletes our last frame. */
10554 if (!terminal->name)
10555 return;
10557 BLOCK_INPUT;
10558 #ifdef HAVE_X_I18N
10559 /* We must close our connection to the XIM server before closing the
10560 X display. */
10561 if (dpyinfo->xim)
10562 xim_close_dpy (dpyinfo);
10563 #endif
10565 /* If called from x_connection_closed, the display may already be closed
10566 and dpyinfo->display was set to 0 to indicate that. */
10567 if (dpyinfo->display)
10569 x_destroy_all_bitmaps (dpyinfo);
10570 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10572 /* Whether or not XCloseDisplay destroys the associated resource
10573 database depends on the version of libX11. To avoid both
10574 crash and memory leak, we dissociate the database from the
10575 display and then destroy dpyinfo->xrdb ourselves.
10577 Unfortunately, the above strategy does not work in some
10578 situations due to a bug in newer versions of libX11: because
10579 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10580 dpy->db is NULL, XCloseDisplay destroys the associated
10581 database whereas it has not been created by XGetDefault
10582 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10583 don't destroy the database here in order to avoid the crash
10584 in the above situations for now, though that may cause memory
10585 leaks in other situations. */
10586 #if 0
10587 #ifdef HAVE_XRMSETDATABASE
10588 XrmSetDatabase (dpyinfo->display, NULL);
10589 #else
10590 dpyinfo->display->db = NULL;
10591 #endif
10592 /* We used to call XrmDestroyDatabase from x_delete_display, but
10593 some older versions of libX11 crash if we call it after
10594 closing all the displays. */
10595 XrmDestroyDatabase (dpyinfo->xrdb);
10596 #endif
10598 #ifdef USE_GTK
10599 xg_display_close (dpyinfo->display);
10600 #else
10601 #ifdef USE_X_TOOLKIT
10602 XtCloseDisplay (dpyinfo->display);
10603 #else
10604 XCloseDisplay (dpyinfo->display);
10605 #endif
10606 #endif /* ! USE_GTK */
10609 /* Mark as dead. */
10610 dpyinfo->display = NULL;
10611 x_delete_display (dpyinfo);
10612 UNBLOCK_INPUT;
10615 /* Create a struct terminal, initialize it with the X11 specific
10616 functions and make DISPLAY->TERMINAL point to it. */
10618 static struct terminal *
10619 x_create_terminal (struct x_display_info *dpyinfo)
10621 struct terminal *terminal;
10623 terminal = create_terminal ();
10625 terminal->type = output_x_window;
10626 terminal->display_info.x = dpyinfo;
10627 dpyinfo->terminal = terminal;
10629 /* kboard is initialized in x_term_init. */
10631 terminal->clear_frame_hook = x_clear_frame;
10632 terminal->ins_del_lines_hook = x_ins_del_lines;
10633 terminal->delete_glyphs_hook = x_delete_glyphs;
10634 terminal->ring_bell_hook = XTring_bell;
10635 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10636 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10637 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10638 terminal->update_begin_hook = x_update_begin;
10639 terminal->update_end_hook = x_update_end;
10640 terminal->set_terminal_window_hook = XTset_terminal_window;
10641 terminal->read_socket_hook = XTread_socket;
10642 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10643 terminal->mouse_position_hook = XTmouse_position;
10644 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10645 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10646 terminal->fullscreen_hook = XTfullscreen_hook;
10647 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10648 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10649 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10650 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10652 terminal->delete_frame_hook = x_destroy_window;
10653 terminal->delete_terminal_hook = x_delete_terminal;
10655 terminal->rif = &x_redisplay_interface;
10656 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10657 terminal->char_ins_del_ok = 1;
10658 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10659 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10660 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10661 off the bottom. */
10663 return terminal;
10666 void
10667 x_initialize (void)
10669 baud_rate = 19200;
10671 x_noop_count = 0;
10672 last_tool_bar_item = -1;
10673 any_help_event_p = 0;
10674 ignore_next_mouse_click_timeout = 0;
10675 #ifdef HAVE_X_SM
10676 x_session_initialized = 0;
10677 #endif
10679 #ifdef USE_GTK
10680 current_count = -1;
10681 #endif
10683 /* Try to use interrupt input; if we can't, then start polling. */
10684 Fset_input_interrupt_mode (Qt);
10686 #ifdef USE_X_TOOLKIT
10687 XtToolkitInitialize ();
10689 Xt_app_con = XtCreateApplicationContext ();
10691 /* Register a converter from strings to pixels, which uses
10692 Emacs' color allocation infrastructure. */
10693 XtAppSetTypeConverter (Xt_app_con,
10694 XtRString, XtRPixel, cvt_string_to_pixel,
10695 cvt_string_to_pixel_args,
10696 XtNumber (cvt_string_to_pixel_args),
10697 XtCacheByDisplay, cvt_pixel_dtor);
10699 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10700 #endif
10702 #ifdef USE_TOOLKIT_SCROLL_BARS
10703 #ifndef USE_GTK
10704 xaw3d_arrow_scroll = False;
10705 xaw3d_pick_top = True;
10706 #endif
10707 #endif
10709 pending_autoraise_frame = 0;
10710 pending_event_wait.f = 0;
10711 pending_event_wait.eventtype = 0;
10713 /* Note that there is no real way portable across R3/R4 to get the
10714 original error handler. */
10715 XSetErrorHandler (x_error_handler);
10716 XSetIOErrorHandler (x_io_error_quitter);
10718 signal (SIGPIPE, x_connection_signal);
10720 xgselect_initialize ();
10724 void
10725 syms_of_xterm (void)
10727 x_error_message = NULL;
10729 staticpro (&x_display_name_list);
10730 x_display_name_list = Qnil;
10732 staticpro (&last_mouse_scroll_bar);
10733 last_mouse_scroll_bar = Qnil;
10735 staticpro (&Qvendor_specific_keysyms);
10736 Qvendor_specific_keysyms = intern_c_string ("vendor-specific-keysyms");
10738 staticpro (&Qlatin_1);
10739 Qlatin_1 = intern_c_string ("latin-1");
10741 staticpro (&last_mouse_press_frame);
10742 last_mouse_press_frame = Qnil;
10744 #ifdef USE_GTK
10745 xg_default_icon_file = make_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10746 staticpro (&xg_default_icon_file);
10748 Qx_gtk_map_stock = intern_c_string ("x-gtk-map-stock");
10749 staticpro (&Qx_gtk_map_stock);
10750 #endif
10752 DEFVAR_BOOL ("x-use-underline-position-properties",
10753 &x_use_underline_position_properties,
10754 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10755 A value of nil means ignore them. If you encounter fonts with bogus
10756 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10757 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10758 to override the font's UNDERLINE_POSITION for small font display
10759 sizes. */);
10760 x_use_underline_position_properties = 1;
10762 DEFVAR_BOOL ("x-underline-at-descent-line",
10763 &x_underline_at_descent_line,
10764 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10765 A value of nil means to draw the underline according to the value of the
10766 variable `x-use-underline-position-properties', which is usually at the
10767 baseline level. The default value is nil. */);
10768 x_underline_at_descent_line = 0;
10770 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10771 &x_mouse_click_focus_ignore_position,
10772 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10773 This variable is only used when the window manager requires that you
10774 click on a frame to select it (give it focus). In that case, a value
10775 of nil, means that the selected window and cursor position changes to
10776 reflect the mouse click position, while a non-nil value means that the
10777 selected window or cursor position is preserved. */);
10778 x_mouse_click_focus_ignore_position = 0;
10780 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10781 doc: /* Which toolkit scroll bars Emacs uses, if any.
10782 A value of nil means Emacs doesn't use toolkit scroll bars.
10783 With the X Window system, the value is a symbol describing the
10784 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10785 With MS Windows, the value is t. */);
10786 #ifdef USE_TOOLKIT_SCROLL_BARS
10787 #ifdef USE_MOTIF
10788 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10789 #elif defined HAVE_XAW3D
10790 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10791 #elif USE_GTK
10792 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10793 #else
10794 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10795 #endif
10796 #else
10797 Vx_toolkit_scroll_bars = Qnil;
10798 #endif
10800 staticpro (&last_mouse_motion_frame);
10801 last_mouse_motion_frame = Qnil;
10803 Qmodifier_value = intern_c_string ("modifier-value");
10804 Qalt = intern_c_string ("alt");
10805 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10806 Qhyper = intern_c_string ("hyper");
10807 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10808 Qmeta = intern_c_string ("meta");
10809 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10810 Qsuper = intern_c_string ("super");
10811 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10813 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10814 doc: /* Which keys Emacs uses for the alt modifier.
10815 This should be one of the symbols `alt', `hyper', `meta', `super'.
10816 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10817 is nil, which is the same as `alt'. */);
10818 Vx_alt_keysym = Qnil;
10820 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10821 doc: /* Which keys Emacs uses for the hyper modifier.
10822 This should be one of the symbols `alt', `hyper', `meta', `super'.
10823 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10824 default is nil, which is the same as `hyper'. */);
10825 Vx_hyper_keysym = Qnil;
10827 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10828 doc: /* Which keys Emacs uses for the meta modifier.
10829 This should be one of the symbols `alt', `hyper', `meta', `super'.
10830 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10831 default is nil, which is the same as `meta'. */);
10832 Vx_meta_keysym = Qnil;
10834 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10835 doc: /* Which keys Emacs uses for the super modifier.
10836 This should be one of the symbols `alt', `hyper', `meta', `super'.
10837 For example, `super' means use the Super_L and Super_R keysyms. The
10838 default is nil, which is the same as `super'. */);
10839 Vx_super_keysym = Qnil;
10841 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10842 doc: /* Hash table of character codes indexed by X keysym codes. */);
10843 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10844 make_float (DEFAULT_REHASH_SIZE),
10845 make_float (DEFAULT_REHASH_THRESHOLD),
10846 Qnil, Qnil, Qnil);
10849 #endif /* HAVE_X_WINDOWS */