Introduce a new comment style "c" flag.
[emacs.git] / src / xterm.c
blob005167221495d92dda6bf147577220bbe8a363f0
1 /* X Communication module for terminals which understand the X protocol.
2 Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
22 /* Xt features made by Fred Pierresteguy. */
24 #include <config.h>
25 #include <signal.h>
26 #include <stdio.h>
27 #include <setjmp.h>
29 #ifdef HAVE_X_WINDOWS
31 #include "lisp.h"
32 #include "blockinput.h"
34 /* Need syssignal.h for various externs and definitions that may be required
35 by some configurations for calls to signal later in this source file. */
36 #include "syssignal.h"
38 /* This may include sys/types.h, and that somehow loses
39 if this is not done before the other system files. */
40 #include "xterm.h"
41 #include <X11/cursorfont.h>
43 /* Load sys/types.h if not already loaded.
44 In some systems loading it twice is suicidal. */
45 #ifndef makedev
46 #include <sys/types.h>
47 #endif /* makedev */
49 #ifdef HAVE_SYS_IOCTL_H
50 #include <sys/ioctl.h>
51 #endif /* ! defined (HAVE_SYS_IOCTL_H) */
53 #include "systime.h"
55 #include <fcntl.h>
56 #include <ctype.h>
57 #include <errno.h>
58 #include <setjmp.h>
59 #include <sys/stat.h>
60 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
61 /* #include <sys/param.h> */
63 #include "charset.h"
64 #include "character.h"
65 #include "coding.h"
66 #include "frame.h"
67 #include "dispextern.h"
68 #include "fontset.h"
69 #include "termhooks.h"
70 #include "termopts.h"
71 #include "termchar.h"
72 #include "emacs-icon.h"
73 #include "disptab.h"
74 #include "buffer.h"
75 #include "window.h"
76 #include "keyboard.h"
77 #include "intervals.h"
78 #include "process.h"
79 #include "atimer.h"
80 #include "keymap.h"
81 #include "font.h"
82 #include "fontset.h"
83 #include "xsettings.h"
84 #include "xgselect.h"
85 #include "sysselect.h"
87 #ifdef USE_X_TOOLKIT
88 #include <X11/Shell.h>
89 #endif
91 #ifdef HAVE_SYS_TIME_H
92 #include <sys/time.h>
93 #endif
94 #ifdef HAVE_UNISTD_H
95 #include <unistd.h>
96 #endif
98 #ifdef USE_GTK
99 #include "gtkutil.h"
100 #endif
102 #ifdef USE_LUCID
103 #include "../lwlib/xlwmenu.h"
104 #endif
106 #ifdef USE_X_TOOLKIT
107 #if !defined(NO_EDITRES)
108 #define HACK_EDITRES
109 extern void _XEditResCheckMessages ();
110 #endif /* not NO_EDITRES */
112 /* Include toolkit specific headers for the scroll bar widget. */
114 #ifdef USE_TOOLKIT_SCROLL_BARS
115 #if defined USE_MOTIF
116 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
117 #include <Xm/ScrollBar.h>
118 #else /* !USE_MOTIF i.e. use Xaw */
120 #ifdef HAVE_XAW3D
121 #include <X11/Xaw3d/Simple.h>
122 #include <X11/Xaw3d/Scrollbar.h>
123 #include <X11/Xaw3d/ThreeD.h>
124 #else /* !HAVE_XAW3D */
125 #include <X11/Xaw/Simple.h>
126 #include <X11/Xaw/Scrollbar.h>
127 #endif /* !HAVE_XAW3D */
128 #ifndef XtNpickTop
129 #define XtNpickTop "pickTop"
130 #endif /* !XtNpickTop */
131 #endif /* !USE_MOTIF */
132 #endif /* USE_TOOLKIT_SCROLL_BARS */
134 #endif /* USE_X_TOOLKIT */
136 #ifdef USE_X_TOOLKIT
137 #include "widget.h"
138 #ifndef XtNinitialState
139 #define XtNinitialState "initialState"
140 #endif
141 #endif
143 /* Default to using XIM if available. */
144 #ifdef USE_XIM
145 int use_xim = 1;
146 #else
147 int use_xim = 0; /* configure --without-xim */
148 #endif
152 /* Non-nil means Emacs uses toolkit scroll bars. */
154 Lisp_Object Vx_toolkit_scroll_bars;
156 /* Non-zero means that a HELP_EVENT has been generated since Emacs
157 start. */
159 static int any_help_event_p;
161 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
162 static Lisp_Object last_window;
164 /* Non-zero means make use of UNDERLINE_POSITION font properties. */
166 int x_use_underline_position_properties;
168 /* Non-zero means to draw the underline at the same place as the descent line. */
170 int x_underline_at_descent_line;
172 /* This is a chain of structures for all the X displays currently in
173 use. */
175 struct x_display_info *x_display_list;
177 /* This is a list of cons cells, each of the form (NAME
178 . FONT-LIST-CACHE), one for each element of x_display_list and in
179 the same order. NAME is the name of the frame. FONT-LIST-CACHE
180 records previous values returned by x-list-fonts. */
182 Lisp_Object x_display_name_list;
184 /* Frame being updated by update_frame. This is declared in term.c.
185 This is set by update_begin and looked at by all the XT functions.
186 It is zero while not inside an update. In that case, the XT
187 functions assume that `selected_frame' is the frame to apply to. */
189 extern struct frame *updating_frame;
191 /* This is a frame waiting to be auto-raised, within XTread_socket. */
193 static struct frame *pending_autoraise_frame;
195 /* This is a frame waiting for an event matching mask, within XTread_socket. */
197 static struct {
198 struct frame *f;
199 int eventtype;
200 } pending_event_wait;
202 #ifdef USE_X_TOOLKIT
203 /* The application context for Xt use. */
204 XtAppContext Xt_app_con;
205 static String Xt_default_resources[] = {0};
206 #endif /* USE_X_TOOLKIT */
208 /* Non-zero means user is interacting with a toolkit scroll bar. */
210 static int toolkit_scroll_bar_interaction;
212 /* Non-zero means to not move point as a result of clicking on a
213 frame to focus it (when focus-follows-mouse is nil). */
215 int x_mouse_click_focus_ignore_position;
217 /* Non-zero timeout value means ignore next mouse click if it arrives
218 before that timeout elapses (i.e. as part of the same sequence of
219 events resulting from clicking on a frame to select it). */
221 static unsigned long ignore_next_mouse_click_timeout;
223 /* Mouse movement.
225 Formerly, we used PointerMotionHintMask (in standard_event_mask)
226 so that we would have to call XQueryPointer after each MotionNotify
227 event to ask for another such event. However, this made mouse tracking
228 slow, and there was a bug that made it eventually stop.
230 Simply asking for MotionNotify all the time seems to work better.
232 In order to avoid asking for motion events and then throwing most
233 of them away or busy-polling the server for mouse positions, we ask
234 the server for pointer motion hints. This means that we get only
235 one event per group of mouse movements. "Groups" are delimited by
236 other kinds of events (focus changes and button clicks, for
237 example), or by XQueryPointer calls; when one of these happens, we
238 get another MotionNotify event the next time the mouse moves. This
239 is at least as efficient as getting motion events when mouse
240 tracking is on, and I suspect only negligibly worse when tracking
241 is off. */
243 /* Where the mouse was last time we reported a mouse event. */
245 static XRectangle last_mouse_glyph;
246 static FRAME_PTR last_mouse_glyph_frame;
247 static Lisp_Object last_mouse_press_frame;
249 /* The scroll bar in which the last X motion event occurred.
251 If the last X motion event occurred in a scroll bar, we set this so
252 XTmouse_position can know whether to report a scroll bar motion or
253 an ordinary motion.
255 If the last X motion event didn't occur in a scroll bar, we set
256 this to Qnil, to tell XTmouse_position to return an ordinary motion
257 event. */
259 static Lisp_Object last_mouse_scroll_bar;
261 /* This is a hack. We would really prefer that XTmouse_position would
262 return the time associated with the position it returns, but there
263 doesn't seem to be any way to wrest the time-stamp from the server
264 along with the position query. So, we just keep track of the time
265 of the last movement we received, and return that in hopes that
266 it's somewhat accurate. */
268 static Time last_mouse_movement_time;
270 /* Time for last user interaction as returned in X events. */
272 static Time last_user_time;
274 /* Incremented by XTread_socket whenever it really tries to read
275 events. */
277 #ifdef __STDC__
278 static int volatile input_signal_count;
279 #else
280 static int input_signal_count;
281 #endif
283 /* Used locally within XTread_socket. */
285 static int x_noop_count;
287 /* The keysyms to use for the various modifiers. */
289 Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
290 Lisp_Object Vx_keysym_table;
291 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
293 static Lisp_Object Qvendor_specific_keysyms;
294 static Lisp_Object Qlatin_1;
296 #ifdef USE_GTK
297 /* The name of the Emacs icon file. */
298 static Lisp_Object xg_default_icon_file;
300 /* Used in gtkutil.c. */
301 Lisp_Object Qx_gtk_map_stock;
302 #endif
304 /* Some functions take this as char *, not const char *. */
305 static char emacs_class[] = EMACS_CLASS;
307 /* Used in x_flush. */
309 extern XrmDatabase x_load_resources (Display *, const char *, const char *,
310 const char *);
311 extern int x_bitmap_mask (FRAME_PTR, int);
313 static int x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
314 static void x_set_window_size_1 (struct frame *, int, int, int);
315 static const XColor *x_color_cells (Display *, int *);
316 static void x_update_window_end (struct window *, int, int);
318 static int x_io_error_quitter (Display *);
319 static struct terminal *x_create_terminal (struct x_display_info *);
320 void x_delete_terminal (struct terminal *);
321 static void x_update_end (struct frame *);
322 static void XTframe_up_to_date (struct frame *);
323 static void XTset_terminal_modes (struct terminal *);
324 static void XTreset_terminal_modes (struct terminal *);
325 static void x_clear_frame (struct frame *);
326 static void frame_highlight (struct frame *);
327 static void frame_unhighlight (struct frame *);
328 static void x_new_focus_frame (struct x_display_info *, struct frame *);
329 static void x_focus_changed (int, int, struct x_display_info *,
330 struct frame *, struct input_event *);
331 static void x_detect_focus_change (struct x_display_info *,
332 XEvent *, struct input_event *);
333 static void XTframe_rehighlight (struct frame *);
334 static void x_frame_rehighlight (struct x_display_info *);
335 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
336 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
337 enum text_cursor_kinds);
339 static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
340 static void x_flush (struct frame *f);
341 static void x_update_begin (struct frame *);
342 static void x_update_window_begin (struct window *);
343 static void x_after_update_window_line (struct glyph_row *);
344 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
345 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
346 enum scroll_bar_part *,
347 Lisp_Object *, Lisp_Object *,
348 unsigned long *);
349 static void x_handle_net_wm_state (struct frame *, XPropertyEvent *);
350 static void x_check_fullscreen (struct frame *);
351 static void x_check_expected_move (struct frame *, int, int);
352 static void x_sync_with_move (struct frame *, int, int, int);
353 static int handle_one_xevent (struct x_display_info *, XEvent *,
354 int *, struct input_event *);
355 /* Don't declare this NO_RETURN because we want no
356 interference with debugging failing X calls. */
357 static SIGTYPE x_connection_closed (Display *, const char *);
360 /* Flush display of frame F, or of all frames if F is null. */
362 static void
363 x_flush (struct frame *f)
365 /* Don't call XFlush when it is not safe to redisplay; the X
366 connection may be broken. */
367 if (!NILP (Vinhibit_redisplay))
368 return;
370 BLOCK_INPUT;
371 if (f == NULL)
373 Lisp_Object rest, frame;
374 FOR_EACH_FRAME (rest, frame)
375 if (FRAME_X_P (XFRAME (frame)))
376 x_flush (XFRAME (frame));
378 else if (FRAME_X_P (f))
379 XFlush (FRAME_X_DISPLAY (f));
380 UNBLOCK_INPUT;
384 /* Remove calls to XFlush by defining XFlush to an empty replacement.
385 Calls to XFlush should be unnecessary because the X output buffer
386 is flushed automatically as needed by calls to XPending,
387 XNextEvent, or XWindowEvent according to the XFlush man page.
388 XTread_socket calls XPending. Removing XFlush improves
389 performance. */
391 #define XFlush(DISPLAY) (void) 0
394 /***********************************************************************
395 Debugging
396 ***********************************************************************/
398 #if 0
400 /* This is a function useful for recording debugging information about
401 the sequence of occurrences in this file. */
403 struct record
405 char *locus;
406 int type;
409 struct record event_record[100];
411 int event_record_index;
413 record_event (locus, type)
414 char *locus;
415 int type;
417 if (event_record_index == sizeof (event_record) / sizeof (struct record))
418 event_record_index = 0;
420 event_record[event_record_index].locus = locus;
421 event_record[event_record_index].type = type;
422 event_record_index++;
425 #endif /* 0 */
429 /* Return the struct x_display_info corresponding to DPY. */
431 struct x_display_info *
432 x_display_info_for_display (Display *dpy)
434 struct x_display_info *dpyinfo;
436 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
437 if (dpyinfo->display == dpy)
438 return dpyinfo;
440 return 0;
443 #define OPAQUE 0xffffffff
444 #define OPACITY "_NET_WM_WINDOW_OPACITY"
446 void
447 x_set_frame_alpha (struct frame *f)
449 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
450 Display *dpy = FRAME_X_DISPLAY (f);
451 Window win = FRAME_OUTER_WINDOW (f);
452 double alpha = 1.0;
453 double alpha_min = 1.0;
454 unsigned long opac;
456 if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
457 /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
458 we must treat the former instead of the latter. */
459 win = FRAME_X_OUTPUT (f)->parent_desc;
461 if (dpyinfo->x_highlight_frame == f)
462 alpha = f->alpha[0];
463 else
464 alpha = f->alpha[1];
466 if (FLOATP (Vframe_alpha_lower_limit))
467 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
468 else if (INTEGERP (Vframe_alpha_lower_limit))
469 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
471 if (alpha < 0.0)
472 return;
473 else if (alpha > 1.0)
474 alpha = 1.0;
475 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
476 alpha = alpha_min;
478 opac = alpha * OPAQUE;
480 /* return unless necessary */
482 unsigned char *data;
483 Atom actual;
484 int rc, format;
485 unsigned long n, left;
487 x_catch_errors (dpy);
488 rc = XGetWindowProperty (dpy, win, XInternAtom(dpy, OPACITY, False),
489 0L, 1L, False, XA_CARDINAL,
490 &actual, &format, &n, &left,
491 &data);
493 if (rc == Success && actual != None)
494 if (*(unsigned long *)data == opac)
496 XFree ((void *) data);
497 x_uncatch_errors ();
498 return;
500 else
501 XFree ((void *) data);
502 x_uncatch_errors ();
505 x_catch_errors (dpy);
506 XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
507 XA_CARDINAL, 32, PropModeReplace,
508 (unsigned char *) &opac, 1L);
509 x_uncatch_errors ();
513 x_display_pixel_height (struct x_display_info *dpyinfo)
515 return HeightOfScreen (dpyinfo->screen);
519 x_display_pixel_width (struct x_display_info *dpyinfo)
521 return WidthOfScreen (dpyinfo->screen);
525 /***********************************************************************
526 Starting and ending an update
527 ***********************************************************************/
529 /* Start an update of frame F. This function is installed as a hook
530 for update_begin, i.e. it is called when update_begin is called.
531 This function is called prior to calls to x_update_window_begin for
532 each window being updated. Currently, there is nothing to do here
533 because all interesting stuff is done on a window basis. */
535 static void
536 x_update_begin (struct frame *f)
538 /* Nothing to do. */
542 /* Start update of window W. Set the global variable updated_window
543 to the window being updated and set output_cursor to the cursor
544 position of W. */
546 static void
547 x_update_window_begin (struct window *w)
549 struct frame *f = XFRAME (WINDOW_FRAME (w));
550 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
552 updated_window = w;
553 set_output_cursor (&w->cursor);
555 BLOCK_INPUT;
557 if (f == display_info->mouse_face_mouse_frame)
559 /* Don't do highlighting for mouse motion during the update. */
560 display_info->mouse_face_defer = 1;
562 /* If F needs to be redrawn, simply forget about any prior mouse
563 highlighting. */
564 if (FRAME_GARBAGED_P (f))
565 display_info->mouse_face_window = Qnil;
568 UNBLOCK_INPUT;
572 /* Draw a vertical window border from (x,y0) to (x,y1) */
574 static void
575 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
577 struct frame *f = XFRAME (WINDOW_FRAME (w));
578 struct face *face;
580 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
581 if (face)
582 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
583 face->foreground);
585 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
586 f->output_data.x->normal_gc, x, y0, x, y1);
589 /* End update of window W (which is equal to updated_window).
591 Draw vertical borders between horizontally adjacent windows, and
592 display W's cursor if CURSOR_ON_P is non-zero.
594 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
595 glyphs in mouse-face were overwritten. In that case we have to
596 make sure that the mouse-highlight is properly redrawn.
598 W may be a menu bar pseudo-window in case we don't have X toolkit
599 support. Such windows don't have a cursor, so don't display it
600 here. */
602 static void
603 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
605 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
607 if (!w->pseudo_window_p)
609 BLOCK_INPUT;
611 if (cursor_on_p)
612 display_and_set_cursor (w, 1, output_cursor.hpos,
613 output_cursor.vpos,
614 output_cursor.x, output_cursor.y);
616 if (draw_window_fringes (w, 1))
617 x_draw_vertical_border (w);
619 UNBLOCK_INPUT;
622 /* If a row with mouse-face was overwritten, arrange for
623 XTframe_up_to_date to redisplay the mouse highlight. */
624 if (mouse_face_overwritten_p)
626 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
627 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
628 dpyinfo->mouse_face_window = Qnil;
631 updated_window = NULL;
635 /* End update of frame F. This function is installed as a hook in
636 update_end. */
638 static void
639 x_update_end (struct frame *f)
641 /* Mouse highlight may be displayed again. */
642 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
644 #ifndef XFlush
645 BLOCK_INPUT;
646 XFlush (FRAME_X_DISPLAY (f));
647 UNBLOCK_INPUT;
648 #endif
652 /* This function is called from various places in xdisp.c whenever a
653 complete update has been performed. The global variable
654 updated_window is not available here. */
656 static void
657 XTframe_up_to_date (struct frame *f)
659 if (FRAME_X_P (f))
661 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
663 if (dpyinfo->mouse_face_deferred_gc
664 || f == dpyinfo->mouse_face_mouse_frame)
666 BLOCK_INPUT;
667 if (dpyinfo->mouse_face_mouse_frame)
668 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
669 dpyinfo->mouse_face_mouse_x,
670 dpyinfo->mouse_face_mouse_y);
671 dpyinfo->mouse_face_deferred_gc = 0;
672 UNBLOCK_INPUT;
678 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
679 arrow bitmaps, or clear the fringes if no bitmaps are required
680 before DESIRED_ROW is made current. The window being updated is
681 found in updated_window. This function It is called from
682 update_window_line only if it is known that there are differences
683 between bitmaps to be drawn between current row and DESIRED_ROW. */
685 static void
686 x_after_update_window_line (struct glyph_row *desired_row)
688 struct window *w = updated_window;
689 struct frame *f;
690 int width, height;
692 xassert (w);
694 if (!desired_row->mode_line_p && !w->pseudo_window_p)
695 desired_row->redraw_fringe_bitmaps_p = 1;
697 /* When a window has disappeared, make sure that no rest of
698 full-width rows stays visible in the internal border. Could
699 check here if updated_window is the leftmost/rightmost window,
700 but I guess it's not worth doing since vertically split windows
701 are almost never used, internal border is rarely set, and the
702 overhead is very small. */
703 if (windows_or_buffers_changed
704 && desired_row->full_width_p
705 && (f = XFRAME (w->frame),
706 width = FRAME_INTERNAL_BORDER_WIDTH (f),
707 width != 0)
708 && (height = desired_row->visible_height,
709 height > 0))
711 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
713 BLOCK_INPUT;
714 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
715 0, y, width, height, False);
716 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
717 FRAME_PIXEL_WIDTH (f) - width,
718 y, width, height, False);
719 UNBLOCK_INPUT;
723 static void
724 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
726 struct frame *f = XFRAME (WINDOW_FRAME (w));
727 Display *display = FRAME_X_DISPLAY (f);
728 Window window = FRAME_X_WINDOW (f);
729 GC gc = f->output_data.x->normal_gc;
730 struct face *face = p->face;
732 /* Must clip because of partially visible lines. */
733 x_clip_to_row (w, row, -1, gc);
735 if (!p->overlay_p)
737 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
739 /* In case the same realized face is used for fringes and
740 for something displayed in the text (e.g. face `region' on
741 mono-displays, the fill style may have been changed to
742 FillSolid in x_draw_glyph_string_background. */
743 if (face->stipple)
744 XSetFillStyle (display, face->gc, FillOpaqueStippled);
745 else
746 XSetForeground (display, face->gc, face->background);
748 #ifdef USE_TOOLKIT_SCROLL_BARS
749 /* If the fringe is adjacent to the left (right) scroll bar of a
750 leftmost (rightmost, respectively) window, then extend its
751 background to the gap between the fringe and the bar. */
752 if ((WINDOW_LEFTMOST_P (w)
753 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
754 || (WINDOW_RIGHTMOST_P (w)
755 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
757 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
759 if (sb_width > 0)
761 int left = WINDOW_SCROLL_BAR_AREA_X (w);
762 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
763 * FRAME_COLUMN_WIDTH (f));
765 if (bx < 0)
767 /* Bitmap fills the fringe. */
768 if (left + width == p->x)
769 bx = left + sb_width;
770 else if (p->x + p->wd == left)
771 bx = left;
772 if (bx >= 0)
774 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
776 nx = width - sb_width;
777 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
778 row->y));
779 ny = row->visible_height;
782 else
784 if (left + width == bx)
786 bx = left + sb_width;
787 nx += width - sb_width;
789 else if (bx + nx == left)
790 nx += width - sb_width;
794 #endif
795 if (bx >= 0 && nx > 0)
796 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
798 if (!face->stipple)
799 XSetForeground (display, face->gc, face->foreground);
802 if (p->which)
804 unsigned char *bits;
805 Pixmap pixmap, clipmask = (Pixmap) 0;
806 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
807 XGCValues gcv;
809 if (p->wd > 8)
810 bits = (unsigned char *)(p->bits + p->dh);
811 else
812 bits = (unsigned char *)p->bits + p->dh;
814 /* Draw the bitmap. I believe these small pixmaps can be cached
815 by the server. */
816 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
817 (p->cursor_p
818 ? (p->overlay_p ? face->background
819 : f->output_data.x->cursor_pixel)
820 : face->foreground),
821 face->background, depth);
823 if (p->overlay_p)
825 clipmask = XCreatePixmapFromBitmapData (display,
826 FRAME_X_DISPLAY_INFO (f)->root_window,
827 bits, p->wd, p->h,
828 1, 0, 1);
829 gcv.clip_mask = clipmask;
830 gcv.clip_x_origin = p->x;
831 gcv.clip_y_origin = p->y;
832 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
835 XCopyArea (display, pixmap, window, gc, 0, 0,
836 p->wd, p->h, p->x, p->y);
837 XFreePixmap (display, pixmap);
839 if (p->overlay_p)
841 gcv.clip_mask = (Pixmap) 0;
842 XChangeGC (display, gc, GCClipMask, &gcv);
843 XFreePixmap (display, clipmask);
847 XSetClipMask (display, gc, None);
852 /* This is called when starting Emacs and when restarting after
853 suspend. When starting Emacs, no X window is mapped. And nothing
854 must be done to Emacs's own window if it is suspended (though that
855 rarely happens). */
857 static void
858 XTset_terminal_modes (struct terminal *terminal)
862 /* This is called when exiting or suspending Emacs. Exiting will make
863 the X-windows go away, and suspending requires no action. */
865 static void
866 XTreset_terminal_modes (struct terminal *terminal)
871 /***********************************************************************
872 Glyph display
873 ***********************************************************************/
877 static void x_set_glyph_string_clipping (struct glyph_string *);
878 static void x_set_glyph_string_gc (struct glyph_string *);
879 static void x_draw_glyph_string_background (struct glyph_string *,
880 int);
881 static void x_draw_glyph_string_foreground (struct glyph_string *);
882 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
883 static void x_draw_glyph_string_box (struct glyph_string *);
884 static void x_draw_glyph_string (struct glyph_string *);
885 static void x_compute_glyph_string_overhangs (struct glyph_string *);
886 static void x_set_cursor_gc (struct glyph_string *);
887 static void x_set_mode_line_face_gc (struct glyph_string *);
888 static void x_set_mouse_face_gc (struct glyph_string *);
889 static int x_alloc_lighter_color (struct frame *, Display *, Colormap,
890 unsigned long *, double, int);
891 static void x_setup_relief_color (struct frame *, struct relief *,
892 double, int, unsigned long);
893 static void x_setup_relief_colors (struct glyph_string *);
894 static void x_draw_image_glyph_string (struct glyph_string *);
895 static void x_draw_image_relief (struct glyph_string *);
896 static void x_draw_image_foreground (struct glyph_string *);
897 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
898 static void x_clear_glyph_string_rect (struct glyph_string *, int,
899 int, int, int);
900 static void x_draw_relief_rect (struct frame *, int, int, int, int,
901 int, int, int, int, int, int,
902 XRectangle *);
903 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
904 int, int, int, XRectangle *);
906 #if GLYPH_DEBUG
907 static void x_check_font (struct frame *, struct font *);
908 #endif
911 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
912 face. */
914 static void
915 x_set_cursor_gc (struct glyph_string *s)
917 if (s->font == FRAME_FONT (s->f)
918 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
919 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
920 && !s->cmp)
921 s->gc = s->f->output_data.x->cursor_gc;
922 else
924 /* Cursor on non-default face: must merge. */
925 XGCValues xgcv;
926 unsigned long mask;
928 xgcv.background = s->f->output_data.x->cursor_pixel;
929 xgcv.foreground = s->face->background;
931 /* If the glyph would be invisible, try a different foreground. */
932 if (xgcv.foreground == xgcv.background)
933 xgcv.foreground = s->face->foreground;
934 if (xgcv.foreground == xgcv.background)
935 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
936 if (xgcv.foreground == xgcv.background)
937 xgcv.foreground = s->face->foreground;
939 /* Make sure the cursor is distinct from text in this face. */
940 if (xgcv.background == s->face->background
941 && xgcv.foreground == s->face->foreground)
943 xgcv.background = s->face->foreground;
944 xgcv.foreground = s->face->background;
947 IF_DEBUG (x_check_font (s->f, s->font));
948 xgcv.graphics_exposures = False;
949 mask = GCForeground | GCBackground | GCGraphicsExposures;
951 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
952 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
953 mask, &xgcv);
954 else
955 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
956 = XCreateGC (s->display, s->window, mask, &xgcv);
958 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
963 /* Set up S->gc of glyph string S for drawing text in mouse face. */
965 static void
966 x_set_mouse_face_gc (struct glyph_string *s)
968 int face_id;
969 struct face *face;
971 /* What face has to be used last for the mouse face? */
972 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
973 face = FACE_FROM_ID (s->f, face_id);
974 if (face == NULL)
975 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
977 if (s->first_glyph->type == CHAR_GLYPH)
978 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
979 else
980 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
981 s->face = FACE_FROM_ID (s->f, face_id);
982 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
984 if (s->font == s->face->font)
985 s->gc = s->face->gc;
986 else
988 /* Otherwise construct scratch_cursor_gc with values from FACE
989 except for FONT. */
990 XGCValues xgcv;
991 unsigned long mask;
993 xgcv.background = s->face->background;
994 xgcv.foreground = s->face->foreground;
995 xgcv.graphics_exposures = False;
996 mask = GCForeground | GCBackground | GCGraphicsExposures;
998 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
999 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1000 mask, &xgcv);
1001 else
1002 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1003 = XCreateGC (s->display, s->window, mask, &xgcv);
1005 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1008 xassert (s->gc != 0);
1012 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1013 Faces to use in the mode line have already been computed when the
1014 matrix was built, so there isn't much to do, here. */
1016 static INLINE void
1017 x_set_mode_line_face_gc (struct glyph_string *s)
1019 s->gc = s->face->gc;
1023 /* Set S->gc of glyph string S for drawing that glyph string. Set
1024 S->stippled_p to a non-zero value if the face of S has a stipple
1025 pattern. */
1027 static INLINE void
1028 x_set_glyph_string_gc (struct glyph_string *s)
1030 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1032 if (s->hl == DRAW_NORMAL_TEXT)
1034 s->gc = s->face->gc;
1035 s->stippled_p = s->face->stipple != 0;
1037 else if (s->hl == DRAW_INVERSE_VIDEO)
1039 x_set_mode_line_face_gc (s);
1040 s->stippled_p = s->face->stipple != 0;
1042 else if (s->hl == DRAW_CURSOR)
1044 x_set_cursor_gc (s);
1045 s->stippled_p = 0;
1047 else if (s->hl == DRAW_MOUSE_FACE)
1049 x_set_mouse_face_gc (s);
1050 s->stippled_p = s->face->stipple != 0;
1052 else if (s->hl == DRAW_IMAGE_RAISED
1053 || s->hl == DRAW_IMAGE_SUNKEN)
1055 s->gc = s->face->gc;
1056 s->stippled_p = s->face->stipple != 0;
1058 else
1060 s->gc = s->face->gc;
1061 s->stippled_p = s->face->stipple != 0;
1064 /* GC must have been set. */
1065 xassert (s->gc != 0);
1069 /* Set clipping for output of glyph string S. S may be part of a mode
1070 line or menu if we don't have X toolkit support. */
1072 static INLINE void
1073 x_set_glyph_string_clipping (struct glyph_string *s)
1075 XRectangle *r = s->clip;
1076 int n = get_glyph_string_clip_rects (s, r, 2);
1078 if (n > 0)
1079 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1080 s->num_clips = n;
1084 /* Set SRC's clipping for output of glyph string DST. This is called
1085 when we are drawing DST's left_overhang or right_overhang only in
1086 the area of SRC. */
1088 static void
1089 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1091 XRectangle r;
1093 r.x = src->x;
1094 r.width = src->width;
1095 r.y = src->y;
1096 r.height = src->height;
1097 dst->clip[0] = r;
1098 dst->num_clips = 1;
1099 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1103 /* RIF:
1104 Compute left and right overhang of glyph string S. */
1106 static void
1107 x_compute_glyph_string_overhangs (struct glyph_string *s)
1109 if (s->cmp == NULL
1110 && (s->first_glyph->type == CHAR_GLYPH
1111 || s->first_glyph->type == COMPOSITE_GLYPH))
1113 struct font_metrics metrics;
1115 if (s->first_glyph->type == CHAR_GLYPH)
1117 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1118 struct font *font = s->font;
1119 int i;
1121 for (i = 0; i < s->nchars; i++)
1122 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1123 font->driver->text_extents (font, code, s->nchars, &metrics);
1125 else
1127 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1129 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1131 s->right_overhang = (metrics.rbearing > metrics.width
1132 ? metrics.rbearing - metrics.width : 0);
1133 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1135 else if (s->cmp)
1137 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1138 s->left_overhang = - s->cmp->lbearing;
1143 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1145 static INLINE void
1146 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1148 XGCValues xgcv;
1149 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1150 XSetForeground (s->display, s->gc, xgcv.background);
1151 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1152 XSetForeground (s->display, s->gc, xgcv.foreground);
1156 /* Draw the background of glyph_string S. If S->background_filled_p
1157 is non-zero don't draw it. FORCE_P non-zero means draw the
1158 background even if it wouldn't be drawn normally. This is used
1159 when a string preceding S draws into the background of S, or S
1160 contains the first component of a composition. */
1162 static void
1163 x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1165 /* Nothing to do if background has already been drawn or if it
1166 shouldn't be drawn in the first place. */
1167 if (!s->background_filled_p)
1169 int box_line_width = max (s->face->box_line_width, 0);
1171 if (s->stippled_p)
1173 /* Fill background with a stipple pattern. */
1174 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1175 XFillRectangle (s->display, s->window, s->gc, s->x,
1176 s->y + box_line_width,
1177 s->background_width,
1178 s->height - 2 * box_line_width);
1179 XSetFillStyle (s->display, s->gc, FillSolid);
1180 s->background_filled_p = 1;
1182 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1183 || s->font_not_found_p
1184 || s->extends_to_end_of_line_p
1185 || force_p)
1187 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1188 s->background_width,
1189 s->height - 2 * box_line_width);
1190 s->background_filled_p = 1;
1196 /* Draw the foreground of glyph string S. */
1198 static void
1199 x_draw_glyph_string_foreground (struct glyph_string *s)
1201 int i, x;
1203 /* If first glyph of S has a left box line, start drawing the text
1204 of S to the right of that box line. */
1205 if (s->face->box != FACE_NO_BOX
1206 && s->first_glyph->left_box_line_p)
1207 x = s->x + eabs (s->face->box_line_width);
1208 else
1209 x = s->x;
1211 /* Draw characters of S as rectangles if S's font could not be
1212 loaded. */
1213 if (s->font_not_found_p)
1215 for (i = 0; i < s->nchars; ++i)
1217 struct glyph *g = s->first_glyph + i;
1218 XDrawRectangle (s->display, s->window,
1219 s->gc, x, s->y, g->pixel_width - 1,
1220 s->height - 1);
1221 x += g->pixel_width;
1224 else
1226 struct font *font = s->font;
1227 int boff = font->baseline_offset;
1228 int y;
1230 if (font->vertical_centering)
1231 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1233 y = s->ybase - boff;
1234 if (s->for_overlaps
1235 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1236 font->driver->draw (s, 0, s->nchars, x, y, 0);
1237 else
1238 font->driver->draw (s, 0, s->nchars, x, y, 1);
1239 if (s->face->overstrike)
1240 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1244 /* Draw the foreground of composite glyph string S. */
1246 static void
1247 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1249 int i, j, x;
1250 struct font *font = s->font;
1252 /* If first glyph of S has a left box line, start drawing the text
1253 of S to the right of that box line. */
1254 if (s->face && s->face->box != FACE_NO_BOX
1255 && s->first_glyph->left_box_line_p)
1256 x = s->x + eabs (s->face->box_line_width);
1257 else
1258 x = s->x;
1260 /* S is a glyph string for a composition. S->cmp_from is the index
1261 of the first character drawn for glyphs of this composition.
1262 S->cmp_from == 0 means we are drawing the very first character of
1263 this composition. */
1265 /* Draw a rectangle for the composition if the font for the very
1266 first character of the composition could not be loaded. */
1267 if (s->font_not_found_p)
1269 if (s->cmp_from == 0)
1270 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1271 s->width - 1, s->height - 1);
1273 else if (! s->first_glyph->u.cmp.automatic)
1275 int y = s->ybase;
1277 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1278 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1280 int xx = x + s->cmp->offsets[j * 2];
1281 int yy = y - s->cmp->offsets[j * 2 + 1];
1283 font->driver->draw (s, j, j + 1, xx, yy, 0);
1284 if (s->face->overstrike)
1285 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1288 else
1290 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1291 Lisp_Object glyph;
1292 int y = s->ybase;
1293 int width = 0;
1295 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1297 glyph = LGSTRING_GLYPH (gstring, i);
1298 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1299 width += LGLYPH_WIDTH (glyph);
1300 else
1302 int xoff, yoff, wadjust;
1304 if (j < i)
1306 font->driver->draw (s, j, i, x, y, 0);
1307 if (s->face->overstrike)
1308 font->driver->draw (s, j, i, x + 1, y, 0);
1309 x += width;
1311 xoff = LGLYPH_XOFF (glyph);
1312 yoff = LGLYPH_YOFF (glyph);
1313 wadjust = LGLYPH_WADJUST (glyph);
1314 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1315 if (s->face->overstrike)
1316 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1317 x += wadjust;
1318 j = i + 1;
1319 width = 0;
1322 if (j < i)
1324 font->driver->draw (s, j, i, x, y, 0);
1325 if (s->face->overstrike)
1326 font->driver->draw (s, j, i, x + 1, y, 0);
1332 #ifdef USE_X_TOOLKIT
1334 static struct frame *x_frame_of_widget (Widget);
1335 static Boolean cvt_string_to_pixel (Display *, XrmValue *, Cardinal *,
1336 XrmValue *, XrmValue *, XtPointer *);
1337 static void cvt_pixel_dtor (XtAppContext, XrmValue *, XtPointer,
1338 XrmValue *, Cardinal *);
1341 /* Return the frame on which widget WIDGET is used.. Abort if frame
1342 cannot be determined. */
1344 static struct frame *
1345 x_frame_of_widget (Widget widget)
1347 struct x_display_info *dpyinfo;
1348 Lisp_Object tail;
1349 struct frame *f;
1351 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1353 /* Find the top-level shell of the widget. Note that this function
1354 can be called when the widget is not yet realized, so XtWindow
1355 (widget) == 0. That's the reason we can't simply use
1356 x_any_window_to_frame. */
1357 while (!XtIsTopLevelShell (widget))
1358 widget = XtParent (widget);
1360 /* Look for a frame with that top-level widget. Allocate the color
1361 on that frame to get the right gamma correction value. */
1362 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1363 if (FRAMEP (XCAR (tail))
1364 && (f = XFRAME (XCAR (tail)),
1365 (FRAME_X_P (f)
1366 && f->output_data.nothing != 1
1367 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1368 && f->output_data.x->widget == widget)
1369 return f;
1371 abort ();
1375 /* Allocate the color COLOR->pixel on the screen and display of
1376 widget WIDGET in colormap CMAP. If an exact match cannot be
1377 allocated, try the nearest color available. Value is non-zero
1378 if successful. This is called from lwlib. */
1381 x_alloc_nearest_color_for_widget (Widget widget, Colormap cmap, XColor *color)
1383 struct frame *f = x_frame_of_widget (widget);
1384 return x_alloc_nearest_color (f, cmap, color);
1388 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1389 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1390 If this produces the same color as PIXEL, try a color where all RGB
1391 values have DELTA added. Return the allocated color in *PIXEL.
1392 DISPLAY is the X display, CMAP is the colormap to operate on.
1393 Value is non-zero if successful. */
1396 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1397 unsigned long *pixel, double factor, int delta)
1399 struct frame *f = x_frame_of_widget (widget);
1400 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1404 /* Structure specifying which arguments should be passed by Xt to
1405 cvt_string_to_pixel. We want the widget's screen and colormap. */
1407 static XtConvertArgRec cvt_string_to_pixel_args[] =
1409 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1410 sizeof (Screen *)},
1411 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1412 sizeof (Colormap)}
1416 /* The address of this variable is returned by
1417 cvt_string_to_pixel. */
1419 static Pixel cvt_string_to_pixel_value;
1422 /* Convert a color name to a pixel color.
1424 DPY is the display we are working on.
1426 ARGS is an array of *NARGS XrmValue structures holding additional
1427 information about the widget for which the conversion takes place.
1428 The contents of this array are determined by the specification
1429 in cvt_string_to_pixel_args.
1431 FROM is a pointer to an XrmValue which points to the color name to
1432 convert. TO is an XrmValue in which to return the pixel color.
1434 CLOSURE_RET is a pointer to user-data, in which we record if
1435 we allocated the color or not.
1437 Value is True if successful, False otherwise. */
1439 static Boolean
1440 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1441 XrmValue *from, XrmValue *to,
1442 XtPointer *closure_ret)
1444 Screen *screen;
1445 Colormap cmap;
1446 Pixel pixel;
1447 String color_name;
1448 XColor color;
1450 if (*nargs != 2)
1452 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1453 "wrongParameters", "cvt_string_to_pixel",
1454 "XtToolkitError",
1455 "Screen and colormap args required", NULL, NULL);
1456 return False;
1459 screen = *(Screen **) args[0].addr;
1460 cmap = *(Colormap *) args[1].addr;
1461 color_name = (String) from->addr;
1463 if (strcmp (color_name, XtDefaultBackground) == 0)
1465 *closure_ret = (XtPointer) False;
1466 pixel = WhitePixelOfScreen (screen);
1468 else if (strcmp (color_name, XtDefaultForeground) == 0)
1470 *closure_ret = (XtPointer) False;
1471 pixel = BlackPixelOfScreen (screen);
1473 else if (XParseColor (dpy, cmap, color_name, &color)
1474 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1476 pixel = color.pixel;
1477 *closure_ret = (XtPointer) True;
1479 else
1481 String params[1];
1482 Cardinal nparams = 1;
1484 params[0] = color_name;
1485 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1486 "badValue", "cvt_string_to_pixel",
1487 "XtToolkitError", "Invalid color `%s'",
1488 params, &nparams);
1489 return False;
1492 if (to->addr != NULL)
1494 if (to->size < sizeof (Pixel))
1496 to->size = sizeof (Pixel);
1497 return False;
1500 *(Pixel *) to->addr = pixel;
1502 else
1504 cvt_string_to_pixel_value = pixel;
1505 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1508 to->size = sizeof (Pixel);
1509 return True;
1513 /* Free a pixel color which was previously allocated via
1514 cvt_string_to_pixel. This is registered as the destructor
1515 for this type of resource via XtSetTypeConverter.
1517 APP is the application context in which we work.
1519 TO is a pointer to an XrmValue holding the color to free.
1520 CLOSURE is the value we stored in CLOSURE_RET for this color
1521 in cvt_string_to_pixel.
1523 ARGS and NARGS are like for cvt_string_to_pixel. */
1525 static void
1526 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1527 Cardinal *nargs)
1529 if (*nargs != 2)
1531 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1532 "XtToolkitError",
1533 "Screen and colormap arguments required",
1534 NULL, NULL);
1536 else if (closure != NULL)
1538 /* We did allocate the pixel, so free it. */
1539 Screen *screen = *(Screen **) args[0].addr;
1540 Colormap cmap = *(Colormap *) args[1].addr;
1541 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1542 (Pixel *) to->addr, 1);
1547 #endif /* USE_X_TOOLKIT */
1550 /* Value is an array of XColor structures for the contents of the
1551 color map of display DPY. Set *NCELLS to the size of the array.
1552 Note that this probably shouldn't be called for large color maps,
1553 say a 24-bit TrueColor map. */
1555 static const XColor *
1556 x_color_cells (Display *dpy, int *ncells)
1558 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1560 if (dpyinfo->color_cells == NULL)
1562 Screen *screen = dpyinfo->screen;
1563 int i;
1565 dpyinfo->ncolor_cells
1566 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1567 dpyinfo->color_cells
1568 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1569 * sizeof *dpyinfo->color_cells);
1571 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1572 dpyinfo->color_cells[i].pixel = i;
1574 XQueryColors (dpy, dpyinfo->cmap,
1575 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1578 *ncells = dpyinfo->ncolor_cells;
1579 return dpyinfo->color_cells;
1583 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1584 colors in COLORS. Use cached information, if available. */
1586 void
1587 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1589 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1591 if (dpyinfo->color_cells)
1593 int i;
1594 for (i = 0; i < ncolors; ++i)
1596 unsigned long pixel = colors[i].pixel;
1597 xassert (pixel < dpyinfo->ncolor_cells);
1598 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1599 colors[i] = dpyinfo->color_cells[pixel];
1602 else
1603 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1607 /* On frame F, translate pixel color to RGB values for the color in
1608 COLOR. Use cached information, if available. */
1610 void
1611 x_query_color (struct frame *f, XColor *color)
1613 x_query_colors (f, color, 1);
1617 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1618 exact match can't be allocated, try the nearest color available.
1619 Value is non-zero if successful. Set *COLOR to the color
1620 allocated. */
1622 static int
1623 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1625 int rc;
1627 rc = XAllocColor (dpy, cmap, color);
1628 if (rc == 0)
1630 /* If we got to this point, the colormap is full, so we're going
1631 to try to get the next closest color. The algorithm used is
1632 a least-squares matching, which is what X uses for closest
1633 color matching with StaticColor visuals. */
1634 int nearest, i;
1635 unsigned long nearest_delta = ~0;
1636 int ncells;
1637 const XColor *cells = x_color_cells (dpy, &ncells);
1639 for (nearest = i = 0; i < ncells; ++i)
1641 long dred = (color->red >> 8) - (cells[i].red >> 8);
1642 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1643 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1644 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1646 if (delta < nearest_delta)
1648 nearest = i;
1649 nearest_delta = delta;
1653 color->red = cells[nearest].red;
1654 color->green = cells[nearest].green;
1655 color->blue = cells[nearest].blue;
1656 rc = XAllocColor (dpy, cmap, color);
1658 else
1660 /* If allocation succeeded, and the allocated pixel color is not
1661 equal to a cached pixel color recorded earlier, there was a
1662 change in the colormap, so clear the color cache. */
1663 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1664 XColor *cached_color;
1666 if (dpyinfo->color_cells
1667 && (cached_color = &dpyinfo->color_cells[color->pixel],
1668 (cached_color->red != color->red
1669 || cached_color->blue != color->blue
1670 || cached_color->green != color->green)))
1672 xfree (dpyinfo->color_cells);
1673 dpyinfo->color_cells = NULL;
1674 dpyinfo->ncolor_cells = 0;
1678 #ifdef DEBUG_X_COLORS
1679 if (rc)
1680 register_color (color->pixel);
1681 #endif /* DEBUG_X_COLORS */
1683 return rc;
1687 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1688 exact match can't be allocated, try the nearest color available.
1689 Value is non-zero if successful. Set *COLOR to the color
1690 allocated. */
1693 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1695 gamma_correct (f, color);
1696 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1700 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1701 It's necessary to do this instead of just using PIXEL directly to
1702 get color reference counts right. */
1704 unsigned long
1705 x_copy_color (struct frame *f, long unsigned int pixel)
1707 XColor color;
1709 color.pixel = pixel;
1710 BLOCK_INPUT;
1711 x_query_color (f, &color);
1712 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1713 UNBLOCK_INPUT;
1714 #ifdef DEBUG_X_COLORS
1715 register_color (pixel);
1716 #endif
1717 return color.pixel;
1721 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1722 It's necessary to do this instead of just using PIXEL directly to
1723 get color reference counts right. */
1725 unsigned long
1726 x_copy_dpy_color (Display *dpy, Colormap cmap, long unsigned int pixel)
1728 XColor color;
1730 color.pixel = pixel;
1731 BLOCK_INPUT;
1732 XQueryColor (dpy, cmap, &color);
1733 XAllocColor (dpy, cmap, &color);
1734 UNBLOCK_INPUT;
1735 #ifdef DEBUG_X_COLORS
1736 register_color (pixel);
1737 #endif
1738 return color.pixel;
1742 /* Brightness beyond which a color won't have its highlight brightness
1743 boosted.
1745 Nominally, highlight colors for `3d' faces are calculated by
1746 brightening an object's color by a constant scale factor, but this
1747 doesn't yield good results for dark colors, so for colors who's
1748 brightness is less than this value (on a scale of 0-65535) have an
1749 use an additional additive factor.
1751 The value here is set so that the default menu-bar/mode-line color
1752 (grey75) will not have its highlights changed at all. */
1753 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1756 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1757 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1758 If this produces the same color as PIXEL, try a color where all RGB
1759 values have DELTA added. Return the allocated color in *PIXEL.
1760 DISPLAY is the X display, CMAP is the colormap to operate on.
1761 Value is non-zero if successful. */
1763 static int
1764 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1766 XColor color, new;
1767 long bright;
1768 int success_p;
1770 /* Get RGB color values. */
1771 color.pixel = *pixel;
1772 x_query_color (f, &color);
1774 /* Change RGB values by specified FACTOR. Avoid overflow! */
1775 xassert (factor >= 0);
1776 new.red = min (0xffff, factor * color.red);
1777 new.green = min (0xffff, factor * color.green);
1778 new.blue = min (0xffff, factor * color.blue);
1780 /* Calculate brightness of COLOR. */
1781 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1783 /* We only boost colors that are darker than
1784 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1785 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1786 /* Make an additive adjustment to NEW, because it's dark enough so
1787 that scaling by FACTOR alone isn't enough. */
1789 /* How far below the limit this color is (0 - 1, 1 being darker). */
1790 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1791 /* The additive adjustment. */
1792 int min_delta = delta * dimness * factor / 2;
1794 if (factor < 1)
1796 new.red = max (0, new.red - min_delta);
1797 new.green = max (0, new.green - min_delta);
1798 new.blue = max (0, new.blue - min_delta);
1800 else
1802 new.red = min (0xffff, min_delta + new.red);
1803 new.green = min (0xffff, min_delta + new.green);
1804 new.blue = min (0xffff, min_delta + new.blue);
1808 /* Try to allocate the color. */
1809 success_p = x_alloc_nearest_color (f, cmap, &new);
1810 if (success_p)
1812 if (new.pixel == *pixel)
1814 /* If we end up with the same color as before, try adding
1815 delta to the RGB values. */
1816 x_free_colors (f, &new.pixel, 1);
1818 new.red = min (0xffff, delta + color.red);
1819 new.green = min (0xffff, delta + color.green);
1820 new.blue = min (0xffff, delta + color.blue);
1821 success_p = x_alloc_nearest_color (f, cmap, &new);
1823 else
1824 success_p = 1;
1825 *pixel = new.pixel;
1828 return success_p;
1832 /* Set up the foreground color for drawing relief lines of glyph
1833 string S. RELIEF is a pointer to a struct relief containing the GC
1834 with which lines will be drawn. Use a color that is FACTOR or
1835 DELTA lighter or darker than the relief's background which is found
1836 in S->f->output_data.x->relief_background. If such a color cannot
1837 be allocated, use DEFAULT_PIXEL, instead. */
1839 static void
1840 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1842 XGCValues xgcv;
1843 struct x_output *di = f->output_data.x;
1844 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1845 unsigned long pixel;
1846 unsigned long background = di->relief_background;
1847 Colormap cmap = FRAME_X_COLORMAP (f);
1848 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1849 Display *dpy = FRAME_X_DISPLAY (f);
1851 xgcv.graphics_exposures = False;
1852 xgcv.line_width = 1;
1854 /* Free previously allocated color. The color cell will be reused
1855 when it has been freed as many times as it was allocated, so this
1856 doesn't affect faces using the same colors. */
1857 if (relief->gc
1858 && relief->allocated_p)
1860 x_free_colors (f, &relief->pixel, 1);
1861 relief->allocated_p = 0;
1864 /* Allocate new color. */
1865 xgcv.foreground = default_pixel;
1866 pixel = background;
1867 if (dpyinfo->n_planes != 1
1868 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1870 relief->allocated_p = 1;
1871 xgcv.foreground = relief->pixel = pixel;
1874 if (relief->gc == 0)
1876 xgcv.stipple = dpyinfo->gray;
1877 mask |= GCStipple;
1878 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1880 else
1881 XChangeGC (dpy, relief->gc, mask, &xgcv);
1885 /* Set up colors for the relief lines around glyph string S. */
1887 static void
1888 x_setup_relief_colors (struct glyph_string *s)
1890 struct x_output *di = s->f->output_data.x;
1891 unsigned long color;
1893 if (s->face->use_box_color_for_shadows_p)
1894 color = s->face->box_color;
1895 else if (s->first_glyph->type == IMAGE_GLYPH
1896 && s->img->pixmap
1897 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1898 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1899 else
1901 XGCValues xgcv;
1903 /* Get the background color of the face. */
1904 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1905 color = xgcv.background;
1908 if (di->white_relief.gc == 0
1909 || color != di->relief_background)
1911 di->relief_background = color;
1912 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1913 WHITE_PIX_DEFAULT (s->f));
1914 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1915 BLACK_PIX_DEFAULT (s->f));
1920 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
1921 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
1922 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
1923 relief. LEFT_P non-zero means draw a relief on the left side of
1924 the rectangle. RIGHT_P non-zero means draw a relief on the right
1925 side of the rectangle. CLIP_RECT is the clipping rectangle to use
1926 when drawing. */
1928 static void
1929 x_draw_relief_rect (struct frame *f,
1930 int left_x, int top_y, int right_x, int bottom_y, int width,
1931 int raised_p, int top_p, int bot_p, int left_p, int right_p,
1932 XRectangle *clip_rect)
1934 Display *dpy = FRAME_X_DISPLAY (f);
1935 Window window = FRAME_X_WINDOW (f);
1936 int i;
1937 GC gc;
1939 if (raised_p)
1940 gc = f->output_data.x->white_relief.gc;
1941 else
1942 gc = f->output_data.x->black_relief.gc;
1943 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
1945 /* Top. */
1946 if (top_p)
1947 for (i = 0; i < width; ++i)
1948 XDrawLine (dpy, window, gc,
1949 left_x + i * left_p, top_y + i,
1950 right_x + 1 - i * right_p, top_y + i);
1952 /* Left. */
1953 if (left_p)
1954 for (i = 0; i < width; ++i)
1955 XDrawLine (dpy, window, gc,
1956 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
1958 XSetClipMask (dpy, gc, None);
1959 if (raised_p)
1960 gc = f->output_data.x->black_relief.gc;
1961 else
1962 gc = f->output_data.x->white_relief.gc;
1963 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
1965 /* Bottom. */
1966 if (bot_p)
1967 for (i = 0; i < width; ++i)
1968 XDrawLine (dpy, window, gc,
1969 left_x + i * left_p, bottom_y - i,
1970 right_x + 1 - i * right_p, bottom_y - i);
1972 /* Right. */
1973 if (right_p)
1974 for (i = 0; i < width; ++i)
1975 XDrawLine (dpy, window, gc,
1976 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
1978 XSetClipMask (dpy, gc, None);
1982 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
1983 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
1984 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
1985 left side of the rectangle. RIGHT_P non-zero means draw a line
1986 on the right side of the rectangle. CLIP_RECT is the clipping
1987 rectangle to use when drawing. */
1989 static void
1990 x_draw_box_rect (struct glyph_string *s,
1991 int left_x, int top_y, int right_x, int bottom_y, int width,
1992 int left_p, int right_p, XRectangle *clip_rect)
1994 XGCValues xgcv;
1996 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
1997 XSetForeground (s->display, s->gc, s->face->box_color);
1998 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2000 /* Top. */
2001 XFillRectangle (s->display, s->window, s->gc,
2002 left_x, top_y, right_x - left_x + 1, width);
2004 /* Left. */
2005 if (left_p)
2006 XFillRectangle (s->display, s->window, s->gc,
2007 left_x, top_y, width, bottom_y - top_y + 1);
2009 /* Bottom. */
2010 XFillRectangle (s->display, s->window, s->gc,
2011 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2013 /* Right. */
2014 if (right_p)
2015 XFillRectangle (s->display, s->window, s->gc,
2016 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2018 XSetForeground (s->display, s->gc, xgcv.foreground);
2019 XSetClipMask (s->display, s->gc, None);
2023 /* Draw a box around glyph string S. */
2025 static void
2026 x_draw_glyph_string_box (struct glyph_string *s)
2028 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2029 int left_p, right_p;
2030 struct glyph *last_glyph;
2031 XRectangle clip_rect;
2033 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2034 ? WINDOW_RIGHT_EDGE_X (s->w)
2035 : window_box_right (s->w, s->area));
2037 /* The glyph that may have a right box line. */
2038 last_glyph = (s->cmp || s->img
2039 ? s->first_glyph
2040 : s->first_glyph + s->nchars - 1);
2042 width = eabs (s->face->box_line_width);
2043 raised_p = s->face->box == FACE_RAISED_BOX;
2044 left_x = s->x;
2045 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2046 ? last_x - 1
2047 : min (last_x, s->x + s->background_width) - 1);
2048 top_y = s->y;
2049 bottom_y = top_y + s->height - 1;
2051 left_p = (s->first_glyph->left_box_line_p
2052 || (s->hl == DRAW_MOUSE_FACE
2053 && (s->prev == NULL
2054 || s->prev->hl != s->hl)));
2055 right_p = (last_glyph->right_box_line_p
2056 || (s->hl == DRAW_MOUSE_FACE
2057 && (s->next == NULL
2058 || s->next->hl != s->hl)));
2060 get_glyph_string_clip_rect (s, &clip_rect);
2062 if (s->face->box == FACE_SIMPLE_BOX)
2063 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2064 left_p, right_p, &clip_rect);
2065 else
2067 x_setup_relief_colors (s);
2068 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2069 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2074 /* Draw foreground of image glyph string S. */
2076 static void
2077 x_draw_image_foreground (struct glyph_string *s)
2079 int x = s->x;
2080 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2082 /* If first glyph of S has a left box line, start drawing it to the
2083 right of that line. */
2084 if (s->face->box != FACE_NO_BOX
2085 && s->first_glyph->left_box_line_p
2086 && s->slice.x == 0)
2087 x += eabs (s->face->box_line_width);
2089 /* If there is a margin around the image, adjust x- and y-position
2090 by that margin. */
2091 if (s->slice.x == 0)
2092 x += s->img->hmargin;
2093 if (s->slice.y == 0)
2094 y += s->img->vmargin;
2096 if (s->img->pixmap)
2098 if (s->img->mask)
2100 /* We can't set both a clip mask and use XSetClipRectangles
2101 because the latter also sets a clip mask. We also can't
2102 trust on the shape extension to be available
2103 (XShapeCombineRegion). So, compute the rectangle to draw
2104 manually. */
2105 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2106 | GCFunction);
2107 XGCValues xgcv;
2108 XRectangle clip_rect, image_rect, r;
2110 xgcv.clip_mask = s->img->mask;
2111 xgcv.clip_x_origin = x;
2112 xgcv.clip_y_origin = y;
2113 xgcv.function = GXcopy;
2114 XChangeGC (s->display, s->gc, mask, &xgcv);
2116 get_glyph_string_clip_rect (s, &clip_rect);
2117 image_rect.x = x;
2118 image_rect.y = y;
2119 image_rect.width = s->slice.width;
2120 image_rect.height = s->slice.height;
2121 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2122 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2123 s->slice.x + r.x - x, s->slice.y + r.y - y,
2124 r.width, r.height, r.x, r.y);
2126 else
2128 XRectangle clip_rect, image_rect, r;
2130 get_glyph_string_clip_rect (s, &clip_rect);
2131 image_rect.x = x;
2132 image_rect.y = y;
2133 image_rect.width = s->slice.width;
2134 image_rect.height = s->slice.height;
2135 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2136 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2137 s->slice.x + r.x - x, s->slice.y + r.y - y,
2138 r.width, r.height, r.x, r.y);
2140 /* When the image has a mask, we can expect that at
2141 least part of a mouse highlight or a block cursor will
2142 be visible. If the image doesn't have a mask, make
2143 a block cursor visible by drawing a rectangle around
2144 the image. I believe it's looking better if we do
2145 nothing here for mouse-face. */
2146 if (s->hl == DRAW_CURSOR)
2148 int r = s->img->relief;
2149 if (r < 0) r = -r;
2150 XDrawRectangle (s->display, s->window, s->gc,
2151 x - r, y - r,
2152 s->slice.width + r*2 - 1,
2153 s->slice.height + r*2 - 1);
2157 else
2158 /* Draw a rectangle if image could not be loaded. */
2159 XDrawRectangle (s->display, s->window, s->gc, x, y,
2160 s->slice.width - 1, s->slice.height - 1);
2164 /* Draw a relief around the image glyph string S. */
2166 static void
2167 x_draw_image_relief (struct glyph_string *s)
2169 int x0, y0, x1, y1, thick, raised_p, extra;
2170 XRectangle r;
2171 int x = s->x;
2172 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2174 /* If first glyph of S has a left box line, start drawing it to the
2175 right of that line. */
2176 if (s->face->box != FACE_NO_BOX
2177 && s->first_glyph->left_box_line_p
2178 && s->slice.x == 0)
2179 x += eabs (s->face->box_line_width);
2181 /* If there is a margin around the image, adjust x- and y-position
2182 by that margin. */
2183 if (s->slice.x == 0)
2184 x += s->img->hmargin;
2185 if (s->slice.y == 0)
2186 y += s->img->vmargin;
2188 if (s->hl == DRAW_IMAGE_SUNKEN
2189 || s->hl == DRAW_IMAGE_RAISED)
2191 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2192 raised_p = s->hl == DRAW_IMAGE_RAISED;
2194 else
2196 thick = eabs (s->img->relief);
2197 raised_p = s->img->relief > 0;
2200 extra = s->face->id == TOOL_BAR_FACE_ID
2201 ? XINT (Vtool_bar_button_margin) : 0;
2203 x0 = x - thick - extra;
2204 y0 = y - thick - extra;
2205 x1 = x + s->slice.width + thick - 1 + extra;
2206 y1 = y + s->slice.height + thick - 1 + extra;
2208 x_setup_relief_colors (s);
2209 get_glyph_string_clip_rect (s, &r);
2210 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2211 s->slice.y == 0,
2212 s->slice.y + s->slice.height == s->img->height,
2213 s->slice.x == 0,
2214 s->slice.x + s->slice.width == s->img->width,
2215 &r);
2219 /* Draw the foreground of image glyph string S to PIXMAP. */
2221 static void
2222 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2224 int x = 0;
2225 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2227 /* If first glyph of S has a left box line, start drawing it to the
2228 right of that line. */
2229 if (s->face->box != FACE_NO_BOX
2230 && s->first_glyph->left_box_line_p
2231 && s->slice.x == 0)
2232 x += eabs (s->face->box_line_width);
2234 /* If there is a margin around the image, adjust x- and y-position
2235 by that margin. */
2236 if (s->slice.x == 0)
2237 x += s->img->hmargin;
2238 if (s->slice.y == 0)
2239 y += s->img->vmargin;
2241 if (s->img->pixmap)
2243 if (s->img->mask)
2245 /* We can't set both a clip mask and use XSetClipRectangles
2246 because the latter also sets a clip mask. We also can't
2247 trust on the shape extension to be available
2248 (XShapeCombineRegion). So, compute the rectangle to draw
2249 manually. */
2250 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2251 | GCFunction);
2252 XGCValues xgcv;
2254 xgcv.clip_mask = s->img->mask;
2255 xgcv.clip_x_origin = x - s->slice.x;
2256 xgcv.clip_y_origin = y - s->slice.y;
2257 xgcv.function = GXcopy;
2258 XChangeGC (s->display, s->gc, mask, &xgcv);
2260 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2261 s->slice.x, s->slice.y,
2262 s->slice.width, s->slice.height, x, y);
2263 XSetClipMask (s->display, s->gc, None);
2265 else
2267 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2268 s->slice.x, s->slice.y,
2269 s->slice.width, s->slice.height, x, y);
2271 /* When the image has a mask, we can expect that at
2272 least part of a mouse highlight or a block cursor will
2273 be visible. If the image doesn't have a mask, make
2274 a block cursor visible by drawing a rectangle around
2275 the image. I believe it's looking better if we do
2276 nothing here for mouse-face. */
2277 if (s->hl == DRAW_CURSOR)
2279 int r = s->img->relief;
2280 if (r < 0) r = -r;
2281 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2282 s->slice.width + r*2 - 1,
2283 s->slice.height + r*2 - 1);
2287 else
2288 /* Draw a rectangle if image could not be loaded. */
2289 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2290 s->slice.width - 1, s->slice.height - 1);
2294 /* Draw part of the background of glyph string S. X, Y, W, and H
2295 give the rectangle to draw. */
2297 static void
2298 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2300 if (s->stippled_p)
2302 /* Fill background with a stipple pattern. */
2303 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2304 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2305 XSetFillStyle (s->display, s->gc, FillSolid);
2307 else
2308 x_clear_glyph_string_rect (s, x, y, w, h);
2312 /* Draw image glyph string S.
2314 s->y
2315 s->x +-------------------------
2316 | s->face->box
2318 | +-------------------------
2319 | | s->img->margin
2321 | | +-------------------
2322 | | | the image
2326 static void
2327 x_draw_image_glyph_string (struct glyph_string *s)
2329 int box_line_hwidth = eabs (s->face->box_line_width);
2330 int box_line_vwidth = max (s->face->box_line_width, 0);
2331 int height;
2332 Pixmap pixmap = None;
2334 height = s->height;
2335 if (s->slice.y == 0)
2336 height -= box_line_vwidth;
2337 if (s->slice.y + s->slice.height >= s->img->height)
2338 height -= box_line_vwidth;
2340 /* Fill background with face under the image. Do it only if row is
2341 taller than image or if image has a clip mask to reduce
2342 flickering. */
2343 s->stippled_p = s->face->stipple != 0;
2344 if (height > s->slice.height
2345 || s->img->hmargin
2346 || s->img->vmargin
2347 || s->img->mask
2348 || s->img->pixmap == 0
2349 || s->width != s->background_width)
2351 if (s->img->mask)
2353 /* Create a pixmap as large as the glyph string. Fill it
2354 with the background color. Copy the image to it, using
2355 its mask. Copy the temporary pixmap to the display. */
2356 Screen *screen = FRAME_X_SCREEN (s->f);
2357 int depth = DefaultDepthOfScreen (screen);
2359 /* Create a pixmap as large as the glyph string. */
2360 pixmap = XCreatePixmap (s->display, s->window,
2361 s->background_width,
2362 s->height, depth);
2364 /* Don't clip in the following because we're working on the
2365 pixmap. */
2366 XSetClipMask (s->display, s->gc, None);
2368 /* Fill the pixmap with the background color/stipple. */
2369 if (s->stippled_p)
2371 /* Fill background with a stipple pattern. */
2372 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2373 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2374 XFillRectangle (s->display, pixmap, s->gc,
2375 0, 0, s->background_width, s->height);
2376 XSetFillStyle (s->display, s->gc, FillSolid);
2377 XSetTSOrigin (s->display, s->gc, 0, 0);
2379 else
2381 XGCValues xgcv;
2382 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2383 &xgcv);
2384 XSetForeground (s->display, s->gc, xgcv.background);
2385 XFillRectangle (s->display, pixmap, s->gc,
2386 0, 0, s->background_width, s->height);
2387 XSetForeground (s->display, s->gc, xgcv.foreground);
2390 else
2392 int x = s->x;
2393 int y = s->y;
2395 if (s->first_glyph->left_box_line_p
2396 && s->slice.x == 0)
2397 x += box_line_hwidth;
2399 if (s->slice.y == 0)
2400 y += box_line_vwidth;
2402 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2405 s->background_filled_p = 1;
2408 /* Draw the foreground. */
2409 if (pixmap != None)
2411 x_draw_image_foreground_1 (s, pixmap);
2412 x_set_glyph_string_clipping (s);
2413 XCopyArea (s->display, pixmap, s->window, s->gc,
2414 0, 0, s->background_width, s->height, s->x, s->y);
2415 XFreePixmap (s->display, pixmap);
2417 else
2418 x_draw_image_foreground (s);
2420 /* If we must draw a relief around the image, do it. */
2421 if (s->img->relief
2422 || s->hl == DRAW_IMAGE_RAISED
2423 || s->hl == DRAW_IMAGE_SUNKEN)
2424 x_draw_image_relief (s);
2428 /* Draw stretch glyph string S. */
2430 static void
2431 x_draw_stretch_glyph_string (struct glyph_string *s)
2433 xassert (s->first_glyph->type == STRETCH_GLYPH);
2435 if (s->hl == DRAW_CURSOR
2436 && !x_stretch_cursor_p)
2438 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2439 as wide as the stretch glyph. */
2440 int width, background_width = s->background_width;
2441 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2443 if (x < left_x)
2445 background_width -= left_x - x;
2446 x = left_x;
2448 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2450 /* Draw cursor. */
2451 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2453 /* Clear rest using the GC of the original non-cursor face. */
2454 if (width < background_width)
2456 int y = s->y;
2457 int w = background_width - width, h = s->height;
2458 XRectangle r;
2459 GC gc;
2461 x += width;
2462 if (s->row->mouse_face_p
2463 && cursor_in_mouse_face_p (s->w))
2465 x_set_mouse_face_gc (s);
2466 gc = s->gc;
2468 else
2469 gc = s->face->gc;
2471 get_glyph_string_clip_rect (s, &r);
2472 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2474 if (s->face->stipple)
2476 /* Fill background with a stipple pattern. */
2477 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2478 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2479 XSetFillStyle (s->display, gc, FillSolid);
2481 else
2483 XGCValues xgcv;
2484 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2485 XSetForeground (s->display, gc, xgcv.background);
2486 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2487 XSetForeground (s->display, gc, xgcv.foreground);
2491 else if (!s->background_filled_p)
2493 int background_width = s->background_width;
2494 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2496 /* Don't draw into left margin, fringe or scrollbar area
2497 except for header line and mode line. */
2498 if (x < left_x && !s->row->mode_line_p)
2500 background_width -= left_x - x;
2501 x = left_x;
2503 if (background_width > 0)
2504 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2507 s->background_filled_p = 1;
2511 /* Draw glyph string S. */
2513 static void
2514 x_draw_glyph_string (struct glyph_string *s)
2516 int relief_drawn_p = 0;
2518 /* If S draws into the background of its successors, draw the
2519 background of the successors first so that S can draw into it.
2520 This makes S->next use XDrawString instead of XDrawImageString. */
2521 if (s->next && s->right_overhang && !s->for_overlaps)
2523 int width;
2524 struct glyph_string *next;
2526 for (width = 0, next = s->next;
2527 next && width < s->right_overhang;
2528 width += next->width, next = next->next)
2529 if (next->first_glyph->type != IMAGE_GLYPH)
2531 x_set_glyph_string_gc (next);
2532 x_set_glyph_string_clipping (next);
2533 if (next->first_glyph->type == STRETCH_GLYPH)
2534 x_draw_stretch_glyph_string (next);
2535 else
2536 x_draw_glyph_string_background (next, 1);
2537 next->num_clips = 0;
2541 /* Set up S->gc, set clipping and draw S. */
2542 x_set_glyph_string_gc (s);
2544 /* Draw relief (if any) in advance for char/composition so that the
2545 glyph string can be drawn over it. */
2546 if (!s->for_overlaps
2547 && s->face->box != FACE_NO_BOX
2548 && (s->first_glyph->type == CHAR_GLYPH
2549 || s->first_glyph->type == COMPOSITE_GLYPH))
2552 x_set_glyph_string_clipping (s);
2553 x_draw_glyph_string_background (s, 1);
2554 x_draw_glyph_string_box (s);
2555 x_set_glyph_string_clipping (s);
2556 relief_drawn_p = 1;
2558 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2559 && !s->clip_tail
2560 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2561 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2562 /* We must clip just this glyph. left_overhang part has already
2563 drawn when s->prev was drawn, and right_overhang part will be
2564 drawn later when s->next is drawn. */
2565 x_set_glyph_string_clipping_exactly (s, s);
2566 else
2567 x_set_glyph_string_clipping (s);
2569 switch (s->first_glyph->type)
2571 case IMAGE_GLYPH:
2572 x_draw_image_glyph_string (s);
2573 break;
2575 case STRETCH_GLYPH:
2576 x_draw_stretch_glyph_string (s);
2577 break;
2579 case CHAR_GLYPH:
2580 if (s->for_overlaps)
2581 s->background_filled_p = 1;
2582 else
2583 x_draw_glyph_string_background (s, 0);
2584 x_draw_glyph_string_foreground (s);
2585 break;
2587 case COMPOSITE_GLYPH:
2588 if (s->for_overlaps || (s->cmp_from > 0
2589 && ! s->first_glyph->u.cmp.automatic))
2590 s->background_filled_p = 1;
2591 else
2592 x_draw_glyph_string_background (s, 1);
2593 x_draw_composite_glyph_string_foreground (s);
2594 break;
2596 default:
2597 abort ();
2600 if (!s->for_overlaps)
2602 /* Draw underline. */
2603 if (s->face->underline_p)
2605 unsigned long thickness, position;
2606 int y;
2608 if (s->prev && s->prev->face->underline_p)
2610 /* We use the same underline style as the previous one. */
2611 thickness = s->prev->underline_thickness;
2612 position = s->prev->underline_position;
2614 else
2616 /* Get the underline thickness. Default is 1 pixel. */
2617 if (s->font && s->font->underline_thickness > 0)
2618 thickness = s->font->underline_thickness;
2619 else
2620 thickness = 1;
2621 if (x_underline_at_descent_line)
2622 position = (s->height - thickness) - (s->ybase - s->y);
2623 else
2625 /* Get the underline position. This is the recommended
2626 vertical offset in pixels from the baseline to the top of
2627 the underline. This is a signed value according to the
2628 specs, and its default is
2630 ROUND ((maximum descent) / 2), with
2631 ROUND(x) = floor (x + 0.5) */
2633 if (x_use_underline_position_properties
2634 && s->font && s->font->underline_position >= 0)
2635 position = s->font->underline_position;
2636 else if (s->font)
2637 position = (s->font->descent + 1) / 2;
2638 else
2639 position = underline_minimum_offset;
2641 position = max (position, underline_minimum_offset);
2643 /* Check the sanity of thickness and position. We should
2644 avoid drawing underline out of the current line area. */
2645 if (s->y + s->height <= s->ybase + position)
2646 position = (s->height - 1) - (s->ybase - s->y);
2647 if (s->y + s->height < s->ybase + position + thickness)
2648 thickness = (s->y + s->height) - (s->ybase + position);
2649 s->underline_thickness = thickness;
2650 s->underline_position = position;
2651 y = s->ybase + position;
2652 if (s->face->underline_defaulted_p)
2653 XFillRectangle (s->display, s->window, s->gc,
2654 s->x, y, s->width, thickness);
2655 else
2657 XGCValues xgcv;
2658 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2659 XSetForeground (s->display, s->gc, s->face->underline_color);
2660 XFillRectangle (s->display, s->window, s->gc,
2661 s->x, y, s->width, thickness);
2662 XSetForeground (s->display, s->gc, xgcv.foreground);
2666 /* Draw overline. */
2667 if (s->face->overline_p)
2669 unsigned long dy = 0, h = 1;
2671 if (s->face->overline_color_defaulted_p)
2672 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2673 s->width, h);
2674 else
2676 XGCValues xgcv;
2677 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2678 XSetForeground (s->display, s->gc, s->face->overline_color);
2679 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2680 s->width, h);
2681 XSetForeground (s->display, s->gc, xgcv.foreground);
2685 /* Draw strike-through. */
2686 if (s->face->strike_through_p)
2688 unsigned long h = 1;
2689 unsigned long dy = (s->height - h) / 2;
2691 if (s->face->strike_through_color_defaulted_p)
2692 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2693 s->width, h);
2694 else
2696 XGCValues xgcv;
2697 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2698 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2699 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2700 s->width, h);
2701 XSetForeground (s->display, s->gc, xgcv.foreground);
2705 /* Draw relief if not yet drawn. */
2706 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2707 x_draw_glyph_string_box (s);
2709 if (s->prev)
2711 struct glyph_string *prev;
2713 for (prev = s->prev; prev; prev = prev->prev)
2714 if (prev->hl != s->hl
2715 && prev->x + prev->width + prev->right_overhang > s->x)
2717 /* As prev was drawn while clipped to its own area, we
2718 must draw the right_overhang part using s->hl now. */
2719 enum draw_glyphs_face save = prev->hl;
2721 prev->hl = s->hl;
2722 x_set_glyph_string_gc (prev);
2723 x_set_glyph_string_clipping_exactly (s, prev);
2724 if (prev->first_glyph->type == CHAR_GLYPH)
2725 x_draw_glyph_string_foreground (prev);
2726 else
2727 x_draw_composite_glyph_string_foreground (prev);
2728 XSetClipMask (prev->display, prev->gc, None);
2729 prev->hl = save;
2730 prev->num_clips = 0;
2734 if (s->next)
2736 struct glyph_string *next;
2738 for (next = s->next; next; next = next->next)
2739 if (next->hl != s->hl
2740 && next->x - next->left_overhang < s->x + s->width)
2742 /* As next will be drawn while clipped to its own area,
2743 we must draw the left_overhang part using s->hl now. */
2744 enum draw_glyphs_face save = next->hl;
2746 next->hl = s->hl;
2747 x_set_glyph_string_gc (next);
2748 x_set_glyph_string_clipping_exactly (s, next);
2749 if (next->first_glyph->type == CHAR_GLYPH)
2750 x_draw_glyph_string_foreground (next);
2751 else
2752 x_draw_composite_glyph_string_foreground (next);
2753 XSetClipMask (next->display, next->gc, None);
2754 next->hl = save;
2755 next->num_clips = 0;
2760 /* Reset clipping. */
2761 XSetClipMask (s->display, s->gc, None);
2762 s->num_clips = 0;
2765 /* Shift display to make room for inserted glyphs. */
2767 void
2768 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2770 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2771 f->output_data.x->normal_gc,
2772 x, y, width, height,
2773 x + shift_by, y);
2776 /* Delete N glyphs at the nominal cursor position. Not implemented
2777 for X frames. */
2779 static void
2780 x_delete_glyphs (struct frame *f, register int n)
2782 abort ();
2786 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2787 If they are <= 0, this is probably an error. */
2789 void
2790 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
2792 xassert (width > 0 && height > 0);
2793 XClearArea (dpy, window, x, y, width, height, exposures);
2797 /* Clear an entire frame. */
2799 static void
2800 x_clear_frame (struct frame *f)
2802 /* Clearing the frame will erase any cursor, so mark them all as no
2803 longer visible. */
2804 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2805 output_cursor.hpos = output_cursor.vpos = 0;
2806 output_cursor.x = -1;
2808 /* We don't set the output cursor here because there will always
2809 follow an explicit cursor_to. */
2810 BLOCK_INPUT;
2811 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2813 /* We have to clear the scroll bars, too. If we have changed
2814 colors or something like that, then they should be notified. */
2815 x_scroll_bar_clear (f);
2817 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
2818 /* Make sure scroll bars are redrawn. As they aren't redrawn by
2819 redisplay, do it here. */
2820 if (FRAME_GTK_WIDGET (f))
2821 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
2822 #endif
2824 XFlush (FRAME_X_DISPLAY (f));
2826 UNBLOCK_INPUT;
2831 /* Invert the middle quarter of the frame for .15 sec. */
2833 /* We use the select system call to do the waiting, so we have to make
2834 sure it's available. If it isn't, we just won't do visual bells. */
2836 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2839 /* Subtract the `struct timeval' values X and Y, storing the result in
2840 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2842 static int
2843 timeval_subtract (struct timeval *result, struct timeval x, struct timeval y)
2845 /* Perform the carry for the later subtraction by updating y. This
2846 is safer because on some systems the tv_sec member is unsigned. */
2847 if (x.tv_usec < y.tv_usec)
2849 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2850 y.tv_usec -= 1000000 * nsec;
2851 y.tv_sec += nsec;
2854 if (x.tv_usec - y.tv_usec > 1000000)
2856 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2857 y.tv_usec += 1000000 * nsec;
2858 y.tv_sec -= nsec;
2861 /* Compute the time remaining to wait. tv_usec is certainly
2862 positive. */
2863 result->tv_sec = x.tv_sec - y.tv_sec;
2864 result->tv_usec = x.tv_usec - y.tv_usec;
2866 /* Return indication of whether the result should be considered
2867 negative. */
2868 return x.tv_sec < y.tv_sec;
2871 void
2872 XTflash (struct frame *f)
2874 BLOCK_INPUT;
2877 #ifdef USE_GTK
2878 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
2879 when the scroll bars and the edit widget share the same X window. */
2880 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
2881 GdkGCValues vals;
2882 GdkGC *gc;
2883 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
2884 ^ FRAME_BACKGROUND_PIXEL (f));
2885 vals.function = GDK_XOR;
2886 gc = gdk_gc_new_with_values (window,
2887 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
2888 #define XFillRectangle(d, win, gc, x, y, w, h) \
2889 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
2890 #else
2891 GC gc;
2893 /* Create a GC that will use the GXxor function to flip foreground
2894 pixels into background pixels. */
2896 XGCValues values;
2898 values.function = GXxor;
2899 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
2900 ^ FRAME_BACKGROUND_PIXEL (f));
2902 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2903 GCFunction | GCForeground, &values);
2905 #endif
2907 /* Get the height not including a menu bar widget. */
2908 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
2909 /* Height of each line to flash. */
2910 int flash_height = FRAME_LINE_HEIGHT (f);
2911 /* These will be the left and right margins of the rectangles. */
2912 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
2913 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
2915 int width;
2917 /* Don't flash the area between a scroll bar and the frame
2918 edge it is next to. */
2919 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
2921 case vertical_scroll_bar_left:
2922 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
2923 break;
2925 case vertical_scroll_bar_right:
2926 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
2927 break;
2929 default:
2930 break;
2933 width = flash_right - flash_left;
2935 /* If window is tall, flash top and bottom line. */
2936 if (height > 3 * FRAME_LINE_HEIGHT (f))
2938 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2939 flash_left,
2940 (FRAME_INTERNAL_BORDER_WIDTH (f)
2941 + FRAME_TOP_MARGIN_HEIGHT (f)),
2942 width, flash_height);
2943 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2944 flash_left,
2945 (height - flash_height
2946 - FRAME_INTERNAL_BORDER_WIDTH (f)),
2947 width, flash_height);
2950 else
2951 /* If it is short, flash it all. */
2952 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2953 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
2954 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
2956 x_flush (f);
2959 struct timeval wakeup;
2961 EMACS_GET_TIME (wakeup);
2963 /* Compute time to wait until, propagating carry from usecs. */
2964 wakeup.tv_usec += 150000;
2965 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
2966 wakeup.tv_usec %= 1000000;
2968 /* Keep waiting until past the time wakeup or any input gets
2969 available. */
2970 while (! detect_input_pending ())
2972 struct timeval current;
2973 struct timeval timeout;
2975 EMACS_GET_TIME (current);
2977 /* Break if result would be negative. */
2978 if (timeval_subtract (&current, wakeup, current))
2979 break;
2981 /* How long `select' should wait. */
2982 timeout.tv_sec = 0;
2983 timeout.tv_usec = 10000;
2985 /* Try to wait that long--but we might wake up sooner. */
2986 select (0, NULL, NULL, NULL, &timeout);
2990 /* If window is tall, flash top and bottom line. */
2991 if (height > 3 * FRAME_LINE_HEIGHT (f))
2993 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2994 flash_left,
2995 (FRAME_INTERNAL_BORDER_WIDTH (f)
2996 + FRAME_TOP_MARGIN_HEIGHT (f)),
2997 width, flash_height);
2998 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2999 flash_left,
3000 (height - flash_height
3001 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3002 width, flash_height);
3004 else
3005 /* If it is short, flash it all. */
3006 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3007 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3008 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3010 #ifdef USE_GTK
3011 g_object_unref (G_OBJECT (gc));
3012 #undef XFillRectangle
3013 #else
3014 XFreeGC (FRAME_X_DISPLAY (f), gc);
3015 #endif
3016 x_flush (f);
3020 UNBLOCK_INPUT;
3023 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3026 static void
3027 XTtoggle_invisible_pointer (FRAME_PTR f, int invisible)
3029 BLOCK_INPUT;
3030 if (invisible)
3032 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3033 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3034 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3036 else
3037 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3038 f->output_data.x->current_cursor);
3039 f->pointer_invisible = invisible;
3040 UNBLOCK_INPUT;
3044 /* Make audible bell. */
3046 void
3047 XTring_bell (struct frame *f)
3049 if (FRAME_X_DISPLAY (f))
3051 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3052 if (visible_bell)
3053 XTflash (f);
3054 else
3055 #endif
3057 BLOCK_INPUT;
3058 XBell (FRAME_X_DISPLAY (f), 0);
3059 XFlush (FRAME_X_DISPLAY (f));
3060 UNBLOCK_INPUT;
3066 /* Specify how many text lines, from the top of the window,
3067 should be affected by insert-lines and delete-lines operations.
3068 This, and those operations, are used only within an update
3069 that is bounded by calls to x_update_begin and x_update_end. */
3071 static void
3072 XTset_terminal_window (struct frame *f, int n)
3074 /* This function intentionally left blank. */
3079 /***********************************************************************
3080 Line Dance
3081 ***********************************************************************/
3083 /* Perform an insert-lines or delete-lines operation, inserting N
3084 lines or deleting -N lines at vertical position VPOS. */
3086 static void
3087 x_ins_del_lines (struct frame *f, int vpos, int n)
3089 abort ();
3093 /* Scroll part of the display as described by RUN. */
3095 static void
3096 x_scroll_run (struct window *w, struct run *run)
3098 struct frame *f = XFRAME (w->frame);
3099 int x, y, width, height, from_y, to_y, bottom_y;
3101 /* Get frame-relative bounding box of the text display area of W,
3102 without mode lines. Include in this box the left and right
3103 fringe of W. */
3104 window_box (w, -1, &x, &y, &width, &height);
3106 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3107 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3108 bottom_y = y + height;
3110 if (to_y < from_y)
3112 /* Scrolling up. Make sure we don't copy part of the mode
3113 line at the bottom. */
3114 if (from_y + run->height > bottom_y)
3115 height = bottom_y - from_y;
3116 else
3117 height = run->height;
3119 else
3121 /* Scolling down. Make sure we don't copy over the mode line.
3122 at the bottom. */
3123 if (to_y + run->height > bottom_y)
3124 height = bottom_y - to_y;
3125 else
3126 height = run->height;
3129 BLOCK_INPUT;
3131 /* Cursor off. Will be switched on again in x_update_window_end. */
3132 updated_window = w;
3133 x_clear_cursor (w);
3135 XCopyArea (FRAME_X_DISPLAY (f),
3136 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3137 f->output_data.x->normal_gc,
3138 x, from_y,
3139 width, height,
3140 x, to_y);
3142 UNBLOCK_INPUT;
3147 /***********************************************************************
3148 Exposure Events
3149 ***********************************************************************/
3152 static void
3153 frame_highlight (struct frame *f)
3155 /* We used to only do this if Vx_no_window_manager was non-nil, but
3156 the ICCCM (section 4.1.6) says that the window's border pixmap
3157 and border pixel are window attributes which are "private to the
3158 client", so we can always change it to whatever we want. */
3159 BLOCK_INPUT;
3160 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3161 f->output_data.x->border_pixel);
3162 UNBLOCK_INPUT;
3163 x_update_cursor (f, 1);
3164 x_set_frame_alpha (f);
3167 static void
3168 frame_unhighlight (struct frame *f)
3170 /* We used to only do this if Vx_no_window_manager was non-nil, but
3171 the ICCCM (section 4.1.6) says that the window's border pixmap
3172 and border pixel are window attributes which are "private to the
3173 client", so we can always change it to whatever we want. */
3174 BLOCK_INPUT;
3175 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3176 f->output_data.x->border_tile);
3177 UNBLOCK_INPUT;
3178 x_update_cursor (f, 1);
3179 x_set_frame_alpha (f);
3182 /* The focus has changed. Update the frames as necessary to reflect
3183 the new situation. Note that we can't change the selected frame
3184 here, because the Lisp code we are interrupting might become confused.
3185 Each event gets marked with the frame in which it occurred, so the
3186 Lisp code can tell when the switch took place by examining the events. */
3188 static void
3189 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3191 struct frame *old_focus = dpyinfo->x_focus_frame;
3193 if (frame != dpyinfo->x_focus_frame)
3195 /* Set this before calling other routines, so that they see
3196 the correct value of x_focus_frame. */
3197 dpyinfo->x_focus_frame = frame;
3199 if (old_focus && old_focus->auto_lower)
3200 x_lower_frame (old_focus);
3202 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3203 pending_autoraise_frame = dpyinfo->x_focus_frame;
3204 else
3205 pending_autoraise_frame = 0;
3208 x_frame_rehighlight (dpyinfo);
3211 /* Handle FocusIn and FocusOut state changes for FRAME.
3212 If FRAME has focus and there exists more than one frame, puts
3213 a FOCUS_IN_EVENT into *BUFP. */
3215 static void
3216 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3218 if (type == FocusIn)
3220 if (dpyinfo->x_focus_event_frame != frame)
3222 x_new_focus_frame (dpyinfo, frame);
3223 dpyinfo->x_focus_event_frame = frame;
3225 /* Don't stop displaying the initial startup message
3226 for a switch-frame event we don't need. */
3227 if (NILP (Vterminal_frame)
3228 && CONSP (Vframe_list)
3229 && !NILP (XCDR (Vframe_list)))
3231 bufp->kind = FOCUS_IN_EVENT;
3232 XSETFRAME (bufp->frame_or_window, frame);
3236 frame->output_data.x->focus_state |= state;
3238 #ifdef HAVE_X_I18N
3239 if (FRAME_XIC (frame))
3240 XSetICFocus (FRAME_XIC (frame));
3241 #endif
3243 else if (type == FocusOut)
3245 frame->output_data.x->focus_state &= ~state;
3247 if (dpyinfo->x_focus_event_frame == frame)
3249 dpyinfo->x_focus_event_frame = 0;
3250 x_new_focus_frame (dpyinfo, 0);
3253 #ifdef HAVE_X_I18N
3254 if (FRAME_XIC (frame))
3255 XUnsetICFocus (FRAME_XIC (frame));
3256 #endif
3257 if (frame->pointer_invisible)
3258 XTtoggle_invisible_pointer (frame, 0);
3262 /* The focus may have changed. Figure out if it is a real focus change,
3263 by checking both FocusIn/Out and Enter/LeaveNotify events.
3265 Returns FOCUS_IN_EVENT event in *BUFP. */
3267 static void
3268 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3270 struct frame *frame;
3272 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3273 if (! frame)
3274 return;
3276 switch (event->type)
3278 case EnterNotify:
3279 case LeaveNotify:
3281 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3282 int focus_state
3283 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3285 if (event->xcrossing.detail != NotifyInferior
3286 && event->xcrossing.focus
3287 && ! (focus_state & FOCUS_EXPLICIT))
3288 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3289 FOCUS_IMPLICIT,
3290 dpyinfo, frame, bufp);
3292 break;
3294 case FocusIn:
3295 case FocusOut:
3296 x_focus_changed (event->type,
3297 (event->xfocus.detail == NotifyPointer ?
3298 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3299 dpyinfo, frame, bufp);
3300 break;
3302 case ClientMessage:
3303 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3305 enum xembed_message msg = event->xclient.data.l[1];
3306 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3307 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3309 break;
3314 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3316 void
3317 x_mouse_leave (struct x_display_info *dpyinfo)
3319 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3322 /* The focus has changed, or we have redirected a frame's focus to
3323 another frame (this happens when a frame uses a surrogate
3324 mini-buffer frame). Shift the highlight as appropriate.
3326 The FRAME argument doesn't necessarily have anything to do with which
3327 frame is being highlighted or un-highlighted; we only use it to find
3328 the appropriate X display info. */
3330 static void
3331 XTframe_rehighlight (struct frame *frame)
3333 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3336 static void
3337 x_frame_rehighlight (struct x_display_info *dpyinfo)
3339 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3341 if (dpyinfo->x_focus_frame)
3343 dpyinfo->x_highlight_frame
3344 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3345 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3346 : dpyinfo->x_focus_frame);
3347 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3349 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3350 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3353 else
3354 dpyinfo->x_highlight_frame = 0;
3356 if (dpyinfo->x_highlight_frame != old_highlight)
3358 if (old_highlight)
3359 frame_unhighlight (old_highlight);
3360 if (dpyinfo->x_highlight_frame)
3361 frame_highlight (dpyinfo->x_highlight_frame);
3367 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3369 /* Initialize mode_switch_bit and modifier_meaning. */
3370 static void
3371 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3373 int min_code, max_code;
3374 KeySym *syms;
3375 int syms_per_code;
3376 XModifierKeymap *mods;
3378 dpyinfo->meta_mod_mask = 0;
3379 dpyinfo->shift_lock_mask = 0;
3380 dpyinfo->alt_mod_mask = 0;
3381 dpyinfo->super_mod_mask = 0;
3382 dpyinfo->hyper_mod_mask = 0;
3384 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3386 syms = XGetKeyboardMapping (dpyinfo->display,
3387 min_code, max_code - min_code + 1,
3388 &syms_per_code);
3389 mods = XGetModifierMapping (dpyinfo->display);
3391 /* Scan the modifier table to see which modifier bits the Meta and
3392 Alt keysyms are on. */
3394 int row, col; /* The row and column in the modifier table. */
3395 int found_alt_or_meta;
3397 for (row = 3; row < 8; row++)
3399 found_alt_or_meta = 0;
3400 for (col = 0; col < mods->max_keypermod; col++)
3402 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3404 /* Zeroes are used for filler. Skip them. */
3405 if (code == 0)
3406 continue;
3408 /* Are any of this keycode's keysyms a meta key? */
3410 int code_col;
3412 for (code_col = 0; code_col < syms_per_code; code_col++)
3414 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3416 switch (sym)
3418 case XK_Meta_L:
3419 case XK_Meta_R:
3420 found_alt_or_meta = 1;
3421 dpyinfo->meta_mod_mask |= (1 << row);
3422 break;
3424 case XK_Alt_L:
3425 case XK_Alt_R:
3426 found_alt_or_meta = 1;
3427 dpyinfo->alt_mod_mask |= (1 << row);
3428 break;
3430 case XK_Hyper_L:
3431 case XK_Hyper_R:
3432 if (!found_alt_or_meta)
3433 dpyinfo->hyper_mod_mask |= (1 << row);
3434 code_col = syms_per_code;
3435 col = mods->max_keypermod;
3436 break;
3438 case XK_Super_L:
3439 case XK_Super_R:
3440 if (!found_alt_or_meta)
3441 dpyinfo->super_mod_mask |= (1 << row);
3442 code_col = syms_per_code;
3443 col = mods->max_keypermod;
3444 break;
3446 case XK_Shift_Lock:
3447 /* Ignore this if it's not on the lock modifier. */
3448 if (!found_alt_or_meta && ((1 << row) == LockMask))
3449 dpyinfo->shift_lock_mask = LockMask;
3450 code_col = syms_per_code;
3451 col = mods->max_keypermod;
3452 break;
3460 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3461 if (! dpyinfo->meta_mod_mask)
3463 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3464 dpyinfo->alt_mod_mask = 0;
3467 /* If some keys are both alt and meta,
3468 make them just meta, not alt. */
3469 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3471 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3474 XFree ((char *) syms);
3475 XFreeModifiermap (mods);
3478 /* Convert between the modifier bits X uses and the modifier bits
3479 Emacs uses. */
3481 unsigned int
3482 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, unsigned int state)
3484 EMACS_UINT mod_meta = meta_modifier;
3485 EMACS_UINT mod_alt = alt_modifier;
3486 EMACS_UINT mod_hyper = hyper_modifier;
3487 EMACS_UINT mod_super = super_modifier;
3488 Lisp_Object tem;
3490 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3491 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3492 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3493 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3494 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3495 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3496 tem = Fget (Vx_super_keysym, Qmodifier_value);
3497 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3500 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3501 | ((state & ControlMask) ? ctrl_modifier : 0)
3502 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3503 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3504 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3505 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3508 static unsigned int
3509 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, unsigned int state)
3511 EMACS_UINT mod_meta = meta_modifier;
3512 EMACS_UINT mod_alt = alt_modifier;
3513 EMACS_UINT mod_hyper = hyper_modifier;
3514 EMACS_UINT mod_super = super_modifier;
3516 Lisp_Object tem;
3518 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3519 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3520 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3521 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3522 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3523 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3524 tem = Fget (Vx_super_keysym, Qmodifier_value);
3525 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3528 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3529 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3530 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3531 | ((state & shift_modifier) ? ShiftMask : 0)
3532 | ((state & ctrl_modifier) ? ControlMask : 0)
3533 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3536 /* Convert a keysym to its name. */
3538 char *
3539 x_get_keysym_name (int keysym)
3541 char *value;
3543 BLOCK_INPUT;
3544 value = XKeysymToString (keysym);
3545 UNBLOCK_INPUT;
3547 return value;
3552 /* Mouse clicks and mouse movement. Rah. */
3554 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3556 If the event is a button press, then note that we have grabbed
3557 the mouse. */
3559 static Lisp_Object
3560 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3562 /* Make the event type NO_EVENT; we'll change that when we decide
3563 otherwise. */
3564 result->kind = MOUSE_CLICK_EVENT;
3565 result->code = event->button - Button1;
3566 result->timestamp = event->time;
3567 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3568 event->state)
3569 | (event->type == ButtonRelease
3570 ? up_modifier
3571 : down_modifier));
3573 XSETINT (result->x, event->x);
3574 XSETINT (result->y, event->y);
3575 XSETFRAME (result->frame_or_window, f);
3576 result->arg = Qnil;
3577 return Qnil;
3581 /* Function to report a mouse movement to the mainstream Emacs code.
3582 The input handler calls this.
3584 We have received a mouse movement event, which is given in *event.
3585 If the mouse is over a different glyph than it was last time, tell
3586 the mainstream emacs code by setting mouse_moved. If not, ask for
3587 another motion event, so we can check again the next time it moves. */
3589 static XMotionEvent last_mouse_motion_event;
3590 static Lisp_Object last_mouse_motion_frame;
3592 static int
3593 note_mouse_movement (FRAME_PTR frame, XMotionEvent *event)
3595 last_mouse_movement_time = event->time;
3596 last_mouse_motion_event = *event;
3597 XSETFRAME (last_mouse_motion_frame, frame);
3599 if (!FRAME_X_OUTPUT (frame))
3600 return 0;
3602 if (event->window != FRAME_X_WINDOW (frame))
3604 frame->mouse_moved = 1;
3605 last_mouse_scroll_bar = Qnil;
3606 note_mouse_highlight (frame, -1, -1);
3607 last_mouse_glyph_frame = 0;
3608 return 1;
3612 /* Has the mouse moved off the glyph it was on at the last sighting? */
3613 if (frame != last_mouse_glyph_frame
3614 || event->x < last_mouse_glyph.x
3615 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3616 || event->y < last_mouse_glyph.y
3617 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3619 frame->mouse_moved = 1;
3620 last_mouse_scroll_bar = Qnil;
3621 note_mouse_highlight (frame, event->x, event->y);
3622 /* Remember which glyph we're now on. */
3623 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3624 last_mouse_glyph_frame = frame;
3625 return 1;
3628 return 0;
3632 /************************************************************************
3633 Mouse Face
3634 ************************************************************************/
3636 static void
3637 redo_mouse_highlight (void)
3639 if (!NILP (last_mouse_motion_frame)
3640 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3641 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3642 last_mouse_motion_event.x,
3643 last_mouse_motion_event.y);
3648 /* Return the current position of the mouse.
3649 *FP should be a frame which indicates which display to ask about.
3651 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3652 and *PART to the frame, window, and scroll bar part that the mouse
3653 is over. Set *X and *Y to the portion and whole of the mouse's
3654 position on the scroll bar.
3656 If the mouse movement started elsewhere, set *FP to the frame the
3657 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3658 the mouse is over.
3660 Set *TIME to the server time-stamp for the time at which the mouse
3661 was at this position.
3663 Don't store anything if we don't have a valid set of values to report.
3665 This clears the mouse_moved flag, so we can wait for the next mouse
3666 movement. */
3668 static void
3669 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)
3671 FRAME_PTR f1;
3673 BLOCK_INPUT;
3675 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3676 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3677 else
3679 Window root;
3680 int root_x, root_y;
3682 Window dummy_window;
3683 int dummy;
3685 Lisp_Object frame, tail;
3687 /* Clear the mouse-moved flag for every frame on this display. */
3688 FOR_EACH_FRAME (tail, frame)
3689 if (FRAME_X_P (XFRAME (frame))
3690 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3691 XFRAME (frame)->mouse_moved = 0;
3693 last_mouse_scroll_bar = Qnil;
3695 /* Figure out which root window we're on. */
3696 XQueryPointer (FRAME_X_DISPLAY (*fp),
3697 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3699 /* The root window which contains the pointer. */
3700 &root,
3702 /* Trash which we can't trust if the pointer is on
3703 a different screen. */
3704 &dummy_window,
3706 /* The position on that root window. */
3707 &root_x, &root_y,
3709 /* More trash we can't trust. */
3710 &dummy, &dummy,
3712 /* Modifier keys and pointer buttons, about which
3713 we don't care. */
3714 (unsigned int *) &dummy);
3716 /* Now we have a position on the root; find the innermost window
3717 containing the pointer. */
3719 Window win, child;
3720 int win_x, win_y;
3721 int parent_x = 0, parent_y = 0;
3723 win = root;
3725 /* XTranslateCoordinates can get errors if the window
3726 structure is changing at the same time this function
3727 is running. So at least we must not crash from them. */
3729 x_catch_errors (FRAME_X_DISPLAY (*fp));
3731 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3732 && FRAME_LIVE_P (last_mouse_frame))
3734 /* If mouse was grabbed on a frame, give coords for that frame
3735 even if the mouse is now outside it. */
3736 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3738 /* From-window, to-window. */
3739 root, FRAME_X_WINDOW (last_mouse_frame),
3741 /* From-position, to-position. */
3742 root_x, root_y, &win_x, &win_y,
3744 /* Child of win. */
3745 &child);
3746 f1 = last_mouse_frame;
3748 else
3750 while (1)
3752 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3754 /* From-window, to-window. */
3755 root, win,
3757 /* From-position, to-position. */
3758 root_x, root_y, &win_x, &win_y,
3760 /* Child of win. */
3761 &child);
3763 if (child == None || child == win)
3764 break;
3765 #ifdef USE_GTK
3766 /* We don't wan't to know the innermost window. We
3767 want the edit window. For non-Gtk+ the innermost
3768 window is the edit window. For Gtk+ it might not
3769 be. It might be the tool bar for example. */
3770 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3771 break;
3772 #endif
3773 win = child;
3774 parent_x = win_x;
3775 parent_y = win_y;
3778 /* Now we know that:
3779 win is the innermost window containing the pointer
3780 (XTC says it has no child containing the pointer),
3781 win_x and win_y are the pointer's position in it
3782 (XTC did this the last time through), and
3783 parent_x and parent_y are the pointer's position in win's parent.
3784 (They are what win_x and win_y were when win was child.
3785 If win is the root window, it has no parent, and
3786 parent_{x,y} are invalid, but that's okay, because we'll
3787 never use them in that case.) */
3789 #ifdef USE_GTK
3790 /* We don't wan't to know the innermost window. We
3791 want the edit window. */
3792 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3793 #else
3794 /* Is win one of our frames? */
3795 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3796 #endif
3798 #ifdef USE_X_TOOLKIT
3799 /* If we end up with the menu bar window, say it's not
3800 on the frame. */
3801 if (f1 != NULL
3802 && f1->output_data.x->menubar_widget
3803 && win == XtWindow (f1->output_data.x->menubar_widget))
3804 f1 = NULL;
3805 #endif /* USE_X_TOOLKIT */
3808 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3809 f1 = 0;
3811 x_uncatch_errors ();
3813 /* If not, is it one of our scroll bars? */
3814 if (! f1)
3816 struct scroll_bar *bar;
3818 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3820 if (bar)
3822 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3823 win_x = parent_x;
3824 win_y = parent_y;
3828 if (f1 == 0 && insist > 0)
3829 f1 = SELECTED_FRAME ();
3831 if (f1)
3833 /* Ok, we found a frame. Store all the values.
3834 last_mouse_glyph is a rectangle used to reduce the
3835 generation of mouse events. To not miss any motion
3836 events, we must divide the frame into rectangles of the
3837 size of the smallest character that could be displayed
3838 on it, i.e. into the same rectangles that matrices on
3839 the frame are divided into. */
3841 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3842 last_mouse_glyph_frame = f1;
3844 *bar_window = Qnil;
3845 *part = 0;
3846 *fp = f1;
3847 XSETINT (*x, win_x);
3848 XSETINT (*y, win_y);
3849 *time = last_mouse_movement_time;
3854 UNBLOCK_INPUT;
3859 /***********************************************************************
3860 Scroll bars
3861 ***********************************************************************/
3863 /* Scroll bar support. */
3865 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
3866 manages it.
3867 This can be called in GC, so we have to make sure to strip off mark
3868 bits. */
3870 static struct scroll_bar *
3871 x_window_to_scroll_bar (Display *display, Window window_id)
3873 Lisp_Object tail;
3875 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3876 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
3877 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
3879 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
3881 Lisp_Object frame, bar, condemned;
3883 frame = XCAR (tail);
3884 /* All elements of Vframe_list should be frames. */
3885 if (! FRAMEP (frame))
3886 abort ();
3888 if (! FRAME_X_P (XFRAME (frame)))
3889 continue;
3891 /* Scan this frame's scroll bar list for a scroll bar with the
3892 right window ID. */
3893 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
3894 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
3895 /* This trick allows us to search both the ordinary and
3896 condemned scroll bar lists with one loop. */
3897 ! NILP (bar) || (bar = condemned,
3898 condemned = Qnil,
3899 ! NILP (bar));
3900 bar = XSCROLL_BAR (bar)->next)
3901 if (XSCROLL_BAR (bar)->x_window == window_id &&
3902 FRAME_X_DISPLAY (XFRAME (frame)) == display)
3903 return XSCROLL_BAR (bar);
3906 return 0;
3910 #if defined USE_LUCID
3912 /* Return the Lucid menu bar WINDOW is part of. Return null
3913 if WINDOW is not part of a menu bar. */
3915 static Widget
3916 x_window_to_menu_bar (Window window)
3918 Lisp_Object tail;
3920 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
3922 if (FRAME_X_P (XFRAME (XCAR (tail))))
3924 Lisp_Object frame = XCAR (tail);
3925 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
3927 if (menu_bar && xlwmenu_window_p (menu_bar, window))
3928 return menu_bar;
3932 return NULL;
3935 #endif /* USE_LUCID */
3938 /************************************************************************
3939 Toolkit scroll bars
3940 ************************************************************************/
3942 #ifdef USE_TOOLKIT_SCROLL_BARS
3944 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
3945 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
3946 static void x_create_toolkit_scroll_bar (struct frame *,
3947 struct scroll_bar *);
3948 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
3949 int, int, int);
3952 /* Lisp window being scrolled. Set when starting to interact with
3953 a toolkit scroll bar, reset to nil when ending the interaction. */
3955 static Lisp_Object window_being_scrolled;
3957 /* Last scroll bar part sent in xm_scroll_callback. */
3959 static int last_scroll_bar_part;
3961 /* Whether this is an Xaw with arrow-scrollbars. This should imply
3962 that movements of 1/20 of the screen size are mapped to up/down. */
3964 #ifndef USE_GTK
3965 /* Id of action hook installed for scroll bars. */
3967 static XtActionHookId action_hook_id;
3969 static Boolean xaw3d_arrow_scroll;
3971 /* Whether the drag scrolling maintains the mouse at the top of the
3972 thumb. If not, resizing the thumb needs to be done more carefully
3973 to avoid jerkyness. */
3975 static Boolean xaw3d_pick_top;
3977 /* Action hook installed via XtAppAddActionHook when toolkit scroll
3978 bars are used.. The hook is responsible for detecting when
3979 the user ends an interaction with the scroll bar, and generates
3980 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
3982 static void
3983 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
3984 XEvent *event, String *params, Cardinal *num_params)
3986 int scroll_bar_p;
3987 char *end_action;
3989 #ifdef USE_MOTIF
3990 scroll_bar_p = XmIsScrollBar (widget);
3991 end_action = "Release";
3992 #else /* !USE_MOTIF i.e. use Xaw */
3993 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
3994 end_action = "EndScroll";
3995 #endif /* USE_MOTIF */
3997 if (scroll_bar_p
3998 && strcmp (action_name, end_action) == 0
3999 && WINDOWP (window_being_scrolled))
4001 struct window *w;
4003 x_send_scroll_bar_event (window_being_scrolled,
4004 scroll_bar_end_scroll, 0, 0);
4005 w = XWINDOW (window_being_scrolled);
4007 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4009 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4010 /* The thumb size is incorrect while dragging: fix it. */
4011 set_vertical_scroll_bar (w);
4013 window_being_scrolled = Qnil;
4014 last_scroll_bar_part = -1;
4016 /* Xt timeouts no longer needed. */
4017 toolkit_scroll_bar_interaction = 0;
4020 #endif /* not USE_GTK */
4022 /* A vector of windows used for communication between
4023 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4025 static struct window **scroll_bar_windows;
4026 static int scroll_bar_windows_size;
4029 /* Send a client message with message type Xatom_Scrollbar for a
4030 scroll action to the frame of WINDOW. PART is a value identifying
4031 the part of the scroll bar that was clicked on. PORTION is the
4032 amount to scroll of a whole of WHOLE. */
4034 static void
4035 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4037 XEvent event;
4038 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4039 struct window *w = XWINDOW (window);
4040 struct frame *f = XFRAME (w->frame);
4041 int i;
4043 BLOCK_INPUT;
4045 /* Construct a ClientMessage event to send to the frame. */
4046 ev->type = ClientMessage;
4047 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4048 ev->display = FRAME_X_DISPLAY (f);
4049 ev->window = FRAME_X_WINDOW (f);
4050 ev->format = 32;
4052 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4053 not enough to store a pointer or Lisp_Object on a 64 bit system.
4054 So, store the window in scroll_bar_windows and pass the index
4055 into that array in the event. */
4056 for (i = 0; i < scroll_bar_windows_size; ++i)
4057 if (scroll_bar_windows[i] == NULL)
4058 break;
4060 if (i == scroll_bar_windows_size)
4062 int new_size = max (10, 2 * scroll_bar_windows_size);
4063 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4064 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4066 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4067 nbytes);
4068 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4069 scroll_bar_windows_size = new_size;
4072 scroll_bar_windows[i] = w;
4073 ev->data.l[0] = (long) i;
4074 ev->data.l[1] = (long) part;
4075 ev->data.l[2] = (long) 0;
4076 ev->data.l[3] = (long) portion;
4077 ev->data.l[4] = (long) whole;
4079 /* Make Xt timeouts work while the scroll bar is active. */
4080 toolkit_scroll_bar_interaction = 1;
4081 #ifdef USE_X_TOOLKIT
4082 x_activate_timeout_atimer ();
4083 #endif
4085 /* Setting the event mask to zero means that the message will
4086 be sent to the client that created the window, and if that
4087 window no longer exists, no event will be sent. */
4088 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4089 UNBLOCK_INPUT;
4093 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4094 in *IEVENT. */
4096 static void
4097 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4099 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4100 Lisp_Object window;
4101 struct frame *f;
4102 struct window *w;
4104 w = scroll_bar_windows[ev->data.l[0]];
4105 scroll_bar_windows[ev->data.l[0]] = NULL;
4107 XSETWINDOW (window, w);
4108 f = XFRAME (w->frame);
4110 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4111 ievent->frame_or_window = window;
4112 ievent->arg = Qnil;
4113 #ifdef USE_GTK
4114 ievent->timestamp = CurrentTime;
4115 #else
4116 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4117 #endif
4118 ievent->part = ev->data.l[1];
4119 ievent->code = ev->data.l[2];
4120 ievent->x = make_number ((int) ev->data.l[3]);
4121 ievent->y = make_number ((int) ev->data.l[4]);
4122 ievent->modifiers = 0;
4126 #ifdef USE_MOTIF
4128 /* Minimum and maximum values used for Motif scroll bars. */
4130 #define XM_SB_MAX 10000000
4133 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4134 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4135 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4137 static void
4138 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4140 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4141 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4142 int part = -1, whole = 0, portion = 0;
4144 switch (cs->reason)
4146 case XmCR_DECREMENT:
4147 bar->dragging = Qnil;
4148 part = scroll_bar_up_arrow;
4149 break;
4151 case XmCR_INCREMENT:
4152 bar->dragging = Qnil;
4153 part = scroll_bar_down_arrow;
4154 break;
4156 case XmCR_PAGE_DECREMENT:
4157 bar->dragging = Qnil;
4158 part = scroll_bar_above_handle;
4159 break;
4161 case XmCR_PAGE_INCREMENT:
4162 bar->dragging = Qnil;
4163 part = scroll_bar_below_handle;
4164 break;
4166 case XmCR_TO_TOP:
4167 bar->dragging = Qnil;
4168 part = scroll_bar_to_top;
4169 break;
4171 case XmCR_TO_BOTTOM:
4172 bar->dragging = Qnil;
4173 part = scroll_bar_to_bottom;
4174 break;
4176 case XmCR_DRAG:
4178 int slider_size;
4180 /* Get the slider size. */
4181 BLOCK_INPUT;
4182 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4183 UNBLOCK_INPUT;
4185 whole = XM_SB_MAX - slider_size;
4186 portion = min (cs->value, whole);
4187 part = scroll_bar_handle;
4188 bar->dragging = make_number (cs->value);
4190 break;
4192 case XmCR_VALUE_CHANGED:
4193 break;
4196 if (part >= 0)
4198 window_being_scrolled = bar->window;
4199 last_scroll_bar_part = part;
4200 x_send_scroll_bar_event (bar->window, part, portion, whole);
4204 #elif defined USE_GTK
4206 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4207 bar widget. DATA is a pointer to the scroll_bar structure. */
4209 static gboolean
4210 xg_scroll_callback (GtkRange *range,
4211 GtkScrollType scroll,
4212 gdouble value,
4213 gpointer user_data)
4215 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4216 gdouble position;
4217 int part = -1, whole = 0, portion = 0;
4218 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4219 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4221 if (xg_ignore_gtk_scrollbar) return FALSE;
4222 position = gtk_adjustment_get_value (adj);
4225 switch (scroll)
4227 case GTK_SCROLL_JUMP:
4228 /* Buttons 1 2 or 3 must be grabbed. */
4229 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4230 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4232 part = scroll_bar_handle;
4233 whole = gtk_adjustment_get_upper (adj) -
4234 gtk_adjustment_get_page_size (adj);
4235 portion = min ((int)position, whole);
4236 bar->dragging = make_number ((int)portion);
4238 break;
4239 case GTK_SCROLL_STEP_BACKWARD:
4240 part = scroll_bar_up_arrow;
4241 bar->dragging = Qnil;
4242 break;
4243 case GTK_SCROLL_STEP_FORWARD:
4244 part = scroll_bar_down_arrow;
4245 bar->dragging = Qnil;
4246 break;
4247 case GTK_SCROLL_PAGE_BACKWARD:
4248 part = scroll_bar_above_handle;
4249 bar->dragging = Qnil;
4250 break;
4251 case GTK_SCROLL_PAGE_FORWARD:
4252 part = scroll_bar_below_handle;
4253 bar->dragging = Qnil;
4254 break;
4257 if (part >= 0)
4259 window_being_scrolled = bar->window;
4260 last_scroll_bar_part = part;
4261 x_send_scroll_bar_event (bar->window, part, portion, whole);
4264 return FALSE;
4267 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4269 static gboolean
4270 xg_end_scroll_callback (GtkWidget *widget,
4271 GdkEventButton *event,
4272 gpointer user_data)
4274 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4275 bar->dragging = Qnil;
4276 if (WINDOWP (window_being_scrolled))
4278 x_send_scroll_bar_event (window_being_scrolled,
4279 scroll_bar_end_scroll, 0, 0);
4280 window_being_scrolled = Qnil;
4283 return FALSE;
4287 #else /* not USE_GTK and not USE_MOTIF */
4289 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4290 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4291 scroll bar struct. CALL_DATA is a pointer to a float saying where
4292 the thumb is. */
4294 static void
4295 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4297 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4298 float top = *(float *) call_data;
4299 float shown;
4300 int whole, portion, height;
4301 int part;
4303 /* Get the size of the thumb, a value between 0 and 1. */
4304 BLOCK_INPUT;
4305 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4306 UNBLOCK_INPUT;
4308 whole = 10000000;
4309 portion = shown < 1 ? top * whole : 0;
4311 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4312 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4313 the bottom, so we force the scrolling whenever we see that we're
4314 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4315 we try to ensure that we always stay two pixels away from the
4316 bottom). */
4317 part = scroll_bar_down_arrow;
4318 else
4319 part = scroll_bar_handle;
4321 window_being_scrolled = bar->window;
4322 bar->dragging = make_number (portion);
4323 last_scroll_bar_part = part;
4324 x_send_scroll_bar_event (bar->window, part, portion, whole);
4328 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4329 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4330 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4331 the scroll bar. CALL_DATA is an integer specifying the action that
4332 has taken place. Its magnitude is in the range 0..height of the
4333 scroll bar. Negative values mean scroll towards buffer start.
4334 Values < height of scroll bar mean line-wise movement. */
4336 static void
4337 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4339 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4340 /* The position really is stored cast to a pointer. */
4341 int position = (long) call_data;
4342 Dimension height;
4343 int part;
4345 /* Get the height of the scroll bar. */
4346 BLOCK_INPUT;
4347 XtVaGetValues (widget, XtNheight, &height, NULL);
4348 UNBLOCK_INPUT;
4350 if (eabs (position) >= height)
4351 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4353 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4354 it maps line-movement to call_data = max(5, height/20). */
4355 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4356 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4357 else
4358 part = scroll_bar_move_ratio;
4360 window_being_scrolled = bar->window;
4361 bar->dragging = Qnil;
4362 last_scroll_bar_part = part;
4363 x_send_scroll_bar_event (bar->window, part, position, height);
4366 #endif /* not USE_GTK and not USE_MOTIF */
4368 #define SCROLL_BAR_NAME "verticalScrollBar"
4370 /* Create the widget for scroll bar BAR on frame F. Record the widget
4371 and X window of the scroll bar in BAR. */
4373 #ifdef USE_GTK
4374 static void
4375 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4377 const char *scroll_bar_name = SCROLL_BAR_NAME;
4379 BLOCK_INPUT;
4380 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4381 G_CALLBACK (xg_end_scroll_callback),
4382 scroll_bar_name);
4383 UNBLOCK_INPUT;
4386 #else /* not USE_GTK */
4388 static void
4389 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4391 Window xwindow;
4392 Widget widget;
4393 Arg av[20];
4394 int ac = 0;
4395 char *scroll_bar_name = SCROLL_BAR_NAME;
4396 unsigned long pixel;
4398 BLOCK_INPUT;
4400 #ifdef USE_MOTIF
4401 /* Set resources. Create the widget. */
4402 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4403 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4404 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4405 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4406 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4407 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4408 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4410 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4411 if (pixel != -1)
4413 XtSetArg (av[ac], XmNforeground, pixel);
4414 ++ac;
4417 pixel = f->output_data.x->scroll_bar_background_pixel;
4418 if (pixel != -1)
4420 XtSetArg (av[ac], XmNbackground, pixel);
4421 ++ac;
4424 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4425 scroll_bar_name, av, ac);
4427 /* Add one callback for everything that can happen. */
4428 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4429 (XtPointer) bar);
4430 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4431 (XtPointer) bar);
4432 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4433 (XtPointer) bar);
4434 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4435 (XtPointer) bar);
4436 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4437 (XtPointer) bar);
4438 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4439 (XtPointer) bar);
4440 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4441 (XtPointer) bar);
4443 /* Realize the widget. Only after that is the X window created. */
4444 XtRealizeWidget (widget);
4446 /* Set the cursor to an arrow. I didn't find a resource to do that.
4447 And I'm wondering why it hasn't an arrow cursor by default. */
4448 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4449 f->output_data.x->nontext_cursor);
4451 #else /* !USE_MOTIF i.e. use Xaw */
4453 /* Set resources. Create the widget. The background of the
4454 Xaw3d scroll bar widget is a little bit light for my taste.
4455 We don't alter it here to let users change it according
4456 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4457 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4458 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4459 /* For smoother scrolling with Xaw3d -sm */
4460 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4462 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4463 if (pixel != -1)
4465 XtSetArg (av[ac], XtNforeground, pixel);
4466 ++ac;
4469 pixel = f->output_data.x->scroll_bar_background_pixel;
4470 if (pixel != -1)
4472 XtSetArg (av[ac], XtNbackground, pixel);
4473 ++ac;
4476 /* Top/bottom shadow colors. */
4478 /* Allocate them, if necessary. */
4479 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4481 pixel = f->output_data.x->scroll_bar_background_pixel;
4482 if (pixel != -1)
4484 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4485 FRAME_X_COLORMAP (f),
4486 &pixel, 1.2, 0x8000))
4487 pixel = -1;
4488 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4491 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4493 pixel = f->output_data.x->scroll_bar_background_pixel;
4494 if (pixel != -1)
4496 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4497 FRAME_X_COLORMAP (f),
4498 &pixel, 0.6, 0x4000))
4499 pixel = -1;
4500 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4504 #ifdef XtNbeNiceToColormap
4505 /* Tell the toolkit about them. */
4506 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4507 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4508 /* We tried to allocate a color for the top/bottom shadow, and
4509 failed, so tell Xaw3d to use dithering instead. */
4510 /* But only if we have a small colormap. Xaw3d can allocate nice
4511 colors itself. */
4513 XtSetArg (av[ac], XtNbeNiceToColormap,
4514 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4515 ++ac;
4517 else
4518 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4519 be more consistent with other emacs 3d colors, and since Xaw3d is
4520 not good at dealing with allocation failure. */
4522 /* This tells Xaw3d to use real colors instead of dithering for
4523 the shadows. */
4524 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4525 ++ac;
4527 /* Specify the colors. */
4528 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4529 if (pixel != -1)
4531 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4532 ++ac;
4534 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4535 if (pixel != -1)
4537 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4538 ++ac;
4541 #endif
4543 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4544 f->output_data.x->edit_widget, av, ac);
4547 char *initial = "";
4548 char *val = initial;
4549 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4550 #ifdef XtNarrowScrollbars
4551 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4552 #endif
4553 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4554 if (xaw3d_arrow_scroll || val == initial)
4555 { /* ARROW_SCROLL */
4556 xaw3d_arrow_scroll = True;
4557 /* Isn't that just a personal preference ? --Stef */
4558 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4562 /* Define callbacks. */
4563 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4564 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4565 (XtPointer) bar);
4567 /* Realize the widget. Only after that is the X window created. */
4568 XtRealizeWidget (widget);
4570 #endif /* !USE_MOTIF */
4572 /* Install an action hook that lets us detect when the user
4573 finishes interacting with a scroll bar. */
4574 if (action_hook_id == 0)
4575 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4577 /* Remember X window and widget in the scroll bar vector. */
4578 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4579 xwindow = XtWindow (widget);
4580 bar->x_window = xwindow;
4582 UNBLOCK_INPUT;
4584 #endif /* not USE_GTK */
4587 /* Set the thumb size and position of scroll bar BAR. We are currently
4588 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4590 #ifdef USE_GTK
4591 static void
4592 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4594 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4597 #else /* not USE_GTK */
4598 static void
4599 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4600 int whole)
4602 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4603 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4604 float top, shown;
4606 BLOCK_INPUT;
4608 #ifdef USE_MOTIF
4610 /* We use an estimate of 30 chars per line rather than the real
4611 `portion' value. This has the disadvantage that the thumb size
4612 is not very representative, but it makes our life a lot easier.
4613 Otherwise, we have to constantly adjust the thumb size, which
4614 we can't always do quickly enough: while dragging, the size of
4615 the thumb might prevent the user from dragging the thumb all the
4616 way to the end. but Motif and some versions of Xaw3d don't allow
4617 updating the thumb size while dragging. Also, even if we can update
4618 its size, the update will often happen too late.
4619 If you don't believe it, check out revision 1.650 of xterm.c to see
4620 what hoops we were going through and the still poor behavior we got. */
4621 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4622 /* When the thumb is at the bottom, position == whole.
4623 So we need to increase `whole' to make space for the thumb. */
4624 whole += portion;
4626 if (whole <= 0)
4627 top = 0, shown = 1;
4628 else
4630 top = (float) position / whole;
4631 shown = (float) portion / whole;
4634 if (NILP (bar->dragging))
4636 int size, value;
4638 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4639 is the scroll bar's maximum and MIN is the scroll bar's minimum
4640 value. */
4641 size = shown * XM_SB_MAX;
4642 size = min (size, XM_SB_MAX);
4643 size = max (size, 1);
4645 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4646 value = top * XM_SB_MAX;
4647 value = min (value, XM_SB_MAX - size);
4649 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4651 #else /* !USE_MOTIF i.e. use Xaw */
4653 if (whole == 0)
4654 top = 0, shown = 1;
4655 else
4657 top = (float) position / whole;
4658 shown = (float) portion / whole;
4662 float old_top, old_shown;
4663 Dimension height;
4664 XtVaGetValues (widget,
4665 XtNtopOfThumb, &old_top,
4666 XtNshown, &old_shown,
4667 XtNheight, &height,
4668 NULL);
4670 /* Massage the top+shown values. */
4671 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4672 top = max (0, min (1, top));
4673 else
4674 top = old_top;
4675 /* Keep two pixels available for moving the thumb down. */
4676 shown = max (0, min (1 - top - (2.0 / height), shown));
4678 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4679 check that your system's configuration file contains a define
4680 for `NARROWPROTO'. See s/freebsd.h for an example. */
4681 if (top != old_top || shown != old_shown)
4683 if (NILP (bar->dragging))
4684 XawScrollbarSetThumb (widget, top, shown);
4685 else
4687 /* Try to make the scrolling a tad smoother. */
4688 if (!xaw3d_pick_top)
4689 shown = min (shown, old_shown);
4691 XawScrollbarSetThumb (widget, top, shown);
4695 #endif /* !USE_MOTIF */
4697 UNBLOCK_INPUT;
4699 #endif /* not USE_GTK */
4701 #endif /* USE_TOOLKIT_SCROLL_BARS */
4705 /************************************************************************
4706 Scroll bars, general
4707 ************************************************************************/
4709 /* Create a scroll bar and return the scroll bar vector for it. W is
4710 the Emacs window on which to create the scroll bar. TOP, LEFT,
4711 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4712 scroll bar. */
4714 static struct scroll_bar *
4715 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4717 struct frame *f = XFRAME (w->frame);
4718 struct scroll_bar *bar
4719 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4721 BLOCK_INPUT;
4723 #ifdef USE_TOOLKIT_SCROLL_BARS
4724 x_create_toolkit_scroll_bar (f, bar);
4725 #else /* not USE_TOOLKIT_SCROLL_BARS */
4727 XSetWindowAttributes a;
4728 unsigned long mask;
4729 Window window;
4731 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4732 if (a.background_pixel == -1)
4733 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4735 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4736 | ButtonMotionMask | PointerMotionHintMask
4737 | ExposureMask);
4738 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4740 mask = (CWBackPixel | CWEventMask | CWCursor);
4742 /* Clear the area of W that will serve as a scroll bar. This is
4743 for the case that a window has been split horizontally. In
4744 this case, no clear_frame is generated to reduce flickering. */
4745 if (width > 0 && height > 0)
4746 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4747 left, top, width,
4748 window_box_height (w), False);
4750 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4751 /* Position and size of scroll bar. */
4752 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4753 top,
4754 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4755 height,
4756 /* Border width, depth, class, and visual. */
4758 CopyFromParent,
4759 CopyFromParent,
4760 CopyFromParent,
4761 /* Attributes. */
4762 mask, &a);
4763 bar->x_window = window;
4765 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4767 XSETWINDOW (bar->window, w);
4768 bar->top = top;
4769 bar->left = left;
4770 bar->width = width;
4771 bar->height = height;
4772 bar->start = 0;
4773 bar->end = 0;
4774 bar->dragging = Qnil;
4775 bar->fringe_extended_p = 0;
4777 /* Add bar to its frame's list of scroll bars. */
4778 bar->next = FRAME_SCROLL_BARS (f);
4779 bar->prev = Qnil;
4780 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4781 if (!NILP (bar->next))
4782 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4784 /* Map the window/widget. */
4785 #ifdef USE_TOOLKIT_SCROLL_BARS
4787 #ifdef USE_GTK
4788 xg_update_scrollbar_pos (f,
4789 bar->x_window,
4790 top,
4791 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4792 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4793 max (height, 1));
4794 #else /* not USE_GTK */
4795 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4796 XtConfigureWidget (scroll_bar,
4797 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4798 top,
4799 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4800 max (height, 1), 0);
4801 XtMapWidget (scroll_bar);
4802 #endif /* not USE_GTK */
4804 #else /* not USE_TOOLKIT_SCROLL_BARS */
4805 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4806 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4808 UNBLOCK_INPUT;
4809 return bar;
4813 #ifndef USE_TOOLKIT_SCROLL_BARS
4815 /* Draw BAR's handle in the proper position.
4817 If the handle is already drawn from START to END, don't bother
4818 redrawing it, unless REBUILD is non-zero; in that case, always
4819 redraw it. (REBUILD is handy for drawing the handle after expose
4820 events.)
4822 Normally, we want to constrain the start and end of the handle to
4823 fit inside its rectangle, but if the user is dragging the scroll
4824 bar handle, we want to let them drag it down all the way, so that
4825 the bar's top is as far down as it goes; otherwise, there's no way
4826 to move to the very end of the buffer. */
4828 static void
4829 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
4831 int dragging = ! NILP (bar->dragging);
4832 Window w = bar->x_window;
4833 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4834 GC gc = f->output_data.x->normal_gc;
4836 /* If the display is already accurate, do nothing. */
4837 if (! rebuild
4838 && start == bar->start
4839 && end == bar->end)
4840 return;
4842 BLOCK_INPUT;
4845 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4846 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4847 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4849 /* Make sure the values are reasonable, and try to preserve
4850 the distance between start and end. */
4852 int length = end - start;
4854 if (start < 0)
4855 start = 0;
4856 else if (start > top_range)
4857 start = top_range;
4858 end = start + length;
4860 if (end < start)
4861 end = start;
4862 else if (end > top_range && ! dragging)
4863 end = top_range;
4866 /* Store the adjusted setting in the scroll bar. */
4867 bar->start = start;
4868 bar->end = end;
4870 /* Clip the end position, just for display. */
4871 if (end > top_range)
4872 end = top_range;
4874 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
4875 below top positions, to make sure the handle is always at least
4876 that many pixels tall. */
4877 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
4879 /* Draw the empty space above the handle. Note that we can't clear
4880 zero-height areas; that means "clear to end of window." */
4881 if (0 < start)
4882 x_clear_area (FRAME_X_DISPLAY (f), w,
4883 /* x, y, width, height, and exposures. */
4884 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4885 VERTICAL_SCROLL_BAR_TOP_BORDER,
4886 inside_width, start,
4887 False);
4889 /* Change to proper foreground color if one is specified. */
4890 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
4891 XSetForeground (FRAME_X_DISPLAY (f), gc,
4892 f->output_data.x->scroll_bar_foreground_pixel);
4894 /* Draw the handle itself. */
4895 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
4896 /* x, y, width, height */
4897 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4898 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
4899 inside_width, end - start);
4901 /* Restore the foreground color of the GC if we changed it above. */
4902 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
4903 XSetForeground (FRAME_X_DISPLAY (f), gc,
4904 FRAME_FOREGROUND_PIXEL (f));
4906 /* Draw the empty space below the handle. Note that we can't
4907 clear zero-height areas; that means "clear to end of window." */
4908 if (end < inside_height)
4909 x_clear_area (FRAME_X_DISPLAY (f), w,
4910 /* x, y, width, height, and exposures. */
4911 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4912 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
4913 inside_width, inside_height - end,
4914 False);
4918 UNBLOCK_INPUT;
4921 #endif /* !USE_TOOLKIT_SCROLL_BARS */
4923 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
4924 nil. */
4926 static void
4927 x_scroll_bar_remove (struct scroll_bar *bar)
4929 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4930 BLOCK_INPUT;
4932 #ifdef USE_TOOLKIT_SCROLL_BARS
4933 #ifdef USE_GTK
4934 xg_remove_scroll_bar (f, bar->x_window);
4935 #else /* not USE_GTK */
4936 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
4937 #endif /* not USE_GTK */
4938 #else
4939 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
4940 #endif
4942 /* Disassociate this scroll bar from its window. */
4943 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
4945 UNBLOCK_INPUT;
4949 /* Set the handle of the vertical scroll bar for WINDOW to indicate
4950 that we are displaying PORTION characters out of a total of WHOLE
4951 characters, starting at POSITION. If WINDOW has no scroll bar,
4952 create one. */
4954 static void
4955 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
4957 struct frame *f = XFRAME (w->frame);
4958 struct scroll_bar *bar;
4959 int top, height, left, sb_left, width, sb_width;
4960 int window_y, window_height;
4961 #ifdef USE_TOOLKIT_SCROLL_BARS
4962 int fringe_extended_p;
4963 #endif
4965 /* Get window dimensions. */
4966 window_box (w, -1, 0, &window_y, 0, &window_height);
4967 top = window_y;
4968 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
4969 height = window_height;
4971 /* Compute the left edge of the scroll bar area. */
4972 left = WINDOW_SCROLL_BAR_AREA_X (w);
4974 /* Compute the width of the scroll bar which might be less than
4975 the width of the area reserved for the scroll bar. */
4976 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
4977 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
4978 else
4979 sb_width = width;
4981 /* Compute the left edge of the scroll bar. */
4982 #ifdef USE_TOOLKIT_SCROLL_BARS
4983 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
4984 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
4985 else
4986 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
4987 #else
4988 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
4989 sb_left = left + width - sb_width;
4990 else
4991 sb_left = left;
4992 #endif
4994 #ifdef USE_TOOLKIT_SCROLL_BARS
4995 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
4996 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
4997 && WINDOW_LEFT_FRINGE_WIDTH (w)
4998 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
4999 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5000 else
5001 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5002 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5003 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5004 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5005 #endif
5007 /* Does the scroll bar exist yet? */
5008 if (NILP (w->vertical_scroll_bar))
5010 if (width > 0 && height > 0)
5012 BLOCK_INPUT;
5013 #ifdef USE_TOOLKIT_SCROLL_BARS
5014 if (fringe_extended_p)
5015 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5016 sb_left, top, sb_width, height, False);
5017 else
5018 #endif
5019 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5020 left, top, width, height, False);
5021 UNBLOCK_INPUT;
5024 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5026 else
5028 /* It may just need to be moved and resized. */
5029 unsigned int mask = 0;
5031 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5033 BLOCK_INPUT;
5035 if (sb_left != bar->left)
5036 mask |= CWX;
5037 if (top != bar->top)
5038 mask |= CWY;
5039 if (sb_width != bar->width)
5040 mask |= CWWidth;
5041 if (height != bar->height)
5042 mask |= CWHeight;
5044 #ifdef USE_TOOLKIT_SCROLL_BARS
5046 /* Move/size the scroll bar widget. */
5047 if (mask || bar->fringe_extended_p != fringe_extended_p)
5049 /* Since toolkit scroll bars are smaller than the space reserved
5050 for them on the frame, we have to clear "under" them. */
5051 if (width > 0 && height > 0)
5053 if (fringe_extended_p)
5054 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5055 sb_left, top, sb_width, height, False);
5056 else
5057 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5058 left, top, width, height, False);
5060 #ifdef USE_GTK
5061 xg_update_scrollbar_pos (f,
5062 bar->x_window,
5063 top,
5064 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5065 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5066 max (height, 1));
5067 #else /* not USE_GTK */
5068 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5069 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5070 top,
5071 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5072 max (height, 1), 0);
5073 #endif /* not USE_GTK */
5075 #else /* not USE_TOOLKIT_SCROLL_BARS */
5077 /* Clear areas not covered by the scroll bar because of
5078 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5079 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5081 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5082 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5083 height, False);
5084 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5085 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5086 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5087 height, False);
5090 /* Clear areas not covered by the scroll bar because it's not as
5091 wide as the area reserved for it. This makes sure a
5092 previous mode line display is cleared after C-x 2 C-x 1, for
5093 example. */
5095 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5096 int rest = area_width - sb_width;
5097 if (rest > 0 && height > 0)
5099 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5100 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5101 left + area_width - rest, top,
5102 rest, height, False);
5103 else
5104 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5105 left, top, rest, height, False);
5109 /* Move/size the scroll bar window. */
5110 if (mask)
5112 XWindowChanges wc;
5114 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5115 wc.y = top;
5116 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5117 wc.height = height;
5118 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5119 mask, &wc);
5122 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5124 /* Remember new settings. */
5125 bar->left = sb_left;
5126 bar->top = top;
5127 bar->width = sb_width;
5128 bar->height = height;
5130 UNBLOCK_INPUT;
5133 #ifdef USE_TOOLKIT_SCROLL_BARS
5134 bar->fringe_extended_p = fringe_extended_p;
5136 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5137 #else /* not USE_TOOLKIT_SCROLL_BARS */
5138 /* Set the scroll bar's current state, unless we're currently being
5139 dragged. */
5140 if (NILP (bar->dragging))
5142 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5144 if (whole == 0)
5145 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5146 else
5148 int start = ((double) position * top_range) / whole;
5149 int end = ((double) (position + portion) * top_range) / whole;
5150 x_scroll_bar_set_handle (bar, start, end, 0);
5153 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5155 XSETVECTOR (w->vertical_scroll_bar, bar);
5159 /* The following three hooks are used when we're doing a thorough
5160 redisplay of the frame. We don't explicitly know which scroll bars
5161 are going to be deleted, because keeping track of when windows go
5162 away is a real pain - "Can you say set-window-configuration, boys
5163 and girls?" Instead, we just assert at the beginning of redisplay
5164 that *all* scroll bars are to be removed, and then save a scroll bar
5165 from the fiery pit when we actually redisplay its window. */
5167 /* Arrange for all scroll bars on FRAME to be removed at the next call
5168 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5169 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5171 static void
5172 XTcondemn_scroll_bars (FRAME_PTR frame)
5174 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5175 while (! NILP (FRAME_SCROLL_BARS (frame)))
5177 Lisp_Object bar;
5178 bar = FRAME_SCROLL_BARS (frame);
5179 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5180 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5181 XSCROLL_BAR (bar)->prev = Qnil;
5182 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5183 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5184 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5189 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5190 Note that WINDOW isn't necessarily condemned at all. */
5192 static void
5193 XTredeem_scroll_bar (struct window *window)
5195 struct scroll_bar *bar;
5196 struct frame *f;
5198 /* We can't redeem this window's scroll bar if it doesn't have one. */
5199 if (NILP (window->vertical_scroll_bar))
5200 abort ();
5202 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5204 /* Unlink it from the condemned list. */
5205 f = XFRAME (WINDOW_FRAME (window));
5206 if (NILP (bar->prev))
5208 /* If the prev pointer is nil, it must be the first in one of
5209 the lists. */
5210 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5211 /* It's not condemned. Everything's fine. */
5212 return;
5213 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5214 window->vertical_scroll_bar))
5215 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5216 else
5217 /* If its prev pointer is nil, it must be at the front of
5218 one or the other! */
5219 abort ();
5221 else
5222 XSCROLL_BAR (bar->prev)->next = bar->next;
5224 if (! NILP (bar->next))
5225 XSCROLL_BAR (bar->next)->prev = bar->prev;
5227 bar->next = FRAME_SCROLL_BARS (f);
5228 bar->prev = Qnil;
5229 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5230 if (! NILP (bar->next))
5231 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5234 /* Remove all scroll bars on FRAME that haven't been saved since the
5235 last call to `*condemn_scroll_bars_hook'. */
5237 static void
5238 XTjudge_scroll_bars (FRAME_PTR f)
5240 Lisp_Object bar, next;
5242 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5244 /* Clear out the condemned list now so we won't try to process any
5245 more events on the hapless scroll bars. */
5246 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5248 for (; ! NILP (bar); bar = next)
5250 struct scroll_bar *b = XSCROLL_BAR (bar);
5252 x_scroll_bar_remove (b);
5254 next = b->next;
5255 b->next = b->prev = Qnil;
5258 /* Now there should be no references to the condemned scroll bars,
5259 and they should get garbage-collected. */
5263 #ifndef USE_TOOLKIT_SCROLL_BARS
5264 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5265 is a no-op when using toolkit scroll bars.
5267 This may be called from a signal handler, so we have to ignore GC
5268 mark bits. */
5270 static void
5271 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5273 Window w = bar->x_window;
5274 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5275 GC gc = f->output_data.x->normal_gc;
5276 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5278 BLOCK_INPUT;
5280 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5282 /* Switch to scroll bar foreground color. */
5283 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5284 XSetForeground (FRAME_X_DISPLAY (f), gc,
5285 f->output_data.x->scroll_bar_foreground_pixel);
5287 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5288 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5290 /* x, y, width, height */
5291 0, 0,
5292 bar->width - 1 - width_trim - width_trim,
5293 bar->height - 1);
5295 /* Restore the foreground color of the GC if we changed it above. */
5296 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5297 XSetForeground (FRAME_X_DISPLAY (f), gc,
5298 FRAME_FOREGROUND_PIXEL (f));
5300 UNBLOCK_INPUT;
5303 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5305 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5306 is set to something other than NO_EVENT, it is enqueued.
5308 This may be called from a signal handler, so we have to ignore GC
5309 mark bits. */
5312 static void
5313 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5315 if (! WINDOWP (bar->window))
5316 abort ();
5318 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5319 emacs_event->code = event->xbutton.button - Button1;
5320 emacs_event->modifiers
5321 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5322 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5323 event->xbutton.state)
5324 | (event->type == ButtonRelease
5325 ? up_modifier
5326 : down_modifier));
5327 emacs_event->frame_or_window = bar->window;
5328 emacs_event->arg = Qnil;
5329 emacs_event->timestamp = event->xbutton.time;
5331 int top_range
5332 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5333 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5335 if (y < 0) y = 0;
5336 if (y > top_range) y = top_range;
5338 if (y < bar->start)
5339 emacs_event->part = scroll_bar_above_handle;
5340 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5341 emacs_event->part = scroll_bar_handle;
5342 else
5343 emacs_event->part = scroll_bar_below_handle;
5345 #ifndef USE_TOOLKIT_SCROLL_BARS
5346 /* If the user has released the handle, set it to its final position. */
5347 if (event->type == ButtonRelease
5348 && ! NILP (bar->dragging))
5350 int new_start = y - XINT (bar->dragging);
5351 int new_end = new_start + bar->end - bar->start;
5353 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5354 bar->dragging = Qnil;
5356 #endif
5358 XSETINT (emacs_event->x, y);
5359 XSETINT (emacs_event->y, top_range);
5363 #ifndef USE_TOOLKIT_SCROLL_BARS
5365 /* Handle some mouse motion while someone is dragging the scroll bar.
5367 This may be called from a signal handler, so we have to ignore GC
5368 mark bits. */
5370 static void
5371 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5373 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5375 last_mouse_movement_time = event->xmotion.time;
5377 f->mouse_moved = 1;
5378 XSETVECTOR (last_mouse_scroll_bar, bar);
5380 /* If we're dragging the bar, display it. */
5381 if (! NILP (bar->dragging))
5383 /* Where should the handle be now? */
5384 int new_start = event->xmotion.y - XINT (bar->dragging);
5386 if (new_start != bar->start)
5388 int new_end = new_start + bar->end - bar->start;
5390 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5395 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5397 /* Return information to the user about the current position of the mouse
5398 on the scroll bar. */
5400 static void
5401 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)
5403 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5404 Window w = bar->x_window;
5405 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5406 int win_x, win_y;
5407 Window dummy_window;
5408 int dummy_coord;
5409 unsigned int dummy_mask;
5411 BLOCK_INPUT;
5413 /* Get the mouse's position relative to the scroll bar window, and
5414 report that. */
5415 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5417 /* Root, child, root x and root y. */
5418 &dummy_window, &dummy_window,
5419 &dummy_coord, &dummy_coord,
5421 /* Position relative to scroll bar. */
5422 &win_x, &win_y,
5424 /* Mouse buttons and modifier keys. */
5425 &dummy_mask))
5427 else
5429 int top_range
5430 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5432 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5434 if (! NILP (bar->dragging))
5435 win_y -= XINT (bar->dragging);
5437 if (win_y < 0)
5438 win_y = 0;
5439 if (win_y > top_range)
5440 win_y = top_range;
5442 *fp = f;
5443 *bar_window = bar->window;
5445 if (! NILP (bar->dragging))
5446 *part = scroll_bar_handle;
5447 else if (win_y < bar->start)
5448 *part = scroll_bar_above_handle;
5449 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5450 *part = scroll_bar_handle;
5451 else
5452 *part = scroll_bar_below_handle;
5454 XSETINT (*x, win_y);
5455 XSETINT (*y, top_range);
5457 f->mouse_moved = 0;
5458 last_mouse_scroll_bar = Qnil;
5461 *time = last_mouse_movement_time;
5463 UNBLOCK_INPUT;
5467 /* The screen has been cleared so we may have changed foreground or
5468 background colors, and the scroll bars may need to be redrawn.
5469 Clear out the scroll bars, and ask for expose events, so we can
5470 redraw them. */
5472 void
5473 x_scroll_bar_clear (FRAME_PTR f)
5475 #ifndef USE_TOOLKIT_SCROLL_BARS
5476 Lisp_Object bar;
5478 /* We can have scroll bars even if this is 0,
5479 if we just turned off scroll bar mode.
5480 But in that case we should not clear them. */
5481 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5482 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5483 bar = XSCROLL_BAR (bar)->next)
5484 XClearArea (FRAME_X_DISPLAY (f),
5485 XSCROLL_BAR (bar)->x_window,
5486 0, 0, 0, 0, True);
5487 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5491 /* The main X event-reading loop - XTread_socket. */
5493 /* This holds the state XLookupString needs to implement dead keys
5494 and other tricks known as "compose processing". _X Window System_
5495 says that a portable program can't use this, but Stephen Gildea assures
5496 me that letting the compiler initialize it to zeros will work okay.
5498 This must be defined outside of XTread_socket, for the same reasons
5499 given for enter_timestamp, above. */
5501 static XComposeStatus compose_status;
5503 /* Record the last 100 characters stored
5504 to help debug the loss-of-chars-during-GC problem. */
5506 static int temp_index;
5507 static short temp_buffer[100];
5509 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5510 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5511 temp_index = 0; \
5512 temp_buffer[temp_index++] = (keysym)
5514 /* Set this to nonzero to fake an "X I/O error"
5515 on a particular display. */
5517 struct x_display_info *XTread_socket_fake_io_error;
5519 /* When we find no input here, we occasionally do a no-op command
5520 to verify that the X server is still running and we can still talk with it.
5521 We try all the open displays, one by one.
5522 This variable is used for cycling thru the displays. */
5524 static struct x_display_info *next_noop_dpyinfo;
5526 #define SET_SAVED_BUTTON_EVENT \
5527 do \
5529 if (f->output_data.x->saved_menu_event == 0) \
5530 f->output_data.x->saved_menu_event \
5531 = (XEvent *) xmalloc (sizeof (XEvent)); \
5532 *f->output_data.x->saved_menu_event = event; \
5533 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5534 XSETFRAME (inev.ie.frame_or_window, f); \
5536 while (0)
5538 enum
5540 X_EVENT_NORMAL,
5541 X_EVENT_GOTO_OUT,
5542 X_EVENT_DROP
5545 /* Filter events for the current X input method.
5546 DPYINFO is the display this event is for.
5547 EVENT is the X event to filter.
5549 Returns non-zero if the event was filtered, caller shall not process
5550 this event further.
5551 Returns zero if event is wasn't filtered. */
5553 #ifdef HAVE_X_I18N
5554 static int
5555 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5557 /* XFilterEvent returns non-zero if the input method has
5558 consumed the event. We pass the frame's X window to
5559 XFilterEvent because that's the one for which the IC
5560 was created. */
5562 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5563 event->xclient.window);
5565 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5567 #endif
5569 #ifdef USE_GTK
5570 static int current_count;
5571 static int current_finish;
5572 static struct input_event *current_hold_quit;
5574 /* This is the filter function invoked by the GTK event loop.
5575 It is invoked before the XEvent is translated to a GdkEvent,
5576 so we have a chance to act on the event before GTK. */
5577 static GdkFilterReturn
5578 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5580 XEvent *xev = (XEvent *) gxev;
5582 BLOCK_INPUT;
5583 if (current_count >= 0)
5585 struct x_display_info *dpyinfo;
5587 dpyinfo = x_display_info_for_display (xev->xany.display);
5589 #ifdef HAVE_X_I18N
5590 /* Filter events for the current X input method.
5591 GTK calls XFilterEvent but not for key press and release,
5592 so we do it here. */
5593 if ((xev->type == KeyPress || xev->type == KeyRelease)
5594 && dpyinfo
5595 && x_filter_event (dpyinfo, xev))
5597 UNBLOCK_INPUT;
5598 return GDK_FILTER_REMOVE;
5600 #endif
5602 if (! dpyinfo)
5603 current_finish = X_EVENT_NORMAL;
5604 else
5605 current_count +=
5606 handle_one_xevent (dpyinfo, xev, &current_finish,
5607 current_hold_quit);
5609 else
5610 current_finish = x_dispatch_event (xev, xev->xany.display);
5612 UNBLOCK_INPUT;
5614 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5615 return GDK_FILTER_REMOVE;
5617 return GDK_FILTER_CONTINUE;
5619 #endif /* USE_GTK */
5622 /* Handles the XEvent EVENT on display DPYINFO.
5624 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5625 *FINISH is zero if caller should continue reading events.
5626 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5628 We return the number of characters stored into the buffer. */
5630 static int
5631 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventp, int *finish, struct input_event *hold_quit)
5633 union {
5634 struct input_event ie;
5635 struct selection_input_event sie;
5636 } inev;
5637 int count = 0;
5638 int do_help = 0;
5639 int nbytes = 0;
5640 struct frame *f = NULL;
5641 struct coding_system coding;
5642 XEvent event = *eventp;
5644 *finish = X_EVENT_NORMAL;
5646 EVENT_INIT (inev.ie);
5647 inev.ie.kind = NO_EVENT;
5648 inev.ie.arg = Qnil;
5650 if (pending_event_wait.eventtype == event.type)
5651 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5653 switch (event.type)
5655 case ClientMessage:
5657 if (event.xclient.message_type
5658 == dpyinfo->Xatom_wm_protocols
5659 && event.xclient.format == 32)
5661 if (event.xclient.data.l[0]
5662 == dpyinfo->Xatom_wm_take_focus)
5664 /* Use x_any_window_to_frame because this
5665 could be the shell widget window
5666 if the frame has no title bar. */
5667 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5668 #ifdef HAVE_X_I18N
5669 /* Not quite sure this is needed -pd */
5670 if (f && FRAME_XIC (f))
5671 XSetICFocus (FRAME_XIC (f));
5672 #endif
5673 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5674 instructs the WM to set the input focus automatically for
5675 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5676 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5677 it has set the focus. So, XSetInputFocus below is not
5678 needed.
5680 The call to XSetInputFocus below has also caused trouble. In
5681 cases where the XSetInputFocus done by the WM and the one
5682 below are temporally close (on a fast machine), the call
5683 below can generate additional FocusIn events which confuse
5684 Emacs. */
5686 /* Since we set WM_TAKE_FOCUS, we must call
5687 XSetInputFocus explicitly. But not if f is null,
5688 since that might be an event for a deleted frame. */
5689 if (f)
5691 Display *d = event.xclient.display;
5692 /* Catch and ignore errors, in case window has been
5693 iconified by a window manager such as GWM. */
5694 x_catch_errors (d);
5695 XSetInputFocus (d, event.xclient.window,
5696 /* The ICCCM says this is
5697 the only valid choice. */
5698 RevertToParent,
5699 event.xclient.data.l[1]);
5700 /* This is needed to detect the error
5701 if there is an error. */
5702 XSync (d, False);
5703 x_uncatch_errors ();
5705 /* Not certain about handling scroll bars here */
5706 #endif /* 0 */
5707 goto done;
5710 if (event.xclient.data.l[0]
5711 == dpyinfo->Xatom_wm_save_yourself)
5713 /* Save state modify the WM_COMMAND property to
5714 something which can reinstate us. This notifies
5715 the session manager, who's looking for such a
5716 PropertyNotify. Can restart processing when
5717 a keyboard or mouse event arrives. */
5718 /* If we have a session manager, don't set this.
5719 KDE will then start two Emacsen, one for the
5720 session manager and one for this. */
5721 #ifdef HAVE_X_SM
5722 if (! x_session_have_connection ())
5723 #endif
5725 f = x_top_window_to_frame (dpyinfo,
5726 event.xclient.window);
5727 /* This is just so we only give real data once
5728 for a single Emacs process. */
5729 if (f == SELECTED_FRAME ())
5730 XSetCommand (FRAME_X_DISPLAY (f),
5731 event.xclient.window,
5732 initial_argv, initial_argc);
5733 else if (f)
5734 XSetCommand (FRAME_X_DISPLAY (f),
5735 event.xclient.window,
5736 0, 0);
5738 goto done;
5741 if (event.xclient.data.l[0]
5742 == dpyinfo->Xatom_wm_delete_window)
5744 f = x_any_window_to_frame (dpyinfo,
5745 event.xclient.window);
5746 if (!f)
5747 goto OTHER; /* May be a dialog that is to be removed */
5749 inev.ie.kind = DELETE_WINDOW_EVENT;
5750 XSETFRAME (inev.ie.frame_or_window, f);
5751 goto done;
5754 goto done;
5757 if (event.xclient.message_type
5758 == dpyinfo->Xatom_wm_configure_denied)
5760 goto done;
5763 if (event.xclient.message_type
5764 == dpyinfo->Xatom_wm_window_moved)
5766 int new_x, new_y;
5767 f = x_window_to_frame (dpyinfo, event.xclient.window);
5769 new_x = event.xclient.data.s[0];
5770 new_y = event.xclient.data.s[1];
5772 if (f)
5774 f->left_pos = new_x;
5775 f->top_pos = new_y;
5777 goto done;
5780 #ifdef HACK_EDITRES
5781 if (event.xclient.message_type
5782 == dpyinfo->Xatom_editres)
5784 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5785 if (f)
5786 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5787 &event, NULL);
5788 goto done;
5790 #endif /* HACK_EDITRES */
5792 if ((event.xclient.message_type
5793 == dpyinfo->Xatom_DONE)
5794 || (event.xclient.message_type
5795 == dpyinfo->Xatom_PAGE))
5797 /* Ghostview job completed. Kill it. We could
5798 reply with "Next" if we received "Page", but we
5799 currently never do because we are interested in
5800 images, only, which should have 1 page. */
5801 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5802 f = x_window_to_frame (dpyinfo, event.xclient.window);
5803 if (!f)
5804 goto OTHER;
5805 x_kill_gs_process (pixmap, f);
5806 expose_frame (f, 0, 0, 0, 0);
5807 goto done;
5810 #ifdef USE_TOOLKIT_SCROLL_BARS
5811 /* Scroll bar callbacks send a ClientMessage from which
5812 we construct an input_event. */
5813 if (event.xclient.message_type
5814 == dpyinfo->Xatom_Scrollbar)
5816 x_scroll_bar_to_input_event (&event, &inev.ie);
5817 *finish = X_EVENT_GOTO_OUT;
5818 goto done;
5820 #endif /* USE_TOOLKIT_SCROLL_BARS */
5822 /* XEmbed messages from the embedder (if any). */
5823 if (event.xclient.message_type
5824 == dpyinfo->Xatom_XEMBED)
5826 enum xembed_message msg = event.xclient.data.l[1];
5827 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
5828 x_detect_focus_change (dpyinfo, &event, &inev.ie);
5830 *finish = X_EVENT_GOTO_OUT;
5831 goto done;
5834 xft_settings_event (dpyinfo, &event);
5836 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5837 if (!f)
5838 goto OTHER;
5839 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
5840 *finish = X_EVENT_DROP;
5842 break;
5844 case SelectionNotify:
5845 last_user_time = event.xselection.time;
5846 #ifdef USE_X_TOOLKIT
5847 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
5848 goto OTHER;
5849 #endif /* not USE_X_TOOLKIT */
5850 x_handle_selection_notify (&event.xselection);
5851 break;
5853 case SelectionClear: /* Someone has grabbed ownership. */
5854 last_user_time = event.xselectionclear.time;
5855 #ifdef USE_X_TOOLKIT
5856 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
5857 goto OTHER;
5858 #endif /* USE_X_TOOLKIT */
5860 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
5862 inev.ie.kind = SELECTION_CLEAR_EVENT;
5863 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
5864 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
5865 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
5866 inev.ie.frame_or_window = Qnil;
5868 break;
5870 case SelectionRequest: /* Someone wants our selection. */
5871 last_user_time = event.xselectionrequest.time;
5872 #ifdef USE_X_TOOLKIT
5873 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
5874 goto OTHER;
5875 #endif /* USE_X_TOOLKIT */
5877 XSelectionRequestEvent *eventp
5878 = (XSelectionRequestEvent *) &event;
5880 inev.ie.kind = SELECTION_REQUEST_EVENT;
5881 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
5882 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
5883 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
5884 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
5885 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
5886 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
5887 inev.ie.frame_or_window = Qnil;
5889 break;
5891 case PropertyNotify:
5892 last_user_time = event.xproperty.time;
5893 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
5894 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
5895 x_handle_net_wm_state (f, &event.xproperty);
5897 x_handle_property_notify (&event.xproperty);
5898 xft_settings_event (dpyinfo, &event);
5899 goto OTHER;
5901 case ReparentNotify:
5902 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
5903 if (f)
5905 int x, y;
5906 f->output_data.x->parent_desc = event.xreparent.parent;
5907 x_real_positions (f, &x, &y);
5908 f->left_pos = x;
5909 f->top_pos = y;
5911 /* Perhaps reparented due to a WM restart. Reset this. */
5912 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
5913 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
5915 goto OTHER;
5917 case Expose:
5918 f = x_window_to_frame (dpyinfo, event.xexpose.window);
5919 if (f)
5921 #ifdef USE_GTK
5922 /* This seems to be needed for GTK 2.6. */
5923 x_clear_area (event.xexpose.display,
5924 event.xexpose.window,
5925 event.xexpose.x, event.xexpose.y,
5926 event.xexpose.width, event.xexpose.height,
5927 FALSE);
5928 #endif
5929 if (f->async_visible == 0)
5931 f->async_visible = 1;
5932 f->async_iconified = 0;
5933 f->output_data.x->has_been_visible = 1;
5934 SET_FRAME_GARBAGED (f);
5936 else
5937 expose_frame (f,
5938 event.xexpose.x, event.xexpose.y,
5939 event.xexpose.width, event.xexpose.height);
5941 else
5943 #ifndef USE_TOOLKIT_SCROLL_BARS
5944 struct scroll_bar *bar;
5945 #endif
5946 #if defined USE_LUCID
5947 /* Submenus of the Lucid menu bar aren't widgets
5948 themselves, so there's no way to dispatch events
5949 to them. Recognize this case separately. */
5951 Widget widget
5952 = x_window_to_menu_bar (event.xexpose.window);
5953 if (widget)
5954 xlwmenu_redisplay (widget);
5956 #endif /* USE_LUCID */
5958 #ifdef USE_TOOLKIT_SCROLL_BARS
5959 /* Dispatch event to the widget. */
5960 goto OTHER;
5961 #else /* not USE_TOOLKIT_SCROLL_BARS */
5962 bar = x_window_to_scroll_bar (event.xexpose.display,
5963 event.xexpose.window);
5965 if (bar)
5966 x_scroll_bar_expose (bar, &event);
5967 #ifdef USE_X_TOOLKIT
5968 else
5969 goto OTHER;
5970 #endif /* USE_X_TOOLKIT */
5971 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5973 break;
5975 case GraphicsExpose: /* This occurs when an XCopyArea's
5976 source area was obscured or not
5977 available. */
5978 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
5979 if (f)
5981 expose_frame (f,
5982 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
5983 event.xgraphicsexpose.width,
5984 event.xgraphicsexpose.height);
5986 #ifdef USE_X_TOOLKIT
5987 else
5988 goto OTHER;
5989 #endif /* USE_X_TOOLKIT */
5990 break;
5992 case NoExpose: /* This occurs when an XCopyArea's
5993 source area was completely
5994 available. */
5995 break;
5997 case UnmapNotify:
5998 /* Redo the mouse-highlight after the tooltip has gone. */
5999 if (event.xmap.window == tip_window)
6001 tip_window = 0;
6002 redo_mouse_highlight ();
6005 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6006 if (f) /* F may no longer exist if
6007 the frame was deleted. */
6009 /* While a frame is unmapped, display generation is
6010 disabled; you don't want to spend time updating a
6011 display that won't ever be seen. */
6012 f->async_visible = 0;
6013 /* We can't distinguish, from the event, whether the window
6014 has become iconified or invisible. So assume, if it
6015 was previously visible, than now it is iconified.
6016 But x_make_frame_invisible clears both
6017 the visible flag and the iconified flag;
6018 and that way, we know the window is not iconified now. */
6019 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6021 f->async_iconified = 1;
6023 inev.ie.kind = ICONIFY_EVENT;
6024 XSETFRAME (inev.ie.frame_or_window, f);
6027 goto OTHER;
6029 case MapNotify:
6030 if (event.xmap.window == tip_window)
6031 /* The tooltip has been drawn already. Avoid
6032 the SET_FRAME_GARBAGED below. */
6033 goto OTHER;
6035 /* We use x_top_window_to_frame because map events can
6036 come for sub-windows and they don't mean that the
6037 frame is visible. */
6038 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6039 if (f)
6041 /* wait_reading_process_output will notice this and update
6042 the frame's display structures.
6043 If we where iconified, we should not set garbaged,
6044 because that stops redrawing on Expose events. This looks
6045 bad if we are called from a recursive event loop
6046 (x_dispatch_event), for example when a dialog is up. */
6047 if (! f->async_iconified)
6048 SET_FRAME_GARBAGED (f);
6050 /* Check if fullscreen was specified before we where mapped the
6051 first time, i.e. from the command line. */
6052 if (!f->output_data.x->has_been_visible)
6053 x_check_fullscreen (f);
6055 f->async_visible = 1;
6056 f->async_iconified = 0;
6057 f->output_data.x->has_been_visible = 1;
6059 if (f->iconified)
6061 inev.ie.kind = DEICONIFY_EVENT;
6062 XSETFRAME (inev.ie.frame_or_window, f);
6064 else if (! NILP (Vframe_list)
6065 && ! NILP (XCDR (Vframe_list)))
6066 /* Force a redisplay sooner or later
6067 to update the frame titles
6068 in case this is the second frame. */
6069 record_asynch_buffer_change ();
6071 #ifdef USE_GTK
6072 xg_frame_resized (f, -1, -1);
6073 #endif
6075 goto OTHER;
6077 case KeyPress:
6079 last_user_time = event.xkey.time;
6080 ignore_next_mouse_click_timeout = 0;
6082 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6083 /* Dispatch KeyPress events when in menu. */
6084 if (popup_activated ())
6085 goto OTHER;
6086 #endif
6088 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6090 /* If mouse-highlight is an integer, input clears out
6091 mouse highlighting. */
6092 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6093 && (f == 0
6094 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6096 clear_mouse_face (dpyinfo);
6097 dpyinfo->mouse_face_hidden = 1;
6100 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6101 if (f == 0)
6103 /* Scroll bars consume key events, but we want
6104 the keys to go to the scroll bar's frame. */
6105 Widget widget = XtWindowToWidget (dpyinfo->display,
6106 event.xkey.window);
6107 if (widget && XmIsScrollBar (widget))
6109 widget = XtParent (widget);
6110 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6113 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6115 if (f != 0)
6117 KeySym keysym, orig_keysym;
6118 /* al%imercury@uunet.uu.net says that making this 81
6119 instead of 80 fixed a bug whereby meta chars made
6120 his Emacs hang.
6122 It seems that some version of XmbLookupString has
6123 a bug of not returning XBufferOverflow in
6124 status_return even if the input is too long to
6125 fit in 81 bytes. So, we must prepare sufficient
6126 bytes for copy_buffer. 513 bytes (256 chars for
6127 two-byte character set) seems to be a fairly good
6128 approximation. -- 2000.8.10 handa@etl.go.jp */
6129 unsigned char copy_buffer[513];
6130 unsigned char *copy_bufptr = copy_buffer;
6131 int copy_bufsiz = sizeof (copy_buffer);
6132 int modifiers;
6133 Lisp_Object coding_system = Qlatin_1;
6134 Lisp_Object c;
6136 #ifdef USE_GTK
6137 /* Don't pass keys to GTK. A Tab will shift focus to the
6138 tool bar in GTK 2.4. Keys will still go to menus and
6139 dialogs because in that case popup_activated is TRUE
6140 (see above). */
6141 *finish = X_EVENT_DROP;
6142 #endif
6144 event.xkey.state
6145 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6146 extra_keyboard_modifiers);
6147 modifiers = event.xkey.state;
6149 /* This will have to go some day... */
6151 /* make_lispy_event turns chars into control chars.
6152 Don't do it here because XLookupString is too eager. */
6153 event.xkey.state &= ~ControlMask;
6154 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6155 | dpyinfo->super_mod_mask
6156 | dpyinfo->hyper_mod_mask
6157 | dpyinfo->alt_mod_mask);
6159 /* In case Meta is ComposeCharacter,
6160 clear its status. According to Markus Ehrnsperger
6161 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6162 this enables ComposeCharacter to work whether or
6163 not it is combined with Meta. */
6164 if (modifiers & dpyinfo->meta_mod_mask)
6165 memset (&compose_status, 0, sizeof (compose_status));
6167 #ifdef HAVE_X_I18N
6168 if (FRAME_XIC (f))
6170 Status status_return;
6172 coding_system = Vlocale_coding_system;
6173 nbytes = XmbLookupString (FRAME_XIC (f),
6174 &event.xkey, copy_bufptr,
6175 copy_bufsiz, &keysym,
6176 &status_return);
6177 if (status_return == XBufferOverflow)
6179 copy_bufsiz = nbytes + 1;
6180 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6181 nbytes = XmbLookupString (FRAME_XIC (f),
6182 &event.xkey, copy_bufptr,
6183 copy_bufsiz, &keysym,
6184 &status_return);
6186 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6187 if (status_return == XLookupNone)
6188 break;
6189 else if (status_return == XLookupChars)
6191 keysym = NoSymbol;
6192 modifiers = 0;
6194 else if (status_return != XLookupKeySym
6195 && status_return != XLookupBoth)
6196 abort ();
6198 else
6199 nbytes = XLookupString (&event.xkey, copy_bufptr,
6200 copy_bufsiz, &keysym,
6201 &compose_status);
6202 #else
6203 nbytes = XLookupString (&event.xkey, copy_bufptr,
6204 copy_bufsiz, &keysym,
6205 &compose_status);
6206 #endif
6208 /* If not using XIM/XIC, and a compose sequence is in progress,
6209 we break here. Otherwise, chars_matched is always 0. */
6210 if (compose_status.chars_matched > 0 && nbytes == 0)
6211 break;
6213 memset (&compose_status, 0, sizeof (compose_status));
6214 orig_keysym = keysym;
6216 /* Common for all keysym input events. */
6217 XSETFRAME (inev.ie.frame_or_window, f);
6218 inev.ie.modifiers
6219 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6220 inev.ie.timestamp = event.xkey.time;
6222 /* First deal with keysyms which have defined
6223 translations to characters. */
6224 if (keysym >= 32 && keysym < 128)
6225 /* Avoid explicitly decoding each ASCII character. */
6227 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6228 inev.ie.code = keysym;
6229 goto done_keysym;
6232 /* Keysyms directly mapped to Unicode characters. */
6233 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6235 if (keysym < 0x01000080)
6236 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6237 else
6238 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6239 inev.ie.code = keysym & 0xFFFFFF;
6240 goto done_keysym;
6243 /* Now non-ASCII. */
6244 if (HASH_TABLE_P (Vx_keysym_table)
6245 && (NATNUMP (c = Fgethash (make_number (keysym),
6246 Vx_keysym_table,
6247 Qnil))))
6249 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6250 ? ASCII_KEYSTROKE_EVENT
6251 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6252 inev.ie.code = XFASTINT (c);
6253 goto done_keysym;
6256 /* Random non-modifier sorts of keysyms. */
6257 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6258 || keysym == XK_Delete
6259 #ifdef XK_ISO_Left_Tab
6260 || (keysym >= XK_ISO_Left_Tab
6261 && keysym <= XK_ISO_Enter)
6262 #endif
6263 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6264 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6265 #ifdef HPUX
6266 /* This recognizes the "extended function
6267 keys". It seems there's no cleaner way.
6268 Test IsModifierKey to avoid handling
6269 mode_switch incorrectly. */
6270 || ((unsigned) (keysym) >= XK_Select
6271 && (unsigned)(keysym) < XK_KP_Space)
6272 #endif
6273 #ifdef XK_dead_circumflex
6274 || orig_keysym == XK_dead_circumflex
6275 #endif
6276 #ifdef XK_dead_grave
6277 || orig_keysym == XK_dead_grave
6278 #endif
6279 #ifdef XK_dead_tilde
6280 || orig_keysym == XK_dead_tilde
6281 #endif
6282 #ifdef XK_dead_diaeresis
6283 || orig_keysym == XK_dead_diaeresis
6284 #endif
6285 #ifdef XK_dead_macron
6286 || orig_keysym == XK_dead_macron
6287 #endif
6288 #ifdef XK_dead_degree
6289 || orig_keysym == XK_dead_degree
6290 #endif
6291 #ifdef XK_dead_acute
6292 || orig_keysym == XK_dead_acute
6293 #endif
6294 #ifdef XK_dead_cedilla
6295 || orig_keysym == XK_dead_cedilla
6296 #endif
6297 #ifdef XK_dead_breve
6298 || orig_keysym == XK_dead_breve
6299 #endif
6300 #ifdef XK_dead_ogonek
6301 || orig_keysym == XK_dead_ogonek
6302 #endif
6303 #ifdef XK_dead_caron
6304 || orig_keysym == XK_dead_caron
6305 #endif
6306 #ifdef XK_dead_doubleacute
6307 || orig_keysym == XK_dead_doubleacute
6308 #endif
6309 #ifdef XK_dead_abovedot
6310 || orig_keysym == XK_dead_abovedot
6311 #endif
6312 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6313 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6314 /* Any "vendor-specific" key is ok. */
6315 || (orig_keysym & (1 << 28))
6316 || (keysym != NoSymbol && nbytes == 0))
6317 && ! (IsModifierKey (orig_keysym)
6318 /* The symbols from XK_ISO_Lock
6319 to XK_ISO_Last_Group_Lock
6320 don't have real modifiers but
6321 should be treated similarly to
6322 Mode_switch by Emacs. */
6323 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6324 || ((unsigned)(orig_keysym)
6325 >= XK_ISO_Lock
6326 && (unsigned)(orig_keysym)
6327 <= XK_ISO_Last_Group_Lock)
6328 #endif
6331 STORE_KEYSYM_FOR_DEBUG (keysym);
6332 /* make_lispy_event will convert this to a symbolic
6333 key. */
6334 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6335 inev.ie.code = keysym;
6336 goto done_keysym;
6339 { /* Raw bytes, not keysym. */
6340 register int i;
6341 register int c;
6342 int nchars, len;
6344 for (i = 0, nchars = 0; i < nbytes; i++)
6346 if (ASCII_BYTE_P (copy_bufptr[i]))
6347 nchars++;
6348 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6351 if (nchars < nbytes)
6353 /* Decode the input data. */
6354 int require;
6355 unsigned char *p;
6357 /* The input should be decoded with `coding_system'
6358 which depends on which X*LookupString function
6359 we used just above and the locale. */
6360 setup_coding_system (coding_system, &coding);
6361 coding.src_multibyte = 0;
6362 coding.dst_multibyte = 1;
6363 /* The input is converted to events, thus we can't
6364 handle composition. Anyway, there's no XIM that
6365 gives us composition information. */
6366 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6368 require = MAX_MULTIBYTE_LENGTH * nbytes;
6369 coding.destination = alloca (require);
6370 coding.dst_bytes = require;
6371 coding.mode |= CODING_MODE_LAST_BLOCK;
6372 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6373 nbytes = coding.produced;
6374 nchars = coding.produced_char;
6375 copy_bufptr = coding.destination;
6378 /* Convert the input data to a sequence of
6379 character events. */
6380 for (i = 0; i < nbytes; i += len)
6382 if (nchars == nbytes)
6383 c = copy_bufptr[i], len = 1;
6384 else
6385 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6386 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6387 ? ASCII_KEYSTROKE_EVENT
6388 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6389 inev.ie.code = c;
6390 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6393 count += nchars;
6395 inev.ie.kind = NO_EVENT; /* Already stored above. */
6397 if (keysym == NoSymbol)
6398 break;
6401 done_keysym:
6402 #ifdef HAVE_X_I18N
6403 /* Don't dispatch this event since XtDispatchEvent calls
6404 XFilterEvent, and two calls in a row may freeze the
6405 client. */
6406 break;
6407 #else
6408 goto OTHER;
6409 #endif
6411 case KeyRelease:
6412 last_user_time = event.xkey.time;
6413 #ifdef HAVE_X_I18N
6414 /* Don't dispatch this event since XtDispatchEvent calls
6415 XFilterEvent, and two calls in a row may freeze the
6416 client. */
6417 break;
6418 #else
6419 goto OTHER;
6420 #endif
6422 case EnterNotify:
6423 last_user_time = event.xcrossing.time;
6424 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6426 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6428 if (f && x_mouse_click_focus_ignore_position)
6429 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6431 /* EnterNotify counts as mouse movement,
6432 so update things that depend on mouse position. */
6433 if (f && !f->output_data.x->hourglass_p)
6434 note_mouse_movement (f, &event.xmotion);
6435 #ifdef USE_GTK
6436 /* We may get an EnterNotify on the buttons in the toolbar. In that
6437 case we moved out of any highlighted area and need to note this. */
6438 if (!f && last_mouse_glyph_frame)
6439 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6440 #endif
6441 goto OTHER;
6443 case FocusIn:
6444 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6445 goto OTHER;
6447 case LeaveNotify:
6448 last_user_time = event.xcrossing.time;
6449 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6451 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6452 if (f)
6454 if (f == dpyinfo->mouse_face_mouse_frame)
6456 /* If we move outside the frame, then we're
6457 certainly no longer on any text in the frame. */
6458 clear_mouse_face (dpyinfo);
6459 dpyinfo->mouse_face_mouse_frame = 0;
6462 /* Generate a nil HELP_EVENT to cancel a help-echo.
6463 Do it only if there's something to cancel.
6464 Otherwise, the startup message is cleared when
6465 the mouse leaves the frame. */
6466 if (any_help_event_p)
6467 do_help = -1;
6469 #ifdef USE_GTK
6470 /* See comment in EnterNotify above */
6471 else if (last_mouse_glyph_frame)
6472 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6473 #endif
6474 goto OTHER;
6476 case FocusOut:
6477 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6478 goto OTHER;
6480 case MotionNotify:
6482 last_user_time = event.xmotion.time;
6483 previous_help_echo_string = help_echo_string;
6484 help_echo_string = Qnil;
6486 if (dpyinfo->grabbed && last_mouse_frame
6487 && FRAME_LIVE_P (last_mouse_frame))
6488 f = last_mouse_frame;
6489 else
6490 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6492 if (dpyinfo->mouse_face_hidden)
6494 dpyinfo->mouse_face_hidden = 0;
6495 clear_mouse_face (dpyinfo);
6498 #ifdef USE_GTK
6499 if (f && xg_event_is_for_scrollbar (f, &event))
6500 f = 0;
6501 #endif
6502 if (f)
6505 /* Generate SELECT_WINDOW_EVENTs when needed.
6506 Don't let popup menus influence things (bug#1261). */
6507 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6509 Lisp_Object window;
6511 window = window_from_coordinates (f,
6512 event.xmotion.x, event.xmotion.y,
6513 0, 0, 0, 0);
6515 /* Window will be selected only when it is not selected now and
6516 last mouse movement event was not in it. Minibuffer window
6517 will be selected only when it is active. */
6518 if (WINDOWP (window)
6519 && !EQ (window, last_window)
6520 && !EQ (window, selected_window)
6521 /* For click-to-focus window managers
6522 create event iff we don't leave the
6523 selected frame. */
6524 && (focus_follows_mouse
6525 || (EQ (XWINDOW (window)->frame,
6526 XWINDOW (selected_window)->frame))))
6528 inev.ie.kind = SELECT_WINDOW_EVENT;
6529 inev.ie.frame_or_window = window;
6532 last_window=window;
6534 if (!note_mouse_movement (f, &event.xmotion))
6535 help_echo_string = previous_help_echo_string;
6537 else
6539 #ifndef USE_TOOLKIT_SCROLL_BARS
6540 struct scroll_bar *bar
6541 = x_window_to_scroll_bar (event.xmotion.display,
6542 event.xmotion.window);
6544 if (bar)
6545 x_scroll_bar_note_movement (bar, &event);
6546 #endif /* USE_TOOLKIT_SCROLL_BARS */
6548 /* If we move outside the frame, then we're
6549 certainly no longer on any text in the frame. */
6550 clear_mouse_face (dpyinfo);
6553 /* If the contents of the global variable help_echo_string
6554 has changed, generate a HELP_EVENT. */
6555 if (!NILP (help_echo_string)
6556 || !NILP (previous_help_echo_string))
6557 do_help = 1;
6558 goto OTHER;
6561 case ConfigureNotify:
6562 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6563 #ifdef USE_GTK
6564 if (!f
6565 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6566 && event.xconfigure.window == FRAME_X_WINDOW (f))
6568 xg_frame_resized (f, event.xconfigure.width,
6569 event.xconfigure.height);
6570 f = 0;
6572 #endif
6573 if (f)
6575 #ifndef USE_X_TOOLKIT
6576 #ifndef USE_GTK
6577 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6578 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6580 /* In the toolkit version, change_frame_size
6581 is called by the code that handles resizing
6582 of the EmacsFrame widget. */
6584 /* Even if the number of character rows and columns has
6585 not changed, the font size may have changed, so we need
6586 to check the pixel dimensions as well. */
6587 if (columns != FRAME_COLS (f)
6588 || rows != FRAME_LINES (f)
6589 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6590 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6592 change_frame_size (f, rows, columns, 0, 1, 0);
6593 SET_FRAME_GARBAGED (f);
6594 cancel_mouse_face (f);
6597 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6598 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6599 #endif /* not USE_GTK */
6600 #endif
6602 #ifdef USE_GTK
6603 /* GTK creates windows but doesn't map them.
6604 Only get real positions when mapped. */
6605 if (FRAME_GTK_OUTER_WIDGET (f)
6606 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6607 #endif
6609 x_real_positions (f, &f->left_pos, &f->top_pos);
6612 #ifdef HAVE_X_I18N
6613 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6614 xic_set_statusarea (f);
6615 #endif
6618 goto OTHER;
6620 case ButtonRelease:
6621 case ButtonPress:
6623 /* If we decide we want to generate an event to be seen
6624 by the rest of Emacs, we put it here. */
6625 int tool_bar_p = 0;
6627 memset (&compose_status, 0, sizeof (compose_status));
6628 last_mouse_glyph_frame = 0;
6629 last_user_time = event.xbutton.time;
6631 if (dpyinfo->grabbed
6632 && 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.xbutton.window);
6638 #ifdef USE_GTK
6639 if (f && xg_event_is_for_scrollbar (f, &event))
6640 f = 0;
6641 #endif
6642 if (f)
6644 /* Is this in the tool-bar? */
6645 if (WINDOWP (f->tool_bar_window)
6646 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6648 Lisp_Object window;
6649 int x = event.xbutton.x;
6650 int y = event.xbutton.y;
6652 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6653 tool_bar_p = EQ (window, f->tool_bar_window);
6655 if (tool_bar_p && event.xbutton.button < 4)
6657 handle_tool_bar_click (f, x, y,
6658 event.xbutton.type == ButtonPress,
6659 x_x_to_emacs_modifiers (dpyinfo,
6660 event.xbutton.state));
6664 if (!tool_bar_p)
6665 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6666 if (! popup_activated ())
6667 #endif
6669 if (ignore_next_mouse_click_timeout)
6671 if (event.type == ButtonPress
6672 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6674 ignore_next_mouse_click_timeout = 0;
6675 construct_mouse_click (&inev.ie, &event.xbutton, f);
6677 if (event.type == ButtonRelease)
6678 ignore_next_mouse_click_timeout = 0;
6680 else
6681 construct_mouse_click (&inev.ie, &event.xbutton, f);
6683 if (FRAME_X_EMBEDDED_P (f))
6684 xembed_send_message (f, event.xbutton.time,
6685 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6687 else
6689 struct scroll_bar *bar
6690 = x_window_to_scroll_bar (event.xbutton.display,
6691 event.xbutton.window);
6693 #ifdef USE_TOOLKIT_SCROLL_BARS
6694 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6695 scroll bars. */
6696 if (bar && event.xbutton.state & ControlMask)
6698 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6699 *finish = X_EVENT_DROP;
6701 #else /* not USE_TOOLKIT_SCROLL_BARS */
6702 if (bar)
6703 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6704 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6707 if (event.type == ButtonPress)
6709 dpyinfo->grabbed |= (1 << event.xbutton.button);
6710 last_mouse_frame = f;
6712 if (!tool_bar_p)
6713 last_tool_bar_item = -1;
6715 else
6716 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6718 /* Ignore any mouse motion that happened before this event;
6719 any subsequent mouse-movement Emacs events should reflect
6720 only motion after the ButtonPress/Release. */
6721 if (f != 0)
6722 f->mouse_moved = 0;
6724 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6725 f = x_menubar_window_to_frame (dpyinfo, &event);
6726 /* For a down-event in the menu bar,
6727 don't pass it to Xt right now.
6728 Instead, save it away
6729 and we will pass it to Xt from kbd_buffer_get_event.
6730 That way, we can run some Lisp code first. */
6731 if (! popup_activated ()
6732 #ifdef USE_GTK
6733 /* Gtk+ menus only react to the first three buttons. */
6734 && event.xbutton.button < 3
6735 #endif
6736 && f && event.type == ButtonPress
6737 /* Verify the event is really within the menu bar
6738 and not just sent to it due to grabbing. */
6739 && event.xbutton.x >= 0
6740 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6741 && event.xbutton.y >= 0
6742 && event.xbutton.y < f->output_data.x->menubar_height
6743 && event.xbutton.same_screen)
6745 SET_SAVED_BUTTON_EVENT;
6746 XSETFRAME (last_mouse_press_frame, f);
6747 *finish = X_EVENT_DROP;
6749 else if (event.type == ButtonPress)
6751 last_mouse_press_frame = Qnil;
6752 goto OTHER;
6754 else
6755 goto OTHER;
6756 #endif /* USE_X_TOOLKIT || USE_GTK */
6758 break;
6760 case CirculateNotify:
6761 goto OTHER;
6763 case CirculateRequest:
6764 goto OTHER;
6766 case VisibilityNotify:
6767 goto OTHER;
6769 case MappingNotify:
6770 /* Someone has changed the keyboard mapping - update the
6771 local cache. */
6772 switch (event.xmapping.request)
6774 case MappingModifier:
6775 x_find_modifier_meanings (dpyinfo);
6776 /* This is meant to fall through. */
6777 case MappingKeyboard:
6778 XRefreshKeyboardMapping (&event.xmapping);
6780 goto OTHER;
6782 case DestroyNotify:
6783 xft_settings_event (dpyinfo, &event);
6784 break;
6786 default:
6787 OTHER:
6788 #ifdef USE_X_TOOLKIT
6789 BLOCK_INPUT;
6790 if (*finish != X_EVENT_DROP)
6791 XtDispatchEvent (&event);
6792 UNBLOCK_INPUT;
6793 #endif /* USE_X_TOOLKIT */
6794 break;
6797 done:
6798 if (inev.ie.kind != NO_EVENT)
6800 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6801 count++;
6804 if (do_help
6805 && !(hold_quit && hold_quit->kind != NO_EVENT))
6807 Lisp_Object frame;
6809 if (f)
6810 XSETFRAME (frame, f);
6811 else
6812 frame = Qnil;
6814 if (do_help > 0)
6816 any_help_event_p = 1;
6817 gen_help_event (help_echo_string, frame, help_echo_window,
6818 help_echo_object, help_echo_pos);
6820 else
6822 help_echo_string = Qnil;
6823 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6825 count++;
6828 *eventp = event;
6829 return count;
6833 /* Handles the XEvent EVENT on display DISPLAY.
6834 This is used for event loops outside the normal event handling,
6835 i.e. looping while a popup menu or a dialog is posted.
6837 Returns the value handle_one_xevent sets in the finish argument. */
6839 x_dispatch_event (XEvent *event, Display *display)
6841 struct x_display_info *dpyinfo;
6842 int finish = X_EVENT_NORMAL;
6844 dpyinfo = x_display_info_for_display (display);
6846 if (dpyinfo)
6847 handle_one_xevent (dpyinfo, event, &finish, 0);
6849 return finish;
6853 /* Read events coming from the X server.
6854 This routine is called by the SIGIO handler.
6855 We return as soon as there are no more events to be read.
6857 We return the number of characters stored into the buffer,
6858 thus pretending to be `read' (except the characters we store
6859 in the keyboard buffer can be multibyte, so are not necessarily
6860 C chars).
6862 EXPECTED is nonzero if the caller knows input is available. */
6864 static int
6865 XTread_socket (struct terminal *terminal, int expected, struct input_event *hold_quit)
6867 int count = 0;
6868 XEvent event;
6869 int event_found = 0;
6871 if (interrupt_input_blocked)
6873 interrupt_input_pending = 1;
6874 #ifdef SYNC_INPUT
6875 pending_signals = 1;
6876 #endif
6877 return -1;
6880 interrupt_input_pending = 0;
6881 #ifdef SYNC_INPUT
6882 pending_signals = pending_atimers;
6883 #endif
6884 BLOCK_INPUT;
6886 /* So people can tell when we have read the available input. */
6887 input_signal_count++;
6889 ++handling_signal;
6891 #ifdef HAVE_X_SM
6892 /* Only check session manager input for the primary display. */
6893 if (terminal->id == 1 && x_session_have_connection ())
6895 struct input_event inev;
6896 BLOCK_INPUT;
6897 /* We don't need to EVENT_INIT (inev) here, as
6898 x_session_check_input copies an entire input_event. */
6899 if (x_session_check_input (&inev))
6901 kbd_buffer_store_event_hold (&inev, hold_quit);
6902 count++;
6904 UNBLOCK_INPUT;
6906 #endif
6908 /* For debugging, this gives a way to fake an I/O error. */
6909 if (terminal->display_info.x == XTread_socket_fake_io_error)
6911 XTread_socket_fake_io_error = 0;
6912 x_io_error_quitter (terminal->display_info.x->display);
6915 #ifndef USE_GTK
6916 while (XPending (terminal->display_info.x->display))
6918 int finish;
6920 XNextEvent (terminal->display_info.x->display, &event);
6922 #ifdef HAVE_X_I18N
6923 /* Filter events for the current X input method. */
6924 if (x_filter_event (terminal->display_info.x, &event))
6925 continue;
6926 #endif
6927 event_found = 1;
6929 count += handle_one_xevent (terminal->display_info.x,
6930 &event, &finish, hold_quit);
6932 if (finish == X_EVENT_GOTO_OUT)
6933 goto out;
6936 #else /* USE_GTK */
6938 /* For GTK we must use the GTK event loop. But XEvents gets passed
6939 to our filter function above, and then to the big event switch.
6940 We use a bunch of globals to communicate with our filter function,
6941 that is kind of ugly, but it works.
6943 There is no way to do one display at the time, GTK just does events
6944 from all displays. */
6946 while (gtk_events_pending ())
6948 current_count = count;
6949 current_hold_quit = hold_quit;
6951 gtk_main_iteration ();
6953 count = current_count;
6954 current_count = -1;
6955 current_hold_quit = 0;
6957 if (current_finish == X_EVENT_GOTO_OUT)
6958 break;
6960 #endif /* USE_GTK */
6962 out:;
6964 /* On some systems, an X bug causes Emacs to get no more events
6965 when the window is destroyed. Detect that. (1994.) */
6966 if (! event_found)
6968 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
6969 One XNOOP in 100 loops will make Emacs terminate.
6970 B. Bretthauer, 1994 */
6971 x_noop_count++;
6972 if (x_noop_count >= 100)
6974 x_noop_count=0;
6976 if (next_noop_dpyinfo == 0)
6977 next_noop_dpyinfo = x_display_list;
6979 XNoOp (next_noop_dpyinfo->display);
6981 /* Each time we get here, cycle through the displays now open. */
6982 next_noop_dpyinfo = next_noop_dpyinfo->next;
6986 /* If the focus was just given to an auto-raising frame,
6987 raise it now. */
6988 /* ??? This ought to be able to handle more than one such frame. */
6989 if (pending_autoraise_frame)
6991 x_raise_frame (pending_autoraise_frame);
6992 pending_autoraise_frame = 0;
6995 --handling_signal;
6996 UNBLOCK_INPUT;
6998 return count;
7004 /***********************************************************************
7005 Text Cursor
7006 ***********************************************************************/
7008 /* Set clipping for output in glyph row ROW. W is the window in which
7009 we operate. GC is the graphics context to set clipping in.
7011 ROW may be a text row or, e.g., a mode line. Text rows must be
7012 clipped to the interior of the window dedicated to text display,
7013 mode lines must be clipped to the whole window. */
7015 static void
7016 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7018 struct frame *f = XFRAME (WINDOW_FRAME (w));
7019 XRectangle clip_rect;
7020 int window_x, window_y, window_width;
7022 window_box (w, area, &window_x, &window_y, &window_width, 0);
7024 clip_rect.x = window_x;
7025 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7026 clip_rect.y = max (clip_rect.y, window_y);
7027 clip_rect.width = window_width;
7028 clip_rect.height = row->visible_height;
7030 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7034 /* Draw a hollow box cursor on window W in glyph row ROW. */
7036 static void
7037 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7039 struct frame *f = XFRAME (WINDOW_FRAME (w));
7040 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7041 Display *dpy = FRAME_X_DISPLAY (f);
7042 int x, y, wd, h;
7043 XGCValues xgcv;
7044 struct glyph *cursor_glyph;
7045 GC gc;
7047 /* Get the glyph the cursor is on. If we can't tell because
7048 the current matrix is invalid or such, give up. */
7049 cursor_glyph = get_phys_cursor_glyph (w);
7050 if (cursor_glyph == NULL)
7051 return;
7053 /* Compute frame-relative coordinates for phys cursor. */
7054 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7055 wd = w->phys_cursor_width;
7057 /* The foreground of cursor_gc is typically the same as the normal
7058 background color, which can cause the cursor box to be invisible. */
7059 xgcv.foreground = f->output_data.x->cursor_pixel;
7060 if (dpyinfo->scratch_cursor_gc)
7061 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7062 else
7063 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7064 GCForeground, &xgcv);
7065 gc = dpyinfo->scratch_cursor_gc;
7067 /* Set clipping, draw the rectangle, and reset clipping again. */
7068 x_clip_to_row (w, row, TEXT_AREA, gc);
7069 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7070 XSetClipMask (dpy, gc, None);
7074 /* Draw a bar cursor on window W in glyph row ROW.
7076 Implementation note: One would like to draw a bar cursor with an
7077 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7078 Unfortunately, I didn't find a font yet that has this property set.
7079 --gerd. */
7081 static void
7082 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7084 struct frame *f = XFRAME (w->frame);
7085 struct glyph *cursor_glyph;
7087 /* If cursor is out of bounds, don't draw garbage. This can happen
7088 in mini-buffer windows when switching between echo area glyphs
7089 and mini-buffer. */
7090 cursor_glyph = get_phys_cursor_glyph (w);
7091 if (cursor_glyph == NULL)
7092 return;
7094 /* If on an image, draw like a normal cursor. That's usually better
7095 visible than drawing a bar, esp. if the image is large so that
7096 the bar might not be in the window. */
7097 if (cursor_glyph->type == IMAGE_GLYPH)
7099 struct glyph_row *row;
7100 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7101 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7103 else
7105 Display *dpy = FRAME_X_DISPLAY (f);
7106 Window window = FRAME_X_WINDOW (f);
7107 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7108 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7109 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7110 XGCValues xgcv;
7112 /* If the glyph's background equals the color we normally draw
7113 the bars cursor in, the bar cursor in its normal color is
7114 invisible. Use the glyph's foreground color instead in this
7115 case, on the assumption that the glyph's colors are chosen so
7116 that the glyph is legible. */
7117 if (face->background == f->output_data.x->cursor_pixel)
7118 xgcv.background = xgcv.foreground = face->foreground;
7119 else
7120 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7121 xgcv.graphics_exposures = 0;
7123 if (gc)
7124 XChangeGC (dpy, gc, mask, &xgcv);
7125 else
7127 gc = XCreateGC (dpy, window, mask, &xgcv);
7128 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7131 x_clip_to_row (w, row, TEXT_AREA, gc);
7133 if (kind == BAR_CURSOR)
7135 if (width < 0)
7136 width = FRAME_CURSOR_WIDTH (f);
7137 width = min (cursor_glyph->pixel_width, width);
7139 w->phys_cursor_width = width;
7141 XFillRectangle (dpy, window, gc,
7142 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7143 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7144 width, row->height);
7146 else
7148 int dummy_x, dummy_y, dummy_h;
7150 if (width < 0)
7151 width = row->height;
7153 width = min (row->height, width);
7155 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7156 &dummy_y, &dummy_h);
7158 XFillRectangle (dpy, window, gc,
7159 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7160 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7161 row->height - width),
7162 w->phys_cursor_width, width);
7165 XSetClipMask (dpy, gc, None);
7170 /* RIF: Define cursor CURSOR on frame F. */
7172 static void
7173 x_define_frame_cursor (struct frame *f, Cursor cursor)
7175 if (!f->pointer_invisible
7176 && f->output_data.x->current_cursor != cursor)
7177 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7178 f->output_data.x->current_cursor = cursor;
7182 /* RIF: Clear area on frame F. */
7184 static void
7185 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7187 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7188 x, y, width, height, False);
7189 #ifdef USE_GTK
7190 /* Must queue a redraw, because scroll bars might have been cleared. */
7191 if (FRAME_GTK_WIDGET (f))
7192 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7193 #endif
7197 /* RIF: Draw cursor on window W. */
7199 static void
7200 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)
7202 struct frame *f = XFRAME (WINDOW_FRAME (w));
7204 if (on_p)
7206 w->phys_cursor_type = cursor_type;
7207 w->phys_cursor_on_p = 1;
7209 if (glyph_row->exact_window_width_line_p
7210 && (glyph_row->reversed_p
7211 ? (w->phys_cursor.hpos < 0)
7212 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7214 glyph_row->cursor_in_fringe_p = 1;
7215 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7217 else
7219 switch (cursor_type)
7221 case HOLLOW_BOX_CURSOR:
7222 x_draw_hollow_cursor (w, glyph_row);
7223 break;
7225 case FILLED_BOX_CURSOR:
7226 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7227 break;
7229 case BAR_CURSOR:
7230 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7231 break;
7233 case HBAR_CURSOR:
7234 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7235 break;
7237 case NO_CURSOR:
7238 w->phys_cursor_width = 0;
7239 break;
7241 default:
7242 abort ();
7246 #ifdef HAVE_X_I18N
7247 if (w == XWINDOW (f->selected_window))
7248 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7249 xic_set_preeditarea (w, x, y);
7250 #endif
7253 #ifndef XFlush
7254 XFlush (FRAME_X_DISPLAY (f));
7255 #endif
7259 /* Icons. */
7261 /* Make the x-window of frame F use the gnu icon bitmap. */
7264 x_bitmap_icon (struct frame *f, Lisp_Object file)
7266 int bitmap_id;
7268 if (FRAME_X_WINDOW (f) == 0)
7269 return 1;
7271 /* Free up our existing icon bitmap and mask if any. */
7272 if (f->output_data.x->icon_bitmap > 0)
7273 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7274 f->output_data.x->icon_bitmap = 0;
7276 if (STRINGP (file))
7278 #ifdef USE_GTK
7279 /* Use gtk_window_set_icon_from_file () if available,
7280 It's not restricted to bitmaps */
7281 if (xg_set_icon (f, file))
7282 return 0;
7283 #endif /* USE_GTK */
7284 bitmap_id = x_create_bitmap_from_file (f, file);
7285 x_create_bitmap_mask (f, bitmap_id);
7287 else
7289 /* Create the GNU bitmap and mask if necessary. */
7290 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7292 int rc = -1;
7294 #ifdef USE_GTK
7296 if (xg_set_icon (f, xg_default_icon_file)
7297 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7298 return 0;
7300 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7302 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7303 if (rc != -1)
7304 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7306 #endif
7308 /* If all else fails, use the (black and white) xbm image. */
7309 if (rc == -1)
7311 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7312 gnu_xbm_width, gnu_xbm_height);
7313 if (rc == -1)
7314 return 1;
7316 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7317 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7321 /* The first time we create the GNU bitmap and mask,
7322 this increments the ref-count one extra time.
7323 As a result, the GNU bitmap and mask are never freed.
7324 That way, we don't have to worry about allocating it again. */
7325 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7327 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7330 x_wm_set_icon_pixmap (f, bitmap_id);
7331 f->output_data.x->icon_bitmap = bitmap_id;
7333 return 0;
7337 /* Make the x-window of frame F use a rectangle with text.
7338 Use ICON_NAME as the text. */
7341 x_text_icon (struct frame *f, const char *icon_name)
7343 if (FRAME_X_WINDOW (f) == 0)
7344 return 1;
7347 XTextProperty text;
7348 text.value = (unsigned char *) icon_name;
7349 text.encoding = XA_STRING;
7350 text.format = 8;
7351 text.nitems = strlen (icon_name);
7352 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7355 if (f->output_data.x->icon_bitmap > 0)
7356 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7357 f->output_data.x->icon_bitmap = 0;
7358 x_wm_set_icon_pixmap (f, 0);
7360 return 0;
7363 #define X_ERROR_MESSAGE_SIZE 200
7365 /* If non-nil, this should be a string.
7366 It means catch X errors and store the error message in this string.
7368 The reason we use a stack is that x_catch_error/x_uncatch_error can
7369 be called from a signal handler.
7372 struct x_error_message_stack {
7373 char string[X_ERROR_MESSAGE_SIZE];
7374 Display *dpy;
7375 struct x_error_message_stack *prev;
7377 static struct x_error_message_stack *x_error_message;
7379 /* An X error handler which stores the error message in
7380 *x_error_message. This is called from x_error_handler if
7381 x_catch_errors is in effect. */
7383 static void
7384 x_error_catcher (Display *display, XErrorEvent *error)
7386 XGetErrorText (display, error->error_code,
7387 x_error_message->string,
7388 X_ERROR_MESSAGE_SIZE);
7391 /* Begin trapping X errors for display DPY. Actually we trap X errors
7392 for all displays, but DPY should be the display you are actually
7393 operating on.
7395 After calling this function, X protocol errors no longer cause
7396 Emacs to exit; instead, they are recorded in the string
7397 stored in *x_error_message.
7399 Calling x_check_errors signals an Emacs error if an X error has
7400 occurred since the last call to x_catch_errors or x_check_errors.
7402 Calling x_uncatch_errors resumes the normal error handling. */
7404 void x_check_errors (Display *dpy, const char *format);
7406 void
7407 x_catch_errors (Display *dpy)
7409 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7411 /* Make sure any errors from previous requests have been dealt with. */
7412 XSync (dpy, False);
7414 data->dpy = dpy;
7415 data->string[0] = 0;
7416 data->prev = x_error_message;
7417 x_error_message = data;
7420 /* Undo the last x_catch_errors call.
7421 DPY should be the display that was passed to x_catch_errors. */
7423 void
7424 x_uncatch_errors (void)
7426 struct x_error_message_stack *tmp;
7428 BLOCK_INPUT;
7430 /* The display may have been closed before this function is called.
7431 Check if it is still open before calling XSync. */
7432 if (x_display_info_for_display (x_error_message->dpy) != 0)
7433 XSync (x_error_message->dpy, False);
7435 tmp = x_error_message;
7436 x_error_message = x_error_message->prev;
7437 xfree (tmp);
7438 UNBLOCK_INPUT;
7441 /* If any X protocol errors have arrived since the last call to
7442 x_catch_errors or x_check_errors, signal an Emacs error using
7443 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7445 void
7446 x_check_errors (Display *dpy, const char *format)
7448 /* Make sure to catch any errors incurred so far. */
7449 XSync (dpy, False);
7451 if (x_error_message->string[0])
7453 char string[X_ERROR_MESSAGE_SIZE];
7454 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7455 x_uncatch_errors ();
7456 error (format, string);
7460 /* Nonzero if we had any X protocol errors
7461 since we did x_catch_errors on DPY. */
7464 x_had_errors_p (Display *dpy)
7466 /* Make sure to catch any errors incurred so far. */
7467 XSync (dpy, False);
7469 return x_error_message->string[0] != 0;
7472 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7474 void
7475 x_clear_errors (Display *dpy)
7477 x_error_message->string[0] = 0;
7480 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7481 * idea. --lorentey */
7482 /* Close off all unclosed x_catch_errors calls. */
7484 void
7485 x_fully_uncatch_errors (void)
7487 while (x_error_message)
7488 x_uncatch_errors ();
7490 #endif
7492 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7495 x_catching_errors (void)
7497 return x_error_message != 0;
7500 #if 0
7501 static unsigned int x_wire_count;
7502 x_trace_wire (void)
7504 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7506 #endif /* ! 0 */
7509 /* Handle SIGPIPE, which can happen when the connection to a server
7510 simply goes away. SIGPIPE is handled by x_connection_signal.
7511 Don't need to do anything, because the write which caused the
7512 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7513 which will do the appropriate cleanup for us. */
7515 static SIGTYPE
7516 x_connection_signal (int signalnum) /* If we don't have an argument, */
7517 /* some compilers complain in signal calls. */
7519 #ifdef USG
7520 /* USG systems forget handlers when they are used;
7521 must reestablish each time */
7522 signal (signalnum, x_connection_signal);
7523 #endif /* USG */
7527 /************************************************************************
7528 Handling X errors
7529 ************************************************************************/
7531 /* Error message passed to x_connection_closed. */
7533 static char *error_msg;
7535 /* Function installed as fatal_error_signal_hook in
7536 x_connection_closed. Print the X error message, and exit normally,
7537 instead of dumping core when XtCloseDisplay fails. */
7539 static void
7540 x_fatal_error_signal (void)
7542 fprintf (stderr, "%s\n", error_msg);
7543 exit (70);
7546 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7547 the text of an error message that lead to the connection loss. */
7549 static SIGTYPE
7550 x_connection_closed (Display *dpy, const char *error_message)
7552 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7553 Lisp_Object frame, tail;
7554 int index = SPECPDL_INDEX ();
7556 error_msg = (char *) alloca (strlen (error_message) + 1);
7557 strcpy (error_msg, error_message);
7558 handling_signal = 0;
7560 /* Prevent being called recursively because of an error condition
7561 below. Otherwise, we might end up with printing ``can't find per
7562 display information'' in the recursive call instead of printing
7563 the original message here. */
7564 x_catch_errors (dpy);
7566 /* Inhibit redisplay while frames are being deleted. */
7567 specbind (Qinhibit_redisplay, Qt);
7569 if (dpyinfo)
7571 /* Protect display from being closed when we delete the last
7572 frame on it. */
7573 dpyinfo->reference_count++;
7574 dpyinfo->terminal->reference_count++;
7577 /* First delete frames whose mini-buffers are on frames
7578 that are on the dead display. */
7579 FOR_EACH_FRAME (tail, frame)
7581 Lisp_Object minibuf_frame;
7582 minibuf_frame
7583 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7584 if (FRAME_X_P (XFRAME (frame))
7585 && FRAME_X_P (XFRAME (minibuf_frame))
7586 && ! EQ (frame, minibuf_frame)
7587 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7588 delete_frame (frame, Qnoelisp);
7591 /* Now delete all remaining frames on the dead display.
7592 We are now sure none of these is used as the mini-buffer
7593 for another frame that we need to delete. */
7594 FOR_EACH_FRAME (tail, frame)
7595 if (FRAME_X_P (XFRAME (frame))
7596 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7598 /* Set this to t so that delete_frame won't get confused
7599 trying to find a replacement. */
7600 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7601 delete_frame (frame, Qnoelisp);
7604 /* We have to close the display to inform Xt that it doesn't
7605 exist anymore. If we don't, Xt will continue to wait for
7606 events from the display. As a consequence, a sequence of
7608 M-x make-frame-on-display RET :1 RET
7609 ...kill the new frame, so that we get an IO error...
7610 M-x make-frame-on-display RET :1 RET
7612 will indefinitely wait in Xt for events for display `:1', opened
7613 in the first call to make-frame-on-display.
7615 Closing the display is reported to lead to a bus error on
7616 OpenWindows in certain situations. I suspect that is a bug
7617 in OpenWindows. I don't know how to circumvent it here. */
7619 if (dpyinfo)
7621 #ifdef USE_X_TOOLKIT
7622 /* If DPYINFO is null, this means we didn't open the display
7623 in the first place, so don't try to close it. */
7625 fatal_error_signal_hook = x_fatal_error_signal;
7626 XtCloseDisplay (dpy);
7627 fatal_error_signal_hook = NULL;
7629 #endif
7631 #ifdef USE_GTK
7632 /* Due to bugs in some Gtk+ versions, just exit here if this
7633 is the last display/terminal. */
7634 if (terminal_list->next_terminal == NULL)
7636 fprintf (stderr, "%s\n", error_msg);
7637 Fkill_emacs (make_number (70));
7638 /* NOTREACHED */
7640 xg_display_close (dpyinfo->display);
7641 #endif
7643 /* Indicate that this display is dead. */
7644 dpyinfo->display = 0;
7646 dpyinfo->reference_count--;
7647 dpyinfo->terminal->reference_count--;
7648 if (dpyinfo->reference_count != 0)
7649 /* We have just closed all frames on this display. */
7650 abort ();
7653 Lisp_Object tmp;
7654 XSETTERMINAL (tmp, dpyinfo->terminal);
7655 Fdelete_terminal (tmp, Qnoelisp);
7659 x_uncatch_errors ();
7661 if (terminal_list == 0)
7663 fprintf (stderr, "%s\n", error_msg);
7664 Fkill_emacs (make_number (70));
7665 /* NOTREACHED */
7668 /* Ordinary stack unwind doesn't deal with these. */
7669 #ifdef SIGIO
7670 sigunblock (sigmask (SIGIO));
7671 #endif
7672 sigunblock (sigmask (SIGALRM));
7673 TOTALLY_UNBLOCK_INPUT;
7675 unbind_to (index, Qnil);
7676 clear_waiting_for_input ();
7677 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7678 longjmp), because returning from this function would get us back into
7679 Xlib's code which will directly call `exit'. */
7680 error ("%s", error_msg);
7683 /* We specifically use it before defining it, so that gcc doesn't inline it,
7684 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7685 static void x_error_quitter (Display *, XErrorEvent *);
7687 /* This is the first-level handler for X protocol errors.
7688 It calls x_error_quitter or x_error_catcher. */
7690 static int
7691 x_error_handler (Display *display, XErrorEvent *error)
7693 if (x_error_message)
7694 x_error_catcher (display, error);
7695 else
7696 x_error_quitter (display, error);
7697 return 0;
7700 /* This is the usual handler for X protocol errors.
7701 It kills all frames on the display that we got the error for.
7702 If that was the only one, it prints an error message and kills Emacs. */
7704 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7706 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7707 #define NO_INLINE __attribute__((noinline))
7708 #else
7709 #define NO_INLINE
7710 #endif
7712 /* Some versions of GNU/Linux define noinline in their headers. */
7714 #ifdef noinline
7715 #undef noinline
7716 #endif
7718 /* On older GCC versions, just putting x_error_quitter
7719 after x_error_handler prevents inlining into the former. */
7721 static void NO_INLINE
7722 x_error_quitter (Display *display, XErrorEvent *error)
7724 char buf[256], buf1[356];
7726 /* Ignore BadName errors. They can happen because of fonts
7727 or colors that are not defined. */
7729 if (error->error_code == BadName)
7730 return;
7732 /* Note that there is no real way portable across R3/R4 to get the
7733 original error handler. */
7735 XGetErrorText (display, error->error_code, buf, sizeof (buf));
7736 sprintf (buf1, "X protocol error: %s on protocol request %d",
7737 buf, error->request_code);
7738 x_connection_closed (display, buf1);
7742 /* This is the handler for X IO errors, always.
7743 It kills all frames on the display that we lost touch with.
7744 If that was the only one, it prints an error message and kills Emacs. */
7746 static int
7747 x_io_error_quitter (Display *display)
7749 char buf[256];
7751 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
7752 x_connection_closed (display, buf);
7753 return 0;
7756 /* Changing the font of the frame. */
7758 /* Give frame F the font FONT-OBJECT as its default font. The return
7759 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7760 frame. If it is negative, generate a new fontset from
7761 FONT-OBJECT. */
7763 Lisp_Object
7764 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7766 struct font *font = XFONT_OBJECT (font_object);
7768 if (fontset < 0)
7769 fontset = fontset_from_font (font_object);
7770 FRAME_FONTSET (f) = fontset;
7771 if (FRAME_FONT (f) == font)
7772 /* This font is already set in frame F. There's nothing more to
7773 do. */
7774 return font_object;
7776 FRAME_FONT (f) = font;
7777 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7778 FRAME_COLUMN_WIDTH (f) = font->average_width;
7779 FRAME_SPACE_WIDTH (f) = font->space_width;
7780 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7782 compute_fringe_widths (f, 1);
7784 /* Compute the scroll bar width in character columns. */
7785 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7787 int wid = FRAME_COLUMN_WIDTH (f);
7788 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7789 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7791 else
7793 int wid = FRAME_COLUMN_WIDTH (f);
7794 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7797 if (FRAME_X_WINDOW (f) != 0)
7799 /* Don't change the size of a tip frame; there's no point in
7800 doing it because it's done in Fx_show_tip, and it leads to
7801 problems because the tip frame has no widget. */
7802 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7803 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7806 #ifdef HAVE_X_I18N
7807 if (FRAME_XIC (f)
7808 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7810 BLOCK_INPUT;
7811 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
7812 UNBLOCK_INPUT;
7814 #endif
7816 return font_object;
7820 /***********************************************************************
7821 X Input Methods
7822 ***********************************************************************/
7824 #ifdef HAVE_X_I18N
7826 #ifdef HAVE_X11R6
7828 /* XIM destroy callback function, which is called whenever the
7829 connection to input method XIM dies. CLIENT_DATA contains a
7830 pointer to the x_display_info structure corresponding to XIM. */
7832 static void
7833 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7835 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7836 Lisp_Object frame, tail;
7838 BLOCK_INPUT;
7840 /* No need to call XDestroyIC.. */
7841 FOR_EACH_FRAME (tail, frame)
7843 struct frame *f = XFRAME (frame);
7844 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7846 FRAME_XIC (f) = NULL;
7847 xic_free_xfontset (f);
7851 /* No need to call XCloseIM. */
7852 dpyinfo->xim = NULL;
7853 XFree (dpyinfo->xim_styles);
7854 UNBLOCK_INPUT;
7857 #endif /* HAVE_X11R6 */
7859 #ifdef HAVE_X11R6
7860 /* This isn't prototyped in OSF 5.0 or 5.1a. */
7861 extern char *XSetIMValues (XIM, ...);
7862 #endif
7864 /* Open the connection to the XIM server on display DPYINFO.
7865 RESOURCE_NAME is the resource name Emacs uses. */
7867 static void
7868 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
7870 XIM xim;
7872 #ifdef HAVE_XIM
7873 if (use_xim)
7875 if (dpyinfo->xim)
7876 XCloseIM (dpyinfo->xim);
7877 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
7878 emacs_class);
7879 dpyinfo->xim = xim;
7881 if (xim)
7883 #ifdef HAVE_X11R6
7884 XIMCallback destroy;
7885 #endif
7887 /* Get supported styles and XIM values. */
7888 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
7890 #ifdef HAVE_X11R6
7891 destroy.callback = xim_destroy_callback;
7892 destroy.client_data = (XPointer)dpyinfo;
7893 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
7894 #endif
7898 else
7899 #endif /* HAVE_XIM */
7900 dpyinfo->xim = NULL;
7904 #ifdef HAVE_X11R6_XIM
7906 /* XIM instantiate callback function, which is called whenever an XIM
7907 server is available. DISPLAY is the display of the XIM.
7908 CLIENT_DATA contains a pointer to an xim_inst_t structure created
7909 when the callback was registered. */
7911 static void
7912 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
7914 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
7915 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
7917 /* We don't support multiple XIM connections. */
7918 if (dpyinfo->xim)
7919 return;
7921 xim_open_dpy (dpyinfo, xim_inst->resource_name);
7923 /* Create XIC for the existing frames on the same display, as long
7924 as they have no XIC. */
7925 if (dpyinfo->xim && dpyinfo->reference_count > 0)
7927 Lisp_Object tail, frame;
7929 BLOCK_INPUT;
7930 FOR_EACH_FRAME (tail, frame)
7932 struct frame *f = XFRAME (frame);
7934 if (FRAME_X_P (f)
7935 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
7936 if (FRAME_XIC (f) == NULL)
7938 create_frame_xic (f);
7939 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
7940 xic_set_statusarea (f);
7941 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
7943 struct window *w = XWINDOW (f->selected_window);
7944 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
7949 UNBLOCK_INPUT;
7953 #endif /* HAVE_X11R6_XIM */
7956 /* Open a connection to the XIM server on display DPYINFO.
7957 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
7958 connection only at the first time. On X11R6, open the connection
7959 in the XIM instantiate callback function. */
7961 static void
7962 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
7964 dpyinfo->xim = NULL;
7965 #ifdef HAVE_XIM
7966 if (use_xim)
7968 #ifdef HAVE_X11R6_XIM
7969 struct xim_inst_t *xim_inst;
7970 int len;
7972 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
7973 dpyinfo->xim_callback_data = xim_inst;
7974 xim_inst->dpyinfo = dpyinfo;
7975 len = strlen (resource_name);
7976 xim_inst->resource_name = (char *) xmalloc (len + 1);
7977 memcpy (xim_inst->resource_name, resource_name, len + 1);
7978 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
7979 resource_name, emacs_class,
7980 xim_instantiate_callback,
7981 /* This is XPointer in XFree86
7982 but (XPointer *) on Tru64, at
7983 least, hence the configure test. */
7984 (XRegisterIMInstantiateCallback_arg6) xim_inst);
7985 #else /* not HAVE_X11R6_XIM */
7986 xim_open_dpy (dpyinfo, resource_name);
7987 #endif /* not HAVE_X11R6_XIM */
7989 #endif /* HAVE_XIM */
7993 /* Close the connection to the XIM server on display DPYINFO. */
7995 static void
7996 xim_close_dpy (struct x_display_info *dpyinfo)
7998 #ifdef HAVE_XIM
7999 if (use_xim)
8001 #ifdef HAVE_X11R6_XIM
8002 if (dpyinfo->display)
8003 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8004 NULL, emacs_class,
8005 xim_instantiate_callback, NULL);
8006 xfree (dpyinfo->xim_callback_data->resource_name);
8007 xfree (dpyinfo->xim_callback_data);
8008 #endif /* HAVE_X11R6_XIM */
8009 if (dpyinfo->display)
8010 XCloseIM (dpyinfo->xim);
8011 dpyinfo->xim = NULL;
8012 XFree (dpyinfo->xim_styles);
8014 #endif /* HAVE_XIM */
8017 #endif /* not HAVE_X11R6_XIM */
8021 /* Calculate the absolute position in frame F
8022 from its current recorded position values and gravity. */
8024 void
8025 x_calc_absolute_position (struct frame *f)
8027 int flags = f->size_hint_flags;
8029 /* We have nothing to do if the current position
8030 is already for the top-left corner. */
8031 if (! ((flags & XNegative) || (flags & YNegative)))
8032 return;
8034 /* Treat negative positions as relative to the leftmost bottommost
8035 position that fits on the screen. */
8036 if (flags & XNegative)
8037 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8038 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8041 int height = FRAME_PIXEL_HEIGHT (f);
8043 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8044 /* Something is fishy here. When using Motif, starting Emacs with
8045 `-g -0-0', the frame appears too low by a few pixels.
8047 This seems to be so because initially, while Emacs is starting,
8048 the column widget's height and the frame's pixel height are
8049 different. The column widget's height is the right one. In
8050 later invocations, when Emacs is up, the frame's pixel height
8051 is right, though.
8053 It's not obvious where the initial small difference comes from.
8054 2000-12-01, gerd. */
8056 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8057 #endif
8059 if (flags & YNegative)
8060 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8061 - height + f->top_pos;
8064 /* The left_pos and top_pos
8065 are now relative to the top and left screen edges,
8066 so the flags should correspond. */
8067 f->size_hint_flags &= ~ (XNegative | YNegative);
8070 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8071 to really change the position, and 0 when calling from
8072 x_make_frame_visible (in that case, XOFF and YOFF are the current
8073 position values). It is -1 when calling from x_set_frame_parameters,
8074 which means, do adjust for borders but don't change the gravity. */
8076 void
8077 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8079 int modified_top, modified_left;
8081 if (change_gravity > 0)
8083 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8084 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8086 f->top_pos = yoff;
8087 f->left_pos = xoff;
8088 f->size_hint_flags &= ~ (XNegative | YNegative);
8089 if (xoff < 0)
8090 f->size_hint_flags |= XNegative;
8091 if (yoff < 0)
8092 f->size_hint_flags |= YNegative;
8093 f->win_gravity = NorthWestGravity;
8095 x_calc_absolute_position (f);
8097 BLOCK_INPUT;
8098 x_wm_set_size_hint (f, (long) 0, 0);
8100 modified_left = f->left_pos;
8101 modified_top = f->top_pos;
8103 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8105 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8106 than the WM decorations. So we use the calculated offset instead
8107 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8108 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8109 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8112 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8113 modified_left, modified_top);
8115 x_sync_with_move (f, f->left_pos, f->top_pos,
8116 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8117 ? 1 : 0);
8119 /* change_gravity is non-zero when this function is called from Lisp to
8120 programmatically move a frame. In that case, we call
8121 x_check_expected_move to discover if we have a "Type A" or "Type B"
8122 window manager, and, for a "Type A" window manager, adjust the position
8123 of the frame.
8125 We call x_check_expected_move if a programmatic move occurred, and
8126 either the window manager type (A/B) is unknown or it is Type A but we
8127 need to compute the top/left offset adjustment for this frame. */
8129 if (change_gravity != 0 &&
8130 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8131 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8132 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8133 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8134 x_check_expected_move (f, modified_left, modified_top);
8136 UNBLOCK_INPUT;
8139 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8140 on the root window for frame F contains ATOMNAME.
8141 This is how a WM check shall be done according to the Window Manager
8142 Specification/Extended Window Manager Hints at
8143 http://freedesktop.org/wiki/Specifications/wm-spec. */
8145 static int
8146 wm_supports (struct frame *f, const char *atomname)
8148 Atom actual_type;
8149 unsigned long actual_size, bytes_remaining;
8150 int i, rc, actual_format;
8151 Atom prop_atom;
8152 Window wmcheck_window;
8153 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8154 Window target_window = dpyinfo->root_window;
8155 long max_len = 65536;
8156 Display *dpy = FRAME_X_DISPLAY (f);
8157 unsigned char *tmp_data = NULL;
8158 Atom target_type = XA_WINDOW;
8159 Atom want_atom;
8161 BLOCK_INPUT;
8163 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8165 x_catch_errors (dpy);
8166 rc = XGetWindowProperty (dpy, target_window,
8167 prop_atom, 0, max_len, False, target_type,
8168 &actual_type, &actual_format, &actual_size,
8169 &bytes_remaining, &tmp_data);
8171 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8173 if (tmp_data) XFree (tmp_data);
8174 x_uncatch_errors ();
8175 UNBLOCK_INPUT;
8176 return 0;
8179 wmcheck_window = *(Window *) tmp_data;
8180 XFree (tmp_data);
8182 /* Check if window exists. */
8183 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8184 x_sync (f);
8185 if (x_had_errors_p (dpy))
8187 x_uncatch_errors ();
8188 UNBLOCK_INPUT;
8189 return 0;
8192 if (dpyinfo->net_supported_window != wmcheck_window)
8194 /* Window changed, reload atoms */
8195 if (dpyinfo->net_supported_atoms != NULL)
8196 XFree (dpyinfo->net_supported_atoms);
8197 dpyinfo->net_supported_atoms = NULL;
8198 dpyinfo->nr_net_supported_atoms = 0;
8199 dpyinfo->net_supported_window = 0;
8201 target_type = XA_ATOM;
8202 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8203 tmp_data = NULL;
8204 rc = XGetWindowProperty (dpy, target_window,
8205 prop_atom, 0, max_len, False, target_type,
8206 &actual_type, &actual_format, &actual_size,
8207 &bytes_remaining, &tmp_data);
8209 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8211 if (tmp_data) XFree (tmp_data);
8212 x_uncatch_errors ();
8213 UNBLOCK_INPUT;
8214 return 0;
8217 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8218 dpyinfo->nr_net_supported_atoms = actual_size;
8219 dpyinfo->net_supported_window = wmcheck_window;
8222 rc = 0;
8223 want_atom = XInternAtom (dpy, atomname, False);
8225 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8226 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8228 x_uncatch_errors ();
8229 UNBLOCK_INPUT;
8231 return rc;
8234 static void
8235 set_wm_state (Lisp_Object frame, int add, const char *what, const char *what2)
8237 const char *atom = "_NET_WM_STATE";
8238 Fx_send_client_event (frame, make_number (0), frame,
8239 make_unibyte_string (atom, strlen (atom)),
8240 make_number (32),
8241 /* 1 = add, 0 = remove */
8242 Fcons
8243 (make_number (add ? 1 : 0),
8244 Fcons
8245 (make_unibyte_string (what, strlen (what)),
8246 what2 != 0
8247 ? Fcons (make_unibyte_string (what2, strlen (what2)),
8248 Qnil)
8249 : Qnil)));
8252 void
8253 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8255 Lisp_Object frame;
8257 XSETFRAME (frame, f);
8258 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8259 "_NET_WM_STATE_STICKY", NULL);
8262 /* Do fullscreen as specified in extended window manager hints */
8264 static int
8265 do_ewmh_fullscreen (struct frame *f)
8267 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8269 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8270 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8271 if (!have_net_atom)
8272 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8274 if (have_net_atom)
8276 Lisp_Object frame;
8277 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8278 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8279 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8281 XSETFRAME (frame, f);
8283 set_wm_state (frame, 0, fs, NULL);
8284 set_wm_state (frame, 0, fh, NULL);
8285 set_wm_state (frame, 0, fw, NULL);
8287 /* If there are _NET_ atoms we assume we have extended window manager
8288 hints. */
8289 switch (f->want_fullscreen)
8291 case FULLSCREEN_BOTH:
8292 set_wm_state (frame, 1, fs, NULL);
8293 break;
8294 case FULLSCREEN_WIDTH:
8295 set_wm_state (frame, 1, fw, NULL);
8296 break;
8297 case FULLSCREEN_HEIGHT:
8298 set_wm_state (frame, 1, fh, NULL);
8299 break;
8300 case FULLSCREEN_MAXIMIZED:
8301 set_wm_state (frame, 1, fw, fh);
8302 break;
8305 f->want_fullscreen = FULLSCREEN_NONE;
8309 return have_net_atom;
8312 static void
8313 XTfullscreen_hook (FRAME_PTR f)
8315 if (f->async_visible)
8317 BLOCK_INPUT;
8318 x_check_fullscreen (f);
8319 x_sync (f);
8320 UNBLOCK_INPUT;
8325 static void
8326 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8328 Atom actual_type;
8329 unsigned long actual_size, bytes_remaining;
8330 int i, rc, actual_format, value = FULLSCREEN_NONE;
8331 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8332 long max_len = 65536;
8333 Display *dpy = FRAME_X_DISPLAY (f);
8334 unsigned char *tmp_data = NULL;
8335 Atom target_type = XA_ATOM;
8336 Lisp_Object lval;
8337 int sticky = 0;
8339 BLOCK_INPUT;
8340 x_catch_errors (dpy);
8341 rc = XGetWindowProperty (dpy, event->window,
8342 event->atom, 0, max_len, False, target_type,
8343 &actual_type, &actual_format, &actual_size,
8344 &bytes_remaining, &tmp_data);
8346 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8348 if (tmp_data) XFree (tmp_data);
8349 x_uncatch_errors ();
8350 UNBLOCK_INPUT;
8351 return;
8354 x_uncatch_errors ();
8356 for (i = 0; i < actual_size; ++i)
8358 Atom a = ((Atom*)tmp_data)[i];
8359 if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8361 if (value == FULLSCREEN_HEIGHT)
8362 value = FULLSCREEN_MAXIMIZED;
8363 else
8364 value = FULLSCREEN_WIDTH;
8366 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8368 if (value == FULLSCREEN_WIDTH)
8369 value = FULLSCREEN_MAXIMIZED;
8370 else
8371 value = FULLSCREEN_HEIGHT;
8373 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen_atom)
8374 value = FULLSCREEN_BOTH;
8375 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8376 sticky = 1;
8379 lval = Qnil;
8380 switch (value)
8382 case FULLSCREEN_WIDTH:
8383 lval = Qfullwidth;
8384 break;
8385 case FULLSCREEN_HEIGHT:
8386 lval = Qfullheight;
8387 break;
8388 case FULLSCREEN_BOTH:
8389 lval = Qfullboth;
8390 break;
8391 case FULLSCREEN_MAXIMIZED:
8392 lval = Qmaximized;
8393 break;
8396 store_frame_param (f, Qfullscreen, lval);
8397 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8399 if (tmp_data) XFree (tmp_data);
8400 UNBLOCK_INPUT;
8403 /* Check if we need to resize the frame due to a fullscreen request.
8404 If so needed, resize the frame. */
8405 static void
8406 x_check_fullscreen (struct frame *f)
8408 if (do_ewmh_fullscreen (f))
8409 return;
8411 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8412 return; /* Only fullscreen without WM or with EWM hints (above). */
8414 if (f->want_fullscreen != FULLSCREEN_NONE)
8416 int width = FRAME_COLS (f), height = FRAME_LINES (f);
8417 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8419 switch (f->want_fullscreen)
8421 /* No difference between these two when there is no WM */
8422 case FULLSCREEN_BOTH:
8423 case FULLSCREEN_MAXIMIZED:
8424 width = x_display_pixel_width (dpyinfo);
8425 height = x_display_pixel_height (dpyinfo);
8426 break;
8427 case FULLSCREEN_WIDTH:
8428 width = x_display_pixel_width (dpyinfo);
8429 break;
8430 case FULLSCREEN_HEIGHT:
8431 height = x_display_pixel_height (dpyinfo);
8434 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8436 change_frame_size (f, height, width, 0, 1, 0);
8437 SET_FRAME_GARBAGED (f);
8438 cancel_mouse_face (f);
8443 /* This function is called by x_set_offset to determine whether the window
8444 manager interfered with the positioning of the frame. Type A window
8445 managers position the surrounding window manager decorations a small
8446 amount above and left of the user-supplied position. Type B window
8447 managers position the surrounding window manager decorations at the
8448 user-specified position. If we detect a Type A window manager, we
8449 compensate by moving the window right and down by the proper amount. */
8451 static void
8452 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8454 int current_left = 0, current_top = 0;
8456 /* x_real_positions returns the left and top offsets of the outermost
8457 window manager window around the frame. */
8459 x_real_positions (f, &current_left, &current_top);
8461 if (current_left != expected_left || current_top != expected_top)
8463 /* It's a "Type A" window manager. */
8465 int adjusted_left;
8466 int adjusted_top;
8468 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8469 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8470 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8472 /* Now fix the mispositioned frame's location. */
8474 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8475 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8477 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8478 adjusted_left, adjusted_top);
8480 x_sync_with_move (f, expected_left, expected_top, 0);
8482 else
8483 /* It's a "Type B" window manager. We don't have to adjust the
8484 frame's position. */
8486 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8490 /* Wait for XGetGeometry to return up-to-date position information for a
8491 recently-moved frame. Call this immediately after calling XMoveWindow.
8492 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8493 frame has been moved to, so we use a fuzzy position comparison instead
8494 of an exact comparison. */
8496 static void
8497 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8499 int count = 0;
8501 while (count++ < 50)
8503 int current_left = 0, current_top = 0;
8505 /* In theory, this call to XSync only needs to happen once, but in
8506 practice, it doesn't seem to work, hence the need for the surrounding
8507 loop. */
8509 XSync (FRAME_X_DISPLAY (f), False);
8510 x_real_positions (f, &current_left, &current_top);
8512 if (fuzzy)
8514 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8515 pixels. */
8517 if (eabs (current_left - left) <= 10
8518 && eabs (current_top - top) <= 40)
8519 return;
8521 else if (current_left == left && current_top == top)
8522 return;
8525 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8526 will then return up-to-date position info. */
8528 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8532 /* Wait for an event on frame F matching EVENTTYPE. */
8533 void
8534 x_wait_for_event (struct frame *f, int eventtype)
8536 int level = interrupt_input_blocked;
8538 SELECT_TYPE fds;
8539 EMACS_TIME tmo, tmo_at, time_now;
8540 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8542 pending_event_wait.f = f;
8543 pending_event_wait.eventtype = eventtype;
8545 /* Set timeout to 0.1 second. Hopefully not noticable.
8546 Maybe it should be configurable. */
8547 EMACS_SET_SECS_USECS (tmo, 0, 100000);
8548 EMACS_GET_TIME (tmo_at);
8549 EMACS_ADD_TIME (tmo_at, tmo_at, tmo);
8551 while (pending_event_wait.eventtype)
8553 interrupt_input_pending = 1;
8554 TOTALLY_UNBLOCK_INPUT;
8555 /* XTread_socket is called after unblock. */
8556 BLOCK_INPUT;
8557 interrupt_input_blocked = level;
8559 FD_ZERO (&fds);
8560 FD_SET (fd, &fds);
8562 EMACS_GET_TIME (time_now);
8563 EMACS_SUB_TIME (tmo, tmo_at, time_now);
8565 if (EMACS_TIME_NEG_P (tmo) || select (fd+1, &fds, NULL, NULL, &tmo) == 0)
8566 break; /* Timeout */
8568 pending_event_wait.f = 0;
8569 pending_event_wait.eventtype = 0;
8573 /* Change the size of frame F's X window to COLS/ROWS in the case F
8574 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8575 top-left-corner window gravity for this size change and subsequent
8576 size changes. Otherwise we leave the window gravity unchanged. */
8578 static void
8579 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8581 int pixelwidth, pixelheight;
8583 check_frame_size (f, &rows, &cols);
8584 f->scroll_bar_actual_width
8585 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8587 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8589 compute_fringe_widths (f, 0);
8591 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8592 + FRAME_TOOLBAR_WIDTH (f);
8593 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8594 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8596 if (change_gravity) f->win_gravity = NorthWestGravity;
8597 x_wm_set_size_hint (f, (long) 0, 0);
8598 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8599 pixelwidth, pixelheight);
8602 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8603 receive in the ConfigureNotify event; if we get what we asked
8604 for, then the event won't cause the screen to become garbaged, so
8605 we have to make sure to do it here. */
8606 SET_FRAME_GARBAGED (f);
8608 /* Now, strictly speaking, we can't be sure that this is accurate,
8609 but the window manager will get around to dealing with the size
8610 change request eventually, and we'll hear how it went when the
8611 ConfigureNotify event gets here.
8613 We could just not bother storing any of this information here,
8614 and let the ConfigureNotify event set everything up, but that
8615 might be kind of confusing to the Lisp code, since size changes
8616 wouldn't be reported in the frame parameters until some random
8617 point in the future when the ConfigureNotify event arrives.
8619 We pass 1 for DELAY since we can't run Lisp code inside of
8620 a BLOCK_INPUT. */
8622 /* But the ConfigureNotify may in fact never arrive, and then this is
8623 not right if the frame is visible. Instead wait (with timeout)
8624 for the ConfigureNotify. */
8625 if (f->async_visible)
8626 x_wait_for_event (f, ConfigureNotify);
8627 else
8629 change_frame_size (f, rows, cols, 0, 1, 0);
8630 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8631 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8632 x_sync (f);
8637 /* Call this to change the size of frame F's x-window.
8638 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8639 for this size change and subsequent size changes.
8640 Otherwise we leave the window gravity unchanged. */
8642 void
8643 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8645 BLOCK_INPUT;
8647 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8649 int r, c;
8651 /* When the frame is maximized/fullscreen or running under for
8652 example Xmonad, x_set_window_size_1 will be a no-op.
8653 In that case, the right thing to do is extend rows/cols to
8654 the current frame size. We do that first if x_set_window_size_1
8655 turns out to not be a no-op (there is no way to know).
8656 The size will be adjusted again if the frame gets a
8657 ConfigureNotify event as a result of x_set_window_size. */
8658 int pixelh = FRAME_PIXEL_HEIGHT (f);
8659 #ifdef USE_X_TOOLKIT
8660 /* The menu bar is not part of text lines. The tool bar
8661 is however. */
8662 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8663 #endif
8664 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8665 /* Update f->scroll_bar_actual_width because it is used in
8666 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8667 f->scroll_bar_actual_width
8668 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8669 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8670 change_frame_size (f, r, c, 0, 1, 0);
8673 #ifdef USE_GTK
8674 if (FRAME_GTK_WIDGET (f))
8675 xg_frame_set_char_size (f, cols, rows);
8676 else
8677 x_set_window_size_1 (f, change_gravity, cols, rows);
8678 #else /* not USE_GTK */
8680 x_set_window_size_1 (f, change_gravity, cols, rows);
8682 #endif /* not USE_GTK */
8684 /* If cursor was outside the new size, mark it as off. */
8685 mark_window_cursors_off (XWINDOW (f->root_window));
8687 /* Clear out any recollection of where the mouse highlighting was,
8688 since it might be in a place that's outside the new frame size.
8689 Actually checking whether it is outside is a pain in the neck,
8690 so don't try--just let the highlighting be done afresh with new size. */
8691 cancel_mouse_face (f);
8693 UNBLOCK_INPUT;
8696 /* Mouse warping. */
8698 void
8699 x_set_mouse_position (struct frame *f, int x, int y)
8701 int pix_x, pix_y;
8703 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8704 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8706 if (pix_x < 0) pix_x = 0;
8707 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8709 if (pix_y < 0) pix_y = 0;
8710 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8712 BLOCK_INPUT;
8714 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8715 0, 0, 0, 0, pix_x, pix_y);
8716 UNBLOCK_INPUT;
8719 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8721 void
8722 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8724 BLOCK_INPUT;
8726 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8727 0, 0, 0, 0, pix_x, pix_y);
8728 UNBLOCK_INPUT;
8731 /* focus shifting, raising and lowering. */
8733 void
8734 x_focus_on_frame (struct frame *f)
8736 #if 0
8737 /* I don't think that the ICCCM allows programs to do things like this
8738 without the interaction of the window manager. Whatever you end up
8739 doing with this code, do it to x_unfocus_frame too. */
8740 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8741 RevertToPointerRoot, CurrentTime);
8742 #endif /* ! 0 */
8745 void
8746 x_unfocus_frame (struct frame *f)
8748 #if 0
8749 /* Look at the remarks in x_focus_on_frame. */
8750 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8751 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8752 RevertToPointerRoot, CurrentTime);
8753 #endif /* ! 0 */
8756 /* Raise frame F. */
8758 void
8759 x_raise_frame (struct frame *f)
8761 BLOCK_INPUT;
8762 if (f->async_visible)
8763 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8765 XFlush (FRAME_X_DISPLAY (f));
8766 UNBLOCK_INPUT;
8769 /* Lower frame F. */
8771 void
8772 x_lower_frame (struct frame *f)
8774 if (f->async_visible)
8776 BLOCK_INPUT;
8777 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8778 XFlush (FRAME_X_DISPLAY (f));
8779 UNBLOCK_INPUT;
8783 /* Activate frame with Extended Window Manager Hints */
8785 void
8786 x_ewmh_activate_frame (FRAME_PTR f)
8788 /* See Window Manager Specification/Extended Window Manager Hints at
8789 http://freedesktop.org/wiki/Specifications/wm-spec */
8791 const char *atom = "_NET_ACTIVE_WINDOW";
8792 if (f->async_visible && wm_supports (f, atom))
8794 Lisp_Object frame;
8795 XSETFRAME (frame, f);
8796 Fx_send_client_event (frame, make_number (0), frame,
8797 make_unibyte_string (atom, strlen (atom)),
8798 make_number (32),
8799 Fcons (make_number (1),
8800 Fcons (make_number (last_user_time),
8801 Qnil)));
8805 static void
8806 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
8808 if (raise_flag)
8809 x_raise_frame (f);
8810 else
8811 x_lower_frame (f);
8814 /* XEmbed implementation. */
8816 void
8817 xembed_set_info (struct frame *f, enum xembed_info flags)
8819 Atom atom;
8820 unsigned long data[2];
8822 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
8824 data[0] = XEMBED_VERSION;
8825 data[1] = flags;
8827 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
8828 32, PropModeReplace, (unsigned char *) data, 2);
8831 void
8832 xembed_send_message (struct frame *f, Time time, enum xembed_message message, long int detail, long int data1, long int data2)
8834 XEvent event;
8836 event.xclient.type = ClientMessage;
8837 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
8838 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
8839 event.xclient.format = 32;
8840 event.xclient.data.l[0] = time;
8841 event.xclient.data.l[1] = message;
8842 event.xclient.data.l[2] = detail;
8843 event.xclient.data.l[3] = data1;
8844 event.xclient.data.l[4] = data2;
8846 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
8847 False, NoEventMask, &event);
8848 XSync (FRAME_X_DISPLAY (f), False);
8851 /* Change of visibility. */
8853 /* This tries to wait until the frame is really visible.
8854 However, if the window manager asks the user where to position
8855 the frame, this will return before the user finishes doing that.
8856 The frame will not actually be visible at that time,
8857 but it will become visible later when the window manager
8858 finishes with it. */
8860 void
8861 x_make_frame_visible (struct frame *f)
8863 Lisp_Object type;
8864 int original_top, original_left;
8865 int retry_count = 2;
8867 retry:
8869 BLOCK_INPUT;
8871 type = x_icon_type (f);
8872 if (!NILP (type))
8873 x_bitmap_icon (f, type);
8875 if (! FRAME_VISIBLE_P (f))
8877 /* We test FRAME_GARBAGED_P here to make sure we don't
8878 call x_set_offset a second time
8879 if we get to x_make_frame_visible a second time
8880 before the window gets really visible. */
8881 if (! FRAME_ICONIFIED_P (f)
8882 && ! FRAME_X_EMBEDDED_P (f)
8883 && ! f->output_data.x->asked_for_visible)
8884 x_set_offset (f, f->left_pos, f->top_pos, 0);
8886 f->output_data.x->asked_for_visible = 1;
8888 if (! EQ (Vx_no_window_manager, Qt))
8889 x_wm_set_window_state (f, NormalState);
8890 #ifdef USE_X_TOOLKIT
8891 if (FRAME_X_EMBEDDED_P (f))
8892 xembed_set_info (f, XEMBED_MAPPED);
8893 else
8895 /* This was XtPopup, but that did nothing for an iconified frame. */
8896 XtMapWidget (f->output_data.x->widget);
8898 #else /* not USE_X_TOOLKIT */
8899 #ifdef USE_GTK
8900 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
8901 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
8902 #else
8903 if (FRAME_X_EMBEDDED_P (f))
8904 xembed_set_info (f, XEMBED_MAPPED);
8905 else
8906 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8907 #endif /* not USE_GTK */
8908 #endif /* not USE_X_TOOLKIT */
8911 XFlush (FRAME_X_DISPLAY (f));
8913 /* Synchronize to ensure Emacs knows the frame is visible
8914 before we do anything else. We do this loop with input not blocked
8915 so that incoming events are handled. */
8917 Lisp_Object frame;
8918 int count;
8919 /* This must be before UNBLOCK_INPUT
8920 since events that arrive in response to the actions above
8921 will set it when they are handled. */
8922 int previously_visible = f->output_data.x->has_been_visible;
8924 original_left = f->left_pos;
8925 original_top = f->top_pos;
8927 /* This must come after we set COUNT. */
8928 UNBLOCK_INPUT;
8930 /* We unblock here so that arriving X events are processed. */
8932 /* Now move the window back to where it was "supposed to be".
8933 But don't do it if the gravity is negative.
8934 When the gravity is negative, this uses a position
8935 that is 3 pixels too low. Perhaps that's really the border width.
8937 Don't do this if the window has never been visible before,
8938 because the window manager may choose the position
8939 and we don't want to override it. */
8941 if (! FRAME_VISIBLE_P (f)
8942 && ! FRAME_ICONIFIED_P (f)
8943 && ! FRAME_X_EMBEDDED_P (f)
8944 && f->win_gravity == NorthWestGravity
8945 && previously_visible)
8947 Drawable rootw;
8948 int x, y;
8949 unsigned int width, height, border, depth;
8951 BLOCK_INPUT;
8953 /* On some window managers (such as FVWM) moving an existing
8954 window, even to the same place, causes the window manager
8955 to introduce an offset. This can cause the window to move
8956 to an unexpected location. Check the geometry (a little
8957 slow here) and then verify that the window is in the right
8958 place. If the window is not in the right place, move it
8959 there, and take the potential window manager hit. */
8960 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8961 &rootw, &x, &y, &width, &height, &border, &depth);
8963 if (original_left != x || original_top != y)
8964 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8965 original_left, original_top);
8967 UNBLOCK_INPUT;
8970 XSETFRAME (frame, f);
8972 /* Wait until the frame is visible. Process X events until a
8973 MapNotify event has been seen, or until we think we won't get a
8974 MapNotify at all.. */
8975 for (count = input_signal_count + 10;
8976 input_signal_count < count && !FRAME_VISIBLE_P (f);)
8978 /* Force processing of queued events. */
8979 x_sync (f);
8981 /* Machines that do polling rather than SIGIO have been
8982 observed to go into a busy-wait here. So we'll fake an
8983 alarm signal to let the handler know that there's something
8984 to be read. We used to raise a real alarm, but it seems
8985 that the handler isn't always enabled here. This is
8986 probably a bug. */
8987 if (input_polling_used ())
8989 /* It could be confusing if a real alarm arrives while
8990 processing the fake one. Turn it off and let the
8991 handler reset it. */
8992 int old_poll_suppress_count = poll_suppress_count;
8993 poll_suppress_count = 1;
8994 poll_for_input_1 ();
8995 poll_suppress_count = old_poll_suppress_count;
8998 /* See if a MapNotify event has been processed. */
8999 FRAME_SAMPLE_VISIBILITY (f);
9002 /* 2000-09-28: In
9004 (let ((f (selected-frame)))
9005 (iconify-frame f)
9006 (raise-frame f))
9008 the frame is not raised with various window managers on
9009 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9010 unknown reason, the call to XtMapWidget is completely ignored.
9011 Mapping the widget a second time works. */
9013 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9014 goto retry;
9018 /* Change from mapped state to withdrawn state. */
9020 /* Make the frame visible (mapped and not iconified). */
9022 void
9023 x_make_frame_invisible (struct frame *f)
9025 Window window;
9027 /* Use the frame's outermost window, not the one we normally draw on. */
9028 window = FRAME_OUTER_WINDOW (f);
9030 /* Don't keep the highlight on an invisible frame. */
9031 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9032 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9034 BLOCK_INPUT;
9036 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9037 that the current position of the window is user-specified, rather than
9038 program-specified, so that when the window is mapped again, it will be
9039 placed at the same location, without forcing the user to position it
9040 by hand again (they have already done that once for this window.) */
9041 x_wm_set_size_hint (f, (long) 0, 1);
9043 #ifdef USE_GTK
9044 if (FRAME_GTK_OUTER_WIDGET (f))
9045 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9046 else
9047 #else
9048 if (FRAME_X_EMBEDDED_P (f))
9049 xembed_set_info (f, 0);
9050 else
9051 #endif
9054 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9055 DefaultScreen (FRAME_X_DISPLAY (f))))
9057 UNBLOCK_INPUT_RESIGNAL;
9058 error ("Can't notify window manager of window withdrawal");
9062 /* We can't distinguish this from iconification
9063 just by the event that we get from the server.
9064 So we can't win using the usual strategy of letting
9065 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9066 and synchronize with the server to make sure we agree. */
9067 f->visible = 0;
9068 FRAME_ICONIFIED_P (f) = 0;
9069 f->async_visible = 0;
9070 f->async_iconified = 0;
9072 x_sync (f);
9074 UNBLOCK_INPUT;
9077 /* Change window state from mapped to iconified. */
9079 void
9080 x_iconify_frame (struct frame *f)
9082 int result;
9083 Lisp_Object type;
9085 /* Don't keep the highlight on an invisible frame. */
9086 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9087 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9089 if (f->async_iconified)
9090 return;
9092 BLOCK_INPUT;
9094 FRAME_SAMPLE_VISIBILITY (f);
9096 type = x_icon_type (f);
9097 if (!NILP (type))
9098 x_bitmap_icon (f, type);
9100 #ifdef USE_GTK
9101 if (FRAME_GTK_OUTER_WIDGET (f))
9103 if (! FRAME_VISIBLE_P (f))
9104 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9106 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9107 f->iconified = 1;
9108 f->visible = 1;
9109 f->async_iconified = 1;
9110 f->async_visible = 0;
9111 UNBLOCK_INPUT;
9112 return;
9114 #endif
9116 #ifdef USE_X_TOOLKIT
9118 if (! FRAME_VISIBLE_P (f))
9120 if (! EQ (Vx_no_window_manager, Qt))
9121 x_wm_set_window_state (f, IconicState);
9122 /* This was XtPopup, but that did nothing for an iconified frame. */
9123 XtMapWidget (f->output_data.x->widget);
9124 /* The server won't give us any event to indicate
9125 that an invisible frame was changed to an icon,
9126 so we have to record it here. */
9127 f->iconified = 1;
9128 f->visible = 1;
9129 f->async_iconified = 1;
9130 f->async_visible = 0;
9131 UNBLOCK_INPUT;
9132 return;
9135 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9136 XtWindow (f->output_data.x->widget),
9137 DefaultScreen (FRAME_X_DISPLAY (f)));
9138 UNBLOCK_INPUT;
9140 if (!result)
9141 error ("Can't notify window manager of iconification");
9143 f->async_iconified = 1;
9144 f->async_visible = 0;
9147 BLOCK_INPUT;
9148 XFlush (FRAME_X_DISPLAY (f));
9149 UNBLOCK_INPUT;
9150 #else /* not USE_X_TOOLKIT */
9152 /* Make sure the X server knows where the window should be positioned,
9153 in case the user deiconifies with the window manager. */
9154 if (! FRAME_VISIBLE_P (f)
9155 && ! FRAME_ICONIFIED_P (f)
9156 && ! FRAME_X_EMBEDDED_P (f))
9157 x_set_offset (f, f->left_pos, f->top_pos, 0);
9159 /* Since we don't know which revision of X we're running, we'll use both
9160 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9162 /* X11R4: send a ClientMessage to the window manager using the
9163 WM_CHANGE_STATE type. */
9165 XEvent message;
9167 message.xclient.window = FRAME_X_WINDOW (f);
9168 message.xclient.type = ClientMessage;
9169 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9170 message.xclient.format = 32;
9171 message.xclient.data.l[0] = IconicState;
9173 if (! XSendEvent (FRAME_X_DISPLAY (f),
9174 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9175 False,
9176 SubstructureRedirectMask | SubstructureNotifyMask,
9177 &message))
9179 UNBLOCK_INPUT_RESIGNAL;
9180 error ("Can't notify window manager of iconification");
9184 /* X11R3: set the initial_state field of the window manager hints to
9185 IconicState. */
9186 x_wm_set_window_state (f, IconicState);
9188 if (!FRAME_VISIBLE_P (f))
9190 /* If the frame was withdrawn, before, we must map it. */
9191 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9194 f->async_iconified = 1;
9195 f->async_visible = 0;
9197 XFlush (FRAME_X_DISPLAY (f));
9198 UNBLOCK_INPUT;
9199 #endif /* not USE_X_TOOLKIT */
9203 /* Free X resources of frame F. */
9205 void
9206 x_free_frame_resources (struct frame *f)
9208 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9209 Lisp_Object bar;
9210 struct scroll_bar *b;
9212 BLOCK_INPUT;
9214 /* If a display connection is dead, don't try sending more
9215 commands to the X server. */
9216 if (dpyinfo->display)
9218 /* We must free faces before destroying windows because some
9219 font-driver (e.g. xft) access a window while finishing a
9220 face. */
9221 if (FRAME_FACE_CACHE (f))
9222 free_frame_faces (f);
9224 if (f->output_data.x->icon_desc)
9225 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9227 #ifdef USE_X_TOOLKIT
9228 /* Explicitly destroy the scroll bars of the frame. Without
9229 this, we get "BadDrawable" errors from the toolkit later on,
9230 presumably from expose events generated for the disappearing
9231 toolkit scroll bars. */
9232 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9234 b = XSCROLL_BAR (bar);
9235 x_scroll_bar_remove (b);
9237 #endif
9239 #ifdef HAVE_X_I18N
9240 if (FRAME_XIC (f))
9241 free_frame_xic (f);
9242 #endif
9244 #ifdef USE_X_TOOLKIT
9245 if (f->output_data.x->widget)
9247 XtDestroyWidget (f->output_data.x->widget);
9248 f->output_data.x->widget = NULL;
9250 /* Tooltips don't have widgets, only a simple X window, even if
9251 we are using a toolkit. */
9252 else if (FRAME_X_WINDOW (f))
9253 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9255 free_frame_menubar (f);
9256 #else /* !USE_X_TOOLKIT */
9258 #ifdef USE_GTK
9259 xg_free_frame_widgets (f);
9260 #endif /* USE_GTK */
9262 if (FRAME_X_WINDOW (f))
9263 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9264 #endif /* !USE_X_TOOLKIT */
9266 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9267 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9268 unload_color (f, f->output_data.x->cursor_pixel);
9269 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9270 unload_color (f, f->output_data.x->border_pixel);
9271 unload_color (f, f->output_data.x->mouse_pixel);
9273 if (f->output_data.x->scroll_bar_background_pixel != -1)
9274 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9275 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9276 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9277 #ifdef USE_TOOLKIT_SCROLL_BARS
9278 /* Scrollbar shadow colors. */
9279 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9280 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9281 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9282 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9283 #endif /* USE_TOOLKIT_SCROLL_BARS */
9284 if (f->output_data.x->white_relief.allocated_p)
9285 unload_color (f, f->output_data.x->white_relief.pixel);
9286 if (f->output_data.x->black_relief.allocated_p)
9287 unload_color (f, f->output_data.x->black_relief.pixel);
9289 x_free_gcs (f);
9290 XFlush (FRAME_X_DISPLAY (f));
9293 xfree (f->output_data.x->saved_menu_event);
9294 xfree (f->output_data.x);
9295 f->output_data.x = NULL;
9297 if (f == dpyinfo->x_focus_frame)
9298 dpyinfo->x_focus_frame = 0;
9299 if (f == dpyinfo->x_focus_event_frame)
9300 dpyinfo->x_focus_event_frame = 0;
9301 if (f == dpyinfo->x_highlight_frame)
9302 dpyinfo->x_highlight_frame = 0;
9304 if (f == dpyinfo->mouse_face_mouse_frame)
9306 dpyinfo->mouse_face_beg_row
9307 = dpyinfo->mouse_face_beg_col = -1;
9308 dpyinfo->mouse_face_end_row
9309 = dpyinfo->mouse_face_end_col = -1;
9310 dpyinfo->mouse_face_window = Qnil;
9311 dpyinfo->mouse_face_deferred_gc = 0;
9312 dpyinfo->mouse_face_mouse_frame = 0;
9315 UNBLOCK_INPUT;
9319 /* Destroy the X window of frame F. */
9321 void
9322 x_destroy_window (struct frame *f)
9324 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9326 /* If a display connection is dead, don't try sending more
9327 commands to the X server. */
9328 if (dpyinfo->display != 0)
9329 x_free_frame_resources (f);
9331 dpyinfo->reference_count--;
9335 /* Setting window manager hints. */
9337 /* Set the normal size hints for the window manager, for frame F.
9338 FLAGS is the flags word to use--or 0 meaning preserve the flags
9339 that the window now has.
9340 If USER_POSITION is nonzero, we set the USPosition
9341 flag (this is useful when FLAGS is 0).
9342 The GTK version is in gtkutils.c */
9344 #ifndef USE_GTK
9345 void
9346 x_wm_set_size_hint (struct frame *f, long flags, int user_position)
9348 XSizeHints size_hints;
9349 Window window = FRAME_OUTER_WINDOW (f);
9351 /* Setting PMaxSize caused various problems. */
9352 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9354 size_hints.x = f->left_pos;
9355 size_hints.y = f->top_pos;
9357 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9358 size_hints.width = FRAME_PIXEL_WIDTH (f);
9360 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9361 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9362 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9363 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9364 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9365 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9367 /* Calculate the base and minimum sizes. */
9369 int base_width, base_height;
9370 int min_rows = 0, min_cols = 0;
9372 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9373 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9375 check_frame_size (f, &min_rows, &min_cols);
9377 /* The window manager uses the base width hints to calculate the
9378 current number of rows and columns in the frame while
9379 resizing; min_width and min_height aren't useful for this
9380 purpose, since they might not give the dimensions for a
9381 zero-row, zero-column frame.
9383 We use the base_width and base_height members if we have
9384 them; otherwise, we set the min_width and min_height members
9385 to the size for a zero x zero frame. */
9387 size_hints.flags |= PBaseSize;
9388 size_hints.base_width = base_width;
9389 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9390 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9391 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9394 /* If we don't need the old flags, we don't need the old hint at all. */
9395 if (flags)
9397 size_hints.flags |= flags;
9398 goto no_read;
9402 XSizeHints hints; /* Sometimes I hate X Windows... */
9403 long supplied_return;
9404 int value;
9406 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9407 &supplied_return);
9409 if (flags)
9410 size_hints.flags |= flags;
9411 else
9413 if (value == 0)
9414 hints.flags = 0;
9415 if (hints.flags & PSize)
9416 size_hints.flags |= PSize;
9417 if (hints.flags & PPosition)
9418 size_hints.flags |= PPosition;
9419 if (hints.flags & USPosition)
9420 size_hints.flags |= USPosition;
9421 if (hints.flags & USSize)
9422 size_hints.flags |= USSize;
9426 no_read:
9428 #ifdef PWinGravity
9429 size_hints.win_gravity = f->win_gravity;
9430 size_hints.flags |= PWinGravity;
9432 if (user_position)
9434 size_hints.flags &= ~ PPosition;
9435 size_hints.flags |= USPosition;
9437 #endif /* PWinGravity */
9439 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9441 #endif /* not USE_GTK */
9443 /* Used for IconicState or NormalState */
9445 void
9446 x_wm_set_window_state (struct frame *f, int state)
9448 #ifdef USE_X_TOOLKIT
9449 Arg al[1];
9451 XtSetArg (al[0], XtNinitialState, state);
9452 XtSetValues (f->output_data.x->widget, al, 1);
9453 #else /* not USE_X_TOOLKIT */
9454 Window window = FRAME_X_WINDOW (f);
9456 f->output_data.x->wm_hints.flags |= StateHint;
9457 f->output_data.x->wm_hints.initial_state = state;
9459 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9460 #endif /* not USE_X_TOOLKIT */
9463 void
9464 x_wm_set_icon_pixmap (struct frame *f, int pixmap_id)
9466 Pixmap icon_pixmap, icon_mask;
9468 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9469 Window window = FRAME_OUTER_WINDOW (f);
9470 #endif
9472 if (pixmap_id > 0)
9474 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9475 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9476 icon_mask = x_bitmap_mask (f, pixmap_id);
9477 f->output_data.x->wm_hints.icon_mask = icon_mask;
9479 else
9481 /* It seems there is no way to turn off use of an icon
9482 pixmap. */
9483 return;
9487 #ifdef USE_GTK
9489 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9490 return;
9493 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9496 Arg al[1];
9497 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9498 XtSetValues (f->output_data.x->widget, al, 1);
9499 XtSetArg (al[0], XtNiconMask, icon_mask);
9500 XtSetValues (f->output_data.x->widget, al, 1);
9503 #else /* not USE_X_TOOLKIT && not USE_GTK */
9505 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9506 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9508 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9511 void
9512 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9514 Window window = FRAME_OUTER_WINDOW (f);
9516 f->output_data.x->wm_hints.flags |= IconPositionHint;
9517 f->output_data.x->wm_hints.icon_x = icon_x;
9518 f->output_data.x->wm_hints.icon_y = icon_y;
9520 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9524 /***********************************************************************
9525 Fonts
9526 ***********************************************************************/
9528 #if GLYPH_DEBUG
9530 /* Check that FONT is valid on frame F. It is if it can be found in F's
9531 font table. */
9533 static void
9534 x_check_font (struct frame *f, struct font *font)
9536 Lisp_Object frame;
9538 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9539 if (font->driver->check)
9540 xassert (font->driver->check (f, font) == 0);
9543 #endif /* GLYPH_DEBUG != 0 */
9546 /***********************************************************************
9547 Initialization
9548 ***********************************************************************/
9550 #ifdef USE_X_TOOLKIT
9551 static XrmOptionDescRec emacs_options[] = {
9552 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9553 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9555 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9556 XrmoptionSepArg, NULL},
9557 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9559 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9560 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9561 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9562 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9563 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9564 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9565 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9568 /* Whether atimer for Xt timeouts is activated or not. */
9570 static int x_timeout_atimer_activated_flag;
9572 #endif /* USE_X_TOOLKIT */
9574 static int x_initialized;
9576 #ifdef HAVE_X_SM
9577 static int x_session_initialized;
9578 #endif
9580 /* Test whether two display-name strings agree up to the dot that separates
9581 the screen number from the server number. */
9582 static int
9583 same_x_server (const char *name1, const char *name2)
9585 int seen_colon = 0;
9586 const unsigned char *system_name = SDATA (Vsystem_name);
9587 int system_name_length = strlen (system_name);
9588 int length_until_period = 0;
9590 while (system_name[length_until_period] != 0
9591 && system_name[length_until_period] != '.')
9592 length_until_period++;
9594 /* Treat `unix' like an empty host name. */
9595 if (! strncmp (name1, "unix:", 5))
9596 name1 += 4;
9597 if (! strncmp (name2, "unix:", 5))
9598 name2 += 4;
9599 /* Treat this host's name like an empty host name. */
9600 if (! strncmp (name1, system_name, system_name_length)
9601 && name1[system_name_length] == ':')
9602 name1 += system_name_length;
9603 if (! strncmp (name2, system_name, system_name_length)
9604 && name2[system_name_length] == ':')
9605 name2 += system_name_length;
9606 /* Treat this host's domainless name like an empty host name. */
9607 if (! strncmp (name1, system_name, length_until_period)
9608 && name1[length_until_period] == ':')
9609 name1 += length_until_period;
9610 if (! strncmp (name2, system_name, length_until_period)
9611 && name2[length_until_period] == ':')
9612 name2 += length_until_period;
9614 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9616 if (*name1 == ':')
9617 seen_colon++;
9618 if (seen_colon && *name1 == '.')
9619 return 1;
9621 return (seen_colon
9622 && (*name1 == '.' || *name1 == '\0')
9623 && (*name2 == '.' || *name2 == '\0'));
9626 /* Count number of set bits in mask and number of bits to shift to
9627 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9628 to 5. */
9629 static void
9630 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9632 int nr = 0;
9633 int off = 0;
9635 while (!(mask & 1))
9637 off++;
9638 mask >>= 1;
9641 while (mask & 1)
9643 nr++;
9644 mask >>= 1;
9647 *offset = off;
9648 *bits = nr;
9651 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9652 But don't permanently open it, just test its availability. */
9655 x_display_ok (const char *display)
9657 int dpy_ok = 1;
9658 Display *dpy;
9660 dpy = XOpenDisplay (display);
9661 if (dpy)
9662 XCloseDisplay (dpy);
9663 else
9664 dpy_ok = 0;
9665 return dpy_ok;
9668 #ifdef USE_GTK
9669 static void
9670 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data)
9672 if (!strstr (message, "g_set_prgname"))
9673 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, message);
9675 #endif
9677 /* Open a connection to X display DISPLAY_NAME, and return
9678 the structure that describes the open display.
9679 If we cannot contact the display, return null. */
9681 struct x_display_info *
9682 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9684 int connection;
9685 Display *dpy;
9686 struct terminal *terminal;
9687 struct x_display_info *dpyinfo;
9688 XrmDatabase xrdb;
9690 BLOCK_INPUT;
9692 if (!x_initialized)
9694 x_initialize ();
9695 ++x_initialized;
9698 if (! x_display_ok (SDATA (display_name)))
9699 error ("Display %s can't be opened", SDATA (display_name));
9701 #ifdef USE_GTK
9703 #define NUM_ARGV 10
9704 int argc;
9705 char *argv[NUM_ARGV];
9706 char **argv2 = argv;
9707 guint id;
9709 if (x_initialized++ > 1)
9711 xg_display_open (SDATA (display_name), &dpy);
9713 else
9715 static char display_opt[] = "--display";
9716 static char name_opt[] = "--name";
9718 for (argc = 0; argc < NUM_ARGV; ++argc)
9719 argv[argc] = 0;
9721 argc = 0;
9722 argv[argc++] = initial_argv[0];
9724 if (! NILP (display_name))
9726 argv[argc++] = display_opt;
9727 argv[argc++] = SDATA (display_name);
9730 argv[argc++] = name_opt;
9731 argv[argc++] = resource_name;
9733 XSetLocaleModifiers ("");
9735 /* Work around GLib bug that outputs a faulty warning. See
9736 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9737 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9738 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9739 gtk_init (&argc, &argv2);
9740 g_log_remove_handler ("GLib", id);
9742 /* gtk_init does set_locale. We must fix locale after calling it. */
9743 fixup_locale ();
9744 xg_initialize ();
9746 dpy = GDK_DISPLAY ();
9748 /* NULL window -> events for all windows go to our function */
9749 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9751 /* Load our own gtkrc if it exists. */
9753 const char *file = "~/.emacs.d/gtkrc";
9754 Lisp_Object s, abs_file;
9756 s = make_string (file, strlen (file));
9757 abs_file = Fexpand_file_name (s, Qnil);
9759 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9760 gtk_rc_parse (SDATA (abs_file));
9763 XSetErrorHandler (x_error_handler);
9764 XSetIOErrorHandler (x_io_error_quitter);
9767 #else /* not USE_GTK */
9768 #ifdef USE_X_TOOLKIT
9769 /* weiner@footloose.sps.mot.com reports that this causes
9770 errors with X11R5:
9771 X protocol error: BadAtom (invalid Atom parameter)
9772 on protocol request 18skiloaf.
9773 So let's not use it until R6. */
9774 #ifdef HAVE_X11XTR6
9775 XtSetLanguageProc (NULL, NULL, NULL);
9776 #endif
9779 int argc = 0;
9780 char *argv[3];
9782 argv[0] = "";
9783 argc = 1;
9784 if (xrm_option)
9786 argv[argc++] = "-xrm";
9787 argv[argc++] = xrm_option;
9789 turn_on_atimers (0);
9790 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
9791 resource_name, EMACS_CLASS,
9792 emacs_options, XtNumber (emacs_options),
9793 &argc, argv);
9794 turn_on_atimers (1);
9796 #ifdef HAVE_X11XTR6
9797 /* I think this is to compensate for XtSetLanguageProc. */
9798 fixup_locale ();
9799 #endif
9802 #else /* not USE_X_TOOLKIT */
9803 XSetLocaleModifiers ("");
9804 dpy = XOpenDisplay (SDATA (display_name));
9805 #endif /* not USE_X_TOOLKIT */
9806 #endif /* not USE_GTK*/
9808 /* Detect failure. */
9809 if (dpy == 0)
9811 UNBLOCK_INPUT;
9812 return 0;
9815 /* We have definitely succeeded. Record the new connection. */
9817 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
9818 memset (dpyinfo, 0, sizeof *dpyinfo);
9820 terminal = x_create_terminal (dpyinfo);
9823 struct x_display_info *share;
9824 Lisp_Object tail;
9826 for (share = x_display_list, tail = x_display_name_list; share;
9827 share = share->next, tail = XCDR (tail))
9828 if (same_x_server (SDATA (XCAR (XCAR (tail))),
9829 SDATA (display_name)))
9830 break;
9831 if (share)
9832 terminal->kboard = share->terminal->kboard;
9833 else
9835 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
9836 init_kboard (terminal->kboard);
9837 terminal->kboard->Vwindow_system = Qx;
9839 /* Add the keyboard to the list before running Lisp code (via
9840 Qvendor_specific_keysyms below), since these are not traced
9841 via terminals but only through all_kboards. */
9842 terminal->kboard->next_kboard = all_kboards;
9843 all_kboards = terminal->kboard;
9845 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
9847 char *vendor = ServerVendor (dpy);
9849 /* Protect terminal from GC before removing it from the
9850 list of terminals. */
9851 struct gcpro gcpro1;
9852 Lisp_Object gcpro_term;
9853 XSETTERMINAL (gcpro_term, terminal);
9854 GCPRO1 (gcpro_term);
9856 /* Temporarily hide the partially initialized terminal. */
9857 terminal_list = terminal->next_terminal;
9858 UNBLOCK_INPUT;
9859 terminal->kboard->Vsystem_key_alist
9860 = call1 (Qvendor_specific_keysyms,
9861 vendor ? build_string (vendor) : empty_unibyte_string);
9862 BLOCK_INPUT;
9863 terminal->next_terminal = terminal_list;
9864 terminal_list = terminal;
9865 UNGCPRO;
9868 /* Don't let the initial kboard remain current longer than necessary.
9869 That would cause problems if a file loaded on startup tries to
9870 prompt in the mini-buffer. */
9871 if (current_kboard == initial_kboard)
9872 current_kboard = terminal->kboard;
9874 terminal->kboard->reference_count++;
9877 /* Put this display on the chain. */
9878 dpyinfo->next = x_display_list;
9879 x_display_list = dpyinfo;
9881 /* Put it on x_display_name_list as well, to keep them parallel. */
9882 x_display_name_list = Fcons (Fcons (display_name, Qnil),
9883 x_display_name_list);
9884 dpyinfo->name_list_element = XCAR (x_display_name_list);
9886 dpyinfo->display = dpy;
9888 /* Set the name of the terminal. */
9889 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
9890 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
9891 terminal->name[SBYTES (display_name)] = 0;
9893 #if 0
9894 XSetAfterFunction (x_current_display, x_trace_wire);
9895 #endif /* ! 0 */
9897 dpyinfo->x_id_name
9898 = (char *) xmalloc (SBYTES (Vinvocation_name)
9899 + SBYTES (Vsystem_name)
9900 + 2);
9901 sprintf (dpyinfo->x_id_name, "%s@%s",
9902 SDATA (Vinvocation_name), SDATA (Vsystem_name));
9904 /* Figure out which modifier bits mean what. */
9905 x_find_modifier_meanings (dpyinfo);
9907 /* Get the scroll bar cursor. */
9908 #ifdef USE_GTK
9909 /* We must create a GTK cursor, it is required for GTK widgets. */
9910 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
9911 #endif /* USE_GTK */
9913 dpyinfo->vertical_scroll_bar_cursor
9914 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
9916 xrdb = x_load_resources (dpyinfo->display, xrm_option,
9917 resource_name, EMACS_CLASS);
9918 #ifdef HAVE_XRMSETDATABASE
9919 XrmSetDatabase (dpyinfo->display, xrdb);
9920 #else
9921 dpyinfo->display->db = xrdb;
9922 #endif
9923 /* Put the rdb where we can find it in a way that works on
9924 all versions. */
9925 dpyinfo->xrdb = xrdb;
9927 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
9928 DefaultScreen (dpyinfo->display));
9929 select_visual (dpyinfo);
9930 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
9931 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
9932 dpyinfo->client_leader_window = 0;
9933 dpyinfo->grabbed = 0;
9934 dpyinfo->reference_count = 0;
9935 dpyinfo->icon_bitmap_id = -1;
9936 dpyinfo->n_fonts = 0;
9937 dpyinfo->bitmaps = 0;
9938 dpyinfo->bitmaps_size = 0;
9939 dpyinfo->bitmaps_last = 0;
9940 dpyinfo->scratch_cursor_gc = 0;
9941 dpyinfo->mouse_face_mouse_frame = 0;
9942 dpyinfo->mouse_face_deferred_gc = 0;
9943 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
9944 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
9945 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
9946 dpyinfo->mouse_face_window = Qnil;
9947 dpyinfo->mouse_face_overlay = Qnil;
9948 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
9949 dpyinfo->mouse_face_defer = 0;
9950 dpyinfo->mouse_face_hidden = 0;
9951 dpyinfo->x_focus_frame = 0;
9952 dpyinfo->x_focus_event_frame = 0;
9953 dpyinfo->x_highlight_frame = 0;
9954 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
9956 /* See if we can construct pixel values from RGB values. */
9957 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
9958 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
9960 if (dpyinfo->visual->class == TrueColor)
9962 get_bits_and_offset (dpyinfo->visual->red_mask,
9963 &dpyinfo->red_bits, &dpyinfo->red_offset);
9964 get_bits_and_offset (dpyinfo->visual->blue_mask,
9965 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
9966 get_bits_and_offset (dpyinfo->visual->green_mask,
9967 &dpyinfo->green_bits, &dpyinfo->green_offset);
9970 /* See if a private colormap is requested. */
9971 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
9973 if (dpyinfo->visual->class == PseudoColor)
9975 Lisp_Object value;
9976 value = display_x_get_resource (dpyinfo,
9977 build_string ("privateColormap"),
9978 build_string ("PrivateColormap"),
9979 Qnil, Qnil);
9980 if (STRINGP (value)
9981 && (!strcmp (SDATA (value), "true")
9982 || !strcmp (SDATA (value), "on")))
9983 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
9986 else
9987 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
9988 dpyinfo->visual, AllocNone);
9990 #ifdef HAVE_XFT
9992 /* If we are using Xft, check dpi value in X resources.
9993 It is better we use it as well, since Xft will use it, as will all
9994 Gnome applications. If our real DPI is smaller or larger than the
9995 one Xft uses, our font will look smaller or larger than other
9996 for other applications, even if it is the same font name (monospace-10
9997 for example). */
9998 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
9999 double d;
10000 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10001 dpyinfo->resy = dpyinfo->resx = d;
10003 #endif
10005 if (dpyinfo->resy < 1)
10007 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10008 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10009 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10010 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10011 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10012 pixels = DisplayWidth (dpyinfo->display, screen_number);
10013 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10014 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10015 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10018 dpyinfo->Xatom_wm_protocols
10019 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10020 dpyinfo->Xatom_wm_take_focus
10021 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10022 dpyinfo->Xatom_wm_save_yourself
10023 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10024 dpyinfo->Xatom_wm_delete_window
10025 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10026 dpyinfo->Xatom_wm_change_state
10027 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10028 dpyinfo->Xatom_wm_configure_denied
10029 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10030 dpyinfo->Xatom_wm_window_moved
10031 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10032 dpyinfo->Xatom_wm_client_leader
10033 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10034 dpyinfo->Xatom_editres
10035 = XInternAtom (dpyinfo->display, "Editres", False);
10036 dpyinfo->Xatom_CLIPBOARD
10037 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10038 dpyinfo->Xatom_TIMESTAMP
10039 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10040 dpyinfo->Xatom_TEXT
10041 = XInternAtom (dpyinfo->display, "TEXT", False);
10042 dpyinfo->Xatom_COMPOUND_TEXT
10043 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10044 dpyinfo->Xatom_UTF8_STRING
10045 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10046 dpyinfo->Xatom_DELETE
10047 = XInternAtom (dpyinfo->display, "DELETE", False);
10048 dpyinfo->Xatom_MULTIPLE
10049 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10050 dpyinfo->Xatom_INCR
10051 = XInternAtom (dpyinfo->display, "INCR", False);
10052 dpyinfo->Xatom_EMACS_TMP
10053 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10054 dpyinfo->Xatom_TARGETS
10055 = XInternAtom (dpyinfo->display, "TARGETS", False);
10056 dpyinfo->Xatom_NULL
10057 = XInternAtom (dpyinfo->display, "NULL", False);
10058 dpyinfo->Xatom_ATOM_PAIR
10059 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10060 /* For properties of font. */
10061 dpyinfo->Xatom_PIXEL_SIZE
10062 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10063 dpyinfo->Xatom_AVERAGE_WIDTH
10064 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10065 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10066 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10067 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10068 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10069 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10070 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10072 /* Ghostscript support. */
10073 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10074 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10076 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10077 False);
10079 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10080 False);
10082 dpyinfo->Xatom_net_wm_state
10083 = XInternAtom (dpyinfo->display, "_NET_WM_STATE", False);
10084 dpyinfo->Xatom_net_wm_state_fullscreen_atom
10085 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_FULLSCREEN", False);
10086 dpyinfo->Xatom_net_wm_state_maximized_horz
10087 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_MAXIMIZED_HORZ", False);
10088 dpyinfo->Xatom_net_wm_state_maximized_vert
10089 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_MAXIMIZED_VERT", False);
10090 dpyinfo->Xatom_net_wm_state_sticky
10091 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_STICKY", False);
10092 dpyinfo->Xatom_net_window_type
10093 = XInternAtom (dpyinfo->display, "_NET_WM_WINDOW_TYPE", False);
10094 dpyinfo->Xatom_net_window_type_tooltip
10095 = XInternAtom (dpyinfo->display, "_NET_WM_WINDOW_TYPE_TOOLTIP", False);
10096 dpyinfo->Xatom_net_wm_icon_name
10097 = XInternAtom (dpyinfo->display, "_NET_WM_ICON_NAME", False);
10098 dpyinfo->Xatom_net_wm_name
10099 = XInternAtom (dpyinfo->display, "_NET_WM_NAME", False);
10101 dpyinfo->cut_buffers_initialized = 0;
10103 dpyinfo->x_dnd_atoms_size = 8;
10104 dpyinfo->x_dnd_atoms_length = 0;
10105 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10106 * dpyinfo->x_dnd_atoms_size);
10108 dpyinfo->net_supported_atoms = NULL;
10109 dpyinfo->nr_net_supported_atoms = 0;
10110 dpyinfo->net_supported_window = 0;
10112 connection = ConnectionNumber (dpyinfo->display);
10113 dpyinfo->connection = connection;
10116 dpyinfo->gray
10117 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10118 gray_bitmap_bits,
10119 gray_bitmap_width, gray_bitmap_height,
10120 (unsigned long) 1, (unsigned long) 0, 1);
10123 #ifdef HAVE_X_I18N
10124 xim_initialize (dpyinfo, resource_name);
10125 #endif
10127 xsettings_initialize (dpyinfo);
10129 /* This is only needed for distinguishing keyboard and process input. */
10130 if (connection != 0)
10131 add_keyboard_wait_descriptor (connection);
10133 #ifdef F_SETOWN
10134 fcntl (connection, F_SETOWN, getpid ());
10135 #endif /* ! defined (F_SETOWN) */
10137 #ifdef SIGIO
10138 if (interrupt_input)
10139 init_sigio (connection);
10140 #endif /* ! defined (SIGIO) */
10142 #ifdef USE_LUCID
10144 Display *dpy = dpyinfo->display;
10145 XrmValue d, fr, to;
10146 Font font;
10148 d.addr = (XPointer)&dpy;
10149 d.size = sizeof (Display *);
10150 fr.addr = XtDefaultFont;
10151 fr.size = sizeof (XtDefaultFont);
10152 to.size = sizeof (Font *);
10153 to.addr = (XPointer)&font;
10154 x_catch_errors (dpy);
10155 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10156 abort ();
10157 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10158 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10159 x_uncatch_errors ();
10161 #endif
10163 /* See if we should run in synchronous mode. This is useful
10164 for debugging X code. */
10166 Lisp_Object value;
10167 value = display_x_get_resource (dpyinfo,
10168 build_string ("synchronous"),
10169 build_string ("Synchronous"),
10170 Qnil, Qnil);
10171 if (STRINGP (value)
10172 && (!strcmp (SDATA (value), "true")
10173 || !strcmp (SDATA (value), "on")))
10174 XSynchronize (dpyinfo->display, True);
10178 Lisp_Object value;
10179 value = display_x_get_resource (dpyinfo,
10180 build_string ("useXIM"),
10181 build_string ("UseXIM"),
10182 Qnil, Qnil);
10183 #ifdef USE_XIM
10184 if (STRINGP (value)
10185 && (!strcmp (SDATA (value), "false")
10186 || !strcmp (SDATA (value), "off")))
10187 use_xim = 0;
10188 #else
10189 if (STRINGP (value)
10190 && (!strcmp (SDATA (value), "true")
10191 || !strcmp (SDATA (value), "on")))
10192 use_xim = 1;
10193 #endif
10196 #ifdef HAVE_X_SM
10197 /* Only do this for the very first display in the Emacs session.
10198 Ignore X session management when Emacs was first started on a
10199 tty. */
10200 if (terminal->id == 1)
10201 x_session_initialize (dpyinfo);
10202 #endif
10204 UNBLOCK_INPUT;
10206 return dpyinfo;
10209 /* Get rid of display DPYINFO, deleting all frames on it,
10210 and without sending any more commands to the X server. */
10212 void
10213 x_delete_display (struct x_display_info *dpyinfo)
10215 struct terminal *t;
10217 /* Close all frames and delete the generic struct terminal for this
10218 X display. */
10219 for (t = terminal_list; t; t = t->next_terminal)
10220 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10222 #ifdef HAVE_X_SM
10223 /* Close X session management when we close its display. */
10224 if (t->id == 1 && x_session_have_connection ())
10225 x_session_close ();
10226 #endif
10227 delete_terminal (t);
10228 break;
10231 delete_keyboard_wait_descriptor (dpyinfo->connection);
10233 /* Discard this display from x_display_name_list and x_display_list.
10234 We can't use Fdelq because that can quit. */
10235 if (! NILP (x_display_name_list)
10236 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10237 x_display_name_list = XCDR (x_display_name_list);
10238 else
10240 Lisp_Object tail;
10242 tail = x_display_name_list;
10243 while (CONSP (tail) && CONSP (XCDR (tail)))
10245 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10247 XSETCDR (tail, XCDR (XCDR (tail)));
10248 break;
10250 tail = XCDR (tail);
10254 if (next_noop_dpyinfo == dpyinfo)
10255 next_noop_dpyinfo = dpyinfo->next;
10257 if (x_display_list == dpyinfo)
10258 x_display_list = dpyinfo->next;
10259 else
10261 struct x_display_info *tail;
10263 for (tail = x_display_list; tail; tail = tail->next)
10264 if (tail->next == dpyinfo)
10265 tail->next = tail->next->next;
10268 xfree (dpyinfo->x_id_name);
10269 xfree (dpyinfo->x_dnd_atoms);
10270 xfree (dpyinfo->color_cells);
10271 xfree (dpyinfo);
10274 #ifdef USE_X_TOOLKIT
10276 /* Atimer callback function for TIMER. Called every 0.1s to process
10277 Xt timeouts, if needed. We must avoid calling XtAppPending as
10278 much as possible because that function does an implicit XFlush
10279 that slows us down. */
10281 static void
10282 x_process_timeouts (struct atimer *timer)
10284 BLOCK_INPUT;
10285 x_timeout_atimer_activated_flag = 0;
10286 if (toolkit_scroll_bar_interaction || popup_activated ())
10288 while (XtAppPending (Xt_app_con) & XtIMTimer)
10289 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10290 /* Reactivate the atimer for next time. */
10291 x_activate_timeout_atimer ();
10293 UNBLOCK_INPUT;
10296 /* Install an asynchronous timer that processes Xt timeout events
10297 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10298 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10299 function whenever these variables are set. This is necessary
10300 because some widget sets use timeouts internally, for example the
10301 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10302 processed, these widgets don't behave normally. */
10304 void
10305 x_activate_timeout_atimer (void)
10307 BLOCK_INPUT;
10308 if (!x_timeout_atimer_activated_flag)
10310 EMACS_TIME interval;
10312 EMACS_SET_SECS_USECS (interval, 0, 100000);
10313 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10314 x_timeout_atimer_activated_flag = 1;
10316 UNBLOCK_INPUT;
10319 #endif /* USE_X_TOOLKIT */
10322 /* Set up use of X before we make the first connection. */
10324 extern frame_parm_handler x_frame_parm_handlers[];
10326 static struct redisplay_interface x_redisplay_interface =
10328 x_frame_parm_handlers,
10329 x_produce_glyphs,
10330 x_write_glyphs,
10331 x_insert_glyphs,
10332 x_clear_end_of_line,
10333 x_scroll_run,
10334 x_after_update_window_line,
10335 x_update_window_begin,
10336 x_update_window_end,
10337 x_cursor_to,
10338 x_flush,
10339 #ifdef XFlush
10340 x_flush,
10341 #else
10342 0, /* flush_display_optional */
10343 #endif
10344 x_clear_window_mouse_face,
10345 x_get_glyph_overhangs,
10346 x_fix_overlapping_area,
10347 x_draw_fringe_bitmap,
10348 0, /* define_fringe_bitmap */
10349 0, /* destroy_fringe_bitmap */
10350 x_compute_glyph_string_overhangs,
10351 x_draw_glyph_string,
10352 x_define_frame_cursor,
10353 x_clear_frame_area,
10354 x_draw_window_cursor,
10355 x_draw_vertical_window_border,
10356 x_shift_glyphs_for_insert
10360 /* This function is called when the last frame on a display is deleted. */
10361 void
10362 x_delete_terminal (struct terminal *terminal)
10364 struct x_display_info *dpyinfo = terminal->display_info.x;
10366 /* Protect against recursive calls. delete_frame in
10367 delete_terminal calls us back when it deletes our last frame. */
10368 if (!terminal->name)
10369 return;
10371 BLOCK_INPUT;
10372 #ifdef HAVE_X_I18N
10373 /* We must close our connection to the XIM server before closing the
10374 X display. */
10375 if (dpyinfo->xim)
10376 xim_close_dpy (dpyinfo);
10377 #endif
10379 /* If called from x_connection_closed, the display may already be closed
10380 and dpyinfo->display was set to 0 to indicate that. */
10381 if (dpyinfo->display)
10383 x_destroy_all_bitmaps (dpyinfo);
10384 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10386 /* Whether or not XCloseDisplay destroys the associated resource
10387 database depends on the version of libX11. To avoid both
10388 crash and memory leak, we dissociate the database from the
10389 display and then destroy dpyinfo->xrdb ourselves.
10391 Unfortunately, the above strategy does not work in some
10392 situations due to a bug in newer versions of libX11: because
10393 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10394 dpy->db is NULL, XCloseDisplay destroys the associated
10395 database whereas it has not been created by XGetDefault
10396 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10397 don't destroy the database here in order to avoid the crash
10398 in the above situations for now, though that may cause memory
10399 leaks in other situations. */
10400 #if 0
10401 #ifdef HAVE_XRMSETDATABASE
10402 XrmSetDatabase (dpyinfo->display, NULL);
10403 #else
10404 dpyinfo->display->db = NULL;
10405 #endif
10406 /* We used to call XrmDestroyDatabase from x_delete_display, but
10407 some older versions of libX11 crash if we call it after
10408 closing all the displays. */
10409 XrmDestroyDatabase (dpyinfo->xrdb);
10410 #endif
10412 #ifdef USE_GTK
10413 xg_display_close (dpyinfo->display);
10414 #else
10415 #ifdef USE_X_TOOLKIT
10416 XtCloseDisplay (dpyinfo->display);
10417 #else
10418 XCloseDisplay (dpyinfo->display);
10419 #endif
10420 #endif /* ! USE_GTK */
10423 /* Mark as dead. */
10424 dpyinfo->display = NULL;
10425 x_delete_display (dpyinfo);
10426 UNBLOCK_INPUT;
10429 /* Create a struct terminal, initialize it with the X11 specific
10430 functions and make DISPLAY->TERMINAL point to it. */
10432 static struct terminal *
10433 x_create_terminal (struct x_display_info *dpyinfo)
10435 struct terminal *terminal;
10437 terminal = create_terminal ();
10439 terminal->type = output_x_window;
10440 terminal->display_info.x = dpyinfo;
10441 dpyinfo->terminal = terminal;
10443 /* kboard is initialized in x_term_init. */
10445 terminal->clear_frame_hook = x_clear_frame;
10446 terminal->ins_del_lines_hook = x_ins_del_lines;
10447 terminal->delete_glyphs_hook = x_delete_glyphs;
10448 terminal->ring_bell_hook = XTring_bell;
10449 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10450 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10451 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10452 terminal->update_begin_hook = x_update_begin;
10453 terminal->update_end_hook = x_update_end;
10454 terminal->set_terminal_window_hook = XTset_terminal_window;
10455 terminal->read_socket_hook = XTread_socket;
10456 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10457 terminal->mouse_position_hook = XTmouse_position;
10458 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10459 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10460 terminal->fullscreen_hook = XTfullscreen_hook;
10461 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10462 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10463 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10464 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10466 terminal->delete_frame_hook = x_destroy_window;
10467 terminal->delete_terminal_hook = x_delete_terminal;
10469 terminal->rif = &x_redisplay_interface;
10470 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10471 terminal->char_ins_del_ok = 1;
10472 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10473 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10474 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10475 off the bottom. */
10477 return terminal;
10480 void
10481 x_initialize (void)
10483 baud_rate = 19200;
10485 x_noop_count = 0;
10486 last_tool_bar_item = -1;
10487 any_help_event_p = 0;
10488 ignore_next_mouse_click_timeout = 0;
10489 #ifdef HAVE_X_SM
10490 x_session_initialized = 0;
10491 #endif
10493 #ifdef USE_GTK
10494 current_count = -1;
10495 #endif
10497 /* Try to use interrupt input; if we can't, then start polling. */
10498 Fset_input_interrupt_mode (Qt);
10500 #ifdef USE_X_TOOLKIT
10501 XtToolkitInitialize ();
10503 Xt_app_con = XtCreateApplicationContext ();
10505 /* Register a converter from strings to pixels, which uses
10506 Emacs' color allocation infrastructure. */
10507 XtAppSetTypeConverter (Xt_app_con,
10508 XtRString, XtRPixel, cvt_string_to_pixel,
10509 cvt_string_to_pixel_args,
10510 XtNumber (cvt_string_to_pixel_args),
10511 XtCacheByDisplay, cvt_pixel_dtor);
10513 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10514 #endif
10516 #ifdef USE_TOOLKIT_SCROLL_BARS
10517 #ifndef USE_GTK
10518 xaw3d_arrow_scroll = False;
10519 xaw3d_pick_top = True;
10520 #endif
10521 #endif
10523 pending_autoraise_frame = 0;
10524 pending_event_wait.f = 0;
10525 pending_event_wait.eventtype = 0;
10527 /* Note that there is no real way portable across R3/R4 to get the
10528 original error handler. */
10529 XSetErrorHandler (x_error_handler);
10530 XSetIOErrorHandler (x_io_error_quitter);
10532 signal (SIGPIPE, x_connection_signal);
10534 xgselect_initialize ();
10538 void
10539 syms_of_xterm (void)
10541 x_error_message = NULL;
10543 staticpro (&x_display_name_list);
10544 x_display_name_list = Qnil;
10546 staticpro (&last_mouse_scroll_bar);
10547 last_mouse_scroll_bar = Qnil;
10549 staticpro (&Qvendor_specific_keysyms);
10550 Qvendor_specific_keysyms = intern_c_string ("vendor-specific-keysyms");
10552 staticpro (&Qlatin_1);
10553 Qlatin_1 = intern_c_string ("latin-1");
10555 staticpro (&last_mouse_press_frame);
10556 last_mouse_press_frame = Qnil;
10558 #ifdef USE_GTK
10559 xg_default_icon_file = make_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10560 staticpro (&xg_default_icon_file);
10562 Qx_gtk_map_stock = intern_c_string ("x-gtk-map-stock");
10563 staticpro (&Qx_gtk_map_stock);
10564 #endif
10566 DEFVAR_BOOL ("x-use-underline-position-properties",
10567 &x_use_underline_position_properties,
10568 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10569 A value of nil means ignore them. If you encounter fonts with bogus
10570 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10571 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10572 to override the font's UNDERLINE_POSITION for small font display
10573 sizes. */);
10574 x_use_underline_position_properties = 1;
10576 DEFVAR_BOOL ("x-underline-at-descent-line",
10577 &x_underline_at_descent_line,
10578 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10579 A value of nil means to draw the underline according to the value of the
10580 variable `x-use-underline-position-properties', which is usually at the
10581 baseline level. The default value is nil. */);
10582 x_underline_at_descent_line = 0;
10584 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10585 &x_mouse_click_focus_ignore_position,
10586 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10587 This variable is only used when the window manager requires that you
10588 click on a frame to select it (give it focus). In that case, a value
10589 of nil, means that the selected window and cursor position changes to
10590 reflect the mouse click position, while a non-nil value means that the
10591 selected window or cursor position is preserved. */);
10592 x_mouse_click_focus_ignore_position = 0;
10594 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10595 doc: /* What X toolkit scroll bars Emacs uses.
10596 A value of nil means Emacs doesn't use X toolkit scroll bars.
10597 Otherwise, value is a symbol describing the X toolkit. */);
10598 #ifdef USE_TOOLKIT_SCROLL_BARS
10599 #ifdef USE_MOTIF
10600 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10601 #elif defined HAVE_XAW3D
10602 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10603 #elif USE_GTK
10604 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10605 #else
10606 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10607 #endif
10608 #else
10609 Vx_toolkit_scroll_bars = Qnil;
10610 #endif
10612 staticpro (&last_mouse_motion_frame);
10613 last_mouse_motion_frame = Qnil;
10615 Qmodifier_value = intern_c_string ("modifier-value");
10616 Qalt = intern_c_string ("alt");
10617 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10618 Qhyper = intern_c_string ("hyper");
10619 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10620 Qmeta = intern_c_string ("meta");
10621 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10622 Qsuper = intern_c_string ("super");
10623 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10625 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10626 doc: /* Which keys Emacs uses for the alt modifier.
10627 This should be one of the symbols `alt', `hyper', `meta', `super'.
10628 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10629 is nil, which is the same as `alt'. */);
10630 Vx_alt_keysym = Qnil;
10632 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10633 doc: /* Which keys Emacs uses for the hyper modifier.
10634 This should be one of the symbols `alt', `hyper', `meta', `super'.
10635 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10636 default is nil, which is the same as `hyper'. */);
10637 Vx_hyper_keysym = Qnil;
10639 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10640 doc: /* Which keys Emacs uses for the meta modifier.
10641 This should be one of the symbols `alt', `hyper', `meta', `super'.
10642 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10643 default is nil, which is the same as `meta'. */);
10644 Vx_meta_keysym = Qnil;
10646 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10647 doc: /* Which keys Emacs uses for the super modifier.
10648 This should be one of the symbols `alt', `hyper', `meta', `super'.
10649 For example, `super' means use the Super_L and Super_R keysyms. The
10650 default is nil, which is the same as `super'. */);
10651 Vx_super_keysym = Qnil;
10653 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10654 doc: /* Hash table of character codes indexed by X keysym codes. */);
10655 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10656 make_float (DEFAULT_REHASH_SIZE),
10657 make_float (DEFAULT_REHASH_THRESHOLD),
10658 Qnil, Qnil, Qnil);
10661 #endif /* HAVE_X_WINDOWS */
10663 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10664 (do not change this comment) */