* ftfont.c (ftfont_shape_by_flt): Use signed integers for lengths.
[emacs.git] / src / xterm.c
blobf40d260dabe134b6c4890ad48af14c747c127f31
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
21 /* Xt features made by Fred Pierresteguy. */
23 #include <config.h>
24 #include <signal.h>
25 #include <stdio.h>
26 #include <setjmp.h>
28 #ifdef HAVE_X_WINDOWS
30 #include "lisp.h"
31 #include "blockinput.h"
33 /* Need syssignal.h for various externs and definitions that may be required
34 by some configurations for calls to signal later in this source file. */
35 #include "syssignal.h"
37 /* This may include sys/types.h, and that somehow loses
38 if this is not done before the other system files. */
39 #include "xterm.h"
40 #include <X11/cursorfont.h>
42 /* Load sys/types.h if not already loaded.
43 In some systems loading it twice is suicidal. */
44 #ifndef makedev
45 #include <sys/types.h>
46 #endif /* makedev */
48 #include <sys/ioctl.h>
50 #include "systime.h"
52 #include <fcntl.h>
53 #include <ctype.h>
54 #include <errno.h>
55 #include <setjmp.h>
56 #include <sys/stat.h>
57 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
58 /* #include <sys/param.h> */
60 #include "charset.h"
61 #include "character.h"
62 #include "coding.h"
63 #include "frame.h"
64 #include "dispextern.h"
65 #include "fontset.h"
66 #include "termhooks.h"
67 #include "termopts.h"
68 #include "termchar.h"
69 #include "emacs-icon.h"
70 #include "disptab.h"
71 #include "buffer.h"
72 #include "window.h"
73 #include "keyboard.h"
74 #include "intervals.h"
75 #include "process.h"
76 #include "atimer.h"
77 #include "keymap.h"
78 #include "font.h"
79 #include "fontset.h"
80 #include "xsettings.h"
81 #include "xgselect.h"
82 #include "sysselect.h"
84 #ifdef USE_X_TOOLKIT
85 #include <X11/Shell.h>
86 #endif
88 #ifdef HAVE_SYS_TIME_H
89 #include <sys/time.h>
90 #endif
92 #include <unistd.h>
94 #ifdef USE_GTK
95 #include "gtkutil.h"
96 #endif
98 #ifdef USE_LUCID
99 #include "../lwlib/xlwmenu.h"
100 #endif
102 #ifdef USE_X_TOOLKIT
103 #if !defined(NO_EDITRES)
104 #define HACK_EDITRES
105 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
106 #endif /* not NO_EDITRES */
108 /* Include toolkit specific headers for the scroll bar widget. */
110 #ifdef USE_TOOLKIT_SCROLL_BARS
111 #if defined USE_MOTIF
112 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
113 #include <Xm/ScrollBar.h>
114 #else /* !USE_MOTIF i.e. use Xaw */
116 #ifdef HAVE_XAW3D
117 #include <X11/Xaw3d/Simple.h>
118 #include <X11/Xaw3d/Scrollbar.h>
119 #include <X11/Xaw3d/ThreeD.h>
120 #else /* !HAVE_XAW3D */
121 #include <X11/Xaw/Simple.h>
122 #include <X11/Xaw/Scrollbar.h>
123 #endif /* !HAVE_XAW3D */
124 #ifndef XtNpickTop
125 #define XtNpickTop "pickTop"
126 #endif /* !XtNpickTop */
127 #endif /* !USE_MOTIF */
128 #endif /* USE_TOOLKIT_SCROLL_BARS */
130 #endif /* USE_X_TOOLKIT */
132 #ifdef USE_X_TOOLKIT
133 #include "widget.h"
134 #ifndef XtNinitialState
135 #define XtNinitialState "initialState"
136 #endif
137 #endif
139 /* Default to using XIM if available. */
140 #ifdef USE_XIM
141 int use_xim = 1;
142 #else
143 int use_xim = 0; /* configure --without-xim */
144 #endif
148 /* Non-zero means that a HELP_EVENT has been generated since Emacs
149 start. */
151 static int any_help_event_p;
153 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
154 static Lisp_Object last_window;
156 /* This is a chain of structures for all the X displays currently in
157 use. */
159 struct x_display_info *x_display_list;
161 /* This is a list of cons cells, each of the form (NAME
162 . FONT-LIST-CACHE), one for each element of x_display_list and in
163 the same order. NAME is the name of the frame. FONT-LIST-CACHE
164 records previous values returned by x-list-fonts. */
166 Lisp_Object x_display_name_list;
168 /* Frame being updated by update_frame. This is declared in term.c.
169 This is set by update_begin and looked at by all the XT functions.
170 It is zero while not inside an update. In that case, the XT
171 functions assume that `selected_frame' is the frame to apply to. */
173 extern struct frame *updating_frame;
175 /* This is a frame waiting to be auto-raised, within XTread_socket. */
177 static struct frame *pending_autoraise_frame;
179 /* This is a frame waiting for an event matching mask, within XTread_socket. */
181 static struct {
182 struct frame *f;
183 int eventtype;
184 } pending_event_wait;
186 #ifdef USE_X_TOOLKIT
187 /* The application context for Xt use. */
188 XtAppContext Xt_app_con;
189 static String Xt_default_resources[] = {0};
191 /* Non-zero means user is interacting with a toolkit scroll bar. */
193 static int toolkit_scroll_bar_interaction;
194 #endif /* USE_X_TOOLKIT */
196 /* Non-zero timeout value means ignore next mouse click if it arrives
197 before that timeout elapses (i.e. as part of the same sequence of
198 events resulting from clicking on a frame to select it). */
200 static unsigned long ignore_next_mouse_click_timeout;
202 /* Mouse movement.
204 Formerly, we used PointerMotionHintMask (in standard_event_mask)
205 so that we would have to call XQueryPointer after each MotionNotify
206 event to ask for another such event. However, this made mouse tracking
207 slow, and there was a bug that made it eventually stop.
209 Simply asking for MotionNotify all the time seems to work better.
211 In order to avoid asking for motion events and then throwing most
212 of them away or busy-polling the server for mouse positions, we ask
213 the server for pointer motion hints. This means that we get only
214 one event per group of mouse movements. "Groups" are delimited by
215 other kinds of events (focus changes and button clicks, for
216 example), or by XQueryPointer calls; when one of these happens, we
217 get another MotionNotify event the next time the mouse moves. This
218 is at least as efficient as getting motion events when mouse
219 tracking is on, and I suspect only negligibly worse when tracking
220 is off. */
222 /* Where the mouse was last time we reported a mouse event. */
224 static XRectangle last_mouse_glyph;
225 static FRAME_PTR last_mouse_glyph_frame;
226 static Lisp_Object last_mouse_press_frame;
228 /* The scroll bar in which the last X motion event occurred.
230 If the last X motion event occurred in a scroll bar, we set this so
231 XTmouse_position can know whether to report a scroll bar motion or
232 an ordinary motion.
234 If the last X motion event didn't occur in a scroll bar, we set
235 this to Qnil, to tell XTmouse_position to return an ordinary motion
236 event. */
238 static Lisp_Object last_mouse_scroll_bar;
240 /* This is a hack. We would really prefer that XTmouse_position would
241 return the time associated with the position it returns, but there
242 doesn't seem to be any way to wrest the time-stamp from the server
243 along with the position query. So, we just keep track of the time
244 of the last movement we received, and return that in hopes that
245 it's somewhat accurate. */
247 static Time last_mouse_movement_time;
249 /* Time for last user interaction as returned in X events. */
251 static Time last_user_time;
253 /* Incremented by XTread_socket whenever it really tries to read
254 events. */
256 #ifdef __STDC__
257 static int volatile input_signal_count;
258 #else
259 static int input_signal_count;
260 #endif
262 /* Used locally within XTread_socket. */
264 static int x_noop_count;
266 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
268 static Lisp_Object Qvendor_specific_keysyms;
269 static Lisp_Object Qlatin_1;
271 #ifdef USE_GTK
272 /* The name of the Emacs icon file. */
273 static Lisp_Object xg_default_icon_file;
275 /* Used in gtkutil.c. */
276 Lisp_Object Qx_gtk_map_stock;
277 #endif
279 /* Some functions take this as char *, not const char *. */
280 static char emacs_class[] = EMACS_CLASS;
282 enum xembed_info
284 XEMBED_MAPPED = 1 << 0
287 enum xembed_message
289 XEMBED_EMBEDDED_NOTIFY = 0,
290 XEMBED_WINDOW_ACTIVATE = 1,
291 XEMBED_WINDOW_DEACTIVATE = 2,
292 XEMBED_REQUEST_FOCUS = 3,
293 XEMBED_FOCUS_IN = 4,
294 XEMBED_FOCUS_OUT = 5,
295 XEMBED_FOCUS_NEXT = 6,
296 XEMBED_FOCUS_PREV = 7,
298 XEMBED_MODALITY_ON = 10,
299 XEMBED_MODALITY_OFF = 11,
300 XEMBED_REGISTER_ACCELERATOR = 12,
301 XEMBED_UNREGISTER_ACCELERATOR = 13,
302 XEMBED_ACTIVATE_ACCELERATOR = 14
305 /* Used in x_flush. */
307 static int x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
308 static void x_set_window_size_1 (struct frame *, int, int, int);
309 static void x_raise_frame (struct frame *);
310 static void x_lower_frame (struct frame *);
311 static const XColor *x_color_cells (Display *, int *);
312 static void x_update_window_end (struct window *, int, int);
314 static int x_io_error_quitter (Display *);
315 static struct terminal *x_create_terminal (struct x_display_info *);
316 void x_delete_terminal (struct terminal *);
317 static void x_update_end (struct frame *);
318 static void XTframe_up_to_date (struct frame *);
319 static void XTset_terminal_modes (struct terminal *);
320 static void XTreset_terminal_modes (struct terminal *);
321 static void x_clear_frame (struct frame *);
322 static void x_ins_del_lines (struct frame *, int, int) NO_RETURN;
323 static void frame_highlight (struct frame *);
324 static void frame_unhighlight (struct frame *);
325 static void x_new_focus_frame (struct x_display_info *, struct frame *);
326 static void x_focus_changed (int, int, struct x_display_info *,
327 struct frame *, struct input_event *);
328 static void x_detect_focus_change (struct x_display_info *,
329 XEvent *, struct input_event *);
330 static void XTframe_rehighlight (struct frame *);
331 static void x_frame_rehighlight (struct x_display_info *);
332 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
333 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
334 enum text_cursor_kinds);
336 static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
337 static void x_flush (struct frame *f);
338 static void x_update_begin (struct frame *);
339 static void x_update_window_begin (struct window *);
340 static void x_after_update_window_line (struct glyph_row *);
341 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
342 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
343 enum scroll_bar_part *,
344 Lisp_Object *, Lisp_Object *,
345 Time *);
346 static void x_handle_net_wm_state (struct frame *, XPropertyEvent *);
347 static void x_check_fullscreen (struct frame *);
348 static void x_check_expected_move (struct frame *, int, int);
349 static void x_sync_with_move (struct frame *, int, int, int);
350 static int handle_one_xevent (struct x_display_info *, XEvent *,
351 int *, struct input_event *);
352 #ifdef USE_GTK
353 static int x_dispatch_event (XEvent *, Display *);
354 #endif
355 /* Don't declare this NO_RETURN because we want no
356 interference with debugging failing X calls. */
357 static void x_connection_closed (Display *, const char *);
358 static void x_wm_set_window_state (struct frame *, int);
359 static void x_wm_set_icon_pixmap (struct frame *, int);
360 static void x_initialize (void);
363 /* Flush display of frame F, or of all frames if F is null. */
365 static void
366 x_flush (struct frame *f)
368 /* Don't call XFlush when it is not safe to redisplay; the X
369 connection may be broken. */
370 if (!NILP (Vinhibit_redisplay))
371 return;
373 BLOCK_INPUT;
374 if (f == NULL)
376 Lisp_Object rest, frame;
377 FOR_EACH_FRAME (rest, frame)
378 if (FRAME_X_P (XFRAME (frame)))
379 x_flush (XFRAME (frame));
381 else if (FRAME_X_P (f))
382 XFlush (FRAME_X_DISPLAY (f));
383 UNBLOCK_INPUT;
387 /* Remove calls to XFlush by defining XFlush to an empty replacement.
388 Calls to XFlush should be unnecessary because the X output buffer
389 is flushed automatically as needed by calls to XPending,
390 XNextEvent, or XWindowEvent according to the XFlush man page.
391 XTread_socket calls XPending. Removing XFlush improves
392 performance. */
394 #define XFlush(DISPLAY) (void) 0
397 /***********************************************************************
398 Debugging
399 ***********************************************************************/
401 #if 0
403 /* This is a function useful for recording debugging information about
404 the sequence of occurrences in this file. */
406 struct record
408 char *locus;
409 int type;
412 struct record event_record[100];
414 int event_record_index;
416 void
417 record_event (char *locus, int type)
419 if (event_record_index == sizeof (event_record) / sizeof (struct record))
420 event_record_index = 0;
422 event_record[event_record_index].locus = locus;
423 event_record[event_record_index].type = type;
424 event_record_index++;
427 #endif /* 0 */
431 /* Return the struct x_display_info corresponding to DPY. */
433 struct x_display_info *
434 x_display_info_for_display (Display *dpy)
436 struct x_display_info *dpyinfo;
438 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
439 if (dpyinfo->display == dpy)
440 return dpyinfo;
442 return 0;
445 #define OPAQUE 0xffffffff
447 void
448 x_set_frame_alpha (struct frame *f)
450 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
451 Display *dpy = FRAME_X_DISPLAY (f);
452 Window win = FRAME_OUTER_WINDOW (f);
453 double alpha = 1.0;
454 double alpha_min = 1.0;
455 unsigned long opac;
457 if (dpyinfo->x_highlight_frame == f)
458 alpha = f->alpha[0];
459 else
460 alpha = f->alpha[1];
462 if (FLOATP (Vframe_alpha_lower_limit))
463 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
464 else if (INTEGERP (Vframe_alpha_lower_limit))
465 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
467 if (alpha < 0.0)
468 return;
469 else if (alpha > 1.0)
470 alpha = 1.0;
471 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
472 alpha = alpha_min;
474 opac = alpha * OPAQUE;
476 /* return unless necessary */
478 unsigned char *data;
479 Atom actual;
480 int rc, format;
481 unsigned long n, left;
483 x_catch_errors (dpy);
484 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
485 0L, 1L, False, XA_CARDINAL,
486 &actual, &format, &n, &left,
487 &data);
489 if (rc == Success && actual != None)
491 unsigned long value = *(unsigned long *)data;
492 XFree ((void *) data);
493 if (value == opac)
495 x_uncatch_errors ();
496 return;
501 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
502 XA_CARDINAL, 32, PropModeReplace,
503 (unsigned char *) &opac, 1L);
504 x_uncatch_errors ();
508 x_display_pixel_height (struct x_display_info *dpyinfo)
510 return HeightOfScreen (dpyinfo->screen);
514 x_display_pixel_width (struct x_display_info *dpyinfo)
516 return WidthOfScreen (dpyinfo->screen);
520 /***********************************************************************
521 Starting and ending an update
522 ***********************************************************************/
524 /* Start an update of frame F. This function is installed as a hook
525 for update_begin, i.e. it is called when update_begin is called.
526 This function is called prior to calls to x_update_window_begin for
527 each window being updated. Currently, there is nothing to do here
528 because all interesting stuff is done on a window basis. */
530 static void
531 x_update_begin (struct frame *f)
533 /* Nothing to do. */
537 /* Start update of window W. Set the global variable updated_window
538 to the window being updated and set output_cursor to the cursor
539 position of W. */
541 static void
542 x_update_window_begin (struct window *w)
544 struct frame *f = XFRAME (WINDOW_FRAME (w));
545 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
547 updated_window = w;
548 set_output_cursor (&w->cursor);
550 BLOCK_INPUT;
552 if (f == hlinfo->mouse_face_mouse_frame)
554 /* Don't do highlighting for mouse motion during the update. */
555 hlinfo->mouse_face_defer = 1;
557 /* If F needs to be redrawn, simply forget about any prior mouse
558 highlighting. */
559 if (FRAME_GARBAGED_P (f))
560 hlinfo->mouse_face_window = Qnil;
563 UNBLOCK_INPUT;
567 /* Draw a vertical window border from (x,y0) to (x,y1) */
569 static void
570 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
572 struct frame *f = XFRAME (WINDOW_FRAME (w));
573 struct face *face;
575 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
576 if (face)
577 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
578 face->foreground);
580 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
581 f->output_data.x->normal_gc, x, y0, x, y1);
584 /* End update of window W (which is equal to updated_window).
586 Draw vertical borders between horizontally adjacent windows, and
587 display W's cursor if CURSOR_ON_P is non-zero.
589 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
590 glyphs in mouse-face were overwritten. In that case we have to
591 make sure that the mouse-highlight is properly redrawn.
593 W may be a menu bar pseudo-window in case we don't have X toolkit
594 support. Such windows don't have a cursor, so don't display it
595 here. */
597 static void
598 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
600 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
602 if (!w->pseudo_window_p)
604 BLOCK_INPUT;
606 if (cursor_on_p)
607 display_and_set_cursor (w, 1, output_cursor.hpos,
608 output_cursor.vpos,
609 output_cursor.x, output_cursor.y);
611 if (draw_window_fringes (w, 1))
612 x_draw_vertical_border (w);
614 UNBLOCK_INPUT;
617 /* If a row with mouse-face was overwritten, arrange for
618 XTframe_up_to_date to redisplay the mouse highlight. */
619 if (mouse_face_overwritten_p)
621 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
622 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
623 hlinfo->mouse_face_window = Qnil;
626 updated_window = NULL;
630 /* End update of frame F. This function is installed as a hook in
631 update_end. */
633 static void
634 x_update_end (struct frame *f)
636 /* Mouse highlight may be displayed again. */
637 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
639 #ifndef XFlush
640 BLOCK_INPUT;
641 XFlush (FRAME_X_DISPLAY (f));
642 UNBLOCK_INPUT;
643 #endif
647 /* This function is called from various places in xdisp.c whenever a
648 complete update has been performed. The global variable
649 updated_window is not available here. */
651 static void
652 XTframe_up_to_date (struct frame *f)
654 if (FRAME_X_P (f))
656 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
658 if (hlinfo->mouse_face_deferred_gc
659 || f == hlinfo->mouse_face_mouse_frame)
661 BLOCK_INPUT;
662 if (hlinfo->mouse_face_mouse_frame)
663 note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
664 hlinfo->mouse_face_mouse_x,
665 hlinfo->mouse_face_mouse_y);
666 hlinfo->mouse_face_deferred_gc = 0;
667 UNBLOCK_INPUT;
673 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
674 arrow bitmaps, or clear the fringes if no bitmaps are required
675 before DESIRED_ROW is made current. The window being updated is
676 found in updated_window. This function It is called from
677 update_window_line only if it is known that there are differences
678 between bitmaps to be drawn between current row and DESIRED_ROW. */
680 static void
681 x_after_update_window_line (struct glyph_row *desired_row)
683 struct window *w = updated_window;
684 struct frame *f;
685 int width, height;
687 xassert (w);
689 if (!desired_row->mode_line_p && !w->pseudo_window_p)
690 desired_row->redraw_fringe_bitmaps_p = 1;
692 /* When a window has disappeared, make sure that no rest of
693 full-width rows stays visible in the internal border. Could
694 check here if updated_window is the leftmost/rightmost window,
695 but I guess it's not worth doing since vertically split windows
696 are almost never used, internal border is rarely set, and the
697 overhead is very small. */
698 if (windows_or_buffers_changed
699 && desired_row->full_width_p
700 && (f = XFRAME (w->frame),
701 width = FRAME_INTERNAL_BORDER_WIDTH (f),
702 width != 0)
703 && (height = desired_row->visible_height,
704 height > 0))
706 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
708 BLOCK_INPUT;
709 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
710 0, y, width, height, False);
711 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
712 FRAME_PIXEL_WIDTH (f) - width,
713 y, width, height, False);
714 UNBLOCK_INPUT;
718 static void
719 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
721 struct frame *f = XFRAME (WINDOW_FRAME (w));
722 Display *display = FRAME_X_DISPLAY (f);
723 Window window = FRAME_X_WINDOW (f);
724 GC gc = f->output_data.x->normal_gc;
725 struct face *face = p->face;
727 /* Must clip because of partially visible lines. */
728 x_clip_to_row (w, row, -1, gc);
730 if (!p->overlay_p)
732 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
734 /* In case the same realized face is used for fringes and
735 for something displayed in the text (e.g. face `region' on
736 mono-displays, the fill style may have been changed to
737 FillSolid in x_draw_glyph_string_background. */
738 if (face->stipple)
739 XSetFillStyle (display, face->gc, FillOpaqueStippled);
740 else
741 XSetForeground (display, face->gc, face->background);
743 #ifdef USE_TOOLKIT_SCROLL_BARS
744 /* If the fringe is adjacent to the left (right) scroll bar of a
745 leftmost (rightmost, respectively) window, then extend its
746 background to the gap between the fringe and the bar. */
747 if ((WINDOW_LEFTMOST_P (w)
748 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
749 || (WINDOW_RIGHTMOST_P (w)
750 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
752 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
754 if (sb_width > 0)
756 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
757 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
758 * FRAME_COLUMN_WIDTH (f));
760 if (bx < 0)
762 /* Bitmap fills the fringe. */
763 if (bar_area_x + bar_area_width == p->x)
764 bx = bar_area_x + sb_width;
765 else if (p->x + p->wd == bar_area_x)
766 bx = bar_area_x;
767 if (bx >= 0)
769 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
771 nx = bar_area_width - sb_width;
772 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
773 row->y));
774 ny = row->visible_height;
777 else
779 if (bar_area_x + bar_area_width == bx)
781 bx = bar_area_x + sb_width;
782 nx += bar_area_width - sb_width;
784 else if (bx + nx == bar_area_x)
785 nx += bar_area_width - sb_width;
789 #endif
790 if (bx >= 0 && nx > 0)
791 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
793 if (!face->stipple)
794 XSetForeground (display, face->gc, face->foreground);
797 if (p->which)
799 char *bits;
800 Pixmap pixmap, clipmask = (Pixmap) 0;
801 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
802 XGCValues gcv;
804 if (p->wd > 8)
805 bits = (char *) (p->bits + p->dh);
806 else
807 bits = (char *) p->bits + p->dh;
809 /* Draw the bitmap. I believe these small pixmaps can be cached
810 by the server. */
811 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
812 (p->cursor_p
813 ? (p->overlay_p ? face->background
814 : f->output_data.x->cursor_pixel)
815 : face->foreground),
816 face->background, depth);
818 if (p->overlay_p)
820 clipmask = XCreatePixmapFromBitmapData (display,
821 FRAME_X_DISPLAY_INFO (f)->root_window,
822 bits, p->wd, p->h,
823 1, 0, 1);
824 gcv.clip_mask = clipmask;
825 gcv.clip_x_origin = p->x;
826 gcv.clip_y_origin = p->y;
827 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
830 XCopyArea (display, pixmap, window, gc, 0, 0,
831 p->wd, p->h, p->x, p->y);
832 XFreePixmap (display, pixmap);
834 if (p->overlay_p)
836 gcv.clip_mask = (Pixmap) 0;
837 XChangeGC (display, gc, GCClipMask, &gcv);
838 XFreePixmap (display, clipmask);
842 XSetClipMask (display, gc, None);
847 /* This is called when starting Emacs and when restarting after
848 suspend. When starting Emacs, no X window is mapped. And nothing
849 must be done to Emacs's own window if it is suspended (though that
850 rarely happens). */
852 static void
853 XTset_terminal_modes (struct terminal *terminal)
857 /* This is called when exiting or suspending Emacs. Exiting will make
858 the X-windows go away, and suspending requires no action. */
860 static void
861 XTreset_terminal_modes (struct terminal *terminal)
866 /***********************************************************************
867 Glyph display
868 ***********************************************************************/
872 static void x_set_glyph_string_clipping (struct glyph_string *);
873 static void x_set_glyph_string_gc (struct glyph_string *);
874 static void x_draw_glyph_string_background (struct glyph_string *,
875 int);
876 static void x_draw_glyph_string_foreground (struct glyph_string *);
877 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
878 static void x_draw_glyph_string_box (struct glyph_string *);
879 static void x_draw_glyph_string (struct glyph_string *);
880 static void x_delete_glyphs (struct frame *, int) NO_RETURN;
881 static void x_compute_glyph_string_overhangs (struct glyph_string *);
882 static void x_set_cursor_gc (struct glyph_string *);
883 static void x_set_mode_line_face_gc (struct glyph_string *);
884 static void x_set_mouse_face_gc (struct glyph_string *);
885 static int x_alloc_lighter_color (struct frame *, Display *, Colormap,
886 unsigned long *, double, int);
887 static void x_setup_relief_color (struct frame *, struct relief *,
888 double, int, unsigned long);
889 static void x_setup_relief_colors (struct glyph_string *);
890 static void x_draw_image_glyph_string (struct glyph_string *);
891 static void x_draw_image_relief (struct glyph_string *);
892 static void x_draw_image_foreground (struct glyph_string *);
893 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
894 static void x_clear_glyph_string_rect (struct glyph_string *, int,
895 int, int, int);
896 static void x_draw_relief_rect (struct frame *, int, int, int, int,
897 int, int, int, int, int, int,
898 XRectangle *);
899 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
900 int, int, int, XRectangle *);
901 static void x_scroll_bar_clear (struct frame *);
903 #if GLYPH_DEBUG
904 static void x_check_font (struct frame *, struct font *);
905 #endif
908 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
909 face. */
911 static void
912 x_set_cursor_gc (struct glyph_string *s)
914 if (s->font == FRAME_FONT (s->f)
915 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
916 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
917 && !s->cmp)
918 s->gc = s->f->output_data.x->cursor_gc;
919 else
921 /* Cursor on non-default face: must merge. */
922 XGCValues xgcv;
923 unsigned long mask;
925 xgcv.background = s->f->output_data.x->cursor_pixel;
926 xgcv.foreground = s->face->background;
928 /* If the glyph would be invisible, try a different foreground. */
929 if (xgcv.foreground == xgcv.background)
930 xgcv.foreground = s->face->foreground;
931 if (xgcv.foreground == xgcv.background)
932 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
933 if (xgcv.foreground == xgcv.background)
934 xgcv.foreground = s->face->foreground;
936 /* Make sure the cursor is distinct from text in this face. */
937 if (xgcv.background == s->face->background
938 && xgcv.foreground == s->face->foreground)
940 xgcv.background = s->face->foreground;
941 xgcv.foreground = s->face->background;
944 IF_DEBUG (x_check_font (s->f, s->font));
945 xgcv.graphics_exposures = False;
946 mask = GCForeground | GCBackground | GCGraphicsExposures;
948 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
949 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
950 mask, &xgcv);
951 else
952 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
953 = XCreateGC (s->display, s->window, mask, &xgcv);
955 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
960 /* Set up S->gc of glyph string S for drawing text in mouse face. */
962 static void
963 x_set_mouse_face_gc (struct glyph_string *s)
965 int face_id;
966 struct face *face;
968 /* What face has to be used last for the mouse face? */
969 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
970 face = FACE_FROM_ID (s->f, face_id);
971 if (face == NULL)
972 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
974 if (s->first_glyph->type == CHAR_GLYPH)
975 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
976 else
977 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
978 s->face = FACE_FROM_ID (s->f, face_id);
979 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
981 if (s->font == s->face->font)
982 s->gc = s->face->gc;
983 else
985 /* Otherwise construct scratch_cursor_gc with values from FACE
986 except for FONT. */
987 XGCValues xgcv;
988 unsigned long mask;
990 xgcv.background = s->face->background;
991 xgcv.foreground = s->face->foreground;
992 xgcv.graphics_exposures = False;
993 mask = GCForeground | GCBackground | GCGraphicsExposures;
995 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
996 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
997 mask, &xgcv);
998 else
999 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1000 = XCreateGC (s->display, s->window, mask, &xgcv);
1002 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1005 xassert (s->gc != 0);
1009 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1010 Faces to use in the mode line have already been computed when the
1011 matrix was built, so there isn't much to do, here. */
1013 static inline void
1014 x_set_mode_line_face_gc (struct glyph_string *s)
1016 s->gc = s->face->gc;
1020 /* Set S->gc of glyph string S for drawing that glyph string. Set
1021 S->stippled_p to a non-zero value if the face of S has a stipple
1022 pattern. */
1024 static inline void
1025 x_set_glyph_string_gc (struct glyph_string *s)
1027 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1029 if (s->hl == DRAW_NORMAL_TEXT)
1031 s->gc = s->face->gc;
1032 s->stippled_p = s->face->stipple != 0;
1034 else if (s->hl == DRAW_INVERSE_VIDEO)
1036 x_set_mode_line_face_gc (s);
1037 s->stippled_p = s->face->stipple != 0;
1039 else if (s->hl == DRAW_CURSOR)
1041 x_set_cursor_gc (s);
1042 s->stippled_p = 0;
1044 else if (s->hl == DRAW_MOUSE_FACE)
1046 x_set_mouse_face_gc (s);
1047 s->stippled_p = s->face->stipple != 0;
1049 else if (s->hl == DRAW_IMAGE_RAISED
1050 || s->hl == DRAW_IMAGE_SUNKEN)
1052 s->gc = s->face->gc;
1053 s->stippled_p = s->face->stipple != 0;
1055 else
1057 s->gc = s->face->gc;
1058 s->stippled_p = s->face->stipple != 0;
1061 /* GC must have been set. */
1062 xassert (s->gc != 0);
1066 /* Set clipping for output of glyph string S. S may be part of a mode
1067 line or menu if we don't have X toolkit support. */
1069 static inline void
1070 x_set_glyph_string_clipping (struct glyph_string *s)
1072 XRectangle *r = s->clip;
1073 int n = get_glyph_string_clip_rects (s, r, 2);
1075 if (n > 0)
1076 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1077 s->num_clips = n;
1081 /* Set SRC's clipping for output of glyph string DST. This is called
1082 when we are drawing DST's left_overhang or right_overhang only in
1083 the area of SRC. */
1085 static void
1086 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1088 XRectangle r;
1090 r.x = src->x;
1091 r.width = src->width;
1092 r.y = src->y;
1093 r.height = src->height;
1094 dst->clip[0] = r;
1095 dst->num_clips = 1;
1096 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1100 /* RIF:
1101 Compute left and right overhang of glyph string S. */
1103 static void
1104 x_compute_glyph_string_overhangs (struct glyph_string *s)
1106 if (s->cmp == NULL
1107 && (s->first_glyph->type == CHAR_GLYPH
1108 || s->first_glyph->type == COMPOSITE_GLYPH))
1110 struct font_metrics metrics;
1112 if (s->first_glyph->type == CHAR_GLYPH)
1114 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1115 struct font *font = s->font;
1116 int i;
1118 for (i = 0; i < s->nchars; i++)
1119 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1120 font->driver->text_extents (font, code, s->nchars, &metrics);
1122 else
1124 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1126 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1128 s->right_overhang = (metrics.rbearing > metrics.width
1129 ? metrics.rbearing - metrics.width : 0);
1130 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1132 else if (s->cmp)
1134 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1135 s->left_overhang = - s->cmp->lbearing;
1140 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1142 static inline void
1143 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1145 XGCValues xgcv;
1146 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1147 XSetForeground (s->display, s->gc, xgcv.background);
1148 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1149 XSetForeground (s->display, s->gc, xgcv.foreground);
1153 /* Draw the background of glyph_string S. If S->background_filled_p
1154 is non-zero don't draw it. FORCE_P non-zero means draw the
1155 background even if it wouldn't be drawn normally. This is used
1156 when a string preceding S draws into the background of S, or S
1157 contains the first component of a composition. */
1159 static void
1160 x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1162 /* Nothing to do if background has already been drawn or if it
1163 shouldn't be drawn in the first place. */
1164 if (!s->background_filled_p)
1166 int box_line_width = max (s->face->box_line_width, 0);
1168 if (s->stippled_p)
1170 /* Fill background with a stipple pattern. */
1171 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1172 XFillRectangle (s->display, s->window, s->gc, s->x,
1173 s->y + box_line_width,
1174 s->background_width,
1175 s->height - 2 * box_line_width);
1176 XSetFillStyle (s->display, s->gc, FillSolid);
1177 s->background_filled_p = 1;
1179 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1180 || s->font_not_found_p
1181 || s->extends_to_end_of_line_p
1182 || force_p)
1184 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1185 s->background_width,
1186 s->height - 2 * box_line_width);
1187 s->background_filled_p = 1;
1193 /* Draw the foreground of glyph string S. */
1195 static void
1196 x_draw_glyph_string_foreground (struct glyph_string *s)
1198 int i, x;
1200 /* If first glyph of S has a left box line, start drawing the text
1201 of S to the right of that box line. */
1202 if (s->face->box != FACE_NO_BOX
1203 && s->first_glyph->left_box_line_p)
1204 x = s->x + eabs (s->face->box_line_width);
1205 else
1206 x = s->x;
1208 /* Draw characters of S as rectangles if S's font could not be
1209 loaded. */
1210 if (s->font_not_found_p)
1212 for (i = 0; i < s->nchars; ++i)
1214 struct glyph *g = s->first_glyph + i;
1215 XDrawRectangle (s->display, s->window,
1216 s->gc, x, s->y, g->pixel_width - 1,
1217 s->height - 1);
1218 x += g->pixel_width;
1221 else
1223 struct font *font = s->font;
1224 int boff = font->baseline_offset;
1225 int y;
1227 if (font->vertical_centering)
1228 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1230 y = s->ybase - boff;
1231 if (s->for_overlaps
1232 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1233 font->driver->draw (s, 0, s->nchars, x, y, 0);
1234 else
1235 font->driver->draw (s, 0, s->nchars, x, y, 1);
1236 if (s->face->overstrike)
1237 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1241 /* Draw the foreground of composite glyph string S. */
1243 static void
1244 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1246 int i, j, x;
1247 struct font *font = s->font;
1249 /* If first glyph of S has a left box line, start drawing the text
1250 of S to the right of that box line. */
1251 if (s->face && s->face->box != FACE_NO_BOX
1252 && s->first_glyph->left_box_line_p)
1253 x = s->x + eabs (s->face->box_line_width);
1254 else
1255 x = s->x;
1257 /* S is a glyph string for a composition. S->cmp_from is the index
1258 of the first character drawn for glyphs of this composition.
1259 S->cmp_from == 0 means we are drawing the very first character of
1260 this composition. */
1262 /* Draw a rectangle for the composition if the font for the very
1263 first character of the composition could not be loaded. */
1264 if (s->font_not_found_p)
1266 if (s->cmp_from == 0)
1267 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1268 s->width - 1, s->height - 1);
1270 else if (! s->first_glyph->u.cmp.automatic)
1272 int y = s->ybase;
1274 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1275 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1277 int xx = x + s->cmp->offsets[j * 2];
1278 int yy = y - s->cmp->offsets[j * 2 + 1];
1280 font->driver->draw (s, j, j + 1, xx, yy, 0);
1281 if (s->face->overstrike)
1282 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1285 else
1287 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1288 Lisp_Object glyph;
1289 int y = s->ybase;
1290 int width = 0;
1292 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1294 glyph = LGSTRING_GLYPH (gstring, i);
1295 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1296 width += LGLYPH_WIDTH (glyph);
1297 else
1299 int xoff, yoff, wadjust;
1301 if (j < i)
1303 font->driver->draw (s, j, i, x, y, 0);
1304 if (s->face->overstrike)
1305 font->driver->draw (s, j, i, x + 1, y, 0);
1306 x += width;
1308 xoff = LGLYPH_XOFF (glyph);
1309 yoff = LGLYPH_YOFF (glyph);
1310 wadjust = LGLYPH_WADJUST (glyph);
1311 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1312 if (s->face->overstrike)
1313 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1314 x += wadjust;
1315 j = i + 1;
1316 width = 0;
1319 if (j < i)
1321 font->driver->draw (s, j, i, x, y, 0);
1322 if (s->face->overstrike)
1323 font->driver->draw (s, j, i, x + 1, y, 0);
1329 /* Draw the foreground of glyph string S for glyphless characters. */
1331 static void
1332 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1334 struct glyph *glyph = s->first_glyph;
1335 XChar2b char2b[8];
1336 int x, i, j;
1338 /* If first glyph of S has a left box line, start drawing the text
1339 of S to the right of that box line. */
1340 if (s->face && s->face->box != FACE_NO_BOX
1341 && s->first_glyph->left_box_line_p)
1342 x = s->x + eabs (s->face->box_line_width);
1343 else
1344 x = s->x;
1346 s->char2b = char2b;
1348 for (i = 0; i < s->nchars; i++, glyph++)
1350 char buf[7], *str = NULL;
1351 int len = glyph->u.glyphless.len;
1353 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1355 if (len > 0
1356 && CHAR_TABLE_P (Vglyphless_char_display)
1357 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1358 >= 1))
1360 Lisp_Object acronym
1361 = (! glyph->u.glyphless.for_no_font
1362 ? CHAR_TABLE_REF (Vglyphless_char_display,
1363 glyph->u.glyphless.ch)
1364 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1365 if (STRINGP (acronym))
1366 str = SSDATA (acronym);
1369 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1371 sprintf ((char *) buf, "%0*X",
1372 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1373 glyph->u.glyphless.ch);
1374 str = buf;
1377 if (str)
1379 int upper_len = (len + 1) / 2;
1380 unsigned code;
1382 /* It is assured that all LEN characters in STR is ASCII. */
1383 for (j = 0; j < len; j++)
1385 code = s->font->driver->encode_char (s->font, str[j]);
1386 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1388 s->font->driver->draw (s, 0, upper_len,
1389 x + glyph->slice.glyphless.upper_xoff,
1390 s->ybase + glyph->slice.glyphless.upper_yoff,
1392 s->font->driver->draw (s, upper_len, len,
1393 x + glyph->slice.glyphless.lower_xoff,
1394 s->ybase + glyph->slice.glyphless.lower_yoff,
1397 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1398 XDrawRectangle (s->display, s->window, s->gc,
1399 x, s->ybase - glyph->ascent,
1400 glyph->pixel_width - 1,
1401 glyph->ascent + glyph->descent - 1);
1402 x += glyph->pixel_width;
1406 #ifdef USE_X_TOOLKIT
1408 static struct frame *x_frame_of_widget (Widget);
1409 static Boolean cvt_string_to_pixel (Display *, XrmValue *, Cardinal *,
1410 XrmValue *, XrmValue *, XtPointer *);
1411 static void cvt_pixel_dtor (XtAppContext, XrmValue *, XtPointer,
1412 XrmValue *, Cardinal *);
1415 /* Return the frame on which widget WIDGET is used.. Abort if frame
1416 cannot be determined. */
1418 static struct frame *
1419 x_frame_of_widget (Widget widget)
1421 struct x_display_info *dpyinfo;
1422 Lisp_Object tail;
1423 struct frame *f;
1425 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1427 /* Find the top-level shell of the widget. Note that this function
1428 can be called when the widget is not yet realized, so XtWindow
1429 (widget) == 0. That's the reason we can't simply use
1430 x_any_window_to_frame. */
1431 while (!XtIsTopLevelShell (widget))
1432 widget = XtParent (widget);
1434 /* Look for a frame with that top-level widget. Allocate the color
1435 on that frame to get the right gamma correction value. */
1436 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1437 if (FRAMEP (XCAR (tail))
1438 && (f = XFRAME (XCAR (tail)),
1439 (FRAME_X_P (f)
1440 && f->output_data.nothing != 1
1441 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1442 && f->output_data.x->widget == widget)
1443 return f;
1445 abort ();
1449 #ifdef USE_LUCID
1451 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1452 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1453 If this produces the same color as PIXEL, try a color where all RGB
1454 values have DELTA added. Return the allocated color in *PIXEL.
1455 DISPLAY is the X display, CMAP is the colormap to operate on.
1456 Value is non-zero if successful. */
1459 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1460 unsigned long *pixel, double factor, int delta)
1462 struct frame *f = x_frame_of_widget (widget);
1463 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1466 #endif
1469 /* Structure specifying which arguments should be passed by Xt to
1470 cvt_string_to_pixel. We want the widget's screen and colormap. */
1472 static XtConvertArgRec cvt_string_to_pixel_args[] =
1474 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1475 sizeof (Screen *)},
1476 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1477 sizeof (Colormap)}
1481 /* The address of this variable is returned by
1482 cvt_string_to_pixel. */
1484 static Pixel cvt_string_to_pixel_value;
1487 /* Convert a color name to a pixel color.
1489 DPY is the display we are working on.
1491 ARGS is an array of *NARGS XrmValue structures holding additional
1492 information about the widget for which the conversion takes place.
1493 The contents of this array are determined by the specification
1494 in cvt_string_to_pixel_args.
1496 FROM is a pointer to an XrmValue which points to the color name to
1497 convert. TO is an XrmValue in which to return the pixel color.
1499 CLOSURE_RET is a pointer to user-data, in which we record if
1500 we allocated the color or not.
1502 Value is True if successful, False otherwise. */
1504 static Boolean
1505 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1506 XrmValue *from, XrmValue *to,
1507 XtPointer *closure_ret)
1509 Screen *screen;
1510 Colormap cmap;
1511 Pixel pixel;
1512 String color_name;
1513 XColor color;
1515 if (*nargs != 2)
1517 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1518 "wrongParameters", "cvt_string_to_pixel",
1519 "XtToolkitError",
1520 "Screen and colormap args required", NULL, NULL);
1521 return False;
1524 screen = *(Screen **) args[0].addr;
1525 cmap = *(Colormap *) args[1].addr;
1526 color_name = (String) from->addr;
1528 if (strcmp (color_name, XtDefaultBackground) == 0)
1530 *closure_ret = (XtPointer) False;
1531 pixel = WhitePixelOfScreen (screen);
1533 else if (strcmp (color_name, XtDefaultForeground) == 0)
1535 *closure_ret = (XtPointer) False;
1536 pixel = BlackPixelOfScreen (screen);
1538 else if (XParseColor (dpy, cmap, color_name, &color)
1539 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1541 pixel = color.pixel;
1542 *closure_ret = (XtPointer) True;
1544 else
1546 String params[1];
1547 Cardinal nparams = 1;
1549 params[0] = color_name;
1550 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1551 "badValue", "cvt_string_to_pixel",
1552 "XtToolkitError", "Invalid color `%s'",
1553 params, &nparams);
1554 return False;
1557 if (to->addr != NULL)
1559 if (to->size < sizeof (Pixel))
1561 to->size = sizeof (Pixel);
1562 return False;
1565 *(Pixel *) to->addr = pixel;
1567 else
1569 cvt_string_to_pixel_value = pixel;
1570 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1573 to->size = sizeof (Pixel);
1574 return True;
1578 /* Free a pixel color which was previously allocated via
1579 cvt_string_to_pixel. This is registered as the destructor
1580 for this type of resource via XtSetTypeConverter.
1582 APP is the application context in which we work.
1584 TO is a pointer to an XrmValue holding the color to free.
1585 CLOSURE is the value we stored in CLOSURE_RET for this color
1586 in cvt_string_to_pixel.
1588 ARGS and NARGS are like for cvt_string_to_pixel. */
1590 static void
1591 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1592 Cardinal *nargs)
1594 if (*nargs != 2)
1596 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1597 "XtToolkitError",
1598 "Screen and colormap arguments required",
1599 NULL, NULL);
1601 else if (closure != NULL)
1603 /* We did allocate the pixel, so free it. */
1604 Screen *screen = *(Screen **) args[0].addr;
1605 Colormap cmap = *(Colormap *) args[1].addr;
1606 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1607 (Pixel *) to->addr, 1);
1612 #endif /* USE_X_TOOLKIT */
1615 /* Value is an array of XColor structures for the contents of the
1616 color map of display DPY. Set *NCELLS to the size of the array.
1617 Note that this probably shouldn't be called for large color maps,
1618 say a 24-bit TrueColor map. */
1620 static const XColor *
1621 x_color_cells (Display *dpy, int *ncells)
1623 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1625 if (dpyinfo->color_cells == NULL)
1627 Screen *screen = dpyinfo->screen;
1628 int i;
1630 dpyinfo->ncolor_cells
1631 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1632 dpyinfo->color_cells
1633 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1634 * sizeof *dpyinfo->color_cells);
1636 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1637 dpyinfo->color_cells[i].pixel = i;
1639 XQueryColors (dpy, dpyinfo->cmap,
1640 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1643 *ncells = dpyinfo->ncolor_cells;
1644 return dpyinfo->color_cells;
1648 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1649 colors in COLORS. Use cached information, if available. */
1651 void
1652 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1654 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1656 if (dpyinfo->color_cells)
1658 int i;
1659 for (i = 0; i < ncolors; ++i)
1661 unsigned long pixel = colors[i].pixel;
1662 xassert (pixel < dpyinfo->ncolor_cells);
1663 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1664 colors[i] = dpyinfo->color_cells[pixel];
1667 else
1668 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1672 /* On frame F, translate pixel color to RGB values for the color in
1673 COLOR. Use cached information, if available. */
1675 void
1676 x_query_color (struct frame *f, XColor *color)
1678 x_query_colors (f, color, 1);
1682 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1683 exact match can't be allocated, try the nearest color available.
1684 Value is non-zero if successful. Set *COLOR to the color
1685 allocated. */
1687 static int
1688 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1690 int rc;
1692 rc = XAllocColor (dpy, cmap, color);
1693 if (rc == 0)
1695 /* If we got to this point, the colormap is full, so we're going
1696 to try to get the next closest color. The algorithm used is
1697 a least-squares matching, which is what X uses for closest
1698 color matching with StaticColor visuals. */
1699 int nearest, i;
1700 int max_color_delta = 255;
1701 int max_delta = 3 * max_color_delta;
1702 int nearest_delta = max_delta + 1;
1703 int ncells;
1704 const XColor *cells = x_color_cells (dpy, &ncells);
1706 for (nearest = i = 0; i < ncells; ++i)
1708 int dred = (color->red >> 8) - (cells[i].red >> 8);
1709 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
1710 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1711 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
1713 if (delta < nearest_delta)
1715 nearest = i;
1716 nearest_delta = delta;
1720 color->red = cells[nearest].red;
1721 color->green = cells[nearest].green;
1722 color->blue = cells[nearest].blue;
1723 rc = XAllocColor (dpy, cmap, color);
1725 else
1727 /* If allocation succeeded, and the allocated pixel color is not
1728 equal to a cached pixel color recorded earlier, there was a
1729 change in the colormap, so clear the color cache. */
1730 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1731 XColor *cached_color;
1733 if (dpyinfo->color_cells
1734 && (cached_color = &dpyinfo->color_cells[color->pixel],
1735 (cached_color->red != color->red
1736 || cached_color->blue != color->blue
1737 || cached_color->green != color->green)))
1739 xfree (dpyinfo->color_cells);
1740 dpyinfo->color_cells = NULL;
1741 dpyinfo->ncolor_cells = 0;
1745 #ifdef DEBUG_X_COLORS
1746 if (rc)
1747 register_color (color->pixel);
1748 #endif /* DEBUG_X_COLORS */
1750 return rc;
1754 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1755 exact match can't be allocated, try the nearest color available.
1756 Value is non-zero if successful. Set *COLOR to the color
1757 allocated. */
1760 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1762 gamma_correct (f, color);
1763 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1767 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1768 It's necessary to do this instead of just using PIXEL directly to
1769 get color reference counts right. */
1771 unsigned long
1772 x_copy_color (struct frame *f, long unsigned int pixel)
1774 XColor color;
1776 color.pixel = pixel;
1777 BLOCK_INPUT;
1778 x_query_color (f, &color);
1779 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1780 UNBLOCK_INPUT;
1781 #ifdef DEBUG_X_COLORS
1782 register_color (pixel);
1783 #endif
1784 return color.pixel;
1788 /* Brightness beyond which a color won't have its highlight brightness
1789 boosted.
1791 Nominally, highlight colors for `3d' faces are calculated by
1792 brightening an object's color by a constant scale factor, but this
1793 doesn't yield good results for dark colors, so for colors who's
1794 brightness is less than this value (on a scale of 0-65535) have an
1795 use an additional additive factor.
1797 The value here is set so that the default menu-bar/mode-line color
1798 (grey75) will not have its highlights changed at all. */
1799 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1802 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1803 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1804 If this produces the same color as PIXEL, try a color where all RGB
1805 values have DELTA added. Return the allocated color in *PIXEL.
1806 DISPLAY is the X display, CMAP is the colormap to operate on.
1807 Value is non-zero if successful. */
1809 static int
1810 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1812 XColor color, new;
1813 long bright;
1814 int success_p;
1816 /* Get RGB color values. */
1817 color.pixel = *pixel;
1818 x_query_color (f, &color);
1820 /* Change RGB values by specified FACTOR. Avoid overflow! */
1821 xassert (factor >= 0);
1822 new.red = min (0xffff, factor * color.red);
1823 new.green = min (0xffff, factor * color.green);
1824 new.blue = min (0xffff, factor * color.blue);
1826 /* Calculate brightness of COLOR. */
1827 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1829 /* We only boost colors that are darker than
1830 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1831 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1832 /* Make an additive adjustment to NEW, because it's dark enough so
1833 that scaling by FACTOR alone isn't enough. */
1835 /* How far below the limit this color is (0 - 1, 1 being darker). */
1836 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1837 /* The additive adjustment. */
1838 int min_delta = delta * dimness * factor / 2;
1840 if (factor < 1)
1842 new.red = max (0, new.red - min_delta);
1843 new.green = max (0, new.green - min_delta);
1844 new.blue = max (0, new.blue - min_delta);
1846 else
1848 new.red = min (0xffff, min_delta + new.red);
1849 new.green = min (0xffff, min_delta + new.green);
1850 new.blue = min (0xffff, min_delta + new.blue);
1854 /* Try to allocate the color. */
1855 success_p = x_alloc_nearest_color (f, cmap, &new);
1856 if (success_p)
1858 if (new.pixel == *pixel)
1860 /* If we end up with the same color as before, try adding
1861 delta to the RGB values. */
1862 x_free_colors (f, &new.pixel, 1);
1864 new.red = min (0xffff, delta + color.red);
1865 new.green = min (0xffff, delta + color.green);
1866 new.blue = min (0xffff, delta + color.blue);
1867 success_p = x_alloc_nearest_color (f, cmap, &new);
1869 else
1870 success_p = 1;
1871 *pixel = new.pixel;
1874 return success_p;
1878 /* Set up the foreground color for drawing relief lines of glyph
1879 string S. RELIEF is a pointer to a struct relief containing the GC
1880 with which lines will be drawn. Use a color that is FACTOR or
1881 DELTA lighter or darker than the relief's background which is found
1882 in S->f->output_data.x->relief_background. If such a color cannot
1883 be allocated, use DEFAULT_PIXEL, instead. */
1885 static void
1886 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1888 XGCValues xgcv;
1889 struct x_output *di = f->output_data.x;
1890 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1891 unsigned long pixel;
1892 unsigned long background = di->relief_background;
1893 Colormap cmap = FRAME_X_COLORMAP (f);
1894 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1895 Display *dpy = FRAME_X_DISPLAY (f);
1897 xgcv.graphics_exposures = False;
1898 xgcv.line_width = 1;
1900 /* Free previously allocated color. The color cell will be reused
1901 when it has been freed as many times as it was allocated, so this
1902 doesn't affect faces using the same colors. */
1903 if (relief->gc
1904 && relief->allocated_p)
1906 x_free_colors (f, &relief->pixel, 1);
1907 relief->allocated_p = 0;
1910 /* Allocate new color. */
1911 xgcv.foreground = default_pixel;
1912 pixel = background;
1913 if (dpyinfo->n_planes != 1
1914 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1916 relief->allocated_p = 1;
1917 xgcv.foreground = relief->pixel = pixel;
1920 if (relief->gc == 0)
1922 xgcv.stipple = dpyinfo->gray;
1923 mask |= GCStipple;
1924 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1926 else
1927 XChangeGC (dpy, relief->gc, mask, &xgcv);
1931 /* Set up colors for the relief lines around glyph string S. */
1933 static void
1934 x_setup_relief_colors (struct glyph_string *s)
1936 struct x_output *di = s->f->output_data.x;
1937 unsigned long color;
1939 if (s->face->use_box_color_for_shadows_p)
1940 color = s->face->box_color;
1941 else if (s->first_glyph->type == IMAGE_GLYPH
1942 && s->img->pixmap
1943 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1944 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1945 else
1947 XGCValues xgcv;
1949 /* Get the background color of the face. */
1950 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1951 color = xgcv.background;
1954 if (di->white_relief.gc == 0
1955 || color != di->relief_background)
1957 di->relief_background = color;
1958 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1959 WHITE_PIX_DEFAULT (s->f));
1960 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1961 BLACK_PIX_DEFAULT (s->f));
1966 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
1967 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
1968 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
1969 relief. LEFT_P non-zero means draw a relief on the left side of
1970 the rectangle. RIGHT_P non-zero means draw a relief on the right
1971 side of the rectangle. CLIP_RECT is the clipping rectangle to use
1972 when drawing. */
1974 static void
1975 x_draw_relief_rect (struct frame *f,
1976 int left_x, int top_y, int right_x, int bottom_y, int width,
1977 int raised_p, int top_p, int bot_p, int left_p, int right_p,
1978 XRectangle *clip_rect)
1980 Display *dpy = FRAME_X_DISPLAY (f);
1981 Window window = FRAME_X_WINDOW (f);
1982 int i;
1983 GC gc;
1985 if (raised_p)
1986 gc = f->output_data.x->white_relief.gc;
1987 else
1988 gc = f->output_data.x->black_relief.gc;
1989 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
1991 /* This code is more complicated than it has to be, because of two
1992 minor hacks to make the boxes look nicer: (i) if width > 1, draw
1993 the outermost line using the black relief. (ii) Omit the four
1994 corner pixels. */
1996 /* Top. */
1997 if (top_p)
1999 if (width == 1)
2000 XDrawLine (dpy, window, gc,
2001 left_x + (left_p ? 1 : 0), top_y,
2002 right_x + (right_p ? 0 : 1), top_y);
2004 for (i = 1; i < width; ++i)
2005 XDrawLine (dpy, window, gc,
2006 left_x + i * left_p, top_y + i,
2007 right_x + 1 - i * right_p, top_y + i);
2010 /* Left. */
2011 if (left_p)
2013 if (width == 1)
2014 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2016 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2017 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2019 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2020 XDrawLine (dpy, window, gc,
2021 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2024 XSetClipMask (dpy, gc, None);
2025 if (raised_p)
2026 gc = f->output_data.x->black_relief.gc;
2027 else
2028 gc = f->output_data.x->white_relief.gc;
2029 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2031 if (width > 1)
2033 /* Outermost top line. */
2034 if (top_p)
2035 XDrawLine (dpy, window, gc,
2036 left_x + (left_p ? 1 : 0), top_y,
2037 right_x + (right_p ? 0 : 1), top_y);
2039 /* Outermost left line. */
2040 if (left_p)
2041 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2044 /* Bottom. */
2045 if (bot_p)
2047 XDrawLine (dpy, window, gc,
2048 left_x + (left_p ? 1 : 0), bottom_y,
2049 right_x + (right_p ? 0 : 1), bottom_y);
2050 for (i = 1; i < width; ++i)
2051 XDrawLine (dpy, window, gc,
2052 left_x + i * left_p, bottom_y - i,
2053 right_x + 1 - i * right_p, bottom_y - i);
2056 /* Right. */
2057 if (right_p)
2059 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2060 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2061 for (i = 0; i < width; ++i)
2062 XDrawLine (dpy, window, gc,
2063 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2066 XSetClipMask (dpy, gc, None);
2070 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2071 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2072 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2073 left side of the rectangle. RIGHT_P non-zero means draw a line
2074 on the right side of the rectangle. CLIP_RECT is the clipping
2075 rectangle to use when drawing. */
2077 static void
2078 x_draw_box_rect (struct glyph_string *s,
2079 int left_x, int top_y, int right_x, int bottom_y, int width,
2080 int left_p, int right_p, XRectangle *clip_rect)
2082 XGCValues xgcv;
2084 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2085 XSetForeground (s->display, s->gc, s->face->box_color);
2086 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2088 /* Top. */
2089 XFillRectangle (s->display, s->window, s->gc,
2090 left_x, top_y, right_x - left_x + 1, width);
2092 /* Left. */
2093 if (left_p)
2094 XFillRectangle (s->display, s->window, s->gc,
2095 left_x, top_y, width, bottom_y - top_y + 1);
2097 /* Bottom. */
2098 XFillRectangle (s->display, s->window, s->gc,
2099 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2101 /* Right. */
2102 if (right_p)
2103 XFillRectangle (s->display, s->window, s->gc,
2104 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2106 XSetForeground (s->display, s->gc, xgcv.foreground);
2107 XSetClipMask (s->display, s->gc, None);
2111 /* Draw a box around glyph string S. */
2113 static void
2114 x_draw_glyph_string_box (struct glyph_string *s)
2116 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2117 int left_p, right_p;
2118 struct glyph *last_glyph;
2119 XRectangle clip_rect;
2121 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2122 ? WINDOW_RIGHT_EDGE_X (s->w)
2123 : window_box_right (s->w, s->area));
2125 /* The glyph that may have a right box line. */
2126 last_glyph = (s->cmp || s->img
2127 ? s->first_glyph
2128 : s->first_glyph + s->nchars - 1);
2130 width = eabs (s->face->box_line_width);
2131 raised_p = s->face->box == FACE_RAISED_BOX;
2132 left_x = s->x;
2133 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2134 ? last_x - 1
2135 : min (last_x, s->x + s->background_width) - 1);
2136 top_y = s->y;
2137 bottom_y = top_y + s->height - 1;
2139 left_p = (s->first_glyph->left_box_line_p
2140 || (s->hl == DRAW_MOUSE_FACE
2141 && (s->prev == NULL
2142 || s->prev->hl != s->hl)));
2143 right_p = (last_glyph->right_box_line_p
2144 || (s->hl == DRAW_MOUSE_FACE
2145 && (s->next == NULL
2146 || s->next->hl != s->hl)));
2148 get_glyph_string_clip_rect (s, &clip_rect);
2150 if (s->face->box == FACE_SIMPLE_BOX)
2151 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2152 left_p, right_p, &clip_rect);
2153 else
2155 x_setup_relief_colors (s);
2156 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2157 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2162 /* Draw foreground of image glyph string S. */
2164 static void
2165 x_draw_image_foreground (struct glyph_string *s)
2167 int x = s->x;
2168 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2170 /* If first glyph of S has a left box line, start drawing it to the
2171 right of that line. */
2172 if (s->face->box != FACE_NO_BOX
2173 && s->first_glyph->left_box_line_p
2174 && s->slice.x == 0)
2175 x += eabs (s->face->box_line_width);
2177 /* If there is a margin around the image, adjust x- and y-position
2178 by that margin. */
2179 if (s->slice.x == 0)
2180 x += s->img->hmargin;
2181 if (s->slice.y == 0)
2182 y += s->img->vmargin;
2184 if (s->img->pixmap)
2186 if (s->img->mask)
2188 /* We can't set both a clip mask and use XSetClipRectangles
2189 because the latter also sets a clip mask. We also can't
2190 trust on the shape extension to be available
2191 (XShapeCombineRegion). So, compute the rectangle to draw
2192 manually. */
2193 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2194 | GCFunction);
2195 XGCValues xgcv;
2196 XRectangle clip_rect, image_rect, r;
2198 xgcv.clip_mask = s->img->mask;
2199 xgcv.clip_x_origin = x;
2200 xgcv.clip_y_origin = y;
2201 xgcv.function = GXcopy;
2202 XChangeGC (s->display, s->gc, mask, &xgcv);
2204 get_glyph_string_clip_rect (s, &clip_rect);
2205 image_rect.x = x;
2206 image_rect.y = y;
2207 image_rect.width = s->slice.width;
2208 image_rect.height = s->slice.height;
2209 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2210 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2211 s->slice.x + r.x - x, s->slice.y + r.y - y,
2212 r.width, r.height, r.x, r.y);
2214 else
2216 XRectangle clip_rect, image_rect, r;
2218 get_glyph_string_clip_rect (s, &clip_rect);
2219 image_rect.x = x;
2220 image_rect.y = y;
2221 image_rect.width = s->slice.width;
2222 image_rect.height = s->slice.height;
2223 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2224 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2225 s->slice.x + r.x - x, s->slice.y + r.y - y,
2226 r.width, r.height, r.x, r.y);
2228 /* When the image has a mask, we can expect that at
2229 least part of a mouse highlight or a block cursor will
2230 be visible. If the image doesn't have a mask, make
2231 a block cursor visible by drawing a rectangle around
2232 the image. I believe it's looking better if we do
2233 nothing here for mouse-face. */
2234 if (s->hl == DRAW_CURSOR)
2236 int relief = s->img->relief;
2237 if (relief < 0) relief = -relief;
2238 XDrawRectangle (s->display, s->window, s->gc,
2239 x - relief, y - relief,
2240 s->slice.width + relief*2 - 1,
2241 s->slice.height + relief*2 - 1);
2245 else
2246 /* Draw a rectangle if image could not be loaded. */
2247 XDrawRectangle (s->display, s->window, s->gc, x, y,
2248 s->slice.width - 1, s->slice.height - 1);
2252 /* Draw a relief around the image glyph string S. */
2254 static void
2255 x_draw_image_relief (struct glyph_string *s)
2257 int x0, y0, x1, y1, thick, raised_p, extra;
2258 XRectangle r;
2259 int x = s->x;
2260 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2262 /* If first glyph of S has a left box line, start drawing it to the
2263 right of that line. */
2264 if (s->face->box != FACE_NO_BOX
2265 && s->first_glyph->left_box_line_p
2266 && s->slice.x == 0)
2267 x += eabs (s->face->box_line_width);
2269 /* If there is a margin around the image, adjust x- and y-position
2270 by that margin. */
2271 if (s->slice.x == 0)
2272 x += s->img->hmargin;
2273 if (s->slice.y == 0)
2274 y += s->img->vmargin;
2276 if (s->hl == DRAW_IMAGE_SUNKEN
2277 || s->hl == DRAW_IMAGE_RAISED)
2279 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2280 raised_p = s->hl == DRAW_IMAGE_RAISED;
2282 else
2284 thick = eabs (s->img->relief);
2285 raised_p = s->img->relief > 0;
2288 extra = s->face->id == TOOL_BAR_FACE_ID
2289 ? XINT (Vtool_bar_button_margin) : 0;
2291 x0 = x - thick - extra;
2292 y0 = y - thick - extra;
2293 x1 = x + s->slice.width + thick - 1 + extra;
2294 y1 = y + s->slice.height + thick - 1 + extra;
2296 x_setup_relief_colors (s);
2297 get_glyph_string_clip_rect (s, &r);
2298 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2299 s->slice.y == 0,
2300 s->slice.y + s->slice.height == s->img->height,
2301 s->slice.x == 0,
2302 s->slice.x + s->slice.width == s->img->width,
2303 &r);
2307 /* Draw the foreground of image glyph string S to PIXMAP. */
2309 static void
2310 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2312 int x = 0;
2313 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2315 /* If first glyph of S has a left box line, start drawing it to the
2316 right of that line. */
2317 if (s->face->box != FACE_NO_BOX
2318 && s->first_glyph->left_box_line_p
2319 && s->slice.x == 0)
2320 x += eabs (s->face->box_line_width);
2322 /* If there is a margin around the image, adjust x- and y-position
2323 by that margin. */
2324 if (s->slice.x == 0)
2325 x += s->img->hmargin;
2326 if (s->slice.y == 0)
2327 y += s->img->vmargin;
2329 if (s->img->pixmap)
2331 if (s->img->mask)
2333 /* We can't set both a clip mask and use XSetClipRectangles
2334 because the latter also sets a clip mask. We also can't
2335 trust on the shape extension to be available
2336 (XShapeCombineRegion). So, compute the rectangle to draw
2337 manually. */
2338 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2339 | GCFunction);
2340 XGCValues xgcv;
2342 xgcv.clip_mask = s->img->mask;
2343 xgcv.clip_x_origin = x - s->slice.x;
2344 xgcv.clip_y_origin = y - s->slice.y;
2345 xgcv.function = GXcopy;
2346 XChangeGC (s->display, s->gc, mask, &xgcv);
2348 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2349 s->slice.x, s->slice.y,
2350 s->slice.width, s->slice.height, x, y);
2351 XSetClipMask (s->display, s->gc, None);
2353 else
2355 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2356 s->slice.x, s->slice.y,
2357 s->slice.width, s->slice.height, x, y);
2359 /* When the image has a mask, we can expect that at
2360 least part of a mouse highlight or a block cursor will
2361 be visible. If the image doesn't have a mask, make
2362 a block cursor visible by drawing a rectangle around
2363 the image. I believe it's looking better if we do
2364 nothing here for mouse-face. */
2365 if (s->hl == DRAW_CURSOR)
2367 int r = s->img->relief;
2368 if (r < 0) r = -r;
2369 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2370 s->slice.width + r*2 - 1,
2371 s->slice.height + r*2 - 1);
2375 else
2376 /* Draw a rectangle if image could not be loaded. */
2377 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2378 s->slice.width - 1, s->slice.height - 1);
2382 /* Draw part of the background of glyph string S. X, Y, W, and H
2383 give the rectangle to draw. */
2385 static void
2386 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2388 if (s->stippled_p)
2390 /* Fill background with a stipple pattern. */
2391 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2392 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2393 XSetFillStyle (s->display, s->gc, FillSolid);
2395 else
2396 x_clear_glyph_string_rect (s, x, y, w, h);
2400 /* Draw image glyph string S.
2402 s->y
2403 s->x +-------------------------
2404 | s->face->box
2406 | +-------------------------
2407 | | s->img->margin
2409 | | +-------------------
2410 | | | the image
2414 static void
2415 x_draw_image_glyph_string (struct glyph_string *s)
2417 int box_line_hwidth = eabs (s->face->box_line_width);
2418 int box_line_vwidth = max (s->face->box_line_width, 0);
2419 int height;
2420 Pixmap pixmap = None;
2422 height = s->height;
2423 if (s->slice.y == 0)
2424 height -= box_line_vwidth;
2425 if (s->slice.y + s->slice.height >= s->img->height)
2426 height -= box_line_vwidth;
2428 /* Fill background with face under the image. Do it only if row is
2429 taller than image or if image has a clip mask to reduce
2430 flickering. */
2431 s->stippled_p = s->face->stipple != 0;
2432 if (height > s->slice.height
2433 || s->img->hmargin
2434 || s->img->vmargin
2435 || s->img->mask
2436 || s->img->pixmap == 0
2437 || s->width != s->background_width)
2439 if (s->img->mask)
2441 /* Create a pixmap as large as the glyph string. Fill it
2442 with the background color. Copy the image to it, using
2443 its mask. Copy the temporary pixmap to the display. */
2444 Screen *screen = FRAME_X_SCREEN (s->f);
2445 int depth = DefaultDepthOfScreen (screen);
2447 /* Create a pixmap as large as the glyph string. */
2448 pixmap = XCreatePixmap (s->display, s->window,
2449 s->background_width,
2450 s->height, depth);
2452 /* Don't clip in the following because we're working on the
2453 pixmap. */
2454 XSetClipMask (s->display, s->gc, None);
2456 /* Fill the pixmap with the background color/stipple. */
2457 if (s->stippled_p)
2459 /* Fill background with a stipple pattern. */
2460 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2461 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2462 XFillRectangle (s->display, pixmap, s->gc,
2463 0, 0, s->background_width, s->height);
2464 XSetFillStyle (s->display, s->gc, FillSolid);
2465 XSetTSOrigin (s->display, s->gc, 0, 0);
2467 else
2469 XGCValues xgcv;
2470 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2471 &xgcv);
2472 XSetForeground (s->display, s->gc, xgcv.background);
2473 XFillRectangle (s->display, pixmap, s->gc,
2474 0, 0, s->background_width, s->height);
2475 XSetForeground (s->display, s->gc, xgcv.foreground);
2478 else
2480 int x = s->x;
2481 int y = s->y;
2483 if (s->first_glyph->left_box_line_p
2484 && s->slice.x == 0)
2485 x += box_line_hwidth;
2487 if (s->slice.y == 0)
2488 y += box_line_vwidth;
2490 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2493 s->background_filled_p = 1;
2496 /* Draw the foreground. */
2497 if (pixmap != None)
2499 x_draw_image_foreground_1 (s, pixmap);
2500 x_set_glyph_string_clipping (s);
2501 XCopyArea (s->display, pixmap, s->window, s->gc,
2502 0, 0, s->background_width, s->height, s->x, s->y);
2503 XFreePixmap (s->display, pixmap);
2505 else
2506 x_draw_image_foreground (s);
2508 /* If we must draw a relief around the image, do it. */
2509 if (s->img->relief
2510 || s->hl == DRAW_IMAGE_RAISED
2511 || s->hl == DRAW_IMAGE_SUNKEN)
2512 x_draw_image_relief (s);
2516 /* Draw stretch glyph string S. */
2518 static void
2519 x_draw_stretch_glyph_string (struct glyph_string *s)
2521 xassert (s->first_glyph->type == STRETCH_GLYPH);
2523 if (s->hl == DRAW_CURSOR
2524 && !x_stretch_cursor_p)
2526 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2527 wide as the stretch glyph. */
2528 int width, background_width = s->background_width;
2529 int x = s->x;
2531 if (!s->row->reversed_p)
2533 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2535 if (x < left_x)
2537 background_width -= left_x - x;
2538 x = left_x;
2541 else
2543 /* In R2L rows, draw the cursor on the right edge of the
2544 stretch glyph. */
2545 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2547 if (x + background_width > right_x)
2548 background_width -= x - right_x;
2549 x += background_width;
2551 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2552 if (s->row->reversed_p)
2553 x -= width;
2555 /* Draw cursor. */
2556 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2558 /* Clear rest using the GC of the original non-cursor face. */
2559 if (width < background_width)
2561 int y = s->y;
2562 int w = background_width - width, h = s->height;
2563 XRectangle r;
2564 GC gc;
2566 if (!s->row->reversed_p)
2567 x += width;
2568 else
2569 x = s->x;
2570 if (s->row->mouse_face_p
2571 && cursor_in_mouse_face_p (s->w))
2573 x_set_mouse_face_gc (s);
2574 gc = s->gc;
2576 else
2577 gc = s->face->gc;
2579 get_glyph_string_clip_rect (s, &r);
2580 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2582 if (s->face->stipple)
2584 /* Fill background with a stipple pattern. */
2585 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2586 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2587 XSetFillStyle (s->display, gc, FillSolid);
2589 else
2591 XGCValues xgcv;
2592 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2593 XSetForeground (s->display, gc, xgcv.background);
2594 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2595 XSetForeground (s->display, gc, xgcv.foreground);
2599 else if (!s->background_filled_p)
2601 int background_width = s->background_width;
2602 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2604 /* Don't draw into left margin, fringe or scrollbar area
2605 except for header line and mode line. */
2606 if (x < left_x && !s->row->mode_line_p)
2608 background_width -= left_x - x;
2609 x = left_x;
2611 if (background_width > 0)
2612 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2615 s->background_filled_p = 1;
2619 /* Draw glyph string S. */
2621 static void
2622 x_draw_glyph_string (struct glyph_string *s)
2624 int relief_drawn_p = 0;
2626 /* If S draws into the background of its successors, draw the
2627 background of the successors first so that S can draw into it.
2628 This makes S->next use XDrawString instead of XDrawImageString. */
2629 if (s->next && s->right_overhang && !s->for_overlaps)
2631 int width;
2632 struct glyph_string *next;
2634 for (width = 0, next = s->next;
2635 next && width < s->right_overhang;
2636 width += next->width, next = next->next)
2637 if (next->first_glyph->type != IMAGE_GLYPH)
2639 x_set_glyph_string_gc (next);
2640 x_set_glyph_string_clipping (next);
2641 if (next->first_glyph->type == STRETCH_GLYPH)
2642 x_draw_stretch_glyph_string (next);
2643 else
2644 x_draw_glyph_string_background (next, 1);
2645 next->num_clips = 0;
2649 /* Set up S->gc, set clipping and draw S. */
2650 x_set_glyph_string_gc (s);
2652 /* Draw relief (if any) in advance for char/composition so that the
2653 glyph string can be drawn over it. */
2654 if (!s->for_overlaps
2655 && s->face->box != FACE_NO_BOX
2656 && (s->first_glyph->type == CHAR_GLYPH
2657 || s->first_glyph->type == COMPOSITE_GLYPH))
2660 x_set_glyph_string_clipping (s);
2661 x_draw_glyph_string_background (s, 1);
2662 x_draw_glyph_string_box (s);
2663 x_set_glyph_string_clipping (s);
2664 relief_drawn_p = 1;
2666 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2667 && !s->clip_tail
2668 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2669 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2670 /* We must clip just this glyph. left_overhang part has already
2671 drawn when s->prev was drawn, and right_overhang part will be
2672 drawn later when s->next is drawn. */
2673 x_set_glyph_string_clipping_exactly (s, s);
2674 else
2675 x_set_glyph_string_clipping (s);
2677 switch (s->first_glyph->type)
2679 case IMAGE_GLYPH:
2680 x_draw_image_glyph_string (s);
2681 break;
2683 case STRETCH_GLYPH:
2684 x_draw_stretch_glyph_string (s);
2685 break;
2687 case CHAR_GLYPH:
2688 if (s->for_overlaps)
2689 s->background_filled_p = 1;
2690 else
2691 x_draw_glyph_string_background (s, 0);
2692 x_draw_glyph_string_foreground (s);
2693 break;
2695 case COMPOSITE_GLYPH:
2696 if (s->for_overlaps || (s->cmp_from > 0
2697 && ! s->first_glyph->u.cmp.automatic))
2698 s->background_filled_p = 1;
2699 else
2700 x_draw_glyph_string_background (s, 1);
2701 x_draw_composite_glyph_string_foreground (s);
2702 break;
2704 case GLYPHLESS_GLYPH:
2705 if (s->for_overlaps)
2706 s->background_filled_p = 1;
2707 else
2708 x_draw_glyph_string_background (s, 1);
2709 x_draw_glyphless_glyph_string_foreground (s);
2710 break;
2712 default:
2713 abort ();
2716 if (!s->for_overlaps)
2718 /* Draw underline. */
2719 if (s->face->underline_p)
2721 unsigned long thickness, position;
2722 int y;
2724 if (s->prev && s->prev->face->underline_p)
2726 /* We use the same underline style as the previous one. */
2727 thickness = s->prev->underline_thickness;
2728 position = s->prev->underline_position;
2730 else
2732 /* Get the underline thickness. Default is 1 pixel. */
2733 if (s->font && s->font->underline_thickness > 0)
2734 thickness = s->font->underline_thickness;
2735 else
2736 thickness = 1;
2737 if (x_underline_at_descent_line)
2738 position = (s->height - thickness) - (s->ybase - s->y);
2739 else
2741 /* Get the underline position. This is the recommended
2742 vertical offset in pixels from the baseline to the top of
2743 the underline. This is a signed value according to the
2744 specs, and its default is
2746 ROUND ((maximum descent) / 2), with
2747 ROUND(x) = floor (x + 0.5) */
2749 if (x_use_underline_position_properties
2750 && s->font && s->font->underline_position >= 0)
2751 position = s->font->underline_position;
2752 else if (s->font)
2753 position = (s->font->descent + 1) / 2;
2754 else
2755 position = underline_minimum_offset;
2757 position = max (position, underline_minimum_offset);
2759 /* Check the sanity of thickness and position. We should
2760 avoid drawing underline out of the current line area. */
2761 if (s->y + s->height <= s->ybase + position)
2762 position = (s->height - 1) - (s->ybase - s->y);
2763 if (s->y + s->height < s->ybase + position + thickness)
2764 thickness = (s->y + s->height) - (s->ybase + position);
2765 s->underline_thickness = thickness;
2766 s->underline_position = position;
2767 y = s->ybase + position;
2768 if (s->face->underline_defaulted_p)
2769 XFillRectangle (s->display, s->window, s->gc,
2770 s->x, y, s->width, thickness);
2771 else
2773 XGCValues xgcv;
2774 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2775 XSetForeground (s->display, s->gc, s->face->underline_color);
2776 XFillRectangle (s->display, s->window, s->gc,
2777 s->x, y, s->width, thickness);
2778 XSetForeground (s->display, s->gc, xgcv.foreground);
2782 /* Draw overline. */
2783 if (s->face->overline_p)
2785 unsigned long dy = 0, h = 1;
2787 if (s->face->overline_color_defaulted_p)
2788 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2789 s->width, h);
2790 else
2792 XGCValues xgcv;
2793 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2794 XSetForeground (s->display, s->gc, s->face->overline_color);
2795 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2796 s->width, h);
2797 XSetForeground (s->display, s->gc, xgcv.foreground);
2801 /* Draw strike-through. */
2802 if (s->face->strike_through_p)
2804 unsigned long h = 1;
2805 unsigned long dy = (s->height - h) / 2;
2807 if (s->face->strike_through_color_defaulted_p)
2808 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2809 s->width, h);
2810 else
2812 XGCValues xgcv;
2813 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2814 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2815 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2816 s->width, h);
2817 XSetForeground (s->display, s->gc, xgcv.foreground);
2821 /* Draw relief if not yet drawn. */
2822 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2823 x_draw_glyph_string_box (s);
2825 if (s->prev)
2827 struct glyph_string *prev;
2829 for (prev = s->prev; prev; prev = prev->prev)
2830 if (prev->hl != s->hl
2831 && prev->x + prev->width + prev->right_overhang > s->x)
2833 /* As prev was drawn while clipped to its own area, we
2834 must draw the right_overhang part using s->hl now. */
2835 enum draw_glyphs_face save = prev->hl;
2837 prev->hl = s->hl;
2838 x_set_glyph_string_gc (prev);
2839 x_set_glyph_string_clipping_exactly (s, prev);
2840 if (prev->first_glyph->type == CHAR_GLYPH)
2841 x_draw_glyph_string_foreground (prev);
2842 else
2843 x_draw_composite_glyph_string_foreground (prev);
2844 XSetClipMask (prev->display, prev->gc, None);
2845 prev->hl = save;
2846 prev->num_clips = 0;
2850 if (s->next)
2852 struct glyph_string *next;
2854 for (next = s->next; next; next = next->next)
2855 if (next->hl != s->hl
2856 && next->x - next->left_overhang < s->x + s->width)
2858 /* As next will be drawn while clipped to its own area,
2859 we must draw the left_overhang part using s->hl now. */
2860 enum draw_glyphs_face save = next->hl;
2862 next->hl = s->hl;
2863 x_set_glyph_string_gc (next);
2864 x_set_glyph_string_clipping_exactly (s, next);
2865 if (next->first_glyph->type == CHAR_GLYPH)
2866 x_draw_glyph_string_foreground (next);
2867 else
2868 x_draw_composite_glyph_string_foreground (next);
2869 XSetClipMask (next->display, next->gc, None);
2870 next->hl = save;
2871 next->num_clips = 0;
2876 /* Reset clipping. */
2877 XSetClipMask (s->display, s->gc, None);
2878 s->num_clips = 0;
2881 /* Shift display to make room for inserted glyphs. */
2883 static void
2884 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2886 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2887 f->output_data.x->normal_gc,
2888 x, y, width, height,
2889 x + shift_by, y);
2892 /* Delete N glyphs at the nominal cursor position. Not implemented
2893 for X frames. */
2895 static void
2896 x_delete_glyphs (struct frame *f, register int n)
2898 abort ();
2902 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2903 If they are <= 0, this is probably an error. */
2905 void
2906 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
2908 xassert (width > 0 && height > 0);
2909 XClearArea (dpy, window, x, y, width, height, exposures);
2913 /* Clear an entire frame. */
2915 static void
2916 x_clear_frame (struct frame *f)
2918 /* Clearing the frame will erase any cursor, so mark them all as no
2919 longer visible. */
2920 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2921 output_cursor.hpos = output_cursor.vpos = 0;
2922 output_cursor.x = -1;
2924 /* We don't set the output cursor here because there will always
2925 follow an explicit cursor_to. */
2926 BLOCK_INPUT;
2928 /* The following call is commented out because it does not seem to accomplish
2929 anything, apart from causing flickering during window resize. */
2930 /* XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f)); */
2932 /* We have to clear the scroll bars. If we have changed colors or
2933 something like that, then they should be notified. */
2934 x_scroll_bar_clear (f);
2936 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
2937 /* Make sure scroll bars are redrawn. As they aren't redrawn by
2938 redisplay, do it here. */
2939 if (FRAME_GTK_WIDGET (f))
2940 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
2941 #endif
2943 XFlush (FRAME_X_DISPLAY (f));
2945 UNBLOCK_INPUT;
2950 /* Invert the middle quarter of the frame for .15 sec. */
2952 /* We use the select system call to do the waiting, so we have to make
2953 sure it's available. If it isn't, we just won't do visual bells. */
2955 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2958 /* Subtract the `struct timeval' values X and Y, storing the result in
2959 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2961 static int
2962 timeval_subtract (struct timeval *result, struct timeval x, struct timeval y)
2964 /* Perform the carry for the later subtraction by updating y. This
2965 is safer because on some systems the tv_sec member is unsigned. */
2966 if (x.tv_usec < y.tv_usec)
2968 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2969 y.tv_usec -= 1000000 * nsec;
2970 y.tv_sec += nsec;
2973 if (x.tv_usec - y.tv_usec > 1000000)
2975 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2976 y.tv_usec += 1000000 * nsec;
2977 y.tv_sec -= nsec;
2980 /* Compute the time remaining to wait. tv_usec is certainly
2981 positive. */
2982 result->tv_sec = x.tv_sec - y.tv_sec;
2983 result->tv_usec = x.tv_usec - y.tv_usec;
2985 /* Return indication of whether the result should be considered
2986 negative. */
2987 return x.tv_sec < y.tv_sec;
2990 static void
2991 XTflash (struct frame *f)
2993 BLOCK_INPUT;
2996 #ifdef USE_GTK
2997 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
2998 when the scroll bars and the edit widget share the same X window. */
2999 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3000 #ifdef HAVE_GTK3
3001 cairo_t *cr = gdk_cairo_create (window);
3002 cairo_set_source_rgb (cr, 1, 1, 1);
3003 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
3004 #define XFillRectangle(d, win, gc, x, y, w, h) \
3005 do { \
3006 cairo_rectangle (cr, x, y, w, h); \
3007 cairo_fill (cr); \
3009 while (0)
3010 #else /* ! HAVE_GTK3 */
3011 GdkGCValues vals;
3012 GdkGC *gc;
3013 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3014 ^ FRAME_BACKGROUND_PIXEL (f));
3015 vals.function = GDK_XOR;
3016 gc = gdk_gc_new_with_values (window,
3017 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3018 #define XFillRectangle(d, win, gc, x, y, w, h) \
3019 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
3020 #endif /* ! HAVE_GTK3 */
3021 #else /* ! USE_GTK */
3022 GC gc;
3024 /* Create a GC that will use the GXxor function to flip foreground
3025 pixels into background pixels. */
3027 XGCValues values;
3029 values.function = GXxor;
3030 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3031 ^ FRAME_BACKGROUND_PIXEL (f));
3033 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3034 GCFunction | GCForeground, &values);
3036 #endif
3038 /* Get the height not including a menu bar widget. */
3039 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3040 /* Height of each line to flash. */
3041 int flash_height = FRAME_LINE_HEIGHT (f);
3042 /* These will be the left and right margins of the rectangles. */
3043 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3044 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3046 int width;
3048 /* Don't flash the area between a scroll bar and the frame
3049 edge it is next to. */
3050 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3052 case vertical_scroll_bar_left:
3053 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3054 break;
3056 case vertical_scroll_bar_right:
3057 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3058 break;
3060 default:
3061 break;
3064 width = flash_right - flash_left;
3066 /* If window is tall, flash top and bottom line. */
3067 if (height > 3 * FRAME_LINE_HEIGHT (f))
3069 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3070 flash_left,
3071 (FRAME_INTERNAL_BORDER_WIDTH (f)
3072 + FRAME_TOP_MARGIN_HEIGHT (f)),
3073 width, flash_height);
3074 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3075 flash_left,
3076 (height - flash_height
3077 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3078 width, flash_height);
3081 else
3082 /* If it is short, flash it all. */
3083 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3084 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3085 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3087 x_flush (f);
3090 struct timeval wakeup;
3092 EMACS_GET_TIME (wakeup);
3094 /* Compute time to wait until, propagating carry from usecs. */
3095 wakeup.tv_usec += 150000;
3096 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3097 wakeup.tv_usec %= 1000000;
3099 /* Keep waiting until past the time wakeup or any input gets
3100 available. */
3101 while (! detect_input_pending ())
3103 struct timeval current;
3104 struct timeval timeout;
3106 EMACS_GET_TIME (current);
3108 /* Break if result would be negative. */
3109 if (timeval_subtract (&current, wakeup, current))
3110 break;
3112 /* How long `select' should wait. */
3113 timeout.tv_sec = 0;
3114 timeout.tv_usec = 10000;
3116 /* Try to wait that long--but we might wake up sooner. */
3117 select (0, NULL, NULL, NULL, &timeout);
3121 /* If window is tall, flash top and bottom line. */
3122 if (height > 3 * FRAME_LINE_HEIGHT (f))
3124 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3125 flash_left,
3126 (FRAME_INTERNAL_BORDER_WIDTH (f)
3127 + FRAME_TOP_MARGIN_HEIGHT (f)),
3128 width, flash_height);
3129 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3130 flash_left,
3131 (height - flash_height
3132 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3133 width, flash_height);
3135 else
3136 /* If it is short, flash it all. */
3137 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3138 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3139 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3141 #ifdef USE_GTK
3142 #ifdef HAVE_GTK3
3143 cairo_destroy (cr);
3144 #else
3145 g_object_unref (G_OBJECT (gc));
3146 #endif
3147 #undef XFillRectangle
3148 #else
3149 XFreeGC (FRAME_X_DISPLAY (f), gc);
3150 #endif
3151 x_flush (f);
3155 UNBLOCK_INPUT;
3158 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3161 static void
3162 XTtoggle_invisible_pointer (FRAME_PTR f, int invisible)
3164 BLOCK_INPUT;
3165 if (invisible)
3167 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3168 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3169 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3171 else
3172 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3173 f->output_data.x->current_cursor);
3174 f->pointer_invisible = invisible;
3175 UNBLOCK_INPUT;
3179 /* Make audible bell. */
3181 static void
3182 XTring_bell (struct frame *f)
3184 if (FRAME_X_DISPLAY (f))
3186 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3187 if (visible_bell)
3188 XTflash (f);
3189 else
3190 #endif
3192 BLOCK_INPUT;
3193 XBell (FRAME_X_DISPLAY (f), 0);
3194 XFlush (FRAME_X_DISPLAY (f));
3195 UNBLOCK_INPUT;
3201 /* Specify how many text lines, from the top of the window,
3202 should be affected by insert-lines and delete-lines operations.
3203 This, and those operations, are used only within an update
3204 that is bounded by calls to x_update_begin and x_update_end. */
3206 static void
3207 XTset_terminal_window (struct frame *f, int n)
3209 /* This function intentionally left blank. */
3214 /***********************************************************************
3215 Line Dance
3216 ***********************************************************************/
3218 /* Perform an insert-lines or delete-lines operation, inserting N
3219 lines or deleting -N lines at vertical position VPOS. */
3221 static void
3222 x_ins_del_lines (struct frame *f, int vpos, int n)
3224 abort ();
3228 /* Scroll part of the display as described by RUN. */
3230 static void
3231 x_scroll_run (struct window *w, struct run *run)
3233 struct frame *f = XFRAME (w->frame);
3234 int x, y, width, height, from_y, to_y, bottom_y;
3236 /* Get frame-relative bounding box of the text display area of W,
3237 without mode lines. Include in this box the left and right
3238 fringe of W. */
3239 window_box (w, -1, &x, &y, &width, &height);
3241 #ifdef USE_TOOLKIT_SCROLL_BARS
3242 /* If the fringe is adjacent to the left (right) scroll bar of a
3243 leftmost (rightmost, respectively) window, then extend its
3244 background to the gap between the fringe and the bar. */
3245 if ((WINDOW_LEFTMOST_P (w)
3246 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
3247 || (WINDOW_RIGHTMOST_P (w)
3248 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
3250 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
3252 if (sb_width > 0)
3254 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
3255 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
3256 * FRAME_COLUMN_WIDTH (f));
3258 if (bar_area_x + bar_area_width == x)
3260 x = bar_area_x + sb_width;
3261 width += bar_area_width - sb_width;
3263 else if (x + width == bar_area_x)
3264 width += bar_area_width - sb_width;
3267 #endif
3269 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3270 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3271 bottom_y = y + height;
3273 if (to_y < from_y)
3275 /* Scrolling up. Make sure we don't copy part of the mode
3276 line at the bottom. */
3277 if (from_y + run->height > bottom_y)
3278 height = bottom_y - from_y;
3279 else
3280 height = run->height;
3282 else
3284 /* Scolling down. Make sure we don't copy over the mode line.
3285 at the bottom. */
3286 if (to_y + run->height > bottom_y)
3287 height = bottom_y - to_y;
3288 else
3289 height = run->height;
3292 BLOCK_INPUT;
3294 /* Cursor off. Will be switched on again in x_update_window_end. */
3295 updated_window = w;
3296 x_clear_cursor (w);
3298 XCopyArea (FRAME_X_DISPLAY (f),
3299 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3300 f->output_data.x->normal_gc,
3301 x, from_y,
3302 width, height,
3303 x, to_y);
3305 UNBLOCK_INPUT;
3310 /***********************************************************************
3311 Exposure Events
3312 ***********************************************************************/
3315 static void
3316 frame_highlight (struct frame *f)
3318 /* We used to only do this if Vx_no_window_manager was non-nil, but
3319 the ICCCM (section 4.1.6) says that the window's border pixmap
3320 and border pixel are window attributes which are "private to the
3321 client", so we can always change it to whatever we want. */
3322 BLOCK_INPUT;
3323 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3324 f->output_data.x->border_pixel);
3325 UNBLOCK_INPUT;
3326 x_update_cursor (f, 1);
3327 x_set_frame_alpha (f);
3330 static void
3331 frame_unhighlight (struct frame *f)
3333 /* We used to only do this if Vx_no_window_manager was non-nil, but
3334 the ICCCM (section 4.1.6) says that the window's border pixmap
3335 and border pixel are window attributes which are "private to the
3336 client", so we can always change it to whatever we want. */
3337 BLOCK_INPUT;
3338 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3339 f->output_data.x->border_tile);
3340 UNBLOCK_INPUT;
3341 x_update_cursor (f, 1);
3342 x_set_frame_alpha (f);
3345 /* The focus has changed. Update the frames as necessary to reflect
3346 the new situation. Note that we can't change the selected frame
3347 here, because the Lisp code we are interrupting might become confused.
3348 Each event gets marked with the frame in which it occurred, so the
3349 Lisp code can tell when the switch took place by examining the events. */
3351 static void
3352 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3354 struct frame *old_focus = dpyinfo->x_focus_frame;
3356 if (frame != dpyinfo->x_focus_frame)
3358 /* Set this before calling other routines, so that they see
3359 the correct value of x_focus_frame. */
3360 dpyinfo->x_focus_frame = frame;
3362 if (old_focus && old_focus->auto_lower)
3363 x_lower_frame (old_focus);
3365 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3366 pending_autoraise_frame = dpyinfo->x_focus_frame;
3367 else
3368 pending_autoraise_frame = 0;
3371 x_frame_rehighlight (dpyinfo);
3374 /* Handle FocusIn and FocusOut state changes for FRAME.
3375 If FRAME has focus and there exists more than one frame, puts
3376 a FOCUS_IN_EVENT into *BUFP. */
3378 static void
3379 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3381 if (type == FocusIn)
3383 if (dpyinfo->x_focus_event_frame != frame)
3385 x_new_focus_frame (dpyinfo, frame);
3386 dpyinfo->x_focus_event_frame = frame;
3388 /* Don't stop displaying the initial startup message
3389 for a switch-frame event we don't need. */
3390 if (NILP (Vterminal_frame)
3391 && CONSP (Vframe_list)
3392 && !NILP (XCDR (Vframe_list)))
3394 bufp->kind = FOCUS_IN_EVENT;
3395 XSETFRAME (bufp->frame_or_window, frame);
3399 frame->output_data.x->focus_state |= state;
3401 #ifdef HAVE_X_I18N
3402 if (FRAME_XIC (frame))
3403 XSetICFocus (FRAME_XIC (frame));
3404 #endif
3406 else if (type == FocusOut)
3408 frame->output_data.x->focus_state &= ~state;
3410 if (dpyinfo->x_focus_event_frame == frame)
3412 dpyinfo->x_focus_event_frame = 0;
3413 x_new_focus_frame (dpyinfo, 0);
3416 #ifdef HAVE_X_I18N
3417 if (FRAME_XIC (frame))
3418 XUnsetICFocus (FRAME_XIC (frame));
3419 #endif
3420 if (frame->pointer_invisible)
3421 XTtoggle_invisible_pointer (frame, 0);
3425 /* The focus may have changed. Figure out if it is a real focus change,
3426 by checking both FocusIn/Out and Enter/LeaveNotify events.
3428 Returns FOCUS_IN_EVENT event in *BUFP. */
3430 static void
3431 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3433 struct frame *frame;
3435 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3436 if (! frame)
3437 return;
3439 switch (event->type)
3441 case EnterNotify:
3442 case LeaveNotify:
3444 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3445 int focus_state
3446 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3448 if (event->xcrossing.detail != NotifyInferior
3449 && event->xcrossing.focus
3450 && ! (focus_state & FOCUS_EXPLICIT))
3451 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3452 FOCUS_IMPLICIT,
3453 dpyinfo, frame, bufp);
3455 break;
3457 case FocusIn:
3458 case FocusOut:
3459 x_focus_changed (event->type,
3460 (event->xfocus.detail == NotifyPointer ?
3461 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3462 dpyinfo, frame, bufp);
3463 break;
3465 case ClientMessage:
3466 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3468 enum xembed_message msg = event->xclient.data.l[1];
3469 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3470 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3472 break;
3477 #if defined HAVE_MENUS && !defined USE_X_TOOLKIT && !defined USE_GTK
3478 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3480 void
3481 x_mouse_leave (struct x_display_info *dpyinfo)
3483 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3485 #endif
3487 /* The focus has changed, or we have redirected a frame's focus to
3488 another frame (this happens when a frame uses a surrogate
3489 mini-buffer frame). Shift the highlight as appropriate.
3491 The FRAME argument doesn't necessarily have anything to do with which
3492 frame is being highlighted or un-highlighted; we only use it to find
3493 the appropriate X display info. */
3495 static void
3496 XTframe_rehighlight (struct frame *frame)
3498 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3501 static void
3502 x_frame_rehighlight (struct x_display_info *dpyinfo)
3504 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3506 if (dpyinfo->x_focus_frame)
3508 dpyinfo->x_highlight_frame
3509 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3510 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3511 : dpyinfo->x_focus_frame);
3512 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3514 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3515 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3518 else
3519 dpyinfo->x_highlight_frame = 0;
3521 if (dpyinfo->x_highlight_frame != old_highlight)
3523 if (old_highlight)
3524 frame_unhighlight (old_highlight);
3525 if (dpyinfo->x_highlight_frame)
3526 frame_highlight (dpyinfo->x_highlight_frame);
3532 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3534 /* Initialize mode_switch_bit and modifier_meaning. */
3535 static void
3536 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3538 int min_code, max_code;
3539 KeySym *syms;
3540 int syms_per_code;
3541 XModifierKeymap *mods;
3543 dpyinfo->meta_mod_mask = 0;
3544 dpyinfo->shift_lock_mask = 0;
3545 dpyinfo->alt_mod_mask = 0;
3546 dpyinfo->super_mod_mask = 0;
3547 dpyinfo->hyper_mod_mask = 0;
3549 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3551 syms = XGetKeyboardMapping (dpyinfo->display,
3552 min_code, max_code - min_code + 1,
3553 &syms_per_code);
3554 mods = XGetModifierMapping (dpyinfo->display);
3556 /* Scan the modifier table to see which modifier bits the Meta and
3557 Alt keysyms are on. */
3559 int row, col; /* The row and column in the modifier table. */
3560 int found_alt_or_meta;
3562 for (row = 3; row < 8; row++)
3564 found_alt_or_meta = 0;
3565 for (col = 0; col < mods->max_keypermod; col++)
3567 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3569 /* Zeroes are used for filler. Skip them. */
3570 if (code == 0)
3571 continue;
3573 /* Are any of this keycode's keysyms a meta key? */
3575 int code_col;
3577 for (code_col = 0; code_col < syms_per_code; code_col++)
3579 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3581 switch (sym)
3583 case XK_Meta_L:
3584 case XK_Meta_R:
3585 found_alt_or_meta = 1;
3586 dpyinfo->meta_mod_mask |= (1 << row);
3587 break;
3589 case XK_Alt_L:
3590 case XK_Alt_R:
3591 found_alt_or_meta = 1;
3592 dpyinfo->alt_mod_mask |= (1 << row);
3593 break;
3595 case XK_Hyper_L:
3596 case XK_Hyper_R:
3597 if (!found_alt_or_meta)
3598 dpyinfo->hyper_mod_mask |= (1 << row);
3599 code_col = syms_per_code;
3600 col = mods->max_keypermod;
3601 break;
3603 case XK_Super_L:
3604 case XK_Super_R:
3605 if (!found_alt_or_meta)
3606 dpyinfo->super_mod_mask |= (1 << row);
3607 code_col = syms_per_code;
3608 col = mods->max_keypermod;
3609 break;
3611 case XK_Shift_Lock:
3612 /* Ignore this if it's not on the lock modifier. */
3613 if (!found_alt_or_meta && ((1 << row) == LockMask))
3614 dpyinfo->shift_lock_mask = LockMask;
3615 code_col = syms_per_code;
3616 col = mods->max_keypermod;
3617 break;
3625 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3626 if (! dpyinfo->meta_mod_mask)
3628 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3629 dpyinfo->alt_mod_mask = 0;
3632 /* If some keys are both alt and meta,
3633 make them just meta, not alt. */
3634 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3636 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3639 XFree ((char *) syms);
3640 XFreeModifiermap (mods);
3643 /* Convert between the modifier bits X uses and the modifier bits
3644 Emacs uses. */
3646 EMACS_INT
3647 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
3649 EMACS_INT mod_meta = meta_modifier;
3650 EMACS_INT mod_alt = alt_modifier;
3651 EMACS_INT mod_hyper = hyper_modifier;
3652 EMACS_INT mod_super = super_modifier;
3653 Lisp_Object tem;
3655 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3656 if (INTEGERP (tem)) mod_alt = XINT (tem);
3657 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3658 if (INTEGERP (tem)) mod_meta = XINT (tem);
3659 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3660 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3661 tem = Fget (Vx_super_keysym, Qmodifier_value);
3662 if (INTEGERP (tem)) mod_super = XINT (tem);
3665 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3666 | ((state & ControlMask) ? ctrl_modifier : 0)
3667 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3668 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3669 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3670 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3673 static int
3674 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
3676 int mod_meta = meta_modifier;
3677 int mod_alt = alt_modifier;
3678 int mod_hyper = hyper_modifier;
3679 int mod_super = super_modifier;
3681 Lisp_Object tem;
3683 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3684 if (INTEGERP (tem)) mod_alt = XINT (tem);
3685 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3686 if (INTEGERP (tem)) mod_meta = XINT (tem);
3687 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3688 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3689 tem = Fget (Vx_super_keysym, Qmodifier_value);
3690 if (INTEGERP (tem)) mod_super = XINT (tem);
3693 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3694 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3695 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3696 | ((state & shift_modifier) ? ShiftMask : 0)
3697 | ((state & ctrl_modifier) ? ControlMask : 0)
3698 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3701 /* Convert a keysym to its name. */
3703 char *
3704 x_get_keysym_name (int keysym)
3706 char *value;
3708 BLOCK_INPUT;
3709 value = XKeysymToString (keysym);
3710 UNBLOCK_INPUT;
3712 return value;
3717 /* Mouse clicks and mouse movement. Rah. */
3719 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3721 If the event is a button press, then note that we have grabbed
3722 the mouse. */
3724 static Lisp_Object
3725 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3727 /* Make the event type NO_EVENT; we'll change that when we decide
3728 otherwise. */
3729 result->kind = MOUSE_CLICK_EVENT;
3730 result->code = event->button - Button1;
3731 result->timestamp = event->time;
3732 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3733 event->state)
3734 | (event->type == ButtonRelease
3735 ? up_modifier
3736 : down_modifier));
3738 XSETINT (result->x, event->x);
3739 XSETINT (result->y, event->y);
3740 XSETFRAME (result->frame_or_window, f);
3741 result->arg = Qnil;
3742 return Qnil;
3746 /* Function to report a mouse movement to the mainstream Emacs code.
3747 The input handler calls this.
3749 We have received a mouse movement event, which is given in *event.
3750 If the mouse is over a different glyph than it was last time, tell
3751 the mainstream emacs code by setting mouse_moved. If not, ask for
3752 another motion event, so we can check again the next time it moves. */
3754 static XMotionEvent last_mouse_motion_event;
3755 static Lisp_Object last_mouse_motion_frame;
3757 static int
3758 note_mouse_movement (FRAME_PTR frame, XMotionEvent *event)
3760 last_mouse_movement_time = event->time;
3761 last_mouse_motion_event = *event;
3762 XSETFRAME (last_mouse_motion_frame, frame);
3764 if (!FRAME_X_OUTPUT (frame))
3765 return 0;
3767 if (event->window != FRAME_X_WINDOW (frame))
3769 frame->mouse_moved = 1;
3770 last_mouse_scroll_bar = Qnil;
3771 note_mouse_highlight (frame, -1, -1);
3772 last_mouse_glyph_frame = 0;
3773 return 1;
3777 /* Has the mouse moved off the glyph it was on at the last sighting? */
3778 if (frame != last_mouse_glyph_frame
3779 || event->x < last_mouse_glyph.x
3780 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3781 || event->y < last_mouse_glyph.y
3782 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3784 frame->mouse_moved = 1;
3785 last_mouse_scroll_bar = Qnil;
3786 note_mouse_highlight (frame, event->x, event->y);
3787 /* Remember which glyph we're now on. */
3788 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3789 last_mouse_glyph_frame = frame;
3790 return 1;
3793 return 0;
3797 /************************************************************************
3798 Mouse Face
3799 ************************************************************************/
3801 static void
3802 redo_mouse_highlight (void)
3804 if (!NILP (last_mouse_motion_frame)
3805 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3806 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3807 last_mouse_motion_event.x,
3808 last_mouse_motion_event.y);
3813 /* Return the current position of the mouse.
3814 *FP should be a frame which indicates which display to ask about.
3816 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3817 and *PART to the frame, window, and scroll bar part that the mouse
3818 is over. Set *X and *Y to the portion and whole of the mouse's
3819 position on the scroll bar.
3821 If the mouse movement started elsewhere, set *FP to the frame the
3822 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3823 the mouse is over.
3825 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
3826 was at this position.
3828 Don't store anything if we don't have a valid set of values to report.
3830 This clears the mouse_moved flag, so we can wait for the next mouse
3831 movement. */
3833 static void
3834 XTmouse_position (FRAME_PTR *fp, int insist, Lisp_Object *bar_window,
3835 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
3836 Time *timestamp)
3838 FRAME_PTR f1;
3840 BLOCK_INPUT;
3842 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3843 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
3844 else
3846 Window root;
3847 int root_x, root_y;
3849 Window dummy_window;
3850 int dummy;
3852 Lisp_Object frame, tail;
3854 /* Clear the mouse-moved flag for every frame on this display. */
3855 FOR_EACH_FRAME (tail, frame)
3856 if (FRAME_X_P (XFRAME (frame))
3857 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3858 XFRAME (frame)->mouse_moved = 0;
3860 last_mouse_scroll_bar = Qnil;
3862 /* Figure out which root window we're on. */
3863 XQueryPointer (FRAME_X_DISPLAY (*fp),
3864 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3866 /* The root window which contains the pointer. */
3867 &root,
3869 /* Trash which we can't trust if the pointer is on
3870 a different screen. */
3871 &dummy_window,
3873 /* The position on that root window. */
3874 &root_x, &root_y,
3876 /* More trash we can't trust. */
3877 &dummy, &dummy,
3879 /* Modifier keys and pointer buttons, about which
3880 we don't care. */
3881 (unsigned int *) &dummy);
3883 /* Now we have a position on the root; find the innermost window
3884 containing the pointer. */
3886 Window win, child;
3887 int win_x, win_y;
3888 int parent_x = 0, parent_y = 0;
3890 win = root;
3892 /* XTranslateCoordinates can get errors if the window
3893 structure is changing at the same time this function
3894 is running. So at least we must not crash from them. */
3896 x_catch_errors (FRAME_X_DISPLAY (*fp));
3898 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3899 && FRAME_LIVE_P (last_mouse_frame))
3901 /* If mouse was grabbed on a frame, give coords for that frame
3902 even if the mouse is now outside it. */
3903 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3905 /* From-window, to-window. */
3906 root, FRAME_X_WINDOW (last_mouse_frame),
3908 /* From-position, to-position. */
3909 root_x, root_y, &win_x, &win_y,
3911 /* Child of win. */
3912 &child);
3913 f1 = last_mouse_frame;
3915 else
3917 while (1)
3919 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3921 /* From-window, to-window. */
3922 root, win,
3924 /* From-position, to-position. */
3925 root_x, root_y, &win_x, &win_y,
3927 /* Child of win. */
3928 &child);
3930 if (child == None || child == win)
3931 break;
3932 #ifdef USE_GTK
3933 /* We don't wan't to know the innermost window. We
3934 want the edit window. For non-Gtk+ the innermost
3935 window is the edit window. For Gtk+ it might not
3936 be. It might be the tool bar for example. */
3937 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3938 break;
3939 #endif
3940 win = child;
3941 parent_x = win_x;
3942 parent_y = win_y;
3945 /* Now we know that:
3946 win is the innermost window containing the pointer
3947 (XTC says it has no child containing the pointer),
3948 win_x and win_y are the pointer's position in it
3949 (XTC did this the last time through), and
3950 parent_x and parent_y are the pointer's position in win's parent.
3951 (They are what win_x and win_y were when win was child.
3952 If win is the root window, it has no parent, and
3953 parent_{x,y} are invalid, but that's okay, because we'll
3954 never use them in that case.) */
3956 #ifdef USE_GTK
3957 /* We don't wan't to know the innermost window. We
3958 want the edit window. */
3959 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3960 #else
3961 /* Is win one of our frames? */
3962 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3963 #endif
3965 #ifdef USE_X_TOOLKIT
3966 /* If we end up with the menu bar window, say it's not
3967 on the frame. */
3968 if (f1 != NULL
3969 && f1->output_data.x->menubar_widget
3970 && win == XtWindow (f1->output_data.x->menubar_widget))
3971 f1 = NULL;
3972 #endif /* USE_X_TOOLKIT */
3975 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3976 f1 = 0;
3978 x_uncatch_errors ();
3980 /* If not, is it one of our scroll bars? */
3981 if (! f1)
3983 struct scroll_bar *bar;
3985 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3987 if (bar)
3989 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3990 win_x = parent_x;
3991 win_y = parent_y;
3995 if (f1 == 0 && insist > 0)
3996 f1 = SELECTED_FRAME ();
3998 if (f1)
4000 /* Ok, we found a frame. Store all the values.
4001 last_mouse_glyph is a rectangle used to reduce the
4002 generation of mouse events. To not miss any motion
4003 events, we must divide the frame into rectangles of the
4004 size of the smallest character that could be displayed
4005 on it, i.e. into the same rectangles that matrices on
4006 the frame are divided into. */
4008 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
4009 last_mouse_glyph_frame = f1;
4011 *bar_window = Qnil;
4012 *part = 0;
4013 *fp = f1;
4014 XSETINT (*x, win_x);
4015 XSETINT (*y, win_y);
4016 *timestamp = last_mouse_movement_time;
4021 UNBLOCK_INPUT;
4026 /***********************************************************************
4027 Scroll bars
4028 ***********************************************************************/
4030 /* Scroll bar support. */
4032 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4033 manages it.
4034 This can be called in GC, so we have to make sure to strip off mark
4035 bits. */
4037 static struct scroll_bar *
4038 x_window_to_scroll_bar (Display *display, Window window_id)
4040 Lisp_Object tail;
4042 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4043 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4044 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4046 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4048 Lisp_Object frame, bar, condemned;
4050 frame = XCAR (tail);
4051 /* All elements of Vframe_list should be frames. */
4052 if (! FRAMEP (frame))
4053 abort ();
4055 if (! FRAME_X_P (XFRAME (frame)))
4056 continue;
4058 /* Scan this frame's scroll bar list for a scroll bar with the
4059 right window ID. */
4060 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4061 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4062 /* This trick allows us to search both the ordinary and
4063 condemned scroll bar lists with one loop. */
4064 ! NILP (bar) || (bar = condemned,
4065 condemned = Qnil,
4066 ! NILP (bar));
4067 bar = XSCROLL_BAR (bar)->next)
4068 if (XSCROLL_BAR (bar)->x_window == window_id &&
4069 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4070 return XSCROLL_BAR (bar);
4073 return NULL;
4077 #if defined USE_LUCID
4079 /* Return the Lucid menu bar WINDOW is part of. Return null
4080 if WINDOW is not part of a menu bar. */
4082 static Widget
4083 x_window_to_menu_bar (Window window)
4085 Lisp_Object tail;
4087 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4089 if (FRAME_X_P (XFRAME (XCAR (tail))))
4091 Lisp_Object frame = XCAR (tail);
4092 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4094 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4095 return menu_bar;
4099 return NULL;
4102 #endif /* USE_LUCID */
4105 /************************************************************************
4106 Toolkit scroll bars
4107 ************************************************************************/
4109 #ifdef USE_TOOLKIT_SCROLL_BARS
4111 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4112 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4113 static void x_create_toolkit_scroll_bar (struct frame *,
4114 struct scroll_bar *);
4115 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4116 int, int, int);
4119 /* Lisp window being scrolled. Set when starting to interact with
4120 a toolkit scroll bar, reset to nil when ending the interaction. */
4122 static Lisp_Object window_being_scrolled;
4124 /* Last scroll bar part sent in xm_scroll_callback. */
4126 static int last_scroll_bar_part;
4128 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4129 that movements of 1/20 of the screen size are mapped to up/down. */
4131 #ifndef USE_GTK
4132 /* Id of action hook installed for scroll bars. */
4134 static XtActionHookId action_hook_id;
4136 static Boolean xaw3d_arrow_scroll;
4138 /* Whether the drag scrolling maintains the mouse at the top of the
4139 thumb. If not, resizing the thumb needs to be done more carefully
4140 to avoid jerkyness. */
4142 static Boolean xaw3d_pick_top;
4144 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4145 bars are used.. The hook is responsible for detecting when
4146 the user ends an interaction with the scroll bar, and generates
4147 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4149 static void
4150 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4151 XEvent *event, String *params, Cardinal *num_params)
4153 int scroll_bar_p;
4154 const char *end_action;
4156 #ifdef USE_MOTIF
4157 scroll_bar_p = XmIsScrollBar (widget);
4158 end_action = "Release";
4159 #else /* !USE_MOTIF i.e. use Xaw */
4160 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4161 end_action = "EndScroll";
4162 #endif /* USE_MOTIF */
4164 if (scroll_bar_p
4165 && strcmp (action_name, end_action) == 0
4166 && WINDOWP (window_being_scrolled))
4168 struct window *w;
4170 x_send_scroll_bar_event (window_being_scrolled,
4171 scroll_bar_end_scroll, 0, 0);
4172 w = XWINDOW (window_being_scrolled);
4174 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4176 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4177 /* The thumb size is incorrect while dragging: fix it. */
4178 set_vertical_scroll_bar (w);
4180 window_being_scrolled = Qnil;
4181 last_scroll_bar_part = -1;
4183 /* Xt timeouts no longer needed. */
4184 toolkit_scroll_bar_interaction = 0;
4187 #endif /* not USE_GTK */
4189 /* A vector of windows used for communication between
4190 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4192 static struct window **scroll_bar_windows;
4193 static size_t scroll_bar_windows_size;
4196 /* Send a client message with message type Xatom_Scrollbar for a
4197 scroll action to the frame of WINDOW. PART is a value identifying
4198 the part of the scroll bar that was clicked on. PORTION is the
4199 amount to scroll of a whole of WHOLE. */
4201 static void
4202 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4204 XEvent event;
4205 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4206 struct window *w = XWINDOW (window);
4207 struct frame *f = XFRAME (w->frame);
4208 size_t i;
4210 BLOCK_INPUT;
4212 /* Construct a ClientMessage event to send to the frame. */
4213 ev->type = ClientMessage;
4214 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4215 ev->display = FRAME_X_DISPLAY (f);
4216 ev->window = FRAME_X_WINDOW (f);
4217 ev->format = 32;
4219 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4220 not enough to store a pointer or Lisp_Object on a 64 bit system.
4221 So, store the window in scroll_bar_windows and pass the index
4222 into that array in the event. */
4223 for (i = 0; i < scroll_bar_windows_size; ++i)
4224 if (scroll_bar_windows[i] == NULL)
4225 break;
4227 if (i == scroll_bar_windows_size)
4229 size_t new_size = max (10, 2 * scroll_bar_windows_size);
4230 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4231 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4233 if ((size_t) -1 / sizeof *scroll_bar_windows < new_size)
4234 memory_full (SIZE_MAX);
4235 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4236 nbytes);
4237 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4238 scroll_bar_windows_size = new_size;
4241 scroll_bar_windows[i] = w;
4242 ev->data.l[0] = (long) i;
4243 ev->data.l[1] = (long) part;
4244 ev->data.l[2] = (long) 0;
4245 ev->data.l[3] = (long) portion;
4246 ev->data.l[4] = (long) whole;
4248 /* Make Xt timeouts work while the scroll bar is active. */
4249 #ifdef USE_X_TOOLKIT
4250 toolkit_scroll_bar_interaction = 1;
4251 x_activate_timeout_atimer ();
4252 #endif
4254 /* Setting the event mask to zero means that the message will
4255 be sent to the client that created the window, and if that
4256 window no longer exists, no event will be sent. */
4257 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4258 UNBLOCK_INPUT;
4262 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4263 in *IEVENT. */
4265 static void
4266 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4268 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4269 Lisp_Object window;
4270 struct window *w;
4272 w = scroll_bar_windows[ev->data.l[0]];
4273 scroll_bar_windows[ev->data.l[0]] = NULL;
4275 XSETWINDOW (window, w);
4277 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4278 ievent->frame_or_window = window;
4279 ievent->arg = Qnil;
4280 #ifdef USE_GTK
4281 ievent->timestamp = CurrentTime;
4282 #else
4283 ievent->timestamp =
4284 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
4285 #endif
4286 ievent->part = ev->data.l[1];
4287 ievent->code = ev->data.l[2];
4288 ievent->x = make_number ((int) ev->data.l[3]);
4289 ievent->y = make_number ((int) ev->data.l[4]);
4290 ievent->modifiers = 0;
4294 #ifdef USE_MOTIF
4296 /* Minimum and maximum values used for Motif scroll bars. */
4298 #define XM_SB_MAX 10000000
4301 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4302 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4303 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4305 static void
4306 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4308 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4309 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4310 int part = -1, whole = 0, portion = 0;
4312 switch (cs->reason)
4314 case XmCR_DECREMENT:
4315 bar->dragging = Qnil;
4316 part = scroll_bar_up_arrow;
4317 break;
4319 case XmCR_INCREMENT:
4320 bar->dragging = Qnil;
4321 part = scroll_bar_down_arrow;
4322 break;
4324 case XmCR_PAGE_DECREMENT:
4325 bar->dragging = Qnil;
4326 part = scroll_bar_above_handle;
4327 break;
4329 case XmCR_PAGE_INCREMENT:
4330 bar->dragging = Qnil;
4331 part = scroll_bar_below_handle;
4332 break;
4334 case XmCR_TO_TOP:
4335 bar->dragging = Qnil;
4336 part = scroll_bar_to_top;
4337 break;
4339 case XmCR_TO_BOTTOM:
4340 bar->dragging = Qnil;
4341 part = scroll_bar_to_bottom;
4342 break;
4344 case XmCR_DRAG:
4346 int slider_size;
4348 /* Get the slider size. */
4349 BLOCK_INPUT;
4350 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4351 UNBLOCK_INPUT;
4353 whole = XM_SB_MAX - slider_size;
4354 portion = min (cs->value, whole);
4355 part = scroll_bar_handle;
4356 bar->dragging = make_number (cs->value);
4358 break;
4360 case XmCR_VALUE_CHANGED:
4361 break;
4364 if (part >= 0)
4366 window_being_scrolled = bar->window;
4367 last_scroll_bar_part = part;
4368 x_send_scroll_bar_event (bar->window, part, portion, whole);
4372 #elif defined USE_GTK
4374 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4375 bar widget. DATA is a pointer to the scroll_bar structure. */
4377 static gboolean
4378 xg_scroll_callback (GtkRange *range,
4379 GtkScrollType scroll,
4380 gdouble value,
4381 gpointer user_data)
4383 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4384 gdouble position;
4385 int part = -1, whole = 0, portion = 0;
4386 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4387 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4389 if (xg_ignore_gtk_scrollbar) return FALSE;
4390 position = gtk_adjustment_get_value (adj);
4393 switch (scroll)
4395 case GTK_SCROLL_JUMP:
4396 /* Buttons 1 2 or 3 must be grabbed. */
4397 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4398 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4400 part = scroll_bar_handle;
4401 whole = gtk_adjustment_get_upper (adj) -
4402 gtk_adjustment_get_page_size (adj);
4403 portion = min ((int)position, whole);
4404 bar->dragging = make_number ((int)portion);
4406 break;
4407 case GTK_SCROLL_STEP_BACKWARD:
4408 part = scroll_bar_up_arrow;
4409 bar->dragging = Qnil;
4410 break;
4411 case GTK_SCROLL_STEP_FORWARD:
4412 part = scroll_bar_down_arrow;
4413 bar->dragging = Qnil;
4414 break;
4415 case GTK_SCROLL_PAGE_BACKWARD:
4416 part = scroll_bar_above_handle;
4417 bar->dragging = Qnil;
4418 break;
4419 case GTK_SCROLL_PAGE_FORWARD:
4420 part = scroll_bar_below_handle;
4421 bar->dragging = Qnil;
4422 break;
4425 if (part >= 0)
4427 window_being_scrolled = bar->window;
4428 last_scroll_bar_part = part;
4429 x_send_scroll_bar_event (bar->window, part, portion, whole);
4432 return FALSE;
4435 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4437 static gboolean
4438 xg_end_scroll_callback (GtkWidget *widget,
4439 GdkEventButton *event,
4440 gpointer user_data)
4442 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4443 bar->dragging = Qnil;
4444 if (WINDOWP (window_being_scrolled))
4446 x_send_scroll_bar_event (window_being_scrolled,
4447 scroll_bar_end_scroll, 0, 0);
4448 window_being_scrolled = Qnil;
4451 return FALSE;
4455 #else /* not USE_GTK and not USE_MOTIF */
4457 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4458 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4459 scroll bar struct. CALL_DATA is a pointer to a float saying where
4460 the thumb is. */
4462 static void
4463 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4465 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4466 float top = *(float *) call_data;
4467 float shown;
4468 int whole, portion, height;
4469 int part;
4471 /* Get the size of the thumb, a value between 0 and 1. */
4472 BLOCK_INPUT;
4473 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4474 UNBLOCK_INPUT;
4476 whole = 10000000;
4477 portion = shown < 1 ? top * whole : 0;
4479 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4480 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4481 the bottom, so we force the scrolling whenever we see that we're
4482 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4483 we try to ensure that we always stay two pixels away from the
4484 bottom). */
4485 part = scroll_bar_down_arrow;
4486 else
4487 part = scroll_bar_handle;
4489 window_being_scrolled = bar->window;
4490 bar->dragging = make_number (portion);
4491 last_scroll_bar_part = part;
4492 x_send_scroll_bar_event (bar->window, part, portion, whole);
4496 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4497 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4498 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4499 the scroll bar. CALL_DATA is an integer specifying the action that
4500 has taken place. Its magnitude is in the range 0..height of the
4501 scroll bar. Negative values mean scroll towards buffer start.
4502 Values < height of scroll bar mean line-wise movement. */
4504 static void
4505 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4507 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4508 /* The position really is stored cast to a pointer. */
4509 int position = (long) call_data;
4510 Dimension height;
4511 int part;
4513 /* Get the height of the scroll bar. */
4514 BLOCK_INPUT;
4515 XtVaGetValues (widget, XtNheight, &height, NULL);
4516 UNBLOCK_INPUT;
4518 if (eabs (position) >= height)
4519 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4521 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4522 it maps line-movement to call_data = max(5, height/20). */
4523 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4524 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4525 else
4526 part = scroll_bar_move_ratio;
4528 window_being_scrolled = bar->window;
4529 bar->dragging = Qnil;
4530 last_scroll_bar_part = part;
4531 x_send_scroll_bar_event (bar->window, part, position, height);
4534 #endif /* not USE_GTK and not USE_MOTIF */
4536 #define SCROLL_BAR_NAME "verticalScrollBar"
4538 /* Create the widget for scroll bar BAR on frame F. Record the widget
4539 and X window of the scroll bar in BAR. */
4541 #ifdef USE_GTK
4542 static void
4543 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4545 const char *scroll_bar_name = SCROLL_BAR_NAME;
4547 BLOCK_INPUT;
4548 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4549 G_CALLBACK (xg_end_scroll_callback),
4550 scroll_bar_name);
4551 UNBLOCK_INPUT;
4554 #else /* not USE_GTK */
4556 static void
4557 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4559 Window xwindow;
4560 Widget widget;
4561 Arg av[20];
4562 int ac = 0;
4563 char const *scroll_bar_name = SCROLL_BAR_NAME;
4564 unsigned long pixel;
4566 BLOCK_INPUT;
4568 #ifdef USE_MOTIF
4569 /* Set resources. Create the widget. */
4570 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4571 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4572 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4573 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4574 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4575 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4576 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4578 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4579 if (pixel != -1)
4581 XtSetArg (av[ac], XmNforeground, pixel);
4582 ++ac;
4585 pixel = f->output_data.x->scroll_bar_background_pixel;
4586 if (pixel != -1)
4588 XtSetArg (av[ac], XmNbackground, pixel);
4589 ++ac;
4592 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4593 scroll_bar_name, av, ac);
4595 /* Add one callback for everything that can happen. */
4596 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4597 (XtPointer) bar);
4598 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4599 (XtPointer) bar);
4600 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4601 (XtPointer) bar);
4602 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4603 (XtPointer) bar);
4604 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4605 (XtPointer) bar);
4606 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4607 (XtPointer) bar);
4608 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4609 (XtPointer) bar);
4611 /* Realize the widget. Only after that is the X window created. */
4612 XtRealizeWidget (widget);
4614 /* Set the cursor to an arrow. I didn't find a resource to do that.
4615 And I'm wondering why it hasn't an arrow cursor by default. */
4616 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4617 f->output_data.x->nontext_cursor);
4619 #else /* !USE_MOTIF i.e. use Xaw */
4621 /* Set resources. Create the widget. The background of the
4622 Xaw3d scroll bar widget is a little bit light for my taste.
4623 We don't alter it here to let users change it according
4624 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4625 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4626 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4627 /* For smoother scrolling with Xaw3d -sm */
4628 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4630 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4631 if (pixel != -1)
4633 XtSetArg (av[ac], XtNforeground, pixel);
4634 ++ac;
4637 pixel = f->output_data.x->scroll_bar_background_pixel;
4638 if (pixel != -1)
4640 XtSetArg (av[ac], XtNbackground, pixel);
4641 ++ac;
4644 /* Top/bottom shadow colors. */
4646 /* Allocate them, if necessary. */
4647 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4649 pixel = f->output_data.x->scroll_bar_background_pixel;
4650 if (pixel != -1)
4652 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4653 FRAME_X_COLORMAP (f),
4654 &pixel, 1.2, 0x8000))
4655 pixel = -1;
4656 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4659 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4661 pixel = f->output_data.x->scroll_bar_background_pixel;
4662 if (pixel != -1)
4664 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4665 FRAME_X_COLORMAP (f),
4666 &pixel, 0.6, 0x4000))
4667 pixel = -1;
4668 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4672 #ifdef XtNbeNiceToColormap
4673 /* Tell the toolkit about them. */
4674 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4675 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4676 /* We tried to allocate a color for the top/bottom shadow, and
4677 failed, so tell Xaw3d to use dithering instead. */
4678 /* But only if we have a small colormap. Xaw3d can allocate nice
4679 colors itself. */
4681 XtSetArg (av[ac], XtNbeNiceToColormap,
4682 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4683 ++ac;
4685 else
4686 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4687 be more consistent with other emacs 3d colors, and since Xaw3d is
4688 not good at dealing with allocation failure. */
4690 /* This tells Xaw3d to use real colors instead of dithering for
4691 the shadows. */
4692 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4693 ++ac;
4695 /* Specify the colors. */
4696 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4697 if (pixel != -1)
4699 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4700 ++ac;
4702 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4703 if (pixel != -1)
4705 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4706 ++ac;
4709 #endif
4711 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4712 f->output_data.x->edit_widget, av, ac);
4715 char const *initial = "";
4716 char const *val = initial;
4717 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4718 #ifdef XtNarrowScrollbars
4719 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4720 #endif
4721 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4722 if (xaw3d_arrow_scroll || val == initial)
4723 { /* ARROW_SCROLL */
4724 xaw3d_arrow_scroll = True;
4725 /* Isn't that just a personal preference ? --Stef */
4726 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4730 /* Define callbacks. */
4731 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4732 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4733 (XtPointer) bar);
4735 /* Realize the widget. Only after that is the X window created. */
4736 XtRealizeWidget (widget);
4738 #endif /* !USE_MOTIF */
4740 /* Install an action hook that lets us detect when the user
4741 finishes interacting with a scroll bar. */
4742 if (action_hook_id == 0)
4743 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4745 /* Remember X window and widget in the scroll bar vector. */
4746 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4747 xwindow = XtWindow (widget);
4748 bar->x_window = xwindow;
4750 UNBLOCK_INPUT;
4752 #endif /* not USE_GTK */
4755 /* Set the thumb size and position of scroll bar BAR. We are currently
4756 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4758 #ifdef USE_GTK
4759 static void
4760 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4762 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4765 #else /* not USE_GTK */
4766 static void
4767 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4768 int whole)
4770 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4771 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4772 float top, shown;
4774 BLOCK_INPUT;
4776 #ifdef USE_MOTIF
4778 /* We use an estimate of 30 chars per line rather than the real
4779 `portion' value. This has the disadvantage that the thumb size
4780 is not very representative, but it makes our life a lot easier.
4781 Otherwise, we have to constantly adjust the thumb size, which
4782 we can't always do quickly enough: while dragging, the size of
4783 the thumb might prevent the user from dragging the thumb all the
4784 way to the end. but Motif and some versions of Xaw3d don't allow
4785 updating the thumb size while dragging. Also, even if we can update
4786 its size, the update will often happen too late.
4787 If you don't believe it, check out revision 1.650 of xterm.c to see
4788 what hoops we were going through and the still poor behavior we got. */
4789 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4790 /* When the thumb is at the bottom, position == whole.
4791 So we need to increase `whole' to make space for the thumb. */
4792 whole += portion;
4794 if (whole <= 0)
4795 top = 0, shown = 1;
4796 else
4798 top = (float) position / whole;
4799 shown = (float) portion / whole;
4802 if (NILP (bar->dragging))
4804 int size, value;
4806 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4807 is the scroll bar's maximum and MIN is the scroll bar's minimum
4808 value. */
4809 size = shown * XM_SB_MAX;
4810 size = min (size, XM_SB_MAX);
4811 size = max (size, 1);
4813 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4814 value = top * XM_SB_MAX;
4815 value = min (value, XM_SB_MAX - size);
4817 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4819 #else /* !USE_MOTIF i.e. use Xaw */
4821 if (whole == 0)
4822 top = 0, shown = 1;
4823 else
4825 top = (float) position / whole;
4826 shown = (float) portion / whole;
4830 float old_top, old_shown;
4831 Dimension height;
4832 XtVaGetValues (widget,
4833 XtNtopOfThumb, &old_top,
4834 XtNshown, &old_shown,
4835 XtNheight, &height,
4836 NULL);
4838 /* Massage the top+shown values. */
4839 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4840 top = max (0, min (1, top));
4841 else
4842 top = old_top;
4843 /* Keep two pixels available for moving the thumb down. */
4844 shown = max (0, min (1 - top - (2.0 / height), shown));
4846 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4847 check that your system's configuration file contains a define
4848 for `NARROWPROTO'. See s/freebsd.h for an example. */
4849 if (top != old_top || shown != old_shown)
4851 if (NILP (bar->dragging))
4852 XawScrollbarSetThumb (widget, top, shown);
4853 else
4855 /* Try to make the scrolling a tad smoother. */
4856 if (!xaw3d_pick_top)
4857 shown = min (shown, old_shown);
4859 XawScrollbarSetThumb (widget, top, shown);
4863 #endif /* !USE_MOTIF */
4865 UNBLOCK_INPUT;
4867 #endif /* not USE_GTK */
4869 #endif /* USE_TOOLKIT_SCROLL_BARS */
4873 /************************************************************************
4874 Scroll bars, general
4875 ************************************************************************/
4877 /* Create a scroll bar and return the scroll bar vector for it. W is
4878 the Emacs window on which to create the scroll bar. TOP, LEFT,
4879 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4880 scroll bar. */
4882 static struct scroll_bar *
4883 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4885 struct frame *f = XFRAME (w->frame);
4886 struct scroll_bar *bar
4887 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4889 BLOCK_INPUT;
4891 #ifdef USE_TOOLKIT_SCROLL_BARS
4892 x_create_toolkit_scroll_bar (f, bar);
4893 #else /* not USE_TOOLKIT_SCROLL_BARS */
4895 XSetWindowAttributes a;
4896 unsigned long mask;
4897 Window window;
4899 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4900 if (a.background_pixel == -1)
4901 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4903 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4904 | ButtonMotionMask | PointerMotionHintMask
4905 | ExposureMask);
4906 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4908 mask = (CWBackPixel | CWEventMask | CWCursor);
4910 /* Clear the area of W that will serve as a scroll bar. This is
4911 for the case that a window has been split horizontally. In
4912 this case, no clear_frame is generated to reduce flickering. */
4913 if (width > 0 && height > 0)
4914 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4915 left, top, width,
4916 window_box_height (w), False);
4918 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4919 /* Position and size of scroll bar. */
4920 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4921 top,
4922 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4923 height,
4924 /* Border width, depth, class, and visual. */
4926 CopyFromParent,
4927 CopyFromParent,
4928 CopyFromParent,
4929 /* Attributes. */
4930 mask, &a);
4931 bar->x_window = window;
4933 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4935 XSETWINDOW (bar->window, w);
4936 bar->top = top;
4937 bar->left = left;
4938 bar->width = width;
4939 bar->height = height;
4940 bar->start = 0;
4941 bar->end = 0;
4942 bar->dragging = Qnil;
4943 bar->fringe_extended_p = 0;
4945 /* Add bar to its frame's list of scroll bars. */
4946 bar->next = FRAME_SCROLL_BARS (f);
4947 bar->prev = Qnil;
4948 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4949 if (!NILP (bar->next))
4950 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4952 /* Map the window/widget. */
4953 #ifdef USE_TOOLKIT_SCROLL_BARS
4955 #ifdef USE_GTK
4956 xg_update_scrollbar_pos (f,
4957 bar->x_window,
4958 top,
4959 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4960 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4961 max (height, 1));
4962 #else /* not USE_GTK */
4963 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4964 XtConfigureWidget (scroll_bar,
4965 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4966 top,
4967 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4968 max (height, 1), 0);
4969 XtMapWidget (scroll_bar);
4970 #endif /* not USE_GTK */
4972 #else /* not USE_TOOLKIT_SCROLL_BARS */
4973 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4974 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4976 UNBLOCK_INPUT;
4977 return bar;
4981 #ifndef USE_TOOLKIT_SCROLL_BARS
4983 /* Draw BAR's handle in the proper position.
4985 If the handle is already drawn from START to END, don't bother
4986 redrawing it, unless REBUILD is non-zero; in that case, always
4987 redraw it. (REBUILD is handy for drawing the handle after expose
4988 events.)
4990 Normally, we want to constrain the start and end of the handle to
4991 fit inside its rectangle, but if the user is dragging the scroll
4992 bar handle, we want to let them drag it down all the way, so that
4993 the bar's top is as far down as it goes; otherwise, there's no way
4994 to move to the very end of the buffer. */
4996 static void
4997 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
4999 int dragging = ! NILP (bar->dragging);
5000 Window w = bar->x_window;
5001 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5002 GC gc = f->output_data.x->normal_gc;
5004 /* If the display is already accurate, do nothing. */
5005 if (! rebuild
5006 && start == bar->start
5007 && end == bar->end)
5008 return;
5010 BLOCK_INPUT;
5013 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5014 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5015 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5017 /* Make sure the values are reasonable, and try to preserve
5018 the distance between start and end. */
5020 int length = end - start;
5022 if (start < 0)
5023 start = 0;
5024 else if (start > top_range)
5025 start = top_range;
5026 end = start + length;
5028 if (end < start)
5029 end = start;
5030 else if (end > top_range && ! dragging)
5031 end = top_range;
5034 /* Store the adjusted setting in the scroll bar. */
5035 bar->start = start;
5036 bar->end = end;
5038 /* Clip the end position, just for display. */
5039 if (end > top_range)
5040 end = top_range;
5042 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5043 below top positions, to make sure the handle is always at least
5044 that many pixels tall. */
5045 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5047 /* Draw the empty space above the handle. Note that we can't clear
5048 zero-height areas; that means "clear to end of window." */
5049 if (0 < start)
5050 x_clear_area (FRAME_X_DISPLAY (f), w,
5051 /* x, y, width, height, and exposures. */
5052 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5053 VERTICAL_SCROLL_BAR_TOP_BORDER,
5054 inside_width, start,
5055 False);
5057 /* Change to proper foreground color if one is specified. */
5058 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5059 XSetForeground (FRAME_X_DISPLAY (f), gc,
5060 f->output_data.x->scroll_bar_foreground_pixel);
5062 /* Draw the handle itself. */
5063 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5064 /* x, y, width, height */
5065 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5066 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5067 inside_width, end - start);
5069 /* Restore the foreground color of the GC if we changed it above. */
5070 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5071 XSetForeground (FRAME_X_DISPLAY (f), gc,
5072 FRAME_FOREGROUND_PIXEL (f));
5074 /* Draw the empty space below the handle. Note that we can't
5075 clear zero-height areas; that means "clear to end of window." */
5076 if (end < inside_height)
5077 x_clear_area (FRAME_X_DISPLAY (f), w,
5078 /* x, y, width, height, and exposures. */
5079 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5080 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5081 inside_width, inside_height - end,
5082 False);
5086 UNBLOCK_INPUT;
5089 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5091 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5092 nil. */
5094 static void
5095 x_scroll_bar_remove (struct scroll_bar *bar)
5097 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5098 BLOCK_INPUT;
5100 #ifdef USE_TOOLKIT_SCROLL_BARS
5101 #ifdef USE_GTK
5102 xg_remove_scroll_bar (f, bar->x_window);
5103 #else /* not USE_GTK */
5104 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5105 #endif /* not USE_GTK */
5106 #else
5107 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5108 #endif
5110 /* Disassociate this scroll bar from its window. */
5111 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5113 UNBLOCK_INPUT;
5117 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5118 that we are displaying PORTION characters out of a total of WHOLE
5119 characters, starting at POSITION. If WINDOW has no scroll bar,
5120 create one. */
5122 static void
5123 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5125 struct frame *f = XFRAME (w->frame);
5126 struct scroll_bar *bar;
5127 int top, height, left, sb_left, width, sb_width;
5128 int window_y, window_height;
5129 #ifdef USE_TOOLKIT_SCROLL_BARS
5130 int fringe_extended_p;
5131 #endif
5133 /* Get window dimensions. */
5134 window_box (w, -1, 0, &window_y, 0, &window_height);
5135 top = window_y;
5136 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5137 height = window_height;
5139 /* Compute the left edge of the scroll bar area. */
5140 left = WINDOW_SCROLL_BAR_AREA_X (w);
5142 /* Compute the width of the scroll bar which might be less than
5143 the width of the area reserved for the scroll bar. */
5144 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5145 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5146 else
5147 sb_width = width;
5149 /* Compute the left edge of the scroll bar. */
5150 #ifdef USE_TOOLKIT_SCROLL_BARS
5151 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5152 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5153 else
5154 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5155 #else
5156 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5157 sb_left = left + width - sb_width;
5158 else
5159 sb_left = left;
5160 #endif
5162 #ifdef USE_TOOLKIT_SCROLL_BARS
5163 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5164 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5165 && WINDOW_LEFT_FRINGE_WIDTH (w)
5166 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5167 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5168 else
5169 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5170 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5171 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5172 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5173 #endif
5175 /* Does the scroll bar exist yet? */
5176 if (NILP (w->vertical_scroll_bar))
5178 if (width > 0 && height > 0)
5180 BLOCK_INPUT;
5181 #ifdef USE_TOOLKIT_SCROLL_BARS
5182 if (fringe_extended_p)
5183 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5184 sb_left, top, sb_width, height, False);
5185 else
5186 #endif
5187 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5188 left, top, width, height, False);
5189 UNBLOCK_INPUT;
5192 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5194 else
5196 /* It may just need to be moved and resized. */
5197 unsigned int mask = 0;
5199 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5201 BLOCK_INPUT;
5203 if (sb_left != bar->left)
5204 mask |= CWX;
5205 if (top != bar->top)
5206 mask |= CWY;
5207 if (sb_width != bar->width)
5208 mask |= CWWidth;
5209 if (height != bar->height)
5210 mask |= CWHeight;
5212 #ifdef USE_TOOLKIT_SCROLL_BARS
5214 /* Move/size the scroll bar widget. */
5215 if (mask || bar->fringe_extended_p != fringe_extended_p)
5217 /* Since toolkit scroll bars are smaller than the space reserved
5218 for them on the frame, we have to clear "under" them. */
5219 if (width > 0 && height > 0)
5221 if (fringe_extended_p)
5222 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5223 sb_left, top, sb_width, height, False);
5224 else
5225 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5226 left, top, width, height, False);
5228 #ifdef USE_GTK
5229 xg_update_scrollbar_pos (f,
5230 bar->x_window,
5231 top,
5232 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5233 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5234 max (height, 1));
5235 #else /* not USE_GTK */
5236 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5237 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5238 top,
5239 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5240 max (height, 1), 0);
5241 #endif /* not USE_GTK */
5243 #else /* not USE_TOOLKIT_SCROLL_BARS */
5245 /* Clear areas not covered by the scroll bar because of
5246 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5247 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5249 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5250 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5251 height, False);
5252 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5253 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5254 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5255 height, False);
5258 /* Clear areas not covered by the scroll bar because it's not as
5259 wide as the area reserved for it. This makes sure a
5260 previous mode line display is cleared after C-x 2 C-x 1, for
5261 example. */
5263 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5264 int rest = area_width - sb_width;
5265 if (rest > 0 && height > 0)
5267 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5268 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5269 left + area_width - rest, top,
5270 rest, height, False);
5271 else
5272 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5273 left, top, rest, height, False);
5277 /* Move/size the scroll bar window. */
5278 if (mask)
5280 XWindowChanges wc;
5282 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5283 wc.y = top;
5284 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5285 wc.height = height;
5286 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5287 mask, &wc);
5290 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5292 /* Remember new settings. */
5293 bar->left = sb_left;
5294 bar->top = top;
5295 bar->width = sb_width;
5296 bar->height = height;
5298 UNBLOCK_INPUT;
5301 #ifdef USE_TOOLKIT_SCROLL_BARS
5302 bar->fringe_extended_p = fringe_extended_p;
5304 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5305 #else /* not USE_TOOLKIT_SCROLL_BARS */
5306 /* Set the scroll bar's current state, unless we're currently being
5307 dragged. */
5308 if (NILP (bar->dragging))
5310 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5312 if (whole == 0)
5313 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5314 else
5316 int start = ((double) position * top_range) / whole;
5317 int end = ((double) (position + portion) * top_range) / whole;
5318 x_scroll_bar_set_handle (bar, start, end, 0);
5321 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5323 XSETVECTOR (w->vertical_scroll_bar, bar);
5327 /* The following three hooks are used when we're doing a thorough
5328 redisplay of the frame. We don't explicitly know which scroll bars
5329 are going to be deleted, because keeping track of when windows go
5330 away is a real pain - "Can you say set-window-configuration, boys
5331 and girls?" Instead, we just assert at the beginning of redisplay
5332 that *all* scroll bars are to be removed, and then save a scroll bar
5333 from the fiery pit when we actually redisplay its window. */
5335 /* Arrange for all scroll bars on FRAME to be removed at the next call
5336 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5337 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5339 static void
5340 XTcondemn_scroll_bars (FRAME_PTR frame)
5342 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5343 while (! NILP (FRAME_SCROLL_BARS (frame)))
5345 Lisp_Object bar;
5346 bar = FRAME_SCROLL_BARS (frame);
5347 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5348 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5349 XSCROLL_BAR (bar)->prev = Qnil;
5350 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5351 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5352 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5357 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5358 Note that WINDOW isn't necessarily condemned at all. */
5360 static void
5361 XTredeem_scroll_bar (struct window *window)
5363 struct scroll_bar *bar;
5364 struct frame *f;
5366 /* We can't redeem this window's scroll bar if it doesn't have one. */
5367 if (NILP (window->vertical_scroll_bar))
5368 abort ();
5370 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5372 /* Unlink it from the condemned list. */
5373 f = XFRAME (WINDOW_FRAME (window));
5374 if (NILP (bar->prev))
5376 /* If the prev pointer is nil, it must be the first in one of
5377 the lists. */
5378 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5379 /* It's not condemned. Everything's fine. */
5380 return;
5381 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5382 window->vertical_scroll_bar))
5383 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5384 else
5385 /* If its prev pointer is nil, it must be at the front of
5386 one or the other! */
5387 abort ();
5389 else
5390 XSCROLL_BAR (bar->prev)->next = bar->next;
5392 if (! NILP (bar->next))
5393 XSCROLL_BAR (bar->next)->prev = bar->prev;
5395 bar->next = FRAME_SCROLL_BARS (f);
5396 bar->prev = Qnil;
5397 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5398 if (! NILP (bar->next))
5399 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5402 /* Remove all scroll bars on FRAME that haven't been saved since the
5403 last call to `*condemn_scroll_bars_hook'. */
5405 static void
5406 XTjudge_scroll_bars (FRAME_PTR f)
5408 Lisp_Object bar, next;
5410 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5412 /* Clear out the condemned list now so we won't try to process any
5413 more events on the hapless scroll bars. */
5414 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5416 for (; ! NILP (bar); bar = next)
5418 struct scroll_bar *b = XSCROLL_BAR (bar);
5420 x_scroll_bar_remove (b);
5422 next = b->next;
5423 b->next = b->prev = Qnil;
5426 /* Now there should be no references to the condemned scroll bars,
5427 and they should get garbage-collected. */
5431 #ifndef USE_TOOLKIT_SCROLL_BARS
5432 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5433 is a no-op when using toolkit scroll bars.
5435 This may be called from a signal handler, so we have to ignore GC
5436 mark bits. */
5438 static void
5439 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5441 Window w = bar->x_window;
5442 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5443 GC gc = f->output_data.x->normal_gc;
5444 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5446 BLOCK_INPUT;
5448 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5450 /* Switch to scroll bar foreground color. */
5451 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5452 XSetForeground (FRAME_X_DISPLAY (f), gc,
5453 f->output_data.x->scroll_bar_foreground_pixel);
5455 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5456 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5458 /* x, y, width, height */
5459 0, 0,
5460 bar->width - 1 - width_trim - width_trim,
5461 bar->height - 1);
5463 /* Restore the foreground color of the GC if we changed it above. */
5464 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5465 XSetForeground (FRAME_X_DISPLAY (f), gc,
5466 FRAME_FOREGROUND_PIXEL (f));
5468 UNBLOCK_INPUT;
5471 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5473 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5474 is set to something other than NO_EVENT, it is enqueued.
5476 This may be called from a signal handler, so we have to ignore GC
5477 mark bits. */
5480 static void
5481 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5483 if (! WINDOWP (bar->window))
5484 abort ();
5486 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5487 emacs_event->code = event->xbutton.button - Button1;
5488 emacs_event->modifiers
5489 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5490 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5491 event->xbutton.state)
5492 | (event->type == ButtonRelease
5493 ? up_modifier
5494 : down_modifier));
5495 emacs_event->frame_or_window = bar->window;
5496 emacs_event->arg = Qnil;
5497 emacs_event->timestamp = event->xbutton.time;
5499 int top_range
5500 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5501 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5503 if (y < 0) y = 0;
5504 if (y > top_range) y = top_range;
5506 if (y < bar->start)
5507 emacs_event->part = scroll_bar_above_handle;
5508 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5509 emacs_event->part = scroll_bar_handle;
5510 else
5511 emacs_event->part = scroll_bar_below_handle;
5513 #ifndef USE_TOOLKIT_SCROLL_BARS
5514 /* If the user has released the handle, set it to its final position. */
5515 if (event->type == ButtonRelease
5516 && ! NILP (bar->dragging))
5518 int new_start = y - XINT (bar->dragging);
5519 int new_end = new_start + bar->end - bar->start;
5521 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5522 bar->dragging = Qnil;
5524 #endif
5526 XSETINT (emacs_event->x, y);
5527 XSETINT (emacs_event->y, top_range);
5531 #ifndef USE_TOOLKIT_SCROLL_BARS
5533 /* Handle some mouse motion while someone is dragging the scroll bar.
5535 This may be called from a signal handler, so we have to ignore GC
5536 mark bits. */
5538 static void
5539 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5541 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5543 last_mouse_movement_time = event->xmotion.time;
5545 f->mouse_moved = 1;
5546 XSETVECTOR (last_mouse_scroll_bar, bar);
5548 /* If we're dragging the bar, display it. */
5549 if (! NILP (bar->dragging))
5551 /* Where should the handle be now? */
5552 int new_start = event->xmotion.y - XINT (bar->dragging);
5554 if (new_start != bar->start)
5556 int new_end = new_start + bar->end - bar->start;
5558 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5563 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5565 /* Return information to the user about the current position of the mouse
5566 on the scroll bar. */
5568 static void
5569 x_scroll_bar_report_motion (FRAME_PTR *fp, Lisp_Object *bar_window,
5570 enum scroll_bar_part *part, Lisp_Object *x,
5571 Lisp_Object *y, Time *timestamp)
5573 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5574 Window w = bar->x_window;
5575 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5576 int win_x, win_y;
5577 Window dummy_window;
5578 int dummy_coord;
5579 unsigned int dummy_mask;
5581 BLOCK_INPUT;
5583 /* Get the mouse's position relative to the scroll bar window, and
5584 report that. */
5585 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5587 /* Root, child, root x and root y. */
5588 &dummy_window, &dummy_window,
5589 &dummy_coord, &dummy_coord,
5591 /* Position relative to scroll bar. */
5592 &win_x, &win_y,
5594 /* Mouse buttons and modifier keys. */
5595 &dummy_mask))
5597 else
5599 int top_range
5600 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5602 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5604 if (! NILP (bar->dragging))
5605 win_y -= XINT (bar->dragging);
5607 if (win_y < 0)
5608 win_y = 0;
5609 if (win_y > top_range)
5610 win_y = top_range;
5612 *fp = f;
5613 *bar_window = bar->window;
5615 if (! NILP (bar->dragging))
5616 *part = scroll_bar_handle;
5617 else if (win_y < bar->start)
5618 *part = scroll_bar_above_handle;
5619 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5620 *part = scroll_bar_handle;
5621 else
5622 *part = scroll_bar_below_handle;
5624 XSETINT (*x, win_y);
5625 XSETINT (*y, top_range);
5627 f->mouse_moved = 0;
5628 last_mouse_scroll_bar = Qnil;
5631 *timestamp = last_mouse_movement_time;
5633 UNBLOCK_INPUT;
5637 /* The screen has been cleared so we may have changed foreground or
5638 background colors, and the scroll bars may need to be redrawn.
5639 Clear out the scroll bars, and ask for expose events, so we can
5640 redraw them. */
5642 static void
5643 x_scroll_bar_clear (FRAME_PTR f)
5645 #ifndef USE_TOOLKIT_SCROLL_BARS
5646 Lisp_Object bar;
5648 /* We can have scroll bars even if this is 0,
5649 if we just turned off scroll bar mode.
5650 But in that case we should not clear them. */
5651 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5652 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5653 bar = XSCROLL_BAR (bar)->next)
5654 XClearArea (FRAME_X_DISPLAY (f),
5655 XSCROLL_BAR (bar)->x_window,
5656 0, 0, 0, 0, True);
5657 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5661 /* The main X event-reading loop - XTread_socket. */
5663 /* This holds the state XLookupString needs to implement dead keys
5664 and other tricks known as "compose processing". _X Window System_
5665 says that a portable program can't use this, but Stephen Gildea assures
5666 me that letting the compiler initialize it to zeros will work okay.
5668 This must be defined outside of XTread_socket, for the same reasons
5669 given for enter_timestamp, above. */
5671 static XComposeStatus compose_status;
5673 /* Record the last 100 characters stored
5674 to help debug the loss-of-chars-during-GC problem. */
5676 static int temp_index;
5677 static short temp_buffer[100];
5679 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5680 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5681 temp_index = 0; \
5682 temp_buffer[temp_index++] = (keysym)
5684 /* Set this to nonzero to fake an "X I/O error"
5685 on a particular display. */
5687 static struct x_display_info *XTread_socket_fake_io_error;
5689 /* When we find no input here, we occasionally do a no-op command
5690 to verify that the X server is still running and we can still talk with it.
5691 We try all the open displays, one by one.
5692 This variable is used for cycling thru the displays. */
5694 static struct x_display_info *next_noop_dpyinfo;
5696 #if defined USE_X_TOOLKIT || defined USE_GTK
5697 #define SET_SAVED_BUTTON_EVENT \
5698 do \
5700 if (f->output_data.x->saved_menu_event == 0) \
5701 f->output_data.x->saved_menu_event \
5702 = (XEvent *) xmalloc (sizeof (XEvent)); \
5703 *f->output_data.x->saved_menu_event = event; \
5704 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5705 XSETFRAME (inev.ie.frame_or_window, f); \
5707 while (0)
5708 #endif
5710 enum
5712 X_EVENT_NORMAL,
5713 X_EVENT_GOTO_OUT,
5714 X_EVENT_DROP
5717 /* Filter events for the current X input method.
5718 DPYINFO is the display this event is for.
5719 EVENT is the X event to filter.
5721 Returns non-zero if the event was filtered, caller shall not process
5722 this event further.
5723 Returns zero if event is wasn't filtered. */
5725 #ifdef HAVE_X_I18N
5726 static int
5727 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5729 /* XFilterEvent returns non-zero if the input method has
5730 consumed the event. We pass the frame's X window to
5731 XFilterEvent because that's the one for which the IC
5732 was created. */
5734 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5735 event->xclient.window);
5737 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5739 #endif
5741 #ifdef USE_GTK
5742 static int current_count;
5743 static int current_finish;
5744 static struct input_event *current_hold_quit;
5746 /* This is the filter function invoked by the GTK event loop.
5747 It is invoked before the XEvent is translated to a GdkEvent,
5748 so we have a chance to act on the event before GTK. */
5749 static GdkFilterReturn
5750 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5752 XEvent *xev = (XEvent *) gxev;
5754 BLOCK_INPUT;
5755 if (current_count >= 0)
5757 struct x_display_info *dpyinfo;
5759 dpyinfo = x_display_info_for_display (xev->xany.display);
5761 #ifdef HAVE_X_I18N
5762 /* Filter events for the current X input method.
5763 GTK calls XFilterEvent but not for key press and release,
5764 so we do it here. */
5765 if ((xev->type == KeyPress || xev->type == KeyRelease)
5766 && dpyinfo
5767 && x_filter_event (dpyinfo, xev))
5769 UNBLOCK_INPUT;
5770 return GDK_FILTER_REMOVE;
5772 #endif
5774 if (! dpyinfo)
5775 current_finish = X_EVENT_NORMAL;
5776 else
5777 current_count +=
5778 handle_one_xevent (dpyinfo, xev, &current_finish,
5779 current_hold_quit);
5781 else
5782 current_finish = x_dispatch_event (xev, xev->xany.display);
5784 UNBLOCK_INPUT;
5786 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5787 return GDK_FILTER_REMOVE;
5789 return GDK_FILTER_CONTINUE;
5791 #endif /* USE_GTK */
5794 static void xembed_send_message (struct frame *f, Time,
5795 enum xembed_message,
5796 long detail, long data1, long data2);
5798 /* Handles the XEvent EVENT on display DPYINFO.
5800 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5801 *FINISH is zero if caller should continue reading events.
5802 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5804 We return the number of characters stored into the buffer. */
5806 static int
5807 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventptr,
5808 int *finish, struct input_event *hold_quit)
5810 union {
5811 struct input_event ie;
5812 struct selection_input_event sie;
5813 } inev;
5814 int count = 0;
5815 int do_help = 0;
5816 int nbytes = 0;
5817 struct frame *f = NULL;
5818 struct coding_system coding;
5819 XEvent event = *eventptr;
5820 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5822 *finish = X_EVENT_NORMAL;
5824 EVENT_INIT (inev.ie);
5825 inev.ie.kind = NO_EVENT;
5826 inev.ie.arg = Qnil;
5828 if (pending_event_wait.eventtype == event.type)
5829 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5831 switch (event.type)
5833 case ClientMessage:
5835 if (event.xclient.message_type
5836 == dpyinfo->Xatom_wm_protocols
5837 && event.xclient.format == 32)
5839 if (event.xclient.data.l[0]
5840 == dpyinfo->Xatom_wm_take_focus)
5842 /* Use x_any_window_to_frame because this
5843 could be the shell widget window
5844 if the frame has no title bar. */
5845 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5846 #ifdef HAVE_X_I18N
5847 /* Not quite sure this is needed -pd */
5848 if (f && FRAME_XIC (f))
5849 XSetICFocus (FRAME_XIC (f));
5850 #endif
5851 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5852 instructs the WM to set the input focus automatically for
5853 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5854 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5855 it has set the focus. So, XSetInputFocus below is not
5856 needed.
5858 The call to XSetInputFocus below has also caused trouble. In
5859 cases where the XSetInputFocus done by the WM and the one
5860 below are temporally close (on a fast machine), the call
5861 below can generate additional FocusIn events which confuse
5862 Emacs. */
5864 /* Since we set WM_TAKE_FOCUS, we must call
5865 XSetInputFocus explicitly. But not if f is null,
5866 since that might be an event for a deleted frame. */
5867 if (f)
5869 Display *d = event.xclient.display;
5870 /* Catch and ignore errors, in case window has been
5871 iconified by a window manager such as GWM. */
5872 x_catch_errors (d);
5873 XSetInputFocus (d, event.xclient.window,
5874 /* The ICCCM says this is
5875 the only valid choice. */
5876 RevertToParent,
5877 event.xclient.data.l[1]);
5878 /* This is needed to detect the error
5879 if there is an error. */
5880 XSync (d, False);
5881 x_uncatch_errors ();
5883 /* Not certain about handling scroll bars here */
5884 #endif /* 0 */
5885 goto done;
5888 if (event.xclient.data.l[0]
5889 == dpyinfo->Xatom_wm_save_yourself)
5891 /* Save state modify the WM_COMMAND property to
5892 something which can reinstate us. This notifies
5893 the session manager, who's looking for such a
5894 PropertyNotify. Can restart processing when
5895 a keyboard or mouse event arrives. */
5896 /* If we have a session manager, don't set this.
5897 KDE will then start two Emacsen, one for the
5898 session manager and one for this. */
5899 #ifdef HAVE_X_SM
5900 if (! x_session_have_connection ())
5901 #endif
5903 f = x_top_window_to_frame (dpyinfo,
5904 event.xclient.window);
5905 /* This is just so we only give real data once
5906 for a single Emacs process. */
5907 if (f == SELECTED_FRAME ())
5908 XSetCommand (FRAME_X_DISPLAY (f),
5909 event.xclient.window,
5910 initial_argv, initial_argc);
5911 else if (f)
5912 XSetCommand (FRAME_X_DISPLAY (f),
5913 event.xclient.window,
5914 0, 0);
5916 goto done;
5919 if (event.xclient.data.l[0]
5920 == dpyinfo->Xatom_wm_delete_window)
5922 f = x_any_window_to_frame (dpyinfo,
5923 event.xclient.window);
5924 if (!f)
5925 goto OTHER; /* May be a dialog that is to be removed */
5927 inev.ie.kind = DELETE_WINDOW_EVENT;
5928 XSETFRAME (inev.ie.frame_or_window, f);
5929 goto done;
5932 goto done;
5935 if (event.xclient.message_type
5936 == dpyinfo->Xatom_wm_configure_denied)
5938 goto done;
5941 if (event.xclient.message_type
5942 == dpyinfo->Xatom_wm_window_moved)
5944 int new_x, new_y;
5945 f = x_window_to_frame (dpyinfo, event.xclient.window);
5947 new_x = event.xclient.data.s[0];
5948 new_y = event.xclient.data.s[1];
5950 if (f)
5952 f->left_pos = new_x;
5953 f->top_pos = new_y;
5955 goto done;
5958 #ifdef HACK_EDITRES
5959 if (event.xclient.message_type
5960 == dpyinfo->Xatom_editres)
5962 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5963 if (f)
5964 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5965 &event, NULL);
5966 goto done;
5968 #endif /* HACK_EDITRES */
5970 if ((event.xclient.message_type
5971 == dpyinfo->Xatom_DONE)
5972 || (event.xclient.message_type
5973 == dpyinfo->Xatom_PAGE))
5975 /* Ghostview job completed. Kill it. We could
5976 reply with "Next" if we received "Page", but we
5977 currently never do because we are interested in
5978 images, only, which should have 1 page. */
5979 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5980 f = x_window_to_frame (dpyinfo, event.xclient.window);
5981 if (!f)
5982 goto OTHER;
5983 x_kill_gs_process (pixmap, f);
5984 expose_frame (f, 0, 0, 0, 0);
5985 goto done;
5988 #ifdef USE_TOOLKIT_SCROLL_BARS
5989 /* Scroll bar callbacks send a ClientMessage from which
5990 we construct an input_event. */
5991 if (event.xclient.message_type
5992 == dpyinfo->Xatom_Scrollbar)
5994 x_scroll_bar_to_input_event (&event, &inev.ie);
5995 *finish = X_EVENT_GOTO_OUT;
5996 goto done;
5998 #endif /* USE_TOOLKIT_SCROLL_BARS */
6000 /* XEmbed messages from the embedder (if any). */
6001 if (event.xclient.message_type
6002 == dpyinfo->Xatom_XEMBED)
6004 enum xembed_message msg = event.xclient.data.l[1];
6005 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6006 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6008 *finish = X_EVENT_GOTO_OUT;
6009 goto done;
6012 xft_settings_event (dpyinfo, &event);
6014 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6015 if (!f)
6016 goto OTHER;
6017 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6018 *finish = X_EVENT_DROP;
6020 break;
6022 case SelectionNotify:
6023 last_user_time = event.xselection.time;
6024 #ifdef USE_X_TOOLKIT
6025 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6026 goto OTHER;
6027 #endif /* not USE_X_TOOLKIT */
6028 x_handle_selection_notify (&event.xselection);
6029 break;
6031 case SelectionClear: /* Someone has grabbed ownership. */
6032 last_user_time = event.xselectionclear.time;
6033 #ifdef USE_X_TOOLKIT
6034 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6035 goto OTHER;
6036 #endif /* USE_X_TOOLKIT */
6038 XSelectionClearEvent *eventp = &(event.xselectionclear);
6040 inev.ie.kind = SELECTION_CLEAR_EVENT;
6041 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6042 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6043 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6044 inev.ie.frame_or_window = Qnil;
6046 break;
6048 case SelectionRequest: /* Someone wants our selection. */
6049 last_user_time = event.xselectionrequest.time;
6050 #ifdef USE_X_TOOLKIT
6051 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6052 goto OTHER;
6053 #endif /* USE_X_TOOLKIT */
6055 XSelectionRequestEvent *eventp = &(event.xselectionrequest);
6057 inev.ie.kind = SELECTION_REQUEST_EVENT;
6058 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6059 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6060 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6061 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6062 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6063 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6064 inev.ie.frame_or_window = Qnil;
6066 break;
6068 case PropertyNotify:
6069 last_user_time = event.xproperty.time;
6070 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6071 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6072 x_handle_net_wm_state (f, &event.xproperty);
6074 x_handle_property_notify (&event.xproperty);
6075 xft_settings_event (dpyinfo, &event);
6076 goto OTHER;
6078 case ReparentNotify:
6079 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6080 if (f)
6082 int x, y;
6083 f->output_data.x->parent_desc = event.xreparent.parent;
6084 x_real_positions (f, &x, &y);
6085 f->left_pos = x;
6086 f->top_pos = y;
6088 /* Perhaps reparented due to a WM restart. Reset this. */
6089 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6090 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6092 goto OTHER;
6094 case Expose:
6095 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6096 if (f)
6098 #ifdef USE_GTK
6099 /* This seems to be needed for GTK 2.6. */
6100 x_clear_area (event.xexpose.display,
6101 event.xexpose.window,
6102 event.xexpose.x, event.xexpose.y,
6103 event.xexpose.width, event.xexpose.height,
6104 FALSE);
6105 #endif
6106 if (f->async_visible == 0)
6108 f->async_visible = 1;
6109 f->async_iconified = 0;
6110 f->output_data.x->has_been_visible = 1;
6111 SET_FRAME_GARBAGED (f);
6113 else
6114 expose_frame (f,
6115 event.xexpose.x, event.xexpose.y,
6116 event.xexpose.width, event.xexpose.height);
6118 else
6120 #ifndef USE_TOOLKIT_SCROLL_BARS
6121 struct scroll_bar *bar;
6122 #endif
6123 #if defined USE_LUCID
6124 /* Submenus of the Lucid menu bar aren't widgets
6125 themselves, so there's no way to dispatch events
6126 to them. Recognize this case separately. */
6128 Widget widget
6129 = x_window_to_menu_bar (event.xexpose.window);
6130 if (widget)
6131 xlwmenu_redisplay (widget);
6133 #endif /* USE_LUCID */
6135 #ifdef USE_TOOLKIT_SCROLL_BARS
6136 /* Dispatch event to the widget. */
6137 goto OTHER;
6138 #else /* not USE_TOOLKIT_SCROLL_BARS */
6139 bar = x_window_to_scroll_bar (event.xexpose.display,
6140 event.xexpose.window);
6142 if (bar)
6143 x_scroll_bar_expose (bar, &event);
6144 #ifdef USE_X_TOOLKIT
6145 else
6146 goto OTHER;
6147 #endif /* USE_X_TOOLKIT */
6148 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6150 break;
6152 case GraphicsExpose: /* This occurs when an XCopyArea's
6153 source area was obscured or not
6154 available. */
6155 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6156 if (f)
6158 expose_frame (f,
6159 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6160 event.xgraphicsexpose.width,
6161 event.xgraphicsexpose.height);
6163 #ifdef USE_X_TOOLKIT
6164 else
6165 goto OTHER;
6166 #endif /* USE_X_TOOLKIT */
6167 break;
6169 case NoExpose: /* This occurs when an XCopyArea's
6170 source area was completely
6171 available. */
6172 break;
6174 case UnmapNotify:
6175 /* Redo the mouse-highlight after the tooltip has gone. */
6176 if (event.xmap.window == tip_window)
6178 tip_window = 0;
6179 redo_mouse_highlight ();
6182 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6183 if (f) /* F may no longer exist if
6184 the frame was deleted. */
6186 /* While a frame is unmapped, display generation is
6187 disabled; you don't want to spend time updating a
6188 display that won't ever be seen. */
6189 f->async_visible = 0;
6190 /* We can't distinguish, from the event, whether the window
6191 has become iconified or invisible. So assume, if it
6192 was previously visible, than now it is iconified.
6193 But x_make_frame_invisible clears both
6194 the visible flag and the iconified flag;
6195 and that way, we know the window is not iconified now. */
6196 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6198 f->async_iconified = 1;
6200 inev.ie.kind = ICONIFY_EVENT;
6201 XSETFRAME (inev.ie.frame_or_window, f);
6204 goto OTHER;
6206 case MapNotify:
6207 if (event.xmap.window == tip_window)
6208 /* The tooltip has been drawn already. Avoid
6209 the SET_FRAME_GARBAGED below. */
6210 goto OTHER;
6212 /* We use x_top_window_to_frame because map events can
6213 come for sub-windows and they don't mean that the
6214 frame is visible. */
6215 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6216 if (f)
6218 /* wait_reading_process_output will notice this and update
6219 the frame's display structures.
6220 If we where iconified, we should not set garbaged,
6221 because that stops redrawing on Expose events. This looks
6222 bad if we are called from a recursive event loop
6223 (x_dispatch_event), for example when a dialog is up. */
6224 if (! f->async_iconified)
6225 SET_FRAME_GARBAGED (f);
6227 /* Check if fullscreen was specified before we where mapped the
6228 first time, i.e. from the command line. */
6229 if (!f->output_data.x->has_been_visible)
6230 x_check_fullscreen (f);
6232 f->async_visible = 1;
6233 f->async_iconified = 0;
6234 f->output_data.x->has_been_visible = 1;
6236 if (f->iconified)
6238 inev.ie.kind = DEICONIFY_EVENT;
6239 XSETFRAME (inev.ie.frame_or_window, f);
6241 else if (! NILP (Vframe_list)
6242 && ! NILP (XCDR (Vframe_list)))
6243 /* Force a redisplay sooner or later
6244 to update the frame titles
6245 in case this is the second frame. */
6246 record_asynch_buffer_change ();
6248 #ifdef USE_GTK
6249 xg_frame_resized (f, -1, -1);
6250 #endif
6252 goto OTHER;
6254 case KeyPress:
6256 last_user_time = event.xkey.time;
6257 ignore_next_mouse_click_timeout = 0;
6259 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6260 /* Dispatch KeyPress events when in menu. */
6261 if (popup_activated ())
6262 goto OTHER;
6263 #endif
6265 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6267 /* If mouse-highlight is an integer, input clears out
6268 mouse highlighting. */
6269 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6270 && (f == 0
6271 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6273 clear_mouse_face (hlinfo);
6274 hlinfo->mouse_face_hidden = 1;
6277 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6278 if (f == 0)
6280 /* Scroll bars consume key events, but we want
6281 the keys to go to the scroll bar's frame. */
6282 Widget widget = XtWindowToWidget (dpyinfo->display,
6283 event.xkey.window);
6284 if (widget && XmIsScrollBar (widget))
6286 widget = XtParent (widget);
6287 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6290 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6292 if (f != 0)
6294 KeySym keysym, orig_keysym;
6295 /* al%imercury@uunet.uu.net says that making this 81
6296 instead of 80 fixed a bug whereby meta chars made
6297 his Emacs hang.
6299 It seems that some version of XmbLookupString has
6300 a bug of not returning XBufferOverflow in
6301 status_return even if the input is too long to
6302 fit in 81 bytes. So, we must prepare sufficient
6303 bytes for copy_buffer. 513 bytes (256 chars for
6304 two-byte character set) seems to be a fairly good
6305 approximation. -- 2000.8.10 handa@etl.go.jp */
6306 unsigned char copy_buffer[513];
6307 unsigned char *copy_bufptr = copy_buffer;
6308 int copy_bufsiz = sizeof (copy_buffer);
6309 int modifiers;
6310 Lisp_Object coding_system = Qlatin_1;
6311 Lisp_Object c;
6313 #ifdef USE_GTK
6314 /* Don't pass keys to GTK. A Tab will shift focus to the
6315 tool bar in GTK 2.4. Keys will still go to menus and
6316 dialogs because in that case popup_activated is TRUE
6317 (see above). */
6318 *finish = X_EVENT_DROP;
6319 #endif
6321 event.xkey.state
6322 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6323 extra_keyboard_modifiers);
6324 modifiers = event.xkey.state;
6326 /* This will have to go some day... */
6328 /* make_lispy_event turns chars into control chars.
6329 Don't do it here because XLookupString is too eager. */
6330 event.xkey.state &= ~ControlMask;
6331 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6332 | dpyinfo->super_mod_mask
6333 | dpyinfo->hyper_mod_mask
6334 | dpyinfo->alt_mod_mask);
6336 /* In case Meta is ComposeCharacter,
6337 clear its status. According to Markus Ehrnsperger
6338 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6339 this enables ComposeCharacter to work whether or
6340 not it is combined with Meta. */
6341 if (modifiers & dpyinfo->meta_mod_mask)
6342 memset (&compose_status, 0, sizeof (compose_status));
6344 #ifdef HAVE_X_I18N
6345 if (FRAME_XIC (f))
6347 Status status_return;
6349 coding_system = Vlocale_coding_system;
6350 nbytes = XmbLookupString (FRAME_XIC (f),
6351 &event.xkey, (char *) copy_bufptr,
6352 copy_bufsiz, &keysym,
6353 &status_return);
6354 if (status_return == XBufferOverflow)
6356 copy_bufsiz = nbytes + 1;
6357 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6358 nbytes = XmbLookupString (FRAME_XIC (f),
6359 &event.xkey, (char *) copy_bufptr,
6360 copy_bufsiz, &keysym,
6361 &status_return);
6363 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6364 if (status_return == XLookupNone)
6365 break;
6366 else if (status_return == XLookupChars)
6368 keysym = NoSymbol;
6369 modifiers = 0;
6371 else if (status_return != XLookupKeySym
6372 && status_return != XLookupBoth)
6373 abort ();
6375 else
6376 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6377 copy_bufsiz, &keysym,
6378 &compose_status);
6379 #else
6380 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6381 copy_bufsiz, &keysym,
6382 &compose_status);
6383 #endif
6385 /* If not using XIM/XIC, and a compose sequence is in progress,
6386 we break here. Otherwise, chars_matched is always 0. */
6387 if (compose_status.chars_matched > 0 && nbytes == 0)
6388 break;
6390 memset (&compose_status, 0, sizeof (compose_status));
6391 orig_keysym = keysym;
6393 /* Common for all keysym input events. */
6394 XSETFRAME (inev.ie.frame_or_window, f);
6395 inev.ie.modifiers
6396 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6397 inev.ie.timestamp = event.xkey.time;
6399 /* First deal with keysyms which have defined
6400 translations to characters. */
6401 if (keysym >= 32 && keysym < 128)
6402 /* Avoid explicitly decoding each ASCII character. */
6404 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6405 inev.ie.code = keysym;
6406 goto done_keysym;
6409 /* Keysyms directly mapped to Unicode characters. */
6410 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6412 if (keysym < 0x01000080)
6413 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6414 else
6415 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6416 inev.ie.code = keysym & 0xFFFFFF;
6417 goto done_keysym;
6420 /* Now non-ASCII. */
6421 if (HASH_TABLE_P (Vx_keysym_table)
6422 && (NATNUMP (c = Fgethash (make_number (keysym),
6423 Vx_keysym_table,
6424 Qnil))))
6426 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6427 ? ASCII_KEYSTROKE_EVENT
6428 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6429 inev.ie.code = XFASTINT (c);
6430 goto done_keysym;
6433 /* Random non-modifier sorts of keysyms. */
6434 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6435 || keysym == XK_Delete
6436 #ifdef XK_ISO_Left_Tab
6437 || (keysym >= XK_ISO_Left_Tab
6438 && keysym <= XK_ISO_Enter)
6439 #endif
6440 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6441 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6442 #ifdef HPUX
6443 /* This recognizes the "extended function
6444 keys". It seems there's no cleaner way.
6445 Test IsModifierKey to avoid handling
6446 mode_switch incorrectly. */
6447 || (XK_Select <= keysym && keysym < XK_KP_Space)
6448 #endif
6449 #ifdef XK_dead_circumflex
6450 || orig_keysym == XK_dead_circumflex
6451 #endif
6452 #ifdef XK_dead_grave
6453 || orig_keysym == XK_dead_grave
6454 #endif
6455 #ifdef XK_dead_tilde
6456 || orig_keysym == XK_dead_tilde
6457 #endif
6458 #ifdef XK_dead_diaeresis
6459 || orig_keysym == XK_dead_diaeresis
6460 #endif
6461 #ifdef XK_dead_macron
6462 || orig_keysym == XK_dead_macron
6463 #endif
6464 #ifdef XK_dead_degree
6465 || orig_keysym == XK_dead_degree
6466 #endif
6467 #ifdef XK_dead_acute
6468 || orig_keysym == XK_dead_acute
6469 #endif
6470 #ifdef XK_dead_cedilla
6471 || orig_keysym == XK_dead_cedilla
6472 #endif
6473 #ifdef XK_dead_breve
6474 || orig_keysym == XK_dead_breve
6475 #endif
6476 #ifdef XK_dead_ogonek
6477 || orig_keysym == XK_dead_ogonek
6478 #endif
6479 #ifdef XK_dead_caron
6480 || orig_keysym == XK_dead_caron
6481 #endif
6482 #ifdef XK_dead_doubleacute
6483 || orig_keysym == XK_dead_doubleacute
6484 #endif
6485 #ifdef XK_dead_abovedot
6486 || orig_keysym == XK_dead_abovedot
6487 #endif
6488 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6489 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6490 /* Any "vendor-specific" key is ok. */
6491 || (orig_keysym & (1 << 28))
6492 || (keysym != NoSymbol && nbytes == 0))
6493 && ! (IsModifierKey (orig_keysym)
6494 /* The symbols from XK_ISO_Lock
6495 to XK_ISO_Last_Group_Lock
6496 don't have real modifiers but
6497 should be treated similarly to
6498 Mode_switch by Emacs. */
6499 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6500 || (XK_ISO_Lock <= orig_keysym
6501 && orig_keysym <= XK_ISO_Last_Group_Lock)
6502 #endif
6505 STORE_KEYSYM_FOR_DEBUG (keysym);
6506 /* make_lispy_event will convert this to a symbolic
6507 key. */
6508 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6509 inev.ie.code = keysym;
6510 goto done_keysym;
6513 { /* Raw bytes, not keysym. */
6514 register int i;
6515 int nchars, len;
6517 for (i = 0, nchars = 0; i < nbytes; i++)
6519 if (ASCII_BYTE_P (copy_bufptr[i]))
6520 nchars++;
6521 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6524 if (nchars < nbytes)
6526 /* Decode the input data. */
6527 int require;
6529 /* The input should be decoded with `coding_system'
6530 which depends on which X*LookupString function
6531 we used just above and the locale. */
6532 setup_coding_system (coding_system, &coding);
6533 coding.src_multibyte = 0;
6534 coding.dst_multibyte = 1;
6535 /* The input is converted to events, thus we can't
6536 handle composition. Anyway, there's no XIM that
6537 gives us composition information. */
6538 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6540 require = MAX_MULTIBYTE_LENGTH * nbytes;
6541 coding.destination = alloca (require);
6542 coding.dst_bytes = require;
6543 coding.mode |= CODING_MODE_LAST_BLOCK;
6544 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6545 nbytes = coding.produced;
6546 nchars = coding.produced_char;
6547 copy_bufptr = coding.destination;
6550 /* Convert the input data to a sequence of
6551 character events. */
6552 for (i = 0; i < nbytes; i += len)
6554 int ch;
6555 if (nchars == nbytes)
6556 ch = copy_bufptr[i], len = 1;
6557 else
6558 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6559 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
6560 ? ASCII_KEYSTROKE_EVENT
6561 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6562 inev.ie.code = ch;
6563 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6566 count += nchars;
6568 inev.ie.kind = NO_EVENT; /* Already stored above. */
6570 if (keysym == NoSymbol)
6571 break;
6574 done_keysym:
6575 #ifdef HAVE_X_I18N
6576 /* Don't dispatch this event since XtDispatchEvent calls
6577 XFilterEvent, and two calls in a row may freeze the
6578 client. */
6579 break;
6580 #else
6581 goto OTHER;
6582 #endif
6584 case KeyRelease:
6585 last_user_time = event.xkey.time;
6586 #ifdef HAVE_X_I18N
6587 /* Don't dispatch this event since XtDispatchEvent calls
6588 XFilterEvent, and two calls in a row may freeze the
6589 client. */
6590 break;
6591 #else
6592 goto OTHER;
6593 #endif
6595 case EnterNotify:
6596 last_user_time = event.xcrossing.time;
6597 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6599 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6601 if (f && x_mouse_click_focus_ignore_position)
6602 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6604 /* EnterNotify counts as mouse movement,
6605 so update things that depend on mouse position. */
6606 if (f && !f->output_data.x->hourglass_p)
6607 note_mouse_movement (f, &event.xmotion);
6608 #ifdef USE_GTK
6609 /* We may get an EnterNotify on the buttons in the toolbar. In that
6610 case we moved out of any highlighted area and need to note this. */
6611 if (!f && last_mouse_glyph_frame)
6612 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6613 #endif
6614 goto OTHER;
6616 case FocusIn:
6617 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6618 goto OTHER;
6620 case LeaveNotify:
6621 last_user_time = event.xcrossing.time;
6622 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6624 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6625 if (f)
6627 if (f == hlinfo->mouse_face_mouse_frame)
6629 /* If we move outside the frame, then we're
6630 certainly no longer on any text in the frame. */
6631 clear_mouse_face (hlinfo);
6632 hlinfo->mouse_face_mouse_frame = 0;
6635 /* Generate a nil HELP_EVENT to cancel a help-echo.
6636 Do it only if there's something to cancel.
6637 Otherwise, the startup message is cleared when
6638 the mouse leaves the frame. */
6639 if (any_help_event_p)
6640 do_help = -1;
6642 #ifdef USE_GTK
6643 /* See comment in EnterNotify above */
6644 else if (last_mouse_glyph_frame)
6645 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6646 #endif
6647 goto OTHER;
6649 case FocusOut:
6650 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6651 goto OTHER;
6653 case MotionNotify:
6655 last_user_time = event.xmotion.time;
6656 previous_help_echo_string = help_echo_string;
6657 help_echo_string = Qnil;
6659 if (dpyinfo->grabbed && last_mouse_frame
6660 && FRAME_LIVE_P (last_mouse_frame))
6661 f = last_mouse_frame;
6662 else
6663 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6665 if (hlinfo->mouse_face_hidden)
6667 hlinfo->mouse_face_hidden = 0;
6668 clear_mouse_face (hlinfo);
6671 #ifdef USE_GTK
6672 if (f && xg_event_is_for_scrollbar (f, &event))
6673 f = 0;
6674 #endif
6675 if (f)
6678 /* Generate SELECT_WINDOW_EVENTs when needed.
6679 Don't let popup menus influence things (bug#1261). */
6680 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6682 Lisp_Object window;
6684 window = window_from_coordinates (f,
6685 event.xmotion.x, event.xmotion.y,
6686 0, 0);
6688 /* Window will be selected only when it is not selected now and
6689 last mouse movement event was not in it. Minibuffer window
6690 will be selected only when it is active. */
6691 if (WINDOWP (window)
6692 && !EQ (window, last_window)
6693 && !EQ (window, selected_window)
6694 /* For click-to-focus window managers
6695 create event iff we don't leave the
6696 selected frame. */
6697 && (focus_follows_mouse
6698 || (EQ (XWINDOW (window)->frame,
6699 XWINDOW (selected_window)->frame))))
6701 inev.ie.kind = SELECT_WINDOW_EVENT;
6702 inev.ie.frame_or_window = window;
6705 last_window=window;
6707 if (!note_mouse_movement (f, &event.xmotion))
6708 help_echo_string = previous_help_echo_string;
6710 else
6712 #ifndef USE_TOOLKIT_SCROLL_BARS
6713 struct scroll_bar *bar
6714 = x_window_to_scroll_bar (event.xmotion.display,
6715 event.xmotion.window);
6717 if (bar)
6718 x_scroll_bar_note_movement (bar, &event);
6719 #endif /* USE_TOOLKIT_SCROLL_BARS */
6721 /* If we move outside the frame, then we're
6722 certainly no longer on any text in the frame. */
6723 clear_mouse_face (hlinfo);
6726 /* If the contents of the global variable help_echo_string
6727 has changed, generate a HELP_EVENT. */
6728 if (!NILP (help_echo_string)
6729 || !NILP (previous_help_echo_string))
6730 do_help = 1;
6731 goto OTHER;
6734 case ConfigureNotify:
6735 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6736 #ifdef USE_GTK
6737 if (!f
6738 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6739 && event.xconfigure.window == FRAME_X_WINDOW (f))
6741 xg_frame_resized (f, event.xconfigure.width,
6742 event.xconfigure.height);
6743 f = 0;
6745 #endif
6746 if (f)
6748 #ifndef USE_X_TOOLKIT
6749 #ifndef USE_GTK
6750 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6751 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6753 /* In the toolkit version, change_frame_size
6754 is called by the code that handles resizing
6755 of the EmacsFrame widget. */
6757 /* Even if the number of character rows and columns has
6758 not changed, the font size may have changed, so we need
6759 to check the pixel dimensions as well. */
6760 if (columns != FRAME_COLS (f)
6761 || rows != FRAME_LINES (f)
6762 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6763 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6765 change_frame_size (f, rows, columns, 0, 1, 0);
6766 SET_FRAME_GARBAGED (f);
6767 cancel_mouse_face (f);
6770 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6771 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6772 #endif /* not USE_GTK */
6773 #endif
6775 #ifdef USE_GTK
6776 /* GTK creates windows but doesn't map them.
6777 Only get real positions when mapped. */
6778 if (FRAME_GTK_OUTER_WIDGET (f)
6779 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6780 #endif
6782 x_real_positions (f, &f->left_pos, &f->top_pos);
6785 #ifdef HAVE_X_I18N
6786 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6787 xic_set_statusarea (f);
6788 #endif
6791 goto OTHER;
6793 case ButtonRelease:
6794 case ButtonPress:
6796 /* If we decide we want to generate an event to be seen
6797 by the rest of Emacs, we put it here. */
6798 int tool_bar_p = 0;
6800 memset (&compose_status, 0, sizeof (compose_status));
6801 last_mouse_glyph_frame = 0;
6802 last_user_time = event.xbutton.time;
6804 if (dpyinfo->grabbed
6805 && last_mouse_frame
6806 && FRAME_LIVE_P (last_mouse_frame))
6807 f = last_mouse_frame;
6808 else
6809 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6811 #ifdef USE_GTK
6812 if (f && xg_event_is_for_scrollbar (f, &event))
6813 f = 0;
6814 #endif
6815 if (f)
6817 /* Is this in the tool-bar? */
6818 if (WINDOWP (f->tool_bar_window)
6819 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6821 Lisp_Object window;
6822 int x = event.xbutton.x;
6823 int y = event.xbutton.y;
6825 window = window_from_coordinates (f, x, y, 0, 1);
6826 tool_bar_p = EQ (window, f->tool_bar_window);
6828 if (tool_bar_p && event.xbutton.button < 4)
6830 handle_tool_bar_click (f, x, y,
6831 event.xbutton.type == ButtonPress,
6832 x_x_to_emacs_modifiers (dpyinfo,
6833 event.xbutton.state));
6837 if (!tool_bar_p)
6838 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6839 if (! popup_activated ())
6840 #endif
6842 if (ignore_next_mouse_click_timeout)
6844 if (event.type == ButtonPress
6845 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6847 ignore_next_mouse_click_timeout = 0;
6848 construct_mouse_click (&inev.ie, &event.xbutton, f);
6850 if (event.type == ButtonRelease)
6851 ignore_next_mouse_click_timeout = 0;
6853 else
6854 construct_mouse_click (&inev.ie, &event.xbutton, f);
6856 if (FRAME_X_EMBEDDED_P (f))
6857 xembed_send_message (f, event.xbutton.time,
6858 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6860 else
6862 struct scroll_bar *bar
6863 = x_window_to_scroll_bar (event.xbutton.display,
6864 event.xbutton.window);
6866 #ifdef USE_TOOLKIT_SCROLL_BARS
6867 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6868 scroll bars. */
6869 if (bar && event.xbutton.state & ControlMask)
6871 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6872 *finish = X_EVENT_DROP;
6874 #else /* not USE_TOOLKIT_SCROLL_BARS */
6875 if (bar)
6876 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6877 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6880 if (event.type == ButtonPress)
6882 dpyinfo->grabbed |= (1 << event.xbutton.button);
6883 last_mouse_frame = f;
6885 if (!tool_bar_p)
6886 last_tool_bar_item = -1;
6888 else
6889 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6891 /* Ignore any mouse motion that happened before this event;
6892 any subsequent mouse-movement Emacs events should reflect
6893 only motion after the ButtonPress/Release. */
6894 if (f != 0)
6895 f->mouse_moved = 0;
6897 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6898 f = x_menubar_window_to_frame (dpyinfo, &event);
6899 /* For a down-event in the menu bar,
6900 don't pass it to Xt right now.
6901 Instead, save it away
6902 and we will pass it to Xt from kbd_buffer_get_event.
6903 That way, we can run some Lisp code first. */
6904 if (! popup_activated ()
6905 #ifdef USE_GTK
6906 /* Gtk+ menus only react to the first three buttons. */
6907 && event.xbutton.button < 3
6908 #endif
6909 && f && event.type == ButtonPress
6910 /* Verify the event is really within the menu bar
6911 and not just sent to it due to grabbing. */
6912 && event.xbutton.x >= 0
6913 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6914 && event.xbutton.y >= 0
6915 && event.xbutton.y < f->output_data.x->menubar_height
6916 && event.xbutton.same_screen)
6918 SET_SAVED_BUTTON_EVENT;
6919 XSETFRAME (last_mouse_press_frame, f);
6920 *finish = X_EVENT_DROP;
6922 else if (event.type == ButtonPress)
6924 last_mouse_press_frame = Qnil;
6925 goto OTHER;
6927 else
6928 goto OTHER;
6929 #endif /* USE_X_TOOLKIT || USE_GTK */
6931 break;
6933 case CirculateNotify:
6934 goto OTHER;
6936 case CirculateRequest:
6937 goto OTHER;
6939 case VisibilityNotify:
6940 goto OTHER;
6942 case MappingNotify:
6943 /* Someone has changed the keyboard mapping - update the
6944 local cache. */
6945 switch (event.xmapping.request)
6947 case MappingModifier:
6948 x_find_modifier_meanings (dpyinfo);
6949 /* This is meant to fall through. */
6950 case MappingKeyboard:
6951 XRefreshKeyboardMapping (&event.xmapping);
6953 goto OTHER;
6955 case DestroyNotify:
6956 xft_settings_event (dpyinfo, &event);
6957 break;
6959 default:
6960 OTHER:
6961 #ifdef USE_X_TOOLKIT
6962 BLOCK_INPUT;
6963 if (*finish != X_EVENT_DROP)
6964 XtDispatchEvent (&event);
6965 UNBLOCK_INPUT;
6966 #endif /* USE_X_TOOLKIT */
6967 break;
6970 done:
6971 if (inev.ie.kind != NO_EVENT)
6973 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6974 count++;
6977 if (do_help
6978 && !(hold_quit && hold_quit->kind != NO_EVENT))
6980 Lisp_Object frame;
6982 if (f)
6983 XSETFRAME (frame, f);
6984 else
6985 frame = Qnil;
6987 if (do_help > 0)
6989 any_help_event_p = 1;
6990 gen_help_event (help_echo_string, frame, help_echo_window,
6991 help_echo_object, help_echo_pos);
6993 else
6995 help_echo_string = Qnil;
6996 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6998 count++;
7001 *eventptr = event;
7002 return count;
7005 #if defined USE_GTK || defined USE_X_TOOLKIT
7007 /* Handles the XEvent EVENT on display DISPLAY.
7008 This is used for event loops outside the normal event handling,
7009 i.e. looping while a popup menu or a dialog is posted.
7011 Returns the value handle_one_xevent sets in the finish argument. */
7013 x_dispatch_event (XEvent *event, Display *display)
7015 struct x_display_info *dpyinfo;
7016 int finish = X_EVENT_NORMAL;
7018 dpyinfo = x_display_info_for_display (display);
7020 if (dpyinfo)
7021 handle_one_xevent (dpyinfo, event, &finish, 0);
7023 return finish;
7025 #endif
7028 /* Read events coming from the X server.
7029 This routine is called by the SIGIO handler.
7030 We return as soon as there are no more events to be read.
7032 We return the number of characters stored into the buffer,
7033 thus pretending to be `read' (except the characters we store
7034 in the keyboard buffer can be multibyte, so are not necessarily
7035 C chars).
7037 EXPECTED is nonzero if the caller knows input is available. */
7039 static int
7040 XTread_socket (struct terminal *terminal, int expected, struct input_event *hold_quit)
7042 int count = 0;
7043 int event_found = 0;
7045 if (interrupt_input_blocked)
7047 interrupt_input_pending = 1;
7048 #ifdef SYNC_INPUT
7049 pending_signals = 1;
7050 #endif
7051 return -1;
7054 interrupt_input_pending = 0;
7055 #ifdef SYNC_INPUT
7056 pending_signals = pending_atimers;
7057 #endif
7058 BLOCK_INPUT;
7060 /* So people can tell when we have read the available input. */
7061 input_signal_count++;
7063 ++handling_signal;
7065 /* For debugging, this gives a way to fake an I/O error. */
7066 if (terminal->display_info.x == XTread_socket_fake_io_error)
7068 XTread_socket_fake_io_error = 0;
7069 x_io_error_quitter (terminal->display_info.x->display);
7072 #ifndef USE_GTK
7073 while (XPending (terminal->display_info.x->display))
7075 int finish;
7076 XEvent event;
7078 XNextEvent (terminal->display_info.x->display, &event);
7080 #ifdef HAVE_X_I18N
7081 /* Filter events for the current X input method. */
7082 if (x_filter_event (terminal->display_info.x, &event))
7083 continue;
7084 #endif
7085 event_found = 1;
7087 count += handle_one_xevent (terminal->display_info.x,
7088 &event, &finish, hold_quit);
7090 if (finish == X_EVENT_GOTO_OUT)
7091 goto out;
7094 out:;
7096 #else /* USE_GTK */
7098 /* For GTK we must use the GTK event loop. But XEvents gets passed
7099 to our filter function above, and then to the big event switch.
7100 We use a bunch of globals to communicate with our filter function,
7101 that is kind of ugly, but it works.
7103 There is no way to do one display at the time, GTK just does events
7104 from all displays. */
7106 while (gtk_events_pending ())
7108 current_count = count;
7109 current_hold_quit = hold_quit;
7111 gtk_main_iteration ();
7113 count = current_count;
7114 current_count = -1;
7115 current_hold_quit = 0;
7117 if (current_finish == X_EVENT_GOTO_OUT)
7118 break;
7120 #endif /* USE_GTK */
7122 /* On some systems, an X bug causes Emacs to get no more events
7123 when the window is destroyed. Detect that. (1994.) */
7124 if (! event_found)
7126 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7127 One XNOOP in 100 loops will make Emacs terminate.
7128 B. Bretthauer, 1994 */
7129 x_noop_count++;
7130 if (x_noop_count >= 100)
7132 x_noop_count=0;
7134 if (next_noop_dpyinfo == 0)
7135 next_noop_dpyinfo = x_display_list;
7137 XNoOp (next_noop_dpyinfo->display);
7139 /* Each time we get here, cycle through the displays now open. */
7140 next_noop_dpyinfo = next_noop_dpyinfo->next;
7144 /* If the focus was just given to an auto-raising frame,
7145 raise it now. */
7146 /* ??? This ought to be able to handle more than one such frame. */
7147 if (pending_autoraise_frame)
7149 x_raise_frame (pending_autoraise_frame);
7150 pending_autoraise_frame = 0;
7153 --handling_signal;
7154 UNBLOCK_INPUT;
7156 return count;
7162 /***********************************************************************
7163 Text Cursor
7164 ***********************************************************************/
7166 /* Set clipping for output in glyph row ROW. W is the window in which
7167 we operate. GC is the graphics context to set clipping in.
7169 ROW may be a text row or, e.g., a mode line. Text rows must be
7170 clipped to the interior of the window dedicated to text display,
7171 mode lines must be clipped to the whole window. */
7173 static void
7174 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7176 struct frame *f = XFRAME (WINDOW_FRAME (w));
7177 XRectangle clip_rect;
7178 int window_x, window_y, window_width;
7180 window_box (w, area, &window_x, &window_y, &window_width, 0);
7182 clip_rect.x = window_x;
7183 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7184 clip_rect.y = max (clip_rect.y, window_y);
7185 clip_rect.width = window_width;
7186 clip_rect.height = row->visible_height;
7188 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7192 /* Draw a hollow box cursor on window W in glyph row ROW. */
7194 static void
7195 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7197 struct frame *f = XFRAME (WINDOW_FRAME (w));
7198 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7199 Display *dpy = FRAME_X_DISPLAY (f);
7200 int x, y, wd, h;
7201 XGCValues xgcv;
7202 struct glyph *cursor_glyph;
7203 GC gc;
7205 /* Get the glyph the cursor is on. If we can't tell because
7206 the current matrix is invalid or such, give up. */
7207 cursor_glyph = get_phys_cursor_glyph (w);
7208 if (cursor_glyph == NULL)
7209 return;
7211 /* Compute frame-relative coordinates for phys cursor. */
7212 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7213 wd = w->phys_cursor_width;
7215 /* The foreground of cursor_gc is typically the same as the normal
7216 background color, which can cause the cursor box to be invisible. */
7217 xgcv.foreground = f->output_data.x->cursor_pixel;
7218 if (dpyinfo->scratch_cursor_gc)
7219 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7220 else
7221 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7222 GCForeground, &xgcv);
7223 gc = dpyinfo->scratch_cursor_gc;
7225 /* Set clipping, draw the rectangle, and reset clipping again. */
7226 x_clip_to_row (w, row, TEXT_AREA, gc);
7227 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7228 XSetClipMask (dpy, gc, None);
7232 /* Draw a bar cursor on window W in glyph row ROW.
7234 Implementation note: One would like to draw a bar cursor with an
7235 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7236 Unfortunately, I didn't find a font yet that has this property set.
7237 --gerd. */
7239 static void
7240 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7242 struct frame *f = XFRAME (w->frame);
7243 struct glyph *cursor_glyph;
7245 /* If cursor is out of bounds, don't draw garbage. This can happen
7246 in mini-buffer windows when switching between echo area glyphs
7247 and mini-buffer. */
7248 cursor_glyph = get_phys_cursor_glyph (w);
7249 if (cursor_glyph == NULL)
7250 return;
7252 /* If on an image, draw like a normal cursor. That's usually better
7253 visible than drawing a bar, esp. if the image is large so that
7254 the bar might not be in the window. */
7255 if (cursor_glyph->type == IMAGE_GLYPH)
7257 struct glyph_row *r;
7258 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7259 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
7261 else
7263 Display *dpy = FRAME_X_DISPLAY (f);
7264 Window window = FRAME_X_WINDOW (f);
7265 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7266 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7267 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7268 XGCValues xgcv;
7270 /* If the glyph's background equals the color we normally draw
7271 the bars cursor in, the bar cursor in its normal color is
7272 invisible. Use the glyph's foreground color instead in this
7273 case, on the assumption that the glyph's colors are chosen so
7274 that the glyph is legible. */
7275 if (face->background == f->output_data.x->cursor_pixel)
7276 xgcv.background = xgcv.foreground = face->foreground;
7277 else
7278 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7279 xgcv.graphics_exposures = 0;
7281 if (gc)
7282 XChangeGC (dpy, gc, mask, &xgcv);
7283 else
7285 gc = XCreateGC (dpy, window, mask, &xgcv);
7286 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7289 x_clip_to_row (w, row, TEXT_AREA, gc);
7291 if (kind == BAR_CURSOR)
7293 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7295 if (width < 0)
7296 width = FRAME_CURSOR_WIDTH (f);
7297 width = min (cursor_glyph->pixel_width, width);
7299 w->phys_cursor_width = width;
7301 /* If the character under cursor is R2L, draw the bar cursor
7302 on the right of its glyph, rather than on the left. */
7303 if ((cursor_glyph->resolved_level & 1) != 0)
7304 x += cursor_glyph->pixel_width - width;
7306 XFillRectangle (dpy, window, gc, x,
7307 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7308 width, row->height);
7310 else
7312 int dummy_x, dummy_y, dummy_h;
7314 if (width < 0)
7315 width = row->height;
7317 width = min (row->height, width);
7319 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7320 &dummy_y, &dummy_h);
7322 XFillRectangle (dpy, window, gc,
7323 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7324 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7325 row->height - width),
7326 w->phys_cursor_width, width);
7329 XSetClipMask (dpy, gc, None);
7334 /* RIF: Define cursor CURSOR on frame F. */
7336 static void
7337 x_define_frame_cursor (struct frame *f, Cursor cursor)
7339 if (!f->pointer_invisible
7340 && f->output_data.x->current_cursor != cursor)
7341 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7342 f->output_data.x->current_cursor = cursor;
7346 /* RIF: Clear area on frame F. */
7348 static void
7349 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7351 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7352 x, y, width, height, False);
7353 #ifdef USE_GTK
7354 /* Must queue a redraw, because scroll bars might have been cleared. */
7355 if (FRAME_GTK_WIDGET (f))
7356 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7357 #endif
7361 /* RIF: Draw cursor on window W. */
7363 static void
7364 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)
7366 struct frame *f = XFRAME (WINDOW_FRAME (w));
7368 if (on_p)
7370 w->phys_cursor_type = cursor_type;
7371 w->phys_cursor_on_p = 1;
7373 if (glyph_row->exact_window_width_line_p
7374 && (glyph_row->reversed_p
7375 ? (w->phys_cursor.hpos < 0)
7376 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7378 glyph_row->cursor_in_fringe_p = 1;
7379 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7381 else
7383 switch (cursor_type)
7385 case HOLLOW_BOX_CURSOR:
7386 x_draw_hollow_cursor (w, glyph_row);
7387 break;
7389 case FILLED_BOX_CURSOR:
7390 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7391 break;
7393 case BAR_CURSOR:
7394 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7395 break;
7397 case HBAR_CURSOR:
7398 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7399 break;
7401 case NO_CURSOR:
7402 w->phys_cursor_width = 0;
7403 break;
7405 default:
7406 abort ();
7410 #ifdef HAVE_X_I18N
7411 if (w == XWINDOW (f->selected_window))
7412 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7413 xic_set_preeditarea (w, x, y);
7414 #endif
7417 #ifndef XFlush
7418 XFlush (FRAME_X_DISPLAY (f));
7419 #endif
7423 /* Icons. */
7425 /* Make the x-window of frame F use the gnu icon bitmap. */
7428 x_bitmap_icon (struct frame *f, Lisp_Object file)
7430 int bitmap_id;
7432 if (FRAME_X_WINDOW (f) == 0)
7433 return 1;
7435 /* Free up our existing icon bitmap and mask if any. */
7436 if (f->output_data.x->icon_bitmap > 0)
7437 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7438 f->output_data.x->icon_bitmap = 0;
7440 if (STRINGP (file))
7442 #ifdef USE_GTK
7443 /* Use gtk_window_set_icon_from_file () if available,
7444 It's not restricted to bitmaps */
7445 if (xg_set_icon (f, file))
7446 return 0;
7447 #endif /* USE_GTK */
7448 bitmap_id = x_create_bitmap_from_file (f, file);
7449 x_create_bitmap_mask (f, bitmap_id);
7451 else
7453 /* Create the GNU bitmap and mask if necessary. */
7454 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7456 int rc = -1;
7458 #ifdef USE_GTK
7460 if (xg_set_icon (f, xg_default_icon_file)
7461 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7462 return 0;
7464 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7466 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7467 if (rc != -1)
7468 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7470 #endif
7472 /* If all else fails, use the (black and white) xbm image. */
7473 if (rc == -1)
7475 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
7476 gnu_xbm_width, gnu_xbm_height);
7477 if (rc == -1)
7478 return 1;
7480 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7481 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7485 /* The first time we create the GNU bitmap and mask,
7486 this increments the ref-count one extra time.
7487 As a result, the GNU bitmap and mask are never freed.
7488 That way, we don't have to worry about allocating it again. */
7489 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7491 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7494 x_wm_set_icon_pixmap (f, bitmap_id);
7495 f->output_data.x->icon_bitmap = bitmap_id;
7497 return 0;
7501 /* Make the x-window of frame F use a rectangle with text.
7502 Use ICON_NAME as the text. */
7505 x_text_icon (struct frame *f, const char *icon_name)
7507 if (FRAME_X_WINDOW (f) == 0)
7508 return 1;
7511 XTextProperty text;
7512 text.value = (unsigned char *) icon_name;
7513 text.encoding = XA_STRING;
7514 text.format = 8;
7515 text.nitems = strlen (icon_name);
7516 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7519 if (f->output_data.x->icon_bitmap > 0)
7520 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7521 f->output_data.x->icon_bitmap = 0;
7522 x_wm_set_icon_pixmap (f, 0);
7524 return 0;
7527 #define X_ERROR_MESSAGE_SIZE 200
7529 /* If non-nil, this should be a string.
7530 It means catch X errors and store the error message in this string.
7532 The reason we use a stack is that x_catch_error/x_uncatch_error can
7533 be called from a signal handler.
7536 struct x_error_message_stack {
7537 char string[X_ERROR_MESSAGE_SIZE];
7538 Display *dpy;
7539 struct x_error_message_stack *prev;
7541 static struct x_error_message_stack *x_error_message;
7543 /* An X error handler which stores the error message in
7544 *x_error_message. This is called from x_error_handler if
7545 x_catch_errors is in effect. */
7547 static void
7548 x_error_catcher (Display *display, XErrorEvent *event)
7550 XGetErrorText (display, event->error_code,
7551 x_error_message->string,
7552 X_ERROR_MESSAGE_SIZE);
7555 /* Begin trapping X errors for display DPY. Actually we trap X errors
7556 for all displays, but DPY should be the display you are actually
7557 operating on.
7559 After calling this function, X protocol errors no longer cause
7560 Emacs to exit; instead, they are recorded in the string
7561 stored in *x_error_message.
7563 Calling x_check_errors signals an Emacs error if an X error has
7564 occurred since the last call to x_catch_errors or x_check_errors.
7566 Calling x_uncatch_errors resumes the normal error handling. */
7568 void
7569 x_catch_errors (Display *dpy)
7571 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7573 /* Make sure any errors from previous requests have been dealt with. */
7574 XSync (dpy, False);
7576 data->dpy = dpy;
7577 data->string[0] = 0;
7578 data->prev = x_error_message;
7579 x_error_message = data;
7582 /* Undo the last x_catch_errors call.
7583 DPY should be the display that was passed to x_catch_errors. */
7585 void
7586 x_uncatch_errors (void)
7588 struct x_error_message_stack *tmp;
7590 BLOCK_INPUT;
7592 /* The display may have been closed before this function is called.
7593 Check if it is still open before calling XSync. */
7594 if (x_display_info_for_display (x_error_message->dpy) != 0)
7595 XSync (x_error_message->dpy, False);
7597 tmp = x_error_message;
7598 x_error_message = x_error_message->prev;
7599 xfree (tmp);
7600 UNBLOCK_INPUT;
7603 /* If any X protocol errors have arrived since the last call to
7604 x_catch_errors or x_check_errors, signal an Emacs error using
7605 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7607 void
7608 x_check_errors (Display *dpy, const char *format)
7610 /* Make sure to catch any errors incurred so far. */
7611 XSync (dpy, False);
7613 if (x_error_message->string[0])
7615 char string[X_ERROR_MESSAGE_SIZE];
7616 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7617 x_uncatch_errors ();
7618 error (format, string);
7622 /* Nonzero if we had any X protocol errors
7623 since we did x_catch_errors on DPY. */
7626 x_had_errors_p (Display *dpy)
7628 /* Make sure to catch any errors incurred so far. */
7629 XSync (dpy, False);
7631 return x_error_message->string[0] != 0;
7634 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7636 void
7637 x_clear_errors (Display *dpy)
7639 x_error_message->string[0] = 0;
7642 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7643 * idea. --lorentey */
7644 /* Close off all unclosed x_catch_errors calls. */
7646 void
7647 x_fully_uncatch_errors (void)
7649 while (x_error_message)
7650 x_uncatch_errors ();
7652 #endif
7654 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7657 x_catching_errors (void)
7659 return x_error_message != 0;
7662 #if 0
7663 static unsigned int x_wire_count;
7664 x_trace_wire (void)
7666 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7668 #endif /* ! 0 */
7671 /* Handle SIGPIPE, which can happen when the connection to a server
7672 simply goes away. SIGPIPE is handled by x_connection_signal.
7673 Don't need to do anything, because the write which caused the
7674 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7675 which will do the appropriate cleanup for us. */
7677 static void
7678 x_connection_signal (int signalnum) /* If we don't have an argument, */
7679 /* some compilers complain in signal calls. */
7681 #ifdef USG
7682 /* USG systems forget handlers when they are used;
7683 must reestablish each time */
7684 signal (signalnum, x_connection_signal);
7685 #endif /* USG */
7689 /************************************************************************
7690 Handling X errors
7691 ************************************************************************/
7693 /* Error message passed to x_connection_closed. */
7695 static char *error_msg;
7697 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7698 the text of an error message that lead to the connection loss. */
7700 static void
7701 x_connection_closed (Display *dpy, const char *error_message)
7703 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7704 Lisp_Object frame, tail;
7705 int idx = SPECPDL_INDEX ();
7707 error_msg = (char *) alloca (strlen (error_message) + 1);
7708 strcpy (error_msg, error_message);
7709 handling_signal = 0;
7711 /* Inhibit redisplay while frames are being deleted. */
7712 specbind (Qinhibit_redisplay, Qt);
7714 if (dpyinfo)
7716 /* Protect display from being closed when we delete the last
7717 frame on it. */
7718 dpyinfo->reference_count++;
7719 dpyinfo->terminal->reference_count++;
7722 /* First delete frames whose mini-buffers are on frames
7723 that are on the dead display. */
7724 FOR_EACH_FRAME (tail, frame)
7726 Lisp_Object minibuf_frame;
7727 minibuf_frame
7728 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7729 if (FRAME_X_P (XFRAME (frame))
7730 && FRAME_X_P (XFRAME (minibuf_frame))
7731 && ! EQ (frame, minibuf_frame)
7732 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7733 delete_frame (frame, Qnoelisp);
7736 /* Now delete all remaining frames on the dead display.
7737 We are now sure none of these is used as the mini-buffer
7738 for another frame that we need to delete. */
7739 FOR_EACH_FRAME (tail, frame)
7740 if (FRAME_X_P (XFRAME (frame))
7741 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7743 /* Set this to t so that delete_frame won't get confused
7744 trying to find a replacement. */
7745 KVAR (FRAME_KBOARD (XFRAME (frame)), Vdefault_minibuffer_frame) = Qt;
7746 delete_frame (frame, Qnoelisp);
7749 /* If DPYINFO is null, this means we didn't open the display in the
7750 first place, so don't try to close it. */
7751 if (dpyinfo)
7753 /* We can not call XtCloseDisplay here because it calls XSync.
7754 XSync inside the error handler apparently hangs Emacs. On
7755 current Xt versions, this isn't needed either. */
7756 #ifdef USE_GTK
7757 /* A long-standing GTK bug prevents proper disconnect handling
7758 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7759 the resulting Glib error message loop filled a user's disk.
7760 To avoid this, kill Emacs unconditionally on disconnect. */
7761 shut_down_emacs (0, 0, Qnil);
7762 fprintf (stderr, "%s\n\
7763 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7764 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7765 For details, see etc/PROBLEMS.\n",
7766 error_msg);
7767 abort ();
7768 #endif /* USE_GTK */
7770 /* Indicate that this display is dead. */
7771 dpyinfo->display = 0;
7773 dpyinfo->reference_count--;
7774 dpyinfo->terminal->reference_count--;
7775 if (dpyinfo->reference_count != 0)
7776 /* We have just closed all frames on this display. */
7777 abort ();
7780 Lisp_Object tmp;
7781 XSETTERMINAL (tmp, dpyinfo->terminal);
7782 Fdelete_terminal (tmp, Qnoelisp);
7786 if (terminal_list == 0)
7788 fprintf (stderr, "%s\n", error_msg);
7789 Fkill_emacs (make_number (70));
7790 /* NOTREACHED */
7793 /* Ordinary stack unwind doesn't deal with these. */
7794 #ifdef SIGIO
7795 sigunblock (sigmask (SIGIO));
7796 #endif
7797 sigunblock (sigmask (SIGALRM));
7798 TOTALLY_UNBLOCK_INPUT;
7800 unbind_to (idx, Qnil);
7801 clear_waiting_for_input ();
7803 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
7804 IF_LINT (if (! terminal_list) return; )
7806 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7807 longjmp), because returning from this function would get us back into
7808 Xlib's code which will directly call `exit'. */
7809 error ("%s", error_msg);
7812 /* We specifically use it before defining it, so that gcc doesn't inline it,
7813 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7814 static void x_error_quitter (Display *, XErrorEvent *);
7816 /* This is the first-level handler for X protocol errors.
7817 It calls x_error_quitter or x_error_catcher. */
7819 static int
7820 x_error_handler (Display *display, XErrorEvent *event)
7822 if (x_error_message)
7823 x_error_catcher (display, event);
7824 else
7825 x_error_quitter (display, event);
7826 return 0;
7829 /* This is the usual handler for X protocol errors.
7830 It kills all frames on the display that we got the error for.
7831 If that was the only one, it prints an error message and kills Emacs. */
7833 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7835 /* On older GCC versions, just putting x_error_quitter
7836 after x_error_handler prevents inlining into the former. */
7838 static void NO_INLINE
7839 x_error_quitter (Display *display, XErrorEvent *event)
7841 char buf[256], buf1[356];
7843 /* Ignore BadName errors. They can happen because of fonts
7844 or colors that are not defined. */
7846 if (event->error_code == BadName)
7847 return;
7849 /* Note that there is no real way portable across R3/R4 to get the
7850 original error handler. */
7852 XGetErrorText (display, event->error_code, buf, sizeof (buf));
7853 sprintf (buf1, "X protocol error: %s on protocol request %d",
7854 buf, event->request_code);
7855 x_connection_closed (display, buf1);
7859 /* This is the handler for X IO errors, always.
7860 It kills all frames on the display that we lost touch with.
7861 If that was the only one, it prints an error message and kills Emacs. */
7863 static int
7864 x_io_error_quitter (Display *display)
7866 char buf[256];
7868 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
7869 x_connection_closed (display, buf);
7870 return 0;
7873 /* Changing the font of the frame. */
7875 /* Give frame F the font FONT-OBJECT as its default font. The return
7876 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7877 frame. If it is negative, generate a new fontset from
7878 FONT-OBJECT. */
7880 Lisp_Object
7881 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7883 struct font *font = XFONT_OBJECT (font_object);
7885 if (fontset < 0)
7886 fontset = fontset_from_font (font_object);
7887 FRAME_FONTSET (f) = fontset;
7888 if (FRAME_FONT (f) == font)
7889 /* This font is already set in frame F. There's nothing more to
7890 do. */
7891 return font_object;
7893 FRAME_FONT (f) = font;
7894 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7895 FRAME_COLUMN_WIDTH (f) = font->average_width;
7896 FRAME_SPACE_WIDTH (f) = font->space_width;
7897 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7899 compute_fringe_widths (f, 1);
7901 /* Compute the scroll bar width in character columns. */
7902 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7904 int wid = FRAME_COLUMN_WIDTH (f);
7905 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7906 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7908 else
7910 int wid = FRAME_COLUMN_WIDTH (f);
7911 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7914 if (FRAME_X_WINDOW (f) != 0)
7916 /* Don't change the size of a tip frame; there's no point in
7917 doing it because it's done in Fx_show_tip, and it leads to
7918 problems because the tip frame has no widget. */
7919 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7920 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7923 #ifdef HAVE_X_I18N
7924 if (FRAME_XIC (f)
7925 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7927 BLOCK_INPUT;
7928 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7929 UNBLOCK_INPUT;
7931 #endif
7933 return font_object;
7937 /***********************************************************************
7938 X Input Methods
7939 ***********************************************************************/
7941 #ifdef HAVE_X_I18N
7943 #ifdef HAVE_X11R6
7945 /* XIM destroy callback function, which is called whenever the
7946 connection to input method XIM dies. CLIENT_DATA contains a
7947 pointer to the x_display_info structure corresponding to XIM. */
7949 static void
7950 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
7952 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7953 Lisp_Object frame, tail;
7955 BLOCK_INPUT;
7957 /* No need to call XDestroyIC.. */
7958 FOR_EACH_FRAME (tail, frame)
7960 struct frame *f = XFRAME (frame);
7961 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7963 FRAME_XIC (f) = NULL;
7964 xic_free_xfontset (f);
7968 /* No need to call XCloseIM. */
7969 dpyinfo->xim = NULL;
7970 XFree (dpyinfo->xim_styles);
7971 UNBLOCK_INPUT;
7974 #endif /* HAVE_X11R6 */
7976 #ifdef HAVE_X11R6
7977 /* This isn't prototyped in OSF 5.0 or 5.1a. */
7978 extern char *XSetIMValues (XIM, ...);
7979 #endif
7981 /* Open the connection to the XIM server on display DPYINFO.
7982 RESOURCE_NAME is the resource name Emacs uses. */
7984 static void
7985 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
7987 XIM xim;
7989 #ifdef HAVE_XIM
7990 if (use_xim)
7992 if (dpyinfo->xim)
7993 XCloseIM (dpyinfo->xim);
7994 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
7995 emacs_class);
7996 dpyinfo->xim = xim;
7998 if (xim)
8000 #ifdef HAVE_X11R6
8001 XIMCallback destroy;
8002 #endif
8004 /* Get supported styles and XIM values. */
8005 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8007 #ifdef HAVE_X11R6
8008 destroy.callback = xim_destroy_callback;
8009 destroy.client_data = (XPointer)dpyinfo;
8010 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8011 #endif
8015 else
8016 #endif /* HAVE_XIM */
8017 dpyinfo->xim = NULL;
8021 #ifdef HAVE_X11R6_XIM
8023 /* XIM instantiate callback function, which is called whenever an XIM
8024 server is available. DISPLAY is the display of the XIM.
8025 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8026 when the callback was registered. */
8028 static void
8029 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8031 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8032 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8034 /* We don't support multiple XIM connections. */
8035 if (dpyinfo->xim)
8036 return;
8038 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8040 /* Create XIC for the existing frames on the same display, as long
8041 as they have no XIC. */
8042 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8044 Lisp_Object tail, frame;
8046 BLOCK_INPUT;
8047 FOR_EACH_FRAME (tail, frame)
8049 struct frame *f = XFRAME (frame);
8051 if (FRAME_X_P (f)
8052 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8053 if (FRAME_XIC (f) == NULL)
8055 create_frame_xic (f);
8056 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8057 xic_set_statusarea (f);
8058 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8060 struct window *w = XWINDOW (f->selected_window);
8061 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8066 UNBLOCK_INPUT;
8070 #endif /* HAVE_X11R6_XIM */
8073 /* Open a connection to the XIM server on display DPYINFO.
8074 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8075 connection only at the first time. On X11R6, open the connection
8076 in the XIM instantiate callback function. */
8078 static void
8079 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8081 dpyinfo->xim = NULL;
8082 #ifdef HAVE_XIM
8083 if (use_xim)
8085 #ifdef HAVE_X11R6_XIM
8086 struct xim_inst_t *xim_inst;
8087 int len;
8089 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8090 dpyinfo->xim_callback_data = xim_inst;
8091 xim_inst->dpyinfo = dpyinfo;
8092 len = strlen (resource_name);
8093 xim_inst->resource_name = (char *) xmalloc (len + 1);
8094 memcpy (xim_inst->resource_name, resource_name, len + 1);
8095 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8096 resource_name, emacs_class,
8097 xim_instantiate_callback,
8098 /* This is XPointer in XFree86
8099 but (XPointer *) on Tru64, at
8100 least, hence the configure test. */
8101 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8102 #else /* not HAVE_X11R6_XIM */
8103 xim_open_dpy (dpyinfo, resource_name);
8104 #endif /* not HAVE_X11R6_XIM */
8106 #endif /* HAVE_XIM */
8110 /* Close the connection to the XIM server on display DPYINFO. */
8112 static void
8113 xim_close_dpy (struct x_display_info *dpyinfo)
8115 #ifdef HAVE_XIM
8116 if (use_xim)
8118 #ifdef HAVE_X11R6_XIM
8119 if (dpyinfo->display)
8120 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8121 NULL, emacs_class,
8122 xim_instantiate_callback, NULL);
8123 xfree (dpyinfo->xim_callback_data->resource_name);
8124 xfree (dpyinfo->xim_callback_data);
8125 #endif /* HAVE_X11R6_XIM */
8126 if (dpyinfo->display)
8127 XCloseIM (dpyinfo->xim);
8128 dpyinfo->xim = NULL;
8129 XFree (dpyinfo->xim_styles);
8131 #endif /* HAVE_XIM */
8134 #endif /* not HAVE_X11R6_XIM */
8138 /* Calculate the absolute position in frame F
8139 from its current recorded position values and gravity. */
8141 static void
8142 x_calc_absolute_position (struct frame *f)
8144 int flags = f->size_hint_flags;
8146 /* We have nothing to do if the current position
8147 is already for the top-left corner. */
8148 if (! ((flags & XNegative) || (flags & YNegative)))
8149 return;
8151 /* Treat negative positions as relative to the leftmost bottommost
8152 position that fits on the screen. */
8153 if (flags & XNegative)
8154 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8155 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8158 int height = FRAME_PIXEL_HEIGHT (f);
8160 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8161 /* Something is fishy here. When using Motif, starting Emacs with
8162 `-g -0-0', the frame appears too low by a few pixels.
8164 This seems to be so because initially, while Emacs is starting,
8165 the column widget's height and the frame's pixel height are
8166 different. The column widget's height is the right one. In
8167 later invocations, when Emacs is up, the frame's pixel height
8168 is right, though.
8170 It's not obvious where the initial small difference comes from.
8171 2000-12-01, gerd. */
8173 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8174 #endif
8176 if (flags & YNegative)
8177 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8178 - height + f->top_pos;
8181 /* The left_pos and top_pos
8182 are now relative to the top and left screen edges,
8183 so the flags should correspond. */
8184 f->size_hint_flags &= ~ (XNegative | YNegative);
8187 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8188 to really change the position, and 0 when calling from
8189 x_make_frame_visible (in that case, XOFF and YOFF are the current
8190 position values). It is -1 when calling from x_set_frame_parameters,
8191 which means, do adjust for borders but don't change the gravity. */
8193 void
8194 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8196 int modified_top, modified_left;
8198 if (change_gravity > 0)
8200 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8201 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8203 f->top_pos = yoff;
8204 f->left_pos = xoff;
8205 f->size_hint_flags &= ~ (XNegative | YNegative);
8206 if (xoff < 0)
8207 f->size_hint_flags |= XNegative;
8208 if (yoff < 0)
8209 f->size_hint_flags |= YNegative;
8210 f->win_gravity = NorthWestGravity;
8212 x_calc_absolute_position (f);
8214 BLOCK_INPUT;
8215 x_wm_set_size_hint (f, (long) 0, 0);
8217 modified_left = f->left_pos;
8218 modified_top = f->top_pos;
8220 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8222 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8223 than the WM decorations. So we use the calculated offset instead
8224 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8225 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8226 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8229 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8230 modified_left, modified_top);
8232 x_sync_with_move (f, f->left_pos, f->top_pos,
8233 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8234 ? 1 : 0);
8236 /* change_gravity is non-zero when this function is called from Lisp to
8237 programmatically move a frame. In that case, we call
8238 x_check_expected_move to discover if we have a "Type A" or "Type B"
8239 window manager, and, for a "Type A" window manager, adjust the position
8240 of the frame.
8242 We call x_check_expected_move if a programmatic move occurred, and
8243 either the window manager type (A/B) is unknown or it is Type A but we
8244 need to compute the top/left offset adjustment for this frame. */
8246 if (change_gravity != 0 &&
8247 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8248 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8249 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8250 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8251 x_check_expected_move (f, modified_left, modified_top);
8253 UNBLOCK_INPUT;
8256 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8257 on the root window for frame F contains ATOMNAME.
8258 This is how a WM check shall be done according to the Window Manager
8259 Specification/Extended Window Manager Hints at
8260 http://freedesktop.org/wiki/Specifications/wm-spec. */
8262 static int
8263 wm_supports (struct frame *f, Atom want_atom)
8265 Atom actual_type;
8266 unsigned long actual_size, bytes_remaining;
8267 int i, rc, actual_format;
8268 Window wmcheck_window;
8269 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8270 Window target_window = dpyinfo->root_window;
8271 long max_len = 65536;
8272 Display *dpy = FRAME_X_DISPLAY (f);
8273 unsigned char *tmp_data = NULL;
8274 Atom target_type = XA_WINDOW;
8276 BLOCK_INPUT;
8278 x_catch_errors (dpy);
8279 rc = XGetWindowProperty (dpy, target_window,
8280 dpyinfo->Xatom_net_supporting_wm_check,
8281 0, max_len, False, target_type,
8282 &actual_type, &actual_format, &actual_size,
8283 &bytes_remaining, &tmp_data);
8285 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8287 if (tmp_data) XFree (tmp_data);
8288 x_uncatch_errors ();
8289 UNBLOCK_INPUT;
8290 return 0;
8293 wmcheck_window = *(Window *) tmp_data;
8294 XFree (tmp_data);
8296 /* Check if window exists. */
8297 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8298 x_sync (f);
8299 if (x_had_errors_p (dpy))
8301 x_uncatch_errors ();
8302 UNBLOCK_INPUT;
8303 return 0;
8306 if (dpyinfo->net_supported_window != wmcheck_window)
8308 /* Window changed, reload atoms */
8309 if (dpyinfo->net_supported_atoms != NULL)
8310 XFree (dpyinfo->net_supported_atoms);
8311 dpyinfo->net_supported_atoms = NULL;
8312 dpyinfo->nr_net_supported_atoms = 0;
8313 dpyinfo->net_supported_window = 0;
8315 target_type = XA_ATOM;
8316 tmp_data = NULL;
8317 rc = XGetWindowProperty (dpy, target_window,
8318 dpyinfo->Xatom_net_supported,
8319 0, max_len, False, target_type,
8320 &actual_type, &actual_format, &actual_size,
8321 &bytes_remaining, &tmp_data);
8323 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8325 if (tmp_data) XFree (tmp_data);
8326 x_uncatch_errors ();
8327 UNBLOCK_INPUT;
8328 return 0;
8331 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8332 dpyinfo->nr_net_supported_atoms = actual_size;
8333 dpyinfo->net_supported_window = wmcheck_window;
8336 rc = 0;
8338 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8339 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8341 x_uncatch_errors ();
8342 UNBLOCK_INPUT;
8344 return rc;
8347 static void
8348 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8350 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8352 x_send_client_event (frame, make_number (0), frame,
8353 dpyinfo->Xatom_net_wm_state,
8354 make_number (32),
8355 /* 1 = add, 0 = remove */
8356 Fcons
8357 (make_number (add ? 1 : 0),
8358 Fcons
8359 (make_fixnum_or_float (atom),
8360 value != 0
8361 ? Fcons (make_fixnum_or_float (value), Qnil)
8362 : Qnil)));
8365 void
8366 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8368 Lisp_Object frame;
8369 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8371 XSETFRAME (frame, f);
8373 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8374 dpyinfo->Xatom_net_wm_state_sticky, None);
8377 /* Return the current _NET_WM_STATE.
8378 SIZE_STATE is set to one of the FULLSCREEN_* values.
8379 STICKY is set to 1 if the sticky state is set, 0 if not. */
8381 static void
8382 get_current_wm_state (struct frame *f,
8383 Window window,
8384 int *size_state,
8385 int *sticky)
8387 Atom actual_type;
8388 unsigned long actual_size, bytes_remaining;
8389 int i, rc, actual_format;
8390 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8391 long max_len = 65536;
8392 Display *dpy = FRAME_X_DISPLAY (f);
8393 unsigned char *tmp_data = NULL;
8394 Atom target_type = XA_ATOM;
8396 *sticky = 0;
8397 *size_state = FULLSCREEN_NONE;
8399 BLOCK_INPUT;
8400 x_catch_errors (dpy);
8401 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8402 0, max_len, False, target_type,
8403 &actual_type, &actual_format, &actual_size,
8404 &bytes_remaining, &tmp_data);
8406 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8408 if (tmp_data) XFree (tmp_data);
8409 x_uncatch_errors ();
8410 UNBLOCK_INPUT;
8411 return;
8414 x_uncatch_errors ();
8416 for (i = 0; i < actual_size; ++i)
8418 Atom a = ((Atom*)tmp_data)[i];
8419 if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8421 if (*size_state == FULLSCREEN_HEIGHT)
8422 *size_state = FULLSCREEN_MAXIMIZED;
8423 else
8424 *size_state = FULLSCREEN_WIDTH;
8426 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8428 if (*size_state == FULLSCREEN_WIDTH)
8429 *size_state = FULLSCREEN_MAXIMIZED;
8430 else
8431 *size_state = FULLSCREEN_HEIGHT;
8433 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8434 *size_state = FULLSCREEN_BOTH;
8435 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8436 *sticky = 1;
8439 if (tmp_data) XFree (tmp_data);
8440 UNBLOCK_INPUT;
8443 /* Do fullscreen as specified in extended window manager hints */
8445 static int
8446 do_ewmh_fullscreen (struct frame *f)
8448 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8449 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8450 int cur, dummy;
8452 get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8454 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8455 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8456 if (!have_net_atom)
8457 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8459 if (have_net_atom && cur != f->want_fullscreen)
8461 Lisp_Object frame;
8463 XSETFRAME (frame, f);
8465 /* Keep number of calls to set_wm_state as low as possible.
8466 Some window managers, or possible Gtk+, hangs when too many
8467 are sent at once. */
8468 switch (f->want_fullscreen)
8470 case FULLSCREEN_BOTH:
8471 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8472 || cur == FULLSCREEN_HEIGHT)
8473 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8474 dpyinfo->Xatom_net_wm_state_maximized_vert);
8475 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8476 break;
8477 case FULLSCREEN_WIDTH:
8478 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8479 || cur == FULLSCREEN_MAXIMIZED)
8480 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8481 dpyinfo->Xatom_net_wm_state_maximized_vert);
8482 if (cur != FULLSCREEN_MAXIMIZED)
8483 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8484 break;
8485 case FULLSCREEN_HEIGHT:
8486 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8487 || cur == FULLSCREEN_MAXIMIZED)
8488 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8489 dpyinfo->Xatom_net_wm_state_maximized_horz);
8490 if (cur != FULLSCREEN_MAXIMIZED)
8491 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8492 break;
8493 case FULLSCREEN_MAXIMIZED:
8494 if (cur == FULLSCREEN_BOTH)
8495 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8496 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8497 dpyinfo->Xatom_net_wm_state_maximized_vert);
8498 break;
8499 case FULLSCREEN_NONE:
8500 if (cur == FULLSCREEN_BOTH)
8501 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8502 else
8503 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8504 dpyinfo->Xatom_net_wm_state_maximized_vert);
8507 f->want_fullscreen = FULLSCREEN_NONE;
8511 return have_net_atom;
8514 static void
8515 XTfullscreen_hook (FRAME_PTR f)
8517 if (f->async_visible)
8519 BLOCK_INPUT;
8520 x_check_fullscreen (f);
8521 x_sync (f);
8522 UNBLOCK_INPUT;
8527 static void
8528 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8530 int value = FULLSCREEN_NONE;
8531 Lisp_Object lval;
8532 int sticky = 0;
8534 get_current_wm_state (f, event->window, &value, &sticky);
8535 lval = Qnil;
8536 switch (value)
8538 case FULLSCREEN_WIDTH:
8539 lval = Qfullwidth;
8540 break;
8541 case FULLSCREEN_HEIGHT:
8542 lval = Qfullheight;
8543 break;
8544 case FULLSCREEN_BOTH:
8545 lval = Qfullboth;
8546 break;
8547 case FULLSCREEN_MAXIMIZED:
8548 lval = Qmaximized;
8549 break;
8552 store_frame_param (f, Qfullscreen, lval);
8553 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8556 /* Check if we need to resize the frame due to a fullscreen request.
8557 If so needed, resize the frame. */
8558 static void
8559 x_check_fullscreen (struct frame *f)
8561 if (do_ewmh_fullscreen (f))
8562 return;
8564 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8565 return; /* Only fullscreen without WM or with EWM hints (above). */
8567 /* Setting fullscreen to nil doesn't do anything. We could save the
8568 last non-fullscreen size and restore it, but it seems like a
8569 lot of work for this unusual case (no window manager running). */
8571 if (f->want_fullscreen != FULLSCREEN_NONE)
8573 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8574 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8576 switch (f->want_fullscreen)
8578 /* No difference between these two when there is no WM */
8579 case FULLSCREEN_BOTH:
8580 case FULLSCREEN_MAXIMIZED:
8581 width = x_display_pixel_width (dpyinfo);
8582 height = x_display_pixel_height (dpyinfo);
8583 break;
8584 case FULLSCREEN_WIDTH:
8585 width = x_display_pixel_width (dpyinfo);
8586 break;
8587 case FULLSCREEN_HEIGHT:
8588 height = x_display_pixel_height (dpyinfo);
8591 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8592 width, height);
8596 /* This function is called by x_set_offset to determine whether the window
8597 manager interfered with the positioning of the frame. Type A window
8598 managers position the surrounding window manager decorations a small
8599 amount above and left of the user-supplied position. Type B window
8600 managers position the surrounding window manager decorations at the
8601 user-specified position. If we detect a Type A window manager, we
8602 compensate by moving the window right and down by the proper amount. */
8604 static void
8605 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8607 int current_left = 0, current_top = 0;
8609 /* x_real_positions returns the left and top offsets of the outermost
8610 window manager window around the frame. */
8612 x_real_positions (f, &current_left, &current_top);
8614 if (current_left != expected_left || current_top != expected_top)
8616 /* It's a "Type A" window manager. */
8618 int adjusted_left;
8619 int adjusted_top;
8621 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8622 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8623 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8625 /* Now fix the mispositioned frame's location. */
8627 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8628 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8630 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8631 adjusted_left, adjusted_top);
8633 x_sync_with_move (f, expected_left, expected_top, 0);
8635 else
8636 /* It's a "Type B" window manager. We don't have to adjust the
8637 frame's position. */
8639 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8643 /* Wait for XGetGeometry to return up-to-date position information for a
8644 recently-moved frame. Call this immediately after calling XMoveWindow.
8645 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8646 frame has been moved to, so we use a fuzzy position comparison instead
8647 of an exact comparison. */
8649 static void
8650 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8652 int count = 0;
8654 while (count++ < 50)
8656 int current_left = 0, current_top = 0;
8658 /* In theory, this call to XSync only needs to happen once, but in
8659 practice, it doesn't seem to work, hence the need for the surrounding
8660 loop. */
8662 XSync (FRAME_X_DISPLAY (f), False);
8663 x_real_positions (f, &current_left, &current_top);
8665 if (fuzzy)
8667 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8668 pixels. */
8670 if (eabs (current_left - left) <= 10
8671 && eabs (current_top - top) <= 40)
8672 return;
8674 else if (current_left == left && current_top == top)
8675 return;
8678 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8679 will then return up-to-date position info. */
8681 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8685 /* Wait for an event on frame F matching EVENTTYPE. */
8686 void
8687 x_wait_for_event (struct frame *f, int eventtype)
8689 int level = interrupt_input_blocked;
8691 SELECT_TYPE fds;
8692 EMACS_TIME tmo, tmo_at, time_now;
8693 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8695 pending_event_wait.f = f;
8696 pending_event_wait.eventtype = eventtype;
8698 /* Set timeout to 0.1 second. Hopefully not noticable.
8699 Maybe it should be configurable. */
8700 EMACS_SET_SECS_USECS (tmo, 0, 100000);
8701 EMACS_GET_TIME (tmo_at);
8702 EMACS_ADD_TIME (tmo_at, tmo_at, tmo);
8704 while (pending_event_wait.eventtype)
8706 interrupt_input_pending = 1;
8707 TOTALLY_UNBLOCK_INPUT;
8708 /* XTread_socket is called after unblock. */
8709 BLOCK_INPUT;
8710 interrupt_input_blocked = level;
8712 FD_ZERO (&fds);
8713 FD_SET (fd, &fds);
8715 EMACS_GET_TIME (time_now);
8716 EMACS_SUB_TIME (tmo, tmo_at, time_now);
8718 if (EMACS_TIME_NEG_P (tmo) || select (fd+1, &fds, NULL, NULL, &tmo) == 0)
8719 break; /* Timeout */
8721 pending_event_wait.f = 0;
8722 pending_event_wait.eventtype = 0;
8726 /* Change the size of frame F's X window to COLS/ROWS in the case F
8727 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8728 top-left-corner window gravity for this size change and subsequent
8729 size changes. Otherwise we leave the window gravity unchanged. */
8731 static void
8732 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8734 int pixelwidth, pixelheight;
8736 check_frame_size (f, &rows, &cols);
8737 f->scroll_bar_actual_width
8738 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8740 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8742 compute_fringe_widths (f, 0);
8744 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8745 + FRAME_TOOLBAR_WIDTH (f);
8746 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8747 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8749 if (change_gravity) f->win_gravity = NorthWestGravity;
8750 x_wm_set_size_hint (f, (long) 0, 0);
8751 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8752 pixelwidth, pixelheight);
8755 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8756 receive in the ConfigureNotify event; if we get what we asked
8757 for, then the event won't cause the screen to become garbaged, so
8758 we have to make sure to do it here. */
8759 SET_FRAME_GARBAGED (f);
8761 /* Now, strictly speaking, we can't be sure that this is accurate,
8762 but the window manager will get around to dealing with the size
8763 change request eventually, and we'll hear how it went when the
8764 ConfigureNotify event gets here.
8766 We could just not bother storing any of this information here,
8767 and let the ConfigureNotify event set everything up, but that
8768 might be kind of confusing to the Lisp code, since size changes
8769 wouldn't be reported in the frame parameters until some random
8770 point in the future when the ConfigureNotify event arrives.
8772 We pass 1 for DELAY since we can't run Lisp code inside of
8773 a BLOCK_INPUT. */
8775 /* But the ConfigureNotify may in fact never arrive, and then this is
8776 not right if the frame is visible. Instead wait (with timeout)
8777 for the ConfigureNotify. */
8778 if (f->async_visible)
8779 x_wait_for_event (f, ConfigureNotify);
8780 else
8782 change_frame_size (f, rows, cols, 0, 1, 0);
8783 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8784 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8785 x_sync (f);
8790 /* Call this to change the size of frame F's x-window.
8791 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8792 for this size change and subsequent size changes.
8793 Otherwise we leave the window gravity unchanged. */
8795 void
8796 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8798 BLOCK_INPUT;
8800 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8802 int r, c;
8804 /* When the frame is maximized/fullscreen or running under for
8805 example Xmonad, x_set_window_size_1 will be a no-op.
8806 In that case, the right thing to do is extend rows/cols to
8807 the current frame size. We do that first if x_set_window_size_1
8808 turns out to not be a no-op (there is no way to know).
8809 The size will be adjusted again if the frame gets a
8810 ConfigureNotify event as a result of x_set_window_size. */
8811 int pixelh = FRAME_PIXEL_HEIGHT (f);
8812 #ifdef USE_X_TOOLKIT
8813 /* The menu bar is not part of text lines. The tool bar
8814 is however. */
8815 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8816 #endif
8817 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8818 /* Update f->scroll_bar_actual_width because it is used in
8819 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8820 f->scroll_bar_actual_width
8821 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8822 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8823 change_frame_size (f, r, c, 0, 1, 0);
8826 #ifdef USE_GTK
8827 if (FRAME_GTK_WIDGET (f))
8828 xg_frame_set_char_size (f, cols, rows);
8829 else
8830 x_set_window_size_1 (f, change_gravity, cols, rows);
8831 #else /* not USE_GTK */
8833 x_set_window_size_1 (f, change_gravity, cols, rows);
8835 #endif /* not USE_GTK */
8837 /* If cursor was outside the new size, mark it as off. */
8838 mark_window_cursors_off (XWINDOW (f->root_window));
8840 /* Clear out any recollection of where the mouse highlighting was,
8841 since it might be in a place that's outside the new frame size.
8842 Actually checking whether it is outside is a pain in the neck,
8843 so don't try--just let the highlighting be done afresh with new size. */
8844 cancel_mouse_face (f);
8846 UNBLOCK_INPUT;
8849 /* Mouse warping. */
8851 void
8852 x_set_mouse_position (struct frame *f, int x, int y)
8854 int pix_x, pix_y;
8856 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8857 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8859 if (pix_x < 0) pix_x = 0;
8860 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8862 if (pix_y < 0) pix_y = 0;
8863 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8865 BLOCK_INPUT;
8867 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8868 0, 0, 0, 0, pix_x, pix_y);
8869 UNBLOCK_INPUT;
8872 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8874 void
8875 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8877 BLOCK_INPUT;
8879 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8880 0, 0, 0, 0, pix_x, pix_y);
8881 UNBLOCK_INPUT;
8884 /* Raise frame F. */
8886 void
8887 x_raise_frame (struct frame *f)
8889 BLOCK_INPUT;
8890 if (f->async_visible)
8891 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8893 XFlush (FRAME_X_DISPLAY (f));
8894 UNBLOCK_INPUT;
8897 /* Lower frame F. */
8899 static void
8900 x_lower_frame (struct frame *f)
8902 if (f->async_visible)
8904 BLOCK_INPUT;
8905 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8906 XFlush (FRAME_X_DISPLAY (f));
8907 UNBLOCK_INPUT;
8911 /* Activate frame with Extended Window Manager Hints */
8913 void
8914 x_ewmh_activate_frame (FRAME_PTR f)
8916 /* See Window Manager Specification/Extended Window Manager Hints at
8917 http://freedesktop.org/wiki/Specifications/wm-spec */
8919 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8920 if (f->async_visible && wm_supports (f, dpyinfo->Xatom_net_active_window))
8922 Lisp_Object frame;
8923 XSETFRAME (frame, f);
8924 x_send_client_event (frame, make_number (0), frame,
8925 dpyinfo->Xatom_net_active_window,
8926 make_number (32),
8927 Fcons (make_number (1),
8928 Fcons (make_number (last_user_time),
8929 Qnil)));
8933 static void
8934 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
8936 if (raise_flag)
8937 x_raise_frame (f);
8938 else
8939 x_lower_frame (f);
8942 /* XEmbed implementation. */
8944 #if defined USE_X_TOOLKIT || ! defined USE_GTK
8946 /* XEmbed implementation. */
8948 #define XEMBED_VERSION 0
8950 static void
8951 xembed_set_info (struct frame *f, enum xembed_info flags)
8953 unsigned long data[2];
8954 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8956 data[0] = XEMBED_VERSION;
8957 data[1] = flags;
8959 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8960 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
8961 32, PropModeReplace, (unsigned char *) data, 2);
8963 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
8965 static void
8966 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
8967 long int detail, long int data1, long int data2)
8969 XEvent event;
8971 event.xclient.type = ClientMessage;
8972 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
8973 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
8974 event.xclient.format = 32;
8975 event.xclient.data.l[0] = t;
8976 event.xclient.data.l[1] = msg;
8977 event.xclient.data.l[2] = detail;
8978 event.xclient.data.l[3] = data1;
8979 event.xclient.data.l[4] = data2;
8981 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
8982 False, NoEventMask, &event);
8983 XSync (FRAME_X_DISPLAY (f), False);
8986 /* Change of visibility. */
8988 /* This tries to wait until the frame is really visible.
8989 However, if the window manager asks the user where to position
8990 the frame, this will return before the user finishes doing that.
8991 The frame will not actually be visible at that time,
8992 but it will become visible later when the window manager
8993 finishes with it. */
8995 void
8996 x_make_frame_visible (struct frame *f)
8998 Lisp_Object type;
8999 int original_top, original_left;
9000 int retry_count = 2;
9002 retry:
9004 BLOCK_INPUT;
9006 type = x_icon_type (f);
9007 if (!NILP (type))
9008 x_bitmap_icon (f, type);
9010 if (! FRAME_VISIBLE_P (f))
9012 /* We test FRAME_GARBAGED_P here to make sure we don't
9013 call x_set_offset a second time
9014 if we get to x_make_frame_visible a second time
9015 before the window gets really visible. */
9016 if (! FRAME_ICONIFIED_P (f)
9017 && ! FRAME_X_EMBEDDED_P (f)
9018 && ! f->output_data.x->asked_for_visible)
9019 x_set_offset (f, f->left_pos, f->top_pos, 0);
9021 f->output_data.x->asked_for_visible = 1;
9023 if (! EQ (Vx_no_window_manager, Qt))
9024 x_wm_set_window_state (f, NormalState);
9025 #ifdef USE_X_TOOLKIT
9026 if (FRAME_X_EMBEDDED_P (f))
9027 xembed_set_info (f, XEMBED_MAPPED);
9028 else
9030 /* This was XtPopup, but that did nothing for an iconified frame. */
9031 XtMapWidget (f->output_data.x->widget);
9033 #else /* not USE_X_TOOLKIT */
9034 #ifdef USE_GTK
9035 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9036 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9037 #else
9038 if (FRAME_X_EMBEDDED_P (f))
9039 xembed_set_info (f, XEMBED_MAPPED);
9040 else
9041 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9042 #endif /* not USE_GTK */
9043 #endif /* not USE_X_TOOLKIT */
9046 XFlush (FRAME_X_DISPLAY (f));
9048 /* Synchronize to ensure Emacs knows the frame is visible
9049 before we do anything else. We do this loop with input not blocked
9050 so that incoming events are handled. */
9052 Lisp_Object frame;
9053 int count;
9054 /* This must be before UNBLOCK_INPUT
9055 since events that arrive in response to the actions above
9056 will set it when they are handled. */
9057 int previously_visible = f->output_data.x->has_been_visible;
9059 original_left = f->left_pos;
9060 original_top = f->top_pos;
9062 /* This must come after we set COUNT. */
9063 UNBLOCK_INPUT;
9065 /* We unblock here so that arriving X events are processed. */
9067 /* Now move the window back to where it was "supposed to be".
9068 But don't do it if the gravity is negative.
9069 When the gravity is negative, this uses a position
9070 that is 3 pixels too low. Perhaps that's really the border width.
9072 Don't do this if the window has never been visible before,
9073 because the window manager may choose the position
9074 and we don't want to override it. */
9076 if (! FRAME_VISIBLE_P (f)
9077 && ! FRAME_ICONIFIED_P (f)
9078 && ! FRAME_X_EMBEDDED_P (f)
9079 && f->win_gravity == NorthWestGravity
9080 && previously_visible)
9082 Drawable rootw;
9083 int x, y;
9084 unsigned int width, height, border, depth;
9086 BLOCK_INPUT;
9088 /* On some window managers (such as FVWM) moving an existing
9089 window, even to the same place, causes the window manager
9090 to introduce an offset. This can cause the window to move
9091 to an unexpected location. Check the geometry (a little
9092 slow here) and then verify that the window is in the right
9093 place. If the window is not in the right place, move it
9094 there, and take the potential window manager hit. */
9095 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9096 &rootw, &x, &y, &width, &height, &border, &depth);
9098 if (original_left != x || original_top != y)
9099 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9100 original_left, original_top);
9102 UNBLOCK_INPUT;
9105 XSETFRAME (frame, f);
9107 /* Wait until the frame is visible. Process X events until a
9108 MapNotify event has been seen, or until we think we won't get a
9109 MapNotify at all.. */
9110 for (count = input_signal_count + 10;
9111 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9113 /* Force processing of queued events. */
9114 x_sync (f);
9116 /* Machines that do polling rather than SIGIO have been
9117 observed to go into a busy-wait here. So we'll fake an
9118 alarm signal to let the handler know that there's something
9119 to be read. We used to raise a real alarm, but it seems
9120 that the handler isn't always enabled here. This is
9121 probably a bug. */
9122 if (input_polling_used ())
9124 /* It could be confusing if a real alarm arrives while
9125 processing the fake one. Turn it off and let the
9126 handler reset it. */
9127 int old_poll_suppress_count = poll_suppress_count;
9128 poll_suppress_count = 1;
9129 poll_for_input_1 ();
9130 poll_suppress_count = old_poll_suppress_count;
9133 /* See if a MapNotify event has been processed. */
9134 FRAME_SAMPLE_VISIBILITY (f);
9137 /* 2000-09-28: In
9139 (let ((f (selected-frame)))
9140 (iconify-frame f)
9141 (raise-frame f))
9143 the frame is not raised with various window managers on
9144 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9145 unknown reason, the call to XtMapWidget is completely ignored.
9146 Mapping the widget a second time works. */
9148 if (!FRAME_VISIBLE_P (f) && --retry_count != 0)
9149 goto retry;
9153 /* Change from mapped state to withdrawn state. */
9155 /* Make the frame visible (mapped and not iconified). */
9157 void
9158 x_make_frame_invisible (struct frame *f)
9160 Window window;
9162 /* Use the frame's outermost window, not the one we normally draw on. */
9163 window = FRAME_OUTER_WINDOW (f);
9165 /* Don't keep the highlight on an invisible frame. */
9166 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9167 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9169 BLOCK_INPUT;
9171 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9172 that the current position of the window is user-specified, rather than
9173 program-specified, so that when the window is mapped again, it will be
9174 placed at the same location, without forcing the user to position it
9175 by hand again (they have already done that once for this window.) */
9176 x_wm_set_size_hint (f, (long) 0, 1);
9178 #ifdef USE_GTK
9179 if (FRAME_GTK_OUTER_WIDGET (f))
9180 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9181 else
9182 #else
9183 if (FRAME_X_EMBEDDED_P (f))
9184 xembed_set_info (f, 0);
9185 else
9186 #endif
9189 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9190 DefaultScreen (FRAME_X_DISPLAY (f))))
9192 UNBLOCK_INPUT_RESIGNAL;
9193 error ("Can't notify window manager of window withdrawal");
9197 /* We can't distinguish this from iconification
9198 just by the event that we get from the server.
9199 So we can't win using the usual strategy of letting
9200 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9201 and synchronize with the server to make sure we agree. */
9202 f->visible = 0;
9203 FRAME_ICONIFIED_P (f) = 0;
9204 f->async_visible = 0;
9205 f->async_iconified = 0;
9207 x_sync (f);
9209 UNBLOCK_INPUT;
9212 /* Change window state from mapped to iconified. */
9214 void
9215 x_iconify_frame (struct frame *f)
9217 #ifdef USE_X_TOOLKIT
9218 int result;
9219 #endif
9220 Lisp_Object type;
9222 /* Don't keep the highlight on an invisible frame. */
9223 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9224 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9226 if (f->async_iconified)
9227 return;
9229 BLOCK_INPUT;
9231 FRAME_SAMPLE_VISIBILITY (f);
9233 type = x_icon_type (f);
9234 if (!NILP (type))
9235 x_bitmap_icon (f, type);
9237 #ifdef USE_GTK
9238 if (FRAME_GTK_OUTER_WIDGET (f))
9240 if (! FRAME_VISIBLE_P (f))
9241 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9243 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9244 f->iconified = 1;
9245 f->visible = 1;
9246 f->async_iconified = 1;
9247 f->async_visible = 0;
9248 UNBLOCK_INPUT;
9249 return;
9251 #endif
9253 #ifdef USE_X_TOOLKIT
9255 if (! FRAME_VISIBLE_P (f))
9257 if (! EQ (Vx_no_window_manager, Qt))
9258 x_wm_set_window_state (f, IconicState);
9259 /* This was XtPopup, but that did nothing for an iconified frame. */
9260 XtMapWidget (f->output_data.x->widget);
9261 /* The server won't give us any event to indicate
9262 that an invisible frame was changed to an icon,
9263 so we have to record it here. */
9264 f->iconified = 1;
9265 f->visible = 1;
9266 f->async_iconified = 1;
9267 f->async_visible = 0;
9268 UNBLOCK_INPUT;
9269 return;
9272 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9273 XtWindow (f->output_data.x->widget),
9274 DefaultScreen (FRAME_X_DISPLAY (f)));
9275 UNBLOCK_INPUT;
9277 if (!result)
9278 error ("Can't notify window manager of iconification");
9280 f->async_iconified = 1;
9281 f->async_visible = 0;
9284 BLOCK_INPUT;
9285 XFlush (FRAME_X_DISPLAY (f));
9286 UNBLOCK_INPUT;
9287 #else /* not USE_X_TOOLKIT */
9289 /* Make sure the X server knows where the window should be positioned,
9290 in case the user deiconifies with the window manager. */
9291 if (! FRAME_VISIBLE_P (f)
9292 && ! FRAME_ICONIFIED_P (f)
9293 && ! FRAME_X_EMBEDDED_P (f))
9294 x_set_offset (f, f->left_pos, f->top_pos, 0);
9296 /* Since we don't know which revision of X we're running, we'll use both
9297 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9299 /* X11R4: send a ClientMessage to the window manager using the
9300 WM_CHANGE_STATE type. */
9302 XEvent msg;
9304 msg.xclient.window = FRAME_X_WINDOW (f);
9305 msg.xclient.type = ClientMessage;
9306 msg.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9307 msg.xclient.format = 32;
9308 msg.xclient.data.l[0] = IconicState;
9310 if (! XSendEvent (FRAME_X_DISPLAY (f),
9311 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9312 False,
9313 SubstructureRedirectMask | SubstructureNotifyMask,
9314 &msg))
9316 UNBLOCK_INPUT_RESIGNAL;
9317 error ("Can't notify window manager of iconification");
9321 /* X11R3: set the initial_state field of the window manager hints to
9322 IconicState. */
9323 x_wm_set_window_state (f, IconicState);
9325 if (!FRAME_VISIBLE_P (f))
9327 /* If the frame was withdrawn, before, we must map it. */
9328 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9331 f->async_iconified = 1;
9332 f->async_visible = 0;
9334 XFlush (FRAME_X_DISPLAY (f));
9335 UNBLOCK_INPUT;
9336 #endif /* not USE_X_TOOLKIT */
9340 /* Free X resources of frame F. */
9342 void
9343 x_free_frame_resources (struct frame *f)
9345 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9346 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9347 #ifdef USE_X_TOOLKIT
9348 Lisp_Object bar;
9349 struct scroll_bar *b;
9350 #endif
9352 BLOCK_INPUT;
9354 /* If a display connection is dead, don't try sending more
9355 commands to the X server. */
9356 if (dpyinfo->display)
9358 /* We must free faces before destroying windows because some
9359 font-driver (e.g. xft) access a window while finishing a
9360 face. */
9361 if (FRAME_FACE_CACHE (f))
9362 free_frame_faces (f);
9364 if (f->output_data.x->icon_desc)
9365 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9367 #ifdef USE_X_TOOLKIT
9368 /* Explicitly destroy the scroll bars of the frame. Without
9369 this, we get "BadDrawable" errors from the toolkit later on,
9370 presumably from expose events generated for the disappearing
9371 toolkit scroll bars. */
9372 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9374 b = XSCROLL_BAR (bar);
9375 x_scroll_bar_remove (b);
9377 #endif
9379 #ifdef HAVE_X_I18N
9380 if (FRAME_XIC (f))
9381 free_frame_xic (f);
9382 #endif
9384 #ifdef USE_X_TOOLKIT
9385 if (f->output_data.x->widget)
9387 XtDestroyWidget (f->output_data.x->widget);
9388 f->output_data.x->widget = NULL;
9390 /* Tooltips don't have widgets, only a simple X window, even if
9391 we are using a toolkit. */
9392 else if (FRAME_X_WINDOW (f))
9393 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9395 free_frame_menubar (f);
9396 #else /* !USE_X_TOOLKIT */
9398 #ifdef USE_GTK
9399 xg_free_frame_widgets (f);
9400 #endif /* USE_GTK */
9402 if (FRAME_X_WINDOW (f))
9403 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9404 #endif /* !USE_X_TOOLKIT */
9406 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9407 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9408 unload_color (f, f->output_data.x->cursor_pixel);
9409 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9410 unload_color (f, f->output_data.x->border_pixel);
9411 unload_color (f, f->output_data.x->mouse_pixel);
9413 if (f->output_data.x->scroll_bar_background_pixel != -1)
9414 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9415 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9416 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9417 #ifdef USE_TOOLKIT_SCROLL_BARS
9418 /* Scrollbar shadow colors. */
9419 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9420 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9421 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9422 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9423 #endif /* USE_TOOLKIT_SCROLL_BARS */
9424 if (f->output_data.x->white_relief.allocated_p)
9425 unload_color (f, f->output_data.x->white_relief.pixel);
9426 if (f->output_data.x->black_relief.allocated_p)
9427 unload_color (f, f->output_data.x->black_relief.pixel);
9429 x_free_gcs (f);
9430 XFlush (FRAME_X_DISPLAY (f));
9433 xfree (f->output_data.x->saved_menu_event);
9434 xfree (f->output_data.x);
9435 f->output_data.x = NULL;
9437 if (f == dpyinfo->x_focus_frame)
9438 dpyinfo->x_focus_frame = 0;
9439 if (f == dpyinfo->x_focus_event_frame)
9440 dpyinfo->x_focus_event_frame = 0;
9441 if (f == dpyinfo->x_highlight_frame)
9442 dpyinfo->x_highlight_frame = 0;
9444 if (f == hlinfo->mouse_face_mouse_frame)
9446 hlinfo->mouse_face_beg_row
9447 = hlinfo->mouse_face_beg_col = -1;
9448 hlinfo->mouse_face_end_row
9449 = hlinfo->mouse_face_end_col = -1;
9450 hlinfo->mouse_face_window = Qnil;
9451 hlinfo->mouse_face_deferred_gc = 0;
9452 hlinfo->mouse_face_mouse_frame = 0;
9455 UNBLOCK_INPUT;
9459 /* Destroy the X window of frame F. */
9461 static void
9462 x_destroy_window (struct frame *f)
9464 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9466 /* If a display connection is dead, don't try sending more
9467 commands to the X server. */
9468 if (dpyinfo->display != 0)
9469 x_free_frame_resources (f);
9471 dpyinfo->reference_count--;
9475 /* Setting window manager hints. */
9477 /* Set the normal size hints for the window manager, for frame F.
9478 FLAGS is the flags word to use--or 0 meaning preserve the flags
9479 that the window now has.
9480 If USER_POSITION is nonzero, we set the USPosition
9481 flag (this is useful when FLAGS is 0).
9482 The GTK version is in gtkutils.c */
9484 #ifndef USE_GTK
9485 void
9486 x_wm_set_size_hint (struct frame *f, long flags, int user_position)
9488 XSizeHints size_hints;
9489 Window window = FRAME_OUTER_WINDOW (f);
9491 /* Setting PMaxSize caused various problems. */
9492 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9494 size_hints.x = f->left_pos;
9495 size_hints.y = f->top_pos;
9497 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9498 size_hints.width = FRAME_PIXEL_WIDTH (f);
9500 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9501 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9502 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9503 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9504 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9505 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9507 /* Calculate the base and minimum sizes. */
9509 int base_width, base_height;
9510 int min_rows = 0, min_cols = 0;
9512 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9513 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9515 check_frame_size (f, &min_rows, &min_cols);
9517 /* The window manager uses the base width hints to calculate the
9518 current number of rows and columns in the frame while
9519 resizing; min_width and min_height aren't useful for this
9520 purpose, since they might not give the dimensions for a
9521 zero-row, zero-column frame.
9523 We use the base_width and base_height members if we have
9524 them; otherwise, we set the min_width and min_height members
9525 to the size for a zero x zero frame. */
9527 size_hints.flags |= PBaseSize;
9528 size_hints.base_width = base_width;
9529 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9530 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9531 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9534 /* If we don't need the old flags, we don't need the old hint at all. */
9535 if (flags)
9537 size_hints.flags |= flags;
9538 goto no_read;
9542 XSizeHints hints; /* Sometimes I hate X Windows... */
9543 long supplied_return;
9544 int value;
9546 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9547 &supplied_return);
9549 if (flags)
9550 size_hints.flags |= flags;
9551 else
9553 if (value == 0)
9554 hints.flags = 0;
9555 if (hints.flags & PSize)
9556 size_hints.flags |= PSize;
9557 if (hints.flags & PPosition)
9558 size_hints.flags |= PPosition;
9559 if (hints.flags & USPosition)
9560 size_hints.flags |= USPosition;
9561 if (hints.flags & USSize)
9562 size_hints.flags |= USSize;
9566 no_read:
9568 #ifdef PWinGravity
9569 size_hints.win_gravity = f->win_gravity;
9570 size_hints.flags |= PWinGravity;
9572 if (user_position)
9574 size_hints.flags &= ~ PPosition;
9575 size_hints.flags |= USPosition;
9577 #endif /* PWinGravity */
9579 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9581 #endif /* not USE_GTK */
9583 /* Used for IconicState or NormalState */
9585 static void
9586 x_wm_set_window_state (struct frame *f, int state)
9588 #ifdef USE_X_TOOLKIT
9589 Arg al[1];
9591 XtSetArg (al[0], XtNinitialState, state);
9592 XtSetValues (f->output_data.x->widget, al, 1);
9593 #else /* not USE_X_TOOLKIT */
9594 Window window = FRAME_X_WINDOW (f);
9596 f->output_data.x->wm_hints.flags |= StateHint;
9597 f->output_data.x->wm_hints.initial_state = state;
9599 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9600 #endif /* not USE_X_TOOLKIT */
9603 static void
9604 x_wm_set_icon_pixmap (struct frame *f, int pixmap_id)
9606 Pixmap icon_pixmap, icon_mask;
9608 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9609 Window window = FRAME_OUTER_WINDOW (f);
9610 #endif
9612 if (pixmap_id > 0)
9614 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9615 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9616 icon_mask = x_bitmap_mask (f, pixmap_id);
9617 f->output_data.x->wm_hints.icon_mask = icon_mask;
9619 else
9621 /* It seems there is no way to turn off use of an icon
9622 pixmap. */
9623 return;
9627 #ifdef USE_GTK
9629 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9630 return;
9633 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9636 Arg al[1];
9637 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9638 XtSetValues (f->output_data.x->widget, al, 1);
9639 XtSetArg (al[0], XtNiconMask, icon_mask);
9640 XtSetValues (f->output_data.x->widget, al, 1);
9643 #else /* not USE_X_TOOLKIT && not USE_GTK */
9645 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9646 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9648 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9651 void
9652 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9654 Window window = FRAME_OUTER_WINDOW (f);
9656 f->output_data.x->wm_hints.flags |= IconPositionHint;
9657 f->output_data.x->wm_hints.icon_x = icon_x;
9658 f->output_data.x->wm_hints.icon_y = icon_y;
9660 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9664 /***********************************************************************
9665 Fonts
9666 ***********************************************************************/
9668 #if GLYPH_DEBUG
9670 /* Check that FONT is valid on frame F. It is if it can be found in F's
9671 font table. */
9673 static void
9674 x_check_font (struct frame *f, struct font *font)
9676 Lisp_Object frame;
9678 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9679 if (font->driver->check)
9680 xassert (font->driver->check (f, font) == 0);
9683 #endif /* GLYPH_DEBUG != 0 */
9686 /***********************************************************************
9687 Initialization
9688 ***********************************************************************/
9690 #ifdef USE_X_TOOLKIT
9691 static XrmOptionDescRec emacs_options[] = {
9692 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9693 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9695 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9696 XrmoptionSepArg, NULL},
9697 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9699 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9700 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9701 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9702 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9703 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9704 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9705 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9708 /* Whether atimer for Xt timeouts is activated or not. */
9710 static int x_timeout_atimer_activated_flag;
9712 #endif /* USE_X_TOOLKIT */
9714 static int x_initialized;
9716 /* Test whether two display-name strings agree up to the dot that separates
9717 the screen number from the server number. */
9718 static int
9719 same_x_server (const char *name1, const char *name2)
9721 int seen_colon = 0;
9722 const char *system_name = SSDATA (Vsystem_name);
9723 int system_name_length = strlen (system_name);
9724 int length_until_period = 0;
9726 while (system_name[length_until_period] != 0
9727 && system_name[length_until_period] != '.')
9728 length_until_period++;
9730 /* Treat `unix' like an empty host name. */
9731 if (! strncmp (name1, "unix:", 5))
9732 name1 += 4;
9733 if (! strncmp (name2, "unix:", 5))
9734 name2 += 4;
9735 /* Treat this host's name like an empty host name. */
9736 if (! strncmp (name1, system_name, system_name_length)
9737 && name1[system_name_length] == ':')
9738 name1 += system_name_length;
9739 if (! strncmp (name2, system_name, system_name_length)
9740 && name2[system_name_length] == ':')
9741 name2 += system_name_length;
9742 /* Treat this host's domainless name like an empty host name. */
9743 if (! strncmp (name1, system_name, length_until_period)
9744 && name1[length_until_period] == ':')
9745 name1 += length_until_period;
9746 if (! strncmp (name2, system_name, length_until_period)
9747 && name2[length_until_period] == ':')
9748 name2 += length_until_period;
9750 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9752 if (*name1 == ':')
9753 seen_colon = 1;
9754 if (seen_colon && *name1 == '.')
9755 return 1;
9757 return (seen_colon
9758 && (*name1 == '.' || *name1 == '\0')
9759 && (*name2 == '.' || *name2 == '\0'));
9762 /* Count number of set bits in mask and number of bits to shift to
9763 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9764 to 5. */
9765 static void
9766 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9768 int nr = 0;
9769 int off = 0;
9771 while (!(mask & 1))
9773 off++;
9774 mask >>= 1;
9777 while (mask & 1)
9779 nr++;
9780 mask >>= 1;
9783 *offset = off;
9784 *bits = nr;
9787 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9788 But don't permanently open it, just test its availability. */
9791 x_display_ok (const char *display)
9793 int dpy_ok = 1;
9794 Display *dpy;
9796 dpy = XOpenDisplay (display);
9797 if (dpy)
9798 XCloseDisplay (dpy);
9799 else
9800 dpy_ok = 0;
9801 return dpy_ok;
9804 #ifdef USE_GTK
9805 static void
9806 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
9807 const gchar *msg, gpointer user_data)
9809 if (!strstr (msg, "g_set_prgname"))
9810 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
9812 #endif
9814 /* Open a connection to X display DISPLAY_NAME, and return
9815 the structure that describes the open display.
9816 If we cannot contact the display, return null. */
9818 struct x_display_info *
9819 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9821 int connection;
9822 Display *dpy;
9823 struct terminal *terminal;
9824 struct x_display_info *dpyinfo;
9825 XrmDatabase xrdb;
9826 Mouse_HLInfo *hlinfo;
9828 BLOCK_INPUT;
9830 if (!x_initialized)
9832 x_initialize ();
9833 ++x_initialized;
9836 if (! x_display_ok (SSDATA (display_name)))
9837 error ("Display %s can't be opened", SSDATA (display_name));
9839 #ifdef USE_GTK
9841 #define NUM_ARGV 10
9842 int argc;
9843 char *argv[NUM_ARGV];
9844 char **argv2 = argv;
9845 guint id;
9847 if (x_initialized++ > 1)
9849 xg_display_open (SSDATA (display_name), &dpy);
9851 else
9853 static char display_opt[] = "--display";
9854 static char name_opt[] = "--name";
9856 for (argc = 0; argc < NUM_ARGV; ++argc)
9857 argv[argc] = 0;
9859 argc = 0;
9860 argv[argc++] = initial_argv[0];
9862 if (! NILP (display_name))
9864 argv[argc++] = display_opt;
9865 argv[argc++] = SSDATA (display_name);
9868 argv[argc++] = name_opt;
9869 argv[argc++] = resource_name;
9871 XSetLocaleModifiers ("");
9873 /* Emacs can only handle core input events, so make sure
9874 Gtk doesn't use Xinput or Xinput2 extensions. */
9876 static char fix_events[] = "GDK_CORE_DEVICE_EVENTS=1";
9877 putenv (fix_events);
9880 /* Work around GLib bug that outputs a faulty warning. See
9881 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9882 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9883 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9884 gtk_init (&argc, &argv2);
9885 g_log_remove_handler ("GLib", id);
9887 /* gtk_init does set_locale. We must fix locale after calling it. */
9888 fixup_locale ();
9889 xg_initialize ();
9891 dpy = DEFAULT_GDK_DISPLAY ();
9893 /* NULL window -> events for all windows go to our function */
9894 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9896 #if GTK_MAJOR_VERSION <= 2 && GTK_MINOR_VERSION <= 90
9897 /* Load our own gtkrc if it exists. */
9899 const char *file = "~/.emacs.d/gtkrc";
9900 Lisp_Object s, abs_file;
9902 s = make_string (file, strlen (file));
9903 abs_file = Fexpand_file_name (s, Qnil);
9905 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9906 gtk_rc_parse (SSDATA (abs_file));
9908 #endif
9910 XSetErrorHandler (x_error_handler);
9911 XSetIOErrorHandler (x_io_error_quitter);
9914 #else /* not USE_GTK */
9915 #ifdef USE_X_TOOLKIT
9916 /* weiner@footloose.sps.mot.com reports that this causes
9917 errors with X11R5:
9918 X protocol error: BadAtom (invalid Atom parameter)
9919 on protocol request 18skiloaf.
9920 So let's not use it until R6. */
9921 #ifdef HAVE_X11XTR6
9922 XtSetLanguageProc (NULL, NULL, NULL);
9923 #endif
9926 int argc = 0;
9927 char *argv[3];
9929 argv[0] = "";
9930 argc = 1;
9931 if (xrm_option)
9933 argv[argc++] = "-xrm";
9934 argv[argc++] = xrm_option;
9936 turn_on_atimers (0);
9937 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
9938 resource_name, EMACS_CLASS,
9939 emacs_options, XtNumber (emacs_options),
9940 &argc, argv);
9941 turn_on_atimers (1);
9943 #ifdef HAVE_X11XTR6
9944 /* I think this is to compensate for XtSetLanguageProc. */
9945 fixup_locale ();
9946 #endif
9949 #else /* not USE_X_TOOLKIT */
9950 XSetLocaleModifiers ("");
9951 dpy = XOpenDisplay (SSDATA (display_name));
9952 #endif /* not USE_X_TOOLKIT */
9953 #endif /* not USE_GTK*/
9955 /* Detect failure. */
9956 if (dpy == 0)
9958 UNBLOCK_INPUT;
9959 return 0;
9962 /* We have definitely succeeded. Record the new connection. */
9964 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
9965 memset (dpyinfo, 0, sizeof *dpyinfo);
9966 hlinfo = &dpyinfo->mouse_highlight;
9968 terminal = x_create_terminal (dpyinfo);
9971 struct x_display_info *share;
9972 Lisp_Object tail;
9974 for (share = x_display_list, tail = x_display_name_list; share;
9975 share = share->next, tail = XCDR (tail))
9976 if (same_x_server (SSDATA (XCAR (XCAR (tail))),
9977 SSDATA (display_name)))
9978 break;
9979 if (share)
9980 terminal->kboard = share->terminal->kboard;
9981 else
9983 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
9984 init_kboard (terminal->kboard);
9985 KVAR (terminal->kboard, Vwindow_system) = Qx;
9987 /* Add the keyboard to the list before running Lisp code (via
9988 Qvendor_specific_keysyms below), since these are not traced
9989 via terminals but only through all_kboards. */
9990 terminal->kboard->next_kboard = all_kboards;
9991 all_kboards = terminal->kboard;
9993 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
9995 char *vendor = ServerVendor (dpy);
9997 /* Protect terminal from GC before removing it from the
9998 list of terminals. */
9999 struct gcpro gcpro1;
10000 Lisp_Object gcpro_term;
10001 XSETTERMINAL (gcpro_term, terminal);
10002 GCPRO1 (gcpro_term);
10004 /* Temporarily hide the partially initialized terminal. */
10005 terminal_list = terminal->next_terminal;
10006 UNBLOCK_INPUT;
10007 KVAR (terminal->kboard, Vsystem_key_alist)
10008 = call1 (Qvendor_specific_keysyms,
10009 vendor ? build_string (vendor) : empty_unibyte_string);
10010 BLOCK_INPUT;
10011 terminal->next_terminal = terminal_list;
10012 terminal_list = terminal;
10013 UNGCPRO;
10016 /* Don't let the initial kboard remain current longer than necessary.
10017 That would cause problems if a file loaded on startup tries to
10018 prompt in the mini-buffer. */
10019 if (current_kboard == initial_kboard)
10020 current_kboard = terminal->kboard;
10022 terminal->kboard->reference_count++;
10025 /* Put this display on the chain. */
10026 dpyinfo->next = x_display_list;
10027 x_display_list = dpyinfo;
10029 /* Put it on x_display_name_list as well, to keep them parallel. */
10030 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10031 x_display_name_list);
10032 dpyinfo->name_list_element = XCAR (x_display_name_list);
10034 dpyinfo->display = dpy;
10036 /* Set the name of the terminal. */
10037 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10038 strncpy (terminal->name, SSDATA (display_name), SBYTES (display_name));
10039 terminal->name[SBYTES (display_name)] = 0;
10041 #if 0
10042 XSetAfterFunction (x_current_display, x_trace_wire);
10043 #endif /* ! 0 */
10045 dpyinfo->x_id_name
10046 = (char *) xmalloc (SBYTES (Vinvocation_name)
10047 + SBYTES (Vsystem_name)
10048 + 2);
10049 sprintf (dpyinfo->x_id_name, "%s@%s",
10050 SSDATA (Vinvocation_name), SSDATA (Vsystem_name));
10052 /* Figure out which modifier bits mean what. */
10053 x_find_modifier_meanings (dpyinfo);
10055 /* Get the scroll bar cursor. */
10056 #ifdef USE_GTK
10057 /* We must create a GTK cursor, it is required for GTK widgets. */
10058 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10059 #endif /* USE_GTK */
10061 dpyinfo->vertical_scroll_bar_cursor
10062 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10064 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10065 resource_name, EMACS_CLASS);
10066 #ifdef HAVE_XRMSETDATABASE
10067 XrmSetDatabase (dpyinfo->display, xrdb);
10068 #else
10069 dpyinfo->display->db = xrdb;
10070 #endif
10071 /* Put the rdb where we can find it in a way that works on
10072 all versions. */
10073 dpyinfo->xrdb = xrdb;
10075 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10076 DefaultScreen (dpyinfo->display));
10077 select_visual (dpyinfo);
10078 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10079 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10080 dpyinfo->client_leader_window = 0;
10081 dpyinfo->grabbed = 0;
10082 dpyinfo->reference_count = 0;
10083 dpyinfo->icon_bitmap_id = -1;
10084 dpyinfo->n_fonts = 0;
10085 dpyinfo->bitmaps = 0;
10086 dpyinfo->bitmaps_size = 0;
10087 dpyinfo->bitmaps_last = 0;
10088 dpyinfo->scratch_cursor_gc = 0;
10089 hlinfo->mouse_face_mouse_frame = 0;
10090 hlinfo->mouse_face_deferred_gc = 0;
10091 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10092 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10093 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10094 hlinfo->mouse_face_window = Qnil;
10095 hlinfo->mouse_face_overlay = Qnil;
10096 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10097 hlinfo->mouse_face_defer = 0;
10098 hlinfo->mouse_face_hidden = 0;
10099 dpyinfo->x_focus_frame = 0;
10100 dpyinfo->x_focus_event_frame = 0;
10101 dpyinfo->x_highlight_frame = 0;
10102 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10104 /* See if we can construct pixel values from RGB values. */
10105 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10106 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10108 if (dpyinfo->visual->class == TrueColor)
10110 get_bits_and_offset (dpyinfo->visual->red_mask,
10111 &dpyinfo->red_bits, &dpyinfo->red_offset);
10112 get_bits_and_offset (dpyinfo->visual->blue_mask,
10113 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10114 get_bits_and_offset (dpyinfo->visual->green_mask,
10115 &dpyinfo->green_bits, &dpyinfo->green_offset);
10118 /* See if a private colormap is requested. */
10119 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10121 if (dpyinfo->visual->class == PseudoColor)
10123 Lisp_Object value;
10124 value = display_x_get_resource (dpyinfo,
10125 build_string ("privateColormap"),
10126 build_string ("PrivateColormap"),
10127 Qnil, Qnil);
10128 if (STRINGP (value)
10129 && (!strcmp (SSDATA (value), "true")
10130 || !strcmp (SSDATA (value), "on")))
10131 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10134 else
10135 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10136 dpyinfo->visual, AllocNone);
10138 #ifdef HAVE_XFT
10140 /* If we are using Xft, check dpi value in X resources.
10141 It is better we use it as well, since Xft will use it, as will all
10142 Gnome applications. If our real DPI is smaller or larger than the
10143 one Xft uses, our font will look smaller or larger than other
10144 for other applications, even if it is the same font name (monospace-10
10145 for example). */
10146 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10147 double d;
10148 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10149 dpyinfo->resy = dpyinfo->resx = d;
10151 #endif
10153 if (dpyinfo->resy < 1)
10155 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10156 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10157 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10158 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10159 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10160 pixels = DisplayWidth (dpyinfo->display, screen_number);
10161 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10162 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10163 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10167 const struct
10169 const char *name;
10170 Atom *atom;
10171 } atom_refs[] = {
10172 { "WM_PROTOCOLS", &dpyinfo->Xatom_wm_protocols },
10173 { "WM_TAKE_FOCUS", &dpyinfo->Xatom_wm_take_focus },
10174 { "WM_SAVE_YOURSELF", &dpyinfo->Xatom_wm_save_yourself },
10175 { "WM_DELETE_WINDOW", &dpyinfo->Xatom_wm_delete_window },
10176 { "WM_CHANGE_STATE", &dpyinfo->Xatom_wm_change_state },
10177 { "WM_CONFIGURE_DENIED", &dpyinfo->Xatom_wm_configure_denied },
10178 { "WM_MOVED", &dpyinfo->Xatom_wm_window_moved },
10179 { "WM_CLIENT_LEADER", &dpyinfo->Xatom_wm_client_leader },
10180 { "Editres", &dpyinfo->Xatom_editres },
10181 { "CLIPBOARD", &dpyinfo->Xatom_CLIPBOARD },
10182 { "TIMESTAMP", &dpyinfo->Xatom_TIMESTAMP },
10183 { "TEXT", &dpyinfo->Xatom_TEXT },
10184 { "COMPOUND_TEXT", &dpyinfo->Xatom_COMPOUND_TEXT },
10185 { "UTF8_STRING", &dpyinfo->Xatom_UTF8_STRING },
10186 { "DELETE", &dpyinfo->Xatom_DELETE },
10187 { "MULTIPLE", &dpyinfo->Xatom_MULTIPLE },
10188 { "INCR", &dpyinfo->Xatom_INCR },
10189 { "_EMACS_TMP_", &dpyinfo->Xatom_EMACS_TMP },
10190 { "TARGETS", &dpyinfo->Xatom_TARGETS },
10191 { "NULL", &dpyinfo->Xatom_NULL },
10192 { "ATOM", &dpyinfo->Xatom_ATOM },
10193 { "ATOM_PAIR", &dpyinfo->Xatom_ATOM_PAIR },
10194 { "CLIPBOARD_MANAGER", &dpyinfo->Xatom_CLIPBOARD_MANAGER },
10195 { "_XEMBED_INFO", &dpyinfo->Xatom_XEMBED_INFO },
10196 /* For properties of font. */
10197 { "PIXEL_SIZE", &dpyinfo->Xatom_PIXEL_SIZE },
10198 { "AVERAGE_WIDTH", &dpyinfo->Xatom_AVERAGE_WIDTH },
10199 { "_MULE_BASELINE_OFFSET", &dpyinfo->Xatom_MULE_BASELINE_OFFSET },
10200 { "_MULE_RELATIVE_COMPOSE", &dpyinfo->Xatom_MULE_RELATIVE_COMPOSE },
10201 { "_MULE_DEFAULT_ASCENT", &dpyinfo->Xatom_MULE_DEFAULT_ASCENT },
10202 /* Ghostscript support. */
10203 { "DONE", &dpyinfo->Xatom_DONE },
10204 { "PAGE", &dpyinfo->Xatom_PAGE },
10205 { "SCROLLBAR", &dpyinfo->Xatom_Scrollbar },
10206 { "_XEMBED", &dpyinfo->Xatom_XEMBED },
10207 /* EWMH */
10208 { "_NET_WM_STATE", &dpyinfo->Xatom_net_wm_state },
10209 { "_NET_WM_STATE_FULLSCREEN", &dpyinfo->Xatom_net_wm_state_fullscreen },
10210 { "_NET_WM_STATE_MAXIMIZED_HORZ",
10211 &dpyinfo->Xatom_net_wm_state_maximized_horz },
10212 { "_NET_WM_STATE_MAXIMIZED_VERT",
10213 &dpyinfo->Xatom_net_wm_state_maximized_vert },
10214 { "_NET_WM_STATE_STICKY", &dpyinfo->Xatom_net_wm_state_sticky },
10215 { "_NET_WM_WINDOW_TYPE", &dpyinfo->Xatom_net_window_type },
10216 { "_NET_WM_WINDOW_TYPE_TOOLTIP",
10217 &dpyinfo->Xatom_net_window_type_tooltip },
10218 { "_NET_WM_ICON_NAME", &dpyinfo->Xatom_net_wm_icon_name },
10219 { "_NET_WM_NAME", &dpyinfo->Xatom_net_wm_name },
10220 { "_NET_SUPPORTED", &dpyinfo->Xatom_net_supported },
10221 { "_NET_SUPPORTING_WM_CHECK", &dpyinfo->Xatom_net_supporting_wm_check },
10222 { "_NET_WM_WINDOW_OPACITY", &dpyinfo->Xatom_net_wm_window_opacity },
10223 { "_NET_ACTIVE_WINDOW", &dpyinfo->Xatom_net_active_window },
10224 { "_NET_FRAME_EXTENTS", &dpyinfo->Xatom_net_frame_extents },
10225 /* Session management */
10226 { "SM_CLIENT_ID", &dpyinfo->Xatom_SM_CLIENT_ID },
10227 { "_XSETTINGS_SETTINGS", &dpyinfo->Xatom_xsettings_prop },
10228 { "MANAGER", &dpyinfo->Xatom_xsettings_mgr },
10231 int i;
10232 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10233 /* 1 for _XSETTINGS_SN */
10234 const int total_atom_count = 1 + atom_count;
10235 Atom *atoms_return = xmalloc (sizeof (Atom) * total_atom_count);
10236 char **atom_names = xmalloc (sizeof (char *) * total_atom_count);
10237 char xsettings_atom_name[64];
10239 for (i = 0; i < atom_count; i++)
10240 atom_names[i] = (char *) atom_refs[i].name;
10242 /* Build _XSETTINGS_SN atom name */
10243 snprintf (xsettings_atom_name, sizeof (xsettings_atom_name),
10244 "_XSETTINGS_S%d", XScreenNumberOfScreen (dpyinfo->screen));
10245 atom_names[i] = xsettings_atom_name;
10247 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10248 False, atoms_return);
10250 for (i = 0; i < atom_count; i++)
10251 *atom_refs[i].atom = atoms_return[i];
10253 /* Manual copy of last atom */
10254 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10256 xfree (atom_names);
10257 xfree (atoms_return);
10260 dpyinfo->x_dnd_atoms_size = 8;
10261 dpyinfo->x_dnd_atoms_length = 0;
10262 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10263 * dpyinfo->x_dnd_atoms_size);
10265 dpyinfo->net_supported_atoms = NULL;
10266 dpyinfo->nr_net_supported_atoms = 0;
10267 dpyinfo->net_supported_window = 0;
10269 connection = ConnectionNumber (dpyinfo->display);
10270 dpyinfo->connection = connection;
10273 dpyinfo->gray
10274 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10275 gray_bitmap_bits,
10276 gray_bitmap_width, gray_bitmap_height,
10277 1, 0, 1);
10280 #ifdef HAVE_X_I18N
10281 xim_initialize (dpyinfo, resource_name);
10282 #endif
10284 xsettings_initialize (dpyinfo);
10286 /* This is only needed for distinguishing keyboard and process input. */
10287 if (connection != 0)
10288 add_keyboard_wait_descriptor (connection);
10290 #ifdef F_SETOWN
10291 fcntl (connection, F_SETOWN, getpid ());
10292 #endif /* ! defined (F_SETOWN) */
10294 #ifdef SIGIO
10295 if (interrupt_input)
10296 init_sigio (connection);
10297 #endif /* ! defined (SIGIO) */
10299 #ifdef USE_LUCID
10301 XrmValue d, fr, to;
10302 Font font;
10304 dpy = dpyinfo->display;
10305 d.addr = (XPointer)&dpy;
10306 d.size = sizeof (Display *);
10307 fr.addr = XtDefaultFont;
10308 fr.size = sizeof (XtDefaultFont);
10309 to.size = sizeof (Font *);
10310 to.addr = (XPointer)&font;
10311 x_catch_errors (dpy);
10312 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10313 abort ();
10314 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10315 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10316 x_uncatch_errors ();
10318 #endif
10320 /* See if we should run in synchronous mode. This is useful
10321 for debugging X code. */
10323 Lisp_Object value;
10324 value = display_x_get_resource (dpyinfo,
10325 build_string ("synchronous"),
10326 build_string ("Synchronous"),
10327 Qnil, Qnil);
10328 if (STRINGP (value)
10329 && (!strcmp (SSDATA (value), "true")
10330 || !strcmp (SSDATA (value), "on")))
10331 XSynchronize (dpyinfo->display, True);
10335 Lisp_Object value;
10336 value = display_x_get_resource (dpyinfo,
10337 build_string ("useXIM"),
10338 build_string ("UseXIM"),
10339 Qnil, Qnil);
10340 #ifdef USE_XIM
10341 if (STRINGP (value)
10342 && (!strcmp (SSDATA (value), "false")
10343 || !strcmp (SSDATA (value), "off")))
10344 use_xim = 0;
10345 #else
10346 if (STRINGP (value)
10347 && (!strcmp (SSDATA (value), "true")
10348 || !strcmp (SSDATA (value), "on")))
10349 use_xim = 1;
10350 #endif
10353 #ifdef HAVE_X_SM
10354 /* Only do this for the very first display in the Emacs session.
10355 Ignore X session management when Emacs was first started on a
10356 tty. */
10357 if (terminal->id == 1)
10358 x_session_initialize (dpyinfo);
10359 #endif
10361 UNBLOCK_INPUT;
10363 return dpyinfo;
10366 /* Get rid of display DPYINFO, deleting all frames on it,
10367 and without sending any more commands to the X server. */
10369 static void
10370 x_delete_display (struct x_display_info *dpyinfo)
10372 struct terminal *t;
10374 /* Close all frames and delete the generic struct terminal for this
10375 X display. */
10376 for (t = terminal_list; t; t = t->next_terminal)
10377 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10379 #ifdef HAVE_X_SM
10380 /* Close X session management when we close its display. */
10381 if (t->id == 1 && x_session_have_connection ())
10382 x_session_close ();
10383 #endif
10384 delete_terminal (t);
10385 break;
10388 delete_keyboard_wait_descriptor (dpyinfo->connection);
10390 /* Discard this display from x_display_name_list and x_display_list.
10391 We can't use Fdelq because that can quit. */
10392 if (! NILP (x_display_name_list)
10393 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10394 x_display_name_list = XCDR (x_display_name_list);
10395 else
10397 Lisp_Object tail;
10399 tail = x_display_name_list;
10400 while (CONSP (tail) && CONSP (XCDR (tail)))
10402 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10404 XSETCDR (tail, XCDR (XCDR (tail)));
10405 break;
10407 tail = XCDR (tail);
10411 if (next_noop_dpyinfo == dpyinfo)
10412 next_noop_dpyinfo = dpyinfo->next;
10414 if (x_display_list == dpyinfo)
10415 x_display_list = dpyinfo->next;
10416 else
10418 struct x_display_info *tail;
10420 for (tail = x_display_list; tail; tail = tail->next)
10421 if (tail->next == dpyinfo)
10422 tail->next = tail->next->next;
10425 xfree (dpyinfo->x_id_name);
10426 xfree (dpyinfo->x_dnd_atoms);
10427 xfree (dpyinfo->color_cells);
10428 xfree (dpyinfo);
10431 #ifdef USE_X_TOOLKIT
10433 /* Atimer callback function for TIMER. Called every 0.1s to process
10434 Xt timeouts, if needed. We must avoid calling XtAppPending as
10435 much as possible because that function does an implicit XFlush
10436 that slows us down. */
10438 static void
10439 x_process_timeouts (struct atimer *timer)
10441 BLOCK_INPUT;
10442 x_timeout_atimer_activated_flag = 0;
10443 if (toolkit_scroll_bar_interaction || popup_activated ())
10445 while (XtAppPending (Xt_app_con) & XtIMTimer)
10446 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10447 /* Reactivate the atimer for next time. */
10448 x_activate_timeout_atimer ();
10450 UNBLOCK_INPUT;
10453 /* Install an asynchronous timer that processes Xt timeout events
10454 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10455 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10456 function whenever these variables are set. This is necessary
10457 because some widget sets use timeouts internally, for example the
10458 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10459 processed, these widgets don't behave normally. */
10461 void
10462 x_activate_timeout_atimer (void)
10464 BLOCK_INPUT;
10465 if (!x_timeout_atimer_activated_flag)
10467 EMACS_TIME interval;
10469 EMACS_SET_SECS_USECS (interval, 0, 100000);
10470 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10471 x_timeout_atimer_activated_flag = 1;
10473 UNBLOCK_INPUT;
10476 #endif /* USE_X_TOOLKIT */
10479 /* Set up use of X before we make the first connection. */
10481 extern frame_parm_handler x_frame_parm_handlers[];
10483 static struct redisplay_interface x_redisplay_interface =
10485 x_frame_parm_handlers,
10486 x_produce_glyphs,
10487 x_write_glyphs,
10488 x_insert_glyphs,
10489 x_clear_end_of_line,
10490 x_scroll_run,
10491 x_after_update_window_line,
10492 x_update_window_begin,
10493 x_update_window_end,
10494 x_cursor_to,
10495 x_flush,
10496 #ifdef XFlush
10497 x_flush,
10498 #else
10499 0, /* flush_display_optional */
10500 #endif
10501 x_clear_window_mouse_face,
10502 x_get_glyph_overhangs,
10503 x_fix_overlapping_area,
10504 x_draw_fringe_bitmap,
10505 0, /* define_fringe_bitmap */
10506 0, /* destroy_fringe_bitmap */
10507 x_compute_glyph_string_overhangs,
10508 x_draw_glyph_string,
10509 x_define_frame_cursor,
10510 x_clear_frame_area,
10511 x_draw_window_cursor,
10512 x_draw_vertical_window_border,
10513 x_shift_glyphs_for_insert
10517 /* This function is called when the last frame on a display is deleted. */
10518 void
10519 x_delete_terminal (struct terminal *terminal)
10521 struct x_display_info *dpyinfo = terminal->display_info.x;
10523 /* Protect against recursive calls. delete_frame in
10524 delete_terminal calls us back when it deletes our last frame. */
10525 if (!terminal->name)
10526 return;
10528 BLOCK_INPUT;
10529 #ifdef HAVE_X_I18N
10530 /* We must close our connection to the XIM server before closing the
10531 X display. */
10532 if (dpyinfo->xim)
10533 xim_close_dpy (dpyinfo);
10534 #endif
10536 /* If called from x_connection_closed, the display may already be closed
10537 and dpyinfo->display was set to 0 to indicate that. */
10538 if (dpyinfo->display)
10540 x_destroy_all_bitmaps (dpyinfo);
10541 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10543 /* Whether or not XCloseDisplay destroys the associated resource
10544 database depends on the version of libX11. To avoid both
10545 crash and memory leak, we dissociate the database from the
10546 display and then destroy dpyinfo->xrdb ourselves.
10548 Unfortunately, the above strategy does not work in some
10549 situations due to a bug in newer versions of libX11: because
10550 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10551 dpy->db is NULL, XCloseDisplay destroys the associated
10552 database whereas it has not been created by XGetDefault
10553 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10554 don't destroy the database here in order to avoid the crash
10555 in the above situations for now, though that may cause memory
10556 leaks in other situations. */
10557 #if 0
10558 #ifdef HAVE_XRMSETDATABASE
10559 XrmSetDatabase (dpyinfo->display, NULL);
10560 #else
10561 dpyinfo->display->db = NULL;
10562 #endif
10563 /* We used to call XrmDestroyDatabase from x_delete_display, but
10564 some older versions of libX11 crash if we call it after
10565 closing all the displays. */
10566 XrmDestroyDatabase (dpyinfo->xrdb);
10567 #endif
10569 #ifdef USE_GTK
10570 xg_display_close (dpyinfo->display);
10571 #else
10572 #ifdef USE_X_TOOLKIT
10573 XtCloseDisplay (dpyinfo->display);
10574 #else
10575 XCloseDisplay (dpyinfo->display);
10576 #endif
10577 #endif /* ! USE_GTK */
10580 /* Mark as dead. */
10581 dpyinfo->display = NULL;
10582 x_delete_display (dpyinfo);
10583 UNBLOCK_INPUT;
10586 /* Create a struct terminal, initialize it with the X11 specific
10587 functions and make DISPLAY->TERMINAL point to it. */
10589 static struct terminal *
10590 x_create_terminal (struct x_display_info *dpyinfo)
10592 struct terminal *terminal;
10594 terminal = create_terminal ();
10596 terminal->type = output_x_window;
10597 terminal->display_info.x = dpyinfo;
10598 dpyinfo->terminal = terminal;
10600 /* kboard is initialized in x_term_init. */
10602 terminal->clear_frame_hook = x_clear_frame;
10603 terminal->ins_del_lines_hook = x_ins_del_lines;
10604 terminal->delete_glyphs_hook = x_delete_glyphs;
10605 terminal->ring_bell_hook = XTring_bell;
10606 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10607 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10608 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10609 terminal->update_begin_hook = x_update_begin;
10610 terminal->update_end_hook = x_update_end;
10611 terminal->set_terminal_window_hook = XTset_terminal_window;
10612 terminal->read_socket_hook = XTread_socket;
10613 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10614 terminal->mouse_position_hook = XTmouse_position;
10615 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10616 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10617 terminal->fullscreen_hook = XTfullscreen_hook;
10618 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10619 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10620 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10621 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10623 terminal->delete_frame_hook = x_destroy_window;
10624 terminal->delete_terminal_hook = x_delete_terminal;
10626 terminal->rif = &x_redisplay_interface;
10627 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10628 terminal->char_ins_del_ok = 1;
10629 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10630 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10631 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10632 off the bottom. */
10634 return terminal;
10637 void
10638 x_initialize (void)
10640 baud_rate = 19200;
10642 x_noop_count = 0;
10643 last_tool_bar_item = -1;
10644 any_help_event_p = 0;
10645 ignore_next_mouse_click_timeout = 0;
10647 #ifdef USE_GTK
10648 current_count = -1;
10649 #endif
10651 /* Try to use interrupt input; if we can't, then start polling. */
10652 Fset_input_interrupt_mode (Qt);
10654 #ifdef USE_X_TOOLKIT
10655 XtToolkitInitialize ();
10657 Xt_app_con = XtCreateApplicationContext ();
10659 /* Register a converter from strings to pixels, which uses
10660 Emacs' color allocation infrastructure. */
10661 XtAppSetTypeConverter (Xt_app_con,
10662 XtRString, XtRPixel, cvt_string_to_pixel,
10663 cvt_string_to_pixel_args,
10664 XtNumber (cvt_string_to_pixel_args),
10665 XtCacheByDisplay, cvt_pixel_dtor);
10667 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10668 #endif
10670 #ifdef USE_TOOLKIT_SCROLL_BARS
10671 #ifndef USE_GTK
10672 xaw3d_arrow_scroll = False;
10673 xaw3d_pick_top = True;
10674 #endif
10675 #endif
10677 pending_autoraise_frame = 0;
10678 pending_event_wait.f = 0;
10679 pending_event_wait.eventtype = 0;
10681 /* Note that there is no real way portable across R3/R4 to get the
10682 original error handler. */
10683 XSetErrorHandler (x_error_handler);
10684 XSetIOErrorHandler (x_io_error_quitter);
10686 signal (SIGPIPE, x_connection_signal);
10688 xgselect_initialize ();
10692 void
10693 syms_of_xterm (void)
10695 x_error_message = NULL;
10697 staticpro (&x_display_name_list);
10698 x_display_name_list = Qnil;
10700 staticpro (&last_mouse_scroll_bar);
10701 last_mouse_scroll_bar = Qnil;
10703 staticpro (&Qvendor_specific_keysyms);
10704 Qvendor_specific_keysyms = intern_c_string ("vendor-specific-keysyms");
10706 staticpro (&Qlatin_1);
10707 Qlatin_1 = intern_c_string ("latin-1");
10709 staticpro (&last_mouse_press_frame);
10710 last_mouse_press_frame = Qnil;
10712 #ifdef USE_GTK
10713 xg_default_icon_file = make_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10714 staticpro (&xg_default_icon_file);
10716 Qx_gtk_map_stock = intern_c_string ("x-gtk-map-stock");
10717 staticpro (&Qx_gtk_map_stock);
10718 #endif
10720 DEFVAR_BOOL ("x-use-underline-position-properties",
10721 x_use_underline_position_properties,
10722 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10723 A value of nil means ignore them. If you encounter fonts with bogus
10724 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10725 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10726 to override the font's UNDERLINE_POSITION for small font display
10727 sizes. */);
10728 x_use_underline_position_properties = 1;
10730 DEFVAR_BOOL ("x-underline-at-descent-line",
10731 x_underline_at_descent_line,
10732 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10733 A value of nil means to draw the underline according to the value of the
10734 variable `x-use-underline-position-properties', which is usually at the
10735 baseline level. The default value is nil. */);
10736 x_underline_at_descent_line = 0;
10738 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10739 x_mouse_click_focus_ignore_position,
10740 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10741 This variable is only used when the window manager requires that you
10742 click on a frame to select it (give it focus). In that case, a value
10743 of nil, means that the selected window and cursor position changes to
10744 reflect the mouse click position, while a non-nil value means that the
10745 selected window or cursor position is preserved. */);
10746 x_mouse_click_focus_ignore_position = 0;
10748 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10749 doc: /* Which toolkit scroll bars Emacs uses, if any.
10750 A value of nil means Emacs doesn't use toolkit scroll bars.
10751 With the X Window system, the value is a symbol describing the
10752 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10753 With MS Windows, the value is t. */);
10754 #ifdef USE_TOOLKIT_SCROLL_BARS
10755 #ifdef USE_MOTIF
10756 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10757 #elif defined HAVE_XAW3D
10758 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10759 #elif USE_GTK
10760 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10761 #else
10762 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10763 #endif
10764 #else
10765 Vx_toolkit_scroll_bars = Qnil;
10766 #endif
10768 staticpro (&last_mouse_motion_frame);
10769 last_mouse_motion_frame = Qnil;
10771 Qmodifier_value = intern_c_string ("modifier-value");
10772 Qalt = intern_c_string ("alt");
10773 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10774 Qhyper = intern_c_string ("hyper");
10775 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10776 Qmeta = intern_c_string ("meta");
10777 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10778 Qsuper = intern_c_string ("super");
10779 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10781 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10782 doc: /* Which keys Emacs uses for the alt modifier.
10783 This should be one of the symbols `alt', `hyper', `meta', `super'.
10784 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10785 is nil, which is the same as `alt'. */);
10786 Vx_alt_keysym = Qnil;
10788 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10789 doc: /* Which keys Emacs uses for the hyper modifier.
10790 This should be one of the symbols `alt', `hyper', `meta', `super'.
10791 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10792 default is nil, which is the same as `hyper'. */);
10793 Vx_hyper_keysym = Qnil;
10795 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10796 doc: /* Which keys Emacs uses for the meta modifier.
10797 This should be one of the symbols `alt', `hyper', `meta', `super'.
10798 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10799 default is nil, which is the same as `meta'. */);
10800 Vx_meta_keysym = Qnil;
10802 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10803 doc: /* Which keys Emacs uses for the super modifier.
10804 This should be one of the symbols `alt', `hyper', `meta', `super'.
10805 For example, `super' means use the Super_L and Super_R keysyms. The
10806 default is nil, which is the same as `super'. */);
10807 Vx_super_keysym = Qnil;
10809 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10810 doc: /* Hash table of character codes indexed by X keysym codes. */);
10811 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10812 make_float (DEFAULT_REHASH_SIZE),
10813 make_float (DEFAULT_REHASH_THRESHOLD),
10814 Qnil, Qnil, Qnil);
10817 #endif /* HAVE_X_WINDOWS */